Search results
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.
get_nopreview_icon()
Developer reference for function get_nopreview_icon()
render_fa_icon_selector()
render_fa_icon_selector()
filterIcons()
The article discusses the process of creating a filterIcons() function in JavaScript, which can be used to filter and display icons based on user input. The function takes an array of objects, each containing information about an icon, and filters them based on the user's search query.
strip_unicode_points()
Description Strip Unicode points from a text value. Parameters Column Type Default Description $value string Text value subject $blocklist list List of unicode points (e.
allow_unicode_characters()
Description Strip any characters not present in the allow list. Mostly useful for search/indexing purposes where we care more about the words themselves and less about linking or any other type of characters.
render_lucide_icon_selector()
Description Renders a Lucide icon selector question Requires lib/lucide/icon_classes.php to be included in the page using the function Parameters Column Type Default Description $label string "" $name string "icon" Input name $current string "" Current value Return void Location include/render_functions.
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.
Navigating Consent and Digital Asset Management
Discover how your organisation can navigate consent and Digital Asset Management (DAM), including ensuring legal compliance and protecting user privacy.
Configuring the database
This article provides instructions on how to configure a database for ResourceSpace, an open-source digital asset management system. The article explains how to create a new database and how to create dedicated users for ResourceSpace, which is a good security practice.
Resource locking
Resource locking is a feature that allows users with edit access to lock resources to prevent other users from editing them and causing metadata conflicts. Once a resource is locked, metadata cannot be changed, and alternative files cannot be managed.
My Profile
The My Profile page in ResourceSpace allows users to configure their user profile to collaborate more effectively with team members and other users. The page has two fields: Profile/Bio and Profile image.
Managing offline jobs
The My Jobs page is a tool used to check the status of jobs, such as collection downloads and preview creation. Administrators can also use this page to check on the status of jobs systemwide. The page displays information about jobs in the queue, including job priority, job reference, job type, user that created the job (admins only), job status, and the earliest job start date.
Removing resources from collections
The article provides three methods to remove resources from a collection. The first method involves clicking and dragging the resource to be removed from the collection and dropping it onto the trash icon that appears at the top of the screen.
Image tools
The Image Tools plugin enables users to edit images by rotating, cropping or scaling them. The plugin also allows users to modify the home slideshow image using resources that have previously been uploaded to ResourceSpace.
Image preview zoom
The article discusses the image preview zoom feature in ResourceSpace, a digital asset management system. If the system is configured with zoomable previews, users can enable the OpenSeadragon viewer on the view page by toggling the image preview zoom tool available in the image preview toolbar.
Whisper
Whisper is an open-source automatic speech recognition (ASR) system by OpenAI that transcribes audio and video files into text using deep learning models, all locally on your server for privacy. It ensures data security, compliance with regulations like GDPR, and can be used offline.
Annotating resources
The article discusses the importance of annotating resources to enhance learning and research. It highlights how annotations can help in better understanding, organizing, and retaining information. The process involves adding notes, comments, and highlights to texts, documents, or other resources.
CLIP AI Smart Search
The CLIP Visual Search plugin integrates OpenAI's CLIP model into ResourceSpace, enabling powerful visual similarity and natural language image searches based on image content rather than metadata. Features include natural language description searches, finding visually similar images by uploading examples, and detecting duplicates based on visual similarity scores.
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.
Contact Sheets not showing special characters
The update to html2pdf changed the name of a font which we used to recommend for compatibility. This article is for systems that have that set or if new systems have issues.
Supported file formats
Supported file formats
Messaging
The article provides instructions on how to view and send messages on a website. To view messages, users need to click on the user profile icon and select "Messages". Messages are listed in date order, newest first, and users can mark them as read, delete them, or reply to them.
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.
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.
Progressive Web App
ResourceSpace can be installed as a Progressive Web App (PWA) by using the manifest.json file. This file sets various properties for the web application, such as the application name, app icons, UI colors, shortcuts, and screenshots.
ResourceSpace messages
ResourceSpace uses messages to ensure that notifications are prominently displayed so that important messages are not overlooked. A counter next to the user's profile will increase to indicate the activity as new messages are received.
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.
Sharing resources
Resources and Resource Collections each offer a 'Share' option which allows them to be shared with other users, as well as with non-users of the system, to allow greater flexibility of use.
Deleting collections
This article explains how to delete collections in a simple and straightforward manner. Users are unable to delete their default "My Collection", but any other collection can be deleted by going to the "Manage My Collections Page", clicking "Delete" against the collection to be deleted, and confirming the deletion.
Creating featured collections
This article explains how to create a featured collection in ResourceSpace, which is a collection of resources that is highlighted on the platform's homepage. The process is similar to creating a public collection, but with an additional step to turn it into a featured 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.
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.
Admin overview
Accessible from the top navigation bar, the Admin menu provides a whole range of tools to help manage ResourceSpace and its contents.
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".
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.
Advanced workflow
workflow, process, publish, embargo, archive, review,state, status
get_resource_types
The "get_resource_types" function returns all the configured resource types available to the user. The function does not require any parameters and returns a list of resource types. The list includes the reference number, name, allowed extensions, order by, configuration options, tab name, and push metadata for each resource type.
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.
Lockable metadata
The article discusses the use of lockable metadata fields to speed up the process of refining metadata after uploading new resources. The feature is intended for use when the default upload sequence is set to 'Upload first, then set metadata'.
Installing on Windows Server
The article provides a step-by-step guide to installing ResourceSpace on Windows Server. The instructions include setting up the IIS Web Server role, installing Web Platform Installer to help with PHP and MySQL install, configuring php.
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.
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".
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.
Table: plugins
The article provides a table named "plugins" that lists all active plugins on the system and stores their configuration. The table has several columns, including name, descrip, author, update_url, info_url, inst_version, config, config_json, config_url, enabled_groups, priority, disable_group_select, title, and icon.
Table: keyword
Table: keyword
Table: node
Table: node
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.
AI Faces (InsightFace)
The AI Faces plugin allows ResourceSpace to automatically detect and recognise people featured in images. This allows for quick and efficient automated tagging on upload.
render_featured_collection()
Developer reference for function render_featured_collection()
render_share_password_question()
Description Renders a question field for setting a share password. This function generates an HTML input field where users can set or change the password for shared access to a resource.
render_featured_collection_context_menu()
Description Render a featured collection (category) contextual menu Parameters Column Type Default Description $id string The HTML identifier for the menu container.
leaflet_markers_legend()
Description Creates a map color markers legend for Leaflet maps. This function generates HTML for a legend that displays markers with colors corresponding to resource types or custom metadata field values.
render_top_right_menu_btn()
Description Render the top right menu button ellipsis icon. Parameters Column Type Default Description $options: array string, list $options The available menu options 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.
RenderPlugin()
Description Render the plugin in the Plugin Manager with options to activate and configure. Parameters Column Type Default Description $plugin array An array containing the plugin data, loaded from the plugin table $active boolean true If true, display options to deactivate and allow group configuration Return void Location include/plugin_functions.
render_message()
Parameters Column Type Default Description $message "" Location include/render_functions.
get_nopreview_html()
Description Returns the HTML necessary to represent a resource with the given extension when no image preview exists. Parameters Column Type Default Description $extension string File extension $resource_type int Optional, the resource type of the resource, used to find an icon at the resource type level if an icon for this extension is not defined.
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.
Brand Guidelines (v10.5+)
The article outlines the brand guidelines for version 10.5 and above. It covers essential information such as logo usage, color palette, typography, and design elements to maintain brand consistency. The guidelines emphasize the correct application of the logo in various formats and backgrounds, specifying clear space requirements and prohibited alterations.
save_resource_type()
Description Save updated resource_type data Parameters Column Type Default Description $ref int Ref of resource type $savedata array Array of column values Return bool * Location include/config_functions.
Adobe Creative Cloud integration (LinkrUI)
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.
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.
render_upload_here_button()
Developer reference for function render_upload_here_button()
execute_api_call()
Developer reference for function execute_api_call()
build_dash_tile_list()
Developer reference for function build_dash_tile_list()
generate_pdf()
Developer reference for function generate_pdf()
activate_plugin()
Developer reference for function activate_plugin()
get_plugin_yaml()
Developer reference for function get_plugin_yaml()
get_plugin_config()
Developer reference for function get_plugin_config()
set_plugin_config()
Developer reference for function set_plugin_config()
include_plugin_config()
Developer reference for function include_plugin_config()
render_search_field()
Developer reference for function render_search_field()
render_sort_order()
Developer reference for function render_sort_order()
render_date_range_field()
Developer reference for function render_date_range_field()
renderSocialMediaShareLinksForUrl()
Developer reference for function renderSocialMediaShareLinksForUrl()
renderLockButton()
Developer reference for function renderLockButton()
render_filter_bar_button()
Developer reference for function render_filter_bar_button()
render_featured_collections()
Developer reference for function render_featured_collections()
render_trash()
Developer reference for function render_trash()
generate_browse_bar_item()
Developer reference for function generate_browse_bar_item()
render_help_link()
Developer reference for function render_help_link()
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_resource_lock_link()
Developer reference for function render_resource_lock_link()
EditNav()
Developer reference for function EditNav()
create_periodic_email()
Developer reference for function create_periodic_email()
send_research_request()
Developer reference for function send_research_request()
get_OR_fields()
Developer reference for function get_OR_fields()
cleanse_string()
Developer reference for function cleanse_string()
render_table()
Developer reference for function render_table()
render_new_featured_collection_cta()
Developer reference for function render_new_featured_collection_cta()