Hyperlinking

Overview

theWord allows all content to be linked to, e.g. create links in modules that point to another topic or verse.  This topic explains how you can create your own links in your user-modules.

theWord's Book View supports user-created and editable modules.  One of the helpful features available while editing a module is the ability to hyperlink text so that tool tips, verse texts, other topics, etc., appear when the user hovers over the link; when the link is clicked a view is used to display the content that this link refers to.  theWord supports hyper linking in many different ways.

Once you have an editable module active in the Book View (and you have, optionally, selected the text you want to hyperlink), you can access the Hyperlink Dialog in several ways:

1.Keyboard shortcut ctrl+k
2.Right-click an area in the content section of the Book View and select Hyperlink
3.The Hyperlink button in the Formatting Toolbar clip0037

 

TIP: It is important to make sure you understand how hyper linking works since choices you make here may affect the way links will behave if you decide to copy topics to other modules later or change the module identifier.

Hyperlink Dialog

theWord allows you to hyperlink to just about anything.  The dialog below will guide you in hyper linking properly.  More advanced hyper linking is supported, which can be found at theWord's website.

Hyperlink Dialog

Hyperlink Dialog

The dialog is divided into three sections, numbered accordingly:

1.Select the type of module that you want to link to.  Your choices in this dialog are Bible, commentary, dictionary,  and general book modules.  There is also an advanced option and an option to use the current module (a topic from the current module).  Once you select the type of module, you can select the specific module to which you want link in the drop-down box at right.  For Bible modules, you may select the current Bible module, which will display a verse reference using the default Bible module (or the active Bible module if ctrl is pressed), or you may select a specific translation. Note: If the Bible version you link to is not installed on the computer, theWord will display the verse text with the default Bible module.  If the book module is unavailable, the link will be dead (will not work).

TIP: When making a link to a topic of the same book module (the one you are currently working), always use the option a topic from the current module.

Most links to Book modules usually refer to another topic of the same module. In these cases, although selecting the option a topic from the current module and selecting directly the appropriate module from a list will have the same result, it’s always preferable to use the first option since a future change to the module identifier will "break" the links.

2.Once you choose the module to link to, you must select the target.  For Bible modules, this is a verse reference or range.  For book modules, this is a specific topic of that module.  You can use the drop-down box to pick your verse or see all available topics for your selected module.  If you start typing in the Target verse/topic box a list will appear with the topics that match as you type.  In case of book modules you may also select a bookmark from the Bookmark list (see also the Book view Bookmarks topic on how to define Bookmarks). Selecting a bookmark (if there is one in the selected topic) will have the following effect for the created hyperlink:
a.If you just hover over the hyperlink so that the content of the topic appears, then the topic will be scrolled so that the first line on the popup will be the one containing the bookmark.
b.If you click the hyperlink (so the topic appears in a Book View), then the topic will be scrolled so that the first line in the Book View will contain the bookmark.
c.The Until (passage) list also contains a list of the bookmarks that appear after the bookmark you defined in the previous step (in the Bookmark list). Select from the list:
i.[Next bookmark] - The popup that will appear will only contain the part of the topic that appears between the first bookmark and the next bookmark (if any) in the topic.
ii.Selecting any other bookmark - The popup that will appear will only contain the part of the topic between the two bookmarks.
3.Show content in popup... determines what happens when the user hovers over the link. Text is the actual text seen in the content of the topic.  If you had text selected when you opened this dialog, this will be filled in already with your selected text.  For every option in section one, except Manually enter the target of the link, the Target section will be filled in already with the target.  This area is non-editable unless you choose the Advanced option in section one. Clicking on the <- Default button will replace the Text with the default text (e.g. a standard text that describes the link).

In the Link colors section at the bottom, you can customize the way the link is displayed in the module. Normal refers to the link under normal conditions. Active refers to the link when a user hovers over it or when the cursor is in the link.  You can change both the text and background colors of these links.  You can also choose to show these links as underlined or not.

The option Use the topic id instead of the topic in the "Target" means that the target module will be identified with the Module Identifier instead of the target topics’ subject. This is the preferred way to create links, since changing the subject of the target topic will break all links that point to it.

If you want to keep the current Link colors options for later use to be used as default, press the Set these options as default button. This will also make theWord use these colors when auto-detecting verse references.

Lastly, if you have selected an already existing hyperlink and would like to delete it, press Delete hyperlink.

See also: Automatic Verse recognition.

Linking to external content (e.g. files, mp3 files, etc)

You can add links to file on your disk by manually entering the path in the Target text box. When you click on these links, the Windows program associated with this file extension will be launched to display the file.

You may use relative links to define the location of the file you link. The location is always relative to the directory of the module. This allows you to have all files associated with a module grouped under a single folder.

For example, if you want to link audio mp3 files, you can just create an mp3 subfolder under the folder where your module exists and put in there the audio files. You can link then using the following target (e.g. for an audio file with the name audio1.mp3):

clip0086

Linking to multiple verses

You can add a link to multiple verse using the following syntax for the Target:

tw://bible.*?id=b.c.v;b.c.v;...

 

where b.c.v stands for book.chapter.verse. For example, if you want to add a link to Gen 9:13 and Gen 9:17 then the target will look like that:

tw://bible.*?id=1.9.13;1.9.17

 

 

 
 
  theWord®
  ©2003-2012 Costas Stergiou
manual version: 4.0.1327