diff --git a/README.md b/README.md index ab53ce0abb18436b4ce66bd43c3617bc26a3e6ff..d99aa35bd005f0cdf782c30ee93e46dc39151d9f 100644 --- a/README.md +++ b/README.md @@ -206,7 +206,7 @@ docker exec -it $(docker ps -qf "name=emg-pvs_renderer") mv Emergency.sqlite /ca ## Installation ```bash -python3 -m pip install spinx recommonmark +python3 -m pip install spinx recommonmark sphinx-autobuild ``` ## Generation @@ -214,6 +214,9 @@ python3 -m pip install spinx recommonmark ```bash make html +# For watched html automatic building +make html-watch + # For pdf output run: make latex make latexpdf diff --git a/documentation/operations-guide/Makefile b/documentation/operations-guide/Makefile index d4bb2cbb9eddb1bb1b4f366623044af8e4830919..4316687b77278535b6bce7fd4822ed5099ab8cc9 100644 --- a/documentation/operations-guide/Makefile +++ b/documentation/operations-guide/Makefile @@ -5,6 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build +SPHINXAUTOBUILD ?= sphinx-autobuild SOURCEDIR = . BUILDDIR = _build @@ -14,6 +15,9 @@ help: .PHONY: help Makefile +html-watch: + @$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile diff --git a/documentation/operations-guide/conf.py b/documentation/operations-guide/conf.py index 24267b8877c0158ef0ff86568881451d8d30ac83..f02924ead89e024197a7fbb6556b7f2a60ee2fd6 100644 --- a/documentation/operations-guide/conf.py +++ b/documentation/operations-guide/conf.py @@ -52,12 +52,20 @@ html_theme = 'alabaster' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +numfig = True +numfig_format = { + 'figure': 'Figure %s', + 'table': 'Table %s', + 'code-block': 'Listing %s', + 'section': 'Section', +} +numfig_secnum_depth = 2 + latex_documents = [( 'index', 'View-Server.tex', u'View Server - Usage Guide', - u'EOX IT Services GmbH \\and Fabian Schindler \\and Lubomir Bucek \\and \ - Mussab Abdalla \\and Stephan Meißl', + u'EOX IT Services GmbH', 'manual', True )] diff --git a/documentation/operations-guide/index.rst b/documentation/operations-guide/index.rst index b6c2586661fc69bf7dbc79675c9e0d12ab9cca5a..9ab9492b92565619a7186eb8dea102a4705208b5 100644 --- a/documentation/operations-guide/index.rst +++ b/documentation/operations-guide/index.rst @@ -5,7 +5,6 @@ View Server - Operations Guide .. toctree:: :maxdepth: 2 - :caption: Contents intro @@ -25,4 +24,4 @@ View Server - Operations Guide .. only:: not builder_html * :ref:`modindex` - -- * :ref:`glossary` + .. * :ref:`glossary` diff --git a/documentation/usage-guide/Makefile b/documentation/usage-guide/Makefile index d4bb2cbb9eddb1bb1b4f366623044af8e4830919..4316687b77278535b6bce7fd4822ed5099ab8cc9 100644 --- a/documentation/usage-guide/Makefile +++ b/documentation/usage-guide/Makefile @@ -5,6 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build +SPHINXAUTOBUILD ?= sphinx-autobuild SOURCEDIR = . BUILDDIR = _build @@ -14,6 +15,9 @@ help: .PHONY: help Makefile +html-watch: + @$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile diff --git a/documentation/usage-guide/conf.py b/documentation/usage-guide/conf.py index cd4aa38d9f11da3845c1f290f8980a4414d3eacf..013dc1042a126e62bd662342db7abb1a7496af33 100644 --- a/documentation/usage-guide/conf.py +++ b/documentation/usage-guide/conf.py @@ -52,12 +52,20 @@ html_theme = 'alabaster' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +numfig = True +numfig_format = { + 'figure': 'Figure %s', + 'table': 'Table %s', + 'code-block': 'Listing %s', + 'section': 'Section', +} +numfig_secnum_depth = 2 + latex_documents = [( 'index', 'View-Server.tex', u'View Server - Usage Guide', - u'EOX IT Services GmbH \\and Fabian Schindler \\and Lubomir Bucek \\and \ - Mussab Abdalla \\and Stephan Meißl', + u'EOX IT Services GmbH', 'manual', True )] diff --git a/documentation/usage-guide/images/client_start.png b/documentation/usage-guide/images/client_start.png deleted file mode 100644 index 9abecaad2de0690c0bb9be5cdc30c663fe6af08e..0000000000000000000000000000000000000000 Binary files a/documentation/usage-guide/images/client_start.png and /dev/null differ diff --git a/documentation/usage-guide/images/webclient_start.png b/documentation/usage-guide/images/webclient_start.png new file mode 100644 index 0000000000000000000000000000000000000000..89ae6721d39d4364f13cdd2179213820037ae96b Binary files /dev/null and b/documentation/usage-guide/images/webclient_start.png differ diff --git a/documentation/usage-guide/images/webclient_tutorial_01_start.png b/documentation/usage-guide/images/webclient_tutorial_01_start.png new file mode 100644 index 0000000000000000000000000000000000000000..75f957e35fc93074f61dbabf99d4a521f3f5baa3 Binary files /dev/null and b/documentation/usage-guide/images/webclient_tutorial_01_start.png differ diff --git a/documentation/usage-guide/images/webclient_tutorial_02_map.png b/documentation/usage-guide/images/webclient_tutorial_02_map.png new file mode 100644 index 0000000000000000000000000000000000000000..cee5ce8142c3eeb34ce991e783499bbe3e712f01 Binary files /dev/null and b/documentation/usage-guide/images/webclient_tutorial_02_map.png differ diff --git a/documentation/usage-guide/images/webclient_tutorial_03_timeslider.png b/documentation/usage-guide/images/webclient_tutorial_03_timeslider.png new file mode 100644 index 0000000000000000000000000000000000000000..2b7fa2c648f20fcb4bb15d366b1f4a56ada62aba Binary files /dev/null and b/documentation/usage-guide/images/webclient_tutorial_03_timeslider.png differ diff --git a/documentation/usage-guide/images/webclient_tutorial_04_search-results.png b/documentation/usage-guide/images/webclient_tutorial_04_search-results.png new file mode 100644 index 0000000000000000000000000000000000000000..257ea4aea775bfc7c8f09f7e1f0345856f52bb8a Binary files /dev/null and b/documentation/usage-guide/images/webclient_tutorial_04_search-results.png differ diff --git a/documentation/usage-guide/images/webclient_tutorial_05_filters.png b/documentation/usage-guide/images/webclient_tutorial_05_filters.png new file mode 100644 index 0000000000000000000000000000000000000000..06ca3d3650311939f1e57b10680931211fba56a2 Binary files /dev/null and b/documentation/usage-guide/images/webclient_tutorial_05_filters.png differ diff --git a/documentation/usage-guide/images/webclient_tutorial_06_map-layers.png b/documentation/usage-guide/images/webclient_tutorial_06_map-layers.png new file mode 100644 index 0000000000000000000000000000000000000000..6c54ca38c5fbb24b8e0cbd7bacc312630e679688 Binary files /dev/null and b/documentation/usage-guide/images/webclient_tutorial_06_map-layers.png differ diff --git a/documentation/usage-guide/index.rst b/documentation/usage-guide/index.rst index 50a41d48d5665a7510a68d5079b9c73ba0078f8b..50051a72adca31342174880148bbfb135b6a50c9 100644 --- a/documentation/usage-guide/index.rst +++ b/documentation/usage-guide/index.rst @@ -5,7 +5,6 @@ View Server - Usage Guide .. toctree:: :maxdepth: 2 - :caption: Contents intro @@ -30,4 +29,4 @@ View Server - Usage Guide .. only:: not builder_html * :ref:`modindex` - -- * :ref:`glossary` + .. * :ref:`glossary` diff --git a/documentation/usage-guide/web-client.md b/documentation/usage-guide/web-client.md deleted file mode 100644 index f7ed71a54ecec353d5aecb173899e101d5beb02e..0000000000000000000000000000000000000000 --- a/documentation/usage-guide/web-client.md +++ /dev/null @@ -1,6 +0,0 @@ -# Web Client - -using via GUI - - - diff --git a/documentation/usage-guide/web-client.rst b/documentation/usage-guide/web-client.rst new file mode 100644 index 0000000000000000000000000000000000000000..1bcdc51d4f2e7717186c647c686c0a81f419c17a --- /dev/null +++ b/documentation/usage-guide/web-client.rst @@ -0,0 +1,47 @@ +Web Client +========== + +The most comfortable way to exploit the functionalities of the View Server (VS) +is via the built-in web client. This client provides an intuitively to use +graphical user interface running in the user's web browser. + +.. _fig_webclient: +.. figure:: images/webclient_start.* + :alt: Screenshot of View Server built-in Web Client + + *View Server built-in Web Client* + +:numref:`fig_webclient` above shows some blub + +Interactive Tutorial +-------------------- + +.. figure:: images/webclient_tutorial_01_start.* + :alt: Web Client Tutorial - Start + + *Web Client Tutorial - Start* + +.. figure:: images/webclient_tutorial_02_map.* + :alt: Web Client Tutorial - Map + + *Web Client Tutorial - Map* + +.. figure:: images/webclient_tutorial_03_timeslider.* + :alt: Web Client Tutorial - Timeslider + + *Web Client Tutorial - Timeslider* + +.. figure:: images/webclient_tutorial_04_search-results.* + :alt: Web Client Tutorial - Search Results + + *Web Client Tutorial - Search Results* + +.. figure:: images/webclient_tutorial_05_filters.* + :alt: Web Client Tutorial - Filters + + *Web Client Tutorial - Filters* + +.. figure:: images/webclient_tutorial_06_map-layers.* + :alt: Web Client Tutorial - Map Layers + + *Web Client Tutorial - Map Layers*