Skip to content

Frequently Asked Questions

Common questions and answers about the Gold Standard Module.

Installation & Setup

How do I install the Gold Standard Module?

  1. Download the module from the official repository
  2. Extract to htdocs/modules/goldstandard
  3. Run composer install in the module directory
  4. Go to Admin → Modules and install the module
  5. Configure permissions and settings

See Getting Started Guide for detailed instructions.

What are the minimum requirements?

Requirement Minimum Recommended
PHP 8.2 8.3+
XOOPS 2.6.0 Latest
MySQL 8.0 8.0+
Memory 128MB 256MB+

The module won't install. What should I check?

  1. PHP Version - Ensure PHP 8.2+ is installed
  2. Composer - Run composer install in module directory
  3. Permissions - Check folder permissions (755 for directories)
  4. Error Logs - Check xoops_data/logs/ for errors
  5. Database - Ensure database user has CREATE TABLE permission

Content Management

How do I create my first article?

  1. Go to Admin → Gold Standard → Articles
  2. Click Add New Article
  3. Fill in title, content, and category
  4. Set status to "Draft" or "Published"
  5. Click Save

Can I schedule articles for future publication?

Yes! When creating or editing an article: 1. Set status to "Scheduled" 2. Set the Publish Date to your desired date/time 3. The article will automatically publish at that time

How do I import content from WordPress?

  1. Export your WordPress content as WXR (XML)
  2. Go to Admin → Gold Standard → Import
  3. Select "WordPress" as the format
  4. Upload your WXR file
  5. Map categories and authors
  6. Click Import

Why are my images not displaying?

Common causes: - File permissions - Ensure upload directory is writable (755) - File size - Check max_image_size setting - File type - Ensure file extension is allowed - Path issues - Regenerate thumbnails from admin panel

Permissions & Users

How do I allow users to submit articles?

  1. Go to Admin → Gold Standard → Permissions
  2. Find article_create permission
  3. Check the box for "Registered Users" group
  4. Save changes

Can I restrict categories to certain users?

Yes, use category-level permissions: 1. Go to Admin → Gold Standard → Categories 2. Click Permissions for the category 3. Set which groups can view/submit 4. Save changes

How do I moderate content before publishing?

  1. Set auto_approve to "No" in settings
  2. Enable notify_new_article for admin notifications
  3. New articles will be saved as "Pending"
  4. Review and approve from the admin panel

Customization

How do I customize the templates?

  1. Copy templates from modules/goldstandard/templates/
  2. Paste to themes/[your-theme]/modules/goldstandard/
  3. Edit the copied templates
  4. Clear template cache in admin panel

Can I add custom fields to articles?

Yes, using the extension system:

// In your custom module or plugin
$eventDispatcher->listen(
    ArticleFormBuilding::class,
    function ($event) {
        $event->form->addElement(
            new XoopsFormText('Custom Field', 'custom_field', 50, 255)
        );
    }
);

How do I change the URL structure?

  1. Go to Admin → Gold Standard → Settings
  2. Find SEO Settings
  3. Modify the url_pattern option
  4. Clear cache and regenerate sitemap

Performance

The module is slow. How can I speed it up?

  1. Enable caching - Set enable_cache to Yes
  2. Increase cache time - Set cache_lifetime to 3600+
  3. Optimize images - Enable auto-compression
  4. Use CDN - Configure CDN for media files
  5. Database indexes - Run optimization command: 
    php xoops_cli.php goldstandard:optimize

How much server resources does it use?

Typical resource usage: - Memory: 20-50MB per request - Database queries: 5-15 per page load - Response time: <200ms with caching

API

How do I get an API key?

  1. Go to your user profile
  2. Click API Keys
  3. Click Generate New Key
  4. Copy and securely store the key

Or via CLI: 

php xoops_cli.php goldstandard:api:generate-key --user=1

What's the API rate limit?

Default: 60 requests per minute per API key.

Configure in settings: - api_rate_limit: Requests per minute (0 = unlimited)

Can I use the API without authentication?

By default, no. To enable public API access: 1. Set require_auth to "No" for specific endpoints 2. Or create a public API key with read-only scope

Troubleshooting

Articles show "Access Denied"

  • Check article_view permission for user's group
  • Verify the article is published (not draft)
  • Check category-level permissions
  • Clear cache and try again

Comments are not appearing

  1. Verify comments are enabled: enable_comments = Yes
  2. Check comment_view permission
  3. Verify comment was approved (if moderation is on)
  4. Check that the article allows comments

Search is not finding articles

  1. Rebuild search index: 
    php xoops_cli.php goldstandard:search:reindex
  2. Verify articles are published
  3. Check that search is enabled in settings

Email notifications not sending

  1. Verify XOOPS mail settings are correct
  2. Check notify_* settings are enabled
  3. Look for errors in mail logs
  4. Test with: 
    php xoops_cli.php goldstandard:test:email admin@example.com

Migration & Backup

How do I backup the module data?

Via Admin Panel: 1. Go to Admin → Gold Standard → Export 2. Select "Full Backup" 3. Choose format (JSON recommended) 4. Download the backup file

Via CLI: 

php xoops_cli.php goldstandard:backup --output=backup.json

How do I migrate to a new server?

  1. Export all data as JSON
  2. Copy module files to new server
  3. Install module (don't activate yet)
  4. Import the JSON backup
  5. Update configuration as needed

Getting Help

Where can I get support?

  • Documentation: This knowledge base
  • Forums: XOOPS Forums
  • GitHub Issues: For bugs and feature requests
  • Discord: Real-time community help

How do I report a bug?

  1. Check if it's already reported on GitHub
  2. Gather information:
  3. PHP version
  4. XOOPS version
  5. Module version
  6. Error messages
  7. Steps to reproduce
  8. Open an issue with all details

goldstandard #faq #help #troubleshooting