Docbook Elemanları
Önceki Linux Belgeleri NASIL Sonraki
Docbook Elemanları
Docbook elemanlarını her biri diğerlerini içeren 8 grupta inceleyebiliriz:
  1. Kitaplıklar (set)
    Bir set elemanı en azından bir book içerir. Sitemizin kitaplık bölümü bir miktar book'tan oluşan bir set'tir
  2. Kitaplar (book)
    Bir book genellikle en üst seviye elemandır. Bir kitap serisi planlamadığınız sürece en tepe Docbook elemanıdır. Aşağıdaki elemanların bir karışımından oluşur.
    Adama Bölümü (dedication)
    Genellikle kitabın en başında yer alır.
    Gezinme Elemanları
    İçindekiler (toc), Çizelge ve Şekil Listeleri (lot), Fihrist (index) gibi kitap bölümleridir.
    Oylumlar
    Bir kitabın üst seviye hiyerarşik parçalarıdır. (part ve reference) Ancak bir kitap bu elemanlar olmadan da oluşturulabilir.
    Kısımlar
    Oylumların ya da kitabın alt kısmı olarak kullanılabilen chapter etiketi ile tanımlanan kitap bölümleridir.
    Bölümler
    Bu kitabın içindeki belgeleri oluşturan parçalar (article ve sect1) bu bölümlere iyi bir örnektir. Her article çok sayıda alt bölüm (sect1, section) içerebilir.
    Uyarı
    article ve chapter etiketleri eşdeğer etiketlerdir. Yani bir article, bir chapter içinde bulunamaz.
  3. Oylumlar (part)
    Kitapların alt bölümü olarak yukarıda bahsedildi.
  4. Kısımlar (chapter)
    Kitapların alt bölümü olarak yukarıda bahsedildi.
  5. Bölümler (article, sect1)
    Kitapların alt bölümü olarak yukarıda bahsedildi.
  6. Alt Bölümler (section)
    Docbook'ta alt bölümleri oluşturan elemanlar çok çeşitlidir:
    sect1...sect5 Elemanları
    Bunlar hemen tüm belgelerde sıklıkla kullanılan numaralı bölüm elemanlardır. sect1'den başlayarak iç içe 5 seviyeli bölümleme yapılabilir.
    section Elemanları
    section elemanlarının sect* elemanlarından farkı sonsuz iç içelikte bölümleme yapılabilmesidir.
    simplesection Elemanı
    Genellikle diğer sect* elemanlarının içinde yer alır. simplesect elemanının altına başka sect* elemanı yerleştirilemez. Bu bakımdan sonlandırıcı sect* elemanı gibi görev yapar.
    bridgehead Elemanı
    Sadece bir bölüm başlığı üretir.
    refsect1...refsect3 Elemanları
    Bu elemanlar sadece refentry elemanlarının içinde bulunabilir. sect* elemanları gibidir, ama sadece 3 seviyeli bölümleme yapılabilir.
    glossdiv, bibliodiv ve indexdiv Elemanları
    Sözcük dağarcığı (glossdiv), kaynakça (bibliodiv) ve fihrist (indexdiv) bölümlerini oluşturmakta kullanılırlar. sect* elemanlarının tersine bunlar iç içe seviyeli olamazlar.
  7. Ön bilgi elemanları
    bookinfo, partinfo, articleinfo gibi önbilgi verme bölümleridir. Bu bölümlerde başlık, yazara ilişkin bilgiler, sürümlerin gelişimi belge hakkında özet bilgi, içindekiler, anahtar sözcükler gibi bilgiler verilir.
  8. Blok elemanları
    Blok elemanlarına en iyi örnek paragraflardır (para). Listeler tablolar, şekiller ve resimlerde blok elemanlarıdır.
    Listeler
    Docbook'ta 7 tane liste elemanı vardır.
    calloutlist
    Genellikle bir program ya da ekran görüntüsü üzerinde bilgi vermek için kullanılır. Bir önceki bölümde XML dosyasının ilk satırlarını incelerken bu elemandan faydalanmıştım.
    glosslist
    Sözcük dağarcığındaki terimler ve tanımları için kullanılır.
    itemizedlist
    Sıra numarasız imli listeler için kullanılır.
    orderedlist
    Sıra numaralı listeler için kullanılır. Bu bölümdeki 1 den 8 e kadar giden liste gibi.
    segmentedlist
    Öğelerinin isimlerinin tekrarlandığı listeler için kullanılır.
    simplelist
    Öğelerinin sıra numarası almadığı imsiz bir liste türüdür. Öğeleri satır ve sütunlar halinde düzenlenebilir.
    variablelist
    Parametre, seçenek açıklamaları türünden listelerde kullanılır. Burada 7 liste elemanını tanıttığım liste böyle bir listedir.
    Dikkat Çekme Elemanları
    Docbook'ta 5 tür dikkat çekme elemanı vardır: caution, important, note, tip, warning
    Paragrafların içinde kullanılan elemanlar
    HTML'deki <BR> elemanının Docbook'da ki karşılığı <sbr/> en basit örnek olarak verilebilir.
    Başlıcaları:
    address
    Posta adreslerini belirtirken kullanılır. Satır içi kullanımda ise isim ve adresleri etiketlemek için kullanılır.
    literallayout
    İçerdiği metne sabit yazı tipi uygular ama programlisting ve screen gibi belli bir zemin rengi yoktur. Boşluklar korunduğundan ASCII-art gösterimler için faydalıdır. (Bu standart uygulama değildir. Bu kitaplık için xsl dönüşümü yapılırken elemana bu özellik verilmiştir.)
    programlisting ve screen
    Program listeleri, konsol çıktıları vb. metinlerin oldukları gibi görünmesini sağlayan bloklama elemanlarıdır. Bu kitaplık için özelleştirilmiş ve zemin rengi atanmıştır. İçeriğine sabit genişlikli yazı tipi uygular.
    screenshot
    Grafik ekran görüntüleri için kullanılır.
    synopsys
    Komut ve işlev bildirimlerini belirlemek için kullanılır.
    Örnekler, Şekiller ve Tablolar
    Örnekler için example ve informalexample, şekiller için figure ve informalfigure, tablolar için table, ve informaltable elemanları kullanılabilir. informal* elemanları türlerinin başlıksız olanlarıdır.
    Paragraflar
    Hemen her elemanın içinde yer alabilen blok elemanlarıdır. para, formalpara, simplepara gibi farklı amaçlara yönelik türleri vardır. formapara elemanı başlıklı bir paragraf türü belirtir.
    İfadeler
    Matematiksel ifadelerin gösterilmesinde kullanılır. equation ve informalequation elemanları blok, inlineequation ise satır içi kullanım elemanlarıdır.
    Resimler
    Resimler için kullanılabilecek elemanlar figure ve screenshot elemanlarıdır. Satır içi kullanım için inlinegraphic elemanı kullanılır. Ayrıca video, ses, resim ve metin veriler için mediaobject, satır içi kullanımda inlinemediaobject elemanları kullanılabilir.
    Soru-Cevap Elemanları
    Sıkça Sorulan Sorular bölümlerini oluşturmak için qandaset, question, answer elemanları kullanılabilir.
  9. İç elemanlar
    Bunlar bölümler ve paragraflar içinde yer alan bağ, karakter biçimleme, uyarı vb. elemanlarıdır. Burada çok sık kullanılan bazı elemanlar tanıtılmıştır.
    abbrev
    Bir kısaltmayı etiketler. Kısaltmayı bir nokta izler.
    acronym
    Bir deyim ya da ismin baş harfleriyle oluşturulan bir kısaltmanın anlatımı için kullanılır.
    emphasis
    Etiketlediği metnin eğik karakterlerle gösterileceğini belirtmek için kullanılır. Bu kitap için özelleştirilerek, role parametresi ile bu etikete kalın karakter gösterimi de eklenmiştir: <emphasis role="bold">. Hem kalın hem eğik istenirse elemanlar birbirinin içinde kullanılmalıdır.
    footnote
    Dipnotlar için kullanılır.
    trademark
    Bir ticari markayı etiketlemekte kullanılır.
    link
    Belge içi çapraz bağlar için kullanılır. Bağ hedefi olan elemanın id parametresi, linkend parametresine belirtilir.
    ulink
    Dış hedefler için bağ belirtir. Hedefin adres bir URL olarak url parametresinde belirtilir.
    literal
    Satır içinde özgün hali korunması ve vurgulanması gereken metin parçaları için kullanılır.
    sgmltag
    Metin içinde geçen etiket isimlerini etiketlemede kullanılır.
    replaceable
    Metin içinde kullanıcının değiştirmesi beklenen ya da istenen metin parçalarını etiketlemekte kullanılır.
Bu bölümde bahsettiğim elemanlar Docbook'un 300'den fazla eleman içerdiği gözönüne alındığında çok azdır. Ama en çok kullanılanlardan bahsetmeye çalıştım. Buradaki bilgiler tek başlarına bir belge yazmak için yeterli değildir. Burada sadece Docbook Guide'ın Docbook oluşturulması ile ilgili bölümünü kısmen çevirdim, kısmen de ben bir şeyler kattım. Docbook Guide, her eleman için bu sayfa gibi birer sayfa içeriyor. Bu bakımdan belge hazırlayacaksanız bu kılavuz daima farenizin imlecinin altında bulunmalıdır. Ya da hazır bir belgenin sadece çevirisiyle ilgilenmelisiniz.
Önceki Üst Ana Başlık Sonraki
Bir XML Dosyasının Yapıtaşları Başlangıç Hata Ayıklama
Bir Linux Kitaplığı Sayfası