luci-app-sqm: Move verbose descriptions into help text
authorToke Høiland-Jørgensen <toke@toke.dk>
Mon, 26 Dec 2022 18:05:28 +0000 (19:05 +0100)
committerToke Høiland-Jørgensen <toke@toke.dk>
Mon, 26 Dec 2022 20:19:11 +0000 (21:19 +0100)
The field labels contain verbose descriptions which looks terrible in the
UI. Replace them with short labels and move the verbose text into the help
text where it belongs.

Reported by Github user @saldry at https://github.com/openwrt/luci/issues/6161

Signed-off-by: Toke Høiland-Jørgensen <toke@toke.dk>
applications/luci-app-sqm/htdocs/luci-static/resources/view/network/sqm.js

index 28004215b829dbbf3a1f2adc22af31723046bbcb..8b4a0aed04b6cb72d2cc66b92c047b00ea536f64 100644 (file)
@@ -89,18 +89,18 @@ return view.extend({
                o = s.taboption("tab_basic", widgets.DeviceSelect, "interface", _("Interface name"));
                o.rmempty = false;
 
-               o = s.taboption("tab_basic", form.Value, "download", _("Download speed (kbit/s) (ingress) set to 0 to selectively disable ingress shaping:"));
+               o = s.taboption("tab_basic", form.Value, "download", _("Download speed (ingress)"), _("Download speed (kbit/s) (ingress) set to 0 to selectively disable ingress shaping"));
                o.datatype = "and(uinteger,min(0))";
                o.rmempty = false;
 
-               o = s.taboption("tab_basic", form.Value, "upload", _("Upload speed (kbit/s) (egress) set to 0 to selectively disable egress shaping:"));
+               o = s.taboption("tab_basic", form.Value, "upload",  _("Upload speed (egress)"), _("Upload speed (kbit/s) (egress) set to 0 to selectively disable egress shaping"));
                o.datatype = "and(uinteger,min(0))";
                o.rmempty = false;
 
-               o = s.taboption("tab_basic", form.Flag, "debug_logging", _("Create log file for this SQM instance under /var/run/sqm/${Interface_name}.[start|stop]-sqm.log."));
+               o = s.taboption("tab_basic", form.Flag, "debug_logging", _("Enable debug logging"), _("Create log file for this SQM instance under /var/run/sqm/${Interface_name}.[start|stop]-sqm.log."));
                o.rmempty = false;
 
-               o = s.taboption("tab_basic", form.ListValue, "verbosity", _("Verbosity of SQM's output into the system log."));
+               o = s.taboption("tab_basic", form.ListValue, "verbosity", _("Log verbosity"), _("Verbosity of SQM's output into the system log."));
                o.value("0", "silent");
                o.value("1", "error");
                o.value("2", "warning");
@@ -109,7 +109,7 @@ return view.extend({
                o.value("10", "trace");
                o.default = "5";
 
-               o = s.taboption("tab_qdisc", form.ListValue, "qdisc", _("Queuing disciplines useable on this system. After installing a new qdisc, you need to restart the router to see updates!"));
+               o = s.taboption("tab_qdisc", form.ListValue, "qdisc", _("Queueing discipline"), _("Lists queuing disciplines useable on this system. After installing a new qdisc, you need to restart the router to see updates!"));
                for (var i=0; i < qdiscs.length; i++) {
                        o.value(qdiscs[i].name);
                }
@@ -130,92 +130,92 @@ return view.extend({
                o.rmempty = false;
                o.description = qos_desc;
 
-               o = s.taboption("tab_qdisc", form.Flag, "qdisc_advanced", _("Show and Use Advanced Configuration. Advanced options will only be used as long as this box is checked."));
+               o = s.taboption("tab_qdisc", form.Flag, "qdisc_advanced", _("Advanced Configuration"), _("Advanced options will only be used as long as this box is checked."));
                o.default = false;
 
-               o = s.taboption("tab_qdisc", form.ListValue, "squash_dscp", _("Squash DSCP on inbound packets (ingress):"));
+               o = s.taboption("tab_qdisc", form.ListValue, "squash_dscp", _("Squash DSCP (ingress)"), _("Squash DSCP markings on inbound packets"));
                o.value("1", "SQUASH");
                o.value("0", "DO NOT SQUASH");
                o.default = "1";
                o.depends("qdisc_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.ListValue, "squash_ingress", _("Ignore DSCP on ingress:"));
+               o = s.taboption("tab_qdisc", form.ListValue, "squash_ingress", _("Ignore DSCP (ingress)"), _("Ignore DSCP markings on inbound packets"));
                o.value("1", "Ignore");
                o.value("0", "Allow");
                o.default = "1";
                o.depends("qdisc_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.ListValue, "ingress_ecn", _("Explicit congestion notification (ECN) status on inbound packets (ingress):"));
+               o = s.taboption("tab_qdisc", form.ListValue, "ingress_ecn", _("ECN (ingress)"), _("Explicit congestion notification (ECN) status on inbound packets"));
                o.value("ECN", "ECN (" + _("default") + ")");
                o.value("NOECN");
                o.default = "ECN";
                o.depends("qdisc_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.ListValue, "egress_ecn", _("Explicit congestion notification (ECN) status on outbound packets (egress)."));
+               o = s.taboption("tab_qdisc", form.ListValue, "egress_ecn", _("ECN (egress)"), _("Explicit congestion notification (ECN) status on outbound packets"));
                o.value("NOECN", "NOECN (" + _("default") + ")");
                o.value("ECN");
                o.default = "NOECN";
                o.depends("qdisc_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.Flag, "qdisc_really_really_advanced", _("Show and Use Dangerous Configuration. Dangerous options will only be used as long as this box is checked."));
+               o = s.taboption("tab_qdisc", form.Flag, "qdisc_really_really_advanced", _("Dangerous Configuration"), _("Dangerous options will only be used as long as this box is checked."));
                o.default = false
                o.depends("qdisc_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.Value, "ilimit", _("Hard limit on ingress queues; leave empty for default."));
+               o = s.taboption("tab_qdisc", form.Value, "ilimit", _("Hard queue limit (ingress)"), _("Hard limit on ingress queues; leave empty for default."));
                o.datatype = "and(uinteger,min(0))";
                o.depends("qdisc_really_really_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.Value, "elimit", _("Hard limit on egress queues; leave empty for default."));
+               o = s.taboption("tab_qdisc", form.Value, "elimit", _("Hard queue limit (egress)"), _("Hard limit on egress queues; leave empty for default."));
                o.datatype = "and(uinteger,min(0))";
                o.depends("qdisc_really_really_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.Value, "itarget", _("Latency target for ingress, e.g 5ms [units: s, ms, or  us]; leave empty for automatic selection, put in the word default for the qdisc's default."));
+               o = s.taboption("tab_qdisc", form.Value, "itarget", _("Latency target (ingress)"), _("Latency target for ingress, e.g 5ms [units: s, ms, or  us]; leave empty for automatic selection, put in the word default for the qdisc's default."));
                o.datatype = "string";
                o.depends("qdisc_really_really_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.Value, "etarget", _("Latency target for egress, e.g. 5ms [units: s, ms, or  us]; leave empty for automatic selection, put in the word default for the qdisc's default."));
+               o = s.taboption("tab_qdisc", form.Value, "etarget", _("Latency target (egress)"), _("Latency target for egress, e.g. 5ms [units: s, ms, or  us]; leave empty for automatic selection, put in the word default for the qdisc's default."));
                o.datatype = "string";
                o.depends("qdisc_really_really_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.Value, "iqdisc_opts", _("Advanced option string to pass to the ingress queueing disciplines; no error checking, use very carefully."));
+               o = s.taboption("tab_qdisc", form.Value, "iqdisc_opts", _("Qdisc options (ingress)"), _("Advanced option string to pass to the ingress queueing disciplines; no error checking, use very carefully."));
                o.depends("qdisc_really_really_advanced", "1");
 
-               o = s.taboption("tab_qdisc", form.Value, "eqdisc_opts", _("Advanced option string to pass to the egress queueing disciplines; no error checking, use very carefully."));
+               o = s.taboption("tab_qdisc", form.Value, "eqdisc_opts", _("Qdisc options (egress)"), _("Advanced option string to pass to the egress queueing disciplines; no error checking, use very carefully."));
                o.depends("qdisc_really_really_advanced", "1");
 
                // LINKLAYER
-               o = s.taboption("tab_linklayer", form.ListValue, "linklayer", _("Which link layer to account for:"));
+               o = s.taboption("tab_linklayer", form.ListValue, "linklayer", _("Link layer"), _("Which link layer technology to account for"));
                o.value("none", "none (" + _("default") + ")");
                o.value("ethernet", "Ethernet with overhead: select for e.g. VDSL2.");
                o.value("atm", "ATM: select for e.g. ADSL1, ADSL2, ADSL2+.");
                o.default = "none";
 
-               o = s.taboption("tab_linklayer", form.Value, "overhead", _("Per Packet Overhead (byte):"));
+               o = s.taboption("tab_linklayer", form.Value, "overhead", _("Per Packet Overhead (bytes)"));
                o.datatype = "and(integer,min(-1500))";
                o.default = 0
                o.depends("linklayer", "ethernet");
                o.depends("linklayer", "atm");
 
-               o = s.taboption("tab_linklayer", form.Flag, "linklayer_advanced", _("Show Advanced Linklayer Options, (only needed if MTU > 1500). Advanced options will only be used as long as this box is checked."));
+               o = s.taboption("tab_linklayer", form.Flag, "linklayer_advanced", _("Advanced Linklayer Options"), _("Advanced options will only be used as long as this box is checked (only needed if MTU > 1500)."));
                o.depends("linklayer", "ethernet");
                o.depends("linklayer", "atm");
 
-               o = s.taboption("tab_linklayer", form.Value, "tcMTU", _("Maximal Size for size and rate calculations, tcMTU (byte); needs to be >= interface MTU + overhead:"));
+               o = s.taboption("tab_linklayer", form.Value, "tcMTU", _("Maximum packet size"), _("Maximal Size for size and rate calculations, tcMTU (byte); needs to be >= interface MTU + overhead"));
                o.datatype = "and(uinteger,min(0))";
                o.default = 2047
                o.depends("linklayer_advanced", "1");
 
-               o = s.taboption("tab_linklayer", form.Value, "tcTSIZE", _("Number of entries in size/rate tables, TSIZE; for ATM choose TSIZE = (tcMTU + 1) / 16:"));
+               o = s.taboption("tab_linklayer", form.Value, "tcTSIZE", _("Rate table size"), _("Number of entries in size/rate tables, TSIZE; for ATM choose TSIZE = (tcMTU + 1) / 16"));
                o.datatype = "and(uinteger,min(0))";
                o.default = 128
                o.depends("linklayer_advanced", "1");
 
-               o = s.taboption("tab_linklayer", form.Value, "tcMPU", _("Minimal packet size, MPU (byte); needs to be > 0 for ethernet size tables:"));
+               o = s.taboption("tab_linklayer", form.Value, "tcMPU", _("Minimum packet size"), _("Minimal packet size, MPU (byte); needs to be > 0 for ethernet size tables"));
                o.datatype = "and(uinteger,min(0))";
                o.default = 0
                o.depends("linklayer_advanced", "1");
 
-               o = s.taboption("tab_linklayer", form.ListValue, "linklayer_adaptation_mechanism", _("Which linklayer adaptation mechanism to use; for testing only"));
+               o = s.taboption("tab_linklayer", form.ListValue, "linklayer_adaptation_mechanism", _("Linklayer adaptation mechanism"), _("Which linklayer adaptation mechanism to use; for testing only"));
                o.value("default", "default (" + _("default") + ")");
                o.value("cake");
                o.value("htb_private");