From: Mark Clarkstone Date: Sat, 24 Sep 2016 07:33:11 +0000 (+0100) Subject: mdhelp: clean-up toc a little & use an include for dvrentry X-Git-Tag: v4.2.1~235 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6ce89220e6f73f65a45b45bfcec6e3b5081d4879;p=thirdparty%2Ftvheadend.git mdhelp: clean-up toc a little & use an include for dvrentry --- diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index 30dd4c1c2..c5d1743d6 100644 --- a/docs/class/dvrentry.md +++ b/docs/class/dvrentry.md @@ -1,142 +1 @@ -DVR entries are how Tvheadend manages upcoming/current, finished and -failed recordings. - -!['Digital Video Recorder' Tabs](static/img/doc/configdvrtabs4.png) - -Each entry is moved between the tabs depending on its state: - -* Upcoming and currently recording entries remain in -the *Upcoming/Current Recordings* tab. -* When a recording completes successfully the entry is moved -(from *Upcoming/Current Recordings*) to the *Finished Recordings* tab. -* When a recording fails (or is aborted) the entry is moved -(from *Upcoming/Current Recordings*) to the *Failed Recordings* tab. - -Please note that the grid in each tab may have different columns and -not all entry information is available until it completes or fails, -e.g filesize, total data errors, etc. - ---- - -###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. - ---- +inc/dvr diff --git a/docs/markdown/dvr.md b/docs/markdown/dvr.md new file mode 100644 index 000000000..4a0b5ac61 --- /dev/null +++ b/docs/markdown/dvr.md @@ -0,0 +1,5 @@ +##Digital Video Recorder + +inc/dvr + +dvrentry diff --git a/docs/markdown/inc/dvr.md b/docs/markdown/inc/dvr.md new file mode 100644 index 000000000..1f934b879 --- /dev/null +++ b/docs/markdown/inc/dvr.md @@ -0,0 +1,146 @@ +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. + +!['Digital Video Recorder' Tabs](static/img/doc/configdvrtabs4.png) + +####Upcoming / Current Recordings + +This sub-tab lists current and upcoming recording entries. Entries +that appear here are either currently recording or are soon-to-be +recorded. + +####Finished Recordings + +This sub-tab lists all completed recording entries. Entries that appear +here have reached the end of the scheduled recording time. + +####Failed Recordings + +This sub-tab lists all failed recording entries. Entries that appear +here have failed to record due to one (or more) errors that occurred +during the recording. + +--- + +###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 070238ed1..24a9dc703 100644 --- a/docs/markdown/toc.md +++ b/docs/markdown/toc.md @@ -15,26 +15,23 @@ Web Interface Guide * [General](webui_general) -* Electronic Program Guide - - - [EPG Grid](epg) +* [Electronic Program Guide](epg) * Digital Video Recorder - - [DVR Entries](class/dvrentry) - - [Upcoming/Current Recordings](class/dvrentry) - - [Finished Recordings](class/dvrentry) - - [Failed Recordings](class/dvrentry) + - [Upcoming / Current Recordings](dvr) + - [Finished Recordings](dvr) + - [Failed Recordings](dvr) - [Auto-recording (Autorecs)](class/dvrautorec) - [Time-based Recording (Timers)](class/dvrtimerec) -Web Interface Configuration Guide +Configuration Guide * General - - [Base Config](class/config) - - [Image Cache Config](class/imagecache) - - [SAT>IP Server Config](class/satip_server) + - [Base](class/config) + - [Image Cache](class/imagecache) + - [SAT>IP Server](class/satip_server) * Access Configuration (Users)