diff --git a/README.md b/README.md index 552b0dd..0e6c18d 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Documentation * [Getting Started](doc/02-Getting-Started.md) * [Create your first process node](doc/03-Create-your-first-process-node.md) * [Importing Processes](doc/04-Importing-Processes.md) +* [Customize Node Order](doc/05-Customize-Node-Order.md) ### Web Components * [Breadcrumb](doc/12-Web-Components-Breadcrumb.md) diff --git a/doc/05-Customize-Node-Order.md b/doc/05-Customize-Node-Order.md new file mode 100644 index 0000000..f9d87f1 --- /dev/null +++ b/doc/05-Customize-Node-Order.md @@ -0,0 +1,74 @@ +Customize Node Order +===================================================== + +By default all nodes are ordered alphabetically while viewing them in the UI. +Though, it is also possible to order nodes entirely manually. + +> **Note** +> +> Once manual order is applied (no matter where) alphabetical order is +> disabled for the entire configuration. + +Reorder by Drag'n'Drop +---------------------- + +Make sure to unlock the configuration first to be able to reorder nodes. + +### Tile View + +To move a tile simply grab it with your mouse and drag it to the location you +want it to appear at. + +![Grab Tile](screenshot/05_customize_node_order/0501_tiles_grab_tile.png) +![Drop Tile](screenshot/05_customize_node_order/0502_tiles_drop_at_location.png) + +### Tree View + +While in tree view nodes can be moved the same way. You just have a narrower +area to grab them. + +![Grab Row](screenshot/05_customize_node_order/0503_tree_grab_header.png) +![Drop Row](screenshot/05_customize_node_order/0504_tree_drop_at_location.png) + +The tree view also has an advantage the tile view has not. It is possible to +move nodes within the entire hierarchy. But remember to unfold processes first, +if you want to move a node into them. + +File Format Extensions +---------------------- + +The configuration file format has slightly been changed to accommodate the new +manual order. Though, previous configurations are perfectly upwards compatible. + +### New Header + +A new header is used to flag a configuration file as being manually ordered. + +``` +# ManualOrder : yes +``` + +Once this is set alphabetical order is disabled and only the next techniques +define the order of nodes. + +### Changed `display` Semantic + +Previously there were only two valid values for the `display` directive. +(0 = Subprocess, 1 = Toplevel Process) + +``` +display 0|1;; +``` + +This has now been extended so that values greater than zero refer to the order +of root nodes. (ascending) + +``` +display 0|n;<name>;<title> +``` + +### Significant Children Order + +Previously the order of a node's children in a configuration file was not +important in any way. Now this is significant and refers to the order in +which children appear in the UI and how process states are determined. diff --git a/doc/screenshot/05_customize_node_order/0501_tiles_grab_tile.png b/doc/screenshot/05_customize_node_order/0501_tiles_grab_tile.png new file mode 100644 index 0000000..5697786 Binary files /dev/null and b/doc/screenshot/05_customize_node_order/0501_tiles_grab_tile.png differ diff --git a/doc/screenshot/05_customize_node_order/0502_tiles_drop_at_location.png b/doc/screenshot/05_customize_node_order/0502_tiles_drop_at_location.png new file mode 100644 index 0000000..cd7b673 Binary files /dev/null and b/doc/screenshot/05_customize_node_order/0502_tiles_drop_at_location.png differ diff --git a/doc/screenshot/05_customize_node_order/0503_tree_grab_header.png b/doc/screenshot/05_customize_node_order/0503_tree_grab_header.png new file mode 100644 index 0000000..7687713 Binary files /dev/null and b/doc/screenshot/05_customize_node_order/0503_tree_grab_header.png differ diff --git a/doc/screenshot/05_customize_node_order/0504_tree_drop_at_location.png b/doc/screenshot/05_customize_node_order/0504_tree_drop_at_location.png new file mode 100644 index 0000000..828aebe Binary files /dev/null and b/doc/screenshot/05_customize_node_order/0504_tree_drop_at_location.png differ