Texinfo - Texinfo
 Ein Beispiel für eine gedruckte Texinfo-Ausgabe; Seite 25 des offiziellen GNU Texinfo-Handbuchs.
| |
| Originalautor(en) |
Richard Stallman Bob Chassell |
|---|---|
| Entwickler | Brian Fox Karl Berry |
| Erstveröffentlichung | Februar 1986 |
| Stabile Version | 6.7 (23. September 2019 ) [±] |
| Repository |
|
| Geschrieben in | C , Perl |
| Betriebssystem | GNU |
| Typ | Dokumentation |
| Lizenz | GNU General Public License |
| Webseite | www |
Texinfo ist eine Satzsyntax, die zum Erstellen von Dokumentation sowohl in Online- als auch in gedruckter Form (Erzeugung von Dateitypen wie dvi , html , pdf usw. und einem eigenen Hypertext-Format info ) mit einer einzigen Quelldatei verwendet wird. Es wird durch ein Computerprogramm implementiert , das als freie Software gleichen Namens veröffentlicht wurde und vom GNU-Projekt der Free Software Foundation erstellt und zur Verfügung gestellt wurde .
Der Hauptzweck von Texinfo besteht darin, Software-Handbücher einfach zu setzen. Ähnlich der LaTeX- Syntax stehen alle normalen Funktionen eines Buches, wie Kapitel, Abschnitte, Querverweise, Tabellen und Indizes für die Verwendung in Dokumenten zur Verfügung. Mit den verschiedenen Ausgabegeneratoren, die für Texinfo zur Verfügung stehen, ist es möglich, verschiedene Dokumentationsarten (wie Online-Dokumentation, die über eine Website bereitgestellt wird, und gedruckte Dokumentation, wie sie mit dem TeX- Satzsystem generiert wurde ) aktuell zu halten, mit nur eine einzige Quelldatei.
Die offizielle Texinfo-Dokumentation besagt, dass die erste Silbe von "Texinfo" so ausgesprochen wird, dass sie sich auf "speck" reimt, nicht auf "hex"; diese Aussprache leitet sich von der Aussprache von TeX ab , in der das X den griechischen Buchstaben chi und nicht den englischen Buchstaben x darstellt . Die Betreuer geben an, dass "Texinfo" nur mit einem großen "T" und den Rest der Buchstaben in Kleinbuchstaben geschrieben werden sollte.
Ausgabeformate
Um die gleichzeitige Aktualisierung mehrerer Dokumentationsausgabeformate beim Ändern der ursprünglichen Texinfo (.texi)-Quelldatei zu ermöglichen, stehen mehrere Syntaxkonverter zur Verfügung, mit denen Übersetzungen der Texinfo-Datei in andere Formate generiert werden können. Die meisten davon werden mit dem Programm makeinfo erstellt, das Teil der GNU-Texinfo-Distribution ist.
- HTML
- (Erzeugt über makeinfo --html.) Da HTML die Standardsprache für Dokumente ist, die im World Wide Web präsentiert werden, kann dieses Ausgabeformat effektiv verwendet werden, um Online-Dokumentationsseiten zu erstellen. Das Handbuch stellt fest, dass das Makeinfo- Programm versucht, seine Ausgabedateien auf eine bestimmte Untermenge von HTML-Markup zu beschränken, die von so vielen Browsern wie möglich gelesen werden kann.
- DVI
- (Erzeugt über texi2dvi.) Das geräteunabhängige Dateiformat wird vom TeX- Satzsystem ausgegeben und kann zum Generieren gerätespezifischer Befehle verwendet werden, die angezeigt oder gedruckt werden können; B. die Übersetzung in PostScript ( ps- Dateien).
- (Erzeugt mit texi2dvi --pdfoder texi2pdf.) Basierend auf der PostScript-Sprache wurde dieses Format von Adobe Systems für den Austausch von portablen Dokumenten entwickelt. Wie das PostScript-Format kann es das genaue Aussehen eines Dokuments darstellen und unterstützt beliebige Skalierungen. Es soll plattformunabhängig sein und kann mit einer Vielzahl von Software betrachtet werden. Texinfo verwendet zur Ausgabe von PDF das Programm pdftex , eine Variante von TeX.
- Docbook
- (Erzeugt über makeinfo --docbook.) Dies ist eine XML-basierte Auszeichnungssprache für technische Dokumentation, die in groben Zügen Texinfo ähnelt. Es ist auch möglich , Docbook - Dateien in Texinfo, mit dem konvertieren docbook2x Programm.
- XML
- (Erzeugt über makeinfo --xml.) Für allgemeine Zwecke.
- Die Info
- (Erzeugt über makeinfo.) Dies ist ein spezielles Format, das im Wesentlichen eine reine Textversion der ursprünglichen Texinfo-Syntax in Verbindung mit einigen Steuerzeichen ist, um Knoten zu trennen und Navigationselemente für Menüs, Querverweise, Abschnitte usw. bereitzustellen. Das Info-Format kann mit dem Info- Programm eingesehen werden.
Mann-Ausgabe
Bemerkenswert ist, dass man nicht als Ausgabeformat von den Standard-Texinfo-Tools verfügbar ist. Während Texinfo zum Schreiben der Dokumentation von GNU- Software verwendet wird, die typischerweise in Unix-ähnlichen Umgebungen wie Linux verwendet wird , wo man-Seiten das traditionelle Format für die Dokumentation sind, liegt der Grund dafür darin, dass man-Seiten ein streng konventionelles Format haben traditionell als Kurzanleitungen, während typische Texinfo-Anwendungen sowohl für Tutorials als auch für Referenzhandbücher gedacht sind. Als solches wird kein Vorteil darin gesehen, Texinfo-Inhalte im Manpage-Format auszudrücken. Darüber hinaus verzichten viele GNU-Projekte fast vollständig auf Manpages und verweisen den Leser der bereitgestellten Manpage (die sich selbst oft als selten gepflegt bezeichnet) auf das Info-Dokument.
Texinfo-Quelldatei
Texinfo ermöglicht es, ein Dokument wie ein Buch mit Kapiteln, Abschnitten, Querverweisen und Indizes zu strukturieren. Die Quelle ist fast reiner Text , aber technisch ist es formatierter Text , der durch Befehle gekennzeichnet ist, die mit " @" beginnen . Ein Beispiel für einen Teil einer Quelldatei:
@ifnottex
@node Top
@top Short Sample
@insertcopying
@end ifnottex
@menu
* First Chapter:: The first chapter is the
only chapter in this sample.
* Index:: Complete index.
@end menu
Die Befehle markieren Strukturen wie Kapitel oder bezeichnen einen Teil der Quelle, der nur für bestimmte Ausgabearten verarbeitet werden soll.
Geschichte und Status
Texinfo wird als offizielles Dokumentationssystem für das GNU-Projekt verwendet . Texinfo ist unter der GNU General Public License lizenziert .
Das Texinfo-Format wurde von Richard M. Stallman entwickelt und kombiniert ein anderes System für die Druckausgabe, das am MIT verwendet wird, namens BoTeX, mit dem Online- Dokumentationssystem Info mit Hyperlink, das ebenfalls von Stallman zusätzlich zur TECO- Implementierung von Emacs entwickelt wurde . BoTeX selbst basierte auf einem früheren System namens Bolio (assoziiert mit David A. Moon und verwendet für die Dokumentation der Lisp-Maschine ), das auf TeX für seine Ausgabe konvertiert wurde . Robert Chassell half Stallman, den ersten Übersetzer zu erstellen, der Info in Emacs Lisp erstellt . Die Entwicklung der Texinfo-Softwareverteilung wurde von Brian Fox (bis Version 3.8), Karl Berry (bis Version 5.2) und von Gavin Smith (seit Dez. 2014) geleitet.
Texinfo ist „lose auf Brian Reid ‚s Scribe und andere Formatierungssprachen der Zeit“.