Help:List of COLLADA wiki templates

From COLLADA Public Wiki
Revision as of 03:53, 12 May 2007 by Elf (talk | contribs) (Tutorial project templates: revise generic tutorial template)
Jump to navigation Jump to search

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

General navigation templates

What to type What it produces Where to put it

{{addtocategory}}

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.

{{disambig}}


Note: this template also places the article in Category:Disambiguation
Bottom
of articles that disambiguate terms that could have various meanings (disambiguation pages).

Editing templates

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


System administration 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.

Tutorial templates

What to type What it produces Where to put it

{{DOM tutorial}}

Bottom
of articles that are part of the COLLADA DOM API tutorial.

{{Domclass}}

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

{{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
When used with "subst:"prefix ({{subst:Domsub}}), fills in outline and sample text to get started on an article about a subsystem.

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

{{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).
Use before addnewsection in FAQ type articles.