[Wylug-help] WikiWikiWebs and unstructure workflow

[Anne Wilson]

--
On Monday 28 Jun 2004 15:15, Nigel Metheringham wrote:
>
> Thanks - would appreciate the file.
>
Sorry for the delay.  Rebuilding the box was no problem, but the filesystem
was badly mangled.  Getting a new disto up and running, retrieving data and
configuring everything necessary took a lot longer than expected.  Anyway,
file attached, and I hope it's helpful

Anne
--
Registered Linux User No.293302
Have you visited http://twiki.mdklinuxfaq.org yet?
--
Write a TWiki article mini HOW-TO

This is intended as a quick introduction to writing for our TWiki site.  There are links on WebHome to many useful pages for understanding TWiki, and in particular I recommend that you look at http://mandrake.vmlinuz.ca/bin/view/TWiki/TextFormattingFAQ.  However, it is often necessary to make a quick start, and study improvements later.  This guide attempts to fill that gap.

Hyperlinks in TWiki are formed from any word that contains more than one capital letter.  When you need to use such a word without making it a WikiWord, such as SoundBlaster it can be avoided - see formatting, below.

The easiest way entry you can make is by adding a section to an existing page.  You will need to register as a user to gain editing rights, but once this is done you simply hit Edit at the bottom of the page, and log in.

If you have already prepared your text in an editor you can paste it in, then turn your attention to correct formatting.  Many pages have a Table of Contents, to make navigation easier.  If you use headings in your formatting the entry will automatically be added to the TOC.

If no suitable page already exists, the easiest way to start a new one is to select a suitable existing page and create a WikiWord entry - maybe a phrase or sentence, depending on how the rest of the page functions, but containing the new WikiWord.  If this is a completely new section you may have to use your personal page as the place for a new entry, then ask an administrator to link it to the top level of the index.

If you type a WikiWord and a related page exists it will form a link to that page.  If no such WikiWord already exists you will see a question mark immediately after it.  Clicking on the entry starts a new page, where you can paste in your text.  If you have sub-headings, or if you expect others to add information, it would be helpful to add %TOC% as a first line.  When a TOC is created it automatically picks up all headings and adds them to the Index.

Formatting - common needs

General Display
   * Separate paragraphs with a blank line
   * To display bold type, put it in asterisks: =*bold type*=
   * To display italics, use underscores: <pre>_italic_</pre>
   * To display monospaced text, use = signs: <pre>=like this=</pre>
   * To display multilines of monospaced text, as in code samples, use <verbatim> as in:
   <verbatim>
   	unformatted text!
   </verbatim>
	NOTE that all formatting codes must be immediate to the words, not interrupted by spaces.

   * To create a horizontal rule, type three or more consecutive hyphens on the line:
   =---=
Bulleted lists
   * Create a bullet point by typing =[space][space][space][asterisk][space]=
   * Nest bullets by typing spaces in multiples of three, then asterisk and space
   * Create a numbered list by substituting [1] for [asterisk].  Other numbers will be automatically created

Linking

   * To make an internal link, use a WikiWord
   * To make an external link, use a full URL: http://twiki.org/
   * To include an image type its full URL
   * To attach an image (display a text link to it) type
   <verbatim>
   %ATTACHURL%/yourimagefilename.jpg
   </verbatim>
   * To avoid linking a word that looks like a WikiWord (eg. SoundBlaster), use <nop> immediately in front of the word.

Headings

Headings will be picked up and displayed in the TOC.  To add a TOC to a new page, place %TOC% at the top of the page.

Headings nest logically, using three hyphens and a number of pluses.
   =---+ Level 1 heading=
   =---++  Level 2 heading=
   =---+++  Level 3 heading=  etc.

If you need to exclude the heading from the list, use =!!=:
   =---+++!!text=
   Text following the =!!= will not be added.

When you have done all you think necessary, select Preview (bottom of the page) and read through what you have done.  To return and correct any mistakes, just use the browser's back button.

Finally, at the bottom of the page is your TWiki signature.  Copy it and paste it in place of the last editor (not the page creator, if one is at the extreme foot).

When you are totally satisfied, from the Preview page you select Save.  IF YOU FORGET THIS YOU WILL LOSE ALL YOUR WORK!  Saving also releases the edit lock, which is very important in a page where multiple contributors work.  If you do not want to save your changes, you can cancel, which will also release the lock.

If any part of this needs amplification, please contact the author AnneWilson
--