summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--res/about/help.gmi45
1 files changed, 34 insertions, 11 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi
index 179f85e1..1c8dd4b6 100644
--- a/res/about/help.gmi
+++ b/res/about/help.gmi
@@ -50,6 +50,7 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a
50* Audio playback: MP3, Ogg Vorbis, WAV 50* Audio playback: MP3, Ogg Vorbis, WAV
51* Read Gempub books and view ZIP archive contents 51* Read Gempub books and view ZIP archive contents
52* Built-in support for Gopher 52* Built-in support for Gopher
53* Built-in support for uploading data using the Titan protocol
53* Use proxy servers for HTTP, Gopher, or Gemini content 54* Use proxy servers for HTTP, Gopher, or Gemini content
54 55
55## Why not just use a web browser 56## Why not just use a web browser
@@ -127,7 +128,7 @@ Right-clicking on a link shows a link-specific context menu. From there, you can
127 128
128### 1.1.5 Opening links to the side 129### 1.1.5 Opening links to the side
129 130
130Holding down ${SHIFT} when left-clicking on a link opens it in split view mode on the other side of the split. When in split view mode, your tab pinning preference will determine the tab on which clicked links will open. See section 1.8 for more information about split view modes. 131Holding down ${SHIFT} when left-clicking on a link opens it in split view mode on the other side of the split. When in split view mode, your tab pinning preference will determine the tab on which clicked links will open. See section 1.9 for more information about split view modes.
131 132
132### 1.1.6 Opening links using the keyboard 133### 1.1.6 Opening links using the keyboard
133 134
@@ -269,7 +270,26 @@ The 🔃 button on the right side of the URL input field is the Reload/Stop butt
269 270
270The location where downloaded files are saved can be changed in Preferences. The default location is "Downloads" in your home directory. 271The location where downloaded files are saved can be changed in Preferences. The default location is "Downloads" in your home directory.
271 272
272## 1.8 Split view mode 273## 1.8 Uploads (with Titan)
274
275Titan is a sister protocol to Gemini that enables sending arbitrary amounts of data from a client to a server. The Gemini protocol itself only enables sending up to 1024 bytes of data in a request. Furthermore, the request URL also counts against that limit, and the sent data must be percent-encoded so it can be parsed as a valid URL. Consequently, Gemini clients can only send very limited amounts of data to a server. Titan solves this by expanding the request so that the request URL is followed by a payload field. When it comes to TLS, Titan is equivalent to Gemini, so the same server and client certificates can be used with both.
276
277=> gemini://transjovian.org/titan Titan Protocol (by Alex Schroeder)
278
279While Titan and Gemini are related, Titan is a separate protocol and regular Gemini servers are not expected to support it. Whether it makes sense to allow clients to upload large amounts of data is a service-specific question. For example, a server that hosts a gemlog could enable Titan uploads for submitting new posts, or editing existing posts by uploading a revised version.
280
281As far as Lagrange is concerned, Titan is just one of the supported URL schemes. Whenever you try to open a "titan://" URL, no matter if it is manually entered into the URL field, or by clicking on a link, opening a bookmark, feed entry, or via a redirect, a dialog will open where you can specify the data to upload.
282
283The Titan upload dialog supports two ways to enter the data:
284
285* You can type text in the input field on the "Text" tab. It will be sent to the server using 'text/plain' as the media type.
286* You can drag and drop a file on the dialog. The details of the file to be uploaded are visible on the "File" tab. The media type can be specified manually if Lagrange does not correctly detect it.
287
288The upload token is a feature of Titan where servers can require a certain token text/passphrase for uploads. It is up to the server how this is interpreted. It could be used as a simple password, or even a command to further instruct the server about what to do with the uploaded data. Please refer to the server's instructions about what to enter here. The token may also be left empty.
289
290The text entered into the upload dialog's main text field is protected against accidental closing of the dialog or the application, or a crash. The previous text is restored when the dialog is reopened. The text field contents are only cleared when the submitted Titan request has been successfully completed.
291
292## 1.9 Split view mode
273 293
274By default, only one tab is visible at a time in the application window. However, sometimes it is beneficial to see two pages at once. For example, many capsules have top-level menus or lists of articles, and keeping the menu/index visible on the side makes navigation less cumbersome. 294By default, only one tab is visible at a time in the application window. However, sometimes it is beneficial to see two pages at once. For example, many capsules have top-level menus or lists of articles, and keeping the menu/index visible on the side makes navigation less cumbersome.
275 295
@@ -281,7 +301,7 @@ Another way to activate split view mode is to click on a link while holding ${SH
281 301
282Each split has its own sidebars, which means that in split view mode you can have a total of four sidebars open at the same time. 302Each split has its own sidebars, which means that in split view mode you can have a total of four sidebars open at the same time.
283 303
284### 1.8.1 Switching focus 304### 1.9.1 Switching focus
285 305
286At any given time, one of the splits has keyboard focus. This is indicated by a colored line at the top of the section, and some UI elements will be dimmed out on the unfocused side. 306At any given time, one of the splits has keyboard focus. This is indicated by a colored line at the top of the section, and some UI elements will be dimmed out on the unfocused side.
287 307
@@ -289,7 +309,7 @@ To switch keyboard focus between the sections, you can use the Next/Previous Tab
289 309
290You may also press Tab to cycle input focus between all the URL input fields. 310You may also press Tab to cycle input focus between all the URL input fields.
291 311
292### 1.8.2 Pinning 312### 1.9.2 Pinning
293 313
294While it is sometimes useful to simply have two independent browsers open side by side, by default view splitting is meant to assist in navigating hierarchies and lists. In the typical use case, you'll have a menu or an index page on the left, and a content page open on the right. Links clicked on the left will automatically open on the right. 314While it is sometimes useful to simply have two independent browsers open side by side, by default view splitting is meant to assist in navigating hierarchies and lists. In the typical use case, you'll have a menu or an index page on the left, and a content page open on the right. Links clicked on the left will automatically open on the right.
295 315
@@ -303,7 +323,7 @@ The default pinning mode is "Left Tab".
303 323
304The â—§ indicator is shown in the URL input field when the current tab is pinned. 324The â—§ indicator is shown in the URL input field when the current tab is pinned.
305 325
306## 1.9 Viewing local files and directories 326## 1.10 Viewing local files and directories
307 327
308"file://" URLs can be used for accessing local files and directories. File types known to Lagrange, such as .gmi, .txt., .png, .jpg, and .zip, can be viewed inside the application. In this release, types of local files are detected solely based on the file extension. 328"file://" URLs can be used for accessing local files and directories. File types known to Lagrange, such as .gmi, .txt., .png, .jpg, and .zip, can be viewed inside the application. In this release, types of local files are detected solely based on the file extension.
309 329
@@ -311,7 +331,7 @@ When viewing a directory, its contents are shown as a list of links. A similar p
311 331
312Note that ZIP archives are not decompressed while browsing their directory structure. Each request that accesses a compressed file in an archive will cause only that particular file to be decompressed. This may cause slow response times when dealing with large compressed files. 332Note that ZIP archives are not decompressed while browsing their directory structure. Each request that accesses a compressed file in an archive will cause only that particular file to be decompressed. This may cause slow response times when dealing with large compressed files.
313 333
314## 1.10 Gempub 334## 1.11 Gempub
315 335
316Gempub is an e-book/archival format that is essentially a set of Gemtext files stored in a ZIP archive. 336Gempub is an e-book/archival format that is essentially a set of Gemtext files stored in a ZIP archive.
317 337
@@ -329,7 +349,7 @@ One important characteristic of Gemini is that you remain in control of what get
329 349
330The "Open archive indices" option controls whether index.gmi pages are automatically opened while browsing the contents of a ZIP archive. The purpose is to simulate the behavior of a Gemini server where opening a directory will by default show its index page. Enabling this option makes navigating an archived copy of a capsule a more streamlined experience. 350The "Open archive indices" option controls whether index.gmi pages are automatically opened while browsing the contents of a ZIP archive. The purpose is to simulate the behavior of a Gemini server where opening a directory will by default show its index page. Enabling this option makes navigating an archived copy of a capsule a more streamlined experience.
331 351
332"Split view pinning" controls which tab links will be opened on when browsing in split view mode. The default mode is "Left Tab", which means that the page in the left tab is pinned (remains unchanged) when clicking on a link. For more information, see section 1.8. 352"Split view pinning" controls which tab links will be opened on when browsing in split view mode. The default mode is "Left Tab", which means that the page in the left tab is pinned (remains unchanged) when clicking on a link. For more information, see section 1.9.
333 353
334## 2.2 Window and UI options 354## 2.2 Window and UI options
335 355
@@ -544,16 +564,16 @@ green: 0 200 0
544# Light 564# Light
545 565
546black: 0 0 0 566black: 0 0 0
547gray25: 75 75 75 567gray25: 75 75 75
548gray50: 150 150 150 568gray50: 150 150 150
549gray75: 235 235 235 569gray75: 235 235 235
550white: 255 255 255 570white: 255 255 255
551brown: 210 120 10 571brown: 210 120 10
552orange: 235 215 200 572orange: 235 215 200
553teal: 10 110 130 573teal: 10 110 130
554cyan: 170 215 220 574cyan: 170 215 220
555yellow: 255 255 32 575yellow: 255 255 32
556red: 255 64 64 576red: 255 64 64
557magenta: 255 0 255 577magenta: 255 0 255
558blue: 132 132 255 578blue: 132 132 255
559green: 0 150 0 579green: 0 150 0
@@ -572,6 +592,9 @@ Trusted server certificates. Each line specifies the certificate fingerprint of
572* The "valid until" expiration date is a UNIX timestamp. 592* The "valid until" expiration date is a UNIX timestamp.
573* The fingerprint is an SHA256 checksum of the server certificate's public key in DER format. 593* The fingerprint is an SHA256 checksum of the server certificate's public key in DER format.
574 594
595### uploadbackup.txt
596Backup of the text entered into the Upload with Titan dialog.
597
575### visited.2.txt 598### visited.2.txt
576The combined navigation history of all tabs. Each line specifies one URL: 599The combined navigation history of all tabs. Each line specifies one URL:
577> {last-visited} {flags} {url} 600> {last-visited} {flags} {url}