CATUG wiki:Notes for editors: Difference between revisions
m (→Standard headings: edit re using level 1) |
(Creating a new page) |
||
| Line 3: | Line 3: | ||
This page gives guidance to editors on what to contribute to this CMUG Wiki, and how to achieve a sufficiently consistent appearance. | This page gives guidance to editors on what to contribute to this CMUG Wiki, and how to achieve a sufficiently consistent appearance. | ||
=Consent= | |||
First of all, 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. | First of all, 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 | =Creating a new page= | ||
One way to do this is to search for the subject, with appropriate capital letters, e.g. "My page", and click "Go". The search results include a line | |||
:There is no page titled "My page". You can create this page. | |||
Then click on "create this page" to do so. | |||
=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. | 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= | |||
If a single email covers a subject sufficiently to publish as it stands, there is no need to rewrite it | If a single email covers a subject sufficiently to publish as it stands, there is no need to rewrite it. Provided the author consents to it being published and credited to him/her, 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]]. | 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]]. | ||
=Standard headings= | |||
The title for the page should be entered at the top, enclosed like this: <nowiki> {{title|Notes for editors}} </nowiki>. | The title for the page should be entered at the top, enclosed like this: <nowiki> {{title|Notes for editors}} </nowiki>. | ||
| Line 28: | Line 33: | ||
*External links | *External links | ||
=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> | 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: | Dates should be written in one of these patterns: | ||
*Mar 4, 2010 | *Mar 4, 2010 | ||
| Line 38: | Line 43: | ||
Do not use only numbers, as 3/4/10 means March 4th in the US but 3rd April in the UK. | 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. | 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. | ||
| Line 45: | Line 50: | ||
:<nowiki>[[Category:News|Bible Software 2006]]</nowiki> | :<nowiki>[[Category:News|Bible Software 2006]]</nowiki> | ||
=See also= | |||
*[[CMUG: Formatting guide]] | *[[CMUG: Formatting guide]] | ||
[[Category:CMUG|Notes for editors]] | [[Category:CMUG|Notes for editors]] | ||
Revision as of 17:40, 7 March 2010
This page gives guidance to editors on what to contribute to this CMUG Wiki, and how to achieve a sufficiently consistent appearance.
Consent
First of all, 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.
Creating a new page
One way to do this is to search for the subject, with appropriate capital letters, e.g. "My page", and click "Go". The search results include a line
- There is no page titled "My page". You can create this page.
Then click on "create this page" to do so.
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. Provided the author consents to it being published and credited to him/her, 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.
Standard headings
The title for the page should be entered at the top, enclosed like this: {{title|Notes for editors}} .
This means that the title can be different from the name of the page, e.g. where additional words help to add clarity. In the case of this page, the title is shorter, omitting the Wiki namespace code "CMUG:". 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 = characters, as shown at CMUG: Formatting guide.
Where relevant, the following standard headings should appear at the end of the page, in this sequence:
- Credits
- See also
- External links
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.
If the article should be indexed by something other than the first word of the page name, then add a bar followed by the sort key, e.g.
- [[Category:Bible Software|2006]]
- [[Category:News|Bible Software 2006]]