Difference between revisions of "VideoLAN Wiki:Syntax"

From VideoLAN Wiki
Jump to navigation Jump to search
(More editing, noted on the page this guide is still being written)
m (Change wikilinks, minor rewording)
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
'''<big>This guide is still in the process of being written</big>'''<br>
+
__FORCETOC__
−
<br>
+
{{See also|Documentation:EditingGuidelines}}
−
Please follow these guidelines when editing this wiki.
+
Please sign your name on talk pages with four tildes: <code><nowiki>~~~~</nowiki></code>. It will automatically expand to your username and date.
−
There will be more guidelines later.
 
  
 
== The basics ==
 
== The basics ==
−
This wiki uses the same general syntax as Wikipedia, because both use MediaWiki markup ([https://www.mediawiki.org/wiki/Help:Editing A full manual can be found here on MediaWiki]).<br>
+
:''Note: You can practice editing at the [[Sandbox]] whenever you like.''
−
Unlike Wikipedia, the "[//en.wikipedia.org/wiki/Help:VisualEditor VisualEditor feature]" was never enabled and so can't be used.
 
  
−
Familiarising yourself with [//en.wikipedia.org/wiki/Help:Wiki_markup_guide wikimarkup] is probably a good idea. The basics of it can be learned within minutes, and a quick reference guide can be found under the "Help" section of the Editing Toolbar, a visual way to insert wikimarkup quickly.
+
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:
 +
* "tags" around words, for example:
 +
*: <code><nowiki><big>example text</big></nowiki></code> → <big>example text</big>
 +
*: <code><nowiki><big><big>example text</big></big></nowiki></code> → <big><big>example text</big></big>
 +
*: <code><nowiki><big><big><big>example text</big></big></big></nowiki></code> → <big><big><big>example text</big></big></big>
 +
*: <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.
  
−
=== General markup ===
+
Another important feature is the page layout:
−
''Note: You can practice editing at the [[Sandbox|Sandbox page]] whenever you like.''
+
* making lists: simply start a line with *. For an indentation, use **.
 +
* making tables: better explained [//en.wikipedia.org/wiki/Help:Table 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 <code><nowiki><pre>example text</pre></nowiki></code>:
 +
example text
  
−
;Lists
+
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 />
−
* To make a bulleted list, begin lines with asterisks <code>*</code>
+
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 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).
 
  
−
;Markup
+
== Calling attention to pages ==
−
* Add two apostrophes around a word or phrase to make it italic: <nowiki>''example''</nowiki> → ''example''
+
It's understood that a wiki will eventually become outdated, and needs to stay up-to-date. You can help by:
−
* Add three apostrophes around a word or phrase to make it bold: <nowiki>'''example'''</nowiki> → '''example'''
+
* Adding {{tl|Dead link}} after a dead link
−
* Occasionally, both are needed. Add five apostrophes around a word or phrase to make it both: <nowiki>'''''example'''''</nowiki> → '''''example'''''
+
* 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]])
  
−
;Linking
+
== Further reading ==
−
* The formula for creating an internal link is <nowiki>[[target page]]</nowiki> or <nowiki>[[target page|text to display]]</nowiki>
+
* [//www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide]
−
** <nowiki>[[VLC]]</nowiki> gives [[VLC]]
 
−
** <nowiki>[[VLC|this totally awesome media player]]</nowiki> gives [[VLC|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:
 
−
** <nowiki>http://example.com/</nowiki> gives http://example.com/ (this makes for the clearest links)
 
−
** <nowiki>[http://example.com/]</nowiki> gives [http://example.com/] (this should only be used if the site name is long or unimportant)
 
−
** <nowiki>[http://example.com/ text to display]</nowiki> gives [http://example.com/ text to display] (useful, but can become confusing if over-used)
 
  
−
=== Useful things ===
+
[[Category:VideoLAN Wiki]]
−
* 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.
 
−
* Keep things simple, and don't be afraid to make mistakes.
 
−
* Wikipedia has already prepared a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet cheat-sheet] for you that you might find useful editing here.
 
−
* 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.
 
−
 
 
−
== Resources ==
 
−
* [//en.wikipedia.org/wiki/Help:Wiki_markup_guide wikimarkup]
 
−
 
 
−
== Templates ==
 
−
 
 
−
* 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"