{ "info": { "author": "it-spirit", "author_email": "thomas.massmann@it-spir.it", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Plone", "Framework :: Plone :: 4.3", "Framework :: Plone :: 5.0", "Framework :: Plone :: 5.1", "Framework :: Plone :: 5.2", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", "Programming Language :: Python", "Programming Language :: Python :: 2.7" ], "description": "====================\nspirit.plone.theming\n====================\n\nThis Plone Add-On provides some theming extensions for `Plone `_ Websites.\nIn order to use it, you would need a diazo theme which supports the provided options.\n\n\nMostly Harmless\n===============\n\n.. image:: https://img.shields.io/pypi/v/spirit.plone.theming.svg\n :target: https://pypi.python.org/pypi/spirit.plone.theming\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/spirit.plone.theming.svg\n :target: https://pypi.python.org/pypi/spirit.plone.theming\n :alt: Supported Python Versions\n\n.. image:: https://img.shields.io/travis/it-spirit/spirit.plone.theming/master.svg\n :target: http://travis-ci.org/it-spirit/spirit.plone.theming\n :alt: Travis CI status\n\n.. image:: https://img.shields.io/coveralls/github/it-spirit/spirit.plone.theming/master.svg\n :target: https://coveralls.io/github/it-spirit/spirit.plone.theming?branch=master\n :alt: Coverage Status\n\n.. image:: https://img.shields.io/readthedocs/spiritplonetheming.svg\n :target: http://spiritplonetheming.readthedocs.io\n :alt: Documentation\n\n\nAvailable Options\n=================\n\nBelow is a list of currently supported options.\nNote that not every theme by default supports all of those options.\n\nEnable Debug Mode\n-----------------\n\nIf enabled, the content of the diazo snippets will be visible to the user.\nIf disabled, the content is hidden with CSS.\nThere is also a debug option which will be available as content with the CSS id ``PLONE_THEMING_DEBUG`` if enabled.\nThe default is set to ``False``.\n\nDiazo example::\n\n \n \n
\n
\n
\n \n
\n
\n
\n
\n\n\nSite Logo\n---------\n\nWhen running on Plone 4, you can upload a custom site logo for your Plone site.\nIn Plone 5 the site logo can be customized in the site settings, so this setting will only be available for Plone 4 or below.\nIf no custom logo is set, Plone's default logo will be used.\nFor Plone 4 and below, there is a custom logo viewlet which will render the logo based on the theme setting.\n\n\nSite Favicon\n------------\n\nYou can upload a custom favicon for your Plone site.\nAny image format can be uploaded, but \\*.ico and \\*.png files work best.\nIf no custom icon is set, Plone's default favicon will be used.\nThe favicon link HTML markup will be available as content with the CSS id ``PLONE_THEMING_FAVICON``.\n\nDiazo example::\n\n \n\n\nHeader Option\n-------------\n\nYou can select one of the available header options which are provided by the theme, e.g. ``header-v1`` and ``header-v2``.\nIf no option is selected, the theme might render a default header.\nThe selected header option will be available as content with the CSS id ``PLONE_THEMING_HEADER_OPTION``.\nThe theme should set all available header options using the ``spirit.plone.theming.interfaces.IPloneThemingVocabularies.available_header_options`` registry key.\n\nDiazo example::\n\n \n \n\n ...\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n\n\nFooter Option\n-------------\n\nYou can select one of the available footer options which are provided by the theme, e.g. ``footer-v1`` and ``footer-v2``.\nIf no option is selected, the theme might render a default footer.\nThe selected footer option will be available as content with the CSS id ``PLONE_THEMING_FOOTER_OPTION``.\nThe theme should set all available footer options using the ``spirit.plone.theming.interfaces.IPloneThemingVocabularies.available_footer_options`` registry key.\n\nDiazo example::\n\n \n \n\n ...\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n\n\nColor Option\n------------\n\nYou can select one of the available color options which are provided by the theme, e.g. ``blue`` and ``red``.\nIf no option is selected, the theme might use a default color.\nThe selected color option will be available as content with the CSS id ``PLONE_THEMING_COLOR_OPTION``.\nThe theme should set all available color options using the ``spirit.plone.theming.interfaces.IPloneThemingVocabularies.available_color_options`` registry key.\n\nDiazo example::\n\n \n \n \n \n \n\n \n \n \n \n\n\nPattern Option\n--------------\n\nYou can select one of the available background pattern options which are provided by the theme, e.g. ``diagonal-noise`` and ``fabric-plaid``.\nIf no option is selected, the theme might use a default pattern.\nThe selected pattern option will be available as content with the CSS id ``PLONE_THEMING_PATTERN_OPTION``.\nThe theme should set all available pattern options using the ``spirit.plone.theming.interfaces.IPloneThemingVocabularies.available_pattern_options`` registry key.\n\nThis option could also be used to switch between color modes, e.g. ``light`` and ``dark``, if no patterns are available in the theme.\n\nDiazo example::\n\n \n \n\n ...\n\n \n \n \n \n \n \n \n \n \n\n\nLayout Option\n-------------\n\nYou can select one of the available layout options which are provided by the theme, e.g. ``wide`` and ``boxed``.\nIf no option is selected, the theme might use a default layout.\nThe selected layout option will be available as content with the CSS id ``PLONE_THEMING_LAYOUT_OPTION``.\nThe theme should set all available layout options using the ``spirit.plone.theming.interfaces.IPloneThemingVocabularies.available_layout_options`` registry key.\n\nDiazo example::\n\n \n \n\n ...\n\n \n \n \n\n \n \n \n \n \n \n\n ...\n\n \n \n\n\nSlogan\n------\n\nAdd a slogan for your website (HTML is supported).\nThe slogan will be available as content with the CSS id ``PLONE_THEMING_SLOGAN``.\n\nDiazo example::\n\n \n \n\n\nPhone Number\n------------\n\nAdd a phone number for your primary website contact.\nThe phone number will be available as content with the CSS id ``PLONE_THEMING_PHONE_NUMBER`` and ``PLONE_THEMING_PHONE_NUMBER_RAW`` (all non-number characters removed).\n\nDiazo example::\n\n \n \n\n\nE-Mail Address\n--------------\n\nAdd a valid email address.\nThe email address will be available as content with the CSS id ``PLONE_THEMING_EMAIL``.\n\nDiazo example::\n\n \n \n\n\nHide Search Box\n---------------\n\nIf enabled, the search box (available in the header part) will be removed in the theme.\nThe searchbox option will be available as content with the CSS id ``PLONE_THEMING_HIDE_SEARCHBOX`` if enabled.\n\nDiazo example::\n\n \n \n
site-search \n
\n \n \n \n \n
\n \n
\n
\n \n\n\nCustom Footer Text\n------------------\n\nAdd your custom footer text (HTML is supported).\nThe footer text will be available as content with the CSS id ``PLONE_THEMING_FOOTER_TEXT``.\nYou can also add the following variables:\n\n- ``{portal_url}``\n- ``{year}``\n\nExample::\n\n

© Copyright 2009-{year} Your Company Name.

\n\nDiazo example (Plone 5)::\n\n \n \n\n \n\n\nHide Footer Text\n----------------\n\nIf enabled, the footer text (available in the footer part) will be removed in the theme.\nThe footer option will be available as content with the CSS id ``PLONE_THEMING_HIDE_FOOTER`` if enabled.\n\nDiazo example::\n\n \n ...\n \n \n\n\nCustom Colophon Text\n--------------------\n\nAdd your custom colophon text (HTML is supported).\nThe colophon text will be available as content with the CSS id ``PLONE_THEMING_COLOPHON_TEXT``.\nYou can also add the following variables:\n\n- ``{portal_url}``\n- ``{year}``\n\nExample::\n\n

Powered by Plone, Python & Your Company Name

\n\n\nDiazo example (Plone 5)::\n\n \n \n\n \n\n\nHide Colophon Text\n------------------\n\nIf enabled, the colophon text (available in the footer part) will be removed in the theme.\nThe colophon option will be available as content with the CSS id ``PLONE_THEMING_HIDE_COLOPHON`` if enabled.\n\nDiazo example::\n\n \n ...\n \n \n\n\nAdditional Available Snippets\n=============================\n\nThe following snippets are always available, as soon as the add-on is activated.\n\nplone_version\n-------------\n\nIt will show the currently used Plone major version number.\nIt will be available as content with the CSS id ``PLONE_THEMING_PLONE_VERSION_${plone_version}``, e.g. ``PLONE_THEMING_PLONE_VERSION_4`` for Plone 4.\n\nDiazo example::\n\n \n \n \n\n \n \n \n\n\nthemingplugins_available\n------------------------\n\nChecks if `plone.app.themingplugins `_ is available.\nIt will be available as content with the CSS id ``PLONE_THEMING_THEMINGPLUGINS_AVAILABLE``.\n\nDiazo example::\n\n \n \n \n\n\nthemefragments_available\n------------------------\n\nChecks if `collective.themefragments `_ is available.\nIt will be available as content with the CSS id ``PLONE_THEMING_THEMEFRAGMENTS_AVAILABLE``.\n\nDiazo example::\n\n \n \n \n\n\nrapido_available\n----------------\n\nChecks if `rapido.plone `_ is available.\nIt will be available as content with the CSS id ``PLONE_THEMING_THEMEFRAGMENTS_AVAILABLE``.\n\nDiazo example::\n\n \n \n \n\n\nAdding Available Options From Within A Diazo Theme\n==================================================\n\nBy default, the available options for header, footer, color and layout are empty.\nBut a theme can add it's options to the list of available items by adding elements to the ``plone.registry`` based record values.\nThe values are then provided as a vocabulary to the theming settings.\nThe records are defined in ``spirit.plone.theming.interfaces.IPloneThemingVocabularies``.\nCurrently the following records are available:\n\n- ``available_header_options``\n- ``available_footer_options``\n- ``available_color_options``\n- ``available_layout_options``\n\nA theme could add the records on installation time using the ``registry.xml`` GenersicSetup import step::\n\n \n \n \n color-1\n color-2\n \n \n \n \n footer-default\n footer-v1\n footer-v2\n \n \n \n \n header-default\n header-v1\n header-v2\n \n \n \n \n boxed\n wide\n \n \n \n \n diagonal-noise\n fabric-plaid\n \n \n \n\nWhen the theme gets uninstalled, the entries should be removed.\nTo do this, add a ``registry.xml`` file to your uninstall profile with the following content::\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n``spirit.plone.theming`` has a dependency to `collective.themesitesetup `_, which allows the embedding of GenericSetup import and export steps into zipped theme packages.\nTo enable this, add the following lines to your theme's manifest.cfg::\n\n [theme:genericsetup]\n install = install\n uninstall = uninstall\n\nAdd the two folders ``install`` and ``uninstall`` next to your manifest.cfg and copy over the ``registry.xml`` files from above.\n\n\n.. note::\n\n Themes created with `spirit.bob `_'s ``diazo_theme`` template already include the dependency to ``spirit.plone.theming`` and the required ``registry.xml`` files.\n\nContributors\n------------\n\n- Thomas Massmann, thomas.massmann@it-spir.it\n\nChangelog\n=========\n\n\n0.9 (2019-03-07)\n----------------\n\n- Add Plone 5.2.x compatibility (Python 2.7 only).\n [tmassman]\n- Drop Plone 4.2.x compatibility.\n [tmassman]\n- Disable CSRF on controlpanel form due tu plone.formwidget.namedfile temp storage.\n [tmassman]\n\n\n0.8 (2018-01-17)\n----------------\n\n- Phone numbers starting with a '+' are getting a '00' country code prefix.\n [tmassman]\n- Replace deprecated plone.directives.form with plone.supermodel to remove grok dependencies.\n [tmassman]\n\n\n0.7 (2017-11-30)\n----------------\n\n- Remove 'slideshow_fullscreen' option.\n [tmassman]\n\n\n0.6 (2017-10-13)\n----------------\n\n- Add snippets to show availability of theming addons.\n [tmassman]\n\n\n0.5 (2017-05-18)\n----------------\n\n- Instead of providing a diazo snippet for the logo, provide a custom logo viewlet.\n [tmassman]\n\n\n0.4 (2017-05-18)\n----------------\n\n- Load collective.monkeypatcher, if available, to prevent ConfigurationError.\n [tmassman]\n- Add ``site_logo`` option to upload a custom site logo (Plone 4 only).\n [tmassman]\n\n\n0.3 (2017-01-24)\n----------------\n\n- Add option to hide footer and colophon texts completely.\n [tmassman]\n- Update installation docs and documentation images.\n [tmassman]\n\n\n0.2 (2017-01-12)\n----------------\n\n- Add ``site_favicon`` option to upload a custom favicon.\n [tmassman]\n- Update documentation.\n [tmassman]\n\n\n0.1 (2016-12-20)\n----------------\n\n- Initial release.\n [tmassman]", "description_content_type": "", "docs_url": null, "download_url": "http://pypi.python.org/pypi/spirit.plone.theming", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/it-spirit/spirit.plone.theming", "keywords": "plone zope theming", "license": "GPL version 2", "maintainer": "", "maintainer_email": "", "name": "spirit.plone.theming", "package_url": "https://pypi.org/project/spirit.plone.theming/", "platform": "", "project_url": "https://pypi.org/project/spirit.plone.theming/", "project_urls": { "Download": "http://pypi.python.org/pypi/spirit.plone.theming", "Homepage": "https://github.com/it-spirit/spirit.plone.theming" }, "release_url": "https://pypi.org/project/spirit.plone.theming/0.9/", "requires_dist": null, "requires_python": "", "summary": "Theming extensions for Plone Websites.", "version": "0.9" }, "last_serial": 4909192, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "b203d8aeda4a71a5bd9a23f899fa588c", "sha256": "7dfd34375c5f817bbbcdb167b58a7a37e34f65db324d8360ce124fe2fa621447" }, "downloads": -1, "filename": "spirit.plone.theming-0.1.tar.gz", "has_sig": false, "md5_digest": "b203d8aeda4a71a5bd9a23f899fa588c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 44112, "upload_time": "2016-12-20T20:39:12", "url": "https://files.pythonhosted.org/packages/b1/11/a4f780fe0121555a7cc156760ad7078ec6dd18c3fad3cc29754a9d903104/spirit.plone.theming-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "43d0a57f2142f96cda8a7e4271bd3fc9", "sha256": "4d862224550b8d931ffdedcdfb4aa6f56b44ea2243846ff7e431530d8fd82458" }, "downloads": -1, "filename": "spirit.plone.theming-0.2.tar.gz", "has_sig": false, "md5_digest": "43d0a57f2142f96cda8a7e4271bd3fc9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 496898, "upload_time": "2017-01-12T09:29:20", "url": "https://files.pythonhosted.org/packages/7b/12/e34d32182cba20a9f1d30e116898150c3c42a799450190dd2d76a51cb42b/spirit.plone.theming-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "36ab823d0ef46090ad571a4c3deaf8b5", "sha256": "68373b08e3d14dbe3f21c8e4a19326554166c583ca931e4dd2f88ae11a7e2155" }, "downloads": -1, "filename": "spirit.plone.theming-0.3.tar.gz", "has_sig": false, "md5_digest": "36ab823d0ef46090ad571a4c3deaf8b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 637137, "upload_time": "2017-01-24T12:04:08", "url": "https://files.pythonhosted.org/packages/1d/ff/fa31c2e20882ef73a035831442e2ba7c7d144bbeb941874ef654d21a1487/spirit.plone.theming-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "b49cb907cec63a435c7e11fbfc73feea", "sha256": "6df98ba829ba8af92b0c0e78a8ccaaf98f4f1c2a7668510769dc68e5701cc32a" }, "downloads": -1, "filename": "spirit.plone.theming-0.4.tar.gz", "has_sig": false, "md5_digest": "b49cb907cec63a435c7e11fbfc73feea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 638132, "upload_time": "2017-05-18T10:35:01", "url": "https://files.pythonhosted.org/packages/82/a4/2264a5eb1ba40989e2c0fb17151c0edd6ab29de2ebbae0ec3fdb4408c062/spirit.plone.theming-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "19e31c026df61e5dd0ccf1fe5cff68ab", "sha256": "6fda03a7a644118ca9d4f24d90bd924c0e5bde99b20485c9eacfb01a5337a161" }, "downloads": -1, "filename": "spirit.plone.theming-0.5.tar.gz", "has_sig": false, "md5_digest": "19e31c026df61e5dd0ccf1fe5cff68ab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 642338, "upload_time": "2017-05-18T12:33:29", "url": "https://files.pythonhosted.org/packages/6f/b5/619a7d96c8ebf00966ae3b08a4e996622a66ec2306df8d7e54186a6ed74a/spirit.plone.theming-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "aa3aae2812400d879ce23b3a0e27d92c", "sha256": "e64e119fdd9363659ca062c81fd82781acda19a1d0c06b640025c512c98388aa" }, "downloads": -1, "filename": "spirit.plone.theming-0.6.tar.gz", "has_sig": false, "md5_digest": "aa3aae2812400d879ce23b3a0e27d92c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 643416, "upload_time": "2017-10-13T06:55:03", "url": "https://files.pythonhosted.org/packages/f1/52/e1fa868aac429af3bd5e85b93a92f9475b21dc8beda2f455493a733fa3ee/spirit.plone.theming-0.6.tar.gz" } ], "0.7": [ { "comment_text": "", "digests": { "md5": "f05641c997cc43c457b2f568579dd6ef", "sha256": "45f87b607e93bdde7c12195b90b25231490d262af0b3ad5050ce5f4d9ef53ae8" }, "downloads": -1, "filename": "spirit.plone.theming-0.7.tar.gz", "has_sig": false, "md5_digest": "f05641c997cc43c457b2f568579dd6ef", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 597554, "upload_time": "2017-11-30T15:29:40", "url": "https://files.pythonhosted.org/packages/bd/2a/df0915f70292c4a3d081377969b41bbaf4ad021b84f97e859e4e31592028/spirit.plone.theming-0.7.tar.gz" } ], "0.8": [ { "comment_text": "", "digests": { "md5": "3385fe2e889b5227c913c021158ce742", "sha256": "d254923bc97d798dea86ee72fe6e0bf9c24325066f1e224593435ff84f894d42" }, "downloads": -1, "filename": "spirit.plone.theming-0.8.tar.gz", "has_sig": false, "md5_digest": "3385fe2e889b5227c913c021158ce742", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 598020, "upload_time": "2018-01-17T14:53:43", "url": "https://files.pythonhosted.org/packages/af/a6/f479cbeb059bb2dc3e2ff4db7b081588e0348904e703f5d1ca1dfecbb1bd/spirit.plone.theming-0.8.tar.gz" } ], "0.9": [ { "comment_text": "", "digests": { "md5": "a5c250caefa909bc9a80e91a611f9a00", "sha256": "aa8f800386f713f7fa7beed0fe69d6f925464e5c1f0e06386eee290ead617d11" }, "downloads": -1, "filename": "spirit.plone.theming-0.9.zip", "has_sig": false, "md5_digest": "a5c250caefa909bc9a80e91a611f9a00", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 634873, "upload_time": "2019-03-07T09:25:15", "url": "https://files.pythonhosted.org/packages/ee/4f/f296f8a592d571bc2ed2a61f7e7faf9597141aa28b74475e0c6f90cbd757/spirit.plone.theming-0.9.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a5c250caefa909bc9a80e91a611f9a00", "sha256": "aa8f800386f713f7fa7beed0fe69d6f925464e5c1f0e06386eee290ead617d11" }, "downloads": -1, "filename": "spirit.plone.theming-0.9.zip", "has_sig": false, "md5_digest": "a5c250caefa909bc9a80e91a611f9a00", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 634873, "upload_time": "2019-03-07T09:25:15", "url": "https://files.pythonhosted.org/packages/ee/4f/f296f8a592d571bc2ed2a61f7e7faf9597141aa28b74475e0c6f90cbd757/spirit.plone.theming-0.9.zip" } ] }