Skip to content

Commit b13c0ff

Browse files
Tom-DynamsoftTom-Dynamsoft
committed
build the file structure
1 parent 0cff8bc commit b13c0ff

31 files changed

+1137
-1
lines changed

‎.github/workflows/main.yml‎

Whitespace-only changes.

‎.vscode/extensions.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"nikolaosgeorgiou.html-fmt-vscode"
4+
]
5+
}

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# capture-vision-docs-js
1+
# Dynamsoft Capture Vision JS Docs
2+
3+
This is the repository for maintaining the official documentation of Capture Vision Router for JavaScript.

‎_config.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
repositoryUrl: https://github.com/dynamsoft-docs/capture-vision-docs-js/blob/main
2+
repository: dynamsoft-docs/capture-vision-docs-js
3+
docFullPath: https://www.dynamsoft.com/capture-vision2/docs/
4+
firstLevelUrl: /capture-vision2/docs/
5+
docHomePage: /capture-vision2/docs/introduction/
6+
7+
introduction: /capture-vision2/docs/introduction/
8+
architecture: /capture-vision2/docs/architecture/
9+
parameter: /capture-vision2/docs/parameters/
10+
parameterFile: /capture-vision2/docs/parameters/file/
11+
parameterReference: /capture-vision2/docs/parameters/reference/
12+
13+
assets: /capture-vision2/docs/assets/
14+
edit_icon: /capture-vision2/docs/assets/img-icon/edit-icon.png
15+
smile_icon: /capture-vision2/docs/assets/img-icon/icon-smile.png
16+
sad_icon: /capture-vision2/docs/assets/img-icon/icon-sad.png
17+
dbr_icon: /capture-vision2/docs/assets/img-icon/icon-dbr.svg
18+
dwt_icon: /capture-vision2/docs/assets/img-icon/icon-dwt.svg
19+
dnt_icon: /capture-vision2/docs/assets/img-icon/icon-dnt.svg
20+
21+
useVersionTree: true
22+
23+
baseurl: "/capture-vision2/docs"
24+
plugins:
25+
- jemoji
26+
27+
url: "https://www.dynamsoft.com" # sitemap root
28+

‎_data/full_tree.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
tree_file_list:
2+
- sidelist-full-tree.html
3+

‎_data/product_version.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
version_info_list:
2+
- latest version

‎_includes/dcvNav.html‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<style>
2+
#cv-header .action-buttons {
3+
display: none;
4+
}
5+
6+
#mdHeader {
7+
border-bottom: 0!important;
8+
}
9+
10+
#sideBarCnt.sidebar-fixed {
11+
position: fixed;
12+
top: 88px;
13+
max-height: unset;
14+
}
15+
16+
.rightSideMenu.rsm-fixed {
17+
position: fixed;
18+
top: 100px;
19+
}
20+
21+
#docHead {
22+
top: 186px;
23+
}
24+
25+
.productMenu .downloadBtn:hover {
26+
color: #ffffff!important;
27+
}
28+
29+
@media (max-width: 1679px) {
30+
#docHead {
31+
top: 145px;
32+
}
33+
}
34+
</style>
35+
36+
<div id="CaptureVision" class="main">
37+
<div id="CaptureVisionMenu" class="productMenu">
38+
<div class="container pcProductMenu">
39+
<div class="row">
40+
<div class="col-xs-12">
41+
<ul class="menuList">
42+
<li class="title"><a class="orangeLink" href="{{site.overview}}">Dynamsoft Capture Vision</a></li>
43+
<li class="item overview">
44+
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
45+
</li>
46+
</ul>
47+
</div>
48+
</div>
49+
</div>
50+
<div class="container mobileProductMenu">
51+
<div class="row">
52+
<div class="col-xs-12">
53+
<div class="productLogo" style="color:#fe8e14!important;font:10px">Dynamsoft Capture Vision <i class="icon-orange-angle"></i></div>
54+
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
55+
</div>
56+
</div>
57+
</div>
58+
<div class="mobileProductDetailMenu">
59+
<div class="container">
60+
<div class="row">
61+
<div class="col-xs-12">
62+
<ul class="menuList">
63+
<li class="item"><a href="{{site.firstLevelUrl}}">Documentation</a></li>
64+
</ul>
65+
</div>
66+
</div>
67+
</div>
68+
</div>
69+
</div>
70+
</div>

‎_includes/sidelist-full-tree.html‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<li>
2+
<a href="{{ site.introduction }}" class="otherLinkColour">Introduction</a>
3+
</li>
4+
<li>
5+
<a href="{{ site.architecture }}" class="otherLinkColour">Architecture</a>
6+
<!-- <ul>
7+
<li><a href="{{ site.architecture }}std-input.html" class="otherLinkColour">Input</a></li>
8+
<li><a href="{{ site.architecture }}image-processing/index.html" class="otherLinkColour">Image
9+
Processing</a>
10+
<ul>
11+
<li><a href="{{ site.architecture }}image-processing/region-predetection.html"
12+
class="otherLinkColour">Region Pre-detection</a></li>
13+
<li><a href="{{ site.architecture }}image-processing/shared-detection.html"
14+
class="otherLinkColour">Shared
15+
Detection</a></li>
16+
<li><a href="{{ site.architecture }}image-processing/barcode-localization.html"
17+
class="otherLinkColour">Barcode Localization</a></li>
18+
<li><a href="{{ site.architecture }}image-processing/barcode-decoding.html"
19+
class="otherLinkColour">Barcode
20+
Decoding</a></li>
21+
<li><a href="{{ site.architecture }}image-processing/textline-localization.html"
22+
class="otherLinkColour">Textline Localization</a></li>
23+
<li><a href="{{ site.architecture }}image-processing/textline-recognition.html"
24+
class="otherLinkColour">Textline Recognition</a></li>
25+
<li><a href="{{ site.architecture }}image-processing/document-detection.html"
26+
class="otherLinkColour">Document Detection</a></li>
27+
<li><a href="{{ site.architecture }}image-processing/document-normalization.html"
28+
class="otherLinkColour">Document Normalization</a></li>
29+
</ul>
30+
</li>
31+
<li><a href="{{ site.architecture }}semantic-processing.html" class="otherLinkColour">Semantic
32+
Processing</a>
33+
</li>
34+
<li><a href="{{ site.architecture }}std-output.html" class="otherLinkColour">Output</a></li>
35+
</ul> -->
36+
</li>
37+
<li>
38+
<a href="{{ site.parameter }}" class="otherLinkColour">Parameters</a>
39+
<ul>
40+
<li><a href="{{ site.parameterFile }}" class="otherLinkColour">Parameter Organization</a>
41+
<ul>
42+
<li><a href="{{ site.parameterFile }}capture-vision-template.html"
43+
class="otherLinkColour">CaptureVisionTemplate Object</a></li>
44+
<li><a href="{{ site.parameterFile }}image-source-options.html"
45+
class="otherLinkColour">ImageSource Object</a></li>
46+
<li><a href="{{ site.parameterFile }}target-ROI-def-options/"
47+
class="otherLinkColour">TargetROIDefi Object</a></li>
48+
<li><a href="{{ site.parameterFile }}semantic-processing-options/"
49+
class="otherLinkColour">SemanticProcessing Object</a>
50+
</li>
51+
<li><a href="{{ site.parameterFile }}task-settings/" class="otherLinkColour">Task
52+
Settings</a>
53+
<ul>
54+
<li><a href="{{ site.parameterFile }}task-settings/barcode-reader-task-setting-options.html"
55+
class="otherLinkColour">BarcodeReaderTaskSetting
56+
Object</a></li>
57+
<li><a href="{{ site.parameterFile }}task-settings/label-recognizer-task-setting-options.html"
58+
class="otherLinkColour">LabelRecognizerTaskSetting
59+
Object</a></li>
60+
<li><a href="{{ site.parameterFile }}task-settings/document-normalizer-task-setting-options.html"
61+
class="otherLinkColour">DocumentNormalizerTaskSetting
62+
Object</a></li>
63+
<li><a href="{{ site.parameterFile }}task-settings/code-parser-task-setting-options.html"
64+
class="otherLinkColour">CodeParserTaskSetting Object</a>
65+
</li>
66+
</ul>
67+
</li>
68+
<li><a href="{{ site.parameterFile }}image-parameter-array.html"
69+
class="otherLinkColour">ImagePapameter Object</a></li>
70+
<li><a href="{{ site.parameterFile }}auxiliary/" class="otherLinkColour">Auxiliary
71+
Settings</a>
72+
<ul>
73+
<li><a href="{{ site.parameterFile }}auxiliary/barcode-format-specification-options.html"
74+
class="otherLinkColour">BarcodeFormatSpecification
75+
Object</a></li>
76+
<li><a href="{{ site.parameterFile }}auxiliary/textline-specification-options.html"
77+
class="otherLinkColour">TextLineSpecification
78+
Object</a></li>
79+
<li><a href="{{ site.parameterFile }}auxiliary/character-model-array.html"
80+
class="otherLinkColour">CharacterModel Object</a>
81+
</li>
82+
<li><a href="{{ site.parameterFile }}auxiliary/global-parameter.html"
83+
class="otherLinkColour">GlobalParameter Object</a></li>
84+
</ul>
85+
</li>
86+
</ul>
87+
</li>
88+
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter References</a>
89+
<ul>
90+
<li><a href="{{ site.parameterReference }}barcode-format-ids.html"
91+
class="otherLinkColour">BarcodeFormatIds</a></li>
92+
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 2</a></li>
93+
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 3</a></li>
94+
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 4</a></li>
95+
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 5</a></li>
96+
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 6</a></li>
97+
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 7</a></li>
98+
</ul>
99+
</li>
100+
</ul>
101+
</li>

‎_layouts/default-layout.html‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
4+
{%- include head.html -%}
5+
{%- assign noTitleIndex = "" -%}
6+
{%- if page.noTitleIndex or page.url contains 'release-notes' -%}
7+
{%- assign noTitleIndex = "noTitleIndex" -%}
8+
{%- endif -%}
9+
<body>
10+
<div class="headWrapper">
11+
{%- include page_header.html -%}
12+
</div>
13+
{%- include dcvNav.html -%}
14+
<div class="sideBarIcon"><i class="fa fa-list" style="margin-right: 5px;"></i> Table of contents</div>
15+
<div class="container" id="categoryMenuTree">
16+
<div class="row">
17+
<div class="sideBar col-xs-12 col-md-3 hide-xs hide-sm">
18+
<div id="sideBarCnt">
19+
<div class="docSearchPart" style="margin-top: 30px;">
20+
<input id="txtSearch" class="search" type="text">
21+
</div>
22+
<div class="mainPage">
23+
<ul id="fullTreeMenuListContainer" name="listLevel1">
24+
</ul>
25+
</div>
26+
</div>
27+
</div>
28+
<div class="docContainer col-xs-12 col-md-9">
29+
<div id="docHead" class="head row hide-xs hide-sm">
30+
{%- include main-page-head.html -%}
31+
</div>
32+
<div class="main row showRightSideMenu" id="articleContent" data-needh3="{{page.needGenerateH3Content}}">
33+
<div class="content markdown-body headCounter {{noTitleIndex}} col-xs-12 col-md-12 col-lg-9 col-xl-10 showRightSideMenu" style="margin-bottom: 20px;">
34+
<div class="dbrThanksDownloading">
35+
<p class="thanksDownloadTitle">Thanks for downloading Dynamsoft Barcode Reader <span class="editionName"></span> Package!</p>
36+
<p style="margin-bottom: 0;">Your download will start shortly. If your download does not begin, <a class="bluelink downloadlink" href="">click here to retry</a>.</p>
37+
</div>
38+
{{ content }}
39+
40+
</div>
41+
<div class="rightSideMenu col-xs-12 col-md-12 col-lg-3 col-xl-2 hide-md hide-sm hide-xs showRightSideMenu">
42+
<div id="compatibleInfo">
43+
<p>This page is compatible for:</p>
44+
<p class="compatibleCurVersion">Version 7.5.0</p>
45+
</div>
46+
<div id="feedbackFooter" style="color: #306877;">
47+
<p class="fontOswald">Is this page helpful? </p>
48+
<a href="javascript:void(0)" style="color: #306877;" class="recordLink smileLink" onclick="UsefulRecord(true)"><img class="icon-smile" src="{{ site.smile_icon }}" alt="Yes" />Yes</a>
49+
<a href="javascript:void(0)" style="color: #306877;" class="recordLink sadLink" onclick="UsefulRecord(false)"><img class="icon-sad" src="{{ site.sad_icon }}" alt="No" />No</a>
50+
</div>
51+
<hr /> {%- if page.needAutoGenerateSidebar -%}
52+
<p class="fontOswald" style="color: #306877;"> In this article: </p>
53+
<div id="AutoGenerateSidebar"></div>
54+
{%- endif -%}
55+
</div>
56+
</div>
57+
<div class="main row" style="display: none; background: #f5f5f5;" id="loadingContent">
58+
<div class="loading" id="loadingLogin">
59+
<div class="lds-ring"><div></div><div></div><div></div><div></div></div>
60+
</div>
61+
</div>
62+
</div>
63+
</div>
64+
</div>
65+
<div class="history list" id="categoryMenuTree_history">
66+
<div class="container">
67+
<div class="col-xs-12">
68+
{%- include liquid_autoGenerateHistoryList.html -%} {%- include auto-version-list.html -%}
69+
</div>
70+
</div>
71+
</div>
72+
<div id="footerWrapper">
73+
{%- include page_footer.html -%}
74+
</div>
75+
76+
<iframe id="sideBarIframe" src="{{site.firstLevelUrl}}/Hide_Tree_Page.html" allow="" height="0" frameborder="0"></iframe>
77+
<script type="text/javascript">
78+
anchors.add();
79+
</script>
80+
81+
82+
<script type="text/javascript">
83+
UrlReplace();
84+
</script>
85+
86+
<script type="text/javascript">
87+
FullTreeMenuList('{{page.needAutoGenerateSidebar}}', '{{page.needGenerateH3Content}}', '{{page.pageStartVer}}', '{{site.useVersionTree}}');
88+
</script>
89+
90+
{%- include livehelp.html -%}
91+
92+
93+
<!-- for dcv -->
94+
<script type="text/javascript">
95+
$(document).ready(function() {
96+
97+
$('#txtSearch').keydown(function(e) {
98+
if (e.keyCode == 13) {
99+
let lang = getCurrentUrlLang(document.URL, true)
100+
if (!lang || lang == '') {
101+
window.location.href = '/capture-vision2/search.html?q=' + $('#txtSearch').val();
102+
} else if (lang == 'android' || lang == 'objectivec-swift') {
103+
window.location.href = '/capture-vision2/search.html?refinement=mobile_native_app&q=' + $('#txtSearch').val();
104+
} else if (lang == 'javascript') {
105+
window.location.href = '/capture-vision2/search.html?refinement=javascript_web&q=' + $('#txtSearch').val();
106+
} else if (lang == 'cplusplus' || lang == 'c') {
107+
window.location.href = '/capture-vision2/search.html?refinement=c/c++&q=' + $('#txtSearch').val();
108+
} else if (lang == 'java') {
109+
window.location.href = '/capture-vision2/search.html?refinement=java&q=' + $('#txtSearch').val();
110+
} else if (lang == 'dotnet') {
111+
window.location.href = '/capture-vision2/search.html?refinement=.net&q=' + $('#txtSearch').val();
112+
} else {
113+
window.location.href = '/capture-vision2/search.html?q=' + $('#txtSearch').val();
114+
}
115+
}
116+
})
117+
})
118+
</script>
119+
120+
<!-- Google Tag Manager -->
121+
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-538F83"
122+
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
123+
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
124+
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
125+
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
126+
'//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
127+
})(window,document,'script','dataLayer','GTM-538F83');</script>
128+
<!-- End Google Tag Manager -->
129+
</body>
130+
131+
</html>

0 commit comments

Comments
 (0)