Mercurial > hg > orthanc-book
changeset 473:c7b2424e4b52
contributing
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 05 Aug 2020 15:34:48 +0200 |
parents | 03dfb896ca4b |
children | e769dcdf26bc |
files | Sphinx/source/contributing.rst |
diffstat | 1 files changed, 33 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/contributing.rst Tue Aug 04 20:53:35 2020 +0200 +++ b/Sphinx/source/contributing.rst Wed Aug 05 15:34:48 2020 +0200 @@ -26,6 +26,10 @@ out the instructions provided in the `README file <https://hg.orthanc-server.com/orthanc-book/file/default/README.md>`__, and send us a :ref:`simple patch <hg-patch>`). + - Pursue the `OpenAPI documentation + <https://api.orthanc-server.com/>`__, that is still + work-in-progress (`check out its source code + <https://hg.orthanc-server.com/orthanc-book/file/default/OpenAPI>`__). - Provide documentation and use cases (inside the dedicated `GitHub repository <https://github.com/jodogne/OrthancContributed>`_, via pull requests). @@ -39,10 +43,20 @@ workarounds on the dedicated `issue tracker <http://bugs.orthanc-server.com/>`_. - Package Orthanc and its associated plugins for more UNIX or - GNU/Linux distributions (e.g. Ubuntu PPA, RHEL, CentOS, openSUSE...). + GNU/Linux distributions (e.g. Ubuntu PPA, RHEL/`EPEL + <https://fedoraproject.org/wiki/EPEL>`__, CentOS, openSUSE...). + - Take ownership of the now-orphaned `Fedora package + <https://src.fedoraproject.org/rpms/orthanc>`__. - Share your maintenance scripts or sample code inside the "`Orthanc Contributed <https://github.com/jodogne/OrthancContributed>`_" public GitHub repository, via pull requests. + - Help with the integration of Orthanc together with our friend free + and open-source projects, notably `GNU Health + <https://www.orthanc-server.com/resources/orthanccon2019/GNUHealthCon-02-AxelBraun.pdf>`__, + but also `OpenEMR + <https://community.open-emr.org/t/project-pacs-server-integration/13706/15>`__, + `GNUmed <https://en.wikipedia.org/wiki/GNUmed>`__... + * **Coding tasks**: @@ -52,7 +66,7 @@ - Interface Orthanc with other software (e.g. 3D Slicer, Matlab/Octave, Python, Horos, dicompyler...). Check the `already supported frameworks <https://www.orthanc-server.com/static.php?page=resources>`_. - - Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. Here are some ideas + - Develop :ref:`C/C++/Python plugins extending the Orthanc core <plugins>`. Here are some ideas of possible plugins: + Create a :ref:`more advanced Web interface @@ -61,14 +75,26 @@ that it manages the worklists (i.e. add/remove items) with a REST API or HL7 messages, instead of reading them from some folder on the filesystem. + + Conversion to/from `NIfTI + <https://www.sciencedirect.com/science/article/abs/pii/S0165027016300073?via%3Dihub>`__ + and/or `BIDS + <https://en.wikipedia.org/wiki/Brain_Imaging_Data_Structure>`__, + notably for neuroimaging. + Have a look at the TODO file containing our `official roadmap <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__. - + + - Develop a way to "mount" the content of one Orthanc server as a + network drive through the :ref:`REST API <rest>`, using either + `FTP <https://en.wikipedia.org/wiki/File_Transfer_Protocol>`__, + `FUSE <https://en.wikipedia.org/wiki/Filesystem_in_Userspace>`__ + (through `Samba + <https://en.wikipedia.org/wiki/Samba_(software)>`__ for Windows) + or `WebDAV <https://en.wikipedia.org/wiki/WebDAV>`__. - Always remember that he **recommended way of contributing to the - source code of Orthanc is by creating C/C++ plugins**. If the - current plugin SDK is insufficient for you to develop some feature - as a plugin, do not hesitate to request an extension to the - Orthanc SDK on the `mailing list + source code of Orthanc is by creating C/C++/Python plugins**. If + the current plugin SDK is insufficient for you to develop some + feature as a plugin, do not hesitate to request an extension to + the Orthanc SDK on the `mailing list <https://groups.google.com/forum/#!forum/orthanc-users>`_.