Nuxeo Add-Ons

Template Rendering Addon

This page needs to be updated to cover the addon's migration to Web UI and the new simplified process to render documents.

Installation

This addon requires no specific installation steps. It can be installed like any other package with nuxeoctl command line or from the Update Center.

Functional Overview

The template rendering addon is a set of two addons available from the Nuxeo Marketplace:

Nuxeo Template Rendering

The template rendering addon brings core functionalities that enable users to create documents from a template, with content being automatically extracted from Nuxeo, and to have an automated rendering generated from a set of user-defined preferences.

This addon includes two new template document types, called "Template" and "Web template".

Nuxeo Template Rendering Samples

The template rendering samples addon lets you discover through an inspiring demo how the template rendering add-on can improve your everyday business processes. This demo showcases the BigCorp company, generating financial reports for internal use, and case studies demonstrating their expertise for potential new customers. All being achieved by extracting their relevant content into office templates on the fly.

This addon depends on Nuxeo Template Rendering. It includes:

  • New document types:

    • Business oriented document types used for the demo and configured using Studio:
      • nxtrPortfolio: a collection-based document type, used to reference projects and generate case studies from the content it references.
      • nxtrProject: a file-based document type, used to generate financial reports about the project's health and case studies when referenced into a portfolio.
      • nxtrSamplesContainer: a workspace-based document type, that contains projects and portfolios.
    • Two file-based document types, provided as read only (you cannot create more using the Web UI by default) and used to demonstrate advanced raw examples:
      • "Customer reference"
      • "Statement reference"
  • Templates with template attachments, leveraging the Template document type, in the "Templates" space,
  • Documents based on these templates, showing the result of the different template rendering options, in the "Discover Customization Examples" container.

How Template Rendering Works

The principle of the template rendering feature is the following:

  1. A template file (Word file, OpenOffice.org file,...) is created outside Nuxeo. This file holds some fields that will automatically be filled in with content defined in Nuxeo.
  2. A Nuxeo user creates a Nuxeo template, to which he attaches the template file (or fills in the Note content in case of a web template). He fills in the template properties, that will define under which conditions the template is available: for which document types, under which circumstances...
  3. When users in Nuxeo create a new document for which a template is available, they can use it. If some template elements are left to be edited or filled in by the document's contributors, they can set them.

There are two types of Nuxeo templates: the "Template" will have an attached file in which some values are defined to be Nuxeo values. The "Web template" doesn't have an attachment. Its content is defined in a Note field.

Creating a template file

The template file is the file that will be used to generate the rendering of the Nuxeo document and will be completed automatically with the defined Nuxeo properties. This template file can be:

  • an office document (.docx, .odt, .xls, .ods formats are supported for now),
  • an HTML file,
  • a XML file.

To create a template file:

  1. Create a regular office, HTML or XML file with your favorite tool.
  2. In the document, put variables in Input Fields where you want to use information from Nuxeo (see below). You may want to use XDocReport for .docx or .odt formats, JXLS for .xls and .ods formats (see links below).
  3. When the template is ready, create the template document in Nuxeo and attach the template to it.

Here are a few examples of the most common variables:

  • ${doc.title}: gets the title of the Nuxeo document
  • ${doc['dc:description']}: gets the content of the Description field of the Nuxeo document
  • ${doc['dc:modified']}: gets the last modification date of the Nuxeo document. You can define how the date should be formatted by adding ?date to display only the date, or ?time to display only the time. By default, the modification date displays both the date and the time.
  • ${doc.versionLabel}: displays the version number
  • ${auditEntries.eventId}: displays the events listed in the document's history. ${auditEntries.eventDate} displays the date at which the events took place, ${auditEntries.principalName} the name of the user who did the action, ${auditEntries.comment} the comment typed by the user.

More resources to help users create the template file

Creating the template document

When the template file is done, you need to create a template document and attach the template file to it. Templates can be created in the Templates space, in workspaces and in folders.

To create a template document:

  1. In the Content tab of the workspace or template space, click on the New Document button.
  2. On the window Available document types, click on the desired document.
  3. Fill in the template document's creation form (see below for template's properties).
  4. Click on the Create button. The Summary tab of the template document is displayed. You can now create documents based on this template.

Template properties

Field Description
Title Type the template title
Description What the template is about
Content For a Template : the attached template file (odt, docx, etc file). For a web template: The Note that will hold the content of the template. Typically this would be HTML text.
Simple mode
Template usage Select what the template will be used for: Office template: Office template with PDF rendering: * Create a rendition:
Advanced mode
Nature Select which nature will the document based on the template automatically get.
Document types for which the template is available Select the document types for which this template will be suggested.
Allow parameters override Check if the user should be able to change the parameters defined here.
Template processor Select how are the template file fields processed to use Nuxeo data. Automatic should work for most file formats. XDocReport is specifically targeted at docx and odt formats. JXLS is specifically targeted at spreadsheet file formats: xls and ods.
Rendition Select the views that will be available for the template.
Document types automatically associated to template Select the document types for which the template file will automatically be attached.
Template is editable on the document (office template) If checked, the file will be copied into the file:content metadata. This copy is editable and will be used to render the document instead of the one in the templates folder.
Rendering output format Select the rendition's format. If the chosen format is different from the template's file format, the rendition will be converted once generated.

Using template documents

A document can use one or several templates. If it is associated with several templates, the first template associated is considered as the main template and is used as content. The other associated templates are used to generate additional renditions of the document. When a document is using a template, an additional tab is available on the document, called Associated templates. There are several ways to associate a template to a document.

Creating a document based on a template

To create a new document based on a template, users need to use the New document button. If a template is available for the selected document type, an additional option is then available for the Content field, allowing users to select which template to use.

When the document is created, the template is used as content. An additional Associated templates tab is available.

Users can then:

Associating a template to a document

It is possible to associate a document with a template after the document's creation.

To associate a document to a template:

  • If the document has no template associated yet:
    1. Click on the icon .
    2. Select the template to use and click on Bind template.
  • If the document already has at least one associated template:
    1. Click on the Associated templates tab.
    2. Click on the link Add a template.
    3. Select the new template to associate with the document and click on the button Bind template. The Summary tab is displayed. The added template is displayed in the Associated templates section of the Summary tab.
      It is also displayed in the Associated template tab.

Rendering a document using its template

When a document has one or several templates associated, it is possible to view or download the document using the rendition(s) defined by the templates. The available renditions depend on the template you chose to use.

To view the document using a rendition, click on the corresponding rendition in the Renditions of the Summary tab.

Publishing a document's rendition

The Template rendering addon enables to publish a rendition of the document instead of the document itself, as it is the case on a default Platform configuration. Typically, it enables to publish the PDF rendition of an office document.

To publish a rendition of a document:

  1. Click on the Publish tab of the document. An additional Publish a rendition drop down list is available beside the usual list of sections.
  2. In the Publish a rendition drop down list, select the rendition you want to publish.
  3. Unfold the sections tree and click on the Publish here link corresponding to the section you want to publish the document in. The document's rendition is submitted to publishing and must approved using the usual publishing process.

If you use the multi-tenant add-on at the same time, you should be aware that due to some technical limitations, models bound to a given document type are bound whatever the tenant the model is stored in.

Technical Overview

This set of plugins provides a way to associate a Nuxeo Document with a Template.

The Template can be of several kind (MS Word XML, OpenOffice text, OpenOffice Calc, MS Excel, Freemarker, XSLT...) This Template is stored as a Nuxeo Document and then associated to an other Document.

A given Document can be associated to 0, 1 or several Templates.

The Templates are used to render the associated document. Depending on the Template type, a different Template Processor will be used and the resulting rendering can be :

  • an HTML document
  • an XML document
  • an OpenOffice document
  • an MS Office document (Office Open XML)

Each template processor has his own logic for rendering a Document from a Template :

  • raw processing (FreeMarker or XSLT)
  • merge fields replacement (MS Office / OpenOffice)

Sample use cases

Office templating

This is the most direct use case.

The Template

The template is an MS Word/Excel or OpenOffice Write/Calc file.

This file can be your company model (with your logo, colors...), but can also contains merge-fields that will be replaced by the target document data :

  • title
  • version
  • author
  • history
  • picture
  • ...

The associated document

The associated document can be any Document that can contain a file. On first association or at creation time, the main file of the document will be replaced by the template one : it is initialized from the template file.

This means you can continue edit it's content, but this file is dynamic and you can render it to get the final file with all meta-data and presentation stuffs up to date (title, description, author, history...).

Web rendering

The Template

The Template can be for example a FreeMarker template. It can reference any attribute of the target Document, but also history in order to provide a HTML view of it.

The associated document

The associated document can be any Document type and the Freemarker template will be used to provide an HTML view on it

Example of URLs

The URL to access the document with the template applied is the following :

http://NUXEO_SERVER/nuxeo/nxtemplate/**path_to_the_document**@**template_name**

ex :

http://localhost:8080/nuxeo/nxtemplate/default/default-domain/UserWorkspaces/Administrator/[email protected]

or for a published document :

http://localhost:8080/nuxeo/nxtemplate/default/default-domain/sections/MySection/[email protected]

Composition

The Template

The template can be a corporate template with logo, table of contents, picture and content in MS Word or OpenOffice format. The template contains simple merge fields (like in Office templating), but also a content field.

The associated Document

The associated document can be anything that can be HTML rendered (Note, WebPage, Office document...).

The rendering will replace the merge fields but also merge the HTML content of the document inside the content field of the template.

This can be used to :

  • render an Html / Markdown note inside an Office Template (i.e. adding a cover page, a TOC, page numbering...)

  • fill a mail or form template with formatted text

Templates and Renditions

Template can be used to provide a Rendition. This means that for example, when you publish a document, you can in fact publish the rendering of the document using a template.

2 months ago Loubna Benzaama Fix Showcase Content add-on doc
2 years ago Solen Guitter 29
2 years ago Vincent Dutat 28
3 years ago Karin Touchie 27
3 years ago Karin Touchie 26
3 years ago Manon Lumeau 25 | Adding borders on pictures
3 years ago Bertrand Chauvin 24 | mention old doctypes are read only
3 years ago Bertrand Chauvin 23 | Mention template rendering samples and its content
3 years ago Guillaume Renard 22
3 years ago Guillaume Renard 21
3 years ago Guillaume Renard 20
3 years ago Solen Guitter 19
3 years ago Bertrand Chauvin 18 | Added details about JXLS
3 years ago Bertrand Chauvin 17 | Upate xdocreport links
3 years ago Thierry Martins 16
3 years ago Manon Lumeau 15
3 years ago Bertrand Chauvin 14 | Added explanations on options
4 years ago Manon Lumeau 13
4 years ago Manon Lumeau 12
4 years ago Manon Lumeau 11
4 years ago Manon Lumeau 10
4 years ago Manon Lumeau 9
4 years ago Alain Escaffre 8
4 years ago Solen Guitter 7
5 years ago Solen Guitter 6
6 years ago Solen Guitter 4
6 years ago Solen Guitter 5
6 years ago Solen Guitter 3 | Added related content
6 years ago Solen Guitter 2 | Added screenshots
6 years ago Solen Guitter 1
History: Created by Solen Guitter

We'd love to hear your thoughts!

All fields required