From 42a5a9ad11e918af441b1d45b62278f47f4c17b2 Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Fri, 1 Mar 2019 10:20:55 +0100 Subject: [PATCH] doc: Also leave a note about how the config file format has changed refs #207 --- doc/05-Customize-Node-Order.md | 45 +++++++++++++++++++++++++++++++--- 1 file changed, 42 insertions(+), 3 deletions(-) diff --git a/doc/05-Customize-Node-Order.md b/doc/05-Customize-Node-Order.md index c990650..f9d87f1 100644 --- a/doc/05-Customize-Node-Order.md +++ b/doc/05-Customize-Node-Order.md @@ -30,6 +30,45 @@ 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) -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. +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.