Difference between revisions of "VideoLAN Wiki:Syntax"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Re-write for clarity)
m (→‎General markup: Expand syntax of internal/external links)
Line 17: Line 17:
 
* Add two apostrophes around a word or phrase to make it italic: <nowiki>''example''</nowiki> → ''example''
 
* Add two apostrophes around a word or phrase to make it italic: <nowiki>''example''</nowiki> → ''example''
 
* Add three apostrophes around a word or phrase to make it bold: <nowiki>'''example'''</nowiki> → '''example'''
 
* Add three apostrophes around a word or phrase to make it bold: <nowiki>'''example'''</nowiki> → '''example'''
* Add five apostrophes around a word or phrase to make it italic and bold: <nowiki>'''''example'''''</nowiki> → '''''example'''''
+
* Occasionally, both are needed. Add five apostrophes around a word or phrase to make it both: <nowiki>'''''example'''''</nowiki> → '''''example'''''
  
 
;Linking
 
;Linking
* The formula for creating a link is <nowiki>[[target page]]</nowiki> or <nowiki>[[target page|text to display]]</nowiki>
+
* The formula for creating an internal link is <nowiki>[[target page]]</nowiki> or <nowiki>[[target page|text to display]]</nowiki>
 
** <nowiki>[[VLC]]</nowiki> gives [[VLC]]
 
** <nowiki>[[VLC]]</nowiki> gives [[VLC]]
 
** <nowiki>[[VLC|this totally awesome media player]]</nowiki> gives [[VLC|this totally awesome media player]]
 
** <nowiki>[[VLC|this totally awesome media player]]</nowiki> gives [[VLC|this totally awesome media player]]
 +
* The formula for creating an external link is <nowiki>[http://example.com/]</nowiki> or <nowiki>[http://example.com/ text to display]</nowiki>
 +
** <nowiki>[http://example.com/]</nowiki> gives [http://example.com/]
 +
** <nowiki>[http://example.com/ text to display]</nowiki> gives [http://example.com/ text to display]
  
 
=== General words of advice ===
 
=== General words of advice ===

Revision as of 00:18, 22 October 2014

Please follow these guidelines when editing this wiki. There will be more guidelines later.

The basics

This wiki uses the same general syntax as Wikipedia, because both use MediaWiki markup (Editing help on MediaWiki).

If you've ever edited on Wikipedia, this should look familiar.

General markup

Note: You can practice editing at the Sandbox page whenever you like.

Lists
  • To make a bulleted list, begin lines with asterisks *
  • To make a numbered list, begin lines with pound signs # (which will be automatically re-numbered if you add or remove items—this is generally smart for long or frequently-changing lists).
Markup
  • Add two apostrophes around a word or phrase to make it italic: ''example'' → example
  • Add three apostrophes around a word or phrase to make it bold: '''example''' → example
  • Occasionally, both are needed. Add five apostrophes around a word or phrase to make it both: '''''example''''' → example
Linking
  • The formula for creating an internal link is [[target page]] or [[target page|text to display]]
  • The formula for creating an external link is [http://example.com/] or [http://example.com/ text to display]
    • [http://example.com/] gives [1]
    • [http://example.com/ text to display] gives text to display

General words of advice

  • 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 cheat-sheet for you that you might find useful editing here.

Templates