Skip to content

Preview #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dynamsoft-h merged 4 commits into from
Jul 22, 2025
Merged

Preview #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e904bd
fix: links and redirect rules (#110)
dynamsoft-h Jul 4, 2025
5dfc6c7
fix: MDS redirects
dynamsoft-h Jul 16, 2025
2680f74
fix: use relative redirect links
dynamsoft-h Jul 16, 2025
48799e9
Staging (#111)
dynamsoft-h Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Mobile-Web-Capture-Docs
# Mobile-Document-Scanner-Docs
4 changes: 2 additions & 2 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
repository: dynamsoft-docs/mobile-web-capture-docs
repositoryUrl: https://github.com/dynamsoft-docs/mobile-web-capture-docs/blob/main
repository: dynamsoft-docs/mobile-document-scanner-docs
repositoryUrl: https://github.com/dynamsoft-docs/mobile-document-scanner-docs/blob/main
docFullPath: https://www.dynamsoft.com/mobile-document-scanner/docs/web
firstLevelUrl: /mobile-document-scanner/docs/web
docHomePage: /mobile-document-scanner/docs/web/introduction/
Expand Down
46 changes: 23 additions & 23 deletions api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,16 +119,16 @@ interface DocumentScannerConfig {

#### Properties

| Property | Type | Description |
| ----------------------- | --------------------------------------------------------------- | --------------------------------------------------------- |
| `license` | `string` | The license key for using the `DocumentScanner`. |
| `container` | ``HTMLElement | string`` | The container element or selector for the `DocumentScanner` UI. |
| `scannerViewConfig` | [`DocumentScannerViewConfig`](#documentscannerconfig) | Configuration settings for the scanner view. |
| `resultViewConfig` | [`DocumentResultViewConfig`](#documentresultviewconfig) | Configuration settings for the result view. |
| `correctionViewConfig` | [`DocumentCorrectionViewConfig`](#documentcorrectionviewconfig) | Configuration settings for the correction view. |
| `templateFilePath` | `string` | The file path to the document template used for scanning. |
| `utilizedTemplateNames` | [`UtilizedTemplateNames`](#utilizedtemplatenames) | Specifies detection and correction templates. |
| `engineResourcePaths` | [`EngineResourcePaths`](#engineresourcepaths) | Paths to the necessary resources for the scanning engine. |
| Property | Type | Description |
| ----------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `license` | `string` | The license key for using the `DocumentScanner`. |
| `container` | ``HTMLElement | string`` | The container element or selector for the `DocumentScanner` UI. |
| `scannerViewConfig` | [`DocumentScannerViewConfig`](#documentscannerconfig) | Configuration settings for the scanner view. |
| `resultViewConfig` | [`DocumentResultViewConfig`](#documentresultviewconfig) | Configuration settings for the result view. |
| `correctionViewConfig` | [`DocumentCorrectionViewConfig`](#documentcorrectionviewconfig) | Configuration settings for the correction view. |
| `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. |
| `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. |
| `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. |

#### Example
```typescript
Expand Down Expand Up @@ -170,18 +170,18 @@ interface DocumentScannerViewConfig {

#### Properties

| Property | Type | Description |
| --------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `templateFilePath` | `string` | Path to a Capture Vision template for scanning configuration. |
| `cameraEnhancerUIPath` | `string` | Path to the UI (`.html` template file) for the scanner view. |
| `container` | `HTMLElement` | The container element for the scanner view. |
| `utilizedTemplateNames` | `[`UtilizedTemplateNames`](#utilizedtemplatenames)` | Capture Vision template names for detection and correction. |
| `enableAutoCropMode` | `boolean` | The default auto-crop mode state. |
| `enableSmartCaptureMode` | `boolean` | The default smart capture mode state. |
| `scanRegion` | [`ScanRegion`](#scanregion) | Defines the region within the viewport to detect documents. |
| `minVerifiedFramesForAutoCapture` | `number` | The minimum number of camera frames to detect document boundaries on Smart Capture mode. |
| `showSubfooter` | `boolean` | Mode selector menu visibility. |
| `showPoweredByDynamsoft` | `boolean` | Visibility of the Dynamsoft branding message. |
| Property | Type | Description |
| --------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `templateFilePath` | `string` | Path to a Capture Vision template for scanning configuration. |
| `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. |
| `container` | `HTMLElement` | The container element for the scanner view. |
| `utilizedTemplateNames` | `[`UtilizedTemplateNames`](#utilizedtemplatenames)` | Capture Vision template names for detection and correction. |
| `enableAutoCropMode` | `boolean` | The default auto-crop mode state. |
| `enableSmartCaptureMode` | `boolean` | The default smart capture mode state. |
| `scanRegion` | [`ScanRegion`](#scanregion) | Defines the region within the viewport to detect documents. |
| `minVerifiedFramesForAutoCapture` | `number` | The minimum number of camera frames to detect document boundaries on Smart Capture mode. |
| `showSubfooter` | `boolean` | Mode selector menu visibility. |
| `showPoweredByDynamsoft` | `boolean` | Visibility of the Dynamsoft branding message. |

#### Example

Expand Down Expand Up @@ -425,7 +425,7 @@ interface UtilizedTemplateNames {

### `EngineResourcePaths`

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).
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.

#### Syntax

Expand Down
2 changes: 1 addition & 1 deletion code-gallery/mobile-web-capture/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ interface DocumentViewConfig {

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

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

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

Expand Down
6 changes: 3 additions & 3 deletions code-gallery/mobile-web-capture/customization-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: Mobile Document Scanner JS Edition User Guide
# How to Customize Mobile Web Capture

> [!TIP]
> Prerequisites: read the [MWC Getting Started Guide]({{ site.guide }}mobile-web-capture/index.html) before proceeding.
> Prerequisites: read the [MWC Getting Started Guide]({{ site.code-gallery }}mobile-web-capture/index.html) before proceeding.

This guide expands on the **Hello World** sample from the **MWC Getting Started Guide** and explores the available customization options.

Expand Down Expand Up @@ -146,8 +146,8 @@ document.getElementById("initialFile").onchange = async function () {
```

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

### Scan Directly to Document

Expand Down
6 changes: 3 additions & 3 deletions code-gallery/mobile-web-capture/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Alternatively, the script can be referenced from a CDN:
**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.

> [!IMPORTANT]
> 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).
> 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).

### Instantiate MWC

Expand All @@ -197,7 +197,7 @@ const mobileWebCapture = new Dynamsoft.MobileWebCapture({
});
```

API Reference: [`MobileWebCapture()`](https://www.dynamsoft.com/mobile-web-capture/docs/api/mobile-web-capture.html#mobilewebcapture)
API Reference: [`MobileWebCapture()`]({{ site.code-gallery }}}mobile-web-capture/api.html#mobilewebcapture)

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).

Expand All @@ -211,7 +211,7 @@ const fileName = `New_Document_${Date.now().toString().slice(-5)}`; // Generates
await mobileWebCapture.launch(fileName);
```

API Reference: [`launch()`](https://www.dynamsoft.com/mobile-web-capture/docs/api/mobile-web-capture.html#launch)
API Reference: [`launch()`]({{ site.code-gallery }}}mobile-web-capture/api.html#launch)

This step launches the UI, starting in **`DocumentView`**, where the user can begin building a document in two ways:

Expand Down
4 changes: 2 additions & 2 deletions guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Alternatively, you can use other methods like `IIS` or `Apache` to serve the pro

### Self-Host Resources

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.
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.

#### Download Resources

Expand Down Expand Up @@ -339,7 +339,7 @@ Alternatively, the script can be referenced from a CDN:
**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.

> [!WARNING]
> 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).
> 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).

### Instantiate MDS

Expand Down
2 changes: 1 addition & 1 deletion release-notes/mobile-web-capture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The most notable improvement in this version is the pluggable scanner feature. T
### Features

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