Adding to the extensions directory: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
(trying to simplify instructions to not look so intimidating...partial pass)
(more cleaning up instructions)
Line 11: Line 11:
** Details about your '''<technique profile="...">''' and '''<extra><technique profile=...">''' extensions
** Details about your '''<technique profile="...">''' and '''<extra><technique profile=...">''' extensions


;Summary:You'll do the following:
'''Summary:'''
 
You'll do the following:
*Add one row to [[List of extensions by company]]  
*Add one row to [[List of extensions by company]]  
*Add one row to [[List of extensions by profile name]]
*Add one row to [[List of extensions by profile name]]
*Create a new article titled [[yourcompanyname  yourproductname  extensions]] and add links to the next item. (e.g., [[Softimage XSI extensions]]).
*Create a new article titled [[yourcompanyname  yourproductname  extensions]] and add links to the next item. (e.g., [[Softimage XSI extensions]]).
*Create one additional article for each COLLADA element that you extend, titled [[elementname yourproductname extension]] (e.g., [[camera XSI extension]]).
*Create one additional article for each COLLADA element that you extend, titled [[elementname yourproductname extension]] (e.g., [[camera XSI extension]]).
*Add links to the preceding to [[List of extensions by element]].  
*Add links for the preceding item to [[List of extensions by element]].  


Detailed instructions:
'''Detailed instructions:'''
#In [[List of extensions by company]], add a table row using this text (if you have extensions for camera and image):
#In [[List of extensions by company]], add a table row using this text (left-justified) (if you have extensions for camera and image) :
#:<pre>    |- valign="top"
#:<pre>    |- valign="top"
#: | [[yourcompanyname  yourproductname  extensions]] ||  profilename  ||
#: | [[yourcompanyname  yourproductname  extensions]] ||  profilename  ||
#: <nowiki>*<camera></nowiki>
#: <nowiki>*<camera></nowiki>
#: <nowiki>*<image></nowiki></pre>
#: <nowiki>*<image></nowiki></pre>
# Click the company/product link you just created to create an article with that name. Add this text to the article and save it:
# Click the company/product link you just created,  add this text (left-justified) to the article, and save it (assuming you provide <camera> and <image> extensions):
#: <pre>{{extensions}}
#: <pre>     {{extensions}}
#: My Company provides extensions for the following elements:
#: mycompanyname provides extensions for the following elements :
#: * [[camera My Product extension]]
#: * [[camera yourproductname extension]]
#: * [[image My Product extension]]</pre>
#: * [[image yourproductname extension]]</pre>
#Click each of those element-based links to create separate articles each extension:
#Click each of those element-based links to create separate articles for each extension:
**Use [[Softimage XSI extensions]] as a model.
#*Put  the following at the top of each article (left-justified):
**Put  the following at the top of each article:
#:<pre>     {{extensions
<nowiki>{{extensions
#: | company = yourcompanyname
| company = yourcompanyname
#: | product = yourproductname }}</pre>
| product = productname }}</nowiki>
#*Use [[Softimage XSI extensions]] as a rough model; provide descriptions and examples of your extensions.
 
# In [[List of extensions by profile name]], add one table row with your info (see [[#Example of Extensions by profile name]]).  
* In [[List of extensions by profile name]], add one table row with your info (see [[#Example of Extensions by profile name]]).  
# In [[List of extensions by element]], add a table row for each element that you support (using the same element-based links as above).  (See [[#Example of Extensions by element]].)
 
* In [[List of extensions by element]], add a table row for each element that you support (using the same element-based links as above).  (See [[#Example of Extensions by element]].)
|} <!--end of basic instructions block -->
|} <!--end of basic instructions block -->


Line 47: Line 47:
* profile="mp"
* profile="mp"
* with extensions for <image> and <camera>
* with extensions for <image> and <camera>
===Example list of articles created===
*[[My Company My Product extensions]]
*[[image My Product extensions]]
*[[camera My Product extensions]]


===Example of List by company===
===Example of List by company===

Revision as of 00:35, 18 May 2007

Extension information
  • Purpose: unstated
  • Company(s): (foo)
  • Product(s): (bar)
  • Last updated: unstated
  • Contact for technical issues:
This article is part of the COLLADA extensions directory
Adding to the extensions directory

Instructions

Instructions for adding your product's COLLADA extensions to the extension directory on this wiki:
  • These instructions use the following variable names:
    • yourcompanyname (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
    • yourproductname. Can be multiple words.
    • profilename used in profile name="..." (often--but not always-the product name)
    • Details about your <technique profile="..."> and <extra><technique profile=..."> extensions

Summary:

You'll do the following:

Detailed instructions:

  1. In List of extensions by company, add a table row using this text (left-justified) (if you have extensions for camera and image) : 
         |- valign="top"
    | [[yourcompanyname yourproductname extensions]] || profilename ||
    *<camera>
    *<image>
  2. Click the company/product link you just created, add this text (left-justified) to the article, and save it (assuming you provide <camera> and <image> extensions): 
         {{extensions}}
    mycompanyname provides extensions for the following elements :
    * [[camera yourproductname extension]]
    * [[image yourproductname extension]]
  3. Click each of those element-based links to create separate articles for each extension:
    • Put the following at the top of each article (left-justified):
         {{extensions
    | company = yourcompanyname
    | product = yourproductname }}
  4. In List of extensions by profile name, add one table row with your info (see #Example of Extensions by profile name).
  5. In List of extensions by element, add a table row for each element that you support (using the same element-based links as above). (See #Example of Extensions by element.)

Example

For example:

  • a company named "My Company"
  • product named "My Product"
  • profile="mp"
  • with extensions for <image> and <camera>

Example list of articles created

Example of List by company

Link (by company) Profile= name Elements extended
My Company My product extensions mp
  • <camera>
  • <image>

Example of List by profile name

Profile= name Company/product link Elements extended
mp My Company My Product extensions
  • <camera>
  • <image>

Example of List by element

Element/product link Profile= name Company/product link
camera My Product extension mp My Company My Product extensions
Retrieved from "http://www.khronos.org/collada/wiki_collada/index.php?title=Adding_to_the_extensions_directory&oldid=2502"