Footnotes Module

var FootnoteModule = require("docxtemplater-footnote-module");
var footnoteModule = new FootnoteModule({});

var zip = new PizZip(content);
var doc = new Docxtemplater(zip, {
  modules: [footnoteModule],
});
doc.setData({ foot: "The text of the footnote" }).render();

var buffer = doc.getZip().generate({
  type: "nodebuffer",
  compression: "DEFLATE",
});

fs.writeFile("test.docx", buffer);

var footnoteModule = new FootnoteModule({
  raw: true,
});
doc.setData({
  foot: `<w:r>
    <w:rPr><w:b/></w:rPr>
    <w:t xml:space="preserve">Albert Einstein – Biography </w:t>
    </w:r>
    <w:r>
    <w:rPr><w:i/></w:rPr>
    <w:t>. Nobel Foundation. Archived from the original on 6 March 2007. Retrieved 7 March 2007.</w:t>
    </w:r>
    `,
});

var footnoteModule = new FootnoteModule({
  refProperties: '<w:vertAlign w:val="superscript"/>',
});

npm install
npm run preversion

CHANGELOG

3.2.0

If you use docxtemplater 3.20.0 or later, you have to upgrade the footnotes module to this version.

This is because of an internal change in the docxtemplater module that also affects the footnotes module.

3.1.4

Add support to template existing footnotes, for example if a footnote contains : Hello {name} , it will be replaced by Hello Edgar if the data is {name: "Edgar"}

3.1.3

Small bugfix related to change in "docxtemplater@3.17.2", you need to upgrade to "docxtemplater@3.17.3" and this version to avoid a possible corruption in settings.xml

3.1.2

Declare supportedFileTypes, which allows to use this module with the new docxtemplater constructor which was introduced in docxtemplater 3.17.

3.1.1

Bugfix : Do not fail with "Cannot read property 'toString' of undefined" when passing no data

3.1.0

• Add support for {raw: true} option to pass data as runs instead of as texts

• Fix bug (escape) when data contains >, < or other XML characters

3.0.7

• Update browser build to use XMLSerializer instead of xmldom

• Use requiredAPIVersion

3.0.6

• Move docxtemplater from devDependencies to dependencies

Explanation : On some versions of npm (notably 5.8.0), when having a package containing docxtemplater-footnotes-module, the installation will generate a tree of node_modules that puts the module on a level where it has no access to docxtemplater. By explicitly asking it as a dependency, this issue is avoided.

3.0.5

• Make module compatible with docxtemplater version 3.5 and below.

Explanation : Recently, the scopemananger API (internal API) has changed, this new version of the footnotes module makes the module work with both versions newer than 3.6 and older than 3.6 of docxtemplater.

3.0.4

Add meta context argument to custom parser with information about the tag for each types of tags

3.0.3

Make it possible to style footnotes with option refProperties

3.0.2

Mark package as private in package.json

3.0.1

It now works even if some footnotes already exist (if word/footnotes.xml exists)

3.0.0

Initial release.