diff --git a/visualization/README.md b/visualization/README.md index 990751f979e912a6d9fe1aad7d318aad7be86911..31722b8dc7a41c550210183fa04e14dd04e5fc77 100644 --- a/visualization/README.md +++ b/visualization/README.md @@ -44,13 +44,13 @@ A remnant of this genericity idea can be found in the main JavaScript file of th 1. **$rootScope.json\_mapping** 2. **$rootScope.special\_node\_types** -These variables maintain a somehwat generic code base by simply defining only _once_ any idiosyncrasies of the encountered JSON files. +These variables maintain a somewhat generic code base by simply defining only _once_ any idiosyncrasies of the encountered JSON files. -In a future update, we might expand this idea by allowing you to freely change a config file that simply gets read by the suite, instead of having to change the code in the nested directory. +In a future update, we might expand this idea by allowing you to freely change a config file that simply gets read by the suite, instead of having to change the code directly. ### **$rootScope.json\_mapping** -The first variable is intended to define a mapping between the JSON-specific nomenclature of keys to the generic graph-theoretical terminology. +This first variable is intended to define a mapping between the JSON-specific nomenclature of keys to the generic graph-theoretical terminology. For example, if you call your nodes "knoten" and your edges "verbindungen", you can simply change the mapping to: @@ -63,7 +63,7 @@ For example, if you call your nodes "knoten" and your edges "verbindungen", you This way, every time the suite needs to access nodes, it can do so by checking this mapping on how _you_ refer to nodes. ### **$rootScope.special\_node\_types** -The second variable declares some nodes to be "special" in the sense that those are nodes that should be displayed differently from undeclared nodes. +This second variable declares some nodes to be "special" in the sense that those are nodes that should be displayed differently from undeclared nodes. Notice that this automatically displays nodes with the default shape and color if they do not match the condition given in the variable. However, this match condition is not made explicit but instead currently relies on the "label" of a node to match a String in this variable.