From f9dcec12986041397596edafea7c6d5264c39c8f Mon Sep 17 00:00:00 2001 From: nruest Date: Mon, 24 Mar 2014 16:16:07 -0400 Subject: [PATCH] README normalization --- README.md | 90 ++++++++++++++++++++++++------------------------------- 1 file changed, 39 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 90d935cf..4933356c 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,69 @@ -BUILD STATUS ------------- -Current build status: -[![Build Status](https://travis-ci.org/Islandora/islandora.png?branch=7.x)](https://travis-ci.org/Islandora/islandora) +# Islandora [![Build Status](https://travis-ci.org/Islandora/islandora.png?branch=7.x)](https://travis-ci.org/Islandora/islandora) -CI Server: -http://jenkins.discoverygarden.ca - -SUMMARY -------- +## Introduction Islandora Fedora Repository Module -For installation and customization instructions please see the documentation -and the DuraSpace Wiki: +For installation and customization instructions please see the [documentation and the DuraSpace Wiki](https://wiki.duraspace.org/display/ISLANDORA/Islandora). + +All bugs, feature requests and improvement suggestions are tracked at the [DuraSpace JIRA](https://jira.duraspace.org/browse/ISLANDORA). + -https://wiki.duraspace.org/display/ISLANDORA/Islandora +## Requirements -All bugs, feature requests and improvement suggestions are tracked at the -DuraSpace JIRA: +This module requires the following modules/libraries: -https://jira.duraspace.org/browse/ISLANDORA +* [Tuque](https://github.com/islandora/tuque) -REQUIREMENTS ------------- -The Tuque library must be installed to use Islandora. It can be found here: -http://github.com/Islandora/tuque -It is expected to be in one of two paths: - - sites/all/libraries/tuque (libraries directory may need to be created) - - islandora_folder/libraries/tuque +Tuque is expected to be in one of two paths: -OPTIONAL REQUIREMENTS ---------------------- +* sites/all/libraries/tuque (libraries directory may need to be created) +* islandora_folder/libraries/tuque -If you want to support languages other than English download and enable -[String Translation](https://drupal.org/project/i18n), And follow our -[guide](wiki/Multilingual-Support) for setting up additional languges. +More detailed requirements are outlined in the [Installing the Islandora Module](https://wiki.duraspace.org/display/ISLANDORA712/Installing+the+Islandora+Module) chapter of the documentation. +### Optional Requirements -INSTALLATION ------------- +If you want to support languages other than English download and enable [String Translation](https://drupal.org/project/i18n), and follow our [guide](wiki/Multilingual-Support) for setting up additional languges. -Before installing Islandora the XACML policies located in the policies folder -should be copied into the Fedora global XACML policies folder. This will allow -"authenticated users" in Drupal to access Fedora API-M functions. +## Installation + +Before installing Islandora the XACML policies located in the policies folder should be copied into the Fedora global XACML policies folder. This will allow "authenticated users" in Drupal to access Fedora API-M functions. It is to be noted that the `permit-upload-to-anonymous-user.xml` and `permit-apim-to-anonymous-user.xml` files do not need to be present unless requirements for anonymous ingesting are present. You will also have to remove some default policies if you want full functionality as well. Remove deny-purge-datastream-if-active-or-inactive.xml to allow for purging of datastream versions. -CONFIGURATION -------------- +More detailed information can be found in the 'Set XACML Policies' in the [Installing Fedora](https://wiki.duraspace.org/display/ISLANDORA712/Installing+Fedora) chapter of the documentation. + +## Configuration -The islandora_drupal_filter passes the username of 'anonymous' through to -Fedora for unauthenticated Drupal Users. A user with the name of 'anonymous' -may have XACML policies applied to them that are meant to be applied to Drupal -users that are not logged in or vice-versa. This is a potential security issue -that can be plugged by creating a user named 'anonymous' and restricting access -to the account. +The islandora_drupal_filter passes the username of 'anonymous' through to Fedora for unauthenticated Drupal Users. A user with the name of 'anonymous' may have XACML policies applied to them that are meant to be applied to Drupal users that are not logged in or vice-versa. This is a potential security issue that can be plugged by creating a user named 'anonymous' and restricting access to the account. -Drupal's cron will can be ran to remove expired authentication tokens. +Drupal's cron can be run to remove expired authentication tokens. -CUSTOMIZATION -------------- +### Customization [Customize ingest forms](http://github.com/Islandora/islandora/wiki/Multi-paged-Ingest-Forms) -TROUBLESHOOTING ---------------- +## Troubleshooting/Issues + +Having problems or solved a problem? Check out the Islandora google groups for a solution. + +* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora) +* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev) + +## Maintainers/Sponsors + +Current maintainers: +* [Nick Ruest](https://github.com/ruebot) -F.A.Q. ------- +## Development +If you would like to contribute to this module, please check out our helpful [Documentation for Developers](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers) info, as well as our [Developers](http://islandora.ca/developers) section on the Islandora.ca site. -CONTACT -------- +## License +[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) -SPONSORS ---------