From 03d2c6413c25b1faf7f37ff20625ce986b19eb88 Mon Sep 17 00:00:00 2001 From: Oleg Pudeyev Date: Fri, 7 Dec 2012 21:57:33 -0500 Subject: [ticket/11248] Convert line endings to LF - develop edition. PHPBB3-11248 --- phpBB/docs/sphinx.sample.conf | 90 ++++++++++++++++++++++++++++--------------- 1 file changed, 60 insertions(+), 30 deletions(-) (limited to 'phpBB/docs') diff --git a/phpBB/docs/sphinx.sample.conf b/phpBB/docs/sphinx.sample.conf index aa0e8d905d..fcaba6dcf3 100644 --- a/phpBB/docs/sphinx.sample.conf +++ b/phpBB/docs/sphinx.sample.conf @@ -10,21 +10,36 @@ source source_phpbb_{SPHINX_ID}_main sql_query_pre = UPDATE phpbb_sphinx SET max_doc_id = MAX(post_id) WHERE counter_id = 1 sql_query_range = SELECT MIN(post_id), MAX(post_id) FROM phpbb_posts sql_range_step = 5000 - sql_query = SELECT \ - p.post_id AS id, \ - p.forum_id, \ - p.topic_id, \ - p.poster_id, \ - CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post, \ - p.post_time, \ - p.post_subject, \ - p.post_subject as title, \ - p.post_text as data, \ - t.topic_last_post_time, \ - 0 as deleted \ - FROM phpbb_posts p, phpbb_topics t \ - WHERE \ - p.topic_id = t.topic_id \ + sql_query = SELECT +\ + p.post_id AS id, +\ + p.forum_id, +\ + p.topic_id, +\ + p.poster_id, +\ + CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post, +\ + p.post_time, +\ + p.post_subject, +\ + p.post_subject as title, +\ + p.post_text as data, +\ + t.topic_last_post_time, +\ + 0 as deleted +\ + FROM phpbb_posts p, phpbb_topics t +\ + WHERE +\ + p.topic_id = t.topic_id +\ AND p.post_id >= $start AND p.post_id <= $end sql_query_post = sql_query_post_index = UPDATE phpbb_sphinx SET max_doc_id = $maxid WHERE counter_id = 1 @@ -42,21 +57,36 @@ source source_phpbb_{SPHINX_ID}_delta : source_phpbb_{SPHINX_ID}_main { sql_query_range = sql_range_step = - sql_query = SELECT \ - p.post_id AS id, \ - p.forum_id, \ - p.topic_id, \ - p.poster_id, \ - CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post, \ - p.post_time, \ - p.post_subject, \ - p.post_subject as title, \ - p.post_text as data, \ - t.topic_last_post_time, \ - 0 as deleted \ - FROM phpbb_posts p, phpbb_topics t \ - WHERE \ - p.topic_id = t.topic_id \ + sql_query = SELECT +\ + p.post_id AS id, +\ + p.forum_id, +\ + p.topic_id, +\ + p.poster_id, +\ + CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post, +\ + p.post_time, +\ + p.post_subject, +\ + p.post_subject as title, +\ + p.post_text as data, +\ + t.topic_last_post_time, +\ + 0 as deleted +\ + FROM phpbb_posts p, phpbb_topics t +\ + WHERE +\ + p.topic_id = t.topic_id +\ AND p.post_id >= ( SELECT max_doc_id FROM phpbb_sphinx WHERE counter_id=1 ) sql_query_pre = } -- cgit v1.2.1 From 52cd0b8a6d2d03dacf81c1ff18e82eab706e85fb Mon Sep 17 00:00:00 2001 From: David King Date: Mon, 17 Dec 2012 18:00:47 -0500 Subject: [feature/events] Add markdown template event documentation file PHPBB3-9550 --- phpBB/docs/EVENTS.md | 130 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 phpBB/docs/EVENTS.md (limited to 'phpBB/docs') diff --git a/phpBB/docs/EVENTS.md b/phpBB/docs/EVENTS.md new file mode 100644 index 0000000000..10073a98dc --- /dev/null +++ b/phpBB/docs/EVENTS.md @@ -0,0 +1,130 @@ +acp_forums_normal_settings_append +=== +* Location: adm/style/acp_forums.html +* Purpose: Add settings to forums + +acp_main_notice_after +=== +* Location: adm/style/acp_main.html +* Purpose: Add notices or other blocks in the ACP below other configuration notices + +acp_main_actions_append +=== +* Location: adm/style/acp_main.html +* Purpose: Add actions to the ACP main page below the cache purge action + +acp_overall_footer_after +=== +* Location: adm/style/overall_footer.html +* Purpose: Add content below the footer in the ACP + +acp_overall_header_head_append +=== +* Location: adm/style/overall_header.html +* Add assets within the tags in the ACP + +acp_simple_footer_after +=== +* Location: adm/style/simple_footer.html +* Purpose: Add content below the simple footer in the ACP + +acp_simple_header_head_append +=== +* Location: adm/style/overall_header.html +* Add assets within the tags in the simple header of the ACP + +acp_users_overview_options_append +=== +* Location: adm/style/acp_users.html +* Purpose: Add options and settings on user overview page + +forumlist_body_last_post_prepend +==== +* Location: styles/prosilver/template/forumlist_body.html +* Purpose: Add content before the post title of the latest post in a forum on the forum list. + +index_body_stat_blocks_before +=== +* Locations: + + styles/prosilver/template/index_body.html + + styles/subsilver2/template/index_body.html +* Purpose: Add new statistic blocks above the Who Is Online and Board Statistics blocks + +overall_footer_breadcrumb_append +=== +* Location: styles/prosilver/template/overall_footer.html +* Purpose: Add links to the list of breadcrumbs in the footer + +overall_footer_copyright_prepend +=== +* Locations: + + styles/prosilver/template/overall_footer.html + + styles/subsilver2/template/overall_footer.html +* Purpose: Add content before the copyright line + +overall_footer_copyright_append +=== +* Locations: + + styles/prosilver/template/overall_footer.html + + styles/subsilver2/template/overall_footer.html +* Purpose: Add content after the copyright line (no new line by default), before the ACP link + +overall_footer_after +=== +* Locations: + + styles/prosilver/template/overall_footer.html + + styles/subsilver2/template/overall_footer.html +* Purpose: Add content at the end of the file, directly prior to the tag + +overall_header_head_append +=== +* Locations: + + styles/prosilver/template/overall_header.html + + styles/subsilver2/template/overall_header.html +* Purpose: Add asset calls directly before the tag + +overall_header_breadcrumb_append +=== +* Locations: + + styles/prosilver/template/overall_header.html + + styles/subsilver2/template/breadcrumbs.html +* Purpose: Add links to the list of breadcrumbs in the header + +overall_header_navigation_prepend +=== +* Location: styles/prosilver/template/overall_header.html +* Purpose: Add links before the navigation links in the header + +overall_header_navigation_append +=== +* Location: styles/prosilver/template/overall_header.html +* Purpose: Add links after the navigation links in the header + +posting_editor_options_prepend +=== +* Locations: + + styles/prosilver/template/posting_editor.html + + styles/prosilver/template/posting_body.html +* Purpose: Add posting options on the posting screen + +simple_footer_after +=== +* Location: styles/prosilver/template/simple_footer.html +* Purpose: Add content directly prior to the tag of the simple footer + +ucp_pm_viewmessage_print_head_append +=== +* Location: styles/prosilver/template/ucp_pm_viewmessage_print.html +* Purpose: Add asset calls directly before the tag of the Print PM screen + +viewtopic_topic_title_prepend +=== +* Locations: + + styles/prosilver/template/viewtopic_body.html + + styles/subsilver2/template/viewtopic_body.html +* Purpose: Add content directly before the topic title link on the View topic screen + +viewtopic_print_head_append +=== +* Location: styles/prosilver/template/viewtopic_print.html +* Purpose: Add asset calls directly before the tag of the Print Topic screen -- cgit v1.2.1 From 736b8e44568f98d737c745dd870ff09275c7d106 Mon Sep 17 00:00:00 2001 From: David King Date: Mon, 17 Dec 2012 19:16:10 -0500 Subject: [feature/events] Remove HTML tags from markdown so they don't get parsed PHPBB3-9550 --- phpBB/docs/EVENTS.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'phpBB/docs') diff --git a/phpBB/docs/EVENTS.md b/phpBB/docs/EVENTS.md index 10073a98dc..5072782198 100644 --- a/phpBB/docs/EVENTS.md +++ b/phpBB/docs/EVENTS.md @@ -21,7 +21,7 @@ acp_overall_footer_after acp_overall_header_head_append === * Location: adm/style/overall_header.html -* Add assets within the tags in the ACP +* Add assets within the head tags in the ACP acp_simple_footer_after === @@ -31,7 +31,7 @@ acp_simple_footer_after acp_simple_header_head_append === * Location: adm/style/overall_header.html -* Add assets within the tags in the simple header of the ACP +* Add assets within the head tags in the simple header of the ACP acp_users_overview_options_append === @@ -74,14 +74,14 @@ overall_footer_after * Locations: + styles/prosilver/template/overall_footer.html + styles/subsilver2/template/overall_footer.html -* Purpose: Add content at the end of the file, directly prior to the tag +* Purpose: Add content at the end of the file, directly prior to the closing body tag overall_header_head_append === * Locations: + styles/prosilver/template/overall_header.html + styles/subsilver2/template/overall_header.html -* Purpose: Add asset calls directly before the tag +* Purpose: Add asset calls directly before the closing head tag overall_header_breadcrumb_append === @@ -110,12 +110,12 @@ posting_editor_options_prepend simple_footer_after === * Location: styles/prosilver/template/simple_footer.html -* Purpose: Add content directly prior to the tag of the simple footer +* Purpose: Add content directly prior to the closing body tag of the simple footer ucp_pm_viewmessage_print_head_append === * Location: styles/prosilver/template/ucp_pm_viewmessage_print.html -* Purpose: Add asset calls directly before the tag of the Print PM screen +* Purpose: Add asset calls directly before the closing head tag of the Print PM screen viewtopic_topic_title_prepend === @@ -127,4 +127,4 @@ viewtopic_topic_title_prepend viewtopic_print_head_append === * Location: styles/prosilver/template/viewtopic_print.html -* Purpose: Add asset calls directly before the tag of the Print Topic screen +* Purpose: Add asset calls directly before the closing head tag of the Print Topic screen -- cgit v1.2.1 From a740ae9c22193d9781a7771cfd633aaeb5fa6f82 Mon Sep 17 00:00:00 2001 From: David King Date: Mon, 17 Dec 2012 19:44:30 -0500 Subject: [feature/events] Use ` to escape HTML tags in markdown PHPBB3-9550 --- phpBB/docs/EVENTS.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'phpBB/docs') diff --git a/phpBB/docs/EVENTS.md b/phpBB/docs/EVENTS.md index 5072782198..cc03688d0d 100644 --- a/phpBB/docs/EVENTS.md +++ b/phpBB/docs/EVENTS.md @@ -21,7 +21,7 @@ acp_overall_footer_after acp_overall_header_head_append === * Location: adm/style/overall_header.html -* Add assets within the head tags in the ACP +* Add assets within the `` tags in the ACP acp_simple_footer_after === @@ -31,7 +31,7 @@ acp_simple_footer_after acp_simple_header_head_append === * Location: adm/style/overall_header.html -* Add assets within the head tags in the simple header of the ACP +* Add assets within the `` tags in the simple header of the ACP acp_users_overview_options_append === @@ -74,14 +74,14 @@ overall_footer_after * Locations: + styles/prosilver/template/overall_footer.html + styles/subsilver2/template/overall_footer.html -* Purpose: Add content at the end of the file, directly prior to the closing body tag +* Purpose: Add content at the end of the file, directly prior to the `` tag overall_header_head_append === * Locations: + styles/prosilver/template/overall_header.html + styles/subsilver2/template/overall_header.html -* Purpose: Add asset calls directly before the closing head tag +* Purpose: Add asset calls directly before the `` tag overall_header_breadcrumb_append === @@ -110,12 +110,12 @@ posting_editor_options_prepend simple_footer_after === * Location: styles/prosilver/template/simple_footer.html -* Purpose: Add content directly prior to the closing body tag of the simple footer +* Purpose: Add content directly prior to the `` tag of the simple footer ucp_pm_viewmessage_print_head_append === * Location: styles/prosilver/template/ucp_pm_viewmessage_print.html -* Purpose: Add asset calls directly before the closing head tag of the Print PM screen +* Purpose: Add asset calls directly before the `` tag of the Print PM screen viewtopic_topic_title_prepend === @@ -127,4 +127,4 @@ viewtopic_topic_title_prepend viewtopic_print_head_append === * Location: styles/prosilver/template/viewtopic_print.html -* Purpose: Add asset calls directly before the closing head tag of the Print Topic screen +* Purpose: Add asset calls directly before the `` tag of the Print Topic screen -- cgit v1.2.1 From 7fa3405cd106da529170c34c889ab6f1511e3e6d Mon Sep 17 00:00:00 2001 From: David King Date: Thu, 20 Dec 2012 14:39:07 -0500 Subject: [feature/events] Make EVENTS.md lowercase PHPBB3-9550 --- phpBB/docs/EVENTS.md | 130 --------------------------------------------------- phpBB/docs/events.md | 130 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 130 insertions(+), 130 deletions(-) delete mode 100644 phpBB/docs/EVENTS.md create mode 100644 phpBB/docs/events.md (limited to 'phpBB/docs') diff --git a/phpBB/docs/EVENTS.md b/phpBB/docs/EVENTS.md deleted file mode 100644 index cc03688d0d..0000000000 --- a/phpBB/docs/EVENTS.md +++ /dev/null @@ -1,130 +0,0 @@ -acp_forums_normal_settings_append -=== -* Location: adm/style/acp_forums.html -* Purpose: Add settings to forums - -acp_main_notice_after -=== -* Location: adm/style/acp_main.html -* Purpose: Add notices or other blocks in the ACP below other configuration notices - -acp_main_actions_append -=== -* Location: adm/style/acp_main.html -* Purpose: Add actions to the ACP main page below the cache purge action - -acp_overall_footer_after -=== -* Location: adm/style/overall_footer.html -* Purpose: Add content below the footer in the ACP - -acp_overall_header_head_append -=== -* Location: adm/style/overall_header.html -* Add assets within the `` tags in the ACP - -acp_simple_footer_after -=== -* Location: adm/style/simple_footer.html -* Purpose: Add content below the simple footer in the ACP - -acp_simple_header_head_append -=== -* Location: adm/style/overall_header.html -* Add assets within the `` tags in the simple header of the ACP - -acp_users_overview_options_append -=== -* Location: adm/style/acp_users.html -* Purpose: Add options and settings on user overview page - -forumlist_body_last_post_prepend -==== -* Location: styles/prosilver/template/forumlist_body.html -* Purpose: Add content before the post title of the latest post in a forum on the forum list. - -index_body_stat_blocks_before -=== -* Locations: - + styles/prosilver/template/index_body.html - + styles/subsilver2/template/index_body.html -* Purpose: Add new statistic blocks above the Who Is Online and Board Statistics blocks - -overall_footer_breadcrumb_append -=== -* Location: styles/prosilver/template/overall_footer.html -* Purpose: Add links to the list of breadcrumbs in the footer - -overall_footer_copyright_prepend -=== -* Locations: - + styles/prosilver/template/overall_footer.html - + styles/subsilver2/template/overall_footer.html -* Purpose: Add content before the copyright line - -overall_footer_copyright_append -=== -* Locations: - + styles/prosilver/template/overall_footer.html - + styles/subsilver2/template/overall_footer.html -* Purpose: Add content after the copyright line (no new line by default), before the ACP link - -overall_footer_after -=== -* Locations: - + styles/prosilver/template/overall_footer.html - + styles/subsilver2/template/overall_footer.html -* Purpose: Add content at the end of the file, directly prior to the `` tag - -overall_header_head_append -=== -* Locations: - + styles/prosilver/template/overall_header.html - + styles/subsilver2/template/overall_header.html -* Purpose: Add asset calls directly before the `` tag - -overall_header_breadcrumb_append -=== -* Locations: - + styles/prosilver/template/overall_header.html - + styles/subsilver2/template/breadcrumbs.html -* Purpose: Add links to the list of breadcrumbs in the header - -overall_header_navigation_prepend -=== -* Location: styles/prosilver/template/overall_header.html -* Purpose: Add links before the navigation links in the header - -overall_header_navigation_append -=== -* Location: styles/prosilver/template/overall_header.html -* Purpose: Add links after the navigation links in the header - -posting_editor_options_prepend -=== -* Locations: - + styles/prosilver/template/posting_editor.html - + styles/prosilver/template/posting_body.html -* Purpose: Add posting options on the posting screen - -simple_footer_after -=== -* Location: styles/prosilver/template/simple_footer.html -* Purpose: Add content directly prior to the `` tag of the simple footer - -ucp_pm_viewmessage_print_head_append -=== -* Location: styles/prosilver/template/ucp_pm_viewmessage_print.html -* Purpose: Add asset calls directly before the `` tag of the Print PM screen - -viewtopic_topic_title_prepend -=== -* Locations: - + styles/prosilver/template/viewtopic_body.html - + styles/subsilver2/template/viewtopic_body.html -* Purpose: Add content directly before the topic title link on the View topic screen - -viewtopic_print_head_append -=== -* Location: styles/prosilver/template/viewtopic_print.html -* Purpose: Add asset calls directly before the `` tag of the Print Topic screen diff --git a/phpBB/docs/events.md b/phpBB/docs/events.md new file mode 100644 index 0000000000..cc03688d0d --- /dev/null +++ b/phpBB/docs/events.md @@ -0,0 +1,130 @@ +acp_forums_normal_settings_append +=== +* Location: adm/style/acp_forums.html +* Purpose: Add settings to forums + +acp_main_notice_after +=== +* Location: adm/style/acp_main.html +* Purpose: Add notices or other blocks in the ACP below other configuration notices + +acp_main_actions_append +=== +* Location: adm/style/acp_main.html +* Purpose: Add actions to the ACP main page below the cache purge action + +acp_overall_footer_after +=== +* Location: adm/style/overall_footer.html +* Purpose: Add content below the footer in the ACP + +acp_overall_header_head_append +=== +* Location: adm/style/overall_header.html +* Add assets within the `` tags in the ACP + +acp_simple_footer_after +=== +* Location: adm/style/simple_footer.html +* Purpose: Add content below the simple footer in the ACP + +acp_simple_header_head_append +=== +* Location: adm/style/overall_header.html +* Add assets within the `` tags in the simple header of the ACP + +acp_users_overview_options_append +=== +* Location: adm/style/acp_users.html +* Purpose: Add options and settings on user overview page + +forumlist_body_last_post_prepend +==== +* Location: styles/prosilver/template/forumlist_body.html +* Purpose: Add content before the post title of the latest post in a forum on the forum list. + +index_body_stat_blocks_before +=== +* Locations: + + styles/prosilver/template/index_body.html + + styles/subsilver2/template/index_body.html +* Purpose: Add new statistic blocks above the Who Is Online and Board Statistics blocks + +overall_footer_breadcrumb_append +=== +* Location: styles/prosilver/template/overall_footer.html +* Purpose: Add links to the list of breadcrumbs in the footer + +overall_footer_copyright_prepend +=== +* Locations: + + styles/prosilver/template/overall_footer.html + + styles/subsilver2/template/overall_footer.html +* Purpose: Add content before the copyright line + +overall_footer_copyright_append +=== +* Locations: + + styles/prosilver/template/overall_footer.html + + styles/subsilver2/template/overall_footer.html +* Purpose: Add content after the copyright line (no new line by default), before the ACP link + +overall_footer_after +=== +* Locations: + + styles/prosilver/template/overall_footer.html + + styles/subsilver2/template/overall_footer.html +* Purpose: Add content at the end of the file, directly prior to the `` tag + +overall_header_head_append +=== +* Locations: + + styles/prosilver/template/overall_header.html + + styles/subsilver2/template/overall_header.html +* Purpose: Add asset calls directly before the `` tag + +overall_header_breadcrumb_append +=== +* Locations: + + styles/prosilver/template/overall_header.html + + styles/subsilver2/template/breadcrumbs.html +* Purpose: Add links to the list of breadcrumbs in the header + +overall_header_navigation_prepend +=== +* Location: styles/prosilver/template/overall_header.html +* Purpose: Add links before the navigation links in the header + +overall_header_navigation_append +=== +* Location: styles/prosilver/template/overall_header.html +* Purpose: Add links after the navigation links in the header + +posting_editor_options_prepend +=== +* Locations: + + styles/prosilver/template/posting_editor.html + + styles/prosilver/template/posting_body.html +* Purpose: Add posting options on the posting screen + +simple_footer_after +=== +* Location: styles/prosilver/template/simple_footer.html +* Purpose: Add content directly prior to the `` tag of the simple footer + +ucp_pm_viewmessage_print_head_append +=== +* Location: styles/prosilver/template/ucp_pm_viewmessage_print.html +* Purpose: Add asset calls directly before the `` tag of the Print PM screen + +viewtopic_topic_title_prepend +=== +* Locations: + + styles/prosilver/template/viewtopic_body.html + + styles/subsilver2/template/viewtopic_body.html +* Purpose: Add content directly before the topic title link on the View topic screen + +viewtopic_print_head_append +=== +* Location: styles/prosilver/template/viewtopic_print.html +* Purpose: Add asset calls directly before the `` tag of the Print Topic screen -- cgit v1.2.1 From 3504e761a3840d9f5281fede517220c22c573e15 Mon Sep 17 00:00:00 2001 From: David King Date: Thu, 20 Dec 2012 14:41:55 -0500 Subject: [feature/events] Put events in alphabetical order PHPBB3-9550 --- phpBB/docs/events.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) (limited to 'phpBB/docs') diff --git a/phpBB/docs/events.md b/phpBB/docs/events.md index cc03688d0d..cf967fe191 100644 --- a/phpBB/docs/events.md +++ b/phpBB/docs/events.md @@ -50,31 +50,38 @@ index_body_stat_blocks_before + styles/subsilver2/template/index_body.html * Purpose: Add new statistic blocks above the Who Is Online and Board Statistics blocks +overall_footer_after +=== +* Locations: + + styles/prosilver/template/overall_footer.html + + styles/subsilver2/template/overall_footer.html +* Purpose: Add content at the end of the file, directly prior to the `` tag + overall_footer_breadcrumb_append === * Location: styles/prosilver/template/overall_footer.html * Purpose: Add links to the list of breadcrumbs in the footer -overall_footer_copyright_prepend +overall_footer_copyright_append === * Locations: + styles/prosilver/template/overall_footer.html + styles/subsilver2/template/overall_footer.html -* Purpose: Add content before the copyright line +* Purpose: Add content after the copyright line (no new line by default), before the ACP link -overall_footer_copyright_append +overall_footer_copyright_prepend === * Locations: + styles/prosilver/template/overall_footer.html + styles/subsilver2/template/overall_footer.html -* Purpose: Add content after the copyright line (no new line by default), before the ACP link +* Purpose: Add content before the copyright line -overall_footer_after +overall_header_breadcrumb_append === * Locations: - + styles/prosilver/template/overall_footer.html - + styles/subsilver2/template/overall_footer.html -* Purpose: Add content at the end of the file, directly prior to the `` tag + + styles/prosilver/template/overall_header.html + + styles/subsilver2/template/breadcrumbs.html +* Purpose: Add links to the list of breadcrumbs in the header overall_header_head_append === @@ -83,23 +90,16 @@ overall_header_head_append + styles/subsilver2/template/overall_header.html * Purpose: Add asset calls directly before the `` tag -overall_header_breadcrumb_append +overall_header_navigation_append === -* Locations: - + styles/prosilver/template/overall_header.html - + styles/subsilver2/template/breadcrumbs.html -* Purpose: Add links to the list of breadcrumbs in the header +* Location: styles/prosilver/template/overall_header.html +* Purpose: Add links after the navigation links in the header overall_header_navigation_prepend === * Location: styles/prosilver/template/overall_header.html * Purpose: Add links before the navigation links in the header -overall_header_navigation_append -=== -* Location: styles/prosilver/template/overall_header.html -* Purpose: Add links after the navigation links in the header - posting_editor_options_prepend === * Locations: @@ -117,14 +117,14 @@ ucp_pm_viewmessage_print_head_append * Location: styles/prosilver/template/ucp_pm_viewmessage_print.html * Purpose: Add asset calls directly before the `` tag of the Print PM screen +viewtopic_print_head_append +=== +* Location: styles/prosilver/template/viewtopic_print.html +* Purpose: Add asset calls directly before the `` tag of the Print Topic screen + viewtopic_topic_title_prepend === * Locations: + styles/prosilver/template/viewtopic_body.html + styles/subsilver2/template/viewtopic_body.html * Purpose: Add content directly before the topic title link on the View topic screen - -viewtopic_print_head_append -=== -* Location: styles/prosilver/template/viewtopic_print.html -* Purpose: Add asset calls directly before the `` tag of the Print Topic screen -- cgit v1.2.1 From c7618ff669f31945948358ff8fb6277b6b950c27 Mon Sep 17 00:00:00 2001 From: David King Date: Thu, 20 Dec 2012 14:46:00 -0500 Subject: [feature/events] Fix alphabetization of events PHPBB3-9550 --- phpBB/docs/events.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'phpBB/docs') diff --git a/phpBB/docs/events.md b/phpBB/docs/events.md index cf967fe191..2e757d9aca 100644 --- a/phpBB/docs/events.md +++ b/phpBB/docs/events.md @@ -3,15 +3,15 @@ acp_forums_normal_settings_append * Location: adm/style/acp_forums.html * Purpose: Add settings to forums -acp_main_notice_after +acp_main_actions_append === * Location: adm/style/acp_main.html -* Purpose: Add notices or other blocks in the ACP below other configuration notices +* Purpose: Add actions to the ACP main page below the cache purge action -acp_main_actions_append +acp_main_notice_after === * Location: adm/style/acp_main.html -* Purpose: Add actions to the ACP main page below the cache purge action +* Purpose: Add notices or other blocks in the ACP below other configuration notices acp_overall_footer_after === -- cgit v1.2.1 From 00c61f9060de5665a9ef09b88701ad21b94ce51c Mon Sep 17 00:00:00 2001 From: David King Date: Thu, 20 Dec 2012 15:03:45 -0500 Subject: [feature/events] Fix improperly named event in documentation PHPBB3-9550 --- phpBB/docs/events.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'phpBB/docs') diff --git a/phpBB/docs/events.md b/phpBB/docs/events.md index 2e757d9aca..f0b3b81822 100644 --- a/phpBB/docs/events.md +++ b/phpBB/docs/events.md @@ -38,9 +38,11 @@ acp_users_overview_options_append * Location: adm/style/acp_users.html * Purpose: Add options and settings on user overview page -forumlist_body_last_post_prepend +forumlist_body_last_post_title_prepend ==== -* Location: styles/prosilver/template/forumlist_body.html +* 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. index_body_stat_blocks_before -- cgit v1.2.1 From a89ed49cbf797ecc82a70f6a36a06e9c0c396ce1 Mon Sep 17 00:00:00 2001 From: David King Date: Thu, 20 Dec 2012 16:40:53 -0500 Subject: [ticket/11287] Add template event naming to docs/coding-guidelines.html PHPBB3-11287 --- phpBB/docs/coding-guidelines.html | 52 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) (limited to 'phpBB/docs') 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 @@
  1. General Templating
  2. Styles Tree
    3. +
  3. Template Events
  • Character Sets and Encodings
  • Translation (i18n/L10n) Guidelines @@ -1678,6 +1679,57 @@ version = 3.1.0 parent = prosilver +

    4.iii. Template Events

    +

    Template events must follow this format: <!-- EVENT event_name -->

    +

    Using the above example, files named event_name.html located within extensions will be injected into the location of the event.

    + +

    Template event naming guidelines:

    +
      +
    • An event name must be all lowercase, with each word separated by an underscore.
      • +
    • An event name must briefly describe the location and purpose of the event.
      • +
    • An event name must end with one of the following suffixes:
      • +
        +
      • _prepend - 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.
        • +
      • _append - 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.
        • +
      • _before - This event adds content directly before the specified block
        • +
      • _after - This event adds content directly after the specified block
        • +
      +
    + +

    Template event documentation

    +

    Events must be documented in phpBB/docs/events.md in alphabetical order based on the event name. The format is as follows:

    + +
    • An event found in only one template file: + 
      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.
+
      • +
    • An event found in multiple template files: + 
      event_name
+===
+* Locations:
+    + first/file/path.html
+    + second/file/path.html
+* Purpose: Same as above.
+
      +
    • An event that is found multiple times in a file should have the number of instances in parenthesis next to the filename. + 
      event_name
+===
+* Locations:
+    + first/file/path.html (2)
+    + second/file/path.html
+* Purpose: Same as above.
+
      • +
    • An actual example event documentation: + 
      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.

    +
    Back to Top
    -- cgit v1.2.1