dynamic/silverstripe-elemental-templates

Elemental Templates

1.1.0 2024-03-05 03:09 UTC

Requires

• php: ^8.1
• dnadesign/silverstripe-elemental: ^5.0
• silverstripe/vendor-plugin: ^2

Requires (Dev)

• silverstripe/frameworktest: ^1
• silverstripe/recipe-testing: ^3
• silverstripe/standards: ^1

BSD-3-Clause

• Jason Irish
• Nic Horstmeier

• templates
• silverstripe
• element
• Content Blocks
• elemental

README

A module allowing CMS users to define layouts, known as "skeletons", that provide a predefined set of elements when a page is created.

This module relies on native $cascade_duplicates settings to ensure sample content, files, images, etc. are copied to the page as a starter. The feature allowing pre-populated content and objects is configurable, see below.

Requirements

• Silverstripe CMS ^5

Installation

Ensure you setup a repository reference in your composer.json file:

composer require dynamic/silverstripe-elemental-templates

Populating Template Elements

You can pre-populate elements added to a template via config. This currently supports database fields via the following mapping:

Dynamic\ElememtalTemplates\Models\Template:
  populate:
    DNADesign\Elemental\Models\ElementContent:
      Title: 'Content Block Title'
      HTML: '<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris elementum congue erat, accumsan tincidunt velit porta lobortis. Sed at efficitur ex. Nulla quis porta neque. In hac habitasse platea dictumst. Nullam et malesuada sem. Pellentesque eros eros, rutrum sit amet erat in, finibus ultrices tortor. Curabitur a tincidunt leo, congue interdum ex. Integer a tortor eget ligula eleifend suscipit a rutrum purus. Donec quis rutrum felis.</p>'

A config like the above is not inherintly included in the module as it may not be a desirable effect/the type of predefined content may be unique for you project.

Roadmap

We understand the current methodology does not allow for configuring population definitions outside of database fields. We're working on adding this feature as it is clearly something that is beneficial.

License

See License

Maintainers

• Dynamic ([e-mail])

Bugtracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

• Create a new issue
• Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
• Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.