Le pagine di aiuto miste forniscono informazioni per la soluzione di problemi complessi, suddividendo il problema in una serie di attività più piccole. Le pagine di aiuto miste sono registrate mediante il punto di estensione org.eclipse.ui.cheatsheets.cheatSheetContent.
The composite cheat sheet content itself is defined in a separate file which conforms to the composite cheat sheet content file specification. Il file di contenuto è un file XML ed è composto da una serie di attività organizzate in gruppi in una struttura ad albero.
<compositeCheatsheet> è l'elemento principale di una pagina di aiuto mista. Avrà una singola attività principale che potrebbe essere <task> o <taskGroup>. Gli elementi <taskGroup> possono disporre di uno o più elementi secondari, e ciascuno di essi può essere <task> o <taskGroup>. <task> non dispone di attività secondarie.
Le attività e i gruppi di attività possono contenere elementi <intro> che contengono il testo da visualizzare prima che l'attività venga avviata ed elementi <onCompletion> che contengono il testo da visualizzare al completamento dell'attività. Sia <intro> che <onCompletion> possono contenere markup di formato testo; nell'esempio seguente sono stati utilizzati i tag <b> e </b> per rendere il testo in grassetto.
Le attività possono contenere anche gli elementi <param>. L'attività pagina di aiuto potrebbe avere uno dei seguenti parametri: "id" è l'ID di una pagina di aiuto registrata, "path" è il percorso relativo o l'URL del file del contenuto della pagina di aiuto e "skipIntro" è un parametro booleano che se impostato su true fa sì che la pagina di aiuto venga avviata al primo punto piuttosto che all'introduzione. "id" e "path" non possono essere specificati contemporaneamente.
Il nodo <dependency> dall'attività "B" all'attività "A" indica che l'attività A deve essere completata affinché l'attività B possa essere avviata.
Se un'attività è di tipo = "cheatsheet", verrà aperta una pagina di aiuto all'avvio dell'attività. Esistono tre possibili parametri per un'attività della pagina di aiuto.
Nome parametro | Descrizione |
id | L'ID di una pagina di aiuto che è stata registrata mediante il punto di estensione org.eclipse.ui.cheatsheets.cheatSheetContent. Esso identifica la pagina di aiuto che verrà associata a questa attività. È necessario specificare l'ID o il parametro path (ma non entrambi). |
path | L'URL di un file di contenuto della pagina della guida. Esso può essere un URL assoluto o un URL relativo al file del contenuto per la pagina di aiuto mista. Se vengono specificati sia l'ID che l'elemento path, l'elemento path verrà utilizzato per individuare il file i contenuto e il parametro id verrà ignorato. |
showIntro | Un parametro booleano con valore predefinito uguale a true. Se il valore è "false", la pagina di aiuto all'avvio visualizzerà la prima operazione invece dell'introduzione. |
The file below is an example of how to create a composite cheat sheet from existing cheat sheets. It shows how to create task groups and make tasks skippable.
<?xml version="1.0" encoding="UTF-8" ?> <compositeCheatsheet name="Composite cheat sheet example"> <taskGroup name= "Composite cheat sheet example"> <intro> This is an example of a <b>composite cheat sheet</b> built from existing cheat sheets. <br/><br/>You can select a task to work on either by following the hyperlinks or by selecting a task in the tree. </intro> <onCompletion>Congratulations you have completed all the tasks.</onCompletion> <task kind="cheatsheet" name= "Branching and merging using CVS" skip="true"> <param name = "id" value = "org.eclipse.platform.cvs_1" /> <intro>This cheat sheet is intended for CVS users. If you are not using CVS or do not intend to branch and merge you may skip this task. </intro> <onCompletion>Congratulations you now know how to branch and merge.</onCompletion> </task> <taskGroup name= "Create Java Projects" kind = "sequence"> <intro> First you will learn how to create a simple java project, then you will create an java project which uses SWT. <br/><br/>This task group is a sequence which means that if you click on the subtask "Standalone SWT Application" it will not let that task be started until "Create a java project" has been completed. </intro> <onCompletion>Congratulations you have built both Java applications.</onCompletion> <task kind="cheatsheet" name= "Creazione di un progetto java" id = "createJavaProject"> <param name="id" value = "org.eclipse.jdt.helloworld"/> <param name="showIntro" value = "false"/> <intro>This cheat sheet walks through the process of creating a simple hello world application. The cheat sheet can launch wizards to create a new project and a new class. </intro> <onCompletion>L'applicazione hello world è stata creata correttamente</onCompletion> </task> <task kind="cheatsheet" name= "Standalone SWT Application"> <intro>I plugin che contribuiscono all'interfaccia utente, utilizzando SWT (Standard Widget Toolkit). Questa attività fornisce ulteriori informazioni su SWT. </intro> <param name = "id" value = "org.eclipse.jdt.helloworld.swt" /> <onCompletion>Congratulations you have succeeded in creating an SWT application.</onCompletion> </task> </taskGroup> </taskGroup> </compositeCheatsheet>
Le pagine di aiuto sono estensibili, anche se in Eclipse 3.2 tale funzionalità e provvisoria e le classi potrebbero essere modificate prima di diventare API. Il supporto per le pagine di aiuto composte può essere ampliato mediante il punto di estensione org.eclipse.ui.cheatsheets.cheatSheetContent che ha due nuovi elementi, taskEditor e taskExplorer che consentono di aggiungere editor e utilità di esplorazione delle attività.
L'aggiunta di editor di attività definisce un nuovo tipo di attività che viene visualizzato nella sezione Dettagli attività. Per aggiungere un editor di attività, implementare una sottoclasse concreta di TaskEditor, quindi aggiungere un elemento taskEditor a plugin.xml.
La rappresentazione di Esplora attività può essere configurata anche con un punto di estensione, una struttura ad albero inclusa con la piattaforma Eclipse. Per impostazione predefinita, l'utilità di esplorazione di una pagina di aiuto mista aperta per la prima volta, è una struttura ad albero; un attributo dell'elemento <compositeCheatSheet> consente di sovrascrivere questa impostazione. Se vengono registrate più utilità di esplorazione, il menu Visualizza conterrà una voce di menu che consente di passare da un'utilità all'altra. Per aggiungere un'utilità di esplorazione di attività, implementare una sottoclasse concreta di TaskExplorer, quindi aggiungere l'elemento taskExplorer a plugin.xml.
Utilizzo delle pagine di aiuto
Working with composite cheat sheets
Creating cheat sheets
Authoring guidelines
Composite cheat
sheet content file specification
org.eclipse.ui.cheatsheets.cheatSheetContent extension point