Esta obra está sujeta a la licencia Creative Commons Atribución 4.0 Internacional, excepto donde se indique lo contrario.
Todas las gemas requeridas para generar la documentación se indican en Gemfile.
Algunas de estas gemas son nativas o dependen de librerías o programas externos que deben instalarse previamente.
En distribuciones derivadas de Debian GNU/Linux y Ubuntu se pueden instalar así:
sudo apt install ruby-bundler ruby-dev libxml2-dev libxslt-dev pkg-config
# asciidoctor-mathematical
sudo apt install bison flex libffi-dev libxml2-dev libgdk-pixbuf-2.0-dev libcairo2-dev libpango1.0-dev libwebp-dev libzstd-dev fonts-lyx cmake
Después las gemas se pueden instalar fácilmente con Bundle:
bundle config set --local path vendor/bundle
bundle config set --local build.nokogiri --use-system-libraries
bundle config set --local without epub3
bundle install
Para automatizar la generación de la documentación se utiliza Rake. Para listar las tareas del proyecto basta con ejecutar:
bundle exec rake -T
Luego se puede ejecutar cualquier tarea con:
bundle exec rake <tarea>
En caso de tener problemas porque mathematical.so no encuentra liblasem.so, puede deberse a haber instalado los paquetes con bundle install de forma global, para todo el sistema.
Esto no debería ocurrir con los pasos indicados anteriormente porque son para una instalación local al proyecto.
Si Bundle no puede escribir en el directorio donde se instalan las gemas, lo hace en un directorio temporal, donde también compila las extensiones, y después pide permiso para ejecutar sudo y copiar los archivos a su ubicación definitiva.
En ese caso, la ruta donde mathematical.so espera encontrar liblasem.so —indicada en RUNPATH en mathematical.so— puede que ya no sirva.
La solución más sencilla es desinstalar y volver a instalar nuevamente mathematical usando Gem:
sudo gem uninstall mathematical
sudo gem install mathematical
Ink Free es la fuente usada en los diagramas de estilo informal que imitan estar dibujados a mano. Viene incluida con Windows 10 y Office, pero también se puede descargar en distintos formatos desde sitios como onlinewebfonts.com.
Para usarla con diagrams.net para crear los diagramas primero debe añadirse como Web Fonts con nombre "Ink Free" y URL https://ull-esit-sistemas-operativos.github.io/ssoo-apuntes/fonts/InkFree.woff.
Para que los diagramas se vean correctamente en sistemas que no incluyen la fuente "Ink Free" por defecto —como ocurre en Linux— en las opciones de exportación a SVG se debe indicar Text Settings > Convert labels to SVG. Esto también evita que los SVG incrustados en el PDF muestren el mensaje Viewer does not support full SVG 1.1.
El código de los ejemplos está disponible en ull-esit-sistemas-operativos/ssoo-ejemplos.
Para ayudar a mantener un estilo consistente a lo largo del tiempo en los diferentes artículos y secciones, se han establecido unas reglas sobre los estilos a aplicar en distintos casos:
- _Aplicación_.
- *Elemento de la GUI*: *Etiqueta*, *Menú*, *Submenú*, *Botón*, *Icono*, *Ventana* o *Interfaz*.
`nombre_de_archivo`,`ruta`,`VARIABLE_DE_ENTORNO`,`comando`o`--argumento`.- Entrada de teclado:
kbd:[Tecla1+Tecla2+...].
Estas reglas están basadas en la guía de GNOME para escribir documentación de software. Respecto a las referencias bibliográficas se sigue la norma APA, si bien las citas se hacen de forma numérica, ya que Asciidoctor no facilita otra forma sin utilizar extensiones adicionales.