Difference between revisions of "VideoLAN Wiki:Syntax"

From VideoLAN Wiki
Jump to navigation Jump to search
Line 24: Line 24:
  
 
== Common conventions and best practices ==
 
== 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:
+
* To show code as pre-formatted text, insert a blank space at the beginning of each line
−
** begin lines of code with a single space
+
* To end a line, either:
−
** wrap the code in the tag <code><nowiki><pre>...</pre></nowiki></code>
+
** use two new lines;
−
** use the in-line tag <code><nowiki><code>...</code></nowiki></code>
+
** or use the HTML entity <code><nowiki><br /></nowiki></code>
  
−
* While making numbered lists, prefer list-making wikicode over manual lists; it makes managing large lists much easier
+
=== Calling attention to pages ===
−
* 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
+
It's understood that a wiki will eventually become outdated, and needs to stay up-to-date. You can help by:
−
* 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>
+
* Adding {{tl|Dead link}} after a dead link
−
* 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
+
* Adding {{tl|Stub}} at the bottom of a page to show that it needs work
−
* 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]]
+
* Adding {{tl|Check}} after something you think might be incorrect
 +
* Adding {{tl|Outdated}} to the bottom of out-of-date pages (this is a new feature)
  
 
=== Useful things ===
 
=== Useful things ===

Revision as of 01:38, 14 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.

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.

Common conventions and best practices

  • To show code as pre-formatted text, insert a blank space at the beginning of each line
  • To end a line, either:
    • use two new lines;
    • or use the HTML entity <br />

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 (this is a new feature)

Useful things

See also

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