content/glyph/book/macros/macros_core.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 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Core Macros – Glyph Documentation</title>
<meta charset="utf-8" />
<meta name="author" content="Fabio Cevasco" />
<meta name="copyright" content="Fabio Cevasco" />
<meta name="robots" content="all, follow" />
<meta name="Revisit-After" content="2 Days" />
<meta name="language" content="en" />
<meta name="target_country" content="en-us" />
<meta name="country" content="United States" />
<meta name="description" content="H3RALD - Fabio Cevasco's Web Site" />
<meta name="keywords" content="h3rald, fabio cevasco, glyph" />
<link rel="shortcut icon" href="/favicon.png" type="image/png" />
<meta content="44.388041;9.073248" name="ICBM" />
<link rel="stylesheet" type="text/css" href="/styles/html5reset.css" />
<link rel="stylesheet" type="text/css" href="/styles/style.css" />
<!--[if lte IE 8]>
<script src="/js/html5.js" type="text/javascript"></script>
<![endif]-->
</head>
<body>
<!--[if lte IE 6]>
<div id="ie-warning">
This site is not compatible with Internet Explorer 6 or lower. You should consider using a more modern browser for a better – and <em>safer</em> – web experience. [<a href="http://browsehappy.com/browsers/">Read More »</a>]
</div>
<![endif]-->
<section id="container">
<header class="page">
<nav class="home-link">
<a href="/">
<img src="/images/h3rald_small.png" alt="H3RALD" class="default"/>
<![if !IE]>
<img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/>
<![endif]>
</a>
</nav>
<nav class="section">
/<a href="/glyph/" rel="archives">GLYPH</a>
</nav>
</header>
<article class="page">
<header>
<hgroup>
<h1>Core Macros</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><a href="/glyph/book/ref_commands.html">Command Reference ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/macros/macros_block.html">→ Block Macros</a></nav>
<section class="section">
<header><h1 id="m_alias">alias</h1></header>
<p>Creates a macro alias.</p>
<p><strong>Example:</strong> <code>alias[s|section]</code></p>
<section class="section">
<header><h1 id="h_125">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The name of the alias.</td>
</tr>
<tr>
<td>1</td>
<td>The name of an existing macro.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_and">and</h1></header>
<p>Conditional <code>and</code> operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p>
<p><strong>Example:</strong> <code>?[and[true|false]|This is never displayed.]</code></p>
<section class="section">
<header><h1 id="h_127">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The first expression to test</td>
</tr>
<tr>
<td>1</td>
<td>The second expression to test</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_comment">comment</h1></header>
<p>Evaluates to nothing. Used to add comments in a Glyph document that will not be displayed in output files.</p>
<strong>Aliases:</strong> <code>--</code>
<p><strong>Example:</strong> <code>--[=>[#link|This link will not be evaluated]]</code></p>
<section class="section">
<header><h1 id="h_129">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The contents to comment out</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_130">Remarks</h1></header>
<p>Macros are not expanded within comments.</p>
</section>
</section>
<section class="section">
<header><h1 id="m_condition">condition</h1></header>
<p>Tests a conditional expression. For more information, see <a href="/glyph/book/text_editing/conditionals.html#cond_macros">Conditional Macros</a>.</p>
<strong>Aliases:</strong> <code>?</code>
<section class="section">
<header><h1 id="h_132">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The condition to test</td>
</tr>
<tr>
<td>1</td>
<td>The contents to expand if the condition is satisfied.</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_133">Remarks</h1></header>
<p>For examples see any of the following:</p>
<ul>
<li><a href="#m_and"><code>and</code></a> macro</li>
<li><a href="#m_or"><code>or</code></a> macro</li>
<li><a href="#m_not"><code>not</code></a> macro</li>
<li><a href="#m_match"><code>match</code></a> macro</li>
<li><a href="#m_eq"><code>eq</code></a> macro</li>
</ul>
</section>
</section>
<section class="section">
<header><h1 id="m_config">config</h1></header>
<p>Returns the value of a configuration setting.</p>
<strong>Aliases:</strong> <code>$</code>
<p><strong>Example:</strong> <code>$[document.author]</code></p>
<section class="section">
<header><h1 id="h_135">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The full name of a configuration setting.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_config_">config:</h1></header>
<p>Sets the value of a configuration setting.</p>
<strong>Aliases:</strong> <code>$:</code>
<p><strong>Example:</strong> <code>$:[document.draft|true]</code></p>
<section class="section">
<header><h1 id="h_137">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The full name of a configuration setting.</td>
</tr>
<tr>
<td>1</td>
<td>The new value of the configuration setting</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_138">Remarks</h1></header>
<p>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</p>
</section>
</section>
<section class="section">
<header><h1 id="m_eq">eq</h1></header>
<p>Conditional equality operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p>
<p><strong>Example:</strong> <code>?[eq[$[document.draft]|true]|This is displayed only in draft documents.]</code></p>
<section class="section">
<header><h1 id="h_140">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The first expression to test</td>
</tr>
<tr>
<td>1</td>
<td>The second expression to test</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_escape">escape</h1></header>
<p>Evaluates to its value. Commonly used with the escaping delimiters <code>[=</code> and <code>=]</code>.</p>
<strong>Aliases:</strong> <code>.</code>
<p><strong>Example:</strong> <code>.[=Macros are escaped here =>[#test].=]</code></p>
<section class="section">
<header><h1 id="h_142">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The contents to escape.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_include">include</h1></header>
<p>Evaluates to the contents of a text file stored in the <code>text/</code> directory referenced by its relative path. 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 <code>true</code>, filters the contents of the file using the <a href="/glyph/book/macros/macros_filters.html#f_macros">filter macro</a> corresponding to the file extension.</p>
<strong>Aliases:</strong> <code>@</code>
<p><strong>Example:</strong> <code>include[frontmatter/introduction]</code></p>
<section class="section">
<header><h1 id="h_144">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The file to include.</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_145">Remarks</h1></header>
<ul><li>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</li>
<li><code>.glyph</code> is assumed if no file extension is specified.</li>
<li>This macro can also be used to include <code>.rb</code> ruby files within the <code>lib</code> directory. File contents are evaluated in the context of the <a href="http://yardoc.org/docs/h3rald-glyph/Glyph">Glyph</a> module.</li></ul>
</section>
</section>
<section class="section">
<header><h1 id="m_match">match</h1></header>
<p>Checks a string against a regular expression.</p>
<p><strong>Example:</strong> <code>?[match[Hello!|/^hell/i]|This is always displayed]</code></p>
<section class="section">
<header><h1 id="h_147">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The string to check.</td>
</tr>
<tr>
<td>1</td>
<td>The regular expression to match against the string.</td>
</tr>
<tr>
<td>2</td>
<td>The contents to expand if the string matches.</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_148">Remarks</h1></header>
<p>This macro must be used with the <a href="#m_condition"><code>condition</code></a> macro.</p>
</section>
</section>
<section class="section">
<header><h1 id="m_macro_">macro:</h1></header>
<p>Defines a macro.</p>
<strong>Aliases:</strong> <code>%:</code>
<p><strong>Example:</strong> <code>%:[test|"<em>test: #{value}</em>"]</code></p>
<section class="section">
<header><h1 id="h_150">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The name of the new macro.</td>
</tr>
<tr>
<td>1</td>
<td>The macro definition (Ruby code).</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_151">Remarks</h1></header>
<ul><li>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</li>
<li>The new macro can only be used <em>after</em> its declaration.</li></ul>
</section>
</section>
<section class="section">
<header><h1 id="m_not">not</h1></header>
<p>Conditional <code>not</code> operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p>
<p><strong>Example:</strong> <code>?[not[false]|This is always displayed.]</code></p>
<section class="section">
<header><h1 id="h_153">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The expression to negate</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_output_">output?</h1></header>
<p>Evaluates to true if Glyph is generating output in the specified format(s).</p>
<p><strong>Example:</strong> <code>?[output?[web|web5]|This text is printed only when generating web or web5 output.]</code></p>
<section class="section">
<header><h1 id="h_155">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0, ...</td>
<td>a valid output target.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_or">or</h1></header>
<p>Conditional <code>or</code> operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p>
<p><strong>Example:</strong> <code>?[or[true|false]|This is always displayed.]</code></p>
<section class="section">
<header><h1 id="h_157">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The first expression to test</td>
</tr>
<tr>
<td>1</td>
<td>The second expression to test</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_rewrite_">rewrite:</h1></header>
<p>Defines a new macro by rewriting (for more information, see <a href="/glyph/book/extending/interpreting.html#rewriting">Rewriting</a>)</p>
<strong>Aliases:</strong> <code>rw:</code>
<div class="example"><p>
<strong>Example</strong>
</p>
<div class="CodeRay">
<div class="code"><pre><span class="no">1</span> rw:[release|
<span class="no">2</span> section[
<span class="no">3</span> @title[Release {{0}}]
<span class="no">4</span> {{1}}
<span class="no">5</span> ]
<span class="no">6</span> ]</pre></div>
</div></div>
<section class="section">
<header><h1 id="h_159">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The name of the new macro.</td>
</tr>
<tr>
<td>0</td>
<td>The macro definition (Glyph code).</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_160">Remarks</h1></header>
<ul><li>The new macro can only be used <em>after</em> its declaration.</li>
<li>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</li></ul>
</section>
</section>
<section class="section">
<header><h1 id="m_ruby">ruby</h1></header>
<p>Evaluates its value as Ruby code within the context of the <a href="http://yardoc.org/docs/h3rald-glyph/Glyph">Glyph</a> module.</p>
<strong>Aliases:</strong> <code>%</code>
<div class="examples">
<p><strong>Examples:</strong></p>
<code>%[Time.now]</code><br /><code>%[Glyph::VERSION]</code><br />
</div>
<section class="section">
<header><h1 id="h_162">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The Ruby code to evaluate.</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_163">Remarks</h1></header>
<p>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</p>
</section>
</section>
<section class="section">
<header><h1 id="m_snippet">snippet</h1></header>
<p>Returns the value of a snippet.</p>
<strong>Aliases:</strong> <code>&</code>
<p><strong>Example:</strong> <code>&[glang]</code></p>
<section class="section">
<header><h1 id="h_165">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The ID of the snippet to retrieve.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_snippet_">snippet:</h1></header>
<p>Defines a snippet.</p>
<strong>Aliases:</strong> <code>&:</code>
<p><strong>Example:</strong> <code>&:[test|This is a test]</code></p>
<section class="section">
<header><h1 id="h_167">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The ID of the new snippet.</td>
</tr>
<tr>
<td>1</td>
<td>The contents of the new snippet.</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_168">Remarks</h1></header>
<p>The new snippet can only be used <em>after</em> its declaration.</p>
</section>
</section>
<nav><a href="/glyph/book/ref_commands.html">Command Reference ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/macros/macros_block.html">→ Block Macros</a></nav>
</section>
</article>
<footer>
<section class="ads">
<script type="text/javascript"><!--
google_ad_client = "pub-2871497824158668";
/* 728x90, created 9/10/10 */
google_ad_slot = "3963343166";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</section>
<section>
<nav>
<a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a>
</nav>
<p>H3RALD Web Site v8.1 — © 2010 — <em>Fabio Cevasco</em></p>
</section>
</footer>
</section><!-- #container end -->
<script src="http://www.google.com/jsapi?key=ABQIAAAAr6RY1Z6dchG_sX9WDLSy3xRlq2n1sm52B5HDRR5tm6o8XM18FhR56xHNNH6CsX86uN5VoTrglpyOyQ" type="text/javascript"></script>
<!-- <script src="/js/jquery.js" type="text/javascript"></script> -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
<script src="/js/jquery-timeago.js" type="text/javascript"></script>
<script src="/js/jquery-easing.js" type="text/javascript"></script>
<script src="/js/jquery-fancybox.js" type="text/javascript"></script>
<script src="/js/jquery-toc.js" type="text/javascript"></script>
<script src="/js/date.js" type="text/javascript"></script>
<script src="/js/feeds.js" type="text/javascript"></script>
<script src="/js/search.js" type="text/javascript"></script>
<script src="/js/hyphenator.js" type="text/javascript"></script>
<script src="/js/init.js" type="text/javascript"></script>
<!-- Start Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18587377-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<!-- End Google Analytics -->
<!-- Start of StatCounter Code -->
<script type="text/javascript">
var sc_project=6193656;
var sc_invisible=1;
var sc_security="57f7ee2a";
</script>
<script type="text/javascript" src="http://www.statcounter.com/counter/counter_xhtml.js"></script>
<!-- End of StatCounter Code -->
</body>
</html>
|