Garmelon/forest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[docs] Switch to map of child nodes plus display order

Browse source
This commit is contained in:
Joscha 2020-02-16 23:32:33 +00:00
parent a50338a028
commit 4d06e48a82
1 changed files with 32 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

49
docs/API.md
View file

@ -19,57 +19,58 @@ not send any more hello packets. They may send any other packets.
The client displays a tree of nodes to the user. The user can then interact with The client displays a tree of nodes to the user. The user can then interact with
that tree in various ways (see the [client packets](#client-packets)). The that tree in various ways (see the [client packets](#client-packets)). The
tree's root is a list of top-level nodes. Those nodes then have lists of child tree's root is a single node. This node has child nodes which then have child
nodes. nodes themselves and so on.
A node is a JSON object with the following properties: A node is a JSON object with the following properties:
| Property | Type | Description | | Property | Type | Description |
|------------|---------------|------------------------------------------------------| |------------|--------------------------|------------------------------------------------------|
| `id` | string | The node's ID |
| `text` | string | The node's text contents | | `text` | string | The node's text contents |
| `children` | list of nodes | The node's child nodes |
| `edit` | bool | Whether the node's text can be edited | | `edit` | bool | Whether the node's text can be edited |
| `delete` | bool | Whether the node can be deleted | | `delete` | bool | Whether the node can be deleted |
| `reply` | bool | Whether a new child node to this node can be created | | `reply` | bool | Whether a new child node to this node can be created |
| `act` | bool | Whether this node's action can be performed | | `act` | bool | Whether this node's action can be performed |
| `children` | map from node ID to node | The node's child nodes |
| `order` | list of node IDs | The order the children should be displayed in |
Each node has an ID that is unique within the node list it is in. A node's ID Each node has a map of child nodes which are identified by an ID. That ID does
does not have to be unique globally. not have to be unique globally.
When a node is displayed, its children should be displayed according to their In addition to that, each node also defines a display order for its child nodes
order in the list. The same is true for the root node list. in the form of a list of node IDs. The list contains each child node ID exactly
once. The nodes are listed from top to bottom.
Here is an example node: Here is an example node:
``` json ``` json
{ {
"id": "node1",
"text": "This is an example node", "text": "This is an example node",
"edit": false, "edit": false,
"delete": false, "delete": false,
"reply": false, "reply": false,
"act": false, "act": false,
"children": [ "children": {
{ "child1": {
"id": "child1",
"text": "And this is a child node", "text": "And this is a child node",
"edit": true, "edit": true,
"delete": true, "delete": true,
"reply": false, "reply": false,
"act": false, "act": false,
"children": [] "children": {},
"order": []
}, },
{ "child2": {
"id": "child2",
"text": "This is another child node", "text": "This is another child node",
"edit": false, "edit": false,
"delete": false, "delete": false,
"reply": false, "reply": false,
"act": true, "act": true,
"children": [] "children": {},
"order": []
} }
] },
"order": ["child2", "child1"]
} }
``` ```
@ -156,13 +157,11 @@ contains the protocol extensions that will be active for this connection.
### update ### update
An `update` packet is sent by the server whenever the client's node tree An `update` packet is sent by the server whenever the client's node tree
changes. When receiving an `update` package, the client should immediately changes. When receiving an `update` packet, the client should immediately update
update its node tree and display the new tree. its node tree and display the new tree.
| Property | Type | Description | | Property | Type | Description |
|----------|---------------|--------------------------------------------------------| |----------|--------|----------------------------------------------|
| `type` | string | The string `update` | | `type` | string | The string `update` |
| `path` | path | The path to the node whose children should be replaced | | `path` | path | The path to the node that should be replaced |
| `nodes` | list of nodes | The new list of children | | `node` | node | The replacement node |
If the path is an empty path, the root node list should be replaced.