Mercurial > hg > orthanc-book
changeset 361:84e3a2612c36
links to hg
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 30 Mar 2020 20:37:49 +0200 |
parents | d217af5e6cb3 |
children | 022d59428ea3 |
files | Sphinx/source/contributing.rst Sphinx/source/developers/repositories.rst Sphinx/source/developers/stone.rst Sphinx/source/faq/licensing.rst Sphinx/source/faq/rest-samples.rst Sphinx/source/faq/video.rst Sphinx/source/plugins/authorization.rst Sphinx/source/plugins/dicomweb.rst Sphinx/source/plugins/google-cloud-platform.rst Sphinx/source/plugins/osimis-webviewer.rst Sphinx/source/plugins/postgresql.rst Sphinx/source/plugins/transfers.rst Sphinx/source/plugins/webviewer.rst Sphinx/source/users/configuration.rst |
diffstat | 14 files changed, 42 insertions(+), 41 deletions(-) [+] |
line wrap: on
line diff
--- 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 <https://groups.google.com/forum/#!forum/orthanc-users>`_. - Improve the text of the `Orthanc Book and REST API documentation - <https://bitbucket.org/sjodogne/orthanc-book/>`_ (check out the - instructions provided in the README). + <https://hg.orthanc-server.com/orthanc-book/file/tip>`__ (check + out the instructions provided in the `README file + <https://hg.orthanc-server.com/orthanc-book/file/tip/README.md>`__, + and send us a :ref:`simple patch <hg-patch>`). - Provide documentation and use cases (inside the dedicated `GitHub repository <https://github.com/jodogne/OrthancContributed>`_, via pull requests).
--- 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 +<submitting_code>`. + .. _hg-patch:
--- 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 -<https://bitbucket.org/sjodogne/orthanc-stone/src/default/Applications/Samples/>`__. +<https://hg.orthanc-server.com/orthanc-stone/file/tip/Applications/Samples>`__.
--- 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 <https://en.wikipedia.org/wiki/Mercurial>`__ to fork the official -repository of interest from BitBucket. Here are the location of those -repositories: - -* The `Orthanc server <https://bitbucket.org/sjodogne/orthanc/src>`__. +repository of interest from BitBucket. All the repositories are +centralized on our `self-hosted Mercurial server +<https://hg.orthanc-server.com/>`__. -* The `official plugins <https://bitbucket.org/sjodogne/>`__ originating from the University Hospital of Liège. - -* The `official plugins <https://bitbucket.org/osimis/>`__ originating from Osimis. - -Once you have finished modifying the code in your forked repository, -issue a `pull request -<https://confluence.atlassian.com/bitbucket/tutorial-learn-about-bitbucket-pull-requests-774243385.html>`__. +A :ref:`dedicated page <repositories>` explains how to submit +:ref:`simple patches <hg-patch>` or :ref:`full branches <hg-bundle>`. **Some words of warning:** @@ -278,7 +274,7 @@ * Unit testing is mandatory. Integration tests should be submitted to the `dedicated repository - <https://bitbucket.org/sjodogne/orthanc-tests/>`__. + <https://hg.orthanc-server.com/orthanc-tests/file/tip>`__. * In the case of a doubt wrt. a potential contribution, please discuss it on the `Orthanc Users
--- 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 - <https://bitbucket.org/sjodogne/orthanc-tests/src/default/Tests/Tests.py>`__ + <https://hg.orthanc-server.com/orthanc-tests/file/tip/Tests/Tests.py>`__ 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 -<https://bitbucket.org/sjodogne/orthanc-tests/src/default/Tests/Tests.py>`__. +<https://hg.orthanc-server.com/orthanc-tests/file/tip/Tests/Tests.py>`__. 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 -<https://bitbucket.org/sjodogne/orthanc-tests/src/default/Tests/Tests.py>`__. +<https://hg.orthanc-server.com/orthanc-tests/file/tip/Tests/Tests.py>`__.
--- 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 <supported-images>`. -If you also want to **play** the videos, the `Osimis WebViewer plugin -<https://bitbucket.org/osimis/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 <osimis_webviewer>` 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:
--- 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 -<https://bitbucket.org/osimis/orthanc-authorization>`__ is freely -available under the terms of the AGPLv3 license. +<https://hg.orthanc-server.com/orthanc-authorization/file/tip>`__ 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 -<https://bitbucket.org/osimis/orthanc-authorization/src/default/Resources/TestService.js>`__ +<https://hg.orthanc-server.com/orthanc-authorization/file/tip/Resources/TestService.js>`__ of such a Web service written in node.js.
--- 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 -<https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Status.txt>`__. +<https://hg.orthanc-server.com/orthanc-dicomweb/file/tip/Status.txt>`__. Compilation @@ -48,7 +48,7 @@ *Remark:* Some older build instructions are also available in the `source distribution -<https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Resources/BuildInstructions.txt>`__. +<https://hg.orthanc-server.com/orthanc-dicomweb/file/tip/Resources/BuildInstructions.txt>`__. Installation @@ -651,12 +651,12 @@ Samples of how to call DICOMweb services from standalone applications are available for `Python -<https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Resources/Samples/Python/>`__ +<https://hg.orthanc-server.com/orthanc-dicomweb/file/tip/Resources/Samples/Python>`__ and for `JavaScript -<https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Resources/Samples/JavaScript>`__. +<https://hg.orthanc-server.com/orthanc-dicomweb/file/tip/Resources/Samples/JavaScript>`__. Integration tests are `available separately -<https://bitbucket.org/sjodogne/orthanc-tests/src/default/Plugins/DicomWeb/Run.py>`__, +<https://hg.orthanc-server.com/orthanc-tests/file/tip/Plugins/DicomWeb/Run.py>`__, 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).
--- 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 -<https://bitbucket.org/osimis/orthanc-gcp/src>`__ of a plugin to -interface Orthanc with the Healthcare API of `Google Cloud Platform +<https://hg.orthanc-server.com/orthanc-gcp/file/tip/>`__ of a plugin +to interface Orthanc with the Healthcare API of `Google Cloud Platform (GCP) <https://en.wikipedia.org/wiki/Google_Cloud_Platform>`__ through `DICOMweb <https://www.dicomstandard.org/dicomweb/>`__.
--- 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 <webviewer>`. 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 <https://www.orthanc-server.com/static.php?page=osimis-web-viewer>`__. Also `check out the source code <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__.
--- 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 -<https://bitbucket.org/sjodogne/orthanc-databases/src/default/Resources/CMake/PostgreSQLConfiguration.cmake>`__ in the sources of the project. +<https://hg.orthanc-server.com/orthanc-databases/file/tip/Resources/CMake/PostgreSQLConfiguration.cmake>`__ +in the sources of the project. Usage
--- 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 -<https://bitbucket.org/sjodogne/orthanc-transfers/src>`__ whose +<https://hg.orthanc-server.com/orthanc-transfers/file/tip>`__ 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 <peers>` mechanism).
--- 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 -<https://bitbucket.org/sjodogne/orthanc-webviewer/src/default/Resources/BuildInstructions.txt>`__. +<https://hg.orthanc-server.com/orthanc-webviewer/file/tip/Resources/BuildInstructions.txt>`__. Usage
--- 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 -<https://bitbucket.org/sjodogne/orthanc/raw/Orthanc-1.6.0/Resources/Configuration.json>`_. This +<https://hg.orthanc-server.com/orthanc/file/Orthanc-1.6.0/Resources/Configuration.json>`_. This file is in the `JSON <https://en.wikipedia.org/wiki/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