Difference between revisions of "VideoLAN Wiki:Syntax"
Jump to navigation
Jump to search
(→Common conventions and best practices: condense & clarify) |
(Re-structure) |
||
| Line 23: | Line 23: | ||
If you want to "dive right in", find the ''Edit Toolbar'' (directly above the edit box) and use the buttons and the dropdown help for assistance. | If you want to "dive right in", find the ''Edit Toolbar'' (directly above the edit box) and use the buttons and the dropdown help for assistance. | ||
| − | == | + | == Important points == |
| − | * | + | * Single lines <u>are ignored by the software</u>. If you don't want text from one line to wrap to another, end it with <code><nowiki><br /></nowiki></code> |
| − | + | * Signing your name on talk pages is considered good practice; it lets others know when and by whom comments are written. Use <nowiki>~~~~</nowiki> to insert your signature and the date. | |
| − | |||
| − | |||
| − | + | == Calling attention to pages == | |
It's understood that a wiki will eventually become outdated, and needs to stay up-to-date. You can help by: | It's understood that a wiki will eventually become outdated, and needs to stay up-to-date. You can help by: | ||
* Adding {{tl|Dead link}} after a dead link | * Adding {{tl|Dead link}} after a dead link | ||
| Line 36: | Line 34: | ||
* Adding {{tl|Outdated}} to the bottom of out-of-date pages (this is a new feature) | * Adding {{tl|Outdated}} to the bottom of out-of-date pages (this is a new feature) | ||
| − | + | == Useful tidbits == | |
* {{tl|VLC}} displays and links to {{VLC}} | * {{tl|VLC}} displays and links to {{VLC}} | ||
| − | * {{tl|VLC icon}} | + | * {{tl|VLC icon}} will insert the image {{VLC icon}} |
* {{tl|VLC:latest version}} will show the latest version of VLC | * {{tl|VLC:latest version}} will show the latest version of VLC | ||
| − | * | + | * <code><nowiki><code>...</code></nowiki></code> will show text <code>like this</code> |
| + | * To show code as pre-formatted text, insert a blank space at the beginning of each line | ||
== See also == | == See also == | ||
Revision as of 01:46, 14 November 2014
- See also: Documentation:EditingGuidelines
Please follow these guidelines when editing this wiki.
There will be more guidelines later.
The basics
- Note: You can practice editing at the Sandbox page whenever you like.
This wiki uses something called "wikimarkup", a way to include plain text on a page and modify how it looks. This is similar to both Wikipedia's markup and HTML.
If you have a minute, learn the basics of editing: a one-page summary and an extensive manual are available at the English Wikipedia.
If you want to "dive right in", find the Edit Toolbar (directly above the edit box) and use the buttons and the dropdown help for assistance.
Important points
- Single lines are ignored by the software. If you don't want text from one line to wrap to another, end it with
<br /> - Signing your name on talk pages is considered good practice; it lets others know when and by whom comments are written. Use ~~~~ to insert your signature and the date.
Calling attention to pages
It's understood that a wiki will eventually become outdated, and needs to stay up-to-date. You can help by:
- Adding {{Dead link}} after a dead link
- Adding {{Stub}} at the bottom of a page to show that it needs work
- Adding {{Check}} after something you think might be incorrect
- Adding {{Outdated}} to the bottom of out-of-date pages (this is a new feature)
Useful tidbits
- {{VLC}} displays and links to VLC media player
- {{VLC icon}} will insert the image
- {{VLC:latest version}} will show the latest version of VLC
<code>...</code>will show textlike this- To show code as pre-formatted text, insert a blank space at the beginning of each line
