Getting Started with the Taxonomy Wiki

Simple user guide for beginners

Getting in

  1. Log On (the bleeding obvious)
    • You should be already registered.
    • You won't be able to see anything much beyond the main Wiki page until you log on.
    • You will not be able to add or edit anything until you log on.
    • Log on by clicking on the Log On icon on the top left hand side of the Wiki side bar and the log on page will appear.
    • Enter your user name and password.
  2. Change your password, email and other details
    • Go to your personal wiki page
    • Link at the bottom of the page takes you to another page to change your password
    • Link at the bottom of the page takes you to another page to change your email address
    • Use the form on the page to update other personal details
  3. Checking things out:
    • The main page has a lot of useful links. You should check out the policies and guidelines so you understand the rules of engagement with (the taxonomy.org.au Wiki guidelines).
    • Each project has its own "Wiki Web", i.e. area where members of those projects conduct their research business.
    • You navigate to the various Wiki webs from the main page via the left side bar and/or you can put your own Project WebHome page into your favourites.
  4. Editing etc.
    • You can look at everything
    • You can edit the main Wiki Web (if you are logged in)
    • You can edit your own and your project Wiki Web (if you are logged in)
    • You can edit other project webs (if you are logged in and have been added to the project group)

Practicalities

Editing

  1. Find the page you want to change.
  2. Hit the edit button on the top right of the page or click the red underlined 'edit' link at the very bottom left of the page. This takes you into the edit screen.
  3. Start making your changes, keeping in mind the page formatting and editing recommendations found at Main.TaxonomyWikiGuidelines#General_page_structure
  4. With Foswiki, the default option is to edit in the WYSIWG (= What You See is What you Get) mode. This is easy after you get the hang of the idea that a Wiki is NOT meant to be a really cool text editor with all formatting bells and whistles you have in your favourite word processing package. The WYSIWG editor has its little ways but is generally fun.
  5. If something is not working the way you think it should, try looking at it in Foswiki markup mode i.e. hit the little pick-tool icon on the right hand of the bottom row on the editing toolbar and have a look at the place which is giving you pain. You might see that you've put in a paragraph tag or something else which is interfering with your formatting. Once you get the hang of Foswiki markup script, it can be faster to write your text in this mode than in WYSIWYG mode.
  6. Spellchecking is only available in the "Raw Edit" mode (click the pick-tool). It also requires the firefox browser.
  7. Note that you can also convert existing input from Microsoft Word to Foswiki markup language, maintaining some degree of formatting. existing input from Microsoft Word to Foswiki markup language, maintaining some degree of formatting.
    • Follow the instructions given via the this link and install the Word2Wiki macro in Microsoft Word
    • Prepare your document in word
    • Run the macro on the document
    • Copy the converted text
    • Open the Web topic page in raw edit mode i.e. in Foswiki markup editing mode
    • Paste the converted text into the editor in the appropriate place on the page
    • Have a look at it in the WYSIWYG editor and correct any little funnies that have crept in.

  1. If you make a mistake in a link you can lose all of the edits you've done since the last save. To avoid frustration, it is best to save, make the link and save again to see if it works.
  2. You can put in a link by putting in the entire URL inside nested square brackets i.e. [[http://taxonomy.org.au/twiki/bin/view/Main/WebHome]]. If you don't use the nested square brackets, mostly the link works, but sometimes it doesn't, which can lead to Wiki-rage (see point 1 above).
  3. You can define a link to a page in the Wiki by specifying it, again inside double nested square brackets, with the web name e.g. Main, or Hubris followed by a dot "." and then the name of the required page e.g. [[Ants.ActiveTopics]] .
  4. If you've got a table of contents, you can also include the heading as shown in the link in Point 3 in the Editing section above i.e. with a '#' character between the page name and the first n characters of the heading - best to copy this straight off the Address banner in your browser so you get the right n characters.
  5. Note that if your link is to a page in the same web, i.e. you are working in the Ants web and you want to link to a page also in the Ants web, you can omit the "Ants." prefix e.g. [[ActiveTopics]].
  6. The convention we prefer is NOT to include any blanks in link names. For example, we prefer you to use [[Ants.ActiveTopics]] rather than [[Ants.Active Topics]].
  7. To have the link become part of the text, type: [[Link][Text you wish to see]] e.g. [[Main.HowToStart][Learn how to start working with the Wiki]], which will then appear like this: Learn how to start working with the Wiki

Attachments

It is possible to attach externally prepared documents to TRIN wiki topic pages. These might include MS Word documents, MS Excel spreadsheets, MS Powerpoint or similar presentations, images, video recordings, sound recordings, etc.
  • Select Attach from the range of options at the bottom of the topic page. A new control form will appear.
  • Select the Browse button to chose a file on you computer to be uploaded
  • Insert a descriptive comment
  • Select Upload file to upload the selected file to the wiki
  • The file will appear in the attachment table at the end of the topic page

Moving Attachment Files

An attachment can be moved between topics.
  • Open the Attachment table at the bottom of the topic page
  • Select Manage in the Action on the Attachment to be moved. A new control form will appear.
  • On the control screen, select the new web and/or topic.
  • Select Move. The attachment and its version history are moved. The original location is stored as topic Meta Data?.

Deleting Attachments

Move unwanted Attachments to web Trash, topic TrashAttachment.

Or:

  • Open the Attachment table at the bottom of the topic page
  • Select Manage in the Action on the Attachment to be moved. A new control form will appear.
  • On the control screen, select the new web and/or topic.
  • Select Delete.

Linking to Attached Files

  • Once a file is attached it can be referenced in the topic. For example to link to Sample.txt
    1. Edit topic and enter: http://trin.org.au/pub/Main/HowToStart/Sample.txt
    2. Preview: %ATTACHURL%/Sample.txt text appears as: http://trin.org.au/pub/Main/HowToStart/Sample.txt, a link to the text file.

  • To reference an attachment located in another topic. For example to link to Sample.txt
    • % <NOP> PUBURL%/Main/OtherTopic/Sample.txt (if it's within the same web)
    • % <NOP> PUBURL%/Otherweb/OtherTopic/Sample.txt (if it's in a different web)

  • The contents of HTML files and text files can be inserted in a topic. For example to include the text of Sample.txt
    1. Edit topic and write text: % <NOP> INCLUDE{"http://trin.org.au/pub/Main/HowToStart/Sample.txt"}%
      • Content of attached file is shown as << %<span class="WYSIWYG_TT">INCLUDE{"http://trin.org.au/pub/Main/HowToStart/Sample.txt"}% >>

  • GIF, JPG and PNG images can be attached can be shown embedded in a topic. for example Smile.gif
    1. Edit topic and write text: % <NOP> ATTACHURL%/Smile.gif
    2. Preview: text appears as Smile.gif, an image.

File Attachment Contents Table

Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click Attach.

*Attachment*Sort *Action* *Size* *Date* *Who* *Comment*
Sample.txt manage 0.1 K 22 Jul 2000 - 19:37 PeterThoeny Just a sample
Smile.gif manage 0.1 K 22 Jul 2000 - 19:38 PeterThoeny Smiley face

Topic page management

Wiki documents are arranged in linked pages or topics. Users can create new pages, edit and format existing pages, move pages and link to other pages.

Make a new topic page

  1. Use a camel-case Foswiki word to create a link to a non-existant page in the page you are editing e.g. [[NewSpecies]]. If this page does not exist, once you save the page, it will show with a question mark after the camel-case link name, as follows: NewSpecies?.
  2. Click on the question mark after the camel-case link name and the Foswiki software will open up a new page of that name in edit mode. Once you save, you have created your new page.

Renaming, moving or archiving a topic page

  • To rename a page or move it somewhere else, go to the bottom of the page in question (NOT in edit mode) and click on More topic actions. This will offer you options for renaming, moving, deleting the page, changing the parent pages etc.
  • When a page if moved, links to other pages and resources are updated automatically.
  • Old or obsolete pages are moved to trash automatically, so you don't lose them completely and can retrieve them if you have an accident.

Inserting images

You can embed images in pages on this Wiki:
  1. Ensure an image of appropriate dimension is available on your desktop or other local directory
    • The images can not be edited once uploaded to the wiki
    • Images bring their filenames with them, so change before upload if desired
  2. Upload and embed the image. There are two ways to do this:
    1. While editing the document
      • Click the 'Edit' button or link on the page you want to put the image into
      • Position the cursor in the place in the document where you wish the image to appear
      • Click the 'Attach' button (paper clip) on the editing toolbar; this will open a little dialog box
      • Choose the 'Upload Attachment' tab (the second one) in the dialog box
      • Find the image file to be uploaded using the 'Browse' button
      • Add a short descriptive comment
      • Click the 'Upload' Button
      • Close the dialog box then click on the paper clip 'Attach' button again
      • The name of the image should now appear in the 'Insert Image' dropdown list. Choose the image you want and click the 'Insert' button and Bob's your uncle.
    2. While not editing the document
      • Click on the Attach link at the very bottom of the page i.e. not in edit mode. A new 'Attach file' page will appear.
      • Find the image file to be uploaded using the 'Browse' button
      • Add a short descriptive comment
      • Selecting the 'Link' check box will embed/display the image on your page; if you don't do this, the selected the image file will only appear in the list of attachments displayed at the bottom of the page
      • Click 'Upload file' to complete the process and return you to the page where the newly attached image can be seen

Tables

If you must do a table, don't do it in WYSIWYG edit mode; it will drive you crazy. Simplest way to do a table is to do it in Foswiki markup mode.

  1. Hit the little pick-tool icon on the right hand of the bottom row on the editing toolbar and navigate to the place in your document where you want to put the table.
  2. If you already have the table in a Word document, what you need to do is to put a '|' character at the beginning of each row of the table, and one between each column, and one at the end, so each row looks like '|first col|second col|third col|'. You can probably do this with a macro, or in a programmable text editor like Programmers' File Editor (open source and excellent: http://www.lancs.ac.uk/staff/steveb/cpaap/pfe/pfefiles.htm).
  3. Paste it into the Wiki in Foswiki markup mode.
  4. Otherwise, type your columns in using the '|' delimiter fore and aft of each column in the table, ending each row with a double i.e. '||' and starting each new row on a new line.
  5. If you want to do formatting, like bold for the column headings, you can put the text inside '*' characters, e.g. ! Heading.
  6. There's an example here, if you want to see how it works in Twiki markup mode

[ Contributors: ; MargaretC; JimCroft; GarryJolleyRogers]