mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-05 04:04:07 +00:00
docs(wiki): name Tours, the AI Assistant, Trip settings and the notifications inbox on Home, and describe the planner's top bar and its Tours and Journal tabs
This commit is contained in:
@@ -38,6 +38,10 @@ Emoji are drawn with Twemoji, so they look the same on every platform.
|
||||
|
||||
Hover a message to bring up its buttons. **Reply** (the arrow) quotes that message: a preview with a bar in the accent colour appears above the field, with an **×** to cancel. Once sent, the quoted text sits inside your bubble above your answer.
|
||||
|
||||
## Answers from the assistant
|
||||
|
||||
With the AI assistant on, a member can share one of its answers into the trip chat with **Share in the trip chat**. Everyone on the trip then sees the message marked **from the assistant**; hovering the badge reads *(name) shared this answer from the assistant*. The badge is set by the server, so nobody can fake it by typing into a normal message.
|
||||
|
||||
## URL link previews
|
||||
|
||||
When a message contains a web address, TREK fetches an Open Graph preview (site, title, description and image) and shows it under the text. Only the first address in a message gets a preview.
|
||||
|
||||
@@ -8,7 +8,7 @@ Invite new users to register on your TREK instance, even when open registration
|
||||
|
||||
An invite link lets a person register a new TREK account without requiring the site to have open registration enabled. Visiting `/register?invite=<token>` pre-validates the token and switches the page to the Register form. The token's use count is incremented on successful registration, and the link stops working once the use limit is reached.
|
||||
|
||||
> Invite links here are for **registering new accounts**. To let people who *already* have an account join a specific trip, use the trip invite link in the trip's Share panel — see [Trip-Members-and-Sharing](Trip-Members-and-Sharing).
|
||||
> Invite links here are for **registering new accounts**. To let people who *already* have an account join a specific trip, use the trip invite link in the **Sharing** area of the trip's **Trip settings** — see [Trip-Members-and-Sharing](Trip-Members-and-Sharing).
|
||||
|
||||
## Creating invite links
|
||||
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
Share a read-only view of your trip with people who do not have a TREK account. The viewer opens in a browser without logging in.
|
||||
|
||||

|
||||

|
||||
|
||||
## Creating a share link
|
||||
|
||||
Open your trip and click the **Share** button (Users icon) in the top navbar. This opens the **Share Trip** dialog. The **Public Link** card appears in its right column and is visible only to users with the `share_manage` permission (trip owner and admins by default).
|
||||
Open your trip and click the **Trip settings** pill beside the trip's title in the top navbar, then pick the **Sharing** area (on a phone: **More**, then **Trip settings**). The **Public Link** section, with the **Trip invite link** stacked under it, is visible only to users with the `share_manage` permission (trip owner and admins by default).
|
||||
|
||||
Click **Create link** to generate a token.
|
||||
|
||||
@@ -22,7 +22,7 @@ Copy this URL and send it to anyone you want to share the trip with. No TREK acc
|
||||
|
||||
A share link is valid for **90 days**, counted from the last time it was saved. Creating the link writes a 90-day expiry, and flipping one of the unlocked permission toggles re-saves the link and writes a new one, so a link you actively manage never lapses under you.
|
||||
|
||||
Once the 90 days are up, visitors get **Link expired or invalid**. Only an unknown, expired or deleted link shows that screen. When the page cannot be loaded for another reason (the server restarting, a proxy error, a viewer who is briefly offline), the visitor sees **This trip could not be loaded** with the hint that this does not mean the link has expired, and **Try again** reloads it in place. The **Public Link** card in the Share dialog does not show this: it keeps displaying the URL and the **Delete link** button, because the owner-side lookup ignores the expiry. There is no expired badge to warn you.
|
||||
Once the 90 days are up, visitors get **Link expired or invalid**. Only an unknown, expired or deleted link shows that screen. When the page cannot be loaded for another reason (the server restarting, a proxy error, a viewer who is briefly offline), the visitor sees **This trip could not be loaded** with the hint that this does not mean the link has expired, and **Try again** reloads it in place. The **Public Link** section in the Trip settings does not show this: it keeps displaying the URL and the **Delete link** button, because the owner-side lookup ignores the expiry. There is no expired badge to warn you.
|
||||
|
||||
To revive a lapsed link, flip one of the unlocked toggles — **Bookings**, **Packing**, **Costs** or **Chat** — and flip it back if you did not mean to change anything. **Map & Plan** is locked, so clicking it sends no request and will not revive the link. Flipping an unlocked toggle re-saves the **same** token for another 90 days and the old URL starts working again. If you want a genuinely different URL, because the old one leaked for instance, use **Delete link** and then **Create link**.
|
||||
|
||||
@@ -73,7 +73,7 @@ The Packing tab shows how much is packed and one card per category. The Costs ta
|
||||
|
||||
## Revoking a share link
|
||||
|
||||
Open the Share button in the navbar, then click **Delete link** in the share link section. The existing URL stops working immediately for anyone who has it.
|
||||
Open **Trip settings**, go to **Sharing** and click **Delete link** (on a phone: **More**, then **Trip settings**). The existing URL stops working immediately for anyone who has it.
|
||||
|
||||
## Journey public share
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ The Collab addon (`collab`) must be enabled by an admin before the panel is visi
|
||||
|
||||
| Sub-feature | What it provides |
|
||||
|-------------|-----------------|
|
||||
| **Chat** | Group chat with reactions, replies, images, and URL previews |
|
||||
| **Chat** | Group chat with reactions, replies, images, and URL previews. With the AI assistant on, an answer can be shared into the chat, marked **from the assistant** |
|
||||
| **Notes** | Categorized, pinnable, markdown-formatted shared notes |
|
||||
| **Links** | Shared web addresses with a title, editable and pinnable, synced live between members |
|
||||
| **Polls** | Single- or multiple-choice votes with optional deadlines |
|
||||
@@ -40,7 +40,7 @@ The Collab addon (`collab`) must be enabled by an admin before the panel is visi
|
||||
|
||||
> **Admin:** enable the Collab addon and individual sub-features in [Admin-Addons](Admin-Addons). Links is on by default, like the other four.
|
||||
|
||||
On a **desktop** (1024 px and wider) each sub-feature is a card with a head band that carries its name, its count and its actions. Chat is a fixed 380 px column on the left when other sub-features are also enabled; if only Chat is on, it fills the full width. Notes, Links, Polls and What's Next share the space on the right; with three or more of them, Notes and Links form the upper row and Polls and What's Next the lower one. On a narrower window a tab bar at the top switches between the enabled sub-features one at a time, and the phone app has its own Collab tab. Disabled sub-features are hidden.
|
||||
On a **desktop** (1024 px and wider) each sub-feature is a card with a head band that carries its name, its count and its actions. Chat is a fixed 380 px column on the left when other sub-features are also enabled; if only Chat is on, it fills the full width. Notes, Links, Polls and What's Next share the space on the right; with three or more of them, Notes and Links form the upper row and Polls and What's Next the lower one. On a narrower window a tab bar at the top switches between the enabled sub-features one at a time, and the phone app has its own Collab tab with Chat, Notes, Links and Polls (What's Next is not shown on the phone). Disabled sub-features are hidden.
|
||||
|
||||
### Links
|
||||
|
||||
|
||||
@@ -1,17 +1,25 @@
|
||||
# Trip Members and Sharing
|
||||
|
||||

|
||||

|
||||
|
||||
## Opening the Members Panel
|
||||
## Opening the Trip settings
|
||||
|
||||
- From the **trip planner**: click the Share button in the top navigation bar.
|
||||
- On **mobile**: open the trip, then **More** → **Share Trip**.
|
||||
- From the **trip planner**: click the **Trip settings** pill beside the trip's title in the top navigation bar.
|
||||
- On **mobile**: open the trip, then **More** and the **Trip settings** row.
|
||||
|
||||
The dialog carries the trip's name in its head band, with the number of people on the trip and, once there are any, of its guests. When you have the `share_manage` permission it opens in two columns (members and guests on the left, the two links on the right). Without that permission only the members column is shown. On a narrow window the columns stack.
|
||||
The dialog is headed **Trip settings**, with the trip's name under it and pills for the number of people on the trip and, once there are any, of its guests. A side navigation splits it into areas:
|
||||
|
||||
## Members List
|
||||
| Area | What it holds | Who sees it |
|
||||
|---|---|---|
|
||||
| **People** | Inviting users, the access list and the guests | Everyone on the trip |
|
||||
| **Sharing** | The **Public Link** and the **Trip invite link** | Users with the `share_manage` permission |
|
||||
| **Journal** | The journal linked to this trip | When the Journey addon is on and you may link a journal, or the trip already has one |
|
||||
|
||||
The left column lists everyone who has access to the trip.
|
||||
When only one area applies to you, the side navigation is hidden. On a narrow window the areas become pills above the content.
|
||||
|
||||
## People
|
||||
|
||||
The **Access** section lists everyone who has access to the trip, with a count.
|
||||
|
||||
- The **trip owner** is marked with an **Owner** badge and a crown.
|
||||
- Your own entry carries a **you** badge (on the phone it reads **(you)**).
|
||||
@@ -19,7 +27,7 @@ The left column lists everyone who has access to the trip.
|
||||
|
||||
### Inviting Members
|
||||
|
||||
If you have the `member_manage` permission (default: trip owner), an invite control appears above the list. Select a user from the searchable dropdown and click **Invite**. The user is looked up by username or email on the server, added immediately, and the list refreshes. The invited user also receives an in-app notification.
|
||||
If you have the `member_manage` permission (default: trip owner), an **Invite User** control appears above the list. Select a user from the searchable dropdown and click **Invite**. The user is looked up by username or email on the server, added immediately, and the list refreshes. The invited user also receives an in-app notification.
|
||||
|
||||
### Removing a Member
|
||||
|
||||
@@ -86,7 +94,7 @@ There is no limit on the number of guests per trip.
|
||||
|
||||
## Public Share Link
|
||||
|
||||
The right column is only visible to users with the `share_manage` permission (default: trip owner).
|
||||
The **Sharing** area is only visible to users with the `share_manage` permission (default: trip owner). Its first section is **Public Link**.
|
||||
|
||||
A share link creates a **read-only, token-based URL**:
|
||||
|
||||
@@ -122,7 +130,7 @@ Click **Delete link** (red button below the URL) to revoke access. The token is
|
||||
|
||||
## Trip Invite Link
|
||||
|
||||
Below the public share link, users with the `share_manage` permission can also create a **trip invite link** — a single rotating link that lets people **join the trip as members**:
|
||||
Below the public link, in the same **Sharing** area, users with the `share_manage` permission can also create a **trip invite link** — a single rotating link that lets people **join the trip as members**:
|
||||
|
||||
```
|
||||
<your-instance>/join/<token>
|
||||
@@ -133,7 +141,7 @@ Unlike the read-only share link, this one is **not anonymous**:
|
||||
- Whoever opens it must have a TREK account and be **signed in**. If they are not, they are sent to the login page and returned to the invite afterwards — there is **no registration** from this link.
|
||||
- Opening it while signed in shows a confirmation card naming the trip. Clicking **Join trip** adds you as a **member** (the same access a manually-added member gets) and opens the trip. The owner and existing members see the same card and are simply taken to the trip when they accept.
|
||||
- To invite people who do **not** yet have an account, use an admin invite link with an optional trip binding instead — see [Invite-Links](Invite-Links).
|
||||
- Someone another member **removed** from the trip cannot rejoin through the invite link, old or regenerated; they see that they were removed. Adding them again by name in the Share dialog lets them back in. Someone who **left** the trip on their own can still rejoin through the link.
|
||||
- Someone another member **removed** from the trip cannot rejoin through the invite link, old or regenerated; they see that they were removed. Adding them again by name in the Trip settings lets them back in. Someone who **left** the trip on their own can still rejoin through the link.
|
||||
|
||||
### Creating and revoking
|
||||
|
||||
@@ -143,6 +151,17 @@ Unlike the read-only share link, this one is **not anonymous**:
|
||||
|
||||
> **Admin:** To invite users who do not yet have an account, create invite links in the admin panel. See [Invite-Links](Invite-Links).
|
||||
|
||||
## Journal
|
||||
|
||||
With the Journey addon on, the **Journal** area links one of your journals to the trip. Whoever you let in opens it right inside the trip, in its Journal tab, live.
|
||||
|
||||
- **Link a journal** shows your journals; pick one and click **Link journal**. Only the journal's owner can link it, and on the trip side the **Link a journal** permission (`journal_link`) decides who may.
|
||||
- Under **Access for trip members** you choose, per person, **Read**, **Edit** or **No access**, or set everyone at once with **Everyone can read** or **Nobody**. People who get access to the journal for the first time are flagged before you save.
|
||||
- Once linked, the card shows a **Linked** badge and your role (**Your journal**, **You can edit** or **You can read**). **Change journal** swaps it, **Edit access** reopens the access list, and **Unlink** removes the Journal tab from the trip. People you added in the journal itself keep their access when you unlink.
|
||||
- Linking needs a connection.
|
||||
|
||||
See [Journey-Journal](Journey-Journal) for the journal itself.
|
||||
|
||||
## Related Pages
|
||||
|
||||
- [Public-Share-Links](Public-Share-Links)
|
||||
|
||||
Reference in New Issue
Block a user