Help:List of COLLADA wiki templates

From COLLADA Public Wiki
Jump to: navigation, search

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.

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

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}}

Bottom
of articles that disambiguate terms that could have various meanings (disambiguation pages).
Note: this template also places the article in Category:Disambiguation
{{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.
{{underconstruction | notready=true }}
Pages actively being worked on and is not ready for use. Please don't leave these lying around if you're not working on the page.

Article initialization templates

These templates are designed for one-time substitution into an article, to get the article layout initialized. To substitute the content of these templates into an article, use the syntax:

{{subst:name_of_template}}

Then save the page, then edit.

What to type What it produces Where to put it

{{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.

Info-box templates

What to type What it produces Where to put it
{{Conditioner | various arguments }}
Conditioner information
  • Name: {{{name}}}
  • Purpose: {{{purpose}}}
  • Last updated: {{{last_updated}}}
  • Current version: {{{current_version}}}
  • Status: {{{status}}}
  • Created by: {{{creator}}}
  • Contact for technical issues: {{{contact_email}}}

Download URL unknown

This article is part of the COLLADA conditioners directory
Adding to the conditioners directory
Top
of each article that describes a COLLADA conditioner.
Note: see the template itself for details about the arguments

{{Conditioners header}}

Conditioners directory
Information about conditioners that can act on COLLADA documents.
This article is part of the COLLADA conditioners directory.

COLLADA Refinery • Conditioners directory

Instructions for adding to the conditioners directory

[[Category: ]]
Top
of articles that summarize or collect info on conditioners.
{{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
Top
of each article that describes a COLLADA extension.
Note: see the template itself for details about the arguments
{{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.
{{Product | various arguments }}
Product information
  • Name: {{{name}}}
  • Purpose: unstated
  • Last updated: unstated
  • Current version: unknown
  • Status: unstated
  • OS: unstated
  • Maintainer: unknown
  • Contact for technical issues:

Download URL unknown

This article is part of the COLLADA products directory
Adding to the list of products
Top
of each article that describes a product that imports, exports, or otherwise works with or interacts with COLLADA documents.
Note: see the template itself for details about the arguments

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.
{{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.

Category 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]]
Top
of Category pages.
Note: this template fills in name of category, not "COLLADA wiki templates"

{{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]]
Top
of image Category pages.
Note: this template fills in name of category, not "COLLADA wiki templates"
{{addtemplatetocategory | what = what the templates in this catg do }}
This is a list of templates that what the templates in this catg do. To add a template to this category, include the text: <noinclude>[[Help:List of COLLADA wiki templates|{{PAGENAME}}]]</noinclude>
Top
of template Category pages.
Note: this template fills in name of category, not "COLLADA wiki templates"

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.

Color templates

To make it easier to switch color themes. See Help:Color schemes for wiki for what these colors look like:

What to type What it produces Which is Where to put it Note

{{Site color 1 pale}}

#FFF2DF
  In color= args

{{Site color 1 light}}

#FFD284
  In color= args

{{Site color 1 mid}}

#FFAE1F
  In color= args

{{Site color 1 dark}}

#A66D0A
  In color= args

{{Site color 2 pale}}

#F5FAFF
  In color= args

{{Site color 2 light}}

#779BD4
  In color= args

{{Site color 2 mid}}

#2256A9
  In color= args

{{Site color 2 dark}}

#0B316E
  In color= args

{{Site color 3 pale}}

#FAF5FF
  In color= args

{{Site color 3 light}}

#8C7CD8
  In color= args

{{Site color 3 mid}}

#4029B0
  In color= args

{{Site color 3 dark}}

#1E0D73
  In color= args

{{Site color 4 pale}}

#F5FFFA
  In color= args

{{Site color 4 light}}

#6CD0BF
  In color= args

{{Site color 4 mid}}

#14A28A
  In color= args

{{Site color 4 dark}}

#066958
  In color= args

{{Site color accent pale}}

#FAEAEA
  In color= args

{{Site color accent light}}

#E6918B
  In color= args

{{Site color accent mid}}

#CC4439
  In color= args

{{Site color accent dark}}

#851B13
  In color= args

{{Site color gray pale}}

#F0EDE9
  In color= args

{{Site color gray light}}

#BFBCB6
  In color= args

{{Site color gray mid}}

#807D79
  In color= args

{{Site color gray dark}}

#403F3D
  In color= args

{{Color conditioners pale}}

#F5FAFF
  In color= args These templates aren't hard-coded with color numbers; they're set to the preceding site colors. Use edit on a template to see how that's done.

{{Color conditioners light}}

#779BD4
  In color= args

{{Color conditioners mid}}

#2256A9
  In color= args

{{Color conditioners dark}}

#0B316E
  In color= args

{{Color extensions pale}}

#F5FFFA
  In color= args

{{Color extensions light}}

#6CD0BF
  In color= args

{{Color extensions mid}}

#14A28A
  In color= args

{{Color extensions dark}}

#066958
  In color= args

{{Color products pale}}

#FFF2DF
  In color= args

{{Color products light}}

#FFD284
  In color= args

{{Color products mid}}

#FFAE1F
  In color= args

{{Color products dark}}

#A66D0A
  In color= args

{{Color general pale}}

#F0EDE9
  In color= args

{{Color general light}}

#BFBCB6
  In color= args

{{Color general mid}}

#807D79
  In color= args

{{Color general dark}}

#403F3D
  In color= args

General navigation templates

What to type What it produces Where to put it
{{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

Templates for constructing templates and similar underpinnings

What to type What it produces Where to put it
{{box-header | title=Title for box }}
edit  

Title for box

Constructs header with edit link for use in "subpages" on Main page, portals, and similar things.
{{NavigationBox | various arguments }}
{{{Title}}}
{{{Summary}}}
{{{List}}}
[[Category: ]]
General format for creating navigation boxes such as Template:DOM navigation
Note: see the template itself for details about the arguments
{{Tplink | template_name }} Used in the left column of this article for displaying template info for templates with no arguments
{{Tplinkarg | various args }} Used in the left column of 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.