Search results


Plugins | ResourceSpace

Explore the range of plugins that are available to expand ResourceSpace's base functionality, including integrations with third party software and systems.

Read more...


Flickr publishing

Allows you to publish selected resources from selected collections to a Flickr account. Create a Featured Collection or collection that contains Resources you wish to publish.

Read more...


Youtube publish

Allows publishing of video resources to a configured YouTube account. This plugin will upload data and has configurable mapped fields to automatically add descriptions, titles and tags.

Read more...


Writing your own plugins

Nearly all modications for ResourceSpace should be done within your own plugin. You can access portions of code through hooks and you can add styling, configuration, language strings and all manner of content.

Read more...


Managing plugins

Plugins are packages that extend or modify ResourceSpace's function and presentation. Plugins have a managed structure which makes it easy for third parties to write and for site administrators to maintain, even as function and bug fixes are applied to the base code.

Read more...


Vimeo publish

Allows publishing of video resources to a configured Vimeo account. This plugin will upload data and has configurable mapped fields to automatically add descriptions, titles and tags.

Read more...


New to ResourceSpace?

Find out from the Knowledge Base how to get started with the ResourceSpace Digital Asset Management System.

Read more...


User guides

Introduction to the user guides section of the ResourceSpace Knowledge Base

Read more...


Collections, public collections and featured collections

Because resources within ResourceSpace may be tagged with many different types and pieces of metadata, there is no need to store them in a traditional hierarchical folder structure in order to know where to find them.

Read more...


Embed document

Allows you to embed Document Resource Previews on another website using a short HTML script. The script is generated by doing the following: Browse to the Resource with the configured resource type (Ask your administrator if you are not sure) that you wish to embed on another site.

Read more...


Managing dash tiles

For some user groups who do not have the permission to manage their own dash, they will not be able to add, remove or rearrange the tiles given to them by the system Administrators.

Read more...


Useful user permissions

The way users access and interact with resources is easy to control and modify by User Group Permissions.

Read more...


User contributions

The way in which your users contribute resources is managed by user group upload permissions. Trusted uploaders (such as administrators) may be granted permission to add resources without the need for review.

Read more...


Batch replace

This functionality can be useful if you wish to update a number of resources within ResourceSpace. It will replace the original file and regenerate the previews of any number of resources.

Read more...


Creating and deleting metadata fields

Resource metadata should be clear and descriptive and storing the right data in the right field type can help you to achieve this.

Read more...


Advanced workflow

workflow, process, publish, embargo, archive, review,state, status

Read more...


Video tracks

This plugin allows users to create custom video files in alternative formats/codecs. Optionally the user can select subtitle and audio track files that have been uploaded as alternative files for a video resource, thus producing multiliingual variants of videos from within ResourceSpace with no further post-production efforts.

Read more...


KE EMu database integration

EMu uses a Texpress database engine: a multi-user and object oriented database management system. The Texpress kernel incorporates features that allow for easy creation and use of applications, accessed via a range of applications.

Read more...


Translations

This document describes how to create an official standard translation and how to create a custom translation for your own system.

Read more...


Google Vision API

This plugin sends your images to Google's Cloud Vision API on upload, and sets appropriate metadata in pre-configured fields based on what has been recognised in the image.

Read more...


Simple SAML

WARNING: This plugin should only be enabled and configured by system administrators as it affects how users log in to ResourceSpace.

Read more...


Winauth

Enables users to login to ResourceSpace using Windows Integrated Authentication

Read more...


ResourceConnect

This plugin allows different ResourceSpace systems to connect to each other to allow searching between installations.

Read more...


Falcon link

This plugin allows users to publish resources as templates in Falcon.io Important information You need to have an account with Falcon.

Read more...


IIIF

IIIF is an API specification designed to improve interoperability between digital image repositories.

Read more...


Cookies notification

Activated under manage plugins, the cookies_notification plugin creates a header on the login page to notify users that their activity will be tracked via cookies.

Read more...


General installation requirements

ResourceSpace normally operates on the LAMP stack and requires the following core programs: MySQL or MariaDB - The database MySQL version 5.

Read more...


All user permissions

One of the central features of ResourceSpace is the ability to control which resources users are permitted to see and how they are able to interact with them.

Read more...


Adobe link

This plugin allows you to import files from ResourceSpace directly into Adobe InDesign and Photoshop.

Read more...


1. Finding your way around

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video h2 { margin-top:21px;margin-bottom:13px; } Transcript Welcome to ResourceSpace.

Read more...


5. Working with collections

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video h2 { margin-top:21px;margin-bottom:13px; } Transcript There are various actions that can be performed that will affect the items in the collection, available from an actions menu on the collection bar.

Read more...


6. Dash tiles

To view this video please enable JavaScript, and consider upgrading to a web browser that supports HTML5 video h2 { margin-top:21px;margin-bottom:13px; } Transcript Collections can be published as dash tiles.

Read more...


Wordpress_SSO

WARNING: This plugin should only be enabled and configured by system administrators as it affects how users log in to ResourceSpace.

Read more...


Database schema

// create an array with nodes var nodes = new vis.DataSet([ { id: 2, label: "activity_log",color: "#ffd"}, { id: 3, label: "annotation",color: "#fdd" }, { id: 4, label: "annotation_node",color: "#fdd" }, { id: 6, label: "collection",color: "#dff", font: {size:30} }, { id: 7, label: "collection_keyword",color: "#dff" }, { id: 8, label: "collection_log",color: "#dff" }, { id: 9, label: "collection_resource",color: "#fdd" }, { id: 10, label: "collection_savedsearch",color: "#dff" }, { id: 11, label: "comment",color: "#fdd" }, { id: 12, label: "daily_stat",color: "#ffd" }, { id: 13, label: "dash_tile",color: "#ffd" }, { id: 15, label: "external_access_keys",color: "#fdd" }, { id: 16, label: "filter",color: "#fdd" }, { id: 17, label: "filter_rule",color: "#fdd" }, { id: 18, label: "filter_rule_node",color: "#fdd" }, { id: 20, label: "job_queue",color: "#ffd" }, { id: 21, label: "keyword",color: "#fdd" }, { id: 22, label: "keyword_related",color: "#fdd" }, { id: 25, label: "message",color: "#ffd" }, { id: 26, label: "node",color: "#fdd" , font: {size:20}}, { id: 27, label: "node_keyword",color: "#fdd" }, { id: 28, label: "plugins",color: "#ddd" }, { id: 30, label: "report",color: "#ffd" }, { id: 31, label: "report_periodic_emails",color: "#ffd" }, { id: 32, label: "report_periodic_emails_unsubscribe",color: "#ffd" }, { id: 33, label: "request",color: "#fdd" }, { id: 34, label: "research_request",color: "#ffd" }, { id: 35, label: "resource",color: "#fdd", font: {size:30}}, { id: 36, label: "resource_alt_files",color: "#fdd" }, { id: 37, label: "resource_custom_access",color: "#fdd" }, { id: 38, label: "resource_data",color: "#fdd" }, { id: 39, label: "resource_dimensions",color: "#fdd" }, { id: 40, label: "resource_keyword",color: "#fdd" }, { id: 42, label: "resource_log",color: "#fdd" }, { id: 43, label: "resource_node",color: "#fdd" }, { id: 44, label: "resource_related",color: "#fdd" }, { id: 45, label: "resource_type",color: "#fdd" }, { id: 46, label: "resource_type_field",color: "#fdd" }, { id: 48, label: "site_text",color: "#ddd" }, { id: 49, label: "slideshow",color: "#fdd" }, { id: 51, label: "user",color: "#ffd", font: {size:30} }, { id: 52, label: "user_collection",color: "#ffd" }, { id: 53, label: "user_dash_tile",color: "#ffd" }, { id: 54, label: "user_message",color: "#ffd" }, { id: 55, label: "user_preferences",color: "#ffd" }, { id: 56, label: "user_rating",color: "#fdd" }, { id: 57, label: "user_report",color: "#ffd" }, { id: 58, label: "user_userlist",color: "#ffd" }, { id: 59, label: "usergroup",color: "#ffd", font: {size:20} }, { id: 60, label: "usergroup_collection",color: "#ffd" }, { id: 61, label: "usergroup_dash_tile",color: "#ffd" }, ]); /* Commenting some things that don't relate to anything.

Read more...


Project structure

A breakdown of the folders used within ResourceSpace, and their typical contents and function.

Read more...


ResourceSpace plugin for WordPress

Please note that this is a WordPress plugin that needs to be installed and runs on WordPress, not on ResourceSpace A WordPress plugin that allows you to embed resource files from ResourceSpace in your posts is now available.

Read more...


ResourceSpace software design principles

When developing ResourceSpace core and plugins please always consider the below principals. The existing codebase doesn't always adhere to these principals - the contributions from many different developers over the years have meant a mix of coding styles - but the important thing is that we're always moving in the right direction by refactoring as we see fit and peer reviewing new code.

Read more...


Table: plugins

Lists all plugins active on the system and stores plugin configuration. Column Type Note name varchar(50) The folder name containing the plugin, also the file name in the case of an uploaded .

Read more...


Table: collection

Collections are groups of resources. Column Type Note ref int(11) Auto incrementing index name varchar(100) The collection display name.

Read more...


YT2RS (Youtube embed)

The Youtube to ResourceSpace plugin hooks into the resource View page to embed a YouTube video. On the options page for this plugin you can enter the ID of a metadata field that is used to store the URL of the Youtube video.

Read more...


get_collection()

Description Returns all data for collection $ref. Parameters Column Type Default Description $ref int Collection ID Return array|boolean Location include/collections_functions.

Read more...


save_collection()

Description Process the save action when saving a colleciton Parameters Column Type Default Description $ref integer $coldata array array Return void Location include/collections_functions.

Read more...


get_home_page_promoted_collections()

Parameters This function accepts no parameters. Location include/collections_functions.

Read more...


config_text_input()

Description Generate an html text entry or password block field. Defaulted to false.

Read more...


config_colouroverride_input()

Description Generate colour picker input Parameters Column Type Default Description $name string HTML input name attribute $label string $current string Current value $default string Default value $title string null Title $autosave boolean false Automatically save the value on change $on_change_js null $hidden false on_change_js string JavaScript run onchange of value (useful for "live" previewing of changes) Location include/config_functions.

Read more...


config_single_select()

Description Generate an html single-select + options block are used as the values of the options, and the values are the alternatives the user sees.

Read more...


config_boolean_select()

Description Generate an html boolean select block to array('False', 'True') in the local language.

Read more...


config_single_ftype_select()

Description Generate an html single-select + options block for selecting one of the RS field types.

Read more...


get_export_tables()

Description Get array of tables to export when exporting system config and data Parameters Column Type Default Description $exportcollection int 0 - Optional collection id to include resources and data from Return array Location include/migration_functions.

Read more...


activate_plugin()

Parameters Column Type Default Description $name Location include/plugin_functions.

Read more...


deactivate_plugin()

Parameters Column Type Default Description $name Location include/plugin_functions.

Read more...


purge_plugin_config()

Description Purge configuration of a plugin. Replaces config value in plugins table with NULL.

Read more...


get_plugin_config()

Description Return plugin config stored in plugins table for a given plugin name. Queries the plugins table for a stored config value and, if found, unserializes the data and returns the result.

Read more...


set_plugin_config()

Description Store a plugin's configuration in the database. Serializes the $config parameter and stores in the config and config_json columns of the plugins table.

Read more...


is_plugin_activated()

Description Check is a plugin is activated. Returns true is a plugin is activated in the plugins database.

Read more...


handle_rsc_upload()

Description Handle the POST for an upload of a plugin configuration (.rsc) file Typically invoked near the beginning of a plugin's setup.

Read more...


display_rsc_upload()

Description Display hmtl form for uploading a plugin configuration (.rsc) file Typically invoked in a plugins's setup.

Read more...


config_gen_setup_post()

Description Generate the first half of the "guts" of a plugin setup page from a page definition array.

Read more...


config_gen_setup_html()

Description Generate the second half of the "guts" of a plugin setup page from a page definition array.

Read more...


config_multi_select()

Description Generate an html multi-select + options block used as the values of the options, and the values are the choices the user sees.

Read more...


config_single_user_select()

Description Generate an html single-select block for selecting one of the RS users. The user key (i.

Read more...


config_multi_user_select()

Description Generate an html multi-select block for selecting from among RS users. An array consisting of the user keys (i.

Read more...


config_single_group_select()

Description Generate an html single-select block for selecting from among RS user groups. Parameters Column Type Default Description $name string the name of the select block.

Read more...


config_multi_group_select()

Description Generate an html multi-select block for selecting from among RS user groups. An array consisting of the group keys (i.

Read more...


config_multi_ftype_select()

Description Generate an html multi-select + options block for selecting multiple the RS field types.

Read more...


config_single_rtype_select()

Description Generate an html single-select + options block for selecting one of the RS resource types.

Read more...


config_multi_rtype_select()

Description Generate an html multi-select check boxes block for selecting multiple the RS resource types.

Read more...


config_db_single_select()

Description Generate an html single-select + options block for selecting from among rows returned by a database query in which one of the columns is the unique key (by default, the "ref" column) and one of the others is the text to display (by default the "name" column).

Read more...


config_db_multi_select()

Description Generate an html multi-select + options block for selecting from among rows returned by a database query in which one of the columns is the unique key (by default, the "ref" column) and one of the others is the text to display (by default the "name" column).

Read more...


get_plugin_css()

Parameters This function accepts no parameters. Location include/plugin_functions.

Read more...


plugin_activate_for_setup()

Parameters Column Type Default Description $plugin_name Location include/plugin_functions.

Read more...


register_plugin_language()

Parameters Column Type Default Description $plugin Location include/plugin_functions.

Read more...


get_plugin_path()

Parameters Column Type Default Description $plugin $url false Location include/plugin_functions.

Read more...


register_plugin()

Parameters Column Type Default Description $plugin Location include/plugin_functions.

Read more...


render_actions()

Description Renders search actions functionality as a dropdown box Parameters Column Type Default Description $collection_data array Collection data $top_actions boolean true Set to true if actions are to be rendered in the search filter bar (above results) $two_line boolean true Display on two lines $id string '' Selector HTML ID $resource_data array array Resource data $optionsonly boolean false Render only options $forpage string "" Specifically target for which page actions apply Return void Location include/render_functions.

Read more...


display_field_data()

Parameters Column Type Default Description $field $valueonly false $fixedwidth 452 Location include/render_functions.

Read more...


update_field()

Description Updates resource field. Works out the previous value, so this is not efficient if we already know what this previous value is (hence it is not used for edit where multiple fields are saved) Parameters Column Type Default Description $resource integer Resource ID $field integer Field ID $value string The new value &$errors array array Any errors that may occur during update $log true Return boolean Location include/resource_functions.

Read more...


compile_search_actions()

Parameters Column Type Default Description $top_actions Location include/search_functions.

Read more...