Help:Editing

From Testiwiki
Revision as of 10:51, 5 March 2008 by Erkki Kuusisto (talk | contribs) (indentations added to quick edit table)
Jump to: navigation, search

Editing help:

Description What you type What you get
applies everywhere
Italic ''italic text'' italic text
Bold '''bold text''' bold text
Bold & italic '''''bold & italic text''''' bold & italic text
Line break

Line 1

Line 2

Textline 1
<BR><BR>
Textline 2

Line 1
Line 2

Textline 1

Textline 2

applies only in the beginning of new lines
Different level

headings

Notice! Level 1 is preserved for article title
==Level 1==
===Level 2===
====Level 3====
=====Level 4=====

Level 1

Level 2

Level 3

Level 4
Horizontal rule

----


Bullet list

* one
* two
* three

  • one
  • two
  • three
Numbered list

# one
# two
# three

  1. one
  2. two
  3. three
Indentations

Normal text
: one indentation
: : two indentations
: : : three indentations

Normal text

one indentation
two indentations
three indentations
Definition list

;Definition
:item 1
:item 2

Definition
item 1
item 2
Preformatted text

  a space at the
  beginning of the line
  creates
  preformatted text

a space at the 
beginning of the line
creates
preformatted text



Introduction

This is a user's guide for Intarese MediaWiki-pages. User's guide contains briefly basic information about using MediaWiki.

Feel free to test your skills in sandbox -page.

Remember! You cannot cause any permanent damage to articles because everything can be retrieved. So have fun editing and creating!


Creating an account and logging in

It is recommended that you create an account before making any editing to MediaWiki-pages. This makes easier for others to see who is the creator or the editor of MediaWiki-pages. Please note, that you can read, edit and create wikipages without creating an account or logging in.

You can create an account by clicking login or create an account on the upper right corner. From there you can choose your User name and password. It is recommended to use your own name in the username (for example first name).


For more information about logging in and user accounts please see [1].


Editing

Starting a new page

There are few different ways to create new articles in MediaWiki.

Creating a new article through URL-method

Easy way to create a new article is to type the name of the article to addresbar (URL) after index.php?title=
For example index.php?title=Name of your new article

Creating a new article through search-box-method

One method is to type the name of the article to search -box on the left and click Go-button. From there you can simply click the text which says this exact title and the editing window opens.

Creating a new article through link-method

Other way to create a new article is to make a link from existing page to a new article. For example name of the new article, code: [[name of the new article]]. When you click this link it opens a new edit window for article named name of the new article. More information about linking later in the linking -section.


For more information about starting a new page please see [2].


Naming a new article

You can name your articles quite freely. There are few basic guidelines which are good to keep in mind while naming articles:

  • Use descriptive names
  • Names can consist of several words
  • Numbers and spaces are allowed
  • Do not use special characters like # < > [ ] | { }
  • Names are case-sensitive
    • mediaWiki is same as MediaWiki but not same as mediawiki
    • Capitalization matters after the first letter but not in the first letter


For more information about naming please see [3].


Editing basics

Start editing

To start editing simply click the edit-link on the upside of the page. This opens edit-page.

Type your text

In the edit-page you can just type your text. It is also possible to copy-paste text from another source (for example Word) directly to WikiPage.

Save your text

Click save-page to save your text. It is a good idea to click show preview before saving your work.


For more information about editing basics please see [4]


Text formatting

New lines

To start a new line you need to press enter twice. It is also possible to use html command <BR> to start a new line.

Italic -text

What you type: You can ''italicize text'' by putting 2 apostrophes on each side.

What you get: You can italicize text by putting 2 apostrophes on each side.

Bold -text

What you type: 3 apostrophes will '''bold the text'''.

What you get: 3 apostrophes will bold the text.

Bold & italic -text

What you type: 5 apostrophes will '''''bold & italicize the text'''''

What you get: 5 apostrophes will bold & italicize the text

Centered text

You can center text placing it between <center> and </center>.

This is centered text

Example code:

<center> This is centered text </center>

Superscripts and subscripts

Superscripts are done placing text between <sup> and </sup>. Subscripts are done placing text between <sub> and </sub>.

X2 and H2O

Example code:

X<sup>2</sup> and H<sub>2</sub>O

Indentation

You can indent lines with :(colon). More colons mean deeper indentation.

One level indentation
Two level indentation
And so on

Example code:

: One level indentation
:: Two level indentation
::: And so on


Lists

Basic lists

Lists are done with *(star) -signs in MediaWiki. Just put * at the beginning of the new line. More stars mean deeper levels.

  • 1 star
    • 2 stars
      • 3 stars

Example code:

* 1 star
** 2 stars
*** 3 stars


Numbered lists

Numbered lists are done with # -signs. Just put one # -sign at the beginning of the everyline you want to be included in your numbered list. Numbers are generated automatically.

  1. This is list item number 1
  2. This is obviously list item number 2

Example code:

# This is list item number 1
# This is obviously list item number 2


You can also use different depths of numbered lines. For example:

  1. First level
    1. Second level
    2. Second level
      1. Third level
  2. Quite easy?

Example code:

# First level
## Second level
## Second level
### Third level
# Quite easy?


Definition lists

Definition lists can be used for defining a word or a phrase for example. Colons (:) and semicolons (;) are used to create a definition list. See example:

Word or a phrase
and the definition
you can also add more than one definitions

Example code:

;Word or a phrase: and the definition
: you can also add more than one definitions


Mixed lists

It is possible to combine different lists (numbered and basic lists for example).

  1. Numbered list
    • option 1
    • option 2
  2. Second item in numbered list
    • Word
      and its definition

Example code:

# Numbered list
#* option 1
#* option 2
# Second item in numbered list
#*;Word: and its definition


Sections

Creating sections is done with = -signs in MediaWiki.


Example code:

== 1 Section ==
=== 1.1 Subsection ===
==== 1.1.1 Sub-subsection ====

So you just type your section name between = -signs. Number of = -signs defines the type of the section. Please note that the section numbers are not shown expect in the table of context. If you'd like to see sections numbers in the text you'll need to change your user preferences.

For more information about creating sections please see [5].


Tables

Standard Wiki-tables

You can create tables in MediaWiki with standard HTML-code or you can use special wikicode. Latter method is descripted here. If you are interested in HTML -table syntax you can learn it from here.

There is basic example of a WikiTable:

The table's caption
Column heading 1 Column heading 2 Column heading 3
Row heading 1 Cell 2 Cell 3
Row heading A Cell B Cell C


Example code:

{| border="1"
|+ The table's caption
! Column heading 1 !! Column heading 2 !! Column heading 3
|-
! Row heading 1
| Cell 2 || Cell 3
|-
! Row heading A
|Cell B
|Cell C
|}


  • Table code is encased with curly brackets and a pipe {| table code here |}.
  • Border is optional (bigger the number, thicker the border)
  • Table's caption is optional
  • First column heading is marked with single ! and next column headings are separated with double !!
  • Rows are separated with |-
  • Single ! marks row headings
  • Cells within the same row are separated with || or with a new line and a single bar |


For more information about creating tables, please see [6].

Converting tables from Excel or Word

Easiest way to convert tables from Excel or Word -files is to use converter which can be found from Navigation -bar on the left: Excel to WIKI.

Instructions:

  1. select table you want to import to MediaWiki
  2. copy table (CTRL+c)
  3. paste table to converter (CTRL+v)
  4. press Convert to MediaWiki -button
  5. select output text
  6. copy output text
  7. paste copied text to your article!


Table of contents

MediaWiki creates automatically table of contents if there is more than 3 headings (sections) in the article.

For more information about table of contents please see [7]


Linking

Links to articles in the same MediaWiki-project

Links to articles within the same MediaWiki-projects are done typing [[Name of the article]].

For example a link to Agriculture-article


Links to articles in different MediaWiki-projects

It is possible to link articles between different MediaWikis easily without typing the whole URL. Following Wiki-projects are so far included:

  • pyrkilo
  • beneris
  • erac
  • intarese
  • heande
  • tyjak
  • piltti

A link to article in different project is created by typing [[project name: article name]].
For example a link to pyrkilo-project article named Mental models in food risks is typed: [[pyrkilo: Mental models in food risks]].
It shows: pyrkilo: Mental models in food risks. It is also possible to use piped links to name links differently.


Links to other sections

You can make a link to another section in the same project typing [[Name of article#Name of section]]. For example Agriculture#Description_of_work

For more information about links please see [8].


Piped links

Piped links can be used to name links differently than the name of the page that it links. In piped links a | -sign is used for separating the real article name from custom label. For example a piped link to article named Agriculture [[Agriculture| Piped link to Agriculture]] . Shows Piped link to Agriculture instead of just Agriculture.

For more information about piped links please see [9]


External links

External links are links that point outside MediaWiki-project.
You can easily create links to another internet-locations simply typing the address: for example http://www.ktl.fi <- please note that you don't necessarily need brackets in external links.

If you type [http://www.ktl.fi] the link address is not shown. For example [10]

You can name the link by typing [http://www.ktl.fi Name of the link] . For example KTL homepage.

Note that you do not have to use | -sign to separate link from the link name.

For more information about external links please see [11]


Using Images and Files

Before images and other files can be used they need to be uploaded into MediaWiki system.


Uploading

You need to be logged in before you can upload files. Uploading is done through Upload file -link which is in the toolbox -menu.

In Upload file -page you will see a browse -button. You can use button to select a file from your computer. You can name your file in Destination filename box (default is the original name). It is recommended to use quite short and descriptive file names because that way they are easier to use. You can also add some information about uploaded file to Summary -box.

For more information about uploading please see [12].


Supported file -types

So far our MediaWiki-projects supports following filetypes:

  • ana (Analytica)
  • ppt (Microsoft PowerPoint)
  • pps (Powerpoint Show)
  • xls (Microsoft Excel)
  • pdf (Adobe)
  • doc (Microsoft Word)
  • bmp (Bitmap -pictures)
  • tif (Tagged Image File -pictures)
  • png (Portable Network Graphics -pictures)
  • gif (Graphics Interchange Format -pictures)
  • jpg & jpeg (Stands for Joint Photographic Experts Group -pictures)
  • ogg (Audio -files)

You cannot upload files that are different types as mentioned above.


Adding images to articles

Images are added to articles using [[Image:name of your picture]] -code. Remember that pictures have to be uploaded before they can be used.

There's a example where name of the picture is picture.GIF:

File:Picture.GIF


Example code:

[[Image:picture.GIF]]


Adding other files to articles

Other files than images can be attached to articles using [[Media:filename]] -code.

Examples:

This is a link to Media:Ytos28_6.pdf. It is also possible use piped links like this. You can add xls -files or any other supported filetypes as well Media:Testixls.xls.


Example code:

This is a link to [[Media:Ytos28_6.pdf]]. It is also possible use piped links like [[Media:Ytos28_6.pdf|this]]. 
You can add xls -files or any other supported filetypes as well [[Media:Testixls.xls]].

Simple reference list

In case you should want to add references to your pages, you need a little bit of code to help you along. Basically you can cite your reference however you want, but the most straightforward way is probably by using superscript numbers that refer to a set of footnotes.

You go about this by adding your reference in the text in between the markers <ref> and </ref>. The text in between these "ref" markers can take any form you like, including hyperlinks to external web sources, or just plain text etc.

At the very bottom of the document you then add in the title ==References== and the marker <references />. When you save the page, you see your reference in the text appear only as a superscript number, and your reference list is automatically populated with the text added between the "ref" markers. This all sounds much worse than it is in practice!

Example

Enter the references between the <ref></ref> markers at the appropriate point in your text:

     The quick brown fox jumped over the lazy dog.<ref>Smith, J. 1998. Foxes are faster than dogs. Journal of 
animal research. 30:19-20</ref> The lazy brown fox jumped over the quick dog.<ref>Jones, S. 1999.
Dogs are faster than foxes. Journal of advanced animal research. 31:20-21</ref>

The quick brown fox jumped over the lazy dog.[1] The lazy brown fox jumped over the quick dog.[2]

References

Adding the <references/> marker then generates the following list automatically from all the references inserted in this document up to that point:

  1. Smith, J. 1998. Foxes are faster than dogs. Journal of animal research. 30:19-20
  2. Jones, S. 1999. Dogs are faster than foxes. Journal of advanced animal research. 31:20-21

Adding hyperlinks to your references

Often when citing a journal it may be desirable to include a hyperlink to a specific article online. This is easy in Mediawiki referencing, since all the usual Mediawiki markup codes apply within the <ref></ref> markers. If you wanted to link to a specific article online, simply insert the web address as the first item in square brackets, in between the reference markers as follows:

     The INTARESE Consortium comprises of 33 partners from many of the leading research
and user organisations in Europe.<ref>[http://www.intarese.org/ INTARESE website, accessed 27/09/2007]</ref>

Note the space between the website address and the text you would like to be displayed in the references list.

In context, the footnote appears thus:

The INTARESE Consortium comprises of 33 partners from many of the leading research and user organisations in Europe.[1]

...And the new references list will look like this

More complicated reference lists

More extensive options relating to reference lists can be found at this link in Wikipedia help

Useful links to Wikipedia help pages