/ManualOnToology

Manual en español del uso de OnToology

Tabla de contenido de la Guía de uso de OnToology

  1. Primer paso: registrar un repositorio
  2. Funcionamiento de OnToology
  3. Administración del entorno de trabajo

Registrar un repositorio

Para utilizar OnToology debes contar previamente con una cuenta de Github en la que posterioremente podrás crear repositorios en los que albergar tu(s) ontología(s). Debes fijarte que en tu perfil de Github tienes escrito tu Nombre y que tu correo eléctronico sea de acceso público pues de no serlo OnToology no podrá acceder a tu cuenta.

Para que OnToology haga un seguimiento de tus ontologías (o mejor dicho los ficheros .ttl, .owl and .rdf que haya en tu repositorio) debes introducir en OnToology el nombre de tu repositorio "usuario/nombreDeRepositorio" y presionar el botón "Watch this Repo" (véase figura a continuación).

A continuación Github te redireccionará para solicitarte que autorices a OnToology para que tenga acceso a tu repositorio, tendrás que dar click en el botón "Authorize application"

Si tu repositorio ya contenía algún fichero .owl, .ttl o .rdf OnToology lanzará los procesos de generación de reportes de evaluación, documentación y diagramas y a continuación generará una Pull request para incorporar los recursos generados a tu repositorio.

En otro caso OnToology no lanzará ningún proceso ya que solo se activa con la modificación de ficheros .owl, .ttl o .rdf.

Funcionamiento de OnToology

Como ya hemos comentado OnToology se activa cuando uno o más ficheros del repositorio que contengan ontologías son añadidos o modificados. Cuando OnToology detecte que un fichero de ontología ha sido añadido o modificado tras un Push al repositorio en GitHub, los procesos configurados en OnToology serán ejecutados.

Al finalizar, OnToology generará una Pull request al repositorio en cuestión para incorporar los recursos generados. Esto es debido a que OnToology hace un fork del repositorio sobre el que se trabaja para generar los nuevos recursos. Al acceder a la información del pull request en tu repositorio de GitHub (esta pull request no aparece en el interfaz de OnToology) encontrarás un "OnToology Update" a la que podrás acceder para ver el detalle como en la siguiente secuencia de imágenes.

Lista de pull request de tu reposortio (vista en GitHub):

Detalle de la pull request:

Finalmente, si deseas incorporar los recursos generados por OnToology a tu repositorio, necesitas confirmar la acción para lo cual debes dar click en el botón Confirm merge.

Tras estos pasos tendrás en tu repositorio una carpeta llamada "OnToology" en la que se depositan todos los archivos generados por la herramienta.

La siguiente imagen muestra la estructura de carpetas creada por OnToology.

Administración del entorno de trabajo

Una vez que se ha enlazado el repositorio con OnToology puedes expandirlo al hacer click en el ícono de la izquierda

A continuación podrás ver las ontologías que tengas en tu repositorio y varios íconos que te permitirán realizar diferentes acciones

Las acciones que puedes realizar con cada ícono son las siguientes:

Ícono Acción
Ir a tu repositorio en Github
Obtener la configuración de tus ontologías en este repositorio
Generar la documentación, diagramas y evaluación de tus ontologías
Reanudar la previsualiación
Publicar la ontología
Descargar un paquete con la documentación, diagramas, evaluación y el .htaccess

La acción del botón "Update Configuration" permite actualizar en el repositorio de Github los cambios que se realizan en el entorno de OnToology, esto ocasiona que se genere una "Pull Request" que tendremos que administrar de la misma forma que se indicó previamente en la sección de Primeros Pasos.

Finalmente el botón "Stop Watching" permite ocultar el repositorio de tal forma que no aparecerá en OnToology, cabe destacar que esta acción no cambia la configuraciones que se realizaron previamente, y que cuando se desee volver a visualizarlo bastará con colocar los datos de nuestra cuenta y el repositorio (miusario/mirepositorio) y dar click en el botón "Whatch this Repo".