Skip to content

Latest commit

 

History

History
300 lines (210 loc) · 8.19 KB

USAGE.md

File metadata and controls

300 lines (210 loc) · 8.19 KB
Raw

Novactive eZ SEO Bundle

Usage

Description

The main idea is to avoid you to manage the <meta> and <link> tag. If there is a content when the view is rendered then the template will take care of the html tags according to the configuration and to the content.

If there is no content and if the content doesn't have the NovaSEO Field Type, the default <meta>, <title> and <link> will be set. But you will have to manage yourself. ( we can't do that for you, but we'd simplified the process.

All the configuration is SiteAccessAware then you can have different one depending on the SiteAccess

Integration

# in your pagelayout
{% block seo_metas %}
    {% include "@NovaeZSEO/seometas_metaslinks.html.twig" %}
{% endblock %}
    
# in a template which extends the pagelayout (not required, useful when you want to do something special)
{% block seo_metas %}
    <title>.....</title>
    <meta name="..." />
    {{ parent() }}
{% endblock %}

As this template handles a lot of <meta> and <link> and the <title> tag you have to be careful in your code to avoid duplicate tags.

Configuration

<meta> Configuration

nova_ezseo:
    system:
        default:
            default_metas:
                author: "Ibexa Community Bundle Nova eZ SEO Bundle"
                copyright: ~
                generator: "Ibexa Platform"
                MSSmartTagsPreventParsing: "TRUE"

You can add your own here

<link> Configuration

nova_ezseo:
    system:
        default:
            default_links:
                Index:
                    href: { location_id: 2 }
                    title: 'Home'
                Top:
                    href: { route : 'yourproject_home' }
                    title: 'Home'
                Search:
                    href: { route: 'yourproject_search_route' }
                    title: 'Search'
                'Shortcut icon':
                    href: { asset: '/bundles/sitebundle/images/favicon.ico' }
                    type: 'image/x-icon'
                Alternate:
                    href: { route: 'yourproject_rss_feed_route' }
                    title: 'RSS'
                    type: 'application/rss+xml'
                'Other package asset':
                    href: { asset: { path: 'images/favicon.ico', package: 'ibexa_design' } }
                    type: 'image/x-icon'

You can add your own here

FieldType Configuration

You can add your Metas in your configuration

nova_ezseo:
    system:
        default:
            fieldtype_metas_identifier: "metas"
            fieldtype_metas:
                title:
                    label: 'Title'
                    default_pattern: "<title|name>"
                    required: true
                description:
                    label: 'Description'
                    default_pattern: "<description|short_description|title|name>"
                    minLength: 100
                    maxLength: 150
                keywords:
                    label: 'Keywords'
                    default_pattern: ~

This configuration defines 3 metas, title, description and keywords

The options required, minLength and maxLength are optional.

You can add what you want to here.

sitemap.xml

Your sitemap is automatically generated on the fly.

nova_ezseo:
    system:
        default:
            sitemap_excludes:
                locations: [2]
                subtrees: [45,89,343]
                contentTypeIdentifiers: ['footer','something']

Set "limit_to_rootlocation" to true to automatically generate sitemap.xml per rootlocation.

nova_ezseo:
    system:
        default:
            limit_to_rootlocation: true
            sitemap_excludes:
                subtrees: [45,89,343]
                contentTypeIdentifiers: ['footer','something']

Set "display_images_in_sitemap" to true to inject the image tags. Notice: this doesn't work with limit_to_rootlocation: true.

nova_ezseo:
    system:
        default:
            display_images_in_sitemap: true

You can customize label by siteaccess

novactive.novaseobundle.default.meta_field_name: Metas
novactive.novaseobundle.default.meta_field_description: Metas for Search Engine Optimizations
novactive.novaseobundle.default.meta_field_group: novaseo

Google Site Verification file

You can manage the Google Verification file in the configuration

nova_ezseo:
    system:
        default:
            google_verification: 1234567890

Simpler way, nothing to put on your server, no need to add a new RewriteRules

Google Analytics Integration Marker

You can insert the GA Marker by just adding your id: UA-XXXXXXXX-X

nova_ezseo:
    system:
        default:
            google_gatracker: UA-XXXXXXXX-X

Google Analyitcs anonymizeIp

The default behavior is to set Google Analytics to anonymize all ip, set 'google_anonymizeIp' to false to turn this of.

nova_ezseo:
    system:
        default:
            google_anonymizeIp: false

Robots.txt file

You can manage the Robots.txt file

nova_ezseo:
    system:
        default:
            google_verification: 1234567890
            robots_disallow:
                - "/admin"
                - "/specials"

Nothing to put on your server, no need to add a new RewriteRules, and there is also a security, the Disallow / is automatically set when you're not in "prod" mode.

How the Field Type works

There are 5 levels of fallback which allow you to set the good value for the metas.

  • 1: in configuration (Yaml only)
  • 2: in the Field Type Definition (Administration Interface, on the Content Type)
  • 3: in the Content (Administration Interface, on the Content)
  • 4: Plus: same 3 previous rules but on the Root Content

Wait, you read 5 !

There is a transverse abstract level based on a feature similar to the Object/Url Name Pattern.

Object Pattern like feature

At each level mentioned above, you can set a default_pattern value.

This pattern allows you to define a fallback on optional Field, <title|name> means it will try to take the title Field, if it finds nothing it will try the name. Depending where you have set this pattern, the system will fallback to the other level

Do what you want to

That's really powerful, and you can do almost what you want to.

If it's not enough, you can also add a sixth level with Twig manipulation!

You can use a image and and object_relation to an image ( needed for facebook image url for example )

Even better !

Started at the version 1.1.0, you can define a CustomFallback service

Ex:

nova_ezseo:
    system:
        default:
            custom_fallback_service: yourname.seo.fallback

This service must be declare and MUST implement the CustomFallbackInterface

public function getMetaContent( $metaName, ContentInfo $contentInfo );

Then here, you can inject whatever you want into this service and manage specific values and condition for empty meta. Just return the Value of the given metaName.

Tip: You can force the meta to be empty (~) to enter in this Service ;)

No more limits!

Add the FieldType to your Content Type

A command is provided to simply add the FieldType, you can always do it by the Administration Inferface

$ php bin/console nova_ezseo:addnovaseometasfieldtype -h
Usage:
 nova_ezseo:addnovaseometasfieldtype [--identifier="..."] [--identifiers="..."] [--group_identifier="..."]

Options:
 --identifier          a content type identifier
 --identifiers         some content types identifier, separated by a comma
 --group_identifier    a content type group identifier
 ...
 --siteaccess          SiteAccess to use for operations. If not provided, default siteaccess will be used

Help:
 The command nova_ezseo:addnovaseometasfieldtype add the FieldType 'novaseometas'.
 You can select the Content Type via the identifier, identifiers, group_identifier option.
     - Identifier will be: %nova_ezseo.default.fieldtype_metas_identifier%
     - Name will be: Metas
     - Category will be: SEO