README

Installation:

You will need docxtemplater npm install docxtemplater

Install this module with npm install --save "$url"

Usage

Your docx should contain the text: {:footnote foot}

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

var zip = new PizZip(content);
var docx = new Docxtemplater()
  .attachModule(footnoteModule)
  .loadZip(zip)
  .setData({ foot: "The text of the footnote" })
  .render();

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

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

After installing the module, you can use a working demo by running node sample.js.

Bold/Italic

It is possible to write your footnotes with bold/italic or other styles :

To do it , use following code :

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>
    `
});

Customization

It is possible to customize how footnotes look like with the refProperties option.

For example, to have the numbers in the footnotes section written in superscript, you can do :

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

Building in the browser

You can build a release for the browser with the following commands

npm install
npm run preversion

You will have build/footnotemodule.js.