all repos — h3rald @ b71c0c77d3e0fc2453da3782101d1050eedd19d3

The sources of https://h3rald.com

content/glyph/book/text_editing/inclusions.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
 
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Content Reuse - 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="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="readability-verification" content="XmaVzRjmcFL5Bb2Fu9TZVdDKzhA3apQdxexTB2rK"/>
    <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/html5reset.css" /> -->
    <!-- <link rel="stylesheet" type="text/css" href="/styles/style.css" /> -->
    <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>
            <img src="/img/h3rald.png" alt="H3RALD" />
          </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>Content Reuse</h1>
      <h2>Glyph</h2>
      </hgroup>
      </header>
      <section id="body-text" class="hyphenate">

							<nav class="navigation"><a href="/glyph/book/text_editing/stylesheets.html">← Adding Stylesheets</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/conditionals.html">Conditional Macros →</a></nav>
							  <section class="section">
<header><h1 id="file-inclusions" class="toc">File inclusions</h1></header>
<p>If you&#8217;re authoring a user manual, a long article, or a book, writing everything inside a single <code>document.glyph</code> file may not be optimal. For this reason, Glyph provides an <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro that can be used to include the contents of any file within the <code>text/</code> directory:</p>
<p><code>include[general/introduction.textile]</code></p>
<p>The macro call above loads the contents of the <code>introduction.textile</code> file, within the <code>text/general</code> directory.</p>
<p>When including a text file, an input filter macro is applied to its contents by default, based on the file extension used:</p>
<ul>
	<li><code>.textile</code> or <code>.txt</code> &rarr; <a href="/glyph/book/macros/macros_filters.html#m_textile"><code>textile</code></a> macro</li>
	<li><code>.markdown</code> or <code>.md</code> &rarr; <a href="/glyph/book/macros/macros_filters.html#m_markdown"><code>markdown</code></a> macro</li>
</ul>
<p>You can override this behavior by setting the <code>filters.by_file_extensions</code> configuration setting to <code>false</code>. If no extension is specified, <code>.glyph</code> is assumed.</p>
    <section class="section">
<header><h1 id="h_39" class="toc">Remarks</h1></header>
<ul>
	<li>The <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro can also be used to include (and evaluate) ruby files (with a <code>.rb</code> extension). In this case, the ruby file must be placed within the <code>lib/</code> directory of the current project.</li>
	<li>The <a href="/glyph/book/macros/macros_core.html#m_load"><code>load</code></a> macro macro can be used to include the content of any file <em>without</em> performing any evaluation.</li>
</ul>

</section>

</section>
  <section class="section">
<header><h1 id="snippets" class="toc">Snippets</h1></header>
<p>While including the context of an entire file is definitely a useful feature for content reuse, sometimes it can be an overkill. What if, for example, you just want to reuse a short procedure or even a sentence or a single word? In this case, you may want to consider using a <em>snippet</em> instead.</p>
<p>Snippets can be defined using the <a href="/glyph/book/macros/macros_core.html#m_snippet_"><code>snippet:</code></a> macro (aliased by <code>&amp;:</code>) and called by using the <a href="/glyph/book/macros/macros_core.html#m_snippet"><code>snippet</code></a> macro (aliased by <code>&amp;</code>). Consider the following simple example:</p>
    <div class="CodeRay">
  <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>&amp;:[markups|Textile or Markdown]
<span class="line-numbers"><a href="#n2" name="n2">2</a></span>
<span class="line-numbers"><a href="#n3" name="n3">3</a></span>Glyph supports &amp;[markups].</pre></div>
</div>

    <p>You can use <code>&amp;[markups]</code> anywhere in your document instead of having to type "Textile or Markdown" every time. Additionally, later on you can change the value of the  <code>markups</code> to change it everywhere else in the document.</p>

</section> 
    <aside class="tip">
<span class="note-title">Tip</span>Snippets (or any other macro) can be nested within other snippets. Glyph takes care of checking if you nested snippets or macros mutually and warns you as necessary.

</aside>
  
							<nav class="navigation"><a href="/glyph/book/text_editing/stylesheets.html">← Adding Stylesheets</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/conditionals.html">Conditional Macros →</a></nav>

      </section>
      </article>
    </div>

    <footer>
    <section>
    <p>H3RALD Web Site v8.3 &copy; 2004 &mdash; 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>