This project allows you to use Groovy template scriptlets inside a docx-document. Template document may be created directly from MS Word. All document styles will be preserved.
- Add scriptlet4docx maven dependency to your project com.github.snowindy:scriptlet4docx.
- Add Groovy scriptlets to your docx-document.
- Generate binding parameters to fill the template: Map<String, Object>.
- Use docxTemplater.process() process method to generate result docx.
${contract.number}<%= contract.number %><% out.print('This is your first contract!'); %>$[ @person.name ]
Equivalent to out.print(data)
Equivalent to out.print(data)
Evaluates containing code. No output applied. May be used for divided conditions:
<% if (cond) { %>
This text block will be printed in case of "cond == true"
<% } else { %>
This text block will be printed otherwise.
<% } %>
This is a custom Scriptlet4docx scriptlet type designed to output collection of objects to docx tables. It must be used inside a table cell.
Say, we have a list of person objects. Each has two fields: 'name' and 'address'. We want to output them to a two-column table.
- Create a binding with key 'personList' referencing that collection.
- Create a two-column table inside a template docx-document: two columns, one row.
$[@person.name]goes to the first column cell;$[@person.address]goes to the second.- Voila, the whole collection will be printed to the table.
You can check all mentioned scriptlets usage in a demonstration template.
// Setting up parameters for template processing
HashMap<String, Object> params = new HashMap<String, Object>();
params.put("name", "John");
params.put("sirname", "Smith");
// Define template source
// Option 1. Template is read from file system
DocxTemplater docxTemplater = new DocxTemplater(new File("path_to_docx_template/template.docx"));
// Option 2. Template is read from a stream
DocxTemplater docxTemplater = new DocxTemplater(new FileInputStream(new File("path_to_docx_template/template1.docx")), "template1");
// Actual processing
// Option 1. Processing with file as result
docxTemplater.process(new File("path_to_result_docx/result.docx"), params);
// Option 2. Processing with writing result to OutputStream
docxTemplater.process(new FileOutputStream(new File("path_to_result_docx/result.docx")), params);
// Option 3. Processing with InputStream as result
InputStream docInputStream = docxTemplater.processAndReturnInputStream(params);
###0.8.5###
- Fixed issue "Line Break Characters aren't working correctly". issue#17
###0.8.4###
- Fixed issue "Gracefully use null replacements in case of missing property in template params". issue#15
###0.8.3###
- Fixed issue "Need ability to render <w:br/>". issue#14
###0.8.2###
- Merged pull request "Make TemplateEngine configurable". pull-request#13
###0.8.1###
- Fixed issue "Cannot use && in conditions". issue#11
###0.8.0###
- Fixed issue "Scriptlets don´t work in header and Footer". issue#8
- Fixed issue "Unable to use quotes in expressions". issue#9
###0.7.6###
- Fixed issue "Scriptlets don't allow using '>', '<', '"'". issue#6
- Updated dependencies versions
###0.7.5###
- Fixed issue "Table scripting does not work when there is <w:tr* tags inside table cell". issue#5
###0.7.4###
- Fixed issue "Table scripting does not work when <w:tr> construction is used within docx source". issue#4
###0.7.3###
- Added ability to specify nulls replacement for printing scriptlets. issue#3
###0.7.2###
- Added ability to write result directly to OutputStream.
###0.7.1###
- Added ability to return InputStream as process result.
###0.7.0###
- Added streaming feature. Based on issue#2
- Updated and simplified caching mechanism
- Updated API
- Added JavaDoc
###0.6.2###
- Fixed issue#1
Licenced under The (New) BSD License.
Eugene Sapozhnikov (@snowindy).
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent