A tool to assist with metadata for social media.
Project description
A tool to assist with metadata for social media and search engines.
Compatibility
Wagtail-metadata works with Wagtail v1.12 and upwards.
Installing
First, install using pip:
pip install wagtail-metadata
Then add wagtailmetadata to your project’s INSTALLED_APPS:
INSTALLED_APPS = [
'home',
'search',
# etc...
'wagtail.contrib.settings',
'wagtail.contrib.modeladmin',
# etc...
# Add the following:
'wagtailmetadata',
]Using
Pages should inherit from wagtailmetadata.models.MetadataPageMixin. This provides a search_image field in the Wagtail interface for that page type. The description for the page will be pulled from the search_description page. Metadata for the page will then be built from the page details.
from wagtail.wagtailcore.models import Page
from wagtailmetadata.models import MetadataPageMixin
class ContentPage(MetadataPageMixin, Page):
passIf you want to use this with a non-page model, or want to use a different implementation for the fields, you can inherit from wagtailmetadata.models.MetadataMixin. You will need to implement the following methods:
from wagtailmetadata.models import MetadataMixin
class CustomObject(MetadataMixin, object):
def get_meta_title(self):
"""The title of this object"""
return "My custom object"
def get_meta_url(self):
"""The URL of this object, including protocol and domain"""
return "http://example.com/my-custom-object/"
def get_meta_description(self):
"""
A short text description of this object.
This should be plain text, not HTML.
"""
return "This thing is really cool, you should totally check it out"
def get_meta_image(self):
"""A relevant Wagtail Image to show. Optional."""
return self.some_image
def get_meta_twitter_card_type(self):
"""
What kind of Twitter card to show this as.
Defaults to ``summary_large_photo`` if there is a meta image,
or ``summary`` if there is no image. Optional.
"""
return "summary_large_photo"Display
Django
To use this in a template, first load the template tag library, and then insert the metadata by placing {% meta_tags %} into the <head>:
{% load wagtailmetadata_tags %}
{% meta_tags %}By default, this will look for a self object in the context to pull the metadata from. You can specify a different object to use if you need to:
{% load wagtailmetadata_tags %}
{% meta_tags my_custom_object %}Jinja2
Add wagtailmetadata.jinja2tags.WagtailMetadataExtension to the template extensions in your settings.py:
TEMPLATES = [
{
'BACKEND': 'django.template.backends.jinja2.Jinja2',
'OPTIONS': {
'extensions': [
'wagtailmetadata.jinja2tags.WagtailMetadataExtension'
],
},
}
]Insert the metadata by placing {{ meta_tags() }} into the <head>:
{{ meta_tags() }}By default, this will look for a page object in the context to pull the metadata from. You can specify a different object to use if you need to:
{{ meta_tags(my_custom_object) }}Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wagtail_metadata-0.4.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d67b11985dc2d159fbe142329e6161990e0b7adba57b801d739437bf3da7aee5 |
|
| MD5 | ae7b7f8fc350c2d862c562397213c4ad |
|
| BLAKE2b-256 | 41d9123060109fdc022d9ead6ac89caae034469a5ffea6e4e82ab5c09818f4a0 |
