slim icon indicating copy to clipboard operation
slim copied to clipboard

Create documentation page in the wiki

Open fedorov opened this issue 1 year ago • 2 comments

For now, we will use a single-page documentation to cover most important features, and will add content to that page as needed.

We should include the following:

  • configuration to use external server and how to enable the "link" icon in the UI (follow up on https://github.com/ImagingDataCommons/slim/issues/5)
  • ...

fedorov avatar May 09 '24 18:05 fedorov

@pedrokohler

  • Add a new section showing how to enable the tool that allows the user to change the main data source on the fly
  • Add a new section showing how to use the gcp query param as a secondary data source to retrieve annotations or derived datasetets
  • Add a new section showing how to customize the highlight color of annotations and how to change the color of each annotation (this would require some investigation to see how this works, you can find examples in the public folder)
  • Add a new section showing how to disable all annotations (read only mode): disableAnnotationTools property and how to disable worklist (disableWorklist property)

igoroctaviano avatar May 10 '24 18:05 igoroctaviano

Hey everyone,

I guess the documentation in the README has already been updated with the ToDos by @igoroctaviano?

Unfortunately, I am not able to follow your tutorial. After connecting the standard Orthanc dicom-web URL (http://localhost:8042/dicom-web/, successfully tested with curl), I get a Communication Error "An error occured. Search for studies failed. (Source: dicomweb-client)" on the website's debug information section (http://localhost:8008).

My config (public/config/local.js) looks like this: window.config = { // This must match the location configured for web server path: '/', servers: [ { id: "local", url: "http://localhost:8042/dicom-web", } ], mode: 'light', } And no other parameters were changed.

Is the documentation incomplete? With your help, I can create a pull request clarifying the setup.

Cheers, Chris

ChrisBtt avatar Feb 17 '25 13:02 ChrisBtt