Mercurial > hg > orthanc-book

comparison Sphinx/source/developers/creating-plugins.rst @ 358:011b01ccf52d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fixing external hyperlinks
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 30 Mar 2020 18:47:35 +0200
parents a5f7fc9fb611
children d217af5e6cb3
comparison
equal deleted inserted replaced
357:6b432ce3a56e 358:011b01ccf52d
11 The recommended way of :ref:`contributing to the Orthanc code 11 The recommended way of :ref:`contributing to the Orthanc code
12 <contributing>` consists in extending it by creating new :ref:`plugins 12 <contributing>` consists in extending it by creating new :ref:`plugins
13 <plugins>`. 13 <plugins>`.
14 14
15 Orthanc plugins must use the `plugin SDK 15 Orthanc plugins must use the `plugin SDK
16 <http://sdk.orthanc-server.com/>`__ and must be written in C or 16 <https://sdk.orthanc-server.com/>`__ and must be written in C or
17 C++. They must also fullfil the terms of the `GPLv3 license 17 C++. They must also fullfil the terms of the `GPLv3 license
18 <http://www.gnu.org/licenses/quick-guide-gplv3.en.html>`__ that is 18 <http://www.gnu.org/licenses/quick-guide-gplv3.en.html>`__ that is
19 used by the core of Orthanc. Here are some resources about creating 19 used by the core of Orthanc. Here are some resources about creating
20 plugins: 20 plugins:
21 21
24 <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/>`__ 24 <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/>`__
25 (in the ``Plugins/Samples`` folder). 25 (in the ``Plugins/Samples`` folder).
26 26
27 * A tutorial showing how to implement a basic WADO server is 27 * A tutorial showing how to implement a basic WADO server is
28 `available on CodeProject 28 `available on CodeProject
29 <http://www.codeproject.com/Articles/797118/Implementing-a-WADO-Server-using-Orthanc>`__. 29 <https://www.codeproject.com/Articles/797118/Implementing-a-WADO-Server-using-Orthanc>`__.
30 30
31 * Marco Barnig provides `tutorial lessons to create Orthanc plugins 31 * Marco Barnig provides `tutorial lessons to create Orthanc plugins
32 <https://github.com/mbarnig/RadioLogic/wiki#orthanc-plugin-development>`__ 32 <https://github.com/mbarnig/RadioLogic/wiki#user-content-orthanc-plugin-development>`__
33 as part of his `RadioLogic project 33 as part of his `RadioLogic project
34 <https://github.com/mbarnig/RadioLogic/>`__. 34 <https://github.com/mbarnig/RadioLogic/>`__.
35 35
36 We suggest developers to adopt the :ref:`coding style of the Orthanc 36 We suggest developers to adopt the :ref:`coding style of the Orthanc
37 core <coding-style>`, although this is of course not required. 37 core <coding-style>`, although this is of course not required.
38 38
39 Do not hesitate to `contact us 39 Do not hesitate to `contact us
40 <http://www.orthanc-server.com/static.php?page=contact>`__ if you wish 40 <https://www.orthanc-server.com/static.php?page=contact>`__ if you wish
41 your plugin to be **indexed** in :ref:`the dedicated part of the 41 your plugin to be **indexed** in :ref:`the dedicated part of the
42 Orthanc Book <plugins-contributed>`! 42 Orthanc Book <plugins-contributed>`!
43 43
44 Structure of the plugins 44 Structure of the plugins
45 ------------------------ 45 ------------------------
73 that is part of the Orthanc source distribution: 73 that is part of the Orthanc source distribution:
74 74
75 * `Plugins/Include/orthanc/OrthancCPlugin.h 75 * `Plugins/Include/orthanc/OrthancCPlugin.h
76 <https://bitbucket.org/sjodogne/orthanc/src/Orthanc-1.6.0/Plugins/Include/orthanc/OrthancCPlugin.h>`__ 76 <https://bitbucket.org/sjodogne/orthanc/src/Orthanc-1.6.0/Plugins/Include/orthanc/OrthancCPlugin.h>`__
77 77
78 `Online documentation <http://sdk.orthanc-server.com/>`__ for this C 78 `Online documentation <https://sdk.orthanc-server.com/>`__ for this C
79 header is available, as generated by `Doxygen 79 header is available, as generated by `Doxygen
80 <https://en.wikipedia.org/wiki/Doxygen>`__. 80 <https://en.wikipedia.org/wiki/Doxygen>`__.
81 81
82 **Convenience C++ wrappers** around the plain C API are available in 82 **Convenience C++ wrappers** around the plain C API are available in
83 the Orthanc source distribution. The following three files can be used 83 the Orthanc source distribution. The following three files can be used