Skip to content

Commit 48799e9

Browse files
dynamsoft-hdynamsoft-h
authored
Staging (#111)
* fix: use different link due to section loading order * fix: add more descriptions and links for self hosting
1 parent 2680f74 commit 48799e9

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

‎api/index.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,16 @@ interface DocumentScannerConfig {
119119

120120
#### Properties
121121

122-
| Property | Type | Description |
123-
| ----------------------- | --------------------------------------------------------------- | --------------------------------------------------------- |
124-
| `license` | `string` | The license key for using the `DocumentScanner`. |
125-
| `container` | ``HTMLElement | string`` | The container element or selector for the `DocumentScanner` UI. |
126-
| `scannerViewConfig` | [`DocumentScannerViewConfig`](#documentscannerconfig) | Configuration settings for the scanner view. |
127-
| `resultViewConfig` | [`DocumentResultViewConfig`](#documentresultviewconfig) | Configuration settings for the result view. |
128-
| `correctionViewConfig` | [`DocumentCorrectionViewConfig`](#documentcorrectionviewconfig) | Configuration settings for the correction view. |
129-
| `templateFilePath` | `string` | The file path to the document template used for scanning. |
130-
| `utilizedTemplateNames` | [`UtilizedTemplateNames`](#utilizedtemplatenames) | Specifies detection and correction templates. |
131-
| `engineResourcePaths` | [`EngineResourcePaths`](#engineresourcepaths) | Paths to the necessary resources for the scanning engine. |
122+
| Property | Type | Description |
123+
| ----------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
124+
| `license` | `string` | The license key for using the `DocumentScanner`. |
125+
| `container` | ``HTMLElement | string`` | The container element or selector for the `DocumentScanner` UI. |
126+
| `scannerViewConfig` | [`DocumentScannerViewConfig`](#documentscannerconfig) | Configuration settings for the scanner view. |
127+
| `resultViewConfig` | [`DocumentResultViewConfig`](#documentresultviewconfig) | Configuration settings for the result view. |
128+
| `correctionViewConfig` | [`DocumentCorrectionViewConfig`](#documentcorrectionviewconfig) | Configuration settings for the correction view. |
129+
| `templateFilePath` | `string` | The file path to the document template used for scanning. You may set custom paths to self-host the template, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details. |
130+
| `utilizedTemplateNames` | [`UtilizedTemplateNames`](#utilizedtemplatenames) | Specifies detection and correction templates. You may set custom names to self-host resources, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details. |
131+
| `engineResourcePaths` | [`EngineResourcePaths`](#engineresourcepaths) | Paths to the necessary resources for the scanning engine. You may set custom paths to self-host resources, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details. |
132132

133133
#### Example
134134
```typescript
@@ -170,18 +170,18 @@ interface DocumentScannerViewConfig {
170170

171171
#### Properties
172172

173-
| Property | Type | Description |
174-
| --------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------- |
175-
| `templateFilePath` | `string` | Path to a Capture Vision template for scanning configuration. |
176-
| `cameraEnhancerUIPath` | `string` | Path to the UI (`.html` template file) for the scanner view. |
177-
| `container` | `HTMLElement` | The container element for the scanner view. |
178-
| `utilizedTemplateNames` | `[`UtilizedTemplateNames`](#utilizedtemplatenames)` | Capture Vision template names for detection and correction. |
179-
| `enableAutoCropMode` | `boolean` | The default auto-crop mode state. |
180-
| `enableSmartCaptureMode` | `boolean` | The default smart capture mode state. |
181-
| `scanRegion` | [`ScanRegion`](#scanregion) | Defines the region within the viewport to detect documents. |
182-
| `minVerifiedFramesForAutoCapture` | `number` | The minimum number of camera frames to detect document boundaries on Smart Capture mode. |
183-
| `showSubfooter` | `boolean` | Mode selector menu visibility. |
184-
| `showPoweredByDynamsoft` | `boolean` | Visibility of the Dynamsoft branding message. |
173+
| Property | Type | Description |
174+
| --------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
175+
| `templateFilePath` | `string` | Path to a Capture Vision template for scanning configuration. |
176+
| `cameraEnhancerUIPath` | `string` | Path to the UI (`.html` template file) for the scanner view. You may set custom paths to self-host or customize the template, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details. |
177+
| `container` | `HTMLElement` | The container element for the scanner view. |
178+
| `utilizedTemplateNames` | `[`UtilizedTemplateNames`](#utilizedtemplatenames)` | Capture Vision template names for detection and correction. |
179+
| `enableAutoCropMode` | `boolean` | The default auto-crop mode state. |
180+
| `enableSmartCaptureMode` | `boolean` | The default smart capture mode state. |
181+
| `scanRegion` | [`ScanRegion`](#scanregion) | Defines the region within the viewport to detect documents. |
182+
| `minVerifiedFramesForAutoCapture` | `number` | The minimum number of camera frames to detect document boundaries on Smart Capture mode. |
183+
| `showSubfooter` | `boolean` | Mode selector menu visibility. |
184+
| `showPoweredByDynamsoft` | `boolean` | Visibility of the Dynamsoft branding message. |
185185

186186
#### Example
187187

@@ -425,7 +425,7 @@ interface UtilizedTemplateNames {
425425

426426
### `EngineResourcePaths`
427427

428-
Paths to extra resources such as `.wasm` engine files. The default paths point to CDNs and so may be left unset. You may set custom paths for the purpose of [self-hosting resources]({{ site.code-gallery }}mobile-web-capture/customization-guide.html#self-hosting-resource-files).
428+
Paths to extra resources such as `.wasm` engine files. The default paths point to CDNs and so may be left unset. You may set custom paths to self-host resources, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details.
429429

430430
#### Syntax
431431

‎guide/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Alternatively, you can use other methods like `IIS` or `Apache` to serve the pro
185185
186186
### Self-Host Resources
187187
188-
By default, the MDS library (whether pre-compiled or self-compiled) fetches resource files (Dynamsoft `node` dependencies and an HTML UI template) from CDNs. Self-hosting library resources gives you full control over hosting your application. Rather than using CDNs to serve these resources, you can instead host these resources on your own servers to deliver to your users directly when they use your application.
188+
By default, the MDS library (whether pre-compiled or self-compiled) fetches resource files (Dynamsoft `node` dependencies and an HTML UI template) from CDNs. Self-hosting library resources gives you full control over hosting your application. Rather than using CDNs to serve these resources, you can instead host these resources on your own servers to deliver to your users directly when they use your application. You can also use this option to host MDS fully offline by pointing to local resources.
189189
190190
#### Download Resources
191191
@@ -339,7 +339,7 @@ Alternatively, the script can be referenced from a CDN:
339339
**MDS** wraps all its dependency scripts, so a **MDS** project only needs to include **MDS** itself as a single script. No additional dependency scripts are required.
340340
341341
> [!WARNING]
342-
> Even if you reference the script locally, supporting resources like `.wasm` engine files are still loaded from the CDN at runtime. If you require a **fully offline setup**, follow the instructions in [Self-Host Resources](#self-host-resources).
342+
> Even if you reference the script locally, supporting resources like `.wasm` engine files are still loaded from the CDN at runtime. If you require a **fully offline setup**, follow the [quick start instructions to self-host resources](#quick-start).
343343
344344
### Instantiate MDS
345345

0 commit comments

Comments
 (0)