Icon and image resource files for 7. consoles
Images are installed on the consoles in PATROL 3. x, but the PATROL 7. x consoles get images from the PATROL Console Server, so you will provide your icons and images to the console server for PATROL 7. x.
For the 7. x PATROL Console, icons are placed in a resource file. Each KM package will have one resource file that contains all the icons and images for the KM.
Other images that are required by the KM, including images displayed in response() function dialog boxes, will be in a resource file for the new 7. x consoles as well. The resource file for your KM package is installed into the KM package directory and is named resource.mk4.
Note
- The first release of the console server includes all KM icons and other images in one resource file. This default resource file is installed in the knowledge/default console server directory. If some of your images are not included in the default resource file, you will include them with your KM.
- When you install your resource file, you must not install it in the knowledge/default directory, or you will overwrite the default icon resource file, and KMs that depend on this resource for their images will no longer have their icons. You must install your resource file in your knowledge/ prdKM _version directory. For more information about PATROL file locations, see PATROL KM product file destinations.
The resource.mk4 resource file is created using the kmres.exe command-line tool provided as part of the PATROL Console Server.
kmres.exe
The kmres.exe program is located in the bin directory of your PATROL Console Server install directory (PATROL_ROOT/bin/ platform ). On Windows, you can run the kmres.exe program from any command prompt because the bin directory is added to the path during the console server installation. The following table describes common kmres.exe usage:
Note
On UNIX, you can put these utilities in your path by sourcing the PATROL 7 environment variables by running the following command from the $PATROL_ROOT directory: ./patrol7rc.sh
kmres.exe options
Usage |
Description |
|---|---|
kmres -v |
Prints the version |
kmres [-h | -help] |
Prints the Help message |
kmres -res resfile -addicon icon_file -name icon_res_name [-size icon_size ] [-overRide] |
Adds an icon to a resource file When -overRide is specified, duplicate icon are overwritten. |
kmres -res resfile -addicons icon_dir [-overRide] |
Adds images from a directory to a resource file When -overRide is specified, duplicate icon are overwritten. |
kmres -res resfile -addimage image_file -name image_res_name |
Adds an image to a resource file |
kmres -res resfile -addimages image_dir |
Adds images from a directory to a resource file |
kmres -res resfile -print |
Lists the contents of a resource file |
kmres -res resfile -list |
Lists the content tree of a resource file |
kmres -res resfile -listIcons |
Lists the content tree of a resource file |
In the preceding table:
- resfile represents the name of the KM resource file (resource.mk4 )
- icon_file represents the name of the icon file. For more information, see Icon file names.
- icon_res_name represents the name of the icon referenced by the KM, the base icon name
- image_file represents the name of the image file, including the file extension
- image_res_name represents the base name of the image file, excluding the file extension
Creating a KM image resource file with kmres.exe
Use the following procedure to create a KM image resource file for use with the PATROL Console Server.
Before you begin
Before you create an image resource file for your KM, put all of your images in a directory on a computer that has the console server installed.
Note
The images must be in the new format required by the PATROL 7. x Consoles. For more information about image file formats, see Icons for PATROL 7. consoles.
To create a KM image resource file
- Open a command prompt on a computer that has your image files and the console server installed.
- Create a new resource file with the following command:
kmres -create resource.mk4 - Add all your icons to the resource file with the following command:
kmres -res resource.mk4 -addiconsicondir
Where icondir is the directory and path that contains your icon files.
or
Add individual icons or images to the resource file using the following command:
kmres -res resource.mk4 -addiconiconfilename-nameicon_res_name
Where iconfilename is the name and path of the icon you are adding, and icon_res_name is the base icon name.
Comments
Log in or register to comment.