Guidelines (Español)

Todos los usuarios registrados están autorizados para editar la sección Wiki, pero se le pide por favor, que siga las siguientes guías/reglas para mantener el formato de la Wiki, para poder evitar las confusiones. Si usted opina que las guías/reglas deberían cambiar, o podrían contener información adicional, por favor no dude en ponerse en contacto Rude(Ingles).

Objetivo

Los principales objetivos de la Wiki son los siguientes.

1. Para la Documentación de la API de LÖVE, y proporcionar tutoriales.
2. Para proporcionar información acerca de videojuegos y librerías usadas en LÖVE.

Esta totalmente permitido añadir cualquier tipo de información acerca de otras cosas que no entran dentro de las categorías.

Si usted desea hacer algún cambio mayor en la Wiki, por ejemplo "el despliegue de una nueva estructura para los tipos predefinidos", Por favor no lo haga. Usted debe hablar con Rude primero(Ingles), de no ser así, existe una gran probabilidad de que los cambios que realice puedan ser revertidos/eliminados.

Conflicto de Nombres

Para evitar ligas(URLs/Links) con demasiados paréntesis, las páginas de la documentación tienen títulos simples sin prefijos ni sufijos. Por ejemplo, el tipoImage puede hacer referencia de forma externa como http://love2d.org/wiki/Image.

Esto en ocasiones pude generar un Conflicto de nombres, en cuyo caso las paginas de la documentación siempre ganan. Por ejemplo, si usted crea un videojuego llamado Awesome y LÖVE después decide exponer un nuevo tipo llamado Awesome(que es muy poco probable), entonces tu videojuego seria movido con otro titulo.

Estilo

Si estamos hablando de tipos construidos en LÖVE, ponga una liga a ellos. Por ejemplo, Image es un objeto que se puede visualizar en la pantalla.

Cuando hacemos referencia a variables y código dentro de un sentencia regular, utilizar <code> tag para manejar la experiencia de lectura. Por ejemplo: cuando usted agrega foo y bar, el resultado es foobar.

Documentación

Las Paginas de Documentación deben seguir la misma estructura, para que puedan ser comprendidas y utilizadas por los usuarios.

Todas las Paginas de Documentación deben tener una vínculo(link) de semántica con sus padres en la sección See Also. Sin esto, el elemento no aparecerá en las listas automáticas a través de la Wiki. Un vínculo(link) semántico se añade así a una función(function), tipo(type) o enumeración(enum) en love.audio:

[[parent::love.audio]]

Todas las Paginas de Documentación deben tener una descripcion semántica 'list-friendly'. Esto se consigue al añadir al final de la pagina lo siguiente:

{{#set:Description=Draws an [[Image]] on screen.}}

Módulos (Modules)

Los siguientes encabezado de 'level 2' están permitidas, pero solamente se deben utilizar si contienen algo.

• Types
• Functions
• Enums
• Notes
• Examples
• See Also

Todos los módulos deben estar asociados con Category:Modules.

Tipos (Types)

Los siguientes encabezado de 'level 2' están permitidas, pero nuevamente, no las utilice y las deje vacías.

• Functions
• Enums
• Supertypes
• Subtypes
• Notes
• Examples
• See Also

Todos los tipos deben estar asociados con Category:Types.

Funciones (Functions)

Para las funciones, todos los encabezados son requeridos, excepto Notas(Notes), Ejemplos (Example) y Véase también (See Also). Esto significa que si una función no regresa nada, eso debería decir explícitamente que no regresa nada. De el mismo modo para los argumentos.

Del mismo modo, si no hay constructores de un tipo determinado (por ejemplo, Contact), esto debe mencionarse explícitamente.

Los elementos externos de la lista a continuación son encabezados 'level 2', y los internos son 'level 3'.

• Constructors
• Function
  • Synopsis
  • Arguments
  • Returns
• Notes
• Examples
• See Also

Si una función tiene sobrecargas(overloads), repetir los encabezados de la 'Función' por cada sobrecarga. Esto no es requerido para rastrear los argumentos, solamente indican el valor predeterminado en lugar de los paréntesis.

Los argumentos y los valores de retorno deben ser presentados como una lista de definición, utilizando Template:param.

Todos las funciones deben estar asociadas con Category:Functions.

Enumeraciones (Enums)

Para las Enumeraciones, estos encabezados están permitidos:

• Constants
• Notes
• See Also

Las constantes debe aparecer como una lista de definiciones.

Todos las Enumeraciones deben estar asociadas con Category:Enums.

Videojuegos (Games)

Para los videojuegos, usted puede elegir su propia estructura, pero siempre hay que añadir algunas propiedades semánticas de la página para que aparezca correctamente en el list of games:

{{#set:Name=NoGame}} (Should be same as page title)
{{#set:Author=User:Rude}}
{{#set:Genre=What kind of game your game is}}
{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your game.}}
{{#set:Screenshot=File:ScreenshotURL.png}}

Las capturas de pantalla serán automáticamente cambiadas de tamaño para que ser adapten a un cuadro de 161x100 pixeles.

Esto pondra su juego en Category:Games para que aparezca automáticamente en la pagina Games. Para poner su juego en la categoría correcta, debe añadir esta linea al final de la pagina.

[[Category:Games]]

También se recomienda que usted proporciona imágenes de su juego.

Librerías (Libraries)

No hay reglas estrictas, pero en igual que los videojuegos, se debe añadir estas propiedades semánticas:

{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your library.}}

Esto pondra su libreria en Category:Libraries para que aparezca automáticamente en la pagina de Libraries. Para poner su librería en la categoría correcta, debe añadir esta linea al final de la pagina.

[[Category:Libraries]]