VideoLAN Wiki:Syntax - Revision history

DoesItReallyMatter: Change wikilinks, minor rewording

2019-02-13T05:07:36Z

Change wikilinks, minor rewording

← Older revision		Revision as of 05:07, 13 February 2019
Line 1:		Line 1:
	__FORCETOC__		__FORCETOC__
	{{See also\|Documentation:EditingGuidelines}}		{{See also\|Documentation:EditingGuidelines}}
	Please sign your name on talk pages with four tildes: <code><nowiki>~~~~</nowiki></code>. It will automatically expand to your username.		Please sign your name on talk pages with four tildes: <code><nowiki>~~~~</nowiki></code>. It will automatically expand to your username and date.

	== The basics ==		== The basics ==
Line 31:		Line 31:
	*: <code><nowiki>[[File:VLC - icon.png]]</nowiki></code> → [[File:VLC - icon.png]]		*: <code><nowiki>[[File:VLC - icon.png]]</nowiki></code> → [[File:VLC - icon.png]]
	*: <code><nowiki>[[File:VLC - icon.png\|16px]]</nowiki></code> → [[File:VLC - icon.png\|16px]]		*: <code><nowiki>[[File:VLC - icon.png\|16px]]</nowiki></code> → [[File:VLC - icon.png\|16px]]
	Single lines <em>are ignored by the software</em>. To add a line break, use <code><nowiki><br /></nowiki></code> or enter two newlines to wikitext.		Single lines <em>are ignored by the software</em>. To add a line break, use <code><nowiki><br /></nowiki></code> or enter two newlines in the wikitext.

	Another important feature is the page layout:		Another important feature is the page layout:
Line 37:		Line 37:
	* making tables: better explained [//en.wikipedia.org/wiki/Help:Table at Wikipedia]		* making tables: better explained [//en.wikipedia.org/wiki/Help:Table at Wikipedia]
	* using page headings to create sections: use pairs of equal signs around text, starting at two		* using page headings to create sections: use pairs of equal signs around text, starting at two
	* To show code as pre-formatted text, insert a blank space at the beginning of each line or wrap in <code><nowiki><pre>~~...~~</pre></nowiki></code>:		* To show code as pre-formatted text, insert a blank space at the beginning of each line or wrap in pre tags as <code><nowiki><pre>example text</pre></nowiki></code>:
	example text		example text

Line 50:		Line 50:
	* Adding {{tl\|Outdated}} to the bottom of out-of-date pages		* Adding {{tl\|Outdated}} to the bottom of out-of-date pages
	* Adding {{tl\|Image requested}} on the page needing better imagery		* Adding {{tl\|Image requested}} on the page needing better imagery
			See also the [[VideoLAN Wiki:List of templates]] for an visual listing of (most) of the templates ([[Special:PrefixIndex/Template:\|full list]])

	== ~~See also~~ ==		== Further reading ==
	* [//www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide]		* [//www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide]
	* See the [[VideoLAN Wiki:List of templates\|Documented List of Templates]].
	* See [[Special:PrefixIndex/Template:\|all templates on {{SERVERNAME}}]]

	[[Category:VideoLAN Wiki]]		[[Category:VideoLAN Wiki]]

DoesItReallyMatter: Rewording "Please follow these guidelines": most of this page is syntax information. Rewrote to apply to "Sign your name with ~~~~" at the top

2019-02-13T04:59:54Z

Rewording "Please follow these guidelines": most of this page is syntax information. Rewrote to apply to "Sign your name with ~~~~" at the top

← Older revision		Revision as of 04:59, 13 February 2019
Line 1:		Line 1:
			__FORCETOC__
	{{See also\|Documentation:EditingGuidelines}}		{{See also\|Documentation:EditingGuidelines}}
	Please ~~follow these guidelines when editing this wiki~~.		Please sign your name on talk pages with four tildes: <code><nowiki>~~~~</nowiki></code>. It will automatically expand to your username.

	== The basics ==		== The basics ==
Line 30:		Line 31:
	*: <code><nowiki>[[File:VLC - icon.png]]</nowiki></code> → [[File:VLC - icon.png]]		*: <code><nowiki>[[File:VLC - icon.png]]</nowiki></code> → [[File:VLC - icon.png]]
	*: <code><nowiki>[[File:VLC - icon.png\|16px]]</nowiki></code> → [[File:VLC - icon.png\|16px]]		*: <code><nowiki>[[File:VLC - icon.png\|16px]]</nowiki></code> → [[File:VLC - icon.png\|16px]]
			Single lines <em>are ignored by the software</em>. To add a line break, use <code><nowiki><br /></nowiki></code> or enter two newlines to wikitext.

	Another important feature is the page layout:		Another important feature is the page layout:
Line 40:		Line 42:
	If you have a minute, learn the basics of editing: a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:Wikitext an extensive manual] are available at the English Wikipedia.<br />		If you have a minute, learn the basics of editing: a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:Wikitext an extensive manual] are available at the English Wikipedia.<br />
	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.		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.

	~~== Important points ==~~
	* Single lines <em>are ignored by the software</em>. If you don't want text from one line to wrap to another, end it with <code><nowiki><br /></nowiki></code>
	* Signing your name on talk pages is considered good practice; it lets others know when and by whom comments are written. Use <nowiki>~~~~</nowiki> to insert your signature and the date.

	== Calling attention to pages ==		== Calling attention to pages ==

DoesItReallyMatter: Removing "There will be more guidelines later."

2019-02-13T04:51:45Z

Removing "There will be more guidelines later."

← Older revision		Revision as of 04:51, 13 February 2019
Line 1:		Line 1:
	{{See also\|Documentation:EditingGuidelines}}		{{See also\|Documentation:EditingGuidelines}}
	Please follow these guidelines when editing this wiki~~.<br />~~		Please follow these guidelines when editing this wiki.
	~~There will be more guidelines later~~.

	== The basics ==		== The basics ==

DoesItReallyMatter: Expand

2019-02-13T04:49:36Z

Expand

← Older revision		Revision as of 04:49, 13 February 2019
Line 1:		Line 1:
	~~:''~~See also~~: [[~~Documentation:EditingGuidelines~~]]''~~		{{See also\|Documentation:EditingGuidelines}}
	Please follow these guidelines when editing this wiki.<br />		Please follow these guidelines when editing this wiki.<br />
	There will be more guidelines later.		There will be more guidelines later.

	== The basics ==		== The basics ==
	:''Note: You can practice editing at the [[Sandbox~~\|Sandbox page~~]] whenever you like.''		:''Note: You can practice editing at the [[Sandbox]] 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 <abbr title="HyperText Markup Language">HTML</abbr>.<br />		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 <abbr title="HyperText Markup Language">HTML</abbr>.<br />
	~~<!-- doesn't seem too informative~~
	Commands to modify plain text include:		Commands to modify plain text include:
	* "tags" around words, for example <code><nowiki><big>example text</big></nowiki></code> ~~to display~~ <big>example text</big>		* "tags" around words, for example:
	* "templates" (common snippets of formatting or often-used text), for example ~~<nowiki>~~{{VLC}}~~</nowiki> to display~~ {{VLC}}		*: <code><nowiki><big>example text</big></nowiki></code> → <big>example text</big>
	* a particular way of linking to other pages and websites on the Internet		*: <code><nowiki><big><big>example text</big></big></nowiki></code> → <big><big>example text</big></big>
	* a particular way of making things bold or italic		*: <code><nowiki><big><big><big>example text</big></big></big></nowiki></code> → <big><big><big>example text</big></big></big>
	* a particular way of inserting images		*: <code><nowiki><small>example text</small></nowiki></code> → <small>example text</small>
			*: <code><nowiki><code>example text</code></nowiki></code> → <code>example text</code>
			* "templates" (common snippets of formatting or often-used text), for example:
			*: {{tl\|VLC}} → {{VLC}}
			*: {{tl\|VLC icon}} → {{VLC icon}}
			*: {{tl\|VLC:latest version}} → {{VLC:latest version}}
			* a particular way of linking to other pages and websites on the Internet:
			*: <code><nowiki>[[Sandbox]]</nowiki></code> → [[Sandbox]]
			*: <code><nowiki>[[Sandbox\|Sandbox page]]</nowiki></code> → [[Sandbox\|Sandbox page]]
			*: <code><nowiki>https://example.com</nowiki></code> → https://example.com
			*: <code><nowiki>[https://example.com Example]</nowiki></code> → [https://example.com Example]
			*: <code><nowiki>[https://example.com]</nowiki></code> → [https://example.com]
			* a particular way of making things bold or italic:
			*: <code><nowiki>'''example text'''</nowiki></code> → '''example text'''
			*: <code><nowiki>''example text''</nowiki></code> → ''example text''
			*: <code><nowiki>'''''example text'''''</nowiki></code> → '''''example text'''''
			* a particular way of inserting images:
			*: <code><nowiki>[[File:VLC - icon.png]]</nowiki></code> → [[File:VLC - icon.png]]
			*: <code><nowiki>[[File:VLC - icon.png\|16px]]</nowiki></code> → [[File:VLC - icon.png\|16px]]

	Another important feature is the page layout:		Another important feature is the page layout:
	* making lists		* making lists: simply start a line with . For an indentation, use *.
	* making tables		* making tables: better explained [//en.wikipedia.org/wiki/Help:Table at Wikipedia]
	* using page headings to create sections-->		* using page headings to create sections: use pairs of equal signs around text, starting at two
			* To show code as pre-formatted text, insert a blank space at the beginning of each line or wrap in <code><nowiki><pre>...</pre></nowiki></code>:
			example text

	If you have a minute, learn the basics of editing: a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:~~Editing~~ an extensive manual] are available at the English Wikipedia.<br />		If you have a minute, learn the basics of editing: a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:Wikitext an extensive manual] are available at the English Wikipedia.<br />
	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.		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.

	== Important points ==		== Important points ==
	* Single lines <u>are ignored by the software</u>. If you don't want text from one line to wrap to another, end it with <code><nowiki><br /></nowiki></code>		* Single lines <em>are ignored by the software</em>. If you don't want text from one line to wrap to another, end it with <code><nowiki><br /></nowiki></code>
	* Signing your name on talk pages is considered good practice; it lets others know when and by whom comments are written. Use <nowiki>~~~~</nowiki> to insert your signature and the date.		* Signing your name on talk pages is considered good practice; it lets others know when and by whom comments are written. Use <nowiki>~~~~</nowiki> to insert your signature and the date.

Line 32:		Line 51:
	* Adding {{tl\|Stub}} at the bottom of a page to show that it needs work		* Adding {{tl\|Stub}} at the bottom of a page to show that it needs work
	* Adding {{tl\|Check}} after something you think might be incorrect		* 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)~~		* Adding {{tl\|Outdated}} to the bottom of out-of-date pages
			* Adding {{tl\|Image requested}} on the page needing better imagery
	~~== Useful tidbits ==~~
	* {{tl\|VLC}} displays and links to {{VLC}}
	* {{tl\|VLC icon}} will insert the image {{VLC icon}}
	* {{tl\|~~VLC:latest version~~}} ~~will show the latest version of VLC~~
	* <code><nowiki><code>...</code></nowiki></code> will show text <code>like this</code>
	* To show code as pre-formatted text, insert a blank space at the ~~beginning of each line~~

	== See also ==		== See also ==
	* [//www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide]		* [//www.mediawiki.org/wiki/Help:Editing MediaWiki exhaustive reference guide]
	* See the [[List of templates\|Documented List of Templates]].		* See the [[VideoLAN Wiki:List of templates\|Documented List of Templates]].
	* See [[Special:PrefixIndex/Template:\|all templates on {{SERVERNAME}}]]		* See [[Special:PrefixIndex/Template:\|all templates on {{SERVERNAME}}]]

	[[Category:VideoLAN Wiki]]		[[Category:VideoLAN Wiki]]

DoesItReallyMatter: add page to :Category:VideoLAN Wiki

2016-11-05T09:27:23Z

add page to Category:VideoLAN Wiki

← Older revision		Revision as of 09:27, 5 November 2016
Line 45:		Line 45:
	* See the [[List of templates\|Documented List of Templates]].		* See the [[List of templates\|Documented List of Templates]].
	* See [[Special:PrefixIndex/Template:\|all templates on {{SERVERNAME}}]]		* See [[Special:PrefixIndex/Template:\|all templates on {{SERVERNAME}}]]

			[[Category:VideoLAN Wiki]]

DoesItReallyMatter: Re-structure

2014-11-14T01:46:14Z

Re-structure

← Older revision		Revision as of 01:46, 14 November 2014
Line 23:		Line 23:
	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.		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~~ ==		== Important points ==
	* ~~To show code as pre-formatted~~ text, ~~insert a blank space at the beginning of each line~~		* Single lines <u>are ignored by the software</u>. If you don't want text from one line to wrap to another, end it with <code><nowiki><br /></nowiki></code>
	* To end ~~a line, either:~~		* Signing your name on talk pages is considered good practice; it lets others know when and by whom comments are written. Use <nowiki>~~~~</nowiki> to insert your signature and the date.
	** use two new lines;
	** or use the HTML entity <code><nowiki><br /></nowiki></code>

	=== Calling attention to pages ===		== 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:		It's understood that a wiki will eventually become outdated, and needs to stay up-to-date. You can help by:
	* Adding {{tl\|Dead link}} after a dead link		* Adding {{tl\|Dead link}} after a dead link
Line 36:		Line 34:
	* Adding {{tl\|Outdated}} to the bottom of out-of-date pages (this is a new feature)		* Adding {{tl\|Outdated}} to the bottom of out-of-date pages (this is a new feature)

	=== Useful ~~things =~~==		== Useful tidbits ==
	* {{tl\|VLC}} displays and links to {{VLC}}		* {{tl\|VLC}} displays and links to {{VLC}}
	* {{tl\|VLC icon}} ~~is a shorthand way to produce~~ the image {{VLC icon}}		* {{tl\|VLC icon}} will insert the image {{VLC icon}}
	* {{tl\|VLC:latest version}} will show the latest version of VLC		* {{tl\|VLC:latest version}} will show the latest version of VLC
	* ~~{{tl\|Font colour}}~~		* <code><nowiki><code>...</code></nowiki></code> will show text <code>like this</code>
			* To show code as pre-formatted text, insert a blank space at the beginning of each line

	== See also ==		== See also ==

DoesItReallyMatter: /* Common conventions and best practices */ condense & clarify

2014-11-14T01:38:19Z

Common conventions and best practices: condense & clarify

← Older revision		Revision as of 01:38, 14 November 2014
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 ===

DoesItReallyMatter: /* Common conventions and best practices */

2014-11-14T01:23:12Z

Common conventions and best practices

← Older revision		Revision as of 01:23, 14 November 2014
Line 40:		Line 40:
	* {{tl\|VLC:latest version}} will show the latest version of VLC		* {{tl\|VLC:latest version}} will show the latest version of VLC
	* {{tl\|Font colour}}		* {{tl\|Font colour}}

	~~=== 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 ==		== See also ==

DoesItReallyMatter: /* The basics */ Commenting out a bit; condensing the rest

2014-11-14T01:22:22Z

The basics: Commenting out a bit; condensing the rest

← Older revision		Revision as of 01:22, 14 November 2014
Line 7:		Line 7:

	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 <abbr title="HyperText Markup Language">HTML</abbr>.<br />		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 <abbr title="HyperText Markup Language">HTML</abbr>.<br />
			<!-- doesn't seem too informative
	Commands to modify plain text include:		Commands to modify plain text include:
	* "tags" around words, for example <code><nowiki><big>example text</big></nowiki></code> to display <big>example text</big>		* "tags" around words, for example <code><nowiki><big>example text</big></nowiki></code> to display <big>example text</big>
Line 18:		Line 18:
	* making lists		* making lists
	* making tables		* making tables
	* using page headings to create sections		* using page headings to create sections-->

	~~=== If you have a minute... ===~~
	~~Begin by learning the basics. A [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one~~-~~page summary] and [//en.wikipedia.org/wiki/Help:Editing an extensive manual] are available at the English Wikipedia.~~

	~~=== To start~~ editing ~~right away~~... ~~===~~		If you have a minute, learn the basics of editing: a [//en.wikipedia.org/wiki/Wikipedia:Cheatsheet one-page summary] and [//en.wikipedia.org/wiki/Help:Editing an extensive manual] are available at the English Wikipedia.<br />
	~~Find~~ the Edit Toolbar directly above the edit box and use the buttons and the ~~"Help"~~ dropdown ~~to guide you~~.		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 ==		== Common conventions and best practices ==

DoesItReallyMatter: trim down documentation to avoid "Too long; didn't read" effect

2014-11-14T01:08:39Z

trim down documentation to avoid "Too long; didn't read" effect

← Older revision		Revision as of 01:08, 14 November 2014
Line 1:		Line 1:
	:''See also: [[Documentation:EditingGuidelines]]''		:''See also: [[Documentation:EditingGuidelines]]''
	Please follow these guidelines when editing this wiki.<br>		Please follow these guidelines when editing this wiki.<br />
	There will be more guidelines later.		There will be more guidelines later.

Line 6:		Line 6:
	:''Note: You can practice editing at the [[Sandbox\|Sandbox page]] whenever you like.''		:''Note: You can practice editing at the [[Sandbox\|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 <abbr title="HyperText Markup Language">HTML</abbr>.<br>		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 <abbr title="HyperText Markup Language">HTML</abbr>.<br />

	Commands to modify plain text include:		Commands to modify plain text include:
Line 34:		Line 34:
	* While making numbered lists, prefer list-making wikicode over manual lists; it makes managing large lists much easier		* 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		* 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 <u>''two new lines''</u> (a single new line will be ignored) or the HTML entity <code><nowiki><br></nowiki></code>		* 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>
	* 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		* 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
	* 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]]		* 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]]

	~~=== Remarks ===~~
	Nota bene or NB means "important note". It's a Latin/Italian phrase that is used very often around the wiki to indicate how a page is to be interpreted, for instance, remarking that the page documents ''past'' conventions. Generally, read this before anything else on the page.

	~~Most pages are written in loosely British English, rather than American English. Contribute in whatever style of English you feel comfortable writing in.~~

	=== Useful things ===		=== Useful things ===