diff options
Diffstat (limited to 'viewer')
-rw-r--r-- | viewer/ldgallery-viewer.7.md | 50 |
1 files changed, 44 insertions, 6 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 41f5003..9ac1512 100644 --- a/viewer/ldgallery-viewer.7.md +++ b/viewer/ldgallery-viewer.7.md | |||
@@ -2,7 +2,7 @@ | |||
2 | pagetitle: Viewer user manual - ldgallery | 2 | pagetitle: Viewer user manual - ldgallery |
3 | title: LDGALLERY-VIEWER(7) ldgallery | 3 | title: LDGALLERY-VIEWER(7) ldgallery |
4 | author: Pacien TRAN-GIRARD, Guillaume FOUET | 4 | author: Pacien TRAN-GIRARD, Guillaume FOUET |
5 | date: 2020-04-30 (v1.0) | 5 | date: 2020-09-19 (v2.0) |
6 | --- | 6 | --- |
7 | 7 | ||
8 | 8 | ||
@@ -24,12 +24,23 @@ Its responsiveness allows it to be used from either a desktop browser or some mo | |||
24 | The viewer's user interface is split into a main item view and a side search panel, which can be opened by using the appropriate button in the toolbar at the top-left corner. | 24 | The viewer's user interface is split into a main item view and a side search panel, which can be opened by using the appropriate button in the toolbar at the top-left corner. |
25 | 25 | ||
26 | The main view displays the gallery's directories and items as a thumbnail grid. | 26 | The main view displays the gallery's directories and items as a thumbnail grid. |
27 | The order in which items are displayed can be chosen from the sort menu at the top-left corner. | ||
27 | 28 | ||
28 | The side panel allows the user to interactively enter filtering queries to search through the gallery's content. | 29 | The side panel allows the user to interactively enter filtering queries to search through the gallery's content. |
29 | This panel features a list of relevant tags, grouped by categories, that can be used to build the search query. | 30 | This panel features a list of relevant tags, grouped by categories, that can be used to build the search query. |
30 | 31 | ||
31 | Picture items can be opened and visualised within the application. | 32 | The information panel at the bottom of the sidebar displays various metadata about the currently viewed item. |
32 | Other types of elements are either downloaded or displayed in the same window depending on the user's web browser supported media types. | 33 | Those include the title, date and description of the file or directory. |
34 | |||
35 | Items of the following formats can be opened and visualised within the web application: | ||
36 | |||
37 | * Pictures (Bitmap, JPEG, PNG, TIFF, HDR, GIF) | ||
38 | * Videos (OGV, WebM, Matroska, MPEG-4) | ||
39 | * Audio files (WAV, Opus, FLAC, MP3, MPEG-4) | ||
40 | * Plain text files (`.txt`) | ||
41 | * PDFs | ||
42 | |||
43 | Formats which are not listed above or which are not supported by the user's web browser are offered for download instead of being directly displayed in the same window. | ||
33 | 44 | ||
34 | 45 | ||
35 | # SEARCH QUERIES | 46 | # SEARCH QUERIES |
@@ -46,17 +57,44 @@ The following modifiers can be used in queries as prefixes of tags: | |||
46 | `-` | 57 | `-` |
47 | : Exclude all items having the associated tag, independently of simple tag restrictions and inclusions. | 58 | : Exclude all items having the associated tag, independently of simple tag restrictions and inclusions. |
48 | 59 | ||
49 | Autocompletion suggestions are shown as filters are being typed in the query field. | 60 | Auto-completion suggestions are shown as filters are being typed in the query field. |
50 | In the case of disambiguated tags, both the category and the tag components are allowed to be partially entered, allowing "loc:fra" to expand into "location:france" for example. | 61 | In the case of disambiguated tags, both the category and the tag components are allowed to be partially entered, allowing "loc:fra" to expand into "location:france" for example. |
51 | 62 | ||
52 | 63 | ||
53 | # VIEWER CONFIGURATION | 64 | # VIEWER CONFIGURATION |
54 | 65 | ||
55 | The viewer itself can be configured through a JSON file named "config.json" and placed in the web viewer's directory. | 66 | The viewer itself can be configured through a JSON file named __config.json__ and placed in the web viewer's directory. |
67 | |||
68 | Viewer configuration options are: | ||
56 | 69 | ||
57 | galleryRoot | 70 | galleryRoot |
58 | : Absolute or relative path to the root of the gallery to display. | 71 | : Absolute or relative path to the root of the gallery to display. |
59 | 72 | ||
73 | galleryIndex | ||
74 | : Optional index file to use under the value specified for "galleryRoot". | ||
75 | Defaults to "index.json". | ||
76 | |||
77 | initialItemSort | ||
78 | : Order in which gallery items are originally to be displayed. | ||
79 | Possible values are "title_asc", "date_asc", "date_desc". | ||
80 | Defaults to "title_asc". | ||
81 | Titles are sorted using a human-friendly _natural sort order_ which treats multi-digit numbers atomically. | ||
82 | |||
83 | <!-- https://github.com/pacien/ldgallery/issues/27 | ||
84 | initialSearchQuery | ||
85 | : Optional initial search query to set when opening the gallery. | ||
86 | --> | ||
87 | |||
88 | initialTagDisplayLimit | ||
89 | : Limit on the number of tags to suggest in each tag category. | ||
90 | Causes only the specified amount of most used tags to be displayed until the user expands the list. | ||
91 | Set to -1 to disable the limit on suggestions. | ||
92 | Defaults to 10. | ||
93 | |||
94 | An alternative viewer configuration file located in the viewer's directory can be loaded by specifying its name, | ||
95 | without the ".json" extension, as a query parameter given before the page anchor; | ||
96 | for example, some alternative configuration named "config_2.json" can be loaded with "http://gallery/?config_2#". | ||
97 | |||
60 | 98 | ||
61 | # PROGRESSIVE WEB APPLICATION | 99 | # PROGRESSIVE WEB APPLICATION |
62 | 100 | ||
@@ -68,7 +106,7 @@ An example of such manifest and an associated icon are available in the example | |||
68 | 106 | ||
69 | # SEE ALSO | 107 | # SEE ALSO |
70 | 108 | ||
71 | Related manual pages: __ldgallery__(1), __ldgallery-quickstart__(7) | 109 | Related manual pages: __ldgallery__(1), __ldgallery-quickstart__(7). |
72 | 110 | ||
73 | The ldgallery source code is available on <https://ldgallery.pacien.org>. | 111 | The ldgallery source code is available on <https://ldgallery.pacien.org>. |
74 | 112 | ||