content/glyph/book/extending/layouts.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 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Layouts – 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>Layouts</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/extending/further_reading.html">→ Further Reading</a></nav>
<p>When generating <a href="/glyph/book/text_editing/topics.html#topics">topic</a>-based outputs, Glyph uses <em>layouts</em> to render topics as standalone documents. By default, the following two layout are used:</p>
<ul>
<li><code>topic</code> — used to render standard topics.</li>
<li><code>index</code> — used to render the index page of your document.</li>
</ul>
<p>Layouts are nothing more than “fancy” Glyph macros defined using the Glyph language (i.e. by using <a href="/glyph/book/extending/interpreting.html#rewriting">macro rewriting</a>) within a single <code>.glyph</code> file.</p>
<section class="section">
<header><h1 id="h_84">Topic Layout</h1></header>
<p>The default layout used to render all web topics (the layout used for web5 topics is very similar) is defined as follows:</p>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> document[
<span class="no"> 2</span> head[
<span class="no"> 3</span> style[default.css]
<span class="no"> 4</span> ]
<span class="no"> 5</span> body[
<span class="no"> 6</span> @class[topic]
<span class="no"> 7</span> section[
<span class="no"> 8</span> @title[{{title}}]
<span class="no"> 9</span> @id[{{id}}]
<span class="no"><strong>10</strong></span> navigation[{{id}}]
<span class="no">11</span> {{contents}}
<span class="no">12</span> navigation[{{id}}]
<span class="no">13</span> ]
<span class="no">14</span> ]
<span class="no">15</span> ]</pre></div>
</div>
<p>Note that it takes the following attributes, passed automatically by Glyph when processing each topic:</p>
<ul>
<li><code>title</code> — the title of the topic.</li>
<li><code>id</code> — the ID of the topic.</li>
<li><code>contents</code> — the body of the topic.</li>
</ul>
</section>
<section class="section">
<header><h1 id="index_layout">Index Layout</h1></header>
<p>The default layout used to render the web index page (the layout used for the web5 index is very similar) is defined as follows:</p>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> document[
<span class="no"> 2</span> head[
<span class="no"> 3</span> style[default.css]
<span class="no"> 4</span> ]
<span class="no"> 5</span> body[
<span class="no"> 6</span> @class[topic]
<span class="no"> 7</span> halftitlepage[
<span class="no"> 8</span> title[]
<span class="no"> 9</span> subtitle[]
<span class="no"><strong>10</strong></span> author[]
<span class="no">11</span> ]
<span class="no">12</span> frontmatter[
<span class="no">13</span> toc[]
<span class="no">14</span> ]
<span class="no">15</span> ]
<span class="no">16</span> ]</pre></div>
</div>
<p>Index layouts do not take any attribute or parameter (basically because they are used to produce only one page).</p>
</section>
<section class="section">
<header><h1 id="h_86">Creating a Custom Layout</h1></header>
<p>To create a custom layout, proceed as follows:</p>
<ul>
<li>Create a <code>.glyph</code> file in the <code>lib/layouts</code> directory, within your project, e.g. <code>mytopic.glyph</code></li>
<li>Add the layout code, making sure (for topic layouts) that all the attributes (<code>title</code>, <code>id</code>, <code>contents</code>) are specified correctly.</li>
<li>Set the <code>output.*.layouts.topic</code> setting to the name of the new layout (<code>mytopic</code>).</li>
</ul>
<aside class="tip">
<span class="note-title">Tip</span>You can override which layout to use on a specific topic by specifying it in a <code>@layout</code> attribute.
</aside>
</section>
<nav><a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/extending/further_reading.html">→ Further Reading</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.min.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>
|