installation:package-info

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
installation:package-info [2017/03/27 17:18] – [install-syntax] admininstallation:package-info [2018/01/10 20:42] (current) – external edit 127.0.0.1
Line 4: Line 4:
  
 The file content is an XML document, that can be split into 3 parts: The file content is an XML document, that can be split into 3 parts:
-  * Package description +  * [[#package-description|Package description]] 
-  * Installation Instructions -> **install** +  * [[#installation-instructions|Installation Instructions]] 
-  * Uninstallation Instructions -> **uninstall**+  * [[#uninstallation-instructions|Uninstallation Instructions]]
  
 <file xml package-info.xml> <file xml package-info.xml>
Line 127: Line 127:
 <code xml><install-macro path="%{macros}%/format.hemcr"/></code> <code xml><install-macro path="%{macros}%/format.hemcr"/></code>
 Registers and activates macro from the given path on target machine. The instruction shall be called after all necessary files are already copied to target directory. Registers and activates macro from the given path on target machine. The instruction shall be called after all necessary files are already copied to target directory.
- 
-Attributes: 
   * **path** - path to macro to install on the target machine. You can use [[#installer_varaibles|installer variables]] withing destination name.   * **path** - path to macro to install on the target machine. You can use [[#installer_varaibles|installer variables]] withing destination name.
  
Line 141: Line 139:
 <code xml><install-color path="%{colors}%/color_highcontrast.xml"/></code> <code xml><install-color path="%{colors}%/color_highcontrast.xml"/></code>
 Registers and activates color palette from the given path on target machine. The instruction shall be called after all necessary files are already copied to target directory. Registers and activates color palette from the given path on target machine. The instruction shall be called after all necessary files are already copied to target directory.
- 
-Attributes: 
   * **path** - path to keyboard mapping to install on the target machine. You can use [[#installer_varaibles|installer variables]] withing destination name.   * **path** - path to keyboard mapping to install on the target machine. You can use [[#installer_varaibles|installer variables]] withing destination name.
  
Line 148: Line 144:
 <code xml><install-template path="%{colors}%/default.cpp"/></code> <code xml><install-template path="%{colors}%/default.cpp"/></code>
 Registers and activates file template from the given path on target machine. The instruction shall be executed after all necessary files are already copied to target directory. Registers and activates file template from the given path on target machine. The instruction shall be executed after all necessary files are already copied to target directory.
- 
-Attributes: 
   * **path** - path to file template to install on the target machine. You can use [[#installer_varaibles|installer variables]] withing destination name.   * **path** - path to file template to install on the target machine. You can use [[#installer_varaibles|installer variables]] withing destination name.
  
Line 164: Line 158:
 <code xml><uninstall-plugin id="CAD932AC-894A-48F2-BAAD-D270B2B28C51"/></code> <code xml><uninstall-plugin id="CAD932AC-894A-48F2-BAAD-D270B2B28C51"/></code>
 Deactives and unregister the plugin by ID. Shall be done before the plugin files are deleted. Deactives and unregister the plugin by ID. Shall be done before the plugin files are deleted.
-Attributes: 
   * **id** - unique ID of the plugin (defined in plugin bundle and in the plugin itself).   * **id** - unique ID of the plugin (defined in plugin bundle and in the plugin itself).
  
 ==== uninstall-syntax ==== ==== uninstall-syntax ====
 +<code xml><uninstall-syntax id="json"/></code>
 +Deactives and unregister the syntax scheme by ID. Shall be done before the syntax files are deleted.
 +  * **id** - unique ID of the syntax (defined in plugin bundle and in the syntax scheme itself).
 +
 ==== uninstall-macro ==== ==== uninstall-macro ====
 +<code xml><uninstall-macro name="%macros%/format.hemcr"/></code>
 +Deactives and unregister the macro by path. Shall be done before the macro file is deleted.
 +  * **name** - path to the macro file on the target machine. You can use [[#installer_varaibles|installer variables]] withing destination name.
 +
 ==== uninstall-keymap ==== ==== uninstall-keymap ====
 +<code xml><uninstall-keymap name="%keympas%/vim.xml"/></code>
 +Deactives and unregisters the keymap by path. Shall be done before the keymap file is deleted.
 +  * **name** - path to the keymap file on the target machine (normally %keymaps%/<keymap name>.xml). You can use [[#installer_varaibles|installer variables]] withing destination name.
 +
 ==== uninstall-color ==== ==== uninstall-color ====
 +<code xml><uninstall-color name="%colors%/color_highcontrast.xml"/></code>
 +Deactives and unregisters the color palette by path. Shall be done before the color palette file is deleted.
 +  * **name** - path to the color palette file on the target machine (normally %colors%/color_<palette name>.xml). You can use [[#installer_varaibles|installer variables]] withing destination name.
 +
 ==== uninstall-template ==== ==== uninstall-template ====
 +<code xml><uninstall-template name="%templates%/default.cpp"/></code>
 +Deactives and unregisters the file template by path. Shall be done before the file template file is deleted.
 +  * **name** - path to the template file on the target machine (normally %templates%/default.<ext>). You can use [[#installer_varaibles|installer variables]] withing destination name.
 +
  
 ==== remove-dir ==== ==== remove-dir ====
 <code xml><remove-dir name="%{plugins}%/view-editor-toolbar"/></code> <code xml><remove-dir name="%{plugins}%/view-editor-toolbar"/></code>
 Recursively removes directory. Recursively removes directory.
-Attributes: +  * **name** - path to the directory to be deleted on the target machine. You may use [[#installer_varaibles|installer variables]] withing name attribute.
-  * **name** - path to directory to be deleted on target machine. You may use [[#installer_varaibles|installer variables]] withing name attribute.+
  
 ==== remove-file ==== ==== remove-file ====
 +<code xml><remove-file name="%{plugins}%/view-editor-toolbar/main.hejs"/></code>
 +Removes a file on target machine.
 +  * **name** - path to a file to be deleted on the target machine. You may use [[#installer_varaibles|installer variables]] withing name attribute.
 +
 ===== Installer Varaibles ===== ===== Installer Varaibles =====
 There are some buil-in variables, that can be used in installer instructions and which may simplify building of the file paths on destiantion side: There are some buil-in variables, that can be used in installer instructions and which may simplify building of the file paths on destiantion side: