Proposed Extensions to CommonMark

Christoph Päper edited this page Nov 2, 2016 · 6 revisions

Terminology

flavor, variant, dialect, syntactic sugar, extension, plug-in, add-on …

deployed = active by default, implemented = optional extension, proposed = not implemented anywhere

Concepts described on separate pages

Critic Markup

http://criticmarkup.com

deletion

<del>deletion</del>

change (removal/replacement)

<del>removal</del><ins>replacement</ins>

addition

<ins>addition</ins>

highlighting, marked text

<mark>highlighted</mark>

comment

<span title="comment">text</span>

See also Notes section.

Strike-through

<s>stricken</s>

Underlines

<u>underlined</u>

Line Breaks

line<br>
break
line<br />
break

Links

Link Syntax Sugar

automatic IDs

<h1 id="heading">Heading</h1>

Implicit Shortcut Links

<a href="#heading">Heading</a>

Shortcut Reference Links

<a href="http://example.com">Reference</a>

see also: CURIE

Notes

footnotes / endnotes

<p>text<a href="#fn1" class="footnote marker" id="fn1.1">1</a></p>

<footer>
<p id="fn1">note, <a href="#fn1.1">↪︎</a></p>
</footer>

marginnotes / sidenotes / asides

<p>text<a href="#sn1" class="sidenote marker" id="sn1.1">1</a></p>

<aside>
<p id="sn1">note, <a href="#sn1.1">↪︎</a></p>
</aside>

slidenotes

<aside>
<p>note</p>
</aside>

inlinenotes / ruby

<ruby>
🐮<rp> (</rp><rt>bull</rt><rp>)</rp>
💩<rp> (</rp><rt>shit</rt><rp>)</rp>
</ruby>

<ruby>🤔💡<rp> (</rp><rt>Eureka!</rt><rp>)</rp></ruby>

tooltips

<span class="tooltip" title="note">text</a>

Spoiler Warnings, hidden answers

<p class="spoiler">spoiler</p>
.spoiler {color: transparent;}
.spoiler:focus,
.spoiler:active,
.spoiler:hover {color: black;}

Paragraph Types or Classes

General and Scientific Articles, Reports and Books

abstract, introduction/lede, byline, …

Textbook boxes, Blurbs

discussion, error, exercise, information, question, tip, warning https://leanpub.com/markua/read#leanpub-auto-blurbs

rST admonitions

attention, caution, danger, error, hint, important, note, tip, warning

Science

corollary, definition, hypothesis, law, lemma, proof, theorem

Other

commentary (not the same as comments), pull-quote

Slide Presentations

slide titles

slide breaks

transitions

sequential uncovering

presenter notes

Paged Media

running header

page numbers

see [Book Structure]

page breaks / pagination

<hr>

page number references

<a href="#reference">Reference on page 1</a>

Book Structure

cover, frontmatter, preface, introduction

<header class="cover">
…
</header>
<section class="frontmatter">
…
</section>

mainmatter

<article class="mainmatter">
…
</article>

backmatter, appendices, imprint

<footer class="backmatter">
…
</footer>

Metadata

Global Document Metadata

<title>Title</title>

attributes, parameters

labels and identifiers

Floats

Captions

Figures

Indices

Table of Contents (TOC) = list of headings

list of figures/floats (LOF), list of tables (LOT) = list of captions

list of code listings, list of equations …

Index ≈ list of Terms and Definitions

Terms and Definitions

Abbreviations and Acronyms

and expansions thereof

<abbr title="expansion">abbr.</abbr>

Technical and Legal Terms, keywords

<dfn>term</dfn>
<b>term</b>

Lists

Glossaries

Definition Lists

<dl>
<dt>term
<dd>definition
</dl>
<dl>
<dt>term</dt>
<dd>definition</dd>
</dl>

FAQ Lists / Q&A

<dl>
<dt>question?
<dd>answer!
</dl>

Pro-Con Lists, Feature lists, Changelog

<ul>
<li class="pro">pro
<li class="con">con
</ul>

To-do List, Agenda

<ul>
<li class="todo">to do
<li class="done">done
</ul>

Numbered Examples

<p class="example" id="ex1">example</p>

Tables

Cells

<td>cell</td>

Rows

<tr>
<td>Row
</tr>

Columns

Column Headers

<th>header</th>

Row Headers

<tr><th>header</th>
…
</tr>

Horizontal Alignment

Block Cell Content

Cells spanning several Columns

Cells spanning several Rows

Caption

CSV

Incorporated Resources

Media Files embedded

audio, video, YouTube, …

includes, transclusions

External Code Samples

Style

templates (layout, variables), designs, themes (colors, pictures), skins

Forms

<form action="./">
</form>

Static Forms, Questionnaire

Interactive Forms

Checkbox Widget, m:n

<input type="checkbox">

Radio Button Widget, 1:n

<input type="radio">

Line Input Widget

<input type="text">

Password Input Widget

<input type="password">

Email Address Input Widget

<input type="email">

Date and Time Input Widgets

<input type="date">

Color Input Widget

Math

Inline Math, Formulas

Display Math, Equations

Numbers and Units, Values

Symbols

Diagrams

Tree Diagrams, Grammars

Charts

Plots

Graphs

Mind Maps

ASCII Art

References

Citations

<cite>key</cite>

Bibliography = list of references

User Names (mentions)

<a href="/user/name" title="User Name">@name</a>

Tags and Categories, Keywords

<a href="/tag/name" title="Tag Name">#name</a>

Symbols

Named Character References

Entities

Numeric Unicode Position References

Escapes

Symbolic References

Emoji/Emoticons

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.