1# This is the help configuration file for Bukkit.
 2# 
 3# By default you do not need to modify this file. Help topics for all plugin commands are automatically provided by
 4# or extracted from your installed plugins. You only need to modify this file if you wish to add new help pages to
 5# your server or override the help pages of existing plugin commands.
 6# 
 7# This file is divided up into the following parts:
 8# -- general-topics: lists admin defined help topics
 9# -- index-topics:   lists admin defined index topics
10# -- amend-topics:   lists topic amendments to apply to existing help topics
11# -- ignore-plugins: lists any plugins that should be excluded from help
12# 
13# Examples are given below. When amending command topic, the string <text> will be replaced with the existing value
14# in the help topic. Color codes can be used in topic text. The color code character is & followed by 0-F.
15# ================================================================
16# 
17# Set this to true to list the individual command help topics in the master help.
18# command-topics-in-master-index: true
19# 
20# Each general topic will show up as a separate topic in the help index along with all the plugin command topics.
21# general-topics:
22#     Rules:
23#         shortText: Rules of the server
24#         fullText: |
25#             &61. Be kind to your fellow players.
26#             &B2. No griefing.
27#             &D3. No swearing.
28#         permission: topics.rules
29# 
30# Each index topic will show up as a separate sub-index in the help index along with all the plugin command topics.
31# To override the default help index (displayed when the user executes /help), name the index topic "Default".
32# index-topics:
33#     Ban Commands:
34#         shortText: Player banning commands
35#         preamble: Moderator - do not abuse these commands
36#         permission: op
37#         commands:
38#             - /ban
39#             - /ban-ip
40#             - /banlist
41# 
42# Topic amendments are used to change the content of automatically generated plugin command topics.
43# amended-topics:
44#     /stop:
45#         shortText: Stops the server cold....in its tracks!
46#         fullText: <text> - This kills the server.
47#         permission: you.dont.have
48# 
49# Any plugin in the ignored plugins list will be excluded from help. The name must match the name displayed by
50# the /plugins command. Ignore "Bukkit" to remove the standard bukkit commands from the index. Ignore "All"
51# to completely disable automatic help topic generation.
52# ignore-plugins:
53#    - PluginNameOne
54#    - PluginNameTwo
55#    - PluginNameThree
56