all repos — h3rald @ 6b243ded05a7593922d198634c681075de1c12e2

The sources of https://h3rald.com

contents/glyph/book/troubleshooting/errors_macro.html

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
-----
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>