docs: add llm txt (#5009)
This commit is contained in:
Alireza
GitHub
parent
4732e8093e
commit
4e185e4b21
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Configuration Files
|
||||
title: Configuration Files
|
||||
summary: Comprehensive guide to configuring OHIF Viewer, including data sources, environment variables, advanced options like study prefetching, and detailed explanations of configuration parameters for performance optimization and feature customization.
|
||||
---
|
||||
|
||||
# Config files
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: Configuration UI
|
||||
title: Configuration UI
|
||||
summary: Describes interfaces for implementing configurable data sources in OHIF, with details on BaseDataSourceConfigurationAPI and BaseDataSourceConfigurationAPIItem to enable generic UIs for hierarchical data source configuration.
|
||||
---
|
||||
|
||||
# Configuration UI
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: DICOM JSON
|
||||
title: DICOM JSON
|
||||
summary: Explains how to configure and use the DICOM JSON data source format in OHIF, including structure of the JSON file with study/series/instance metadata, implementation examples, and local deployment instructions.
|
||||
---
|
||||
|
||||
# DICOM JSON
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: DICOMweb Proxy
|
||||
title: DICOMweb Proxy
|
||||
summary: Documents the DICOMweb Proxy data source which constructs a dynamic DICOMweb datasource from a configuration JSON file, allowing OHIF to delegate subsequent requests for metadata and images to the configured server.
|
||||
---
|
||||
|
||||
# DICOMweb Proxy
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: DICOMweb
|
||||
title: DICOMweb
|
||||
summary: Comprehensive guide to configuring DICOMweb data sources in OHIF, including setting up local DICOM servers (Orthanc, DCM4CHEE), configurations for PDF, video, and bulkdata handling, and detailed instructions for development environments.
|
||||
---
|
||||
|
||||
# DICOMweb
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Introduction
|
||||
title: Data Source Introduction
|
||||
summary: Introduces OHIF's data structure based on naturalized DICOM JSON format, providing an overview of common data sources available in OHIF and how custom data sources can be implemented.
|
||||
---
|
||||
|
||||
# Data Source
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_label: Static Files
|
||||
title: Static DICOMweb Files
|
||||
summary: Details how to use the static-wado project to generate and serve optimized static DICOMweb files for enhanced OHIF Viewer performance, with step-by-step instructions for installation, file generation, and viewer configuration.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Tours
|
||||
title: Configuring Tours in OHIF
|
||||
summary: Guide to implementing interactive guided tours in OHIF using Shepherd.js, including detailed configuration options, step definitions, customization parameters, and examples for creating effective user onboarding experiences.
|
||||
---
|
||||
|
||||
# Configuring Tours in OHIF with Shepherd.js
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: URL
|
||||
title: URL Parameters
|
||||
summary: Reference for OHIF Viewer URL parameters that control WorkList filtering, study/series loading, and viewer behavior, including parameters for filtering by patient name, modality, data sources, specifying initial series/instances, and selecting hanging protocols.
|
||||
---
|
||||
|
||||
# URL
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
sidebar_position: 12
|
||||
sidebar_label: DICOM Conformance Statement
|
||||
title: DICOM Conformance Statement
|
||||
summary: Access information about the OHIF Viewer's compliance with DICOM standards through an open-sourced document provided by Radical Imaging, which details the application's implementation of DICOM protocols and services.
|
||||
---
|
||||
|
||||
You can find a version that has been open sourced by Radical Imaging [in this link](https://docs.google.com/document/d/1hbDlUApX4svX33gAUGxGfD7fXXZNaBsX0hSePbc-hNA/edit?usp=sharing)
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: Auth
|
||||
title: Authorization and Authentication
|
||||
summary: Guide to configuring OpenID-Connect authentication in OHIF Viewer, including setup of authorization flows, token handling, and implementation details for securing access to medical imaging data.
|
||||
---
|
||||
|
||||
# Authorization and Authentication
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
title: Microsoft Azure Integration
|
||||
summary: Comprehensive guide for configuring OHIF with Microsoft Azure Healthcare APIs, including step-by-step instructions for Azure AD registration, DICOM service setup, CORS configuration, and OAuth authentication implementation.
|
||||
---
|
||||
|
||||
# Microsoft Azure
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Build for Production
|
||||
summary: Step-by-step guide to building a production-ready version of the OHIF Viewer, including environment setup, code acquisition, dependency restoration, production build creation, and configuration options for deployment.
|
||||
---
|
||||
|
||||
# Build for Production
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
title: Cross-Origin Resource Sharing
|
||||
summary: Detailed explanation of cross-origin security configurations for OHIF Viewer, covering CORS requirements for data source access, iframe embedding, secure contexts, and troubleshooting techniques for proper implementation.
|
||||
---
|
||||
|
||||
# Cross-Origin Information for OHIF
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Custom URL Access/Build
|
||||
summary: "Instructions for hosting the OHIF Viewer on custom URL paths, with two deployment approaches: simple setup for serving the viewer from a subpath with assets at the root, and advanced setup for custom asset paths with detailed configuration steps."
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Docker Deployment
|
||||
summary: Comprehensive guide for deploying OHIF Viewer using Docker, covering pre-built images from Docker Hub, custom image building, configuration options through build arguments and environment variables, and runtime container management.
|
||||
---
|
||||
|
||||
# Docker
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: SSL
|
||||
title: SSL Configuration for Docker
|
||||
summary: Guide to configuring SSL for OHIF Viewer in Docker deployments, including environment variable setup, certificate mounting, permissions management, and instructions for both CA-signed and self-signed certificate implementation.
|
||||
---
|
||||
|
||||
# SSL
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
title: Google Cloud Healthcare Integration
|
||||
summary: Guide to setting up Google Cloud Healthcare API as a DICOM data source for OHIF, including project creation, API configuration, OAuth authentication setup, and implementation details for connecting the viewer to Google-hosted medical imaging data.
|
||||
---
|
||||
|
||||
# Google Cloud Healthcare
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: iframe
|
||||
title: Embedding OHIF in an iframe
|
||||
summary: Guidelines for embedding OHIF Viewer within other applications using iframe integration, explaining configuration requirements for path settings, static builds, and proper setup to ensure WebWorkers, WASM, and WebGL features function correctly.
|
||||
---
|
||||
|
||||
# iframe
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Overview
|
||||
title: Deployment Overview
|
||||
summary: Comprehensive guide to deploying the OHIF Viewer as a standalone web application or embedded iframe, covering data source configuration, security considerations, and various deployment options with examples for different hosting environments.
|
||||
---
|
||||
|
||||
# Deployment
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
title: Nginx + Image Archive Setup
|
||||
summary: Tutorial for setting up OHIF Viewer with Nginx and PACS (Orthanc or DCM4CHEE), using Docker for a production-ready system with reverse proxy configuration to securely handle medical imaging data, including installation steps and troubleshooting tips.
|
||||
---
|
||||
|
||||
# Nginx + Image Archive
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Deploy Static Assets
|
||||
summary: Guide to deploying OHIF Viewer static assets using various hosting options, from simple drag-and-drop methods like Netlify to more advanced cloud platforms like AWS, GCP, and Azure, with step-by-step instructions for each deployment approach.
|
||||
---
|
||||
|
||||
# Deploy Static Assets
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
title: User Account Control
|
||||
summary: Comprehensive guide for implementing user authentication in OHIF using Keycloak, covering setup with both Orthanc and DCM4CHEE, configuration with OAuth2 proxy, SSL implementation, and detailed steps for local and production deployment scenarios.
|
||||
---
|
||||
# User Account Control
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
sidebar_label: Android & iOS Debugging
|
||||
title: Android & iOS Debugging
|
||||
summary: Comprehensive guide for debugging OHIF Viewer on mobile devices, covering setup of Android and iOS emulators, step-by-step instructions for connecting Chrome DevTools and Safari Web Inspector, and video tutorials demonstrating the debugging workflow.
|
||||
---
|
||||
|
||||
# Android & iOS Debugging for OHIF using Emulators
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Architecture
|
||||
title: OHIF Architecture
|
||||
summary: Detailed explanation of OHIF Viewer's architecture, covering the platform's core components, extensions system, modes concept, and the relationships between these elements that enable building flexible and extensible medical imaging applications.
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
sidebar_label: Continuous Integration
|
||||
title: Continuous Integration
|
||||
summary: Overview of OHIF's CI/CD setup using CircleCI and Netlify, detailing workflows for pull request checks, optional Docker image publishing, deployment to development/staging/production environments, and the release process for npm packages and documentation.
|
||||
---
|
||||
|
||||
# Continuous Integration (CI)
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_label: Contributing
|
||||
title: Contributing to OHIF
|
||||
summary: Guidelines for contributing to the OHIF project, including best practices for submitting pull requests, working with multiple repositories, and advice on creating changes that are more likely to be accepted by the core team.
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Getting Started
|
||||
title: Getting Started with OHIF Development
|
||||
summary: Quick start guide for OHIF development, covering repository setup options, branch organization, development environment requirements, project initialization, and steps for building production-ready assets.
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: Local Linking
|
||||
title: Local Library Linking
|
||||
summary: Brief introduction to the concept of local linking for library development in OHIF, explaining how to test libraries in application context before publishing, with reference to Cornerstonejs linking documentation.
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: OHIF CLI
|
||||
title: OHIF Command Line Interface
|
||||
summary: Comprehensive guide to the OHIF CLI tool for managing extensions and modes, including commands for creating, linking, adding, removing, and publishing components, with detailed examples and explanations of the underlying configuration system.
|
||||
---
|
||||
|
||||
# OHIF Command Line Interface
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: Issue & PR Triage Process
|
||||
title: OHIF Development Process
|
||||
summary: Detailed explanation of OHIF's issue triage, backlog management, contribution evaluation, and release processes, including categorization of issues, pull request workflow, quality assurance procedures, and continuous integration practices.
|
||||
---
|
||||
|
||||
# Our Process
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
sidebar_label: Playwright Testing
|
||||
title: Playwright End-to-End Testing
|
||||
summary: Guide to writing and running end-to-end tests for OHIF Viewer using Playwright, covering test configuration, screenshot verification, simulating user interactions, accessing application services, and using the VSCode extension for test recording.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: Testing
|
||||
title: Testing OHIF
|
||||
summary: Comprehensive guide to OHIF's testing approach, covering unit tests and end-to-end tests with detailed instructions for running them, explanation of test data management, and an overview of the project's testing philosophy and best practices.
|
||||
---
|
||||
|
||||
# Running Tests for OHIF
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
sidebar_label: Global Types
|
||||
title: Global Types and Service Extensions
|
||||
summary: Guide to using and extending TypeScript types in OHIF applications, focusing on the withAppTypes utility for component typing, adding custom properties, and properly integrating new services into the global namespace for type safety and code completion.
|
||||
---
|
||||
|
||||
# Extending App Types and Services in Your Application
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Video Tutorials
|
||||
title: OHIF Development Video Tutorials
|
||||
summary: Collection of instructional videos demonstrating key OHIF development workflows, including creating, linking, and publishing modes and extensions, with step-by-step demonstrations of the OHIF CLI and NPM publishing process.
|
||||
---
|
||||
|
||||
# Video Tutorials
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
sidebar_label: Web Workers
|
||||
title: Web Workers Implementation Guide
|
||||
summary: Step-by-step guide for implementing web workers in OHIF to handle computationally intensive tasks in background threads, including worker creation, registration, task execution, progress tracking, and best practices for code organization.
|
||||
---
|
||||
# Web Worker Implementation Guide
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
id: general
|
||||
title: General FAQ
|
||||
summary: Answers to common questions about OHIF Viewer, including how to report bugs, request features, contact for support or academic collaborations, regulatory compliance status (FDA/CE/HIPAA), and obtaining sample studies.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
id: index
|
||||
title: OHIF Viewer FAQ
|
||||
summary: Comprehensive list of frequently asked questions about the OHIF Viewer, covering common inquiries about reporting bugs, requesting features, academic collaborations, regulatory status, and obtaining demo studies.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,3 +1,9 @@
|
||||
---
|
||||
id: technical
|
||||
title: Technical FAQ
|
||||
summary: Technical explanations and solutions for OHIF Viewer implementation challenges, including required metadata fields, handling large volumes for MPR/rendering, dynamically loading measurements, customizing series sorting, and addressing common rendering issues.
|
||||
---
|
||||
|
||||
# Technical FAQ
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: 0-general
|
||||
title: General
|
||||
summary: General migration changes from OHIF 3.8 to 3.9, including removing SharedArrayBuffer requirements, React 18 updates, Polyfill removal, webpack changes, scroll utility relocation, Crosshairs improvements, and toolbar button evaluation enhancements.
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: seg-new-arch
|
||||
title: New Architecture
|
||||
summary: Overview of the new viewport-centric segmentation architecture in OHIF 3.9, which replaces the previous toolGroup-centric approach and introduces clearer separation between segmentation data and its visual representation.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: seg-api
|
||||
title: SegmentationService API
|
||||
summary: Detailed guide to the SegmentationService API changes in OHIF 3.9, covering the transition from toolGroup to viewport-centric segmentation management, updates to key methods like getActiveSegmentation, setActiveSegmentation, and addSegment.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: seg-representation
|
||||
title: Segmentation Representations
|
||||
summary: Migration guide for segmentation representation management in OHIF 3.9, explaining the transition from toolGroup-based to viewport-centric representation handling, and introducing the new specifier pattern for more flexible API usage.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: seg-creation
|
||||
title: Segmentation Creation
|
||||
title: Segmentation Creation
|
||||
summary: Migration guide for segmentation creation methods in OHIF 3.9, covering renamed methods like createLabelmapForViewport and createLabelmapForDisplaySet, updated parameter structures, and transition from tool group to viewport-centric approach.
|
||||
---
|
||||
|
||||
## createEmptySegmentationForViewport
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: seg-service-mod
|
||||
title: SegmentationService Modifications
|
||||
summary: Migration guide for segmentation representation management API changes in OHIF 3.9, showing how to transition from tool group-based methods to viewport-centric approaches for adding, removing, and querying segmentation representations.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: seg-style
|
||||
title: SegmentationService Style
|
||||
summary: Migration guide for segmentation styling API changes in OHIF 3.9, covering the transition to viewport-specific visibility controls, new style specification system using the specifier pattern, and updated methods for setting colors and toggling visibility.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: seg-other
|
||||
title: Other Changes
|
||||
summary: Migration guide for additional segmentation service changes in OHIF 3.9, covering updates to addOrUpdateSegmentation with new data structures, loadSegmentationsForViewport, highlightSegment, and jumpToSegmentCenter methods with viewport-centric approach.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
id: segmentation-index
|
||||
title: Segmentation
|
||||
sidebar_position: 1
|
||||
summary: Migration guide for segmentation architecture changes in OHIF 3.9, covering the shift from tool group-centric to viewport-centric architecture to support advanced visualization capabilities and more flexible segmentation handling.
|
||||
---
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
id: 2-renamings
|
||||
title: Renamings
|
||||
sidebar_position: 2
|
||||
summary: Migration guide for renamed components in OHIF 3.9, including the Panel Measurements name change from 'measure' to 'panelMeasurement' and addIcon utility changes to support both UI packages.
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
id: 3-data-sources
|
||||
title: Data Sources
|
||||
sidebar_position: 3
|
||||
summary: Migration guide for BulkDataURI configuration changes in OHIF 3.9, explaining the transition from a simple boolean flag to a more flexible configuration object with additional control options.
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Measurements
|
||||
summary: Migration guide for measurement changes in OHIF 3.9, covering the new structured 'displayText' object with primary and secondary arrays for better organization, and the renaming of 'selected' property to 'isSelected'.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: viewport-action-corner
|
||||
title: ViewportActionCorner
|
||||
summary: Migration guide for ViewportActionCornerService in OHIF 3.9, introducing the new addComponent and addComponents methods that provide more reliable positioning of multiple components within viewport corners.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
id: state-sync-service
|
||||
title: StateSyncService
|
||||
summary: Migration guide for transitioning from StateSyncService to Zustand stores in OHIF 3.9, covering all store types including LutPresentationStore, PositionPresentationStore, ViewportGridStore, and more with examples of old and new API usage.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
id: 6-rtstruct
|
||||
title: RTSTRUCT
|
||||
sidebar_position: 6
|
||||
summary: Migration guide for RT Structure Set rendering in OHIF 3.9, explaining the transition from VTK-based rendering to SVG-based rendering for improved stability and speed while maintaining stack viewports instead of converting to volume viewports.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: UI
|
||||
summary: Migration guide for UI changes in OHIF 3.9, covering the new UI components from @ohif/ui-next, UINotificationService updates with Sonner integration, viewport pane Tailwind class changes, Header component refactoring, and managing both UI libraries.
|
||||
---
|
||||
|
||||
## New Components
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Refactoring
|
||||
summary: Migration guide for refactored components in OHIF 3.9, including the move of PanelSegmentation from cornerstone-dicom-seg extension to cornerstone extension, centralization of dialog utilities, and improved customization ID structure for better modularity.
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Other Changes
|
||||
summary: Migration guide for additional changes in OHIF 3.9, covering external library loading with browserImport function, the pluginConfig.json format for dynamic imports, and improvements to viewport navigation using ViewReference methods.
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
id: 3p8-to-3p9
|
||||
title: 3.8 -> 3.9
|
||||
sidebar_position: 2
|
||||
summary: Migration guide for upgrading from OHIF 3.8 to 3.9, covering segmentation architecture changes, renamings, data sources, measurements, viewport action corners, state sync service, RT structure improvements, UI changes, and other refactorings.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Commands
|
||||
summary: Migration guide for commands in OHIF 3.10, covering the replacement of deleteMeasurement with removeMeasurement and setSourceViewportForReferenceLinesTool with the more generic setViewportForToolConfiguration command.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: General
|
||||
summary: General migration changes from OHIF 3.9 to 3.10, including Node.js version update, HTML template modifications, bundled Google Fonts, docs updates, faster development builds with rsbuild, and webpack configuration changes for AI segmentation support.
|
||||
---
|
||||
|
||||
## Node.js Version Update
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Hotkeys
|
||||
summary: Migration guide for hotkeys management in OHIF 3.10, explaining the transition from defining hotkeys in mode factory to using the customizationService, with examples of replacing, adding, and modifying hotkey bindings.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: routerBaseName
|
||||
summary: Migration guide for router configuration in OHIF 3.10, covering the updated default behavior of routerBasename and its interaction with PUBLIC_URL, with scenario-based examples for both root and subpath hosting.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Customization Service
|
||||
summary: Migration guide for OHIF's Customization Service from 3.9 to 3.10, covering unified customization getters, simplified registration, new commands, renamed customizations, and updated patterns for modifying UI components.
|
||||
---
|
||||
|
||||
# CustomizationService
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Introduction
|
||||
position: 1
|
||||
summary: Introduction to UI changes in OHIF 3.10, covering the migration of the image viewer to the @ohif/ui-next library, a complete rewrite of UI components offering extensibility, accessibility, and a modern design, with guidance on updating custom panels.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Tests
|
||||
summary: Migration guide for test updates in OHIF 3.10, covering changes to how tools are identified and tested, including the transition from class-based to data-attribute-based selection in Cypress tests.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Colors
|
||||
summary: Migration guide for OHIF 3.10's new color system, explaining the transition from custom color names to a semantic color palette using CSS variables, with detailed mapping of old color classes to new Tailwind equivalents.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Icons
|
||||
summary: Migration guide for OHIF 3.10's Icon component updates, covering the transition from @ohif/ui to @ohif/ui-next with new PascalCase naming conventions, legacy fallback options, and a comprehensive renaming table for all icons.
|
||||
---
|
||||
|
||||
## Migration Guide: Icon Component Updates
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Button
|
||||
summary: Migration guide for Button components in OHIF 3.10, explaining the transition from @ohif/ui to @ohif/ui-next, the replacement of ButtonEnums with string-based variants, and changes to IconButton, ButtonGroup, and styling approach.
|
||||
---
|
||||
|
||||
## Key Changes:
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Input
|
||||
summary: Migration guide for input components in OHIF 3.10, covering the transition from Input, InputNumber, InputRange, InputDoubleRange and others to the new Numeric component system and updated input patterns in @ohif/ui-next.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Tooltip
|
||||
summary: Migration guide for Tooltip components in OHIF 3.10, explaining the new composable structure with TooltipTrigger and TooltipContent, and replacement of TooltipClipboard with the Clipboard component.
|
||||
---
|
||||
|
||||
## Tooltip Updates
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Tooltip
|
||||
title: Select
|
||||
summary: Migration guide for Select components in OHIF 3.10, explaining the transition from @ohif/ui to @ohif/ui-next, with details on the new Select.Root, Select.Trigger, Select.Content, and Select.Item structure replacing the old dropdown approach.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Switch
|
||||
summary: Migration guide for Switch component in OHIF 3.10, covering the transition from custom Toggle and CinePlayPauseButton components to the standardized Switch component, with details on prop changes and usage patterns.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Toolbar
|
||||
summary: Migration guide for toolbar components in OHIF 3.10, covering the new uiType values (ohif.toolButton and ohif.toolButtonList), section-based definitions replacing nested structures, ToolBox updates, and changes to tool option handlers.
|
||||
---
|
||||
|
||||
# Toolbar
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Segmentation Table
|
||||
summary: Migration guide for the refactored SegmentationTable component in OHIF 3.10, covering changes to the context system, compound component pattern adoption, replacement of SelectorHeader, and introduction of segment statistics features.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Tours and Onboarding
|
||||
summary: Migration guide for Tours and Onboarding features in OHIF 3.10, explaining the transition from defining tours directly in window.config.tours to using the customization service, enabling mode-specific tours and better organization.
|
||||
---
|
||||
|
||||
## Migration Guide: Tours
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: uiDialogService
|
||||
summary: Migration guide for uiDialogService in OHIF 3.10, covering the transition from create/dismiss to show/hide methods, changes to dialog definition structure, and updates to utility functions like callInputDialog and colorPickerDialog.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: uiModalService
|
||||
summary: Migration guide for the uiModalService in OHIF 3.10, covering props that remain unchanged, renamed props (containerDimensions to containerClassName), removed props (movable, isOpen, contentDimensions), and automatic handling of modal closing.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: 3.9 -> 3.10 beta
|
||||
title: Migration Guide from 3.9 to 3.10 beta
|
||||
summary: Migration guide for upgrading from OHIF 3.9 to 3.10 beta, covering general changes, customization service improvements, UI component upgrades, command handling, hotkey updates, routing changes, and testing strategies.
|
||||
---
|
||||
|
||||
# Migration Guide
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: 3.7 -> 3.8
|
||||
title: Migration Guide from 3.7 to 3.8
|
||||
summary: Migration guide for upgrading from OHIF 3.7 to 3.8, covering changes to toolbar button definitions, active tool handling, button evaluators, tool listeners, leftPanel/rightPanel naming, URL parameters, UI components, and refactoring of enums.
|
||||
---
|
||||
|
||||
# Migration Guide
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: 2.x -> 3.5
|
||||
title: Migration Guide from 2.x to 3.5
|
||||
summary: Comprehensive migration guide for upgrading from OHIF 2.x to 3.5, covering architectural changes, UI improvements, extensions, modes, cornerstone3D integration, configuration changes, and build process updates.
|
||||
---
|
||||
|
||||
# Migration Guide
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
id: index
|
||||
title: Migration Guides Overview
|
||||
summary: Introduction to OHIF migration guides covering the upgrade paths between different versions of the platform, with links to version-specific guides for migrating from one OHIF version to another.
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Browser Support
|
||||
summary: Documentation of OHIF's browser compatibility standards, including supported browsers (IE11, Firefox, Chrome, Safari, Edge), transpilation and polyfill strategies, and development priorities focused on modern evergreen browsers.
|
||||
---
|
||||
# Browser Support
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Environment Variables
|
||||
title: Environment Variables
|
||||
summary: Documentation of the environment variables used in OHIF during build time to configure application behavior, including application settings, internationalization options, and methods for setting these variables.
|
||||
---
|
||||
# Environment Variables
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Extension Manager
|
||||
title: OHIF Extension Manager
|
||||
summary: Documentation for OHIF's ExtensionManager class, which manages the registration and access of extensions, providing methods to retrieve module entries, access data sources, and handle extension configurations.
|
||||
---
|
||||
|
||||
# Extension Manager
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Introduction
|
||||
title: OHIF Extensions Introduction
|
||||
summary: Comprehensive introduction to the OHIF viewer extension system, explaining how extensions provide modular functionality through different module types, and how they're configured and accessed in modes to build customized viewer experiences.
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_label: Installation
|
||||
title: Extension Installation
|
||||
summary: Instructions for installing external OHIF extensions using the OHIF CLI tool, which allows adding both local and published extensions from NPM to the viewer application.
|
||||
---
|
||||
|
||||
# Extension: Installation
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Lifecycle Hooks
|
||||
title: Extension Lifecycle Hooks
|
||||
summary: Documentation for OHIF extension lifecycle hooks including preRegistration, onModeEnter, and onModeExit, which allow extensions to initialize resources, handle mode transitions, and clean up data when needed.
|
||||
---
|
||||
|
||||
# Extensions: Lifecycle Hooks
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Commands
|
||||
title: Commands Module
|
||||
summary: Documentation for OHIF Commands Module, which allows extensions to register functions that can be called by tools, UI components, or hotkeys, with context-specific implementations and flexible command definitions.
|
||||
---
|
||||
# Module: Commands
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: Context
|
||||
title: Context Module
|
||||
summary: Documentation for OHIF Context Module, which enables component communication via React Context, allowing viewport and panel components to share state and synchronize through a common provider mechanism.
|
||||
---
|
||||
# Module: Context
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Data Source
|
||||
title: Data Source Module
|
||||
summary: Documentation for OHIF Data Source Module, which defines ways to fetch and map data into OHIF's native format, covering built-in sources like dicomweb and dicomjson, and explaining how to create custom data sources for proprietary backends.
|
||||
---
|
||||
|
||||
# Module: Data Source
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
sidebar_label: Hanging Protocol
|
||||
title: Hanging Protocol Module
|
||||
summary: Documentation for OHIF Hanging Protocol Module, which controls image arrangement in viewports based on matching rules, with capabilities for layout configuration, viewport settings, synchronization, and advanced study comparison workflows.
|
||||
---
|
||||
# Module: Hanging Protocol
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: Layout Template
|
||||
title: Layout Template Module
|
||||
summary: Documentation for OHIF Layout Template Module, which defines the structural organization of the viewer interface, controlling toolbar positioning, panel arrangement, and viewport grid placement through React components.
|
||||
---
|
||||
|
||||
# Module: Layout Template
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: Panel
|
||||
title: Panel Module
|
||||
summary: Documentation for OHIF Panel Module, which provides UI components for the application's side panels, allowing extensions to contribute content that appears in left and right sidebars with proper event triggering and state management.
|
||||
---
|
||||
|
||||
# Module: Panel
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: SOP Class Handler
|
||||
title: SOP Class Handler Module
|
||||
summary: Documentation for OHIF SOP Class Handler Module, which processes specific DICOM SOP classes into displayable sets, supporting various medical imaging formats and defining how different types of DICOM data are prepared for viewing.
|
||||
---
|
||||
# Module: SOP Class Handler
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Toolbar
|
||||
title: Toolbar Module
|
||||
summary: Documentation for OHIF Toolbar Module, which provides UI components and evaluators for the application's toolbar, supporting custom button types, advanced state management, and conditional rendering based on viewport and modality requirements.
|
||||
---
|
||||
|
||||
# Module: Toolbar
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_label: Utility
|
||||
title: Utility Module
|
||||
summary: Documentation for OHIF Utility Module, which exposes reusable functionality from one extension to others, allowing for sharing of internal methods, services, and enumerations across the application architecture.
|
||||
---
|
||||
|
||||
# Module: Utility
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
sidebar_label: Viewport
|
||||
title: Viewport Module
|
||||
summary: Documentation for OHIF Viewport Module, which provides React components that consume displaySets for viewing medical images and documents, with examples of 2D image viewing, structured reports, PDFs, and performance optimization techniques.
|
||||
---
|
||||
|
||||
# Module: Viewport
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Internationalization
|
||||
title: Internationalization
|
||||
summary: Documentation of OHIF's internationalization (i18n) implementation, including how to change languages, extend existing languages, add new languages, and contribute translations, using the @ohif/i18n package powered by i18next.
|
||||
---
|
||||
|
||||
# Viewer: Internationalization
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Commands Manager
|
||||
title: Commands Manager
|
||||
summary: Documentation for the CommandsManager class which tracks named functions scoped to specific contexts, allowing OHIF to execute commands with appropriate context prioritization across the application.
|
||||
---
|
||||
# Commands Manager
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Extension Manager
|
||||
title: Extension Manager
|
||||
summary: Documentation for the ExtensionManager class which aggregates and exposes extension modules throughout the OHIF application, manages data sources, and provides a centralized registry for accessing extension functionality.
|
||||
---
|
||||
|
||||
# Extension Manager
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user