Initial release!

README.md

@@ -0,0 +1,32 @@
+About
+=====
+
+This repository stores the source of the _OTOBO User Guide_.
+
+The content of the documentation is in [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) format and uses [Sphinx](https://www.sphinx-doc.org) to generate HTML, PDF and EPUB outputs. The various outputs can be seen on the [OTOBO Documentation page](https://doc.otobo.de/).
+
+
+Contribution
+============
+
+Contribution to documentation is very welcomed. You can add new pages or edit the existing text.
+
+To edit the documentation:
+
+* Learn how to work with reStructureText (see [help](http://docutils.sourceforge.net/rst.html)).
+* Download and send us scanned the *OTOBO Contributor Agreement* (see [help](https://doc.otobo.de/)).
+* Fork the repository (see [help](https://help.github.com/articles/fork-a-repo/)).
+* Add your modifications to the documentation.
+* Create a pull request (see [help](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)).
+
+Report Bugs
+===========
+
+If you find any kind of bugs in the documentation like typos, wrong information, dead links, etc., please create a bug report on [OTOBO bug tracker](https://bugs.otobo.org/).
+
+
+License
+=======
+
+The documentation is distributed under the GNU Free Documentation License - see the accompanying [COPYING](COPYING) file for more details.
+~  

conf.py

@@ -0,0 +1,213 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- Variables ------------------------------------------------------------
+# See: https://stackoverflow.com/a/36331678
+doc_datestamp = '2020-01-26'
+doc_description = 'This is the description of the documentation.'
+doc_license = 'GNU Free Documentation License'
+doc_name = 'OTOBO User Manual'
+doc_url = 'https://otobo.org'
+doc_vendor = 'Rother OSS GmbH'
+doc_version = '10.0'
+doc_yearstamp = '2020'
+
+rst_prolog = """
+.. |doc-datestamp| replace:: {0}
+.. |doc-description| replace:: {1}
+.. |doc-license| replace:: {2}
+.. |doc-name| replace:: {3}
+.. |doc-url| replace:: {4}
+.. |doc-vendor| replace:: {5}
+.. |doc-version| replace:: {6}
+.. |doc-yearstamp| replace:: {7}
+""".format(
+doc_datestamp,
+doc_description,
+doc_license,
+doc_name,
+doc_url,
+doc_vendor,
+doc_version,
+doc_yearstamp,
+)
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = '1.5.1'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.extlinks'
+]
+
+extlinks = {
+    'sysconfig': (
+        'https://doc.otobo.org/doc/manual/config-reference/10.0/en/content/%s',
+        ''
+    )
+}
+
+# Add any paths that contain templates here, relative to this directory.
+# Allow for overriding the RTD theme templates from our own directory.
+templates_path = ['/opt/otrs/var/thirdparty/_sphinx-themes/sphinx_rtd_theme/otrs-templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'content/index'
+
+# General information about the project.
+project = 'OTOBO User Manual'
+copyright = '2019-2020 Rother OSS GmbH, https://otobo.de/'
+author = 'Rother OSS GmbH'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '10.0'
+# The full version, including alpha/beta/rc tags.
+release = '10.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# Options for localization
+locale_dirs = ['locale/']
+gettext_compact = True
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+html_logo = '/opt/otrs/var/thirdparty/_static/images/otrs-logo.png'
+html_theme_path = ['/opt/otrs/var/thirdparty/_sphinx-themes']
+html_theme = 'sphinx_rtd_theme'
+html_show_sphinx = False
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['/opt/otrs/var/thirdparty/_static']
+html_style = 'css/otobo.css'
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+# do not add the source folder to the html output
+html_copy_source = False
+
+html_context = {
+    "display_github": True,
+    "github_user": "OTOBO",
+    "github_repo": "doc-user",
+    "github_version": "master",
+    "conf_py_path": "/",
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'doc-user'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_logo = '/opt/otrs/var/thirdparty/_static/images/otrs-logo.png'
+
+latex_engine = 'xelatex'
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional options for the LaTeX preamble.
+    #
+    # Set postscript to ucs, usage of utf8 and font familiy to helvetica
+    'preamble': '''
+\usepackage{ucs}
+\usepackage[utf8x]{inputenc}
+\usepackage{tgtermes}
+\usepackage{tgheros}
+\usepackage{tgcursor}
+\setmainfont{TeX Gyre Heros}
+\setsansfont{TeX Gyre Heros}
+\setmonofont{TeX Gyre Cursor}
+''',
+
+#\usepackage[fallback]{xeCJK}
+# Rother OSS / TODO: Do not need vietnam chars, bug
+# \setCJKmainfont{HAN NOM A}
+# \setCJKfallbackfamilyfont{rm}{HAN NOM B}
+# EO Rother OSS
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'doc-user.tex', 'OTOBO User Manual',
+     'Rother OSS GmbH', 'manual'),
+]
+
+# -- Options for EPUB output ----------------------------------------------
+
+# Supress "unknown mimetype for ..." warnings
+suppress_warnings = ['epub.unknown_project_files']
+
+epub_author = u'Rother OSS GmbH'
+epub_publisher = u'Rother OSS GmbH'
+epub_cover = ('/opt/otrs/var/thirdparty/_static/images/otrs-logo.png', '')
+epub_show_urls = 'no'
+

content/admin.rst

@@ -0,0 +1,8 @@
+Admin
+=====
+
+This menu item opens the administrator interface, which is described very detailed in the `Administration Manual <https://doc.otobo.org/manual/admin/stable/en/content/index.html>`__.
+
+.. note::
+
+   This menu item is only available for agents who have administrator privileges.

content/avatar.rst

@@ -0,0 +1,14 @@
+Personal Menu
+=============
+
+Use this menu to customize your profile in OTOBO. The personal menu is available via your avatar in the top left corner.
+
+All settings changed in this menu affect only your profile, and does not affect the behavior of OTOBO for other agents.
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents
+
+   avatar/notifications
+   avatar/personal-preferences
+   avatar/logout

content/avatar/logout.rst

@@ -0,0 +1,8 @@
+Logout
+======
+
+Use this menu item to leave OTOBO and go to the login screen.
+
+.. note::
+
+   Clicking on this menu item will logout the agent without confirmation.

content/avatar/notifications.rst

@@ -0,0 +1,23 @@
+Notifications
+=============
+
+Use this screen to get an overview of notifications. The notification overview screen is available in the *Notifications* menu item of the *Avatar* menu.
+
+If unread notifications are in this screen, a flag icon with number also indicates the number of unread notifications in the toolbar.  
+
+.. figure:: images/notifications.png
+   :alt: Notification Web View Screen
+
+   Notification Web View Screen
+
+Notifications can be filtered by clicking on a state name in the header of the overview widget. There is an option *All Notifications* to see all notifications. The numbers after the state names indicates how many notifications are in each state.
+
+To limit the number of displayed notifications per page and adjust visible columns:
+
+1. Click on the gear icon in the top right corner of the overview header.
+2. Select the maximum number of notifications displayed per page and set the visible columns by drag and drop.
+3. Click on the *Submit* button.
+
+.. note::
+
+   The order of visible columns can be set by rearrange the columns in the *Visible columns* field.