Commit 497dea1a authored by Mark Jordan's avatar Mark Jordan
Browse files

Updated README.md.

parent 5be05fd9
......@@ -48,9 +48,10 @@ All configuration for this module is performed via .ini files.
Sample .ini file:
```
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; File paths, logging options, etc. ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; File paths, logging options, etc. ;
; You may not need to use any of the options in this section. ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
[SYSTEM]
; Directory where the Scholars' Lab BagIt for PHP library is installed,
......@@ -67,9 +68,10 @@ Sample .ini file:
; the Drush command.
; temp_dir = /special/temporary/directory
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Options for the BagIt directory or file. ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Options for the BagIt directory or file. ;
; You will likely want to define some options in this section. ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
[BAG-OUTPUT]
; Defaults to 'islandora_bagit_light_output' within the directory
......@@ -94,9 +96,10 @@ bag_name_prefix = 'islandora_object_bag-'
; is false.
; delete_unserialized_bag = false
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Entries in this section are added to the bag-info.txt file. ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; Entries in this section are added to the bag-info.txt file. ;
; You will likely want to define some options in this section. ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
[BAG-INFO]
; Dynamically generated entries like Bagging-Date and Payload-Oxum take a true/false value.
......@@ -120,14 +123,14 @@ This module provides a Drush command to assign DOIs to a list of objects identif
```
islandora:23
islandora:29
// Comments can be prefixed by // or #.
islandora:107
// Comments can be prefixed by // or #.
islandora:2183
```
## Bundled submodules
### Extending and customizing the BagIt module
### Extending and customizing the Islandora BagIt Light module
Hooks are documented in islandora_bagit_light.api.php.
......@@ -142,10 +145,7 @@ This module is intended for users who have a fairly high level of permissions on
## 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)
If you are having a problem with this module, please open an issue in its Github repo.
## Maintainers
......@@ -153,7 +153,7 @@ Having problems or solved a problem? Check out the Islandora google groups for a
## Development
If you would like to contribute to this module, please check out [CONTRIBUTING.md](CONTRIBUTING.md). In addition, we have 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](http://islandora.ca) site.
Pull requests against this module are welcome, as are submodules. Please open an issue in this module's Github repo before opening a pull request.
## License
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment