Difference between revisions of "Master Scripts"
From Keyfax Wiki
(→The Hotspot Editor) |
|||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== The Navigation Pane == | == The Navigation Pane == | ||
| − | Shows the | + | Shows the script categories. These can be opened up to show the list of topics by clicking + to the left of each category. |
[[File:Masterscriptcategories41.png|center]] | [[File:Masterscriptcategories41.png|center]] | ||
| Line 11: | Line 6: | ||
=== Script Categories === | === Script Categories === | ||
| − | The | + | The navigation pane displays the script selection containing a list of the categories already set up and listed alphabetically. The category properties are displayed in the editing pane. |
| − | Script | + | Script categories and topics must be created at master script level to be available at script set level. |
| − | To edit an existing category, select the category and click on | + | To edit an existing category, select the category and click on '''Edit''' on the menu bar. |
[[File:Categoryedit41.png|center]] | [[File:Categoryedit41.png|center]] | ||
| Line 22: | Line 17: | ||
=== Script Topics === | === Script Topics === | ||
| − | In the | + | In the navigation pane, double-click on a category or select the + sign to the left to open the list of topics. |
| − | Select a | + | Select a topic by clicking on the relevant topic heading which will open the script grid for that topic. To edit an existing topic click '''Edit''' on the menu bar. |
[[File:Topicediting41.png|center]] | [[File:Topicediting41.png|center]] | ||
| − | To add a new | + | To add a new topic click on the '''<New Topic>''' tab at the bottom of each category list, or click '''Add''' on the menu bar, which will open the topic properties pane for your new topic area. This will automatically take you into edit mode. Topics are added to categories at the master script level. |
[[File:Newtopicediting41.png|center]] | [[File:Newtopicediting41.png|center]] | ||
| Line 33: | Line 28: | ||
== The Menu Bar == | == The Menu Bar == | ||
| − | Shows icons for editing the selected | + | Shows icons for editing the selected script. |
[[File:Menubar41.png|center]] | [[File:Menubar41.png|center]] | ||
| − | '''Add''' - | + | '''Add''' - Adds a new script category/topic to the system. Alternatively click on the '''<New Category>''' tab at the bottom of the category/topic list in the navigation pane. Enter the relevant information in all the appropriate fields then click '''Save''' to finish creating the new script category |
| − | '''Save''' - | + | '''Save''' - Saves changes. This will only appear if changes have been made. |
| − | '''Edit''' - | + | '''Edit''' - Allows changes to be made to the selected Script. Once selected the icon will change to '''Edit''' with a lock above it to show the script is locked for editing and the '''Read only''' icon will change to '''Editing'''. Click again to stop editing without making changes. |
If the edit tab is greyed out, this is because you are editing in another tab. | If the edit tab is greyed out, this is because you are editing in another tab. | ||
| − | '''Restore''' - | + | '''Restore''' - Restores the script to the last saved position. |
'''Warning:''' This is '''NOT''' an undo button. Selecting this will delete any amendments made since the last save. | '''Warning:''' This is '''NOT''' an undo button. Selecting this will delete any amendments made since the last save. | ||
| − | '''Delete''' - | + | '''Delete''' - Deletes the selected Script. This will be greyed out unless you are switched into Exclusive Mode. |
== Category Editing Pane == | == Category Editing Pane == | ||
| − | Allows you to edit the content of the scripts by | + | Allows you to edit the content of the scripts by category |
=== Category properties === | === Category properties === | ||
| − | * | + | * '''Bread-crumb''' is displayed at the top of the editing pane. |
| − | * '''Name''' - | + | * '''Name''' - The displayed name of the Category |
| − | * '''Selectable (visible)''' - | + | * '''Selectable (visible)''' - If this button is checked the category is visible to the operators |
| − | * '''.. Continuation (not visible)''' - | + | * '''.. Continuation (not visible)''' - If this button is checked the category is not visible to the operators and would be used as a continuation script, linked to a visible script. |
=== Category Images === | === Category Images === | ||
| Line 66: | Line 61: | ||
==== Topic Hotspots ==== | ==== Topic Hotspots ==== | ||
| − | Hotspots can be used with images to link to | + | Hotspots can be used with images to link to topics within the selected category. Images with '''Hotspot''' areas can be added to the script, which will be displayed to the operator as they select a category. By selecting a '''Hotspot''', operators are selecting the associated topic. Click on '''Topic Hotspots''' which will open the hotspot editor in a new window. |
===== The Hotspot Editor ===== | ===== The Hotspot Editor ===== | ||
| Line 74: | Line 69: | ||
Allows editing of images to be used within the scripts. To make any edits, click on '''Edit''' on the Menu Bar. | Allows editing of images to be used within the scripts. To make any edits, click on '''Edit''' on the Menu Bar. | ||
| − | * '''Breadcrumb''' – | + | * '''Breadcrumb''' – This displays the current selected category and confirms that this is held at master level |
| − | * '''Image''' – | + | * '''Image''' – Identifies the image file being used – default images are ‘png’ format. ‘Gif’, ‘bmp’ and ‘jpg’ format can also be used. |
| − | * '''Display Text''' – | + | * '''Display Text''' – The name displayed to operators |
| − | * '''Topic''' – | + | * '''Topic''' – Displays the topics within the selected category. Where a hotspot has not been created a + is shown to the right of the topic. To create a hotspot for the topic, click the '''+''' symbol. A new hotspot area will be created in the image which can be moved and resized as required (any overlapping areas will be highlighted in red). |
| + | |||
| + | If you are in exclusive mode there will be an option to remove the image and all related hotspots. To do so, click on '''Edit''' and then on the '''Remove image and Hotspots''', you can then save your changes. | ||
| + | |||
| + | [[File:removehotspotimage.png|center]] | ||
==== Related Images ==== | ==== Related Images ==== | ||
| − | Keyfax Inter•View also provides a facility for | + | Keyfax Inter•View also provides a facility for operators to view additional images appropriate to the selected category. Click on '''Related Images''' to open the related images selection in a new window. |
===== Related Image selection ===== | ===== Related Image selection ===== | ||
| Line 87: | Line 86: | ||
[[File:Relatedimageselection41.png|center]] | [[File:Relatedimageselection41.png|center]] | ||
| − | To edit the list of related images click on '''Edit''' on the | + | To edit the list of related images click on '''Edit''' on the menu bar. |
| − | * '''Image''' - | + | * '''Image''' - Identifies the file name for the selected image. To view or select another image click on the folder icon. |
| − | * '''Name''' - | + | * '''Name''' - The name for the image displayed to operators |
== Topic Editing Pane == | == Topic Editing Pane == | ||
| − | Allows you to edit the content of the | + | Allows you to edit the content of the scripts by topic. |
=== Topic Properties === | === Topic Properties === | ||
| − | Enables you to view and/or edit the selected | + | Enables you to view and/or edit the selected priority |
| − | * | + | * '''Bread-crumb''' is displayed at the top of the editing pane. |
| − | * '''Name''' – | + | * '''Name''' – The displayed name of the topic |
| − | * '''Key Words''' – | + | * '''Key Words''' – Keywords used by the keyword search for operators when looking for a topic – use all words that might assist with the selection. |
| − | * '''Related Image''' – | + | * '''Related Image''' – This is the image displayed to operators in the viewing pane when they select the '''Related Images Tab'''. The drop-down list displays all images available for the category. Any image selected will be shown as a thumbnail. |
| − | * '''Selectable (visible)''' – | + | * '''Selectable (visible)''' – If this button is checked, the topic is visible to operators |
| − | * '''.. Continuation (not visible)''' – | + | * '''.. Continuation (not visible)''' – If this is checked, the topic is not visible to operators and would be used as a continuation script, linked to a visible script. Topics that have been set as continuation (not visible) are displayed in the navigation pane with the leading ‘..’ |
[[File:Relatedimage41.png|center]] | [[File:Relatedimage41.png|center]] | ||
| Line 115: | Line 114: | ||
[[File:OL2Selection.png|center]] | [[File:OL2Selection.png|center]] | ||
| − | To select a selection image for your category in | + | To select a selection image for your category in admin tools, select the category you wish to edit, and click on the '''Edit''' button. |
[[File:OL2SelectionEdit.png|center]] | [[File:OL2SelectionEdit.png|center]] | ||
| − | Enter the file name of the image into the Selection Image field and the text you wish to appear beneath the icon into the Image Text field. The default images and file names are as follows. | + | Enter the file name of the image into the '''Selection Image field''' and the text you wish to appear beneath the icon into the Image Text field. The default images and file names are as follows. |
[[File:Catselection.png|center]] | [[File:Catselection.png|center]] | ||
Latest revision as of 09:20, 2 October 2019
Contents
Shows the script categories. These can be opened up to show the list of topics by clicking + to the left of each category.
Script Categories
The navigation pane displays the script selection containing a list of the categories already set up and listed alphabetically. The category properties are displayed in the editing pane.
Script categories and topics must be created at master script level to be available at script set level.
To edit an existing category, select the category and click on Edit on the menu bar.
Script Topics
In the navigation pane, double-click on a category or select the + sign to the left to open the list of topics. Select a topic by clicking on the relevant topic heading which will open the script grid for that topic. To edit an existing topic click Edit on the menu bar.
To add a new topic click on the <New Topic> tab at the bottom of each category list, or click Add on the menu bar, which will open the topic properties pane for your new topic area. This will automatically take you into edit mode. Topics are added to categories at the master script level.
The Menu Bar
Shows icons for editing the selected script.
Add - Adds a new script category/topic to the system. Alternatively click on the <New Category> tab at the bottom of the category/topic list in the navigation pane. Enter the relevant information in all the appropriate fields then click Save to finish creating the new script category
Save - Saves changes. This will only appear if changes have been made.
Edit - Allows changes to be made to the selected Script. Once selected the icon will change to Edit with a lock above it to show the script is locked for editing and the Read only icon will change to Editing. Click again to stop editing without making changes.
If the edit tab is greyed out, this is because you are editing in another tab.
Restore - Restores the script to the last saved position.
Warning: This is NOT an undo button. Selecting this will delete any amendments made since the last save.
Delete - Deletes the selected Script. This will be greyed out unless you are switched into Exclusive Mode.
Category Editing Pane
Allows you to edit the content of the scripts by category
Category properties
- Bread-crumb is displayed at the top of the editing pane.
- Name - The displayed name of the Category
- Selectable (visible) - If this button is checked the category is visible to the operators
- .. Continuation (not visible) - If this button is checked the category is not visible to the operators and would be used as a continuation script, linked to a visible script.
Category Images
Topic Hotspots
Hotspots can be used with images to link to topics within the selected category. Images with Hotspot areas can be added to the script, which will be displayed to the operator as they select a category. By selecting a Hotspot, operators are selecting the associated topic. Click on Topic Hotspots which will open the hotspot editor in a new window.
The Hotspot Editor
Allows editing of images to be used within the scripts. To make any edits, click on Edit on the Menu Bar.
- Breadcrumb – This displays the current selected category and confirms that this is held at master level
- Image – Identifies the image file being used – default images are ‘png’ format. ‘Gif’, ‘bmp’ and ‘jpg’ format can also be used.
- Display Text – The name displayed to operators
- Topic – Displays the topics within the selected category. Where a hotspot has not been created a + is shown to the right of the topic. To create a hotspot for the topic, click the + symbol. A new hotspot area will be created in the image which can be moved and resized as required (any overlapping areas will be highlighted in red).
If you are in exclusive mode there will be an option to remove the image and all related hotspots. To do so, click on Edit and then on the Remove image and Hotspots, you can then save your changes.
Related Images
Keyfax Inter•View also provides a facility for operators to view additional images appropriate to the selected category. Click on Related Images to open the related images selection in a new window.
Related Image selection
To edit the list of related images click on Edit on the menu bar.
- Image - Identifies the file name for the selected image. To view or select another image click on the folder icon.
- Name - The name for the image displayed to operators
Topic Editing Pane
Allows you to edit the content of the scripts by topic.
Topic Properties
Enables you to view and/or edit the selected priority
- Bread-crumb is displayed at the top of the editing pane.
- Name – The displayed name of the topic
- Key Words – Keywords used by the keyword search for operators when looking for a topic – use all words that might assist with the selection.
- Related Image – This is the image displayed to operators in the viewing pane when they select the Related Images Tab. The drop-down list displays all images available for the category. Any image selected will be shown as a thumbnail.
- Selectable (visible) – If this button is checked, the topic is visible to operators
- .. Continuation (not visible) – If this is checked, the topic is not visible to operators and would be used as a continuation script, linked to a visible script. Topics that have been set as continuation (not visible) are displayed in the navigation pane with the leading ‘..’
Selection Images (Inter•View Online only)
When using Keyfax Online tenants will be presented with icons to allow them to select the category that is most relevant to their repair or enquiry. The icons will be arranged with text below them as shown here.
To select a selection image for your category in admin tools, select the category you wish to edit, and click on the Edit button.
Enter the file name of the image into the Selection Image field and the text you wish to appear beneath the icon into the Image Text field. The default images and file names are as follows.
Additional Selection Images
Additional images will need to be uploaded to the selection images folder defined in your Keyfax config file.
Information on the format and dimensions of the images can be found at the following link:
