README in rdf-microdata-0.2.2 vs README in rdf-microdata-0.2.3
- old
+ new
@@ -4,87 +4,62 @@
## DESCRIPTION
RDF::Microdata is a Microdata reader for Ruby using the [RDF.rb][RDF.rb] library suite.
## FEATURES
-RDF::Microdata parses [Microdata][] into statements or triples.
+RDF::Microdata parses [Microdata][] into statements or triples using the rules defined in [Microdata RDF][].
* Microdata parser.
-* Uses Nokogiri for parsing HTML
+* If available, Uses Nokogiri for parsing HTML/SVG, falls back to REXML otherwise (and for JRuby)
Install with 'gem install rdf-microdata'
+### Living implementation
+Microdata to RDF transformation is undergoing active development. This implementation attempts to be up-to-date
+as of the time of release, and is being used in developing the [Microdata RDF][] specification
+
+### Microdata Registry
+The parser uses a build-in version of the [Microdata RDF][] registry.
+
## Usage
### Reading RDF data in the Microdata format
graph = RDF::Graph.load("etc/foaf.html", :format => :microdata)
## Note
-The Microdata editor has recently [dropped support for RDF
-conversion](http://html5.org/tools/web-apps-tracker?from=6426&to=6427), as a result, this gem is being used to
-investigate ways in which Microdata might have more satisfactory RDF generation.
-
-### Generating RDF friendly URIs from terms
-If the `@itemprop` is included within an item having an `@itemtype`,
-the URI of the `@itemtype` will be used for generating a term URI. The type URI will be trimmed following
-the last '#' or '/' character, and the term will be appended to the resulting URI. This is in keeping
-with standard convention for defining properties and classes within an RDFS or OWL vocabulary.
-
-For example:
-
- <div itemscope itemtype="http://schema.org/Person">
- My name is <span itemprop="name">Gregg</span>
- </div>
-
-Without the `:rdf\_terms` option, this would create the following statements:
-
- @prefix md: <http://www.w3.org/1999/xhtml/microdata#> .
- @prefix schema: <http://schema.org/> .
- <> md:item [
- a schema:Person;
- <http://www.w3.org/1999/xhtml/microdata#http://schema.org/Person%23:name> "Gregg"
- ] .
-
-With the `:rdf\_terms` option, this becomes:
-
- @prefix md: <http://www.w3.org/1999/xhtml/microdata#> .
- @prefix schema: <http://schema.org/> .
- <> md:item [ a schema:Person; schema:name "Gregg" ] .
-
-### Improve xsd:date, xsd:time, xsd:dateTime and xsd:duration generation from _time_ element
-
-Use the lexical form of the @datetime attribute of the _time_ element to determine the specific type
-of the generated literal.
-
-### Remove implicit RDF triple generation
-
-html>head>title and anchor (_a_) elements no longer generate triples without @item* properties
-
+This spec is based on the W3C HTML Data Task Force specification and does not support
+GRDDL-type triple generation, such as for html>head>title and <a>
+
## Dependencies
* [RDF.rb](http://rubygems.org/gems/rdf) (>= 0.3.4)
-* [Nokogiri](http://rubygems.org/gems/nokogiri) (>= 1.3.3)
+* [RDF::XSD](http://rubygems.org/gems/rdf-xsd) (>= 0.3.4)
+* [HTMLEntities](https://rubygems.org/gems/htmlentities) ('>= 4.3.0')
+* Soft dependency on [Nokogiri](http://rubygems.org/gems/nokogiri) (>= 1.5.0)
## Documentation
Full documentation available on [Rubydoc.info][Microdata doc]
### Principle Classes
* {RDF::Microdata::Format}
Asserts :html format, text/html mime-type and .html file extension.
* {RDF::Microdata::Reader}
+ * {RDF::Microdata::Reader::Nokogiri}
+ * {RDF::Microdata::Reader::REXML}
### Additional vocabularies
## TODO
* Add support for LibXML and REXML bindings, and use the best available
* Consider a SAX-based parser for improved performance
## Resources
* [RDF.rb][RDF.rb]
* [Documentation](http://rdf.rubyforge.org/microdata)
-* [History](file:file.History.html)
+* [History](file:History.md)
* [Microdata][]
+* [Microdata RDF][]
## Author
* [Gregg Kellogg](http://github.com/gkellogg) - <http://kellogg-assoc.com/>
## Contributing
@@ -115,7 +90,8 @@
[RDF.rb]: http://rdf.rubyforge.org/
[YARD]: http://yardoc.org/
[YARD-GS]: http://rubydoc.info/docs/yard/file/docs/GettingStarted.md
[PDD]: http://lists.w3.org/Archives/Public/public-rdf-ruby/2010May/0013.html
-[Microdata]: http://www.w3.org/TR/2011/WD-microdata-20110525/ "HTML Microdata"
+[Microdata]: http://dev.w3.org/html5/md/Overview.html "HTML Microdata"
+[Microdata RDF]: https://dvcs.w3.org/hg/htmldata/raw-file/default/microdata-rdf/index.html "Microdata to RDF"
[Microdata doc]: http://rubydoc.info/github/gkellogg/rdf-microdata/frames