Glossary of terms

A name referring to a location. This name has the location being referred to and an optional program to open the target resource in the location.

A line in a bookmark file that records the details of a bookmark. A bookmark entry has got three fields, namely

See category

A class of bookmarks, usually on one subject. A category is a file in the "bookmarks" directory with bookmark entries. This is the one that hlg reads every time a request is made.

A bookmark whose location does not link to another resource. Instead, the location executes a command through a given script or an inline script.

The main file in which user options are stored. To edit the file, you enter hlg --edit-configuration and make any adjustments before saving it. The configuration file entries are in the .toml format.

A directory in the $HLG_HOME called "bookmarks" with the files holding bookmark entries.

A category in which all bookmarks that are not fully-qualified are looked for. This category is set in the configuration file under the option "default-category"

A comment about the bookmark entry made on a line starting with a hash mark # character. Description is one of the metadata types.

A bookmark marked as a favorite in a database by appending a plus sign (+) It can be launched by simply passing the plus sign to hlg

A program set to open or handle a location of a bookmark. The handler is entered in the third field of bookmark entry

A category holding the main home bookmark. This category may be different from the default category.

A bookmark marked with a star (or asterisk) (written as *) in a category bookmark file. This is the bookmark that is opened by hlg when no bookmark name is passed to it in any category. Each category must not have more than one bookmark marked as a home bookmark. To launch the default category home bookmark, you enter hlg .

A script whose entire contents are typed in the location field of a bookmark entry.

A pair of parentheses attached at the end of the bookmark name. Inside the parentheses is placed the desired shortcut key.

A bookmark whose location links to some other resource on the local or remote computer.

The second field in the bookmark entry that resolves to some destination. There are three types of location, namely:

A bookmark that is launched by hlg when called without any argument. This bookmark is set in the configuration file under the "home" option. When the "home" option is not set in the configuration file, the home bookmark of the default category becomes the main home bookmark.

Extra information given to a bookmark entry. A metadata entry is made on a separate line just above the line with a bookmark entry. It starts with a hash mark # character. Metadata can contain either a description, a tag or both. When both description and tags are present, the description is entered first before the tags.

An entry in the configuration file. This is where a user sets her or his option. Each entry is formatted like this: option-name = "<value>" and the desired choice is entered in the value placeholder in quotes for a chosen option-name. The toml language is used in options.

A bookmark whose location field targets another bookmark.

A category that cannot be renamed or deleted as this will result in errors in resolving bookmark names. The default and the home-linked categories are the safe categories.

A single key passed to hlg as an argument to launch a bookmark with the assigned key. This key is either alphabetic or numeric. No two bookmarks in hlg can use the single shortcut key.

A single keystroke passed as an argument to hlg which is not numeric or alphabetic. This key launches some designated bookmark.

Keywords on the bookmark entry. This is the other type of metadata attached to the bookmark entry besides the description. A tag, or a group of tags is denoted by square brackets [] on the line starting with a hash mark character #

The end point of a location field in a bookmark. This is the destination of a bookmark.