Difference between revisions of "VideoLAN Wiki:Syntax"
Jump to navigation
Jump to search
(More editing, noted on the page this guide is still being written) |
(Layout-edit) |
||
| Line 1: | Line 1: | ||
| + | ''Note: You can practice editing at the [[Sandbox|Sandbox page]] whenever you like.'' | ||
| + | |||
'''<big>This guide is still in the process of being written</big>'''<br> | '''<big>This guide is still in the process of being written</big>'''<br> | ||
<br> | <br> | ||
| Line 5: | Line 7: | ||
== The basics == | == The basics == | ||
| − | This wiki uses the same general syntax as Wikipedia, because both use MediaWiki markup | + | This wiki uses the same general syntax as Wikipedia, because both use MediaWiki markup.<br> |
| − | + | This wiki does <u>not</u> support the VisualEditor extension that [//en.wikipedia.org/wiki/Help:VisualEditor Wikipedia does]. | |
| − | Familiarising yourself with [//en.wikipedia.org/wiki/ | + | Familiarising yourself with wikimarkup is probably a good idea, and the convenient one-page summary of wiki syntax is provided at the English Wikipedia [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet here]. The basics of it can be learned within minutes, and the Edit Toolbar includes a "Help" section that will refresh your memory if you forget. |
| − | === | + | == VideoLAN wiki syntax == |
| − | + | TODO | |
| + | |||
| + | == Best practices == | ||
| + | TODO | ||
| − | + | === Lists === | |
* To make a bulleted list, begin lines with asterisks <code>*</code> | * To make a bulleted list, begin lines with asterisks <code>*</code> | ||
* To make a numbered list, begin lines with pound signs <code>#</code> (which will be automatically re-numbered if you add or remove items—this is generally smart for long or frequently-changing lists). | * To make a numbered list, begin lines with pound signs <code>#</code> (which will be automatically re-numbered if you add or remove items—this is generally smart for long or frequently-changing lists). | ||
| − | + | === Linking === | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* The formula for creating an internal link is <nowiki>[[target page]]</nowiki> or <nowiki>[[target page|text to display]]</nowiki> | * The formula for creating an internal link is <nowiki>[[target page]]</nowiki> or <nowiki>[[target page|text to display]]</nowiki> | ||
** <nowiki>[[VLC]]</nowiki> gives [[VLC]] | ** <nowiki>[[VLC]]</nowiki> gives [[VLC]] | ||
| Line 34: | Line 34: | ||
* to link to a Wikipedia article on "example", use <nowiki>[[Wikipedia:example]]</nowiki> | * to link to a Wikipedia article on "example", use <nowiki>[[Wikipedia:example]]</nowiki> | ||
| − | + | == Editing tips == | |
* Use the editing toolbar to help you; it provides buttons to help you out. | * Use the editing toolbar to help you; it provides buttons to help you out. | ||
* Keep things simple, and don't be afraid to make mistakes. | * Keep things simple, and don't be afraid to make mistakes. | ||
| − | |||
* Adding a line after a sentence <u>will not</u> make the next bit appear on a new line: for the convenience of coders, it will appear on the ''same line''. To get it on a different line, either use <code><nowiki><br></nowiki></code> or two lines. | * Adding a line after a sentence <u>will not</u> make the next bit appear on a new line: for the convenience of coders, it will appear on the ''same line''. To get it on a different line, either use <code><nowiki><br></nowiki></code> or two lines. | ||
| − | == | + | == Links == |
| − | * [// | + | * [https://www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide] |
== Templates == | == Templates == | ||
Revision as of 03:57, 26 October 2014
Note: You can practice editing at the Sandbox page whenever you like.
This guide is still in the process of being written
Please follow these guidelines when editing this wiki.
There will be more guidelines later.
Contents
The basics
This wiki uses the same general syntax as Wikipedia, because both use MediaWiki markup.
This wiki does not support the VisualEditor extension that Wikipedia does.
Familiarising yourself with wikimarkup is probably a good idea, and the convenient one-page summary of wiki syntax is provided at the English Wikipedia here. The basics of it can be learned within minutes, and the Edit Toolbar includes a "Help" section that will refresh your memory if you forget.
VideoLAN wiki syntax
TODO
Best practices
TODO
Lists
- To make a bulleted list, begin lines with asterisks
* - To make a numbered list, begin lines with pound signs
#(which will be automatically re-numbered if you add or remove items—this is generally smart for long or frequently-changing lists).
Linking
- The formula for creating an internal link is [[target page]] or [[target page|text to display]]
- [[VLC]] gives VLC
- [[VLC|this totally awesome media player]] gives this totally awesome media player
- There are several ways to create external links: a simple outgoing link, a shortened link, or a shortened link with alternate text:
- http://example.com/ gives http://example.com/ (this makes for the clearest links)
- [http://example.com/] gives [1] (this should only be used if the site name is long or unimportant)
- [http://example.com/ text to display] gives text to display (useful, but can become confusing if over-used)
Useful things
- to link to a Wikipedia article on "example", use [[Wikipedia:example]]
Editing tips
- Use the editing toolbar to help you; it provides buttons to help you out.
- Keep things simple, and don't be afraid to make mistakes.
- Adding a line after a sentence will not make the next bit appear on a new line: for the convenience of coders, it will appear on the same line. To get it on a different line, either use
<br>or two lines.
