Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

Tutorial title

Page table of contents

  • Links to subheadings within this article for ease of access

Reference section

Each tutorial article should contain a multi-faceted, useful reference section contaning a number of links:

  • Name of current article
  • “previous” and “next” links to take readers to the previous or next article in the series, or suggested "next steps", if the article isn’t in an obvious series, or is at the end of a series.
  • Other “related links” to take the reader to articles that cover related topics or topics that were only touched upon in this article, in more detail.
  • Basic canonical articles: links to the definitive articles that cover the components of the current article. For example, in an article about creating buttons with CSS sprites, gradients, border-radius and box/text-shadow, you’d link to the basic articles that cover background, gradients, border-radius, box-shadow and text-shadow.
  • Links to the relevant specs covering these features. Do we need these here too?
  • Topic tags, which will link to other articles tagged with the same tag.

Introduction

Brief introduction to the topic in hand: the problem we are solving, the technique we are demonstrating, the widget we are coding, or the API or module feature we are explaining.

Article body

The tutorial is a step-by-step description of a task or use case. The reader should be guided from the beginning through to completion. The introduction should make a promise of what will be accomplished, and the summary should recap what they have learned.

The complete meat of the article. We probably need to work out some sort of guidance template for article body structure, but I don’t think it should be too restricting. It can be more freeform than reference pages. The article body contains any code samples included in the article.

Theoretically, this will be the longest section of the tutorial, although it doesn’t look it in this template.

Summary

Summary saying what we learned, and any conclusions we can draw from the article.

See Also

List of other topics that are relevant to the tutorial

Reference


List of reference topics

Conceptual Topics


List of nonreference topics

External References

Resources from elsewhere on the web that might give useful information or further examples about the same topic, or which were used in the creation of this article (influences, or places where inspiration or material were drawn from)

Footer

<details> <summary>This article contains content originally from external sources, including ones licensed under the CC-BY-SA license.</summary>

Portions of this content copyright 2012 Mozilla Contributors. This article contains work licensed under the Creative Commons Attribution-Sharealike License v2.5 or later. The original work is available at Mozilla Developer Network: <a href="http://developer.mozilla.org/foo" target="_blank">Foo</a>

Portions of this content come from Foo.org: <a href="http://foo.org/baz" target="_blank">Baz</a>

</details>