Conteúdo de Folha de Apontamentos

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Este ponto de extensão é utilizado para registar configuração de conteúdo de folha de apontamentos. As folhas de anotações surgem como opções do menu "Ajuda" ou da vista de folha de apontamentos e são normalmente utilizadas para auxiliar o utilizador ao longo de várias tarefas complexas, de forma a atingir o objectivo geral.

As folhas de anotação estão organizadas em categorias que normalmente reflectem o domínio de um determinado problema. Por exemplo, um plug-in direccionado para Java pode definir uma categoria designada "Java", que é adequada a folhas de anotações que auxiliem o utilizador em qualquer uma das ferramentas Java. As categorias definidas por um plug-in podem ser referenciadas por outros plug-ins, utilizando o atributo category de um elemento cheatsheet. As folhas de anotações que não pertencem a uma categoria, bem como as folhas de anotações com caminhos de categoria inválidas, acabarão na categoria "Outra".

As folhas de anotações podem especificar, opcionalmente, um subelemento description cujo corpo deve conter um texto breve descritivo da folha de apontamentos.

<!ELEMENT extension (category | cheatsheet | taskEditor | taskExplorer)>

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

Um elemento category no ponto de extensão cheatsheetContent cria uma nova categoria no menu de folha de apontamentos. O menu de folha de apontamentos está disponível no menu de ajuda da área de trabalho. Caso seja especificada uma nova categoria, as folhas de anotações podem destinar-se a essa categoria e irão aparecer na mesma na caixa de diálogo de selecção da folha de apontamentos.



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED

composite   (true | false) "false">

Um elemento cheatsheet é colocado no ponto de extensão cheatsheetContent, caso haja uma folha de apontamentos para contribuir para a área de trabalho. Um elemento de folha de apontamentos deve especificar um id, um nome traduzível para aparecer nas opções de selecção, um id de categoria para especificar qual a categoria na qual esta folha de apontamentos será incluída e um ficheiro de conteúdo. O ficheiro de conteúdo de folha de apontamentos é um ficheiro XML que descreve os passos e acções que a folha de apontamentos tem.



<!ELEMENT description (#PCDATA)>

uma descrição breve da folha de apontamentos



<!ELEMENT taskEditor EMPTY>

<!ATTLIST taskEditor

id    CDATA #REQUIRED

class CDATA #REQUIRED

icon  CDATA #REQUIRED>

Este ponto de extensão é provisional, uma vez que se baseia na classe de API provisional TaskEditor. O ponto de extensão taskEditor permite que o UI personalizado surja na área da janela do editor de uma página de anotações composta. Qualquer tarefa que esteja numa página de anotações composta, cujo tipo corresponde ao id desta extensão, irá utilizar a classe definida neste ponto de extensão para criar a área do editor.



<!ELEMENT taskExplorer EMPTY>

<!ATTLIST taskExplorer

id    CDATA #REQUIRED

class CDATA #IMPLIED

icon  CDATA #IMPLIED

name  CDATA #REQUIRED>

Este ponto de extensão é provisional, uma vez que se baseia na classe de API provisional TaskExplorer. Este ponto de extensão permite que a contribuição de um explorador de tarefas, que será utilizado ao abrir uma página de anotações composta.



De seguida é apresentado um exemplo de utilização do ponto de extensão 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>

Consiste num pequeno texto da descrição da folha de apontamentos do utilizador.

</description>

</cheatsheet>

</extension>

Para obter mais detalhes, consulte a especificação do pacote de API org.eclipse.ui.cheatsheets API.

Não existem folhas de anotações incorporadas.