forked from WoltLab/docs.woltlab.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add clipboard action PIP documentation
- Loading branch information
1 parent
99b0bad
commit f1738fe
Showing
4 changed files
with
63 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 `<action>` element with the mandatory attribute `name`. | ||
|
||
### `<actionclassname>` | ||
|
||
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`. | ||
|
||
### `<pages>` | ||
|
||
Element with `<page>` children whose value contains the class name of the controller of the page on which the clipboard action is available. | ||
|
||
### `<showorder>` | ||
|
||
{% include callout.html content="Optional" type="info" %} | ||
|
||
Determines at which position of the clipboard action list the action is shown. | ||
|
||
|
||
## Example | ||
|
||
```xml | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/vortex/clipboardAction.xsd"> | ||
<import> | ||
<action name="delete"> | ||
<actionclassname>wcf\system\clipboard\action\ExampleClipboardAction</actionclassname> | ||
<showorder>1</showorder> | ||
<pages> | ||
<page>wcf\acp\page\ExampleListPage</page> | ||
</pages> | ||
</action> | ||
<action name="foo"> | ||
<actionclassname>wcf\system\clipboard\action\ExampleClipboardAction</actionclassname> | ||
<showorder>2</showorder> | ||
<pages> | ||
<page>wcf\acp\page\ExampleListPage</page> | ||
</pages> | ||
</action> | ||
<action name="bar"> | ||
<actionclassname>wcf\system\clipboard\action\ExampleClipboardAction</actionclassname> | ||
<showorder>3</showorder> | ||
<pages> | ||
<page>wcf\acp\page\ExampleListPage</page> | ||
</pages> | ||
</action> | ||
</import> | ||
</data> | ||
``` |