Modules

Overview

Modules are individual books or resources that are used within theWord.  Compared to a regular library, the modules would be the books on the shelves.  theWord has only two basic types of modules: Bibles and non-Bible (or Book) modules.  See below for more information on modules.

Bible Modules

Book Modules

Official Modules

theWord's website (www.theword.net) hosts all official theWord modules.  They can be downloaded from the website freely. These official modules have identifiers and are maintained by theWord team. They are formatted correctly and have been tested. However, users are not limited only to official modules. Users can make their own modules or share modules with one another. As modules are made by users, shown to be in the public domain or proper permission has been obtained, and formatted correctly, they can be submitted to theWord team to be placed in the official library. Our hope is that the library will become a very rich resource for users. You can go the library here.

Installing new modules

Read the Installing new modules topic to see how you can add more modules in theWord.

User and non-user modules, encrypted modules

A user module is one whose content can be edited. You can change the status of a module from user to non-user and vice versa from the Module properties dialog (Settings/Actions tab, User module (can be edited) option). You can think this status as a module level property that can be changed if necessary. The primary reason for the distinction between the two is to prevent the content to be changed by mistake. Notice that although non-user modules' content cannot be edited, it can be formatted/highlighted.

An encrypted module is a special case of a non-user module whose content is also encrypted and, moreover, it cannot be switched to non-user status. Paid modules are encrypted modules that require a proper unlock key in order to be used. There is no way to edit the content of an encrypted module.

Storage Locations

theWord can read from several different storage locations to locate modules that can be used in theWord.  At startup, theWord searches all these locations for new modules and indexes them.  These locations (on Windows 7) are:

C:\Program Files\The Word
C:\Users\<user>\AppData\The Word
C:\ProgramData\The Word

By default, official modules downloaded from theWord library are installed in the third path in the list above.  User modules should be stored in the user's personal path, which is the second path above.  All of the user's installed modules can be found in theWord via the main menu: Help -> About... -> File Locations tab.  More detailed and technical information on module storage locations can be found at this page on theWord's website.

Deleting a module

To delete a Book module you can right-click on the module's tab and click on the Delete menu.

There is no direct way to delete a Bible module from within the program at this moment; yet, since, each module corresponds to a single file on your disk you can just delete the corresponding file.

To delete a Bible module:

1.Right click on the module tab and select Info...

bible_info_menu

2.At the bottom of the info dialog notice the full path to the module:

bible_module_info_path

3.Close theWord and delete this file using Windows Explorer.

To delete a Book module:

Right click on a module tab and click on Delete module...

book_view_module_properties_menu

Encrypting a module

theWord allow you to encrypt a module if you want to distribute it but do not wish for the end user to be able to change it's content. To do so, you will need to invoke the following command from a DOS command prompt:

for a Bible module:

theword.exe -encrypt "filename" [-maxverses xxx]

The -maxverses argument is optional and defines the maximum number of continuous verse that can be copied in a single step from the Bible. The value used by default for official encrypted Bible modules is 200.

for a Book module:

theword.exe -encrypt "filename"

In the case of a Bible module, the result is an encrypted module file with the letter x appended to it's extension. Notice that the first time an encrypted Bible module file is opened by theWord, it is indexed and its size grows significantly, so if you want to distribute your encrypted module file do not run theWord after the encryption!

In the case of a Book module, the result is an encrypted module file with the phrase -encrypted appended to the filename (the extension will not change, it will remain .twm).

TIP: Encrypting a module prevents it from later being compressed. This is an inherent property of the encryption. If you plan to distribute your module (and obviously you would want to compress the file before you distribute it), you will not be able to do so effectively. In order to circumvent this it is better to compress the module from within theWord before encrypting it. You can do so from the Module Properties dialog, Settings/Actions tab, Module is compressed (to save disk space) option.

Also, make sure to execute the action Prepare module for distribution... before doing so, so that unnecessary search data are removed from the module prior to distribution (this will further remove it's size). See Preparing User Module for Distribution.

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