othmane/ohif-viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: duplicate PR-784

Browse Source
This commit is contained in:
dannyrb 2019-08-20 16:39:25 -04:00
parent e7e2dcc4b6
commit 2cf355856b
8 changed files with 50 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/latest/advanced/_maintained-extensions-table.md
View File

@ -10,7 +10,7 @@
<!-- CORNERSTONE.js --> <!-- CORNERSTONE.js -->
<tr> <tr>
<td> <td>
<a href="https://www.npmjs.com/package/ohif-cornerstone-extension"> <a href="https://www.npmjs.com/package/@ohif/extension-cornerstone">
Cornerstone Cornerstone
</a> </a>
</td> </td>
@ -22,7 +22,7 @@
<!-- VTK.js --> <!-- VTK.js -->
<tr> <tr>
<td> <td>
<a href="https://www.npmjs.com/package/ohif-vtk-extension"> <a href="https://www.npmjs.com/package/@ohif/extension-vtk">
VTK.js VTK.js
</a> </a>
</td> </td>
@ -33,30 +33,30 @@
</tr> </tr>
<tr> <tr>
<td> <td>
<a href="">HTML</a> <a href="https://www.npmjs.com/package/@ohif/extension-dicom-html">DICOM HTML</a>
</td> </td>
<td> <td>
Renders text and HTML content for <a href="https://github.com/OHIF/Viewers/blob/react/extensions/ohif-dicom-html-extension/src/OHIFDicomHtmlSopClassHandler.js#L7-L15">specific SopClassUIDs</a>. Renders text and HTML content for <a href="https://github.com/OHIF/Viewers/blob/master/extensions/dicom-html/src/OHIFDicomHtmlSopClassHandler.js#L4-L12">specific SopClassUIDs</a>.
</td> </td>
<td>Viewport, SopClassHandler</td> <td>Viewport, SopClassHandler</td>
</tr> </tr>
<tr> <tr>
<td> <td>
<a href="https://www.npmjs.com/package/ohif-dicom-pdf-extension">PDF</a> <a href="https://www.npmjs.com/package/@ohif/extension-dicom-pdf">DICOM PDF</a>
</td> </td>
<td> <td>
Renders PDFs for a <a href="https://github.com/OHIF/Viewers/blob/react/extensions/ohif-dicom-pdf-extension/src/OHIFDicomPDFSopClassHandler.js#L8">specific SopClassUID</a>. Renders PDFs for a <a href="https://github.com/OHIF/Viewers/blob/master/extensions/dicom-pdf/src/OHIFDicomPDFSopClassHandler.js#L4-L6">specific SopClassUID</a>.
</td> </td>
<td>Viewport, SopClassHandler</td> <td>Viewport, SopClassHandler</td>
</tr> </tr>
<tr> <tr>
<td> <td>
<a href="https://www.npmjs.com/package/ohif-dicom-microscopy-extension">Microscopy</a> <a href="https://www.npmjs.com/package/@ohif/extension-dicom-microscopy">DICOM Microscopy</a>
</td> </td>
<td> <td>
Renders Microscopy images for a <a href="https://github.com/OHIF/Viewers/blob/react/extensions/ohif-dicom-microscopy-extension/src/DicomMicroscopySopClassHandler.js#L6">specific SopClassUID</a>. Renders Microscopy images for a <a href="https://github.com/OHIF/Viewers/blob/master/extensions/dicom-microscopy/src/DicomMicroscopySopClassHandler.js#L5-L7">specific SopClassUID</a>.
</td> </td>
<td>Viewport, SopClassHandler</td> <td>Viewport, SopClassHandler</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

18
docs/latest/advanced/extensions.md
View File

@ -152,7 +152,7 @@ is used depends on:
<center><i>An example of three Viewports</i></center> <center><i>An example of three Viewports</i></center>
For a complete example implementation, For a complete example implementation,
[check out the OHIFCornerstoneViewport](https://github.com/OHIF/Viewers/blob/react/extensions/ohif-cornerstone-extension/src/OHIFCornerstoneViewport.js). [check out the OHIFCornerstoneViewport](https://github.com/OHIF/Viewers/blob/master/extensions/cornerstone/src/OHIFCornerstoneViewport.js).
#### Toolbar #### Toolbar
@ -168,7 +168,7 @@ store.
Toolbar components are rendered in the `ToolbarRow` component. Toolbar components are rendered in the `ToolbarRow` component.
For a complete example implementation, For a complete example implementation,
[check out the OHIFCornerstoneViewport's Toolbar Module](https://github.com/OHIF/Viewers/blob/react/extensions/ohif-cornerstone-extension/src/ToolbarModule.js). [check out the OHIFCornerstoneViewport's Toolbar Module](https://github.com/OHIF/Viewers/blob/master/extensions/cornerstone/src/toolbarModule.js).
#### SopClassHandler #### SopClassHandler
@ -197,9 +197,9 @@ would like included at startup.
_app.js_ _app.js_
```js ```js
import { createStore, combineReducers } from "redux"; import { createStore, combineReducers } from 'redux';
import OHIF from "@ohif/core"; import OHIF from '@ohif/core';
import OHIFCornerstoneExtension from "ohif-cornerstone-extension"; import OHIFCornerstoneExtension from 'ohif-cornerstone-extension';
const combined = combineReducers(OHIF.redux.reducers); const combined = combineReducers(OHIF.redux.reducers);
const store = createStore(combined); const store = createStore(combined);
@ -214,8 +214,8 @@ ExtensionManager.registerExtensions(store, extensions);
A small number of powerful extensions for popular use cases are maintained by A small number of powerful extensions for popular use cases are maintained by
OHIF. They're co-located in the OHIF. They're co-located in the
[`OHIF/Viewers`](https://github.com/OHIF/Viewers/tree/react/) repository, in the [`OHIF/Viewers`](https://github.com/OHIF/Viewers) repository, in the top level
top level [`extensions/`](https://github.com/OHIF/Viewers/tree/react/extensions) [`extensions/`](https://github.com/OHIF/Viewers/tree/master/extensions)
directory. directory.
{% include "./_maintained-extensions-table.md" %} {% include "./_maintained-extensions-table.md" %}
@ -225,6 +225,6 @@ directory.
--> -->
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
[example-ext-src]: https://github.com/OHIF/Viewers/blob/master/extensions/_ohif-example-extension/src/index.js) [example-ext-src]: https://github.com/OHIF/Viewers/tree/master/extensions/_example/src
[module-types]: https://github.com/OHIF/ohif-core/blob/43c08a29eff3fb646a0e83a03a236ddd84f4a6e8/src/plugins.js#L1-L6 [module-types]: https://github.com/OHIF/Viewers/blob/master/platform/core/src/extensions/MODULE_TYPES.js
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->

14
docs/latest/deployment/recipes/build-for-production.md
View File

@ -71,11 +71,11 @@ how to configure the project for your own imaging archive below.
#### How it Works #### How it Works
The configuration for our project is in the `/public/config` directory. Our The configuration for our project is in the `/public/config` directory. Our
build process knows which configuration file to use based on the build process knows which configuration file to use based on the `APP_CONFIG`
`APP_CONFIG` environment variable. By default, its value is environment variable. By default, its value is
[`default.js`](https://github.com/OHIF/Viewers/blob/react/public/config/default.js). [`default.js`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/config/default.js).
When we build, the `%APP_CONFIG%` value in When we build, the `%APP_CONFIG%` value in
our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/react/public/index.html#L12-L15) our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/index.html)
file is substituted for the correct configuration file's name. This sets file is substituted for the correct configuration file's name. This sets
the`window.config` equal to our configuration file's value. the`window.config` equal to our configuration file's value.
@ -104,12 +104,12 @@ window.config = {
}, },
], ],
}, },
} };
``` ```
You can also create a new config file and specify its path relative to the build You can also create a new config file and specify its path relative to the build
output's root by setting the `APP_CONFIG` environment variable. You can output's root by setting the `APP_CONFIG` environment variable. You can set the
set the value of this environment variable a few different ways: value of this environment variable a few different ways:
- [Add a temporary environment variable in your shell](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell) - [Add a temporary environment variable in your shell](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell)
- [Add environment specific variables in `.env` file(s)](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-development-environment-variables-in-env) - [Add environment specific variables in `.env` file(s)](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-development-environment-variables-in-env)

8
docs/latest/deployment/recipes/nginx--image-archive.md
View File

@ -11,7 +11,7 @@ control.
Do not use this recipe to host sensitive medical data on the open web. Depending Do not use this recipe to host sensitive medical data on the open web. Depending
on your company's policies, this may be an appropriate setup on an internal on your company's policies, this may be an appropriate setup on an internal
network when protected with a server's basic authentication. For a more robust network when protected with a server's basic authentication. For a more robust
setup, check out our [user account control recpie](./user-account-control.md) setup, check out our [user account control recipe](./user-account-control.md)
that builds on the lessons learned here. that builds on the lessons learned here.
## Overview ## Overview
@ -51,7 +51,7 @@ We can solve this one of two ways:
This solution uses the first approach, but you can see an example of the second This solution uses the first approach, but you can see an example of the second
in the `docker-compose` bundled with this project for local development: in the `docker-compose` bundled with this project for local development:
[HERE](#) [HERE](https://github.com/OHIF/Viewers/blob/master/platform/viewer/.recipes/Nginx-Orthanc/docker-compose.yml)
You can read more about CORS in this Medium article: [Understanding You can read more about CORS in this Medium article: [Understanding
CORS][understanding-cors] CORS][understanding-cors]
@ -124,8 +124,8 @@ likely want to update:
The OHIF Viewer's configuration is imported from a static `.js` file and made The OHIF Viewer's configuration is imported from a static `.js` file and made
available globally at `window.config`. The configuration we use is set to a available globally at `window.config`. The configuration we use is set to a
specific file when we build the viewer, and determined by the env variable: specific file when we build the viewer, and determined by the env variable:
`APP_CONFIG`. You can see where we set its value in the `dockerfile` for `APP_CONFIG`. You can see where we set its value in the `dockerfile` for this
this solution: solution:
`ENV APP_CONFIG=config/docker_openresty-orthanc.js` `ENV APP_CONFIG=config/docker_openresty-orthanc.js`

14
docs/latest/deployment/recipes/user-account-control.md
View File

@ -125,8 +125,8 @@ likely want to update:
The OHIF Viewer's configuration is imported from a static `.js` file and made The OHIF Viewer's configuration is imported from a static `.js` file and made
available globally at `window.config`. The configuration we use is set to a available globally at `window.config`. The configuration we use is set to a
specific file when we build the viewer, and determined by the env variable: specific file when we build the viewer, and determined by the env variable:
`APP_CONFIG`. You can see where we set its value in the `dockerfile` for `APP_CONFIG`. You can see where we set its value in the `dockerfile` for this
this solution: solution:
`ENV APP_CONFIG=config/docker_openresty-orthanc-keycloak.js` `ENV APP_CONFIG=config/docker_openresty-orthanc-keycloak.js`
@ -281,9 +281,9 @@ community members put together:
[orthanc-docs]: http://book.orthanc-server.com/users/configuration.html#configuration [orthanc-docs]: http://book.orthanc-server.com/users/configuration.html#configuration
[lua-resty-openidc-docs]: https://github.com/zmartzone/lua-resty-openidc [lua-resty-openidc-docs]: https://github.com/zmartzone/lua-resty-openidc
<!-- SRC --> <!-- SRC -->
[config]: # [config]: https://github.com/OHIF/Viewers/blob/master/platform/viewer/src/config.js
[dockerfile]: # [dockerfile]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes
[config-nginx]: # [config-nginx]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes
[config-orthanc]: # [config-orthanc]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes
[config-keycloak]: # [config-keycloak]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->

14
docs/latest/essentials/configuration.md
View File

@ -7,11 +7,11 @@
## How it Works ## How it Works
The configuration for our project is in the `/public/config` directory. Our The configuration for our project is in the `/public/config` directory. Our
build process knows which configuration file to use based on the build process knows which configuration file to use based on the `APP_CONFIG`
`APP_CONFIG` environment variable. By default, its value is environment variable. By default, its value is
[`default.js`](https://github.com/OHIF/Viewers/blob/react/public/config/default.js). [`default.js`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/config/default.js).
When we build, the `%APP_CONFIG%` value in When we build, the `%APP_CONFIG%` value in
our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/react/public/index.html#L12-L15) our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/index.html)
file is substituted for the correct configuration file's name. This sets the file is substituted for the correct configuration file's name. This sets the
`window.config` equal to our configuration file's value. `window.config` equal to our configuration file's value.
@ -40,12 +40,12 @@ window.config = {
}, },
], ],
}, },
} };
``` ```
You can also create a new config file and specify its path relative to the build You can also create a new config file and specify its path relative to the build
output's root by setting the `APP_CONFIG` environment variable. You can output's root by setting the `APP_CONFIG` environment variable. You can set the
set the value of this environment variable a few different ways: value of this environment variable a few different ways:
- [Add a temporary environment variable in your shell](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell) - [Add a temporary environment variable in your shell](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell)
- [Add environment specific variables in `.env` file(s)](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-development-environment-variables-in-env) - [Add environment specific variables in `.env` file(s)](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-development-environment-variables-in-env)

11
docs/latest/essentials/data-source.md
View File

@ -60,8 +60,8 @@ _Upload your first Study:_
#### Orthanc: Learn More #### Orthanc: Learn More
You can see the `docker-compose.yml` file this command runs at You can see the `docker-compose.yml` file this command runs at
[`<project-root>/docker/Nginx-Docker/`](#), and more on Orthanc for Docker in [`<project-root>/platform/viewer/.recipes/Nginx-Orthanc/`](https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes/Nginx-Orthanc),
[Orthanc's documentation][orthanc-docker]. and more on Orthanc for Docker in [Orthanc's documentation][orthanc-docker].
### Connecting to Orthanc ### Connecting to Orthanc
@ -96,10 +96,9 @@ cross-env PORT=5000 APP_CONFIG=config/docker_nginx-orthanc.js react-scripts star
- `react-scripts` runs it's `start` script. This is [the de-facto - `react-scripts` runs it's `start` script. This is [the de-facto
way][cra-start] to run a "Create React App" in development mode. way][cra-start] to run a "Create React App" in development mode.
The `APP_CONFIG` value tells our app which file to load on to The `APP_CONFIG` value tells our app which file to load on to `window.config`.
`window.config`. By default, our app uses the file at By default, our app uses the file at `<project-root>/public/config/default.js`.
`<project-root>/public/config/default.js`. Here is what that configuration looks Here is what that configuration looks like:
like:
```js ```js
window.config = { window.config = {

4
docs/latest/frequently-asked-questions.md
View File

@ -37,8 +37,8 @@ Some tips for filing a new issue:
At the moment we are in the process of defining our roadmap and will do our best At the moment we are in the process of defining our roadmap and will do our best
to communicate this to the community. If your requested feature is on the to communicate this to the community. If your requested feature is on the
roadmap, then it will most likely be built at some point. If it is not, you are roadmap, then it will most likely be built at some point. If it is not, you are
welcome to build it yourself and [contribute it](../contributing.md). If you welcome to build it yourself and [contribute it](contributing.md). If you have
have resources and would like to fund the development of a feature, please resources and would like to fund the development of a feature, please
[contact us](http://www.ohif.org). [contact us](http://www.ohif.org).
### Who should I contact about Academic Collaborations? ### Who should I contact about Academic Collaborations?