Appboard/2.5/builder/custom icons - Revision history

imported>Jason.nicholls: /* Icon Registry Files */

2014-07-30T07:18:44Z

Icon Registry Files

← Older revision		Revision as of 07:18, 30 July 2014
Line 31:		Line 31:
	=== Icon Registry Files ===		=== Icon Registry Files ===

	AppBoard maintains the icon registry in the following directory: <tt>[INSTALL_HOME]]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry</tt>. All <tt>csv</tt> files in this directory are loaded and by default the following files are included with the install - these should not be edited:		AppBoard maintains the icon registry in the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry</tt>. All <tt>csv</tt> files in this directory are loaded and by default the following files are included with the install - these should not be edited:

	* <tt>backgrounds.csv</tt>: images used for backgrounds with the Diagrammer widget.		* <tt>backgrounds.csv</tt>: images used for backgrounds with the Diagrammer widget.

imported>Jason.nicholls: /* Copying Icons to the Server */

2014-07-30T07:18:18Z

Copying Icons to the Server

← Older revision		Revision as of 07:18, 30 July 2014
Line 25:		Line 25:

	=== Copying Icons to the Server ===		=== Copying Icons to the Server ===
	# Create a directory for the custom icons, this has to be under the <tt>~~enportal/~~visualizer</tt> ~~part of the tree~~, but it is recommended to create a custom directory for all custom icons such as:		# Create a directory for the custom icons, this has to be under the <tt>visualizer</tt> directory, but it is recommended to create a custom directory for all custom icons such as:
	#: <tt>[INSTALL_HOME]/server/enportal/visualizer/assets/custom/icons/</tt>		#: <tt>[INSTALL_HOME]/server/enportal/visualizer/assets/custom/icons/</tt>
	# Copy all the icon/image files into this directory on the AppBoard server ensuring to set the correct ownership and permissions for AppBoard to access the files.		# Copy all the icon/image files into this directory on the AppBoard server ensuring to set the correct ownership and permissions for AppBoard to access the files.

imported>Jason.nicholls at 07:17, 30 July 2014

2014-07-30T07:17:01Z

← Older revision		Revision as of 07:17, 30 July 2014
Line 45:		Line 45:
	# Copy this file into the icon registry directory, for example:		# Copy this file into the icon registry directory, for example:
	#: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry/custom_icons.csv</tt>		#: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry/custom_icons.csv</tt>
			# At this point the AppBoard server can be restarted and if there are no issues the new icons should be available!

	==== Registry Format ====		==== Registry Format ====
Line 110:		Line 111:
	\|Set of space separated tags to allow for easy searching in the Icon Chooser when large numbers of icons are available.		\|Set of space separated tags to allow for easy searching in the Icon Chooser when large numbers of icons are available.
	\|}		\|}

			=== Including in Backups ===

			Finally the last step is to ensure all icon files and the custom icon registry file are included in full backups. This is to make sure that when restoring the system, or migrating from one environment to another, that the custom icons will be included.

			See the [[appboard/2.5/admin/backup_and_recovery#Customizing_the_Export\|Customizing the Export]] section on the Backup & Recovery page for more information.

imported>Jason.nicholls: /* Registry Format */

2014-07-30T07:13:32Z

Registry Format

← Older revision		Revision as of 07:13, 30 July 2014
Line 78:		Line 78:
	\|<tt>rasterPath</tt>		\|<tt>rasterPath</tt>
	\|string		\|string
	\|~~TODO~~		\|This is the path to the icon file location relative to the <tt>visualizer</tt> directory on the server. So for example using the recommended directory from above: <tt>assets/custom/icons/office.png</tt>
	\|-		\|-
	\|align='right'\|6		\|align='right'\|6

imported>Jason.nicholls: /* Registry Format */

2014-07-30T07:11:30Z

Registry Format

← Older revision		Revision as of 07:11, 30 July 2014
Line 68:		Line 68:
	\|<tt>id</tt>		\|<tt>id</tt>
	\|string		\|string
	\|~~Unique~~ identifier across all ~~tile~~ registry files.		\|Internal unique identifier across all icon registry files.
	\|-		\|-
	\|align='right'\|4		\|align='right'\|4

imported>Jason.nicholls: /* Icon Registry Files */

2014-07-30T07:10:49Z

Icon Registry Files

← Older revision		Revision as of 07:10, 30 July 2014
Line 44:		Line 44:
	# Create a new registry <tt>.csv</tt> file with the correct fields and values for each of the custom icons added to the server. This should have a filename that differs from the set of shipped registry files listed above. See further down for the format of this file.		# Create a new registry <tt>.csv</tt> file with the correct fields and values for each of the custom icons added to the server. This should have a filename that differs from the set of shipped registry files listed above. See further down for the format of this file.
	# Copy this file into the icon registry directory, for example:		# Copy this file into the icon registry directory, for example:
	#: <tt>[INSTALL_HOME]]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry/~~my_custom_icons~~.csv</tt>		#: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry/custom_icons.csv</tt>

	==== Registry Format ====		==== Registry Format ====

imported>Jason.nicholls at 07:09, 30 July 2014

2014-07-30T07:09:48Z

← Older revision		Revision as of 07:09, 30 July 2014
Line 15:		Line 15:

	{{Note\|The Google Map widget and Vector Map widgets have a specific set of icons only used for those widgets. The list of images that appear in the Icon Chooser will differ when editing those widgets.}}		{{Note\|The Google Map widget and Vector Map widgets have a specific set of icons only used for those widgets. The list of images that appear in the Icon Chooser will differ when editing those widgets.}}

			== Custom Icons ==

			To make icons available to AppBoard they must be registered in the Icon Registry which is loaded on startup. The basic process for adding custom icons is:

			# Copy the icon/image files onto the AppBoard server.
			# Create an icon registry file for the custom icons, and copy this to the server.
			# Include the custom icon/image files and icon registry file in full archives.

			=== Copying Icons to the Server ===
			# Create a directory for the custom icons, this has to be under the <tt>enportal/visualizer</tt> part of the tree, but it is recommended to create a custom directory for all custom icons such as:
			#: <tt>[INSTALL_HOME]/server/enportal/visualizer/assets/custom/icons/</tt>
			# Copy all the icon/image files into this directory on the AppBoard server ensuring to set the correct ownership and permissions for AppBoard to access the files.

			=== Icon Registry Files ===

			AppBoard maintains the icon registry in the following directory: <tt>[INSTALL_HOME]]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry</tt>. All <tt>csv</tt> files in this directory are loaded and by default the following files are included with the install - these should not be edited:

			* <tt>backgrounds.csv</tt>: images used for backgrounds with the Diagrammer widget.
			* <tt>base.csv</tt>: the broad set of generic icons used by most widgets.
			* <tt>custom_military.csv.disabled</tt>: supplementary military focused icons, disabled by default (remove .disabled to have this loaded).
			* <tt>mapBadge.csv</tt>: images used for the Vector Map iconic badges.
			* <tt>mapIcon.csv</tt>: images used for the Google Map widget.
			* <tt>patterns.csv</tt>: pattern images used in various chart widgets for filled areas.

			To add custom icons you must:

			# Create a new registry <tt>.csv</tt> file with the correct fields and values for each of the custom icons added to the server. This should have a filename that differs from the set of shipped registry files listed above. See further down for the format of this file.
			# Copy this file into the icon registry directory, for example:
			#: <tt>[INSTALL_HOME]]/server/webapps/enportal/WEB-INF/xmlroot/appboard/config/iconregistry/my_custom_icons.csv</tt>

			==== Registry Format ====
			This table describes the <tt>csv</tt> format as used by the icon registry. All fields are required and errors may result in failure to process the entire registry. A good idea is to also look at the default <tt>base.csv</tt> file as an example.

			{\|class='wikitable'
			!#
			!Field
			!Type
			!Description
			\|-
			\|align='right'\|1
			\|<tt>type</tt>
			\|string
			\|Should always be set to <tt>base</tt>.
			\|-
			\|align='right'\|2
			\|<tt>style</tt>
			\|string
			\|This column is optional, if included set to <tt>3d</tt>.
			\|-
			\|align='right'\|3
			\|<tt>id</tt>
			\|string
			\|Unique identifier across all tile registry files.
			\|-
			\|align='right'\|4
			\|<tt>label</tt>
			\|string
			\|The label shown in the user interface, such as in the Icon Chooser.
			\|-
			\|align='right'\|5
			\|<tt>rasterPath</tt>
			\|string
			\|TODO
			\|-
			\|align='right'\|6
			\|<tt>vectorPath</tt>
			\|string
			\|This can be left blank in most instances unless producing vector <tt>swf</tt> icons. Otherwise it should provide a path relative to the <tt>visualizer</tt> directory as with the rasterPath.
			\|-
			\|align='right'\|7
			\|<tt>width</tt>
			\|integer
			\|Width of the icon in pixels.
			\|-
			\|align='right'\|8
			\|<tt>height</tt>
			\|integer
			\|Height of the icon in pixels.
			\|-
			\|align='right'\|9
			\|<tt>centerX</tt>
			\|integer
			\|The x-axis center point. Not all images have a center in the middle of the image, so for correct placement set the image center correctly.
			\|-
			\|align='right'\|10
			\|<tt>centerY</tt>
			\|integer
			\|As above for the y-axis center point.
			\|-
			\|align='right'\|11
			\|<tt>tags</tt>
			\|string
			\|Set of space separated tags to allow for easy searching in the Icon Chooser when large numbers of icons are available.
			\|}

imported>Jason.nicholls: /* Icon Chooser */

2014-07-30T06:39:12Z

Icon Chooser

← Older revision		Revision as of 06:39, 30 July 2014
Line 9:		Line 9:
	== Icon Chooser ==		== Icon Chooser ==

	When configuring a widget that supports icons the ''Icon Chooser'' is used to make a selection, as shown below:		When configuring a widget that supports icons the ''Icon Chooser'' is used to make a selection, as shown below. The ''Keyword Search'' can be used to search through tags associated with each icon. This will be explained in the sections below detailing how to add custom icons.

	[[File:appboard-2.4-icon-chooser.png\|frame\|center\|Icon Chooser dialog]]		[[File:appboard-2.4-icon-chooser.png\|frame\|center\|Icon Chooser dialog]]

	~~The ''Keyword Search'' can be used to search through tags associated with each icon. This will be explained in the sections below detailing how to add custom icons.~~

	{{Note\|The Google Map widget and Vector Map widgets have a specific set of icons only used for those widgets. The list of images that appear in the Icon Chooser will differ when editing those widgets.}}		{{Note\|The Google Map widget and Vector Map widgets have a specific set of icons only used for those widgets. The list of images that appear in the Icon Chooser will differ when editing those widgets.}}

imported>Jason.nicholls: /* Icon Chooser */

2014-07-30T06:38:06Z

Icon Chooser

← Older revision		Revision as of 06:38, 30 July 2014
Line 12:		Line 12:

	[[File:appboard-2.4-icon-chooser.png\|frame\|center\|Icon Chooser dialog]]		[[File:appboard-2.4-icon-chooser.png\|frame\|center\|Icon Chooser dialog]]

			The ''Keyword Search'' can be used to search through tags associated with each icon. This will be explained in the sections below detailing how to add custom icons.

			{{Note\|The Google Map widget and Vector Map widgets have a specific set of icons only used for those widgets. The list of images that appear in the Icon Chooser will differ when editing those widgets.}}

imported>Jason.nicholls at 06:30, 30 July 2014

2014-07-30T06:30:41Z

← Older revision		Revision as of 06:30, 30 July 2014
Line 6:		Line 6:

	Please note this page refers to icons as defined by setting a ''Default Icon'' or via ''Icon Filters''. ''Status Shapes'' are not icons as such but automatically rendered shapes with colour tints applied. The set of shapes is defined in code and not user extensible.		Please note this page refers to icons as defined by setting a ''Default Icon'' or via ''Icon Filters''. ''Status Shapes'' are not icons as such but automatically rendered shapes with colour tints applied. The set of shapes is defined in code and not user extensible.

			== Icon Chooser ==

			When configuring a widget that supports icons the ''Icon Chooser'' is used to make a selection, as shown below:

			[[File:appboard-2.4-icon-chooser.png\|frame\|center\|Icon Chooser dialog]]