Document `acpTemplateDelete` PIP
authorMatthias Schmidt <gravatronics@live.com>
Tue, 8 Jun 2021 16:06:57 +0000 (18:06 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Tue, 8 Jun 2021 16:06:57 +0000 (18:06 +0200)
docs/package/pip.md
docs/package/pip/acp-template-delete.md [new file with mode: 0644]
mkdocs.yml
snippets/package/pip/acpTemplateDelete.xml [new file with mode: 0644]

index 6c4011150ac0a60d435f857dce0e7311c8661f9e..93ee7096982003382748bdcd0edc4d3da91460f8 100644 (file)
@@ -12,6 +12,7 @@ Package Installation Plugins (PIPs) are interfaces to deploy and edit content as
 | [acpMenu](pip/acp-menu.md) | Admin panel menu categories and items |
 | [acpSearchProvider](pip/acp-search-provider.md) | Data provider for the admin panel search |
 | [acpTemplate](pip/acp-template.md) | Admin panel templates |
+| [acpTemplateDelete](pip/acp-template-delete.md) | Deletes admin panel templates installed with [acpTemplate](pip/acp-template.md) |
 | [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 |
diff --git a/docs/package/pip/acp-template-delete.md b/docs/package/pip/acp-template-delete.md
new file mode 100644 (file)
index 0000000..433b5b0
--- /dev/null
@@ -0,0 +1,19 @@
+# ACP Template Delete Package Installation Plugin
+
+Deletes admin panel templates installed with the [acpTemplate](pip/acp-template.md) package installation plugin.
+
+!!! warning "You cannot delete acp templates provided by other packages."
+
+
+## Components
+
+Each item is described as a `<template>` element with an optional `application`, which behaves like it does for [acp templates](acp-template.md#application).
+The templates are identified by their name like when adding [template listeners](template-listener.md), i.e. by the file name without the `.tpl` file extension.
+
+## Example
+
+{jinja{ codebox(
+    title="acpTemplateDelete.xml",
+    language="xml",
+    filepath="package/pip/acpTemplateDelete.xml"
+) }}
index 99e0e8e955e51a58b2f40e8f727d0298b55837f5..95f27effefc9a180b197dcbc52876cc57bc38bed 100644 (file)
@@ -74,6 +74,7 @@ nav:
       - 'acpMenu': 'package/pip/acp-menu.md'
       - 'acpSearchProvider': 'package/pip/acp-search-provider.md'
       - 'acpTemplate': 'package/pip/acp-template.md'
+      - 'acpTemplateDelete': 'package/pip/acp-template-delete.md'
       - 'bbcode': 'package/pip/bbcode.md'
       - 'box': 'package/pip/box.md'
       - 'clipboardAction': 'package/pip/clipboard-action.md'
diff --git a/snippets/package/pip/acpTemplateDelete.xml b/snippets/package/pip/acpTemplateDelete.xml
new file mode 100644 (file)
index 0000000..1c57fb9
--- /dev/null
@@ -0,0 +1,7 @@
+<?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/2019/acpTemplateDelete.xsd">
+       <delete>
+               <template>fouAdd</template>
+               <template application="app">__appAdd</template>
+       </delete>
+</data>