[DEV] Simple phpBB FAQ

A place for Extension Authors to post and receive feedback on Extensions still in development. No Extensions within this forum should be used within a live environment!
Anti-Spam Guide
Forum rules
READ: phpBB.com Board-Wide Rules and Regulations

IMPORTANT: Extensions Development rules

IMPORTANT FOR NEEDED EVENTS!!!
If you need an event for your extension please read this for the steps to follow to request the event(s)
Post Reply
rxu
Extensions Development Team
Posts: 3267
Joined: Wed Oct 25, 2006 12:46 pm
Location: Siberia, Russian Federation
Name: Ruslan
Contact:

[DEV] Simple phpBB FAQ

Post by rxu »

Extension Name: Simple phpBB FAQ
Author: rxu

Extension Description: This extension allows plugging custom phpBB-like help files automatically.
Extension Version: 1.0.0 (unslable)

Requirements: phpBB >=3.1.4-RC1 (not released yet :!: )

Development repository: https://github.com/rxu/simplephpbbfaq

Extension Download: Download button named "Download ZIP" can be found at the development repository page.

Installation: Extension files should be extracted to /ext/rxu/simplephpbbfaq/ folder. Then the extension should be enabled in ACP as usually.

Explanation: This extension is designed to automatically plug in phpBB-like (help_faq.php-like ) custom help/FAQ files. Those files have the same format with help_faq.php and can be created either manually or using, f.e., FAQ Manager extension by david63. Tne name should follow the template like help_<custom_name>.php.
Custom help/FAQ files can be placed either in the board's /language/<iso>/ folder or in the extensions's /ext/rxu/simplephpbbfaq/language/<iso>/ folder.
Custom help/FAQ can be used with the URL like /faq.php?mode=<custom_name>.

For example, having custom help file help_myfaq.php, you can access it using board relative URL like /faq.php?mode=myfaq. Note the myfaq postfix which is used to identify the custom help file.

You can set custom help/FAQ page title by creating another language file named like help_<custom_name>_lang.php at the same language folder, containing the language entry like 'HELP_<CUSTOM_NAME>_TITLE', f.e. help_myfaq_lang.php:

Code: Select all

<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/

if (!defined('IN_PHPBB'))
{
	exit;
}

if (empty($lang) || !is_array($lang))
{
	$lang = array();
}

$lang = array_merge($lang, array(
	'HELP_MYFAQ_TITLE'	=> 'My custom FAQ',
));

User avatar
Raul [ThE KuKa]
Style Customisations
Style Customisations
Posts: 8047
Joined: Mon Dec 08, 2003 9:24 pm
Location: Spain
Name: Raul Arroyo
Contact:

Re: [DEV] Simple phpBB FAQ

Post by Raul [ThE KuKa] »

It's cool... :)
All unsolicited PMs will be ignored.
:warning: Knowledge Base | Documentation | Board rules | phpBB Styles Rules & Policies | Styles Queue Stats :warning:


If you like my styles, translations, etc. and want to show some appreciation, then feel free to Donate.
:flag_es: phpBB Spain - Online Since 2003 :heart:


Post Reply

Return to “Extensions in Development”