search

silverstripe / silverstripe-elemental-blocks

A base set of CMS content blocks for the silverstripe-elemental module
BSD 3-Clause "New" or "Revised" License
1 stars 7 forks source link

readme

SilverStripe Elemental Blocks (deprecated)

Build Status Scrutinizer Code Quality codecov SilverStripe supported module

This repository contains a base set of CMS content blocks for the silverstripe-elemental module.

Warning: deprecated!

For ease of maintenance and the ability for developers to individually select functionality, this module was split into two.

For SilverStripe 4.2 or newer, please use one or both of the following modules instead:

As a replacement for this module during an upgrade, there is a recipe that re-combines the content blocks into a single requirement:

This module (silverstripe/elemental-content-blocks) will not be accepting patch fixes from now on.

Installation

Install using Composer:

composer require silverstripe/elemental-blocks 1.0.x-dev

Once complete, run dev/build from your browser, or command line via vendor/bin/sake dev/build.

Requirements

Documentation

An in-depth overview of using the blocks in this module will be added shortly.

Customising templates

The blocks in this module follow the BEM (Block Element Modifier) CSS class naming system, and should provide a WCAG 2.0 compliant template markup for your project's accessibility standard.

If you do need to modify the templates, copy the appropriate template into mysite/templates or your custom theme, and adjust as necessary. If doing so, ensure that you match the folder structure (PHP class namespace) to ensure that your customised template is given priority over the defaults.

For more information see templates in the developer documentation.

Translations

The translations for this project are managed via Transifex and are updated automatically during the release process. To contribute, please head to the link above and get translating!

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Reporting Issues

Please create an issue for any bugs you've found.