Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Cosmetic update help
  • Loading branch information
@pepsonEL @perexg
pepsonEL authored and perexg committed Oct 15, 2014
1 parent 12649aa commit ec231ac
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 43 deletions.
Binary file modified docs/docresources/accessconfig.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 modified docs/docresources/accessconfigexample.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 22 additions & 15 deletions docs/html/config_access.html
View file
Expand Up @@ -32,84 +32,91 @@
</ul>

<p>
<br>
<hr>
<b>Columns</b>
<hr>
The columns have the following functions:
<br><br>

<dl>
<dt>Enabled
<dt><b>Enabled</b>
<dd>Make the entry participate in access control. If disabled, the entry
is inactive.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Enable this access control rule. Uncheck the box to disable.
<dt>Username
<dt><b>Username</b>
<dd>
Name of user, if no username is needed for match it should contain a
single asterisk (*).

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Login name to be used. If no username is required, this entry should contain a single asterisk (*).
<dt>Password
<dt><b>Password</b>
<dd>
Password to combine with user, if username is '*' (unused), the password
should be the same.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Login password to be used. If username is '*' (unused), the password should be the same (i.e. match any username/password combination, or no username/password required).

<dt>Prefix
<dt><b>Network prefix</b>

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Network Prefix
<dd>
IPv4 prefix for matching based on source IP address.
If set to 0.0.0.0/0 it will match everything.

<dt>Streaming
<dt><b>Streaming</b>
<dd>
Enables access to streaming function. The 'streaming' access is enough to
make Showtime (over HTSP) work.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

Enables access to streaming functionality. This permission is enough to stream over HTSP to VLC, Showtime and similar.

<dt>Advanced Streaming
<dt><b>Advanced Streaming</b>
<dd>
Enables access to advanced streaming function for HTTP - like direct
service or whole MPEG-TS stream (mux)..

<dt>Video Recorder
<dt><b>Video Recorder</b>
<dd>
Enables access to all video recording functions. This also include administration of the auto recordings.

<dt>DVR Config Profile
<dt><b>DVR Config Profile</b>
<dd>
If set, the user will only be able to use the DVR config profile
equal to this value.
Note that this field is unset when the DVR Config Profile is removed.

<dt>Web interface
<dt><b>Web interface</b>
<dd>
Required for web user interface access. Also gives access to the EPG.

<dt>Admin
<dt><b>Admin</b>
<dd>
Enables access to the Configuration tab.

<dt>Limit Connections
<dt><b>Limit Connections</b>
<dd>
If nonzero, the user will be limited to this amount of streaming

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

If non-zero, the user will be limited to this number of concurrent streaming connections.

OR

If set, this will limit the number of concurrent streaming connections a user is permitted to have.
connection at a time.

<dt>Min Channel Num
<dt><b>Min Channel Num</b>
<dd>
If nonzero, the user will only be able to access channels with
a channel number equal or greater to this value.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

If non-zero, this sets the lower limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or greater than this value.

<dt>Max Channel Num
<dt><b>Max Channel Num</b>
<dd>
If nonzero, the user will only be able to access channels with
a channel number equal or lower to this value.

This comment has been minimized.

Sign in to view

Copy link
@ProfYaffle

ProfYaffle Oct 15, 2014

Member

If non-zero, this sets the upper limit of the channels accessible by a user, i.e. the user will only be able to access channels where the channel number is equal to or less than this value.

<dt>Channel Tag
<dt><b>Channel Tag</b>
<dd>
If set, the user will only be able to access channels containing
this channel tag.
Note that this field is unset when the channel tag is removed.

<dt>Comment
<dt><b>Comment</b>
<dd>
Allows the administrator to set a comment only visible in this editor.
It does not serve any active purpose.
</dl>

<p>
<br>
<hr>
Let's also take a look at an example:
<p>
<img src="docresources/accessconfigexample.png">
Expand Down
21 changes: 12 additions & 9 deletions docs/html/dvrfailed.html → docs/html/config_dvrfailed.html
View file
Expand Up @@ -5,8 +5,12 @@
<img src="docresources/failedrecordings1.png">
</p>
<p>
<u>Buttons have the following functions:</u>

<br>
<hr>
<b>Buttons</b>
<hr>
Buttons have the following functions:
<br><br>
<dl>
<dt><b>Delete</b>
<dd>
Expand All @@ -15,15 +19,14 @@
<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

Click this button to download the selected failed recordings to a local disk. You will be prompted to select the path for the saved file(s).
<p>
</dl>

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


<br>
<hr>
<b>Columns</b>
<hr>
The columns have the following functions:
<br><br>
<dl>
<dt><b>Details</b>
<dd>
Expand Down
19 changes: 12 additions & 7 deletions docs/html/dvrfinished.html → docs/html/config_dvrfinished.html
View file
Expand Up @@ -5,8 +5,12 @@
<img src="docresources/finishedrecordings1.png">
</p>
<p>
<u>Buttons have the following functions:</u>

<br>
<hr>
<b>Buttons</b>
<hr>
Buttons have the following functions:
<br><br>
<dl>
<dt><b>Delete</b>
<dd>
Expand All @@ -16,12 +20,13 @@
<dd>
If clicked download selected finished 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

Click this button to download the selected finished recordings to a local disk. You will be prompted to select the path for the saved file(s).
</dl>
<br>
<br>
<p>
<u>The columns have the following functions:</u>


<br>
<hr>
<b>Columns</b>
<hr>
The columns have the following functions:
<br><br>
<dl>
<dt><b>Details</b>
<dd>
Expand Down
21 changes: 12 additions & 9 deletions docs/html/dvrupcoming.html → docs/html/config_dvrupcoming.html
View file
Expand Up @@ -5,21 +5,24 @@
<img src="docresources/upcomingrecordings1.png">
</p>
<p>
<u>Buttons have the following functions:</u>

<br>
<hr>
<b>Buttons</b>
<hr>
Buttons have the following functions:
<br><br>
<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.
<p>
</dl>

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


<br>
<hr>
<b>Columns</b>
<hr>
The columns have the following functions:
<br><br>
<dl>
<dt><b>Details</b>
<dd>
Expand Down
6 changes: 3 additions & 3 deletions src/webui/static/app/dvr.js
View file
Expand Up @@ -189,7 +189,7 @@ tvheadend.dvr_upcoming = function(panel, index) {
selected: selected,
beforeedit: beforeedit,
help: function() {
new tvheadend.help('DVR-Upcoming/Current Recordings', 'dvrupcoming.html');
new tvheadend.help('DVR-Upcoming/Current Recordings', 'config_dvrupcoming.html');
},
});

Expand Down Expand Up @@ -271,7 +271,7 @@ tvheadend.dvr_finished = function(panel, index) {
tbar: [downloadButton],
selected: selected,
help: function() {
new tvheadend.help('DVR-Finished Recordings', 'dvrfinished.html');
new tvheadend.help('DVR-Finished Recordings', 'config_dvrfinished.html');
},
});

Expand Down Expand Up @@ -354,7 +354,7 @@ tvheadend.dvr_failed = function(panel, index) {
tbar: [downloadButton],
selected: selected,
help: function() {
new tvheadend.help('DVR-Failed Recordings', 'dvrfailed.html');
new tvheadend.help('DVR-Failed Recordings', 'config_dvrfailed.html');
},
});

Expand Down

1 comment on commit ec231ac

@ProfYaffle
Copy link
Member

Choose a reason for hiding this comment

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

@PiterEL - see if that works for you. If it does, I'll work my way through the other files.

On the graphics, do we need to select a standard size - perhaps an 800px-wide image for all screenshots? It's a balance between making it fit on as many screens as possible while still being big enough to be readable...

Please sign in to comment.