Code Monkey home page Code Monkey logo

seo's Introduction

seo

This module enables advanced SEO functions for Silverstripe. It providers an SEO editor with

  1. Instant Previews for Google, Facebook, Twitter
  2. Editor for Open Graph Data
  3. Editor for Twitter Cards
  4. Save taxonomies
  5. Various meta title templates for pages
  6. Robots.txt controller
  7. Canonical URL management
  8. Flexibility on extending

Maintainers

[email protected]

Installation

Use composer to install on your SilverStripe 4 website.

composer require silverstripers/seo dev-master

Requirements

  1. SilverStripe 4+
  2. SilverStripe Reports
  3. SilverStripe Assets

Basic usage

Require the package via composer and run dev build. http://mysite.com/dev/build?flush=all The module will create additional SEO fields for the SiteTree (page) objects and will add in an interface for set up the SEO data.

Add the following instead of the SilverStripe's default meta tag in the <head> section of your template.

$GenerateMetaTags.RAW

DataObjects as pages

If you are using data objects as pages then you may need to add in SEO fields for those data objects to do that it needs to decorate the data object with SEODataExtension

MyDataObject:
    extensions:
        SilverStripers\SEO\Extension\SEODataExtension

This will create the db fields and add the seo editor on to the CMS.

Within the controller you need to call override_seo_from function, and pass your data record for the module to grab the SEO details

use SilverStripers\SEO\Extension\SEODataExtension
...

class MyController extension Controller {

    ...

    public function view()
    {
        ...
        SEODataExtension::override_seo_from($record);
        ...
    }

}

Variables / Taxonomies

If you login to the CMS and go to Settings -> SEO -> Variables, there is a grid field where you can enter name value pair objects. These can have any names and any values and for any text field within the meta editor you can use these.

The variables will have respective buttons to click which will add them automatically on to the editors fields.

You can also type them in like this. {MyVariableName}

Meta Title Templates

For various websites there are different types of web pages which needs various types of meta titles.

eg: A product page will have a meta title like: ABC Product - Create the best value for money | XYZ Company

Meta titles templates lets you define these as

{MetaTitle} - Create the best value for money | {SiteTitle}

This then get the meta title from the page's meta title variable, and site title from the Site Config title. You can also use any of the variables you defined in the variables sections.

Structured Data

The module supports structured data and enabling takes only a few yml configurations.

E.G: The following makes a Page a Thing and maps the fields on to the Database fields.

Page:
  schema_type: 'Thing'
  schema:
    'name': 'MetaTitle'
    'description': 'MetaDescription'
    'Image': 'FacebookImage'

Supported Types

  • Article
  • Beach
  • BlogPosting
  • BreadcrumbList
  • ContactPoint
  • Corporation
  • CreativeWork
  • Duration
  • Event
  • GeoCoordinates
  • ImageObject
  • Invoice
  • ListItem
  • LocalBusiness
  • MusicAlbum
  • MusicGroup
  • MusicPlaylist
  • MusicRecording
  • NewsArticle
  • Offer
  • Order
  • Organization
  • Person
  • Place
  • PostalAddress
  • PriceSpeficication
  • Product
  • Rating
  • Review
  • SearchBox
  • Thing
  • VideoObject
  • WebPage

To view the config options for any type visit the page with adding ?structureddata_help=1 to the end of the URL

Enjoy!!

seo's People

Contributors

fonsekaean avatar drmartingonzo avatar prameshharshana3 avatar christohill avatar ethanjohnstone avatar kdanilewicz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.