Skip to content

TIKA-4967: link REF/PAGEREF/NOTEREF and HYPERLINK \l fields to bookma… - #3317

Merged
tballison merged 3 commits into
apache:mainfrom
tballison:TIKA-4967
Oct 18, 2026
Merged

tballison merged 3 commits into
apache:mainfrom
tballison:TIKA-4967

Conversation

@tballison

Copy link
Copy Markdown
Contributor

…rks in docx

Thanks for your contribution to Apache Tika! Your help is appreciated!

Before opening the pull request, please verify that

  • there is an open issue on the Tika issue tracker which describes the problem or the improvement. We cannot accept pull requests without an issue because the change wouldn't be listed in the release notes.
  • the issue ID (TIKA-XXXX)
    • is referenced in the title of the pull request
    • and placed in front of your commit messages surrounded by square brackets ([TIKA-XXXX] Issue or pull request title)
  • commits are squashed into a single one (or few commits for larger changes)
  • Tika builds and unit tests pass with ./mvnw clean install (clean test alone cannot resolve the pipes plugin zips)
  • if you used a generative AI tool: follow the ASF Generative Tooling Guidance (Generated-by: <tool> in the commit message), and consider running the pre-flight in .skills/devs/pr-review/SKILL.md — fix what it finds; don't paste its report here
  • there should be no conflicts when merging the pull request branch into the recent main branch. If there are conflicts, please try to rebase the pull request branch on top of a freshly pulled main branch
  • if you add new module that downstream users will depend upon add it to relevant group in tika-bom/pom.xml.

We will be able to faster integrate your pull request if these conditions are met. If you have any questions how to fix your problem or about using Tika in general, please sign up for the Tika mailing list. Thanks!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Quoted bookmark arguments are valid but currently fail to produce links.

1 open finding
What changed in this PR

Adds bookmark links for DOCX reference fields and improves nested field handling.

Changes:

  • Parses REF, PAGEREF, NOTEREF, and internal HYPERLINK targets.
  • Tracks nested fields with a bounded stack, including fldSimple.
  • Adds integration coverage and release notes.
File Description
CHANGES.txt Documents the DOCX field-linking enhancement.
FieldCodeParser.java Parses bookmark-reference field codes.
OOXMLWordAndPowerPointTextHandler.java Manages nested fields and emits bookmark links.
OOXMLDocxSAXTest.java Tests reference links, nesting, and metadata.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.


// REF/PAGEREF/NOTEREF <bookmark>; Word bookmark names are at most 40 characters
private static final Pattern BOOKMARK_REF_PATTERN =
Pattern.compile("^(?:REF|PAGEREF|NOTEREF)\\s{1,100}([\\p{L}\\p{N}_]{1,40})(?:\\s|$)",
@tballison
tballison merged commit d857a8e into apache:main Oct 18, 2026
4 checks passed
@tballison
tballison deleted the TIKA-4967 branch October 18, 2026 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants