GuidePlugin DocsOverview
Understand how GuidePlugin components work together to create powerful filtering experiences.
GuidePlugin creates guided user experiences through interconnected components. Understanding how these components work together is essential for building effective guides.
Component Architecture
Core Components
| Component | Facets | Filters | Guides | Templates |
|---|---|---|---|---|
| Purpose | Data extraction and indexing | User interaction questions | Complete experience orchestration | Result display formatting |
| Analogy | Filing cabinet categories | Survey questions | Complete survey | Report layout |
| Required For | All functionality | User interactions | Publishing guides | Showing results |
| Creates | Searchable data points | Step-by-step questions | Complete user journeys | Styled result displays |
How Components Connect
Data Flow
- Content Analysis Facets scan WordPress content for characteristics
- Data Indexing Optimized tables created for fast filtering
- Filter Creation Facets become user-selectable options
- Guide Assembly Filters combined into complete experiences
- Result Display Templates format and show filtered content
Component Dependencies
| To Create This | You First Need |
|---|---|
| Filter | At least 1 Facet with data |
| Guide | At least 1 Filter + 1 Template |
| Complete Experience | Facets + Filters + Guide + Template + Index |
Real-World Example: E-Commerce Store
Let's see how components work together for a product finder:
Facets Setup
| Facet Name | Data Source | Generated Values |
|---|---|---|
| Product Category | WooCommerce categories | Shoes, Clothes, Electronics |
| Price Range | Product price field | $0-50, $51-100, $101-200, $200+ |
| Brand | Product attribute | Nike, Apple, Sony, Samsung |
| Rating | Review average | 1-2 stars, 3 stars, 4 stars, 5 stars |
Filter Questions
| Filter Name | Question | Type | Linked Facets |
|---|---|---|---|
| Category Filter | "What are you shopping for?" | Cards | Product Category |
| Budget Filter | "What's your budget?" | Slider | Price Range |
| Brand Filter | "Any preferred brands?" | Cards | Brand |
Guide Structure
- Welcome - "Find your perfect product"
- Step 1 - Category selection (Category Filter)
- Step 2 - Budget range (Budget Filter)
- Step 3 - Brand preference (Brand Filter)
- Results - Filtered products with Template styling
Template Layout
- Product Title (linked to product page)
- Product Image
- Price (from WooCommerce)
- Rating Stars (from reviews)
- "Add to Cart" Button
Component Creation Order
Best Practice: Always create components in this order to avoid dependency issues and ensure smooth setup.
Recommended Sequence
| Step | Component | Why This Order |
|---|---|---|
| 1 | Facets | Must extract data before creating filters |
| 2 | Filters | Need facets to create meaningful questions |
| 3 | Templates | Define how results appear |
| 4 | Guides | Combine all components together |
| 5 | Index | Build searchable database |
Component Relationships
One-to-Many Relationships
- 1 Facet → Multiple Filters (same data, different questions)
- 1 Filter → Multiple Guides (reuse questions across guides)
- 1 Template → Multiple Guides (consistent result styling)
Many-to-One Relationships
- Multiple Facets → 1 Filter (complex filtering options)
- Multiple Filters → 1 Guide (complete user journey)
Performance Considerations
| Component | Performance Impact | Optimization Tips |
|---|---|---|
| Facets | Medium - affects indexing speed | Limit to essential characteristics, use efficient data sources |
| Filters | Low - minimal impact | Keep filter options under 10 per question |
| Guides | Low - just orchestration | Limit to 5-7 filters maximum |
| Templates | Medium - affects result display | Use efficient modules, optimize images |
| Index | High during build, fast during use | Schedule rebuilds during low traffic |
Common Architecture Patterns
Simple Product Finder
Facets: Category, Price
Filters: "What type?" + "Budget?"
Guide: 2-step experience
Template: Title + Price + Button
Advanced Real Estate Search
Facets: Location, Bedrooms, Price, Property Type
Filters: Location + Bedrooms + Budget + Type
Guide: 4-step detailed experience
Template: Address + Key details + Features list + Contact button
Content Recommendation Engine
Facets: Topic, Reading Time, Difficulty
Filters: Interest + Available time + Skill level
Guide: 3-step personalized experience
Template: Title + Meta info + Excerpt + Read more
Next Steps
Now that you understand the architecture:
| Action | Purpose | Link |
|---|---|---|
| Start Building | Create your first complete guide | Getting Started → |
| Learn Facets | Master data extraction and indexing | Facets Documentation → |
| Create Filters | Build interactive user questions | Filters Documentation → |