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

WPD/New Page

Follow the steps below as you create new content pages. (Content pages are pages that live in the default namespace.) If your page is not a content page (for example, it lives in the WPD/ namespace), just visit the URL you would like to exist and hit the ‘Create’ tab.

To create a new page:

  1. Figure out where the page should live. Consult the Topic hierarchy page for an overview of the URL structure of the site.
  2. Identify the most specific form below that fits the type of content you’d like to create.
  3. In the associated input box, type the full name of the page you’d like to create (including slashes if you’re creating a sub-page) and hit the “Create foo” button, where “foo” is the name of the form you want to use. For file naming guidelines, consult the Style guide.

Note: This page lists all page templates that currently exist. As we create more, we’ll add them here.

API Listing

For pages that primarily list APIs, like apis/webrtc. See WPD/Creating_API_pages.

API Object

If you’re documenting an API, like document. Generally all pages in this type have a URL that contains apis, and has method and property pages that are sub-pages. The Bar API object of the foo API list would have the URL shown below. See WPD/Creating_API_pages.

API Object Method

If you’re documenting a method of an API, like appendChild. Generally all pages in this type have a URL that contains apis and also includes the parent API Object. The fuz method of the Bar API object in the foo API list would have the URL shown below. See WPD/Creating_API_pages.

API Object Property

If you’re documenting a property of an API, like childNodes. Generally all pages in this type have a URL that contains apis and also includes the parent API Object. The baz property of the Bar API object in the foo API list would have the URL shown below. See WPD/Creating_API_pages.

API Object Event

Use the Event form, below. The buz event of the Bar API object in the foo API list would have the URL, apis/foo/Bar/buz. See WPD/Creating_API_pages.

Concept

For pages that are overviews of a basic concept, like CSS inheritance or float-based layout.

TODO: Examples of topics and URLS

Constant

For pages that document a constant (for CSS, JavaScript, etc).

TODO: Examples of topics and URLS

CSS At Rule

For pages that document a CSS At Rule (like @keyframes).

TODO: Examples of topics and URLS

CSS Function

For pages that document a CSS function (like calc()).

TODO: Examples of topics and URLS

CSS Keyword

For pages that document a CSS keyword (like inherit).

TODO: Examples of topics and URLS

CSS Media Feature

For pages that document a CSS media feature.

TODO: Examples of topics and URLS

CSS Property

For pages that document a CSS property, like font-size. Generally, all pages that have a URL that begins with /css/properties/ should live here.

CSS Selector

For pages that document a CSS selector (like the descendant selector). The URL should be a descriptive name since most of the selectors are illegal characters for MediaWiki URLs.

TODO: Examples of topics and URLS

Data Type

For pages that document a data type (for CSS, JavaScript, etc).

TODO: Examples of topics and URLS

Event

For pages that document a DOM event, like click (dom/events/click) or an API object event like ended (apis/webrtc/MediaStream/ended). For information about documenting API object events, see WPD/Creating_API_pages.

Guide

For pages that are guides to a given complex topic.

TODO: Examples of topics and URLS

Glossary

For pages that act as a collection of Glossary Items.

TODO: Examples of topics and URLS

Glossary Item

For pages that define a single term and its definition.

TODO: Examples of topics and URLS

JavaScript Operator

For pages that document a JavaScript operator, for example + or .. These normally live at URLs that begin with js/operators/. Note that you must use a readable long-form name as many of the actual values are illegal in URLs.

JavaScript Statement

For pages that document a JavaScript statement, for example for, or var. Normally their URLs begin with js/statements/

Markup Attribute

For pages that document a Markup attribute (of HTML, SVG, MathML or XML), for example class or href. These normally live at URLs with a prefix of {xml,html,mathml,svg}/attributes/.

Markup Element

For pages that document a Markup Element (of HTML, SVG, MathML, or XML). For example, canvas, div, circle. These articles normally live at URLs with a prefix of {xml,svg,html,mathml}/elements/

Markup Structure

For pages that document a Markup structure (of HTML, SVG, or other types). For example, CDATA.

TODO: Where do these live in the URL structure?

Regex Metacharacter

For pages that document a regex metacharacter, like * or .. Make sure to use a descriptive name, not the literal character (as those are often illegal page names).

TODO: Examples of topics and URLS

Tutorial

For pages that cover a tutorial that walks users through a practical sequence of steps. Generally, these pages live at URLs that begin with /tutorials, although there may be redirects to them from other URLs in other sections.

Other/Basic

For content pages (that is, pages in the default namespace) that do not have a more specific form to use.

TODO: Create a Media Content page type

TODO: Create a Protocol page type

TODO: Create a Javascript Object page type

TODO: Create a Javascript Enum page type?