From 0a925ff067c6230554c4336627f621decfcd1e79 Mon Sep 17 00:00:00 2001 From: rmichela Date: Thu, 22 Mar 2012 00:21:18 -0400 Subject: [Bleeding] Added support for custom index help topics in help.yml. Addresses BUKKIT-1263 --- src/main/resources/configurations/help.yml | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'src/main/resources/configurations/help.yml') diff --git a/src/main/resources/configurations/help.yml b/src/main/resources/configurations/help.yml index faa7d569..15c3d070 100644 --- a/src/main/resources/configurations/help.yml +++ b/src/main/resources/configurations/help.yml @@ -5,19 +5,21 @@ # your server or override the help pages of existing plugin commands. # # This file is divided up into the following parts: -# -- general-topics: lists admin defined topics +# -- general-topics: lists admin defined help topics +# -- index-topics: lists admin defined index topics # -- amend-topics: lists topic amendments to apply to existing help topics # -- ignore-plugins: lists any plugins that should be excluded from help # # Examples are given below. When amending command topic, the string will be replaced with the existing value # in the help topic. Color codes can be used in topic text. The color code character is & followed by 0-F. +# ================================================================ # # Set this to true to list the individual command help topics in the master help. # command-topics-in-master-index: true # # Each general topic will show up as a separate topic in the help index along with all the plugin command topics. # general-topics: -# rules: +# Rules: # shortText: Rules of the server # fullText: | # &61. Be kind to your fellow players. @@ -25,6 +27,18 @@ # &D3. No swearing. # permission: topics.rules # +# Each index topic will show up as a separate sub-index in the help index along with all the plugin command topics. +# To override the default help index (displayed when the user executes /help), name the index topic "Default". +# index-topics: +# Ban Commands: +# shortText: Player banning commands +# preamble: Moderator - do not abuse these commands +# permission: op +# commands: +# - /ban +# - /ban-ip +# - /banlist +# # Topic amendments are used to change the content of automatically generated plugin command topics. # amended-topics: # /stop: -- cgit v1.2.3