From 113dc50b32d3bf82623e50c2d53ef1de57d76a3d Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Sat, 16 May 2020 18:52:06 +0200 Subject: [PATCH] [bibtex] Update README Updated readme to reflect new filtering options, and highlight the script's brittle nature again. --- bibtex/README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/bibtex/README.md b/bibtex/README.md index 6c8a733..9763a32 100644 --- a/bibtex/README.md +++ b/bibtex/README.md @@ -4,7 +4,7 @@ ## bib-due -The `bib-due` script depends on (gnu) grep, awk, and sed. It is currently written in a rather haphazard way, and prone to breakage. +The `bib-due` script depends on (gnu) grep, awk, and sed, date if using date filtering capabilities. It is currently written in a rather haphazard way, and prone to breakage. On the other hand, it does what it's supposed to do: list bibtex entries which have their due-date coming up. The script needs bibtex entries to be marked with two fields: `due`, containing a due date (ideally in YYYY-MM-DD format, for easy sorting), and `priority` containing a read priority. It will also, by default attempt to grab the values of the fields `author` and `title`, as well as the name of the bibtex key of the entry. @@ -17,6 +17,34 @@ Example output looks as follows: The output can then be filtered further through other programs. +Bib-due itself allows 2 filtering options: *until* a certain date (`-u`), and *at least* a certain priority (`-p`). + +Using priority is relatively self-explanatory: 1 is the highest priority, 3 the lowest (technically, no priority is the lowest). Choosing `-p3` means priority 1, 2, and 3 will be displayed. Choosing `-p1` will only display the highest priority items. + +Using the date works as a cut-off for the future, and it uses gnu `date` to calculate the correct date. That makes things like `-u fri this week'` possible, showing only upcoming items until the end of the week. Read the `date` manual for more information. + +Again, this script will for now break when bibtex files are formatted in any way other than for example this entry: + +``` + +@InBook{Borhi2016, + author = {László Borhi}, + chapter = {1956: Self-Liberation}, + pages = {117--137}, + publisher = {Indiana University Press}, + title = {Dealing with dictators: the {United States}, {Hungary}, and {East Central Europe}, 1942-1989}, + year = {2016}, + due = {2020-05-07}, + file = {:Borhi2016 - Dealing with Dictators_ the United States, Hungary, and East Central Europe, 1942 1989.pdf:PDF}, + pagetotal = {564}, + priority = {prio1}, + timestamp = {2020-05-08}, +} + +``` + +Important fields are author, title, due, priority. These need to exist, and need to be ordered alphabetically. Otherwise there will probably be some breakage. + ## rofi-bib-due The `rofi-bib-due` script utilizes the `bib-due` script and depends on an existing installed `rofi` module (see [here](rofi/)).