Skip to content

Commit a96a683

Browse files
leobalterleobalter
committed
More meta data to the doc
1 parent 8c95b96 commit a96a683

10 files changed

+220
-10
lines changed

‎assets/img/ecma-logo.svg

+120
Loading

‎assets/img/favicon.ico

5.3 KB
Binary file not shown.

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"name": "tc53-draft",
44
"description": "Draft for ECMAScript Modules for Embedded Systems",
55
"scripts": {
6-
"build": "ecmarkup --verbose spec/index.emu out/index.html --assets none --css out/main.css --js out/main.js",
6+
"build": "ecmarkup --verbose spec/index.emu out/index.html --assets none --img out/img --css out/main.css --js out/main.js",
77
"prebuild": "rm -rf out && mkdir out && cp -R assets/* out/",
88
"build-for-pdf": "npm run build -- --old-toc",
99
"test": "exit 0",

‎spec/colophon.emu

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<emu-annex id="sec-colophon">
2+
<h1>Colophon</h1>
3+
<p>This specification is authored on <a href="https://github.com/EcmaTC53/draft">GitHub</a> in a plaintext source format called <a href="https://github.com/bterlson/ecmarkup">Ecmarkup</a>. Ecmarkup is an HTML and Markdown dialect that provides a framework and toolset for authoring ECMAScript specifications in plaintext and processing the specification into a full-featured HTML rendering that follows the editorial conventions for this document. Ecmarkup builds on and integrates a number of other formats and technologies including <a href="https://github.com/rbuckton/grammarkdown">Grammarkdown</a> for defining syntax and <a href="https://github.com/domenic/ecmarkdown">Ecmarkdown</a> for authoring algorithm steps. PDF renderings of this specification are produced by printing the HTML rendering to a PDF.</p>
4+
</emu-annex>

‎spec/conformance.emu

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<emu-clause id="conformance">
2+
<h1>Conformance</h1>
3+
<p>
4+
A conforming implementation of the ECMAScript Modules for Embedded Systems Specification must conform to the ECMAScript Language Specification (ECMA-262 10<sup>th</sup> Edition, or successor), and must provide and support all the objects, properties, functions, and program semantics described in this specification.
5+
</p>
6+
<p>
7+
A conforming implementation of the ECMAScript Modules for Embedded Systems Specification is permitted to provide additional objects, properties, and functions beyond those described in this specification. In particular, a conforming implementation of the ECMAScript Modules for Embedded Systems Specification is permitted to provide properties not described in this specification, and values for those properties, for objects that are described in this specification. A conforming implementation is not permitted to add optional arguments to the functions defined in this specification.
8+
</p>
9+
</emu-clause>

‎spec/conventions.emu

+10-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<h1>Notational Conventions</h1>
33

44
<p>
5-
This standard uses a subset of the notational conventions of the ECMAScript 2020 Language Specification (ECMA-262 10<sup>th</sup> Edition), as ES2020:
5+
This standard uses a subset of the notational conventions of the ECMAScript Language Specification (ECMA-262 10<sup>th</sup> Edition), as ES2020:
66
</p>
77

88
<ul>
@@ -59,4 +59,12 @@
5959
</emu-table>
6060

6161
</emu-clause>
62-
</emu-clause>
62+
</emu-clause>
63+
64+
<emu-clause id="requirements">
65+
<h1>Requirements for Standard Built-in ECMAScript Objects</h1>
66+
67+
<p>
68+
Unless specified otherwise in this document, the objects, functions, and constructors described in this standard are subject to the generic requirements and restrictions specified for standard built-in ECMAScript objects in the ECMAScript Language Specification, 10<sup>th</sup> edition, clause <emu-xref href="#sec-ecmascript-standard-built-in-objects"></emu-xref>, or successor.
69+
</p>
70+
</emu-clause>

‎spec/index.emu

+13-5
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,21 @@
55
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/github.min.css">
66
<script src="./main.js"></script>
77
<pre class="metadata">
8-
title: ECMAScript Modules for Embedded Systems
9-
status: draft
10-
version: 0.0.1
11-
copyright: true
8+
title: ECMAScript&reg; Modules for Embedded Systems
9+
shortname: TC53-Draft
10+
location: https://ecmatc53.github.io/draft/
11+
status: draft
1212
</pre>
13-
13+
<style>
14+
#ecma-logo {
15+
width: 500px;
16+
}
17+
</style>
18+
<p><img src="img/ecma-logo.svg" id=ecma-logo></p>
19+
<emu-import href="./metablock.emu"></emu-import>
20+
<emu-import href="./introduction.emu"></emu-import>
1421
<emu-import href="./normative-references.emu"></emu-import>
1522
<emu-import href="./conventions.emu"></emu-import>
1623
<emu-import href="./sensors.emu"></emu-import>
1724
<emu-import href="./pwm.emu"></emu-import>
25+
<emu-import href="./colophon.emu"></emu-import>

‎spec/introduction.emu

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<emu-intro id="introduction">
2+
<h1>Introduction</h1>
3+
<p>
4+
This specification's source can be found at <a href="https://github.com/EcmaTC53/draft">https://github.com/EcmaTC53/draft</a>.
5+
</p>
6+
<p>
7+
The ECMAScript Modules for Embedded Systems Specification (ECMA-nnn 1<sup>st</sup> Edition), provides key language sensitive functionality as a complement to the ECMAScript Language Specification (ECMA-262 10<sup>th</sup> Edition or successor). Its functionality has been selected from that of well-established Embedded Systems APIs.
8+
</p>
9+
<p>
10+
NAME TBD<br>
11+
ECMA-nnn, 1<sup>st</sup> Edition Project Editor
12+
</p>
13+
</emu-intro>
14+
15+
<emu-clause id="scope">
16+
<h1>Scope</h1>
17+
<p>
18+
This Standard defines the application programming interface for ECMAScript modules that support programs that need to adapt to conventions used by different embedded systems.
19+
</p>
20+
21+
</emu-clause>
22+
23+
<emu-clause id="conformance">
24+
<h1>Conformance</h1>
25+
<p>
26+
A conforming implementation of the ECMAScript Modules for Embedded Systems Specification must conform to the ECMAScript Language Specification (ECMA-262 10<sup>th</sup> Edition, or successor), and must provide and support all the objects, properties, functions, and program semantics described in this specification.
27+
</p>
28+
<p>
29+
A conforming implementation of the ECMAScript Modules for Embedded Systems Specification is permitted to provide additional objects, properties, and functions beyond those described in this specification. In particular, a conforming implementation of the ECMAScript Modules for Embedded Systems Specification is permitted to provide properties not described in this specification, and values for those properties, for objects that are described in this specification. A conforming implementation is not permitted to add optional arguments to the functions defined in this specification.
30+
</p>
31+
</emu-clause>
32+

‎spec/metablock.emu

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
<div id=metadata-block>
3+
<h1>Contributing to this Specification</h1>
4+
<p>This specification is developed on GitHub with the help of the ECMAScript community. There are a number of ways to contribute to the development of this specification:</p>
5+
<ul>
6+
<li>GitHub Repository: <a href="https://github.com/EcmaTC53/draft">https://github.com/EcmaTC53/draft</a></li>
7+
<li>Issues: <a href="https://github.com/EcmaTC53/draft/issues">All Issues</a>, <a href="https://github.com/EcmaTC53/draft/issues/new">File a New Issue</a></li>
8+
<li>Pull Requests: <a href="https://github.com/EcmaTC53/draft/pulls">All Pull Requests</a>, <a href="https://github.com/EcmaTC53/draft/pulls/new">Create a New Pull Request</a></li>
9+
<li>Test Suite: <a href="https://github.com/EcmaTC53/tests">Not available yet</a></li>
10+
<li>Admin:
11+
<ul>
12+
<li>Chair: <a href="mailto:#">Peter Hoddie</a> (<a href="https://github.com/phoddie">@phoddie</a>)</li>
13+
</ul>
14+
</li>
15+
<li>Editors:
16+
<ul>
17+
<li><a href="mailto:#">TBD</a> (<a href="https://github.com/EcmaTC53">@TBD</a>)</li>
18+
</ul>
19+
</li>
20+
<li>
21+
Community:
22+
<ul>
23+
<li>Mailing list: <a href="#">TBD</a></li>
24+
<li>IRC: <a href="ircs://irc.freenode.net:6667">#TBD</a> on <a href="https://freenode.net/kb/answer/chat">freenode</a></li>
25+
</ul>
26+
</li>
27+
</ul>
28+
<p>Refer to the <emu-xref href="#sec-colophon">colophon</emu-xref> for more information on how this document is created.</p>
29+
</div>

‎spec/normative-references.emu

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
</p>
66

77
<p>
8-
ECMAScript 2020 Language Specification (ECMA-262 10<sup>th</sup> Edition, or successor).<br>
8+
ECMAScript Language Specification (ECMA-262 10<sup>th</sup> Edition, or successor).<br>
99
<a href="https://www.ecma-international.org/publications/standards/Ecma-262.htm">https://www.ecma-international.org/publications/standards/Ecma-262.htm</a>
1010
</p>
1111

1212
<emu-note>
13-
Throughout this document, the phrase &ldquo;ES2020, _x_&rdquo; (where x is a sequence of numbers separated by periods) may be used as shorthand for "ECMAScript 2020 Language Specification (ECMA-262 10<sup>th</sup> Edition, sub clause _x_)".
13+
Throughout this document, the phrase &ldquo;ES2020, _x_&rdquo; (where x is a sequence of numbers separated by periods) may be used as shorthand for "ECMAScript Language Specification (ECMA-262 10<sup>th</sup> Edition, sub clause _x_)".
1414
</emu-note>
1515

1616
<ul>

0 commit comments

Comments
 (0)