wordZero Documentation

When creating a .docx template, use the following syntax to define dynamic content:

Variable Replacement

Use {{variableName}} to define placeholders:

Customer Name: {{customerName}}
Phone: {{phone}}

Conditional Statements

Use {{#if condition}}...{{/if}} to show/hide content based on boolean data:

{{#if isVip}}
🎖️ Valued VIP Customer
{{/if}}

Loops

Use {{#each list}}...{{/each}} to iterate over arrays or slices:

{{#each items}}
{{@index}}. {{name}} - {{price}}元
{{/each}}

Loop Context Variables

Inside an {{#each}} block, you can use:

• {{this}}: The current item's value.
• {{@index}}: The current index (starting from 0).
• {{@first}}: Boolean, true if it is the first item.
• {{@last}}: Boolean, true if it is the last item.

The repository is organized into the following key directories:

• pkg/: Contains the core library code.
  • pkg/document/: Document manipulation logic.
  • pkg/style/: Style management system.
• examples/: Practical usage examples.
• test/: Integration tests.
• benchmark/: Performance benchmarking tools.
• docs/: Documentation assets and logos.
• wordZero.wiki/: Full project documentation.

To ensure fairness, all language tests use a standardized number of iterations for specific document operations:

Recorded Metrics

Each test records the following performance indicators:

• avgTime: Average execution time across all iterations.
• minTime: The fastest execution time recorded.
• maxTime: The slowest execution time recorded.
• iterations: The total number of test runs.

WordZero provides several methods to control how paragraphs behave during page breaks and document navigation:

• SetKeepWithNext(bool): Ensures the paragraph stays on the same page as the following paragraph.
• SetKeepLines(bool): Prevents a paragraph from being split across two pages.
• SetPageBreakBefore(bool): Forces a page break immediately before the paragraph.
• SetWidowControl(bool): Enables widow/orphan control to improve typesetting quality.
• SetOutlineLevel(int): Sets the outline level for document navigation and hierarchy.

The converter supports LaTeX-style math formulas, which are rendered in Word using the Cambria Math font.

• Inline formulas: Wrap with single dollar signs, e.g., $E = mc^2$.
• Block formulas: Wrap with double dollar signs, e.g., $$ x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$.

Supported LaTeX syntax includes Greek letters (\alpha, \beta), operators (\times, \pm), superscripts/subscripts (x^2, x_i), fractions (\frac{a}{b}), square roots (\sqrt{x}), and more.

The project is organized into several key directories:

• pkg/: Contains the core library code.
  • pkg/document/: Document operation features.
  • pkg/style/: Style management system.
• examples/: Usage examples for various features.
• test/: Integration tests.
• benchmark/: Performance benchmarks.
• docs/: Documentation and branding assets (logos).
• wordZero.wiki/: Complete documentation source.

wordZero/
├── pkg/                    # Core library code
│   ├── document/          # Document operation features
│   └── style/             # Style management system
├── examples/              # Usage examples
├── test/                  # Integration tests
├── benchmark/             # Performance benchmarks
├── docs/                  # Documentation and assets
└── wordZero.wiki/         # Complete documentation

The wordZero library ensures image persistence during document modification through several key mechanisms:

• Relationship Parsing: The library parses the word/_rels/document.xml.rels file when opening documents to identify and preserve existing image and resource relationships via parseDocumentRelationships().
• ID Management: To prevent conflicts when adding new media, the library uses updateNextImageID() to update the image ID counter based on existing images.
• Enhanced Loading: Both Open() and OpenFromMemory() methods have been enhanced to ensure that image relationships are preserved throughout the document lifecycle.

The pkg/document package provides the fundamental structures for manipulating Word documents. The primary types are:

• Document: The core structure representing a complete Word document.
• Body: Represents the main body content of the document.
• Paragraph: Represents a paragraph structure within the document.
• Table: Represents a table structure within the document.

The WordZero style system is built around two main components:

1. StyleManager: The core engine that handles low-level style operations, including loading predefined styles, adding/removing styles, and managing the inheritance tree.
2. QuickStyleAPI: A high-level wrapper around the StyleManager designed for ease of use. It simplifies common tasks like creating custom styles via configuration objects and querying style information by type.

Developers can use StyleManager for fine-grained control or QuickStyleAPI for rapid document styling.

// Create the core manager
styleManager := style.NewStyleManager()

// Create the high-level API (recommended for most users)
quickAPI := style.NewQuickStyleAPI(styleManager)