graphiques-digitale/silverstripe-seo-icons

Enhanced SEO favicon and application icon module for the SilverStripe framework

v1.0.0 2016-07-07 21:53 UTC

This package is not auto-updated.

Last update: 2024-11-01 21:42:41 UTC


README

Build Status Scrutinizer Code Quality

Overview

This is a modular extension for graphiques-digitale/silverstripe-seo-metadata

It enables enhanced favicon and pinned icon features.

Favicon inspired by: audreyr/favicon-cheat-sheet, Jonathan T. Neal - Understand the Favicon and High Quality Visuals for Pinned Sites in Windows 8

It requires:

It is intended to be used alongside it's siblings:

These are all optional and fragmented from the alpha version SSSEO, which is now redundant.

The whole module collection is based largely on 18 Meta Tags Every Webpage Should Have in 2013.

Also, a good overview: 5 tips for SEO with Silverstripe 3.

Touch icons inspired by: Everything you always wanted to know about touch icons

Installation

Composer

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

From ZIP

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

CMS Usage

All icons are set globally via /admin/settings/ under the Metadata tab.

It is recommended you simply have a favicon.ico file in the root of your website

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.:

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

This will output something along the lines of:

<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." />
<!-- Favicon -->
<link rel="icon" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/logo.png" />
<!--[if IE]><link rel="shortcut icon" href="/favicon.ico" /><![endif]-->
<meta name="msapplication-TileColor" content="FFFFFF" />
<meta name="msapplication-TileImage" content="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/logo.png" />
<!-- Touch Icon -->
<link rel="icon" sizes="192x192" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize192192-logo.png">
<link rel="apple-touch-icon-precomposed" sizes="180x180" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize180180-logo.png">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/logo.png">
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize144144-logo.png">
<link rel="apple-touch-icon-precomposed" sizes="120x120" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize120120-logo.png">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize114114-logo.png">
<link rel="apple-touch-icon-precomposed" sizes="76x76" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize7676-logo.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize7272-logo.png">
<link rel="apple-touch-icon-precomposed" href="http://dev.seo.silverstripe.org/assets/SiteConfig/seo-icons/_resampled/SetSize5757-logo.png"><!-- 57×57px -->
<!-- END SEO -->

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

Issue Tracker

Issues are tracked on GitHub @ Issue Tracker

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.

License

BSD-3-Clause license

See @ Why BSD?

Screenshot

Screenshot

Screenshot