Skip to content

Commit 639eb6a

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #25 from dynamsoft-docs/preview
update to internal commit a71bd083
2 parents 2731a5a + 1a18969 commit 639eb6a

File tree

15 files changed

+469
-6
lines changed

15 files changed

+469
-6
lines changed

‎_config.yml‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ dcp_dotnet: /code-parser/docs/server/programming/dotnet/
1212
dcp_dotnet_api: /code-parser/docs/server/programming/dotnet/api-reference/
1313
dcp_dotnet_release_notes: /code-parser/docs/server/programming/dotnet/release-notes/
1414

15+
dcp_python: /code-parser/docs/server/programming/python/
16+
dcp_python_api: /code-parser/docs/server/programming/python/api-reference/
17+
dcp_python_release_notes: /code-parser/docs/server/programming/python/release-notes/
18+
1519
assets: /code-parser/docs/server/assets/
1620
edit_icon: /code-parser/docs/server/assets/img-icon/edit-icon.png
1721
smile_icon: /code-parser/docs/server/assets/img-icon/icon-smile.png
@@ -25,8 +29,10 @@ dcv_enumerations: /capture-vision/docs/core/enums/
2529
dcv_parameters: /capture-vision/docs/core/parameters/
2630
dcv_cpp_api: /capture-vision/docs/server/programming/cplusplus/api-reference/
2731
dcv_dotnet_api: /capture-vision/docs/server/programming/dotnet/api-reference/
32+
dcv_python_api: /capture-vision/docs/server/programming/python/api-reference/
2833

29-
useVersionTree: true
34+
useVersionTree: false
35+
isDCV: true
3036

3137
baseurl: "/code-parser/docs/server"
3238
plugins:
@@ -53,6 +59,16 @@ defaults:
5359
values:
5460
docRootName: "Code Parser C++ Edition"
5561
docHomePage: "/code-parser/docs/server/programming/cplusplus/"
62+
- scope:
63+
path: "programming/dotnet"
64+
values:
65+
docRootName: "Code Parser .NET Edition"
66+
docHomePage: "/code-parser/docs/server/programming/dotnet/"
67+
- scope:
68+
path: "programming/python"
69+
values:
70+
docRootName: "Code Parser Python Edition"
71+
docHomePage: "/code-parser/docs/server/programming/python/"
5672
- scope:
5773
path: "Hide_Tree_Page.html"
5874
values:

‎_data/full_tree.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ tree_file_list:
22
- sidelist-full-tree.html
33
- sidelist-programming/programming-cpp.html
44
- sidelist-programming/programming-dotnet.html
5+
- sidelist-programming/programming-python.html

‎_includes/release-notes/python-highlight-2.4.10.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
* This is the first release of the Python Edition of `DynamsoftCodeParser` SDK integrated with `DynamsoftCaptureVision (DCV)` architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually.
3+
* Added supports to parse following code types:
4+
* [MRTD_TD1_ID]({{ site.dcp_code_types }}mrtd.html)
5+
* [MRTD_TD2_ID]({{ site.dcp_code_types }}mrtd.html)
6+
* [MRTD_TD2_VISA]({{ site.dcp_code_types }}mrtd.html)
7+
* [MRTD_TD3_PASSPORT]({{ site.dcp_code_types }}mrtd.html)
8+
* [MRTD_TD3_VISA]({{ site.dcp_code_types }}mrtd.html)
9+
* [VIN]({{ site.dcp_code_types }}vin.html)
10+
* [AAMVA_DL_ID]({{ site.dcp_code_types }}aamva-dl-id.html)
11+
* [AAMVA_DL_ID_WITH_MAG_STRIPE]({{ site.dcp_code_types }}aamva-dl-id.html)
12+
* [AADHAAR]({{ site.dcp_code_types }}aadhaar.html)
13+
* [SOUTH_AFRICA_DL]({{ site.dcp_code_types }}za-dl.html)
14+

‎_includes/sidelist-full-tree.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<!--
21
<li lang="python">
3-
<a href="{{ site.python }}" class="otherLinkColour">Python Edition Introduction</a>
2+
<a href="{{ site.dcp_python }}" class="otherLinkColour">Python Edition Introduction</a>
43
</li>
54
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-python.html" -%}
5+
<!--
66
<li lang="java">
77
<a href="{{ site.java }}" class="otherLinkColour">Java Edition Introduction</a>
88
</li>

‎_includes/sidelist-programming/programming-dotnet.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<li lang="dotnet" class="category">DEVELOPMENT</li>
2-
<li lang="dotnet"><a class="otherLinkColour">API Reference</a>
2+
<li lang="dotnet"><a href="{{ site.dcp_dotnet_api }}" class="otherLinkColour">API Reference</a>
33
<ul>
44
<li><a class="otherLinkColour">Classes</a>
55
<ul>

‎_includes/sidelist-programming/programming-python.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<li lang="python" class="category">DEVELOPMENT</li>
2+
<li lang="python"><a href="{{ site.dcp_python_api }}" class="otherLinkColour">API Reference</a>
3+
<ul>
4+
<li><a class="otherLinkColour">Classes</a>
5+
<ul>
6+
<li><a href="{{ site.dcp_python_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
7+
<li><a href="{{ site.dcp_python_api }}parsed-result.html" class="otherLinkColour">ParsedResult</a></li>
8+
<li><a href="{{ site.dcp_python_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
9+
</ul>
10+
</li>
11+
<li><a class="otherLinkColour">Enumerations</a>
12+
<ul>
13+
<li><a href="{{ site.dcv_enumerations }}core/error-code.html?lang=python" class="otherLinkColour">EnumErrorCode</a></li>
14+
<li><a href="{{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python" class="otherLinkColour">EnumMappingStatus</a></li>
15+
<li><a href="{{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python" class="otherLinkColour">EnumValidationStatus</a></li>
16+
</ul>
17+
</li>
18+
</ul>
19+
</li>
20+
<li lang="python"><a href="{{ site.dcp_python_release_notes }}" class="otherLinkColour">Release Notes</a>
21+
<ul >
22+
<li ><a href="{{ site.dcp_python_release_notes }}python-2.html" class="otherLinkColour">Version 2.x</a></li>
23+
</ul>
24+
</li>

‎assets/js/dcpServerVersionSearch.json‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,92 @@
8787
"version": "3.4.10"
8888
}
8989
]
90+
},
91+
"python":{
92+
"dcvRepoServer": [
93+
{
94+
"path": "/programming/python/api-reference/capture-vision-router",
95+
"version": "2.4.10"
96+
},
97+
{
98+
"path": "/programming/python/api-reference/core",
99+
"version": "3.2.40"
100+
},
101+
{
102+
"path": "/programming/python/api-reference/image-processing",
103+
"version": "2.2.40"
104+
},
105+
{
106+
"path": "/programming/python/api-reference/license",
107+
"version": "3.2.30"
108+
},
109+
{
110+
"path": "/programming/python/api-reference/utility",
111+
"version": "1.4.10"
112+
}
113+
],
114+
"dcvRepoCore": [
115+
{
116+
"path": "/enums/capture-vision-router",
117+
"version": "2.4.10"
118+
},
119+
{
120+
"path": "/enums/code-parser",
121+
"version": "2.4.10"
122+
},
123+
{
124+
"path": "/enums/core",
125+
"version": "3.2.40"
126+
},
127+
{
128+
"path": "/parameters/reference/barcode-format-specification",
129+
"version": "10.4.10"
130+
},
131+
{
132+
"path": "/parameters/reference/barcode-reader-task-settings",
133+
"version": "10.4.10"
134+
},
135+
{
136+
"path": "/parameters/reference/capture-vision-template",
137+
"version": "2.2.40"
138+
},
139+
{
140+
"path": "/parameters/reference/character-model",
141+
"version": "3.4.10"
142+
},
143+
{
144+
"path": "/parameters/reference/code-parser-task-settings",
145+
"version": "2.4.10"
146+
},
147+
{
148+
"path": "/parameters/reference/global-parameter",
149+
"version": "2.2.40"
150+
},
151+
{
152+
"path": "/parameters/reference/image-parameter",
153+
"version": "2.2.40"
154+
},
155+
{
156+
"path": "/parameters/reference/image-source-options",
157+
"version": "2.2.40"
158+
},
159+
{
160+
"path": "/parameters/reference/label-recognizer-task-settings",
161+
"version": "3.4.10"
162+
},
163+
{
164+
"path": "/parameters/reference/semantic-processing",
165+
"version": "2.2.40"
166+
},
167+
{
168+
"path": "/parameters/reference/target-roi-def",
169+
"version": "2.2.40"
170+
},
171+
{
172+
"path": "/parameters/reference/text-line-specification",
173+
"version": "3.4.10"
174+
}
175+
]
90176
}
91177
}
92178
},

‎index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: home-page
33
title: Dynamsoft Code Parser SDK Documentation
4-
keywords: Dynamsoft Code Parser, dlr, documentation
4+
keywords: Dynamsoft Code Parser, documentation
55
description: Dynamsoft Code Parser SDK Documentation Homepage
66
---
77

@@ -11,9 +11,9 @@ Learn how to use Dynamsoft Code Parser SDK in different programming languages:
1111

1212
- [C++]({{ site.dcp_cpp }})
1313
- [.NET]({{ site.dcp_dotnet }})
14+
- [Python]({{ site.dcp_python }})
1415

1516
Coming soon:
1617

17-
- Python
1818
- C
1919
- Java

‎programming/python/api-reference/code-parser-module.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: default-layout
3+
title: CodeParserModule Class - Dynamsoft Code Parser Module Python Edition API Reference
4+
description: Definition of the CodeParserModule class in Dynamsoft Code Parser Module Python Edition.
5+
keywords: CodeParserModule, api reference, python
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
# CodeParserModule Class
10+
11+
The `CodeParserModule` class defines general functions in the code parser module.
12+
13+
## Definition
14+
15+
*Module:* dynamsoft_code_parser
16+
17+
18+
```python
19+
class CodeParserModule(object)
20+
```
21+
22+
## Methods
23+
24+
| Method | Description |
25+
|----------------------|-------------|
26+
| [`get_version`](#get_version) | Returns the version of the code parser module.|
27+
28+
29+
### get_version
30+
31+
Returns the version of the code parser module.
32+
33+
```python
34+
@staticmethod
35+
def get_version() -> str:
36+
```
37+
38+
**Return Value**
39+
40+
Returns a string representing the version of the code parser module.
41+

‎programming/python/api-reference/index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default-layout
3+
title: Main Page - Dynamsoft Code Parser Module Python Edition API Reference
4+
description: This is the main page of Dynamsoft Code Parser SDK Python Edition API Reference.
5+
keywords: api reference, python
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
---
9+
10+
# API Reference - Dynamsoft Code Parser SDK Python Edition
11+
12+
## Classes
13+
14+
* [`CodeParserModule`]({{ site.dcp_python_api }}code-parser-module.html)
15+
* [`ParsedResult`]({{ site.dcp_python_api }}parsed-result.html)
16+
* [`ParsedResultItem`]({{ site.dcp_python_api }}parsed-result-item.html)
17+
18+
## Enumerations
19+
20+
* [`EnumErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=python)
21+
* [`EnumMappingStatus`]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python)
22+
* [`EnumValiadtionStatus`]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python)

0 commit comments

Comments
 (0)