Template:ClassElement: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
Elf (talk | contribs)
clarify instr
Elf (talk | contribs)
m chg catg to user templ's
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>This template is intended for use by engineer creating DOM subsystem description pages.
<noinclude>'''USAGE:'''
This template is intended for use by engineers creating class or element description pages. To use this template:
#Go to a new blank page--preferably by adding the article's name as a link to some related or summary article and then clicking that link.
#In the new blank page, type: <nowiki>{{subst:ClassElement}}</nowiki>
#Save the page; this fills in the outline and sample text.
#Edit the page; replace "foo" with the name of the class or element. Make any other edits and save the page.  


USAGE:
The rest of this page shows what this template produces:
#Go to a new blank page--preferably by adding the article's name as a link in the [[COLLADA DOM API tutorial]] article and then clicking that link.
----
#In the new blank page, type: <nowiki>{{subst:domclass}}</nowiki>
#Save the page; this fills in the outline and sample text.
#Edit the page; replace "foo" with the name of the class. Make any other edits and save the page.


This is what this template produces:
</noinclude>'''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.
</noinclude>'''Summary:''' The '''foo class''' is part of the [[DOM foobar subsystem]]. It is an interface to inherit from for creating [[URI]] resolvers.


==Purpose==
==Purpose==
:''Anything more detailed about its purpose''
Anything more detailed about its purpose.


Text here...
Text here...


==How it's used==
==How it's used==
:''Where and how might an application apply this class?''
Where and how might an application apply this class or element?


Each blah blah blah...
Each blah blah blah...
Line 28: Line 29:
  } datablah;
  } datablah;


==Foo class example==
==Foo example==
:''Describe an example use of the foo class''
:''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==
==Related classes and functions==
This section briefly describes what each function in this class is used for.
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===
===Function A===
Line 48: Line 65:
:blah blah
:blah blah


<includeonly>[[Category:DOM project|Foo class]]</includeonly>
==See also==
<!-- this is a standard heading. Use if needed. -->
*[[link 1]]
 
==External links==
<!-- this is a standard heading. Use if needed. -->
*[http://www.foo.com Blah home page]
 
<includeonly>[[Category:COLLADA]]<!--pick an appropriate category--></includeonly><noinclude>[[Category:User templates|{{PAGENAME}}]]</noinclude>

Latest revision as of 21:15, 4 March 2009

USAGE: This template is intended for use by engineers creating class or element description pages. To use this template:

  1. Go to a new blank page--preferably by adding the article's name as a link to some related or summary article and then clicking that link.
  2. In the new blank page, type: {{subst:ClassElement}}
  3. Save the page; this fills in the outline and sample text.
  4. Edit the page; replace "foo" with the name of the class or element. Make any other edits and save the page.

The rest of this page shows what this template produces:


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