diff --git a/config/vufind/ConsoleMenu.yaml b/config/vufind/ConsoleMenu.yaml index 00fff5a3d1a..8b16df216c6 100644 --- a/config/vufind/ConsoleMenu.yaml +++ b/config/vufind/ConsoleMenu.yaml @@ -1,3 +1,34 @@ +# This configuration file controls the menu displayed by thhe menu/menu console command. +# It must begin with a "main:" container; all of its contents must be either nested submenus +# or commands. +# +# Every section of the configuration MUST have a label and a type. Each supported type has +# different requirements. +# +# type = menu +# Purpose: Display a sub-menu +# Attributes: +# - contents (required): a list of sub-menus and/or commands in the menu +# +# type = external-command +# Purpose: Run a command-line command +# Attributes: +# - command (required): the command to run (relative to VUFIND_HOME) +# - arguments (optional): a list of arguments for the command. Each entry contains: +# - label (required): A description of the argument +# - required (optional): Set to true if the argument is required +# - default (optional): A default value to use +# - options (optional): a list of options for the command. Each entry contains: +# - label (required): A description of the option +# - switch (required): The switch text to add to the command line for the option +# - type (optional, defaults to 'string'): 'string' for arguments that require +# a string value; 'no-value' for arguments that are simple toggle switches. +# - default (optional): A default value to use +# +# type = internal-command +# Purpose: Run an internal Symfony console command +# Attributes: +# - command (required): the name of the command in the plugin manager main: label: Main Menu type: menu @@ -17,4 +48,4 @@ main: type: string - label: Import XML type: internal-command - command: import/import-xsl \ No newline at end of file + command: import/import-xsl