Difference between revisions of "Adding to the extensions directory"

From COLLADA Public Wiki
Jump to navigation Jump to search
(more cleaning up instructions)
(remove args & a little editing)
Line 1: Line 1:
{{extensions|company=(foo)|product=(bar)}}
+
{{extensions}}
  
 
==Instructions==
 
==Instructions==
 
{| style="text-align:left; width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"
 
{| style="text-align:left; width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"
 
|-
 
|-
| style="background-color:#eeeeee;" | <big>'''Instructions for adding your product's COLLADA extensions to the [[Portal:Extension directory|extension directory]] on this wiki:'''</big>
+
| style="background-color:#eeeeee;" | <big>'''Instructions for adding your product's COLLADA extensions to the [[Portal:Extension directory|extension directory]]'''</big>
 
* These instructions use the following variable names:
 
* These instructions use the following variable names:
 
** '''yourcompanyname''' (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
 
** '''yourcompanyname''' (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
Line 16: Line 16:
 
*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 for articles in the next bullet. (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 for the preceding item to [[List of extensions by element]].  
+
*Add links for articles in the preceding bullet to [[List of extensions by element]].  
  
 
'''Detailed instructions:'''
 
'''Detailed instructions:'''
Line 26: Line 26:
 
#: <nowiki>*<camera></nowiki>
 
#: <nowiki>*<camera></nowiki>
 
#: <nowiki>*<image></nowiki></pre>
 
#: <nowiki>*<image></nowiki></pre>
# 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):
+
#: (See [[#Example output of Extensions by company addition]].)
 +
# Click the company/product link you just created,  add this text  (left-justified) to the new article, and save it (assuming you provide <camera> and <image> extensions):
 
#: <pre>    {{extensions}}
 
#: <pre>    {{extensions}}
 
#: mycompanyname provides extensions for the following elements :
 
#: mycompanyname provides extensions for the following elements :
Line 37: Line 38:
 
#: | product = yourproductname }}</pre>
 
#: | product = yourproductname }}</pre>
 
#*Use [[Softimage XSI extensions]] as a rough model; provide descriptions and examples of your extensions.
 
#*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 output of Extensions by profile name addition]].)  
# 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 output of Extensions by element addition]].)
 
|} <!--end of basic instructions block -->
 
|} <!--end of basic instructions block -->
  
 
==Example==
 
==Example==
''For example:''
+
''Assume:''
 
* a company named "My Company"
 
* a company named "My Company"
 
* product named "My Product"
 
* product named "My Product"
Line 50: Line 51:
 
===Example list of articles created===
 
===Example list of articles created===
 
*[[My Company My Product extensions]]
 
*[[My Company My Product extensions]]
*[[image My Product extensions]]
+
*[[image My Product extension]]
*[[camera My Product extensions]]
+
*[[camera My Product extension]]
  
===Example of List by company===
+
===Example output of List by company addition===
 
{| style="text-align:left;  width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"  
 
{| style="text-align:left;  width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"  
 
|- style="background-color:#eeeeee;"  
 
|- style="background-color:#eeeeee;"  
Line 63: Line 64:
 
|}
 
|}
  
===Example of List by profile name===
+
===Example output of List by profile name addition===
  
 
{| style="text-align:left;  width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"  
 
{| style="text-align:left;  width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"  
Line 74: Line 75:
 
|}
 
|}
  
===Example of List by element===
+
===Example output of List by element addition===
 
{| style="text-align:left;  width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"  
 
{| style="text-align:left;  width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"  
 
|- style="background-color:#eeeeee;"  
 
|- style="background-color:#eeeeee;"  

Revision as of 02:07, 18 May 2007

Extension information
  • Purpose: unstated
  • Company(s): unstated
  • Product(s): unstated
  • 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
  • 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>
    (See #Example output of Extensions by company addition.)
  2. Click the company/product link you just created, add this text (left-justified) to the new 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 output of Extensions by profile name addition.)
  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 output of Extensions by element addition.)

Example

Assume:

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

Example list of articles created

Example output of List by company addition

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

Example output of List by profile name addition

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

Example output of List by element addition

Element/product link Profile= name Company/product link
camera My Product extension mp My Company My Product extensions