Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: added more (include) docs mdhelp: added/updated more screensh…
…ots and gave some a trim ;) mdhelp: use the tvh_include tag throughout on many help docs mdhelp: update various texts
  • Loading branch information
Mark Clarkstone authored and perexg committed May 7, 2016
1 parent a540820 commit 6fd0f83
Show file tree
Hide file tree
Showing 37 changed files with 140 additions and 167 deletions.
4 changes: 1 addition & 3 deletions docs/class/access_entry.md
Expand Up @@ -17,7 +17,7 @@ to asterisk. Only network prefix is matched then.

<tvh_include>inc/common_button_table_end</tvh_include>

Entries are checked in order, the following
Entries are checked in order (when logging in, etc), the following
functions allows you to change the ordering:

Button | Function
Expand All @@ -29,8 +29,6 @@ Button | Function

<tvh_include>inc/add_grid_entry</tvh_include>

####An Example

!['Access Entry Example'](docresources/accessentriesnewuser.png)

If you would like to allow anonymous access to your Tvheadend
Expand Down
2 changes: 1 addition & 1 deletion docs/class/config.md
Expand Up @@ -7,7 +7,7 @@ the core Tvheadend functionality.

###Menu Bar/Buttons

The tab has the following buttons:
The the following functions are available:

Button | Function
-----------------------|-------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/class/dvrautorec.md
Expand Up @@ -12,8 +12,6 @@ This tab controls EPG-driven recording rules.

<tvh_include>inc/add_grid_entry</tvh_include>

####An Example

If you wanted to record any programs matching "BBC News" on
BBC One you would enter something like this into the add entry dialog:

Expand All @@ -39,6 +37,8 @@ automatically start being recorded.**

<tvh_include>inc/edit_grid_entries</tvh_include>

!['Edit Autorec'](docresources/editautorec.png)

---

<tvh_include>inc/del_grid_entries</tvh_include>
Expand Down
9 changes: 9 additions & 0 deletions docs/class/dvrentry.md
Expand Up @@ -76,6 +76,15 @@ Button | Function

<tvh_include>inc/add_grid_entry</tvh_include>

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'](docresources/addnewrecentry.png)

####Adding an Entry Using the EPG

Using the Electronic Program Guide search functionality, find the
Expand Down
2 changes: 0 additions & 2 deletions docs/class/dvrtimerec.md
Expand Up @@ -12,8 +12,6 @@ This tab controls timer-driven recording rules.

<tvh_include>inc/add_grid_entry</tvh_include>

####An Example

![Timer add example](docresources/dvrtimeradd.png)

Note that when you create a rule/entry it will also generate a [DVR Entry](class/dvrentry).
Expand Down
2 changes: 1 addition & 1 deletion docs/class/imagecache.md
Expand Up @@ -9,7 +9,7 @@ providers.

###Menu Bar/Buttons

The following buttons are available:
The following functions are available:

Button | Function
----------------------------|-------------------
Expand Down
82 changes: 40 additions & 42 deletions docs/class/mpegts_mux.md
Expand Up @@ -8,50 +8,38 @@ streams - so an IP address, in effect.

---

###Menu Bar/Buttons
<tvh_include>inc/common_button_table_start</tvh_include>

The following functions are available:

Button | Function
---------------|---------
**Save** | Save any changes made to the mux entries.
**Undo** | Undo any changes made to the mux entries since the last save.
**Add** | Add a new mux.
**Delete** | Delete an existing mux.
**Edit** | Edit an existing mux. This allows you to change any of the parameters you’d otherwise set when adding a new mux, e.g. EPG scan, character set, etc.
**View Level** | Change the interface view level to show/hide more advanced options.
**Help** | Displays this help page.
<tvh_include>inc/common_button_table_end</tvh_include>

---

###Playing a Mux
###Adding an Entry/Mux

You can stream a complete multiplex by copying/pasting the *Play* link
into the desired player/software.
To add a mux press the *[Add]* button from the menu bar and select the
network you want to add the mux to:

**Notes**:
* The *Play* links don't link to the actual stream but to a playlist for
use with media players such as VLC, If you'd prefer to receive the raw
transport stream instead, you can do so by removing the `/play/` path from
the *Play* URL.
* Not all devices support receiving a complete mux, notably low
powered set-top-boxes and older USB tuners.
!['Network selection'](docresources/addmuxnetworkselection.png)

---
Then enter the mux information:

###Adding a Mux
!['Add Mux Dialog'](docresources/configaddmuxexample.png)

To add a mux press the *[Add]* button from the menu bar and select the
network you want to add the mux to.
Pressing the *[Save]* button (at the bottom of the dialog)
will commit your changes and close the dialog, pressing the *[Apply]*
button will commit your changes but won't close the dialog, pressing
the *[Cancel]* button closes the dialog - any unsaved changes will be
lost.

You only really need to add muxes if the pre-defined list didn't
Note: You only really need to add muxes if the pre-defined list didn't
work, e.g. because of out-of-date data as broadcasters re-arrange their
services or because automatic detection (network discovery) hasn't
successfully found all the muxes over time.

!['Add Mux Dialog'](docresources/configaddmuxexample.png)

**Notes**:
**Tips**:
* If you're not sure what to enter here, take a look at the "If Necessary,
Manually Add Muxes" section on the [Configure Tvheadend](configure_tvheadend)
page.
* Some tuners (or drivers) require more tuning parameters than
others so be sure to enter as many tuning parameters as possible.
* Newly added muxes are automatically set to the *PEND* state.
Expand All @@ -60,27 +48,37 @@ others so be sure to enter as many tuning parameters as possible.

---

###Editing a Mux

To edit a mux highlight the desired mux from within the grid, and
press the *[Edit]* button from the menu bar.

**Tip**: You can also make changes to a mux from within the grid.
<tvh_include>inc/edit_grid_entries</tvh_include>

---

###Deleting a Mux
###Deleting an Entry/Mux

To delete a mux highlight the desired mux from within the grid, and
press the *[Delete]* button from the menu bar.
To delete a mux highlight (select) the desired muxes from within the
grid, and press the *[Delete]* button from the menu bar.

Deleting a mux will also remove any associated services, including
those mapped to channels. If you have network discovery enabled any
previously deleted muxes found in the NIT during a scan will
automatically be re-added.

**Tip**: You can select all muxes within the grid by pressing ctrl+A.
You can also ctrl+click to make additional selections, or shift+click to
select a range.
<tvh_include>inc/selecting_entries_tip</tvh_include>

<tvh_include>inc/paging_tip</tvh_include>

---

###Playing a Mux

You can stream a complete multiplex by copying/pasting the *Play* icon link
into the desired player/software.

**Notes**:
* The links don't link to the actual stream but to a playlist for
use with media players such as VLC, If you'd prefer to receive the raw
transport stream instead, you can do so by removing the `/play/` path from
the URL.
* Not all devices support receiving a complete mux, notably low
powered set-top-boxes and older USB tuners.

---
2 changes: 1 addition & 1 deletion docs/class/mpegts_mux_sched.md
Expand Up @@ -28,7 +28,7 @@ To edit an entry highlight (select) the entry from within the grid, and press th
*[Edit]* button from the menu bar.

A common set of fields is used for the Add or Edit functions, most of
which can also be seen in the grid view:
which can be seen in the grid view:

!['Mux Add/Edit Example'](docresources/configdvbmuxsched1.png)

Expand Down
59 changes: 32 additions & 27 deletions docs/class/mpegts_network.md
Expand Up @@ -24,35 +24,36 @@ Click the desired network type (above) to see all available

---

###Menu Bar/Buttons
<tvh_include>inc/common_button_table_start</tvh_include>

The following functions are available:
<tvh_include>inc/common_button_table_end</tvh_include>

The following tab specific buttons are available:

Button | Function
---------------|---------
**Save** | Save any changes made to the network configuration.
**Undo** | Undo any changes made to the network configuration since the last save.
**Add** | Add a new network. You can choose from any of the types described above.
**Delete** | Delete an existing network. This will also remove any association with an adapter.
**Edit** | Edit an existing network. This allows you to change any of the parameters you’d otherwise set when adding a new network, e.g. network discovery, idle scan, etc. - similar to using the check boxes to enable/disable functions.
**Force Scan** | Force a new scan (i.e. scan all muxes for services) for the selected networks.
**View Level**| Change the interface view level to show/hide more advanced options.
**Help** | Displays this help page.

---

###Add/Edit a Network
###Adding an Entry/Network

To create a network click the *[Add]* button from the menu bar and
then select the required network type, then using the resultant dialog
enter/select the desired network options. To edit a network highlight
(select) the network within the grid, and then press the *[Edit]*
button from the menu bar.
then select the required network type:

A common set of fields is used for the _Add_ or _Edit_ functions, most
of which can also be seen in the grid view:
!['Network selection'](docresources/networktypeselect.png)

!['Add/Edit Network' Dialog - DVB-S/2](docresources/dvbnetworkedit.png)
Then using the resultant dialog enter/select the desired network
options. A common set of fields is used for the *[Add]* dialog,
most of which can be seen in the grid view.

!['Add new network'](docresources/addnewnetwork.png)

Pressing the *[Save]* button (at the bottom of the dialog)
will commit your changes and close the dialog, pressing the *[Apply]*
button will commit your changes but won't close the dialog, pressing
the *[Cancel]* button closes the dialog - any unsaved changes will be
lost.

**Notes**:

Expand All @@ -66,25 +67,29 @@ For more detailed information on networks and how to set them up, see

---

<tvh_include>inc/edit_grid_entries</tvh_include>

!['Add/Edit Network' Dialog - DVB-S/2](docresources/dvbnetworkedit.png)

---

<tvh_include>inc/del_grid_entries</tvh_include>

---

###Force Scanning

Highlight the network(s) you would like to force scan and then press
the "Force Scan" button from the menu bar.
Highlight (select) the network(s) you would like to force scan, and
then press the "Force Scan" button from the menu bar.

Force scanning can take some time. You may continue to use Tvheadend
while a scan is in progress, but doing so will increase the time needed
for it to complete. Note that the time required can vary depending on a
number of factors, such as how many tuners you have available and the
number of muxes on each.

**Tip**: You may select more than one network by holding ctrl and
clicking on additional networks.

---

###Deleting a Network
<tvh_include>inc/selecting_entries_tip</tvh_include>

To delete a network highlight (select) the network within the grid, and then
press the *[Delete]* button.
<tvh_include>inc/paging_tip</tvh_include>

---

0 comments on commit 6fd0f83

Please sign in to comment.