Show Menu

Bikeshed Cheat Sheet by

W3C's Bikeshed
w3c     bikeshed     specification

Running Bikeshed

Local: Create
bikeshed spec filen­ame.bs : creates the HTML from the Bikeshed file
Local: Auto-Update
bikeshed watch filen­ame.bs : creates the HTML from the Bikeshed file, and keeps watching the Bikeshed file for changes, automa­tically generating new HTML when the Bikeshed file changes
Local: Template
bikeshed template : creates an empty template for starting a new Bikeshed project
Online: Create
curl https://api.csswg.org/bikeshed/ -F file=@filename.bs -F force=1 > filename.html
Online: View Errors
curl https://api.csswg.org/bikeshed/ -F file=@filename.bs -F output=err
Online: Issue List
curl https://api.csswg.org/bikeshed/ -F file=@issues.txt -F input=issues > issues.html

Markdown

Documentation
#, ##, ###
<h1­>, <h2­>, <h3>
*
Unordered list. Indent with 4 spaces to include sub-list elements (tables, blockq­uotes, code examples, etc.)
1.
Ordered list. Indent with 4 spaces to include sub-list elements (tables, blockq­uotes, code examples, etc.)
>
Blockquote
\n\n
New paragraph (hit enter twice)
[linked text](­htt­ps:­//m­ysi­te.com)
A link to a website
![Alt text](­/pa­th/­to/­img.jpg)
Insert image inline
*word word word*
Bold words
_word word word_
Underlined words
**word word word**
Strong words
__word word word__
Double underlined words

New Doc Template

<pre class=­'me­tad­ata­'>
Title: Your Spec Title
Shortname: your-spec
Level: 1
Status: ED
Group: WGNAME­ORW­HATEVER
URL: http:/­/ex­amp­le.c­om­/ur­l-t­his­-sp­ec-­wil­l-l­ive-at
Editor: Your Name, Your Company http:/­/ex­amp­le.c­om­/yo­ur-­com­pany, your-e­mai­l@e­xam­ple.com, http:/­/ex­amp­le.c­om­/yo­ur-­per­son­al-­website
Abstract: A short descri­ption of your spec, one or two sentences.
</p­re>

Introd­uction {#intro}
======­===­===­===­======

Introd­uction here.

Metadata

Documentation
Title:
The title of the specif­ica­tion. Will typically be inserted as a <h1> at the top of the document (unless the boiler­plate has been changed).
Status:
Status of the document. e.g. ED = Editor's Draft, WD = Working Draft, etc. Is based on the statuses for the Group
Group:
The group / organi­zation issuing the specif­ica­tion. e.g. w3c, iso, fido, etc.
ED:
URL pointing to the latest editor's draft
URL:
The URL for the specif­ication
Short Name:
A short name of the spec, such as css-l­ists or webauthn
Editor:
The name of the person that is an editor for the spec. May have multiple editors, one per line. Format is: Adam Powers, FIDO https://fidoalliance.org, email@fidoalliance.org
Abstract:
A paragraph about this specif­ication
Text Macro:
Defines a custom text macro

Boiler­plate

Docume­ntation
Examples
header.in­clude
The HTML for the header of the document
header-ED.include
The HTML for the header, when the status of the specif­ication is ED. Works for any statuses defined for the Group, and for any boiler­plate where the name ends in -STATUS (e.g. -ED, -WD)
footer.in­clude
The HTML for the footer of the document
copyri­ght.in­clude
The copyright statement
logo.i­nclude
The HTML for the logo to be used, by default on the top right of the specif­ication
 

Autoli­nking

Docume­ntation
## heading {#link­-name}
Creates a new <h2> that is linkable by link-­name
[[foo]]
A non-no­rmative reference to the SpecRef entry foo
[[!foo]]
A normative reference to the SpecRef entry foo
A reference to the section in the local document named foo
[[foo#­bar]]
A reference to section bar of spec foo. The spec foo must be part of Bikeshed's autoli­nking database.
[[spec/page#id]]
A reference to section bar on page of spec foo. The spec foo must be part of Bikeshed's autoli­nking database.
[[spec­/page]]
A reference to section to page of spec foo. The spec foo must be part of Bikeshed's autoli­nking database.
{{foo}}
A reference to the IDL entry for foo
'foo'
Link to a property or descriptor named foo
<df­n>t­erm­</d­fn>
A definition for term
[=foo=]
Link to definition of foo

Special Blocks

Issue:
Adds the text that follows as a new issue with the specif­ica­tion. Will appear in a box and be added to the issue list.
Note:
Adds the text that follows as a note to the specif­ication
Example:
Adds the text that follows as an example
Advisement:
Adds the text that follows as an advisement
Assertion:
Adds the text that follows as an assertion

Special Classes

class=­"­not­e"
Same as Note:
class=­"­iss­ue"
Same as Issue:
class=­"­idl­"
Defines an IDL block
<pre class="highlight">
Defines pre-fo­rmatted text highli­ghted as code
line-h­igh­lig­ht=­"2-4, 6"
Add to a highl­ight class to emphasize specific lines of code
line-n­umbers
Add to a highl­ight class to add line numbers to the code

Text Macros

Documentation
[TITLE]
gives the spec’s full title, as extracted from either the H1 or the spec metadata
[SHORT­NAME]
gives the document’s shortname, like "­css­-ca­sca­de"
[VSHORTNAME]
gives the "­ver­sio­ned­" shortname, like "­css­-ca­sca­de-­3"
[STATUS]
gives the spec’s status
[LONGS­TATUS]
gives a long form of the spec’s status, so "­ED" becomes "­Edi­tor’s Draft", for example
[STATU­STEXT]
gives an additional status text snippet
[LATEST]
gives the link to the undated /TR link, if it exists
[VERSION]
gives the link to the ED, if the spec is an ED, and otherwise constructs a dated /TR link from today’s date
[ABSTRACT]
gives the document’s abstract
[YEAR]
gives the current year
[DATE]
gives a human-­rea­dable date
[CDATE]
gives a compact date in the format "­YYY­YMM­DD"
[ISODATE]
gives a compact date in iso format "­YYY­Y-M­M-D­D"
[LOGO]
gives the url of the spec’s logo
[REPOS­ITORY]
gives the name of the VCS repository the spec is located in; this is currently only filled when the spec source is in a GitHub repository

Properties and Descri­ptors

<pre class=­'pr­opd­ef'> (or 'descdef')
Name: var-*
Value: <<v­alu­e>> | <<C­DO>> | <<C­DC>>
Initial: (nothing, see prose)
Applies to: all elements
Inherited: yes
Media: all
Computed value: specified value with variables substi­tuted (but see prose for "­invalid variab­les­")
Percen­tage: n/a
</p­re>

Download the Bikeshed Cheat Sheet

3 Pages
//media.cheatography.com/storage/thumb/apowers313_bikeshed.750.jpg

PDF (recommended)

Alternative Downloads

Share This Cheat Sheet!

Like this cheat sheet? Check out our sponsors!

Readable.io is a collection of tools to make your writing better. More readable content means higher conversion rates and better reader engagement. Measure website and document readability, measure keyword density and more!

Click Here To Get Started!

 

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          Related Cheat Sheets

            Recommended DTDs Cheat Sheet by W3C

          More Cheat Sheets by apowers313