en:user:the_depositor
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | en:user:the_depositor [2023/03/13 01:46] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | |||
+ | |||
+ | |||
+ | ====== The Depositor ====== | ||
+ | |||
+ | <tabbox Greenstone3> | ||
+ | The depositor is a web interface for adding new documents, along with metadata, to existing collections. It is specifically aimed to mimic the structured submission workflow of a institutional repository. The Depositor for Greenstone3 is still in development. | ||
+ | <tabbox Greenstone2> | ||
+ | The depositor is a web interface for adding new documents, along with metadata, to existing collections. Derived from the [[# | ||
+ | |||
+ | * You must have already created the collection via the [[en: | ||
+ | * The collection should use Lucene as the indexer. Lucene provides incremental rebuilding ability - where just the newly uploaded document is added and indexed in the collection. MG or MGPP can be used, but each time a document is added, the full collection must be rebuilt, so the deposit part of the submission will be much slower, particularly as the collection becomes large. If the user will be only depositing and not rebuilding each time, then the choice of indexer is not important. | ||
+ | * You must be serving your collection using Apache or similar web-server (Greenstone' | ||
+ | |||
+ | |||
+ | ===== Enable the Depositor ===== | ||
+ | |||
+ | To enable the Depositor tool modify '' | ||
+ | |||
+ | Note: | ||
+ | * You might need to change file permissions for the '' | ||
+ | * To modify a collection, a user needs to be in a group that has permission. The ''' | ||
+ | * Remember, the Depositor only works with the Web server, not the local server | ||
+ | |||
+ | ===== Use the Depositor ===== | ||
+ | |||
+ | - Go to the Greenstone' | ||
+ | - Sign in to the page | ||
+ | - Select a collection from the collection list | ||
+ | - Fill in the metadata fields | ||
+ | - Click the " | ||
+ | - Select the file you want to deposit, then click the " | ||
+ | - Click the " | ||
+ | - Try the newly built collection | ||
+ | |||
+ | Notes: | ||
+ | * The Depositor uses the Dublin Core metadata set by default. So if the target collection doesn' | ||
+ | * If you want to upload more than one file at a time, zip them first. Don't forget to include ZipPlugin in your collection' | ||
+ | * You will see " | ||
+ | |||
+ | ===== Configure the Depositor ===== | ||
+ | |||
+ | The default set up for the depositor is as described [[# | ||
+ | This workflow can be changed to suit each collection. | ||
+ | |||
+ | The depositor workflow is defined in the **deposit.dm** macro file in the main greenstone macros folder. | ||
+ | Editing this file will change the workflow for **all** collections. To change it for just one collection, copy **deposit.dm** into the collection' | ||
+ | You'll need to start by adding the line < | ||
+ | |||
+ | ==== Deposit only ==== | ||
+ | |||
+ | In some cases, you may want users to be able to deposit items but not trigger a collection rebuild. Perhaps the items and metadata need monitoring or checking by the librarian before being added to the collection. | ||
+ | |||
+ | To make the depositor deposit the item in the collection but not import/ | ||
+ | |||
+ | Note, to do this for a single collection, you can add | ||
+ | < | ||
+ | package depositor | ||
+ | |||
+ | _laststep_ {depositonly} | ||
+ | </ | ||
+ | |||
+ | to the Collection Specific Macros pane in the collection in GLI. | ||
+ | ==== Configure the Metadata Fields ==== | ||
+ | |||
+ | By default, the Depositor uses three fields (Title, Creator and Description) from the Dublin Core metadata set, but you can easily customize this in the GLI Format panel (from Greenstone version 2.81) | ||
+ | |||
+ | - Launch GLI, open the collection you want to customize. Go to the Format Panel, click the " | ||
+ | - Select fields that you want to be used in the Depositor. A drop-down list will appear right after the selected element, which is used to specify the text input type for that element in the web page: " | ||
+ | * It is recommended to select metadata fields that have been used to build classifiers, | ||
+ | * Please note that at least one metadata element must be selected. If there is only one element left selected in the list, de-select the element will fail and pop up a warning message. | ||
+ | - Save the collection. Note, if GLI doesn' | ||
+ | |||
+ | GLI writes out a macro into the collect.cfg file which lists all the metadata fields that should be used. The default list is: | ||
+ | < | ||
+ | collectionmeta | ||
+ | {\" | ||
+ | {\" | ||
+ | </ | ||
+ | |||
+ | You can edit this by hand if you like, but its probably easier to let GLI do it for you. For each item, the ' | ||
+ | |||
+ | === Multiple metadata values or change the order === | ||
+ | |||
+ | If you want to have the user add more than one value for a metadata element, for example, multiple Subjects, or if you want to change the order of the fields, you'll have to edit the depositormetadata list by hand. You can add multiple entries for any of the metadata fields and change the order to suit the collection. | ||
+ | |||
+ | Because GLI does not offer this functionality, | ||
+ | |||
+ | If you do want to open the collection in GLI, then you will need to define the custommetadataconf macro instead of depositormetadata. (Note, this available from 2.87 or nightly releases after 23 October 2014) | ||
+ | |||
+ | You can do this in two ways: as a collectionmacro in collect.cfg, | ||
+ | |||
+ | * In the collect.cfg file, add by hand (remember to close in GLI before editing) | ||
+ | < | ||
+ | collectionmacro depositor: | ||
+ | </ | ||
+ | |||
+ | * In Collection Specific Macros: | ||
+ | < | ||
+ | _custommetadataconf_ {var DepositorMDFields = new Array(\{\" | ||
+ | </ | ||
+ | |||
+ | The content is basically the same for the two cases. Note, in the second case, internal ' | ||
+ | |||
+ | The collectionmacro in collect.cfg has priority over the macro in extra.dm, if they were both defined. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== Add a deposit link to a collection ==== | ||
+ | (Note this is only available for 2.87 or nightly releases after 20 October 2014.) | ||
+ | |||
+ | By default, the depositor link is available from the home page, and the user needs to select a collection and log in. They can access the depositor page again from within the depositor by clicking the '' | ||
+ | |||
+ | To add a link in a collection for depositing an item, that bypasses the collection selection page, do the following. | ||
+ | |||
+ | In the Collection Specific Macros pane in GLI, add: | ||
+ | < | ||
+ | package Global | ||
+ | |||
+ | _optdepositlink_ {_depositlink_} | ||
+ | |||
+ | </ | ||
+ | This will add a DEPOSIT button in the row of HOME, HELP, PREFERENCES button. It will be available for every page in the collection. | ||
+ | |||
+ | To add a link just on one page, add some text and link to **__httppagedepositorcurrentcollection_** | ||
+ | You'll need to add this into the **_content_** macro of the relevant page. | ||
+ | |||
+ | For example, to add a link on the about page, you might add the following to the Collection Specific Macros: | ||
+ | |||
+ | < | ||
+ | package about | ||
+ | |||
+ | _content_ { | ||
+ | _optnavigationbar_ | ||
+ | |||
+ | <div class=" | ||
+ | _If_(" | ||
+ | | ||
+ | ) | ||
+ | | ||
+ | <div style=" | ||
+ | </ | ||
+ | _If_(_Global: | ||
+ | _textsubcollections_ | ||
+ | |||
+ | <div class=" | ||
+ | < | ||
+ | _help: | ||
+ | </ | ||
+ | |||
+ | </ | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | This will add a link **Deposit an item into the collection** at the right of the page underneath the quick search form. Note that this is the default **_content_** macro from the about page, copied into the collection, with one **< | ||
+ | |||
+ | === Metadata Field Caching === | ||
+ | |||
+ | When you are using the Despositor in a local collection manner, you will remain logged in between deposits, and the system will cache the metadata values. This means that next time you return to the " | ||
+ | < | ||
+ | package depositor | ||
+ | _cacheoption_{0} | ||
+ | </ | ||
+ | |||
+ | Note that the '' | ||
+ | |||
+ | === Removing the depositor link on the home page === | ||
+ | |||
+ | If you have a deposit button in a collection, then you may want to remove the main depositor link from the home page. To do this, edit // | ||
+ | |||
+ | ==== Single page Submission ==== | ||
+ | |||
+ | You can combine the metadata field entry and file selection into a single page if you like. | ||
+ | |||
+ | In the Collection Specific Macros section in GLI (or in the collection' | ||
+ | |||
+ | < | ||
+ | _numsteps_ {1} | ||
+ | </ | ||
+ | |||
+ | This will make it only have one page of data entry. After this page, it will go to deposit item or deposit and build, depending on the other settings. | ||
+ | |||
+ | < | ||
+ | _textstep1_ {Specify File and Metadata} | ||
+ | _textstep1description_ {Please enter the metadata values, select a file, then click _textbild_ } | ||
+ | </ | ||
+ | |||
+ | These define the heading and description at the top of the page, as the default ones don't fit this scenario so well. | ||
+ | |||
+ | < | ||
+ | _step1content_ { | ||
+ | |||
+ | <form name=" | ||
+ | |||
+ | <input type=hidden name=" | ||
+ | <input type=hidden name=" | ||
+ | |||
+ | |||
+ | < | ||
+ | <table width=_pagewidth_> | ||
+ | < | ||
+ | <div class=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | <div class=" | ||
+ | |||
+ | < | ||
+ | < | ||
+ | < | ||
+ | |||
+ | <div class=" | ||
+ | |||
+ | < | ||
+ | <div class=" | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | < | ||
+ | </ | ||
+ | |||
+ | </ | ||
+ | |||
+ | } | ||
+ | </ | ||
+ | |||
+ | This is the _step1content_ macro copied from greenstone2/ | ||
+ | |||
+ | And then we have added the file input element so that the user can select the file on this page. | ||
+ | |||
+ | In a Deposit-Only situation, the user gets a Confirmation page, listing the file name and file size. You can change this by redefining the _depositonlycontent_ macro. For example: | ||
+ | |||
+ | < | ||
+ | _depositonlycontent_ { | ||
+ | < | ||
+ | < | ||
+ | <table width=_pagewidth_> | ||
+ | < | ||
+ | <div class=" | ||
+ | < | ||
+ | <div class=" | ||
+ | < | ||
+ | < | ||
+ | <div class=" | ||
+ | </ | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | ==== DSpace-inspired Depositor ==== | ||
+ | |||
+ | Greenstone comes with a version of the depositor that behaves like the DSpace repository. It provides a multi-page submission process. | ||
+ | - Describe 1: Add Author, Title, Series/ | ||
+ | - Describe 2: Add Subject Keywords, Abstract, Sponsors, Description | ||
+ | - Upload 1: Select a file to upload | ||
+ | - Upload 2: Check the details of uploaded file | ||
+ | - Verfiy: Check all the metadata, with options to go back and change it | ||
+ | - License: accept the DSpace distribution license for the document | ||
+ | - Deposit Item: add the item to the collection and rebuild the indexes. | ||
+ | |||
+ | * To use this for all collections, | ||
+ | * To use it for just one collection, copy depositdspace.dm from greenstone2/ | ||
+ | |||
+ | *The Dspace Depositor works with Dublin Core (dc) metadata and some extra fields defined in the Dspace inspired metadata set " | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== Additional Resources ===== | ||
+ | |||
+ | *The [[http:// | ||
+ | |||
+ | *Diego has provided a [[http:// | ||
+ | |||
+ | </ | ||
en/user/the_depositor.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1