Atom Vocabulary for Wiki Metadata

Abstract

This document specifies Extension elements and link relations for the Atom Syndication Format used for description of wiki metadata.

Authors

Copyright

Copyright © 2018 Paulina Laura Emilia

Atom Vocabulary for Wiki Metadata is licensed under a Creative Commons Attribution 4.0 International License.

Status of this document

This document is a working draft of a proposed specification. Its contents may be subject to change at any moment.

Changelog

2018-08-26
Merged wiki:editsummary, wiki:importance, wiki:status and wiki:version into a one element. Added useful link relations.
2018-05-14
Removed proposed categorization schemes. It is better to refer to well-defined SKOS concept schemes instead.

1. Introduction

This document specifies Extension elements and link relations for the Atom Syndication Format (RFC 4287) useful for description of metadata specific to the wiki engines.

It is loosely based on the proposed RSS 1.0 Wiki Module (ModWiki) and Atom Syndication Format Revision Tracking Internet Draft (I-D.snell-atompub-revision).

1.1 Namespace

The XML Namespaces URI (REC-xml-names) for XML elements defined in this document is https://wandystan.eu/ns/AtomWiki/0.3/. The preferred XML namespace prefix for elements in this namespace is wiki.

1.2 Notational conventions

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.

Terms “Extension element”, “Simple Extension element”, “Structured Extension element”, “Text construct” and “Person construct” are to be interpreted as described in RFC 4287.

The namespace prefix wiki: is used for the Namespace URI identified in section 1.1 of this document. The namespace prefix atom: is used for the Namespace URI identified in section 1.2 of the RFC 4287.

2. Extension element definitions

2.1 wiki:revision

Indicates that the entry it occurs in represents a revision of a wiki page. It is an extended Atom Text construct whose value MAY be used to provide a human-readable summary of the change to the page.

This element MAY contain an identifier attribute whose value is a string that unambiguously identifies revision of the page.

This element MAY contain an importance attribute that indicates the importance of the change to the page. The value of this attribute SHOULD be either “major” or “minor”.

This element MAY contain a scheme attribute whose value is an IRI that identifies a scheme used to produce the revision number specified by the identifier attribute.

This element MAY contain a status attribute that indicates the status of the change to the page. The value of this attribute SHOULD be one of the “new”, “updated”, or “deleted”.

wiki:revision is a Structured Extension element and MUST be a child of atom:entry element.

2.2 wiki:host

The host associated with the person that edited the wiki page. The content of this element MUST be either an IP address or a hostname; they MAY be partially masked.

wiki:host is a Simple Extension element and MUST be a child of an Atom Person construct.

3. Link relations

When used in an Atom document, names of the relations described below MUST be preceded by the Namespace URI identified in section 1.1 of this document, e.g. rel="https://wandystan.eu/ns/AtomWiki/0.3/history".

3.1. revision-of

Refers to the page that the entry is a revision of.

3.2. first-revision

Refers to the earliest revision of the page.

3.3. last-revision

Refers to the latest revision of the page.

3.4. prev-revision

Refers to the previous revision of the page.

3.5. next-revision

Refers to the next revision of the page.

3.6. diff

Refers to the resource describing the difference between a previous and the current revision of the page.

3.7. history

Refers to the resource describing the revision history of the page.

4. References

4.1 Normative references

REC-xml-names

T. Bray et al., “Namespaces in XML 1.0 (Third Edition)”, W3C Recommendation, 8 December 2009.

RFC 2119

S. Bradner, “Key words for use in RFCs to Indicate Requirement Levels”, RFC 2119, March 1997.

RFC 4287

M. Nottingham, R. Sayre, “The Atom Syndication Format”, RFC 4287, December 2005.

4.2 Informative references

I-D.snell-atompub-revision

J. Snell, “Atom Syndication Format Revision Tracking”, Internet-Draft, February 2006.

ModWiki

RDF Site Summary 1.0 Module: Wiki”, MeatballWiki.