Блог

    Caché (Кашэ́) — промышленная высокопроизводительная, объектная система управления базами данных, интегрированная с технологией разработки веб-приложений. Единая архитектура данных Caché позволяет разработчикам использовать одновременно объектный, реляционный (SQL) и прямой (NoSQL) доступ к одним и тем же данным, хранение которых обеспечивается ориентированным на транзакции многомерным ядром СУБД.

    http://www.intersystems.ru/cache/

Последние записи


Теги

Информация

Расширение встроенной документации

добавлено: 02 мар 12
понравилось:0
просмотров: 2335
комментов: 2

теги:

Автор: servit

Этот же пост доступен и на хабре.

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

Поскольку встроенная документация основывается на стандарте DocBook v4.0, есть возможность её преобразования в другие форматы: HTML, PDF, RTF и др.
На русском про DocBook можно почитать, например, здесь:udev.zip — файл с примером статьи, повторяющей "Ресурсы для разработчиков".

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

1) запустите терминал Caché и перейдите в область "DOCBOOK":

zn "DOCBOOK"

2) выполните команду:

do ##class(DocBook.Utils).Load("C:\Articles\UDEV.xml")

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

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

Прочитать "вновь прибывшую" статью не составит труда даже для krvsa

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

Картинка с другого сайта.

Картинка с другого сайта.

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

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

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

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 (рус.)

Комментарии


  • 05 марта 2012, 20:04 Шваров Евгений

    А можно ли таким образом создавать документацию для приложения, сделанного на Сache?

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

    Если имелось в виду автоматическое создание статей на основе комментариев классов, методов, свойств и т.д. используемого приложения, то, конечно, это можно сделать.
    Для этого есть соответствующие классы пакета "%Dictionary": [url=http://docs.intersystems.com/cache20121/csp/docbook/DocBook.UI.Page.cls?KEY=GORIENT_ch_lib#GORIENT_lib_class]Programmatic Access to Class Information[/url].



Необходимо войти на сайт, чтобы оставлять комментарии