summaryrefslogtreecommitdiff
path: root/res/about/help.gmi
diff options
context:
space:
mode:
authorJaakko Keränen <jaakko.keranen@iki.fi>2020-11-21 22:25:39 +0200
committerJaakko Keränen <jaakko.keranen@iki.fi>2020-11-21 22:25:39 +0200
commitb9f7a1234976afcc2cd97f602a6bad422070c2d7 (patch)
tree1b5cc9cdee15fbf7a75269aa0a454bfe1db02ddc /res/about/help.gmi
parent78b9c04d7f878bf5b848e55a1729fb81af9219ea (diff)
Updated Help and Release notes
Diffstat (limited to 'res/about/help.gmi')
-rw-r--r--res/about/help.gmi66
1 files changed, 43 insertions, 23 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi
index af3b06be..1fa1e07e 100644
--- a/res/about/help.gmi
+++ b/res/about/help.gmi
@@ -36,6 +36,8 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a
36* Scaling factor for the UI (for arbitrary monitor DPI) 36* Scaling factor for the UI (for arbitrary monitor DPI)
37* Persistent app state — tabs and history are restored on next run 37* Persistent app state — tabs and history are restored on next run
38* Configurable keybindings 38* Configurable keybindings
39* Built-in support for Gopher
40* Use proxy servers for HTTP, Gopher, or Gemini content
39 41
40## What is Gemini 42## What is Gemini
41 43
@@ -65,7 +67,7 @@ Lagrange's user interface is modeled after web browsers:
65 67
66Tip: Try pressing ${CTRL+}4 now to see the page outline. 68Tip: Try pressing ${CTRL+}4 now to see the page outline.
67 69
68The user interface has been designed for both mouse and keyboard based use. The most commonly needed features are available via context menus, for example by right-clicking on the currently open page. Keyboard shortcuts on the other hand can provide a very quick and fluid user experience. For example, to open the "CAPCOM" bookmark, one might use the following keyboard shortcuts: 70The user interface has been designed for both mouse and keyboard based use. When using a mouse the most commonly needed features are available via context menus, for example by right-clicking on the currently open page. Keyboard shortcuts on the other hand can provide a very quick and fluid user experience. For example, to open the "CAPCOM" bookmark, one might use the following keyboard shortcuts:
69 71
70* ${CTRL+}L to activate the URL input field 72* ${CTRL+}L to activate the URL input field
71* Type "cap" which shows the "CAPCOM" bookmark as the first lookup result 73* Type "cap" which shows the "CAPCOM" bookmark as the first lookup result
@@ -76,9 +78,9 @@ The user interface has been designed for both mouse and keyboard based use. The
76 78
77### URL entry and quick search 79### URL entry and quick search
78 80
79The URL input field is in its typical location in the navigation bar. It can be accessed quickly by pressing ${CTRL+}L. 81The URL input field is in its typical location in the navigation bar. It can be accessed quickly by pressing ${CTRL+}L. You can then type or paste an URL and press Enter to load the page.
80 82
81As you enter text, Lagrange starts looking for matches in bookmarks, history, content of cached pages, and identities. Search results appear below the URL input field in a popup. Press Tab or ↓ to switch input focus to the results. 83As you enter text in the URL input field, Lagrange starts looking for matches in bookmarks, history, identities, and content of cached pages. This provides an easy way to return to a page you've been on recently. Press Tab or ↓ to switch input focus to the results.
82 84
83Search within cached pages is limited to the (small) set of pages that Lagrange keeps in memory for back navigation. Search terms are case insensitive, and if many words are entered, they are all required to appear in the specified order in any matched content. 85Search within cached pages is limited to the (small) set of pages that Lagrange keeps in memory for back navigation. Search terms are case insensitive, and if many words are entered, they are all required to appear in the specified order in any matched content.
84 86
@@ -91,9 +93,11 @@ The type and destination of a link are indicated by the link's icon and color: â
91* Blue for Gemini 93* Blue for Gemini
92* Purple for Gopher 94* Purple for Gopher
93* Orange for HTTP(S) 95* Orange for HTTP(S)
94* Red for other (cannot be opened) 96* Red for other/unknown/invalid (cannot be opened)
95 97
96When you move the mouse over a link, additional information about it will appear: the destination domain, with the URL scheme shown for non-Gemini links, and the date of the last visit to the URL. 98Link colors remain the same regardless of which color theme is being used for page content. (Color themes are discussed in the Customization section.)
99
100When you move the mouse cursor over a link, additional information will appear: the destination domain, with the URL scheme shown for non-Gemini links, and the date of the last visit to the URL.
97 101
98### Note about caching 102### Note about caching
99 103
@@ -109,11 +113,11 @@ Right-clicking on a link shows a link-specific context menu. From there, you can
109 113
110### Opening links using the keyboard 114### Opening links using the keyboard
111 115
112When navigating via keyboard, hold down ${ALT} to see link shortcut keys. Try doing so now and see how the link icon below is replaced with a number. 116Lagrange has two modes for navigating links with the keyboard. The first uses a modifier key (${ALT} by default): while the modifier is pressed, alphanumeric shortcuts are shown for each visible link in the window. You can then press the corresponding key, still holding the modifier, to open a link. The second mode is based on letters only and focuses on the home row keys. You press and release the activation key ("F" by default) to show the link shortcut letters. In this mode the shortcuts are not in alphabetic order, but instead roughly sorted based on proximity to the F and J keys. You may find this easier to use since it is a simple sequence of key presses without using modifiers, allowing one to keep fingers on or near the home row.
113 117
114=> gemini://gemini.circumlunar.space/ Project Gemini 118You can give it a try now with the link below. Either hold down ${ALT}, or press and release F.
115 119
116Each visible link on the page gets an alphanumeric shortcut. For example, the first link can be opened by pressing ${ALT+}1. The tenth link is ${ALT+}A. Additionally hold down ${CTRL} to open the link in a new tab. 120=> gemini://gemini.circumlunar.space/ Project Gemini
117 121
118## Tabs 122## Tabs
119 123
@@ -130,12 +134,14 @@ The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has f
130* Identities: TLS client certificates. 134* Identities: TLS client certificates.
131* Outline: List of the headings in the currently open tab. Useful when reading longer documents. 135* Outline: List of the headings in the currently open tab. Useful when reading longer documents.
132 136
133${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. 137${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. You can also press Escape to dismiss the sidebar.
134 138
135## Bookmarks 139## Bookmarks
136 140
137Press ${CTRL+}D to bookmark the currently open URL. 141Press ${CTRL+}D to bookmark the currently open URL.
138 142
143Bookmarks are listed in alphabetic order in the sidebar. There is no support for folders or manual sorting.
144
139In 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. 145In 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.
140 146
141### Special tags 147### Special tags
@@ -144,7 +150,7 @@ In addition to a title, bookmarks can have tags. Some tags have a special meanin
144 150
145## Identities (client certificates) 151## Identities (client certificates)
146 152
147Gemini uses TLS client certificates for manual user/session identification purposes. This is analogous to logging into a web site, except you are in full control of the information. The term "Identity" is used in Lagrange to refer to client certificates. 153Gemini uses TLS client certificates for user/session identification purposes. Unlike on the web where user identity tracking is covert and automatic, client certificates must be manually taken into use, and you are able to define how long each certificate remains valid. The term "Identity" is used in Lagrange to refer to client certificates.
148 154
149The Identities sidebar tab shows all identities known to Lagrange. Press ${CTRL+}3 to show it. This includes identities created in Lagrange and any identities based on imported X.509 certificates. 155The Identities sidebar tab shows all identities known to Lagrange. Press ${CTRL+}3 to show it. This includes identities created in Lagrange and any identities based on imported X.509 certificates.
150 156
@@ -152,7 +158,7 @@ The Identities sidebar tab shows all identities known to Lagrange. Press ${CTRL+
152 158
153Click on the 👤 button in the navigation bar and select "New Identity...". The shortcut for this is ${SHIFT+}${CTRL+}N. 159Click on the 👤 button in the navigation bar and select "New Identity...". The shortcut for this is ${SHIFT+}${CTRL+}N.
154 160
155Consider any information you enter in the certificate as public; only the Common Name is required and will appear as the issuer and subject of the certificate. This makes it clear that the certificate is self-signed. The other required field is the expiration date in "Valid until". Entering a year is sufficient, and means that the certificate is valid until the end of that year. 161Consider any information you enter in the certificate as public — only the Common Name is required to be non-empty. The generated certificate will use the Common Name as the issuer and subject of the certificate, making it clear that the certificate is self-signed. The other required field is the expiration date in "Valid until". Entering a year is sufficient, and means that the certificate is valid until the end of that year.
156 162
157The "Temporary" option prevents the identity from being saved persistently — it will be deleted as soon as you quit Lagrange. Otherwise, the certificate and its private key are written to .crt and .pem files. 163The "Temporary" option prevents the identity from being saved persistently — it will be deleted as soon as you quit Lagrange. Otherwise, the certificate and its private key are written to .crt and .pem files.
158 164
@@ -177,26 +183,40 @@ Lagrange will add a note to the imported identities to mark them as "Imported".
177 183
178Press ${CTRL+}S to save the contents of the current page to the Downloads folder. This works on all pages regardless of whether Lagrange can display the contents or not. 184Press ${CTRL+}S to save the contents of the current page to the Downloads folder. This works on all pages regardless of whether Lagrange can display the contents or not.
179 185
180The location where downloaded files are saved can be set in Preferences. 186When image or audio content is displayed inline, you can right-click on it and select "Save to Downloads" in the context menu.
181 187
182The 🔃 button on the right side of the URL input field is the Reload/Stop button — it reloads the current page or stops an ongoing download. During large downloads, an additional progress indicator appears next to the Stop button. 188The 🔃 button on the right side of the URL input field is the Reload/Stop button — it reloads the current page or stops an ongoing download. During large downloads, an additional progress indicator appears next to the Stop button.
183 189
190The location where downloaded files are saved can be changed in Preferences. The default location is "Downloads" in your home directory.
191
184## Customization 192## Customization
185 193
186You can find a number of settings in Preferences to customize the user interface and page contents. 194You can find a number of settings in Preferences to customize the user interface and page contents.
187 195
188### Color themes 196### Browsing behavior
197
198The "Outline on scrollbar" option shows the page outline when the mouse cursor is moved over the scrollbar, allowing one to better navigate long documents. The outline will disappear after the mouse cursor is moved away. If you need a persistent outline, one is always available in the sidebar.
199
200One important characteristic of Gemini is that you remain in control of what gets loaded and when. The browser will not suddenly fetch a ton of images, autoplay videos, or make surreptitious connections to any tracking servers — each network request is purposeful and manually triggered. The "Load image on scroll" option is provided to assist keyboard-only browsing and to facilitate a focused reading experience. When enabled, if there is an image link visible on the page and you press Space or ↓, it will be loaded and shown inline _instead_ of the view scrolling down. This allows you to read and see all the content of the page while only tapping on a single key on the keyboard.
189 201
190Lagrange supports configuring dark and light modes separately. You can select a different page content color theme for dark mode and light mode. 202### Window and UI options
191 203
192There are four different UI color themes: two for dark mode, and two for light mode. These can be selected on the "General" tab of the Preferences dialog: 204Lagrange supports configuring dark and light UI modes separately.
205
206There are four different color schemes for the UI: two for dark mode, and two for light mode. These can be selected on the "Window" tab of the Preferences dialog:
193 207
194* Dark mode: "Pure Black" and "Dark" have a fully black or dark gray UI. 208* Dark mode: "Pure Black" and "Dark" have a fully black or dark gray UI.
195* Light mode: "Pure White" and "Light" have completety white or light gray UI. 209* Light mode: "Pure White" and "Light" have completety white or light gray UI.
196 210
197On 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. 211On 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.
198 212
199Page content color themes are selected on the "Colors" tab of Preferences. The "Dark theme" is active in dark mode, and the "Light theme" is active in light mode. 213Options for wide window sizes:
214
215* 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.
216
217### Color themes
218
219Page content color themes are selected on the "Colors" tab of Preferences. The "Dark theme" is active in dark UI mode, and the "Light theme" is active in light UI mode.
200 220
201* Colorful Dark: All elements of the page are colored; the background is dark and text is light. This mode provides the best visual distinction between different domains because more color combinations are available. 221* Colorful Dark: All elements of the page are colored; the background is dark and text is light. This mode provides the best visual distinction between different domains because more color combinations are available.
202* Colorful Light: A single, bright background color with black text. This is the most colorful light theme. Note that colored backgrounds may reduce readability. 222* Colorful Light: A single, bright background color with black text. This is the most colorful light theme. Note that colored backgrounds may reduce readability.
@@ -208,6 +228,8 @@ Page content color themes are selected on the "Colors" tab of Preferences. The "
208 228
209### Page style 229### Page style
210 230
231The "Style" tab of the Preferences dialog lets you customize the appearance and layout of page content.
232
211The 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. 233The 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.
212 234
213There are two sans-serif and two serif fonts: 235There are two sans-serif and two serif fonts:
@@ -223,15 +245,13 @@ Other style options:
223* Quote indicator: Quoted text is shown in an italic font. Additionally, you can select between a quotation mark icon and the traditional vertical line along the left edge of the quote. 245* Quote indicator: Quoted text is shown in an italic font. Additionally, you can select between a quotation mark icon and the traditional vertical line along the left edge of the quote.
224* Big 1st paragraph: When enabled, the leading paragraph on the page is shown in a slightly larger font. 246* Big 1st paragraph: When enabled, the leading paragraph on the page is shown in a slightly larger font.
225 247
226Options for wide window sizes: 248### Proxies
227
228* 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.
229 249
230### Bindings 250### Keybindings
231 251
232The Bindings tab lets you change which keys are bound to UI commands. Currently only basic page scrolling keybindings are available. 252The "Keys" tab lets you change which keys are bound to UI commands. Click on an item with the mouse and then press the new key combination that you want bound to it. Right-click on a binding to erase it or reset it to the default.
233 253
234Click on an item with the mouse and then press the new key combination that you want bound to it. 254Erasing a binding can be useful to disable certain features. For example, if you have no use for keyboard navigation of links via a modifier key, that binding can be erased and use of the modifier key for other purposes will no longer distract you by showing the link shortcuts.
235 255
236To reset all bindings to their defaults, quit Lagrange and delete the "bindings.txt" file in Lagrange's runtime directory. This is a platform-dependent location; see below for more information (under "Runtime files"). 256To reset all bindings to their defaults, quit Lagrange and delete the "bindings.txt" file in Lagrange's runtime directory. This is a platform-dependent location; see below for more information (under "Runtime files").
237 257
@@ -266,7 +286,7 @@ You can drag and drop .gmi files on the Lagrange window to open them in the curr
266Lagrange stores user-specific persistent files in one of the following locations (depending on the operating system): 286Lagrange stores user-specific persistent files in one of the following locations (depending on the operating system):
267 287
268``` 288```
269 Windows : C:\Users\Name\AppData\Roaming\fi.skyjake.Lagrange\ 289 Windows : C:\Users\Name\AppData\Roaming\fi.skyjake.Lagrange
270 macOS : ~/Library/Application Support/fi.skyjake.Lagrange/ 290 macOS : ~/Library/Application Support/fi.skyjake.Lagrange/
271Other Unix : ~/.config/lagrange/ 291Other Unix : ~/.config/lagrange/
272``` 292```