Средства документирования во Flash MX

Во Флэш МХ встроена неплохая система онлайн-документации. Лучшее свойство этой системы - простота модификации. Программисту, написавшему свой компонент не составит труда сделать по нему справочный файл для дизайнеров (доступный прямо в среде разработки). Именно этим мы сейчас и займемся.

Установка онлайн-документации

Среда разработки Flash MX предоставляет несколько возможностей помощи в работе с кодом ActionScript. Это References, контекстные подсказки, подсвечивание элементов кода, а так же специфические возможности редактирования в режимах Normal и Expert. Информация, необходимая для работы этих инструментов хранится в xml-файлах. Чтобы она стала доступна в среде разработки, достаточно просто поместить эти файлы в специальное место. Это можно сделать вручную. Местоположение папки, в которую должны быть помещены файлы, зависит от операционной системы; находится эта папка в пользовательском профиле ( profile ), там, где хранятся данные установленных программ. Вот несколько примеров для самых распространенных систем (вместо User подставьте имя конкретного пользователя):

Windows 2000 and XP

C:\Documents and Settings\User\Application Data\Macromedia\Flash
MX\Configuration\ActionsPanel\CustomActions

Windows 98 and ME

C:\Windows\Application Data\Macromedia\Flash
MX\Configuration\ActionsPanel\CustomActions

Windows NT

C:\WinNT\Profiles\User\Application Data\Macromedia\Flash
MX\Configuration\ActionsPanel\CustomActions

MAC OS X

Hard Drive:Users:Library:Application
Support:Macromedia:FlashMX:Configuration:ActionsPanel:CustomActions:

Mac OS 9.x (multi-user)

Hard Drive:Users:User:Documents:Macromedia
:FlashMX:Configuration:ActionsPanel:CustomActions:

Установить эти файлы можно также из ActionScript, с помощью метода install объекта CustomActions (пример 12.1).

Рис. 12.1. Методы объекта CustomActions

liftRef_xml = new XML();
liftRef_xml.load("lift.xml");
liftRef_xml.onLoad = function(){
   instSuccess =
      CustomActions.install("lift",liftRef_xml.toString());
      trace(instSuccess);
      trace(CustomActions.list());
}

Этот код устанавливает References и подсказки к классу lift, информация о которых находится в файле lift.xml, а также выводит список установленных компонентов документации ( CustomActions.list() ). После выполнения этого кода в окне Output должен появиться следующий текст

true
UIComponents,UIComponents2,UIComponents2Ref,lift

Строчка " true " - содержимое переменной instSuccess - то, что возвращает метод CustomActions.install в случае успешного выполнения, следующая строчка - список уже установленных компонентов, среди которых появился lift. В панелях Actions и References должны появиться новые папки (информация о них содержится в файле lift.xml).

Рис. 12.2. Установленный компонент в панели Actions или References

В следующих параграфах будет рассмотрен формат xml-файлов, необходимых для работы инструментов онлайн-документации. А пока мы рассмотрим один важный вопрос: можно ли составить документацию на русском языке? Точнее, будет ли она корректно отображаться? Мы вправе этого ожидать, зная, что среда Флэш МХ ориентирована на использование Unicode. И действительно, если файлы справки, сделанные, скажем, в Notepad, сохранять в Unicode, а не в ANSI, Флэш сможет их правильно отобразить. Правда, поначалу файлы могут показываться некорректно; в этом случае придется (кроме сохранения файлов в Unicode) сделать еще одну вещь. В системном реестре откройте ключ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Nls\CodePage, найдите значение 1252 и установите соответствующую ему строчку данных в c_1251.nls. Те, кто много работал, например, с Adobe Photoshop, хорошо знают этот фокус. Для большей надежности можно проделать ту же операцию с аналогичными ключами, расп оложенными не в CurrentControlSet, а в ControlSet001, ControlSet002 и т.д.; впрочем, обычно это не требуется. После этого достаточно закрыть среду Флэш и снова ее запустить; теперь (если только русская локаль у вас настроена правильно) все должно работать.