Skip to content
Browse files

updated description of main and sub-projects, some clean-up

  • Loading branch information...
1 parent 72ee121 commit 040912eb19e449d7aa5385a4c84ad7a2daae63a2 mhausenblas committed Jun 17, 2011
Showing with 85 additions and 31 deletions.
  1. +39 −24 README.md
  2. +3 −3 examples/README.md
  3. +4 −4 mappings/README.md
  4. +28 −0 scrapers/README.md
  5. +11 −0 tools/schema-gateway/README.md
View
63 README.md
@@ -1,40 +1,55 @@
-# Schema.org in RDF
+# Schema.RDFS.org
-This is a project to provide an RDF(S) version of Schema.org including tools to benefit from data that uses Schema.org terms.
+This is a project to provide an RDF(S) version of Schema.org terms, including tools, examples and mappings to benefit from data that uses Schema.org terms. Currently, we have the following sub-projects (in descending order of maturity):
+* Generating variants
+* Schema.org gateway
+* Examples
+* Mappings
-## Who is behind this?
-
-The EC FP7 LOD-Around-The-Clock Support Action (<a href="http://latc-project.eu/">LATC</a>) and people from the Linked Data Research Centre, [DERI](http://www.deri.ie).
+## Sub-projects
-## License
+Over time, a number of sub-projects of Schema.RDFS.org emerged, introduced in the following. Have a look at the respective directories for more details.
-This software is Public Domain.
+### Generating variants
+[This](https://github.com/mhausenblas/schema-org-rdf/tree/master/scrapers) Schema.RDFS.org sub-project deals with generating structured representations for Schema.org terms through the natural language definition found in Schema.org.
+### Schema.org gateway
-## Generating the RDF and other versions
+[This](https://github.com/mhausenblas/schema-org-rdf/tree/master/tools/schema-gateway) Schema.RDFS.org sub-projec develops the Schema.org gateway, a anything-to-anything data format converter, based on the [Lingua Franca](http://c2.com/cgi/wiki?LinguaFrancaPattern "Lingua Franca Pattern") pattern.
-Run the following Python scripts in the `scrapers` directory:
+### Examples
- scrape_rdf.py
- scrape_json.py
- scrape_csv.py
+[This](https://github.com/mhausenblas/schema-org-rdf/tree/master/examples) Schema.RDFS.org sub-project collects Schema.org examples in all kinds of markup and data formats, incl. RDFa, CSV, JSON etc.
-They either write to STDOUT or to a filename taken as command line argument.
+### Mappings
-There is also a script that generates all formats, does a bit of sanity checking to see if it worked, and copies them to a target directory.
+[This](https://github.com/mhausenblas/schema-org-rdf/tree/master/mappings) Schema.RDFS.org sub-project collects mappings to Schema.org terms from widely deployed Linked Data vocabularies such as Dublin Core, FOAF, GoodRelations, SIOC, DBpedia ontology, etc.
- cd scrapers
- ./run.rb temp-directory target-directory
+## Who is behind this?
-This requires the [any23](http://developers.any23.org/) command line tool on the path.
+Led by [Michael](http://sw-app.org/mic.xhtml#i) and [Richard](http://richard.cyganiak.de/foaf.rdf#cygri) of the Linked Data Research Centre, [DERI](http://www.deri.ie) the Schema.RDFS.org project is officially endorsed and supported by the EC FP7 LOD-Around-The-Clock Support Action (<a href="http://latc-project.eu/">LATC</a>). Many people from the Linked Data domain, Web of Data domain and other communities (SEO, library, archives, etc.) are contributing and have been delivering valuable input.
+If you have any questions, please do not hesitate to ask Michael, either via [michael.hausenblas AT gmail.com](mailto:&#x6D;&#x69;&#x63;&#x68;&#x61;&#x65;&#x6C;&#x2E;&#x68;&#x61;&#x75;&#x73;&#x65;&#x6E;&#x62;&#x6C;&#x61;&#x73;&#x40;&#x67;&#x6D;&#x61;&#x69;&#x6C;&#x2E;&#x63;&#x6F;&#x6D;) or via Twitter where he listens to [@mhausenblas](http://twitter.com/mhausenblas/) or drop by at the [#swig](http://chatlogs.planetrdf.com/swig/) channel on Freenode/IRC.
-## Roadmap/Ideas
+## License
-* multi-lang labels/comments
-* mappings to well-known legacy terms
-* get the community involved and give them a sense of ownership
-** feedback on a Wiki?
-** mappings/multi-lang suggestions into a Google spreadsheet?
-* Produce RDFa markup examples, similar to the microdata ones on schema.org
+The software and artefacts (such as examples, mappings, etc.) provided through the Schema.RDFS.org project are, if not otherwise stated, in the Public Domain.
+
+## Roadmap and Ideas
+
+* Community
+ * get communities involved and give them a sense of ownership (ML, Twitter, here, etc.)
+ * feedback on a Wiki, issue tracker, etc. (?)
+* Generating variants
+ * multi-lang labels/comments
+ * mappings to well-known legacy terms
+* Schema.org gateway
+ * http://bibutils.refbase.org/ extensions and collaboration
+* Examples
+ * collect
+ * create based on existing examples
+* Mappings
+ ** multi-lang suggestions into a Google spreadsheet?
+ * Alexandre will provide SIOC mapping, hosted directly here
+ * ask vocab stake-holders to provide pointers to their mapping (Michael: DBpedia, FOAF, DC, GR, Richard: the rest ;)
View
6 examples/README.md
@@ -1,18 +1,18 @@
# What is this space for?
This space is for collecting Schema.org examples. You're encouraged to provide all kinds of markup and data formats, incl. RDFa, CSV, JSON etc.
-# Are there IPR and license issues?
+## Are there IPR and license issues?
We understand that whoever contributes here, in the `examples/*` folder, agrees to put the provided example into the Public Domain.
-# Where should I put my stuff?
+## Where should I put my stuff?
Into the respective `{dataformat}` folder, such as:
Thing
|_ RDFa
|_ CSV
|_ JSON
-# Whom can I ask if I dunno what or how to do it
+## Whom can I ask if I dunno what or how to do it
Ask Michael. Either via [michael.hausenblas AT gmail.com](mailto:&#x6D;&#x69;&#x63;&#x68;&#x61;&#x65;&#x6C;&#x2E;&#x68;&#x61;&#x75;&#x73;&#x65;&#x6E;&#x62;&#x6C;&#x61;&#x73;&#x40;&#x67;&#x6D;&#x61;&#x69;&#x6C;&#x2E;&#x63;&#x6F;&#x6D;) or via Twitter where he listens to [@mhausenblas](http://twitter.com/mhausenblas/) or drop by at the [#swig](http://chatlogs.planetrdf.com/swig/) channel on Freenode/IRC.
View
8 mappings/README.md
@@ -1,10 +1,10 @@
# What is this space for?
-This space is for collecting mappings to Schema.org terms from widely deployed Linked Data vocabularies, such as [in preparation](http://mappings.dbpedia.org/) by DBpedia, to be expected for top-level vocabularies such as [Dublin Core](http://dublincore.org/) or [FOAF](http://www.foaf-project.org/) or via 3rd party providers such as [schemapedia.com](http://schemapedia.com/).
+This space is for collecting mappings to Schema.org terms from widely deployed Linked Data vocabularies, such as [in preparation](http://mappings.dbpedia.org/) by DBpedia, to be expected for top-level vocabularies such as [Dublin Core](http://dublincore.org/), [FOAF](http://www.foaf-project.org/), [GoodRelations](http://purl.org/goodrelations/), and [SIOC](http://sioc-project.org/) or that come from 3rd party providers such as [schemapedia.com](http://schemapedia.com/).
-# Are there IPR and license issues?
-We understand that whoever contributes here, in the `mappings/*` folder, agrees to put the provided example into the Public Domain.
+## Are there IPR and license issues?
+We understand that whoever contributes here, in the `mappings/*` folder, agrees to put the provided example into the Public Domain. If you simply provide a link to your mapping, of course, your respective IPR apply.
-# Whom can I ask if I dunno what or how to do it
+## Whom can I ask if I dunno what or how to do it
Ask Michael. Either via [michael.hausenblas AT gmail.com](mailto:&#x6D;&#x69;&#x63;&#x68;&#x61;&#x65;&#x6C;&#x2E;&#x68;&#x61;&#x75;&#x73;&#x65;&#x6E;&#x62;&#x6C;&#x61;&#x73;&#x40;&#x67;&#x6D;&#x61;&#x69;&#x6C;&#x2E;&#x63;&#x6F;&#x6D;) or via Twitter where he listens to [@mhausenblas](http://twitter.com/mhausenblas/) or drop by at the [#swig](http://chatlogs.planetrdf.com/swig/) channel on Freenode/IRC.
View
28 scrapers/README.md
@@ -0,0 +1,28 @@
+# What is this space for?
+This space is contains the scripts for generating structured representations of Schema.org terms.
+
+In order to generate variants (that is RDF, JSON or CSV versions) of the Schema.org terms, run the following Python scripts in the `scrapers` directory:
+
+ scrape_rdf.py
+ scrape_json.py
+ scrape_csv.py
+
+They either write to STDOUT or to a filename taken as command line argument.
+
+There is also a script that generates all formats, does a bit of sanity checking to see if it worked, and copies them to a target directory.
+
+ cd scrapers
+ ./run.rb temp-directory target-directory
+
+This requires the [any23](http://developers.any23.org/) command line tool on the path.
+
+
+
+## License
+
+This software is Public Domain.
+
+## Whom can I ask if I dunno what or how to do it
+Ask Richard via Twitter [@cygri](http://twitter.com/cygri).
+
+
View
11 tools/schema-gateway/README.md
@@ -0,0 +1,11 @@
+# What is this space for?
+This space is developing the Schema.org gateway, a anything-to-anything data format converter, based on the [Lingua Franca](http://c2.com/cgi/wiki?LinguaFrancaPattern "Lingua Franca Pattern") pattern. Conceptually, the gateway takes whatever kind of data format that uses [Schema.org](http://schema.org) terms, turns it internally into RDF and then outputs any other kind of target data format.
+
+## License
+
+This software is Public Domain.
+
+## Whom can I ask if I dunno what or how to do it
+Ask Michael. Either via [michael.hausenblas AT gmail.com](mailto:&#x6D;&#x69;&#x63;&#x68;&#x61;&#x65;&#x6C;&#x2E;&#x68;&#x61;&#x75;&#x73;&#x65;&#x6E;&#x62;&#x6C;&#x61;&#x73;&#x40;&#x67;&#x6D;&#x61;&#x69;&#x6C;&#x2E;&#x63;&#x6F;&#x6D;) or via Twitter where he listens to [@mhausenblas](http://twitter.com/mhausenblas/) or drop by at the [#swig](http://chatlogs.planetrdf.com/swig/) channel on Freenode/IRC.
+
+

0 comments on commit 040912e

Please sign in to comment.
Something went wrong with that request. Please try again.