Skip to content

Commit c0966d6

Browse files
committed
Remove occurences of phpBB3
1 parent 4953008 commit c0966d6

File tree

6 files changed

+31
-26
lines changed

6 files changed

+31
-26
lines changed

development/extensions/modification_to_extension.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -774,7 +774,7 @@ Adding Events
774774
There are already numerous events available. However, if your extension needs to
775775
make use of an event which is not yet in the phpBB code, you can request the
776776
event be added to the core by creating a ticket in the
777-
`phpBB Bug Tracker <https://tracker.phpbb.com/projects/PHPBB3>`_ and we will
777+
`phpBB Bug Tracker <https://tracker.phpbb.com/projects/PHPBB>`_ and we will
778778
endeavour to include it in the next release.
779779

780780
Basics finished!

development/extensions/tutorial_authentication.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ authentication provider class is show below:
3939
namespace acme\demo\auth\provider;
4040
4141
/**
42-
* Database authentication provider for phpBB3
42+
* Database authentication provider for phpBB
4343
*
4444
* This is for authentication via the integrated user table
4545
*/
@@ -162,10 +162,10 @@ get the data it needs from the service, and the service file which allows
162162
phpBB to find the class. To find out how you should most likely make calls
163163
to the OAuh service, it is recommended that you refer to the included OAuth
164164
services and to the examples provided by
165-
`Lusitanian/PHPoAuthLib <https://github.com/Lusitanian/PHPoAuthLib>`_.
165+
`carlos-mg89/PHPoAuthLib <https://github.com/carlos-mg89/PHPoAuthLib>`_.
166166

167167
The example files below show the minimum needed to enable an OAuth service in
168-
phpBB. They are copies of the bitly service implementation from phpBB3's
168+
phpBB. They are copies of the bitly service implementation from phpBB's
169169
develop branch.
170170

171171
The Class file

development/extensions/tutorial_key_concepts.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,17 +135,22 @@ then the ``IN_PHPBB`` test is required prior to any executable code:
135135
136136
.. seealso::
137137

138-
* The phpBB 3.1 `Coding Guidelines <https://area51.phpbb.com/docs/31x/coding-guidelines.html>`_.
138+
* The phpBB :doc:`Coding Guidelines <../development/index>`.
139139
* The phpBB Customisation Database `PHP Validation Policy <https://www.phpbb.com/extensions/rules-and-policies/validation-policy/#php>`_.
140140

141141

142142
Template files
143143
==============
144144

145-
Templating for extensions is no different than templating for phpBB3 in general. phpBB 3.1 has switched to the
145+
Templating for extensions is no different than templating for phpBB in general. Since version 3.1, phpBB has switched to the
146146
Twig template engine but retains phpBB’s original templating syntax. Therefore, either phpBB or Twig template syntax
147147
is permissible in an extension. If you are not familiar with Twig, you may use phpBB’s syntax.
148148

149+
.. note::
150+
151+
phpBB 4.0 will be deprecating the phpBB template syntax in favour of Twig. Therefore, it is recommended to use Twig syntax
152+
in your extensions to future-proof them.
153+
149154
An extension can contain two types of template files: custom templates and :ref:`template-events-label`.
150155
An extension's custom template files should have unique names, preferably prefixed with the vendor and extension
151156
names, to prevent conflicts with other extension or phpBB template files. In addition to template

development/language/validation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Package
3636
this folder.
3737
* Revision name in the `Customisation Database`_ should be left blank, contain
3838
the phpBB package version and/or package release name (e.g. ``3.3.10`` /
39-
``Bertie's translation` for 3.3.10) for more understanding.
39+
``Bertie's translation`` for 3.3.10) for more understanding.
4040

4141
Package Validation
4242
==================
@@ -164,7 +164,7 @@ Please do not omit any of these lines, and fill them out carefully.
164164

165165
.. note::
166166

167-
The ``composer.json`` must be valid JSON code. You can validate it using ``composer.phar``, see: `composer.json validation`_.
167+
The ``composer.json`` must be valid JSON code. You can validate it using ``composer.phar``, see: `composer.json validation`_.
168168

169169
\*/index.htm
170170
------------

development/start/getting_started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Although we are rather proud of the included styles, we realise that they may no
5151

5252
For more information about styles, please see: https://www.phpbb.com/styles/
5353

54-
**Please note** that 3rd party styles downloaded for versions of phpBB2 will **not** work in phpBB3. It is also important to ensure that the style is updated to match the current version of the phpBB software you are using.
54+
**Please note** that 3rd party styles downloaded for previous versions of phpBB will **not** work. It is important to ensure that the style is updated to match the current version of the phpBB software you are using.
5555

5656
Once you have downloaded a style, the usual next step is to unarchive (or upload the unarchived contents of) the package into your ``styles/`` directory. You then need to visit ``Administration Control Panel -> Customise tab -> Style management -> Install Styles`` where you should see the new style available. Click "Install style" to install the style.
5757

@@ -139,7 +139,7 @@ Please note that the development forums should **NOT** be used to seek support f
139139

140140
The phpBB developers use a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please **DO NOT** post bug reports to our forums. In addition please **DO NOT** use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).
141141

142-
http://tracker.phpbb.com/browse/PHPBB3
142+
http://tracker.phpbb.com/browse/PHPBB
143143

144144
While we very much appreciate receiving bug reports (the more reports the more stable phpBB will be) we ask you carry out a few steps before adding new entries:
145145

development/start/install.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ Installation
55
1. Quick install
66
================
77

8-
If you have basic knowledge of using FTP and are sure your hosting service or server will run phpBB3 you can use these steps to quickly get started. For a more detailed explanation you should skip this and go to `2. Requirements`_ below.
8+
If you have basic knowledge of using FTP and are sure your hosting service or server will run phpBB you can use these steps to quickly get started. For a more detailed explanation you should skip this and go to `2. Requirements`_ below.
99

10-
Decompress the phpBB3 archive to a local directory on your system.
10+
Decompress the phpBB archive to a local directory on your system.
1111
Upload all the files contained in this archive (retaining the directory structure) to a web accessible directory on your server or hosting account.
1212
Change the permissions on config.php to be writable by all (``666`` or ``-rw-rw-rw-`` within your FTP Client)
1313
Change the permissions on the following directories to be writable by all (``777`` or ``-rwxrwxrwx`` within your FTP Client):
1414
``store/``, ``cache/``, ``files/`` and ``images/avatars/upload/``.
15-
Point your web browser to the location where you uploaded the phpBB3 files with the addition of ``install/app.php`` or simply ``install/``, e.g. ``http://www.example.com/phpBB3/install/app.php``, ``http://www.example.com/forum/install/``.
15+
Point your web browser to the location where you uploaded the phpBB files with the addition of ``install/app.php`` or simply ``install/``, e.g. ``http://www.example.com/phpBB/install/app.php``, ``http://www.example.com/forum/install/``.
1616
Click the **INSTALL** tab, follow the steps and fill out all the requested information.
1717
Change the permissions on config.php to be writable only by yourself (``644`` or ``-rw-r--r--`` within your FTP Client)
18-
phpBB3 should now be available, please **MAKE SURE** you read at least `6. Conversion from phpBB 2.0.x to phpBB 3.2.x`_ below for important, security related post-installation instructions, and also take note of `7. Important (security related) post-Install tasks for all installation methods`_ regarding anti-spam measures.
18+
phpBB should now be available, please **MAKE SURE** you read at least `6. Conversion from phpBB 2.0.x to phpBB 3.2.x`_ below for important, security related post-installation instructions, and also take note of `7. Important (security related) post-Install tasks for all installation methods`_ regarding anti-spam measures.
1919
If you experienced problems or do not know how to proceed with any of the steps above please read the rest of this document.
2020

2121
2. Requirements
2222
===============
2323

24-
phpBB 3.2.x has a few requirements which must be met before you are able to install and use it.
24+
phpBB has a few requirements which must be met before you are able to install and use it.
2525

2626
A webserver or web hosting account running on any major Operating System with support for PHP
2727
A SQL database system, **one of**:
@@ -53,7 +53,7 @@ All .php, .sql, .cfg, .css, .js, .html, .htaccess and .txt files should be uploa
5353

5454
phpBB comes supplied with British English as its standard language. However, a number of separate packs for different languages are available. If you are not a native English speaker you may wish to install one or more of these packages before continuing. The installation process below will allow you to select a default language from those available (you can, of course, change this default at a later stage). For more details on language packs, where to obtain them and how to install them please see :ref:`i-languages-internationalisation-i18n`.
5555

56-
Once all the files have been uploaded to your site, you should point your browser at this location with the addition of ``/install/``. For example, if your domain name is ``www.example.com`` and you placed the phpBB files in the directory ``/phpBB3`` off your web root you would enter ``http://www.example.com/phpBB3/install/`` or (alternatively) ``http://www.example.com/phpBB3/install/app.php`` into your browser. When you have done this, you should see the **phpBB Introduction** screen appear.
56+
Once all the files have been uploaded to your site, you should point your browser at this location with the addition of ``/install/``. For example, if your domain name is ``www.example.com`` and you placed the phpBB files in the directory ``/phpBB`` off your web root you would enter ``http://www.example.com/phpBB/install/`` or (alternatively) ``http://www.example.com/phpBB/install/app.php`` into your browser. When you have done this, you should see the **phpBB Introduction** screen appear.
5757

5858
3.i. Introduction
5959
-------------------
@@ -166,7 +166,7 @@ To perform the update, either follow the instructions from the **Administration
166166
- Go to the `downloads page <https://www.phpbb.com/downloads/>`_ and download the latest update package listed there, matching your current version.
167167
- Upload the uncompressed archive contents to your phpBB installation - only the ``install/`` and ``vendor/`` folders are required. Upload these folders in their entirety, retaining the file structure.
168168
- After the install folder is present, phpBB will go offline automatically.
169-
- Point your browser to the install directory, for example ``http://www.example.com/phpBB3/install/``
169+
- Point your browser to the install directory, for example ``http://www.example.com/phpBB/install/``
170170
- Choose the "Update" Tab and follow the instructions
171171

172172

@@ -198,23 +198,23 @@ Delete the ``install/`` directory
198198
6. Conversion from phpBB 2.0.x to phpBB 3.2.x
199199
=============================================
200200

201-
This paragraph explains the steps necessary to convert your existing phpBB2 installation to phpBB3.
201+
This paragraph explains the steps necessary to convert your existing phpBB2 installation to the latest phpBB.
202202

203203
6.i. Requirements before converting
204204
-----------------------------------
205205

206-
Before converting, we heavily recommend you do a **full backup of your database and files!** If you are unsure how to achieve this, please ask your hosting provider for advice. You basically need to follow the instructions given for `3. New installation`_. Please **do not** overwrite any old files - install phpBB3 at a different location.
206+
Before converting, we heavily recommend you do a **full backup of your database and files!** If you are unsure how to achieve this, please ask your hosting provider for advice. You basically need to follow the instructions given for `3. New installation`_. Please **do not** overwrite any old files - install phpBB in a different location.
207207

208-
Once you made a backup of everything and also have a brand new phpBB3 installation, you can now begin the conversion.
208+
Once you made a backup of everything and also have a brand new phpBB installation, you can now begin the conversion.
209209

210-
Note that the conversion requires ``CREATE`` and ``DROP`` privileges for the phpBB3 database user account.
210+
Note that the conversion requires ``CREATE`` and ``DROP`` privileges for the phpBB database user account.
211211

212212
6.ii. Converting
213213
----------------
214214

215-
To begin the conversion, visit the ``install/`` folder of your phpBB3 installation (the same as you have done for installing). Now you will see a new tab **Convert**. Click this tab.
215+
To begin the conversion, visit the ``install/`` folder of your phpBB installation (the same as you have done for installing). Now you will see a new tab **Convert**. Click this tab.
216216

217-
As with install, the conversion is automated. Your previous 2.0.x database tables will not be changed and the original 2.0.x files will remain unaltered. The conversion is actually only filling your phpBB3 database tables and copying additional data over to your phpBB3 installation. This has the benefit that if something goes wrong, you are able to either re-run the conversion or continue a conversion, while your old board is still accessible. We really recommend that you disable your old installation while converting, else you may have inconsistent data after the conversion.
217+
As with install, the conversion is automated. Your previous 2.0.x database tables will not be changed and the original 2.0.x files will remain unaltered. The conversion is actually only filling your phpBB database tables and copying additional data over to your phpBB installation. This has the benefit that if something goes wrong, you are able to either re-run the conversion or continue a conversion, while your old board is still accessible. We really recommend that you disable your old installation while converting, else you may have inconsistent data after the conversion.
218218

219219
Please note that this conversion process may take quite some time and depending on your hosting provider this may result in it failing (due to web server resource limits or other timeout issues). If this is the case, you should ask your provider if they are willing to allow the convert script to temporarily exceed their limits (be nice and they will probably be quite helpful). If your host is unwilling to increase the limits to run the convertor, please see this article for performing the conversion on your local machine: `Knowledge Base - Offline Conversions <https://www.phpbb.com/kb/article/offline-conversions/>`_
220220

@@ -231,7 +231,7 @@ During the conversion, the search index is not created or transferred. This mean
231231

232232
After verifying the settings in the ACP, you can delete the install directory to enable the board. The board will stay disabled until you do so.
233233

234-
Once you are pleased with your new installation, you may want to give it the name of your old installation, changing the directory name. With phpBB3 this is possible without any problems, but you may still want to check your cookie settings within the administration panel; in case your cookie path needs to be adjusted prior to renaming.
234+
Once you are pleased with your new installation, you may want to give it the name of your old installation, changing the directory name. With phpBB this is possible without any problems, but you may still want to check your cookie settings within the administration panel; in case your cookie path needs to be adjusted prior to renaming.
235235

236236
6.iv. Common conversion problems
237237
--------------------------------
@@ -240,9 +240,9 @@ Once you are pleased with your new installation, you may want to give it the nam
240240

241241
**http 500 / white pages** The conversion is a load-heavy procedure. Restrictions imposed by some server hosting providers can cause problems. The most common causes are: values too low for the PHP settings ``memory_limit`` and ``max_execution_time``. Limits on the allowed CPU time are also a frequent cause for such errors, as are limits on the number of database queries allowed. If you cannot change such settings, then contact your hosting provider or run the conversion procedure on a different computer. The phpBB.com forums are also an excellent location to ask for support.
242242

243-
**Password conversion** Due to the utf-8 based handling of passwords in phpBB3, it is not always possible to transfer all passwords. For passwords "lost in translation" the easiest workaround is to use the **I forgot my password** link on the login page.
243+
**Password conversion** Due to the utf-8 based handling of passwords in phpBB, it is not always possible to transfer all passwords. For passwords "lost in translation" the easiest workaround is to use the **I forgot my password** link on the login page.
244244

245-
**Path to your former board** The convertor expects the relative path to your old board's files. So, for instance, if the old board is located at ``http://www.yourdomain.com/forum`` and the phpBB3 installation is located at ``http://www.yourdomain.com/phpBB3``, then the correct value would be ``../forum``. Note that the webserver user must be able to access the source installation's files.
245+
**Path to your former board** The convertor expects the relative path to your old board's files. So, for instance, if the old board is located at ``http://www.yourdomain.com/forum`` and the phpBB installation is located at ``http://www.yourdomain.com/phpBB``, then the correct value would be ``../forum``. Note that the webserver user must be able to access the source installation's files.
246246

247247
**Missing images** If your default board language's language pack does not include all images, then some images might be missing in your installation. Always use a complete language pack as default language.
248248

0 commit comments

Comments
 (0)