Создание Help-а для своих программ

Приемы и подходы, обмен опытом

Модераторы: Screw, larin

Ответить
Peter
партнер
Сообщения: 28
Зарегистрирован: Пт, 19/10/2007 11:49
Имя Фамилия: Петр Кузьмин
Откуда: ЗАО "Галактика Про"
Контактная информация:

Создание Help-а для своих программ

Сообщение Peter »

Не нашел описание процесса создания справки в документации.
Этот вопрос в руководсиве по разработе полностью обойден.
Есть ли инструкция?

В данный момент мы скопировали последовательность действий из исходников. Справка по F1 работает, но нет понимания зачем что делается. Например не получается работать с файлом справки с названием отличным от Partner, не находит топик.

В asdk.chm написано "Практика присвоения идентификаторов тем подсказки из кода считается устаревшей и в дальнейшем поддерживаться не будет".
Как делать правильно?

Вобщем много непонятного, помогите разобраться.
Зада стоит такая: некоторые свои программы, которые того стоят, оснастить хелпом по F1 как в стандартных.
natkl
топ-софт
Сообщения: 2
Зарегистрирован: Пн, 10/03/2008 10:40
Имя Фамилия: Наталья Климович
Откуда: ТопСофт
Контактная информация:

Сообщение natkl »

1) Подключение файлов справки с названием, отличным от Partner, является нетривиальной и достаточно трудоемкой задачей.
Имеются ТИ по разработке и подключению модульной help-системы для сторонних разработчиков.
При необходимости подключения справки за рамками партнерского модуля прошу более детально сформулировать задачу (для выяснения целесообразности работ). mailto:Natallia.Klimovich@galaktika.by

2) Подключение Help средствами конфигуратора поддерживалось в версии 8.0.
На текущий момент (в версии 8.10, начиная с Атлантис 5.03.20, asdk.chm изд. 2008 года) конфигуратор help-контекстов не применяется, а используется практика подключения из кода. Подробнее смогут рассказать сотрудники отдела системных проектов
Leontiev
топ-софт
Сообщения: 16
Зарегистрирован: Чт, 24/01/2008 16:40
Имя Фамилия: Денис Леонтьев
Откуда: Галактика Софт
Контактная информация:

Сообщение Leontiev »

По поводу использования конфигуратора.
В asdk написано абсолютно правильно.
Конфигуратор подсказок делался как раз для создания возможности разделения труда между программистами и документаторами. Программисты программируют, документаторы пишут хелпы и расставляют привязки. Именно такая схема и применяется для сопровождения справочной системы для Support и Atlantis.
Как иллюстрация: недавно вышли обновления SupHelp 5.3.21 и AtlHelp 5.3.21. Никто из программистов никаких топиков в коде не расставлял и не менял - все от начала и до конца сделано в отделе тестирования и документирования. Более того, начиная с версии Atlantis 5.3.14 эти компоненты целиком и полностью создаются и сопровождаются документаторами, в отделе системных проектов они даже не компилируются.
Peter
партнер
Сообщения: 28
Зарегистрирован: Пт, 19/10/2007 11:49
Имя Фамилия: Петр Кузьмин
Откуда: ЗАО "Галактика Про"
Контактная информация:

Сообщение Peter »

Слава богу, хоть с этим вопросом разобрались.
Осталось выяснить, как заставить работать хелп, если появится новый модуль (т.е. файлы New.res, New.hlp, New.cnt)? Неужто все так сложно и необходимо выпустить новую версию Галактики?
cruger
топ-софт
Сообщения: 566
Зарегистрирован: Пт, 21/09/2007 15:19
Имя Фамилия: Фёдор Терсин
Откуда: Галактика Софт
Контактная информация:

Сообщение cruger »

Новая версия Галактики не нужна, но изменения в галактических хелп-файлах нужны. Дело в том, что формат winhlp справки подразумевает наличие главного cnt-файла из которого есть ссылки на все остальные, и на который тоже все ссылаются. Этот файл - galnet.cnt.
Peter
партнер
Сообщения: 28
Зарегистрирован: Пт, 19/10/2007 11:49
Имя Фамилия: Петр Кузьмин
Откуда: ЗАО "Галактика Про"
Контактная информация:

Сообщение Peter »

Инклуд в galnet.cnt сделали, наш раздел в общей справке есть.
Вопрос в том что пока файлики называются Partner.res, Partner.hlp, Partner.cnt все замечательно работает, но стоит их назвать Partner2.res, Partner2.hlp, Partner2.cnt, то при нажатии F1 не находится наш топик, при этом в общем меню справки наш раздел попрежнему виден. Отсюда и вопрос про новый модуль.
cruger
топ-софт
Сообщения: 566
Зарегистрирован: Пт, 21/09/2007 15:19
Имя Фамилия: Фёдор Терсин
Откуда: Галактика Софт
Контактная информация:

Сообщение cruger »

на эту тему наталья уже написала
Ответить