Wiki Team/Guide/Style Guide - Revision history

FGrose at 04:34, 5 December 2011

2011-12-05T04:34:20Z

← Older revision		Revision as of 00:34, 5 December 2011
Line 34:		Line 34:
	* For example:		* For example:
	** Skype - Internet telephony software (closed source).		** Skype - Internet telephony software (closed source).

			==Punctuation==
			* Please use [[wikipedia:Serial comma]]s.

Cjl: moved Walter is a wanker 15/Guide/Style Guide to Wiki Team/Guide/Style Guide over redirect: revert

2010-02-24T23:57:17Z

moved Walter is a wanker 15/Guide/Style Guide to Wiki Team/Guide/Style Guide over redirect: revert

← Older revision		Revision as of 19:57, 24 February 2010
(No difference)

Faggot: moved Wiki Team/Guide/Style Guide to Walter is a wanker 15/Guide/Style Guide: Walter is a wanker

2010-02-24T23:53:41Z

moved Wiki Team/Guide/Style Guide to Walter is a wanker 15/Guide/Style Guide: Walter is a wanker

← Older revision		Revision as of 19:53, 24 February 2010
(No difference)

FGrose: /* Section Headings */

2009-03-17T01:12:11Z

Section Headings

← Older revision		Revision as of 21:12, 16 March 2009
Line 18:		Line 18:
	*: Although this is a valid point, other wikis have solved it by adjusting header levels when transcluding. ''E.g.,'' if a page is including at an H4 level, then any H1 heading in that page is mapped to H4, and so on.		*: Although this is a valid point, other wikis have solved it by adjusting header levels when transcluding. ''E.g.,'' if a page is including at an H4 level, then any H1 heading in that page is mapped to H4, and so on.
	*:: Even if the structure problems are moot, the extra large typeface in the H1 header may be considered 'too loud', like shouting in the context of the smaller typefaces on the rest of the page and sidebars. Notice that it seems more appropriate for a single use to title the page.		*:: Even if the structure problems are moot, the extra large typeface in the H1 header may be considered 'too loud', like shouting in the context of the smaller typefaces on the rest of the page and sidebars. Notice that it seems more appropriate for a single use to title the page.


	(Taken from the GNOME Style Guide)		(Taken from the GNOME Style Guide)
Line 27:		Line 28:
	** Initial uppercase letter for prepositions of four letters or longer		** Initial uppercase letter for prepositions of four letters or longer
	** Initial uppercase letter for prepositions that are part of a phrasal verb		** Initial uppercase letter for prepositions that are part of a phrasal verb
	** All lowercase letters for conjunctions, articles, and prepositions of less than four letters		** All lowercase letters for conjunctions, articles, and prepositions of less than four letters


	==Lists==		==Lists==

FGrose at 01:10, 17 March 2009

2009-03-17T01:10:07Z

← Older revision		Revision as of 21:10, 16 March 2009
Line 1:		Line 1:
	=Introduction=		==Introduction==
	The pages in this wiki should be as easy to understand and follow as possible. With this in mind, please take into account the following suggested writing style guidelines:		The pages in this wiki should be as easy to understand and follow as possible. With this in mind, please take into account the following suggested writing style guidelines:

	=Terminology=		==Terminology==
	*Sugar releases - Always try to specify which versions of Sugar a page is valid for. When referring to Sugar releases, use "Sugar X.XX" - eg. "Sugar 0.82".		*Sugar releases - Always try to specify which versions of Sugar a page is valid for. When referring to Sugar releases, use "Sugar X.XX" - eg. "Sugar 0.82".
	*Linux distributions - Capitalize the names of Linux distributions like Fedora, Debian, Ubuntu, etc.		*Linux distributions - Capitalize the names of Linux distributions like Fedora, Debian, Ubuntu, etc.
	*Operating Systems - Capitalize the names of operating systems like Linux, Ubuntu, Windows, etc.		*Operating Systems - Capitalize the names of operating systems like Linux, Ubuntu, Windows, etc.

	=Page Titles=		==Page Titles==
	* Be descriptive.		* Be descriptive.
	* Avoid using the word "Howto" in the page title (everything here is a howto!).		* Avoid using the word "Howto" in the page title (everything here is a howto!).
Line 13:		Line 13:
	* Avoid camel casing, such as 'WikiTeam', because search engines will not find this 'Team', so 'Wiki Team', then. (We are in the process of converting away from CamelCase contractions, so you may see many examples of the deprecated style.)		* Avoid camel casing, such as 'WikiTeam', because search engines will not find this 'Team', so 'Wiki Team', then. (We are in the process of converting away from CamelCase contractions, so you may see many examples of the deprecated style.)

	=Section Headings=		==Section Headings==

			* '''do NOT use H1 headers''' within a page (''i.e.,'' don't do =Header with a single equal signs on each side=). Start your hierarchy with ==H2 level header== within the body of the wiki article. H1 headers should be reserved for the page's title (like this page's [[{{FULLPAGENAME}}]] above); any further H1's should indicate the inclusion of an entire other page. Imagine what happens when you [http://en.wikipedia.org/wiki/Transclusion transclude] one page at the end of another: this should make sense within a Table of Contents if you add an H1 header before it.
			*: Although this is a valid point, other wikis have solved it by adjusting header levels when transcluding. ''E.g.,'' if a page is including at an H4 level, then any H1 heading in that page is mapped to H4, and so on.
			*:: Even if the structure problems are moot, the extra large typeface in the H1 header may be considered 'too loud', like shouting in the context of the smaller typefaces on the rest of the page and sidebars. Notice that it seems more appropriate for a single use to title the page.

			(Taken from the GNOME Style Guide)
	* Heading text should be short, clear, and descriptive.		* Heading text should be short, clear, and descriptive.
	* Capitalize in the following manner:		* Capitalize in the following manner:
Line 23:		Line 29:
	** All lowercase letters for conjunctions, articles, and prepositions of less than four letters		** All lowercase letters for conjunctions, articles, and prepositions of less than four letters

	~~(Taken from the GNOME Style Guide)~~

	=Lists=		==Lists==
	Bullet lists of links should take the following form: <Bullet> <Link> <Hyphen> <Sentence>.		Bullet lists of links should take the following form: <Bullet> <Link> <Hyphen> <Sentence>.
	* For example:		* For example:
	** Skype - Internet telephony software (closed source).		** Skype - Internet telephony software (closed source).

FGrose: Wiki Team/Guide/StyleGuide moved to Wiki Team/Guide/Style Guide: deCamel casing

2009-03-15T16:40:44Z

Wiki Team/Guide/StyleGuide moved to Wiki Team/Guide/Style Guide: deCamel casing

← Older revision		Revision as of 12:40, 15 March 2009
(No difference)

FGrose: /* Page Titles */

2009-03-15T16:39:29Z

Page Titles

← Older revision		Revision as of 12:39, 15 March 2009
Line 10:		Line 10:
	* Be descriptive.		* Be descriptive.
	* Avoid using the word "Howto" in the page title (everything here is a howto!).		* Avoid using the word "Howto" in the page title (everything here is a howto!).
	* Use capital letters and avoid ~~spaces or~~ dashes (~~WikiName~~, ~~for example~~).		* Use capital letters and avoid dashes.
			* Avoid camel casing, such as 'WikiTeam', because search engines will not find this 'Team', so 'Wiki Team', then. (We are in the process of converting away from CamelCase contractions, so you may see many examples of the deprecated style.)

	=Section Headings=		=Section Headings=

Dfarning-bot: WikiTeam/WikiGuide/StyleGuide moved to Wiki Team/Guide/StyleGuide: Robot: Moved page

2009-03-08T11:37:14Z

WikiTeam/WikiGuide/StyleGuide moved to Wiki Team/Guide/StyleGuide: Robot: Moved page

← Older revision	Revision as of 07:37, 8 March 2009
(No difference)

Dfarning: WikiTeam/WritingGuide moved to WikiTeam/WikiGuide/StyleGuide: creating wikiguide

2008-11-11T00:38:15Z

WikiTeam/WritingGuide moved to WikiTeam/WikiGuide/StyleGuide: creating wikiguide

← Older revision		Revision as of 20:38, 10 November 2008
(No difference)

Dfarning: initial style guide

2008-11-11T00:14:45Z

initial style guide

New page

=Introduction=
The pages in this wiki should be as easy to understand and follow as possible. With this in mind, please take into account the following suggested writing style guidelines:

=Terminology=
*Sugar releases - Always try to specify which versions of Sugar a page is valid for. When referring to Sugar releases, use "Sugar X.XX" - eg. "Sugar 0.82".
*Linux distributions - Capitalize the names of Linux distributions like Fedora, Debian, Ubuntu, etc.
*Operating Systems - Capitalize the names of operating systems like Linux, Ubuntu, Windows, etc.

=Page Titles=
* Be descriptive.
* Avoid using the word "Howto" in the page title (everything here is a howto!).
* Use capital letters and avoid spaces or dashes (WikiName, for example).

=Section Headings=
* Heading text should be short, clear, and descriptive.
* Capitalize in the following manner:
** Initial uppercase letter for the first word and the last word, regardless of part of speech
** Initial uppercase letter for all nouns, adjectives, and verbs
** Initial uppercase letter for conjunctions of four letters or longer
** Initial uppercase letter for prepositions of four letters or longer
** Initial uppercase letter for prepositions that are part of a phrasal verb
** All lowercase letters for conjunctions, articles, and prepositions of less than four letters

(Taken from the GNOME Style Guide)

=Lists=
Bullet lists of links should take the following form: <Bullet> <Link> <Hyphen> <Sentence>.
* For example:
** Skype - Internet telephony software (closed source).