OPML 1.0 Specifications
External Processor Marking Language
OPML 1.0 Specifications |
|
|
External Processor Marking Language
|
Dave Wiener for UserLand. 9/15/00 DW
French translation by Denis Surot for .fr Specifications in English.
This specification describes the OPML 1.0 format, which is now replaced by OPML 2.0, but this format can be found in OPML documents.
About this document 
This document describes a format for storing plans in XML 1.0 called Outline Processor Markup Language or OPML (in French, Tags de Processor de Plan).
For the purposes of this document, a plan is a tree where each node contains a set of named attributes with row values.
An outsyle (or plan) has long been a common way of organizing information on computers. Even if the story with the planned software is unclear, a story project is possible.
The first planned software was developed by Doug Engelbart as part of his Augment system in the 60s.
Living Videotext in 1981-87 developed several planned programs for personal computers. They are archived on UserLand, outliners.
Frontier, whose distribution began in 1992, is built on creating a plan. Text editors, menus, and scripts in Frontier are scheduled software as well as an object database browser.
XML 1.0, the format on which OPML is based, is a W3C recommendation.
Radio UserLand, which began distribution in March 2001, is a planned software with its own file format in OPML.
OPML is used for directories in Manila.
Plans can be used for specifications, legal reports, product planning, presentations, scripts, catalogs, personal journals, discussion groups, chats, and novels.
Planning software is programs for reading, editing and reorganizing plans.
As examples of OPML documents: play-list, specifications, presentation.
The purpose of this format is to provide a way to exchange information between planning software and Internet services that can be targeted and controlled by planning software.
The idea behind its design is to have a simple and transparent, documentable, extensible and human readable format capable of representing a large panel of data that can be viewed and edited. With the future development of the format, this goal will continue. It should be possible for someone with minimal technical baggage to perfectly understand the format by quickly reading one web page.
This is an open format, which means that other scheduled software vendors and service developers can freely use the format to be compatible with Radio UserLand or for any other reason.
<opml> is an XML element with one required version attribute; the "head" element and the "body" element, both of which are necessary.
The version attribute is a character string of form version x.y, where x and y are numeric strings.
<head> contains zero or more additional elements, as described below.
<title> - document title.
<dateCreated> is the date/time when the document was created.
<dateModified> is the date/time when the document was last modified.
<ownerName> is the row that owns the document.
<ownerEmail> - line, address of the document owner.
<expansionState> is a comma-separated list of expanded string numbers. The line number in the list tells you which headings to develop. Order is important. For each item in the X list, starting at the first vertex, we move X times and develop. We repeat every item on the list.
<greenScrollState> is a number that specifies which plan line is displayed in the first line of the window. This number is calculated taking into account the already applied state of development.
<windowsTop> - number, pixel position of the top edge of the window.
<windowsLeft> - number, pixel position of the left edge of the window.
<windowsBottom> - number, pixel position of the bottom edge of the window.
<windowsRight> - number, pixel position of the right edge of the window.
Notes about <head>
All nested <head> elements may be ignored by the processor. If a plane is open in another plane, the processor should ignore windowsXxx elements, which control only the size and location of planes open in their own windows.
All date/hours conform to Date/Time Specification RFC 822.
If you are downloading an OPML document to a client computer, you can choose whether to use expansionState or not. In no way do we try to direct what the user is doing. expansionState information is here because it is needed in certain contexts. It is easy to imagine contexts where it would be relevant to ignore it completely.
What is a " bodysuit"?
<body> contains "outline" or later.
An outline is an XML element that contains one or more attributes and any number of nested outline elements.
Common attributes
Text is a string that appears when you walk through or edit a plan. There is no limit to the length of the text attribute.
type is a string of characters that tells you how other attributes are interpreted in <outline> .
isComment is a string, that is, "true" or "false" (true or false), indicating whether the plan is commented on or not. By agreement, if a plan is commented on, then all subordinate plans are also considered commented. If it is not, the value is wrong.
isBreakpoint is a string, that is, "true" or "false," indicating whether the stop point is placed on a plane. This attribute is needed mainly for plans used to edit running scripts. If a value is missing, it is invalid.
Before the 1.0 format was frozen, the first level elements of the format were called outlineDocument. UserLand radio continues to read these materials.
There is no limit to the number of attributes an <outline> element can have or the number of <outline> elements it can contain.
OPML is a file format, not a protocol. When you click on a link in an HTML document, the document stored on the server does not change in any way. OPML is used in the same way.
Wayne Steele did the DTD for OPML 1.0. Thanks.
Typically, the mime type of an OPML document when you access it via HTTP is text/xml. This allows web browsers to use regular XML formats to view the OPML document. The Radio UserLand HTTP server looks at the Accept header of the request to determine how it handles the OPML document. If the Accept header indicates that the client computer includes text/x-opml, the XML text is returned without processing. If not, return plan text with mime type text/html.
Copyright and authorization
© Copyright 2000 UserLand Software, Inc. All rights reserved.
This document and its translations may be copied and made available to others, and works derived for comment or explanation or to facilitate implementation may be written, copied, published and distributed in whole or in part without restriction of any kind, provided that the copyright notice is above and those paragraphs are included in those copies or derived works.
A document may in no way be altered by removing a copyright notice or links to UserLand or other entities. In addition, since these copyright restrictions apply to the writing of the OPML specification, UserLand makes no claim to ownership in the format it describes. Anyone may, for commercial or non-commercial reasons, implement this protocol without licensing rights or royalties associated with UserLand. The above limited permissions are perpetual and may not be revoked by UserLand or its successors or representatives.
The above document and information are provided "as is" and USERLAND DECLINE ALL WARRANTIES, EXPRESS OR RELATED THERETO, INCLUDING ANY WARRANTIES THAT THE USE OF THE ABOVE INFORMATION WILL NOT INFRINGE ANY RIGHTS OR ANY WARRANTIES RELATING TO MARKETING OR APPLICABILITY TO ANY OF USE
© Copyright 2000-2007, Script News, Inc.
OPML is a trademark of Script News, Inc.
Last Updated Thursday, Januarius 3, 2002 at 3:56:54 PM
© Copyright 2007 by Denis Surot and .fr for French translation.
French Translation License: The terms and conditions of this document are the terms and conditions of the original document with such accuracy that a notice including the name of Denis Surot's translator and the URL of the site where the translation is posted must iqlevsha.ru be stored on any document derived from this document .
Translation creation: March 24, 2007.