Skip to content

Commit 1d0dd0d

Browse files
authored
Intro to style guidelines, add section about <simpara> (#168)
1 parent 2e12f85 commit 1d0dd0d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/style.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Style guidelines
22

3+
The style for the PHP manual has evolved over the years, and this tries
4+
to capture the current guidelines. Existing documentation may not closely
5+
adhere to these, but new additions and substantial changes should.
6+
7+
When updating existing documentation, it is okay to not update
8+
conflicts with these style guidelines if it would cause too much work
9+
for translators.
10+
311
## Technical requirements
412
- All files **must** be encoded using UTF-8 (without BOM)
513
- Use only Unix line endings (`\n`)
@@ -24,6 +32,14 @@ a period.
2432
Sentences need not have two spaces between them.
2533
Commas and apostrophes should be used appropriately.
2634

35+
## Markup
36+
37+
### Use `<para>` sparingly
38+
39+
Use `<simpara>` in markup (similar to HTML's `<p>`) in favor of `<para>`
40+
(similar to HTML's `<div>`) when there are no block elements (such as
41+
`<example>` or `<itemizedlist>` in the paragraph.
42+
2743
## Personalization
2844
The PHP Manual is a technical document, and should be written so. The use of "you" is rampant in the manual,
2945
and presents an unprofessional image. The only exceptions to the personalization rule are: the PHP Tutorial and FAQs.

0 commit comments

Comments
 (0)