• Stars
    star
    110
  • Rank 316,770 (Top 7 %)
  • Language
    HTML
  • Created about 11 years ago
  • Updated 7 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The draft C++ Library Fundamentals Technical Specification

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.

More Repositories

1

draft

C++ standards drafts
TeX
5,690
star
2

papers

ISO/IEC JTC1 SC22 WG21 paper scheduling and management
Perl
645
star
3

LEWG

Project planning for the C++ Library Evolution Working Group
92
star
4

networking-ts

The draft C++ Extensions for Networking Technical Specification
TeX
90
star
5

reflection-ts

The draft C++ Reflection Technical Specification
TeX
83
star
6

concepts-ts

Technical Specification: Concepts
HTML
80
star
7

concurrency-ts

The draft C++ Library Concurrency Technical Specification
HTML
71
star
8

parallelism-ts

Technical Specification: Parallelism
HTML
67
star
9

filesystem-ts

Library Enhancements Working Group
Shell
57
star
10

transactional-memory-ts

HTML
40
star
11

SG20

Study Group 20: Education
CSS
36
star
12

CWG

Core Working Group
24
star
13

html-doc-framework

A set of custom HTML elements to make writing well-formatted C++ papers and ISO documents easier.
HTML
24
star
14

modules-ts

C++ Modules Technical Specification working draft.
TeX
23
star
15

EWG

Evolution Working Group
HTML
22
star
16

modules-ecosystem-tr

The ISO C++ Modules Ecosystem Technical Report (METeR)
TeX
21
star
17

sender-receiver

Issues list for P2300
HTML
20
star
18

ecosystem-is

Working Draft for a future C++ Ecosystem IS
TeX
19
star
19

nbballot

Handling of NB comments in response to ballots
14
star
20

bikeshed

This repository should have a better name
13
star
21

lib-issues-software

Library issues list software sources
C++
10
star
22

concurrency-ts2

C++ Concurrency TS 2
TeX
10
star
23

cxxpoll

A polling site for the C++ committee.
JavaScript
5
star
24

ssrg

Safety and Security Review Group
3
star
25

SG9

Study Group 9: Ranges
3
star
26

transactional-memory-ts2

Transactional Memory TS2 2021, from NWIP to TS
TeX
2
star
27

mattermost

Issue tracker for Mattermost chat service
JavaScript
1
star