Herramientas de usuario

Herramientas del sitio

Traducciones de esta página:

repo:guia_de_uso

Uso del repositorio

En construcción

¿Cuál es el objetivo del repositorio?

La idea es organizar la información de la wiki de modo tal que disminuya la duplicación de información

La propuesta actual es segmentar por tipo de información en lugar de por plataforma, proyecto o tecnología, construyendo bloques reutilizables a incluir desde las páginas reales de documentación.

De este modo, “como conectar la edu ciaa” es un bloque constitutivo que se usa desde las guías de instalación de firmware, de ide, de linux, de debugging y cualquier otra que en algún momento necesite referirse a conectar la edu ciaa.

Es la aplicación de las más sencillas técnicas de reutilización de software a los textos e imágenes que constituyen la documentación del proyecto.

Bloques

¿Cómo construir un bloque?

Habiendo detectado o previendo una duplicación de información, se crea un bloque. Debe corresponder a un concepto o una instrucción.

¿Cómo se usa un bloque?

Se debe usar la siguiente instrucción:

{{page>repo:espacio:bloque#seccion&nofooter}}

siendo

  • espacio un sub espacio de nombre, por ejemplo: “instalacion”
  • bloque el nombre del bloque, por ejemplo: “debug”
  • sección el nombre de una sección, por ejemplo: “linux”

Pueden haber varios espacios en la medida en que haya jerarquización dentro del repo.

La sección es optativa, pero es muy relevante en caso de quere utilizar la sección de una página existente. Esto puede ocurrir principalmente durante la adaptación al nuevo modelo.

Opcionalmente se puede agregar el atributo &noheader, ver el tema de TOC para más detalles.

Trabajando con la TOC

Para evitar que se muestre, hay que poner ~~NOTOC~~ como primera linea. En caso de usarla, puede ser conveniente hacer las inclusiones de bloques con el atributo &noheader y replicar el encabezado del bloque con el nivel apropiado para que figure correctamente en la TOC.

Otros espacios asociados

Acompanañando al espacio de nombres repo están borradores, imagenes y guias.

borradores

Es donde se preparan las páginas nuevas o en proceso de migración.

imagenes

Al igual que repo debe contar con alguna jerarquización. Contiene una sóla página, cargar que cumple con la función de punto de entrada para cargar las imágenes en este espacio de nombres, hasta que halle como mover las cosas de lugar.

Una vez en esa página, seleccionar “fichero” → “cargar”

guias

Misc

Autoría

La migración produce la pérdida de autoría y la falsa atribución a quien la realice. Según lo conversado en las listas, no es un tema muy importante.

Roadmap

Páginas en proceso

  • firmware
  • hardware

Páginas a procesar

  • uncrustify desarrollo:firmware:uncrustify
  • php
  • conectar edu_ciaa desarrollo:edu-ciaa:edu-ciaa-nxp:python:comenzar_programar
  • corregir guiones en bloques existentes
  • miniterm
  • generador: incluir bloque definición OIL

Páginas a crear

  • yaml
  • instalación de cygwin
repo/guia_de_uso.txt · Última modificación: 2016/11/19 15:06 por cpantelides