readit

Tooling for managing structured reading notes for scientific publications

git clone https://git.8pit.net/readit.git

 1* Allow execution with cpp(1) to support #include as
 2  done by calendar(1) and the Xresources parser.
 3* Allow associating more information with references,
 4  for instance to allow referencing specific pages
 5* Less syntactic restrictions for optional notes
 6	* Allow references in notes
 7	* Allow newlines in note entries. Alternatively, explicitly
 8	  advocated single-lines notes for clarity. Figure out what
 9	  works best by experimenting with this a bit.
10	* Allow markdown-like syntax, e.g. headings, et cetera
11* Consider allowing specific unicode characters as note start
12  characters. For example ↳ or →.
13* Considering adding support for an "in-progress" entry state (e.g. |).
14* Experiment with using wikidata IDs for topics (e.g. Q179310)
15
16* Add readit-def tool for finding the line number and file where a
17  reading list entry has been defined. This has to be done after CPP
18  integration as CPP integration (#include) will make doing so more
19  difficult.
20	* If combined with CPP integration parsing of CPP markers is necessary
21	* Syntax for CPP markers maybe vary across different implementations
22	* For GCC documented here: https://gcc.gnu.org/onlinedocs/gcc-7.2.0/cpp/Preprocessor-Output.html#Preprocessor-Output
23* Add readit-fields tool for finding fields by value
24	* Should allow listing all field names, like `beet fields` to
25	  ensure consistency regarding entry field names
26
27* Alternative design: Use markdown for notes, only use readit format for
28  fields. This would be similar to Jekyll's approach for combining
29  metadata with text by using markdown with inline yaml.