Difference between revisions of "Wiki best practice"

From GO Wiki
Jump to navigation Jump to search
m
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:GOC Overview]]
== 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.
==Moving 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 '''[http://meta.wikimedia.org/wiki/Help:Wikitext mediawiki markup]'''.
* Use "=" as initial indentation. Add further levels by adding extra "=" characters.
* Avoid using 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 ==


=== Linking between pages ===
=== Linking between wiki pages ===
 
To make links within the wiki, use wiki syntax with the double square brackets, like this:
To make links on the wiki, do it like this:
<pre>[[Name of page]]</pre>


[[GO_Managers]]
===Linking to external webpages===
To make links to external webpages, use single brackets:
<pre>[http://geneontology.org/]</pre>


=== Linking between the public and consortium wiki ===
To give a name to the link, leave a space between the URL and the name:
<pre>[http://geneontology.org/ GO website]</pre>
Format on page: [http://geneontology.org/ GO website]


These are the URLs for the twoo wikis:
== Archiving and retiring pages ==


* Public wiki: http://wiki.geneontology.org
Retired pages contain contents that is obsolete and likely inaccurate.  
* Internal consortium wiki: http://gocwiki.geneontology.org
Archived pages include reports, meeting minutes, etc. that are saved for reference.  


If you are editing the consortium wiki and want to make a link to the public, you can use the gowiki: prefix as a shortcut; for example
* Move page, adding "(Archived)" or "Retired" at the end of the page name
* Add Category:Archived or Category:Retired as appropriate.


* [[gowiki:Example_Queries]] is a shortcut for http://wiki.geneontology.org/index.php/Example_Queries
== Review Status ==


You can make reciprocal links using the gocwiki: prefix
Last reviewed: April 11, 2019

Latest revision as of 09:05, 12 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.

Moving 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

  • Use "=" as initial indentation. Add further levels by adding extra "=" characters.
  • Avoid using 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]]

Linking to external webpages

To make links to external webpages, use single brackets:

[http://geneontology.org/]

To give a name to the link, leave a space between the URL and the name:

[http://geneontology.org/ GO website]

Format on page: 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