Bears FAQ Module - Complete Documentation

Introduction

The Bears FAQ Module is a modern, accessible Joomla extension that transforms your FAQ content into an elegant, user-friendly interface. Built with Bootstrap 5 and comprehensive accessibility features, it automatically organizes FAQ articles by tags into tabs and accordions, making it easy for visitors to find the information they need.

Key Features

Core Functionality

• Tag-Based Organization: Automatically groups FAQ articles by their assigned tags
• Multiple Navigation Styles: Choose between Tabs, Pills, or List styles
• Flexible Layouts: Horizontal or vertical tab orientations
• Accordion Content: Each tab contains an accordion of FAQ questions and answers
• Smart Filtering: Only tagged articles are displayed; untagged articles are automatically excluded

Advanced Permissions & Content Control

The module includes a sophisticated permission system that allows you to create multi-level FAQ content:

Restricted User Groups (Special Access)

Grant privileged access to specific user groups who can see restricted content. Perfect for:

• Staff/Administrator FAQs
• Internal documentation
• Premium member content
• Department-specific information

Allowed User Groups

Limit module visibility to specific user groups while keeping restricted content hidden. Ideal for:

• Member-only FAQs
• Registered user content
• Subscriber-specific information

Restricted Tags

Hide specific FAQ tags from normal users. Only users in "Restricted User Groups" can see these tags and their content. Great for:

• Confidential information
• Staff-only procedures
• Beta features documentation
• VIP customer support

Public Access by Default

The module is accessible to all users (including guests) unless you explicitly configure restrictions. This ensures your public FAQs are always available while giving you the flexibility to add restricted sections.

Customizable Styling

• Tab Styles: Traditional Tabs, modern Pills, or simple List
• Color Customization: Configure colors for active/inactive tabs, borders, text, and underlines
• Active Underline Control: Adjustable height and color (supports RGBA)
• Layout Options: Multiple tab alignment options (left, center, right, justified, equal width, etc.)
• Responsive Design: Works seamlessly across all device sizes
• Professional Appearance: Enhanced styling with shadows, borders, and smooth transitions

Accessibility Features (WCAG 2.1 AA Compliant)

• Keyboard Navigation: Complete keyboard support with arrow keys, Home/End
• Screen Reader Optimized: Proper ARIA labels, live regions, and semantic HTML
• Focus Management: Clear focus indicators and logical tab order
• High Contrast Support: Enhanced visibility for users with visual impairments
• Reduced Motion Support: Respects user preferences for reduced animations

Installation

1. Download the module package from the Joomla Extensions Directory or GitHub
2. In Joomla Administrator, navigate to Extensions > Manage > Install
3. Upload the module package file
4. Go to Extensions > Modules to configure and assign the module to your desired position

Configuration Guide

Basic Settings

FAQ Category

Select the Joomla content category containing your FAQ articles. This is a required field.

Maximum Articles

Set the maximum number of FAQ articles to display (default: 100, range: 1-500).

Tab Style

Choose your preferred navigation style:

• Tabs: Traditional tab interface (default)
• Pills: Modern pill-style navigation
• List: Simple list navigation optimized for vertical layouts

Tab Orientation

Select how tabs are displayed:

• Horizontal: Tabs displayed horizontally above content (default)
• Vertical: Tabs displayed vertically beside content

Styling Options

Customize the appearance of your FAQ module:

Colors

• Active Tab Background: Background color for the currently selected tab
• Inactive Tab Background: Background color for non-selected tabs
• Tab Font Color: Text color for all tabs
• Question Color: Color for question links in accordions
• Border Color: Color for tab borders
• Active Tab Underline Color: Color of the underline bar for active tabs (supports RGBA)

Layout

• Border Radius: Rounded corner radius for tabs (0-50px)
• Tab Gap: Space between tabs (0-64px)
• Tab Alignment: Choose from Left, Right, Centered, Space Between, Space Around, Justified, or Equal Width

User Group Permissions

Configure who can see your FAQ content:

Restricted User Groups (Special Access)

Select user groups that get privileged access to view restricted tags. Users in these groups will see:

• ✅ The entire FAQ module
• ✅ ALL tags including restricted tags
• ✅ All FAQ content regardless of restrictions

Allowed User Groups

Select user groups that are allowed to view the FAQ module (but not restricted tags).

• If specified, only users in these groups or restricted groups will see the module
• Leave empty to allow all users including public/guest users (default behavior)

Restricted Tags

Select tags that should be hidden from normal users. Only users in "Restricted User Groups" will see these tags and their articles.

Permission System Examples

Setting Up Your FAQ Content

Step 1: Create FAQ Category

1. Navigate to Content > Categories
2. Create a new category (e.g., "FAQ" or "Help Center")
3. Note the category for use in module configuration

Step 2: Create FAQ Articles

1. Go to Content > Articles
2. Create articles in your FAQ category
3. Use clear, descriptive titles for questions (e.g., "How do I reset my password?")
4. Add detailed answers in the article content
5. Assign appropriate tags to group related questions

Step 3: Organize with Tags

1. Create tags for different FAQ topics:
   • General
   • Technical Support
   • Billing
   • Account Management
   • Getting Started
   • etc.
2. Assign tags to each FAQ article
3. Articles can have multiple tags and will appear in multiple groups
4. Important: Untagged articles will not be displayed in the module

Step 4: Configure Restricted Content (Optional)

1. Create tags for restricted content (e.g., "Staff Only", "Premium", "Internal")
2. Assign these tags to appropriate articles
3. In module configuration, add these tags to "Restricted Tags"
4. Select appropriate user groups for "Restricted User Groups"

Step 5: Configure Module

1. Go to Extensions > Modules
2. Find "Bears FAQ" module
3. Configure:
   • Select your FAQ category
   • Choose navigation style and orientation
   • Set up permissions if needed
   • Customize colors and layout
4. Assign module to desired position and menu items
5. Save and test

Accessibility Features

The Bears FAQ Module is fully WCAG 2.1 AA compliant, ensuring all users can access your FAQ content:

Keyboard Navigation

• Tab Key: Navigate between interactive elements
• Arrow Keys: Move between tabs
• Home/End Keys: Jump to first/last tab
• Enter/Space: Activate tabs and expand accordions

Screen Reader Support

• Semantic HTML with proper heading hierarchy
• Descriptive ARIA labels for all interactive elements
• Live region announcements for state changes
• Skip links for quick navigation

Visual Accessibility

• Clear focus indicators for keyboard navigation
• High contrast mode support
• Respects user preferences for reduced motion
• Information not conveyed by color alone

Technical Requirements

• Joomla: 4.0+ or 5.0+
• PHP: 7.4+
• Bootstrap: 5.x (automatically loaded by the module)

Browser Support

• Desktop: Chrome 90+, Firefox 88+, Safari 14+, Edge 90+
• Mobile: iOS Safari 14+, Chrome Mobile 90+
• Assistive Technology: NVDA, JAWS, VoiceOver, Dragon NaturallySpeaking

Troubleshooting

No FAQs Displayed

• Verify FAQ category exists and contains published articles
• Check that articles are assigned to the correct category
• Ensure articles have tags assigned
• Verify module is published and assigned to correct menu items

Tags Not Grouping Correctly

• Check that articles have tags assigned
• Verify tag names for typos or extra spaces
• Ensure tags are published

Permission Issues

• Verify user group assignments in Joomla
• Check that restricted tags are properly configured
• Test with different user accounts to verify access levels
• Clear Joomla cache after making permission changes

Styling Issues

• Clear Joomla cache after making changes
• Check for CSS conflicts with your template
• Verify Bootstrap 5 is loaded
• Use browser developer tools to inspect CSS

Support & Resources

• Documentation: Complete README included with module
• Issues: Report bugs on GitHub
• Community: Joomla community forums
• Updates: Available through Joomla Update System

License

This module is licensed under the GNU General Public License v3.0, making it free to use, modify, and distribute.

Credits

• Author: N6REJ
• Email: troy@hallhome.us
• Website: https://hallhome.us
• Framework: Joomla 4.x/5.x
• UI Framework: Bootstrap 5
• Accessibility: WCAG 2.1 AA compliant

Bears FAQ Module - Making FAQ management accessible, beautiful, and flexible for Joomla websites.