From: Mark Clarkstone <hello@markclarkstone.co.uk>
Date: Tue, 10 May 2016 00:02:33 +0000 (+0100)
Subject: mdhelp: add bouquet help doc + screenshots
X-Git-Tag: v4.2.1~532
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=48d61cef4ac06eb5b57ef5a8947a5aa1a89907fc;p=thirdparty%2Ftvheadend.git

mdhelp: add bouquet help doc + screenshots
---

diff --git a/docs/class/bouquet.md b/docs/class/bouquet.md
new file mode 100644
index 000000000..44a0311cf
--- /dev/null
+++ b/docs/class/bouquet.md
@@ -0,0 +1,38 @@
+Bouquets are broadcaster-defined groupings and orders of channels.
+
+!['Bouqets' Tab](static/img/doc/bouquettab.png)
+
+To use bouquets, ensure to add and scan all available muxes using the
+predefined muxes or manual configuration.
+
+The bouquets are obtained automatically from the DVB source during the
+mux scan period. Note that bouquets may use more muxes and only services
+from scanned muxes are added. The mux with bouquets might require
+another scan when all muxes are discovered (manually using the rescan
+checkbox).
+
+The fastscan bouquets are pre-defined in the configuration tree. These
+bouquets must be manually enabled to let Tvheadend to subscribe and
+listen to the specific MPEG-TS PIDs.
+
+---
+
+<tvh_include>inc/common_button_table_start</tvh_include>
+
+<tvh_include>inc/common_button_table_end</tvh_include>
+
+---
+
+<tvh_include>inc/add_grid_entry</tvh_include>
+
+!['Add Bouquet Dialog'](static/img/doc/bouquetadd.png)
+
+---
+
+<tvh_include>inc/edit_grid_entries</tvh_include>
+
+---
+
+<tvh_include>inc/del_grid_entries</tvh_include>
+
+---
diff --git a/docs/property/bouquet_mapping_options.md b/docs/property/bouquet_mapping_options.md
new file mode 100644
index 000000000..4e9fe3de9
--- /dev/null
+++ b/docs/property/bouquet_mapping_options.md
@@ -0,0 +1,9 @@
+:
+
+Option                         | Function
+-------------------------------|-------------
+**Map zero-numbered channels** | Include channels with no channel number.
+**Map unnamed channels**       | Include channels with no name. 
+**Map radio channels**:        | Include radio channels. 
+**Map encrypted services**     | Include channels even if the linked service is flagged as encrypted. 
+**Merge same name**            | Combine channels with the same name into a single channel.
diff --git a/src/bouquet.c b/src/bouquet.c
index 13a284ac7..623a0b332 100644
--- a/src/bouquet.c
+++ b/src/bouquet.c
@@ -954,9 +954,13 @@ bouquet_class_ext_url_notify ( void *obj, const char *lang )
   bouquet_download_trigger((bouquet_t *)obj);
 }
 
+CLASS_DOC(bouquet)
+PROP_DOC(bouquet_mapping_options)
+
 const idclass_t bouquet_class = {
   .ic_class      = "bouquet",
   .ic_caption    = N_("Bouquet"),
+  .ic_doc        = tvh_doc_bouquet_class,
   .ic_event      = "bouquet",
   .ic_perm_def   = ACCESS_ADMIN,
   .ic_save       = bouquet_class_save,
@@ -994,15 +998,8 @@ const idclass_t bouquet_class = {
       .islist   = 1,
       .id       = "mapopt",
       .name     = N_("Channel mapping options"),
-      .desc     = N_("Options to use/used when mapping "
-                     "channels; Map zero-numbered "
-                     "channels: include channels with no channel number. "
-                     " | Map unnamed channels: include channels with no "
-                     "name. | Map radio channels: include radio "
-                     "channels. | Map encrypted services: include "
-                     "channels even if the linked service is flagged as "
-                     "encrypted. | Merge same name: combine channels "
-                     "with the same name into a single channel."),
+      .desc     = N_("Options to use/used when mapping - see Help for details."),
+      .doc      = prop_doc_bouquet_mapping_options,
       .notify   = bouquet_class_mapopt_notify,
       .list     = bouquet_class_mapopt_enum,
       .get      = bouquet_class_mapopt_get,
diff --git a/src/webui/static/img/doc/bouquetadd.png b/src/webui/static/img/doc/bouquetadd.png
new file mode 100644
index 000000000..e396597c5
Binary files /dev/null and b/src/webui/static/img/doc/bouquetadd.png differ
diff --git a/src/webui/static/img/doc/bouquettab.png b/src/webui/static/img/doc/bouquettab.png
new file mode 100644
index 000000000..8e8396478
Binary files /dev/null and b/src/webui/static/img/doc/bouquettab.png differ