Skip to content
The draft C++ Library Fundamentals Technical Specification
HTML Other
  1. HTML 99.7%
  2. Other 0.3%
Branch: v3
Clone or download
jwakely and tkoeppe [README.md] Update links to pre-rendered HTML drafts
The rawgit.com site is going away, so use GitHub Pages instead.
Latest commit cf3b407 Jul 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bower_components Update the HTML document framework. Jun 7, 2015
papers Update configuration to build new working draft N4806. Mar 13, 2019
tools Italicize resource_adaptor_imp to clarify that the name isn't normative. Mar 2, 2014
.editorconfig Add an .editorconfig file to make it easier to edit uniformly. May 10, 2015
README.md [README.md] Update links to pre-rendered HTML drafts Jul 4, 2019
algorithms.html Harmonize stable labels for header synopses Mar 13, 2019
bower.json Add a bower.json to make it easier to update the HTML document framew… May 22, 2015
container.html Harmonize stable labels for header synopses Mar 13, 2019
cxx17_index.json P1224R0 LWG2960 nonesuch is insufficiently useless Nov 12, 2018
func.html Harmonize stable labels for header synopses Mar 13, 2019
fundamentals-ts.html [scopeguard.uniqueres.create] Fix nesting of example and code. Mar 19, 2019
futures.html Harmonize stable labels for header synopses Mar 13, 2019
general.html P0052R10 Generic Scope Guard and RAII Wrapper for the Standard Library Mar 13, 2019
iterator.html Harmonize stable labels for header synopses Mar 13, 2019
main.html Update configuration to build drafts after N4806. Mar 13, 2019
memory.html Harmonize stable labels for header synopses Mar 13, 2019
mods.html P0052R10 Generic Scope Guard and RAII Wrapper for the Standard Library Mar 13, 2019
numeric.html Harmonize stable labels for header synopses Mar 13, 2019
reflection.html Harmonize stable labels for header synopses Mar 13, 2019
utilities.html [scopeguard.uniqueres.create] Fix nesting of example and code. Mar 19, 2019

README.md

fundamentals-ts

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 of custom HTML elements based on the Polymer framework.

Style guide

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 to http://developers.whatwg.org/.

Generally use <code> rather than <samp>, <kbd>, <tt> or other monospacing elements. <samp> could be useful for sample compiler error messages. Don't use <kbd> for code a user might enter: that's just <code>.

Use <em> for emphasis and <i> for text in another "voice", like comments and technical terms. <dfn> is good for the defining instance 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 all variables, including function parameters, and only calling out meta-variables used in documentation. I'm leaning toward only meta-variables, since marking up parameters requires a huge number of tags, which make it harder to read the source, and there's not much reason to italicize normal variables. Most meta-variables will end up marked 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 custom element in the https://github.com/cplusplus/html-doc-framework project.

Namespace formatting

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

namespace std {
namespace experimental {

  class contents{};

} // namespace experimental
} // namespace std

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

You can’t perform that action at this time.