CrossWire Bible Society - User contributions [en]

Main Page

2006-10-17T18:16:46Z

Mgruner: SPAM deleted

<big>'''Welcome to the CrossWire Wiki.'''</big>

A Wiki is a place to share documentation and development information. Since this wiki just started, things are a little bare right now, but hopefully these pages will fill with wonderfully pertinent information shortly.

Be sure to check out our [[Current events|Current events]] page to see how you might use your skills here at [http://crosswire.org CrossWire].

If you are looking for support or a place to discuss CrossWire and its products/activities, try [http://crosswire.org/forums our forums] instead.

== Getting started ==
* If you are new to Wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for information on using the wiki software.
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]

Main Page

2006-06-21T15:56:38Z

Mgruner:

<big>'''Welcome to the CrossWire Wiki.'''</big>

This wiki is intended a place mostly for developers to share documentation and developmend specific information that needs to be more persistent than on a mailing list. Since it just started, things are a little bare right now, but hopefully these pages will fill with wonderfully pertinent information shortly.

If you are looking for support or a place to discuss Crosswire and its products/activities, please use [http://crosswire.org/forums the forums] instead.

Be sure to check out our [[Current events|Current events]] page to see how you might use your skills here at [http://crosswire.org CrossWire].

== Getting started ==
* If you are new to Wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for information on using the wiki software.
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]

DevTools:SWORD

2006-06-19T14:23:15Z

Mgruner:

= Documentation =

== Locale file layout ==

Locales require a few things. Let's step thru the German locale:

excerpts from /sword/locales/de.conf:

[Meta]
Name=de
Description=German

The above information is used to define the locale. They should be
fairly obvious. Name should be taken from a standard abbrev, probably
returned from echo $LANG. Please understand that this, and all entries
are case sensitive.

The following entries are translation strings for anything you might
want. REQUIRED are the book names of the Bible. Other things might be
option name, value, tip, translations, or any text returned from the
engine. It may not work right now, but if it doesn't, please post a
message that you found a constant string in the engine not being
tranlated.

[Text]
Genesis=1. Mose
Exodus=2. Mose
Leviticus=3. Mose

# <snipped rest of book names>

[Book Abbrevs]
1 C=46
1 CHRONICLES=13
1 CORINTHIANS=46
1 JN=62

These are the abbreviations for each book and are REQUIRED for the
locale to work correctly in the engine. They are actually more than
just abbreviations; they tell the parser how to incrementally parse
versekey text. Notice that 1 Chronicles would come, alphabetically
before 1 corinthians. The above entries say: book 46 (1 Corinthians)
has precidence up thru "1 C", any character beyond that will
unabiguate the entry anyway, so the default 1 CHRONICLES or 1
CORINTHIANS entries would take over from there.

IMPORTANT:

1) There MUST be at least 1 abbreviation entry for each book name
comprised of a toupper (uppercase function) of the entire string
EXACTLY as you have translated it in the [Text] section.

2) The English abbreviation entries MUST remain in the locale.
The precidence entries may be tweeked, especially if you find them
interferring with your precidence entries, but the entire book name--
as stated in the first requirement above, must remain for English book
names.

Following are the REQUIRED entries from our excerpt book names above.

GENESIS=1
EXODUS=2
LEVITICUS=3

# <snip rest of english abbrevs>

1. MOSE=1
2. MOSE=2
3. MOSE=3

That's it for requirements. Tuning your locale can be important for the
user experience. Many [Book Abbrevs] entries may be added to assign
precidence if, for example, you find you are getting taken to the wrong
entries from text like: "Ma 1:1" (would be Malachi by default because of
alphabetical precidence, but might want Matthew or Mark).

You can test your locale with the sword/tests/parsekey test program (this
program is in the sword source along with several other programs that are
used to validate the configuration files) and try different strings to see
how they parse.
---
Submissions should be sent to scribe@crosswire.org

DevTools:Modules

2006-06-08T19:34:13Z

Mgruner:

= .conf File Layout =

The conf file tell the Sword engine how to treat installed module files, etc. which kind of markup they contain, and so forth. Below is a listing of the possible directives in that file.

<table width="100%" border="1">
<tr>
<td width="26%">
<div align="center"><b>Element</b></div>
</td>
<td width="63%">
<div align="center"><b>Values (type or enumerated)</b></div>
</td>
<td width="11%">
<div align="center"><b>Default Value</b></div>
</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">required elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">DataPath</div>
</td>
<td width="63%"><relative system path></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Description</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">ModDrv</div>
</td>
<td width="63%">RawText, zText, RawCom, zCom, HREFCom, RawFiles, RawLD, RawLD4,
zLD, RawGenBook</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"></div>
<div align="center"><font size="-1">elements required for proper module
access</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CipherKey</div>
</td>
<td width="63%"><string> (typically in a format matching the pattern
/[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/</td>
<td width="11%">
<div align="left"></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">BlockType</div>
</td>
<td width="63%">BOOK, CHAPTER, VERSE</td>
<td width="11%">CHAPTER</td>
</tr>
<tr>
<td width="26%">
<div align="left">CompressType</div>
</td>
<td width="63%">ZIP, LZSS</td>
<td width="11%">LZSS</td>
</tr>
<tr>
<td width="26%">BlockCount</td>
<td width="63%"><integer></td>
<td width="11%">200</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements required for proper rendering</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">GlobalOptionFilter</div>
</td>
<td width="63%">GBFStrongs, GBFFootnotes, GBFScripref, GBFMorph, GBFHeadings,
ThMLStrongs, ThMLFootnotes, ThMLScripref, ThMLMorph, ThMLHeadings, ThMLVariants,
ThMLLemma, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewVowels</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Direction</div>
</td>
<td width="63%">RtoL, LtoR</td>
<td width="11%">LtoR</td>
</tr>
<tr>
<td width="26%">
<div align="left">SourceType</div>
</td>
<td width="63%">Plaintext, GBF, ThML, OSIS</td>
<td width="11%">Plaintext</td>
</tr>
<tr>
<td width="26%">
<div align="left">Encoding</div>
</td>
<td width="63%">UTF-8, Latin-1</td>
<td width="11%">Latin-1</td>
</tr>
<tr>
<td width="26%">DisplayLevel</td>
<td width="63%"><integer></td>
<td width="11%">1</td>
</tr>
<tr>
<td width="26%">
<div align="left">Font</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">OSISqToTick</div>
</td>
<td width="63%">true/false</td>
<td width="11%">true</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements to indicate features</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">Feature</div>
</td>
<td width="63%">StrongsNumbers, GreekDef, HebrewDef, GreekParse, HebrewParse,
DailyDevotion, Glossary</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryFrom</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryTo</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">general informatic and installer elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">About</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Version</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.0</td>
</tr>
<tr>
<td width="26%">
<div align="left">History_x.x</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">MinimumVersion</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.5.1a</td>
</tr>
<tr>
<td width="26%">
<div align="left">Category</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">LCSH</div>
</td>
<td width="63%"><tree/string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Lang</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%">en</td>
</tr>
<tr>
<td width="26%">
<div align="left">InstallSize</div>
</td>
<td width="63%"><integer (indicating bytes)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">SwordVersionDate</div>
</td>
<td width="63%"><ISO date string (yyyy-mm-dd)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Obsoletes</div>
</td>
<td width="63%"><name of module></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">copyright- & licensing-related elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightHolder</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightDate</div>
</td>
<td width="63%"><integer (indicating year)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactName</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactAddress</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactEmail</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionLicense</div>
</td>
<td width="63%">"Public Domain", "Copyrighted", "Copyrighted; Permission to distribute granted to CrossWire", "Copyrighted; Free non-commercial distribution"</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionSource</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">TextSource</div>
</td>
<td width="63%"><string, probably a URL></td>
<td width="11%"> </td>
</tr>
</table>

DevTools:SWORD

2006-06-08T19:32:04Z

Mgruner:

= Locale file layout =

Locales require a few things. Let's step thru the German locale:

excerpts from /sword/locales/de.conf:

[Meta]
Name=de
Description=German

The above information is used to define the locale. They should be
fairly obvious. Name should be taken from a standard abbrev, probably
returned from echo $LANG. Please understand that this, and all entries
are case sensitive.

The following entries are translation strings for anything you might
want. REQUIRED are the book names of the Bible. Other things might be
option name, value, tip, translations, or any text returned from the
engine. It may not work right now, but if it doesn't, please post a
message that you found a constant string in the engine not being
tranlated.

[Text]
Genesis=1. Mose
Exodus=2. Mose
Leviticus=3. Mose

# <snipped rest of book names>

[Book Abbrevs]
1 C=46
1 CHRONICLES=13
1 CORINTHIANS=46
1 JN=62

These are the abbreviations for each book and are REQUIRED for the
locale to work correctly in the engine. They are actually more than
just abbreviations; they tell the parser how to incrementally parse
versekey text. Notice that 1 Chronicles would come, alphabetically
before 1 corinthians. The above entries say: book 46 (1 Corinthians)
has precidence up thru "1 C", any character beyond that will
unabiguate the entry anyway, so the default 1 CHRONICLES or 1
CORINTHIANS entries would take over from there.

IMPORTANT:

1) There MUST be at least 1 abbreviation entry for each book name
comprised of a toupper (uppercase function) of the entire string
EXACTLY as you have translated it in the [Text] section.

2) The English abbreviation entries MUST remain in the locale.
The precidence entries may be tweeked, especially if you find them
interferring with your precidence entries, but the entire book name--
as stated in the first requirement above, must remain for English book
names.

Following are the REQUIRED entries from our excerpt book names above.

GENESIS=1
EXODUS=2
LEVITICUS=3

# <snip rest of english abbrevs>

1. MOSE=1
2. MOSE=2
3. MOSE=3

That's it for requirements. Tuning your locale can be important for the
user experience. Many [Book Abbrevs] entries may be added to assign
precidence if, for example, you find you are getting taken to the wrong
entries from text like: "Ma 1:1" (would be Malachi by default because of
alphabetical precidence, but might want Matthew or Mark).

You can test your locale with the sword/tests/parsekey test program (this
program is in the sword source along with several other programs that are
used to validate the configuration files) and try different strings to see
how they parse.
---
Submissions should be sent to scribe@crosswire.org

Frontends:BibleCS

2006-06-08T19:06:51Z

Mgruner:

This is the collaboration/planning area for the Windows frontend of Sword.

For now, the content consists of stuff from an old wiki with broken formatting. Could someone sort it through and repair the formatting?

= Getting Started =

Borland has been in the habit of releasing different levels of their
tools at different price tiers, and sometimes they have an 'Open' edition
which is free for personal use or opensource development.
Now, I'd personally recommend buying their tools. I use them for all
of my commercial development and they are second to none-- truly built
with the developer in mind.

Here are the steps to freely compile the free software freely :)

Download and install Borland's compiler at:

http://www.forum.nokia.com/main/0,6566,034-49,00.html
<br/>(You'll have to get a Nokia developer username/password for this first step ... not onerous.)

Download and Install Tortoise SVN:

http://tortoisesvn.tigris.org/download.html

Follow the WinCVS instructions to checkout the source code:

http://www.crosswire.org/sword/develop/biblecs/svn.jsp

For Windows development, you will need to checkout 3 SVN modules: 'sword',
'biblecs', & 'icu-sword'. All three should be checked out to checked out to
the same location, so you should end up with sword, biblecs, and icu-sword
directories in that folder.

Download the ICU DLL from here (grab the latest icudt??l.zip file, icudt28l.zip as of April, 2005):
ftp://ftp.crosswire.org/pub/sword/utils/win32/

and place it in the CVS tree at:

sword/apps/windoze/CBuilder6/BibleCS/stage

Then change to the folder:

sword/apps/windoze/CBuilder6/BibleCS/

and double-click on:

swordprj.bpg

From the Borland IDE menu, choose Projects|Build All Projects

And that's it!!!

One recommendation: create a directory, \etc at the root of the drive
where you checked out the sword source and place a file sword.conf
containing something like:

[Install]<br>
DataPath=d:/Program Files/CrossWire/The SWORD Project/

[also good to set SWORD_PATH ... lda]

This will let the sword.exe running from the Borland IDE find your SWORD
modules (Bibles, etc.)

Have fun!

-Troy.

[taken from an email from Troy on sword-devel.]
-- Main.MartinGruner - 13 Jul 2003

-- Main.InVerseParaclete - 06 Dec 2003 <br />
Note that the Borland C++Builder 6.0 and C++BuilderX tools are not yet officially supported for development of BibleCS software. The project files and project group files are not necessarily kept up-to-date in SVN with the officially supported CBuilder 5.0 .bpr's and .bpg's.

If you are not an experienced C++Builder user, you will probably want to peruse the sword-devel list carefully, and strongly consider connecting with a _mentor_. There are some Getting.Started oriented projects, as well as the ./tests subdirectory.

Availability of CBuilder 5.0 is _sketchy_. It is not available from Borland anymore. For obtaining ethically, you may try e-Bay (sometimes available, usually about $50 opening bid). Another source is getting a book from your library or World.Cat, hoping the CD is still there, and taking advantage of the 30-day or 60-day trial.

-- Main.ChrisLittle - 11 Apr 2005

The CBuilder 6.0 personal is also available at polish borland representative site at address http://www.borland.pl/downloads/bcb6_personal/cbuilder_6_personal.exe Do not be afraid, it is not Polish version, just plain English :-) To get this version working You'll need a free personal license from Borland accessible at http://www.borland.com/products/downloads/download_cbuilder.html .<br>
Pleas also be informed that functionality of the personal edition is somewhat limited. The worst thing is that it lacks CodeGuard and Data Breakpoints which makes a memory problems debugging pretty hopeless.

-- Main.KrzysztofBialas - 16 Apr 2005

= Compiling with Cygwin =

---+ Cygwin
The [[http://www.cygwin.com][cygwin]] provides the necessary layer ontop of the windows environment emulating API and services necessary to compile from source and run Unix software.

---++ Install
Cygwin should be installed using standard installer available on http://www.cygwin.com. I haven't had time to check which packages are needed for the Sword build - so You'd probably be better off just installing everything (maybe except TeX and games ;-)). As of today the full install requires about

---+ Sword
Well, everyone knows what The Sword is :-)

---++ Getting sources
The sources should be downloaded using SVN windows client (http://tortoisesvn.tigris.org - quite a good choice). The detailed information is available at http://www.crosswire.org/sword/develop/biblecs/svn.jsp Just a small information, You need only the 'sword' product.

---++ Necessary changes in the source tree
None necessary currently. :-)

---++ Configure
First one needs to get the configure script. To get it You should run the =autogen.sh= from the main Sword directory. Then, the configure script should be invoked 'configure --enable-shared --with-curl --without-clucene'. This command will generate the necessary Makefiles
---++ Compilation
This is an easy part. Just type =make=, and everything will be compiled (except from the tests)

---++ Installation
"make install"

---+ Final remark
I've not tested the build with the tests, alhou the tests itself bilds correctly (to do this You need to manually switch to the =tests= directory and write =make= .

I've tested the osis2mod utility, and one 'funny' thing - osis2mod compiled in cygwin environment runs 10 times slower than osis2mod compiled in BCPB 6 (!). Perhaps some optimization flags need to be tweaked, but the speed difference is really enormous...
-- Main.KrzysztofBialas - 02 May 2005