Difference between revisions of "Wiki editing guidelines"

From EPrints Documentation
Jump to: navigation, search
Line 16: Line 16:
 
<pre> #My lines of code go in here </pre>
 
<pre> #My lines of code go in here </pre>
  
Some times you will have a few tokens of code that you wish to use in a sentance. To do this use the &lt;code&gt; tag
+
Some times you will have a few tokens of code that you wish to use in a sentance. To do this use the &lt;code&gt; tag. For example when I want to talk about <code>$c->{set_eprint_automatic_fields}</code> in a sentance.

Revision as of 11:08, 8 June 2010

This is a guide to best practices when editing the EPrints wiki.

The EPrints wiki uses a standard installation of MediaWiki. A basic guide to understanding wiki markup for formatting pages can be found here: http://www.mediawiki.org/wiki/Help:Formatting

The main aim of these guidelines is to help keep information stored on the wiki usable, organised and discoverable. This means that other users will be able to get the best use of out you help.

Page Formatting

Headings

To make a page easy to navigate internally it is advisable to use sensibly nested headings and sub headings. This will result in neat table of contents at the top of your page. It also makes the document more readable.

If your page is very short you may want to remove the table of contents by placing the __NOTOC__ directive at the top of the page.

Code in text

Often you will want put code snippets in text. If you have a line of code of more place the code in a <pre> like so:

 #My lines of code go in here 

Some times you will have a few tokens of code that you wish to use in a sentance. To do this use the <code> tag. For example when I want to talk about $c->{set_eprint_automatic_fields} in a sentance.