doclang 0.4.0__tar.gz

doclang-0.4.0/CHANGELOG.md

@@ -0,0 +1,57 @@
+## [v0.4.0](https://github.com/doclang-project/doclang/releases/tag/v0.4.0)
+
+* refine public API and reorganize validator docs (#85)
+* update spec example picture, add fixture (#84)
+* enforce field scope rules, expand recommendation guidance (#83)
+* improve `<location>` handling, various spec refinements (#82)
+* add version to spec, rescope example showing planned feature (#81)
+* refine `<picture>` subclassing, update examples (#80)
+* add CI, enhance dev env and validation tools (#79)
+* Update spec.md
+* extend `<picture>` documentation, detail `src.uri`, improve `<smiles>`
+* clarify `<picture>`/`<src>`, update default class/label & picture labels
+* improve documentation of `<formula>`, `<superscript>` & `<subscript>`
+* limit scope that goes into package sdist
+* enable package versioning w/out Git info
+* add `<label>`, document recommended values
+* refactor spec for clarity and correctness
+* refine repo layout
+* enhance `location@value` validation in schema and documentation
+* remove `<floating_group>` from validator
+* align `field_heading@level` spec
+* align `heading@level` constraints
+* add `<custom>`, defer `<meta>`
+* sync validator w.r.t. `<layer>`
+* add `<default_resolution>` to validator, add tests, align `<h_thread>`
+* add `<page_break>` to validator, add tests
+* refactor spec, separating out planned features
+* fix typo
+* add missing caption test
+* restor broken image link
+* refactor terminology, move `<caption>` to element head
+* minor test improvements
+* add `<thread>` validation & tests
+* add cross-reference support, refactor hyperlink support
+* refine terminology
+* enhance release preparation, add changelog
+* switch to dynamic versioning, document release process
+* improve semantic element nesting handling
+* add content element to virtual text schema
+* update version retrieval method
+* Update ISO standard contributor table
+
+## [v0.3.0](https://github.com/doclang-project/doclang/releases/tag/v0.3.0)
+
+* add table index class and version sync utility
+* add virtual text support to lists and tables, incl. validation
+
+## [v0.2.0](https://github.com/doclang-project/doclang/releases/tag/v0.2.0)
+
+* chore: align lists, tables, groups, headings
+* fix table structure description and examples
+* restructure specification incl. appendices, auto-inject ref data
+
+
+## [v0.1.0](https://github.com/doclang-project/doclang/releases/tag/v0.1.0)
+
+* Initial version

doclang-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

doclang-0.4.0/MANIFEST.in

@@ -0,0 +1,14 @@
+# Runtime package and build metadata only; repo assets stay in git.
+graft doclang
+include pyproject.toml README.md LICENSE CHANGELOG.md
+
+prune examples
+prune exports
+prune reference
+prune resources
+prune utils
+prune tests
+
+exclude uv.lock spec.md .pre-commit-config.yaml .gitignore
+
+global-exclude *.py[cod] __pycache__ */__pycache__/*

doclang-0.4.0/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: doclang
+Version: 0.4.0
+Summary: DocLang specification and reference validator (XSD, Schematron, CLI)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml>=6.0.2
+Requires-Dist: saxonche>=12.9.0
+Requires-Dist: typer>=0.15.1
+Dynamic: license-file
+
+# DocLang
+
+Specification and reference validator for the [DocLang](https://www.doclang.ai/) document format.
+
+This repository contains:
+
+- **[spec.md](./spec.md)** — normative specification
+- **`doclang/`** — reference validator (XSD + Schematron, `doclang` CLI on PyPI)
+
+For validator usage (install, CLI, XSD/Schematron), see [doclang/README.md](./doclang/README.md).
+
+To work on this repository — setup, tests, reference generation, releases — see [CONTRIBUTING.md](./CONTRIBUTING.md).

doclang-0.4.0/README.md

@@ -0,0 +1,12 @@
+# DocLang
+
+Specification and reference validator for the [DocLang](https://www.doclang.ai/) document format.
+
+This repository contains:
+
+- **[spec.md](./spec.md)** — normative specification
+- **`doclang/`** — reference validator (XSD + Schematron, `doclang` CLI on PyPI)
+
+For validator usage (install, CLI, XSD/Schematron), see [doclang/README.md](./doclang/README.md).
+
+To work on this repository — setup, tests, reference generation, releases — see [CONTRIBUTING.md](./CONTRIBUTING.md).

doclang-0.4.0/doclang/README.md

@@ -0,0 +1,106 @@
+# DocLang Validation
+
+Validate DocLang XML documents against XSD schema and Schematron rules.
+
+## Installation
+
+```bash
+pip install doclang
+```
+
+## Usage
+
+### Basic CLI Usage
+
+```bash
+doclang validate my_document.dclg.xml
+```
+
+### More CLI Usage Scenarios
+
+```bash
+## Inject DocLang namespace if document doesn't declare it:
+doclang validate my_document.dclg.xml --allow-empty-namespace
+
+# XSD validation only
+doclang validate my_document.dclg.xml --xsd-only
+
+# Schematron validation only
+doclang validate my_document.dclg.xml --schematron-only
+
+# JSON output
+doclang validate my_document.dclg.xml --format json
+
+# Quiet mode (exit code only)
+doclang validate my_document.dclg.xml --quiet
+
+# Show help
+doclang --help
+```
+
+### Python API
+
+```python
+from doclang import validate, ValidationError
+
+try:
+    validate("my_document.dclg.xml")
+    print("Validation OK (no exception)")
+except ValidationError as exc:
+    print(exc)  # human-readable summary
+    print(f"{exc.xsd_errors=}")
+    print(f"{exc.schematron_errors=}")
+```
+
+## Validation Rules
+
+### XSD Validation (doclang.xsd)
+
+Standard XML Schema Definition for structural validation:
+
+- Document structure and element hierarchy
+- Data types and attributes
+- Element ordering
+
+### Schematron Rules (doclang.sch)
+
+Additional business rules that XSD cannot express, using XSLT 3.0 and XPath 3.1:
+
+```xml
+<sch:pattern id="my-rule">
+  <sch:rule context="dl:element">
+    <sch:assert test="condition">Error message</sch:assert>
+  </sch:rule>
+</sch:pattern>
+```
+
+The validation uses XSLT 3.0 for modern XPath features.
+
+## XSD Validation with VS Code
+
+In VS Code you can use [Red Hat's XML extension](https://open-vsx.org/vscode/item?itemName=redhat.vscode-xml) and enable IDE-native XSD validation by adding the following to your `settings.json` (ℹ️ replacing the actual XSD path):
+
+```xml
+    "xml.fileAssociations": [
+        {
+            "pattern": "**/*.dclg.xml",
+            "systemId": "file:///absolute/path/to/doclang.xsd",
+        }
+    ],
+```
+
+For this to work, the DocLang XML document must include the relevant namespace:
+
+```xml
+<doclang xmlns="https://www.doclang.ai/ns/v0">
+    <!-- ... -->
+</doclang>
+```
+
+Note that this approach does not cover Schematron validation rules.
+
+## References
+
+- [XSD 1.0 Specification](https://www.w3.org/TR/xmlschema-1/)
+- [ISO Schematron](http://schematron.com/)
+- [XPath 3.1 Specification](https://www.w3.org/TR/xpath-31/)

doclang-0.4.0/doclang/__init__.py

@@ -0,0 +1,5 @@
+"""DocLang reference validator."""
+
+from doclang.validation import ValidationError, validate
+
+__all__ = ["ValidationError", "validate"]

doclang-0.4.0/doclang/_schemas.py

@@ -0,0 +1,23 @@
+"""Bundled DocLang schema paths (internal)."""
+
+from pathlib import Path
+
+_SCHEMA_DIR = Path(__file__).resolve().parent
+
+
+def _bundled_xsd_path() -> Path:
+    path = _SCHEMA_DIR / "doclang.xsd"
+    if not path.exists():
+        raise FileNotFoundError(f"Bundled XSD schema not found: {path}")
+    return path
+
+
+def _bundled_sch_path() -> Path:
+    path = _SCHEMA_DIR / "doclang.sch"
+    if not path.exists():
+        raise FileNotFoundError(f"Bundled Schematron schema not found: {path}")
+    return path
+
+
+def _bundled_schema_paths() -> tuple[Path, Path]:
+    return _bundled_xsd_path(), _bundled_sch_path()

doclang-0.4.0/doclang/cli.py

@@ -0,0 +1,172 @@
+"""
+DocLang CLI - Command-line interface for XML validation.
+
+Provides a user-friendly CLI using Typer for validating DocLang XML documents
+against XSD schemas and Schematron rules.
+"""
+
+import json
+from enum import Enum
+from pathlib import Path
+from typing import Any
+
+import typer
+
+from doclang._schemas import _bundled_schema_paths
+from doclang.utils import _VERSION
+from doclang.validation import ValidationError
+from doclang.validation import validate as validate_document
+
+app = typer.Typer(
+    name="doclang",
+    help="DocLang XML validation tool with XSD and Schematron support",
+    add_completion=False,
+    no_args_is_help=True,
+)
+
+
+class OutputFormat(str, Enum):
+    """Output format options."""
+
+    text = "text"
+    json = "json"
+
+
+@app.command(
+    context_settings={"help_option_names": ["-h", "--help"]},
+    no_args_is_help=True,
+)
+def validate(
+    xml_file: Path = typer.Argument(..., help="XML file to validate", exists=True),
+    xsd_only: bool = typer.Option(False, "--xsd-only", help="Validate XSD only"),
+    schematron_only: bool = typer.Option(False, "--schematron-only", help="Validate Schematron only"),
+    allow_empty_namespace: bool = typer.Option(
+        False,
+        "--allow-empty-namespace",
+        "-n",
+        help="Allow documents without namespace (auto-inject DocLang namespace)",
+    ),
+    quiet: bool = typer.Option(False, "--quiet", "-q", help="Quiet mode (exit code only)"),
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="Verbose output"),
+    format: OutputFormat = typer.Option(OutputFormat.text, "--format", "-f", help="Output format"),
+):
+    """
+    Validate XML document against bundled XSD schema and Schematron rules.
+
+    Examples:
+
+        doclang validate document.xml
+        doclang validate document.xml --xsd-only
+        doclang validate document.xml --format json
+    """
+    try:
+        bundled_xsd, bundled_sch = _bundled_schema_paths()
+    except FileNotFoundError as exc:
+        typer.echo(f"Error: {exc}", err=True)
+        raise typer.Exit(1)
+
+    if not quiet and format == OutputFormat.text:
+        typer.echo(f"Validating: {xml_file}")
+        typer.echo("-" * 60)
+
+    try:
+        validate_document(
+            xml_file,
+            allow_empty_namespace=allow_empty_namespace,
+            xsd_only=xsd_only,
+            schematron_only=schematron_only,
+        )
+    except ValidationError as exc:
+        results: dict[str, Any] = {
+            "file": exc.file,
+            "xsd": {"valid": exc.xsd_valid, "errors": exc.xsd_errors},
+            "schematron": {"valid": exc.schematron_valid, "errors": exc.schematron_errors},
+        }
+
+        if not quiet and format == OutputFormat.text:
+            if not schematron_only:
+                if verbose:
+                    typer.echo("XSD Validation")
+                    typer.echo(f"Schema: {bundled_xsd}")
+                if exc.xsd_valid:
+                    typer.echo("XSD validation passed")
+                else:
+                    typer.echo("XSD validation failed")
+                    for error in exc.xsd_errors:
+                        if "line" in error:
+                            typer.echo(f"  Line {error['line']}: {error['message']}")
+                        else:
+                            typer.echo(f"  {error.get('error', 'Unknown error')}")
+
+            if not xsd_only and (exc.xsd_valid or schematron_only):
+                if verbose:
+                    typer.echo("Schematron Validation")
+                    typer.echo(f"Schema: {bundled_sch}")
+                if exc.schematron_valid:
+                    typer.echo("Schematron validation passed")
+                else:
+                    typer.echo("Schematron validation failed")
+                    for error in exc.schematron_errors:
+                        typer.echo(f"  {error['location']}")
+                        typer.echo(f"    {error['message']}")
+
+        if format == OutputFormat.json:
+            typer.echo(json.dumps(results, indent=2))
+        elif not quiet:
+            typer.echo("-" * 60)
+            typer.echo("VALIDATION FAILED")
+
+        raise typer.Exit(1)
+
+    if not quiet and format == OutputFormat.text:
+        if not schematron_only:
+            if verbose:
+                typer.echo("XSD Validation")
+                typer.echo(f"Schema: {bundled_xsd}")
+            typer.echo("XSD validation passed")
+
+        if not xsd_only:
+            if verbose:
+                typer.echo("Schematron Validation")
+                typer.echo(f"Schema: {bundled_sch}")
+            typer.echo("Schematron validation passed")
+
+    if format == OutputFormat.json:
+        typer.echo(
+            json.dumps(
+                {
+                    "file": str(xml_file),
+                    "xsd": {"valid": True, "errors": []},
+                    "schematron": {"valid": True, "errors": []},
+                },
+                indent=2,
+            )
+        )
+    elif not quiet:
+        typer.echo("-" * 60)
+        typer.echo("VALIDATION SUCCESSFUL")
+
+
+def _version_callback(value: bool):
+    """Show version and exit."""
+    if value:
+        typer.echo(f"doclang version {_VERSION}")
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    version: bool = typer.Option(
+        None,
+        "--version",
+        "-v",
+        callback=_version_callback,
+        is_eager=True,
+        help="Show version and exit",
+    ),
+):
+    """DocLang XML validation tool."""
+
+
+if __name__ == "__main__":
+    app()