.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ==================================== 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: 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: Table of Contents ----------------- `EXT: Search Engine Toolkit 1 <#__RefHeading__5551_1752220325>`_ **`Introduction 3 <#__RefHeading__5553_1752220325>`_** `What does it do? 3 <#__RefHeading__5555_1752220325>`_ `Screenshots 3 <#__RefHeading__5569_1752220325>`_ **`Users manual 4 <#__RefHeading__5573_1752220325>`_** `sitemap.xml / robots.txt 4 <#__RefHeading__20566_1498267658>`_ `Metatags 5 <#__RefHeading__20568_1498267658>`_ **`Administration 6 <#__RefHeading__5575_1752220325>`_** **`Configuration 7 <#__RefHeading__5577_1752220325>`_** `Reference 7 <#__RefHeading__5581_1752220325>`_ **`Credits 9 <#__RefHeading__20572_1498267658>`_** **`To-Do list 10 <#__RefHeading__5583_1752220325>`_** **`ChangeLog 11 <#__RefHeading__5585_1752220325>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: 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: 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: Users manual ------------ .. _sitemap-xml-robots-txt: 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: 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: 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: Configuration ------------- .. _Reference: Reference ^^^^^^^^^ .. _TypoScript-Constants: TypoScript Constants """""""""""""""""""" all properties can be accessed via plugin.tx\_hriseo.settings e.g.: :: plugin.tx_hriseo.settings.robots = index,follow .. ### BEGIN~OF~TABLE ### .. _robots: robots ~~~~~~ .. container:: table-row 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: autor ~~~~~ .. container:: table-row 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 .. _copyright: copyright ~~~~~~~~~ .. container:: table-row Property copyright Data type string Description Adds meta tag with copyright notice on every page. Leave blank for none Default .. _language: language ~~~~~~~~ .. container:: table-row 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: baseURL ~~~~~~~ .. container:: table-row 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 .. ###### END~OF~TABLE ###### .. _TypoScript-Setup: TypoScript Setup """""""""""""""" all properties can be accessed in setup.: :: page = PAGE page.10 < plugin.tx_hriseo.robots .. ### BEGIN~OF~TABLE ### .. _plugin-tx-hriseo-canonical: plugin.tx\_hriseo.canonical ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property plugin.tx\_hriseo.canonical Data type string/html Description The canonical meta tag Default .. _plugin-tx-hriseo-robots: plugin.tx\_hriseo.robots ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: plugin.tx\_hriseo.sitemap ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: page.headerData.508 ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property page.headerData.508 Data type string/html Description Title tag Default .. _page-headerData-509: page.headerData.509 ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property page.headerData.509 Data type string/html Description Place where we add the canonical link info in the header Default .. _page-meta-title: page.meta.title ~~~~~~~~~~~~~~~ .. container:: table-row Property page.meta.title Data type stdWrap Description Either title (or subtitle if no title is defined) Default .. _page-meta-keywords: page.meta.keywords ~~~~~~~~~~~~~~~~~~ .. container:: table-row 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: page.meta.author ~~~~~~~~~~~~~~~~ .. container:: table-row 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: page.meta.date ~~~~~~~~~~~~~~ .. container:: table-row Property page.meta.date Data type stdWrap Description Date of the last change of this page Default .. _page-meta-robots: page.meta.robots ~~~~~~~~~~~~~~~~ .. container:: table-row Property page.meta.robots Data type stdWrap Description Index,follow unless “Include in Search” is disabled for a page Default .. _page-meta-copyright: page.meta.copyright ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property page.meta.copyright Data type stdWrap Description Copyright of this page – alternative nex copyright in rootline is used or if none found the default as defined in constants. Default .. _robots: robots ~~~~~~ .. container:: table-row Property robots Data type page Description Type = 201 Default .. _sitemap: sitemap ~~~~~~~ .. container:: table-row Property sitemap Data type Page Description Type = 202 Default .. ###### END~OF~TABLE ###### 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: Credits ------- Developed by Ralf Schneider and supported hr-interactive: h `ttp://hr-interctive.com `_ Google Sitemap Description: h `ttp://sitemaps.org `_ .. _To-Do-list: To-Do list ---------- .. _ChangeLog: ChangeLog --------- .. ### BEGIN~OF~TABLE ### .. _0-1-0: 0.1.0 ^^^^^ .. container:: table-row Version 0.1.0 Changes First version .. _0-2-0: 0.2.0 ^^^^^ .. container:: table-row Version 0.2.0 Changes Added robot.txt .. _0-3-0: 0.3.0 ^^^^^ .. container:: table-row Version 0.3.0 Changes Added Sitemap.xml .. _0-4-0: 0.4.0 ^^^^^ .. container:: table-row Version 0.4.0 Changes Fixes and update of documentation .. _0-5-0: 0.5.0 ^^^^^ .. container:: table-row Version 0.5.0 Changes Recursive inheritance of changefreq, no\_search and priority settings into sitemap.xml and robots .. _1-0-0: 1.0.0 ^^^^^ .. container:: table-row Version 1.0.0 Changes First stable: update manual and some small changes .. ###### END~OF~TABLE ###### |img-2| 11 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 130 .. :id: Grafik3 .. :name: Grafik3 .. :width: 667 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 321 .. :id: Grafik4 .. :name: Grafik4 .. :width: 474 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 234 .. :id: Grafik8 .. :name: Grafik8 .. :width: 410 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 89 .. :id: Grafik1 .. :name: Grafik1 .. :width: 414 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 394 .. :id: Grafik7 .. :name: Grafik7 .. :width: 454