Documentation example template

Looking for WET v3.1?

As of September 23, 2014, version 3.1 of the Web Experience Toolkit is no longer supported. The source code and documentation have been moved to the wet-boew-legacy repository.

Purpose

A brief description of the component.

Use when

Do not use when

Working example

Link to a working example

How to implement

  1. Step 1
  2. Step 2 
    Example code
  3. Step 3 
    Example of multi-line code
Example of multi-line code
Example of multi-line code
  4. Step 4

Configuration options

Document the public configuration options that can be used by implementers or developers.

Option Description How to configure Values
Option 1 Brief description of the option How to configure the option
Value 1 (default):
Brief description
Value 2:
Brief description
Value 3:
Brief description
Option 2 Brief description of the option How to configure the option
Value 1 (default):
Brief description
Value 2:
Brief description
Value 3:
Brief description

Events

Document the public events that can be used by implementers or developers.

Event Trigger What it does
Event 1 When the event is triggered and how to trigger it manually (where supported) Brief description of what it does.
Event 2 When the event is triggered and how to trigger it manually (where supported) Brief description of what it does.

Source code

Link to the folder on GitHub containing the files for the component

Date modified: