silverstripe-module silverstripe-seo-metadata {🖫 2,708, ⚐ 5, ★ 4}

graphiques-digitale/silverstripe-seo-metadata

Enhanced SEO metadata module for the SilverStripe framework.

Friday, September 29, 2017
by 4t4r1
Repository
1 Watchers
4 Stars
2,708 Installations

PHP
3 Dependents
0 Suggesters
3 Forks
0 Open issues
5 Versions
8 % Grown

The README.md

, _(*1)

Overview

This is the core metadata module for the graphiques-digitale/silverstripe-seo-* module collection., _(*2)

It enables enhanced title features, character set selection, canonical URLs and an enhanced fall-back description using $Content.FirstParagraph()., _(*3)

Title inspired by: http://moz.com/learn/seo/title-tag, _(*4)

It is intended to be used with it's siblings: * Graphiques-Digitale/silverstripe-seo-icons * Graphiques-Digitale/silverstripe-seo-facebook-domain-insights * Graphiques-Digitale/silverstripe-seo-open-graph, _(*5)

These are all optional and fragmented from the alpha version Graphiques-Digitale/SSSEO, which is now redundant., _(*6)

The whole module collection is based largely on 18 Meta Tags Every Webpage Should Have in 2013., _(*7)

Also, a good overview: 5 tips for SEO with Silverstripe 3., _(*8)

Installation

Composer

composer require graphiques-digitale/silverstripe-seo-metadata
rebuild using /dev/build/?flush

From ZIP

Place the extracted folder silverstripe-seo-metadata-{version} into silverstripe-seo-metadata in the SilverStripe webroot
rebuild using /dev/build/?flush

CMS Usage

See /silverstripe-seo-metadata/_config/app.yml for configuration., _(*9)

Metadata is changed globally via /admin/settings/ under the Metadata tab., _(*10)

And also locally, per page, under their Metadata tab., _(*11)

Template Usage

Depending on your configuration, the general idea is to replace all header content relating to metadata with $Metadata() just below the opening <head> tag and <% base_tag %> include, e.g.:, _(*12)

<head>
    <% base_tag %>
    $Metadata()
    <!-- further includes ~ viewport, etc. -->
</head>

This will output something along the lines of:, _(*13)

<head>
    <base href="http://dev.seo.silverstripe.org/"><!--[if lte IE 6]></base><![endif]-->

    <!-- SEO -->
    <!-- Metadata -->
    <meta charset="UTF-8" />
    <link rel="canonical" href="http://dev.seo.silverstripe.org/" />
    <title>Your Site Name | Home - your tagline here</title>
    <meta name="description" content="Welcome to SilverStripe! This is the default home page. You can edit this page by opening the CMS. You can now access the developer documentation, or begin the tutorials." />
    <!-- END SEO -->

    <!-- further includes ~ viewport, etc. -->
</head>

Advanced Usage

Please check the documentation folder for how to extend classes and more., _(*14)

Issue Tracker

Issues are tracked on GitHub @ Issue Tracker, _(*15)

Development and Contribution

Please get in touch @ hello@graphiquesdigitale.net if you have any extertise in any of these SEO module's areas and would like to help ~ they're a lot to maintain, they should be improved continually as HTML evolves and I'm sure they can generally be improved upon by field experts., _(*16)