Skip to content

Commit 26071fb

Browse files
Add short explanation of track categories
1 parent 4a70430 commit 26071fb

File tree

6 files changed

+41
-5
lines changed

6 files changed

+41
-5
lines changed

docs/categories.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: page
3+
title: Categories
4+
nav_order: 4
5+
---
6+
7+
# Categories
8+
9+
{: .no_toc }
10+
11+
<details open markdown="block">
12+
<summary>
13+
Table of contents
14+
</summary>
15+
{: .text-delta }
16+
1. TOC
17+
{:toc}
18+
</details>
19+
20+
J!TrackGallery offers the possibility to organise tracks in _Categeries_, which are fully configurable. After installation, the suggesties categories are different activities, such as biking, hiking and driving, but you can completely customise the categories to suit your needs, for using different regions or other track atributes. Each category has an icon attached which is used on the overview map.
21+
22+
If you only need one category, you can switch off the use of categories in the configuration menu. Internally, the tracks are still categorised, but this not explicitly shown in the frontend to reduce complexity for the user. Track icons on the overview map are stil determined by the categories. All new tracks will be assigned to the default category.
23+
24+
25+
## Category view
26+
27+
A view showing a map and/or list of tracks in a specific category
28+
- Overview map
29+
- Track search/filter box
30+
- Track list
31+
Each element can be switched on or off in the configuration menu.
32+
The selection of columns shown in the track table is similar to that in the main 'Track list' overview page; it can also be configured in the configuration menu.

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: Configuration
4-
nav_order: 4
4+
nav_order: 5
55
---
66

77
# Configuration settings

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ The main functionality part or base package is a Joomla! *component* (`com_jtg.z
3434
The J!TrackGallery provides several _views_ which present the tracks in different formats. Most views can also be assigned to menu items in the menu(s) of your pages. The following views are provided:
3535
- [Overview map](overview): this is the main entry point showing an overview of all tracks that are available on your web site
3636
- [Track view](frontend): the main view with a map, graph, and details for a specific track - several aspects of this view can be configured to suit your needs. A button to edit the track information appears when authorised users are logged in to the site.
37-
- _Category list_: a list of all categories
38-
- _Category overview_: a map and/or list of tracks for a specific category
37+
- _Category list_: a list of all [categories](categories)
38+
- [Category overview](categories#Category view): a map and/or list of tracks for a specific category
3939
- _Track list_: a (sortable) list of all tracks with basic information about each track
4040
- _User view_: a view for users that are logged in, showing a list of tracks owned, and recent comments (if enabled on the site), as well as summary statistics
4141

docs/languages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Language support
3-
nav_order: 6
3+
nav_order: 7
44
---
55
## Language support
66

docs/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,7 @@ By default, the range of the map that is shown is automatically adjusted to show
2929
- *Center on user location* uses geolocation from the user's browser to center the map on the user's current location. This also uses the specified zoom level. If no geolocation information can be obtained, the defaults are used.
3030

3131
There is also a configuration option to specify whether the welcome text should be shown or not.
32+
33+
## Icon location
34+
35+
Each track is shown on the map using the icon that is assigned to the [categorie](categories) that the track is part of. By default, the icon is placed at the start of the track, but there is a configuration option to use the end or the middle of the track. This can be useful if you have multiple tracks that start in the same location.

docs/plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Map plugin
3-
nav_order: 5
3+
nav_order: 6
44
---
55
### J!TrackGallery maps plugin
66

0 commit comments

Comments
 (0)