Difference between revisions of "Adding to the extensions directory"

From COLLADA Public Wiki
Jump to navigation Jump to search
(can't do numbered list with embedded tables & preformatted text, so abandoning (sigh))
(trying to simplify instructions to not look so intimidating...partial pass)
Line 1: Line 1:
 
{{extensions|company=(foo)|product=(bar)}}
 
{{extensions|company=(foo)|product=(bar)}}
  
 +
==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]] on this wiki:'''</big>
* You'll need:
+
* These instructions use the following variable names:
** Company name (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc.")
+
** '''yourcompanyname''' (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
** Product name
+
** '''yourproductname'''. Can be multiple words.
** Name used in '''profile name="..."'''  (often--but not always-the product name?)
+
** '''profilename''' used in '''profile name="..."'''  (often--but not always-the product name)
 
** Details about your '''<technique profile="...">''' and '''<extra><technique profile=...">''' extensions
 
** Details about your '''<technique profile="...">''' and '''<extra><technique profile=...">''' extensions
*:''For example, a company named "My Company", product named "My Product", profile "mp", with extensions for <image> and <camera>.''
+
 
*In [[List of extensions by company]], add a table row with this info:
+
;Summary:You'll do the following:
 +
*Add one row to [[List of extensions by company]]
 +
*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 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]].
 +
 
 +
Detailed instructions:
 +
#In [[List of extensions by company]], add a table row using this text (if you have extensions for camera and image):
 +
#:<pre>    |- valign="top"
 +
#: | [[yourcompanyname  yourproductname  extensions]] ||  profilename  ||
 +
#: <nowiki>*<camera></nowiki>
 +
#: <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:
 +
#: <pre>{{extensions}}
 +
#: My Company provides extensions for the following elements:
 +
#: * [[camera My Product extension]]
 +
#: * [[image My Product extension]]</pre>
 +
#Click each of those element-based links to create separate articles each extension:
 +
**Use [[Softimage XSI extensions]] as a model.
 +
**Put  the following at the top of each article:
 +
<nowiki>{{extensions
 +
| company = yourcompanyname
 +
| product = productname }}</nowiki>
 +
 
 +
* 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]].)
 +
|} <!--end of basic instructions block -->
 +
 
 +
==Example==
 +
''For example:''
 +
* a company named "My Company"
 +
* product named "My Product"
 +
* profile="mp"
 +
* with extensions for <image> and <camera>
 +
 
 +
===Example of List by company===
 
{| 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;"  
 
! Link (by company)||Profile= ''name''||Elements extended
 
! Link (by company)||Profile= ''name''||Elements extended
 
|- valign="top"
 
|- valign="top"
|[[My Company My Product extensions]]||mp||
+
|[[My Company My product extensions]]||mp||
 
*<camera>
 
*<camera>
 
*<image>
 
*<image>
 
|}
 
|}
* Click your new "''companyname productname'' extensions" link to create an article with that name, and add this text to the article (substituting your own company and product names):
 
<pre><nowiki>{{extensions}}
 
My Company provides extensions for the following elements:
 
* [[camera My Product extension]]
 
* [[image My Product extension]]</nowiki></pre>
 
  
*Click each of these links to create separate articles each extension:
+
===Example of List by profile name===
**Use [[Softimage XSI extensions]] as a model.
+
 
**Put  the following at the top of each article:
 
<nowiki>{{extensions
 
| company = yourcompanyname
 
| product = productname }}</nowiki>
 
* In [[List of extensions by profile name]], add a table row with this info:
 
 
{| 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 40: Line 68:
 
*<image>
 
*<image>
 
|}
 
|}
* In [[List of extensions by element]], add a table row for each element that you support (use the same element-specific links as above); for example:
+
 
;camera:
+
===Example of List by element===
 
{| 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 48: Line 76:
 
|[[camera My Product extension]]||mp||[[My Company My Product extensions]]
 
|[[camera My Product extension]]||mp||[[My Company My Product extensions]]
 
|}<!-- end of example table -->
 
|}<!-- end of example table -->
|}
 
 
  
 
[[Category:Help]][[Category:Extensions| ]]
 
[[Category:Help]][[Category:Extensions| ]]

Revision as of 00:20, 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 (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 to create an article with that name. Add this text to the article and save it:
    {{extensions}}
    My Company provides extensions for the following elements:
    * [[camera My Product extension]]
    * [[image My Product extension]]
  3. Click each of those element-based links to create separate articles each extension:
{{extensions
 | company = yourcompanyname
 | product = productname }}

Example

For example:

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

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