From 47709881b734786b6b8caa4c882caf73cec19fef Mon Sep 17 00:00:00 2001 From: Andre601 Date: Fri, 19 Jan 2024 01:21:06 +0100 Subject: [PATCH] Move commands.md to user guides section --- .../creating-a-placeholderexpansion.md | 4 +-- docs/developers/expansion-cloud.md | 8 +++--- docs/faq.md | 10 +++---- docs/index.md | 26 ++----------------- docs/{ => users}/commands.md | 0 docs/users/index.md | 8 ++++++ mkdocs.yml | 2 +- 7 files changed, 22 insertions(+), 36 deletions(-) rename docs/{ => users}/commands.md (100%) diff --git a/docs/developers/creating-a-placeholderexpansion.md b/docs/developers/creating-a-placeholderexpansion.md index f7b4ac5..e455e13 100644 --- a/docs/developers/creating-a-placeholderexpansion.md +++ b/docs/developers/creating-a-placeholderexpansion.md @@ -7,7 +7,7 @@ description: Comprehensive guide on how to create a PlaceholderExpansion for oth This page will cover how you can create your own [`PlaceholderExpansion`][placeholderexpansion] which you can either integrate into your own plugin (Recommended) or [upload to the eCloud](expansion-cloud.md). It's worth noting that PlaceholderAPI relies on expansions being installed. PlaceholderAPI only acts as the core replacing utility while the expansions allow other plugins to use any installed placeholder in their own messages. -You can download expansions either directly from the eCloud yourself, or download them through the [download command of PlaceholderAPI](../commands.md#papi-ecloud-download). +You can download expansions either directly from the eCloud yourself, or download them through the [download command of PlaceholderAPI](../users/commands.md#papi-ecloud-download). ## Table of contents @@ -231,7 +231,7 @@ It is recommended to only make external Expansions for the following situations. Should the above cases not match your situation, meaning your expansion is for a plugin you maintain, is the creation of an [internal Expansion](#making-an-internal-expansion) recommended. -Some benefits of an external expansion include automatic (re)loading of your expansion by PlaceholderAPI and having the option to [upload it to the eCloud](expansion-cloud.md) allowing the download of it through the [`/papi ecloud download` command](../commands.md#papi-ecloud-download). +Some benefits of an external expansion include automatic (re)loading of your expansion by PlaceholderAPI and having the option to [upload it to the eCloud](expansion-cloud.md) allowing the download of it through the [`/papi ecloud download` command](../users/commands.md#papi-ecloud-download). Downsides include a more tedious setup in terms of checking for a required plugin being present. /// details | Full Example (Without Dependency) diff --git a/docs/developers/expansion-cloud.md b/docs/developers/expansion-cloud.md index 7265381..215d225 100644 --- a/docs/developers/expansion-cloud.md +++ b/docs/developers/expansion-cloud.md @@ -13,7 +13,7 @@ The expansion-cloud can be seen under https://api.extendedclip.com/home ## How it works PlaceholderAPI connects to the ecloud on startup of your server, to check if the cloud is available and how many expansions are available on it. -If you run [`/papi ecloud download `](../commands.md#papi-ecloud-download), PlaceholderAPI will connect to the site to first check if the specified expansion exists and then downloads it if it does. +If you run [`/papi ecloud download `](../users/commands.md#papi-ecloud-download), PlaceholderAPI will connect to the site to first check if the specified expansion exists and then downloads it if it does. /// note PlaceholderAPI can only download expansions that are verified on the eCloud. Any unverified expansion needs to be downloaded manually. @@ -82,11 +82,11 @@ Here is how you can do it for each. This is the easiest of both methods since it requires the least amount of effort. Run the following command in-game or in your console to download a specific version: -[`/papi ecloud download [version]`](../commands.md#papi-ecloud-download) +[`/papi ecloud download [version]`](../users/commands.md#papi-ecloud-download) -To find out, what versions are available for the expansion, run [`/papi ecloud info `](../commands.md#papi-ecloud-info). +To find out, what versions are available for the expansion, run [`/papi ecloud info `](../users/commands.md#papi-ecloud-info). -After you downloaded the specific version, run [`/papi reload`](../commands.md#papi-reload) to refresh the installed expansions. +After you downloaded the specific version, run [`/papi reload`](../users/commands.md#papi-reload) to refresh the installed expansions. ### Download manually diff --git a/docs/faq.md b/docs/faq.md index c962b64..0d293a2 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -11,16 +11,16 @@ Here are frequently asked questions about stuff related to PlaceholderAPI. An expansion (or PlaceholderExpansion) refers to either a jar file or part of a plugin that provides placeholders to use through PlaceholderAPI itself. Whether said expansion is a separate jar file or part of a plugin depends on the expansion itself and its main purpose. -Expansions that are separate jar files can be found on the eCloud and are downloadable through [`/papi ecloud download `](commands.md#papi-ecloud-download) if the expansion is verified. +Expansions that are separate jar files can be found on the eCloud and are downloadable through [`/papi ecloud download `](users/commands.md#papi-ecloud-download) if the expansion is verified. ## It only shows `%placeholder%` and not the variable -When a plugin or [`/papi parse me %placeholder%`](commands.md#papi-parse) only returns the placeholder itself and no value should you check for the following things: +When a plugin or [`/papi parse me %placeholder%`](users/commands.md#papi-parse) only returns the placeholder itself and no value should you check for the following things: - ### The expansion is actually installed. Some expansions may not be integrated into a plugin or don't even have a plugin to depend on, meaning that they may be their own separate jar file that you have to download. - Such expansions can usually be found on the eCloud of PlaceholderAPI and be downloaded using the [`/papi ecloud download `](commands.md#papi-ecloud-download) command. + Such expansions can usually be found on the eCloud of PlaceholderAPI and be downloaded using the [`/papi ecloud download `](users/commands.md#papi-ecloud-download) command. Whether an expansion is available on the eCloud or not can be found out in the [Placeholder List](users/placeholder-list.md) with any expansion displaying a papi command being downlodable. @@ -34,7 +34,7 @@ When a plugin or [`/papi parse me %placeholder%`](commands.md#papi-parse) only r - ### No typo in the placeholder - Double-check that the placeholder you set doesn't contain a typo. You can use [`/papi ecloud placeholders `](commands.md#papi-ecloud-placeholders) (replace `` with the name of the expansion) to get a list of all the placeholders the expansion may have. + Double-check that the placeholder you set doesn't contain a typo. You can use [`/papi ecloud placeholders `](users/commands.md#papi-ecloud-placeholders) (replace `` with the name of the expansion) to get a list of all the placeholders the expansion may have. Keep in mind that this only works for separate expansions on the eCloud and not for those that are loaded by plugins. Additionally can the placeholder list from the eCloud be outdated. It is recommended to check the [Placeholder List](users/placeholder-list.md) or see if there is any documentation for the placeholders you want to use. @@ -52,7 +52,7 @@ Make the following checks: 3. The expansion is verified. Only verified expansions can be downloaded through PlaceholderAPI's download command. This is a security measure to prevent the spread of malware. If the above checks are all fine and you still can't get the expansion through the download command, consider downloading it manually. -To do that, head to the expansion's page on the ecloud, download the jar file and put it into `/plugins/PlaceholderAPI/expansions/` before using [`/papi reload`](commands.md#papi-reload). +To do that, head to the expansion's page on the ecloud, download the jar file and put it into `/plugins/PlaceholderAPI/expansions/` before using [`/papi reload`](users/commands.md#papi-reload). ## How can other plugins use my placeholders with PlaceholderAPI? diff --git a/docs/index.md b/docs/index.md index ec802b8..f60b622 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,14 +9,6 @@ It also has a community-curated list of all available Placeholder expansions and
-- ### :material-slash-forward: Commands - - ---- - - List of all available commands in PlaceholderAPI. - - - [:octicons-chevron-right-16: Go to Page](commands.md) - - ### :material-account-file-text: User Guides ---- @@ -25,6 +17,7 @@ It also has a community-curated list of all available Placeholder expansions and Available pages: + - [:octicons-chevron-right-16: Commands](users/commands.md) - [:octicons-chevron-right-16: Using Placeholders](users/using-placeholders.md) - [:octicons-chevron-right-16: Placeholder List](users/placeholder-list.md) - [:octicons-chevron-right-16: Plugins using PlaceholderAPI](users/plugins-using-placeholderapi.md) @@ -57,19 +50,4 @@ It also has a community-curated list of all available Placeholder expansions and - [:octicons-chevron-right-16: Go to Page](faq.md) -
- - - - -- [:material-slash-forward: Commands](commands.md) -- :material-account-file-text: User Guides - - [:material-cog: Using Placeholders](users/using-placeholders.md) - - [:material-format-list-bulleted-square: Placeholder List](users/placeholder-list.md) - - [:material-graph: Plugins using PlaceholderAPI](users/plugins-using-placeholderapi.md) -- :material-file-code: Dev Guides - - [:material-cog: Using PlaceholderAPI](developers/using-placeholderapi.md) - - [:material-code-braces: Making a PlaceholderExpansion](developers/creating-a-placeholderexpansion.md) - - [:material-cloud-braces: eCloud](developers/expansion-cloud.md) -- [:material-alert-circle-outline: Common Issues](common-issues.md) -- [:material-chat-question: FAQ](faq.md) \ No newline at end of file + \ No newline at end of file diff --git a/docs/commands.md b/docs/users/commands.md similarity index 100% rename from docs/commands.md rename to docs/users/commands.md diff --git a/docs/users/index.md b/docs/users/index.md index e2bd80a..ac74ee1 100644 --- a/docs/users/index.md +++ b/docs/users/index.md @@ -10,6 +10,14 @@ The pages listed under this section are meant for server owners who want to use
+- ### Commands + + ---- + + List of all available commands in PlaceholderAPI. + + - [:octicons-chevron-right-16: Go to Page](commands.md) + - ### Using Placeholders ---- diff --git a/mkdocs.yml b/mkdocs.yml index 189304f..a55752b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -69,9 +69,9 @@ extra: nav: - index.md - - commands.md - User Guides: - users/index.md + - users/commands.md - users/using-placeholders.md - users/placeholder-list.md - users/plugins-using-placeholderapi.md