diff --git a/_data/sidebars/other.yml b/_data/sidebars/other.yml index aaf6c9302..612126f59 100644 --- a/_data/sidebars/other.yml +++ b/_data/sidebars/other.yml @@ -30,8 +30,8 @@ entries: url: /package_pip_bbcode.html - title: box url: /package_pip_box.html - - title: clipboard - url: /package_pip_clipboard.html + - title: clipboardAction + url: /package_pip_clipboard_action.html - title: coreObject url: /package_pip_core-object.html - title: cronjob diff --git a/pages/package/package_pip.md b/pages/package/package_pip.md index c098463bb..de9af56d6 100644 --- a/pages/package/package_pip.md +++ b/pages/package/package_pip.md @@ -19,7 +19,7 @@ Package Installation Plugins (PIPs) are interfaces to deploy and edit content as | [acpTemplate][package_pip_acp-template] | Admin panel templates | | [bbcode][package_pip_bbcode] | BBCodes for rich message formatting | | [box][package_pip_box] | Boxes that can be placed anywhere on a page | -| [clipboard][package_pip_clipboard] | Perform bulk operations on objects by marking them | +| [clipboardAction][package_pip_clipboard_action] | Perform bulk operations on marked objects | | [coreObject][package_pip_core-object] | Access Singletons from within the template | | [cronjob][package_pip_cronjob] | Periodically execute code with customizable intervals | | [eventListener][package_pip_event-listener] | Register listeners for the event system | diff --git a/pages/package/pip/package_pip_clipboard.md b/pages/package/pip/package_pip_clipboard.md deleted file mode 100644 index bf30bf7d9..000000000 --- a/pages/package/pip/package_pip_clipboard.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Clipboard Package Installation Plugin -sidebar: sidebar -permalink: package_pip_clipboard.html -folder: package/pip -parent: package_pip ---- - -*Content will follow soon* diff --git a/pages/package/pip/package_pip_clipboard_action.md b/pages/package/pip/package_pip_clipboard_action.md new file mode 100644 index 000000000..1de45af2a --- /dev/null +++ b/pages/package/pip/package_pip_clipboard_action.md @@ -0,0 +1,60 @@ +--- +title: Clipboard Action Package Installation Plugin +sidebar: sidebar +permalink: package_pip_clipboard_action.html +folder: package/pip +parent: package_pip +--- + +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. + +### `` + +{% include callout.html content="Optional" type="info" %} + +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 + + + + +```