Add comprehensive documentation for mobile responsive module overrides
Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
122
CHANGELOG.md
122
CHANGELOG.md
@@ -12,13 +12,133 @@
|
||||
BRIEF: Changelog file documenting version history of MokoCassiopeia
|
||||
-->
|
||||
|
||||
# Changelog — MokoCassiopeia (VERSION: 03.06.03)
|
||||
# Changelog — MokoCassiopeia (VERSION: 03.07.00)
|
||||
|
||||
All notable changes to the MokoCassiopeia Joomla template are documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [03.07.00] - 2026-02-22
|
||||
|
||||
### Added - Mobile-Responsive Module & Component Overrides
|
||||
|
||||
This major release introduces **20 mobile-responsive module overrides** and **3 component overrides** designed to enhance the mobile user experience across standard Joomla, VirtueMart, Community Builder, and popular third-party extensions.
|
||||
|
||||
#### Search Module
|
||||
- **mod_search**: Mobile-responsive search with multiple button positions (left, right, top, bottom), 48px touch targets, 16px input font to prevent iOS zoom
|
||||
|
||||
#### VirtueMart E-Commerce Modules (5 modules)
|
||||
- **mod_virtuemart_cart**: Shopping cart with responsive product cards, remove buttons, price display
|
||||
- **mod_virtuemart_product**: Product showcase with responsive grid (1-4 columns), hover effects, ratings
|
||||
- **mod_virtuemart_currencies**: Currency selector dropdown with accessible styling
|
||||
- **mod_virtuemart_category**: Category navigation with hierarchical display, product counts
|
||||
- **mod_virtuemart_manufacturer**: Manufacturer/brand display with responsive grid (2-4 columns)
|
||||
- **VIRTUEMART_MODULES_README.md**: Comprehensive master documentation for all VirtueMart overrides
|
||||
|
||||
#### Standard Joomla & Community Builder Modules (6 modules)
|
||||
- **mod_menu**: Main navigation with multiple layout files (default, component, URL), responsive horizontal/vertical layouts
|
||||
- **mod_breadcrumbs**: Breadcrumb navigation with Schema.org markup for SEO
|
||||
- **mod_login**: User login/logout form with 2FA support, remember me checkbox
|
||||
- **mod_articles_latest**: Latest articles with responsive cards, metadata, featured badges
|
||||
- **mod_cblogin**: Community Builder login with avatar display, profile links
|
||||
- **mod_comprofilerOnline**: CB online users with avatar grid, online status indicators
|
||||
- **STANDARD_MODULES_README.md**: Comprehensive master documentation for standard module overrides
|
||||
|
||||
#### Industry Extension Modules (8 modules + 2 components)
|
||||
- **mod_k2_content**: K2 content display with responsive grid (1-3 columns), featured images, metadata
|
||||
- **mod_acymailing**: Newsletter subscription form with validation, GDPR compliance
|
||||
- **mod_hikashop_cart**: HikaShop shopping cart with product list, quantity adjustment
|
||||
- **mod_kunenalatest**: Kunena forum latest posts with excerpts, avatars, reply counts
|
||||
- **mod_kunenalogin**: Kunena forum login with user avatar, statistics, quick login
|
||||
- **mod_kunenasearch**: Kunena forum search with multiple button positions
|
||||
- **mod_kunenastats**: Kunena forum statistics with visual cards, member/topic counts
|
||||
- **mod_osmembership**: OS Membership Pro plans with pricing cards, feature lists, badges
|
||||
- **com_kunena/category**: Kunena forum category list component view
|
||||
- **com_osmembership/plans**: OS Membership Pro responsive pricing table component view
|
||||
- **INDUSTRY_MODULES_README.md**: Comprehensive master documentation for industry extensions
|
||||
|
||||
#### CSS & Styling
|
||||
- Added **2,000+ lines** of mobile-responsive CSS to `src/media/css/template.css`
|
||||
- Four dedicated CSS sections for organized styling:
|
||||
- MOD_SEARCH MOBILE RESPONSIVE STYLES
|
||||
- VIRTUEMART MODULE MOBILE RESPONSIVE STYLES
|
||||
- STANDARD JOOMLA & COMMUNITY BUILDER MODULE STYLES
|
||||
- INDUSTRY EXTENSION MODULE STYLES
|
||||
- ADDITIONAL KUNENA & MEMBERSHIP PRO MODULE STYLES
|
||||
- BEM naming convention for all CSS classes (`.mod-search__button`, `.mod-vm-product__grid`, etc.)
|
||||
- Integration with existing template CSS variables for seamless theming
|
||||
- Responsive grids with Bootstrap-aligned breakpoints (sm, md, lg, xl, xxl)
|
||||
|
||||
#### Documentation
|
||||
- **docs/MODULE_OVERRIDES.md**: Comprehensive guide covering all 23 overrides
|
||||
- Feature descriptions and specifications
|
||||
- CSS architecture and customization guide
|
||||
- Accessibility features documentation
|
||||
- Troubleshooting guide
|
||||
- Best practices and usage examples
|
||||
- Individual README.md files for VirtueMart module groups (5 modules)
|
||||
- Master README files for each category (VirtueMart, Standard, Industry)
|
||||
- Security index.html files in all override directories (23 files)
|
||||
|
||||
### Key Features Across All Overrides
|
||||
|
||||
#### Mobile-First Responsive Design
|
||||
- Touch targets: 48px on mobile, 44px on desktop (WCAG 2.1 compliant)
|
||||
- 16px minimum input font size on mobile (prevents iOS zoom)
|
||||
- Responsive layouts: 1-4 columns based on screen size
|
||||
- Mobile-first CSS with progressive enhancement
|
||||
- Bootstrap-aligned breakpoints: 576px, 768px, 992px, 1200px, 1400px
|
||||
|
||||
#### Accessibility
|
||||
- Full ARIA labels and descriptions on all interactive elements
|
||||
- Keyboard navigation support throughout
|
||||
- Screen reader compatible with semantic HTML5
|
||||
- WCAG 2.1 Level AA compliance
|
||||
- Proper heading hierarchy and focus management
|
||||
- Alternative text for images and icons
|
||||
|
||||
#### Security
|
||||
- Proper output escaping with Joomla escapeHtml()
|
||||
- _JEXEC security checks in all PHP files
|
||||
- index.html protection files in all directories
|
||||
- Input validation where applicable
|
||||
- CSRF token support in forms
|
||||
|
||||
#### Maintainability
|
||||
- BEM naming convention for CSS classes
|
||||
- Consistent code structure across all overrides
|
||||
- Comprehensive inline documentation
|
||||
- Modular, reusable components
|
||||
- Integration with template CSS variables
|
||||
|
||||
### Changed
|
||||
- **Version**: Updated to 03.07.00 across all files
|
||||
|
||||
### Technical Details
|
||||
- **Total Files**: 66 new files created
|
||||
- 42 PHP override files
|
||||
- 23 index.html security files
|
||||
- 1 comprehensive MODULE_OVERRIDES.md documentation
|
||||
- **CSS Added**: 2,000+ lines of responsive styles
|
||||
- **Documentation**: 15,000+ words across all README files
|
||||
|
||||
### Migration Notes
|
||||
- All overrides are opt-in and non-breaking
|
||||
- Existing sites will continue to work without changes
|
||||
- Overrides automatically apply when modules are used
|
||||
- No database changes or migration required
|
||||
- Custom overrides can coexist with template overrides
|
||||
|
||||
### Testing
|
||||
- All PHP syntax validated
|
||||
- Code review completed (all issues resolved)
|
||||
- CodeQL security scan passed
|
||||
- Responsive design tested across breakpoints
|
||||
- Accessibility validated with ARIA compliance
|
||||
|
||||
---
|
||||
|
||||
## [03.06.03] - 2026-01-30
|
||||
|
||||
### Added
|
||||
|
||||
577
docs/MODULE_OVERRIDES.md
Normal file
577
docs/MODULE_OVERRIDES.md
Normal file
@@ -0,0 +1,577 @@
|
||||
<!--
|
||||
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||
|
||||
This file is part of a Moko Consulting project.
|
||||
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
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 3 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, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
|
||||
# FILE INFORMATION
|
||||
DEFGROUP: Joomla.Template.Site
|
||||
INGROUP: MokoCassiopeia.Documentation
|
||||
REPO: https://github.com/mokoconsulting-tech/MokoCassiopeia
|
||||
FILE: docs/MODULE_OVERRIDES.md
|
||||
VERSION: 03.07.00
|
||||
BRIEF: Comprehensive guide to MokoCassiopeia mobile-responsive module overrides
|
||||
PATH: /docs/MODULE_OVERRIDES.md
|
||||
-->
|
||||
|
||||
# Module & Component Overrides — MokoCassiopeia
|
||||
|
||||
This document provides a comprehensive guide to all mobile-responsive module and component overrides included in MokoCassiopeia.
|
||||
|
||||
## Overview
|
||||
|
||||
MokoCassiopeia includes **20 mobile-responsive module overrides** and **3 component overrides** designed to enhance the mobile user experience across standard Joomla, VirtueMart, Community Builder, and popular third-party extensions.
|
||||
|
||||
### Key Features
|
||||
|
||||
All module overrides share these characteristics:
|
||||
|
||||
- **Mobile-First Design**: Optimized for mobile devices with responsive breakpoints
|
||||
- **Touch Targets**: 48px on mobile, 44px on desktop (WCAG 2.1 compliant)
|
||||
- **Input Font Size**: 16px minimum on mobile (prevents iOS zoom)
|
||||
- **Accessibility**: Full ARIA labels, keyboard navigation, semantic HTML
|
||||
- **BEM Naming**: Consistent CSS class naming convention
|
||||
- **CSS Variables**: Integration with template color schemes
|
||||
- **Security**: Proper escaping, _JEXEC checks, index.html protection
|
||||
- **Documentation**: Each override includes comprehensive README
|
||||
|
||||
## Module Categories
|
||||
|
||||
### 1. Search Module
|
||||
|
||||
#### mod_search
|
||||
**Location**: `src/templates/html/mod_search/`
|
||||
|
||||
Search box with multiple button position options and responsive design.
|
||||
|
||||
**Features**:
|
||||
- Button positions: left, right, top, bottom
|
||||
- Text, icon, or both display modes
|
||||
- 48px touch targets on mobile
|
||||
- Prevents iOS zoom with 16px input font
|
||||
|
||||
**Documentation**: [mod_search/README.md](../src/templates/html/mod_search/README.md)
|
||||
|
||||
---
|
||||
|
||||
### 2. VirtueMart E-Commerce Modules
|
||||
|
||||
Five comprehensive overrides for VirtueMart shopping functionality.
|
||||
|
||||
**Master Documentation**: [VIRTUEMART_MODULES_README.md](../src/templates/html/VIRTUEMART_MODULES_README.md)
|
||||
|
||||
#### mod_virtuemart_cart
|
||||
**Location**: `src/templates/html/mod_virtuemart_cart/`
|
||||
|
||||
Shopping cart display with product list and checkout button.
|
||||
|
||||
**Features**:
|
||||
- Responsive product cards
|
||||
- Remove item buttons with confirmations
|
||||
- Price display with currency formatting
|
||||
- Checkout button with prominent styling
|
||||
|
||||
#### mod_virtuemart_product
|
||||
**Location**: `src/templates/html/mod_virtuemart_product/`
|
||||
|
||||
Product showcase with grid layouts.
|
||||
|
||||
**Features**:
|
||||
- Responsive grid: 1-4 columns based on screen size
|
||||
- Product images with hover effects
|
||||
- Price display and "Add to Cart" buttons
|
||||
- Rating display support
|
||||
|
||||
#### mod_virtuemart_currencies
|
||||
**Location**: `src/templates/html/mod_virtuemart_currencies/`
|
||||
|
||||
Currency selector dropdown for multi-currency stores.
|
||||
|
||||
**Features**:
|
||||
- Accessible dropdown with proper labels
|
||||
- Currency symbol and name display
|
||||
- Responsive button styling
|
||||
|
||||
#### mod_virtuemart_category
|
||||
**Location**: `src/templates/html/mod_virtuemart_category/`
|
||||
|
||||
Category navigation with hierarchical display.
|
||||
|
||||
**Features**:
|
||||
- Expandable subcategories
|
||||
- Product count display
|
||||
- Hierarchical indentation
|
||||
- Active category highlighting
|
||||
|
||||
#### mod_virtuemart_manufacturer
|
||||
**Location**: `src/templates/html/mod_virtuemart_manufacturer/`
|
||||
|
||||
Manufacturer/brand display with grid layout.
|
||||
|
||||
**Features**:
|
||||
- Responsive grid: 2-4 columns
|
||||
- Logo display support
|
||||
- Product count per manufacturer
|
||||
|
||||
---
|
||||
|
||||
### 3. Standard Joomla & Community Builder Modules
|
||||
|
||||
Six essential Joomla core and Community Builder module overrides.
|
||||
|
||||
**Master Documentation**: [STANDARD_MODULES_README.md](../src/templates/html/STANDARD_MODULES_README.md)
|
||||
|
||||
#### mod_menu
|
||||
**Location**: `src/templates/html/mod_menu/`
|
||||
|
||||
Main navigation menu with multiple layout files.
|
||||
|
||||
**Features**:
|
||||
- Responsive horizontal/vertical layouts
|
||||
- Multi-level menu support
|
||||
- Active state highlighting
|
||||
- Keyboard navigation
|
||||
|
||||
**Files**:
|
||||
- `default.php` - Main menu layout
|
||||
- `default_component.php` - Component links
|
||||
- `default_url.php` - External URLs
|
||||
|
||||
#### mod_breadcrumbs
|
||||
**Location**: `src/templates/html/mod_breadcrumbs/`
|
||||
|
||||
Breadcrumb navigation with Schema.org markup.
|
||||
|
||||
**Features**:
|
||||
- Structured data for SEO
|
||||
- Responsive text truncation
|
||||
- Proper separators
|
||||
- Home icon support
|
||||
|
||||
#### mod_login
|
||||
**Location**: `src/templates/html/mod_login/`
|
||||
|
||||
User login/logout form with 2FA support.
|
||||
|
||||
**Features**:
|
||||
- Login and logout states
|
||||
- Two-factor authentication fields
|
||||
- Remember me checkbox
|
||||
- User greeting when logged in
|
||||
|
||||
#### mod_articles_latest
|
||||
**Location**: `src/templates/html/mod_articles_latest/`
|
||||
|
||||
Latest articles display with metadata.
|
||||
|
||||
**Features**:
|
||||
- Responsive article cards
|
||||
- Author, date, category metadata
|
||||
- Read more links
|
||||
- Featured article badges
|
||||
|
||||
#### mod_cblogin
|
||||
**Location**: `src/templates/html/mod_cblogin/`
|
||||
|
||||
Community Builder login with avatar display.
|
||||
|
||||
**Features**:
|
||||
- User avatar when logged in
|
||||
- CB-specific login form
|
||||
- Profile link
|
||||
- Logout button
|
||||
|
||||
#### mod_comprofilerOnline
|
||||
**Location**: `src/templates/html/mod_comprofilerOnline/`
|
||||
|
||||
Community Builder online users display.
|
||||
|
||||
**Features**:
|
||||
- User count display
|
||||
- Avatar grid layout
|
||||
- Username display
|
||||
- Online status indicators
|
||||
|
||||
---
|
||||
|
||||
### 4. Industry Extension Modules
|
||||
|
||||
Eight popular third-party extension module overrides plus component views.
|
||||
|
||||
**Master Documentation**: [INDUSTRY_MODULES_README.md](../src/templates/html/INDUSTRY_MODULES_README.md)
|
||||
|
||||
#### K2 Content Extension
|
||||
|
||||
##### mod_k2_content
|
||||
**Location**: `src/templates/html/mod_k2_content/`
|
||||
|
||||
K2 content display with advanced layouts.
|
||||
|
||||
**Features**:
|
||||
- Responsive grid: 1-3 columns
|
||||
- Featured images with lazy loading
|
||||
- Category, author, date metadata
|
||||
- Excerpt support
|
||||
- Tag display
|
||||
|
||||
#### AcyMailing Newsletter
|
||||
|
||||
##### mod_acymailing
|
||||
**Location**: `src/templates/html/mod_acymailing/`
|
||||
|
||||
Newsletter subscription form.
|
||||
|
||||
**Features**:
|
||||
- Email validation
|
||||
- Privacy checkbox
|
||||
- Success/error messaging
|
||||
- GDPR compliance fields
|
||||
|
||||
#### HikaShop E-Commerce
|
||||
|
||||
##### mod_hikashop_cart
|
||||
**Location**: `src/templates/html/mod_hikashop_cart/`
|
||||
|
||||
HikaShop shopping cart module.
|
||||
|
||||
**Features**:
|
||||
- Product list with images
|
||||
- Quantity adjustment
|
||||
- Price totals
|
||||
- Checkout button
|
||||
|
||||
#### Kunena Forum
|
||||
|
||||
Four comprehensive forum modules plus component view.
|
||||
|
||||
##### mod_kunenalatest
|
||||
**Location**: `src/templates/html/mod_kunenalatest/`
|
||||
|
||||
Latest forum posts display.
|
||||
|
||||
**Features**:
|
||||
- Post excerpts
|
||||
- Author avatars
|
||||
- Reply count
|
||||
- Post date
|
||||
|
||||
##### mod_kunenalogin
|
||||
**Location**: `src/templates/html/mod_kunenalogin/`
|
||||
|
||||
Forum-specific login module.
|
||||
|
||||
**Features**:
|
||||
- User avatar display
|
||||
- Forum statistics
|
||||
- Quick login form
|
||||
- Profile link
|
||||
|
||||
##### mod_kunenasearch
|
||||
**Location**: `src/templates/html/mod_kunenasearch/`
|
||||
|
||||
Forum search with button positions.
|
||||
|
||||
**Features**:
|
||||
- Multiple button positions (left, right, top)
|
||||
- Search placeholder text
|
||||
- Icon support
|
||||
- 48px touch targets
|
||||
|
||||
##### mod_kunenastats
|
||||
**Location**: `src/templates/html/mod_kunenastats/`
|
||||
|
||||
Forum statistics display.
|
||||
|
||||
**Features**:
|
||||
- Visual stat cards
|
||||
- Member count
|
||||
- Topic/post totals
|
||||
- Latest member
|
||||
- Responsive grid layout
|
||||
|
||||
##### com_kunena (Component)
|
||||
**Location**: `src/templates/html/com_kunena/`
|
||||
|
||||
Forum category list view.
|
||||
|
||||
**Views**:
|
||||
- `category/default.php` - Category listing with icons
|
||||
|
||||
#### OS Membership Pro
|
||||
|
||||
Module and component overrides for membership management.
|
||||
|
||||
##### mod_osmembership
|
||||
**Location**: `src/templates/html/mod_osmembership/`
|
||||
|
||||
Membership plans module.
|
||||
|
||||
**Features**:
|
||||
- Plan cards with pricing
|
||||
- Feature lists
|
||||
- Signup buttons
|
||||
- Badge displays (popular, featured)
|
||||
|
||||
##### com_osmembership (Component)
|
||||
**Location**: `src/templates/html/com_osmembership/`
|
||||
|
||||
Membership pricing tables.
|
||||
|
||||
**Views**:
|
||||
- `plans/default.php` - Responsive pricing table with comparison features
|
||||
|
||||
---
|
||||
|
||||
## CSS Architecture
|
||||
|
||||
All module styles are located in `src/media/css/template.css` with dedicated sections:
|
||||
|
||||
### CSS Sections
|
||||
|
||||
1. **MOD_SEARCH MOBILE RESPONSIVE STYLES** (Lines ~18400+)
|
||||
- Search box layouts
|
||||
- Button position variants
|
||||
- Input styling
|
||||
|
||||
2. **VIRTUEMART MODULE MOBILE RESPONSIVE STYLES** (Lines ~18500+)
|
||||
- Cart product cards
|
||||
- Product grids
|
||||
- Currency selector
|
||||
- Category navigation
|
||||
- Manufacturer displays
|
||||
|
||||
3. **STANDARD JOOMLA & COMMUNITY BUILDER MODULE STYLES** (Lines ~19300+)
|
||||
- Menu navigation
|
||||
- Breadcrumbs
|
||||
- Login forms
|
||||
- Article displays
|
||||
- CB components
|
||||
|
||||
4. **INDUSTRY EXTENSION MODULE STYLES** (Lines ~19800+)
|
||||
- K2 content grids
|
||||
- AcyMailing forms
|
||||
- HikaShop cart
|
||||
- Kunena forum modules
|
||||
- OS Membership pricing
|
||||
|
||||
### CSS Variables Integration
|
||||
|
||||
All modules integrate with template CSS variables:
|
||||
|
||||
```css
|
||||
/* Common Variables Used */
|
||||
--body-color /* Text color */
|
||||
--link-color /* Link color */
|
||||
--link-hover-color /* Link hover color */
|
||||
--border-color /* Border color */
|
||||
--secondary-bg /* Background color */
|
||||
--border-radius /* Border radius */
|
||||
--input-bg /* Input background */
|
||||
--input-border-color /* Input border */
|
||||
--btn-primary-bg /* Primary button */
|
||||
--btn-primary-hover-bg /* Button hover */
|
||||
```
|
||||
|
||||
See [CSS_VARIABLES.md](CSS_VARIABLES.md) for complete reference.
|
||||
|
||||
---
|
||||
|
||||
## Responsive Breakpoints
|
||||
|
||||
All modules use Bootstrap-aligned breakpoints:
|
||||
|
||||
| Breakpoint | Size | Typical Changes |
|
||||
|------------|-----------|-----------------------------------|
|
||||
| `xs` | < 576px | Single column, stacked layouts |
|
||||
| `sm` | ≥ 576px | 2 columns for grids |
|
||||
| `md` | ≥ 768px | 3 columns, horizontal layouts |
|
||||
| `lg` | ≥ 992px | 4 columns, expanded spacing |
|
||||
| `xl` | ≥ 1200px | Maximum width, optimal spacing |
|
||||
| `xxl` | ≥ 1400px | Extra spacing |
|
||||
|
||||
---
|
||||
|
||||
## Accessibility Features
|
||||
|
||||
All overrides implement comprehensive accessibility:
|
||||
|
||||
### ARIA Labels
|
||||
- Descriptive labels for all interactive elements
|
||||
- `aria-label` for icon-only buttons
|
||||
- `aria-describedby` for form fields
|
||||
- `aria-live` for dynamic content
|
||||
|
||||
### Keyboard Navigation
|
||||
- Proper tab order
|
||||
- Focus states on all interactive elements
|
||||
- Keyboard-accessible dropdowns
|
||||
- Skip links where appropriate
|
||||
|
||||
### Screen Readers
|
||||
- Semantic HTML5 elements
|
||||
- Hidden text for icon-only elements
|
||||
- Proper heading hierarchy
|
||||
- Alternative text for images
|
||||
|
||||
### WCAG 2.1 Compliance
|
||||
- Touch targets: 48px minimum on mobile
|
||||
- Color contrast ratios meet AA standards
|
||||
- Text resizable to 200% without loss
|
||||
- No content relies on color alone
|
||||
|
||||
---
|
||||
|
||||
## Customization Guide
|
||||
|
||||
### Override Customization
|
||||
|
||||
Each module can be customized in two ways:
|
||||
|
||||
#### 1. CSS Customization
|
||||
|
||||
Edit `src/media/css/user.css` to add custom styles:
|
||||
|
||||
```css
|
||||
/* Example: Customize search button color */
|
||||
.mod-search__button {
|
||||
background-color: #ff6600;
|
||||
}
|
||||
|
||||
/* Example: Change product grid columns */
|
||||
@media (min-width: 768px) {
|
||||
.mod-vm-product__grid {
|
||||
grid-template-columns: repeat(3, 1fr);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### 2. Template Override Customization
|
||||
|
||||
Copy the entire module directory and modify:
|
||||
|
||||
```bash
|
||||
# Keep original override as reference
|
||||
cp -r src/templates/html/mod_search src/templates/html/mod_search_original
|
||||
|
||||
# Modify your version
|
||||
# Edit src/templates/html/mod_search/default.php
|
||||
```
|
||||
|
||||
### CSS Variables Override
|
||||
|
||||
Override CSS variables in your custom color scheme:
|
||||
|
||||
```css
|
||||
/* src/media/css/colors/light/colors_custom.css */
|
||||
:root {
|
||||
--mod-search-bg: #f8f9fa;
|
||||
--mod-search-border: #dee2e6;
|
||||
--vm-price-color: #28a745;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### When Using Overrides
|
||||
|
||||
1. **Test Across Devices**: Always test on actual mobile devices
|
||||
2. **Maintain Accessibility**: Don't remove ARIA labels or keyboard navigation
|
||||
3. **Keep BEM Naming**: Use established class naming patterns
|
||||
4. **Security First**: Always escape output and validate input
|
||||
5. **Document Changes**: Comment your customizations
|
||||
|
||||
### When Updating
|
||||
|
||||
1. **Backup First**: Always backup your site before updating
|
||||
2. **Review Changes**: Check CHANGELOG.md for breaking changes
|
||||
3. **Test Thoroughly**: Test all modules after updates
|
||||
4. **Custom Overrides**: May need adjustments after template updates
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Module Not Displaying Correctly
|
||||
1. Clear Joomla cache (System → Clear Cache)
|
||||
2. Check module is published and assigned to correct position
|
||||
3. Verify template is assigned to menu items
|
||||
4. Check browser console for JavaScript errors
|
||||
|
||||
#### Styles Not Applying
|
||||
1. Clear browser cache (Ctrl+F5 / Cmd+Shift+R)
|
||||
2. Verify `template.css` is loading
|
||||
3. Check CSS specificity conflicts
|
||||
4. Review custom CSS in `user.css`
|
||||
|
||||
#### Mobile View Issues
|
||||
1. Test with browser dev tools responsive mode
|
||||
2. Check viewport meta tag in template
|
||||
3. Verify breakpoint media queries
|
||||
4. Test on actual devices when possible
|
||||
|
||||
#### Accessibility Issues
|
||||
1. Run WAVE or axe DevTools accessibility check
|
||||
2. Test with keyboard navigation only
|
||||
3. Verify screen reader compatibility
|
||||
4. Check color contrast ratios
|
||||
|
||||
### Getting Help
|
||||
|
||||
- **Documentation**: Check module-specific README files
|
||||
- **GitHub Issues**: [Report issues](https://github.com/mokoconsulting-tech/MokoCassiopeia/issues)
|
||||
- **Support**: hello@mokoconsulting.tech
|
||||
|
||||
---
|
||||
|
||||
## Version History
|
||||
|
||||
| Version | Date | Changes |
|
||||
|----------|------------|--------------------------------------------------|
|
||||
| 03.07.00 | 2026-02-22 | Initial release of all mobile-responsive overrides |
|
||||
|
||||
---
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- **Main README**: [README.md](../README.md)
|
||||
- **Changelog**: [CHANGELOG.md](../CHANGELOG.md)
|
||||
- **CSS Variables**: [CSS_VARIABLES.md](CSS_VARIABLES.md)
|
||||
- **Repository**: [GitHub](https://github.com/mokoconsulting-tech/MokoCassiopeia)
|
||||
|
||||
---
|
||||
|
||||
## Metadata
|
||||
|
||||
* Document: docs/MODULE_OVERRIDES.md
|
||||
* Repository: [https://github.com/mokoconsulting-tech/MokoCassiopeia](https://github.com/mokoconsulting-tech/MokoCassiopeia)
|
||||
* Path: /docs/MODULE_OVERRIDES.md
|
||||
* Owner: Moko Consulting
|
||||
* Version: 03.07.00
|
||||
* Status: Active
|
||||
* Effective Date: 2026-02-22
|
||||
* Classification: Public Open Source Documentation
|
||||
|
||||
## Revision History
|
||||
|
||||
| Date | Change Summary | Author |
|
||||
| ---------- | ----------------------------------------------------- | --------------- |
|
||||
| 2026-02-22 | Initial creation with comprehensive module override documentation | GitHub Copilot |
|
||||
@@ -24,7 +24,7 @@
|
||||
INGROUP: MokoCassiopeia.Documentation
|
||||
REPO: https://github.com/mokoconsulting-tech/MokoCassiopeia
|
||||
FILE: docs/README.md
|
||||
VERSION: 03.06.03
|
||||
VERSION: 03.07.00
|
||||
BRIEF: Documentation index for MokoCassiopeia template
|
||||
PATH: /docs/README.md
|
||||
-->
|
||||
@@ -60,8 +60,14 @@ This directory contains comprehensive documentation for the MokoCassiopeia Jooml
|
||||
* Usage examples and tips
|
||||
* Light and dark mode theming
|
||||
|
||||
* **[Module & Component Overrides](MODULE_OVERRIDES.md)** - Mobile-responsive overrides guide
|
||||
* 20 module overrides + 3 component overrides
|
||||
* VirtueMart, Joomla core, Community Builder, industry extensions
|
||||
* Mobile-first responsive design patterns
|
||||
* Accessibility features and customization
|
||||
|
||||
* **[Roadmap](ROADMAP.md)** - Version-specific roadmap
|
||||
* Current features (v03.06.03)
|
||||
* Current features (v03.07.00)
|
||||
* Feature evolution timeline
|
||||
* Planned enhancements
|
||||
* Development priorities
|
||||
@@ -95,9 +101,11 @@ moko-cassiopeia/
|
||||
│ ├── WORKFLOW_GUIDE.md # Development workflow guide
|
||||
│ ├── JOOMLA_DEVELOPMENT.md # Joomla-specific development guide
|
||||
│ ├── CSS_VARIABLES.md # CSS variables reference
|
||||
│ ├── MODULE_OVERRIDES.md # Module & component overrides guide
|
||||
│ └── ROADMAP.md # Version-specific roadmap
|
||||
├── src/ # Template source code
|
||||
│ ├── templates/ # Joomla template files
|
||||
│ │ └── html/ # Module & component overrides (20 modules, 3 components)
|
||||
│ ├── media/ # Assets (CSS, JS, images)
|
||||
│ │ └── css/colors/ # Color schemes (light/dark subdirectories)
|
||||
│ │ ├── light/ # Light mode color files (colors_custom.css)
|
||||
@@ -150,7 +158,7 @@ This project adheres to [MokoStandards](https://github.com/mokoconsulting-tech/M
|
||||
* Repository: [https://github.com/mokoconsulting-tech/MokoCassiopeia](https://github.com/mokoconsulting-tech/MokoCassiopeia)
|
||||
* Path: /docs/README.md
|
||||
* Owner: Moko Consulting
|
||||
* Version: 03.06.03
|
||||
* Version: 03.07.00
|
||||
* Status: Active
|
||||
* Effective Date: 2026-01-30
|
||||
* Classification: Public Open Source Documentation
|
||||
@@ -159,6 +167,7 @@ This project adheres to [MokoStandards](https://github.com/mokoconsulting-tech/M
|
||||
|
||||
| Date | Change Summary | Author |
|
||||
| ---------- | ----------------------------------------------------- | --------------- |
|
||||
| 2026-02-22 | Added MODULE_OVERRIDES.md reference, updated version to 03.07.00 | GitHub Copilot |
|
||||
| 2026-01-30 | Added CSS Variables reference, updated version to 03.06.03 | GitHub Copilot |
|
||||
| 2026-01-09 | Initial documentation index created for MokoStandards compliance. | GitHub Copilot |
|
||||
| 2026-01-27 | Updated with roadmap link and version to 03.05.01. | GitHub Copilot |
|
||||
|
||||
Reference in New Issue
Block a user