mdhelp: update various captions mdhelp: add mpegts doc (and screenies)

tvheadend · May 4, 2016 · 78faf11 · 78faf11
1 parent 229e0af
commit 78faf11
Show file tree

Hide file tree

Showing 8 changed files with 89 additions and 39 deletions.
diff --git a/docs/class/ipblocking.md b/docs/class/ipblocking.md
@@ -32,6 +32,10 @@ then press the *[Edit]* button from the menu bar.
 
 Note that both the *[Add]* and *[Edit]* buttons display similar dialogs.
 
+**Tip**: You can enter a comma-separated list of network prefixes, if you're 
+unsure as to what to enter in the *Network prefix* field take a look at 
+[this guide](https://www.ripe.net/about-us/press-centre/understanding-ip-addressing).
+
 ---
 
 ### Deleting an Entry.

diff --git a/docs/class/mpegts_network.md b/docs/class/mpegts_network.md
@@ -1,39 +1,29 @@
 A network is the type of carrier for your television signals. Tvheadend
 supports several different types of network, notably:
 
-* Cable TV, delivered via a cable to your house
-  - [DVB-C](class/dvb_network_dvbc)
-  - [ISDB-C](class/dvb_network_isdb_c)
-  - [ATSC-C](class/dvb_network_atsc_c) - common in north and central America and parts of south Asia
+* [Network Types](class/mpegts_network)
+ * Cable TV, delivered via a cable to your house
+   - [DVB-C](class/dvb_network_dvbc) - common in most of Europe
+   - [ISDB-C](class/dvb_network_isdb_c) - common in Brazil and various other countries throughout south America
+   - [ATSC-C](class/dvb_network_atsc_c) - common in north and central America and parts of south Asia
+ * Satellite, any signal coming in via a dish
+   - [DVB-S](class/dvb_network_dvbs) - Available worldwide
+   - [ISDB-S](class/dvb_network_isdb_s) - available worldwide but common in Brazil and various other countries throughout south America
+ * Terrestrial, over-the-air broadcasts received through a traditional television aerial
+   - [DVB-T](class/dvb_network_dvbt) - common in most of Europe
+   - [ISDB-T](class/dvb_network_isdb_t) - common in Brazil and various other countries throughout south America
+   - [ATSC-T](class/dvb_network_atsc_t) - common in north and central America
+ * IPTV - TV over the Internet via your broadband connection
+   - [IPTV](class/iptv_network)
+   - [IPTV Automatic Network](class/iptv_auto_network) - IPTV using a playlist as the source
 
-* Satellite, any signal coming in via a dish
-  - [DVB-S](class/dvb_network_dvbs)
-  - [ISDB-S](class/dvb_network_isdb_s)
-
-* Terrestrial, over-the-air broadcasts received through a traditional television aerial
-  - [DVB-T](class/dvb_network_dvbt) - common in most of Europe
-  - [ISDB-T](class/dvb_network_isdb_t) - common in Brazil and various other countries throughout south America
-  - [ATSC-T](class/dvb_network_atsc_t) - common in north and central America
-
-* IPTV - TV over the Internet via your broadband connection
-  - [IPTV](class/iptv_network)
-  - [IPTV Automatic Network](class/iptv_auto_network) - IPTV using a playlist as the source
+Click the desired network type (above) to see all available 
+[options](#items).
 
 !['Networks' Tab Screenshot](docresources/dvbinputsnetwork.png)
 
 ---
 
-###Add/Edit Dialog Example
-
-A common set of fields is used for the _Add_ or _Edit_ functions, most
-of which can also be seen in the grid view:
-
-!['Add/Edit Network' Dialog - DVB-S/2](docresources/dvbnetworkedit.png)
-
-!['Add/Edit Network' Dialog - IPTV](docresources/configdvbnetwork_iptv.png)
-
----
-
 ###Menu Bar/Buttons
 
 The following functions are available:
@@ -50,3 +40,39 @@ Button         | Function
 **Help**       | Displays this help page. 
 
 ---
+
+###Add/Edit a Network
+
+To create a network click the *[Add]* button from the menu bar and 
+select the required network type, and then using the resultant dialog 
+enter/select the desired network options. To edit a network highlight 
+(select) the network within the grid, and then press the *[Edit]* 
+button from the menu bar.
+
+A common set of fields is used for the _Add_ or _Edit_ functions, most
+of which can also be seen in the grid view:
+
+!['Add/Edit Network' Dialog - DVB-S/2](docresources/dvbnetworkedit.png)
+
+**Notes**:
+
+* Once you've created a network (and added muxes) you must assign it to 
+an **enabled** adapter.
+* There is a 5-10 minute delay before a scan starts, this is so you can 
+make changes if needed (this does not apply to IPTV networks).
+
+---
+
+###Force Scanning
+
+You can force a scan by highlighting (selecting) the network(s) within the grid, 
+and then pressing the *[Force Scan]* button from the menu bar. 
+
+---
+
+###Deleting a Network
+
+To delete a network highlight (select) the network within the grid, and then 
+press the *[Delete]* button.
+
+---
diff --git a/docs/docresources/dvbinputsnetwork.png b/docs/docresources/dvbinputsnetwork.png
diff --git a/docs/docresources/dvbnetworkedit.png b/docs/docresources/dvbnetworkedit.png
diff --git a/docs/property/predefinedmuxlist.md b/docs/property/predefinedmuxlist.md
@@ -0,0 +1,6 @@
+:
+
+Generally an out of date mux list isn't an issue provided that you have 
+*Network Discovery* enabled and a mux (in the list) with [NIT](https://en.wikipedia.org/wiki/Program-specific_information#NIT_.28network_information_specific_data.29) 
+data scans successfully, Tvheadend will parse the NIT and then add/scan 
+newly discovered muxes automatically. 
diff --git a/src/input/mpegts/iptv/iptv.c b/src/input/mpegts/iptv/iptv.c
@@ -703,7 +703,7 @@ extern const idclass_t mpegts_network_class;
 const idclass_t iptv_network_class = {
   .ic_super      = &mpegts_network_class,
   .ic_class      = "iptv_network",
-  .ic_caption    = N_("IPTV network"),
+  .ic_caption    = N_("IPTV Network"),
   .ic_delete     = iptv_network_class_delete,
   .ic_properties = (const property_t[]){
     {
@@ -817,7 +817,7 @@ iptv_auto_network_class_charset_list(void *o, const char *lang)
 const idclass_t iptv_auto_network_class = {
   .ic_super      = &iptv_network_class,
   .ic_class      = "iptv_auto_network",
-  .ic_caption    = N_("IPTV automatic network"),
+  .ic_caption    = N_("IPTV Automatic Network"),
   .ic_properties = (const property_t[]){
     {
       .type     = PT_STR,

diff --git a/src/input/mpegts/mpegts_network.c b/src/input/mpegts/mpegts_network.c
@@ -129,10 +129,13 @@ mpegts_network_class_idlescan_notify ( void *p, const char *lang )
   }
 }
 
+CLASS_DOC(mpegts_network)
+
 const idclass_t mpegts_network_class =
 {
   .ic_class      = "mpegts_network",
-  .ic_caption    = N_("MPEG-TS network"),
+  .ic_caption    = N_("DVB Inputs - Networks"),
+  .ic_doc        = tvh_doc_mpegts_network_class,
   .ic_event      = "mpegts_network",
   .ic_perm_def   = ACCESS_ADMIN,
   .ic_save       = mpegts_network_class_save,

diff --git a/src/input/mpegts/mpegts_network_dvb.c b/src/input/mpegts/mpegts_network_dvb.c
@@ -221,6 +221,8 @@ dvb_network_class_orbital_pos_list ( void *o, const char *lang )
   return m;
 }
 
+PROP_DOC(predefinedmuxlist)
+
 const idclass_t dvb_network_class =
 {
   .ic_super      = &mpegts_network_class,
@@ -236,7 +238,7 @@ const idclass_t dvb_network_dvbt_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_dvbt",
-  .ic_caption    = N_("DVB-T network"),
+  .ic_caption    = N_("DVB-T Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -245,6 +247,7 @@ const idclass_t dvb_network_dvbt_class =
       .desc     = N_("Use a pre-defined list of DVB-T muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_dvbt,
@@ -258,7 +261,7 @@ const idclass_t dvb_network_dvbc_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_dvbc",
-  .ic_caption    = N_("DVB-C network"),
+  .ic_caption    = N_("DVB-C Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -267,6 +270,7 @@ const idclass_t dvb_network_dvbc_class =
       .desc     = N_("Use a pre-defined list of DVB-C muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_dvbc,
@@ -280,7 +284,7 @@ const idclass_t dvb_network_dvbs_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_dvbs",
-  .ic_caption    = N_("DVB-S network"),
+  .ic_caption    = N_("DVB-S Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -289,6 +293,7 @@ const idclass_t dvb_network_dvbs_class =
       .desc     = N_("Use a pre-defined list of DVB-S/S2 muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_dvbs,
@@ -312,7 +317,7 @@ const idclass_t dvb_network_atsc_t_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_atsc_t",
-  .ic_caption    = N_("ATSC-T network"),
+  .ic_caption    = N_("ATSC-T Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -321,6 +326,7 @@ const idclass_t dvb_network_atsc_t_class =
       .desc     = N_("Use a pre-defined list of ATSC-T muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_atsc_t,
@@ -334,7 +340,7 @@ const idclass_t dvb_network_atsc_c_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_atsc_c",
-  .ic_caption    = N_("ATSC-C network"),
+  .ic_caption    = N_("ATSC-C Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -343,6 +349,7 @@ const idclass_t dvb_network_atsc_c_class =
       .desc     = N_("Use a pre-defined list of ATSC-C muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_atsc_c,
@@ -356,7 +363,7 @@ const idclass_t dvb_network_isdb_t_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_isdb_t",
-  .ic_caption    = N_("ISDB-T network"),
+  .ic_caption    = N_("ISDB-T Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -365,6 +372,7 @@ const idclass_t dvb_network_isdb_t_class =
       .desc     = N_("Use a pre-defined list of ISDB-T muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_isdb_t,
@@ -378,7 +386,7 @@ const idclass_t dvb_network_isdb_c_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_isdb_c",
-  .ic_caption    = N_("ISDB-C network"),
+  .ic_caption    = N_("ISDB-C Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -387,6 +395,7 @@ const idclass_t dvb_network_isdb_c_class =
       .desc     = N_("Use a pre-defined list of ISDB-C muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_isdb_c,
@@ -400,7 +409,7 @@ const idclass_t dvb_network_isdb_s_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_isdb_s",
-  .ic_caption    = N_("ISDB-S network"),
+  .ic_caption    = N_("ISDB-S Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -409,6 +418,7 @@ const idclass_t dvb_network_isdb_s_class =
       .desc     = N_("Use a pre-defined list of ISDB-S muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_isdb_s,
@@ -422,7 +432,7 @@ const idclass_t dvb_network_dab_class =
 {
   .ic_super      = &dvb_network_class,
   .ic_class      = "dvb_network_dab",
-  .ic_caption    = N_("DAB network"),
+  .ic_caption    = N_("DAB Network"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -431,6 +441,7 @@ const idclass_t dvb_network_dab_class =
       .desc     = N_("Use a pre-defined list of DAB muxes. "
                      "Note: these lists can sometimes be outdated and "
                      "may cause scanning to take longer than usual."),
+      .doc      = prop_doc_predefinedmuxlist,
       .set      = dvb_network_class_scanfile_set,
       .get      = dvb_network_class_scanfile_get,
       .list     = dvb_network_class_scanfile_list_dab,