Template:ElementSpec: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
Elf (talk | contribs)
new template for spec pages, to use for extension elements
 
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Category: <!-- fill in --> (See [[list of specification categories]])
{{extension
  | company = yourcompanyname
| purpose = short description
| company = ...
| product = product this applies to (match name of wiki page for this product)
| product2 = 2nd product or blank
| product3 = 3rd product or blank
| contact_email = ...
| last_updated = ...}}


Introduction: <!-- fill in one sentence starting with a verb that describes purpose of this element -->
==<your_element> Element==
<!-- 
          TIP: The ":" at the beginning of lines indents them.
-->
:'''Specification Version:''' 1.X <!-- fill in --> (Choose: 1.4 or 1.5)
:'''Category:''' <!-- fill in word right after the colon to reference the category  --> (See [[list of specification categories]])


==Concepts==
===Introduction===
<!-- Background info needed to understand this element's purpose and place within COLLADA -->
:<!-- fill in one sentence starting with a verb that describes purpose of this element -->


==Attributes==
===Concepts===
{| {{prettytable}}
:<!-- Background info needed to understand this element's purpose and place within COLLADA -->
|-
 
:{| {{prettytable}}
|+ '''Attributes'''
!Name||Type||Description||Required?
!Name||Type||Description||Required?
|-
|-
Line 14: Line 29:
|}
|}


==Related Elements==
:{| {{prettytable}}
{|
|+ '''Related Elements'''
!Affected Parent element(s)
| list_here
|-
|-
!Parent element(s)
!Extra and/or Technique
|list_here
| fill_in <!-- e.g., <extra type="foo">/<technique profile="BAR"> -->
|-
|-
!Child elements
!Child elements
|list_here or state None
| list_here <!--  or state None -->
|-
|-
!Other
!Other
|list any other relevant elements
| list_here <!-- list any other relevant elements -->
|}
|}
:{| {{prettytable}}
|+ '''Child Elements'''
!Name||Description||Default||Occurrences
|-
|Example||Specifies foo.||N/A||0 or more
|}
===Details===
:<!-- Additional info about how and where to use the element (and its children), lists of additional relevant links, detailed value tables for element or attribute values, etc. -->
====Problem====
:<!-- Additional info about the problem that is being solved. -->
====Analysis====
:<!-- Additional info about the design and analysis of the problem. -->
====Solution====
:<!-- Additional info about the solution for the problem that is addresses. -->
====Schema====
:<!-- A copy of the schema and links to the schema namespace. -->
===Examples===
===Status===
:<!-- Status can be one of: Incomplete, Complete, Released product version, Obsolete -->
===IP Status===
:<!-- Document any known patents or other IP claims that may prohibit royalty-free implementation of the extension, or impose other constraints on implementations -->
===Dependencies===
:<!-- List the COLLADA version(s) required by this extension as well as any other dependencies -->
===Issues===
:<!-- List remaining open issues, or closed issues whose resolution set a precedent, or was otherwise especially interesting. Briefly describe each issue, options considered, the choice made, and the reason for that choice. Include Bugzilla issue numbers were applicable. -->
===Parsing Errors===
====Version 1.X Error Handling====
:<!-- The handling of error conditions while parsing extensions is specified on an per-extension basis. Describe the error handling behavior for each version of the specification that the extension is designed to work with. -->
<!-- Really required. --><noinclude>[[Category:Templates]][[Category:COLLADA extensions|*]]</noinclude>

Latest revision as of 14:14, 17 May 2010

Extension information
This article is part of the COLLADA extensions directory
Adding to the extensions directory

<your_element> Element

Specification Version: 1.X (Choose: 1.4 or 1.5)
Category: (See list of specification categories)

Introduction

Concepts

Attributes
Name Type Description Required?
example xs:token A text string value that specifies blah. Yes
Related Elements
Affected Parent element(s) list_here
Extra and/or Technique fill_in
Child elements list_here
Other list_here
Child Elements
Name Description Default Occurrences
Example Specifies foo. N/A 0 or more

Details

Problem

Analysis

Solution

Schema

Examples

Status

IP Status

Dependencies

Issues

Parsing Errors

Version 1.X Error Handling