Talk:DevTools:conf Files

From CrossWire Bible Society
Revision as of 01:05, 15 June 2013 by David Haslam (Talk | contribs) (Feature=NoParagraphs: :It should also be noted that the OSIS XML file used as the source for our KJV module was carefully hand-crafted. In approaching other Biblical texts containing pilcrows ¶,)

Jump to: navigation, search

Column is too wide in table

After Osk autowikified the table, the second column is too wide. Having to use horizontal scrollbar in webpages is a PITB. David Haslam 10:19, 13 November 2008 (UTC)

Sorted. David Haslam 07:33, 18 November 2008 (UTC)

HTML and RTF in columns that do not allow for it

The Allowed column is for showing what columns allow for HTML and RTF. It is never OK to use it in any other field. While it may work in a front-end, it is guaranteed to not work in others.--Dmsmith 18:28, 23 February 2013 (MST)

Why the almost top posting? Tip: Use Add Topic in future. David Haslam 13:08, 24 February 2013 (MST)
Never noticed the "Add topic" tab. Top posting makes sense that the most recent conversations are at the top. And old ones, having been addressed are lower down. But it doesn't matter to me. Either is fine. More critical to sign and date.--Dmsmith 09:14, 22 April 2013 (MDT)

Suggestion for a new element in conf files

It would be useful to permit a non-specific element called simply Notes. This element could contain anything not covered by About, Description, CopyrightNotes or DistributionNotes, etc. It could be used to record further information about various aspects of the module or the module creation process such as a description of the preprocessing steps. Such information could be very useful to developers. David Haslam 13:13, 13 October 2011 (MDT)

Suggestion for new OSIS filter to toggle the appearance and activeness of dictionary lookup links

The xulsword application includes support for toggling the display of dictionary lookup references. This is implemented by means of the following additional properties in the configuration file for any OSIS text module.


The xulsword developer suggests that this idea might be useful to incorporate into the SWORD and JSword API, and for other front-ends to start to make use of it.

David Haslam 12:12, 5 January 2012 (MST)

See also David Haslam 06:57, 20 January 2012 (MST)


The policy advice in the localization section is somewhat ambiguous. Clarification is needed. David Haslam 03:52, 9 January 2012 (MST)

It's clarified a bit more now, I hope. --Osk 06:12, 9 January 2012 (MST)


Is there a default for OSISVersion (like there is for MinimumVersion) ? David Haslam 06:49, 20 January 2012 (MST)

No. With MinimumVersion, there really is a default, in the sense that if you fail to set one in the .conf, the library will set one for you so that any front end can query the value and reliably get some answer. OSISVersion is essentially just informational, and I don't believe anyone has put it to any use. --Osk 20:29, 20 January 2012 (MST)

Broken links for Creative Commons license summaries

As Osk had just added a link for CC0, I tried some of the other Creative Commons links, and found that they go to pages that no longer exist. Needs follow-up. David Haslam 01:19, 11 March 2012 (MST)

Reminder – still needs doing. David Haslam 02:39, 11 February 2013 (MST)


These new global filters (OSISXlit & OSISEnum) need describing in more detail, with suitable examples in the page for OSIS Bibles or wherever most suitable. David Haslam 13:52, 28 June 2012 (MDT)

Strip Filters

A recent post to the sword-devel mailing list describes the use of local Strip Filters. I hope to insert this description into the main page presently. David Haslam 09:04, 10 December 2012 (MST)

Done. David Haslam 04:51, 13 December 2012 (MST)

Promo & ShortPromo?

SomKQA module version 1.0 had a config property named Promo. We document the property named ShortPromo. Was the original name changed at some time, or is this merely a minor error in the somkqa.conf file? David Haslam 09:47, 12 December 2012 (MST)

JSword and language codes

Currently, JSword does not support language code subtags, but there is now a plan to implement this. (Email conversation with DM today). David Haslam 04:52, 25 January 2013 (MST)

Proposed Scope Attribute


Indicates that the versification is limited to subset of its books, chapters and/or verses.

When there are only a few verses different within a chapter, it may be permissible to include them. But where there are many, do so.

To leave out deuterocanonical material from Synodal use the following:
Gen-Josh.4.33 Judg-2Chr Ezra Neh Esth-Ps.150 Prov.0[2]-Prov.4.27 Prov.5-Prov.13.25 Prov.14-Prov.18.24 Prov.19-Song Isa-Lam Ezek-Dan.3.33 Dan.4-Dan.12 Hos-Mal Matt-Rev

To note that a module only contains the NT, the following would be appropriate for many v11n:


  1. Use OSIS Book names. Book, chapter and verse are separated by '.', dot. Ranges are with respect to the order of books in the v11n. Both ends of a range must be fully specified. Ranges are separated by spaces. While order in an osisRef is undefined, they should be ordered here.
  2. When used in a verse range, the start of a book is chapter 0, the introduction. If the book has no introduction then Prov.1 is fine.
  3. At the moment, there is no way to specify the inclusion of module or testament introductions. JSword (in development) is using Intro.Bible, Intro.OT and Intro.NT.


It should be noted that using Feature=NoParagraphs for our KJV module would be inappropriate. Even though the KJV is normally printed as Verse Per Line without any paragraphing, we have taken it upon ourselves to implement the pilcrows ¶ as paragraph markers (which no doubt they are), and those chapters containing pilcrows are divided into OSIS paragraphs using the p element. At the same time, the pilcrows were converted to marker attribute values. David Haslam 02:00, 15 June 2013 (MDT)

It should also be noted that the OSIS XML file used as the source for our KJV module was carefully hand-crafted. In approaching other Biblical texts containing pilcrows ¶, the Python converter treats these as part of ordinary text, and not as something special. Were we to desire similar functionality to the KJV, then extra measures would be required to make further changes to the OSIS file output from the Python script. David Haslam 02:05, 15 June 2013 (MDT)