Wieloplatformowe narzędzia do tworzenia narzędzi dla użytkowników końcowych

Question

Jakie są dobre narzędzia do tworzenia narzędzi do tworzenia wieloplatformowych plików pomocy dla użytkowników końcowych? (Nasza aplikacja korzysta z frameworku Qt, jeśli to robi jakąkolwiek różnicę.)

Uwaga: Nie interesuje mnie wewnętrzna dokumentacja API - do tego używamy doxygen.

Idealnie rozwiązanie byłoby:

• Pozwól nam zarządzać całą zawartość pomocy (tekst, spisu treści, zdjęć, etc.) w jednym miejscu.
• Wyprowadzanie do rodzimych formatów pomocy. (CHM dla Windows - lub przynajmniej coś, co moglibyśmy podać bezpośrednio w interfejsie API pomocy HTML, nie mamy pewności, jakie są standardowe formaty pomocy dla innych platform.)
• Przyzwoite wsparcie dla trybu WYSIWYG: obsługa typowych wpisów tekstowych, obrazów, przekrojów referencje itp. z łatwością, ale możemy edytować kod HTML, gdy zajdzie taka potrzeba.
• Format pliku tekstowego dla projektu pomocy (XML, itp.), Aby mógł być wersjonowany w Subversion.
• Wszelkie haki, które pomagają utrzymać synchronizację z rzeczywistą bazą kodów, będą świetne. (Być może w jakiś sposób temat pomocy jest powiązany z plikiem kodu i można sprawdzić Subversion, aby zobaczyć, czy zostały wprowadzone jakieś zmiany i oznaczyć temat jako "prawdopodobnie nieaktualny" ... czy ja śnię?)
• Treść pomocy może być zlokalizowane.
• Nie przeciwstawia się produktowi komercyjnemu, ale opcja bezpłatna byłaby miła.

Powiem dalej i zrobię to wiki i zacznę od kilku przykładów. Głosuj na nich lub w dół, jeśli masz z nimi doświadczenie i zostaw kilka komentarzy. Dodaj również dodatkowe narzędzia.

Answer 1

Właśnie odkryłem Sphinx; Myślę, że się zakochałem.

• Lepsze niż WYSIWYG nad HTML: reStructuredText
• wyjść do QtHelp (między innymi), więc będzie łatwo rozpowszechniać (i zintegrować) w naszej aplikacji.
• Nie jestem jeszcze pewien co do lokalizacji, ale przekroczymy ten most, kiedy zajdzie taka potrzeba.
• Był łatwy do skonfigurowania i "po prostu działa"; wygląda profesjonalnie.

Answer 2

Robohelp

Answer 3

Help & Manual

Answer 4

Jedyne, co znam, to Latex, jeden z konwerterów latex2html, a następnie kilka adaptacji, aby przygotować gotowy HTML do archiwizatora CHM.

• tekst, html, chm, pdf, ps bez problemu.
• Konwersja do Word za pomocą RTF była katastrofą, nie znamy aktualnego stanu.
• konwertery lateksowe 2 html, podczas gdy kilka, wszystkie mają swoje własne problemy.
• Pliki PDF wyglądają doskonale.
• możliwe WYSIWYM (przez LYKS).

To archiwum ma kilka CHMS tamtędy (zwłaszcza części prog, sygn i użytkowników, reszta (RTL, FCL, LCL) są generowane przez nasz własny odpowiednik doxygen, fpdoc)

http://www.stack.nl/~marcov/doc-chm.zip

Należy zauważyć, że powyższe parametry CHM są tworzone za pomocą naszego własnego (przenośnego) kompilatora CHM. Tak, nie więcej warsztatów.

dokument Lyx jako PDF i HTML:

pdf: http://www.stack.nl/~marcov/buildfaq.pdf

html: http://www.stack.nl/~marcov/buildfaq/

Answer 5

Użyłem RoboHelp lat.

Jest w porządku, ale podstawowa technologia jest bardzo stara. Również sposób, w jaki blokują wersje programu Word, to całkowita PITA (i zmusiła mnie do kilkukrotnego uniknięcia aktualizacji MS Office).

Posuwamy się do szalonych pochodni http://www.madcapsoftware.com/products/flare/robohelp.aspx

Answer 6

myślę DocBook adresy wszystkich Wymagania wyjątkiem ewentualnie haków synchronizację, która Pomyślę trochę dalej. Jest to w istocie podzbiór XML zaprojektowany do tworzenia dokumentacji i jest bezpłatny i open source. To tylko format i zestaw transformacji wyjściowych XSL, które przekształca Docbook w bardziej użyteczne formaty (HTML, a więc CHM, JavaHelp, PDF przez XML-FO lub Tex).

Oznacza to, że nadal trzeba wybrać narzędzie do tworzenia XML, aby faktycznie je edytować, aby takie rzeczy jak WYSIWYG zależały od funkcji oprogramowania do tworzenia XML. Używamy Syntext Serna, ponieważ ma dobre wsparcie dla WYSIWYG i wbudowanego edytowania XML #includes (nikt inny nie wydaje się wspierać tego ostatniego). Możesz znaleźć inne narzędzia do authoringu XML, które będą lepiej odpowiadały Twoim potrzebom - Serna jest rozsądną cenowo ofertą komercyjną.

Docbook zapewnia dużą elastyczność dzięki profilowaniu, który umożliwia dołączanie/wykluczanie elementów XML na podstawie ich atrybutów. Przykładowymi przypadkami użycia będą nieco inne wyjścia pomocy dla systemu operacyjnego = Windows niż OS = Linux. Lokalizacja jest również obsługiwana poprzez profilowanie i inne mechanizmy.

Dość dobrze introduction to Docbook można znaleźć here.

Używamy Docbook do naszego formatu pomocy i kompilujemy go do plików CHM, które zawierają pomoc tylko dla funkcji związanych z konkretnym produktem (np. Edycja Enterprise ma funkcje, które nie są w wersji Standard lub Demo). Odpowiednie kroki to:

1. Przeprowadź profilowanie szablonów XSL na źródle XML (używając np. XSLTproc).
2. Uruchom szablony XSL HTML-Help na wyjściu 1.
3. Skompiluj wyjściowe pliki HTML za pomocą Microsoft HTML Help Compiler (HHC).