From 78fcbf5233a256e8ed509bfec864631ffc583845 Mon Sep 17 00:00:00 2001
From: Jaroslav Kysela <perex@perex.cz>
Date: Wed, 23 Apr 2014 09:31:23 +0200
Subject: [PATCH] SAT>IP: Add Help button to the TV adapters.

---
 docs/html/config_tvadapters.html   | 81 ++++++++++++++++++++++++++++++
 src/webui/static/app/idnode.js     | 15 +++++-
 src/webui/static/app/tvadapters.js |  9 +++-
 3 files changed, 102 insertions(+), 3 deletions(-)
 create mode 100644 docs/html/config_tvadapters.html

diff --git a/docs/html/config_tvadapters.html b/docs/html/config_tvadapters.html
new file mode 100644
index 00000000..9582a7e3
--- /dev/null
+++ b/docs/html/config_tvadapters.html
@@ -0,0 +1,81 @@
+<div class="hts-doc-text">
+
+<h3>The adapters and tuners are listed / edited  in a tree</h3>
+
+<ul>
+  <li>To edit an item, click on it. To commit edited changes back to
+      Tvheadend press the 'Save' button. In order to change a Checkbox cell
+      you only have to click once in it.
+</ul>
+</p>
+
+<h4>The rows have the following functions</h4>
+
+<dl>
+  <dt>Enabled</dt>
+  <dd>If selected, the IPTV service will be enabled an use for channel
+      subscriptions.</dd>
+
+  <dt>Name</dt>
+  <dd>The name of this tuner.</dd>
+
+  <dt>Full Mux Rx mode</dt>
+  <dd>If selected, the whole mux (transponder) will be received without any
+      filtering. It is not usually required to enable this option. It does
+      not have usually any benefit, because tvheadend will filter the
+      unwanted PIDs from the TS stream, except for the malfunctioning drivers.</dd>
+</dl>
+</p>
+
+<h4>LinuxDVB specific rows</h4>
+
+<dl>
+  <dt>Keep FE open</dt>
+  <dd>Enable to not close the LinuxDVB frontend device in the idle state.</dd>
+</dl>      
+
+<h4>SAT>IP specific rows</h4>
+
+<dl>
+  <dt>Full Mux Rx mode supported</dt>
+  <dd>Enable, if the SAT>IP box supports the full mux rx mode (pids=all)
+      parameter.</dd>
+      
+  <dt>Signal scale (240 or 100)</dt>
+  <dd>Some SAT>IP boxes has only 0-100 scale. If your signal is too low, try
+      value 100 here.</dd>
+      
+  <dt>Maximum PIDs<dt>
+  <dd>Maximum supported PIDs in the filter of the SAT>IP box.</dd>
+  
+  <dt>Maximum length of PIDs<dt>
+  <dd>Maximum length in characters for the command setting PIDs to the
+      SAT>IP box.</dd>
+
+  <dt>addpids/delpids supported</dt>
+  <dd>Enable, if the SAT>IP box supports the addpids/delpids command.
+
+  <dt>PIDs in setup</dt>
+  <dd>Enable, if the SAT>IP box requires pids=0 parameter in the SETUP RTSP command.</dd>
+
+  <dt>UDP RTP Port Number (2 ports)</dt>
+  <dd>Force the local UDP Port number here. The number should be even (RTP port).
+      The next odd number (+1) will be used as the RTCP port.</dd>
+
+  <dt>Satellite Positions</dt>
+  <dd>Select the number of satellite positions supported by the SAT>IP
+      hardware and your coaxial cable wiring.</dd>
+
+  <dt>Master Tuner</dt>
+  <dd>Select the master tuner.
+     <p>The signal from the standard universal LNB can be split using
+        a simple coaxial splitter (no multiswitch) to several outputs.
+        In this case, the position, the polarization and low-high
+        band settings must be equal.</p>
+     <p>If you set other tuner as master, then this tuner will act like
+        a slave one and tvheadend will assure that this tuner will not
+        use incompatible parameters (position, polarization, lo-hi).</p>
+  </dd>
+</dl>
+
+</div>
diff --git a/src/webui/static/app/idnode.js b/src/webui/static/app/idnode.js
index c172ff18..880565d6 100644
--- a/src/webui/static/app/idnode.js
+++ b/src/webui/static/app/idnode.js
@@ -458,6 +458,7 @@ tvheadend.idnode_editor_form = function ( d, panel )
 tvheadend.idnode_editor = function(item, conf)
 {
   var panel  = null;
+  var buttons = [];
 
   /* Buttons */
   var saveBtn = new Ext.Button({
@@ -476,6 +477,15 @@ tvheadend.idnode_editor = function(item, conf)
       });
     }
   });
+  buttons.push(saveBtn);
+
+  if (conf.help) {
+    var helpBtn = new Ext.Button({
+      text    : 'Help',
+      handler : conf.help
+    });
+    buttons.push(helpBtn);
+  }
 
   panel = new Ext.FormPanel({
     title       : conf.title || null,
@@ -490,7 +500,7 @@ tvheadend.idnode_editor = function(item, conf)
     //defaults: {width: 330},
     defaultType : 'textfield',
     buttonAlign : 'left',
-    buttons     : [ saveBtn ]
+    buttons     : buttons
   });
 
   tvheadend.idnode_editor_form(item.props || item.params, panel);
@@ -1037,7 +1047,8 @@ tvheadend.idnode_tree = function (conf)
         if(!n.isRoot)
           current = panel.add(new tvheadend.idnode_editor(n.attributes, {
             title       : 'Parameters',
-            fixedHeight : true
+            fixedHeight : true,
+            help        : conf.help || null,
           }));
         panel.doLayout();
       }
diff --git a/src/webui/static/app/tvadapters.js b/src/webui/static/app/tvadapters.js
index a15bb21b..d3353c09 100644
--- a/src/webui/static/app/tvadapters.js
+++ b/src/webui/static/app/tvadapters.js
@@ -1,3 +1,10 @@
 tvheadend.tvadapters = function() {
-  return tvheadend.idnode_tree({ url: 'api/hardware/tree', title: 'TV adapters', comet: 'hardware'});
+  return tvheadend.idnode_tree( {
+    url   : 'api/hardware/tree',
+    title : 'TV adapters',
+    comet : 'hardware',
+    help  : function() {
+      new tvheadend.help('TV adapters', 'config_tvadapters.html');
+    }
+  });
 }