Skip to content

Commit 3f60373

Browse files
Merge pull request #859 from dynamsoft-docs/preview
update to internal commit ecd59085
2 parents ebfef0d + b0ef9c8 commit 3f60373

File tree

11 files changed

+160
-106
lines changed

11 files changed

+160
-106
lines changed

_data/full_tree.yml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,12 @@ tree_list:
2929
childList:
3030
- name: Loading Library Resources
3131
path: /general-usage/resource-loading.html
32-
- name: License
32+
- name: Configuring License Keys
3333
path: /general-usage/license.html
3434
- name: Initializing DWT
3535
path: /general-usage/initialization.html
36-
- name: Importing Images
37-
path: /general-usage/image-import/index.html
38-
childList:
39-
- name: Acquiring Images from Scanners
40-
path: /general-usage/image-import/scanner-image-acquisition.html
41-
- name: Loading Documents from Files
42-
path: /general-usage/image-import/file-import.html
36+
- name: Acquiring Images from Scanners
37+
path: /general-usage/scanner-image-acquisition.html
4338
- name: Configuring the Viewer
4439
path: /general-usage/viewer-configuration.html
4540
- name: Processing Images
@@ -65,6 +60,8 @@ tree_list:
6560
childList:
6661
- name: Advanced DWT Initialization
6762
path: /extended-usage/advanced-initialization.html
63+
- name: Loading Documents from Files
64+
path: /extended-usage/file-import.html
6865
- name: Configuring System Messages
6966
path: /extended-usage/system-message-configuration.html
7067
- name: Set Up the Dynamsoft Service

articles/extended-usage/advanced-initialization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Some use cases call for instantiating `WebTwain` objects on demand. To do this,
115115
<script>
116116
var DWTObject; // Use this to store the WebTwain object after retrieval
117117
118-
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/dwt@latest/dist"; // Load supporting resources from here
118+
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/npm/dwt@latest/dist"; // Load supporting resources from here
119119
Dynamsoft.DWT.ProductKey = ""; // Add product key here
120120
121121
// Configure the WebTwain instance created when calling Dynamsoft.DWT.Load()
@@ -183,13 +183,13 @@ The previous two methods relied on listening to the `OnWebTwainReady` event to g
183183
<script>
184184
var DWTObject; // Use this to store the WebTwain object after retrieval
185185
186-
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/dwt@latest/dist"; // Load supporting resources from here
186+
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/npm/dwt@latest/dist"; // Load supporting resources from here
187187
Dynamsoft.DWT.ProductKey = ""; // Add product key here
188188
189189
// Create WebTwain instance
190190
function instantiate() {
191191
Dynamsoft.DWT.CreateDWTObject(
192-
'dwtControlContainer'
192+
'dwtcontrolContainer'
193193
, function (object) {
194194
DWTObject = object;
195195
}, function (exp) {
@@ -248,7 +248,7 @@ The other instantiation methods all create a `Viewer` component in the `WebTwain
248248
<script>
249249
var DWTObject; // Use this to store the WebTwain object after retrieval
250250
251-
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/dwt@latest/dist"; // Load supporting resources from here
251+
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/npm/dwt@latest/dist"; // Load supporting resources from here
252252
Dynamsoft.DWT.ProductKey = ""; // Add product key here
253253
254254
// Create WebTwain instance without a Viewer

articles/general-usage/image-import/scanner-image-acquisition.md renamed to articles/extended-usage/scanner-image-acquisition.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Dynamic Web TWAIN SDK Basics - Acquiring Images from Scanners
55
keywords: Dynamic Web TWAIN, Documentation, development, guide, development guide, basic, basic guide, importing images, image import, imaging devices, selecting imaging devices, scanners, scanning, image acquisition
66
breadcrumbText: Acquiring Images from Scanners
77
description: Dynamic Web TWAIN SDK General Usage Guide - Acquiring Images from Scanners
8-
permalink: /general-usage/image-import/scanner-image-acquisition.html
8+
permalink: /general-usage/scanner-image-acquisition.html
99
redirect_from:
1010
- /indepth/features/input.html
1111
---
@@ -14,6 +14,8 @@ redirect_from:
1414

1515
> Prerequisite: [DWT Initialization]({{site.general-usage}}initialization.html)
1616
17+
DWT can import images in a few different ways, the most common which is to acquire images from image sources, which are scanners and other imaging hardware. (We can also load image files, both from the local file system and over the network, as explained [here]({{site.general-usage}}image-import/file-import.html))
18+
1719
After the web application has initialized DWT and instantiated a `WebTwain` object, the `WebTwain` object can perform image acquisition, which is a term that includes scanning and file input. We will first go over scanning in this section. Note that we also provide an add-on for webcam-based scanning, which you can learn more about [here]({{site.api}}Addon_Webcam.html).
1820

1921
## Acquisition from All Available Scanners

articles/general-usage/image-import/file-import.md renamed to articles/general-usage/file-import.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Dynamic Web TWAIN SDK Basics - Loading Documents from Files
55
keywords: Dynamic Web TWAIN, Documentation, development, guide, development guide, basic, basic guide, importing images, image import, importing documents, documents, document import
66
breadcrumbText: Loading Documents from Files
77
description: Dynamic Web TWAIN SDK General Usage Guide - Loading Documents from Files
8-
permalink: /general-usage/image-import/file-import.html
8+
permalink: /extended-usage/file-import.html
99
---
1010

1111
# Loading Documents from Files

articles/general-usage/image-import/index.md

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

articles/general-usage/license.md

Lines changed: 116 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,48 +11,141 @@ redirect_from:
1111
- /about/license.html
1212
---
1313

14-
# License
14+
# Using License Keys
1515

16-
## Trial License
16+
Dynamic Web TWAIN (DWT) requires a valid license key to function. License keys authorize the use of DWT, as well as any configured add-on modules.
1717

18-
### Request trial license
18+
## Use Trial Licenses
1919

20-
You can request a trial license of Dynamic Web TWAIN via our <a href="https://www.dynamsoft.com/customer/license/trialLicense?product=dwt" target="_blank">customer portal</a> or [contacting support](https://www.dynamsoft.com/company/contact/).
20+
You can request a trial license of Dynamic Web TWAIN through our <a href="https://www.dynamsoft.com/customer/license/trialLicense?product=dwt" target="_blank">customer portal</a>, and we will email you your trial license key. You can also contact our [support team](https://www.dynamsoft.com/company/contact/) for new licenses and/or trial license extensions.
2121

22-
### Update trial license
22+
### Configure Trial License Keys
2323

24-
You can set the new key via the `ProductKey` API.
24+
License keys are configured in the [`Dynamsoft.DWT.ProductKey`]({{site.api}}Dynamsoft_WebTwainEnv.html#productkey) property. (**Note**: prior to version 17.0, this property was `Dynamsoft.WebTwainEnv.ProductKey`). The configuration differs depending on how a project loads DWT resource files (see [loading library resources]({{site.general-usage}}resource-loading.html) for more details). Trial key strings typically have the `t0076` prefix.
2525

26-
1. Open `dynamsoft.webtwain.config.js` from your local project or search `ProductKey` to locate the code for license setting.
26+
<div class="multi-panel-switching-prefix"></div>
2727

28-
2. Update `ProductKey` in the code.
28+
- [Official SDK](#trial-keys-with-sdk)
29+
- [Package Managers](#trial-keys-with-package-managers)
30+
31+
<div class="multi-panel-start"></div>
32+
33+
1. Locate the `dynamsoft.webtwain.config.js` file (or search for `ProductKey`).
34+
35+
2. Assign the license key string to [`Dynamsoft.DWT.ProductKey`]({{site.api}}Dynamsoft_WebTwainEnv.html#productkey):
36+
37+
```javascript
38+
Dynamsoft.DWT.ProductKey = 't0076******'; // Use an offline trial key
39+
```
40+
41+
3. Load (or reload, if replacing an existing key) the web application and see that it starts scanning.
42+
43+
<div class="multi-panel-end">
44+
45+
</div><div class="multi-panel-start"></div>
46+
47+
When using package managers such as `npm`, be sure to check out our web framework samples. Roughly speaking, it involves setting `Dynamsoft.DWT.ProductKey` before calling either [`Dynamsoft.DWT.Load()`]({{site.api}}Dynamsoft_WebTwainEnv.html#load) or [`Dynamsoft.DWT.CreateDWTObjectEx()`]({{site.api}}Dynamsoft_WebTwainEnv.html#createdwtobjectex):
48+
49+
- [Use Web TWAIN in Angular]({{site.indepth}}development/angular.html)
50+
- [Use Web TWAIN in React]({{site.indepth}}development/react.html)
51+
- [Use Web TWAIN in Vue]({{site.indepth}}development/vue.html)
52+
53+
<div class="multi-panel-switching-end"></div>
54+
55+
## Using Full Licenses
56+
57+
Contact our [sales team](https://www.dynamsoft.com/store/dynamic-web-twain/) to purchase full licenses for Dynamic Web TWAIN. Use our <a href="https://www.dynamsoft.com/customer/license/fullLicense" target="_blank">customer portal</a> to manage full licenses. Full licenses are either offline licenses, or DLS-connected licenses. DLS-connected licenses contact DLS servers for authentication purposes - please see [Dynamsoft License Server](https://www.dynamsoft.com/license-server/docs/about/index.html) for more details. Full licenses may also be configured with add-on modules.
58+
59+
### Acquiring Full Keys
60+
61+
<div class="multi-panel-switching-prefix"></div>
62+
63+
- [DLS-Connected Keys](#get-dls-keys)
64+
- [Offline Keys](#get-offline-keys)
65+
66+
<div class="multi-panel-start"></div>
67+
68+
DLS-connected license keys begin with the `DLS` prefix. Learn more about the Dynamsoft Licensing Server [here](https://www.dynamsoft.com/license-server/docs/about/activate.html).
69+
70+
1. Without add-ons: activate the license in the customer portal, then acquire the DLS key. This key only authorizes the use of the core DWT module.
71+
2. With add-ons: activate the license and configure the core DWT module along with add-ons into one project in DLS, then acquire the DLS key. This authorizes the use of the add-on modules on top of the core module.
72+
73+
<div class="multi-panel-end">
74+
75+
</div><div class="multi-panel-start"></div>
76+
77+
Offline license keys begin with the `f0068` prefix.
78+
79+
1. Without add-ons: activate the license in the customer portal, then acquire the offline key. This key only authorizes the use of the core DWT module.
80+
2. With add-ons: activate the license in the customer portal, then acquire the offline keys. This may result in multiple license keys - one for the base DWT module, and separate ones for the add-ons. To use multiple keys in a single project, concatenate them (in any order) into a single string, separated with semicolons.
81+
82+
<div class="multi-panel-switching-end"></div>
83+
84+
### Configuring Full License Keys
85+
86+
To use a full license key, set the value of [`Dynamsoft.DWT.ProductKey`]({{site.api}}Dynamsoft_WebTwainEnv.html#productkey) to the key string. (**Note**: prior to version 17.0, this property was `Dynamsoft.WebTwainEnv.ProductKey`) The configuration differs depending on how a project loads DWT resource files (see [loading library resources]({{site.general-usage}}resource-loading.html) for more details).
87+
88+
<div class="multi-panel-switching-prefix"></div>
89+
90+
- [DLS-Connected Keys](#use-dls-keys)
91+
- [Offline Keys](#use-offline-keys)
92+
- [Multiple Offline Keys](#use-multiple-offline-keys)
93+
- [Package Managers](#full-keys-with-package-managers)
94+
95+
<div class="multi-panel-start"></div>
96+
97+
1. Locate the `dynamsoft.webtwain.config.js` file (or search for `ProductKey`).
98+
99+
2. Assign the license key string to [`Dynamsoft.DWT.ProductKey`]({{site.api}}Dynamsoft_WebTwainEnv.html#productkey):
29100

30101
```javascript
31-
Dynamsoft.DWT.ProductKey = 't0076lQAAAGNcO61He******'; // update the ProductKey with yours
102+
Dynamsoft.DWT.ProductKey = 'DLS******'; // Use an online key
32103
```
33104

34-
3. Refresh your scan page and try again.
105+
3. Load (or reload, if replacing an existing key) the web application and see that it starts scanning.
106+
107+
<div class="multi-panel-end">
108+
109+
</div><div class="multi-panel-start"></div>
110+
111+
1. Locate the `dynamsoft.webtwain.config.js` file (or search for `ProductKey`).
35112

36-
## Full license
113+
2. Assign the license key string to [`Dynamsoft.DWT.ProductKey`]({{site.api}}Dynamsoft_WebTwainEnv.html#productkey):
37114

38-
You can find all the full licenses you own via our <a href="https://www.dynamsoft.com/customer/license/fullLicense" target="_blank">customer portal</a>.
115+
```javascript
116+
Dynamsoft.DWT.ProductKey = 'f0068******;'; // Use an online key
117+
```
118+
119+
3. Load (or reload, if replacing an existing key) the web application and see that it starts scanning.
120+
121+
<div class="multi-panel-end">
122+
123+
</div><div class="multi-panel-start"></div>
124+
125+
Offline license keys with add-ons should be concatenated (in any order) into a single string, separated with semicolons, and assigned to the same property (e.g. `f0068******;f0068******`).
126+
127+
1. Locate the `dynamsoft.webtwain.config.js` file (or search for `ProductKey`).
128+
129+
2. Assign the license key string to [`Dynamsoft.DWT.ProductKey`]({{site.api}}Dynamsoft_WebTwainEnv.html#productkey):
130+
131+
```javascript
132+
Dynamsoft.DWT.ProductKey = 'f0068******;f0068******'; // Use an online key
133+
```
39134

40-
Depending on the type of full license you are using, you can add/update the full license via the `ProductKey` API (available for Dynamic Web TWAIN v17.0+).
135+
3. Load (or reload, if replacing an existing key) the web application and see that it starts scanning.
41136

42-
### Update ProductKey
137+
<div class="multi-panel-end">
43138

44-
If you are using a **ProductKey**, you can search `ProductKey` to locate the code for license setting which resides in the `dynamsoft.webtwain.config.js` file for most cases.
139+
</div><div class="multi-panel-start"></div>
45140

46-
``` javascript
47-
Dynamsoft.DWT.ProductKey = 't0076lQAAAGNcO61He******'; // update the ProductKey with yours
48-
```
141+
When using package managers such as `npm`, be sure to check out our web framework samples. Roughly speaking, it involves setting `Dynamsoft.DWT.ProductKey` before calling either [`Dynamsoft.DWT.Load()`]({{site.api}}Dynamsoft_WebTwainEnv.html#load) or [`Dynamsoft.DWT.CreateDWTObjectEx()`]({{site.api}}Dynamsoft_WebTwainEnv.html#createdwtobjectex):
49142

50-
If you have multiple license keys, separate them with semicolons like below:
143+
- [Use Web TWAIN in Angular]({{site.indepth}}development/angular.html)
144+
- [Use Web TWAIN in React]({{site.indepth}}development/react.html)
145+
- [Use Web TWAIN in Vue]({{site.indepth}}development/vue.html)
51146

52-
``` javascript
53-
Dynamsoft.DWT.ProductKey = 't0076lQAAAGNcO61He******;t0076lQAAAGNcO61He******';
54-
```
147+
<div class="multi-panel-switching-end"></div>
55148

56149
## License Agreement
57150

58-
View the <a href="https://www.dynamsoft.com/Products/WebTwain_license.aspx" target="_blank">Dynamic Web TWAIN License Agreement</a>.
151+
View the Dynamic Web TWAIN License Agreement <a href="https://www.dynamsoft.com/Products/WebTwain_license.aspx" target="_blank">here</a>.

articles/general-usage/resource-loading.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,18 @@ The resources obtained from the package managers differ slightly from the ones f
5858

5959
Simply create a `script` element like so:
6060

61-
### Loading from [UNPKG](https://unpkg.com/dwt@18.5.0/dist/dynamsoft.webtwain.min.js)
61+
### Loading from [UNPKG](https://unpkg.com/dwt@latest/dist/dynamsoft.webtwain.min.js)
6262

6363
```html
6464
<html>
6565
<head>
6666
<!-- Load resources from UNPKG CDN -->
67-
<script src="https://unpkg.com/dwt@18.5.0/dist/dynamsoft.webtwain.min.js"></script>
67+
<script src="https://unpkg.com/dwt@latest/dist/dynamsoft.webtwain.min.js"></script>
6868
</head>
6969

7070
<body>
7171
<script>
72-
Dynamsoft.DWT.ResourcesPath = "https://unpkg.com/dwt@18.5.0/dist"; // Load supporting resources from here
72+
Dynamsoft.DWT.ResourcesPath = "https://unpkg.com/dwt@latest/dist"; // Load supporting resources from here
7373
Dynamsoft.DWT.ProductKey = ""; // Add product key here
7474
</script>
7575
</body>
@@ -81,20 +81,20 @@ APIs used:
8181
- [`Dynamsoft.DWT.ResourcesPath`]({{site.api}}Dynamsoft_WebTwainEnv.html#resourcespath)
8282
- [`Dynamsoft.DWT.ProductKey`]({{site.api}}Dynamsoft_WebTwainEnv.html#productkey)
8383

84-
### Loading from [jsDelivr](https://cdn.jsdelivr.net/npm/dwt@18.5.0/dist/dynamsoft.webtwain.min.js)
84+
### Loading from [jsDelivr](https://cdn.jsdelivr.net/npm/dwt@latest/dist/dynamsoft.webtwain.min.js)
8585

86-
Note that jsDelivr currently has problems delivering the Dynamsoft Service installer (`https://cdn.jsdelivr.net/npm/dwt@18.5.0/dist/dist/`) due to [size restrictions](https://www.jsdelivr.com/documentation#id-configuring-a-default-file-in-packagejson); please consider hosting this particular resource file elsewhere. UKPKG is currently unaffected. For information about the Dynamsoft Service, learn more [here]({{site.extended-usage}}dynamsoft-service-configuration.html).
86+
Note that jsDelivr currently has problems delivering the Dynamsoft Service installer (`https://cdn.jsdelivr.net/npm/dwt@latest/dist/dist/`) due to [size restrictions](https://www.jsdelivr.com/documentation#id-configuring-a-default-file-in-packagejson); please consider hosting this particular resource file elsewhere. UKPKG is currently unaffected. For information about the Dynamsoft Service, learn more [here]({{site.extended-usage}}dynamsoft-service-configuration.html).
8787

8888
```html
8989
<html>
9090
<head>
9191
<!-- Load resources from jsDelivr CDN -->
92-
<script src="https://cdn.jsdelivr.net/npm/dwt@18.5.0/dist/dynamsoft.webtwain.min.js"></script>
92+
<script src="https://cdn.jsdelivr.net/npm/dwt@latest/dist/dynamsoft.webtwain.min.js"></script>
9393
</head>
9494

9595
<body>
9696
<script>
97-
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/npm/dwt@18.5.0/dist"; // Load supporting resources from here
97+
Dynamsoft.DWT.ResourcesPath = "https://cdn.jsdelivr.net/npm/dwt@latest/dist"; // Load supporting resources from here
9898
Dynamsoft.DWT.ProductKey = ""; // Add product key here
9999
</script>
100100
</body>

getstarted/vue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ export default {
9494
},
9595
data() {
9696
return {
97-
containerId: "dwtControlContainer",
97+
containerId: "dwtcontrolContainer",
9898
sourceList: [],
9999
selectedIndex: 0,
100100
};

0 commit comments

Comments
 (0)