ESS:Integration

From ESS
Jump to: navigation, search
Format ESS
Ess-feed-icon.png
.ess, .xml
application/ess+xml
version 0.9

3 | ESS Integration

Once an ESS Feed is generated (ESS generator) and validated (ESS validator), the feeds must be available online.
ESS documents are XML based files, to be correctly displayed and reconised by 3rd party ESS robots processors the document should specify a specific "content type" header.
ESS feed can be served as XML files with a :
content-type: text/xml

But to facilitate robot recognition of .ess feeds file, ESS producers should explicitly specify on serverside an header deficated to this file extension :
content-type: application/ess+xml



Publish ESS feed

To get ESS file up on the web. Here are the steps: 1. Name your RSS file. Notice that the file should have an .xml or a .ess extension: ESS generator.

2. Validate ESS file: ESS validator.

3. Upload ESS file to your web directory on your web server.

4. Copy the little orange icon icon ess to your web directory.

5. Put the little blue "ESS" or "XML" button on the page where you will offer ESS to the world (e.g. on your home page). Then add a link to the button that links to the ESS file.

6. Submit your RSS feed to the RSS Feed Directories. Note! The URL to your feed is not your home page, it is the URL to your feed, like "http://www.example.org/feed/myfirstess.ess". Here are some free ESS aggregation services: ESS Aggregators.

7. Register your feed with the major search engines:

  1. Google - http://www.google.com/ig (Google's personalized homepage. Google will index any ESS feed added here)
  2. Bing - http://www.bing.com/webmaster/SubmitSitePage.aspx
  3. Yahoo - http://publisher.yahoo.com/rss_guide/submit.php


or Feed agregators:

  1. Hypecal
    1. XML Result http://api.hypecal.com/v1/ess/aggregator.json?feed=http://sample.com/feeds/events.ess&method=xml
    2. JSON Result http://api.hypecal.com/v1/ess/aggregator.json?feed=http://sample.com/feeds/events.ess&method=json

8. Update your feed - Now you have registered your ESS feed with Google, Yahoo, and MSN. Now you must make sure that you update your content frequently and that your ESS feed is constantly available.



Update ESS Feed

The best way to ensure your ESS feed works the way you want, is to manage it yourself.
However, this can be very time consuming, especially for pages with lot of updates.
An alternative is to use a third-party automated ESS:


ESS Multi-language libraries


https://github.com/essfeed
  • ESS Library available for PHP
  • ESS Library available for JAVA
  • ESS Library available for JavaScript
  • ESS Library available for AS3
  • ESS Library available for Ruby On Rail
  • ESS Library available for Python


Code configuration

When ESS is correctly configured as file extension in the server, it is possible to generate ESS feeds and display them within websites. Third party libraries can help programers to create ESS feeds.


<?php
   include("libraries/EssObject.php");
 
   $ess = new EssObject();
   $ess->title = "Event title name";
   $ess->subtitle = "sub title text."
   $ess->places(0)->adress = "646, 5th ave / 49 E";
   $ess->places(0)->city = "New York";
   ...
 
   header("Content-Type: application/ess+xml");
   $ess->output();
?>

   import ess.org.libraries.EssObject;
 
   String ess = new EssObject();
   ess.title = "Event title name";
   ess.subtitle = "sub title text."
   ess.places(0).adress = "646, 5th ave / 49 E";
   ess.places(0).city = "New York";
   ...
 
   response.setContentType("application/ess+xml");
   ess.output();




Discussions

ESS Forum Discussion > General

Could not find wordpress article with a title like home






External documentation

Ietf logo.png

ESS standard under RFC validation process: RFC ESS Draft

IF EVENTS MATTER TO YOU

Spread the news about ESS
Personal tools
Actions
Standard


Developers


Communication