Home Specs Ideas Testing About
You are here: CSS Working Group Wiki » Specification Issues and Planning » <dfn> Patterns for Proper Cross-Linking

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
spec:dfn-patterns [2013/07/30 11:41] – Filled in page tabatkinsspec:dfn-patterns [2013/07/30 11:44] – Added summary tabatkins
Line 4: Line 4:
  
 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. 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.
 +
 +===== Summary =====
 +
 +All ''<dfn>'' elements have a definition type.  This can usually be inferred from the contents or context, but might need to be explicitly specified.
 +
 +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.
 +
 +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.
  
 ===== <dfn> Types ===== ===== <dfn> Types =====
 
spec/dfn-patterns.txt · Last modified: 2014/12/09 15:48 by 127.0.0.1
Recent changes RSS feed Valid XHTML 1.0 Valid CSS Driven by DokuWiki