ailab

Readmo AI Plugin integrates seamlessly with the Readmo AI API service to bring intelligent article processing and question generation directly into your WordPress site.
<h3>Service Requirements</h3>
This plugin is free and open source software (GPL v2 or later), but it requires: 
– A paid subscription to Readmo AI API service 
– Valid API credentials (API Key) from Readmo AI 
– Active internet connection for API communication
The plugin code itself is completely free and you have full rights to modify and redistribute it under GPL v2 terms. However, without Readmo AI API access, the plugin will not be functional.
<h3>Features</h3>
<ul>
<li>Easy Configuration – Simple setup with API Key and Sub Domain in the WordPress admin</li>
<li>Secure Storage – API keys encoded using Base64 for safe storage in WordPress options</li>
<li>Smart Question Generation – Automatically generates comprehension questions from any article URL</li>
<li>Real-time Processing – Monitor job status with 5-second polling intervals</li>
<li>Beautiful UI – Responsive button layout for question display</li>
<li>Multilingual Ready – Full translation support (i18n/l10n)</li>
<li>Shortcode Support – Use <code>[readmo_ai_articles]</code> to display on any page or post</li>
<li>CSRF Protection – Complete nonce verification on all forms and AJAX requests</li>
<li>Secure Architecture – WordPress Coding Standards compliant</li>
</ul>
<h3>How It Works</h3>
<ol>
<li>Configure your Readmo AI credentials in Settings > Readmo AI</li>
<li>Add the <code>[readmo_ai_articles]</code> shortcode to any page or post</li>
<li>The plugin automatically detects the current page URL</li>
<li>Questions are generated and displayed as interactive buttons</li>
<li>Clicking a button navigates to the question detail page on your Readmo AI subdomain</li>
</ol>
<h3>Shortcode Usage</h3>
Basic Usage: 
 <code>[readmo_ai_articles]</code>
The shortcode automatically detects the current page URL and sends it to the Readmo AI API for processing. Questions will be displayed as interactive buttons below the content.
<h3>API Integration</h3>
The plugin connects to the Readmo AI API with the following endpoints:
<ul>
<li>GET /api/v1/api-key-info – Retrieve API key configuration and subdomain information</li>
<li>POST /api/v1/ArticleJobs – Create new article processing job</li>
<li>GET /api/v1/ArticleJobs/status – Check job processing status</li>
<li>GET /api/v1/Articles – Retrieve processed article with questions</li>
</ul>
All API requests are authenticated using your encoded API key and include comprehensive error handling with user-friendly messages.
<h3>Security</h3>
<ul>
<li>Base64 Encoding – API keys encoded for safe storage in WordPress options</li>
<li>Complete Nonce Verification – All AJAX requests and admin forms protected with WordPress nonce tokens</li>
<li>Input Validation – All user inputs sanitized using WordPress security functions</li>
<li>Output Escaping – All dynamic outputs escaped to prevent XSS attacks</li>
<li>CSRF Protection – Cross-Site Request Forgery protection on all forms</li>
<li>API Response Validation – Strict type checking and structure validation on all API responses</li>
<li>No Direct Database Access – Uses WordPress Options API exclusively</li>
</ul>
<h3>Requirements</h3>
<ul>
<li>WordPress 5.9 or higher</li>
<li>PHP 7.4 or higher</li>
<li>Active internet connection for API communication</li>
<li>Valid Readmo AI API credentials</li>
</ul>
<h3>Plugin Architecture</h3>
This plugin follows a modern four-layer architecture pattern for clean code separation and maintainability:
<ul>
<li>View Layer – Handles presentation templates and HTML output for user interfaces</li>
<li>Controller Layer – Processes HTTP requests, AJAX handling, and shortcode registration</li>
<li>Service Layer – Implements business logic and data validation, such as API key encoding</li>
<li>Infrastructure Layer – Manages data access and external API communication, including DAO and configuration</li>
</ul>
This architecture ensures: 
– Clear separation of concerns 
– Easy testing and maintenance 
– Scalability for future features 
– WordPress Coding Standards compliance
<h3>Configuration</h3>
In the plugin settings page (Settings > Readmo AI), configure:
<ul>
<li>API Key – Your Readmo AI API authentication key (encoded using Base64)</li>
</ul>
The API Key is encoded using Base64 before storage for safe storage in WordPress options. The encoded key is decoded when making API requests.
<h3>Troubleshooting</h3>
Questions not displaying: 
– Verify API Key is correct in Settings > Readmo AI 
– Verify subdomain is configured via CNAME 
– Check browser console for JavaScript errors (F12 > Console) 
– Verify your Readmo AI account is active 
– Check that the nonce is being passed correctly in AJAX requests
Slow processing: 
– Processing time depends on article length and API load 
– Large articles may take 30+ seconds to process 
– The 5-second polling interval is optimal for most cases
API errors: 
– 401 Unauthorized: API Key is invalid or expired 
– 403 Forbidden: Account does not have permission for this resource 
– 404 Not Found: Job ID or Article ID does not exist 
– 429 Too Many Requests: API rate limit exceeded, wait and try again 
– 500+ Server Error: Readmo AI service issue, contact support
Encoding errors: 
– API keys are encoded using Base64 (no special PHP extensions required) 
– Verify that data is being properly saved in WordPress options
AJAX not working: 
– Verify WordPress AJAX is functioning (<code>admin-ajax.php</code> accessible) 
– Check that JavaScript is not blocked by browser extensions 
– Verify nonce tokens are being generated and validated 
– Check PHP error logs for backend errors
<h3>Privacy</h3>
This plugin sends the following data to Readmo AI API (https://xlab-api.cmoney.tw/Readmore.ai.backend): 
– Current page URL or custom URL (for article processing) 
– Your encoded API Key (for authentication) 
– Source type parameter (URL)
The plugin does NOT: 
– Collect personal user data 
– Track user behavior 
– Store cookies 
– Share data with third parties (except Readmo AI API)
All API communications are HTTPS-encrypted. For more details, see the Readmo AI Privacy Policy.
<h3>Credits</h3>
Built and maintained by the Readmo AI team.
Special thanks to: 
– WordPress community for coding standards and best practices
<h3>Support</h3>
For support, feature requests, or bug reports: 
– Documentation: Contact your Readmo AI account representative 
– Technical Support: Readmo AI support team 
– Security Issues: Report responsibly to support@readmo.ai
<h3>Third-Party Services</h3>
This plugin connects to the Readmo AI API service: 
– Service URL: https://xlab-api.cmoney.tw/Readmore.ai.backend/api 
– Privacy Policy: Contact Readmo AI for details 
– Terms of Service: Contact Readmo AI for details
By using this plugin, you agree to send article URLs to the Readmo AI service for processing.
<h3>License</h3>
This plugin is licensed under the GNU General Public License v2 or later.
<pre><code>Copyright (C) 2024 Readmo AI

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA<h3>License Clarification</h3>
</code></pre>
Plugin Code: Free and open source (GPL v2 or later) 
– You may freely use, modify, and redistribute this plugin code 
– The source code is publicly available 
– No restrictions on commercial or personal use of the plugin code
Readmo AI API Service: Paid subscription required 
– The plugin connects to Readmo AI’s paid API service 
– API access requires valid authentication credentials 
– Service terms and pricing set by Readmo AI 
– Plugin functionality depends on active API subscription
Your Rights Under GPL v2: 
– Run the plugin for any purpose 
– Study and modify the source code 
– Redistribute copies of the plugin 
– Distribute modified versions 
– Use commercially without restrictions
What GPL v2 Does NOT Cover: 
– Access to Readmo AI’s proprietary API service 
– Readmo AI service subscription or pricing 
– API authentication credentials 
– Content generated by Readmo AI service
Important: While the plugin code is free under GPL v2, the Readmo AI API service is a separate commercial service with its own terms. You need both the free plugin AND a paid API subscription for the plugin to function.

Readmo AI

AI-powered article analysis and intelligent question generation for WordPress. Requires Readmo AI API subscription.

Joeri van Veen

FAQs are great for your visitors and when implemented correctly also for SEO.
This simple FAQ plugin creates a new post-type. This is straightforward and flexible: you can now create and manage FAQs like any other post type in WordPress.
The FAQs can be summoned using shortcodes, the default for the central FAQ page is [faq-with-categories]. More options are explained below and on the settings page.
FAQs are always sorted by published-date descending, so newest entries are first (you can manipulate the published date of each post).
You can choose a taxonomy, the default is ‘category’, to attach your FAQ posts to. You can now summon FAQs for a specific category (including sub categories) on a page. The plugin also uses it to filter the FAQs if you place the filter on your central FAQ page.
If you want some FAQs in other locations that do not appear on the central page you can use an ‘exclusive’ tag.
When there are many entries, a ‘Show more’ button appears automatically (configurable in the settings)
<h4>Pros</h4>
<ul>
<li>
Easy to manage the FAQs
</li>
<li>
Tidy accordion display and smooth filtering / searching
</li>
<li>
The ‘exclusive’ short_code and the central FAQ page output FAQ snippet schema data as ld+json in the head
</li>
<li>
Supports direct linking to pre-select the filters (faq-page?category=name%20of%20category)
</li>
<li>
Automatically follows (chosen) taxonomy hierarchy (infinite depth) with added option to order the categories
</li>
</ul>
<h4>Cons</h4>
<ul>
<li>
Only 1 central FAQ list is supported (though you can display subsets of the FAQs anywhere you want)
</li>
<li>
Currently only with shortcodes, no widgets
</li>
<li>
Filtering and searching the FAQs only work with javascript enabled (but then again, so does most of WordPress)
</li>
</ul>
<h4>Short codes</h4>
You may use the following shortcodes, of course certain combinations do not make sense and may produce erratic behaviour.
[faq-with-categories] produces the default list with all the faqs and outputs FAQ snippets schema in the head. Use only ONCE for central FAQ page, and on pages that are linked to a taxonomy (category) in the plugin.
[faq-with-categories-filter] produces a filter menu according to the chosen taxonomy using the specified order (only works when default shortcode is also on that page).
[faq-with-categories-search] produces a search box that will perform client-side lookup through the faqs (only works when default shortcode is also on that page).
[faq-with-categories quantity=”5″] (1) limits the quantity of the faqs to 5, or use another number. Can be combined with the other settings.
[faq-with-categories category=”category name”] (1) display only faqs for the specified category (case-insensitive). This will NOT output FAQ snippets schema in the head.
[faq-with-categories exclusive=”your tag”] (1) (use only ONCE for every tag) any tag you specified under a faq entry in the box, will gather all faqs with that tag for display.
[faq-with-categories title-only=”any value”] outputs the list as links rather than as an accordion.
(1) NOTE: only a limited number of faqs will be present on the page, searching and filtering will be limited to those.
<h4>Template</h4>
The post-type is called ruigehond010_faq, so you can create a single-ruigehond010_faq.php and archive-ruigehond010_faq.php template should you want to format the display in more detail.
Have fun. Let me know if you have a question!

FAQ with categories

Easy to manage FAQ with categories, including accordion, filter, search and show more functionality.

Readmo AI vs FAQ with categories