ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / sudairsocs / www / forum / Sources

<?php

/**
 * This file has the important job of taking care of help messages and the help center.
 *
 * Simple Machines Forum (SMF)
 *
 * @package SMF
 * @author Simple Machines https://www.simplemachines.org
 * @copyright 2022 Simple Machines and individual contributors
 * @license https://www.simplemachines.org/about/smf/license.php BSD
 *
 * @version 2.1.3
 */

if (!defined('SMF'))
	die('No direct access...');

/**
 * Redirect to the user help ;).
 * It loads information needed for the help section.
 * It is accessed by ?action=help.
 *
 * Uses Help template and Manual language file.
 */
function ShowHelp()
{
	loadTemplate('Help');
	loadLanguage('Manual');

$subActions = array(
		'index' => 'HelpIndex',
	);

// CRUD $subActions as needed.
	call_integration_hook('integrate_manage_help', array(&$subActions));

$sa = isset($_GET['sa'], $subActions[$_GET['sa']]) ? $_GET['sa'] : 'index';
	call_helper($subActions[$sa]);
}

/**
 * The main page for the Help section
 */
function HelpIndex()
{
	global $scripturl, $context, $txt;

// We need to know where our wiki is.
	$context['wiki_url'] = 'https://wiki.simplemachines.org/smf';
	$context['wiki_prefix'] = 'SMF2.1:';

$context['canonical_url'] = $scripturl . '?action=help';

// Sections were are going to link...
	$context['manual_sections'] = array(
		'registering' => 'Registering',
		'logging_in' => 'Logging_In',
		'profile' => 'Profile',
		'search' => 'Search',
		'posting' => 'Posting',
		'bbc' => 'Bulletin_board_code',
		'personal_messages' => 'Personal_messages',
		'memberlist' => 'Memberlist',
		'calendar' => 'Calendar',
		'features' => 'Features',
	);

// Build the link tree.
	$context['linktree'][] = array(
		'url' => $scripturl . '?action=help',
		'name' => $txt['help'],
	);

// Lastly, some minor template stuff.
	$context['page_title'] = $txt['manual_smf_user_help'];
	$context['sub_template'] = 'manual';
}

/**
 * Show some of the more detailed help to give the admin an idea...
 * It shows a popup for administrative or user help.
 * It uses the help parameter to decide what string to display and where to get
 * the string from. ($helptxt or $txt?)
 * It is accessed via ?action=helpadmin;help=?.
 *
 * Uses ManagePermissions language file, if the help starts with permissionhelp.
 * @uses template_popup() with no layers.
 */
function ShowAdminHelp()
{
	global $txt, $helptxt, $context, $scripturl, $boarddir, $boardurl;

if (!isset($_GET['help']) || !is_string($_GET['help']))
		fatal_lang_error('no_access', false);

if (!isset($helptxt))
		$helptxt = array();

// Load the admin help language file and template.
	loadLanguage('Help');

// Permission specific help?
	if (isset($_GET['help']) && substr($_GET['help'], 0, 14) == 'permissionhelp')
		loadLanguage('ManagePermissions');

loadTemplate('Help');

// Allow mods to load their own language file here
	call_integration_hook('integrate_helpadmin');

// What help string should be used?
	if (isset($helptxt[$_GET['help']]))
		$context['help_text'] = $helptxt[$_GET['help']];
	elseif (isset($txt[$_GET['help']]))
		$context['help_text'] = $txt[$_GET['help']];
	else
		fatal_lang_error('not_found', false, array(), 404);

switch ($_GET['help']) {
		case 'cal_short_months':
			$context['help_text'] = sprintf($context['help_text'], $txt['months_short'][1], $txt['months_titles'][1]);
			break;
		case 'cal_short_days':
			$context['help_text'] = sprintf($context['help_text'], $txt['days_short'][1], $txt['days'][1]);
			break;
		case 'cron_is_real_cron':
			$context['help_text'] = sprintf($context['help_text'], allowedTo('admin_forum') ? $boarddir : '[' . $txt['hidden'] . ']', $boardurl);
			break;
		case 'queryless_urls':
			$context['help_text'] = sprintf($context['help_text'], (isset($_SERVER['SERVER_SOFTWARE']) && (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') !== false || strpos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) ? $helptxt['queryless_urls_supported'] : $helptxt['queryless_urls_unsupported']));
			break;
	}

// Does this text contain a link that we should fill in?
	if (preg_match('~%([0-9]+\$)?s\?~', $context['help_text'], $match))
		$context['help_text'] = sprintf($context['help_text'], $scripturl, $context['session_id'], $context['session_var']);

// Set the page title to something relevant.
	$context['page_title'] = $context['forum_name'] . ' - ' . $txt['help'];

// Don't show any template layers, just the popup sub template.
	$context['template_layers'] = array();
	$context['sub_template'] = 'popup';
}

[+] ..
[-] Errors.php~ [edit]
[-] ReportedContent.php [edit]
[-] Profile.php~ [edit]
[-] Notify.php [edit]
[-] Security.php~ [edit]
[-] ScheduledTasks.php [edit]
[-] ModerationCenter.php [edit]
[-] Mentions.php [edit]
[-] DbExtra-mysql.php~ [edit]
[-] Subs-MessageIndex.php [edit]
[-] Display.php~ [edit]
[-] DbPackages-sqlite.php [edit]
[-] ManageSettings.php~ [edit]
[-] Subs-Compat.php [edit]
[-] ManageScheduledTasks.php [edit]
[-] Security.php [edit]
[-] Profile-View.php~ [edit]
[-] BoardIndex.php [edit]
[-] Class-Punycode.php [edit]
[-] Subs-Db-postgresql.php~ [edit]
[-] MessageIndex.php [edit]
[-] ManageMail.php~ [edit]
[-] Modlog.php [edit]
[-] Calendar.php [edit]
[-] Subs-Members.php~ [edit]
[-] Profile-Modify.php~ [edit]
[-] .reference [edit]
[-] RemoveTopic.php~ [edit]
[-] ManageSmileys.php [edit]
[-] MoveTopic.php [edit]
[-] RemoveTopic.php [edit]
[-] Subs-Post.php~ [edit]
[-] Profile.php [edit]
[+] Unicode
[-] Groups.php [edit]
[-] Subs-Sound.php~ [edit]
[-] Groups.php~ [edit]
[-] Recent.php~ [edit]
[-] Who.php~ [edit]
[-] Class-TOTP.php [edit]
[-] ManageRegistration.php~ [edit]
[-] Agreement.php [edit]
[-] ReportToMod.php [edit]
[-] Profile-Actions.php [edit]
[-] Subs-Db-sqlite.php~ [edit]
[-] Display.php [edit]
[-] ManageCalendar.php~ [edit]
[-] PersonalMessage.php [edit]
[-] ManageAttachments.php~ [edit]
[-] Subs-Attachments.php [edit]
[-] Help.php [edit]
[-] Subs-Notify.php [edit]
[-] index.php [edit]
[-] Subs-Admin.php~ [edit]
[-] Subs-Db-mysql.php~ [edit]
[-] Subs-Package.php [edit]
[-] Printpage.php [edit]
[-] Subs-Post.php [edit]
[-] Class-SearchAPI.php [edit]
[-] Subs-Admin.php [edit]
[-] DbExtra-postgresql.php [edit]
[-] ManageSmileys.php~ [edit]
[-] Class-Graphics.php~ [edit]
[-] Subs-Categories.php [edit]
[-] ManageSearch.php~ [edit]
[-] Subs-Editor.php~ [edit]
[-] Likes.php [edit]
[-] Subs.php~ [edit]
[-] SendTopic.php [edit]
[-] DbPackages-postgresql.php [edit]
[-] DbSearch-mysql.php [edit]
[-] Xml.php [edit]
[-] Reports.php [edit]
[-] Subs-Membergroups.php [edit]
[-] ManagePosts.php [edit]
[-] ManageAttachments.php [edit]
[-] ManagePaid.php~ [edit]
[-] SearchAPI-Standard.php [edit]
[-] DbExtra-mysql.php [edit]
[-] ManageLanguages.php [edit]
[+] Cache
[-] Session.php [edit]
[-] Load.php~ [edit]
[-] Packages.php~ [edit]
[-] ManageScheduledTasks.php~ [edit]
[-] Karma.php [edit]
[-] Poll.php~ [edit]
[-] ManageMembers.php~ [edit]
[-] News.php [edit]
[-] Subs-Compat.php~ [edit]
[-] DbSearch-sqlite.php [edit]
[-] Subs-Charset.php [edit]
[-] Subs.php [edit]
[-] Reminder.php [edit]
[-] Modlog.php~ [edit]
[-] ManagePaid.php [edit]
[-] LogInOut.php [edit]
[-] DbSearch-postgresql.php [edit]
[-] hcaptcha.php [edit]
[-] Subs-BoardIndex.php [edit]
[-] ManageMembergroups.php~ [edit]
[+] minify
[-] Class-Graphics.php [edit]
[-] Subs-Graphics.php~ [edit]
[-] Subs-Menu.php [edit]
[-] Admin.php~ [edit]
[-] ManageMail.php [edit]
[-] SearchAPI-Custom.php [edit]
[-] ScheduledTasks.php~ [edit]
[-] Logging.php [edit]
[-] DbPackages-mysql.php [edit]
[-] Subs-Recent.php [edit]
[-] Class-CurlFetchWeb.php~ [edit]
[-] ModerationCenter.php~ [edit]
[+] random_compat
[-] Admin.php [edit]
[-] Class-Package.php [edit]
[-] ManageMaintenance.php [edit]
[-] Packages.php [edit]
[-] Subs-BoardIndex.php~ [edit]
[-] ManageBans.php~ [edit]
[-] ManageMembers.php [edit]
[-] ManageServer.php [edit]
[-] Subs-Db-mysql.php [edit]
[-] ManageErrors.php [edit]
[-] Subs-Calendar.php [edit]
[-] Subs-Editor.php [edit]
[-] Load.php [edit]
[-] Subs-Graphics.php [edit]
[-] Subs-Boards.php [edit]
[-] News.php~ [edit]
[-] Stats.php [edit]
[-] ManageNews.php [edit]
[-] Subs-Db-sqlite.php [edit]
[-] Attachments.php [edit]
[-] Subs-ReportedContent.php [edit]
[-] Register.php~ [edit]
[-] Subs-Sound.php [edit]
[-] Who.php [edit]
[-] Subs-Members.php [edit]
[-] Search.php~ [edit]
[-] ManageRegistration.php [edit]
[-] Help.php~ [edit]
[-] PostModeration.php [edit]
[-] ShowAttachments.php [edit]
[-] Subs-Db-postgresql.php [edit]
[-] Recent.php [edit]
[-] Memberlist.php [edit]
[-] ManageBoards.php [edit]
[-] Themes.php~ [edit]
[-] Errors.php [edit]
[-] ManagePermissions.php [edit]
[-] SplitTopics.php [edit]
[-] Profile-Modify.php [edit]
[-] Themes.php [edit]
[-] Register.php [edit]
[-] Profile-Export.php [edit]
[-] ManageServer.php~ [edit]
[-] Subs-Auth.php [edit]
[-] PersonalMessage.php~ [edit]
[-] ManageSearchEngines.php [edit]
[-] Drafts.php [edit]
[-] Subs-Package.php~ [edit]
[-] Subs-MembersOnline.php [edit]
[-] ManageCalendar.php [edit]
[-] Memberlist.php~ [edit]
[-] QueryString.php [edit]
[-] Poll.php [edit]
[-] ManageMembergroups.php [edit]
[+] tasks
[-] ManageSearch.php [edit]
[-] Subs-Auth.php~ [edit]
[-] Agreement.php~ [edit]
[-] Topic.php [edit]
[-] QueryString.php~ [edit]
[-] ViewQuery.php [edit]
[-] ManageMaintenance.php~ [edit]
[-] PackageGet.php [edit]
[-] Post.php [edit]
[-] Subs-Timezones.php [edit]
[-] ManageErrors.php~ [edit]
[-] Post.php~ [edit]
[-] SearchAPI-Fulltext.php~ [edit]
[-] Profile-View.php [edit]
[-] Subs-OpenID.php [edit]
[-] ManageBans.php [edit]
[-] Class-CurlFetchWeb.php [edit]
[-] DbExtra-sqlite.php [edit]
[-] ManageNews.php~ [edit]
[-] Subscriptions-PayPal.php [edit]
[-] ManageSearchEngines.php~ [edit]
[-] RepairBoards.php [edit]
[-] Class-BrowserDetect.php [edit]
[+] ReCaptcha
[-] Subs-List.php [edit]
[-] Notify.php~ [edit]
[-] ManageSettings.php [edit]
[-] RepairBoards.php~ [edit]
[-] Subs-Themes.php [edit]
[-] Search.php [edit]
[-] SearchAPI-Fulltext.php [edit]