User Tools

Site Tools


en:club:kurzanleitung_zur_pflege_des_club-wikis

Quick guide to maintaining the Club Wiki

Further information on wiki formatting can be found at DokuWiki syntax

Our wiki depends on the cooperation of all club members!

Everybody is invited to contribute his knowledge! - And I'm quite sure that each of us knows something that somebody else can use sometime ;-)

But to avoid an unmanageable proliferation we should consider a few things.

  • The Wiki Framework offers an incredible amount of formatting possibilities. We should use as little of them as possible!
  • Individual pages should also deal with individual topics. Please do not mix the topics within a page!
  • Topics that fit into multiple categories should only be written once. All pages can be linked multiple times.

General

All pages you see in the Wiki can be changed, added, edited.

If you find an error somewhere, if you can/would like to describe a point better/precisely or if you want to describe a new topic, then you can simply switch to edit mode (button at the edge of each page).

In edit mode you will see the text of the page with all formatting information and can make changes.

The edit mode has some buttons at the top of the page to format the text and insert links. These functions are described below.

If you are unsure, or just want to try something, you can also try it on the test page.

Important to keep structure in the wiki is the following:

New, self-contained topics should also be described on new pages! Please do not mix different topics on one page! If we 'keep order' here, the topics can be reused in other places.

For example, the page 'Correctly making crimped cable connections' could be linked to the pages 'Electrics / Electronics' and 'Lighting'. If the topic is somewhere in the page 'Electrics / Electronics', it is lost for the page 'Lighting' or has to be added there again.

It would also be nice if all pages had a uniform (or at least similar) structure:

  1. General text (if necessary with external and internal links)
  2. Links to further internal pages (details on the superordinate topic)
  3. Links to Internet resources on the subject
  4. File links

The page Rover-Motor could serve as an example

Create new pages

The easiest way to create new pages is to first create an internal link to the new (not yet existing) page.

This sounds a bit strange, but it is actually the easiest way ;-)

So:

  1. Switch to the page from which you want to jump to the new page (possibly the main page)
  2. Switch to edit mode
  3. Move the cursor to the place in the text where you want to insert the new link
  4. Press the 'Internal Link' pushbutton
  5. Enter the name of the new page instead of the “link text
  6. Press the 'Save page' button (at the bottom of the editing window)
  7. DONE

You have now created a link to a not yet existing page. The link should now appear red in the original page.

If the link is displayed in blue, then there is already a page with the name you have chosen!

And exactly here it becomes clear what to consider with the page names:

The wiki framework identifies the new page by the text you enter as name! So please be as accurate as possible when naming new pages e.g: “Ford T9 transmission to Rover K-Series engine” and not just “transmission to engine”. This way another user has the chance to create the page “Caterham 6-Speed Transmission to Ford Kent Motor” without getting wrong links.

If the link creation worked (red) you can simply click on the new link and fill the new page with content.

Normal text

You can simply write normal text on the page.

But please note the following:

  • Simple line breaks (Enter key) are ignored by Wiki.
  • If you want to have a line break in your text, you have to insert a blank line (two times Enter key).
  • If you really want one empty line in your text (new paragraph) you have to insert two empty lines (three times Enter key).

Formatting of text

For our 'small Wiki' a few formatting options should be sufficient.

Bold print

The easiest way to print in bold is to highlight the text and press the “Bold Text” key. In the written text bold passages are shown in two stars (**).

What you write How it is presented to the reader
this text is **partly bold** printed this text is partly bold printed

Italic print

Italics can be printed most easily by marking the text and pressing the ”italic text“ key. In the written text, passages in italics are represented by two slashes (//).

What you write How it is presented to the reader
this text is //partly italic// printed this text is partly italic printed

Enumeration

Hierarchical enumerations can be made by using the asterisk (*) at the beginning of the line.<br/> Deeper levels of the enumeration can be realized by several stars (, *).

What you write How it is presented to the reader

* One

  • Two
    • Two-One
    • Two-Two
      • Two-Two-One
  • Three |

Numbering

Numbering can be done by using the 'hash' (#) at the beginning of the line.<br/> Deeper levels of numbering can be realized by several rhombuses (##, ###).<br/> Please DO NOT include numbering in the names of pages (because of the reuse mentioned above).<br/>

What you write How it is presented to the reader

# One<br/> # Two<br/> ## Two-One<br/> ## Two-Two<br/> ### Two-Two-One<br/> # Three<br/> </html>

- One

  1. Two
    1. Two-One
    2. Two-Two
      1. Two-Two-One
  2. Three

|

Insert pictures

Inserting images into the text is done in a similar way to creating new pages.

  1. if necessary, switch to the page in which the image should be inserted
  2. Switch to edit mode if necessary
  3. Move the cursor to the position in the text where the image is to be inserted
  4. Press button 'File link' –> Wiki inserts a link to the file 'Example.jpg' "[[File:Example.jpg]]"
  5. Replace the text “Example.jpg” with the real future file name.
  6. After saving the page, the text contains a (red) placeholder for the image
  7. Click the placeholder and upload the file
  8. DONE

Insert links

Different types of links can be used. For each type there is a corresponding pushbutton in editing.

Internal links refer to other pages of our Wiki.

By pressing the 'Internal Link' button, Wiki inserts a four square brackets and the text “Link Text” into the page.<br/> The text “Link text” must be replaced with the name of a Wiki page.

What you write How it is presented to the reader
the text [[weber double carburettor]] is a wiki-internal link the text weber_double carburettor is a wiki-internal link

Internal links are displayed red if the linked page does not yet exist.

External links refer to (foreign) Internet pages.

By pressing the 'External link' button, Wiki inserts two square brackets and the text "http://www.example.com Link text" into the page. The text "http://www.example.com" must be replaced by the path of the Internet page.<br/> The text “Link text” should be replaced by a meaningful name.

What you write How it is presented to the reader
What you write How it is presented to the reader
[[http://wiki.caterhamcar.club/images/Servicehefte/Lotus_7_assembly_guide.pdf|Caterham Seven 1600 BDR 1986(English)] [[http://wiki.caterhamcar.club/images/Servicehefte/Lotus_7_assembly_guide.pdf

In the description of file links, the language of the file should be specified (if possible)

If there is anything missing or if you have any questions, just get in touch with me (mailto:webmaster@caterhamcar.club)!

Otherwise: Have fun with it and … be brave!

en/club/kurzanleitung_zur_pflege_des_club-wikis.txt · Last modified: 2020/04/01 17:08 by Andreas_Seydell