Help:Contents

From wiki.dca-project.eu
Jump to: navigation, search

Wiki quickstart guide

How to create a new page?

1) Enter the url of the non-existing page into your browser's address bar. You can use spaces in the title of a new page. These will automatically be replaced by underscores. Please note that the names of wiki pages are case sensitive. main page will not be the same as Main Page


caption


2) The page will only be created once you make your first edit. Click on create in the right corner to start editing your page.


caption


3) After entering some content you save the page.


caption


For more information on editing wiki pages see 2. How to edit a page.

4) You can reach your newly created page at the url you specified in 1).

How to edit a page?

1) Make sure you are logged in.

2) Go to the page you would like to edit.

3) Click on the edit tab.


caption


4) Type in your text and hit the Save page button.


caption


Pages are formatted using the wiki markup. By adding specific characters to your text you can change the formatting. For example to put a piece of text in bold just put it between 3 apostrophes: '''bold text'''.

The most used wiki markup code:


Description You type You get
Character (inline) formatting – applies anywhere
Italic text
''italic''

italic

Bold text
'''bold'''

bold

Bold and italic
'''''bold & italic'''''

bold & italic

Strike text
<strike> strike text </strike>
strike text
Escape wiki markup
<nowiki>no ''markup''</nowiki>

no ''markup''

Escape wiki markup once
[[API]]<nowiki/>extension

APIextension

Section formatting – only at the beginning of the line
Headings of different levels == Level 2 == === Level 3 === ==== Level 4 ==== ===== Level 5 ===== ====== Level 6 ======


Level 2


Level 3

Level 4

Level 5
Level 6
Horizontal rule
Text before
----
Text after

Text before


Text after

Bullet list
* Start each line
* with an [[Wikipedia:asterisk|asterisk]] (*).
** More asterisks give deeper
*** and deeper levels.
* Line breaks <br />don't break levels.
*** But jumping levels creates empty space.
Any other start ends the list.
  • Start each line
  • with an asterisk (*).
    • More asterisks give deeper
      • and deeper levels.
  • Line breaks
    don't break levels.
      • But jumping levels creates empty space.

Any other start ends the list.

Numbered list
# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
## More number signs give deeper
### and deeper
### levels.
# Line breaks <br />don't break levels.
### But jumping levels creates empty space.
# Blank lines

# end the list and start another.
Any other start also
ends the list.
  1. Start each line
  2. with a number sign (#).
    1. More number signs give deeper
      1. and deeper
      2. levels.
  3. Line breaks
    don't break levels.
      1. But jumping levels creates empty space.
  4. Blank lines
  1. end the list and start another.

Any other start also ends the list.

Definition list
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
item 1
definition 1
item 2
definition 2-1
definition 2-2
Indent text
: Single indent
:: Double indent
::::: Multiple indent

Single indent
Double indent
Multiple indent
Mixture of different types of list
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this looks like a continuation
#: and is often used
#: instead <br />of <nowiki><br /></nowiki>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2

  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this looks like a continuation
    and is often used
    instead
    of <br />
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2
Preformatted text
 Start each line with a space.
 Text is '''preformatted''' and
 ''markups'' '''''can''''' be done.

Start each line with a space.
Text is preformatted and
markups can be done.
Preformatted text blocks
 <nowiki>Start with a space in the first column,
(before the <nowiki>).

Then your block format will be
    maintained.
 
This is good for copying in code blocks:

def function():
    """documentation string"""

    if True:
        print True
    else:
        print False</nowiki>
Start with a space in the first column,
(before the <nowiki>).

Then your block format will be
    maintained.

This is good for copying in code blocks:

def function():
    """documentation string"""

    if True:
        print True
    else:
        print False

! You can't use the preformatted text options for importing the markup used in word text. For this see: How to import text from a word document


In addition some html-tags are allowed. For example <br/> to start a new line.

You don't have to remember all these codes but could simply use the editor's tool bar. By selectting a formatting option the markup code is automatically printed in the editor.

Table of contents

The wiki will automatically create a Table of contents.


caption


However if you do not want to display this table of contents you can remove it by adding __NOTOC__ somewhere in the page.


caption


Tables

Tables can be created by using wikicode or xhtml.

How to add white lines between paragraphs

MediaWiki ignores single line breaks.

However there are several ways to add a space between paragraphs.

1) You can simply add an extra white line in the editor between two paragraphs.


caption


2) or you could use the <br/> code. There is also a shortcut for this in the editor's toolbar.


caption

How to add a picture to a page?

Uploading a picture to the wiki is a two step process. You need to upload the image file first under special pages after which you can add the image to the page by using wiki markup.


Upload image

1) First go to Special:Upload or click on Upload file in the navigation bar on the left.


2) Select the file you would like to upload and press upload file.

caption


3) On the next page you will get the filename. This filename is needed to display the file on the page.


caption

Put picture in page

You can add the image on your page by using the following syntax: [[File:Wiki guide 1.png]]. This filename is found when uploading the image or in the image library.

You can also add a border : [[File:Wiki guide 1.png| border |caption]]

Or put the image in a frame: [[File:Wiki guide 1.png| frame |caption]]


How to create an internal link?

Internal links to wiki pages are created by putting the page name between a pair of square brackets ([[ ]]). Linking to the Main Page would be done by entering [[Main Page]].

You can change the display text by adding it after a pipe ("|") [[Main Page|main page of the dca wiki]]

How to create an external link?

Links to external pages or files are created by putting the page name between single square brackets ([ ]). Linking to www.google.com would be done by entering [http://www.google.be].

You can change the display text by adding it after a space [[http://dca-project.eu Website of the dca project]

How to add footnotes and references?

To add references you should put the contents of the notes between a ref-tag. For example <ref>This is reference 1</ref>. To display all the references enter <references /> in the text where you want them to show up.


caption


caption


To add footnotes follow the same procedure except add a group to the <ref>-tags and the <references>-tag. <ref group=note>Footnote 1</ref>. To display all the footnotes enter <references group="note"/>


caption


caption

How to get an email notification when a page has changed?

1) First you have to add the page to your watchlist. You can do this when editing a page or going to Special:Watchlist.


caption


caption


2) Then go to Special:Preferences and make sure you have selected watchlist notification if you want to receive an email when pages on your watchlist have been edited.


caption


How to import text from a word document?


1) Save your word document as a webpage


caption


Make sure the option 'Save entire file into html' is checked!

caption


2) You might have to change the character encoding of the file to UTF-8 (for OS X it is set to macintosh but the online html cleaner won't accept this encoding).

I am using TextWrangler for this.

a) Change it in the text

caption

b) save the file with the correct encoding

caption


3) Go to http://textism.com/wordcleaner/ and upload the utf-8 .htm-file you just created.

4) Copy this text and paste in into the wiki-editor. You'll have to remove some html tags which are not recognised by the wiki manually, such as the <a></a> tags.