Skip to content

Commit 0b8822c

Browse files
committed
RFC: Tool Introspection Wording
Initial, ported from wg21 source, wording for ecostd/rfcs#2
1 parent 626ed49 commit 0b8822c

15 files changed

+668
-1
lines changed

build.jam

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,13 @@ install std-pub
2121
<location>.build/pub
2222
<doc-stage>draft:<name>draft.html
2323
;
24+
25+
install std-json
26+
: [ glob src/std_*.json ]
27+
: <location>.build/pub
28+
;
29+
30+
alias all
31+
: std-pub std-json
32+
test//validate
33+
;

src/std-docinfo.html

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,98 @@
2222
#covertitle .title {
2323
font-size: 1.2em;
2424
}
25+
26+
/* Table of Contents. */
27+
28+
#toc ul.sectlevel1 > li {
29+
margin-bottom: 1em;
30+
}
31+
#toc ul.sectlevel1 > li > a {
32+
font-weight: bold;
33+
}
34+
35+
/* Admonitions, i.e. notes. */
36+
37+
.admonitionblock > table {
38+
width: auto;
39+
}
40+
.admonitionblock .icon {
41+
vertical-align: top;
42+
padding: 0 0.25em 0 0 !important;
43+
width: fit-content !important;
44+
}
45+
.admonitionblock .icon .title {
46+
text-transform: none !important;
47+
width: fit-content !important;
48+
font-weight: normal !important;
49+
font-style: italic !important;
50+
font-family: serif !important;
51+
font-size: inherit !important;
52+
}
53+
.admonitionblock .content {
54+
border: none !important;
55+
padding: 0 !important;
56+
}
57+
58+
/* General formatting. */
59+
60+
.indented {
61+
margin-left: 3em;
62+
}
63+
64+
.term {
65+
font-style: italic;
66+
font-family: sans-serif;
67+
}
68+
69+
.ucode::before {
70+
content: "U+";
71+
}
72+
.ucode, .uname {
73+
font-family: serif;
74+
font-style: normal;
75+
text-transform: uppercase;
76+
}
77+
78+
/* BNF grammar descriptions. */
79+
80+
.bnf {
81+
margin-left: 3em;
82+
}
83+
.bnf dl dt {
84+
font-weight: normal;
85+
font-style: italic;
86+
font-family: sans-serif;
87+
}
88+
.bnf dl dd {
89+
margin-left: 3em;
90+
font-weight: normal;
91+
font-style: italic;
92+
font-family: sans-serif;
93+
}
94+
.bnf .opt::after {
95+
content: "opt";
96+
position: relative;
97+
top: 0.25em;
98+
font-size: 60%;
99+
}
100+
.bnf .descr {
101+
font-style: normal;
102+
font-family: serif;
103+
}
104+
105+
/* Examples. */
106+
107+
.exampleblock > .content::before {
108+
content: "Example: ";
109+
font-weight: normal !important;
110+
font-style: italic !important;
111+
font-family: serif !important;
112+
}
113+
.exampleblock > .content {
114+
background: none;
115+
border: none;
116+
padding: 0;
117+
box-shadow: none;
118+
}
25119
</style>

src/std.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,18 @@ toc::[]
4141
include::std.license.adoc[leveloffset=+1]
4242

4343
//-------------------------------------------------------------------
44-
// Chapters..
44+
// Intro Chapters..
4545
:sectnums:
4646

4747
include::std.intro.adoc[leveloffset=+1]
4848
include::std.conventions.adoc[leveloffset=+1]
4949
include::std.refs.adoc[leveloffset=+1]
5050
include::std.defs.adoc[leveloffset=+1]
5151

52+
//-------------------------------------------------------------------
53+
// Body Chapters..
54+
include::std.introspection.adoc[leveloffset=+1]
55+
5256
//-------------------------------------------------------------------
5357
// Appendices..
5458
:sectnums!:

src/std.defs.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,31 @@ and the following apply.
99
Terms that are used only in a small portion of this document are defined where
1010
they are used and _italicized_ where they are defined.
1111

12+
*application*: A computer program that performs some desired function.
13+
14+
*capability*: An aspect of an overall specification that defines a subset of the
15+
entire specification.
16+
17+
*directory*: A file that contains directory entries.
18+
19+
*file*: An object that can be written to, or read from, or both.
20+
21+
*filename*: A sequence of bytes used to name a file.
22+
23+
*parent directory*: A directory containing a directory entry for the file under
24+
discussion.
25+
26+
*pathname*: A string that is used to identify a file.
27+
28+
*implementation define*: ???
29+
30+
1231
////
32+
1333
(((application)))
1434
1535
[[defns.application,([defns.application])]]
1636
application::
1737
a computer program that performs some desired function.
38+
1839
////

0 commit comments

Comments
 (0)