Ayuda:Accesorios

Esta extensión no está habilitada por defecto, pero puede estar disponible mediante solicitud.

Los accesorios o gadgets distribuyen JavaScript o CSS personalizado a los usuarios que elijan usarlos. A diferencia del CSS y JS comunitario, que se cargan para todos los usuarios, los accesorios CSS y JS solo los ven los usuarios que activen el accesorio.

Una sección de Accesorios en Especial:Preferencias.

Una sección de Accesorios en Especial:Preferencias.

Son una forma de proporcionar a los usuarios experiencias opcionales en una comunidad. Sin embargo, ten en cuenta que los usuarios anónimos no pueden activar accesorios ni desactivar ningún accesorio configurado como activado de forma predeterminada.

Solicitar la extensión

De forma predeterminada, la mayoría de las comunidades de Fandom no utilizan accesorios. Los accesorios funcionan con una extensión; cualquier comunidad que desee utilizar accesorios debe contactar al personal para solicitar la activación de la extensión en esa comunidad.

Lista de accesorios

Un ejemplo de Especial:Accesorios.

Un ejemplo de Especial:Accesorios.

Para ver la lista de accesorios de una comunidad, ve a Especial:Accesorios. Esta página especial también provee enlaces para descripciones de accesorio, muestra una lista de páginas usada por cada accesorio, y muestra cualquier derecho requerido por cada accesorio.

Nota que no puedes activar o desactivar accesorios en esta página; debes ir a Especial:Preferencias para activar o desactivar los accesorios que uses.

Los wikis que no tengan activada la extensión Gadgets mostrarán una página de error en Especial:Accesorios, ya que no existe en dicha comunidad.

Crear un accesorio

Definición de accesorio

Un ejemplo de MediaWiki:Gadgets-definition.

Un ejemplo de MediaWiki:Gadgets-definition.

El primer paso para crear un accesorio es definirlo. Para hacer esto, edita MediaWiki:Gadgets-definition en tu comunidad. Cada accesorio está definido por una entrada en una lista de viñetas, por lo que cada línea debe comenzar con *. El formato de definición de accesorios es el siguiente:

* nombre_del_accesorio [opciones] | archivo1 | archivo2 | etc.

  • nombre_del_accesorio debe ser único y distingue entre mayúsculas y minúsculas. Debe comenzar con una letra latina básica ([A-Za-z]) y puede ir seguido de cualquier número de letras, dígitos ([0-9]), guiones (-), guiones bajos (_), dos puntos (:) y puntos (.).
  • Véase § Opciones de accesorio para una explicación de opciones.
  • Véase § Archivos de accesorio para una explicación de archivo1, archivo2, etc.

Si tu wiki tiene muchos accesorios, puede ser útil dividir la lista en secciones usando ==encabezados==. Por ejemplo, la siguiente lista de cuatro gadgets se divide en dos secciones: utilidades y visuales. Al igual que los nombres de los gadgets, los encabezados de las secciones también distinguen entre mayúsculas y minúsculas y deben ser únicos. Por ejemplo: 

==utilidades==
* Utilidad1 [ResourceLoader] | BonitaUtilidad.js
* Utilidad2 [ResourceLoader|rights=rollback] | RollbackUtil.js | RollbackUtil.css

==visuales==
* Tems1 [type=styles] | TemaAgua.css
* Tema2 [type=styles] | TemaFuego.css

Descripción de accesorio

Por defecto, los usuarios verán tu accesorio presentado en Especial:Preferencias como ⧼gadget-nombre_del_accesorio⧽. Esta no es una descripción muy útil. Puedes editar esta descripción yendo a MediaWiki:Gadget-nombre_del_accesorio en tu wiki. También puedes ir a la lista de accesorios en Especial:Accesorios y hacer clic en el enlace "Editar" junto a la definición de cada accesorio.

Las descripciones de accesorios deben ser razonables. Una descripción útil explica todo lo que el usuario verá de manera diferente o tendrá acceso si activa el accesorios. Recuerda que los accesorios sirven para dar a tus usuarios opciones para modificar su experiencia. Para hacerlo, necesitan información precisa.

Los encabezados de secciones también se pueden editar para que sean más fáciles de usar. En el ejemplo anterior, para editar el encabezado utilidades, simplemente ve a MediaWiki:Gadget-section-utilidades o haz clic en el enlace "Editar" junto al encabezado de la sección en Especial:Accesorios.

Opciones de accesorio

Una definición de accesorio puede incluir opciones que especifican aún más cómo cargar el accesorio o quién puede activarlo. Cada opción debe estar separada por un carácter de barra vertical |. Las opciones que no toman ningún parámetro, como ResourceLoader, simplemente se pueden incluir por sí mismas; las opciones que sí toman parámetros deben incluirse con un signo igual seguido de una lista de parámetros separados por comas, como rights=rollback,delete.

La siguiente tabla enumera las opciones de accesorios disponibles para las comunidades de Fandom.

Nombre Parámetros Description
ResourceLoader Ninguno Marca las secuencias de comandos del accesorio como compatibles con ResourceLoader.
Esta opción es necesaria para cualquier accesorio que cargue al menos un archivo JS; de lo contrario, Especial:Accesorios mostrará un error y el JS no cargará.
dependencies Nombres de módulos ResourceLoader separados por comas Ten en cuenta que esta opción no tiene efecto si el accesorio no tiene recursos compatibles con ResourceLoader (es decir, estilos y scripts no marcados como compatibles).
rights Nombres de privilegios separados por comas Desactiva y oculta el accesorio en las preferencias para los usuarios que no tienen estos privilegios. Ten en cuenta que los "permisos" de los usuarios no son "grupos" de usuarios; la lista completa de permisos de los usuarios está disponible en Especial:ListaDerechosGrupos.
default Ninguno Cualquier accesorio establecido como predeterminado debe adherirse a la política de personalización.
Activa el accesorio de forma predeterminada para todos, incluidos los usuarios anónimos. Solo los usuarios registrados pueden desactivar este accesorio.
type styles o general Usa type=styles para accesorios que solo cargan archivos CSS. Esto cargará el CSS a través del HTML de la página, que es más rápido que el comportamiento de carga predeterminado de JavaScript. Ten en cuenta que type=styles no cargará ningún archivo JS en el accesorio.

Archivos de accesorio

La crema del pastel de un accesorio son los archivos que carga cuando está habilitado. Cada página CSS o JS que cargue un accesorio debe tener el prefijo MediaWiki:Gadget-. En el ejemplo anterior, Utilidad2 define dos archivos, "RollbackUtil.js" y "RollbackUtil.css", que estarían ubicados en MediaWiki:Gadget-RollbackUtil.js y MediaWiki:Gadget-RollbackUtil.css, respectivamente. Una buena regla general es usar el mismo nombre para el gadget y los archivos, pero, como se demostró, esto no es un requisito.

Aparte del prefijo Gadget-, los archivos CSS y JS de accesorio funcionan como cualquier otro archivo CSS o JS. Como tal, ten en cuenta que los archivos JS de los accesorio deben ser aprobados por el proceso de revisión de JavaScript antes de que estén disponibles para todos. En términos de orden de carga, los accesorios se cargan después de otro código comunitario local, pero antes del código personal.

Un accesorio puede cargar tantas páginas como se desee, pero es raro cargar más de una página JS y una CSS. Cada archivo debe estar precedido en la definición del accesorio por un carácter de barra vertical |. Cualquier página CSS o JS de accesorio también se puede cargar con varios accesorios. Al igual que otras páginas que se aplican a todo el sitio, los accesorios solo se pueden escribir con JS o CSS.

Véase también

Ayuda y comentarios