projects / GitHub / WoltLab / woltlab.github.io.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: e6dd3e1)
Document the comment refactoring
authorMarcel Werk <burntime@woltlab.com>
Mon, 30 Jan 2023 14:34:14 +0000 (15:34 +0100)
committerMarcel Werk <burntime@woltlab.com>
Mon, 30 Jan 2023 14:34:14 +0000 (15:34 +0100)
See #350

docs/migration/wsc55/comments.md [new file with mode: 0644] patch | blob
mkdocs.yml patch | blob | blame | history

diff --git a/docs/migration/wsc55/comments.md b/docs/migration/wsc55/comments.md
new file mode 100644 (file)
index 0000000..eaca6f5
--- /dev/null
+++ b/docs/migration/wsc55/comments.md
@@ -0,0 +1,12 @@
+# 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/mkdocs.yml b/mkdocs.yml
index 55773c6c33beb808ac42a8cb6c3f577bd13e9c86..19f0f707fc70d181260fa06630574e7f129005a3 100644 (file)
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -9,7 +9,7 @@ theme:
     primary: teal
   font: false
   features:
-  - navigation.tracking
+    - navigation.tracking
 copyright: Copyright © 2020 WoltLab GmbH
 site_url: https://docs.woltlab.com/
 repo_url: https://github.com/WoltLab/docs.woltlab.com/
@@ -19,158 +19,159 @@ nav:
   - 'Getting Started': 'getting-started.md'
 
   - 'PHP API':
-    - 'Pages': 'php/pages.md'
-    - 'Database Objects': 'php/database-objects.md'
-    - 'Database Access': 'php/database-access.md'
-    - 'Exceptions': 'php/exceptions.md'
-    - 'API':
-      - 'Caches':
-        - 'Overview': 'php/api/caches.md'
-        - 'Persistent Caches': 'php/api/caches_persistent-caches.md'
-        - 'Runtime Caches': 'php/api/caches_runtime-caches.md'
-      - 'Comments': 'php/api/comments.md'
-      - 'Cronjobs': 'php/api/cronjobs.md'
-      - 'Events': 'php/api/events.md'
-      - 'Form Builder': 
-        - 'Overview': 'php/api/form_builder/overview.md'
-        - 'Structure': 'php/api/form_builder/structure.md'
-        - 'Fields': 'php/api/form_builder/form_fields.md'
-        - 'Validation and Data': 'php/api/form_builder/validation_data.md'
-        - 'Dependencies': 'php/api/form_builder/dependencies.md'
-      - 'Package Installation Plugins': 'php/api/package_installation_plugins.md'
-      - 'User Activity Points': 'php/api/user_activity_points.md'
-      - 'User Notifications': 'php/api/user_notifications.md'
-      - 'Sitemaps': 'php/api/sitemaps.md'
-    - 'Code Style': 'php/code-style.md'
-    - 'Apps': 'php/apps.md'
-    - 'GDPR': 'php/gdpr.md'
+      - 'Pages': 'php/pages.md'
+      - 'Database Objects': 'php/database-objects.md'
+      - 'Database Access': 'php/database-access.md'
+      - 'Exceptions': 'php/exceptions.md'
+      - 'API':
+          - 'Caches':
+              - 'Overview': 'php/api/caches.md'
+              - 'Persistent Caches': 'php/api/caches_persistent-caches.md'
+              - 'Runtime Caches': 'php/api/caches_runtime-caches.md'
+          - 'Comments': 'php/api/comments.md'
+          - 'Cronjobs': 'php/api/cronjobs.md'
+          - 'Events': 'php/api/events.md'
+          - 'Form Builder':
+              - 'Overview': 'php/api/form_builder/overview.md'
+              - 'Structure': 'php/api/form_builder/structure.md'
+              - 'Fields': 'php/api/form_builder/form_fields.md'
+              - 'Validation and Data': 'php/api/form_builder/validation_data.md'
+              - 'Dependencies': 'php/api/form_builder/dependencies.md'
+          - 'Package Installation Plugins': 'php/api/package_installation_plugins.md'
+          - 'User Activity Points': 'php/api/user_activity_points.md'
+          - 'User Notifications': 'php/api/user_notifications.md'
+          - 'Sitemaps': 'php/api/sitemaps.md'
+      - 'Code Style': 'php/code-style.md'
+      - 'Apps': 'php/apps.md'
+      - 'GDPR': 'php/gdpr.md'
 
   - 'Languages, Templates & CSS':
-    - 'Languages': 'view/languages.md'
-    - 'Templates': 'view/templates.md'
-    - 'Template Plugins': 'view/template-plugins.md'
-    - 'CSS': 'view/css.md'
+      - 'Languages': 'view/languages.md'
+      - 'Templates': 'view/templates.md'
+      - 'Template Plugins': 'view/template-plugins.md'
+      - 'CSS': 'view/css.md'
 
   - 'TypeScript and JavaScript API':
-    - 'General Usage': 'javascript/general-usage.md'
-    - 'TypeScript': 'javascript/typescript.md'
-    - 'Components':
-      - 'Confirmation': 'javascript/components_confirmation.md'
-      - 'Dialog': 'javascript/components_dialog.md'
-      - 'Google Maps': 'javascript/components_google_maps.md'
-      - 'Pagination': 'javascript/components_pagination.md'
-    - 'New API':
-      - 'Writing a module': 'javascript/new-api_writing-a-module.md'
-      - 'Core Functions': 'javascript/new-api_core.md'
-      - 'DOM': 'javascript/new-api_dom.md'
-      - 'Event Handling': 'javascript/new-api_events.md'
-      - 'Ajax': 'javascript/new-api_ajax.md'
-      - 'Dialogs': 'javascript/new-api_dialogs.md'
-      - 'Browser and Screen Sizes': 'javascript/new-api_browser.md'
-      - 'User Interface': 'javascript/new-api_ui.md'
-    - 'Legacy API': 'javascript/legacy-api.md'
-    - 'Code Snippets': 'javascript/code-snippets.md'
+      - 'General Usage': 'javascript/general-usage.md'
+      - 'TypeScript': 'javascript/typescript.md'
+      - 'Components':
+          - 'Confirmation': 'javascript/components_confirmation.md'
+          - 'Dialog': 'javascript/components_dialog.md'
+          - 'Google Maps': 'javascript/components_google_maps.md'
+          - 'Pagination': 'javascript/components_pagination.md'
+      - 'New API':
+          - 'Writing a module': 'javascript/new-api_writing-a-module.md'
+          - 'Core Functions': 'javascript/new-api_core.md'
+          - 'DOM': 'javascript/new-api_dom.md'
+          - 'Event Handling': 'javascript/new-api_events.md'
+          - 'Ajax': 'javascript/new-api_ajax.md'
+          - 'Dialogs': 'javascript/new-api_dialogs.md'
+          - 'Browser and Screen Sizes': 'javascript/new-api_browser.md'
+          - 'User Interface': 'javascript/new-api_ui.md'
+      - 'Legacy API': 'javascript/legacy-api.md'
+      - 'Code Snippets': 'javascript/code-snippets.md'
 
   - 'Package Components':
-    - 'package.xml': 'package/package-xml.md'
-    - 'PIPs':
-      - 'Overview': 'package/pip.md'
-      - 'aclOption': 'package/pip/acl-option.md'
-      - 'acpMenu': 'package/pip/acp-menu.md'
-      - 'acpSearchProvider': 'package/pip/acp-search-provider.md'
-      - 'acpTemplate': 'package/pip/acp-template.md'
-      - 'acpTemplateDelete': 'package/pip/acp-template-delete.md'
-      - 'bbcode': 'package/pip/bbcode.md'
-      - 'box': 'package/pip/box.md'
-      - 'clipboardAction': 'package/pip/clipboard-action.md'
-      - 'coreObject': 'package/pip/core-object.md'
-      - 'cronjob': 'package/pip/cronjob.md'
-      - 'database': 'package/pip/database.md'
-      - 'eventListener': 'package/pip/event-listener.md'
-      - 'file': 'package/pip/file.md'
-      - 'fileDelete': 'package/pip/file-delete.md'
-      - 'language': 'package/pip/language.md'
-      - 'mediaProvider': 'package/pip/media-provider.md'
-      - 'menu': 'package/pip/menu.md'
-      - 'menuItem': 'package/pip/menu-item.md'
-      - 'objectType': 'package/pip/object-type.md'
-      - 'objectTypeDefinition': 'package/pip/object-type-definition.md'
-      - 'option': 'package/pip/option.md'
-      - 'page': 'package/pip/page.md'
-      - 'pip': 'package/pip/pip.md'
-      - 'script': 'package/pip/script.md'
-      - 'smiley': 'package/pip/smiley.md'
-      - 'sql': 'package/pip/sql.md'
-      - 'style': 'package/pip/style.md'
-      - 'template': 'package/pip/template.md'
-      - 'templateDelete': 'package/pip/template-delete.md'
-      - 'templateListener': 'package/pip/template-listener.md'
-      - 'userGroupOption': 'package/pip/user-group-option.md'
-      - 'userMenu': 'package/pip/user-menu.md'
-      - 'userNotificationEvent': 'package/pip/user-notification-event.md'
-      - 'userOption': 'package/pip/user-option.md'
-      - 'userProfileMenu': 'package/pip/user-profile-menu.md'
-    - 'Database PHP API': 'package/database-php-api.md'
+      - 'package.xml': 'package/package-xml.md'
+      - 'PIPs':
+          - 'Overview': 'package/pip.md'
+          - 'aclOption': 'package/pip/acl-option.md'
+          - 'acpMenu': 'package/pip/acp-menu.md'
+          - 'acpSearchProvider': 'package/pip/acp-search-provider.md'
+          - 'acpTemplate': 'package/pip/acp-template.md'
+          - 'acpTemplateDelete': 'package/pip/acp-template-delete.md'
+          - 'bbcode': 'package/pip/bbcode.md'
+          - 'box': 'package/pip/box.md'
+          - 'clipboardAction': 'package/pip/clipboard-action.md'
+          - 'coreObject': 'package/pip/core-object.md'
+          - 'cronjob': 'package/pip/cronjob.md'
+          - 'database': 'package/pip/database.md'
+          - 'eventListener': 'package/pip/event-listener.md'
+          - 'file': 'package/pip/file.md'
+          - 'fileDelete': 'package/pip/file-delete.md'
+          - 'language': 'package/pip/language.md'
+          - 'mediaProvider': 'package/pip/media-provider.md'
+          - 'menu': 'package/pip/menu.md'
+          - 'menuItem': 'package/pip/menu-item.md'
+          - 'objectType': 'package/pip/object-type.md'
+          - 'objectTypeDefinition': 'package/pip/object-type-definition.md'
+          - 'option': 'package/pip/option.md'
+          - 'page': 'package/pip/page.md'
+          - 'pip': 'package/pip/pip.md'
+          - 'script': 'package/pip/script.md'
+          - 'smiley': 'package/pip/smiley.md'
+          - 'sql': 'package/pip/sql.md'
+          - 'style': 'package/pip/style.md'
+          - 'template': 'package/pip/template.md'
+          - 'templateDelete': 'package/pip/template-delete.md'
+          - 'templateListener': 'package/pip/template-listener.md'
+          - 'userGroupOption': 'package/pip/user-group-option.md'
+          - 'userMenu': 'package/pip/user-menu.md'
+          - 'userNotificationEvent': 'package/pip/user-notification-event.md'
+          - 'userOption': 'package/pip/user-option.md'
+          - 'userProfileMenu': 'package/pip/user-profile-menu.md'
+      - 'Database PHP API': 'package/database-php-api.md'
 
   - 'Migration':
-    - 'From WoltLab Suite 5.5':
-      - 'PHP API': 'migration/wsc55/php.md'
-      - 'TypeScript and JavaScript': 'migration/wsc55/javascript.md'
-      - 'Templates': 'migration/wsc55/templates.md'
-      - 'Icons': 'migration/wsc55/icons.md'
-      - 'Dialogs': 'migration/wsc55/dialogs.md'
-      - 'Third Party Libraries': 'migration/wsc55/libraries.md'
-      - 'Deprecations and Removals': 'migration/wsc55/deprecations_removals.md'
-    - 'From WoltLab Suite 5.4':
-      - 'PHP API': 'migration/wsc54/php.md'
-      - 'TypeScript and JavaScript': 'migration/wsc54/javascript.md'
-      - 'Templates': 'migration/wsc54/templates.md'
-      - 'Third Party Libraries': 'migration/wsc54/libraries.md'
-      - 'Deprecations and Removals': 'migration/wsc54/deprecations_removals.md'
-    - 'From WoltLab Suite 5.3':
-      - 'PHP API': 'migration/wsc53/php.md'
-      - 'Session Handling and Authentication': 'migration/wsc53/session.md'
-      - 'TypeScript and JavaScript': 'migration/wsc53/javascript.md'
-      - 'Templates': 'migration/wsc53/templates.md'
-      - 'Third Party Libraries': 'migration/wsc53/libraries.md'
-    - 'From WoltLab Suite 5.2':
-      - 'PHP API': 'migration/wsc52/php.md'
-      - 'Templates and Languages': 'migration/wsc52/templates.md'
-      - 'Third Party Libraries': 'migration/wsc52/libraries.md'
-    - 'From WoltLab Suite 3.1':
-      - 'PHP API': 'migration/wsc31/php.md'
-    - 'From WoltLab Suite 3.0':
-      - 'PHP API': 'migration/wsc30/php.md'
-      - 'JavaScript API': 'migration/wsc30/javascript.md'
-      - 'Templates': 'migration/wsc30/templates.md'
-      - 'CSS': 'migration/wsc30/css.md'
-      - 'Package Components': 'migration/wsc30/package.md'
-    - 'From WCF 2.1':
-      - 'PHP API': 'migration/wcf21/php.md'
-      - 'Templates': 'migration/wcf21/templates.md'
-      - 'CSS': 'migration/wcf21/css.md'
-      - 'Package Components': 'migration/wcf21/package.md'
+      - 'From WoltLab Suite 5.5':
+          - 'PHP API': 'migration/wsc55/php.md'
+          - 'TypeScript and JavaScript': 'migration/wsc55/javascript.md'
+          - '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':
+          - 'PHP API': 'migration/wsc54/php.md'
+          - 'TypeScript and JavaScript': 'migration/wsc54/javascript.md'
+          - 'Templates': 'migration/wsc54/templates.md'
+          - 'Third Party Libraries': 'migration/wsc54/libraries.md'
+          - 'Deprecations and Removals': 'migration/wsc54/deprecations_removals.md'
+      - 'From WoltLab Suite 5.3':
+          - 'PHP API': 'migration/wsc53/php.md'
+          - 'Session Handling and Authentication': 'migration/wsc53/session.md'
+          - 'TypeScript and JavaScript': 'migration/wsc53/javascript.md'
+          - 'Templates': 'migration/wsc53/templates.md'
+          - 'Third Party Libraries': 'migration/wsc53/libraries.md'
+      - 'From WoltLab Suite 5.2':
+          - 'PHP API': 'migration/wsc52/php.md'
+          - 'Templates and Languages': 'migration/wsc52/templates.md'
+          - 'Third Party Libraries': 'migration/wsc52/libraries.md'
+      - 'From WoltLab Suite 3.1':
+          - 'PHP API': 'migration/wsc31/php.md'
+      - 'From WoltLab Suite 3.0':
+          - 'PHP API': 'migration/wsc30/php.md'
+          - 'JavaScript API': 'migration/wsc30/javascript.md'
+          - 'Templates': 'migration/wsc30/templates.md'
+          - 'CSS': 'migration/wsc30/css.md'
+          - 'Package Components': 'migration/wsc30/package.md'
+      - 'From WCF 2.1':
+          - 'PHP API': 'migration/wcf21/php.md'
+          - 'Templates': 'migration/wcf21/templates.md'
+          - 'CSS': 'migration/wcf21/css.md'
+          - 'Package Components': 'migration/wcf21/package.md'
 
   - 'Tutorials':
-    - 'Tutorial Series':
-        - 'Overview': 'tutorial/series/overview.md'
-        - 'Part 1': 'tutorial/series/part_1.md'
-        - 'Part 2': 'tutorial/series/part_2.md'
-        - 'Part 3': 'tutorial/series/part_3.md'
-        - 'Part 4': 'tutorial/series/part_4.md'
-        - 'Part 5': 'tutorial/series/part_5.md'
-        - 'Part 6': 'tutorial/series/part_6.md'
+      - 'Tutorial Series':
+          - 'Overview': 'tutorial/series/overview.md'
+          - 'Part 1': 'tutorial/series/part_1.md'
+          - 'Part 2': 'tutorial/series/part_2.md'
+          - 'Part 3': 'tutorial/series/part_3.md'
+          - 'Part 4': 'tutorial/series/part_4.md'
+          - 'Part 5': 'tutorial/series/part_5.md'
+          - 'Part 6': 'tutorial/series/part_6.md'
 
 plugins:
   - git-revision-date
   - search
   - macros:
-      j2_comment_start_string: "{jinja#"
-      j2_variable_start_string: "{jinja{"
+      j2_comment_start_string: '{jinja#'
+      j2_variable_start_string: '{jinja{'
 
 markdown_extensions:
   - toc:
-      permalink: "#"
+      permalink: '#'
       toc_depth: 4
   - admonition
   - abbr
@@ -183,7 +184,7 @@ markdown_extensions:
             startinline: true
   - pymdownx.superfences
   - pymdownx.snippets:
-      base_path: "snippets/"
+      base_path: 'snippets/'
 
 extra_css:
   - stylesheets/extra.css