Merge pull request #261 from dynamsoft-docs/preview

add upgrade guide

Author: tony-xlh

_data/full_tree.yml

@@ -7,6 +7,7 @@ tree_file_list:
   - sidelist-apis.html
   - sidelist-releasenotes.html
   - sidelist-faq.html
+  - sidelist-upgrade-guide.html
   - sidelist-full-tree.html
   - sidelist-apis-v1.0.0.html
   - sidelist-apis-v1.1.html

_includes/sidelist-full-tree.html

@@ -5,4 +5,5 @@
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-ui.html" -%}
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-apis.html" -%}
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%}
-{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-faq.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-faq.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-upgrade-guide.html" -%}

_includes/sidelist-upgrade-guide.html

@@ -0,0 +1 @@
+<li><a href="{{ site.firstLevelUrl }}/upgrade-guide/index.html" class="otherLinkColour">Upgrade Guide</a></li>

faq/index.md

@@ -3,7 +3,7 @@ layout: default-layout
 needAutoGenerateSidebar: true
 needGenerateH3Content: true
 noTitleIndex: true
-title: Dynamic Web TWAIN SDK FAQ
+title: Dynamsoft Document Viewer FAQ
 keywords: Documentation, Dynamsoft Document Viewer, FAQ
 breadcrumbText: FAQ
 description: Dynamsoft Document Viewer Documentation FAQ

index.md

@@ -57,4 +57,5 @@ description: Dynamsoft Document Viewer Documentation Homepage
         - [Update UI dynamically]({{ site.ui }}customize/dynamically.html)
 - [API Reference]({{ site.api }}index.html)
 - [Release Notes]({{ site.releasenotes }}index.html)
-- [FAQ]({{ site.faq }}index.html)
+- [FAQ]({{ site.faq }}index.html)
+- [Upgrade Guide](/upgrade-guide/index.md)

ui/default_ui.md

@@ -34,7 +34,8 @@ Default UiConfig:
     type: Dynamsoft.DDV.Elements.Layout,
     flexDirection: "column",
     className: "ddv-edit-viewer-mobile",
-    children: [{
+    children: [
+        {
             type: Dynamsoft.DDV.Elements.Layout,
             className: "ddv-edit-viewer-header-mobile",
             children: [
@@ -83,7 +84,8 @@ Default UiConfig:
     type: Dynamsoft.DDV.Elements.Layout,
     flexDirection: "column",
     className: "ddv-edit-viewer-desktop",
-    children: [{
+    children: [
+        {
             type: Dynamsoft.DDV.Elements.Layout,
             className: "ddv-edit-viewer-header-desktop",
             children: [{

upgrade-guide/index.md

@@ -0,0 +1,49 @@
+---
+layout: default-layout
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+title: Upgrade Guide Dynamsoft Document Viewer Documentation 
+keywords: Documentation, Dynamsoft Document Viewer, Upgrade
+breadcrumbText: Upgrade Guide
+description: Upgrade guide for Dynamsoft Document Viewer
+---
+
+# Upgrade Guide
+
+Upgrading Dynamsoft Document Viewer from an old version to the latest version (v3.x as of now) is straightforward. You need to pay attention to the following changes:
+
+* Changes of APIs
+* Changes of [`UIConfig`](/api/interface/uiconfig.md)
+
+
+There are some code snippets that are frequently used and we will talk about the changes you have to make.
+
+## Initialization of Edit Viewer
+
+In v2.x, you can use an additional options parameter to enable the annotation icon in the default UI.
+
+```js
+const editViewer = new Dynamsoft.DDV.EditViewer({
+    container: "container",
+    uiConfig: Dynamsoft.DDV.getDefaultUiConfig("editViewer", {includeAnnotationSet: true}),
+});
+```
+
+In v3.x, the option is removed and the annotation icon is included in the default UI. So you can just initialize it with the following code:
+
+```js
+const editViewer = new Dynamsoft.DDV.EditViewer({
+    container: "container"
+});
+```
+
+## Default UI Config
+
+The default UI elements may be different across different versions. Check out [this post](/ui/default_ui.md) to learn about the default configs.
+
+You can try to unify the UI across versions by specifying the [`UIConfig`](/api/interface/uiconfig.md). But pay attention to supported [elements](/ui/default_elements.md) of different versions.
+
+## Getting the Page Data
+
+Before v3.x, [`getPageData()`](/api/interface/idocument/index.md#getpagedata) returns a promise object, which was time consuming as it required getting all the image blobs. In v3.x, it directly returns an [`IPageData`](/api/interface/ipagedata.md) object and you can retrieve image blobs with its functions.