diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html
index 957acc574..22a4691b1 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html
@@ -1,6 +1,45 @@
-Relation map is a type of Note which
- visualizes notes and their relations.
- See an example:
+Relation map is a type of note which visualizes notes and their
+ relations.
+Interaction
+
+ - To create a new note and add it to the board, press the plus button in
+ the Floating buttons.
+
+ - Afterwards, click anywhere on the map to place it there.
+ - The note will be placed as a sub-child of the map.
+
+
+ - An existing note can also be dragged from the Note Tree. It will be
+ placed at the position it's dragged on.
+
+ - Multiple notes can also be dragged via Multiple selection. The
+ notes will be positioned near the dragged position without overlapping.
+ - The dragged note can be a sub-child of the map, or it can be at any arbitrary
+ position.
+
+
+ - To create a relationship, hold the mouse on the box on the right of a
+ note and then:
+
+ - Drag it over another note to create a relationship pointing from the first
+ note to the second one.
+ - Drag over the same note to create a self-referencing relationship (represented
+ as a loop).
+ - Once dragged, enter the name of the relationship to create. To cancel,
+ simply dismiss the dialog or press Esc.
+
+
+ - To open a note, either click on the note (opening it in the current view)
+ or use the right click menu to open in a new tab.
+ - To edit the title of a note or to delete it (either from the map, or delete
+ it completely), right click the note.
+ - To delete a relationship, right click it and select the corresponding
+ option.
+
Development process demo
This is a basic example how you can create simple diagram using relation
maps:
@@ -32,33 +71,38 @@
There are several steps here:
- - we start with empty relation map and two existing notes representing Prince
- Philip and Queen Elizabeth II. These two notes already have "isPartnerOf"
+
- we start with empty relation map and two existing notes representing Prince
+ Philip and Queen Elizabeth II. These two notes already have
isPartnerOf
relationsdefined.
- - There are actually two "inverse" relations (one from Philip to Elizabeth
+
- There are actually two "inverse" relations (one from Philip to Elizabeth
and one from Elizabeth to Philip)
- - we drag both notes to relation map and place to suitable position. Notice
- how the existing "isPartnerOf" relations are displayed.
- - now we create new note - we name it "Prince Charles" and place it on the
+
- we drag both notes to relation map and place to suitable position. Notice
+ how the existing
isPartnerOf relations are displayed.
+ - now we create new note - we name it "Prince Charles" and place it on the
relation map by clicking on the desired position. The note is by default
created under the relation map note (visible in the note tree on the left).
- - we create two new relations "isChildOf" targeting both Philip and Elizabeth
-
- - now there's something unexpected - we can also see the relation to display
- another "hasChild" relation. This is because there's a relation definition which
- puts "isChildOf" as an "inverse"
- relation of "hasChildOf" (and vice versa) and thus it is created automatically.
-
-
- - we create another note for Princess Diana and create "isPartnerOf" relation
- from Charles. Again notice how the relation has arrows both ways - this
- is because "isPartnerOf" definition specifies its inverse relation as again
- "isPartnerOf" so the opposite relation is created automatically.
- - as the last step we pan & zoom the map to fit better to window dimensions.
+ - we create two new relations
isChildOf targeting both Philip
+ and Elizabeth
+
+ - now there's something unexpected - we can also see the relation to display
+ another
hasChild relation. This is because there's a relation definition which
+ puts isChildOf as an "inverse"
+ relation of hasChildOf (and vice versa) and thus it is created
+ automatically.
+
+
+ - we create another note for Princess Diana and create
isPartnerOf relation
+ from Charles. Again notice how the relation has arrows both ways - this
+ is because isPartnerOf definition specifies its inverse relation
+ as again "isPartnerOf" so the opposite relation is created automatically.
+ - as the last step we pan & zoom the map to fit better to window dimensions.
Relation definitions mentioned above come from "Person template" note
which is assigned to any child of "My Family Tree" relation note. You can
@@ -71,5 +115,6 @@
the ones defined in the label.
See also
\ No newline at end of file
diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json
index 997d24d43..c039b67ef 100644
--- a/docs/Developer Guide/!!!meta.json
+++ b/docs/Developer Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.0",
+ "appVersion": "0.99.1",
"files": [
{
"isClone": false,
diff --git a/docs/Release Notes/!!!meta.json b/docs/Release Notes/!!!meta.json
index 1d824c415..149090d20 100644
--- a/docs/Release Notes/!!!meta.json
+++ b/docs/Release Notes/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.0",
+ "appVersion": "0.99.1",
"files": [
{
"isClone": false,
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 9957ce34c..e3b77f0ef 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.99.0",
+ "appVersion": "0.99.1",
"files": [
{
"isClone": false,
@@ -7671,13 +7671,6 @@
"type": "text",
"mime": "text/markdown",
"attributes": [
- {
- "type": "relation",
- "name": "internalLink",
- "value": "BFs8mudNFgCS",
- "isInheritable": false,
- "position": 10
- },
{
"type": "relation",
"name": "internalLink",
@@ -7699,13 +7692,6 @@
"isInheritable": false,
"position": 40
},
- {
- "type": "relation",
- "name": "internalLink",
- "value": "BCkXAVs63Ttv",
- "isInheritable": false,
- "position": 50
- },
{
"type": "label",
"name": "shareAlias",
@@ -7719,6 +7705,34 @@
"value": "bx bxs-network-chart",
"isInheritable": false,
"position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "XpOYSgsLkTJy",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "yTjUdsOi4CIE",
+ "isInheritable": false,
+ "position": 80
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "bdUJEHsAPYQR",
+ "isInheritable": false,
+ "position": 90
}
],
"format": "markdown",
diff --git a/docs/User Guide/User Guide/Note Types/Relation Map.md b/docs/User Guide/User Guide/Note Types/Relation Map.md
index 23af21574..d6d164ac3 100644
--- a/docs/User Guide/User Guide/Note Types/Relation Map.md
+++ b/docs/User Guide/User Guide/Note Types/Relation Map.md
@@ -1,5 +1,21 @@
# Relation Map
-Relation map is a type of [Note](../Basic%20Concepts%20and%20Features/Notes.md) which visualizes notes and their [relations](../Advanced%20Usage/Attributes.md). See an example:
+Relation map is a type of note which visualizes notes and their [relations](../Advanced%20Usage/Attributes.md).
+
+## Interaction
+
+* To create a new note and add it to the board, press the plus button in the Floating buttons.
+ * Afterwards, click anywhere on the map to place it there.
+ * The note will be placed as a sub-child of the map.
+* An existing note can also be dragged from the Note Tree. It will be placed at the position it's dragged on.
+ * Multiple notes can also be dragged via Multiple selection. The notes will be positioned near the dragged position without overlapping.
+ * The dragged note can be a sub-child of the map, or it can be at any arbitrary position.
+* To create a relationship, hold the mouse on the box on the right of a note and then:
+ * Drag it over another note to create a relationship pointing from the first note to the second one.
+ * Drag over the same note to create a self-referencing relationship (represented as a loop).
+ * Once dragged, enter the name of the relationship to create. To cancel, simply dismiss the dialog or press Esc.
+* To open a note, either click on the note (opening it in the current view) or use the right click menu to open in a new tab.
+* To edit the title of a note or to delete it (either from the map, or delete it completely), right click the note.
+* To delete a relationship, right click it and select the corresponding option.
## Development process demo
@@ -11,7 +27,7 @@ And this is how you can create it:
-We start completely from scratch by first creating new note called "Development process" and changing its type to "Relation map". After that we create new notes one by one and place them by clicking into the map. We also drag [relations](../Advanced%20Usage/Attributes.md)between notes and name them. That's all!
+We start completely from scratch by first creating new note called "Development process" and changing its type to "Relation map". After that we create new notes one by one and place them by clicking into the map. We also drag [relations](../Advanced%20Usage/Attributes.md) between notes and name them. That's all!
Items on the map - "Specification", "Development", "Testing" and "Demo" are actually notes which have been created under "Development process" note - you can click on them and write some content. Connections between notes are called "[relations](../Advanced%20Usage/Attributes.md)".
@@ -27,13 +43,13 @@ This is how you get to it:
There are several steps here:
-* we start with empty relation map and two existing notes representing Prince Philip and Queen Elizabeth II. These two notes already have "isPartnerOf" [relations](../Advanced%20Usage/Attributes.md)defined.
+* we start with empty relation map and two existing notes representing Prince Philip and Queen Elizabeth II. These two notes already have `isPartnerOf` [relations](../Advanced%20Usage/Attributes.md) defined.
* There are actually two "inverse" relations (one from Philip to Elizabeth and one from Elizabeth to Philip)
-* we drag both notes to relation map and place to suitable position. Notice how the existing "isPartnerOf" relations are displayed.
+* we drag both notes to relation map and place to suitable position. Notice how the existing `isPartnerOf` relations are displayed.
* now we create new note - we name it "Prince Charles" and place it on the relation map by clicking on the desired position. The note is by default created under the relation map note (visible in the note tree on the left).
-* we create two new relations "isChildOf" targeting both Philip and Elizabeth
- * now there's something unexpected - we can also see the relation to display another "hasChild" relation. This is because there's a [relation definition](../Advanced%20Usage/Attributes/Promoted%20Attributes.md) which puts "isChildOf" as an "[inverse](../Advanced%20Usage/Attributes/Promoted%20Attributes.md)" relation of "hasChildOf" (and vice versa) and thus it is created automatically.
-* we create another note for Princess Diana and create "isPartnerOf" relation from Charles. Again notice how the relation has arrows both ways - this is because "isPartnerOf" definition specifies its inverse relation as again "isPartnerOf" so the opposite relation is created automatically.
+* we create two new relations `isChildOf` targeting both Philip and Elizabeth
+ * now there's something unexpected - we can also see the relation to display another `hasChild` relation. This is because there's a [relation definition](../Advanced%20Usage/Attributes/Promoted%20Attributes.md) which puts `isChildOf` as an "[inverse](../Advanced%20Usage/Attributes/Promoted%20Attributes.md)" relation of `hasChildOf` (and vice versa) and thus it is created automatically.
+* we create another note for Princess Diana and create `isPartnerOf` relation from Charles. Again notice how the relation has arrows both ways - this is because `isPartnerOf` definition specifies its inverse relation as again "isPartnerOf" so the opposite relation is created automatically.
* as the last step we pan & zoom the map to fit better to window dimensions.
Relation definitions mentioned above come from "Person template" note which is assigned to any child of "My Family Tree" relation note. You can play with the whole thing in the [demo notes](../Advanced%20Usage/Database.md).
@@ -46,4 +62,4 @@ Alternatively, you can specify comma delimited list of relation names in `hideRe
## See also
-* [Note Map](../Advanced%20Usage/Note%20Map%20\(Link%20map%2C%20Tree%20map\).md) is a similar concept
\ No newline at end of file
+* Note Map is a similar concept.
\ No newline at end of file