Difference between revisions of "Help:Editing"
(→Getting help) |
|||
(23 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
+ | =Official Guides= | ||
+ | * [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page Quick Guide] | ||
+ | * [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide WikiMedia User's Guide] | ||
+ | * [http://meta.wikimedia.org/wiki/Help:Editing MediaWiki editing help]. | ||
+ | |||
+ | =Word formatting= | ||
+ | ; Emphasize | ||
+ | <nowiki>''Emphasize'', '''strongly''', '''''very strongly'''''</nowiki> | ||
+ | ''Emphasize'', '''strongly''', '''''very strongly''''' | ||
+ | |||
+ | |||
+ | ; HTML tags you can use | ||
+ | |||
+ | Typewriter font for technical terms | ||
+ | <nowiki><tt>monospace text</tt></nowiki> | ||
+ | <tt>monospace text</tt> | ||
+ | |||
+ | |||
+ | Small text | ||
+ | <nowiki><small>small text</small></nowiki> | ||
+ | <small>small text</small> | ||
+ | |||
+ | |||
+ | Strikethru text | ||
+ | <nowiki><s>strike out deleted material</s></nowiki> | ||
+ | <s>strike out deleted material</s> | ||
+ | |||
+ | |||
+ | =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= | ||
+ | <nowiki>[[Main Page]]</nowiki> | ||
+ | Becomes a link to the [[Main Page]] of this Wiki. | ||
+ | |||
+ | |||
+ | <nowiki>[[MPC|Musepack]]</nowiki> | ||
+ | Becomes a link to the MPC page but Musepack is written instead like this: [[MPC|Musepack]] | ||
+ | |||
+ | |||
+ | A postfix added right after a normal internal link is added to the written word in the final document, but links to the page without the postfix. | ||
+ | <nowiki>[[Critical band]]s</nowiki> | ||
+ | Becomes: [[Critical band]]s | ||
+ | |||
+ | |||
+ | ; Linking to a headline at a wiki page. | ||
+ | You can link to a headline on another wiki page. | ||
+ | <nowiki>[[AAC#What's the best AAC encoder?]]</nowiki> | ||
+ | Becomes at link to the headline "What's the best AAC encoder?" at the AAC page like this: [[AAC#What's the best AAC encoder?]] | ||
+ | |||
+ | |||
+ | You can also replace the text written on the final page. | ||
+ | <nowiki>[[AAC#What's the best AAC encoder?|Read about the best AAC encoder]]</nowiki> | ||
+ | Becomes: [[AAC#What's the best AAC encoder?|Read about the best AAC encoder]] | ||
+ | |||
+ | |||
+ | =External linking= | ||
+ | Remember to start with "<nowiki>http://</nowiki>". | ||
+ | |||
+ | |||
+ | ; Bare URL | ||
+ | <nowiki>http://www.rarewares.org/</nowiki> | ||
+ | Becomes http://www.rarewares.org/ | ||
+ | |||
+ | |||
+ | ; Named link | ||
+ | <nowiki>[http://www.rarewares.org/ The best audio resource on the net]</nowiki> | ||
+ | Becomes [http://www.rarewares.org/ The best audio resource on the net] | ||
+ | |||
+ | |||
+ | =Lists= | ||
+ | |||
+ | ==Bullet lists== | ||
+ | You can make bullet lists with "*". | ||
+ | <nowiki>* First level list object</nowiki> | ||
+ | <nowiki>** Second level list object</nowiki> | ||
+ | <nowiki>*** Third level list object</nowiki> | ||
+ | <nowiki>* Another first level list object</nowiki> | ||
+ | |||
+ | * 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 "#". | ||
+ | <nowiki># First level list object</nowiki> | ||
+ | <nowiki>## Second level list object</nowiki> | ||
+ | <nowiki>### Third level list object</nowiki> | ||
+ | <nowiki># Another first level list object</nowiki> | ||
+ | |||
+ | # First level list object | ||
+ | ## Second level list object | ||
+ | ### Third level list object | ||
+ | # 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 | ||
+ | *# 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: | ||
+ | <nowiki>[[Image:filename|options|caption text]]</nowiki> | ||
+ | The last item added will always be considered the caption text. | ||
+ | |||
+ | |||
+ | ==Stand alone image== | ||
+ | <nowiki>[[Image:Small_HA_logo.png]]</nowiki> | ||
+ | [[Image:Small_HA_logo.png]] | ||
+ | |||
+ | |||
+ | ==Stand alone 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. | ||
+ | <nowiki>[[Image:Small_HA_logo.png|The HA logo]]</nowiki> | ||
+ | [[Image:Small_HA_logo.png|The HA logo]] | ||
+ | |||
+ | |||
+ | ==Image options== | ||
+ | |||
+ | [[Image:Small_HA_logo.png|thumb|The HA 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): | ||
+ | <nowiki>[[Image:Small_HA_logo.png|thumb|The HA logo]]</nowiki> | ||
+ | |||
+ | |||
+ | ; 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. | ||
+ | |||
+ | |||
+ | [[Image:Small_HA_logo.png|frame|The HA 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: | ||
+ | |||
+ | |||
+ | ; ''size''px | ||
+ | : 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): | ||
+ | <nowiki>[[Image:Small_HA_logo.png|50px|left|none|The HA logo]]</nowiki> | ||
+ | [[Image:Small_HA_logo.png|50px|left|none|The HA logo]] | ||
+ | |||
+ | |||
+ | <nowiki>[[Image:Small_HA_logo.png|none|frame|The HA logo]]</nowiki> | ||
+ | [[Image:Small_HA_logo.png|none|frame|The HA logo]] | ||
+ | |||
+ | |||
+ | =Tables= | ||
+ | <nowiki>{| border="1" cellpadding="5" cellspacing="3"</nowiki> | ||
+ | <nowiki>| 1 || 2</nowiki> | ||
+ | <nowiki>|-</nowiki> | ||
+ | <nowiki>| 3 || 4</nowiki> | ||
+ | <nowiki>|-</nowiki> | ||
+ | <nowiki>| 5 || 6</nowiki> | ||
+ | <nowiki>|}</nowiki> | ||
+ | {| border="1" cellpadding="5" cellspacing="3" | ||
+ | | 1 || 2 | ||
+ | |- | ||
+ | | 3 || 4 | ||
+ | |- | ||
+ | | 5 || 6 | ||
+ | |} | ||
+ | |||
+ | See also [http://meta.wikimedia.org/wiki/Help:Table WikiMedia table guide] | ||
+ | |||
+ | |||
+ | =Additional hints= | ||
+ | You can avoid that the wiki system proccessing the text (to avoid unwanted formatting) by putting <nowiki><nowiki></nowiki></nowiki> around the text you want to parse directly. | ||
+ | |||
+ | |||
+ | =Getting help= | ||
+ | If you need help to work with the wiki you can do the following: | ||
+ | * Post at http://www.hydrogenaudio.org in the [http://www.hydrogenaudio.org/forums/index.php?showforum=36 Wiki Forum] |
Latest revision as of 20:25, 13 March 2017
Contents
Official Guides
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
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.
[[MPC|Musepack]]
Becomes a link to the MPC page but Musepack is written instead like this: Musepack
A postfix added right after a normal internal link is added to the written word in the final document, but links to the page without the postfix.
[[Critical band]]s
Becomes: Critical bands
- Linking to a headline at a wiki page.
You can link to a headline on another wiki page.
[[AAC#What's the best AAC encoder?]]
Becomes at link to the headline "What's the best AAC encoder?" at the AAC page like this: AAC#What's the best AAC encoder?
You can also replace the text written on the final page.
[[AAC#What's the best AAC encoder?|Read about the best AAC encoder]]
Becomes: Read about the best AAC encoder
External linking
Remember to start with "http://".
- Bare URL
http://www.rarewares.org/
Becomes http://www.rarewares.org/
- Named link
[http://www.rarewares.org/ The best audio resource on the net]
Becomes The best audio resource on the net
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
- Second 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
- First level list object
- Second level list object
- Third level list object
- Second level list object
- 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
- and nest them
- like this
- and nest them
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.
Stand alone image
[[Image:Small_HA_logo.png]]
Stand alone 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:Small_HA_logo.png|The HA logo]]
Image options
- 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:Small_HA_logo.png|thumb|The HA 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.
- 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:Small_HA_logo.png|50px|left|none|The HA logo]]
[[Image:Small_HA_logo.png|none|frame|The HA 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
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.
Getting help
If you need help to work with the wiki you can do the following:
- Post at http://www.hydrogenaudio.org in the Wiki Forum