Skip to content

Commit

Permalink
Intro to style guidelines, add section about <simpara>
Browse files Browse the repository at this point in the history
  • Loading branch information
jimwins committed Oct 22, 2024
1 parent 17463fe commit 5b70a7d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/style.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Style guidelines

The style for the PHP manual has evolved over the years, and this tries
to capture the current guidelines. Existing documentation may not closely
adhere to these, but new additions and substantial changes should.

When updating existing documentation, it is okay to not update
conflicts with these style guidelines if it would cause too much work
for translators.

## Technical requirements
- All files **must** be encoded using UTF-8 (without BOM)
- Use only Unix line endings (`\n`)
Expand All @@ -24,6 +32,14 @@ a period.
Sentences need not have two spaces between them.
Commas and apostrophes should be used appropriately.

## Markup

### Use `<para>` sparingly

Use `<simpara>` in markup (similar to HTML's `<p>`) in favor of `<para>`
(similar to HTML's `<div>`) when there are no block elements (such as
`<example>` or `<itemizedlist>` in the paragraph.

## Personalization
The PHP Manual is a technical document, and should be written so. The use of "you" is rampant in the manual,
and presents an unprofessional image. The only exceptions to the personalization rule are: the PHP Tutorial and FAQs.
Expand Down

0 comments on commit 5b70a7d

Please sign in to comment.