From: Mark Clarkstone Date: Fri, 6 May 2016 14:31:12 +0000 (+0100) Subject: mdhelp: add a common set of button table rows. mdhelp: use the (above) button rows... X-Git-Tag: v4.2.1~556 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=96d07b9e5c63fee5e62df567d391e899edc110f5;p=thirdparty%2Ftvheadend.git 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 --- diff --git a/docs/class/config.md b/docs/class/config.md index 36d249bf0..0b5c50429 100644 --- 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. +inc/common_button_table_end --- diff --git a/docs/class/dvrautorec.md b/docs/class/dvrautorec.md index 0ef8c8d6a..6d4dc80ed 100644 --- a/docs/class/dvrautorec.md +++ b/docs/class/dvrautorec.md @@ -4,34 +4,24 @@ This tab controls EPG-driven recording rules. --- -###Menu Bar/Buttons +inc/common_button_table_start -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. +inc/common_button_table_end --- -###Adding an Entry/Rule +inc/add_grid_entry -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. +inc/edit_grid_entries --- -###Deleting an Entry - -Highlight (select) the desired entry within the grid, then click the *[Delete]* -button from the menu bar. +inc/del_grid_entries --- + diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index dce4172df..b70a7e0d4 100644 --- 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. +inc/common_button_table_end The following functions are only available in the **Upcoming/Current Recordings** tab. diff --git a/docs/class/dvrtimerec.md b/docs/class/dvrtimerec.md index 3fb552874..72ee69e6e 100644 --- a/docs/class/dvrtimerec.md +++ b/docs/class/dvrtimerec.md @@ -1,28 +1,18 @@ This tab controls timer-driven recording rules. -![Timer Tab](docresources/timeschedules.png) +![Timer Tab](docresources/timers.png) --- -###Menu Bar/Buttons +inc/common_button_table_start -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. +inc/common_button_table_end --- -###Adding an Entry +inc/add_grid_entry -You can add an entry by pressing the *[Add]* button from the menu bar. +####An Example ![Timer add example](docresources/dvrtimeradd.png) @@ -30,20 +20,11 @@ Note that when you create a rule/entry it will also generate a [DVR Entry](class --- -###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. +inc/edit_grid_entries --- -###Deleting an Entry - -Highlight (select) the desired entry within the grid, then click the *[Delete]* -button from the menu bar. +inc/del_grid_entries --- + diff --git a/docs/class/ipblocking.md b/docs/class/ipblocking.md index 15d2f1de5..aee13ecb7 100644 --- a/docs/class/ipblocking.md +++ b/docs/class/ipblocking.md @@ -5,7 +5,9 @@ are not allowed to login (use any Tvheadend service). --- -inc/buttons1 +inc/common_button_table_start + +inc/common_button_table_end --- diff --git a/docs/class/linuxdvb_frontend_dvbc.md b/docs/class/linuxdvb_frontend_dvbc.md index 228c36af8..19bfe54be 100644 --- 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. +inc/common_button_table_end --- diff --git a/docs/class/linuxdvb_frontend_dvbs.md b/docs/class/linuxdvb_frontend_dvbs.md index 2647493f3..d773785b7 100644 --- 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. +inc/common_button_table_end --- diff --git a/docs/class/linuxdvb_satconf.md b/docs/class/linuxdvb_satconf.md index 90e2cdab8..d49ec89cc 100644 --- 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. +inc/common_button_table_end --- diff --git a/docs/docresources/dvrautorecentries.png b/docs/docresources/dvrautorecentries.png index c85127250..833437235 100644 Binary files a/docs/docresources/dvrautorecentries.png and b/docs/docresources/dvrautorecentries.png differ diff --git a/docs/docresources/timers.png b/docs/docresources/timers.png new file mode 100644 index 000000000..e7aeb63b6 Binary files /dev/null and b/docs/docresources/timers.png differ diff --git a/docs/markdown/inc/common_button_table_end.md b/docs/markdown/inc/common_button_table_end.md new file mode 100644 index 000000000..4416c0f15 --- /dev/null +++ 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 b/docs/markdown/inc/common_button_table_start.md similarity index 60% rename from docs/markdown/inc/buttons1.md rename to docs/markdown/inc/common_button_table_start.md index 4413507b3..60ba8241c 100644 --- a/docs/markdown/inc/buttons1.md +++ b/docs/markdown/inc/common_button_table_start.md @@ -1,6 +1,6 @@ ###Menu Bar/Buttons -The tab has the following buttons: +The following functions are available: Button | Function -----------------------|------------------- @@ -8,6 +8,4 @@ Button | Function **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 index 723dcfcdc..5495e810e 100644 --- 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. +inc/common_button_table_end --- diff --git a/src/dvr/dvr_autorec.c b/src/dvr/dvr_autorec.c index dc592fad6..d0a28e601 100644 --- 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,