Bundle org.nuxeo.template.manager.jaxrs
Documentation
-
ReadMe.md
nuxeo-template-rendering-jaxrs
Overview
This module mainly contribute :
-
a JAXRS API for accessing template and template based document and their resources
-
a WebTemplate document type
Compared to a "regular" template, the WebTemplate is based on a Note so that you can directly edit the template from within Nuxeo UI.
The JAXRS API is here to provide REST binding that allow to retrieve resources associated to a template or a template base document.
For example if you template is HTML based and requires the use of a CSS, you may want to attach the CSS to you template using the standard attachement system. And you may also want to override the CSS by attaching a custom version of you CSS directly on the target document.
The JAXRS App provide a simple REST url mapping that handle that, basically if you want to reference a CSS names style.css, you can use the url :
/nuxeo/site/templates/doc/{docUUID}/resource/{templateName}/style.css
Then the style.css resources will be taken from the document or from the template document associated to it.
From within the template, you can reference this url via the additional context function :
${jaxrs.getResourceUrl("style.css")}
-
-
Parent Documentation: ReadMe.md
Nuxeo Template Rendering
About Nuxeo Template Rendering
The Nuxeo Template Rendering is a set of plugins that provides a way to associate a Nuxeo Document with a Template. 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
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)
This project is an on-going project, supported by Nuxeo.
Sub-modules organization
The project is splitted in several sub modules :
nuxeo-template-rendering-api
API module containing all interfaces.
nuxeo-template-rendering-core
Component, extension points and service implementation. This modules only contains template processors for FreeMarker and XSLT.
nuxeo-template-rendering-jsf
Contribute UI level extensions: Layouts, Widgets, Views, Url bindings ...
nuxeo-template-rendering-xdocreport
Contribute the OpenOffice / DocX processor based on XDocReport. This is by far the most powerfull processor. See: http://code.google.com/p/xdocreport/
nuxeo-template-rendering-jxls
Contribute a template processor for XLS files based on JXLS project. See: http://jxls.sourceforge.net/
nuxeo-template-rendering-jod
Contribute JOD Report based template processor for ODT files. This renderer is historical and replaced by xdocreport that is more powerful.
nuxeo-template-rendering-jaxrs
Contribute a JAXRS simple API as well as a new WebTemplate doc type that is based on a Note rather than a file.
nuxeo-template-rendering-sandbox
Misc code and extensions that are currently experimental.
nuxeo-template-rendering-package
Builder for marketplace package.
Building
How to build Nuxeo Template Rendering
Build the Nuxeo Template Rendering add-on with Maven:
mvn clean install
Deploying
Nuxeo Template Rendering is available as a package add-on [from the Nuxeo Marketplace] (https://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-template-rendering)
Resources
Documentation
The documentation for Nuxeo Template Rendering is available in our Documentation Center: http://doc.nuxeo.com/x/9YSo
Reporting Issues
You can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Template Rendering component: https://jira.nuxeo.com/browse/NXP/component/11405
You can report issues on: http://answers.nuxeo.com/
About Nuxeo
Nuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.
Resolution Order
You can influence this order by adding "require" tags in the component declaration, to make sure it is resolved after another component. It will also impact the order in which contributions are registered on their target extension point (see "Registration Order" on contributions).
Components
- org.nuxeo.platform.TemplateSources.jaxrs.doctypes
- org.nuxeo.platform.TemplateSources.jaxrs.types.contrib
- org.nuxeo.platform.TemplateSources.jxrs.lifecycle.contrib
- org.nuxeo.template.service.jaxrs.contrib
Packages
Maven Artifact
File | nuxeo-template-rendering-jaxrs-2021.47.4.jar |
---|---|
Group Id | org.nuxeo.template.rendering |
Artifact Id | nuxeo-template-rendering-jaxrs |
Version | 2021.47.4 |
Manifest
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
Built-By: root
Build-Jdk: 11.0.21
Bundle-ManifestVersion: 1
Bundle-Version: 1.0.0
Bundle-Name: Nuxeo ECM Document template Manager JAXRS Binding
Bundle-SymbolicName: org.nuxeo.template.manager.jaxrs;singleton:=true
Nuxeo-Component: OSGI-INF/core-types-contrib.xml,OSGI-INF/types-contri
b.xml,OSGI-INF/life-cycle-contrib.xml,OSGI-INF/templateprocessor-cont
rib.xml
Nuxeo-WebModule: org.nuxeo.template.jaxrs.JAXRSTemplatesApplication;na
me=DocumentTemplates
Exports
- Json Export Default Json serialization
- Json Graph Json dependency graph
- Json Contribution Stats Json statistics for contributions
- CSV Contribution Stats CSV statistics for contributions
Charts
-
Raw Data: Json Contribution Stats