TracNav

Wiki Guidelines and Help

Do not edit this page.

Table of Contents:

  1. Getting Started
  2. Good Etiquette
  3. Creating and Naming Pages
  4. Navigation Menu
  5. Comment Boxes
  6. Passwords
  7. Trac Wiki

Getting Started

Registered users have accounts that let them edit and update these wiki pages. If you have any questions about passwords, send an email to: ef-web [at] ukoln.ac.uk.

Feel free to contribute, but be sure to follow the purpose of the page you're editing. For example, if a page is a discussion or thread DO NOT edit previous posts. If someone has stated clearly that you shouldn't edit a page DO NOT edit it. Read the section on good etiquette.

Consider subscribing to the mailing lists.

Good Etiquette

Please read the e-Framework Acceptable Use Policy.

Observe the following recommendations when using the wiki:

  • On new pages you MUST state what the page is for. Short sentence at the top.
  • A page should clearly state who can edit the page. Otherwise everyone can edit.
  • Sign your contributions to pages and comments.
  • Feel free to fix anything anywhere that is obviously broken eg. spilling erros and typos
  • In pages that are communal you may do anything you like, including rewording sentences and restructuring
  • In pages belonging to other people you can and should ask questions. You can post comments to the end of the page following this example:

<insert your name>: Can we have some more information please?

  • Links are important so as you progress try to make as many as you can - it is good to let others know what you are doing and what is going on.
  • Don't like a comment? Regard this as an opportunity for discussion. Revert back to previous versions of a page only when necessary.

Wiki pages generally follow one of these formats.

  • Documents - single owner text, or community editable text, comments generally are added to the bottom. Edits to the text usually don't require signing your name.
  • Structured Documents - contribute, but try not to change the structure unless everyone agrees
  • Threads or Discussions - contribute by adding your comments

Creating and Naming Pages

In the Trac wiki system it is easier to manage smaller pages than big ones. Feel free to make new pages, but it is advisable to follow a sensible structure, for example parent/child structure.

Use WikiWords or CamelCase for page names. This means a word that starts with uppercase, then some lowercase, then more uppercase. To indicate child pages use the name of the parent page as a prefix. For example, you might have a page called FruitPage with links to children FruitPageApple, FruitPageOrange etc. This allows the title list feature of the wiki to put child/sub-pages under their parent (see "Index by Title" in toolbar).

You can create new pages by first editing an existing page to add a link to a new page name. Once this change has been made on the existing page you then click on the link to create the new page. WikiWords automatically link to pages but you can force links by using the following. 

[wiki:FruitPageBanana The banana page]

For an example: on the SUMs Development page also found in the menu, you can click the 'Edit this Page' button. You might add the following text under one of the existing headings... 

  * [wiki:DevelopmentSUMBanana  Banana SUM] - Fred Bloggs, JISC - Banana management system

    * ''Status:'' In Development

Once these changes are submitted clicking on the [wiki: link entitled Banana SUM will create a new page called DevelopmentSUMBanana .

When creating a new wiki page you can include the Navigation Menu on the right hand side of the page. Please include the following code on the first line of your page in the 'editing textbox': 

[[TracNav(WikiNav)]]

Don't just edit the Navigation Menu. Discuss with ef-web [at] ukoln.ac.uk first. To add a new page to the navigation menu please click on the 'edit' hyperlink within the navigation on the right

Comment Boxes

NOTE This comments macro feature has been removed for security reasons.

As the comments macro is vulnerable to spam, please use the following procedure if you wish to invite comments from other registered users.

Create a comments section simply by entering:

COMMENTS SECTION (please enter comments here)

Passwords

Registered users have been given passwords. If you need editing access to this wiki and do not have a login password, please send a support request via email to ef-web [at] ukoln.ac.uk

Trac Wiki

Trac is a minimalistic approach to web-based management of software projects, but this Trac installation is used mainly for its wiki component.

Wiki pages can be edited by registered users (even this one). This means that you can modify the contents of this page simply by using your web-browser. Simply click on the "Edit this page" link at the bottom of the page. WikiFormatting will give you a detailed description of available Wiki formatting commands.

Enjoy!

The Trac Team

Starting Points:

  • TracWiki -- How to use the built-in Wiki.
  • TracGuide -- Built-in Documentation for all of Trac

For a complete list of local wiki pages, see TitleIndex.