diff options
Diffstat (limited to 'help/C/ar01s05.html')
| -rw-r--r-- | help/C/ar01s05.html | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/help/C/ar01s05.html b/help/C/ar01s05.html new file mode 100644 index 0000000..fd2162c --- /dev/null +++ b/help/C/ar01s05.html @@ -0,0 +1,91 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Module Manager</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s04.html" title="Preferences"><link rel="next" href="ar01s06.html" title="The Search Function"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="module-manager"></a>Module Manager</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="module-introduction"></a>Introduction To The Module Manager</h3></div></div></div><p> + The "module" is the unit of content in <span class="application">Xiphos</span>, and Sword generally; a Sword module is a resource + available for viewing in Sword applications. There are several varieties: Most importantly, Bible texts, as well as + dictionaries and lexicons, commentaries, and general books, any of which may include image content (e.g. atlases). They are + installed either from a local directory structure (typically on removable media, such as a CDROM distribution) or remotely + via ftp from a repository such as Crosswire, which is the home of Sword, and from which all officially Sword-sanctioned + modules are available. Also, many other modules are available from non-Crosswire repositories. In particular, there is the + Xiphos repository, containing a variety of otherwise-unofficial modules produced primarily by contributors to + <span class="application">Xiphos</span> itself. + </p><p> + If you have other Sword applications installed, they will all share the same set of Sword modules that you install through + the Module Manager. + </p><div class="figure"><a name="d0e1561"></a><p class="title"><b>Figure 24. The Module Manager Dialog</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/module.png" alt="The Module Manager Dialog"></div></div></div></div><br class="figure-break"><p> + Notice the <span class="guibutton">View Intro</span> button above. You may see an introductory explanation of Module Manager + operation at any time. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="sword-config"></a>Sword Module Configurations</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="sword-sources"></a>Module Sources Settings</h4></div></div></div><div class="figure"><a name="d0e1585"></a><p class="title"><b>Figure 25. Module Sources Settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_sources.png" alt="Module Installation"></div></div></div></div><br class="figure-break"><p> + There are other repositories available besides CrossWire's own, though the modules available from other repositories do not + represent content officially sanctioned by Crosswire. On the web, see this page for list of those repositories known: + <a class="ulink" href="http://www.crosswire.org/wiki/Module_Repositories" target="_top">http://www.crosswire.org/wiki/Module_Repositories</a> + </p><p> + The list of standard repositories is maintained at CrossWire. Xiphos normally auto-synchronizes with that list one time, + when the user first puts the Module Manager to use. The list may change, as new repositories come into existence; + occasional re-synchronization with the list is suggested, which is accomplished by clicking <span class="guibutton">Load Standard</span>. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="installation"></a>Sword Module Installations</h4></div></div></div><div class="figure"><a name="d0e1610"></a><p class="title"><b>Figure 26. Sword Module Installations</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_config.png" alt="Module Installation"></div></div></div></div><br class="figure-break"><p> + After you have selected your Install Source, click the <span class="guimenuitem">Refresh</span> button to cause + <span class="application">Xiphos</span> to find the module summary available from that source before moving on. + </p><p> + Take note of the "Install Destination". In most cases, you will have a choice of a personal area or a system area. + The details vary according to your operating system. + </p><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="destination-linux"></a>Linux</h5></div></div></div><p> + Unless you run as root (via su or sudo) you will only be able to install in your personal area, under ~/.sword. + If you run as root, or change permissions on the shared directory, you will also be able to install modules for + all users, typically in /usr/share/sword. There have been some requests for Xiphos to provide a means by which + an ordinary (non-root) user could start the program, gain temporary write access to the system area while installing + modules, and then revoke that access after installation is complete. Attempting to devise a scheme to do this has + proven quite difficult, given the different superuser management schemes employed by various Linux distributions. + Therefore, at this time there are no ongoing plans to try to solve this problem, and users are advised to enable + write access to the system area outside Xiphos. + </p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="destination-xp"></a>Windows XP</h5></div></div></div><p> + You may install modules to a shared folder so the modules are available to all users. If you have previously used + "The Sword Project for Windows", this folder will be "C:\Program Files\Crosswire\The Sword Project\Sword". Otherwise + it will be "C:\Documents and Settings\All Users\Application Data\Sword". You may also install modules to a location + that can only be seen by you. This location is "C:\Documents and Settings\YOUR NAME\Application Data\Sword". + </p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="destination-vista"></a>Windows Vista</h5></div></div></div><p> + Vista works much the same as XP, except for the locations. The private location is + "C:\Users\YOUR NAME\AppData\Roaming\Sword". The shared location is "C:\ProgramData\Sword". + </p></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="module-management"></a>Installing, Updating, and Maintaining Modules</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="add-module"></a>Installing, Updating, and Maintaining Modules</h4></div></div></div><div class="figure"><a name="d0e1654"></a><p class="title"><b>Figure 27. Installing and Updating Modules</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_install.png" alt="Module Installation"></div></div></div></div><br class="figure-break"><p> + The module manager generates both a per-type module list as well as a parallel availability list. The latter is + intended to make it easier to find new items without having to work one's way through the per-type list, one subtree at a + time. Modules which are either not yet installed or updated beyond what is currently installed will appear in both lists. + </p><p> + Modules that are already installed will show a checkmark beside them. If a fast search ("lucene") index is available, a magnifying glass will be + displayed, otherwise an "X" will be shown; creation of the index is available on the Maintenance pane. Locked modules, which require that you + purchase an unlock key from the module's copyright holder, will show a lock symbol. If there are modules installed for which a more recent + version is available, a refresh icon will appear between the differing old and new version stamps. There may be an approximate size displayed, + if the repository management provides this information, otherwise a question mark ("-?-") will be shown. + </p><p> + Select new modules to be installed by clicking the checkboxes and then the Install button at the bottom. Any number of + modules may be requested for installation at one time. + </p><p> + If you acquire a locked module and have obtained the cipher key for it, the module is then unlocked in the main window: Open + the module, which will probably appear blank, then using the right-click context menu, choose "Unlock This Module." + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="remove-module"></a>Module Maintenance</h4></div></div></div><div class="figure"><a name="d0e1677"></a><p class="title"><b>Figure 28. Module Maintenance</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_remove.png" alt="Module Maintenance"></div></div></div></div><br class="figure-break"><p> + Several maintenance functions are available: Removal, archival, index, and index deletion. + </p><p> + Removal disposes of a module entirely. There is no recovery of the module unless you have previously archived a copy of it. + </p><p> + Archival is available for any module, although it is provided with personal commentaries specifically in mind. A *.zip of + the module is left in the directory ~/.sword/zip. Archival prior to removal of personal commentaries is recommended, in + order to be available for future re-install if the subject matter of the personal commentary becomes important again. + </p><p> + Indexing is provided so that the underlying Sword search support can create the index needed for the "lucene" fast-search + functions. If the index is not created, plain multi-word search will still be available, but it will be much slower. With + the index in place, searches through an entire Bible can take just a few seconds. + </p><p> + Indexes may be deleted as well. + </p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="non-standard-modules"></a>Installing Non-Standard Modules</h3></div></div></div><p> + Some resource modules in Sword Project format are available from sources other than Crosswire and not from a module manager-ready repository. + Necessarily, installing such a module is a manual task. + </p><p> + Modules are normally packaged as *.zip files; they contain a configuration file plus a number of data files. Installation + of such a module is done by cd'ing to your personal Sword (not <span class="application">Xiphos</span>) configuration + directory, ~/.sword, and unzipping the file there. The configuration file will be left in "mods.d", and the module's data + files will go into a subdirectory of "modules". Alternatively, if you have write access to the system Sword directory, + typically /usr/share/sword, you may cd there instead before unzipping. + </p><p> + Restart <span class="application">Xiphos</span> after installing such a module, so that a fresh instance of the program can + notice the new module in place. + </p></div></div></body></html>
\ No newline at end of file |