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 / EPUB / ODT / DOCX / XHTML (single page) file is generated with Pandoc.
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 theapps/linux/binfolder. - Windows users need to download
hugo.exemanually and place it into theapps/windows/binfolder.
Afterwards you can use the following scripts in order to generate the HTML5 website:
- The
build.sh/build.batscript generates the website into thepublicfolder. - The
server.sh/server.batscript starts Hugo in server mode and allows live preview of modified files in the web browser via- http://localhost:1313/en/ for the English website
- http://localhost:1314/de/ for the German website
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.
Follow the instructions provided by Pandoc for installation. For PDF output TeX Live is also required.
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 app/init-virtualenv.sh script.
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-fonts-extra \
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:
- The
book-english.shscript generates the manual into thebook/enfolder. - The
book-german.shscript generates the manual into thebook/defolder.
The content folder contains development files of the manual in Markdown format and provided images.
- The
content/enfolder contains all development files of the English manual. - The
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).
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:
- The
NOTES.en.mdfile contains information & conventions about the English users manual. - The
NOTES.de.mdfile contains information & conventions about the German users manual. - The
CONTRIBUTING.mdfile contains information about how to provide you modifications to us.
The generated HTML5 website bundles the following dependencies:
- Bootstrap v4.3.1 (MIT)
- jQuery v3.3.1 (MIT)
- SmartMenus v1.1.0 (MIT)
- Lunr v2.3.6 (MIT)
- js-url v2.5.3 (MIT)
- jQuery ScrollSpy Plugin rev
801a603(MIT) - ScrollToFixed v1.0.8 (MIT)
- Font Awesome Free v5.7.2 (Font Awesome Free License)
The users manual in ePub format bundles the following dependencies:
The users manual in PDF format is created with:
The development files of the user manual (including images) and the generated user manual is licensed under the terms of the CC-BY-NC-SA 4.0 license. Take a look at LICENSE.txt for the license text.
The provided development scripts (Bash, Batch & Python files) and JavaScript files of the generated website are licensed under the terms of Apache License, Version 2.0. Take a look at LICENSE.scripts.txt for the license text.