nswdpc/silverstripe-schema-specialannouncement

Schema.org SpecialAnnouncement support for Silverstripe

v1.0.0 2024-05-10 07:32 UTC

Requires

• dnadesign/silverstripe-elemental: ^5
• gorriecoe/silverstripe-linkfield: ^1.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• phpunit/phpunit: ^9.5

BSD-3-Clause

• James Ellis

• silverstripe
• schema.org
• nsw
• SpecialAnnouncement

README

This module provides support for the SpecialAnnouncement term within the schema.org specification within the Silverstripe content management system

Features

• Add an elemental block to a page, to select and display a single special announcement
• Automatically renders JSON-LD supporting schema.org metadata
• Provides a model admin with permission management to add,edit and delete multiple special announcements
• Select a global special announcement for your site
• Optionally link specific special announcements to one or more pages
• Link support for internal and external URLs

Supported schema.org/SpecialAnnouncement metadata

<script type="application/ld+json">
{
    "@context": "http:\/\/schema.org",
    "@type": "SpecialAnnouncement",
    "category": "https:\/\/www.wikidata.org\/wiki\/Q81068910",
    "name": "COVID-19 Update",
    "text": "Stay safe with the latest COVID Safe information",
    "image": "https:\/\/example.com\/assets\/Uploads\/stay-covid-safe.jpg",
    "datePosted": "2020-11-06T12:00:00+1100",
    "expires": "2021-01-14T12:00:00+1100",
    "url": "https:\/\/example.com"
}
</script>

You can also specify the following values as links to further content (external or internal)

diseasePreventionInfo
diseaseSpreadStatistics
gettingTestedInfo
governmentBenefitsInfo
newsUpdatesAndGuidelines
publicTransportClosuresInfo
quarantineGuidelines
schoolClosuresInfo
travelBans

Installation

The recommended way of installing this module is via composer

composer require nswdpc/silverstripe-schema-specialannouncement

License

BSD-3-Clause

Documentation

• Documentation

Configuration

There is no configuration outside of the administration area, currently.

Maintainers

• dpcdigital@NSWDPC:~$

TODO

• spatialCoverage support

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

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.

Please review the code of conduct prior to completing a pull request.