HTML Yardım Sistemi için Yazmak:
Katkılar son derece hoş karşılanır. HTML yardım sistemine bir katkıda
bulunmak istiyorsanız, lütfen bakımcı ile irtibata geçin:
fritzdotmuelleratmaildotcom
\help dizininin yapısı:
\help\index.htm
Sistemde kurulu yardım dillerini listeler.
İngilizce (EN) kurulu değilse ve LANG mevcut bir lisana ayarlı
değilse otomatik olarak yüklenir.
\help\%LANG%\index.htm
Yardım, varsayılan olarak bunu yükler. %LANG% LANG ortam değişkeni
ayarlanarak seçilen dildir. Eğer LANG ayarlı değilse, EN varsayılır.
\help\%LANG%\help.htm
Yardım, kullanıcı F1 tuşuna bastığında veya "Yardımın Yardımı"
bağlantısına tıkladığında bunu yükler.
\help\docinfo\bi\nls\%LANG%.bi
Kütüphane etajer dosyalarını Aitor'un bookshlf aracı ile lisan
endeksini oluşturmak için saklar (\help\index.htm).
Sıkıştırılmış yardım dosyaları oluşturmak:
Sıkıştırılmış dosya kümesi için şu şekilde bir ad kullanmalısınız:
\help\...\[isim]\[isim].zip
Yardım dosyalarınızı sıkıştırmak istiyorsanız, zip biçiminde olmaları
gerekir. Dosya isimleri saklandıkları dizin ile aynı olmalıdır, ek
olarka zip uzantısı kullanılmalıdır. Mesela:
\help\en\myhelp\myhelp.zip
index.htm bir zip dosyası içinde olabilir, fakat değilse yardım ve
bookshlf daha iyi çalışır.
Zip dosyası içinde dizin yapılarına izin verilir. Ancak şifreleme ile
eski ve daha az bilinen sıkıştırma yöntemleri desteklenmez.
Yardım dosyalarının değiştirilmiş sürümlerinin oluşturulması:
Değiştirilmiş sürümlerde başlık sayfasında (çoğunlukla index.htm)
farklı bir başlık kullanın. Bunun maksadı karışıklık ve çakışmalara
engel olmaktır ve daha da önemli olarak bu,
GNU Özgür Belgelendirme Lisansı 1.1 bölüm 4A'da şart koşulur.
Başlığı değiştirmeye ilaveten lütfen tarihçeyi, yazarlar listesini
vs. güncelleyin, GNU Özgür Belgeleme Lisansı 1.1 4. bölümün
gerektirdiği üzere.
Eğer dosya kümesi yeni veya değiştirilmiş bir paketi açıklayacaksa ya
da dosya kümesi temel bir değişikliğe maruz kalıyorsa (mesela tercüme
gibi), en iyisi farklı bir alt dizin ismi kullanmaktır, yukarıda
\help dizininin yapısı bölümünde izah edildiği gibi. Bu, sadece
index.htm dosyasındaki alt dizin ismini bulup değiştirme meselesidir
ve hakikaten buna değer.
Mesela, "hhstndrd" dosya kümesinin küçültülmüş bir sürümünün ismi
"hhmicro" olabilir. Bu, alt dizinin ismi olur, ve index.htm dahilinde
başlık şu şekilde olabilir:
FreeDOS Hilfe (hhmicro 1.0)
Güncelleme yayınlarken sadece sürüm numarasını değiştirmek (isim ve
"hhmicro" dizini yerine) makul olacaktır.
Yeni dosya eklemek veya oluşturmak:
Her yeni yardım dosyasının sonuna şu lisans mesajını koymanız tavsiye
edilir (buna istisna, yardım dosyası kümesine dahil olmayan, tek unless it is going to be a stand alone file, not
başına bir dosya olacaksa):
...
<hr>
<address>
<b>Telif hakkı © 2008
<a href="mailto:benimepostam@adres.com">İsmim</a></b><br>
Bu dosya FreeDOS HTML Yardım Belgelendirmesi parçasıdır ve onun
lisans koşulları kapsamındadır, şu sayfaya bakın:
<a href="../index.htm">index.htm</a>
</address>
</body>
</html>
Bir e-posta adresi girmek tamamen seçime dayalıdır; eğer yardım
dosyalarınızı bir İnternet sitesine yüklerseniz, e-posta adresi
spam'a maruz kalabilir.
Koşullar şunlardır: GNU Özgür Belgelendirme Lisansı 1.1.
Zip arşivinde bulunan bir dosyanın düzenlenmesi:
Zip arşivini, html dosyalarının başka bir tarayıcı ile okunması veya
düzenleme amacıyla açmak isteyebilirsiniz. Zip dosyaları genelde
sıkıştırılmamış dosyalara nazaran önceliklidir; yardımın düzenlenmiş,
sıkıştırılmamış bir sürümü okumasını istiyorsanız, zip arşivindeki
orijinal sürümü silmeniz veya onun yerine başkasını koymanız gerekir.
Yardım dosyalarının denenmesi:
Yardım dosyalarının denemesinde kullanılan referans tarayıcılar
şunlardır:
* FreeDOS HTML Yardım Görüntüleyicisi (help.exe)
* Chromium türevi bir tarayıcı.
Tablo oluşturulması:
Maalesef yardım tablo etiketlerini desteklemez. Bilgi tabloları için
ön biçimlendirme etiketleri olan <pre> </pre> kullanın.
Genel ipuçları:
Yardımın görüntülediği dosyayı tazelemek için F5 veya Ctrl+R
tuşlarına basın. Böylece dosyaya yapılan değişiklikler derhal
görüntülenebilir. Bu, Windows türü bir ortamda dosyalar düzenlenirken
kullanışlıdır. HTML Yardım Görüntüleyicisini henüz dosya kümesine
dahil edilmemiş bir dosyayı görüntülemek amacıyla kullanmak için
yardım yolu geçersiz kılma seçeneği kullanılabilir:
help /O[sürücü:][yol]dosyaismi[.htm]
veya \HELP dizinine göreli ise:
help /L[altdizinler]dosyaismi[.htm]
Ayrıca bakın:
HTML Yardım Tarafından Desteklenen Etiketler
Yazarlar için Kaynaklar
Telif hakkı © 2003-4 Robert Platt, 2008 ve 2020 senelerinde
W. Spiegl tarafından güncellenmiştir.
2022 senesinde Berki Yenigün tarafından tercüme edilmiştir.
Bu dosya, FreeDOS HTML Yardım Belgelendirmesi'nin bir parçasıdır ve
onun şartları kapsamındadır: index.htm sayfasına bakın.