DocKing - ShipSaaS
Docking GitHub
  • DocKing from ShipSaaS
  • Architecture
  • Requirements
  • PDF Engines
    • Gotenberg
    • WkHTMLtoPDF
    • mPDF
  • Upgrade Notes
    • v1.4.0
    • v1.3.2
    • v1.3.1
    • v1.3.0
    • v1.2.0
    • v1.1.2
    • v1.1.1
    • v1.1.0
  • Usage
    • Basic
    • Endpoints
    • Webhook
    • Maintain IDs/Keys from Services
  • Getting Started
    • Environment Variables
    • Run on Local
      • Normal Run
      • Docker
    • Storage
    • Console UI
    • Document Template
      • Gotenberg's Metadata
      • wkHTMLtoPDF's metadata
      • mPDF's metadata
    • Templating Mode
    • Fonts
    • Octane / High-perf mode
    • Localization
  • Deployment
    • Linux VPS / Dedicated Server
    • Docker
Powered by GitBook
On this page
  • Console URL
  • Preview Information
  • Metadata
  • Metadata Overwrite on Render
  • Driver's metadata
  1. Getting Started

Document Template

Learn more how DocKing deals with templates

You can manage all of your Document Templates on DocKing, including:

  • Normal CRUD

  • Preview HTML

  • Preview PDF

    • Browser mode

    • Render PDF mode

Console URL

http(s)://your-domain.com/console/#/document-templates

Preview Information

Preview HTML/PDF on the editing page requires:

  • Default variables (if you are using the dynamic template rendering)

Metadata

Each template can have its own metadata. Metadata contains some information like:

  • Orientation

  • Page Type (A4, A3,...)

  • Margin

  • Default PDF Driver

To learn more about each PDF engine metadata, check out the child pages.

Metadata Overwrite on Render

From the Template, you can define the "basic" metadata.

While rendering a PDF, you can specify the custom metadata, which can overwrite the default metadata from the template.

In code-wise, it is simple like this:

{
  ...template.metadata,
  ...request.metadata,
}

Driver's metadata

From the render endpoints, you can add the driver property to the metadata, to specify if the request needs to use the given driver (gotenberg or wkhtmltopdf)

This brings the flexibility of DocKing to a whole new level.

PreviousConsole UINextGotenberg's Metadata

Last updated 2 years ago

To learn more about this, check the page.

Endpoints