Skip to main content

Smart Interlink - Quick Reference Guide

Compatibility:  
Extension type:   plugin icon
Version:   3.1.1

One-Minute Overview

What: Intelligent internal linking tool for Joomla articles
How: Select text → Click Smart Link → Choose article → Done
Uses: Joomla Smart Search index for instant, relevant results
Compatibility: Joomla 4, 5, 6 | TinyMCE editor | JCE editor


Quick Start

Installation (3 Steps)

  1. Extensions → Manage → Install → Upload plugin ZIP
  2. System → Plugins → Enable "System - Smart Interlink"
  3. Start writing! Button appears automatically in editor

First Use (4 Steps)

  1. Open any article in Joomla admin
  2. Select text you want to link
  3. Click "🔗 Smart Link" button in toolbar
  4. Click "Link" on your chosen result

Key Features at a Glance

Feature

Description

Real-time Search

Instant results as you select text

Smart Ranking

Title matches first, then content matches

Text Snippets

See context with highlighted search terms

Auto-Exclude

Current article never appears in results

Category Display

Know where each article belongs

Configurable

Adjust result count, search length, snippets

Secure

CSRF protection, permission checks

Fast

Leverages Smart Search index


How Search Works

Relevance Scoring

  • Title match: 100 points (highest priority)
  • Content match: 50 points
  • Both: 150 points (most relevant)
  • Tie-breaker: Alphabetical by title

What Gets Searched

✅ Article titles
✅ Article descriptions/content
✅ Published articles only
✅ Indexed in Smart Search
❌ Current article (auto-excluded)
❌ Unpublished content
❌ Non-indexed articles


Configuration Options

Location: Plugins → System - Smart Interlink → Configure

Setting

Options

Default

Use Case

Max Results

3, 5, 10, 15, 20

5

More results for complex sites

Min Search Length

1-10 chars

2

Prevent too-broad searches

Enable Snippets

Yes / No

Yes

Show/hide text previews


Requirements Checklist

System Requirements

  • Joomla 4.0+ (or 5.x/6.x)
  • PHP 7.4+
  • Smart Search component enabled
  • Articles indexed in Smart Search

User Requirements

  • Administrator access
  • core.create OR core.edit permission for com_content
  • Modern browser with JavaScript

Optional (Recommended)

  • Scheduled Smart Search indexing
  • PHP 8.0+ for better performance

Common Workflows

Basic Linking

  1. Edit article
  2. Select "SEO tips"
  3. Click Smart Link
  4. Choose "Complete SEO Guide"
  5. Link inserted: <a href="/...">SEO tips</a>

Building Topic Clusters

  1. Write pillar article
  2. Select topic keywords
  3. Link to supporting articles
  4. Repeat for each topic
  5. Result: Strong topical authority

Cross-Referencing

  1. Open reference article
  2. Select term to link
  3. Find related glossary entry
  4. Insert link
  5. Reader can click for details

Keyboard Shortcuts

Editor:

  • Select text: Click & drag OR double-click word
  • Deselect: Click elsewhere OR Escape

Modal:

  • Close: Escape OR click overlay OR click × button
  • Insert link: Click "Link" button

Search Tips

For Best Results

✅ Select specific terms (2-5 words)
✅ Use exact phrases when possible
✅ Try variations if first search fails
✅ Check article is published & indexed

Avoid

❌ Very generic terms (too many results)
❌ Single characters (below minimum length)
❌ Special characters (may not match)
❌ Very long phrases (might not match exactly)


Troubleshooting Quick Fixes

Button Not Appearing

Problem: Can't see Smart Link button
Check:

  1. Plugin enabled? (System → Plugins)
  2. Have edit permissions? (Users → Access Levels)
  3. In admin area? (Not frontend)
  4. Using TinyMCE? (Not another editor)

No Search Results

Problem: Modal shows "No results found"
Check:

  1. Smart Search enabled? (Components → Smart Search)
  2. Content indexed? (Smart Search → Index → Run)
  3. Search term long enough? (Default: 2+ characters)
  4. Articles published? (Content → Articles)

Slow Performance

Problem: Search takes several seconds
Fix:

  1. Run Smart Search indexer
  2. Optimize database tables
  3. Reduce max results setting
  4. Check server resources

CSRF Token Error

Problem: "Invalid token" error
Fix:

  1. Clear browser cache
  2. Log out and back in
  3. Check session timeout settings
  4. Verify plugin is latest version

Best Practices

SEO Optimization

  • Link to related content naturally
  • Use descriptive anchor text
  • Don't over-link (3-5 links per 500 words)
  • Link to both pillar and supporting content
  • Vary anchor text (don't repeat exact same phrase)

Content Strategy

  • Build topic clusters with hub articles
  • Cross-reference related concepts
  • Link older content to newer articles
  • Update old articles with new links
  • Create navigation paths through content

Workflow Efficiency

  • Link as you write (don't go back later)
  • Keep Smart Search index updated
  • Use 5-10 results for most sites
  • Enable snippets to see context
  • Review suggestions before linking

Performance Metrics

Average Performance:

  • Search time: < 100ms
  • Modal display: < 50ms
  • Link insertion: Instant
  • Asset size: ~28KB total (CSS + JS)

Scalability:

  • Tested with 10,000+ articles
  • Smart Search index handles millions of records
  • No performance degradation with large sites

Security Features

✅ CSRF token validation on all requests
✅ Permission checks (create/edit content)
✅ SQL injection prevention (bound parameters)
✅ XSS protection (htmlspecialchars)
✅ Admin-only access
✅ Secure session handling



Support & Resources

Included Documentation:

  • Full user guide (online)
  • Technical documentation
  • Installation instructions
  • FAQ section

Support Channels:

Updates:

  • Via Joomla Update System
  • Automatic notifications
  • One-click updates
  • 6-month update access

Version Info

Current Version: 3.1.1
Release Date: February 2026
Compatibility: Joomla 4.0+ / 5.x / 6.x
License: GNU GPL v2+
Author: JoomIQ


Common Use Cases

Blog Authors

Link to previous posts while writing new content

Documentation Teams

Cross-reference related help articles and tutorials

SEO Specialists

Build internal linking structure for topic authority

Content Editors

Update old articles with links to new content

Knowledge Managers

Create interconnected knowledge base articles


Migration Notes

From Manual Linking:

  • All existing links remain unchanged
  • Continue using manual links if preferred
  • Smart Interlink is additional tool, not replacement

From Other Plugins:

  • Can run alongside other linking tools
  • No conflicts with standard link buttons
  • Disable if you prefer other solutions


Tips for Power Users

  1. Batch Linking: Open multiple articles in tabs, link as you review
  2. Custom Categories: Use category names to identify content types
  3. Result Tuning: Adjust max results based on content volume
  4. Snippet Review: Enable snippets to verify relevance before linking
  5. Index Scheduling: Set up automatic Smart Search indexing

Troubleshooting Matrix

Symptom

Likely Cause

Quick Fix

No button

Permissions

Grant content edit rights

No results

Not indexed

Run indexer

Slow search

Large DB

Optimize tables

Token error

Cache

Clear & re-login

Wrong results

Old index

Re-run indexer

Button duplicate

JavaScript

Reload page


Advanced Configuration

For Large Sites (10,000+ articles):

  • Max Results: 10
  • Min Search: 3 chars
  • Snippets: Disable (faster)
  • Index: Daily schedule

For Small Sites (< 1,000 articles):

  • Max Results: 15
  • Min Search: 2 chars
  • Snippets: Enable (context)
  • Index: Weekly schedule

For Multi-author Sites:

  • Train editors on usage
  • Establish linking guidelines
  • Monitor linking patterns
  • Regular index updates

This quick reference provides instant access to essential information. Bookmark this page for fast troubleshooting and workflow optimization!

 

Order Now

Unlimited Websites

€ 14,99
  • Support for a single website.
  • 12 months of support.
  • 12 months of access to downloads.