twingle/doc/teps tep-0101.txt,NONE,1.1

[email protected] Thu, 6 Mar 2003 08:12:54 -0700 (MST)
Newsgroups gmane.comp.cms.oscom.twingle.cvs
Message-ID <[email protected]>
Update of /cvs/root/twingle/doc/teps
In directory alpha.oscom.org:/tmp/cvs-serv12626

Added Files:
	tep-0101.txt 
Log Message:
TEP on service discoverabiliy started

--- NEW FILE: tep-0101.txt ---

TEP: 101
Title: Configuration discovery and file format
Version: $Id: tep-0101.txt,v 1.1 2003/03/06 15:12:52 gregor Exp $
Last-Modified: $Date: 2003/03/06 15:12:52 $
Author: Gregor J. Rothfuss
Status: Active
Type: Standards Track
Content-Type: text/plain
Created: 07-Mar-2003

Abstract

   Twingle needs to discover per-server settings. A way to achieve
   this is described, as well as the configuration file format.

Service Discovery

   The problem of service discovery has been discussed at length
   in weblog circles. [1],[2] Best practice is to use the
   LINK tag to indicate the location of services. Building on
   that, a format has been proposed recently that allows for lightweight
   service descriptions.

RSD
   Really Simple Discoverability is a format [3] "to help client 
   software find the services needed to read, edit, or "work with" 
   weblogging software. Although I talk about weblogging software, 
   there's no reason this format can't apply to other forms of web 
   client/system software that I wasn't considering, or may not 
   even exist as of this writing."

   The plan is to use the RSD specification for twingle as well.
   Here is a sample RSD file:

<?xml version="1.0" ?> 
<rsd version="1.0" xmlns="http://archipelago.phrasewise.com/rsd" >
    <service>
        <engineName>Blog Munging CMS</engineName> 
        <engineLink>http://www.blogmunging.com/ </engineLink>
        <homePageLink>http://www.userdomain.com/ </homePageLink>
        <apis>
                <api name="Twingle" preferred="false" apiLink="http://example.com/xml/rpc/url" blogID="">
                    <settings>
                        <docs>http://oscom.org/Projects/Twingle/</docs> 
                        <notes>Additional explanation here.</notes>
                        <setting name="service-specific-setting">a value</setting> 
                        <setting name="another-setting">another value</setting> 
                    </settings>
                 </api>
        </apis>
    </service>
</rsd>


Open Issues
   What kind of configuration parameters do we need for Twingle?
 

Resources

  [1] http://diveintomark.org/archives/2002/06/02/important_change_to_the_link_tag.html
  [2] http://www.w3.org/P3P/validator/20020128/document
  [3] http://archipelago.phrasewise.com/rsd


Copyright

  This document has been placed in the public domain.