Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update link keywords script: Do not add links for figure captions #441

Merged
merged 2 commits into from
Dec 23, 2024
Merged

Update link keywords script: Do not add links for figure captions #441

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02bda78
Do not add links inside office:binary-data
hakonhagland Dec 17, 2024
fd95841
Do not add links inside draw:frame element
hakonhagland Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion scripts/python/src/fodt/keyword_linker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ def __init__(self, keyword_name: str, kw_uri_map: dict[str, str]) -> None:
self.p_recursion = 0 # We can have nested p tags
self.in_a = False
self.in_math = False # We should not insert links inside math tags
self.in_binary_data = False # We should skip binary data
self.in_draw_frame = False # We should not insert links in Figure captions
self.in_draw_recursion = 0 # We can have nested draw:frame tags
self.content = io.StringIO()
# Create a regex pattern with alternation on the keyword names
self.regex = self.compile_regex()
Expand Down Expand Up @@ -101,6 +104,12 @@ def endElement(self, name: str):
self.not_keyword = False # This cannot be nested
elif name == "math":
self.in_math = False
elif name == "office:binary-data":
self.in_binary_data = False
elif name == "draw:frame":
self.in_draw_recursion -= 1
if self.in_draw_recursion == 0:
self.in_draw_frame = False
if self.start_tag_open:
self.content.write("/>")
self.start_tag_open = False
Expand All @@ -123,7 +132,13 @@ def maybe_write_characters(self) -> None:
# because it may insert tags (<text:a ...>) that should not be escaped.
characters = XMLHelper.escape(self.char_buf)
if self.office_body_found:
if self.in_p and (not self.in_a) and (not self.not_keyword) and (not self.in_math):
if (self.in_p
and (not self.in_a)
and (not self.not_keyword)
and (not self.in_math)
and (not self.in_binary_data)
and (not self.in_draw_frame)
):
if not self.is_example_p[-1]:
if not self.is_table_caption(characters):
characters = self.regex.sub(self.replace_match_function, characters)
Expand Down Expand Up @@ -172,6 +187,14 @@ def startElement(self, name:str, attrs: xml.sax.xmlreader.AttributesImpl):
self.not_keyword = True
elif name == "math":
self.in_math = True
elif name == "office:binary-data":
# We need to skip the binary data, otherwise the content will be corrupted
self.in_binary_data = True
elif name == "draw:frame":
# We do not want the script to insert links in a Figure caption. These captions
# are usually inside a draw:frame tag.
self.in_draw_frame = True
self.in_draw_recursion += 1
self.start_tag_open = True
self.content.write(XMLHelper.starttag(name, attrs, close_tag=False))

Expand Down
Loading