Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: Partially revert dc10c4614e3eb68dd86081f76ba17def06ba291c - r…
…ather than use an include for dvr, change the dvr_entry_class caption instead.
  • Loading branch information
Mark Clarkstone authored and perexg committed Nov 10, 2016
1 parent a33b768 commit c365cdf
Show file tree
Hide file tree
Showing 4 changed files with 153 additions and 154 deletions.
149 changes: 148 additions & 1 deletion docs/class/dvrentry.md
@@ -1 +1,148 @@
<tvh_include>inc/dvr</tvh_include>
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.
<tvh_include>inc/common_button_table_end</tvh_include>

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

---
<tvh_include>inc/add_grid_entry</tvh_include>

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.

---

<tvh_include>inc/edit_grid_entries</tvh_include>

---

<tvh_include>inc/del_grid_entries</tvh_include>

---

<tvh_include>inc/play</tvh_include>

---

###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.

---
148 changes: 0 additions & 148 deletions docs/markdown/inc/dvr.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/markdown/toc.md
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion src/dvr/dvr_db.c
Expand Up @@ -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,
Expand Down

0 comments on commit c365cdf

Please sign in to comment.