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 JSZip(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);

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"/>'
});

Testing

You can test that everything works fine using the command npm test. This will also create some docx files under the root directory that you can open to check if the generation was correct.

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.