Difference between revisions of "VideoLAN Wiki:Syntax"
Jump to navigation
Jump to search
m (→General markup: Expand syntax of internal/external links) |
(→General markup: Expand link syntax) |
||
| Line 23: | Line 23: | ||
** <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]] | ||
| − | * | + | * There are several ways to create external links: a simple outgoing link, a shortened link, or a shortened link with alternate text: |
| − | ** <nowiki>[http://example.com/]</nowiki> gives [http://example.com/] | + | ** <nowiki>http://example.com/</nowiki> gives http://example.com/ (this makes for the clearest links) |
| − | ** <nowiki>[http://example.com/ text to display]</nowiki> gives [http://example.com/ text to display] | + | ** <nowiki>[http://example.com/]</nowiki> gives [http://example.com/] (this should only be used if the site name is long or unimportant) |
| + | ** <nowiki>[http://example.com/ text to display]</nowiki> gives [http://example.com/ text to display] (useful, but can become confusing if over-used) | ||
=== General words of advice === | === General words of advice === | ||
Revision as of 08:05, 24 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]]
- [[VLC]] gives VLC
- [[VLC|this totally awesome media player]] gives this totally awesome media player
- There are several ways to create external links: a simple outgoing link, a shortened link, or a shortened link with alternate text:
- http://example.com/ gives http://example.com/ (this makes for the clearest links)
- [http://example.com/] gives [1] (this should only be used if the site name is long or unimportant)
- [http://example.com/ text to display] gives text to display (useful, but can become confusing if over-used)
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.
