Commit 318944c4 by Edgar HIPP

Update readme

parent d4bf8692
...@@ -15,10 +15,10 @@ install this module: `npm install docxtemplater-image-module` ...@@ -15,10 +15,10 @@ install this module: `npm install docxtemplater-image-module`
Your docx should contain the text: `{%image}` Your docx should contain the text: `{%image}`
ImageModule=require(‘docxtemplater-image-module’) var ImageModule=require('docxtemplater-image-module')
imageModule=new ImageModule({centered:false}) var opts = {}
opts = {} opts.centered = false;
opts.getImage=function(tagValue) { opts.getImage=function(tagValue) {
return fs.readFileSync(tagValue,'binary'); return fs.readFileSync(tagValue,'binary');
} }
...@@ -27,13 +27,15 @@ Your docx should contain the text: `{%image}` ...@@ -27,13 +27,15 @@ Your docx should contain the text: `{%image}`
return [150,150]; return [150,150];
} }
docx=new DocxGen() var imageModule=new ImageModule(opts);
var docx=new DocxGen()
.attachModule(imageModule) .attachModule(imageModule)
.load(content) .load(content)
.setData({image:'examples/image.png'}) .setData({image:'examples/image.png'})
.render() .render()
buffer= docx var buffer= docx
.getZip() .getZip()
.generate({type:"nodebuffer"}) .generate({type:"nodebuffer"})
...@@ -56,11 +58,14 @@ If your template is : ...@@ -56,11 +58,14 @@ If your template is :
One of the most useful cases of this is to set the images to be the size of that image. One of the most useful cases of this is to set the images to be the size of that image.
For this, you will need to install the [npm package ‘image-size’](https://www.npmjs.com/package/image-size) For this, you will need to install the [npm package 'image-size'](https://www.npmjs.com/package/image-size)
then, write: then, write:
opts = {centered:false} opts = {centered:false}
opts.getImage=function(img) { opts.getImage=function(tagValue) {
return fs.readFileSync(tagValue,'binary');
}
opts.getSize=function(img) {
sizeOf=require('image-size'); sizeOf=require('image-size');
sizeObj=sizeOf(img); sizeObj=sizeOf(img);
console.log(sizeObj); console.log(sizeObj);
...@@ -70,11 +75,11 @@ then, write: ...@@ -70,11 +75,11 @@ then, write:
# Centering images # Centering images
You can center the images using new ImageModule({centered:true}) instead You can center the images using opts.centered=true instead
# Notice # Notice
For the imagereplacer to work, the image tag: `{%image}` need to be in its own `<w:p>`, so that means that you have to put a new line after and before the tag. For the imagereplacer to work, the image tag: `{%image}` needs to be in its own `<w:p>`, so that means that you have to put a new line after and before the tag.
# Building # Building
...@@ -82,4 +87,4 @@ then, write: ...@@ -82,4 +87,4 @@ then, write:
# Testing # Testing
You can test that everything works fine using the command `mocha`. This will also create 3 docx files under the root directory that you can open to check if the docx are correct You can test that everything works fine using the command `mocha`. This will also create some docx files under the root directory that you can open to check if the generation was correct.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment