Skip to content

Commit

Permalink
Merge pull request #347 from Bandov/UG-Image-update
Browse files Browse the repository at this point in the history
Ug image update
  • Loading branch information
Bandov authored Apr 15, 2024
2 parents 0753264 + fbc8cbe commit 1317c48
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ For your convenience, <span class="hello_span">Gene-nie</span> has some predefin
1. This relationship type is used to denote a friendship relationship.

<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
**Be careful with custom attribute names and values!** We are unable to handle any unexpected bugs that might occur due to the user's defined relations other than the constraints we have [defined below](#features---managing-person-relationships) Alas, we cannot wave our wands to fix these just yet. Remember, even adding predefined relation types without an 's' still counts as a custom relation type (eg. sibling instead of siblings)! To harness the power of our predefined relation types mentioned above, be sure to match the characters exactly.
**Be careful with custom attribute names and values!** We are unable to handle any unexpected bugs that might occur due to the user's defined relations other than the constraints we have [defined below](#features---managing-person-relationships). Alas, we cannot wave our wands to fix these just yet. Remember, even adding predefined relation types without an 's' still counts as a custom relation type (eg. sibling instead of siblings)! To harness the power of our predefined relation types mentioned above, be sure to match the characters exactly.
</div>

<div markdown="block" class="alert alert-warning">:exclamation: **Warning:**
Expand Down Expand Up @@ -1118,8 +1118,8 @@ UUIDs are 4 characters long, containing only alphanumeric characters
* If there exists at least one relationship between `ORIGINUUID` and `TARGETUUID` the relationship pathway will be returned,
else `No Relationship Pathway Found` will be returned.

* * <span class="hello_span">Examples:</span>
* * * Example: `anySearch /0001 /0003` suppose 0003 is the friend of 0001 parent, `anySearch` will then return the descriptor `0001 -> (bioParents) child of --> 0002 --> friends of --> 0003`.
* <span class="hello_span">Examples:</span>
* Example: `anySearch /0001 /0003` suppose 0003 is the friend of 0001 parent, `anySearch` will then return the descriptor `0001 -> (bioParents) child of --> 0002 --> friends of --> 0003`.

<div class="img_container" align="center">
<figure>
Expand All @@ -1132,16 +1132,18 @@ else `No Relationship Pathway Found` will be returned.
</figure>
</div>

* * <span class="hello_span">Examples:</span>
* * * `anySearch /0001 /0004` suppose 0004 is not related to 0001 at all, then `anySearch` returns `No Relationship Pathway Found`
* <span class="hello_span">Examples:</span>
* `anySearch /0001 /0004` suppose 0004 is not related to 0001 at all, then `anySearch` returns `No Relationship Pathway Found`
* The command is order-sensitive: `anySearch /0001 /0003` can potentially return a different result from `anySearch /0003 /0001`
* * * `anySearch /0001 /0003` suppose the search above returns `0001 -> (bioParents) child of --> 0002 --> friends of --> 0003` then `anySearch /0003 /0001`
returns `0003 -> friends of --> 0002 --> (bioParents) parent of --> 0001` since relationships are bidirectional
* `anySearch /0001 /0003` suppose the search above returns `0001 -> (bioParents) child of --> 0002 --> friends of --> 0003` then `anySearch /0003 /0001`
returns `0003 -> friends of --> 0002 --> (bioParents) parent of --> 0001` since relationships are bidirectional

[Back to Table of Contents](#table-of-contents)

---

<span class="h3_span" id="finding-family-relationships-between-entities--familysearch-or-ds">Finding Family Relationships between Entities: `familySearch` or `fs`</span>

<span style="font-style: italic;">Finds the family relationship pathway between 2 input entities.</span>

<span class="hello_span">Format:</span> `familySearch /ORIGINUUID /TARGETUUID` or `fs /ORIGINUUID /TARGETUUID`
Expand All @@ -1155,8 +1157,8 @@ UUIDs are 4 characters long, containing only alphanumeric characters
* If there exists a family relationship between `ORIGINUUID` and `TARGETUUID` the relationship descriptor will be returned,
else `No Relationship Pathway Found` will be returned.

* * <span class="hello_span">Examples:</span>
- - - `familySearch /0001 /0003` suppose 0003 is the grandparent of 0001, `familySearch` will then return the descriptor `0001 -> (bioParents) child of --> 0002 --> (bioParents) child of --> 0003`.
* <span class="hello_span">Examples:</span>
* `familySearch /0001 /0003` suppose 0003 is the grandparent of 0001, `familySearch` will then return the descriptor `0001 -> (bioParents) child of --> 0002 --> (bioParents) child of --> 0003`.

<div class="img_container" align="center">
<figure>
Expand All @@ -1169,11 +1171,11 @@ else `No Relationship Pathway Found` will be returned.
</figure>
</div>

- - - `familySearch /0001 /0004` suppose 0004 has no family relation to 0001, then `familySearch` returns `No Relationship Pathway Found`
* `familySearch /0001 /0004` suppose 0004 has no family relation to 0001, then `familySearch` returns `No Relationship Pathway Found`
* The command is order-sensitive `familySearch /0001 /0003` can potentially return a different result from `familySearch /0003 /0001`

* * <span class="hello_span">Examples:</span>
- - - `familySearch /0001 /0003` suppose the search above returns `0001 -> (bioParents) child of --> 0002 --> (bioParents) child of --> 0003` then `familySearch /0003 /0001` returns `0003 -> (bioParents) parent of --> 0002 --> (bioParents) parent of --> 0001` since relationships are bidirectional.
* <span class="hello_span">Examples:</span>
* `familySearch /0001 /0003` suppose the search above returns `0001 -> (bioParents) child of --> 0002 --> (bioParents) child of --> 0003` then `familySearch /0003 /0001` returns `0003 -> (bioParents) parent of --> 0002 --> (bioParents) parent of --> 0001` since relationships are bidirectional.

[Back to Table of Contents](#table-of-contents)

Expand Down
Binary file modified docs/images/Gene-nieMainScreen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/Gene-niePersonCard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/PersonCard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/geneniesearchresult.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1317c48

Please sign in to comment.