Guidelines (Español)

¡Esta traducción no es necesarea! ¡En caso de duda, acudir al original en inglés!

Todos los usuarios registrados están autorizados para editar la sección wiki, pero se te pide por favor, que sigas las siguientes guías/reglas para mantener el formato de la wiki y así poder evitar confusiones. Si opinas que las guías/reglas deberían cambiar o podrían contener información adicional, por favor no dudes en ponerte en contacto con Rude (en inglés).

Objetivo

Los principales objetivos del wiki son los siguientes:

1. Documentar la API de LÖVE y proporcionar tutoriales.
2. Proporcionar información acerca de juegos y librerías usadas en LÖVE.

Dicho esto, está totalmente permitido añadir cualquier tipo de información que no entre dentro de estas categorías.

Si deseas realizar cambios importantes en el wiki, como por ejemplo "el despliegue de una nueva estructura para los tipos predefinidos", no lo hagas. Debes hablar con Rude primero, de no ser así, existe una gran probabilidad de que los cambios que realices puedan ser revertidos/eliminados.

Conflicto de Nombres

Para evitar enlaces con demasiados paréntesis, las páginas de la documentación tienen títulos simples sin prefijos ni sufijos. Por ejemplo, el tipo Image puede hacer referencia de forma externa a traves de http://love2d.org/wiki/Image.

Esto en ocasiones pude generar un conflicto de nombres, en cuyo caso las páginas de la documentación siempre ganan. Por ejemplo, si creas un juego llamado Alucinante y después LÖVE decide exponer un nuevo tipo llamado Alucinante (no del todo improbable), entonces tu juego se moverá a otro título.

Estilo

Si estamos hablando de tipos integrados en LÖVE, enlázalos. Por ejemplo, Image es un objeto que se puede visualizar en la pantalla.

Cuando hacemos referencia a variables y a código dentro de un sentencia regular, utiliza la etiqueta <code> para mejorar la experiencia de lectura. Por ejemplo: cuando agregas foo y bar, el resultado es foobar.

Documentación

Las páginas de la documentación deben seguir la misma estructura, para que puedan ser comprendidas y utilizadas por los usuarios.

Todas las páginas de la documentación deben tener un vínculo (link) de semántica a sus padres en la sección Véase También. Sin esto, el elemento no aparecerá en las listas automáticas a través de la wiki. Un vínculo semántico se añade así a una función, tipo o enumeración en love.audio:

[[parent::love.audio]]

Todas las páginas de la documentación deben tener una descripcion semántica, 'list-friendly'. Esto se consigue al añadir al final de la página lo siguiente:

{{#set:Description=Dibuja una [[Imagen]] en la pantalla.}}

Módulos

Los siguientes encabezados de 'nivel 2' están permitidos, pero solo se deben utilizar si contienen algo:

• Tipos
• Funciones
• Enumeraciones
• Notas
• Ejemplos
• Véase También

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

Tipos

Los siguientes encabezados de 'nivel 2' están permitidos, pero nuevamente, no las utilices y las dejes vacías:

• Funciones
• Enumeraciones
• Supertipos
• Subtipos
• Notas
• Ejemplos
• Véase También

Todos los tipos deben estar asociados con Category:Types.

Funciones

Para las funciones, todos los encabezados son requeridos, excepto Notas, Ejemplos y Véase También. Esto significa que si una función no devuelve nada, debería decir explícitamente que no devuelve nada. Lo mismo ocurre con los argumentos.

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

Los elementos externos de la lista a continuación son encabezados de 'nivel 2' y los internos de 'nivel 3':

• Constructores
• Función
  • Sinopsis
  • Argumentos
  • Retornos
• Notas
• Ejemplos
• Véase También

Si una función tiene sobrecargas (overloads), repetir los encabezados de la 'Función' por cada sobrecarga. Esto no es necesario para la adición de argumentos opcionales, simplemente indica el valor por defecto entre paréntesis en su lugar.

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

Todos las funciones deben estar asociadas con Category:Functions.

Enumeraciones

Para las enumeraciones, estos encabezados están permitidos:

• Constantes
• Notas
• Véase También

Las constantes deben aparecer como una lista de definiciones.

Todos las enumeraciones deben estar asociadas con Category:Enums.

Juegos

Para los juegos, puedes elegir tu propia estructura, pero siempre hay que añadir algunas propiedades semánticas a la página para que aparezca correctamente en la lista de juegos:

{{#set:Name=Monkey Island}} (Debería ser el mismo que el titulo de la página)
{{#set:Author=User:Rude}}
{{#set:Genre=Que tipo de juego es.}}
{{#set:LOVE Version=0.6.1}}
{{#set:Description=Una breve descripcion de tu juego.}}
{{#set:Screenshot=File:ImagenURL.png}}

Las capturas de pantalla serán automáticamente cambiadas de tamaño para que se adapten a una resolución de 161x100 pixeles.

Pon tu juego en Category:Games para que aparezca automáticamente en la página Games. Para ponerlo en la categoría correcta, debes añadir esta linea al final de la página:

[[Category:Games]]

También se recomienda que proporciones imágenes de tu juego.

Librerías

No hay reglas estrictas, pero al igual que en los juegos, debes añadir estas propiedades semánticas:

{{#set:LOVE Version=0.6.1}}
{{#set:Description=Una breve descripción de tu librería.}}

Pon tu librería en Category:Libraries para que aparezca automáticamente en la página de Libraries. Para ponerla en la categoría correcta, debes añadir esta linea al final de la página:

[[Category:Libraries]]