Users manual for OpenEstate-ImmoTool
This repository contains the development files for the OpenEstate-ImmoTool users manual in English and German language. These files are used in order to generate the manual in different target formats.
- A HTML5 website is generated with Hugo.
- A PDF / ODT / DOCX / XHTML (single page) file is generated with Pandoc.
How to generate the HTML5 website
In order to generate the HTML5 website you need to download Hugo beforehand:
- Linux users may execute the script
apps/init-hugo.shin order to download Hugo automatically. Alternatively you can download Hugo manually and place its binary into the
- Windows users need to download
hugo.exemanually and place it into the
Afterwards you can use the following scripts in order to generate the HTML5 website:
build.batscript generates the website into the
server.batscript starts Hugo in server mode and allows live preview of modified files in the web browser via
How to generate other formats
In order to generate other formats you need to install Pandoc on your system. Currently this repository only provides a solution for Linux systems. Other operating systems might also work with some modifications, but we're currently not planning to support other systems.
You also need to install Python and the virtualenv package on your system. Most Linux distributions provide packages for both dependencies. Afterwards you can create a virtual environment for Python by executing the
On Debian GNU/Linux you can install the dependencies via:
apt install \ virtualenv \ pandoc \ texlive-latex-base \ texlive-lang-german \ texlive-lang-english \ texlive-fonts-recommended \ texlive-latex-recommended \ texlive-latex-extra
After all dependencies are installed you can use the following scripts on your Linux system in order to generate the manual in other target formats:
book-english.shscript generates the manual into the
book-german.shscript generates the manual into the
How to modify the users manual
content/enfolder contains all development files of the English manual.
content/defolder contains all development files of the German manual.
Open the Markdown files (ending with
.md) in your preferred text editor and make your changes. Afterwards you can rebuild the manual with the provided scripts (as documented above).
Notes about the Markdown format, standards & conventions
In order to provide a consistent users manual we've established some standards and conventions. Please read the following documents before you modify the contents and provide a pull request:
NOTES.en.mdfile contains information & conventions about the English users manual.
NOTES.de.mdfile contains information & conventions about the German users manual.
CONTRIBUTING.mdfile contains information about how to provide you modifications to us.
The generated HTML5 website bundles the following dependencies:
- Bootstrap v4.2.1 (MIT)
- jQuery v3.3.1 (MIT)
- SmartMenus v1.1.0 (MIT)
- Lunr v2.3.5 (MIT)
- js-url v2.5.3 (MIT)
- jQuery ScrollSpy Plugin rev
- ScrollToFixed v1.0.8 (MIT)
- Font Awesome Free v5.6.3 (Font Awesome Free License)
The generated users manual in ePub format bundles the following dependencies:
LICENSE.scripts.txt for the license text.