Texinfo

Wikipediasta
Siirry navigaatioon Siirry hakuun
Texinfo
Esimerkki Texinfon tuottamasta dokumentista; GNU Texinfon manuaalin sivu 25.
Esimerkki Texinfon tuottamasta dokumentista; GNU Texinfon manuaalin sivu 25.
Luoja Richard Stallman
Bob Chassell
Kehittäjä Brian Fox[1]
Karl Berry
Kehityshistoria
Ensijulkaisu helmikuu 1986[2]
Tiedot
Ohjelmistotyyppi ladontajärjestelmä
Alusta Linux
Ohjelmointikielet C, Perl
Lisenssi GNU General Public License
Aiheesta muualla
[1]

Texinfo on merkintäsyntaksi, jonka avulla yhdestä lähdekoodista voidaan luoda dokumentointia sekä verkkosivuille että tulostettavaan muotoon eri tiedostomuodoissa, kuten dvi, html, pdf, jne., sekä texinfon oma hypertekstimuoto, info). Texinfon kääntää tietokoneohjelma, joka on julkaistu saman nimisenä vapaana ohjelmistona, jonka on tuottanut GNU-projekti, joka on osa Free Software Foundation -yhdistystä.[3]

Texinfon päätarkoitus on helpottaa ohjelmisto-oppaiden kirjoittamista. Kuten LaTeX-syntaksissa, kaikki kirjan normaalit rakenteet, kuten luvut, aliluvut, viittaukset, taulukot ja indeksit on mahdollista toteuttaa. Käyttämällä Texinfon eri kääntäjiä, on mahdollista päivittää useita dokumentointeja (kuten verkkosivu ja tulostettava manuaali, joka on tehty TeX ladontajärjestelmällä) käyttäen ainoastaan yhtä lähdekoodia.

Texinfo tulisi lausua "tehinfo" - tämä lausuntatapa periytyy ladontajärjestelmän TeX lausuntatavasta, missä X esittää kreikan kirjainta χ (khi) eikä latinalaisten aakkosten kirjainta x. Kehittäjien mukaan "Texinfo" tulisi kirjoittaa isolla alkukirjaimella "T", mutta muuten pienillä kirjaimilla.

Tiedostotyypit[muokkaa | muokkaa wikitekstiä]

Jotta useita tiedostotyyppejä voidaan päivittää samanaikaisesti, editoimalla Texinfon (.texi) lähdekoodia, on tehty useita syntaksikääntäjiä, jotka voivat kääntää Texinfo-tiedoston muihin tiedostotyyppeihin. Useimmat tiedostot luodaan käyttämällä makeinfo-ohjelmaa, joka on osa GNU Texinfo -jakelua.

HTML
(luodaan komennolla makeinfo --html.) Koska HTML on standardi verkkosivujen merkintätapa, tätä tiedostotyyppiä voidaan käyttää verkkosivumuotoisen dokumentaation tekemiseen. Texinfon manuaalin mukaan makeinfo-ohjelma yrittää rajoittaa tuotettavaa tiedostoa tiettyyn HTML-merkintätavan osajoukkoon, jotta mahdollisimman monet selaimet voivat lukea valmista dokumenttia.
DVI
(luodaan komennolla texi2dvi.) dvi on TeX ladontajärjestelmän tuottama tiedostotyyppi, jolle voidaan tehdä laitteistoriippuvaisia tehtäviä (kuten tulostaa) tai kääntää PostScript (ps-tiedostoksi).
PDF
(luodaan komennolla texi2dvi --pdf tai texi2pdf.) PDF-tiedostotyyppi perustuu PostScript-kieleen. Adobe Systems kehitti tiedostomuodon laitteistoriippumattomien

tiedostojen muodoksi. Kuten PostScript-tiedosto, PDF-tiedosto voi esittää dokumentin lopullista ulkoasua ja on rajatta skaalattavissa. PDF-tiedostot on tarkoitettu laitteistoriippumattomiksi ja niitä voidaan katsella useilla ohjelmistoilla. Texinfo käyttää pdftex-ohjelmaa, TeX-varianttia, tuottaakseen PDF-tiedoston.

Docbook
(luodaan komennolla makeinfo --docbook.) Tämä on XML-kieleen perustuva merkintätapa tekniselle dokumentaatiolle, joka muistuttaa pääpiirteiltään Texinfoa. On myös mahdollista kääntää Docbook-tiedostoja Texinfo-tiedostoiksi käyttämällä docbook2X-ohjelmistoa.
XML
(luodaan komennolla makeinfo --xml.) Yleisiin käyttötarkoituksiin.
Info
(luodaan komennolla makeinfo.) Tämä on erityinen tiedostotyyppi, joka on oleellisesti leipätekstiversio alkuperäisestä Texinfo-syntaksista, johon on lisätty joitakin kontrollikirjaimia, joiden avulla voidaan jäsentää eri solmut sekä tuottaa navigoitielementtejä

menuille, ristiviittauksille, aliluvuille ja niin edelleen. Info-tiedostotyyppiä voi katsella info-ohjelmistolla.

On huomattava, että man-tiedostotyyppi ei ole tuotettavissa tavanomaisilla Texinfo-kääntäjillä. Texinfoa käytetään, kun kirjoitetaan GNU-ohjelmistojen dokumentointia, jota tarvitaan yleensä Unix-tyyppisissä ympäristöissä, kuten GNU/Linux, missä man-sivut ovat perinteinen dokumentointitapa. Perinteen vuoksi man-sivuilla on tarkka rakenne ja niitä käytetään yleensä pikaoppaina, kun taas Texinfon avulla tehdyt dokumentit ovat laajoja ja kattavia oppaita. Tämän vuoksi ei yleensä nähdä syytä muuttaa Texinfo-sisältöä man-sivuiksi. Kuitenkin, useille GNU-ohjelmille on olemassa kattavat man-sivut, jotka kertovat olevansa harvoin päivitettäviä ja kannustavat lukijaa tutustumaan Info-sivuun.

Texinfo-lähdekoodi[muokkaa | muokkaa wikitekstiä]

Texinfo mahdollistaa dokumentin jäsentämisen kirjan tapaan, jolloin dokumentissa on lukuja, alilukuja, ristiviittauksia ja indeksejä. Lähdekoodi on lähes leipätekstiä, mutta teknisesti ottaen se on jäsenneltyä tekstiä, jota on jäsennetty komennoilla, jotka alkavat merkillä "@". Näyte lähdetiedostosta:

@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

Komennot merkitsevät rakennetta, kuten lukua, sekä erottavat lähdekoodista osia, joita tarvitaan vain tietyissä luotavissa tiedostotyypeissä.

Historia ja status[muokkaa | muokkaa wikitekstiä]

Texinfo on GNU-projektin virallinen dokumentaatiotapa. Texinfo on lisensoitu GNU General Public License -lisenssillä.

Texinfo-formaatin loi Richard M. Stallman, yhdistäessään tulostettavia tiedostoja tuottavan BoTeX-formaatin, joka oli käytössä MIT-yliopistolla, verkkosivuilla käytettävään Info-dokumentaatiojärjestelmään, joka käyttää hyperlinkkejä. Info on myös Stallmanin luoma ja perustuu TECO versioon Emacsista.[4][5] BoTeX perustui puolestaan aiempaan järjestelmään, jolla oli nimi Bolio (yhdistetään usein David A. Mooniin, ja jota käytettiin Lisp-tietokoneessa[6]), jota muokattiin käyttämään TeX-formaattia ulostulonaan. Robert Chassell auttoi Stallmania luomaan ensimmäisen kääntäjän Info-tiedostotyypin tekemiseen Emacs Lispiä varten. Texinfon ohjelmistokehitystä johti Brian Fox (versioon 3.8 asti), Karl Berry (versioon 5.2 asti), ja Gavin Smith (joulukuusta 2014 alkaen).

Texinfo "perustuu löyhästi Brian Reidin Scribe-merkintäkieleen ja muihin merkintäkieliin, jotka olivat tyypillisiä sen syntyaikana".[7]

Katso myös[muokkaa | muokkaa wikitekstiä]

Lähteet[muokkaa | muokkaa wikitekstiä]

  1. GNU's Who, The GNU Team has grown larger in the last few months: Brian Fox and Opus Goldstein have joined Jay Fenlason as the only employees of the Foundation. Most recently, Brian created a stand-alone texinfo formatter and browser..., February, 1988, GNU's Bulletin, vol. 1 no. 4
  2. Gnu Status, by Richard M. Stallman. 5. Documentation system. I now have a truly compatible pair of programs which can convert a file of texinfo format documentation into either a printed manual or an Info file. Documentation files are needed for many utilities., February 1986, G N U ' S B U L L E T I N, Volume 1 No.1
  3. What's GNU: Texinfo, Issue 6, Oct 01, 1994, By Arnold Robbins, Linux Journal
  4. GNU Texinfo Manual, Section 1.14 History
  5. Richard Stallman, January 8, 2012, post on emacs-devel mailing list: "...Info has existed since 1976 or so, in the original Emacs. At that time, Info files were written by hand, and everyone could edit system files on ITS."
  6. Daniel Weinreb and David A. Moon (January 1979), Lisp Machine Manual, Second Preliminary Version
  7. Texinfo
Tämä tietotekniikkaan liittyvä artikkeli on tynkä. Voit auttaa Wikipediaa laajentamalla artikkelia.