Skip to content

Commit c876853

Browse files
authored
Merge pull request #299 from phpbb/add/type_info
Add RFC reference and add type guidelines
2 parents 1410235 + 9b68b8f commit c876853

File tree

2 files changed

+110
-54
lines changed

2 files changed

+110
-54
lines changed

development/development/php/defaults.rst

+15-7
Original file line numberDiff line numberDiff 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
210
===========
311

4-
1.i. Editor Settings
12+
2.i. Editor Settings
513
--------------------
614

715
Tabs vs Spaces
@@ -23,7 +31,7 @@ Linefeeds
2331

2432
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.
2533

26-
1.ii. File Layout
34+
2.ii. File Layout
2735
-----------------
2836

2937
Standard header for new files:
@@ -43,7 +51,7 @@ This template of the header must be included at the start of all phpBB files:
4351
*
4452
*/
4553
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.
4755

4856
PHP closing tags
4957
++++++++++++++++
@@ -104,14 +112,14 @@ If this case is true, the best method to avoid documentation confusions is addin
104112
*/
105113
class ...
106114
107-
1.iii. File Locations
115+
2.iii. File Locations
108116
---------------------
109117

110118
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.
111119

112120
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:
113121

114-
**phpBB3**
122+
**phpBB**
115123
Core files and all files not assigned to a separate package
116124
**acm**
117125
``/phpbb/cache``
@@ -160,7 +168,7 @@ Search System
160168
``/styles``
161169
phpBB Styles/Templates/Themes
162170

163-
1.iv. Special Constants
171+
2.iv. Special Constants
164172
-----------------------
165173

166174
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

Comments
 (0)