Erights:Editorial guidelines - Revision history

Kevin Reid: add guidelines I've been following

Kevin Reid — Fri, 25 Feb 2011 17:32:14 GMT

add guidelines I've been following

New page

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 <nowiki><var></nowiki> elements, '''not''' <nowiki><code></nowiki> or <nowiki><tt></nowiki>.

===Messages===

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

== 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:
<nowiki>{{:Standard updoc prelude}}</nowiki>
which appears as the following text:
{| style="border: 1px solid black;" |
|| {{:Standard updoc prelude}}
|}

All updoc sections should be indented one space, to trigger <nowiki><pre></nowiki> formatting. Note that wiki markup is still permitted in such sections; it may be better to use <nowiki><pre><no</nowiki><nowiki>wiki></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]]

Kevin Reid: Reverted edits by Ca5Hqk (Talk); changed back to last version by Kevin Reid

Kevin Reid — Sun, 15 Jul 2007 03:07:41 GMT

Reverted edits by Ca5Hqk (Talk); changed back to last version by Kevin Reid

←Older revision		Revision as of 03:07, 15 July 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{:Standard updoc prelude}}
	----		----
-	Further updoc passages should appear within a <code>	+	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.
		+
		+	== Updoc Preludes ==
		+	[[Standard updoc prelude]]
		+
		+	[[Standard updoc prelude for awt and swing]]
		+
		+	[[Standard updoc prelude for swt]]
		+
		+	[[Old 0.8 updoc prelude]]

Ca5Hqk at 23:41, 14 July 2007

Ca5Hqk — Sat, 14 Jul 2007 23:41:05 GMT

←Older revision		Revision as of 23:41, 14 July 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{: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.~~	+	Further updoc passages should appear within a <code>
-		+
-	~~== Updoc Preludes ==~~	+
-	~~[[Standard updoc prelude]]~~	+
-		+
-	~~[[Standard updoc prelude for awt and swing]]~~	+
-		+
-	~~[[Standard updoc prelude for swt]]~~	+
-		+
-	~~[[Old 0.8 updoc prelude]]~~	+

Kevin Reid: Reverted edits by LxcZ2l (Talk); changed back to last version by Kevin Reid

Kevin Reid — Sun, 03 Jun 2007 23:42:08 GMT

Reverted edits by LxcZ2l (Talk); changed back to last version by Kevin Reid

←Older revision		Revision as of 23:42, 3 June 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{:Standard updoc prelude}}
	----		----
-	Further updoc passages should appear within a <code>	+	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.
		+
		+	== Updoc Preludes ==
		+	[[Standard updoc prelude]]
		+
		+	[[Standard updoc prelude for awt and swing]]
		+
		+	[[Standard updoc prelude for swt]]
		+
		+	[[Old 0.8 updoc prelude]]

LxcZ2l at 23:02, 3 June 2007

LxcZ2l — Sun, 03 Jun 2007 23:02:37 GMT

←Older revision		Revision as of 23:02, 3 June 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{: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.~~	+	Further updoc passages should appear within a <code>
-		+
-	~~== Updoc Preludes ==~~	+
-	~~[[Standard updoc prelude]]~~	+
-		+
-	~~[[Standard updoc prelude for awt and swing]]~~	+
-		+
-	~~[[Standard updoc prelude for swt]]~~	+
-		+
-	~~[[Old 0.8 updoc prelude]]~~	+

Kevin Reid: Reverted edits by Kb9Aad (Talk); changed back to last version by Kevin Reid

Kevin Reid — Sun, 03 Jun 2007 18:02:35 GMT

Reverted edits by Kb9Aad (Talk); changed back to last version by Kevin Reid

←Older revision		Revision as of 18:02, 3 June 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{:Standard updoc prelude}}
	----		----
-	Further updoc passages should appear within a <code>	+	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.
		+
		+	== Updoc Preludes ==
		+	[[Standard updoc prelude]]
		+
		+	[[Standard updoc prelude for awt and swing]]
		+
		+	[[Standard updoc prelude for swt]]
		+
		+	[[Old 0.8 updoc prelude]]

Kb9Aad at 17:22, 3 June 2007

Kb9Aad — Sun, 03 Jun 2007 17:22:50 GMT

←Older revision		Revision as of 17:22, 3 June 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{: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.~~	+	Further updoc passages should appear within a <code>
-		+
-	~~== Updoc Preludes ==~~	+
-	~~[[Standard updoc prelude]]~~	+
-		+
-	~~[[Standard updoc prelude for awt and swing]]~~	+
-		+
-	~~[[Standard updoc prelude for swt]]~~	+
-		+
-	~~[[Old 0.8 updoc prelude]]~~	+

Kevin Reid: Reverted edits by TllVhf (Talk); changed back to last version by Kevin Reid

Kevin Reid — Sun, 15 Apr 2007 01:45:47 GMT

Reverted edits by TllVhf (Talk); changed back to last version by Kevin Reid

←Older revision		Revision as of 01:45, 15 April 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{:Standard updoc prelude}}
	----		----
-	Further updoc passages should appear within a <code>	+	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.
		+
		+	== Updoc Preludes ==
		+	[[Standard updoc prelude]]
		+
		+	[[Standard updoc prelude for awt and swing]]
		+
		+	[[Standard updoc prelude for swt]]
		+
		+	[[Old 0.8 updoc prelude]]

TllVhf at 23:11, 14 April 2007

TllVhf — Sat, 14 Apr 2007 23:11:38 GMT

←Older revision		Revision as of 23:11, 14 April 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{: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.~~	+	Further updoc passages should appear within a <code>
-		+
-	~~== Updoc Preludes ==~~	+
-	~~[[Standard updoc prelude]]~~	+
-		+
-	~~[[Standard updoc prelude for awt and swing]]~~	+
-		+
-	~~[[Standard updoc prelude for swt]]~~	+
-		+
-	~~[[Old 0.8 updoc prelude]]~~	+

Kevin Reid: Reverted edits by He7Z2f (Talk); changed back to last version by Markm

Kevin Reid — Tue, 10 Apr 2007 16:28:27 GMT

Reverted edits by He7Z2f (Talk); changed back to last version by Markm

←Older revision		Revision as of 16:28, 10 April 2007
Line 13:		Line 13:
	{{:Standard updoc prelude}}		{{:Standard updoc prelude}}
	----		----
-	Further updoc passages should appear within a <code>	+	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.
		+
		+	== Updoc Preludes ==
		+	[[Standard updoc prelude]]
		+
		+	[[Standard updoc prelude for awt and swing]]
		+
		+	[[Standard updoc prelude for swt]]
		+
		+	[[Old 0.8 updoc prelude]]