Editing Wiki editing guidelines (section)

==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 <code> <nowiki>__NOTOC__</nowiki> </code> directive at the top of the page.

===Versioning===
When you write a wiki page it is very useful if you can include at the top the versions of Eprints you think this applies to. For example
<pre>Applicable to 3.2.1+</pre>
If you know a page does not work for a version of EPrints (probably from experience) edit the page to include that.

===Linking===
If you refer to material from another wiki page or another website please place a link to it. It makes moving around the wiki much smoother and really increases the usefulness of your document. Note: it will often be useful to link to a page in the EPrints_3_Reference category since this explains some of the configuration in detail.

===Code in text===
Often you will want put code snippets in text. If you have one line of code or more place the code in a <code>&lt;pre&gt;</code> like so:
<pre> #My lines of code go in here </pre>

The most readable way to present source code is to surround it with <code>&lt;source lang="..."&gt;source code here&lt;/source&gt;</code> tags, where <code>...</code> is the language name, such as perl or xml.  For example:

<source lang="perl">
               my $fields = $session->get_conf('etd_ms','fields');					
               foreach my $field_conf (@{$fields})
		{
		   my $tags = $plugin->generate_tag($eprint, $field_conf);			
		   foreach my $tag (@{$tags})
		   {
					push @dcdata, ($tag) if $tag; 
		   }
		}
</source>

Some times you will have a few tokens of code that you wish to use in a sentence. 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 sentence.

===Lists===
Bulleted lists are a very clear and easy way to convey information clearly and concisely. Do not shy away from using bulleted lists or numbered lists (see the mediawiki article above). You can also easy nest lists.