help_system

Introduction

With bebot 0.3 the help is moved inside the modules offering the commands, and no longer kept in outside text files.

Adding help

To add help to a module you have to define an array $help inside the class. Best place for the definition is the constructor of the class. The array got 3 fields:

  1. $this → help['description'] = 'Description of the module'; for a description shown in the top of the help window
  2. $this → help['command']['command1']=“What does command1 do without any keywords”;
  3. $this → help['command']['command1 keyword'] = “What does command1 do with keyword”;
  4. $this → help['command']['command2 keyword <param>'] = “What does command2 do with <param>”;
  5. $this → help['notes'] = “Notes for the help goes in here.”; any kind of note related to the commands.
  • help_system.txt
  • Last modified: 2020/09/12 01:30
  • (external edit)