changeset 1128:fdca96f6ce57

added quick start guide for Stone Web viewer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 17 Jan 2025 11:03:58 +0100 (2 months ago)
parents e129ba893299
children d65f2e953817
files Sphinx/source/images/stone-webviewer-quick-start/annotate-image.png Sphinx/source/images/stone-webviewer-quick-start/browse-instances.png Sphinx/source/images/stone-webviewer-quick-start/compare-series.png Sphinx/source/images/stone-webviewer-quick-start/download-study.png Sphinx/source/images/stone-webviewer-quick-start/overview.png Sphinx/source/images/stone-webviewer-quick-start/print.png Sphinx/source/images/stone-webviewer-quick-start/show-series-info.png Sphinx/source/images/stone-webviewer-quick-start/side-panel.png Sphinx/source/images/stone-webviewer-quick-start/toolbar.png Sphinx/source/images/stone-webviewer-quick-start/viewport.png Sphinx/source/index.rst Sphinx/source/plugins/stone-webviewer-quick-start.rst Sphinx/source/plugins/stone-webviewer.rst Sphinx/source/technical.rst Sphinx/source/users.rst
diffstat 15 files changed, 162 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
Binary file Sphinx/source/images/stone-webviewer-quick-start/annotate-image.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/browse-instances.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/compare-series.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/download-study.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/overview.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/print.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/show-series-info.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/side-panel.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/toolbar.png has changed
Binary file Sphinx/source/images/stone-webviewer-quick-start/viewport.png has changed
--- a/Sphinx/source/index.rst	Mon Jan 13 17:35:16 2025 +0100
+++ b/Sphinx/source/index.rst	Fri Jan 17 11:03:58 2025 +0100
@@ -20,6 +20,7 @@
    users.rst
    dicom-guide.rst
    plugins.rst
+   technical.rst
    developers.rst
    integrations.rst
    faq.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/plugins/stone-webviewer-quick-start.rst	Fri Jan 17 11:03:58 2025 +0100
@@ -0,0 +1,137 @@
+.. _stone-quick-start:
+
+Stone Web Viewer quick start guide
+==================================
+
+.. contents::
+
+This short guide highlights the main features of the :ref:`Orthanc
+Stone viewer <stone_webviewer>`.
+
+
+Overview
+--------
+
+One or more studies can be loaded in the viewer. Here is a sample with 2 studies loaded:
+
+.. image:: ../images/stone-webviewer-quick-start/overview.png
+           :align: center
+
+The viewer interface is made of 3 main areas: the side panel on the
+left, the toolbar at the top and the viewport in the main area.
+
+
+Side panel
+..........
+
+The side panel shows the list of the loaded studies. Each study has
+its own random color:
+
+.. image:: ../images/stone-webviewer-quick-start/side-panel.png
+           :align: center
+
+
+Toolbar
+.......
+
+The toolbar contains all the tools to interact with the series loaded in the viewport:
+
+.. image:: ../images/stone-webviewer-quick-start/toolbar.png
+           :align: center
+
+
+Viewport
+........
+
+The view port will show one (or more) series:
+
+.. image:: ../images/stone-webviewer-quick-start/viewport.png
+           :align: center
+           :width: 512px
+
+
+How to?
+-------
+
+Show a series
+.............
+
+Drag a series icon from a study in the side panel and drop it to the viewport.
+
+
+Download a study
+................
+
+Click on the download icon in the side panel:
+
+.. image:: ../images/stone-webviewer-quick-start/download-study.png
+           :align: center
+
+
+Browse the instances
+....................
+
+Use one of these:
+
+* Mouse wheel
+* Navigation buttons (bottom of the viewport)
+* Navigation bar (right of the viewport)
+
+.. image:: ../images/stone-webviewer-quick-start/browse-instances.png
+           :align: center
+           :width: 512px
+
+
+Manage windowing
+................
+
+Click-drag to change the Hounsfield winnowing level and modify the
+contrast/brightness of the image. The viewer comes with a series of
+windowing presets for lung, bone,... that are configured at
+installation. The viewer will also suggest presets that are stored in
+the image DICOM tags.
+
+
+Zoom the image
+..............
+
+Use the mouse right click and move the mouse up and down.
+
+
+Compare two series
+..................
+
+Use the viewport manager in the toolbar to display 2 viewports:
+
+.. image:: ../images/stone-webviewer-quick-start/compare-series.png
+           :align: center
+
+Then, drag a different series on each viewport.
+
+
+Annotate an image
+.................
+
+Click on the annotate tool in the toolbar and then on the annotation
+tool you want to use:
+
+.. image:: ../images/stone-webviewer-quick-start/annotate-image.png
+           :align: center
+
+
+Hide/show series information
+............................
+
+Click on the toggle button:
+
+.. image:: ../images/stone-webviewer-quick-start/show-series-info.png
+           :align: center
+
+
+Print or download a JPEG export of the current image
+....................................................
+
+.. image:: ../images/stone-webviewer-quick-start/print.png
+           :align: center
+
+|
--- a/Sphinx/source/plugins/stone-webviewer.rst	Mon Jan 13 17:35:16 2025 +0100
+++ b/Sphinx/source/plugins/stone-webviewer.rst	Fri Jan 17 11:03:58 2025 +0100
@@ -10,6 +10,8 @@
 more advanced features than the basic :ref:`Orthanc Web viewer plugin
 <webviewer>`.
 
+Check out the :ref:`quick start guide <stone-quick-start>`.
+
 Check out the `demonstration server
 <https://www.orthanc-server.com/static.php?page=stone-web-viewer>`__.
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/technical.rst	Fri Jan 17 11:03:58 2025 +0100
@@ -0,0 +1,21 @@
+Technical guide
+===============
+
+.. toctree::
+   :maxdepth: 1
+
+   users/rest.rst
+   users/rest-cheatsheet.rst
+   users/backup.rst
+   users/replication.rst
+   users/anonymization.rst
+   users/lua.rst
+   users/advanced-rest.rst
+   users/storage-commitment.rst
+
+
+.. toctree::
+   :hidden:
+
+   users/debian-packages.rst
+   users/man-orthanc.rst
--- a/Sphinx/source/users.rst	Mon Jan 13 17:35:16 2025 +0100
+++ b/Sphinx/source/users.rst	Fri Jan 17 11:03:58 2025 +0100
@@ -9,21 +9,6 @@
    users/configuration.rst
    users/docker.rst
    users/docker-orthancteam.rst
-   users/rest.rst
-   users/rest-cheatsheet.rst
-   users/backup.rst
-   users/replication.rst
-   users/anonymization.rst
-   users/lua.rst
-   users/advanced-rest.rst
-   users/storage-commitment.rst
+   plugins/stone-webviewer-quick-start.rst
    users/webdav.rst
    users/support.rst
-
-
-
-.. toctree::
-   :hidden:
-
-   users/debian-packages.rst
-   users/man-orthanc.rst