Fix sets tab order to "Structure" when a document is tagged #1260 (#1449

) * Set tab order when document is tagged * Update approach and add inverse test * Revert page dictionary setup * Update lib/mixins/markings.js * Update kitchen-sink-accessible.pdf * Update CHANGELOG.md --------- Co-authored-by: Libor M. <[email protected]>
foliojs · Dec 26, 2024 · 8b20d07 · 8b20d07
1 parent baeff0f
commit 8b20d07
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 - Update fontkit to 2.0
 - Update linebreak to 1.1
 - Add support for spot colors
+- Fix sets tab order to "Structure" when a document is tagged
 - Fix measuring text when OpenType features are passed in to .text()
 
 ### [v0.15.2] - 2024-12-15

diff --git a/examples/kitchen-sink-accessible.pdf b/examples/kitchen-sink-accessible.pdf
diff --git a/lib/mixins/markings.js b/lib/mixins/markings.js
@@ -138,6 +138,10 @@ export default {
     return this._root.data.MarkInfo;
   },
 
+  hasMarkInfoDictionary() {
+    return !!this._root.data.MarkInfo;
+  },
+
   getStructTreeRoot() {
     if (!this._root.data.StructTreeRoot) {
       this._root.data.StructTreeRoot = this.ref({

diff --git a/lib/page.js b/lib/page.js
@@ -155,7 +155,15 @@ class PDFPage {
     return this.content.write(chunk);
   }
 
+  // Set tab order if document is tagged for accessibility.
+  _setTabOrder() {
+    if (!this.dictionary.Tabs && this.document.hasMarkInfoDictionary()) {
+      this.dictionary.data.Tabs = 'S';
+    }
+  }
+
   end() {
+    this._setTabOrder();
     this.dictionary.end();
     this.resources.data.ColorSpace = this.resources.data.ColorSpace || {};
     for (let color of Object.values(this.document.spotColors)) {

diff --git a/tests/unit/markings.spec.js b/tests/unit/markings.spec.js
@@ -623,6 +623,47 @@ EMC
         `(My Title)`,
         `endobj`
       ]);
+      expect(docData).toContainChunk([
+        `10 0 obj`,
+        /\/Tabs \/S/,
+        `endobj`
+      ]);
+    });
+  });
+
+  describe('untagged document', () => {
+    test('taborder not set for unmarked content', () => {
+      document = new PDFDocument({
+        info: {
+          CreationDate: new Date(Date.UTC(2018, 1, 1)),
+          Title: "My Title"
+        },
+        displayTitle: true,
+        compress: false,
+        pdfVersion: '1.5',
+        tagged: false,
+        lang: 'en-AU'
+      });
+
+      const docData = logData(document);
+
+      document.end();
+
+      expect(docData).toContainChunk([
+        `3 0 obj`,
+        /\/Lang \(en-AU\)/,
+        `endobj`
+      ]);
+      expect(docData).not.toContainChunk([
+        `3 0 obj`,
+        /\/MarkInfo 5 0 R/,
+        `endobj`
+      ]);
+      expect(docData).not.toContainChunk([
+        `10 0 obj`,
+        /\/Tabs \/S/,
+        `endobj`
+      ]);
     });
   });