django-meta-mixin 0.3.0

Request

as_meta() accepts the request object that is saved locally and is available to methods by using the get_request method.

Public interface

ModelMeta.get_meta(request=None): returns the metadata attributes definition. Tipically these are set in _metadata attribute in the model;

ModelMeta.as_meta(request=None): returns the meta representation of the object suitable for use in the template;

ModelMeta.get_request(): returns the request object, if given as argument to as_meta;

ModelMeta.get_author(): returns the author object for the current instance. Default implementation does not return a valid object, this must be overidden in the application according to what is an author in the application domain;

ModelMeta.build_absolute_uri(url): create an absolute URL (i.e.: complete with protocol and domain); this is generated from the request object, if given as argument to as_meta;

Note

For Google+ support you must add {% render_block 'html_extra' %} in your template to add object type definition. See relevant Google+ snippets documentation (https://developers.google.com/+/web/snippet/)

Example

Look at the example folder for a sample implementation.

Generic properties

• title: object title,

• description: generic object description, used for SEO and as default for specific description,

• keywords: generic keywords for SEO

• locale: advertised object locale (if any)

• image: image to display for object

• object_type: default object type

• published_time: date-time of publishing

• modified_time: date-time of modification

• expiration_time: date-time of expiration

• url: canonical object url

Open Graph properties

• og_description: object description in Open Graph

• og_type: object type in Open Graph

• og_app_id: Facebook App ID

• og_profile_id: Author’s Facebook profileID

• og_publisher: Facebook URL to publisher’s profile

• og_author_url: Facebook URL to author’s profile

• tag: object tags

Twitter Cards properties

• twitter_description: object description on Twitter card (currently 200 chars max)

• twitter_type: twitter card type

• twitter_site: Website twitter account

• twitter_author: Author twitter account

Google+ Snippet properties

• gplus_description: object description

• gplus_type: object type according to schema.org types

• gplus_author: Author Google+ account

Generic / OpenGraph

• Article

• Website

You can override by defining META_OBJECT_TYPES/META_FB_TYPES nested tuples in the project settings like:

META_OBJECT_TYPES = (
    ('Article', _('Article')),
    ('Website', _('Website')),
)

META_FB_TYPES = (
    ('Article', _('Article')),
    ('Website', _('Website')),
)

Twitter

• Summary Card

• Summary Card with Large Image

• App Card

You can override by defining META_TWITTER_TYPES nested tuples in the project settings like:

META_TWITTER_TYPES = (
    ('summary', _('Summary Card')),
    ('summary_large_image', _('Summary Card with Large Image')),
    ('app', _('App Card')),
)

Google+ / Schema.org

• Article

• Blog

• WebPage

• WebSite

• Event

• Product

• Place

• Person

You can override by defining META_GPLUS_TYPES nested tuples in the project settings like:

META_GPLUS_TYPES = (
    ('Article', _('Article')),
    ('Blog', _('Blog')),
    ('WebPage', _('Page')),
    ('WebSite', _('WebSite')),
    ('Event', _('Event')),
    ('Product', _('Product')),
    ('Place', _('Place')),
    ('Person', _('Person')),
)

0.2.2 (XXXX-XX-XX)

• Use autoescape off in template for Django 1.9

0.2.1 (2015-10-17)

• Add object types for facebook, twitter, google plus

• Add translations

0.2.0 (2015-10-03)

• Add support for using request in extracting metadata

• Add one (optional) argument to class method call.

• Add support for editorconfig

• Add get_meta method to allow customising metadata

• Use META_SITE_PROTOCOL when generating full URL

• Extend documentation

• Clean up the code

• Use build_absolute_url instead of make_full_url

0.1.1 (2014-06-20)

• Add make_full_url method to retrieve complete object URL.

0.1.0 (2014-04-19)

• First release on PyPI.