pict-section-inlinedocumentation 1.0.0 → 1.0.2

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 (41) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +11 -13
  3. package/diagrams/four-levels-of-embeddedness.excalidraw +717 -0
  4. package/diagrams/four-levels-of-embeddedness.mmd +4 -0
  5. package/diagrams/four-levels-of-embeddedness.svg +2 -0
  6. package/docs/README.md +10 -19
  7. package/docs/_brand.json +18 -0
  8. package/docs/_cover.md +6 -0
  9. package/docs/_sidebar.md +8 -4
  10. package/docs/_version.json +3 -3
  11. package/docs/architecture.md +2 -44
  12. package/docs/diagrams/component-diagram.excalidraw +3546 -0
  13. package/docs/diagrams/component-diagram.mmd +42 -0
  14. package/docs/diagrams/component-diagram.svg +2 -0
  15. package/docs/diagrams/four-levels-of-embeddedness.excalidraw +717 -0
  16. package/docs/diagrams/four-levels-of-embeddedness.mmd +9 -0
  17. package/docs/diagrams/four-levels-of-embeddedness.svg +2 -0
  18. package/docs/diagrams/project-layout.excalidraw +6082 -0
  19. package/docs/diagrams/project-layout.mmd +25 -0
  20. package/docs/diagrams/project-layout.svg +2 -0
  21. package/docs/embedding-level2-routes.md +1 -1
  22. package/docs/embedding-level4-autogen.md +1 -1
  23. package/docs/examples/README.md +9 -0
  24. package/docs/examples/bookshop/README.md +582 -0
  25. package/docs/examples/bookshop/bookshop_example.js +4519 -0
  26. package/docs/examples/bookshop/index.html +236 -0
  27. package/docs/index.html +6 -7
  28. package/docs/overview.md +4 -4
  29. package/docs/reference.md +2 -27
  30. package/docs/retold-catalog.json +77 -178
  31. package/docs/retold-keyword-index.json +14134 -1917
  32. package/example_applications/basic/docs/_brand.json +18 -0
  33. package/example_applications/bookshop/docs/_brand.json +18 -0
  34. package/example_applications/bookshop/package.json +9 -1
  35. package/package.json +9 -9
  36. package/source/providers/Pict-Provider-InlineDocumentation.js +27 -3
  37. package/source/views/Pict-View-InlineDocumentation-Content.js +19 -15
  38. package/source/views/Pict-View-InlineDocumentation-Layout.js +115 -3
  39. package/source/views/Pict-View-InlineDocumentation-Nav.js +98 -17
  40. package/source/views/Pict-View-InlineDocumentation-TopicManager.js +18 -18
  41. package/docs/css/docuserve.css +0 -327
package/docs/diagrams/four-levels-of-embeddedness.excalidraw ADDED
@@ -0,0 +1,717 @@
1
+ {
2
+ "type": "excalidraw",
3
+ "version": 2,
4
+ "source": "pict-section-excalidraw/notebook-generator",
5
+ "elements": [
6
+ {
7
+ "id": "shape-L1-000000ro",
8
+ "type": "rectangle",
9
+ "x": 16,
10
+ "y": 16,
11
+ "width": 208,
12
+ "height": 56,
13
+ "angle": 0,
14
+ "strokeColor": "#1B1F23",
15
+ "backgroundColor": "transparent",
16
+ "fillStyle": "solid",
17
+ "strokeWidth": 2,
18
+ "strokeStyle": "solid",
19
+ "roughness": 1,
20
+ "opacity": 100,
21
+ "groupIds": [],
22
+ "frameId": null,
23
+ "roundness": {
24
+ "type": 3
25
+ },
26
+ "seed": 996,
27
+ "version": 1,
28
+ "versionNonce": 996,
29
+ "isDeleted": false,
30
+ "boundElements": [
31
+ {
32
+ "id": "label-L1-000000p0",
33
+ "type": "text"
34
+ },
35
+ {
36
+ "id": "arrow-L1-L2-000000ok",
37
+ "type": "arrow"
38
+ }
39
+ ],
40
+ "updated": 1,
41
+ "link": null,
42
+ "locked": false,
43
+ "index": null
44
+ },
45
+ {
46
+ "id": "label-L1-000000p0",
47
+ "type": "text",
48
+ "x": 24,
49
+ "y": 31.5,
50
+ "width": 192,
51
+ "height": 25,
52
+ "angle": 0,
53
+ "strokeColor": "#1B1F23",
54
+ "backgroundColor": "transparent",
55
+ "fillStyle": "solid",
56
+ "strokeWidth": 1,
57
+ "strokeStyle": "solid",
58
+ "roughness": 1,
59
+ "opacity": 100,
60
+ "groupIds": [],
61
+ "frameId": null,
62
+ "roundness": null,
63
+ "seed": 900,
64
+ "version": 1,
65
+ "versionNonce": 900,
66
+ "isDeleted": false,
67
+ "boundElements": null,
68
+ "updated": 1,
69
+ "link": null,
70
+ "locked": false,
71
+ "text": "1. Sidebar + ToC",
72
+ "fontSize": 20,
73
+ "fontFamily": 5,
74
+ "textAlign": "center",
75
+ "verticalAlign": "middle",
76
+ "baseline": 15,
77
+ "containerId": "shape-L1-000000ro",
78
+ "originalText": "1. Sidebar + ToC",
79
+ "autoResize": true,
80
+ "lineHeight": 1.25,
81
+ "index": null
82
+ },
83
+ {
84
+ "id": "shape-L2-000000r0",
85
+ "type": "rectangle",
86
+ "x": 314,
87
+ "y": 16,
88
+ "width": 285,
89
+ "height": 56,
90
+ "angle": 0,
91
+ "strokeColor": "#1B1F23",
92
+ "backgroundColor": "transparent",
93
+ "fillStyle": "solid",
94
+ "strokeWidth": 2,
95
+ "strokeStyle": "solid",
96
+ "roughness": 1,
97
+ "opacity": 100,
98
+ "groupIds": [],
99
+ "frameId": null,
100
+ "roundness": {
101
+ "type": 3
102
+ },
103
+ "seed": 972,
104
+ "version": 1,
105
+ "versionNonce": 972,
106
+ "isDeleted": false,
107
+ "boundElements": [
108
+ {
109
+ "id": "label-L2-000000fx",
110
+ "type": "text"
111
+ },
112
+ {
113
+ "id": "arrow-L1-L2-000000ok",
114
+ "type": "arrow"
115
+ },
116
+ {
117
+ "id": "arrow-L2-L3-000000ho",
118
+ "type": "arrow"
119
+ }
120
+ ],
121
+ "updated": 1,
122
+ "link": null,
123
+ "locked": false,
124
+ "index": null
125
+ },
126
+ {
127
+ "id": "label-L2-000000fx",
128
+ "type": "text",
129
+ "x": 322,
130
+ "y": 31.5,
131
+ "width": 269,
132
+ "height": 25,
133
+ "angle": 0,
134
+ "strokeColor": "#1B1F23",
135
+ "backgroundColor": "transparent",
136
+ "fillStyle": "solid",
137
+ "strokeWidth": 1,
138
+ "strokeStyle": "solid",
139
+ "roughness": 1,
140
+ "opacity": 100,
141
+ "groupIds": [],
142
+ "frameId": null,
143
+ "roundness": null,
144
+ "seed": 573,
145
+ "version": 1,
146
+ "versionNonce": 573,
147
+ "isDeleted": false,
148
+ "boundElements": null,
149
+ "updated": 1,
150
+ "link": null,
151
+ "locked": false,
152
+ "text": "2. Route-Mapped Content",
153
+ "fontSize": 20,
154
+ "fontFamily": 5,
155
+ "textAlign": "center",
156
+ "verticalAlign": "middle",
157
+ "baseline": 15,
158
+ "containerId": "shape-L2-000000r0",
159
+ "originalText": "2. Route-Mapped Content",
160
+ "autoResize": true,
161
+ "lineHeight": 1.25,
162
+ "index": null
163
+ },
164
+ {
165
+ "id": "shape-L3-000000q1",
166
+ "type": "rectangle",
167
+ "x": 689,
168
+ "y": 16,
169
+ "width": 307,
170
+ "height": 56,
171
+ "angle": 0,
172
+ "strokeColor": "#1B1F23",
173
+ "backgroundColor": "transparent",
174
+ "fillStyle": "solid",
175
+ "strokeWidth": 2,
176
+ "strokeStyle": "solid",
177
+ "roughness": 1,
178
+ "opacity": 100,
179
+ "groupIds": [],
180
+ "frameId": null,
181
+ "roundness": {
182
+ "type": 3
183
+ },
184
+ "seed": 937,
185
+ "version": 1,
186
+ "versionNonce": 937,
187
+ "isDeleted": false,
188
+ "boundElements": [
189
+ {
190
+ "id": "label-L3-000000o4",
191
+ "type": "text"
192
+ },
193
+ {
194
+ "id": "arrow-L2-L3-000000ho",
195
+ "type": "arrow"
196
+ },
197
+ {
198
+ "id": "arrow-L3-L4-0000003g",
199
+ "type": "arrow"
200
+ }
201
+ ],
202
+ "updated": 1,
203
+ "link": null,
204
+ "locked": false,
205
+ "index": null
206
+ },
207
+ {
208
+ "id": "label-L3-000000o4",
209
+ "type": "text",
210
+ "x": 697,
211
+ "y": 31.5,
212
+ "width": 291,
213
+ "height": 25,
214
+ "angle": 0,
215
+ "strokeColor": "#1B1F23",
216
+ "backgroundColor": "transparent",
217
+ "fillStyle": "solid",
218
+ "strokeWidth": 1,
219
+ "strokeStyle": "solid",
220
+ "roughness": 1,
221
+ "opacity": 100,
222
+ "groupIds": [],
223
+ "frameId": null,
224
+ "roundness": null,
225
+ "seed": 868,
226
+ "version": 1,
227
+ "versionNonce": 868,
228
+ "isDeleted": false,
229
+ "boundElements": null,
230
+ "updated": 1,
231
+ "link": null,
232
+ "locked": false,
233
+ "text": "3. Hand-Authored Tooltips",
234
+ "fontSize": 20,
235
+ "fontFamily": 5,
236
+ "textAlign": "center",
237
+ "verticalAlign": "middle",
238
+ "baseline": 15,
239
+ "containerId": "shape-L3-000000q1",
240
+ "originalText": "3. Hand-Authored Tooltips",
241
+ "autoResize": true,
242
+ "lineHeight": 1.25,
243
+ "index": null
244
+ },
245
+ {
246
+ "id": "shape-L4-000000o0",
247
+ "type": "rectangle",
248
+ "x": 1086,
249
+ "y": 16,
250
+ "width": 318,
251
+ "height": 56,
252
+ "angle": 0,
253
+ "strokeColor": "#1B1F23",
254
+ "backgroundColor": "transparent",
255
+ "fillStyle": "solid",
256
+ "strokeWidth": 2,
257
+ "strokeStyle": "solid",
258
+ "roughness": 1,
259
+ "opacity": 100,
260
+ "groupIds": [],
261
+ "frameId": null,
262
+ "roundness": {
263
+ "type": 3
264
+ },
265
+ "seed": 864,
266
+ "version": 1,
267
+ "versionNonce": 864,
268
+ "isDeleted": false,
269
+ "boundElements": [
270
+ {
271
+ "id": "label-L4-00000050",
272
+ "type": "text"
273
+ },
274
+ {
275
+ "id": "arrow-L3-L4-0000003g",
276
+ "type": "arrow"
277
+ }
278
+ ],
279
+ "updated": 1,
280
+ "link": null,
281
+ "locked": false,
282
+ "index": null
283
+ },
284
+ {
285
+ "id": "label-L4-00000050",
286
+ "type": "text",
287
+ "x": 1094,
288
+ "y": 31.5,
289
+ "width": 302,
290
+ "height": 25,
291
+ "angle": 0,
292
+ "strokeColor": "#1B1F23",
293
+ "backgroundColor": "transparent",
294
+ "fillStyle": "solid",
295
+ "strokeWidth": 1,
296
+ "strokeStyle": "solid",
297
+ "roughness": 1,
298
+ "opacity": 100,
299
+ "groupIds": [],
300
+ "frameId": null,
301
+ "roundness": null,
302
+ "seed": 180,
303
+ "version": 1,
304
+ "versionNonce": 180,
305
+ "isDeleted": false,
306
+ "boundElements": null,
307
+ "updated": 1,
308
+ "link": null,
309
+ "locked": false,
310
+ "text": "4. Auto-Generated Tooltips",
311
+ "fontSize": 20,
312
+ "fontFamily": 5,
313
+ "textAlign": "center",
314
+ "verticalAlign": "middle",
315
+ "baseline": 15,
316
+ "containerId": "shape-L4-000000o0",
317
+ "originalText": "4. Auto-Generated Tooltips",
318
+ "autoResize": true,
319
+ "lineHeight": 1.25,
320
+ "index": null
321
+ },
322
+ {
323
+ "id": "arrow-L1-L2-000000ok",
324
+ "type": "arrow",
325
+ "x": 224,
326
+ "y": 44,
327
+ "width": 90,
328
+ "height": 1.4210854715202004e-14,
329
+ "angle": 0,
330
+ "strokeColor": "#2E7D74",
331
+ "backgroundColor": "transparent",
332
+ "fillStyle": "solid",
333
+ "strokeWidth": 2,
334
+ "strokeStyle": "solid",
335
+ "roughness": 1,
336
+ "opacity": 100,
337
+ "groupIds": [],
338
+ "frameId": null,
339
+ "roundness": null,
340
+ "seed": 884,
341
+ "version": 1,
342
+ "versionNonce": 884,
343
+ "isDeleted": false,
344
+ "boundElements": [],
345
+ "updated": 1,
346
+ "link": null,
347
+ "locked": false,
348
+ "points": [
349
+ [
350
+ 0,
351
+ 0
352
+ ],
353
+ [
354
+ 16,
355
+ 0
356
+ ],
357
+ [
358
+ 19.875171467764062,
359
+ -7.105427357601002e-15
360
+ ],
361
+ [
362
+ 23.519890260631,
363
+ -7.105427357601002e-15
364
+ ],
365
+ [
366
+ 26.962962962962962,
367
+ 7.105427357601002e-15
368
+ ],
369
+ [
370
+ 30.233196159122116,
371
+ 0
372
+ ],
373
+ [
374
+ 33.35939643347052,
375
+ 7.105427357601002e-15
376
+ ],
377
+ [
378
+ 36.37037037037038,
379
+ 0
380
+ ],
381
+ [
382
+ 39.294924554183865,
383
+ 0
384
+ ],
385
+ [
386
+ 42.161865569273004,
387
+ 0
388
+ ],
389
+ [
390
+ 45,
391
+ 0
392
+ ],
393
+ [
394
+ 47.83813443072705,
395
+ 0
396
+ ],
397
+ [
398
+ 50.70507544581619,
399
+ 0
400
+ ],
401
+ [
402
+ 53.62962962962962,
403
+ 0
404
+ ],
405
+ [
406
+ 56.640603566529535,
407
+ 7.105427357601002e-15
408
+ ],
409
+ [
410
+ 59.76680384087791,
411
+ 0
412
+ ],
413
+ [
414
+ 63.03703703703707,
415
+ 0
416
+ ],
417
+ [
418
+ 66.48010973936903,
419
+ 7.105427357601002e-15
420
+ ],
421
+ [
422
+ 70.12482853223594,
423
+ 0
424
+ ],
425
+ [
426
+ 74,
427
+ 0
428
+ ],
429
+ [
430
+ 90,
431
+ 0
432
+ ]
433
+ ],
434
+ "lastCommittedPoint": null,
435
+ "startBinding": {
436
+ "elementId": "shape-L1-000000ro",
437
+ "focus": 0,
438
+ "gap": 8
439
+ },
440
+ "endBinding": {
441
+ "elementId": "shape-L2-000000r0",
442
+ "focus": 0,
443
+ "gap": 8
444
+ },
445
+ "startArrowhead": null,
446
+ "endArrowhead": "arrow",
447
+ "elbowed": false,
448
+ "index": null
449
+ },
450
+ {
451
+ "id": "arrow-L2-L3-000000ho",
452
+ "type": "arrow",
453
+ "x": 599,
454
+ "y": 44,
455
+ "width": 90,
456
+ "height": 1.4210854715202004e-14,
457
+ "angle": 0,
458
+ "strokeColor": "#2E7D74",
459
+ "backgroundColor": "transparent",
460
+ "fillStyle": "solid",
461
+ "strokeWidth": 2,
462
+ "strokeStyle": "solid",
463
+ "roughness": 1,
464
+ "opacity": 100,
465
+ "groupIds": [],
466
+ "frameId": null,
467
+ "roundness": null,
468
+ "seed": 636,
469
+ "version": 1,
470
+ "versionNonce": 636,
471
+ "isDeleted": false,
472
+ "boundElements": [],
473
+ "updated": 1,
474
+ "link": null,
475
+ "locked": false,
476
+ "points": [
477
+ [
478
+ 0,
479
+ 0
480
+ ],
481
+ [
482
+ 16,
483
+ 0
484
+ ],
485
+ [
486
+ 19.875171467764062,
487
+ -7.105427357601002e-15
488
+ ],
489
+ [
490
+ 23.519890260630973,
491
+ -7.105427357601002e-15
492
+ ],
493
+ [
494
+ 26.962962962963047,
495
+ 7.105427357601002e-15
496
+ ],
497
+ [
498
+ 30.23319615912203,
499
+ 0
500
+ ],
501
+ [
502
+ 33.35939643347058,
503
+ 7.105427357601002e-15
504
+ ],
505
+ [
506
+ 36.37037037037044,
507
+ 0
508
+ ],
509
+ [
510
+ 39.29492455418392,
511
+ 0
512
+ ],
513
+ [
514
+ 42.16186556927312,
515
+ 0
516
+ ],
517
+ [
518
+ 45,
519
+ 0
520
+ ],
521
+ [
522
+ 47.838134430726996,
523
+ 0
524
+ ],
525
+ [
526
+ 50.70507544581619,
527
+ 0
528
+ ],
529
+ [
530
+ 53.62962962962956,
531
+ 0
532
+ ],
533
+ [
534
+ 56.640603566529535,
535
+ 7.105427357601002e-15
536
+ ],
537
+ [
538
+ 59.766803840877856,
539
+ 0
540
+ ],
541
+ [
542
+ 63.03703703703707,
543
+ 0
544
+ ],
545
+ [
546
+ 66.48010973936903,
547
+ 7.105427357601002e-15
548
+ ],
549
+ [
550
+ 70.12482853223594,
551
+ 0
552
+ ],
553
+ [
554
+ 74,
555
+ 0
556
+ ],
557
+ [
558
+ 90,
559
+ 0
560
+ ]
561
+ ],
562
+ "lastCommittedPoint": null,
563
+ "startBinding": {
564
+ "elementId": "shape-L2-000000r0",
565
+ "focus": 0,
566
+ "gap": 8
567
+ },
568
+ "endBinding": {
569
+ "elementId": "shape-L3-000000q1",
570
+ "focus": 0,
571
+ "gap": 8
572
+ },
573
+ "startArrowhead": null,
574
+ "endArrowhead": "arrow",
575
+ "elbowed": false,
576
+ "index": null
577
+ },
578
+ {
579
+ "id": "arrow-L3-L4-0000003g",
580
+ "type": "arrow",
581
+ "x": 996,
582
+ "y": 44,
583
+ "width": 90,
584
+ "height": 1.4210854715202004e-14,
585
+ "angle": 0,
586
+ "strokeColor": "#2E7D74",
587
+ "backgroundColor": "transparent",
588
+ "fillStyle": "solid",
589
+ "strokeWidth": 2,
590
+ "strokeStyle": "solid",
591
+ "roughness": 1,
592
+ "opacity": 100,
593
+ "groupIds": [],
594
+ "frameId": null,
595
+ "roundness": null,
596
+ "seed": 124,
597
+ "version": 1,
598
+ "versionNonce": 124,
599
+ "isDeleted": false,
600
+ "boundElements": [],
601
+ "updated": 1,
602
+ "link": null,
603
+ "locked": false,
604
+ "points": [
605
+ [
606
+ 0,
607
+ 0
608
+ ],
609
+ [
610
+ 16,
611
+ 0
612
+ ],
613
+ [
614
+ 19.875171467764062,
615
+ -7.105427357601002e-15
616
+ ],
617
+ [
618
+ 23.519890260631087,
619
+ -7.105427357601002e-15
620
+ ],
621
+ [
622
+ 26.962962962963047,
623
+ 7.105427357601002e-15
624
+ ],
625
+ [
626
+ 30.233196159122144,
627
+ 0
628
+ ],
629
+ [
630
+ 33.359396433470465,
631
+ 7.105427357601002e-15
632
+ ],
633
+ [
634
+ 36.37037037037044,
635
+ 0
636
+ ],
637
+ [
638
+ 39.29492455418381,
639
+ 0
640
+ ],
641
+ [
642
+ 42.161865569273004,
643
+ 0
644
+ ],
645
+ [
646
+ 45,
647
+ 0
648
+ ],
649
+ [
650
+ 47.83813443072722,
651
+ 0
652
+ ],
653
+ [
654
+ 50.705075445815964,
655
+ 0
656
+ ],
657
+ [
658
+ 53.62962962962956,
659
+ 0
660
+ ],
661
+ [
662
+ 56.640603566529535,
663
+ 7.105427357601002e-15
664
+ ],
665
+ [
666
+ 59.766803840877856,
667
+ 0
668
+ ],
669
+ [
670
+ 63.03703703703695,
671
+ 0
672
+ ],
673
+ [
674
+ 66.48010973936903,
675
+ 7.105427357601002e-15
676
+ ],
677
+ [
678
+ 70.12482853223582,
679
+ 0
680
+ ],
681
+ [
682
+ 74,
683
+ 0
684
+ ],
685
+ [
686
+ 90,
687
+ 0
688
+ ]
689
+ ],
690
+ "lastCommittedPoint": null,
691
+ "startBinding": {
692
+ "elementId": "shape-L3-000000q1",
693
+ "focus": 0,
694
+ "gap": 8
695
+ },
696
+ "endBinding": {
697
+ "elementId": "shape-L4-000000o0",
698
+ "focus": 0,
699
+ "gap": 8
700
+ },
701
+ "startArrowhead": null,
702
+ "endArrowhead": "arrow",
703
+ "elbowed": false,
704
+ "index": null
705
+ }
706
+ ],
707
+ "appState": {
708
+ "viewBackgroundColor": "#FBF7EE",
709
+ "theme": "light",
710
+ "gridSize": null,
711
+ "exportBackground": true,
712
+ "exportEmbedScene": true,
713
+ "exportScale": 1,
714
+ "currentItemFontFamily": 5
715
+ },
716
+ "files": {}
717
+ }
package/docs/diagrams/four-levels-of-embeddedness.mmd ADDED
@@ -0,0 +1,9 @@
1
+ flowchart LR
2
+ L1[1. Sidebar + ToC] --> L2[2. Route-Mapped Content]
3
+ L2 --> L3[3. Hand-Authored Tooltips]
4
+ L3 --> L4[4. Auto-Generated Tooltips]
5
+
6
+ style L1 fill:#e3f2fd,stroke:#42a5f5,color:#333
7
+ style L2 fill:#e8f5e9,stroke:#66bb6a,color:#333
8
+ style L3 fill:#fff3e0,stroke:#ffa726,color:#333
9
+ style L4 fill:#fce4ec,stroke:#ef5350,color:#333