Verse Links and Links to Other Modules in User Entries

<< Click to Display Table of Contents >>

Navigation:  Creating Your Own Books and Commentaries > Using the Editor >

Verse Links and Links to Other Modules in User Entries

The User Editor includes several helper functions for inserting links in user book and commentary entries.


Verse references are automatically linked


Verse references you type in the user editor are automatically linked in the Book or Commentary panels, and also indexed for use in the Verse Guide. As you type, verse links are indicated in green with a dotted underline, so you can see what SwordSearcher will link as a verse reference.


For example:


This user entry has two verse references typed.

This user entry has two verse references typed.


The Commentary and Book panels show the verse references as links.

The Commentary and Book panels show the verse references as links.

When you have trouble getting a verse reference to link


First, make sure that you are typing in at least a book name and chapter number. In order to avoid incorrectly linking a verse, SwordSearcher will only link complete references that have a book name (or abbreviation) and at least a chapter number.  SwordSearcher can understand over 2,000 different forms of names of the 66 book canon, but if you are unsure how to specify a book you can check the Book Abbreviations appendix.


If you are unsure of the correct way to write a verse reference, you can use the Link to Verse(s) function on the editor Insert menu to preview verse references and have them standardized and inserted into the editor for you. Also, the Bible and Verse List panel right-click menus have functions for sending links to the user editor.


If you enter some references and SwordSearcher incorrectly identifies them, or incorrectly recognizes a number at the start of a proceeding sentence as a verse, you can surround your verse references with # symbols to tell the editor when a verse reference begins and/or ends.


For example, this sentence:


 1. See Joh 1:1,3. 2. See Joh 2:1.


is ambiguous because the "2." looks like a chapter reference.  The above could be re-written like this:


 1. See #Joh 1:1,3#. 2. See #Joh 2:1#.


The # symbols will tell the editor to "break" at that position and "start over" looking for verses, so the following number is not included as a part of the preceding list of verses.  The # symbols are hidden during display so they don't appear in the Book and Commentary panels; only in the editor.


Note that you should not usually need to use # symbols. SwordSearcher will almost always "figure out" what verse references are intended.


Also check the Configure Verse Reference Recognition (editor File menu) to ensure that a specific abbreviation you are using is not excluded from Bible book name interpretation.


Telling the editor not to link a verse reference


If SwordSearcher is linking verse references that you do not wish to be shown as links in the Book or Commentary panel, just surround the reference(s) with / symbols like this:


 This verse reference won't be linked: /Joh 1:1/.


The / symbols will be hidden in the Book and Commentary panels and only appear in the editor itself.


Tip: you can right-click a green, dotted-underline verse link in the editor and select "ignore this reference." This will add the needed symbols so that it is not linked in the book or commentary panel.


Right-clicking a reference in the editor

Right-clicking a reference in the editor


If SwordSearcher links text it shouldn't: In the Editor, select the File menu and choose Configure Verse Reference Recognition. You can add words that should not be interpreted as a Bible book name, and disable Roman number recognition if you do not need it.


Linking to other entries in your module


Use the Insert menu item Link to Entry in this Module to insert a link to another entry in the Book or Commentary you are currently editing. (This is a good idea because the link will continue to work even if you change the name of your module.)


Linking to other modules in SwordSearcher


If you want to link to an entry in a different Book or Commentary, use the Link to an Entry in Book or Commentary function. You can also right-click the Book or Commentary panel to send a link to the visible entry to the editor.


To link to an image in the SwordSearcher image viewer, open the image in the viewer and right-click it and select Send Image Link to Editor.


You can also insert links to "searches" -- these types of links will perform a Bible, Book, or Commentary search for the specified search expression. Link to a Bible Search, Link to a Book Search, and Link to a Commentary Search are on the editor Insert menu. Search links support SwordSearcher's advanced search expressions.


Advanced: To save typing additional verse references, type Ctrl+R to insert a "contextual verse reference."


This inserts the book and chapter from the most recent verse reference recognized up to the caret position.

If no prior reference was recognized, and the entry is a commentary entry, the book and chapter for the entry being edited is inserted.

This is just a convenience keyboard shortcut to avoid the need to re-type book and chapter repeatedly when making a series of references broken up by other text.

It Has no effect if the caret is positioned inside of a recognized verse reference.

Tip: if the inserted book+chapter reference is not what was desired, Ctrl+Z will undo the insert.


Advanced users: SwordSearcher URL Protocol and the Code Editor


Users who are familiar with HTML code can use the editor in "code edit mode" and create various links to other SwordSearcher modules and common actions manually with <a href="swordsearcher://...">...</a> links. See Using the Code Editor and the URL Protocol appendix.


In addition to the SwordSearcher URL protocol, you can specify an in-line image link which uses an image from the SwordSearcher Image Viewer this way:


<img src="{ssimagestorepath}\Maps\Kingdom of Saul.png" width="90%"/>


{ssimagestorepath} is an in-line variable to the SwordSearcher image store which is automatically expanded during display in the Book or Commentary panel.