Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: add (full) screenshot of Configuration -> Base mdhelp: remove…
… additional title from imagecache mdhelp: add help docs to some config properties
  • Loading branch information
Mark Clarkstone authored and perexg committed Apr 14, 2016
1 parent f4f261d commit 8814922
Show file tree
Hide file tree
Showing 8 changed files with 88 additions and 14 deletions.
4 changes: 1 addition & 3 deletions docs/class/config.md
@@ -1,6 +1,4 @@
##Configuration - General

This tabs allow configuration of several general parameters that affect
the core Tvheadend functionality.

!['General' Tab Screenshot 1](docresources/configgeneraltab.png)
!['General Base' Tab Screenshot 1](docresources/configbaseall.png)
2 changes: 0 additions & 2 deletions docs/class/imagecache.md
@@ -1,5 +1,3 @@
##Configuration - Image Cache

This will cache any channel icons or other images (such as EPG metadata)
to be served from the local webserver. This can be useful for
multi-client systems and, generally, to reduce hits on upstream
Expand Down
Binary file added docs/docresources/configbaseall.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/property/config_channelicon_path.md
@@ -0,0 +1,8 @@
: The following placeholders are available:

Placeholder | Function
:----------:| --------
**%C** | The transliterated channel name in ASCII (safe characters, no spaces, etc. - so `Das Erste HD` will be `Das_Erste_HD`, but `WDR Köln` will be `WDR_Koln`)
**%c** | The channel name (URL encoded ASCII)

Example: `file:///tmp/icons/%C.png` or `http://example.com/%c.png`
26 changes: 26 additions & 0 deletions docs/property/config_channelname_scheme.md
@@ -0,0 +1,26 @@
:

Note that you must correctly set the *channel icon path* (above) for
this option to take effect/generate icon filenames. You may need to use
the *[Reset Icon]* button in
*Configuration -> Channel / EPG -> Channels* to trigger filename
(re-)generation.

Scheme | Description
-----------------------|-------------------
No Scheme | Use service name "as is" to generate the filename.
All lower-case | Generate lower-case filenames.
Service name picons | Generate lower-case filenames using picon formatting.

When using *No Scheme* or *All lower-case* - spaces are replaced with
underscores `_` and non-alphanumeric characters are URL encoded.

When using the *service name picon scheme* - some characters will be
replaced:

Char | Replacement
-----------------------|----------------------
`*` | star
`+` | plus
` ` (space) | None (it's removed).

6 changes: 6 additions & 0 deletions docs/property/config_picon_path.md
@@ -0,0 +1,6 @@
This can be named however you wish, as either a local (file://) or
remote (http://) location - however, remember that it’s pointing to a
directory as the picon names are automatically generated from the
service parameters frequency, orbital position, etc.).

Example: `file:///home/hts/picons`
4 changes: 4 additions & 0 deletions docs/property/config_picon_servicetype.md
@@ -0,0 +1,4 @@
:
If your picon pack uses filenames that start with "1_0_1_xxxx" you'll want to
use the *force service type to 1* setting. If your filenames use the
standard naming scheme e.g "1_0_19_xxxx" leave it as standard.
52 changes: 43 additions & 9 deletions src/config.c
Expand Up @@ -1968,12 +1968,40 @@ config_muxconfpath_notify ( void *o, const char *lang )
#endif
}

static char *
config_channelicon_path_doc(const struct property *p, const char *lang)
{
extern const char *tvh_doc_config_channelicon_path_property[];
return prop_md_doc(tvh_doc_config_channelicon_path_property, lang);
}

static char *
config_channelname_scheme_doc(const struct property *p, const char *lang)
{
extern const char *tvh_doc_config_channelname_scheme_property[];
return prop_md_doc(tvh_doc_config_channelname_scheme_property, lang);
}

static char *
config_picon_path_doc(const struct property *p, const char *lang)
{
extern const char *tvh_doc_config_picon_path_property[];
return prop_md_doc(tvh_doc_config_picon_path_property, lang);
}

static char *
config_picon_servicetype_doc(const struct property *p, const char *lang)
{
extern const char *tvh_doc_config_picon_servicetype_property[];
return prop_md_doc(tvh_doc_config_picon_servicetype_property, lang);
}

extern const char *tvh_doc_config_class[];

const idclass_t config_class = {
.ic_snode = &config.idnode,
.ic_class = "config",
.ic_caption = N_("Configuration"),
.ic_caption = N_("Configuration - Base"),
.ic_event = "config",
.ic_perm_def = ACCESS_ADMIN,
.ic_doc = tvh_doc_config_class,
Expand Down Expand Up @@ -2019,6 +2047,8 @@ const idclass_t config_class = {
.type = PT_STR,
.id = "full_version",
.name = N_("Last updated from"),
.desc = N_("The version of Tvheadend that last updated the "
"config."),
.off = offsetof(config_t, full_version),
.opts = PO_RDONLY | PO_HIDDEN | PO_EXPERT,
.group = 1
Expand All @@ -2037,7 +2067,7 @@ const idclass_t config_class = {
.id = "uilevel",
.name = N_("User interface level"),
.desc = N_("Sets the default interface view level (next to the "
"help button)."),
"Help button)."),
.off = offsetof(config_t, uilevel),
.list = config_class_uilevel,
.group = 1
Expand All @@ -2056,8 +2086,8 @@ const idclass_t config_class = {
{
.type = PT_BOOL,
.id = "ui_quicktips",
.name = N_("User interface quick tips"),
.desc = N_("Allow to show the quick tips for the form fields."),
.name = N_("User interface quick tips (tooltips)"),
.desc = N_("Enable/disable interface quick tips."),
.off = offsetof(config_t, ui_quicktips),
.opts = PO_ADVANCED,
.group = 1
Expand All @@ -2068,7 +2098,7 @@ const idclass_t config_class = {
.name = N_("Use HTTP digest authentication"),
.desc = N_("Digest access authentication is intended as a security trade-off. "
"It is intended to replace unencrypted HTTP basic access authentication. "
"This option should be enabled for the standard usage."),
"This option should be enabled for standard usage."),
.off = offsetof(config_t, digest),
.opts = PO_ADVANCED,
.group = 1
Expand Down Expand Up @@ -2190,7 +2220,7 @@ const idclass_t config_class = {
.type = PT_STR,
.id = "theme_ui",
.name = N_("Theme"),
.desc = N_("The default theme for web interface to use if the user "
.desc = N_("The default web interface to use if the user's "
" theme isn't set in the Access Entries tab."),
.list = theme_get_ui_list,
.off = offsetof(config_t, theme_ui),
Expand Down Expand Up @@ -2249,20 +2279,21 @@ const idclass_t config_class = {
.id = "prefer_picon",
.name = N_("Prefer picons over channel name"),
.desc = N_("If both a picon and a channel-specific "
"(e.g. channelname.jpg) icon are defined, use the picon."),
"(e.g. channelname.jpg) icon are defined, prefer the picon."),
.off = offsetof(config_t, prefer_picon),
.opts = PO_ADVANCED,
.group = 6,
},
{
.type = PT_STR,
.id = "chiconpath",
.name = N_("Channel icon path (see Help)"),
.name = N_("Channel icon path"),
.desc = N_("Path to an icon for this channel. This can be "
"named however you wish, as either a local "
"(file://) or remote (http://) image. "
"See Help for more infomation."),
.off = offsetof(config_t, chicon_path),
.doc = config_channelicon_path_doc,
.opts = PO_ADVANCED,
.group = 6,
},
Expand All @@ -2273,17 +2304,19 @@ const idclass_t config_class = {
.desc = N_("Scheme to generate the the channel icon names "
"(all lower-case, service name picons etc.)."),
.list = config_class_chiconscheme_list,
.doc = config_channelname_scheme_doc,
.off = offsetof(config_t, chicon_scheme),
.opts = PO_ADVANCED,
.group = 6,
},
{
.type = PT_STR,
.id = "piconpath",
.name = N_("Picon path (see Help)"),
.name = N_("Picon path"),
.desc = N_("Path to a directory (folder) containing your picon "
"collection. See Help for more detailed "
"information."),
.doc = config_picon_path_doc,
.off = offsetof(config_t, picon_path),
.opts = PO_ADVANCED,
.group = 6,
Expand All @@ -2295,6 +2328,7 @@ const idclass_t config_class = {
.desc = N_("Select scheme to generate the picon names "
"(standard, force service type to 1)"),
.list = config_class_piconscheme_list,
.doc = config_picon_servicetype_doc,
.off = offsetof(config_t, picon_scheme),
.opts = PO_ADVANCED,
.group = 6,
Expand Down

0 comments on commit 8814922

Please sign in to comment.