From: Mark Clarkstone Date: Tue, 19 Apr 2016 11:55:48 +0000 (+0100) Subject: mdhelp: complete(?) tv adapters docs and added more screenshots X-Git-Tag: v4.2.1~605 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6cb1e8134304dea491d60e33b72f60d5ac3f8bd6;p=thirdparty%2Ftvheadend.git mdhelp: complete(?) tv adapters docs and added more screenshots --- diff --git a/docs/class/linuxdvb_frontend.md b/docs/class/linuxdvb_frontend.md new file mode 100644 index 000000000..ab82b7584 --- /dev/null +++ b/docs/class/linuxdvb_frontend.md @@ -0,0 +1,6 @@ +This is the list of available parameters for the linuxdvb frontend. It +is used as a base for other frontends. + +See [TV Adapters](tv_adapters). + +--- diff --git a/docs/class/linuxdvb_frontend_dvbc.md b/docs/class/linuxdvb_frontend_dvbc.md new file mode 100644 index 000000000..228c36af8 --- /dev/null +++ b/docs/class/linuxdvb_frontend_dvbc.md @@ -0,0 +1,25 @@ +This panel lists all the available Cable (DVB-C/C2/ISDB-C/ATSC-C) frontend +parameters. + +!['DVB-C frontend parameters'](docresources/dvbcfrontendparams.png) + +--- + +* Other Frontends + - [DVB-C](class/linuxdvb_frontend_dvbc) + - [ATSC-C](class/linuxdvb_frontend_atsc_c) + - [ISDB-C](class/linuxdvb_frontend_isdb_c) +* Back to [TV Adapters](tv_adapters) + +--- + +###Buttons + +The following buttons are available: + +Button | Function +---------------|--------- +**Save** | Save the current configuration. +**Help** | Display this help page. + +--- diff --git a/docs/class/linuxdvb_frontend_dvbs.md b/docs/class/linuxdvb_frontend_dvbs.md new file mode 100644 index 000000000..c62e4b80d --- /dev/null +++ b/docs/class/linuxdvb_frontend_dvbs.md @@ -0,0 +1,25 @@ +This panel lists all the available satellite (DVB-S/ISDB-S) frontend +parameters. + +!['DVB-S frontend parameters'](docresources/dvbsfrontendparams.png) + +--- + +* Other Frontends + - [Master](class/linuxdvb_frontend_dvbs) + - [Slave](class/linuxdvb_frontend_dvbs_slave) + - [Master (ISDB-S)](class/linuxdvb_frontend_isdb_s) +* Back to [TV Adapters](tv_adapters) + +--- + +###Buttons + +The following buttons are available: + +Button | Function +---------------|--------- +**Save** | Save the current configuration. +**Help** | Display this help page. + +--- diff --git a/docs/class/linuxdvb_frontend_dvbt.md b/docs/class/linuxdvb_frontend_dvbt.md new file mode 100644 index 000000000..9d4f35df3 --- /dev/null +++ b/docs/class/linuxdvb_frontend_dvbt.md @@ -0,0 +1,25 @@ +This panel lists all the available Terrestrial (DVB-T/T2/ISDB-T/ATSC-T) frontend +parameters. + +!['DVB-T frontend parameters'](docresources/dvbtfrontendparams.png) + +--- + +* Other Frontends + - [DVB-T/DVB-T2](class/linuxdvb_frontend_dvbt) + - [ATSC-T](class/linuxdvb_frontend_atsc_t) + - [ISDB-T](class/linuxdvb_frontend_isdb_t) +* Back to [TV Adapters](tv_adapters) + +--- + +###Buttons + +The following buttons are available: + +Button | Function +---------------|--------- +**Save** | Save the current configuration. +**Help** | Display this help page. + +--- diff --git a/docs/class/linuxdvb_satconf.md b/docs/class/linuxdvb_satconf.md new file mode 100644 index 000000000..63dcdd99d --- /dev/null +++ b/docs/class/linuxdvb_satconf.md @@ -0,0 +1,32 @@ +This tab lists all the available satellite (DVB-S/ISDB-S) configuration +parameters. + +!['Example Configuration'](docresources/dvbsatconf.png) + +--- + +###Buttons + +The following buttons are available: + +Button | Function +---------------|--------- +**Save** | Save the current configuration. +**Help** | Display this help page. + +--- + +* Satellite Configuration + - [Universal LNB](class/linuxdvb_satconf_lnbonly) + - [2 Port](class/linuxdvb_satconf_2port) + - [4 Port](class/linuxdvb_satconf_4port) +* Satellite Configuration (Advanced) + - [Advanced LNB](class/linuxdvb_satconf_advanced) + - [Unicable EN50494 (experimental)](class/linuxdvb_satconf_en50494) + - [DiseqC Rotor](class/linuxdvb_rotor) + - [DiSEqC Switch](class/linuxdvb_switch) + - [Rotor (GOTOX)](class/linuxdvb_rotor_gotox) + - [Rotor (USALS)](class/linuxdvb_rotor_usals) +* Back to [TV Adapters](tv_adapters) + +--- diff --git a/docs/docresources/dvbcfrontendparams.png b/docs/docresources/dvbcfrontendparams.png new file mode 100644 index 000000000..57ba628d9 Binary files /dev/null and b/docs/docresources/dvbcfrontendparams.png differ diff --git a/docs/docresources/dvbsatconf.png b/docs/docresources/dvbsatconf.png new file mode 100644 index 000000000..d133141b0 Binary files /dev/null and b/docs/docresources/dvbsatconf.png differ diff --git a/docs/docresources/dvbsfrontendparams.png b/docs/docresources/dvbsfrontendparams.png new file mode 100644 index 000000000..412626697 Binary files /dev/null and b/docs/docresources/dvbsfrontendparams.png differ diff --git a/docs/docresources/dvbtfrontendparams.png b/docs/docresources/dvbtfrontendparams.png new file mode 100644 index 000000000..b0af7d8f2 Binary files /dev/null and b/docs/docresources/dvbtfrontendparams.png differ diff --git a/docs/markdown/tv_adapters.md b/docs/markdown/tv_adapters.md index 03e4169c6..9755370dc 100644 --- a/docs/markdown/tv_adapters.md +++ b/docs/markdown/tv_adapters.md @@ -8,11 +8,11 @@ The adapters and tuners are listed and edited in a tree. ###Buttons -The following functions are available: +The following buttons are available: Button | Function ---------------|--------- -**Save** | Save the current TV adapter configuration. +**Save** | Save the current configuration. **Help** | Display this help page. --- @@ -20,8 +20,8 @@ Button | Function ###Device Tree The device tree lists the available frontends, LNB configuration and -so on related to your device in sections. Clicking on these sections -will display all available parameters. +so on related to your device(s) in sections. Clicking on these sections +will display all available parameters and various device information. !['TV Adapter params'](docresources/tvadapterparams.png) @@ -29,13 +29,51 @@ will display all available parameters. --- -##DVB-S +##Device Configuration Options + +You will generally see the following parameters for your device(s), however +there are device-specific parameters too, see +[Device-specific Parameters](#device-specific-parameters) for a full +list. + +linuxdvb_frontend + +--- + +##Device-specific Parameters + +###Satellite (DVB-S/ISDB-S) * Frontend - [Master](class/linuxdvb_frontend_dvbs) - [Slave](class/linuxdvb_frontend_dvbs_slave) -* SatConf - - [Basic LNB](class/linuxdvb_satconf) + - [Master (ISDB-S)](class/linuxdvb_frontend_isdb_s) +* Satellite Configuration + - [Universal LNB](class/linuxdvb_satconf_lnbonly) + - [2 Port](class/linuxdvb_satconf_2port) + - [4 Port](class/linuxdvb_satconf_4port) +* Satellite Configuration (Advanced) - [Advanced LNB](class/linuxdvb_satconf_advanced) - [Unicable EN50494 (experimental)](class/linuxdvb_satconf_en50494) + - [DiseqC Rotor](class/linuxdvb_rotor) + - [DiSEqC Switch](class/linuxdvb_switch) + - [Rotor (GOTOX)](class/linuxdvb_rotor_gotox) + - [Rotor (USALS)](class/linuxdvb_rotor_usals) + +--- +###Terrestrial (DVB-T/ATSC-T/ISDB-T) + +* Frontend + - [DVB-T/DVB-T2](class/linuxdvb_frontend_dvbt) + - [ATSC-T](class/linuxdvb_frontend_atsc_t) + - [ISDB-T](class/linuxdvb_frontend_isdb_t) + +--- + +###Cable (DVB-C/ATSC-C/ISDB-C) + +* Frontend + - [DVB-C](class/linuxdvb_frontend_dvbc) + - [ATSC-C](class/linuxdvb_frontend_atsc_c) + - [ISDB-C](class/linuxdvb_frontend_isdb_c) diff --git a/src/input/mpegts/linuxdvb/linuxdvb_frontend.c b/src/input/mpegts/linuxdvb/linuxdvb_frontend.c index 075779a05..25d948f40 100644 --- a/src/input/mpegts/linuxdvb/linuxdvb_frontend.c +++ b/src/input/mpegts/linuxdvb/linuxdvb_frontend.c @@ -51,11 +51,17 @@ linuxdvb_frontend_class_changed ( idnode_t *in ) linuxdvb_adapter_changed(la); } +CLASS_DOC(linuxdvb_frontend) +CLASS_DOC(linuxdvb_frontend_dvbs) +CLASS_DOC(linuxdvb_frontend_dvbt) +CLASS_DOC(linuxdvb_frontend_dvbc) + const idclass_t linuxdvb_frontend_class = { .ic_super = &mpegts_input_class, .ic_class = "linuxdvb_frontend", .ic_caption = N_("Linux DVB frontend"), + .ic_doc = tvh_doc_linuxdvb_frontend_class, .ic_changed = linuxdvb_frontend_class_changed, .ic_properties = (const property_t[]) { { @@ -175,6 +181,7 @@ const idclass_t linuxdvb_frontend_dvbt_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_dvbt", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbt_class, .ic_caption = N_("Linux DVB-T frontend"), .ic_properties = (const property_t[]){ { @@ -258,6 +265,7 @@ const idclass_t linuxdvb_frontend_dvbs_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_dvbs", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbs_class, .ic_caption = N_("Linux DVB-S frontend"), .ic_get_childs = linuxdvb_frontend_dvbs_class_get_childs, .ic_properties = (const property_t[]){ @@ -300,6 +308,7 @@ const idclass_t linuxdvb_frontend_dvbs_slave_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_dvbs_slave", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbs_class, .ic_caption = N_("Linux DVB-S slave frontend"), .ic_properties = (const property_t[]){ { @@ -330,6 +339,7 @@ const idclass_t linuxdvb_frontend_dvbc_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_dvbc", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbc_class, .ic_caption = N_("Linux DVB-C frontend"), .ic_properties = (const property_t[]){ {} @@ -340,6 +350,7 @@ const idclass_t linuxdvb_frontend_atsc_t_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_atsc_t", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbt_class, .ic_caption = N_("Linux ATSC-T frontend"), .ic_properties = (const property_t[]){ {} @@ -350,6 +361,7 @@ const idclass_t linuxdvb_frontend_atsc_c_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_atsc_c", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbc_class, .ic_caption = N_("Linux ATSC-C frontend"), .ic_properties = (const property_t[]){ {} @@ -360,6 +372,7 @@ const idclass_t linuxdvb_frontend_isdb_t_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_isdb_t", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbt_class, .ic_caption = N_("Linux ISDB-T frontend"), .ic_properties = (const property_t[]){ {} @@ -370,6 +383,7 @@ const idclass_t linuxdvb_frontend_isdb_c_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_isdb_c", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbc_class, .ic_caption = N_("Linux ISDB-C frontend"), .ic_properties = (const property_t[]){ {} @@ -380,6 +394,7 @@ const idclass_t linuxdvb_frontend_isdb_s_class = { .ic_super = &linuxdvb_frontend_class, .ic_class = "linuxdvb_frontend_isdb_s", + .ic_doc = tvh_doc_linuxdvb_frontend_dvbs_class, .ic_caption = N_("Linux ISDB-S frontend"), .ic_properties = (const property_t[]){ {} diff --git a/src/input/mpegts/linuxdvb/linuxdvb_rotor.c b/src/input/mpegts/linuxdvb/linuxdvb_rotor.c index c95d41ff3..cbe828c40 100644 --- a/src/input/mpegts/linuxdvb/linuxdvb_rotor.c +++ b/src/input/mpegts/linuxdvb/linuxdvb_rotor.c @@ -86,9 +86,12 @@ linuxdvb_rotor_class_get_title ( idnode_t *o, const char *lang ) extern const idclass_t linuxdvb_diseqc_class; +CLASS_DOC(linuxdvb_satconf) + const idclass_t linuxdvb_rotor_class = { .ic_super = &linuxdvb_diseqc_class, .ic_class = "linuxdvb_rotor", + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_caption = N_("DiseqC rotor"), .ic_get_title = linuxdvb_rotor_class_get_title, .ic_properties = (const property_t[]) { diff --git a/src/input/mpegts/linuxdvb/linuxdvb_satconf.c b/src/input/mpegts/linuxdvb/linuxdvb_satconf.c index fe8f939c4..b2844dfbf 100644 --- a/src/input/mpegts/linuxdvb/linuxdvb_satconf.c +++ b/src/input/mpegts/linuxdvb/linuxdvb_satconf.c @@ -208,12 +208,16 @@ linuxdvb_satconf_class_get_childs ( idnode_t *o ) /* * Generic satconf */ + +CLASS_DOC(linuxdvb_satconf) /* Referenced by multiple classes. */ + const idclass_t linuxdvb_satconf_class = { .ic_class = "linuxdvb_satconf", .ic_caption = N_("DVB-S satellite configuration"), .ic_event = "linuxdvb_satconf", .ic_get_title = linuxdvb_satconf_class_get_title, + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_changed = linuxdvb_satconf_class_changed, .ic_properties = (const property_t[]) { { @@ -276,12 +280,14 @@ const idclass_t linuxdvb_satconf_lnbonly_class = { .ic_super = &linuxdvb_satconf_class, .ic_class = "linuxdvb_satconf_lnbonly", + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_caption = N_("DVB-S simple"), .ic_properties = (const property_t[]) { { .type = PT_STR, .id = "networks", .name = N_("Networks"), + .desc = N_("The networks assigned to the device."), .islist = 1, .get = linuxdvb_satconf_class_network_get0, .set = linuxdvb_satconf_class_network_set0, @@ -300,6 +306,7 @@ const idclass_t linuxdvb_satconf_2port_class = { .ic_super = &linuxdvb_satconf_class, .ic_class = "linuxdvb_satconf_2port", + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_caption = N_("DVB-S tone burst"), .ic_properties = (const property_t[]) { { @@ -337,6 +344,7 @@ const idclass_t linuxdvb_satconf_4port_class = { .ic_super = &linuxdvb_satconf_class, .ic_class = "linuxdvb_satconf_4port", + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_caption = N_("DVB-S 4-port"), .ic_properties = (const property_t[]) { { @@ -455,6 +463,7 @@ const idclass_t linuxdvb_satconf_en50494_class = { .ic_super = &linuxdvb_satconf_class, .ic_class = "linuxdvb_satconf_en50494", + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_caption = N_("DVB-S EN50494 (UniCable, experimental)"), .ic_properties = (const property_t[]) { { @@ -521,6 +530,7 @@ const idclass_t linuxdvb_satconf_advanced_class = { .ic_super = &linuxdvb_satconf_class, .ic_class = "linuxdvb_satconf_advanced", + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_caption = N_("DVB-S advanced"), .ic_get_childs = linuxdvb_satconf_class_get_childs, .ic_properties = (const property_t[]) { @@ -1313,6 +1323,7 @@ const idclass_t linuxdvb_satconf_ele_class = { .ic_class = "linuxdvb_satconf_ele", .ic_caption = N_("Satconf"), + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_event = "linuxdvb_satconf_ele", .ic_get_title = linuxdvb_satconf_ele_class_get_title, .ic_get_childs = linuxdvb_satconf_ele_class_get_childs, diff --git a/src/input/mpegts/linuxdvb/linuxdvb_switch.c b/src/input/mpegts/linuxdvb/linuxdvb_switch.c index 11a368f61..ea5ddd35c 100644 --- a/src/input/mpegts/linuxdvb/linuxdvb_switch.c +++ b/src/input/mpegts/linuxdvb/linuxdvb_switch.c @@ -109,11 +109,14 @@ linuxdvb_switch_class_get_title ( idnode_t *o, const char *lang ) extern const idclass_t linuxdvb_diseqc_class; +CLASS_DOC(linuxdvb_satconf) + const idclass_t linuxdvb_switch_class = { .ic_super = &linuxdvb_diseqc_class, .ic_class = "linuxdvb_switch", .ic_caption = N_("DiseqC switch"), + .ic_doc = tvh_doc_linuxdvb_satconf_class, .ic_get_title = linuxdvb_switch_class_get_title, .ic_properties = (const property_t[]) { {