mdhelp: some minor edits mdhelp: add grabber docs + screenie mdhelp: …

…update captions
tvheadend · May 11, 2016 · 6867738 · 6867738
1 parent ea333d0
commit 6867738
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 10 deletions.
diff --git a/docs/class/caclient.md b/docs/class/caclient.md
@@ -45,7 +45,7 @@ connection status.
 Icon                                         | Description
 ---------------------------------------------|------------
 !['Accept/OK Icon'](icons/accept.png)        | The client is connected.
-!['Error Icon'](icons/exclamation.png)       | There was an error connecting.
+!['Error Icon'](icons/exclamation.png)       | There was an error.
 !['Stop/Disabled Icon'](icons/stop.png)      | The client is disabled.
 
 ---

diff --git a/docs/class/epgconf.md b/docs/class/epgconf.md
@@ -1,7 +1,5 @@
 This tab is used to configure the Electronic Program Guide (EPG) 
-grabbing capabilities. Tvheadend supports a variety of different EPG 
-grabbing mechanisms. These fall into 3 broad categories, within which 
-there are a variety of specific grabber implementations.
+[grabbing](class/epggrab_mod) capabilities.
 
 !['EPG Grabber Configuration'](static/img/doc/epggrabberconfig.png)
 

diff --git a/docs/class/epggrabber_channel.md b/docs/class/epggrabber_channel.md
@@ -1,4 +1,4 @@
-This tab displays external EPG data used by channels.
+This tab displays EPG data used by channels.
 
 !['EPG Grabber Channels Tab'](static/img/doc/epggrabberchannels.png)
 

diff --git a/docs/class/epggrabber_modules.md b/docs/class/epggrabber_modules.md
@@ -0,0 +1,26 @@
+This tab is used to configure the Electronic Program Guide (EPG) 
+grabber modules. Tvheadend supports a variety of different EPG 
+grabbing mechanisms. These fall into 3 broad categories, within which 
+there are a variety of specific grabber implementations.
+
+!['EPG Grabber Configuration'](static/img/doc/epggrabmodules.png)
+
+---
+
+###Menu Bar/Buttons
+
+The following functions are available:
+
+Button                      | Function
+----------------------------|-------------------
+**Save**                    | Save any changes made to the tab.
+**Undo**                    | Revert any changes made since the last save.
+
+<tvh_include>inc/common_button_table_end</tvh_include>
+
+---
+
+
+
+
+
diff --git a/src/epggrab/module.c b/src/epggrab/module.c
@@ -104,9 +104,12 @@ static int epggrab_mod_class_type_set(void *o, const void *v)
   return 0;
 }
 
+CLASS_DOC(epggrabber_modules)
+
 const idclass_t epggrab_mod_class = {
   .ic_class      = "epggrab_mod",
-  .ic_caption    = N_("EPG grabber"),
+  .ic_caption    = N_("EPG Grabber"),
+  .ic_doc        = tvh_doc_epggrabber_modules_class,
   .ic_event      = "epggrab_mod",
   .ic_perm_def   = ACCESS_ADMIN,
   .ic_get_title  = epggrab_mod_class_title,

diff --git a/src/epggrab/module/pyepg.c b/src/epggrab/module/pyepg.c
@@ -461,14 +461,14 @@ static int _pyepg_parse
 const idclass_t epggrab_mod_int_pyepg_class = {
   .ic_super      = &epggrab_mod_int_class,
   .ic_class      = "epggrab_mod_int_pyepg",
-  .ic_caption    = N_("Internal PyEPG grabber"),
+  .ic_caption    = N_("Internal PyEPG Grabber"),
 };
 
 
 const idclass_t epggrab_mod_ext_pyepg_class = {
   .ic_super      = &epggrab_mod_ext_class,
   .ic_class      = "epggrab_mod_ext_pyepg",
-  .ic_caption    = N_("External PyEPG grabber"),
+  .ic_caption    = N_("External PyEPG Grabber"),
 };
 
 

diff --git a/src/epggrab/module/xmltv.c b/src/epggrab/module/xmltv.c
@@ -767,7 +767,7 @@ xmltv_dn_chnum_list ( void *o, const char *lang )
 const idclass_t epggrab_mod_int_xmltv_class = {
   .ic_super      = &epggrab_mod_int_class,
   .ic_class      = "epggrab_mod_int_xmltv",
-  .ic_caption    = N_("Internal XMLTV EPG grabber"),
+  .ic_caption    = N_("Internal XMLTV EPG Grabber"),
   .ic_properties = (const property_t[]){
     {
       .type   = PT_INT,
@@ -785,7 +785,7 @@ const idclass_t epggrab_mod_int_xmltv_class = {
 const idclass_t epggrab_mod_ext_xmltv_class = {
   .ic_super      = &epggrab_mod_ext_class,
   .ic_class      = "epggrab_mod_ext_xmltv",
-  .ic_caption    = N_("External XMLTV EPG grabber"),
+  .ic_caption    = N_("External XMLTV EPG Grabber"),
   .ic_properties = (const property_t[]){
     {
       .type   = PT_BOOL,

diff --git a/src/webui/static/img/doc/epggrabmodules.png b/src/webui/static/img/doc/epggrabmodules.png