Release: com.io7m.xstructural 1.9.0

Change: Add MULTIPLE_FILE_INDEX_ONLY index generation. (Ticket: #29)
Change: Add the ability to add web cover images. (Ticket: #27)
Change: Change CSS to a form that scales with screen sizes. (Ticket: #28)
Change: Formal items were being assigned the wrong CSS class. (Ticket: #26)
Change: Use normalize-space() on link targets. (Ticket: #30)

.github/workflows/deploy-release.sh

@@ -1,4 +1,9 @@
 #!/bin/sh
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#
 
 fatal()
 {
@@ -22,6 +27,11 @@ fi
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
 
+  <!-- Enable deployment of OCI images. -->
+  <activeProfiles>
+    <activeProfile>io7m-oci-image</activeProfile>
+  </activeProfiles>
+
   <profiles>
     <profile>
       <id>io7m</id>
@@ -54,5 +64,6 @@ exec mvn \
 -Dio7m.deployment=true \
 --batch-mode \
 --strict-checksums \
+-Denforcer.skip=true \
 -DskipTests=true \
 -DskipITs=true deploy

.github/workflows/deploy-snapshot.sh

@@ -1,4 +1,9 @@
 #!/bin/sh
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#
 
 fatal()
 {
@@ -46,5 +51,6 @@ EOF
 exec mvn \
 --batch-mode \
 --strict-checksums \
+-Denforcer.skip=true \
 -DskipTests=true \
 -DskipITs=true deploy

.github/workflows/deploy.linux.temurin.lts.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: deploy.linux.temurin.lts
 
@@ -19,10 +25,13 @@ jobs:
           java-version: 21
           distribution: temurin
 
+      - name: Check PGP version
+        run: gpg --version
+
       - name: Import signing key
         env:
           PGP_SIGNING_KEY: ${{ secrets.PGP_SIGNING_KEY }}
-        run: echo "${PGP_SIGNING_KEY}" | gpg --import
+        run: echo "${PGP_SIGNING_KEY}" | gpg -v --import
 
       - name: Log in to Quay.io.
         uses: redhat-actions/[email protected]

.github/workflows/main.linux.temurin.current.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: main.linux.temurin.current
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs

.github/workflows/main.linux.temurin.lts.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: main.linux.temurin.lts
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs
@@ -38,7 +47,7 @@ jobs:
           path: ./com.io7m.xstructural.tests/target/surefire-reports
 
       - name: Coverage
-        uses: codecov/codecov-action@v4.3.1
+        uses: codecov/codecov-action@v4.5.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: com.io7m.xstructural.tests/target/site/jacoco-aggregate/jacoco.xml

.github/workflows/main.windows.temurin.current.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: main.windows.temurin.current
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs

.github/workflows/main.windows.temurin.lts.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: main.windows.temurin.lts
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs

.github/workflows/pr.linux.temurin.current.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: pr.linux.temurin.current
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs

.github/workflows/pr.linux.temurin.lts.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: pr.linux.temurin.lts
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs

.github/workflows/pr.windows.temurin.current.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: pr.windows.temurin.current
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs

.github/workflows/pr.windows.temurin.lts.yml

@@ -1,3 +1,9 @@
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#  Workflow profile: Core
+#
 
 name: pr.windows.temurin.lts
 
@@ -27,7 +33,10 @@ jobs:
         id: project_is_snapshot
         run: java .github/workflows/Tools.java ShowProjectIsSnapshot pom.xml >> "$GITHUB_OUTPUT"
 
+
       - name: Build
+        env:
+          XOANON_REALLY_USE_LOCAL_DISPLAY: true
         run: mvn --batch-mode --strict-checksums --errors clean verify site
 
       - name: Upload test logs

.github/workflows/run-with-xvfb.sh

@@ -0,0 +1,66 @@
+#!/bin/bash -ex
+#
+#  Automatically generated: DO NOT EDIT.
+#
+#  Generation code: https://www.github.com/io7m-com/.github/
+#
+
+exec > >(tee build.txt) 2>&1
+
+#---------------------------------------------------------------------
+# Install all of the various required packages.
+#
+# We use:
+#   xvfb    to provide a virtual X server
+#   fluxbox to provide a bare-minimum window manager with click-to-focus
+#   ffmpeg  to record the session
+#   feh     to set a background
+#
+
+sudo apt-get -y update
+sudo apt-get -y upgrade
+sudo apt-get -y install xvfb fluxbox feh ffmpeg
+
+#---------------------------------------------------------------------
+# Start Xvfb on a new display.
+#
+
+Xvfb :99 &
+export DISPLAY=:99
+sleep 1
+
+#---------------------------------------------------------------------
+# Start recording the session.
+#
+
+ffmpeg -f x11grab -y -r 60 -video_size 1280x1024 -i :99 -vcodec vp9 test-suite.webm &
+FFMPEG_PID="$!"
+
+#---------------------------------------------------------------------
+# Start fluxbox on the X server.
+#
+
+fluxbox &
+sleep 1
+
+#---------------------------------------------------------------------
+# Set a desktop image.
+#
+
+feh --bg-tile .github/workflows/wallpaper.png
+sleep 1
+
+#---------------------------------------------------------------------
+# Execute the passed-in build command.
+#
+
+"$@"
+
+#---------------------------------------------------------------------
+# Wait a while, and then instruct ffmpeg to stop recording. This step
+# is necessary because video files need to be processed when recording
+# stops.
+#
+
+sleep 20
+kill -INT "${FFMPEG_PID}" || true

README-CHANGES.xml

@@ -99,7 +99,7 @@
         <c:change date="2022-11-13T00:00:00+00:00" summary="Add a Maven plugin to avoid classpath pollution during Maven builds."/>
       </c:changes>
     </c:release>
-    <c:release date="2024-05-08T21:41:14+00:00" is-open="false" ticket-system="com.github.io7m.xstructural" version="1.8.1">
+    <c:release date="2024-05-08T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.xstructural" version="1.8.1">
       <c:changes>
         <c:change date="2024-05-05T00:00:00+00:00" summary="Update org.apache.commons:commons-compress 1.25.0 → 1.26.1."/>
         <c:change date="2024-05-08T00:00:00+00:00" summary="Update ch.qos.logback:logback-classic:1.4.14 → 1.5.6"/>
@@ -114,6 +114,35 @@
         <c:change date="2024-05-08T00:00:00+00:00" summary="Update org.junit.jupiter:junit-jupiter-engine:5.10.1 → 5.10.2"/>
       </c:changes>
     </c:release>
+    <c:release date="2024-09-16T16:00:45+00:00" is-open="false" ticket-system="com.github.io7m.xstructural" version="1.9.0">
+      <c:changes>
+        <c:change date="2024-09-14T00:00:00+00:00" summary="Change CSS to a form that scales with screen sizes.">
+          <c:tickets>
+            <c:ticket id="28"/>
+          </c:tickets>
+        </c:change>
+        <c:change date="2024-09-14T00:00:00+00:00" summary="Formal items were being assigned the wrong CSS class.">
+          <c:tickets>
+            <c:ticket id="26"/>
+          </c:tickets>
+        </c:change>
+        <c:change date="2024-09-14T00:00:00+00:00" summary="Use normalize-space() on link targets.">
+          <c:tickets>
+            <c:ticket id="30"/>
+          </c:tickets>
+        </c:change>
+        <c:change date="2024-09-15T00:00:00+00:00" summary="Add MULTIPLE_FILE_INDEX_ONLY index generation.">
+          <c:tickets>
+            <c:ticket id="29"/>
+          </c:tickets>
+        </c:change>
+        <c:change date="2024-09-15T00:00:00+00:00" summary="Add the ability to add web cover images.">
+          <c:tickets>
+            <c:ticket id="27"/>
+          </c:tickets>
+        </c:change>
+      </c:changes>
+    </c:release>
   </c:releases>
   <c:ticket-systems>
     <c:ticket-system default="true" id="com.github.io7m.xstructural" url="https://www.github.com/io7m/xstructural/issues/"/>

com.io7m.xstructural.api/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.xstructural</artifactId>
     <groupId>com.io7m.xstructural</groupId>
-    <version>1.8.1</version>
+    <version>1.9.0</version>
   </parent>
 
   <artifactId>com.io7m.xstructural.api</artifactId>

com.io7m.xstructural.api/src/main/java/com/io7m/xstructural/api/XSProcessorRequestType.java

@@ -129,7 +129,21 @@ enum Stylesheet
      * use in an EPUB file.
      */
 
-    EPUB
+    EPUB,
+
+    /**
+     * <p>The multiple file index stylesheet. Produces a single index file
+     * that contains references to elements as they would appear had they
+     * been handled by the {@link #MULTIPLE_FILE} stylesheet.</p>
+     *
+     * <p>Essentially, the index answers the question "Given an element in my
+     * source document, in which file does that element appear in the output
+     * document?".</p>
+     *
+     * @since 1.9.0
+     */
+
+    MULTIPLE_FILE_INDEX_ONLY
   }
 
   /**