diff --git a/README.md b/README.md index 9f3e4a42..e68f7b0c 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ features they make available to you. - [remark-headings](/json-schema-org/json-schema-spec/blob/main/remark-headings.js) -- A collection of enhancements for headings. - Adds hierarchical section numbers to headings. - - Use the `[Appendix]` prefix on headings that should be numbered as an + - Use the `%appendix%` prefix on headings that should be numbered as an appendix. - Adds id anchors to headers that don't have one - Example: `#section-2-13` diff --git a/remark/remark-headings.js b/remark/remark-headings.js index 6cecefcd..1cc6abb8 100644 --- a/remark/remark-headings.js +++ b/remark/remark-headings.js @@ -7,7 +7,7 @@ import { toString as nodeToString } from "mdast-util-to-string"; const defaultOptions = { startDepth: 1, skip: [], - appendixToken: "[Appendix]", + appendixToken: "%appendix%", appendixPrefix: "Appendix" }; diff --git a/specs/jsonschema-core.md b/specs/jsonschema-core.md index 8b2be269..fcce6fad 100644 --- a/specs/jsonschema-core.md +++ b/specs/jsonschema-core.md @@ -2156,7 +2156,7 @@ Bray, T., Ed., Hollander, D., Ed., Layman, A., Ed., and R. Tobin, Ed., "Namespaces in XML 1.1 (Second Edition)", August 2006, <>. -## [Appendix] Schema identification examples {#idexamples} +## %appendix% Schema identification examples {#idexamples} Consider the following schema, which shows `$id` being used to identify both the root schema and various subschemas, and `$anchor` being used to define plain @@ -2258,7 +2258,7 @@ Document location `/$defs/C`: - base IRI of enclosing (root.json) resource plus fragment: `https://example.com/root.json#/$defs/C` -## [Appendix] Manipulating schema documents and references +## %appendix% Manipulating schema documents and references Various tools have been created to rearrange schema documents based on how and where references (`$ref`) appear. This appendix discusses which use cases and @@ -2300,7 +2300,7 @@ scope of this specification to determine or provide a set of safe `$ref` removal transformations, as they depend not only on the schema structure but also on the intended usage. -## [Appendix] Example of recursive schema extension {#recursive-example} +## %appendix% Example of recursive schema extension {#recursive-example} Consider the following two schemas describing a simple recursive tree structure, where each node in the tree can have a "data" field of any type. The first @@ -2394,7 +2394,7 @@ of the node schema objects were moved under `$defs`. It is the matching `$dynamicAnchor` values which tell us how to resolve the dynamic reference, not any sort of correlation in JSON structure. -## [Appendix] References and generative use cases +## %appendix% References and generative use cases While the presence of references is expected to be transparent to validation results, generative use cases such as code generators and UI renderers often @@ -2444,7 +2444,7 @@ instance of a distinct class. This style of usage requires the annotation to be in the same object as the reference, which must be recognizable as a reference. -## [Appendix] Acknowledgments +## %appendix% Acknowledgments Thanks to Gary Court, Francis Galiegue, Kris Zyp, Geraint Luff, and Henry Andrews for their work on the initial drafts of JSON Schema. @@ -2454,7 +2454,7 @@ Bowman, Gowry Sankar, Donald Pipowitch, Dave Finlay, Denis Laxalde, Phil Sturgeon, Shawn Silverman, and Karen Etheridge for their submissions and patches to the document. -## [Appendix] Change Log[^19] +## %appendix% Change Log[^19] ### draft-bhutton-json-schema-next - Use IRIs instead of URIs, including allowing unicode in plain-name fragments diff --git a/specs/jsonschema-validation.md b/specs/jsonschema-validation.md index c2b50e13..c6d985ac 100644 --- a/specs/jsonschema-validation.md +++ b/specs/jsonschema-validation.md @@ -886,7 +886,7 @@ draft-bhutton-json-schema-01, June 2022, Hoehrmann, B., "Scripting Media Types", RFC 4329, DOI 10.17487/RFC4329, April 2006, <>. -## [Appendix] Acknowledgments +## %appendix% Acknowledgments Thanks to Gary Court, Francis Galiegue, Kris Zyp, Geraint Luff, and Henry Andrews for their work on the initial drafts of JSON Schema. @@ -896,7 +896,7 @@ Bowman, Gowry Sankar, Donald Pipowitch, Dave Finlay, Denis Laxalde, Phil Sturgeon, Shawn Silverman, and Karen Etheridge for their submissions and patches to the document. -## [Appendix] Change Log[^6] +## %appendix% Change Log[^6] - *draft-next* - Use IRIs instead of URIs diff --git a/specs/proposals/propertyDependencies-adr.md b/specs/proposals/propertyDependencies-adr.md index f6ae0200..04db71fc 100644 --- a/specs/proposals/propertyDependencies-adr.md +++ b/specs/proposals/propertyDependencies-adr.md @@ -235,7 +235,7 @@ cases carried a lower priority. - Properties with non-string values cannot be supported using this keyword and the `allOf`-`if`-`then` pattern must still be used. -## [Appendix] Problems With Existing Patterns {#problems} +## %appendix% Problems With Existing Patterns {#problems} ### `oneOf`/`anyOf` diff --git a/specs/proposals/propertyDependencies.md b/specs/proposals/propertyDependencies.md index 066b9806..2e7685f7 100644 --- a/specs/proposals/propertyDependencies.md +++ b/specs/proposals/propertyDependencies.md @@ -129,7 +129,7 @@ vocabulary](../jsonschema-core.md#applicators). } ``` -## [Appendix] Change Log +## %appendix% Change Log - \[March 2021\] - Initially proposed - \[October 2021\] Added to specification document diff --git a/specs/proposals/proposal-template.md b/specs/proposals/proposal-template.md index 885a04cc..e187380d 100644 --- a/specs/proposals/proposal-template.md +++ b/specs/proposals/proposal-template.md @@ -81,11 +81,11 @@ For example ``` --> -## [Appendix] Change Log +## %appendix% Change Log - \[MMMM YYYY\] Created -## [Appendix] Champions +## %appendix% Champions | Champion | Company | Email | URI | | -------------------------- | ------- | ----------------------- | -------------------------------- | diff --git a/specs/proposals/vocabularies.md b/specs/proposals/vocabularies.md index 646f6885..2ddd86ea 100644 --- a/specs/proposals/vocabularies.md +++ b/specs/proposals/vocabularies.md @@ -258,11 +258,11 @@ worth the time and effort to fill in this section just yet. As such, please read the above sections for loose requirements. For tighter requirements, please assume conformance with the 2020-12 Core and Validation specifications.* -## [Appendix] Change Log +## %appendix% Change Log - 2024-06-10 - Created -## [Appendix] Champions +## %appendix% Champions | Champion | Company | Email | URI | | ----------- | ------- | ------------------------------ | ------------------------------- |