diff --git a/development/development/upgrade/400.rst b/development/development/upgrade/400.rst index 9bcad8fb..cb6d9012 100644 --- a/development/development/upgrade/400.rst +++ b/development/development/upgrade/400.rst @@ -40,6 +40,12 @@ The ban system has been greatly refactored for phpBB 4.0. As part of this, the f - Added support for IPv6 banning - Removed "exclude" functionality which resulted in ambiguous settings +Removal of Jabber/XMPP +---------------------- +The Jabber/XMPP functionality has been removed from phpBB 4.0. This includes the Jabber/XMPP settings in the ACP and the Jabber/XMPP notification system. +Users with Jabber/XMPP accounts will no longer receive notifications via Jabber/XMPP and have instead been migrated to email notifications. +The Jabber/XMPP functionality was removed due to the lack of support for the XMPP protocol in modern browsers and the fact that it was not widely used by phpBB users. + Class and function changes ========================== The following table lists class and function changes that might affect custom PHP or Extension code. @@ -391,6 +397,12 @@ Also have a look at the `phpBB API documentation `_ namespace. + **Explanation of columns:** * **Class or function:** The name of the class or function that was added, changed, deprecated, or removed in this version. diff --git a/development/extensions/tutorial_notifications.rst b/development/extensions/tutorial_notifications.rst index fdb4928f..b7e152bb 100644 --- a/development/extensions/tutorial_notifications.rst +++ b/development/extensions/tutorial_notifications.rst @@ -651,14 +651,10 @@ you will have to indicate that in the path, e.g.: ``@vendor_extension/subdirecto return '@vendor_extension/sample'; } -There is also a third notification method, Jabber, which uses the :class:`email/short` directory for its template files. -This notification method is closely tied to the email method, so it is important to also supply that template file, -even though the content might be identical to the email template. - -.. warning:: +.. note:: - Make sure to have both :class:`language/en/email/sample.txt` and :class:`language/en/email/short/sample.txt` - in your extension's language directory to prevent errors. + The previously existing Jabber notification method has been removed in phpBB 4.0. A separate :class:`email/short` directory + for this notification method is no longer used and therefore you no longer need to create a separate template file for it. get_email_template_variables ---------------------------- diff --git a/documentation/content/en/chapters/admin_guide.xml b/documentation/content/en/chapters/admin_guide.xml index 345c35c2..f82e1868 100644 --- a/documentation/content/en/chapters/admin_guide.xml +++ b/documentation/content/en/chapters/admin_guide.xml @@ -10,7 +10,7 @@ Administration Guide - This chapter describes the phpBB 3.3 admin controls. + This chapter describes the phpBB admin controls.
@@ -21,7 +21,7 @@ The Administration Control Panel - Even more so than its predecessor, phpBB 3.3 "Proteus" is highly configurable. You can tune, adjust, or turn off almost all features. To make this load of settings as accessible as possible, we redesigned the Administration Control Panel (ACP) completely. + Even more so than its predecessor, phpBB is highly configurable. You can tune, adjust, or turn off almost all features. To make this load of settings as accessible as possible, we redesigned the Administration Control Panel (ACP) completely. Click on the Administration Control Panel link on the bottom of the default forum style to visit the ACP. The ACP has seven different sections by default with each containing a number of subsections. We will discuss each section in this Admin Guide. @@ -146,7 +146,7 @@ Private Messaging Private Messages are a way for registered members to communicate privately through your board without the need to fall back to e-mail or instant messaging. You can disable this feature with the Private Messaging setting. This will keep the feature turned off for the whole board. You can disable private messages for selected users or groups with Permissions. Please see the Permissions section for more information. - Proteus allows users to create own personal folders to organise Private Messages. The Maximum private message folders setting defines the number of message folders they can create. The default value is 4. You can disable the feature with setting value to 0. + phpBB allows users to create own personal folders to organise Private Messages. The Maximum private message folders setting defines the number of message folders they can create. The default value is 4. You can disable the feature with setting value to 0. Max Private Messages Per Box sets the number of Private Messages each folder can contain. The default value is 50, Set it to 0 to allow unlimited messages per folder. If you limit the number of messages users can store in their folders, you need to define a default action that is taken once a folder is full. This can be changed in the "Full Folder Default Action" list. The oldest message gets deleted or the new message will be held back until the folder has place for it. Note that users will be able to choose this for themselves in their PM options and this setting only changes the default value they face. This will not override the action a user chosen. When sending a private message, it is still possible to edit the message until the recipient reads it. After a sent private message has been read, editing the message is no longer possible. To limit the time a message can be edited before the recipient reads it, you can set the Limit Editing Time. The default value is 0, which allows editing until the message is read. Note that you can disallow users or groups to edit Private Messages after sending through Permissions. If the permission to edit messages is denied, it will override this setting. @@ -330,30 +330,37 @@
-
+
- MennoniteHobbit + Marc - Jabber settings - - phpBB3 also has the ability to communicate messages to users via Jabber, your board can be configured to board notifications via Jabber. Here, you can enable and control exactly how your board will use Jabber for communication. + Web Push settings - - Some Jabber servers include gateways or transports which allow you to contact users on other networks. Not all servers offer all transports and changes in protocols can prevent transports from operating. Note that it may take several seconds to update Jabber account details, so do not stop the script until it has finished! - + phpBB also has the ability to send notifications to users via Web Push. Your board can be configured to board notifications via Web Push. - Jabber settings - Enable Jabber: Set this to Enabled if you want to enable the use of Jabber for messaging and notifications. - Jabber server: The Jabber server that your board will use. For a list of public servers, see jabber.org's list of open, public servers. - Jabber port: The port that the Jabber server specified above is located on. Port 5222 is the most common port; if you are unsure about this, leave this value alone. - Jabber username or JID: The Jabber username or a complete Jabber ID (looks like an e-mail address) that your board will use when connecting to the specified Jabber server. You must specify an already registered account. - Jabber password: The password for the Jabber username specified above. If the Jabber username is unregistered, phpBB3 will attempt to register the above Jabber username, with this specified value as the password.This password will be stored as plain text in the database, visible to everybody who can access your database or who can view this configuration page. - Jabber package size: This is the number of messages that can be sent in one package. If this is set to "0", messages will be sent immediately and is will not be queued for later sending. + Web Push settings + + Enable Web Push: Set this to Yes if you want to enable the use of Web Push for notifications. + + + Server identification public key: The Voluntary Application Server Identification (VAPID) public key is shared to authenticate push messages from your site. You can set this manually or generate the key by clicking on the Generate Identification keys button. + Caution: Modifying the VAPID public key will automatically render all Web Push subscriptions invalid. + + + Server identification private key: The Voluntary Application Server Identification (VAPID) private key is used to generate authenticated push messages dispatched from your site. The VAPID private key must form a valid public-private key pair alongside the VAPID public key. You can set this manually or generate the key by clicking on the Generate Identification keys button. + Caution: Modifying the VAPID private key will automatically render all Web Push subscriptions invalid. + + + Enable all user-based web push notification options by default: When this setting is enabled, users who subscribe and allow browser notifications will start receiving them automatically. Users only need to visit the UCP Notification settings to disable any unwanted notifications. If this setting is disabled, users will not receive any notifications, even if they have subscribed, until they visit the UCP Notification settings to enable the specific notification options they wish to receive. + + + Show “Subscribe” button in notification dropdown: Display a “Subscribe” button in the Notification dropdown, allowing users to easily subscribe to push notifications from anywhere in the forum. +
@@ -739,8 +746,7 @@ Subforums - One of the features in phpBB 3.3 is subforums. Especially bulletin boards with a high number of forums will benefit from this. In the simple flat category and forum approach in phpBB 2.0, all forums and categories were listed on the forum index. In Proteus you can now put as many forums, links, or categories as you like inside other forums. - + One of the features in phpBB is subforums. Especially bulletin boards with a high number of forums will benefit from this. In the simple flat category and forum approach in phpBB 2.0, all forums and categories were listed on the forum index. In phpBB you can now put as many forums, links, or categories as you like inside other forums. If you have a forum about pets for instance, you are able to put subforums for cats, dogs, or guinea pigs inside it without making the parent "Pets" forum a category. In this example, only the "Pets" forum will be listed on the index like a normal forum. Its subforums will appear as simple links below the forum description (unless you disabled this).
@@ -1899,7 +1905,7 @@ Permissions - On your board, you will need to control what users can and cannot do, and what they can and cannot see. With the flexible and detailed system that Proteus provides, you have an extensive ability to manage permissions. There are five types of permissions in phpBB3: + On your board, you will need to control what users can and cannot do, and what they can and cannot see. With the flexible and detailed system that phpBB provides, you have an extensive ability to manage permissions. There are five types of permissions in phpBB: Global User permissions Global Moderator permissions diff --git a/documentation/content/en/chapters/glossary.xml b/documentation/content/en/chapters/glossary.xml index 6f4b64b2..c035859a 100644 --- a/documentation/content/en/chapters/glossary.xml +++ b/documentation/content/en/chapters/glossary.xml @@ -180,13 +180,6 @@ - - Jabber - - Jabber is the former name of Extensible Messaging and Presence Protocol (XMPP) an open-source protocol that can be used for instant messenging. For more information on XMPP's role in phpBB, see . - - - Listener @@ -330,6 +323,13 @@ Usergroups are a way of grouping users. This makes it easier to set permissions to many people at the same time (e.g. create a moderator group and give it moderating permissions to a certain forum instead of giving lots of individual people moderating permissions separately). A usergroup has a usergroup moderator (a leader, essentially), who has the ability to add or delete users from the group. Usergroups can be set to hidden, closed or open. If a usergroup is open, users can try requesting membership via the proper page within the group control panel. phpBB 3.3 has six pre-defined usergroups. + + + Web Push + + Web Push notifications are messages sent by a website to a user's browser, even when the user is not actively browsing the site. They deliver notifications to all subscribed devices in real-time. For more information on Web Push notifications in phpBB, see . + + diff --git a/documentation/content/en/chapters/quick_start_guide.xml b/documentation/content/en/chapters/quick_start_guide.xml index e74c753e..cd867252 100644 --- a/documentation/content/en/chapters/quick_start_guide.xml +++ b/documentation/content/en/chapters/quick_start_guide.xml @@ -98,7 +98,7 @@ Installation - phpBB 3.3 Proteus has an easy to use installation system that will guide you through the installation process. + phpBB has an easy to use installation system that will guide you through the installation process. After you have decompressed the phpBB3 archive and uploaded the files to the location where you want it to be installed, you need to enter the URL into your browser to open the installation screen. The first time you point your browser to the URL (http://www.example.com/phpBB3 for instance), phpBB will detect that it is not yet installed and automatically redirect you to the installation screen.
Introduction @@ -302,7 +302,7 @@ Setting permissions - After you created your first forum, you have to decide who has access to it and what your users are allowed to do and what not. This is what Permissions are for. You can disallow guests to post or hand out moderating powers, for instance. Almost every aspect of user interaction with phpBB 3.3 Proteus can be adjusted with permissions. + After you created your first forum, you have to decide who has access to it and what your users are allowed to do and what not. This is what Permissions are for. You can disallow guests to post or hand out moderating powers, for instance. Almost every aspect of user interaction with phpBB can be adjusted with permissions.
Permission types @@ -353,7 +353,7 @@
The Forum Permissions page shows you two columns, one for users and one for groups to select (see ). The top lists on both columns labelled as Manage Users and Manage Groups show users and groups that already have permissions on at least one of your selected forums set. You can select them and change their permissions with the Edit Permissions button, or use Remove Permissions to remove them which leads to them not having permissions set, and therefore not being able to see the forum or have any access to it (unless they have access to it through another group). The bottom boxes allow you to add new users or groups, that do not currently have permissions set on at least one of your selected forums. To add permissions for groups, select one or more groups either in the Add Groups list (this works similar with users, but if you want to add new users, you have to type them in manually in the Add Users text box or use the Find a member function). Add Permissions will take you to the permission interface. Each forum you selected is listed, with the groups or users to change the permissions for below them. - There are two ways to assign permissions: You can set them manually or use predefined Permission Roles for a simpler but less powerful way. You can switch between both approaches any time you want. You can skip the manual permission introduction and jump directly into the section on "Permissions Roles", if you are eager to get everything running as quickly as possible. But remember that permission roles do only offer a small bit of what the permission system has to offer and we believe that to be a good Proteus administrator, you have to fully grasp permissions. + There are two ways to assign permissions: You can set them manually or use predefined Permission Roles for a simpler but less powerful way. You can switch between both approaches any time you want. You can skip the manual permission introduction and jump directly into the section on "Permissions Roles", if you are eager to get everything running as quickly as possible. But remember that permission roles do only offer a small bit of what the permission system has to offer and we believe that to be a good phpBB administrator, you have to fully grasp permissions. Both ways only differ in the way you set them. They both share the same interface.
@@ -385,7 +385,7 @@
Permissions roles - phpBB 3.3 Proteus ships with a number of default permission roles, that offer you a wide variety of options for setting permissions. Instead of having to check each radio button manually, you can select a predefined role in the Rolepull down list. Each role has a detailed description, that will pop up when you hover your mouse over it. Submit your changes with Apply Permissions or Apply All Permissions when you are satisfied with them. That will set the permissions and you are done. + phpBB ships with a number of default permission roles, that offer you a wide variety of options for setting permissions. Instead of having to check each radio button manually, you can select a predefined role in the Rolepull down list. Each role has a detailed description, that will pop up when you hover your mouse over it. Submit your changes with Apply Permissions or Apply All Permissions when you are satisfied with them. That will set the permissions and you are done.
Permission roles diff --git a/documentation/content/en/chapters/upgrade_guide.xml b/documentation/content/en/chapters/upgrade_guide.xml index 54807b32..19a33846 100644 --- a/documentation/content/en/chapters/upgrade_guide.xml +++ b/documentation/content/en/chapters/upgrade_guide.xml @@ -36,15 +36,15 @@ - Upgrading from 3.0 to 3.3 + Upgrading from 3.0 to 4.0 - Upgrading to phpBB 3.3 will render previously installed MODifications and styles unusable. If you have a custom logo, it will need to be redone after the upgrade. See Knowledge Base: How to Change your Board Logo. + Upgrading to phpBB 4.0 will render previously installed MODifications and styles unusable. If you have a custom logo, it will need to be redone after the upgrade. See Knowledge Base: How to Change your Board Logo. - phpBB 3.3 is not compatible with 3.0 and most of the previous files will need to be removed prior to upgrading. + phpBB 4.0 is not compatible with 3.0 and most of the previous files will need to be removed prior to upgrading. To upgrade, perform the following steps: - Ensure that your server meets the requirements for running phpBB 3.3: + Ensure that your server meets the requirements for running phpBB 4.0: Make a backup of the original files Make a backup of the database Deactivate all styles except for prosilver diff --git a/documentation/content/en/chapters/user_guide.xml b/documentation/content/en/chapters/user_guide.xml index b71b9ec7..c7d8d8cb 100644 --- a/documentation/content/en/chapters/user_guide.xml +++ b/documentation/content/en/chapters/user_guide.xml @@ -146,11 +146,6 @@ Personal settings Personal settings control the information that is displayed when a user views your profile. - ICQ Number: Your account number associated with ICQ system. - AOL Instant Messenger: Your screen name associated with AOL Instant Messenger system. - Windows Live Messenger: Your email address associated with the Windows Live service. - Yahoo Messenger: Your username associated with the Yahoo Messenger service. - Jabber Address: Your username associated with the Jabber service. Facebook: Your unique username/page name associated with the Facebook service. Twitter: Your username associated with the Twitter service. Skype: Your username associated with the Skype service. diff --git a/documentation/create_docs.sh b/documentation/create_docs.sh index 53c7b394..f82439ab 100755 --- a/documentation/create_docs.sh +++ b/documentation/create_docs.sh @@ -1,13 +1,13 @@ #!/bin/bash # set this to the correct path -path=${1:-'/var/www/phpbb.com/htdocs/support/documentation/3.3'} +path=${1:-'/var/www/phpbb.com/htdocs/support/documentation/4.0'} echo "Removing build directory" rm -rf build echo "Creating docs" -xsltproc --xinclude xsl/proteus_php.xsl proteus_doc.xml +xsltproc --xinclude xsl/triton_php.xsl triton_doc.xml exit_code=$? # Capture the exit code if [ "$exit_code" == "0" ]; then diff --git a/documentation/create_pdf.bat b/documentation/create_pdf.bat index 36c6d6eb..08b7f200 100644 --- a/documentation/create_pdf.bat +++ b/documentation/create_pdf.bat @@ -4,9 +4,9 @@ set fop_path=C:\fop echo Removing previous PDF -del proteus_doc.pdf +del triton_doc.pdf echo Creating new PDF -%fop_path%\fop -xml proteus_doc.xml -xsl xsl\proteus_pdf.xsl -pdf proteus_doc.pdf +%fop_path%\fop -xml triton_doc.xml -xsl xsl\triton_pdf.xsl -pdf triton_doc.pdf echo Done diff --git a/documentation/create_pdf.sh b/documentation/create_pdf.sh index 46439462..fec72acc 100755 --- a/documentation/create_pdf.sh +++ b/documentation/create_pdf.sh @@ -1,11 +1,11 @@ #!/bin/bash echo "Removing previous PDF" -if [ -f proteus_doc.pdf ]; then - rm proteus_doc.pdf +if [ -f triton_doc.pdf ]; then + rm triton_doc.pdf fi echo "Creating new PDF" -fop -xml proteus_doc.xml -xsl xsl/proteus_pdf.xsl -pdf proteus_doc.pdf +fop -xml triton_doc.xml -xsl xsl/triton_pdf.xsl -pdf triton_doc.pdf echo "Done" diff --git a/documentation/proteus_doc.xml b/documentation/triton_doc.xml similarity index 86% rename from documentation/proteus_doc.xml rename to documentation/triton_doc.xml index b7cbc825..66c5984d 100644 --- a/documentation/proteus_doc.xml +++ b/documentation/triton_doc.xml @@ -1,9 +1,9 @@ - phpBB 3.3 <emphasis>Proteus</emphasis> Documentation + phpBB 4.0 <emphasis>Triton</emphasis> Documentation - The detailed documentation for phpBB 3.3 Proteus. + The detailed documentation for phpBB 4.0 Triton. @@ -16,7 +16,7 @@ - 2005 + 2025 phpBB Group phpBB Group diff --git a/documentation/xsl/proteus_pdf.xsl b/documentation/xsl/triton_pdf.xsl similarity index 100% rename from documentation/xsl/proteus_pdf.xsl rename to documentation/xsl/triton_pdf.xsl diff --git a/documentation/xsl/proteus_php.xsl b/documentation/xsl/triton_php.xsl similarity index 99% rename from documentation/xsl/proteus_php.xsl rename to documentation/xsl/triton_php.xsl index 54deef8a..6cb55daf 100644 --- a/documentation/xsl/proteus_php.xsl +++ b/documentation/xsl/triton_php.xsl @@ -15,7 +15,7 @@ - + @@ -37,7 +37,7 @@ - + diff --git a/documentation/xsl/proteus_php_subsection.xsl b/documentation/xsl/triton_php_subsection.xsl similarity index 99% rename from documentation/xsl/proteus_php_subsection.xsl rename to documentation/xsl/triton_php_subsection.xsl index 7d94c199..3e342902 100644 --- a/documentation/xsl/proteus_php_subsection.xsl +++ b/documentation/xsl/triton_php_subsection.xsl @@ -15,7 +15,7 @@ - + @@ -40,7 +40,7 @@ - + diff --git a/documentation/xsl/proteus_phpbb_dot_com.xsl b/documentation/xsl/triton_phpbb_dot_com.xsl similarity index 99% rename from documentation/xsl/proteus_phpbb_dot_com.xsl rename to documentation/xsl/triton_phpbb_dot_com.xsl index 8b3fd7f7..36fb988e 100644 --- a/documentation/xsl/proteus_phpbb_dot_com.xsl +++ b/documentation/xsl/triton_phpbb_dot_com.xsl @@ -14,7 +14,7 @@ - + @@ -39,7 +39,7 @@ - + diff --git a/documentation/xsl/proteus_xhtml.xsl b/documentation/xsl/triton_xhtml.xsl similarity index 98% rename from documentation/xsl/proteus_xhtml.xsl rename to documentation/xsl/triton_xhtml.xsl index cff14f91..c91af245 100644 --- a/documentation/xsl/proteus_xhtml.xsl +++ b/documentation/xsl/triton_xhtml.xsl @@ -12,7 +12,7 @@ - +