Advanced User Module Maintenance

<< Click to Display Table of Contents >>

Navigation:  Creating Your Own Books and Commentaries >

Advanced User Module Maintenance

Advanced User Module Maintenance is available on the User main menu.


Most SwordSearcher users will not need this tool. It is designed primarily for module authors with complex needs. The tools in this window only apply to user-editable modules.


The Module Maintenance window has five sections:




From here you can export your user module to one of two formats:


Export Module as HTML Document: Writes the entire module content out to an HTML document that can be loaded by most word processors or by a web browser.


Export Module for Forge: Saves the module content to the Forge input file format. Advanced users with complex processing needs can use this file and rebuild the module with Forge for SwordSearcher. The Include <scripref> option can be disabled if you do not want the automatically linked verses hard-tagged in the output.




Images for user module entries are considered assets and stored in a companion folder with the module file. The tools on this page of the Maintenance window are used to ensure that the module does not have any "external" image references not owned by the module. Images from entries which are on web pages or other locations on the local hard drive can automatically be copied into the module's assets folder.


Starting with SwordSearcher 7.1, images pasted into the user editor are automatically copied to the assets folder. These tools can be used to update older user modules.




The Rebuild Module function completely rebuilds the module data file. This process is almost never necessary but it can be useful for one of the following purposes:


If certain text patterns are being incorrectly interpreted as verse links across multiple entries, you can use the configure verse reference recognition option rebuild the entries, which re-scans each one for verse links. This is equivalent to using the Configure Verse Reference Recognition option on the editor's File menu and re-saving each entry.

Remove Styles and Formatting from Entries can remove styles and formatting from all of the entries at once. This removes all hard-coded font names, sizes, and colors, as well as all CSS-based formatting, and can optionally remove table, heading, list, and other types of formatting from the entries. This is useful if your module contains a lot of entries pasted in from external sources with inconsistent or undesirable formatting, and allows users of the module to see the text in the font, size, and color they have chosen in their preferences. (Using this option will permanently remove formatting information from all entries in the module. It cannot be undone.) You can do this for specific entries by loading them into the entry editor as you normally would, and selecting Style and Format Cleaner from the editor's Format menu.




You can package a copy of this module file into a zip file for easy sharing or as a means of backup. Zipping the module includes all used Asset folder files (if any).


Zip an editable copy of the module: Good for personal backup use or if you want to share your module in editable form.


Zip a read-only copy of the module: Use this if you want to share your module but do not want it to appear as a user-editable module.Warning! If you zip the module in read-only form, you will not be able to use the zip file to restore an editable copy of your content.


Restoring from zip files: Simply extract the zipped module files into your Documents\SwordSearcher User Modules folder.




Provides a detailed report of the module content, including the results of a module file integrity check, external links and images, missing images, etc. Selecting this tab will test the entire module for errors.