From: Mark Clarkstone Date: Fri, 15 Apr 2016 10:34:33 +0000 (+0100) Subject: mdhelp: add button info tables to the various dvr docs and some general clean-up... X-Git-Tag: v4.2.1~644 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b83b931982a1a3812dfc1b7c8a0d0fc73208256c;p=thirdparty%2Ftvheadend.git mdhelp: add button info tables to the various dvr docs and some general clean-up. mdhelp: add channelname_scheme property doc --- diff --git a/docs/class/dvrautorec.md b/docs/class/dvrautorec.md index a61e6ceef..ff9fa5961 100644 --- a/docs/class/dvrautorec.md +++ b/docs/class/dvrautorec.md @@ -4,6 +4,18 @@ This tab controls EPG-driven recording rules. --- +###Buttons + +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. + ###Adding an Entry/Rule You can add an entry by pressing the *[Add]* button from the menu bar. diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index a470ccb7a..68af34093 100644 --- a/docs/class/dvrentry.md +++ b/docs/class/dvrentry.md @@ -3,9 +3,9 @@ and failed recordings. !['Digital Video Recorder' Tabs](docresources/configdvrtabs4.png) - * Upcoming and currently recording entries remain in the *Upcoming/Current Recordings* tab. - * When a recording completes successfully the entry is moved to the *Finished Recordings* tab. - * When a recording fails or gets aborted the entry is moved to the *Failed Recordings* tab. + * Upcoming and currently recording entries remain in the *[Upcoming/Current Recordings](#upcoming-current-recordings)* tab. + * When a recording completes successfully the entry is moved to the *[Finished Recordings](#finished-recordings)* tab. + * When a recording fails or gets aborted the entry is moved to the *[Failed Recordings](#failed-recordings)* tab. **Some entry details are not available/incomplete until the recording completes or fails, e.g. filesize, total data errors, etc.** @@ -18,6 +18,21 @@ This tab shows your all upcoming/current recording entries. !['Upcoming/Current Recordings' Tab](docresources/upcomingrecordings1.png) +###Buttons + +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 Entry* dialog. +**Delete** | Delete the selected entry/entries. +**Edit** | Edit the selected entry. +**Stop** | Gracefully stop the selected (in-progress) recording/entry. +**Abort** | Stop the selected (in-progress) recording/entry. +**Help** | Display this help page. + ###Adding and Editing an Entry ####Adding an Entry Using the EPG @@ -79,12 +94,25 @@ Note that only in-progress recording can be stopped or aborted. --- -##DVR - Finished Recordings +##Finished Recordings This tab shows all your finished recording entries. !['Finished Recordings' Tab](docresources/finishedrecordings1.png) +###Buttons + +The tab has the following buttons: + +Button | Function +-----------------------|------------------- +**Delete** | Delete the selected entry/recording. +**Edit** | Edit the selected entry/recording. +**Download** | Download the selected entry/recording. +**Re-record** | Re-schedule the selected entry/recording if possible. +**Move to failed** | Move the selected entry/entries to the *Failed Recordings* tab. +**Help** | Display this help page. + ###Playing a Recording You can play a recording by clicking the *Play* link, @@ -118,13 +146,24 @@ will be prompted to confirm deletion.** --- -##DVR - Failed Recordings +##Failed Recordings This tab shows all failed recording entries. !['Failed Recordings' Tab](docresources/failedrecordings1.png) -The *Status* column gives the reason why a recording failed. +###Buttons + +The tab has the following buttons: + +Button | Function +-----------------------|------------------- +**Delete** | Delete the selected entry/recording. +**Edit** | Edit the selected entry/recording. +**Download** | Download the selected entry/recording. +**Re-record** | Re-schedule the selected entry/recording if possible. +**Move to finished** | Move the selected entry/entries to the *Finished Recordings* tab. +**Help** | Display this help page. ###Playing a Failed Recording diff --git a/docs/class/dvrtimerec.md b/docs/class/dvrtimerec.md index 23309ed3f..24b2c4edb 100644 --- a/docs/class/dvrtimerec.md +++ b/docs/class/dvrtimerec.md @@ -4,6 +4,18 @@ This tab controls timer-driven recording rules. --- +###Buttons + +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. + ###Adding an Entry You can add an entry by pressing the *[Add]* button from the menu bar. diff --git a/docs/property/config_channelname_scheme.md b/docs/property/config_channelname_scheme.md index 2e3b01b0d..be49da5e5 100644 --- a/docs/property/config_channelname_scheme.md +++ b/docs/property/config_channelname_scheme.md @@ -1,26 +1,13 @@ : -Note that you must correctly set the *channel icon path* (above) for -this option to take effect/be able to generate icon filenames. You may -need to use the *[Reset Icon]* button in -*Configuration -> Channel / EPG -> Channels* to trigger filename -(re-)generation. +You must correctly set the *Channel icon path* (above) to be able to generate icon +filenames. Note that changing this option **won't** automatically (re-)generate +icon filenames. You must manually (re-)generate them using the +*[Reset Icons]* button in the *Configuration -> Channel / EPG -> Channels* +tab. Scheme | Description -----------------------|------------------- -No Scheme | Use service name "as is" to generate the filename. -All lower-case | Generate lower-case filenames. +No scheme | Use service name "as is" to generate the filename - spaces are replaced with underscores `_` and non-alphanumeric characters are URL encoded. +All lower-case | Generate lower-case filenames - spaces are replaced with underscores `_` and non-alphanumeric characters are URL encoded. Service name picons | Generate lower-case filenames using picon formatting. - -When using *No Scheme* or *All lower-case* spaces are replaced with -underscores `_` and non-alphanumeric characters are URL encoded. - -When using the *service name picon scheme* certain characters will be -replaced and non-alphanumeric characters removed. - -Character | Replacement String ------------------------|---------------------- -`*` | star -`+` | plus -` ` (space) | None (it's removed.) -