site_name: WoltLab Suite Documentation
theme:
- name: material
- language: en
- custom_dir: overrides
- logo: assets/logo.png
- favicon: assets/default.favicon.ico
+ name: material
+ language: en
+ custom_dir: overrides
+ logo: assets/logo.png
+ favicon: assets/default.favicon.ico
+ palette:
+ primary: teal
+ font: false
copyright: Copyright © 2020 WoltLab GmbH
+repo_url: https://github.com/WoltLab/docs.woltlab.com
+edit_uri: edit/5.4/docs/
nav:
- - 'Getting Started': 'getting-started_quick-start.md'
+ - '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': 'php_api_caches.md'
- - 'Comments': 'php_api_comments.md'
- - 'Cronjobs': 'php_api_cronjobs.md'
- - 'Events': 'php_api_events.md'
- - 'Form Builder': 'php_api_form_builder.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'
+ - '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'
- - 'Languages, Templates & CSS':
- - 'Languages': 'view_languages.md'
- - 'Templates': 'view_templates.md'
- - 'CSS': 'view_css.md'
+ - 'Languages, Templates & CSS':
+ - 'Languages': 'view/languages.md'
+ - 'Templates': 'view/templates.md'
+ - 'Template Plugins': 'view/template-plugins.md'
+ - 'CSS': 'view/css.md'
- - 'JavaScript API':
- - 'General Usage': 'javascript_general-usage.md'
- - 'New API':
- - 'Writing a module': 'javascript_new-api_writing-a-module.md'
- - 'Data Structures': 'javascript_new-api_data-structures.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'
- - 'Helper Functions': 'javascript_helper-functions.md'
- - 'Code Snippets': 'javascript_code-snippets.md'
+ - 'TypeScript and JavaScript API':
+ - 'General Usage': 'javascript/general-usage.md'
+ - 'TypeScript': 'javascript/typescript.md'
+ - 'New API':
+ - 'Writing a module': 'javascript/new-api_writing-a-module.md'
+ - 'Data Structures': 'javascript/new-api_data-structures.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'
+ - 'Helper Functions': 'javascript/helper-functions.md'
+ - 'Code Snippets': 'javascript/code-snippets.md'
- - 'Package Components':
- - 'package.xml': 'package_package-xml.md'
- - 'PIPs': 'package_pip.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'
+ - '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'
+ - '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'
+ - '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':
- - 'Migrating from WSC 5.3':
- - 'PHP API': 'migration_wsc-53_php.md'
- - 'Session Handling and Authentication': 'migration_wsc-53_session.md'
- - 'JavaScript': 'migration_wsc-53_javascript.md'
- - 'Templates': 'migration_wsc-53_templates.md'
- - 'Third Party Libraries': 'migration_wsc-53_libraries.md'
- - 'Migrating from WSC 5.2':
- - 'PHP API': 'migration_wsc-52_php.md'
- - 'Templates and Languages': 'migration_wsc-52_templates.md'
- - 'Third Party Libraries': 'migration_wsc-52_libraries.md'
- - 'Migrating from WSC 3.1':
- - 'PHP API': 'migration_wsc-31_php.md'
- - 'Migrating from WSC 3.0':
- - 'PHP API': 'migration_wsc-30_php.md'
- - 'JavaScript API': 'migration_wsc-30_javascript.md'
- - 'Templates': 'migration_wsc-30_templates.md'
- - 'CSS': 'migration_wsc-30_css.md'
- - 'Package Components': 'migration_wsc-30_package.md'
- - 'Migrating from WCF 2.1':
- - 'PHP API': 'migration_wcf-21_php.md'
- - 'Templates': 'migration_wcf-21_templates.md'
- - 'CSS': 'migration_wcf-21_css.md'
- - 'Package Components': 'migration_wcf-21_package.md'
+ - 'Migration':
+ - 'Migrating from WSC 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'
+ - 'Migrating from WSC 5.2':
+ - 'PHP API': 'migration/wsc52/php.md'
+ - 'Templates and Languages': 'migration/wsc52/templates.md'
+ - 'Third Party Libraries': 'migration/wsc52/libraries.md'
+ - 'Migrating from WSC 3.1':
+ - 'PHP API': 'migration/wsc31/php.md'
+ - 'Migrating from WSC 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'
+ - 'Migrating 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': 'tutorial_tutorial-series.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'
+
+plugins:
+ - git-revision-date
+ - search
+ - markdownextradata:
+ jinja_options:
+ block_start_string: "{jinja%"
+ comment_start_string: "{jinja#"
+ variable_start_string: "{jinja{"
markdown_extensions:
- - toc:
- permalink: "#"
- toc_depth: 4
- - admonition
- - abbr
- - pymdownx.highlight
- - pymdownx.superfences
- - pymdownx.snippets:
- base_path: "snippets/"
+ - toc:
+ permalink: "#"
+ toc_depth: 4
+ - admonition
+ - abbr
+ - pymdownx.highlight:
+ extend_pygments_lang:
+ - name: php
+ lang: php
+ options:
+ startinline: true
+ - pymdownx.superfences
+ - pymdownx.snippets:
+ base_path: "snippets/"
extra_css:
- - stylesheets/extra.css
+ - stylesheets/extra.css
+
+extra:
+ version:
+ provider: mike
projects / GitHub / WoltLab / woltlab.github.io.git / blobdiff