ADL Workbench Help Page - Getting Started

HomeNext

Initial Configuration

Locate archetype repository

The ADL Workbench will process archetypes found in a "reference repository" directory and an optional "work repository" directory.  Typically the reference repository will be the 'dev' directory in the openEHR Subversion knowledge repository. You only need to specify a work repository if you are developing archetypes yourself; its location may well be in another part of the openEHR Subversion repository, or another version-controlled area used with colleagues, or it can be a private area on your disk.

If both are specified, the archetypes will be merged into a single tree in the ADL Workbench, under a common folder structure, and showing specialisation relationships. To make merging work properly, the directory structure of a work repository must follow that used in the openEHR Subversion knowledge repository.

For both reference and work repositories, the repository location is specified in the Repository Settings dialog, from the Repository menu, as shown in the screen shot. The directory just above the directories you want to see should be chosen.

In the example here, the "dev/adl" directory in a local copy of the  openEHR Subversion knowledge repository (http://www.openehr.org/svn/knowledge) is being chosen for the reference repository, and a directory "dev-nl-tno/adl" as the work repository. 		ADL workbench
Repository setting
If a work repository has been specified along with the reference repository, the appearance of the two groups of archetypes will be as shown in the example. Note that archetypes from the work repository that are specialisations of those in the reference repository will be displayed that way in the tree merge.
 Merged archetype repositories
Merged archetype repositories

Options

Various options are available on the Tools > Options menu selection, as follows:
  • Set External Editor: set the path of an external editor tool for editing archetype source.
  • Show Definition Tree Expanded: if checked, this option causes the node map tree to automatically be expanded when first viewed.
  • Show Line Numbers In ADL Source: if checked, this option causes line numbers to be added to the source views of the archetype, which is useful for finding errors reported by the parser.
  • Parser Error Reporting Level: allows various levels of parser error reporting to be set. The INFO level provides verbose output; WARNING provides only warnings and errors, and ERROR provides errors only. WARNING is typically the most useful setting.
  • HTML Export Directory: indicates where HTML format archetypes should be exported to. The HTML Export function is available on the Repository menu, and causes a directory tree to be created containing a colourised HTML rendering of all archetypes in the repository.
Options dialog
Options Dialog

Menus

The ADL Workbench has the following menus:
  • File menu: 
    • Open: open an archetype manually. Whereas archetypes in the specified archetype repository can be opened and parsed automatically just by single-clicking on the archetype in the explorer, the Open option allows the user to open and parse an archetype somewhere else in the file system. Although this does not disturb ADL Workbench's idea of where the repository is, the manually-opened archetype is displayed in the explorer. If it happens to be an archetype within the repository, then it is simply selected in the explorer; otherwise, it is added to the appropriate place in the explorer tree, based on its semantic category.
    • Parse: manually parse an archetype, usually after doing a Save from an external editor.
    • Edit: use the external editor specified in Options to open the selected archetype.
    • Save As: save the archetype either over the top of the original file, or as a new file. The format is specified by a combo box in the Save dialog.
    • Exit: quit the application.
  • Edit menu: 
    • Copy: copy a selected item to the clipboard; this only works on certain controls such as the path control and text boxes.
    • Select All: select all text in the focussed text box.
    • Clipboard: view current contents of clipboard.
  • Repository:
    • Set Repository: set the archetype repository location (see above).
    • Build All (F7): parse every archetype in the repository not already built.
    • Rebuild All (Shift F7): rebuild all archetypes in the entire repository, regardless of whether they have already been built.
    • Build Subtree (Ctrl F7): parse all archetypes in the subtree under the currently selected node.
    • Rebuild Subtree (Ctrl Shift F7): reparse archetypes in the currently selected subtree, regardless of whether they have already been built.
    • Export HTML: generate HTML files for all archetypes in the repository.
    • Interrupt Build (Ctrl Shift F7): stop building or exporting. This option is enabled only when building or exporting is in progress.
  • History: this feature provides access to the retained history of visiting archetypes.
    • Forward: go forward in the archetype visiting history.
    • Backward: go back in the archetype visiting history.
  • Options:
    • Set Options: set various options, such as the external editor.
  • Help:
    • Icons: list of icons used in the archetype node map, and their meanings.
    • News: latest news for this version of application.
    • Online: access to this online help page.
    • About: "About" information for the ADL Workbench.
 Menus
Menus

$LastChangedDate: $ $LastChangedRevision$