content/glyph/book/macros/macros_structure.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 |
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <title>Glyph</title> <meta name="author" content="Fabio Cevasco" /> <meta name="copyright" content="Fabio Cevasco" /> <meta name="generator" content="Glyph v0.4.0 (http://www.h3rald.com/glyph)" /> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <title>Structure Macros - Glyph</title> <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, technical writing, html, html5, book" /> <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" /> <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <meta content="44.388041;9.073248" name="ICBM" /> <link href="/css/main.css" media="all" rel="stylesheet" type="text/css" /> <link href="/glyph/book/styles/default.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="wrapper"> <a href="http://github.com/h3rald/h3rald"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub" /></a> <div id="header"> <!--[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]--> <!-- HEADER START --> <div id="header-container"> <div id="header-left"> <h1><span class="logo"></span><a id="logo" href="/" title="H3RALD"></a></h1> </div> <div id="header-right"> <ul id="navigation"> <li><span class="preload nav-archives"></span><a id="nav-archives" href="/archives/" title="ARCHIVES"></a></li> <li><span class="preload nav-projects"></span><a id="nav-projects" href="/projects/" title="PROJECTS"></a></li> <li><span class="preload nav-about"></span><a id="nav-about" href="/about/" title="ABOUT"></a></li> <li><span class="preload nav-other"></span><a id="nav-other" href="/other/" title="OTHER"></a></li> </ul> </div> </div> </div> <!-- HEADER END --> <div class="ribbon"> </div> <!-- MAIN START --> <div id="main"> <!-- CONTAINER START --> <div id="container"> <!-- CONTENT START --> <div id="content" class="clearfixstandard"> <div id="page-links"> <span><script type="text/javascript" src="http://w.sharethis.com/button/sharethis.js#publisher=6e34d60c-b14e-4c19-9b2f-7c35a9f0ab09&type=website&linkfg=%23a4282d"></script></span> </div> <h2>Structure Macros</h2> <hr /> <div id="content-body"> <div class="navigation"><a href="/glyph/book/macros/macros_filters.html">Filter Macros ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/config/document.html">→ document.*</a></div> <div class="section"> <h4 id="m_article">article</h4> <p>Used to create a simple article. By default, it includes the following macros:</p> <ul> <li><code>document</code> <ul> <li><code>head</code> <ul> <li><code>style[default.css]</code></li> </ul></li> <li><code>body</code> <ul> <li><code>halftitlepage</code> <ul> <li><code>title</code></li> <li><code>pubdate</code></li> <li><code>subtitle</code></li> <li><code>author</code></li> </ul></li> </ul></li> </ul></li> </ul> <div class="section"> <h5 id="h_204">Parameters</h5> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th> <th>Description</th> </tr> <tr> <td>0</td> <td>The article contents.</td> </tr> </table> </div> <div class="section"> <h5 id="h_205">Attributes</h5> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th> <th>Description</th> </tr> <tr> <td>pre-title</td> <td>Contents to include before the <a href="/glyph/book/macros/macros_block.html#m_title"><code>title</code></a> macro.</td> </tr> <tr> <td>post-title</td> <td>Contents to include after the <a href="/glyph/book/macros/macros_block.html#m_title"><code>title</code></a> macro.</td> </tr> <tr> <td>head</td> <td>Contents to include instead of the default <code>head</code> macro.</td> </tr> <tr> <td>pubdate</td> <td>Contents to include instead of the default <code>pubdate</code> macro.</td> </tr> <tr> <td>halftitlepage</td> <td>Contents to include instead of the default <code>halftitlepage</code> macro.</td> </tr> </table> </div> </div> <div class="section"> <h4 id="m_book">book</h4> <p>Used to create a book. By default, it includes the following macros:</p> <ul> <li><code>document</code> <ul> <li><code>head</code> <ul> <li><code>style[default.css]</code></li> </ul></li> <li><code>body</code> <ul> <li><code>titlepage</code> <ul> <li><code>title</code></li> <li><code>pubdate</code></li> <li><code>subtitle</code></li> <li><code>revision</code></li> <li><code>author</code></li> </ul></li> </ul></li> </ul></li> </ul> <div class="section"> <h5 id="h_207">Parameters</h5> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th> <th>Description</th> </tr> <tr> <td>0</td> <td>The article contents.</td> </tr> </table> </div> <div class="section"> <h5 id="h_208">Attributes</h5> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th> <th>Description</th> </tr> <tr> <td>pre-title</td> <td>Contents to include before the <a href="/glyph/book/macros/macros_block.html#m_title"><code>title</code></a> macro.</td> </tr> <tr> <td>post-title</td> <td>Contents to include after the <a href="/glyph/book/macros/macros_block.html#m_title"><code>title</code></a> macro.</td> </tr> <tr> <td>head</td> <td>Contents to include instead of the default <code>head</code> macro.</td> </tr> <tr> <td>pubdate</td> <td>Contents to include instead of the default <code>pubdate</code> macro.</td> </tr> <tr> <td>titlepage</td> <td>Contents to include instead of the default <code>titlepage</code> macro.</td> </tr> <tr> <td>frontmatter</td> <td>Contents to include within a <code>frontmatter</code> macro.</td> </tr> <tr> <td>bodymatter</td> <td>Contents to include within a <code>bodymatter</code> macro.</td> </tr> <tr> <td>backmatter</td> <td>Contents to include within a <code>backmatter</code> macro.</td> </tr> </table> </div> </div> <div class="section"> <h4 id="m_document">document</h4> <p>Creates an <code><html></code> tag and a <span class="caps">DOCTYPE</span> declaration. Called internally by the <a href="#m_book"><code>book</code></a> macro and the <a href="#m_article"><code>article</code></a> macro.</p> <div class="section"> <h5 id="h_210">Parameters</h5> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th> <th>Description</th> </tr> <tr> <td>0</td> <td>The document contents.</td> </tr> </table> </div> </div> <div class="section"> <h4 id="m_head">head</h4> <p>Creates a <code><head></code> tag, pre-populated with <code>title</code> and author/copyright <code><meta></code> tags.</p> <div class="section"> <h5 id="h_212">Parameters</h5> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th> <th>Description</th> </tr> <tr> <td>0</td> <td>The head contents.</td> </tr> </table> </div> </div> <div class="section"> <h4 id="m_section">section</h4> <p>Creates a section (<code><div></code> tag).</p> <strong>Aliases:</strong> <code>acknowledgement, addendum, afterword, appendix, bibliography, chapter, colophon, dedication, epilogue, foreword, glossary, imprint, index, inspiration, introduction, lof, lot, part, postscript, preface, prologue, promotion, references, section, section, volume</code> <div class="example"><p> <strong>Example</strong> </p> <pre class="lazy"><span class="line-numbers"> 1 </span> section[ <span class="line-numbers"> 2 </span> @title[Test Section] <span class="line-numbers"> 3 </span> @id[test] <span class="line-numbers"> 4 </span> ... <span class="line-numbers"> 5 </span> ] </pre></div> <div class="section"> <h5 id="h_214">Parameters</h5> <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> </div> <div class="section"> <h5 id="h_215">Attributes</h5> <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> </div> </div> <div class="section"> <h4 id="m_style">style</h4> <p>Embeds the content of a <span class="caps">CSS</span> or Sass file within a <code><style></code> tag (<span class="fmi">for more information on stylesheets, see <a href="/glyph/book/text_editing/stylesheets.html#stylesheets">Adding Stylesheets</a></span>).</p> <p><strong>Example:</strong> <code>style[default.css]</code></p> <div class="section"> <h5 id="h_217">Parameters</h5> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th> <th>Description</th> </tr> <tr> <td>0</td> <td>The stylesheet file to embed.</td> </tr> </table> </div> </div> <div class="section"> <h4 id="m_toc">toc</h4> <p>Generates a <em>Table of Contents</em> based on how sections are nested in the current document.</p> <p><strong>Example:</strong> <code>toc[1]</code></p> <div class="section"> <h5 id="h_219">Parameters</h5> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th> <th>Description</th> </tr> <tr> <td>0</td> <td>The maximum header depth of the TOC <em>(optional)</em>.</td> </tr> </table> </div> </div> <div class="navigation"><a href="/glyph/book/macros/macros_filters.html">Filter Macros ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/config/document.html">→ document.*</a></div> </div> <div id="content-footer"> <div class="share"> <script type="text/javascript"><!-- google_ad_client = "pub-2871497824158668"; /* 728x90, h3rald 8.0 */ google_ad_slot = "0081634732"; google_ad_width = 728; google_ad_height = 90; //--> </script> <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> </script> </div> </div> </div> <!-- CONTENT END --> </div> <!-- CONTAINER END --> </div> <div class="ribbon"></div> <!-- MAIN END --> <div id="border-bottom"> <div id="services"> <div class ="footer-left"> <div id="backtype"> <h3><span class="s-opinions preload"></span><a id="s-opinions" href="http://www.backtype.com/h3rald" title="Opinions"></a></h3> </div> </div> <div class ="footer-center"> <div id="twitter"> <h3><span class="s-tweets preload"></span><a id="s-tweets" href="http://www.twitter.com/h3rald" title="Tweets"></a></h3> </div> </div> <div class ="footer-right"> <div id="delicious"> <h3><span class="s-bookmarks preload"></span><a id="s-bookmarks" href="http://www.delicious.com/h3rald" title="Bookmarks"></a></h3> </div> </div> </div> <!-- SERVICES END --> </div> <div class="clearfooter"></div> </div> <!-- WRAPPER END --> <div id="footer"> <div id="footer-container"> <div class="footer-div"> H3RALD Web Site v8.0.0 <em>"xStatic"</em> — © 2004-2010 <strong>Fabio Cevasco</strong> — <a class="link" href="http://creativecommons.org/licenses/by-nc-nd/3.0/us/">Some rights reserved</a> | <a href="http://validator.w3.org/check?uri=referer" class="link">XHTML 1.1</a> | <a href="http://jigsaw.w3.org/css-validator/validator?uri=/t_52.html" class="link">CSS 2.1</a> </div> </div> <!-- END FOOTER CONTAINER--> </div> <!-- END FOOTER --> <!-- 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 --> <script src='http://www.google-analytics.com/ga.js' type='text/javascript'></script> <script src="http://www.google.com/jsapi?key=ABQIAAAA6h3j8Jri5D_da53UPbEbThRlq2n1sm52B5HDRR5tm6o8XM18FhTKn3v155RpPeD0kWnWG81QEhhifQ" type="text/javascript"></script> <script src="/js/compressed.js" type="text/javascript"></script> </body> </html> |