File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change 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.
2432Sentences need not have two spaces between them.
2533Commas 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
2844The PHP Manual is a technical document, and should be written so. The use of "you" is rampant in the manual,
2945and presents an unprofessional image. The only exceptions to the personalization rule are: the PHP Tutorial and FAQs.
You can’t perform that action at this time.
0 commit comments