Template:TutorialSample

From COLLADA Public Wiki
Jump to: navigation, search

USAGE: This template is intended for assistance with creating user guide or tutorial topic pages. To use this template:

  1. Read the full set of steps to adding a tutorial.
  2. Go to a new blank page--preferably by adding the article's name as a link in the Portal:Tutorials article and then clicking that link.
  3. In the new blank page, type: {{subst:TutorialSample}}
  4. Save the page; this fills in the following sample text.
  5. Edit the page and save it again.

The following shows what this template produces:


Insert short description of what situation the reader might encounter that makes this tutorial relevant. Example: When your application encounters a URI, it needs to resolve the actual location of the referenced item. This page describes how to do this.

Overview

Insert a paragraph or two giving relevant background, context, definition of terms, and so on. You can include bulleted lists if needed, as follows:

  • Bullet 1
  • Bullet 2

Discussing elements

Note: Most headings should be active phrases--starting with a verb--such as "Discussing elements," "Resolving full URLs," and so on. This paragraph also serves as a sample NOTE format.

When discussing a COLLADA element, you can enclose it in < and >; for example, let's mention the <triangles> element. However, if the element's name is the same as a standard html element--for example, the <p> primitive element--you'll need to use special syntax, which you can see if you edit this article and look at this paragraph.

Resolving full URLs

Some background blah blah. Include numbered steps for instructions whenever possible. Here's an example.

To resolve URLs:

  1. first step
    1. Nested step one
    2. Nested step two
  2. second step
    Text to clarify the second step.
  3. third step
  4. fourth step

Discussing attributes and including code

blah blah When discussing an attribute of an element, italicize the element name. For example, when referring to the name attribute.

You can include code examples like this:

Code first line
   Code indented
   code indented
Code ending

Resolving external references

blah blah

See also

External links