Расширение встроенной документации в СУБД Caché

docbook

В СУБД Caché есть возможность встраивать свои материалы в стандартную документацию с помощью методов класса DocBook.Utils.
Таким образом можно создать собственную корпоративную документацию с возможностью удобной навигации и расширенным поиском по ней.

Поскольку встроенная документация основывается на стандарте DocBook v4.0, есть возможность её преобразования в другие форматы: HTML, PDF, RTF и др.
На русском про DocBook можно почитать, например, здесь:
Почему DocBook?
DocBook. Коротко.

udev.zip — файл с примером статьи, повторяющей Разработчику Caché.

Шаги для установки и открытия статьи-примера:

  1. запустите терминал Caché и перейдите в область “DOCBOOK”:
    zn "DOCBOOK"
  2. выполните команду:
    do ##class(DocBook.Utils).Load("C:\Articles\UDEV.xml")

    Примечание: Ваш путь к файлу может быть другим;

  3. откройте в браузере локальную онлайн-документацию и найдите загруженную статью в разделе Technical Articles.

Скриншоты статьи в портале документации:

пример русской документации

пример русской документации

Любителям встроенной документации на родном языке

Если есть энтузиазм и время, то можно собственными силами сделать и её перевод.

Для этого потребуется:

  1. в терминале перейти в область “DOCBOOK”:
    zn "DOCBOOK"
  2. экспортировать все существующие книги и статьи в заданный каталог:
    do ##class(DocBook.Utils).XMLExportAll("C:\XMLDOC",1)

    Примечание: Ваш каталог может быть другим;

  3. собственно перевести содержимое сгенерированных файлов;
  4. импортировать из заданного каталога всё обратно:
    do ##class(DocBook.Utils).LoadDir("C:\XMLDOC")

Скриншоты русифицированной документации:


PS: для удобной разработки и публикации документации Вам может пригодиться продукт Arbortext, который используется в самой InterSystems:
http://www.ptc.com/products/arbortext/ (англ.)
http://www.pro-technologies.ru/product/Arbortext (рус.)

Расширение встроенной документации в СУБД Caché: 1 комментарий

  1. Уведомление: Локализация в СУБД Caché | writeimagejournal.com

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *