Difference between revisions of "ART Template Editor"

(Creating a link to a template that resides in a BBR)
Line 19: Line 19:
  
 
===Creating a link to a template that resides in a BBR===
 
===Creating a link to a template that resides in a BBR===
Click the [[File:TemplateEditor-linkbutton.png|30px]] button in the Template Viewer. The template repository browser window will open and present you with a dialog with prototypes to base your new template on. These are taken from the building block repositories in the project.
+
Click the [[File:TemplateEditor-linkbutton.png|30px]] button in the Template Viewer. The template repository browser window will open and present you a dialog with templates that reside in all accessible repositories. These are taken from the building block repositories mentioned in the project.
 
[[File:TemplateEditor-RepositoryDialog.png|650px|Repository Dialog]]
 
[[File:TemplateEditor-RepositoryDialog.png|650px|Repository Dialog]]
  

Revision as of 14:59, 5 August 2014

Template Editor Overview

Starting the template editor is done from the ART Template Viewer or the ART Template Associations forms. From those forms you either start a completely new template, create a new version of an existing template, or edit a template. These options are handed as parameters to the Template Editor.

You can only work with the template editor if you are a designated project author.

Templates Plus Button

Creating a new template

On the left hand side of the template viewer you'll find (up to) four buttons as shown in (1).


Click the TemplateEditor-plusbutton.png button in the Template Viewer. The template editor will open and present you with a dialog with prototypes to base your new template on. These are taken from the building block repositories in the project.

Prototype Dialog

Information.svg Please note that you need a reference to one of the prototype building block repository (BBR) in your project in order to see prototypes. The simplest way to do so is to add a BBR reference in your project, see Reference a building block repository. A list of prototype BBRs can be found here.

The prototypes are alphabetically ordered and grouped by classification. For all templates you may inspect the meta data. Click the prototype you need e.g. CDA Section and click the Select button.

From here, editing follows the same pattern as editing an existing template using the rules for a specialization of a template based on that prototype. See section about editing a template.

Creating a link to a template that resides in a BBR

Click the TemplateEditor-linkbutton.png button in the Template Viewer. The template repository browser window will open and present you a dialog with templates that reside in all accessible repositories. These are taken from the building block repositories mentioned in the project. Repository Dialog

Creating a new version of an existing template

When a template has reached the status 'Active', you can no longer alter it. What you can do is create a new version of it. The Template Viewer will present you with a choice when you click the Edit button on an active template

New Version Dialog

When you choose new version with the same id, it means that any dynamic binding to the selected template will now point to this new version. When you choose new version with different id, no existing bindings to templates are affected.

The Template Editor opens. From here, editing follows the same pattern as editing an existing template using the rules for an adaptation of a template based on that prototype. See section about editing a template.

Editing a template

The template is one potentially long page that allows editing the meta data (name, display name, description, classification, reference, etc.) and the body (example, elements, attributes, choices, includes and their properties).

Saving the template currently closes the Template Editor so intermediate saving and continue work is not possible. However, ART locks the template while you are working on it if you are editing an existing template.

Body Element Editing

Most of the meta data editing is filling out text and selecting options from the drop down menus. When you get to the body of the template you'll notice an action button to the far right with context sensitive options. When you are working on a specialization for example, you will not get the option of creating new elements that are now part of the prototype. On datatypes you get to option to add attributes/elements that are part of that particular datatype.

If a certain datatype is specializable into another datatypes or flavors thereof you may select this from the datatype drop menu. In the screenshot, there is a flavor TEL.AT (Austria) and a flavor TEL.EU.EPSOS for the main datatype TEL.

If applicable, there is a check box shown to specify the conformance mandatory for an element (in the example below hl7:id is mandatory).

Actions for Datatypes