Adding to the extensions directory: Difference between revisions

From COLLADA Public Wiki
Jump to navigation Jump to search
Elf (talk | contribs)
can't do numbered list with embedded tables & preformatted text, so abandoning (sigh)
vendor
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{extensions|company=(foo)|product=(bar)}}
{{extensions header}}


==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:Extensions directory|extensions directory]]'''</big>
* You'll need:
* These instructions use the following '''variable names''' and assumptions:
** Company name (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc.")
** '''yourvendorname''' (preferably simplified/common version; for example, "Sony", not "Sony Computer Entertainment, Inc."). Can be multiple words.
** Product name
** '''yourproductname'''. Can be multiple words. Match entry in [[Portal:Products directory|Products directory]].
** 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
** Assume that you have defined <image> and <camera> extensions with '''<technique profile="...">''' or '''<extra><technique profile=...">''' (or both)
*:''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 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):
#:<pre>    |- valign="top"
#: | [[yourvendorname  yourproductname  extensions]] ||  profilename  ||
#: <nowiki>*<camera></nowiki>
#: <nowiki>*<image></nowiki></pre>
#: (See [[#Example output of Extensions by vendor addition]].)
# Click the vendor/product link you just created,  add this text  (left-justified) to the new article, and save it:
#: <pre>    {{extension}}
#: myvendorname provides extensions for the following elements :
#: * [[camera yourproductname extension]]
#: * [[image yourproductname extension]]</pre>
#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):
#:<pre>    {{Subst:ElementSpec}}</pre>
#*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]].)
|} <!--end of basic instructions block -->
 
==Example==
''Assume:''
* a vendor named "My Company"
* product named "My Product"
* profile="mp"
* with extensions for <image> and <camera>
 
===Example list of articles created===
*[[My Company My Product extensions]]
*[[image My Product extension]]
*[[camera My Product extension]]
 
===Example output of List by vendor addition===
If you use just one profile name for all extensions, add one item like this:
 
{| style="text-align:left;  width:100%; border:1px solid #666666;" cellspacing="0" cellpadding="8"
|- style="background-color:#eeeeee;"
! Link (by vendor)||Profile= ''name''||Elements extended
|- valign="top"
|[[My Company My Product extensions]]
|mp
|
*<camera>
*<image>
|}
 
If you use different profile names, it might look like this:
{| 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 vendor)||Profile= ''name''||Elements extended
|- valign="top"
|- valign="top"
|[[My Company My Product extensions]]||mp||
|[[My Company My Product extensions]]
|
*mpc
*mpi
|
*<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 output of List by profile name addition===
**Use [[Softimage XSI extensions]] as a model.
If you use just one profile name for all extensions, add one item like this:
**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;"  
! Profile= ''name''||Company/product link||Elements extended
! Profile= ''name''||Vendor/product link||Elements extended
|- valign="top"
|- valign="top"
|mp||[[My Company My Product extensions]]||
|mp||[[My Company My Product extensions]]||
Line 40: Line 91:
*<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:
If you use different profile names, add multiple lines like this:
{| 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;"  
! Element/product link||Profile= ''name''||Company/product link
! Profile= ''name''||Vendor/product link||Elements extended
|-  
|- valign="top"
|[[camera My Product extension]]||mp||[[My Company My Product extensions]]
|mpc||[[camera My Product extension]]||<camera>
|}<!-- end of example table -->
|- valign="top"
|mpi||[[image My Product extension]]||<image>
|}
|}


===Example output of List by element addition===
{{table header ext2}}
{{table item ext2
| element=camera | product=My Product | profile=mp | vendor=My Company }}
{{table footer ext2}}


[[Category:Help]][[Category:Extensions| ]]
[[Category:Help]][[Category:COLLADA extensions|*A]]

Latest revision as of 22:49, 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:

Detailed instructions:

  1. 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 vendor addition.)
  2. 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]]
  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):
         {{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.
  4. 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.)
  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 vendor 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 vendor addition

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

Link (by vendor) 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 vendor) 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 Vendor/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 Vendor/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 [[{{{company}}} My Product extensions]]