Template

Inuse/doc: Difference between revisions

From Joomla! Documentation

< Template:Inuse
CirTap (talk | contribs)
1,176 edits
mNo edit summary
 
CirTap (talk | contribs)
1,176 edits
mNo edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
'''''NB:''' This is not an article template. Therefore, it is not to be placed on articles.
Adds the depicted message box to prevent [[Help:edit conflict|edit conflict]]s.


This ''template message'' indicates the template is currently being edited or short, it is ''in use''.
The template should not be misused to "lock" drafts from being edited by others. New pages that are known to need editing for a long time are better created first as a user subpage, and if ''useable'' or ready for {{tl|review}}, copied to the designated page.


Template development can be time consuming and many complex templates often rely on other (sub-)templates to provide a certain look and feel or functionality.
==Usage==
*{{tlx|inuse}} for the default template
*{{tlx|inuse|end of {{CURRENTMONTHNAME}}}} to include a timeframe
*{{tlx|inuse|category&#61;no}} to ommit the category


If you happen to create such a complex template incl. it's helpers, please add this message while you're developing the code. This helps others to avoid using incompleted templates.
== Parameters ==
<includeonly>{{wikipedia template}}[[Category:Marker templates|{{PAGENAME}}]]</includeonly>
{|class="prettytable parameters"
|-
!Parameter
!Parameter description
!req./opt.
|-
|<nowiki>{{{1}}}</nowiki>
|to replace "&hellip; ''a short while''" in the caption with an estimate how long the page is "in use"
|class="req"|required
|}
 
== Notes ==
The ''page type'' of the category name is based on the result of {{lt|thingamabob}}
 
<!-- edit *calling* TEMPLATE CATEGORIES BELOW THIS LINE
  noteworthy: [[Category:Wiki templates using Extensions]]
-->
<includeonly>{{wikipedia template}}
[[Category:Marker templates|{{PAGENAME}}]]
</includeonly>

Latest revision as of 14:38, 11 May 2008

This is a documentation subpage for Template:Inuse.
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:Inuse.

Adds the depicted message box to prevent edit conflicts.

The template should not be misused to "lock" drafts from being edited by others. New pages that are known to need editing for a long time are better created first as a user subpage, and if useable or ready for {{review}}, copied to the designated page.

Usage

  • {{inuse}} for the default template
  • {{inuse|end of April}} to include a timeframe
  • {{inuse|category=no}} to ommit the category

Parameters

Parameter Parameter description req./opt.
{{{1}}} to replace "… a short while" in the caption with an estimate how long the page is "in use" required

Notes

The page type of the category name is based on the result of Template:Thingamabob (edit|talk|history|links|watch|logs)


Retrieved from "https://docs.sandbox.joomla.org/index.php?title=Template:Inuse/doc&oldid=6792"