Merge pull request #70 from out-of-cheese-error/feat/document_title

Feat/document title

Author: Ninjani

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: -- -D warnings
+#          args: -- -D warnings
 
 #  coverage:
 #    name: Code coverage

CHANGELOG.md

@@ -6,9 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+
 ### Fixed
+
 * truncates filename if over 250 characters
 
+### Added
+
+* The web-page/document `title` can be used in the annotation template, hierarchy, and sort configurations (
+  Issue [#69](https://github.com/out-of-cheese-error/gooseberry/issues/69))
+* `gooseberry uri` and `Shift-Up` option to `gooseberry search` that prints out the set of URIs associated with a list of selected annotations.
+
 ## [0.6.0] - 2021-03-10
 
 ### Added

Cargo.lock

@@ -13,7 +13,7 @@ include = ["src/**/*", "README.md"]
 
 [dependencies]
 # Hypothesis
-hypothesis = { version = "0.8.0", default-features = false }
+hypothesis = { version = "0.9.1", default-features = false }
 tokio = { version = "1.3.0", features = ["macros"] }
 
 # To extract the base URI
@@ -57,6 +57,9 @@ indicatif = "0.15.0"
 # Templating markdown
 handlebars = "3.5.3"
 
+# Sanitizing filenames
+sanitize-filename = "0.3.0"
+
 [dev-dependencies]
 assert_cmd = "1.0.3"
 predicates = "1.0.7"

Cargo.toml

@@ -104,7 +104,7 @@ Then ran `gooseberry make` to make an `mdBook` style wiki which I could then ope
 
 ![Tag page example](data/images/wiki.png)
 
-Or an Obsidian style wiki, with annotations grouped into folders based on their base URI
+Or an Obsidian style wiki, with annotations grouped into folders based on the document/web-page title
 
 ![Obsidian example](data/images/obsidian_example.png)
 
@@ -170,6 +170,7 @@ The following keys can be used inside the template
 * `{{ uri }}` - Annotation URI
 * `{{ base_uri }}` - Base website of URI, i.e just the protocol and domain.
     * e.g. https://github.com/rust-lang/cargo?asdf becomes https://github.com/
+* `{{ title }}` - Title of webpage/article/document
 * `{{ incontext }}` - Link to annotation in context (opens the Hypothesis sidebar and focuses on the annotation)
 * `highlight` - List of selected/highlighted lines from document (split by newline)
 * `{{ text }}` - The text content of the annotation body
@@ -276,6 +277,7 @@ The available options are:
 * Tag - Groups annotations by tag
 * URI - Groups annotations by their URI
 * BaseURI - Groups annotations by their base URI
+* Title - Group annotations by the title of their webpage/article/document
 * ID - Groups annotations by annotation ID.
 
 Multiple hierarchies combined make folders and sub-folders, with the last entry defining pages.
@@ -298,6 +300,7 @@ The available options are:
 * Tag - Sorts by tag (multiple tags are considered as "tag1,tag2,tag3" for sorting)
 * URI
 * BaseURI
+* Title
 * ID
 * Created
 * Updated

README.md

@@ -6,7 +6,7 @@ use chrono::Utc;
 use color_eyre::Help;
 use dialoguer::{theme, Confirm, Input, Select};
 use directories_next::{ProjectDirs, UserDirs};
-use hypothesis::annotations::{Annotation, Permissions, Selector, Target, UserInfo};
+use hypothesis::annotations::{Annotation, Document, Permissions, Selector, Target, UserInfo};
 use hypothesis::{Hypothesis, UserAccountID};
 use serde::{Deserialize, Serialize};
 
@@ -26,7 +26,7 @@ Tags: {{#each tags}}{{this}}{{#unless @last}}, {{/unless}}{{/each}}
 
 {{text}}
 
-[See in context]({{incontext}})
+[See in context]({{incontext}}) at [{{title}}]({{uri}})
 
 "#;
 pub static DEFAULT_PAGE_TEMPLATE: &str = r#"
@@ -43,6 +43,7 @@ pub enum OrderBy {
     Tag,
     URI,
     BaseURI,
+    Title,
     ID,
     Empty,
     Created,
@@ -55,6 +56,7 @@ impl fmt::Display for OrderBy {
             OrderBy::Tag => write!(f, "tag"),
             OrderBy::URI => write!(f, "uri"),
             OrderBy::BaseURI => write!(f, "base_uri"),
+            OrderBy::Title => write!(f, "title"),
             OrderBy::ID => write!(f, "id"),
             OrderBy::Empty => write!(f, "empty"),
             OrderBy::Created => write!(f, "created"),
@@ -373,6 +375,7 @@ file_extension = '{}'
             OrderBy::Tag,
             OrderBy::URI,
             OrderBy::BaseURI,
+            OrderBy::Title,
             OrderBy::ID,
         ];
         let order = Self::get_order_bys(selections)?;
@@ -406,6 +409,7 @@ file_extension = '{}'
             OrderBy::URI,
             OrderBy::BaseURI,
             OrderBy::ID,
+            OrderBy::Title,
             OrderBy::Created,
             OrderBy::Updated,
         ];
@@ -512,6 +516,12 @@ file_extension = '{}'
                 .collect(),
                 hidden: false,
                 flagged: false,
+                document: Some(Document {
+                    title: vec!["Web page title".into()],
+                    dc: None,
+                    highwire: None,
+                    link: vec![],
+                }),
                 references: vec![],
                 user_info: Some(UserInfo {
                     display_name: Some("test_display_name".to_string()),
@@ -597,6 +607,12 @@ file_extension = '{}'
                 .collect(),
                 hidden: false,
                 flagged: false,
+                document: Some(Document {
+                    title: vec!["Web page title".into()],
+                    dc: None,
+                    highwire: None,
+                    link: vec![],
+                }),
                 references: vec![],
                 user_info: Some(UserInfo {
                     display_name: Some("test_display_name".to_string()),

data/images/obsidian_example.png

@@ -66,6 +66,14 @@ pub enum GooseberrySubcommand {
         #[structopt(conflicts_with = "filters")]
         id: Option<String>,
     },
+    /// Get the set of URIs from a list of (optionally filtered) annotations
+    Uri {
+        #[structopt(flatten)]
+        filters: Filters,
+        /// list of comma-separated annotation IDs
+        #[structopt(use_delimiter = true)]
+        ids: Vec<String>,
+    },
     /// Create your knowledge-base text files
     Make {
         /// Don't ask for confirmation before clearing knowledge base directory