DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Readable name of your extension

Created:2010-02-18T17:33:18
Changed by:Ralf Schneider
Changed:2012-07-25T11:36:24
Classification:extensionkey
Description:The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ----
Keywords:keywords comma-separated
Author:Author Name
Email:your@email.com
Info 4:
Language:en

img-1 img-2 Search Engine Toolkithriseo

EXT: Search Engine Toolkit

Extension Key: hriseo

Language: en

Keywords: SEO, TYPO3, realurl, canonical tags, meta tags, sitemap.xml, robots.txt

Copyright 2012, Ralf Schneider, < ralf@hr-interactive.de >

Version: 0.5.0

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents

EXT: Search Engine Toolkit 1

`Introduction 3 <#__RefHeading__5553_1752220325>`_

What does it do? 3

Screenshots 3

`Users manual 4 <#__RefHeading__5573_1752220325>`_

sitemap.xml / robots.txt 4

Metatags 5

`Administration 6 <#__RefHeading__5575_1752220325>`_

`Configuration 7 <#__RefHeading__5577_1752220325>`_

Reference 7

`Credits 9 <#__RefHeading__20572_1498267658>`_

`To-Do list 10 <#__RefHeading__5583_1752220325>`_

`ChangeLog 11 <#__RefHeading__5585_1752220325>`_

Introduction

What does it do?

This extension toolkit provides the collection of some basic SEO tools

  • Create of sitemap.xml file according to standards, ready to be submitted to Google etc
  • Optional exclude selected pages or parts of the page tree from the sitemap
  • Define priority and changefrequences for pages and whole pagetrees
  • Create robots.txt based on page specifig settings
  • configurable meta tags (keywords, description: will be slided from above pages if empty)
  • Canonical meta tags
  • SEO friendly page title
  • Additional meta tags (like author, language, copyright) on every page
  • Automated configuration of realurl

Screenshots

img-3 Set the change frequency per page or whole page tree for the sitemap file

Constants Editor can be used to set zentral settings.

Users manual

sitemap.xml / robots.txt

  • The extension creates a /sitemap.xml file plus /robots.txt. By default all regular pages are included in the sitemap, unless a page has “Include in Search” disabled. In this case this page and all childs are excluded from the sitemap.xml and an Disallow entry is added to robots.txt. This setting will inherit to all child pages.

    img-4

  • In most cases, the default settings for the sitemap should be fine. In this case the search engines assume a normal priority of 0.5. If required an individual value 0.0 < x <= 1.0 can be defined in the seo Tab:

  • img-3 Only when a value > 0.0 and different to 0.5 is selected, it will be included in sitemap.xml, as 0.5 is assumed to be default. However, this setting as well as the expected change frequency does not affect the ranking of a page in the search engine. It is more or less inteded as hint for the robots. See also http://sitemaps.org

Metatags

img-5 Page settings: edit the individual meta tags for each page (keywords, description). If one page does not have keywords or description but a page in the root line does, the next in the rootlne is used instead

Administration

  • Download the extension and install it

  • Set the starting point in the page tree, from where the sitemap.xml shall be created

    img-6

  • Include the static template (hriseo)

  • remove typo3conf/realurlautoconf.php – The Search Engine Toolkit will automatically hook into the configuration of realurl and add /robots.txt and /sitemap.xml to your domain

  • clear the cache

  • Contants editor: define the default author, language, copyright, which will be displayed on every page. Leave fields empty to remove those meta tags completely

  • img-7

Configuration

Reference

TypoScript Constants

all properties can be accessed via plugin.tx_hriseo.settings e.g.:

plugin.tx_hriseo.settings.robots = index,follow
robots

Property

robots

Data type

string

Description

Add robots meta tag with these values to each page unless Include in Search is disabled. Leave blank for none.

Default

index,follow

autor

Property

autor

Data type

string

Description

Default autor meta to be added on each page if no author is set per page or in rootline of page. Leave blank for none.

Default

language

Property

language

Data type

string

Description

Default language code of site

For localizations set the default language plus the corresponding lang in TypoScript (not constants):

plugin.tx_hriseo.settings {
    language = de
}
page.meta {
   language = {$plugin.tx_hriseo.settings.language}
   language.lang {
      en = en
   }
}

Default

de

baseURL

Property

baseURL

Data type

string

Description

URL of the site – required for sitemap.xml, robots.txt and realUrl. Mind the trailing slash!

plugin.tx_hriseo.settings {
    baseURL = http://hr-interactive.com/
}

Default

TypoScript Setup

all properties can be accessed in setup.:

page = PAGE
page.10 < plugin.tx_hriseo.robots
plugin.tx_hriseo.canonical

Property

plugin.tx_hriseo.canonical

Data type

string/html

Description

The canonical meta tag

Default

plugin.tx_hriseo.robots

Property

plugin.tx_hriseo.robots

Data type

string/html

Description

Output of the robots.txt file content (is include also in ?type=201)

Default

plugin.tx_hriseo.sitemap

Property

plugin.tx_hriseo.sitemap

Data type

String/xml

Description

XML file ready to be submitted to search engines. The output is also available at /?type=202

Default

page.headerData.508

Property

page.headerData.508

Data type

string/html

Description

Title tag

Default

page.headerData.509

Property

page.headerData.509

Data type

string/html

Description

Place where we add the canonical link info in the header

Default

page.meta.title

Property

page.meta.title

Data type

stdWrap

Description

Either title (or subtitle if no title is defined)

Default

page.meta.keywords

Property

page.meta.keywords

Data type

stdWrap

Description

Keywords of this page, if empty keywords form the next page in rootline is used

Default

page.meta.author

Property

page.meta.author

Data type

stdWrap

Description

Author of this page. If non given for page either the next in rootline or default from constants is used

Default

page.meta.date

Property

page.meta.date

Data type

stdWrap

Description

Date of the last change of this page

Default

page.meta.robots

Property

page.meta.robots

Data type

stdWrap

Description

Index,follow unless “Include in Search” is disabled for a page

Default

robots

Property

robots

Data type

page

Description

Type = 201

Default

sitemap

Property

sitemap

Data type

Page

Description

Type = 202

Default

The extension addes two additional page types: 201, containing the robots.txt data and type=202 for the sitemap. After the successful installation, you might want to access these with

http://yourdomain.org/?type=201
     http://yourdomain.org/?type=202

Credits

Developed by Ralf Schneider and supported hr-interactive:

h ttp://hr-interctive.com

Google Sitemap Description:

h ttp://sitemaps.org

To-Do list

ChangeLog

0.1.0

Version

0.1.0

Changes

First version

0.2.0

Version

0.2.0

Changes

Added robot.txt

0.3.0

Version

0.3.0

Changes

Added Sitemap.xml

0.4.0

Version

0.4.0

Changes

Fixes and update of documentation

0.5.0

Version

0.5.0

Changes

Recursive inheritance of changefreq, no_search and priority settings into sitemap.xml and robots

1.0.0

Version

1.0.0

Changes

First stable: update manual and some small changes

img-2 11