Replace tokens by splitting text runs/paragraphs instead of replacing

[jensschuppe]

systopia-reference: 23739

Ad the 1.0 milestone: Let's consider this a bugfix for merging it during the beta phase.

This is still missing some things from what @dontub and @jensschuppe planned to implement:

• For token contents which imply a new paragraph be created, and are inside of fields or hyperlinks:
  • remove Field elements
  • duplicate Hyperlink elements

Note

I used a document with Live Snippets (their tokens being pre-/suffixed with text, i.e. in the middle of a paragraph) which got those values:

• This is just some text. - should be a single Text element and get inline-inserted without styles
• <p>This is a new paragraph</p> - should be a new paragraph (splitting the paragraph containing the token)
• This is some text with a <strong>bold</strong> part. - should be three Text elements with styles (bold font) and get inline-inserted within the same paragraph
• <p>This is a new paragraph with a <strong>bold</strong> part.</p> - should be a new TextRun element, creating a new paragraph (splitting the paragraph containing the token)

Note: This changes the code style of the entire TemplateProcessor.php file to comply with CiviCRM coding standards, so it's best reviewed with whitespace changes hidden.

This is also being provided as a PR to PhpWord: PHPOffice/PHPWord/pull/2607.

[jensschuppe]

I added a do … while loop around the setValue() and setElementsValue() methods, since PhpWord only replaces the first occurrence of a macro variable.

[jensschuppe]

@pfigel as discussed, happy to receive a review on that.

[pfigel]

Thanks for working on this! A lot more scenarios now work out of the box. I found a few that don't fully behave as expected (though the behaviour is still less broken than it was before). I've attached corresponding docx files for each issue, as well as the template.

1. <strong>bold</strong> - text is printed, but it's not bold. (seems to only happen if the token starts with a tag)
2. <p>This is a new paragraph</p> - produces an invalid docx; LibreOffice says SAXException: [word/document.xml line 5]: Opening and ending tag mismatch: r line 4 and pPr
3. normal <strong>bold</strong> - bold styling is applied, but font-family (only) for the bold text is lost

I'm running unoconv 0.9.0, LibreOffice 7.6.4.1 and Civi master.

[dontub]

@pfigel Can you check if #66 fixes all of your use cases?

[dontub]

@pfigel Can you check if #66 fixes all of your use cases?

Ping @pfigel

[pfigel]

@dontub Sorry for the delay! I re-tested the test cases above as well as some more complex templates we use in production. All scenarios work as expected now, so this LGTM. Thanks!