DevTools:SWORD - Revision history

David Haslam: /* Source code */ 13

2026-11-03T09:15:12Z

Source code: 13

← Older revision		Revision as of 09:15, 3 November 2026
Line 1:		Line 1:
	== Source code ==		== Source code ==
	Although for many years it was developed on SVN, from 15 August 2026, SWORD's official source home is now:		Although for many years it was developed on SVN, from 13 August 2026, SWORD's official source home is now:

	: https://git.crosswire.org/main/sword		: https://git.crosswire.org/main/sword

David Haslam: /* Source code */ added link to official home

2026-11-03T09:07:13Z

Source code: added link to official home

← Older revision		Revision as of 09:07, 3 November 2026
Line 1:		Line 1:
	== Source code ==		== Source code ==
			Although for many years it was developed on SVN, from 15 August 2026, SWORD's official source home is now:

			: https://git.crosswire.org/main/sword

	== Documentation ==		== Documentation ==

David Haslam: Inserted == Source code ==

2026-11-03T09:03:10Z

Inserted == Source code ==

← Older revision		Revision as of 09:03, 3 November 2026
Line 1:		Line 1:
			== Source code ==


	== Documentation ==		== Documentation ==

David Haslam: /* API Documentation */ Section removed

2026-11-03T09:02:24Z

API Documentation: Section removed

← Older revision		Revision as of 09:02, 3 November 2026
Line 174:		Line 174:
	}		}
	</pre>		</pre>

	~~== API Documentation ==~~
	~~See [http://www.crosswire.org/~ghellings/svnclassdocs/ The SWORD Project - API documentation] for the current (or very nearly current) SVN HEAD.~~

	== See also ==		== See also ==

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

2018-01-11T14:00:54Z

David Haslam: /* See also / Sword library versions

2018-01-09T13:06:51Z

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

2018-01-09T12:57:09Z

Notes: replace by See also

← Older revision		Revision as of 12:57, 9 January 2018
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.		See [http://www.crosswire.org/~ghellings/svnclassdocs/ The SWORD Project - API documentation] for the current (or very nearly current) SVN HEAD.

	==~~Notes~~==		== See also ==
	~~<references />~~


	[[Category:Development tools\|SWORD]]		[[Category:Development tools\|SWORD]]
	[[Category:Documentation\|SWORD]]		[[Category:Documentation\|SWORD]]
	[[Category:Localization\|SWORD]]		[[Category:Localization\|SWORD]]

Refdoc: /* API Documentation */

2018-01-09T10:04:45Z

API Documentation

← Older revision		Revision as of 10:04, 9 January 2018
Line 176:		Line 176:

	== API Documentation ==		== 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==		==Notes==

Refdoc: /* CMake & Bindings for SWORD */

2018-01-08T19:31:34Z

CMake & Bindings for SWORD

← Older revision		Revision as of 19:31, 8 January 2018
Line 177:		Line 177:
	== API Documentation ==		== 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. 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.

	~~== CMake & Bindings for SWORD ==~~
	* [[DevTools:CMake\|CMake]]
	* [[DevTools:Bindings\|Bindings]] – ''experimental''

	==Notes==		==Notes==

David Haslam: section levels

2018-01-08T15:04:15Z

section levels

← Older revision		Revision as of 15:04, 8 January 2018
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''		''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.		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.		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).		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.		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>		screenInfo.Save();</pre>
	===~~= Section 3 -~~ Bringing It All Together ====
			=== 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:		The following is an example included in the SWORD engine source code. You should be able to read this entirely through now:

← 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]]

← Older revision		Revision as of 13:06, 9 January 2018
Line 179:		Line 179:

	== See also ==		== See also ==
			* [[Sword library versions]]

	[[Category:Development tools\|SWORD]]		[[Category:Development tools\|SWORD]]
	[[Category:Documentation\|SWORD]]		[[Category:Documentation\|SWORD]]
	[[Category:Localization\|SWORD]]		[[Category:Localization\|SWORD]]