Difference between revisions of "VideoLAN Wiki:Syntax"
Jump to navigation
Jump to search
(Removing "There will be more guidelines later.") |
(Rewording "Please follow these guidelines": most of this page is syntax information. Rewrote to apply to "Sign your name with ~~~~" at the top) |
||
| Line 1: | Line 1: | ||
| + | __FORCETOC__ | ||
{{See also|Documentation:EditingGuidelines}} | {{See also|Documentation:EditingGuidelines}} | ||
| − | Please | + | Please sign your name on talk pages with four tildes: <code><nowiki>~~~~</nowiki></code>. It will automatically expand to your username. |
== The basics == | == The basics == | ||
| Line 30: | Line 31: | ||
*: <code><nowiki>[[File:VLC - icon.png]]</nowiki></code> → [[File:VLC - icon.png]] | *: <code><nowiki>[[File:VLC - icon.png]]</nowiki></code> → [[File:VLC - icon.png]] | ||
*: <code><nowiki>[[File:VLC - icon.png|16px]]</nowiki></code> → [[File:VLC - icon.png|16px]] | *: <code><nowiki>[[File:VLC - icon.png|16px]]</nowiki></code> → [[File:VLC - icon.png|16px]] | ||
| + | Single lines <em>are ignored by the software</em>. To add a line break, use <code><nowiki><br /></nowiki></code> or enter two newlines to wikitext. | ||
Another important feature is the page layout: | Another important feature is the page layout: | ||
| Line 40: | Line 42: | ||
If you have a minute, learn the basics of editing: a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:Wikitext an extensive manual] are available at the English Wikipedia.<br /> | If you have a minute, learn the basics of editing: a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:Wikitext an extensive manual] are available at the English Wikipedia.<br /> | ||
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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
== Calling attention to pages == | == Calling attention to pages == | ||
Revision as of 04:59, 13 February 2019
See also: Documentation:EditingGuidelines
Please sign your name on talk pages with four tildes: ~~~~. It will automatically expand to your username.
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]]→
Single lines are ignored by the software. To add a line break, use <br /> or enter two newlines to wikitext.
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.
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
