Help:List of COLLADA wiki templates: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
Elf (talk | contribs)
organizing page to match new template categories, part 1
Elf (talk | contribs)
moving msg templates, add underconstr
Line 7: Line 7:
|-
|-
!width=20%| What to type !!width=55%| What it produces !! Where to put it
!width=20%| What to type !!width=55%| What it produces !! Where to put it
|-
| {{tplinkarg|delete |arg=reason=''why to delete''}}
| <div>{{delete|reason=why to delete}}</div>
| ''Top''<br />of articles that you'd like a [[sysop]] to delete.
|-
| {{tplink|disambig}}
| <div>{{disambig}}</div>
----''Note: this template also places the article in [[:Category:Disambiguation]]''
| ''Bottom''<br />of articles that disambiguate terms that could have various meanings ([[disambiguation]] pages).
|-
| {{tplinkarg|editor |arg=what=''what needs attention''}}
| <div>{{editor|what=what needs attention}}</div>
| ''Inside''<br /> articles at location where an editor needs to address an issue.
|-
|-
| {{tplink|stub}}
| {{tplink|stub}}
Line 12: Line 25:
| ''Bottom''<br />of articles that need more info.
| ''Bottom''<br />of articles that need more info.
|-
|-
| {{tplinkarg|editor |arg=what=''what needs attention''}}
| {{tplink|underconstruction}}
| <div>{{editor|what=what needs attention}}</div>
| <div>{{underconstruction}}</div>
| ''Inside''<br /> articles at location where an editor needs to address an issue.
| Pages actively being worked on. Please don't leave these lying around if you're not working on the page.
|}
|}


Line 49: Line 62:
|-
|-
| {{tplinkarg|Extensions|arg=n/a }}
| {{tplinkarg|Extensions|arg=n/a }}
| <div>{{Extensions}}</div>  obsolete
|   obsolete
| Use Template:Extension
| Use Template:Extension
|-  
|-  
Line 74: Line 87:
----''Note: this template fills in name of category, not "COLLADA wiki templates"''
----''Note: this template fills in name of category, not "COLLADA wiki templates"''
| ''Top''<br />of image Category pages.
| ''Top''<br />of image Category pages.
|-
| {{tplink|disambig}}
| <div>{{disambig}}</div>
----''Note: this template also places the article in [[:Category:Disambiguation]]''
| ''Bottom''<br />of articles that disambiguate terms that could have various meanings ([[disambiguation]] pages).
|-
|-
|{{tplinkarg|portalheader|arg = various arguments  }}
|{{tplinkarg|portalheader|arg = various arguments  }}
Line 94: Line 102:
|-
|-
!width=20%| What to type !!width=55%| What it produces !! Where to put it
!width=20%| What to type !!width=55%| What it produces !! Where to put it
|-
| {{tplinkarg|delete |arg=reason=''why to delete''}}
| <div>{{delete|reason=why to delete}}</div>
| ''Top''<br />of articles that you'd like a [[sysop]] to delete.
|}
|}



Revision as of 19:03, 23 February 2009

This page contains details of Wiki templates currently defined in this COLLADA wiki.

User templates

Any template can be used by anyone, but these are more likely to be of general use to a general user.

Message templates

What to type What it produces Where to put it
{{delete | reason=why to delete }}
Sysop, please delete this page. Reason: why to delete
Top
of articles that you'd like a sysop to delete.

{{disambig}}


Note: this template also places the article in Category:Disambiguation
Bottom
of articles that disambiguate terms that could have various meanings (disambiguation pages).
{{editor | what=what needs attention }}

((EDITOR: This page needs the following improvement: what needs attention ))

Inside
articles at location where an editor needs to address an issue.

{{stub}}

This article is a stub; it could use more information. Please help by supplying sufficient info for purposes of this wiki.
Bottom
of articles that need more info.

{{underconstruction}}

Pages actively being worked on. Please don't leave these lying around if you're not working on the page.

Formatting templates

What to type What it produces Where to put it
{{highlight | text to highlight }}
text to highlight
Enclose text to highlight as an argument
{{notice | text to format as notice }}

text to format as notice

Enclose text (doesn't work in all contexts because it's a table)

{{prettytable}}

border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show;"
On first line of table definition

{{=}}

=
Inside templates where an = character is needed

Extensions templates

What to type What it produces Where to put it
{{Extension | various arguments }}
Extension information
  • Purpose: unstated
  • Company(s): unstated
  • Product(s): unstated
  • Last updated: unstated
  • Contact for technical issues:
This article is part of the COLLADA extensions directory
Adding to the extensions directory
note see the template itself for details about the arguments
Top
of each article that describes a COLLADA extension.
{{Extensions | n/a }} obsolete Use Template:Extension

{{Extensions header}}

Extensions directory
Information about COLLADA <technique profile=...> and <extra> extensions.
This article is part of the COLLADA extensions directory.

List of extensions by vendor • List of extensions by profile name • List of extensions by element

Instructions for adding to the extensions directory

[[Category: ]]
Top
of articles that summarize or collect info on extensions.

Site templates

These templates are used in the construction of other templates, for more specific system administration or page construction, or are otherwise less likely to be of use to a general user.

General navigation templates

What to type What it produces Where to put it
{{addtocategory | description }}

The following is an automatically collected, alphabetic list of subcategories and articles that have been flagged as pertaining to this category. To add an article to this list, add the following to the end of the article:

[[Help:List of COLLADA wiki templates]]

Note: this template fills in name of category, not "COLLADA wiki templates"
Top
of Category pages.

{{addimagetocategory}}

To add an image to this list, just add the following to the end of the image's description page:

[[Help:List of COLLADA wiki templates]]

Note: this template fills in name of category, not "COLLADA wiki templates"
Top
of image Category pages.
{{portalheader | various arguments }}
Welcome to the {{{title}}} portal
{{{description}}}

Portals:  • Products  • Extensions  • Tools  • Conditioners  • COLLADA DOM  • Coherency Test  • Tech topics  • Tutorials
Top of portal pages.

{{helpTOC}}

Top of Help articles.

System administration templates

What to type What it produces Where to put it

Tutorial templates

What to type What it produces Where to put it

{{DOM navigation}}

COLLADA DOM - Version 2.4 Historical Reference
List of main articles under the DOM portal.
User Guide chapters:  • Intro  • Architecture  • Setting up  • Working with documents  • Creating docs  • Importing docs  • Representing elements  • Working with elements  • Resolving URIs  • Resolving SIDs  • Using custom COLLADA data  • Integration templates  • Error handling

Systems:  • URI resolver  • Meta  • Load/save flow  • Runtime database  • Memory • StringRef  • Code generator
Additional information:  • What's new  • Backward compatibility  • Future work
Terminology categories:  • COLLADA  • DOM  • XML

Bottom
of articles that are part of the Portal:COLLADA DOM.

{{ClassElement}}

See template documentation
When used with "subst:"prefix ({{subst:ClassElement}}), fills in outline and sample text to get started on an article about a class or an element.

{{TutorialSample}}

See template documentation
When used with "subst:"prefix ({{subst:TutorialSample}}), fills in outline and sample text to get started on a how-to (tutorial) article .

{{Domsub}}

See template documentation
Note: This template is probably obsolete. When used with "subst:"prefix ({{subst:Domsub}}), fills in outline and sample text to get started on an article about a subsystem.
{{DOMversion | {{{arg}}} }}
DOM 1.3 This revision of this article is current for COLLADA DOM version 1.3.

See DOM 1.3 documentation for all related articles.
See Portal:COLLADA DOM for other documentation versions.

Put at top of DOM tutorial articles to indicate what version the page is current for.

{{Tutorials}}

Tutorials
This article is one several tutorials, guides, and annotated examples available in this wiki.
Multipage tutorials:  • COLLADA DOM user guide
Shorter how-tos:  • Using accessors  • Schema validation • Using URIs
 • Various annotated examples

Instructions for adding a tutorial

[[Category: ]]
Top of tutorial article or first in related set of articles forming a single tutorial.

Templates for constructing templates and similar underpinnings

What to type What it produces Where to put it
{{NavigationBox | various arguments }}
{{{Title}}}
{{{Summary}}}
{{{List}}}
[[Category: ]]
note see the template itself for details about the arguments
General format for creating navigation boxes such as Template:DOM navigation

{{Tplink}}

{{[[:Template:|]]}}

Used in this article for displaying template info for templates with no arguments
{{Tplinkarg | arg=argname=valuedescription }}
{{[[:Template:|]] | arg=argname=valuedescription }}
Used in this article for displaying template info for templates with one argument (for more than one, say "various arguments" and refer to template documentation).

For FAQ and help desk pages

And other places where you want to control people adding a single heading and (usually) a single paragraph or so to the article.

What to type What it produces Where to put it
{{addnewsection | actiontext=what user achieves }} In FAQ or help desk or similar article AFTER instructions on how you want people to add new sections/questions. "what user achieves" might be "ask a question", "add a new FAQ", etc.

{{howtoask}}

How to ask a question
  • Search first. As this wiki grows, it might be faster for you to find what you're looking for.
  • Include a title and a question. It's easier for everyone if question formatting is consistent.
  • Be specific. Clearly state your question and include any information that might help to understand the context (for example, a wikilink or a link to an online resource).
  • Don't provide contact information, such as your e-mail|e-mail address, home address, or telephone number. Making your e-mail address public here may make it very public.
  • Sign your question. Type ~~~~ (four tildes) at the end of your question, so we know know who's asking.
  • Be patient. Your question probably won't be answered right away, so come back later and check for a response. Questions are normally answered at the same page on which they were asked. A complete answer to your question may be developed over time.
Use before addnewsection in help desk type articles.

{{howtoanswer}}

How to answer a question

  • Indent your answer. Indent your response under previous text by putting a colon (:) at the beginning of each paragraph of your response.
  • Be thorough. Provide as much of the answer as you can.
  • Provide links when available, such as wikilinks to related articles, or links to the information that you used to find your answer.
  • For long answers, create a new article and link to it from here (if your answer is more than a paragraph or so in length).
  • Sign your response using four tildes (~~~~).
Use after addnewsection in help desk type articles.

{{howtopost}}

How to post a new FAQ (question and answer) using the following link
  • Include a concise question as the subject (title).
  • Include the answer as text below the subject/title.
  • Be thorough; provide as much of the answer as you can.
  • Provide links when available--such as wikilinks to related articles in this wiki, or a link to an online resource.
  • For long answers, create a new article and link to it from here (if your answer is more than a paragraph or so in length).
(Don't use at the moment...see following)

{{howtopostfaq}}

You can post a new question with an answer using the following link:
  • Include a concise question as the subject.
  • Include the answer below the subject.
  • Provide links when available--wikilinks to related articles in this wiki, or link to an online resource.
  • For long answers, create a new article and link to it from here.
Use before addnewsection in FAQ type articles.