-----
title: "Glyph - Macro Errors"
content-type: page
-----
<nav class="navigation"><a href="/glyph/book/troubleshooting/errors_command.html">← Command Errors</a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/ref_commands.html">Command Reference →</a>
</nav>
<p>The following errors are displayed in the form:</p>
<p><em>message</em><br />
	&nbsp; source: <em>macro_source</em><br />
	&nbsp; path: <em>macro_path</em></p>
<p><em>macro_value</em></p>
<p>Where:</p>
<ul>
	<li><em>message</em> is the error message.</li>
	<li><em>macro_source</em> is the file or snippet where the error occurred.</li>
	<li><em>macro_path</em> is the full path to the macro that returned the error, within the document syntax tree, e.g.
		<code>document/body/bodymatter/chapter/section/header/&amp;</code> if the error occurrent in a snippet within
		the header of a section in the <code>bodymatter</code> part of the document.
	</li>
	<li><em>macro_value</em> is the value of the macro (shown only if Glyph is running in <a
			href="/glyph/book/ref_commands.html#debug_switch">debug mode</a>).</li>
</ul>

<table style="width:100%;">
	<tr>
		<th style="width:30%">Error Message</th>
		<th>Description</th>
	</tr>
	<tr>
		<td>Macro '<em>name</em>' takes up to <em>x</em> parameter(s) (<em>y</em> given)</td>
		<td>Returned if the macro was called with extra parameters.</td>
	</tr>


	<tr>
		<td>Macro '<em>name</em>' takes at least <em>x</em> parameter(s) (<em>y</em> given)</td>
		<td>Returned if the macro was called with fewer parameters than expected.</td>
	</tr>


	<tr>
		<td>Macro '<em>name</em>' takes exactly <em>x</em> parameter(s) (<em>y</em> given)</td>
		<td>Returned if the macro was called with a different number of parameters than.</td>
	</tr>


	<tr>
		<td>Macro not available when compiling a single file.</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro if
			used in <a href="/glyph/book/compiling/lite_mode.html#lite_mode">lite mode</a>.</td>
	</tr>


	<tr>
		<td>Filter macro '<em>extension</em>' not available</td>
		<td>Returned by a filter macro if <a
				href="/glyph/book/config/options.html#s_options_filters_by_file_extension"><code>options.filters_by_file_extension</code></a>
			setting is set to @true@, but the extension was not recognized.</td>
	</tr>


	<tr>
		<td>Invalid regular expression: <em>regexp</em></td>
		<td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_match"><code>match</code></a> macro if an
			invalid regular expression was supplied.</td>
	</tr>


	<tr>
		<td>Macro '<em>name</em>' takes no parameters (<em>x</em> given)</td>
		<td>Returned if the macro was called with parameters but none are requested.</td>
	</tr>


	<tr>
		<td>No highlighter installed. Please run: gem install coderay</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_filters.html#m_highlight"><code>highlight</code></a>
			macro if no highlighters are installed.</td>
	</tr>


	<tr>
		<td>CodeRay highlighter not installed. Please run: gem install coderay</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_filters.html#m_highlight"><code>highlight</code></a>
			macro if <a
				href="/glyph/book/config/filters.html#s_filters_highlighter"><code>filters.highlighter</code></a>
			setting is set to @coderay@ but <a href="http://coderay.rubychan.de/">Coderay</a> is not installed.</td>
	</tr>


	<tr>
		<td>UltraViolet highlighter not installed. Please run: gem install ultraviolet</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_filters.html#m_highlight"><code>highlight</code></a>
			macro if <a
				href="/glyph/book/config/filters.html#s_filters_highlighter"><code>filters.highlighter</code></a>
			setting is set to @ultraviolet@ but <a href="http://ultraviolet.rubyforge.org/">Ultraviolet</a> is not
			installed.</td>
	</tr>


	<tr>
		<td>Mutual Inclusion in parameter/attribute(<em>name</em>): '<em>value</em>'</td>
		<td>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.</td>
	</tr>


	<tr>
		<td>Snippet '<em>snippet_id</em>' does not exist</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_snippet"><code>snippet</code></a> macro if an
			invalid snippet ID was supplied.</td>
	</tr>


	<tr>
		<td>File '<em>file_name</em>' not found</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro if an
			invalid file was supplied.</td>
	</tr>


	<tr>
		<td>Filter macro '<em>macro_name</em>' not found</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro if
			the <a
				href="/glyph/book/config/options.html#s_options_filters_by_file_extension"><code>options.filters_by_file_extension</code></a>
			setting is set to @true@ but the file extension of the included file is not recognized as a filter macro.
		</td>
	</tr>


	<tr>
		<td>RedCloth gem not installed. Please run: gem install RedCloth</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_filters.html#m_textile"><code>textile</code></a> macro if
			the RedCloth gem is not installed.</td>
	</tr>


	<tr>
		<td>No MarkDown converter installed. Please run: gem install bluecloth</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_filters.html#m_markdown"><code>markdown</code></a> macro
			if no valid Markdown converter gem is installed. Glyph checks for: BlueCloth, Maruku, Kramdown and
			RDiscount.</td>
	</tr>


	<tr>
		<td>Image/Figure not found</td>
		<td>Retured by the <a href="/glyph/book/macros/macros_block.html#m_image"><code>image</code></a> macro or the <a
				href="/glyph/book/macros/macros_block.html#m_figure"><code>figure</code></a> macro respectively, if the
			specified image file could not be found within the <code>images/</code> folder.</td>
	</tr>


	<tr>
		<td>Bookmark '<em>bookmark_name</em>' already exists</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_inline.html#m_anchor"><code>anchor</code></a> macro or by
			the <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macro if the
			anchor ID supplied as attribute has already been used in the document.</td>
	</tr>


	<tr>
		<td>Bookmark '<em>bookmark_name</em>' already exists</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_inline.html#m_link"><code>link</code></a> macro if the
			anchor ID supplied as parameter has not been used in the document.</td>
	</tr>


	<tr>
		<td>Stylesheet '<em>file_name</em>' not found</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_structure.html#m_style"><code>style</code></a> macro if
			the <code>.css</code> or <code>.sass</code> file supplied as parameter was not found in the
			<code>styles/</code> directory.
		</td>
	</tr>


	<tr>
		<td>Haml is not installed. Please run: gem install haml</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_structure.html#m_style"><code>style</code></a> macro if a
			<code>.sass</code> file was passed as parameter but the Haml gem is not installed.
		</td>
	</tr>


	<tr>
		<td>Invalid XML element: '<em>element_name</em>'</td>
		<td>An invalid XML element name was supplied to the <code>|xml|</code> system macro (see <a
				href="/glyph/book/config/document.html#other_elements">Other HTML Elements</a>).</td>
	</tr>


	<tr>
		<td>Invalid XML element: '<em>element_name</em>'</td>
		<td>An invalid XML attribute name was supplied to the <code>|xml|</code> system macro (see <a
				href="/glyph/book/config/document.html#other_elements">Other HTML Elements</a>).</td>
	</tr>


	<tr>
		<td>Macro '<em>macro_name</em>' cannot be used in safe mode</td>
		<td>Returned if a forbidden macro was used in safe mode (see <a
				href="/glyph/book/compiling/programmatic_usage.html#modes">Modes</a>).</td>
	</tr>


	<tr>
		<td>Cannot reset 'system.<em>setting_name</em>' setting (system use only).</td>
		<td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_config_"><code>config:</code></a> when
			attempting to override a setting in the <code>system.*</code> namespace.</td>
	</tr>


	<tr>
		<td>Macro '<em>macro_a</em>' must be within a '<em>macro_b</em>' macro</td>
		<td>Returned if a macro was used in the wrong place.</td>
	</tr>


	<tr>
		<td>Macro '<em>macro_a</em>' must not be within a '<em>macro_b</em>' macro</td>
		<td>Returned if a macro was used in the wrong place.</td>
	</tr>
</table>

<nav class="navigation"><a href="/glyph/book/troubleshooting/errors_command.html">← Command Errors</a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/ref_commands.html">Command Reference →</a>
</nav>