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 | |
parent | 36877c2e4cd1d1a920ca2b7a5ce14e01ee49b1f6 (diff) | |
download | ldgallery-69cd09b4eba999447527819401ff9e23bfa1134e.tar.gz |
docs: prepare docs for release
commenting out references to not yet fully implemented features
-rw-r--r-- | compiler/ldgallery.1.md | 31 | ||||
-rw-r--r-- | viewer/ldgallery-viewer.7.md | 17 |
2 files changed, 27 insertions, 21 deletions
diff --git a/compiler/ldgallery.1.md b/compiler/ldgallery.1.md index 4f9935b..29f0cf3 100644 --- a/compiler/ldgallery.1.md +++ b/compiler/ldgallery.1.md | |||
@@ -2,7 +2,7 @@ | |||
2 | pagetitle: Compiler user manual - ldgallery | 2 | pagetitle: Compiler user manual - ldgallery |
3 | title: LDGALLERY(1) ldgallery | 3 | title: LDGALLERY(1) ldgallery |
4 | author: Pacien TRAN-GIRARD, Guillaume FOUET | 4 | author: Pacien TRAN-GIRARD, Guillaume FOUET |
5 | date: 2020-02-15 (v0.1.0.0-SNAPSHOT) | 5 | date: 2020-04-17 (v1.0-SNAPSHOT) |
6 | --- | 6 | --- |
7 | 7 | ||
8 | 8 | ||
@@ -15,7 +15,9 @@ ldgallery - a static web gallery generator with tags | |||
15 | 15 | ||
16 | ldgallery is a static gallery generator which turns a collection of tagged pictures into a searchable web gallery. | 16 | ldgallery is a static gallery generator which turns a collection of tagged pictures into a searchable web gallery. |
17 | 17 | ||
18 | The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery. It can optionally output a static web viewer along, which allows the content to be presented and searched through from a JavaScript-enabled web browser. This client-side web application does not require any special software on the server's side. | 18 | The ldgallery compiler program processes pictures and aggregates metadata from plain text sidecar files to generate an indexed version of the gallery. |
19 | It can optionally output a static web viewer along, which allows the content to be presented and searched through from a JavaScript-enabled web browser. | ||
20 | This client-side web application does not require any special software on the server's side. | ||
19 | 21 | ||
20 | 22 | ||
21 | # COMMAND | 23 | # COMMAND |
@@ -97,13 +99,17 @@ title | |||
97 | : Title of the item. | 99 | : Title of the item. |
98 | Defaults to the name of the file or directory. | 100 | Defaults to the name of the file or directory. |
99 | 101 | ||
102 | <!-- not used in the viewer yet -- | ||
100 | datetime | 103 | datetime |
101 | : ISO 8601 zoned date and time. | 104 | : ISO 8601 zoned date and time. |
102 | Defaults to the last modification time of the file itself, | 105 | Defaults to the last modification time of the file itself, |
103 | or the most recent modification date of a directory's items. | 106 | or the most recent modification date of a directory's items. |
107 | --> | ||
104 | 108 | ||
109 | <!-- not used in the viewer yet -- | ||
105 | description | 110 | description |
106 | : Description for the item. | 111 | : Description for the item. |
112 | --> | ||
107 | 113 | ||
108 | tags | 114 | tags |
109 | : List of tags for the item. | 115 | : List of tags for the item. |
@@ -116,19 +122,24 @@ tags | |||
116 | The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory. | 122 | The gallery settings reside in a file named "gallery.yaml" located at the root of the gallery's source directory. |
117 | 123 | ||
118 | galleryTitle | 124 | galleryTitle |
119 | : Title of the gallery. Defaults to "ldgallery". | 125 | : Title of the gallery. |
126 | Defaults to "ldgallery". | ||
120 | 127 | ||
121 | includedDirectories[] | 128 | includedDirectories[] |
122 | : Glob patterns of directory names to include in the gallery. Defaults to ["*"] (matches all directory names). | 129 | : Glob patterns of directory names to include in the gallery. |
130 | Defaults to ["*"] (matches all directory names). | ||
123 | 131 | ||
124 | excludedDirectories[] | 132 | excludedDirectories[] |
125 | : Glob patterns of directory names to exclude from the gallery. Defaults to [] (none). | 133 | : Glob patterns of directory names to exclude from the gallery. |
134 | Defaults to [] (none). | ||
126 | 135 | ||
127 | includedFiles[] | 136 | includedFiles[] |
128 | : Glob patterns of file names to include in the gallery. Defaults to ["*"] (matches all file names). | 137 | : Glob patterns of file names to include in the gallery. |
138 | Defaults to ["*"] (matches all file names). | ||
129 | 139 | ||
130 | excludedFiles[] | 140 | excludedFiles[] |
131 | : Glob patterns of file names to exclude from the gallery. Defaults to [] (none). | 141 | : Glob patterns of file names to exclude from the gallery. |
142 | Defaults to [] (none). | ||
132 | 143 | ||
133 | includedTags[] | 144 | includedTags[] |
134 | : Glob patterns of tags to include in the gallery. | 145 | : Glob patterns of tags to include in the gallery. |
@@ -144,8 +155,7 @@ tagCategories[] | |||
144 | Defaults to [] (none). | 155 | Defaults to [] (none). |
145 | 156 | ||
146 | tagsFromDirectories.fromParents | 157 | tagsFromDirectories.fromParents |
147 | : Automatically generate tags from the name of parent directories, | 158 | : Automatically generate tags from the name of parent directories, looking up in the hierarchy as far as indicated by this parameter. |
148 | looking up in the hierarchy as far as indicated by this parameter. | ||
149 | Defaults to 0 (does not generate tags from parent directories). | 159 | Defaults to 0 (does not generate tags from parent directories). |
150 | 160 | ||
151 | tagsFromDirectories.prefix | 161 | tagsFromDirectories.prefix |
@@ -172,4 +182,5 @@ Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. | |||
172 | 182 | ||
173 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. | 183 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. |
174 | 184 | ||
175 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details <https://www.gnu.org/licenses/agpl-3.0.html>. | 185 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
186 | See the GNU Affero General Public License for more details <https://www.gnu.org/licenses/agpl-3.0.html>. | ||
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. |