Kdissert el kitabı
Thomas Nagy [email protected]
˙Içerik
1 Giri¸s 2
1.1 Çok amaçlı doküman üreteci . . . 2
1.2 Konu-haritası olu¸sturma aracı. . . 2
1.3 Önerilen yöntem . . . 4
2 Hızlı ba¸slangıç 4 2.1 Haritayı olu¸sturun . . . 4
2.1.1 Yeni haritalar . . . 4
2.1.2 Kökleri ve dalları ekleyin. . . 4
2.1.3 Ö˘gelerin içeri˘gini yazın. . . 4
2.1.4 Bayrak eklemek, renk ve font de˘gi¸stirmek . . . 5
2.2 Haritayı hazırlamak için Kdissert modlarının kullanımı . . . 5
2.2.1 Seçim modu . . . 5
2.2.2 Ba˘glantı modu . . . 5
2.2.3 Sıralama modu . . . 5
2.2.4 Gezinim modu . . . 6
2.3 Ana a˘gaçtan doküman üretmek . . . 6
2.3.1 Doküman üreteçlerini kullanmak. . . 6
2.3.2 Haritadan resim olu¸sturmak . . . 6
3 ˙Ileri seviyede özellikler 6 3.1 Harita düzenleme ipuçları . . . 6
3.1.1 Satır içi editör. . . 6
3.1.2 Seçim modunda özel i¸slemler . . . 6
3.1.3 Sürükle ve bırak . . . 7
3.1.4 Kaynak ve ba˘glantı eklemek . . . 7
3.2 Doküman üreteçleri . . . 7
3.2.1 Doküman üreteç tipleri . . . 7
3.2.2 Doküman i¸sleme bilgisi . . . 7
3.2.3 Komut satırı arayüzü ve örnek . . . 8
3.3 Kısa yol tu¸sları . . . 8
3.3.1 Gezinim. . . 8
3.3.2 Haritayı hazırlamak. . . 8
3.4 Ayarlar . . . 9
3.4.1 Yeni doküman özellikleri . . . 9
3.4.2 Öntanımlı fontlar . . . 9
3.4.3 Özet ¸seklin büyüklü˘gü . . . 9
4 Geli¸stirici bilgisi 9 4.1 WAF tabanlı derleme sistemi . . . 9
4.2 Tasarım kararları . . . 9
4.2.1 Kopyalayıp yapı¸stırmak yerine veriyi haritaya aktarmak . 9 4.2.2 Satır içi editör . . . 9
4.3 Derleme ve kurulum . . . 10
4.4 Geni¸sletme programlarıyla doküman üretmek . . . 10
1 Giri¸s
1.1 Çok amaçlı doküman üreteci
Kdissert ile metin, ¸sekil, yorum ve ba˘glantı içeren konu-haritaları olu¸sturulabilir ve bunlar rapor veya sunuma dönü¸stürülebilir. Ana amaç doküman olu¸sturmayı hızlı ve verimli kılmaktır.
Program bir KDE uygulaması oldu˘gu ve tez yazma i¸sini kolayla¸stırmayı amaçladı˘gı için kdissert olarak isimlendirilmi¸stir. Temel olarak ö˘grencilerin kullanabilece˘gi bir program olmakla birlikte, mühendis, i¸sadamı ve ö˘gretmenler için de faydalı olabilecektir.
1.2 Konu-haritası olu¸sturma aracı
Kdissert, ana kullanıcı arayüzünde, grafiksel ortamda konu-haritası olu¸sturmaya olanak sa˘glar ve doküman içeri˘gini global olarak dü¸sünmeyi, konuları hızla birbirine ba˘glamayı, ba˘glantıları koparmayı ve yeniden düzenlemeyi sa˘glar.
Doküman içeri˘gini liste olarak planlamayı tercih edenler için bu olanak ta sunulmu¸stur.
¸Sekil 1: Kdissert’in ekran görüntüsü
1.3 Önerilen yöntem
• Ö˘geleri ekleyerek ba¸slayın - ekleyebildi˘giniz kadar fazla alt konuyu ekleyerek ba¸slayın
• Link moduna geçip alt konular arasındaki ba˘glantıları kurun
• Konu dı¸sında kalan veya gereksiz ö˘geleri silin, a˘gacı dengeleyin (her ö˘gede ortalama olarak 3-4 alt ö˘ge ve a˘gaçtaki dallanma derinli˘gi 5’ten az olmalıdır)
• Haritadaki nesnelere metin ve ¸sekilleri ekleyin - nekadar çok o kadar daha iyi (¸sekiller özellikle raporlarda önemlidir)
• Sıralama moduna geçip dalları anlamlarına uygun sıralayın
• Dokümanınızı üretip üzerinde çalı¸sın (LaTeX, OpenOffice, ..)
2 Hızlı ba¸slangıç
2.1 Haritayı olu¸sturun
2.1.1 Yeni haritalar
˙Ilk olarak, konu haritası çalı¸sma ortamında aklınızdakilerin konu-haritasını hazırlayın (kdissert grafiksel kullanıcı arayüzündeki ilk sekme). Çalı¸sma ortamı penceresini enbüyüterek mümkün oldu˘gunca geni¸s bir alan açın, harita alanının ortasına gelip farenin sa˘g tu¸suna tıklayın ve ’new item’ seçene˘gini seçip a˘gaç kökünü olu¸sturun.
2.1.2 Kökleri ve dalları ekleyin
Harita olu¸sturma alanına çift tıklayarakta yeni konu-haritası ö˘geleri eklemek mümkün. Haritadan ö˘ge silmek için ö˘geyi seçtikten sonra silme (delete) tu¸suna basmak yeterlidir. Öntanımlama nedeniyle konu-haritasının kökleri sarı ve dalları ye¸sil olmaktadır.
2.1.3 Ö˘gelerin içeri˘gini yazın
Yeni eklenen ö˘gelere metin eklemek için ekranın alt kısımlarındaki alanı kullanın.
Özet do˘grudan harita alanı üzerinden girilebilir. Ö˘geyi seçip ’a’, ’e’,
’i’ tu¸slarından herhangi birine basarak özet yazma alanının görüntülenmesini sa˘glayabilirsiniz. Özeti yazdıktan sonra kabul etmek için ’enter’ ya da vazgeçmek için ’escape’ tu¸suna basınız.
2.1.4 Bayrak eklemek, renk ve font de˘gi¸stirmek
Konu-haritasını daha anlamlı kılmak için, renk ve fontları de˘gi¸stirmek mümkündür - menüler ö˘genin üzerine sa˘g-tıklayarak görüntülenir (konu-haritası ya da liste alanlarından herhangi birinde). Bu i¸slem konu-haritasında seçili ö˘ge grubuna da uygulanabilir.
2.2 Haritayı hazırlamak için Kdissert modlarının kullanımı
2.2.1 Seçim modu
Seçim moduna geçi¸s için imleç ikonunu kullanın. Bu modda harita üzerinden ö˘gelerin seçilmesi ve sürüklenmesi mümkündür, böylece yeni ö˘geler için mevcut bo¸s alanı artırabilirsiniz (farenin sol tu¸sunu basılı tutarak ok tu¸slarını kullanınız).
Harita alanına sol-tıklayıp civara sürüklerken konu-haritası üzerinde yer alan ö˘geleri kolay seçebilmek için seçim dörtgeni belirmektedir. Birden fazla ö˘genin seçilmesi için, ’shift’ tu¸sunu basılı tutup harita üzerindeki ö˘gelere sırayla sol-tıklayın.
2.2.2 Ba˘glantı modu
Ba˘glantı modunu kullanarak (artı ikonu) ö˘ge ata ö˘gesine ya da kök ö˘geye ba˘glanabilir. Bu amaçla, ö˘ge üzerine sol-tıklayın ve fare tu¸sunu basılı tutarak olu¸san ba˘glantıyı di˘ger ö˘ge üzerine bırakın. Ba˘glantı herhangi bir ö˘geden ba¸slayabilir ancak ba˘glantısız ö˘ge ile sonlanmalıdır (sarı renkte).
2.2.3 Sıralama modu
Doküman üreteçleri, konu-haritasındaki hangi dalın önce geldi˘gini bilmelidir, bu da ö˘gelerin sıralanmasını gerektirir. Ö˘geleri sıralamak için, sıralama modunu seçin (üzerinde sayılar olan ikon) ve haritada bir ö˘ge üzerine tıklayın. Tıklanan ö˘genin dallarındaki ö˘gelerin yanında sayılar belirir (sarı daireler). Numaralar üzerine sırayla tıklayarak sıralama yapabilirsiniz.
2.2.4 Gezinim modu
Bu modu haritayı hızlı olarak incelemek için kullanın. Farenin sol tu¸sunu basılı tutup imleci etrafta ta¸sıyarak haritayı kaydırarak istedi˘giniz bölgesine ula¸sabilirsiniz.
2.3 Ana a˘gaçtan doküman üretmek
2.3.1 Doküman üreteçlerini kullanmak
Doküman üreteçleri konu-haritasında yer alan bilginin tekrar kullanımını sa˘glayan etkili araçlardır. Bu araçlara menünün ’Tools’ seçene˘gi kullanılarak eri¸silebilir.
Doküman üretme özelli˘ginin kullanımını açıklayan bilgi sihirbazda sunulmu¸stur, ileti¸sim penceresinde beliren bu bilgiyi dikkatlice okuyunuz.
2.3.2 Haritadan resim olu¸sturmak
Konu-haritasının resmini ’Tools’ menüsünden ’Create Picture...’ seçene˘giyle olu¸sturabilirsiniz. Resim PNG formatında bir dosya olarak kaydedilmektedir ve pek çok grafik uygulama aracı tarafından tekrar kullanılabilir.
3 ˙Ileri seviyede özellikler
3.1 Harita düzenleme ipuçları
3.1.1 Satır içi editör
Ö˘geyi açıklayan özet do˘grudan konu-haritası üzerinden ö˘ge seçilerek girilebilir.
Bu amaçla kullanılan kısa yol tu¸sları vim editörünün tu¸slarına çok benzemektedir:
’A’ ile metin ekleme, ’E’ ile tüm metni seçme ve ’I’ ile imleç satır ba¸sına konumlama.
3.1.2 Seçim modunda özel i¸slemler
Seçim modundayken, kontrol tu¸suna basılarak ö˘ge üzerine çift tıklamayla üst ö˘geyle olan ba˘glantısı kesilebilir. Kontrol tu¸su basılıyken ba˘glantı üzerine çift tıklayarak ta ba˘glantı kesilebilir. Kontrol tu¸su basılıyken iki ö˘geye sırayla tıklamakla da ba˘glantı sa˘glanabilir.
3.1.3 Sürükle ve bırak
Liste görünümüyle konu-haritasını sıralanı¸sı görülebilir. Liste görüntüsü üzerinde ö˘geleri sürükleyip bırakmakla ö˘geler sıralanabilir. Burada bazı kısa yol tu¸sları kullanılabilir: silme (silme tu¸su), bir alt seviyeye ta¸sıma (’o’ tu¸su) ve bir üst seviyeye ta¸sıma (’p’ tu¸su).
Konu-haritası ya da bir ö˘gesinin üzerine metin bırakmak mümkündür.
3.1.4 Kaynak ve ba˘glantı eklemek
Kaynaklara denk dü¸sen özel ba˘glantılar eklemek mümkündür. Bu ba˘glantılar farklı renktedir ve dokümanda grafik benzeri yapılara olanak verir. Kaynak ba˘glantısı eklemek için, ba˘glantı modunu kullanarak ve kontrol tu¸suna basılı tutarak ba˘glantı olu¸sturun. Ba˘glantılar ve kaynaklar farklı renklerdedir ve ba˘glantılar tüm dokümanlar için kullanılır oysa kaynaklar sadece ’book’ ve
’article’ türündeki LaTeX dokümanlarında görüntülenir.
3.2 Doküman üreteçleri
3.2.1 Doküman üreteç tipleri
Su anki Kdissert ile LaTeX (Beamer ve Prosper sunumları, rapor ve makale pdf’leri), OpenOffice.org Writer ve Impress, docbook, düz metin ve html dokümanları üretilebilir.
LaTeX çıktısı
’Settings’ menüsünden ’use LaTeX code’ seçene˘gini seçerek ö˘geye ait açıklamaların LaTeX komutu olarak yorumlanmasını sa˘glayabilirsiniz. Bu seçene˘gin seçilmemesi halinde ’comment’ bölümünde yazılanlar üretilen LaTeX kodunda açıklama satırı olarak geçer.
E˘ger LaTeX dokümanlarda unicode ile ilgili sorunla kar¸sıla¸sırsanız, sorunu xmltex ve ilgili paketleri sisteminize kurarak çözebilirsiniz (örne˘gin Fedora Core 3’te).
OpenOffice.org sunumu
OpenOffice.org sunumlarında ¸sekiller rastgele olarak yerle¸smektedir, bu nedenle ¸sekilleri sıralamalısınız.
3.2.2 Doküman i¸sleme bilgisi
Doküman üreteçleri dokümanı üretirken var olan en büyük a˘gacı kullanır, dolayısıyla küçük a˘gaçlar ve ba˘glantısız dallar bir yana atılacaktır.
3.2.3 Komut satırı arayüzü ve örnek
Komut satırından doküman üretmek için kdissert ¸su ¸sekilde kullanılabilir:
kdissert -g kdisspdflatexarticle -g kdissOOOdoc -p folder file.kdi
#! /bin/sh
DIR=/tmp/atest/
rm -rf $DIR
# generate the document
kdissert -g kdisspdflatexarticle -p $DIR /home/ita/SGD/sgd.kdi pushd $DIR/kdisspdflatexarticle
# substitutions
perl -pi -e "s/\%\\ \\\\usepackage\[frenchb\]/\\\\usepackage[frenchb]/" main.tex
# compile the latex document make
rm -f main.pdf make view
3.3 Kısa yol tu¸sları
3.3.1 Gezinim
Ana kök merkezde olacak ¸sekilde ortalamak
En büyük a˘gacın kökü merkezde olacak ¸sekilde konu-haritasının görüntüsünü ortalamak için ’kontrol+h’ kısa yol tu¸sunu kullanabilirsiniz.
Kök listesi üzerinde çevrim
Kök listesi üzerinde çevrim halinde geçi¸s için ’kontrol+virgül’ kısa yol tu¸su kullanılabilir (’,’ - kısa yol tu¸su editörü ile yapılandırılmalıdır)
Modlar arasında geçi¸s
Nokta, ba˘glantı, sıralama ve ta¸sıma modları arasında hızlı geçi¸s yapabilmek için ¸su kısa yol tu¸sları öntanımlanmı¸stır: ’f’ nokta, ’d’ ba˘glantı, ’s’ sıralama ve ’a’
tu¸su da ta¸sıma moduna geçi¸s sa˘glar. Bu kısa yol tu¸sları, ’Settings’ menüsündeki kısa yol tu¸s editöru kullanılarak de˘gi¸stirilebilir.
3.3.2 Haritayı hazırlamak Haritayı yeniden düzenlemek
Haritayı yeniden düzenlemek için kontrol+G kullanın.
Font büyüklü˘günü fare tekeriyle ayarlamak
3.4 Ayarlar
3.4.1 Yeni doküman özellikleri
Yeni doküman özellikleri sadece yeni dokümanlara uygulanmaktadır. O anda aktif olan dokümanın özelliklerini de˘gi¸stirmek için ’Edit’ menüsündeki ’Document Properties’ seçene˘gini kullanın.
3.4.2 Öntanımlı fontlar
Öntanımlı font konu-haritası donatılarında kullanılır (ö˘gelerin sıralanmasında kullanılan etiketlerde) ve konu-haritası ö˘gelerinde kullanılan ba¸slangıç fontudur.
Di˘ger .kdi dosyalarındaki konu-haritaları kendi öntanımlı font ayarlarını korur.
Tüm ö˘gelerin fontunu de˘gi¸stirmek için, tüm ö˘geleri seçip yeni fontu uygulayın (konu-haritası alanına sa˘g-tıklayıp font ayarını seçin).
3.4.3 Özet ¸seklin büyüklü˘gü
Özet ¸seklin büyüklü˘gü ile özet ¸seklin (¸sekli olan ö˘geler için) konu-haritası üzerindeki önizleme boyutunu belirtilir. Bu önizlemeler ilgili i¸saret kutusu onayı kaldırılarak kapatılabilir.
4 Geli¸stirici bilgisi
4.1 WAF tabanlı derleme sistemi
BKsys sayfası
http://www.kde-apps.org/content/show.php?content=19243
4.2 Tasarım kararları
4.2.1 Kopyalayıp yapı¸stırmak yerine veriyi haritaya aktarmak
Kopyalayıp yapı¸stırmaya izin vermek verinin kopyalanmasına olanak sa˘glar.
Bu durum kdissert programının ba¸slangıç amacı olan bilgiyi yapılandırarak ö˘grencilerin iyi dokümanlar hazırlamasını sa˘glamak amacıyla ikilem yaratır.
4.2.2 Satır içi editör
Ö˘genin metnini kutu seçilmi¸sken yazmak cezbedici, ancak bu durumda kısa yol sisteminde kopma olur. Bu durum, kullanıcı dikkatini uygulamadan saptırmak olarak görülebilir.
4.3 Derleme ve kurulum
¸Su komutları kullanın:
./runme.sh make
make install
4.4 Geni¸sletme programlarıyla doküman üretmek
Yeni kdissert geni¸sletme programları olu¸sturmak için, src/templates dizininde var olan üreteçlerden (örne˘gin : kdissasciidoc) ba¸slanmalıdır, isim de˘gi¸stirilmeli (’kdiss’ öntakısı korunarak) ve kütüphane olu¸sturulmalıdır. .h ve .cpp dosyalarının da de˘gi¸stirilmesi gerekir (isimleri de˘gi¸stirilmeli).
Doküman üretebilmek için ’kdissPLUGIN.tar.gz’ isimli tar-paketi gereklidir.
Bu dosya mevcut olmadı˘gında doküman üretme çalı¸smayacaktır. Bu paketin içine README dosyasının dahil edilmesi önemlidir.
