Template

Difference between revisions of "Underconstruction/doc"

From Joomla! Documentation

< Template:Underconstruction
m
m
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
−
Pages tagged with this template are automatically added to the category <nowiki>[[:Category:"namespace item" actively undergoing construction]]</nowiki> wheras "''namespace item''" is based on the <nowiki>{{NAMESPACE}}</nowiki> the template is used at, i.e. for {{ns:help}} "Help contents", {{ns:Framework}} "Framework pages", and alike.
+
Display a (very) prominent "underconstruction" message to prevent edit conflicts while a page is undergoing larger or complex changes. The page is also added to the maintenace category [[:Category:Articles actively undergoing construction]]
−
Pages from a _talk namespace will appear in [[:Category:Articles actively undergoing construction]] unless the optional parameter <tt>category</tt> is used (see below).
 
  
−
==Parameters==
+
== Functions/Features ==
−
;notready
 
−
: If used on a non-article page which is not yet ready for use, type {{tlx|Underconstruction|notready&#61;true}}. That will produce the following:
 
−
<noinclude>{{underconstruction|notready=true}}</noinclude>
 
−
;category:
 
−
: alternative category link
 
−
==See also==
 
−
*{{tlp|inuse}} tags ''a template'' as "in use" for editing
 
−
{{ambox/pagelinks|underconstruction}}
 
  
−
<includeonly>{{wikipedia template}}[[Category:Marker templates|{{PAGENAME}}]]</includeonly>
+
== Usage ==
 +
<!-- examples should be given using any of the following formats -->
 +
;{{tlx|underconstruction}}
 +
:the default message box
 +
;{{tlx|underconstruction|2=notready=message text}}
 +
:additional text
 +
;{{tlx|underconstruction|2=placedby=wiki user}}
 +
:name of the wiki user who added this box.
 +
 
 +
== Parameters ==
 +
{|class="wikitable"
 +
|-
 +
!Parameter Name
 +
!Parameter Description
 +
!req./opt.
 +
|-
 +
|<nowiki>{{{notready}}}</nowiki>
 +
|description of unnamed parameter 1
 +
|'''Optional'''
 +
|-
 +
|<nowiki>{{{placedby}}}</nowiki>
 +
|description of named parameter 'foobar'
 +
|'''Optional.'''
 +
|-
 +
|<nowiki>{{{category}}}</nowiki>
 +
|place page in this ''maintenance category'' instead of the default [[:Category:Articles actively undergoing construction]]
 +
|'''Optional.'''
 +
|}
 +
 
 +
<!-- REMOVE BLANKS in includeonly-tags and edit *calling* TEMPLATE CATEGORIES BELOW THIS LINE -->
 +
<includeonly>[[Category:Marker templates|{{PAGENAME}}]]</includeonly>

Revision as of 11:32, 1 May 2008

This is a documentation subpage for Template:Underconstruction.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Underconstruction.

Display a (very) prominent "underconstruction" message to prevent edit conflicts while a page is undergoing larger or complex changes. The page is also added to the maintenace category Category:Articles actively undergoing construction

Functions/Features[edit]

Usage[edit]

{{underconstruction}}
the default message box
{{underconstruction|notready=message text}}
additional text
{{underconstruction|placedby=wiki user}}
name of the wiki user who added this box.

Parameters[edit]

Parameter Name Parameter Description req./opt.
{{{notready}}} description of unnamed parameter 1 Optional
{{{placedby}}} description of named parameter 'foobar' Optional.
{{{category}}} place page in this maintenance category instead of the default Category:Articles actively undergoing construction Optional.


Retrieved from "https://docs.joomla.org/index.php?title=Template:Underconstruction/doc&oldid=5677"