Difference between revisions of "Talk:DevTools:conf Files"
David Haslam (talk | contribs) (→Broken links for Creative Commons license summaries: new section) |
David Haslam (talk | contribs) (→Missing sections for RTF, Continuation, Localization: ::Deleted sections restored, but below the tables now. Links to them are no longer broken. ~~~~) |
||
| (38 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | 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 [[Fonts#Hebrew|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|<tt>osis2mod</tt>]] & <tt>tei2mod</tt>. | |
| − | + | 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 [[Encoding#Normalization|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 <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> | |
| − | + | --[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:33, 7 January 2018 (MST) | |
| − | + | <references /> | |
| − | |||
| − | + | [[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. [[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) | ||
| − | + | == 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) | ||
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)
- ↑ Added to SWORD SVN by DM Smith on 2018-01-07.
- ↑ 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)
