From: Jaroslav Kysela <perex@perex.cz>
Date: Wed, 6 Apr 2016 16:07:05 +0000 (+0200)
Subject: mdhelp: convert configuration / general to mdhelp
X-Git-Tag: v4.2.1~715
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=596f7119b048da49200d15a24cd0a863fe5eee79;p=thirdparty%2Ftvheadend.git

mdhelp: convert configuration / general to mdhelp
---

diff --git a/docs/class/config.md b/docs/class/config.md
new file mode 100644
index 000000000..6bbcaebd8
--- /dev/null
+++ b/docs/class/config.md
@@ -0,0 +1,6 @@
+##Configuration - General
+
+This tabs allow configuration of several general parameters that affect
+the core Tvheadend functionality.
+
+!['General' Tab Screenshot 1](docresources/configgeneraltab.png)
diff --git a/docs/class/imagecache.md b/docs/class/imagecache.md
new file mode 100644
index 000000000..aaf020068
--- /dev/null
+++ b/docs/class/imagecache.md
@@ -0,0 +1,6 @@
+##Configuration - Image Cache
+
+This will cache any channel icons or other images (such as EPG metadata)
+to be served from the local webserver. This can be useful for
+multi-client systems and, generally, to reduce hits on upstream
+providers.
diff --git a/docs/class/satip_server.md b/docs/class/satip_server.md
new file mode 100644
index 000000000..e03023f31
--- /dev/null
+++ b/docs/class/satip_server.md
@@ -0,0 +1,15 @@
+##Configuration - SAT>IP Server
+
+SAT>IP Server is something like DVB network tuner. Tvheadend can
+forward mpegts input streams including on-the-fly descramling to SAT\>IP
+clients.
+
+Only networks with the “SAT>IP Source” field set are exported through
+the SAT>IP protocol. This field is matched through the “src” parameter
+asked from the SAT>IP client. Usually (and by default) this value is 1.
+For satellite tuners, this value determines the satellite source (dish).
+By specification position 1 = DiseqC AA, 2 = DiseqC AB, 3 = DiseqC BA, 4
+= DiseqC BB, but any numbers may be used - depends on the SAT\>IP
+client. Note that if you use a similar number for multiple networks, the
+first matched network containing the mux with requested parameters will
+win (also for unknown mux).
diff --git a/src/access.c b/src/access.c
index d2c9be464..005de7b11 100644
--- a/src/access.c
+++ b/src/access.c
@@ -2051,7 +2051,6 @@ ipblock_entry_class_prefix_get(void *o)
 
 extern const char *tvh_doc_ipblocking_class[];
 
-
 const idclass_t ipblock_entry_class = {
   .ic_class      = "ipblocking",
   .ic_caption    = N_("IP blocking"),
diff --git a/src/config.c b/src/config.c
index 4f75f97fd..2daab0115 100644
--- a/src/config.c
+++ b/src/config.c
@@ -1965,12 +1965,15 @@ config_muxconfpath_notify ( void *o, const char *lang )
 #endif
 }
 
+extern const char *tvh_doc_config_class[];
+
 const idclass_t config_class = {
   .ic_snode      = &config.idnode,
   .ic_class      = "config",
   .ic_caption    = N_("Configuration"),
   .ic_event      = "config",
   .ic_perm_def   = ACCESS_ADMIN,
+  .ic_doc        = tvh_doc_config_class,
   .ic_save       = config_class_save,
   .ic_groups     = (const property_group_t[]) {
       {
diff --git a/src/imagecache.c b/src/imagecache.c
index 4e173d66f..48b7af418 100644
--- a/src/imagecache.c
+++ b/src/imagecache.c
@@ -71,12 +71,15 @@ struct imagecache_config imagecache_conf = {
 
 static htsmsg_t *imagecache_save(idnode_t *self, char *filename, size_t fsize);
 
+extern const char *tvh_doc_imagecache_class[];
+
 const idclass_t imagecache_class = {
   .ic_snode      = (idnode_t *)&imagecache_conf,
   .ic_class      = "imagecache",
   .ic_caption    = N_("Image cache"),
   .ic_event      = "imagecache",
   .ic_perm_def   = ACCESS_ADMIN,
+  .ic_doc        = tvh_doc_imagecache_class,
   .ic_save       = imagecache_save,
   .ic_properties = (const property_t[]){
     {
diff --git a/src/satip/server.c b/src/satip/server.c
index eb5ac3a97..1585f3ce3 100644
--- a/src/satip/server.c
+++ b/src/satip/server.c
@@ -565,12 +565,15 @@ static htsmsg_t *satip_server_class_muxcfg_list ( void *o, const char *lang )
   return strtab2htsmsg(tab, 1, lang);
 }
 
+extern const char *tvh_doc_satip_server_class[];
+
 const idclass_t satip_server_class = {
   .ic_snode      = (idnode_t *)&satip_server_conf,
   .ic_class      = "satip_server",
   .ic_caption    = N_("SAT>IP server"),
   .ic_event      = "satip_server",
   .ic_perm_def   = ACCESS_ADMIN,
+  .ic_doc        = tvh_doc_satip_server_class,
   .ic_changed    = satip_server_class_changed,
   .ic_groups     = (const property_group_t[]) {
       {
diff --git a/src/webui/static/app/config.js b/src/webui/static/app/config.js
index 1c55f1f70..eb18c5036 100644
--- a/src/webui/static/app/config.js
+++ b/src/webui/static/app/config.js
@@ -57,7 +57,7 @@ tvheadend.baseconf = function(panel, index) {
                 window.location.reload();
         },
         help: function() {
-            new tvheadend.help(_('General Configuration'), 'config_general.html');
+            new tvheadend.mdhelp('class/config');
         }
     });
 
@@ -116,7 +116,7 @@ tvheadend.imgcacheconf = function(panel, index) {
         labelWidth: 200,
         tbar: [cleanButton, triggerButton],
         help: function() {
-            new tvheadend.help(_('General Configuration'), 'config_general.html');
+            new tvheadend.mdhelp('class/imagecache');
         }
     });
 
@@ -158,7 +158,7 @@ tvheadend.satipsrvconf = function(panel, index) {
         labelWidth: 250,
         tbar: [discoverButton],
         help: function() {
-            new tvheadend.help(_('SAT>IP Server Configuration'), 'config_satips.html');
+            new tvheadend.mdhelp('class/satip_server');
         }
     });
 };