Difference between revisions of "Creating and Maintaining a Module Repository"
(→Zipped files) |
|||
| Line 1: | Line 1: | ||
== Layout of a Module repository == | == Layout of a Module repository == | ||
| − | + | In order to deal with all ways the various frontends use our module [http://en.wikipedia.org/wiki/Repository repository] the following needs to be provided: | |
| + | |||
| + | An echo of the '''mods.d''' and '''modules''' area as found under any Sword module area on your system (e.g. '''~/.sword''') plus '''mods.d.tar.gz''', as created by: | ||
tar czvf mods.d.tar.gz mods.d/* | tar czvf mods.d.tar.gz mods.d/* | ||
| − | + | Also a directory with zipped mnodules for JSword derrived front ends. This can also serve as a repository for smaller devices without integrated module manager. | |
| − | + | This needs to be accessible both via FTP and via HTTP (for direct download and for JSword) | |
| − | == Zipped | + | == Zipped Modules == |
Some of the smaller devices running a sword frontend do not have a network enabled module manager. Users of these devices need to download their modules as zipped files and unzip them in the right place - e.g. a SD card. | Some of the smaller devices running a sword frontend do not have a network enabled module manager. Users of these devices need to download their modules as zipped files and unzip them in the right place - e.g. a SD card. | ||
| Line 29: | Line 31: | ||
cd ~ftp/pub/sword | cd ~ftp/pub/sword | ||
zip zip/mybook.zip mods.d/mybook.conf modules/genbook/rawgenbooks/mybook | zip zip/mybook.zip mods.d/mybook.conf modules/genbook/rawgenbooks/mybook | ||
| + | |||
| + | === MS Windows zip === | ||
| + | |||
| + | This is a zip file which will selfextract on a MS Windows computer. To create it you require: | ||
| + | |||
| + | ''missing content '' | ||
| + | |||
| + | === MacOS X zip === | ||
| + | |||
| + | ''missing content'' | ||
== Jsword/BibleDesktop == | == Jsword/BibleDesktop == | ||
Revision as of 12:30, 29 November 2008
Contents
Layout of a Module repository
In order to deal with all ways the various frontends use our module repository the following needs to be provided:
An echo of the mods.d and modules area as found under any Sword module area on your system (e.g. ~/.sword) plus mods.d.tar.gz, as created by:
tar czvf mods.d.tar.gz mods.d/*
Also a directory with zipped mnodules for JSword derrived front ends. This can also serve as a repository for smaller devices without integrated module manager.
This needs to be accessible both via FTP and via HTTP (for direct download and for JSword)
Zipped Modules
Some of the smaller devices running a sword frontend do not have a network enabled module manager. Users of these devices need to download their modules as zipped files and unzip them in the right place - e.g. a SD card.
It is also helpful for people who have no access to direct internet connections or live in countries with monitored access to the internet[1] to be able to download (and possibly distribute) zipped modules.
These come in three formats
- rawzip (required by JSword derrived front-ends)
- zip for MS Windows
- zip for Mac OSX
rawzip
This is a zipped archive of a module in the file and directory layout used in the local module directory.
E.g. to create from your own module directory a zipped module of a uncompressed GenBook do this:
cd ~ftp/pub/sword zip zip/mybook.zip mods.d/mybook.conf modules/genbook/rawgenbooks/mybook
MS Windows zip
This is a zip file which will selfextract on a MS Windows computer. To create it you require:
missing content
MacOS X zip
missing content
Jsword/BibleDesktop
Jsword derrived frontends use a different module management process.
Firstly they require a HTTP connection, secondly they require only mods.d.tar.gz and a directory of zipped modules (rawzip format).
