EMBL Content meta properties utility

These meta tags describe the role of page within the EMBL information architecture.

github location npm version

Usage

The meta properties:

  • Content descriptors
    • embl:who the people, groups and teams involved
    • embl:what the activities covered
    • embl:where at which EMBL sites the content applies
    • embl:active which of the above three facets is most important for this content
  • Content role:
    • embl:utility if content is task and work based or if is meant to inspire
    • embl:reach if content is externally (public) or internally focused (those that work at EMBL)
  • Page infromation:
    • embl:maintainer the contact person or group responsible for the page
    • embl:last-review the last time the page was reviewed or updated
    • embl:review-cycle how long in days before the page should be checked
    • embl:expiry if there is a fixed point in time when the page is no longer relevant

These tags should be placed in your <head>.

Why do they matter?

  1. Ensures future quality of content
  2. Will be programatically queried by other patterns to offer contextually-appropriate content and navigation
  3. Can affect the look and feel of content

Variants

HTML
<!-- Content descriptors -->
<meta name="embl:who" content="all"> <!-- the people, groups and teams involved -->
<meta name="embl:where" content="EMBL"> <!-- at which EMBL sites the content applies -->
<meta name="embl:what" content="services, websites"> <!-- the activities covered -->
<meta name="embl:active" content="what"> <!-- which of the who/what/where is active -->

<!-- Content role -->
<meta name="embl:utility" content="-8"> <!-- if content is task and work based or if is meant to inspire -->
<meta name="embl:reach" content="-5"> <!-- if content is externally (public) or internally focused (those that work at EMBL) -->

<!-- Page infromation -->
<meta name="embl:maintainer" content="Strategy and Communications"> <!-- the contact person or group responsible for the page -->
<meta name="embl:last-review" content="NaN"> <!-- the last time the page was reviewed or updated -->
<meta name="embl:review-cycle" content=""> <!-- how long in days before the page should be checked -->
<meta name="embl:expiry" content="2019-06-20"> <!-- if there is a fixed point in time when the page is no longer relevant -->
              

Examples

Installation info

This component is distributed with npm. After installing npm, you can install the embl-content-meta-properties with this command.

$ yarn add --dev @visual-framework/embl-content-meta-properties

Sass/CSS

The source files included are written in Sass(scss). You can point your Sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/embl-grid/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Changelog

Changelog

1.0.0 (2019-12-17)

  • Initial stable release

Assets



File system location: components/embl-content-meta-properties

Find an issue on this page? Propose a change or discuss it.