From: Mark Clarkstone Date: Fri, 7 Apr 2017 17:45:38 +0000 (+0100) Subject: mdhelp: This is a major overhaul of the documentation. X-Git-Tag: v4.2.1~14 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=34bda01329a69ba7893674ab4cbec2dd69762c84;p=thirdparty%2Ftvheadend.git mdhelp: This is a major overhaul of the documentation. * I've removed unnecessary sections in many of the docs describing how to add, edit and delete entries. We're just repeating ourselves, the general web interface guide covers most situations anyway. * Clean up the documentation image directory. This took a while as things were all over the place, I've deleted unused files and put all images in separate folders.. * I've tried to add little bits here and there - still lots more things need improving but hopefully this is a start! --- diff --git a/docs/class/access_entry.md b/docs/class/access_entry.md index 60535e877..49541b1bf 100644 --- a/docs/class/access_entry.md +++ b/docs/class/access_entry.md @@ -17,7 +17,7 @@ prefix only. that you put the wildcard (asterisk `*`) accounts at top and all other accounts (with special permissions) at the bottom. -!['Access Entries Grid'](static/img/doc/accessentriesgrid.png) +!['Access Entries Grid'](static/img/doc/access_entry/tab.png) --- @@ -26,7 +26,7 @@ accounts (with special permissions) at the bottom. inc/common_button_table_end Entries are checked in order (when logging in, etc), the following -functions allows you to change the ordering: +functions allow you to change the ordering: Button | Function -----------------------|--------- @@ -35,13 +35,11 @@ Button | Function --- -inc/add_grid_entry - -####Example +###Example This is an example of a limited user entry. -!['Access Entry Example'](static/img/doc/accessentriesnewuser.png) +!['Access Entry Example'](static/img/doc/access_entry/new.png) Remember to also add a password entry in the *[Passwords](class/passwd)* tab - not required for wildcard accounts. @@ -57,14 +55,6 @@ rights, allowing you to enable / disable each as needed. Note, matching --- -inc/edit_grid_entries - ---- - -inc/del_grid_entries - ---- - ###Emergency/Backdoor Access Tvheadend includes functionality that allows you to regain access to diff --git a/docs/class/bouquet.md b/docs/class/bouquet.md index ea959b994..c548b294f 100644 --- a/docs/class/bouquet.md +++ b/docs/class/bouquet.md @@ -1,6 +1,6 @@ Bouquets are broadcaster-defined groupings and orders of channels. -!['Bouqets' Tab](static/img/doc/bouquettab.png) +!['Bouqets' Tab](static/img/doc/bouquet/tab.png) To use bouquets, ensure to add and scan all available muxes using the predefined muxes or manual configuration. @@ -31,20 +31,14 @@ Button | Function --- -inc/add_grid_entry +###Example -####Example - -!['Add Bouquet Dialog'](static/img/doc/bouquetadd.png) +!['Add Bouquet Dialog'](static/img/doc/bouquet/add.png) Note that the URL must begin with `file://` or `http(s)://`. --- -inc/edit_grid_entries - ---- - ###Detaching Channels If you're mapping another service to a channel created by a bouquet you @@ -53,7 +47,7 @@ changes, you can do this by selecting the desired channels from within the grid and then pressing the *Detach selected channels from bouquet* option from the *[Map services]* button. -!['Map All Services'](static/img/doc/mapallserviceschannels.png) +!['Map All Services'](static/img/doc/bouquet/detach.png) If you do not detach channel(s) before mapping additional services the following changes can occur.. @@ -65,10 +59,4 @@ Detaching channels from a bouquet will prevent any further updates provided by the bouquet, which unfortunately means you will have to manually re-map when changes to services occur (e.g, mux moves, ceased broadcasting etc). -inc/selecting_entries_tip - ---- - -inc/del_grid_entries - --- diff --git a/docs/class/caclient.md b/docs/class/caclient.md index 46be9bff2..e08ba2c1b 100644 --- a/docs/class/caclient.md +++ b/docs/class/caclient.md @@ -1,7 +1,7 @@ Tvheadend supports connecting to card clients via the cwc (newcamd) and capmt (linux network dvbapi) protocols for so-called 'softcam' descrambling. -!['CA Client Configuration Example'](static/img/doc/caclientconfig.png) +!['CA Client Configuration Example'](static/img/doc/caclient/tab.png) --- @@ -49,30 +49,3 @@ Icon | Description !['Stop/Disabled Icon'](icons/stop.png) | The client is disabled. --- - -###Adding/Editing a CA Configuration - -To create a new CA configuration press the *[Add]* button from the -menu bar, you will then be asked to select a client type. Once you've -selected a type you can then enter/select the desired options from the -resultant *Add* dialog. - -!['Add CA Config'](static/img/doc/configcaadd.png) - -To edit an existing configuration, click on it from within the grid, the -*Parameters* panel should then appear on the right hand side. - -**Tips**: -* Remember to *[Save]* your changes before selecting another config -from within the grid. -* You can clone an existing config by clicking the *[Clone]* -button. - ---- - -###Deleting a CA Configuration - -Highlight (select) the desired entry from the grid, then press the -*[Delete]* button from the menu bar. - ---- diff --git a/docs/class/channel.md b/docs/class/channel.md index 14b1aa808..1803c33b4 100644 --- a/docs/class/channel.md +++ b/docs/class/channel.md @@ -1,6 +1,6 @@ This tab lists all defined channels. -!['Channel lists'](static/img/doc/configchannellist.png) +!['Channel lists'](static/img/doc/channel/tab.png) --- @@ -30,11 +30,9 @@ Numbering Button | Function --- -inc/add_grid_entry +###Example -####Example - -!['Add Channel Dialog'](static/img/doc/addchanneldialog.png) +!['Add Channel Dialog'](static/img/doc/channel/add.png) In the above example image, we're creating a channel called Channel 4 and mapping it to the service of the same name. You can name a channel @@ -44,21 +42,11 @@ to. If you have a lot of services you may want to use the [Map services](class/mpegts_service) functions or a [Bouquet](class/bouquet). ---- - -inc/edit_grid_entries - -!['Edit Channel Dialog'](static/img/doc/channeleditsingle.png) - -Note that editing a channel created by a bouquet can have unexpected +Note, that editing a channel created by a bouquet can have unexpected results, please see *Detaching Channels* on the [Bouquet](class/bouquet) page for info. --- -inc/del_grid_entries - ---- - inc/play --- diff --git a/docs/class/channeltag.md b/docs/class/channeltag.md index 0373fda63..f69639a13 100644 --- a/docs/class/channeltag.md +++ b/docs/class/channeltag.md @@ -4,26 +4,6 @@ Tags are not required by Tvheadend itself, but are useful in media applications such as Kodi and are a requirement for using Tvheadend with Movian. -!['Channel tag'](static/img/doc/channeltags.png) - ---- - -inc/common_button_table_start - -inc/common_button_table_end - ---- - -inc/add_grid_entry - -!['Channel tag dialog'](static/img/doc/addchanneltagdialog.png) - ---- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries +!['Channel tag'](static/img/doc/channeltag/tab.png) --- diff --git a/docs/class/config.md b/docs/class/config.md index 528ae43d8..e75022b01 100644 --- a/docs/class/config.md +++ b/docs/class/config.md @@ -1,7 +1,7 @@ This tabs allow configuration of several general parameters that affect the core Tvheadend functionality. -!['General Base' Tab Screenshot 1](static/img/doc/configbaseall.png) +!['General Base' Tab Screenshot 1](static/img/doc/config/tab.png) --- diff --git a/docs/class/debugging.md b/docs/class/debugging.md index 80b6a56d8..2a9aead1d 100644 --- a/docs/class/debugging.md +++ b/docs/class/debugging.md @@ -1,6 +1,6 @@ This tab is used to configure various debugging options in tvheadend. -!['Debugging tab'](static/img/doc/debuggingtab.png) +!['Debugging tab'](static/img/doc/debugging/tab.png) Changes to any of these settings must be confirmed by pressing the *[Apply configuration]* button before taking effect. diff --git a/docs/class/dvrautorec.md b/docs/class/dvrautorec.md index 20c9eec16..4104bcbdb 100644 --- a/docs/class/dvrautorec.md +++ b/docs/class/dvrautorec.md @@ -1,6 +1,6 @@ This tab controls EPG-driven recording rules. -!['Autorec' Tab](static/img/doc/dvrautorecentries.png) +!['Autorec' Tab](static/img/doc/dvrautorec/tab.png) --- @@ -10,14 +10,12 @@ This tab controls EPG-driven recording rules. --- -inc/add_grid_entry - -####Example +###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: -!['Autorec' example entry](static/img/doc/dvrautorecadd.png) +!['Autorec example entry'](static/img/doc/dvrautorec/add.png) This uses a regular expression (regex) to match the program title "BBC News" exactly, otherwise event titles containing the phrase would @@ -36,14 +34,3 @@ Matching events will be added to the automatically start being recorded.** --- - -inc/edit_grid_entries - -!['Edit Autorec'](static/img/doc/editautorec.png) - ---- - -inc/del_grid_entries - ---- - diff --git a/docs/class/dvrconfig.md b/docs/class/dvrconfig.md index bfb9643e7..e49cb68ce 100644 --- a/docs/class/dvrconfig.md +++ b/docs/class/dvrconfig.md @@ -2,7 +2,7 @@ This tab is used to configure operation of the Digital Video Recorder. It is not used for scheduling or administration of individual recordings. -!['Digital Video Recorder Profiles' Tab 1](static/img/doc/dvrprofiles.png) +!['Digital Video Recorder Profiles' Tab 1](static/img/doc/dvrconfig/tab.png) --- @@ -21,29 +21,3 @@ Button | Function inc/common_button_table_end --- - -###Adding/Editing a Profile - -To create a new profile press the *[Add]* button from the -menu bar, a new entry "! New config" will be added to the grid, click -on that entry to configure it - don't forget to save! - -!['Add New Profile'](static/img/doc/dvrnewprofile.png) - -To edit an existing configuration, click on it from within the grid, the -*Parameters* panel should then appear on the right hand side. - -**Tips**: -* Remember to *[Save]* your changes before selecting another profile -from within the grid. -* You can clone an existing profile by clicking the *[Clone]* -button. - ---- - -###Deleting a Profile - -Highlight (select) the desired entry from the grid, then press the -*[Delete]* button from the menu bar. - ---- diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md index 36ca0fe9e..a982c3a65 100644 --- a/docs/class/dvrentry.md +++ b/docs/class/dvrentry.md @@ -21,7 +21,7 @@ the recording. Entries shown here link to file(s) that Tvheadend cannot locate (files which have been externally removed). -!['Digital Video Recorder' Tabs](static/img/doc/configdvrtabs4.png) +!['Digital Video Recorder' Tabs](static/img/doc/dvrentry/tab.png) --- @@ -60,18 +60,14 @@ Icon | Description ![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 +###Manual Recording Entry Example This is an example of a one-time recording entry. -!['Add new recording dialog'](static/img/doc/addnewrecentry.png) +!['Add new recording dialog'](static/img/doc/dvrentry/add.png) -####Adding an Entry Using the EPG +###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 @@ -84,7 +80,7 @@ details dialog you can: 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 +###Adding an Entry Using Autorec Rules Autorec rules allow you to match events using various options. @@ -95,18 +91,6 @@ 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]* diff --git a/docs/class/dvrtimerec.md b/docs/class/dvrtimerec.md index a0bebc0fd..6a41d7ab9 100644 --- a/docs/class/dvrtimerec.md +++ b/docs/class/dvrtimerec.md @@ -1,6 +1,6 @@ This tab controls timer-driven recording rules. -![Timer Tab](static/img/doc/timers.png) +![Timer Tab](static/img/doc/dvrtimerec/tab.png) --- @@ -10,23 +10,12 @@ This tab controls timer-driven recording rules. --- -inc/add_grid_entry - -####Example +###Example This is an example of a one-time timer-based recording entry. -![Timer add example](static/img/doc/dvrtimeradd.png) +![Timer add example](static/img/doc/dvrtimerec/add.png) Note that when you create a rule/entry it will also generate a [DVR Entry](class/dvrentry). --- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries - ---- - diff --git a/docs/class/epgconf.md b/docs/class/epgconf.md index dc6202de8..be19d3a38 100644 --- a/docs/class/epgconf.md +++ b/docs/class/epgconf.md @@ -1,7 +1,7 @@ This tab is used to configure the Electronic Program Guide (EPG) [grabbing](class/epggrab_mod) capabilities. -!['EPG Grabber Configuration'](static/img/doc/epggrabberconfig.png) +!['EPG Grabber Configuration'](static/img/doc/epgconf/tab.png) --- diff --git a/docs/class/epggrabber_channel.md b/docs/class/epggrabber_channel.md index fdb2c42eb..1f1a9687d 100644 --- a/docs/class/epggrabber_channel.md +++ b/docs/class/epggrabber_channel.md @@ -1,6 +1,6 @@ This tab displays EPG data used by channels. -!['EPG Grabber Channels Tab'](static/img/doc/epggrabberchannels.png) +!['EPG Grabber Channels Tab'](static/img/doc/epggrabber_channel/tab.png) --- @@ -15,14 +15,4 @@ Button | Function **Delete** | Delete the selected grid entries. **Edit** | Edit the selected grid entries. -inc/common_button_table_end - ---- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries - --- diff --git a/docs/class/epggrabber_modules.md b/docs/class/epggrabber_modules.md index 5c48c2cb9..85ffe0694 100644 --- a/docs/class/epggrabber_modules.md +++ b/docs/class/epggrabber_modules.md @@ -3,7 +3,7 @@ grabber modules. Tvheadend supports a variety of different EPG grabbing mechanisms. These fall into 3 broad categories, within which there are a variety of specific grabber implementations. -!['EPG Grabber Configuration'](static/img/doc/epggrabmodules.png) +!['EPG Grabber Configuration'](static/img/doc/epggrabber_modules/tab.png) --- diff --git a/docs/class/filters.md b/docs/class/filters.md index 95d18be15..21f90f87d 100644 --- a/docs/class/filters.md +++ b/docs/class/filters.md @@ -1,7 +1,7 @@ This tab allows you to define rules that filter and order various elementary streams. -!['Stream filters'](static/img/doc/streamfiltertab.png) +!['Stream filters'](static/img/doc/filters/tab.png) --- @@ -42,30 +42,18 @@ This dialog shows the received PIDs and filtered PIDs in one window. --- -inc/add_grid_entry +###Filtering out a Stream -Below are some examples: - -####Filtering out a Stream - -!['Removing a stream'](static/img/doc/filterexample.png) +!['Removing a stream'](static/img/doc/filters/example.png) Here we're removing the Bulgarian language audio from the input (first rule). However, if Bulgarian is the only language available add it back in as a last resort (second rule). -####Ignoring Unknown Streams +###Ignoring Unknown Streams If you'd like to ignore unknown elementary streams, add a rule to the end of grid with the *ANY* (not defined) comparison(s) and the action set to *IGNORE*. --- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries - ---- diff --git a/docs/class/imagecache.md b/docs/class/imagecache.md index 390819e85..282b9312e 100644 --- a/docs/class/imagecache.md +++ b/docs/class/imagecache.md @@ -3,7 +3,7 @@ to be served from the local webserver. This can be useful for multi-client systems and, generally, to reduce hits on upstream providers. -!['Configuration - Image Cache tab'](static/img/doc/configimagecache.png) +!['Configuration - Image Cache tab'](static/img/doc/imagecache/tab.png) --- diff --git a/docs/class/ipblocking.md b/docs/class/ipblocking.md index 53ba90def..18412a5e3 100644 --- a/docs/class/ipblocking.md +++ b/docs/class/ipblocking.md @@ -1,7 +1,7 @@ This tab allows to configure blocked IP ranges. Users within these ranges are not allowed to login (use any Tvheadend service). -!['Access Control - Entries tab'](static/img/doc/accessconfigipblockentries.png) +!['Access Control - Entries tab'](static/img/doc/ipblocking/tab.png) --- @@ -10,21 +10,3 @@ are not allowed to login (use any Tvheadend service). inc/common_button_table_end --- - -inc/add_grid_entry - -!['Add Entries Dialog'](static/img/doc/accessipblockingedit.png) - -**Tip**: You can enter a comma-separated list of network prefixes, if you're -unsure as to what to enter in the *Network prefix* field take a look at -[this guide](https://www.ripe.net/about-us/press-centre/understanding-ip-addressing). - ---- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries - ---- diff --git a/docs/class/linuxdvb_frontend_dvbc.md b/docs/class/linuxdvb_frontend_dvbc.md index 778cf25cd..5f5e93d39 100644 --- a/docs/class/linuxdvb_frontend_dvbc.md +++ b/docs/class/linuxdvb_frontend_dvbc.md @@ -1,7 +1,7 @@ This panel lists all the available Cable (DVB-C/C2/ISDB-C/ATSC-C) frontend parameters. -!['DVB-C frontend parameters'](static/img/doc/dvbcfrontendparams.png) +!['DVB-C frontend parameters'](static/img/doc/linuxdvb_frontend_dvbc/tab.png) --- diff --git a/docs/class/linuxdvb_frontend_dvbs.md b/docs/class/linuxdvb_frontend_dvbs.md index 98992086e..7a70047b0 100644 --- a/docs/class/linuxdvb_frontend_dvbs.md +++ b/docs/class/linuxdvb_frontend_dvbs.md @@ -1,7 +1,7 @@ This panel lists all the available satellite (DVB-S/ISDB-S) frontend parameters. -!['DVB-S frontend parameters'](static/img/doc/dvbsfrontendparams.png) +!['DVB-S frontend parameters'](static/img/doc/linuxdvb_frontend_dvbs/tab.png) --- diff --git a/docs/class/linuxdvb_frontend_dvbt.md b/docs/class/linuxdvb_frontend_dvbt.md index 0e32f2a70..737582e15 100644 --- a/docs/class/linuxdvb_frontend_dvbt.md +++ b/docs/class/linuxdvb_frontend_dvbt.md @@ -1,7 +1,7 @@ This panel lists all the available Terrestrial (DVB-T/T2/ISDB-T/ATSC-T) frontend parameters. -!['DVB-T frontend parameters'](static/img/doc/dvbtfrontendparams.png) +!['DVB-T frontend parameters'](static/img/doc/linuxdvb_frontend_dvbt/tab.png) --- diff --git a/docs/class/mpegts_mux.md b/docs/class/mpegts_mux.md index 0f878ef26..99fb29062 100644 --- a/docs/class/mpegts_mux.md +++ b/docs/class/mpegts_mux.md @@ -4,7 +4,7 @@ individual channels are multiplexed, hence the name. However, Tvheadend also uses the term ‘mux’ to describe a source for multiple IP streams - so an IP address, in effect. -!['Mux List'](static/img/doc/configdvbmux.png) +!['Mux List'](static/img/doc/mpegts_mux/tab.png) --- @@ -14,60 +14,6 @@ streams - so an IP address, in effect. --- -###Adding an Entry/Mux - -To add a mux press the *[Add]* button from the menu bar and select the -network you want to add the mux to: - -!['Network selection'](static/img/doc/addmuxnetworkselection.png) - -Then enter the mux information: - -!['Add Mux Dialog'](static/img/doc/configaddmuxexample.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. - -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. - -**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. -* Tvheadend won't scan the newly added mux instantly, it can take up to -10 minutes to begin an initial scan. - ---- - -inc/edit_grid_entries - ---- - -###Deleting an Entry/Mux - -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. - -inc/selecting_entries_tip - -inc/paging_tip - ---- - inc/play --- diff --git a/docs/class/mpegts_mux_sched.md b/docs/class/mpegts_mux_sched.md index c81fa04f4..ee2f43b5c 100644 --- a/docs/class/mpegts_mux_sched.md +++ b/docs/class/mpegts_mux_sched.md @@ -1,26 +1,6 @@ Mux Schedulers enable Tvheadend to automatically play channels. This is useful to get EPG, services or access rights updates. -!['Mux Schedule Entries'](static/img/doc/configdvbmuxsched.png) - ---- - -inc/common_button_table_start - -inc/common_button_table_end - ---- - -inc/add_grid_entry - -!['Add Mux Schedule'](static/img/doc/addmuxsched.png) - ---- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries +!['Mux Schedule Entries'](static/img/doc/mpegts_mux_sched/tab.png) --- diff --git a/docs/class/mpegts_network.md b/docs/class/mpegts_network.md index 4abef77ee..53ac3019a 100644 --- a/docs/class/mpegts_network.md +++ b/docs/class/mpegts_network.md @@ -20,7 +20,7 @@ supports several different types of network, notably: Click the desired network type (above) to see all available [parameters](#items). -!['Networks' Tab Screenshot](static/img/doc/dvbinputsnetwork.png) +!['Networks' Tab Screenshot](static/img/doc/mpegts_network/tab.png) --- @@ -36,59 +36,12 @@ Button | Function --- -###Adding an Entry/Network - -To create a network click the *[Add]* button from the menu bar and -then select the required network type: - -!['Network selection'](static/img/doc/networktypeselect.png) - -Then using the resultant dialog enter/select the desired network -options. - -!['Add new network'](static/img/doc/addnewnetwork.png) - -Once you're happy with what you've entered into the dialog you can save -the network using the *[Save]* button (closing the dialog), save your -pending changes and continue making further adjustments by pressing the -*[Apply]* button, or cancel any unsaved changes (and close the dialog) -by pressing the *[Cancel]* button. - -**Notes**: - -* Once you've created a network (and added muxes) you must assign it to -an **enabled** adapter. -* There is a 5-10 minute delay before a scan starts, this is so you can -make changes if needed (this does not apply to IPTV networks). - -For more detailed information on networks and how to set them up, see -[Configure Tvheadend.](configure_tvheadend) - ---- - -inc/edit_grid_entries - -!['Add/Edit Network' Dialog - DVB-S/2](static/img/doc/dvbnetworkedit.png) - ---- - -inc/del_grid_entries - ---- - ###Force Scanning -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. -inc/selecting_entries_tip - -inc/paging_tip - --- diff --git a/docs/class/mpegts_service.md b/docs/class/mpegts_service.md index eccb4aba9..ac9cb5b7e 100644 --- a/docs/class/mpegts_service.md +++ b/docs/class/mpegts_service.md @@ -1,6 +1,6 @@ Services are automatically pulled from muxes and can be mapped to Channels. -!['Services'](static/img/doc/configdvbservices.png) +!['Services'](static/img/doc/mpegts_service/tab.png) --- @@ -32,13 +32,13 @@ Maintenance Button | Function There are a number of methods to mapping available services, mapping uses the following dialog. - !['Service mapper dialog'](static/img/doc/mapservicesdialog.png) + !['Service mapper dialog'](static/img/doc/service_mapper/dialog.png) ####Mapping All Press the *[Map services]* button and then *[Map all services]*. -!['Map All Services'](static/img/doc/mapservicesall.png) +!['Map All Services'](static/img/doc/mpegts_service/map_all.png) The [Map services to channels](class/service_mapper) will now be displayed with **all** services checked - feel free to make changes. Once you're happy with the selection press the "Map services" button, you will @@ -51,7 +51,7 @@ Click on the services you would like to map as channels, once you're done selecting press the "Map services" button and then "Map selected services". -!['Map selected'](static/img/doc/mapselectedservices.png) +!['Map selected'](static/img/doc/mpegts_service/map_selected.png) The [Map services to channels](class/service_mapper) dialog will now be displayed with the **selected** services checked - feel free to make @@ -60,8 +60,6 @@ changes. Once you're happy with the selection press the [Service Mapper](status_service_mapper) tab which will begin mapping the selected services to channels. -inc/selecting_entries_tip - **Tip**: By default Tvheadend will only show a small selection of available services - you can increase this by using the paging selector at the bottom right of the page. @@ -73,41 +71,29 @@ You can map/remove a service to/from an existing channel by doing the following: **1)** Find the desired service from within the services grid. If you have a lot of services you may want to use filtering to limit the -number of grid entries. You can do this by hovering your mouse over the -*Service name* column, a down arrow ▾ should now be visible, clicking -the arrow will then display a list of options, move your mouse down to -"Filters" and a text box should then appear, click on it and enter the -desired service's name. +number of grid entries. -!['Service filtering'](static/img/doc/servicefilter.png) +!['Service filtering'](static/img/doc/mpegts_service/map_selected.png) -**Tip**: Remember to remove the filter when you're finished (uncheck the +**Tip**: Remember to remove the filter when you're finished (untick the check box next to the "Filters" option). **2)** Double click on the channel field, a drop down listing of all defined channels will appear, check/uncheck the check box next to the channel you'd like to associate/disassociate the service with. -!['Add service to channel example'](static/img/doc/addservicetochannel.png) +!['Add service to channel example'](static/img/doc/mpegts_service/add_service.png) **3)** Press the *[Save]* button from the menu bar, and you're done! --- -inc/edit_grid_entries - ---- - -inc/del_grid_entries - ---- - ###Service Information Clicking the !['Information Icon'](static/icons/information.png) information icon will display service details. -!['Service Information'](static/img/doc/serviceinfo.png) +!['Service Information'](static/img/doc/mpegts_service/service_info.png) --- diff --git a/docs/class/passwd.md b/docs/class/passwd.md index 3947dec75..871aa61f7 100644 --- a/docs/class/passwd.md +++ b/docs/class/passwd.md @@ -1,7 +1,7 @@ This tab is the second part of Tvheadend's access control mechanism. It is where you set and maintain all user passwords (e.g. for streaming or DVR access). -!['Configuration - Passwords tab'](static/img/doc/configpasswordentries.png) +!['Configuration - Passwords tab'](static/img/doc/passwd/tab.png) --- @@ -11,24 +11,14 @@ where you set and maintain all user passwords (e.g. for streaming or DVR access) --- -inc/add_grid_entry - -####Example +###Example This is an example of a password entry. -!['Add Password dialog'](static/img/doc/configpasswdadd.png) +!['Add Password dialog'](static/img/doc/passwd/add.png) Be aware that the username you enter here must match a username/entry in -the [Access Entries](class/access_entry) tab for it to apply. You may +the Access Entries tab for it to apply. You may have multiple password entries for the same username if you wish. --- - -inc/edit_grid_entries - ---- - -inc/del_grid_entries - ---- diff --git a/docs/class/profile.md b/docs/class/profile.md index 2c2b04256..324652b78 100644 --- a/docs/class/profile.md +++ b/docs/class/profile.md @@ -3,7 +3,7 @@ streaming and recordings. The profiles are assigned through the [Access Entries](class/access), DVR Profiles or as parameter for HTTP Streaming. -!['Stream Profiles'](static/img/doc/configstreamprofiles.png) +!['Stream Profiles'](static/img/doc/profile/tab.png) * Types * Built-in @@ -38,37 +38,3 @@ Button | Function inc/common_button_table_end --- - -###Add a Profile - -To create a new profile press the *[Add]* button from the -menu bar, you will then be asked to select a profile type. - -!['Type select'](static/img/doc/streamprofiletypeselect.png) - -Once you've selected a type you can then enter/select the desired options from the -resultant *Add* dialog. - -!['Add Profile Dialog'](static/img/doc/addprofiledialog.png) - ---- - -###Edit a Profile - -To edit an existing profile, click on it from within the grid, the -*Parameters* panel should then appear on the right hand side. - -**Tips**: -* Remember to *[Save]* your changes before selecting another config -from within the grid. -* You can clone an existing config by clicking the *[Clone]* -button. - ---- - -###Deleting a Profile - -Highlight (select) the desired entry from the grid, then press the -*[Delete]* button from the menu bar. - ---- diff --git a/docs/class/satip_client.md b/docs/class/satip_client.md index 8cfa125d8..d943b04e2 100644 --- a/docs/class/satip_client.md +++ b/docs/class/satip_client.md @@ -1,6 +1,6 @@ This panel displays all available SAT>IP client parameters. -!['SAT>IP Panel'](static/img/doc/satipclient.png) +!['SAT>IP Panel'](static/img/doc/satip_client/tab.png) --- diff --git a/docs/class/satip_server.md b/docs/class/satip_server.md index c4c185f7b..3b85b3895 100644 --- a/docs/class/satip_server.md +++ b/docs/class/satip_server.md @@ -2,7 +2,7 @@ SAT\>IP Server is something like DVB network tuner. Tvheadend can forward mpegts input streams including on-the-fly descrambling to SAT\>IP clients. -!['SAT\>IP Config tab'](static/img/doc/satipconfig.png) +!['SAT\>IP Config tab'](static/img/doc/satip_server/tab.png) --- diff --git a/docs/class/service_mapper.md b/docs/class/service_mapper.md index fca2fda01..64c15d857 100644 --- a/docs/class/service_mapper.md +++ b/docs/class/service_mapper.md @@ -3,7 +3,7 @@ services are mapped. The options selected here get passed to the [Service Mapper](status_service_mapper) tab when you press the *[Map services]* button. -!['Service mapper dialog'](static/img/doc/mapservicesdialog.png) +!['Service mapper dialog'](static/img/doc/service_mapper/dialog.png) See [Services](class/mpegts_service) for more details on service mapping. diff --git a/docs/class/timeshift.md b/docs/class/timeshift.md index be933d441..4c9af2e10 100644 --- a/docs/class/timeshift.md +++ b/docs/class/timeshift.md @@ -1,6 +1,6 @@ This tab is used to configure timeshift properties. -!['Timeshift Tab'](static/img/doc/timeshifttab.png) +!['Timeshift Tab'](static/img/doc/timeshift/tab.png) --- diff --git a/docs/markdown/before_begin.md b/docs/markdown/before_begin.md index 7ef9b00b9..387af8fe1 100644 --- a/docs/markdown/before_begin.md +++ b/docs/markdown/before_begin.md @@ -67,4 +67,4 @@ go and get the signal for you. The following diagram explains the relationship between these components: -![Relationship Between Tuners, Neworks, Muxes, Services and Channels](images/tvh_schematic.png) +![Relationship Between Tuners, Neworks, Muxes, Services and Channels](static/img/doc/before_begin/schematic.png) diff --git a/docs/markdown/doc_update.md b/docs/markdown/doc_update.md index 887552cb9..1be10a78c 100644 --- a/docs/markdown/doc_update.md +++ b/docs/markdown/doc_update.md @@ -1,7 +1,5 @@ ##Updating the Documentation -This information was last updated on 11 May 2016. - The documentation is written in markdown, and then converted for direct inclusion to tvheadend binary. The markdown processor in tvheadend binary adds other information from the internal diff --git a/docs/markdown/epg.md b/docs/markdown/epg.md index 198e3516e..8ecadbaae 100644 --- a/docs/markdown/epg.md +++ b/docs/markdown/epg.md @@ -8,7 +8,7 @@ such as XMLTV. The EPG tab displays a filterable grid containing all events, sorted based on start time. -!['Electronic Program Guide' Tab](static/img/doc/epg.png) +!['Electronic Program Guide' Tab](static/img/doc/epg/tab.png) --- @@ -147,13 +147,13 @@ for recording by clicking on the *[Record program]* button. For EPG providers that supply series link information there will also be a *[Record series]* button that will record all entries in the series. -![EPG Detail 1](static/img/doc/epg2.png) +![EPG Detail 1](static/img/doc/epg/series_link.png) For events without any series link information, an *[Autorec]* button will be provided to create a pseudo-series link using the autorec feature. -![EPG Detail 2](static/img/doc/epg3.png) +![EPG Detail 2](static/img/doc/epg/autorec.png) If you schedule any kind of recording from this point, you can choose a specific DVR profile that will apply to the recording or autorec rule. diff --git a/docs/markdown/inc/add_grid_entry.md b/docs/markdown/inc/add_grid_entry.md deleted file mode 100644 index a1c31a4c8..000000000 --- a/docs/markdown/inc/add_grid_entry.md +++ /dev/null @@ -1,6 +0,0 @@ -###Adding an Entry - -To add an entry click the *[Add]* button from the menu bar, the add -dialog should now be displayed. Once you've filled in the required/desired -fields you can then press *[Save]* to add the entry, *[Apply]* to commit -and continue editing or *[Cancel]* to abort (losing any unsaved changes). diff --git a/docs/markdown/inc/del_grid_entries.md b/docs/markdown/inc/del_grid_entries.md deleted file mode 100644 index ebe44e230..000000000 --- a/docs/markdown/inc/del_grid_entries.md +++ /dev/null @@ -1,13 +0,0 @@ -###Deleting an Entry - -Highlight (select) the desired entries in the grid, then press the *[Delete]* button on the -menu bar. - -**Deleting can't be undone. You will be prompted to confirm. ** - -**Tip**: Rather than deleting an entry, you can disable it instead by -unchecking the "Enabled" check box (if available). - -inc/selecting_entries_tip - -inc/paging_tip diff --git a/docs/markdown/inc/edit_grid_entries.md b/docs/markdown/inc/edit_grid_entries.md deleted file mode 100644 index ce1b5bc8c..000000000 --- a/docs/markdown/inc/edit_grid_entries.md +++ /dev/null @@ -1,30 +0,0 @@ -###Editing an Entry - -There are two methods for editing an entry. - -####Editing in the Grid - -Highlight (select) the desired entry and then..: - -* To edit a cell, double click on it. -* To change a check box or radio button, click once. - -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). - -inc/selecting_entries_tip - -inc/paging_tip - -####Using the *[Edit]* Button - -Highlight (select) the entries in the grid that you'd like to edit, then -click the *[Edit]* button from the menu bar, the edit dialog should now -be displayed. Note that when editing multiple -entries there is an additional check box before each setting, -ticking it will apply that setting to all selected entries. -After you've finished editing an entry you can save your pending changes -using the *[Save]* button (closing the dialog), save your changes and continue making -further adjustments by pressing the *[Apply]* button, or cancel any unsaved -changes (and close the dialog) by pressing the *[Cancel]* button. diff --git a/docs/markdown/inc/selecting_entries_tip.md b/docs/markdown/inc/selecting_entries_tip.md deleted file mode 100644 index aac8177b7..000000000 --- a/docs/markdown/inc/selecting_entries_tip.md +++ /dev/null @@ -1,3 +0,0 @@ -\n**Tip**: You can select all entries within the grid by pressing ctrl+A. -You can also ctrl+click to make additional selections, or shift+click to -select a range. diff --git a/docs/markdown/index.md b/docs/markdown/index.md index d0e37fdc8..a71da1b43 100644 --- a/docs/markdown/index.md +++ b/docs/markdown/index.md @@ -1,6 +1,6 @@ #Tvheadend 4.2 User Guide -![Tvheadend Logo](images/logomid.png) +![Tvheadend Logo](static/img/doc/index/logo.png) #Purpose diff --git a/docs/markdown/overview.md b/docs/markdown/overview.md index b8d8e2cd5..790da0b38 100644 --- a/docs/markdown/overview.md +++ b/docs/markdown/overview.md @@ -5,7 +5,7 @@ Tvheadend is a lightweight, easily-configured, general-purpose TV/video streaming server and recorder (PVR/DVR) for GNU/Linux, FreeBSD and Android. -![Tvheadend interface](images/overall_screenshot.png) +![Tvheadend interface](static/img/doc/overview/screenshot.png) It supports input from: diff --git a/docs/markdown/status_connections.md b/docs/markdown/status_connections.md index 1c36d2faf..f9d606b31 100644 --- a/docs/markdown/status_connections.md +++ b/docs/markdown/status_connections.md @@ -4,7 +4,7 @@ This tab shows information about all active connections. This is a read-only tab; nothing is configurable. -!['Status - Subscriptions' Tab](static/img/doc/status_connections.png) +!['Status - Subscriptions' Tab](static/img/doc/status_connections/tab.png) --- diff --git a/docs/markdown/status_service_mapper.md b/docs/markdown/status_service_mapper.md index f1721b926..384ecb5c7 100644 --- a/docs/markdown/status_service_mapper.md +++ b/docs/markdown/status_service_mapper.md @@ -4,7 +4,7 @@ This tab shows information about current service mapping activity. This is a read-only tab; nothing is configurable. -!['Status - Subscriptions' Tab](static/img/doc/statusservicemapper.png) +!['Status - Subscriptions' Tab](static/img/doc/status_service_mapper/tab.png) The [Map services to channels](class/service_mapper) dialog diff --git a/docs/markdown/status_stream.md b/docs/markdown/status_stream.md index 14e659887..1bfbeb0d2 100644 --- a/docs/markdown/status_stream.md +++ b/docs/markdown/status_stream.md @@ -4,7 +4,7 @@ This tab shows information about all currently-open streams. This is a read-only tab; nothing is configurable. -!['Status - Stream' Tab](static/img/doc/streamtab.png) +!['Status - Stream' Tab](static/img/doc/status_stream/tab.png) --- diff --git a/docs/markdown/status_subscriptions.md b/docs/markdown/status_subscriptions.md index a8d65e75c..ab11e3b06 100644 --- a/docs/markdown/status_subscriptions.md +++ b/docs/markdown/status_subscriptions.md @@ -4,7 +4,7 @@ This tab shows information about all active subscriptions to Tvheadend. This is a read-only tab; nothing is configurable. -!['Status - Subscriptions' Tab](static/img/doc/statussubscriptions.png) +!['Status - Subscriptions' Tab](static/img/doc/status_subscriptions/tab.png) --- diff --git a/docs/markdown/tv_adapters.md b/docs/markdown/tv_adapters.md index 7b974be9a..ab21440d5 100644 --- a/docs/markdown/tv_adapters.md +++ b/docs/markdown/tv_adapters.md @@ -2,7 +2,7 @@ The adapters and tuners are listed and edited in a tree. -!['TV Adapter tree'](static/img/doc/tvadaptertree.png) +!['TV Adapter tree'](static/img/doc/tv_adapters/tree.png) --- @@ -23,7 +23,7 @@ The device tree lists the available frontends, LNB configuration and so on related to your device(s) in sections. Clicking on these sections will display available parameters and device information. -!['TV Adapter params'](static/img/doc/tvadapterparams.png) +!['TV Adapter params'](static/img/doc/tv_adapters/params.png) **Tip**: Remember to save your changes *before* switching panels. diff --git a/docs/markdown/webui_general.md b/docs/markdown/webui_general.md index c98a91501..92f67c41e 100644 --- a/docs/markdown/webui_general.md +++ b/docs/markdown/webui_general.md @@ -9,11 +9,12 @@ make the best of it. 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). +items for a particular topic are below that). However, be aware that not all tabs are +shown by default, some tabs are hidden depending on the current [view level](#view-level). -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. +Each tab is then typically laid out with a menu bar 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 @@ -23,6 +24,19 @@ 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. +####View level + +The *View level* drop-down/button - next to the Help button, +displays/hides the more advanced features. By default it is set to Basic. + +View level | Description +----------------------|------------------------------------------------- +**Basic** | Display the most commonly used tabs/items. +**Advanced** | Display the more advanced tabs/items. +**Expert** | Show all tabs/items. + +Depending on configuration, the view-level drop-down is not always visible. + ###Displaying and Manipulating Columns * Not all columns are necessarily visible. If you hover your mouse over a @@ -44,22 +58,38 @@ that need these values. * **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. +* A cookie is used to remember your column/filtering preferences. Clearing + your cookies will reset the interface to default. -* 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. +###Adding, Editing and More -* Most rows are multi-selectable, so you can carry out certain actions on +* Rows (in the grid) 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. + multiple items by using ctrl+click on each entry or click, + shift+click to select a range, or ctrl+A to select all. + +* To add an entry, click the *Add* button from the menu bar. You'll then + see a dialog, or in some cases (where a list/split panel is used), a + parameter panel. You can now fill in the desired/required fields, the + entry can then be saved (*Create/Save* button), applied (*Apply* button), + or abandoned (*Cancel button). + +* To edit a single entry in the grid, double click on the desired field/cell. + It should now be editable. Once you've made your changes you can then + save (*Save* button), apply (*Apply* button), or abandon (*Cancel* button) + them. + + 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. + + To change a check box or radio button, click once. + +* To edit multiple entries, select the desired entries (as explained above), and + then press the *Edit* button - a dialog will be displayed. You can now make + your changes to each field. These changes can then be kept (*Save* button), + applied (*Apply* button), or abandoned (*Undo* button). Remember to tick the + check box before each field when saving/applying, so that the changes are applied + to all selected entries. + +* To delete entries, simply select the entry/entries and press the *Delete* button. + You will be prompted to confirm deletion. diff --git a/docs/property/viewlevel_access_entries.md b/docs/property/viewlevel_access_entries.md index 0494794a8..9910acf89 100644 --- a/docs/property/viewlevel_access_entries.md +++ b/docs/property/viewlevel_access_entries.md @@ -3,8 +3,6 @@ Option | Description ------------------------|------------ **Default** | Use the default view level value as set in [Base Config](class/config). -**Basic** | Show basic settings/information. -**Advanced** | Show more advanced settings/information. -**Expert** | Show the expert (All) settings/information. - - +**Basic** | Display the most commonly used tabs/items. +**Advanced** | Display the more advanced tabs/items. +**Expert** | Show all tabs/items. diff --git a/src/webui/static/img/doc/accessentriesnewuser.png b/src/webui/static/img/doc/access_entry/new.png similarity index 100% rename from src/webui/static/img/doc/accessentriesnewuser.png rename to src/webui/static/img/doc/access_entry/new.png diff --git a/src/webui/static/img/doc/accessentriesgrid.png b/src/webui/static/img/doc/access_entry/tab.png similarity index 100% rename from src/webui/static/img/doc/accessentriesgrid.png rename to src/webui/static/img/doc/access_entry/tab.png diff --git a/src/webui/static/img/doc/accessconfig.png b/src/webui/static/img/doc/accessconfig.png deleted file mode 100644 index 88048d022..000000000 Binary files a/src/webui/static/img/doc/accessconfig.png and /dev/null differ diff --git a/src/webui/static/img/doc/accessconfigexample.png b/src/webui/static/img/doc/accessconfigexample.png deleted file mode 100644 index 2b0e27ef4..000000000 Binary files a/src/webui/static/img/doc/accessconfigexample.png and /dev/null differ diff --git a/src/webui/static/img/doc/accessipblockingedit.png b/src/webui/static/img/doc/accessipblockingedit.png deleted file mode 100644 index 249542d58..000000000 Binary files a/src/webui/static/img/doc/accessipblockingedit.png and /dev/null differ diff --git a/src/webui/static/img/doc/addchanneltagdialog.png b/src/webui/static/img/doc/addchanneltagdialog.png deleted file mode 100644 index 17a31636e..000000000 Binary files a/src/webui/static/img/doc/addchanneltagdialog.png and /dev/null differ diff --git a/src/webui/static/img/doc/addfilterdialog.png b/src/webui/static/img/doc/addfilterdialog.png deleted file mode 100644 index 32319c2e9..000000000 Binary files a/src/webui/static/img/doc/addfilterdialog.png and /dev/null differ diff --git a/src/webui/static/img/doc/addmuxnetworkselection.png b/src/webui/static/img/doc/addmuxnetworkselection.png deleted file mode 100644 index 1f11308ce..000000000 Binary files a/src/webui/static/img/doc/addmuxnetworkselection.png and /dev/null differ diff --git a/src/webui/static/img/doc/addmuxsched.png b/src/webui/static/img/doc/addmuxsched.png deleted file mode 100644 index 57ebafaac..000000000 Binary files a/src/webui/static/img/doc/addmuxsched.png and /dev/null differ diff --git a/src/webui/static/img/doc/addnewnetwork.png b/src/webui/static/img/doc/addnewnetwork.png deleted file mode 100644 index a79f52b9f..000000000 Binary files a/src/webui/static/img/doc/addnewnetwork.png and /dev/null differ diff --git a/src/webui/static/img/doc/addprofiledialog.png b/src/webui/static/img/doc/addprofiledialog.png deleted file mode 100644 index e96f37ecc..000000000 Binary files a/src/webui/static/img/doc/addprofiledialog.png and /dev/null differ diff --git a/src/webui/static/img/doc/autorec.png b/src/webui/static/img/doc/autorec.png deleted file mode 100644 index 7917c0428..000000000 Binary files a/src/webui/static/img/doc/autorec.png and /dev/null differ diff --git a/src/webui/static/img/doc/autorecpopup.png b/src/webui/static/img/doc/autorecpopup.png deleted file mode 100644 index 31929dc76..000000000 Binary files a/src/webui/static/img/doc/autorecpopup.png and /dev/null differ diff --git a/src/webui/static/img/tvh_schematic.png b/src/webui/static/img/doc/before_begin/schematic.png similarity index 100% rename from src/webui/static/img/tvh_schematic.png rename to src/webui/static/img/doc/before_begin/schematic.png diff --git a/src/webui/static/img/doc/bouquetadd.png b/src/webui/static/img/doc/bouquet/add.png similarity index 100% rename from src/webui/static/img/doc/bouquetadd.png rename to src/webui/static/img/doc/bouquet/add.png diff --git a/src/webui/static/img/doc/mapallserviceschannels.png b/src/webui/static/img/doc/bouquet/detach.png similarity index 100% rename from src/webui/static/img/doc/mapallserviceschannels.png rename to src/webui/static/img/doc/bouquet/detach.png diff --git a/src/webui/static/img/doc/bouquettab.png b/src/webui/static/img/doc/bouquet/tab.png similarity index 100% rename from src/webui/static/img/doc/bouquettab.png rename to src/webui/static/img/doc/bouquet/tab.png diff --git a/src/webui/static/img/doc/caclientconfig.png b/src/webui/static/img/doc/caclient/tab.png similarity index 100% rename from src/webui/static/img/doc/caclientconfig.png rename to src/webui/static/img/doc/caclient/tab.png diff --git a/src/webui/static/img/doc/addchanneldialog.png b/src/webui/static/img/doc/channel/add.png similarity index 100% rename from src/webui/static/img/doc/addchanneldialog.png rename to src/webui/static/img/doc/channel/add.png diff --git a/src/webui/static/img/doc/configchannellist.png b/src/webui/static/img/doc/channel/tab.png similarity index 100% rename from src/webui/static/img/doc/configchannellist.png rename to src/webui/static/img/doc/channel/tab.png diff --git a/src/webui/static/img/doc/channeleditmultiple.png b/src/webui/static/img/doc/channeleditmultiple.png deleted file mode 100644 index a039940f1..000000000 Binary files a/src/webui/static/img/doc/channeleditmultiple.png and /dev/null differ diff --git a/src/webui/static/img/doc/channeleditsingle.png b/src/webui/static/img/doc/channeleditsingle.png deleted file mode 100644 index 91b975e7f..000000000 Binary files a/src/webui/static/img/doc/channeleditsingle.png and /dev/null differ diff --git a/src/webui/static/img/doc/channeltab.png b/src/webui/static/img/doc/channeltab.png deleted file mode 100644 index 079d00f30..000000000 Binary files a/src/webui/static/img/doc/channeltab.png and /dev/null differ diff --git a/src/webui/static/img/doc/channeltags.png b/src/webui/static/img/doc/channeltag/tab.png similarity index 100% rename from src/webui/static/img/doc/channeltags.png rename to src/webui/static/img/doc/channeltag/tab.png diff --git a/src/webui/static/img/doc/configbaseall.png b/src/webui/static/img/doc/config/tab.png similarity index 100% rename from src/webui/static/img/doc/configbaseall.png rename to src/webui/static/img/doc/config/tab.png diff --git a/src/webui/static/img/doc/configaddmuxexample.png b/src/webui/static/img/doc/configaddmuxexample.png deleted file mode 100644 index f1b6ef20f..000000000 Binary files a/src/webui/static/img/doc/configaddmuxexample.png and /dev/null differ diff --git a/src/webui/static/img/doc/configcaadd.png b/src/webui/static/img/doc/configcaadd.png deleted file mode 100644 index a14344cdb..000000000 Binary files a/src/webui/static/img/doc/configcaadd.png and /dev/null differ diff --git a/src/webui/static/img/doc/configcapmt.png b/src/webui/static/img/doc/configcapmt.png deleted file mode 100644 index 68d8ff3b6..000000000 Binary files a/src/webui/static/img/doc/configcapmt.png and /dev/null differ diff --git a/src/webui/static/img/doc/configcwc.png b/src/webui/static/img/doc/configcwc.png deleted file mode 100644 index 785241366..000000000 Binary files a/src/webui/static/img/doc/configcwc.png and /dev/null differ diff --git a/src/webui/static/img/doc/configdvbmuxsched1.png b/src/webui/static/img/doc/configdvbmuxsched1.png deleted file mode 100644 index adaed4235..000000000 Binary files a/src/webui/static/img/doc/configdvbmuxsched1.png and /dev/null differ diff --git a/src/webui/static/img/doc/configdvbnetwork.png b/src/webui/static/img/doc/configdvbnetwork.png deleted file mode 100644 index 40e708415..000000000 Binary files a/src/webui/static/img/doc/configdvbnetwork.png and /dev/null differ diff --git a/src/webui/static/img/doc/configdvbnetwork_iptv.png b/src/webui/static/img/doc/configdvbnetwork_iptv.png deleted file mode 100644 index 9d7c6c55c..000000000 Binary files a/src/webui/static/img/doc/configdvbnetwork_iptv.png and /dev/null differ diff --git a/src/webui/static/img/doc/configdvbnetwork_iptvauto.png b/src/webui/static/img/doc/configdvbnetwork_iptvauto.png deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/webui/static/img/doc/configdvbtab.png b/src/webui/static/img/doc/configdvbtab.png deleted file mode 100644 index a25b689b7..000000000 Binary files a/src/webui/static/img/doc/configdvbtab.png and /dev/null differ diff --git a/src/webui/static/img/doc/configdvrtab1.png b/src/webui/static/img/doc/configdvrtab1.png deleted file mode 100644 index adfd5d1cb..000000000 Binary files a/src/webui/static/img/doc/configdvrtab1.png and /dev/null differ diff --git a/src/webui/static/img/doc/configdvrtab2.png b/src/webui/static/img/doc/configdvrtab2.png deleted file mode 100644 index b3b5a55dd..000000000 Binary files a/src/webui/static/img/doc/configdvrtab2.png and /dev/null differ diff --git a/src/webui/static/img/doc/configdvrtab3.png b/src/webui/static/img/doc/configdvrtab3.png deleted file mode 100644 index 622f56b3c..000000000 Binary files a/src/webui/static/img/doc/configdvrtab3.png and /dev/null differ diff --git a/src/webui/static/img/doc/configgeneraltab1.png b/src/webui/static/img/doc/configgeneraltab1.png deleted file mode 100644 index b7f1f8202..000000000 Binary files a/src/webui/static/img/doc/configgeneraltab1.png and /dev/null differ diff --git a/src/webui/static/img/doc/configgeneraltab2.png b/src/webui/static/img/doc/configgeneraltab2.png deleted file mode 100644 index 4cbdf1310..000000000 Binary files a/src/webui/static/img/doc/configgeneraltab2.png and /dev/null differ diff --git a/src/webui/static/img/doc/configtabs.png b/src/webui/static/img/doc/configtabs.png deleted file mode 100644 index aae860918..000000000 Binary files a/src/webui/static/img/doc/configtabs.png and /dev/null differ diff --git a/src/webui/static/img/doc/configtimeshifttab.png b/src/webui/static/img/doc/configtimeshifttab.png deleted file mode 100644 index 4ab3f1117..000000000 Binary files a/src/webui/static/img/doc/configtimeshifttab.png and /dev/null differ diff --git a/src/webui/static/img/doc/configtvadapters.png b/src/webui/static/img/doc/configtvadapters.png deleted file mode 100644 index 194b25c2f..000000000 Binary files a/src/webui/static/img/doc/configtvadapters.png and /dev/null differ diff --git a/src/webui/static/img/doc/configtvhlog.png b/src/webui/static/img/doc/configtvhlog.png deleted file mode 100644 index e7ce259a5..000000000 Binary files a/src/webui/static/img/doc/configtvhlog.png and /dev/null differ diff --git a/src/webui/static/img/doc/debuggingtab.png b/src/webui/static/img/doc/debugging/tab.png similarity index 100% rename from src/webui/static/img/doc/debuggingtab.png rename to src/webui/static/img/doc/debugging/tab.png diff --git a/src/webui/static/img/doc/dvbnetworkedit.png b/src/webui/static/img/doc/dvbnetworkedit.png deleted file mode 100644 index a1210c620..000000000 Binary files a/src/webui/static/img/doc/dvbnetworkedit.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvbsatconf.png b/src/webui/static/img/doc/dvbsatconf.png deleted file mode 100644 index d133141b0..000000000 Binary files a/src/webui/static/img/doc/dvbsatconf.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvrautorecadd.png b/src/webui/static/img/doc/dvrautorec/add.png similarity index 100% rename from src/webui/static/img/doc/dvrautorecadd.png rename to src/webui/static/img/doc/dvrautorec/add.png diff --git a/src/webui/static/img/doc/dvrautorecentries.png b/src/webui/static/img/doc/dvrautorec/tab.png similarity index 100% rename from src/webui/static/img/doc/dvrautorecentries.png rename to src/webui/static/img/doc/dvrautorec/tab.png diff --git a/src/webui/static/img/doc/dvrprofiles.png b/src/webui/static/img/doc/dvrconfig/tab.png similarity index 100% rename from src/webui/static/img/doc/dvrprofiles.png rename to src/webui/static/img/doc/dvrconfig/tab.png diff --git a/src/webui/static/img/doc/addnewrecentry.png b/src/webui/static/img/doc/dvrentry/add.png similarity index 100% rename from src/webui/static/img/doc/addnewrecentry.png rename to src/webui/static/img/doc/dvrentry/add.png diff --git a/src/webui/static/img/doc/configdvrtabs4.png b/src/webui/static/img/doc/dvrentry/tab.png similarity index 100% rename from src/webui/static/img/doc/configdvrtabs4.png rename to src/webui/static/img/doc/dvrentry/tab.png diff --git a/src/webui/static/img/doc/dvrlog.png b/src/webui/static/img/doc/dvrlog.png deleted file mode 100644 index 8b40a178e..000000000 Binary files a/src/webui/static/img/doc/dvrlog.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvrlog2.png b/src/webui/static/img/doc/dvrlog2.png deleted file mode 100644 index ae4c0e57c..000000000 Binary files a/src/webui/static/img/doc/dvrlog2.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvrlog3.png b/src/webui/static/img/doc/dvrlog3.png deleted file mode 100644 index 76080d35c..000000000 Binary files a/src/webui/static/img/doc/dvrlog3.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvrlog4.png b/src/webui/static/img/doc/dvrlog4.png deleted file mode 100644 index f4ae5b6ba..000000000 Binary files a/src/webui/static/img/doc/dvrlog4.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvrlogentry.png b/src/webui/static/img/doc/dvrlogentry.png deleted file mode 100644 index 52e8338bd..000000000 Binary files a/src/webui/static/img/doc/dvrlogentry.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvrnewprofile.png b/src/webui/static/img/doc/dvrnewprofile.png deleted file mode 100644 index 27d07d27f..000000000 Binary files a/src/webui/static/img/doc/dvrnewprofile.png and /dev/null differ diff --git a/src/webui/static/img/doc/dvrtimeradd.png b/src/webui/static/img/doc/dvrtimerec/add.png similarity index 100% rename from src/webui/static/img/doc/dvrtimeradd.png rename to src/webui/static/img/doc/dvrtimerec/add.png diff --git a/src/webui/static/img/doc/timers.png b/src/webui/static/img/doc/dvrtimerec/tab.png similarity index 100% rename from src/webui/static/img/doc/timers.png rename to src/webui/static/img/doc/dvrtimerec/tab.png diff --git a/src/webui/static/img/doc/editautorec.png b/src/webui/static/img/doc/editautorec.png deleted file mode 100644 index 40bbace54..000000000 Binary files a/src/webui/static/img/doc/editautorec.png and /dev/null differ diff --git a/src/webui/static/img/doc/epg3.png b/src/webui/static/img/doc/epg/autorec.png similarity index 100% rename from src/webui/static/img/doc/epg3.png rename to src/webui/static/img/doc/epg/autorec.png diff --git a/src/webui/static/img/doc/epg2.png b/src/webui/static/img/doc/epg/series_link.png similarity index 100% rename from src/webui/static/img/doc/epg2.png rename to src/webui/static/img/doc/epg/series_link.png diff --git a/src/webui/static/img/doc/epg.png b/src/webui/static/img/doc/epg/tab.png similarity index 100% rename from src/webui/static/img/doc/epg.png rename to src/webui/static/img/doc/epg/tab.png diff --git a/src/webui/static/img/doc/epggrabberconfig.png b/src/webui/static/img/doc/epgconf/tab.png similarity index 100% rename from src/webui/static/img/doc/epggrabberconfig.png rename to src/webui/static/img/doc/epgconf/tab.png diff --git a/src/webui/static/img/doc/epggrabberchannels.png b/src/webui/static/img/doc/epggrabber_channel/tab.png similarity index 100% rename from src/webui/static/img/doc/epggrabberchannels.png rename to src/webui/static/img/doc/epggrabber_channel/tab.png diff --git a/src/webui/static/img/doc/epggrabmodules.png b/src/webui/static/img/doc/epggrabber_modules/tab.png similarity index 100% rename from src/webui/static/img/doc/epggrabmodules.png rename to src/webui/static/img/doc/epggrabber_modules/tab.png diff --git a/src/webui/static/img/doc/failedrecordings1.png b/src/webui/static/img/doc/failedrecordings1.png deleted file mode 100644 index c2ec6627c..000000000 Binary files a/src/webui/static/img/doc/failedrecordings1.png and /dev/null differ diff --git a/src/webui/static/img/doc/failedrecordings2.png b/src/webui/static/img/doc/failedrecordings2.png deleted file mode 100644 index 8bbefa9b3..000000000 Binary files a/src/webui/static/img/doc/failedrecordings2.png and /dev/null differ diff --git a/src/webui/static/img/doc/filterexample.png b/src/webui/static/img/doc/filters/example.png similarity index 100% rename from src/webui/static/img/doc/filterexample.png rename to src/webui/static/img/doc/filters/example.png diff --git a/src/webui/static/img/doc/streamfiltertab.png b/src/webui/static/img/doc/filters/tab.png similarity index 100% rename from src/webui/static/img/doc/streamfiltertab.png rename to src/webui/static/img/doc/filters/tab.png diff --git a/src/webui/static/img/doc/finishedrecordings1.png b/src/webui/static/img/doc/finishedrecordings1.png deleted file mode 100644 index 29ce05df4..000000000 Binary files a/src/webui/static/img/doc/finishedrecordings1.png and /dev/null differ diff --git a/src/webui/static/img/doc/finishedrecordings2.png b/src/webui/static/img/doc/finishedrecordings2.png deleted file mode 100644 index b95c1e961..000000000 Binary files a/src/webui/static/img/doc/finishedrecordings2.png and /dev/null differ diff --git a/src/webui/static/img/doc/icons b/src/webui/static/img/doc/icons new file mode 120000 index 000000000..fc54c5dfa --- /dev/null +++ b/src/webui/static/img/doc/icons @@ -0,0 +1 @@ +../../../../webui/static/icons \ No newline at end of file diff --git a/src/webui/static/img/doc/configimagecache.png b/src/webui/static/img/doc/imagecache/tab.png similarity index 100% rename from src/webui/static/img/doc/configimagecache.png rename to src/webui/static/img/doc/imagecache/tab.png diff --git a/src/webui/static/img/doc/index/logo.png b/src/webui/static/img/doc/index/logo.png new file mode 100644 index 000000000..221657181 Binary files /dev/null and b/src/webui/static/img/doc/index/logo.png differ diff --git a/src/webui/static/img/doc/accessconfigipblockentries.png b/src/webui/static/img/doc/ipblocking/tab.png similarity index 100% rename from src/webui/static/img/doc/accessconfigipblockentries.png rename to src/webui/static/img/doc/ipblocking/tab.png diff --git a/src/webui/static/img/doc/dvbcfrontendparams.png b/src/webui/static/img/doc/linuxdvb_frontend_dvbc/tab.png similarity index 100% rename from src/webui/static/img/doc/dvbcfrontendparams.png rename to src/webui/static/img/doc/linuxdvb_frontend_dvbc/tab.png diff --git a/src/webui/static/img/doc/dvbsfrontendparams.png b/src/webui/static/img/doc/linuxdvb_frontend_dvbs/tab.png similarity index 100% rename from src/webui/static/img/doc/dvbsfrontendparams.png rename to src/webui/static/img/doc/linuxdvb_frontend_dvbs/tab.png diff --git a/src/webui/static/img/doc/dvbtfrontendparams.png b/src/webui/static/img/doc/linuxdvb_frontend_dvbt/tab.png similarity index 100% rename from src/webui/static/img/doc/dvbtfrontendparams.png rename to src/webui/static/img/doc/linuxdvb_frontend_dvbt/tab.png diff --git a/src/webui/static/img/doc/configdvbmux.png b/src/webui/static/img/doc/mpegts_mux/tab.png similarity index 100% rename from src/webui/static/img/doc/configdvbmux.png rename to src/webui/static/img/doc/mpegts_mux/tab.png diff --git a/src/webui/static/img/doc/configdvbmuxsched.png b/src/webui/static/img/doc/mpegts_mux_sched/tab.png similarity index 100% rename from src/webui/static/img/doc/configdvbmuxsched.png rename to src/webui/static/img/doc/mpegts_mux_sched/tab.png diff --git a/src/webui/static/img/doc/dvbinputsnetwork.png b/src/webui/static/img/doc/mpegts_network/tab.png similarity index 100% rename from src/webui/static/img/doc/dvbinputsnetwork.png rename to src/webui/static/img/doc/mpegts_network/tab.png diff --git a/src/webui/static/img/doc/addservicetochannel.png b/src/webui/static/img/doc/mpegts_service/add_service.png similarity index 100% rename from src/webui/static/img/doc/addservicetochannel.png rename to src/webui/static/img/doc/mpegts_service/add_service.png diff --git a/src/webui/static/img/doc/mapservicesall.png b/src/webui/static/img/doc/mpegts_service/map_all.png similarity index 100% rename from src/webui/static/img/doc/mapservicesall.png rename to src/webui/static/img/doc/mpegts_service/map_all.png diff --git a/src/webui/static/img/doc/mapselectedservices.png b/src/webui/static/img/doc/mpegts_service/map_selected.png similarity index 100% rename from src/webui/static/img/doc/mapselectedservices.png rename to src/webui/static/img/doc/mpegts_service/map_selected.png diff --git a/src/webui/static/img/doc/servicefilter.png b/src/webui/static/img/doc/mpegts_service/service_filter.png similarity index 100% rename from src/webui/static/img/doc/servicefilter.png rename to src/webui/static/img/doc/mpegts_service/service_filter.png diff --git a/src/webui/static/img/doc/serviceinfo.png b/src/webui/static/img/doc/mpegts_service/service_info.png similarity index 100% rename from src/webui/static/img/doc/serviceinfo.png rename to src/webui/static/img/doc/mpegts_service/service_info.png diff --git a/src/webui/static/img/doc/configdvbservices.png b/src/webui/static/img/doc/mpegts_service/tab.png similarity index 100% rename from src/webui/static/img/doc/configdvbservices.png rename to src/webui/static/img/doc/mpegts_service/tab.png diff --git a/src/webui/static/img/doc/muxbylocation.png b/src/webui/static/img/doc/muxbylocation.png deleted file mode 100644 index be3fca661..000000000 Binary files a/src/webui/static/img/doc/muxbylocation.png and /dev/null differ diff --git a/src/webui/static/img/doc/networktypeselect.png b/src/webui/static/img/doc/networktypeselect.png deleted file mode 100644 index ad42e09e4..000000000 Binary files a/src/webui/static/img/doc/networktypeselect.png and /dev/null differ diff --git a/src/webui/static/img/overall_screenshot.png b/src/webui/static/img/doc/overview/screenshot.png similarity index 100% rename from src/webui/static/img/overall_screenshot.png rename to src/webui/static/img/doc/overview/screenshot.png diff --git a/src/webui/static/img/doc/configpasswdadd.png b/src/webui/static/img/doc/passwd/add.png similarity index 100% rename from src/webui/static/img/doc/configpasswdadd.png rename to src/webui/static/img/doc/passwd/add.png diff --git a/src/webui/static/img/doc/configpasswordentries.png b/src/webui/static/img/doc/passwd/tab.png similarity index 100% rename from src/webui/static/img/doc/configpasswordentries.png rename to src/webui/static/img/doc/passwd/tab.png diff --git a/src/webui/static/img/doc/configstreamprofiles.png b/src/webui/static/img/doc/profile/tab.png similarity index 100% rename from src/webui/static/img/doc/configstreamprofiles.png rename to src/webui/static/img/doc/profile/tab.png diff --git a/src/webui/static/img/doc/satipclient.png b/src/webui/static/img/doc/satip_client/tab.png similarity index 100% rename from src/webui/static/img/doc/satipclient.png rename to src/webui/static/img/doc/satip_client/tab.png diff --git a/src/webui/static/img/doc/satipconfig.png b/src/webui/static/img/doc/satip_server/tab.png similarity index 100% rename from src/webui/static/img/doc/satipconfig.png rename to src/webui/static/img/doc/satip_server/tab.png diff --git a/src/webui/static/img/doc/mapservicesdialog.png b/src/webui/static/img/doc/service_mapper/dialog.png similarity index 100% rename from src/webui/static/img/doc/mapservicesdialog.png rename to src/webui/static/img/doc/service_mapper/dialog.png diff --git a/src/webui/static/img/doc/serviceedit.png b/src/webui/static/img/doc/serviceedit.png deleted file mode 100644 index 943652dac..000000000 Binary files a/src/webui/static/img/doc/serviceedit.png and /dev/null differ diff --git a/src/webui/static/img/doc/serviceedit2.png b/src/webui/static/img/doc/serviceedit2.png deleted file mode 100644 index ee90b0d18..000000000 Binary files a/src/webui/static/img/doc/serviceedit2.png and /dev/null differ diff --git a/src/webui/static/img/doc/status_connections.png b/src/webui/static/img/doc/status_connections/tab.png similarity index 100% rename from src/webui/static/img/doc/status_connections.png rename to src/webui/static/img/doc/status_connections/tab.png diff --git a/src/webui/static/img/doc/statusservicemapper.png b/src/webui/static/img/doc/status_service_mapper/tab.png similarity index 100% rename from src/webui/static/img/doc/statusservicemapper.png rename to src/webui/static/img/doc/status_service_mapper/tab.png diff --git a/src/webui/static/img/doc/streamtab.png b/src/webui/static/img/doc/status_stream/tab.png similarity index 100% rename from src/webui/static/img/doc/streamtab.png rename to src/webui/static/img/doc/status_stream/tab.png diff --git a/src/webui/static/img/doc/statussubscriptions.png b/src/webui/static/img/doc/status_subscriptions/tab.png similarity index 100% rename from src/webui/static/img/doc/statussubscriptions.png rename to src/webui/static/img/doc/status_subscriptions/tab.png diff --git a/src/webui/static/img/doc/streamprofiletypeselect.png b/src/webui/static/img/doc/streamprofiletypeselect.png deleted file mode 100644 index 2420bc99a..000000000 Binary files a/src/webui/static/img/doc/streamprofiletypeselect.png and /dev/null differ diff --git a/src/webui/static/img/doc/tagstab.png b/src/webui/static/img/doc/tagstab.png deleted file mode 100644 index a363e3e30..000000000 Binary files a/src/webui/static/img/doc/tagstab.png and /dev/null differ diff --git a/src/webui/static/img/doc/timeschedules.png b/src/webui/static/img/doc/timeschedules.png deleted file mode 100644 index 8d9ec53aa..000000000 Binary files a/src/webui/static/img/doc/timeschedules.png and /dev/null differ diff --git a/src/webui/static/img/doc/timeshifttab.png b/src/webui/static/img/doc/timeshift/tab.png similarity index 100% rename from src/webui/static/img/doc/timeshifttab.png rename to src/webui/static/img/doc/timeshift/tab.png diff --git a/src/webui/static/img/doc/tvadapterparams.png b/src/webui/static/img/doc/tv_adapters/params.png similarity index 100% rename from src/webui/static/img/doc/tvadapterparams.png rename to src/webui/static/img/doc/tv_adapters/params.png diff --git a/src/webui/static/img/doc/tvadaptertree.png b/src/webui/static/img/doc/tv_adapters/tree.png similarity index 100% rename from src/webui/static/img/doc/tvadaptertree.png rename to src/webui/static/img/doc/tv_adapters/tree.png diff --git a/src/webui/static/img/doc/upcomingrecordings1.png b/src/webui/static/img/doc/upcomingrecordings1.png deleted file mode 100644 index caccb0d26..000000000 Binary files a/src/webui/static/img/doc/upcomingrecordings1.png and /dev/null differ diff --git a/src/webui/static/img/doc/upcomingrecordings2.png b/src/webui/static/img/doc/upcomingrecordings2.png deleted file mode 100644 index ceaab3ff2..000000000 Binary files a/src/webui/static/img/doc/upcomingrecordings2.png and /dev/null differ diff --git a/src/webui/static/img/doc/upcomingrecordings3.png b/src/webui/static/img/doc/upcomingrecordings3.png deleted file mode 100644 index 655a2837f..000000000 Binary files a/src/webui/static/img/doc/upcomingrecordings3.png and /dev/null differ diff --git a/src/webui/static/img/doc/xmltvtab.png b/src/webui/static/img/doc/xmltvtab.png deleted file mode 100644 index df5c4df87..000000000 Binary files a/src/webui/static/img/doc/xmltvtab.png and /dev/null differ