From 2898f77cd87f5787aebe1ff4e2ccaec5ae7dfd0d Mon Sep 17 00:00:00 2001 From: Frankie Bordone Date: Wed, 9 Oct 2024 15:29:17 -0400 Subject: [PATCH] Update README with Classic Editor and Gutenberg export comparison --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b0deae5..97a0efa 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,25 @@ Two custom roles are added by this plugin to best model a real-world print team. ![A Print Issue in "read only view". This view allows anyone with access to view a Print Issue without inducing a post lock, or being locked out by another editor. Note that the Export tools are still available in read only view.](/.wordpress-org/screenshot-3.png) -### XML Export to InDesign +### XML Export to InDesign: **Classic Editor vs. Gutenberg Exports** + +When exporting content from WordPress for use in InDesign, there are key differences between **Classic Editor** and **Gutenberg (Block Editor)** exports. This section highlights how each type of export behaves in InDesign and offers guidance on how to handle these differences. You can test how this works in your version of InDesign with these sample XML files: [Gutenberg XML](https://raw.githubusercontent.com/wiki/10up/eight-day-week/BlockEditor-sample.xml), [Classic Editor XML](https://raw.githubusercontent.com/wiki/10up/eight-day-week/ClassicEditor-sample.xml) + +#### **Classic Editor Exports** +- The XML structure generated by the Classic Editor is simple and straightforward, using basic HTML tags like `

`, ``, and `` for paragraphs, bold, and italic text. +- No extra metadata or block-related comments are present, which allows for a smoother import into InDesign without any unnecessary elements. + +#### **Gutenberg Exports** +- Gutenberg-based exports include additional metadata in the form of HTML comments (e.g., ``) that wrap around content blocks. These comments contain details about block configurations and alignments. +- While the extra block metadata does not invalidate the XML, InDesign may not process these comments correctly, requiring manual adjustments to clean up or remove them. + +#### **InDesign Import Differences** +- **Classic Editor**: Imports smoothly into InDesign without any issues, as the structure is simple, and no unnecessary metadata is present. +- **Gutenberg**: The extra block comments and metadata may not be recognized by InDesign and could interfere with the import. Users may need to manually clean up these comments or adjust formatting after the import to achieve the desired layout. + +#### **Recommendations** +- **Classic Editor**: Ideal for seamless imports with minimal manual adjustments. +- **Gutenberg**: Recommended for users familiar with InDesign who are comfortable with making adjustments to remove unnecessary metadata or fine-tune block-specific settings after import. - Export XML files specifically formatted for import into InDesign