quintagroup.seoptimizer 4.3

Quintagroup Search Engine Optimization Tool

Introduction

Quintagroup Search Engine Optimization Tool (quintagroup.seoptimizer) was created to enhance SE visibility of Plone sites.

quintagroup.seoptimizer allows per document editing of:

• HTML Title tag

• META description tag

• META keywords tag

• HTML comment into page header

• HTML noframes tag into page header

• META robots tag

• META Disposition tag

• Canonical URl http://projects.quintagroup.com/products/wiki/qSEOptimizer#CanonicalURL

For Title, description keywords and comment you have statistics (total/stop/used words, field length counter).

IMPORTANT

Starting from 3.0 release - quintagroup.seoptimizer package does not need ‘overrides.zcml’ file. So please remove ‘quintagroup.seoptimizer-overrides’ line from your buildout’s ZCML area.

Usage

• Go to Plone Control Panel, enable Plone SEO for desired content types

• Go to a document (Blog entry, news item, event, etc)

• Switch to SEO Properties tab

• Select Override checkboxes of features you want to override

• Type-in your SEO values

• Save changes

• Do this for all documents that need enhanced SEO properties

Requirements

• Plone 3.x, Plone 4.x

quintagroup.seoptimizer requires plone.browserlayer package to be installed in your site. plone.browserlayer package is shipped with Plone >= 3.1 and thus you don’t need anything extra when you have that version of Plone.

But for Plone 3.0.x < 3.1 the process looks like this:

• if you are creating a new Plone site and want it to support Quintagroup Search Engine Optimization Tool, just select 2 extension profiles Local browser layer support and quintagroup.seoptimizer profile in ‘Extension Profiles’ when adding a new Plone site;

• if you want to add quintagroup.seoptimizer to already-existing Plone site, you need to apply Local browser layer support extension profile and then quintagroup.seoptimizer profile. You can do it either in portal_setup/Import or in portal_quickinstaller by simple installation procedure.

In Plone 3.1 you can simply install quintagroup.seoptimizer profile in portal_quickinstaller without need of prior installation of Local browser layer support (that is not available for installation anyway, since it is a part of core system).

IMPORTANT! For Plone 3.0.x you should use plone.browserlayer 1.0.rc3. Be sure to define the right version of plone.browserlayer in your buildout.cfg. For Plone 3.1.x just use the version you have.

Notes

• For Plone 4 versions - use Plone SEO 4.0 release and up https://pypi.python.org/pypi/quintagroup.seoptimizer/4.0. In your buildout.cfg file’s egg section set product version:

  [buildout]
  ....
  eggs =
       ...
       quintagroup.seoptimizer >=4.0

• For Plone 3 versions - use the latest Plone SEO 3.x release https://pypi.python.org/pypi/quintagroup.seoptimizer/3.0.5. In your buildout.cfg file’s egg section set product version:

  [buildout]
  ....
  eggs =
       ...
       quintagroup.seoptimizer >3.0,<4.0

• For Plone 2.x versions - use Plone SEO 1.7.1 release https://pypi.python.org/pypi/quintagroup.seoptimizer/1.7.1

Links

Watch Plone SEO screencast http://quintagroup.com/cms/screencasts/plone-seo to learn how to install and set up Plone SEO on a buildout-based Plone instance for Plone 3.2 or above.

Authors

• Myroslav Opyr

• Andriy Mylenkyy

• Volodymyr Cherepanyak

• Vitaliy Podoba

• Taras Melnychuk

• Mykola Kharechko

• Vitaliy Stepanov

• Volodymyr Romaniuk

• Volodymyr Maksymiv

• Taras Kozlovskyy

• Roman Kozlovskyi

Contributors

• Michael Krishtopa (Theo) testing bug reporting

• Craig Russell

Installation

Buildout

If you are using zc.buildout and the plone.recipe.zope2instance recipe to manage your project:

• Add quintagroup.seoptimizer to the list of eggs to install, e.g.:

  For Plone 4.x - in your buildout.cfg file write:

  [buildout]
  ....
  eggs =
       ...
       quintagroup.seoptimizer >=4.0

  For Plone 3 - in your buildout.cfg file write:

  [buildout]
  ....
  eggs =
       ...
       quintagroup.seoptimizer >3.0,<4.0

• Tell the plone.recipe.zope2instance recipe to install a ZCML slug:

  [instance]
  ...
  zcml =
      quintagroup.seoptimizer

• Re-run buildout, e.g. with:

  $ ./bin/buildout

• Restart the Zope server, e.g with the following command in the terminal:

  $ ./bin/instance restart

Install quintagroup.seoptimizer via ZMI portal_setup -> Import tab. Select quintagroup.seoptimizer from the list of available profiles and press Import all steps.

Uninstallation

To uninstall quintagroup.seoptimizer - go to ZMI portal_setup -> Import tab. Select quintagroup.seoptimizer uninstall profile from the list of available profiles and press Import all steps.

Package Upgrade / Reinstall

In case you want to upgrate quintagroup.seoptimizer to a newer version in your buildout:

• Remove quintagroup.seoptimizer-overrides from buildout.cfg file’s ZCML area if it is there (starting from 3.0 release - quintagroup.seoptimizer package does not use overrides.zcml file any longer)

• Upgrade quintagroup.seoptimizer to the newer version using buildout (rerun the buildout to replace old package with a new one in your instance)

• Run the reinstall procedure: visit “Site Setup” -> “Add-ons” control panel in your Plone site, where you have to press quintagroup.seoptimizer button next to Upgrade. (The same can be done with quickinstaller via ZMI: at /portal_quickinstaller/manage_installProductsForm: check the seoptimizer box and press Reinstall button.) This is an essential step as new version of product introduces new persistent settings and ways to migrate settings/content from old to new version.

Changelog

4.3 (2013-09-18)

• Added Dexterity content types support [kroman0]

4.2.1 (2013-01-16)

• Fixed compatibility with Plone 4.3.x [ktarasz]

• Fixed code for pep8 and pyflakes [kroman0,ktarasz]

• Fixed classifiers and keywords [kroman0]

4.2.0 (2012-07-02)

• added ‘HTML Noframes’ property [ktarasz]

4.1.3 (2012-03-02)

• escape non-string types fixed [kroman0]

4.1.2 (2012-01-30)

• extended tags escaping function for quotes and apostrophes. Thanks to Graig Russell for pointing this out.

4.1.1 (2011-11-23)

• Fixed seo fields escaping. [vmaksymiv]

4.1.0 (2011-10-28)

• Compatibility with Plone 4.1 added. [vmaksymiv]

• Fixed doc tests for Plone 4.1. Plone 4.1. introduced ‘Log in’ python script (“[your_domain/plone_site]/login”) instead of form in earlier Plones. [vmaksymiv]

4.0.6 (2011-06-06)

• Fixed canonical link display, it is now not added as default property.http://plone.org/products/plone-seo/issues/33, [vmaksymiv]

4.0.5 (unreleased)

• Fixed title escaping, http://plone.org/products/plone-seo/issues/31, [vmaksymiv]

4.0.4 (2010-11-05)

• Fixed “Cancel” button processing by SEO Properties form on the context. Thanks Vitaliy Podoba for report. [mylan]

4.0.3 (2010-11-05)

• Merged fixes from v3.0.7, [mylan]

• Fixed plone-3.X compatibility, [mylan]

3.0.7 (2010-10-20)

• Removed lynx dependency, fixed http://plone.org/products/plone-seo/issues/28 issue. [mylan]

• Added ‘External keywords test’ option to SEO configlet. Keyword validation can occur against HTML produced by Plone itself or against one processed externally with Deliverance/xdv. [mylan]

4.0.1 (2010-08-04)

• Removed tabindex form tags attributes from seo-context view [mylan]

4.0 (2010-06-02)

• Release 4.0 version for Plone-4.X

3.0.5 (2010-05-15)

• Fix version issue in metadata.xml [crchemist]

3.0.4 (2010-05-05)

• Added overrides.zcml for BBB http://plone.org/products/plone-seo/issues/19, http://plone.org/products/plone-seo/issues/23 [mylan]

• Prevent view breakage for context, which canonical url can’t be calculated for http://plone.org/products/plone-seo/issues/22 [mylan]

• Fixed security issue for SEO Property action and view http://plone.org/products/plone-seo/issues/24 [crchemist, mylan]

3.0.1 (2010-04-29)

• Bad title tag definition fixed http://plone.org/products/plone-seo/issues/20 [crchemist]

3.0 (2010-04-20)

• Drop global keywords functionality [mylan]

• Fix performance issues [mylan]

• Reviewed, updated tests [mylan]

• Moved all metatags list into htmlhead viewletmanager [mylan]

• Added advanced tab to seo configlet [mylan]

• Rewrite seo configlet - use standard plone configlet approach [mylan]

• Use collective.monkeypatcher package for listMetatags patch [liebster]

• Killed accessors usage in ‘metatags order’ property [liebster]

• Changed management of ‘SEO’ tab visiblity for different portal types [liebster]

• Implemented migration to new version [liebster]

• Cleanup code [mylan]

• Extend package’s requirements, register in z3c.autoinclude entry-point [mylan]

• Translations rebuilt [mylan]

• Typo in fields description of seo_configlet fixed [mylan]

• Ukrainian translations updated [mylan]

2.3.4 (2010-03-30)

• Fixed bugs with using domain by custom content type.

• Missing icon added

2.3.3 (2010-02-22)

• Fixed content types translation

2.3.2 (2010-02-16)

• Removed the broken keywords filtering code (fixed the issue #10 decode error) [chervol]

2.3.0 (2010-02-08)

• Added condition install or reinstall package [liebster]

• Added filter keywords by their availability in content [liebster]

• Added settings to control Plone categories and global SEO keywords behaviour [liebster]

• Added settings to control Plone global SEO keywords vs local SEO keywords behaviour [liebster]

2.2.0 (2010-01-06)

• Refactor seo_context_properties cpy script to browser view [liebster]

• Added search numbers of keywords at page [liebster]

2.1.1 (2009-11-09)

• Fixed bug of meta-tags absence for folderish objects [mylan]

2.1.0 (2009-10-21)

• Added metatags order feature, which is managed by metatags_order property of of configlet [liebster]

• Resolved metatags duplication [liebster]

2.0.9 (2009-09-10)

• Fixed bugs in metatags viewlet [liebster]

2.0.8 (2009-07-28)

• Added use of default meta tags from the control panel in metatags viewlet [liebster]

2.0.7 (2009-07-25)

• Fix url action in qseo_properties_edit_form [liebster]

2.0.6 (2009-05-19)

• Fix page title tag, now it is not duplicated in case site and current page have equal titles [piv]

2.0.5 (2009-04-03)

• Fix seoptimizer intrusion before installation to plone instance [mylan]

• Fix base url for folderish objects [mylan]

• Bind viewlets to specific layer and set viewlets order for all skins. [mylan]

2.0.4 (2009-03-31)

• Canonical url support added [mylan]

• Custom script viewlets in html head added

2.0.2 (2009-03-06)

• Uninstallation package profile title added

• REAME.txt and INSTALL.txt changed, text format ready for PyPi

2.0.1 (2009-02-16)

• Formatted text in docs for PyPi

2.0.0 (2009-02-11)

• Some refactoring of product was done, some python script are moved to zope 3 views. Also all main parts of html head section were moved to viewlets and now can easily be reordered.

1.5.1

• Support of additional keywords added.