Template:Archived/doc - Revision history

Tom Hutchison: syntax

2012-11-29T14:59:05Z

syntax

← Older revision		Revision as of 14:59, 29 November 2012
Line 60:		Line 60:
	* You must retrieve the REVISION ID of the page before use, otherwise the link to the archived version WILL NOT work.		* You must retrieve the REVISION ID of the page before use, otherwise the link to the archived version WILL NOT work.

	To find the REVISION ID, use the page history link, then choose the page to show as the last known state. This will generally be at the top, ~~just~~ click the link shown with time and date.		To find the REVISION ID, use the page's '''View history''' link, then choose the page to show as the last known state. This will generally be the one at the top, which is the current version of the page. Then click the link shown with time and date.
	<pre>		<pre>
	(cur \| prev) 23:04, 25 November 2012‎ AnyUser(Talk \| contribs \| block)‎ . . (+1,438)‎ . . (doc page, will improve)		(cur \| prev) 23:04, 25 November 2012‎ AnyUser(Talk \| contribs \| block)‎ . . (+1,438)‎ . . (doc page, will improve)
Line 67:		Line 67:
	click here		click here
	</pre>		</pre>
	This will show ~~you~~ page in historical REVISION ID format. The REVISION ID is at the very end of your bowser's address bar shown as <code>&oldid=</code> some number.		This will show a page in historical REVISION ID format. The REVISION ID is at the very end of your bowser's address bar shown as <code>&oldid=</code> some number.
	<pre>		<pre>
	http://docs.joomla.org/index.php?title=Template:Archived/doc&oldid=77774		http://docs.joomla.org/index.php?title=Template:Archived/doc&oldid=77774

Tom Hutchison: category fix for Template

2012-11-29T14:56:38Z

category fix for Template

← Older revision		Revision as of 14:56, 29 November 2012
Line 77:		Line 77:
	-->		-->
	<includeonly>		<includeonly>
	[[Category:Marker ~~Template~~\|{{PAGENAME}}]]		[[Category:Marker templates\|{{PAGENAME}}]]
	</includeonly>		</includeonly>

Tom Hutchison: final documentation for archive template use

2012-11-29T14:55:29Z

final documentation for archive template use

← Older revision		Revision as of 14:55, 29 November 2012
Line 1:		Line 1:
	{{documentation subpage}}		{{documentation subpage}}
	Easily archive pages no longer needed or of duplicated content. Options include adding links to relevant page(s).		Easily archive pages no longer needed or of duplicated content. Options include adding links to relevant page(s) - limited to 2 and archive categories inclusions. Should not be used as a substitute for a page in need of actual deletion.

	== Functions/Features ==		== Functions/Features ==
	~~Describe its features ...~~		* Information box
			**Generic message or stated reason for the page being archived
			**Page links to more relevant or current page
			**Link to view the page's last state with content before being archived
			* Automated category inclusion or creation

	== Usage ==		== Usage ==
	~~Provide examples such as ....~~		<pre>
	* via {{tl\|tl}} ~~for templates w/o params~~: {{tl\|~~template name\|foo~~}}		{{archived\|(revision ###)}} - default categorisation will be [[Category:Archived pages]]
	* via {{tl\|~~tlx~~}} ~~for templates~~ with ~~params & complex output~~: {{~~tlx~~\|~~template name~~\|~~foo~~\|~~param=bar~~}}		Example:
	* via {{tl\|~~xpd~~}} ~~for templates with simple & output:~~ {{~~xpd~~\|template ~~name~~\|~~foo\|param=bar~~}}		{{archived\|77774}} will show this documentation's pages last revision if you
			click the link to see the page before archival.
			</pre>
			{{archived\|77774}}
			<pre>
			Include more information with:
			\|Page called Foo - parameter {{{2\|}}
			\|Page called Foo2 - parameter {{{3\|}}}
			\|reason=This page has not been maintained since 2007
			\|cat=Foo,Foo2,Foo3 (use an array, comma separated to include archive categories
			Example:
			{{archived\|77774\|Foo\|Foo2\|reason=Showing how to use this template.\|cat=Foo,Foo2,Foo3}}
			</pre>
			{{archived\|77774\|Foo\|Foo2\|reason=Showing how to use this template.\|cat=Foo,Foo2,Foo3}}

	== Parameters ==		== Parameters ==
	{\|class="prettytable parameters"		{\|class="prettytable parameters" style="width:60%;"
	\|-		\|-
	!Parameter		!Parameter
Line 19:		Line 36:
	\|-		\|-
	\|<nowiki>{{{1}}}</nowiki>		\|<nowiki>{{{1}}}</nowiki>
	\|~~description~~ of ~~unnamed parameter 1~~		\|Revision ID of the last page state
	\|~~class~~="~~req~~"\|required		\|style="background-color:#330; color:white;"\|required
	\|-		\|-
	\|<nowiki>{{{~~foobar~~}}}</nowiki>		\|<nowiki>{{{2}}}</nowiki>
	\|~~Default~~: "~~batbaz~~"~~. Description of named parameter 'foobar'~~		\|1st link to relevant page
			\|class="opt"\|optional
			\|-
			\|<nowiki>{{{3}}}</nowiki>
			\|2nd link to relevant page
			\|class="opt"\|optional
			\|-
			\|<nowiki>{{{reason}}}</nowiki>
			\|style="width:60%;"\|Override default reason: This page has not been maintained in some time, or no longer contains information relevant or current. It may also contain information which is duplicated or contains historical content.
			\|class="opt"\|optional
			\|-
			\|<nowiki>{{{cat}}}</nowiki>
			\|categorisation using array format - Foo,Foo1,Foo2
	\|class="opt"\|optional		\|class="opt"\|optional
	\|}		\|}

	== Known Issues ==		== Known Issues ==
	~~Include notes about ...~~		Dependencies:
	* ~~dependencies (templates~~, ~~extensions, assets)~~		* You must retrieve the REVISION ID of the page before use, otherwise the link to the archived version WILL NOT work.
	* limitations, technical probs, namespace restrictions
	* rendering issues

	~~== See also ==~~		To find the REVISION ID, use the page history link, then choose the page to show as the last known state. This will generally be at the top, just click the link shown with time and date.
	~~Provide links to~~ ...		<pre>
	* related templates		(cur \| prev) 23:04, 25 November 2012‎ AnyUser(Talk \| contribs \| block)‎ . . (+1,438)‎ . . (doc page, will improve)
	* supplemental documentation		/ \
	* style guides		\|
	* example pages		click here
			</pre>
			This will show you page in historical REVISION ID format. The REVISION ID is at the very end of your bowser's address bar shown as <code>&oldid=</code> some number.
			<pre>
			http://docs.joomla.org/index.php?title=Template:Archived/doc&oldid=77774
			</pre>

	~~== Stylesheet ==~~
	~~Provide CSS selectors ... for [[MediaWiki::joomla.css]] (or [[MediaWiki::common.css]])~~
	~~some.class~~

	<!-- REMOVE BLANKS in includeonly-tags and edit calling TEMPLATE CATEGORIES BELOW THIS LINE		<!-- REMOVE BLANKS in includeonly-tags and edit calling TEMPLATE CATEGORIES BELOW THIS LINE
Line 48:		Line 77:
	-->		-->
	<includeonly>		<includeonly>
	[[Category:~~Wiki Templates~~\|{{PAGENAME}}]]		[[Category:Marker Template\|{{PAGENAME}}]]
	</includeonly>		</includeonly>

Tom Hutchison: doc page, will improve

2012-11-26T04:04:22Z

doc page, will improve

New page

{{documentation subpage}}
Easily archive pages no longer needed or of duplicated content. Options include adding links to relevant page(s).

== Functions/Features ==
Describe its features ...

== Usage ==
Provide examples such as ....
* via {{tl|tl}} for templates w/o params: {{tl|template name|foo}}
* via {{tl|tlx}} for templates with params & complex output: {{tlx|template name|foo|param=bar}}
* via {{tl|xpd}} for templates with simple & output: {{xpd|template name|foo|param=bar}}

== Parameters ==
{|class="prettytable parameters"
|-
!Parameter
!Parameter description
!req./opt.
|-
|<nowiki>{{{1}}}</nowiki>
|description of unnamed parameter 1
|class="req"|required
|-
|<nowiki>{{{foobar}}}</nowiki>
|Default: "batbaz". Description of named parameter 'foobar'
|class="opt"|optional
|}

== Known Issues ==
Include notes about ...
* dependencies (templates, extensions, assets)
* limitations, technical probs, namespace restrictions
* rendering issues

== See also ==
Provide links to ...
* related templates
* supplemental documentation
* style guides
* example pages

== Stylesheet ==
Provide CSS selectors ... for [[MediaWiki::joomla.css]] (or [[MediaWiki::common.css]])
some.class


<includeonly>
[[Category:Wiki Templates|{{PAGENAME}}]]
</includeonly>