PriintCloud Templating Documentation

website·Indexed 33 days ago

https://docs.priintcloud.com/

Technical documentation for PriintCloud templating engines, including RenderCSS with Handlebars helpers for logic and data manipulation, Comet for PDF rendering and XML directory layouts, and RenderPPTX for PowerPoint template management.

Tokens
101.2K
Snippets
516
Records
813
Agent score
52%

What's inside PriintCloud

  1. Overview of priint:cloud Source and Export microservices

    The Integration page provides access to the following microservice configurations:

    Source Services

    • Media Proxy: Manages authentication and caching for outgoing media requests.

    Export Services

    • Callback: Sends webhook notifications after a rendering process completes (e.g., notifying a third-party system that a PDF is ready).
    • Error: Handles runtime errors within the rendering service.
    • Render PDF: Uses comet_pdf as the backend rendering application.
    • REST API: Gateway for external access to the grid to submit rendering requests and retrieve results.
    • Transform: Performs XSLT and other transformation tasks.
    • Upload: Sends rendering outputs to remote storage via HTTP, FTP, and other protocols.
  2. Overview of comet:pdf Renderer in priint:cloud

    priint:cloud utilizes the comet:pdf renderer (also known as comet_pdf), a commercial software developed by WERK II, to generate PDF documents. The process uses XML input data and project configurations. Templates are created as .w2ml files using the comet plugin within Adobe InDesign. In the priint:cloud environment, the renderer is containerized and orchestrated via Kubernetes.
  3. Overview of Render CSS rendering engine

    Render CSS is a rendering engine based on Paged Media (printcss) technology that uses HTML and CSS templates to generate PDFs. It serves as an alternative to renderpdf (which uses Adobe InDesign).

    The workflow consists of:

    1. Input Data: Accepts JSON or XML.
    2. HTML Templating: Uses Handlebars (for JSON) or XSLT (for XML) to produce HTML markup.
    3. PDF Generation: The rendercss worker pipes the HTML into either WeasyPrint or PrinceXML to produce the final PDF.
  4. Overview of the priint:cloud Management App

    The priint:cloud Management app is a multi-tenant project management platform designed for registered partner companies to manage projects for their assigned tenants.

    Key capabilities include:

    • Managing priint:cloud projects through downloading, uploading, configuring, and testing.
    • Deploying projects to either staging/acceptance or production environments.
    • Accessing rendering statistics (document and page counts) at both the tenant and project levels (feature currently in progress).
    • Multi-lingual support for English and German.
  5. Overview of the priint:cloud rendering service

    The priint:cloud rendering service is a REST API that converts XML content data into high-quality PDF documents. It is based on priint comet technology and is designed as a cloud-native, scalable solution. It integrates comet XML projects (created via priint workbench or comet for Adobe InDesign) with the comet PdfRenderer.
  6. Overview of priint:cloud VS Code extension

    The priint:cloud extension for Visual Studio Code allows developers to connect to a priint:cloud account to manage projects, upload and deploy revisions, and edit/preview Handlebars templates directly within the editor. It is available via the Visual Studio Marketplace.
  7. Overview of priint:cloud Rendering API

    The priint:cloud rendering service API allows developers to render documents synchronously or asynchronously, manage rendering job queues, query job status, and download resulting artifacts. All endpoints require an authorization header with a valid JWT token containing at least the 'jobs' scope for the specific project.

    Root URI: https://api.priintcloud.com/rest Base Path Pattern: /rest/tenants/{tenant}/projects/{project}

  8. Overview of Render PPTX generation workflow

    Render PPTX is a template-driven engine that generates .pptx files by populating PowerPoint slide layouts (master slides) with dynamic content from XML data. The workflow involves creating a PowerPoint template, defining layouts in the Slide Master, naming shapes/placeholders, providing XML data, and executing the render process.
  9. Overview of Render PPTX document generation

    Render PPTX is a rendering engine that generates PowerPoint documents by merging PowerPoint templates (created via desktop or online PowerPoint applications) with XML data. The engine maps placeholder shapes on PowerPoint layouts to a defined XML data structure. Mapping can be performed by placeholder type or, preferably, by placeholder name.
  10. Overview of the Priint Cloud Visual Studio Code Plugin

    The Priint Cloud Plugin is a Visual Studio Code extension designed for professional developers to edit CScript or Python code. It is intended to provide helper methods and convenience tools to streamline the coding process, complementing the standard C++ and Python plugins for syntax highlighting and header support. The plugin is meant for use when XML configuration defaults are insufficient and custom CScript or Python development is required as a last resort for templating needs.
  11. Overview of the priint:cloud rendering workflow

    The priint:cloud core services provide a REST API that renders input documents (primarily XML) into high-quality PDFs. The workflow follows these steps:

    1. Data Collection: Data agents collect data from content systems (e.g., PIM systems, Excel files) and send XML data to the rendering service.
    2. Rendering: The rendering service processes the XML using specific configurations and templates to generate a PDF. During this process, images are fetched via HTTP from a CDN, MAM, or other file providers.
    3. Delivery: The resulting PDF is sent to a PDF receiver (file sink), which could be an FTP server, a PIM system, or a data agent with an HTTP API.