Add more page directly to the navigation
authorMatthias Schmidt <gravatronics@live.com>
Sun, 24 Jan 2021 11:24:55 +0000 (12:24 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Sun, 24 Jan 2021 11:24:55 +0000 (12:24 +0100)
See #118

docs/package/pip.md
docs/package/pip/clipboard-action.md [new file with mode: 0644]
docs/package/pip/clipboard_action.md [deleted file]
mkdocs.yml

index fc9ce417517b7f3b32bfde373e4b688e4a424882..b9ecbdc8f6b445292f3298c8c5da09c6f9a3e1a1 100644 (file)
@@ -14,7 +14,7 @@ Package Installation Plugins (PIPs) are interfaces to deploy and edit content as
 | [acpTemplate](pip/acp-template.md) | Admin panel templates |
 | [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 |
+| [clipboardAction](pip/clipboard-action.md) | Perform bulk operations on marked objects |
 | [coreObject](pip/core-object.md) | Access Singletons from within the template |
 | [cronjob](pip/cronjob.md) | Periodically execute code with customizable intervals |
 | [eventListener](pip/event-listener.md) | Register listeners for the event system |
diff --git a/docs/package/pip/clipboard-action.md b/docs/package/pip/clipboard-action.md
new file mode 100644 (file)
index 0000000..d436ffe
--- /dev/null
@@ -0,0 +1,54 @@
+# Clipboard Action Package Installation Plugin
+
+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>`
+
+<span class="label label-info">Optional</span>
+
+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/2019/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>
+```
diff --git a/docs/package/pip/clipboard_action.md b/docs/package/pip/clipboard_action.md
deleted file mode 100644 (file)
index d436ffe..0000000
+++ /dev/null
@@ -1,54 +0,0 @@
-# Clipboard Action Package Installation Plugin
-
-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>`
-
-<span class="label label-info">Optional</span>
-
-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/2019/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>
-```
index 6e545f14e23989f54e1db3e959937dbe4d3df7f1..209e73ffde24aeb33b3c8ccd236fcea4926042e2 100644 (file)
@@ -59,7 +59,40 @@ nav:
 
   - 'Package Components':
     - 'package.xml': 'package/package-xml.md'
-    - 'PIPs': 'package/pip.md'
+    - 'PIPs':
+      - 'Overview': 'package/pip.md'
+      - 'aclOption': 'package/pip/acl-option.md'
+      - 'acpMenu': 'package/pip/acp-menu.md'
+      - 'acpSearchProvider': 'package/pip/acp-search-provider.md'
+      - 'acpTemplate': 'package/pip/acp-template.md'
+      - 'bbcode': 'package/pip/bbcode.md'
+      - 'box': 'package/pip/box.md'
+      - 'clipboardAction': 'package/pip/clipboard-action.md'
+      - 'coreObject': 'package/pip/core-object.md'
+      - 'cronjob': 'package/pip/cronjob.md'
+      - 'eventListener': 'package/pip/event-listener.md'
+      - 'file': 'package/pip/file.md'
+      - 'language': 'package/pip/language.md'
+      - 'mediaProvider': 'package/pip/media-provider.md'
+      - 'menu': 'package/pip/menu.md'
+      - 'menuItem': 'package/pip/menu-item.md'
+      - 'objectType': 'package/pip/object-type.md'
+      - 'objectTypeDefinition': 'package/pip/object-type-definition.md'
+      - 'option': 'package/pip/option.md'
+      - 'page': 'package/pip/page.md'
+      - 'pip': 'package/pip/pip.md'
+      - 'script': 'package/pip/script.md'
+      - 'smiley': 'package/pip/smiley.md'
+      - 'sql': 'package/pip/sql.md'
+      - 'style': 'package/pip/style.md'
+      - 'template': 'package/pip/template.md'
+      - 'templateListener': 'package/pip/template-listener.md'
+      - 'userGroupOption': 'package/pip/user-group-option.md'
+      - 'userMenu': 'package/pip/user-menu.md'
+      - 'userNotificationEvent': 'package/pip/user-notification-event.md'
+      - 'userOption': 'package/pip/user-option.md'
+      - 'userProfileMenu': 'package/pip/user-profile-menu.md'
+    - 'Database PHP API': 'package/database-php-api.md'
 
   - 'Migration':
     - 'Migrating from WSC 5.3':