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

Спасибо за статью по расширению документации Servit.

Если вы также хотите поделиться своим опытом с другими разработчиками Cache,  присылайте нам свои материалы.

В Cach? есть замечательная возможность добавлять свои статьи во встроенную документацию:
http://docs.intersystems.com/cache20081/csp/docbook/DocBook.UI.Page.cls?KEY=GDOC_using
Таким образом можно создавать полезные статьи и встраивать их прямо в СУБД. Можно даже создавать документацию
относящуюся не только к Cach?, Ensemble, DeepSee и т.д., но и внутреннюю корпоративную документацию с удобной
навигацией, расширенным поиском по ней.

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

udev.zip – файл с примером статьи .

Для её установки требуется:
1) в терминале перейти в область “DOCBOOK”:
zn “DOCBOOK”
2) выполнить команду Do ##class(DocBook.Utils).Load(“C:\XMLDOC\UDEV.xml”)
Ваш путь к файлу может быть другим;
3) Всё! Теперь Вы можете открыть документацию по адресу (правильная ссылка есть в документации):
http://localhost:57772/csp/docbook/DocBook.UI.Page.cls?KEY=KNBASE, найти загруженную статью и прочитать её.
Прочитать “вновь прибывшую” статью не составит труда даже для krvsa ;)

Теперь для любителей встроенной документации на русском языке. Если есть энтузиазм и время, то можно собственными
силами сделать и перевод. Для этого потребуется:
1) в терминале перейти в область “DOCBOOK”:
zn “DOCBOOK”
2) экспортировать все книги и статьи в заданный каталог:
Do ##class(DocBook.Utils).XMLExportAll(“C:\XMLDOC”,1)
Ваш каталог может быть другим;
3) собственно перевести содержимое сгенерированных файлов;
4) импортировать всё из заданного каталога:
Do ##class(DocBook.Utils).LoadDir(“C:\XMLDOC”)
5) наслаждаться чтением документации на родном языке.

Для тех, кто хочет посмотреть как это выглядит “вживую” есть скриншоты:

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

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

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

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