Mejoras y correcciones en el material

Tienes dos formas de hacerlo:

• Si es un error o mejora particular en algún texto, puedes subir un ticket en el panel de incidencias. Trata de detallar de forma especifica el asunto así podemos solucionarlo lo más rápido posible. También puedes contactarte por email: reportes(arroba)librojquery.com.

• Si quieres contribuir con textos, puedes clonar el repositorio, realizar los cambios y enviar una solicitud para incorporarlos. Los contenidos a añadir pueden ser de todo tipo: nuevos temas, mejores explicaciones, trucos, tips, etc. Algunos temas interesantes pueden ser:

  • Mejoras que surjan en nuevas versiones de jQuery;
  • Utilización de jQuery UI;
  • Pruebas unitarias con QUnit o similar;
  • Jquery Mobile;

Los textos de cada capítulo se encuentran dentro de la carpeta /libro/markdown/. Allí cada capítulo es un archivo con la extensión .markdown. Dichos archivos estan conformados por texto plano en el formato markdown, una forma muy fácil de escribir textos (muy similar a la forma en la que se escriben los textos en la wikipedia...). Más información sobre la sintaxis de markdown: http://es.debugmodeon.com/articulo/sintaxis-de-markdown (aunque si abres un capítulo con cualquier editor de textos te darás cuenta lo fácil que es...);

Si nunca has utilizado Git o GitHub:

El proceso es muy sencillo:

1- Crear una cuenta gratuita en GitHub;

2- Seguir el manual para instalar Git: http://help.github.com/set-up-git-redirect. En la sección que dice Add your SSH key to GitHub debes loguearte con la cuenta que hayas creado en GitHub y seguir los pasos;

3- Luego realizar un fork (clon) del repositorio original del libro:

4- Una vez realizado el fork, debes bajarte el repositorio clon a tu máquina: http://help.github.com/fork-a-repo/ (seguir las instrucciones a partir de donde dice: Next: Set up your local repo). El repositorio remoto para bajar actualizaciones (para la sección que dice Configure remotes) es [email protected]:dzignus/librojquery.git;

5- Una vez bajados los archivos a tu máquina, realiza los cambios apropiados que quieras sumar al manual.

6- Una vez hechos los cambios, los comandos básicos para subir lo que has hecho al repositorio son (se deben ejecutar desde la carpeta raíz que contienen los archivos fuentes, puedes navegar entre carpetas a través del comando cd):

git status
git add .
git commit -m "Un comentario sobre el cambio realizado"
git push

7- Si todo salió bien, al entrar a la URL de tu repositorio debería aparecer el commit (subida) que realizaste.

8- Puedes seguir modificando, realizando cambios y subiendo. Cuando hayas finalizado debes mandar una pull request para que los cambios realizados sean unidos al repositorio maestro: http://help.github.com/pull-requests/. Esto sólo implica presionar el botón pull request y agregar algún comentario sobre lo que se quiere sumar.

9- ¡Y listo!

Convenciones en la incorporación de textos

Los textos del libro tratan de seguir algunas convenciones. Si quieres realizar algún aporte, por favor, tenlas en cuenta:

• Se deben evitar términos exclusivos de un país o región. En caso de no poder hacerlo, buscar un sinónimo lo más acorde posible;

• Evitar la repetición de palabras, sobre todo cuando dichas estén demasiado próximas, salvo en excepciones (cuando no exista otro término adecuado para intercambiar);

• Los títulos deben estar en infinitivo, no en gerundio (ejemplo: "Crear una página web");

• Pueden existir términos en inglés que no tienen traducción al español (o hacerlo puede resultar confuso para el usuario). Para estos casos, la palabra debe ser marcada en cursiva y tener, en caso de ser necesario, una breve descripción del significado de la palabra (ejemplo: Clapper (Interruptor por aplausos));

• Las mayúsculas deben llevar tilde cuando sea necesario;

• Los signos de puntuación van fuera de paréntesis, comillas, etc.

• Cuando el enunciado se refiera al lector, la persona gramatical utilizada es la segunda (Usted). La inclusión del término Usted no es obligatorio para oraciones en las que queda explícito a quién se refiere el enunciado.

Generar las versiones HTML y PDF del libro

Si te has bajado el repositorio completo para realizar algún cambio y deseas generar las versiones HTML/PDF para ver como quedan dichas modificaciones, deberás tener instalado:

• Pandoc: Para poder realizar la conversión markdown a HTML;
• LaTeX: Para poder realizar la conversión markdown a PDF;

Los comandos para realizar la conversión se encuentran en el archivo Makefile. También puedes realizar la conversión automática ejecutando el comando make sobre la carpeta raíz del repositorio. Ten en cuenta que si estás en Windows debes utilizar cygwin (en conjunto con el paquete make). En caso de estar en Mac debes tener instaladas las herramientas de desarrollo.