From: Mark Clarkstone Date: Wed, 6 Apr 2016 19:31:38 +0000 (+0100) Subject: Various changes.. X-Git-Tag: v4.2.1~707 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=954ac7a330c3152a64532cab3b6a35c8c5c40510;p=thirdparty%2Ftvheadend.git Various changes.. mdhelp: add images for upcomingrecordings - these can be updated later mdhelp: add dvr_upcoming.md doc mdhelp: update toc - add dvrentry and update the links mdhelp: fix a few mistakes in features.md mdhelp: add webui_general.md css: make links to other pages actually look like links --- diff --git a/docs/docresources/upcomingrecordings1.png b/docs/docresources/upcomingrecordings1.png index b814cd776..caccb0d26 100644 Binary files a/docs/docresources/upcomingrecordings1.png and b/docs/docresources/upcomingrecordings1.png differ diff --git a/docs/docresources/upcomingrecordings2.png b/docs/docresources/upcomingrecordings2.png index 3256b0652..ceaab3ff2 100644 Binary files a/docs/docresources/upcomingrecordings2.png and b/docs/docresources/upcomingrecordings2.png differ diff --git a/docs/docresources/upcomingrecordings3.png b/docs/docresources/upcomingrecordings3.png new file mode 100644 index 000000000..655a2837f Binary files /dev/null and b/docs/docresources/upcomingrecordings3.png differ diff --git a/docs/markdown/dvr_upcoming.md b/docs/markdown/dvr_upcoming.md new file mode 100644 index 000000000..811168724 --- /dev/null +++ b/docs/markdown/dvr_upcoming.md @@ -0,0 +1,57 @@ +##Digital Video Recorder - Upcoming/Current Recordings + +This tab shows your all upcoming/current recordings. + +!['Upcoming/Current Recordings' Tab](docresources/upcomingrecordings1.png) + +### Items + +**Details** +: Shows the status of the recording event: + +Icon | Description +-------------------------------------------|------------- +![Clock icon](icons/clock.png) | the program is scheduled (upcoming) +![Recording icon](icons/rec.png) | the program is active and underway (current) +![Information icon](icons/information.png) | click to display detailed information about the selected recording (upcoming or current) + +Please see the [DVR Entry](class/dvrentry) page for a more detailed look at +the various entry options. + +###1. Adding an Entry/Adding a New Recording + +You can add an entry by: + +####1.1. Using the EPG + +Using the Electronic Program Guide search functionality, find the +program/event you would like to record. For full instructions on how to +search the EPG, take a look at the [EPG](epg) page. + +Once you've found the program you'd like to record, click on it, then +using the resultant dialog you can: + +* Record it 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.** + +**Tip**: You can quickly find all matching programs by clicking on the title. + +####1.2. 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. + +Please see [Autorec](dvr_autorec) for more information. + +###1.3. Manual Event Entry/Editing an Entry + +A common set of fields is used for the _Add_ or _Edit_ functions, most +of which can also be seen in the grid view: + +![Add/Edit Upcoming Recording](docresources/upcomingrecordings3.png) + +See the [DVR Entry](class/dvrentry) page for a more detailed look at +the various entry options. diff --git a/docs/markdown/features.md b/docs/markdown/features.md index fdacfadc4..70a698915 100644 --- a/docs/markdown/features.md +++ b/docs/markdown/features.md @@ -63,7 +63,7 @@ be configured based on username/password and/or IP address. ####Fully-Integrated with Mainstream Media Players * Movian and Kodi are the main targets. -* All channel data, channel groups/tages, EPG and TV streaming is carried over a single TCP connection. +* All channel data, channel groups/tags, EPG and TV streaming is carried over a single TCP connection. ####Mobile/Remote Client Support * As well as the web interface, which is accessible through VPN if required, diff --git a/docs/markdown/toc.md b/docs/markdown/toc.md index a22c6f306..5f4959111 100644 --- a/docs/markdown/toc.md +++ b/docs/markdown/toc.md @@ -20,13 +20,14 @@ Web Interface Guide - [EPG Grid](epg) -* DVR +* Digital Video Recorder - - [Upcoming/Current Recordings](class/dvrentry) + - [Upcoming/Current Recordings](dvr_upcoming) - [Finished Recordings](class/dvrentry) - [Failed Recordings](class/dvrentry) - [DVR AutoRec Entries](class/dvrautorec) - [Time Schedules (TimeRec)](class/dvrtimerec) + - [DVR Entry](class/dvrentry) Web Interface Configuration Guide diff --git a/docs/markdown/webui_general.md b/docs/markdown/webui_general.md new file mode 100644 index 000000000..9824a3e76 --- /dev/null +++ b/docs/markdown/webui_general.md @@ -0,0 +1,64 @@ +##General Overview of Web Interface + +Tvheadend is operated primarily through a tabbed web interface. + +There are some basic navigation concepts that will help you get around and +make the best of it. + +####Page Structure + +The interface is made up of nested tabs, so similar functions are grouped +together (e.g. all configuration items at the top level, then all configuration +items for a particular topic are below that). + +Each tab is then typically laid out with a menu bar across the top that +provides access to Add/Save/Edit-type functions, and a grid like a spreadsheet +below that. The grid items are frequently editable. + +Most configuration items - certainly the ones that are common to all types +of item covered by that tab - are in this grid. However, some item-specific +configuration items are then only available through the *Add* and *Edit* +dialog boxes. For example, the main network configuration tab grid covers +parameters common to DVB-S, -T, -C and IPTV networks, but specific things +such as FEC rolloff or mux URL are then only in the dialogs for networks +that need these values. + +####Displaying and Manipulating Columns + +* Not all columns are necessarily visible. If you hover your mouse over a + column heading, you'll see a down arrow - click here, and a drop-down menu + will appear to give you access to **which columns are shown and which are not**. + +* The same drop-down menu gives you access to a **sort** function if defined + (it doesn't always make sense to have a sortable column for some parameters). + You can also sort a column by simply clicking on the column header; reverse + the sort order by clicking again. + +* And the same drop-down menu also gives you access to a **filter** function + if defined. The filter does simple pattern-matching on any string you + provide. + +* **Re-arrange** the columns by simply dragging he header to a new spot. + +* **Re-size** the columns by dragging the very edges of the column header as + required. + +####Editing Fields + +* To edit a cell, double click on it. After a cell is changed, a small red + flag or triangle will appear in the top-left corner to indicate that it + has been changed. These changes can now be kept (*Save* button), or + abandoned (*Undo* button). + +* To change a check box or radio button, click once. + +* To add a new entry, press the *Add* button. The new (empty) entry will + be created on the server but will not be saved and will not necessarily + be enabled. You can now change all the cells to the desired values, check + the ‘enable’ box if applicable and then press *Save* to activate the new + entry. + +* Most rows are multi-selectable, so you can carry out certain actions on + more than one entry at the same time. So, for example, you can select + multiple items by using ctrl+click on each + entry or click, shift+click to select a range. diff --git a/src/webui/static/app/ext.css b/src/webui/static/app/ext.css index dc2082f11..8d5a4abbf 100644 --- a/src/webui/static/app/ext.css +++ b/src/webui/static/app/ext.css @@ -945,6 +945,12 @@ padding-bottom: 0px } +.hts-doc-text a { + cursor: pointer; + text-decoration: underline; + color:blue; +} + .tv-video-idle { background-image : url(../../static/img/logobig.png); background-repeat : no-repeat; diff --git a/src/webui/static/img/epg.png b/src/webui/static/img/epg.png new file mode 100644 index 000000000..dda1af9e2 Binary files /dev/null and b/src/webui/static/img/epg.png differ