Содержимое памятки

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Эта точка расширения служит для регистрации дополнений содержимого памятки. Памятки отображаются как варианты в меню "Справка" или в панели памяток. В них обычно содержатся инструкции для пользователя о какой-либо задаче в рамках общего проекта.

Памятки разбиты по категориям. Обычно одна категория отражает какую-либо конкретную задачу. Например, для модуля, работающего с Java, можно определить категорию с именем "Java", в которой будут находиться памятки по инструментам Java. К категориям, определенным одним модулем, можно обращаться из других модулей с помощью атрибута category элемента cheatsheet. Памятки, не входящие ни в одну категорию, а также памятки с недопустимыми путями к категориям, будут отнесены к категории "Прочие".

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

<!ELEMENT extension (category | cheatsheet)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>

Элемент category в точке расширения cheatsheetContent создает в меню памятки новую категорию. Меню памяток отображается в меню Справка рабочей среды. Если указана новая категория, то в нее можно добавлять памятки. Они будут отображаться в окне выбора памяток.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED>

Если в рабочую среду добавляется памятка, то в точку расширения cheatsheetContent помещается элемент cheatsheet. В элементе cheatsheet должен указываться идентификатор, переводимое имя, отображаемое в вариантах для выбора, ИД категории, в которую включена эта памятка, и файл содержимого. Файл содержимого памятки - это файл в формате XML, описывающий шаги и действия этой памятки.



<!ELEMENT description (#PCDATA)>

краткое описание памятки



Ниже приведен пример использования точки расширения cheatSheetContent:

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Example category"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Example cheat sheet"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

Краткое описание памятки.

</description>

</cheatsheet>

</extension>

Дополнительные сведения можно найти в спецификации для пакета API org.eclipse.ui.cheatsheets.

Встроенных памяток нет.