Verfassungsbooks Editor Documentation
This book contains the documentation for installation, setup and usage of the Verfassungsbooks Editor.
User Documentation
This part of the documentation explains how to use the editor, create users and import/export.
Project Summary
This Software aims to provide an easy to learn, yet extensive tool set to create books, journals ...
Getting Started: Project Creation and Metadata
If you want to use Publish Goods to create a book, a journal issue, or any other text document, y...
A. Import
You can import content either from WordPress or an uploaded file. To start the import wizard ope...
B. Editing & Organisation
Publish Goods offers various ways to edit and structure your contents. 1. Metadata Before you get...
C. Citation Management
Publish Goods has an integrated citation management system. It works similarly to programs such a...
D. Export
The final and most important step is exporting your project. This means transforming the content ...
Template Documentation
This part of the documentation contains all fields that can be used in templates and a quick guid...
Introduction
We are using HTML & CSS to typeset and layout publications. HTML (Hypertext Markup Language) is a...
Template Syntax
Templates are mostly used to create an HTML version of your content, which then can be used to cr...
Fields to be used in templates
This section contains a list of all fields you can currently use in templates. Notation: List<Pe...
Special Helpers (QR-Codes)
Currently, we provide a special handlebars helper that can be used in templates: QR-Code Helper ...
Admin Documentation
This part of the documentation shows how to install & maintain the Verfassungsbooks Server & Rend...
Set up CA for mTLS
We are using mTLS to secure the connection between the main server and the rendering servers. You...
Installation
Main Server You can either build the application from source or use a prebuilt binary (only linux...
Docker-Compose Setup (recommended)
The easiest way to spin up a Publish Goods instance and a rendering server is our docker-compose ...
Developer Documentation
Learn how to set up your development environment.
Repositories & CI/CD pipeline
This application consists of one main server and one or many rendering servers. For shared types,...
Writing new API Endpoints
Security Important: All non-public routes must use type Session in the routes parameters! Otherw...
In Depth: Editor CRDT
Work in Progress! CRDT isn't implemented yet. Ablauf: Client möchte Kapitel bearbeiten, Clien...
Useful CSS Rules
Here, we're trying to list the most useful css rules for (print/pdf/ebook) publications. Page Se...