Trabajando con Docsets
Los Docsets son colecciones de archivos de documentación. Para que puedas visualizar su contenido en SimpleDocs primero debes descargarlos y, una vez instalados, los Docsets estarán disponibles sin conexión a internet.
Contenido
Visión general del entorno de trabajo
La ventana principal de SimpleDocs se compone de los siguientes elementos:
- Barra de menús
- Cuadro de búsqueda
- Explorador de Docsets
- Área de navegación
- Botones de acción (Docset Manager/Regresar)
- Botón de listado de índices
- Botones de navegación
- Botón de búsqueda en línea
- Barra de estado
Administrador de Docsets
El Administrador de Docsets (Docset Manager) es una herramienta que te permite descargar, actualizar y eliminar los Docsets usados por SimpleDocs:
Para abrir el Administrador de Docsets haz clic en el botón (
) Docset Manager.
En caso de que estés navegando por un Docset, primero haz clic en (
) Docset List.
En la interfaz del Administrador de Docsets hay dos pestañas: en la pestaña Installed se muestran los Docsets instalados, mientras que en la pestaña Available se listan los Docsets disponibles para su descarga e instalación en el equipo.
Instalar un Docset
En la pestaña Available, ubica el (o los) Docset(s) que deseas instalar y haz clic en Download:
Para cancelar una descarga, haz clic en Cancel. Para reintentar una descarga fallida, haz clic en Retry.
Para cancelar todas las descargas en curso o reintentar todas las descargas fallidas haz clic en Cancel all y Retry all, respectivamente.
Actualizar un Docset
En la pestaña Installed, ubica el Docset que desees actualizar (y que esté disponible para actualizar) y haz clic en Update:
Para cancelar la actualización de un Docset, haz clic en Cancel. Para reintentar una actualización fallida, haz clic en Retry.
Para cancelar todas las actualizaciones en curso o reintentar todas las actualizaciones fallidas haz clic en Cancel all y Retry all, respectivamente.
Por último, para actualizar todos los Docsets haz clic en Update all:
Eliminar un Docset
En la pestaña Installed, ubica el Docset que desees eliminar y haz clic en Delete:
Búsqueda de Docsets
Tanto en la pestaña Installed como en Available hay un cuadro de búsqueda donde puedes ingresar el nombre o parte del nombre de un Docset para listar todas las coincidencias:
Además, puedes aplicar una serie de filtros rápidos al escribir cualquiera de los siguientes textos en el cuadro de búsqueda:
- :downloading
- :updating
- :failed
- :retrying
- :installing
- :update
O bien, haciendo clic en cualquiera de los links en la parte inferior del Administrador de Docsets:
Por ejemplo, para listar únicamente los Docsets en descarga, basta con escribir :downloading en el cuadro de búsqueda:
Explorar Docsets
Una vez que hayas instalado algunos Docsets, puedes empezar a navegar por su contenido:
Al seleccionar un Docset de la lista de Docsets se desplegará su contenido, agrupado en las distintas categorías de los ítems que contiene:
Para navegar a un ítem, expande la categoría en el árbol y selecciónalo:
Los botones de navegación, como su nombre lo indica, te permiten navegar en el Docset actual:
- Para navegar a la página anterior, haz clic en el botón ().
- Para navegar a la página siguiente, haz clic en el botón (
). - Para navegar a la página de inicio haz clic en el botón (
).
Navegación de índices
En algunos Docsets está disponible la navegación de índices. Para mostrar el índice del documento actual haz clic en el botón (
):
Para ir al título o sección deseada del índice haz clic en el elemento de la lista correspondiente:
Buscar en Docsets
Para buscar contenido dentro un Docset escribe el término a buscar dentro del cuadro de búsqueda y presiona ENTER:
Los resultados se listarán en el Explorador de Docsets, organizados por Docset, en la pestaña Search.
Búsqueda en línea
Para buscar texto dentro del área de de navegación haz clic en el botón (
) ubicado en la esquina inferior derecha:
A continuación escribe el término de búsqueda y presiona ENTER:
Búsqueda extendida
Una funcionalidad interesante de SimpleDocs es la búsqueda extendida: puedes limitar la búsqueda a un Docset o a un tipo de elemento mediante una sintaxis especial:
- Para buscar en un Docset escribe "@" + [ID del Docset] + ":" seguido del término de búsqueda. Por ejemplo, para buscar "strpos" en el Docset PHP escribe
@php:strpos - Para buscar por tipo de elemento escribe "#" + [ID del Tipo] + ":" seguido del término de búsqueda. Por ejemplo, para buscar únicamente las funciones que se llamen "strpos" escribe
#function:strpos - Para buscar en un Docset por un tipo de elemento escribe "@" + [ID del Docset] + ":" + "#" + [ID del Tipo] + ":" seguido del término de búsqueda. Por ejemplo, para buscar las funciones que comiencen por (o contengan) "str" dentro del Docset PHP escribe
@php:#function:str
Estos son los IDs de los tipos de elementos que pueden contener un Docset:
|
|
|
