From 172f0a5df5d1707e13b678a3f5c421a32ddd4a92 Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Tue, 8 Jun 2021 18:07:13 +0200 Subject: [PATCH] Document `fileDelete` PIP --- docs/package/pip.md | 1 + docs/package/pip/file-delete.md | 19 +++++++++++++++++++ mkdocs.yml | 1 + snippets/package/pip/fileDelete.xml | 7 +++++++ 4 files changed, 28 insertions(+) create mode 100644 docs/package/pip/file-delete.md create mode 100644 snippets/package/pip/fileDelete.xml diff --git a/docs/package/pip.md b/docs/package/pip.md index 93ee7096..1c998353 100644 --- a/docs/package/pip.md +++ b/docs/package/pip.md @@ -21,6 +21,7 @@ Package Installation Plugins (PIPs) are interfaces to deploy and edit content as | [database](pip/database.md) | Updates the database layout using [the PHP API](database-php-api.md) | | [eventListener](pip/event-listener.md) | Register listeners for the event system | | [file](pip/file.md) | Deploy any type of files with the exception of templates | +| [fileDelete](pip/file-delete.md) | Deletes files installed with [file](pip/file.md) | | [language](pip/language.md) | Language items | | [mediaProvider](pip/media-provider.md) | Detect and convert links to media providers | | [menu](pip/menu.md) | Side-wide and custom per-page menus | diff --git a/docs/package/pip/file-delete.md b/docs/package/pip/file-delete.md new file mode 100644 index 00000000..c0bb88cd --- /dev/null +++ b/docs/package/pip/file-delete.md @@ -0,0 +1,19 @@ +# File Delete Package Installation Plugin + +Deletes files installed with the [file](pip/file.md) package installation plugin. + +!!! warning "You cannot delete files provided by other packages." + + +## Components + +Each item is described as a `` element with an optional `application`, which behaves like it does for [acp templates](acp-template.md#application). +The file path is relative to the installation of the app to which the file belongs. + +## Example + +{jinja{ codebox( + title="fileDelete.xml", + language="xml", + filepath="package/pip/fileDelete.xml" +) }} diff --git a/mkdocs.yml b/mkdocs.yml index 95f27eff..0eba921e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -83,6 +83,7 @@ nav: - 'database': 'package/pip/database.md' - 'eventListener': 'package/pip/event-listener.md' - 'file': 'package/pip/file.md' + - 'fileDelete': 'package/pip/file-delete.md' - 'language': 'package/pip/language.md' - 'mediaProvider': 'package/pip/media-provider.md' - 'menu': 'package/pip/menu.md' diff --git a/snippets/package/pip/fileDelete.xml b/snippets/package/pip/fileDelete.xml new file mode 100644 index 00000000..7b9b5828 --- /dev/null +++ b/snippets/package/pip/fileDelete.xml @@ -0,0 +1,7 @@ + + + + path/file.ext + lib/data/foo/Fou.class.php + + -- 2.20.1