✨ NEW: Add fields enumerated and enumerator to containers, math, …

…headings (#36) * Add required field numbered to containers, math, headings * Minor fixes to numbered in tests * Make numbered not required * Add optional number field to numbered nodes * Numbered -> enumerated, remove from examples
jupyter-book · Apr 11, 2022 · 753530a · 753530a
1 parent 35f8097
commit 753530a
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 22 deletions.
diff --git a/docs/examples/directives.figure.yml b/docs/examples/directives.figure.yml
@@ -37,7 +37,7 @@ cases:
       Something! A legend!?
       ```
     html: |-
-      <figure>
+      <figure class="numbered">
         <img src="https://via.placeholder.com/150">
         <figcaption>
           <p>This is the figure caption!</p>
@@ -63,7 +63,6 @@ cases:
               kind: figure
               identifier: myfigure
               label: myFigure
-              numbered: true
               children:
                 - type: image
                   url: https://via.placeholder.com/150
@@ -111,7 +110,6 @@ cases:
               kind: figure
               identifier: myfigure
               label: myFigure
-              numbered: true
               children:
                 - type: image
                   url: https://via.placeholder.com/150
@@ -150,7 +148,6 @@ cases:
               kind: figure
               identifier: myfigure
               label: myFigure
-              numbered: true
               children:
                 - type: image
                   url: https://via.placeholder.com/150
@@ -188,7 +185,6 @@ cases:
               kind: figure
               identifier: myfigure
               label: myFigure
-              numbered: true
               children:
                 - type: image
                   url: https://via.placeholder.com/150
@@ -209,7 +205,6 @@ cases:
               kind: figure
               identifier: myotherfigure
               label: myOtherFigure
-              numbered: true
               children:
                 - type: image
                   url: https://via.placeholder.com/151

diff --git a/docs/examples/directives.table.yml b/docs/examples/directives.table.yml
@@ -88,7 +88,6 @@ cases:
               kind: table
               identifier: my-table
               label: my-table
-              numbered: true
               class: myclass
               children:
                 - type: caption

diff --git a/docs/examples/references.equations.yml b/docs/examples/references.equations.yml
@@ -26,7 +26,6 @@ cases:
               kind: figure
               identifier: matrix
               label: matrix
-              numbered: true
               children:
                 - type: image
                   url: fig.jpg

diff --git a/docs/examples/references.figures.yml b/docs/examples/references.figures.yml
@@ -86,7 +86,6 @@ cases:
               kind: figure
               identifier: my-figure
               label: my-figure
-              numbered: true
               children:
                 - type: image
                   url: fig.jpg
@@ -142,7 +141,6 @@ cases:
               kind: figure
               identifier: my-figure
               label: my-figure
-              numbered: true
               children:
                 - type: image
                   url: fig.jpg
@@ -195,7 +193,6 @@ cases:
               kind: figure
               identifier: my-figure
               label: my-figure
-              numbered: true
               children:
                 - type: image
                   url: fig.jpg
@@ -257,7 +254,6 @@ cases:
               kind: figure
               identifier: my-figure
               label: my-figure
-              numbered: true
               children:
                 - type: image
                   url: fig.jpg
@@ -312,7 +308,6 @@ cases:
               kind: figure
               identifier: my-figure
               label: my-figure
-              numbered: true
               children:
                 - type: image
                   url: fig.jpg
@@ -372,7 +367,6 @@ cases:
               kind: figure
               identifier: my-figure
               label: my-figure
-              numbered: true
               children:
                 - type: image
                   url: fig.jpg

diff --git a/docs/examples/references.tables.yml b/docs/examples/references.tables.yml
@@ -29,7 +29,6 @@ cases:
               kind: table
               identifier: my-table
               label: my-table
-              numbered: true
               children:
                 - type: caption
                   children:
@@ -111,7 +110,6 @@ cases:
               kind: table
               identifier: my-table
               label: my-table
-              numbered: true
               children:
                 - type: caption
                   children:
@@ -189,7 +187,6 @@ cases:
               kind: table
               identifier: my-table
               label: my-table
-              numbered: true
               children:
                 - type: caption
                   children:
@@ -270,7 +267,6 @@ cases:
               kind: table
               identifier: my-table
               label: my-table
-              numbered: true
               children:
                 - type: caption
                   children:
@@ -343,7 +339,6 @@ cases:
               kind: table
               identifier: my-table
               label: my-table
-              numbered: true
               children:
                 - type: caption
                   children:
@@ -423,7 +418,6 @@ cases:
               kind: table
               identifier: my-table
               label: my-table
-              numbered: true
               children:
                 - type: caption
                   children:

diff --git a/schema/commonmark.schema.json b/schema/commonmark.schema.json
@@ -39,6 +39,14 @@
               "minimum": 1,
               "maximum": 6
             },
+            "enumerated": {
+              "description": "count this heading for numbering based on kind, e.g. Section 2.4.1",
+              "type": "boolean"
+            },
+            "enumerator": {
+              "description": "resolved enumerated value for this heading",
+              "type": "string"
+            },
             "children": {
               "type": "array",
               "items": {

diff --git a/schema/containers.schema.json b/schema/containers.schema.json
@@ -22,10 +22,14 @@
               "description": "any custom class information",
               "type": "string"
             },
-            "numbered": {
-              "description": "count this container for numbering based on kind, e.g. Figure 1",
+            "enumerated": {
+              "description": "count this container for numbering based on kind, e.g. Figure 1a",
               "type": "boolean"
             },
+            "enumerator": {
+              "description": "resolved enumerated value for this container",
+              "type": "string"
+            },
             "children": {
               "type": "array",
               "items": {

diff --git a/schema/math.schema.json b/schema/math.schema.json
@@ -12,6 +12,14 @@
             "type": {
               "const": "math"
             },
+            "enumerated": {
+              "description": "count this math block for numbering based on kind, e.g. See equation (1a)",
+              "type": "boolean"
+            },
+            "enumerator": {
+              "description": "resolved enumerated value for this math block",
+              "type": "string"
+            },
             "identifier": {},
             "label": {},
             "value": {},