Difference between revisions of "Adding to the extensions directory"

Revision as of 22:44, 23 July 2010

Extensions directory

Information about COLLADA <technique profile=...> and <extra> extensions.

This article is part of the COLLADA extensions directory.

• List of extensions by vendor • List of extensions by profile name • List of extensions by element

Instructions for adding to the extensions directory

[[Category: ]]

Instructions

Instructions for adding your product's COLLADA extensions to the extensions directory

These instructions use the following variable names and assumptions:
- yourvendorname (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
- yourproductname. Can be multiple words. Match entry in Products directory.
- profilename used in profile name="..." (often--but not always-the product name)
- Assume that you have defined <image> and <camera> extensions with <technique profile="..."> or <extra><technique profile=..."> (or both)

Summary:

You'll do the following:

Add one row to List of extensions by vendor
Add one (or more) rows to List of extensions by profile name
Create a new article titled yourvendorname 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).
Add links for articles in the preceding bullet to List of extensions by element.

Detailed instructions:

In List of extensions by vendor, add a table row using this text (left-justified):
```
     |- valign="top"
```
| [[yourvendorname yourproductname extensions]] || profilename ||

*<camera>

*<image>

(See #Example output of Extensions by company addition.)
Click the vendor/product link you just created, add this text (left-justified) to the new article, and save it:
```
     {{extension}}
```
myvendorname provides extensions for the following elements :

* [[camera yourproductname extension]]

* [[image yourproductname extension]]
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):
```
     {{Subst:ElementSpec}}
```
- SAVE the page immediately, then click the edit tab to fill in details; use Softimage XSI extensions as a rough model; provide descriptions and examples of your extensions.
In List of extensions by profile name, add one or more table row(s) 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 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

If you use just one profile name for all extensions, add one item like this:

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

If you use different profile names, it might look like this:

Link (by company)	Profile= name	Elements extended
My Company My Product extensions	mpc mpi	<camera> <image>

Example output of List by profile name addition

If you use just one profile name for all extensions, add one item like this:

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

If you use different profile names, add multiple lines like this:

Profile= name	Company/product link	Elements extended
mpc	camera My Product extension	<camera>
mpi	image My Product extension	<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

@@ Line 6: / Line 6: @@
 | style="background-color:#eeeeee;" | <big>'''Instructions for adding your product's COLLADA extensions to the [[Portal:Extensions directory|extensions directory]]'''</big>
 * These instructions use the following '''variable names''' and assumptions:
-** '''yourcompanyname''' (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
+** '''yourvendorname''' (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
 ** '''yourproductname'''. Can be multiple words. Match entry in [[Portal:Products directory|Products directory]].
 ** '''profilename''' used in '''profile name="..."'''  (often--but not always-the product name)
@@ Line 14: / Line 14: @@
 You'll do the following:
-*Add one row to [[List of extensions by company]]
+*Add one row to [[List of extensions by vendor]]
 *Add one (or more) rows to [[List of extensions by profile name]]
-*Create a new article titled [[yourcompanyname  yourproductname  extensions]] and add links for articles in the next bullet. (e.g., [[Softimage XSI extensions]]).
+*Create a new article titled [[yourvendorname  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]]).
 *Add links for articles in the preceding bullet to [[List of extensions by element]].
 '''Detailed instructions:'''
-#In [[List of extensions by company]], add a table row using this text (left-justified):
+#In [[List of extensions by vendor]], add a table row using this text (left-justified):
 #:<pre>     |- valign="top"
-#: | [[yourcompanyname  yourproductname  extensions]] ||  profilename  ||
+#: | [[yourvendorname  yourproductname  extensions]] ||  profilename  ||
 #: <nowiki>*<camera></nowiki>
 #: <nowiki>*<image></nowiki></pre>
 #: (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:
+# Click the vendor/product link you just created,  add this text  (left-justified) to the new article, and save it:
 #: <pre>     {{extension}}
-#: mycompanyname provides extensions for the following elements :
+#: myvendorname provides extensions for the following elements :
 #: * [[camera yourproductname extension]]
 #: * [[image yourproductname extension]]</pre>