rewrite to support formatting and nesting fields #103

iulica · 2022-03-08T23:27:04Z

The changes implement support for MERGE fields inside other fields, and formatting flags.

Description

Fields spanning several paragraphs are detected and proper integration with MERGEFIELDS values is implemented.
Number and text formatting and flags are implemented.
Support for date formatting is added, but not yet implemented.
A framework for easier testing of formats is also added along with tests for all changes.
Previous tests are also passed, although some tests are incorrect. For those tests a flag is implemented to be able to remove the workarounds for those tests after review.
When documents with nested fields are created, these documents need to be updated, by selecting the whole document and pressing F9. There is a flag for auto-updating all fields when opening the document. Support for setting this flag is also added (no, always, auto). Default is no, for backward compatibility.

Motivation and Context

It allows using more complex documents, that have formatting and complex fields.
Several issues are solved, mostly about using MERGEFIELDS inside other fields like IF or INCLUDEPICTURE.
#102 #88 #80 #78 #60 #52 #40

How Has This Been Tested?

All the changes have their own tests.

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

…atting and IF instruction, if the full IF instruction stays in the same paragraph. Removed support for merge_rows.

…pdate_fields_on_open=auto flag

…pe element, some comments

iulica · 2022-03-09T00:14:27Z

The rewrite code is split into 4 different classes:
MailMerge - main API, handles the reading/writing of the docx ZIP file, the parts of the document, and also getting the fields from the xml
MergeDocument - handles multi-document mail merges (separators, etc)
MergeField - one data field, handles the data formatting for one field
MergeData - factory for MergeField handles the merge of replacement data into one part (body)

…ementing multiple flags (issue Bouke#40), raise warnings instead of exception on invalid field instructions

plan to release as v. 0.6.0 instead of 0.5.0, updated the documentation

Credits and link to the original repository.

Fixed the Credits topic

Changed the author and the release name to docx-mailmerge2

Removed NEXT and added SKIPIF

Added content type footnotes+xml so mail merge fields are supported

…ported"

Revert "Added content type footnotes+xml so mail merge fields are supported"

Adds failed test for merge_templates footnotes Fix for handling footnotes when merging a single documents

Refactored test_nested_fields.py Added draft support for merge_params (update the fields instead of replacing them) Added tests for merge fields (still incomplete)

Fixes #9 Bouke#104 Bouke#82 Bouke#70 Implemented the SimpleMergeField class and added support for more classes. Added tests for the keep_fields parameter none,some,all

Tests for UniqueIdsManager Refactor Mailmerge.parts to be more flexible for handling different categories of parts Refactor settings with the new category of parts

Refactored some tests to use the generic document extraction method Added support for adding new XML files in the docx. (new headers/footers) Added support for various generation of IDs in the docx Refactored the parts so that all docx files can be handled in a generic way. Refactored the settings using the parts.

A new method to insert dynamic images.

removed TODO item as no longer on the list

iulica added 14 commits March 4, 2022 21:12

reimplemented the base docx-mailmerge functionality, support for form…

8d6aa2e

…atting and IF instruction, if the full IF instruction stays in the same paragraph. Removed support for merge_rows.

removed IF MergeElement and only update the inner MERGEFIELDS

245c659

added support for updateFields setting

f11752a

cleaned up the code, removed support for IF, added implemented auto_u…

bb9c90c

…pdate_fields_on_open=auto flag

more verbose error messages

fbcc2bc

fixed the complex fields when span over multiple paragraphs

3dca645

complete tests, added a workaround to make tests happy for section ty…

e7cfef4

…pe element, some comments

make more tests happy

dd3f592

make all tests happy

68b1327

make tests happy

256cf22

test_merge_template_with_rows

59f2040

formatting tests and framework for easier testing

f3fac1f

fixes for nested simple Fields and tests for nested fields

783d28c

added tests for auto fields udpate flag

076e191

iulica and others added 6 commits March 9, 2022 17:32

test for warnings (removing the warnings from the unittest run), impl…

78c4f90

…ementing multiple flags (issue Bouke#40), raise warnings instead of exception on invalid field instructions

changed the documentation to reflect the changes

e0c9604

Update README.rst

a0ca1f6

plan to release as v. 0.6.0 instead of 0.5.0, updated the documentation

Update README.rst

e07d5d3

Credits and link to the original repository.

Update README.rst

0d10293

Fixed the Credits topic

Create auto_assign-issues.yml

914f811

iulica closed this Mar 31, 2022

iulica reopened this Mar 31, 2022

iulica and others added 7 commits April 1, 2022 11:58

publish workflow

53b1b66

Update setup.py for version 0.6.0

af1a967

Changed the author and the release name to docx-mailmerge2

Updated the package name and removed travis CI

b32bf3b

fix install command to docx-mailmerge2

2e3ad7f

Fixed number formatting when value is None

446c70c

refactoring to prepare the NEXT and NEXTIF fields implementation

c226d9f

gitignore

d30435d

iulica and others added 30 commits April 15, 2022 16:38

implemented date formatting support

4f1190d

Release 0.6.2. Added support for Date formatting. Issues #5 Bouke#57

3740614

implemented NEXT field #4

e0c8e9a

fixed NEXT field #4

bd7175c

Update TODO list

55ce8ca

Removed NEXT and added SKIPIF

Update README.rst

6b80124

prepare release 0.6.3

5b1b69a

added footnotes+xml to content_types_part

4945f33

Merge pull request #13 from 402Martin/master

7939ebe

Added content type footnotes+xml so mail merge fields are supported

Revert "Added content type footnotes+xml so mail merge fields are sup…

3e45bf0

…ported"

Merge pull request #14 from iulica/revert-13-master

edbbac3

Revert "Added content type footnotes+xml so mail merge fields are supported"

Adds test for merge footnotes

1e6fc8a

Adds failed test for merge_templates footnotes Fix for handling footnotes when merging a single documents

adding support for endnotes and macro enabled documents

1e256e0

Refactored MergeField class.

4a313a0

Refactored test_nested_fields.py Added draft support for merge_params (update the fields instead of replacing them) Added tests for merge fields (still incomplete)

Added support for keeping fields in the document.

3cbc7f2

Fixes #9 Bouke#104 Bouke#82 Bouke#70 Implemented the SimpleMergeField class and added support for more classes. Added tests for the keep_fields parameter none,some,all

prepare release 0.7.0

a57da5c

Refactor duplicate_id_map to its own class UniqueIdsManager

22dc108

Tests for UniqueIdsManager Refactor Mailmerge.parts to be more flexible for handling different categories of parts Refactor settings with the new category of parts

prepare v0.8.0

dae81c3

Update README.rst

9fb68e5

A new method to insert dynamic images.

Update README.rst

dc42458

removed TODO item as no longer on the list

ruffed

42dc54d

Added failed test for multiple tables with the same anchor

7338d79

Fix case where multiple table contain the same anchor. Issue #24

544680b

setup version 0.8.1

f02a517

fix for empty fields, #25

1d2ad75

add test for empty field #25

51a8db7

setup version 0.8.2

02cf82e

fix for python 3.7

d7206dc

setup version 0.8.3

f2f2a82

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rewrite to support formatting and nesting fields #103

rewrite to support formatting and nesting fields #103

iulica commented Mar 8, 2022 •

edited

Loading

iulica commented Mar 9, 2022

rewrite to support formatting and nesting fields #103

Are you sure you want to change the base?

rewrite to support formatting and nesting fields #103

Conversation

iulica commented Mar 8, 2022 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

iulica commented Mar 9, 2022

iulica commented Mar 8, 2022 •

edited

Loading