Command Palette

Search for a command to run...

GE

Generador de lectura de WordPress

Escriba un complemento readme.txt que analiza el directorio de WordPress.org, con una vista previa en vivo del listado que produce y una descarga cuando sea correcto.

¿qué es un generador de lectura de WordPress?

Un generador de wordpress readme crea el archivo readme.txt que lee el directorio del complemento WordPress.org para crear la lista pública de un complemento. Completa los campos del encabezado y las secciones, y emite el archivo en el formato exacto que analiza el directorio: el título `=== Plugin Name ===`, el bloque de encabezado separado por dos puntos y los cuerpos `== Sección ==`, con una vista previa en vivo al lado que muestra cómo se verá la página de listado.

El formato es complicado en formas que son invisibles hasta que algo anda mal. `Stable tag` nombra la versión que realmente sirve el directorio, por lo que una etiqueta incorrecta o faltante no envía nada sin importar lo que hayas cometido. `Tested up to` es lo que produce la advertencia "no probado con su versión de WordPress" en el listado cuando se queda atrás del núcleo. `Tags` indexa los primeros cinco e ignora silenciosamente el resto. La breve descripción se corta en 150 caracteres en los resultados de búsqueda. Ninguno de estos produce un error que ve al escribir el archivo; producen un listado que parece incorrecto o una descarga que no ocurre días después. Esta herramienta establece cada límite al lado del campo al que pertenece y enumera lo que el directorio haría con su archivo antes de descargarlo.

Todo se ejecuta en el lado del cliente. No se carga nada, no se crea ninguna cuenta y el borrador se guarda en su propio navegador para que la recarga no lo pierda. También puede importar un readme.txt existente: pegue el que ya envía su complemento y se vuelva a analizar en el formulario, que es la forma más rápida de arreglar un archivo antiguo o llevar un readme a los requisitos actuales sin volver a escribirlo. Secciones en un orden inusual, líneas de encabezado que esta herramienta no modela y el espaciado inconsistente se leen en lugar de rechazarse, porque así es como se ven los archivos reales de readme.

Vale la pena decir claramente dos cosas que el archivo en sí no puede contener. Las imágenes de banner e íconos no forman parte de readme.txt: viven en la carpeta `/assets/` del complemento como `banner-1544x500.png` y `icon-256x256.png`, y los campos aquí existen, por lo que la vista previa muestra el listado que realmente obtendrá. Las capturas de pantalla funcionan de la misma manera: readme.txt lleva los subtítulos numerados y los archivos `screenshot-1.png` coincidentes van en `/assets/` en ese orden. La vista previa es honesta al respecto en lugar de pretender que una URL de imagen en el formulario aparecerá en WordPress.org. Una vez que el archivo esté correcto, descárguelo, colóquelo en la raíz del complemento y confírmelo al troncal de su repositorio SVN.

¿cómo utilizar el generador de lectura de WordPress?

  1. Rellena los títulos

    El nombre del complemento, los nombres de usuario de WordPress.org de los contribuyentes, la etiqueta estable, las versiones de WordPress y PHP que admite y hasta cinco etiquetas. Estos se convierten en el bloque de encabezado que analiza el directorio primero.

  2. Escribe la descripción

    Una oración corta para la lista de búsqueda, luego la descripción larga en Markdown - ## encabezados, **bold** y * enumera todas las representaciones en la página del complemento. La vista previa al lado del formulario se actualiza a medida que escribe.

  3. Agregue preguntas frecuentes, capturas de pantalla e registro de cambios

    Cada pregunta frecuente se convierte en su propio bloque = pregunta =. Los subtítulos de captura de pantalla están numerados para que coincidan con los archivos de captura de pantalla-1.png en su carpeta de activos. El registro de cambios toma uno = versión = bloque por versión, el más nuevo primero.

  4. Verifique las advertencias y luego descárguelas

    Lea "Qué haría el directorio con esto" (falta una etiqueta estable, una descripción breve y demasiado larga, pasa de la quinta), luego descargue readme.txt y confíelo al troncal de su complemento.

Características clave

  • Vista previa del directorio en vivo

    El banner, el ícono, las pestañas y la barra lateral de una lista de WordPress.org, que se representan desde sus campos a medida que escribe, para que vea la página antes de publicarla.

  • Importe un readme.txt existente

    Analiza un readme que ya envía al formulario, incluidas secciones en un orden inusual y líneas de encabezado que esta herramienta no modela.

  • Los propios límites del directorio, afirmó

    Cinco etiquetas indexadas, una breve descripción de 150 caracteres, una etiqueta estable que decide qué se envía, cada una de las cuales se muestra en el campo al que se aplica y se resume antes de la descarga.

  • Marque donde el directorio lo acepta

    Los encabezados, negrita, listas y enlaces se muestran en la descripción, instalación e registro de cambios exactamente como lo harán en la página del complemento.

Frequently Asked Questions

Sí, es gratuito y no necesita registro. Se ejecuta en el lado del cliente en su navegador, por lo que no hay ningún servidor que haga el trabajo y no hay nada por lo que cobrar.

Comments

0 comments

0/2000 characters

No comments yet. Be the first to share your thoughts!

wordpress readme generatorreadme.txt generatorplugin readme generatorwordpress plugin readmereadme txt wordpress plugingenerate readme for wordpress pluginwordpress readme validatorplugin directory listing