Skip to content

Commit c5f8737

Browse files
committed
feat: move guide article paths
feat: guides and MWC redirects feat: update links to guide articles in side tree fix: remove extra navigation bar file fix: move MDS release notes fix: MDS release notes links and content fix: MDS guide content fix: broken MDS guide links and liquid macro chore: remove moved links
1 parent 02b1511 commit c5f8737

20 files changed

+220
-242
lines changed

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ codegallery: /mobile-document-scanner/docs/web/codegallery/
1010
code-gallery: /mobile-document-scanner/docs/web/code-gallery/
1111
api: /mobile-document-scanner/docs/web/api/
1212

13-
guides: /mobile-document-scanner/docs/web/guides/
13+
guide: /mobile-document-scanner/docs/web/guide/
1414

1515
release-notes: /mobile-document-scanner/docs/web/release-notes/
1616

_data/full_tree.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
tree_file_list:
22
- sidelist-introduction.html
3-
- sidelist-guides.html
3+
- sidelist-guide.html
44
- sidelist-code-gallery.html
55
- sidelist-api.html
66
- sidelist-release-notes.html

_includes/mwcNav.html

Lines changed: 0 additions & 67 deletions
This file was deleted.

_includes/sidelist-full-tree.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%}
2-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guides.html" -%}
2+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guide.html" -%}
33
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-code-gallery.html" -%}
44
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api.html" -%}
55
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes.html" -%}

_includes/sidelist-guide.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<li><a href="{{ site.guide }}index.html" class="otherLinkColour">Developer Guide</a>
2+
</li>

_includes/sidelist-guides.html

Lines changed: 0 additions & 2 deletions
This file was deleted.

_includes/sidelist-release-notes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<li><a href="{{ site.release-notes }}mobile-web-capture.html" class="otherLinkColour">Release Notes</a></li>
1+
<li><a href="{{ site.release-notes }}index.html" class="otherLinkColour">Release Notes</a></li>

api/document-scanner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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.guides }}mobile-web-capture-customization.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 for the purpose of [self-hosting resources]({{ site.code-gallery }}mobile-web-capture/customization-guide.html#self-hosting-resource-files).
429429

430430
#### Syntax
431431

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

Lines changed: 2 additions & 2 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.guides }}mobile-web-capture.html) before proceeding.
14+
> Prerequisites: read the [MWC Getting Started Guide]({{ site.guide }}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

@@ -51,7 +51,7 @@ Keep TOC only for npm /github as readme
5151
4. `onUploadSuccess`: Specifies a function that is triggered when the upload operation succeeds.
5252
4. `showLibraryView`: Configures where or not this **MWC** instance starts with the `LibraryView`.
5353
5. `onClose`: Specifies a function that is triggered when the user closes this **MWC** instance.
54-
6. `documentScannerConfig`: Configures the behavior of the built-in `DocumentScanner` instance. See the details in [`DocumentScannerConfig`]({{ site.guides }}document-scanner.html#documentscannerconfig-overview).
54+
6. `documentScannerConfig`: Configures the behavior of the built-in `DocumentScanner` instance. See the details in [`DocumentScannerConfig`]({{ site.guide }}document-scanner.html#documentscannerconfig-overview).
5555
7. `libraryViewConfig`: Configures the library view with the following properties:
5656
1. `emptyContentConfig`: Specifies the content displayed in the library view when it is empty (no document).
5757
2. `toolbarButtonsConfig`: Configures the buttons in the toolbar of the library view.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ description: Mobile Document Scanner JS Edition User Guide
2121
This guide walks you through building a web application that scans multi-page documents using **MWC**, with **pre-defined configurations**.
2222

2323
> [!TIP]
24-
> If you are looking for a solution that scans single-page documents, please read [Mobile Document Scanner User Guide]({{ site.guides }}index.html) instead.
24+
> If you are looking for a solution that scans single-page documents, please read [Mobile Document Scanner User Guide]({{ site.guide }}index.html) instead.
2525
2626
<!--
2727
Keep TOC only for npm /github as readme
@@ -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.guides }}mobile-web-capture-customization.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.guide }}mobile-web-capture/customization-guide.html#self-hosting-resource-files).
190190
191191
### Instantiate MWC
192192
@@ -199,7 +199,7 @@ const mobileWebCapture = new Dynamsoft.MobileWebCapture({
199199
200200
API Reference: [`MobileWebCapture()`](https://www.dynamsoft.com/mobile-web-capture/docs/api/mobile-web-capture.html#mobilewebcapture)
201201
202-
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.guides }}mobile-web-capture-customization.html#example-1-specify-the-ui-container).
202+
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
204204
> [!WARNING]
205205
> A **license key** is required for the instantiation.
@@ -234,7 +234,7 @@ The user can:
234234
5. **Manage****Share** : Share individual pages as images (**.PNG**).
235235
- **Download** is enabled where **Share** is not supported (e.g., in Firefox).
236236
237-
The user can also enable the **"Upload"** feature. Check out [Enable File Upload]({{ site.guides }}mobile-web-capture-customization.html#enable-file-upload)
237+
The user can also enable the **"Upload"** feature. Check out [Enable File Upload]({{ site.code-gallery }}mobile-web-capture/customization-guide.html#enable-file-upload)
238238
239239
#### The PageView
240240
When the user presses an image, the `PageView` is launched for that page, where the user can
@@ -249,8 +249,8 @@ When the user presses an image, the `PageView` is launched for that page, where
249249
5. **Edit****Filter** : Adjust the page's pixels.
250250
6. **Edit** → **Annotate** : Add annotations to the page.
251251
252-
The user can also enable the **"Upload"** feature. Check out [Enable File Upload]({{ site.guides }}mobile-web-capture-customization.html#enable-file-upload)
252+
The user can also enable the **"Upload"** feature. Check out [Enable File Upload]({{ site.code-gallery }}mobile-web-capture/customization-guide.html#enable-file-upload)
253253
254254
## Next Step
255255
256-
Mobile Web Capture provides extensive customization options. Read on to explore the available customizations in the [MWC Customization Guide]({{ site.guides }}mobile-web-capture-customization.html).
256+
Mobile Web Capture provides extensive customization options. Read on to explore the available customizations in the [MWC Customization Guide]({{ site.code-gallery }}mobile-web-capture/customization-guide.html).

0 commit comments

Comments
 (0)