/*****************************************************************************
* vlc_config_cat.h : Definition of configuration categories
*****************************************************************************
- * Copyright (C) 2003 the VideoLAN team
+ * Copyright (C) 2003 VLC authors and VideoLAN
* $Id$
*
* Authors: Clément Stenac <zorglub@videolan.org>
* Anil Daoud <anil@videolan.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifndef VLC_HELP_H
#define VLC_HELP_H 1
+# include <vlc_plugin.h>
/*
* First, we need help strings for the General Settings and for the
#define MAIN_HELP N_( \
"Select \"Advanced Options\" to see all options." )
-#define GENERAL_TITLE N_("General")
-
/* Interface */
#define INTF_TITLE N_("Interface")
#define INTF_HELP N_( "Settings for VLC's interfaces" )
-#define INTF_GENERAL_HELP N_( "General interface settings" )
+#define INTF_GENERAL_HELP N_( "Main interfaces settings" )
#define INTF_MAIN_TITLE N_( "Main interfaces" )
#define INTF_MAIN_HELP N_( "Settings for the main interface" )
#define AUDIO_TITLE N_( "Audio" )
#define AUDIO_HELP N_( "Audio settings" )
-#define AUDIO_GENERAL_TITLE N_( "General audio settings" )
#define AUDIO_GENERAL_HELP N_("General audio settings")
#define AFILTER_TITLE N_("Filters")
-#define AFILTER_HELP N_( \
- "Audio filters are used to postprocess the audio stream." )
+#define AFILTER_HELP N_( "Audio filters are used to process the audio stream." )
#define AVISUAL_TITLE N_("Visualizations")
-#define AVISUAL_HELP N_( \
- "Audio visualizations" )
+#define AVISUAL_HELP N_( "Audio visualizations" )
#define AOUT_TITLE N_( "Output modules" )
-#define AOUT_HELP N_("These are general settings for audio output modules.")
+#define AOUT_HELP N_("General settings for audio output modules.")
#define AMISC_TITLE N_("Miscellaneous")
#define AMISC_HELP N_( "Miscellaneous audio settings and modules." )
#define VIDEO_TITLE N_("Video")
#define VIDEO_HELP N_("Video settings")
-#define VIDEO_GENERAL_TITLE N_( "General video settings")
#define VIDEO_GENERAL_HELP N_( "General video settings" )
#define _VOUT_TITLE N_("Output modules" )
-#define VOUT_HELP N_( \
- "Choose your preferred video output and configure it here." )
+#define VOUT_HELP N_("General settings for video output modules.")
#define VFILTER_TITLE N_("Filters" )
-#define VFILTER_HELP N_( \
- "Video filters are used to postprocess the video stream." )
+#define VFILTER_HELP N_("Video filters are used to process the video stream." )
-#define SUBPIC_TITLE N_( "Subtitles/OSD")
-#define SUBPIC_HELP N_( "Miscellaneous settings related to On-Screen-Display,"\
- " subtitles and \"overlay subpictures\".")
+#define SUBPIC_TITLE N_( "Subtitles / OSD")
+#define SUBPIC_HELP N_( "Settings related to On-Screen-Display,"\
+ " subtitles and \"overlay subpictures\"")
/*
-#define TEXT_TITLE N_("Text rendering")
#define TEXT_HELP N_( \
"Use the settings of the \"freetype\" module to choose the font you " \
"want VLC to use for text rendering (to display subtitles for example).")
*/
/* Input */
#define INPUT_TITLE N_( "Input / Codecs" )
-#define INPUT_HELP N_( "These are the settings for the input, demultiplexing " \
- "and decoding parts of VLC. Encoder settings can also be found here." )
+#define INPUT_HELP N_( "Settings for input, demultiplexing, " \
+ "decoding and encoding")
#define ACCESS_TITLE N_( "Access modules" )
#define ACCESS_HELP N_( \
- "Settings related to the various access methods used by VLC. " \
+ "Settings related to the various access methods. " \
"Common settings you may want to alter are HTTP proxy or " \
"caching settings." )
#define STREAM_FILTER_TITLE N_( "Stream filters" )
#define STREAM_FILTER_HELP N_( \
"Stream filters are special modules that allow advanced operations on " \
- "the input side of VLC. You should not touch anything here unless you " \
- "know what you are doing." )
+ "the input side of VLC. Use with care..." )
#define DEMUX_TITLE N_("Demuxers")
#define DEMUX_HELP N_( "Demuxers are used to separate audio and video streams." )
#define VDEC_TITLE N_( "Video codecs" )
-#define VDEC_HELP N_( "Settings for the video-only decoders and encoders." )
+#define VDEC_HELP N_( "Settings for the video, images or video+audio decoders and encoders." )
#define ADEC_TITLE N_( "Audio codecs" )
#define ADEC_HELP N_( "Settings for the audio-only decoders and encoders." )
-#define SDEC_TITLE N_( "Other codecs")
-#define SDEC_HELP N_( "Settings for audio+video and miscellaneous decoders and encoders." )
+#define SDEC_TITLE N_( "Subtitle codecs")
+#define SDEC_HELP N_( "Settings for subtitle, teletext and CC decoders and encoders." )
-#define ADVANCED_TITLE N_("General")
-#define ADVANCED_HELP N_( "General input settings. Use with care." )
+#define ADVANCED_HELP N_( "General input settings. Use with care..." )
/* Sout */
#define SOUT_TITLE N_( "Stream output" )
#define SOUT_HELP N_( \
- "Stream output is what allows VLC to act as a streaming server " \
- "or to save incoming streams.\n" \
+ "Stream output settings are used when acting as a streaming server " \
+ "or when saving incoming streams.\n" \
"Streams are first muxed and then sent through an \"access output\" "\
"module that can either save the stream to a file, or stream " \
"it (UDP, HTTP, RTP/RTSP).\n" \
"more information. You can configure default options for " \
"each sout stream module here.")
-#define SOUT_SAP_TITLE N_( "SAP" )
-#define SOUT_SAP_HELP N_( \
- "SAP is a way to publically announce streams that are being "\
- "sent using multicast UDP or RTP." )
-
#define SOUT_VOD_TITLE N_( "VOD" )
#define SOUT_VOD_HELP N_( "VLC's implementation of Video On Demand" )
/* Advanced */
#define AADVANCED_TITLE N_( "Advanced" )
-#define AADVANCED_HELP N_( "Advanced settings. Use with care.")
-
-#define CPU_TITLE N_( "CPU features" )
-#define CPU_HELP N_( "You can choose to disable some CPU accelerations " \
- "here. You should probably not change these settings." )
+#define AADVANCED_HELP N_( "Advanced settings. Use with care...")
#define MISC_TITLE N_( "Advanced settings" )
-#define MISC_HELP N_( "Other advanced settings")
-
-#define NETWORK_TITLE N_( "Network" )
-#define NETWORK_HELP N_( "These modules provide network functions to all " \
- "other parts of VLC." )
-
-/* OLD */
-
-#define CHROMA_TITLE N_("Chroma modules settings")
-#define CHROMA_HELP N_("These settings affect chroma transformation modules.")
-
-#define PACKETIZER_TITLE N_("Packetizer modules settings" )
-#define PACKETIZER_HELP "These are general settings for the "\
- "packetizers used in VLC's stream output subsystem."
-
-#define ENCODER_TITLE N_("Encoders settings")
-#define ENCODER_HELP N_( \
- "These are general settings for video/audio/subtitles encoding modules.")
-
-
-#define DIALOGS_TITLE N_("Dialog providers settings")
-#define DIALOGS_HELP N_( \
- "Dialog providers can be configured here.")
-
-#define SUBTITLE_DEMUX_TITLE N_("Subtitle demuxer settings")
-#define SUBTITLE_DEMUX_HELP N_( \
- "In this section you can force the behavior of the subtitle demuxer, " \
- "for example by setting the subtitles type or file name.")
-
-/*
- * A little help for modules with unknown capabilities
- */
-
-#define UNKNOWN_TITLE N_("No help available" )
-#define UNKNOWN_HELP N_("There is no help available for these modules.")
/* This function is deprecated and is kept only for compatibility */
static const struct config_category_t categories_array[] =
{
/* Interface */
{ CAT_INTERFACE, INTF_TITLE, INTF_HELP },
- { SUBCAT_INTERFACE_GENERAL, GENERAL_TITLE, INTF_GENERAL_HELP },
+ { SUBCAT_INTERFACE_GENERAL, INTF_TITLE, INTF_GENERAL_HELP },
{ SUBCAT_INTERFACE_MAIN, INTF_MAIN_TITLE, INTF_MAIN_HELP },
{ SUBCAT_INTERFACE_CONTROL, INTF_CONTROL_TITLE, INTF_CONTROL_HELP },
{ SUBCAT_INTERFACE_HOTKEYS, INTF_HOTKEYS_TITLE, INTF_HOTKEYS_HELP },
{ CAT_AUDIO, AUDIO_TITLE, AUDIO_HELP },
- { SUBCAT_AUDIO_GENERAL, AUDIO_GENERAL_TITLE, AUDIO_GENERAL_HELP },
+ { SUBCAT_AUDIO_GENERAL, AUDIO_TITLE, AUDIO_GENERAL_HELP },
{ SUBCAT_AUDIO_AOUT, AOUT_TITLE, AOUT_HELP },
{ SUBCAT_AUDIO_AFILTER, AFILTER_TITLE, AFILTER_HELP },
{ SUBCAT_AUDIO_VISUAL, AVISUAL_TITLE, AVISUAL_HELP },
{ SUBCAT_AUDIO_MISC, AMISC_TITLE, AMISC_HELP },
{ CAT_VIDEO, VIDEO_TITLE, VIDEO_HELP },
- { SUBCAT_VIDEO_GENERAL, VIDEO_GENERAL_TITLE, VIDEO_GENERAL_HELP },
+ { SUBCAT_VIDEO_GENERAL, VIDEO_TITLE, VIDEO_GENERAL_HELP },
{ SUBCAT_VIDEO_VOUT, _VOUT_TITLE, VOUT_HELP },
{ SUBCAT_VIDEO_VFILTER, VFILTER_TITLE, VFILTER_HELP },
{ SUBCAT_VIDEO_SUBPIC, SUBPIC_TITLE, SUBPIC_HELP },
{ CAT_INPUT, INPUT_TITLE, INPUT_HELP },
- { SUBCAT_INPUT_GENERAL, ADVANCED_TITLE, ADVANCED_HELP },
+ { SUBCAT_INPUT_GENERAL, INPUT_TITLE, INPUT_HELP },
{ SUBCAT_INPUT_ACCESS, ACCESS_TITLE, ACCESS_HELP },
{ SUBCAT_INPUT_DEMUX, DEMUX_TITLE, DEMUX_HELP },
{ SUBCAT_INPUT_VCODEC, VDEC_TITLE, VDEC_HELP },
{ SUBCAT_INPUT_STREAM_FILTER, STREAM_FILTER_TITLE, STREAM_FILTER_HELP },
{ CAT_SOUT, SOUT_TITLE, SOUT_HELP },
- { SUBCAT_SOUT_GENERAL, GENERAL_TITLE, SOUT_GENERAL_HELP },
+ { SUBCAT_SOUT_GENERAL, SOUT_TITLE, SOUT_GENERAL_HELP },
{ SUBCAT_SOUT_STREAM, SOUT_STREAM_TITLE, SOUT_STREAM_HELP },
{ SUBCAT_SOUT_MUX, SOUT_MUX_TITLE, SOUT_MUX_HELP },
{ SUBCAT_SOUT_ACO, SOUT_ACO_TITLE, SOUT_ACO_HELP },
{ SUBCAT_SOUT_PACKETIZER, SOUT_PACKET_TITLE, SOUT_PACKET_HELP },
- { SUBCAT_SOUT_SAP, SOUT_SAP_TITLE, SOUT_SAP_HELP },
{ SUBCAT_SOUT_VOD, SOUT_VOD_TITLE, SOUT_VOD_HELP },
{ CAT_PLAYLIST, PLAYLIST_TITLE , PLAYLIST_HELP },
- { SUBCAT_PLAYLIST_GENERAL, GENERAL_TITLE, PGENERAL_HELP },
+ { SUBCAT_PLAYLIST_GENERAL, PLAYLIST_TITLE, PGENERAL_HELP },
{ SUBCAT_PLAYLIST_SD, SD_TITLE, SD_HELP },
{ CAT_ADVANCED, AADVANCED_TITLE, AADVANCED_HELP },
- { SUBCAT_ADVANCED_CPU, CPU_TITLE, CPU_HELP },
- { SUBCAT_ADVANCED_MISC, MISC_TITLE, MISC_HELP },
+ { SUBCAT_ADVANCED_MISC, MISC_TITLE, AADVANCED_HELP },
{ -1, NULL, NULL }
};
-LIBVLC_USED
+VLC_USED
static inline const char *config_CategoryNameGet( int i_value )
{
- int i = 0 ;
+ int i = 0;
while( categories_array[i].psz_name != NULL )
{
if( categories_array[i].i_id == i_value )
{
- return _(categories_array[i].psz_name);
+ return vlc_gettext(categories_array[i].psz_name);
}
i++;
}
return NULL;
}
-LIBVLC_USED
+VLC_USED
static inline const char *config_CategoryHelpGet( int i_value )
{
- int i = 0 ;
+ int i = 0;
while( categories_array[i].psz_help != NULL )
{
if( categories_array[i].i_id == i_value )
{
- return _(categories_array[i].psz_help);
+ return vlc_gettext(categories_array[i].psz_help);
}
i++;
}