Skip to content

Commit 949a0ae

Browse files
committed
Enhance documentation formatting and add new Permalinks tutorial
- Updated RATING-SYSTEM.md, README.md, STYLE-CUSTOMIZATION.md, and STYLES-ARCHITECTURE-RELEASE.md to improve readability with consistent use of bold and italic styles. - Added a comprehensive PERMALINKS-TUTORIAL.md to guide users on configuring permalinks in both free and Pro versions, including examples and troubleshooting tips.
1 parent fd56cc0 commit 949a0ae

File tree

8 files changed

+456
-348
lines changed

8 files changed

+456
-348
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,28 @@ Effortlessly create a powerful, multi-product knowledge base. Boost your support
3232

3333
### Main features
3434

35-
🚀 Unlimited Knowledge Bases — Support as many products as you like, with unlimited sections and sub-sections.
36-
🎨 Beautiful, Responsive Layouts — Ships with clean templates powered by the Responsive Grid System.
37-
🔗 Customisable Permalinks — View your KB at /knowledgebase/ by default or change it easily.
38-
✨ Shortcodes + Gutenberg Blocks — Add KB listings anywhere using [knowledgebase] or use the Knowledge Base block.
39-
🧭 Built-in Breadcrumbs — Improve UX and SEO with breadcrumb navigation.
40-
🧩 Widgets Included — WZKB Articles, WZKB Sections, and WZKB Breadcrumbs widgets.
41-
⚡ Built-in Caching — Speed up your Knowledge Base without extra plugins.
35+
- 🚀 __Unlimited Knowledge Bases__ — Support as many products as you like, with unlimited sections and sub-sections.
36+
- 🎨 __Beautiful, Responsive Layouts__ — Ships with clean templates powered by the Responsive Grid System.
37+
- 🔗 __Customisable Permalinks__ — View your KB at /knowledgebase/ by default or change it easily.
38+
-__Shortcodes + Gutenberg Blocks__ — Add KB listings anywhere using [knowledgebase] or use the Knowledge Base block.
39+
- 🧭 __Built-in Breadcrumbs__ — Improve UX and SEO with breadcrumb navigation.
40+
- 🧩 __Widgets Included__ — WZKB Articles, WZKB Sections, and WZKB Breadcrumbs widgets.
41+
-__Built-in Caching__ — Speed up your Knowledge Base without extra plugins.
4242

4343
### Pro features
4444

45-
⭐ Article Rating System — Collect binary or 5-star feedback with optional follow-up questions, admin alerts, Bayesian sorting, and GDPR-friendly tracking modes.
45+
-__Article Rating & Feedback System__ — Collect binary or 5-star feedback with optional follow-up questions, admin alerts, Bayesian sorting, and GDPR-friendly tracking modes.
46+
- 💬 __Beacon Help Widget__ — Offer an in-app support hub with live search, suggested articles, and a contact form inside a floating assistant.
47+
- 🧭 __Custom Permalinks Engine__ — Craft advanced URL structures for articles, sections, tags, and products using dynamic placeholders.
48+
- 🎨 __Premium Layout Pack__ — Unlock seven additional frontend styles (Card, Minimal, Boxed, Gradient, Compact, Magazine, Professional).
49+
- 🛠️ __Advanced Admin Tools__ — Control knowledge base caching with expiry settings, on-demand cache clearing, and other productivity enhancements.
4650

4751
### Key Concepts
4852

49-
* __Articles:__ Custom post type `wz_knowledgebase` — your FAQs, how-to guides, and documentation.
50-
* __Products:__ Custom taxonomy `wzkb_product` — link articles to one or more products.
51-
* __Sections:__ Custom taxonomy `wzkb_category` — organize content neatly into categories.
52-
* __Tags:__ Optional `wzkb_tag` taxonomy — make finding content even easier.
53+
- __Articles:__ Custom post type `wz_knowledgebase` — your FAQs, how-to guides, and documentation.
54+
- __Products:__ Custom taxonomy `wzkb_product` — link articles to one or more products.
55+
- __Sections:__ Custom taxonomy `wzkb_category` — organize content neatly into categories.
56+
- __Tags:__ Optional `wzkb_tag` taxonomy — make finding content even easier.
5357

5458
### Contribute
5559

docs/BEACON-WIDGET.md

Lines changed: 69 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -6,60 +6,60 @@ The Beacon is a floating help widget that provides self-service support with sea
66

77
### Core Functionality
88

9-
- **Floating Button** - Customizable button that sits at the bottom right (or left) of the screen
10-
- **Self-Service Search** - Search knowledge base articles with debounced AJAX search (500ms)
11-
- **Smart Suggested Articles** - Context-aware articles using Related class for KB posts, recent articles elsewhere
12-
- **Contact Form** - HTML email contact with beautiful template when articles don't help
13-
- **Built-in Spam Protection** - Honeypot field plus anonymous rate limiting without storing IPs
14-
- **Minimum Message Length** - Requires at least 30 characters before submitting (filterable)
15-
- **Stacked Navigation** - Mobile-app-style layered interface for smooth UX
16-
- **Responsive Design** - Works beautifully on desktop, tablet, and mobile devices
17-
- **Fixed Search Box** - Search box locked at bottom using CSS Grid for optimal UX
18-
- **Related Articles Integration** - Reuses existing Related class logic (DRY principle)
9+
- __Floating Button__ Customizable button that sits at the bottom right (or left) of the screen.
10+
- __Self-Service Search__ Search knowledge base articles with debounced AJAX search (500ms).
11+
- __Smart Suggested Articles__ Context-aware articles using Related class for KB posts, recent articles elsewhere.
12+
- __Contact Form__ HTML email contact with beautiful template when articles do not help.
13+
- __Built-in Spam Protection__ Honeypot field plus anonymous rate limiting without storing IPs.
14+
- __Minimum Message Length__ Requires at least 30 characters before submitting (filterable).
15+
- __Stacked Navigation__ Mobile-app-style layered interface for smooth UX.
16+
- __Responsive Design__ Works beautifully on desktop, tablet, and mobile devices.
17+
- __Fixed Search Box__ Search box locked at bottom using CSS Grid for optimal UX.
18+
- __Related Articles Integration__ Reuses existing Related class logic (DRY principle).
1919

2020
### Design Features
2121

22-
- **Customizable Appearance** - Colors, position, button style, and labels
23-
- **Dark Mode Support** - Automatically adapts to user's color scheme preference
24-
- **Smooth Animations** - Polished transitions and hover effects
25-
- **Accessibility** - Keyboard navigation, focus states, and ARIA labels
26-
- **Modern UI** - Clean, professional design with rounded corners and shadows
27-
- **Smart Color Palette** - Setup wizard derives hover/text/link colors from your primary brand color while keeping the panel background white for readability
22+
- __Customizable Appearance__ Colors, position, button style, and labels.
23+
- __Dark Mode Support__ Automatically adapts to the users color scheme preference.
24+
- __Smooth Animations__ Polished transitions and hover effects.
25+
- __Accessibility__ Keyboard navigation, focus states, and ARIA labels.
26+
- __Modern UI__ Clean, professional design with rounded corners and shadows.
27+
- __Smart Color Palette__ Setup wizard derives hover/text/link colors from your primary brand color while keeping the panel background white for readability.
2828

2929
## Configuration
3030

3131
### Admin Settings
3232

33-
Navigate to **Knowledge Base > Settings > Output** and scroll to the **Beacon Help Widget** section.
33+
Navigate to __Knowledge Base Settings → Output__ and scroll to the __Beacon Help Widget__ section.
3434

3535
#### Basic Settings
3636

37-
- **Enable Beacon** - Turn the beacon on/off
38-
- **Button Position** - Choose bottom right or bottom left
39-
- **Button Style** - Icon only, text only, or icon + text
40-
- **Button Text** - Custom text for the button (default: "Help")
41-
- **Beacon Color** - Primary color for button and UI elements (default: #617DEC)
37+
- __Enable Beacon__ Turn the beacon on/off.
38+
- __Button Position__ Choose bottom right or bottom left.
39+
- __Button Style__ Icon only, text only, or icon + text.
40+
- __Button Text__ Custom text for the button (default: Help”).
41+
- __Beacon Color__ - Primary color for button and UI elements (default: #617DEC)
4242

43-
> **Setup Wizard Color Tips:** When using the setup wizard, choosing a primary color automatically generates a full palette (button hover, text, panel text, and link hover colors) with contrast-aware values. The panel background is intentionally kept white to maintain content readability.
43+
> __Setup Wizard Color Tips:__ When using the setup wizard, choosing a primary color automatically generates a full palette (button hover, text, panel text, and link hover colors) with contrast-aware values. The panel background is intentionally kept white to maintain content readability.
4444
4545
#### Content Settings
4646

47-
- **Greeting Message** - Welcome message when beacon opens (default: "Hi! How can we help you?")
48-
- **Search Placeholder** - Placeholder text for search input (default: "Search for answers...")
47+
- __Greeting Message__ Welcome message when beacon opens (default: Hi! How can we help you?”).
48+
- __Search Placeholder__ Placeholder text for search input (default: Search for answers…”).
4949

5050
#### Contact Form Settings
5151

52-
- **Enable Contact Form** - Allow visitors to send messages
53-
- **Contact Email** - Email address for form submissions (default: admin email)
54-
- **Minimum Message Length** - Require visitors to enter at least 30 characters (default: 30, filterable)
52+
- __Enable Contact Form__ Allow visitors to send messages.
53+
- __Contact Email__ Email address for form submissions (default: admin email).
54+
- __Minimum Message Length__ Require visitors to enter at least 30 characters (default: 30, filterable).
5555

5656
#### Display Options
5757

58-
- **Display Location** - Choose where beacon appears:
59-
- **Knowledge Base Only** (default) - Shows only on KB pages (singles, archives, taxonomies)
60-
- **Entire Site** - Shows sitewide
61-
- **Show on Mobile** - Display beacon on mobile devices
62-
- **Enable Animations** - Smooth animations and transitions
58+
- __Display Location__ Choose where beacon appears:
59+
- __Knowledge Base Only__ (default) Shows only on KB pages (singles, archives, taxonomies).
60+
- __Entire Site__ Shows sitewide.
61+
- __Show on Mobile__ - Display beacon on mobile devices
62+
- __Enable Animations__ - Smooth animations and transitions
6363

6464
## JavaScript API
6565

@@ -166,7 +166,7 @@ The beacon uses CSS Grid for a robust, modern layout:
166166
}
167167
```
168168

169-
**Benefits:**
169+
__Benefits:__
170170

171171
- Search box always visible at bottom
172172
- Articles scroll independently
@@ -178,8 +178,8 @@ The beacon uses CSS Grid for a robust, modern layout:
178178

179179
The search box appears at the bottom of:
180180

181-
1. **Home Screen** - Below suggested articles and contact button
182-
2. **Search Results Screen** - Below search results
181+
1. __Home Screen__ - Below suggested articles and contact button
182+
2. __Search Results Screen__ - Below search results
183183

184184
Both use the same CSS Grid layout ensuring the search box is always accessible without scrolling.
185185

@@ -206,7 +206,7 @@ add_filter( 'wzkb_beacon_labels', function( $labels ) {
206206
} );
207207
```
208208

209-
**Available Labels:**
209+
__Available Labels:__
210210

211211
- `greeting` - Welcome message on home screen
212212
- `searchPlaceholder` - Search input placeholder
@@ -235,9 +235,9 @@ add_filter( 'wzkb_beacon_labels', function( $labels ) {
235235

236236
The beacon intelligently suggests articles based on context:
237237

238-
1. **On KB Articles** - Shows related articles using the Related class (same categories/tags)
239-
2. **On Other Pages** - Shows recent KB articles
240-
3. **Custom Override** - Use filter to provide specific articles
238+
1. __On KB Articles__ - Shows related articles using the Related class (same categories/tags)
239+
2. __On Other Pages__ - Shows recent KB articles
240+
3. __Custom Override__ - Use filter to provide specific articles
241241

242242
#### Custom Suggested Articles
243243

@@ -348,11 +348,11 @@ Add custom styles to override defaults:
348348

349349
### Files
350350

351-
- **PHP Class**: `includes/pro/beacon/class-beacon.php`
352-
- **JavaScript**: `includes/pro/beacon/js/beacon.js` (and `beacon.min.js`)
353-
- **CSS**: `includes/pro/beacon/css/beacon.css` (and `beacon.min.css`)
354-
- **Settings**: `includes/admin/class-settings.php`
355-
- **Related Integration**: `includes/frontend/class-related.php`
351+
- __PHP Class__: `includes/pro/beacon/class-beacon.php`
352+
- __JavaScript__: `includes/pro/beacon/js/beacon.js` (and `beacon.min.js`)
353+
- __CSS__: `includes/pro/beacon/css/beacon.css` (and `beacon.min.css`)
354+
- __Settings__: `includes/admin/class-settings.php`
355+
- __Related Integration__: `includes/frontend/class-related.php`
356356

357357
### AJAX Endpoints
358358

@@ -430,12 +430,12 @@ Add custom styles to override defaults:
430430

431431
## Best Practices
432432

433-
1. **Keep Suggested Articles Relevant** - Use the filter to show contextual articles
434-
2. **Test on Mobile** - Ensure beacon works well on all devices
435-
3. **Monitor Contact Submissions** - Set up proper email notifications
436-
4. **Customize Colors** - Match your brand colors
437-
5. **Add Analytics** - Track beacon usage with custom events
438-
6. **Optimize Search** - Ensure articles have good titles and excerpts
433+
1. __Keep Suggested Articles Relevant__ - Use the filter to show contextual articles
434+
2. __Test on Mobile__ - Ensure beacon works well on all devices
435+
3. __Monitor Contact Submissions__ - Set up proper email notifications
436+
4. __Customize Colors__ - Match your brand colors
437+
5. __Add Analytics__ - Track beacon usage with custom events
438+
6. __Optimize Search__ - Ensure articles have good titles and excerpts
439439

440440
## Examples
441441

@@ -559,24 +559,24 @@ Enhanced search results experience:
559559

560560
### Version 3.0.0
561561

562-
- **NEW**: CSS Grid layout for robust positioning
563-
- **NEW**: Search box locked at bottom (home + search screens)
564-
- **NEW**: Related articles integration using Related class
565-
- **NEW**: Customizable labels via `wzkb_beacon_labels` filter
566-
- **NEW**: Display location setting (KB only or sitewide)
567-
- **NEW**: "Haven't found what you're looking for" message
568-
- **NEW**: Contact button in search results
569-
- **NEW**: RTL (Right-to-Left) language support with automatic detection
570-
- **IMPROVED**: No horizontal scrollbar with `overflow-x: hidden`
571-
- **IMPROVED**: Word wrapping for long content
572-
- **IMPROVED**: Scrollable content area with fixed search
573-
- **IMPROVED**: HTML email template for contact form
574-
- **IMPROVED**: State persistence (no reset on close)
575-
- **IMPROVED**: DRY principle - reuses Related class logic
576-
- **FIXED**: Duplicate ID issues (now uses classes)
577-
- **FIXED**: Search box positioning issues
578-
- **FIXED**: Cache busting for CSS/JS updates
579-
- **FIXED**: RTL CSS files now load automatically based on `is_rtl()`
562+
- __NEW__: CSS Grid layout for robust positioning
563+
- __NEW__: Search box locked at bottom (home + search screens)
564+
- __NEW__: Related articles integration using Related class
565+
- __NEW__: Customizable labels via `wzkb_beacon_labels` filter
566+
- __NEW__: Display location setting (KB only or sitewide)
567+
- __NEW__: "Haven't found what you're looking for" message
568+
- __NEW__: Contact button in search results
569+
- __NEW__: RTL (Right-to-Left) language support with automatic detection
570+
- __IMPROVED__: No horizontal scrollbar with `overflow-x: hidden`
571+
- __IMPROVED__: Word wrapping for long content
572+
- __IMPROVED__: Scrollable content area with fixed search
573+
- __IMPROVED__: HTML email template for contact form
574+
- __IMPROVED__: State persistence (no reset on close)
575+
- __IMPROVED__: DRY principle - reuses Related class logic
576+
- __FIXED__: Duplicate ID issues (now uses classes)
577+
- __FIXED__: Search box positioning issues
578+
- __FIXED__: Cache busting for CSS/JS updates
579+
- __FIXED__: RTL CSS files now load automatically based on `is_rtl()`
580580

581581
### Version 2.0.0
582582

0 commit comments

Comments
 (0)