Boas maneiras de acessar a documentação?

7

Emacs tem auto-documentação como um de seus objetivos, e ele consegue isso muito bem para Emacs Lisp com comandos como describe-variable, describe-function, etc. Pacotes como empresa-QuickHelp tornar isso ainda mais conveniente, oferecendo ajuda nas dicas, o que reduz a necessidade de constantemente interruptor atenção a um buffer de ajuda.

O leitor de informações embutido também é muito conveniente para navegar nos manuais de informações. Helmaprimora isso fornecendo informações de leme , que permite escolher entre todos os arquivos de informações instalados e pesquisar o índice de um arquivo por meio de conclusão incremental.

Acho as ferramentas acima importantes porque, facilitando a pesquisa de documentação, elas me incentivam a fazer mais.

No entanto, é difícil replicar a facilidade com que posso consultar a documentação sobre o Emacs, o Emacs Lisp, etc. com outras ferramentas e linguagens. Por exemplo, se eu esquecer o que uma regra CSS faz, ainda me encontro pesquisando no Google por respostas, o que é lento e desvia a atenção do Emacs.

Então, quais são algumas boas maneiras (gerais e específicas de ferramentas / linguagens específicas) para pesquisar a documentação ou verificar os manuais no Emacs?

O Common Lisp, por exemplo, possui o SLIME , que tenta fazer pelo Common Lisp o que o Emacs faz pelo Emacs Lisp, embora não chegue tão longe porque muitas referências são feitas ao Common Lisp HyperSpec .

documentation Tianxiang Xiong
fonte
4
Ouvi dizer que github.com/areina/helm-dash é uma boa opção. (Estou escrevendo isso como um comentário e não uma resposta porque eu não tenho nenhuma experiência com ele.)
Constantine
Oh isso é interessante! Fiquei com a impressão de que o Dash era apenas para Mac, mas parece que os próprios documentos estão disponíveis em qualquer plataforma.
Tianxiang Xiong 06/02
11
Isso depende de um idioma (de programação) com o qual você trabalha ... Para alguns idiomas, a documentação pode ser navegada usando suas próprias ferramentas, possivelmente integradas ao Emacs. Para outros, você pode visualizar a documentação através do navegador da Web do Emacs (mas como ele não suporta JavaScript, isso nem sempre funciona). Você pode fazer SLIME, por exemplo. para procurar o HyperSpec localmente (se você tiver uma cópia local). Com CSS, você pode usar eww ou w3m para acessá-lo on-line, por exemplo. w3.org/TR/selectors4 com occurvocê pode até criar um índice interativo ad hoc.
Wvxvw
11
Pergunta interessante em geral, mas provavelmente muito ampla na ausência de um método unificado. Você poderia tornar a pergunta mais específica (por exemplo, qual idioma em particular?)?
Dan
11
Se uma ferramenta fornecer um manual de informações, use-o. Caso contrário, procure informações na web. (E sim, não há problema em deixar Emacs ;-).)
de Drew

Respostas:

1

As informações são ótimas, se estiverem disponíveis para uma ferramenta ou idioma específico. Os sincelos podem ajudar a navegar e pesquisar livros de informações (conjuntos de documentos).

  • A conclusão é mais flexível (padrões de combinação regular, difusa, progressiva / incremental).
  • Crie livros virtuais a partir de qualquer conjunto de nós Info de qualquer manual.
  • Visite nós que correspondem a um padrão de entrada em qualquer ordem, seletivamente.
  • Classifique as correspondências de *Completions*várias maneiras (ordem dos livros, alfabética etc.).
  • Limite as correspondências do seu padrão de entrada aos nós que seguem o nó atual (ou seja, no restante do manual atual).
  • g pode corresponder ao nome do nó ou ao conteúdo do nó, ou ambos, para que você possa pesquisar um conjunto de nós (ou um manual) e escolher na lista de nós correspondentes.

Mais Informações...

Desenhou
fonte