Template:ClassElement: Difference between revisions
Jump to navigation
Jump to search
a little clarification in usage |
make more generic |
||
| Line 1: | Line 1: | ||
<noinclude>USAGE: | <noinclude>'''USAGE:''' | ||
This template is intended for use by engineers creating | 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 | #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: | #In the new blank page, type: <nowiki>{{subst:ClassElement}}</nowiki> | ||
#Save the page; this fills in the outline and sample text. | #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. | #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: | The rest of this page shows what this template produces: | ||
---- | ---- | ||
</noinclude>'''Summary:''' The '''foo class''' is part of the [[DOM foobar subsystem]]. It is an interface to inherit from for creating [[URI]] resolvers. | </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. | ||
==Purpose== | ==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 or element? | |||
Each blah blah blah... | Each blah blah blah... | ||
| Line 29: | Line 29: | ||
} datablah; | } datablah; | ||
==Foo | ==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 49: | Line 65: | ||
:blah blah | :blah blah | ||
<includeonly>[[Category: | ==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> | |||
Revision as of 04:10, 12 May 2007
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: {{subst:ClassElement}}
- 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.
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