Help:Contents
From BioclipseWiki
This page contains editing help and guidelines for this wiki. For general help with Bioclipse, see the FAQ or Documentation page at the main site, as well as other pages on this wiki, like the Development tutorials.
Contents |
The MediaWiki Syntax
- See the Cheatsheet over at Wikipedia.
- And the ditto for Semantic MediaWiki
Categories
Categorizing an article
A simple categorization is done like so:
[[Category:My pretty category]]
This will categorize that article with "My pretty category".
Creating Category trees
By categorizing a page (see "Categorizing an article") above, you'll get a link to the corresponding category page in a box at the bottom of the page. If you click that link and categorize that category page you have started creating a category tree.
For example: On the article Category:My pretty category, you would add:
[[Category:My pretty category's parent category]]
...then My pretty category will become a subcategory of My pretty category's parent category category, with bi-directional links between etc.
Linking to a category page
If you want to link to a category page, rather than categorizing a page, you do it by adding an extra ':' in the beginning, like so:
[[:Category:My pretty category's parent category]]
Templates
Existing templates that can be used
See each template page below for usage instructions and cut-and-paste code snippet.
- Template:Development tutorial - Information on how to develop Bioclipse and plugins for it.
- Template:Working page - For suggestions, drafts, collaborations, brainstormings and the like.
- Template:Feature - For Bioclipse features.
- Template:Project - For Bioclipse subproject, like plugins etc.
- Template:Repository - For Bioclipse subproject, like plugins etc.
- Template:BioclipseLab - For marking up a Bioclipse research group.
- Template:Developer - For marking up a Bioclipse developer.
- Template:Caution - For caution message.
- Template:Caution.OutOfDate - For indicating that a page/article is out of date.
- Template:Caution.Bioclipse1 - For indicating that a page/article is not applicable/useful for Bioclipse2.
- Template:TOCright - For moving the table of contents (TOC) to the right, (floating beside the wiki content).
Creating templates
Templates are created using the following syntax, anywhere, on any page:
{{Template name|Unnamed parameter 1|Unnamed parameter 2|Name of named parameter 1=Parameter 1 content|Name of named parameter 1=Parameter 1 content}}
Or, in a prettier way:
{{Template name|
|Unnamed parameter 1
|Unnamed parameter 2
|Named parameter 1=actual parameter content
|Named parameter 2=actual parameter content
}}
This will create a link to the article Template:Template name. Clicking that link will allow you to start design your template.
Inside the template article you can output the content sent to the template through the parameters, like so:
{{{1}}}
{{{2}}}
{{{Named parameter 1}}}
{{{Named parameter 2}}}
Or maybe add some pretty formatting, for example creating a list, and labels before the parameter content:
* '''Some label 1:''' {{{1}}}
* '''Some label 2:''' {{{2}}}
* '''Some label 3:''' {{{Named parameter 1}}}
* '''Some label 4:''' {{{Named parameter 2}}}
Categorizing pages using templates
Note that you can even categorize pages based on the content of the parameters.
So for example you can create a template that simply categorizes a page, like so:
{{Categorize page|
|The category=A category
}}
And then inside the template page categorize, by using the content of the parameter "The category" like so:
[[Category:{{{The category}}}]]
This will then categorize with "The category" all pages where the template is used.
Conditional output of template variables
If, inside a template, there is content that you want to show only in case a certain template variable is set (for example a label for the content of the variable), you do it like so (using something called "parser functions", which is enabled on this wiki):
{{#if: {{{Conditional variable|}}} | Show this if variable is set to sth | Show this if variable is empty }}
So, for example:
{{#if: {{{Conditional variable|}}} | '''Nice label:''' {{{Conditional variable}}} | }}
