VideoLAN Wiki:Syntax

From VideoLAN Wiki
Revision as of 01:08, 14 November 2014 by DoesItReallyMatter (talk | contribs) (trim down documentation to avoid "Too long; didn't read" effect)
Jump to navigation Jump to search
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

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