Difference between revisions of "Wiki best practice"

From GO Wiki
Jump to navigation Jump to search
m
Line 6: Line 6:
== Naming Wiki Pages ==
== 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.
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, to group all GO_Meetings pages.
 
Having a grouping page called GO_Meetings is perfectly appropriate however


*Do not use "/" as a substitute for directories
*Do not use "/" as a substitute for directories
*"GO-CAM" should never be abbreviated, and should always be written in uppercase with a hyphen
*"GO-CAM" should never be abbreviated, and should always be written in uppercase with a hyphen.


=== Don't be afraid to move pages ===
=== 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.
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.


== Markup ==
== Markup ==
Line 21: Line 19:
Learn basic mediawiki markup
Learn basic mediawiki markup


Use "==" as initial indentation
Use "==" as initial indentation.


Never use HTML tags unless absolutely necessary
Never use HTML tags unless absolutely necessary.


== Use wiki categories ==
== Use wiki categories ==


These can help keep pages automagically organized
These can help keep pages automagically organized.


See the [http://meta.wikimedia.org/wiki/Help:Category MediaWiki help on Categories]
See the [http://meta.wikimedia.org/wiki/Help:Category MediaWiki help on Categories]
Line 42: Line 40:
== Watching ==
== 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
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 ==


=== Linking between pages ===
=== Linking between wiki pages ===


To make links within the wiki, use wiki syntax with the square brackets, like this:
* To make links within the wiki, use wiki syntax with the double square brackets, like this:


<pre>[[Name of page]]</pre>
<pre>[[Name of page]]</pre>
* To link to external webpages, use single brackets, like this:
<pre>[http://geneontology.org/]</pre>
** To give a name to the link, leave a space between the URL and the name:
<pre>[http://geneontology.org/ GO website]</pre>


== Archiving and retiring pages ==
== Archiving and retiring pages ==
Line 59: Line 63:
* Move page, adding "(Archived)" or "Retired" at the end of the page name
* Move page, adding "(Archived)" or "Retired" at the end of the page name
* Add Category:Archived or Category:Retired as appropriate.
* Add Category:Archived or Category:Retired as appropriate.
== Review Status ==
Last reviewed: April 11, 2019

Revision as of 11:35, 11 April 2019

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, to group all GO_Meetings pages.

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

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 wiki pages

  • To make links within the wiki, use wiki syntax with the double square brackets, like this:
[[Name of page]]
  • To link to external webpages, use single brackets, like this:
[http://geneontology.org/]
    • To give a name to the link, leave a space between the URL and the name:
[http://geneontology.org/ GO website]

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.

Review Status

Last reviewed: April 11, 2019