Commits

Anonymous committed c6256f2

updated docs and setup.py

  • Participants
  • Parent commits dce7e4b

Comments (0)

Files changed (3)

 MOAI Changes
 ============
 
-MOAI 2.0.0 (2012-12-19)
+MOAI 2.0.0 (2013-02-28)
 -----------------------
 
 - First public release in the 2.x series, switched to mod_wsgi, 
 
 The app:moai_example configuration let's you specify the following options:
 
-name:              The name of the oai feed (returned in Identify verb)
-url:               The url of the oai feed (returned in oaipmh xml output)
-admin_email:       The email adress of the amdin  (returned in Identify verb)
-
-formats:           Available metadata formats
-disallow_sets:     List of setspecs that are not allowed in the output of this
-                   feed
-allow_sets:        If used, only sets listed here will be returned
-
-database:          SQLAlchemy uri to identify the database for used for storage
-provider:          Provider identifier where moai retrieves content from
-content:           Class that maps metadata from provider format to moai format
+name
+  The name of the oai feed (returned in Identify verb)
+url
+  The url of the oai feed (returned in oaipmh xml output)
+admin_email
+  The email adress of the amdin  (returned in Identify verb)
+formats
+  Available metadata formats
+disallow_sets
+  List of setspecs that are not allowed in the output of this feed
+allow_sets
+  If used, only sets listed here will be returned
+database
+  SQLAlchemy uri to identify the database for used for storage
+provider
+  Provider identifier where moai retrieves content from
+content
+  Class that maps metadata from provider format to moai format
 
 Adding Content
 ==============
 
 In the settings.ini file, the following option is specified:
 
-provider = file://moai/example-*.xml
+`provider = file://moai/example-*.xml`
 
-This tells moai that we want to use a file provider, with some files located in moai/example-*.xml. 
+This tells moai that we want to use a file provider, with some files located in
+`moai/example-*.xml`. 
 
 The following option points to the class that we want to use for converting the example content xml data to Moais internal format.
 
 
 'title', 'creator', 'subject', 'description', 'publisher', 'contributor', 'type', 'format', 'identifier', 'source', 'language', 'date', 'relation', 'coverage', 'rights
 
-So a return value would look like:
+So a return value would look like::
 
     {'id': <oai record id>,
      'deleted': <bool>,
     version='2.0.0',
     author='Infrae',
     author_email='info@infrae.com',
-    url='http://moai.infrae.com',
+    url='http://infrae.com/products/moai',
     description="MOAI, A Open Access Server Platform for Institutional Repositories",
-    long_description=(open(join(dirname(__file__), 'README.txt')).read()+
+    long_description=(open(join(dirname(__file__), 'ABOUT.txt')).read()+
+                      '\n'+
+                      open(join(dirname(__file__), 'README.txt')).read()+
                       '\n'+
                       open(join(dirname(__file__), 'HISTORY.txt')).read()),
     classifiers=["Development Status :: 5 - Production/Stable",