From: Mark Clarkstone <hello@markclarkstone.co.uk>
Date: Wed, 4 May 2016 10:12:32 +0000 (+0100)
Subject: mdhelp: add mux scheduler doc + screenies mdhelp: change caption (from "mux schedule... 
X-Git-Tag: v4.2.1~577
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=78122a17d7baf9331903d5dbfc3789c9c3a89c52;p=thirdparty%2Ftvheadend.git

mdhelp: add mux scheduler doc + screenies mdhelp: change caption (from "mux schedule entry" to "Mux Scheduler") mdhelp: add cron property doc
---

diff --git a/docs/class/mpegts_mux_sched.md b/docs/class/mpegts_mux_sched.md
new file mode 100644
index 000000000..0324d71ff
--- /dev/null
+++ b/docs/class/mpegts_mux_sched.md
@@ -0,0 +1,46 @@
+Mux Schedulers enable Tvheadend to automatically play channels. This is 
+useful to get EPG, services or access rights updates.
+
+!['Mux Schedule Entries'](docresources/configdvbmuxsched.png)
+
+---
+
+###Menu Bar/Buttons
+
+The following functions are available:
+
+Button         | Function
+---------------|---------
+**Save**       | Save any changes made.
+**Undo**       | Undo any changes made since the last save.
+**Add**        | Add a new entry.
+**Delete**     | Delete an existing entry.
+**Edit**       | Edit an existing schedule entry.
+**View Level** | Change the interface view level to show/hide more advanced options.
+**Help**       | Displays this help page. 
+
+---
+
+###Adding/Editing an Entry
+
+You can add an entry by pressing the *[Add]* button from the menu bar. 
+To edit an entry highlight (select) the entry from within the grid, and 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:
+
+!['Mux Add/Edit Example'](docresources/configdvbmuxsched1.png)
+
+---
+
+###Deleting an Entry
+
+To delete an entry highlight (select) the entry from within the grid, 
+and press the *[Delete]* button from the menu bar.
+
+**Tip**: You can select all entries within the grid by pressing ctrl+A. 
+You can also ctrl+click to make additional selections, or shift+click to 
+select a range. 
+
+---
diff --git a/docs/docresources/configdvbmuxsched.png b/docs/docresources/configdvbmuxsched.png
index 65b40a066..57bc75ee1 100644
Binary files a/docs/docresources/configdvbmuxsched.png and b/docs/docresources/configdvbmuxsched.png differ
diff --git a/docs/docresources/configdvbmuxsched1.png b/docs/docresources/configdvbmuxsched1.png
new file mode 100644
index 000000000..adaed4235
Binary files /dev/null and b/docs/docresources/configdvbmuxsched1.png differ
diff --git a/docs/property/cron.md b/docs/property/cron.md
new file mode 100644
index 000000000..d88442358
--- /dev/null
+++ b/docs/property/cron.md
@@ -0,0 +1,23 @@
+:
+Example : every day at 2am is : `0 2 * * *` 
+
+`┌───────────── min (0 - 59)` 
+
+`│ ┌────────────── hour (0 - 23)` 
+
+`│ │ ┌─────────────── day of month (1 - 31)` 
+
+`│ │ │ ┌──────────────── month (1 - 12)` 
+
+`│ │ │ │ ┌───────────────── day of week (0 - 6) (0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the same as 0)` 
+
+`│ │ │ │ │` 
+
+`│ │ │ │ │` 
+
+`* * * * *` 
+ 
+You cannot use non-standard predefined scheduling definitions for this 
+field.
+
+See [Wikipedia for a detailed look into Cron.](https://en.wikipedia.org/wiki/Cron)
diff --git a/src/input/mpegts/mpegts_mux_sched.c b/src/input/mpegts/mpegts_mux_sched.c
index e310e3f88..3f65e5459 100644
--- a/src/input/mpegts/mpegts_mux_sched.c
+++ b/src/input/mpegts/mpegts_mux_sched.c
@@ -119,11 +119,15 @@ mpegts_mux_sched_class_cron_set ( void *p, const void *v )
   return 0;
 }
 
+CLASS_DOC(mpegts_mux_sched)
+PROP_DOC(cron)
+
 const idclass_t mpegts_mux_sched_class =
 {
   .ic_class      = "mpegts_mux_sched",
-  .ic_caption    = N_("Mux schedule entry"),
+  .ic_caption    = N_("Mux Scheduler"),
   .ic_event      = "mpegts_mux_sched",
+  .ic_doc        = tvh_doc_mpegts_mux_sched_class,
   .ic_changed    = mpegts_mux_sched_class_changed,
   .ic_save       = mpegts_mux_sched_class_save,
   .ic_delete     = mpegts_mux_sched_class_delete,
@@ -149,6 +153,7 @@ const idclass_t mpegts_mux_sched_class =
       .id       = "cron",
       .name     = N_("Cron"),
       .desc     = N_("Schedule frequency (in Cron format)."),
+      .doc      = prop_doc_cron,
       .off      = offsetof(mpegts_mux_sched_t, mms_cronstr),
       .set      = mpegts_mux_sched_class_cron_set,
     },