| 1 | Syntax
|
|---|
| 2 | |
|
|---|
| 3 | To write your own page you need to understand the syntax of the files.
|
|---|
| 4 | The first line in the file is the title. It is just the title
|
|---|
| 5 | displayed. If the first character is an asterix (*) then the page is
|
|---|
| 6 | considered a page which is intented for script submission (<I>control
|
|---|
| 7 | page</I>). If the page name starts with <B>help-</B>, the page is
|
|---|
| 8 | considered a help page and the help symbol is inactive. If the page is
|
|---|
| 9 | a control page, the submitted script with have the name of the page
|
|---|
| 10 | without extension, with the extension <B>.dim</B>, <I>e.g.</I>
|
|---|
| 11 | if the page name is <I>mypage.page</I> the submitted scripts
|
|---|
| 12 | name is <I>mypage.dim</I>.
|
|---|
| 13 |
|
|---|
| 14 | Each following line of the file describes a row in the table and is
|
|---|
| 15 | split by pipes (|). To use a pipe in a line you have to
|
|---|
| 16 | write &#124;. Lines which containes less than two pipes are
|
|---|
| 17 | concatenated until the number of pipes in one line is at least two. So
|
|---|
| 18 | the description of one row can look like
|
|---|
| 19 |
|
|---|
| 20 | <pre>
|
|---|
| 21 | leftlink|Description|format|rightlink
|
|---|
| 22 | </pre>
|
|---|
| 23 |
|
|---|
| 24 | but also
|
|---|
| 25 |
|
|---|
| 26 | <pre>
|
|---|
| 27 | leftlink|<br/>
|
|---|
| 28 | Description<br/>
|
|---|
| 29 | |format|rightlink
|
|---|
| 30 | </pre>
|
|---|
| 31 |
|
|---|
| 32 | If <I>leftlink</I> is available, a left arrow is displayed on the left
|
|---|
| 33 | and the row will link to page called <I>leftlink.page</I>. The same for
|
|---|
| 34 | <I>rightlink</i>, just that a right arrow is displayed on the right instead.
|
|---|
| 35 | Both are mutually exclusive, and can also be omotted.
|
|---|
| 36 |
|
|---|
| 37 | The <I>Description</I> is just a text which appears on the left side of
|
|---|
| 38 | the row in bold-face. if the format is omitted, it will fill the full
|
|---|
| 39 | width of the table and be displayed in normal-face. Consequently, a
|
|---|
| 40 | simple text entry could look like:
|
|---|
| 41 |
|
|---|
| 42 | <pre>
|
|---|
| 43 | |<br/>
|
|---|
| 44 | This is my simple text entry.<br/><br/>
|
|---|
| 45 | We can have more lines...
|
|---|
| 46 |
|
|---|
| 47 | ...and even a paragraph-break.<br/><br/>
|
|---|
| 48 | |
|
|---|
| 49 | </pre>
|
|---|
| 50 |
|
|---|
| 51 | Every line starting with a # is ignored.
|
|---|
| 52 |
|
|---|
| 53 | The description can also have special contents (see below).
|
|---|
| 54 |
|
|---|
| 55 | If the help is not a help-page, a data file is loaded and its data is
|
|---|
| 56 | displayed on the right of each row according the format given.
|
|---|
| 57 | |
|
|---|
| 58 | |Special tag descriptions||help-description
|
|---|
| 59 | |Data file and data file format||help-datafile
|
|---|
| 60 | |Binary file format||help-binaryfile
|
|---|
