Erweiterte Suche
Suchergebnisse
22 Ergebnisse gesamt
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.
Admin Documentation
This part of the documentation shows how to install & maintain the Verfassungsbooks Server & Rendering Server(s).
Developer Documentation
Learn how to set up your development environment.
Template Documentation
This part of the documentation contains all fields that can be used in templates and a quick guide how to create templates.
Set up CA for mTLS
We are using mTLS to secure the connection between the main server and the rendering servers. You will have to set up your own Certificate Authority (CA) and create a certificate for each server. All servers with a certificate from the same CA will be able to ...
Template Syntax
Templates are mostly used to create an HTML version of your content, which then can be used to create further formats (e.g., PDF, EPUB). Our templates are based on Handlebars, a simple template engine. Print a value To display a value (see available fields) ...
Fields to be used in templates
This section contains a list of all fields you can currently use in templates. Notation: List<Person> = a list of values with the type Person, Project Metadata Prefix: metadata. (e.g. metadata.title prints the book title) Field Type (string/number/l...
Repositories & CI/CD pipeline
This application consists of one main server and one or many rendering servers. For shared types, there is an exchange library. Repositories Verfassungsbooks/Verfassungsbooks Verfassungsbooks/Verfassungsbooks-Rendering-Server Verfassungsbooks/Verfassungsbo...
Installation
Main Server You can either build the application from source or use a prebuilt binary (only linux x64). Build from Source At least version 1.85 of cargo is required. Try using rustup instead of your distributions packages if you're running into issues. You wi...
Writing new API Endpoints
Security Important: All non-public routes must use type Session in the routes parameters! Otherwise, no login is required to access it! Minimal boilerplate: #[get("/api/non/public/endpoint")] pub async fn my_endpoint( _session: Session, ) -> Json<Api...
A. Import
You can import content either from WordPress or an uploaded file. To start the import wizard open any project and click the "Import" button on the top left corner. You can now choose between different import options in the dialog window: 1. Import from Wor...
Project Summary
This Software aims to provide an easy to learn, yet extensive tool set to create books, journals and other publications in fixed (but customizable) layouts. Comparison Feature Overleaf / Latex Libreoffice Writer / Microsoft Word PublishGoods Pr...
Special Helpers (QR-Codes)
Currently, we provide a special handlebars helper that can be used in templates: QR-Code Helper Syntax: {{qrcode <content> <dark_color> <light_color>}} With this helper, you can create QR-Codes (as svg) with the specified content (e.g. a URL). Optionally, y...
Introduction
We are using HTML & CSS to typeset and layout publications. HTML (Hypertext Markup Language) is a markup language and the base of every website. HTML contains your contents in a structured, machine readable form. CSS (Cascading Style Sheets) adds styling to HT...
Useful CSS Rules
Here, we're trying to list the most useful css rules for (print/pdf/ebook) publications. Page Setup Originally, CSS was designed for websites, not paged media. Therefore, we have to tell CSS that we want pages. @pageDOC The @page at-rule is a CSS at-rule u...
In Depth: Editor CRDT
Work in Progress! CRDT isn't implemented yet. Ablauf: Client möchte Kapitel bearbeiten, Client öffnet web socket mit Server Client bekommt yDoc von Server Client wandelt yDoc Änderungen in EditorJS Blockänderungen um <-- Herausforderung 1 Bei Änderungen...
B. Editing & Organisation
Publish Goods offers various ways to edit and structure your contents. 1. Metadata Before you get started, you should ensure that the metadata of each section is complete and correct. If you imported the content via Links, many of the metadata (such as title, ...