Otras macros

A diferencia de las macros enumeradas en Macros usadas comúnmente, las macros documentadas en este artículo se usan con poca frecuencia o solo en contextos específicos, o están en desuso.

Contextos especiales

Estas macros se utilizan solo con contextos particulares, como una referencia de API específica.

  • jsapixref enlaza a una página en la Referencia de JSAPI.
  • XPCOMxref enlaza a una página en la referencia de XPCOM. Puedes especificar el nombre de una función, clase, componente o interfaz XPCOM (aunque para esta última, en su lugar, debes usar interface). Esta macro encontrará la página y creará un enlace a ella, donde sea que esté en el subárbol de la referencia de XPCOM.
  • npapi enlaza a la Referencia de la API del complemento Gecko.
  • interface se puede usar cuando se vincula a interfaces XPCOM.
    Ejemplo: {{interface ("nsIIOService")}} da como resultado: nsIIOService.
  • ifmethod e ifattribute te permiten crear un enlace a un método o atributo (respectivamente) en particular en una interfaz de Mozilla que se ha creado usando nuestro formato estándar para la documentación de la interfaz. Por ejemplo, {{ifmethod("nsIAutoCompleteSearch", "stopSearch")}} aparece como nsIAutoCompleteSearch.stopSearch(). Ten en cuenta que para ifattribute, id="..." se debe agregar explícitamente en el destino, ya que los atributos no tienen encabezados.
  • Interwiki facilita la creación de enlaces Interwiki. Actualmente admite enlaces a Wikipedia y Wikimo. El primer parámetro es el nombre de la wiki ("wikipedia" o "wikimo") y el segundo es la ruta del artículo. Por ejemplo, {{interwiki("wikipedia", "Firefox")}} aparece como Firefox. Esta plantilla automáticamente detecta el idioma de la página y lo dirige al mismo idioma en Wikipedia, por ejemplo.
  • RFC crea un enlace al RFC especificado, dado su número. La sintaxis es simplemente: {{RFC(número)}}. Por ejemplo, {{RFC(2616)}} se convierte en RFC 2616.

Componentes de la página destino

Tenemos una variedad de macros que se pueden utilizar para generar automáticamente el contenido de las páginas destino. Aquí están.

Listas de subpáginas

  • ListSubpages genera una lista desordenada de enlaces a todos los hijos inmediatos de la página actual; útil para generar automáticamente tablas de contenido para conjuntos de documentación.
  • LandingPageListSubpages genera una lista de definición de dos columnas de todas las subpáginas inmediatas de la página actual, con sus títulos como <dt> y su resumen SEO como <dd>. Esto facilita la generación automática de páginas destino razonablemente atractivas.
  • NavListWithPrioritizedPages genera una lista ordenada formateada correctamente para su uso en una zona de barra de navegación lateral (o enlaces rápidos). Como entrada, puedes especificar cero o más enlaces amigables de página que se deben sacar de la lista principal y, en su lugar, insertarse en la parte superior de la lista, en el orden dado. Todas las páginas restantes se colocan alfabéticamente en la lista. Se incluye un nivel de subpáginas.
  • APIListAlpha crea una lista de las subpáginas de la página actual, formateada como una lista de términos de la API, dividida por la primera letra. Hay tres parámetros. El primero es 0 si deseas incluir todas las subpáginas de nivel superior o 1 para omitir las subpáginas con "." en sus nombres. El segundo y el tercero te permiten agregar texto para mostrar como parte del nombre en cada enlace. Esto se puede usar para agregar "<" y ">" para los enlaces de elementos, o para agregar "()" al final de las listas de nombres de métodos.
  • SubpagesWithSummaries construye una lista de definiciones de todos los hijos inmediatos de la página actual. No se ha realizado ningún otro formateo. Puedes obtener una lista de dos columnas preparada para usar como página destino de varias columnas mediante LandingPageListSubpages.

Enlaces rápidos

Tenemos algunas macros diseñadas específicamente para crear enlaces rápidos (en-US):

  • La macro MakeSimpleQuicklinks crea una lista plana de enlaces en el cuadro de enlaces rápidos. Simplemente dale un conjunto de rutas a las páginas destino como argumentos de entrada. El texto de cada enlace es el título de la página y cada enlace tiene una información sobre herramientas derivada del resumen de la página.
  • QuickLinksWithSubpages crea un conjunto de enlaces rápidos compuestos por las páginas debajo de la página actual (o la página especificada, si se proporciona una). En total, se generan hasta dos niveles de profundidad.

Usadas con poca frecuencia

  • outdated se puede usar para marcar páginas que se sabe que están (o que podrían estar) horriblemente desactualizadas. La plantilla va seguida de un parámetro opcional, que se puede utilizar para proporcionar detalles. Por ejemplo: {{outdated("Se actualizó por última vez en 1999")}} te da esto:

    Advertencia:

    The content of this article may be out of date. Se actualizó por última vez en 1999.

  • disambig se usa en las pocas páginas de desambiguación que tenemos. No utilices esta macro en las páginas de desambiguación del glosario; en su lugar, utiliza la macro GlossaryDisambiguation.
  • block-title se puede utilizar para crear texto en negrita que visualmente sirve como título para un bloque en una página, no aparece en la tabla de contenido generada automáticamente y puede actuar como un enlace para apuntar tal como lo hacen los encabezados. La sintaxis es: {{block-title(título)}}, donde título es lo que quieras que se muestre. título también sirve como destino para los enlaces a la sección que estás titulando. block-title está diseñado para usarse en titulación Plantilla: nota al margen, tablas, imágenes y bloques de código, particularmente en lugares a los que te referirás en el artículo más de una vez o en lugares no cercanos al artículo en sí mismo.
  • ref y endnote se pueden utilizar para implementar notas a pie de página en los artículos. El "número" de la nota al pie se crea usando {{ref("algo")}}, dónde algo debería ser una palabra descriptiva adecuada para todo lo que se menciona en la nota al pie. Luego, al final del documento, inserta {{endnote("algo")}} Blah blah, texto para la primera nota al pie para crear una lista numerada para la información de las notas al pie.
  • ReleaseChannelInfo se utiliza para crear el encabezado estándar en la parte superior de las páginas de "Firefox X para desarrolladores" para un determinado canal; se necesitan cuatro parámetros: la versión de Firefox, la versión de Gecko, una cadena que indica una fecha de lanzamiento prevista y el nombre del canal en el que se puede descargar el lanzamiento actualmente.
  • InsertFeedLinkList genera una lista de enlaces de una fuente RSS. Sus parámetros configuran la salida de manera significativa:
    • URL para el canal
    • Número máximo de entradas para incluir en la salida
    • El nivel de encabezado que se usará para el nombre del canal o 0 para dejar ese encabezado
    • Nombre de la clase que se utilizará al crear la lista; esto se aplicará al elemento <ul>.
    • Tipo de lista; este es un valor entero. 0 produce una lista de viñetas simple, mientras que 1 genera un encabezado para el título de la página seguido de un párrafo con una línea de autor.
    • El nivel de título que se utilizará para los elementos de la lista cuando se utilice el tipo de lista 1.

Transclusión

La transclusión es la incorporación de parte o la totalidad de una página en otra. Ten cuidado al utilizar esta macro, para asegurarte de que el contenido transcluido tenga sentido en el contexto de la página en la que está incorporado.

page te permite incrustar parte o la totalidad de una página específica en un documento. Acepta cinco parámetros:

  1. La URI de la página que se va a transcluir. Por ejemplo, "/es/docs/Project:MDN/About".
  2. El nombre de la sección dentro de la página que se va a incluir. Esto se puede especificar como la cadena de título o como el ID de un bloque a copiar. Si no se especifica, se transcluye todo el artículo. Optional
  3. El número de revisión de la versión de la página que se va a incluir. Esta función no está implementada actualmente, pero permitiría incluir texto de versiones específicas de un artículo. No implementado
  4. Un valor booleano que indica si se muestra o no el encabezado de la sección de nivel superior que se está transcluyendo. Esto es útil si deseas especificar tu propio título. El valor predeterminado es falso, lo cual significa que el encabezado no se incluye de forma predeterminada. Optional
  5. El nivel de título que se utilizará como nivel de título superior. Esto ajusta el primer nivel descubierto más externo del contenido transcluido al número especificado, y todos los demás encabezados correspondientemente. Esto te permite incluir contenido que tiene sus propios títulos, pero ajustarlos para que coincidan con el nivel de título en el que los estás incluyendo. Si no especificas este valor, los títulos no se ajustan. No implementado

Ejemplo sin título

{{Page("/es/docs/MDN/About", "Acerca de Mozilla")}}

Resultado:

Si deseas aprender más acerca de quiénes somos, cómo ser parte de Mozilla, o simplemente, dónde encontrarnos, estás en el lugar correcto. Para saber lo que nos mueve y nos hace diferentes, por favor visita nuestra página de misión.

Ejemplo con encabezado

{{Page("/es/docs/MDN/About", "Acerca de Mozilla", 0, 1)}}

Resultado:

Acerca de Mozilla

Si deseas aprender más acerca de quiénes somos, cómo ser parte de Mozilla, o simplemente, dónde encontrarnos, estás en el lugar correcto. Para saber lo que nos mueve y nos hace diferentes, por favor visita nuestra página de misión.

Creando nuevas insignias

También tenemos insignias que no tienen iconos con burbujas. La plantilla genérica para esto es SimpleBadge, que acepta tres parámetros:

  1. Texto para mostrar en la insignia.
  2. Nombre de una clase CSS que se utilizará como fondo de la insignia.
  3. (Opcional) Texto para mostrar en una información sobre herramientas al pasar el cursor sobre la insignia.

Desaprobado

Estas macros han sido reemplazadas por otras formas de hacer lo mismo y ya no se deberían usar. Si los encuentras en artículos existentes, reemplázalos.

Enlaces

  • La macro anch inserta un enlace a un ancla. {{anch("top")}} produce <a href="#top">top</a> (top). También puedes agregar un segundo parámetro que contiene texto de reemplazo para mostrar como texto del enlace. {{anch("Otras insignias", "puedes usar otras insignias")}} produce este resultado: puedes usar otras insignias. La idea era crear una plantilla que permitiera vincular fácilmente a otras secciones de un documento. Reemplazo: usa el botón de la barra de herramientas de anclaje en la interfaz del editor. Esto realmente no es un "reemplazo" y existe cierta discusión sobre si esto está realmente desaprobado en este momento.
  • La macro SectionOnPage crea una frase que enlaza tanto con el nombre de una sección como con el artículo que contiene esa sección. Por ejemplo, {{SectionOnPage("/es/docs/Mozilla/Firefox/Releases/21", "Cambios para desarrolladores web")}} genera lo siguiente: Cambios para desarrolladores web (en-US) in [Page not yet written] (en-US).
  • La macro manch inserta un enlace a un método dentro de la interfaz actual; esto está destinado únicamente para su uso en las páginas de documentación de la interfaz. {{manch("foo")}} produce <code><a href="ruta/actual#foo">foo()</a></code> (foo()).
  • La macro Link inserta un enlace a la página especificada en MDN, usando el título de la página como la cadena visible para hacer clic, y la información sobre herramientas extraída del resumen SEO de la página.
  • La macro LinkItem inserta un enlace a una URL especificada, con el texto indicado como la cadena visible para hacer clic. El enlace automáticamente recoge como información sobre herramientas el resumen de la página destino. Esto difiere de Link en que debe especificar el título.
  • La macro LinkItemDL inserta un enlace a una URL especificada, con el texto indicado como <dt> que también es el enlace. El elemento <dd> contiene el resumen de la página especificada.
  • funcref crea enlaces a funciones globales (generalmente de C++) documentadas en páginas de nivel superior. Sin embargo, estas páginas ya no se crean en el nivel superior de MDN.
  • Pref inserta un enlace a la entrada en Referencia de preferencia para la preferencia especificada.
  • spec inserta un enlace a una especificación. Reemplazo: utiliza spec2 o SpecName en su lugar.
  • source te permite vincular a un archivo de código fuente de Mozilla sin tener que escribir una URL MXR larga usando esta sintaxis: {{source("browser/Makefile.in")}}. Esto te da: browser/Makefile.in. El texto del enlace es la ruta proporcionada; si deseas un texto diferente, proporciona un segundo parámetro, así: {{source("browser/Makefile.in", "the browser/Makefile.in")}} , que produce the browser/Makefile.in. Ten en cuenta que el enlace será a la última versión del archivo en código de última generación.
  • source_cvs funciona igual que source, excepto que enlaza con repositorio CVS (en-US) en lugar del más nuevo mozilla-central uno.
  • LXRSearch se puede utilizar para crear una URL de búsqueda LXR.

Ejemplos de código

Las siguientes macros se usaron antes de la implementación del sistema de ejemplo en vivo (en-US) integrado en Kuma, y se deben reemplazar por usos de EmbedLiveSample o LiveSampleLink.

  • LiveSample te permite crear un botón que se vincule a un archivo de ejemplo; estos ejemplos se enviaron a Eric Shepherd para su carga. Estos se utilizaron en las páginas de referencia cuando se vinculan a páginas de muestra independientes y en vivo. La plantilla acepta un parámetro, el nombre del archivo HTML al que enlazar.
  • CSSLiveSample te permite crear un botón que se vincule a una muestra en la Referencia CSS; estos ejemplos se enviaron a Eric Shepherd para su carga. Estos se utilizaron en las páginas de referencia de CSS cuando se vinculan a páginas de ejemplo independientes y en vivo. La plantilla acepta un parámetro, el nombre del archivo HTML al que enlazar.
  • DOMLiveSample te permite crear un botón que se vincule a una ejemplo en la Referencia DOM; estos ejemplos se enviaron a Eric Shepherd para su carga. Estas se utilizaron en las páginas de referencia DOM al vincular a páginas de ejemplos independientes y en vivo. La plantilla acepta un parámetro, el nombre del archivo HTML al que enlazar.
  • HTMLLiveSample te permite crear un botón que enlace a una ejemplo en la Referencia HTML; estos ejemplos se enviaron a Eric Shepherd para su carga. Estos se utilizaron en páginas de referencia HTML al vincular a páginas de ejemplos independientes y en vivo. La plantilla acepta un parámetro, el nombre del archivo HTML al que enlazar.
  • SVGLiveSample te permite crear un botón que se vincule a un ejemplo en la Referencia DOM; estos ejemplos se enviaron a Eric Shepherd para su carga. Estos se utilizaron en las páginas de referencia SVG al vincular a páginas de ejemplos independientes y en vivo. La plantilla acepta un parámetro, el nombre del archivo HTML al que enlazar.
  • JSFiddleLink te permite crear fácilmente un botón que enlace a un ejemplo en el sitio web jsFiddle. Estos NO se deben usar para reemplazar los ejemplos en línea o los ejemplos cargados por MDC, sino para ofrecer acceso a ejemplos secundarios con los que los lectores pueden experimentar. La plantilla acepta un parámetro, la etiqueta de identificación del elemento jsFiddle a vincular.

Organizacional

  • LockedPage inserta una barra de marcas en la página que proporciona una explicación de por qué una página está bloqueada. Esta macro está obsoleta porque Kuma no admite el bloqueo de páginas.
  • jsapi_ref_header se utilizó para crear rutas de navegación para la JSAPI referenciada; esto ahora lo hace Kuma, no una macro.

Formateo

  • Note inserta un bloque de "nota" con un formato especial en el texto del artículo. Esto tiene la intención de resaltar un hecho interesante o importante. Reemplazo: Usa el estilo Note box en la barra de herramientas del Editor.
  • warning inserta un bloque de "advertencia" con un formato especial. WarningStart y WarningEnd definen el inicio y el final del bloque de advertencia que debe contener otras llamadas de macro. Reemplazo: Usa el estilo Warning box en la barra de herramientas del Editor.

Indicadores de versión

Las siguientes macros están en desuso porque esta información debería estar contenida en el artículo de la tabla de compatibilidad de navegadores.

  • Gecko inserta el texto "Gecko número de versión" en el texto, pero agrega una información sobre herramientas que, cuando el usuario pasa el mouse sobre él, muestra las versiones correspondientes de Firefox, Thunderbird y SeaMonkey.
  • unimplemented_inline inserta una marca en línea de "no implementado" para evitar el uso de, por ejemplo, una función, método o propiedad que aún no está implementada. Reemplazo: Utiliza la tabla de compatibilidad de navegadores para indicar esta información.
  • gecko_callout_heading incluye un cuadro de llamada específico de la versión de Gecko.
  • fx_minversion_note crea una nota sobre una versión mínima de Firefox.
  • h1_gecko_minversion, h2_gecko_minversion y h3_gecko_minversion te permiten insertar encabezados (h1, h2 y h3) que se incluyen a la derecha al final de la línea, una insignia que indica la versión de Gecko (y las versiones correspondientes de la aplicación) a la que se aplica la sección.