Difference between revisions of "Help:Authoring"

From 3kWiki
Jump to navigation Jump to search
imported>Shadowspawn
imported>Shadowspawn
(No difference)

Revision as of 06:27, 10 April 2009

3KWiki Specific help

A quick walkthrough of using the templates on our pages can be found here.

General Wiki editing is covered below. Enjoy yourself, and thanks for helping someone else's time on 3K more enjoyable.

Converters

Converting documents from Word,Excel,HTML,etc to wiki format

Categories

Please use appropriate category tags to tag your pages. Simply include something like the following to your page.

[[Category:XYZCategory]]

Ultra Short Wiki Tutorial

For the more technically inclined, you may find the ultra short wiki tutorial a good overview.

Headings

same as headlines/chapters/sections

First, second and third level headings

=New section=

==Subsection==

===Sub-subsection===

A first level heading is for example the "Word formatting" heading on this page. The "Bullet lists" heading on this page is an example of a 2rd level heading.

The "Table of contents" box you see at the top of this page will appear automatically when you have used 4 or more headings. First level headings are shown as x, 2rd level as x.x and so on.


Internal linking

[[Main Page]]

Becomes a link to the Main Page of this Wiki.


[[Information|Infos!]]

Becomes a link to the Information page but Infos! is written instead like this: Infos!


Word formatting

Emphasize
''Emphasize'', '''strongly''', '''''very strongly'''''

Emphasize, strongly, very strongly


HTML tags you can use

Typewriter font for technical terms

<tt>monospace text</tt>

monospace text


Small text

<small>small text</small>

small text


Strikethru text

<s>strike out deleted material</s>

strike out deleted material

External linking

Remember to start with "http://".


Bare URL
http://www.3k.org/

Becomes http://www.3k.org/


Named link
[http://www.3k.org/ 3k Mud]

Becomes 3k Mud

Lists

Bullet lists

You can make bullet lists with "*".

* First level list object
** Second level list object
*** Third level list object
* Another first level list object
  • First level list object
    • Second level list object
      • Third level list object
  • Another first level list object


Numbered lists

You can make numbered lists with "#".

# First level list object
## Second level list object
### Third level list object
# Another first level list object
  1. First level list object
    1. Second level list object
      1. Third level list object
  2. Another first level list object


Mixed lists

You can even make mixed lists like this.

* You can even do mixed lists
*# and nest them
*#* like this
  • You can even do mixed lists
    1. and nest them
      • like this


Definition lists

;item
: the item's definition
item
the item's definition


Images

You can insert images using the syntax:

[[Image:filename|options|caption text]]

The last item added will always be considered the caption text.


Image without alt-text

[[Image:mediawiki.png]]

File:Mediawiki.png


Image with alt-text

You add "|caption text" after the image link. This is the text most browsers will show when you hover over the image with the mouse.

[[Image:mediawiki.png|The MediaWiki logo]]

The MediaWiki logo

Image options

File:Mediawiki.png
The MediaWiki logo
thumbnail, thumb
Generates an automatically resized thumbnail image (either reduced or enlarged).
Caption text is displayed directly underneath. An "enlarge"-icon is added.
If you do not specify where the image should be place it will be places to the right.
Example to the right (in this example the image is enlarged because it is small):
[[Image:mediawiki.png|thumb|The MediaWiki logo]]


right
Makes the image right-aligned.


left
Same as above, but left aligned.


center
Same as above, but centered.


none
The image will be rendered inline, even if the thumbnail-option is set.


File:Mediawiki.png
The MediaWiki logo
frame
The image will have a frame, regardless of whether it is a thumb, and the caption text will be included as a visible caption.
Example to the right:


sizepx
Renders a version of the image that's [size] pixels wide (e.g. '150px').
Height is computed to keep the aspect ratio (i.e. the shape of the image).
This allows both size reduction and enlargement.


Combining options
You can combine the options as you like. Example (as you see below resizing is often not very good):
[[Image:mediawiki.png|50px|left|none|The MediaWiki logo]]


[[Image:mediawiki.png|none|frame|The MediaWiki logo]]
File:Mediawiki.png
The MediaWiki logo

Tables

{| border="1" cellpadding="5" cellspacing="3"
| 1 || 2
|-
| 3 || 4
|-
| 5 || 6
|}
1 2
3 4
5 6

See also WikiMedia table guide

Our sortable tables have some custom javascript to specify which column is initially sorted. Set "id=" in the table open row to the number of the column you want sorted; the first column is 0.

{| border="1" cellpadding="5" cellspacing="3" class="sortable" id="1"
!First!!Second!!Third
 |-
 | 1 || 2 || 7
 |- 
 | 3 || 4 || 8
 |- 
 | 5 || 6 || 9
 |}
First Second Third
1 2 7
3 4 8
5 6 9


Here is a walkthrough of adding to our automatically generated tables

Additional hints

You can avoid that the wiki system proccessing the text (to avoid unwanted formatting) by putting <nowiki></nowiki> around the text you want to parse directly.

Official Guides