Skip to main content

A new addon for Plone

Project description

cs_dynamicpages

A new addon for Plone to create web-based dynamic pages.

The concept is pretty similar that of Volto blocks:

  • You can build a page using reusable items.
  • Each item can have different fields
  • Each item can have different views

Provided Content Types

  • DynamicPageFolder: this content type will be created in a given folder, and will be the container where all the rows will be added.

  • DynamicPageRow: this content type will be the one that will be rendered in a separate row in the view

  • DynamicPageRowFeatured: this content type can be used to save static information that can be shown in a row. For instance: each of the items of a slider need a title, a description or an image. They can be added using this content-type

Provided View

There is just one view dynamic_view registered for Folders and Naviation roots. You can register it for your own content-types also.

Different fields

To provide different fields, you should register standard behaviors to the DynamicPageRow content type.

Custom views

To provide different views, you should register standard views (using zcml).

Those views must be registered for implementers of cs_dynamicpages.content.dynamic_page_row.IDynamicPageRow and their name must start by cs_dynamicpages-.

Restrict fields in the row edit view

You may register several behaviors for DynamicPageRow objects but only use some of the fields provided by them in a given view.

You can restrict which fields are shown in the edit form of the DynamicPageRow going to the Dynamic Pages Controlpanel, and setting there the list of fields that will be shown when editing each of the row types.

To ease installation of such views and field configuration in your products, cs_dynamicpages.utils contains 2 utility functions:

  • add_custom_view: function to add a given view to the list of available row types
  • enable_behavior: function to enable the given behavior in the DynamicPageRow content type

Templates

The product lets the end-user save a given dynamic page as a "Template". This means that a reference to the rows setup of a given page will be saved and then can be used as an starting point when creating a new dynamic page.

Templates are saved in a JSON field of a behavior called cs_dynamicpages.templates in a content object. This behavior is applied, by default, to the Plone Site object. But can be applied to any other object.

The template manager goes up in the contentree from the context object where you are setting the template until it finds a content object that implements the said behavior, and saves the template information there.

This means that you can configure different templates in different parts of your site, provided that you set the said behavior to a given content-type. Think, for instance, that you could set the behavior to Subsites of your site, or to Language Root Folders in multilingual sites.

A template management screen is also available to view and delete such templates.

Installation

Install cs_dynamicpages with pip:

pip install cs_dynamicpages

And to create the Plone site:

make create-site

Contribute

Please, clone this repo, do your developments in a specific branch, and create a pull request from it.

Prerequisites ✅

Installation 🔧

  1. Clone this repository, then change your working directory.

    git clone git@github.com:codesyntax/cs_dynamicpages.git
    cd cs_dynamicpages
    
  2. Install this code base.

    make install
    

Add features using plonecli or bobtemplates.plone

This package provides markers as strings (<!-- extra stuff goes here -->) that are compatible with plonecli and bobtemplates.plone. These markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from plonecli.

To run plonecli with configuration to target this package, run the following command.

make add <template_name>

For example, you can add a content type to your package with the following command.

make add content_type

You can add a behavior with the following command.

make add behavior
You can check the list of available subtemplates in the [`bobtemplates.plone` `README.md` file](https://github.com/plone/bobtemplates.plone/?tab=readme-ov-file#provided-subtemplates).
See also the documentation of [Mockup and Patternslib](https://6.docs.plone.org/classic-ui/mockup.html) for how to build the UI toolkit for Classic UI.

License

The project is licensed under GPLv2.

Credits and acknowledgements 🙏

Generated using Cookieplone (0.9.7) and cookieplone-templates (4d55553) on 2025-07-17 11:59:12.982862. A special thanks to all contributors and supporters!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cs_dynamicpages-1.0.0b7.tar.gz (85.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cs_dynamicpages-1.0.0b7-py3-none-any.whl (180.1 kB view details)

Uploaded Python 3

File details

Details for the file cs_dynamicpages-1.0.0b7.tar.gz.

File metadata

  • Download URL: cs_dynamicpages-1.0.0b7.tar.gz
  • Upload date:
  • Size: 85.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for cs_dynamicpages-1.0.0b7.tar.gz
Algorithm Hash digest
SHA256 6b50ada91d752470f9c75712bfb165eb96a95bcc6ab897ad9445fd4387c850ce
MD5 a7065da7000c815e82d79f37db56f76a
BLAKE2b-256 053a101a90f4d65cd5d178c25fbe53bce2c864d7dacb294f7984689de1d53e57

See more details on using hashes here.

File details

Details for the file cs_dynamicpages-1.0.0b7-py3-none-any.whl.

File metadata

File hashes

Hashes for cs_dynamicpages-1.0.0b7-py3-none-any.whl
Algorithm Hash digest
SHA256 30d18e9310e49482b1d20cad501de87b861eb31571734cf609533b3ff2b26fbd
MD5 23474de1b9b5700df3fd3488b663d2c0
BLAKE2b-256 a9b42f2565a9c6722a31d70ee71bac9b459a44d7836e9f85cc13dfc0677bb3d3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page