content/glyph/book/macros/macros_filters.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 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Filter 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>Filter Macros</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><a href="/glyph/book/macros/macros_inline.html">Inline Macros ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/macros/macros_structure.html">→ Structure Macros</a></nav>
<section class="section">
<header><h1 id="m_markdown">markdown</h1></header>
<p>Uses a Markdown converter (BlueCloth, RDiscount, Maruku or Kramdown) to transform the value into <span class="caps">HTML</span> if the <a href="/glyph/book/config/output.html#cfg_output"><code>output.*.filter_target</code></a> setting is set to <code>html</code>.</p>
<p>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>, this macro is called automatically on <a href="/glyph/book/macros/macros_core.html#m_include">included</a> files with a <code>.markdown</code> or a <code>.md</code> extension.</p>
<strong>Aliases:</strong> <code>md</code>
<p><strong>Example:</strong> <code>markdown[This is *emphasized* text.]</code></p>
<section class="section">
<header><h1 id="h_201">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The Markdown text to filter.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_markdown_section">markdown_section</h1></header>
<p>Creates a section (see <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macro) whose content can be formatted with markdown markup.</p>
<strong>Aliases:</strong> <code>§md, md_section</code>
<div class="example"><p>
<strong>Example</strong>
</p>
<div class="CodeRay">
<div class="code"><pre><span class="no">1</span> markdown_section[
<span class="no">2</span> @title[Test Section]
<span class="no">3</span> @id[test]
<span class="no">4</span> Some *markdown* text.
<span class="no">5</span> ]</pre></div>
</div></div>
<section class="section">
<header><h1 id="h_203">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 section</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_204">Attributes</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Attribute</th>
<th>Description</th>
</tr>
<tr>
<td>title</td>
<td>The title of the section <em>(optional)</em></td>
</tr>
<tr>
<td>id</td>
<td>The ID of the section <em>(optional)</em></td>
</tr>
<tr>
<td>notoc</td>
<td>If not blank, the header will not appear in the Table of Contents. <em>(optional)</em></td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_textile">textile</h1></header>
<p>Uses the RedCloth gem to transform the value into <span class="caps">HTML</span> or LaTeX, depending on the value of the <a href="/glyph/book/config/output.html#cfg_output"><code>output.*.filter_target</code></a>.</p>
<p>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>, this macro is called automatically on <a href="/glyph/book/macros/macros_core.html#m_include">included</a> files with a <code>.textile</code> or a <code>.txt</code> extension.</p>
<strong>Aliases:</strong> <code>txt</code>
<p><strong>Example:</strong> <code>textile[This is a *strong emphasis*.]</code></p>
<section class="section">
<header><h1 id="h_206">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>The Textile text to filter.</td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_textile_section">textile_section</h1></header>
<p>Creates a section (see <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macro) whose content can be formatted with textile markup.</p>
<strong>Aliases:</strong> <code>§txt, txt_section</code>
<div class="example"><p>
<strong>Example</strong>
</p>
<div class="CodeRay">
<div class="code"><pre><span class="no">1</span> textile_section[
<span class="no">2</span> @title[Test Section]
<span class="no">3</span> @id[test]
<span class="no">4</span> Some *textile* text.
<span class="no">5</span> ]</pre></div>
</div></div>
<section class="section">
<header><h1 id="h_208">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 section</td>
</tr>
</table>
</section>
<section class="section">
<header><h1 id="h_209">Attributes</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Attribute</th>
<th>Description</th>
</tr>
<tr>
<td>title</td>
<td>The title of the section <em>(optional)</em></td>
</tr>
<tr>
<td>id</td>
<td>The ID of the section <em>(optional)</em></td>
</tr>
<tr>
<td>notoc</td>
<td>If not blank, the header will not appear in the Table of Contents. <em>(optional)</em></td>
</tr>
</table>
</section>
</section>
<section class="section">
<header><h1 id="m_highlight">highlight</h1></header>
<p>Highlights a piece of source code according to the specified language. <span class="fmi">for more information on <mark>code highligting</mark>, see <a href="/glyph/book/text_editing/code.html#source_code">Source Code</a></span>.</p>
<div class="example"><p>
<strong>Example</strong>
</p>
<div class="CodeRay">
<div class="code"><pre><span class="no">1</span> highlight[ruby|
<span class="no">2</span> def hello
<span class="no">3</span> puts "Hello World"
<span class="no">4</span> end
<span class="no">5</span> ]</pre></div>
</div></div>
<section class="section">
<header><h1 id="h_211">Parameters</h1></header>
<table style="width:100%;">
<tr>
<th style="width:30%">Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>0</td>
<td>A programming language supported by the underlying highlighter.</td>
</tr>
<tr>
<td>1</td>
<td>The code to highlight.</td>
</tr>
</table>
</section>
</section>
<nav><a href="/glyph/book/macros/macros_inline.html">Inline Macros ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/macros/macros_structure.html">→ Structure 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>
|