From: Mark Clarkstone Date: Thu, 13 Oct 2016 18:47:41 +0000 (+0100) Subject: mdhelp: Partially revert dc10c4614e3eb68dd86081f76ba17def06ba291c - rather than use... X-Git-Tag: v4.2.1~228 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c365cdf43bcb1f230a4f3146d9325624cb7ec8ea;p=thirdparty%2Ftvheadend.git mdhelp: Partially revert dc10c4614e3eb68dd86081f76ba17def06ba291c - rather than use an include for dvr, change the dvr_entry_class caption instead. --- diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index c5d1743d6..ad8eb7a11 100644 --- a/docs/class/dvrentry.md +++ b/docs/class/dvrentry.md @@ -1 +1,148 @@ -inc/dvr +This tab is where you manage your recordings. Each entry is moved +between the *Upcoming / Current Recordings*, *Finished Recordings* and +*Failed Recordings* sub-tabs depending on its status. + +**Upcoming / Current Recordings** +: This sub-tab lists current and upcoming recording entries. Entries +shown here are either currently recording or are soon-to-be recorded. + +**Finished Recordings** +: This sub-tab lists all completed recording entries. Entries shown +here have reached the end of the scheduled (or EITp/f defined) +recording time. + +**Failed Recordings** +: This sub-tab lists all failed recording entries. Entries shown here +have failed to record due to one (or more) errors that occurred during +the recording. + +**Removed Recordings** +: This sub-tab lists all recording entries that have missing file(s). +Entries shown here link to file(s) that Tvheadend cannot locate +(files which have been externally removed). + +!['Digital Video Recorder' Tabs](static/img/doc/configdvrtabs4.png) + +--- + +###Menu Bar/Buttons + +The following functions are available in all tabs: + +Button | Function +-----------------------------|--------- +**Delete** | Delete the selected grid entries. +**Edit** | Edit the selected grid entries. +inc/common_button_table_end + +The following functions are only available in the +**Upcoming/Current Recordings** tab. + +Button | Function +-----------------------------|--------- +**Add** | Add a new (one-time-only) recording entry. +**Save** | Save changes made to the grid entries. +**Undo** | Revert all changes made to the grid entries since the last save. +**Stop** | Gracefully stop the selected in-progress recording entries. +**Abort** | Abruptly stop the selected in-progress recording entries. + +The following functions are only available in the **Finished Recordings** +and **Failed Recordings** tabs: + +Button | Function +-----------------------------|--------- +**Download** | Download the recording. +**Re-record** | Re-schedule the selected entry/recording if possible. + +The following functions are only available in the **Finished Recordings** +tab. + +Button | Function +-----------------------------|--------- +**Move to failed** | Move the selected recording entries to the **Failed Recordings** tab. + +The following functions are only available in the **Failed Recordings** +tab. + +Button | Function +-----------------------------|--------- +**Move to finished** | Move the selected recording entries to the *Finished Recordings* tab. + +--- + +###Entry Overview + +The *Details* column gives a quick overview as to the status of each +entry: + +Icon | Description +-------------------------------------------|------------- +![Clock icon](icons/scheduled.png) | the program is scheduled (upcoming) +![Recording icon](icons/rec.png) | recording of the program is active and underway (current) +![Information icon](icons/information.png) | click to display detailed information about the selected recording +![Exclamation icon](icons/exclamation.png) | the program failed to record +![Accept icon](icons/accept.png) | the program recorded successfully + +--- +inc/add_grid_entry + +Note that the *[Add]* functionality is only available in +the *Upcoming/Current Recordings* tab. + +####Manual Recording Entry Example + +This is an example of a one-time recording entry. + +!['Add new recording dialog'](static/img/doc/addnewrecentry.png) + +####Adding an Entry Using the EPG + +Using the Electronic Program Guide search functionality, find the +program/event you would like to record. Click on it, then using the broadcast +details dialog you can: + +* Record the event once by pressing the *[Record program]* button. +* Automatically record all upcoming events matching the program's title by pressing the *[Autorec]* button. +* Record all upcoming series episodes by pressing the *[Record series]* button. **This replaces the *[Autorec]* button when series link information is available.** + +For full instructions on how to search and record using the EPG take a +look at the [EPG](epg) page. + +####Adding an Entry Using Autorec Rules + +Autorec rules allow you to match events using various options. + +* Record events using regular expressions, they can be as simple or as powerful as you like. +* Record events that broadcast between certain times or days of the week. + +See [Autorec](class/dvrautorec) for more information. + +--- + +inc/edit_grid_entries + +--- + +inc/del_grid_entries + +--- + +inc/play + +--- + +###Downloading a Recording + +Highlight (select) the desired entry, then press the *[Download]* +button on the menu bar. + +--- + +###Re-recording an Entry/Re-schedule a Recording + +You can re-schedule an entry by pressing the *[Re-record]* button on the menu bar. + +**Note**: Your EPG data must have another matching event to be able to re-schedule +the entry. + +--- diff --git a/docs/markdown/inc/dvr.md b/docs/markdown/inc/dvr.md deleted file mode 100644 index ad8eb7a11..000000000 --- a/docs/markdown/inc/dvr.md +++ /dev/null @@ -1,148 +0,0 @@ -This tab is where you manage your recordings. Each entry is moved -between the *Upcoming / Current Recordings*, *Finished Recordings* and -*Failed Recordings* sub-tabs depending on its status. - -**Upcoming / Current Recordings** -: This sub-tab lists current and upcoming recording entries. Entries -shown here are either currently recording or are soon-to-be recorded. - -**Finished Recordings** -: This sub-tab lists all completed recording entries. Entries shown -here have reached the end of the scheduled (or EITp/f defined) -recording time. - -**Failed Recordings** -: This sub-tab lists all failed recording entries. Entries shown here -have failed to record due to one (or more) errors that occurred during -the recording. - -**Removed Recordings** -: This sub-tab lists all recording entries that have missing file(s). -Entries shown here link to file(s) that Tvheadend cannot locate -(files which have been externally removed). - -!['Digital Video Recorder' Tabs](static/img/doc/configdvrtabs4.png) - ---- - -###Menu Bar/Buttons - -The following functions are available in all tabs: - -Button | Function ------------------------------|--------- -**Delete** | Delete the selected grid entries. -**Edit** | Edit the selected grid entries. -inc/common_button_table_end - -The following functions are only available in the -**Upcoming/Current Recordings** tab. - -Button | Function ------------------------------|--------- -**Add** | Add a new (one-time-only) recording entry. -**Save** | Save changes made to the grid entries. -**Undo** | Revert all changes made to the grid entries since the last save. -**Stop** | Gracefully stop the selected in-progress recording entries. -**Abort** | Abruptly stop the selected in-progress recording entries. - -The following functions are only available in the **Finished Recordings** -and **Failed Recordings** tabs: - -Button | Function ------------------------------|--------- -**Download** | Download the recording. -**Re-record** | Re-schedule the selected entry/recording if possible. - -The following functions are only available in the **Finished Recordings** -tab. - -Button | Function ------------------------------|--------- -**Move to failed** | Move the selected recording entries to the **Failed Recordings** tab. - -The following functions are only available in the **Failed Recordings** -tab. - -Button | Function ------------------------------|--------- -**Move to finished** | Move the selected recording entries to the *Finished Recordings* tab. - ---- - -###Entry Overview - -The *Details* column gives a quick overview as to the status of each -entry: - -Icon | Description --------------------------------------------|------------- -![Clock icon](icons/scheduled.png) | the program is scheduled (upcoming) -![Recording icon](icons/rec.png) | recording of the program is active and underway (current) -![Information icon](icons/information.png) | click to display detailed information about the selected recording -![Exclamation icon](icons/exclamation.png) | the program failed to record -![Accept icon](icons/accept.png) | the program recorded successfully - ---- -inc/add_grid_entry - -Note that the *[Add]* functionality is only available in -the *Upcoming/Current Recordings* tab. - -####Manual Recording Entry Example - -This is an example of a one-time recording entry. - -!['Add new recording dialog'](static/img/doc/addnewrecentry.png) - -####Adding an Entry Using the EPG - -Using the Electronic Program Guide search functionality, find the -program/event you would like to record. Click on it, then using the broadcast -details dialog you can: - -* Record the event once by pressing the *[Record program]* button. -* Automatically record all upcoming events matching the program's title by pressing the *[Autorec]* button. -* Record all upcoming series episodes by pressing the *[Record series]* button. **This replaces the *[Autorec]* button when series link information is available.** - -For full instructions on how to search and record using the EPG take a -look at the [EPG](epg) page. - -####Adding an Entry Using Autorec Rules - -Autorec rules allow you to match events using various options. - -* Record events using regular expressions, they can be as simple or as powerful as you like. -* Record events that broadcast between certain times or days of the week. - -See [Autorec](class/dvrautorec) for more information. - ---- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries - ---- - -inc/play - ---- - -###Downloading a Recording - -Highlight (select) the desired entry, then press the *[Download]* -button on the menu bar. - ---- - -###Re-recording an Entry/Re-schedule a Recording - -You can re-schedule an entry by pressing the *[Re-record]* button on the menu bar. - -**Note**: Your EPG data must have another matching event to be able to re-schedule -the entry. - ---- diff --git a/docs/markdown/toc.md b/docs/markdown/toc.md index e9964219f..d08984408 100644 --- a/docs/markdown/toc.md +++ b/docs/markdown/toc.md @@ -19,10 +19,10 @@ Web Interface Guide * Digital Video Recorder - - [Upcoming / Current Recordings](dvr) - - [Finished Recordings](dvr) - - [Failed Recordings](dvr) - - [Removed Recordings](dvr) + - [Upcoming / Current Recordings](class/dvrentry) + - [Finished Recordings](class/dvrentry) + - [Failed Recordings](class/dvrentry) + - [Removed Recordings](class/dvrentry) - [Auto-recording (Autorecs)](class/dvrautorec) - [Time-based Recording (Timers)](class/dvrtimerec) diff --git a/src/dvr/dvr_db.c b/src/dvr/dvr_db.c index 6607d4c60..9465101bf 100644 --- a/src/dvr/dvr_db.c +++ b/src/dvr/dvr_db.c @@ -2922,7 +2922,7 @@ PROP_DOC(dvr_stop_extra) const idclass_t dvr_entry_class = { .ic_class = "dvrentry", - .ic_caption = N_("DVR Entries"), + .ic_caption = N_("Digital Video Recorder"), .ic_event = "dvrentry", .ic_doc = tvh_doc_dvrentry_class, .ic_changed = dvr_entry_class_changed,