Skip to content

Commit

Permalink
Add clipboard action PIP documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gravatronics committed Apr 22, 2017
1 parent 99b0bad commit f1738fe
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 12 deletions.
4 changes: 2 additions & 2 deletions _data/sidebars/other.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pages/package/package_pip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
9 changes: 0 additions & 9 deletions pages/package/pip/package_pip_clipboard.md

This file was deleted.

60 changes: 60 additions & 0 deletions pages/package/pip/package_pip_clipboard_action.md
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>
```

0 comments on commit f1738fe

Please sign in to comment.