content/glyph/book/text_editing/esc_quot.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 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Escaping and Quoting – 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>Escaping and Quoting</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/text_editing/sections.html">→ Sections and Headers</a></nav>
<p>Glyph doesn’t require any special control characters like LaTeX, and its macro syntax is very straightforward and liberal. This however comes with a price: because square brackets are used as delimiters, you must escape any square bracket in your text with a backslash. That’s not <em>too</em> bad if you think about it, unless you’re writing programming code, in which case escaping every single square bracket can be painful.</p>
<p>If a portion of your text contains an excessive amount of square brackets, you may consider using the <a href="/glyph/book/macros/macros_core.html#m_escape"><code>escape</code></a> macro (or its alias <code>.</code>) with the <code>[=</code> and <code>=]</code> delimiters. By itself, the escape macro doesn’t do anything: it just evaluates to its contents, but the special delimiters act as an escape for any square bracket within them. As a consequence, any macro within <code>[=</code> and <code>=]</code> will <em>not</em> be evaluated.</p>
<p>You can use the quoting delimiters with <em>any</em> macro identifier. Obviously, using them as delimiters for things like <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macros may not be a good idea, but they should be more or less mandatory with the <a href="/glyph/book/macros/macros_block.html#m_codeblock"><code>codeblock</code></a> macro or the <a href="/glyph/book/macros/macros_filters.html#m_highlight"><code>highlight</code></a> macro, especially when it contains square brackets or even Glyph code, like this:</p>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> codeblock[=
<span class="no"> 2</span> section[
<span class="no"> 3</span> @title[A section]
<span class="no"> 4</span> @id[test]
<span class="no"> 5</span> This is a section.
<span class="no"> 6</span> section[
<span class="no"> 7</span> @title[A nested section]
<span class="no"> 8</span> This is another section.
<span class="no"> 9</span> ]
<span class="no"><strong>10</strong></span> ]
<span class="no">11</span> =]</pre></div>
</div>
<aside class="note">
<span class="note-title">Note</span>Although quoting delimiters allow you to use square brackets without escaping them, you must still escape them if you want to escape quoting delimiters themselves.
</aside>
<p>Besides square brackets, there are other characters that must or can be escaped with backslashes, as shown in the following table:</p>
<table><tr><th>Escape Sequence</th>
<th>Evaluates to...</th>
<th>Notes</th></tr>
<tr><td>
<code>\[</code>
</td>
<td>
<code>[</code>
</td>
<td>Square brackets must be escaped unless used as macro delimiters or within a quoting macro.</td></tr>
<tr><td>
<code>\]</code>
</td>
<td>
<code>]</code>
</td>
<td>Square brackets must be escaped unless used as macro delimiters or within a quoting macro.</td></tr>
<tr><td>
<code>\\</code>
</td>
<td>
<code>\</code>
</td>
<td>Backslashes do not have to be escaped by default, but an escaped backslash will evaluate to itself.</td></tr>
<tr><td>
<code>\=</code>
</td>
<td>
<code>=</code>
</td>
<td>Equal signs do not have to be escaped by default, but an escaped equal sign will evaluate to iself.</td></tr>
<tr><td>
<code>\|</code>
</td>
<td>
<code>|</code>
</td>
<td>Pipes must be escaped (even within quoting macros) unless they are used to separate macro parameters.</td></tr>
<tr><td>
<code>\.</code>
</td>
<td />
<td>An escaped dot evaluates to nothing. Useful to separate macro identifiers from other characters: <br /><code>_\.=>[#link|This link is emphasized using Textile]_</code></td></tr></table>
<nav><a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/text_editing/sections.html">→ Sections and Headers</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>
|