mozilla

Comparar revisiones

Escribiendo documentación de referencia de la interfaz

Change Revisions

Revisión 380895:

Revisión 380895 de Aligo el

Revisión 382623:

Revisión 382623 de Aligo el

Título:
Writing interface reference documentation
Writing interface reference documentation
Enlace amigable (slug):
Project:en/Project:Writing_interface_reference_documentation
Project:en/Project:Writing_interface_reference_documentation
Contenido:

Revisión 380895
Revisión 382623
n17      Echa un vistazo a nuestro <a href="/en-US/docs/Project:Sampn17      Echa un vistazo a nuestro <a href="/en-US/docs/Project:Samp
>le_interface_document" title="Project:Sample_interface_document">>le_interface_document" title="Project:Sample_interface_document">
>documento de muestra de interfaz</a> para ver un interfaz fictici>documento de muestra de interfaz</a> para ver un interfaz fictici
>o que incluye todos los elementos de un completo documento de ref>o que incluye todos los elementos de un documento completo de ref
>erencia de un interfaz. Este artículo puede servir de ejemplo cua>erencia de un interfaz. Este artículo puede servir de ejemplo cua
>ndo se documente un interfaz.>ndo se documente un interfaz.
n29      Following the table of contents, use the <code><a href="/enn29      Basándote en la lista de contenidos, usa la plantilla <code
>-US/docs/Template:IFSummary" title="Template:IFSummary">IFSummary>><a href="/en-US/docs/Template:IFSummary" title="Template:IFSumma
></a></code> template to describe the location and status of the i>ry">IFSummary</a></code> para describir la localización y el esta
>nterface in the source tree.>do del interfaz en el árbol de origen.
n32      The parameters to the <code>IFSummary</code> template are:n32      Los parámetros de la plantilla <code>IFSummary</code> son:
n36        Path of the IDL file defining the interfacen36        Ruta del archivo IDL que define la interfaz
n39        This is used to create a link to the interface's IDL on Mn39        Se usa para crear un vínculo con el IDL del interfaz sobr
>XR so the reader can refer to it if they wish.>e el MXR para que el lector pueda referirse a él si lo desea.
n42        Parent interfacen42        Interfaz padre
n45        This is the name of the interface upon which the interfacn45        Es el nombre del interfaz sobre el que se basa el interfa
>e being document is based. This will be turned into a link to tha>z que se está documentando. Se convertirá en un vínculo a ese int
>t interface in the interface reference and displayed.>erfaz en la referencia y se mostrará.
n48        scriptable/not scriptablen48        scriptable/no scriptable
n51        A string indicating whether the interface is scriptable on51        Una cadena que indica si el interfaz se puede convertir e
>r not. You must use either "scriptable" or "not scriptable" (thes>n un script o no. Debes elegir "scriptable" o "no scriptable" (qu
>e are, however, case insensitive). This will be turned into an ap>e diferencian entre mayúsculas y minúsculas). La indicación se co
>propriate indicator in the box, colored green for scriptable inte>nvertirá en el marcador apropiado, de color gris cuando el interf
>rfaces or red for non-scriptable ones. The indicator will also in>az se pueda convertir en script y rojo cuando no. El indicador ta
>clude a link to an article explaining what this means.>mbién incluirá un vínculo a un artículo que explique lo que signi
 >fica esto.
n54        Last changed in what Gecko versionn54        Últimos cambios en una versión Gecko
n57        This is a string indicating the version of Gecko in whichn57        Es una cadena que indica la versión de Gecko en la que el
> the interface was last changed. Should be a string in standard G> interfaz sufrió cambios por última vez. Debería ser una cadena c
>ecko version format, such as "1.9" or "1.9.2" or even "1.9.1.6".>on el formato estandar de la versión de Gecko, como "1.9" o "1.9.
 >2" o incluso "1.9.1.6".
n60        Summary {{ optional_inline() }}n60        Resumen{{ optional_inline() }}
n63        A brief textual summary of what the interface does. Shouln63        Un breve resumen de texto de lo que el interfaz hace. Bas
>d be just a sentence or two. This is only optional for backward c>ta con una frase o dos. Esto sólo opcional por compatibilidad hac
>ompatibility with old interface documents using the now deprecate>ia atrás con documentos de interfaces antiguos que usan la planti
>d InterfaceStatus template (which now calls through to this one).>lla ya relegada de InterfaceStatus (que ahora dirige a esta). <em
> You should <em>always</em> provide this.>>Siempre</em> deberías incluirlo.
n66        Version introduced {{ optional_inline() }}n66        Versión introducida {{ optional_inline() }}
t69        If you know the version of Gecko in which the interface wt69        Si sabes la versión de Gecko en la que se introdujo el in
>as introduced, include that here. This will trigger the inclusion>terfaz, inclúyela aquí. This will trigger the inclusion of a vers
> of a version timeline showing the availability of the interface >ion timeline showing the availability of the interface in contras
>in contrast to the history of Gecko, in graphical format.>t to the history of Gecko, in graphical format.

Volver al historial