В СУБД Caché есть возможность встраивать свои материалы в стандартную документацию с помощью методов класса DocBook.Utils.
Таким образом можно создать собственную корпоративную документацию с возможностью удобной навигации и расширенным поиском по ней.
Поскольку встроенная документация основывается на стандарте DocBook v4.0, есть возможность её преобразования в другие форматы: HTML, PDF, RTF и др.
На русском про DocBook можно почитать, например, здесь:
Почему DocBook?
DocBook. Коротко.
udev.zip — файл с примером статьи, повторяющей "Уголок разработчика".
Шаги для установки и открытия статьи-примера:
- запустите терминал Caché и перейдите в область «DOCBOOK»:
zn "DOCBOOK"
- выполните команду:
do ##class(DocBook.Utils).Load("C:ArticlesUDEV.xml")
Примечание: Ваш путь к файлу может быть другим;
- откройте в браузере локальную онлайн-документацию и найдите загруженную статью в разделе "Technical Articles".
Скриншоты статьи в портале документации:
Любителям встроенной документации на родном языке
Если есть энтузиазм и время, то можно собственными силами сделать и её перевод.
Для этого потребуется:
- в терминале перейти в область «DOCBOOK»:
zn "DOCBOOK"
- экспортировать все существующие книги и статьи в заданный каталог:
do ##class(DocBook.Utils).XMLExportAll("C:XMLDOC",1)
Примечание: Ваш каталог может быть другим;
- собственно перевести содержимое сгенерированных файлов;
- импортировать из заданного каталога всё обратно:
do ##class(DocBook.Utils).LoadDir("C:XMLDOC")
Скриншоты русифицированной документации:
PS: для удобной разработки и публикации документации Вам может пригодиться продукт Arbortext, который используется в самой InterSystems:
www.ptc.com/products/arbortext/ (англ.)
www.pro-technologies.ru/product/Arbortext (рус.)
Автор: servitRM