Search

Search results

Special search terms

Special search terms help users to find content in a much more specific and controlled manner, either through giving them extra tools or using a prebuilt search.

The ResourceSpace search feature is a powerful tool that allows users to quickly find the resources they need. Users can start with a broad search and then refine the results to find the most relevant content.

do_search

The article provides a description of the do_search function, which is used to perform a search and return matching resources. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, and offset.

Simple search

The article discusses the simple search panel in ResourceSpace, a system that allows for easy searching within the platform. The basic panel includes a general search box for quick text searching across all indexed fields, as well as options to search by resource type and date.

Advanced search

The advanced search page in ResourceSpace allows users to access a wider selection of metadata fields, enabling them to create more refined searches. The fields are grouped by resource type, with global fields at the top and resource-specific fields further down.

User research requests

Research requests enable users to ask admins for help in sourcing resources. Users can fill out a form detailing what they need, and administrators can then help them to find suitable resources. This can be done by either providing them with a list of resources or by sending them links to searches or collections to help them get their search started.

Search filters

Each user group can have a 'search filter' set (via the user group options in System Setup), which allows for resource visibility restrictions.

Watched searches

The 'rse_search_notifications' plugin enables the functionality of watched searches, which allows users to subscribe to any search result or set of resources, such as a collection. The system will then notify the user when resources are added or edited to match the result set.

search_public_collections

This article provides information on how to search for public and featured collections using the provided variables. The $search variable is used to input search terms, and leaving it blank will return all collections.

search_get_previews

The article describes the search_get_previews function, which is used to perform a search and return matching resources including URLs for the requested preview sizes. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, recent search day limit, preview sizes, and preview file extension.

Conditional terms

Montala has launched a plugin that enables users to make acceptance of terms and conditions necessary prior to downloading certain resources based on their metadata. The plugin configuration allows users to select a metadata field value which, when met, will require the terms to be accepted.

Search notifications

The article discusses a new feature called "Search Notifications" that allows users to receive notifications when the results of a specified search change. This feature is useful for users who want to stay up-to-date on a particular topic or keep track of changes in a specific search result.

Excluding terms from your search

The article explains how to exclude specific terms from a search. It suggests using the simple search bar and entering the search term followed by a space, a minus symbol, and the term to be excluded. For example, entering 'Marketing -advertising' will return all resources tagged with 'marketing' but not tagged with 'advertising'.

Geographic search

The geographic search function allows users to search for resources that have embedded location data. To use the function, users can drag the map and zoom to an area of interest or search for a location using the search button.

Full text searching

ResourceSpace has changed the way it handles long text stored in metadata fields. From version 10.1, keywords (tags) will only be processed for the first 500 characters of any text. To search the full text, there is a new option on the advanced search page that will utilise native database full-text indexing.

Table: collection_savedsearch

The article provides information about the "collection_savedsearch" table, which is a list of saved searches that can exist within collections. The table has several columns, including "ref," which is an auto-incrementing index, "collection," which refers to the collection table, "search," which is the search string, "restypes," which is the resource types used when searching, "starsearch," which is an integer value, "archive," which is a comma-separated list of workflow states, "created," which is the date created, and "result_limit," which is the maximum number of results to return.

Table: research_request

The article provides information about the "research_request" table, which is used in ResourceSpace, a digital asset management system. The table stores information related to research requests, which are requests for appropriate resources for a project.

Table: search_log

Search log. Log every search made by the system. Column Type Note ref int(11) Auto incrementing index search_string mediumtext Actual search string resource_types mediumtext Resource types filter archive_states mediumtext Archive states filter logged datetime Date and time of search user int(11) User executing the search result_count int(11) Result count This table is empty by default.

search_public_collections()

Developer reference for function search_public_collections()

do_collections_search()

Developer reference for function do_collections_search()

get_saved_searches()

Developer reference for function get_saved_searches()

add_saved_search()

Developer reference for function add_saved_search()

remove_saved_search()

Developer reference for function remove_saved_search()

get_search_title()

Developer reference for function get_search_title()

add_saved_search_items()

Developer reference for function add_saved_search_items()

collection_is_research_request()

Developer reference for function collection_is_research_request()

search_array_by_keyvalue()

Developer reference for function search_array_by_keyvalue()

render_search_field()

Developer reference for function render_search_field()

send_research_request()

Developer reference for function send_research_request()

get_research_requests()

Developer reference for function get_research_requests()

get_research_request()

Developer reference for function get_research_request()

save_research_request()

Developer reference for function save_research_request()

get_research_request_collection()

Developer reference for function get_research_request_collection()

set_research_collection()

Developer reference for function set_research_collection()

get_advanced_search_fields()

Developer reference for function get_advanced_search_fields()

get_advanced_search_collection_fields()

Developer reference for function get_advanced_search_collection_fields()

search_form_to_search_query()

Developer reference for function search_form_to_search_query()

refine_searchstring()

Developer reference for function refine_searchstring()

compile_search_actions()

Developer reference for function compile_search_actions()

search_filter()

Developer reference for function search_filter()

search_special()

Developer reference for function search_special()

rebuild_specific_field_search_from_node()

Developer reference for function rebuild_specific_field_search_from_node()

search_get_previews()

Developer reference for function search_get_previews()

get_default_search_states()

Developer reference for function get_default_search_states()

get_simple_search_fields()

Developer reference for function get_simple_search_fields()

get_fields_for_search_display()

Developer reference for function get_fields_for_search_display()

update_search_from_request()

Developer reference for function update_search_from_request()

get_search_default_restypes()

Developer reference for function get_search_default_restypes()

render_advanced_search_buttons()

Developer reference for function render_advanced_search_buttons()

log_search_event()

Description Log search events Parameters Column Type Default Description $search string Actual search string {@see do_search()} $resource_types array Resource types filter $archive_states array Archive states filter $result_count integer Search result count Return void This article was last updated 17th November 2024 20:35 Europe/London time based on the source file dated 10th September 2024 17:30 Europe/London time.

process_node_search_syntax_to_names()

Description Process one of the columns whose value is a search string containing nodes (e.g @@228@229, @@555) and mutate input array by adding a new column (named $column + '_node_name') which will hold the nodes found in the search string and their translated names Parameters Column Type Default Description $R array Generic type for array (e.

get_search_params()

Description Get all search request parameters. Note that this does not escape the parameters which must be sanitised using e.g. htmlspecialchars() or urlencode() before rendering on page Parameters This function accepts no parameters.

search_title_node_processing()

Description Convert node searches into a friendly syntax. Used by search_title_processing.php Parameters Column Type Default Description $string string Search string Return string Location include/search_functions.

get_dash_search_data()

Description Get images and resource count for search dash tile. This has to work on a string because the dash tile does not yet exist when on dash creation page For performance this function will return a maximum of 4 images Parameters Column Type Default Description $link string '' Tile link URL $promimg int 0 Promoted image ref Return array $searchdata Array containing the count of resources and details of preview images.

update_node_hitcount_from_search()

The article provides information about the function "update_node_hitcount_from_search()" in the resource_functions.php file of ResourceSpace. The function is used to increment the hit count for each node that has been used in a search for a specified resource.

setup_search_chunks()

The function `setup_search_chunks()` allows `$fetchrows` to support an integer or array. If an integer is supplied, the search will receive the number of rows with no offset. If an array is supplied, the search will receive the number of rows to return and an offset, allowing for chunking of results.

check_upload_terms()

The check_upload_terms() function is used to verify if the terms have been accepted for a given upload. The terms only need to be accepted when uploading through an upload share link, and if so, the accepted terms are stored in $_COOKIE["acceptedterms"].

set_search_order_by()

Description Validate and set the order_by for the current search from the requested values passed to do_search() Parameters Column Type Default Description $search string $order_by string $sort: string $sort string Return string * Location include/search_functions.

build_specialsearch_list_urls()

Description Limit the length of !list special search url by adding a maximum of 650 characters of resource references per link including separators. Mail servers may break very long text strings into multiple lines and this will cause the special search to fail.

Editing a collection

This article explains how to edit a collection in a resource management system. The edit screen provides several options, including customising the name of the collection, adding a description, and attaching tags to help find the collection of resources.

Reports

ResourceSpace offers a reporting section that allows users to access information about downloads, uploads, and views. The reporting section provides a detailed table structure that can be downloaded as a CSV file for spreadsheet software or viewed directly in the browser.

MuseumPlus

MuseumPlus is a web-based museum management system that provides real-time museum management and fully documents any type of collection and all related workflow. The system can be integrated with ResourceSpace, a digital asset management system, through its API.

Further videos

The article provides a list of videos that cover various topics related to using the ResourceSpace digital asset management system. The videos cover topics such as creating users, customizing the homepage slideshow, search filters, sharing resources, and more.

The Complete Guide to Metadata

Metadata is data that provides information about other data, without describing the content of that data. It is crucial for digital assets and is used to categorize and describe various types of files, such as documents, videos, and audio files.

Upload here

ResourceSpace has introduced a new feature called "Upload here" that helps users create new resources based on a recent advanced search. The feature directs users to the upload page where the options will have been automatically selected, meaning they can easily add more resources that this metadata set describes.

Creating and editing filters

Creating and editing filters. Filters can be set to control access to resources

User guides

Introduction to the user guides section of the ResourceSpace Knowledge Base

Resources and structure

Article to explain the concept of Resources and how they are structured with ResourceSpace Digital Asset Manager

Collections, public collections and featured collections

ResourceSpace allows resources to be tagged with various metadata, eliminating the need for a traditional hierarchical folder structure. This means that a resource can exist in multiple collections and can be found through metadata searches.

Metadata

ResourceSpace Digital Asset Management System uses embedded and user inserted metadata to describe and track your resources

Fixed list metadata

Article in the ResourceSpace Knowledge Base explaining Concepts about Fixed List Metadata.

Accounts & access

A ResourceSpace Knowledge Base article explaining user accounts and access within ResourceSpace for users.

Uploading

Uploading files into ResourceSpace is a very simple process, however it is at this stage that you will be adding the metadata that ensures your resources can found and used effectively. It is key that you put as much relevant metadata into the resource fields as possible now to make your contributions as valuable as they can be.

Featured & public collections

Featured Collections are a way to showcase the best and most in-demand content. They can contain a select number of resources and encourage users to browse content by directing them to relevant tags or ideas.

Resource tools

The article discusses the various resource tools available in the resource downloads area of the resource view page. These tools allow users to download, view, and request resource files, as well as perform actions such as adding to a collection or sharing.

Alternative files

Alternative files are a feature in ResourceSpace that allows users to store multiple versions of a resource together with a single set of metadata. This is useful when there are different variations of a resource that need to be easily accessible from a single point.

Editing multiple resources

The article explains how to edit multiple resources in ResourceSpace using batch editing. Batch editing allows users to apply the same change to multiple resources at once, ensuring continuity. To perform a batch edit, users need to add the selected resources to a collection and then choose "Edit all resources" from the collection actions list.

Resource status & access

Resource status and access are important factors in controlling how users interact with resources in ResourceSpace. The status of a resource determines whether it can be found or edited by users, while the access controls which users can download the resource.

Deleting resources

The article provides instructions on how to delete resources in ResourceSpace, a digital asset management system. There are two methods described: deleting resources individually and batch deleting resources.

Related resources

The article explains how resources can be related to each other in order to group similar or mutually relevant resources. There are three ways to relate resources: relating all resources in a collection, manually relating resources by editing each resource individually, and relating resources on upload.

Creating collections

The article explains how to create collections in ResourceSpace, a digital asset management system. Collections can be created in three ways: when uploading resources, from the collection bar, or from the "manage my collections" section.

Collection options

There is a list of options available to you from the collection actions dropdown menu. This menu is present in the collection bar and from the "Manage My Collections" page, as well as on the search page when viewing resources in a collection.

PDF contact sheet

The article explains how to create a PDF contact sheet for a collection in ResourceSpace. A contact sheet is a quick reference overview of what is in a collection, which can be printed or downloaded. To create a contact sheet, users need to choose the "Contact Sheet" option in the collection Actions list.

Keyboard controls

ResourceSpace offers keyboard controls to help advanced users speed up their use of the platform. These controls can be customised system-wide but are not currently available for per-user customisation.

Refine results

The article discusses the addition of a filter bar above search results to allow for further filtering within the result set. This feature allows users to type in more relevant keywords and extra information into the "further results" field to keep filtering results.

Creating dash tiles

Dash tiles are a great way of creating shortcuts to your favourite things in ResourceSpace.

Managing dash tiles

This article explains how to manage dash tiles in ResourceSpace. Dash Administrators can create tiles for all users or selected user groups, and reorder the tiles for those users who cannot manage their own dash.

Useful user permissions

The article provides an overview of user group permissions and how they affect user actions when accessing and interacting with resources. The permissions are divided into different categories, including searching/access, metadata fields, resource types, resource creation/management, collections, and administration.

Batch replace

ResourceSpace has a batch replace functionality that allows users to update multiple resources at once. This feature is useful for replacing original files and regenerating previews of any number of resources.

Resource types

Resource types are a key way to organise metadata in ResourceSpace, allowing users to record different metadata for different types of assets. Resource types can be created as needed, and separating resources into types allows users to apply certain media-specific fields only where they will be useful, saving time and effort.

Creating a resource type

This article provides instructions on how to create a new resource type in MODX. To create a new resource type, users need to browse to "Admin > System > Resource types", enter the name of the new resource type, click "Create", fill in the rest of the form as required, and click "Save".

Managing metadata

The article discusses the importance of managing metadata in a system to make searching for resources faster, easier and more intuitive. The article suggests that metadata should be descriptive, clear and complete to ensure that users can search effectively and get the best out of using the system.

Understanding resource metadata

Metadata is essential for describing resources and forms the basis of search. When a resource is uploaded into ResourceSpace, it is tagged with words or phrases that best describe the asset. These tags form the resource metadata and are how users search for the resources they need.

Creating and deleting metadata fields

The article provides guidance on creating and deleting metadata fields in ResourceSpace. Metadata fields should be clear and descriptive, and the right data should be stored in the right field type to achieve this.

Metadata field types

This article provides a list of metadata field types that can be used to capture data in an appropriate form for communicating to users what it represents. The list includes text boxes for single-line, multi-line, large multi-line, and formatted text, as well as check box lists, drop-down lists, radio buttons, and date fields.

Configuring category trees

The category tree field type is useful for selecting metadata tags from a nested tree, particularly where resource subjects follow a hierarchical classification, such as product taxonomy or projects within campaigns.

Modifying field options

The article explains how to modify field options in fixed list metadata fields in ResourceSpace. Users can add, remove or edit options by editing the field and selecting the "manage options" link. To add a new option, users can enter the name of the tag and click "Add".

Ordering metadata fields

Metadata fields can be ordered to determine where they appear on search, edit and upload pages. Global fields are placed first, followed by resource type-specific fields in a collapsible section below.

Advanced metadata field configuration

This page covers the advanced options for metadata field configuration including display templates, smart featured collections, display conditions, autocomplete options and additional settings for ExifTool and IPTC metadata.

Indexing metadata

ResourceSpace has announced that from version 10.1, indexing of text fields will be limited to the first 500 characters of text. This change is being made to enable ResourceSpace to quickly search resource metadata, rather than the full file contents.

Related keywords

The article explains how to manage related keywords in a website's admin panel. This feature allows creating relationships between search terms so that a search for one will also return resources that have the other keyword present in their metadata.

Creating user groups

This article provides information on how to create user groups in ResourceSpace. The default user groups in ResourceSpace are Administrators, Archivist, General users, Restricted user, and Super Admin.

Creating users

This article provides a step-by-step guide on how to create a user account in a system. It explains that user accounts require user groups to be created first, as user permissions and configuration settings are managed in the groups.

Useful user tools

ResourceSpace provides several user management tools to help with the user configuration process. The first tool is resetting passwords, which can be done by browsing to Admin > Users, editing the user, entering a password into the password field or clicking "Suggest" to generate one, and clicking Save.

Advanced user group options

The article explains the advanced user group options available in ResourceSpace. These options are hidden by default to make the user group page easier to use, but they can be accessed by clicking on the "Advanced options" header above the save button.

Edit filters

Edit filters are used to determine if users in a group can edit resources based on the metadata in the resource. The existing 'e0' (or e1, e2 etc.) permissions must be used first to open up edit access.

Derestrict filters

The article discusses the use of derestrict filters in ResourceSpace, which allows users to access resources that would normally be restricted to them. This feature is useful when some users need to access only a few resources within the system while being completely restricted from all others.

Writing your own plugins

A plugin in ResourceSpace is a collection of PHP code, language files, graphics, CSS files and other related files that are structured to conform to the ResourceSpace plugin architecture. For deployment, the files that constitute a plugin are packaged together into a self-contained file called a ResourceSpace Plugin (.

Adding resources to a collection

This article explains the different ways to add resources to a collection in a learning management system. Resources can be added to multiple collections at any given time. The first way to add resources is during upload, where the resources can be added to an existing or new collection.

CSV upload

The CSV upload plugin for ResourceSpace allows users to edit existing resource metadata and create new resources by uploading a CSV file. The plugin is recommended for administrators and users with elevated permissions due to the risk of inserting incorrect data into ResourceSpace.

Advanced workflow

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

KE EMu database integration

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

API

ResourceSpace implements a RESTful API that returns JSON. All requests must be signed using a shared private key specific to each user. This can be performed via GET or POST.

get_resource_path

The get_resource_path function returns a URL or file path for a resource file. It takes several parameters, including the ID of the resource or an array of resource IDs, a flag indicating whether a file path should be returned instead of a URL, the size of the requested file, and whether the path should be generated if it does not yet exist on disk.

Installation overview

The article provides an overview of the installation process for ResourceSpace, a standard PHP/MySQL application. The installation process is similar to other PHP/MySQL applications, and most issues encountered relate to the default php.

Customising the top level navigation

This article provides instructions on how to customise the top-level navigation in ResourceSpace. To add additional top navigation links, users can enter the code in the config.php file or in "Config Override" if setting this on a per-group basis.

Creating custom reports

ResourceSpace allows users to create custom reports by writing SQL queries. Reports can be created in Admin > System > Reports, and existing reports can be viewed and edited from the same location. Users can create reports that show resources pending submission, and reports that allow date range selection.

Configuring for multi-client use

The article provides a method for setting up ResourceSpace as an environment where multiple users can use the system, but their resources remain private from each other. The method involves creating a new global field called 'client' that can be attached to all types of resources.

Watermarks

ResourceSpace allows users to enable watermarks on preview images generated for each resource. To enable watermark preview generation, users need to add the following to their config.php: $watermark = "gfx/watermark.

Translations

The article provides a guide on how to create an official standard translation and a custom translation for a system. Before starting an official translation, it is important to verify that no other translator is already working with the language.

Simple LDAP

The Simple LDAP plugin enables consistent sign-on (CSO) for ResourceSpace users, allowing them to log in using the same credentials they use to log in to their organisation's network. The plugin has been tested with Microsoft Active Directory and Oracle Directory servers.

Antivirus

The antivirus plugin for ResourceSpace allows the platform to check every file uploaded to see if it is a known virus. The plugin can be configured to work with any antivirus that has a command line interface, and has been tested with ClamAV and Sophos.

Metadata read/write mapping

ResourceSpace can map between embedded metadata stored in original files and the metadata fields in ResourceSpace itself. This synchronisation can be two-way, so that imported metadata can be automatically extracted into a configured field, but also that metadata added to the resource after import is written back to the file at download.

CSV user import

The CSV user import plugin allows administrators to create user accounts in bulk based on information stored in a CSV file. The CSV file must be encoded in UTF-8 format and without BOM, and should have text cells quoted in case they contain commas or other special characters.

Falcon link

The Falcon Link plugin allows users to publish resources as templates in Falcon.io. However, users must have an account with Falcon.io to use this plugin. The plugin creates a share link with no expiration date instead of copying the file itself when a resource is published to Falcon.

Basic metadata field configuration

This article provides an overview of the basic options for metadata field configuration in ResourceSpace. The article covers the following options: Enabled, Required, Index, Display full width on view page, Display field, Enable advanced search, Enable simple search, May contain personal data, Hide when uploading, and Hide when restricted.

IIIF

IIIF is an API specification that aims to improve interoperability between digital image repositories. ResourceSpace provides basic support for the IIIF presentation API, which was originally created to link with the TMS plugin to enable publishing of resources related to a specified TMS object as a IIIF manifest.

Geolocation

This article provides instructions on how to add location data to a resource on a website. Users can add a location to a resource by clicking on the 'Add location' button on the resource view page and setting the marker for the location on the map that appears.

Alternative installation

ResourceSpace offers alternative installation options for users who are unfamiliar with installing applications or unable to install ResourceSpace on their server. One-click installers are available for Windows, Linux, and OS X, which are self-contained packages with everything needed to run ResourceSpace.

Customising the interface colours, logo and favicon

This article explains how to customise the interface colours, logo and favicon in a system. To do this, navigate to Admin -> System -> System configuration and open the User interface section. From there, you can change the colours for various areas of the system by ticking the check box next to each description and choosing a colour from the colour picker that appears.

Resources not showing for a given user group

The article discusses the possible reasons why a resource may not be visible to some users, while it is visible to others. The reasons could be related to permissions, such as whether the user has access to the workflow state the resource is in or whether the user can see the resource type.

User opt-in consent

The article discusses the configuration option for user opt-in consent, which is enabled by default in certain data protection regulations such as the General Data Protection Regulation (GDPR). The configuration option requires users to give consent for their personal data to be processed before they can submit an account request.

Image banks

The Image Banks plugin allows users to search external image banks for photos without having to navigate manually to the external system. Users can run searches in the external image bank using the simple search box and the dropdown selector called "Search external image banks".

What file formats can be uploaded to ResourceSpace?

ResourceSpace allows any type of file to be uploaded except for banned extensions such as php, cgi, pl, exe, asp, jsp, sh, and bash. The list of banned extensions can be changed using the config option $banned_extensions.

Smart collections

Smart collections are a new feature that can be enabled in a system by using the config option $allow_smart_collections. Once enabled, a new option will appear in the Actions drop-down menu on the Search page, allowing users to save a search as a smart collection.

All user permissions

ResourceSpace is a digital asset management system that allows users to control which resources other users can see and how they can interact with them. The system offers a range of permission options, including search, metadata fields, resource types, resource creation, featured collections, restrictive permissions, and administration.

CSV export

ResourceSpace allows users to extract metadata from its database as a CSV file, which can be opened in most standard spreadsheet or database programs. The metadata fields included in the CSV file can be customised by editing metadata fields and enabling the "Include in CSV export" option.

Browse bar

ResourceSpace has introduced a browse bar to help users find resources more easily. The bar is a collapsible side tab available from all pages, offering the options to search by resource type, tag, collection or workflow state.

Coding standards v2.0

The article provides coding standards for developers working on the ResourceSpace project. The standards cover various aspects of coding, including security, documentation, functionality, PHP version, MySQL strict mode, backward compatibility, file format, coding style, indentation, line length, control structures, function calls, function definitions, MySQL statements, readability of code blocks, returning early, and avoiding cross-site scripting vulnerabilities.

1. Finding your way around

An overview of the ResourceSpace user interface.

2. Uploading and editing

We can simply drag and drop the files or an entire folder directly from our computer on to the upload queue.

4. Sharing and collections

Sharing single resources is very straightforward. We can send the resource to other users of the system, but we can also enter e-mail addresses and share with people that are not users of the system. They receive a special link that allows them to access only the resource you've shared with them.

6. Dash tiles

Collections can be published as dash tiles. The dash is an area on the home page to which users can add their own custom tiles.

7. Reporting

ResourceSpace include comprehensive reporting and analytics capabilities.

File integrity checking

ResourceSpace has a tool to verify the file integrity of primary resource files, which notifies users of any corruption and allows them to take remedial action. To configure the system to check file integrity, users need to have full file checksums configured, the ResourceSpace cron script configured to run frequently as a cron task or scheduled task, and the file integrity verify window enabled to set the hours between which the script will run.

Debugging ResourceSpace

The article provides three methods for debugging ResourceSpace, an open-source digital asset management system. The first method is to use the internal function called debug(), which writes debug text to a file specified in the config file.

Checksums

Checksums are a sequence of numbers and letters that are produced by running a file through an algorithm that uses a cryptographic hash to create a unique identifier. Even the slightest change in the original file will produce a different checksum, making them useful for ensuring file integrity and preventing resource duplication.

ResourceSpace Plugins

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

Vimeo publish

The Vimeo Publish plugin allows users to publish video resources to a configured Vimeo account. The plugin uploads data and has configurable mapped fields to automatically add descriptions, titles, and tags.

Usage history

ResourceSpace, the open source digital asset management software, is logging every time a user downloads a resource from the system, even one of its available sizes. By default, this is not shown on the view page of a resource, but there are configuration options which can change this behaviour.

Database schema

Database schema for ResourceSpace.

Fixed list fields

ResourceSpace has various metadata field types, including text boxes, check box lists, dropdown lists, date fields, category trees, and radio button lists. Some of these fields can have their options defined by an administrator of the system, and these fields are called fixed list fields.

Downloading multiple resources

Users can download multiple resources in one go by adding the resources to a collection or selecting a number of resources from the search results page and clicking on 'Download' from the 'Actions' dropdown box.

ResourceSpace plugin for WordPress

A new WordPress plugin has been developed that allows users to embed resource files from ResourceSpace in their posts. The plugin was funded by ADRA International and developed by Codecide. To install the plugin, users should download the WordPress plugin zip file, navigate to Plugins->Add plugins from the WordPress Admin menu and click 'Upload plugin', or manually upload the zip file to the wp-content/plugins directory of the WordPress installation.

Sensitive image blurring

The sensitive image blurring plugin can blur selected images from users both in the results and on the resource view page. The plugin can be configured by enabling it and choosing a desired field for the "sensitive message" in the plugin's options page.

Extracted text

ResourceSpace, a digital asset management software, can extract text from document files and use it to populate metadata fields. This feature enables users to search for resource contents within the system and by applied metadata tags.

Sharing upload links

ResourceSpace has introduced a new feature that allows users to share upload links externally. This feature enables external media creators to upload files into ResourceSpace without requiring an account.

RSS Feed

The RSS Feed plugin generates RSS URLs for a resource search in ResourceSpace using the API. After enabling the plugin, a new link appears at the bottom of the Simple Search area, which takes the user to the RSS feed for the 50 most recently uploaded resources.

get_users

The article provides information on the get_users function, which is used to retrieve a list of users. The function honours permissions, so users from other groups to which the user does not have access will be omitted.

Configuring Leaflet Maps

This article provides a guide to configuring Leaflet maps in ResourceSpace. The article lists several configuration options that can be used to add tile sources and customize how geolocation data is displayed.

User preferences

The article provides instructions on how to access user preferences on a website. Users can click on the user profile icon at the top right of the screen and select "Preferences" to make changes to the functionality and interface available to them.

Consent manager

Adds the capability to manage resource licensing via the resource view page.

Mobile responsive mode

ResourceSpace, the open source digital asset management software, is now available on mobile devices. The software's interface automatically adjusts to account for the smaller screen, but the functionality remains the same.

get_system_status

The get_system_status API provides system status information, which is configuration-dependent, such as mysql_log_transactions. The API does not require any parameters. The API returns a JSON object that contains the system status information.

User actions

User actions are now enabled for all users by default, unless disabled by a system administrator. Actions alert users to resources or activities that require their attention, and the actions visible to a user will vary depending on system configuration and user permissions.

The Digital Asset Management Buyer's Guide

In this guide we look at what DAM software actually is, the problems it solves and some questions to ask a vendor before making a buying decision.

Integrating with BrandStencil

Instantly create marketing materials from templates using your DAM images thanks to ResourceSpace's integration with BrandStencil.

Sending user notifications

The article provides guidance on sending user notifications in ResourceSpace. Before version 10, developers had to make several checks before calling send_mail() or message_add() whenever required, resulting in duplicated code and inconsistency.

Integrating ResourceSpace with RightMarket

Create branded marketing materials, including posters, social graphics or point of sale materials, with ResourceSpace's RightMarket integration.

Prepared statements

ResourceSpace, an open-source digital asset management software, has announced that all new code must use prepared statements for any SQL execution. The new functions ps_query(), ps_array() and ps_value() replace functions sql_query(), sql_array() and sql_value() respectively.

Push metadata

The article explains how to display related resources alongside resource metadata on the resource view page. By default, related resources appear as thumbnails in a panel located below the resource metadata.

OpenAI GPT

OpenAI's GPT language model has been integrated into ResourceSpace, a digital asset management system, to automate metadata processing tasks. The plugin allows users to use GPT to populate metadata fields based on data stored in another field.

The System Configuration page

The System Configuration Page is a feature in Moodle that can be accessed via the administration menu System category. It allows users to configure many system-wide properties, such as the default system language, timezone, and the appearance of the system.

What is Digital Asset Management?

A Digital Asset Management system is critical component of your organisation's tech stack. Explore the benefits of DAM, its use cases, and how it streamlines asset management.

Do you need a Digital Asset Management system? Find out here.

A Digital Asset Management (DAM) system can help organizations overcome various challenges related to managing digital assets. These challenges may include difficulties in finding specific files, using outdated assets, licensing and copyright issues, and sharing large files with external contacts.

User rating of resources

ResourceSpace has a star rating feature that allows each user to give resources a rating of between one and five stars. User rating of resources can be enabled by super admins in the configuration area via admin, system, configuration, user accounts and enabling "user rating of resources".

get_resource_type_fields

The "get_resource_type_fields" function allows users to retrieve metadata field information for all matching fields. This function is available from version 10.3+ and requires permission "a". Users can filter the results by resource type, fuzzy searching, and field type.

A Comprehensive Guide to Digital Curation: Tools and Techniques

Explore digital curation: key tools and techniques for preserving significant cultural assets.

How do I delete resources from the system permanently?

To permanently delete resources from ResourceSpace, follow these steps: 1. Add the resources you want to remove to your collection. 2. From the "Actions" menu, choose "Delete all resources". 3. This action will move the resources to the "Deleted" workflow state.

How do I change the welcome message?

The article discusses how to change the welcome message on a website or application. It explains that the welcome message is the first thing users see when they visit a website or open an app, and it sets the tone for their experience.

How do I change my font/colours/logo?

The article provides instructions on how to change the font, colors, and logo in a system. To change the system font, the user needs to navigate to the Admin > System > Configuration section and select a preset font from the Font dropdown or upload a custom font file.

Can I change which fields are shown in List view?

The article explains that most metadata fields can be added as column headings in list view on the search results page. This can be done through configuration in the back end of the system. If the user has a support contract, they can ask their account manager to set it up for them.

How do I edit multiple resources at the same time?

To edit multiple resources at the same time in ResourceSpace, you can add the selected resources to a collection and then choose "Edit all resources" from the collection actions menu. Alternatively, you can edit resources directly from the search results page by selecting the checkbox next to each resource or using Shift + click to select multiple resources before clicking on the "Edit selected" button.

LinkrUI for Adobe

LinkrUI for Adobe is a Connector plugin that integrates ResourceSpace with Adobe software such as Photoshop, Illustrator, InDesign, Premiere Pro, and After Effects. This integration allows users to easily search, open, and place assets stored in ResourceSpace directly into their Adobe applications.

How do I delete resources? Is there a batch delete option?

To delete resources, single resources can be deleted by selecting 'Delete' from the resource preview. For multiple resources, add them to a collection and choose 'Delete all resources' from the collection menu.

CSP frame-ancestors

The article discusses the use of CSP frame-ancestors to specify which sites can embed a ResourceSpace page using certain HTML tags. To enable this feature, the configuration option $csp_frame_ancestors needs to be set as an array of valid parent URLs.

Managing files with Microsoft SharePoint? You could do more with DAM

Is your organisation still using Microsoft SharePoint for digital asset management? You could do so much more with a dedicated DAM system.

Table: collection

This article provides a table that outlines the structure of a collection in ResourceSpace, which is a group of resources. The table includes columns such as ref, name, user, created, public, theme, theme2, theme3, allow_changes, cant_delete, keywords, savedsearch, home_page_publish, home_page_text, home_page_image, session_id, description, type, parent, thumbnail_selection_method, bg_img_resource_ref, and order_by.

Table: collection_keyword

The collection_keyword table is a join table that connects collections with keywords to enable rapid collection searching. It contains two columns: collection and keyword, both of which are of type int(11).

Table: dash_tile

The article provides a table schema for the "dash_tile" table, which is used to display dash tiles on the home page. The table contains columns such as "ref" for an auto-incrementing index, "title" for the title text, "txt" for the tile text, "all_users" to indicate if the tile is published to all users, "default_order_by" for the default order, "url" for the anchor link href URL, "link" for the link text, "reload_interval_secs" for the reload interval in seconds, "resource_count" to indicate the number of resources if the tile is a search/collection tile, and "allow_delete" to indicate if the tile can be deleted.

Table: filter

This article provides a table definition for the "filter" table, which is used for search, edit, and derestrict filters on user groups. The table has three columns: "ref," which is an auto-incrementing index; "name," which is the name of the filter; and "filter_condition," which defines which rules must be met to satisfy the filter.

Table: keyword

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 13661 tokens. Please reduce the length of the messages.

Table: keyword_related

The "keyword_related" table defines related keywords in ResourceSpace. When a keyword is searched for, related keywords are also searched for. The table has two columns: "keyword" and "related". The "keyword" column is of type int(11) and refers to the "keyword" table.

Table: node_keyword

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 12343 tokens. Please reduce the length of the messages.

Table: report

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 4846 tokens. Please reduce the length of the messages.

Table: report_periodic_emails

The report_periodic_emails table is a database table in ResourceSpace that stores information about users who have subscribed to receive a report regularly. The table has several columns, including ref, user, send_all_users, user_groups, report, period, email_days, last_sent, and search_params.

Table: resource

The article provides a table of the resource, which is the central record within ResourceSpace mapping to a single asset/file. The table includes various columns such as ref, title, resource_type, has_image, is_transcoding, hit_count, new_hit_count, creation_date, rating, user_rating, user_rating_count, user_rating_total, country, file_extension, preview_extension, image_red, image_green, image_blue, thumb_width, thumb_height, archive, access, colour_key, created_by, file_path, file_modified, file_checksum, request_count, expiry_notification_sent, preview_tweaks, geo_lat, geo_long, mapzoom, disk_usage, disk_usage_last_updated, file_size, preview_attempts, modified, last_verified, integrity_fail, and lock_user.

Table: resource_keyword

The article provides information about the "resource_keyword" table, which is used to store indexed keywords for free text metadata. The table has six columns, including "resource," which is a foreign key referencing the "resource" table, and "keyword," which is a foreign key referencing the "keyword" table.

Table: resource_node

The resource_node table in ResourceSpace links fixed metadata nodes with resources to store metadata for fixed metadata types such as dropdowns. The table has three columns: resource, node, and hit_count.

Table: resource_type

This article provides a table of the resource_type database schema used in ResourceSpace, a digital asset management system. The resource_type table contains information about the types of resources, such as photo, video, or case study, and determines the metadata fields that a resource has.

Table: resource_type_field

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 10794 tokens. Please reduce the length of the messages.

Table: user

The "user" table in ResourceSpace stores all user information, including their username, password, full name, email address, user group, and last activity date. It also includes information on whether the user is currently logged in, their browser user agent string, and their IP address.

Table: usergroup

The article provides a table called "usergroup" that defines user groups. The table contains several columns, including "ref," which is an auto-incrementing index, "name," which is the name of the user group, and "permissions," which is a list of permissions that the user group has.

compile_collection_actions()

Developer reference for function compile_collection_actions()

str_highlight()

Developer reference for function str_highlight()

Custom fields ("user" defined)

ResourceSpace, a digital asset management system, allows users to configure custom fields. These fields can be used to add additional metadata to assets, such as images or documents, and can be used to filter and search for specific assets.

get_user_actions()

Developer reference for function get_user_actions()

get_editable_resource_sql()

Developer reference for function get_editable_resource_sql()

ajax_response_ok()

Developer reference for function ajax_response_ok()

getAnnotations()

Developer reference for function getAnnotations()

getAnnotationTags()

Developer reference for function getAnnotationTags()

iiif_get_canvases()

Developer reference for function iiif_get_canvases()

get_user_collections()

Developer reference for function get_user_collections()

get_collection_resources()

Developer reference for function get_collection_resources()

add_resource_to_collection()

Developer reference for function add_resource_to_collection()

collection_writeable()

Developer reference for function collection_writeable()

create_collection()

Developer reference for function create_collection()

delete_collection()

Developer reference for function delete_collection()

save_collection()

Developer reference for function save_collection()

get_themes()

Developer reference for function get_themes()

email_collection()

Developer reference for function email_collection()

add_smart_collection()

Developer reference for function add_smart_collection()

allow_multi_edit()

Developer reference for function allow_multi_edit()

get_theme_image()

Developer reference for function get_theme_image()

send_collection_feedback()

Developer reference for function send_collection_feedback()

get_collection_videocount()

Developer reference for function get_collection_videocount()

collection_max_access()

Developer reference for function collection_max_access()

collection_min_access()

Developer reference for function collection_min_access()

is_collection_approved()

Developer reference for function is_collection_approved()

show_hide_collection()

Developer reference for function show_hide_collection()

comments_show()

Developer reference for function comments_show()

generateResourcesMetadataCSV()

Developer reference for function generateResourcesMetadataCSV()

get_default_dash()

Developer reference for function get_default_dash()

allow_tile_colour_change()

Developer reference for function allow_tile_colour_change()

get_stats_activity_types()

Developer reference for function get_stats_activity_types()

get_all_site_text()

Developer reference for function get_all_site_text()

rs_quoted_printable_encode()

Developer reference for function rs_quoted_printable_encode()

tail()

Developer reference for function tail()

job_queue_get_jobs()

Developer reference for function job_queue_get_jobs()

findDuplicates()

Developer reference for function findDuplicates()

i18n_get_translated()

Developer reference for function i18n_get_translated()

i18n_get_collection_name()

Developer reference for function i18n_get_collection_name()

str_replace_formatted_placeholder()

Developer reference for function str_replace_formatted_placeholder()

ucfirstletter()

Developer reference for function ucfirstletter()

get_activity_log()

Developer reference for function get_activity_log()

perform_login()

Developer reference for function perform_login()

message_send_unread_emails()

Developer reference for function message_send_unread_emails()

getFitsMetadataFieldValue()

Developer reference for function getFitsMetadataFieldValue()

migrate_filter()

Developer reference for function migrate_filter()

get_export_tables()

Developer reference for function get_export_tables()

get_root_node_by_leaf()

Developer reference for function get_root_node_by_leaf()

reorder_nodes()

Developer reference for function reorder_nodes()

draw_tree_node_table()

Developer reference for function draw_tree_node_table()

get_node_by_name()

Developer reference for function get_node_by_name()

get_node_id()

Developer reference for function get_node_id()

get_tree_strings()

Developer reference for function get_tree_strings()

get_pdf_template_path()

Developer reference for function get_pdf_template_path()

generate_pdf()

Developer reference for function generate_pdf()

display_rsc_upload()

Developer reference for function display_rsc_upload()

render_sort_order()

Developer reference for function render_sort_order()

render_actions()

Developer reference for function render_actions()

render_split_text_question()

Developer reference for function render_split_text_question()

display_field()

Developer reference for function display_field()

render_date_range_field()

Developer reference for function render_date_range_field()

renderBreadcrumbs()

Developer reference for function renderBreadcrumbs()

render_resource_image()

Developer reference for function render_resource_image()

render_upload_here_button()

Developer reference for function render_upload_here_button()

render_selected_resources_counter()

Developer reference for function render_selected_resources_counter()

render_edit_selected_btn()

Developer reference for function render_edit_selected_btn()

render_clear_selected_btn()

Developer reference for function render_clear_selected_btn()

render_selected_collection_actions()

Developer reference for function render_selected_collection_actions()

has_browsebar()

Developer reference for function has_browsebar()

display_field_data()

Developer reference for function display_field_data()

EditNav()

Developer reference for function EditNav()

do_report()

Developer reference for function do_report()

create_periodic_email()

Developer reference for function create_periodic_email()

send_periodic_report_emails()

Developer reference for function send_periodic_report_emails()

email_collection_request()

Developer reference for function email_collection_request()

managed_collection_request()

Developer reference for function managed_collection_request()

get_valid_custom_fields()

Developer reference for function get_valid_custom_fields()

process_custom_fields_submission()

Developer reference for function process_custom_fields_submission()

put_resource_data()

Developer reference for function put_resource_data()

create_resource()

Developer reference for function create_resource()

save_resource_data_multi()

Developer reference for function save_resource_data_multi()

add_keyword_mappings()

Developer reference for function add_keyword_mappings()

update_field()

Developer reference for function update_field()

get_resource_field_data()

Developer reference for function get_resource_field_data()

get_resource_field_data_batch()

Developer reference for function get_resource_field_data_batch()

get_resource_top_keywords()

Developer reference for function get_resource_top_keywords()

notify_user_contributed_submitted()

Developer reference for function notify_user_contributed_submitted()

notify_user_contributed_unsubmitted()

Developer reference for function notify_user_contributed_unsubmitted()

get_field()

Developer reference for function get_field()

get_resource_access()

Developer reference for function get_resource_access()

resource_download_allowed()

Developer reference for function resource_download_allowed()

check_use_watermark()

Developer reference for function check_use_watermark()

notify_user_resources_approved()

Developer reference for function notify_user_resources_approved()

get_original_imagesize()

Developer reference for function get_original_imagesize()

resource_type_config_override()

Developer reference for function resource_type_config_override()

copy_locked_fields()

Developer reference for function copy_locked_fields()

download_link_generate_key()

Developer reference for function download_link_generate_key()

update_resource_keyword_hitcount()

Developer reference for function update_resource_keyword_hitcount()

get_hidden_indexed_fields()

Developer reference for function get_hidden_indexed_fields()

get_OR_fields()

Developer reference for function get_OR_fields()

get_resource_type_fields()

Developer reference for function get_resource_type_fields()

add_verbatim_keywords()

Developer reference for function add_verbatim_keywords()

get_resource_type_from_extension()

Developer reference for function get_resource_type_from_extension()

resolve_soundex()

Developer reference for function resolve_soundex()

suggest_refinement()

Developer reference for function suggest_refinement()

resolve_nodes_from_string()

Developer reference for function resolve_nodes_from_string()

get_upload_here_selected_nodes()

Developer reference for function get_upload_here_selected_nodes()

get_filter_sql()

Developer reference for function get_filter_sql()

split_keywords()

Developer reference for function split_keywords()

cleanse_string()

Developer reference for function cleanse_string()

resolve_keyword()

Developer reference for function resolve_keyword()

add_partial_index()

Developer reference for function add_partial_index()

highlightkeywords()

Developer reference for function highlightkeywords()

sorthighlights()

Developer reference for function sorthighlights()

get_suggested_keywords()

Developer reference for function get_suggested_keywords()

get_related_keywords()

Developer reference for function get_related_keywords()

get_grouped_related_keywords()

Developer reference for function get_grouped_related_keywords()

save_related_keywords()

Developer reference for function save_related_keywords()

get_filters()

Developer reference for function get_filters()

get_filter()

Developer reference for function get_filter()

get_filter_rules()

Developer reference for function get_filter_rules()

get_filter_rule()

Developer reference for function get_filter_rule()

save_filter()

Developer reference for function save_filter()

save_filter_rule()

Developer reference for function save_filter_rule()

delete_filter()

Developer reference for function delete_filter()

delete_filter_rule()

Developer reference for function delete_filter_rule()

copy_filter()

Developer reference for function copy_filter()

getThemePathPerms()

Developer reference for function getThemePathPerms()

get_users()

Developer reference for function get_users()

get_users_with_permission()

Developer reference for function get_users_with_permission()

get_user_by_email()

Developer reference for function get_user_by_email()

get_user_by_username()

Developer reference for function get_user_by_username()

get_usergroups()

Developer reference for function get_usergroups()

resolve_userlist_groups()

Developer reference for function resolve_userlist_groups()

resolve_userlist_groups_smart()

Developer reference for function resolve_userlist_groups_smart()

get_notification_users()

Developer reference for function get_notification_users()

get_selectedtypes()

Developer reference for function get_selectedtypes()

check_order_by_in_table_joins()

Developer reference for function check_order_by_in_table_joins()

render_table()

Developer reference for function render_table()

get_featured_collection_resources()

Developer reference for function get_featured_collection_resources()

get_featured_collections()

Developer reference for function get_featured_collections()

featured_collections_permissions_filter_sql()

Developer reference for function featured_collections_permissions_filter_sql()

is_featured_collection_category()

Developer reference for function is_featured_collection_category()

get_featured_collection_ref_by_name()

Developer reference for function get_featured_collection_ref_by_name()

render_featured_collections()

Developer reference for function render_featured_collections()

render_featured_collection()

Developer reference for function render_featured_collection()

allow_upload_to_collection()

Developer reference for function allow_upload_to_collection()

array_flip_by_value_key()

Developer reference for function array_flip_by_value_key()

compute_node_branch_path()

Developer reference for function compute_node_branch_path()

compute_nodes_by_parent()

Developer reference for function compute_nodes_by_parent()

comments_notify_tagged()

Description Notify anyone tagged when a new comment is posted Parameters Column Type Default Description $comment string The comment body $from_user integer Who posted the comment $resource integer null If commenting on a resource, the resource ID $collection integer null If commenting on a collection, the collection ID Return void Location include/comment_functions.

get_collections_resource_count()

Description Get collection total resource count for a list of collections note that the returned array might NOT contain keys for all the input IDs (e.g validation failed).

Frequently Asked Questions (FAQs)

The most frequently asked questions about ResourceSpace, the free and open source Digital Asset Management system.

upload_share_setup()

Description Set up external upload share "collection" - (int) collection ID "user" - (int) user ID of share creator "usergroup" - (int) usergroup ID used for share Parameters Column Type Default Description $key string access key $shareopts array array Array of share options Return void Location include/collections_functions.

leaflet_polygon_parsing()

Description Parses the resource polygon string to extract latitude and longitude bounds and formats the polygon string. as well as the formatted polygon string for Leaflet display.

header_add_map_providers()

Description Adds map providers for Leaflet maps. This function generates a JavaScript snippet that defines various tile layer providers for use in Leaflet maps. It supports OpenStreetMap and ESRI basemaps, as well as custom providers defined in the global variable `$geo_leaflet_sources`.

get_geolibraries()

Description Checks the current page and includes necessary geolocation libraries for Leaflet maps. This function loads the Leaflet Control Geocoder plugin and checks if the current page requires geolocation capabilities.

set_geo_map_centerview()

Description Set bounds for default map view (geo_search.php and geo_edit.php) Parameters This function accepts no parameters. Return void Location include/map_functions.

rs_password_verify()

Description ResourceSpace verify password value is the actual value for that variable. Parameters Column Type Default Description $password string Password $hash string Password hash $data array Extra data required for matching hash expectations (e.

is_not_wildcard_only()

Description Helper function to check a string is not just the asterisk. Parameters Column Type Default Description $str string The string to be checked.

move_featured_collection_branch_path_root()

Description Move a featured collection branch paths' root to the node determined by the global configuration option $featured_collections_root_collection. This temporarily moves the root of the featured collection branch, removing any nodes on the branch from the real root up to the new root.

send_collection_to_admin()

Description Send collection to administrators - used if $send_collection_to_admin is enabled Parameters Column Type Default Description $collection int Collection ID Return boolean Location include/collections_functions.

collection_add_resources()

Parameters Column Type Default Description $collection $resources '' $search '' $selected false Location include/collections_functions.

tltype_srch_generate_js_for_background_and_count()

Description Generate client side logic for doing expensive computation async for retrieving the tile background and total results count. Parameters Column Type Default Description $tile array Tile information {@see pages/ajax/dash_tile.

render_fa_icon_selector()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 4732 tokens. Please reduce the length of the messages.

escape_quoted_data()

The article describes a PHP function called `escape_quoted_data()` that is used for output encoding in HTML and JavaScript when unsafe input is rendered inside it. The function takes a single parameter, `$unsafe`, which is a string that needs to be encoded.

update_smart_collection()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 7957 tokens. Please reduce the length of the messages.

order_tree_nodes()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 6337 tokens. Please reduce the length of the messages.

display_related_resources()

Description Render all related resources on view page Parameters Column Type Default Description $context array Array with all required info from the view page Return void * Location include/render_functions.

admin_resource_type_field_option()

Parameters Column Type Default Description $propertyname string $propertytitle string $helptext string $type $currentvalue $fieldtype int $system_date_field bool $resource_type_array; $lang $baseurl_short $FIXED_LIST_FIELD_TYPES $daterange_edtf_support $allfields $newfield $resource_type_array $existingrestypes $regexp_slash_replace Location include/render_functions.

get_resource_type_field_columns()

Description Get the definitions for resource_type_field columns, including properties and display configurations. Parameters This function accepts no parameters. Return array An associative array of resource type field column definitions.

log_keyword_usage()

Description Log which keywords are used in a search Parameters Column Type Default Description $keywords array refs of keywords used in a search $search_result $search_results array result of the search Location include/search_functions.

add_download_column()

Description Render the Download info for the resource tool (on view page) Parameters Column Type Default Description $ref int Resource ref $size_info array Preview size information $downloadthissize bool Should the size be downloadable or requested? $view_in_browser bool false Allow the size to be viewed directly in the browser Location include/render_functions.

escape()

Description Output encoding for HTML context when unsafe input is rendered inside it Parameters Column Type Default Description $unsafe: string | ENT_QUOTES "" $name string "icon" $current string "" Return string Location include/render_functions.

I've missed out an important keyword. Can I add this to my resource(s) after I've published them?

The article explains that it is possible to add keywords to resources after they have been published. Users can make metadata edits at any time by choosing the "Edit metadata" option from the individual resource preview.

render_resource_view_image()

Description Render image on view.php "access" - Resource access "edit_access" - Resource edit access Parameters Column Type Default Description $resource array Resource data $context array Array with following named elements Return void * Location include/render_functions.

related_resource_pull()

Description Get a related resource to pull images from Parameters Column Type Default Description $resource array Array of resource data from do_search() Return array|bool $resdata Array of alternative resource data to use, or false if not configured or no resource image found Location include/resource_functions.

get_resource_preview()

Description Get the largest available preview URL for the given resource and the given array of sizes Parameters Column Type Default Description $resource array Array of resource data from get_resource_data() or search results $sizes array [] Array of size IDs to look through, in order of size.

validate_resource_files()

Description Validate the files on disk that are associated with the given resources array of resource data e.g, from search results required return values in order to pass the check e.

send_integrity_failure_notices()

Description Send notifications about file integrity failures Parameters Column Type Default Description $failures: array get_sysvar'last_integrity_check_notify' '1970-01-01'; $failures array Array of resources that have failed integrity check Location include/message_functions.