diff --git a/spec/index.html b/spec/index.html index cbe091de..e62b303c 100644 --- a/spec/index.html +++ b/spec/index.html @@ -161,20 +161,69 @@

emu-clause

Attributes

id: Clause id. Must be unique.

-

aoid: Abstract operation ID. A unique name identifying this clause as an abstract operation. Algorithm steps will auto-link calls to this abstract operation to this clause. If left blank, the aoid will be set to the id of this clause.

+

example: If present, the clause is an example.

+

legacy: If present, the clause is Legacy.

normative-optional: If present, the clause is Normative Optional.

+

type: Optional: Type of feature described by the clause.

+ + + +

Legacy Attributes

+

aoid: Abstract operation ID. A unique name identifying this clause as an abstract operation. Algorithm steps will auto-link calls to this abstract operation to this clause. If left blank, the aoid will be set to the id of this clause. When a structured header is present the aoid will be inferred, but this attribute may be set explicitly when not using a structured header.

+
+ + +

Structured Headers

+

A clause describing an operation or method may have a structured header to document its signature and metadata. Such a structure consists of:

+
    +
  1. an <h1> element containing the name of the operation followed by a parenthesized list of parameters, each appearing on a comma-terminated line of its own and consisting of a name and value constraints separated by a colon and optionally preceded with "optional"
  2. +
  3. + a <dl> element with class "header" and a collection of optional key-value pairs expressed using <dt> and <dd> elements: +
      +
    • description: An explanation of the operation's behavior.
    • +
    • for: The type of value to which a clause of type "concrete method" or "internal method" applies.
    • +
    +
  4. +
+

Example

Element


-      <emu-clause id="example-normative-optional" normative-optional>
-        <h1>Example Normative Optional Clause</h1>
+      <emu-clause id="example-normative-optional" type="abstract operation" example normative-optional>
+        <h1>
+          ExampleOperation (
+            _S_: a String,
+            optional _length_: a non-negative integer,
+          )
+        </h1>
+        <dl class="header">
+          <dt>description</dt>
+          <dd>It returns a List of the code points of the first _length_ grapheme clusters of _S_ using the host environment's current locale, or all code points when _length_ is not present.</dd>
+        </dl>
         <p>This clause is normative optional.</p>
       </emu-clause>
     

Result

- -

Example Normative Optional Clause

+ +

+ ExampleOperation ( + _S_: a String, + optional _length_: a non-negative integer, + ) +

+
+
description
+
It returns a List of the code points of the first _length_ grapheme clusters of _S_ using the host environment's current locale, or all code points when _length_ is not present.
+

This clause is normative optional.