BookWyrm Vocabulary v1.0

Note: This vocabulary is a draft and may change.

BookWyrm servers do not currently send activities in the format shown in these examples, nor reference this vocabulary.

BookWyrm uses the Core and Extended types and properties outlined in the Activity Streams 2.0 Vocabulary.

This page outlines a set of extended object types and properties for BookWyrm, where the Activity Streams Vocabulary is not sufficient for BookWyrm's needs.

Extended Object book types

The basic BookWyrm types are all extensions of the core Activity Streams Object type.

Core book type properties

All types in this section (Work, Edition, Author, Series) have all the properties of Object.

In addition, all types in this section have the following properties:

openlibraryKey: String
inventaireId: String
finnaKey: String
librisKey: String
librarythingKey: String
goodreadsKey: String
bnfId: String
viaf: String
wikidata: String
asin: String
aasin: String
isfdb: String
lastEditedBy: @id

Extended book type properties

In addition to the core properties above, Work and Edition types have the following extended properties:

title: String
sortTitle: String
subtitle: String
description: String
languages: Array
series: String
seriesNumber: String
seriesBooks: Array
subjects: Array
subjectPlaces: Array
authors: Array
firstPublishedDate: String
publishedDate: String
fileLinks: Array
cover: Document

Work

Included in version 1.0 of the BookWyrm vocabulary

A bibliographic work, which manifests in the form of one or more Editions.

Properties

Inherits all the Object, Core book type and Extended book type properties.

In addition, a Work has the following extended properties:

lccn: String
editions: Array

Example

{
    "@context": [
        "https://www.w3id.org/bookwyrm/ns",
        "https://www.w3.org/ns/activitystreams",
    ],
    "id": "https://example.com/book/5988",
    "type": "Work",
    "authors": [
        "https://example.com/author/417"
    ],
    "first_published_date": null,
    "published_date": null,
    "title": "Piranesi",
    "sort_title": null,
    "subtitle": null,
    "description": "**From the *New York Times* bestselling author of *Jonathan Strange & Mr. Norrell*, an intoxicating, hypnotic new novel set in a dreamlike alternative reality.",
    "languages": [],
    "series": null,
    "series_number": null,
    "subjects": [
        "English literature"
    ],
    "subject_places": [],
    "openlibrary_key": "OL20893680W",
    "librarything_key": null,
    "goodreads_key": null,
    "attachment": [
        {
            "url": "https://example.com/images/covers/10226290-M.jpg",
            "type": "Image"
        }
    ],
    "lccn": null,
    "editions": [
        "https://example.com/book/5989"
    ]
}

Edition

Included in version 1.0 of the BookWyrm vocabulary

The manifestation of a Work as a specific edition.

Properties

Inherits all the Object, Core book type and Extended book type properties.

In addition, an Edition has the following extended properties:

work: @id
isbn10: String
isbn13: String
oclcNumber: String
pages: Number
physicalFormat: String
physicalFormatDetail: String
publishers: Array
editionRank: Number

Example

{
    "@context": [
        "https://www.w3id.org/bookwyrm/ns",
        "https://www.w3.org/ns/activitystreams",
    ],
    "id": "https://example.com/book/5989",
    "lastEditedBy": "https://example.net/users/rat",
    "type": "Edition",
    "authors": [
        "https://example.com/author/417"
    ],
    "first_published_date": null,
    "published_date": "2020-09-15T00:00:00+00:00",
    "title": "Piranesi",
    "sort_title": null,
    "subtitle": null,
    "description": "Piranesi's house is no ordinary building; its rooms are infinite, its corridors endless, its walls are lined with thousands upon thousands of statues, each one different from all the others.",
    "languages": [
        "English"
    ],
    "series": null,
    "series_number": null,
    "subjects": [],
    "subject_places": [],
    "openlibrary_key": "OL29486417M",
    "librarything_key": null,
    "goodreads_key": null,
    "isfdb": null,
    "attachment": [
        {
            "url": "https://example.com/images/covers/50202953._SX318_.jpg",
            "type": "Image"
        }
    ],
    "isbn_10": "1526622424",
    "isbn_13": "9781526622426",
    "oclc_number": null,
    "asin": null,
    "pages": 272,
    "physical_format": null,
    "publishers": [
        "Bloomsbury Publishing Plc"
    ],
    "work": "https://example.com/book/5988"
}

Author

Included in version 1.0 of the BookWyrm vocabulary

A creator of a Work or Edition. This includes creative contributions such as editor, illustrator, or translator.

Properties

Inherits all the Object and Core book type properties.

In addition, an Author has the following extended properties:

isni: String
gutenbergId: String
born: String
died: String
aliases: Array
bio: String
wikipediaLink: String
website: String

Example

{
    "@context": [
        "https://www.w3id.org/bookwyrm/ns",
        "https://www.w3.org/ns/activitystreams",
    ],
    "id": "https://example.com/author/1",
    "type": "Author",
    "openlibraryKey": "OL9388A",
    "inventaireId": "wd:Q692",
    "librarythingKey": "shakespearewilliam",
    "goodreadsKey": "947",
    "bnfId": "119246079",
    "viaf": "96994048",
    "wikidata": "Q692",
    "asin": "B000APWKO4",
    "isfdb": "22499",
    "lastEditedBy": "https://example.com/user/avid_reader",
    "name": "William Shakespeare",
    "isni": "0000000121032683",
    "born": "1564-04-19",
    "died": "1616-04-22",
    "aliases": [],
    "bio": "<p>William Shakespeare was an English poet and playwright, widely regarded as the greatest writer in the English language and the world's pre-eminent dramatist.  He is often called England's national poet and the &quot;Bard of Avon&quot;.  His surviving works, including some collaborations, consist of 38 plays,[c]  154 sonnets, two long narrative poems, and several other poems. His plays have been translated into every major living language and are performed more often than those of any other playwright. He has invented over 1700 words and some of them are common, some of them are not. (<a href=\"https://en.wikipedia.org/wiki/William_Shakespeare\">Source</a>.)</p>\n<p>Looking for the '<a href=\"https://openlibrary.org/works/OL362289W/Plays\">First Folio</a>'?</p>",
    "wikipediaLink": "https://en.wikipedia.org/wiki/William_Shakespeare",
    "website": ""
}

Extended Object collection item types

ShelfItem

Included in version 1.0 of the BookWyrm vocabulary

A ShelfItem represents an Edition on a Shelf.

Properties

Inherits all the properties of Object.

In addition, a ShelfItem has the following properties:

book: @id

ListItem

Included in version 1.0 of the BookWyrm vocabulary

A ListItem represents an Edition on a BookList.

Properties

Inherits all the properties of Object.

In addition, a ListItem has the following properties:

book: @id
notes: String
approved: Boolean
order: Number

SuggestionListItem

Included in version 1.0 of the BookWyrm vocabulary

A SuggestionListItem represents a suggested Work on a SuggestionList.

Properties

Inherits all the properties of Object.

In addition, a SuggestionListItem has the following properties:

book: @id
notes: String

SeriesBook

Included in version 1.0 of the BookWyrm vocabulary

A SeriesBook represents the relationship of a Work to a Series.

Properties

Inherits all the properties of Object.

In addition, a SeriesBook has the following properties:

book: @id
series: @id
seriesNumber: String

Extended Note Types

These type are all extensions of the Activity Streams Note object type.

GeneratedNote

Included in version 1.0 of the BookWyrm vocabulary

This type is under review and may be removed in a future version of BookWyrm

An extended Note that is auto-generated by BookWyrm. For example, when a user adds a book to one of their shelves.

There is no other difference between this type and a Note.

Comment

Included in version 1.0 of the BookWyrm vocabulary

An extended Note related to an Edition.

Properties

Inherits all the properties of Note.

In addition, a Comment has the following extended properties:

inReplyToBook: @id
readingStatus: String
progress: int
progressMode: String

Example

{
    "@context": [
        "https://www.w3.org/ns/activitystreams",
        {"bw": "https://www.w3id.org/bookwyrm/ns/"}
    ],
    "id": "https://example.net/user/library_lurker/comment/9",
    "type": ["bw:Comment", "Note"],
    "published": "2023-06-30T21:43:46.013132+00:00",
    "attributedTo": "https://example.net/user/library_lurker",
    "content": "<p>This is a very enjoyable book so far.</p>",
    "to": ["https://example.net/user/library_lurker/followers"],
    "cc": [],
    "replies": {
        "id": "https://example.net/user/library_lurker/comment/9/replies",
        "type": "OrderedCollection",
        "totalItems": 0,
        "first": "https://example.net/user/library_lurker/comment/9/replies?page=1",
        "last": "https://example.net/user/library_lurker/comment/9/replies?page=1",
        "@context": "https://www.w3.org/ns/activitystreams"
        },
    "summary": "Spoilers ahead!",
    "tag": [],
    "attachment": [],
    "sensitive": true,
    "bw:inReplyToBook": "https://example.net/book/1",
    "bw:readingStatus": "reading",
    "bw:progress": 25,
    "bw:progressMode": "PG"
}

Quotation

Included in version 1.0 of the BookWyrm vocabulary

A quotation from an Edition.

Properties

Inherits all the properties of Comment.

In addition, a Quotation has the following extended properties:

quote : String
position: Number
positionMode: String

Example

{
    "@context": [
        "https://www.w3.org/ns/activitystreams",
        {"bw": "https://www.w3id.org/bookwyrm/ns/"}
    ],
    "id": "https://example.net/user/mouse/quotation/13",
    "url": "https://example.net/user/mouse/quotation/13",
    "inReplyTo": null,
    "published": "2020-05-10T02:38:31.150343+00:00",
    "attributedTo": "https://example.net/user/mouse",
    "to": [
        "https://www.w3.org/ns/activitystreams#Public"
        ],
    "cc": [
        "https://example.net/user/mouse/followers"
        ],
    "sensitive": false,
    "content": "I really like this quote",
    "type": ["bw:Quotation", "Note"],
    "replies": {
        "id": "https://example.net/user/mouse/quotation/13/replies",
        "type": "Collection",
        "first": {
            "type": "CollectionPage",
            "next": "https://example.net/user/mouse/quotation/13/replies?only_other_accounts=true&page=true",
            "partOf": "https://example.net/user/mouse/quotation/13/replies",
            "items": []
        }
    },
    "inReplyToBook": "https://example.net/book/1",
    "bw:quote": "To be or not to be, that is the question.",
    "bw:position": 50,
    "bw:positionMode": "PCT",
}

Rating

Included in version 1.0 of the BookWyrm vocabulary

A star rating indicating the actor's impression of the quality of an Edition. This is essentially a review without any text.

Properties

Inherits the properties of Review, however content and name are not used. Although this type inherits from Review, the advertised Activity Streams type is Note rather than Activity.

Example

{
    "@context": [
        "https://www.w3.org/ns/activitystreams",
        {"bw": "https://www.w3id.org/bookwyrm/ns/"}
    ],
    "id": "https://example.com/user/mouse/reviewrating/123",
    "type": ["bw:Rating", "Note"],
    "published": "2026-08-05T15:37:46.054716+00:00",
    "attributedTo": "https://example.com/user/mouse",
    "content": "rated <em><a href=\"https://example.com/book/36497\">The outsider</a></em>: 3 stars",
    "to": [
        "https://www.w3.org/ns/activitystreams#Public"
    ],
    "cc": [
        "https://example.com/user/mouse/followers"
    ],
    "replies": {
        "@context": ["https://www.w3.org/ns/activitystreams"],
        "id": "https://example.com/user/mouse/reviewrating/123/replies",
        "type": "OrderedCollection",
        "totalItems": 0,
        "first": "https://example.com/user/mouse/reviewrating/123/replies?page=1",
        "last": "https://example.com/user/mouse/reviewrating/123/replies?page=1",
    },
    "tag": [],
    "attachment": [
        {
            "type": "Document",
            "url": "https://example.com/images/previews/covers/_2EcfJ15.jpg",
            "name": "Stephen King: The outsider (AudiobookFormat, 2018)",
            "@context": [
                "https://www.w3.org/ns/activitystreams",
                { "Hashtag": "as:Hashtag" }
            ]
        }
    ],
    "sensitive": false,
    "bw:inReplyToBook": "https://example.com/book/36497",
    "bw:rating": 3.0,
    "bw:name": "Review of \"The outsider\" (3 stars): None"
}

Extended Article types

These types inherit all properties from Article.

Review

Included in version 1.0 of the BookWyrm vocabulary

A written review of an Edition.

Properties

Inherits all properties from Article.

In addition, a Review has the following extended properties:

rating: Number

Example

{
    "@context": [
        "https://www.w3.org/ns/activitystreams",
        {"bw": "https://www.w3id.org/bookwyrm/ns/"}
    ],
    "id": "https://example.net/user/library_lurker/review/2",
    "type": ["Review", "Article"],
    "published": "2023-06-30T21:43:46.013132+00:00",
    "attributedTo": "https://example.net/user/library_lurker",
    "content": "<p>This is an enjoyable book with great characters.</p>",
    "to": ["https://example.net/user/library_lurker/followers"],
    "cc": [],
    "replies": {
        "id": "https://example.net/user/library_lurker/review/2/replies",
        "type": "OrderedCollection",
        "totalItems": 0,
        "first": "https://example.net/user/library_lurker/review/2/replies?page=1",
        "last": "https://example.net/user/library_lurker/review/2/replies?page=1",
        "@context": "https://www.w3.org/ns/activitystreams"
        },
    "summary": "Spoilers ahead!",
    "tag": [],
    "attachment": [],
    "sensitive": true,
    "bw:inReplyToBook": "https://example.net/book/1",
    "bw:name": "What a cracking read",
    "bw:rating": 4.5
}

Extended OrderedCollection types

These type are all based on the Activity Streams OrderedCollection core object types.

OrderedCollection extended properties

Types in this group have all the properties of OrderedCollection.

In addition, all extended OrderedCollection types have the following properties:

owner: @id

Other than Series, these types make use of the to and cc properties of Object to enable privacy controlled collections.

Shelf

Included in version 1.0 of the BookWyrm vocabulary

This type is under review and may be removed in a future version of BookWyrm

A Shelf is a collection of Edition objects. Shelves are used to indicate the reading status of an Edition.

Properties

Shelf inherits all the OrderedCollection extended properties.

Example

{
    "id": "https://example.net/user/avid_reader/books/extraspecialbooks-5",
    "type": "Shelf",
    "totalItems": 0,
    "first": "https://example.net/user/avid_reader/books/extraspecialbooks-5?page=1",
    "last": "https://example.net/user/avid_reader/books/extraspecialbooks-5?page=1",
    "name": "Extra special books",
    "owner": "https://example.net/user/avid_reader",
    "to": [
        "https://www.w3.org/ns/activitystreams#Public"
    ],
    "cc": [
        "https://example.net/user/avid_reader/followers"
    ],
    "@context": "https://www.w3.org/ns/activitystreams"
}

BookList

Included in version 1.0 of the BookWyrm vocabulary

A BookList is a collection of Edition objects, grouped together by an Actor for any arbitrary reason. Items in a BookList are defined in ListItem

Properties

BookList inherits all the OrderedCollection extended properties.

In addition, BookList has the following properties:

curation: String

Example

{
    "id": "https://example.net/list/1",
    "type": "BookList",
    "totalItems": 0,
    "first": "https://example.net/list/1?page=1",
    "last": "https://example.net/list/1?page=1",
    "name": "My cool list",
    "owner": "https://example.net/user/avid_reader",
    "to": [
        "https://www.w3.org/ns/activitystreams#Public"
    ],
    "cc": [
        "https://example.net/user/avid_reader/followers"
    ],
    "summary": "A list of books I like.",
    "curation": "curated",
    "@context": "https://www.w3.org/ns/activitystreams"
}

SuggestionList

Included in version 1.0 of the BookWyrm vocabulary

A SuggestionList is a collection of SuggestionListItem objects that can be added to by any Actor. A SuggestionList represents suggested works that may be similar to a given Work identified by the book property.

Properties

SuggestionList inherits all the OrderedCollection extended properties.

In addition, SuggestionList has the following properties:

book: @id

Example

TODO

Series

Included in version 1.0 of the BookWyrm vocabulary

A Series is a collection of SeriesBook objects representing Work objects in a formal series. An example of a series is "The Lord of the Rings" by J.R.R. Tolkien.

Properties

Series inherits all the OrderedCollection extended properties but does not use to or cc from Object as there is no concept of "privacy" for Series objects.

alternativeNames: Array

Example

TODO

Properties

aasin

Included in version 1.0 of the BookWyrm vocabulary

An Amazon Standard Identification Number for an Audible audiobook. The same audiobook may have a different ASIN when sold by Amazon directly.

Type: String

Used on: Work, Edition, Author, Series

aliases

Included in version 1.0 of the BookWyrm vocabulary

Alternative names an author may be known by.

Type: Array of Strings

Used on: Author

alternativeNames

Included in version 1.0 of the BookWyrm vocabulary

Alternative names a series may be known by.

Type: Array of Strings

Used on: Series

approved

Included in version 1.0 of the BookWyrm vocabulary

Indicates whether a ListItem has been approved for inclusion in a BookList. This is only relevant for lists where the value of curation is curated.

Type: Boolean

Used on: ListItem

asin

Included in version 1.0 of the BookWyrm vocabulary

An Amazon Standard Identification Number.

Type: String

Used on: Work, Edition, Author, Series

authors

Included in version 1.0 of the BookWyrm vocabulary

The Authors associated with a Work or Edition.

Type: Array of @ids

Used on: Work, Edition

bio

Included in version 1.0 of the BookWyrm vocabulary

Biographical information about an Author.

Type: String

Used on: Author

bnfId

Included in version 1.0 of the BookWyrm vocabulary

Unique identifier assigned by the Bibliothèque nationale de France (National library of France).

Type: String

Used on: Work, Edition, Author, Series

book

Included in version 1.0 of the BookWyrm vocabulary

A book related to another object. This may represent either a Work or an Edition depending on the object it is a property of.

Type: @id

Used on: ListItem, SeriesBook, ShelfItem, SuggestionList, SuggestionListItem

born

Included in version 1.0 of the BookWyrm vocabulary

The birth date of an Author in the format YYYY-MM-DD. This represents a date but takes the form of a string.

Type: String

Used on: Author

cover

Included in version 1.0 of the BookWyrm vocabulary

The cover image for a book.

Type: Document

Used on: Work, Edition

curation

Included in version 1.0 of the BookWyrm vocabulary

The type of curation for a BookList. Possible values are:

closed: only the owner may add items to the list
open: any other Actor may add to the list.
curated: Any other Actor may add to the list, however the item must be approved by the owner.
group: Any other member of the group may add to the list.

Type: String

Used on: BookList

Note: BookWyrm Groups are not currently ActivityPub objects.

description

Included in version 1.0 of the BookWyrm vocabulary

A brief description or blurb for a book.

Type: String

Used on: Work, Edition

Note: This is used rather than summary because summary is widely used within the fediverse (including BookWyrm) as a "content warning" property.

died

Included in version 1.0 of the BookWyrm vocabulary

The date of death for an Author in the format YYYY-MM-DD. This represents a date but takes the form of a string.

Type: String

Used on: Author

editionRank

Included in version 1.0 of the BookWyrm vocabulary

A preferential ranking for an Edition in comparison to other editions with the same parent work, based on the completeness of the Edition object's metadata. Edition objects with more complete will have a higher rank represented by a lower integer. This is used to determine which edition will be considered the "default".

Type: Number

Used on: Edition

editions

Included in version 1.0 of the BookWyrm vocabulary

A list of Edition objects that derive from a Work.

Type: Array of ids

Used on: Work

fileLinks

Included in version 1.0 of the BookWyrm vocabulary

A list of URLs representing web locations for a digital copy of a book.

Type: Array of URL Strings

Used on: Work, Edition

finnaKey

Included in version 1.0 of the BookWyrm vocabulary

The id field for any record from the National Library of Finland's Finna.fi catalogue.

Type: String

Used on: Work, Edition, Author, Series

firstPublishedDate

Included in version 1.0 of the BookWyrm vocabulary

The first known publication date for a book in the format YYYY-MM-DD. This represents a date but takes the form of a string.

Type: String

Used on: Work, Edition

goodreadsKey

Included in version 1.0 of the BookWyrm vocabulary

The unique identifier for any record from GoodReads.

Type: String

Used on: Work, Edition, Author, Series

gutenbergId

Included in version 1.0 of the BookWyrm vocabulary

The unique identifier for an author from Project Gutenberg.

Type: String

Used on: Author

inReplyToBook

Included in version 1.0 of the BookWyrm vocabulary

Represents an Edition that is the subject of the content of an object. For example the book that is being reviewed.

Type: @id

Used on: Comment, Quotation, Rating, Review

inventaireId

Included in version 1.0 of the BookWyrm vocabulary

The unique identifier for any record from Inventaire.

Type: String

Used on: Work, Edition, Author, Series

Note: Inventaire identifiers are often, but not necessarily the same as wikidata ids

isbn10

Included in version 1.0 of the BookWyrm vocabulary

An International Standard Book Number (ISBN). isbn10 is the original 10-digit format for ISBNs.

Type: String

Used on: Work, Edition

isbn13

Included in version 1.0 of the BookWyrm vocabulary

An International Standard Book Number (ISBN). isbn13 is the modern 13-digit format for ISBNs.

Type: String

Used on: Work, Edition

isfdb

Included in version 1.0 of the BookWyrm vocabulary

The unique identifier for a record in the Internet Speculative Fiction Database.

Type: String

Used on: Work, Edition, Author, Series

isni

Included in version 1.0 of the BookWyrm vocabulary

The International Standard Name Identifier for an author.

Type: String

Used on: Author

languages

Included in version 1.0 of the BookWyrm vocabulary

A list of the languages in which a book has been published.

Type: Array of Strings.

Used on: Work, Edition

Note: This is an uncontrolled field and may itself be written in multiple languages.

lastEditedBy

Included in version 1.0 of the BookWyrm vocabulary

An actor who last made changes to an object.

Type: @id

Used on: Work, Edition, Author, Series

lccn

Included in version 1.0 of the BookWyrm vocabulary

The Library of Congress Control Number for a work.

Type: String

Used on: Work

librarythingKey

Included in version 1.0 of the BookWyrm vocabulary

A unique identifier from Library Thing.

Type: String

Used on: Work, Edition, Author, Series

librisKey

Included in version 1.0 of the BookWyrm vocabulary

Unique identifier from the Swedish libraries' union catalogue Libris.

Type: String

Used on: Work, Edition, Author, Series

Used on: Author, Review

notes

Included in version 1.0 of the BookWyrm vocabulary

A brief explanatory note.

Type: String

Used on: ListItem, SuggestionListItem

oclcNumber

Included in version 1.0 of the BookWyrm vocabulary

Unique identifier for an edition recorded in OCLC's WorldCat. This is formally known as the OCLC Control Number and may be recorded in other systems, especially library catalogues.

Type: String

Used on: Edition

openlibraryKey

Included in version 1.0 of the BookWyrm vocabulary

Unique identifier for records from Open Library.

Type: String

Used on: Work, Edition, Author, Series

order

Included in version 1.0 of the BookWyrm vocabulary

An item's place in a sequential order.

Type: Number

Used on: ListItem

owner

Included in version 1.0 of the BookWyrm vocabulary

The Actor who created an object.

Type: @id

Used on: BookList, Series, Shelf, SuggestionList

pages

Included in version 1.0 of the BookWyrm vocabulary

The number of pages in a book.

Type: Number

Used on: Work, Edition

physicalFormat

Included in version 1.0 of the BookWyrm vocabulary

The physical format of a book. For example "Paperback". This is a controlled field in the BookWyrm user interface. Options are:

AudiobookFormat
EBook
GraphicNovel
Hardcover
Paperback

Type: String

Used on: Work, Edition

physicalFormatDetail

Included in version 1.0 of the BookWyrm vocabulary

More specific detail regarding the physical format of a book. For example "spiral bound". This is a free text field in the BookWyrm user interface.

Type: String

Used on: Work, Edition

position

Included in version 1.0 of the BookWyrm vocabulary

The position within a book in which a quote appears.

Type: Number

Used on: Quotation

positionMode

Included in version 1.0 of the BookWyrm vocabulary

The measure that position represents. This is a controlled field in the BookWyrm user interface. Options are:

PG representing "pages"
PCT representing "percentage"

Type: String

Used on: Quotation

progress

Included in version 1.0 of the BookWyrm vocabulary

How much of a book an Actor has read.

Type: Number

Used on: Comment

progressMode

Included in version 1.0 of the BookWyrm vocabulary

The measure that progress represents. This is a controlled field in the BookWyrm user interface. Options are:

PG representing "pages"
PCT representing "percentage"

Type: String

Used on: Comment

publishedDate

Included in version 1.0 of the BookWyrm vocabulary

The publication date for a specific book in the format YYYY-MM-DD. This represents a date but takes the form of a string.

Type: String

Used on: Work, Edition

publishers

Included in version 1.0 of the BookWyrm vocabulary

A list of publishers of a book.

Type: Array of Strings

Used on: Edition

quote

Included in version 1.0 of the BookWyrm vocabulary

The text of a quotation from a book.

Type: String

Used on: Quotation

Note: Quotation objects can be coerced into a Note. Applications that implement FEP-044f quote-posts also have a quote property which references another Note by its id. Care should be taken to ensure the quote property is handled correctly according to each context.

rating

Included in version 1.0 of the BookWyrm vocabulary

A star rating indicating the Actor's impression of the quality of an Edition.

Type: Number

Used on: Rating, Review

readingStatus

Included in version 1.0 of the BookWyrm vocabulary

A status indicating an Actor's overall reading progress for an Edition. This is a controlled field in the BookWyrm user interface. Options are:

to-read
reading
read
stopped-reading

Type: String

Used on: Comment

Note: Currently there is a strong relationship between readingStatus and ShelfItem, and every BookWyrm user has a Shelf with an identifier that matches the reading status options listed above. This may change in future.

series

Included in version 1.0 of the BookWyrm vocabulary

The name of a series of books, or the @id of a Series.

Type: String or @id

Used on: Work, Edition, SeriesBook

Note: When used on Work or Edition, series is a legacy property retained for backwards-compatibility. The correct way to identify Series objects associated with a Work is to dereference any associated SeriesBook objects and their series property.

seriesBooks

Included in version 1.0 of the BookWyrm vocabulary

A list of SeriesBook associated with a book.

Type: Array of @ids

Used on: Work

Note: This property was formerly also used on Edition. Some BookWyrm instances may still send Edition objects with the seriesBook property.

seriesNumber

Included in version 1.0 of the BookWyrm vocabulary

The name of a series of books, or the @id of a Series.

Type: String

Used on: Work, Edition, SeriesBook

Note: When used on Work or Edition, seriesNumber is a legacy property retained for backwards-compatibility. The correct way to identify the series number associated with a Work is to dereference any associated SeriesBook objects and their seriesNumber property.