Как организована документация в Блэкбоксе

Документация на русском языке
Справки по интерфейсам модулей
Документация по конкретному модулю
Общая документация и поиск в ней
Примеры программ

Документация на русском языке

На момент написания данной страницы на русский язык переведено три важнейших документа:

1. Основополагающее "Сообщение о языке Компонентный Паскаль". Оно является справочником для программистов и содержит список формальных правил синтаксиса. Краткость описания (всего около 30 с.), достигнутая благодаря исключительной четкости дизайна языка, делает его <описание> незаменимым документом. 
2. "Отличия Компонентного Паскаля от Паскаля". Документ краткий, но исчерпывающий.
3. "Краткая история Паскаля".

Все три документа автоматически устанавливаются при выполнении русификации (имена документов заканчиваются на _rus.odc). Их можно прочесть из Блэкбокса, если нажать на F1 и в открывшемся окошке кликать на соответствующие гиперссылки (показаны зеленым цветом).

Справки по интерфейсам модулей

Наиболее часто приходится справляться насчет деталей интерфейсов модулей, которыми требуется воспользоваться и назначение которых уже известно. Например, модуль StdLog содержит средства печати в рабочий журнал, причем предусмотрены процедуры для значений разных основных типов языка (INTEGER, REAL и т.д.). Достаточно в любом открытом текстовом документе Блэкбокса (например, в рабочем журнале) написать идентификатор модуля, выбрать его (например, дважды кликнув по нему мышкой) и нажать Ctrl+D (из меню: Инфо --> Клиентский интерфейс; в оригинале Info --> Client Interface). В ответ на это Блэкбокс найдет модуль, выяснит его интерфейс и представит последний в новом окошке в виде текстового документа:

Показаны внешние интерфейсы модуля:

1. все модули, которые импортируются в данный (оператор IMPORT);
2. экспортируемые константы (раздел CONST);
3. экспортируемые переменные (раздел VAR); все они в данном случае экспортируются только для чтения (минусы в качестве значков экспорта после идентификаторов);
4. экспортируемые процедуры вместе с полными описаниями формальных параметров.

В общем случае могут экспортироваться определенные в модуле типы данных (на жаргоне объектно-ориентированного программирования — классы) вместе со связанными с ними процедурами (методами).

После изучения интерфейсов можно искать — если нужно — документацию по конкретной процедуре.

Документация по конкретному модулю

Чтобы открыть документацию по конкретному модулю (если таковая имеется), достаточно в любом открытом текстовом документе Блэкбокса (например, в рабочем журнале) написать идентификатор модуля, выбрать его (например, дважды кликнув по нему мышкой) и выполнить команду меню Инфо --> Документация (в оригинале Info --> Documentation). Блэкбокс найдет соответствующий текст и откроет его в отдельном окошке в режиме браузера; в этом режиме "работают" гиперссылки (см. модуль StdLinks), обычно отмеченные голубым цветом и подчеркиванием.

Об используемых в документации соглашениях можно прочесть в разделе документации Documentation Conventions (нажать F1 и искать там).

Общая документация и поиск в ней

Нажатие F1 в Блэкбоксе открывает (в режиме браузера) документ с гиперссылками, по которым можно найти всю документацию, поставляемую в оригинальной дистрибуции. В русифицированной версии там же добавлены гиперссылки на переведенные документы.

Там же внизу есть мини-диалог для поиска в документации. Например, напечатав там, например, имя модуля StdLog и кликнув по кнопке Искать, получим новое окно с гиперссылками на все модули в папках Docu, где встречается это имя, вместе с указанием того, сколько раз оно там встречается:

Примеры программ

1. Примеры программ "школьного" типа даны в подсистеме Info21 (см. исходные тексты в папке BlackBox\Info21\Mod\).
2. В документации Блэкбокса (F1) содержится целая книга с примерами (Component Software ...).
3. В дистрибуции Блэкбокса есть полные исходные тексты достаточно нетривиальной подсистемы Form (создание и работа с диалоговыми формами).
4. Большое количество весьма нетривиальных примеров поставляется в подсистеме Obx (см. документы в папке BlackBox\Obx\Mod\).
5. Несколько полезных текстов есть в папке BlackBox\Info21sys\Mod\.