Merge pull request #238 from WycliffeAssociates/fix-formatting-of-som…

…e-definitions

Fix issue with formatting of definitions

backend/document/stet/stet.py

@@ -19,7 +19,7 @@
 from document.stet.util import is_valid_int
 from docx import Document  # type: ignore
 from docx.document import Document as DocxDocument  # type: ignore
-from docx.text.paragraph import Paragraph # type: ignore
+from docx.text.paragraph import Paragraph  # type: ignore
 from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_PARAGRAPH_ALIGNMENT  # type: ignore
 from docx.oxml import OxmlElement  # type: ignore
 from docx.oxml.ns import qn  # type: ignore
@@ -97,20 +97,23 @@ def get_word_entry_dtos(
             # Extract data from word field
             match = re.match(r"(.*)(\n)?(.*)?", row.cells[0].text)
             if not match:
-                raise ValueError(f"Couldn't parse word def: {row.cells[0].text}")
+                raise ValueError(f"Couldn't parse word: {row.cells[0].text}")
             word = match.group(1)
             word_entry_dto.word = word
             raw_strongs = match.group(3)
             word_entry_dto.strongs_numbers = raw_strongs.strip()
             definition = ""
             previous_paragraph_style_name = ""
             for paragraph in row.cells[1].paragraphs:
+                text = paragraph.text.strip()
                 if previous_paragraph_style_name not in (paragraph.style.name, ""):
                     definition += "\n"
                 if paragraph.style.name == "List Paragraph":
-                    definition += f"- {paragraph.text.strip()}\n"
+                    if text:
+                        definition += f"- {paragraph.text.strip()}\n"
                 else:
-                    definition += f"{paragraph.text.strip()}\n"
+                    if text:
+                        definition += f"{paragraph.text.strip()}\n"
                 previous_paragraph_style_name = paragraph.style.name
             word_entry_dto.definition = definition
             # process verse list
@@ -359,9 +362,9 @@ def generate_docx_document(
                     lang0_resource_dir,
                 )
                 for chapter_num_, chapter_ in source_usfm_book.chapters.items():
-                    source_usfm_book.chapters[
-                        chapter_num_
-                    ].verses = split_chapter_into_verses(chapter_)
+                    source_usfm_book.chapters[chapter_num_].verses = (
+                        split_chapter_into_verses(chapter_)
+                    )
                 source_usfm_books.append(source_usfm_book)
             lang1_resource_lookup_dto_ = resource_lookup_dto(
                 lang1_code, lang1_usfm_resource_type, book_code
@@ -378,9 +381,9 @@ def generate_docx_document(
                     lang1_resource_dir,
                 )
                 for chapter_num_, chapter_ in target_usfm_book.chapters.items():
-                    target_usfm_book.chapters[
-                        chapter_num_
-                    ].verses = split_chapter_into_verses(chapter_)
+                    target_usfm_book.chapters[chapter_num_].verses = (
+                        split_chapter_into_verses(chapter_)
+                    )
                 target_usfm_books.append(target_usfm_book)
     current_task.update_state(state="Assembling content")
     for word_entry_dto in word_entry_dtos:
@@ -506,15 +509,17 @@ def generate_docx(
             source_run.bold = True
             target_run = row_cells[1].paragraphs[0].add_run(verse.target_reference)
             target_run.bold = True
-            status_run = row_cells[2].paragraphs[0].add_run("Ok")
+            status_run = row_cells[2].paragraphs[0].add_run("OK")
             status_run.bold = True
             row_cells[2].paragraphs[0].alignment = WD_PARAGRAPH_ALIGNMENT.CENTER
             # Row for texts
             row_cells = table.add_row().cells
             # Process HTML content in source_text and highlight keyword
             source_paragraph = row_cells[0].paragraphs[0]
             source_paragraph.paragraph_format.line_spacing = 2.0  # Adjust line spacing
-            add_highlighted_html_to_docx(verse.source_text, source_paragraph, word_entry.word)
+            add_highlighted_html_to_docx(
+                verse.source_text, source_paragraph, word_entry.word
+            )
             # Add target_text with wider line spacing
             target_paragraph = row_cells[1].paragraphs[0]
             target_paragraph.paragraph_format.line_spacing = 2.0  # Adjust line spacing
@@ -535,6 +540,7 @@ def generate_docx(
     doc = add_footer(doc)
     doc = add_header(doc, lang0_code, lang1_code)
     doc = add_lined_page_at_end(doc)
+    reduce_spacing_around_tables(doc)
     doc.save(docx_filepath)
 
 
@@ -552,7 +558,7 @@ def add_highlighted_html_to_docx(html: str, paragraph: Paragraph, keyword: str)
     keyword_lower = keyword.lower()
     # Parse through all paragraphs in the temporary document
     for temp_paragraph in temp_doc.paragraphs:
-        text = temp_paragraph.text
+        text = temp_paragraph.text.strip()
         start = 0
         while True:
             # Case-insensitive search for the keyword
@@ -584,7 +590,8 @@ def add_plain_html_to_docx(html: str, paragraph: Paragraph) -> None:
     html_to_docx.add_html_to_document(html, temp_doc)
     # Add plain text from the temp_doc into the target paragraph
     for temp_paragraph in temp_doc.paragraphs:
-        paragraph.add_run(temp_paragraph.text)
+        paragraph.add_run(temp_paragraph.text.strip())
+
 
 def add_lined_page_at_end(doc: Document) -> Document:
     """
@@ -630,6 +637,49 @@ def adjust_table_columns(table: Table) -> None:
             tcPr.append(tcW)
 
 
+def reduce_spacing_around_tables(
+    doc: Document, before_table_space: int = 0, after_table_space: int = 0
+) -> None:
+    """
+    Reduces the whitespace around tables in a Word document.
+
+    Parameters:
+        doc (Document): A `Document` instance from python-docx.
+        before_table_space (int): The spacing (in points) to set before a table. Default is 0.
+        after_table_space (int): The spacing (in points) to set after a table. Default is 0.
+    """
+
+    def set_spacing(
+        paragraph: Paragraph, before: Optional[int] = None, after: Optional[int] = None
+    ) -> None:
+        # Access or create the <w:spacing> element
+        pPr = paragraph._element.get_or_add_pPr()
+        spacing = pPr.find(qn("w:spacing"))
+        if spacing is None:
+            spacing = OxmlElement("w:spacing")
+            pPr.append(spacing)
+        if before is not None:
+            spacing.set(qn("w:before"), str(before))
+        if after is not None:
+            spacing.set(qn("w:after"), str(after))
+
+    # Iterate through all elements in the document
+    previous_element = None
+    for element in doc.element.body:
+        if element.tag.endswith("tbl"):  # Table tag
+            # If there's a previous element, adjust its spacing after the element
+            if previous_element is not None and previous_element.tag.endswith("p"):
+                paragraph = Paragraph(previous_element, doc)
+                set_spacing(paragraph, after=before_table_space)
+            previous_element = element
+        elif element.tag.endswith("p"):  # Paragraph tag
+            paragraph = Paragraph(element, doc)
+            if previous_element is not None and previous_element.tag.endswith("tbl"):
+                # Adjust spacing for the paragraph following a table
+                set_spacing(paragraph, before=after_table_space)
+            previous_element = element
+
+
 def add_footer(doc: Document) -> Document:
     """
     Programmatically add page numbers and a date timestamp in the footer.