Example of a Widget Specification

Unofficial Proposal Draft,

More details about this document
This version:
https://dlaliberte.github.io/bikeshed-intro-examples/widgets.html
Issue Tracking:
GitHub
Editor:
Your Name (Your Company)

Abstract

This documents a fictitious Widget Specification.

Status of this document

1. Introduction

This document describes the Web Standard for Widgets, which is a set of guidelines for creating and using widgets. Widgets are small, self-contained applications that can be embedded in a web page. They are typically used to provide additional functionality to a web page, such as a calendar, a weather forecast, or a news ticker.

The Web Standard for Widgets is based on the following principles:

The Web Standard for Widgets is a work in progress. We welcome feedback and suggestions for improvement. Please contact us at [email protected] if you have any questions or comments.

2. API Sections

The Web Standard for Widgets defines the following API:

The `Widget` interface defines the following methods:

The `WidgetManager` interface defines the following methods:

The `WidgetRegistry` interface defines the following methods:

2.1. Definitions

The following definitions are used in this document:

Conformance

Document conventions

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

References

Normative References

[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc2119