Documentation

Publications

Download (pdf)

Curation Workflow

Turning on Curation:

  1. From the backend, navigate to Components -> Publications
  2. Click the Options button
  3. Click the Curation tab
  4. Select ON in the Curation field
  5. In the Name of Group of curators field, type in the CN of the group you want to give curation rights to
  6. Optionally, select 1 month in the Grace period for changes box if needing to give users the ability to change the publication after it has been published
    1. Note: mkAPI will not run until the one month grace period if set.  
  7. Click Save & Close to ensure the changes and are submitted

 

curation1

Auto-Approve Publications

If you would like certain users to have their new Publications by pass the Curation steps, you can add them to a list where their Publications are auto-approved. To add users to this list, follow these steps:

  1. Navigate to the backend of the HUB and click on Publications underneath the Components drop-down
  2. Inside of Publications, click on the Options button
  3. Click on the Curation tab and then insert the usernames of the users who's Publications are to be auto-approved
  4. Click Save & Close to save the changes

Enabling Databases

To enable databases within Publications:

  1. Log onto the administrative backend
  2. Go to Components
  3. Go to Publications
  4. Go to Master Types submenu item
  5. Select the checkbox next to the Database table row
  6. Click the Edit Button
  7. Find the Content block for the Databases Type
  8. Click the [Edit] button next to Block Elements
  9. Locate the Type drop-down, change file to data
  10. Change the Maximum count to 1
  11. Save the Block Element
     

 

Creating a Publication License

  1. Navigate to the backend of the Hub and click on Components and from the drop-down click on Publications
  2. Open up the Licenses tab and then click the New button in the upper right hand corner of the page
  3. Start filling out the License Information:
    1. Title: The title of the license
    2. Name: The name of the license, full name if the license is an acronym
    3. URL: The webpage that all the legal license information
    4. About: The background information about this license
    5. Content: The parameters of the license such as what content this license supports
    6. Icon: Path to icon image that lives in the Media Manger on the HUB
  4. Once you have filled out the License Information, begin filling out the License Configuration:
    1. Active: If this license should be automatically published and available on the frontend for users to use after saving
    2. Customizable: Should the license text be customizable for publication authors to edit
    3. Agreement required: Forces publication authors to
  5. Once you have finished filling out the information for the license, click Save & Close

Selecting a Default Publication License

  1. Navigate to the backend of the Hub and click on Components and from the drop-down click on Publications
  2. Open up the Licenses tab and locate the Default column
  3. Locate the license that should become the new default and select the box beside the license title
  4. Click the Make Default button (star icon) and the license will be made the new default

Publishing/Unpublishing a Publication License

  1. Navigate to the backend of the Hub and click on Components and from the drop-down click on Publications
  2. Open up the Licenses tab and locate the license you want to publish or unpublish
  3. In the Status column you can click on the check-mark or cancel sign to change the status of the license
  4. After clicking on the status icon the new status will be automatically saved

Reordering Publication Licenses

  1. Navigate to the backend of the Hub and click on Components and from the drop-down click on Publications
  2. Open up the Licenses tab and locate the Order column
  3. Rearrange the licenses by clicking the arrows facing up and down
  4. The final ordering you leave the licenses in will appear the same inside of Publications on the frontend of the Hub inside the License drop-down when creating a new publication

Creating Publication Categories

  1. Navigate to the backend of the Hub and click on Components and from the drop-down click on Publications
  2. Open up the Categories tab and then click the New button
  3. Begin filling out the Category Information:
    1. Name: The name of the new category
    2. Alias: The shortname of the new category
    3. URL Alias: The URL name for the category
    4. dc:type: The Dublin Core Meta Data type
    5. About: A short introduction describing what type of publication files and content are stored in this category
  4. Determine what plugins you want to connect to the this new Publication Category
  5. Fill out the Item Configuration:
    1. Status: Determine if the category is active (publish) or inactive (unpublished)
    2. Contributable: Determine if the category can be contributed to
  6. Determine the Custom Fields by creating new fields or managing the preexisting files. The fields determine the layout of the Publication overview page:
    1. Reorder: Drag and drop the different field rows to change the order
    2. Field name: Change the name of the field title
    3. Input Type: Determine the amount of text that can be inputted in this field from the drop-down
    4. Required: Check the box to make the field required for the publication author to fill out before publishing the publication
  7. Review the information and then click Save & Close

Publishing/Unpublishing a Publication Category

  1. Navigate to the backend of the Hub and click on Components and from the drop-down click on Publications
  2. Open up the Categories tab and locate the license you want to publish or unpublish
  3. In the Status column you can click on the check-mark or cancel sign to change the status of the license
  4. After clicking on the status icon the new status will be automatically saved

 

Handling Publication Options

  1. Navigate to the backend of the Hub and click on Components and from the drop-down click on Publications
  2. Open up the Publications tab and then click the Options button in the upper right hand corner of the page
  3. Inside the Publication Options, the different areas of Publications can be managed and adjusted as needed:
  4. Defaults:
    1. Component ON/OFF: Turning on or off Publications
    2. User Contributaions Outside of Projects: Allow users to contribute to Publications outside of Projects
    3. Email Notifications: Allow component to send out emails
    4. Default Category: Newly created Publications will automatically be defaulted to this category if not selected by the publication author
    5. Default Publication Thumbnail: Path to default publication, used as a placeholder
    6. Default Video Thumbnail: Path to default video, used as a placeholder
    7. Default Image Thumbnail: Path to default image, used as a placeholder
    8. Default Master Image: Default image for Publication page cover, used as a placeholder
    9. Publication Files: Master path for restoring published data
    10. URL to Documentation: URL to page with Publication information
    11. URL to Terms of Deposit: URL of Terms of Deposit page on the HUB
  5. Curation:
    1. Name of Curators:(Hub) group members authorized to perform pre-publication curation (all publication types) and manage curation assignment
    2. Grace Period for Changes:Allow authors to make changes to a published resource within the grace period after approval
    3. Auto-approve:Automatically approve new submissions
    4. Auto-approved Users:A comma-separated list of usernames to be auto-approved
  6. DOI Configuration:
    1. About DOI Link: a link to an explanation of what Digital Object Identifiers (DOI) are [optional]
    2. DOI Namespace Start: First part of DOI namespace (what goes right after DOI: and before /,e.g. 10.5072)
    3. DOI Namespace End: Hub-specific DOI namespace end (usually 2-3 characters going after /, e.g. F2K
    4. DOI Service URL: DOI service address
    5. DOI Service User/Password: DOI Service/Password
    6. DOI Publisher: Publisher name (may use full HUB name) for DOI service
    7. DOI Resolve URL: URL for resolving DOI's
    8. DOI Verification URL: URL for verifying DOI's
    9. Issue master DOI for Publication?: Master DOI links to /main page listing all previously published versions
  7. Sections:
    1. Contributors: Show/Hide the list of authors on publication page
    2. Format Author Display: Format list of authors on publication page
    3. Ranking: Show/Hide the ranking
    4. Rating: Show/Hide the rating
    5. Date: Show/Hide the date on the publication page
    6. Linked Data: Show/Hide a link to an OAI-ORE compliant linked data representation in the HTML source for each publications
    7. Citation: Show example/instructions for citing this publications.
    8. Suggest License: Allow users to suggest licenses
    9. Citation Format: Choose format for citations
    10. Supported Tag: A tag to display to indicate Org supported tools
    11. Supported Link: A link display to describe Org supported tools
    12. Audience Link: URL to a page describing audience levels.
  8. AIP:
    1. ​Trusted Digital Repository: Trusted Digital Repository
    2. AIP Path: AIP path (for trusted digital repos)
    3. MkAIP Admin Group: Group of administrators to get notification about archived dataset

Master Types: Editing Block Information

  1. Navigate to the backend of the HUB and click on the tab Components
  2. From the drop-down click on Publications
  3. Inside of Publications, click on the tab Master Types
  4. Click on the name of the Master Type that you want to edit block information in
  5. Locate the Block you wish to edit
    1. A Block is a section of the Publication that holds information about the materials being published (i.e. description, abstract, etc.)
  6. Find the Block Elements section and click the Edit in brackets 
  7. Change the block information as fit, for example below is a use case of a small issue that occurs in some Master Types with the abstract switching with the description:
    1. In this case the abstract and description mappings are incorrect. There is a section that tells the block which field the Publication versions table what to map from the content block. Here, one would switch the description alias and name from abstract to description and vise versa. 
  8. Click Save & Close to save these changes

Setting Up Group Association with a Publication

Groups can be associated with a Publication that was not published from a Project owned by any groups. Only one group can be given association rights. Usually a group is associated with a Publication if the group contributed materials or resources that helped with the Publication's development or if the group helped fund this Publication. To set up the ability for users to associate groups with their Publications, follow these steps:

  1. Navigate to the backend of the Hub
  2. Hover over Components and click Publications from the drop-down
  3. Inside of Publications click the Master Types tab
  4. Click the title of the Master Type that you want this feature to be enabled on
  5. Under the section called Blocks and Configuration locate the Authors block
  6. Locate the Show group ownership and allow to be assign group ownership and change the drop-down to be Yes
  7. Click Save & Close and this feature will be enabled on this Master Type
  8. Enable this on each Master Type that you wish for this feature to be enabled

Can attaching a license to a Publication be made optional?

Yes, it can be set up in specific Master Types:

  1. Navigate to the backend of the Hub
  2. Hover over Components and select Publications from the drop-down
  3. Select Master Types tab
  4. Select the Master Type you would like to manage this setting
  5. Inside the Master Type locate the License block and change "Input required" to No
  6. Click Save & Close

Setting up minting DOIs as optional for a Publication

It can be set up in specific Master Types:

  1. Navigate to the backend of the Hub
  2. Hover over Components and select Publications from the drop-down
  3. Select Master Types tab
  4. Select the Master Type you would like to manage this setting
  5. Inside the Master Type locate the Curation Configuration block and change "Require DOI" to Offer choice to publish with DOI or post without DOI
  6. Click Save & Close

Batch Create

  1. Navigate to administrator on the Hub
  2. Hover over Components and select Publications from the drop-down
  3. Select Batch Create tab
  4. Select a project you would like to create publications in
  5. Underneath Data, click Choose File and upload a .xml file with the publications.
  6. Make sure the .xml file follows the schema provided by the link on your hub

  1. Click Process data and review the record to add to the database as there may be errors.
  2. After verifying the data is correct, click the Create record(s) button

Last modified: