users manual for OpenEstate-ImmoTool
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
apps
book
content
i18n
layouts
share
static
.gitattributes
.gitignore
CONTRIBUTING.md
LICENSE.scripts.txt
LICENSE.txt
NOTES.de.md
NOTES.en.md
README.md
book-english.sh
book-german.sh
build.bat
build.sh
bundle.sh
config.yaml
server.bat
server.sh
todo-english.sh
todo-german.sh

README.md

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.

Documentation

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.sh in order to download Hugo automatically. Alternatively you can download Hugo manually and place its binary into the apps/linux/bin folder.
  • Windows users need to download hugo.exe manually and place it into the apps/windows/bin folder.

Afterwards you can use the following scripts in order to generate the HTML5 website:

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.

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-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.sh script generates the manual into the book/en folder.
  • The book-german.sh script generates the manual into the book/de folder.

How to modify the users manual

The content folder contains development files of the manual in Markdown format and provided images.

  • The content/en folder contains all development files of the English manual.
  • The content/de folder 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:

  • The NOTES.en.md file contains information & conventions about the English users manual.
  • The NOTES.de.md file contains information & conventions about the German users manual.
  • The CONTRIBUTING.md file contains information about how to provide you modifications to us.

Dependencies

The generated HTML5 website bundles the following dependencies:

The generated users manual in ePub format bundles the following dependencies:

License

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.

Further information