From 94acb754ad56bcd1e716c2314d5847f520923d60 Mon Sep 17 00:00:00 2001 From: Brian Pepple Date: Wed, 28 Oct 2026 11:37:24 -0400 Subject: [PATCH] Update MetronInfo.xsd docs to v1.2 Point the remote-content plugin and schema page at v1.2, and document the new Series EndYear, Status, and Summary elements, plus the switch to BCP 47 language tags for the lang attribute. Repoint the v1.1 blog post's schema link to GitHub, since the v1.1 schema page was replaced. --- blog/2026-07-19-metroninfo-v1-1/index.md | 2 +- docs/metroninfo/documentation.md | 32 +++++++++++++++++--- docs/metroninfo/schemas/{v1.1.md => v1.2.md} | 6 ++-- docusaurus.config.js | 2 +- 4 files changed, 33 insertions(+), 9 deletions(-) rename docs/metroninfo/schemas/{v1.1.md => v1.2.md} (76%) diff --git a/blog/2026-07-19-metroninfo-v1-1/index.md b/blog/2026-07-19-metroninfo-v1-1/index.md index ed6ae10a..ea842e47 100644 --- a/blog/2026-07-19-metroninfo-v1-1/index.md +++ b/blog/2026-07-19-metroninfo-v1-1/index.md @@ -29,7 +29,7 @@ A new element for tracking the community's average rating for the book. It has t - **RatingCount** - Optional. The number of ratings used to determine the `AverageRating` value. Both elements are documented in full on the [MetronInfo documentation](/docs/metroninfo/documentation) page, and the -raw schema is up on the [schema page](/docs/metroninfo/schemas/v1.1). +raw schema is up on the [schema page](https://github.com/Metron-Project/metroninfo/blob/master/schema/v1.1/MetronInfo.xsd). ## What Software Currently Supports It? diff --git a/docs/metroninfo/documentation.md b/docs/metroninfo/documentation.md index 9cb8d56c..4fc50521 100644 --- a/docs/metroninfo/documentation.md +++ b/docs/metroninfo/documentation.md @@ -53,8 +53,9 @@ It also has the following children elements: ### Series Contains information about the series the book is part of. It can have a `lang` attribute, which is defined as a -2-letter language code (ISO 639-3), and an `id` attribute that can be used to add the identification number from the -source of information. +[BCP 47](https://www.rfc-editor.org/info/bcp47) language tag (for example `en`, `fil`, `pt-BR`, or `zh-Hant`) and +defaults to `en`, and an `id` attribute that can be used to add the identification number from the source of +information. It also has the following children elements: @@ -111,6 +112,22 @@ It also has the following children elements: The year that the series started in. This must be a 4 digit value. +- #### EndYear + + Optional. The year that the series ended in. This must be a 4 digit value, and it can't be earlier than the + `StartYear` value. + + This element should not be used if the `Status` of the series is `Ongoing`. + +- #### Status + + Optional. The publication status of the series. It must be one of the following values: + + - Cancelled + - Completed + - Hiatus + - Ongoing + - #### AlternativeNames Any other names the series is named as. It has `AlternativeName` children name for the individual alternative series @@ -120,8 +137,15 @@ It also has the following children elements: - ##### Name - The alternative name of the series. It can have an `id` and `lang` (defined as a 2-letter language code (ISO - 639-3)) attribute. + The alternative name of the series. It can have an `id` and `lang` (defined as a BCP 47 language tag) attribute. + +- #### Summary + + Optional. A description or summary of the series. This is separate from the book's [Summary](#summary-1) element. + +***Note***: The rules that `EndYear` can't be earlier than `StartYear`, and that an `Ongoing` series has no `EndYear`, +are enforced with XSD 1.1 assertions. They are only checked by a validator that supports XSD 1.1 (for example, Saxon or +Xerces-J with XSD 1.1 enabled). ### MangaVolume diff --git a/docs/metroninfo/schemas/v1.1.md b/docs/metroninfo/schemas/v1.2.md similarity index 76% rename from docs/metroninfo/schemas/v1.1.md rename to docs/metroninfo/schemas/v1.2.md index b57b9a1a..e19a6a25 100644 --- a/docs/metroninfo/schemas/v1.1.md +++ b/docs/metroninfo/schemas/v1.2.md @@ -1,13 +1,13 @@ --- sidebar_position: 25 -title: Version 1.1 +title: Version 1.2 --- -[Source](https://github.com/Metron-Project/metroninfo/blob/master/schema/v1.1/MetronInfo.xsd) on GitHub +[Source](https://github.com/Metron-Project/metroninfo/blob/master/schema/v1.2/MetronInfo.xsd) on GitHub ```mdx-code-block import CodeBlock from '@theme/CodeBlock'; -import Schema from '!!raw-loader!@site/docs/metroninfo/_remote/schema/v1.1/MetronInfo.xsd'; +import Schema from '!!raw-loader!@site/docs/metroninfo/_remote/schema/v1.2/MetronInfo.xsd'; {Schema} ``` \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 70428bad..c5ef0b1d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -43,7 +43,7 @@ const config = { name: 'metroninfo', // used by CLI, must be path safe sourceBaseUrl: 'https://raw.githubusercontent.com/Metron-Project/metroninfo/master/', // the base url for the markdown (gets prepended to all of the documents when fetching) outDir: 'docs/metroninfo/_remote', // the base directory to output to. - documents: ['schema/v1.1/MetronInfo.xsd',], // the file names to download + documents: ['schema/v1.2/MetronInfo.xsd',], // the file names to download noRuntimeDownloads: true, performCleanup: false, },