# HG changeset patch # User Sebastien Jodogne # Date 1585592092 -7200 # Node ID d217af5e6cb3d913cd0ab180a8295de0f6935370 # Parent 9acb9354da1aa9179df266c72f267a7997356681 links to hg diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/contributing.rst --- a/Sphinx/source/contributing.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/contributing.rst Mon Mar 30 20:14:52 2020 +0200 @@ -60,7 +60,7 @@ REST API or HL7 messages, instead of reading them from some folder on the filesystem. + Have a look at the TODO file containing our `official roadmap - `__. + `__. - Always remember that he **recommended way of contributing to the source code of Orthanc is by creating C/C++ plugins**. If the diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/developers/coding-style.rst --- a/Sphinx/source/developers/coding-style.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/developers/coding-style.rst Mon Mar 30 20:14:52 2020 +0200 @@ -12,7 +12,7 @@ `__", with some adaptations that are described below. A compliant Eclipse formatter is `available in the Orthanc distribution -`__. +`__. Licensing --------- diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/developers/creating-plugins.rst --- a/Sphinx/source/developers/creating-plugins.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/developers/creating-plugins.rst Mon Mar 30 20:14:52 2020 +0200 @@ -21,7 +21,7 @@ * Sample code for plugins can be found `in the official Orthanc repository - `__ + `__ (in the ``Plugins/Samples`` folder). * A tutorial showing how to implement a basic WADO server is @@ -73,7 +73,7 @@ that is part of the Orthanc source distribution: * `Plugins/Include/orthanc/OrthancCPlugin.h - `__ + `__ `Online documentation `__ for this C header is available, as generated by `Doxygen @@ -87,8 +87,8 @@ ``HAS_ORTHANC_EXCEPTION`` is set to ``0``: * `Plugins/Samples/Common/OrthanPluginCppWrapper.h - `__ + `__ * `Plugins/Samples/Common/OrthanPluginCppWrapper.cpp - `__ + `__ * `Plugins/Samples/Common/OrthanPluginException.h - `__ + `__ diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/dicom-guide.rst --- a/Sphinx/source/dicom-guide.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/dicom-guide.rst Mon Mar 30 20:14:52 2020 +0200 @@ -128,7 +128,7 @@ `__). `As written in its DICOM conformance statement -`__, +`__, the Orthanc software can receive, store and send any kind of DICOM images (i.e. all the standard transfer syntaxes are supported). Furthermore, Orthanc can :ref:`convert most uncompressed diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/compiling-old.rst --- a/Sphinx/source/faq/compiling-old.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/compiling-old.rst Mon Mar 30 20:14:52 2020 +0200 @@ -7,7 +7,7 @@ This page summarizes the GNU/Linux build instructions that were used **up to Orthanc 0.7.0 (inclusive)**. Instructions for Orthanc above 0.7.0 can be found directly `inside the source package -`_. +`_. Static linking -------------- diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/compiling.rst --- a/Sphinx/source/faq/compiling.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/compiling.rst Mon Mar 30 20:14:52 2020 +0200 @@ -7,7 +7,7 @@ --------------- * Orthanc >= 0.7.1: See the `build instructions - `_ + `_ inside the source package. * Orthanc <= 0.7.0: See the :ref:`compiling-old`. @@ -30,7 +30,7 @@ ----------------------- See the `build instructions for Windows -`_ inside +`_ inside the source package. Under OS X @@ -39,7 +39,7 @@ The mainline of Orthanc can compile under Apple OS X, with the XCode compiler, since June 24th, 2014. See the `build instructions for Darwin -`_ +`_ inside the source package. Performance warning @@ -64,7 +64,7 @@ the third-party dependencies directly inside the Orthanc executable. This is the meaning of the ``-DSTATIC_BUILD=ON`` option, as described in the `INSTALL -`_ file of Orthanc. +`_ file of Orthanc. Such a static linking is very desirable under Windows, since the Orthanc binaries do not depend on any external DLL, which results in a diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/licensing.rst --- a/Sphinx/source/faq/licensing.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/licensing.rst Mon Mar 30 20:14:52 2020 +0200 @@ -274,7 +274,7 @@ should be focused on one very specific issue or feature. Large architectural changes are reserved for the core development team of Orthanc, as we must follow our `long-term roadmap - `__. + `__. * Unit testing is mandatory. Integration tests should be submitted to the `dedicated repository diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/orthanc-ids.rst --- a/Sphinx/source/faq/orthanc-ids.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/orthanc-ids.rst Mon Mar 30 20:14:52 2020 +0200 @@ -41,7 +41,7 @@ The actual implementation of the hashing is carried on by the `DicomInstanceHasher class -`_. +`_. The "Inexistent Tag" error diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/orthanc-storage.rst --- a/Sphinx/source/faq/orthanc-storage.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/orthanc-storage.rst Mon Mar 30 20:14:52 2020 +0200 @@ -59,9 +59,9 @@ database schema is kept as simple as possible, and can be found in the following two files of the source code of Orthanc: `PrepareDatabase.sql -`__ +`__ and `InstallTrackAttachmentsSize.sql -`__. +`__. Direct access diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/rest-samples.rst --- a/Sphinx/source/faq/rest-samples.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/rest-samples.rst Mon Mar 30 20:14:52 2020 +0200 @@ -10,7 +10,7 @@ dedicated section `. * Many working examples written in Python are `available in the source distribution - `__. + `__. * If you cannot find an example for some feature in this manual or in the Python examples, please check the `publicly available integration tests diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/supported-images.rst --- a/Sphinx/source/faq/supported-images.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/supported-images.rst Mon Mar 30 20:14:52 2020 +0200 @@ -5,7 +5,7 @@ Orthanc can **receive/store/send** any kind of standard DICOM files (cf. the `DICOM conformance statement -`__). +`__). Note that the ``UnknownSopClassAccepted`` :ref:`configuration option ` can be set to `true` if interfacing with modalities that are producing non-standard SOP classes. diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/transcoding.rst --- a/Sphinx/source/faq/transcoding.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/transcoding.rst Mon Mar 30 20:14:52 2020 +0200 @@ -13,7 +13,7 @@ Adding support for transcoding is one of the features that is pending on `our roadmap -`__, and for which +`__, and for which we are looking for industrial sponsors. @@ -108,7 +108,7 @@ ``OrthancPluginRegisterOnStoredInstanceCallback()`` function). A sample Lua script that converts every incoming DICOM file to the JPEG2k transfer syntax is `part of the Orthanc sources -`__. +`__. Finally, as a fourth solution, it is possible to **combine two Orthanc diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/faq/troubleshooting.rst --- a/Sphinx/source/faq/troubleshooting.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/faq/troubleshooting.rst Mon Mar 30 20:14:52 2020 +0200 @@ -106,7 +106,7 @@ advantage of this patch, you need to statically link Orthanc against DCMTK by using the ``-DUSE_SYSTEM_DCMTK=OFF`` flag `when invoking CMake - `__. + `__. Checking DICOM file integrity ----------------------------- diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/plugins/serve-folders.rst --- a/Sphinx/source/plugins/serve-folders.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/plugins/serve-folders.rst Mon Mar 30 20:14:52 2020 +0200 @@ -12,7 +12,7 @@ The source code of this sample plugin is `available in the source distribution of Orthanc -`__ +`__ (GPLv3+ license). diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/plugins/worklists-plugin.rst --- a/Sphinx/source/plugins/worklists-plugin.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/plugins/worklists-plugin.rst Mon Mar 30 20:14:52 2020 +0200 @@ -26,7 +26,7 @@ The source code of this sample plugin is `available in the source distribution of Orthanc -`__ +`__ (GPLv3+ license). @@ -59,7 +59,7 @@ The folder ``WorklistsDatabase`` of the `source distribution of Orthanc -`__ +`__ contains a database of sample worklists, that comes from the DCMTK source distribution, as described in the `FAQ entry #37 of the DCMTK project `__. @@ -73,7 +73,7 @@ - Download `DCMTK utilities `__. - Download sample `worklist files - `__ + `__ from the Orthanc source code and copy them in a dedicated folder. - Generate the :ref:`default configuration of Orthanc `. - Enable the ModalityWorklist plugin in your configuration file by adding this section:: @@ -130,7 +130,7 @@ - Start with an existing worklist file, some samples of which can be found in the `Orthanc source distribution - `__ + `__ (with ``.wl`` file extensions). - The worklist file is a DICOM file. Dump its content as a text file using ``dcmdump``:: diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/users/lua.rst --- a/Sphinx/source/users/lua.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/users/lua.rst Mon Mar 30 20:14:52 2020 +0200 @@ -13,7 +13,7 @@ scripting. Many other examples are `available in the source distribution -`__. +`__. Installing a Lua script @@ -108,7 +108,7 @@ protocol. This allows to inspect the content of the C-Find query, and possibly modify it if a patch is needed for some manufacturer. A `sample script is available - `__. + `__. Some other **resource-related events** are available: @@ -137,7 +137,7 @@ SCP, several callbacks are successively invoked to specify which **transfer syntaxes** are accepted for the association. These callbacks are listed in `this sample script -`__. +`__. *Note:* All of these callbacks are guaranteed to be **invoked in mutual exclusion**. This implies that Lua scripting in Orthanc does diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/users/replication.rst --- a/Sphinx/source/users/replication.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/users/replication.rst Mon Mar 30 20:14:52 2020 +0200 @@ -71,7 +71,7 @@ The most direct way to replicate an instance of Orthanc consists in using the `ImportDicomFiles -`_ +`_ script of the Orthanc distribution. For instance, the following command would recursively explore the content of the ``OrthancStorage`` folder (where Orthanc stores its DICOM files by @@ -111,7 +111,7 @@ ------------------- If you cannot use the first method, you can use the `Replicate -`_ +`_ script of the Orthanc distribution. This script will use the REST API of both the source and target instances of Orthanc. For instance:: diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/users/rest.rst --- a/Sphinx/source/users/rest.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/users/rest.rst Mon Mar 30 20:14:52 2020 +0200 @@ -57,7 +57,7 @@ $ curl -X POST -H "Expect:" http://localhost:8042/instances --data-binary @CT.X.1.2.276.0.7230010.dcm The code distribution of Orthanc contains a `sample Python script -`__ +`__ that recursively upload the content of some folder into Orthanc using the REST API:: @@ -598,7 +598,7 @@ The list of the resources to be sent are given as a JSON array. In this case, a single DICOM connection is used. `Sample code is available - `__. + `__. Note that the list of resources to be sent can include the :ref:`Orthanc identifiers ` of entire patients, @@ -922,7 +922,7 @@ $ curl 'http://localhost:8042/changes?limit=100&since=922' A `sample code in the source distribution -`__ +`__ shows how to use this Changes API to implement a polling loop. diff -r 9acb9354da1a -r d217af5e6cb3 Sphinx/source/users/support.rst --- a/Sphinx/source/users/support.rst Mon Mar 30 20:03:51 2020 +0200 +++ b/Sphinx/source/users/support.rst Mon Mar 30 20:14:52 2020 +0200 @@ -25,12 +25,12 @@ `__. 7. Check out the ``Pending changes in the mainline`` section of the `NEWS file - `__, as + `__, as your issue might already be solved in the mainline of Orthanc (i.e. in the cutting-edge version of Orthanc since the last stable official release). 8. Carefully read the `TODO file - `__ that + `__ that contains our roadmap, as you might be requesting a feature that is currently pending in our backlog (i.e. not implemented yet). 9. Have a look for the issue in the `official bug tracker