opmllogo:
Outline Processor Markup Language

 
About

Home

Spec

Directory

Validator

Editor



Members
Join Now
Login

 
 

Proposal: New "include" nodetype

Sat, Nov 5, 2005; by Dave Winer.

Status 

 11/5/05: Request for comments, please do not deploy.

Goal 

 To provide a simple and straightforward way to include one OPML document within another.

Background 

 There already is a syntax for inclusion, this new syntax does not replace the previous method, it provides a simpler alternative. I suggest that this new method be favored over the original method, however processors must continue to interpret the original method.

type="include" 

 An outline element whose type is include must have a url attribute that points to the OPML file to be included. The text attribute is, as usual, what's displayed in the outliner, and it's also what is displayed in the HTML rendering.

 A validator should check that the OPML file being included is accessible, and may wish to validate the pointed-to file as well.

Example 

 <outline text="Florida" type="include" url="http://hosting.opml.org/dave/florida.opml"/>

Prior art 

 Think of this nodetype as being like a #include in C and C-like programming languages. The result of an include is as if the text of the included file appeared in the original.

 It's also something like the anchor element in HTML, but the effect is a bit different, because the content may appear to the user as if it's part of the document containing the inclusion. Outliners therefore should provide a visual indication that a node is an inclusion.

Comments? 

 Please post comments here.




© Copyright 2000-2008, Scripting News, Inc.
OPML is a trademark of Scripting News, Inc.
Last update: Saturday, November 5, 2005 at 7:53:56 PM.

Create your own Manila site in minutes. Everyone's doing it!