{ "info": { "author": "Kees Hink", "author_email": "hink@gw20e.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Plone", "Framework :: Plone :: 4.3", "Intended Audience :: End Users/Desktop", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Topic :: Internet", "Topic :: Scientific/Engineering :: GIS", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": ".. image:: https://travis-ci.org/collective/Products.Doormat.png\n :target: https://travis-ci.org/collective/Products.Doormat\n\n.. image:: https://coveralls.io/repos/collective/Products.Doormat/badge.png\n :target: https://coveralls.io/r/collective/Products.Doormat\n\n\nIntroduction\n============\n\nA doormat is a couple of links which are presented in a structured\nway. One example is the current plone.org_, where the div#sitemap at the bottom\nconsists of some ordered bundles of internal and external links, with sections\ncalled \"Downloads\", \"Documentation\", \"Developers\", \"Plone foundation\" and\n\"Support\". See more examples_ of doormats.\n\nThis product adds a couple of content types (Archetypes), which are used to\ncreate a structure which is used for generating a doormat. A viewlet on this\ndoormat is placed in the Plone footer. The links in the Doormat are managed as\ncontent, making the Doormat more flexible than a sitemap. It's also possible\nto add external links. It's also possible to add bits of text, with markup.\n\n\nQuick feature overview\n======================\n\n* Internal links\n* External links\n* Text blocks (including images)\n* Links from Plone Collections\n* Can have any number of columns\n* Can have multiple sections per column\n\n\nSimilar products\n================\n\ncollective.doormat\n------------------\n\ncollective.doormat_ also lets you creates a doormat in your site, but takes a different approach: Instead of creating a structure of content objects, it offers a configuration panel where you can create the doormat in a single rich text field.\n\nThis approach is a lot easier for maintaining the doormat.\n\nIt doesn't take permissions into account, so links might point to internal content to which the visitor viewing the page has no access. There is also no way to add content from collections.\n\n\nGetting started\n===============\n\nAfter installing the product in your site, you should have a \"Doormat\" item in\nyour Plone site, which should show up in the folder contents of the site.\nInside it, you can create a hierarchical structure of Columns,\nSections, links (both internal and external), Documents (Plone's Page type),\nand Links to a Collection (DoormatCollection).\nThere should be one Column, one Section and one Document already there.\n\nThe Doormat may look like this, schematically::\n\n +-- Doormat ----------------------------------------------------------------------------+\n | |\n | +-- Column 1 ----------+ +-- Column 2----------+ +-- Column 3 ------------------+ |\n | | | | | | | |\n | | +-- Section 1 ----+ | | +-- Section 1 ----+ | | +-- Section 1 -------------+ | |\n | | | | | | | | | | | | | |\n | | | +-- Link 1 --+ | | | | +-- Link 1 --+ | | | | +-- Document 1 -------+ | | |\n | | | +------------+ | | | | +------------+ | | | | | | | | |\n | | | | | | | | | | | | (Contact info) | | | |\n | | | +-- Link 2 --+ | | | | +-- Link 2 --+ | | | | | | | | |\n | | | +------------+ | | | | +------------+ | | | | +---------------------+ | | |\n | | | | | | | | | | | | | |\n | | | +- Document -+ | | | | | | | | +- DoormatCollection -+ | | |\n | | | | | | | | | | | | | | | | | |\n | | | | | | | | | | | | | | Item 1 from Collctn | | | |\n | | | +------------+ | | | | | | | | | Item 2 from Collctn | | | |\n | | | | | | | | | | | | (...) | | | |\n | | | | | | | | | | | | Link to Collection | | | |\n | | | | | | | | | | | | | | | |\n | | | | | | | | | | | +---------------------| | | |\n | | | | | | | | | | | | | |\n | | +-----------------+ | | +-----------------+ | | +--------------------------+ | |\n | | | | | | | |\n | +----------------------+ +---------------------+ +------------------------------+ |\n | |\n +---------------------------------------------------------------------------------------+\n\nIn fact, you can add more than one section, they will be displayed below each\nother. In each section, you can mix internal links, external links and\nDocuments.\n\nAnd in real life:\n\n.. image:: http://plone.org/products/doormat/screenshot\n\nNote that the product adds an extra hierarchical layer compared to the\nplone.org_ doormat: it adds a Column, which can contain more than one Section.\nAn example using this structure is the Oosterpoort_, which actually is the\nproduct's predecessor.\n\n\nAdding a Document\n=================\n\nAdding and editing a Document to the Doormat is just as simple as adding it in\nany other place. However, keep this in mind that only the \"Body text\" field\nwill be displayed in the Doormat. Other fields, most notably the title and\ndescription will be omitted.\n\nLinks in a Document\n-------------------\n\nBy default, relative links will be created from the place where the Document\nlives. This link is then displayed in the Doormat on all pages, so it is very\nlikely to be broken.\n\nThe solution is to make your editor insert links by uid. With TinyMCE on Plone\n4, you can enable \"link by uid\" by going to the \"Resource types\" tab on TinyMCE\nSettings (via the \"Site setup\"), and checking the box called \"Link using UIDs\".\n\nThis will apply to the whole site. You may want to revert to the default\nsetting after you've added the link, as relative links are more desirable in\ngeneral.\n\nAdding an Image\n---------------\n\nTo add an image to the Doormat, add a Document and include an image there. It's\nnot possible to upload an Image to a DoormatSection, so you need to upload the\nimage to another place in your site first.\n\nMake sure you enable \"Link using UIDs\" (see above) first, because defining the\nimage's location in a relative way will break in the same way as a relative\nlink will break.\n\nLinks to Collections\n====================\n\nIt's also possible to add a \"Link to Collection\" item (DoormatCollection). This\nallows yout to point to a Plone Collection object, and take the items from\nthat.\n\n\nSimple configuration\n====================\n\nBy default, the Doormat is excluded from navigation.\n\nThere's a field `showTitle` on the folderish types (Doormat, Column and\nSection) which allows content managers to decide if the item's title should be\ndisplayed in the doormat.\n\n\nMore advanced configuration and styling\n=======================================\n\nThis section is intended for integrators and/or developers who would like to\ncustomize the way the doormat is rendered in more detail.\n\nMoving the doormat\n------------------\n\nBy default, the default doormat viewlet (`doormat.footer`) is placed in the\n`plone.portalfooter` viewlet manager. It's easy to modify this in an add-on\nproduct, so the doormat will display below the global navigation (portal tabs),\nor anywhere else in the site.\n\n\nDisplaying the doormat without the extra div elements\n-----------------------------------------------------\n\nThe default viewlet renders the doormat inside Plone's default footer elements,\nso it blends in with Plone 4's default Sunburst Theme::\n\n