0 Members and 1 Guest are viewing this topic.
Ибо в реалиях сегодняшнего дня такой способ распространения выглядит откровенно архаичным и создаёт ощущение, будто мы всё ещё живём во времена Windows 98
единственная беда всех CHM - примитивный поиск
CHM
Мне как WEB разработчику привычен онлайн формат, поэтому привык использовать документацию прямо в браузере и в этом есть свои плюсы, ибо там удобнее поиск, проще ориентироваться между версиями библиотек, а ещё есть возможность запускать код в песочнице и сразу проверять примеры из доки, что сильно ускоряет изучение. Кроме того, web-документация проще обновляется и лучше интегрируется с поиском и современными инструментами разработки по сравнению с CHM.
А я не люблю такие CHM (а PDF и подавно), где жётско прописаны bgcolor="#FFFFFF", из-за этого приходится ставить галочку в "Свойства обозревателя…" — Оформление — "Не учитывать цвета, указанные на веб-страницах" (или может в политиках каких ещё что-то), хотя и это изредка приводит к небольшим неудобствам… Особо тяжёлые случаяи, когда определённые .chm запрещают hh отображать нужные элементы окна (кнопки или какие-нибудь панели) — вроде и попался какой-то "редактор" таких "атрибутов", но что-то мне им не удалось исправить такие .chm`ки (чаще они вообще ломались), и, соответственно, выходит как у "старого доброго .hlp" — даже страницу никак не отмасштабировать! HTML (для банального просмотра в ишаке) в этом плане хотя бы предпочтительнее, но, вспоминая, как погано оно сделано у LibreOffice, то не знаю, что лучше Не идеальный и .h1s (да и инструментов для их создания нет в открытом доступе — ждём слива исходиков висты/7ки, да и с их "открытием" такая же проблема, как со справкой VisualStudio 2005/2008), но этот хотя бы интереснее, да и поприятнее чтоль… MSHelp2 — наихудший сценарий Я не против DOS-варианта (да даже для qh, хотя я его тоже не понимаю…), но лучше, чтоб можно было читать прямо из-под консольного FreePascal IDE
а ещё есть возможность запускать код в песочнице и сразу проверять примеры из доки, что сильно ускоряет изучение.
А если по делу? Чем CHM неудобен?
The AIMP Software Development Kit (SDK) historically included a compiled HTML help (.chm) file for offline documentation, though modern versions transition toward web-based documentation and header-file comments.
Сам-то CHM как формат - особо ничем, но вот с софтом для него - есть заметные проблемы. В винде его открывает специальный просмотрщик, всё ещё поддерживаемый MS даже в вин11. На других платформах его, очевидно, нет. Например, для линукса (на примере arch) я нашёл только один всё ещё рабочий вариант из примерно вот такого списка предлагаемых гуглом опций:okular - несмотря на информацию из поиска и, особенно, от назойливых нейросетей, уже не поддерживает chm.xchm - во многом не поддерживает (или игнорирует?) форматирование. Читать можно, но блоки текста регулярно смешиваются в кучу (например, когда таблицами идут описания аргументов или enum-ов).archmage, chm-to-pdf, chm2pdf и так далее - конвертеры в другие форматы. Тут, в зависимости от формата, теряются гиперссылки, оглавление и прочее. Плюс, часть из них ещё надо сперва запустить.просто распаковать chm и открывать браузером - почти те же минусы, что и при конвертировании.kchmviewer - тот самый рабочий вариант. Но он, похоже, скорее мёртв, чем жив, и в последний раз трогался автором несколько лет назад, из-за чего может требовать танцы с бубном в актуальных дистрибутивах.Возможно, есть смысл рассмотреть более доступные/открытые форматы и выбрать что-то, что будет удобно со всех сторон?.. Например, как вариант, писать справку в markdown и обрабатывать чем-то типа Material for MkDocs. Исходный маркдаун можно читать даже в репке на гитхабе, полученный статичный HTML можно как выкладывать онлайн, так и прикладывать к SDK. При этом не нужны особые инструменты ни автору (маркдаун можно писать в чём угодно), ни пользователям (найти браузер нынче всё-таки проще, чем читалку chm); в сгенерированном HTML будут удобные оглавление с поиском, а исходный маркдаун при желании можно собирать и в другие форматы (да хоть md->html->chm).PS: забавно, что бесполезный нейропоиск гугла ссылается на эту тему, заявляя, что...
Для Linux версии у нас идёт просто набор HTML-ек.
Так SDK же один, разве нет?.. Я вижу только один архив, в котором заголовки, примеры и документация в виде двух chm (en и ru). Я что-то не то качаю?
