Skip to content

Commit 0106cf6

Browse files
jyasskinjyasskin
committed
Switch to https://github.com/cplusplus/html-doc-framework for the custom elements.
1 parent 1d87475 commit 0106cf6

39 files changed

+882
-89
lines changed

‎bower_components/cxx-html-doc-framework/.bower.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"name": "cxx-html-doc-framework",
3+
"description": "A set of custom HTML elements to make writing well-formatted C++ papers and ISO documents easier.",
4+
"main": "framework.html",
5+
"homepage": "https://github.com/cplusplus/html-doc-framework",
6+
"ignore": [
7+
"**/.*",
8+
"bower_components",
9+
"test",
10+
"tests"
11+
],
12+
"dependencies": {
13+
"polymer-ajax": "Polymer/polymer-ajax#0.2.0"
14+
},
15+
"_release": "ee6db917ba",
16+
"_resolution": {
17+
"type": "branch",
18+
"branch": "master",
19+
"commit": "ee6db917ba352913ea5c67d462eed71a5a4fd6b7"
20+
},
21+
"_source": "git://github.com/cplusplus/html-doc-framework.git",
22+
"_target": "*",
23+
"_originalSource": "cplusplus/html-doc-framework",
24+
"_direct": true
25+
}

‎bower_components/cxx-html-doc-framework/LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2014 Google Inc. All rights reserved.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎bower_components/cxx-html-doc-framework/README.md

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
C++ HTML document framework
2+
===========================
3+
4+
This is a [Polymer](http://www.polymer-project.org/)-based HTML framework for
5+
writing ISO C++ documents and papers. To use it for your document, you should
6+
7+
1. [Install Bower.](http://bower.io/#installing-bower)
8+
2. Install this package by running `bower install cplusplus/html-doc-framework` in the root directory of your document.
9+
3. Import this package into your main HTML file by adding two lines inside the `<head>` element:
10+
11+
```HTML
12+
<script src="bower_components/platform/platform.js"></script>
13+
<link rel="import" href="bower_components/cxx-html-doc-framework/framework.html"/>
14+
```
15+
16+
Before I can accept a contribution to this project, you'll need to sign the
17+
Contributor License Agreement at https://developers.google.com/open-source/cla/individual.
18+
19+
Custom C++-specific elements
20+
----------------------------
21+
22+
### `<cxx-clause>` and `<cxx-section>`
23+
24+
These automatically number clauses and sections, fill in
25+
table-of-contents data, and allow cross-linking. `<cxx-clause>` is for
26+
top-level sections, while `<cxx-section>` can be nested arbitrarily.
27+
The title of the section is given in a nested `<h1>` element.
28+
The `id` attribute is used for cross-linking.
29+
30+
### `<cxx-titlepage>`
31+
32+
Wraps the title page of an ISO document. The title page takes a
33+
`stage` attribute whose value can be `draft` or (once I implement
34+
them) `CD`, `DTS`, `TS`, etc. The title page recognizes several
35+
nested elements that describe the document.
36+
37+
#### `<cxx-docnum>`
38+
39+
The D or N number for the document.
40+
41+
#### `<time pubdate>`
42+
43+
The publication date of the document in ISO (YYYY-MM-DD) format.
44+
45+
#### `<cxx-revises>`
46+
47+
The N number of the previous version of the document.
48+
49+
#### `<cxx-editor>`
50+
51+
A paragraph describing the editor of the document. Use `<br>` to
52+
separate lines.
53+
54+
### `<cxx-toc>`
55+
56+
Generates a table of contents based on the `<cxx-section>` structure.
57+
58+
### `<cxx-publish-button>`
59+
60+
Open the document using Polymer's shadow-dom polyfill (add
61+
`?shadow=polyfill` to the URL) and then click this button to generate
62+
a standalone version of the document, that doesn't rely on any custom
63+
elements, scripts, or external CSS. The result of this transformation
64+
is what actually gets published in the C++ committee mailings.
65+
66+
It's tested back to IE 8 and should degrade fairly gracefully in even
67+
older browsers.
68+
69+
70+
### `<dl is="cxx-definition-section">`
71+
72+
Numbers the terms in the `<dl>` with the parent `<cxx-section>`'s section
73+
number, and formats and links the `id`.
74+
75+
76+
### `<cxx-ednote>`
77+
78+
An editor's note that won't appear in the final published document.
79+
This is formatted as a separate box on the side of the document.
80+
81+
82+
### `<cxx-email>`
83+
84+
Must contain an email address as text, and wraps it into an
85+
appropriate `mailto:` link.
86+
87+
### `<cxx-function>`
88+
89+
Describes a C++ library function. Several nested elements help
90+
describe the signatures and semantics of a function.
91+
92+
#### `<cxx-signature>`
93+
94+
Use one of these for each related function signature that can be
95+
described by a single set of attributes.
96+
97+
#### `<cxx-requires>`, `<cxx-effects>`, `<cxx-synchronization>`, `<cxx-postconditions>`, `<cxx-returns>`, `<cxx-throws>`, `<cxx-exception-safety>`, `<cxx-remarks>`, `<cxx-error-conditions>`, and `<cxx-notes>`
98+
99+
Each of these elements represents one attribute from [structure.specifications]p3 ([except for `<cxx-exception-safety>`](https://github.com/cplusplus/draft/issues/228)).
100+
101+
### `<cxx-note>`
102+
103+
Wraps non-normative text inside a paragraph.
104+
105+
### `<cxx-ref>`
106+
107+
Links to a section in the current document, whose `id` is given by the
108+
`to` attribute on the `<cxx-ref>`. References are displayed like
109+
"`(1.2.3)`", unless the `insynopsis` attribute is also present, in
110+
which case the reference is displayed as a C++ comment, "`// 1.2.3,
111+
title of referenced section`".
112+
113+
### `<table is="cxx-table">`
114+
115+
Adds a "Table # —" prefix to the table `<caption>`.
116+
117+
Style guide for documents using this framework
118+
----------------------------------------------
119+
120+
This guide is intended to produce results compatible with the main C++
121+
standard, which is written in LaTeX.
122+
123+
Write semantic markup according to http://developers.whatwg.org/.
124+
125+
Generally use `<code>` rather than `<samp>`, `<kbd>`, `<tt>` or other
126+
monospacing elements. `<samp>` could be useful for sample compiler
127+
error messages. Don't use `<kbd>` for code a user might enter: that's
128+
just `<code>`.
129+
130+
Use `<em>` for emphasis and `<i>` for text in another "voice", like
131+
comments and technical terms. `<dfn>` is good for the defining
132+
instance of a term, but not for subsequent uses. I may add a
133+
`<cxx-term>` element to call out uses of technical terms specifically,
134+
which will enable automatic cross-linking and indexing.
135+
136+
Use `<var>` for variables. There's tension between using it for all
137+
variables, including function parameters, and only calling out
138+
meta-variables used in documentation. I'm leaning toward only
139+
meta-variables, since marking up parameters requires a huge number of
140+
tags, which make it harder to read the source, and there's not much
141+
reason to italicize normal variables. Most meta-variables will end up
142+
marked up as `<code><var>meta-variable</var></code>`.
143+
144+
Very little text is bold, either with `<strong>` or `<b>`.
145+
146+
In CSS, avoid the CSS `content` property because it doesn't copy/paste well in many browsers.
147+
Use a custom element with text in the `<template>` instead.
148+
Shadow DOM (what's generated from the template) also doesn't copy/paste well, but that's improving,
149+
and the polyfill can produce non-Shadow DOM, which `<cxx-publish>` can fix into plain HTML.

‎elements/base.css renamed to ‎bower_components/cxx-html-doc-framework/base.css

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/* Copyright 2014 Google Inc. All rights reserved.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.
14+
*/
15+
116
@page {
217
margin: 10%;
318
@top-left { content: "© ISO/IEC"; font-size: 10pt; }

0 commit comments

Comments
 (0)