CATUG wiki:Notes for editors: Difference between revisions
(Consent (learned the hard way)) |
(Merge Style Guide here) |
||
| Line 1: | Line 1: | ||
{{title|Notes for editors}} | {{title|Notes for editors}} | ||
This page | This page gives guidance to editors on what to contribute to this CMUG Wiki, and how to achieve a consistent appearance. | ||
==Consent== | ==Consent== | ||
| Line 7: | Line 7: | ||
==Sources== | ==Sources== | ||
Info may be added from a single Mac-Min email, amalgamated from a thread, converted from an article on the old CMUG site, or created from scratch. | Info may be added from a single Mac-Min email, amalgamated from a thread, converted from an article on the old CMUG site, expanded from one of the above, or created from scratch. | ||
Add a "Credits" section at the end of the article to say which of these it is, and mention the main contributor(s) if they consent. | Add a "Credits" section at the end of the article to say which of these it is, and mention the main contributor(s) if they consent. | ||
==Tone== | ==Tone== | ||
If a single email covers a subject sufficiently to publish as it stands, there is no need to rewrite it, if the author consents to be published and credited. Provided the author consents to it being published, it may be reused with little effort by the Wiki editor. | If a single email covers a subject sufficiently to publish as it stands, there is no need to rewrite it, if the author consents to be published and credited. Provided the author consents to it being published, it may be reused with little effort by the Wiki editor. | ||
| Line 15: | Line 16: | ||
It is fine for articles on the CMUG Wiki to vary in tone. We do not pretend to be an encyclopedia or a magazine. An informal style may attract new members to join the [[Mac Ministry List]]. | It is fine for articles on the CMUG Wiki to vary in tone. We do not pretend to be an encyclopedia or a magazine. An informal style may attract new members to join the [[Mac Ministry List]]. | ||
==See also== | ==How to do formatting== | ||
*[[ | For a cheat sheet that summarises the main ways to do formatting, see the Wikipedia page [http://en.wikipedia.org/wiki/WP:CHEAT WP:CHEAT] as this Wiki uses the same software. | ||
==Headings== | |||
The title for the page should be entered at the top, enclosed like this: <nowiki> {{title|Style Guide for this wiki}} </nowiki>. | |||
This is different from Wikipedia and means that the title can be different from the name of the page. For instance, the title of this page is longer, to add clarity. However, so that the indexing does not confuse readers, it should be similar and start with the same word(s). | |||
Section headings should be enclosed by double == characters. | |||
Where relevant, the following standard headings should appear at the end of the page, in this sequence: | |||
*Credits | |||
*See also | |||
*External links | |||
===Sub-sections=== | |||
To create sub-sections, use more = characters, e.g. the heading above this line has three = signs at each end. | |||
==Table of contents== | |||
If there are four or more headings, a Table of Contents will appear automatically at the top. Use the code <nowiki>__TOC__ at the end of the first section to make it appear there. If a page is so short that it doesn't need a table of contents, use __NOTOC__ to suppress the automatic one. </nowiki> | |||
==Dates== | |||
Dates should be written in one of these patterns: | |||
*Mar 4, 2010 | |||
*March 4, 2010 | |||
Do not use only numbers, as 3/4/10 means March 4th in the US but 3rd April in the UK. | |||
==Categories== | |||
New pages are added into one or more relevant categories by including the category codes at the end of the page. This one has <nowiki>[[Category:CMUG]]</nowiki>. It doesn't display that code on the page, but linka to the categories appear below the end of the article. This gives readers another way to navigate between similar articles. | |||
[[Category:CMUG]] | [[Category:CMUG]] | ||
Revision as of 08:17, 6 March 2010
This page gives guidance to editors on what to contribute to this CMUG Wiki, and how to achieve a consistent appearance.
Consent
Before adding information from emails sent to Mac-Min, consider whether the writer might not want the information published openly, or would not want to be identified in the credits. If in doubt, ask the writer for his/her consent before adding material to the Wiki. Alternatively, rewrite it, removing any personal touches or potentially sensitive info.
Sources
Info may be added from a single Mac-Min email, amalgamated from a thread, converted from an article on the old CMUG site, expanded from one of the above, or created from scratch.
Add a "Credits" section at the end of the article to say which of these it is, and mention the main contributor(s) if they consent.
Tone
If a single email covers a subject sufficiently to publish as it stands, there is no need to rewrite it, if the author consents to be published and credited. Provided the author consents to it being published, it may be reused with little effort by the Wiki editor.
It is fine for articles on the CMUG Wiki to vary in tone. We do not pretend to be an encyclopedia or a magazine. An informal style may attract new members to join the Mac Ministry List.
How to do formatting
For a cheat sheet that summarises the main ways to do formatting, see the Wikipedia page WP:CHEAT as this Wiki uses the same software.
Headings
The title for the page should be entered at the top, enclosed like this: {{title|Style Guide for this wiki}} .
This is different from Wikipedia and means that the title can be different from the name of the page. For instance, the title of this page is longer, to add clarity. However, so that the indexing does not confuse readers, it should be similar and start with the same word(s).
Section headings should be enclosed by double == characters.
Where relevant, the following standard headings should appear at the end of the page, in this sequence:
- Credits
- See also
- External links
Sub-sections
To create sub-sections, use more = characters, e.g. the heading above this line has three = signs at each end.
Table of contents
If there are four or more headings, a Table of Contents will appear automatically at the top. Use the code __TOC__ at the end of the first section to make it appear there. If a page is so short that it doesn't need a table of contents, use __NOTOC__ to suppress the automatic one.
Dates
Dates should be written in one of these patterns:
- Mar 4, 2010
- March 4, 2010
Do not use only numbers, as 3/4/10 means March 4th in the US but 3rd April in the UK.
Categories
New pages are added into one or more relevant categories by including the category codes at the end of the page. This one has [[Category:CMUG]]. It doesn't display that code on the page, but linka to the categories appear below the end of the article. This gives readers another way to navigate between similar articles.