From: mpmc Date: Mon, 4 Dec 2017 15:27:18 +0000 (+0000) Subject: mdhelp: even more help refresh - I'm starting to run out of commit messages ;) X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6705fe272ba5112ce4d17bd6b4d19afb10b55292;p=thirdparty%2Ftvheadend.git mdhelp: even more help refresh - I'm starting to run out of commit messages ;) --- diff --git a/docs/class/mpegts_service.md b/docs/class/mpegts_service.md index 77ae6f26e..870f0ae00 100644 --- a/docs/class/mpegts_service.md +++ b/docs/class/mpegts_service.md @@ -1,10 +1,5 @@ -Contents | Description --------------------------------------------|------------------------ -[Overview](#overview) | Tab overview -[Service information](#service-information)| How to display service information -[Items/Properties](#items) | Items and Properties -[Return to DVB Inputs](dvbinputs) +inc/service_contents --- diff --git a/docs/class/service_mapper.md b/docs/class/service_mapper.md index d4a3693e8..4dbe602f0 100644 --- a/docs/class/service_mapper.md +++ b/docs/class/service_mapper.md @@ -1,22 +1,23 @@ + +inc/service_contents + +--- + +## Overview + The map services to channels dialog allows you to control which 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/service_mapper/dialog.png) +!['Service mapper'](static/img/doc/dvbinputs/service_mapper_dialog.png) See [Services](class/mpegts_service) for more details on service mapping. --- -### Buttons - -The following functions are available: +## Buttons -Button | Function --------------------|--------- -**Cancel** | Cancel mapping and close the dialog. -**Map Services** | Map the services. -inc/common_button_table_end +inc/buttons --- diff --git a/docs/markdown/inc/service_contents.md b/docs/markdown/inc/service_contents.md new file mode 100644 index 000000000..0f37d6121 --- /dev/null +++ b/docs/markdown/inc/service_contents.md @@ -0,0 +1,8 @@ +Contents | Description +----------------------------------------------------|------------------------ +[Overview](#overview) | Tab overview +[Service information](#service-information) | How to display service information +[Service Mapper Dialog](class/service_mapper) | Service mapping option(s) dialog +[Items/Properties](#items) | Items and Properties + +[Return to DVB Inputs](dvbinputs) diff --git a/docs/markdown/inc/status_contents.md b/docs/markdown/inc/status_contents.md new file mode 100644 index 000000000..46250056f --- /dev/null +++ b/docs/markdown/inc/status_contents.md @@ -0,0 +1,9 @@ +Contents | Description +--------------------------------------------------|------------------------ +[Overview](#overview) | Tab overview +[Stream](status_stream) | Currently-active streams +[Subscriptions](status_subscriptions) | Active subscriptions +[Connections](status_connections) | Connection information +[Service Mapper Dialog](class/service_mapper) | Service mapping dialog +[Service Mapper](status_service_mapper) | Service mapping status +[Items/Properties](#items) | Items/Properties diff --git a/docs/markdown/status_connections.md b/docs/markdown/status_connections.md index b21be118d..f5e271084 100644 --- a/docs/markdown/status_connections.md +++ b/docs/markdown/status_connections.md @@ -1,26 +1,26 @@ -## Status - Connections +# Status - Connections + +inc/status_contents + +--- + +## Overview 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/tab.png) +!['Status - Connections' Tab](static/img/doc/status/connections.png) --- -### Menu Bar/Buttons - -The following functions are available: +## Buttons -Button | Function ------------|--------- -**Help** | Display this help page. +inc/buttons --- -### Grid Items - -The main grid items have the following functions: +## Items **Cancel Icon !['Cancel'](static/icons/cancel.png)** : Forcefully kill the connection. Note that many applications such as Kodi will automatically reconnect when a connection is dropped. diff --git a/docs/markdown/status_service_mapper.md b/docs/markdown/status_service_mapper.md index 97e53bed7..811eb224f 100644 --- a/docs/markdown/status_service_mapper.md +++ b/docs/markdown/status_service_mapper.md @@ -1,10 +1,16 @@ -## Service Mapper +# Service Mapper + +inc/status_contents + +--- + +# Overview This tab shows information about current service mapping activity. This is a read-only tab; nothing is configurable. -!['Status - Subscriptions' Tab](static/img/doc/status_service_mapper/tab.png) +!['Status - Service mapper'](static/img/doc/status/service_mapper.png) The [Map services to channels](class/service_mapper) dialog @@ -12,17 +18,7 @@ determines how services are mapped. --- -### Menu Bar/Buttons - -The following functions are available: - -Button | Function ------------|--------- -**Help** | Display this help page. - ---- - -### Items +## Items **Mapped** : Number of services mapped. diff --git a/docs/markdown/status_stream.md b/docs/markdown/status_stream.md index b3c92e69e..63ebd76ca 100644 --- a/docs/markdown/status_stream.md +++ b/docs/markdown/status_stream.md @@ -1,26 +1,26 @@ -## Status - Stream +# Status - Stream + +inc/status_contents + +--- + +## Overview This tab shows information about all currently-open streams. This is a read-only tab; nothing is configurable. -!['Status - Stream' Tab](static/img/doc/status_stream/tab.png) +!['Status - Stream' Tab](static/img/doc/status/stream.png) --- -### Menu Bar/Buttons +## Buttons -The following functions are available: - -Button | Function ---------------|--------- -**Help** | Display this help page. +inc/buttons --- -### Items - -The main grid items have the following functions: +## Items **Sweep/Clean Icon !['Status - Stream' Tab](static/icons/clean.png)** : Clear all "Uncorrected Blocks", "BER", etc stats. @@ -64,4 +64,3 @@ the value here can sometimes be ambiguous. **Signal Strength** : The signal strength as reported by the device, note that not all devices supply correct signal information, the value here can sometimes be ambiguous - diff --git a/docs/markdown/status_subscriptions.md b/docs/markdown/status_subscriptions.md index 0cdb4e8fe..c3a37ecf0 100644 --- a/docs/markdown/status_subscriptions.md +++ b/docs/markdown/status_subscriptions.md @@ -1,26 +1,26 @@ -## Status - Subscriptions +# Status - Subscriptions + +inc/status_contents + +--- + +## Overview 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/status_subscriptions/tab.png) +!['Status - Subscriptions' Tab](static/img/doc/status/subscriptions.png) --- -### Menu Bar/Buttons - -The following functions are available: +## Buttons -Button | Function ------------|--------- -**Help** | Display this help page. +inc/buttons --- -#### Items - -The main grid items have the following functions: +## Items **ID** : Subscription ID. diff --git a/docs/markdown/toc.md b/docs/markdown/toc.md index c36876a34..1de8d4789 100644 --- a/docs/markdown/toc.md +++ b/docs/markdown/toc.md @@ -21,14 +21,7 @@ Web Interface Guide - [Recording (Profiles/Timeshift)](class/dvrconfig) - [Conditional Access (CA)](class/caclient) - [Debugging](class/tvhlog_conf) - - - Status - - * [Stream](status_stream) - * [Subscriptions](status_subscriptions) - * [Connections](status_connections) - * [Server Mapper](status_service_mapper) - + - [Status](status_stream) - [About](webui_about) Appendices diff --git a/src/webui/static/img/doc/service_mapper/dialog.png b/src/webui/static/img/doc/dvbinputs/service_mapper_dialog.png similarity index 100% rename from src/webui/static/img/doc/service_mapper/dialog.png rename to src/webui/static/img/doc/dvbinputs/service_mapper_dialog.png diff --git a/src/webui/static/img/doc/status_connections/tab.png b/src/webui/static/img/doc/status/connections.png similarity index 100% rename from src/webui/static/img/doc/status_connections/tab.png rename to src/webui/static/img/doc/status/connections.png diff --git a/src/webui/static/img/doc/status_service_mapper/tab.png b/src/webui/static/img/doc/status/service_mapper.png similarity index 100% rename from src/webui/static/img/doc/status_service_mapper/tab.png rename to src/webui/static/img/doc/status/service_mapper.png diff --git a/src/webui/static/img/doc/status_stream/tab.png b/src/webui/static/img/doc/status/stream.png similarity index 100% rename from src/webui/static/img/doc/status_stream/tab.png rename to src/webui/static/img/doc/status/stream.png diff --git a/src/webui/static/img/doc/status_subscriptions/tab.png b/src/webui/static/img/doc/status/subscriptions.png similarity index 100% rename from src/webui/static/img/doc/status_subscriptions/tab.png rename to src/webui/static/img/doc/status/subscriptions.png