Skip to content

Commit 6daa96e

Browse files
committed
Update README to point at the html-doc-framework repo.
1 parent 0106cf6 commit 6daa96e

File tree

1 file changed

+5
-105
lines changed

1 file changed

+5
-105
lines changed

README.md

+5-105
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@ version](http://cplusplus.github.io/fundamentals-ts/main.html)
88
or the [standalone
99
version](http://cplusplus.github.io/fundamentals-ts/fundamentals-ts.html).
1010

11-
This TS is written using the [Polymer
12-
framework](http://www.polymer-project.org/) to build custom HTML
13-
elements. See the `elements` directory for these elements'
14-
definitions.
11+
This TS is written using a set of [custom HTML elements](https://github.com/cplusplus/html-doc-framework)
12+
based on the [Polymer framework](http://www.polymer-project.org/).
1513

1614

1715
Style guide
@@ -20,7 +18,8 @@ Style guide
2018
This guide is intended to produce results compatible with the main C++
2119
standard, which is written in LaTeX.
2220

23-
Write semantic markup according to http://developers.whatwg.org/.
21+
Look for applicable [`<cxx-*>` elements](https://github.com/cplusplus/html-doc-framework),
22+
and write semantic markup according to http://developers.whatwg.org/.
2423

2524
Generally use `<code>` rather than `<samp>`, `<kbd>`, `<tt>` or other
2625
monospacing elements. `<samp>` could be useful for sample compiler
@@ -44,103 +43,4 @@ marked up as `<code><var>meta-variable</var></code>`.
4443
Very little text is bold, either with `<strong>` or `<b>`.
4544

4645
Any repeated markup structure should be abstracted out into a custom
47-
element in the `elements/` directory.
48-
49-
50-
Custom C++-specific elements
51-
----------------------------
52-
53-
### `<cxx-clause>` and `<cxx-section>`
54-
55-
These automatically number clauses and sections, fill in
56-
table-of-contents data, and allow cross-linking. `<cxx-clause>` is for
57-
top-level sections, while `<cxx-section>` can be nested arbitrarily.
58-
The title of the section is given in a nested `<h1>` element.
59-
The `id` attribute is used for cross-linking.
60-
61-
### `<cxx-titlepage>`
62-
63-
Wraps the title page of an ISO document. The title page takes a
64-
`stage` attribute whose value can be `draft` or (once I implement
65-
them) `CD`, `DTS`, `TS`, etc. The title page recognizes several
66-
nested elements that describe the document.
67-
68-
#### `<cxx-docnum>`
69-
70-
The D or N number for the document.
71-
72-
#### `<time pubdate>`
73-
74-
The publication date of the document in ISO (YYYY-MM-DD) format.
75-
76-
#### `<cxx-revises>`
77-
78-
The N number of the previous version of the document.
79-
80-
#### `<cxx-editor>`
81-
82-
A paragraph describing the editor of the document. Use `<br>` to
83-
separate lines.
84-
85-
### `<cxx-toc>`
86-
87-
Generates a table of contents based on the `<cxx-section>` structure.
88-
89-
### `<cxx-publish-button>`
90-
91-
Open the document using Polymer's shadow-dom polyfill (add
92-
`?shadow=polyfill` to the URL) and then click this button to generate
93-
a standalone version of the document, that doesn't rely on any custom
94-
elements, scripts, or external CSS. The result of this transformation
95-
is what actually gets published in the C++ committee mailings.
96-
97-
It's tested back to IE 8 and should degrade fairly gracefully in even
98-
older browsers.
99-
100-
101-
### `<dl is="cxx-definition-section">`
102-
103-
Numbers the terms in the `<dl>` with the parent `<cxx-section>`'s section
104-
number, and formats and links the `id`.
105-
106-
107-
### `<cxx-ednote>`
108-
109-
An editor's note that won't appear in the final published document.
110-
This is formatted as a separate box on the side of the document.
111-
112-
113-
### `<cxx-email>`
114-
115-
Must contain an email address as text, and wraps it into an
116-
appropriate `mailto:` link.
117-
118-
### `<cxx-function>`
119-
120-
Describes a C++ library function. Several nested elements help
121-
describe the signatures and semantics of a function.
122-
123-
#### `<cxx-signature>`
124-
125-
Use one of these for each related function signature that can be
126-
described by a single set of attributes.
127-
128-
#### `<cxx-requires>`, `<cxx-effects>`, `<cxx-synchronization>`, `<cxx-postconditions>`, `<cxx-returns>`, `<cxx-throws>`, `<cxx-exception-safety>`, `<cxx-remarks>`, `<cxx-error-conditions>`, and `<cxx-notes>`
129-
130-
Each of these elements represents one attribute from [structure.specifications]p3 ([except for `<cxx-exception-safety>`](https://github.com/cplusplus/draft/issues/228)).
131-
132-
### `<cxx-note>`
133-
134-
Wraps non-normative text inside a paragraph.
135-
136-
### `<cxx-ref>`
137-
138-
Links to a section in the current document, whose `id` is given by the
139-
`to` attribute on the `<cxx-ref>`. References are displayed like
140-
"`(1.2.3)`", unless the `insynopsis` attribute is also present, in
141-
which case the reference is displayed as a C++ comment, "`// 1.2.3,
142-
title of referenced section`".
143-
144-
### `<table is="cxx-table">`
145-
146-
Adds a "Table # —" prefix to the table `<caption>`.
46+
element in the https://github.com/cplusplus/html-doc-framework project.

0 commit comments

Comments
 (0)