Skip to content

Commit 1a751e4

Browse files
dynamsoft-hdynamsoft-h
authored
Preview (#112)
* fix: links and redirect rules (#110) * fix: MDS redirects * fix: use relative redirect links * Staging (#111) * fix: use different link due to section loading order * fix: add more descriptions and links for self hosting
1 parent 392b956 commit 1a751e4

File tree

9 files changed

+50
-50
lines changed

9 files changed

+50
-50
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Mobile-Web-Capture-Docs
1+
# Mobile-Document-Scanner-Docs

‎_config.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
repository: dynamsoft-docs/mobile-web-capture-docs
2-
repositoryUrl: https://github.com/dynamsoft-docs/mobile-web-capture-docs/blob/main
1+
repository: dynamsoft-docs/mobile-document-scanner-docs
2+
repositoryUrl: https://github.com/dynamsoft-docs/mobile-document-scanner-docs/blob/main
33
docFullPath: https://www.dynamsoft.com/mobile-document-scanner/docs/web
44
firstLevelUrl: /mobile-document-scanner/docs/web
55
docHomePage: /mobile-document-scanner/docs/web/introduction/

‎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

‎code-gallery/mobile-web-capture/api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ interface DocumentViewConfig {
305305

306306
By default, the `DocumentView` displays the following when empty:
307307

308-
![Empty Document View](https://www.dynamsoft.com/mobile-web-capture/docs/assets/imgs/empty-document-view.png)
308+
![Empty Document View]({{ site.assets }}imgs/empty-document-view.png)
309309

310310
You can customize its appearance using the [`emptyContentConfig`](#emptycontentconfig) property.
311311

‎code-gallery/mobile-web-capture/customization-guide.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Mobile Document Scanner JS Edition User Guide
1111
# How to Customize Mobile Web Capture
1212

1313
> [!TIP]
14-
> Prerequisites: read the [MWC Getting Started Guide]({{ site.guide }}mobile-web-capture/index.html) before proceeding.
14+
> Prerequisites: read the [MWC Getting Started Guide]({{ site.code-gallery }}mobile-web-capture/index.html) before proceeding.
1515
1616
This guide expands on the **Hello World** sample from the **MWC Getting Started Guide** and explores the available customization options.
1717

@@ -146,8 +146,8 @@ document.getElementById("initialFile").onchange = async function () {
146146
```
147147

148148
API Reference:
149-
- [`hasLaunched`]({{ site.code-gallery }}}mobile-web-capture/.html#haslaunched)
150-
- [`dispose`]({{ site.api }}mobile-web-capture.html#dispose)
149+
- [`hasLaunched`]({{ site.code-gallery }}}mobile-web-capture/api.html#haslaunched)
150+
- [`dispose`]({{ site.code-gallery }}}mobile-web-capture/api.html#dispose)
151151

152152
### Scan Directly to Document
153153

‎code-gallery/mobile-web-capture/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Alternatively, the script can be referenced from a CDN:
186186
**MWC** wraps all its dependency scripts, so a **MWC** project only needs to include **MWC** itself as a single script. No additional dependency scripts are required.
187187
188188
> [!IMPORTANT]
189-
> 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-Hosting Resource File]({{ site.guide }}mobile-web-capture/customization-guide.html#self-hosting-resource-files).
189+
> 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-Hosting Resource File]({{ site.code-gallery }}mobile-web-capture/customization-guide.html#self-hosting-resource-files).
190190
191191
### Instantiate MWC
192192
@@ -197,7 +197,7 @@ const mobileWebCapture = new Dynamsoft.MobileWebCapture({
197197
});
198198
```
199199
200-
API Reference: [`MobileWebCapture()`](https://www.dynamsoft.com/mobile-web-capture/docs/api/mobile-web-capture.html#mobilewebcapture)
200+
API Reference: [`MobileWebCapture()`]({{ site.code-gallery }}}mobile-web-capture/api.html#mobilewebcapture)
201201
202202
This step creates the **MWC** UI, which, when launched, occupies the entire visible area of the browser window by default. If needed, you can specify a container to restrict the UI's size. For more details, refer to [Specify the UI Container]({{ site.code-gallery }}mobile-web-capture/customization-guide.html#example-1-specify-the-ui-container).
203203
@@ -211,7 +211,7 @@ const fileName = `New_Document_${Date.now().toString().slice(-5)}`; // Generates
211211
await mobileWebCapture.launch(fileName);
212212
```
213213
214-
API Reference: [`launch()`](https://www.dynamsoft.com/mobile-web-capture/docs/api/mobile-web-capture.html#launch)
214+
API Reference: [`launch()`]({{ site.code-gallery }}}mobile-web-capture/api.html#launch)
215215
216216
This step launches the UI, starting in **`DocumentView`**, where the user can begin building a document in two ways:
217217

‎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

‎release-notes/mobile-web-capture.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The most notable improvement in this version is the pluggable scanner feature. T
1919
### Features
2020

2121
1. Add Pluggable Scanner feature which integrates any scanner satisfying the following:
22-
1. Implements the [`MWCScanner`](https://www.dynamsoft.com/mobile-web-capture/docs/api/mobile-web-capture.html#mwcscanner) interface
22+
1. Implements the [`MWCScanner`]({{ site.code-gallery }}}mobile-web-capture/api.html#mwcscanner) interface
2323
2. Implements a `launch()` method to return a result that includes:
2424
1. `_imageData` with a `toBlob()` function
2525
2. `imageData: true`

0 commit comments

Comments
 (0)