Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation #66

Open
wants to merge 36 commits into
base: main
Choose a base branch
from
Open
Changes from 11 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
053415a
update description of the app
koebel Nov 19, 2024
ecc4b61
adding pics to the description
koebel Nov 19, 2024
57d8375
formatting of pictures
koebel Nov 19, 2024
8208e9b
display pics in one row
koebel Nov 19, 2024
786c205
formatting of images
koebel Nov 19, 2024
1c2f2c2
update styling of pictures
koebel Nov 19, 2024
4e955d5
add table of content
koebel Nov 19, 2024
00c6c51
add more screenshots and move detail description down
koebel Nov 19, 2024
f707b5f
add draft for installation instructions
koebel Nov 19, 2024
492d29d
update anchor link
koebel Nov 19, 2024
54b7028
updating TOC
koebel Nov 19, 2024
616040f
Update README.md
koebel Nov 20, 2024
697c820
moving quick reference section down and minor text updates
koebel Nov 20, 2024
f190fcb
add paragraph about how to add web app to installation
koebel Nov 20, 2024
5638390
add links to assets
koebel Nov 20, 2024
eda9d10
adding draft for yaml & fix link
koebel Nov 20, 2024
5b32f02
update installation section
koebel Nov 20, 2024
aecaf1c
update contributing and copyright section
koebel Nov 20, 2024
a34ba62
update prerequisites
koebel Nov 20, 2024
2baf550
update Development section
koebel Nov 20, 2024
94d9db9
add app installation
koebel Nov 20, 2024
23b2878
remove internal comments
koebel Nov 20, 2024
da283c3
remove internal notes regarding TODOs
koebel Nov 20, 2024
6724968
upadte contribution section
koebel Nov 20, 2024
0c9d943
Apply suggestions from code review
koebel Nov 20, 2024
2afde28
minor corrections
koebel Nov 20, 2024
e22ed0c
fix minor typos and update table of content
koebel Nov 20, 2024
1080a2b
update order of steps for development
koebel Nov 21, 2024
58da163
update links in TOC
koebel Nov 21, 2024
61e1b88
update styling
koebel Nov 21, 2024
b96dbae
remove line about location of manifest.json
koebel Nov 21, 2024
ea40d25
adding section on how to add dicom viewer to the ocis deployment example
koebel Nov 21, 2024
cb1ddae
adding path to yml file
koebel Nov 21, 2024
b9d89e0
minor text changes and fixing anchor links
koebel Nov 21, 2024
1a92661
Apply suggestions from code review
koebel Nov 21, 2024
16b68ca
Apply suggestions from code review
koebel Nov 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,29 @@

The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://github.com/owncloud/web) to preview DICOM files (medical images and their corresponding metadata) in the browser. The preview of the medical images is based on MIT licensed [cornerstone3D](https://github.com/cornerstonejs/cornerstone3D).

The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom, rotate, flip, invert and reset of the image preview. The UI is implemented in responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device.

## Table of Contents

* [Functionalities of the DICOM Viewer Web Extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension)
* [Adding DICOM Viewer to your oCIS installation](#)
* [Installation instructions for developers](#)
* [Contributing to this app](#)

TODO: update TOC!


## Functionalities of the DICOM Viewer Web Extension

The current release allows to preview .dcm files within oCIS and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device.
koebel marked this conversation as resolved.
Show resolved Hide resolved

<img src="https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/1.png" alt="app functionalities" style="width:48%; height:auto;"> &nbsp; &nbsp; <img src="https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png" alt="display of metadata" style="width:48%; height:auto;">

_The extension allows to preview a DICOM image and it's most important meta data. On request, all corresponding metadata of the file are displayed in the sidebar._

<img src="https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/2.png" alt="app functionalities" style="width:48%; height:auto;"> &nbsp; &nbsp; <img src="https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/3.png" alt="display of metadata" style="width:48%; height:auto;">

_The extension allows to zoom, rotate and flip the preview of the image. Inverting the colors of the preview is also supported._
koebel marked this conversation as resolved.
Show resolved Hide resolved


## Quick reference

Expand All @@ -16,6 +38,16 @@ The current implementation allows to preview .dcm files and display their corres
- **Supported architectures:**\
`amd64`


## Adding DICOM Viewer to your oCIS installation
As administrator of an environment you can add custom web applications for your users. By adding DICOM Viewer you enable your users to take advantage of this web extension.
koebel marked this conversation as resolved.
Show resolved Hide resolved

TODO: following text is taken from general installation instructions, insert specific steps?

Please follow the steps provided in our [developer documentation](https://owncloud.dev/services/web/#web-apps) if you want to install any of the
following apps and extensions. For some of them there are released artifacts, others still need to be built from source code.


## Installation

### 1. Install dependencies
Expand Down