Difference between revisions of "Talk:DevTools:conf Files"

From CrossWire Bible Society
Jump to: navigation, search
(→‎HTML and RTF in columns that do not allow for it: :Why the almost top posting? Tip: Use '''Add Topic''' in future. ~~~~)
(→‎Missing sections for RTF, Continuation, Localization: ::Deleted sections restored, but below the tables now. Links to them are no longer broken. ~~~~)
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
== Column is too wide in table ==
+
I have following paragraph here presevered until a decision is made.
  
−
After Osk autowikified the table, the second column is too wide. Having to use horizontal scrollbar in webpages is a PITB. [[User:David Haslam|David Haslam]] 10:19, 13 November 2008 (UTC)
+
==== Normalization ====
−
:Sorted.  [[User:David Haslam|David Haslam]] 07:33, 18 November 2008 (UTC)
+
:''Currently, this optional key is a discussion proposal.''
  
−
== HTML and RTF in columns that do not allow for it ==
+
Background: "Unicode Normalization can break [[Fonts#Hebrew|Biblical Hebrew]]."
−
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.--[[User:Dmsmith|Dmsmith]] 18:28, 23 February 2013 (MST)
 
−
:Why the almost top posting? Tip: Use '''Add Topic''' in future. [[User:David Haslam|David Haslam]] 13:08, 24 February 2013 (MST)
 
  
−
== Suggestion for a new element in conf files ==
+
Most modules with Unicode source text are encoded as '''UTF-8''' and normalized to '''NFC''', these being the ''default settings'' for both [[Osis2mod|<tt>osis2mod</tt>]] & <tt>tei2mod</tt>.
  
−
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. [[User:David Haslam|David Haslam]] 13:13, 13 October 2011 (MDT)
+
Now these two module creation tools have a '''-N''' command line switch to prevent conversion to UTF-8 and Normalization.  
  
−
== Suggestion for new OSIS filter to toggle the appearance and activeness of dictionary lookup links ==
+
Biblical Hebrew source text with both vowel accents and cantillation may be supplied properly with custom [[Encoding#Normalization|normalization]] as required by the text provider. It should still be encoded UTF-8.
  
−
The [http://code.google.com/p/xulsword/ 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.
+
As there is a need to create modules from source text that has such a custom ordering of the diacritics, it may be useful to provide information in the .conf file for such modules that are intentionally not normalized to NFC during build. The following method is proposed:
  
−
  DictionaryModule=glossary_module_name
+
  Normalization=Custom
−
GlobalOptionFilter=OSISDictionary
 
  
−
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.
+
It should be assumed that modules where this is specified are made using the '''-N''' switch in the module creation tool.
  
−
[[User:David Haslam|David Haslam]] 12:12, 5 January 2012 (MST)
+
Normalization is useful to ensure (e.g.) that a search index stores all words the same way. That's why for the most part, modules are expected to be in NFC form. Custom normalization is still a normalization. What's different about it is that the combining classes for each character are different from the canonical combining classes defined by the Unicode Consortium.
  
−
:See also http://code.google.com/p/osis-converters/wiki/Compatibility [[User:David Haslam|David Haslam]] 06:57, 20 January 2012 (MST)
+
To create a search index for such a module such that it does not automatically use NFC, give the <tt>mkfastmod</tt> command with the '''-N''' switch.<ref>Added to SWORD SVN by DM Smith on 2018-01-07.</ref><ref>The UI in front-ends for creating a search index should ideally also be enhanced to support this option.</ref>
  
−
== Localization ==
+
--[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:33, 7 January 2018 (MST)
  
−
The policy advice in the localization section is somewhat ambiguous. Clarification is needed. [[User:David Haslam|David Haslam]] 03:52, 9 January 2012 (MST)
+
<references />
  
−
: It's clarified a bit more now, I hope. --[[User:Osk|Osk]] 06:12, 9 January 2012 (MST)
 
  
−
== OSISVersion ==
+
[[Talk:DevTools:conf Files/Archive]]
  
−
Is there a default for OSISVersion (like there is for MinimumVersion) ? [[User:David Haslam|David Haslam]] 06:49, 20 January 2012 (MST)
+
== Missing sections for RTF, Continuation, Localization ==
  
−
: 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. --[[User:Osk|Osk]] 20:29, 20 January 2012 (MST)
+
Some edits during the last 3 years seem to have removed the 3 sections linked by words in the '''Allowed''' column. The links don't go anywhere now. This error needs fixing. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:40, 14 March 2020 (UTC)
 +
:Links that (in effect) pointed to https://wiki.crosswire.org/DevTools:conf_Files#Localization are all now broken because this section was removed! [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:47, 16 May 2020 (UTC)
 +
::Deleted sections restored, but below the tables now. Links to them are no longer broken. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:06, 27 June 2023 (UTC)
  
−
== Broken links for Creative Commons license summaries ==
+
== Weird consequences of specifying an Abbreviation that matches another module name ==
  
−
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. [[User:David Haslam|David Haslam]] 01:19, 11 March 2012 (MST)
+
While working on '''KJV''' module development my e'''X'''perimental build is called '''KJVX'''. Last week I tried including
−
:Reminder &ndash; still needs doing. [[User:David Haslam|David Haslam]] 02:39, 11 February 2013 (MST)
+
Abbreviation=KJV
−
 
+
in <tt>kjvx.conf</tt> and discovered today that this has weird consequences in Xiphos. When I selected the released module '''KJV''', any minor change to this module display settings made Xiphos show module '''KJVX''' instead because of the Abbreviation clash. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:06, 11 May 2020 (UTC)
−
== OSISXlit & OSISEnum  ==
 
−
 
 
−
These new global filters ('''OSISXlit''' & '''OSISEnum''') need describing in more detail, with suitable examples in the page for [[OSIS Bibles]] or wherever most suitable. [[User:David Haslam|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. [[User:David Haslam|David Haslam]] 09:04, 10 December 2012 (MST)
 
−
:Done. [[User:David Haslam|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? [[User:David Haslam|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). [[User:David Haslam|David Haslam]] 04:52, 25 January 2013 (MST)
 

Latest revision as of 09:06, 27 June 2023

I have following paragraph here presevered until a decision is made.

Normalization

Currently, this optional key is a discussion proposal.

Background: "Unicode Normalization can break Biblical Hebrew."

Most modules with Unicode source text are encoded as UTF-8 and normalized to NFC, these being the default settings for both osis2mod & tei2mod.

Now these two module creation tools have a -N command line switch to prevent conversion to UTF-8 and Normalization.

Biblical Hebrew source text with both vowel accents and cantillation may be supplied properly with custom normalization as required by the text provider. It should still be encoded UTF-8.

As there is a need to create modules from source text that has such a custom ordering of the diacritics, it may be useful to provide information in the .conf file for such modules that are intentionally not normalized to NFC during build. The following method is proposed: 

Normalization=Custom

It should be assumed that modules where this is specified are made using the -N switch in the module creation tool.

Normalization is useful to ensure (e.g.) that a search index stores all words the same way. That's why for the most part, modules are expected to be in NFC form. Custom normalization is still a normalization. What's different about it is that the combining classes for each character are different from the canonical combining classes defined by the Unicode Consortium.

To create a search index for such a module such that it does not automatically use NFC, give the mkfastmod command with the -N switch.[1][2]

--David Haslam (talk) 09:33, 7 January 2018 (MST)

  1. ↑ Added to SWORD SVN by DM Smith on 2018-01-07.
  2. ↑ The UI in front-ends for creating a search index should ideally also be enhanced to support this option.


Talk:DevTools:conf Files/Archive

Missing sections for RTF, Continuation, Localization

Some edits during the last 3 years seem to have removed the 3 sections linked by words in the Allowed column. The links don't go anywhere now. This error needs fixing. David Haslam (talk) 13:40, 14 March 2020 (UTC)

Links that (in effect) pointed to https://wiki.crosswire.org/DevTools:conf_Files#Localization are all now broken because this section was removed! David Haslam (talk) 09:47, 16 May 2020 (UTC)
Deleted sections restored, but below the tables now. Links to them are no longer broken. David Haslam (talk) 09:06, 27 June 2023 (UTC)

Weird consequences of specifying an Abbreviation that matches another module name

While working on KJV module development my eXperimental build is called KJVX. Last week I tried including 

Abbreviation=KJV

in kjvx.conf and discovered today that this has weird consequences in Xiphos. When I selected the released module KJV, any minor change to this module display settings made Xiphos show module KJVX instead because of the Abbreviation clash. David Haslam (talk) 13:06, 11 May 2020 (UTC)

Retrieved from "https://wiki.crosswire.org/index.php?title=Talk:DevTools:conf_Files&oldid=17452"