Help:Wiki Beginners Guide

From NuGOwiki

Jump to: navigation, search


This will be a very short simple guide to start people off with links to further reading.

Contents

What the Wiki is for

Welcome to the NuGOwiki, a content management framework based on the Mediawiki open source engine that allows all users to edit and store content centrally.

It seeks to fulfil two primary objectives:

  1. To develop a metabolite database which will act as a central point for anyone seeking information on biological and other information of this vast range of compounds. Contributions will be drawn from the global metabolomic community and from members of the larger scientific community, including pharmacology, toxicology and pathology.
  2. To develop a curriculum for an MSc in Nutrigenomics. This curriculum will be available from multiple institutions and the wiki will be used to allow representatives of these universities to collaborate on the development of the curriculum and share resources.

We hope to build a community of users who will contribute, where they can, to the body of knowledge, and rely on NuGOwiki as a central resource in the field of nutrigenomics.

Layout of Site

The wiki is divided into two main sections; the Metabolite Database and the MSc Curriculum.

To make it easy to find pages within the site, they should normally be placed into a category. However it is worth noting that if the category has a large number of pages (especially if they are similar) - a new page may be difficult to find. In many cases an intermediate page is advisable. For example see the Objective 1 Meetings page. The advantages of having an intermediate are:

  1. There is a central ordered document to access similar pages
  2. There is a guideline to the nomenclature of the pages that can be followed to keep them standard.
  3. Interested parties can watch the intermediate page for updates.

The disadvantage is that there is extra maintenance - i.e. the intermediate page needs to be updated when a new document is added.

Quick Intro to Editing

Editing within a wiki is relatively simple and safe. Any changes to the pages are recorded and therefore if you make a mistake, it can easily be reverted by youself or any other person.

5 Easy Steps to Editing a page

  1. To be able to edit a page you must first log in. If you have forgotten your password please contact [1].
  2. On the page you wish to edit click the Edit tab at the top of the page. Note that some pages are locked to protect their content in which case you will see "View source"
  3. Start editing! Note that wikitext has its own language for formatting text and layout. Download and print out this [[2]] for a basic reference. If you want to know more see Editing Help - note that this link is always available below the editing box which will bring up a pop-up window.
  4. Enter a short description on what you have done in the Summary box. If you have done minor changes e.g. correct typos check the "This is a minor edit" box.
  5. Preview the Changes by clicking on Show preview button below the edit box and check your edits and, once happy with the changes, save the page!

Recommended Preferences

It is recommended that you change a few of the default preferences for your account. In order to do this you must first login.

  1. Click on preferences at the top right had side of the page.
  2. Enter your e-mail address in the User data form. This enables you to be sent a new password automatically and e-mail notifications of your watched pages.
  3. Verify your e-mail address
  4. Enable Send me an email on page changes. With this enabled you will get an e-mail when any of your watched pages are updated. See Watching pages for more details.
  5. In Recent Changes and Stubs menu - Enable Enhanced Recent changes Note that this will only work if you have JavaScript enabled. This gives a clearer and more succinct view of Recent Changes made to the Wiki.

Watching pages

Watching a page is a useful way of keeping track of changes to pages that you are interested in, especially the e-mail alerting preferences detailed in the recommended preferences section above has been set up. Click on the Watch tab at the top of the page that you wish to track. When the page is updated an email with a link to the page is automatically sent to you. Additionally all watched pages are highlighted in bold in Recentchanges. To list and manage your watched pages, click "my watchlist" link at the top right hand side of any page (when logged in).

Further Reading