diff options
author | Jaakko Keränen <jaakko.keranen@iki.fi> | 2021-02-27 09:20:11 +0200 |
---|---|---|
committer | Jaakko Keränen <jaakko.keranen@iki.fi> | 2021-02-27 09:20:11 +0200 |
commit | 8fa01b3e8ad8ff2df482779527f063819b33d2c1 (patch) | |
tree | 71f5cd3c9d6e0a0e8c10344f5068fdef93a767db /res/about/help.gmi | |
parent | 66b1193cfd3070bc1746ddce691e1784f0f04395 (diff) |
Updated Help
Diffstat (limited to 'res/about/help.gmi')
-rw-r--r-- | res/about/help.gmi | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi index b845c6fb..15485571 100644 --- a/res/about/help.gmi +++ b/res/about/help.gmi | |||
@@ -31,11 +31,12 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a | |||
31 | * Sidebar for page outline, managing bookmarks and identities, and viewing history | 31 | * Sidebar for page outline, managing bookmarks and identities, and viewing history |
32 | * Multiple tabs | 32 | * Multiple tabs |
33 | * Identity management — create and use TLS client certificates | 33 | * Identity management — create and use TLS client certificates |
34 | * Subscribe to Gemini feeds | 34 | * Subscribe to Gemini and Atom feeds |
35 | * Use Gemini pages as a source of bookmarks | 35 | * Use Gemini pages as a source of bookmarks |
36 | * Light and dark color themes | 36 | * Light and dark color themes |
37 | * Select and copy text with the mouse | 37 | * Select and copy text with the mouse |
38 | * Find text on the page | 38 | * Find text on the page |
39 | * Search engine integration | ||
39 | * Open image links inline on the same page | 40 | * Open image links inline on the same page |
40 | * Audio playback: MP3, Ogg Vorbis, WAV | 41 | * Audio playback: MP3, Ogg Vorbis, WAV |
41 | * Open links via keyboard shortcuts | 42 | * Open links via keyboard shortcuts |
@@ -88,6 +89,8 @@ Search within cached pages is limited to the (small) set of pages that Lagrange | |||
88 | 89 | ||
89 | Note that the navigation stack is saved to a file when Lagrange is shut down and restored on the next launch. This means the next time you launch Lagrange, you can still search the contents of past pages. However, navigation stacks are tab-specific, so closing a tab will delete its history as well. | 90 | Note that the navigation stack is saved to a file when Lagrange is shut down and restored on the next launch. This means the next time you launch Lagrange, you can still search the contents of past pages. However, navigation stacks are tab-specific, so closing a tab will delete its history as well. |
90 | 91 | ||
92 | You can also make online search queries via the URL input field. When a search URL is configured on the "Network" tab of Preferences, text entered in the URL field is passed to the search URL as a query parameter. A search query will only occur when Enter is pressed while the [⇒ Search Query] indicator is visible. | ||
93 | |||
91 | ### 1.1.2 Links | 94 | ### 1.1.2 Links |
92 | 95 | ||
93 | The type and destination of a link are indicated by the link's icon and color: ➤ links to the same domain, and 🌐 to a different domain. The colors are: | 96 | The type and destination of a link are indicated by the link's icon and color: ➤ links to the same domain, and 🌐 to a different domain. The colors are: |
@@ -127,7 +130,13 @@ You can give it a try now with the link below. Either hold down ${ALT}, or press | |||
127 | 130 | ||
128 | Press ${CTRL+}T to open a new tab, and ${CTRL+}W to close the current tab. Right-clicking on buttons in the tab bar shows a context menu for additional tab-related functions. | 131 | Press ${CTRL+}T to open a new tab, and ${CTRL+}W to close the current tab. Right-clicking on buttons in the tab bar shows a context menu for additional tab-related functions. |
129 | 132 | ||
130 | The set of open tabs is restored when you launch Lagrange. | 133 | The set of open tabs and their full contents are saved when you quit the application and restored when relaunch it. |
134 | |||
135 | ### 1.2.1 Auto-reloading | ||
136 | |||
137 | A tab can be set to auto-reload at given intervals. The setting is remembered until the tab is closed. This is helpful if you keep a periodically updated page open for longer periods of time. | ||
138 | |||
139 | The feature can be found in the page context menu: right-click and select "Set Auto-Reload...". | ||
131 | 140 | ||
132 | ## 1.3 Sidebars | 141 | ## 1.3 Sidebars |
133 | 142 | ||
@@ -149,6 +158,8 @@ Bookmarks are listed in alphabetic order in the sidebar. There is no support for | |||
149 | 158 | ||
150 | In addition to a title, bookmarks can have tags. Some tags have a special meaning, but you are free to enter whatever you want in the tags field. In quick search results, tags are given extra weight so they appear higher in results. | 159 | In addition to a title, bookmarks can have tags. Some tags have a special meaning, but you are free to enter whatever you want in the tags field. In quick search results, tags are given extra weight so they appear higher in results. |
151 | 160 | ||
161 | By default bookmarks are assigned random icons. You can enter a custom icon for a bookmark in the bookmark edit dialog to make it easier to recognize a particular site at a glance. The icon must be a single Unicode character. It will appear in the bookmark list, tab titles, feed entry list, quick search results, and page top banners. | ||
162 | |||
152 | ### 1.4.1 Exporting and importing | 163 | ### 1.4.1 Exporting and importing |
153 | 164 | ||
154 | => about:bookmarks The special page "about:bookmarks" is used for exporting bookmarks out of Lagrange. | 165 | => about:bookmarks The special page "about:bookmarks" is used for exporting bookmarks out of Lagrange. |
@@ -183,10 +194,11 @@ Note that remote bookmarks are read-only: they cannot be edited or tagged. This | |||
183 | 194 | ||
184 | ## 1.5 Subscribing to feeds | 195 | ## 1.5 Subscribing to feeds |
185 | 196 | ||
186 | You may be familiar with RSS and Atom XML feeds from the web. Lagrange does _not_ support RSS or Atom, only Gemini feeds. A Gemini feed is simply a regular 'text/gemini' page that contains one or more links whose labels are formatted in a particular way. | 197 | You may be familiar with XML-based RSS and Atom feeds from the web. The Gemini equivalent of these is Gemini feeds. A Gemini feed is simply a regular 'text/gemini' page that contains one or more links whose labels are formatted in a particular way. This makes it very easy to write pages that clients can subscribe to. |
187 | |||
188 | => gemini://gemini.circumlunar.space/docs/companion/subscription.gmi See "Subscribing to Gemini pages" for more information. | 198 | => gemini://gemini.circumlunar.space/docs/companion/subscription.gmi See "Subscribing to Gemini pages" for more information. |
189 | 199 | ||
200 | Lagrange supports Gemini and Atom feed subscriptions. Atom feeds are automatically translated to the Gemini feed format so they can be viewed and subscribed to like a normal 'text/gemini' page. RSS feeds are not supported. | ||
201 | |||
190 | Subscriptions are managed via bookmarks. When you subscribe to a feed page, a bookmark is created and the special "subscribed" tag is applied on it. In the Bookmarks list, this is indicated by a ★ icon. There is no other difference between normal bookmarks and feed subscriptions — you may tag any bookmark as "subscribed" and Lagrange will look through it for feed-style links. The bookmark title is used as the feed title. This defaults to the top heading of the feed index page, but you can edit it to suit your needs. | 202 | Subscriptions are managed via bookmarks. When you subscribe to a feed page, a bookmark is created and the special "subscribed" tag is applied on it. In the Bookmarks list, this is indicated by a ★ icon. There is no other difference between normal bookmarks and feed subscriptions — you may tag any bookmark as "subscribed" and Lagrange will look through it for feed-style links. The bookmark title is used as the feed title. This defaults to the top heading of the feed index page, but you can edit it to suit your needs. |
191 | 203 | ||
192 | Feeds are refreshed periodically while Lagrange is running, and also immediately after launching if it has been a while since the previous refresh. You may also manually refresh all feeds via the menus or by pressing ${SHIFT+}${CTRL+}R. | 204 | Feeds are refreshed periodically while Lagrange is running, and also immediately after launching if it has been a while since the previous refresh. You may also manually refresh all feeds via the menus or by pressing ${SHIFT+}${CTRL+}R. |
@@ -260,6 +272,8 @@ There are four different color schemes for the UI: two for dark mode, and two fo | |||
260 | 272 | ||
261 | On macOS, Lagrange will automatically switch between dark and light modes if the "Use system theme" setting is enabled. On other platforms you'll need to switch manually. | 273 | On macOS, Lagrange will automatically switch between dark and light modes if the "Use system theme" setting is enabled. On other platforms you'll need to switch manually. |
262 | 274 | ||
275 | On Windows, an option is provided to use a custom window frame. This provides a more consistent visual style for the application. However, the custom frame overrides default behaviors of the window, so if you are a Windows power user expect it to not support all the special interactions. For example, when pressing the Windows+Left/Right key, the window is resized to take over one half of the screen. Normally, Windows would then prompt to select another window to fill the rest of the screen, but this does not happen with the custom window frame. | ||
276 | |||
263 | Options for wide window sizes: | 277 | Options for wide window sizes: |
264 | 278 | ||
265 | * Site icon: If there is room on the left side of the page text, the site icon appears there along with the top level heading. This allows one to keep better track of the current reading position in long documents. | 279 | * Site icon: If there is room on the left side of the page text, the site icon appears there along with the top level heading. This allows one to keep better track of the current reading position in long documents. |
@@ -282,12 +296,14 @@ The "Style" tab of the Preferences dialog lets you customize the appearance and | |||
282 | 296 | ||
283 | The fonts for headings and other text are selected separately. This way one can achieve a greater number of style variations. Also, headings that are in a different font are more visually distinct and thus easier for one's eyes to scan. | 297 | The fonts for headings and other text are selected separately. This way one can achieve a greater number of style variations. Also, headings that are in a different font are more visually distinct and thus easier for one's eyes to scan. |
284 | 298 | ||
285 | There are two sans-serif and two serif fonts: | 299 | There are six fonts available: |
286 | 300 | ||
287 | * "Nunito" is a friendly rounded sans-serif font. | 301 | * "Nunito" is a friendly rounded sans-serif font. |
288 | * "Fira Sans" is a bolder, narrower, and more angular sans-serif font. | 302 | * "Fira Sans" is a bolder, narrower, and more angular sans-serif font. |
289 | * "Literata" is a heavy and serious serif font. | 303 | * "Literata" is a heavy and serious serif font. |
290 | * "Tinos" is a lighter serif font. | 304 | * "Tinos" is a lighter serif font. |
305 | * "Source Sans Pro" is the Lagrange UI font. | ||
306 | * "Iosevka" is the monospace font. | ||
291 | 307 | ||
292 | Other style options: | 308 | Other style options: |
293 | 309 | ||
@@ -388,7 +404,7 @@ Any output that does not follow this format is considered to mean that the hook | |||
388 | ## 4.2 mimehooks.txt syntax | 404 | ## 4.2 mimehooks.txt syntax |
389 | 405 | ||
390 | Like other Lagrange configuration lines, mimehooks.txt has a simple line-oriented syntax. Lagrange must be restarted for changes to the configuration file to take effect. | 406 | Like other Lagrange configuration lines, mimehooks.txt has a simple line-oriented syntax. Lagrange must be restarted for changes to the configuration file to take effect. |
391 | 407 | ≈ | |
392 | Each hook is specified as three lines: | 408 | Each hook is specified as three lines: |
393 | * A human-readable label (for reporting to the user) | 409 | * A human-readable label (for reporting to the user) |
394 | * MIME type/parameter regular expression | 410 | * MIME type/parameter regular expression |