Merge pull request #919 from arkhi/structured-data

Add structured data to Book

bookwyrm/templates/book/book.html

@@ -6,24 +6,36 @@
 {% block title %}{{ book.title }}{% endblock %}
 
 {% block content %}
-<div class="block">
+{% with user_authenticated=request.user.is_authenticated can_edit_book=perms.bookwyrm.edit_book %}
+<div class="block" itemscope itemtype="https://schema.org/Book">
     <div class="columns is-mobile">
         <div class="column">
             <h1 class="title">
-                {{ book.title }}{% if book.subtitle %}:
-                <small>{{ book.subtitle }}</small>{% endif %}
+                <span itemprop="name">
+                    {{ book.title }}{% if book.subtitle %}:
+                        <small>{{ book.subtitle }}</small>
+                    {% endif %}
+                </span>
+
                 {% if book.series %}
-                <small class="has-text-grey-dark">({{ book.series }}{% if book.series_number %} #{{ book.series_number }}{% endif %})</small><br>
+                    <meta itemprop="isPartOf" content="{{ book.series }}">
+                    <meta itemprop="volumeNumber" content="{{ book.series_number }}">
+
+                    <small class="has-text-grey-dark">
+                        ({{ book.series }}
+                        {% if book.series_number %} #{{ book.series_number }}{% endif %})
+                    </small>
+                    <br>
                 {% endif %}
             </h1>
             {% if book.authors %}
             <h2 class="subtitle">
-                {% trans "by" %} {% include 'snippets/authors.html' with book=book %}
+            {% trans "by" %} {% include 'snippets/authors.html' with book=book %}
             </h2>
             {% endif %}
         </div>
 
-        {% if request.user.is_authenticated and perms.bookwyrm.edit_book %}
+        {% if user_authenticated and can_edit_book %}
         <div class="column is-narrow">
             <a href="{{ book.id }}/edit">
                 <span class="icon icon-pencil" title="{% trans "Edit Book" %}">
@@ -44,7 +56,7 @@
                 {% include 'snippets/shelve_button/shelve_button.html' %}
             </div>
 
-            {% if request.user.is_authenticated and not book.cover %}
+            {% if user_authenticated and not book.cover %}
             <div class="block">
                 {% trans "Add cover" as button_text %}
                 {% include 'snippets/toggle/toggle_button.html' with text=button_text controls_text="add-cover" controls_uid=book.id focus="modal-title-add-cover" class="is-small" %}
@@ -60,7 +72,7 @@
                     {% if book.isbn_13 %}
                     <div class="is-flex is-justify-content-space-between is-align-items-center">
                         <dt>{% trans "ISBN:" %}</dt>
-                        <dd>{{ book.isbn_13 }}</dd>
+                        <dd itemprop="isbn">{{ book.isbn_13 }}</dd>
                     </div>
                     {% endif %}
 
@@ -89,14 +101,31 @@
 
         <div class="column is-three-fifths">
             <div class="block">
-                <h3 class="field is-grouped">
+                <h3
+                    class="field is-grouped"
+                    itemprop="aggregateRating"
+                    itemscope
+                    itemtype="https://schema.org/AggregateRating"
+                >
+                    <meta itemprop="ratingValue" content="{{ rating|floatformat }}">
+                    {# @todo Is it possible to not hard-code the value? #}
+                    <meta itemprop="bestRating" content="5">
+                    <meta itemprop="reviewCount" content="{{ review_count }}">
+
                     {% include 'snippets/stars.html' with rating=rating %}
-                    {% blocktrans count counter=review_count %}({{ review_count }} review){% plural %}({{ review_count }} reviews){% endblocktrans %}
+
+                    {% blocktrans count counter=review_count trimmed %}
+                        ({{ review_count }} review)
+                    {% plural %}
+                        ({{ review_count }} reviews)
+                    {% endblocktrans %}
                 </h3>
 
-                {% include 'snippets/trimmed_text.html' with full=book|book_description %}
+                {% with full=book|book_description itemprop='abstract' %}
+                    {% include 'snippets/trimmed_text.html' %}
+                {% endwith %}
 
-                {% if request.user.is_authenticated and perms.bookwyrm.edit_book and not book|book_description %}
+                {% if user_authenticated and can_edit_book and not book|book_description %}
                 {% trans 'Add Description' as button_text %}
                 {% include 'snippets/toggle/open_button.html' with text=button_text controls_text="add-description" controls_uid=book.id focus="id_description" hide_active=True id="hide-description" %}
 
@@ -138,7 +167,7 @@
                 {% endfor %}
             </div>
 
-            {% if request.user.is_authenticated %}
+            {% if user_authenticated %}
             <section class="block">
                 <header class="columns">
                     <h2 class="column title is-5 mb-1">{% trans "Your reading activity" %}</h2>
@@ -176,14 +205,15 @@
         </div>
         <div class="column is-one-fifth">
             {% if book.subjects %}
-            <section class="content block">
-                <h2 class="title is-5">{% trans "Subjects" %}</h2>
-                <ul>
-                {% for subject in book.subjects %}
-                    <li>{{ subject }}</li>
-                {% endfor %}
-                </ul>
-            </section>
+                <section class="content block">
+                    <h2 class="title is-5">{% trans "Subjects" %}</h2>
+
+                    <ul>
+                        {% for subject in book.subjects %}
+                            <li itemprop="about">{{ subject }}</li>
+                        {% endfor %}
+                    </ul>
+                </section>
             {% endif %}
 
             {% if book.subject_places %}
@@ -229,41 +259,54 @@
             {% endif %}
         </div>
     </div>
-</div>
 
-<div class="block" id="reviews">
-    {% for review in reviews %}
-    <div class="block">
-        {% include 'snippets/status/status.html' with status=review hide_book=True depth=1 %}
-    </div>
-    {% endfor %}
-
-    <div class="block is-flex is-flex-wrap-wrap">
-        {% for rating in ratings %}
-        <div class="block mr-5">
-            <div class="media">
-                <div class="media-left">{% include 'snippets/avatar.html' with user=rating.user %}</div>
-                <div class="media-content">
-                    <div>
-                        <a href="{{ rating.user.local_path }}">{{ rating.user.display_name }}</a>
-                    </div>
-                    <div class="is-flex">
-                        <p class="mr-1">{% trans "rated it" %}</p>
-                        {% include 'snippets/stars.html' with rating=rating.rating %}
-                    </div>
-                    <div>
-                        <a href="{{ rating.remote_id }}">{{ rating.published_date | naturaltime }}</a>
-                    </div>
-                </div>
+    <div class="block" id="reviews">
+        {% for review in reviews %}
+            <div
+                class="block"
+                itemprop="review"
+                itemscope
+                itemtype="https://schema.org/Review"
+            >
+                {% with status=review hide_book=True depth=1 %}
+                    {% include 'snippets/status/status.html' %}
+                {% endwith %}
             </div>
-        </div>
         {% endfor %}
-    </div>
-    <div class="block">
-        {% include 'snippets/pagination.html' with page=reviews path=book.local_path anchor="#reviews" %}
+
+        <div class="block is-flex is-flex-wrap-wrap">
+            {% for rating in ratings %}
+                {% with user=rating.user %}
+                    <div class="block mr-5">
+                        <div class="media">
+                            <div class="media-left">
+                                {% include 'snippets/avatar.html' %}
+                            </div>
+
+                            <div class="media-content">
+                                <div>
+                                    <a href="{{ user.local_path }}">{{ user.display_name }}</a>
+                                </div>
+                                <div class="is-flex">
+                                    <p class="mr-1">{% trans "rated it" %}</p>
+
+                                    {% include 'snippets/stars.html' with rating=rating.rating %}
+                                </div>
+                                <div>
+                                    <a href="{{ rating.remote_id }}">{{ rating.published_date | naturaltime }}</a>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                {% endwith %}
+            {% endfor %}
+        </div>
+        <div class="block">
+            {% include 'snippets/pagination.html' with page=reviews path=book.local_path anchor="#reviews" %}
+        </div>
     </div>
 </div>
-
+{% endwith %}
 {% endblock %}
 
 {% block scripts %}

bookwyrm/templates/book/publisher_info.html

@@ -1,24 +1,69 @@
+{% spaceless %}
+
 {% load i18n %}
+
 <p>
-    {% if book.physical_format and not book.pages %}
-    {{ book.physical_format | title }}
-    {% elif book.physical_format and book.pages %}
-    {% blocktrans with format=book.physical_format|title pages=book.pages %}{{ format }}, {{ pages }} pages{% endblocktrans %}
-    {% elif book.pages %}
-    {% blocktrans with pages=book.pages %}{{ pages }} pages{% endblocktrans %}
-    {% endif %}
+    {% with format=book.physical_format pages=book.pages %}
+        {% if format %}
+            {% comment %}
+                @todo The bookFormat property is limited to a list of values whereas the book edition is free text.
+                @see https://schema.org/bookFormat
+            {% endcomment %}
+            <meta itemprop="bookFormat" content="{{ format }}">
+        {% endif %}
+
+        {% if pages %}
+            <meta itemprop="numberOfPages" content="{{ pages }}">
+        {% endif %}
+
+        {% if format and not pages %}
+            {% blocktrans %}{{ format }}{% endblocktrans %}
+        {% elif format and pages %}
+            {% blocktrans %}{{ format }}, {{ pages }} pages{% endblocktrans %}
+        {% elif pages %}
+            {% blocktrans %}{{ pages }} pages{% endblocktrans %}
+        {% endif %}
+    {% endwith %}
 </p>
+
 {% if book.languages %}
-<p>
-    {% blocktrans with languages=book.languages|join:", " %}{{ languages }} language{% endblocktrans %}
-</p>
+    {% for language in book.languages %}
+        <meta itemprop="inLanguage" content="{{ language }}">
+    {% endfor %}
+
+    <p>
+        {% with languages=book.languages|join:", " %}
+            {% blocktrans %}{{ languages }} language{% endblocktrans %}
+        {% endwith %}
+    </p>
 {% endif %}
+
 <p>
-    {% if book.published_date and book.publishers %}
-    {% blocktrans with date=book.published_date|date:'M jS Y' publisher=book.publishers|join:', ' %}Published {{ date }} by {{ publisher }}.{% endblocktrans %}
-    {% elif book.published_date %}
-    {% blocktrans with date=book.published_date|date:'M jS Y' %}Published {{ date }}{% endblocktrans %}
-    {% elif book.publishers %}
-    {% blocktrans with publisher=book.publishers|join:', ' %}Published by {{ publisher }}.{% endblocktrans %}
-    {% endif %}
+    {% with date=book.published_date|date:'M jS Y' publisher=book.publishers|join:', ' %}
+        {% if date or book.first_published_date %}
+            <meta
+                itemprop="datePublished"
+                content="{{ book.first_published_date|default:book.published_date|date:'Y-m-d' }}"
+            >
+        {% endif %}
+
+        {% comment %}
+            @todo The publisher property needs to be an Organization or a Person. We’ll be using Thing which is the more generic ancestor.
+            @see https://schema.org/Publisher
+        {% endcomment %}
+        {% if book.publishers %}
+            {% for publisher in book.publishers %}
+                <meta itemprop="publisher" content="{{ publisher }}">
+            {% endfor %}
+        {% endif %}
+
+        {% if date and publisher %}
+            {% blocktrans %}Published {{ date }} by {{ publisher }}.{% endblocktrans %}
+        {% elif date %}
+            {% blocktrans %}Published {{ date }}{% endblocktrans %}
+        {% elif publisher %}
+            {% blocktrans %}Published by {{ publisher }}.{% endblocktrans %}
+        {% endif %}
+    {% endwith %}
 </p>
+{% endspaceless %}

bookwyrm/templates/snippets/authors.html

@@ -1 +1,17 @@
-{% for author in book.authors.all %}<a href="/author/{{ author.id }}" class="author">{{ author.name }}</a>{% if not forloop.last %}, {% endif %}{% endfor %}
+{% spaceless %}
+{% comment %}
+    @todo The author property needs to be an Organization or a Person. We’ll be using Thing which is the more generic ancestor.
+    @see https://schema.org/Author
+{% endcomment %}
+{% for author in book.authors.all %}
+    <a
+        href="/author/{{ author.id }}"
+        class="author"
+        itemprop="author"
+        itemscope
+        itemtype="https://schema.org/Thing"
+    ><span
+        itemprop="name"
+    >{{ author.name }}<span></a>{% if not forloop.last %}, {% endif %}
+{% endfor %}
+{% endspaceless %}

bookwyrm/templates/snippets/book_cover.html

@@ -1,13 +1,29 @@
+{% spaceless %}
+
 {% load bookwyrm_tags %}
+{% load i18n %}
+
 <div class="cover-container is-{{ size }}">
-{% if book.cover %}
-<img class="book-cover" src="/images/{{ book.cover }}" alt="{{ book.alt_text }}" title="{{ book.alt_text }}">
-{% else %}
-    <div class="no-cover book-cover">
-        <img class="book-cover" src="/static/images/no_cover.jpg" alt="No cover">
-        <div>
-            <p>{{ book.alt_text }}</p>
+    {% if book.cover %}
+        <img
+            class="book-cover"
+            src="/images/{{ book.cover }}"
+            alt="{{ book.alt_text }}"
+            title="{{ book.alt_text }}"
+            itemprop="thumbnailUrl"
+        >
+    {% else %}
+        <div class="no-cover book-cover">
+            <img
+                class="book-cover"
+                src="/static/images/no_cover.jpg"
+                alt="{% trans "No cover" %}"
+            >
+
+            <div>
+                <p>{{ book.alt_text }}</p>
+            </div>
         </div>
-    </div>
-{% endif %}
+    {% endif %}
 </div>
+{% endspaceless %}

bookwyrm/templates/snippets/status/status_content.html

@@ -1,68 +1,137 @@
+{% spaceless %}
+
 {% load bookwyrm_tags %}
 {% load i18n %}
-<div class="block">
-    {% if status.status_type == 'Review' or status.status_type == 'Rating' %}
-    <div>
-        {% if status.name %}
-        <h3 class="title is-5 has-subtitle" dir="auto">
-            {{ status.name|escape }}
-        </h3>
-        {% endif %}
-        {% include 'snippets/stars.html' with rating=status.rating %}
-    </div>
+
+{% with status_type=status.status_type %}
+<div
+    class="block"
+
+    {% if status_type == 'Review' %}
+        {% firstof "reviewBody" as body_prop %}
+        {% firstof 'itemprop="reviewRating" itemscope itemtype="https://schema.org/Rating"' as rating_type %}
+    {% endif %}
+
+    {% if status_type == 'Rating' %}
+        itemprop="rating"
+        itemtype="https://schema.org/Rating"
+    {% endif %}
+>
+    {% if status_type == 'Review' or status_type == 'Rating' %}
+        <div>
+            {% if status.name %}
+                <h3
+                    class="title is-5 has-subtitle"
+                    dir="auto"
+                    itemprop="name"
+                >
+                    {{ status.name|escape }}
+                </h3>
+            {% endif %}
+
+            <span
+                class="is-sr-only"
+                {{ rating_type }}
+            >
+                <meta itemprop="ratingValue" content="{{ status.rating|floatformat }}">
+
+                {% if status_type == 'Rating' %}
+                    {# @todo Is it possible to not hard-code the value? #}
+                    <meta itemprop="bestRating" content="5">
+                {% endif %}
+            </span>
+
+            {% include 'snippets/stars.html' with rating=status.rating %}
+        </div>
     {% endif %}
 
     {% if status.content_warning %}
-    <div>
-        <p>{{ status.content_warning }}</p>
-        {% trans "Show more" as button_text %}
-        {% include 'snippets/toggle/open_button.html' with text=button_text class="is-small" controls_text="show-status-cw" controls_uid=status.id %}
-    </div>
+        <div>
+            <p>{{ status.content_warning }}</p>
+
+            {% trans "Show more" as button_text %}
+
+            {% with text=button_text class="is-small" controls_text="show-status-cw" controls_uid=status.id %}
+                {% include 'snippets/toggle/open_button.html' %}
+            {% endwith %}
+        </div>
     {% endif %}
 
-    <div{% if status.content_warning %} class="hidden" id="show-status-cw-{{ status.id }}"{% endif %}>
+    <div
         {% if status.content_warning %}
-        {% trans "Show less" as button_text %}
-        {% include 'snippets/toggle/close_button.html' with text=button_text class="is-small" controls_text="show-status-cw" controls_uid=status.id %}
+            id="show-status-cw-{{ status.id }}"
+            class="hidden"
+        {% endif %}
+    >
+        {% if status.content_warning %}
+            {% trans "Show less" as button_text %}
+
+            {% with text=button_text class="is-small" controls_text="show-status-cw" controls_uid=status.id %}
+                {% include 'snippets/toggle/close_button.html' %}
+            {% endwith %}
         {% endif %}
 
         {% if status.quote %}
-        <div class="quote block">
-            <blockquote dir="auto" class="mb-2">{{ status.quote | safe }}</blockquote>
+            <div class="quote block">
+                <blockquote dir="auto" class="mb-2">{{ status.quote | safe }}</blockquote>
 
-            <p> &mdash; {% include 'snippets/book_titleby.html' with book=status.book %}</p>
-        </div>
-        {% endif %}
-
-        {% if status.content and status.status_type != 'GeneratedNote' and status.status_type != 'Announce' %}
-        {% include 'snippets/trimmed_text.html' with full=status.content|safe no_trim=status.content_warning %}
-        {% endif %}
-        {% if status.attachments.exists %}
-        <div class="block">
-            <div class="columns">
-                {% for attachment in status.attachments.all %}
-                <div class="column is-narrow">
-                    <figure class="image is-128x128">
-                        <a href="/images/{{ attachment.image }}" target="_blank" aria-label="{% trans 'Open image in new window' %}">
-                            <img src="/images/{{ attachment.image }}"{% if attachment.caption %} alt="{{ attachment.caption }}" title="{{ attachment.caption }}"{% endif %}>
-                        </a>
-                    </figure>
-                </div>
-                {% endfor %}
+                <p> &mdash; {% include 'snippets/book_titleby.html' with book=status.book %}</p>
+            </div>
+        {% endif %}
+
+        {% if status.content and status_type != 'GeneratedNote' and status_type != 'Announce' %}
+            {% with full=status.content|safe no_trim=status.content_warning itemprop=body_prop %}
+                {% include 'snippets/trimmed_text.html' %}
+            {% endwith %}
+        {% endif %}
+
+        {% if status.attachments.exists %}
+            <div class="block">
+                <div class="columns">
+                    {% for attachment in status.attachments.all %}
+                        <div class="column is-narrow">
+                            <figure class="image is-128x128">
+                                <a
+                                    href="/images/{{ attachment.image }}"
+                                    target="_blank"
+                                    aria-label="{% trans 'Open image in new window' %}"
+                                >
+                                    <img
+                                        src="/images/{{ attachment.image }}"
+
+                                        {% if attachment.caption %}
+                                            alt="{{ attachment.caption }}"
+                                            title="{{ attachment.caption }}"
+                                        {% endif %}
+                                    >
+                                </a>
+                            </figure>
+                        </div>
+                    {% endfor %}
+                </div>
             </div>
-        </div>
         {% endif %}
     </div>
 </div>
 
 {% if not hide_book %}
-{% if status.book or status.mention_books.count %}
-<div class="{% if status.status_type != 'GeneratedNote' %}box has-background-white-bis{% endif %}">
-    {% if status.book %}
-    {% include 'snippets/status/book_preview.html' with book=status.book %}
-    {% elif status.mention_books.count %}
-    {% include 'snippets/status/book_preview.html' with book=status.mention_books.first %}
+    {% if status.book or status.mention_books.count %}
+        <div
+            {% if status_type != 'GeneratedNote' %}
+                class="box has-background-white-bis"
+            {% endif %}
+        >
+            {% if status.book %}
+                {% with book=status.book %}
+                    {% include 'snippets/status/book_preview.html' %}
+                {% endwith %}
+            {% elif status.mention_books.count %}
+                {% with book=status.mention_books.first %}
+                    {% include 'snippets/status/book_preview.html' %}
+                {% endwith %}
+            {% endif %}
+        </div>
     {% endif %}
-</div>
-{% endif %}
 {% endif %}
+{% endwith %}
+{% endspaceless %}

bookwyrm/templates/snippets/status/status_header.html

@@ -1,9 +1,19 @@
 {% load bookwyrm_tags %}
 {% load i18n %}
-<a href="{{ status.user.local_path }}">
-{% include 'snippets/avatar.html' with user=status.user ariaHide="true" %}
-{{ status.user.display_name }}
-</a>
+<span
+    itemprop="author"
+    itemscope
+    itemtype="https://schema.org/Person"
+>
+    <a
+        href="{{ status.user.local_path }}"
+        itemprop="url"
+    >
+        {% include 'snippets/avatar.html' with user=status.user ariaHide="true" %}
+
+        <span itemprop="name">{{ status.user.display_name }}</span>
+    </a>
+</span>
 
 {% if status.status_type == 'GeneratedNote' %}
     {{ status.content | safe }}

bookwyrm/templates/snippets/trimmed_text.html

@@ -1,40 +1,49 @@
+{% spaceless %}
 {% load bookwyrm_tags %}
 {% load i18n %}
 
 {% with 0|uuid as uuid %}
-{% if full %}
-{% with full|to_markdown|safe as full %}
+    {% if full %}
+        {% with full|to_markdown|safe as full %}
+            {% with full|to_markdown|safe|truncatewords_html:60 as trimmed %}
+                {% if not no_trim and trimmed != full %}
+                    <div id="hide-full-{{ uuid }}">
+                        <div class="content" id="trimmed-{{ uuid }}">
+                            <div dir="auto">{{ trimmed }}</div>
 
-{% with full|to_markdown|safe|truncatewords_html:60 as trimmed %}
-{% if not no_trim and trimmed != full %}
-<div id="hide-full-{{ uuid }}">
-    <div class="content" id="trimmed-{{ uuid }}">
-        <div dir="auto">{{ trimmed }}</div>
+                            <div>
+                                {% trans "Show more" as button_text %}
+                                {% include 'snippets/toggle/open_button.html' with text=button_text controls_text="full" controls_uid=uuid class="is-small" %}
+                            </div>
+                        </div>
+                    </div>
+                    <div id="full-{{ uuid }}" class="hidden">
+                        <div class="content">
+                            <div
+                                dir="auto"
+                                {% if itemprop %}itemprop="{{ itemprop }}{% endif %}"
+                            >
+                                {{ full }}
+                            </div>
 
-        <div>
-            {% trans "Show more" as button_text %}
-            {% include 'snippets/toggle/open_button.html' with text=button_text controls_text="full" controls_uid=uuid class="is-small" %}
-        </div>
-    </div>
-</div>
-<div id="full-{{ uuid }}" class="hidden">
-    <div class="content">
-        <div dir="auto">{{ full }}</div>
-
-        <div>
-            {% trans "Show less" as button_text %}
-            {% include 'snippets/toggle/close_button.html' with text=button_text controls_text="full" controls_uid=uuid class="is-small" %}
-        </div>
-    </div>
-</div>
-{% else %}
-<div class="content">
-    <div dir="auto">{{ full }}</div>
-</div>
-{% endif %}
+                            <div>
+                                {% trans "Show less" as button_text %}
+                                {% include 'snippets/toggle/close_button.html' with text=button_text controls_text="full" controls_uid=uuid class="is-small" %}
+                            </div>
+                        </div>
+                    </div>
+                    {% else %}
+                    <div class="content">
+                        <div
+                            dir="auto"
+                            {% if itemprop %}itemprop="{{ itemprop }}{% endif %}"
+                        >
+                            {{ full }}
+                        </div>
+                    </div>
+                {% endif %}
+            {% endwith %}
+        {% endwith %}
+    {% endif %}
 {% endwith %}
-
-{% endwith %}
-{% endif %}
-{% endwith %}
-
+{% endspaceless %}