Project icon

com.io7m.xstructural

Build status Maven Central Codecov

The xstructural package provides an XSLT implementation of the structural documentation language.

Contents

Features

  • Extremely simple core language with roughly ~20 elements. Easy to learn!
  • DocBook-like semantic tagging of terms without the need to memorize hundreds of XML elements.
  • Automatic tables of content, section and paragraph numbering.
  • Full, strict XSD schema with mandatory validation of documents.
  • XHTML Strict 1.0 output, in single or multi-page forms.
  • EPUB output.
  • Produces valid and strongly accessible XHTML, with captions and metadata for screen readers. Tools automatically validate their own output and refuse to produce invalid output.
  • Written in Java 17 for platform independence.
  • Fully documented command line tools for document processing.
  • Maven plugin for processing documentation as part of a project build.
  • Large, high-coverage test suite.
  • OSGi-ready
  • JPMS-ready
  • High-coverage automated test suite.
  • ISC license

Releases

The most recently published version of the software is 1.9.0.

Source code and binaries are available from the repository.

Documentation

Documentation for the 1.9.0 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural</artifactId>
  <version>1.9.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural.api</artifactId>
  <version>1.9.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural.cmdline</artifactId>
  <version>1.9.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural.documentation</artifactId>
  <version>1.9.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural.maven_plugin</artifactId>
  <version>1.9.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural.tests</artifactId>
  <version>1.9.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural.vanilla</artifactId>
  <version>1.9.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.xstructural</groupId>
  <artifactId>com.io7m.xstructural.xml</artifactId>
  <version>1.9.0</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2024-09-16 Release: com.io7m.xstructural 1.9.0
2024-09-14 Change: Change CSS to a form that scales with screen sizes. (tickets: 28 )
2024-09-14 Change: Formal items were being assigned the wrong CSS class. (tickets: 26 )
2024-09-14 Change: Use normalize-space() on link targets. (tickets: 30 )
2024-09-15 Change: Add MULTIPLE_FILE_INDEX_ONLY index generation. (tickets: 29 )
2024-09-15 Change: Add the ability to add web cover images. (tickets: 27 )
2024-05-08 Release: com.io7m.xstructural 1.8.1
2024-05-05 Change: Update org.apache.commons:commons-compress 1.25.0 → 1.26.1.
2024-05-08 Change: Update ch.qos.logback:logback-classic:1.4.14 → 1.5.6
2024-05-08 Change: Update org.slf4j:slf4j-api:2.0.10 → 2.0.13
2024-05-08 Change: Update com.io7m.junreachable:com.io7m.junreachable.core:4.0.0 → 4.0.2
2024-05-08 Change: Update com.github.marschall:memoryfilesystem:2.7.0 → 2.8.0
2024-05-08 Change: Update commons-io:commons-io:2.15.1 → 2.16.1
2024-05-08 Change: Update org.apache.tika:tika-core:2.9.1 → 2.9.2
2024-05-08 Change: Update org.apache.maven.plugin-tools:maven-plugin-annotations:3.10.2 → 3.13.0
2024-05-08 Change: Update org.immutables:value:2.10.0 → 2.10.1
2024-05-08 Change: Update org.junit.jupiter:junit-jupiter-api:5.10.1 → 5.10.2
2024-05-08 Change: Update org.junit.jupiter:junit-jupiter-engine:5.10.1 → 5.10.2
2022-11-13 Release: com.io7m.xstructural 1.8.0
2022-11-13 Change: Add a Maven plugin to avoid classpath pollution during Maven builds.
2022-11-13 Release: com.io7m.xstructural 1.7.2
2022-11-13 Change: Update org.osgi:org.osgi.service.component.annotations 1.5.0 → 1.5.1-RC1.
2022-11-13 Change: Update net.sf.saxon:Saxon-HE 10.3 → 10.8.
2022-11-13 Change: Update org.slf4j:slf4j-api 2.0.1 → 2.0.3.
2022-11-13 Change: Update ch.qos.logback:logback-classic 1.4.1 → 1.4.4.
2022-11-13 Change: Update com.github.marschall:memoryfilesystem 2.3.0 → 2.4.0.
2022-11-13 Change: Update org.apache.commons:commons-compress 1.21 → 1.22.
2022-11-13 Change: Update org.apache.tika:tika-core 2.1.0 → 2.6.0.
2022-11-13 Change: Switch to using xercesImpl instead of depending on JVM XML factories.
2022-09-21 Release: com.io7m.xstructural 1.7.1
2022-09-21 Change: In the table of contents, subsections were being numbered as if they were sections. (tickets: 22 )
2022-09-20 Release: com.io7m.xstructural 1.7.0
2022-09-20 Change: Add the ability to add extra EPUB resources. (tickets: 19 )
2022-09-20 Release: com.io7m.xstructural 1.6.0
2022-09-20 Change: Update slf4j to 2.0.1
2022-09-20 Change: Update logback to 1.4.1
2022-06-30 Release: com.io7m.xstructural 1.5.0
2022-06-30 Change: Add 1em margin to list items (tickets: 21 )
2022-06-30 Change: Update dependencies
2022-02-03 Release: com.io7m.xstructural 1.4.0
2022-02-03 Change: Fix a bug where documents with comments would be rejected (tickets: 18 )
2022-02-03 Change: Ensure existing files are replaced when producing EPUBs (tickets: 20 )
2022-02-03 Release: com.io7m.xstructural 1.3.0
2021-06-27 Change: Add EPUB support (tickets: 13 )
2021-06-27 Change: Fix a schema bug that rejected valid footnotes in documents
2020-12-20 Release: com.io7m.xstructural 1.2.0
2020-12-19 Change: Slightly improve the CSS for table elements
2020-12-19 Release: com.io7m.xstructural 1.1.0
2020-12-19 Change: Use "Front Matter" in XHTML documents (tickets: 12 )
2020-12-19 Change: Update primogenitor support 6.0.0 -> 6.1.0
2020-12-19 Change: Update org.osgi:org.osgi.annotation.bundle 1.0.0 -> 1.1.0
2020-12-19 Change: Update org.osgi:org.osgi.annotation.versioning 1.1.0 -> 1.1.1
2020-12-19 Change: Update Saxon-HE 10.2 -> 10.3
2020-12-11 Release: com.io7m.xstructural 1.0.0
2020-12-11 Change: Initial public release

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/xstructural

$ git clone https://www.github.com/io7m-com/xstructural

License

Copyright © 2024 Mark Raynsford <code@io7m.com> https://www.io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.