Erights:Editorial guidelines
From Erights
(Difference between revisions)
(add guidelines I've been following) |
(started section on code conventions) |
||
Line 1: | Line 1: | ||
- | This site is intended to be an authoritative resource for the E language and object | + | 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 == | == Code Conventions == | ||
Line 20: | 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 | + | 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: |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | <pre> | |
+ | ? pragma.syntax("0.9") | ||
+ | </pre> | ||
- | + | You'll want to place the pragma line in a <code><pre> ... </pre></code> section. |
Revision as of 16:30, 10 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 each page:
? pragma.syntax("0.9")
You'll want to place the pragma line in a <pre> ... </pre>
section.