doc:en:appendixa
====== Differences ====== This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
doc:en:appendixa [2013/02/05 13:37] rosmord [Free-text Description Editor] |
doc:en:appendixa [2022/01/12 09:07] (current) dmorandi [Transliteration] typo |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Appendix A. The current sign description system ====== | ====== Appendix A. The current sign description system ====== | ||
| - | It is possible to document the hieroglyphs (and in particular the new signs) so that the the palette can handle them in better ways. This is of course useful for your own new signs, but also for "standard" JSesh signs, as the signs information provided by JSesh is currently very partial. User input would be most welcome here, and above all user input by professionals. | + | It is possible to document the hieroglyphs (and in particular the new signs) so that the palette can handle them in better ways. This is of course useful for your own new signs, but also for "standard" JSesh signs, as the signs information provided by JSesh is currently very partial. User input would be most welcome here, and above all user input by professionals. |
| - | The main feature of version 2.4.15 of JSesh is the availability of a user friendly editor for adding information about signs. Starting the sign description editor | + | The main feature of version 2.4.15 of JSesh is the availability of a user friendly editor for adding information about signs. |
| + | |||
| + | ===== Starting the sign description editor ===== | ||
| The sign description editor is a separate program. To start it: | The sign description editor is a separate program. To start it: | ||
| * on windows, there is a shortcut for it | * on windows, there is a shortcut for it | ||
| Line 14: | Line 16: | ||
| * The Transliterations associated with the sign | * The Transliterations associated with the sign | ||
| * The signs which are part of this sign. For instance, A6 contains a W54 sign | * The signs which are part of this sign. For instance, A6 contains a W54 sign | ||
| - | * The sign(s) of which the they are variants | + | * The sign(s) of which they are variants |
| * Descriptions in free text of the sign, which may include for instance bibliographical remarks | * Descriptions in free text of the sign, which may include for instance bibliographical remarks | ||
| * Tags are short description items attached to the signs, and used to select them. For instance, "enemy" is attached to signs which represent an ennemy. | * Tags are short description items attached to the signs, and used to select them. For instance, "enemy" is attached to signs which represent an ennemy. | ||
| Line 30: | Line 32: | ||
| The "basic sign" check box is used to say that the sign should appear in the sign palette even if "show all" is not selected. | The "basic sign" check box is used to say that the sign should appear in the sign palette even if "show all" is not selected. | ||
| - | From this window, you can edit the sign transliterations, and many other things. The bottom part of the window gives access to three kinds of information: relationships between this sign and other signs, free text description of the sign, and tags. Transliteration | + | From this window, you can edit the sign transliterations, and many other things. The bottom part of the window gives access to three kinds of information: relationships between this sign and other signs, free text description of the sign, and tags. |
| + | |||
| + | ==== Transliteration ==== | ||
| It is possible to associate a number of transliterations with a given sign. Transliterations can be used in various contexts: to find a sign (in the palette, or typing the transliteration directly at the keyboard), or simply for informative purposes, for uncommon transliterations. | It is possible to associate a number of transliterations with a given sign. Transliterations can be used in various contexts: to find a sign (in the palette, or typing the transliteration directly at the keyboard), or simply for informative purposes, for uncommon transliterations. | ||
| Line 37: | Line 42: | ||
| {{ http://jsesh.qenherkhopeshef.org/files_jsesh/images/transliterationEditor.png }} | {{ http://jsesh.qenherkhopeshef.org/files_jsesh/images/transliterationEditor.png }} | ||
| - | To type a new transliteration, simply press the "+" button. If you enter some text in the transliteration text fied, this text will be used as the new transliteration. | + | To type a new transliteration, simply press the "+" button. If you enter some text in the transliteration text field, this text will be used as the new transliteration. |
| If you want to suppress a transliteration of yours, select the line, and press the "minus" button. This button is gray if no line is selected, or if the selected line can't be deleted. | If you want to suppress a transliteration of yours, select the line, and press the "minus" button. This button is gray if no line is selected, or if the selected line can't be deleted. | ||
| Line 51: | Line 56: | ||
| * ideogram: should be used both for simple ideograms (those followed by Z1), and for so-called phonetic determinatives, which are really ideograms in disguise. | * ideogram: should be used both for simple ideograms (those followed by Z1), and for so-called phonetic determinatives, which are really ideograms in disguise. | ||
| * abbreviation: use for signs which are actual abbreviations for words. They are not normally followed by Z1 in writing. Exempli gratia: G37 can be used as abbreviation for "Sri". | * abbreviation: use for signs which are actual abbreviations for words. They are not normally followed by Z1 in writing. Exempli gratia: G37 can be used as abbreviation for "Sri". | ||
| - | * typical:the sign is typical for some word. Often useful for some determinatives. I use it for G37's value "bin". | + | * typical: the sign is typical for some word. Often useful for some determinatives. I use it for G37's value "bin". |
| * keyboard: the sign will be accessible through this transliteration in JSesh when using the keyboard to enter signs. For instance, D54's transliteration "iw". | * keyboard: the sign will be accessible through this transliteration in JSesh when using the keyboard to enter signs. For instance, D54's transliteration "iw". | ||
| * palette: the sign will not be accessible from the keyboard through this tranliteration, but will be accessible through the palette. Note that if a user uses transliteration to access a sign in the palette, he will be able to access it through its transliteration afterwards. | * palette: the sign will not be accessible from the keyboard through this tranliteration, but will be accessible through the palette. Note that if a user uses transliteration to access a sign in the palette, he will be able to access it through its transliteration afterwards. | ||
| Line 68: | Line 73: | ||
| * is similar: is checked if the signs "look the same". | * is similar: is checked if the signs "look the same". | ||
| - | * degree | + | * degree: list how close the relationship between the two signs is. It can be one of : |
| - | * list how close the relationship between the two signs is. It can be one of : | + | |
| * full: a full variant of a sign S is a sign with the exact same uses and values as S. | * full: a full variant of a sign S is a sign with the exact same uses and values as S. | ||
| * partial: the uses overlap significantly. Usually, the variant would cover some of the uses of the original sign. | * partial: the uses overlap significantly. Usually, the variant would cover some of the uses of the original sign. | ||
| Line 80: | Line 84: | ||
| This field allows free text comments for signs. The most important use for this is to document uncommon signs, giving bibliographical references about them, and in general helping the user to select the best possible sign. If you want your sign description to be included in the distributed version of JSesh, they should have bibliographical references to back up their claim. Please also note that JSesh is a free software, but that it must respect copyright. So, this is not the place for blind copying of the sign lists of the usual grammars (it doesn't mean of course that you can't use them as sources). You can write descriptions in multiple languages, although it would be better if there were an english version for each sign. | This field allows free text comments for signs. The most important use for this is to document uncommon signs, giving bibliographical references about them, and in general helping the user to select the best possible sign. If you want your sign description to be included in the distributed version of JSesh, they should have bibliographical references to back up their claim. Please also note that JSesh is a free software, but that it must respect copyright. So, this is not the place for blind copying of the sign lists of the usual grammars (it doesn't mean of course that you can't use them as sources). You can write descriptions in multiple languages, although it would be better if there were an english version for each sign. | ||
| - | Tag list editor | + | === Tag list editor === |
| - | ==== The Tag list editor ==== | + | {{ http://jsesh.qenherkhopeshef.org/files_jsesh/images/SignTagsWindow.png |The Tag list editor}} |
| This window allows to describe the sign in terms of various short descriptive words called "tags". Those are available in the palette to select sub-categories of a given family. For instance, "standing" characters (obviously, the tags used here do not apply to A44). The left window displays all available tags, listing first those which are already used for this family, and then the other tags. The best way to tag signs is to look at similar signs, and see how it's done. | This window allows to describe the sign in terms of various short descriptive words called "tags". Those are available in the palette to select sub-categories of a given family. For instance, "standing" characters (obviously, the tags used here do not apply to A44). The left window displays all available tags, listing first those which are already used for this family, and then the other tags. The best way to tag signs is to look at similar signs, and see how it's done. | ||
| + | |||
| I'd like to draw your attention toward some very useful tags, which are a bit different. Those are "tall narrow sign", "low broad sign", and "long narrow sign". Those tags are used as special families in JSesh palette. | I'd like to draw your attention toward some very useful tags, which are a bit different. Those are "tall narrow sign", "low broad sign", and "long narrow sign". Those tags are used as special families in JSesh palette. | ||
| + | |||
| To add a new tag to a sign, simply select the tag in the left list, and click on the left-to-right arrow. To remove a tag, use the same principle. Note that you can't remove tags which are given in the "Official" JSesh list. | To add a new tag to a sign, simply select the tag in the left list, and click on the left-to-right arrow. To remove a tag, use the same principle. Note that you can't remove tags which are given in the "Official" JSesh list. | ||
| - | The tag creation window | ||
| - | The Tag Creation Window | + | ==== The Tag creation window ==== |
| + | |||
| + | {{ http://jsesh.qenherkhopeshef.org/files_jsesh/images/tagEditor.png |The Tag Creation Window}} | ||
| This window (accessible through the tools menu) allows you to create new tag, and associate multilingual translation with them. Those translation are not currently used. | This window (accessible through the tools menu) allows you to create new tag, and associate multilingual translation with them. Those translation are not currently used. | ||
| - | The menus | ||
| - | File | ||
| - | Open user default file | + | ==== The menus ==== |
| - | opens the file which contains your own definitions for signs. Those will automatically be used by JSesh the next time it's launched. | + | |
| - | Save :saves your work in your user definition file. As long as it hasn't been done, your file is unchanged. | + | |
| - | Clear :create a brand new workspace, with no data in it but the "official" one. Your user file will in any case be changed only if you save your work. | + | |
| - | Edit | + | |
| - | copy | + | === File === |
| - | copy this sign's definition for future use | + | |
| - | paste | + | |
| - | paste the data copyied for another sign into this sign definition. Very usefull when dealing with close variants. | + | |
| - | Tools | + | |
| - | Display/Hide Palette | + | * Open user default file: opens the file which contains your own definitions for signs. Those will automatically be used by JSesh the next time it's launched. |
| - | allows to open the sign palette, for selecting signs (by drag and drop) | + | * Save :saves your work in your user definition file. As long as it hasn't been done, your file is unchanged. |
| - | Display Tag Editor | + | * Clear :create a brand new workspace, with no data in it but the "official" one. Your user file will in any case be changed only if you save your work. |
| - | open (or closes) the tag editor window, for creating new tags. | + | |
| + | === Edit === | ||
| + | |||
| + | * copy: copy this sign's definition for future use | ||
| + | * paste: paste the data copyied for another sign into this sign definition. Very usefull when dealing with close variants. | ||
| + | === Tools === | ||
| + | |||
| + | * Display/Hide Palette: allows to open the sign palette, for selecting signs (by drag and drop) | ||
| + | * Display Tag Editor: open (or closes) the tag editor window, for creating new tags. | ||
| ==== Contributing your sign description to JSesh ==== | ==== Contributing your sign description to JSesh ==== | ||
| Your sign descriptions are stored in a file called signs_definition.xml, which is placed in: | Your sign descriptions are stored in a file called signs_definition.xml, which is placed in: | ||
| - | (Your home directory)/Library/Preferences/JSesh on macintoshes. For instance: /Users/rosmord/Library/Preferences/JSesh/signs_definition.xml on my machine. | + | * ''(Your home directory)/Library/Preferences/JSesh'' on macintoshes. For instance: /Users/rosmord/Library/Preferences/JSesh/signs_definition.xml on my machine. |
| - | c:\Documents and Settings\YOUR LOGIN\JSeshData on windows (basically, JSeshData in your personnal directory). Normally, the JSeshData directory is created by JSesh, so you can search for it if you have doubts. For instance, C:\Documents and Settings\Rosmord\JSeshData. | + | * ''c:\Documents and Settings\YOUR LOGIN\JSeshData'' on windows (basically, JSeshData in your personnal folder). Normally, the JSeshData directory is created by JSesh, so you can search for it if you have doubts. For instance, ''C:\Documents and Settings\Rosmord\JSeshData''. |
| - | $HOME/.jsesh on linux. | + | * ''$HOME/.jsesh'' on linux. |
| To contribute your sign descriptions to JSesh, simply send me this file. I will decide what can go in the general JSesh distribution. There are many problems I must take into account: the software must remain general enough, correct enough, and I must avoid copyright infrigement. | To contribute your sign descriptions to JSesh, simply send me this file. I will decide what can go in the general JSesh distribution. There are many problems I must take into account: the software must remain general enough, correct enough, and I must avoid copyright infrigement. | ||
| + | |||
doc/en/appendixa.1360067827.txt.gz · Last modified: 2016/10/12 14:14 (external edit)
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: GNU Free Documentation License 1.3
