From 91b64798bbdf1beec9c6a3a38b74d3c7292562fd Mon Sep 17 00:00:00 2001 From: Adrian Hall Date: Fri, 10 Apr 2020 11:40:39 +0100 Subject: [PATCH 1/2] Escape the pipes in the syntax table --- docs/entityRelationshipDiagram.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/entityRelationshipDiagram.md b/docs/entityRelationshipDiagram.md index da5bf4b0d0..f87b0c9b52 100644 --- a/docs/entityRelationshipDiagram.md +++ b/docs/entityRelationshipDiagram.md @@ -61,10 +61,10 @@ Cardinality is a property that describes how many elements of another entity can | Value (left) | Value (right) | Meaning | |:------------:|:-------------:|--------------------------------------------------------| -| `|o` | `o|` | Zero or one | -| `||` | `||` | Exactly one | +| `\|o` | `o\|` | Zero or one | +| `\|\|` | `\|\|` | Exactly one | | `}o` | `o{` | Zero or more (no upper limit) | -| `}|` | `|{` | One or more (no upper limit) | +| `}\|` | `\|{ | One or more (no upper limit) | ### Identification From 3db27e601727e76f0dd68620978489a6545a9e40 Mon Sep 17 00:00:00 2001 From: Adrian Hall Date: Fri, 10 Apr 2020 11:47:29 +0100 Subject: [PATCH 2/2] Tiny tweaks to docs for ER diagram --- docs/entityRelationshipDiagram.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/entityRelationshipDiagram.md b/docs/entityRelationshipDiagram.md index f87b0c9b52..8a3924d3b1 100644 --- a/docs/entityRelationshipDiagram.md +++ b/docs/entityRelationshipDiagram.md @@ -2,7 +2,7 @@ > An entity–relationship model (or ER model) describes interrelated things of interest in a specific domain of knowledge. A basic ER model is composed of entity types (which classify the things of interest) and specifies relationships that can exist between entities (instances of those entity types). Wikipedia. -Note that practitioners of ER modelling almost always refer to entity types simply as entities. For example the CUSTOMER entity type would be referred to simply as the CUSTOMER entity. This is so common it would be inadvisable to do anything else, but technically an entity is an abstract *instance* of an entity type, and this is what an ER diagram shows - abstract instances, and the relationships between them. This is why entities are always named using singular nouns. +Note that practitioners of ER modelling almost always refer to *entity types* simply as *entities*. For example the CUSTOMER entity type would be referred to simply as the CUSTOMER entity. This is so common it would be inadvisable to do anything else, but technically an entity is an abstract *instance* of an entity type, and this is what an ER diagram shows - abstract instances, and the relationships between them. This is why entities are always named using singular nouns. Mermaid can render ER diagrams ``` @@ -24,7 +24,7 @@ Relationships between entities are represented by lines with end markers represe ## Status -ER diagrams are a new feature in Mermaid and are **experimental**. There are likely to be a few bugs and constraints, and enhancements will be made in due course. +ER diagrams are a new feature in Mermaid and are **experimental**. There are likely to be a few bugs and constraints, and enhancements will be made in due course. Currently you can only define entities and relationships, but not attributes. ## Syntax @@ -64,7 +64,7 @@ Cardinality is a property that describes how many elements of another entity can | `\|o` | `o\|` | Zero or one | | `\|\|` | `\|\|` | Exactly one | | `}o` | `o{` | Zero or more (no upper limit) | -| `}\|` | `\|{ | One or more (no upper limit) | +| `}\|` | `\|{` | One or more (no upper limit) | ### Identification