Difference between revisions of "HaskellWiki:Guidelines"
Jump to navigation
Jump to search
BrettGiles (talk | contribs) (→Headlines: Adding note about Level1 vs Level2 being under discussion) |
|||
| Line 1: | Line 1: | ||
Here you will find guidelines for editing this wiki. |
Here you will find guidelines for editing this wiki. |
||
| − | |||
| − | = Official guidelines = |
||
| − | |||
| − | Currently, there are no official guidelines for this wiki. |
||
| − | |||
| − | = Unofficial guidelines = |
||
| − | |||
| − | What follows are some unofficial guidelines, contributed by different users. |
||
== Page titles == |
== Page titles == |
||
| Line 16: | Line 8: | ||
# Titles should use sentence-style capitalization (see [http://en.wikipedia.org/wiki/Capitalization#Headings_and_publication_titles]). Capitalizing more words seems to be only appropriate in larger documents like books. If slashes are used to denote hierarchy, each part of the hierarchical title should be handled as if it were a title itself, i.e., its first word should be capitalized. |
# Titles should use sentence-style capitalization (see [http://en.wikipedia.org/wiki/Capitalization#Headings_and_publication_titles]). Capitalizing more words seems to be only appropriate in larger documents like books. If slashes are used to denote hierarchy, each part of the hierarchical title should be handled as if it were a title itself, i.e., its first word should be capitalized. |
||
Currently, the page titles on this wiki adhere more or less to these guidelines. |
Currently, the page titles on this wiki adhere more or less to these guidelines. |
||
| − | |||
| − | -- [[User:Wolfgang Jeltsch|Wolfgang Jeltsch]] |
||
| − | |||
| − | == Headlines == |
||
| − | |||
| − | Each page has a title which is automatically shown near the top of the page (currently centered and in red). So it doesn't make sense to put a single level 1 headline at the top of the page. (At the moment, you will see this on a few pages of this wiki. I suppose this is a legacy which comes from copying content from the old website to this wiki.) |
||
| − | |||
| − | For top-level structuring, level 1 headlines (the ones denoted by single equals signs in the source) should be used. It is semantically incorrect to use level 2 headlines for this purpose. I note that level 1 headlines are currently rather large and in a font that might not be preferable. However, the solution to this is not to refrain from using level 1 headlines but to change the stylesheet appropriately. |
||
| − | |||
| − | :''Note that is is currently being discussed. Level 1 (single equals) create an <tt><h1></tt> heading, which is the same level as the page title. We may (or may not:) switch to the standard of starting at level 2 (double equals) - See [[HaskellWiki_talk:Guidelines|Discuss this page]] for the discussion.'' |
||
| − | |||
| − | -- [[User:Wolfgang Jeltsch|Wolfgang Jeltsch]] |
||
== Editing == |
== Editing == |
||
When editing a wiki, the bottom of the editing page has a place to put a summary. It is considered good form to put a one line comment about any changes you are making. As well, you have the capability to mark an edit as ''minor''. Please use this only for changing format, spelling, fixing bad links or minor word re-arrangement. It should not be used when adding whole new sections, a signficant number of links, new pages or rewrites of the page. |
When editing a wiki, the bottom of the editing page has a place to put a summary. It is considered good form to put a one line comment about any changes you are making. As well, you have the capability to mark an edit as ''minor''. Please use this only for changing format, spelling, fixing bad links or minor word re-arrangement. It should not be used when adding whole new sections, a signficant number of links, new pages or rewrites of the page. |
||
| − | |||
| − | -- [[User:BrettGiles|BrettGiles]] |
||
Revision as of 06:31, 3 March 2006
Here you will find guidelines for editing this wiki.
Page titles
These are some guidelines for page titles:
- Page titles not only affect a page's URL but they are also shown at the top of the page. Therefore, it is important that a page title is a title, not a mnemonic “path name”. I strongly doubt that we need such mnemonic names but if they are introduced they should denote only redirects to the actual page.
- On the other hand, it is good if titles are not unnecessarily long so that URLs have reasonable size. Especially, redundant occurences of the word “Haskell” in titles should be avoided. If a page on HaskellWiki is just named “Compilers and interpreters”, it should be clear that it refers to “Haskell compilers and interpreters”, so the extra “Haskell” is not needed.
- Titles should use sentence-style capitalization (see [1]). Capitalizing more words seems to be only appropriate in larger documents like books. If slashes are used to denote hierarchy, each part of the hierarchical title should be handled as if it were a title itself, i.e., its first word should be capitalized.
Currently, the page titles on this wiki adhere more or less to these guidelines.
Editing
When editing a wiki, the bottom of the editing page has a place to put a summary. It is considered good form to put a one line comment about any changes you are making. As well, you have the capability to mark an edit as minor. Please use this only for changing format, spelling, fixing bad links or minor word re-arrangement. It should not be used when adding whole new sections, a signficant number of links, new pages or rewrites of the page.