Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
WEBUI: cosmetic, add help for upcoming/current recordings
  • Loading branch information
@pepsonEL @perexg
pepsonEL authored and perexg committed Oct 15, 2014
1 parent d239e65 commit dd06df7
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 1 deletion.
Binary file added docs/docresources/upcomingrecordings1.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docresources/upcomingrecordings2.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/html/dvrfailed.html
View file
Expand Up @@ -12,7 +12,6 @@
<dd>
If clicked delete selected failed recordings you delete recordings. Before deleted show message: Do you really want to delete the selection ? Answer Yes or No.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Duplicate (I think I'm going backwards in time 😄 ).
<p>
<dl>
<dt><b>Download</b>
<dd>
If clicked download selected failed recordings you can downloaded recordings to your disk. After clicked you ask to select path.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Ditto
Expand Down
70 changes: 70 additions & 0 deletions docs/html/dvrupcoming.html
View file
@@ -0,0 +1,70 @@
<div class="hts-doc-text">
This tab show your all upcoming/current recordings.

<p>
<img src="docresources/upcomingrecordings1.png">
</p>
<p>
<u>Buttons have the following functions:</u>

<dl>
<dt><b>Delete</b>
<dd>
If clicked delete selected upcoming/current recordings you delete recordings. Before deleted show message: Do you really want to delete the selection ? Answer Yes or No.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Ditto
<p>

<br>
<br>
<p>
<u>The columns have the following functions:</u>


<dl>
<dt><b>Details</b>
<dd>
Show clock status or red point status and blue icon "i". Red point status means current recording and clock status means scheduled recording. After click on icon "i" you see info about select upcoming/current recordings.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Shows the status of the recording event:

Clock - the recording is scheduled (upcoming).

Record symbol (red circle) - the recording is active and underway (current).

Info - displays detailed information about the selected recording (upcoming or current).
<p>
<img src="docresources/upcomingrecordings2.png">
<p>
<dt><b>Title</b>
<dd>
Showing title of record.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The title (name) of the recording.

_Q: this isn't used to match a programme name, is it? It's copied from the EPG but is only really "the name of the recording event" and not used otherwise, I think._

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Then:

The title (name) of the recording. While this is copied from the EPG when you create a recording, it's not used to match the event itself and is thus used here as the name of the event (see also: adding an event manually with the Add button).
<p>
<dt><b>Episod</b>

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Episode
<dd>
Showing number episod of record.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The episode number of the recording (whether this is available depends on your broadcaster and/or EPG data source).
<p>
<dt><b>Priority</b>
<dd>
Showing priority of record.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The priority of the recording: Not set, Important, High, Normal, Low, Unimportant.

If there is a clash, more important recordings will take priority over less important ones. _Need to check this behaviour?_
<p>
<dt><b>Scheduled Start Time</b>
<dd>
Showing date and time when the recording was started.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The date and time when the scheduled recording will start. Note that this includes any extra time defined in the recording profile (e.g. "start two minutes earlier than the EPG start time").
<p>
<dt><b>Scheduled Stop Time</b>
<dd>
Showing date and time when the recording was stoped.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The date and time when the scheduled recording will stop. Note that this includes any extra time defined in the recording profile (e.g. "finish recording five minutes after the EPG stop time").
<p>
<dt><b>Duration</b>
<dd>
Showing how long it took the recording.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The total duration of the scheduled recording, including any extra time before or after.
<p>
<dt><b>Channel Name</b>
<dd>
Showing the name of the channel from which the recording will be made.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The channel to be recorded.
<p>
<dt><b>Creator</b>
<dd>
Showing the name of the user who created the recording.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The user who created the recording or the auto-recording source and IP address if scheduled by a matching rule.
<p>
<dt><b>DVR Configuration</b>
<dd>
Showing the name of DVR Configuration which is use to record.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The DVR configuration to be used for this recording.
<p>
<dt><b>Schedule Status</b>
<dd>
Showing the status info of record.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

The status of the recording. _Q: Is this always 'scheduled'?_
<p>

</div>

3 comments on commit dd06df7

@ksooo
Copy link
Contributor

@ksooo ksooo commented on dd06df7 Oct 15, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of missing documentation. What do you think, wouldn't ist be a good idea to find a native English speaker (which I'm not) for a review before doing the initial commit. My feeling is, that there might be room for improvement.

@ProfYaffle
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd pass for a native English speaker in most quarters, although some would surely argue...

I'm happy to check it over if I have time. @PiterEL, if I just comment on your code with suggestions, would that work for you? It saves having two people fight over the HTML files and means I can do it as and when I get a chance.

The issue I see is that we're working with a moving target. I updated much of the help text and the screenshots not that long ago, but they'll continue to go out of date until we branch to 4.0 final - so we can expect to make some changes multiple times...

@ProfYaffle
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated a few of the latest help files, then. Let the changes find their way through to master and then I'll update my installation and see which ones I've missed, otherwise I'm looking at multiple versions of the same file.

And apologies, I didn't notice @PiterEL's cry for help. All I can immediately suggest is to enable static ffmpeg in configure, or checking the specific library version you do have installed.

Please sign in to comment.