HTML Yardımı'na alternatifler

Şu anda basit bir metin işaretlemesinde dokümantasyon oluşturmamızı sağlayan AsciiDoc adlı bir sistem kullanıyoruz . Bundan çoklu çıktı formatları üretebiliriz. Sadece pdf çıktı ve chm çıktı formatlarını kullanıyoruz.

Chm'e bir alternatif olup olmadığını merak ediyordum? Aradığım şey, yazılımımızla çevrimdışı kullanılabilen bir şeydir (bu çok önemlidir, çünkü kullanıcılarımızın çok azı çok uzak yerlerde bulunmaktadır). Bir dizine sahip olmalıdır (köprülü terimlere sahip bir html sayfası kadar basit olabilir), aranabilir olmalı ve koddan belirli girdilerin çağrılmasına izin veren bir mekanizmaya sahip olmalıdır (bağlama duyarlı yardıma benzer).

Bu durumda PDF'ye karşı olan iki şey:

1. Bağlama duyarlı yardım bir seçenek değildir
2. Genellikle belge oldukça büyük
3. PDF, basılı belgelere bağlama duyarlı yardımdan daha uygundur

Ne istiyorum html kullanmaktır. Html ile tek sorun, nasıl otomatik olarak bir anahtar kelime arama sağlamak için anlamaya olamaz ki (tarayıcılar ctrl + f işlevselliği dışında - ben daha belirgin bir şey istiyorum). Ayrıca otomatik olarak anahtar sözcüklerin köprülü bir dizin oluşturmak için bir yöntem bulamıyorum. Bağlam duyarlı yardım bölüm etiketleri nedeniyle basit olurdu - Ben sadece varsayılan tarayıcı ilgilendi sayfanın ve bölümün url iletmek olabilir ve bu sayfa doğru bölüme kadar yüklemeniz gerekir.

Gereksinimlerim chm gibi berbat bir ses çıkarıyor. Gereksinimlerimi chm'den modelledim. Ben chm sevmiyorum tek nedeni kod onun mapids ve böyle kullanarak etkileşim yolu nedeniyle. Daha çok benim kod belgelerin içeriğe duyarlı bölümüne erişmek için kullanabileceğiniz düz metin listesi (benim için otomatik olarak oluşturulan) depo kullanmak.

Html çıkış dosyaları üzerinden gidip sadece bulduğu anahtar kelimelerin bir listesini içeren bir dizin sayfası oluşturmak bir komut dosyası hayal ediyorum. Açıkçası, şu gibi kelimeleri görmezden gelmek için sözcük dışlama mekanizması olmalıdır: bu bölümün yazılması nispeten kolay olacaktır. İkinci bölüm, bir anahtar kelime veritabanını ve html metni içindeki konumlarını bir araya getirmek için bir tür betiğe ihtiyaç duyar. Bu tarayıcı içinde arama mekanizması sağlamak ile birlikte zor bir parçası olacağını düşünüyorum.

Alternatiflerle ilgili her türlü fikir takdir edilecektir. Bir yerde bir web sunucusunda barındırılan bir wiki veya statik html sayfaları kümesi kullanmak isterim, ancak kritik bir çevrimdışı kullanım gereksinimimiz var. Html'yi yerel sürücüye yerleştirmek, bize ihtiyacımız olan arama gereksinimlerini sağlamaz.

DÜZENLE:

Madencilik endüstrisi tarafından kullanılan yazılımlar tasarlıyorum. Bir sürü maden çok uzak ve anlamlı bir şekilde internete erişimi yok. Pdf veya html veya chm ile ilgili yanlış bir şey yoktur (yaşlanması dışında). Eğer doğru yerde bir pdf dosyası görüntüleyebilseydim (örneğin, içeriğe duyarlı yardım) bunu kullanırdım. Neredeyse kendi yazmak için cazip - temelde taşınabilir bir wiki olurdu. Bundan bahsetmek gerekirse, taşınabilir wiki önerirseniz - bu araçları kullanma konusunda hiçbir deneyimi olmayan son kullanıcıyı düşünmeniz gerekir. Ölü basit olmalı. Bu chm güzelliği, çalışmak için bir acı ama son kullanıcılar gibi.

HTML yerine DocBook XML biçimlendirmesinde yardımınızı yazmaya hazırsanız, DocBook Web Yardımı üretme desteğine sahiptir: http://wiki.docbook.org/WebHelp

WebHelp belgeleri aynı zamanda çıktının bir demosudur: http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html

Size aşağıdakileri içeren Web tabanlı bir HTML yardım biçimi sağlar:

• Şununla tam metin araması:
  • İngilizce, Fransızca ve Almanca için kaynaklanıyor. Bir stemmer uygulanarak diğer diller için gövde desteği eklenebilir.
  • Lucene arama motorunun kodunu kullanarak Çince, Japonca ve Korece desteği.
  • Aranan terimin sonuçlarda nerede göründüğünü gösteren arama vurgulama.
  • Arama sonuçları hedefin kısa tanımlarını içerebilir.
• İçindekiler bölmesi ile katlanabilir TOC ağacı.
• İçerik bölmesinin ve TOK'nun otomatik senkronizasyonu.
• TOC ve arama bölmesi çerçeve kümesi kullanılmadan uygulanır.
• Çıktı üretmek için bir Ant build.xml dosyası.

RoboHelp'in yaratıcıları başka şeylere devam ettiler ve daha iyi bir alternatif yapmak için geri döndüler. MadCap Flare'ye göz atın - çeşitli çıktı biçimlerini destekler, bir dizin oluşturur ve yerel olarak (JavaScript aracılığıyla) çalışan bir arama işlevi sağlar.

Adobe RoboHelp'i çeşitli çevrimdışı yardım belgeleri stilleri oluşturmak için kullanıyoruz . İçerik için birçok çıktı ve entegrasyon seçeneği sunar. Bu araçla ilgili en iyi şey, onu geliştiricilere verememeniz ve çözümünüze entegre edilen az çaba ile harika içerik elde etmenizdir.

CHM'nin kendisi yaşlanıyor ve Microsoft daha yeni şeylere de geçti: http://msdn.microsoft.com/en-us/library/bb164608(v=vs.80).aspx

Ancak, yardımınızı mevcut bir sisteme dönüştürmekten gerçekten kaçınmak istiyorsanız ve statik yardım dosyalarında nasıl arama ve anahtar kelime araması sağlayacağınızı arıyorsanız, iki fikir vardır:

• belgelere sahip bir web sitesi sunmak için projeye yalnızca localhost tabanlı küçük bir HTTP sunucusu ekleyin. Sorunlar, bu HTTP sunucusunu ne zaman veya nasıl başlatacağınız / durduracağınız ve / veya çalışmaya devam edeceğinizdir. Bir alternatif, özel bir URL şeması uygulamak olabilir, ancak bu sizi bir tarayıcıya bağlar ve çok daha fazla çalışmadır ( ve söyleyebilirim )

• bir JavaScript arama motoru yazın. Herhangi bir tarayıcıdaki JavaScript bugünlerde oldukça hızlı ve performans gösteriyor. Bir anahtar kelime dizini JSON'da kolayca saklanabilir ve yerel dosyalar üzerinde oldukça iyi sonuçlar veren düzenli ifadeler çalıştırdım.

Aradığım şey, yazılımımızla çevrimdışı kullanılabilen bir şeydir (bu çok önemlidir, çünkü kullanıcılarımızın çok azı çok uzak yerlerde bulunmaktadır).

Şirketimizde RoboHelp kullanıyoruz ve sık sık ağ erişimi olmayan alanlardan kullanıcılara sahip olmadığımız için yardım dosyalarını çevrimdışı hale getirmekte iyi şanslar sunuyoruz.

Aranabilir olmalı ve belirli girişlerin çağrılmasını sağlayan bir mekanizmaya sahip olmalıdır

Bir ekrandaki belirli alanların kullanımını açıklamak için RoboHelp'teki bazı sayfaları kullanıyoruz. Bir tıklamadan sonra görünen alanlar için pop-up'larımız olabilir. RoboHelp ayrıca çok güzel bir arama yeteneğine ve otomatik olarak oluşturulmuş bir dizine sahiptir. Her zaman onunla aramada iyi şanslar yaşadım. Bu sizin için büyük bir endişe olmayabilir, ancak RoboHelp'in kullanımı oldukça kolay bir program olduğu için herkesin belgeleri güncellemesini sağlayabiliriz.