Context help links

Coding standards

Coding standards v2.1
ResourceSpace software design principles
Contributing to the base code
Intellectual property
Prepared statements

Security in ResourceSpace

Access control
Cross-Site Request Forgery (CSRF)
Injection
File management (uploads)

Developer reference

Project structure
Database schema
Fixed list fields
Debugging ResourceSpace
Writing your own plugins
Context help links
Custom fields ("user" defined)
Query caching
All user permissions
Client side API calls
Modals
Sending user notifications
Progressive Web App
Managing (PHP) code dependencies
Managing (JS) code dependencies
OpenAPI documentation

Database

Table: activity_log
Table: annotation
Table: annotation_node
Table: collection
Table: collection_keyword
Table: collection_log
Table: collection_resource
Table: collection_savedsearch
Table: comment
Table: daily_stat
Table: dash_tile
Table: dynamic_tree_node
Table: external_access_keys
Table: filter
Table: filter_rule
Table: filter_rule_node
Table: ip_lockout
Table: job_queue
Table: keyword
Table: keyword_related
Table: mail_log
Table: message
Table: node
Table: node_keyword
Table: plugins
Table: preview_size
Table: report
Table: report_periodic_emails
Table: report_periodic_emails_unsubscribe
Table: request
Table: research_request
Table: resource
Table: resource_alt_files
Table: resource_custom_access
Table: resource_dimensions
Table: resource_keyword
Table: resource_log
Table: resource_node
Table: resource_related
Table: resource_type
Table: resource_type_field
Table: resource_type_field_resource_type
Table: search_log
Table: site_text
Table: slideshow
Table: sysvars
Table: tab
Table: user
Table: user_collection
Table: user_dash_tile
Table: user_message
Table: user_preferences
Table: user_rating
Table: user_report
Table: user_userlist
Table: usergroup
Table: usergroup_collection
Table: usergroup_dash_tile

Context Help links can be added to pages to link to a relevant Knowledge Base page.

Help links open Knowledge Base in a modal or new page and look like this:

The help links are enabled by default on a ResourceSpace system but can be disabled by setting $contextual_help_links=false;

Adding a help link to a page

To add a help link to a page use the render_help_link function.

The function takes the Knowledge Base page as a parameter without the base URL. For Example:

This code will add a help link to the page: 'https://www.resourcespace.com/knowledge-base/user/uploading' with the link appearing after the intro text for the page.

When adding the link into Javascript it is helpful to create the link as a string variable before using it as creating the link inline can give undesirable results.