Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Объединение CHM
 
Ищу среду создания файлов помощи в разных форматах с такими требованиеми: есть (1) CHM справка для разработчиков, генерится отдельной тулзой, (2) глобальный проект помощи, который содержит различные кастомные (вручную написанные) разделы помощи. Файл (1) должен быть включен/вложен/импортирован под определенной мной нодой в TOC помощи. Т.е. при генерации помощи из проекта (2) в нужный формат (на сейчас нужны CHM и HTML для онлайн помощи) файл (1) должен также попасть в сгенерированную помощь.
Т.к. файл (1) в CHM формате, DrExplain должен распаковать его на HTML файлы и вложить в результирующую сгенерированную справку.
Файл (1) будет строится при каждой сборке проекта, поэтому импортнуть его содержимое в отдельный проект (если DrExplain это позволяет) без авто-обновления содержимого - не вариант.

Вопрос: DrExplain позволяет это сделать?
 
Чего?  :D
 
Добрый день, Arm.

Боюсь, Dr.Explain такую хитрую схему не потянет.
Посмотрите в сторону более сложных систем - Flare, RoboHelp и т.д. Хотя не уверен, что и они полностью потянут такую схему именно в том виде, в котором вы ее описали. Больше всего сомнений в возможности распаковывать CHM на лету на этапе компиляции основной справки и "некоряво" встраивать контент из него в финальный документ. Хотя, все может быть в этом мире.
 
Цитата
arm пишет:
Ищу среду создания файлов помощи в разных форматах с такими требованиеми: есть (1) CHM справка для разработчиков, генерится отдельной тулзой, (2) глобальный проект помощи, который содержит различные кастомные (вручную написанные) разделы помощи. Файл (1) должен быть включен/вложен/импортирован под определенной мной нодой в TOC помощи. Т.е. при генерации помощи из проекта (2) в нужный формат (на сейчас нужны CHM и HTML для онлайн помощи) файл (1) должен также попасть в сгенерированную помощь.
Т.к. файл (1) в CHM формате, DrExplain должен распаковать его на HTML файлы и вложить в результирующую сгенерированную справку.
Файл (1) будет строится при каждой сборке проекта, поэтому импортнуть его содержимое в отдельный проект (если DrExplain это позволяет) без авто-обновления содержимого - не вариант.

Вопрос: DrExplain позволяет это сделать?
Я думаю, что CHM все равно генерируется из HTML и должны быть HTML-исходники? Поэтому вряд ли должны возникнуть проблемы с импортом. Вот, другой вопрос я не очень поняла. Т.е., у вас есть TOC, который хочется тоже "встроить" в проект?
techwriter.ru.com
 
Если проще, то у меня есть рукописный файл помощи (1), в который я хочу автоматически встроить другой CHM (2), сгенерированный Sandcastle help file builder-ом. Я могу генерить html для второго CHM, но как мне встроить эти страницы в проект (1) так, чтобы при изменении (добавлении/удалении) новых страниц в (2) они автоматически попадали в TOC файла (1)?
Цель в том, чтобы генеря при каждом билде файл(ы) (2) он автоматически встраивался в результирующий файл (1) под определенной нодой в дереве TOCа.
Честно говоря удивлен, что этот довольно простой сценарий не поддерживается системами генерации справок. Тем более, что CHM это всего лишь ZIP с определенным форматом.
 
Цитата
arm пишет:

Если проще, то у меня есть рукописный файл помощи (1), в который я хочу автоматически встроить другой CHM (2), сгенерированный Sandcastle help file builder-ом. Я могу генерить html для второго CHM, но как мне встроить эти страницы в проект (1) так, чтобы при изменении (добавлении/удалении) новых страниц в (2) они автоматически попадали в TOC файла (1)?
Цель в том, чтобы генеря при каждом билде файл(ы) (2) он автоматически встраивался в результирующий файл (1) под определенной нодой в дереве TOCа.
Честно говоря удивлен, что этот довольно простой сценарий не поддерживается системами генерации справок. Тем более, что CHM это всего лишь ZIP с определенным форматом.

Думаю, что это слишком сложная схема. Но, возможно, решение есть. Правда, я его не вижу.
CHM на сегодняшний день устаревший формат. Но периодически его поддерживают. Я тоже в данный момент делаю самописный CHM, пока средство разработки справок других электронных форматов в закупке. По моим прогнозам, в скором будущем его вообще перестанут разрабатывать и поддерживать.
Изменено: techwriter - 23.11.2014 19:49:22
techwriter.ru.com
 
Глючил форум. не сохранилось мое пятничное сообщение. Суть была в том, что можно распаковать CHM любым архиватором.
Цитата
arm пишет:
Честно говоря удивлен, что этот довольно простой сценарий не поддерживается системами генерации справок.
Смотря какими системами. И правда, это довольно простой сценарий: в билд-скрипт добавить 2 шага 1) распаковать CHM в нужную папку, 2) добавить в toc все полученные html файлы (или не все) и продолжить генерацию билд-скрипта.
Изменено: ADVANCED - 24.11.2014 13:27:58
 
Да, видимо придется самому возится с декомпиляцией CHM. Всем спасибо.
 
К сожалению, в полностью автоматическом режиме без использования сторонних утилит сделать это не получится. Можно поступить следующим образом:
1) Создаете проект-заготовку в Dr.Explain. Настраиваете все пути, стили, форматирование и т.п. Открываете раздел, в качестве подразделов которого будете импортировать CHM-файл позднее и сохраняете проект. Сделайте резервную копию (на всякий случай).
2) Перед тем, как собрать финальный CHM или HTML, делаете копию этого проекта, открываете копию в Dr.Explain и находите нужный раздел, щелкаете по нему правой кнопкой мыши и выбираете "Добавить->Импортировать внешние файлы" из выпадающего меню. Указываете ваш CHM-файл и проводите импорт. Получаете проект, в котором часть разделов написана вами, а другая часть - импортирована из CHM-файла.
3) Далее проверяете правильность импортирования, делаете экспорт в нужные форматы и закрываете проект не сохраняя (или можно сохранить под отдельным именем файла, чтобы потом можно было что-нибудь подправить).

Если хронических проблем с импортом нет, можно какой-нибудь программой автоматизации воспользоваться, чтобы она сама имитировала щелчки мыши и нажатия на кнопки в окнах, например, AutoIT.
Изменено: izogfif - 26.11.2014 19:24:38 (Добавлена информация об автоматизации.)
 
Делюсь опытом: Innovasys Document!X + HelpStudio полностью покрывают мои требования, плюс имеют много очень полезного и удобного функционала. На самом деле Helpstudio мне не пригодился (он для импорта из сторонних скомпилированных форматов справок, экспорта в пдф и командной работы). Но документ!Х шикарен. Советую.
 
а что там шикарного? ;)
 
Ну например, мне нужно документировать .NET продукт для программеров. Раньше я настраивал шаблон в sandcastle help build, авто-генерил доку её же доку продукта, затем эту доку нужно было как-то (почему вопрос и возник) встроить в головнУю документацию, где были всякие Хау Ту и т.п. Все что я видел споткнулось на последнем шаге. Док!Х же позволяет парой кликов добавить .NET сборку (.dll) в проект, генерит девелоперкую доку для этой сборки, позволяет вставить эту доку в любую ветку общей документации, позволяет перелинковать вручную написанные топики с автосгенеренной докой, полностью интегрирует метаданные (ToC, search, index, keywords,...) автосгенеренной доки в результирующий файл(ы) помощи,.....
Не говоря уже, что кастомизировать ДокХ-страницы помощи можно как угодно (виджеты, кастомные CSS, редактирование в редакторе/напрямую html + делать превью (видеть результат без компиляции). Вобщем вместо десятка костылей получаешь один продукт. Да, он стоит 500 баксов, но я уже через 20 минут педалил доку, которую не мог придумать как сделать/собрать дня 3.
Страницы: 1
Читают тему