G2GP Wiki Guide: Markup and Conventions#

Filenaming#

See Creating a page section.

Editing Pages#

By default all users are set to use the plain editor for wiki page markup. Once in the editor you will be able to see, below the text panel, an outline of common markup elements. A number of standardised tags along with details of where to use them are also detailed on this page (below). Two alternative editors have also been installed, plain and FCKEditor (discussed below), and both can be accessed from the 'My Prefs' link on the wiki toolbar. All of the editors do have an options and editor toolbars so much of the formatting can be applied a la Word (select text and click formatting option). The three editors are:

• Plain - a simple plain text editor. All markup is visible and will only display formatting in the preview window below the editor.

Users should be aware that a time-out period of 30 minutes has been across the whole wiki (both viewing and editing). If no activity is registered within this period you will be automatically logged out.

Headings#

Table of Contents

• Guide Titles - triple !
• Guide authors and section headings - single !

Page headings

• All pages should contain navigation (very top and bottom) and the section heading (top, !!)
• Subheadings should be styled as per example below

Text - blocks and paragraphs#

• Inset block (simple paragraphs) - use Definition Block (;term:def) without a term.
• Bulleted list within a Definition block use:

%%(margin-left:3em;)
YOUR TEXT HERE
%%

• Inset block (large complex text w/ backround colour and border) - use:

%%( background-color: #ddd; border: 1px dotted black; padding: 1em; )
YOUR TEXT HERE
%%

• Centre text (some figure/table captions etc.):

%%center
your text here
/%

Navigation Elements#

Top of page:

[Previous|DbSht_2] ~| [Next|DbSht_Bib] ~| [Contents|DbSht_Toc]
----

!!Section 3. Archiving Databases and Spreadsheets...

Bottom of page

...documentation can then be stored in sub directories within this structure.

----

[1|#1] [http://www.gnome.org/projects/gnumeric/|http://www.gnome.org/projects/gnumeric/]
\\[2|#2] [http://www.bar.admin.ch/dienstleistungen/00823/00825/index.html?lang=en]
----

[Previous|DbSht_2] ~| [Next|DbSht_Bib] ~| [Contents|DbSht_Toc]
\\
\\

Text - fonts, style, etc.#

• There is no underlined text (easy to confuse with links).
• Use unicode to insert special characters e.g. the degree symbol (°) is U+00B0 (unicode) so would be inserted in wikimarkup as:

°

Images/Figures#

More info here: http://www.jspwiki.org/wiki/Image

• In order to display images on pages it is necessary to attach/upload the relevant file. Images should be attached to the page in which they are displayed. Images can be uploaded to one page and linked to from another, just add in the page name to the link address e.g. src='Main/pic1.jpg'
• Images should be named using the guide title, section and figure numbers e.g. gis_1-1_fig01.gif.
• Images should be no wider than 796px
• Figures should be centred
• Captions should be formatted as below (prefixed 'Figure #'(bold) and centred, followed by double line break).
• example:

[{Image src='gis_1-1_fig01.gif' align='center' alt='2d'}]
%%center
__Figure 1__: Two-dimensional engineering-style drawing...
%%
\\
\\

Linked image (e.g. to a larger version):

[{Image src='oldcad_fig03_thumb.gif' align='center' link='http://guides.archaeologydataservice.ac.uk/attach/OldCad_2-4/oldcad_fig03.gif' alt='a picture'}]
%%center
__Figure 3__: Part of a plan of a ditch context at Deansway (© Worcestershire Archaeological Service)  (''Click for larger image'')
%%
\\
\\

Tables#

• Should be captioned above table e.g.

\\
%%center
__Table 1__: caption text here...
%%
||Header1||Header2
|Content1|Content2

Comments / Notes / Warnings#

Use %%commentbox ... /% for a rhs comment box e.g.

Glitches to note#

• double-clicking to highlight a word will include the trailing space (unless follwed by punctuation).
• JSPwiki uses CamelCase i.e. anything in square brackets is automatically identified as a link. If you really need to use square blackets then you can escape camelcase by using a tilde ~ before the first square bracket (and if you need a tilde then just double up).

Advanced stuff#

• CSS inline styles http://www.jspwiki.org/wiki/JSPWikiStyles