diff options
author | pacien | 2020-04-17 20:21:47 +0200 |
---|---|---|
committer | pacien | 2020-04-17 20:21:47 +0200 |
commit | 69cd09b4eba999447527819401ff9e23bfa1134e (patch) | |
tree | a8aaa3d9686a558c6072780ed045c297f2c10d87 /viewer | |
parent | 36877c2e4cd1d1a920ca2b7a5ce14e01ee49b1f6 (diff) | |
download | ldgallery-69cd09b4eba999447527819401ff9e23bfa1134e.tar.gz |
docs: prepare docs for release
commenting out references to not yet fully implemented features
Diffstat (limited to 'viewer')
-rw-r--r-- | viewer/ldgallery-viewer.7.md | 17 |
1 files changed, 6 insertions, 11 deletions
diff --git a/viewer/ldgallery-viewer.7.md b/viewer/ldgallery-viewer.7.md index 59a9f49..1cc3cdd 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-05 (v0.1.0.0-SNAPSHOT) | 5 | date: 2020-04-17 (v1.0-SNAPSHOT) |
6 | --- | 6 | --- |
7 | 7 | ||
8 | 8 | ||
@@ -21,8 +21,7 @@ Its responsiveness allows it to be used from either a desktop browser or some mo | |||
21 | 21 | ||
22 | # USER INTERFACE | 22 | # USER INTERFACE |
23 | 23 | ||
24 | The viewer's user interface is split into a main item view and a side search panel, | 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 | which can be opened by using the appropriate button in the toolbar at the top-left corner. | ||
26 | 25 | ||
27 | 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. |
28 | 27 | ||
@@ -42,16 +41,13 @@ Tags which belong to multiple categories may be disambiguated by adding their ca | |||
42 | The following modifiers can be used in queries as prefixes of tags: | 41 | The following modifiers can be used in queries as prefixes of tags: |
43 | 42 | ||
44 | `+` | 43 | `+` |
45 | : Include all items having the associated tag, | 44 | : Include all items having the associated tag, independently of simple tag restrictions. |
46 | independently of simple tag restrictions. | ||
47 | 45 | ||
48 | `-` | 46 | `-` |
49 | : Exclude all items having the associated tag, | 47 | : Exclude all items having the associated tag, independently of simple tag restrictions and inclusions. |
50 | independently of simple tag restrictions and inclusions. | ||
51 | 48 | ||
52 | Autocompletion suggestions are shown as filters are being typed in the query field. | 49 | Autocompletion suggestions are shown as filters are being typed in the query field. |
53 | In the case of disambiguated tags, both the category and the tag components are allowed to be partially entered, | 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. |
54 | allowing "loc:fra" to expand into "location:france" for example. | ||
55 | 51 | ||
56 | 52 | ||
57 | # VIEWER CONFIGURATION | 53 | # VIEWER CONFIGURATION |
@@ -64,8 +60,7 @@ galleryRoot | |||
64 | 60 | ||
65 | # PROGRESSIVE WEB APPLICATION | 61 | # PROGRESSIVE WEB APPLICATION |
66 | 62 | ||
67 | This web application can be "installed" on some user's mobile device as a progressive web application, | 63 | This web application can be "installed" on some user's mobile device as a progressive web application, i.e. a shortcut giving the web page the appearance of a native application. |
68 | i.e. a shortcut giving the web page the appearance of a native application. | ||
69 | 64 | ||
70 | This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. | 65 | This feature can be enabled by adding a PWA manifest in the viewer's directory when deployed. |
71 | An example of such manifest and an associated icon are available in the example folder packaged with the viewer. | 66 | An example of such manifest and an associated icon are available in the example folder packaged with the viewer. |