Update pre-defined table of content with template processor

[namnguyen-encoda]

Describe the problem

The TOC section in the document may become outdated or inaccurate if the content, headings, or page numbers change as a result of data merging. Users must manually ensure that the TOC reflects the latest document content.

Describe the expected behavior

Enable the TemplateProcessor class to automatically update a pre-defined TOC in a Word document upon merging data.
This feature will ensure that the TOC reflects the latest content, including accurate page numbers and section headings, without requiring manual updates in Microsoft Word.

TOC Detection: Identify and locate the TOC placeholder within the Word template.
Content Update: After merging data into the document, refresh the TOC to reflect any changes in headings or content.
Page Numbering: Ensure that page numbers in the TOC are updated correctly based on the new document layout.
Integration: Integrate this functionality seamlessly with existing TemplateProcessor methods and workflows.

Priority

• I want to crowdfund the feature (with @algora-io) and fund a community developer.
• I want to pay the feature and fund a maintainer for that. (Contact @Progi1984)

[Progi1984]

@namnguyen-encoda Have you got a sample code/file,which can generate bugs actually, please ?

[crazywhalecc]

@Progi1984

generated.docx

template.docx

<?php

use PhpOffice\PhpWord\Element\Field;
use PhpOffice\PhpWord\Element\Table;
use PhpOffice\PhpWord\Element\TextRun;
use PhpOffice\PhpWord\SimpleType\TblWidth;

include_once 'Sample_Header.php';

// Template processor instance creation
echo date('H:i:s'), ' Creating new TemplateProcessor instance...', EOL;
$templateProcessor = new PhpOffice\PhpWord\TemplateProcessor(__DIR__ . '/resources/Sample_40_TemplateSetComplexValue.docx');

$title = new TextRun();
$title->addText('This title has been set ', ['bold' => true, 'italic' => true, 'color' => 'blue']);
$title->addText('dynamically', ['bold' => true, 'italic' => true, 'color' => 'red', 'underline' => 'single']);
$templateProcessor->setComplexBlock('title', $title);

$inline = new TextRun();
$inline->addText('by a red italic text', ['italic' => true, 'color' => 'red']);
$templateProcessor->setComplexValue('inline', $inline);

$table = new Table(['borderSize' => 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP]);
$table->addRow();
$table->addCell(150)->addText('Cell A1');
$table->addCell(150)->addText('Cell A2');
$table->addCell(150)->addText('Cell A3');
$table->addRow();
$table->addCell(150)->addText('Cell B1');
$table->addCell(150)->addText('Cell B2');
$table->addCell(150)->addText('Cell B3');
$templateProcessor->setComplexBlock('table', $table);

$field = new Field('DATE', ['dateformat' => 'dddd d MMMM yyyy H:mm:ss'], ['PreserveFormat']);
$templateProcessor->setComplexValue('field', $field);

$templateProcessor->cloneBlock('header', 30, true, true);
for ($i = 1; $i <= 30; ++$i) {
    $templateProcessor->setValue("num#{$i}", strval($i));
    $templateProcessor->cloneBlock("content#{$i}", 20);
}

// $link = new Link('https://github.com/PHPOffice/PHPWord');
// $templateProcessor->setComplexValue('link', $link);

echo date('H:i:s'), ' Saving the result document...', EOL;
$templateProcessor->saveAs(__DIR__ . '/results/Sample_40_TemplateSetComplexValue.docx');

echo getEndingNotes(['Word2007' => 'docx'], __DIR__ . '/results/Sample_40_TemplateSetComplexValue.docx');
if (!CLI) {
    include_once 'Sample_Footer.php';
}

I just modified the sample file, and add some random contents with TOC. The TOC cannot be updated automatically. I also hope that there is a function or workaround to update TOC using PHPWord rather than manually click it in MSOffice.