04 Apr 2022 11:35:58 UTC
- Distribution: SemanticWeb-Schema
- Module version: v14.0.0
- Source (raw)
- Browse (raw)
- How to Contribute
- KwaliteeBus factor: 1
- 100.00% Coverage
- License: artistic_2
- Perl: v5.10.1
- Activity24 month
- Download (638.34KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version++ed by:4 non-PAUSE usersRRWO Robert Rothenberg
Looking for help!The maintainer of this distribution is looking for people to help them improve this module! If you're interested then please contact them via email.
- SEE ALSO
- COPYRIGHT AND LICENSE
SemanticWeb::Schema::SpecialAnnouncement - A SpecialAnnouncement combines a simple date-stamped textual information update with contextualized Web links and other structured data
A SpecialAnnouncement combines a simple date-stamped textual information update with contextualized Web links and other structured data. It represents an information update made by a locally-oriented organization, for example schools, pharmacies, healthcare providers, community groups, police, local government.
For work in progress guidelines on Coronavirus-related markup see this doc.
The motivating scenario for SpecialAnnouncement is the Coronavirus pandemic, and the initial vocabulary is oriented to this urgent situation. Schema.org expect to improve the markup iteratively as it is deployed and as feedback emerges from use. In addition to our usual Github entry, feedback comments can also be provided in this document.
While this schema is designed to communicate urgent crisis-related information, it is not the same as an emergency warning technology like CAP, although there may be overlaps. The intent is to cover the kinds of everyday practical information being posted to existing websites during an emergency situation.
Several kinds of information can be provided:
We encourage the provision of "name", "text", "datePosted", "expires" (if appropriate), "category" and "url" as a simple baseline. It is important to provide a value for "category" where possible, most ideally as a well known URL from Wikipedia or Wikidata. In the case of the 2019-2020 Coronavirus pandemic, this should be "https://en.wikipedia.org/w/index.php?title=2019-20_coronavirus_pandemic" or "https://www.wikidata.org/wiki/Q81068910".
For many of the possible properties, values can either be simple links or an inline description, depending on whether a summary is available. For a link, provide just the URL of the appropriate page as the property's value. For an inline description, use a SemanticWeb::Schema::WebContent type, and provide the url as a property of that, alongside at least a simple "[[text]]" summary of the page. It is unlikely that a single SpecialAnnouncement will need all of the possible properties simultaneously.
We expect that in many cases the page referenced might contain more specialized structured data, e.g. contact info, [[openingHours]], SemanticWeb::Schema::Event, SemanticWeb::Schema::FAQPage etc. By linking to those pages from a SemanticWeb::Schema::SpecialAnnouncement you can help make it clearer that the events are related to the situation (e.g. Coronavirus) indicated by the [[category]] property of the SemanticWeb::Schema::SpecialAnnouncement.
Many SemanticWeb::Schema::SpecialAnnouncements will relate to particular regions and to identifiable local organizations. Use [[spatialCoverage]] for the region, and [[announcementLocation]] to indicate specific SemanticWeb::Schema::LocalBusinesses and SemanticWeb::Schema::CivicStructures. If the announcement affects both a particular region and a specific location (for example, a library closure that serves an entire region), use both [[spatialCoverage]] and [[announcementLocation]].
The [[about]] property can be used to indicate entities that are the focus of the announcement. We now recommend using [[about]] only for representing non-location entities (e.g. a SemanticWeb::Schema::Course or a SemanticWeb::Schema::RadioStation). For places, use [[announcementLocation]] and [[spatialCoverage]]. Consumers of this markup should be aware that the initial design encouraged the use of /about for locations too.
The basic content of SemanticWeb::Schema::SpecialAnnouncement is similar to that of an RSS or Atom feed. For publishers without such feeds, basic feed-like information can be shared by posting SemanticWeb::Schema::SpecialAnnouncement updates in a page, e.g. using JSON-LD. For sites with Atom/RSS functionality, you can point to a feed with the [[webFeed]] property. This can be a simple URL, or an inline SemanticWeb::Schema::DataFeed object, with [[encodingFormat]] providing media type information e.g. "application/rss+xml" or "application/atom+xml".
Indicates a specific SemanticWeb::Schema::CivicStructure or SemanticWeb::Schema::LocalBusiness associated with the SpecialAnnouncement. For example, a specific testing facility or business with special opening hours. For a larger geographic region like a quarantine of an entire region, use [[spatialCoverage]].
A announcement_location should be one of the following types:
A predicate for the "announcement_location" attribute.
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
A category should be one of the following types:
A predicate for the "category" attribute.
Publication date of an online listing.
A date_posted should be one of the following types:
A predicate for the "date_posted" attribute.
Information about disease prevention.
A disease_prevention_info should be one of the following types:
A predicate for the "disease_prevention_info" attribute.
Statistical information about the spread of a disease, either as SemanticWeb::Schema::WebContent, or described directly as a SemanticWeb::Schema::Dataset, or the specific SemanticWeb::Schema::Observations in the dataset. When a SemanticWeb::Schema::WebContent URL is provided, the page indicated might also contain more such markup.
A disease_spread_statistics should be one of the following types:
A predicate for the "disease_spread_statistics" attribute.
Information about getting tested (for a SemanticWeb::Schema::MedicalCondition), e.g. in the context of a pandemic.
A getting_tested_info should be one of the following types:
A predicate for the "getting_tested_info" attribute.
governmentBenefitsInfo provides information about government benefits associated with a SpecialAnnouncement.
A government_benefits_info should be one of the following types:
A predicate for the "government_benefits_info" attribute.
Indicates a page with news updates and guidelines. This could often be (but is not required to be) the main page containing SemanticWeb::Schema::SpecialAnnouncement markup on a site.
A news_updates_and_guidelines should be one of the following types:
A predicate for the "news_updates_and_guidelines" attribute.
Information about public transport closures.
A public_transport_closures_info should be one of the following types:
A predicate for the "public_transport_closures_info" attribute.
Guidelines about quarantine rules, e.g. in the context of a pandemic.
A quarantine_guidelines should be one of the following types:
A predicate for the "quarantine_guidelines" attribute.
Information about school closures.
A school_closures_info should be one of the following types:
A predicate for the "school_closures_info" attribute.
Information about travel bans, e.g. in the context of a pandemic.
A travel_bans should be one of the following types:
A predicate for the "travel_bans" attribute.
The URL for a feed, e.g. associated with a podcast series, blog, or series of date-stamped updates. This is usually RSS or Atom.
A web_feed should be one of the following types:
A predicate for the "web_feed" attribute.
Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/SemanticWeb-Schema/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Robert Rothenberg <email@example.com>
This software is Copyright (c) 2018-2022 by Robert Rothenberg.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
Module Install Instructions
To install SemanticWeb::Schema, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install SemanticWeb::Schema
For more information on module installation, please visit the detailed CPAN module installation guide.