Jump to content

Please read the Forum Rules before posting.


How to Make e-Sword Modules - ToolTip NT User's Guide - .94 / Revision 2/12/2012

  • Please log in to reply
120 replies to this topic

#1 Josh Bond

Josh Bond


  • Administrators
  • PipPipPipPipPip
  • 2,890 posts
  • LocationGallatin, TN

Posted 08 February 2012 - 07:54 PM


Tooltip NT is an e-Sword module authoring tool. You can create e-Sword modules with ToolTip NT.

This 85+ page User's Guide explains, step-by-step, how to make e-Sword modules with Tooltip NT. In the "How to Turn Text into Modules" chapter, simple examples are used with non-technical language. The guide assumes no prior knowledge of Tooltip and introduces basic concepts like Tooltipping. More advanced topics are also explained. A basic knowledge of e-Sword is presumed.

Download the ToolTip User's Guide:

(Pinned in the Tutorials Forum)

#2 Toma


    e-Sword Addict

  • Veterans
  • PipPipPipPip
  • 69 posts

Posted 08 February 2012 - 08:24 PM

Wow Josh and Brent, this is AWESOME! This Tooltip User's Guide was what I was looking for weeks ago. (But thankfully, both of you ended up filling its shoes for that period; and for that i thank your gracious and diligent efforts.

I'm nearly done typing our my Bible Module (it's been almost a month now), and would like to know--since I'm using Tooltip 3.46--if there is a font editor like what Tooltip NT4 has in the User's guide. In other words, from Tooltip 3.46 can I just as easily color my text, or am I limited to the "code" such as {\cf2} ?

Also, is it possible to insert a space at the end of a book, in order that I can input the phrase in small text "This ends the book of Hebrews, sent by the hands of ..." (Or are double spaces prohibited?

Thanks again!

#3 BaptizedBeliever



  • Members (T)
  • PipPipPipPipPip
  • 924 posts

Posted 08 February 2012 - 08:58 PM

You can do that easily, but just hit shift-enter a couple times instead of enter.

#4 BH.


    Utility Developer

  • Contributors
  • PipPipPipPipPip
  • 1,244 posts
  • LocationCalifornia

Posted 08 February 2012 - 09:27 PM

Josh is the one doing all the documentation. He has put together a lot of information, wow.

Coloring text, the whole idea of ToolTip Tool and ToolTip Tool NT is to get away from having to know much about RTF code. In T3, there is a font color palette which can be used to color text. It also the the same one that selects the font color for tooltips. In T4, there are separate palettes.

Both T3 and T4 in Bible modules work on a paragraph basis. Each verse is a single paragraph. If you want more that one line, then you need to use the Shift+Enter to create a soft breaks to get extra lines.

#5 Toma


    e-Sword Addict

  • Veterans
  • PipPipPipPip
  • 69 posts

Posted 09 February 2012 - 12:55 PM

Bradley thank you for answering regarding double-spacing. That is perfect.

Regarding my question about font size and colors, I'm fully aware of the editor that is at the top of ToolTip, but that only changes the formatting of the text within Tooltip. Once I save the Bible Module and then load it into E-Sword, none of those formatting changes that I made appear in E-Sword. It has only been when I employ code in ToolTip such as {\i italics} {\cf2\ color} {\super supercript} that changes are actually rendered when I load my module into E-Sword. Does this sound right? I would think that the formatting editor would be effecting a change beyond just my use of Tooltip for my .bblx file. Do I have to do something "special" to get it to work?

On a different note, if my Bible Module is "New Testament" only, but I want to reference all the "Old Testament" quotes in the New Testament, I already know how to employ color code such as {\cf2\} ... but is there a way that I can link a superscripted reference such a Psalm 19:7 to Sto actually open up that passage? Would this be "linking to Scripture" and can I do that with my own Bible module in Tooltip 3.46 or 4.0? Thanks a bunch.


#6 BH.


    Utility Developer

  • Contributors
  • PipPipPipPipPip
  • 1,244 posts
  • LocationCalifornia

Posted 09 February 2012 - 01:01 PM

There are 3 ways to build a BBLX module in T3. Which did you use? I know from your discription it is the first one. Try the second. The first is straight text. The second used RTF. If you use RTF, then all the edits will be perserved. You could not have used the 3rd way because it also is RTF.

T4 has only 2 ways to build a BBLX, both are RTF.

Edited by BH., 09 February 2012 - 01:02 PM.

#7 Josh Bond

Josh Bond


  • Administrators
  • PipPipPipPipPip
  • 2,890 posts
  • LocationGallatin, TN

Posted 09 February 2012 - 05:16 PM

Someone who is very kind read every word of this manual and sent me a list of 8 errors. (He did the same for the e-Sword User's Guide as well a while back.) One of the errors would have prevented the steps from being followed in certain circumstances.

So, I've made those changes and uploaded a revised edition. My thank you to the proofreader!


#8 patchworkid


    Resource Builder

  • Members (T)
  • PipPipPipPipPip
  • 1,554 posts
  • LocationOld England

Posted 09 February 2012 - 06:28 PM


Thanks a lot for this information. just a question - would this be good if it was in the download of T4. so when you download T4 you also get the Tool tip NT user's guide with it.

it is very good found out a lot of info that i did not know.

thanks again for all ya'll hard work.
Merismos the Scriptures with Patchworkid's Study Bible Set<p>http://www.biblesupp...tudy-bible-set/, MySword -http://www.biblesupp...tudy-bible-set/

#9 SpreadTheWord


    Resource Builder

  • Veterans
  • PipPipPip
  • 41 posts

Posted 09 February 2012 - 06:44 PM

First class all the way, well written and well organized. Even a feature or two in the manual that hasn't been released yet. :D

#10 Josh Bond

Josh Bond


  • Administrators
  • PipPipPipPipPip
  • 2,890 posts
  • LocationGallatin, TN

Posted 12 February 2012 - 02:12 PM

Revision: 2/12/2012B (added "e-Sword Modules are Hot Swappable" section, fixed typos).

I've updated the manual for ToolTip Tool .94 and I think I have this text where I want it now—a mixture of basic explanations in each section, followed by more advanced concepts for those wanting to know exactly how their text will be handled.

I strived to show the relationships between features and commands more clearly. I used internal bookmarks/hyperlinks to cross reference the commands and how they work together (or do not work together). Rather than just explain what a feature does in an abstract way, I've tried to apply the features to real life situations, so that you, the module maker, understand what's happening with the text.

I've also documented behavior found in Tooltip that will come as a surprise to even experienced module makers. (Much of this behavior also exists in ToolTip 3, just with different names and slightly different characteristics.) It's important to understand the trade-offs, advantages, and disadvantages of the options available, so you can understand how your text will be impacted.

For example:
  • 2 ways of Tooltipping a commentary cause comments for references like "÷John 1:1-2:2" to not be inserted into the module for the 2nd chapter unless you enable a specific option (page 64).
  • One way of tooltipping will turn "John 1:1; 2" into Joh_1:1; Joh_2:1-25 (a verse reference to John 1:1 and John chapter 2). Another way of tooltipping turns "John 1:1; 2' into Joh_1:1-2, where the "2" is a continuation of the first reference. These 2 possibilities are VERY different and you should be aware of it. (Pages 44, 67, and 73)
  • There's a way of generating a commentary that will apply the comment to every verse reference in the first paragraph of the comment for that passage instead of just the verse with the ÷ symbol. (page 43).
  • Another frequently asked question is addressed: Linking a Commentary, Bible, or Topic/Reference Book to a Dictionary (like we constructed Bullinger's Commentary and accompanying Dictionary) is explained on page 52.
  • Instructions for how to update an e-Sword module without restarting e-Sword on page 26.
  • A whole list of frequently asked questions and hints are now included on pages 25 and 26.

Chapter 1: Getting to Know ToolTip
------What are e-Sword Modules?
------What Module Types does ToolTip Support?
------ToolTip Interface Overview
--------Configuring the Toolbars
--------Common Tasks Menu
--------Frequently Used Shortcut/Hotkey Combinations

Chapter 2: ToolTip is a Word Processor
------Working with Text
--------Converting Roman Numerals to Digits
--------Converting Text Case
--------Inserting a Hyperlink
--------Font Selection and Size
--------Selecting a Font Color
--------Customizing the Font Color Palette Location
--------Bold (Ctrl-B), Italic (Ctrl-I), Underline (Ctrl-U)
--------Align Left, Align Right, Align Center, Justify
--------Numbering and Bullets
--------Bullets and Numbering Formatting
--------Indent Paragraph and Outdent Paragraph
--------Show/Hide Formatting Symbols
------Formatting Paragraphs
--------Frame and Page Breaks
------Working with Tables
--------Creating a New Table
--------Dragging Table Boundaries
--------Table Properties (Table Settings)
--------Adding and Deleting Rows and Columns
------Working with Images
--------Topic Preview
--------Inserting an Image
--------Image Attributes

Chapter 3: How to Turn Text into e-Sword Modules
------Helpful Hints About Module Making
--------Test Sample Sections of Your Work in e-Sword
--------File Size Limitations
--------Always Save Your Source Document
--------You Can Use Other Word Processors
--------Activate “Do Not ToolTip Marked References”
--------ToolTip Markers Are Just Division Signs
--------Curly Brackets {} Mean Something Different in ToolTip NT
--------Don’t Re-Type Data
--------Font Specifics in ToolTip NT and e-Sword
--------e-Sword Modules are “Hot Swappable”
------Topics (Books) Modules
--------Creating a Topic Module
--------Viewing the Topic Module
--------“Save TOPX File” versus “Save TOPX File – Remove Titles from Text Body”
--------Introduction to Topic Numbering
--------Automatically Numbering Topics: Simple
--------Automatically Numbering Topics: Advanced
--------Allowing for Front Matter When Automatically Numbering
--------Defining a Specific Prefix When Using Topic Numbering
------Commentary Modules
--------Creating a Commentary Module
--------Viewing the Commentary Module
--------Drop Reference When Saving
--------Adding Book and Chapter Comments
--------Applying Comments to Verse Ranges and Overlapping Verses
--------Applying Comments to Multiple Verse References
--------Applying Comments to All References in the First Paragraph
--------Applying Comments Across Chapter Boundaries in a Singular Reference
------Bible Modules
--------Creating a Bible Module
--------Viewing the Bible Module
--------Creating a Red Letter Bible
------Dictionary Modules
--------Creating a Dictionary Module
--------Viewing the Dictionary Module
--------Linking a Commentary, Bible, or Topic/Reference Book to a Dictionary
------Devotional Modules
--------Creating a Devotional Module
--------Viewing the Devotional Module
------Graphics Modules
--------Creating a Graphics Module
--------Viewing the Graphics Module
------Bible Reading Plan Modules
--------Creating a Bible Reading Plan Module
--------Viewing the Bible Reading Plan Module
------Verse List Modules
--------Creating a Verse List Module
--------Viewing the Verse List Module

Chapter 4: Formatting Scripture References
------What is ToolTipping?
--------ToolTip NT Automatically ToolTips Scripture References
------Configuring ToolTip Formatting Options
--------Do Not ToolTip Marked Reference
--------Changing the ToolTip Color
--------Changing The ToolTip Highlight Color
--------Underlining ToolTip References
--------Chapter ToolTipping Options
--------How to Handle Line Wrapped Scripture References
--------Book References { }
--------Bible Book Abbreviation List
------How to ToolTip Scripture References -Basic
------How to ToolTip Scripture References – Advanced
--------Verse Syntax Flexibility
--------Learning the Rules of Unexpected Results
--------Book Name Abbreviations
--------Chapter Tooltips
--------ToolTipping Exclusions
------Invalid Verse References
--------Finding Invalid Verse References
--------Chapter References Identified as Invalid References
------Viewing All Scripture References in a Document
--------Finding Invalid Verse References
------Markup References
------Full Book Name: How to “Un-ToolTip” a Document
------Validate References
------ToolTipping Existing e-Sword Modules
------Scripture Fill-In

Chapter 5: Working with e-Sword Modules
------ToolTipping Existing e-Sword Modules
------Importing e-Sword Modules into ToolTip
------Combining/Sorting Multiple Modules into One Module
------Creating a Self Installing Module

0 user(s) are reading this topic

0 members, 0 guests, 0 anonymous users

Similar Topics

Latest Blogs