Manual de uso del sitio

Como utilizar el software bookstack, que potencia este sitio.

Introducción

Introducción

El software de este sitio

Este sitio está construido utilizando un software de código abierto llamado bookstack. Existe un manual del usuario en inglés que puede ser accedido aquí. El presente manual, es una traducción libre y parcial del mismo, con agregados y supresiones.

Introducción

Registrarse para crear contenido

Si quiere editar o crear contenido en este sitio (Estantes, libros, capítulos, páginas) debe estar registrado primero.

Actualmente el registro público no está permitido, por lo que solo podrá editar contenido si se le ha asignado un usuario.

Si no está registrado, y el ingreso público está permitido, ingrese en la opción Registrarse de la cabecera y complete los datos que se le solicitan:

Nombre: Ingrese su nombre y apellido

Correo electrónico: Un correo electrónico válido

Contraseña: Una clave de al menos 8 caracteres.

El sistema le enviará entonces un correo con un link, al que deberá acceder para completar el registro. Si no encuentra el correo en su bandeja de entrada, revise su carpeta de spam.

Introducción

Generalidades

Los principios para almacenar y organizar información dentro del sitio, está basado en la idea de estantes de libros. De la misma manera que en los libros físicos, los libros aquí, pueden contener capítulos y páginas. Para comenzar, hay que crear un libro, que funciona como el nivel más alto de categorización. Idealmente, Ud. tendrá diferentes libros, para diferentes temas.

Dentro de un libro, Ud. puede crear directamente páginas o primero, crear capítulos. Los capítulos proveen un nivel adicional de agrupamiento de páginas, pero son opcionales. Toda la información que Ud. escribe es contenida dentro de páginas. Aunque los libros y capítulos no contienen información, se les puede asignar un pequeña descripción, para ayudar en la búsqueda y visibilidad.

Cuando ya tenga una buena cantidad de libros, puede comenzar a utilizar estantes para organizarlos. Los estantes contienen múltiples libros, y un libro, puede ser colocado en múltiples estantes.

Convención de Colores

Los estantes, libros, capítulos y páginas tienen un codificación de color por defecto, a fin de que sean fácilmente identificables. En este sitio se utilizan los siguientes colores:

Libros     Capítulos      Páginas     Borradores de página     Estantes

Comenzando a crear contenido

Cuando Ud. comienza, puede organizar las cosas de dos maneras: Puede planificar los libros y su estructura, con sus capítulos y páginas, o dejar que las cosas vayan creciendo naturalmente a través del tiempo. Si tiene claro lo que que quiere poner y en que lugar, lo mejor es planificarlo de entrada, si no es así, lo mejor es iniciar y dejar que la estructura se vaya decantando a medida que se avanza.

Si se inclina por lo último, probablemente Ud. comenzará con un libro por cada categoría y agregará páginas directamente en esos libros. A medida que vaya teniendo muchas páginas en cada libro, va a empezar a utilizar capítulos para agrupar esas páginas. Cuando un capítulo se hace muy muy grande, por ahí encuentra mejor transformarlo en un nuevo libro. Con este software, Ud. puede fácilmente mover capítulos y páginas entre libros y capítulos, por lo que no tendría que preocuparse por tener que mover un poco las cosas en el futuro.

Introducción

Organizando contenido

Una vez que su sitio comience a crecer, puede necesitar re-organizar el contenido. Para mover el contenido de lugar, hay dos opciones: O mueve las páginas y capítulos individualmente, o puede ordenar libros completos.

Tenga en cuenta que para mover contenido, Ud. tiene que tener permiso de "edición", tanto para el contenido que mueve, como para el contenido a donde lo va a mover.

Moviendo páginas y capítulos

Las páginas y capítulos pueden moverse directamente a un nuevo capítulo o libro. Para mover un capítulo o página de esta manera, vaya a la página o capítulo y seleccione "Mover" en la lista de acciones.

Al hacer clic en "Mover", el sistema lo llevará a una pantalla, donde podrá seleccionar una nueva ubicación para el capítulo o página. Aquí puede buscar un libro o capítulo en particular, utilizando la barra de búsqueda que se encuentra arriba en la pantalla de selección. Una vez que selecciona el nuevo padre para su capítulo o página, , haga clic en el botón "Mover Página" o "Mover Capítulo". Si mueve un capítulo, todas sus páginas hijas permanecerán en él, y toda la actividad relacionada, aparecerá bajo el nuevo libro padre.

Ordenando libros

La interfase de ordenar libros, le permite mover múltiples páginas y capítulos con facilidad, arrastrando y soltando. Para ordenar el contenido de un libro, abra el libro y busque la opción "Ordenar" entre la lista de acciones.

Inicialmente, solo el libro que Ud. estaba viendo aparecerá a la izquierda. Puede agrega otros libros a la interfase de ordenar, seleccionando de la derecha. Aquí Ud. puede simplemente arrastrar y soltar capítulos y páginas dentro de un libro, o colocarlos en otros. Una vez que tenga organizado el contenido, presione "Guardar" y todos los cambios serán realizados en en los libros.

Libros y estantes

Un estante puede contener muchos libros, y un libro puede estar en muchos estantes. Para agregar un libro a un estante, abra primero el estantey seleccione "Editar". Bajo la sección  "Agregar libros a este estante", puede buscar y seleccionar libros para agregar al mismo. Luego presiones "Guardar estante". Dentro de la misma interfase, puede arrastrar libros de una a otra lista, y también reordenar los libros dentro del estante.

Recuerde que un libro puede estar en muchos estantes, por lo que agregar un libro a un nuevo estante, no lo quita de otros. Si quiere eliminar un libro de un estante, tiene que ir al estante y arrastrarlo de la lista "Libros en este estante" y luego "Guardar" el estante.

Funciones comunes

Funciones comunes

Buscando contenido

La posibilidad de buscar en su documentación, es vital para el uso diario. Hay varios lugares dentro del software, donde se puede buscar contenido. Debajo hay un listado de las funciones de búsqueda:

Sintaxis de búsqueda avanzada

Todos los lugares de búsqueda de arriba comparten la posibilidad de utilizar sintaxis avanzada de búsqueda. Una forma fácil de ver esto en acción, es utilizar la búsqueda global, y luego experimentar con filtros de búsqueda. Debajo hay detalles de los distintos tipos de sintaxis que se pueden utilizar:

Tipo
 Sintaxis
 Ejemplos
 Descripción
Normal
 <term_a> <term_b>
 reunion rosario
 Busca en los nombres, descripción o cuerpo del contenido. Cuando se ingresan varios términos, con que el contenido tenga uno, ya alcanza para que lo muestre, aunque los que tengan los dos, estarán más arriba en los resultados.
Exacta
 "<term>"
 "reunion rosario"
 Requiere que la frase entre comillas se encuentre exactamente igual en el contenido, para mostrarlo en los resultados.
Etiquetas

[<nombre>]

[<operador><valor>]

[<nombre><operador><valor>]

[ubicacion]

[=rosario]

[ubicacion=rosario]

[asistentes>5]

Permiten encontrar páginas que tengan una etiqueta específica aplicada. Puede buscar por nombre de la etiqueta, por valor de la etiqueta o por ambos. Cuando se busca por un valor de una etiqueta, debe usarse un operador para definir el tipo de coincidencia. Pueden usarse  =, !=, <, >,<=, >= ,likecomo operadores. Cuando usa like puede utilizar el  símbolo % para representar un comodín en la búsqueda.
Filtros

{<nombre_filtro>}

{<nombre_filtro><valor_filtro>}

 Ver abajo
 Permiten agregar funcionalidad adicional en las búsquedas. Algunos filtros requieren valores, pero otros no. Ver abajo la lista de filtros disponible.

Filtros disponibles

Ver documentación original

Ejemplos de búsquedas

Debajo hay algunos ejemplos de uso de la sintaxis y filtros con su descripción

Funciones comunes

Editando páginas

El editor por defecto de las páginas, es del tipo "lo que ve, es lo que resulta". Es similar a un procesador de palabras típico como Word o Google Docs.

Atajos de teclado

Los siguientes son los atajos de teclado disponibles en el editor:

Atajos (Windows & Linux/Mac) Descripción
Ctrl+S / Cmd+S Guardar borrador
Ctrl+Enter / Cmd+Enter Guardar página y continuar
Ctrl+B / Cmd+B Negrita
Ctrl+I / Cmd+I Cursiva
Ctrl+U / Cmd+U Subrayado
Ctrl+1 / Cmd+1
Ctrl+2 / Cmd+2
Ctrl+3 / Cmd+3
Ctrl+4 / Cmd+4

Título grande
Título mediano
Título pequeño

Título muy pequeño
Ctrl+5 / Cmd+5
Ctrl+D / Cmd+D		 Párrafo normal
Ctrl+6 / Cmd+6
Ctrl+Q / Cmd+Q		 cita
Ctrl+7 / Cmd+7
Ctrl+E / Cmd+E		 Bloque de código
Ctrl+8 / Cmd+8
Ctrl+Shift+E / Cmd+Shift+E		 Código en linea
Ctrl+9 / Cmd+9 Llamado de atención
(Continúe presionando para los distintos estilos)
Ctrl+O / Cmd+O
Ctrl+P / Cmd+P		 Lista numerada
Lista de items
Ctrl+Shift+K / Cmd+Shift+K Enlazar a contenido del sitio

Temas avanzados

Temas avanzados

URL o enlace permanente de una página en bookstack

Puede suceder que la URL o enlace a una página en Bookstack, que normalmente se conforma a partir del  nombre del libro y el título de la página, deje de existir (por ejemplo por cambios en los nombres). Bookstack basándose en que guarda la historia de las páginas, puede llegar a detectar, a que página actual se refiere el antiguo enlace o URL. Sin embargo, este método no es infalible.

Una forma de evitar este problema, es utilizar la nomenclatura interna que usa Bookstack para identificar las páginas.

Esta numeración interna la podemos obtener mediante el siguiente procedimiento:

  1. Dentro de la página de la que queremos obtener su URL permanente, seleccionamos cualquier porción de texto.
  2. Automáticamente aparecerá una pequeña ventana, con un enlace o link y dos botones..
  3. Hacemos click en el boton de copiar la URL o enlace.
  4. Disponemos entonces en el portapapeles, el enlace o URL a esa sección de texto.
  5. Si pegamos el contenido del portapapeles en algún lado, veremos que contiene la URL del sitio, una barra (/), la palabra "link", otra barra (/),  y un número seguido de numeral (#) y cierto texto.
  6. El link permanente que buscamos, es todo lo que hay hasta antes del numeral.

Ejemplo:

si obtenemos

https://www.ejemplo.com/link/765#bkmrk-la-funcion-a-aplicar

https://www.ejemplo.com/link/765