Help:List of COLLADA wiki templates: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
Elf (talk | contribs)
first pass at explaining what I've created
 
Elf (talk | contribs)
more info
Line 21: Line 21:
| <div>{{stub}}</div>
| <div>{{stub}}</div>
| ''Bottom''<br />of articles that need more info.
| ''Bottom''<br />of articles that need more info.
|-
| {{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.
|}
|}


Line 35: Line 39:
|}
|}


DOM tutorial
==DOM tutorial project templates==
Domclass Domguide
{| border=1 cellspacing=0 cellpadding=3 align=center
Domsub Editor NavigationBox
|-
!width=20%| What to type !!width=55%| What it produces !! Where to put it
|-
| {{tplink|DOM tutorial}}
| <div>{{DOM tutorial}}</div> 
| ''Bottom''<br />of articles that are part of the [[COLLADA DOM API tutorial]].
|-
| {{tplink|Domclass}}
| <div>{{Domclass}}</div>
| When used with "subst:"prefix (<nowiki>{{subst:Domclass}}</nowiki>), fills in outline and sample text to get started on an article about a class.
|-
| {{tplink|Domguide}}
| <div>{{Domguide}}</div>
| When used with "subst:"prefix (<nowiki>{{subst:Domguide}}</nowiki>), fills in outline and sample text to get started on a how-to article .
|-
| {{tplink|Domsub}}
| <div>{{Domsub}}</div>
| When used with "subst:"prefix (<nowiki>{{subst:Domsub}}</nowiki>), fills in outline and sample text to get started on an article about a subsystem.
|}
 
==Templates for constructing templates and similar underpinnings==
 
NavigationBox
Tplink Tplinkarg
Tplink Tplinkarg


[[Category:Help]]
[[Category:Help]]

Revision as of 23:40, 10 April 2007

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.

{{disambig}}

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.

DOM tutorial project 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}}

Summary: The foo class is part of the DOM foobar subsystem. Or the <foo> element is part of the <blah> element. It is an interface to inherit from for creating URI resolvers.

Purpose

Anything more detailed about its purpose.

Text here...

How it's used

Where and how might an application apply this class or element?

Each blah blah blah...

When it finds the correct one, it calls resolve_URI and passes the following struct:

typedef struct {
  int foo;
  char *name;
  enum { a, b } 
} datablah;

Foo example

Describe an example use of the foo class

Attributes

This element has the following attributes:

  • blah: Interacts with the bar element and frammistanis the glompus.
  • name: blah blah

Related classes and functions

This section briefly describes what each function in this class is used for.

Related elements

Child elements

  • list
  • child
  • elements

Parent elements

  • list
  • parent
  • elements

Function A

Summary
summary description
How it's used
blah blah

Function B

Summary
summary description
How it's used
blah blah

See also

External links

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

{{Domguide}}

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

{{Domsub}}

Summary: The foo subsystem manages the resolution of URIs based on various URI schemes and filename extensions.

Purpose

Anything more detailed about its purpose

Text here...

Default behavior

What kinds of default behavior does this subsystem exhibit and in what circumstances? Can you change the default?

By default, this subsystem resolves only COLLADA documents, whether internal or external references...

More text here...

How it works

How does this subsystem operate?

Each blah blah blah

Foo example

Describe an example use of the foo subsystem

Related classes and functions

  • DOM foo class: summary text here, e.g.: An interface to inherit from for creating resolvers.
  • other?
When used with "subst:"prefix ({{subst:Domsub}}), fills in outline and sample text to get started on an article about a subsystem.

Templates for constructing templates and similar underpinnings

NavigationBox Tplink Tplinkarg