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

From CrossWire Bible Society
Jump to: navigation, search
(OSISVersion)
(Missing sections for RTF, Continuation, Localisation: :Links that (in effect) pointed to https://wiki.crosswire.org/DevTools:conf_Files#Localization are all now broken because this section was removed! ~~~~)
(37 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.''
  
== Suggestion for a new element in conf files ==
+
Background: "Unicode Normalization can break [[Fonts#Hebrew|Biblical Hebrew]]."
  
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)
+
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>.
  
== Suggestion for new OSIS filter to toggle the appearance and activeness of dictionary lookup links ==
+
Now these two module creation tools have a '''-N''' command line switch to prevent conversion to UTF-8 and Normalization.
  
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.
+
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.
  
DictionaryModule=glossary_module_name
+
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:
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.
+
Normalization=Custom
  
[[User:David Haslam|David Haslam]] 12:12, 5 January 2012 (MST)
+
It should be assumed that modules where this is specified are made using the '''-N''' switch in the module creation tool.
  
:See also http://code.google.com/p/osis-converters/wiki/Compatibility [[User:David Haslam|David Haslam]] 06:57, 20 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.
  
== Localization ==
+
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>
  
The policy advice in the localization section is somewhat ambiguous. Clarification is needed. [[User:David Haslam|David Haslam]] 03:52, 9 January 2012 (MST)
+
--[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:33, 7 January 2018 (MST)
  
: It's clarified a bit more now, I hope. --[[User:Osk|Osk]] 06:12, 9 January 2012 (MST)
+
<references />
  
== OSISVersion ==
 
  
Is there a default for OSISVersion (like there is for MinimumVersion) ? [[User:David Haslam|David Haslam]] 06:49, 20 January 2012 (MST)
+
[[Talk:DevTools:conf Files/Archive]]
  
: 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)
+
== Missing sections for RTF, Continuation, Localisation ==
 +
 
 +
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)
 +
 
 +
== Weird consequences of specifying an Abbreviation that matches another module name ==
 +
 
 +
While working on '''KJV''' module development my e'''X'''perimental build is called '''KJVX'''. Last week I tried including
 +
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)

Revision as of 09:47, 16 May 2020

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, Localisation

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)

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)