diff --git a/README.md b/README.md new file mode 100644 index 0000000..65a6e36 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +rome +==== + +ROME is a set of RSS and Atom Utilities for Java. It makes it easy to work in Java with most syndication formats: RSS 0.90, RSS 0.91 Netscape, RSS 0.91 Userland, RSS 0.92, RSS 0.93, RSS 0.94, RSS 1.0, RSS 2.0, Atom 0.3, Atom 1.0 + +More Information: http://rometools.github.io/rome-opml/ diff --git a/pom.xml b/pom.xml index b75e5bf..ae38037 100644 --- a/pom.xml +++ b/pom.xml @@ -7,11 +7,20 @@ jar 1.5-SNAPSHOT rome-opml - http://rometools.jira.com + http://rometools.github.io/rome-opml/ Support for OPML 1 and OPML 2 in ROME + + ROME Project + https://github.com/rometools/ + - https://rometools.jira.com/secure/IssueNavigator.jspa + https://github.com/rometools/rome-opml/issues + + scm:git:git@github.com:rometools/rome-opml.git + scm:git:git@github.com:rometools/rome-opml.git + https://github.com/rometools/rome-opml/ + kebernet @@ -26,11 +35,6 @@ repo - - scm:svn:https://rometools.jira.com/svn/MODULES/trunk - scm:svn:https://rometools.jira.com/svn/MODULES/trunk - https://rometools.jira.com/source/browse/MODULES - maven2-repository.dev.java.net @@ -74,11 +78,30 @@ org.apache.maven.plugins maven-resources-plugin - 2.2 + 2.6 ${project.build.sourceEncoding} + + org.apache.maven.plugins + maven-site-plugin + 3.3 + + 9000 + ${basedir}/target/site/tempdir + + + + org.apache.maven.plugins + maven-scm-publish-plugin + 1.0-beta-2 + + gh-pages + scm:git:git@github.com:rometools/rome-opml.git + ${project.build.directory}/site + + @@ -148,4 +171,33 @@ UTF-8 + + + + org.apache.maven.plugins + maven-project-info-reports-plugin + 2.6 + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9 + + + + javadoc + test-javadoc + + + + aggregate + false + + aggregate + + + + + + diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt new file mode 100644 index 0000000..0e7e427 --- /dev/null +++ b/src/site/apt/index.apt @@ -0,0 +1,125 @@ + ----- + Home + ----- + kwebble + ----- + 2011-09-23 14:15:28.442 + ----- + +ROME OPML + + This project provides support for {{{http://www.opml.org/}OPML}} in ROME. + +*Downloads + + * {{{./apidocs/index.html}JavaDocs}} + + [] + +*Sample Usage + + To use this parser, simply include the jar file in your classpath as you are using ROME. Be sure it exists at the same level as ROME, + such that, if ROME is in the common classpath of an application server, don't include this jar in your webapps WEB\-INF/lib. + ++------+ +WireFeedInput input = new WireFeedInput(); + Opml feed = (Opml) input.build( new File("myOpml.xml") ); + List outlines = (List) feed.getOutlines(); ++------+ + +*Hierarchy vs Flat + + Since OPML is a hierarchical format, some magic is required to preserve this information when they feed is moved to a Synd\* structure. + This is accomplished by adding categories indicating the tree structure to the {{{http://wiki.java.net/bin/edit/Javawsxml/SyndEntries?topicparent\=Javawsxml.OPML;nowysiwyg\=0}SyndEntries}} ... + + For example: + ++------+ + + + Top Ten Sources for podcasting + Newsilike Media Group + opml@TopTenSources.com + + + + + + + + + + + + + + + + + + + + ++------+ + + ...\ + When converted to RSS2 becomes: + ++------+ + + Top Ten Sources for podcasting + http://foo.com + + Newsilike Media Group + + TopTenSources: podcasting + http://podcasting.TopTenSources.com/TopTenSources/ + node.-1732517202 + http://podcasting.TopTenSources.com/TopTenSources/ + http://podcasting.TopTenSources.com/TopTenSources/ + + + CBS Technology News Podcast - Larry Magid' Tech Report + node.1353657827 + + + Larry Magid's Tech Report + http://www.cbsnews.com + node.-4085850 + parent.1353657827 + http://www.cbsnews.com + http://www.cbsnews.com + + + Adam Curry: Daily Source Code + node.835791399 + + + #374 Daily Source Code for Tuesday April 25th 2006 + http://radio.weblogs.com/0001014/2006/04/26.html#a7304 + node.222050897 + parent.835791399 + http://radio.weblogs.com/0001014/2006/04/26.html#a7304 + http://radio.weblogs.com/0001014/2006/04/26.html#a7304 + + + #373 Daily Source Code for Monday April 24th 2006 + http://radio.weblogs.com/0001014/2006/04/24.html#a7303 + node.2088220478 + parent.835791399 + http://radio.weblogs.com/0001014/2006/04/24.html#a7303 + http://radio.weblogs.com/0001014/2006/04/24.html#a7303 + ++------+ + + Nodes get categories with the "urn:rome.tree" URI that is used to maintain the tree structure. + + The other thing you will notice is the "urn:rome.attribute#url". Since OPML allows you to add arbitrary attributes to each outline element, these are used to preserve these values. + + \ No newline at end of file diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css new file mode 100644 index 0000000..43c3cd8 --- /dev/null +++ b/src/site/resources/css/site.css @@ -0,0 +1,8 @@ +h1 { + padding: 4px 4px 4px 6px; + border: 1px solid #999; + color: #900; + background-color: #ddd; + font-weight:900; + font-size: x-large; +} \ No newline at end of file diff --git a/src/site/resources/images/romelogo.png b/src/site/resources/images/romelogo.png new file mode 100644 index 0000000..2c90608 Binary files /dev/null and b/src/site/resources/images/romelogo.png differ diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000..23c4366 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,19 @@ + + + + ROME + images/romelogo.png + http://github.com/ + + + + + + + + + +