Really Simple Discovery

Last updated

Really Simple Discovery (RSD) is an XML format and a publishing convention for making services exposed by a blog or other software discoverable by client software.

Contents

It is a way to reduce the information required to set up editing/blogging software to three well known elements: username, password, and homepage URL. Any other critical settings should either be defined in the RSD file related to the website, or discoverable using the information provided.

History

RSD was authored by Daniel Berlinger in the Really Simple Discoverability 1.0 specification.[ citation needed ]

Format

To make use of RSD, the owner of a site places a link tag in the head section of the homepage which indicates the location of the RSD file. An example of what MediaWiki uses is:

<linkrel="EditURI"type="application/rsd+xml"href="https://en.wikipedia.org/w/api.php?action=rsd"/>

If this tag is missing or the file is not found, clients should look in the default location, which is a file named rsd.xml in the webroot. [1] For example, at https://example.net/rsd.xml.

Contents

Here is a sample RSD file, from "Really Simple Discoverability 1.0":

<?xml version="1.0" ?><rsdversion="1.0"xmlns="http://archipelago.phrasewise.com/rsd"><service><engineName>BlogMungingCMS</engineName><engineLink>http://www.blogmunging.com/</engineLink><homePageLink>http://www.userdomain.com/</homePageLink><apis><apiname="MetaWeblog"preferred="true"apiLink="http://example.com/xml/rpc/url"blogID="123abc"/><apiname="Blogger"preferred="false"apiLink="http://example.com/xml/rpc/url"blogID="123abc"/><apiname="MetaWiki"preferred="false"apiLink="http://example.com/some/other/url"blogID="123abc"/><apiname="Antville"preferred="false"apiLink="http://example.com/yet/another/url"blogID="123abc"/><apiname="Conversant"preferred="false"apiLink="http://example.com/xml/rpc/url"blogID=""><settings><docs>http://www.conversant.com/docs/api/</docs><notes>Additionalexplanationhere.</notes><settingname="service-specific-setting">avalue</setting><settingname="another-setting">anothervalue</setting>...</settings></api></apis></service></rsd>

MediaWiki example:

<?xml version="1.0"?><rsdversion="1.0"xmlns="http://archipelago.phrasewise.com/rsd"><service><apis><apiname="MediaWiki"preferred="true"apiLink="http://en.wikipedia.org/w/api.php"blogID=""><settings><docsxml:space="preserve">http://mediawiki.org/wiki/API</docs><settingname="OAuth"xml:space="preserve">false</setting></settings></api></apis><engineNamexml:space="preserve">MediaWiki</engineName><engineLinkxml:space="preserve">http://www.mediawiki.org/</engineLink></service></rsd>

Usage of RSD

See also

Related Research Articles

Vector Markup Language (VML) is an obsolete XML-based file format for two-dimensional vector graphics. It was specified in Part 4 of the Office Open XML standards ISO/IEC 29500 and ECMA-376. According to the specification, VML is a deprecated format included in Office Open XML for legacy reasons only.

<span class="mw-page-title-main">Atom (web standard)</span> Web standards

The name Atom applies to a pair of related Web standards. The Atom Syndication Format is an XML language used for web feeds, while the Atom Publishing Protocol is a simple HTTP-based protocol for creating and updating web resources.

The following tables compare general and technical information for many wiki software packages.

XML namespaces are used for providing uniquely named elements and attributes in an XML document. They are defined in a W3C recommendation. An XML instance may contain element or attribute names from more than one XML vocabulary. If each vocabulary is given a namespace, the ambiguity between identically named elements or attributes can be resolved.

XML Interface for Network Services (XINS) is an open-source technology for definition and implementation of internet applications, which enforces a specification-oriented approach.

A sitemap is a list of pages of a web site within a domain.

<span class="mw-page-title-main">FOAF</span> Semantic Web ontology to describe relations between people

FOAF is a machine-readable ontology describing persons, their activities and their relations to other people and objects. Anyone can use FOAF to describe themselves. FOAF allows groups of people to describe social networks without the need for a centralised database.

Sitemaps is a protocol in XML format meant for a webmaster to inform search engines about URLs on a website that are available for web crawling. It allows webmasters to include additional information about each URL: when it was last updated, how often it changes, and how important it is in relation to other URLs of the site. This allows search engines to crawl the site more efficiently and to find URLs that may be isolated from the rest of the site's content. The Sitemaps protocol is a URL inclusion protocol and complements robots.txt, a URL exclusion protocol.

<span class="mw-page-title-main">Yadis</span>

Yadis is a communications protocol for discovery of services such as OpenID, OAuth, and XDI connected to a Yadis ID. While intended to discover digital identity services, Yadis is not restricted to those. Other services can easily be included.

FeedSync for Atom and RSS, previously Simple Sharing Extensions, are extensions to RSS and Atom feed formats designed to enable the bi-directional synchronization of information by using a variety of data sources. Initially developed by Ray Ozzie, Chief Software Architect at Microsoft, it is now maintained by Jack Ozzie, George Moromisato, Matt Augustine, Paresh Suthar and Steven Lees. Dave Winer, the designer of the UserLand Software RSS specification variants, has given input for the specifications.

RDFa or Resource Description Framework in Attributes is a W3C Recommendation that adds a set of attribute-level extensions to HTML, XHTML and various XML-based document types for embedding rich metadata within Web documents. The Resource Description Framework (RDF) data-model mapping enables its use for embedding RDF subject-predicate-object expressions within XHTML documents. It also enables the extraction of RDF model triples by compliant user agents.

GeoRSS is a specification for encoding location as part of a Web feed. (Web feeds are used to describe feeds of content, such as news articles, Audio blogs, video blogs and text blog entries. These web feeds are rendered by programs such as aggregators and web browsers.) The name "GeoRSS" is derived from RSS, the most known Web feed and syndication format.

Security Assertion Markup Language 2.0 (SAML 2.0) is a version of the SAML standard for exchanging authentication and authorization identities between security domains. SAML 2.0 is an XML-based protocol that uses security tokens containing assertions to pass information about a principal between a SAML authority, named an Identity Provider, and a SAML consumer, named a Service Provider. SAML 2.0 enables web-based, cross-domain single sign-on (SSO), which helps reduce the administrative overhead of distributing multiple authentication tokens to the user. SAML 2.0 was ratified as an OASIS Standard in March 2005, replacing SAML 1.1. The critical aspects of SAML 2.0 are covered in detail in the official documents SAMLCore, SAMLBind, SAMLProf, and SAMLMeta.

Apache Click is a page and component oriented web application framework for the Java language and is built on top of the Java Servlet API.

The Office Open XML file formats are a set of file formats that can be used to represent electronic office documents. There are formats for word processing documents, spreadsheets and presentations as well as specific formats for material such as mathematical formulas, graphics, bibliographies etc.

In computing, Open Data Protocol (OData) is an open protocol that allows the creation and consumption of queryable and interoperable Web service APIs in a standard way. Microsoft initiated OData in 2007. Versions 1.0, 2.0, and 3.0 are released under the Microsoft Open Specification Promise. Version 4.0 was standardized at OASIS, with a release in March 2014. In April 2015 OASIS submitted OData v4 and OData JSON Format v4 to ISO/IEC JTC 1 for approval as an international standard. In December 2016, ISO/IEC published OData 4.0 Core as ISO/IEC 20802-1:2016 and the OData JSON Format as ISO/IEC 20802-2:2016.

The Open Publication Distribution System (OPDS) catalog format is a syndication format for electronic publications based on Atom and HTTP. OPDS catalogs enable the aggregation, distribution, discovery, and acquisition of electronic publications. OPDS catalogs use existing or emergent open standards and conventions, with a priority on simplicity.

gSOAP is a C and C++ software development toolkit for SOAP/XML web services and generic XML data bindings. Given a set of C/C++ type declarations, the compiler-based gSOAP tools generate serialization routines in source code for efficient XML serialization of the specified C and C++ data structures. Serialization takes zero-copy overhead.

The SAML metadata standard belongs to the family of XML-based standards known as the Security Assertion Markup Language (SAML) published by OASIS in 2005. A SAML metadata document describes a SAML deployment such as a SAML identity provider or a SAML service provider. Deployments share metadata to establish a baseline of trust and interoperability.

References

  1. "RFC: Really Simple Discoverability 1.0". 2007-10-16.
  2. API discovery - StatusNet
  3. MediaWiki source code for ApiRsd.php
  4. MediaWiki API's documentation about the API entry point
  5. Wordpress source code for rsd_link