Difference between revisions of "VideoLAN Wiki:Syntax"

From VideoLAN Wiki
Jump to navigation Jump to search
(Re-write)
m (Change wikilinks, minor rewording)
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Please follow these guidelines when editing this wiki.<br>
+
__FORCETOC__
−
There will be more guidelines later.
+
{{See also|Documentation:EditingGuidelines}}
 +
Please sign your name on talk pages with four tildes: <code><nowiki>~~~~</nowiki></code>. It will automatically expand to your username and date.
  
 
== The basics ==
 
== The basics ==
−
''Note: You can practice editing at the [[Sandbox|Sandbox page]] whenever you like.''
+
:''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 <span title="HyperText Markup Language" style="border-bottom:1px dotted;">HTML</span>.<br>
 
  
 +
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 <abbr title="HyperText Markup Language">HTML</abbr>.<br />
 
Commands to modify plain text include:
 
Commands to modify plain text include:
−
* "tags" around words, for example <code><nowiki><big>example text</big></nowiki></code> to display <big>example text</big>
+
* "tags" around words, for example:
−
* "templates" (common snippets of formatting or often-used text), for example <nowiki>{{VLC}}</nowiki> to display {{VLC}}
+
*: <code><nowiki><big>example text</big></nowiki></code> → <big>example text</big>
−
* a particular way of linking to other pages and websites on the Internet
+
*: <code><nowiki><big><big>example text</big></big></nowiki></code> → <big><big>example text</big></big>
−
* a particular way of making things bold or italic
+
*: <code><nowiki><big><big><big>example text</big></big></big></nowiki></code> → <big><big><big>example text</big></big></big>
−
* a particular way of inserting images
+
*: <code><nowiki><small>example text</small></nowiki></code> → <small>example text</small>
 +
*: <code><nowiki><code>example text</code></nowiki></code> → <code>example text</code>
 +
* "templates" (common snippets of formatting or often-used text), for example:
 +
*: {{tl|VLC}} → {{VLC}}
 +
*: {{tl|VLC icon}} → {{VLC icon}}
 +
*: {{tl|VLC:latest version}} → {{VLC:latest version}}
 +
* a particular way of linking to other pages and websites on the Internet:
 +
*: <code><nowiki>[[Sandbox]]</nowiki></code> → [[Sandbox]]
 +
*: <code><nowiki>[[Sandbox|Sandbox page]]</nowiki></code> → [[Sandbox|Sandbox page]]
 +
*: <code><nowiki>https://example.com</nowiki></code> → https://example.com
 +
*: <code><nowiki>[https://example.com Example]</nowiki></code> → [https://example.com Example]
 +
*: <code><nowiki>[https://example.com]</nowiki></code> → [https://example.com]
 +
* a particular way of making things bold or italic:
 +
*: <code><nowiki>'''example text'''</nowiki></code> → '''example text'''
 +
*: <code><nowiki>''example text''</nowiki></code> → ''example text''
 +
*: <code><nowiki>'''''example text'''''</nowiki></code> → '''''example text'''''
 +
* a particular way of inserting images:
 +
*: <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]]
 +
Single lines <em>are ignored by the software</em>. To add a line break, use <code><nowiki><br /></nowiki></code> or enter two newlines in the wikitext.
  
 
Another important feature is the page layout:
 
Another important feature is the page layout:
−
* making lists
+
* making lists: simply start a line with *. For an indentation, use **.
−
* making tables
+
* making tables: better explained [//en.wikipedia.org/wiki/Help:Table at Wikipedia]
−
* using page headings to create sections
+
* 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 tags as <code><nowiki><pre>example text</pre></nowiki></code>:
 +
example text
  
−
=== If you have a minute... ===
+
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 />
−
Begin by learning the basics. A [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:Editing 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.
  
−
=== To start editing right away... ===
+
== Calling attention to pages ==
−
Find the Edit Toolbar directly above the edit box and use the buttons and the "Help" dropdown to guide you.
+
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|Stub}} at the bottom of a page to show that it needs work
 +
* Adding {{tl|Check}} after something you think might be incorrect
 +
* Adding {{tl|Outdated}} to the bottom of out-of-date pages
 +
* Adding {{tl|Image requested}} on the page needing better imagery
 +
See also the [[VideoLAN Wiki:List of templates]] for an visual listing of (most) of the templates ([[Special:PrefixIndex/Template:|full list]])
  
−
== Common conventions and best practices ==
+
== Further reading ==
−
* Frequently example code is shown, both for VLC commands or to document the internals of VLC. The following two tags currently exist to display text "as-is":
+
* [//www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide]
−
** Inline: <code><nowiki><code>...</code></nowiki></code>
 
−
** Block code: <code><nowiki><pre>...</pre></nowiki></code>
 
−
* While making numbered lists, prefer <code>#</code> notation for long lists, since the numbers are dynamic and automatically change when list items are added or removed
 
−
* Several ways to link to websites are available; the clearest way to link them is with text that says where the link goes, for example <code><nowiki>[http://en.wikipedia.org/wiki/VLC/ Wikipedia's entry on VLC]</nowiki></code>
 
−
* To end a line, use either ''two new lines'' or ''<code><nowiki><br></nowiki></code>''; single returns are ignored by the wiki, which expects two new-lines to signal a new line
 
−
* To mark text that is out-of-date, incorrect, or otherwise inaccurate, place {{tl|Check}} after the text to mark it with{{Check}} and add it to [[:Category:Pages to check]]
 
−
* If a page is very short or needs work, place {{tl|Stub}} at either the top or bottom of the page (somewhere out-of-the-way but visible) to help draw attention and add it to [[:Category:Stubs]]
 
  
−
=== Remarks ===
+
[[Category:VideoLAN Wiki]]
−
Templates seem to be local to each wiki (except built-in MediaWiki templates), so the VideoLAN wiki lacks the wide selection of perfunctory templates Wikipedia offers ‒ for example, {{tl|citation needed}}, which inserts <sup>[''<span style="color:blue;">citation needed</span>'']</sup>.
 
−
 
 
−
Rules concerning style are much more relaxed, and you are advised to use common sense. If something works ''better'' than listed in the section above, <u>do that instead</u>.
 
−
 
 
−
''Almost all pages are out of date.'' Currently no campaign to clean this up has been launched, but in the future out-of-date pages might be noted with a template/category identification system.
 
−
 
 
−
=== Useful things ===
 
−
* {{tl|VLC}} displays and links to {{VLC}}
 
−
* {{tl|VLC icon}} is a shorthand way to produce the image {{VLC icon}}
 
−
* {{tl|VLC:latest version}} will show the latest version of VLC
 
−
* {{tl|Font colour}}
 
−
 
 
−
=== 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.
 
−
 
 
−
== See also ==
 
−
* [//www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide]
 
−
* See the [[List of templates|Documented List of Templates]].
 
−
* See [[Special:PrefixIndex/Template:|all templates on {{SERVERNAME}}]]
 

Latest revision as of 05:07, 13 February 2019

See also: Documentation:EditingGuidelines

Please sign your name on talk pages with four tildes: ~~~~. It will automatically expand to your username and date.

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}} → LargeVLC.png
    {{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 page
    https://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]] → VLC - icon.png
    [[File:VLC - icon.png|16px]] → VLC - icon.png

Single lines are ignored by the software. To add a line break, use <br /> or enter two newlines in the 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 tags as <pre>example text</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

See also the VideoLAN Wiki:List of templates for an visual listing of (most) of the templates (full list)

Further reading

Retrieved from "https://wiki.videolan.org/index.php?title=VideoLAN_Wiki:Syntax&oldid=58000"