diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2013-01-16 16:15:31 +0100 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2013-01-16 16:15:31 +0100 |
| commit | 19b6ea8cf748034c041f88370bac620924fe1d7b (patch) | |
| tree | 83fc9d93e6ea24db857a0aaf6e8948cbd4982ca9 /phpBB/docs/coding-guidelines.html | |
| parent | 37014abd022be4f7824a590b93a329f74aef442c (diff) | |
| parent | f63e115ae90edb9d65bc3bb23fc4d3c0ce81b763 (diff) | |
| download | forums-19b6ea8cf748034c041f88370bac620924fe1d7b.tar forums-19b6ea8cf748034c041f88370bac620924fe1d7b.tar.gz forums-19b6ea8cf748034c041f88370bac620924fe1d7b.tar.bz2 forums-19b6ea8cf748034c041f88370bac620924fe1d7b.tar.xz forums-19b6ea8cf748034c041f88370bac620924fe1d7b.zip | |
Merge branch 'develop' of https://github.com/phpbb/phpbb3 into ticket/10714
* 'develop' of https://github.com/phpbb/phpbb3: (205 commits)
[ticket/10786] Javascript toggle member search panel in memberlist.php
[ticket/10786] Javascript toggle member search panel in memberlist.php
[ticket/10786] Javascript toggle member search panel in memberlist.php
[ticket/11201] Remove database column on update
[ticket/10431] Remove .left class from reply-all
[ticket/10431] Remove reply-all custom css
[ticket/10431] Adjustments for large buttons
[ticket/11323] Add tests for inclusion of defined variables
[ticket/11324] Add PHP 5.5 environment to travis and allow it to fail.
[ticket/11201] Remove MSN/WLM fields
[ticket/11321] Recreate schema files with develop/create_schema_files.php
[ticket/11320] Include functions file as we need phpbb_convert_30_dbms_to_31
[ticket/11313] Use correct object el instead of eel in alt_text callback
[ticket/11301] Guidelines: Add spaces in front and after the / operator.
[ticket/11301] Explicitly cast str offset to int to prevent E_NOTICE on 5.4.
[ticket/11311] Include asset core.js in subsilver2 overall_footer.html
[ticket/10949] Remove not needed comma
[ticket/11309] phpbb_extension_interface::disable_step correct docblock.
[ticket/10949] Converted missing code to new JS coding guidelines
[ticket/11302] Correctly select first timezone or selected timezone
...
Diffstat (limited to 'phpBB/docs/coding-guidelines.html')
| -rw-r--r-- | phpBB/docs/coding-guidelines.html | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index eb569d12d5..14c2281323 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -72,6 +72,7 @@ <ol style="list-style-type: lower-roman;"> <li><a href="#templates">General Templating</a></li> <li><a href="#stylestree">Styles Tree</a></li> + <li><a href="#template-events">Template Events</a></li> </ol></li> <li><a href="#charsets">Character Sets and Encodings</a></li> <li><a href="#translation">Translation (<abbr title="Internationalisation">i18n</abbr>/<abbr title="Localisation">L10n</abbr>) Guidelines</a> @@ -1678,6 +1679,57 @@ version = 3.1.0 parent = prosilver </pre></div> + <a name="template-events"></a><h3>4.iii. Template Events</h3> + <p>Template events must follow this format: <code><!-- EVENT event_name --></code></p> + <p>Using the above example, files named <code>event_name.html</code> located within extensions will be injected into the location of the event.</p> + + <h4>Template event naming guidelines:</h4> + <ul> + <li>An event name must be all lowercase, with each word separated by an underscore.</li> + <li>An event name must briefly describe the location and purpose of the event.</li> + <li>An event name must end with one of the following suffixes:</li> + <ul> + <li><code>_prepend</code> - This event adds an item to the beginning of a block of related items, or adds to the beginning of individual items in a block.</li> + <li><code>_append</code> - This event adds an item to the end of a block of related items, or adds to the end of individual items in a block.</li> + <li><code>_before</code> - This event adds content directly before the specified block</li> + <li><code>_after</code> - This event adds content directly after the specified block</li> + </ul> + </ul> + + <h4>Template event documentation</h4> + <p>Events must be documented in <code>phpBB/docs/events.md</code> in alphabetical order based on the event name. The format is as follows:</p> + + <ul><li>An event found in only one template file: + <div class="codebox"><pre>event_name +=== +* Location: styles/<style_name>/template/filename.html +* Purpose: A brief description of what this event should be used for. +This may span multiple lines. +</pre></div></li> + <li>An event found in multiple template files: + <div class="codebox"><pre>event_name +=== +* Locations: + + first/file/path.html + + second/file/path.html +* Purpose: Same as above. +</pre></div> + <li>An event that is found multiple times in a file should have the number of instances in parenthesis next to the filename. + <div class="codebox"><pre>event_name +=== +* Locations: + + first/file/path.html (2) + + second/file/path.html +* Purpose: Same as above. +</pre></div></li> + <li>An actual example event documentation: + <div class="codebox"><pre>forumlist_body_last_post_title_prepend +==== +* Locations: + + styles/prosilver/template/forumlist_body.html + + styles/subsilver2/template/forumlist_body.html +* Purpose: Add content before the post title of the latest post in a forum on the forum list.</pre></div></ul><br /> + </div> <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> |