DevTools:Modules - Revision history

David Haslam: /* Collect and Install Software Tools */ Notes

2025-07-09T16:05:01Z

‎Collect and Install Software Tools: Notes

David Haslam: /* Collect and Install Software Tools */ 2025-07-08 A new version of the Windows tools updated to '''SVN r3906''' has been posted [https://src.thehellings.com/greg/mingw-sword-build/-/releases here].

2025-07-09T16:03:21Z

‎Collect and Install Software Tools: <ref>2025-07-08 A new version of the Windows tools updated to '''SVN r3906''' has been posted [https://src.thehellings.com/greg/mingw-sword-build/-/releases here].</ref>

David Haslam: /* Related Pages / deleted GenBook and OpenOffice

2020-06-04T20:31:50Z

‎Related Pages: deleted *GenBook and OpenOffice

Refdoc: /* Submit the Module to CrossWire for Distribution */

2018-05-31T15:47:11Z

‎Submit the Module to CrossWire for Distribution

Refdoc: /* Related Pages */

2018-01-10T15:24:04Z

‎Related Pages

Refdoc: /* Create the .conf File */

2018-01-10T15:21:01Z

‎Create the .conf File

Refdoc: /* Markup */

2018-01-09T07:47:25Z

‎Markup

Refdoc: /* Import formats */

2018-01-08T15:53:03Z

‎Import formats

Refdoc: /* IMP Format */

2018-01-08T15:49:59Z

‎IMP Format

Refdoc: /* Versification */

2018-01-08T15:48:40Z

‎Versification

@@ Line 12: / Line 12: @@
 =Creating a module=
 ==Collect and Install Software Tools==
-*Install SWORD and collect SWORD module creation tools. For Linux (and Mac?) many of the module creation tools come installed with SWORD, so if you aren't comfortable installing from source simply install from your distribution's repositories. For Windows, you will need to download the module creation utilities from [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/ http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/].<ref>2025-07-08 A new version of the Windows tools updated to '''SVN r3906''' has been posted [https://src.thehellings.com/greg/mingw-sword-build/-/releases here].</ref> Be sure to download the most recent '''icudt dll''' and unzip it in the folder where you place the utilities.
+*Install SWORD and collect SWORD module creation tools. For Linux (and Mac?) many of the module creation tools come installed with SWORD, so if you aren't comfortable installing from source simply install from your distribution's repositories. For Windows, you will need to download the module creation utilities from [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/ http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/].<ref>2025-07-08 A new version of the Windows tools updated to '''SVN r3906''' has been posted [https://src.thehellings.com/greg/mingw-sword-build/-/releases here].</ref><ref>Be sure to download the most recent '''icudt dll''' and unzip it in the folder where you place the utilities.</ref>
 *[[Frontends:Xiphos|Xiphos]] (for Windows) users should find a complete set of Sword tools in the Xiphos directory.
@@ Line 20: / Line 20: @@
 *Obtain a good programmer's text editor, preferentially one which does syntax and validation checks. See [[DevTools:Text Editors]] for examples
 <references />

@@ Line 12: / Line 12: @@
 =Creating a module=
 ==Collect and Install Software Tools==
-*Install SWORD and collect SWORD module creation tools. For Linux (and Mac?) many of the module creation tools come installed with SWORD, so if you aren't comfortable installing from source simply install from your distribution's repositories. For Windows, you will need to download the module creation utilities from [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/ http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/].<ref>Unofficial builds that may be from more recent SVN revisions may be found [http://dl.thehellings.com/sword-utils/ here].</ref> Be sure to download the most recent icudt dll and unzip it in the folder where you place the utilities.
+*Install SWORD and collect SWORD module creation tools. For Linux (and Mac?) many of the module creation tools come installed with SWORD, so if you aren't comfortable installing from source simply install from your distribution's repositories. For Windows, you will need to download the module creation utilities from [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/ http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/].<ref>2025-07-08 A new version of the Windows tools updated to '''SVN r3906''' has been posted [https://src.thehellings.com/greg/mingw-sword-build/-/releases here].</ref> Be sure to download the most recent '''icudt dll''' and unzip it in the folder where you place the utilities.
 *[[Frontends:Xiphos|Xiphos]] (for Windows) users should find a complete set of Sword tools in the Xiphos directory.

@@ Line 163: / Line 163: @@
 *Guide to Writing [[TEI Dictionaries]]
 *Guide to [[Converting SFM Bibles to OSIS]]
 *[[Encoding| Text Encoding]]
 *Related [[File Formats]]

@@ Line 147: / Line 147: @@
 ==Submit the Module to CrossWire for Distribution==
 First ensure that your module complies with our stated [[copyright]] policy.
 If your module is to be sold rather than distributed for free, CrossWire has a tool to encrypt a module. However, we do not handle any payments, so we always suggest that it's for the owner (or an authorised agent) to host the payment system as well as the delivery of the unlock key.
-After you have tested your module, you may wish to submit it to the SWORD Project for public release so that other people can benefit from your work. All modules submitted to the SWORD Project for distribution either on the internet or on CDs should include both the module as a single document and the .conf file.
+After you have tested your module, you may wish to submit it to the SWORD Project for public release so that other people can benefit from your work. The submission itself should be of an uncompiled, plain text document in either VPL (verse-per-line), IMP (import),  OSIS or TEI [[File Formats|format]], ready to be run through one of the module build tools. '''Do not''' submit built modules that you have imported to Sword format; submit only source documents. You also need to supply the relevant conf file entries.  Before any module will be considered for hosting, we require that the following minimum set of module configuration fields be included in its .conf file:  '''Description''', '''About''', '''DistributionLicense''', and '''TextSource'''. For further detail please read [[Module Submission]]
 When you decide that your module is ready to be submitted, you may email it to modules@crosswire.org. If you are unable to email it or would prefer to send the files by some other means, you may contact us at the same email address, and we can discuss other arrangements.

@@ Line 169: / Line 169: @@
 *[[Encoding| Text Encoding]]
 *Related [[File Formats]]
-*List of Known [[Module Repositories]]
+*List of [[Official and Affiliated Module Repositories]]
 *[[Zipped modules]]
 *[[Module Requests]]

@@ Line 135: / Line 135: @@
 ==Create the .conf File==
-In order to test and before submitting a new module, you need to create a .conf file, which tells Sword how to recognize and what to do with your module. Instructions for creating a .conf file are on the [[DevTools:confFiles]] page.
+In order to test and before submitting a new module, you need to create a .conf file, which tells Sword how to recognize and what to do with your module. Instructions for creating a .conf file are on the [[DevTools:conf Files]] page.
 ==Install and Test the Module==

@@ Line 58: / Line 58: @@
 ===Markup===
-(''see also [[Various Tools]]'')
+(''see also [[DevTools:Misc]]'')
 We will accept only plain texts or texts marked up in OSIS or TEI, with the sole exception texts based on CCEL documents that are marked up in ThML.

← Older revision		Revision as of 15:53, 8 January 2018
Line 84:		Line 84:

	'''For CrossWire import purposes VPL is acceptable for text only Bibles without any further markup'''		'''For CrossWire import purposes VPL is acceptable for text only Bibles without any further markup'''
		+
		+	===Imp Format ===
		+
		+	GenBook and LexDict modules may also be submitted in [[DevTools:Imp Format\|Imp Format]].
		+
	==Validate the Source Text==		==Validate the Source Text==

← Older revision		Revision as of 15:49, 8 January 2018
Line 84:		Line 84:

	'''For CrossWire import purposes VPL is acceptable for text only Bibles without any further markup'''		'''For CrossWire import purposes VPL is acceptable for text only Bibles without any further markup'''
−	~~====IMP Format====~~
−	~~:'''IMPORTANT''': ''Please first read http://www.crosswire.org/tracker/browse/MODTOOLS-92''~~
−
−	The [[File Formats#IMP\|IMP]] or import format is the most versatile of the import formats and may be used in creating all types of modules (Bibles, commentaries, dictionaries, daily devotionals, glossaries, general books, etc.) in any supported markup (GBF, ThML, OSIS or TEI). Each entry in an imp file may take as many lines as are needed. The first line of the entry will have a format such as "$$$<key>" and will be followed by all lines of text that should be included with that entry. So our above example in imp format would be written as:
−	~~$$$Genesis 1:1~~
−	~~In the beginning God created the heaven and the earth.~~
−	~~$$$Genesis 1:2~~
−	~~And the earth was without form, and void; and darkness was upon the face of the deep. And the Spirit of God moved upon the face of the waters.~~
−
−	With multiline content per key, any content line (except the last for each key) that would otherwise end with a space should be terminated by the continuation code \ (reverse solidus) to prevent joining words. e.g.
−	~~$$$Genesis 1:2~~
−	~~And the earth was without form, and void; \~~
−	~~and darkness was upon the face of the deep. \~~
−	~~And the Spirit of God moved upon the face of the waters.~~
−	~~$$$Genesis 1:3~~
−
−	Commentaries would follow the same format, but would probably include a greater number of lines of text. If your Bible or commentary uses a single entry to handle multiple verses, simply give a list or range of verses as the key (e.g. "$$$Genesis 1:1-5", "$$$Exodus 1", "$$$Leviticus 1:1,5"). Lexicons, dictionaries, glossaries and daily devotionals would take a form such as:
−	~~$$$Adam~~
−	~~Adam was the first man created by God.~~
−	~~$$$Eve~~
−	~~Eve was the first woman created by God.~~
−
−	~~For daily devotionals, you must encode the key as "$$$mm.dd", such as "$$$01.01" for January 1st and "$$$12.31" for December 31st.~~
−	~~<br>Example from M'Cheyne's Bible Reading Calendar for January 1st:~~
−	~~<pre>~~
−	~~$$$01.01~~
−	~~<br />Family Reading: <scripRef>Genesis 1</scripRef>~~
−	~~<br />Family Reading: <scripRef>Matthew 1</scripRef>~~
−	~~<br />Secret Reading: <scripRef>Ezra 1</scripRef>~~
−	~~<br />Secret Reading: <scripRef>Acts 1</scripRef>~~
−	~~</pre>~~
−	~~Here the '''scripRef''' element is from '''ThML'''.~~
−
−	General books are encoded with each book division as a separate entry. The entries are then listed as a tree hierarchy with keys similar to a file system directory structure. For example, if you were encoding the Josephus' Works, you might have a structure like this:
−	~~$$$/War~~
−	~~The War of the Jews~~
−	~~$$$/War/Book 1~~
−	~~Book 1 of the War of the Jews~~
−	~~$$$/War/Book 1/Chapter 1~~
−	~~Chapter 1 of Book 1 of the War of the Jews~~
−	~~$$$/War/Book 1/Chapter 1/Section 1~~
−	~~Section 1 of Chapter 1 of Book 1 of the War of the Jews~~
−	~~$$$/War/Book 1/Chapter 1/Section 2~~
−	~~Section 2 of Chapter 1 of Book 1 of the War of the Jews~~
−
−	~~''' For CrossWire purposes we will accept only GenBook modules and LexDict modules in imp format. Bibles must be in VPL or OSIS'''~~
−
	==Validate the Source Text==		==Validate the Source Text==

@@ Line 30: / Line 30: @@
 ===Versification===
-For Bible modules, SWORD supports [[Alternate Versification]]s. A prerequisite for a module that would not match the default versification for the KJV Bible is to decide which of the several versifications is most suitable for the new module.
+For Bible modules, SWORD supports a growing number of [[Alternate Versification|Versifications]]. A prerequisite for submission of a module that would not match the default versification for the KJV Bible is to decide which of the several versifications is most suitable for the new module.
 ===Encoding===