From: Tim Düsterhus Date: Fri, 3 Feb 2023 12:49:43 +0000 (+0100) Subject: Move the comment migration guide into the templates migration X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=453d6afc664c0019b26a9355d290c5d95163485a;p=GitHub%2FWoltLab%2Fwoltlab.github.io.git Move the comment migration guide into the templates migration No need to have an entirely separate page for a few sentences and the only change that needs to happen is with the templates. --- diff --git a/docs/migration/wsc55/comments.md b/docs/migration/wsc55/comments.md deleted file mode 100644 index eaca6f56..00000000 --- a/docs/migration/wsc55/comments.md +++ /dev/null @@ -1,12 +0,0 @@ -# Migrating from WoltLab Suite 5.5 - Comments - -In WoltLab Suite 6.0 the comment system has been overhauled. -In the process, the integration of comments via templates has been significantly simplified: - -```smarty -{include file='comments' commentContainerID='someElementId' commentObjectID=$someObjectID} -``` - -An example for the migration of existing template integrations can be found [here](https://github.com/WoltLab/WCF/commit/b1d5f7cc6b81ae7fd938603bb20a3a454a531a96#diff-3419ed2f17fa84a70caf0d99511d5ac2a7704c62f24cc7042984d7a9932525ce). - -See [WoltLab/WCF#5210](https://github.com/WoltLab/WCF/pull/5210) for more details. diff --git a/docs/migration/wsc55/templates.md b/docs/migration/wsc55/templates.md index 7b2b63e2..b84fb2e1 100644 --- a/docs/migration/wsc55/templates.md +++ b/docs/migration/wsc55/templates.md @@ -9,3 +9,16 @@ To improve security and to reduce the number of differences between enterprise m It is strongly recommended to keep the template logic as simple as possible by moving the heavy lifting into regular PHP code, reducing the number of (specialized) modifiers that need to be applied. See [WoltLab/WCF#4788](https://github.com/WoltLab/WCF/pull/4788) for details. + +## Comments + +In WoltLab Suite 6.0 the comment system has been overhauled. +In the process, the integration of comments via templates has been significantly simplified: + +```smarty +{include file='comments' commentContainerID='someElementId' commentObjectID=$someObjectID} +``` + +An example for the migration of existing template integrations can be found [here](https://github.com/WoltLab/WCF/commit/b1d5f7cc6b81ae7fd938603bb20a3a454a531a96#diff-3419ed2f17fa84a70caf0d99511d5ac2a7704c62f24cc7042984d7a9932525ce). + +See [WoltLab/WCF#5210](https://github.com/WoltLab/WCF/pull/5210) for more details. diff --git a/mkdocs.yml b/mkdocs.yml index 19f0f707..438c1f1c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -119,7 +119,6 @@ nav: - 'Templates': 'migration/wsc55/templates.md' - 'Icons': 'migration/wsc55/icons.md' - 'Dialogs': 'migration/wsc55/dialogs.md' - - 'Comments': 'migration/wsc55/comments.md' - 'Third Party Libraries': 'migration/wsc55/libraries.md' - 'Deprecations and Removals': 'migration/wsc55/deprecations_removals.md' - 'From WoltLab Suite 5.4':