Difference between revisions of "rel-principles"
(initial add for rel-principles specification draft)
|Line 44:||Line 44:|
Revision as of 00:27, 22 January 2010
<entry-title>rel-principles 0.1</entry-title> This document represents a draft microformat specification. Although drafts are somewhat mature in the development process, the stability of this document cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Watch this wiki page, or follow discussions on the #microformats Freenode IRC channel to stay up-to-date.
rel-principles is a simple, open format for indicating statements of principles for the associated content, which is embeddable in HTML or XHTML, Atom, RSS, and arbitrary XML.
Draft Specification 2010-01-21
- Jonathan Malek (Associated Press)
- Ben Campbell (Media Standards Trust)
- Martin Moore (Media Standards Trust)
- Stuart Myles (Associated Press)
- Todd B. Martin (Associated Press)
Per the public domain release on the authors' user pages (Jonathan Malek) this specification is released into the public domain.
Public Domain Contribution Requirement. Since the author(s) released this work into the public domain, in order to maintain this work's public domain status, all contributors to this page agree to release their contributions to this page to the public domain as well. Contributors may indicate their agreement by adding the public domain release template to their user page per the Voluntary Public Domain Declarations instructions. Unreleased contributions may be reverted/removed.
rel-principles is a format for identifying principles statements for a piece of content. It builds on other microformats which define specific uses of the rel attribute for links, such as rel="tag" and rel="license".
Whilst its original intention is to be used for journalistic content in conjunction with hNews 0.1, its use may extend to other entities or professions with principles or codes of conduct.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Semantic XHTML Design Principles
Note: the Semantic XHTML Design Principles were written primarily within the context of developing hCard and hCalendar, thus it may be easier to understand these principles in the context of the hCard design methodology (i.e. read that first). Tantek
XHTML is built on XML, and thus XHTML based formats can be used not only for convenient display presentation, but also for general purpose data exchange. In many ways, XHTML based formats exemplify the best of both HTML and XML worlds. However, when building XHTML based formats, it helps to have a guiding set of principles.
- Reuse the schema (names, objects, properties, values, types, hierarchies, constraints) as much as possible from pre-existing, established, well-supported standards by reference. Avoid restating constraints expressed in the source standard. Informative mentions are ok.
- For types with multiple components, use nested elements with class names equivalent to the names of the components.
- Plural components are made singular, and thus multiple nested elements are used to represent multiple text values that are comma-delimited.
- Use the most accurately precise semantic XHTML building block for each object etc.
- Otherwise use a generic structural element (e.g.
<div>), or the appropriate contextual element (e.g. an
- Use class names based on names from the original schema, unless the semantic XHTML building block precisely represents that part of the original schema. If names in the source schema are case-insensitive, then use an all lowercase equivalent. Components names implicit in prose (rather than explicit in the defined schema) should also use lowercase equivalents for ease of use. Spaces in component names become dash '-' characters.
- Finally, if the format of the data according to the original schema is too long and/or not human-friendly, use
<abbr>instead of a generic structural element, and place the literal data into the 'title' attribute (where abbr expansions go), and the more brief and human readable equivalent into the element itself. Further informative explanation of this use of
<abbr>: Human vs. ISO8601 dates problem solved
rel=”principles” to a hyperlink, a page indicates that the destination of that hyperlink is a description of the principles the content on the page was created under.
<a href="http://www.mediastandardstrust.org/code-of-practice" rel="principles">some statement of principles name goes here</a>
See rel-tag Profile