Adds more help files

This commit is contained in:
Sloom Sloum Sluom IV 2020-06-21 15:53:31 -07:00
parent 3ffd878ad6
commit 975a3e34fd
15 changed files with 221 additions and 28 deletions

View File

@ -28,6 +28,10 @@ func helpAddress(section string) (string, error) {
switch strings.ToLower(section) {
case "add", "a", "delete", "d", "bookmarks", "bookmark", "b":
addr = "bookmarks.help"
case "quit", "quitting", "q", "flags", "runtime", "options", "exiting", "exit", "general", "startup", "version", "title":
addr = "general.help"
case "help", "info", "?", "information":
addr = "help.help"
default:
return "", fmt.Errorf("No help section for %q exists", section)
}

View File

@ -6,81 +6,76 @@ It is easy to add, view, navigate to, and delete bookmarks in Bombadillo. Let's
+---------------------------+
+ Adding Bookmarks +
+---------------------------+
-- Adding Bookmarks --
Adding a bookmark is done with the add command and has the following syntax:
`:add [target] [name...]`
`add [target] [name...]`
Like many commands in Bombadillo, you can use an abbreviated form and just type `:a [target] [name...]`
Like many commands in Bombadillo, you can use an abbreviated form and just type `a [target] [name...]`
The available target valies are a url, a link ID that appears on the current page, or the character `.`, which represents the current page itself.
Examples:
- `:add gopher://bombadillo.colorfield.space Bombadillo`
- `:a 5 My Favorite Phlog`
- `:add . Dave's Gopherhole`
- `add gopher://bombadillo.colorfield.space Bombadillo`
- `a 5 My Favorite Phlog`
- `add . Dave's Gopherhole`
If you are missing an element, or the link ID does not exist, Bombadillo will let you know the issue and/or show you the correct syntax.
+---------------------------+
+ Viewing Bookmarks +
+---------------------------+
-- Viewing Bookmarks --
Viewing your bookmarks is quite easy. You can use a command or a "hot" key. To toggle the bookmarks bar into and out of view you can press the key `B` (the key combination `shift + b`). The command version is as follows:
Viewing your bookmarks is quite easy. You can use a command or a "hot" key. To toggle the bookmarks bar into and out of view you can press the key "B" (the key combination "shift" + "b"). The command version, including the abbreviated form, is as follows:
`:bookmarks` or the abbreviated `:b`
- `bookmarks`
- `b`
In general, the hot key is likely more comfortable for most users.
Once the bookmarks bar is visible you can scroll up and down in it with the regular `j` and `k` keys to view your bookmarks if you have more than the height of your temrinal allows on screen at one time. You may notice that you can no longer scroll the page with these keys. This is because the bookmark bar has focus when it is first opened. You can switch focus between the main content and the bookmarks bar by pressing the tab key (`<tab>`), which will allow you to scroll in whichever area is needed at a given time.
Once the bookmarks bar is visible you can scroll up and down in it with the regular "j" and "k" keys to view your bookmarks if you have more than the height of your temrinal allows on screen at one time. You may notice that you can no longer scroll the page with these keys. This is because the bookmark bar has focus when it is first opened. You can switch focus between the main content and the bookmarks bar by pressing the "tab" key, which will allow you to scroll in whichever area is needed at a given time.
Closing the bookmarks bar is done the same way as opening it.
+---------------------------+
+ Navigating To Bookmarks +
+---------------------------+
-- Navigating To Bookmarks --
Navigating to a bookmark is done in much the same way as navigating to a regular link, except there is an additional command paramater. The syntax is as follows:
Navigating to a bookmark is done in much the same way as navigating to a regular link, except there is an additional command paramater. The syntax, including the abbreviated version, is as follows:
`:bookmarks [bookmark-id]` or the abbreviated `:b [bookmark-id]`
- `bookmarks [bookmark-id]`
- `b [bookmark-id]`
The bookmark-id is shown in the bookmarks bar next to the bookmark name.
Examples:
- `:bookmarks 3`
- `:b 21`
- `bookmarks 3`
- `b 21`
If the bookmark-id you provide does not exist, Bombadillo will let you know. Otherwise, the URL that the selected bookmark represents will be loaded.
+---------------------------+
+ Deleting Bookmarks +
+---------------------------+
-- Deleting Bookmarks --
To delete a bookmark you will need to know its ID. This can be found in the bookmarks bar (see above: 'Viewing Bookmarks') next to the bookmark's name.
The syntax for deleting a bookmark is as follows:
The syntax for deleting a bookmark, including the abbreviated form, is as follows:
`:delete [bookmark-id]` or the abbreviated `:d [bookmark-id]`
- `delete [bookmark-id]`
- `d [bookmark-id]`
Examples:
- `:delete 3`
- `:d 21`
- `delete 3`
- `d 21`
If the bookmark-id you provide does not exist, Bombadillo will let you know. Otherwise, the bookmark will be deleted.
@ -91,3 +86,26 @@ This concludes the help section brought up by the following keywords:
bookmark, bookmarks, a, b, d, add, delete
Other sections of the help document:
`help help`
`help general`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

0
help/commands.help Normal file
View File

0
help/finger.help Normal file
View File

0
help/gemini.help Normal file
View File

87
help/general.help Normal file
View File

@ -0,0 +1,87 @@
General Opperation
---------------------------
This help guide will walk you through starting Bombadillo, including the various flags/options avialable at startup. It will also cover quitting Bombadillo and a few other simple commands that are not covered elsewhere.
-- Starting Bombadillo --
If Bombadillo has been installed somewhere on your system path the starting Bombadillo can be done by opening a terminal and typing `bombadillo` at the prompt. Bombadillo should open up in the existing terminal window.
If Bombadillo is not on your system path you can either add it to the path and follow the above instructions, or you can navigate to the directory containing the Bombadillo executable and run it. For example, if I was the user "dave" and had the executable in my home folder I might run the following in my terminal's shell:
- `~/bombadillo`
- `cd && ./bombadillo`.
Users on Linux that support desktop files can also launch Bombadillo by clicking on the desktop icon (it may be found in a menu or launcher, depending on the system).
Bombadillo supports a few command line flags to modify its behavior at run time.
To see the command usage, you can run the following in your terminal's shell:
`bombadillo -h`
This will print out the available command line options, as well as the command syntax, and exit.
To see the version of Bombadillo you are using, you can run the following in your terminal's shell:
`bombadillo -v`
This will print out the version and build information, and exit.
The last command line flag will, for terminal's that support this, change the name of the tab or window that Bombadillo is running in to "Bombadillo". Not all terminals support this behavior, and some that do support it do not support removing it automatically. Most users will not need or want to use this flag, but some users that have a lot of terminal windows open might like to have the name as a reference, so this flag is made available. It can be run as follows:
`bombadillo -t`
The last item in this section is not a flag/option, but an argument. Bombadillo accepts a URL when it is invoked. This will cause Bombadillo to navigate directly to the given URL, rather than load your home page. This behavior can be combined with the `-t` flag, but not with the others.
Examples (run from your terminal's shell):
- `bombadillo bombadillo.colorfield.space`
- `bombadillo -t gopher://bombadillo.colorfield.space`
-- Exiting Bombadillo --
Exiting Bombadillo can be done four different ways. The simplest is to just press the "q" key. This will exit immediately. Alternatively you may use a command (and an abbreviated form of that command) to exit:
`quit`
`q`
Lastly, you can break out of the program by pressing "control" + "c" (while holding the "control" key, press the "c" key). This option should only be used if the program has frozen or you need to exit but the other three ways are not working.
________________________________
This concludes the help section brought up by the following keywords:
quit, quitting, q, flags, runtime, options, exit, exiting, general, startup, version, title
Other sections of the help document:
`help help`
`help navigation`
`help bookmarks`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

0
help/gopher.help Normal file
View File

84
help/help.help Normal file
View File

@ -0,0 +1,84 @@
Using This Guide
---------------------------
The Bombadilo help system is a collection of small "how to" documents about varying aspects of Bombadillo. Some include instructions on what keys to press to achieve certain actions or the syntax for various commands. Others are guides to the kinds of content you will find on the various protocols Bombadillo supports, as well as how Bombadillo interacts with them. Others still are small collections of guides on how certain features work (for example: quitting Bombadillo or writing content to a file).
-- Documentation Syntax --
While reading articles in this help guide you will come across words enclosed in back-ticks, like so: `add 13`. Anytime you see text between back-ticks it represents an actual command that you can run in Bombadillo or your terminal shell. A command will always be noted as a shell command if it is one. Otherwise, you can assume it is a command to be run inside of Bombadillo (see: `help commands`).
Key presses will be notated with double quotes. For example: "a", "B", "w". Keys that do not correspond to characters will be given by name, such as "tab", "space", or "control". Do note that "b" and "B" are different keys, with the later implying the combination of "shift" + "b" (or, if your "caps lock" is on, just "b").
Each page will end with a listing of the keywords that will bring up that page, when combined with the help command. A listing of other pages that can be viewed with the help command will also be included on each page.
-- The Help Command --
The help command can be run in two ways, with an argument and without:
`help [keyword]`
`help`
Running only the help command will load this page. When the help command is run with a keyword Bombadillo will attempt to find a page that can be identified by that keyword. All commands will have a page associated with them, as well as some other groupings of like items (commands, keys), and some pages talk about concepts (bookmarks, help, general). Most of the time just think of a single word that describes what you are looking, Bombadillo strives to make getting help intuitive.
-- Contents --
This is a listing of the available help sections (the keyword given below is the main keyword they are identified with, but many others also exist and are given at the bottom of each article).
1. help - This page
2. general - A guide to running and quitting Bombadillo
3. navigation - How to navigating within a single page, and between pages
4. saving - How to save documents
5. commands - A listing of the available commands and their syntax
6. keys - A listing of the available "hot" keys
7. search - How to use the default search engine
8. settings - How to configure Bombadillo to your liking
9. protocols - A top level guide to each protocol Bombadillo supports
10. gopher - Information about the gopher protocol
11. gemini - Information about the gemini protocol
12. http - Information about the HTTP & HTTPS protocols
13. finger - Information about the finger protocol
13. telnet - Information about the telnet protocol
14. local - Information about how Bombadillo handles local file browsing
15. resources - Places to get additional help or information
16. license - View the software license that Bombadillo is released under
________________________________
This concludes the help section brought up by the following keywords:
help, ?, info, information
Other sections of the help document:
`help general`
`help bookmarks`
`help navigation`
`help saving`
`help commands`
`help keys`
`help search`
`help settings`
`help protocols`
`help gemini`
`help gopher`
`help http`
`help finger`
`help telnet`
`help local`
`help resources`
`help license`

0
help/keys.help Normal file
View File

0
help/license.help Normal file
View File

0
help/navigation.help Normal file
View File

0
help/protocols.help Normal file
View File

0
help/resources.help Normal file
View File

0
help/settings.help Normal file
View File

0
help/telnet.help Normal file
View File