Skip to content

Commit 11b9501

Browse files
committed
Update to Triton where possible
1 parent 8db62d7 commit 11b9501

12 files changed

+30
-31
lines changed

documentation/content/en/chapters/admin_guide.xml

+5-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
</chapterinfo>
1111
<title>Administration Guide</title>
1212
<abstract>
13-
<para>This chapter describes the phpBB 3.3 admin controls.</para>
13+
<para>This chapter describes the phpBB admin controls.</para>
1414
</abstract>
1515
<section id="admin_control_panel">
1616
<sectioninfo>
@@ -21,7 +21,7 @@
2121
</authorgroup>
2222
</sectioninfo>
2323
<title>The Administration Control Panel</title>
24-
<para>Even more so than its predecessor, phpBB 3.3 &quot;Proteus&quot; 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. </para>
24+
<para>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. </para>
2525
<para>Click on the <guilabel>Administration Control Panel</guilabel> link on the bottom of the default forum style to visit the <acronym>ACP</acronym>.</para>
2626
<para>The <acronym>ACP</acronym> has seven different sections by default with each containing a number of subsections. We will discuss each section in this Admin Guide. </para>
2727

@@ -146,7 +146,7 @@
146146
<title>Private Messaging</title>
147147
<para><glossterm>Private Messages</glossterm> are a way for registered members to communicate privately through your board without the need to fall back to e-mail or instant messaging. </para>
148148
<para>You can disable this feature with the <guilabel>Private Messaging</guilabel> setting. This will keep the feature turned off for the whole board. You can disable private messages for selected users or groups with <link linkend="acp_permissions">Permissions</link>. Please see the <link linkend="acp_permissions">Permissions section</link> for more information. </para>
149-
<para>Proteus allows users to create own personal folders to organise Private Messages. The <guilabel>Maximum private message folders</guilabel> 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. </para>
149+
<para>phpBB allows users to create own personal folders to organise Private Messages. The <guilabel>Maximum private message folders</guilabel> 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. </para>
150150
<para><guilabel>Max Private Messages Per Box</guilabel> sets the number of Private Messages each folder can contain. The default value is <guilabel>50</guilabel>, Set it to 0 to allow unlimited messages per folder. </para>
151151
<para>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 &quot;Full Folder Default Action&quot; 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. </para>
152152
<para>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 <guilabel>Limit Editing Time</guilabel>. 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 <link linkend="acp_permissions">Permissions</link>. If the permission to edit messages is denied, it will override this setting. </para>
@@ -746,8 +746,7 @@
746746
</authorgroup>
747747
</sectioninfo>
748748
<title>Subforums</title>
749-
<para>One of the features in phpBB 3.3 is <glossterm>subforums</glossterm>. 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.</para>
750-
<!-- (TODO: Diagram of a 2.0 / 3.0 comparison) -->
749+
<para>One of the features in phpBB is <glossterm>subforums</glossterm>. 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.</para>
751750
<para>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).</para>
752751

753752
<figure id="img_acp_subforums_list">
@@ -1906,7 +1905,7 @@
19061905
</authorgroup>
19071906
</sectioninfo>
19081907
<title>Permissions</title>
1909-
<para>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:</para>
1908+
<para>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:</para>
19101909
<itemizedlist>
19111910
<listitem><para>Global User permissions</para></listitem>
19121911
<listitem><para>Global Moderator permissions</para></listitem>

documentation/content/en/chapters/quick_start_guide.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
</authorgroup>
9999
</sectioninfo>
100100
<title>Installation</title>
101-
<para>phpBB 3.3 Proteus has an easy to use installation system that will guide you through the installation process.</para>
101+
<para>phpBB has an easy to use installation system that will guide you through the installation process.</para>
102102
<para>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 <acronym>URL</acronym> into your browser to open the installation screen. The first time you point your browser to the <acronym>URL</acronym> (<uri>http://www.example.com/phpBB3</uri> for instance), phpBB will detect that it is not yet installed and automatically redirect you to the installation screen.</para>
103103
<figure id="img_quick_installation_intro">
104104
<title>Introduction</title>
@@ -302,7 +302,7 @@
302302
</authorgroup>
303303
</sectioninfo>
304304
<title>Setting permissions</title>
305-
<para>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.</para>
305+
<para>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.</para>
306306

307307
<section id="quick_permissions_types">
308308
<title>Permission types</title>
@@ -353,7 +353,7 @@
353353
</figure>
354354
<para>The <guilabel>Forum Permissions</guilabel> page shows you two columns, one for users and one for groups to select (see <xref linkend="img_quick_permissions_select" />). The top lists on both columns labelled as <guilabel>Manage Users</guilabel> and <guilabel> Manage Groups</guilabel> 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 <guilabel>Edit Permissions</guilabel> button, or use <guilabel>Remove Permissions</guilabel> 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.</para>
355355
<para>To add permissions for groups, select one or more groups either in the <guilabel>Add Groups</guilabel> list (this works similar with users, but if you want to add new users, you have to type them in manually in the <guilabel>Add Users</guilabel> text box or use the <guilabel>Find a member</guilabel> function). <guilabel>Add Permissions</guilabel> 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. </para>
356-
<para>There are two ways to assign permissions: You can set them manually or use predefined <guilabel>Permission Roles</guilabel> 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 <link linkend="quick_permissions_roles">jump directly into the section on "Permissions Roles"</link>, 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. </para>
356+
<para>There are two ways to assign permissions: You can set them manually or use predefined <guilabel>Permission Roles</guilabel> 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 <link linkend="quick_permissions_roles">jump directly into the section on "Permissions Roles"</link>, 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. </para>
357357
<para>Both ways only differ in the way you set them. They both share the same interface.</para>
358358
</section>
359359
<section id="quick_permissions_manual">
@@ -385,7 +385,7 @@
385385
</section>
386386
<section id="quick_permissions_roles">
387387
<title>Permissions roles</title>
388-
<para>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 <guilabel>Role</guilabel>pull down list. Each role has a detailed description, that will pop up when you hover your mouse over it. Submit your changes with <guilabel>Apply Permissions</guilabel> or <guilabel>Apply All Permissions</guilabel> when you are satisfied with them. That will set the permissions and you are done.</para>
388+
<para>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 <guilabel>Role</guilabel>pull down list. Each role has a detailed description, that will pop up when you hover your mouse over it. Submit your changes with <guilabel>Apply Permissions</guilabel> or <guilabel>Apply All Permissions</guilabel> when you are satisfied with them. That will set the permissions and you are done.</para>
389389
<figure id="img_quick_permissions_roles">
390390
<title>Permission roles</title>
391391
<mediaobject>

documentation/content/en/chapters/upgrade_guide.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@
3636
</author>
3737
</authorgroup>
3838
</sectioninfo>
39-
<title>Upgrading from 3.0 to 3.3</title>
39+
<title>Upgrading from 3.0 to 4.0</title>
4040
<warning>
41-
<para>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 <ulink url="https://www.phpbb.com/support/docs/en/3.3/kb/article/how-to-change-your-board-logo/">Knowledge Base: How to Change your Board Logo</ulink>.</para>
41+
<para>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 <ulink url="https://www.phpbb.com/support/docs/en/3.3/kb/article/how-to-change-your-board-logo/">Knowledge Base: How to Change your Board Logo</ulink>.</para>
4242
</warning>
4343

44-
<para>phpBB 3.3 is not compatible with 3.0 and most of the previous files will need to be removed prior to upgrading.</para>
44+
<para>phpBB 4.0 is not compatible with 3.0 and most of the previous files will need to be removed prior to upgrading.</para>
4545
<para>To upgrade, perform the following steps:</para>
4646
<orderedlist>
47-
<listitem><para>Ensure that your server meets the requirements for running phpBB 3.3: <xref linkend="quick_requirements" /></para></listitem>
47+
<listitem><para>Ensure that your server meets the requirements for running phpBB 4.0: <xref linkend="quick_requirements" /></para></listitem>
4848
<listitem><para><emphasis role="bold">Make a backup of the original files</emphasis></para></listitem>
4949
<listitem><para><emphasis role="bold">Make a backup of the database</emphasis></para></listitem>
5050
<listitem><para>Deactivate all styles except for prosilver</para></listitem>

documentation/create_docs.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#!/bin/bash
22

33
# set this to the correct path
4-
path=${1:-'/var/www/phpbb.com/htdocs/support/documentation/3.3'}
4+
path=${1:-'/var/www/phpbb.com/htdocs/support/documentation/4.0'}
55

66
echo "Removing build directory"
77
rm -rf build
88

99
echo "Creating docs"
10-
xsltproc --xinclude xsl/proteus_php.xsl proteus_doc.xml
10+
xsltproc --xinclude xsl/triton_php.xsl triton_doc.xml
1111
exit_code=$? # Capture the exit code
1212

1313
if [ "$exit_code" == "0" ]; then

documentation/create_pdf.bat

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
set fop_path=C:\fop
55

66
echo Removing previous PDF
7-
del proteus_doc.pdf
7+
del triton_doc.pdf
88

99
echo Creating new PDF
10-
%fop_path%\fop -xml proteus_doc.xml -xsl xsl\proteus_pdf.xsl -pdf proteus_doc.pdf
10+
%fop_path%\fop -xml triton_doc.xml -xsl xsl\triton_pdf.xsl -pdf triton_doc.pdf
1111

1212
echo Done

documentation/create_pdf.sh

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
#!/bin/bash
22

33
echo "Removing previous PDF"
4-
if [ -f proteus_doc.pdf ]; then
5-
rm proteus_doc.pdf
4+
if [ -f triton_doc.pdf ]; then
5+
rm triton_doc.pdf
66
fi
77

88
echo "Creating new PDF"
9-
fop -xml proteus_doc.xml -xsl xsl/proteus_pdf.xsl -pdf proteus_doc.pdf
9+
fop -xml triton_doc.xml -xsl xsl/triton_pdf.xsl -pdf triton_doc.pdf
1010

1111
echo "Done"

documentation/proteus_doc.xml renamed to documentation/triton_doc.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<book>
33
<bookinfo>
4-
<title>phpBB 3.3 <emphasis>Proteus</emphasis> Documentation</title>
4+
<title>phpBB 4.0 <emphasis>Triton</emphasis> Documentation</title>
55
<abstract>
6-
<para>The detailed documentation for phpBB 3.3 <emphasis>Proteus</emphasis>. </para>
6+
<para>The detailed documentation for phpBB 4.0 <emphasis>Triton</emphasis>. </para>
77
</abstract>
88
<authorgroup>
99
<editor>
@@ -16,7 +16,7 @@
1616
</editor>
1717
</authorgroup>
1818
<copyright>
19-
<year>2005</year>
19+
<year>2025</year>
2020
<holder> phpBB Group </holder>
2121
</copyright>
2222
<orgname>phpBB Group</orgname>
File renamed without changes.

documentation/xsl/proteus_php.xsl renamed to documentation/xsl/triton_php.xsl

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<xsl:param name="html.ext" select="'.php'"/>
1616

1717
<!-- Link to the stylesheet -->
18-
<xsl:param name="html.stylesheet" select="'/support/documentation/3.3/style.css'"/>
18+
<xsl:param name="html.stylesheet" select="'/support/documentation/4.0/style.css'"/>
1919

2020
<xsl:param name="chunk.fast" select="1"/>
2121
<!-- Do NOT add the first section into the starting chunk -->
@@ -37,7 +37,7 @@
3737
<xsl:param name="chunker.output.doctype-public" select="''"/>
3838
<xsl:param name="chunker.output.doctype-system" select="''"/>
3939

40-
<xsl:variable name="main.title.text" select="'phpBB 3.3 Proteus Documentation'"/>
40+
<xsl:variable name="main.title.text" select="'phpBB 4.0 Triton Documentation'"/>
4141

4242
<xsl:template name="user.preroot">
4343

documentation/xsl/proteus_php_subsection.xsl renamed to documentation/xsl/triton_php_subsection.xsl

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<xsl:param name="html.ext" select="'.php'"/>
1616

1717
<!-- Link to the stylesheet -->
18-
<xsl:param name="html.stylesheet" select="'/support/documentation/3.3/style.css'"/>
18+
<xsl:param name="html.stylesheet" select="'/support/documentation/4.0/style.css'"/>
1919

2020
<xsl:param name="chunk.fast" select="1"/>
2121
<!-- Do NOT add the first section into the starting chunk -->
@@ -40,7 +40,7 @@
4040
<xsl:param name="chunker.output.doctype-public" select="''"/>
4141
<xsl:param name="chunker.output.doctype-system" select="''"/>
4242

43-
<xsl:variable name="main.title.text" select="'phpBB 3.3 Proteus Documentation'"/>
43+
<xsl:variable name="main.title.text" select="'phpBB 4.0 Triton Documentation'"/>
4444

4545
<xsl:template name="user.preroot">
4646

documentation/xsl/proteus_phpbb_dot_com.xsl renamed to documentation/xsl/triton_phpbb_dot_com.xsl

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<xsl:param name="html.ext" select="'.php'"/>
1515

1616
<!-- Link to the stylesheet -->
17-
<xsl:param name="html.stylesheet" select="'/support/documentation/3.3/style.css'"/>
17+
<xsl:param name="html.stylesheet" select="'/support/documentation/4.0/style.css'"/>
1818

1919
<xsl:param name="chunk.fast" select="1"/>
2020
<!-- Do NOT add the first section into the starting chunk -->
@@ -39,7 +39,7 @@
3939
<xsl:param name="chunker.output.doctype-public" select="''"/>
4040
<xsl:param name="chunker.output.doctype-system" select="''"/>
4141

42-
<xsl:variable name="main.title.text" select="'phpBB 3.3 Proteus Documentation'"/>
42+
<xsl:variable name="main.title.text" select="'phpBB 4.0 Triton Documentation'"/>
4343

4444
<xsl:template name="user.preroot">
4545

documentation/xsl/proteus_xhtml.xsl renamed to documentation/xsl/triton_xhtml.xsl

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<xsl:import href="xhtml/chunk.xsl"/>
1313

1414
<!-- Link to the stylesheet -->
15-
<xsl:param name="html.stylesheet" select="'/support/documentation/3.3/style.css'"/>
15+
<xsl:param name="html.stylesheet" select="'/support/documentation/4.0/style.css'"/>
1616

1717
<xsl:param name="chunk.fast" select="1"/>
1818
<!-- Do NOT add the first section into the starting chunk -->

0 commit comments

Comments
 (0)