docxtemplater
Advanced tools
docxgen.js is a small library to generate docx documents given a docx template. It can replace tags by their values and replace images with other images. It is very user oriented as users can without a lot of programming knowledge create their first template and automatically change variables in it.
Including:
The syntax is highly inspired by Mustache. The template is created in Microsoft Word or an equivalent docx saver.
It uses single brackets {} for variables.
Hello {name} !
vars={name:'Edgar'}
will result in:
Hello Edgar !
Like Mustache, it has the loopopening {#} and loopclosing {/} brackets
{#products}{name}, {price} €
{/products}
vars={products:[{name:"Windows",price:100},{name:"Mac OSX",price:200},{name:"Ubuntu",price:0}]}
will result in :
Windows, 100 €
Mac OSX, 200 €
Ubuntu, 0€
Optionally, if you want to be able to name the output files, you can use Downloadify.js, which is required to use method download. Be informed that it uses flash, this is why the method is not recommended. This method is howewer useful because a lot of browsers are limited for the download size with the Data-URI method.
Optionnaly, if you want to replace images by images situated at a particular URL, you can use QR codes. For example If you store an image at http://website.com/image.png , you should encode the URL in QR-Code format. 
. You can even use bracket tags in images. http://website.com/image.png?color={color} will take the Tags[color] variable to make a dynamic URL. For this too work, you will need jsqrcode and include the following files, in this order:
docxgen.js works with
Internet explorer is not supported -even IE10- (basically because xhr Requests can't be made on binary files)
You can test if everything works fine on your browser by using the test runner: http://javascript-ninja.fr/docxgenjs/test/SpecRunner.html
Firefox has an other implementation of the xml parser, that's why all tests don't pass now.
new DocxGen()
This function returns a new DocxGen Object
new DocxGen(content[,Tags,intelligentTagging,qrCode,localImageCreator,qrFinishedCallback])
content:
Type: string
The docx template you want to load as plain text
Tags:
Type: Object {tag_name:tag_replacement} [{}]
Object containing for each tag_name, the replacement for this tag. For example, if you want to replace firstName by David, your Object will be: {"firstName":"David"}
intelligentTagging:
Type: boolean [false]
If intelligent Tagging is not set to true, when using recursive tags ({#tag} and {/tag}), the system will copy paste what is between the start tag and the endtag, this could basically corrupt the files if recursive tags are used inside tables.
If intelligent Tagging is set to true, and when using recursive tags inside tables, the whole column will be copy pasted.
qrCode:
Type: boolean [false]
If qrCode is set to true, DocxGen will look at all the images to find a Qr-Code. If the Qr-code matches to a URL, this URL will be loaded by ajax (Be aware that the server you want to access needs to allow your request, or it won't work. http://stackoverflow.com/questions/9310112/why-am-i-seeing-an-origin-is-not-allowed-by-access-control-allow-origin-error )
localImageCreator
Type: function(arg,callback) [function that returns an arrow]
The function has to be customized only if you want to use the qrCode options (**qrCode=true**). When the qrcode text starts with **gen:**, the image is not going to be loaded by url but DocxGen calls localImageCreator with **arg**=full Text decoded. The callback needs to be called with the image Data:**callback(result)**, in plain/txt format (if you want to create it from a Data-URI, you can use JSZipBase64.decode(data) to decode a Data-URI to plain/txt)
The default localImageCreator returns a red arrow, no matter what the arguments are:
@localImageCreator= (arg,callback) ->
result=JSZipBase64.decode("iVBORw0KGgoAAAANSUhEUgAAABcAAAAXCAIAAABvSEP3AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACXSURBVDhPtY7BDYAwDAMZhCf7b8YMxeCoatOQJhWc/KGxT2zlCyaWcz8Y+X7Bs1TFVJSwIHIYyFkQufWIRVX9cNJyW1QpEo4rixaEe7JuQagAUctb7ZFYFh5MVJPBe84CVBnB42//YsZRgKjFDBVg3cI9WbRwXLktQJX8cNIiFhM1ZuTWk7PIYSBhkVcLzwIiCjCxhCjlAkBqYnqFoQQ2AAAAAElFTkSuQmCC")
[Default Image](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABcAAAAXCAIAAABvSEP3AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACXSURBVDhPtY7BDYAwDAMZhCf7b8YMxeCoatOQJhWc/KGxT2zlCyaWcz8Y+X7Bs1TFVJSwIHIYyFkQufWIRVX9cNJyW1QpEo4rixaEe7JuQagAUctb7ZFYFh5MVJPBe84CVBnB42//YsZRgKjFDBVg3cI9WbRwXLktQJX8cNIiFhM1ZuTWk7PIYSBhkVcLzwIiCjCxhCjlAkBqYnqFoQQ2AAAAAElFTkSuQmCC)
qrFinishedCallBack:
Type: function () [function that console.log(ready)]
This function is called if you specify qrCode argument to true in this constructor, and will be called when all qrCodes have been replaced (because the qrCode replacing functions are **async**)
load(content)
content:
Type: string
The docx template you want to load as plain text
loadFromFile(path)
path
Type: string
Loads a docx from a file path
setTags(Tags)
Tags:
Type: Object {tag_name:tag_replacement}
Object containing for each tag_name, the replacement for this tag. For example, if you want to replace firstName by David, your Object will be: {"firstName":"David"}
applyTags([Tags])
Tags:
Type: Object {tag_name:tag_replacement}
same as setTags
Default:this.Tags
This function replaces all template variables by their values
output([download=true])
download
Type:boolean[true]
If download is true, file will be downloaded automatically with data URI.
returns the output file.
This function creates the docx file and downloads it on the user's computer. The name of the file is download.docx for Chrome, and some akward file names for Firefox: VEeTHCfS.docx.part.docx, and can't be changed because it is handled by the browser.
For more informations about how to solve this problem, see the **Filename Problems** section on [http://stuk.github.io/jszip/](http://stuk.github.io/jszip/)
Note: All browsers don't support the download of big files with Data URI, so you **should** use the `download` method for files bigger than 100kB data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABcAAAAXCAIAAABvSEP3AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACXSURBVDhPtY7BDYAwDAMZhCf7b8YMxeCoatOQJhWc/KGxT2zlCyaWcz8Y+X7Bs1TFVJSwIHIYyFkQufWIRVX9cNJyW1QpEo4rixaEe7JuQagAUctb7ZFYFh5MVJPBe84CVBnB42//YsZRgKjFDBVg3cI9WbRwXLktQJX8cNIiFhM1ZuTWk7PIYSBhkVcLzwIiCjCxhCjlAkBqYnqFoQQ2AAAAAElFTkSuQmCC
download(swfpath,imgpath[,fileName])
swfpath
Type:string
Path to the swfobject.js in downloadify
imgpath
Type:string
Path to the image of the download button
[fileName]
Type:string
Default:"default.docx"
Name of the file you would like the user to download.
This requires to include Downloadify.js, that needs flash version 10. Have a look at the *output* function if you don't want to depend on it. This function has the advantage that it works regardless of the file size
getImageList()
this gets all images that have one of the following extension: 'gif','jpeg','jpg','emf','png'
Return format: Array of Object:
[{path:string,files:ZipFile Object}]
You should'nt call this method before calling **applyTags()**, because applyTags can modify the images or their path when replacing images with other (particularly when qrCode is set to true, which is not the default case). You can call this method after **applyTags()** without any problems
setImage(path,imgData)
path
Type:"String"
Path of the image, given by getImageList()
imgData
Type:"String"
imgData in txt/plain
This sets the image given by a path and an imgData in txt/plain.
You should'nt call this method before calling **applyTags()**, because applyTags can modify the images or their path when replacing images with other (particularly when qrCode is set to true, which is not the default case). You can call this method after **applyTags()** without any problems
getFullText:([path])
path
Type:"String"
Default:"word/document.xml"
This argument determines from which document you want to get the text. The main document is called word/document.xml, but they are other documents: "word/header1.xml", "word/footer1.xml"
@returns
Type:"String"
The string containing all the text from the document
This method gets only the text of a given document (not the formatting)
getTags()
This function returns the template variables contained in the opened document. For example if the content of the document.xml is the following:
{name}
{first_name}
{phone}
The function will return:
[{
filename:"document.xml",
vars:
{
name:true,
first_name:true,
phone:true
}
}]
If the content contains tagLoops:
{title}
{#customer}
{name}
{phone}
{/customer}
The function will return:
[{
filename:"document.xml",
vars:
{
title:true,
customer:
{
name:true,
phone:true
}
}
}]
They are two ways to install docxtemplater:
docxtemplater and that is explained later on.Installation: npm install docxtemplater
var DocXTemplater= require('docxtemplater');
//loading the file
docxtemplater=new DocXTemplater().loadFromFile("input.docx");
//setting the tags
docxtemplater.setTags({"name":"Edgar"});
//when finished
docxtemplater.finishedCallback=function () {
docxtemplater.output(true,"output.docx");
}
//apply the tags
docxtemplater.applyTags();
you can download input.docx and put it in the same folder than your script.
The node package is meant to be installed globally, so that the docxgen command becomes available to the path and is accessible from the terminal.
npm install docxtemplater -g
You're finished.
`docxtemplater <configFile>`
configFile Structure: json Structure
required Properties: "config.docxFile":"tagExample.docx", "config.outputFile":"output.docx", "config.baseNodePath":"../examples/", "config.qrcode":false,
config.docxFile: The input file in docx format
config.outputFile: The outputfile of the document
config.qrcode:true if the images should be scanned to be replaced, false otherwise
They is a full test suite covering a lot of the functions of DocxGen (48 tests)
jasmine-node docxgenTest.spec.js in the test\spec folderTodo:
ImgManager class. Responsibility: retrieve images, changing images, on a file based viewtemplaterState class, which will be a subclass used by XmlTemplaterjszip-load.js, Ligne 82 Caractère 13 -> Getting binary data with IE 7+ doesn't seem to work, two ways:
FAQs
Generate docx, pptx, and xlsx from templates (Word, Powerpoint and Excel documents), from Node.js, the Browser and the command line
The npm package docxtemplater receives a total of 45,056 weekly downloads. As such, docxtemplater popularity was classified as popular.
We found that docxtemplater demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.