From: Mark Clarkstone Date: Tue, 12 Apr 2016 00:16:24 +0000 (+0100) Subject: mdhelp: I've come to realise that it makes more sense to keep all markdown for the... X-Git-Tag: v4.2.1~664 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4d666deb67a9b1ae017c8a6695e7571aa6d2cba3;p=thirdparty%2Ftvheadend.git mdhelp: I've come to realise that it makes more sense to keep all markdown for the DVR tabs in one central location (dvrentry) rather than separate pages. --- diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index f02150ffc..a470ccb7a 100644 --- a/docs/class/dvrentry.md +++ b/docs/class/dvrentry.md @@ -1,17 +1,164 @@ -DVR entries are used by Tvheadend to keep track of upcoming, finished +DVR entries are used by Tvheadend to keep track of upcoming/current, finished and failed recordings. !['Digital Video Recorder' Tabs](docresources/configdvrtabs4.png) - * Upcoming and currently recording entries remain in the [Upcoming/Current Recordings](dvr_upcoming) tab. - - * When a recording completes successfully the entry is moved to the [Finished Recordings](dvr_finished) tab. - - * When a recording fails or gets aborted the entry is moved to the [Failed Recordings](dvr_failed) tab. - + * 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. -Some entry details are not available/incomplete until the recording -completes or fails, e.g. filesize, total data errors, etc. +**Some entry details are not available/incomplete until the recording +completes or fails, e.g. filesize, total data errors, etc.** + +--- + +##Upcoming/Current Recordings + +This tab shows your all upcoming/current recording entries. + +!['Upcoming/Current Recordings' Tab](docresources/upcomingrecordings1.png) + +###Adding and Editing an Entry + +####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. + + +####Adding a Timer Event + +You can set time-based entries using the [Timer](class/dvrtimerec) tab. + + +####Manual Event Entry/Editing an Entry + +To add an entry press the *[Add]* button from the menu bar. To edit an +entry highlight the desired entry within the grid and +then press the *[Edit]* button. + +A common set of fields is used for the _Add_ or _Edit_ dialogs, most +of which can also be seen in the grid view: + +![Add/Edit Upcoming Recording](docresources/upcomingrecordings3.png) + +**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. + + +###Deleting an Entry/Stopping an In-progress Recording + +You can delete, stop or abort an upcoming (or an already in-progress) recording by pressing +the *[Delete]*, *[Stop]* or *[Abort]* button from the menu bar. + +* The *[Delete]* button completely removes the event and any associated file(s). +* The *[Stop]* button gracefully stops an in-progress recording and moves it to the Finished Recordings tab. +* The *[Abort]* button stops an already in-progress recording, moves the entry to the Failed Recordings and marks it as *Aborted by user*. Note that this does not remove the (partial) recording file from disk. + +Note that only in-progress recording can be stopped or aborted. + +**Deleting an entry can't be undone, you will be prompted for confirmation.** + +--- + +##DVR - Finished Recordings + +This tab shows all your finished recording entries. + +!['Finished Recordings' Tab](docresources/finishedrecordings1.png) + +###Playing a Recording + +You can play a recording by clicking the *Play* link, +note that these links do not link to an actual file but to a playlist. +This will automatically launch an appropriate player, otherwise you will +need to manually open the playlist to start watching (normally a +double-click on the downloaded file). + +###Downloading a Recording + +Highlight (select) the desired entry then press the *[Download]* button on the +menu bar. + +###Editing an Entry + +You can edit an entry by clicking the *[Edit]* button on the menu bar, +note that not all fields can be edited. + +###Deleting an Entry + +Highlight (select) the desired entry(s) then press the *[Delete]* button on the +menu bar. + +**Deleting can't be undone. You +will be prompted to confirm deletion.** + +**Tip**: You can highlight multiple entries by holding ctrl or shift +(to select a range) while clicking. + + + +--- + +##DVR - 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. + +###Playing a Failed Recording + +You can play a partial recording by clicking the *Play* link, +note that these links do not link to an actual file but to a playlist. +This will automatically launch an appropriate player, otherwise you will +need to manually open the playlist to start watching (normally a +double-click on the downloaded file). + +###Downloading a Recording + +Highlight (select) the desired entry then press the *[Download]* button on the menu bar. + +###Re-recording an Entry/Re-schedule a Failed 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. + +###Moving an Entry + +Failed recordings can be moved to the Finished Recordings tab by +highlighting (selecting) the desired entry and then pressing the *[Move to finished]* +button from the menu bar. + +###Deleting an Entry + +Highlight (select) the desired entry(s) then press the *[Delete]* button on the menu bar. + +**Deleting can't be undone. You will be prompted to confirm deletion.** + +**Tip**: You can highlight multiple entries by holding ctrl or shift +(to select a range) while clicking. --- diff --git a/docs/docresources/dvrautorecadd.png b/docs/docresources/dvrautorecadd.png new file mode 100644 index 000000000..0139162c9 Binary files /dev/null and b/docs/docresources/dvrautorecadd.png differ diff --git a/docs/docresources/dvrtimeradd.png b/docs/docresources/dvrtimeradd.png new file mode 100644 index 000000000..7bb223139 Binary files /dev/null and b/docs/docresources/dvrtimeradd.png differ diff --git a/docs/markdown/dvr_failed.md b/docs/markdown/dvr_failed.md deleted file mode 100644 index 204914d48..000000000 --- a/docs/markdown/dvr_failed.md +++ /dev/null @@ -1,47 +0,0 @@ -##DVR - Failed Recordings - -This tab shows all failed recording entries. - -!['Failed Recordings' Tab](docresources/failedrecordings1.png) - -The *Status* column indicates why a recording failed. -See the status item on the [DVR Entries](class/dvrentry) page for more -information. - ---- - -###Playing a Failed Recording - -You can play a partial recording by clicking the *Play* link, -note that these links do not link to an actual file but to a playlist. - -This will automatically launch an appropriate player, otherwise you will -need to manually open the playlist to start watching (normally a -double-click on the downloaded file). - -###Downloading a Recording - -Highlight the desired entry then press the *[Download]* button on the menu bar. - -###Re-recording an Entry/Re-schedule a Failed 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. - -###Moving an Entry - -Failed recordings can be moved to the [Finished Recordings](dvr_finished) -tab by highlighting the desired entry and then pressing the *[Move to finished]* -button from the menu bar. - -###Deleting an Entry - -Highlight the desired entry(s) then press the *[Delete]* button on the menu bar. - -**Deleting can't be undone. You will be prompted to confirm deletion.** - -**Tip**: You can highlight multiple entries by holding ctrl or shift -(to select a range) while clicking. - diff --git a/docs/markdown/dvr_finished.md b/docs/markdown/dvr_finished.md deleted file mode 100644 index dc32e90df..000000000 --- a/docs/markdown/dvr_finished.md +++ /dev/null @@ -1,39 +0,0 @@ -##DVR - Finished Recordings - -This tab shows all your finished recording entries. - -!['Finished Recordings' Tab](docresources/finishedrecordings1.png) - ---- - -###Playing a Recording - -You can play a recording by clicking the *Play* link, -note that these links do not link to an actual file but to a playlist. - -This will automatically launch an appropriate player, otherwise you will -need to manually open the playlist to start watching (normally a -double-click on the downloaded file). - -###Downloading a Recording - -Highlight the desired entry then press the *[Download]* button on the -menu bar. - -###Editing an Entry - -You can edit an entry by clicking the *[Edit]* button on the menu bar, -note that not all [Entry](class/dvrentry) fields can be edited. - -###Deleting an Entry - -Highlight the desired entry(s) then press the *[Delete]* button on the -menu bar. - -**Deleting can't be undone. You -will be prompted to confirm deletion.** - -**Tip**: You can highlight multiple entries by holding ctrl or shift -(to select a range) while clicking. - - diff --git a/docs/markdown/dvr_upcoming.md b/docs/markdown/dvr_upcoming.md deleted file mode 100644 index cf8ff7af2..000000000 --- a/docs/markdown/dvr_upcoming.md +++ /dev/null @@ -1,66 +0,0 @@ -##DVR - Upcoming/Current Recordings - -This tab shows your all upcoming/current recording entries. - -!['Upcoming/Current Recordings' Tab](docresources/upcomingrecordings1.png) - ---- - -###Adding and Editing an Entry - -####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. - -####Adding a Timer Event - -You can set time-based entries using the [Timer](class/dvrtimerec) tab. - -####Manual Event Entry/Editing an Entry - -To add an entry press the *[Add]* button from the menu bar. To edit an -entry highlight the desired entry within the grid and -then press the *[Edit]* button. - -A common set of fields is used for the _Add_ or _Edit_ dialogs, most -of which can also be seen in the grid view: - -![Add/Edit Upcoming Recording](docresources/upcomingrecordings3.png) - -See the [DVR Entries](class/dvrentry) page for a more detailed look at -the various entry options. - -**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. - -###Deleting an Entry/Stopping an In-progress Recording - -You can delete, stop or abort an upcoming (or an already in-progress) recording by pressing -the *[Delete]*, *[Stop]* or *[Abort]* button from the menu bar. - -* The *[Delete]* button completely removes the event and any associated file(s). -* The *[Stop]* button gracefully stops an in-progress recording and moves it to the [Finished Recordings](dvr_finished) tab. -* The *[Abort]* button stops an already in-progress recording, moves the entry to the [Failed Recordings](dvr_failed) and marks it as *Aborted by user*. Note that this does not remove the (partial) recording file from disk. - -Note that only in-progress recording can be stopped or aborted. - -**Deleting an entry can't be undone, you will be prompted for confirmation.** diff --git a/docs/markdown/toc.md b/docs/markdown/toc.md index ded371755..b3a747b71 100644 --- a/docs/markdown/toc.md +++ b/docs/markdown/toc.md @@ -23,9 +23,9 @@ Web Interface Guide * Digital Video Recorder - [DVR Entries](class/dvrentry) - - [Upcoming/Current Recordings](dvr_upcoming) - - [Finished Recordings](dvr_finished) - - [Failed Recordings](dvr_failed) + - [Upcoming/Current Recordings](class/dvrentry) + - [Finished Recordings](class/dvrentry) + - [Failed Recordings](class/dvrentry) - [Auto-recording (Autorecs)](class/dvrautorec) - [Time-based Recording (Timers)](class/dvrtimerec)