Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions about/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: Dynamic Web TWAIN SDK Documentation Resources Page

* <a href="https://www.dynamsoft.com/Downloads/WebTWAIN_Download.aspx" target="_blank">Official installer</a>

> This official package is meant for developers to evaluate the SDK. When the package is installed, you get all the [resource files]({{site.about}}faqs.html#what-are-the-resources-files), documentation, and samples. A 30-day free trial is included when evaluating our SDK.
> This official package is meant for developers to evaluate the SDK. When the package is installed, you get all the [resource files]({{site.faq}}what-are-the-resources-files.html), documentation, and samples. A 30-day free trial is included when evaluating our SDK.

* <a href="https://www.npmjs.com/package/dwt" target="_blank">NPM package</a>

Expand All @@ -27,7 +27,7 @@ description: Dynamic Web TWAIN SDK Documentation Resources Page

* <a href="https://www.dynamsoft.com/Downloads/WebTWAIN-Sample-Download.aspx" target="_blank">Official samples</a>

> We have many prebuilt samples to demonstrate common user scenarios. All samples contain the [resource files]({{site.about}}faqs.html#what-are-the-resources-files) required in your application. If a sample is hosted on the Dynamsoft website (not Github), then the sample comes with a 30-day free trial license as well. Otherwise, you can [get a trial license](#how-do-i-get-a-trial-license).
> We have many prebuilt samples to demonstrate common user scenarios. All samples contain the [resource files]({{site.faq}}what-are-the-resources-files.html) required in your application. If a sample is hosted on the Dynamsoft website (not Github), then the sample comes with a 30-day free trial license as well. Otherwise, you can [get a trial license](#how-do-i-get-a-trial-license).

* <a href="https://github.com/dynamsoft-dwt" target="_blank">Github repo</a>

Expand Down
2 changes: 2 additions & 0 deletions faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,8 @@ description: Dynamic Web TWAIN SDK Documentation FAQ

<a href="{{site.faq}}how-come-would-you-need-local.dynamsoft.com.html" target="_blank">In which cases would I use local.dynamsoft.com instead of 127.0.0.1?</a>

<a href="{{site.faq}}what-are-the-resources-files.html" target="_blank">What are the Resources files?</a>

<a href="{{site.faq}}resources-to-be-included-in-SDK.html" target="_blank">What resources of the SDK should be included in my web application?</a>

<a href="{{site.faq}}change-reference-path.html" target="_blank">How can I change the reference path to the Dynamsoft’s resources in my project?</a>
Expand Down
121 changes: 121 additions & 0 deletions faq/what-are-the-resources-files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
layout: default-layout
noTitleIndex: true
needAutoGenerateSidebar: true
title: What are the Resources files?
keywords: Dynamic Web TWAIN, Documentation, General
breadcrumbText: What Are The Resources Files
description: What are the Resources files?
---

# General

## What are the Resources files?

Resources files help you include Dynamic Web TWAIN in your application. The following shows the purpose of these files.

> *Resources* is the default name of the folder that contain these files. It can be changed. For example, in the [Dynamic Web TWAIN package](https://github.com/dynamsoft-dwt/web-twain-package), it's called *dist*.

### Default files

* dynamsoft.webtwain.config.js

> This file is used to make basic configuration of the Dynamic Web TWAIN library. It's where you enter the product key for the product and to change the initial viewer size, etc.

* dynamsoft.webtwain.initiate.js

> This file is the core of the Dynamic Web TWAIN library.

* dynamsoft.webtwain.install.js

> This file is used to configure the dialogs which are shown when the Dynamic Web TWAIN library is not installed or needs to be upgraded. This file is already referenced inside the dynamsoft.webtwain.initiate.js

* Readme.txt
* addon
+ dynamsoft.upload.js

> This file contains the functionalities of the Dynamsoft Upload Module.

+ dynamsoft.webtwain.addon.camera.js

> This file contains the functionalities of the Camera addon.

+ dynamsoft.webtwain.addon.ocr.js

> This file contains the functionalities of the OCR Basic addon. It's not included by default, contact [Dynamsoft Support]({{site.about}}Getsupport.html) to get it.

+ dynamsoft.webtwain.addon.ocrpro.js

> This file contains the functionalities of the OCR Professional addon. It's not included by default, contact [Dynamsoft Support]({{site.about}}Getsupport.html) to get it.

+ dynamsoft.webtwain.addon.pdf.js

> This file contains the functionalities of the PDF Rasterizer addon.

+ dynamsoft.webtwain.addon.webcam.js

> This file contains the functionalities of the Webcam addon.

+ dynamsoft.webtwain.addon.barcodereader.js

> This file contains the functionalities of the Barcode addon.

+ dbrjs

> These files are meant for the barcode reader addon under [WASM mode]({{site.indepth}}initialize.html#wasm-mode).

- dbr.js
- dbr-7.4.0.1.full.wasm
- dbr-7.4.0.1.full.wasm.js
- dbr-7.4.0.1.worker.js
* dist

> Under this directory are the installers for the Dynamsoft Service which needs to be manually installed on each client machine that uses the Dynamic Web TWAIN library as a service.

- DynamsoftServiceSetup.deb

> For Linux (Debian)

- DynamsoftServiceSetup.rpm

> For Linux (Redhat)

- DynamsoftServiceSetup.msi

> For Windows

- DynamsoftServiceSetup.pkg

> For macOS

- LICENSE
+ src

> These files contain the following functionalities for the [WASM-mode]({{site.indepth}}features/initialize.html#wasm-mode)
> - image input & output
> - decode & encode
> - PDF read & write
> - Viewer & UI

- dynamsoft.imageio.js
- dynamsoft.imageio_wasm-<version number>.js
- dynamsoft.imagecore-<version number>.wasm
- dynamsoft.imageio-<version number>.wasm
- dynamsoft.imageProc-<version number>.wasm
- dynamsoft.pdfReader-<version number>.wasm
- dynamsoft.pdfWriter-<version number>.wasm
- dynamsoft.viewer.css
- dynamsoft.viewer.js
- dynamsoft.webtwain.css

### Other Resources files

The following two files are present in the [Dynamic Web TWAIN package](https://github.com/dynamsoft-dwt/web-twain-package).

* dynamsoft.webtwain.min.js

> This is an all-in-one JavaScript file that consists of the files dynamsoft.webtwain.initiate.js , dynamsoft.webtwain.config.js , dynamsoft.webtwain.install.js as well as all the add-on JavaScript files. If you include this file in the application, you no longer need to include these constituent files separately.

* dynamsoft.webtwain.min.mjs

> This file is like dynamsoft.webtwain.min.js but is built by the ECMAScript 6 (ES6) standard. It's used by applications (Angular, React, Vue, etc.) that import the `Dynamic Web TWAIN` package as a module.
2 changes: 1 addition & 1 deletion indepth/deployment/server-v16.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Once you have finished integrating `DWT` in your application, you can deploy it

## Make sure the static files can be served correctly

`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.about}}FAQs.html#what-are-the-resources-files). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.
`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.faq}}what-are-the-resources-files.html). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.

| File Type | MIME Type | Required by |
|:-:|:-:|:-:|
Expand Down
2 changes: 1 addition & 1 deletion indepth/deployment/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The deployment of Dynamic Web TWAIN is easy. Simply copy the Resources folder to

### Make sure the static files can be served correctly

`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.about}}FAQs.html#what-are-the-resources-files). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.
`DWT` comes with lots of static resources files, for the full list, check out [What are the Resources files]({{site.faq}}what-are-the-resources-files.html). The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.

| File Type | MIME Type | Required by |
|:-:|:-:|:-:|
Expand Down
2 changes: 1 addition & 1 deletion indepth/development/Pro-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following is how VDS works

## Customization Service

Dynamsoft provides many public samples and code snippets free of cost to all customers. The code in these materials can be customized at will. However, the [resources files]({{site.about}}faqs.html#what-are-the-resources-files) provided with each SDK **should not be changed** unless otherwise mentioned in this documentation. If you want to make unmentioned changes to any of these files in the documentation, you must first consult [Dynamsoft Support]({{site.about}}getsupport.html) to learn whether or not it can be done and if so, what that would entail from our end. If it involves a considerable amount of extra effort from the Dynamsoft team, the "Customization Service" (CS) may apply.
Dynamsoft provides many public samples and code snippets free of cost to all customers. The code in these materials can be customized at will. However, the [resources files]({{site.faq}}what-are-the-resources-files.html) provided with each SDK **should not be changed** unless otherwise mentioned in this documentation. If you want to make unmentioned changes to any of these files in the documentation, you must first consult [Dynamsoft Support]({{site.about}}getsupport.html) to learn whether or not it can be done and if so, what that would entail from our end. If it involves a considerable amount of extra effort from the Dynamsoft team, the "Customization Service" (CS) may apply.

The difference between VDS and CS is that the latter involves changes to the `DWT` SDK itself and is considered much more complicated from a technical standpoint. However, in term of the customer's workflow to get a customization job done, the steps are the same as VDS.

Expand Down
2 changes: 1 addition & 1 deletion indepth/development/upgrade-v16.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following three steps are required to upgrade your application to use a newe

## Update the resources files

Read more about [resources files]({{site.about}}faqs.html#what-are-the-resources-files).
Read more about [resources files]({{site.faq}}what-are-the-resources-files.html).

### Regular Web application

Expand Down
8 changes: 4 additions & 4 deletions indepth/features/OCR-v16.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Client side OCR only works in [browsers on Windows]({{site.getstarted}}platform.

#### Step one - Include OCRB

To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).

> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.

Expand Down Expand Up @@ -72,7 +72,7 @@ function downloadOCRB(bDownloadDLL) {
downloadOCRB(true);
```

The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).
The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRB-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRBasicx64-v16.zip).

Once the installation is done, you should be able to find the following files under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_16\DynamicOCR` .

Expand Down Expand Up @@ -131,7 +131,7 @@ function DoOCR() {

#### Step one - Include OCRPro

To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html) or get it from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).

> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.

Expand Down Expand Up @@ -159,7 +159,7 @@ function downloadOCRPro() {
downloadOCRPro();
```

The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). As mentioned above, if you can't find these files, you can get them from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).
The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.WebTwainEnv.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). As mentioned above, if you can't find these files, you can get them from [64bit-OCRPro-v16-Resources](https://tst.dynamsoft.com/public/download/ocr/OCRProx64-v16.zip).

Once the installation is done, you should be able to find the following under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_16`
* `DynamicOCRProx64_1.2.0.0806.dll` : The version number may vary.
Expand Down
8 changes: 4 additions & 4 deletions indepth/features/OCR.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Client side OCR only works in [browsers on Windows]({{site.getstarted}}platform.

#### Step one - Include OCRB

To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocr.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).

> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.

Expand Down Expand Up @@ -72,7 +72,7 @@ function downloadOCRB(bDownloadDLL) {
downloadOCRB(true);
```

The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
The code asks `DWT` to download `OCRB` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRx64.zip'` and the language data from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRBasicLanguages/English.zip'` . Both zip files need to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). As mentioned above, if you can't find these files, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).

Once the installation is done, you should be able to find the following files under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17\DynamicOCR` .

Expand Down Expand Up @@ -131,7 +131,7 @@ function DoOCR() {

#### Step one - Include OCRPro

To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
To include this addon is to reference the necessary JavaScript file `dynamsoft.webtwain.addon.ocrpro.js` which is **NOT** included in the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).

> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the addon is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.

Expand Down Expand Up @@ -159,7 +159,7 @@ function downloadOCRPro() {
downloadOCRPro();
```

The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.about}}faqs.html#what-are-the-resources-files). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
The code asks `DWT` to download `OCRPro` from the URL `Dynamsoft.DWT.ResourcesPath + '/addon/OCRProx64.zip'` . This zip file needs to be placed on the server where you placed the [resources files]({{site.faq}}what-are-the-resources-files.html). If you can't find this file, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).

Once the installation is done, you should be able to find the following under `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17`
* `DynamicOCRProx64_1.2.0.0806.dll` : The version number may vary.
Expand Down
2 changes: 1 addition & 1 deletion indepth/features/barcode-v16.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ With the increasing use of barcode reading in document management systems, the B

### Step one - Include the add-on

To include this add-on is to reference the necessary JavaScript file which is included in the [resources files]({{site.about}}faqs.html#what-are-the-resources-files).
To include this add-on is to reference the necessary JavaScript file which is included in the [resources files]({{site.faq}}what-are-the-resources-files.html).

> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the barcode reader is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.

Expand Down
Loading