doc/entities.md in power_stencil-0.3.9 vs doc/entities.md in power_stencil-0.4.0

- old
+ new

@@ -270,12 +270,17 @@ $ power_stencil get base_entity --names-only --regexp - my_2nd_entity - my_1st_entity ``` -There are 2 other options (`--compiled` and `--scenario`) but they will be covered in the scope of [builds]. +There are 2 other interesting options (`--compiled` and `--scenario`) but they will be covered in the scope of [builds]. +:information_source: Another very interesting option is `--graph`. **It will generate a [Graphviz] graph of the relations of the entities within the repository.** This is actually provided by the [universe_compiler] Gem. The display of this graph can be completed customized at project level (the 2 versioned and unversioned config files), at entity level (by providing a `#graphviz_label` method in your entities. You'll see later in that document what it means in [creating custom entity types](#creating-custom-entity-types)), and even at plugin level. + +By default the graph is generated in a temporary folder, but of course you can specify the file name using the `--graph-file` options. The default is to generate an svg file (best viewed in a browser as it contains _hover_ over its nodes). + + ## Creating entities ### Versioned entities You can create new entities in the repository using the `power_stencil create` command. @@ -961,6 +966,7 @@ [YAML]: https://yaml.org/ "The YAML official site" [Ruby]: https://www.ruby-lang.org "The powerful Ruby language" [Pry]: https://github.com/pry/pry "The awesome Pry console" [ActiveRecord]: https://guides.rubyonrails.org/active_record_basics.html "The ultimate ORM" [Ruby On Rails]: https://rubyonrails.org/ "One of the best Web framework" -[universe_compiler]: https://gitlab.com/tools4devops/universe_compiler "The underlying engine to manage entities and compilation !" +[universe_compiler]: https://gitlab.com/tools4devops/universe_compiler "The underlying engine to manage entities and compilation !" +[Graphviz]: (https://www.graphviz.org/) "Graph Visualization Software" \ No newline at end of file