Erights:Editorial guidelines
From Erights
(→Code Conventions) |
|||
| Line 5: | Line 5: | ||
We are in the process of installing syntax highlighting for this wiki. So the tags used to indicate code are not yet settled. | We are in the process of installing syntax highlighting for this wiki. So the tags used to indicate code are not yet settled. | ||
| - | All wiki pages that contain code should pass [[Updoc]]. For now, this means that each page needs to have this near the top of each page: | + | All wiki pages that contain code should pass [[Updoc]]. For now, this means that each page needs to have this near the top of the wiki source of each page: |
| - | + | <pre><nowiki> | |
| - | < | + | {{:Standard updoc prelude}} |
| - | + | </nowiki></pre> | |
| - | + | which appears as the text between the horizontal bars below. (If you know of a better way to delimit this, please do.) | |
| - | + | ---- | |
| - | + | {{:Standard updoc prelude}} | |
| + | ---- | ||
| + | Further updoc passages should appear within a <code><code> ... </code></code> section. It seems the lines between <code> tags need to be indented so that they'll be rendered into html with <pre> tags. | ||
Revision as of 04:56, 23 December 2006
This site is intended to be an authoritative resource for the E language and object-capability security in general. Please keep this in mind as you are editing.
Code Conventions
We are in the process of installing syntax highlighting for this wiki. So the tags used to indicate code are not yet settled.
All wiki pages that contain code should pass Updoc. For now, this means that each page needs to have this near the top of the wiki source of each page:
{{:Standard updoc prelude}}
which appears as the text between the horizontal bars below. (If you know of a better way to delimit this, please do.)
The following line
? pragma.syntax("0.9")
declares to updoc that further updoc passages on this page are in E 0.9 syntax.
Further updoc passages should appear within a <code> ... </code> section. It seems the lines between <code> tags need to be indented so that they'll be rendered into html with <pre> tags.
