Difference between revisions of "Summary Templates"

From IMSMA Wiki
Jump to: navigation, search
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__FORCETOC__
 
__FORCETOC__
 
{{TOC right}}
 
{{TOC right}}
−
[[File:ViewDesignerAndVictimView.png|thumb|left|200px|alt=The Victim Summary and Summary Designer - side by side.|The Victim Summary - as displayed in the both Summary and Summary Designer Windows]]
+
[[Image:ViewDesignerAndVictimView.png|center|500px]]
 +
<div align="center">
 +
'' The Victim Summary - as displayed in the both Summary and Summary Designer Windows''
 +
</div>
  
 
The Summary Designer window lets you modify how an item's data displays in the [[Summary Window]]. The figure to the left shows an example.
 
The Summary Designer window lets you modify how an item's data displays in the [[Summary Window]]. The figure to the left shows an example.
  
−
There are two panes in the Summary Designer window. The pane on the left displays a data tree of elements available for the selected item. You can drag elements to and from the data tree to populate your summary. On the right is the design pane, where you can add, remove, and modify elements. Above the design pane is a series of tabs that let you switch between pages.  
+
There are two panes in the Summary Designer window. The pane on the left displays a data tree of elements available for the selected item. You can drag elements to and from the data tree to populate your summary. On the right is the design pane, where you can add, delete, and modify elements. Above the design pane is a series of tabs that let you switch between pages.  
  
 
When you have finished customising the summary template, you can either save it with a new name or overwrite an existing summary. In both cases the new version will get the status '''draft''' and you need to [[Publish and Archive Summary Templates#Publishing a Summary template | publish]] it before it is visible to the users.
 
When you have finished customising the summary template, you can either save it with a new name or overwrite an existing summary. In both cases the new version will get the status '''draft''' and you need to [[Publish and Archive Summary Templates#Publishing a Summary template | publish]] it before it is visible to the users.
Line 12: Line 15:
  
 
==Customising a Summary template==__NOEDITSECTION__
 
==Customising a Summary template==__NOEDITSECTION__
−
#From the [[IMSMA Navigation Window]], click '''Customisation > Summary Manager'''.
+
#In the '''Customisation''' menu &rarr; '''Summary Manager'''.
−
#Select an item from the '''Object''' menu to display its complete list of views.
+
#Select an item from the '''Object''' menu to display its complete list of Summary Templates.
−
#Select one of the item's existing summaries from the list.
+
#Select one of the item's existing Summary Templates from the list.
−
#Click the [[Image:EditIcon.png | 20px | Edit]] button to open the [[Summary Templates | Summary Designer]] window.
+
#Click the [[File:FieldViewIcon.png|20px]] button to open the [[Summary Templates | Summary Designer]] window.
  
 
===Adding Data Elements===__NOEDITSECTION__
 
===Adding Data Elements===__NOEDITSECTION__
−
----
+
''Data Elements'' are the relevant information (gathered during data entry) that display on an item's summary. You can move existing data elements around in the design pane, and resize, relabel, or delete them. You can also add elements by dragging them from the data tree to the design pane. With certain exceptions, only one instance of the same data element can be added to each tab.
−
''Data Elements'' are the relevant information (gathered during [[Entering Data into IMSMANG#Entering Data into the Data Entry Form Template| data entry]]) that display on an item's summary. You can move existing data elements around in the design pane, and resize, relabel, or delete them. You can also add elements by dragging them from the data tree to the design pane. With certain exceptions, only one instance of the same data element can be added to each tab.
 
  
 
# Click the tab on which you want to add the data element.
 
# Click the tab on which you want to add the data element.
Line 26: Line 28:
 
# If you are editing a table, refer to [[Customise Tables]].
 
# If you are editing a table, refer to [[Customise Tables]].
  
 +
[[Image:Summary template designer Links.png|500px|center]]
 +
<div align="center">
 +
'' Link table''
 +
</div>
 +
{{Note | In the Summary template designer it is the calculated subobject Links that should be used for the ''Links'' table. It does '''not''' make sense to use ''Linked IDs'' in Summary templates.}}
 +
 
===Adding Graphic Elements===__NOEDITSECTION__
 
===Adding Graphic Elements===__NOEDITSECTION__
−
----
+
''Graphic Elements'' make up the visual layout of an item's summary, and are unaffected by data entry. They are the lines that border or separate sections, text boxes where messages can be written, and images (like photographs, maps, and diagrams) that add to the visual aesthetic. All graphic elements are located in the Summary Designer data tree, inside the '''Tool Folder'''.
−
''Graphic Elements'' make up the visual layout of an item's summary, and are unaffected by data entry. They are the [[Summary Templates#Lines | lines]] that border or separate sections, [[Summary Templates#Text Boxes | text boxes]] where messages can be written, and [[Summary Templates#Images | images]] (like photographs, maps, and diagrams) that add to the visual aesthetic. All graphic elements are located in the Summary Designer data tree, inside the '''Tool Folder'''.
 
  
 
====Lines====__NOEDITSECTION__
 
====Lines====__NOEDITSECTION__
Line 37: Line 44:
 
====Text Boxes====__NOEDITSECTION__
 
====Text Boxes====__NOEDITSECTION__
 
# Click the tab on which you want to add the text box.
 
# Click the tab on which you want to add the text box.
−
# Drag the '''Text Tool''' from the Tool folder in the data tree to the design pallate.
+
# Drag the '''Text Tool''' from the Tool folder in the data tree to the design palette.
 
# Double-click the text box to add the desired text (in place of the default "Text Tool") and edit the font style and size. Note that the text box borders will expand or contract to fit its contents.
 
# Double-click the text box to add the desired text (in place of the default "Text Tool") and edit the font style and size. Note that the text box borders will expand or contract to fit its contents.
  
Line 46: Line 53:
  
 
===Saving a Summary template===__NOEDITSECTION__
 
===Saving a Summary template===__NOEDITSECTION__
−
----
+
When you have finished customising your Summary Template and saved it, remember to [[Publish and Archive Summary Templates#Publishing a Summary template| publish]] the Summary Template if you want to activate it in IMSMA. Note that you can save separate Summary Templates with the same name in the Summary Manager.
−
When you have finished customising your summary, do one of the following:
 
−
* Click '''Save As''' to save the custom summary as a separate entry in the Summary Manager Window.
 
−
* Click '''Save''' to overwrite the existing custom summary.
 
−
 
 
−
Remember to [[Publish and Archive Summary Templates#Publishing a Summary template| publish]] the summary if you want to activate it in IMSMA. Note that you can save separate summaries with the same name in the Summary Manager.
 
  
 
===Summary Designer User Interface Buttons===__NOEDITSECTION__
 
===Summary Designer User Interface Buttons===__NOEDITSECTION__
−
----
+
The following table lists all of the GUI buttons available in the Summary Designer window and their purposes:
−
The following table lists all of the GUI buttons avaiable in the Summary Designer window and their purposes:
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 99: Line 100:
 
|-
 
|-
 
| style="padding-left: 2em" | Undo or redo previous actions
 
| style="padding-left: 2em" | Undo or redo previous actions
−
| Click the [[Image:ViewDesignerUndo.png | Undo]] or [[Image:ViewDesignerRedo.png | Redo]] buttons.
+
| Click the [[Image:Undo.jpg | Undo]] or [[Image:Redo.jpg | Redo]] buttons.
 
|-
 
|-
 
| style="padding-left: 2em" | Save your changes to the summary
 
| style="padding-left: 2em" | Save your changes to the summary

Latest revision as of 16:47, 19 June 2017

ViewDesignerAndVictimView.png

The Victim Summary - as displayed in the both Summary and Summary Designer Windows

The Summary Designer window lets you modify how an item's data displays in the Summary Window. The figure to the left shows an example.

There are two panes in the Summary Designer window. The pane on the left displays a data tree of elements available for the selected item. You can drag elements to and from the data tree to populate your summary. On the right is the design pane, where you can add, delete, and modify elements. Above the design pane is a series of tabs that let you switch between pages.

When you have finished customising the summary template, you can either save it with a new name or overwrite an existing summary. In both cases the new version will get the status draft and you need to publish it before it is visible to the users.

The following sections describe how to complete common tasks in the Summary Designer window. For a complete list of the available functions, refer to Summary Designer User Interface Buttons.

Customising a Summary template

  1. In the Customisation menu → Summary Manager.
  2. Select an item from the Object menu to display its complete list of Summary Templates.
  3. Select one of the item's existing Summary Templates from the list.
  4. Click the FieldViewIcon.png button to open the Summary Designer window.

Adding Data Elements

Data Elements are the relevant information (gathered during data entry) that display on an item's summary. You can move existing data elements around in the design pane, and resize, relabel, or delete them. You can also add elements by dragging them from the data tree to the design pane. With certain exceptions, only one instance of the same data element can be added to each tab.

  1. Click the tab on which you want to add the data element.
  2. Drag an element from the data tree to the design pane.
  3. Double-click the element's graphic or label to edit its properties.
  4. If you are editing a table, refer to Customise Tables.
Summary template designer Links.png

Link table

Note.jpg In the Summary template designer it is the calculated subobject Links that should be used for the Links table. It does not make sense to use Linked IDs in Summary templates.

Adding Graphic Elements

Graphic Elements make up the visual layout of an item's summary, and are unaffected by data entry. They are the lines that border or separate sections, text boxes where messages can be written, and images (like photographs, maps, and diagrams) that add to the visual aesthetic. All graphic elements are located in the Summary Designer data tree, inside the Tool Folder.

Lines

  1. Click the tab on which you want to add the line.
  2. Drag the Line Tool from the Tool folder in the data tree to the design pane.
  3. Double-click the line to edit its width and height.

Text Boxes

  1. Click the tab on which you want to add the text box.
  2. Drag the Text Tool from the Tool folder in the data tree to the design palette.
  3. Double-click the text box to add the desired text (in place of the default "Text Tool") and edit the font style and size. Note that the text box borders will expand or contract to fit its contents.

Images

  1. Click the tab on which you want to add the image.
  2. Drag the Icon Tool from the Tool folder in the data tree to the design pane.
  3. Double-click the Icon Tool widget to resize its boundaries and choose an image file to import. Note that the Icon Tool borders will expand or contract to fit the imported file.

Saving a Summary template

When you have finished customising your Summary Template and saved it, remember to publish the Summary Template if you want to activate it in IMSMA. Note that you can save separate Summary Templates with the same name in the Summary Manager.

Summary Designer User Interface Buttons

The following table lists all of the GUI buttons available in the Summary Designer window and their purposes:

Summary Designer Interface
Desired Elements Steps to Achieve
Tabs
Move a tab to the left or right of other tabs Click a tab, and then click the Move Tab Left or Move Tab Right buttons.
Add a new tab Click the New Tab "*" and then double-click the New Tab label to rename it.
Delete a selected tab Click the x by the tab name (ViewDesignerDeleteTab.png).
Set page layout and size Click Tab Setup.
Clear all elements from a selected tab Click Clear Tab.
Elements
Delete selected elements from a selected tab Click Clear.
Align selected elements Click Align.
Modify the properties of a selected element Click Properties.
Clear all elements from all tabs Click Clear All Tabs.
General
Undo or redo previous actions Click the Undo or Redo buttons.
Save your changes to the summary Click Save.
Save your summary as new Click Save As.
Print and preview a summary Click Preview.
Exit the Summary Designer Click Close.
Designing Summary Templates
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Summary_Templates&oldid=23668"