istihza.com’daki belge sayısı günden güne artıyor. Haliyle belge sayısı arttıkça bu belgeleri oluşturmak ve yönetmek de bir o kadar zorlaşıyor. Şimdiye kadar istihza.com’daki bütün yazıları html+css kullanarak el kuvvetiyle hazırlıyordum. Ancak belge sayısındaki hızlı artış nedeniyle bu yazıları elle hazırlamak artık büyük bir külfet haline gelmeye başlamıştı. Bu nedenle uzun süredir işlerimi kolaylaştıracak bir alternatif arayışındaydım. Sonunda işimi kolaylaştıracak yöntemin ne olması gerektiğine karar verdim…
Bundan böyle istihza.com’daki belgeleri reST (reStructuredText) biçiminde hazırlayacağım. reStructuredText, bir metin işaretleme sistemidir. Bu sistem sayesinde, düz metne yakın bir biçimde oluşturulan belgeler, farklı formatlarda otomatik olarak yeniden üretilebilir. Örneğin reST biçiminde yazdığınız bir metni, daha sonra otomatik olarak html ve/veya pdf biçimine dönüştürebilirsiniz.
reST biçiminde hazırlanmış belgeleri farklı formatlarda yeniden üretmek için bazı yazılımlardan faydalanılıyor. Mesela Sphinx; reST biçimli belgeleri parçalayıp, bu belgelerden html, pdf ve chm biçimlerinde yeni belgeler üretebilen özel bir yazılımdır. Sphinx’in resmi sitesi http://sphinx.pocoo.org/ adresindedir. Ayrıca reStructuredText hakkında daha geniş bilgi almak için de http://docutils.sourceforge.net/rst.html adresini ziyaret edebilirsiniz… Bu arada Python’un resmi sitesi olan http://www.python.org adresindeki belgelendirme çalışmaları da bu Sphinx adlı yazılım yardımıyla yapılıyor…
Ben şu anda istihza.com’daki Python 3.x bölümünü reST biçimine dönüştürüyorum. Böylelikle hem ben yükümü biraz hafifletmiş olacağım, hem de istihza.com takipçileri Python 3.x bölümünü pdf biçiminde güncel olarak takip edebilecekler…
Sphinx; belge üretme sürecinde LaTex, Docutils, Jinja ve Pygments adlı yazılımlardan faydalanıyor. Örneğin ürettiğiniz belgelerdeki kodlar Pygments yazılımı yardımıyla otomatik olarak renklendirilebiliyor…
Bugün istihza.com’un takipçilerine bu Sphinx adlı yazılım yardımıyla üretilen Pdf belgesini sunarak yeni sürece doğru ilk adımımızı atıyoruz… İlgili pdf belgesine http://www.istihza.com/py3/pdf/Python3x.pdf adresinden erişebilirsiniz (NOT: Bu belge 28.08.09 tarihinde güncellenmiştir). Bu belgede şimdiye kadar Python 3.x bölümüne eklenmiş bütün konuları bulacaksınız. Yalnız bu pdf belgesi ile ilgili bazı uyarı ve hatırlatmalar yapmam gerekiyor:
1. Bu pdf belgesi Sphinx yazılımı yardımıyla otomatik olarak üretilmiştir.
2. Ben istihza.com’un Python3.x bölümündeki html belgelerini reST biçimine dönüştürürken bazı hatalar yapmış olabilirim. Dolayısıyla bu pdf belgesinde bazı eksik veya yanlış kısımlar olabilir. Mesela ekranın dışına taşan kodlar, yazım yanlışları, vb…
3. Göreceğiniz gibi, bu pdf belgesindeki kapak ve sayfa başlıkları gibi kısımlar İngilizce. Bunun nedeni, pdf belgesinin üretilmesinde kullanılan LaTex yazılımının unicode karakter dizilerini tanımakta zorlanması… Bunun için bir çözüm arıyorum. Ancak belgedeki İngilizce kısımlar rahatsız edecek boyutta olmadığı için, neyse ki ölümcül bir durumla karşı karşıya değiliz… Bununla ilgili çözüm önerisi olanları dinlemekten memnuniyet duyarım.
4. Belgedeki hataları ben sürekli olarak düzeltiyorum. Ancak bazı şeyler gözümden kaçabiliyor. Bu yüzden bu konuda sizlerin de yardım ve desteğine ihtiyacım var. Bu pdf belgesi içinde bulacağınız hataları kistihza{at}yahoo.com adresine bildirirseniz, yapacağımız düzeltmeler sayesinde hem daha kaliteli bir pdf, hem de daha düzgün bir html belgesine ulaşabiliriz…
5. Bu pdf belgesini sürekli olarak güncelleyeceğim. Her sürümde, sizlerin de desteğiyle, daha kararlı bir pdf belgesi elde edeceğimize inanıyorum.
6. Aslında istihza.com’daki Python3.x bölümünün html belgeleri de hazır. Ancak bunların yayımlanması daha farklı bir sürece girmeyi gerektirdiği için, bu html belgelerini birkaç gün daha bekleteceğim. Buradaki Pdf belgesi için bildireceğiniz hata düzeltmeleri html belgelerinin de kalitesinin artmasını sağlayacaktır.
7. Şimdiye kadar Python 3.x bölümünün pdf haline getirilmesi işiyle Sevgili Metehan Özbek ilgileniyordu. Ben istihza.com’a her yeni belge ekleyişimde Metehan’ın bu değişiklikleri pdf belgesine yansıtması bir hayli zor oluyordu. İşin kötü tarafı, Python 3.x bölümü yalnızca yeni belge eklemesi almıyor, aynı zamanda eski belgeler de sürekli olarak gözden geçirilip yenileniyor. Bu değişikliklerin insan eliyle pdf’ye aktarılması bir süre sonra kaçınılmaz olarak dayanılmaz bir hal alacaktır… Sevgili Metehan Özbek’e katlandığı bu büyük külfetten ötürü teşekkürü bir borç bilirim. istihza.com’daki bu yenilik onun da yükünü hafifletmiş olacak…
Dediğim gibi, pdf belgesini inceleyip bana hataları bildirirseniz hep beraber ortaya güzel bir iş çıkarmış oluruz.
İlgilenen herkese şimdiden teşekkür ederim.
Sevgiler,
istihza
istihza GNU/Linux, Python, Yazılım istihza.com, otomatik belge oluşturma, pdf, sphinx
Son Yorumlar