Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: notes/comments field #16

Open
gRegorLove opened this issue Mar 10, 2020 · 4 comments
Open

Feature: notes/comments field #16

gRegorLove opened this issue Mar 10, 2020 · 4 comments

Comments

@gRegorLove
Copy link
Owner

Add a notes/comments field which would be set as the e-content of the post and micropub request.

@manton I wanted to check in with you to make sure this wouldn't unexpectedly break anything for micro.blog users.

@manton
Copy link

manton commented Apr 7, 2020

Would the content only include the notes, or would it also include the book name? If it's just the notes, it probably would break Micro.blog slightly, but I can work around it. Micro.blog takes the current summary + metadata and adds it to the blog post content.

Might be worth discussing, though. I feel like this would be confusing for any Micropub endpoint that wasn't set up to understand read-of posts, because the content would change from having the book name, to potentially only having the notes without the book name.

@gRegorLove
Copy link
Owner Author

My initial thought is the notes would only be in the content. Here's an example of what that request would look like. content is the only new key; others would remain the same.

{
  "type": [
    "h-entry"
  ],
  "properties": {
    "summary": [
      "Want to read: Title by Author, ISBN: ISBN"
    ],
    "content": [
      "I am really enjoying this book"
    ],
    "read-status": [
      "to-read"
    ],
    "read-of": [
      {
        "type": [
          "h-cite"
        ],
        "properties": {
          "name": [
            "Title"
          ],
          "author": [
            "Author"
          ],
          "uid": [
            "isbn:ISBN"
          ]
        }
      }
    ]
  }
}

The read-of doesn't change and I expect most micropub servers don't handle them currently. Is micro.blog using any of the read-of properties, e.g. to build a link to the title? I found a friend's example, though I'm now thinking they posted it manually since it has rating stars and links to indiebound (indiebookclub doesn't have those).

I can see this causing problems if a micropub server uses only content and ignores the summary. Putting the generated "want to read..." as the start of the content feels incorrect. I'll check in #dev to see what servers currently do and recommended best practice. I can't think of a good workaround offhand.

@manton
Copy link

manton commented Apr 8, 2020

Micro.blog looks for book name and ISBN in read-of, but it also assumes the name is in the summary. It basically uses the metadata to link the book in the blog post, and also appends a 📚 at the end.

Unless I'm missing something, the problem is that most Micropub endpoints are going to discard summary if content is present. So you'll end up with published blog posts like "This is a great book" without any reference to what the book actually is.

@manton
Copy link

manton commented Jul 16, 2020

I was thinking about this again and realized that indieweb/micropub-extensions#8 could help. IndieBookClub could query a Micropub server for whether it supported the read-of property. If it didn't, IndieBookClub could always send the simplest format (probably making sure all the information and even notes are in summary). If it did support the property, then IndieBookClub would be more free to split out the notes into content and include other details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants