Wiki best practice: Difference between revisions
No edit summary |
|||
(15 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:GO Consortium]] | |||
== General == | == General == | ||
Try to avoid using "I" and "We". It's rarely obvious who edited a given wikisection last. | Try to avoid using "I" and "We". It's rarely obvious who edited a given wikisection last. | ||
== Naming Wiki Pages == | |||
Pages names - like GO IDs - should stand the test of time. If you want to make a page for a consortium meeting, don't call it GO_Meeting. Call it GO_Meeting_Sept_2007 or something unambiguous. | |||
Having a grouping page called GO_Meetings is perfectly appropriate however | |||
*Do not use "/" as a substitute for directories | |||
*"GO-CAM" should never be abbreviated, and should always be written in uppercase with a hyphen | |||
=== Don't be afraid to move pages === | |||
If you later realize the name of a page no longer reflects the contents, use the "move" option. It's one of the tabs at the top of the page. It's quite similar (but less extreme than) obsoleting a term and providing replaced_by links. Mediawiki will take care of all the redirection for you. | |||
== Markup == | |||
Learn basic mediawiki markup | |||
Use "==" as initial indentation | |||
Never use HTML tags unless absolutely necessary | |||
== Use wiki categories == | |||
These can help keep pages automagically organized | |||
See the [http://meta.wikimedia.org/wiki/Help:Category MediaWiki help on Categories] | |||
See for example: | |||
* [[:Category:Regulation]] | |||
* [[:Category:Cross Products]] | |||
Full list of categories used on this wiki: | |||
* [[:Special:Categories]] | |||
== Watching == | |||
Watch pages you're interested in - see the tab at the top. You can configure your preferences so that anything you edit you automatically watch | |||
== Linking == | == Linking == | ||
Line 7: | Line 48: | ||
=== Linking between pages === | === Linking between pages === | ||
To make links | To make links within the wiki, use wiki syntax with the square brackets, like this: | ||
[[GO_Managers]] | [[GO_Managers]] | ||
It's much simpler than embedding a whole URL | |||
== Archiving and retiring pages == | |||
Retired pages contain contents that is obsolete and likely inaccurate. | |||
Archived pages include reports, meeting minutes, etc. that are saved for reference. | |||
* Move page, adding "(Archived)" or "Retired" at the end of the page name | |||
* Add Category:Archived or Category:Retired as appropriate. |
Revision as of 16:12, 18 March 2018
General
Try to avoid using "I" and "We". It's rarely obvious who edited a given wikisection last.
Naming Wiki Pages
Pages names - like GO IDs - should stand the test of time. If you want to make a page for a consortium meeting, don't call it GO_Meeting. Call it GO_Meeting_Sept_2007 or something unambiguous.
Having a grouping page called GO_Meetings is perfectly appropriate however
- Do not use "/" as a substitute for directories
- "GO-CAM" should never be abbreviated, and should always be written in uppercase with a hyphen
Don't be afraid to move pages
If you later realize the name of a page no longer reflects the contents, use the "move" option. It's one of the tabs at the top of the page. It's quite similar (but less extreme than) obsoleting a term and providing replaced_by links. Mediawiki will take care of all the redirection for you.
Markup
Learn basic mediawiki markup
Use "==" as initial indentation
Never use HTML tags unless absolutely necessary
Use wiki categories
These can help keep pages automagically organized
See the MediaWiki help on Categories
See for example:
Full list of categories used on this wiki:
Watching
Watch pages you're interested in - see the tab at the top. You can configure your preferences so that anything you edit you automatically watch
Linking
Linking between pages
To make links within the wiki, use wiki syntax with the square brackets, like this:
It's much simpler than embedding a whole URL
Archiving and retiring pages
Retired pages contain contents that is obsolete and likely inaccurate. Archived pages include reports, meeting minutes, etc. that are saved for reference.
- Move page, adding "(Archived)" or "Retired" at the end of the page name
- Add Category:Archived or Category:Retired as appropriate.