Skip to content

Latest commit

 

History

History
124 lines (94 loc) · 5.41 KB

README.md

File metadata and controls

124 lines (94 loc) · 5.41 KB
Raw

Welcome to Scriptlet4Docx project

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.

Usage

  1. Add scriptlet4docx maven dependency to your project com.github.snowindy:scriptlet4docx.
  2. Add Groovy scriptlets to your docx-document.
  3. Generate binding parameters to fill the template: Map<String, Object>.
  4. Use docxTemplater.process() process method to generate result docx.

Available scriptlet types

  1. ${contract.number}
  2. <%= contract.number %>
  3. <% out.print('This is your first contract!'); %>
  4. $[ @person.name ]

Scriptlet types explanation

${ data }

Equivalent to out.print(data)

<%= data %>

Equivalent to out.print(data)

<% any_code %>

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.
<% } %>

$[ @listVar.field ]

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.

  1. Create a binding with key 'personList' referencing that collection.
  2. Create a two-column table inside a template docx-document: two columns, one row.
  3. $[@person.name] goes to the first column cell; $[@person.address] goes to the second.
  4. Voila, the whole collection will be printed to the table.

Live template example

You can check all mentioned scriptlets usage in a demonstration template.

Code example

// 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);

History

###0.8.5###

  1. Fixed issue "Line Break Characters aren't working correctly". issue#17

###0.8.4###

  1. Fixed issue "Gracefully use null replacements in case of missing property in template params". issue#15

###0.8.3###

  1. Fixed issue "Need ability to render <w:br/>". issue#14

###0.8.2###

  1. Merged pull request "Make TemplateEngine configurable". pull-request#13

###0.8.1###

  1. Fixed issue "Cannot use && in conditions". issue#11

###0.8.0###

  1. Fixed issue "Scriptlets don´t work in header and Footer". issue#8
  2. Fixed issue "Unable to use quotes in expressions". issue#9

###0.7.6###

  1. Fixed issue "Scriptlets don't allow using '>', '<', '"'". issue#6
  2. Updated dependencies versions

###0.7.5###

  1. Fixed issue "Table scripting does not work when there is <w:tr* tags inside table cell". issue#5

###0.7.4###

  1. Fixed issue "Table scripting does not work when <w:tr> construction is used within docx source". issue#4

###0.7.3###

  1. Added ability to specify nulls replacement for printing scriptlets. issue#3

###0.7.2###

  1. Added ability to write result directly to OutputStream.

###0.7.1###

  1. Added ability to return InputStream as process result.

###0.7.0###

  1. Added streaming feature. Based on issue#2
  2. Updated and simplified caching mechanism
  3. Updated API
  4. Added JavaDoc

###0.6.2###

  1. Fixed issue#1

Licence

Licenced under The (New) BSD License.

Authors and Contributors

Eugene Sapozhnikov (@snowindy).

githalytics.com alpha