[pmg-devel] [PATCH pmg-gui 1/1] add onlineHelp properties to all edit windows

Stoiko Ivanov s.ivanov at proxmox.com
Wed Oct 3 13:37:34 CEST 2018


Signed-off-by: Stoiko Ivanov <s.ivanov at proxmox.com>
---
 js/BackupRestore.js          |  1 +
 js/ClamAVDatabase.js         |  3 ++-
 js/ClusterAdministration.js  |  1 +
 js/FetchmailEdit.js          |  1 +
 js/LDAPConfig.js             |  1 +
 js/LDAPGroupEditor.js        |  1 +
 js/LDAPUserEditor.js         |  1 +
 js/MailProxyOptions.js       |  3 ++-
 js/MailProxyPorts.js         |  3 ++-
 js/MailProxyRelaying.js      |  4 +++-
 js/MailProxyTLS.js           |  3 ++-
 js/MailProxyTLSDomains.js    |  1 +
 js/MyNetworks.js             |  2 ++
 js/ObjectGroupList.js        |  2 ++
 js/RelayDomains.js           |  2 ++
 js/RuleEditor.js             |  1 +
 js/SpamDetectorLanguages.js  |  1 +
 js/SpamDetectorOptions.js    |  3 ++-
 js/SpamQuarantineOptions.js  |  3 ++-
 js/SystemOptions.js          |  4 +++-
 js/Transport.js              |  2 ++
 js/UserBlackWhiteList.js     |  1 +
 js/UserEdit.js               |  1 +
 js/Utils.js                  | 22 ++++++++++++++++++++++
 js/VirusDetectorOptions.js   |  3 ++-
 js/VirusQuarantineOptions.js |  3 ++-
 26 files changed, 63 insertions(+), 10 deletions(-)

diff --git a/js/BackupRestore.js b/js/BackupRestore.js
index 541081e..70044d3 100644
--- a/js/BackupRestore.js
+++ b/js/BackupRestore.js
@@ -17,6 +17,7 @@ Ext.define('pmg-backup-list', {
 Ext.define('PMG.RestoreWindow', {
     extend: 'Proxmox.window.Edit',
     xtype: 'pmgRestoreWindow',
+    onlineHelp: 'chapter_pmgbackup',
 
     showProgress: true,
     title: gettext('Restore'),
diff --git a/js/ClamAVDatabase.js b/js/ClamAVDatabase.js
index 005a593..43d4e6c 100644
--- a/js/ClamAVDatabase.js
+++ b/js/ClamAVDatabase.js
@@ -22,7 +22,8 @@ Ext.define('PMG.ClamAVDatabaseConfig', {
 	Ext.apply(me, {
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_clamav'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
diff --git a/js/ClusterAdministration.js b/js/ClusterAdministration.js
index 0fc842a..c1942b9 100644
--- a/js/ClusterAdministration.js
+++ b/js/ClusterAdministration.js
@@ -29,6 +29,7 @@ Ext.define('pmg-cluster', {
 Ext.define('PMG.ClusterJoinNodeWindow', {
     extend: 'Proxmox.window.Edit',
     xtype: 'pmgClusterJoinNodeWindow',
+    onlineHelp: 'pmgcm_join',
 
     title: gettext('Cluster Join'),
 
diff --git a/js/FetchmailEdit.js b/js/FetchmailEdit.js
index cafb9ea..57409a7 100644
--- a/js/FetchmailEdit.js
+++ b/js/FetchmailEdit.js
@@ -3,6 +3,7 @@
 Ext.define('PMG.FetchmailEdit', {
     extend: 'Proxmox.window.Edit',
     xtype: 'pmgFetchmailEdit',
+    onlineHelp: 'pmgconfig_fetchmail',
 
     userid: undefined,
 
diff --git a/js/LDAPConfig.js b/js/LDAPConfig.js
index 71760df..8990847 100644
--- a/js/LDAPConfig.js
+++ b/js/LDAPConfig.js
@@ -168,6 +168,7 @@ Ext.define('PMG.LDAPInputPanel', {
 Ext.define('PMG.LDAPEdit', {
     extend: 'Proxmox.window.Edit',
     alias: 'widget.pmgLDAPEdit',
+    onlineHelp: 'pmgconfig_ldap',
 
     subject: 'LDAP Profile',
     isAdd: true,
diff --git a/js/LDAPGroupEditor.js b/js/LDAPGroupEditor.js
index 4280a41..460d340 100644
--- a/js/LDAPGroupEditor.js
+++ b/js/LDAPGroupEditor.js
@@ -94,6 +94,7 @@ Ext.define('PMG.LDAPGroupInputPanel', {
 Ext.define('PMG.LDAPGroupEditor', {
     extend: 'Proxmox.window.Edit',
     alias: 'widget.pmgLDAPGroupEditor',
+    onlineHelp: 'pmgconfig_ldap',
 
     width: 500,
 
diff --git a/js/LDAPUserEditor.js b/js/LDAPUserEditor.js
index 1fcaf8f..1d50d30 100644
--- a/js/LDAPUserEditor.js
+++ b/js/LDAPUserEditor.js
@@ -48,6 +48,7 @@ Ext.define('PMG.LDAPUserInputPanel', {
 Ext.define('PMG.LDAPUserEditor', {
     extend: 'Proxmox.window.Edit',
     alias: 'widget.pmgLDAPUserEditor',
+    onlineHelp: 'pmgconfig_ldap',
 
     width: 500,
 
diff --git a/js/MailProxyOptions.js b/js/MailProxyOptions.js
index 14e5f73..eb080ec 100644
--- a/js/MailProxyOptions.js
+++ b/js/MailProxyOptions.js
@@ -83,7 +83,8 @@ Ext.define('PMG.MailProxyOptions', {
 	    }],
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_mailproxy_options'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
diff --git a/js/MailProxyPorts.js b/js/MailProxyPorts.js
index f96182d..8abbb1f 100644
--- a/js/MailProxyPorts.js
+++ b/js/MailProxyPorts.js
@@ -7,7 +7,8 @@ Ext.define('PMG.MailProxyPorts', {
     monStoreErrors: true,
 
     editorConfig: {
-	url: '/api2/extjs/config/mail'
+	url: '/api2/extjs/config/mail',
+	onlineHelp: 'pmgconfig_mailproxy_ports'
     },
 
     interval: 5000,
diff --git a/js/MailProxyRelaying.js b/js/MailProxyRelaying.js
index 041b8a3..1856130 100644
--- a/js/MailProxyRelaying.js
+++ b/js/MailProxyRelaying.js
@@ -43,6 +43,7 @@ Ext.define('PMG.MailProxyRelaying', {
 	    },
 	    editor: {
 		xtype: 'proxmoxWindowEdit',
+		onlineHelp: 'pmgconfig_mailproxy_relaying',
 		subject: gettext('Smarthost'),
 		fieldDefaults: {
 		    labelWidth: 100
@@ -84,7 +85,8 @@ Ext.define('PMG.MailProxyRelaying', {
 	    }],
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_mailproxy_relaying'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
diff --git a/js/MailProxyTLS.js b/js/MailProxyTLS.js
index f45115b..d2029e3 100644
--- a/js/MailProxyTLS.js
+++ b/js/MailProxyTLS.js
@@ -27,7 +27,8 @@ Ext.define('PMG.MailProxyTLS', {
 	    }],
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_mailproxy_tls'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
diff --git a/js/MailProxyTLSDomains.js b/js/MailProxyTLSDomains.js
index d1e1be0..757057d 100644
--- a/js/MailProxyTLSDomains.js
+++ b/js/MailProxyTLSDomains.js
@@ -16,6 +16,7 @@ Ext.define('pmg-tls-policy', {
 Ext.define('PMG.TLSDomainEdit', {
     extend: 'Proxmox.window.Edit',
     xtype: 'pmgTLSDomainEdit',
+    onlineHelp: 'pmgconfig_mailproxy_tls',
 
     subject: gettext('TLS Policy'),
     initComponent : function() {
diff --git a/js/MyNetworks.js b/js/MyNetworks.js
index 6ef0022..a255812 100644
--- a/js/MyNetworks.js
+++ b/js/MyNetworks.js
@@ -45,6 +45,7 @@ Ext.define('PMG.MyNetworks', {
 
 	    var config = {
 		url: "/api2/extjs/config/mynetworks/" + rec.data.cidr,
+		onlineHelp: 'pmgconfig_mailproxy_networks',
 		method: 'PUT',
 		subject: gettext("Trusted Network"),
 		items: [
@@ -83,6 +84,7 @@ Ext.define('PMG.MyNetworks', {
 		    var config = {
 			method: 'POST',
 			url: "/api2/extjs/config/mynetworks",
+			onlineHelp: 'pmgconfig_mailproxy_networks',
 			isCreate: true,
 			subject: gettext("Trusted Network"),
 			items: [
diff --git a/js/ObjectGroupList.js b/js/ObjectGroupList.js
index 6f98454..80655f7 100644
--- a/js/ObjectGroupList.js
+++ b/js/ObjectGroupList.js
@@ -58,6 +58,7 @@ Ext.define('PMG.ObjectGroupList', {
 
 	var config = {
 	    url: "/api2/extjs" + me.baseurl +'/' + rec.data.id + '/config',
+	    onlineHelp: 'chapter_mailfilter',
 	    method: 'PUT',
 	    subject: me.subject,
 	    width: 400,
@@ -116,6 +117,7 @@ Ext.define('PMG.ObjectGroupList', {
 		    var config = {
 			method: 'POST',
 			url: "/api2/extjs" + me.baseurl,
+			onlineHelp: 'chapter_mailfilter',
 			isCreate: true,
 			width: 400,
 			subject: me.subject,
diff --git a/js/RelayDomains.js b/js/RelayDomains.js
index 26560c1..2cee2f5 100644
--- a/js/RelayDomains.js
+++ b/js/RelayDomains.js
@@ -45,6 +45,7 @@ Ext.define('PMG.RelayDomains', {
 
 	    var config = {
 		url: "/api2/extjs/config/domains/" + rec.data.domain,
+		onlineHelp: 'pmgconfig_mailproxy_relay_domains',
 		method: 'PUT',
 		subject: gettext("Relay Domain"),
 		items: [
@@ -83,6 +84,7 @@ Ext.define('PMG.RelayDomains', {
 		    var config = {
 			method: 'POST',
 			url: "/api2/extjs/config/domains",
+			onlineHelp: 'pmgconfig_mailproxy_relay_domains',
 			isCreate: true,
 			subject: gettext("Relay Domain"),
 			items: [
diff --git a/js/RuleEditor.js b/js/RuleEditor.js
index cf48d9a..8291dde 100644
--- a/js/RuleEditor.js
+++ b/js/RuleEditor.js
@@ -1,6 +1,7 @@
 Ext.define('PMG.RuleEditor', {
     extend: 'Proxmox.window.Edit',
     xtype: 'ruleeditwindow',
+    onlineHelp: 'chapter_mailfilter',
 
     url: undefined,
 
diff --git a/js/SpamDetectorLanguages.js b/js/SpamDetectorLanguages.js
index 86c63e0..ca4ec4b 100644
--- a/js/SpamDetectorLanguages.js
+++ b/js/SpamDetectorLanguages.js
@@ -116,6 +116,7 @@ Ext.define('PMG.SpamDetectorLanguagesInputPanel', {
 
 Ext.define('PMG.SpamDetectorLanguages', {
     extend: 'Proxmox.window.Edit',
+    onlineHelp: 'pmgconfig_spamdetector',
 
     subject: 'Languages',
 
diff --git a/js/SpamDetectorOptions.js b/js/SpamDetectorOptions.js
index cf0a68e..e506296 100644
--- a/js/SpamDetectorOptions.js
+++ b/js/SpamDetectorOptions.js
@@ -56,7 +56,8 @@ Ext.define('PMG.SpamDetectorOptions', {
 	    }],
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_spamdetector'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
diff --git a/js/SpamQuarantineOptions.js b/js/SpamQuarantineOptions.js
index e3f6789..d605c13 100644
--- a/js/SpamQuarantineOptions.js
+++ b/js/SpamQuarantineOptions.js
@@ -80,7 +80,8 @@ Ext.define('PMG.SpamQuarantineOptions', {
 	    }],
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_spamdetector_quarantine'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
diff --git a/js/SystemOptions.js b/js/SystemOptions.js
index 5a83076..9692aa2 100644
--- a/js/SystemOptions.js
+++ b/js/SystemOptions.js
@@ -9,7 +9,8 @@ Ext.define('PMG.SystemOptions', {
 
     url: '/api2/json/config/admin',
     editorConfig: {
-	url: '/api2/extjs/config/admin'
+	url: '/api2/extjs/config/admin',
+	onlineHelp: 'pmgconfig_systemconfig'
     },
 
     controller: {
@@ -44,6 +45,7 @@ Ext.define('PMG.SystemOptions', {
 	    header: text,
 	    editor: {
 		xtype: 'proxmoxWindowEdit',
+		onlineHelp: 'pmgconfig_systemconfig',
 		subject: text,
 		items: {
 		    xtype: 'proxmoxtextfield',
diff --git a/js/Transport.js b/js/Transport.js
index f125835..c721da3 100644
--- a/js/Transport.js
+++ b/js/Transport.js
@@ -88,6 +88,7 @@ Ext.define('PMG.Transport', {
 
 	    var config = {
 		url: "/api2/extjs/config/transport/" + rec.data.domain,
+		onlineHelp: 'pmgconfig_mailproxy_transports',
 		method: 'PUT',
 		subject: gettext("Transport"),
 		items: edit_properties
@@ -114,6 +115,7 @@ Ext.define('PMG.Transport', {
 		    var config = {
 			method: 'POST',
 			url: "/api2/extjs/config/transport",
+			onlineHelp: 'pmgconfig_mailproxy_transports',
 			isCreate: true,
 			subject: gettext("Transport"),
 			items: create_properties
diff --git a/js/UserBlackWhiteList.js b/js/UserBlackWhiteList.js
index 62c3ed8..3cc5adb 100644
--- a/js/UserBlackWhiteList.js
+++ b/js/UserBlackWhiteList.js
@@ -41,6 +41,7 @@ Ext.define('PMG.UserBlackWhiteList', {
 	    var config = {
 		method: 'POST',
 		url: url,
+		onlineHelp: 'pmg_userblackwhitelist',
 		isCreate: true,
 		isAdd: true,
 		items: items
diff --git a/js/UserEdit.js b/js/UserEdit.js
index 35163fe..c953c43 100644
--- a/js/UserEdit.js
+++ b/js/UserEdit.js
@@ -5,6 +5,7 @@ Ext.define('PMG.UserEdit', {
     extend: 'Proxmox.window.Edit',
     alias: 'widget.pmgUserEdit',
     mixins: ['Proxmox.Mixin.CBind'],
+    onlineHelp: 'pmgconfig_localuser',
 
     userid: undefined,
 
diff --git a/js/Utils.js b/js/Utils.js
index 852f653..b85c64d 100644
--- a/js/Utils.js
+++ b/js/Utils.js
@@ -126,6 +126,7 @@ Ext.define('PMG.Utils', {
 
     object_editors: {
 	1000: {
+	    onlineHelp: 'pmg_mailfilter_regex',
 	    iconCls: 'fa fa-filter',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'regex',
@@ -148,18 +149,21 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	1005: {
+	    onlineHelp: 'pmgconfig_ldap',
 	    iconCls: 'fa fa-users',
 	    xtype: 'pmgLDAPGroupEditor',
 	    subdir: 'ldap',
 	    subject: gettext("LDAP Group")
 	},
 	1006: {
+	    onlineHelp: 'pmgconfig_ldap',
 	    iconCls: 'fa fa-user',
 	    xtype: 'pmgLDAPUserEditor',
 	    subdir: 'ldapuser',
 	    subject: gettext("LDAP User")
 	},
 	1009: {
+	    onlineHelp: 'pmg_mailfilter_regex',
 	    iconCls: 'fa fa-filter',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'receiver_regex',
@@ -176,6 +180,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	1001: {
+	    onlineHelp: 'pmg_mailfilter_who',
 	    iconCls: 'fa fa-envelope-o',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'email',
@@ -190,6 +195,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	1007: {
+	    onlineHelp: 'pmg_mailfilter_who',
 	    iconCls: 'fa fa-envelope-o',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'receiver',
@@ -205,6 +211,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	1002: {
+	    onlineHelp: 'pmg_mailfilter_who',
 	    iconCls: 'fa fa-globe',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'domain',
@@ -219,6 +226,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	1008: {
+	    onlineHelp: 'pmg_mailfilter_who',
 	    iconCls: 'fa fa-globe',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'receiver_domain',
@@ -234,6 +242,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	1003: {
+	    onlineHelp: 'pmg_mailfilter_who',
 	    iconCls: 'fa fa-globe',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'ip',
@@ -248,6 +257,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	1004: {
+	    onlineHelp: 'pmg_mailfilter_who',
 	    iconCls: 'fa fa-globe',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'network',
@@ -262,6 +272,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	2000: {
+	    onlineHelp: 'pmg_mailfilter_when',
 	    iconCls: 'fa fa-clock-o',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'timeframe',
@@ -282,6 +293,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	3000: {
+	    onlineHelp: 'pmg_mailfilter_what',
 	    iconCls: 'fa fa-bullhorn',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'spamfilter',
@@ -297,6 +309,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	3001: {
+	    onlineHelp: 'pmg_mailfilter_what',
 	    iconCls: 'fa fa-bug',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'virusfilter',
@@ -310,6 +323,7 @@ Ext.define('PMG.Utils', {
 	    }
 	},
 	3002: {
+	    onlineHelp: 'pmg_mailfilter_regex',
 	    iconCls: 'fa fa-code',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'matchfield',
@@ -340,6 +354,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	3003: {
+	    onlineHelp: 'pmg_mailfilter_what',
 	    iconCls: 'fa fa-file-image-o',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'contenttype',
@@ -381,6 +396,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	3004: {
+	    onlineHelp: 'pmg_mailfilter_regex',
 	    iconCls: 'fa fa-file-o',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'filenamefilter',
@@ -405,6 +421,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	3005: {
+	    onlineHelp: 'pmg_mailfilter_what',
 	    iconCls: 'fa fa-file-archive-o',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'archivefilter',
@@ -446,6 +463,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	4002: {
+	    onlineHelp: 'pmg_mailfilter_action',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'notification',
 	    subject: gettext('Notification'),
@@ -502,6 +520,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	4003: {
+	    onlineHelp: 'pmg_mailfilter_action',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'field',
 	    subject: gettext('Header Attribute'),
@@ -534,6 +553,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	4005: {
+	    onlineHelp: 'pmg_mailfilter_action',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'bcc',
 	    subject: gettext('BCC'),
@@ -566,6 +586,7 @@ Ext.define('PMG.Utils', {
 
 	},
 	4007: {
+	    onlineHelp: 'pmg_mailfilter_action',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'removeattachments',
 	    subject: gettext('Remove Attachments'),
@@ -601,6 +622,7 @@ Ext.define('PMG.Utils', {
 	    ]
 	},
 	4009: {
+	    onlineHelp: 'pmg_mailfilter_action',
 	    xtype: 'proxmoxWindowEdit',
 	    subdir: 'disclaimer',
 	    subject: gettext('Disclaimer'),
diff --git a/js/VirusDetectorOptions.js b/js/VirusDetectorOptions.js
index 3d34bac..318e197 100644
--- a/js/VirusDetectorOptions.js
+++ b/js/VirusDetectorOptions.js
@@ -44,7 +44,8 @@ Ext.define('PMG.VirusDetectorOptions', {
 	    }],
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_clamav_options'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
diff --git a/js/VirusQuarantineOptions.js b/js/VirusQuarantineOptions.js
index 839a62e..c18a859 100644
--- a/js/VirusQuarantineOptions.js
+++ b/js/VirusQuarantineOptions.js
@@ -31,7 +31,8 @@ Ext.define('PMG.VirusQuarantineOptions', {
 	    }],
 	    url: '/api2/json' + baseurl,
 	    editorConfig: {
-		url: '/api2/extjs' + baseurl
+		url: '/api2/extjs' + baseurl,
+		onlineHelp: 'pmgconfig_clamav_quarantine'
 	    },
 	    interval: 5000,
 	    cwidth1: 200,
-- 
2.11.0




More information about the pmg-devel mailing list