From: Mark Clarkstone Date: Tue, 10 May 2016 11:38:28 +0000 (+0100) Subject: mdhelp: some minor edits mdhelp: add grabber docs + screenie mdhelp: update captions X-Git-Tag: v4.2.1~528 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6867738321533758dc55e7f0c483ceb612c8e713;p=thirdparty%2Ftvheadend.git mdhelp: some minor edits mdhelp: add grabber docs + screenie mdhelp: update captions --- diff --git a/docs/class/caclient.md b/docs/class/caclient.md index 8d6e7fd7c..1adc604db 100644 --- 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 index ff5975842..6afc73301 100644 --- 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 index 652b0636f..fdb2c42eb 100644 --- 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 new file mode 100644 index 000000000..fa95f5b90 --- /dev/null +++ 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. + +inc/common_button_table_end + +--- + + + + + diff --git a/src/epggrab/module.c b/src/epggrab/module.c index cd4247749..a3c815c9e 100644 --- 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 index 5994a2abb..6131a76fa 100644 --- 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 index 8f2ec8227..15497696b 100644 --- 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 new file mode 100644 index 000000000..4766f944a Binary files /dev/null and b/src/webui/static/img/doc/epggrabmodules.png differ