From c8f3e94c4f8f04f4d8416c16b5d56acde9f86a14 Mon Sep 17 00:00:00 2001 From: Tom Schraitle Date: Tue, 21 Apr 2026 14:25:00 +0200 Subject: [PATCH] Fix#187: Refactor product schema These changes reflect broad architectural shifts and naming conventions throughout the entire configuration system. * **Rebranding**: The naming convention has shifted from Docserv to Portal. This is reflected in namespace changes and element renaming (e.g., `` is now part of a portal root). * **Documentation-First Design**: The schema now heavily utilizes `db:refname` and `db:refpurpose` annotations for almost every element and attribute. This allows for automated generation of human-readable documentation directly from the RNC file. * *Enhanced Modularity**: The schema now explicitly supports splitting large configuration files into smaller, more manageable parts. By utilizing inclusion mechanisms, you can maintain different sections of the portal (like `` or specific products) in separate files, leading to a cleaner and more maintainable structure. * **Implicit Language Logic**: Master/source language identification has shifted from a boolean attribute (`@default`) to a value-based system. The schema now assumes `en-us` is the source locale for products and deliverables. * **Migration Tooling**: To facilitate the transition, an XSLT migration stylesheet is available. This tool automates the conversion of version 6.0 configuration files to the 7.0 format, handling the renaming of elements, restructuring of attributes, and the removal of deprecated metadata. Version 7.0 introduces several elements to support a more hierarchical portal structure and better metadata documentation. * ``: The new root element for the entire portal configuration. * ``: Used to highlight specific products or deliverables on the entry page. * ``: A container for defining product family groupings. * ``: Defines series/tabs (e.g., SBP, TRD, Products & Solutions). * ``: Generic element for entries within a family or series. * ``: A unified wrapper for product or version descriptions. * ``: A wrapper for grouping category definitions. * ``: Replaces the old builddocs logic for defining deliverables. * ``: Specifically for defining pre-built content links with metadata. * ``: An XInclude element pointing to an external XML resource to facilitate modularity. * New elements * New `` element (root element of everything) * Add optional `` element The `linkend` attribute points to a specific product, docset, or deliverable. Two possible notations: with and without text (empty element). * Insert XInclude definition Disable specific attributes like `xpointer`, `fragid`, `language`, and `accept`. * Add `` and `` to portal Both contain an ` ... `. Having text inside `` makes it easier and we don't need an additional `name` attribute. * Changed content models * The `start` pattern allows ``, ``, ``, ``, and ``. * Simplified ``: Allows multiple URLs in ``. This makes it possible to have different formats. Additionally allow a `` element to describe the resource. * Major elements now support ``, allowing configuration files to be broken into smaller, manageable chunks. * `` contains only a `@linkend` attribute to link to a resource. You don't need `dc`, `product`, or some other strange combination. * Renamed elements * `` -> `` Move elements into a parent * `` -> `` Container for definitions of resources * `` -> `` Version-specific content * `/` -> `` Require at least one with lang="en-us" as default language. * Removed elements * Disable `` in `` * Remove `` from `` * Remove ds.deliverablerestricted ds.subdeliverablerestricted * New attributes * Add xml:base for all start elements This is needed when elements are xincluded they get automatically a xml:base attribute. * Add `family` and `series` for `` * Add optional `rank` in `` * Changed attributes * Use xsd:language for ds.type.lang pattern The xsd:token isn't the right one. * Make schemaversion optional on * Add datatypes library (xsd prefix) * Raise `schemaversion` value to `7.0` * Renamed attributes * `productid`, `categoryid`, `setid`, `linkid` are all "id" now They are of type ID (not just token or string) * Removed attributes * `meta` in deliverable * `default` in `` Use required lang="en-us" instead of default="true" * Remove double ds.titleformat.attr definition --- .gitignore | 1 + src/docbuild/config/xml/data/README.md | 56 + .../config/xml/data/config.d/categories.xml | 6 + .../xml/data/config.d/categories/de-de.xml | 8 + .../xml/data/config.d/categories/en-us.xml | 8 + .../data/config.d/cloudnative/cloudnative.xml | 0 .../config/xml/data/config.d/portal.xml | 22 + .../config/xml/data/config.d/sles/16.0.xml | 216 +++ .../xml/data/config.d/sles/desc/de-de.xml | 0 .../xml/data/config.d/sles/desc/en-us.xml | 20 + .../config/xml/data/config.d/sles/sles.xml | 20 + .../config/xml/data/convert-v6-to-v7.xsl | 768 ++++++++ .../config/xml/data/portal-config-schema.rnc | 1541 +++++++++++++++++ .../config/xml/data/portal-example.xml | 166 ++ .../config/xml/data/product-config-schema.rnc | 926 ---------- src/docbuild/config/xml/data/rng2docbook.xsl | 466 +++++ 16 files changed, 3298 insertions(+), 926 deletions(-) create mode 100644 src/docbuild/config/xml/data/README.md create mode 100644 src/docbuild/config/xml/data/config.d/categories.xml create mode 100644 src/docbuild/config/xml/data/config.d/categories/de-de.xml create mode 100644 src/docbuild/config/xml/data/config.d/categories/en-us.xml create mode 100644 src/docbuild/config/xml/data/config.d/cloudnative/cloudnative.xml create mode 100644 src/docbuild/config/xml/data/config.d/portal.xml create mode 100644 src/docbuild/config/xml/data/config.d/sles/16.0.xml create mode 100644 src/docbuild/config/xml/data/config.d/sles/desc/de-de.xml create mode 100644 src/docbuild/config/xml/data/config.d/sles/desc/en-us.xml create mode 100644 src/docbuild/config/xml/data/config.d/sles/sles.xml create mode 100644 src/docbuild/config/xml/data/convert-v6-to-v7.xsl create mode 100644 src/docbuild/config/xml/data/portal-config-schema.rnc create mode 100644 src/docbuild/config/xml/data/portal-example.xml delete mode 100644 src/docbuild/config/xml/data/product-config-schema.rnc create mode 100644 src/docbuild/config/xml/data/rng2docbook.xsl diff --git a/.gitignore b/.gitignore index a1c5ddd7..ab704686 100644 --- a/.gitignore +++ b/.gitignore @@ -289,3 +289,4 @@ audit_reports/ git_repos/ .DS_Store lean_audit.txt +output/ diff --git a/src/docbuild/config/xml/data/README.md b/src/docbuild/config/xml/data/README.md new file mode 100644 index 00000000..4981b17d --- /dev/null +++ b/src/docbuild/config/xml/data/README.md @@ -0,0 +1,56 @@ +# Portal Configuration + +This directory contains: + +* A RELAX NG schema (`src/docbuild/config/xml/data/product-config-schema.rnc`). + It's the successor of the previous Docserv product schema. +* An example `config.d` directory. + +## File structure + +The `config.d` directory contains several subdirectories + +```text +config.d/ +├── categories/ +│ ├── [... more languages ...] +│ ├── de-de.xml +│ └── en-us.xml +├── cloudnative/ +│ ├── [... similar to sles/... ] +│ └── cloudnative.xml +├── portal.xml +└── sles/ + ├── desc + │ ├── [... more languages ...] + │ ├── descriptions.xml + │ ├── de-de.xml + │ └── en-us.xml + ├── docsets + │ ├── [... more docsets ...] + │ └── 16.0.xml + └── sles.xml +``` + +* `config.d/`: the configuration directory with all portal configuration +* `categories/`: A directory that contains all categories. +* `portal.xml`: The main entry file which references all categories and + product configuration. +* `sles/sles.xml`: The main product configuration for SLES. +* `sles/desc/`: contains all language specific +* `sles/docsets/`: contains all docsets of a product. + Depending on the complexity of the product, this may not always be + needed. For SLES, it would probably useful. + +## Creating combined config + +```shell +xmllint --xinclude \ + --output src/docbuild/config/xml/data/stitchfile.xml \ + src/docbuild/config/xml/data/config.d/portal.xml +``` + + +## Additional Sources + +https://confluence.suse.com/x/0QB5e diff --git a/src/docbuild/config/xml/data/config.d/categories.xml b/src/docbuild/config/xml/data/config.d/categories.xml new file mode 100644 index 00000000..ae0ed65a --- /dev/null +++ b/src/docbuild/config/xml/data/config.d/categories.xml @@ -0,0 +1,6 @@ + + + + + + diff --git a/src/docbuild/config/xml/data/config.d/categories/de-de.xml b/src/docbuild/config/xml/data/config.d/categories/de-de.xml new file mode 100644 index 00000000..4c107929 --- /dev/null +++ b/src/docbuild/config/xml/data/config.d/categories/de-de.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/src/docbuild/config/xml/data/config.d/categories/en-us.xml b/src/docbuild/config/xml/data/config.d/categories/en-us.xml new file mode 100644 index 00000000..57ab2feb --- /dev/null +++ b/src/docbuild/config/xml/data/config.d/categories/en-us.xml @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/src/docbuild/config/xml/data/config.d/cloudnative/cloudnative.xml b/src/docbuild/config/xml/data/config.d/cloudnative/cloudnative.xml new file mode 100644 index 00000000..e69de29b diff --git a/src/docbuild/config/xml/data/config.d/portal.xml b/src/docbuild/config/xml/data/config.d/portal.xml new file mode 100644 index 00000000..36664874 --- /dev/null +++ b/src/docbuild/config/xml/data/config.d/portal.xml @@ -0,0 +1,22 @@ + + + + + + + + Linux + Cloud Native + SUSE Edge + SUSE AI + + + Products & Solutions + SUSE Best Practices + Technical References + Release Notes + + + + + diff --git a/src/docbuild/config/xml/data/config.d/sles/16.0.xml b/src/docbuild/config/xml/data/config.d/sles/16.0.xml new file mode 100644 index 00000000..d045fcd3 --- /dev/null +++ b/src/docbuild/config/xml/data/config.d/sles/16.0.xml @@ -0,0 +1,216 @@ + + + + 16.0 + sles/16.0 + + + + + + + maintenance/SLE16.0 + + + + DC-SLE-comparison + + + + DC-SLE-differences-faq + + + + DC-SLE-packages-lifecycle + + + + DC-SLE-os-identification + + + + + DC-SLES-x86-64-agama-based-installation + + + + DC-SLES-s390-agama-based-installation + + + + DC-SLES-ppc-agama-based-installation + + + + DC-SLES-x86-64-agama-automated-installation + + + + DC-SLES-PXE-server + + + + DC-SLES-deployment-pxe-client + + + + + DC-SLES-klp + + + + DC-SLES-ulp + + + + DC-SLES-upgrading + + + + + DC-SLES-Ansible + + + + DC-SLES-ansible-roles + + + + DC-SLES-cockpit + + + + DC-SLES-copy-file-rsync + + + + DC-SLES-gnome-remote-desktop + + + + DC-SLES-networkmanager-nmcli + + + + DC-SLES-ntp-time-synchronization + + + + DC-SLES-predictable-naming + + + + DC-SLES-snapper-basics + + + + DC-SLES-subnet-manager + + + + DC-SLES-sudo-run-commands-as-superuser + + + + DC-SLES-supportconfig + + + + DC-SLES-systemd-basics + + + + DC-SLES-systemd-timers + + + + + DC-SLES-apache-tomcat-cloud + + + + DC-SLES-virtualization + + + + DC-SLES-virtualization-disk-cache + + + + DC-SLES-virtualization-io + + + + DC-SLES-virtualization-libvirt + + + + DC-SLES-virtualization-qemu + + + + DC-SLES-virtualization-spice-removal + + + + DC-SLES-virtualization-support + + + + DC-SLES-vm-host-network-multihome-setup + + + + + DC-SLES-GNOME-getting-started + + + + DC-SLES-valkey + + + + + DC-SLES-intro-firewalld + + + + DC-SLES-SELinux + + + + DC-SLES-sudo-configure-superuser-privileges + + + + + DC-SAP-saptune + + + + + + main + + DC-foo + + + + + + + + + + + + + +

...

+ + + + + + diff --git a/src/docbuild/config/xml/data/config.d/sles/desc/de-de.xml b/src/docbuild/config/xml/data/config.d/sles/desc/de-de.xml new file mode 100644 index 00000000..e69de29b diff --git a/src/docbuild/config/xml/data/config.d/sles/desc/en-us.xml b/src/docbuild/config/xml/data/config.d/sles/desc/en-us.xml new file mode 100644 index 00000000..f11bac5f --- /dev/null +++ b/src/docbuild/config/xml/data/config.d/sles/desc/en-us.xml @@ -0,0 +1,20 @@ + + + + THE platform for your business-critical apps in any environment +

+ A multimodal operating system that paves the way for IT transformation in the + software-defined era. +

+

+ The modern and modular OS helps simplify multimodal IT, makes traditional IT + infrastructure efficient and provides an engaging platform for developers. + As a result, you can easily deploy and transition business-critical workloads + across on-premise and public cloud environments. +

+

+ SUSE Linux Enterprise Server, based on latest SUSE Linux Enterprise, is another + example of our open approach helping you optimize and modernize your multimodal + IT infrastructure. +

+ diff --git a/src/docbuild/config/xml/data/config.d/sles/sles.xml b/src/docbuild/config/xml/data/config.d/sles/sles.xml new file mode 100644 index 00000000..7ff0a53e --- /dev/null +++ b/src/docbuild/config/xml/data/config.d/sles/sles.xml @@ -0,0 +1,20 @@ + + + SUSE Linux Enterprise Server + SLES + + taroth@suse.de + toms@suse.de + fs@suse.com + + + + + + + + + + + diff --git a/src/docbuild/config/xml/data/convert-v6-to-v7.xsl b/src/docbuild/config/xml/data/convert-v6-to-v7.xsl new file mode 100644 index 00000000..0ff6eaf5 --- /dev/null +++ b/src/docbuild/config/xml/data/convert-v6-to-v7.xsl @@ -0,0 +1,768 @@ + + + + +]> + + + + + + + + + + + + + + + + + + + + 7.0 + + + . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Written file: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + application/relax-ng-compact-syntax + application/xml + + + Error: Unknown schema file extension for + + . Only .rnc and .rng are supported. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Linux + Cloud Native + SUSE Edge + SUSE AI + + + Products & Solutions + SUSE Best Practices + Technical References + Release Notes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + main + + + + TODO: Found non-English links in docset/external + + + + + + + + + + + + + + + + + + + + + en-us + + + + <xsl:value-of select="@title"/> + +

TODO

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <xsl:value-of select="normalize-space(@title)"/> + + + +

TODO

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + WARN: Couldn't create a linkend for <ref + + + /> + + + + + + + + + + + + + + + diff --git a/src/docbuild/config/xml/data/portal-config-schema.rnc b/src/docbuild/config/xml/data/portal-config-schema.rnc new file mode 100644 index 00000000..113364e8 --- /dev/null +++ b/src/docbuild/config/xml/data/portal-config-schema.rnc @@ -0,0 +1,1541 @@ +# RELAX NG Schema for portal product configuration +# +# See also https://confluence.suse.com/x/0QB5e +# +namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0" +namespace db = "http://docbook.org/ns/docbook" +namespace xi = "http://www.w3.org/2001/XInclude" +namespace local = "" +default namespace = "" + +datatypes xsd = "http://www.w3.org/2001/XMLSchema-datatypes" + +# BASICS +[ + db:refname [ "start" ] + db:refpurpose [ "The start elements of the schema" ] +] +start = (ds.portal + | ds.product + | ds.docset + | ds.categories + | ds.category.default + | ds.category.translation + | ds.descriptions +) + + +# XIncludes +[ + db:refname [ "xi:include" ] + db:refpurpose [ "An XInclude element pointing to an external XML or text resource" ] +] +div { + xi.any.other.attribute = attribute * - local:* { text } + + xi.href.attr = + ## Target URL for the link (if the URL has no protocol prefix, the link is assumed to be local to the current host and a `/` will be added automatically) + [ + db:refpurpose [ "Target URL for the link (if the URL has no protocol prefix, the link is assumed to be local to the current host and a / will be added automatically)" ] + ] + attribute href { xsd:anyURI { pattern = "[^#]+" } } + + xi.parse.attr = + ## How to parse the included resource (default: xml) + [ + a:defaultValue="xml" + db:refpurpose [ "How to parse the included resource (default: xml)" ] + ] + attribute parse { "xml" | "text" }? + + xi.set-xml-id.attr = + ## Set the XML ID of the included content to the value of this attribute (optional) + [ + db:refpurpose [ "Set the XML ID of the included content to the value of this attribute (optional)" ] + ] + attribute set-xml-id { text }? + + xi.encoding.attr = + ## The encoding of the included resource (optional) + [ + db:refpurpose [ "The encoding of the included resource (optional)" ] + ] + attribute encoding { text }? + + xi.accept.attr = + ## The media type(s) that the included resource must match (optional) + [ + db:refpurpose [ "The media type(s) that the included resource must match (optional)" ] + ] + attribute accept { text }? + + xi.language.attr = + ## The language(s) that the included resource must match (optional) + [ + db:refpurpose [ "The language(s) that the included resource must match (optional)" ] + ] + attribute accept-language { text }? + + xi.include.attlist = + xi.href.attr?, + xi.parse.attr?, + # attribute xpointer { text }?, + # attribute fragid { text }?, + # xi.language.attr?, + # xi.accept.attr?, + xi.set-xml-id.attr?, + xi.encoding.attr?, + xi.any.other.attribute* + + xi.include = + element xi:include { + xi.include.attlist, + empty + # We don't use fallbacks at the moment. + # xi.fallback? + } +} + + +# CONSTANTS + +# Whenever there is a backward-incompatible schema revision, bump this +# version to the version of the software itself that this schema is shipped +# with. If the schema remains backward-compatible and there are only minor +# changes, leave the version as is. +ds.schema.version = + ## Schema version + [ + db:refpurpose [ "Schema version" ] + ] + "7.0" + + +# TYPES +[ + db:refpurpose [ "Custom data types used in the schema"] +] +div { +ds.type.class = + ## A space-separated list of HTML classes + [ + db:refpurpose [ "A space-separated list of HTML classes" ] + ] + xsd:token { pattern = "[\-_\+\.a-zA-Z0-9]+( [\-_\+\.a-zA-Z0-9]+)*" } + +ds.type.email = + ## An email address + # http://www.dpawson.co.uk/relaxng/schema/datatypes/datatypes.html#d1034e184 + # Works for both normal addresses and forms like + # "David Tolpin"@[Obscure Place] + # The expression above is slightly more allowing than required, + # but should be appropriate for the majority of cases. + [ + db:refpurpose [ "An email address" ] + + ] + xsd:token { + pattern="""([a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+(\.[a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+)*|"[^"\\]*")@([a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+(\.[a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+)*|\[[^\[\]\\]*\])""" + } + +ds.type.lang = + ## A language code + [ + db:refpurpose [ "A language code (la-ng style)" ] + ] + xsd:language { + pattern="""[a-z]{2}(-[a-z]{2,8})?""" + } + +ds.type.gitremote = + ## URL to a Git remote ("http[s]" URLs only) + # (Let's not support SSH URLs for the moment since that needs authentication) + [ + db:refpurpose [ "URL to a Git remote (https URLs only)" ] + ] + xsd:anyURI { + pattern="""https?://.*""" + } + +ds.type.dirname = + ## A relative directory name + [ + db:refpurpose [ "A relative directory name" ] + ] + xsd:anyURI { + pattern="""[^/\\]*[^/\\:](/[^/\\]+)*""" + } + +ds.type.branch = + ## A Git branch name + [ + db:refpurpose [ "A Git branch name" ] + ] + xsd:token { + pattern="""[^\s\\]+""" + } + +ds.type.dcfile = + ## A DC file name + [ + db:refpurpose [ "A DC file name" ] + ] + xsd:string { + pattern="""DC-[\-_\.\+a-zA-Z0-9]+""" + } + +ds.type.alphanumeric = + ## An alphanumeric value + "-" + "_" + [ + db:refpurpose [ "An alphanumeric value with dash and underscore" ] + ] + xsd:token { + pattern="""[\-_a-zA-Z0-9]+""" + } + +ds.type.id = + ## An unique ID (unlike xml:ids, this allows initial digits) + [ + db:refpurpose [ "An ID (unlike xml:ids, this allows initial digits)" ] + ] + xsd:token { + pattern="""[\-_\.\+a-zA-Z0-9]+""" + } + +ds.type.idmulti = + ## A space-separated list of IDs + [ + db:refpurpose [ "A space-separated list of IDs" ] + ] + xsd:token { + # TODO: Change that to xsd:IDREF or xsd:IDREFS? + pattern="""([\-_\.\+a-zA-Z0-9]+ )*[\-_\.\+a-zA-Z0-9]+""" + } + + + + +# A basic title template that allows strings like "title subtitle product/docset", +# in exactly that order, but everything except the title can be +# left away. product and docset will in many cases just be the same, and thus +# are set up to exclude each other. +# There is no guarantee that the title string will be formatted +# exactly this way or in this order, just that, if available, all of the +# information requested will come out. +ds.type.titleformat.build = + ## Elements of titles displayed on navigational pages for documents built within the portal + "title" | "title docset" | "title product" | "title subtitle" | "title subtitle product" | "title subtitle docset" +# For external links, some metadata is never available: product name and +# subtitle cannot be generated in any way currently (but you're free to +# create whatever title you want and that should make up for it). +ds.type.titleformat.link = + ## Elements of titles displayed on navigational pages for externally-hosted documents + "title" | "title docset" + +} + +# TAG/ATTRIBUTE SETS + +div +{ +# FIXME: add img? (It is a bit unclear whether our script would need to take +# care of copying stuff then.) +ds.htmlblock = + ## HTML block elements + ds.p + | ds.div + | ds.pre + | ds.ul + | ds.ol + | ds.dl + | ds.h1 + | ds.h2 + | ds.h3 + | ds.h4 + | ds.h5 + | ds.h6 +} + +div +{ +ds.htmlinline = + ## HTML inline elements + ds.a + | ds.br + | ds.cite + | ds.code + | ds.em + | ds.hr + | ds.q + | ds.s + | ds.span + | ds.strong + | ds.sub + | ds.sup + | ds.u +} + +div +{ +ds.htmlattr = + ds.id.attr?, + ds.class.attr? +} + +div +{ +ds.htmlinlinecontent = + ds.htmlattr, + (ds.htmlinline | + text)* +} + +# +# Common attributes +# +ds.xmlbase.attr = + ## Specifies the base URI of the element and its descendants + [ + db:refpurpose [ "Specifies the base URI of the element and its descendants" ] + ] + attribute xml:base { xsd:anyURI } + +ds.id.attr = + ## ID attribute for identifying an object + [ + db:refpurpose [ "ID attribute for identifying an object" ] + ] + attribute id { xsd:ID } + +ds.path.attr = + ## Relative path to a file or directory, with no leading or trailing slash + [ + db:refpurpose [ "Relative path to a file or directory, with no leading or trailing slash" ] + ] + attribute path { ds.type.dirname } + +ds.class.attr = + ## Class attribute (HTML) + [ + db:refpurpose [ "Class attribute (HTML)" ] + ] + attribute class { ds.type.class } + +ds.gated.attr = + ## Is the content behind a paywall? (default "false") + [ + a:defaultValue = "false" + db:refpurpose [ "Is the content behind a paywall?" ] + ] + attribute gated { xsd:boolean } + +ds.lang.attr = + ## Language code (`la-ng` style) of this description + [ + db:refpurpose [ "Language code (la-ng style) of this description" ] + ] + attribute lang { ds.type.lang } + +ds.lang.en-us.attr = + ## Language code strictly locked to US English + [ + db:refpurpose [ "Language code strictly locked to US English" ] + ] + attribute lang { "en-us" } + +ds.title.attr = + ## Localized title of description + [ + db:refpurpose [ "Localized title of description" ] + ] + attribute title { text } + +ds.titleformat.attr = + ## How to display the document title on the product version navigational page, a combination of the following values: + ## * `title`: title as extracted from the document + ## * `subtitle`: subtitle as extracted from the document (can be empty) + ## * `docset`: product and version number as classified in the portal product configuration + ## * `product`: product and version number as extracted from the document (can be empty) + ## Note the following: + ## * `title` is mandatory + ## * `docset` and `product` are mutually exclusive. + ## * the order of values must be `title`, `subtitle`, `docset`/`product` + ## Default: `title subtitle` + [ + db:refpurpose [ "How to display the document title on the product version navigational page, a combination of the following values: title, subtitle, docset, product. Note the following: title is mandatory, docset and product are mutually exclusive, and the order of values must be title, subtitle, docset/product. Default: title subtitle" ] + ] + attribute titleformat { ds.type.titleformat.build } + + +ds.category.attr = + ## What category or categories to display this document under on the product version navigational page + [ + db:refpurpose [ "What category or categories to display this document under on the product version navigational page" ] + ] + attribute category { ds.type.idmulti } + +ds.includes-productname.attr = + ## * is a normal version (number) that is normally combined with a + ## product name and shown in all situations. When @includes-productname=true is + ## set for , we will always only display the text rather + ## than displaying the product name alongside it. + ## * is also a version (number), also normally combined with a + ## product name. However, it is only ever shown on the home page's selection + ## boxes, but not used within internal references or for product pages. + [ + a:defaultValue = "false" + db:refpurpose [ "Whether the version number name includes the product name (default: false)" ] + ] + attribute includes-productname { xsd:boolean } + +ds.remarks.attr = + ## Enable DocBook remarks in this document (`daps ... --remarks`; + ## the default value varies depending on the site configuration) + [ + db:refpurpose [ "Enable DocBook remarks in this document (daps ... --remarks; the default value varies depending on the site configuration)" ] + ] + attribute remarks { xsd:boolean } + +ds.draft.attr = + ## Enable DocBook draft watermark in this document (`daps ... --draft`; + ## the default value varies depending on the site configuration and product lifecycle) + [ + db:refpurpose [ "Enable DocBook draft watermark in this document (daps ... --draft; the default value varies depending on the site configuration and product lifecycle)" ] + ] + attribute draft { xsd:boolean } + +ds.meta.attr = + ## Enable DocBook meta information in this document (`daps ... --meta`; + ## the default value varies depending on the site configuration) + [ + db:refpurpose [ "Enable DocBook meta information in this document (daps ... --meta; the default value varies depending on the site configuration)" ] + ] + # TODO: Is this still needed? + attribute meta { xsd:boolean } + +ds.href.attr = + ## Target URL for the link (if the URL has no protocol prefix, the link is assumed + ## to be local to the current host and a `/` will be added automatically) + [ + db:refpurpose [ "Target URL for the link" ] + ] + attribute href { xsd:anyURI } + + +# --- ROOT --- +[ + db:refname [ "portal" ] + db:refpurpose [ "The root element of all portal configuration" ] +] +div { + ds.portal = + ## The root element of all portal configuration + element portal { + ds.schemaversion.attr, + ds.spotlight?, + ds.categories, + ds.productfamilies, + db.series, + (ds.product+ & xi.include*) + } +} + + +[ + db:refname [ "spotlight" ] + db:refpurpose [ "Highlights a specific product, docset, or deliverable on the entry page." ] +] +div { + ds.spotlight = + ## Highlights a specific product, docset, or deliverable on the entry page. + element spotlight { + ds.ref.linkend.attr, + (text | empty) + } +} + +[ + db:refname [ "productfamilies"] + db:refpurpose [ "Product families definition" ] +] +div { + ds.productfamilies = + ## Product families definition + element productfamilies { + ds.xmlbase.attr?, + db.item+ + } +} + +[ + db:refname [ "series" ] + db:refpurpose [ "Series definition" ] +] +div { + db.series = + ## Series definition + element series { + ds.xmlbase.attr?, + db.item+ + } +} + +[ + db:refname [ "item" ] + db:refpurpose [ "An item of a product family or a series" ] +] +div { + db.item = + ## An item of a product family or a series + element item { + # ds.xmlbase.attr?, + ds.id.attr, + text + } +} + +[ + db:refname [ "product"] + db:refpurpose [ "Product definition" ] +] +div { + ds.schemaversion.attr = + ## Version of the schema, verifies that portal schema major version and version of product configuration match + [ + db:refpurpose [ "Version of the schema, verifies that portal schema major version and version of product configuration match" ] + ] + # TODO: Simplify to version? + attribute schemaversion { ds.schema.version } + + ds.enabled.attr = + ## Whether to enable this configuration file (`true` by default) + [ + a:defaultValue = "true" + db:refpurpose [ "Whether to enable this configuration file (true by default)" ] + ] + attribute enabled { xsd:boolean } + + ds.site-section.attr = + ## Site section this configuration belongs to + [ + db:refpurpose [ "Site section this configuration belongs to" ] + ] + # TODO: Do we still need this attribute? + # TODO: Is it similar to a (product) family now? + attribute site-section { ds.type.alphanumeric }? + + ds.series.attr = + ## Where a product belongs to which tab (SBP, TRD, Products & Solution) + [ + db:refpurpose [ "Where a product belongs to which tab (SBP, TRD, Products & Solution)" ] + ] + attribute series { xsd:IDREF } # ds.type.alphanumeric TODO: IDREF? + + ds.family.attr = + ## Product family this product belongs to + [ + db:refpurpose [ "Product family this product belongs to" ] + ] + attribute family { xsd:IDREF } + + ds.rank.attr = + ## Rank of this product in the homepage listing (lower ranks are listed first; products with the same rank are sorted alphabetically by product name) + [ + db:refpurpose [ "Rank of this product in the homepage listing (lower ranks are listed first; products with the same rank are sorted alphabetically by product name)" ] + ] + attribute rank { xsd:nonNegativeInteger } + + ds.docset-sort.attr = + ## Whether to sort docsets of this product Z-A9-0 (`descending`, default) or 0-9A-Z (`ascending`) + [ + a:defaultValue = "descending" + db:refpurpose [ "Whether to sort docsets of this product" ] + ] + attribute docset-sort { + ## Sort 0-9A-Z + "ascending" + | + ## Sort Z-A9-0 + "descending" }? + +ds.product = + ## Product (or top-level category, root element) + element product { + # This ID value can only be checked when we take all of the productconfig + # files together (i.e. after we have run stitch.sh). In any case, it does + # not make sense to use xsd:id here because there can only ever be one + # of these ID per productconfig file. + ( + ds.id.attr & + ds.xmlbase.attr? & + ds.path.attr? & + ds.schemaversion.attr? & + ds.enabled.attr? & + ds.site-section.attr? & # TODO: Do we still need this attribute? + ds.series.attr & + ds.family.attr & + ds.rank.attr? & + ds.docset-sort.attr? & + ds.gated.attr? + ), + ds.name, + ds.sortname?, + ds.acronym?, + ds.maintainers, + # TODO: Adjust the content model? + (ds.categories | xi.include)?, + (ds.descriptions | xi.include)?, + (ds.docset | xi.include)+ + } +} + + +# PRODUCT DESCRIPTION +[ + db:refname [ "name" ] + db:refpurpose [ "Name of product or top-level category" ] +] +div { +ds.name = + ## Name of product or top-level category + element name { + text + } +} + + +[ + db:refname [ "sortname" ] + db:refpurpose [ "Sort name of product or top-level category" ] +] +div { +ds.sortname = + ## Sort name of product or top-level category + element sortname { + text + } +} + + +[ + db:refname [ "acronym" ] + db:refpurpose [ "Acronym of name of product or top-level category" ] +] +div { +ds.acronym = + ## Acronym of name of product or top-level category + element acronym { + text + } +} + + +[ + db:refname [ "maintainers" ] + db:refpurpose [ "Collection of email addresses to send mail about build failures to" ] +] +div { +ds.maintainers = + ## Collection of email addresses to send mail about build failures to + element maintainers { + ds.contact+ + } +} + + +[ + db:refname [ "contact" ] + db:refpurpose [ "Email address to send mail about build failures to" ] +] +div { +ds.contact = + ## Email address to send mail about build failures to + element contact { + ds.type.email + } +} + + +[ + db:refname [ "descriptions" ] + db:refpurpose [ "Wrapper of desc element" ] +] +div { + ds.treatment.attr = + ## How to treat version-specific product descriptions + [ + a:defaultValue = "append" + db:refpurpose [ "How to treat version-specific product descriptions" ] + ] + attribute treatment { + ## Append this description to the original product description + 'append' | + ## Prepend this description to the original product description + 'prepend' | + ## Replace the original product description with this description + 'replace' + } + + ds.descriptions = + ## Wrapper of desc element + element descriptions { + ds.xmlbase.attr?, ds.treatment.attr?, + ds.desc_default, + ds.desc_translation* + } +} + +[ + db:refname [ "desc" ] + db:refpurpose [ "Description of product or top-level category" ] +] +div { +ds.desc_default = + ## Description of product or top-level category (default language) + element desc { + ds.xmlbase.attr?, + ds.lang.en-us.attr, + ds.title?, + ds.htmlblock* + } +} + + +[ + db:refname [ "desc" ] + db:refpurpose [ "Description of product or top-level category (dependent languages)" ] +] +div { +ds.desc_translation = + ## Description of product or top-level category (dependent languages) + element desc { + ## Language code (`la-ng` style) of this description + ds.xmlbase.attr?, + ds.lang.attr, + ds.title?, + ds.htmlblock* + } +} + + +ds.title_text = + xsd:string { pattern = "[^\n]{1,80}" } + + +[ + db:refname [ "shortdesc" ] + db:refpurpose [ "A short description of the product"] +] +div { +ds.title = + ## A short description of the product + element title { + ds.title_text + } +} + +[ + db:refname [ "subtitle" ] + db:refpurpose [ "A short subtitle of the product"] +] +div { +ds.subtitle = + ## A short subtitle of the product + element subtitle { + text + } +} + +[ + db:refname [ "categories" ] + db:refpurpose [ "Wrapper for all category elements" ] +] +div { + ds.categories = + ## Wrapper for all category elements + element categories { + ds.xmlbase.attr?, + ( + (ds.category.default, ds.category.translation*) + | xi.include+ + ) + } +} + + +[ + db:refname [ "category" ] + db:refpurpose [ "Definition of category (default language)" ] +] +div { + # UNUSED + # ds.categoryid.attr = + # ## Category ID, must be unique across the configuration for a single product + # [ + # db:refpurpose [ "Category ID, must be unique across the configuration for a single product" ] + # ] + # attribute categoryid { ds.type.id } + + ds.category.default = + ## Definition of category (default language) + element category { + ds.xmlbase.attr?, + ds.lang.en-us.attr, + ds.category_language+ + } +} + + +[ + db:refname [ "category" ] + db:refpurpose [ "Definition of category (dependent languages)" ] +] +div { + + ds.category.translation = + ## Definition of category (dependent languages) + element category { + ds.xmlbase.attr?, + ds.lang.attr, + ds.category_language+ + } +} + + +[ + db:refname [ "language" ] + db:refpurpose [ "Metadata for category displayed on product detail navigational page" ] +] +div { +ds.category_language = + ## Metadata for category displayed on product detail navigational page + element language { + ds.id.attr, + ds.title.attr, + ds.htmlblock* + } +} + + + +# DOCSETS +[ + db:refname [ "docset" ] + db:refpurpose [ "Product version definition" ] +] +div { + ds.lifecycle.attr = + ## Lifecycle value of this product version + [ + a:defaultValue = "supported" + db:refpurpose [ "Lifecycle value of this product version" ] + ] + attribute lifecycle { + ## Product versions can only be built for instances defined as internal in the INI configuration + "unpublished" | + ## Product versions can be built without restriction but contain a draft watermark + "beta" | + ## Product versions can be built without restriction + "supported" | + ## Product versions can be built without restriction but are only published as Zip archives + "unsupported" + } + + ds.navigation.attr = + ## Whether to build a navigational page for this product version + [ + a:defaultValue = "linked" + db:refpurpose [ "Whether to build a navigational page for this product version: linked for navigational pages linked from the homepage (default), hidden for navigational pages not linked from the homepage, disabled to disable creation of a navigational page" ] + ] + attribute navigation { + ## For navigational pages linked from the homepage (default) + "linked" | + ## For navigational pages not linked from the homepage + "hidden" | + ## To disable creation of a navigational page + "disabled" } + +ds.docset = + ## Product version or second-level category + element docset { + ( + ds.xmlbase.attr? & + ds.path.attr? & + ds.id.attr & + ds.lifecycle.attr & + ds.navigation.attr? & + ds.gated.attr? + ), + # + # To allow for name changes between versions, as in the example of SUSE + # Cloud -> SUSE OpenStack Cloud: optional ds.name here + ds.name?, + ds.sortname?, + ds.acronym?, + ds.version, + ds.canonical?, + ds.listingversion?, + ds.descriptions?, + ( + (ds.resources, + ds.internal?, + ds.external?) + | + (ds.internal, + ds.external?) | + ds.external + ) + } +} + + +[ + db:refname [ "version" ] + db:refpurpose [ "User-visible version number (or name of second-level category)" ] +] +div { +# * is a normal version (number) that is normally combined with a +# product name and shown in all situations. When @includes-productname=true is +# set for , we will always only display the text rather +# than displaying the product name alongside it. +# * is also a version (number), also normally combined with a +# product name. However, it is only ever shown on the home page's selection +# boxes, but not used within internal references or for product pages. +# +# FIXME: version v/ listingversion v/ @includes-productname is a bit of a mess, +# clean up eventually when use cases are clearer + +ds.version = + ## User-visible version number (or name of second-level category) + element version { + ## Whether the version number name includes the product name (default: `false`) + ds.includes-productname.attr?, + text + } +} + + +[ + db:refname [ "canonical" ] + db:refpurpose [ "For canonical links; from previous, obsolete SPs to the latest" ] +] +div { +ds.canonical = + ## For canonical links; from previous, obsolete SPs to the latest + element canonical { + xsd:anyURI + } +} + + +[ + db:refname [ "listingversion" ] + db:refpurpose [ "Version number (or name of second-level category) displayed in homepage listing" ] +] +div { + ds.listingversion = + ## User-visible version number (or name of second-level category) displayed in homepage listing + element listingversion { + ## Whether the version number name includes the product name (default: `false`) + ds.includes-productname.attr?, + text + } +} + + +[ + db:refname [ "resources" ] + db:refpurpose [ "Container for definitions of documents to build (formerly builddocs)" ] +] +div { +ds.resources = + ## Container for definitions of documents to build + element resources { + ds.git, + ds.locale_default, + ds.locale_translation* + } +} + + +[ + db:refname [ "git" ] + db:refpurpose [ "Definition of Git remote URL to use for documentation of a specific product version (or second-level category)" ] +] +div { +ds.git = + ## Definition of Git remote URL to use for documentation of a specific product version (or second-level category) + element git { + ## Git remote URL + attribute remote { ds.type.gitremote }, + empty + } +} + + +# About @translation-type: +# * "list" creates a list of documents that will be built for the +# translation in question. This is advantageous in the common case that only +# a small subset of documents are translated into a particular language. +# * "full" means there is a full translation in this language for +# this docset +[ + db:refname [ "locale (en-us)" ] + db:refpurpose [ "Set of deliverables to build for the default language" ] +] +div { +ds.locale_default = + ## Set of deliverables to build for the default language + element locale { + ds.lang.en-us.attr, + ds.branch, + ds.subdir?, + ( + ds.deliverable_en_us_dc + | ds.deliverable_subdeliverable + | ds.deliverable_en_us_prebuilt + )+ + } +} + + +[ + db:refname [ "locale (translations)" ] + db:refpurpose [ "Set of deliverables to build for the default language" ] +] +div { +ds.locale_translation = + ## Set of documents to build (default language, must list full set of documents available for product version) + element locale { + ds.lang.attr, + ds.branch, + ds.subdir?, + + ds.deliverable_trans+ + } +} + + +div { + ds.deliverable.trans.type.attr = + [ a:defaultValue = "ref" ] + attribute type { "ref" } + + ds.deliverable_trans = + ## A document to build for a translation, identified by the DC file of the default language deliverable + element deliverable { + ( + ds.gated.attr? + & ds.deliverable.trans.type.attr + ), + # + # TODO: Do we want only have references in translations? + # The content model allows also descriptions. + ds.ref # | ds.deliverable.prebuilt + } + +} + + +[ + db:refname [ "branch" ] + db:refpurpose [ "Branch of the source Git repository" ] +] +div { +ds.branch = + ## Branch of the source Git repository + element branch { + ds.type.branch + } +} + + +[ + db:refname [ "subdir" ] + db:refpurpose [ "Subdirectory within the source Git repository"] +] +div { +ds.subdir = + ## Subdirectory within the source Git repository + element subdir { + ds.type.dirname + } +} + + +[ + db:refname [ "partners" ] + db:refpurpose [ "A list of partners (usually for TRDs)" ] +] +div { +ds.partners = + ## A list of partners (usually for TRDs) + element partners { + ## An individual partner + element partner { text }+ + } +} + + +[ + db:refname [ "deliverable (dc)" ] + db:refpurpose [ "Definition of an individual document built by DAPS (default language)" ] +] +div { + ds.deliverable.dc.type.attr = + [ a:defaultValue = "dc" ] + attribute type { "dc" } + +ds.deliverable_en_us_dc = + ## An individual document built by DAPS (default language) + element deliverable { + ( + ds.deliverable.dc.type.attr? + & ds.remarks.attr? + & ds.draft.attr? + # & ds.meta.attr? + & ds.category.attr? + & ds.titleformat.attr? + & ds.gated.attr? + & ds.id.attr + ), + # + ds.dc + #ds.git?, + #ds.subdir?, + #ds.format, + #ds.partners* + } +} + + +[ + db:refname [ "deliverable (prebuilt)" ] + db:refpurpose [ "Definition of an individual prebuilt document (default language)" ] +] +div { +ds.deliverable.prebuilt.type.attr = + [ a:defaultValue = "prebuilt" ] + attribute type { "prebuilt" } + +ds.deliverable_en_us_prebuilt = + ## + element deliverable { + ( + ds.deliverable.prebuilt.type.attr? + & ds.category.attr? + & ds.titleformat.attr? + & ds.gated.attr? + & ds.id.attr + ), + # + ds.deliverable.prebuilt + } +} + + + +[ + db:refname [ "prebuilt" ] + db:refpurpose [ "Pre-built content definition" ] +] +div { + ds.deliverable.prebuilt = + ## Pre-built content definition + element prebuilt { + ds.title, + ds.subtitle?, + ds.url+, + ds.descriptions + # ds.metadata # TODO + } +} + + +[ + db:refname [ "metadata" ] + db:refpurpose [ "" ] +] +div { +ds.metadata = + ## + element metadata { + empty # TODO + } +} + + +[ + db:refname [ "deliverable" ] + db:refpurpose [ "Definition of an individual document that is a DocBook set/book that includes articles/book (default language)" ] +] +div { +ds.deliverable_subdeliverable = + ## An individual document that is a DocBook set/book that includes articles/book (default language) + element deliverable { + ds.remarks.attr?, + ds.draft.attr?, + ds.meta.attr?, + ds.gated.attr?, + ds.subdir?, + ds.dc, + ds.format, + ds.subdeliverable+ + } +} + + +[ + db:refname [ "dc" ] + db:refpurpose [ "Wrapper to structure DC file reference" ] +] +div { + ds.dc.file.attr = + ## + attribute file { + ds.type.dcfile + } + +ds.dc = + ## Wrapper to structure DC file reference + element dc { + ds.dc.file.attr, + ds.git?, + ds.subdir?, + ds.format, + ds.partners* + } +} + + +[ + db:refname [ "format" ] + db:refpurpose [ "Enabling/disabling document formats to build" ] +] +div { +# Unfortunately, this way, I can't force people to choose at least one format +# they actually want to build. +ds.format = + ## Allows enabling/disabling document formats, at least one format must be enabled + element format { + ## Whether to enable multi-page HTML builds + attribute html { xsd:boolean }?, + ## Whether to enable single-page HTML builds + attribute single-html { xsd:boolean }?, + ## Whether to enable PDF builds + attribute pdf { xsd:boolean }?, + ## Whether to enable EPUB builds + attribute epub { xsd:boolean }? + } +} + + +[ + db:refname [ "subdeliverable" ] + db:refpurpose [ "Individual document within a DocBook set as identified by their XML ID (default language)" ] +] +div { +ds.subdeliverable = + ## Individual document within a DocBook set as identified by their XML ID (default language) + element subdeliverable { + ds.category.attr?, + ds.titleformat.attr?, + ds.type.id + } +} + + +[ + db:refname [ "internal" ] + db:refpurpose [ "Wrapper for internal references" ] +] +div { +ds.internal = + ## Wrapper for internal references + element internal { + ds.ref+ + } +} + + +[ + db:refname [ "ref" ] + db:refpurpose [ "Reference to a document or navigational page" ] +] +div { + ds.ref.linkend.attr = + ## Link ID of referenced external link + [ + db:refpurpose [ "Link ID of referenced external link" ] + ] + attribute linkend { xsd:IDREF } + + ds.ref = + ## Internal reference + element ref { + ( + ds.ref.linkend.attr & + ds.category.attr? & + ds.titleformat.attr? + ), + + ds.descriptions? + } +} + + +[ + db:refname [ "external" ] + db:refpurpose [ "Container for references to externally-hosted documents" ] +] +div { +ds.external = + ## Container for references to externally-hosted documents + element external { + ds.link* + } +} + + +[ + db:refname [ "link" ] + db:refpurpose [ "Collection of URLs for a single externally-hosted document in different languages and formats" ] +] +div { +ds.link = + ## Collection of URLs for a single externally-hosted document in different languages and formats + element link { + # attribute linkid { ds.type.id }?, + ds.category.attr?, + ## How to display the document title on the product version navigational page, a combination of the following values: + ## * `title`: title as extracted from the document + ## * `docset`: product and version number as classified in the portal product configuration + ## Note the following: + ## * `title` is mandatory + ## * the order of values must be `title`, `docset` + ## Default: `title` + attribute titleformat { ds.type.titleformat.link }?, + ds.gated.attr?, + ds.url+, + ds.descriptions + } +} + + +[ + db:refname [ "url" ] + db:refpurpose [ "URL of externally-hosted document"] +] +div { +ds.url = + ## URL of externally-hosted document + element url { + ds.href.attr, + ## Target file format of the link for display in the UI + attribute format { + "html" + | "single-html" + | "pdf" + | "epub" + | "zip" + | "tar" + | "other" + }, + empty + } +} + +# SUPPORTED HTML SUBSET + +ds.p = + ## Paragraph (HTML, block) + element p { + ds.htmlinlinecontent + } + +ds.div = + ## Generic block element (HTML, block) + element div { + ds.htmlattr, + ( + ds.htmlinline | + ds.htmlblock | + text + )* + } + +ds.pre = + ## Preformatted text (HTML, block) + element pre { + ds.htmlattr, + text* + } + +ds.ul = + ## Unordered list (HTML, block) + element ul { + ds.htmlattr, + ds.li+ + } + +ds.ol = + ## Ordered (itemized) list (HTML, block) + element ol { + ds.htmlattr, + ds.li+ + } + +ds.dl = + ## Definition list (HTML, block) + element dl { + ds.htmlattr, + (ds.dt, ds.dd)+ + } + +ds.dt = + ## Term in definition list (HTML, block) + element dt { + ds.htmlattr, + ds.htmlblock* + } + +ds.dd = + ## Definition in definition list (HTML, block) + element dd { + ds.htmlattr, + ds.htmlblock* + } + +ds.li = + ## List item in unordered or ordered list (HTML, block) + element li { + ds.htmlattr, + ds.htmlblock* + } + +ds.h1 = + ## Heading of level 1 (HTML, block) + element h1 { + ds.htmlinlinecontent + } + +ds.h2 = + ## Heading of level 2 (HTML, block) + element h2 { + ds.htmlinlinecontent + } + +ds.h3 = + ## Heading of level 3 (HTML, block) + element h3 { + ds.htmlinlinecontent + } + +ds.h4 = + ## Heading of level 4 (HTML, block) + element h4 { + ds.htmlinlinecontent + } + +ds.h5 = + ## Heading of level 5 (HTML, block) + element h5 { + ds.htmlinlinecontent + } + +ds.h6 = + ## Heading of level 6 (HTML, block) + element h6 { + ds.htmlinlinecontent + } + + +ds.sup = + ## Superscript text (HTML, inline) + element sup { + ds.htmlinlinecontent + } + +ds.sub = + ## Subscript text (HTML, inline) + element sub { + ds.htmlinlinecontent + } + +ds.s = + ## Struck text (HTML, inline) + element s { + ds.htmlinlinecontent + } + +ds.u = + ## Underlined text (HTML, inline) + element u { + ds.htmlinlinecontent + } + +ds.q = + ## Short quote (HTML, inline) + element q { + ds.htmlinlinecontent + } + +ds.em = + ## Emphasized text, displayed in italics (HTML, inline) + element em { + ds.htmlinlinecontent + } + +ds.a = + ## Web link (HTML, inline) + element a { + ds.href.attr, + ## Whether to open the link in a new tab/window (`_blank`) + attribute target { "_blank" }?, + ## Attributes of the link: + ## * `nofollow`: Ask search engine spiders not to follow the link + ## * `prev`: Link target is the previous in a series of documents + ## * `next`: Link target is the next in a series of documents + ## * `license`: Link target represents a license of the current page + ## * `alternate`: Link target represents an alternate variant of the current page (such as a different language or format) + attribute rel { "nofollow" | "prev" | "next" | "license" | "alternate" }?, + ds.htmlinlinecontent + } + +ds.strong = + ## Strongly emphasized text, displayed in boldface (HTML, inline) + element strong { + ds.htmlinlinecontent + } + +ds.code = + ## Code/command (HTML, inline) + element code { + ds.htmlinlinecontent + } + +ds.cite = + ## Citation (HTML, inline) + element cite { + ds.htmlinlinecontent + } + +ds.span = + ## Generic inline element (HTML, inline) + element span { + ds.htmlinlinecontent + } + +ds.br = + ## Manual line break (HTML, inline) + element br { + ds.htmlattr, + empty + } + +ds.hr = + ## Horizontal rule (HTML, inline) + element hr { + ds.htmlattr, + empty + } diff --git a/src/docbuild/config/xml/data/portal-example.xml b/src/docbuild/config/xml/data/portal-example.xml new file mode 100644 index 00000000..5a3845a3 --- /dev/null +++ b/src/docbuild/config/xml/data/portal-example.xml @@ -0,0 +1,166 @@ + + + + + + + + + + + + + + + + + + + + + + + Linux + Cloud Native + SUSE Edge + SUSE AI + + + Products & Solutions + SUSE Best Practices + Technical References + Release Notes + + + + SUSE Linux Enterprise Server + SLES + + taroth@suse.de + toms@suse.de + fs@suse.com + + + + + + 16.0 + sles/16.0 + + + + maintenance/SLE16.0 + + + + + + + + Hello + World + + + + +

The bla-bla

+ + + + + + + + maintenance/SLE16.0 + l10n/de-de + + + + + + + +

A different description

+ + + + + + + + + + + Cloud Native + rancher + + fs@suse.com + + + + + + + + + + The enterprise, production-ready Kubernetes platform +

SUSE's Cloud Native product family introduces additional value with + greater security assurances, extended lifecycles, access to focused + architectures and Kubernetes advisories. It will also offer options to + get production support for innovative Cloud Native projects. With + SUSE's Cloud Native, installation assets are hosted on a trusted + registry owned and managed by SUSE.

+ + + + + SUSE Rancher Prime: Continuous Delivery (Fleet) + + +

+ SUSE Rancher Prime: Continuous Delivery is a set of Kubernetes custom + resource definitions (CRDs) and controllers that manage GitOps for a + single Kubernetes cluster or a large scale deployment of Kubernetes + clusters. It is a distributed initialization system that makes it + easy to customize applications and manage HA clusters from a single + point. +

+ + + + + + + main + + + Overview + + + +

The bla-bla

+ + + + + + + + + + + + + + + Collaboration +

The bla-bla

+ + + + + + + diff --git a/src/docbuild/config/xml/data/product-config-schema.rnc b/src/docbuild/config/xml/data/product-config-schema.rnc deleted file mode 100644 index ff171a5a..00000000 --- a/src/docbuild/config/xml/data/product-config-schema.rnc +++ /dev/null @@ -1,926 +0,0 @@ -# RELAX NG Schema for Docserv² product configuration -namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0" - -# BASICS - -default namespace = "" -start = ds.product - - -# CONSTANTS - -# Whenever there is a backward-incompatible schema revision, bump this -# version to the version of the software itself that this schema is shipped -# with. If the schema remains backward-compatible and there are only minor -# changes, leave the version as is. -ds.schema.version = - ## Schema version - "6.0" - - -# TYPES - -ds.type.class = - ## A space-separated list of HTML classes - xsd:token { pattern = "[\-_\+\.a-zA-Z0-9]+( [\-_\+\.a-zA-Z0-9]+)*" } - -ds.type.email = - ## An email address - # http://www.dpawson.co.uk/relaxng/schema/datatypes/datatypes.html#d1034e184 - # Works for both normal addresses and forms like - # "David Tolpin"@[Obscure Place] - # The expression above is slightly more allowing than required, - # but should be appropriate for the majority of cases. - xsd:token { - pattern="""([a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+(\.[a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+)*|"[^"\\]*")@([a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+(\.[a-zA-Z0-9!#$%&'*+\-/=?\^_`{|}~]+)*|\[[^\[\]\\]*\])""" - } - -ds.type.lang = - ## A language code - xsd:token { - pattern="""[a-z]{2}(-[a-z]{2,8})?""" - } - -ds.type.gitremote = - ## URL to a Git remote ("http[s]" URLs only) - # (Let's not support SSH URLs for the moment since that needs authentication) - xsd:anyURI { - pattern="""https?://.*""" - } - -ds.type.dirname = - ## A relative directory name - xsd:anyURI { - pattern="""[^/\\]*[^/\\:](/[^/\\]+)*""" - } - -ds.type.branch = - ## A Git branch name - xsd:token { - pattern="""[^\s\\]+""" - } - -ds.type.dcfile = - ## A DC file name - xsd:string { - pattern="""DC-[\-_\.\+a-zA-Z0-9]+""" - } - -ds.type.xsltparam = - ## An XSLT parameter name - xsd:token { - pattern="""[\-_\.\+a-zA-Z0-9]+""" - } - -ds.type.alphanumeric = - ## An alphanumeric value + "-" + "_" - xsd:token { - pattern="""[\-_a-zA-Z0-9]+""" - } - -ds.type.id = - ## An ID (unlike xml:ids, this allows initial digits) - # (however, we do not check for uniqueness via RNC -- we check in docserv-stitch) - xsd:token { - pattern="""[\-_\.\+a-zA-Z0-9]+""" - } - -ds.type.idmulti = - ## A space-separated list of IDs - # (we do not check via RNC -- we check in docserv-stitch) - xsd:token { - pattern="""([\-_\.\+a-zA-Z0-9]+ )*[\-_\.\+a-zA-Z0-9]+""" - } - -ds.type.containerref = - ## A reference to a remote container image - # matches the expression used by daps2docker - xsd:token { - pattern="""[\-_\.a-zA-Z0-9]+(/[\-_\.a-zA-Z0-9]+)*(:[\-_\.a-zA-Z0-9]+)?""" - } - -ds.type.hexdigest = - ## A hash/hex digest (such as a Docker or Git SHA reference) - xsd:token { - pattern="""[a-f0-9]{7,}""" - } - -# A basic title template that allows strings like "title subtitle product/docset", -# in exactly that order, but everything except the title can be -# left away. product and docset will in many cases just be the same, and thus -# are set up to exclude each other. -# There is no guarantee that the title string will be formatted -# exactly this way or in this order, just that, if available, all of the -# information requested will come out. -ds.type.titleformat.build = - ## Elements of titles displayed on navigational pages for documents built within Docserv² - "title" | "title docset" | "title product" | "title subtitle" | "title subtitle product" | "title subtitle docset" -# For external links, some metadata is never available: product name and -# subtitle cannot be generated in any way currently (but you're free to -# create whatever title you want and that should make up for it). -ds.type.titleformat.link = - ## Elements of titles displayed on navigational pages for externally-hosted documents - "title" | "title docset" - -ds.false.enum = - ## Boolean false value - "0" | "false" -ds.true.enum = - ## Boolean true value - "1" | "true" - -# TAG/ATTRIBUTE SETS - -div -{ -# FIXME: add img? (It is a bit unclear whether our script would need to take -# care of copying stuff then.) -ds.htmlblock = - ## HTML block elements - ds.p - | ds.div - | ds.pre - | ds.ul - | ds.ol - | ds.dl - | ds.h1 - | ds.h2 - | ds.h3 - | ds.h4 - | ds.h5 - | ds.h6 -} - -div -{ -ds.htmlinline = - ## HTML inline elements - ds.a - | ds.br - | ds.cite - | ds.code - | ds.em - | ds.hr - | ds.q - | ds.s - | ds.span - | ds.strong - | ds.sub - | ds.sup - | ds.u -} - -div -{ -ds.htmlattr = - ## ID attribute (HTML, not checked for uniqueness within Docserv²) - attribute id { xsd:ID }?, - ## Class attribute (HTML) - attribute class { ds.type.class }? -} - -div -{ -ds.htmlinlinecontent = - ds.htmlattr, - (ds.htmlinline | - text)* -} - - -# Common attributes -ds.gated.attr = - ## Is the content behind a paywall? (default "false") - [ a:defaultValue = "false" ] attribute gated { xsd:boolean } - -ds.lang.attr = - ## Language code (`la-ng` style) of this description - attribute lang { ds.type.lang } - -ds.default.true.attr = - ## Whether this is the default language (must be true for initial `` element) - attribute default { ds.true.enum } - -ds.default.false.attr = - ## Whether this is the default language (must be true for initial `` element) - attribute default { ds.false.enum } - -ds.title.attr = - ## Localized title of description - attribute title { text } - -ds.titleformat.attr = - ## How to display the document title on the product version navigational page, a combination of the following values: - ## * `title`: title as extracted from the document - ## * `subtitle`: subtitle as extracted from the document (can be empty) - ## * `docset`: product and version number as classified in the Docserv² product configuration - ## * `product`: product and version number as extracted from the document (can be empty) - ## Note the following: - ## * `title` is mandatory - ## * `docset` and `product` are mutually exclusive. - ## * the order of values must be `title`, `subtitle`, `docset`/`product` - ## Default: `title subtitle` - attribute titleformat { ds.type.titleformat.build } - - -ds.category.attr = - ## What category or categories to display this document under on the product version navigational page - attribute category { ds.type.idmulti } - -ds.includes-productname.attr = - ## * is a normal version (number) that is normally combined with a - ## product name and shown in all situations. When @includes-productname=true is - ## set for , we will always only display the text rather - ## than displaying the product name alongside it. - ## * is also a version (number), also normally combined with a - ## product name. However, it is only ever shown on the home page's selection - ## boxes, but not used within internal references or for product pages. - attribute includes-productname { xsd:boolean } - -ds.remarks.attr = - ## Enable DocBook remarks in this document (`daps ... --remarks`; - ## the default value varies depending on the site configuration) - attribute remarks { xsd:boolean } - -ds.draft.attr = - ## Enable DocBook draft watermark in this document (`daps ... --draft`; - ## the default value varies depending on the site configuration and product lifecycle) - attribute draft { xsd:boolean } - -ds.meta.attr = - ## Enable DocBook meta information in this document (`daps ... --meta`; - ## the default value varies depending on the site configuration) - attribute meta { xsd:boolean } - -ds.href.attr = - ## Target URL for the link (if the URL has no protocol prefix, the link is assumed - ## to be local to the current host and a `/` will be added automatically) - attribute href { xsd:anyURI } - -# --- ROOT --- - -ds.product = - ## Product (or top-level category, root element) - element product { - # This ID value can only be checked when we take all of the productconfig - # files together (i.e. after we have run stitch.sh). In any case, it does - # not make sense to use xsd:id here because there can only ever be one - # of these ID per productconfig file. - ## Product ID, must be unique across entire site config, used as first-level path element - attribute productid { ds.type.id }, - ## Version of the schema, verifies that Docserv² major version and version of product configuration match - attribute schemaversion { ds.schema.version }, - ## Whether to enable this configuration file (`true` by default) - attribute enabled { xsd:boolean }?, - ## Site section this configuration belongs to - attribute site-section { ds.type.alphanumeric }?, - ## Whether to sort docsets of this product Z-A9-0 (`descending`, default) or 0-9A-Z (`ascending`) - attribute docset-sort { "ascending" | "descending" }?, - ds.gated.attr?, - ds.name, - ds.sortname?, - ds.acronym?, - ds.maintainers, - ds.category*, - ds.desc_default, - ds.desc_translation*, - ds.docset+ - } - - -# PRODUCT DESCRIPTION - -ds.name = - ## Name of product or top-level category - element name { - text - } - -ds.sortname = - ## Sort name of product or top-level category - element sortname { - text - } - -ds.acronym = - ## Acronym of name of product or top-level category - element acronym { - text - } - -ds.maintainers = - ## Collection of email addresses to send mail about build failures to - element maintainers { - ds.contact+ - } - -ds.contact = - ## Email address to send mail about build failures to - element contact { - ds.type.email - } - -ds.desc_default = - ## Description of product or top-level category (default language) - element desc { - ds.lang.attr, - ds.default.true.attr, - ds.shortdesc?, - ds.htmlblock+ - } - -ds.desc_translation = - ## Description of product or top-level category (dependent languages) - element desc { - ## Language code (`la-ng` style) of this description - ds.lang.attr, - ds.default.false.attr?, - ds.shortdesc?, - ds.htmlblock* - } - -ds.shortdesc_text = - xsd:string { pattern = "[^\n]{1,80}" } - -ds.shortdesc = - ## A short description of the product - element title { - ds.shortdesc_text - } - -ds.category = - ## Definition of category displayed on product detail navigational page (third-level category) - element category { - ## Category ID, must be unique across the configuration for a single product - attribute categoryid { ds.type.id }?, - ds.categorylanguage_default, - ds.categorylanguage_translation* - } - -ds.categorylanguage_default = - ## Metadata for category displayed on product detail navigational page (default language, third-level category) - element language { - ds.lang.attr, - ds.default.true.attr, - ds.title.attr, - ds.htmlblock* - } -ds.categorylanguage_translation = - ## Metadata for category displayed on product detail navigational page (dependent languages, third-level category) - element language { - ds.lang.attr, - ds.default.false.attr?, - ds.title.attr, - ds.htmlblock* - } - - -# DOCSETS - -ds.docset = - ## Product version or second-level category - element docset { - ## Set ID, must be unique across the configuration for a single product - attribute setid { ds.type.id }, - ## Lifecycle value of this product version: - ## * `unpublished` product versions can only be built for instances defined as internal in the INI configuration - ## * `beta` product versions can be built without restriction but contain a draft watermark - ## * `supported` product versions can be built without restriction - ## * `unsupported` product versions can be built without restriction but are only published as Zip archives - attribute lifecycle { "unpublished" | "beta" | "supported" | "unsupported" }, - ## Whether to build a navigational page for this product version: - ## * `linked` for navigational pages linked from the homepage (default) - ## * `hidden` for navigational pages not linked from the homepage - ## * `disabled` to disable creation of a navigational page - attribute navigation { "linked" | "hidden" | "disabled" }?, - # - ds.gated.attr?, - # To allow for name changes between versions, as in the example of SUSE - # Cloud -> SUSE OpenStack Cloud: optional ds.name here - ds.name?, - ds.sortname?, - ds.acronym?, - ds.version, - ds.canonical?, - ds.listingversion?, - ds.overridedesc?, - ( - (ds.builddocs, - ds.internal?, - ds.external?) | - (ds.internal, - ds.external?) | - ds.external - ) - } - -# * is a normal version (number) that is normally combined with a -# product name and shown in all situations. When @includes-productname=true is -# set for , we will always only display the text rather -# than displaying the product name alongside it. -# * is also a version (number), also normally combined with a -# product name. However, it is only ever shown on the home page's selection -# boxes, but not used within internal references or for product pages. -# -# FIXME: version v/ listingversion v/ @includes-productname is a bit of a mess, -# clean up eventually when use cases are clearer - -ds.version = - ## User-visible version number (or name of second-level category) - element version { - ## Whether the version number name includes the product name (default: `false`) - ds.includes-productname.attr?, - text - } -ds.canonical = - ## For canonical links; from previous, obsolete SPs to the latest - element canonical { - xsd:anyURI - } -ds.listingversion = - ## User-visible version number (or name of second-level category) displayed in homepage listing - element listingversion { - ## Whether the version number name includes the product name (default: `false`) - ds.includes-productname.attr?, - text - } - -ds.overridedesc = - ## Collection of version-specific product descriptions - element overridedesc { - ## How to treat version-specific product descriptions: - ## * `append`: append this description to the original product description - ## * `prepend`: prepend this description to the original product description - ## * `replace`: replace the original product description with this description - attribute treatment { 'append' | 'prepend' | 'replace' }, - ds.desc_default, - ds.desc_translation* - } - -ds.builddocs = - ## Container for definitions of documents to build - element builddocs { - ds.git, - ds.buildcontainer?, - ds.language_default, - ( - ds.language_translation_list | - ds.language_translation_full - )* - } - -ds.git = - ## Definition of Git remote URL to use for documentation of a specific product version (or second-level category) - element git { - ## Git remote URL - attribute remote { ds.type.gitremote }, - empty - } - -ds.buildcontainer = - ## Docker container to use for specific product version (or second-level category) - element buildcontainer { - ## Image ID, can be identified by a SHA hash (locally-available Docker image) or reference to remote Docker image - attribute image { ds.type.hexdigest | ds.type.containerref }, - empty - } - -# About @translation-type: -# * "list" creates a list of documents that will be built for the -# translation in question. This is advantageous in the common case that only -# a small subset of documents are translated into a particular language. -# * "full" means there is a full translation in this language for -# this docset - -ds.language_default = - ## Set of documents to build (default language, must list full set of documents available for product version) - element language { - ds.lang.attr, - ds.default.true.attr, - ds.branch, - ds.subdir?, - ( - ds.deliverable | - ds.deliverable_subdeliverable - )+ - } -ds.language_translation_list = - ## Set of documents to build (dependent languages, lists a subset of documents available in the default language) - element language { - ds.lang.attr, - ds.default.false.attr?, - ## Documents to build for this language are a subset of documents available in the default language - attribute translation-type { "list" }, - ds.branch?, - ds.subdir?, - ds.deliverablerestricted+ - } -ds.language_translation_full = - ## Set of documents to build (dependent languages, set of documents matches documents available in default language) - element language { - ds.lang.attr, - ds.default.false.attr?, - ## Documents to build for this language match the documents available in the default language - attribute translation-type { "full" }, - ds.branch?, - ds.subdir? - } - - -ds.branch = - ## Branch of the source Git repository - element branch { - ds.type.branch - } - -ds.subdir = - ## Subdirectory within the source Git repository - element subdir { - ds.type.dirname - } - -ds.partners = - ## A list of partners (usually for TRDs) - element partners { - ## An individual partner - element partner { text }+ - } - -ds.deliverable = - ## An individual DAPS-compatible document built on its own (default language) - element deliverable { - ds.remarks.attr?, - ds.draft.attr?, - ds.meta.attr?, - ds.category.attr?, - ds.titleformat.attr?, - ds.gated.attr?, - # - ds.subdir?, - ds.dc, - ds.format+, - ds.param*, - ds.partners* - } - -ds.deliverable_subdeliverable = - ## An individual DAPS-compatible document that is a DocBook set/book that includes articles/book (default language) - element deliverable { - ds.remarks.attr?, - ds.draft.attr?, - ds.meta.attr?, - ds.subdir?, - ds.gated.attr?, - ds.dc, - ds.format+, - ds.param*, - ds.subdeliverable+ - } - -ds.dc = - ## Reference to DC file - element dc { - ds.type.dcfile - } - -# Unfortunately, this way, I can't force people to choose at least one format -# they actually want to build. -ds.format = - ## Allows enabling/disabling document formats, at least one format must be enabled - element format { - ## Whether to enable multi-page HTML builds - attribute html { xsd:boolean }?, - ## Whether to enable single-page HTML builds - attribute single-html { xsd:boolean }?, - ## Whether to enable PDF builds - attribute pdf { xsd:boolean }?, - ## Whether to enable EPUB builds - attribute epub { xsd:boolean }? - } - -ds.param = - ## Custom XSLT parameter - element param { - ## Name of the XSLT parameter - attribute name { ds.type.xsltparam }, - text - } - - -ds.subdeliverable = - ## Individual document within a DocBook set as identified by their XML ID (default language) - element subdeliverable { - ds.category.attr?, - ds.titleformat.attr?, - ds.type.id - } - -ds.deliverablerestricted = - ## An individual DAPS-compatible document that is a DocBook set/book that includes articles/book (dependent languages) - element deliverable { - ds.gated.attr?, - ds.subdir?, - ds.dc, - ds.subdeliverablerestricted* - } - -ds.subdeliverablerestricted = - ## Individual document within a DocBook set as identified by its XML ID (dependent languages) - element subdeliverable { - ds.type.id - } - -ds.internal = - ## Container for Docserv²-internal references - element internal { - ds.ref+ - } - -# The following definition is a bit complicated, so -- the intention is to -# allow links to either of: -# * a specific product (i.e. show the most recent product revision, link will -# only support the current UI language) -# * a specific docset (link will only support the current UI language) -# * a specific deliverable (by DC), subdeliverable (by DC and rootid), or an -# external link (by link ID) -ds.ref = - ## Docserv²-internal reference - element ref { - ## Product ID of referenced document or navigational page - attribute product { ds.type.id }, - ( - ## Docset ID of referenced navigational page - attribute docset { ds.type.id }? | - ( - ## Docset ID of referenced document - attribute docset { ds.type.id }, - ( - ( - ## DC file name of referenced document - attribute dc { ds.type.id }, - ## Subdeliverable (DocBook/AsciiDoc ID) of referenced document - attribute subdeliverable { ds.type.id }?, - ds.titleformat.attr?) | - (attribute link { ds.type.id }, - ## How to display the document title on the product version navigational page, a combination of the following values: - ## * `title`: title as extracted from the document - ## * `docset`: product and version number as classified in the Docserv² product configuration - ## Note the following: - ## * `title` is mandatory - ## * the order of values must be `title`, `docset` - ## Default: `title docset` - attribute titleformat { ds.type.titleformat.link }?) - ) - ) - ), - ds.category.attr?, - empty - } - -ds.external = - ## Container for references to externally-hosted documents - element external { - ds.link* - } - -ds.link = - ## Collection of URLs for a single externally-hosted document in different languages and formats - element link { - attribute linkid { ds.type.id }?, - ds.category.attr?, - ## How to display the document title on the product version navigational page, a combination of the following values: - ## * `title`: title as extracted from the document - ## * `docset`: product and version number as classified in the Docserv² product configuration - ## Note the following: - ## * `title` is mandatory - ## * the order of values must be `title`, `docset` - ## Default: `title` - attribute titleformat { ds.type.titleformat.link }?, - ds.gated.attr?, - ds.linklanguage_default, - ds.linklanguage_translation* - } - -ds.linklanguage_default = - ## Collection of URLs for a single externally-hosted document in different formats (default language) - element language { - ds.lang.attr?, - ## Whether this is the default language (must be `false` for initial `` element) - ds.default.true.attr, - ds.title.attr, - ds.url+ - } - -ds.linklanguage_translation = - ## Collection of URLs for a single externally-hosted document in different formats (dependent languages) - element language { - ds.lang.attr?, - ds.default.false.attr?, - ds.title.attr, - ds.url+ - } - -ds.url = - ## URL of externally-hosted document - element url { - ds.href.attr, - ## Target file format of the link for display in the UI - attribute format { "html" | "single-html" | "pdf" | "epub" | "zip" | "tar" | "other" }, - empty - } - - -# SUPPORTED HTML SUBSET - -ds.p = - ## Paragraph (HTML, block) - element p { - ds.htmlinlinecontent - } - -ds.div = - ## Generic block element (HTML, block) - element div { - ds.htmlattr, - ( - ds.htmlinline | - ds.htmlblock | - text - )* - } - -ds.pre = - ## Preformatted text (HTML, block) - element pre { - ds.htmlattr, - text* - } - -ds.ul = - ## Unordered list (HTML, block) - element ul { - ds.htmlattr, - ds.li+ - } - -ds.ol = - ## Ordered (itemized) list (HTML, block) - element ol { - ds.htmlattr, - ds.li+ - } - -ds.dl = - ## Definition list (HTML, block) - element dl { - ds.htmlattr, - (ds.dt, ds.dd)+ - } - -ds.dt = - ## Term in definition list (HTML, block) - element dt { - ds.htmlattr, - ds.htmlblock* - } - -ds.dd = - ## Definition in definition list (HTML, block) - element dd { - ds.htmlattr, - ds.htmlblock* - } - -ds.li = - ## List item in unordered or ordered list (HTML, block) - element li { - ds.htmlattr, - ds.htmlblock* - } - -ds.h1 = - ## Heading of level 1 (HTML, block) - element h1 { - ds.htmlinlinecontent - } - -ds.h2 = - ## Heading of level 2 (HTML, block) - element h2 { - ds.htmlinlinecontent - } - -ds.h3 = - ## Heading of level 3 (HTML, block) - element h3 { - ds.htmlinlinecontent - } - -ds.h4 = - ## Heading of level 4 (HTML, block) - element h4 { - ds.htmlinlinecontent - } - -ds.h5 = - ## Heading of level 5 (HTML, block) - element h5 { - ds.htmlinlinecontent - } - -ds.h6 = - ## Heading of level 6 (HTML, block) - element h6 { - ds.htmlinlinecontent - } - - -ds.sup = - ## Superscript text (HTML, inline) - element sup { - ds.htmlinlinecontent - } - -ds.sub = - ## Subscript text (HTML, inline) - element sub { - ds.htmlinlinecontent - } - -ds.s = - ## Struck text (HTML, inline) - element s { - ds.htmlinlinecontent - } - -ds.u = - ## Underlined text (HTML, inline) - element u { - ds.htmlinlinecontent - } - -ds.q = - ## Short quote (HTML, inline) - element q { - ds.htmlinlinecontent - } - -ds.em = - ## Emphasized text, displayed in italics (HTML, inline) - element em { - ds.htmlinlinecontent - } - -ds.a = - ## Web link (HTML, inline) - element a { - ds.href.attr, - ## Whether to open the link in a new tab/window (`_blank`) - attribute target { "_blank" }?, - ## Attributes of the link: - ## * `nofollow`: Ask search engine spiders not to follow the link - ## * `prev`: Link target is the previous in a series of documents - ## * `next`: Link target is the next in a series of documents - ## * `license`: Link target represents a license of the current page - ## * `alternate`: Link target represents an alternate variant of the current page (such as a different language or format) - attribute rel { "nofollow" | "prev" | "next" | "license" | "alternate" }?, - ds.htmlinlinecontent - } - -ds.strong = - ## Strongly emphasized text, displayed in boldface (HTML, inline) - element strong { - ds.htmlinlinecontent - } - -ds.code = - ## Code/command (HTML, inline) - element code { - ds.htmlinlinecontent - } - -ds.cite = - ## Citation (HTML, inline) - element cite { - ds.htmlinlinecontent - } - -ds.span = - ## Generic inline element (HTML, inline) - element span { - ds.htmlinlinecontent - } - -ds.br = - ## Manual line break (HTML, inline) - element br { - ds.htmlattr, - empty - } - -ds.hr = - ## Horizontal rule (HTML, inline) - element hr { - ds.htmlattr, - empty - } diff --git a/src/docbuild/config/xml/data/rng2docbook.xsl b/src/docbuild/config/xml/data/rng2docbook.xsl new file mode 100644 index 00000000..98e41edc --- /dev/null +++ b/src/docbuild/config/xml/data/rng2docbook.xsl @@ -0,0 +1,466 @@ + + + + + + + + + + +
+ + + <xsl:choose> + <xsl:when test="db:refname"> + <xsl:value-of select="db:refname[1]"/> + </xsl:when> + <xsl:otherwise>Schema Reference</xsl:otherwise> + </xsl:choose> + + + + + + + + +
+ + + + + + + + + + + + + + + start + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + rnc. + + start + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Content Model + + + ::= + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Content Model + + + ::= + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Attributes + + + + + + @ + + + + + + + + + + + + + + + + + + + (default: + + + + ) + + + [type: + + + + ] + + + + + + + + + + + + + + + + + + + + + + + : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text + + + + + + + + + + , + + + + + + + + + data( + + ) + + + + " + + " + + + + + + + + | + + + + + + + + + + + ( + + + + , + + + ) + + + + + + + + + & + + + + + + + + + + + + + + + + + + + * + + + + + + + + ? + + + +