You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: development/development/php/defaults.rst
+15-7
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,15 @@
1
-
1. Defaults
1
+
1. Introduction
2
+
===============
3
+
4
+
The key words "**MUST**", "**MUST NOT**", "**REQUIRED**", "**SHALL**", "**SHALL NOT**",
5
+
"**SHOULD**", "**SHOULD NOT**", "**RECOMMENDED**", "**NOT RECOMMENDED**", "**MAY**", and "**OPTIONAL**"
6
+
in this document are to be interpreted as described in `BCP 14 <https://datatracker.ietf.org/doc/html/bcp14>` [`RFC2119 <https://datatracker.ietf.org/doc/html/rfc2119>`] [`RFC8174 <https://datatracker.ietf.org/doc/html/rfc8174>`] when,
7
+
and only when, they appear in all capitals, as shown here.
8
+
9
+
2. Defaults
2
10
===========
3
11
4
-
1.i. Editor Settings
12
+
2.i. Editor Settings
5
13
--------------------
6
14
7
15
Tabs vs Spaces
@@ -23,7 +31,7 @@ Linefeeds
23
31
24
32
Ensure that your editor is saving files in the UNIX (LF) line ending format. This means that lines are terminated with a newline, not with Windows Line endings (CR/LF combo) as they are on Win32 or Classic Mac (CR) Line endings. Any decent editor should be able to do this, but it might not always be the default setting. Know your editor. If you want advice for an editor for your Operating System, just ask one of the developers. Some of them do their editing on Win32.
25
33
26
-
1.ii. File Layout
34
+
2.ii. File Layout
27
35
-----------------
28
36
29
37
Standard header for new files:
@@ -43,7 +51,7 @@ This template of the header must be included at the start of all phpBB files:
43
51
*
44
52
*/
45
53
46
-
Please see the `1.iii. File Locations`_ section for the correct package name.
54
+
Please see the `2.iii. File Locations`_ section for the correct package name.
47
55
48
56
PHP closing tags
49
57
++++++++++++++++
@@ -104,14 +112,14 @@ If this case is true, the best method to avoid documentation confusions is addin
104
112
*/
105
113
class ...
106
114
107
-
1.iii. File Locations
115
+
2.iii. File Locations
108
116
---------------------
109
117
110
118
Functions used by more than one page should be placed in functions.php, functions specific to one page should be placed on that page (at the bottom) or within the relevant sections functions file. Some files in /includes are holding functions responsible for special sections, for example uploading files, displaying "things", user related functions and so forth.
111
119
112
120
The following packages are defined, and related new features/functions should be placed within the mentioned files/locations, as well as specifying the correct package name. The package names are bold within this list:
113
121
114
-
**phpBB3**
122
+
**phpBB**
115
123
Core files and all files not assigned to a separate package
116
124
**acm**
117
125
``/phpbb/cache``
@@ -160,7 +168,7 @@ Search System
160
168
``/styles``
161
169
phpBB Styles/Templates/Themes
162
170
163
-
1.iv. Special Constants
171
+
2.iv. Special Constants
164
172
-----------------------
165
173
166
174
There are some special constants application developers are able to utilize to bend some of phpBB's internal functionality to suit their needs.
0 commit comments