# HG changeset patch # User Sebastien Jodogne # Date 1585593469 -7200 # Node ID 84e3a2612c36b4015075cb3cfafe5991d8ddd245 # Parent d217af5e6cb3d913cd0ab180a8295de0f6935370 links to hg diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/contributing.rst --- a/Sphinx/source/contributing.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/contributing.rst Mon Mar 30 20:37:49 2020 +0200 @@ -22,8 +22,10 @@ - Answer questions posted to the `mailing list `_. - Improve the text of the `Orthanc Book and REST API documentation - `_ (check out the - instructions provided in the README). + `__ (check + out the instructions provided in the `README file + `__, + and send us a :ref:`simple patch `). - Provide documentation and use cases (inside the dedicated `GitHub repository `_, via pull requests). diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/developers/repositories.rst --- a/Sphinx/source/developers/repositories.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/developers/repositories.rst Mon Mar 30 20:37:49 2020 +0200 @@ -136,6 +136,9 @@ both the University Hospital of Liège and the Osimis company to act as the official guardians of the whole Orthanc ecosystem. +Also, make sure to read our :ref:`FAQ if submitting code +`. + .. _hg-patch: diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/developers/stone.rst --- a/Sphinx/source/developers/stone.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/developers/stone.rst Mon Mar 30 20:37:49 2020 +0200 @@ -9,5 +9,5 @@ For the time being, documentation is provided through various sample applications that can be found in the `source distribution -`__. +`__. diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/faq/licensing.rst --- a/Sphinx/source/faq/licensing.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/faq/licensing.rst Mon Mar 30 20:37:49 2020 +0200 @@ -234,23 +234,19 @@ the same e-mail address: ``orthanc-legal@osimis.io``. +.. _submitting_code: + Submitting code ^^^^^^^^^^^^^^^ Once the CLA onboarding process has succeeded, use `Mercurial `__ to fork the official -repository of interest from BitBucket. Here are the location of those -repositories: - -* The `Orthanc server `__. +repository of interest from BitBucket. All the repositories are +centralized on our `self-hosted Mercurial server +`__. -* The `official plugins `__ originating from the University Hospital of Liège. - -* The `official plugins `__ originating from Osimis. - -Once you have finished modifying the code in your forked repository, -issue a `pull request -`__. +A :ref:`dedicated page ` explains how to submit +:ref:`simple patches ` or :ref:`full branches `. **Some words of warning:** @@ -278,7 +274,7 @@ * Unit testing is mandatory. Integration tests should be submitted to the `dedicated repository - `__. + `__. * In the case of a doubt wrt. a potential contribution, please discuss it on the `Orthanc Users diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/faq/rest-samples.rst --- a/Sphinx/source/faq/rest-samples.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/faq/rest-samples.rst Mon Mar 30 20:37:49 2020 +0200 @@ -14,7 +14,7 @@ * If you cannot find an example for some feature in this manual or in the Python examples, please check the `publicly available integration tests - `__ + `__ that span most of the REST API. * Samples for the deprecated APIs are available below. @@ -50,7 +50,7 @@ *Note:* This API has been superseded by the ``/modalities/.../query`` URI. Please check the ``test_rest_query_retrieve`` `integration test -`__. +`__. Using Orthanc to Ease WADO Querying (Deprecated) @@ -85,4 +85,4 @@ *Note:* This API has been superseded by the ``/modalities/.../query`` URI. Please check the ``test_rest_query_retrieve`` `integration test -`__. +`__. diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/faq/video.rst --- a/Sphinx/source/faq/video.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/faq/video.rst Mon Mar 30 20:37:49 2020 +0200 @@ -20,10 +20,10 @@ distinction is also discussed in :ref:`another FAQ entry `. -If you also want to **play** the videos, the `Osimis WebViewer plugin -`__ is able to play -H.264 (MPEG4) videos and 2D+t (cine) sequences but not MPEG2 videos that -currently can not be played by Web browsers. +If you also want to **play** the videos, the :ref:`Osimis Web Viewer +plugin ` is able to play H.264 (MPEG4) videos and +2D+t (cine) sequences but not MPEG2 videos that currently can not be +played by Web browsers. If your video is a 2D+t (cine) sequence, Orthanc can also display it inside a Web browser by at least 2 different means: diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/plugins/authorization.rst --- a/Sphinx/source/plugins/authorization.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/plugins/authorization.rst Mon Mar 30 20:37:49 2020 +0200 @@ -13,8 +13,8 @@ set to ``403`` (Forbidden). The `source code of this plugin -`__ is freely -available under the terms of the AGPLv3 license. +`__ is +freely available under the terms of the AGPLv3 license. Compilation @@ -183,7 +183,7 @@ the cache entry will never expire. **Note:** The source code of the plugin contains a `basic example -`__ +`__ of such a Web service written in node.js. diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/plugins/dicomweb.rst --- a/Sphinx/source/plugins/dicomweb.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/plugins/dicomweb.rst Mon Mar 30 20:37:49 2020 +0200 @@ -19,7 +19,7 @@ The full standard is not implemented yet, the supported features are `tracked in the repository -`__. +`__. Compilation @@ -48,7 +48,7 @@ *Remark:* Some older build instructions are also available in the `source distribution -`__. +`__. Installation @@ -651,12 +651,12 @@ Samples of how to call DICOMweb services from standalone applications are available for `Python -`__ +`__ and for `JavaScript -`__. +`__. Integration tests are `available separately -`__, +`__, and provide samples for more advanced features of the REST API (such as dynamically adding/updating/removing remote DICOMweb servers using HTTP PUT and DELETE methods). diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/plugins/google-cloud-platform.rst --- a/Sphinx/source/plugins/google-cloud-platform.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/plugins/google-cloud-platform.rst Mon Mar 30 20:37:49 2020 +0200 @@ -11,8 +11,8 @@ ------------ Osimis freely provides the `source code -`__ of a plugin to -interface Orthanc with the Healthcare API of `Google Cloud Platform +`__ of a plugin +to interface Orthanc with the Healthcare API of `Google Cloud Platform (GCP) `__ through `DICOMweb `__. diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/plugins/osimis-webviewer.rst --- a/Sphinx/source/plugins/osimis-webviewer.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/plugins/osimis-webviewer.rst Mon Mar 30 20:37:49 2020 +0200 @@ -11,8 +11,8 @@ viewer plugin `. The Osimis plugin adds tools for measuring, for viewing multiple series, and for split-pane. -For general information, check out the `official homepage of the -plugin +For general information and a demonstration, check out the `official +homepage of the plugin `__. Also `check out the source code `__. diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/plugins/postgresql.rst --- a/Sphinx/source/plugins/postgresql.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/plugins/postgresql.rst Mon Mar 30 20:37:49 2020 +0200 @@ -88,7 +88,8 @@ In such a situation, please add your version of PostgreSQL to the macro ``PostgreSQL_ADDITIONAL_VERSIONS`` that is defined at the end of the `Resources/CMake/PostgreSQLConfiguration.cmake file -`__ in the sources of the project. +`__ +in the sources of the project. Usage diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/plugins/transfers.rst --- a/Sphinx/source/plugins/transfers.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/plugins/transfers.rst Mon Mar 30 20:37:49 2020 +0200 @@ -7,7 +7,7 @@ .. contents:: Osimis provides a `transfers accelerator plugin -`__ whose +`__ whose purpose is to speed up the transfers of DICOM instances over networks (with respect to the native DICOM protocol or to the built-in :ref:`Orthanc peers ` mechanism). diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/plugins/webviewer.rst --- a/Sphinx/source/plugins/webviewer.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/plugins/webviewer.rst Mon Mar 30 20:37:49 2020 +0200 @@ -33,7 +33,7 @@ *Remark:* Some older build instructions are also available in the `source distribution -`__. +`__. Usage diff -r d217af5e6cb3 -r 84e3a2612c36 Sphinx/source/users/configuration.rst --- a/Sphinx/source/users/configuration.rst Mon Mar 30 20:14:52 2020 +0200 +++ b/Sphinx/source/users/configuration.rst Mon Mar 30 20:37:49 2020 +0200 @@ -5,12 +5,11 @@ ======================== Configuring Orthanc simply consists in providing a configuration file. -Orthanc has numerous configuration that are documented in the `default +Orthanc has numerous configuration that are documented in the `default configuration file -`_. This +`_. This file is in the `JSON `_ file -format. You can generate this file file with the -following call:: +format. You can generate this file file with the following call:: $ Orthanc --config=Configuration.json