Changes

This '''Manual of Style''' has the simple purpose of making things easy to read by following a consistent format — it is a style guide. The following rules do not claim to be the last word on SME Server wiki-style. One way is often as good as another, but if everyone does it the same way, the SME Server wiki will be easier to read and use, not to mention easier to write and edit. In this regard, the following quotation from ''The Chicago Manual of Style'' deserves notice:

This '''Manual of Style''' has the simple purpose of making things easy to read by following a consistent format — it is a style guide. The following rules do not claim to be the last word on SME Server wiki-style. One way is often as good as another, but if everyone does it the same way, the SME Server wiki will be easier to read and use, not to mention easier to write and edit. In this regard, the following quotation from ''The Chicago Manual of Style'' deserves notice:

:Rules and regulations such as these, in the nature of the case, cannot be endowed with the fixity of rock-ribbed law. They are meant for the average case, and must be applied with a certain degree of elasticity.

:Rules and regulations such as these, in the nature of the case, cannot be endowed with the fixity of rock-ribbed law. They are meant for the average case, and must be applied with a certain degree of elasticity.

===Naming Conventions===

===Naming Conventions===

The following descriptions are the prefered naming conventions:

The following are the preferred naming conventions:

Name: SME Server

*Name: Koozali SME Server

Full: SME Server 8

*Full: Koozali SME Server 10

Point Release: SME Server 8.#

*Point Release: Koozali SME Server 10.#

The version number or point release number should only be used where the text refers to a action/process that is specific to that release or point release, SME Server in all other instances.

The version number or point release number should only be used where the text refers to a action/process that is specific to that release or point release, SME Server in all other instances.

===Categories===  

===Categories===  

All articles no matter what type should be categorised and a link to that category placed at the bottom of the article using the inbuilt function [[Category:Name]]

All articles no matter what type should be categorised and a link to that category placed at the bottom of the article using the inbuilt function <nowiki>[[Category:Name]]</nowiki>

Help page here: http://wiki.contribs.org/Help:Categories  

Help page here: http://wiki.contribs.org/Help:Categories  

As a general rule, do not put links in

As a general rule, do not put links in

# the bold reiteration of the title in the article's lead sentence or

 

# any section title.

#the bold reiteration of the title in the article's lead sentence or

#any section title.

 

Also, try not to put other phrases in bold in the first sentence.

Also, try not to put other phrases in bold in the first sentence.

Follow the normal rules for italics in choosing whether to put part or all of the title in italics.

Follow the normal rules for italics in choosing whether to put part or all of the title in italics.

==== Singular vs. Plural ====

====Singular vs. Plural====

It is better to name an article in the singular instead of plural notation, because it is easier to add plurality later in a sentence instead of removing it with a pipe.

It is better to name an article in the singular instead of plural notation, because it is easier to add plurality later in a sentence instead of removing it with a pipe.

<nowiki>[[Contrib]]s</nowiki> is easier to maintain than <nowiki>[[Contribs|Contrib]]</nowiki>

<nowiki>[[Contrib]]s</nowiki> is easier to maintain than <nowiki>[[Contribs|Contrib]]</nowiki>

==== Upper case/lower case/mixed case ====

====Upper case/lower case/mixed case====

Mediawiki automatically "uppers" article names. Every letter after the first, however, is case sensitive. To make your articles easier to link inline to those of others, use lowercase for the rest of the article unless it is a proper noun.

Mediawiki automatically "uppers" article names. Every letter after the first, however, is case sensitive. To make your articles easier to link inline to those of others, use lowercase for the rest of the article unless it is a proper noun.

{| border="1" cellpadding="2" cellspacing="0"

{| border="1" cellpadding="2" cellspacing="0"

! What it looks like !! What you type

!What it looks like!!What you type

|-

|-

| For example, it is easier to link to a sentence about [[contrib]]s than to link to one about [[Contribs|contrib]].

|For example, it is easier to link to a sentence about [[contrib]]s than to link to one about [[Contribs|contrib]].

| <pre><nowiki>

|<pre><nowiki>

For example, it is easier to link to a

For example, it is easier to link to a

sentence about [[contrib]]s

sentence about [[contrib]]s

Also note the following:

Also note the following:

*Avoid links within headings.

 

*Avoid links within headings.

*Avoid overuse of sub-headings.

*Avoid overuse of sub-headings.

*Avoid "The" in headings.  For example, use "Voyage" instead of "The voyage".

*Avoid "The" in headings.  For example, use "Voyage" instead of "The voyage".

====Titles====

====Titles====

''Italics'' should be used for titles of the following:

''Italics'' should be used for titles of the following:

*Books

*Books

*Computer and video games

*Computer and video games

Italics are generally used for titles of longer works. Titles of shorter works, such as the following, should be enclosed in double quotation marks:

Italics are generally used for titles of longer works. Titles of shorter works, such as the following, should be enclosed in double quotation marks:

*Articles, essays or papers  

 

*Chapters of a longer work  

*Articles, essays or papers

*Chapters of a longer work

*Episodes of a television series

*Episodes of a television series

*Short poems

*Short poems

*Short stories  

*Short stories

*Songs

*Songs

Other examples:

Other examples:

:Arthur said the situation was "deplorable". (''The full stop (period) is not part of the quotation.'')

:Arthur said the situation was "deplorable". (''The full stop (period) is not part of the quotation.'')

:Arthur said, "The situation is deplorable." (''The full sentence is quoted; the period is part of the quotation.'')

:Arthur said, "The situation is deplorable." (''The full sentence is quoted; the period is part of the quotation.'')

===Usage and spelling===

===Usage and spelling===

====Usage====

====Usage====

*Possessives of singular nouns ending in ''s'' may be formed with or without an additional ''s''. Either form is generally acceptable within Wikipedia. However, if either form is much more common for a particular word or phrase, follow that form, such as with "Achilles' heel".

*Possessives of singular nouns ending in ''s'' may be formed with or without an additional ''s''. Either form is generally acceptable within Wikipedia. However, if either form is much more common for a particular word or phrase, follow that form, such as with "Achilles' heel".

*Abbreviations of Latin terms like "i.e.", "e.g.", or "n.b." should be avoided and English terms such as "that is", "for example", or "note" used instead.

*Abbreviations of Latin terms like "i.e.", "e.g.", or "n.b." should be avoided and English terms such as "that is", "for example", or "note" used instead.

====Avoid self-referential pronouns====

====Avoid self-referential pronouns====

Most SME Server wiki articles should not be based on one person's opinions or experiences -- except for HowTos.  Thus, "I" can never be used, except, of course, when it appears in a quotation. For similar reasons, avoid the use of "we" and "one", as in: "We/One should note that some critics have argued in favor of the proposal", as it sounds more personal than encyclopedic.

Most Koozali SME Server wiki articles should not be based on one person's opinions or experiences -- except for HowTos.  Thus, "I" can never be used, except, of course, when it appears in a quotation. For similar reasons, avoid the use of "we" and "one", as in: "We/One should note that some critics have argued in favor of the proposal", as it sounds more personal than encyclopedic.

Nevertheless, it might sometimes be appropriate to use "we" or "one" when referring to an experience that ''anyone'', any reader, would be expected to have, such as general perceptual experiences. For example, although it might be best to write, "When most people open their eyes, they see something", it is still legitimate to write, "When we open our eyes, we see something", and it is certainly better than using the passive voice: "When the eyes are opened, something is seen".

Nevertheless, it might sometimes be appropriate to use "we" or "one" when referring to an experience that ''anyone'', any reader, would be expected to have, such as general perceptual experiences. For example, although it might be best to write, "When most people open their eyes, they see something", it is still legitimate to write, "When we open our eyes, we see something", and it is certainly better than using the passive voice: "When the eyes are opened, something is seen".

====Avoid the second person====

====Avoid the second person====

Use of the second person ("you") is generally discouraged.  This is to keep an encyclopedic tone, and also to help clarify the sentence.  Instead, refer to the subject of the sentence, for example:

Use of the second person ("you") is generally discouraged.  This is to keep an encyclopedic tone, and also to help clarify the sentence.  Instead, refer to the subject of the sentence, for example:

*"When ''a player'' moves past "go," ''that player'' collects $200."

*"When ''a player'' moves past "go," ''that player'' collects $200."

**Or, even better: "Players passing 'go' collect $200."  

**Or, even better: "Players passing 'go' collect $200."

*'''Not:''' "When ''you'' move past "go," ''you'' collect $200."

*'''Not:''' "When ''you'' move past "go," ''you'' collect $200."

This does not apply to quoted text, which should be quoted exactly.

This does not apply to quoted text, which should be quoted exactly.

===Bulleted items===

===Bulleted items===

These line item lists use the following guidelines:

These line item lists use the following guidelines:

*Complete sentences should use punctuation and an ending period.

*Complete sentences should use punctuation and an ending period.

*Incomplete sentence do not need terminal punctuation.

*Incomplete sentence do not need terminal punctuation.

Finally, do not be afraid to create links to pages you know do not exist yet; these can serve as hints to people as to what pages it would be useful to create.  If you create such a page, though, be mindful that the phrasing someone used in creating a link might not be the best choice of article title; you may have to change the original writer's link into a [[piped link]] before clicking through it to create the article.

Finally, do not be afraid to create links to pages you know do not exist yet; these can serve as hints to people as to what pages it would be useful to create.  If you create such a page, though, be mindful that the phrasing someone used in creating a link might not be the best choice of article title; you may have to change the original writer's link into a [[piped link]] before clicking through it to create the article.

=== External linking ===

===External linking===

Wikipedia, as a policy, prefers author/editors to group external links at the bottom of an article, in a named section. The SME Server wiki, as policy, does not care. If you want to use an external link in-line under a descriptive piece of a sentence, knock yourself out.

Wikipedia, as a policy, prefers author/editors to group external links at the bottom of an article, in a named section. The Koozali SME Server wiki, as policy, does not care. If you want to use an external link in-line under a descriptive piece of a sentence, knock yourself out.

===Miscellaneous notes===

===Miscellaneous notes===

====When all else fails====

====When all else fails====

If this page does not specify which usage is preferred, use other resources, such as ''The Chicago Manual of Style'' (from the University of Chicago Press) or Fowler's ''Modern English Usage'' (3rd edition) (from the Oxford University Press). Also, please feel free to carry on a discussion on [[SME Server talk:Manual of Style|the style guide's talk page]], especially for substantive changes.

If this page does not specify which usage is preferred, use other resources, such as ''The Chicago Manual of Style'' (from the University of Chicago Press), Fowler's ''Modern English Usage'' (3rd edition) (from the Oxford University Press) or the ''Oxford Style Guide'' (also from the Oxford University Press). Also, please feel free to carry on a discussion on [[SME Server talk:Manual of Style|the style guide's talk page]], especially for substantive changes.

Even simpler is to look at an article that you like and open it for editing to see how the writers and editors have put it together. You can then close the window without saving changes if you like, but look around while you are there. Almost every article can be improved.

Even simpler is to look at an article that you like and open it for editing to see how the writers and editors have put it together. You can then close the window without saving changes if you like, but look around while you are there. Almost every article can be improved.

====Keep markup simple====

====Keep markup simple====

====Formatting issues====

====Formatting issues====

Formatting issues such as font size, blank space and color are issues for the Wikipedia site-wide style sheet and should not be dealt with in articles except in special cases. If you absolutely must specify a font size, use a relative size i.e. <code>font-size: 80%</code>; not an absolute size, for example, <code>font-size: 4pt</code>. Color coding of information should not be done, but if necessary, try to choose colors that are unambiguous when viewed by a person with color blindness. In general, this means that red and green should not both be used. Viewing the page with Vischeck ([http://www.vischeck.com/vischeck/vischeckURL.php http://www.vischeck.com/vischeck/vischeckURL.php]) can help with deciding if the colors should be altered.

Formatting issues such as font size, blank space and color are issues for the Wikipedia site-wide style sheet and should not be dealt with in articles except in special cases. If you absolutely must specify a font size, use a relative size i.e. <code>font-size: 80%</code>; not an absolute size, for example, <code>font-size: 4pt</code>. Color coding of information should not be done, but if necessary, try to choose colors that are unambiguous when viewed by a person with color blindness. In general, this means that red and green should not both be used. Viewing the page with Vischeck (http://www.vischeck.com/vischeck/vischeckURL.php) can help with deciding if the colors should be altered.

====Make comments invisible====

====Make comments invisible====

For example, the following:

For example, the following:

:<code>hello &lt;!-- This is a comment. --&gt; world<br/></code>

 

:<code>hello &lt;!-- This is a comment. --&gt; world<br /></code>

 

is displayed as:

is displayed as:

====Legibility====

====Legibility====

Consider the legibility of what you are writing. Make your entry easy to read on a screen. Make judicious use of devices such as bulleted lists and bolding. More on this has been written by Jakob Nielsen in [http://www.useit.com/alertbox/9710a.html How Users Read on the Web].

Consider the legibility of what you are writing. Make your entry easy to read on a screen. Make judicious use of devices such as bulleted lists and bolding. More on this has been written by Jakob Nielsen in [http://www.useit.com/alertbox/9710a.html How Users Read on the Web].

<noinclude>----

<noinclude>

[[Category:Help|Wiki]]</noinclude>

----

[[Category:Help|Manual of Style]]

</noinclude>