[sword-svn] r3831 - trunk/bindings/cordova/cordova-plugin-crosswire-sword

[scribe at crosswire.org]

Author: scribe
Date: 2020-12-07 19:26:23 -0500 (Mon, 07 Dec 2020)
New Revision: 3831

Removed:
   trunk/bindings/cordova/cordova-plugin-crosswire-sword/doc/
Modified:
   trunk/bindings/cordova/cordova-plugin-crosswire-sword/README.md
   trunk/bindings/cordova/cordova-plugin-crosswire-sword/package.json
   trunk/bindings/cordova/cordova-plugin-crosswire-sword/plugin.xml
Log:
cordova plugin migrated docs to README.md


Modified: trunk/bindings/cordova/cordova-plugin-crosswire-sword/README.md
===================================================================
--- trunk/bindings/cordova/cordova-plugin-crosswire-sword/README.md	2020-12-08 00:12:31 UTC (rev 3830)
+++ trunk/bindings/cordova/cordova-plugin-crosswire-sword/README.md	2020-12-08 00:26:23 UTC (rev 3831)
@@ -19,4 +19,131 @@
 
 # org.crosswire.sword.cordova.SWORD
 
-Plugin documentation: [doc/index.md](doc/index.md)
+This plugin defines a global 'SWORD' object, which provides access to CrossWire's SWORD engine.
+Although the object is in the global scope, it is not available until after the `deviceready` event.
+
+### Supported Platforms
+
+- Android
+- iOS
+- others should work from source, but binaries are only included for these
+
+### Quick Example
+
+	document.addEventListener("deviceready", onDeviceReady, false);
+
+	function onDeviceReady() {
+
+		var moduleName = 'KJV';
+		var verse = 'Jn.3.16';
+
+		SWORD.mgr.getModuleByName(moduleName, module) {
+			module.setKeyText(verse, function() {
+				module.renderText(function(entryText) {
+					console.log(verse + ': ' + entryText + '(' + moduleName + ')');
+				});
+			});
+		});
+	}
+
+## Installation
+
+	cordova plugin add cordova-plugin-crosswire-sword
+
+
+## Defines and statics
+	SWORD.CATEGORY_BIBLES
+	SWORD.CATEGORY_COMMENTARIES
+	SWORD.CATEGORY_LEXDICTS
+	SWORD.CATEGORY_GENBOOKS
+	SWORD.CATEGORY_DAILYDEVOS
+	SWORD.osisOT - array of OSIS OT Books
+	SWORD.osisNT - array of OSIS NT Books
+
+
+## Properties
+	SWORD.available - if SWORD is available for use
+	SWORD.version - SWORD C++ version
+	SWORD.installMgr - access to SWORD's InstallMgr (an instance of class InstallMgr described below)
+	SWORD.mgr - access to SWORD's module library manager SWMgr (an instance of class SWMgr described below)
+	SWORD.httpUtils - access to general http requests methods provided by SWORD's C++ transport agent (see HTTPUtils described below)
+
+
+## Class Properties and Methods
+
+### InstallMgr
+	InstallMgr.setUserDisclaimerConfirmed
+	InstallMgr.syncConfig
+	InstallMgr.getRemoteSources
+	InstallMgr.refreshRemoteSource
+	InstallMgr.getRemoteModInfoList
+	InstallMgr.getRemoteModuleByName
+	InstallMgr.remoteInstallModule
+	InstallMgr.uninstallModule
+
+
+### SWModule
+	SWModule.SEARCHTYPE_REGEX
+	SWModule.SEARCHTYPE_PHRASE
+	SWModule.SEARCHTYPE_MULTIWORD
+	SWModule.SEARCHTYPE_ENTRYATTR
+	SWModule.SEARCHTYPE_LUCENE
+
+	SWModule.SEARCHOPTION_ICASE
+
+	SWModule.name
+	SWModule.description
+	SWModule.category
+	SWModule.direction
+	SWModule.language
+	SWModule.font
+	SWModule.shortCopyright
+	SWModule.shortPromo
+	SWModule.cipherKey
+	SWModule.remoteSourceName
+
+	SWModule.setKeyText
+	SWModule.search
+	SWModule.getKeyText
+	SWModule.getRenderText
+	SWModule.getStripText
+	SWModule.getRawEntry
+	SWModule.shareVerse
+	SWModule.getRenderChapter
+	SWModule.getRenderHeader
+	SWModule.getKeyChildren
+	SWModule.getVerseKey
+	SWModule.getConfigEntry
+	SWModule.popError
+	SWModule.getEntryAttribute
+	SWModule.next
+	SWModule.previous
+	SWModule.begin
+	SWModule.getBookNames
+	SWModule.parseKeyList
+	SWModule.setRawEntry
+
+### SWMgr
+	SWMgr.getModInfoList
+	SWMgr.getModuleByName
+	SWMgr.getExtraConfigSections
+	SWMgr.getExtraConfigKeys
+	SWMgr.getExtraConfigValue
+	SWMgr.setExtraConfigValue
+	SWMgr.addExtraConfig
+	SWMgr.startBibleSync
+	SWMgr.stopBibleSync
+	SWMgr.sendBibleSyncMessage
+	SWMgr.setJavascript
+	SWMgr.getAvailableLocales
+	SWMgr.setDefaultLocale
+	SWMgr.translate
+	SWMgr.setGlobalOption
+	SWMgr.getPrefixPath
+
+### HTTPUtils
+	HTTPUtils.METHOD_GET
+	HTTPUtils.METHOD_POST
+
+	HTTPUtils.makeRequest
+

Modified: trunk/bindings/cordova/cordova-plugin-crosswire-sword/package.json
===================================================================
--- trunk/bindings/cordova/cordova-plugin-crosswire-sword/package.json	2020-12-08 00:12:31 UTC (rev 3830)
+++ trunk/bindings/cordova/cordova-plugin-crosswire-sword/package.json	2020-12-08 00:26:23 UTC (rev 3831)
@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-crosswire-sword",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "The SWORD Project Plugin",
   "cordova": {
     "id": "cordova-plugin-crosswire-sword",

Modified: trunk/bindings/cordova/cordova-plugin-crosswire-sword/plugin.xml
===================================================================
--- trunk/bindings/cordova/cordova-plugin-crosswire-sword/plugin.xml	2020-12-08 00:12:31 UTC (rev 3830)
+++ trunk/bindings/cordova/cordova-plugin-crosswire-sword/plugin.xml	2020-12-08 00:26:23 UTC (rev 3831)
@@ -4,7 +4,7 @@
     xmlns:rim="http://www.blackberry.com/ns/widgets"
     xmlns:android="http://schemas.android.com/apk/res/android"
     id="cordova-plugin-crosswire-sword"
-    version="0.2.2">
+    version="0.2.3">
     <name>cordova-plugin-crosswire-sword</name>
     <description>The SWORD Project Plugin</description>
     <license>GNU 2.0</license>