Mercurial > hg > orthanc-book

comparison Sphinx/source/contributing.rst @ 473:c7b2424e4b52

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
contributing
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 05 Aug 2020 15:34:48 +0200
parents 93c2f780aaef
children e769dcdf26bc
comparison
equal deleted inserted replaced
472:03dfb896ca4b 473:c7b2424e4b52
24 - Improve the text of the `Orthanc Book and REST API documentation 24 - Improve the text of the `Orthanc Book and REST API documentation
25 <https://hg.orthanc-server.com/orthanc-book/file/default>`__ (check 25 <https://hg.orthanc-server.com/orthanc-book/file/default>`__ (check
26 out the instructions provided in the `README file 26 out the instructions provided in the `README file
27 <https://hg.orthanc-server.com/orthanc-book/file/default/README.md>`__, 27 <https://hg.orthanc-server.com/orthanc-book/file/default/README.md>`__,
28 and send us a :ref:`simple patch <hg-patch>`). 28 and send us a :ref:`simple patch <hg-patch>`).
29 - Pursue the `OpenAPI documentation
30 <https://api.orthanc-server.com/>`__, that is still
31 work-in-progress (`check out its source code
32 <https://hg.orthanc-server.com/orthanc-book/file/default/OpenAPI>`__).
29 - Provide documentation and use cases (inside the dedicated `GitHub 33 - Provide documentation and use cases (inside the dedicated `GitHub
30 repository <https://github.com/jodogne/OrthancContributed>`_, via 34 repository <https://github.com/jodogne/OrthancContributed>`_, via
31 pull requests). 35 pull requests).
32 - Index external contributions inside the `Links.md 36 - Index external contributions inside the `Links.md
33 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md>`_ 37 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md>`_
37 41
38 - Report problems together with sample DICOM images and possible 42 - Report problems together with sample DICOM images and possible
39 workarounds on the dedicated `issue tracker 43 workarounds on the dedicated `issue tracker
40 <http://bugs.orthanc-server.com/>`_. 44 <http://bugs.orthanc-server.com/>`_.
41 - Package Orthanc and its associated plugins for more UNIX or 45 - Package Orthanc and its associated plugins for more UNIX or
42 GNU/Linux distributions (e.g. Ubuntu PPA, RHEL, CentOS, openSUSE...). 46 GNU/Linux distributions (e.g. Ubuntu PPA, RHEL/`EPEL
47 <https://fedoraproject.org/wiki/EPEL>`__, CentOS, openSUSE...).
48 - Take ownership of the now-orphaned `Fedora package
49 <https://src.fedoraproject.org/rpms/orthanc>`__.
43 - Share your maintenance scripts or sample code inside the "`Orthanc Contributed 50 - Share your maintenance scripts or sample code inside the "`Orthanc Contributed
44 <https://github.com/jodogne/OrthancContributed>`_" public GitHub 51 <https://github.com/jodogne/OrthancContributed>`_" public GitHub
45 repository, via pull requests. 52 repository, via pull requests.
53 - Help with the integration of Orthanc together with our friend free
54 and open-source projects, notably `GNU Health
55 <https://www.orthanc-server.com/resources/orthanccon2019/GNUHealthCon-02-AxelBraun.pdf>`__,
56 but also `OpenEMR
57 <https://community.open-emr.org/t/project-pacs-server-integration/13706/15>`__,
58 `GNUmed <https://en.wikipedia.org/wiki/GNUmed>`__...
59
46 60
47 * **Coding tasks**: 61 * **Coding tasks**:
48 62
49 - The Orthanc project will happily accept patches in the core of 63 - The Orthanc project will happily accept patches in the core of
50 Orthanc and in its associated official plugins. Please read the 64 Orthanc and in its associated official plugins. Please read the
51 :ref:`dedicated FAQ entry <cla>`. 65 :ref:`dedicated FAQ entry <cla>`.
52 - Interface Orthanc with other software (e.g. 3D Slicer, 66 - Interface Orthanc with other software (e.g. 3D Slicer,
53 Matlab/Octave, Python, Horos, dicompyler...). Check the `already 67 Matlab/Octave, Python, Horos, dicompyler...). Check the `already
54 supported frameworks <https://www.orthanc-server.com/static.php?page=resources>`_. 68 supported frameworks <https://www.orthanc-server.com/static.php?page=resources>`_.
55 - Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. Here are some ideas 69 - Develop :ref:`C/C++/Python plugins extending the Orthanc core <plugins>`. Here are some ideas
56 of possible plugins: 70 of possible plugins:
57 71
58 + Create a :ref:`more advanced Web interface 72 + Create a :ref:`more advanced Web interface
59 <improving-interface>` than the built-in Orthanc Explorer. 73 <improving-interface>` than the built-in Orthanc Explorer.
60 + Extend the :ref:`sample modality worklist plugin <worklist>` so 74 + Extend the :ref:`sample modality worklist plugin <worklist>` so
61 that it manages the worklists (i.e. add/remove items) with a 75 that it manages the worklists (i.e. add/remove items) with a
62 REST API or HL7 messages, instead of reading them from some 76 REST API or HL7 messages, instead of reading them from some
63 folder on the filesystem. 77 folder on the filesystem.
78 + Conversion to/from `NIfTI
79 <https://www.sciencedirect.com/science/article/abs/pii/S0165027016300073?via%3Dihub>`__
80 and/or `BIDS
81 <https://en.wikipedia.org/wiki/Brain_Imaging_Data_Structure>`__,
82 notably for neuroimaging.
64 + Have a look at the TODO file containing our `official roadmap 83 + Have a look at the TODO file containing our `official roadmap
65 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__. 84 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__.
66 85
86 - Develop a way to "mount" the content of one Orthanc server as a
87 network drive through the :ref:`REST API <rest>`, using either
88 `FTP <https://en.wikipedia.org/wiki/File_Transfer_Protocol>`__,
89 `FUSE <https://en.wikipedia.org/wiki/Filesystem_in_Userspace>`__
90 (through `Samba
91 <https://en.wikipedia.org/wiki/Samba_(software)>`__ for Windows)
92 or `WebDAV <https://en.wikipedia.org/wiki/WebDAV>`__.
67 - Always remember that he **recommended way of contributing to the 93 - Always remember that he **recommended way of contributing to the
68 source code of Orthanc is by creating C/C++ plugins**. If the 94 source code of Orthanc is by creating C/C++/Python plugins**. If
69 current plugin SDK is insufficient for you to develop some feature 95 the current plugin SDK is insufficient for you to develop some
70 as a plugin, do not hesitate to request an extension to the 96 feature as a plugin, do not hesitate to request an extension to
71 Orthanc SDK on the `mailing list 97 the Orthanc SDK on the `mailing list
72 <https://groups.google.com/forum/#!forum/orthanc-users>`_. 98 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
73 99
74 100
75 * **Financial support**: 101 * **Financial support**:
76 102