X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=README.md;h=4806b37d435ac484f03bf07bea718d014d403a6b;hb=d23e4446900023bfc179c60224514851e508ad9f;hp=4d434405a8767742677f081bbc42b449058f889b;hpb=bf4fc3ed5a41cd1604ed74b8fb0b1e5261e517c5;p=erdiag.git diff --git a/README.md b/README.md index 4d43440..4806b37 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,13 @@ Inspired by [this repository](https://code.google.com/archive/p/merisier/). This parser reads ER diagrams definition files, and produces two types of diagrams + SQL code. [Graphviz](https://www.graphviz.org/) is used on server side to translate parsed graph descriptions into SVG objects. -*Note:* at the moment, only the conceptual graph is implemented, and no comments are allowed in textual descriptions. -At least the former is planned, and also probably a way to indicate relative identifiers. +**TODO** list: + + - functional integrity constraints (CIF), + - inter-relations constraints (or, and, xor...), + - inheritance with the right symbol (triangle). + +*Note:* temporary dependency to [underscore](http://underscorejs.org/); good library but used so far only for its shuffle() method. ----- @@ -35,6 +40,8 @@ Cardinality dictionary: * 1 = 1..1 * ? = 0..1 +Special cardinalities are also available to indicate relative identification: `?R` and `1R`. + To mark a weak entity, just surround its name by extra-brackets [[WeakEntity]] @@ -51,7 +58,7 @@ To indicate an inheritance relation, proceed as follow Animal Cat Fish Planet Mars Venus -Finally, blocks must be separated by new lines. For a usage example, see example.html (it should render as seen in example.svg) +Finally, blocks must be separated by new lines. For a usage example, see example.html (it should render as seen in example\_\*.svg) Note that the "drawMcd" method can take a second argument, which indicates the type of graph. * "bubble" draws the standard graph, as seen [here](https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model#/media/File:ER_Diagram_MMORPG.png) for example