Difference between revisions of "VideoLAN Wiki:Syntax"

From VideoLAN Wiki
Jump to navigation Jump to search
(various)
Line 1: Line 1:
 +
:''See also: [[Documentation:EditingGuidelines]]''
 
Please follow these guidelines when editing this wiki.<br>
 
Please follow these guidelines when editing this wiki.<br>
 
There will be more guidelines later.
 
There will be more guidelines later.
Line 31: Line 32:
 
** use the in-line tag <code><nowiki><code>...</code></nowiki></code>
 
** use the in-line tag <code><nowiki><code>...</code></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
+
* While making numbered lists, prefer list-making wikicode over manual lists; it makes managing large lists much easier
−
* Generally the best way to link to other websites is with descriptive text: <code><nowiki>[http://en.wikipedia.org/wiki/VLC/ Wikipedia's entry on VLC]</nowiki></code>
+
* Generally the best way to link to other websites is with descriptive text. Users don't know where links go (within the wiki, Wikipedia, or another site) until they click the link
 
* To end a line, use either <u>''two new lines''</u> (a single new line will be ignored) or the HTML entity <code><nowiki><br></nowiki></code>
 
* To end a line, use either <u>''two new lines''</u> (a single new line will be ignored) or the HTML entity <code><nowiki><br></nowiki></code>
−
* Avoid adding in-line notes such as <code>FIXME</code> or <code>BROKEN LINK</code> within articles, as this may not be seen by the editors willing to help
+
* Avoid adding in-line notes such as <code>FIXME</code> or <code>BROKEN LINK</code> within articles—use the [[Help:Templates|templates]] {{tl|Check}} and {{tl|Dead link}} instead. This will add an in-text visual reminder and will automatically add the page to maintenance categories
−
** Instead, mark text that needs review (e.g., anything out-of-date, broken, etc.) by placing {{tl|Check}} after the text. This will add the text<sup>[Please check this]</sup> as a visual reminder and will ''automatically'' add the page 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]]
 
* 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 ===
 
=== Remarks ===
−
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>.
 
−
 
 
Nota bene or NB means "important note". It's a Latin/Italian phrase that is used very often around the wiki to indicate how a page is to be interpreted, for instance, remarking that the page documents ''past'' conventions. Generally, read this before anything else on the page.
 
Nota bene or NB means "important note". It's a Latin/Italian phrase that is used very often around the wiki to indicate how a page is to be interpreted, for instance, remarking that the page documents ''past'' conventions. Generally, read this before anything else on the page.
  
 
Most pages are written in loosely British English, rather than American English. Contribute in whatever style of English you feel comfortable writing in.
 
Most pages are written in loosely British English, rather than American English. Contribute in whatever style of English you feel comfortable writing in.
−
 
−
''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 ===
 
=== Useful things ===

Revision as of 09:30, 6 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.

Commands to modify plain text include:

  • "tags" around words, for example <big>example text</big> to display example text
  • "templates" (common snippets of formatting or often-used text), for example {{VLC}} to display VLC media player
  • a particular way of linking to other pages and websites on the Internet
  • a particular way of making things bold or italic
  • a particular way of inserting images

Another important feature is the page layout:

  • making lists
  • making tables
  • using page headings to create sections

If you have a minute...

Begin by learning the basics. A one-page summary and an extensive manual are available at the English Wikipedia.

To start editing right away...

Find the Edit Toolbar directly above the edit box and use the buttons and the "Help" dropdown to guide you.

Common conventions and best practices

  • Many articles explain how to manipulate code within VLC. It is standard practice to visually separate large chunks of code from the body of the article in order to make it easier to read. You can do this in several ways:
    • begin lines of code with a single space
    • wrap the code in the tag <pre>...</pre>
    • use the in-line tag <code>...</code>
  • While making numbered lists, prefer list-making wikicode over manual lists; it makes managing large lists much easier
  • Generally the best way to link to other websites is with descriptive text. Users don't know where links go (within the wiki, Wikipedia, or another site) until they click the link
  • To end a line, use either two new lines (a single new line will be ignored) or the HTML entity <br>
  • Avoid adding in-line notes such as FIXME or BROKEN LINK within articles—use the templates {{Check}} and {{Dead link}} instead. This will add an in-text visual reminder and will automatically add the page to maintenance categories
  • If a page is very short or needs work, place {{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

Nota bene or NB means "important note". It's a Latin/Italian phrase that is used very often around the wiki to indicate how a page is to be interpreted, for instance, remarking that the page documents past conventions. Generally, read this before anything else on the page.

Most pages are written in loosely British English, rather than American English. Contribute in whatever style of English you feel comfortable writing in.

Useful things

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

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