DCMI Plugin brings all Dublin Core's set of metadata elements to your website. DCMI metadata tags are HTML5 Valid and can be used for Search Engine Optimization (semantic tagging) and for other implementations that are not necessarily Web-based.
The documentation is also available within the application by using the Documentation button, or by hovering the mouse over help points.
Quick Start
Welcome to Eorisis DCMI. After initial installation the plugin is disabled. Enable the plugin and save your settings. Also make sure that you clear the Cache of your Joomla and browser.
Installation & Updates
The downloadable package zip file can be used as an initial install or as an upgrade without the need to uninstall the previous version. Once you have downloaded the zip file, login to your Joomla Administration area and navigate to System -> Install: Extensions (Joomla 4 or higher), or Extensions -> Manage -> Install (Joomla 3) from the top menu. Then you can Drag and drop or click 'Browse for file' from the 'Upload Package File' tab.
IMPORTANT:
The zip file is intended to be used as is at the Joomla Extensions Manager. This will execute the package installer and perform all tasks required. DO NOT unzip/extract or upload separate files that are included in the package in order to perform an install or update.
Doing so may lead to errors.
Always take a backup of your website before you install any extension.
Uninstall
To uninstall an extension, always use your native Joomla Extensions area. For Joomla 4 or higher it is System -> Manage: Extensions, for Joomla 3 it is Extensions -> Manage -> Manage. This will remove the whole application properly and all of your settings related to it. Eorisis applications uninstall fully, including their database tables.
Plugin Options
These are Global options that will apply to all pages, based on your settings on each page. Example, if you need specific metadata/settings for each article or category, use the DCMI Metadata tab inside the article or category that you edit.
- Document Status: This is a DCMI Recommendation.
- Literal Values: A literal value surrogate is a value surrogate for a literal value, and is made up of exactly one value string. The value string is a literal which encodes the literal value.
- Non-Literal Values: A non-literal value surrogate is a value surrogate for a non-literal value, and is made up of zero or one value URI (a URI that identifies the non-literal value associated with the property), zero or one vocabulary encoding scheme URI (a URI that identifies the vocabulary encoding scheme of which the non-literal value is a member), and zero or more value strings. Each value string is a literal which represents the non-literal value.
Content Options
Settings
- Global:
Use the metadata/settings of the Plugin for this resource.
- Custom:
Apply specific metadata/settings for this resource.
- Off:
Do not use any DCMI metadata for this resource.
Custom Settings
- Inherit Blank:
Any fields left blank, will use the metadata set in the Plugin.
- Omit Blank:
Any fields left blank, will not appear as metatags.
DCMI Metadata
Title
(Page Title / Custom / Off)
A name given to the resource.
Example: EU Stability Programm of Belgium
Status: Recommended.
Used Only with Literal Values.
Alternative Title
An alternative name for the resource. The distinction between titles and alternative titles is application-specific.
Example: AMA Newsletter
Status: Recommended.
Used Only with Literal Values.
Description
(Page Meta Description / Site Meta Description / Content Language Meta Description / Custom / Off)
An account of the resource. Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource.
Status: Recommended.
May be used with Literal and Non-Literal Values.
Subject
(Page Meta Description / Site Meta Description / Content Language Meta Description / Custom / Off)
The topic of the resource. Typically, the subject will be represented using keywords, key phrases, or classification codes. Recommended best practice is to use a controlled vocabulary.
Status: Recommended.
Used Only with Non-Literal Values.
Abstract
(Page Meta Description / Site Meta Description / Content Language Meta Description / Custom / Off)
A summary of the resource.
Note that in the case that the current page has no meta description, then the main site's meta description will be used (if the Content Language meta description is not set, otherwise that will be used instead).
Status: Recommended.
May be used with Literal and Non-Literal Values.
Language
(Default / Language Code Plugin / Custom / Off)
A language of the resource (RFC 4646). Automatically set for each Joomla language.
Status: Recommended.
Used Only with Non-Literal Values.
Type
The nature or genre of the resource.
- Collection:
A collection is an aggregation of items. The term collection means that the resource is described as a group; its parts may be separately described and navigated.
- Dataset:
A dataset is information encoded in a defined structure (for example, lists, tables, and databases), intended to be useful for direct machine processing.
- Event:
An event is a non-persistent, time-based occurrence. Metadata for an event provides descriptive information that is the basis for discovery of the purpose, location, duration, responsible agents, and links to related events and resources. The resource of type event may not be retrievable if the described instantiation has expired or is yet to occur. Examples - exhibition, web-cast, conference, workshop, open-day, performance, battle, trial, wedding, tea-party, conflagration.
- Image:
An image is a primarily symbolic visual representation other than text. For example - images and photographs of physical objects, paintings, prints, drawings, other images and graphics, animations and moving pictures, film, diagrams, maps, musical notation. Note that image may include both electronic and physical representations.
- Interactive Resource:
An interactive resource is a resource which requires interaction from the user to be understood, executed, or experienced. For example - forms on web pages, applets, multimedia learning objects, chat services, virtual reality.
- Service:
A service is a system that provides one or more functions of value to the end-user. Examples include: a photocopying service, a banking service, an authentication service, interlibrary loans, a Z39.50 or Web server.
- Software:
Software is a computer program in source or compiled form which may be available for installation non-transiently on another machine. For software which exists only to create an interactive environment, use interactive instead.
- Sound:
A sound is a resource whose content is primarily intended to be rendered as audio. For example - a music playback file format, an audio compact disc, and recorded speech or sounds.
- Text:
A text is a resource whose content is primarily words for reading. For example - books, letters, dissertations, poems, newspapers, articles, archives of mailing lists. Note that facsimiles or images of texts are still of the genre text.
Status: Recommended.
Used Only with Non-Literal Values.
Medium
The material or physical carrier of the resource.
Status: Recommended.
Used Only with Non-Literal Values.
Identifier
An unambiguous reference to the resource within a given context. Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.
Example 1:
http://www.ltg.ed.ac.uk/~ht/WhatAreURIs/Example 2:
03KTM147Status: Recommended.
Used Only with Literal Values.
Format
The file format, physical medium, or dimensions of the resource. Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME].
[MIME] https://www.iana.org/assignments/media-types/
Status: Recommended.
Used Only with Non-Literal Values.
Has Format
A related resource that is substantially the same as the pre-existing described resource, but in another format.
Status: Recommended.
Used Only with Non-Literal Values.
Is Format Of
A related resource that is substantially the same as the described resource, but in another format.
Status: Recommended.
Used Only with Non-Literal Values.
Has Part
A related resource that is included either physically or logically in the described resource.
Status: Recommended.
Used Only with Non-Literal Values.
Is Part Of
A related resource in which the described resource is physically or logically included.
Status: Recommended.
Used Only with Non-Literal Values.
Has Version
A related resource that is a version, edition, or adaptation of the described resource.
Status: Recommended.
Used Only with Non-Literal Values.
Is Version Of
A related resource of which the described resource is a version, edition, or adaptation. Changes in version imply substantive changes in content rather than differences in format.
Status: Recommended.
Used Only with Non-Literal Values.
Extent
The size or duration of the resource.
Status: Recommended.
Used Only with Non-Literal Values.
Creator
An entity primarily responsible for making the resource. Examples of a Creator include a person, an organization, or a service. Typically, the name of a Creator should be used to indicate the entity.
Status: Recommended.
Used Only with Non-Literal Values.
Created
(Calendar / Custom / Off)
Date of creation of the resource.
Example:
2003-04-10 or approx. 500 B.C.Status: Recommended.
Used Only with Literal Values.
Available
(Calendar / Custom / Off)
Date (often a range) that the resource became or will become available. Could be Release Date.
Example:
2006-07Status: Recommended.
Used Only with Literal Values.
Date Issued
(Calendar / Custom / Off)
Date of formal issuance (i.e., publication) of the resource.
Example:
2009Status: Recommended.
Used Only with Literal Values.
Date Submitted
(Calendar / Custom / Off)
Date of submission of the resource. Examples of resources to which a Date Submitted may be relevant are a thesis (submitted to a university department) or an article (submitted to a journal).
Example:
2011-07-09Status: Conforming.
Used Only with Literal Values.
Date Accepted
(Calendar / Custom / Off)
Date of acceptance of the resource. Examples of resources to which a Date Accepted may be relevant are a thesis (accepted by a university department) or an article (accepted by a journal).
Example:
2010-05-07Status: Conforming.
Used Only with Literal Values.
Date Valid
(Calendar / Custom / Off)
Date (often a range) of validity of a resource.
Example:
2007-05-06/2007-07-15Status: Recommended.
Used Only with Literal Values.
Date Modified
(Calendar / Custom / Last Modified / Off)
Date on which the resource was changed.
Example:
2009-12-22Status: Recommended.
Used Only with Literal Values.
Date
(Calendar / Custom / Off)
A point or period of time associated with an event in the lifecycle of the resource. Date may be used to express temporal information at any level of granularity. Recommended best practice is to use an encoding scheme, such as the W3CDTF profile of ISO 8601 [W3CDTF].
[W3CDTF] https://www.w3.org/TR/NOTE-datetime
Example:
1633Status: Recommended.
Used Only with Literal Values.
Date Copyrighted
(Calendar / Custom / Current Year / Off)
Date of copyright.
Example:
2009-04-03Status: Conforming.
Used Only with Literal Values.
Rights Holder
A person or organization owning or managing rights over the resource.
Status: Conforming.
Used Only with Non-Literal Values.
Rights
Copyright Statement - Information about rights held in and over the resource. Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights.
Status: Recommended.
Used Only with Non-Literal Values.
Access Rights
Information about who can access the resource or an indication of its security status. Access Rights may include information regarding access or restrictions based on privacy, security, or other policies.
Status: Conforming.
Used Only with Non-Literal Values.
Provenance
A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. The statement may include a description of any changes successive custodians made to the resource.
Status: Conforming.
Used Only with Non-Literal Values.
License
A legal document giving official permission to do something with the resource.
Example:
http://www.gnu.org/licenses/gpl.htmlStatus: Conforming.
Used Only with Non-Literal Values.
Publisher
An entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.
Status: Recommended.
Used Only with Non-Literal Values.
Contributor
An entity responsible for making contributions to the resource. Examples of a Contributor include a person, an organization, or a service. Typically, the name of a Contributor should be used to indicate the entity.
Status: Recommended.
Used Only with Non-Literal Values.
Mediator
An entity that mediates access to the resource and for whom the resource is intended or useful. In an educational context, a mediator might be a parent, teacher, teaching assistant, or care-giver.
Status: Recommended.
Used Only with Non-Literal Values.
Audience
A class of entity for whom the resource is intended or useful. A class of entity may be determined by the creator or the publisher or by a third party.
Status: Recommended.
Used Only with Non-Literal Values.
Audience Education Level
A class of entity, defined in terms of progression through an educational or training context, for which the described resource is intended.
Status: Conforming.
Used Only with Non-Literal Values.
Coverage
The spatial or temporal topic of the resource, the spatial applicability of the resource, or the jurisdiction under which the resource is relevant. Spatial topic and spatial applicability may be a named place or a location specified by its geographic coordinates. Temporal topic may be a named period, date, or date range. A jurisdiction may be a named administrative entity or a geographic place to which the resource applies. Recommended best practice is to use a controlled vocabulary such as the Thesaurus of Geographic Names [TGN]. Where appropriate, named places or time periods can be used in preference to numeric identifiers such as sets of coordinates or date ranges.
[TGN] https://www.getty.edu/research/tools/vocabularies/tgn
Status: Recommended.
Used Only with Non-Literal Values.
Spatial Coverage
Spatial characteristics of the resource.
Status: Recommended.
Used Only with Non-Literal Values.
Temporal Coverage
Temporal characteristics of the resource.
Status: Recommended.
Used Only with Non-Literal Values.
Bibliographic Citation
A bibliographic reference for the resource. Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible.
Example:
Lecture Notes in Computer Science 2458, 309-323 (2002)Status: Conforming.
Used Only with Literal Values.
Relation
A related resource. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
Status: Recommended.
Used Only with Non-Literal Values.
References
A related resource that is referenced, cited, or otherwise pointed to by the described resource.
Status: Recommended.
Used Only with Non-Literal Values.
Is Referenced By
A related resource that references, cites, or otherwise points to the described resource.
Status: Recommended.
Used Only with Non-Literal Values.
Replaces
A related resource that is supplanted, displaced, or superseded by the described resource.
Status: Recommended.
Used Only with Non-Literal Values.
Is Replaced By
A related resource that supplants, displaces, or supersedes the described resource.
Status: Recommended.
Used Only with Non-Literal Values.
Requires
A related resource that is required by the described resource to support its function, delivery, or coherence.
Status: Recommended.
Used Only with Non-Literal Values.
Is Required By
A related resource that requires the described resource to support its function, delivery, or coherence.
Status: Recommended.
Used Only with Non-Literal Values.
Source
A related resource from which the described resource is derived. The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.
Status: Recommended.
Used Only with Non-Literal Values.
Accrual Method
The method by which items are added to a collection.
Status: Conforming.
Used Only with Non-Literal Values.
Accrual Periodicity
The frequency with which items are added to a collection.
Status: Conforming.
Used Only with Non-Literal Values.
Accrual Policy
The policy governing the addition of items to a collection.
Status: Conforming.
Used Only with Non-Literal Values.
Instructional Method
A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. Instructional Method will typically include ways of presenting instructional materials or conducting instructional activities, patterns of learner-to-learner and learner-to-instructor interactions, and mechanisms by which group and individual levels of learning are measured. Instructional methods include all aspects of the instruction and learning processes from planning and implementation through evaluation and feedback.
Status: Conforming.
Used Only with Non-Literal Values.
Conforms To
An established standard to which the described resource conforms.
Example:
http://www.w3.org/2001/XMLSchemaStatus: Recommended.
Used Only with Non-Literal Values.
Table Of Contents
A list of subunits of the resource.
Status: Recommended.
May be used with Literal and Non-Literal Values.
Elements/Terms Included
titlealternativedescriptionsubjectabstractlanguagetype (Collection, Dataset, Event, Image, InteractiveResource, Service, Software, Sound, Text)mediumidentifierformathasFormatisFormatOfhasPartisPartOfhasVersionisVersionOfextentcreatorcreatedavailableissueddateSubmitteddateAcceptedvalidmodifieddatedateCopyrightedrightsHolderrightsaccessRightsprovenancelicensepublishercontributormediatoraudienceeducationLevelcoveragespatialtemporalbibliographicCitationrelationreferencesisReferencedByreplacesisReplacedByrequiresisRequiredBysourceaccrualMethodaccrualPeriodicityaccrualPolicyinstructionalMethodconformsTotableOfContents
Notes
- Support for Joomla version older than 3.4.4 has been dropped since eorisis DCMI 2.0.0. See the Changelog and Requirements.
- The plugin uses the Joomla! Framework and PHP language to integrate the metadata fields into the articles, categories, menus, etc., tabs and add the meta elements in the head of the document in the Front End. No JavaScript involved. All this is done in the server memory (RAM) before the page is rendered.
- The plugin uses it's own table in the database. This table holds only the used fields and settings and only for the content that have DCMI set. If you uninstall the plugin, this table gets dropped so that the plugin gets removed completely from your website (as it should -- there may be an option upon uninstall in the future). If you plan to upgrade to a newer version of the plugin, never uninstall it first because you will lose all your DCMI settings and metadata, unless you want to. Always upgrade the plugin using the recommended methods. See Updates below.
- Do not use the terms or the variant in the fields, i.e., dcterms.title : Use what you want each term to be set to. See Screenshots.
- Do not type dates manually into the Calendar fields, instead use the calendar button or the Custom field. A Joomla bug exists so that in case you type wrong characters in the calendar field, Joomla will go crazy and the only solution will be to edit the database manually. Although it is not caused by the plugin, a solution for this preexisting Joomla bug will be given at a later version.
- When you see two calendars for an element, that is because this element can use a range of dates, i.e., from 2016-5-17 to 2016-5-19. This could be, say, an event that will start (or took place in the past) on the 17th and will end on the 19th of the 5th month of 2016. If you want to type it in the Custom field, use the following format: YYYY-MM-DD/YYYY-MM-DD (notice the slash in between). If you use the calendars this slash will be entered by the software. If you do not wish to set an End Date, just use the 1st calendar only. If you use the 2nd only by accident, the software will take care of it. If you want to set a date for a historical event of the ancient times you can set the date like: 500 B.C. or approx. 500 B.C.
- By default, all content DCMI metadata are set to Global. Switch to Custom if you want to set specific metadata for that article/category/menu/resource. It is set this way so that all Global metadata will appear on all your website's pages (example your copyright information). If you want the opposite behavior, do not set anything in the plugin page, use only Custom settings in each article, category or menu. Customizing and learning how the plugin will behave should let you do anything you want without any kind of limitation already. Much more advanced handling, for much better control should be expected in later versions as well.
- The Global DCMI Metadata options exist in the plugin's page and not in the Joomla Global Configuration page for various of reasons. One of them is to avoid rewriting the configuration.php file after save.
