¿Buenas formas de acceder a la documentación?

7

Emacs tiene auto-documentación como uno de sus objetivos, y lo logra bastante bien para Emacs Lisp con comandos como describe-variable, describe-function, etc. paquetes como empresa-Ayuda rápida de hacer esto aún más conveniente, proporcionando ayuda en la información de herramientas, lo que reduce la necesidad de constante conmutador atención a un búfer de ayuda.

El lector de información incorporado también es muy conveniente para navegar por los manuales de información. Helmmejora esto al proporcionar helm-info , que permite elegir entre todos los archivos de información instalados y buscar en el índice de un archivo a través de la finalización incremental.

Considero que las herramientas anteriores son importantes porque, al facilitar la búsqueda de documentación, me alientan a hacer más.

Sin embargo, es difícil replicar la facilidad con la que puedo buscar documentación sobre Emacs, Emacs Lisp, etc. con otras herramientas e idiomas. Por ejemplo, si olvido lo que hace una regla CSS, todavía me encuentro buscando respuestas en Google, lo cual es lento y desvía la atención de Emacs.

Entonces, ¿cuáles son algunas buenas formas (tanto generales como específicas de herramientas / lenguajes particulares) para buscar documentación o consultar manuales en Emacs?

Common Lisp, por ejemplo, tiene SLIME , que intenta hacer para Common Lisp lo que Emacs hace para Emacs Lisp, aunque no llega tan lejos porque se hacen muchas referencias a Common Lisp HyperSpec .

documentation Tianxiang Xiong
fuente
44
He oído que github.com/areina/helm-dash es una buena opción. (Estoy escribiendo esto como un comentario y no como una respuesta porque no tengo ninguna experiencia con él.)
Constantine
¡Oh eso es interesante! Tenía la impresión de que Dash era solo para Mac, pero parece que los propios documentos están disponibles en cualquier plataforma.
Tianxiang Xiong
1
Esto dependería de un lenguaje (de programación) con el que trabaje ... Para algunos idiomas, la documentación se puede navegar usando sus propias herramientas, posiblemente integradas en Emacs. Para otros, puede ver la documentación a través del navegador web de Emacs (pero dado que no es compatible con JavaScript, eso no siempre funciona). Puedes hacer SLIME, por ejemplo. para buscar HyperSpec localmente (si tiene una copia local). Con CSS, puede usar eww o w3m para acceder en línea, por ejemplo. w3.org/TR/selectors4 con occurusted incluso podría hacer una tabla de contenido interactiva ad hoc.
wvxvw
1
Pregunta interesante en general, pero probablemente demasiado amplia en ausencia de un método unificado. ¿Podría por favor hacer la pregunta más específica (por ejemplo, ¿qué idioma en particular?)?
Dan
1
Si una herramienta proporciona un manual de información, úselo. Si no, busque información en la web. (Y sí, está bien dejar Emacs. ;-))
Dibujó

Respuestas:

1

La información es excelente, si está disponible para una herramienta o idioma en particular. Los carámbanos pueden ayudar a navegar y buscar libros de información (conjuntos de documentos).

  • La finalización es más flexible (expresiones regulares, difusas, progresivas / incrementales: patrones combinados).
  • Cree libros virtuales a partir de cualquier conjunto de nodos de información a partir de cualquier manual.
  • Visite los nodos que coincidan con un patrón de entrada en cualquier orden, de forma selectiva.
  • Ordenar coincidencias de *Completions*varias maneras (orden de libros, alfabético, etc.).
  • Limite las coincidencias de su patrón de entrada a los nodos que siguen al nodo actual (es decir, en el resto del manual actual).
  • g puede coincidir con el nombre del nodo o el contenido del nodo, o ambos, para que pueda buscar un conjunto de nodos (o un manual) y elegir de la lista de nodos coincidentes.

Más información...

Dibujó
fuente