work in progress...

ESS:Categories

From ESS
Revision as of 20:16, 5 March 2012 by Admin ess (Talk | contribs)
Jump to: navigation, search

Contents

"Categories" definition

The principal XML element that caracterised an ESS event is the category.
The category define events theme, the purpose of this section is to universalise all main stream events into generalist categories.
ESS event's categories are the essential, they create a virtual connection between all events that use ESS as standard.
ESS categories start from generic main stream theme definition and digg to more specific definitions. Each category have a specific unic identifier, this ID simplify ESS Processors feeds analysis to cross similarities with other events.


For example:
A Basketball match can de defined by: Sport (C) > Team Sport (C2) > Basketball (C2BA) The ESS category ID for such an event is C2BA (worlwide and forever).
A cinema can define a movie by: Art > Film > Action Movie The ESS category ID for such an event is A25B (worlwide and forever).
At the same time a portal that federate ESS event feeds can easily display the kind of events that interest its readers (A25B). There is no longer human interaction to reach the information: the source create the feed, the subscriber syndicate to the feed and with the category ID there are both talking about the same subject.




ESS categories structure

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 be only composed by three XML element types : "name", "id" and "description", elements must have at least a "name" element as imediat child. If it is present, the value of element identify a hierarchic identifier location in the ESS taxonomy. Processors may establish conventions for the interpretation of category ID, even if user is free to define its own category by entering a "name" and a "description". But it is adviced to use ESS categories taxonomy for a wide scale brodcasting and usage of the event feed.



Category's item elements

Each XML element must have as imediate child, at least, one XML element. The element must be the only type of XML element children of element. elements can be repeated an infinit number of time.
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 cascading order (top to bottom).

Name Description Type Required
Hierarchic identifier location in the ESS indicated taxonomy. String FALSE
Language-Sensitive trivial category short name. Should not be longer then 64 characters String TRUE
Language-Sensitive category description that SHOULD NOT be longer then 512 chars. String FALSE
XML structure that enumerare an infinite number of child elements with String content of category keywords, this keywords can be used by ESS Processors to afinate the representation of event category. XML FALSE


ESS categories sample

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

Search a category



External documentation

Ietf logo.png
  1. [RFC 3076] : Canonical XML Version 1.0




Discussion


Leave your comment

Personal tools
Variants
Actions
Standard

 

Developers

 

Community