all repos — h3rald @ 19f3724b35edc7f6b5e2f1a91e2062c8531cc51d

The sources of https://h3rald.com

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
 200
 201
 202
 203
 204
 205
 206
 207
<!DOCTYPE html>
<html lang="en">
	<head>
    <title>Layouts - H3RALD</title>
		<link href='https://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" />
		<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/bootstrap.css" />
		<link rel="stylesheet" type="text/css" href="/styles/github.css" />
		<link rel="stylesheet" type="text/css" href="/styles/style.css" />
    <!--[if lt IE 9]>
    <script src="https://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <script src="https://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="https://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/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/highlight.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="col-md-6 main-title">
      <h1>
        
        <a href="/"><img src="/img/h3rald.png" alt="H3RALD" /></a>
      
      </h1>
    </div>
    <div class="col-md-4 col-md-offset-2">
      <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" role="navigation">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
    </div>
    <div class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li><a href="/"><i class="fa fa-home"></i> HOME</a></li>
        <li><a href="/projects/"><i class="fa fa-briefcase"></i> PROJECTS</a></li>
        <li><a href="/tags/"><i class="fa fa-tags"></i> TAGS</a></li>
        <li><a href="/archives/"><i class="fa fa-archive"></i> ARCHIVES</a></li>
        <li><a href="/about/"><i class="fa fa-question-circle"></i> ABOUT</a></li>
        <li><a href="/contact/"><i class="fa fa-envelope"></i> CONTACT</a></li>
      </ul>
    </div>
  </div>
</div>
        <div class="container">
				<article class="page">
			  <header class="row">
        <hgroup class="col-md-9">
      <h1>Layouts</h1>
      <h2>Glyph</h2>
      </hgroup>
      </header>
      <section id="body-text" class="hyphenate">

							<nav class="navigation"><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> &#8212; used to render standard topics.</li>
	<li><code>index</code> &#8212; used to render the index page of your document.</li>
</ul>
<p>Layouts are nothing more than &#8220;fancy&#8221; 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_96" class="toc">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="line-numbers"> <a href="#n1" name="n1">1</a></span>document[
<span class="line-numbers"> <a href="#n2" name="n2">2</a></span>  head[
<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>    style[default.css]
<span class="line-numbers"> <a href="#n4" name="n4">4</a></span>  ]
<span class="line-numbers"> <a href="#n5" name="n5">5</a></span>  body[
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span>    @class[topic]
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span>    section[
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span>      @title[{{title}}]
<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>      @id[{{id}}]
<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span>      navigation[{{id}}]
<span class="line-numbers"><a href="#n11" name="n11">11</a></span>{{contents}}
<span class="line-numbers"><a href="#n12" name="n12">12</a></span>      navigation[{{id}}]
<span class="line-numbers"><a href="#n13" name="n13">13</a></span>    ]
<span class="line-numbers"><a href="#n14" name="n14">14</a></span>  ]
<span class="line-numbers"><a href="#n15" name="n15">15</a></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> &#8212; the title of the topic.</li>
	<li><code>id</code> &#8212; the ID of the topic.</li>
	<li><code>contents</code> &#8212; the body of the topic.</li>
</ul>

</section>
<section class="section">
<header><h1 id="index_layout" class="toc">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="line-numbers"> <a href="#n1" name="n1">1</a></span>document[
<span class="line-numbers"> <a href="#n2" name="n2">2</a></span>  head[
<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>    style[default.css]
<span class="line-numbers"> <a href="#n4" name="n4">4</a></span>  ]
<span class="line-numbers"> <a href="#n5" name="n5">5</a></span>  body[
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span>    @class[topic]
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span>    halftitlepage[
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span>      title[]
<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>      subtitle[]
<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span>      author[]
<span class="line-numbers"><a href="#n11" name="n11">11</a></span>    ]
<span class="line-numbers"><a href="#n12" name="n12">12</a></span>    frontmatter[
<span class="line-numbers"><a href="#n13" name="n13">13</a></span>      toc[]
<span class="line-numbers"><a href="#n14" name="n14">14</a></span>    ]
<span class="line-numbers"><a href="#n15" name="n15">15</a></span>  ]
<span class="line-numbers"><a href="#n16" name="n16">16</a></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_98" class="toc">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 class="navigation"><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>
    </div>

			
			<footer>
				<section>
          <p>H3RALD Web Site v8.4 &copy; 2004 &mdash; 2014 <em>Fabio Cevasco</em></p>
				</section>
			</footer>
		
    <script type="text/javascript">
        var disqus_shortname = 'h3rald'; 

        (function() {
            var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
            dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
            (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
        })();
    </script>
    <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
    <a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
    
		
    <script>
      hljs.tabReplace = '  ';
      hljs.initHighlightingOnLoad();
    </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 --> 
	</body>
</html>