Chris@76: <?php
Chris@76: 
Chris@76: /**
Chris@76:  * Simple Machines Forum (SMF)
Chris@76:  *
Chris@76:  * @package SMF
Chris@76:  * @author Simple Machines http://www.simplemachines.org
Chris@76:  * @copyright 2011 Simple Machines
Chris@76:  * @license http://www.simplemachines.org/about/smf/license.php BSD
Chris@76:  *
Chris@76:  * @version 2.0
Chris@76:  */
Chris@76: 
Chris@76: if (!defined('SMF'))
Chris@76: 	die('Hacking attempt...');
Chris@76: 
Chris@76: /*	This file has the important job of taking care of help messages and the
Chris@76: 	help center.  It does this with two simple functions:
Chris@76: 
Chris@76: 	void ShowHelp()
Chris@76: 		- loads information needed for the help section.
Chris@76: 		- accesed by ?action=help.
Chris@76: 		- uses the Help template and Manual language file.
Chris@76: 
Chris@76: 	void ShowAdminHelp()
Chris@76: 		- shows a popup for administrative or user help.
Chris@76: 		- uses the help parameter to decide what string to display and where
Chris@76: 		  to get the string from. ($helptxt or $txt?)
Chris@76: 		- loads the ManagePermissions language file if the help starts with
Chris@76: 		  permissionhelp.
Chris@76: 		- uses the Help template, popup sub template, no layers.
Chris@76: 		- accessed via ?action=helpadmin;help=??.
Chris@76: */
Chris@76: 
Chris@76: // Redirect to the user help ;).
Chris@76: function ShowHelp()
Chris@76: {
Chris@76: 	global $scripturl, $context, $txt;
Chris@76: 
Chris@76: 	loadTemplate('Help');
Chris@76: 	loadLanguage('Manual');
Chris@76: 
Chris@76: 	// We need to know where our wiki is.
Chris@76: 	$context['wiki_url'] = 'http://wiki.simplemachines.org/smf';
Chris@76: 
Chris@76: 	// Sections were are going to link...
Chris@76: 	$context['manual_sections'] = array(
Chris@76: 		'registering' => 'Registering',
Chris@76: 		'logging_in' => 'Logging_In',
Chris@76: 		'profile' => 'Profile',
Chris@76: 		'search' => 'Search',
Chris@76: 		'posting' => 'Posting',
Chris@76: 		'bbc' => 'Bulletin_board_code',
Chris@76: 		'personal_messages' => 'Personal_messages',
Chris@76: 		'memberlist' => 'Memberlist',
Chris@76: 		'calendar' => 'Calendar',
Chris@76: 		'features' => 'Features',
Chris@76: 	);
Chris@76: 
Chris@76: 	// Build the link tree.
Chris@76: 	$context['linktree'][] = array(
Chris@76: 		'url' => $scripturl . '?action=help',
Chris@76: 		'name' => $txt['help'],
Chris@76: 	);
Chris@76: 
Chris@76: 	// Lastly, some minor template stuff.
Chris@76: 	$context['page_title'] = $txt['manual_smf_user_help'];
Chris@76: 	$context['sub_template'] = 'manual';
Chris@76: }
Chris@76: 
Chris@76: // Show some of the more detailed help to give the admin an idea...
Chris@76: function ShowAdminHelp()
Chris@76: {
Chris@76: 	global $txt, $helptxt, $context, $scripturl;
Chris@76: 
Chris@76: 	if (!isset($_GET['help']) || !is_string($_GET['help']))
Chris@76: 		fatal_lang_error('no_access', false);
Chris@76: 
Chris@76: 	if (!isset($helptxt))
Chris@76: 		$helptxt = array();
Chris@76: 
Chris@76: 	// Load the admin help language file and template.
Chris@76: 	loadLanguage('Help');
Chris@76: 
Chris@76: 	// Permission specific help?
Chris@76: 	if (isset($_GET['help']) && substr($_GET['help'], 0, 14) == 'permissionhelp')
Chris@76: 		loadLanguage('ManagePermissions');
Chris@76: 
Chris@76: 	loadTemplate('Help');
Chris@76: 
Chris@76: 	// Set the page title to something relevant.
Chris@76: 	$context['page_title'] = $context['forum_name'] . ' - ' . $txt['help'];
Chris@76: 
Chris@76: 	// Don't show any template layers, just the popup sub template.
Chris@76: 	$context['template_layers'] = array();
Chris@76: 	$context['sub_template'] = 'popup';
Chris@76: 
Chris@76: 	// What help string should be used?
Chris@76: 	if (isset($helptxt[$_GET['help']]))
Chris@76: 		$context['help_text'] = $helptxt[$_GET['help']];
Chris@76: 	elseif (isset($txt[$_GET['help']]))
Chris@76: 		$context['help_text'] = $txt[$_GET['help']];
Chris@76: 	else
Chris@76: 		$context['help_text'] = $_GET['help'];
Chris@76: 
Chris@76: 	// Does this text contain a link that we should fill in?
Chris@76: 	if (preg_match('~%([0-9]+\$)?s\?~', $context['help_text'], $match))
Chris@76: 		$context['help_text'] = sprintf($context['help_text'], $scripturl, $context['session_id'], $context['session_var']);
Chris@76: }
Chris@76: 
Chris@76: ?>