From: Matthias Schmidt Date: Sun, 24 Jan 2021 11:24:55 +0000 (+0100) Subject: Add more page directly to the navigation X-Git-Tag: 5.6.final~314 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=0066874e9349932953df1f88e2d081754341380c;p=GitHub%2FWoltLab%2Fwoltlab.github.io.git Add more page directly to the navigation See #118 --- diff --git a/docs/package/pip.md b/docs/package/pip.md index fc9ce417..b9ecbdc8 100644 --- a/docs/package/pip.md +++ b/docs/package/pip.md @@ -14,7 +14,7 @@ Package Installation Plugins (PIPs) are interfaces to deploy and edit content as | [acpTemplate](pip/acp-template.md) | Admin panel templates | | [bbcode](pip/bbcode.md) | BBCodes for rich message formatting | | [box](pip/box.md) | Boxes that can be placed anywhere on a page | -| [clipboardAction](pip/clipboard_action.md) | Perform bulk operations on marked objects | +| [clipboardAction](pip/clipboard-action.md) | Perform bulk operations on marked objects | | [coreObject](pip/core-object.md) | Access Singletons from within the template | | [cronjob](pip/cronjob.md) | Periodically execute code with customizable intervals | | [eventListener](pip/event-listener.md) | Register listeners for the event system | diff --git a/docs/package/pip/clipboard-action.md b/docs/package/pip/clipboard-action.md new file mode 100644 index 00000000..d436ffec --- /dev/null +++ b/docs/package/pip/clipboard-action.md @@ -0,0 +1,54 @@ +# Clipboard Action Package Installation Plugin + +Registers clipboard actions. + +## Components + +Each clipboard action is described as an `` element with the mandatory attribute `name`. + +### `` + +The name of the class used by the clipboard API to process the concrete action. +The class has to implement the `wcf\system\clipboard\action\IClipboardAction` interface, best by extending `wcf\system\clipboard\action\AbstractClipboardAction`. + +### `` + +Element with `` children whose value contains the class name of the controller of the page on which the clipboard action is available. + +### `` + +Optional + +Determines at which position of the clipboard action list the action is shown. + + +## Example + +```xml + + + + + wcf\system\clipboard\action\ExampleClipboardAction + 1 + + wcf\acp\page\ExampleListPage + + + + wcf\system\clipboard\action\ExampleClipboardAction + 2 + + wcf\acp\page\ExampleListPage + + + + wcf\system\clipboard\action\ExampleClipboardAction + 3 + + wcf\acp\page\ExampleListPage + + + + +``` diff --git a/docs/package/pip/clipboard_action.md b/docs/package/pip/clipboard_action.md deleted file mode 100644 index d436ffec..00000000 --- a/docs/package/pip/clipboard_action.md +++ /dev/null @@ -1,54 +0,0 @@ -# Clipboard Action Package Installation Plugin - -Registers clipboard actions. - -## Components - -Each clipboard action is described as an `` element with the mandatory attribute `name`. - -### `` - -The name of the class used by the clipboard API to process the concrete action. -The class has to implement the `wcf\system\clipboard\action\IClipboardAction` interface, best by extending `wcf\system\clipboard\action\AbstractClipboardAction`. - -### `` - -Element with `` children whose value contains the class name of the controller of the page on which the clipboard action is available. - -### `` - -Optional - -Determines at which position of the clipboard action list the action is shown. - - -## Example - -```xml - - - - - wcf\system\clipboard\action\ExampleClipboardAction - 1 - - wcf\acp\page\ExampleListPage - - - - wcf\system\clipboard\action\ExampleClipboardAction - 2 - - wcf\acp\page\ExampleListPage - - - - wcf\system\clipboard\action\ExampleClipboardAction - 3 - - wcf\acp\page\ExampleListPage - - - - -``` diff --git a/mkdocs.yml b/mkdocs.yml index 6e545f14..209e73ff 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,7 +59,40 @@ nav: - 'Package Components': - 'package.xml': 'package/package-xml.md' - - 'PIPs': 'package/pip.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' + - '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':