- Back up the existing modules/EasyRead folder and CMS database.
- Extract EasyRead-0.1.24.zip and replace the site's modules/EasyRead folder with the included EasyRead folder.
- In Extensions → Modules, run Upgrade for EasyRead. Do not uninstall first.
- Open Layout → Design Manager → Templates. Look for Easy Read Summary (type EasyRead::summary).
- Add the generic integration below to your CMSMS page template. Replace any existing Easy Read row loop with
{EasyRead data=$easyread_data}.
Design Manager controls the Easy Read heading, pictures and text layout. The included template uses Bootstrap 5 layout classes and neutral easyread-summary CSS classes. Supply Bootstrap in your site theme, or edit the Design Manager template to use your own layout. Any optional visitor toggle and preference cookie belong to your page template.
Choose a named template with {EasyRead data=$easyread_data template='Easy Read Summary'}. Without template=, the default EasyRead::summary template is used. Existing {EasyRead data=$easyread_data to='easyread'} calls still return data without rendering HTML.
Repeat upgrades preserve existing templates and user edits. Uninstall retains Design Manager templates, like the existing module's retained content/uploads. No page data migration is required.
Register the content block once in the template body, before rendering it:
{content_module module='EasyRead' block='easy_read'
label='Easy Read Summary' assign='easyread_data'}
{EasyRead data=$easyread_data}For custom output, use {EasyRead data=$easyread_data to='easyread'} and loop
over $easyread. The to call returns data without output. Do not register
the same content block twice. Editors then add pictures, alt descriptions and
short text under Easy Read Summary in the page editor.
The bundled frontend template and setup examples use neutral names. Existing
Design Manager templates are preserved on upgrade. To use the new factory
markup on an existing installation, update your Easy Read Summary template
from templates/default.tpl after backing up any custom changes. The bundled
template uses easyread-summary, easyread-summary-item,
easyread-summary-image and easyread-summary-text as its CSS hooks. Update
your site stylesheet to match these hooks if needed.
This distribution has been syntax checked locally; installation in a running CMSMS site remains to be verified.
Guidance appears under the Easy Read heading. The Show/Hide Easy Read button sits above the guidance. Hide Easy Read collapses the guidance, item fields and Add Item button; Show Easy Read restores them. This only changes the editor display, not published content or saved data. The editor remembers Show/Hide separately for each saved page and Easy Read block, using a one-year cookie in this browser. New unsaved pages start expanded.
Each item offers Upload image or Use image link. Paste a direct public HTTP(S) image URL and click Import image. The downloaded bytes are checked as JPG, PNG, GIF or WebP, up to 8 MB, and saved into uploads/EasyRead. Apply or Submit saves the selected picture to the page. PHP cURL is required. Redirect links are rejected with instructions to use the final image URL. Failed imports retain the previous picture.
Use image link + expands the link field; Use image link − closes it. Drop one image file from your computer onto the picture frame to upload it. Add picture + and the existing upload option remain available. The same file validation and 8 MB limit apply. Apply or Submit saves the page.
Easy Read content now renders CMSMS Smarty and module tags automatically. For example, write {YouTubeCatalog} in the WYSIWYG editor. In the Easy Read Design Manager template, keep the usual {$easyItem.content} output; do not add {eval}.
The View Easy Read in Extensions permission controls whether a user sees Easy Read in the Extensions menu. Assign it only to users who need the module help page. Removing it hides the Extensions entry, but does not remove Easy Read fields from the page editor or affect published pages.
Added the GPL-2.0-or-later licence, PHP licence headers, an explicit help-page permission check, uninstall warning, external-image and editor-cookie disclosures, and project artwork.
Uploading an image file stores it in the site's uploads/EasyRead directory.
Image files remain until removed by the site administrator or module uninstall.
Remove personal information from images and metadata before uploading when
it is not needed for the published content.
Use image link makes an HTTP(S) GET request from the hosting server to the public image URL entered by an editor. It sends the URL, ordinary HTTP request headers and the server IP address to that image host, then stores the returned image locally. The request occurs only when an editor imports a link. There is no fixed external provider: consult the Terms of Service and Privacy Policy published by the selected image host. Redirects and private network addresses are rejected. The module does not load external analytics or tracking scripts.
The admin editor stores an easyreadEditor_PAGEID_BLOCK cookie to remember
whether that saved page's editor is shown or hidden. It contains only the
display preference, lasts up to one year, and is scoped to the CMSMS admin
directory with SameSite=Lax (and Secure on HTTPS). Clearing the browser cookie
resets the preference. It does not store visitor activity or published page
content. The module sets no frontend visitor cookie; any optional visitor
toggle is implemented by your site template.
Suggested site privacy wording: “Our content editors can upload images or import them from a public image link. Imported images are stored on our hosting; the selected image host receives a normal server request. The editor also uses a cookie to remember whether its editing controls are shown or hidden.”
GPL-2.0-or-later. See LICENSE. Project support is available through GitHub issues.
See CREDITS.md for the projects, contributors, services, documentation and artwork that support this module. Existing licence notices are preserved.