rt.lastmodifier


Namert.lastmodifier JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://github.com/redturtle/rt.lastmodifier
SummaryExtends features and shown data in Plone document byline section
upload_time2024-02-07 10:54:57
maintainer
docs_urlNone
authorRedTurtle Technology
requires_python>=3.6
licenseGPL version 2
keywords python plone
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            Enhance the Plone adding an additional information on document view: the **user who performed the last change** and
the **change note**.
Optionally expands the **document byline** section showing those informations.

.. contents:: **Table of contents**

Documentation
=============

Plone already handle lot of infos in the document byline section, like the document author, the modification date
and the publication date.

In the same way new data added by this add-on will be added to the byline section.

.. image:: http://blog.redturtle.it/pypi-images/rt.lastmodifier/rt.lastmodifier-0.4-01.png
   :alt: Document byline preview in the Plone 4.3 style

When the new byline informations are shown?
-------------------------------------------

New infos apart, all byline elements can now be controlled with a **granular security configuration**.
This will change the way to handle document byline because commonly Plone simply use a couple of
site-wide options: the *allow_anon_views_about* and the *displayPublicationDateInByline*.

The viewlet will now handle many different informations: *author*, *last modifier*, *publication date*,
*modification date* and *last versioning change note*.
Each information is visible if the user has a specified permission:

- ``rt.lastmodifier: documentByLine view author``
- ``rt.lastmodifier: documentByLine view last modifier``
- ``rt.lastmodifier: documentByLine view modification date``
- ``rt.lastmodifier: documentByLine view publication date``
- ``rt.lastmodifier: documentByLine view change note``
- ``rt.lastmodifier: show long time format``

To show last modifier info, *Creator* and *Modifier* must be not equals (just for not show a duplicate link).

By default Anonymous users can't see anything (this will reproduce the Plone default behavior, where Anonymous
can't see the byline section by default).

The "show long time format" permission can enable disable the visibility of timing when dates are displayed.

Disabling byline on content types
---------------------------------

Sometimes the byline section is displayed on contents where you don't need it.

In that case you can apply (from ZMI) a marker interface named ``ILastModifierInertContent`` to a single
content, or let your 3rd-party content types to extends it.
This will disable the byline section.

Also, the byline section is automatically disabled on the Plone site root.

Show change notes
-----------------

This feature will show the comment to changes you did, that commonly are kept in the history section
so this only works for content type where `versioning`_ is activated.

The editor must explicitly choose if a change note must be putted in the byline section by selecting
the "*Show the changes note in document info*" checkbox.
This will store *that* change note to be shown in the content, that means that additional changes without
checking the option will not update that information.

.. image:: http://blog.redturtle.it/pypi-images/rt.lastmodifier/rt.lastmodifier-0.4-02.png
   :alt: New change note section

To *delete* the change note shown you must edit a document, provide an empty note while keeping the check
selected.

**Note**: this feature require JavaScript to work properly *and* has only be tested for Archetypes based
content types.

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

Add ``rt.lastmodifier`` to your buildout::

    [buildout]
    ...
    
    [instance]
    ...
    eggs=
       ...
       rt.lastmodifier

After that, install the "rt.lastmodifier" add-on product.

.. Note::
    Installation will trigger an index creation and population. This can require some times
    on huge sites.

Compatibility
-------------

All Plone versions from 3.3 to 4.3.

Credits
=======

Developed with the support of:

* `S. Anna Hospital, Ferrara`__
  
  .. image:: http://www.ospfe.it/ospfe-logo.jpg 
     :alt: S. Anna Hospital logo
  
* `Camera di Commercio di Ferrara`__
  
  .. image:: http://www.fe.camcom.it/cciaa-logo.png/
     :alt: CCIAA Ferrara - logo
  
* `Province of Vicenza`__

  .. image:: http://www.provincia.vicenza.it/logo_provincia_vicenza.png
     :alt: Province of Vicenza - logo

All of them supports the `PloneGov initiative`__.

__ http://www.ospfe.it/
__ http://www.fe.camcom.it/
__ http://www.provincia.vicenza.it/
__ http://www.plonegov.it/

Authors
=======

This product was developed by RedTurtle Technology team.

.. image:: http://www.redturtle.it/redturtle_banner.png
   :alt: RedTurtle Technology Site
   :target: http://www.redturtle.it/

.. _`versioning`: https://plone.org/documentation/manual/plone-4-user-manual/managing-content/versioning-plone-v3.3


Changelog
=========

1.1.2 (2024-02-07)
------------------

- Python3 chore.
  [folix-01]


1.1.1 (2020-07-02)
------------------

- Fix problem on patch when deleting contents.
  [cekk]


1.1.0 (2020-03-07)
------------------

- Python3 compatibility [cekk]


1.0.2 (2015-12-16)
------------------

- Fix document by line folder viewlet to take last modifier
  from last modified content inside the folder
  [fdelia]


1.0.1 (2015-10-16)
------------------

- Added memoize for caching the values of last_modifier method
  [fdelia]


1.0.0 (2015-09-07)
------------------

- Added a new permission ``rt.lastmodifier: show long time format``.
  This can enable/disable the full time format on dates.
  [keul]
- Added the ``ILastModifierInertContent`` marker interface for disable
  byline section on contents
  [keul]
- Fixed to byline infos: prevented some commas to be misdisplayed
  [keul]



0.6.0 (2015-07-28)
------------------

- Fixed italian translation typo
  [keul]
- Now save last modifier info in a low level annotation.
  This way we can have this information also when the content type do not
  use any versioning support (that is still the fallback)
  [keul]
- Do not, never, display any byline on site root.
  It's totally useless
  [keul]

0.5.0 (2015-02-16)
------------------

- When visiting folders, show last modifier and modification date taken
  by most recent child document, not from folder itself
  [keul]

0.4.1 (2014-09-30)
------------------

- Fixed issue in calling ``@@manage-viewlets``, and generally
  accessing site root [keul]
- Fixed typo in italian translation [keul]

0.4 (2014-07-17)
----------------

- New feature for showing the last change note on versionable contents.
  User must explicitly mark the change has "showable"
  [keul]

0.3.1 (2014-02-25)
------------------

- Fixed default roles: do not use ``Authenticated`` but ``Member``
  [keul]

0.3 (2014-02-12)
----------------

- Added new permissions to handle the view of single infos in the viewlet:
  author, last modifier, publication date and modified date
  [cekk]
- fixed bug: last modifier was never shown to anonymous users in Plone 4
  (`#1`__)
  [keul]

__ https://github.com/RedTurtle/rt.lastmodifier/issues/1

0.2 (2013-04-17)
----------------

* Renamed the product from "collective.lastmodifier" to "rt.lastmodifier".
  This is unbelievable and embarassing, but I didn't find `collective.lastmodifier`__ when I looked for
  a Plone product with those features... and in the end I choosed the same name!
  However the original product is using a different approach.
* Added collection criteria (for new and old ones)

__ https://pypi.python.org/pypi/collective.lastmodifier

0.1 (Unreleased)
----------------

- Initial release
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/redturtle/rt.lastmodifier",
    "name": "rt.lastmodifier",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "Python Plone",
    "author": "RedTurtle Technology",
    "author_email": "sviluppoplone@redturtle.it",
    "download_url": "https://files.pythonhosted.org/packages/bc/e1/1fdb9f7e0f28aa907ea1362a9c597921326d41f0b0446be9e1d2fec975ef/rt.lastmodifier-1.1.2.tar.gz",
    "platform": null,
    "description": "Enhance the Plone adding an additional information on document view: the **user who performed the last change** and\nthe **change note**.\nOptionally expands the **document byline** section showing those informations.\n\n.. contents:: **Table of contents**\n\nDocumentation\n=============\n\nPlone already handle lot of infos in the document byline section, like the document author, the modification date\nand the publication date.\n\nIn the same way new data added by this add-on will be added to the byline section.\n\n.. image:: http://blog.redturtle.it/pypi-images/rt.lastmodifier/rt.lastmodifier-0.4-01.png\n   :alt: Document byline preview in the Plone 4.3 style\n\nWhen the new byline informations are shown?\n-------------------------------------------\n\nNew infos apart, all byline elements can now be controlled with a **granular security configuration**.\nThis will change the way to handle document byline because commonly Plone simply use a couple of\nsite-wide options: the *allow_anon_views_about* and the *displayPublicationDateInByline*.\n\nThe viewlet will now handle many different informations: *author*, *last modifier*, *publication date*,\n*modification date* and *last versioning change note*.\nEach information is visible if the user has a specified permission:\n\n- ``rt.lastmodifier: documentByLine view author``\n- ``rt.lastmodifier: documentByLine view last modifier``\n- ``rt.lastmodifier: documentByLine view modification date``\n- ``rt.lastmodifier: documentByLine view publication date``\n- ``rt.lastmodifier: documentByLine view change note``\n- ``rt.lastmodifier: show long time format``\n\nTo show last modifier info, *Creator* and *Modifier* must be not equals (just for not show a duplicate link).\n\nBy default Anonymous users can't see anything (this will reproduce the Plone default behavior, where Anonymous\ncan't see the byline section by default).\n\nThe \"show long time format\" permission can enable disable the visibility of timing when dates are displayed.\n\nDisabling byline on content types\n---------------------------------\n\nSometimes the byline section is displayed on contents where you don't need it.\n\nIn that case you can apply (from ZMI) a marker interface named ``ILastModifierInertContent`` to a single\ncontent, or let your 3rd-party content types to extends it.\nThis will disable the byline section.\n\nAlso, the byline section is automatically disabled on the Plone site root.\n\nShow change notes\n-----------------\n\nThis feature will show the comment to changes you did, that commonly are kept in the history section\nso this only works for content type where `versioning`_ is activated.\n\nThe editor must explicitly choose if a change note must be putted in the byline section by selecting\nthe \"*Show the changes note in document info*\" checkbox.\nThis will store *that* change note to be shown in the content, that means that additional changes without\nchecking the option will not update that information.\n\n.. image:: http://blog.redturtle.it/pypi-images/rt.lastmodifier/rt.lastmodifier-0.4-02.png\n   :alt: New change note section\n\nTo *delete* the change note shown you must edit a document, provide an empty note while keeping the check\nselected.\n\n**Note**: this feature require JavaScript to work properly *and* has only be tested for Archetypes based\ncontent types.\n\nInstallation\n============\n\nAdd ``rt.lastmodifier`` to your buildout::\n\n    [buildout]\n    ...\n    \n    [instance]\n    ...\n    eggs=\n       ...\n       rt.lastmodifier\n\nAfter that, install the \"rt.lastmodifier\" add-on product.\n\n.. Note::\n    Installation will trigger an index creation and population. This can require some times\n    on huge sites.\n\nCompatibility\n-------------\n\nAll Plone versions from 3.3 to 4.3.\n\nCredits\n=======\n\nDeveloped with the support of:\n\n* `S. Anna Hospital, Ferrara`__\n  \n  .. image:: http://www.ospfe.it/ospfe-logo.jpg \n     :alt: S. Anna Hospital logo\n  \n* `Camera di Commercio di Ferrara`__\n  \n  .. image:: http://www.fe.camcom.it/cciaa-logo.png/\n     :alt: CCIAA Ferrara - logo\n  \n* `Province of Vicenza`__\n\n  .. image:: http://www.provincia.vicenza.it/logo_provincia_vicenza.png\n     :alt: Province of Vicenza - logo\n\nAll of them supports the `PloneGov initiative`__.\n\n__ http://www.ospfe.it/\n__ http://www.fe.camcom.it/\n__ http://www.provincia.vicenza.it/\n__ http://www.plonegov.it/\n\nAuthors\n=======\n\nThis product was developed by RedTurtle Technology team.\n\n.. image:: http://www.redturtle.it/redturtle_banner.png\n   :alt: RedTurtle Technology Site\n   :target: http://www.redturtle.it/\n\n.. _`versioning`: https://plone.org/documentation/manual/plone-4-user-manual/managing-content/versioning-plone-v3.3\n\n\nChangelog\n=========\n\n1.1.2 (2024-02-07)\n------------------\n\n- Python3 chore.\n  [folix-01]\n\n\n1.1.1 (2020-07-02)\n------------------\n\n- Fix problem on patch when deleting contents.\n  [cekk]\n\n\n1.1.0 (2020-03-07)\n------------------\n\n- Python3 compatibility [cekk]\n\n\n1.0.2 (2015-12-16)\n------------------\n\n- Fix document by line folder viewlet to take last modifier\n  from last modified content inside the folder\n  [fdelia]\n\n\n1.0.1 (2015-10-16)\n------------------\n\n- Added memoize for caching the values of last_modifier method\n  [fdelia]\n\n\n1.0.0 (2015-09-07)\n------------------\n\n- Added a new permission ``rt.lastmodifier: show long time format``.\n  This can enable/disable the full time format on dates.\n  [keul]\n- Added the ``ILastModifierInertContent`` marker interface for disable\n  byline section on contents\n  [keul]\n- Fixed to byline infos: prevented some commas to be misdisplayed\n  [keul]\n\n\n\n0.6.0 (2015-07-28)\n------------------\n\n- Fixed italian translation typo\n  [keul]\n- Now save last modifier info in a low level annotation.\n  This way we can have this information also when the content type do not\n  use any versioning support (that is still the fallback)\n  [keul]\n- Do not, never, display any byline on site root.\n  It's totally useless\n  [keul]\n\n0.5.0 (2015-02-16)\n------------------\n\n- When visiting folders, show last modifier and modification date taken\n  by most recent child document, not from folder itself\n  [keul]\n\n0.4.1 (2014-09-30)\n------------------\n\n- Fixed issue in calling ``@@manage-viewlets``, and generally\n  accessing site root [keul]\n- Fixed typo in italian translation [keul]\n\n0.4 (2014-07-17)\n----------------\n\n- New feature for showing the last change note on versionable contents.\n  User must explicitly mark the change has \"showable\"\n  [keul]\n\n0.3.1 (2014-02-25)\n------------------\n\n- Fixed default roles: do not use ``Authenticated`` but ``Member``\n  [keul]\n\n0.3 (2014-02-12)\n----------------\n\n- Added new permissions to handle the view of single infos in the viewlet:\n  author, last modifier, publication date and modified date\n  [cekk]\n- fixed bug: last modifier was never shown to anonymous users in Plone 4\n  (`#1`__)\n  [keul]\n\n__ https://github.com/RedTurtle/rt.lastmodifier/issues/1\n\n0.2 (2013-04-17)\n----------------\n\n* Renamed the product from \"collective.lastmodifier\" to \"rt.lastmodifier\".\n  This is unbelievable and embarassing, but I didn't find `collective.lastmodifier`__ when I looked for\n  a Plone product with those features... and in the end I choosed the same name!\n  However the original product is using a different approach.\n* Added collection criteria (for new and old ones)\n\n__ https://pypi.python.org/pypi/collective.lastmodifier\n\n0.1 (Unreleased)\n----------------\n\n- Initial release",
    "bugtrack_url": null,
    "license": "GPL version 2",
    "summary": "Extends features and shown data in Plone document byline section",
    "version": "1.1.2",
    "project_urls": {
        "Homepage": "https://github.com/redturtle/rt.lastmodifier",
        "PyPI": "https://pypi.python.org/pypi/rt.lastmodifier",
        "Source": "https://github.com/redturtle/rt.lastmodifier",
        "Tracker": "https://github.com/redturtle/rt.lastmodifier/issues"
    },
    "split_keywords": [
        "python",
        "plone"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bce11fdb9f7e0f28aa907ea1362a9c597921326d41f0b0446be9e1d2fec975ef",
                "md5": "5a05eeec5871e916ebe3157968145635",
                "sha256": "08bbe0fa411e4c0838443e60fb5d4dc6454633d2b37f53de507a610799ab0b13"
            },
            "downloads": -1,
            "filename": "rt.lastmodifier-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "5a05eeec5871e916ebe3157968145635",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 33511,
            "upload_time": "2024-02-07T10:54:57",
            "upload_time_iso_8601": "2024-02-07T10:54:57.182460Z",
            "url": "https://files.pythonhosted.org/packages/bc/e1/1fdb9f7e0f28aa907ea1362a9c597921326d41f0b0446be9e1d2fec975ef/rt.lastmodifier-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-07 10:54:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "redturtle",
    "github_project": "rt.lastmodifier",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "tox": true,
    "lcname": "rt.lastmodifier"
}
        
Elapsed time: 0.73622s