Skip to content

Commit

Permalink
Refactored help
Browse files Browse the repository at this point in the history
  • Loading branch information
kreaweb.be committed Apr 14, 2024
1 parent 3101288 commit 09104d8
Showing 1 changed file with 51 additions and 51 deletions.
102 changes: 51 additions & 51 deletions resources/markdown/help.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,20 @@

### a. Users

<img src="img/help/genealogy-002aa.webp" class="rounded" alt="Menu">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-002aa.webp" class="rounded" alt="Menu">

Users can <b>register</b> themselves. At least a surname, a valid e-mail address and a password is needed.

<img src="img/help/genealogy-002bb.webp" class="rounded" alt="Register">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-002bb.webp" class="rounded" alt="Register">

After registration and optional e-mail verification, users can <b>login</b>.<br/>

<img src="img/help/genealogy-002cc.webp" class="rounded" alt="Login">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-002cc.webp" class="rounded" alt="Login">

Authenticated users, without invitation, by default belong to (and own) their own <b>personal team</b>.<br/>
New users, after accepting an invitation by email from another user and registering, by default will be logged in to the team they were invited to. Those users by default also have their own personal team at their disposal.

<img src="img/help/genealogy-002dd.webp" class="rounded" alt="Team">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-002dd.webp" class="rounded" alt="Team">

<div class="col-span-6 text-sm rounded bg-info-200 p-3 text-info-700" role="alert">
<b>Two Factor Authentification</b> (2FA) and <b>E-mail Verification</b> are enabled by default but can be configured in <b>config/fortify.php</b>.
Expand All @@ -57,14 +57,14 @@ This application uses <a href="https://jetstream.laravel.com/" target="_blank">L

Authenticated users can manage their own user profile and teams settings by using the dropdown menus in the top right-hand corner of the menu bar.

<img src="img/help/genealogy-003a.webp" class="rounded" alt="Profile settings">
<img src="img/help/genealogy-004a.webp" class="rounded" alt="Team settings">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-003a.webp" class="rounded" alt="Profile settings">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-004a.webp" class="rounded" alt="Team settings">

Users can manage either their personal team or create new teams.<br/>
<span class="text-danger">The personal team and all teams created by a user are also <b>owned</b> by that user.<br/>
Only the owner can invite other (new or already registered) users (by e-mail) to join the owned teams</span>.

<img src="img/help/genealogy-005.webp" class="rounded" alt="Team management">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-005.webp" class="rounded" alt="Team management">

<div class="col-span-6 text-sm rounded bg-info-200 p-3 text-info-700" role="alert">
Create a <b>new and seperate team</b> for each <b>family tree</b> you want to manage and invite other users to it</b>.<br/>
Expand Down Expand Up @@ -138,19 +138,19 @@ Authenticated users can only see persons and couples:

## 3. Search

<img src="img/help/genealogy-001.webp" class="rounded" alt="Menu">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-001.webp" class="rounded" alt="Menu">

After login and <span class="text-danger">selecting the proper team</span>, click on the <b>Search</b> button in the top navigation menu.

<img src="img/help/genealogy-010a.webp" class="rounded" alt="Search">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-010a.webp" class="rounded" alt="Search">

Enter a search value in the <b>search box</b>. You can use the character <b class="text-danger">%</b> as a wildcard character.<br/>
Above the search box the number of persons available to / found in the <b>current team</b> are shown.<br/>
You can use the pagination buttons. You can also change the number of persons shown per page.<br/>

The results are shown below the search box, each person is represented in one card.

<img src="img/help/genealogy-012.webp" class="rounded" alt="Menu">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-012.webp" class="rounded" alt="Menu">

Click on the <b>Profile</b> or <b>Family chart</b> button to see details about that person.
Click on the name of the father or the mother to go that person.
Expand All @@ -163,19 +163,19 @@ Click on the name of the father or the mother to go that person.

After login and <span class="text-danger">selecting the proper team</span>, click on the <b>Search</b> button in the top navigation menu.

<img src="img/help/genealogy-001.webp" class="rounded" alt="Search">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-001.webp" class="rounded" alt="Search">

You can add new person by clicking the <b>Add person</b> button above the search bar.

<img src="img/help/genealogy-010a.webp" class="rounded" alt="Add person">
<img src="img/help/genealogy-011a.webp" class="rounded" alt="Add person">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-010a.webp" class="rounded" alt="Add person">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-011a.webp" class="rounded" alt="Add person">

You can also upload the <b>primary photo</b> for the new person.

Another way to add people is to click on the <b>Add child</b> tab in the <b>Children</b> context menu of an existing person.

<img src="img/help/genealogy-050a.webp" class="rounded" alt="Children">
<img src="img/help/genealogy-051b.webp" class="rounded" alt="Add child">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-050a.webp" class="rounded" alt="Children">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-051b.webp" class="rounded" alt="Add child">

<div class="col-span-6 text-sm rounded bg-info-200 p-3 text-info-700" role="alert">
You can either create a <b>brand new person</b> or select an <b>existing person</b> as this persons new child.
Expand All @@ -191,35 +191,35 @@ Another way to add people is to click on the <b>Add child</b> tab in the <b>Chil

The personal overview shows all information about the selected person.

<img src="img/help/genealogy-020b.webp" class="rounded" alt="Person overview">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-020b.webp" class="rounded" alt="Person overview">

The navigation bar on top allows you to chose some specific items.

<img src="img/help/genealogy-021a.webp" class="rounded" alt="Person menu">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-021a.webp" class="rounded" alt="Person menu">

The <b>Profile</b> card shows all general information about the person.

<img src="img/help/genealogy-022aa.webp" class="rounded" alt="Profile deceased">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-022aa.webp" class="rounded" alt="Profile deceased">

Notice this card shows different data for <b>living</b> and <b>deceased</b> persons.

<img src="img/help/genealogy-022bb.webp" class="rounded" alt="Profile living">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-022bb.webp" class="rounded" alt="Profile living">

You can edit the <b>profile</b>, <b>contact</b> and <b>death</b> data by choosing the corresponding tab in the context menu.

<img src="img/help/genealogy-023a.webp" class="rounded" alt="Profile edit">
<img src="img/help/genealogy-024a.webp" class="rounded" alt="Profile edit profile">
<img src="img/help/genealogy-025a.webp" class="rounded" alt="Profile edit contact">
<img src="img/help/genealogy-026a.webp" class="rounded" alt="Profile edit death">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-023a.webp" class="rounded" alt="Profile edit">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-024a.webp" class="rounded" alt="Profile edit profile">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-025a.webp" class="rounded" alt="Profile edit contact">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-026a.webp" class="rounded" alt="Profile edit death">

### b. Photos

<img src="img/help/genealogy-022cc.webp" class="rounded" alt="Photo editing">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-022cc.webp" class="rounded" alt="Photo editing">

You can browse through the available photos by using the navigation bar above the photo carousel.<br/>
You can manage photos by choosing the corresponding tab in the context menu.

<img src="img/help/genealogy-027a.webp" class="rounded" alt="Photo add">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-027a.webp" class="rounded" alt="Photo add">

You can <b>upload</b> (multiple) new images.<br/>
You can <b>download</b> or <b>delete</b> existing images.<br/>
Expand All @@ -230,40 +230,40 @@ You can also set the primary image by clicking the <b>1</b> button.

The <b>Family</b> card shows the persons parents and the current partner.

<img src="img/help/genealogy-033a.webp" class="rounded" alt="Family">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-033a.webp" class="rounded" alt="Family">

<b>Father</b> and <b>Mother</b> are always referring to the <b>biological</b> father and mother.<br/>
Non-biological parent can be defined by the <b>Parents</b> link.

You can edit the family data by clicking the blue <b>Edit</b> button in the card header.

<img src="img/help/genealogy-034a.webp" class="rounded" alt="Family edit">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-034a.webp" class="rounded" alt="Family edit">

### d. Partners (Couples)

<img src="img/help/genealogy-040a.webp" class="rounded" alt="Partners">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-040a.webp" class="rounded" alt="Partners">

You can <b>add</b>, <b>edit</b> or <b>delete</b> a relationship by choosing the corresponding tab in the context menu.

<img src="img/help/genealogy-041a.webp" class="rounded" alt="Partners add">
<img src="img/help/genealogy-042a.webp" class="rounded" alt="Partners edit">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-041a.webp" class="rounded" alt="Partners add">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-042a.webp" class="rounded" alt="Partners edit">

### e. Children

<img src="img/help/genealogy-050a.webp" class="rounded" alt="Children">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-050a.webp" class="rounded" alt="Children">

You can add a child or disconnect existing children by choosing the corresponding tab in the context menu.
The disconnected child will remain in the database as a person but just not have the selected person as father or mother anymore.

<img src="img/help/genealogy-051b.webp" class="rounded" alt="Child add">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-051b.webp" class="rounded" alt="Child add">

When adding a child you can either create a <b>brand new person</b> or select an <b>existing person</b>.

### f. Siblings

Siblings are shown on the siblings card.<br/>

<img src="img/help/genealogy-060a.webp" class="rounded" alt="Siblings">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-060a.webp" class="rounded" alt="Siblings">

A sibling can be <b>full</b>: both the same biological parents as the selected person.<br/>
A sibling can be <b>half</b>: only the biological mother or the biological father are common.<br/>
Expand All @@ -274,21 +274,21 @@ A sibling can be <b>plus</b>: neither the biological father nor the biological m
This shows the selected persons ancestors.<br/>
You can change the tree depth by using the control in the Ancestors card header.

<img src="img/help/genealogy-070.webp" class="rounded" alt="Ancestors">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-070.webp" class="rounded" alt="Ancestors">

### h. Descendants

This shows the selected persons descendants.<br/>
You can change the tree depth by using the control in the Descendants card header.

<img src="img/help/genealogy-071.webp" class="rounded" alt="Descendants">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-071.webp" class="rounded" alt="Descendants">

### i. Family chart

This shows the compleet family chart, 3 generations deep.<br/>
Click on a family member name to see that persons details.

<img src="img/help/genealogy-072.webp" class="rounded" alt="Family chart">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-072.webp" class="rounded" alt="Family chart">

<hr />

Expand All @@ -298,11 +298,11 @@ Click on a family member name to see that persons details.

After login and selecting the proper team, click on the <b>Birthdays</b> button in the top navigation menu.

<img src="img/help/genealogy-001.webp" class="rounded" alt="Menu">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-001.webp" class="rounded" alt="Menu">

This shows the upcomming birthdays.

<img src="img/help/genealogy-080.webp" class="rounded" alt="Birthdays">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-080.webp" class="rounded" alt="Birthdays">

<hr />

Expand All @@ -314,44 +314,44 @@ Users can click a button in the top right-hand menu to open the <b>offcanvas men
On top the users role and permissions in the current team are shown.<br/>
If a user has the proper rights, additional features are presented.

<img src="img/help/genealogy-006b.webp" class="rounded" alt="Offcanvas menu">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-006b.webp" class="rounded" alt="Offcanvas menu">

### a. Teams & people

<img src="img/help/genealogy-090a.webp" class="rounded" alt="Teams">
<img src="img/help/genealogy-090b.webp" class="rounded" alt="People">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-090a.webp" class="rounded" alt="Teams">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-090b.webp" class="rounded" alt="People">

### b. Users & logging

The offcanvas menu allows <b>developers</b> to consult the users and their logging information.

<img src="img/help/genealogy-091a.webp" class="rounded" alt="Users">
<img src="img/help/genealogy-093.webp" class="rounded" alt="User logging 1">
<img src="img/help/genealogy-094.webp" class="rounded" alt="User logging 2">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-091a.webp" class="rounded" alt="Users">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-093.webp" class="rounded" alt="User logging 1">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-094.webp" class="rounded" alt="User logging 2">

### c. Backups

The <b>Backups</b> menu item allows <b>developers</b> to make database backups.

<img src="img/help/genealogy-095.webp" class="rounded" alt="Backups">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-095.webp" class="rounded" alt="Backups">

### d. Log viewer

The <b>Log Viewer</b> menu item allows <b>developers</b> to consult the application log files.

<img src="img/help/genealogy-096a.webp" class="rounded" alt="Log viewer">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-096a.webp" class="rounded" alt="Log viewer">

### e. Dependencies

The <b>Dependencies</b> menu item allows <b>developers</b> to consult the application dependencies.

<img src="img/help/genealogy-097a.webp" class="rounded" alt="Dependencies">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-097a.webp" class="rounded" alt="Dependencies">

### f. Session

The <b>Dependencies</b> menu item allows <b>developers</b> to consult the application session.

<img src="img/help/genealogy-098.webp" class="rounded" alt="Session">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-098.webp" class="rounded" alt="Session">

<hr />

Expand All @@ -364,14 +364,14 @@ The <b>Dependencies</b> menu item allows <b>developers</b> to consult the applic
Visitor can change the language in the top right-hand menu by using the <b>language selector</b>.<br/>
De default application language is English.

<img src="img/help/genealogy-002aa.webp" class="rounded" alt="Language menu">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-002aa.webp" class="rounded" alt="Language menu">

### b. Authenticated users

Authenticated users can change the language in the top right-hand menu by using the <b>profile editor</b>.<br/>
The selected language is saved in the database for further use.

<img src="img/help/genealogy-002dd.webp" class="rounded" alt="Profile editor">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-002dd.webp" class="rounded" alt="Profile editor">

<hr />

Expand All @@ -381,4 +381,4 @@ The selected language is saved in the database for further use.

Visitors and authenticated users can change the color theme in the top right-hand menu by using the <b>theme selctor</b>.<br/>

<img src="img/help/genealogy-002aa.webp" class="rounded" alt="Theme selector">
<img src="https://genealogy.kreaweb.be/img/help/genealogy-002aa.webp" class="rounded" alt="Theme selector">

0 comments on commit 09104d8

Please sign in to comment.