Texinfo

Az oldal jelenlegi verzióját még nem ellenőrizték tapasztalt hozzászólók, és jelentősen eltérhet a 2016. október 31-én felülvizsgált verziótól ; az ellenőrzések 3 szerkesztést igényelnek .
texinfo
Típusú Dokumentációs rendszer
Fejlesztő Richard Stallman
Beírva Xi
Operációs rendszer GNÚ
Első kiadás 1986. február
legújabb verzió
Olvasható fájlformátumok Texinfo forrás [d]
Engedély GPLv3
Weboldal gnu.org/software/texinfo
 Médiafájlok a Wikimedia Commons oldalon

A Texinfo ( orosz Tekinfo [2] ) egy ingyenes dokumentációs rendszer és jelölőnyelv, amely lehetővé teszi, hogy egyetlen forrásszövegből különböző formátumú dokumentumokat hozzon létre. A Texinfo a GNU projekt része .

A rendszer leírása

A Texinfo dokumentumok forrásfájljai egyszerű szövegesek , speciális, jellel kezdődő parancsokkal @(például @contentsvagy @titlepage) jelölve. A Texinfo fájloknak általában van .texiegy .txi.

A Texinfoban található segédprogramok segítségével a makeinfodokumentáció texi2dvia texi2pdfkövetkező formátumokban jön létre a forrásfájlokból:

A Texinfo a TeX -et használja nyomtatható fájlformátumok létrehozására a @Texinfo -parancsok TeX vezérlőstruktúrákká konvertálásával.

Texinfo nyelv

A Texinfo jelölőnyelv parancsokat tartalmaz a logikai strukturáláshoz és a szövegkiválasztáshoz, tartalomjegyzékek, hivatkozások, index létrehozásához és táblázatok beszúrásához. Mivel a Texinfo lehetővé teszi, hogy különböző formátumokban szerezze be a dokumentációt, vannak olyan parancsok, amelyek feltételesen tartalmazzák a szöveget minden kimeneti formátumhoz.

Dokumentumpélda

Itt van egy kis dokumentum Texinfo-val megjelölve.

\input texinfo @setfilename teszt.info @documentencoding UTF-8 @settitle Foo Compiler @másolás Copyright © 2007 Hacker Publishing @vége másolás @Címlap @title Foo fordító @subtitle "Új szó a fordítóprogram fejlesztésében" @szerző J. Random Hacker @vskip 0pt plusz 1fill @insertcopying @end címlap @headings off @tartalom @ifnotex @nodeTop @top Foo fordító @insertcopying @endifnottex @menü *Bevezetés:: *Második fejezet:: @end menü @node Bevezetés @fejezet hogyan kezdődött az egész @cindex bevezető Ez egy bevezető fejezet. @node Második fejezet @fejezet Második fejezet Ez a Texinfo mintadokumentum. @node Concept Index @számozatlan Fogalmi Index @printindex cp @Viszlát

Man oldalak és Texinfo

A Texinfo -t nagyméretű, kiterjesztett kézikönyvek (például könyvtárak dokumentálása) készítésére szolgáló rendszerként tartják számon, míg a kézikönyvoldalak hagyományos használata kompakt referenciadokumentumok. A Texinfo kézikönyv kimondja, hogy a man formátum az olvashatóság szempontjából nem hasonlítható össze a főbb Texinfo forrásokkal [3] . A Texinfo disztribúció ezért nem tartalmaz segédprogramokat a Man oldalak Texinfo fájlokból történő előállításához. A kézikönyvoldalak automatikus generálásához a help2man [4] segédprogram használata javasolt .

Projektek Texinfo segítségével

A Texinfo-t széles körben használják GNU programok dokumentálására . Ezek közé tartozik a GCC és a GDB , a GNU libc , a GNU Emacs (beleértve a Gnust is ), a Bash , a GNU Octave , az Autotools , a Guile , a GRUB .

Lásd még

Linkek

Jegyzetek

  1. Smith G. Texinfo 6.8 kiadása  – 2021 .
  2. "A "Texinfo" első szótagját "speck"-ként ejtik, nem "hex" - a Texinfo kézikönyvből
  3. "...egy jó man oldal létrehozásához teljesen más forrásra van szükség, mint a tipikus Texinfo alkalmazásokhoz..." - a Texinfo kézikönyvből
  4. help2man honlapja . Letöltve: 2007. augusztus 19. Az eredetiből archiválva : 2007. augusztus 21..