Skip to content

Commit 21e5442

Browse files
committed
Standardize formatting for bullet lists and add metadata documentation in Main View guide.
1 parent 1224d00 commit 21e5442

2 files changed

Lines changed: 87 additions & 73 deletions

File tree

docs/img/metadata-dialog.png

101 KB
Loading

docs/usage/main-view.md

Lines changed: 87 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,23 @@ The main view is the central interface of Reitti where you can visualize and int
1313

1414
Located in the top navigation bar, the main menu provides access to all major sections of Reitti:
1515

16-
- **Timeline** The main view showing your location data on a map (this page)
17-
- **Memories** Create and manage location-based memories (see [Memories](../memories/index.md))
18-
- **Workbench** Merge different timelines from multiple devices. Edit single or multiple location points. (see [Workbench](workbench.md)
19-
- **Statistics** View detailed analytics of your movement patterns
20-
- **Settings** Configure application preferences and integrations
21-
- **Enter Live-Mode** - Switch to real-time location tracking
22-
- **Enter Fullscreen** Expand the interface to fullscreen view
23-
- **Logout** Sign out of your Reitti account
16+
- **Timeline**: The main view showing your location data on a map (this page)
17+
- **Memories**: Create and manage location-based memories (see [Memories](../memories/index.md))
18+
- **Workbench**: Merge different timelines from multiple devices. Edit single or multiple location points. (see [Workbench](workbench.md)
19+
- **Statistics**: View detailed analytics of your movement patterns
20+
- **Settings**: Configure application preferences and integrations
21+
- **Enter Live-Mode**: Switch to real-time location tracking
22+
- **Enter Fullscreen**: Expand the interface to fullscreen view
23+
- **Logout**: Sign out of your Reitti account
2424

2525
## Timeline Component
2626

2727
The timeline component is located on the left side of the interface and displays your location history chronologically:
2828

2929
### User Switcher
30-
If you have access to other users' data (via [Share Access](share-access.md) or [Reitti Integration](../integrations/reitti.md)) or more than one device configure (via [Devices](../configurations/devices.md)), a user switcher appears at the top of the timeline. This allows you to:
30+
If you have access to other users' data (via [Share Access](share-access.md) or [Reitti Integration](../integrations/reitti.md)) or more than one device configure (via [Devices](../configurations/devices.md)), a user switcher appears at the top of the timeline. This allows
31+
you to:
32+
3133
- Switch between different users' timelines
3234
- View location data for multiple users
3335
- Compare movement patterns across users
@@ -36,34 +38,47 @@ If you have access to other users' data (via [Share Access](share-access.md) or
3638

3739
### Chronological List
3840
Below the user switcher, the timeline shows a chronological list of all visits and trips during the selected time range:
39-
- **Visits** Periods where you stayed at a specific location
40-
- **Trips** Movement between locations with transportation mode information
41+
- **Visits**: Periods where you stayed at a specific location
42+
- **Trips**: Movement between locations with transportation mode information
4143

4244
### Interactive Features
43-
- **Click to Zoom** - Clicking on a timeline entry zooms the map to that element
44-
- For trips: Highlights the route on the map
45-
- For visits: Centers the map on the location
46-
- **Click Again to Restore** – Clicking the same entry again restores the previous map view
47-
- **Edit Visits** – When a visit is selected, hover over it to reveal an edit icon (pencil) that takes you to [Edit Place](place-edit.md)
48-
- **Edit Trips** – When a trip is selected, hover over it and click the edit icon to change the transportation mode
49-
45+
- **Click to Zoom**: Clicking on a timeline entry zooms the map to that element
46+
- For trips: Highlights the route on the map
47+
- For visits: Centers the map on the location
48+
- **Click Again to Restore**: Clicking the same entry again restores the previous map view
49+
- **Edit Visits**: When a visit is selected, hover over it to reveal an edit icon (pencil) that takes you to [Edit Place](place-edit.md)
50+
- **Edit Trips**: When a trip is selected, hover over it and click the edit icon to change the transportation mode
51+
52+
### Metadata
53+
You can enrich your visits and trips with metadata such as mood, tags, and notes. When a visit or trip is selected, hover over it to reveal a metadata icon (e.g., a smiley or note icon). Clicking the icon opens a dialog where you can:
54+
55+
- **Mood**: Select a mood from the following options:
56+
- 😊 Happy
57+
- 😌 Relaxed
58+
- 🧗 Adventurous
59+
- 😴 Tired
60+
- 😰 Stressed
61+
- **Tags**: Add custom tags (e.g., "work", "commute", "weekend") to categorize the element.
62+
- **Notes**: Attach free-form text notes for personal context.
63+
64+
![Metadata Dialog](../img/metadata-dialog.png)
5065

5166
## Date Picker
5267

5368
The date picker is a horizontal interface that allows flexible navigation through your location history. It displays dates as interactive elements with multiple modes and selection options:
5469

5570
### Date Selection
56-
- **Single Date Selection** Click on a date to select it, loading data and updating the timeline
57-
- **Range Selection Mode** Click a selected date again to enter range selection mode, then click another date to select a range
58-
- **Range Modification** In range selection mode, click any other date to change the range boundaries
59-
- **Range Clearing** In range selection mode, click the start or end date to clear the selection and exit range mode
71+
- **Single Date Selection**: Click on a date to select it, loading data and updating the timeline
72+
- **Range Selection Mode**: Click a selected date again to enter range selection mode, then click another date to select a range
73+
- **Range Modification**: In range selection mode, click any other date to change the range boundaries
74+
- **Range Clearing**: In range selection mode, click the start or end date to clear the selection and exit range mode
6075

6176
### Navigation Methods
62-
- **Horizontal Scrolling** Drag the date slider left/right or use horizontal scroll to navigate through time
63-
- **Mode Switching** Scroll up/down to switch between different time granularity modes:
64-
- **Day Mode** View individual days
65-
- **Month Mode** View months
66-
- **Year Mode** View years
77+
- **Horizontal Scrolling**: Drag the date slider left/right or use horizontal scroll to navigate through time
78+
- **Mode Switching**: Scroll up/down to switch between different time granularity modes:
79+
- **Day Mode**: View individual days
80+
- **Month Mode**: View months
81+
- **Year Mode**: View years
6782

6883
### Drill-Down Navigation
6984
When drilling into time periods:
@@ -72,44 +87,43 @@ When drilling into time periods:
7287
- The date picker positions the selected period under the mouse cursor for intuitive navigation
7388

7489
### Advanced Range Selection
75-
- **Year Ranges** – Select a year, click it again, then select another year to create a range from January 1 of the first year to December 31 of the second year
76-
- **Month Ranges** – Similarly, select months to create ranges spanning from the first day of the first month to the last day of the second month
77-
- **Arbitrary Ranges** – Combine different modes to create custom date ranges spanning days, months, or years
78-
90+
- **Year Ranges**: Select a year, click it again, then select another year to create a range from January 1 of the first year to December 31 of the second year
91+
- **Month Ranges**: Similarly, select months to create ranges spanning from the first day of the first month to the last day of the second month
92+
- **Arbitrary Ranges**: Combine different modes to create custom date ranges spanning days, months, or years
7993

8094
## View Control
8195

8296
The View Control component sits above the date picker and provides tools for controlling how your location data is visualized:
8397

8498
### Replay Controls
85-
- **Start Replay** Begins a replay of all your movements during the selected time range, animating your path on the map
86-
- **Speed Control** Adjusts the playback speed of the replay (slow, normal, fast, automatic, adaptive)
87-
- **Time Control Slider** When opened, displays a slider above the View Control that allows you to scrub through the replay time to show specific ranges of interest
99+
- **Start Replay**: Begins a replay of all your movements during the selected time range, animating your path on the map
100+
- **Speed Control**: Adjusts the playback speed of the replay (slow, normal, fast, automatic, adaptive)
101+
- **Time Control Slider**: When opened, displays a slider above the View Control that allows you to scrub through the replay time to show specific ranges of interest
88102

89103
### Today Button
90104

91-
- **Today** Jumps to the current date and time, if not currently selected
105+
- **Today**: Jumps to the current date and time, if not currently selected
92106

93107
### Map View Settings
94108
The map view control allows you to customize the map display with various settings:
95-
- **3D View** - Enable/disable the 3D perspective view of the map
96-
- **Render Buildings** - Toggle building rendering for more detailed urban environments
97-
- **Globe Projection** Switch between flat map and globe projection views
98-
- **Terrain Layer** - Enable/disable terrain elevation visualization
99-
- **Satellite View** - Toggle between map and satellite imagery
100-
- **North Alignment** Align the map with true north (disables automatic rotation)
109+
- **3D View**: Enable/disable the 3D perspective view of the map
110+
- **Render Buildings**: Toggle building rendering for more detailed urban environments
111+
- **Globe Projection**: Switch between flat map and globe projection views
112+
- **Terrain Layer**: Enable/disable terrain elevation visualization
113+
- **Satellite View**: Toggle between map and satellite imagery
114+
- **North Alignment**: Align the map with true north (disables automatic rotation)
101115

102116
### Settings Menu
103-
- **Open Settings** Access the main view settings menu for additional customization options
117+
- **Open Settings**: Access the main view settings menu for additional customization options
104118

105119
## Settings
106120

107121
The Settings menu provides comprehensive control over how your location data is displayed and analyzed:
108122

109123
### Path Display Modes
110-
- **Standard** Displays optimized paths that balance detail with performance by not overwhelming the browser with all points in the time range
111-
- **Raw Path** Displays all location data points without any optimizations, showing the complete raw data
112-
- **Edge Bundling** Bundles paths based on proximity, making it easy to visualize your most frequently used routes within the selected time range
124+
- **Standard**: Displays optimized paths that balance detail with performance by not overwhelming the browser with all points in the time range
125+
- **Raw Path**: Displays all location data points without any optimizations, showing the complete raw data
126+
- **Edge Bundling**: Bundles paths based on proximity, making it easy to visualize your most frequently used routes within the selected time range
113127

114128
### 24-Hour Aggregate Mode
115129
When enabled, this feature aligns all times to the day, allowing you to:
@@ -118,50 +132,50 @@ When enabled, this feature aligns all times to the day, allowing you to:
118132
- When combined with the replay feature, all days in the selected time range are played simultaneously, showing aggregated daily patterns
119133

120134
### Interface Controls
121-
- **Hide Timeline** Toggle visibility of the timeline component on the left side
122-
- **Hide Date Picker** Toggle visibility of the date picker component
135+
- **Hide Timeline**: Toggle visibility of the timeline component on the left side
136+
- **Hide Date Picker**: Toggle visibility of the date picker component
123137

124138
## Live Mode
125139

126140
Live mode provides real-time tracking functionality with a kiosk-style display:
127141

128142
### Real-time Tracking
129-
- **Automatic Updates** The display automatically updates as soon as new location data arrives
130-
- **Latest Locations** Shows the most recent known location of you and all connected users
131-
- **User Avatars** Each user is represented by their avatar on the map
132-
- **Hover Information** Hover over an avatar to display additional information including when the data was last updated
143+
- **Automatic Updates**: The display automatically updates as soon as new location data arrives
144+
- **Latest Locations**: Shows the most recent known location of you and all connected users
145+
- **User Avatars**: Each user is represented by their avatar on the map
146+
- **Hover Information**: Hover over an avatar to display additional information including when the data was last updated
133147

134148
### Multi-User Display
135-
- **Connected Users** View all users you have access to via [Share Access](share-access.md) or [Reitti Integration](../integrations/reitti.md)
136-
- **Real-time Movement** Watch as user locations update in real-time as they move
149+
- **Connected Users**: View all users you have access to via [Share Access](share-access.md) or [Reitti Integration](../integrations/reitti.md)
150+
- **Real-time Movement**: Watch as user locations update in real-time as they move
137151

138152
### Kiosk Mode
139-
- **Continuous Display** Ideal for wall-mounted displays or shared screens
140-
- **Minimal Interface** Clean, focused display optimized for at-a-glance viewing
141-
- **Automatic Refresh** No user interaction required to see updated locations
153+
- **Continuous Display**: Ideal for wall-mounted displays or shared screens
154+
- **Minimal Interface**: Clean, focused display optimized for at-a-glance viewing
155+
- **Automatic Refresh**: No user interaction required to see updated locations
142156

143157
## Navigation Tips
144158

145-
- **Zoom Controls** Use mouse wheel, +/- buttons, or double-click to zoom
146-
- **Pan Navigation** Click and drag to move around the map
147-
- **Search Locations** Use the search bar to find specific places
148-
- **Fullscreen Mode** Expand the map to fullscreen for better visibility
149-
- **Quick Date Navigation** Use the date picker's horizontal scroll and mode switching for efficient time travel
150-
- **Interactive Timeline** Click timeline entries to zoom to specific locations or trips
151-
- **Multi-User Switching** Use the user switcher in the timeline to view different users' data
159+
- **Zoom Controls**: Use mouse wheel, +/- buttons, or double-click to zoom
160+
- **Pan Navigation**: Click and drag to move around the map
161+
- **Search Locations**: Use the search bar to find specific places
162+
- **Fullscreen Mode**: Expand the map to fullscreen for better visibility
163+
- **Quick Date Navigation**: Use the date picker's horizontal scroll and mode switching for efficient time travel
164+
- **Interactive Timeline**: Click timeline entries to zoom to specific locations or trips
165+
- **Multi-User Switching**: Use the user switcher in the timeline to view different users' data
152166

153167
## Getting the Most from the Main View
154168

155-
1. **Analyze Daily Patterns** Use **24-Hour Aggregate Mode** to identify your regular routines and commute patterns
156-
2. **Explore Movement History** Switch between **Standard**, **Raw Path**, and **Edge Bundling** modes to analyze your movement data at different levels of detail
157-
3. **Customize Your View** Adjust map settings like **3D View**, **Terrain Layer**, and **Satellite View** to match your analysis needs
158-
4. **Use Live Mode for Real-time Tracking** Enable live tracking for current movement monitoring or set up a **Kiosk Mode** display for shared viewing
159-
5. **Leverage Replay Features** Use the **Replay Controls** with different speeds to review your movements over selected time ranges
160-
6. **Compare Multi-User Data** If you have access to other users' data, use the **User Switcher** to compare movement patterns and coordinate activities
169+
1. **Analyze Daily Patterns**: Use **24-Hour Aggregate Mode** to identify your regular routines and commute patterns
170+
2. **Explore Movement History**: Switch between **Standard**, **Raw Path**, and **Edge Bundling** modes to analyze your movement data at different levels of detail
171+
3. **Customize Your View**: Adjust map settings like **3D View**, **Terrain Layer**, and **Satellite View** to match your analysis needs
172+
4. **Use Live Mode for Real-time Tracking**: Enable live tracking for current movement monitoring or set up a **Kiosk Mode** display for shared viewing
173+
5. **Leverage Replay Features**: Use the **Replay Controls** with different speeds to review your movements over selected time ranges
174+
6. **Compare Multi-User Data**: If you have access to other users' data, use the **User Switcher** to compare movement patterns and coordinate activities
161175

162176
## View Mode Use Cases
163177

164-
- **Route Planning** Use **Edge Bundling** mode to identify your most frequently traveled routes
165-
- **Pattern Recognition** Enable **24-Hour Aggregate Mode** to discover daily routines and habitual locations
166-
- **Presentation Mode** Use **Fullscreen** with a simplified interface for sharing your location history with others
167-
- **Real-time Monitoring** - **Live Mode** is ideal for tracking current movements or monitoring multiple users simultaneously
178+
- **Route Planning**: Use **Edge Bundling** mode to identify your most frequently traveled routes
179+
- **Pattern Recognition**: Enable **24-Hour Aggregate Mode** to discover daily routines and habitual locations
180+
- **Presentation Mode**: Use **Fullscreen** with a simplified interface for sharing your location history with others
181+
- **Real-time Monitoring**: **Live Mode** is ideal for tracking current movements or monitoring multiple users simultaneously

0 commit comments

Comments
 (0)