Changes

{{style-guideline}}

{{style-guideline}}

<br>

<br>

==Article titles==

===Article titles===

If possible, make the title the ''subject'' of the first sentence of the article (as opposed to putting it in the predicate). For example, write "This Manual of Style is a style guide" instead of "This style guide is known as the Manual of Style."  In any case, the title should appear as early as possible in the article &mdash; preferably in the first sentence.

If possible, make the title the ''subject'' of the first sentence of the article (as opposed to putting it in the predicate). For example, write "This Manual of Style is a style guide" instead of "This style guide is known as the Manual of Style."  In any case, the title should appear as early as possible in the article &mdash; preferably 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.

''P.S. The singular rule would also be good in this case.''

''P.S. The singular rule would also be good in this case.''

==Headings==

===Headings===

Use the <tt>==</tt> (two equal signs) style markup for headings, not the <nowiki>'''</nowiki> (triple apostrophes) used to make words appear '''bold''' in  [[How_to_edit_a_page#Character_formatting|character formatting]]. Start with "<tt>==</tt>", add the heading title, then end with "<tt>==</tt>".  

Use the <tt>==</tt> (two equal signs) style markup for headings, not the <nowiki>'''</nowiki> (triple apostrophes) used to make words appear '''bold''' in  [[How_to_edit_a_page#Character_formatting|character formatting]]. Start with "<tt>==</tt>", add the heading title, then end with "<tt>==</tt>".  

*In general, avoid level 1 headings '='; they tend to stand out ''too'' much in the flow of a page. Tables of contents will be numbered based on the lowest numerical level heading, so they will not look silly.

*In general, avoid level 1 headings '='; they tend to stand out ''too'' much in the flow of a page. Tables of contents will be numbered based on the lowest numerical level heading, so they will not look silly.

==Signing==

===Signing===

Please keep the wiki in general terms as possible and do not sign or credit pages that you aren't or most likely will not be the only contributor of. Please do sign user experiences and comments you make on the talk pages.

Please keep the wiki in general terms as possible and do not sign or credit pages that you aren't or most likely will not be the only contributor of. Please do sign user experiences and comments you make on the talk pages.

==Capital letters==

===Capital letters===

===Titles===

====Titles====

Titles such as ''president'', ''king'', or ''emperor'' start with a capital letter when used as a title (followed by a name): "President Nixon", not "president Nixon". When used generically, they should be in lower case: "De Gaulle was the French president." The correct formal name of an office is treated as a proper noun. Hence: "Hirohito was Emperor of Japan". Similarly "Louis XVI was the French king" but "Louis XVI was King of France", ''King of France'' being a title in that context. Likewise, royal titles should be capitalized: "Her Majesty" or "His Highness". (Reference: ''Chicago Manual of Style'' 14th ed., par. 7.16; [http://www.guardian.co.uk/styleguide/page/0,5817,184841,00.html ''The Guardian Manual of Style''], "Titles" keyword.) Exceptions may apply for specific offices.

Titles such as ''president'', ''king'', or ''emperor'' start with a capital letter when used as a title (followed by a name): "President Nixon", not "president Nixon". When used generically, they should be in lower case: "De Gaulle was the French president." The correct formal name of an office is treated as a proper noun. Hence: "Hirohito was Emperor of Japan". Similarly "Louis XVI was the French king" but "Louis XVI was King of France", ''King of France'' being a title in that context. Likewise, royal titles should be capitalized: "Her Majesty" or "His Highness". (Reference: ''Chicago Manual of Style'' 14th ed., par. 7.16; [http://www.guardian.co.uk/styleguide/page/0,5817,184841,00.html ''The Guardian Manual of Style''], "Titles" keyword.) Exceptions may apply for specific offices.

American English and Commonwealth English differ in their inclination to use capitals.  Commonwealth English uses capitals more widely than American English does. This may apply to titles for people. If possible, as with spelling, use rules appropriate to the cultural and linguistic context. In other words, do not enforce American rules on pages about Commonwealth topics or Commonwealth rules on pages about American topics. In regard to pages about other cultures, choose either style, but be consistent within the page itself.

American English and Commonwealth English differ in their inclination to use capitals.  Commonwealth English uses capitals more widely than American English does. This may apply to titles for people. If possible, as with spelling, use rules appropriate to the cultural and linguistic context. In other words, do not enforce American rules on pages about Commonwealth topics or Commonwealth rules on pages about American topics. In regard to pages about other cultures, choose either style, but be consistent within the page itself.

===Calendar items===

====Calendar items====

The names of months, days, and holidays always begin with a capital letter: June, Monday, Fourth of July.

The names of months, days, and holidays always begin with a capital letter: June, Monday, Fourth of July.

However, they do not start with a capital letter when they are used generally: "This summer was very hot."

However, they do not start with a capital letter when they are used generally: "This summer was very hot."

===As Of dates and versions===

====As Of dates and versions====

If you're talking about a feature that now exists "as of" a specific version, please put ''as of 0.19'' (or whatever version it may be, and wiki-link it.  This will permit us to go to that page, and check What Links Here, to find out what things need to be updated as new versions are released.  This is not necessary in the User Manual; it's expected that that section will be maintained as up-to-date as possible as new releases come out.

If you're talking about a feature that now exists "as of" a specific version, please put ''as of 0.19'' (or whatever version it may be, and wiki-link it.  This will permit us to go to that page, and check What Links Here, to find out what things need to be updated as new versions are released.  This is not necessary in the User Manual; it's expected that that section will be maintained as up-to-date as possible as new releases come out.

==Italics==

===Italics===

Use the <code><nowiki>''</nowiki></code> (italic) markup. Example:

Use the <code><nowiki>''</nowiki></code> (italic) markup. Example:

Italics are mainly used to emphasize certain words. They are also used in other cases that are mentioned here.

Italics are mainly used to emphasize certain words. They are also used in other cases that are mentioned here.

   

   

===Titles===

====Titles====

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

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

*Books

*Books

*Songs

*Songs

===Words as words===

====Words as words====

Use italics when writing about words as words, or letters as letters (to indicate the use-mention distinction). For example:

Use italics when writing about words as words, or letters as letters (to indicate the use-mention distinction). For example:

*The most common letter in English is ''e''.

*The most common letter in English is ''e''.

===Quotations===

====Quotations====

There is normally no need to put quotations in italics unless the material would otherwise call for italics (emphasis, use of non-English words, etc.). It is necessary to indicate whether the italics are used in the original text or were added later.  For example:

There is normally no need to put quotations in italics unless the material would otherwise call for italics (emphasis, use of non-English words, etc.). It is necessary to indicate whether the italics are used in the original text or were added later.  For example:

<blockquote>Now cracks a noble heart. Good night sweet prince: And ''flights of angels'' sing thee to thy rest!</blockquote>

<blockquote>Now cracks a noble heart. Good night sweet prince: And ''flights of angels'' sing thee to thy rest!</blockquote>

You can do the indentation either using HTML's &lt;blockquote> tag, or by indenting the paragraph on a ":".

You can do the indentation either using HTML's &lt;blockquote> tag, or by indenting the paragraph on a ":".

==Punctuation==

===Punctuation===

In most cases, simply follow the usual rules of English punctuation.  A few points where SME Server may differ from usual usage follow.

In most cases, simply follow the usual rules of English punctuation.  A few points where SME Server may differ from usual usage follow.

===Quotation marks===

====Quotation marks====

With quotation marks, we split the difference between American and British usage. Though not a rigid rule, we use the "double quotes" for most quotations&mdash;they are easier to read on the screen&mdash;and use 'single quotes' for nesting quotations, that is, "quotations 'within' quotations".

With quotation marks, we split the difference between American and British usage. Though not a rigid rule, we use the "double quotes" for most quotations&mdash;they are easier to read on the screen&mdash;and use 'single quotes' for nesting quotations, that is, "quotations 'within' quotations".

Never use grave and acute accents or backticks (<big><b>` ´</b></big>) as quotation marks.

Never use grave and acute accents or backticks (<big><b>` ´</b></big>) as quotation marks.

===Colons===

====Colons====

[[Colon (punctuation)|Colons]] ( : ) should not have spaces before them, as in this example: "See? No space."

[[Colon (punctuation)|Colons]] ( : ) should not have spaces before them, as in this example: "See? No space."

===Contractions===

====Contractions====

In general, formal writing is preferred. Therefore, avoid excessive use of contractions&nbsp;&mdash; such as ''don't'', ''can't'', ''won't'', ''would've'', ''they'd'', and so on &mdash; unless they occur in a quotation or in a HOWTO article, written first-person.

In general, formal writing is preferred. Therefore, avoid excessive use of contractions&nbsp;&mdash; such as ''don't'', ''can't'', ''won't'', ''would've'', ''they'd'', and so on &mdash; unless they occur in a quotation or in a HOWTO article, written first-person.

==Acronyms and abbreviations==

===Acronyms and abbreviations===

Do not assume that your reader is familiar with the acronym or abbreviation that you are using.  The standard writing style is to spell out the acronym or abbreviation on the first reference (wiki-linked if appropriate) and then show the acronym or abbreviation after it.  This signals to readers to look out for it later in the text, and makes it easy for them to refer back to it, for example:

Do not assume that your reader is familiar with the acronym or abbreviation that you are using.  The standard writing style is to spell out the acronym or abbreviation on the first reference (wiki-linked if appropriate) and then show the acronym or abbreviation after it.  This signals to readers to look out for it later in the text, and makes it easy for them to refer back to it, for example:

It can also be helpful in a longer article to spell out the acronym or abbreviation for the reader again or to rewikify it if it has not been used for a while.

It can also be helpful in a longer article to spell out the acronym or abbreviation for the reader again or to rewikify it if it has not been used for a while.

==Simple tabulation==

===Simple tabulation===

Any line that starts with a blank space becomes a fixed font width and can be used for simple tabulation.

Any line that starts with a blank space becomes a fixed font width and can be used for simple tabulation.

A line that starts with a blank space with nothing else on it forms a blank line.

A line that starts with a blank space with nothing else on it forms a blank line.

==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.

*If a word or phrase is generally regarded as correct, then prefer it to any other word or phrase that might be regarded as incorrect. For example, "other meaning" should be used instead of "alternate meaning" or "alternative meaning", because not all English speakers regard "alternate" and "alternative" as meaning the same. The ''American Heritage Dictionary'' "Usage Note" at ''alternative'' says: "Alternative should not be confused with alternate." ''Alternative'' commonly suggests "non-traditional" or "out-of-the-mainstream" to an American-English speaker. Some traditional usage experts consider ''alternative'' to be appropriate only when there are exactly two alternatives.

*If a word or phrase is generally regarded as correct, then prefer it to any other word or phrase that might be regarded as incorrect. For example, "other meaning" should be used instead of "alternate meaning" or "alternative meaning", because not all English speakers regard "alternate" and "alternative" as meaning the same. The ''American Heritage Dictionary'' "Usage Note" at ''alternative'' says: "Alternative should not be confused with alternate." ''Alternative'' commonly suggests "non-traditional" or "out-of-the-mainstream" to an American-English speaker. Some traditional usage experts consider ''alternative'' to be appropriate only when there are exactly two alternatives.

===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 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.

This wiki does not require a style or view nearly as formal as Wikipedia, but authors should still strive, when possible, to present a certain feeling of professionalism and thoughtfulness in their writing -- especially writers for whom English is not a primary language.  All editors are invited to clean up weak syntax which obviously derives from this situation, while still trying to avoid taking "voice" out of first-person segments.

This wiki does not require a style or view nearly as formal as Wikipedia, but authors should still strive, when possible, to present a certain feeling of professionalism and thoughtfulness in their writing -- especially writers for whom English is not a primary language.  All editors are invited to clean up weak syntax which obviously derives from this situation, while still trying to avoid taking "voice" out of first-person segments.

===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."

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

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

==Pictures==

===Pictures===

Articles with a single picture are encouraged to have that picture at the top of the article, right-aligned, but this is not a hard and fast rule. Portraits with the head looking to the right should be left-aligned (looking into the article).  

Articles with a single picture are encouraged to have that picture at the top of the article, right-aligned, but this is not a hard and fast rule. Portraits with the head looking to the right should be left-aligned (looking into the article).  

  <code><nowiki>[[Image:picture.jpg|120px|right|thumb|Caption blah blah]]</nowiki></code>

  <code><nowiki>[[Image:picture.jpg|120px|right|thumb|Caption blah blah]]</nowiki></code>

==Captions==

===Captions===

Photos and other graphics should have captions unless they are "self-captioning" as in reproductions of album or book covers, or when the graphic is an unambiguous depiction of the subject of the article. For example, in a biography article, a caption is not needed for a portrait of the subject, pictured alone, however most entries use the name of the subject and the birth and death years and an approximation of the date when the image was taken: "John Smith (1812-1895) circa 1880" or "John Smith (1812-1895) on January 12, 1880 in Paris". If the caption is a single sentence or a sentence fragment, it does not get a period at the end. If the caption contains more than one sentence, then each sentence should get a period at the end. The caption always starts with a capital letter. Remember the full information concerning the image is contained in the image entry, so people looking for more information can click on the photo to see the full details.

Photos and other graphics should have captions unless they are "self-captioning" as in reproductions of album or book covers, or when the graphic is an unambiguous depiction of the subject of the article. For example, in a biography article, a caption is not needed for a portrait of the subject, pictured alone, however most entries use the name of the subject and the birth and death years and an approximation of the date when the image was taken: "John Smith (1812-1895) circa 1880" or "John Smith (1812-1895) on January 12, 1880 in Paris". If the caption is a single sentence or a sentence fragment, it does not get a period at the end. If the caption contains more than one sentence, then each sentence should get a period at the end. The caption always starts with a capital letter. Remember the full information concerning the image is contained in the image entry, so people looking for more information can click on the photo to see the full details.

In particular, photo captions should not contain credits; the credit can be on the description page.

In particular, photo captions should not contain credits; the credit can be on the description page.

==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.

*Each entry begins with a capital letter, even if it is a sentence fragment.

*Each entry begins with a capital letter, even if it is a sentence fragment.

==Wiki-linking==

===Wiki-linking===

Make only links relevant to the context. It is not useful and can be very distracting to mark all possible words as hyperlinks. Links should add to the user's experience; they should not detract from it by making the article harder to read. A high density of links can draw attention away from the high-value links that you would like your readers to follow up. Redundant links clutter up the page and make future maintenance harder. A link is the equivalent of a footnote in a print medium. Imagine if every second word in an encyclopedia article were followed by '(see:)'. Hence, the links should not be so numerous as to make the article harder to read.  

Make only links relevant to the context. It is not useful and can be very distracting to mark all possible words as hyperlinks. Links should add to the user's experience; they should not detract from it by making the article harder to read. A high density of links can draw attention away from the high-value links that you would like your readers to follow up. Redundant links clutter up the page and make future maintenance harder. A link is the equivalent of a footnote in a print medium. Imagine if every second word in an encyclopedia article were followed by '(see:)'. Hence, the links should not be so numerous as to make the article harder to read.  

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 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) 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.

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====

Use the simplest markup to display information in a useful and comprehensible way. Markup may appear differently in different browsers. Use HTML and CSS markup sparingly and only with good reason. Minimizing markup in entries allows easier editing.

Use the simplest markup to display information in a useful and comprehensible way. Markup may appear differently in different browsers. Use HTML and CSS markup sparingly and only with good reason. Minimizing markup in entries allows easier editing.

In particular, do not use the CSS <code>float</code> or <code>line-height</code> properties because they break rendering on some browsers when large fonts are used.

In particular, do not use the CSS <code>float</code> or <code>line-height</code> properties because they break rendering on some browsers when large fonts are used.

===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 http://www.vischeck.com/vischeck/vischeckURL.php]) can help with deciding if the colors should be altered.

===Make comments invisible===

====Make comments invisible====

Avoid highlighting that the article is incomplete and in need of further work.  

Avoid highlighting that the article is incomplete and in need of further work.  

So the comment can be seen when viewing the HTML or wiki source.

So the comment can be seen when viewing the HTML or wiki source.

===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].

 

[[Category:Help]]

[[Category:Help]]</noinclude>