Protocol

Editing Help

This tutorial provides an important introduction to editing wiki pages using wiki syntax. It is a useful reference for both new and experienced users!

Getting started editing
Editing mode
Using the editing toolbar
Using Wiki-syntax
Editing Cheatsheet
Advanced editing tips and coding
Categories
When you've finished editing
Give it a go!

Getting started editing

As a registered user, you can, and should, edit, correct any mistakes, update and add to any protocols or discussions you see on PrometheusWiki. Don't be afraid! No changes are lost, and any mistakes can be undone!

To start editing an existing protocol:

Select the 'edit' icon from the top right hand side of the protocol or section you wish to edit.

Alternately, click the button labelled 'EDIT' at the foot of the protocol in question.

This will open an new window - the same page in editing mode. Below the ordinary text is a special box in which you can see the protocol text, in wiki format (ie the formatting has been replaced by symbols amongst the wording). In this editing mode you can add, remove or alter existing text and attachments using TikiWiki syntax, or the editing tool bar.

Note: you must be registered to edit any PrometheusWiki page.

Back to Contents

Editing mode

Below is an image of a page in 'Editing mode'.

There are two options you can use to edit a page - the 'quicktags'/icons in the editing tool bar, and typing in Wiki-Syntax code directly.

Back to Contents

Using the editing toolbar

Using the 'quicktags' is the easiest editing option, recommended for beginners. Simply highlight the text you wish to format, and select the appropriate quicktag to format the highlighted text as you desire. Other options, such as creating a table and inserting hyperlinks, are also available using quicktags.

Within editing mode, there is a blue 'Help button' insert image (note: tiki5 only) towards the right end of the editing tool bar. Clicking on this will bring up a list explaining what each of the quicktags in the editing toolbar do, and also allows you to conduct a search on more advanced editing options.

Back to Contents

Using Wiki-syntax

PrometheusWiki uses the software TikiWiki which is based on the markup language Wiki-Syntax – see http://doc.tikiwiki.org/tiki-index.php?page=wiki-syntax+text. This is essentially the 'language' used to edit TikiWiki pages. In addition to, or instead of using the quicktags available in the editing toolbar, you can choose to format wiki pages by typing in Wiki-Syntax code directly during editing mode. It's quite easy to learn!

Note: The Wiki-Syntax associated with the TikiWiki software used on PrometheusWiki is slightly different to that used on Wikipedia and some other wikis.

Back to Contents

Editing Cheatsheet

For users who want to become more competent with using Wiki-Syntax, download the Editing Cheatsheet here to get started using basic Wiki-Syntax to format pages and protocols.

Back to Contents

Advanced editing tips and coding

To learn more about how to edit a wiki page using Wiki-Syntax, the following external pages contain a lot of useful tips - TikiWiki for Smarties or http://doc.tikiwiki.org/tiki-index.php?page=wiki-syntax+text.

Back to Contents

When you've finished editing

In editing mode there are a number of buttons to choose from to view your newly edited page:

‘Preview’ allows you to refresh the edit mode to include both the editing feature with the raw code, and a view of the page as it will appear on the wiki itself. However, this does not ensure your changes have been saved.

By pressing ‘Save minor edit’, you leave the editing mode and any edits you have made appear in a refreshed screen image of the protocol.

Until you have completely finished editing and formatting your protocol, it is best to choose to ‘Preview’ or ‘Save minor changes’ rather than the 'Save' button, because pressing ‘Save’ automatically sends your protocol or a record of your changes to the responsible editor for assessment. Once you are completely prepared to submit your changes, then press 'Save'.