Updated Help: Added Titan uploads

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
 * Audio playback: MP3, Ogg Vorbis, WAV
 * Read Gempub books and view ZIP archive contents
 * Built-in support for Gopher
+* Built-in support for uploading data using the Titan protocol
 * Use proxy servers for HTTP, Gopher, or Gemini content
 
 ## 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
 
 ### 1.1.5 Opening links to the side
 
-Holding 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.
+Holding 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.
 
 ### 1.1.6 Opening links using the keyboard
 
@@ -269,7 +270,26 @@ The 🔃 button on the right side of the URL input field is the Reload/Stop butt
 
 The location where downloaded files are saved can be changed in Preferences. The default location is "Downloads" in your home directory.
 
-## 1.8 Split view mode
+## 1.8 Uploads (with Titan)
+
+Titan 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.
+
+=> gemini://transjovian.org/titan  Titan Protocol (by Alex Schroeder)
+
+While 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.
+
+As 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.
+
+The Titan upload dialog supports two ways to enter the data:
+
+* 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.
+* 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.
+
+The 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.
+
+The 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.
+
+## 1.9 Split view mode
 
 By 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.
 
@@ -281,7 +301,7 @@ Another way to activate split view mode is to click on a link while holding ${SH
 
 Each 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.
 
-### 1.8.1 Switching focus
+### 1.9.1 Switching focus
 
 At 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.
 
@@ -289,7 +309,7 @@ To switch keyboard focus between the sections, you can use the Next/Previous Tab
 
 You may also press Tab to cycle input focus between all the URL input fields.
 
-### 1.8.2 Pinning
+### 1.9.2 Pinning
 
 While 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.
 
@@ -303,7 +323,7 @@ The default pinning mode is "Left Tab".
 
 The ◧ indicator is shown in the URL input field when the current tab is pinned.
 
-## 1.9 Viewing local files and directories
+## 1.10 Viewing local files and directories
 
 "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.
 
@@ -311,7 +331,7 @@ When viewing a directory, its contents are shown as a list of links. A similar p
 
 Note 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.
 
-## 1.10 Gempub
+## 1.11 Gempub
 
 Gempub is an e-book/archival format that is essentially a set of Gemtext files stored in a ZIP archive.
 
@@ -329,7 +349,7 @@ One important characteristic of Gemini is that you remain in control of what get
 
 The "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.
 
-"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.
+"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.
 
 ## 2.2 Window and UI options
 
@@ -544,16 +564,16 @@ green:      0       200     0
 # Light
 
 black:      0       0       0
-gray25:     75      75      75 
+gray25:     75      75      75
 gray50:     150     150     150
 gray75:     235     235     235
 white:      255     255     255
-brown:      210     120      10 
+brown:      210     120      10
 orange:     235     215     200
 teal:       10      110     130
 cyan:       170     215     220
-yellow:     255     255     32 
-red:        255     64      64 
+yellow:     255     255     32
+red:        255     64      64
 magenta:    255     0       255
 blue:       132     132     255
 green:      0       150     0
@@ -572,6 +592,9 @@ Trusted server certificates. Each line specifies the certificate fingerprint of
 * The "valid until" expiration date is a UNIX timestamp.
 * The fingerprint is an SHA256 checksum of the server certificate's public key in DER format.
 
+### uploadbackup.txt
+Backup of the text entered into the Upload with Titan dialog.
+
 ### visited.2.txt
 The combined navigation history of all tabs. Each line specifies one URL:
 > {last-visited} {flags} {url}