Erights:Editorial guidelines

From Erights

Jump to: navigation, search

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.

Particularly, anything in Category:E specification is draft material for the E language and library specification, and should be written with precision in mind. Including usage advice is encouraged, but it should be made reasonably clear whether a paragraph is normative or informative.


Markup and templates

General formatting

XXX Add more general guidelines here

Do not use monospace except when referring to snippets of E language syntax (or other languages). In particular, when referring to variables such as in documenting a method, wrap them in <var> elements, not <code> or <tt>.


Whenever you mention a message (verb & arity), refer to it using the template {{msg|verb/arity}}. This creates automatic cross-references. To refer to a verb with arbitrary arity, use {{msg|verb/*}}.

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 following text:

The following line

? pragma.syntax("0.9")

declares to updoc that further updoc passages on this page are in E 0.9 syntax.

All updoc sections should be indented one space, to trigger <pre> formatting. Note that wiki markup is still permitted in such sections; it may be better to use <pre><nowiki> in some cases.

Updoc Preludes

Standard updoc prelude

Standard updoc prelude for awt and swing

Standard updoc prelude for swt

Old 0.8 updoc prelude

Personal tools
more tools