Actions

JDOC

Difference between revisions of "Local wiki templates"

From Joomla! Documentation

m (Version Notice: clarity)
(Copyedit)
 
(11 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
==Incomplete Content Notice==
 
==Incomplete Content Notice==
 +
Use this notice to indicate a page or section is incomplete and missing key information. The {{tl|incomplete}} or {{tl|underconstruction}} are different. The {{tl|underconstruction}} template is used to note the page is not finished, but a contributor will be completing the page in the very near future.
 
Insert {{tl|incomplete}} to obtain the following notice:
 
Insert {{tl|incomplete}} to obtain the following notice:
{| cellspacing="0" cellpadding="0" style="margin:0em 0em 1em 0em; width:100%"
+
{{incomplete}}
| colspan="1" style="width:100%; vertical-align:top; text-align: center; border:1px solid #A0522D; background-color:#FFF8DC;" |
+
<div style="border-bottom:1px solid #A0522D; background-color:#F5DEB3; padding:0.2em 0.5em 0.2em 0.5em; font-size:130%; font-weight:bold;">Note</div>
+
<div style="text-align: center; padding:1em 5em 1em 1em;"> <!--Note: Top, right, bottom, left -->
+
Please note that the {{{1|content}}} on this page is currently incomplete.  Please treat it as a work in progress.
+
</div>
+
|}
+
 
+
==Standard License Notice==
+
Insert {{tl|license}} to obtain the following notice:
+
{{1}}{{license}}
+
  
 
==Page In Use Notice==
 
==Page In Use Notice==
Insert {{tl|inuse}} to obtain the following notice:
+
Use this notice should be used during '''Doc Sprints''' or if you will be editing a page for an extended period of time, e.g. more than 30 minutes. Please don't forget to remove it when you are done.
 +
Insert {{tl|inuse}} at the top of the page to obtain the following notice:
 
{{inuse|category=no}}
 
{{inuse|category=no}}
  
 
==Under Construction Notice==
 
==Under Construction Notice==
 +
The {{tl|underconstruction}} template is used to note the page is not finished, but a contributor will be completing the page in the very near future.
 
Insert {{tl|underconstruction}} to obtain the following notice:
 
Insert {{tl|underconstruction}} to obtain the following notice:
{{underconstruction|category=no}}
+
{{underconstruction}}
 +
 
 +
==Copyedit==
 +
Use: <nowiki>{{copyedit}}</nowiki>
 +
 
 +
{{copyedit}}
  
 
==Article Reviews and Needs==
 
==Article Reviews and Needs==
Line 31: Line 29:
 
{{page|needs more content}}Or use, '''<nowiki>{{page|needs images}}</nowiki>''' which would add the article to the [[:Category:Needs images]].
 
{{page|needs more content}}Or use, '''<nowiki>{{page|needs images}}</nowiki>''' which would add the article to the [[:Category:Needs images]].
 
{{page|needs images}}
 
{{page|needs images}}
==Request for Deletion Notice==
 
If you believe that a page should be deleted then please add {{tl|delete}} at the top of the page.  You should add a reason for the wanting to delete the page, like this: '''<nowiki>{{delete|Content now included in [[this page]]}}</nowiki>'''
 
 
 
==Joomla Version Icons==
 
==Joomla Version Icons==
 
To indicate availability of a class, method or some piece of functionality in or from a particular version of Joomla, you can use the {{tl|JVer}} template.  Only certain specific version numbers are supported:
 
To indicate availability of a class, method or some piece of functionality in or from a particular version of Joomla, you can use the {{tl|JVer}} template.  Only certain specific version numbers are supported:
Line 61: Line 56:
 
|<nowiki>{{JVer|2.5}}</nowiki>: {{JVer|2.5}}
 
|<nowiki>{{JVer|2.5}}</nowiki>: {{JVer|2.5}}
 
|<nowiki>{{JVer|2,5|Joomla 2.5|long}}</nowiki>: {{JVer|2.5|Joomla 2.5|long}}
 
|<nowiki>{{JVer|2,5|Joomla 2.5|long}}</nowiki>: {{JVer|2.5|Joomla 2.5|long}}
 +
|-
 +
|CMS 3.x
 +
|<nowiki>{{JVer|3.x}}</nowiki>: {{JVer|3.x}}
 +
|<nowiki>{{JVer|3.x|Joomla 3.x|long}}</nowiki>: {{JVer|3.x|Joomla 3.x|long}}
 
|-
 
|-
 
|CMS 3.0
 
|CMS 3.0
 
|<nowiki>{{JVer|3.0}}</nowiki>: {{JVer|3.0}}
 
|<nowiki>{{JVer|3.0}}</nowiki>: {{JVer|3.0}}
 
|<nowiki>{{JVer|3.0|Joomla 3.0|long}}</nowiki>: {{JVer|3.0|Joomla 3.0|long}}
 
|<nowiki>{{JVer|3.0|Joomla 3.0|long}}</nowiki>: {{JVer|3.0|Joomla 3.0|long}}
 +
|-
 +
|CMS 3.1
 +
|<nowiki>{{JVer|3.1}}</nowiki>: {{JVer|3.1}}
 +
|<nowiki>{{JVer|3.1|Joomla 3.1|long}}</nowiki>: {{JVer|3.1|Joomla 3.1|long}}
 
|-
 
|-
 
|Platform
 
|Platform
Line 108: Line 111:
 
|}
 
|}
  
For more information on use, specifically the long version icon use, please see, {{tl|Jver/multi}}
+
For more information on use, specifically the long version icon use, please see, {{tl|JVer/multi}}
  
 
==Table of Contents==
 
==Table of Contents==
You will get a table of contents box on each page by default as soon as you start making use of headings and subheadings on the page.  The default table of contents box is located on the left and text does not flow around it.  You can make the table of contents box float right by inserting '''{{tlp|RightTOC}}''' at the appropriate place in your page.  You can also suppress the table of contents box altogether by inserting '''<nowiki>__NOTOC__</nowiki>''' at the top of the page.
+
You will get a table of contents(TOC) box on each page by default as soon as you make 4 or more headings and subheadings on the page. As an example, please look at the one you see on this page.  The default table of contents box is located on the right and text will flow around it.   
 +
*You can force the table of contents in the location you add the text: '''<nowiki>__TOC__</nowiki>'''  
 +
*Alternatively, you can suppress the table of contents box by adding anywhere on the page: '''<nowiki>__NOTOC__</nowiki>'''
 +
 
 +
==Organisational Templates==
 +
Used to mark articles for deletion, merging or version splitting.
 +
 
 +
===Delete===
 +
Use the template {{tlx|delete|<reason text>}} on the very top of the page.
 +
{{delete|This marker is just an example of use.}}
 +
 
 +
===Merge===
 +
Use the template {{tlx|merge||title of target page}} on the very top of the page.
 +
{{merge|JDOC:Local wiki templates}}
 +
 
 +
===JSplit===
 +
Use the template {{tl|JSplit}} on the very top of the page.
 +
{{JSplit}}
 +
 
 +
===Split===
 +
Use the template {{tlx|split|<reason for splitting>}} on the very top of the page.
 +
{{split|This page is too long and hard to follow.}}
  
 
==Version Notice==
 
==Version Notice==
Line 125: Line 149:
  
 
This helps readers know what version the information references and aids in version icon(s) inclusion in lists of articles and tutorials. For more information and how to use extended features of this template, please see {{tl|version}} template documentation.
 
This helps readers know what version the information references and aids in version icon(s) inclusion in lists of articles and tutorials. For more information and how to use extended features of this template, please see {{tl|version}} template documentation.
 +
 +
==Standard License Notice==
 +
Insert {{tl|license}} to obtain the following notice:
 +
{{1}}{{license}}
  
 
==Shortcuts, Links &amp; Navigation==
 
==Shortcuts, Links &amp; Navigation==

Latest revision as of 10:23, 24 April 2014

Local wiki templatesLocal wiki extensionsLocal interwiki links

MediaWiki templates should not to be confused with Joomla! templates! MediaWiki templates are "boiler-plate" items that can be included in your wiki pages by inserting a simple reference.

Contents

Incomplete Content Notice

Use this notice to indicate a page or section is incomplete and missing key information. The {{incomplete}} or {{underconstruction}} are different. The {{underconstruction}} template is used to note the page is not finished, but a contributor will be completing the page in the very near future. Insert {{incomplete}} to obtain the following notice:

Quill icon.png
Content is Incomplete

This project page or section is incomplete, which means it may be lacking information. You are welcome to assist in its completion by editing it as well. If this project page or section has not been edited in several days, please consider helping complete the content.
This page was last edited by GreyHead (talk| contribs) 2 months ago. (Purge)


Page In Use Notice

Use this notice should be used during Doc Sprints or if you will be editing a page for an extended period of time, e.g. more than 30 minutes. Please don't forget to remove it when you are done. Insert {{inuse}} at the top of the page to obtain the following notice:

Quill icon.png
Page Actively Being Edited!

This project page is actively undergoing a major edit for a short while.
As a courtesy, please do not edit this page while this message is displayed. The user who added this notice will be listed in the page history. This message is intended to help reduce edit conflicts; please remove it between editing sessions to allow others to edit the page. If this page has not been edited for several hours, please remove this template, or replace it with {{underconstruction}} or {{incomplete}}.

Under Construction Notice

The {{underconstruction}} template is used to note the page is not finished, but a contributor will be completing the page in the very near future. Insert {{underconstruction}} to obtain the following notice:

Documentation all together tranparent small.png
Under Construction

This project page or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well. If this project page or section has not been edited in several days, please remove this template.
This page was last edited by GreyHead (talk| contribs) 2 months ago. (Purge)


Copyedit

Use: {{copyedit}}

Copyedit.png
This Page Needs Copy Editing

This article has been tagged and requires copy editing for grammar, style, cohesion, tone, or spelling. Please help maintain and improve our documentation by editing it.


Article Reviews and Needs

Once you're done with editing please replace {{underconstruction}} and {{inuse}} with {{review}}. This will add your document to the Category:Needs review.

Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS REVIEW. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


You can also use the {{page}} notice if the page needs review or something other than a review.
Examples are:{{page|needs more content}} which would add the article to the Category:Needs more content.

Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS MORE CONTENT. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


Or use, {{page|needs images}} which would add the article to the Category:Needs images.

Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS IMAGES. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


Joomla Version Icons

To indicate availability of a class, method or some piece of functionality in or from a particular version of Joomla, you can use the {{JVer}} template. Only certain specific version numbers are supported:

Version Short icon Long icon
CMS 1.0 {{JVer|1.0}}: Joomla 1.0 {{JVer|1.0|Joomla 1.0|long}}: Joomla 1.0
CMS 1.5 {{JVer|1.5}}: Joomla 1.5 {{JVer|1.5|Joomla 1.5|long}}: Joomla 1.5
CMS 1.6 {{JVer|1.6}}: Joomla 1.6 {{JVer|1.6|Joomla 1.6|long}}: Joomla 1.6
CMS 1.7 {{JVer|1.7}}: Joomla 1.7 {{JVer|1.7|Joomla 1.7|long}}: Joomla 1.7
CMS 2.5 {{JVer|2.5}}: Joomla 2.5 {{JVer|2,5|Joomla 2.5|long}}: Joomla 2.5
CMS 3.x {{JVer|3.x}}: Joomla 3.x {{JVer|3.x|Joomla 3.x|long}}: Joomla 3.x
CMS 3.0 {{JVer|3.0}}: Joomla 3.0 {{JVer|3.0|Joomla 3.0|long}}: Joomla 3.0
CMS 3.1 {{JVer|3.1}}: Joomla 3.1 {{JVer|3.1|Joomla 3.1|long}}: Joomla 3.1
Platform {{JVer|Platform}}: Joomla Platform Not available
Platform 11.1 {{JVer|11.1}}: Joomla 11.1 Not available
Platform 11.2 {{JVer|11.2}}: Joomla 11.2 Not available
Platform 11.3 {{JVer|11.3}}: Joomla 11.3 Not available

By default the alt tag generated will be the same as the version number, prefixed with the word "Joomla". You can override this default by adding a second parameter. For example, to get an alt tag of "Only available in Joomla 1.5" you should use {{JVer|1.5|Only available in Joomla 1.5}} which produces this: Only available in Joomla 1.5

Full documentation on the JVer template can be found here.

You can also use the {{JVer/multi}} Template to place multiple version icons.

Versions Short icon Long icon
CMS Versions {{JVer/multi|1.0,1.5}}:  Joomla 1.0 Joomla 1.5 {{JVer/multi|1.6,1.7,2.5|Joomla Version|long}}:  Joomla Version Joomla Version Joomla Version
Platform {{JVer/multi|11.1,11.2}}:  Joomla 11.1 Joomla 11.2 Not Available
Mix CMS/Platform {{JVer/multi|1.7,11.2}}:  Joomla 1.7 Joomla 11.2 Not Available

For more information on use, specifically the long version icon use, please see, {{JVer/multi}}

Table of Contents

You will get a table of contents(TOC) box on each page by default as soon as you make 4 or more headings and subheadings on the page. As an example, please look at the one you see on this page. The default table of contents box is located on the right and text will flow around it.

  • You can force the table of contents in the location you add the text: __TOC__
  • Alternatively, you can suppress the table of contents box by adding anywhere on the page: __NOTOC__

Organisational Templates

Used to mark articles for deletion, merging or version splitting.

Delete

Use the template {{delete|<reason text>}} on the very top of the page.

Delete-icon.png
This Page is a Candidate for Deletion

This page is a candidate for deletion. The given reason is: This marker is just an example of use. This notice should remain for a minimum of 1 week after it was placed on the page. If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on its associated talk page, as applicable. Remember to check if anything links here and the page history before deleting. Last edit by GreyHead (talk · contrib) · Last edited on Thu, 24 Apr 2014 10:23:59 +0000


Merge

Use the template {{merge|title of target page}} on the very top of the page.

Merge-icon.png
Merge Notice

It has been suggested that this article or section be merged with JDOC:Local wiki templates. (Discuss). Proposed since 2 months ago.


JSplit

Use the template {{JSplit}} on the very top of the page.

Split-icon.png
Split Page into Specific Joomla! Versions - J2.5 and J3.1

It has been suggested that this article or section be split into specific version Namespaces. (Discuss). If version split is not obvious, please allow split request to remain for 1 week pending discussions. Proposed since 2 months ago.


Split

Use the template {{split|<reason for splitting>}} on the very top of the page.


Version Notice

If an article is written for a specific Joomla! Version, please use the {{version}} template. It should be placed at the very top(first of all wiki markup) of an article so a person will see what version the page is relevant to. For example: {{version|1.6,1.7,2.5}} will place this:



If the article is a tutorial or part of a Tutorial Series, please use the {{version/tutor|1.5}} template, which will show this:


This helps readers know what version the information references and aids in version icon(s) inclusion in lists of articles and tutorials. For more information and how to use extended features of this template, please see {{version}} template documentation.

Standard License Notice

Insert {{license}} to obtain the following notice:


License

The contents of this wiki are subject to copyright law and are made available under the Joomla! Electronic Documentation License (JEDL) unless otherwise stated. You may find the JEDL Frequently Asked Questions useful in determining if your proposed use of this material is allowed. If you have any questions regarding licensing of this material please contact legal@opensourcematters.org. If you wish to report a possible violation of the license terms for the material on this site then please contact legal@opensourcematters.org.

Shortcuts, Links & Navigation

Some URLs can become utterly long, some are ugly, and some are just tedious to type over and over again. Adding categories to a page can become equally annoying.

To simplify your job try some of the following templates. Similar to the interwikis, they're true keystroke-savers:

  • {{jsite|keyword}}, for example:
{{jsite}} = www.joomla.org
{{jsite|forum}} = forum.joomla.org
{{jsite|ext}} = extensions.joomla.org. For more see {{jsite}}.
  • {{jforum|keyword}}, shortcuts for the many Working Group fora, i.e.
{{jforum}} = forum.joomla.org
{{jforum|doc}} = Documentation forum
{{jforum|devdoc}} = Developer Documentation forum. For more see {{jforum}}.

See also: