doc:en:appendixb
====== Differences ====== This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
doc:en:appendixb [2013/02/01 14:45] rosmord [Appendix B: Technical information on the sign description file] |
doc:en:appendixb [2016/10/12 14:14] 127.0.0.1 external edit |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | (Still needs cleaning) | ||
| ====== Appendix B: Technical information on the sign description file ====== | ====== Appendix B: Technical information on the sign description file ====== | ||
| Beware: technically explicit content. Pure souls, avert your eyes. A more user friendly system has been created. | Beware: technically explicit content. Pure souls, avert your eyes. A more user friendly system has been created. | ||
| + | |||
| Alternatively, you may directly edit your file description file. You need some kind of simple editor to do this : The notepad might do on windows, and softwares like TextWrangler can be used on Mac OS X. XML files are made of plain text. | Alternatively, you may directly edit your file description file. You need some kind of simple editor to do this : The notepad might do on windows, and softwares like TextWrangler can be used on Mac OS X. XML files are made of plain text. | ||
| + | |||
| JSesh won't accept badly formed files, so you may find yourself unable to launch JSesh. If this is the case, either correct signs_definition.xml, or rename it to something else, so that it will be ignored. In the future, I will add a user friendly editor, but I won't do it until the format is completely defined. | JSesh won't accept badly formed files, so you may find yourself unable to launch JSesh. If this is the case, either correct signs_definition.xml, or rename it to something else, so that it will be ignored. In the future, I will add a user friendly editor, but I won't do it until the format is completely defined. | ||
| The file must have the following form: | The file must have the following form: | ||
| + | <code> | ||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE signs PUBLIC "-//ORG/QENHERKHOPESHEF//DTD SIGNDESCRIPTION 1.0" "sign_description.dtd"> | <!DOCTYPE signs PUBLIC "-//ORG/QENHERKHOPESHEF//DTD SIGNDESCRIPTION 1.0" "sign_description.dtd"> | ||
| Line 13: | Line 15: | ||
| </signs> | </signs> | ||
| + | </code> | ||
| + | |||
| It is important to have exactly this content, specially the DOCTYPE line. | It is important to have exactly this content, specially the DOCTYPE line. | ||
| - | Here is a small example (actually, a part of JSesh standard sign description file). This file describes signs C1 and C1A. You see that they are classified in a number of categories. They are both human-headed deities and seated characters. The translitteration of C1 is given. We have provided one for C1A as well. The code "relevance='1'" means that this translitteration is here only for informationnal purporses. Actually, the XML format has been prepared to accomodate a lot of different data, which is not really used yet by JSesh, and I am very interested in getting suggestions about it. The definition for the format (its "dtd") is given just after this appendix. | + | |
| + | Here is a small example (actually, a part of JSesh standard sign description file). This file describes signs C1 and C1A. You see that they are classified in a number of categories. They are both human-headed deities and seated characters. The translitteration of C1 is given. We have provided one for C1A as well. The code ''"relevance='1'"'' means that this translitteration is here only for informationnal purporses. Actually, the XML format has been prepared to accomodate a lot of different data, which is not really used yet by JSesh, and I am very interested in getting suggestions about it. The definition for the format (its "dtd") is given just after this appendix. | ||
| + | <code> | ||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE signs PUBLIC "-//ORG/QENHERKHOPESHEF//DTD SIGNDESCRIPTION 1.0" "sign_description.dtd"> | <!DOCTYPE signs PUBLIC "-//ORG/QENHERKHOPESHEF//DTD SIGNDESCRIPTION 1.0" "sign_description.dtd"> | ||
| Line 42: | Line 48: | ||
| </sign> | </sign> | ||
| </signs> | </signs> | ||
| + | </code> | ||
| Note that tags must be defined before they are used (as tagCategory). A tag has a name and a label ; it is indeed possible to define labels in multiple languages, although this is not really used by JSesh now. | Note that tags must be defined before they are used (as tagCategory). A tag has a name and a label ; it is indeed possible to define labels in multiple languages, although this is not really used by JSesh now. | ||
| Line 48: | Line 55: | ||
| For the more technically-oriented, here is the current DTD used for sign descriptions. It is still experimental, and has already changed since version 2.4.13. | For the more technically-oriented, here is the current DTD used for sign descriptions. It is still experimental, and has already changed since version 2.4.13. | ||
| + | <code> | ||
| <!-- DTD used to describe signs characteristics. --> | <!-- DTD used to describe signs characteristics. --> | ||
| <!-- CATALOG NAME : "-//ORG/QENHERKHOPESHEF//DTD SIGNDESCRIPTION 1.0" --> | <!-- CATALOG NAME : "-//ORG/QENHERKHOPESHEF//DTD SIGNDESCRIPTION 1.0" --> | ||
| Line 196: | Line 204: | ||
| existsIn CDATA 'jsesh' | existsIn CDATA 'jsesh' | ||
| > | > | ||
| - | '' | + | </code> |
doc/en/appendixb.txt · Last modified: 2022/01/11 19:11 by dmorandi
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: GNU Free Documentation License 1.3
