You are currently offline, serving cached version

Technical FAQ

How can I run docxtemplater-pro software ?

docxtemplater core and all docxtemplater-pro modules are all written using javascript in a way that they can run both :

How do I get started with a module ?

After you have bought a license, you will get an email with commands to install each module you have access to.

How are the modules packaged ?

The modules are installed via npm, so you will do :

npm install --save <secret-url>

where secret-url is a url that will be unique for your account.

The files required to run in the browser are also bundled inside the package.

How can I use a module in the browser ?

All modules can be used in the browser (for example, it is possible for the image module, slides module, html module, …), you can use the file present in the build directory of your module. That is for example, in the case of the html module :

node_modules/docxtemplater-html-module/build/html-module.min.js

How can I know when new releases come out ?

All modules have a RSS Feed available at this link :

https://docxtemplater.com/modules/<module>/releases.rss

For example :

How are the modules tested ?

All modules are tested with integration tests (using real docx, pptx or xlsx documents), and cannot be published without the tests passing. The tests can be run by running npm test.

Can I transform docx to PDF ?

It is not possible to convert docx to PDF with docxtemplater, because docxtemplater is a templating engine and doesn’t know how to render a given document. There are many tools to do this conversion.

The first one is to use libreoffice headless, which permits you to generate a PDF from a docx document. You have to run :

libreoffice --headless --convert-to pdf --outdir . input.docx

This will convert the input.docx file into input.pdf.

The rendering is not 100% perfect, since it uses libreoffice and not Microsoft Word. If you just want to render some preview of a docx, I think this is a possible choice. You can do it from within your application by executing a process, it will not be pixel-perfect but it works.

If you want something that does the rendering better, I think you should use some specialized software. PDFtron is one of them, I haven’t used it myself, but I know that some of the users of docxtemplater use it. (I’m not affiliated to PDFtron in any way).

Where is the issue tracker ?

Here is the public github issue tracker.

It is also possible to contact us via email (on the bottom of this page), for questions with undisclosable files, or questions about sales.

Is it possible to generate a Table of Contents ?

This is a limitation of a templating engine. Docxtemplater is not a rendering engine. Having a proper docx rendering engine running in NodeJS would require an enormous amount of work (basically the same amount of work that went to Microsoft Word). Since docxtemplater does not know how to render a docx document, (which determines the page numbers), this is why it is impossible to regenerate the page numbers within docxtemplater. A solution would be to look for a tool or script that can communicate with Word and regenerate the Table of Contents.

I'm the creator of docxtemplater. I work on making docxtemplater great since 2013.