CrossWire Bible Society - User contributions [en]

Main Page

2014-10-02T20:13:58Z

Jon Behrens: /* Development Tools */

{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid green;padding-left:1em;padding-right:0.5em;background:#E4FFDF;padding-bottom:0.5em;" width="100%"|
==Welcome to the CrossWire Developers' Wiki==
Be sure to check out our [[Current Projects|current projects]] page to see how you might use your skills here at [http://crosswire.org/ CrossWire].

Please look at our general [[Volunteers|volunteering]] page, the [http://www.crosswire.org/bugs bugs] database and/or assist end-users in the [http://www.crosswire.org/forums forums].

Also, we have pages describing the [[Purpose Statement|purpose]] of our work and the [[About Us|CrossWire Bible Society]] itself.

You can even come and chat with SWORD developers on IRC: [http://webchat.freenode.net/?randomnick=1&channels=sword&prompt=1 #sword] on FreeNode.

Newcomers should take note of the difference between SWORD as a [https://en.wikipedia.org/wiki/Front_and_back_ends back-end], and the SWORD Project as a front-end application for Windows.
|}
{| cellspacing="1" width="100%"
|- valign="top"

| style="background:#E8F1FF;border-style:solid;border-width:1px;border-color:#00ccFF;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==SWORD Modules==
* List of Known [[Module Repositories]]
* Information about Unicode [[Fonts]]
* [[Module Requests]]
* [[BibTeX entries]]

==Front-end Applications==
* [[Choosing a SWORD program]]
* A Front-end [[Frontends:FeatureList|Features Wishlist]]
* [[Frontends:No longer being actively developed|Front-ends no longer being actively developed]]
===SWORD based front-ends===
* [[Frontends:BibleCS|The SWORD Project for Windows]] (internally known as BibleCS)
* [[Frontends:Eloquent|Eloquent]] (formerly named MacSword)
* [[Frontends:Xiphos|Xiphos (GTK)]] (formerly [[Frontends:GnomeSword|GnomeSword]])
* [[Frontends:BibleTime|BibleTime]] (see also [[Frontends:KioSword|Kio-Sword]])
* [http://bibletimemini.sf.net/ BibleTime Mini] (for mobile devices, cross-platform)
* [http://bpbible.com BPBible (wxPython)]
* [http://swordwarrior.net SwordBible]
* [http://www.crosswire.org/swordweb/ The Bible Tool] – server application using [http://en.wikipedia.org/wiki/ORBit ORBit]
* [[Frontends:PocketSword|PocketSword]] (for [http://en.wikipedia.org/wiki/IOS_%28Apple%29 Apple iOS])
* [http://sourceforge.net/projects/dbst/ Dexios Bible Study Tool]
* [http://katana.garage.maemo.org/ Katana] (for [http://maemo.org/ maemo] Internet tablets)
* [[Frontends:Diatheke|Diatheke]] (CLI)
* [http://code.google.com/p/xulsword/ xulsword] & [http://code.google.com/p/xulsword/source/browse/#svn%2Ftrunk%2FCpp%2Fphpsword phpsword]

===JSword based front-ends===
* [[Frontends:BibleDesktop|BibleDesktop]]
* [http://thegoan.com/firebible FireBible] – Firefox Add-on (with [https://mozillalabs.com/ubiquity/ Ubiquity] support)
* [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]
* [[Frontends:GSword|GSword]] – CCIM Online Bible Studio
* [http://code.google.com/p/and-bible/ And Bible] – for Android OS
* [http://www.stepbible.org/ STEP Bible] – developed at [http://www.tyndale.cam.ac.uk/ Tyndale House]

==Other CrossWire Applications==
* [[Projects:Go Bible|Go Bible]] – mobile phone Bible viewer for Java ME

|valign="top" bgcolor="#FFE8E8" style="border-style:solid;border-width:1px;border-color:#FF6060;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Development Tools==
* [[DevTools:SWORD|SWORD Engine (C++)]]
* [[DevTools:JSword|JSword (Java)]]
* [[:DevTools:Code Examples|Code Examples]]
* [[Tutorial:How SWORD works]]
* [[:Tutorial:Compiling & Installing SWORD]]
* [[DevTools:ICU|International Components for Unicode (ICU)]]
* [[DevTools:CMake|CMake]] & [[DevTools:Bindings|Bindings]] for SWORD – experimental
* [[DevTools:Locale Files|Locale Files]]
* [[CSharp_Bindings_on_Windows | Tutorial:How to set up C# bindings on Windows]]

==Module Development==
* How to Create [[DevTools:Modules|SWORD Modules]]
* How to Create [[DevTools:conf Files|Module .conf Files]]
* A Basic [[OSIS Tutorial]]
* Guide to Writing [[OSIS Bibles]]
* Guide to Writing [[OSIS Commentaries]]
* Guide to Writing [[OSIS Genbooks]]
* Guide to Writing [[ThML modules]]
* Guide to Writing [[TEI Dictionaries]]
* Guide to [[Converting SFM Bibles to OSIS]]
* About [[DevTools:JSword/Personal Commentary|Personal Commentaries]]
* About [[Alternate Versification]]
* [[OpenOffice Export Filter for Genbooks]]
* [[File Formats]] and related Utility Programs
* [[DevTools:Text Editors|Unicode Text Editors]]
* [[Modules_in_the_beta_repository|Testing status of Beta modules]]
* Guide to [[Creating and Maintaining a Module Repository]]
* [[Non-CrossWire Text-Development Projects]]

==Public Relations, Website, User assistance==
* [[EnduserFAQ|FAQ]]
* [[Project websites and domains]]
* [[Help:Contents|Getting help]], joining mailing lists, reporting problems and tracking issues
* [[Copyright]] policy and lobbying copyright owners
* [[Twitter|CrossWire on Twitter]] and [[Facebook]]
* [[SWORD CD]]
|}
{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8E8E8;padding-bottom:0.5em;" width="100%"|

==Getting Started in Wiki Collaboration==
A Wiki is a place to share documentation and development information.
* New user account requests are now moderated.
* Anyone who has been a member for at least 4 days can edit a wiki once they have [[Special:Userlogin|logged in]].
* If you are new to Wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide User's Guide] for information on using the wiki software.
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* You may experiment with Wiki using our [[CrossWire:Sandbox|Sandbox]].
* Another way to navigate the Wiki is to click on [[:Special:SpecialPages|Special pages]] in the toolbox, and then select [[:Special:Categories|Categories]], or just go directly to [[:Category:Categories]].
|}

[[Category:CrossWire]]
[[Category:SWORD Frontends]]
[[Category:JSword]]
[[Category:Modules]]
[[Category:Development tools]]
[[Category:Support]]
__NOTOC__

CSharp Environment Variables Class

2014-10-02T19:37:54Z

Jon Behrens: Created page with "C# code should be portable between Windows and Linux using Mono. The sword project is at heart a Linux program, so figuring out where configuration files, book modules and enviro..."

C# code should be portable between Windows and Linux using Mono. The sword project is at heart a Linux program, so figuring out where configuration files, book modules and environment variables live can sometimes cause subtle errors. This class is intended to abstract that process so that the rest of the C# project can proceed without worrying about it.

<pre>
// Copyright 2014 CrossWire Bible Society (http://www.crosswire.org)
// CrossWire Bible Society
// P. O. Box 2528
// Tempe, AZ 85280-2528
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the
// Free Software Foundation version 2.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.

using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.IO;
using System.Text.RegularExpressions;

namespace Sword {
public static class Enviro {
static private List<string> configSections = new List<string>();
static private NameValueCollection configValues = new NameValueCollection();
static private bool configNotRead = true;

public static string dataPath {
get {
if (configNotRead) {
readConfigFile();
}
return configValues["DataPath"];
}
}

public static string installMgrPath {
get {
if (configNotRead) {
readConfigFile();
}
if (string.IsNullOrEmpty (configValues ["InstallMgrPath"]))
return dataPath;
return configValues["InstallMgrPath"];
}
}

public static string swordHome {
get {
if (String.IsNullOrEmpty (configValues ["swordHome"])) {
string home = Environment.GetEnvironmentVariable ("HOME");
if (String.IsNullOrEmpty (home))
home = Environment.GetEnvironmentVariable ("APPDATA");
/*
* Figure out where sword.conf lives
*/
string thePath = home.Replace ('\\', '/');
if (File.Exists (Path.Combine (thePath, "sword.conf"))) {
configValues ["swordHome"] = Path.Combine (thePath, "sword.conf");
} else if (File.Exists (Path.Combine (thePath, ".sword", "sword.conf"))) {
configValues ["swordHome"] = Path.Combine (thePath, ".sword", "sword.conf");
} else if (File.Exists (Path.Combine (thePath, "sword", "sword.conf"))) {
configValues ["swordHome"] = Path.Combine (thePath, "sword", "sword.conf");
} else if (File.Exists ("/etc/sword.conf")) {
configValues ["swordHome"] = "/etc/sword.conf";
} else {
/*
* TODO: Don't know enough about Linux Sword to know where all else the
* file could be located. This might need to be expanded.
*/
throw new Exception("Cannot find the file sword.conf. " +
"Should be in one of the following places: " +
"~/Home/sword/.sword.conf " +
"/AppData/roaming/sword/sword.conf " +
"/etc/sword.conf");
}
}
return configValues["swordHome"]; ;
}
}

private static void readConfigFile() {
string line;
StreamReader config = new StreamReader(swordHome);
while ((line = config.ReadLine()) != null) {
/*
* Section headings are enclosed in []
*
* TODO: Not sure if we need these for anything. At the moment just store them.
* If in the future there are multiple config sections, may want to key the
* values with the appropriate section.
*/
if(Regex.IsMatch(line, @"\[*\]")) {
configSections.Add(Regex.Replace(line, @"[\[\]]", ""));
} else {
/*
* Regular lines are of the form key=value
*/
string[] raw = line.Split('=');
/*
* Value may need some special treatment
*/
switch (raw[0]) {
/*
* Sword expects a data path using / as separaters rather than Windows \
* Also expects no trailing /
*/
case "DataPath":
case "InstallMgrPath":
raw[1] = Regex.Replace(raw[1], @"\\", "/").TrimEnd('/');
break;
default:
break;
}
configValues.Add(raw[0].Trim(),raw[1].Trim());
}
}
configNotRead = false;
}
}
}

</pre>

DevTools:CSharp Bindings on Windows

2014-10-02T18:10:39Z

Jon Behrens: Created page with "The standard Sword distribution contains bindings for C#. These will not make and run on Windows using Visual Studio 2013. This is a tutorial on the steps needed to get things wo..."

The standard Sword distribution contains bindings for C#. These will not make and run on Windows using Visual Studio 2013. This is a tutorial on the steps needed to get things working on Windows. The goal is to be able to cross develop on either Windows or Linux using the same source code. After downloading the current version of Sword [http://crosswire.org/sword/develop/index.jsp]:

<ol>
<li>
Set up Sword for windows according to these instructions: 
http://crosswire.org/wiki/Tutorial:Compiling_%26_Installing_SWORD_on_Windows 
Except, stop before making libsword.sln, you will need to make some changes before the project will build successfully.
</li><li>
Open \sword\sword\lib\vcppmake\libsword.sln in VS2013. VS will want to convert the project; allow this.
</li><li>
Open the project properties window
<ol>
<li>
Under the C/C++ tab General, edit additional include directories, change icu-sword to icu
</li><li>
Under the Linker tab General, edit additional library directories 
Change libcurl-vc10-x86-release-static-ipv6-sspi-spnego-winssl/lib to 
libcurl-vc-x86-release-static-ipv6-sspi-spnego-winssl/lib 
Change icu-sword/lib to icu/lib
</li>
</ol>
</li><li>
In the Solution Explorer window, drag the file: sword\bindings\flatapi.cpp into the solution.
</li><li>
Open flatapi.h
<ol>
<li>
Replace all ' * SWDLLEXPORT ' with ' SWDLLEXPORT * ' (without the quotes)
</li><li>
Replace all ' ** SWDLLEXPORT ' with ' SWDLLEXPORT ** ' (without the quotes)
</li><li>
If they do not exist, declare the following functions: 
<pre>
SWHANDLE SWDLLEXPORT org_crosswire_sword_SWMgr_newWithPath(const char *thePath);
void SWDLLEXPORT org_crosswire_sword_InstallMgr_delete(SWHANDLE hInstallMgr);
</pre>
</li>
</ol>
</li><li>
Open flatapi.cpp
<ol>
<li>
Make the replacements as in step 5
</li><li>
Change all ::clearModInfo to clearTheModInfo (remove the colons and rename)
</li><li>
Change the declaration of clearModInfo in the unnamed namespace to clearTheModInfo
</li><li>
Define the functions in 5.3 above if they do not exist: 
<pre>
SWHANDLE SWDLLEXPORT org_crosswire_sword_SWMgr_newWithPath(const char *thePath) {
SWConfig *sysConf = new SWConfig(thePath);
return (SWHANDLE) new HandleSWMgr(new WebMgr(sysConf));
}
void SWDLLEXPORT org_crosswire_sword_InstallMgr_delete(SWHANDLE hInstallMgr) {
HandleInstMgr *hinstmgr = (HandleInstMgr*)hInstallMgr;
if (hinstmgr) delete hinstmgr;
}
</pre>
</li>
</ol>
</li><li>
At this point, libsword.sln should make without errors
</li><li>
In the Sword distribution, there is a bindings directory having a csharp directory. In that directory, edit the file NativeMethods.cs:
<ol>
<li>
In the NativeMethods class the DLLNAME changes from libsword.so to libsword
</li><li>
In the NativeMethods class change:
<pre>
[DllImport(DLLNAME)] to
[DllImport(DLLNAME, CallingConvention=CallingConvention.Cdecl)]
</pre>
</li>
</ol>
</li><li>
Put all of the dlls in the sword project where C# can find them. Quick and dirty is to
copy them all to the bin directory for the executable you will build. You may need the
following dlls (I don't yet know yet which dlls do what, so I've included them all from the
Windows build of the Sword distribution. This list works, a lesser list may be sufficient.):
<pre>
icule53.dll clucene-core.dll icudt53.dll icuuc53.dll
liblzma.dll icuio53.dll icuin53.dll binding.dll
icutu53.dll iculx53.dll clucene-shared.dll
libsword.dll libbz2.dll
</pre>
</li><li>
Figure out where you want your data files and edit sword.conf to point to that directory. Also put sword.conf somewhere reasonable. 
Note that in getting everything located, the differences between Linux and Windows on environment variables and file locations became
sufficiently complex that I found it easier to create a C# class to manage all that. That class is located at [[CSharp Environment Variables Class]].
</li><li>
In sword\bindings\csharp\examples edit LookupExample.cs 
<pre>
using (var manager = new manager()) //changes to
using (var manager = new manager(@"path to sword.conf"))

</pre>
</li>
</ol>