Descripción
Aria Auto Table of Contents (SEO Friendly) is a lightweight and powerful WordPress plugin that automatically generates a table of contents for your posts and pages. With built-in Schema.org support and FAQ functionality, this plugin helps improve your SEO and user experience.
✨ Key Features
- Automatic TOC Generation: Automatically extracts h2 and h3 headings from your content
- Gutenberg Block Support: Easily insert TOC anywhere using the Gutenberg block
- SEO Optimized: Built-in Schema.org ItemList markup for better search engine visibility
- FAQ Schema Support: Automatically detects and adds FAQ schema markup
- Customizable: Control position, minimum headings, numbering, and more
- Collapsible TOC: Users can collapse/expand the table of contents
- Smooth Scrolling: Beautiful smooth scroll animation when clicking TOC links
- Active Heading Highlight: Automatically highlights the current section
- RTL Support: Full support for right-to-left languages
- Dark Mode Ready: Respects user’s system dark mode preference
- Responsive Design: Looks great on all devices
- Lightweight: Minimal impact on page load speed
- Developer Friendly: Clean, extensible code with WordPress coding standards
🎯 Perfect For
- Bloggers who write long-form content
- Documentation sites
- Educational websites
- News websites
- Any site that wants to improve content navigation
🔧 How It Works
- The plugin scans your content for h2 and h3 headings
- Automatically generates IDs for headings (if they don’t have one)
- Creates a beautiful, accessible table of contents
- Adds Schema.org structured data for SEO
- Enables smooth scrolling and active section highlighting
📦 What’s Included
- TOC Generator with smart heading detection
- Gutenberg TOC Block for manual placement
- Gutenberg FAQ Block with schema support
- Admin settings page with full customization
- Schema.org ItemList markup for TOC
- Schema.org FAQPage markup (optional)
- Beautiful, modern design
- Accessibility features (ARIA labels, keyboard navigation)
🌍 Developer Information
- Developer: Alireza Aminzadeh
- Website: ariait.net
- Email: alireza@aryait.net
- Support: Available through WordPress.org forums
🔗 Links
Technical Details
System Requirements
- WordPress 5.8 or higher
- PHP 7.4 or higher
- Modern browser with JavaScript enabled
Code Standards
- Follows WordPress Coding Standards
- Fully documented code
- Security best practices (nonce verification, data sanitization, etc.)
- Translation ready
- Accessibility compliant (WCAG 2.1 Level AA)
Performance
- Lightweight: < 50KB total assets
- Minimal database queries
- Efficient caching
- No external dependencies
- Lazy loading of scripts
Browser Support
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
- Opera (latest)
- Mobile browsers
Developer Features
- Clean, object-oriented code
- Singleton pattern for main classes
- WordPress hooks and filters
- Extensible architecture
- Well-documented API
- Translation ready (i18n)
Privacy Policy
This plugin does not collect, store, or transmit any user data. All processing happens on your WordPress server.
Credits
Developed with ❤️ by Alireza Aminzadeh
- Website: ariait.net
- Support: WordPress.org forums
License
This plugin is licensed under the GPLv2 or later.
Copyright (C) 2024 Alireza Aminzadeh
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 2 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Bloques
Este plugin proporciona 2 bloques.
- FAQ (SEO)
- Table of Contents
Instalación
From WordPress Dashboard
- Navigate to Plugins > Add New
- Search for “Aria Auto Table of Contents”
- Click “Install Now”
- Activate the plugin
- Go to Settings > Auto TOC SEO to configure
Manual Installation
- Download the plugin zip file
- Extract it to the
/wp-content/plugins/directory - Activate the plugin through the ‘Plugins’ menu in WordPress
- Go to Settings > Auto TOC SEO to configure
Configuration
- Go to Settings > Auto TOC SEO
- Configure your preferred settings:
- Enable/disable auto-insert
- Choose TOC position
- Set minimum number of headings
- Customize TOC title
- Enable/disable numbering
- Enable/disable collapsible feature
- Enable/disable Schema.org markup
Using Gutenberg Blocks
TOC Block
- Create or edit a post/page
- Click the (+) button to add a new block
- Search for “Table of Contents”
- Insert the block where you want the TOC to appear
- Customize the block settings in the sidebar
FAQ Block
- Create or edit a post/page
- Click the (+) button to add a new block
- Search for “FAQ (SEO)”
- Add your questions and answers
- The plugin will automatically add FAQ schema markup
FAQ
-
How does the plugin generate the table of contents?
-
The plugin automatically scans your post/page content for h2 and h3 heading tags and generates a hierarchical table of contents based on these headings.
-
Can I manually insert the TOC?
-
Yes! You can use the “Table of Contents” Gutenberg block to insert the TOC anywhere in your content. This will override the automatic insertion for that post.
-
Does it work with classic editor?
-
The plugin works best with Gutenberg (block editor). For classic editor users, the automatic insertion feature will still work, but block insertion requires Gutenberg.
-
Will it slow down my site?
-
No! The plugin is very lightweight and optimized for performance. It only loads the necessary scripts and styles on pages where the TOC is displayed.
-
Can I customize the appearance?
-
Yes! The plugin includes CSS custom properties that you can override in your theme. You can also modify the settings in the admin panel.
-
Does it support RTL languages?
-
Yes! The plugin includes full RTL support for right-to-left languages like Arabic, Persian, and Hebrew.
-
What is Schema.org markup and why should I use it?
-
Schema.org markup is structured data that helps search engines understand your content better. It can improve your SEO and make your content eligible for rich snippets in search results.
-
Can I disable the Schema markup?
-
Yes! You can enable/disable both TOC and FAQ schema markup independently in the plugin settings.
-
Does it work with page builders?
-
The plugin works best with native WordPress content. Compatibility with page builders may vary depending on how they output content.
-
How many heading levels does it support?
-
Currently, the plugin supports h2 and h3 headings. This provides a good balance between detail and simplicity for most content.
-
Can I change the TOC position?
-
Yes! You can choose to display the TOC before content or after the first paragraph. Use the Gutenberg block for complete control over positioning.
-
Is it compatible with AMP?
-
The plugin uses standard HTML/CSS/JavaScript and should be compatible with most AMP implementations, but specific testing is recommended.
-
How do I report bugs or request features?
-
Please use the WordPress.org support forum or visit our GitHub repository to report issues or request new features.
Reseñas
No hay reseñas para este plugin.
Colaboradores & Desarrolladores
“Aria Auto Table of Contents (SEO Friendly)” es software de código abierto. Las siguientes personas han contribuido a este plugin.
ColaboradoresTraduce “Aria Auto Table of Contents (SEO Friendly)” a tu idioma.
¿Interesado en el desarrollo?
Revisa el código, echa un vistazo al repositorio SVN, o suscríbete al registro de desarrollo por RSS .
Historial de cambios
1.2.0 – 2024-12-XX
- Fixed security issues: Properly escape all output variables
- Added owner username to Contributors list
- Improved JSON schema output escaping
1.1.0 – 2024-10-30
- Updated plugin name to “Aria Auto Table of Contents (SEO Friendly)”
- Changed slug to “aria-auto-table-of-contents”
- Updated text domain and block namespaces
- Fixed ownership verification issues
1.0.0 – 2024-10-21
- Initial release
- Automatic TOC generation from h2-h3 headings
- Gutenberg TOC block
- Gutenberg FAQ block with schema support
- Schema.org ItemList markup for TOC
- Schema.org FAQPage markup for FAQ
- Admin settings page
- Collapsible TOC functionality
- Smooth scrolling
- Active heading highlighting
- RTL support
- Dark mode support
- Responsive design
- Accessibility features