u-read-of/read-status proposed draft

[dshanske]

https://indieweb.org/read

Indiebookclub.biz is a micropub client that publishes this. The Post Kinds plugin displays the posts created by it and allows the creation of posts with the read-of property but does not currently support read-status except as created by Indiebookclub.biz

[gRegorLove]

We have 2+ publishers for p-read-of and p-read-status:

• https://gregorlove.com/2018/06/want-to-read-welcoming-the/
• https://martymcgui.re/2018/06/12/105334/
• all indiebookclub profiles, e.g. https://indiebookclub.biz/users/gregorlove.com

We have 2+ consumers for p-read-of:

• WordPress Post Kinds plugin: https://tiny.n9n.us/2018/06/19/4700/
• micro.blog: http://manton.micro.blog/2018/06/30/185527.html
• indiebookclub accepts a URL parameter on the new post form and parses title, author, and uid from the p-read-of h-cite

p-read-status is not consumed yet, to my knowledge.

I propose adding these as proposed properties:

p-read-of - indicates this h-entry is a read post of some written work (book or other document). The value can be the title of the work or an h-cite. Should be used in conjunction with p-read-status. See https://indieweb.org/read for examples in the wild.

p-read-status - indicates current status of the reading. The value can be one of: to-read, reading, or finished. Should be used in conjunction with p-read-of. See https://indieweb.org/read for examples in the wild.

Edit 1: updated consumers

[chrisaldrich]

I seem to recall @gRegorLove having some reservations about having implemented the read-status indicators. Since there are proposals for watch-of and listen-of and potentially other similar future verbs which may have a variety of "tenses" or a sense of progress across time, I wonder if it may be more advisable to have a completely separate progress/tense related microformat? This would provide the broader benefit of allowing it to be reused in those other cases rather than being specific to the read case only.

Perhaps a grow-able spectrum of statuses like: p-want-to, p-currently, and p-finished? (These are placeholder suggestions as we may do better with some thought on naming). These could be used in combination with the other proposed read, watch, and listen related microformats (or other potential future classes of verbs). The "want" status is reasonably well attested for activities like want to read, want to watch, want to listen, want to buy (or acquire), etc. Most of these are often finished in relatively short (or very long) time frames such that on-going statuses like watching, listening, or owning may not be posted frequently the way that an ongoing "reading" progress-like status might be used over the days, weeks, months that books are being read. I could see myself using ongoing statuses like these being used with to-do list items or project management related functionality as well. Longer term checkins at on-going events (conferences, festivals, vacations, etc.) might benefit from these statuses as well.

Separating the progress (tense) from the verb/action may also make it easier to create collections of posts around the related content. (An example may be the collection of all the posts about a particular book: the want post, the progress posts, notes, annotations, etc.)

On a separate note, I'll mention that @swentel's Indigenous for Android has added publishing support for both p-read-of and p-read-status (as well as all the proposed values) in the past few months.

(Originally published at https://boffosocko.com/2020/08/09/u-read-of-read-status-proposed-draft-%c2%b7-issue-10-%c2%b7-microformats-h-entry/)

Edit: Realizing that this is discussed in #18 as well...

[dshanske]

So, is it u-read-of, indicating the value is a URL of the citation or the work itself, or p-read-of, indicating the value is the title of the work? We need to better define that.