Skip to content

Commit e2e1728

Browse files
committed
spec/dfn-patterns: Added summary
1 parent c569b57 commit e2e1728

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

spec/dfn-patterns.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ Historically, CSS drafts have had very little structure in the way they mark up
44

55
This page documents the patterns and attributes that are recognized by [[http://wiki.csswg.org/tools|Shepherd, our spec parsing tool, and Tab's preprocessor]]. By using these in your own specs, you make your life and the lives of other editors easier, and contribute to better automatically-generated CSS documentation.
66

7+
===== Summary =====
8+
9+
All ''<dfn>'' elements have a definition type. This can usually be inferred from the contents or context, but might need to be explicitly specified.
10+
11+
Some types of definitions are part of some higher construct. This should be indicated with a ''data-dfn-for'' attribute on the definition or a container.
12+
13+
Getting this metadata right is easy and helps with auto-crossreferencing (in Tab's preprocessor) and automatically generated documentation (in Shepherd), so please get it right.
14+
715
===== <dfn> Types =====
816

917
To aid with cross-linking and automatic documentation, definitions are now classified into one of several categories:

0 commit comments

Comments
 (0)