From a89ed49cbf797ecc82a70f6a36a06e9c0c396ce1 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Thu, 20 Dec 2012 16:40:53 -0500
Subject: [PATCH] [ticket/11287] Add template event naming to
 docs/coding-guidelines.html

PHPBB3-11287
---
 phpBB/docs/coding-guidelines.html | 52 +++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

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>&lt;!-- EVENT event_name --&gt;</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/&lt;style_name&gt;/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>