Merge pull request #157 from UA-Libraries-Research-Data-Services/update-site-metadata

Update site metadata

Author: dachambers

src/_config.yml

@@ -41,7 +41,13 @@ launch_buttons:
   jupyterhub_url: ""
 
 sphinx:
+  extra_extensions:
+    - sphinx_sitemap
+    - sphinx-last-updated-by-git
   config:
     templates_path:
       - _templates
     html_baseurl: https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/
+    html_context:
+      html_baseurl: https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/
+    sitemap_url_scheme: "{link}"

src/_templates/layout.html

@@ -3,22 +3,46 @@
 {%- block extrahead %}
   {{ super() }}
 
+  {% set site_name = "University of Alabama Libraries Scholarly API Cookbook" %}
+  {% set base = (html_baseurl or "https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/") %}
+  {% set page_url = base ~ pagename ~ ('' if pagename.endswith('.html') else '.html') %}
+
+  {# Prefer page description; fallback to a global site description #}
+  {% set site_desc = "Example tutorials for working with scholarly APIs for academic scholarly research and teaching using Python and R." %}
+  {% set page_desc = meta.get("description") if meta is defined else None %}
+  {% set desc = page_desc or site_desc %}
+
+  {# Allow per-page overrides for social #}
+  {% set og_title = (meta.get("og:title") if meta is defined else None) or (title|striptags) %}
+  {% set og_type  = (meta.get("og:type")  if meta is defined else None) or "website" %}
+
+  <!-- Canonical Link -->
+  <link rel="canonical" href="{{ page_url }}" />
+
+  <!-- Open Graph -->
+  <meta property="og:site_name" content="{{ site_name }}" />
+  <meta property="og:title" content="{{ og_title }}" />
+  <meta property="og:description" content="{{ desc }}" />
+  <meta property="og:type" content="{{ og_type }}" />
+  <meta property="og:url" content="{{ page_url }}" />
+
+  <!-- LD+JSON -->
   <script type="application/ld+json">
     {
       "@context": "https://schema.org",
       "@graph": [
         {
           "@type": "Organization",
-          "@id": "{{ html_baseurl }}#org-ua",
+          "@id": "{{ base }}#org-ua",
           "name": "The University of Alabama",
-          "alternateName": ["UA"],
+          "alternateName": ["UA", "Bama"],
           "url": "https://www.ua.edu/",
           "sameAs": [
             "https://en.wikipedia.org/wiki/University_of_Alabama"
-          ]
+          ],
           "subOrganization": {
             "@type": "Organization",
-            "@id": "{{ html_baseurl }}#org-ua-libraries",
+            "@id": "{{ base }}#org-ua-libraries",
             "name": "The University of Alabama Libraries",
             "alternateName": [
               "UA Libraries",
@@ -30,14 +54,14 @@
             "subOrganization": [
               {
                 "@type": "Organization",
-                "@id": "{{ html_baseurl }}#org-rds",
+                "@id": "{{ base }}#org-rds",
                 "name": "Research Data Services",
                 "alternateName": ["RDS"],
                 "url": "https://guides.lib.ua.edu/rds/"
               },
               {
                 "@type": "Organization",
-                "@id": "{{ html_baseurl }}#org-rcs",
+                "@id": "{{ base }}#org-rcs",
                 "name": "Research Computing Services",
                 "alternateName": ["RCS"],
                 "url": "https://guides.lib.ua.edu/RCS/"
@@ -47,24 +71,33 @@
         },
         {
           "@type": "WebSite",
-          "@id": "{{ html_baseurl }}#website",
+          "@id": "{{ base }}#website",
           "name": "University of Alabama Libraries Scholarly API Cookbook",
-          "url": "{{ html_baseurl }}",
+          "alternateName": [
+            "UA Libraries Scholarly API Cookbook",
+            "University Libraries Scholarly API Cookbook",
+            "UALIB Scholarly API Cookbook",
+            "Scholarly API Cookbook",
+            "Scholarly API Guide"
+          ],
+          "description": "{{ site_desc }}",
+          "url": "{{ base }}",
           "publisher": {
-            "@id": "{{ html_baseurl }}#org-ua-libraries"
+            "@id": "{{ base }}#org-ua-libraries"
           },
           "logo": {
             "@type": "ImageObject",
-            "url": "{{ html_baseurl }}images/script-a-icon.png"
+            "url": "{{ base }}images/script-a-icon.png"
           }
         },
         {
           "@type": "WebPage",
-          "@id": {{ (html_baseurl ~ pathto(pagename, 1) ~ "#webpage") | tojson }},
+          "@id": {{ page_url ~ "#webpage" | tojson }},
           "name": {{ title | striptags | tojson }},
-          "url": {{ (html_baseurl ~ pathto(pagename, 1)) | tojson }},
-          "isPartOf": { "@id": "{{html_baseurl}}#website" },
-          "publisher": { "@id": "{{html_baseurl}}#org-ua-libraries" }
+          "url": {{ page_url | to_json }},
+          "dateModified": "{{ last_updated | tojson }}",
+          "isPartOf": { "@id": "{{ base }}#website" },
+          "publisher": { "@id": "{{ base }}#org-ua-libraries" }
         }
       ]
     }

src/about/introduction.rst

@@ -1,3 +1,7 @@
+.. meta::
+   :title: Scholarly API Cookbook Introduction
+   :og:type: article
+
 Introduction
 %%%%%%%%%%%%%%
 

src/python/chronam.ipynb

@@ -1,5 +1,16 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "title: Chronicling America API in Python\n",
+    "description: Tutorial for using the Chronicling America API with Python including use cases\n",
+    "og:type: article\n",
+    "---"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {

src/requirements.txt

@@ -1,3 +1,5 @@
 jupyter-book<2
 matplotlib
 numpy
+sphinx-sitemap
+sphinx-last-updated-by-git