Skip to content

Commit

Permalink
[Help] Update help documentation and screenshots for new features
Browse files Browse the repository at this point in the history
  • Loading branch information
Phillipus committed Oct 19, 2023
1 parent 2d9e971 commit 5fd0c44
Show file tree
Hide file tree
Showing 26 changed files with 166 additions and 117 deletions.
Binary file modified com.archimatetool.help/help/Images/conn_properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/export_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_canvas_block3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_canvas_image2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_canvas_sticky2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_element3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_group2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_note2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_relation3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified com.archimatetool.help/help/Images/properties_viewref2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions com.archimatetool.help/help/Text/prefs_appearance.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h2>Colours</h2>
<p>Theme colours for backgrounds can be set for each theme as set in the Appearance preference. These are for the application and are not saved in the model.</p>

<p><strong>Derive element line colours from fill colours</strong><br/>
If this is checked a diagram element's line colour is derived as a darker shade of its fill colour. You can adjust the amount of contrast with the "Contrast factor" control. If this option is set, user line colours are ignored.</p>
If this is checked a newly created diagram object's line colour is derived from its fill colour. The setting for each object can be changed in the object's properties tab.</p>

<p><strong>Save the default fill colour for elements in the model file</strong><br/>
If this is checked an element's default colour is saved in the model file and will then be "fixed" in the file. This ensures that if the file is shared with another user they will see these colours.</p>
Expand All @@ -60,7 +60,7 @@ <h2>Colours</h2>
<br/>

<h2>Fonts</h2>
<p>Sets the default font to use elements and connections in diagrams (Views) and fonts to use for various user interface controls. Clicking the "Default" button sets the default font for the selected items. The "Edit" button will allow you to set the font for the selected items.</p>
<p>Sets the default font to use for elements and connections in diagrams (Views) and fonts to use for various user interface controls. Clicking the "Default" button sets the default font for the selected items. The "Edit" button will allow you to set the font for the selected items.</p>

<p>&nbsp;</p>

Expand Down
24 changes: 14 additions & 10 deletions com.archimatetool.help/help/Text/properties_canvas_block.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,21 @@ <h2>Canvas Block</h2>
<td>Sets the fill colour for the selected object. The "Default" button sets the fill colour to the default setting.</td>
</tr>
<tr>
<td><strong>Border colour:</strong></td>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Border Colour:</strong></td>
<td>Sets the colour of the border used for the selected object. The "None" button removes the border from the object.</td>
</tr>
<tr>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the border line. Options are "Normal", "Medium", and "Heavy".</td>
</tr>
<tr>
<td><strong>Line Opacity:</strong></td>
<td>Set the line opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected object to Left, Centred or Right.</td>
Expand All @@ -91,17 +103,9 @@ <h2>Canvas Block</h2>
<td>Sets the font used for the text in the selected object. The "Default" button sets the font to the default setting as set in Preferences.</td>
</tr>
<tr>
<td><strong>Font colour:</strong></td>
<td><strong>Font Colour:</strong></td>
<td>Sets the colour of the font used for the text in the selected object. The "Default" button sets the font colour to the default setting.</td>
</tr>
<tr>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Outline Opacity:</strong></td>
<td>Set the outline opacity of the figure. Range from 0-255.</td>
</tr>
</table>

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,27 +65,27 @@ <h2>Canvas Connection</h2>
<td>Sets the position of the text that will appear next to the line on the View. Options are "Source", "Middle" and "Target".</td>
</tr>
<tr>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the connection line. Options are "Normal", "Medium" and "Heavy".</td>
<td><strong>Line Style:</strong></td>
<td>Sets the connection line's source and target head types, and main line style.</td>
</tr>
<tr>
<td><strong>Line colour:</strong></td>
<td><strong>Line Colour:</strong></td>
<td>Sets the colour of the connection line. The "Default" button sets the line colour to the default setting.</td>
</tr>
<tr>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected element to Left, Centred or Right.</td>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the connection line. Options are "Normal", "Medium" and "Heavy".</td>
</tr>
<tr>
<td><strong>Line Style:</strong></td>
<td>Sets the connection line's source and target head types, and main line style.</td>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected element to Left, Centred or Right.</td>
</tr>
<tr>
<td><strong>Font:</strong></td>
<td>Sets the font used for the text in the selected connection. The "Default" button sets the font to the default setting as set in Preferences.</td>
</tr>
<tr>
<td><strong>Font colour:</strong></td>
<td><strong>Font Colour:</strong></td>
<td>Sets the colour of the font used for the text in the selected connection. The "Default" button sets the font colour to the default setting.</td>
</tr>
</table>
Expand Down
14 changes: 9 additions & 5 deletions com.archimatetool.help/help/Text/properties_canvas_image.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,20 @@ <h2>Canvas Image</h2>

<table>
<tr>
<td><strong>Border colour:</strong></td>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Border Colour:</strong></td>
<td>Sets the colour of the border used for the selected object. The "None" button removes the border from the object.</td>
</tr>
<tr>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the border line. Options are "Normal", "Medium" and "Heavy".</td>
</tr>
<tr>
<td><strong>Outline Opacity:</strong></td>
<td>Set the outline opacity of the figure. Range from 0-255.</td>
<td><strong>Line Opacity:</strong></td>
<td>Set the line opacity of the figure. Range from 0-255.</td>
</tr>
</table>

Expand Down
22 changes: 11 additions & 11 deletions com.archimatetool.help/help/Text/properties_canvas_sticky.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,21 @@ <h2>Canvas Sticky</h2>

<table>
<tr>
<td><strong>Fill colour:</strong></td>
<td><strong>Fill Colour:</strong></td>
<td>Sets the fill colour for the selected object. The "Default" button sets the fill colour to the default setting.</td>
</tr>
<tr>
<td><strong>Border colour:</strong></td>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Border Colour:</strong></td>
<td>Sets the colour of the border used for the selected object. The "None" button removes the border from the object.</td>
</tr>
<tr>
<td><strong>Line Opacity:</strong></td>
<td>Set the line opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected object to Left, Centred or Right.</td>
Expand All @@ -77,17 +85,9 @@ <h2>Canvas Sticky</h2>
<td>Sets the font used for the text in the selected object. The "Default" button sets the font to the default setting as set in Preferences.</td>
</tr>
<tr>
<td><strong>Font colour:</strong></td>
<td><strong>Font Colour:</strong></td>
<td>Sets the colour of the font used for the text in the selected object. The "Default" button sets the font colour to the default setting.</td>
</tr>
<tr>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Outline Opacity:</strong></td>
<td>Set the outline opacity of the figure. Range from 0-255.</td>
</tr>
</table>

<br/>
Expand Down
34 changes: 19 additions & 15 deletions com.archimatetool.help/help/Text/properties_element_appearance.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,32 @@ <h2>Element Appearance Properties</h2>

<table>
<tr>
<td><strong>Fill colour:</strong></td>
<td><strong>Fill Colour:</strong></td>
<td>Sets the fill colour for the selected element. The "Default" button sets the fill colour to the default setting.</td>
</tr>
<tr>
<td><strong>Line colour:</strong></td>
<td>Sets the colour of the line used to draw the selected element. The "Default" button sets the line colour to the default setting. If this is disabled it is because line colours are derived from the element's fill colour, as set in Preferences.</td>
<td><strong>Gradient:</strong></td>
<td>Sets the direction used to draw the gradient fill of the selected element. Settings are "None", "Top", Left", "Right" and "Bottom". Note - gradients will not show when a diagram is exported in SVG image format.</td>
</tr>
<tr>
<td><strong>Icon colour:</strong></td>
<td>Sets the colour of the small ArchiMate icon in figures. The "Default" button sets the line colour to the default setting.</td>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Gradient:</strong></td>
<td>Sets the direction used to draw the gradient fill of the selected element. Settings are "None", "Top", Left", "Right" and "Bottom". Note - gradients will not show when a diagram is exported in SVG image format.</td>
<td><strong>Line Colour:</strong></td>
<td>Sets the colour of the line used to draw the selected element. The "Derive from fill colour" drop-down option sets the line colour based on the fill colour. The "Default" drop-down option sets the line colour to the default colour as set in Preferences. If the "Default" drop-down option is not visible it is because line colours are derived from the element's fill colour, as set in the "Derive from fill colour" drop-down option.</td>
</tr>
<tr>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the line used to draw the selected element. Options are "Normal", "Medium" and "Heavy".</td>
</tr>
<tr>
<td><strong>Line Opacity:</strong></td>
<td>Set the line opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Icon Colour:</strong></td>
<td>Sets the colour of the small ArchiMate icon in figures. The "Default" button sets the line colour to the default setting.</td>
</tr>
<tr>
<td><strong>Text Alignment:</strong></td>
Expand All @@ -56,14 +68,6 @@ <h2>Element Appearance Properties</h2>
<td><strong>Font colour:</strong></td>
<td>Sets the colour of the font used for the text in the selected element. The "Default" button sets the font colour to the default setting.</td>
</tr>
<tr>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Outline Opacity:</strong></td>
<td>Set the outline opacity of the figure. Range from 0-255.</td>
</tr>
</table>

<p>&nbsp;</p>
Expand Down
42 changes: 23 additions & 19 deletions com.archimatetool.help/help/Text/properties_group.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,29 +46,14 @@ <h2>Group Properties</h2>

<table>
<tr>
<td><strong>Fill colour:</strong></td>
<td><strong>Fill Colour:</strong></td>
<td>Sets the fill colour for the Group. The "Default" button sets the fill colour to the default setting.</td>
</tr>
<tr>
<td><strong>Line colour:</strong></td>
<td>Sets the colour of the line used to draw the Group. The "Default" button sets the line colour to the default setting. If this is disabled it is because line colours are derived from the object's fill colour, as set in Preferences.</td>
</tr>
<tr>
<td><strong>Gradient:</strong></td>
<td>Sets the direction used to draw the gradient fill of the selected element. Settings are "None", "Top", Left", "Right" and "Bottom". Note - gradients will not show when a diagram is exported in SVG image format.</td>
</tr>
<tr>
<td><strong>Border:</strong></td>
<td>Sets the border type. Can be either "Tabbed" or "Rectangle".</td>
</tr>
<tr>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected object to Left, Centred or Right.</td>
</tr>
<tr>
<td><strong>Text Position:</strong></td>
<td>Align text in the selected object to Top, Middle or Bottom.</td>
</tr>
<tr>
<td><strong>Font:</strong></td>
<td>Sets the font used for the text in the Group. The "Default" button sets the font to the default setting as set in Preferences.</td>
Expand All @@ -82,10 +67,29 @@ <h2>Group Properties</h2>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Outline Opacity:</strong></td>
<td>Set the outline opacity of the figure. Range from 0-255.</td>
<td><strong>Line Colour:</strong></td>
<td>>Sets the colour of the line used to draw the selected element. The "Derive from fill colour" drop-down option sets the line colour based on the fill colour. The "Default" drop-down option sets the line colour to the default colour as set in Preferences. If the "Default" drop-down option is not visible it is because line colours are derived from the element's fill colour, as set in the "Derive from fill colour" drop-down option.</td>
</tr>
</table>
<tr>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the line used to draw the Group. Options are "Normal", "Medium" and "Heavy".</td>
</tr>
<tr>
<td><strong>Line Opacity:</strong></td>
<td>Set the line opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Border:</strong></td>
<td>Sets the border type. Can be either "Tabbed" or "Rectangle".</td>
</tr>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected object to Left, Centred or Right.</td>
</tr>
<tr>
<td><strong>Text Position:</strong></td>
<td>Align text in the selected object to Top, Middle or Bottom.</td>
</tr>
</table>

<p>&nbsp;</p>

Expand Down
32 changes: 18 additions & 14 deletions com.archimatetool.help/help/Text/properties_note.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,29 @@ <h2>Note Properties</h2>

<table>
<tr>
<td><strong>Fill colour:</strong></td>
<td><strong>Fill Colour:</strong></td>
<td>Sets the fill colour for the selected object. The "Default" button sets the fill colour to the default setting.</td>
</tr>
<tr>
<td><strong>Line colour:</strong></td>
<td>Sets the colour of the line used to draw the selected object. The "Default" button sets the line colour to the default setting. If this is disabled it is because line colours are derived from the object's fill colour, as set in Preferences.</td>
</tr>
<tr>
<td><strong>Gradient:</strong></td>
<td>Sets the direction used to draw the gradient fill of the selected element. Settings are "None", "Top", Left", "Right" and "Bottom". Note - gradients will not show when a diagram is exported in SVG image format.</td>
</tr>
<tr>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Line Colour:</strong></td>
<td>>Sets the colour of the line used to draw the selected element. The "Derive from fill colour" drop-down option sets the line colour based on the fill colour. The "Default" drop-down option sets the line colour to the default colour as set in Preferences. If the "Default" drop-down option is not visible it is because line colours are derived from the element's fill colour, as set in the "Derive from fill colour" drop-down option.</td>
</tr>
<tr>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the line used to draw the selected object. Options are "Normal", "Medium" and "Heavy".</td>
</tr>
<tr>
<td><strong>Line Opacity:</strong></td>
<td>Set the line opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Border:</strong></td>
<td>Sets the border type. Can be either "Dog Ear", "Rectangle" or "None".</td>
Expand All @@ -69,17 +81,9 @@ <h2>Note Properties</h2>
<td>Sets the font used for the text in the selected object. The "Default" button sets the font to the default setting as set in Preferences.</td>
</tr>
<tr>
<td><strong>Font colour:</strong></td>
<td><strong>Font Colour:</strong></td>
<td>Sets the colour of the font used for the text in the selected object. The "Default" button sets the font colour to the default setting.</td>
</tr>
<tr>
<td><strong>Fill Opacity:</strong></td>
<td>Set the fill opacity of the figure. Range from 0-255.</td>
</tr>
<tr>
<td><strong>Outline Opacity:</strong></td>
<td>Set the outline opacity of the figure. Range from 0-255.</td>
</tr>
</table>

<p>&nbsp;</p>
Expand Down
16 changes: 8 additions & 8 deletions com.archimatetool.help/help/Text/properties_note_connection.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,27 +55,27 @@ <h2>Connection Properties</h2>
<td>Sets the position of the text that will appear next to the line on the View. Options are "Source", "Middle" and "Target".</td>
</tr>
<tr>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the connection line. Options are "Normal", "Medium" and "Heavy".</td>
<td><strong>Line Style:</strong></td>
<td>Sets the connection line's source and target head types, and main line style.</td>
</tr>
<tr>
<td><strong>Line colour:</strong></td>
<td><strong>Line Colour:</strong></td>
<td>Sets the colour of the connection line. The "Default" button sets the line colour to the default setting.</td>
</tr>
<tr>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected element to Left, Centred or Right.</td>
<td><strong>Line Width:</strong></td>
<td>Sets the width of the connection line. Options are "Normal", "Medium" and "Heavy".</td>
</tr>
<tr>
<td><strong>Line Style:</strong></td>
<td>Sets the connection line's source and target head types, and main line style.</td>
<td><strong>Text Alignment:</strong></td>
<td>Align text in the selected element to Left, Centred or Right.</td>
</tr>
<tr>
<td><strong>Font:</strong></td>
<td>Sets the font used for the text in the selected connection. The "Default" button sets the font to the default setting as set in <a href="prefs_diagram.html">Preferences</a>.</td>
</tr>
<tr>
<td><strong>Font colour:</strong></td>
<td><strong>Font Colour:</strong></td>
<td>Sets the colour of the font used for the text in the selected connection. The "Default" button sets the font colour to the default setting.</td>
</tr>
</table>
Expand Down
Loading

0 comments on commit 5fd0c44

Please sign in to comment.