@aj-shadow/actorjs-documentation-text 0.0.0-aj-beta.221
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.
- package/.gitattributes +26 -0
- package/Documentation/Document-global-Be-100-more-efficient.txt +31 -0
- package/Documentation/Document-global-actorjs-trigger-mock-and-intercept-anything.txt +21 -0
- package/Documentation/Document-global-advanced-visualization.txt +28 -0
- package/Documentation/Document-global-debugging.txt +4 -0
- package/Documentation/Document-global-divide-and-reuse.txt +37 -0
- package/Documentation/Document-global-general-separation.txt +2 -0
- package/Documentation/Document-global-markup-anchor.txt +6 -0
- package/Documentation/Document-global-markup-api-status.txt +39 -0
- package/Documentation/Document-global-markup-chart-line.txt +18 -0
- package/Documentation/Document-global-markup-documentation-status.txt +39 -0
- package/Documentation/Document-global-markup-documentation.txt +72 -0
- package/Documentation/Document-global-markup-embed.txt +6 -0
- package/Documentation/Document-global-markup-flowchart.txt +88 -0
- package/Documentation/Document-global-markup-html.txt +122 -0
- package/Documentation/Document-global-markup-ie.txt +18 -0
- package/Documentation/Document-global-markup-image.txt +55 -0
- package/Documentation/Document-global-markup-lab.txt +63 -0
- package/Documentation/Document-global-markup-markup.txt +21 -0
- package/Documentation/Document-global-markup-navigation.txt +25 -0
- package/Documentation/Document-global-markup-node-diagram.txt +163 -0
- package/Documentation/Document-global-markup-note.txt +6 -0
- package/Documentation/Document-global-markup-ref.txt +6 -0
- package/Documentation/Document-global-markup-sequence-diagram.txt +215 -0
- package/Documentation/Document-global-markup-state-machine.txt +121 -0
- package/Documentation/Document-global-markup-table.txt +34 -0
- package/Documentation/Document-global-navigation-pane.txt +3 -0
- package/Documentation/Document-global-navigation.txt +2 -0
- package/Documentation/Document-global-specialized-javascript-editors.txt +2 -0
- package/Documentation/Document-global-stacks-connection.txt +2 -0
- package/Documentation/Document-global-stacks-server.txt +2 -0
- package/Documentation/Document-global-test-environment-overview.txt +15 -0
- package/Documentation/Document-global-the-architecture.txt +51 -0
- package/Documentation/Document-global-the-development-environment.txt +5 -0
- package/Documentation/Document-global-the-test-environment.txt +15 -0
- package/Documentation/Document-global-think-ahead.txt +35 -0
- package/Documentation/Document-global-thinking-in-actors-unlimited.txt +1 -0
- package/Documentation/Document-global-what-is-a-stack.txt +2 -0
- package/Documentation/Document-global-why-actorjs.txt +52 -0
- package/Documentation/Document-global-why-actors-unlimited.txt +182 -0
- package/Documentation/Document-global-x-test-case-tool.txt +2 -0
- package/Documentation/Navigation-Documentation-actorjs-global.txt +372 -0
- package/Documentation/Navigation-Documentation-actorsite-global.txt +363 -0
- package/Documentation/abstractions/Document-global-addressing.txt +81 -0
- package/Documentation/abstractions/Document-global-configuration-floor.txt +2 -0
- package/Documentation/abstractions/Document-global-content.txt +3 -0
- package/Documentation/abstractions/Document-global-functions-test.txt +4 -0
- package/Documentation/abstractions/Document-global-functions-unde-test.txt +2 -0
- package/Documentation/abstractions/Document-global-load-test.txt +3 -0
- package/Documentation/abstractions/Document-global-repo.txt +79 -0
- package/Documentation/abstractions/Document-global-shared-data.txt +5 -0
- package/Documentation/abstractions/Document-global-system-to-test.txt +2 -0
- package/Documentation/abstractions/Document-global-system-under-test.txt +3 -0
- package/Documentation/abstractions/Document-global-test-data.txt +251 -0
- package/Documentation/abstractions/Document-global-test-suite.txt +37 -0
- package/Documentation/abstractions/Document-global-verification-data.txt +103 -0
- package/Documentation/abstractions/actor/Document-global-actor-condition.txt +74 -0
- package/Documentation/abstractions/actor/Document-global-actor-local.txt +44 -0
- package/Documentation/abstractions/actor/Document-global-actor-originating.txt +100 -0
- package/Documentation/abstractions/actor/Document-global-actor-proxy.txt +119 -0
- package/Documentation/abstractions/actor/Document-global-actor-terminating.txt +101 -0
- package/Documentation/abstractions/actor/Document-global-actor.txt +90 -0
- package/Documentation/abstractions/actor/Document-global-execution-states.txt +21 -0
- package/Documentation/abstractions/actorpart/Document-global-actorpart.txt +2 -0
- package/Documentation/abstractions/stack/Document-global-client-connection.txt +3 -0
- package/Documentation/abstractions/stack/Document-global-connection.txt +3 -0
- package/Documentation/abstractions/stack/Document-global-decoder.txt +3 -0
- package/Documentation/abstractions/stack/Document-global-encoder.txt +3 -0
- package/Documentation/abstractions/stack/Document-global-message.txt +4 -0
- package/Documentation/abstractions/stack/Document-global-server-connection.txt +3 -0
- package/Documentation/abstractions/stack/Document-global-stack.txt +12 -0
- package/Documentation/abstractions/stack/Document-global-worker.txt +3 -0
- package/Documentation/abstractions/test-case/Document-global-phases.txt +30 -0
- package/Documentation/abstractions/test-case/Document-global-test-case-result.txt +23 -0
- package/Documentation/abstractions/test-case/Document-global-test-case.txt +199 -0
- package/Documentation/actor-api/Document-global-actor-part.txt +7 -0
- package/Documentation/actor-api/Document-global-actor.txt +375 -0
- package/Documentation/actor-api/Document-global-async.txt +176 -0
- package/Documentation/actor-api/Document-global-client-stack.txt +215 -0
- package/Documentation/actor-api/Document-global-content.txt +106 -0
- package/Documentation/actor-api/Document-global-logger.txt +426 -0
- package/Documentation/actor-api/Document-global-process.txt +7 -0
- package/Documentation/actor-api/Document-global-server-stack.txt +213 -0
- package/Documentation/actor-api/Document-global-shared-data.txt +259 -0
- package/Documentation/actor-api/Document-global-test-data.txt +816 -0
- package/Documentation/actor-api/Document-global-timer.txt +70 -0
- package/Documentation/actor-api/Document-global-verification-data.txt +624 -0
- package/Documentation/connection-worker-api/Document-global-logger.txt +3 -0
- package/Documentation/documentation-references.json +199 -0
- package/Documentation/embedded/Document-global-test-case-result.txt +10 -0
- package/Documentation/howto/Document-global-create-actor.txt +1 -0
- package/Documentation/howto/Document-global-create-stack.txt +1 -0
- package/Documentation/howto/Document-global-create-test-case.txt +1 -0
- package/Documentation/howto/Document-global-create-test-suite.txt +1 -0
- package/Documentation/howto/Document-global-define-addresses.txt +1 -0
- package/Documentation/howto/Document-global-define-fut.txt +1 -0
- package/Documentation/howto/Document-global-define-sut.txt +16 -0
- package/Documentation/howto/Document-global-full-workflow.txt +143 -0
- package/Documentation/howto/Document-global-normal-workflow.txt +58 -0
- package/Documentation/howto/Document-global-prerequisites.txt +8 -0
- package/Documentation/howto/prerequisites/Document-global-install-actorjs.txt +64 -0
- package/Documentation/howto/prerequisites/Document-global-install-git.txt +26 -0
- package/Documentation/howto/prerequisites/Document-global-install-nodejs.txt +19 -0
- package/Documentation/markup/Document-global-markup-test-case.txt +6 -0
- package/Documentation/markup/Document-global-markup-test-suite.txt +13 -0
- package/Documentation/markup/embed/Document-global-inner_markup_tc.txt +164 -0
- package/Documentation/nodejs-api/Document-global-fs.txt +7 -0
- package/Documentation/stack-api/Document-global-ascii-dictionary.txt +108 -0
- package/Documentation/stack-api/Document-global-binary-log.txt +91 -0
- package/Documentation/stack-api/Document-global-bit-byte.txt +80 -0
- package/Documentation/stack-api/Document-global-content-base.txt +169 -0
- package/Documentation/stack-api/Document-global-ip-log.txt +101 -0
- package/Documentation/stack-api/Document-global-log-inner.txt +152 -0
- package/Documentation/stack-api/Document-global-log-part-error.txt +12 -0
- package/Documentation/stack-api/Document-global-log-part-ref.txt +80 -0
- package/Documentation/stack-api/Document-global-log-part-text.txt +81 -0
- package/Documentation/tools/Document-global-actors.txt +196 -0
- package/Documentation/tools/Document-global-addressing.txt +38 -0
- package/Documentation/tools/Document-global-content.txt +1 -0
- package/Documentation/tools/Document-global-global-test-data.txt +197 -0
- package/Documentation/tools/Document-global-stacks.txt +1 -0
- package/Documentation/tools/Document-global-test-case-analyze.txt +3 -0
- package/Documentation/tools/Document-global-test-case-debug.txt +16 -0
- package/Documentation/tools/Document-global-test-case-definition.txt +37 -0
- package/Documentation/tools/Document-global-test-case-execution.txt +28 -0
- package/Documentation/tools/Document-global-test-case-log.txt +95 -0
- package/Documentation/tools/Document-global-test-case-sequence-diagram.txt +17 -0
- package/Documentation/tools/Document-global-test-case-specification.txt +3 -0
- package/Documentation/tools/Document-global-test-cases.txt +11 -0
- package/Documentation/tools/Document-global-tool-test-suite.txt +202 -0
- package/Education/Document-global-add-your-first-addresses.txt +75 -0
- package/Education/Document-global-define-your-first-sut.txt +18 -0
- package/Education/Document-global-make-your-first-actors.txt +35 -0
- package/Education/Document-global-make-your-first-test-case.txt +43 -0
- package/Education/Document-global-make-your-first-test-suite.txt +29 -0
- package/Education/Document-global-share-your-work.txt +35 -0
- package/Education/Navigation-Education-actorjs-global.txt +31 -0
- package/LICENSE.txt +96 -0
- package/README.md +5 -0
- package/Workshop/Document-global-actordemo-image-ai.txt +5 -0
- package/Workshop/Document-global-actordemo-login.txt +10 -0
- package/Workshop/Document-global-actordemo-site.txt +3 -0
- package/Workshop/Document-global-actordemo-start.txt +5 -0
- package/Workshop/Document-global-actordemo-the-architecture.txt +27 -0
- package/Workshop/Document-global-introduction-actor.txt +84 -0
- package/Workshop/Document-global-introduction-actorjs.txt +42 -0
- package/Workshop/Document-global-introduction-stack.txt +25 -0
- package/Workshop/Document-global-introduction-system-under-test.txt +102 -0
- package/Workshop/Document-global-introduction-test-case.txt +50 -0
- package/Workshop/Document-global-introduction-test-suite.txt +31 -0
- package/Workshop/Document-global-login-with-puppeter.txt +45 -0
- package/Workshop/Document-global-mock-with-http.txt +83 -0
- package/Workshop/Document-global-mock-with-icap.txt +94 -0
- package/Workshop/Document-global-prerequisites-actorJs.txt +18 -0
- package/Workshop/Document-global-prerequisites-actordemo.txt +15 -0
- package/Workshop/Document-global-trigger-with-http.txt +93 -0
- package/Workshop/Document-global-trigger-with-puppeter.txt +49 -0
- package/Workshop/Navigation-Workshop-actorjs-global.txt +86 -0
- package/npm-shrinkwrap.json +13 -0
- package/package.json +10 -0
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# **Markup - Lab**
|
|
2
|
+
[[DOC-STATUS=PARTLY, ]]
|
|
3
|
+
|
|
4
|
+
## **Description**
|
|
5
|
+
Lab Markup provides the documentation with lab images, the same type of images you get when doing a login.
|
|
6
|
+
|
|
7
|
+
```lab
|
|
8
|
+
Network(N1, IPv4, Actor IPv4 network 1, Actor IPv4 network 1, true, false)
|
|
9
|
+
Network(N2, IPv4, 127.0.0.0/8, Actor IPv4 network 2, true, false)
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### **Title**
|
|
14
|
+
**format:** Title: *`title text`*
|
|
15
|
+
**description:** the title of the lab image
|
|
16
|
+
**example:** Title: Demo Lab Markup
|
|
17
|
+
### **Network**
|
|
18
|
+
**format:**
|
|
19
|
+
Network(`networkName`, `family`, `subnet`, `description`, `valid`, `reduced`)
|
|
20
|
+
**description:** Defines a network
|
|
21
|
+
* **name:** *[string][optional]* the name of the network. **default:** N1.
|
|
22
|
+
* **ip-family:** *[string][optional]* the shape of the node. **default:** IPv4. Valid values are:
|
|
23
|
+
* **IPv4**
|
|
24
|
+
* **IPv6**
|
|
25
|
+
* **subnet**: the subnet.
|
|
26
|
+
* **description:** *[string][optional]* description of the network. **default:** ''
|
|
27
|
+
* **valid:** *[string][boolean]* the network is valid.
|
|
28
|
+
* **reduced:** *[string][boolean]* the network is reduced.
|
|
29
|
+
|
|
30
|
+
**example:**
|
|
31
|
+
Network(PublicNetwork, IPv4, ImageService IPv4 public network, true, false)
|
|
32
|
+
|
|
33
|
+
### **Client**
|
|
34
|
+
**format:**
|
|
35
|
+
Client(`name`, `network`, `type`, `address`, `netmask`, `isStatic`, `external`, `valid`, `reduced`)
|
|
36
|
+
**description:** Defines a client interface
|
|
37
|
+
* **name:** *[string][optional]* the name of the network. **default:** actor1.
|
|
38
|
+
* **network:** *[string][optional]* the name of the network. **default:** N1.
|
|
39
|
+
* **type:** *[string][optional]* the type of interface. **default:** ip. Valid values are:
|
|
40
|
+
* **ip**
|
|
41
|
+
* **gui**
|
|
42
|
+
* **address:** *[string][optional]* the address of the interface. **default:** '192.168.0.1'
|
|
43
|
+
* **netmask:** *[string][optional]* the netmask of the interface. **default:** '255.255.0.0'
|
|
44
|
+
* **isStatic:** *[string][boolean]* is the address static or dynamically created. **default:** false
|
|
45
|
+
* **external:** *[string][boolean]* is the is the address external. **default:** false
|
|
46
|
+
* **valid:** *[string][boolean]* is the is the address valid. **default:** true
|
|
47
|
+
* **reduced:** *[string][boolean]* is the is the address reduced. **default:** false
|
|
48
|
+
|
|
49
|
+
### **Server**
|
|
50
|
+
**format:**
|
|
51
|
+
Server(`name`, `network`, `type`, `address`, `netmask`, `isStatic`, `external`, `valid`, `reduced`)
|
|
52
|
+
**description:** Defines a server interface
|
|
53
|
+
* **name:** *[string][optional]* the name of the network. **default:** actor1.
|
|
54
|
+
* **network:** *[string][optional]* the name of the network. **default:** N1.
|
|
55
|
+
* **type:** *[string][optional]* the type of interface. **default:** ip. Valid values are:
|
|
56
|
+
* **ip**
|
|
57
|
+
* **gui**
|
|
58
|
+
* **address:** *[string][optional]* the address of the interface. **default:** '192.168.0.1'
|
|
59
|
+
* **netmask:** *[string][optional]* the netmask of the interface. **default:** '255.255.0.0'
|
|
60
|
+
* **isStatic:** *[string][boolean]* is the address static or dynamically created. **default:** false
|
|
61
|
+
* **external:** *[string][boolean]* is the is the address external. **default:** false
|
|
62
|
+
* **valid:** *[string][boolean]* is the is the address valid. **default:** true
|
|
63
|
+
* **reduced:** *[string][boolean]* is the is the address reduced. **default:** false
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# **Introduction - Markup**
|
|
2
|
+
## **Description**
|
|
3
|
+
The default markup is parsed by the third party [Remarkable](https://www.npmjs.com/package/remarkable), see the [demo](http://jonschlinkert.github.io/remarkable/demo/).
|
|
4
|
+
|
|
5
|
+
## **Extensions**
|
|
6
|
+
ActorJs has done a lot of extensions. There are two different kind of extensions.
|
|
7
|
+
1) The Simple Extensions
|
|
8
|
+
2) The Complex Extensions
|
|
9
|
+
|
|
10
|
+
### **The Simple Extensions**
|
|
11
|
+
The simple extensions are easy to use. They are built up by a double bracket and *optional* parameters inside parameters. The *optional* parameters are often generated by the extension when it is saved for the first time.
|
|
12
|
+
#### **Examples**
|
|
13
|
+
1) [Anchor](markup-anchor)
|
|
14
|
+
2) [Ie](markup-ie)
|
|
15
|
+
|
|
16
|
+
### **The Complex Extensions**
|
|
17
|
+
The complex extensions needs a little more effort to understand. But some rows of text can generate very complex images.
|
|
18
|
+
|
|
19
|
+
#### **Examples**
|
|
20
|
+
1) [Sequence Diagram](markup-sequence-diagram)
|
|
21
|
+
2) [State Machine](markup-state-machine)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# **Markup - Navigation**
|
|
2
|
+
[[DOC-STATUS=PARTLY, ]]
|
|
3
|
+
|
|
4
|
+
## **Description**
|
|
5
|
+
Navigation Markup is a special markup letting the user add links and documents to the site. The sites supporting Navigation Markup is:
|
|
6
|
+
* [Documentation](/documentation)
|
|
7
|
+
|
|
8
|
+
### **Example Markup**
|
|
9
|
+
|Quick Start |
|
|
10
|
+
|Getting Started |getting-started |
|
|
11
|
+
|Tutorial |tutorial |
|
|
12
|
+
|Thinking in ActorJs|thinking-in-actorjs|
|
|
13
|
+
|
|
14
|
+
## **Definitions**
|
|
15
|
+
The Navigation Markup consists of tables where each table defines a section of the links.
|
|
16
|
+
|
|
17
|
+
#### **Section Heading**
|
|
18
|
+
**format:** '|(section heading)|'
|
|
19
|
+
**description:** the first row of a navigation table defines the Section Heading. The first row **must** only have one column.
|
|
20
|
+
**example:** |Quick Start|
|
|
21
|
+
|
|
22
|
+
#### **Navigation Link**
|
|
23
|
+
**format:** '|(link text)|(actual file name postfix of the link)|'
|
|
24
|
+
**description:** the second and the following rows of a navigation table defines the Links. The second and the following rows **must** have two columns.
|
|
25
|
+
**example:** |Getting Started |getting-started |
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# **Markup - Node Diagram**
|
|
2
|
+
[[DOC-STATUS=MOSTLY, ]]
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## **Description**
|
|
6
|
+
Node Diagram Markup provides the documentation for node diagram images.
|
|
7
|
+
|
|
8
|
+
### **Example Image 1**
|
|
9
|
+
|
|
10
|
+
```node
|
|
11
|
+
Title: Demo NodeDiagram Markup
|
|
12
|
+
Config(nodeWidth: 80, nodeHeight: 80, nodeWidthBetween: 25, nodeHeightBetween: 45, widthBias: 30, heightBias: 30)
|
|
13
|
+
|
|
14
|
+
Nodes[, , , , HSS(; ; Snow)]
|
|
15
|
+
Nodes[Client, , SUT, ]
|
|
16
|
+
Nodes[, , , , Image Service(; ; MintCream)]
|
|
17
|
+
|
|
18
|
+
Groups[Actor Clients(0; 1; 0; 3), SUT(2; 3; 0; 3), Actor Servers(4; 5; 0; 3)]
|
|
19
|
+
|
|
20
|
+
Client => SUT[radius]: radius
|
|
21
|
+
Client => SUT[http]: http
|
|
22
|
+
SUT => HSS[diameter]: diameter
|
|
23
|
+
SUT => Image Service[http]: http
|
|
24
|
+
```
|
|
25
|
+
### **Example Markup**
|
|
26
|
+
|
|
27
|
+
```escape
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
\`\`\`node
|
|
32
|
+
Title: Demo NodeDiagram Markup
|
|
33
|
+
Config(nodeWidth: 80, nodeHeight: 80, nodeWidthBetween: 25, nodeHeightBetween: 45, widthBias: 30, heightBias: 30)
|
|
34
|
+
|
|
35
|
+
Nodes[, , , , HSS(; ; Snow)]
|
|
36
|
+
Nodes[Client, , SUT, ]
|
|
37
|
+
Nodes[, , , , Image Service(; ; MintCream)]
|
|
38
|
+
|
|
39
|
+
Groups[Actor Clients(0; 1; 0; 3), SUT(2; 3; 0; 3), Actor Servers(4; 5; 0; 3)]
|
|
40
|
+
|
|
41
|
+
Client => SUT[radius]: radius
|
|
42
|
+
Client => SUT[http]: http
|
|
43
|
+
SUT => HSS[diameter]: diameter
|
|
44
|
+
SUT => Image Service[http]: http
|
|
45
|
+
\`\`\`
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## **Definitions**
|
|
49
|
+
|
|
50
|
+
### **Config**
|
|
51
|
+
**format:** Config(`nodeWidth`: `value`, `nodeHeight`: `value`, `nodeWidthBetween`: `value`, `nodeHeightBetween`: `value`, `widthBias`: `value`, `heightBias`: `value`)
|
|
52
|
+
**description:** values used when the image is generated.
|
|
53
|
+
* **nodeWidth:** [number][generated] the width of a node. **default:** 50.
|
|
54
|
+
* **nodeHeight:** [number][generated] the height of a node. **default:** 50.
|
|
55
|
+
* **nodeWidthBetween:** [number][generated] the width between nodes. **default:** 25.
|
|
56
|
+
* **nodeHeightBetween:** [number][generated] the height between nodes. **default:** 25.
|
|
57
|
+
* **widthBias:** [number][generated] the width of a node. **default:** 30.
|
|
58
|
+
* **heightBias:** [number][generated] the width of a node. **default:** 30.
|
|
59
|
+
|
|
60
|
+
### **Title**
|
|
61
|
+
**format:** Title: *`title text`*
|
|
62
|
+
**description:** the title of the node diagram image
|
|
63
|
+
**example:** Title: Demo Node Diagram Markup
|
|
64
|
+
### **Nodes**
|
|
65
|
+
**format:**
|
|
66
|
+
Nodes[*node 0,0`name`(`shape; corners; color`), node 0,1`name`(`shape; corners; color`), ..., node 0,n-1`name`(`shape; corners; color`)*]
|
|
67
|
+
Nodes[...]
|
|
68
|
+
Nodes[*node m-1,0`name`(`shape; corners; color`), node m-1,1`name`(`shape; corners; color`), ..., node m-1,n-1`name`(`shape; corners; color`)*]
|
|
69
|
+
**description:** *Nodes* and an arrays of the node names. One array for every row.
|
|
70
|
+
* **name:** [[REF=`<string>`, MDN_string]]*[mandatory]* the name of the node. **default:** if there is no name the position is moved for the next node.
|
|
71
|
+
* **shape:** [[REF=`<string>`, MDN_string]]*[optional]* the shape of the node. **default:** square. Valid shapes are:
|
|
72
|
+
* **polygon**
|
|
73
|
+
* **square**
|
|
74
|
+
* **corners:** *[number][optional]* used to set the number of corners for shapes that can have different number of corners. **default:** 5
|
|
75
|
+
* **color:** *[[REF=`<string>`, MDN_string]][optional]* the fill color of the shape.
|
|
76
|
+
|
|
77
|
+
**example:**
|
|
78
|
+
Nodes[A, B]
|
|
79
|
+
Nodes[C, D]
|
|
80
|
+
Nodes[E, F(square)]
|
|
81
|
+
Nodes[G, H(polygon; 8; Blue)]
|
|
82
|
+
|
|
83
|
+
### **Connection**
|
|
84
|
+
**format:** '*`name`* `connection operator` *`name`*[*`css type`, `from position`, `to position`, `slope`*]: *`connection text`*'
|
|
85
|
+
**description:**
|
|
86
|
+
* **name:** *[string]* the name of the node who makes the connection
|
|
87
|
+
* **connection operator:** *[string]* decides which connection to make
|
|
88
|
+
* **=>:** send a message, `from => to`
|
|
89
|
+
* **<=>:** send and receive a message, `both directions`
|
|
90
|
+
* **<=:** send a message, `to <= from`
|
|
91
|
+
* **->:** send a part of a message, `from -> to`
|
|
92
|
+
* **<->:** send and receive a part of a message, `both directions`
|
|
93
|
+
* **<-:** send a part of a message`to <- from`
|
|
94
|
+
* **css type:** *[string][optional]* the name of the stack, which will choose color. **default:** the unknown color.
|
|
95
|
+
* **from position:** *[string][optional]* from which side the line will leave the node. 'top' | 'right' | 'bottom' | 'left'. **default:** it will be calculated.
|
|
96
|
+
* **to position:** *[string][optional]* from which side the line will enter the node. 'top' | 'right' | 'bottom' | 'left'. **default:** it will be calculated.
|
|
97
|
+
* **slope:** *[boolean][optional]* decides if a slop on the lines are allowed. **default:** true.
|
|
98
|
+
|
|
99
|
+
**example:**
|
|
100
|
+
A => B[]: hello
|
|
101
|
+
C => D[, bottom, top]: bye
|
|
102
|
+
C => D[http]: Get /image
|
|
103
|
+
|
|
104
|
+
### **Example Image 2**
|
|
105
|
+
```node
|
|
106
|
+
Config(nodeWidth: 40, nodeHeight: 20, nodeWidthBetween: 25, nodeHeightBetween: 25, widthBias: 30, heightBias: 30)
|
|
107
|
+
|
|
108
|
+
Nodes[Repo, , , , ]
|
|
109
|
+
Nodes[, SUT, , , ]
|
|
110
|
+
Nodes[, , FUT, , ]
|
|
111
|
+
Nodes[, , , TC, ]
|
|
112
|
+
Nodes[, , , TS, ]
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
Repo => SUT[, , , false]:
|
|
116
|
+
SUT => FUT[, , , false]:
|
|
117
|
+
FUT => TC[, , , false]:
|
|
118
|
+
FUT => TS[, , , false]:
|
|
119
|
+
```
|
|
120
|
+
### **Example Image 3**
|
|
121
|
+
```node
|
|
122
|
+
Config(nodeWidth: 70, nodeHeight: 70, nodeWidthBetween: 25, nodeHeightBetween: 25, widthBias: 30, heightBias: 30)
|
|
123
|
+
|
|
124
|
+
Nodes[A1, A2, A3, A4, A5]
|
|
125
|
+
Nodes[B1, B2, B3, B4, B5]
|
|
126
|
+
Nodes[C1, C2, C3, C4, C5]
|
|
127
|
+
Nodes[D1, D2, D3, D4, D5]
|
|
128
|
+
Nodes[E1, E2, E3, E4, E5]
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
A2 => A1[, , , false]:
|
|
132
|
+
A4 => A5[, , , false]:
|
|
133
|
+
E4 => D4[, , , false]:
|
|
134
|
+
A3 => C2[, , , false]:
|
|
135
|
+
D2 => E2[, , , false]:
|
|
136
|
+
E5 => C5[, , , false]:
|
|
137
|
+
B5 => C4[, , , false]:
|
|
138
|
+
C2 => D4[, bottom, top, false]:
|
|
139
|
+
C2 => E4[, bottom, top, false]:
|
|
140
|
+
B3 => C4[, bottom, ltef, false]:
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### **Example Image 4**
|
|
144
|
+
```node
|
|
145
|
+
Config(nodeWidth: 50, nodeHeight: 50, nodeWidthBetween: 25, nodeHeightBetween: 25, widthBias: 30, heightBias: 30)
|
|
146
|
+
|
|
147
|
+
Nodes[, , C(star), , ]
|
|
148
|
+
Nodes[, B(; ; red), , D, ]
|
|
149
|
+
Nodes[A, , SUT, , E]
|
|
150
|
+
Nodes[, G, , F, ]
|
|
151
|
+
Nodes[, , H(polygon; 12; polygon), , ]
|
|
152
|
+
|
|
153
|
+
Groups[Actor Clients(0; 2; 0; 5), SUT(2; 3; 0; 5), Actor Servers(3; 5; 0; 5)]
|
|
154
|
+
|
|
155
|
+
B -x SUT[diameter]:
|
|
156
|
+
C -x SUT[unknown]:
|
|
157
|
+
A => SUT[unknown]:
|
|
158
|
+
SUT => D[unknown]:
|
|
159
|
+
SUT => E[unknown]:
|
|
160
|
+
SUT => F[unknown]:
|
|
161
|
+
G => SUT[unknown]:
|
|
162
|
+
H -x SUT[unknown]:
|
|
163
|
+
```
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
# **Markup - Sequence Diagram**
|
|
2
|
+
[[DOC-STATUS=MOSTLY, ]]
|
|
3
|
+
|
|
4
|
+
## **Description**
|
|
5
|
+
Sequence Diagram Markup provides the documentation with sequence diagram images.
|
|
6
|
+
|
|
7
|
+
### **Example Image**
|
|
8
|
+
|
|
9
|
+
```seq
|
|
10
|
+
Title: Demo Sequence Diagram Markup
|
|
11
|
+
Config(nodeWidth: 150, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 30, heightBias: 30, lineNumbers: false, border: true, backgroundColor: default)
|
|
12
|
+
|
|
13
|
+
Nodes[A, B, C]
|
|
14
|
+
A -o B[http]: connect
|
|
15
|
+
A => B[http]: GET /a HTTP1.1
|
|
16
|
+
B -o C[http]: connect
|
|
17
|
+
B => C[http]: GET /a HTTP1.1
|
|
18
|
+
C => B[http]: 200 OK
|
|
19
|
+
B => A[http]: 200 OK
|
|
20
|
+
A -x B[http]: disconnect
|
|
21
|
+
B -x C[http]: disconnect
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### **Example Markup**
|
|
25
|
+
|
|
26
|
+
```escape
|
|
27
|
+
|
|
28
|
+
\`\`\`seq
|
|
29
|
+
Title: Demo Sequence Diagram Markup
|
|
30
|
+
Nodes[A, B, C]
|
|
31
|
+
A -o B[http]: connect
|
|
32
|
+
A => B[http]: GET /a HTTP1.1
|
|
33
|
+
B -o C[http]: connect
|
|
34
|
+
B => C[http]: GET /a HTTP1.1
|
|
35
|
+
C => B[http]: 200 OK
|
|
36
|
+
B => A[http]: 200 OK
|
|
37
|
+
A -x B[http]: disconnect
|
|
38
|
+
B -x C[http]: disconnect
|
|
39
|
+
\`\`\`
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## **Definitions**
|
|
43
|
+
#### **Title**
|
|
44
|
+
**format:** \'Title: *`title text`*\'
|
|
45
|
+
**description:** the title of the sequence diagram image
|
|
46
|
+
**example:** Title: Demo Sequence Diagram Markup
|
|
47
|
+
#### **Nodes**
|
|
48
|
+
**format:** 'Nodes[*`node 0`, `node 1`, ..., `node n-1`*]'
|
|
49
|
+
**description:** *Nodes* and an array of the node names
|
|
50
|
+
**example:** Nodes[A, B]
|
|
51
|
+
#### **Action**
|
|
52
|
+
|
|
53
|
+
**format:** '*`from node`* `action operator` *`to node`*[*`stack`*, *`comment`*]: *`action text`*'
|
|
54
|
+
**description:**
|
|
55
|
+
* **from node:** the node who makes the action
|
|
56
|
+
* **to node:** the node who receives the action
|
|
57
|
+
* **action operator:** decides which action made
|
|
58
|
+
```table
|
|
59
|
+
Config(classHeading: )
|
|
60
|
+
|
|
61
|
+
|protocol |
|
|
62
|
+
|characters |description |
|
|
63
|
+
|=> |send a message |
|
|
64
|
+
|-> |send a part of a message |
|
|
65
|
+
|<=> |send and receive a message |
|
|
66
|
+
|<-> |send and receive a part of a message|
|
|
67
|
+
|-o |connect |
|
|
68
|
+
|-x |disconnect |
|
|
69
|
+
|> |start |
|
|
70
|
+
|# |stop |
|
|
71
|
+
||||pause |
|
|
72
|
+
|// |comment |
|
|
73
|
+
|/\*\*/ |long-comment |
|
|
74
|
+
|== |verify |
|
|
75
|
+
|= |new |
|
|
76
|
+
|! |delete |
|
|
77
|
+
```
|
|
78
|
+
```table
|
|
79
|
+
Config(classHeading: )
|
|
80
|
+
|
|
81
|
+
|gui |
|
|
82
|
+
|characters|description|
|
|
83
|
+
|launch | |
|
|
84
|
+
|page | |
|
|
85
|
+
|click | |
|
|
86
|
+
|type | |
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
* **stack:** the name of the stack
|
|
90
|
+
|
|
91
|
+
**example:** A => B[http]: GET /demo HTTP1.1
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
## **Examples**
|
|
95
|
+
### **Example 1**
|
|
96
|
+
```seq
|
|
97
|
+
Title: Send a message
|
|
98
|
+
Config(nodeWidth: 150, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 30, heightBias: 30, lineNumbers: false, border: true, backgroundColor: default)
|
|
99
|
+
|
|
100
|
+
Nodes[A, B]
|
|
101
|
+
A => B[http]: message
|
|
102
|
+
B => A[http]: message
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
```escape
|
|
106
|
+
|
|
107
|
+
\`\`\`seq
|
|
108
|
+
Title: Send a message
|
|
109
|
+
Nodes[A, B]
|
|
110
|
+
A => B[http]: message
|
|
111
|
+
B => A[http]: message
|
|
112
|
+
\`\`\`
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### **Example 2**
|
|
117
|
+
```seq
|
|
118
|
+
Title: Send a part of a message
|
|
119
|
+
Config(nodeWidth: 200, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 30, heightBias: 30, lineNumbers: false, border: true, backgroundColor: default)
|
|
120
|
+
|
|
121
|
+
Nodes[A, B]
|
|
122
|
+
A -> B[http]: part of a message
|
|
123
|
+
B -> A[http]: part of a message
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
```escape
|
|
127
|
+
|
|
128
|
+
\`\`\`seq
|
|
129
|
+
Title: Send a part of a message
|
|
130
|
+
Nodes[A, B]
|
|
131
|
+
A -> B[http]: part of a message
|
|
132
|
+
B -> A[http]: part of a message
|
|
133
|
+
\`\`\`
|
|
134
|
+
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### **Example 3**
|
|
138
|
+
```seq
|
|
139
|
+
Title: Send and receive a message
|
|
140
|
+
Config(nodeWidth: 230, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 30, heightBias: 30, lineNumbers: false, border: true, backgroundColor: default)
|
|
141
|
+
|
|
142
|
+
Nodes[A, B]
|
|
143
|
+
A <=> B[http]: message
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
```escape
|
|
147
|
+
|
|
148
|
+
\`\`\`seq
|
|
149
|
+
Title: Send and receive a message
|
|
150
|
+
Nodes[A, B]
|
|
151
|
+
A <=> B[http]: message
|
|
152
|
+
\`\`\`
|
|
153
|
+
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### **Example 4**
|
|
157
|
+
```seq
|
|
158
|
+
Title: Send and receive a part of a message
|
|
159
|
+
Config(nodeWidth: 310, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 30, heightBias: 30, lineNumbers: false, border: true, backgroundColor: default)
|
|
160
|
+
|
|
161
|
+
Nodes[A, B]
|
|
162
|
+
A <-> B[http]: part of a message
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
```escape
|
|
166
|
+
|
|
167
|
+
\`\`\`seq
|
|
168
|
+
Title: Send and receive a part of a message
|
|
169
|
+
Nodes[A, B]
|
|
170
|
+
A <-> B[http]: part of a message
|
|
171
|
+
\`\`\`
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### **Example 5**
|
|
176
|
+
```seq
|
|
177
|
+
Title: Connect
|
|
178
|
+
Config(nodeWidth: 150, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 30, heightBias: 30, lineNumbers: false, border: true, backgroundColor: default)
|
|
179
|
+
|
|
180
|
+
Nodes[A, B]
|
|
181
|
+
A -o B[http]: connect
|
|
182
|
+
B -o A[http]: connect
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
```escape
|
|
186
|
+
|
|
187
|
+
\`\`\`seq
|
|
188
|
+
Title: Connect
|
|
189
|
+
Nodes[A, B]
|
|
190
|
+
A -o B[http]: connect
|
|
191
|
+
B -o A[http]: connect
|
|
192
|
+
\`\`\`
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### **Example 6**
|
|
197
|
+
```seq
|
|
198
|
+
Title: Disconnect
|
|
199
|
+
Config(nodeWidth: 150, nodeMessageHeight: 17, nodeEventHeight: 10, nodeCommentHeight: 26, widthBias: 30, heightBias: 30, lineNumbers: false, border: true, backgroundColor: default)
|
|
200
|
+
|
|
201
|
+
Nodes[A, B]
|
|
202
|
+
A -x B[http]: disconnect
|
|
203
|
+
B -x A[http]: disconnect
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
```escape
|
|
207
|
+
|
|
208
|
+
\`\`\`seq
|
|
209
|
+
Title: Disconnect
|
|
210
|
+
Nodes[A, B]
|
|
211
|
+
A -x B[http]: disconnect
|
|
212
|
+
B -x A[http]: disconnect
|
|
213
|
+
\`\`\`
|
|
214
|
+
|
|
215
|
+
```
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# **Markup - State Machine**
|
|
2
|
+
[[DOC-STATUS=PARTLY, ]]
|
|
3
|
+
|
|
4
|
+
## **Description**
|
|
5
|
+
State Machine Markup provides the documentation with state machine images.
|
|
6
|
+
|
|
7
|
+
### **Example Image**
|
|
8
|
+
```state
|
|
9
|
+
Config(width: 400, height: 200, widthBias: 25, heightBias: 25)
|
|
10
|
+
|
|
11
|
+
States[start, load]
|
|
12
|
+
States[stop, run]
|
|
13
|
+
|
|
14
|
+
start -> load[normal]: a
|
|
15
|
+
load -> run[normal]: a
|
|
16
|
+
start -> run[normal]: b
|
|
17
|
+
run -> stop[normal]: c
|
|
18
|
+
```
|
|
19
|
+
state
|
|
20
|
+
Title: Demo State Machine Markup
|
|
21
|
+
Config(width: 400, height: 200, widthBias: 25, heightBias: 25)
|
|
22
|
+
|
|
23
|
+
States[Init, Connected, Done]
|
|
24
|
+
|
|
25
|
+
Init -> Connected[normal]: connect
|
|
26
|
+
Connected -> Done[normal]: disconnect
|
|
27
|
+
Init -> Done[normal]: close
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### **Example Markup**
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## **Definitions**
|
|
35
|
+
#### **Title**
|
|
36
|
+
**format:** \'Title: *(`title text`)*\'
|
|
37
|
+
**description:** the title of the state machine image
|
|
38
|
+
|
|
39
|
+
**example:** Title: Demo State Machine Markup
|
|
40
|
+
#### **States**
|
|
41
|
+
**format:** 'States[*`state 0`, `state 1`, ..., `state n-1`*]'
|
|
42
|
+
**description:** *States* and an array of the state names
|
|
43
|
+
**example:** States[A, B, C]
|
|
44
|
+
#### **Transition**
|
|
45
|
+
**format:** '*`from state`* `transition operator` *`to state`*[*`css type`*]: *`action text`*'
|
|
46
|
+
**description:**
|
|
47
|
+
* **from state:** the state who makes the transition
|
|
48
|
+
* **to state:** the state
|
|
49
|
+
* **transition operator:** decides what kind of transition
|
|
50
|
+
* **->:** simplex transition
|
|
51
|
+
* **<->:** duplex transition
|
|
52
|
+
* **css type:** type deciding the color of the transition
|
|
53
|
+
* **normal:** black
|
|
54
|
+
* **success:** green
|
|
55
|
+
* **failure:** red
|
|
56
|
+
* **external:** orange
|
|
57
|
+
|
|
58
|
+
**example:** A -> B[normal]: connected
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
## **Implementation Details**
|
|
62
|
+
### **_q2(x1, x2, y1, y2)**
|
|
63
|
+
```raw
|
|
64
|
+
<svg width="800" height="1200" viewBox="-30 -30 460 660" xmlns="http://www.w3.org/2000/svg">
|
|
65
|
+
<g>
|
|
66
|
+
<rect x="0" y="0" width="200" height="300" stroke="black" fill="none"/>
|
|
67
|
+
<line id="b1" x1="0" y1="0" x2="200" y2="0" stroke="blue" />
|
|
68
|
+
<line id="a1"x1="200" y1="0" x2="200" y2="300" stroke="blue" />
|
|
69
|
+
<line id="c1" x1="0" y1="0" x2="200" y2="300" stroke="blue" />
|
|
70
|
+
<text x="100" y="-5" text-anchor="middle">b1</text>
|
|
71
|
+
<text x="212" y="150" text-anchor="middle">a1</text>
|
|
72
|
+
<text x="110" y="150" text-anchor="middle">c1</text>
|
|
73
|
+
<text x="18" y="15" text-anchor="middle">A</text>
|
|
74
|
+
<text x="9" y="35" text-anchor="middle">B</text>
|
|
75
|
+
</g>
|
|
76
|
+
<g>
|
|
77
|
+
<line x1="61.53" y1="92.30" x2="200" y2="0" stroke="black" />
|
|
78
|
+
<line id="xb" x1="0" y1="92.30" x2="61.53" y2="92.30" stroke="black" />
|
|
79
|
+
<line id="c2" x1="0" y1="0" x2="104.7" y2="64.57" stroke="red" />
|
|
80
|
+
<line id="a2" x1="61.53" y1="92.30" x2="104.7" y2="64.57" stroke="red" />
|
|
81
|
+
<line id="b2" x1="0" y1="0" x2="61.53" y2="92.30" stroke="red" />
|
|
82
|
+
<text x="24" y="60" text-anchor="middle">b2</text>
|
|
83
|
+
<text x="100" y="90" text-anchor="middle">a2, c3</text>
|
|
84
|
+
<text x="80" y="30" text-anchor="middle">c2</text>
|
|
85
|
+
<text x="-12" y="50" text-anchor="middle">yb</text>
|
|
86
|
+
<text x="25" y="110" text-anchor="middle">xb</text>
|
|
87
|
+
<text x="45" y="88" text-anchor="middle">A</text>
|
|
88
|
+
|
|
89
|
+
</g>
|
|
90
|
+
<line class="xt" x1="0" y1="64.57" x2="104.7" y2="64.57" stroke="black" />
|
|
91
|
+
<line id="b3" x1="61.53" y1="92.30770" x2="104.7" y2="92.30770" stroke="black" />
|
|
92
|
+
<text x="59" y="77" text-anchor="middle">A</text>
|
|
93
|
+
<text x="78" y="77" text-anchor="middle">B</text>
|
|
94
|
+
<path d="M 0 0 Q 104.7 64.57 200 300" stroke="black" stroke-width="1" fill="none" />
|
|
95
|
+
<g>
|
|
96
|
+
|
|
97
|
+
</g>
|
|
98
|
+
</svg>
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
a1 = y2 - y1 = 300
|
|
102
|
+
b1 = x2 - x1 = 200
|
|
103
|
+
A = arctan(a1 / b1) = 56,31
|
|
104
|
+
B = 90 - A = 33,69
|
|
105
|
+
|
|
106
|
+
b2 = b1 * cos(A) = 110,93
|
|
107
|
+
xb = b2 * sin(B) = 61,53
|
|
108
|
+
yb = b2 * cos(B) = 92,30
|
|
109
|
+
|
|
110
|
+
a2 = c3 = 50
|
|
111
|
+
b3 = c3 * cos(B) = 41,60
|
|
112
|
+
a3 = c3 * sin(B) = 27,73
|
|
113
|
+
xt = xb + b3 = 104,7
|
|
114
|
+
yt = yb - a3 = 64,57
|
|
115
|
+
|
|
116
|
+
b3 = c3 * cos(B)
|
|
117
|
+
a3 = c3 * sin(C)
|
|
118
|
+
xt = xb + a3
|
|
119
|
+
yt = xb + b3
|
|
120
|
+
|
|
121
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# **Markup - Table**
|
|
2
|
+
[[DOC-STATUS=MOSTLY, ]]
|
|
3
|
+
|
|
4
|
+
## **Description**
|
|
5
|
+
Table Markup provides the documentation with table images.
|
|
6
|
+
|
|
7
|
+
### **Example Image**
|
|
8
|
+
```table
|
|
9
|
+
Config(classHeading: dddd)
|
|
10
|
+
|
|
11
|
+
|Demo Table |
|
|
12
|
+
|#|age|sport |
|
|
13
|
+
|1|21 |ice-hockey|
|
|
14
|
+
|2|22 |fotball |
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### **Example Markup**
|
|
18
|
+
```escape
|
|
19
|
+
|
|
20
|
+
\`\`\`table
|
|
21
|
+
|Demo Table |
|
|
22
|
+
|#|age|sport |
|
|
23
|
+
|1|21 |ice-hockey|
|
|
24
|
+
|2|22 |fotball |
|
|
25
|
+
\`\`\`
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## **Definitions**
|
|
29
|
+
|
|
30
|
+
### **Config**
|
|
31
|
+
**format:** Config(`classHeading`: `value`)
|
|
32
|
+
**description:** values used when the image is generated.
|
|
33
|
+
* **classHeading:** [[REF=, MDN_number]] [generated] extra classes to the heading. **default:** ''.
|
|
34
|
+
|