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

Object Reference page title

In W3C Specifications, this is called an Interface; In JavaScript, it is an Object; in some languages, it is a Class.

An Object page should transclude the appropriate Object Method and Object Property pages.

Should Constants have their own page, or just be part of the Object or Object Property pages?

Page table of contents

  • Links to subheadings within this article for ease of access

  • Link to Parent object, if any

Summary

Brief summary. A few sentences at most.

Syntax

New ObjectName(param1, param2, ...) Syntax prototype should not have syntax-coloring, because it’s not meant to be executed.

Parameters

param1
definition of param1
param2
definition of param2

Properties

property1
definition of property1; {tag for specific spec version, e.g., HTML5}
property2
definition of property2

Inherited properties

Inherited from SomeObject: foo, bar, baz

Functions

function1()
brief description of function1(); click link for separate page about function1().

Methods

method1()
brief description of method1(); click link for separate page about method1().

Inherited methods

Inherited from SomeObject: qux(), quuz()

Description/Remarks

Longer description, multiple paragraphs.

(Arbitrary subheading)

More explanation.

(Examples)

Explanatory text about examples

(Example subheading)

Example pages/Common elements#Code_block

Normative documents

Example pages/Common elements#Normative_documents

Browser compatibility

Example pages/Common elements#Browser_compatibility

(See Also)

Example pages/Common elements#See_also