[Eneboo Standard] Cómo colaborar

Oscar edited this page Oct 16, 2015 · 5 revisions

Este manual lo han creado miembros de la Comunidad Eneboo. Si deseas completarlo, este capítulo te interesa. ¿Crees que no tienes suficientes conocimientos técnicos? No te preocupes, verás que es muy fácil. ¡Anímate a colaborar!

Guía rápida de edición del wiki de GitHub

Como puedes ver, este manual está publicado en el wiki de GitHub. Es una herramienta sencilla, intuitiva y muy fácil de usar. En este apartado mostraremos cómo utilizar las opciones que se usan para la edición de este manual. Puedes encontrar un manual más completo aquí, aunque esta documentación está algo desactualizada.

Pídenos permiso

Si quieres colaborar con la edición necesitarás una cuenta de GitHub con permisos de edición sobre el wiki. Date de alta en GitHub y después solicita permisos de edición en el foro de Eneboo.

Crear o editar una página

Cada capítulo del manual se escribe en una página distinta. Con los botones Edit Page o New Page podemos respectivamente editar o crear una nueva página.

Siempre utilizaremos el modo de edición (Edit mode) Markdown, el que usa el wiki por defecto.

La barra de botones de edición

Al crear o editar una página nos aparecerá una barra de botones de edición. Barra de botones de edición

Hay que aclarar que el editor del wiki no es del tipo WYSIWYG. Por tanto, no veremos inmediatamente los cambios de formato que producen los botones, sino que al pulsarlos se introducirán unas marcas en el texto. Para ver cómo quedará finalmente la página debemos guardarla o pulsar el botón Preview que podemos encontrar al final de ésta.

Los tres primeros botones (h1, h2 y h3) sirven para indicar que un párrafo es un título. El nombre de una sección de un capítulo se marca con h1, con h2 el de una subsección y con h3 se marca el nombre de una subsección un nivel más abajo.

El botón de Link sirve para crear enlaces. Los tenemos de tres tipos:

  1. Enlaces internos. Son los que hacemos dentro de la misma página, al título de una sección. Tienen la forma: [Texto del enlace](#titulo-seccion)
  2. Enlaces a otras páginas del wiki. Tienen la forma: [Texto del enlace]([Eneboo Standard] Nombre de la página)
  3. Enlaces externos (a otras páginas web que no pertenecen al wiki). Tienen la forma: [Texto del enlace](http://www.unapaginacualquiera.com/pagina)

Las imágenes se insertan con el botón Image, que abre un diálogo que nos pide la URL de la imagen y un texto alternativo (que no se ve normalmente y que se utiliza para, por ejemplo, para mostrarlo cuando por alguna razón la imagen no se puede visualizar). Las imágenes se han de subir a la carpeta images/standard/ del repositorio doc. La URL que hemos de indicar tendrá la forma: https://raw.githubusercontent.com/eneboo/doc/master/images/standard/nombre_imagen.png.

Podemos obtener esta URL navegando por GitHub hasta llegar a la imagen en el repositorio, pulsando el botón Raw y copiando la URL que nos muestre el navegador.

El resto de las opciones de la barra de botones hacen lo que se espera de ellas y no merecen una explicación detallada. Se puede ver su funcionamiento simplemente probándolas.

Convenciones usadas para este manual

Para conseguir que el manual, editado por muchos colaboradores, tenga una apariencia homogénea, seguiremos unas sencillas convenciones.

  1. Los elementos propios de la aplicación, como nombres de campos o botones, deberán ir en cursiva para distinguirlos mejor. Durante la edición el texto se verá como se muestra en el siguiente ejemplo: Para crear una nueva factura pulse el botón *Insertar registro*.
  2. Los nombres de las páginas irán precedidos siempre por el texto [Eneboo Standard]. Esto se hace así para poder ver en el listado de páginas del wiki todas las que se refieren a un mismo tema de forma agrupada, ya que el wiki no muestra carpetas.

El índice

En la parte superior derecha de cada página verás un índice que nos permite acceder directamente a cada una de ellas. Este índice no se genera de forma automática, sino que hay que editarlo.

Podemos hacerlo cuando pulsamos el botón Edit Page. Iremos al final de la página y pulsaremos en la flecha hacia abajo que hay junto Sidebar. Ahí podemos añadir o modificar los enlaces del índice como hemos explicado en la sección La barra de botones de edición para el caso de enlaces a páginas del mismo wiki.

Nota: Cuando crees una página nueva verás que no aparece el índice. Esto es porque el wiki por defecto crea la página en el directorio raíz del repositorio del wiki, donde no le afecta el archivo _Sidebar.md que contiene el índice, ya que este archivo está en el directorio standard. Para que se muestre el índice debes hacer lo siguiente:

  1. Bájate con git el repositorio del wiki ejecutando git clone https://github.com/eneboo/doc.wiki.git.
  2. Mueve la página al directorio standard con git mv \[Eneboo-Standard\]-Nombre-de-la-pagina.md standard/.
  3. Haz commit y push.

Si tienes problemas para hacer esto coméntalo en el foro, te echaremos una mano.

Eneboo Standard:

  • [Introducción]([Eneboo Standard] Introducción)
  • [Instalación]([Eneboo Standard] Instalación)
  • [El entorno de trabajo en Eneboo]([Eneboo Standard] Entorno de trabajo)
  • [Primeros pasos]([Eneboo Standard] Primeros pasos)
  • [Área de facturación]([Eneboo Standard] Área de facturación)
  • [Área financiera]([Eneboo Standard] Área financiera)
  • [Área de sistema](Área de sistema)
  • [Cómo colaborar]([Eneboo Standard] Cómo colaborar)

--

Personalización de Eneboo:

  • [Cargar módulos y aplicar extensiones](Cargar módulos y aplicar extensiones)
  • [Listado de extensiones](Listado de extensiones)
  • Eneboo-Reports (Informes con Jasper Reports)
  • [Eneboo-Reports: crear Plantillas .jrxml](Crear plantillas Jasper para Eneboo Reports)
  • [Importación de datos](Importación de datos)

--

Área técnica:

  • [Compilar el motor](Compilar el motor)
  • EnebooTools
  • [Bancos](Lista de Bancos por defecto)
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.