DevTools:Locale Files - Revision history

Scribe: /* Book Abbrevs */

2019-08-19T20:59:50Z

‎Book Abbrevs

Scribe: /* Pref Abbrevs */

2019-08-19T20:25:10Z

‎Pref Abbrevs

Scribe: /* Pref Abbrevs */

2019-08-19T18:46:02Z

‎Pref Abbrevs

Scribe: /* Pref Abbrevs */

2019-08-19T18:45:31Z

‎Pref Abbrevs

Scribe at 18:42, 19 August 2019

2019-08-19T18:42:34Z

Scribe: /* Meta */

2019-08-19T18:36:22Z

‎Meta

David Haslam: /* Maintained locale files */ Category:SWORD

2018-01-11T14:05:58Z

‎Maintained locale files: Category:SWORD

Refdoc at 12:06, 8 January 2018

2018-01-08T12:06:04Z

Refdoc: /* Maintained locale files */

2018-01-08T12:05:24Z

‎Maintained locale files

Refdoc: /* Related Sword utilities */

2018-01-08T09:29:45Z

‎Related Sword utilities

@@ Line 38: / Line 38: @@
 === Book Abbrevs ===
-This section permits a "many-to-one" mapping for each book, as required by the references used in the Bible translation or commentary, etc.
+This section specifies all possible alternative book names and abbreviations for each Bible book.  These are required for the locale to work correctly within the SWORD engine.  This section teaches the verse reference parser all possible ways to represent a book name.  The verse parser will allow partial matches and will sort entries in this section alphabetically by their codepoint values and give preference to partial matches with lower alphabetical order, e.g, "1 C" is a partial match for 1 CORINTHIANS=1Cor and 1 CHRONICLES=1Chr, but 1 CHRONICLES will be preferred because it is alphabetically first.  If the desire is to have "1 C" prefer 1Cor, instead, then a 3rd entry is required: 1 C=1Cor.  This preference for disambiguation is important to consider for partial matches, as they are prolific throughout Biblical literature, e.g., Jud=Jude (instead of Judges), Jo=John (instead of Job, Jonah, or Joshua)
   [Book Abbrevs]
@@ Line 45: / Line 49: @@
 CORINTHIANS=1Cor
 JN=1Jn
-These are the abbreviations for each book and are REQUIRED for the
-locale to work correctly in the engine.  They are actually more than
+As expressed earlier, notice that 1 Chronicles would come, alphabetically
 before 1 Corinthians.  The above entries say: 1Cor (which is the OSIS book id for 1 Corinthians)
-has precedence up through "1 C", any character beyond that will
+has precedence up through "1 C", any character beyond that will disambiguate the entry anyway, so the default 1 CHRONICLES or 1
-disambiguate the entry anyway, so the default 1 CHRONICLES or 1
+CORINTHIANS entries would correctly resolve partial matches with more characters starting with "1 C".
 '''IMPORTANT''':
-There MUST be at least 1 abbreviation entry for each book name
+All verse references output by SWORD must be legal, parsable reference as input to SWORD.  This means that there MUST be at least 1 abbreviation entry for each book name
-comprised of a toupper (uppercase function) of the entire string
+which is comprised of a toupper (uppercase function) of the entire string EXACTLY as you have translated it in the [Text] section.
-Following are the REQUIRED entries from our excerpt book names above.
+For example, the following are the REQUIRED entries for our book names from the excerpt [Text] section example above.
 . MOSE=Gen
 . MOSE=Ex
@@ Line 76: / Line 82: @@
 alphabetical precedence, but might want Matthew or Mark).
 In this case, you would put in an entry MA=Matt or MA=Mark
 === Pref Abbrevs ===

@@ Line 79: / Line 79: @@
 === Pref Abbrevs ===
-This section define a preferred abbreviation for each book.  These are typically used when SWORD is asked to display a very short verse reference or a short Bible book name.  The format for these entries is: osisID=Preferred Abbreviation, e.g.,
+This section designates the preferred abbreviation for each book.  These are typically used when SWORD is asked to display a very short verse reference or a short Bible book name.  The format for these entries is: osisID=Preferred Abbreviation, e.g.,
   [Pref Abbrevs]

@@ Line 89: / Line 89: @@
   Josh=Jos
   Judg=Rich
-−
 Each preferred abbreviation must necessarily be parsable by the exhaustive list of abbreviations in the [Book Abbrevs] section.

← Older revision		Revision as of 18:45, 19 August 2019
Line 90:		Line 90:
	Judg=Rich		Judg=Rich

		+	Each preferred abbreviation must necessarily be parsable by the exhaustive list of abbreviations in the [Book Abbrevs] section.
		+

	You can test your locale with the sword/tests/parsekey test program (this		You can test your locale with the sword/tests/parsekey test program (this

@@ Line 76: / Line 76: @@
 alphabetical precedence, but might want Matthew or Mark).
 In this case, you would put in an entry MA=Matt or MA=Mark
 You can test your locale with the sword/tests/parsekey test program (this

@@ Line 15: / Line 15: @@
   Name=de
   Description=German
-  Encoding=ISO8859-1
+  Encoding=UTF-8
 The above information is used to define the locale.  They should be
-fairly obvious.  Name should be taken from a standard abbrev, probably
+fairly obvious.  Name should be, in preferred order, an ISO 639-1 alpha 2 language code, an ISO 639-2+ alpha 3 lanugage code, or an Ethnologue 3 letter language code.  SWORD includes a fairly comprehensive list of these available at: sword/locales.d/locales.conf.
-returned from echo $LANG.  Please understand that this, and all entries
+This, and all entries are case sensitive.
 === Text ===

← Older revision		Revision as of 14:05, 11 January 2018
Line 98:		Line 98:

	[[Category:Localization\|Locale Files]]		[[Category:Localization\|Locale Files]]
		+	[[Category:SWORD]]

@@ Line 2: / Line 2: @@
 The file name is generally the language code with extension .conf <br>
 As Unicode text files, locale files should be encoded UTF-8 (without BOM) and the file name should include "-utf8" after the language code.<br>
-Other encodings are allowed, but the encoding should always be specified in the Meta section.
+Other encodings are deprecated.
 == Example ==

@@ Line 91: / Line 91: @@
 == Maintained locale files ==
-Locale files are not automatically installed with any of the front-end applications.<br>
 On the CrossWire server, the locale files are stored in <tt>/space/home/ftp/pub/sword/raw/locales.d</tt><br>
 Users with FTP or SCP access are able to download them from that folder.

← Older revision		Revision as of 09:29, 8 January 2018
Line 89:		Line 89:

	Submissions should be sent to sword-support@crosswire.org		Submissions should be sent to sword-support@crosswire.org
−
−	~~== Related Sword utilities ==~~
−	~~The following utilities make use of Sword locale files:~~
−	* vs2osisref - parse verse reference to OSISRef markup
−	* vs2osisreftext
−	~~The former is called by Perl scripts xrefmake.pl and xrefadd.pl that are available in CrossWire utilities.~~

	== Maintained locale files ==		== Maintained locale files ==