Improve metadata handling

opendatateam · Oct 13, 2018 · 712e922 · 712e922
1 parent 924289b
commit 712e922
Show file tree

Hide file tree

Showing 28 changed files with 233 additions and 49 deletions.
diff --git a/data/identity.yml b/data/identity.yml
@@ -1,2 +1,7 @@
 ---
 tagline: Open, customizable and skinnable platform dedicated to open data
+
+social:
+  github: https://github.com/opendatateam
+  twitter: https://twitter.com/udata_project
+  gitter: https://gitter.im/opendatateam/udata
diff --git a/pelicanconf.py b/pelicanconf.py
@@ -2,9 +2,7 @@
 import os
 
 AUTHOR = 'Open Data Team'
-SITENAME = 'udata'
-
-SITEDESCRIPTION = 'Bla bla bla'
+SITENAME = 'getudata.org'
 
 TAGS = ('opendata', 'data')
 
@@ -36,11 +34,6 @@
 AUTHOR_FEED_ATOM = None
 AUTHOR_FEED_RSS = None
 
-# Blogroll
-LINKS = (('Pelican', 'http://getpelican.com/'),
-         ('Python.org', 'http://python.org/'),
-         ('Jinja2', 'http://jinja.pocoo.org/'),
-         ('You can modify those links in your config file', '#'),)
 
 DEFAULT_PAGINATION = 10
 
@@ -111,12 +104,6 @@
 
 RELATED_POSTS_MAX = 3
 
-SOCIAL = (
-    ('github', 'https://github.com/opendatateam'),
-    ('twitter', 'https://twitter.com/udata_project'),
-    ('gitter', 'https://gitter.im/opendatateam/udata'),
-)
-
 MENUITEMS = (
     ('Documentation', 'https://udata.readthedocs.io'),
 )
diff --git a/publishconf.py b/publishconf.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 import os
 import sys
 sys.path.append(os.curdir)

diff --git a/theme/static/favicons/apple-touch-icon-114x114.png b/theme/static/favicons/apple-touch-icon-114x114.png
diff --git a/theme/static/favicons/apple-touch-icon-120x120.png b/theme/static/favicons/apple-touch-icon-120x120.png
diff --git a/theme/static/favicons/apple-touch-icon-144x144.png b/theme/static/favicons/apple-touch-icon-144x144.png
diff --git a/theme/static/favicons/apple-touch-icon-152x152.png b/theme/static/favicons/apple-touch-icon-152x152.png
diff --git a/theme/static/favicons/apple-touch-icon-57x57.png b/theme/static/favicons/apple-touch-icon-57x57.png
diff --git a/theme/static/favicons/apple-touch-icon-60x60.png b/theme/static/favicons/apple-touch-icon-60x60.png
diff --git a/theme/static/favicons/apple-touch-icon-72x72.png b/theme/static/favicons/apple-touch-icon-72x72.png
diff --git a/theme/static/favicons/apple-touch-icon-76x76.png b/theme/static/favicons/apple-touch-icon-76x76.png
diff --git a/theme/static/favicons/favicon-128.png b/theme/static/favicons/favicon-128.png
diff --git a/theme/static/favicons/favicon-16x16.png b/theme/static/favicons/favicon-16x16.png
diff --git a/theme/static/favicons/favicon-196x196.png b/theme/static/favicons/favicon-196x196.png
diff --git a/theme/static/favicons/favicon-32x32.png b/theme/static/favicons/favicon-32x32.png
diff --git a/theme/static/favicons/favicon-96x96.png b/theme/static/favicons/favicon-96x96.png
diff --git a/theme/static/favicons/favicon.ico b/theme/static/favicons/favicon.ico
diff --git a/theme/static/favicons/mstile-144x144.png b/theme/static/favicons/mstile-144x144.png
diff --git a/theme/static/favicons/mstile-150x150.png b/theme/static/favicons/mstile-150x150.png
diff --git a/theme/static/favicons/mstile-310x150.png b/theme/static/favicons/mstile-310x150.png
diff --git a/theme/static/favicons/mstile-310x310.png b/theme/static/favicons/mstile-310x310.png
diff --git a/theme/static/favicons/mstile-70x70.png b/theme/static/favicons/mstile-70x70.png
diff --git a/theme/static/favicons/safari-pinned-tab.svg b/theme/static/favicons/safari-pinned-tab.svg
diff --git a/theme/templates/article.html b/theme/templates/article.html
@@ -1,5 +1,13 @@
 {% extends 'base.html' %}
 
+{% set meta = {
+  'title': article.title,
+  'lang': article.lang,
+  'description': article.summary|default('')|striptags,
+  'image': article.image,
+  'tags': article.tags|default([]),
+} %}
+
 {% block hero %}
 <section class="hero article__hero">
   <div class="article__container">

diff --git a/theme/templates/base.html b/theme/templates/base.html
@@ -1,39 +1,18 @@
 <!DOCTYPE html>
-<html lang="{% block html_lang %}{{ DEFAULT_LANG }}{% endblock html_lang %}">
+{% set meta = meta or {} %}
+<html lang="{{ meta.lang or DEFAULT_LANG }}">
 <head>
   {% block head %}
-  <title>{% block title %}{{ SITENAME }}{% endblock title %}</title>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1">
 
+  {% from 'macros/metadata.html' import metadata with context %}
+  {{ metadata(meta) }}
+
   <link rel="stylesheet" href="{{SITEURL}}/theme/css/fonts.css">
   <link rel="stylesheet" href="{{SITEURL}}/theme/css/template.css">
   <link rel="stylesheet" href="{{SITEURL}}/theme/css/typography.css">
   <link rel="stylesheet" href="{{SITEURL}}/theme/css/main.css">
-  {% if FEED_ALL_ATOM %}
-  <link href="{{ FEED_DOMAIN }}/{% if FEED_ALL_ATOM_URL %}{{ FEED_ALL_ATOM_URL }}{% else %}{{ FEED_ALL_ATOM }}{% endif %}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }} Full Atom Feed" />
-  {% endif %}
-  {% if FEED_ALL_RSS %}
-  <link href="{{ FEED_DOMAIN }}/{% if FEED_ALL_RSS_URL %}{{ FEED_ALL_RSS_URL }}{% else %}{{ FEED_ALL_RSS }}{% endif %}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }} Full RSS Feed" />
-  {% endif %}
-  {% if FEED_ATOM %}
-  <link href="{{ FEED_DOMAIN }}/{%if FEED_ATOM_URL %}{{ FEED_ATOM_URL }}{% else %}{{ FEED_ATOM }}{% endif %}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }} Atom Feed" />
-  {% endif %}
-  {% if FEED_RSS %}
-  <link href="{{ FEED_DOMAIN }}/{% if FEED_RSS_URL %}{{ FEED_RSS_URL }}{% else %}{{ FEED_RSS }}{% endif %}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }} RSS Feed" />
-  {% endif %}
-  {% if CATEGORY_FEED_ATOM and category %}
-  <link href="{{ FEED_DOMAIN }}/{% if CATEGORY_FEED_ATOM_URL %}{{ CATEGORY_FEED_ATOM_URL|format(category.slug) }}{% else %}{{ CATEGORY_FEED_ATOM|format(category.slug) }}{% endif %}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }} Categories Atom Feed" />
-  {% endif %}
-  {% if CATEGORY_FEED_RSS and category %}
-  <link href="{{ FEED_DOMAIN }}/{% if CATEGORY_FEED_RSS_URL %}{{ CATEGORY_FEED_RSS_URL|format(category.slug) }}{% else %}{{ CATEGORY_FEED_RSS|format(category.slug) }}{% endif %}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }} Categories RSS Feed" />
-  {% endif %}
-  {% if TAG_FEED_ATOM and tag %}
-  <link href="{{ FEED_DOMAIN }}/{% if TAG_FEED_ATOM_URL %}{{ TAG_FEED_ATOM_URL|format(tag.slug) }}{% else %}{{ TAG_FEED_ATOM|format(tag.slug) }}{% endif %}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }} Tags Atom Feed" />
-  {% endif %}
-  {% if TAG_FEED_RSS and tag %}
-  <link href="{{ FEED_DOMAIN }}/{% if TAG_FEED_RSS_URL %}{{ TAG_FEED_RSS_URL|format(tag.slug) }}{% else %}{{ TAG_FEED_RSS|format(tag.slug) }}{% endif %}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }} Tags RSS Feed" />
-  {% endif %}
   {% endblock head %}
 </head>
 

diff --git a/theme/templates/includes/footer.html b/theme/templates/includes/footer.html
@@ -2,13 +2,13 @@
   <div class="container">
     <div class="footer__logo">
       <h2>opendatateam</h2>
-      {% if SOCIAL %}
+      {% if data.identity.social %}
         <ul class="footer__social">
-          {% for name, link in SOCIAL %}
+          {% for name, link in data.identity.social.items() %}
             <li><a href="{{link}}" title="{{name}}"><svg class="icon icon-{{name}}"><use xlink:href="#{{name}}"></use></svg></a></li>
           {% endfor %}
         </ul>
       {% endif %}
     </div>
   </div>
-</footer>
+</footer>
diff --git a/theme/templates/macros/metadata.html b/theme/templates/macros/metadata.html
@@ -0,0 +1,91 @@
+{% macro metadata(meta) %}
+{% set title = meta.title|default(SITENAME) %}
+{% set full_title = ' - '.join((SITENAME, title)) if meta.title else SITENAME %}
+{% set description = meta.description|default(data.identity.tagline) %}
+{% set tags = TAGS|list + meta.tags|default([])|list %}
+
+<title>{{ full_title }}</title>
+
+<!-- Standard HTML metadata -->
+<meta name="keywords" content="{{ tags|join(',') }}">
+<meta name="description" content="{{ description }}">
+<meta name="author" content="{{ AUTHOR }}">
+<meta name="generator" content="Pelican" />
+
+<!-- Standard favicons and colors -->
+<meta name="theme-color" content="#ffffff" />
+<link rel="icon" type="image/png" href="{{ SITEURL }}/theme/favicons/favicon-196x196.png" sizes="196x196" />
+<link rel="icon" type="image/png" href="{{ SITEURL }}/theme/favicons/favicon-96x96.png" sizes="96x96" />
+<link rel="icon" type="image/png" href="{{ SITEURL }}/theme/favicons/favicon-32x32.png" sizes="32x32" />
+<link rel="icon" type="image/png" href="{{ SITEURL }}/theme/favicons/favicon-16x16.png" sizes="16x16" />
+<link rel="icon" type="image/png" href="{{ SITEURL }}/theme/favicons/favicon-128.png" sizes="128x128" />
+<link rel="icon" type="image/x-icon" href="{{ SITEURL }}/theme/favicons/favicon.ico" />
+<link rel="shortcut icon" type="image/x-icon" href="{{ SITEURL }}/theme/favicons/favicon.ico" />
+<!-- Apple and Safari favicons -->
+<link rel="apple-touch-icon-precomposed" sizes="57x57" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-57x57.png" />
+<link rel="apple-touch-icon-precomposed" sizes="114x114" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-114x114.png" />
+<link rel="apple-touch-icon-precomposed" sizes="72x72" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-72x72.png" />
+<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-144x144.png" />
+<link rel="apple-touch-icon-precomposed" sizes="60x60" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-60x60.png" />
+<link rel="apple-touch-icon-precomposed" sizes="120x120" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-120x120.png" />
+<link rel="apple-touch-icon-precomposed" sizes="76x76" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-76x76.png" />
+<link rel="apple-touch-icon-precomposed" sizes="152x152" href="{{ SITEURL }}/theme/favicons/apple-touch-icon-152x152.png" />
+<link rel="mask-icon" href="{{ SITEURL }}/theme/favicons/safari-pinned-tab.svg" color="#5bbad5">
+
+<!-- Microsoft/Metro tiles -->
+<meta name="application-name" content="{{ full_title }}"/>
+<meta name="msapplication-TileColor" content="#2d89ef" />
+<meta name="msapplication-TileImage" content="{{ SITEURL }}/theme/favicons/mstile-144x144" />
+<meta name="msapplication-square70x70logo" content="{{ SITEURL }}/theme/favicons/mstile-70x70" />
+<meta name="msapplication-square150x150logo" content="{{ SITEURL }}/theme/favicons/mstile-150x150" />
+<meta name="msapplication-wide310x150logo" content="{{ SITEURL }}/theme/favicons/mstile-310x150" />
+<meta name="msapplication-square310x310logo" content="{{ SITEURL }}/theme/favicons/mstile-310x310" />
+
+<!-- OpenGraph -->
+<meta property="og:title" content="{{ title }}" />
+<meta property="og:site_name" content="{{ SITENAME }}" />
+<meta property="og:description" content="{{ description }}" />
+<meta property="og:locale" content="{{ meta.lang or DEFAULT_LANG }}" />
+{% if meta.image %}
+<meta property="og:image" content="{{ meta.image }}" />
+{% endif %}
+
+<!-- Twitter Card -->
+<meta name="twitter:card" content="summary_large_image" />
+{% if data.identity.social.twitter %}<meta name="twitter:site" content="{{ data.identity.social.twitter }}" />{% endif %}
+<meta name="twitter:title" content="{{ full_title }}" />
+<meta name="twitter:description" content="{{ description }}" />
+{% if meta.image %}
+<meta name="twitter:image" content="{{ meta.image }}" />
+{% endif %}
+
+{% if JSON_LD %}
+<!-- JSON-LD -->
+<script type="application/ld+json">{{ JSON_LD | json }}</script>
+{% endif %}
+
+<!-- Feeds -->
+{# 
+  The `or` condition ensure that each feed is present once.
+  The `*_FEED_ALL_*` include the entire content in the feed
+  whereas the `*_FEED_*` only include the summary
+#}
+{% if FEED_ALL_ATOM or FEED_ATOM %}
+<link href="{{ FEED_DOMAIN }}/{{ FEED_ALL_ATOM or FEED_ATOM }}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }}" />
+{% endif %}
+{% if FEED_ALL_RSS or FEED_RSS %}
+<link href="{{ FEED_DOMAIN }}/{{ FEED_ALL_RSS or FEED_RSS }}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }}" />
+{% endif %}
+{% if category and (CATEGORY_FEED_ALL_ATOM or CATEGORY_FEED_ATOM) %}
+<link href="{{ FEED_DOMAIN }}/{{ (CATEGORY_FEED_ATOM_URL or CATEGORY_FEED_ATOM) | format(category.slug) }}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }} - {{ category }} category" />
+{% endif %}
+{% if category and (CATEGORY_FEED_ALL_RSS or CATEGORY_FEED_RSS) %}
+<link href="{{ FEED_DOMAIN }}/{{ (CATEGORY_FEED_RSS_URL or CATEGORY_FEED_RSS) | format(category.slug) }}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }} - {{ category }} category" />
+{% endif %}
+{% if tag and (TAG_FEED_ALL_ATOM or TAG_FEED_ATOM) %}
+<link href="{{ FEED_DOMAIN }}/{{ (TAG_FEED_ATOM_URL or TAG_FEED_ATOM)|format(tag.slug) }}" type="application/atom+xml" rel="alternate" title="{{ SITENAME }} - {{ tag }} tag" />
+{% endif %}
+{% if tag and (TAG_FEED_ALL_RSS or TAG_FEED_RSS) %}
+<link href="{{ FEED_DOMAIN }}/{{ (TAG_FEED_RSS_URL or TAG_FEED_RSS)|format(tag.slug) }}" type="application/rss+xml" rel="alternate" title="{{ SITENAME }} - {{ tag }} tag" />
+{% endif %}
+{% endmacro %}
diff --git a/theme/templates/page.html b/theme/templates/page.html
@@ -1,7 +1,11 @@
 {% extends "base.html" %}
-{% block html_lang %}{{ page.lang }}{% endblock %}
-
-{% block title %}{{ SITENAME }} - {{ page.title }}{%endblock%}
+{% set meta = {
+  'title': page.title,
+  'lang': page.lang,
+  'description': page.summary|default('')|striptags,
+  'image': page.image,
+  'tags': page.tags|default([]),
+} %}
 
 {% block content %}
   <section class="section-white">
@@ -18,4 +22,4 @@
       {% endif %}
     </div>
   </section>
-{% endblock %}
+{% endblock %}