hdoc-tools 0.61.0 → 0.62.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +89 -75
  3. package/editor/dist/assets/index-Blewr90z.css +1 -1
  4. package/editor/dist/assets/index-BtxvGZHW.js +111 -111
  5. package/editor/dist/assets/spell.worker-sryEKmOj.js +13 -13
  6. package/editor/dist/index.html +14 -14
  7. package/hdoc-build-db.js +275 -275
  8. package/hdoc-build-embeddings.js +202 -202
  9. package/hdoc-build-pdf.js +232 -232
  10. package/hdoc-bump.js +125 -125
  11. package/hdoc-create.js +110 -110
  12. package/hdoc-db.js +114 -114
  13. package/hdoc-help.js +60 -60
  14. package/hdoc-install-browser.js +145 -145
  15. package/hdoc-mermaid.js +204 -204
  16. package/hdoc-module.js +1102 -1102
  17. package/hdoc-validate-config.js +355 -355
  18. package/hdoc-validate-interbook.js +321 -321
  19. package/hdoc-validate.js +1231 -1231
  20. package/hdoc-ver.js +45 -45
  21. package/package.json +12 -1
  22. package/templates/doc-header-non-git.html +19 -19
  23. package/templates/doc-header.html +26 -26
  24. package/templates/init/.github/workflows/hdocbuild_onpull.yml +16 -16
  25. package/templates/init/.github/workflows/hdocbuild_onpush.yml +15 -15
  26. package/templates/init/LICENSE +21 -21
  27. package/templates/init/README.md +9 -9
  28. package/templates/init/_hdocbook/index.md +4 -4
  29. package/templates/init/gitignore +8 -8
  30. package/templates/init/resources/README.md +2 -2
  31. package/templates/pdf/css/custom-block.css +90 -90
  32. package/templates/pdf/css/fonts.css +221 -221
  33. package/templates/pdf/css/hdocs-pdf.css +495 -495
  34. package/templates/pdf/css/vars.css +404 -404
  35. package/templates/pdf/template-footer.html +19 -19
  36. package/templates/pdf/template-header.html +37 -37
  37. package/templates/pdf/template.html +20 -20
  38. package/templates/pdf-header-non-git.html +12 -12
  39. package/templates/pdf-header.html +16 -16
  40. package/ui/content/invalid-hdocbook-json.html +6 -6
  41. package/ui/content/invalid-hdocbook-json.md +7 -7
  42. package/ui/css/theme-default/styles/components/content.css +124 -124
  43. package/ui/css/theme-default/styles/components/sidebar.css +182 -182
  44. package/ui/css/theme-default/styles/htldoc.layouts.css +310 -310
  45. package/ui/index.html +419 -419
package/ui/index.html CHANGED
@@ -1,420 +1,420 @@
1
- <html lang="en-US">
2
-
3
- <head>
4
-
5
- <head>
6
- <base href="">
7
- <script>
8
- var siteBaseLocation = window.location.protocol + '//' + window.location.host + "/";
9
- var baseTag = document.getElementsByTagName('base')[0];
10
- baseTag.href = siteBaseLocation;
11
- </script>
12
-
13
- <title>Hornbill ESP Platform Documentation | Hornbill Platform</title>
14
- <meta charset="utf-8">
15
- <meta name="viewport" content="width=device-width,initial-scale=1">
16
- <meta name="description" content="Internal documentation for the Hornbill ESP Platform">
17
-
18
-
19
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.5/font/bootstrap-icons.css">
20
-
21
- <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet"
22
- integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
23
- <script src="https://code.jquery.com/jquery-3.6.1.min.js"
24
- integrity="sha256-o88AwQnZB+VDvE9tvIXrMQaPlFFSUTR+nldQm1LuPXQ=" crossorigin="anonymous"></script>
25
- <script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.9.2/dist/umd/popper.min.js"
26
- integrity="sha384-IQsoLXl5PILFhosVNubq5LC7Qb9DXgDA9i+tQ8Zj3iwWAwPtgFTxbJ8NT4GN1R8p"
27
- crossorigin="anonymous"></script>
28
- <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.min.js"
29
- integrity="sha384-cVKIPhGWiC2Al4u+LWgxfKTRIcfu0JTxR+EQDz/bgldoEyl4H0zUF0QKbrJ0EcQF"
30
- crossorigin="anonymous"></script>
31
- <script src="https://cdn.jsdelivr.net/npm/vue@2/dist/vue.js"></script>
32
-
33
- <style>
34
- .hb-hidden {
35
- visibility: hidden !important;
36
- }
37
- </style>
38
- <script>
39
-
40
- class APIParamName extends HTMLElement {
41
- constructor() {
42
- super();
43
- // GS: Use this to set a role on the element for ARIO screen-reader directives
44
- this.setAttribute("role", "title");
45
- }
46
- // Element functionality written in here
47
- }
48
- customElements.define("api-param-name", APIParamName);
49
-
50
- class ApiParamOptional extends HTMLElement {
51
- connectedCallback() {
52
- const text = (this.textContent || '').trim();
53
- if (!text) {
54
- this.innerHTML = ''; // remove content
55
- this.setAttribute('no-default-value', '');
56
- }
57
- }
58
- }
59
- customElements.define('api-param-optional', ApiParamOptional);
60
-
61
- var ThemePreference = localStorage.getItem('hdocbook-theme-appearance') || '';
62
- const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches
63
- if (!ThemePreference || ThemePreference === 'auto' ? prefersDark : ThemePreference === 'dark') {
64
- ThemePreference = "dark";
65
- document.documentElement.classList.add('dark')
66
- }
67
-
68
- function loadJS(arrFiles, callback) {
69
- // Head tag
70
- var head = document.getElementsByTagName('head')[0]
71
-
72
- // Creating script element
73
- var loadedCount = 0;
74
- for (let x = 0; x < arrFiles.length; x++) {
75
- var script = document.createElement('script');
76
- script.src = arrFiles[x];
77
- script.type = 'text/javascript';
78
- script.async = false;
79
-
80
- script.onload = function () {
81
- loadedCount++;
82
- if (loadedCount === arrFiles.length) callback();
83
- }
84
-
85
- // Adding script element
86
- head.append(script);
87
- }
88
- }
89
-
90
- function loadCss(arrFiles, callback) {
91
- // Head tag
92
- var head = document.getElementsByTagName('head')[0]
93
-
94
- // Creating link element
95
- var loadedCount = 0;
96
- for (let x = 0; x < arrFiles.length; x++) {
97
- // Creating link element
98
- var style = document.createElement('link');
99
- style.href = arrFiles[x];
100
- style.type = 'text/css';
101
- style.rel = 'stylesheet';
102
- style.async = false;
103
-
104
- style.onload = function () {
105
- loadedCount++;
106
- if (loadedCount === arrFiles.length) callback();
107
- }
108
-
109
- head.append(style);
110
-
111
- }
112
- }
113
-
114
-
115
- </script>
116
-
117
- <!-- template for nav item section -->
118
- <script type="text/x-template" id="nav-section-template">
119
- <section class="DocSidebarGroup" v-bind:class="{collapsible: asection.items && asection.items.length}">
120
- <div class="title" v-on:click="toggleNavCollapse(asection)">
121
- <div class="action">
122
- <div v-if="asection.items && asection.items.length" class="icon">
123
- <i v-bind:class="{'bi bi-chevron-right': !asection.expand,'bi bi-chevron-down': asection.expand}" class="bi"></i>
124
- </div>
125
- </div>
126
- <a class="title-text"><i v-if="asection.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This section is set to draft."></i><i v-if="asection.inline" class="bi bi-files-alt text-warning" title="This section is set to inline."></i> {{asection.text}}</a>
127
- </div>
128
- <div v-show="asection.expand && asection.items" v-for="(navSectionItem, index) in asection.items" class="items">
129
-
130
- <!-- if navSectionItem has no items show clickable link -->
131
- <div v-if="!navSectionItem.items">
132
- <a class="DocLink link noitems" v-bind:href="navSectionItem.link" v-bind:target="navSectionItem.target || ''" style="padding-left: 0px;">
133
- <span class="link-text"><i v-if="navSectionItem.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This page is set to draft."></i><i v-if="asection.inline" class="bi bi-files-alt text-warning" title="This section is set to inline."></i> {{navSectionItem.text}} <i v-if="navSectionItem.target" class="bi bi-box-arrow-up-right"></i> </span>
134
- </a>
135
- </div>
136
-
137
- <nav-section-component v-if="navSectionItem.items" v-bind:asection="navSectionItem"></nav-section-component>
138
-
139
- </div>
140
- </section>
141
- </script>
142
- <!-- eof template-->
143
-
144
- </head>
145
-
146
- <body>
147
-
148
- <div id="vDocDevApp" class="hb-hidden Layout hb-container-vertical" v-on:click="resetMobileMenu($event)">
149
- <!-- top toolbar -->
150
- <div class="toolbar-layout hb-container-horizontal">
151
-
152
- <div class="hb-center-v">
153
- <button class="mobile-menu-btn" v-on:click="toggleMobileMenu()"><i class="bi bi-list-ul"></i></button>
154
- </div>
155
- <div class="toolbar-logo">
156
- <div class="toolbar-logo-image"></div>
157
- </div>
158
- <div class="toolbar-split"></div>
159
- <div class="toolbar-middle hb-center-v hb-container-expand">
160
-
161
- <h2 class="title">{{docApp.title}}</h2>
162
- <h5 class="description">{{docApp.description}}</h5>
163
-
164
- <!-- could generate nav bar based on library settings -->
165
- <!--
166
- <ul class="nav-bar-nav-list">
167
- <li class="nav-bar-item active">
168
- <a>Documentation</a>
169
- </li>
170
- </ul>
171
- -->
172
- </div>
173
- <div class="toolbar-right hb-center-v">
174
-
175
- <!-- theme switch -->
176
- <label class="theme-switch">
177
- <input class="theme-switch-checkbox" type="checkbox" v-on:change="switchViewTheme()">
178
- <span class="slider round">
179
- </span>
180
- </label>
181
- </div>
182
- <div v-if="docApp.userSession" class="toolbar-right hb-center-v">
183
- <!-- user info -->
184
- <div class="userprofile dropdown">
185
- <span class="dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">
186
- <img class="svg-prof" v-bind:src="docApp.userSession.profileImage"
187
- style="width:32;height:32;"></img>
188
- </span>
189
- <ul class="dropdown-menu p-0">
190
-
191
-
192
-
193
- <div class="panel-header border-0 position-relative">
194
- <div class="position-relative">
195
- <div class="text-center fw-bolder lh-3">{{docApp.userSession.userId}}</div>
196
- <div style="height:20px"></div>
197
- </div>
198
- <div class="position-absolute top-100 start-50 translate-middle">
199
- <img class="svg-prof" v-bind:src="docApp.userSession.profileImage"
200
- style="width:64px;height:64px;"></img>
201
- </div>
202
- </div>
203
- <div class="panel-content border-0 border-top p-3 pt-5 fw-light lh-normal">
204
- <div class="text-center fw-bolder p-1">{{docApp.userSession.userName}}</div>
205
- <div class="text-center fw-bolder p-1 fs-12">{{docApp.userSession.email}}</div>
206
- </div>
207
- <div class="panel-content p-3 border-0 border-top fw-light lh-normal">
208
- <div class="lh-normal fs-12"><i class="bi bi-database-lock"></i> <span
209
- style="display:inline-block;width:48px">Issuer</span> :
210
- {{docApp.userSession.issuerInstance}}</div>
211
- <div class="lh-normal fs-12" v-bind:title="docApp.userSession.expiresDateTime"><i
212
- class="bi bi-hourglass-split"></i> <span
213
- style="display:inline-block;width:48px">Expires</span> : {{new
214
- Date(docApp.userSession.validUntil).toLocaleDateString()}}</div>
215
- </div>
216
- </ul>
217
- </div>
218
- </div>
219
- </div>
220
-
221
- <!-- 100% horizontal col below toolbar and auto adjust vertical to take rest of avail height -->
222
- <div class="main-layout hb-container-horizontal hb-container-expand hb-hidden">
223
-
224
- <!-- the left hand nav col -->
225
- <aside class="DocSidebar hb-container-vertical hb-hidden">
226
-
227
- <nav class="hdoc-nav hb-container-expand" id="DocSidebarNav" aria-labelledby="sidebar-aria-label"
228
- tabindex="-1">
229
- <div v-for="(navSection,index) in docApp.navSections" v-bind:class="{'group':navSection.items, 'nogrouplink':!navSection.items}">
230
-
231
- <div v-show="!navSection.items">
232
- <a class="DocLink link noitems" v-bind:href="navSection.link"
233
- v-bind:target="navSection.target || ''" style="padding-left: 0px;">
234
- <span class="link-text">{{navSection.text}} <i v-if="navSection.target"
235
- class="bi bi-box-arrow-up-right"></i> </span>
236
- </a>
237
- </div>
238
-
239
- <div v-show="navSection.items">
240
- <nav-section-component v-show="navSection.items" :key="updateCounter"
241
- v-bind:asection="navSection"></nav-section-component>
242
- </div>
243
- </div>
244
-
245
- <div v-if="docApp.hasInlinePopupDocuments" class="nogrouplink">
246
- <div>
247
- <a class="DocLink link noitems" v-on:click="showInlineDocumentList($event)">
248
- <span class="link-text">
249
- Inline Help Documents
250
- </span>
251
- </a>
252
- </div>
253
- </div>
254
-
255
- </nav>
256
-
257
- </aside>
258
-
259
- <!-- the right hand content col -->
260
- <div class="DocContent hb-container-expand hb-container-vertical" id="DocContent">
261
- <div class="HTL-doc content-wrapper hb-container-expand">
262
-
263
- <div v-show="!docApp.showInlineDocumentsMarkup" class="injected-document-container hb-container-horizontal">
264
-
265
- <div class="injected-document-content">
266
- <div v-if="docApp.error === ''">
267
- <div class="document-header">
268
-
269
- <!-- breadcrumb-->
270
- <div class="hb-container-horizontal">
271
- <div class="hb-center-v hb-container-expand">
272
- <ul class="ps-0 nav-bar-nav-list noeffects after-fslash overflow-ellipsis">
273
- <li class="mt-0 nav-bar-item"
274
- v-for="(crumb,$index) in docApp.bookBreadCrumb">
275
- <a class="ps-0 pe-0 text-decoration-none"
276
- v-bind:href="crumb.link">{{crumb.title}}</a>
277
- </li>
278
- </ul>
279
- </div>
280
- <div class="toolbar-right hb-center-v">
281
-
282
- <a class="toolbar-action" v-bind:href="docApp.documentGithubUrl"
283
- target="_blank">
284
- <i class="bi bi-pencil"></i>
285
- </a>
286
-
287
- <a class="toolbar-action">
288
- <i class="bi bi-three-dots-vertical"></i>
289
- </a>
290
- </div>
291
- </div>
292
-
293
- <div class="document-title"></div>
294
-
295
- <!-- doc frontmatter info -->
296
- <div class="hb-container-horizontal">
297
- <div class="hb-center-v hb-container-expand">
298
- <ul
299
- class="ps-0 nav-bar-nav-list noeffects after-bullets overflow-ellipsis text-light-2">
300
- <li class="ps-0 mt-0 nav-bar-item">
301
- Article
302
- </li>
303
- <li class="ps-0 mt-0 nav-bar-item">
304
- YYYY-MM-DD
305
- </li>
306
- <li class="ps-0 mt-0 nav-bar-item">
307
- (n) minutes to read
308
- </li>
309
- <li class="ps-0 mt-0 nav-bar-item">
310
- <a class="link c-pointer">(n) contributors</a>
311
- </li>
312
- </ul>
313
- </div>
314
- <div class="toolbar-right hb-center-v">
315
- </div>
316
- </div>
317
-
318
- </div>
319
- <div class="document-body"></div>
320
- </div>
321
-
322
- <div v-if="docApp.error !== ''">
323
- <div class="alert alert-danger" role="alert">
324
- <h1>Book Navigation Render Failed!</h1>
325
- <p>This is likely due to invalid JSON in the <strong>hdocbook.json</strong> file in your book. Please fix the error below, then refresh your browser to reload the book.</p>
326
- <p><code>{{docApp.error}}</code></p>
327
- </div>
328
- </div>
329
-
330
- </div>
331
-
332
-
333
- <!-- table of contents -->
334
- <div v-if="docApp.keepTocLayout" class="injected-document-toc">
335
- <div v-if="docApp.tableOfContents.length" class="panel-header">
336
- <span class="icon">
337
- <i class="bi bi-list-ul"></i>
338
- </span>
339
- <span class="title">In This Document</span>
340
- </div>
341
- <div v-if="docApp.tableOfContents.length" class="panel-content">
342
- <div v-for="tocItem in docApp.tableOfContents"
343
- v-bind:class="{'ms-3':tocItem.tagName=='H3'}">
344
- <a :href="tocItem.href">{{tocItem.eleText}}</a>
345
- </div>
346
- </div>
347
- </div>
348
-
349
- </div>
350
-
351
- <!-- show inline document links -->
352
- <div v-if="docApp.showInlineDocumentsMarkup" class="hb-container-vertical">
353
-
354
- <!-- the problem is the test server doesn't serve inline documents like the live/proper one ?? -->
355
- <div class="modal fade" id="inlineModal" tabindex="-1" role="dialog" aria-hidden="true">
356
- <div class="modal-dialog" role="document">
357
- <div class="modal-content">
358
- <iframe v-if="docApp.inlinePopupDocumentHref" v-bind:src="docApp.inlinePopupDocumentHref"></iframe>
359
- </div>
360
- </div>
361
- </div>
362
-
363
-
364
- <div class="p-4">
365
-
366
- <div class="document-header">
367
- <div class="document-title"><h1>Inline Help Documents (DOES NOT WORK) - NOTE DEV SERVER NEEDS _inline.html PROCESSING - NEED TO SPEAK TO GERRY</h1></div>
368
- </div>
369
-
370
- <div class="p-2">
371
- <div v-for="(navSectionItem,index) in docApp.inlineDocumentItems">
372
-
373
- <a class="DocLink link noitems" href="#" v-on:click="popupInlineDocument($event,navSectionItem)" style="padding-left: 0px;">
374
- <span class="link-text"><i v-if="navSectionItem.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This page is set to draft."></i><i class="bi bi-files-alt text-warning"></i> {{navSectionItem.text}}</span>
375
- </a>
376
-
377
- </div>
378
- </div>
379
- </div>
380
- </div>
381
-
382
-
383
- </div>
384
- </div>
385
-
386
- </div>
387
-
388
- </div> <!-- <div class="main hb-vertical-expand"> -->
389
-
390
-
391
-
392
- </body>
393
- <script>
394
-
395
- //-- we load these like this as we have set the BASE location of the document - so have to load these after doc
396
- loadCss([
397
- "css/theme-default/styles/fonts.css",
398
- "css/theme-default/styles/vars.css",
399
- "css/theme-default/styles/base.css",
400
- "css/theme-default/styles/htldoc.layouts.css",
401
-
402
- "css/theme-default/styles/components/htl-doc.css",
403
- "css/theme-default/styles/components/sidebar.css",
404
- "css/theme-default/styles/components/content.css",
405
- "css/theme-default/styles/components/custom-block.css",
406
- "css/theme-default/styles/components/api-doc.css",
407
-
408
- "js/highlightjs/styles/vs2015.css"
409
- ], function () {
410
- //-- required js + 3rd party libs
411
- setTimeout(function () {
412
- loadJS(["js/doc.hornbill.js", "js/highlightjs/highlight.pack.js", "js/highlightjs-badge.js"], function () {
413
- intialiseApp();
414
- });
415
- }, 50);
416
- });
417
-
418
- </script>
419
-
1
+ <html lang="en-US">
2
+
3
+ <head>
4
+
5
+ <head>
6
+ <base href="">
7
+ <script>
8
+ var siteBaseLocation = window.location.protocol + '//' + window.location.host + "/";
9
+ var baseTag = document.getElementsByTagName('base')[0];
10
+ baseTag.href = siteBaseLocation;
11
+ </script>
12
+
13
+ <title>Hornbill ESP Platform Documentation | Hornbill Platform</title>
14
+ <meta charset="utf-8">
15
+ <meta name="viewport" content="width=device-width,initial-scale=1">
16
+ <meta name="description" content="Internal documentation for the Hornbill ESP Platform">
17
+
18
+
19
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.5/font/bootstrap-icons.css">
20
+
21
+ <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet"
22
+ integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
23
+ <script src="https://code.jquery.com/jquery-3.6.1.min.js"
24
+ integrity="sha256-o88AwQnZB+VDvE9tvIXrMQaPlFFSUTR+nldQm1LuPXQ=" crossorigin="anonymous"></script>
25
+ <script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.9.2/dist/umd/popper.min.js"
26
+ integrity="sha384-IQsoLXl5PILFhosVNubq5LC7Qb9DXgDA9i+tQ8Zj3iwWAwPtgFTxbJ8NT4GN1R8p"
27
+ crossorigin="anonymous"></script>
28
+ <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.min.js"
29
+ integrity="sha384-cVKIPhGWiC2Al4u+LWgxfKTRIcfu0JTxR+EQDz/bgldoEyl4H0zUF0QKbrJ0EcQF"
30
+ crossorigin="anonymous"></script>
31
+ <script src="https://cdn.jsdelivr.net/npm/vue@2/dist/vue.js"></script>
32
+
33
+ <style>
34
+ .hb-hidden {
35
+ visibility: hidden !important;
36
+ }
37
+ </style>
38
+ <script>
39
+
40
+ class APIParamName extends HTMLElement {
41
+ constructor() {
42
+ super();
43
+ // GS: Use this to set a role on the element for ARIO screen-reader directives
44
+ this.setAttribute("role", "title");
45
+ }
46
+ // Element functionality written in here
47
+ }
48
+ customElements.define("api-param-name", APIParamName);
49
+
50
+ class ApiParamOptional extends HTMLElement {
51
+ connectedCallback() {
52
+ const text = (this.textContent || '').trim();
53
+ if (!text) {
54
+ this.innerHTML = ''; // remove content
55
+ this.setAttribute('no-default-value', '');
56
+ }
57
+ }
58
+ }
59
+ customElements.define('api-param-optional', ApiParamOptional);
60
+
61
+ var ThemePreference = localStorage.getItem('hdocbook-theme-appearance') || '';
62
+ const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches
63
+ if (!ThemePreference || ThemePreference === 'auto' ? prefersDark : ThemePreference === 'dark') {
64
+ ThemePreference = "dark";
65
+ document.documentElement.classList.add('dark')
66
+ }
67
+
68
+ function loadJS(arrFiles, callback) {
69
+ // Head tag
70
+ var head = document.getElementsByTagName('head')[0]
71
+
72
+ // Creating script element
73
+ var loadedCount = 0;
74
+ for (let x = 0; x < arrFiles.length; x++) {
75
+ var script = document.createElement('script');
76
+ script.src = arrFiles[x];
77
+ script.type = 'text/javascript';
78
+ script.async = false;
79
+
80
+ script.onload = function () {
81
+ loadedCount++;
82
+ if (loadedCount === arrFiles.length) callback();
83
+ }
84
+
85
+ // Adding script element
86
+ head.append(script);
87
+ }
88
+ }
89
+
90
+ function loadCss(arrFiles, callback) {
91
+ // Head tag
92
+ var head = document.getElementsByTagName('head')[0]
93
+
94
+ // Creating link element
95
+ var loadedCount = 0;
96
+ for (let x = 0; x < arrFiles.length; x++) {
97
+ // Creating link element
98
+ var style = document.createElement('link');
99
+ style.href = arrFiles[x];
100
+ style.type = 'text/css';
101
+ style.rel = 'stylesheet';
102
+ style.async = false;
103
+
104
+ style.onload = function () {
105
+ loadedCount++;
106
+ if (loadedCount === arrFiles.length) callback();
107
+ }
108
+
109
+ head.append(style);
110
+
111
+ }
112
+ }
113
+
114
+
115
+ </script>
116
+
117
+ <!-- template for nav item section -->
118
+ <script type="text/x-template" id="nav-section-template">
119
+ <section class="DocSidebarGroup" v-bind:class="{collapsible: asection.items && asection.items.length}">
120
+ <div class="title" v-on:click="toggleNavCollapse(asection)">
121
+ <div class="action">
122
+ <div v-if="asection.items && asection.items.length" class="icon">
123
+ <i v-bind:class="{'bi bi-chevron-right': !asection.expand,'bi bi-chevron-down': asection.expand}" class="bi"></i>
124
+ </div>
125
+ </div>
126
+ <a class="title-text"><i v-if="asection.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This section is set to draft."></i><i v-if="asection.inline" class="bi bi-files-alt text-warning" title="This section is set to inline."></i> {{asection.text}}</a>
127
+ </div>
128
+ <div v-show="asection.expand && asection.items" v-for="(navSectionItem, index) in asection.items" class="items">
129
+
130
+ <!-- if navSectionItem has no items show clickable link -->
131
+ <div v-if="!navSectionItem.items">
132
+ <a class="DocLink link noitems" v-bind:href="navSectionItem.link" v-bind:target="navSectionItem.target || ''" style="padding-left: 0px;">
133
+ <span class="link-text"><i v-if="navSectionItem.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This page is set to draft."></i><i v-if="asection.inline" class="bi bi-files-alt text-warning" title="This section is set to inline."></i> {{navSectionItem.text}} <i v-if="navSectionItem.target" class="bi bi-box-arrow-up-right"></i> </span>
134
+ </a>
135
+ </div>
136
+
137
+ <nav-section-component v-if="navSectionItem.items" v-bind:asection="navSectionItem"></nav-section-component>
138
+
139
+ </div>
140
+ </section>
141
+ </script>
142
+ <!-- eof template-->
143
+
144
+ </head>
145
+
146
+ <body>
147
+
148
+ <div id="vDocDevApp" class="hb-hidden Layout hb-container-vertical" v-on:click="resetMobileMenu($event)">
149
+ <!-- top toolbar -->
150
+ <div class="toolbar-layout hb-container-horizontal">
151
+
152
+ <div class="hb-center-v">
153
+ <button class="mobile-menu-btn" v-on:click="toggleMobileMenu()"><i class="bi bi-list-ul"></i></button>
154
+ </div>
155
+ <div class="toolbar-logo">
156
+ <div class="toolbar-logo-image"></div>
157
+ </div>
158
+ <div class="toolbar-split"></div>
159
+ <div class="toolbar-middle hb-center-v hb-container-expand">
160
+
161
+ <h2 class="title">{{docApp.title}}</h2>
162
+ <h5 class="description">{{docApp.description}}</h5>
163
+
164
+ <!-- could generate nav bar based on library settings -->
165
+ <!--
166
+ <ul class="nav-bar-nav-list">
167
+ <li class="nav-bar-item active">
168
+ <a>Documentation</a>
169
+ </li>
170
+ </ul>
171
+ -->
172
+ </div>
173
+ <div class="toolbar-right hb-center-v">
174
+
175
+ <!-- theme switch -->
176
+ <label class="theme-switch">
177
+ <input class="theme-switch-checkbox" type="checkbox" v-on:change="switchViewTheme()">
178
+ <span class="slider round">
179
+ </span>
180
+ </label>
181
+ </div>
182
+ <div v-if="docApp.userSession" class="toolbar-right hb-center-v">
183
+ <!-- user info -->
184
+ <div class="userprofile dropdown">
185
+ <span class="dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">
186
+ <img class="svg-prof" v-bind:src="docApp.userSession.profileImage"
187
+ style="width:32;height:32;"></img>
188
+ </span>
189
+ <ul class="dropdown-menu p-0">
190
+
191
+
192
+
193
+ <div class="panel-header border-0 position-relative">
194
+ <div class="position-relative">
195
+ <div class="text-center fw-bolder lh-3">{{docApp.userSession.userId}}</div>
196
+ <div style="height:20px"></div>
197
+ </div>
198
+ <div class="position-absolute top-100 start-50 translate-middle">
199
+ <img class="svg-prof" v-bind:src="docApp.userSession.profileImage"
200
+ style="width:64px;height:64px;"></img>
201
+ </div>
202
+ </div>
203
+ <div class="panel-content border-0 border-top p-3 pt-5 fw-light lh-normal">
204
+ <div class="text-center fw-bolder p-1">{{docApp.userSession.userName}}</div>
205
+ <div class="text-center fw-bolder p-1 fs-12">{{docApp.userSession.email}}</div>
206
+ </div>
207
+ <div class="panel-content p-3 border-0 border-top fw-light lh-normal">
208
+ <div class="lh-normal fs-12"><i class="bi bi-database-lock"></i> <span
209
+ style="display:inline-block;width:48px">Issuer</span> :
210
+ {{docApp.userSession.issuerInstance}}</div>
211
+ <div class="lh-normal fs-12" v-bind:title="docApp.userSession.expiresDateTime"><i
212
+ class="bi bi-hourglass-split"></i> <span
213
+ style="display:inline-block;width:48px">Expires</span> : {{new
214
+ Date(docApp.userSession.validUntil).toLocaleDateString()}}</div>
215
+ </div>
216
+ </ul>
217
+ </div>
218
+ </div>
219
+ </div>
220
+
221
+ <!-- 100% horizontal col below toolbar and auto adjust vertical to take rest of avail height -->
222
+ <div class="main-layout hb-container-horizontal hb-container-expand hb-hidden">
223
+
224
+ <!-- the left hand nav col -->
225
+ <aside class="DocSidebar hb-container-vertical hb-hidden">
226
+
227
+ <nav class="hdoc-nav hb-container-expand" id="DocSidebarNav" aria-labelledby="sidebar-aria-label"
228
+ tabindex="-1">
229
+ <div v-for="(navSection,index) in docApp.navSections" v-bind:class="{'group':navSection.items, 'nogrouplink':!navSection.items}">
230
+
231
+ <div v-show="!navSection.items">
232
+ <a class="DocLink link noitems" v-bind:href="navSection.link"
233
+ v-bind:target="navSection.target || ''" style="padding-left: 0px;">
234
+ <span class="link-text">{{navSection.text}} <i v-if="navSection.target"
235
+ class="bi bi-box-arrow-up-right"></i> </span>
236
+ </a>
237
+ </div>
238
+
239
+ <div v-show="navSection.items">
240
+ <nav-section-component v-show="navSection.items" :key="updateCounter"
241
+ v-bind:asection="navSection"></nav-section-component>
242
+ </div>
243
+ </div>
244
+
245
+ <div v-if="docApp.hasInlinePopupDocuments" class="nogrouplink">
246
+ <div>
247
+ <a class="DocLink link noitems" v-on:click="showInlineDocumentList($event)">
248
+ <span class="link-text">
249
+ Inline Help Documents
250
+ </span>
251
+ </a>
252
+ </div>
253
+ </div>
254
+
255
+ </nav>
256
+
257
+ </aside>
258
+
259
+ <!-- the right hand content col -->
260
+ <div class="DocContent hb-container-expand hb-container-vertical" id="DocContent">
261
+ <div class="HTL-doc content-wrapper hb-container-expand">
262
+
263
+ <div v-show="!docApp.showInlineDocumentsMarkup" class="injected-document-container hb-container-horizontal">
264
+
265
+ <div class="injected-document-content">
266
+ <div v-if="docApp.error === ''">
267
+ <div class="document-header">
268
+
269
+ <!-- breadcrumb-->
270
+ <div class="hb-container-horizontal">
271
+ <div class="hb-center-v hb-container-expand">
272
+ <ul class="ps-0 nav-bar-nav-list noeffects after-fslash overflow-ellipsis">
273
+ <li class="mt-0 nav-bar-item"
274
+ v-for="(crumb,$index) in docApp.bookBreadCrumb">
275
+ <a class="ps-0 pe-0 text-decoration-none"
276
+ v-bind:href="crumb.link">{{crumb.title}}</a>
277
+ </li>
278
+ </ul>
279
+ </div>
280
+ <div class="toolbar-right hb-center-v">
281
+
282
+ <a class="toolbar-action" v-bind:href="docApp.documentGithubUrl"
283
+ target="_blank">
284
+ <i class="bi bi-pencil"></i>
285
+ </a>
286
+
287
+ <a class="toolbar-action">
288
+ <i class="bi bi-three-dots-vertical"></i>
289
+ </a>
290
+ </div>
291
+ </div>
292
+
293
+ <div class="document-title"></div>
294
+
295
+ <!-- doc frontmatter info -->
296
+ <div class="hb-container-horizontal">
297
+ <div class="hb-center-v hb-container-expand">
298
+ <ul
299
+ class="ps-0 nav-bar-nav-list noeffects after-bullets overflow-ellipsis text-light-2">
300
+ <li class="ps-0 mt-0 nav-bar-item">
301
+ Article
302
+ </li>
303
+ <li class="ps-0 mt-0 nav-bar-item">
304
+ YYYY-MM-DD
305
+ </li>
306
+ <li class="ps-0 mt-0 nav-bar-item">
307
+ (n) minutes to read
308
+ </li>
309
+ <li class="ps-0 mt-0 nav-bar-item">
310
+ <a class="link c-pointer">(n) contributors</a>
311
+ </li>
312
+ </ul>
313
+ </div>
314
+ <div class="toolbar-right hb-center-v">
315
+ </div>
316
+ </div>
317
+
318
+ </div>
319
+ <div class="document-body"></div>
320
+ </div>
321
+
322
+ <div v-if="docApp.error !== ''">
323
+ <div class="alert alert-danger" role="alert">
324
+ <h1>Book Navigation Render Failed!</h1>
325
+ <p>This is likely due to invalid JSON in the <strong>hdocbook.json</strong> file in your book. Please fix the error below, then refresh your browser to reload the book.</p>
326
+ <p><code>{{docApp.error}}</code></p>
327
+ </div>
328
+ </div>
329
+
330
+ </div>
331
+
332
+
333
+ <!-- table of contents -->
334
+ <div v-if="docApp.keepTocLayout" class="injected-document-toc">
335
+ <div v-if="docApp.tableOfContents.length" class="panel-header">
336
+ <span class="icon">
337
+ <i class="bi bi-list-ul"></i>
338
+ </span>
339
+ <span class="title">In This Document</span>
340
+ </div>
341
+ <div v-if="docApp.tableOfContents.length" class="panel-content">
342
+ <div v-for="tocItem in docApp.tableOfContents"
343
+ v-bind:class="{'ms-3':tocItem.tagName=='H3'}">
344
+ <a :href="tocItem.href">{{tocItem.eleText}}</a>
345
+ </div>
346
+ </div>
347
+ </div>
348
+
349
+ </div>
350
+
351
+ <!-- show inline document links -->
352
+ <div v-if="docApp.showInlineDocumentsMarkup" class="hb-container-vertical">
353
+
354
+ <!-- the problem is the test server doesn't serve inline documents like the live/proper one ?? -->
355
+ <div class="modal fade" id="inlineModal" tabindex="-1" role="dialog" aria-hidden="true">
356
+ <div class="modal-dialog" role="document">
357
+ <div class="modal-content">
358
+ <iframe v-if="docApp.inlinePopupDocumentHref" v-bind:src="docApp.inlinePopupDocumentHref"></iframe>
359
+ </div>
360
+ </div>
361
+ </div>
362
+
363
+
364
+ <div class="p-4">
365
+
366
+ <div class="document-header">
367
+ <div class="document-title"><h1>Inline Help Documents (DOES NOT WORK) - NOTE DEV SERVER NEEDS _inline.html PROCESSING - NEED TO SPEAK TO GERRY</h1></div>
368
+ </div>
369
+
370
+ <div class="p-2">
371
+ <div v-for="(navSectionItem,index) in docApp.inlineDocumentItems">
372
+
373
+ <a class="DocLink link noitems" href="#" v-on:click="popupInlineDocument($event,navSectionItem)" style="padding-left: 0px;">
374
+ <span class="link-text"><i v-if="navSectionItem.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This page is set to draft."></i><i class="bi bi-files-alt text-warning"></i> {{navSectionItem.text}}</span>
375
+ </a>
376
+
377
+ </div>
378
+ </div>
379
+ </div>
380
+ </div>
381
+
382
+
383
+ </div>
384
+ </div>
385
+
386
+ </div>
387
+
388
+ </div> <!-- <div class="main hb-vertical-expand"> -->
389
+
390
+
391
+
392
+ </body>
393
+ <script>
394
+
395
+ //-- we load these like this as we have set the BASE location of the document - so have to load these after doc
396
+ loadCss([
397
+ "css/theme-default/styles/fonts.css",
398
+ "css/theme-default/styles/vars.css",
399
+ "css/theme-default/styles/base.css",
400
+ "css/theme-default/styles/htldoc.layouts.css",
401
+
402
+ "css/theme-default/styles/components/htl-doc.css",
403
+ "css/theme-default/styles/components/sidebar.css",
404
+ "css/theme-default/styles/components/content.css",
405
+ "css/theme-default/styles/components/custom-block.css",
406
+ "css/theme-default/styles/components/api-doc.css",
407
+
408
+ "js/highlightjs/styles/vs2015.css"
409
+ ], function () {
410
+ //-- required js + 3rd party libs
411
+ setTimeout(function () {
412
+ loadJS(["js/doc.hornbill.js", "js/highlightjs/highlight.pack.js", "js/highlightjs-badge.js"], function () {
413
+ intialiseApp();
414
+ });
415
+ }, 50);
416
+ });
417
+
418
+ </script>
419
+
420
420
  </html>