collective.liches 0.1

Introduction
============
Keeping the links in your site up to date is hard and unappreciated work.
Content editors need all the help and incentive they can get to do
this job. liches_ tries to make this task a bit easier.


Installation
============

Liches
-------

You have to install a liches_ linkchecker server for this product to work.
please follow the liches_ installation instructions and make sure your
liches_ server works before installing the plone product.


Plone
------

This addon can be installed has any other addons, please follow official
documentation_.

.. _documentation: http://plone.org/documentation/kb/installing-add-ons-quick-how-to



Usage
======

Configure the access to your liches Linkchecker serser and which content
types will be displayed on your link checker start page in the plone
control panel:

.. image:: https://raw.github.com/collective/collective.liches/master/docs/liches-settings.png


Linkcheckers normally go through your site recursivly which
will result in many pages to be checked several times. The
linkchecker start pages tries to avoid this by giving the
linkchecker_ a page from which every relevant content item can be reached.
Append `@@linkchecker-startpage.html` to your siteroot to view this page.

.. image:: https://raw.github.com/collective/collective.liches/master/docs/linkchecker-startpage.png

append `@@linkchecker-brokenpages.html` to your site root or to any
folder(ish object) in your site. This will show you a view with links
to all pages with broken links in this path.

.. image:: https://raw.github.com/collective/collective.liches/master/docs/broken-pages-in-site.png

All pages will show you (as long as you are able to edit it) which links
are broken. At the top you see a summary of the links and the result
of the linkcheck. Broken Links are highlighted and underlined in red.

.. image:: https://raw.github.com/collective/collective.liches/master/docs/broken-links-in-page.png

Similar Products
================

You may also want to have a look at the competition.

gocept.linkchecker_ relies on a separate process gocept.lms_ to perform
external link-checking. It communicates with Plone via XML-RPC.

collective.linkcheck_ is an integrated solution, with a headless instance
processing items in the background.

Why yet another solution?
-------------------------

- I want my linkchecking to be independent from plone and to be
able to monitor non plone sites with the same tool.
- Linkchecking is hard. The venerable linkchecker_ is a tried and tested
tool that does this job good. It has lots of options to finetune the results
to your needs e.g. to check the validity of HTLM and CSS.

.. _linkchecker: http://wummel.github.io/linkchecker/
.. _liches: https://github.com/cleder/liches
.. _gocept.lms: https://pypi-hypernode.com/pypi/gocept.lms/
.. _gocept.linkchecker: https://pypi-hypernode.com/pypi/gocept.linkchecker/
.. _collective.linkcheck: https://pypi-hypernode.com/pypi/collective.linkcheck/

Changelog
=========

0.1dev (2013/07/31)
-------------------

- Initial release