mdhelp: add a common set of button table rows. mdhelp: use the (above…

…) button rows in some of the docs mdhelp: update timers/dvrautorec screenshots mdhelp: update dvrautorec caption
tvheadend · May 7, 2016 · 96d07b9 · 96d07b9
1 parent 9cedb05
commit 96d07b9
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 71 deletions.
diff --git a/docs/class/config.md b/docs/class/config.md
@@ -11,10 +11,9 @@ The tab has the following buttons:
 
 Button                 | Function
 -----------------------|-------------------
-**Save**               | Save all changes (this will reload the web interface).
-**Undo**               | Revert all changes since last save.
+**Save**       | Save the current configuration.
+**Undo**       | Undo changes since the last save.
 **Start wizard**       | Display the first-run set-up wizard.
-**View Level**| Change the interface view level to show/hide more advanced options.
-**Help**               | Display this help page.
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
diff --git a/docs/class/dvrautorec.md b/docs/class/dvrautorec.md
@@ -4,34 +4,24 @@ This tab controls EPG-driven recording rules.
 
 ---
 
-###Menu Bar/Buttons
+<tvh_include>inc/common_button_table_start</tvh_include>
 
-The tab has the following buttons:
-
-Button                 | Function
------------------------|-------------------
-**Save**               | Save any changes made to the grid/entries.
-**Undo**               | Revert any changes made since the last save.
-**Add**                | Display the *Add Autorec* dialog.
-**Delete**             | Delete the selected entry/entries.
-**Edit**               | Edit the selected entry.
-**View Level**| Change the interface view level to show/hide more advanced options.
-**Help**               | Display this help page.
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
 
-###Adding an Entry/Rule
+<tvh_include>inc/add_grid_entry</tvh_include>
 
-You can add an entry by pressing the *[Add]* button from the menu bar.
+####An Example
 
-For example, if you wanted to record any programs matching "BBC News" on 
+If you wanted to record any programs matching "BBC News" on 
 BBC One you would enter something like this into the add entry dialog: 
 
 !['Autorec' example entry](docresources/dvrautorecadd.png)
 
 This uses a regular expression (regex) to match the program title 
 "BBC News" exactly, otherwise event titles containing the phrase would 
-also match (e.g "BBC News at One", "BBC News at Six" etc).
+also match, e.g "BBC News at One" and "BBC News at Six" etc.
 
 Regular expressions examples:
 
@@ -47,20 +37,11 @@ automatically start being recorded.**
 
 ---
 
-###Editing an Entry
-
-Highlight (select) the desired entry within the grid, then click the *[Edit]* 
-button from the menu bar.
-
-**Tip**: You can quickly make changes to an entry by double-clicking on 
-the desired field within the grid. See *Editing Fields* on the [Web interface Guide - General](webui_general) 
-page for details.
+<tvh_include>inc/edit_grid_entries</tvh_include>
 
 ---
 
-###Deleting an Entry
-
-Highlight (select) the desired entry within the grid, then click the *[Delete]* 
-button from the menu bar.
+<tvh_include>inc/del_grid_entries</tvh_include>
 
 ---
+
diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md
@@ -37,7 +37,7 @@ Button                       | Function
 -----------------------------|---------
 **Delete**                   | Delete the selected grid entries.
 **Edit**                     | Edit the selected grid entries.
-**View Level**               | Change the interface view level to show/hide more advanced options.
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 The following functions are only available in the 
 **Upcoming/Current Recordings** tab.

diff --git a/docs/class/dvrtimerec.md b/docs/class/dvrtimerec.md
@@ -1,49 +1,30 @@
 This tab controls timer-driven recording rules.
 
-![Timer Tab](docresources/timeschedules.png)
+![Timer Tab](docresources/timers.png)
 
 ---
 
-###Menu Bar/Buttons
+<tvh_include>inc/common_button_table_start</tvh_include>
 
-The tab has the following buttons:
-
-Button                 | Function
------------------------|-------------------
-**Save**               | Save any changes made to the grid/entries.
-**Undo**               | Revert any changes made since the last save.
-**Add**                | Display the *Add Timer* dialog.
-**Delete**             | Delete the selected entry/entries.
-**Edit**               | Edit the selected entry.
-**View Level**| Change the interface view level to show/hide more advanced options.
-**Help**               | Display this help page.
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
 
-###Adding an Entry
+<tvh_include>inc/add_grid_entry</tvh_include>
 
-You can add an entry by pressing the *[Add]* button from the menu bar.
+####An Example
 
 ![Timer add example](docresources/dvrtimeradd.png)
 
 Note that when you create a rule/entry it will also generate a [DVR Entry](class/dvrentry).
 
 ---
 
-###Editing an Entry
-
-Highlight (select) the desired entry within the grid, then click the *[Edit]* 
-button from the menu bar.
-
-**Tip**: You can quickly make changes to an entry by double-clicking on 
-the desired field within the grid. See *Editing Fields* on the [Web interface Guide - General](webui_general) 
-page for details.
+<tvh_include>inc/edit_grid_entries</tvh_include>
 
 ---
 
-###Deleting an Entry
-
-Highlight (select) the desired entry within the grid, then click the *[Delete]* 
-button from the menu bar.
+<tvh_include>inc/del_grid_entries</tvh_include>
 
 ---
+
diff --git a/docs/class/ipblocking.md b/docs/class/ipblocking.md
@@ -5,7 +5,9 @@ are not allowed to login (use any Tvheadend service).
 
 ---
 
-<tvh_include>inc/buttons1</tvh_include>
+<tvh_include>inc/common_button_table_start</tvh_include>
+
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
 

diff --git a/docs/class/linuxdvb_frontend_dvbc.md b/docs/class/linuxdvb_frontend_dvbc.md
@@ -20,6 +20,6 @@ The following buttons are available:
 Button         | Function
 ---------------|---------
 **Save**       | Save the current configuration.
-**Help**       | Display this help page. 
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
diff --git a/docs/class/linuxdvb_frontend_dvbs.md b/docs/class/linuxdvb_frontend_dvbs.md
@@ -20,6 +20,6 @@ The following buttons are available:
 Button         | Function
 ---------------|---------
 **Save**       | Save the current configuration.
-**Help**       | Display this help page. 
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
diff --git a/docs/class/linuxdvb_satconf.md b/docs/class/linuxdvb_satconf.md
@@ -12,7 +12,7 @@ The following buttons are available:
 Button         | Function
 ---------------|---------
 **Save**       | Save the current configuration.
-**Help**       | Display this help page. 
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
 

diff --git a/docs/docresources/dvrautorecentries.png b/docs/docresources/dvrautorecentries.png
diff --git a/docs/docresources/timers.png b/docs/docresources/timers.png
diff --git a/docs/markdown/inc/common_button_table_end.md b/docs/markdown/inc/common_button_table_end.md
@@ -0,0 +1 @@
+**View Level**         | Change the interface view level to show/hide more advanced options.\n**Help**               | Display this help page.
diff --git a/docs/markdown/inc/buttons1.md → ...markdown/inc/common_button_table_start.md b/docs/markdown/inc/buttons1.md → ...markdown/inc/common_button_table_start.md
@@ -1,13 +1,11 @@
 ###Menu Bar/Buttons
 
-The tab has the following buttons:
+The following functions are available:
 
 Button                 | Function
 -----------------------|-------------------
 **Save**               | Save any changes made to the grid/entries.
 **Undo**               | Revert any changes made since the last save.
 **Add**                | Display the *Add entry* dialog.
 **Delete**             | Delete the selected entry/entries.
-**Edit**               | Edit the selected entry.
-**View Level**         | Change the interface view level to show/hide more advanced options.
-**Help**               | Display this help page.
+**Edit**               | Edit the selected entries.
diff --git a/docs/markdown/tv_adapters.md b/docs/markdown/tv_adapters.md
@@ -13,8 +13,7 @@ The following buttons are available:
 Button         | Function
 ---------------|---------
 **Save**       | Save the current configuration.
-**View Level**| Change the interface view level to show/hide more advanced options.
-**Help**       | Display this help page.
+<tvh_include>inc/common_button_table_end</tvh_include>
 
 ---
 

diff --git a/src/dvr/dvr_autorec.c b/src/dvr/dvr_autorec.c
@@ -1041,7 +1041,9 @@ const idclass_t dvr_autorec_entry_class = {
       .id       = "channel",
       .name     = N_("Channel"),
       .desc     = N_("The channel on which this rule applies, i.e. the "
-                     "channel you're aiming to record."),
+                     "channel you're aiming to record. You can leave "
+                     "this field blank to apply the rule to all "
+                     "channels."),
       .set      = dvr_autorec_entry_class_channel_set,
       .get      = dvr_autorec_entry_class_channel_get,
       .rend     = dvr_autorec_entry_class_channel_rend,