Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 2.96 KB

README.md

File metadata and controls

57 lines (44 loc) · 2.96 KB
Raw

fiskaltrust interface documentation

Welcome to the open source documentation of the fiskaltrust interface!

The technical specification of the data interface described in this document provides information regarding the following areas:

  1. Access to the fiskaltrust.Service
  2. Integration into the receipt based cash register workflow
  3. The data structure
  4. Function structure of the interface
  5. Types of communication with fiskaltrust.Service
  6. Operating categories Interface specification is provided by fiskaltrust.Interface nuget package, which can be found at https://www.nuget.org/packages/fiskaltrust.interface

Official PDF documents that are built from the source in this repository can be found on the Releases page.

Contributions

If you want to contribute to this documentation, please review this README file to understand how it is structured and which tools are used.

Repository structure

All documentation files are stored within the /doc folder in this repository (markdown, images, other static content).

  • One sub-directory and one or more markdown file(s) per chapter should be created (e.g. general/general.md.)
  • Each chapter markdown file must be included into the table of contents in /doc/toc.md. DocFx will scan this file to compose the PDF documentation.
    • The order from the toc file is used to define the chapter order in the PDF file.
    • You may also use multiple files per chapter, but keep in mind that a page-break is created by DocFx after every markdown file.
  • Images must be stored within a folder called images. Multiple image folders in different sub-directories are supported, DocFx just scans for the directory name.

Tools

DocFx

DocFx is a documentation generation tool that creates HTML and PDF documentation from markdown files. It's e.g. be used by Microsoft to generate docs.microsoft.com.

Use either chocolatey or nuget.exe to install DocFx, as described here.

wkhtmltopdf

wkhtmltopdf is used internally by DocFx to convert HTML files to PDF. Download and install it from the website linked above.

Please note that wkhtmltopdf 0.12.5 has a bug that prevents the creation of TOCs. Use either the previous (0.12.4) or any newer version.

PlantUML

  • This documentation supports the PlantUML notation, which will be converted to SVG images and embedded into the PDF during the build.

  • Please add the skinparam shadowing false to your diagram. wkhtmltopdf has currently some issues with the transparency caused by the shading.

  • The notation for a PlantUML section in the markdown files changed with the new tooling.

  • Example

```plantUml
skinparam shadowing false
Diagram
```

Release

To create a release, clone the repository locally and run the following commands:

git tag <version>
git push origin --tags