git.sesse.net Git - vlc/blob - include/vlc_help.h

   1 /*****************************************************************************
   2  * vlc_help.h: Help strings
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN
   5  * $Id: vlc_help.h,v 1.8 2004/02/06 03:52:09 hartman Exp $
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Anil Daoud <anil@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #ifndef _VLC_HELP_H
  26 #define _VLC_HELP_H 1
  27
  28 /*
  29  *  First, we need help strings for the General Settings and for the
  30  *  Plugins screen
  31  */
  32 #define GENERAL_TITLE N_( "VLC preferences" )
  33 #define GENERAL_HELP N_( \
  34     "Configure some global options in General Settings " \
  35     "and configure each VLC module in the Modules section.\n" \
  36     "Click on \"Advanced Options\" to see all options." )
  37
  38 #define PLUGIN_TITLE N_( "VLC modules preferences" )
  39 #define PLUGIN_HELP N_( \
  40     "In this tree, you can set options for every module used by VLC.\n" \
  41     "Modules are sorted by type.\nHave fun tuning VLC!" )
  42
  43 /*
  44  *  Then, help for each module capabilities.
  45  */
  46
  47 #define ACCESS_TITLE N_( "Access modules settings" )
  48 #define ACCESS_HELP N_( \
  49     "Settings related to the various access methods used by VLC.\n" \
  50     "Common settings you may want to alter are HTTP proxy or " \
  51     "caching settings." )
  52
  53 #define AUDIO_FILTER_TITLE N_("Audio filters settings")
  54 #define AUDIO_FILTER_HELP N_( \
  55     "Audio filters can be set in the Audio section, and configured " \
  56     "here.")
  57
  58 #define AOUT_TITLE N_("Audio output modules settings")
  59 #define AOUT_HELP N_("These are general settings for audio output modules.")
  60
  61 #define AOUT_ENC_TITLE N_("Audio encoders settings")
  62 #define AOUT_ENC_HELP N_( \
  63     "These are general settings for audio encoding modules.")
  64
  65 #define CHROMA_TITLE N_("Chroma modules settings")
  66 #define CHROMA_HELP N_("These settings affect chroma transformation modules.")
  67
  68 #define DECODER_TITLE  N_("Decoder modules settings" )
  69 #define DECODER_HELP N_( \
  70     "In the Subsdec section you may want to set the text encoding of your " \
  71     "preferred subtitles.")
  72
  73 #define DEMUX_TITLE N_("Demuxers settings")
  74 #define DEMUX_HELP N_( "These settings affect demuxer modules.")
  75
  76 #define INTERFACE_TITLE N_("Interface plugins settings")
  77 #define INTERFACE_HELP  N_( \
  78     "Interface plugins can be enabled in the Interface section and " \
  79     "configured here.")
  80
  81 #define SOUT_TITLE N_("Stream output access modules settings")
  82 #define SOUT_HELP N_( \
  83     "In this section you can set the caching value for the UDP stream" \
  84     "output access module.")
  85
  86 #define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
  87 #define SUBTITLE_DEMUX_HELP N_( \
  88     "In this section you can force the behavior of the subtitle demuxer, " \
  89     "for example by setting the subtitles type or file name.")
  90
  91 #define TEXT_TITLE N_("Text renderer settings")
  92 #define TEXT_HELP N_( \
  93     "Use these settings to choose the font you want VLC to use for text " \
  94     "rendering (to display subtitles for example).")
  95
  96 #define VOUT__TITLE N_("Video output modules settings")
  97 #define VOUT_HELP N_( \
  98     "Choose your preferred video output in the Video section, " \
  99     "and configure it here." )
 100
 101 #define VIDEO_FILTER_TITLE N_("Video filters settings")
 102 #define VIDEO_FILTER_HELP N_( \
 103     "Video filters can be enabled in the Video section and configured " \
 104     "here.\n" \
 105     "Configure the \"adjust\" filter to modify contrast/hue/saturation " \
 106     "settings.")
 107
 108 /*
 109  *  A little help for modules with unknown capabilities
 110  */
 111
 112 #define UNKNOWN_TITLE N_("No help available" )
 113 #define UNKNOWN_HELP N_("No help is available for these modules")
 114
 115 /*****************************************************************************
 116  * GetCapabilityHelp: Display the help for one capability.
 117  *****************************************************************************/
 118 static char * GetCapabilityHelp( char *psz_capability, int i_type)
 119 {
 120     if( psz_capability == NULL) return "";
 121
 122     if( !strcasecmp(psz_capability,"access") )
 123         return i_type == 1 ? ACCESS_TITLE : ACCESS_HELP;
 124     if( !strcasecmp(psz_capability,"audio filter") )
 125         return i_type == 1 ? AUDIO_FILTER_TITLE : AUDIO_FILTER_HELP;
 126     if( !strcasecmp(psz_capability,"audio output") )
 127         return i_type == 1 ? AOUT_TITLE : AOUT_HELP;
 128     if( !strcasecmp(psz_capability,"audio encoder") )
 129         return i_type == 1 ? AOUT_ENC_TITLE : AOUT_ENC_HELP;
 130     if( !strcasecmp(psz_capability,"chroma") )
 131         return i_type == 1 ? CHROMA_TITLE : CHROMA_HELP;
 132     if( !strcasecmp(psz_capability,"decoder") )
 133         return i_type == 1 ? DECODER_TITLE : DECODER_HELP;
 134     if( !strcasecmp(psz_capability,"demux") )
 135         return i_type == 1 ? DEMUX_TITLE : DEMUX_HELP;
 136     if( !strcasecmp(psz_capability,"interface") )
 137         return i_type == 1 ? INTERFACE_TITLE : INTERFACE_HELP;
 138     if( !strcasecmp(psz_capability,"sout access") )
 139         return i_type == 1 ? SOUT_TITLE : SOUT_HELP;
 140     if( !strcasecmp(psz_capability,"subtitle demux") )
 141         return i_type == 1 ? SUBTITLE_DEMUX_TITLE : SUBTITLE_DEMUX_HELP;
 142     if( !strcasecmp(psz_capability,"text renderer") )
 143         return i_type == 1 ? TEXT_TITLE : TEXT_HELP;
 144     if( !strcasecmp(psz_capability,"video output") )
 145         return i_type == 1 ? VOUT__TITLE : VOUT_HELP;
 146     if( !strcasecmp(psz_capability,"video filter") )
 147         return i_type == 1 ? VIDEO_FILTER_TITLE : VIDEO_FILTER_HELP;
 148
 149     return "";
 150 }
 151
 152
 153 #endif /* VLC_HELP_H */