Re[2]: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 20.03.23 18:41
Оценка:
Здравствуйте, qaz77, Вы писали:

T>>Так куда податься, что нынче в моде для справки?


Q>Для довольно крупной десктопной программы для Windows мы 10 лет назад начали уходить от HLP и CHM.

Q>Решено было опираться на html, что позволило основную массу материалов использовать как в оффлайн версии, так и на сайте.
В offline версии милионый html файлов справки как у java это прото кошмар. А если еще и учесть около нулевую информативность и жуть при попытке распечатать, то вариант так себе.
Другая крайность это документация по автомобилям сотни тысяч html которые ссылаются на лежащие неподалёку pdf-ки где собственно основное жир и лежит, причем желательно сканированный.
Все эти толпы файлов для offline очень удобно копируются на флешку (примерно вечность).
...
Q>Затем питон работает с этим XML, генерирует все, что нужно.
Q>И в итоге заливается на сайт.
Если пользователь хочет offline вариант, то выкачивать весь сайт, править скриптами и складывать в chm?

Короче ужас со всех направлений. HLP упакованный rtf и мелкософт активно от него пытается закопать, так что winhlp приходится свой таскать.
А chm это просто архив как zip файл, внутри тот-же html. Был удобен и позволял пользователю, скачав один файл иметь простую структурированную справку.
Быстро просто и один файл и ставить ничего не надо. Не считая за%бов с сетевыми дисками и дырами с безопасностью пока является образцом того что хотел пользователь. (Если не считать того что utf он не умеет)
Но нет они сделали лучше: 3-ю версию, которая в состав студии входит. Улучшили так что лучше было бы хорошо. Для просмотра был сторонний просмотрщик, но чуда не случилось стало еще более неудобно.
Другие прямо ходячие обезьяны XML предлагают изначально как убер документ из которого можно генерировать вАаЩе уСё (скриптами конечно, XSLT и т.п.). Всё очень удобно и хорошо но нет стандартного подхода, сложно, нет поиска и простого способо посмотреть, да и фалов чуть больше чем дофигища.
Другой вариант epub — тот же xhtml упакованный zip-ом, смотреть можно электронными книгами и внешними просмотрщиками, довольно широко распространен. Есть вменяемые viewer-ы, которые не загружают по 300-600Мб dll-ок при старте и не выглядят как гавно ужос.
Как ни странно pdf умеет всё то же что и chm, даже индексы для полнотекстового поиска умеет, но его в таком разрезе не пользует никто.
Для онлайна конечно куча вариантов есть https://devdocs.io/ для офлайна https://zealdocs.org/ и Devhelp но это chm всё равно не заменит.

В итоге приходим к readme.txt, в котором ссылка на сайт. Вот вам и светлое будущее, нет нормального стандарта для электронной справки.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.