Easy Table of Contents

Descripción

Un plugin fácil de usar, que te permite insertar una tabla de contenidos en tus entradas, páginas y tipos de contenido personalizados.

Características

  • Genera automáticamente una tabla de contenidos para tus entradas, páginas y tipos de contenido personalizados analizando el contenido para las cabeceras.
  • Opcionalmente se puede activar para páginas y/o entradas. Se admiten los tipos de contenido personalizados, siempre que tu contenido se genere con la etiqueta de plantilla the_content().
  • Opcionalmente, puede insertar automáticamente el índice de contenidos en la página, seleccionable por el tipo de contenido activado.
  • Proporciona muchas opciones fáciles de entender para configurar cuándo y dónde insertar la tabla de contenidos.
  • Hay muchas opciones disponibles para configurar cómo aparece la tabla de contenido insertada que incluye varios temas incorporados. Si los temas suministrados no satisfacen tus necesidades, puedes crear los tuyos propios eligiendo tus propios colores para el borde, el fondo y el color del enlace.
  • Múltiples formatos de contador de viñetas entre los que elegir; ninguno, decimal, numérico y romano.
  • Elige entre mostrar la tabla de contenido de forma jerárquica o no. Esto significa que las cabeceras de menor prioridad estarán anidadas bajo cabeceras de mayor prioridad.
  • El usuario puede opcionalmente ocultar la tabla de contenidos. Tú tienes el control total de esta característica. Puede desactivarse y puedes elegir tenerlo oculto por defecto.
  • Compatible con el desplazamiento suave.
  • Activación o desactivación selectiva del índice de contenidos entrada por entrada.
  • Elige qué encabezados se usarán para generar la tabla de contenidos. Esto también se puede configurarse entrada por entrada.
  • Excluye fácilmente las cabeceras de forma global y entrada por entrada.
  • Si prefieres no insertar el índice en el contenido de la entrada, puedes usar el widget suministrado y colocar la tabla de contenidos en la barra lateral de tu tema.
  • Los widgets se pueden colocar o pegar en la página para que estén siempre visibles a medida que te desplazas por la página. NOTA: esta es una opción avanzada ya que cada tema es diferente, es posible que necesites el asesoramiento del desarrollador del tema para saber cuál es el selector de elementos correcto a utilizar en los ajustes para activar esta característica.
  • El widget resalta automáticamente las secciones actualmente visibles en la página. El color de realce es configurable.
  • Para el desarrollador con muchos ganchos de acción y filtros disponibles. Se pueden añadir más a petición en Github. Las solicitudes de pull son bienvenidas.

Ejemplos en vivo

Aquí hay enlaces a páginas de documentación de varias de las plantillas premium para el plugin Connections Business Directory plugin que utilizan el widget incluido con este plugin:

Hoja de ruta

  • Almacenamiento en caché de fragmentos para mejorar el rendimiento.
  • Compatible con <!--nextpage-->.
  • Compatible con el Personalizador.

Requisitos

  • Versión de WordPress: >= 3.2
  • Versión de PHP: >= 5.2.4

Reconocimiento

Easy Table Contents es una bifurcación del excelente plugin Table of Contents Plus de Michael Tran.

Capturas

  • La sección general de los ajustes.
  • La sección de apariencia de los ajustes.
  • La sección avanzada de los ajustes.

Instalación

Usando la búsqueda de plugins de WordPress

  1. Navigate to the Add New sub-page under the Plugins admin page.
  2. Search for easy table of contents.
  3. The plugin should be listed first in the search results.
  4. Click the Install Now link.
  5. Lastly click the Activate Plugin link to activate the plugin.

Subiendo a la administración de WordPress

  1. Download the plugin zip file and save it to your computer.
  2. Navigate to the Add New sub-page under the Plugins admin page.
  3. Click the Upload link.
  4. Select Easy Table of Contents zip file from where you saved the zip file on your computer.
  5. Haz clic en el botón Instalar ahora.
  6. Lastly click the Activate Plugin link to activate the plugin.

Usando FTP

  1. Download the plugin zip file and save it to your computer.
  2. Descomprime el archivo zip de Easy Table of Contents.
  3. Create a new directory named easy-table-of-contents directory in the ../wp-content/plugins/ directory.
  4. Upload the files from the folder extracted in Step 2.
  5. Activate the plugin on the Plugins admin page.

Preguntas frecuentes

Vale, he instalado esto…. ¿qué hago ahora?

La primera parada debe ser la página de administración de la configuración de la tabla de contenido. Encontrarás esto en la opción de menú de ajustes.

La primera y única decisión que se requiere es la de decidir para qué tipos de contenido deseas activar la compatibilidad con la tabla de contenido. Por defecto es el tipo de contenido de páginas. Si el único lugar en el que planeas usar la tabla de contenido es en las páginas, no hay nada más que hacer en la página de ajustes. Para simplificar las cosas, recomiendo no cambiar ninguno de los demás ajustes en este momento. Muchos de los otros ajustes controlan cuándo y dónde se inserta la tabla de contenido y cambiar estos ajustes podría causar que no se muestre, lo que dificulta un poco más la tarea de empezar. Después de que te sientas cómodo con la forma en que esto funciona…. entonces haz los ajustes 🙂

Con eso quitado, asegúrate de leer la FAQ ¿Cómo se crean las tablas de contenido? para que sepas cómo se genera automáticamente la tabla de contenido. Después de haber configurado las cabeceras de página, o antes, de cualquier manera…. Desplázate hacia abajo en la página y verás una caja meta llamada «Tabla de Contenidos«, activa la opción Insertar_tabla de contenidos. y actualiza y/o publica tu página. El índice debe aparecer automáticamente en la parte superior de la página.

¿Cómo se crean las tablas de contenidos?

La tabla de contenido la generan las cabeceras que se encuentran en una página. Las cabeceras son las siguientes: <h1>,<h2>,<h3>,<h4>,<h5>,<h6> HTML tags. Si utilizas el editor visual de entradas de WordPress, estas etiquetas de encabezado se utilizan y se insertan en el mensaje cuando selecciona una de las opciones de encabezado desde el menú desplegable de formato . Cada encabezado que se encuentre en la página creará una tabla de contenido. He aquí un ejemplo que creará una tabla de contenidos que contiene los seis elementos.

<h1>Item 1</h1>
<h1>Item 2</h1>
<h1>Item 3</h1>
<h1>Item 4</h1>
<h1>Item 5</h1>
<h1>Item 6</h1>

También puedes crear una tabla de contenidos «anidada». Esto es difícil de explicar, así que voy a ilustrar la construcción sobre el ejemplo anterior. En este ejemplo se creará un índice de contenidos con los mismos seis elementos, pero ahora los tres primeros serán cada uno un elemento subordinado anidado debajo de él. La sangría no es necesaria, sólo se ha añadido con fines ilustrativos.

<h1>Item 1</h1>
    <h2>Item 1.1 -- Level 2</h2>
<h1>Item 2</h1>
    <h2>Item 2.1 -- Level 2</h2>
<h1>Item 3</h1>
    <h2>Item 3.1 -- Level 2</h2>
<h1>Item 4</h1>
<h1>Item 5</h1>
<h1>Item 6</h1>

Tampoco está limitado a un solo elemento anidado. Puedes añadir tantos como necesites. Incluso puede crear múltiples niveles anidados….

<h1>Item 1</h1>
    <h2>Item 1.1 -- Level 2</h2>
        <h3>Item 1.1.1 -- Level 3</h3>
        <h3>Item 1.1.2 -- Level 3</h3>
        <h3>Item 1.1.3 -- Level 3</h3>
    <h2>Item 1.2 -- Level 2</h2>
      <h3>Item 1.2.1 -- Level 3</h3>
      <h3>Item 1.2.2 -- Level 3</h3>
      <h3>Item 1.2.3 -- Level 3</h3>
    <h2>Item 1.3 -- Level 2</h2>
<h1>Item 2</h1>
    <h2>Item 2.1 -- Level 2</h2>
    <h2>Item 2.2 -- Level 2</h2>
<h1>Item 3</h1>
    <h2>Item 3.1 -- Level 2</h2>
    <h2>Item 3.2 -- Level 2</h2>
<h1>Item 4</h1>
<h1>Item 5</h1>
<h1>Item 6</h1>

Puedes anidar hasta 6 niveles de profundidad si es necesario. ¡Espero que esto te ayude a entender cómo crear y construir tu propio índice de contenido generado automáticamente en tus sitios!

Reseñas

mayo 28, 2019
I used to have toc+ in my websites, but as that plugin is not having any updates and it's not compatible with Elementor, I decided to switch to Easy TOC. Everything works like a charm, I didn't have to do basically anything to set it up and now I have a good TOC plugin, updated and that totally works with Elementor. 5 well-earned stars!
mayo 23, 2019
I am only here to say, Author Steven made a GREAT PLUGIN, thanks! Yes, under some of the myriads of display and wordpress installations out there, it does have a very minor display issue at times, but I wouldn't know if anyone can prevent that, given the magnitude how people desire and require to show their very personal TOC. I just gloss over that. All in all, it is a fantastic plugin!
mayo 9, 2019
This Plugin is simply brilliant 🙂 Nevertheless, the only thing is, that the “Smooth Scroll Offset” does not work, when the link is located on-or in another page, or, for example, in the homepage footer? It is a bit “annoying” because it restricts this beautiful plugin options, to primarily need links and anchors on the same internal page, when you have a consistent menus across the top of your site... Please if you could fix this in a near future 🙂 Best regards Carmad
abril 18, 2019
It good plugins but with some error. its showing gaps or blank line with numbering between 2 content.
Leer todas las 61 reseñas

Colaboradores y desarrolladores

“Easy Table of Contents” es un software de código abierto. Las siguientes personas han colaborado con este plugin.

Colaboradores

“Easy Table of Contents” ha sido traducido a 6 idiomas locales. Gracias a los traductores por sus contribuciones.

Traduce “Easy Table of Contents” a tu idioma.

¿Interesado en el desarrollo?

Revisa el código , echa un vistazo al repositorio SVN , o suscríbete al log de desarrollo por RSS .

Registro de cambios

1.7 05/09/2018

  • NEW: Introduce the ez_toc_shortcode filter.
  • TWEAK: Fix notices due to late eligibility check. props unixtam
  • TWEAK: Tweak eligibility check to support the TOC widget.
  • TWEAK: Prefix a few CSS classes in order to prevent collisions with theme’s and other plugins.
  • TWEAK: Avoid potential PHP notice in admin when saving the post by checking for nonce before validating it.
  • TWEAK: Using the shortcode now overrides global options.
  • TWEAK: the_content() now caches result of is_eligible().
  • TWEAK: Refactor to pass the WP_Post object internally vs. accessing it via the $wp_query->post which may not in all cases exist.
  • TWEAK: Use pre_replace() to replace one or more spaces with an underscore.
  • TWEAK: Return original title in the ez_toc_url_anchor_target filter.
  • TWEAK: Strip &nbsp;, replacing it with a space character.
  • TWEAK: Minor tweaks to the in page URL creating.
  • TWEAK: Wrap TOC list in a nav element.
  • TWEAK: Init plugin on the plugins_loaded hook.
  • TWEAK: Tweak the minimum number of headers to 1.
  • BUG: The header options from the post meta should be used when building the TOC hierarchy, not the header options from the global settings.
  • BUG: Do not double escape field values.
  • BUG: Ensure Apostrophe / Single quote use in Exclude Headings work.
  • OTHER: Update CSS to include the newly prefixed classes.
  • DEV: Remove some commented out unused code.

1.6.1 03/16/2018

  • MEJORA: Revertir el cambio hecho para permitir HTML añadido via el filtro ez_toc_title ya que ha causado efectos secundarios no deseados.
  • Error: Asegurar Desplazamiento Fluido está analizado como un número entero.

1.6 03/15/2018

  • NEW: Add px option for font size unit.
  • NEW: Add title font size and weight settings options.
  • NEW: Add the Mobile Smooth Scroll Offset option.
  • TWEAK: Change default for font size unit from px to % to match the default options values.
  • TWEAK: Correct CSS selector so margin is properly applied between the title and TOC items.
  • TWEAK: Honor HTML added via ez_toc_title filter.
  • TWEAK: Ensure the ezTOC content filter is not applied when running the_content filter.
  • TWEAK: Only enqueue the javascript if the page is eligible for a TOC.
  • TWEAK: Update icomoon CSS to remove unecessary CSS selectors to prevent possible conflicts.
  • TWEAK: The smooth scroll offset needs to be taken into account when defining the offset_top property when affixing the widget.
  • OTRO: Actualización del archivo CSS minified de la intefaz del usuario.
  • OTRO: Actualización al archivo javascript minified de la interfaz del usuario.
  • DEV: Correcciones phpDoc

1.5 02/20/2018

  • BUG: Correct CSS selector to properly target the link color.
  • OTHER: Update the WayPoints library.
  • DEV: Add a couple @todo’s.

1.4 01/29/2018

  • TWEAK: Change text domain from ez_toc to easy-table-of-contents.
  • TWEAK: Rename translation files with correct text domain.
  • BUG: Ensure page headers are processed to add the in page header link when using the shortcodes.
  • BUG: Add forward slash to domain path in the plugin header.
  • I18N: Update POT file.
  • I18N: Update Dutch (nl_NL) translation.

1.3 12/18/2017

  • FEATURE: Add support for the [ez-toc] shortcode.
  • NEW: For backwards compatibility with «Table of Content Plus», register the [toc] shortcode.
  • NEW: Introduce the ez_toc_extract_headings_content filter.
  • TWEAK: Update the tested to and required readme header text.
  • TWEAK: Do not show the widget on the 404, archive, search and posts pages.
  • I18N: Add the nl_NL translation.

1.2 04/29/2016

  • TWEAK: Remove the font family from styling the TOC title header.
  • TWEAK: Pass the raw title to the ez_toc_title filter.
  • BUG: A jQuery 1.12 fix for WordPress 4.5.

1.1 02/24/2016

  • FEATURE: Add option to replace header wither alternate header text in the table of content.
  • NEW: Introduce the ez_toc_filter.
  • NEW: Introduce ezTOC_Option::textarea() to render textareas.
  • NEW: Introduce array_search_deep() to recursively search an array for a value.
  • TWEAK: Run table of contents headers thru wp_kses_post().
  • TWEAK: Escape URL.
  • TWEAK: Count excluded headings only once instead of multiple times.
  • TWEAK: Escape translated string before rendering.
  • TWEAK: Use wp_unslash() instead of stripslashes().
  • TWEAK: Escape translated string.
  • BUG: Fix restrict path logic.
  • OTHER: Readme tweaks.
  • I18N: Add POT file.
  • I18N: Add Dutch translation.
  • DEV: Update .gitignore to allow PO files.
  • DEV: phpDoc fix.

1.0 09/08/2015

  • Initial release.
    • Complete refactor and restructure of the original code for better design and separation of function to make code base much easier to maintain and extend.
    • Update all third party libraries.
    • Make much better use of the WordPress Settings API.
    • Minified CSS and JS files are used by default. Using SCRIPT_DEBUG will use the un-minified versions.
    • Add substantial amounts of phpDoc for developers.
    • Add many hooks to permit third party integrations.
    • Widget can be affixed/stuck to the page so it is always visible.
    • Widget will highlight the table of content sections that are currently visible in the browser viewport.
    • Widget will now generate table of contents using output from third party shortcodes.
    • Use wpColorPicker instead of farbtastic.
    • Remove all shortcodes.
    • Per post options are saved in post meta instead of set by shortcode.