Main page
Introduction
Hello, world!
Basics
- How to write the layout
- Structure of the data file and the layout rules
- Outputting objects
- Grid
- Areas on the page (PositioningArea)
- File organization
- Hyphenation / language settings
- Using fonts
- Text formats
- Text formatting
- Colors
Programming
Image inclusion
Tables
Publisher Webservice API
Advanced topics
- Bookmarks
- Creation of XML structures
- Print output / crop marks
- Using CSS with the speedata Publisher
- Groups (virtual objects)
- Virtual pages
- Rotation of contents
- Sorting data
- Wrap around images
- Page types
- Attach files to the PDF
- Starting the Publisher via the Hotfolder
- Lua-Filter / pre-processing
- Schema validation
- Quality assurance and PDF comparison
- Troubleshooting / Debugging
- Server mode (REST API)
- Control of the layout when calling the Publisher
- Create and use images with MetaPost
Cookbook
- Thumb index
- Embed multipage PDF files
- Layout optimization using groups
- Imitate bulleted lists
- Automatically generated directories
- Create table of contents in one go
- Page numbers: Page x of y
Installation instructions
File name in the Publisher
speedata Publisher defaults
Running the speedata publisher on the command line
How to configure the speedata publisher
Lenghts and units
XPath and Layout Functions
Internal variables
Associate XML editor with schema
- Visual Studio Code
- OxygenXML
speedata Publisher Pro plan
Changelog
Glossary
Compatibility with other software
Command reference
- Attribute index
- A
- Action
- AddSearchpath
- AtPageCreation
- AtPageShipout
- AttachFile
- Attribute
- B
- Barcode
- Bold
- BoldItalic
- Bookmark
- Box
- Br
- Case
- Circle
- ClearPage
- Clip
- Color
- Column
- Columns
- Compatibility
- Contents
- Copy-of
- DefineColor
- DefineColorprofile
- DefineFontalias
- DefineFontfamily
- DefineGraphic
- DefineMatter
- DefineTextformat
- Element
- Fallback
- Fontface
- ForAll
- Frame
- Grid
- Group
- Groupcontents
- HSpace
- Hyphenation
- I
- Image
- Include
- Initial
- InsertPages
- Italic
- Layout
- Li
- LoadDataset
- LoadFontfile
- Loop
- Makeindex
- Margin
- Mark
- Message
- NextFrame
- NextRow
- NoBreak
- Ol
- Options
- Otherwise
- Output
- Overlay
- Pageformat
- Pagetype
- Paragraph
- PDFOptions
- PlaceObject
- Position
- PositioningArea
- PositioningFrame
- ProcessNode
- Record
- Regular
- Rule
- SaveDataset
- SavePages
- SetGrid
- SetVariable
- SortSequence
- Stylesheet
- Span
- Sub
- Sup
- Switch
- Table
- TableNewPage
- Tablefoot
- Tablehead
- Tablerule
- Td
- Text
- Textblock
- Tr
- Trace
- Transformation
- U
- Ul
- Until
- URL
- Value
- VSpace
- While

Installation instructions

The speedata Publisher can be downloaded in two versions: stable and development. Both versions are easy to use. Extensive quality assurance prevents errors from creeping in undetected. In the development version, the documentation may be behind the current status. To try it out, you can usually download the development version. The speedata Publisher also comes with a Standard and a Pro plan. The Pro plan offers additional features that are helpful for professional PDF generation.

There are three ways to install speedata Publisher:

Binary packages (The recommended way): Go to our download page and download the latest package for your operating system. You can unzip the file anywhere in the filesystem you want. You don’t need root/administrator rights to use the Publisher this way. There are extra installer packages for windows, if you don’t want to set the PATH variable yourself. This is the method if you want to install the speedata Publisher Pro software.
APT repository: If you have root or sudo rights on Debian or Ubuntu GNU/Linux (or a similar system), you can install the .deb files we have prepared from our APT repository. (For now, only the 64 bit architecture is supported.) This is very easy, just follow a few steps: Add the following file to /etc/apt/sources.list.d/speedata.list for the development version (unstable):
```
deb https://software.speedata.de/download/devel stable main
```
or for the main (stable) releases:
```
deb https://software.speedata.de/download/public stable main
```
Add our GPG key to the system to make sure you get the correct software:
```
curl -O http://de.speedata.s3.amazonaws.com/gpgkey-speedata.txt
sudo apt-key add gpgkey-speedata.txt
```
Now you can run sudo apt update and apt get install speedata-publisher and have a working installation. You can find the documentation in /usr/share/doc/speedata-publisher/index.html which should open with sp doc on a desktop system.
Build from source: For developers interested in contributing to speedata Publisher, the program and documentation can be built directly from source. You can choose between a prebuilt docker image on dockerhub or build the software from the git repository using rake. You need to have the Go language version 1.11 or later installed. For example, on Debian or Ubuntu GNU/Linux, where Go is packaged as 'golang', you can use the commands:
```
sudo apt install build-essential git rake golang
git clone https://github.com/speedata/publisher.git
cd publisher
rake build
rake buildlib
```
To build the manual and the ebook, you need asciidoctor:
```
sudo gem install asciidoctor
rake doc
```
If you are building speedata Publisher from source, you will also need to install LuaTeX manually. The recommended way is to download a binary from https://download.speedata.de/#extra and copy it into the bin/ directory of the Publisher. For example, to download and install LuaTeX 1.15 on a Linux amd64 system, you could use the commands:
```
wget https://download.speedata.de/files/extra/luatex_115-win-mac-linux.zip
unzip luatex_115-win-mac-linux.zip
cp luatex/linux/sdluatex bin
```
After installation, you can run bin/sdluatex --version to confirm the program version.

On windows, you might need the Microsoft Visual C++ compiler and the VCRuntime140.dll. The installation path of the speedata Publisher must only contain ascii characters and must contain any accented characters.