| 1 | |
|---|
| 2 | ARB documentation |
|---|
| 3 | ----------------- |
|---|
| 4 | |
|---|
| 5 | Sources for ARB helpfiles are located in 'HELP_SOURCE/source'. |
|---|
| 6 | |
|---|
| 7 | They contain plain text which is converted into .xml and |
|---|
| 8 | stored in 'HELP_SOURCE/Xml'. |
|---|
| 9 | |
|---|
| 10 | These .xml files are converted into |
|---|
| 11 | - Hypertext (stored in 'lib/help_html') and |
|---|
| 12 | - Arb helpfiles (stored in 'lib/help') |
|---|
| 13 | |
|---|
| 14 | The difference between the original helpfiles |
|---|
| 15 | from 'HELP_SOURCE/source' and the resulting ones |
|---|
| 16 | in 'lib/help' is the formatting. |
|---|
| 17 | |
|---|
| 18 | |
|---|
| 19 | The ARB software displays the helpfiles located in 'lib/help'. |
|---|
| 20 | When you press the 'BROWSE' button, it displays those in 'lib/help_html'. |
|---|
| 21 | |
|---|
| 22 | The latter is also made available at http://help.arb-home.de/arb.html |
|---|
| 23 | (updates from trunk every 24h) |
|---|
| 24 | |
|---|
| 25 | |
|---|
| 26 | When editing helpfiles from inside the ARB software, it depends |
|---|
| 27 | on DEBUG mode, what happens: |
|---|
| 28 | - with DEBUG mode enable this edits the files in 'HELP_SOURCE/source' |
|---|
| 29 | (if they are available) |
|---|
| 30 | - in userland it edits the files in 'HELP_SOURCE/source'. After editing the |
|---|
| 31 | changes are packed into an archive (ready to be sent to arb developers). |
|---|
| 32 | |
|---|
| 33 | |
|---|
| 34 | ARB help "syntax" |
|---|
| 35 | ----------------- |
|---|
| 36 | |
|---|
| 37 | # comment |
|---|
| 38 | UP <target> # may occur multiple times |
|---|
| 39 | SUB <target> # may occur multiple times |
|---|
| 40 | |
|---|
| 41 | TITLE concise title |
|---|
| 42 | |
|---|
| 43 | verbose subtitle |
|---|
| 44 | |
|---|
| 45 | OCCURRENCE ARB_PROGRAM/Menu/Submenu/Buttonname |
|---|
| 46 | |
|---|
| 47 | # historical section types (each allowed to occur once): |
|---|
| 48 | DESCRIPTION <running text> |
|---|
| 49 | NOTES <running text> |
|---|
| 50 | EXAMPLES <running text> |
|---|
| 51 | WARNINGS <running text> |
|---|
| 52 | BUGS <running text> |
|---|
| 53 | |
|---|
| 54 | # custom section type (each 'name' allowed to occur once): |
|---|
| 55 | SECTION name |
|---|
| 56 | |
|---|
| 57 | <running text> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | <running text>: |
|---|
| 61 | - should contain empty lines (to separate paragraphs, ...). |
|---|
| 62 | - uses indentation (first line defines for whole paragraph; same indentation results in same structure-level). |
|---|
| 63 | - lists can be defined by |
|---|
| 64 | - using digits as first character (numbered-lists). |
|---|
| 65 | - using '-' or '*' as first character (bullet-lists). |
|---|
| 66 | - has to be first char of a paragraph (or consecutive line). |
|---|
| 67 | - may be of same indentation-level as superior structure-level. |
|---|
| 68 | - no empty lines needed between consecutive list-entries. |
|---|
| 69 | - may be nested. |
|---|
| 70 | - paragraphs containing multiple consecutive space characters will not reflow. |
|---|
| 71 | - they will be displayed in monospaced font in html version. |
|---|
| 72 | - may contain links to other documents/resources using 'LINK{<target>}' |
|---|
| 73 | |
|---|
| 74 | |
|---|
| 75 | <target>: |
|---|
| 76 | - another name.hlp file (=internal link) |
|---|
| 77 | - name.ps and name.pdf file (=files delivered with arb) |
|---|
| 78 | - URLs starting with http[s]://, ftp:// or file:// (=external link) |
|---|
| 79 | - email addresses: name@domain.tl |
|---|
| 80 | - ticket number: #NUM (=link to arb bug tracker) |
|---|
