Как нынче принято делать хелп?
От: temnik Россия  
Дата: 17.03.23 18:20
Оценка:
У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает. Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.
Так куда податься, что нынче в моде для справки?
Лучший хостинг от 4 евро, VPS от 6 евро, разные локации, оплата картами без проблем, скидки до 20%.
50 бесплатных смс
Re: Как нынче принято делать хелп?
От: sqrt  
Дата: 17.03.23 18:28
Оценка:
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает. Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.

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

PDF, если оффлайн и контекстную справку по F1 не нужно показывать.
Re: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 17.03.23 18:32
Оценка:
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM.


У меня тоже.

T>увидел, что в win 11 он не работает.


Все отлично работает.

T>Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.


Если там "Zone.Identifier", то он и в XP работать не будет.
Re: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 17.03.23 18:37
Оценка: +1
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает. Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.

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

Что значит не работает? Не открывает или открывает пустой файл.

Я на win11 открыл первый попавшийся chm всё работает.
Re[2]: Как нынче принято делать хелп?
От: temnik Россия  
Дата: 17.03.23 18:48
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>Что значит не работает? Не открывает или открывает пустой файл.


Пустой, только содержание есть. Ссылку посмотрел. У меня нет вкладки Безопасность в свойствах. Но все равно — это ж не дело, если у юзера будет такая же фигня.
Лучший хостинг от 4 евро, VPS от 6 евро, разные локации, оплата картами без проблем, скидки до 20%.
50 бесплатных смс
Re[3]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 17.03.23 18:53
Оценка:
Здравствуйте, temnik, Вы писали:

T>не дело, если у юзера будет такая же фигня.


Не дело, но для предотвращения этого есть более адекватные методы, чем смена CHM на что-то более другое.
Re[4]: Как нынче принято делать хелп?
От: temnik Россия  
Дата: 17.03.23 19:10
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>Здравствуйте, temnik, Вы писали:


T>>не дело, если у юзера будет такая же фигня.


ЕМ>Не дело, но для предотвращения этого есть более адекватные методы, чем смена CHM на что-то более другое.


Ну тогда скажи уж — какие? Как сделать, чтобы chm работал без плясок с бубном?
Лучший хостинг от 4 евро, VPS от 6 евро, разные локации, оплата картами без проблем, скидки до 20%.
50 бесплатных смс
Re[5]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 17.03.23 19:16
Оценка:
Здравствуйте, temnik, Вы писали:

T>Как сделать, чтобы chm работал без плясок с бубном?


Удалить из него поток Zone.Identifier, который виндовые средства добавляют при копировании файла "снаружи". Или просто не допускать его создания, копируя файл не через CopyFile и подобное, а через CreateFile/ReadFile/WriteFile или сишные средства.
Re[6]: Как нынче принято делать хелп?
От: temnik Россия  
Дата: 17.03.23 20:06
Оценка:
ЕМ>Удалить из него поток Zone.Identifier, который виндовые средства добавляют при копировании файла "снаружи".

Это круто. Но у моего файла справки нет Zone.Identifier. Как и у файлов других приложений. И нет вкладки Безопасность в свойствах. Хотя, может, конечно, виновата кастомная сборка винды.

В общем, вижу только вариант перехода на pdf.
Лучший хостинг от 4 евро, VPS от 6 евро, разные локации, оплата картами без проблем, скидки до 20%.
50 бесплатных смс
Отредактировано 17.03.2023 20:07 temnik . Предыдущая версия .
Re[7]: Как нынче принято делать хелп?
От: bnk СССР http://unmanagedvisio.com/
Дата: 17.03.23 20:15
Оценка:
Здравствуйте, temnik, Вы писали:


ЕМ>>Удалить из него поток Zone.Identifier, который виндовые средства добавляют при копировании файла "снаружи".


T>Это круто. Но у моего файла справки нет Zone.Identifier. Как и у файлов других приложений. И нет вкладки Безопасность в свойствах. Хотя, может, конечно, виновата кастомная сборка винды.


Там же выше ссылка на статью. Эта проблема существует только для файлов, скачанных пользователем из интернета (со времен Windows XP),
и решается нажатием кнопки "разблокировать" в свойствах файла (в обычных свойствах по правой кнопке)

Отредактировано 17.03.2023 20:20 bnk . Предыдущая версия . Еще …
Отредактировано 17.03.2023 20:19 bnk . Предыдущая версия .
Отредактировано 17.03.2023 20:18 bnk . Предыдущая версия .
Re[8]: Как нынче принято делать хелп?
От: temnik Россия  
Дата: 17.03.23 20:28
Оценка:
bnk>Там же выше ссылка на статью.

Там же выше я написал, что у меня нет вкладки Безопасность в Свойствах. Имел ввиду нет лейбла Security и чекбокса Unlock.

И в принципе тема не о том, как разблокировать, а о том — чем лучше всего делать справку.
Лучший хостинг от 4 евро, VPS от 6 евро, разные локации, оплата картами без проблем, скидки до 20%.
50 бесплатных смс
Отредактировано 17.03.2023 20:33 temnik . Предыдущая версия . Еще …
Отредактировано 17.03.2023 20:32 temnik . Предыдущая версия .
Re[7]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 17.03.23 20:38
Оценка:
Здравствуйте, temnik, Вы писали:

T>у моего файла справки нет Zone.Identifier.


Что выдает Streams?

T>может, конечно, виновата кастомная сборка винды.


Сама по себе сборка виновата быть не может — никто не заменяет в сборках один код на другой. Виноваты могут быть только настройки. Если Вам надо, чтоб работало не в Вашей системе, а у пользователей, то и проверять нужно в тех системах, что используют они.

T>В общем, вижу только вариант перехода на pdf.


Если на Вашей сборке возникнут проблемы с PDF, на что будете переходить дальше?
Re[8]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 17.03.23 20:39
Оценка:
Здравствуйте, bnk, Вы писали:

bnk>Эта проблема существует только для файлов, скачанных пользователем из интернета


Не только из интернета — из любого "наружного" источника, включая локальную сеть, Shared Folders в виртуалках и т.п.
Re[9]: Как нынче принято делать хелп?
От: bnk СССР http://unmanagedvisio.com/
Дата: 17.03.23 20:46
Оценка: +1
Здравствуйте, temnik, Вы писали:

T>Там же выше я написал, что у меня нет вкладки Безопасность в Свойствах. Имел ввиду нет лейбла Security и чекбокса Unlock.


Ну значит это какая-то другая болезнь.
Мы о том, что для CHM ничего не изменилось со времен Windows XP. У меня распоследняя Windows 11 22H2, CHM открывается без проблем.
Re[10]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 17.03.23 22:04
Оценка:
Здравствуйте, bnk, Вы писали:

bnk>У меня распоследняя Windows 11 22H2, CHM открывается без проблем.


У меня в основном продукте хелп в CHM, жалоб на проблемы с ним не было уже много лет — с тех пор, как добавил удаление Zone.Identifier.
Re[8]: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 17.03.23 23:03
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

T>>В общем, вижу только вариант перехода на pdf.


ЕМ>Если на Вашей сборке возникнут проблемы с PDF, на что будете переходить дальше?

hh -decompile outdir srcfile.chm

И потом браузером html-и смотреть

Вообще надо текстовый readme.txt или lookme.mp4
Re: Как нынче принято делать хелп?
От: TailWind  
Дата: 18.03.23 01:37
Оценка: +1 -1
T>Так куда податься, что нынче в моде для справки?

HTML конечно
Зачем справка в программе, делайте на сайте
Отредактировано 18.03.2023 1:45 TailWind . Предыдущая версия .
Re: Как нынче принято делать хелп?
От: Слава  
Дата: 18.03.23 05:06
Оценка: +2
Здравствуйте, temnik, Вы писали:

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


В меню About — Help делают открытие URL сайта, где должна быть справка, но сейчас её нету. Там показывают шапку на треть экрана, снизу попап про accept our cookies на треть экрана и малозаметным крестиком, а справа выводят анимированный баннер с corporate art от Пикассо. Ссылки на документацию на сайте нет, она находится только поиском в гугле на другом сайте.

Вот что нынче в моде для справки.

PS: сделайте CHM и отдельно простой единый HTML-файл с оглавлением в начале и папочкой files с картинками рядом.
Re: Как нынче принято делать хелп?
От: JustPassingBy  
Дата: 18.03.23 07:14
Оценка: +1
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает.


У меня в chm, и в Windows 11 все работает. Менять ничего не планирую. Справка дополнительно присутствует в PDF и онлайн версиях на сайте, но chm удобен для использования в самой программе.
Re[9]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 18.03.23 08:21
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>hh -decompile outdir srcfile.chm

_>И потом браузером html-и смотреть

Зачем?
Re[2]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 18.03.23 08:23
Оценка:
Здравствуйте, TailWind, Вы писали:

TW>Зачем справка в программе, делайте на сайте


Конечно, разве ж может случиться такое, чтоб у пользователя любой программы в какой-то момент не оказалось интернета?
Re[3]: Как нынче принято делать хелп?
От: Sharowarsheg  
Дата: 18.03.23 08:27
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

TW>>Зачем справка в программе, делайте на сайте


ЕМ>Конечно, разве ж может случиться такое, чтоб у пользователя любой программы в какой-то момент не оказалось интернета?


Вопрос цены. Или пользователи, у которых нет интернета, или знание, в каких местах люди смотрят хелп. Технически, можно удовлетворить и тех, и других, сделав локальную копию и открывая её (по кнопке F1 ну или как там), если интернета нет.
Re[4]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 18.03.23 08:36
Оценка:
Здравствуйте, Sharowarsheg, Вы писали:

S>сделав локальную копию и открывая её (по кнопке F1 ну или как там), если интернета нет.


Если есть локальная копия, для чего вообще может потребоваться отсылка в интернет из программы?

Документация в интернете нужна для тех, кто придет к ней по ссылкам из интернета же — хоть с сайта, хоть из поисковика.
Re[5]: Как нынче принято делать хелп?
От: Sharowarsheg  
Дата: 18.03.23 09:21
Оценка: +2
Здравствуйте, Евгений Музыченко, Вы писали:

S>>сделав локальную копию и открывая её (по кнопке F1 ну или как там), если интернета нет.


ЕМ>Если есть локальная копия, для чего вообще может потребоваться отсылка в интернет из программы?


Для того, чтобы узнать, по каким аспектам программы люди хотят хелп чаще всего.
Если вдруг окажется, что одна из страниц требуется в 10 раз чаще, то это обычно хорошая причина переделать интерфейс.
Конечно, интерпретации зависят от программы, но мне кажется, что грех не пользоваться.
Re[6]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 18.03.23 09:29
Оценка:
Здравствуйте, Sharowarsheg, Вы писали:

S>Для того, чтобы узнать, по каким аспектам программы люди хотят хелп чаще всего.


Для этого гораздо лучше подходит сбор статистики самой программой, а не веб-сервером, на который она будет давать ссылки, приправленные информацией о пользователе и его локальной ситуации. Делать это через веб — откровенно коряво.
Re[7]: Как нынче принято делать хелп?
От: Sharowarsheg  
Дата: 18.03.23 09:34
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

S>>Для того, чтобы узнать, по каким аспектам программы люди хотят хелп чаще всего.


ЕМ>Для этого гораздо лучше подходит сбор статистики самой программой, а не веб-сервером, на который она будет давать ссылки, приправленные информацией о пользователе и его локальной ситуации. Делать это через веб — откровенно коряво.


Да, если есть сбор статистики, то это не нужно.

Хотя ссылки можно информацией и не приправлять, кроме одного ?source=program-date да и всё.

Статистика в программе, конечно, хорошо.
Re: Как нынче принято делать хелп?
От: opfor  
Дата: 18.03.23 15:03
Оценка: +1
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает. Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.

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

Как пользователь, если у меня возникает вопрос по продукту — спрашиваю у гугла, желания копаться во встроенной документации (с корявым поиском) обычно нет, а гугл подсказывает ответ обычно сразу. В приложение можно встроить tutorial при первом запуске программы, остальное — велком на сайт (еще полезно для SEO).
Кто-то еще пользуется встроенными "справками"?
Re: Как нынче принято делать хелп?
От: Khimik  
Дата: 18.03.23 17:33
Оценка:
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает. Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.

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

Я вывел всю справку в html на сайте программы. По-моему это логично, т.к. будут чаще находить программу через гугление.
"Ты должен сделать добро из зла, потому что его больше не из чего сделать". АБ Стругацкие.
Re[2]: Как нынче принято делать хелп?
От: Aquilaware  
Дата: 18.03.23 22:18
Оценка: +1
Здравствуйте, opfor, Вы писали:

O>Кто-то еще пользуется встроенными "справками"?


Пользуюсь и тем и тем. Преимущество встроенных в том, что они остаются даже когда производитель софта отправляется на Марс.

Считаю, что устанавливаемый софт по-возможности должен предостовлять и ту и другую опцию. А если в целом — то веб удобнее конечно. На него и сослаться в переписке можно, и поисковиком хорошо индексируется.
Re[10]: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 19.03.23 10:50
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>Здравствуйте, kov_serg, Вы писали:


_>>hh -decompile outdir srcfile.chm

_>>И потом браузером html-и смотреть

ЕМ>Зачем?


А затем что бы так не делать:

[hh-en.reg]
Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\HTMLHelp\1.x\ItssRestrictions]
"MaxAllowedZone"=dword:00000004
[hh-en.cmd]
@echo off
reg import hh-en.reg /reg:32
reg import hh-en.reg /reg:64

Более того на сетевых дисках и веб сервере оно может в squashfs лежать, который жмёт не хуже.
Re[11]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 19.03.23 11:23
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>А затем что бы так не делать:


А я так не делаю, но у меня "все работает".
Re: Как нынче принято делать хелп?
От: velkin Удмуртия https://kisa.biz
Дата: 19.03.23 12:05
Оценка: +1
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает. Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.

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

Можно использовать.
1. Обычный html, как в программе, так и на сайте.
2. Версию для печати, такую как pdf, как в программе, так и на сайте.
3. Контекстно зависимую справку, вроде Qt (qch) или что-то такое, кнопка ? или клавиша F1, только в программе.

В начале тысячелетия chm был неплохим вариантом.

А сейчас можно получить.
1. При открытии файла ничего не откроется, будет пусто.
2. Откроется, но ссылки не будут работать.
Особенно такое поведение характерно для других платформ отличных от Windows.

Опять же в наше время некоторые люди используют справочную систему, вроде одной папки с кучей html файлов прямо в таком виде.
index.html
somehelp.html
anyhelp.html
myhelp.html
otherhelp.html
...

Ведь chm это просто Compiled HTML, который из некогда полезного инструмента превратился в то, что мешает.

Можно вообще всю документацию запихнуть в один html файл. Я даже такое больше люблю, так как тут и полный локальный поиск Ctrl+F в браузере и сразу всё видно. Больше книги всё равно вряд ли напишешь, а браузер такое обрабатывает очень быстро.
Re[8]: Как нынче принято делать хелп?
От: temnik Россия  
Дата: 19.03.23 12:23
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>Здравствуйте, temnik, Вы писали:


T>>у моего файла справки нет Zone.Identifier.


ЕМ>Что выдает Streams?


Выдает — "The specified volume does not support streams."

ЕМ>Если на Вашей сборке возникнут проблемы с PDF, на что будете переходить дальше?


Ну, pdf можно открыть любым браузером. А вот пока я искал инфу про Zone.Identifier — попадалось много сообщений от разработчиков, что пользователи жалуются на chm, что он пустой. То есть эта проблема существует не только у меня. Формат, который тут работает, а тут не работает — плохой формат.

Идея со справкой на сайте тоже хорошая. Лишнее продвижение в поиске. При необходимости локальной работы можно файлы справки устанавливать вместе с программой и в программу встроить какой-нибудь webview и показывать в нем справку, или в браузере по умолчанию открывать.

Я не то, чтобы очень хотел переделывать, просто сейчас выпускаю новую версию после длительного перерыва и изменения очень значительные и все равно справку придется переделывать полностью. Вот и хочу найти лучший вариант.
Лучший хостинг от 4 евро, VPS от 6 евро, разные локации, оплата картами без проблем, скидки до 20%.
50 бесплатных смс
Re[2]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 19.03.23 12:24
Оценка:
Здравствуйте, velkin, Вы писали:

V>Особенно такое поведение характерно для других платформ отличных от Windows.


То есть, другие платформы еще более корявы? Так-то, хоть в винде, хоть где-то еще, достаточно было бы блокировать в недоверенных chm-файлах активное содержимое и внешние ссылки, чтобы они перестали представлять опасность. Но нет, надо было заблокировать целиком. Непонятно только, почему не додумались так же блокировать любые контейнеры — ведь в них может содержаться что-то вредоносное.

V>chm это просто Compiled HTML, который из некогда полезного инструмента превратился в то, что мешает.


Это не "он превратился", это винда запоганилась.
Re[9]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 19.03.23 12:38
Оценка:
Здравствуйте, temnik, Вы писали:

T>Выдает — "The specified volume does not support streams."


У Вас все это на FAT32?

T>pdf можно открыть любым браузером.


Не "любым", а лишь достаточно свежим. Сейчас, конечно, мало осталось людей со старыми браузерами, но нарваться можно.

T>вот пока я искал инфу про Zone.Identifier — попадалось много сообщений от разработчиков, что пользователи жалуются на chm, что он пустой.


Потому и выглядит пустым, что в него записывается Zone.Identifier.

T>эта проблема существует не только у меня.


Разумеется, ей больше двадцати лет.

T>Формат, который тут работает, а тут не работает — плохой формат.


Вам уже несколько раз объяснили, что формат ни при чем. Дело в интерпретаторе формата, который с некоторых пор стал распознавать пометку "файл небезопасен". Если эту пометку снять, проблема исчезает.

T>можно файлы справки устанавливать вместе с программой и в программу встроить какой-нибудь webview и показывать в нем справку, или в браузере по умолчанию открывать.


Если считаете, что городить все это будет проще, чем однократно снять пометку с CHM — ради бога.
Re[10]: Как нынче принято делать хелп?
От: temnik Россия  
Дата: 19.03.23 14:03
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>У Вас все это на FAT32?


Хуже — APFS

ЕМ>Вам уже несколько раз объяснили, что формат ни при чем. Дело в интерпретаторе формата


И мне, и клиенту, у которого будет то же самое — глубоко фиолетово, кто виноват. Важно, что не работает.

ЕМ>Если считаете, что городить все это будет проще, чем однократно снять пометку с CHM — ради бога.


Ну как же ее снять-то?
Лучший хостинг от 4 евро, VPS от 6 евро, разные локации, оплата картами без проблем, скидки до 20%.
50 бесплатных смс
Re[11]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 19.03.23 14:19
Оценка: +1
Здравствуйте, temnik, Вы писали:

T>Хуже — APFS


То есть, у Вас винда как-то сбоку прикручена к макоси, и Вы используете эту конфигурацию в качестве эталонной, оценивая на ней поведение Ваших продуктов у пользователей?

T>И мне, и клиенту, у которого будет то же самое — глубоко фиолетово, кто виноват. Важно, что не работает.


Если Вы будете проверять и отлаживать продукты, предназначенные для пользователей винды, на такой химере, рискуете столкнуться с неработой и других вещей.

T>Ну как же ее снять-то?


На NTFS — удалить из файла дополнительные потоки. На FAT32 их нет, поэтому этой проблемы там не возникает. Как это делать в нестандартных конфигурациях вроде Вашей — не знаю.
Re[12]: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 19.03.23 14:24
Оценка: :)
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>А я так не делаю, но у меня "все работает".

А вы с сетевого диска попробуйте.
Re[13]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 19.03.23 14:49
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>А вы с сетевого диска попробуйте.


Чтоб получилось "доктор, если я делаю вот так (изображает сложное движение), то мне больно"?

Ежели кто-то хочет запускать софт с сетевого диска, то CHM здесь вообще ни при чем. В таких случаях нужно начинать с грамотной настройки режимов безопасности, после чего и CHM автоматически будет работать правильно.
Re[14]: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 19.03.23 19:01
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>Ежели кто-то хочет запускать софт с сетевого диска, то CHM здесь вообще ни при чем. В таких случаях нужно начинать с грамотной настройки режимов безопасности, после чего и CHM автоматически будет работать правильно.

Ну хз. Такая лажа только в винде.
Re[15]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 19.03.23 19:31
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>Такая лажа только в винде.


А где еще есть сочетание активного содержимого во вроде бы "обычных документах" и многоуровневая политика безопасности?
Re[16]: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 20.03.23 04:56
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>А где еще есть сочетание активного содержимого во вроде бы "обычных документах" и многоуровневая политика безопасности?

Вся таже лажа есть в pdf и оглавление и активное содержимое и embedded файлы и много еще чего, но не все умеют это готовить.
Re[17]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 20.03.23 10:03
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>Вся таже лажа есть в pdf и оглавление и активное содержимое и embedded файлы и много еще чего


Если на то пошло, оно есть и в DOC/DOCX/XLS/XLSX. Но в винде нет встроенной поддержки этих форматов, как и PDF. Поэтому вопросы их безопасности закономерно не входят в компетенцию самой системы.
Re: Как нынче принято делать хелп?
От: qaz77  
Дата: 20.03.23 17:10
Оценка: +1
Здравствуйте, temnik, Вы писали:
T>Так куда податься, что нынче в моде для справки?

Для довольно крупной десктопной программы для Windows мы 10 лет назад начали уходить от HLP и CHM.
Решено было опираться на html, что позволило основную массу материалов использовать как в оффлайн версии, так и на сайте.
В этом проекте используется разветвленный DSL с полутора десятком модулей и множеством функций в каждом модуле.
Поэтому поместить все в один файл — выглядело неудобно и объем был бы десятки мегабайт, что тормоза при загрузке с сайта.
Для понимания масштабов: на 2023 год там почти 5000 файлов общим размером 40 мегабайт (html + картинки).

Второй вопрос был в том, как организовать навигацию по этой документации сравнимую хотя бы HtmlHelp/CHM.
Т.е. требовались: содержание в виде дерева, алфавитный указатель, полнотекстовый поиск.
Причем было очевидно, что для оффлайн версии документации и онлайн нужны будут различные реализации всего этого.
Плюс для оффлайн версии нужна еще связка с контекстами программы, чтобы работала F1 и т.п.

В итоге для оффлайн версии решили сделать обвязку вокруг WebBrowser2,
строить самим содержание, алфавитный указатель и индексы для полнотекстового поиска.
Бонусом получилось использовать событие BeforeNavigate2, где можно обрабатывать клики по любым ссылкам в html.
Это позволило по ссылкам в документации дергать функции программы. Например, описание фичи Foo и тут же ссылка "Включить фичу Foo в программе прямо сейчас".
Но сам принцип не упирается в WebBrowser2 (IE). Можно взять Chromium или какую-нибудь рендерилку html полегче.
Для построения индексов полнотекстового поиска взяли CLucene (он, к сожалению заброшен с 2013).
Остальное запилили сами.

Для генерации онлайн версии документации сделали возможность выгрузки модели документации из оффлайн версии.
А именно: содержания и алфавитного указателя. Полнотекстовый поиск на сайте — средствами гугло-роботов.
Сначала сделали содержание одним XML. Но он оказался около 3 мегабайт и заметно подтормаживал при открытии сайта.
Тогда побили xml-ки на уровни дерева содержания, чтобы подгружались только для развернутых узлов дерева.
А алфавитный указатель — просто статический html с буковками и еще страничка на каждую буковку.
Эти странички генерирует питоновский скрипт из выгруженной в XML модели документации.

Синхронизация онлайн справки и оффлайн делается в один клик: запускается выгрузка оффлайн модели в XML.
Затем питон работает с этим XML, генерирует все, что нужно.
И в итоге заливается на сайт.
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, в котором ссылка на сайт. Вот вам и светлое будущее, нет нормального стандарта для электронной справки.
Re[3]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 20.03.23 21:21
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>А chm это просто архив как zip файл, внутри тот-же html. Был удобен и позволял пользователю, скачав один файл иметь простую структурированную справку.

_>Быстро просто и один файл и ставить ничего не надо.

Почему "было"?
Re[4]: Как нынче принято делать хелп?
От: kov_serg Россия  
Дата: 21.03.23 06:14
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

_>>А chm это просто архив как zip файл, внутри тот-же html. Был удобен и позволял пользователю, скачав один файл иметь простую структурированную справку.

_>>Быстро просто и один файл и ставить ничего не надо.

ЕМ>Почему "было"?

Потому как возникают вопросы на чем же его делать и не появилось ли что-то удобное.
Мелкомягкие его не поддерживают и до сих пор даже не исправили ошибку out of bounds (access violation at 0x453217D8) в индексаторе текста пришлось править вручную
Re[3]: Как нынче принято делать хелп?
От: qaz77  
Дата: 21.03.23 07:31
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>В offline версии милионый html файлов справки как у java это прото кошмар. А если еще и учесть около нулевую информативность и жуть при попытке распечатать, то вариант так себе.

_>Другая крайность это документация по автомобилям сотни тысяч html которые ссылаются на лежащие неподалёку pdf-ки где собственно основное жир и лежит, причем желательно сканированный.

Чисто на html — да, кошмар. Приходилось мне ковыряться в документации SDK OpenOffice...

В нашем варианте пользователь и не знает, что у него где-то эти тысячи html лежат.
Он не работает с ними напрямую, а через окно наподобие HtmlHelp.
Например, нажимает F1 — открывается окно справки с нужной страничкой.

_>Все эти толпы файлов для offline очень удобно копируются на флешку (примерно вечность).

Нет такой необходимости.
Эти файлы один раз инсталлятор пишет на комп пользователя при установке продукта.

_>...

Q>>Затем питон работает с этим XML, генерирует все, что нужно.
Q>>И в итоге заливается на сайт.
_>Если пользователь хочет offline вариант, то выкачивать весь сайт, править скриптами и складывать в chm?

Нет, это не про пользователя. Если пользователю нужно установить оффлайн доки, то скачивается дистрибутив продукта и выбирается компонент для установки "Документация" — все.
Про питон — это я описал внутренний технологический этап преобразования оффлайн версии доков в онлайн.

Есть репозиторий с html и картинками. Сначала на него натравливается программа, которая строит модель:
содержание, алфавитный указатель и проч.
Далее эта модель записывается в XML.
Этот XML читает питоновский скрипт и генерирует онлайн-специфик вещи, которых нет в исходном репозитории.
И его выхлоп уже заливается на сайт.

_>Короче ужас со всех направлений.

Не согласен.
10 лет полет нормальный.
Удобнее, чем было с CHM.
Отредактировано 21.03.2023 7:38 qaz77 . Предыдущая версия . Еще …
Отредактировано 21.03.2023 7:33 qaz77 . Предыдущая версия .
Re[5]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 21.03.23 08:04
Оценка:
Здравствуйте, kov_serg, Вы писали:

_>Потому как возникают вопросы на чем же его делать и не появилось ли что-то удобное.


У многих такие вопросы возникают по принципу "оно ж очень старое, должно быть что-то новое", когда к функциональности внятных претензий нет.

_>Мелкомягкие его не поддерживают и до сих пор даже не исправили ошибку out of bounds (access violation at 0x453217D8) в индексаторе текста


Насколько она распространена? Я на своих ни разу не видел.
Re: Как нынче принято делать хелп?
От: Matrix_Failure http://matrixfailure.wordpress.com/
Дата: 25.03.23 15:52
Оценка:
Здравствуйте, temnik, Вы писали:

T>У меня всегда был CHM. Сейчас только увидел, что в win 11 он не работает. Посмотрел несколько программ, которыми пользуюсь — тоже chm, тоже не работает.

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

Программы для создания справок сейчас мультформатные. Например отечественный drexplain. И сгенерят и chm и pdf и прилично выглядящий html в виде папки для выкладывания на хостинг (имхо обязательный вариант чтобы через Гугл искалось).

Для меня вопрос в другом: мы измеряем частоту открытия справки юзерами из программы — и она неуклонно падает и уже довольно крошечная.

Наверное ищут сразу в поиске или в ютубе решение проблемы, а скоро будут спрашивать chatgpt.
Re[2]: Как нынче принято делать хелп?
От: Евгений Музыченко Франция https://software.muzychenko.net/ru
Дата: 25.03.23 16:07
Оценка: +1
Здравствуйте, Matrix_Failure, Вы писали:

M_F>мы измеряем частоту открытия справки юзерами из программы — и она неуклонно падает и уже довольно крошечная.

M_F>Наверное ищут сразу в поиске или в ютубе решение проблемы, а скоро будут спрашивать chatgpt.

Меня тоже давно удивляло, почему народ упорно роет интернет, спрашивает в чатах/форумах то, что достаточно подробно изложено в документации, и легко может быть найдено поиском по ключевым словам. Потом сообразил, что большинство ищет не информацию, а готовое решение. Лень превыше всего.
Re[3]: Как нынче принято делать хелп?
От: JustPassingBy  
Дата: 25.03.23 21:47
Оценка:
Здравствуйте, Евгений Музыченко, Вы писали:

ЕМ>Меня тоже давно удивляло, почему народ упорно роет интернет, спрашивает в чатах/форумах то, что достаточно подробно изложено в документации, и легко может быть найдено поиском по ключевым словам. Потом сообразил, что большинство ищет не информацию, а готовое решение. Лень превыше всего.


Как вариант, люди часто сталкивались с плохой документацией, поэтому легче сразу запрос в поисковик делать, чем лезть хз куда. К документации обратятся, если поиск в интернете не поможет. По хорошему, поиск и должен приводить на html версию документации на сайте разработчика. В реальности, конечно, между неудачным поиском в интернете и документацией будет этап с обращением в саппорт.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.