Texinfo

Kokeneet kirjoittajat eivät ole vielä tarkistaneet sivun nykyistä versiota, ja se voi poiketa merkittävästi 31. lokakuuta 2016 tarkistetusta versiosta . tarkastukset vaativat 3 muokkausta .
texinfo
Tyyppi Dokumentointijärjestelmä
Kehittäjä Richard Stallman
Sisään kirjoitettu Xi
Käyttöjärjestelmä GNU
Ensimmäinen painos Helmikuu 1986
uusin versio
Luettavat tiedostomuodot Texinfo lähde [d]
Lisenssi GPLv3
Verkkosivusto gnu.org/software/texinfo
 Mediatiedostot Wikimedia Commonsissa

Texinfo ( Venäjän Tekinfo [2] ) on ilmainen dokumentaatiojärjestelmä ja merkintäkieli, jonka avulla voit luoda eri muotoisia asiakirjoja yhdestä lähdetekstistä. Texinfo on osa GNU - projektia .

Järjestelmän kuvaus

Texinfo-asiakirjojen lähdetiedostot ovat pelkkää tekstiä , jotka on merkitty erityisillä merkillä alkavilla komennoilla @(esimerkiksi @contentstai @titlepage). .texiTexinfo-tiedostoissa on yleensä .txi.

Texinfoon sisältyvien apuohjelmien makeinfoavulla dokumentaatio luodaan lähdetiedostoista seuraavissa muodoissa: texi2dvitexi2pdf

Texinfo käyttää TeX :ää tulostettavien tiedostomuotojen luomiseen muuntamalla @Texinfo -komennot TeX-ohjausrakenteiksi.

Texinfo kieli

Texinfo-merkintäkieli sisältää komentoja loogiseen jäsentelyyn ja tekstin valintaan, sisällysluetteloiden, linkkien, hakemiston luomiseen ja taulukoiden lisäämiseen. Koska Texinfo mahdollistaa dokumenttien saamisen eri muodoissa, on olemassa komentoja, jotka sisältävät tekstin ehdollisesti jokaiselle tulostemuodolle.

Asiakirjaesimerkki

Tässä on pieni asiakirja, joka on merkitty Texinfolla.

\input texinfo @setfilename testi.info @documentencoding UTF-8 @settitle Foo Compiler @kopioidaan Copyright © 2007 Hacker Publishing @lopeta kopiointi @nimilehti @title Foo Compiler @subtitle "Uusi sana kääntäjien kehityksessä" @kirjoittaja J. Random Hacker @vskip 0pt plus 1fill @insertcopying @loppu otsikkosivu @otsikot pois päältä @sisällys @ifnotex @nodeTop @top Foo Compiler @insertcopying @endifnotex @valikko *Esittely:: *Toinen luku:: @loppuvalikko @node Johdanto @luku kuinka kaikki alkoi @cindex esittely Tämä on johdantokappale. @node Toinen luku @luku Toinen luku Tämä on Texinfo-esimerkkiasiakirja. @node Concept Index @numeroimaton käsiteindeksi @printindex cp @Hei hei

Man-sivut ja Texinfo

Texinfoa kehutaan järjestelmänä suurten, laajennettujen käsikirjojen (kuten kirjastojen dokumentointi) luomiseen, kun taas perinteinen man - sivujen käyttö on kompakteja viiteasiakirjoja. Texinfo-käsikirjassa todetaan, että man -muoto ei ole verrattavissa tärkeimpiin Texinfo-lähteisiin [3] luettavuuden suhteen. Texinfo- jakelu ei siis sisällä apuohjelmia man-sivujen luomiseen Texinfo-tiedostoista. Man - sivujen automaattiseen luomiseen suositellaan help2man [4] -apuohjelmaa .

Texinfoa käyttävät projektit

Texinfoa käytetään laajalti GNU - ohjelmien dokumentointiin . Näitä ovat GCC ja GDB , GNU libc , GNU Emacs (mukaan lukien Gnus ), Bash , GNU Octave , Autotools , Guile , GRUB .

Katso myös

Linkit

Muistiinpanot

  1. Smith G. Texinfo 6.8 julkaistu  - 2021 .
  2. ""Texinfon" ensimmäinen tavu lausutaan "speck", ei "hex"" - Texinfon käsikirjasta
  3. "...hyvän man-sivun luominen vaatii täysin eri lähteen kuin tyypilliset Texinfo-sovellukset..." - Texinfo-oppaasta
  4. help2man kotisivu . Haettu 19. elokuuta 2007. Arkistoitu alkuperäisestä 21. elokuuta 2007.