Editing
Template:Documentation/doc
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
==Usage== Normally, this template is used without any parameters, and is placed at the bottom of the template page or other page being documented, within a {{tag|noinclude}} container: <syntaxhighlight lang="xml+smarty"> <!--Last line of your template code--><noinclude> {{Documentation}} <!-- Add categories to the /doc subpage --> </noinclude> </syntaxhighlight> Then, this template automatically loads the content from the /doc subpage of the template it is used on. This template can also load the content from any other page. For example: <syntaxhighlight lang="xml+smarty"> <!--Last line of your template code--><noinclude> {{Documentation |Template:Other page/doc}} </noinclude> </syntaxhighlight> Note that when loading the documentation from a page other than the local /doc subpage, it becomes tricky to handle the categories. The content can also be fed directly as text. For example: <syntaxhighlight lang="xml"> <!--Last line of your template code--><noinclude> {{Documentation | content = <!-- template documentation --> }}</noinclude> </syntaxhighlight> When the {{para|content}} parameter is used, the doc box normally does not show the [edit] [purge] links in the top right corner. Note that if the /doc page exists, a link to it is still shown in the link box below the doc box. Parameter {{para|1}} and the {{para|content}} parameter can also be combined, for example: <syntaxhighlight lang="xml"> <!--Last line of your template code--><noinclude> {{Documentation |1=Template:Any page/doc | content = <!-- {{Template:Any page/doc |parameters}} --> }}</noinclude> </syntaxhighlight> Then, the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But, the '''content''' parameter is used for the content shown in the doc box. The above code means that the content is transcluded as {{tnull|Template:Any page/doc{{!}}parameters}}. In this example, a parameter is also fed to the /doc page being loaded.
Edit summary
(Briefly describe your changes)
Please note that all contributions to A2wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
A2wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Template
Discussion
English
Views
Read
Edit source
View history
More
Search
Navigation
Main page
Current events
Random page
About A2wiki
interaction
Help
Community portal
Recent changes
Upload file
Tools
What links here
Related changes
Special pages
Page information