{"id":205231,"date":"2025-04-17T13:02:32","date_gmt":"2025-04-17T13:02:32","guid":{"rendered":"https:\/\/wordpress.org\/plugins\/helpshelf\/"},"modified":"2025-04-17T13:07:46","modified_gmt":"2025-04-17T13:07:46","slug":"helpshelf","status":"publish","type":"plugin","link":"https:\/\/kea.wordpress.org\/plugins\/helpshelf\/","author":23135535,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"1.0.0","stable_tag":"1.0.0","tested":"6.7.5","requires":"4.7","requires_php":"7.0","requires_plugins":null,"header_name":"HelpShelf","header_author":"HelpShelf","header_description":"Plugin to integrate the HelpShelf widget on your WordPress site to give your customers easy access to your content through AI-powered search.","assets_banners_color":"","last_updated":"2025-04-17 13:07:46","external_support_url":"","external_repository_url":"","donate_link":"https:\/\/helpshelf.com\/","header_plugin_uri":"https:\/\/www.helpshelf.com\/docs\/how-to-install-the-helpshelf-wordpress-plugin","header_author_uri":"https:\/\/helpshelf.com\/","rating":0,"author_block_rating":0,"active_installs":0,"downloads":391,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":{"1.0.0":{"tag":"1.0.0","author":"helpshelf","date":"2025-04-17 13:07:46"}},"upgrade_notice":{"1.0.0":"<p>First version of the plugin dynamically loads the HelpShelf script from our S3 service to the head of every page.<\/p>"},"ratings":[],"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":3279761,"resolution":"128x128","location":"assets","locale":""}},"assets_banners":[],"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0.0"],"block_files":[],"assets_screenshots":[],"screenshots":[],"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[2353,14090,944,1104],"plugin_category":[],"plugin_contributors":[240960],"plugin_business_model":[],"class_list":["post-205231","plugin","type-plugin","status-publish","hentry","plugin_tags-ai","plugin_tags-knowledge-base","plugin_tags-search","plugin_tags-support","plugin_contributors-helpshelf","plugin_committers-helpshelf"],"banners":[],"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/helpshelf\/assets\/icon-128x128.png?rev=3279761","icon_2x":false,"generated":false},"screenshots":[],"raw_content":"<!--section=description-->\n<p>The HelpShelf WordPress Plugin provides a customizable widget service that integrates seamlessly with your WordPress site. This plugin acts as a connector to the HelpShelf service, enabling you to embed a fully customizable help widget on your website.<\/p>\n\n<p><strong>Key Features:<\/strong>\n* <strong>Dynamic Script Insertion:<\/strong><br \/>\n  The plugin takes the SITE_ID provided by the user in the WordPress admin panel and automatically injects the required JavaScript code into the  section of all pages.\n* <strong>HelpShelf Widget Integration:<\/strong><br \/>\n  The plugin loads a JavaScript file from a dynamic URL (https:\/\/s3.amazonaws.com\/helpshelf-production\/gen\/loader\/{SITE_ID}.min.js) hosted on our secure S3 service. This file initializes and identifies the HelpShelf widget, ensuring that any updates or bug fixes are delivered instantly without requiring a new plugin release.\n* <strong>Customizable User and Company Attributes:<\/strong><br \/>\n  Easily pass custom attributes to HelpShelf for personalized user interactions and enhanced support.<\/p>\n\n<p><strong>Service Information:<\/strong>\n* This plugin connects to HelpShelf's widget service\n* The remote script loading is essential for widget functionality because:\n  - It enables real-time widget customization\n  - Allows dynamic updates to widget appearance and behavior\n  - Maintains consistent widget performance across all installations\n* A HelpShelf account is required (sign up at https:\/\/helpshelf.com)\n* Your site will connect to our secure AWS S3 servers (helpshelf-production.s3.amazonaws.com) to load the widget<\/p>\n\n<p><strong>Widget Customization:<\/strong>\n* Fully customizable design to match your brand\n* Flexible color scheme options\n* Adjustable widget positioning and behavior\n* Custom styling options through HelpShelf dashboard<\/p>\n\n<p>*Technical Details:**\n* Remote Script: The plugin loads your customized widget configuration from our secure servers\n* Server Location: All widget resources are served from helpshelf-production.s3.amazonaws.com\n* Updates: Remote loading ensures your widget always has the latest features and improvements<\/p>\n\n<p><strong>Account Requirements:<\/strong>\n1. Sign up for a HelpShelf account at https:\/\/helpshelf.com\n2. Obtain your unique SITE_KEY from the HelpShelf dashboard\n3. Enter the SITE_KEY in your WordPress plugin settings\n4. Customize your widget design through the HelpShelf<\/p>\n\n<p><strong>Privacy &amp; Security:<\/strong>\n* All remote scripts are served via HTTPS\n* Our servers are hosted on secure AWS infrastructure\n* Widget configuration is loaded securely<\/p>\n\n<h3>Additional Information<\/h3>\n\n<p>By integrating HelpShelf, you agree to allow our plugin to load remote assets essential for delivering our service. For more details on our service and remote asset management, please visit https:\/\/helpshelf.com\/.<\/p>\n\n<!--section=installation-->\n<ol>\n<li>Download the plugin ZIP file.<\/li>\n<li>Navigate to the Plugins section in your WordPress dashboard.<\/li>\n<li>Click \"Add New\" and then \"Upload Plugin.\"<\/li>\n<li>Select the ZIP file you downloaded and click \"Install Now.\"<\/li>\n<li>After installation, click \"Activate\" to enable the plugin.<\/li>\n<\/ol>\n\n<!--section=faq-->\n<dl>\n<dt id='q%3A%20why%20is%20the%20helpshelf%20javascript%20file%20loaded%20from%20an%20external%20server%3F'><h3>Q: Why is the HelpShelf JavaScript file loaded from an external server?<\/h3><\/dt>\n<dd><p>A: Because HelpShelf is designed as a service, our dynamic assets are hosted on our secure S3 service. This allows us to quickly deploy updates and maintain compatibility without forcing frequent plugin updates.<\/p><\/dd>\n\n<\/dl>\n\n<!--section=changelog-->\n<h4>1.0.0<\/h4>\n\n<ul>\n<li>Initial release featuring core AI-powered search functionality, dynamic script insertion, and remote asset management for the HelpShelf widget.<\/li>\n<\/ul>","raw_excerpt":"Short Description: Easily integrate the HelpShelf widget into your WordPress site for enhanced support and streamlined knowledge base access.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/205231","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=205231"}],"author":[{"embeddable":true,"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/helpshelf"}],"wp:attachment":[{"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=205231"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=205231"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=205231"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=205231"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=205231"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/kea.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=205231"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}