Contenido de hoja de apuntes

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Este punto de extensión permite registrar contribuciones de contenido de hoja de apuntes. Las hojas de apuntes aparecen como opciones en el menú "Ayuda" o en la vista de hojas de apuntes, y se utilizan generalmente para asistir al usuario en una serie de tareas complejas destinadas a alcanzar un objetivo global.

Las hojas de apuntes están organizadas por categorías que generalmente reflejan el dominio de un problema en particular. Por ejemplo, un conector orientado a Java puede definir una categoría llamada "Java", que sea apropiada para las hojas de apuntes que ayudarán al usuario en alguna de las herramientas Java. Los conectores pueden hacer referencia a las categorías definidas por otro conector mediante el atributo category de un elemento cheatsheet. Las hojas de apuntes que no pertenecen a ninguna categoría, así como las hojas de apuntes con vías de acceso a categorías no válidas, acabarán en la categoría "Otras".

Las hojas de apuntes pueden especificar opcionalmente un subelemento description cuyo cuerpo debe contener un texto corto que describa la hoja de apuntes.

<!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>

Un elemento category del punto de extensión cheatsheetContent crea una categoría nueva en el menú de hojas de apuntes. El menú de hojas de apuntes está disponible en el menú de ayuda del entorno de trabajo. Si se especifica una categoría nueva, las hojas de apuntes pueden destinarse a esa categoría y aparecerán bajo ella en el diálogo de selección de hojas de apuntes.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED>

Un elemento cheatsheet se coloca en el punto de extensión cheatsheetContent si existe una hoja de apuntes que deba añadirse al entorno de trabajo. Un elemento de hoja de apuntes debe especificar un ID, un nombre traducible que debe aparecer en las opciones de selección, un ID de categoría destinado a especificar en qué categoría se incluirá esta hoja de apuntes y un archivo de contenido. El archivo de contenido de hoja de apuntes es un archivo XML que describe los pasos y acciones que contiene la hoja de apuntes.



<!ELEMENT description (#PCDATA)>

breve descripción de la hoja de apuntes



A continuación figura un ejemplo de utilización del punto de extensión cheatSheetContent:

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Ejemplo de categoría"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Ejemplo de hoja de apuntes"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

Fragmento de texto descriptivo para la descripción de mi hoja de apuntes.

</description>

</cheatsheet>

</extension>

Para obtener más detalles, consulte la especificación del paquete de API org.eclipse.ui.cheatsheets.

No existen hojas de apuntes incorporadas.