Translate

субота, 6 квітня 2013 р.

Project тип Blueprint документів


Щоб згрупувати документацію програми для перегляду в переглядачі використовуєтся project тип документу. Кореневим тегом документу є тег project, який має обовязковий підтег name з ім'ям проекту і довільну кількість тегів document і package. Для задання документу використовуєтся тег document з атрибутами name (ім'я документу), file (файл документу який буде відкриватись коли project документ відкриваєтся в переглядачі), page (файл документу який буде відкриватись коли project документ трансформований в html). Документи можуть групуватись у пакети з довільним рівнем вкладеності які описуются тегом package з атрибутом name (ім'я пакету). При відкритті в переглядачі project документ трансформуєтся в HTML сторінку з двома секціями : з ліва буде перелік документів і пакетів у вигляді ссилок, а з права самий документ. При кліку на ссилці буде завантажено відповідний документ для перегляду у правій частині або відкрито пакет з документами у лівій частині сторінки. Документами для перегляду можуть бути не тільки Blueprint документи, а будь-які що відображаются в переглядачі, наприклад документація згенерована через javadoc.
Приклад :
<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href=".blueprint/project.xslt"?>
<!DOCTYPE project SYSTEM ".blueprint/project.dtd">
<project>
  <name>Blueprint Builder</name>
  <document name="proposal" file="proposal.xml" page="proposal.html" />
  <document name="analysis" file="analysis.xml" page="analysis.html" />
  <document name="file operations" file="file_operations.xml" page="file_operations.html" />
  <package name="editing">
    <document name="editing operations" file="editing_operations.xml" page="editing_operations.html" />
    <document name="advanced editing operations" file="advanced_editing_operations.xml" page="advanced_editing_operations.html" />
  </package>

  <package name="options">
    <document name="option operations" file="option_operations.xml" page="option_operations.html" />
    <document name="advanced editing option operations" file="advanced_editing_option_operations.xml" page="advanced_editing_option_operations.html" />
    <document name="advanced window option operations" file="advanced_window_option_operations.xml" page="advanced_window_option_operations.html" />
    <document name="advanced current files option operations" file="advanced_current_files_option_operations.xml" page="advanced_current_files_option_operations.html" />
  </package>
  <document name="window operations" file="window_operations.xml" page="window_operations.html" />
  <document name="blueprint operations" file="blueprint_operations.xml" page="blueprint_operations.html" />
  <document name="static view" file="static_view.xml" page="static_view.html" />
  <document name="code documentation" file="../blueprint/blueprintBuilder_doc/index.html" page="blueprintBuilder_doc/index.html" />
</project>

Вигляд в переглядачі :