|
1 | 1 | # Formatting rules
|
2 | 2 |
|
3 |
| -1. The format of this document is [Markdown](http://daringfireball.net/projects/markdown/) |
| 3 | +1. The format of the PHP Language Specification is |
| 4 | + [Markdown](http://daringfireball.net/projects/markdown/). |
4 | 5 | 2. Everything in the actual specification document must be ASCII only.
|
5 | 6 | 3. The only allowed extensions to original Markdown are tables and code blocks
|
6 | 7 | (indicated by three backticks).
|
7 | 8 | 4. Style
|
8 | 9 | * Use spaces to indent, not tabs.
|
9 |
| - * Use of prefixed `##` is preferred for headers over underlined `===` |
| 10 | + * For headings, use prefixed hash symbols `# Example`, not underlining it |
| 11 | + with `===`. |
10 | 12 | * Use of *inline* links `[example](http://example.org)` is preferred over
|
11 |
| - *reference* links `[example][xmpl]` unless used multiple times. This is to |
12 |
| - allow for easier splitting and reorganization. |
13 |
| - * Do not embed external images not hosted on php.net. |
| 13 | + *reference* links `[example][xmpl]` unless used multiple times in a |
| 14 | + paragraph or section. This is to allow for easier splitting and |
| 15 | + reorganization of the document. |
| 16 | + * Do not embed external images not hosted on [php.net](http://php.net) |
| 17 | + infrastructure. |
14 | 18 | * Try to stick to 80 chars wide, if possible. This is not as strict as
|
15 |
| - in code, but still easier to read most of the times. This does only apply |
16 |
| - to text, not to code examples or tables. |
| 19 | + in coding standard rules, but still easier to read most of the times. |
| 20 | + This does only apply to text, not to code examples or tables. |
0 commit comments