Mercurial > hg > orthanc-book

annotate README.md @ 1068:7ae36fd42cbe default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
how do you spell Orthanc
author Alain Mazy <am@orthanc.team>
date Thu, 16 May 2024 16:14:38 +0200
parents 1316bc62b5d5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 General information
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 ===================
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
4 Orthanc is a lightweight, RESTful Vendor Neutral Archive for
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
5 DICOM. General information about Orthanc can be found on its
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
6 [official Website](http://www.orthanc-server.com/).
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
8 This repository contains the source code of the
991
1316bc62b5d5 migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 583
diff changeset
9 [Orthanc Book](https://orthanc.uclouvain.be/book/), that documents how
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
10 Orthanc can be used. It also contains the source code of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
11 documentation of the
991
1316bc62b5d5 migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 583
diff changeset
12 [REST API of Orthanc](https://orthanc.uclouvain.be/api/). The continuous
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
13 integration server (CIS) of Orthanc watches this repository, and
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
14 automatically publishes modifications online.
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
17 Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
18 ============
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
19
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 Setup
151
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
21 -----
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
22
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
23 To build the Orthanc Book from sources, you need to install
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
24 [Sphinx](http://www.sphinx-doc.org/), the Python Documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
25 Generator.
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
151
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
27
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
28 ### Installing Sphinx under Ubuntu 14.04 LTS ###
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
29
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
30 # sudo pip install sphinx sphinx_bootstrap_theme
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
33 Generating the Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
34 -------------------
151
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
35
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
36 ### Under Linux ###
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
151
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
38 # cd ./Sphinx
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
39 # make html
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
40
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
41 The HTML documentation will be available in the folder
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
42 `./build/html`. You can for instance open it using Mozilla Firefox as
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
43 follows:
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
44
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
45 # firefox ./build/html/index.html
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
48 Contributing to the Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
49 ------------------------
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
51 * Make sure to understand the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
52 [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText).
151
8753cd3e6735 how to contribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
53 * Fork this repository onto your BitBucket account.
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
54 * Edit the content of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
55 [`./Sphinx/source/` folder](./Sphinx/source/).
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
56 * Generate locally the Orthanc Book (cf. above), and make sure it
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
57 displays properly on your computer.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
58 * Submit a
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
59 [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
60 for review by the Orthanc project.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
61 * Once the pull request is reviewed and accepted, the continuous
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
62 integration server of the Orthanc project will automatically
991
1316bc62b5d5 migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 583
diff changeset
63 publish the new version [online](https://orthanc.uclouvain.be/book/).
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
65
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
66
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
67 REST API of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
68 ===================
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
69
583
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
70 The REST API of Orthanc is now fully documented in the [source code of
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
71 the Orthanc
991
1316bc62b5d5 migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 583
diff changeset
72 server](https://orthanc.uclouvain.be/hg/orthanc/file/default/OrthancServer/Sources/OrthancRestApi).
583
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
73 The `--openapi=` and the `--cheatsheet=` command-line options of
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
74 Orthanc automatically generate respectively the [OpenAPI in JSON
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
75 format](https://swagger.io/specification/) and its [quick reference
991
1316bc62b5d5 migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 583
diff changeset
76 (cheatsheet)](https://orthanc.uclouvain.be/book/users/rest-cheatsheet.html)
583
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
77 in CSV format that is designed to be included right into the [Orthanc
991
1316bc62b5d5 migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 583
diff changeset
78 Book](https://orthanc.uclouvain.be/hg/orthanc-book/file/default/Sphinx/source/users/rest-cheatsheet.csv).
268
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 234
diff changeset
79
583
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
80 In order to contribute to the documentation of the REST API, you can
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
81 [propose a simple
991
1316bc62b5d5 migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 583
diff changeset
82 patch](https://orthanc.uclouvain.be/book/developers/repositories.html#simple-patch-import-export)
583
502ac2047b9b fix guide to contribute to openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 296
diff changeset
83 to the core of Orthanc to be reviewed by the core maintainers.