content/glyph/book/macros/macros_inline.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 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Inline Macros - Glyph</title>
<link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'>
<meta charset="utf-8" />
<meta name="author" content="Fabio Cevasco" />
<meta name="robots" content="all, follow" />
<meta name="Revisit-After" content="2 Days" />
<meta name="description" content="H3RALD - Fabio Cevasco's Web Site" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="keywords" content="h3rald, fabio cevasco, glyph, ruby, opensource" />
<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/style.css" /> -->
<!--[if lt IE 9]>
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/styles/bootstrap.css" />
<link rel="stylesheet" type="text/css" href="/styles/style.css" />
<script src="http://www.google.com/jsapi?key=ABQIAAAAr6RY1Z6dchG_sX9WDLSy3xRlq2n1sm52B5HDRR5tm6o8XM18FhR56xHNNH6CsX86uN5VoTrglpyOyQ" type="text/javascript"></script>
<script src="/js/sevenup.js" type="text/javascript"></script>
<script src="/js/sevenup_black.js" type="text/javascript"></script>
<script src="http://code.jquery.com/jquery-latest.js" type="text/javascript"></script>
<script src="/js/jquery-timeago.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/hyphenator.js" type="text/javascript"></script>
<script src="/js/init.js" type="text/javascript"></script>
<script src="/js/search.js" type="text/javascript"></script>
<script src="/js/bootstrap.js" type="text/javascript"></script>
</head>
<body>
<div class="container">
<div class="row" id="header-row">
<div class="span6 main-title">
<h1>
<a href="/"><img src="/img/h3rald.png" alt="H3RALD" /></a>
</h1>
</div>
<div class="span4 offset2">
<div class="gcse-searchbox" data-enableAutoComplete="true"></div>
</div>
</div>
<div id="search_results">
<div class="gcse-searchresults" data-linkTarget="_top"></div>
</div>
<div id=main-navbar class="navbar navbar-inverse">
<div class="navbar-inner">
<button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div class="nav-collapse collapse">
<ul class="nav">
<li><a href="/">HOME</a></li>
<li><a href="/projects/">PROJECTS</a></li>
<li><a href="/tags/">TAGS</a></li>
<li><a href="/archives/">ARCHIVES</a></li>
<li><a href="/about/">ABOUT</a></li>
<li><a href="/contact/">CONTACT</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<article class="page">
<header class="row">
<hgroup class="span9">
<h1>Inline Macros</h1>
<h2>Glyph</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate">
<nav class="navigation"><a href="/glyph/book/macros/macros_block.html">← Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros →</a></nav>
<section class="section">
<header><h1 id="m_anchor" class="toc"><code>anchor</code></h1></header>
<p>Creates a named anchor (or bookmark).</p>
<strong>Aliases:</strong> <code>bookmark, #</code>
<p><strong>Example:</strong> <code>#[test|Test Bookmark]</code></p>
<section class="section">
<header><h1 id="h_242" class="notoc">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The identifier of the bookmark</td>
</tr>
<tr>
<td>1</td>
<td>The contents of the bookmark <em>(optional)</em></td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_draftcomment" class="toc"><code>draftcomment</code></h1></header>
<p>If the <a href="/glyph/book/config/document.html#s_document_draft"><code>document.draft</code></a> setting is set to <code>true</code>, displays a draft comment within the document.</p>
<strong>Aliases:</strong> <code>dc</code>
<p><strong>Example:</strong> <code>dc[This is printed only in draft documents.]</code></p>
<section class="section">
<header><h1 id="h_244" class="notoc">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The text of the comment.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_fmi" class="toc"><code>fmi</code></h1></header>
<p>Creates a <em>For More Information</em> link (for an example usage, see the <a href="#m_link"><code>link</code></a> macro).</p>
<p><strong>Example:</strong> <code>fmi[creating links|#links]</code></p>
<section class="section">
<header><h1 id="h_246" class="notoc">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The object that needs additional explanation.</td>
</tr>
<tr>
<td>1</td>
<td>A valid bookmark within the document.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_link" class="toc"><code>link</code></h1></header>
<p>Creates an hyperlink (<span class="fmi">for more information on <mark>creating links</mark>, see <a href="/glyph/book/text_editing/links.html#links">Links and Bookmarks</a></span>).</p>
<strong>Aliases:</strong> <code>=></code>
<p><strong>Example:</strong> <code>=>[http://www.h3rald.com|H3RALD.com]</code></p>
<section class="section">
<header><h1 id="h_248" class="notoc">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 bookmark within the document or an URL.</td>
</tr>
<tr>
<td>1</td>
<td>The text of the link <em>(optional)</em>.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_todo" class="toc"><code>todo</code></h1></header>
<p>Saves the value as a <span class="caps">TODO</span> item, which can be printed using the <a href="/glyph/book/ref_commands.html#c_todo"><code>todo</code></a> command and included in the document if the <a href="/glyph/book/config/document.html#s_document_draft"><code>document.draft</code></a> setting is set to <code>true</code>.</p>
<strong>Aliases:</strong> <code>!</code>
<p><strong>Example:</strong> <code>todo[Remember to do this.]</code></p>
</section>
<nav class="navigation"><a href="/glyph/book/macros/macros_block.html">← Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros →</a></nav>
</section>
</article>
</div>
<footer>
<section>
<p>H3RALD Web Site v8.3 © 2004 — 2013 <em>Fabio Cevasco</em></p>
</section>
</footer>
<!-- 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>
|