Gute Möglichkeiten, auf Dokumentation zuzugreifen?

7

Emacs hat Selbstdokumentation als eines ihrer Ziele, und es erreicht dies ziemlich gut für Emacs Lisp mit Befehlen wie describe-variable, describe-functionetc. Pakete wie Unternehmen-Schnellhilfe dies machen noch bequemer durch Hilfe bei den Tooltips bieten, was die Notwendigkeit Schalter ständig reduziert Aufmerksamkeit auf einen Hilfepuffer.

Der eingebaute Info-Reader ist auch sehr praktisch zum Durchsuchen von Info-Handbüchern. HelmVerbessert dies durch die Bereitstellung von Steuerinformationen , mit denen Sie aus allen installierten Infodateien auswählen und den Index einer Datei durch schrittweise Vervollständigung durchsuchen können.

Ich finde die oben genannten Tools wichtig, da sie mich durch eine einfachere Suche nach Dokumentationen dazu ermutigen, mehr davon zu tun.

Es ist jedoch schwierig, die Leichtigkeit, mit der ich Dokumentation über Emacs, Emacs Lisp usw. nachschlagen kann, mit anderen Tools und Sprachen zu reproduzieren. Wenn ich zum Beispiel vergesse, was eine CSS-Regel bewirkt, google ich immer noch nach Antworten, was langsam ist und die Aufmerksamkeit von Emacs ablenkt.

Was sind also einige gute Möglichkeiten (sowohl allgemein als auch spezifisch für bestimmte Tools / Sprachen), um die Dokumentation in Emacs nachzuschlagen oder Handbücher zu überprüfen?

Common Lisp verfügt beispielsweise über SLIME , das versucht, für Common Lisp das zu tun, was Emacs für Emacs Lisp tut, obwohl es nicht so weit kommt, da viele Verweise auf Common Lisp HyperSpec gemacht werden .

documentation Tianxiang Xiong
quelle
4
Ich habe gehört, dass github.com/areina/helm-dash eine gute Option ist. (Ich schreibe dies als Kommentar und nicht als Antwort, weil ich keine Erfahrung damit habe.)
Constantine
Oh, das ist interessant! Ich hatte den Eindruck, Dash sei nur für Mac gedacht, aber es sieht so aus, als ob die Docsets selbst auf jeder Plattform verfügbar sind.
Tianxiang Xiong
1
Dies hängt von einer (Programmier-) Sprache ab, mit der Sie arbeiten ... In einigen Sprachen kann die Dokumentation mit eigenen Tools durchsucht werden, die möglicherweise in Emacs integriert sind. Für andere können Sie die Dokumentation über den Webbrowser von Emacs anzeigen (da JavaScript jedoch nicht unterstützt wird, funktioniert dies möglicherweise nicht immer). Sie können SLIME machen, zum Beispiel. um HyperSpec lokal nachzuschlagen (wenn Sie eine lokale Kopie haben). Mit CSS können Sie eww oder w3m verwenden, um online darauf zuzugreifen, z. w3.org/TR/selectors4 mit occurIhnen könnte sogar ein Ad - hoc interaktives Inhaltsverzeichnis machen.
wvxvw
1
Interessante Frage im Allgemeinen, aber wahrscheinlich zu weit gefasst, da es keine einheitliche Methode gibt. Könnten Sie bitte die Frage präzisieren (z. B. welche Sprache im Besonderen?)?
Dan
1
Wenn ein Tool ein Info-Handbuch bereitstellt, verwenden Sie dieses. Wenn nicht, suchen Sie im Web nach Informationen. (Und ja, es ist in Ordnung, Emacs zu verlassen. ;-))
Drew

Antworten:

1

Informationen sind großartig, wenn sie für ein bestimmtes Tool oder eine bestimmte Sprache verfügbar sind. Eiszapfen können beim Durchsuchen und Durchsuchen von Infobüchern (Dokumentensätzen) hilfreich sein.

  • Die Vervollständigung ist flexibler (regulärer Ausdruck, unscharf, progressiv / inkrementell - Muster kombinieren).
  • Erstellen Sie virtuelle Bücher aus einem beliebigen Satz von Info-Knoten aus beliebigen Handbüchern.
  • Besuchen Sie Knoten, die einem Eingabemuster in beliebiger Reihenfolge entsprechen, selektiv.
  • Sortieren Sie Übereinstimmungen auf *Completions*verschiedene Arten (Buchreihenfolge, alphabetisch usw.).
  • Begrenzen Sie Übereinstimmungen Ihres Eingabemusters auf Knoten, die dem aktuellen Knoten folgen (dh im Rest des aktuellen Handbuchs).
  • g kann mit dem Knotennamen oder dem Knoteninhalt oder mit beiden übereinstimmen, sodass Sie eine Reihe von Knoten (oder ein Handbuch) durchsuchen und aus der Liste der übereinstimmenden Knoten auswählen können.

Mehr Informationen...

Drew
quelle