Difference between revisions of "VideoLAN Wiki:Syntax"

From VideoLAN Wiki
Jump to navigation Jump to search
(→‎How to...: Reorganise & explain how to "pipe" internal links)
m (Re-write for clarity)
Line 3: Line 3:
  
 
== The basics ==
 
== The basics ==
−
This "wiki" ([https://en.wikipedia.org/wiki/Wiki/ Wikipedia entry]) inherits its syntax from the MediaWiki code ([https://www.mediawiki.org/wiki/MediaWiki official site]). This means that editing this wiki will be very similar to any other wiki you may have encountered, such as Wikipedia or Wikia sites.
+
This wiki uses the same general syntax as Wikipedia, because both use MediaWiki markup ([https://www.mediawiki.org/wiki/Help:Editing Editing help on MediaWiki]).
  
−
Wikimarkup, as it's called, is simplified HyperText Markup Language (HTML), and was designed for ease of use. You can learn the basics of it within a few minutes.
+
If you've ever edited on Wikipedia, this should look familiar.
 +
 
 +
=== General markup ===
 +
''Note: You can practice editing at the [[Sandbox|Sandbox page]] whenever you like.''
  
−
=== How to... ===
 
−
The markup might be best learned by practicing in the [https://wiki.videolan.org/Sandbox/ Sandbox page] after looking over this quick list:
 
 
;Lists
 
;Lists
−
* Asterisks (*) at the beginning of one or more lines create a bulleted list
+
* To make a bulleted list, begin lines with asterisks <code>*</code>
−
* Pound signs (#) at the beginning of one one or more lines create numbered lists—this is incredibly convenient if you have long lists, because the line numbers are auto-calculated
+
* 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
 
;Markup
 
* 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'''''
 
* Add five apostrophes around a word or phrase to make it italic and bold: <nowiki>'''''example'''''</nowiki> → '''''example'''''
 +
 
;Linking
 
;Linking
−
* Two sets of double brackets around words, e.g. <nowiki>[[example]]</nowiki>, will link to the page "Example"
+
* The formula for creating a link is <nowiki>[[target page]]</nowiki> or <nowiki>[[target page|text to display]]</nowiki>
−
* External URLs, like http://example.com, will automatically link
+
** <nowiki>[[VLC]]</nowiki> gives [[VLC]]
−
* The [https://en.wikipedia.org/wiki/Wikipedia:PIPELINK "pipe trick"] enables you to link to one page but display a different text label
+
** <nowiki>[[VLC|this totally awesome media player]]</nowiki> gives [[VLC|this totally awesome media player]]
−
** The text on the ''left'' is the target page you wish to link to
 
−
** The text on the ''right'' is the label
 
−
** For example, <nowiki>[[VLC|this totally awesome media player]]</nowiki> becomes [[VLC|this totally awesome media player]]
 
  
 
=== General words of advice ===
 
=== General words of advice ===
 
* Use the editing toolbar to help you; it provides buttons to help you out.
 
* 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.
 
* Keep things simple, and don't be afraid to make mistakes.
−
* Wikipedia has already prepared a cheat-sheet for you (all of it should work nicely here): [https://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia:Cheatsheet]
+
* Wikipedia has already prepared a [https://en.wikipedia.org/wiki/Wikipedia:Cheatsheet cheat-sheet] for you that you might find useful editing here.
  
 
== Templates ==
 
== Templates ==

Revision as of 20:18, 21 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
  • Add five apostrophes around a word or phrase to make it italic and bold: '''''example''''' → example
Linking
  • The formula for creating a link is [[target page]] or [[target page|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

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