Wiki.emacinc.com:Style Guide - Revision history

Tstratman: added article history section

2013-12-11T13:15:35Z

added article history section

Tstratman: corrected heading level

2013-12-11T13:09:41Z

corrected heading level

Tstratman: /* Organization */ added organization info

2013-12-11T13:08:58Z

‎Organization: added organization info

Tstratman: /* Organization */ started categories

2013-12-10T13:18:53Z

‎Organization: started categories

Tstratman: /* Using the ComplexList Extension */ showed wiki code

2013-12-10T13:12:29Z

‎Using the ComplexList Extension: showed wiki code

Tstratman: page name info

2013-12-07T15:04:51Z

page name info

Tstratman: /* Organization */ created section content

2013-12-07T14:35:19Z

‎Organization: created section content

Tstratman: added list example

2013-12-07T13:51:39Z

added list example

Tstratman: code blocks

2013-12-07T13:33:24Z

code blocks

Tstratman: lists

2013-12-06T13:26:11Z

lists

← Older revision		Revision as of 13:15, 11 December 2013
Line 1:		Line 1:
	This page serves as a set of guidelines for style, formatting, and content across the EMAC Wiki project. While there will be exceptions, following the standards set here will promote consistency and best-practices across the wiki and provide a reference for content review. This guide should be treated as a living document and updated with the current conventions.		This page serves as a set of guidelines for style, formatting, and content across the EMAC Wiki project. While there will be exceptions, following the standards set here will promote consistency and best-practices across the wiki and provide a reference for content review. This guide should be treated as a living document and updated with the current conventions.
		+
		+	== Article History ==
		+	One of the advantages of a wiki is that it allows for an automatic revision log of the article. This feature is much more useful if each edit includes a note about what was changed in that revision. Each edit on the wiki should include a note in the Summary box indicating the nature / content / or purpose of the edit that was performed.

	== Writing Guidelines ==		== Writing Guidelines ==

@@ Line 228: / Line 228: @@
 ** Topic Landing pages (see [[Linux Main]]) are used to group all of the articles related to the topic both spatially (like topics are linked in logical order on the page) and visually (groupings are made using bounding boxes).
-=== Categories ===
+==== Categories ====
 Categories are a the main method for grouping and organizing articles. A category is created just like any other wiki page and articles are added to categories by adding a link to the categories that it belongs to. For example:
 <pre>

@@ Line 222: / Line 222: @@
 # Use spaces between words in the page name.
 # Capitalize the word in the name as well as all principal words (nouns, verbs, etc) and all words longer than three letters. For example: "The Name of the Article is an Example".
 === Categories ===
-Categories are a powerful organization tool in the wiki and are
+Categories are a the main method for grouping and organizing articles. A category is created just like any other wiki page and articles are added to categories by adding a link to the categories that it belongs to. For example:
-http://wikidev.emacinc.com/wiki/Special:Categories
+<pre>
-http://wikidev.emacinc.com/wiki/Category:Linux
+[[Category:Linux]]

@@ Line 221: / Line 221: @@
 # The title should be descriptive enough that a page for a different topic would not use the same name. For example, use "EMAC OE Getting Started Guide" as opposed to "Getting Started".
 # Use spaces between words in the page name.
-# Capitalize the word in the name as well as all principal words (nouns, verbs, etc) and all words longer than three letters. For example: "The Name of the Article is Example".
+# Capitalize the word in the name as well as all principal words (nouns, verbs, etc) and all words longer than three letters. For example: "The Name of the Article is an Example".
 === Categories ===

@@ Line 147: / Line 147: @@
 ComplexList elements begin with a <nowiki><cl></nowiki> tag. The style of numbering (1, 2, 3; a, b, c; i, ii, iii; etc) is specified on the first line of a level, and new levels are denoted by indenting the line. Here is an example showing some of the various options:
 <cl>
@@ Line 168: / Line 190: @@
 * list item 4
 </cl>
 == Review ==

@@ Line 192: / Line 192: @@
 Subpages allow page names to be separated with a "/" to break them down into a hierarchy of pages. By default, subpages are disabled in the mainspace and enabled in the User and Talk namespaces. Subpages do not provide a benefit for main articles that is not covered by categories and also have the side effect of making longer page names. See this page for more information: http://www.mediawiki.org/wiki/Help:Subpages
-== EMAC Wiki Structure ==
+=== EMAC Wiki Structure ===
-=== Page Names ===
+==== Page Names ====
 === Categories ===

@@ Line 146: / Line 146: @@
 ==== Using the ComplexList Extension ====
-ComplexList elements begin with a <nowiki><cl></nowiki> tag. The style of numbering (1, 2, 3; a, b, c; i, ii, iii; etc) is specified on the first line of a level, and new levels are denoted by indenting the line. Here is an example as taken from the ComplexList extension page:
+ComplexList elements begin with a <nowiki><cl></nowiki> tag. The style of numbering (1, 2, 3; a, b, c; i, ii, iii; etc) is specified on the first line of a level, and new levels are denoted by indenting the line. Here is an example showing some of the various options:
 == Review ==

@@ Line 101: / Line 101: @@
 === Code Blocks ===
-Code blocks are used to display example source code and console sessions. There are several ways to do this in mediawiki syntax, including indenting lines, and using <nowiki><code></nowiki> tags. The preferred and most flexible method is to use the SyntaxHighlight extension. This works more smoothly when nested in other elements (i.e. lists) and allows for language-based syntax highlighting among other features. In general, use <nowiki><code></nowiki> tags when you need to add a single word or phrase within the text. Use <nowiki><syntaxhighlight></nowiki> tags when you need demonstrate a block of commands, code, console output, or system text such as configuration file contents.
+Code blocks are used to display example source code and console sessions. There are several ways to do this in mediawiki syntax, including indenting lines, and using <code><code></code> tags. The preferred and most flexible method is to use the SyntaxHighlight extension. This works more smoothly when nested in other elements (i.e. lists) and allows for language-based syntax highlighting among other features. In general, use <code><code></code> tags when you need to add a single word or phrase within the text. Use <nowiki><syntaxhighlight></nowiki> tags when you need demonstrate a block of commands, code, console output, or system text such as configuration file contents.
 ==== Using the SyntaxHighlight Extension ====
@@ Line 132: / Line 132: @@
 .  myfile yourfile test
 </syntaxhighlight>
 === Lists ===
@@ Line 139: / Line 146: @@
 ==== Using the ComplexList Extension ====
-ComplexList elements begin with a <code><cl></code> tag. The style of numbering (1, 2, 3; a, b, c; i, ii, iii; etc) is specified on the first line of a level, and new levels are denoted by indenting the line. Here is an example as taken from the ComplexList extension page:
+ComplexList elements begin with a <nowiki><cl></nowiki> tag. The style of numbering (1, 2, 3; a, b, c; i, ii, iii; etc) is specified on the first line of a level, and new levels are denoted by indenting the line. Here is an example as taken from the ComplexList extension page:
 == Review ==

@@ Line 135: / Line 135: @@
 === Lists ===
-Bulleted and numbered lists are common elements in this project. Some of them may be large with multiple levels and nested elements (procedures, for example). While standard mediawiki syntax provides controls for lists, support for nesting elements (code blocks, notes, images, etc) is limited. To get around these issues, the ComplexList extension has been installed and should be used for most lists.
+Bulleted and numbered lists are common elements in this project. Some of them may be large with multiple levels and nested elements (procedures, for example). While standard mediawiki syntax provides controls for lists, support for nesting elements (code blocks, notes, images, etc) is limited. To get around these issues, the [http://www.mediawiki.org/wiki/Extension:ComplexList ComplexList extension] has been installed and should be used for most lists, though standard mw syntax is still acceptable for simple lists.
-....