Recent changes to Plugins automatic installation

Plugins automatic installation modified by Alexey T.

Alexey T. — Wed, 15 Mar 2017 08:50:10 -0000

Plugins automatic installation modified by Alexey T.

Alexey T. — Sat, 11 Mar 2017 09:27:22 -0000

--- v18
+++ v19
@@ -60,8 +60,8 @@

 * file: Only for binary plugins: DLL file name of plugin (without path).
 * params: Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more parameters, separated with ";". 
-    * For command plugins: "method_name,lexers_list" (list is comma-separated)
-    * For event plugins: "events_list,lexers_list" (event names are from: [py event names])
+    * For command plugins: "method_name;lexers_list" (list is comma-separated)
+    * For event plugins: "events_list;lexers_list" (event names are from: [py event names])
     * For auto-completion/ find-id plugins: lexers_list 
     * For panel plugins: empty

Plugins automatic installation modified by Alexey T.

Alexey T. — Sat, 11 Mar 2017 09:25:39 -0000

--- v17
+++ v18
@@ -53,20 +53,25 @@
     * Panels
     * Complete
     * FindID
+
 * id: Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear. To specify separators in submenu (don't use them in root menu), write them like this: 
     * 1st separator with id "Submenu\\-1" with params "nnn" (any string)
     * 2nd separator with id "Submenu\\-2" with params "nnn", etc.
+
 * file: Only for binary plugins: DLL file name of plugin (without path).
-* params: Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more parameters, separated with ";". For panel plugins it's empty. For command/ auto-completion/ find-id plugins it's comma-separated lexers list.
+* params: Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more parameters, separated with ";". 
+    * For command plugins: "method_name,lexers_list" (list is comma-separated)
+    * For event plugins: "events_list,lexers_list" (event names are from: [py event names])
+    * For auto-completion/ find-id plugins: lexers_list 
+    * For panel plugins: empty
+
 * hotkey: Hotkey for command plugin item (optional). Example of simple values: "Alt+A", "Ctrl+Shift+F1", example of combo keys: "Ctrl+Shift+A * Ctrl+B * Ctrl+C". If lexers list (in params=) empty, then hotkey saves to file SynHotkeys.ini. If lexers list not empty, then hotkey saves to each "SynHotkeys lexer nnnn.ini" for all mentioned lexers.

 Sections "lexerN"
 -----------------
-If type is "lexer", then instead of sections "iniN" you must use sections "lexer1" to "lexer120". These sections list lexers and/or autocomplete files (*.acp) present in package. Allowed keys:
+If type is "lexer", then instead of sections "iniN" you must use sections "lexer1" to "lexer120". These sections list lexers and/or autocomplete files (*.acp) present in package. First section must be for main lexer, others for sublexers of main lexer. Keys in sections:

-* file: Lexer base filename w/o extension (e.g. "MyName"). You must supply file "MyName.lcf" and/or file "MyName.acp" in package root (both are optional) for each lexer section.
-* link1: Name of 1st linked lexer (e.g. if your lexer has sublexers C and C++, then 1st linked name is "C", 2nd "C++")
-* link2: Name of 2nd linked lexer
-* link3: Name of 3rd linked lexer
-* link4: Name of 4th linked lexer
-* link5: Name of 5th linked lexer
+* file: Lexer base filename w/o extension, e.g. "MyName". You must supply file "MyName.lcf" and/or file "MyName.acp" in package root (both are optional) for each lexer section.
+* link1: Name of 1st linked sublexer (e.g. if lexer has sublexers C and C++, then 1st linked name is "C", 2nd "C++")
+* link2: Name of 2nd linked sublexer
+* link3: etc

Plugins automatic installation modified by Alexey T.

Alexey T. — Sat, 11 Mar 2017 09:06:34 -0000

--- v16
+++ v17
@@ -1,65 +1,72 @@
-Plugins and add-ons for SynWrite can be installed automatically. You should pack files into RAR or ZIP archive and place text file "install.inf" into archive root. Then user should open your rar/zip archive in SynWrite, and program will suggest auto-installation of this archive.
+Install.inf
+===========
+Add-ons for SynWrite can be installed automatically. You should pack files into ZIP archive and place text file "install.inf" into archive root. Then user should open zip in SynWrite, and program will suggest auto-installation of this package.

-An example of file "install.inf" for SynJedi plugin:
+Example of install.inf for SynJedi plugin:

     [info]
     title=SynJedi
     type=plugin
     subdir=SynJedi
-
+       
     [ini]
     section=Complete
     id=SynJedi
     file=SynJedi.dll
     params=Python;

-An example for Python command plugin (lexers C and C++ specified, hotkey Alt+R specified):
+Example for Python command plugin (lexers C/C++ specified):

     [info]
     title=My Sample
     type=py-plugin
     subdir=syn_my_sample
-
+      
     [ini]
     section=Commands
     id=My Sample
-    params=run;C,C++;Alt+R;
+    params=run;C,C++
+    hotkey=Alt+C

 Section "info"
 --------------

-Id | Meaning
----|--------
-title | Official title. (Without ending dot.)
-type | One of strings: "plugin" for binary plugins, "py-plugin" for Python plugins, "template" for data files to be copied into "Template" folder, "root-addon" for any files to be copied into SynWrite installation folder, "lexer" for lexers and autocomplete files.
-desc | One-line description of add-on, more informative than title. (Optional. Without ending dot.)
-subdir | Only for plugins and data files (ignored for root-addons and lexers). Name of subfolder, into which all package files are unpacked. For plugins, this name often equals to plugin name. For data files, this name is one of standard names, which you see inside SynWrite "Template" folder ("conv", "colors", etc). This value must be valid folder name without slashes.
-
-Section "ini"
--------------
-Section's needed only for plugins and should have such fields:
-
-Id | Meaning
----|--------
-section | Section name for "SynPlugins.ini" file. It can be one of: "Panels", "Complete", "FindID", "Commands", "Events".
-id | Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear. To specify separators in submenu (don't use them in root menu), write them like this: 1st separator with id "Submenu\\-1" with params "nnn" (any string), 2nd separator with id "Submenu\\-2" with params "nnn", etc.
-file | Only for binary plugins: DLL file name of plugin (without path).
-params | Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more plugin parameters, separated with ";". For panel plugins it's empty; for auto-completion and find-id plugins it's comma-separated lexers list; for command plugins see [Plugins manual installation] for details.
+* title: Official title (without ending dot).
+* type: One of fixed strings:
+    * "plugin" for binary plugins
+    * "py-plugin" for Python plugins
+    * "template" for any files for "Data" folder
+    * "lexer" for lexers and autocomplete files
+    * "root-addon" for any files for SynWrite installation folder
+* desc: One-line description, more informative than title (optional).
+* subdir: Only for plugins and data files (ignored for root-addons and lexers). Name of subfolder, into which all package files are unpacked. For Python plugins, this is Python module name (e.g. syn_my_name). For data files, this name is one of standard names, which you see inside SynWrite "Data" folder ("conv", "colors", etc). This value must be valid folder name without slashes.

 Sections "iniN"
 ---------------
-If plugin needs more than one line in "SynPlugins.ini", add more sections: besides section "ini" add sections from "ini1" up to "ini400". Sections can be with gaps, e.g. only 1, 10, 20, 40.
+This describes section "ini" and sections "ini1" to "ini400".
+Sections can be with gaps, e.g. only 1, 10, 20, 40.
+Sections needed only for plugins and have such fields:
+
+* section: Section name for SynPlugins.ini file. Can be one of: 
+    * Commands
+    * Events
+    * Panels
+    * Complete
+    * FindID
+* id: Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear. To specify separators in submenu (don't use them in root menu), write them like this: 
+    * 1st separator with id "Submenu\\-1" with params "nnn" (any string)
+    * 2nd separator with id "Submenu\\-2" with params "nnn", etc.
+* file: Only for binary plugins: DLL file name of plugin (without path).
+* params: Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more parameters, separated with ";". For panel plugins it's empty. For command/ auto-completion/ find-id plugins it's comma-separated lexers list.
+* hotkey: Hotkey for command plugin item (optional). Example of simple values: "Alt+A", "Ctrl+Shift+F1", example of combo keys: "Ctrl+Shift+A * Ctrl+B * Ctrl+C". If lexers list (in params=) empty, then hotkey saves to file SynHotkeys.ini. If lexers list not empty, then hotkey saves to each "SynHotkeys lexer nnnn.ini" for all mentioned lexers.

 Sections "lexerN"
 -----------------
 If type is "lexer", then instead of sections "iniN" you must use sections "lexer1" to "lexer120". These sections list lexers and/or autocomplete files (*.acp) present in package. Allowed keys:

-Id | Meaning
----|--------
-file | Lexer base filename w/o extension (e.g. "MyName"). You must supply file "MyName.lcf" and/or file "MyName.acp" in package root (both are optional) for each lexer section.
-link1 | Name of 1st linked lexer (e.g. if your lexer has sublexers C and C++, then 1st linked name is "C", 2nd "C++")
-link2 | Name of 2nd linked lexer
-link3 | Name of 3rd linked lexer
-link4 | Name of 4th linked lexer
-link5 | Name of 5th linked lexer
-
+* file: Lexer base filename w/o extension (e.g. "MyName"). You must supply file "MyName.lcf" and/or file "MyName.acp" in package root (both are optional) for each lexer section.
+* link1: Name of 1st linked lexer (e.g. if your lexer has sublexers C and C++, then 1st linked name is "C", 2nd "C++")
+* link2: Name of 2nd linked lexer
+* link3: Name of 3rd linked lexer
+* link4: Name of 4th linked lexer
+* link5: Name of 5th linked lexer

Plugins automatic installation modified by Alexey T.

Alexey T. — Sat, 04 Jun 2016 16:15:23 -0000

--- v15
+++ v16
@@ -48,7 +48,7 @@

 Sections "iniN"
 ---------------
-If plugin needs more than one line in "SynPlugins.ini", add more sections: besides section "ini" add sections from "ini1" up to "ini120". List additional sections without gaps, e.g. no missed section allowed between "ini2" and "ini4".
+If plugin needs more than one line in "SynPlugins.ini", add more sections: besides section "ini" add sections from "ini1" up to "ini400". Sections can be with gaps, e.g. only 1, 10, 20, 40.

 Sections "lexerN"
 -----------------

Plugins automatic installation modified by Alexey T.

Alexey T. — Tue, 28 Oct 2014 20:23:18 -0000

--- v14
+++ v15
@@ -33,7 +33,7 @@
 title | Official title. (Without ending dot.)
 type | One of strings: "plugin" for binary plugins, "py-plugin" for Python plugins, "template" for data files to be copied into "Template" folder, "root-addon" for any files to be copied into SynWrite installation folder, "lexer" for lexers and autocomplete files.
 desc | One-line description of add-on, more informative than title. (Optional. Without ending dot.)
-subdir | Name of subfolder, into which all archive files are unpacked. For plugins, this subfolder name often equals to plugin name. For templates, this subfolder name is one of standard names, which you see inside SynWrite's "Template" folder ("conv", "colors", etc). This value must be valid Windows folder name (without slashes).
+subdir | Only for plugins and data files (ignored for root-addons and lexers). Name of subfolder, into which all package files are unpacked. For plugins, this name often equals to plugin name. For data files, this name is one of standard names, which you see inside SynWrite "Template" folder ("conv", "colors", etc). This value must be valid folder name without slashes.

 Section "ini"
 -------------

Plugins automatic installation modified by Alexey T.

Alexey T. — Tue, 28 Oct 2014 19:57:18 -0000

--- v13
+++ v14
@@ -31,7 +31,7 @@
 Id | Meaning
 ---|--------
 title | Official title. (Without ending dot.)
-type | One of strings: "plugin" for binary plugins, "py-plugin" for Python plugins, "template" for data files to be copied into "Template" folder, "root-addon" for any files to be copied into SynWrite installation folder.
+type | One of strings: "plugin" for binary plugins, "py-plugin" for Python plugins, "template" for data files to be copied into "Template" folder, "root-addon" for any files to be copied into SynWrite installation folder, "lexer" for lexers and autocomplete files.
 desc | One-line description of add-on, more informative than title. (Optional. Without ending dot.)
 subdir | Name of subfolder, into which all archive files are unpacked. For plugins, this subfolder name often equals to plugin name. For templates, this subfolder name is one of standard names, which you see inside SynWrite's "Template" folder ("conv", "colors", etc). This value must be valid Windows folder name (without slashes).

@@ -49,3 +49,17 @@
 Sections "iniN"
 ---------------
 If plugin needs more than one line in "SynPlugins.ini", add more sections: besides section "ini" add sections from "ini1" up to "ini120". List additional sections without gaps, e.g. no missed section allowed between "ini2" and "ini4".
+
+Sections "lexerN"
+-----------------
+If type is "lexer", then instead of sections "iniN" you must use sections "lexer1" to "lexer120". These sections list lexers and/or autocomplete files (*.acp) present in package. Allowed keys:
+
+Id | Meaning
+---|--------
+file | Lexer base filename w/o extension (e.g. "MyName"). You must supply file "MyName.lcf" and/or file "MyName.acp" in package root (both are optional) for each lexer section.
+link1 | Name of 1st linked lexer (e.g. if your lexer has sublexers C and C++, then 1st linked name is "C", 2nd "C++")
+link2 | Name of 2nd linked lexer
+link3 | Name of 3rd linked lexer
+link4 | Name of 4th linked lexer
+link5 | Name of 5th linked lexer
+

Plugins automatic installation modified by Alexey T.

Alexey T. — Sun, 26 Oct 2014 20:00:26 -0000

--- v12
+++ v13
@@ -33,7 +33,6 @@
 title | Official title. (Without ending dot.)
 type | One of strings: "plugin" for binary plugins, "py-plugin" for Python plugins, "template" for data files to be copied into "Template" folder, "root-addon" for any files to be copied into SynWrite installation folder.
 desc | One-line description of add-on, more informative than title. (Optional. Without ending dot.)
-ver | Version string. (Optional.)
 subdir | Name of subfolder, into which all archive files are unpacked. For plugins, this subfolder name often equals to plugin name. For templates, this subfolder name is one of standard names, which you see inside SynWrite's "Template" folder ("conv", "colors", etc). This value must be valid Windows folder name (without slashes).

 Section "ini"
@@ -43,7 +42,7 @@
 Id | Meaning
 ---|--------
 section | Section name for "SynPlugins.ini" file. It can be one of: "Panels", "Complete", "FindID", "Commands", "Events".
-id | Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear. To specify separators in submenu (don't use them in root menu), write them like this: 1st separator with id "Submenu\-1" with params "nnn" (any string), 2nd separator with id "Submenu\-2" with params "nnn", etc.
+id | Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear. To specify separators in submenu (don't use them in root menu), write them like this: 1st separator with id "Submenu\\-1" with params "nnn" (any string), 2nd separator with id "Submenu\\-2" with params "nnn", etc.
 file | Only for binary plugins: DLL file name of plugin (without path).
 params | Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more plugin parameters, separated with ";". For panel plugins it's empty; for auto-completion and find-id plugins it's comma-separated lexers list; for command plugins see [Plugins manual installation] for details.

Plugins automatic installation modified by Alexey T.

Alexey T. — Sun, 26 Oct 2014 19:58:23 -0000

--- v11
+++ v12
@@ -43,10 +43,10 @@
 Id | Meaning
 ---|--------
 section | Section name for "SynPlugins.ini" file. It can be one of: "Panels", "Complete", "FindID", "Commands", "Events".
-id | Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear; if it is "Submenu\\-", then separator line will appear.
+id | Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear. To specify separators in submenu (don't use them in root menu), write them like this: 1st separator with id "Submenu\-1" with params "nnn" (any string), 2nd separator with id "Submenu\-2" with params "nnn", etc.
 file | Only for binary plugins: DLL file name of plugin (without path).
 params | Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more plugin parameters, separated with ";". For panel plugins it's empty; for auto-completion and find-id plugins it's comma-separated lexers list; for command plugins see [Plugins manual installation] for details.

 Sections "iniN"
 ---------------
-If plugin needs more than one line in "SynPlugins.ini", add more sections: besides section __ini__ add sections from __ini1__ up to __iniN__ (maximal value of N is rather big, about 120). List additional sections without gaps, e.g. no missed section allowed between __ini2__ and __ini4__.
+If plugin needs more than one line in "SynPlugins.ini", add more sections: besides section "ini" add sections from "ini1" up to "ini120". List additional sections without gaps, e.g. no missed section allowed between "ini2" and "ini4".

Plugins automatic installation modified by Alexey T.

Alexey T. — Tue, 12 Aug 2014 16:31:17 -0000

--- v10
+++ v11
@@ -25,23 +25,28 @@
     id=My Sample
     params=run;C,C++;Alt+R;

-Section "info" should have such fields:
+Section "info"
+--------------

 Id | Meaning
----|---
+---|--------
 title | Official title. (Without ending dot.)
-type | One of strings: "plugin" for binary plugins, "py-plugin" for Python plugins, "template" for additional data files to be copied into "Template" folder.
+type | One of strings: "plugin" for binary plugins, "py-plugin" for Python plugins, "template" for data files to be copied into "Template" folder, "root-addon" for any files to be copied into SynWrite installation folder.
 desc | One-line description of add-on, more informative than title. (Optional. Without ending dot.)
 ver | Version string. (Optional.)
 subdir | Name of subfolder, into which all archive files are unpacked. For plugins, this subfolder name often equals to plugin name. For templates, this subfolder name is one of standard names, which you see inside SynWrite's "Template" folder ("conv", "colors", etc). This value must be valid Windows folder name (without slashes).

-Section "ini" is needed only for plugins and should have such fields:
+Section "ini"
+-------------
+Section's needed only for plugins and should have such fields:

 Id | Meaning
----|---
+---|--------
 section | Section name for "SynPlugins.ini" file. It can be one of: "Panels", "Complete", "FindID", "Commands", "Events".
 id | Text before "=" char for "SynPlugins.ini" file. For command plugins: if it is "Submenu\ItemName", then menu item in submenu will appear; if it is "Submenu\\-", then separator line will appear.
 file | Only for binary plugins: DLL file name of plugin (without path).
 params | Additional string, which is appended to the line of "SynPlugins.ini" file. It's one or more plugin parameters, separated with ";". For panel plugins it's empty; for auto-completion and find-id plugins it's comma-separated lexers list; for command plugins see [Plugins manual installation] for details.

+Sections "iniN"
+---------------
 If plugin needs more than one line in "SynPlugins.ini", add more sections: besides section __ini__ add sections from __ini1__ up to __iniN__ (maximal value of N is rather big, about 120). List additional sections without gaps, e.g. no missed section allowed between __ini2__ and __ini4__.