Glyph – Macro Errors

The following errors are displayed in the form:

message
  source: macro_source
  path: macro_path

macro_value

Where:

  • message is the error message.
  • macro_source is the file or snippet where the error occurred.
  • macro_path is the full path to the macro that returned the error, within the document syntax tree, e.g. document/body/bodymatter/chapter/section/header/& if the error occurrent in a snippet within the header of a section in the bodymatter part of the document.
  • macro_value is the value of the macro (shown only if Glyph is running in debug mode).
Error Message Description
Macro 'name' takes up to x parameter(s) (y given) Returned if the macro was called with extra parameters.
Macro 'name' takes at least x parameter(s) (y given) Returned if the macro was called with fewer parameters than expected.
Macro 'name' takes exactly x parameter(s) (y given) Returned if the macro was called with a different number of parameters than.
Macro not available when compiling a single file. Returned by the include macro if used in lite mode.
Filter macro 'extension' not available Returned by a filter macro if options.filters_by_file_extension setting is set to @true@, but the extension was not recognized.
Invalid regular expression: regexp Returned by the match macro if an invalid regular expression was supplied.
Macro 'name' takes no parameters (x given) Returned if the macro was called with parameters but none are requested.
No highlighter installed. Please run: gem install coderay Returned by the highlight macro if no highlighters are installed.
CodeRay highlighter not installed. Please run: gem install coderay Returned by the highlight macro if filters.highlighter setting is set to @coderay@ but Coderay is not installed.
UltraViolet highlighter not installed. Please run: gem install ultraviolet Returned by the highlight macro if filters.highlighter setting is set to @ultraviolet@ but Ultraviolet is not installed.
Mutual Inclusion in parameter/attribute(name): 'value' Returned if a catch-22 situation occurs with macro inclusion, for example if the value of a snippet includes a reference to the same snippet.
Snippet 'snippet_id' does not exist Returned by the snippet macro if an invalid snippet ID was supplied.
File 'file_name' not found Returned by the include macro if an invalid file was supplied.
Filter macro 'macro_name' not found Returned by the include macro if the options.filters_by_file_extension setting is set to @true@ but the file extension of the included file is not recognized as a filter macro.
RedCloth gem not installed. Please run: gem install RedCloth Returned by the textile macro if the RedCloth gem is not installed.
No MarkDown converter installed. Please run: gem install bluecloth Returned by the markdown macro if no valid Markdown converter gem is installed. Glyph checks for: BlueCloth, Maruku, Kramdown and RDiscount.
Image/Figure not found Retured by the image macro or the figure macro respectively, if the specified image file could not be found within the images/ folder.
Bookmark 'bookmark_name' already exists Returned by the anchor macro or by the section macro if the anchor ID supplied as attribute has already been used in the document.
Bookmark 'bookmark_name' already exists Returned by the link macro if the anchor ID supplied as parameter has not been used in the document.
Stylesheet 'file_name' not found Returned by the style macro if the .css or .sass file supplied as parameter was not found in the styles/ directory.
Haml is not installed. Please run: gem install haml Returned by the style macro if a .sass file was passed as parameter but the Haml gem is not installed.
Invalid XML element: 'element_name' An invalid XML element name was supplied to the |xml| system macro (see Other HTML Elements).
Invalid XML element: 'element_name' An invalid XML attribute name was supplied to the |xml| system macro (see Other HTML Elements).
Macro 'macro_name' cannot be used in safe mode Returned if a forbidden macro was used in safe mode (see Modes).
Cannot reset 'system.setting_name' setting (system use only). Returned by the config: when attempting to override a setting in the system.* namespace.
Macro 'macro_a' must be within a 'macro_b' macro Returned if a macro was used in the wrong place.
Macro 'macro_a' must not be within a 'macro_b' macro Returned if a macro was used in the wrong place.