Added online documentation to ASF Scorecard feature.

1 files changed, 59 insertions, 0 deletions

diff --git a/src/bmweb/indexsection.js b/src/bmweb/indexsection.js
index 18cc52c..9a1401a 100644
--- a/src/bmweb/indexsection.js
+++ b/src/bmweb/indexsection.js
@@ -673,6 +673,34 @@ function IndexSection()
         fieldset.appendChild(document.createElement("br"));
 
         table = fieldset.appendChild(document.createElement("table"));
+        table.setAttribute("style", "border:0px; padding:0px; background-color:#eeeeee");
+        tr = table.insertRow(table.rows.length);
+        td = tr.insertCell(0);
+        td.setAttribute("style", "text-align:right");
+        td.innerHTML = "<i>MaxESS (maximum equality subsequence):</i>";
+        td = tr.insertCell(1);
+        td.innerHTML =
+            "One of the subsequences formed by partitioning a result history into the smallest "
+            + "number of contiguous sequences so that each sequence consists only of values that "
+            + "are considered equal.";
+        //
+        tr = table.insertRow(table.rows.length);
+        td = tr.insertCell(0);
+        td.setAttribute("style", "text-align:right");
+        td.innerHTML = "<i>Level:</i>";
+        td = tr.insertCell(1);
+        td.innerHTML = "The representative value of a MaxESS (typically the first value).";
+        //
+        tr = table.insertRow(table.rows.length);
+        td = tr.insertCell(0);
+        td.setAttribute("style", "text-align:right");
+        td.innerHTML = "<i>Relative difference between positive real numbers v1 and v2:</i>";
+        td = tr.insertCell(1);
+        td.innerHTML = "100&nbsp;*&nbsp;(max(v1,&nbsp;v2)&nbsp;/&nbsp;min(v1,&nbsp;v2))";
+
+        fieldset.appendChild(document.createElement("br"));
+
+        table = fieldset.appendChild(document.createElement("table"));
         table.setAttribute("style", "border:0px; padding:0px");
 
         // ... 'from timestamp' ...
@@ -685,6 +713,9 @@ function IndexSection()
         input.setAttribute("type", "text");
         input.setAttribute("id", "ixASFStatsFromTime");
         input.setAttribute("value", "-1");
+        td = tr.insertCell(2);
+        td.innerHTML = "Latest time of first sample.";
+        td.setAttribute("style", "background-color:#eeeeee");
 
         // ... 'to timestamp' ...
         tr = table.insertRow(table.rows.length);
@@ -696,6 +727,9 @@ function IndexSection()
         input.setAttribute("type", "text");
         input.setAttribute("id", "ixASFStatsToTime");
         input.setAttribute("value", "-1");
+        td = tr.insertCell(2);
+        td.innerHTML = "Latest time of second sample.";
+        td.setAttribute("style", "background-color:#eeeeee");
 
         // ... 'difference tolerance' ...
         tr = table.insertRow(table.rows.length);
@@ -708,6 +742,11 @@ function IndexSection()
         input.setAttribute("type", "text");
         input.setAttribute("id", "ixASFStatsDiffTol");
         input.setAttribute("Value", "10");
+        td = tr.insertCell(2);
+        td.innerHTML =
+            "The maximum allowed relative difference between two values for them to be "
+            + "considered equal.";
+        td.setAttribute("style", "background-color:#eeeeee");
 
         // ... 'stability tolerance' ...
         tr = table.insertRow(table.rows.length);
@@ -724,6 +763,9 @@ function IndexSection()
         select.options[3] = new Option("5", "5");
         select.options[4] = new Option("6", "6");
         select.options[2].selected = true;
+        td = tr.insertCell(2);
+        td.innerHTML = "The minimum length a MaxESS must have for it to be considered stable.";
+        td.setAttribute("style", "background-color:#eeeeee");
 
         // ... 'stability fraction tolerance' ...
         tr = table.insertRow(table.rows.length);
@@ -736,6 +778,11 @@ function IndexSection()
         input.setAttribute("type", "text");
         input.setAttribute("id", "ixASFStatsSFTol");
         input.setAttribute("Value", "10");
+        td = tr.insertCell(2);
+        td.innerHTML =
+            "The minimum SF (stability fraction) of a result history must have for it to be "
+            + "considered stable, where SF is the percentage of MaxESS'es that are stable.";
+        td.setAttribute("style", "background-color:#eeeeee");
 
         // ... 'level fraction tolerance' ...
         tr = table.insertRow(table.rows.length);
@@ -748,6 +795,11 @@ function IndexSection()
         input.setAttribute("type", "text");
         input.setAttribute("id", "ixASFStatsLFTol");
         input.setAttribute("Value", "10");
+        td = tr.insertCell(2);
+        td.innerHTML =
+            "The minimum ULF (unique level fraction) a result history must have for it to be "
+            + "considered stable, where ULF is the percentage of levels that are unique.";
+        td.setAttribute("style", "background-color:#eeeeee");
 
         // ... 'max level difference tolerance' ...
         tr = table.insertRow(table.rows.length);
@@ -760,6 +812,13 @@ function IndexSection()
         input.setAttribute("type", "text");
         input.setAttribute("id", "ixASFStatsMaxLDTol");
         input.setAttribute("Value", "10");
+        td = tr.insertCell(2);
+        td.innerHTML = "The percentage of subsequence levels that are unique.";
+        td.innerHTML =
+            "The maximum allowed relative difference between any two levels in a result history "
+            + "for it to be considered stable.";
+        td.setAttribute("style", "background-color:#eeeeee");
+
 
         // Create 'Configuration' section ...
         section.appendChild(document.createElement("br"));