Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins.rst @ 40:99b45a963bcf
contributing
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 19 Aug 2016 08:59:32 +0200 |
| parents | 2ee7f4462a6a |
| children | a52f1dc48ebc |
| rev | line source |
|---|---|
| 24 | 1 .. _plugins: |
| 2 | |
| 3 Plugins | |
| 4 ======= | |
| 5 | |
| 25 | 6 .. contents:: |
| 7 | |
| 8 Overview | |
| 9 -------- | |
| 10 | |
| 24 | 11 The core of Orthanc can be extended through **plugins**. A plugin |
| 12 takes the form of a shared library (``.DLL`` under Windows, ``.so`` | |
| 13 under Linux, ``.dylib`` under Apple OS X...). A plugin can do various | |
| 14 things, among others: | |
| 15 | |
| 16 * Serving new **Web applications** that have full access to the REST | |
| 17 API of Orthanc, which makes easy to handle DICOM images from | |
| 18 JavaScript code. | |
| 19 * Replacing **the way DICOM images are decoded** (e.g. the official | |
| 20 :ref:`Web viewer plugin <webviewer>` introduces the decoding of | |
| 21 JPEG2000 images, which is not available in the core of Orthanc). | |
| 22 * Replacing the default **database back-end** of Orthanc (that is built | |
| 23 upon SQLite) by another (:ref:`PostgreSQL <postgresql>`, MySQL, SQL Server...). | |
| 24 * Creating **new REST APIs** on the top of the Orthanc built-in API (as in | |
| 25 in the official :ref:`DICOMweb <dicomweb>` plugin). | |
| 26 * **Reacting** to the arrival of new DICOM images or other | |
| 27 DICOM-related events so as to carry on automated processing. | |
| 25 | 28 * ... |
| 29 | |
| 30 Developers external to the official Orthanc project are :ref:`invited | |
| 38 | 31 to contribute <contributing>` to the C/C++ part of Orthanc by creating |
| 32 third-party plugins. A specific section of the Orthanc Book explains | |
| 33 :ref:`how to create new Orthanc plugins <creating-plugins>`. | |
| 24 | 34 |
| 35 .. _plugins-official: | |
| 36 | |
| 37 Index of the official plugins | |
| 38 ----------------------------- | |
| 39 | |
| 40 .. toctree:: | |
| 41 :maxdepth: 1 | |
| 42 | |
|
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
43 plugins/webviewer.rst |
| 24 | 44 plugins/dicomweb.rst |
| 45 plugins/postgresql.rst | |
| 46 plugins/worklists-plugin.rst | |
|
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
47 plugins/serve-folders.rst |
| 24 | 48 |
| 49 | |
| 50 .. _plugins-contributed: | |
| 51 | |
| 52 Index of the contributed plugins | |
| 53 -------------------------------- | |
| 54 | |
|
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
55 * `Osimis <http://osimis.io/>`__ maintains an evolution of the |
|
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
56 official Web viewer plugin. The Osimis plugin adds tools for |
|
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
57 measuring, for viewing multiple series, and for split-pane. `Check |
|
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
58 out their source code |
|
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
59 <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__. |
| 24 | 60 * `DWV Orthanc Plugin |
| 61 <https://github.com/ivmartel/dwv-orthanc-plugin>`__: This plugin by | |
| 62 Yves Martelli is based on `dwv | |
| 63 <https://github.com/ivmartel/dwv/wiki>`__ and extends Orthanc with a | |
| 64 Web viewer of DICOM images. | |
| 65 * Another Web viewer is provided courtesy of `Emsy Chan | |
| 25 | 66 <https://groups.google.com/d/msg/orthanc-users/EC5Z2KaM4Hs/MG3KkzhCDAAJ>`__. |
| 40 | 67 * Check out the `OrthancContributed repository on GitHub |
| 68 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`__, that | |
| 69 might contain plugins that are not tracked in this list. | |
| 24 | 70 |
| 38 | 71 *Remark:* Do not hesitate to `contact us |
| 72 <http://www.orthanc-server.com/static.php?page=contact>`__ if you have | |
| 73 developed a plugin so that we can include it in the list above! |