DevTools:SWORD - Revision history

David Haslam: /* See also */ Category:SWORD

2018-01-11T14:00:54Z

‎See also: Category:SWORD

David Haslam: /* See also / Sword library versions

2018-01-09T13:06:51Z

‎See also: * Sword library versions

David Haslam: /* Notes */ replace by See also

2018-01-09T12:57:09Z

‎Notes: replace by See also

Refdoc: /* API Documentation */

2018-01-09T10:04:45Z

‎API Documentation

Refdoc: /* CMake & Bindings for SWORD */

2018-01-08T19:31:34Z

‎CMake & Bindings for SWORD

David Haslam: section levels

2018-01-08T15:04:15Z

section levels

David Haslam: /* API Documentation / == CMake & Bindings for SWORD == CMake * Bindings – ''experimental''

2018-01-08T14:59:56Z

‎API Documentation: == CMake & Bindings for SWORD == * CMake * Bindings – ''experimental''

Refdoc: /* Locale file layout */ created new page with content

2014-07-29T22:12:03Z

‎Locale file layout: created new page with content

Refdoc: /* Locale file layout */ removed note re module.conf - not relevant

2014-07-29T22:10:59Z

‎Locale file layout: removed note re module.conf - not relevant

Refdoc: /* Locale file layout */ removed note re non-standard behaviour of BpBible - not relevant here

2014-07-29T22:10:11Z

‎Locale file layout: removed note re non-standard behaviour of BpBible - not relevant here

← Older revision		Revision as of 14:00, 11 January 2018
Line 184:		Line 184:
	[[Category:Documentation\|SWORD]]		[[Category:Documentation\|SWORD]]
	[[Category:Localization\|SWORD]]		[[Category:Localization\|SWORD]]
		+	[[Category:SWORD]]

@@ Line 179: / Line 179: @@
 == See also ==
 [[Category:Development tools|SWORD]]
 [[Category:Documentation|SWORD]]
 [[Category:Localization|SWORD]]

@@ Line 178: / Line 178: @@
 See [http://www.crosswire.org/~ghellings/svnclassdocs/ The SWORD Project - API documentation] for the current (or very nearly current) SVN HEAD.
-==Notes==
+== See also ==
 [[Category:Development tools|SWORD]]
 [[Category:Documentation|SWORD]]
 [[Category:Localization|SWORD]]

@@ Line 176: / Line 176: @@
 == API Documentation ==
-See [http://www.crosswire.org/~ghellings/svnclassdocs/ The SWORD Project - API documentation] for the current (or very nearly current) SVN HEAD. Starting with the next version of the documentation (post 1.5.11), there will also be other documentation placed there for developers to keep track of.
+See [http://www.crosswire.org/~ghellings/svnclassdocs/ The SWORD Project - API documentation] for the current (or very nearly current) SVN HEAD.
 ==Notes==

@@ Line 177: / Line 177: @@
 == API Documentation ==
 See [http://www.crosswire.org/~ghellings/svnclassdocs/ The SWORD Project - API documentation] for the current (or very nearly current) SVN HEAD. Starting with the next version of the documentation (post 1.5.11), there will also be other documentation placed there for developers to keep track of.
 ==Notes==

@@ Line 1: / Line 1: @@
-= Documentation =
+== Documentation ==
-== The SWORD Engine API Primer ==
+=== The SWORD Engine API Primer ===
 ''The API primer is quite old and has not been updated for a long time.If in doubt, consult the API Doxygen documentation (see below) and look at code samples within the source tree under /examples''
 This short introduction gives a brief review of the underlying classes of the The SWORD Engine's interface. Understanding this tutorial will give a good foundational knowledge necessary for building applications with The SWORD Engine API. This tutorial begins by showing the 'hard' way to do things. This understanding is foundational for learning 'how things work' in the world of SWORD; but don't get discouraged, there are higher level factories which are explained later, which hide much of this elementary work.
-==== Section 1 - SWModule / SWKey / SWFilter ====
+=== SWModule / SWKey / SWFilter ===
 The SWModule class is probably the most important core object in the API. Every module descends from it. Immediate descendants include subdivided module types such as: SWText (Bible texts), SWCom (commentaries), SWLD (lexicons and dictionaries). Descendants of these subdivided types are specialized Module 'drivers', including RawText (descends from SWText and reads raw text data files), RawCom, zText (SWText descendent that reads compressed data files), etc.
@@ Line 61: / Line 61: @@
 SWModules can contain one or more SWFilters for rendering their text to the appropriate formats. SWFilters are added to an SWModule using the AddRenderFilter() and AddStripFilter() methods. Render filters filter the text for display whereas Strip filters filter the text to a raw form used by such as the search functions. Typical SWFilter descendants include: GBFPlain (filters from General Bible Format (GBF) to Plain Text), GBFRTF (GBF to Rich Text Format), RWPRTF (filters special greek tags in Robertson's Word Pictures to Rich Text Format).
-==== Section 2 - SWMgr / MarkupFilterMgr / SWConfig ====
+=== SWMgr / MarkupFilterMgr / SWConfig ===
 SWMgr is a high level factory which is more typically used by a frontend developer to access all of the installed modules on a system.
@@ Line 127: / Line 127: @@
 screenInfo.Save();</pre>
-==== Section 3 - Bringing It All Together ====
 The following is an example included in the SWORD engine source code. You should be able to read this entirely through now:

@@ Line 179: / Line 179: @@
 == Locale file layout ==
 A locale file is stored in the '''locales.d''' folder under the Sword path.
-The file name is generally the language code with extension .conf <ref>Not to be confused with a [[DevTools:conf Files|module.conf file]]</ref>
+The file name is generally the language code with extension .conf
 Locales require a few things.  Let's step through the German locale:

@@ Line 250: / Line 250: @@
 how they parse.
-Note that punctuation characters commonly used in verse references are not allowed in localized book names. These include the hyphen '-' (used for verse ranges), the colon ':' (used to separate chapter and verse numbers), and the comma ',' (used for verse lists)<ref>BPBible, allows hyphens via non-standard locale files; see [http://code.google.com/p/bpbible/wiki/TranslatingBPBible#Bible_Book_names here] for details.</ref>. Additionally, numerals in non-initial position are not permitted in book names (i.e. '3John' is valid but 'Psalm151' is not).
+Note that punctuation characters commonly used in verse references are not allowed in localized book names. These include the hyphen '-' (used for verse ranges), the colon ':' (used to separate chapter and verse numbers), and the comma ',' (used for verse lists). Additionally, numerals in non-initial position are not permitted in book names (i.e. '3John' is valid but 'Psalm151' is not).
 Submissions should be sent to sword-support@crosswire.org