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

docs(spelling): Add codespell config + github action, run and fix a good number of typos (#3645)

Browse Source
This commit is contained in:
Yaroslav Halchenko authored and GitHub committed 2023-09-12 07:40:38 -04:00
1 parent 64079e0720
commit 11ca5b6eae
76 files changed
+128 -100
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

platform/docs/docs/README.md
+1 -1
View File
@@ -18,7 +18,7 @@ Key features:
Offers a Data Source API for communicating with archives over proprietary API
formats.
- Provides a plugin framework for creating task-based workflow modes which can
re-use core functionality.
reuse core functionality.
- Beautiful user interface (UI) designed with extensibility in mind. UI
components available in a reusable component library built with React.js and
Tailwind CSS
platform/docs/docs/configuration/configurationFiles.md
+2 -2
View File
@@ -117,7 +117,7 @@ Here are a list of some options available:
decoding. Defaults to minimum of `navigator.hardwareConcurrency` and
what is specified by `maxNumberOfWebWorkers`. Some windows machines require smaller values.
- `acceptHeader` : accept header to request specific dicom transfer syntax ex : [ 'multipart/related; type=image/jls; q=1', 'multipart/related; type=application/octet-stream; q=0.1' ]
- `requestTransferSyntaxUID` : Request a specific Tansfer syntax from dicom web server ex: 1.2.840.10008.1.2.4.80 (applyed only if acceptHeader is not set)
- `requestTransferSyntaxUID` : Request a specific Tansfer syntax from dicom web server ex: 1.2.840.10008.1.2.4.80 (applied only if acceptHeader is not set)
- `omitQuotationForMultipartRequest`: Some servers (e.g., .NET) require the `multipart/related` request to be sent without quotation marks. Defaults to `false`. If your server doesn't require this, then setting this flag to `true` might improve performance (by removing the need for preflight requests). Also note that
if auth headers are used, a preflight request is required.
- `maxNumRequests`: The maximum number of requests to allow in parallel. It is an object with keys of `interaction`, `thumbnail`, and `prefetch`. You can specify a specific number for each type.
@@ -178,7 +178,7 @@ if auth headers are used, a preflight request is required.
- `dangerouslyUseDynamicConfig`: Dynamic config allows user to pass `configUrl` query string. This allows to load config without recompiling application. If the `configUrl` query string is passed, the worklist and modes will load from the referenced json rather than the default .env config. If there is no `configUrl` path provided, the default behaviour is used and there should not be any deviation from current user experience.<br/>
Points to consider while using `dangerouslyUseDynamicConfig`:<br/>
- User have to enable this feature by setting `dangerouslyUseDynamicConfig.enabled:true`. By default it is `false`.
- Regex helps to avoid easy exploit. Dafault is `/.*/`. Setup your own regex to choose a specific source of configuration only.
- Regex helps to avoid easy exploit. Default is `/.*/`. Setup your own regex to choose a specific source of configuration only.
- System administrators can return `cross-origin: same-origin` with OHIF files to disallow any loading from other origin. It will block read access to resources loaded from a different origin to avoid potential attack vector.
- Example config:
```js
platform/docs/docs/configuration/url.md
+1 -1
View File
@@ -109,7 +109,7 @@ You can open more than one study in the Viewer by adding the `StudyInstanceUIDs`
:::tip
You can ues this feature to open a current and prior study in the Viewer.
You can use this feature to open a current and prior study in the Viewer.
Read more in the [Hanging Protocol Module](../platform/extensions/modules/hpModule.md#matching-on-prior-study-with-uid) section. You can also use commas to separate
values.
platform/docs/docs/deployment/docker.md
+1 -1
View File
@@ -239,7 +239,7 @@ To create a self-signed certificate:
|Country Name (2 letter code) [AU]|
|State or Province Name (full name) [Some-State]|
|Locality Name (eg, city) []|
|Organization Name (eg, company) [Internet Widgits Pty Ltd]|
|Organization Name (eg, company) [Internet Widgets Pty Ltd]|
|Organizational Unit Name (eg, section) []|
|Common Name (e.g. server FQDN or YOUR name) []|
|Email Address []|
platform/docs/docs/deployment/index.md
+2 -2
View File
@@ -93,7 +93,7 @@ support it yet, but it is gaining wider adoption.
If you have an existing archive and intend to host the OHIF Viewer at the same
domain name as your archive, then connecting the two is as simple as following
the steps layed out in our
the steps laid out in our
[Configuration Essentials Guide](./../configuration/configurationFiles.md).
#### What if I don't have an imaging archive?
@@ -297,7 +297,7 @@ You can find an example of this setup in our
In general, we recommend using the "Authorization Code Flow" ( [see
`response_type=code` here][code-flows]); however, the "Implicit Flow" ( [see
`response_type=token` here][code-flows]) can work if additonal precautions are
`response_type=token` here][code-flows]) can work if additional precautions are
taken. If the flow you've chosen produces a JWT Token, it's validity can be used
to secure access to your Image Archive as well.
platform/docs/docs/development/continous-integration.md → platform/docs/docs/development/continuous-integration.md
View File
File renamed without changes.
platform/docs/docs/development/our-process.md
+1 -1
View File
@@ -101,7 +101,7 @@ quality and test coverage must not be changed by a significant margin. For some
repositories, visual screenshot-based tests are also included, and video
recordings of end-to-end tests are stored for later review.
[You can read more about our continous integration efforts here](/development/continous-integration.md)
[You can read more about our continuous integration efforts here](/development/continuous-integration.md)
## Releases
platform/docs/docs/migration-guide.md
+1 -1
View File
@@ -935,7 +935,7 @@ We have gone through extensive re-design of each part of the UI, and we have als
<details>
<summary>
I have a huge complex styles using native CSS, how can I re-use them?
I have a huge complex styles using native CSS, how can I reuse them?
</summary>
You can leverage the power of Tailwind CSS (https://TailwindCSS.com/) in OHIF v3 to reuse your existing styles. Tailwind CSS is a utility-first approach, allowing you to create reusable CSS classes by composing utility classes together. You can migrate your existing styles to Tailwind CSS by breaking them down into utility classes and utilizing the extensive set of predefined utilities provided by Tailwind CSS.
platform/docs/docs/platform/extensions/index.md
+3 -3
View File
@@ -51,7 +51,7 @@ export default {
*/
id,
// Lifecyle
// Lifecycle
preRegistration() { /* */ },
onModeEnter() { /* */ },
onModeExit() { /* */ },
@@ -182,7 +182,7 @@ Use the provided `cli` to add/remove/install/uninstall extensions. Read more [he
The final registration and import of the extensions happen inside a non-tracked file `pluginImport.js` (this file is also for internal use only).
After an extension gets registered withing the `viewer`,
After an extension gets registered within the `viewer`,
each [module](#modules) defined by the extension becomes available to the modes
via the `ExtensionManager` by requesting it via its id.
[Read more about Extension Manager](#extension-manager)
@@ -206,7 +206,7 @@ used to initialize data.
[`onModeExit`](./lifecycle#onModeExit): Similarly to onModeEnter, this hook is
called when navigating away from a mode, or before a mode’s data or datasource
is changed. This can be used to cache data for re-use later, but since it
is changed. This can be used to cache data for reuse later, but since it
isn't known which mode will be entered next, the state after exiting should be
clean, that is, the same as the state on a clean start. This is called BEFORE
service clean up, and after mode specific onModeExit handling.
platform/docs/docs/platform/extensions/modules/layout-template.md
+1 -1
View File
@@ -120,7 +120,7 @@ function ViewerLayout({
commandsManager={commandsManager}
/>
{/* Rigth SIDEPANELS */}
{/* Right SIDEPANELS */}
<SidePanel
side="right"
defaultComponentOpen={rightPanelComponents[0].name}
platform/docs/docs/platform/internationalization.md
+2 -2
View File
@@ -182,7 +182,7 @@ the following file tree:
index.js
| UK
|-- Buttons.js
indes.js
index.js
| US
|-- Buttons.js
index.js
@@ -347,7 +347,7 @@ https://viewer.ohif.org/viewer/1.2.840.113619.2.5.1762583153.215519.978957063.78
Chinese:
https://viewer.ohif.org/viewer/1.2.840.113619.2.5.1762583153.215519.978957063.78?lng=zh
Portugese:
Portuguese:
https://viewer.ohif.org/viewer/1.2.840.113619.2.5.1762583153.215519.978957063.78?lng=pt-BR
Here are some links you can use to sign up to help translate. All you have to do
platform/docs/docs/platform/modes/index.md
+1 -1
View File
@@ -191,7 +191,7 @@ export default mode;
### Consuming Extensions
As mentioned in the [Extensions](../extensions/index.md) section, in `OHIF-v3`
developers write their extensions to create re-usable functionalities that later
developers write their extensions to create reusable functionalities that later
can be used by `modes`. Now, it is time to describe how the registered
extensions will get utilized for a workflow mode via its `id`.
platform/docs/docs/platform/services/data/HangingProtocolService.md
+3 -3
View File
@@ -45,7 +45,7 @@ export default function getHangingProtocolModule() {
}
```
Within the protocol itself, the structure is layed out as described in the HangingProtocol.ts
Within the protocol itself, the structure is laid out as described in the HangingProtocol.ts
type definition, starting with `Protocol`. See the type definition for more details.
## Events
@@ -71,7 +71,7 @@ the stage activate. The status values are:
* enabled - meaning that the stage is fully applicable
* passive - meaning that the stage can be applied, but might be missing details
* disabled - meaning that the study has insuffient information for this stage
* disabled - meaning that the study has insufficient information for this stage
The default values for no `stageActivation` are to assume that `enabled` has `minViewports` of 1,
and `passive` has `minViewports=0`. That is, enable the stage if at least one
@@ -118,7 +118,7 @@ stageActivation: {
stable as to exactly what this returns, as internal details can change.
- `getState`: Returns the currently applied protocol ID, stage index and active study UID.
This information is storable/useable as state information to be used elsewhere.
This information is storable/usable as state information to be used elsewhere.
- `getDefaultProtocol`: Returns the default protocol to apply.
platform/docs/docs/platform/services/data/StateSyncService.md
+1 -1
View File
@@ -47,7 +47,7 @@ grid store state as a modal state.
```
### getState
The `getState` call returns an object containing all of the reigstered states,
The `getState` call returns an object containing all of the registered states,
by id. The values can be read directly, but should not be modified.
### reduce
platform/docs/docs/platform/services/ui/customization-service.md
+3 -3
View File
@@ -43,7 +43,7 @@ automatically when the extension or mode is loaded.
In the `value` of each customizations, you will define customization prototype(s).
These customization prototype(s) can be considered like "Prototype" in Javascript.
These can be used to extend the customization definitions from configurations.
Default cutomizations will be often used to define all the customization prototypes,
Default customizations will be often used to define all the customization prototypes,
as they will be loaded automatically along with the defining extension or mode.
@@ -178,7 +178,7 @@ onModeEnter() {
customizationType: 'ohif.cornerstoneOverlay',
// The cornerstoneOverlay definition requires an items list here.
items: [
// Custom definitions for hte context menu here.
// Custom definitions for the context menu here.
],
};
customizationService.addModeCustomizations(bottomRight);
@@ -285,7 +285,7 @@ uses it's own internal class names.
* Name: 'class:StudyBrowser'
* Attributes:
** `true` for the is active true text color
** `false` fo rhte is active false text color.
** `false` for the is active false text color.
** Values are button colors, from the Button class, eg default, white, black
## customRoutes
platform/docs/docs/release-notes.md
+2 -2
View File
@@ -84,10 +84,10 @@ Check out the complete press announcement [here](https://ohif.org/newsletters/20
- New UI components have been built with Tailwind CSS
- Addition of workflow modes
- Often, medical imaging use cases involves lots of specific workflows that
re-use functionalities. We have added the capability of workflow modes, that
reuse functionalities. We have added the capability of workflow modes, that
enable people to customize user interface and configure application for
specific workflow.
- The idea is to re-use the functionalities that extensions provide and create
- The idea is to reuse the functionalities that extensions provide and create
a workflow. Brain segmentation workflow is different from prostate
segmentation in UI for sure; however, they share the segmentation tools that
can be re-used.
platform/docs/docs/resources.md
+1 -1
View File
@@ -21,7 +21,7 @@ Free, Open Source Tools for Research: MONAI and OHIF Viewer
We participated in the 38th Project Week with three projects around OHIF. [[Website](https://projectweek.na-mic.org/PW38_2023_GranCanaria/)]
- PolySeg representations for OHIF Viewer ([link](https://projectweek.na-mic.org/PW38_2023_GranCanaria/Projects/OHIF_PolySeg/))
- Cross study sychronizer for OHIF Crosshair ([link](https://projectweek.na-mic.org/PW38_2023_GranCanaria/Projects/OHIF_SyncCrosshair/))
- Cross study synchronizer for OHIF Crosshair ([link](https://projectweek.na-mic.org/PW38_2023_GranCanaria/Projects/OHIF_SyncCrosshair/))
- DATSCAN Viewer implementation in OHIF ([link](https://projectweek.na-mic.org/PW38_2023_GranCanaria/Projects/OHIF_DATSCAN/))