ESS:Categories

From ESS
Revision as of 20:43, 28 March 2012 by Admin ess (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Contents

"Categories" definition

The principal XML element that characterizes an ESS event is the category under which that event is labeled.
The category defines the theme of an event and the purpose of this section is to universalize all main stream events into general categories.
ESS event categories are essential- they create a virtual connection between all events that use ESS as a standard.
ESS categories start from generic main-stream theme definition and uncover more specific definitions. Each category has a specific unique identifier, this ID simplify ESS Processors feeds analysis to cross similarities with other events.


For example:
A Basketball match can be defined by: Sport (C) > Team Sport (C2) > Basketball) The ESS category ID for such an event is C2 with in keywork and description Basketball.
A cinema listing can be defined as: Cinema > Action Movie The ESS category ID for such an event is I3 (worldwide and permanent).
At the same time, a portal that federates ESS event feeds can easily display the kinds of events that interest readers (A25B). Humans are not needed to retrieve the information and post it: the source creates the feed, the subscriber syndicates to the feed and with the category ID can receive updated and relevant information regarding events and happening that fall under that category.




ESS structure

ESS documents are composed by various main XML elements. ESS processors must consider each and every element's description as valid and applicable to each and every other XML element within the same ESS document. If this is not the case, then it is the responsibility of another feed to describe this event parameter.
Example: every items must be valid and applicable to every and items within the same feed.

XML element must be defined in an ESS Feed Document, it is a mandatory ESS XML element.
must contain, at least, one element. elements must only be comprised of three XML element types : "name", "id" and "description", elements must have at least a "name" element of an immediate child. If it is present, the value of element identifies a hierarchic identifier location in the ESS taxonomy. Processors may establish conventions for the interpretation of category ID, even if the user is free to define its own category by entering a "name" and a "description". But it is advisable to use ESS categories taxonomy for wide scale broadcasting and usage of the event feed.




Categories elements

Each XML element must have as immediate child, at least, one XML element. The element must be the only type of XML element children of element. elements can be repeated an infinite number of times.
If several elements are defined, the prevalence can be defined by a "priority" attribute. If no "priority" attributes are defined, ESS Processors may apply the writing in cascading order (top to bottom).

Name Description Type Required
Unique hierarchical category identifier in ESS indicated taxonomy. IRI RFC3987 FALSE
Language-sensitive category shortens name. Should not be longer then 64 characters String TRUE
Language-sensitive category description should not be longer then 512 chars. String FALSE
XML structure that numerate an infinite number of childs elements with keywords content. ESS Processors should use those keywords to affinate event's categories representation. XML FALSE




ESS categories sample

DTD description [https://eventstandardsyndication.org/history/0.9 ]

 version="1.0" encoding="UTF-8"?>
 xmlns="https://eventstandardsyndication.org/history/0.9" version="0.9" lang="en">
   ...
   >
      >
         >C2AH>
         >Football>
         >
            
               Here is the category specific description that match the best the event subject.
            ]]>
         >
         >
             >Sport>
             >Team sport>
             >Ball>
             >Stadium>
         > 
      >
   >
   ...
>



Search a category

Complete listing of all event's categories will come soon.







External documentation

Ietf logo.png

ESS standard under RFC validation process: RFC ESS Draft




Discussion


Leave your comment

Personal tools
Variants
Actions
Standard

 

Developers