Repository files navigation

The draft C++ Library Fundamentals Technical Specification.

The draft can be viewed online at:https://cplusplus.github.io/fundamentals-ts/

This TS is written using a set ofcustom HTML elementsbased on thePolymer framework.

This guide is intended to produce results compatible with the main C++standard, which is written in LaTeX.

Look for applicable<cxx-*> elements,and write semantic markup according tohttp://developers.whatwg.org/.

Generally use<code> rather than<samp>,<kbd>,<tt> or othermonospacing elements.<samp> could be useful for sample compilererror messages. Don't use<kbd> for code a user might enter: that'sjust<code>.

Use<em> for emphasis and<i> for text in another "voice", likecomments and technical terms.<dfn> is good for the defininginstance of a term, but not for subsequent uses. I may add a<cxx-term> element to call out uses of technical terms specifically,which will enable automatic cross-linking and indexing.

Use<var> for variables. There's tension between using it for allvariables, including function parameters, and only calling outmeta-variables used in documentation. I'm leaning toward onlymeta-variables, since marking up parameters requires a huge number oftags, which make it harder to read the source, and there's not muchreason to italicize normal variables. Most meta-variables will end upmarked up as<code><var>meta-variable</var></code>.

Very little text is bold, either with<strong> or<b>.

Any repeated markup structure should be abstracted out into a customelement in thehttps://github.com/cplusplus/html-doc-framework project.

Namespace contents are indented by 2 spaces, with one blank linebetween the namespace open and the first line of the contents.Multiple namespaces can be opened at the same indentation level, like:

namespacestd {namespaceexperimental {classcontents{};}// namespace experimental}// namespace std

Namespaces are only shown in header synopses, not around class orfunction definitions.