Appendix A: Sample Bookmark File

The following is a single category file — call it “web” — showing most of what this manual covers in one place: a category header, plain and flagged bookmarks, comments and tags, a shortcut key, a deactivated entry, and a subcategory with its own key and home.

*w <@thetextsmith.com> My web bookmarks

# The Rust programming language, official book [rust programming book]
the-rust-book <@doc.rust-lang.org/book/>

# A search engine [search]
google? <@google.com>

# An old project I'm not using right now [old]
old-project- <@old-project.example.com/>

recipes(r) <@allrecipes.com> :firefox

news : {
*n <@cnn.com> breaking news, straight from the source
    # Breaking news, straight from the source [breaking urgent]
    breaking(b) <@cnn.com/breaking>

    world <@cnn.com/world>
}

A few things to notice, matched up with where each is covered in the manual:

• The header line (*w <@thetextsmith.com> My web bookmarks) gives the whole category a shortcut key (w), a home bookmark, and a description — Chapter 2.
• the-rust-book is a plain local bookmark using the @ link shortcut — Chapter 3.
• google? is flagged as a search bookmark — Chapter 5.
• old-project- is deactivated — hande skips right past it — Chapter 5.
• recipes(r) carries its own shortcut key and an explicit handler — Chapter 3 and Chapter 5.
• news : { ... } is a subcategory with its own header line (a key, a home location, and a description) right after its opening, holding two bookmarks of its own — one of them, breaking(b), with a key of its own too — Chapter 2.
• Every comment line above a bookmark carries both a description and a set of tags in brackets — Chapter 5.

Reachable from anywhere as: web.the-rust-book, web.recipes (or @wr), web.news.breaking (or @wnb), and web. or @w for the category’s own home.