VideoLAN Wiki:Syntax
Revision as of 04:51, 13 February 2019 by DoesItReallyMatter (talk | contribs) (Removing "There will be more guidelines later.")
See also: Documentation:EditingGuidelines
Please follow these guidelines when editing this wiki.
The basics
- Note: You can practice editing at the Sandbox 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.
Commands to modify plain text include:
- "tags" around words, for example:
<big>example text</big>→ example text<big><big>example text</big></big>→ example text<big><big><big>example text</big></big></big>→ example text<small>example text</small>→ example text<code>example text</code>→example text
- "templates" (common snippets of formatting or often-used text), for example:
- {{VLC}} → VLC media player
- {{VLC icon}} →
- {{VLC:latest version}} → 3.0.12
- a particular way of linking to other pages and websites on the Internet:
[[Sandbox]]→ Sandbox[[Sandbox|Sandbox page]]→ Sandbox pagehttps://example.com→ https://example.com[https://example.com Example]→ Example[https://example.com]→ [1]
- a particular way of making things bold or italic:
'''example text'''→ example text''example text''→ example text'''''example text'''''→ example text
- a particular way of inserting images:
[[File:VLC - icon.png]]→
[[File:VLC - icon.png|16px]]→
Another important feature is the page layout:
- making lists: simply start a line with *. For an indentation, use **.
- making tables: better explained at Wikipedia
- using page headings to create sections: use pairs of equal signs around text, starting at two
- To show code as pre-formatted text, insert a blank space at the beginning of each line or wrap in
<pre>...</pre>:
example text
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
- Adding {{Image requested}} on the page needing better imagery
