DocBook

DocBookjęzyk znaczników do tworzenia dokumentacji technicznej, pierwotnie przeznaczony do opracowywania dokumentów związanych ze sprzętem i oprogramowaniem komputerowym, ale potem wykorzystywany w wielu innych dziedzinach. Można w nim opracowywać zarówno całe książki, jak i zwyczajne artykuły. Dodatkowe znaczniki umożliwiają tworzenie np. indeksów, słowników terminologii itd. Język powstał w roku 1991 jako wspólny projekt HaL Computer Systems oraz O’Reilly & Associates. Obecnie rozwija go DocBook Technical Committee w OASIS (pierwotnie SGML Open).

DocBook istnieje zarówno w postaci SGML-owego, jak i XML-owego DTD (Document Type Definition). Początkowo był aplikacją SGML-ową, jednak opracowano również jego XML-owy ekwiwalent, który zastąpił SGML w większości zastosowań – XML DTD pojawiło się razem z wersją 4 SGML DTD.

DocBook jest używany głównie przez wspólnotę Open Source. Przykładami są opisy API w Linux Documentation Project, GNOME i GTK+ API oraz dokumentacja kernela Linuksa. Format DocBook jest z kolei używany jako format pośredni dla języka znaczników AsciiDoc[1].

Norman Walsh i zespół DocBook Project rozwijają zbiór arkuszy stylów XSL (oraz przestarzałych DSSSL) do generowania wydruków, plików PDF, RTF i HTML z dokumentów w formacie DocBook (jak również generowania innych formatów, w tym stron man i plików HTML Help. Walsh jest też głównym autorem książki DocBook: The Definitive Guide, oficjalnej dokumentacji DocBook. Książka jest dostępna online, na licencji GNU FDL, oraz jako publikacja drukowana.

DocBook jest bardzo łatwy do rozszerzania. Każdy, kto tego potrzebuje, może przygotować odpowiednią nakładkę personalizacyjną (ang. customization layer), która doda nowe lub usunie niepotrzebne znaczniki. Jeżeli nakładka ma być rozpowszechniana, nie może się ona dalej nazywać DocBook.

Ponieważ DocBook jest aplikacją XML, dokumenty mogą być tworzone i edytowane w dowolnym edytorze tekstu. Istnieje jednak wiele dedykowanych narzędzi upraszczających ten proces. Edytor Emacs w trybie nXML posiada wbudowane informacje o schemacie DocBook, dzięki czemu użytkownicy mogą szybko dodawać nowe elementy lub przeprowadzać kontrolę dokumentu. Istnieją także narzędzia WYSIWYG (np. XMLmind) potrafiące automatycznie generować odpowiednią strukturę dokumentu DocBook w trakcie pisania.

Przykładowy kod

<book id="prosta_ksiazka">
  <title>Bardzo prosta książka</title>
  <chapter id="prosty_rozdzial">
    <title>Rozdział 1</title>
    <para>Witaj świecie!</para>
  </chapter>
</book>

Przypisy

  1. AsciiDoc Home Page [online], asciidoc.org [dostęp 2019-07-23].

Literatura

Linki zewnętrzne

Content Disclaimer

Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.

  1. The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
  2. There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
  3. It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
  4. Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
  5. Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.