Permalink
Browse files

Added an .md version of the read me file

  • Loading branch information...
1 parent 3ec7cb0 commit 780c7cb4b1d76ec0534abdec998ea5d0dfa0fb1c @iherman iherman committed Aug 14, 2013
Showing with 98 additions and 21 deletions.
  1. +68 −0 README.md
  2. +30 −21 README.txt
View
@@ -0,0 +1,68 @@
+PyRDFA
+======
+
+# WARNING: DEPRECATED Package
+
+New users should not use this package for RDFa 1.1 processing. RDFa parsing has
+been added to the latest release of the core RDFLib package as a parser, using the same
+code as in this package. For most users this package is of a historical interest only,
+except for those who have incorporated this version as part of their application workflow
+and do not want to change the full workflow.
+
+Bugs in processing RDFa 1.1 will be taken care of both in this package and in the
+version in RDFLib. Possible radical changes in the form of new functionalities may
+be incorporated in the RDFLib version only.
+
+2013-08-13
+
+
+Usage Warning
+-------------
+
+Warning (2013-07-16): the latest version of the html5lib package has a bug.
+This bug manifests itself if the source HTML file contains non-ASCII Unicode characters
+Until the bug is handled, users should use the older, 0.95 version. It can be downloaded
+at <https://code.google.com/p/html5lib/downloads/detail?name=html5lib-0.95.tar.gz>
+
+What is it
+----------
+
+pyRdfa distiller/parser library. The distribution contains:
+
+- ./pyRdfa: the Python library. You should copy the directory
+ somewhere into your PYTHONPATH. Alternatively, you can also run the
+
+ `python setup.py install`
+
+ script in the directory.
+
+- ./scripts/CGI_RDFa.py: can be used as a CGI script to invoke the library.
+ It has to be adapted to the local server setup, namely in setting the right paths
+
+- ./scripts/localRdfa.py: script that can be run locally on to transform
+ a file into RDF (on the standard output). Run the script with "-h" to
+ get the available flags.
+
+- ./Doc-pyRdfa: (epydoc) documentation of the classes and functions
+
+- ./Additional_Packages: some additional packages that are necessary for the library; added here for an easier distribution.
+Each of those libraries must be installed separately. Exception is RDFLib that should be installed directly from the server
+
+The package primarily depends on:
+ - RDFLib: <http://rdflib.net>. Version 3.2.0 or higher is strongly recommended.
+ - html5lib: <https://github.com/html5lib/html5lib-python>
+ - simplejson: <http://undefined.org/python/#simplejson> (in the additional packages folder), needed if the JSON serialization is used and if the underlying python version is 2.5 or lower
+ - isodate: <http://hg.proclos.com/isodate> (in the additional packages folder) which, in some cases, is missing and RDFLib complains (?)
+
+The package has been tested on Python version 2.5 and higher. Python 2.6 or higher is strongly recommended. The package has been adapted to Python 3, though not yet thoroughly tested, because the html5lib does not have yet a Python 3 version.
+
+For the details on RDFa 1.1, see:
+
+- <http://www.w3.org/TR/rdfa-core>
+- <http://www.w3.org/TR/rdfa-lite/>
+- <http://www.w3.org/TR/xhtml-rdfa/>
+- <http://www.w3.org/TR/rdfa-in-html/>
+
+possibly:
+
+- <http://www.w3.org/TR/rdfa-primer/>
View
@@ -1,25 +1,34 @@
+pyRDFA
+======
-***********************************************************************************
-* New users should not use this package for RDFa 1.1 processing. RDFa parsing has
-* been added to the latest release of the core RDFLib package as a parser, using the same
-* code as in this package. For most users this package is of a historical interest only,
-* except for those who have incorporated this version as part of their application workflow
-* and do not want to change the full workflow.
-*
-* Bugs in processing RDFa 1.1 will be taken care of both in this package and in the
-* version in RDFLib. Possible radical changes in the form of new functionalities may
-* be incorporated in the RDFLib version only.
-*
-* 2013-08-13
-***********************************************************************************
-
-
-***
-*** Warning (2013-07-16): the latest version of the html5lib package has a bug.
-*** This bug manifests itself if the source HTML file contains non-ASCII Unicode characters
-*** Until the bug is handled, users should use the older, 0.95 version. It can be downloaded
-*** at https://code.google.com/p/html5lib/downloads/detail?name=html5lib-0.95.tar.gz
-***
+Warnings
+--------
+
+# WARNING: DEPRECATED Package
+
+New users should not use this package for RDFa 1.1 processing. RDFa parsing has
+been added to the latest release of the core RDFLib package as a parser, using the same
+code as in this package. For most users this package is of a historical interest only,
+except for those who have incorporated this version as part of their application workflow
+and do not want to change the full workflow.
+
+Bugs in processing RDFa 1.1 will be taken care of both in this package and in the
+version in RDFLib. Possible radical changes in the form of new functionalities may
+be incorporated in the RDFLib version only.
+
+2013-08-13
+
+
+## Usage Warning
+
+
+Warning (2013-07-16): the latest version of the html5lib package has a bug.
+This bug manifests itself if the source HTML file contains non-ASCII Unicode characters
+Until the bug is handled, users should use the older, 0.95 version. It can be downloaded
+at <https://code.google.com/p/html5lib/downloads/detail?name=html5lib-0.95.tar.gz>
+
+What is it
+----------
pyRdfa distiller/parser library. The distribution contains:

0 comments on commit 780c7cb

Please sign in to comment.