CodeBlocks:Article Writing Guidelines - Revision history

Artojon: fixed few typos

2006-09-02T14:37:42Z

fixed few typos

Sethjackson at 15:54, 12 July 2006

2006-07-12T15:54:57Z

Sethjackson at 12:35, 9 July 2006

2006-07-09T12:35:17Z

Sethjackson at 23:10, 19 April 2006

2006-04-19T23:10:21Z

Thomas at 17:28, 10 April 2006

2006-04-10T17:28:39Z

Thomas at 17:28, 10 April 2006

2006-04-10T17:28:10Z

Sethjackson: Started Article Writing Guidelines

2006-04-10T15:15:26Z

Started Article Writing Guidelines

New page

;Conventions

* Avoid large paragraphs. Break them up a bit.
* Use a professional writing style. Don't get too silly in your writing. If you start warning your audience about anything or using a lot of cliches like 'just my $.02' you're bordering on silly.
* Name sections according to content. The table of contents should show a map of where the discussion is going to go.

''This is not a useful TOC:''

<pre>
1 The Obligitory Warning
2 Get your boilerplate ready
3 The Meaty Part
4 From Bad to Worse
</pre>

; Accuracy

* Use proper English, spelling and grammar. Copy it into Word to do a spelling & grammar check if need be.
* Link your article with the articles or tutorials page only after it has been proof read.
* Don't post code that you haven't actually compiled and ran, nor code that you didn't write. Remember when you post your code it becomes public domain. If you post someone elses code, it's a license violation until we delete it.
* Post all code necessary. Provide both the inline code that you are commenting on, and also post the full code base for easy copying and pasting.

; Guidelines

* Write for multiple platforms. Code::Blocks has a wide audience. If you don't use another platform ask someone in the forums to cross check your work before posting.
* Stay on topic. Pick one or a few related topics and write exclusively to that subject. If you have many ideas, make separate tutorials.

@@ Line 2: / Line 2: @@
 * Every Wiki page should be in a category.
-* [[Special:Categories|This]] page has a list.
+* [[Special:Categories|List of available categories]].
-''The catgory link should be on the first line of the Wiki page''
+''The category link should be on the first line of the Wiki page''
 <pre>
 [[Category:Outdated]]
-== Exapmle ==
+== Example ==
 </pre>

@@ Line 1: / Line 1: @@
-; Categorization
+== Categorization ==
 * Every Wiki page should be in a category.
@@ Line 13: / Line 13: @@
-;Conventions
+== Conventions ==
 * Avoid large paragraphs. Break them up a bit.
@@ Line 28: / Line 28: @@
 </pre>
-; Accuracy
+== Accuracy ==
 * Use proper English, spelling, and grammar. Copy your text into Word to do a spelling & grammar check if need be.
@@ Line 35: / Line 35: @@
 * Post all code necessary. Provide both the inline code that you are commenting on, and also post the full code base for easy copying and pasting.
-; Guidelines
+== Guidelines ==
 * Write for multiple platforms. Code::Blocks has a wide audience. If you don't use another platform ask someone in the forums to cross check your work before posting.
 * Stay on topic. Pick one or a few related topics and write exclusively to that subject. If you have many ideas, make separate tutorials.

@@ Line 2: / Line 2: @@
 * Every Wiki page should be in a category.
-* This Wiki uses only five categories. [[Special:Categories|This]] page has a list.
+* [[Special:Categories|This]] page has a list.
 ''The catgory link should be on the first line of the Wiki page''

← Older revision		Revision as of 23:10, 19 April 2006
Line 1:		Line 1:
		+	; Categorization
		+
		+	* Every Wiki page should be in a category.
		+	* This Wiki uses only five categories. [[Special:Categories\|This]] page has a list.
		+
		+	''The catgory link should be on the first line of the Wiki page''
		+
		+	<pre>
		+	[[Category:Outdated]]
		+
		+	== Exapmle ==
		+	</pre>
		+
		+
	;Conventions		;Conventions

@@ Line 18: / Line 18: @@
 * Use proper English, spelling, and grammar. Copy your text into Word to do a spelling & grammar check if need be.
 * Link your article with the articles or tutorials page only after it has been proof read.
-* Don't post code that you haven't actually compiled and ran, nor code that you didn't write. Publishing someone else's original work usually constitutes infringment (unless explicitely permitted) and is actionable in most countries.
+* Don't post code that you haven't actually compiled and run, nor code that you didn't write. Publishing someone else's original work usually constitutes infringment (unless explicitely permitted) and is actionable in most countries.
 * Post all code necessary. Provide both the inline code that you are commenting on, and also post the full code base for easy copying and pasting.