From 0e2b54b92a91f81e7e1a2256ca243e1d1c513900 Mon Sep 17 00:00:00 2001 From: rschoene <rene.schoene@tu-dresden.de> Date: Thu, 24 Feb 2022 16:54:48 +0100 Subject: [PATCH] 0.2.1 - fix and update documentation --- .../resources/grammar2umlVersion.properties | 4 +-- pages/docs/grammar2uml.md | 31 ------------------ pages/docs/index.md | 32 +++++++++++++++++++ pages/mkdocs.yml | 1 - 4 files changed, 34 insertions(+), 34 deletions(-) delete mode 100644 pages/docs/grammar2uml.md create mode 100644 pages/docs/index.md diff --git a/grammar2uml/src/main/resources/grammar2umlVersion.properties b/grammar2uml/src/main/resources/grammar2umlVersion.properties index b3b2086..0dab828 100644 --- a/grammar2uml/src/main/resources/grammar2umlVersion.properties +++ b/grammar2uml/src/main/resources/grammar2umlVersion.properties @@ -1,2 +1,2 @@ -#Thu Feb 24 16:08:53 CET 2022 -version=0.2 +#Thu Feb 24 16:54:04 CET 2022 +version=0.2.1 diff --git a/pages/docs/grammar2uml.md b/pages/docs/grammar2uml.md deleted file mode 100644 index 1685260..0000000 --- a/pages/docs/grammar2uml.md +++ /dev/null @@ -1,31 +0,0 @@ -# Grammar2Uml - -The tool called `Grammar2Uml` ([see in repo](https://git-st.inf.tu-dresden.de/jastadd/grammar2uml/-/tree/main/grammar2uml)) takes a set of grammar specifications and creates a visualization similar to UML class diagrams. - - - - -Every nonterminal will be shown as a rectangular box with its terminal children listed within it. Children are shown as containment relations between parent and child, whereas relations and intrinsic references are shown using arrows. - -Furthermore, some options may be specified. - -| Name | Required (Default) | Description | -|----------------------|--------------------|-------------------------------------------------------------------------| -| `--output` | No (`uml.md`) | target file to be generated. | -| `--inputGrammar2Uml` | No | grammar2uml definition file, see [below](#grammar2uml-definition-file). | -| `--defaultFolders` | No (`false`) | Creates a default folder per grammar file. | -| `--help` | No | Print usage and exit. | -| `--version` | No | Print version and exit. | -| `--verbose` | No | Print more messages while compiling. | - -## Grammar2uml definition file - -To structure the generated visualization, any number of nonterminals can be grouped with folders. -Either specify the option `--defaultFolders` to use one folder per input grammar file, or specify a grammar2uml definition file. -The definition file has a simple syntax, it is a list of folder specifications. One specifications looks like - -``` -folder FOLDER_NAME : NT1, NT2, ..., NT_n -``` - -It produces one folder named `FOLDER_NAME` containing all nonterminals (`NT1`, `NT2`, ..., `NT_n`) following it. diff --git a/pages/docs/index.md b/pages/docs/index.md new file mode 100644 index 0000000..a19a534 --- /dev/null +++ b/pages/docs/index.md @@ -0,0 +1,32 @@ +# Grammar2Uml + +The tool called `Grammar2Uml` ([see in repo](https://git-st.inf.tu-dresden.de/jastadd/grammar2uml)) takes a set of grammar specifications and creates a visualization similar to UML class diagrams. + + + + +Every nonterminal will be shown as a rectangular box with its terminal children listed within it. Children are shown as containment relations between parent and child, whereas relations and intrinsic references are shown using arrows. + +Furthermore, more options may be specified. + +| Name | Description | +|----------------------|-------------------------------------------------------------------------| +| `--output` | target file to be generated (default: `uml.md` or `uml.png`, depending on `--printSource`) | +| `--inputGrammar2Uml` | grammar2uml definition file, see [below](#grammar2uml-definition-file). | +| `--printSource` | If set, the output will be the source code instead of a png. (default: create a png) | +| `--defaultFolders` | If set, creates a default folder per grammar file. (default: use one global folder) | +| `--help` | Print usage and exit. | +| `--version` | Print version and exit. | +| `--verbose` | Print more messages while compiling. | + +## Grammar2uml definition file + +To structure the generated visualization, any number of nonterminals can be grouped with folders. +Either specify the option `--defaultFolders` to use one folder per input grammar file, or specify a grammar2uml definition file. +The definition file has a simple syntax, it is a list of folder specifications. One specifications looks like + +``` +folder FOLDER_NAME : NT1, NT2, ..., NT_n +``` + +It produces one folder named `FOLDER_NAME` containing all nonterminals (`NT1`, `NT2`, ..., `NT_n`) following it. diff --git a/pages/mkdocs.yml b/pages/mkdocs.yml index 209f546..853b051 100644 --- a/pages/mkdocs.yml +++ b/pages/mkdocs.yml @@ -3,7 +3,6 @@ repo_url: https://git-st.inf.tu-dresden.de/jastadd/grammar2uml site_dir: ../public nav: - - "grammar2uml": grammar2uml.md - "API documentation": ragdoc/index.html theme: -- GitLab