all repos — h3rald @ 93d21c0e2809890a6b57e26b73d255a23d99c5cc

The sources of https://h3rald.com

content/glyph/book/stats/macros.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
 
<?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>Macro Statistics - 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 &ndash; and <em>safer</em> &ndash; 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&amp;type=website&amp;linkfg=%23a4282d"></script></span>
						</div>

						<h2>Macro Statistics</h2>
						<hr />
						<div id="content-body">
							<div class="navigation"><a href="/glyph/book/stats/stats.html">Using the stats command &larr;</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/stats/snippets.html">&rarr; Snippet Statistics</a></div>
							
	<div class="section">
<h4 id="h_52">Displaying stats about all macros</h4>
<p>To display statistics about all macros, execute <code>glyph stats --macros</code>. Glyph displays something like this:</p>
		<pre class="lazy"><span class="line-numbers">   1 </span> ===== Macros
<span class="line-numbers">   2 </span> -- Total Macro Instances: 2497
<span class="line-numbers">   3 </span> -- Total Macro Definitions: 65
<span class="line-numbers">   4 </span> -- Total Macro Aliases: 57
<span class="line-numbers">   5 </span> -- Total Used Macro Definitions: 56
<span class="line-numbers">   6 </span> -- Macro Definitions:
<span class="line-numbers">   7 </span>      #&gt;            $&gt;            %&gt;            alias:        aliases       
<span class="line-numbers">   8 </span>      anchor        and           article       author        block_example 
<span class="line-numbers">   9 </span>      book          box           class         codeblock     comment       
<span class="line-numbers">  10 </span>      condition     config        config:       config_table  default       
<span class="line-numbers">  11 </span>      document      draftcomment  eq            error_table   escape        
<span class="line-numbers">  12 </span>      example       examples      features      figure        fmi           
<span class="line-numbers">  13 </span>      head          highlight     image         include       issue         
<span class="line-numbers">  14 </span>      link          macro:        markdown      match         navigation    
<span class="line-numbers">  15 </span>      not           note          option        or            parameters    
<span class="line-numbers">  16 </span>      pubdate       ref_config    ref_error     ref_macro     release       
<span class="line-numbers">  17 </span>      revision      rewrite:      ruby          section       snippet       
<span class="line-numbers">  18 </span>      snippet:      stats_for     style         subtitle      textile       
<span class="line-numbers">  19 </span>      title         toc           todo          values        |xml|         
<span class="line-numbers">  20 </span> 
<span class="line-numbers">  21 </span> -- Used Macro Definitions:
<span class="line-numbers">  22 </span>      #&gt;            $&gt;            %&gt;            aliases       anchor        
<span class="line-numbers">  23 </span>      and           author        block_example book          box           
<span class="line-numbers">  24 </span>      class         codeblock     comment       condition     config        
<span class="line-numbers">  25 </span>      config_table  default       document      eq            error_table   
<span class="line-numbers">  26 </span>      escape        example       examples      features      figure        
<span class="line-numbers">  27 </span>      fmi           head          highlight     image         include       
<span class="line-numbers">  28 </span>      issue         link          note          option        or            
<span class="line-numbers">  29 </span>      parameters    pubdate       ref_config    ref_error     ref_macro     
<span class="line-numbers">  30 </span>      release       revision      rewrite:      ruby          section       
<span class="line-numbers">  31 </span>      snippet       snippet:      stats_for     style         subtitle      
<span class="line-numbers">  32 </span>      textile       title         toc           todo          values        
<span class="line-numbers">  33 </span>      |xml|
</pre>
		<div class="section">
<h5 id="h_53">Remarks</h5>
<ul>
	<li>Only macro <em>definitions</em> (not their <em>aliases</em>) are displayed, both default and user-defined.</li>
	<li>The <code>|xml|</code> macro is a special macro used if the <a href="/glyph/book/config/options.html#s_options_xml_fallback"><code>options.xml_fallback</code></a> setting is enabled.</li>
	<li>There&#8217;s no distinction between macros defined by the user and macros defined by Glyph itself.</li>
</ul>

</div>

</div>

	<div class="section">
<h4 id="h_54">Displaying stats about a single macro</h4>
<p>To display statistics about a single macro (e.g. <code>note</code>), execute <code>glyph stats --macro=note</code>. Glyph displays something like this:</p>
		<pre class="lazy"><span class="line-numbers">   1 </span> ===== Macro 'note' 
<span class="line-numbers">   2 </span> -- Total Instances: 18
<span class="line-numbers">   3 </span> -- Occurrences:
<span class="line-numbers">   4 </span>    - text/compiling/compiling.glyph (2)
<span class="line-numbers">   5 </span>    - text/compiling/programmatic_usage.glyph (1)
<span class="line-numbers">   6 </span>    - text/extending/params_attrs.glyph (1)
<span class="line-numbers">   7 </span>    - text/getting_started/configuration.glyph (1)
<span class="line-numbers">   8 </span>    - text/stats/macros.glyph (2)
<span class="line-numbers">   9 </span>    - text/text_editing/attribute_intro.glyph (1)
<span class="line-numbers">  10 </span>    - text/text_editing/esc_quot.glyph (1)
<span class="line-numbers">  11 </span>    - text/text_editing/images.glyph (1)
<span class="line-numbers">  12 </span>    - text/text_editing/inclusions.glyph (3)
<span class="line-numbers">  13 </span>    - text/text_editing/links.glyph (1)
<span class="line-numbers">  14 </span>    - text/text_editing/raw_html.glyph (1)
<span class="line-numbers">  15 </span>    - text/text_editing/section_aliases.glyph (1)
<span class="line-numbers">  16 </span>    - text/text_editing/xml_fallback.glyph (2)
</pre>
		<div class="section">
<h5 id="h_55">Remarks</h5>
<ul>
	<li>All the instances of the specified macro definition <em>and all its aliases</em> are collected, regardless whether a definition or an alias is specified.</li>
	<li>If you use custom macros, make sure they call the <a href="http://yardoc.org/docs/h3rald-glyph/Glyph/Macro:update_source">Macro#update_source</a> appropriately method if necessary.</li>
	<li>If macros are used within <a href="/glyph/book/extending/interpreting.html#rewriting">rewritten</a> macros, they&#8217;ll be also listed in each file where the rewritten macro is used.</li>
</ul>

</div>

</div>
							<div class="navigation"><a href="/glyph/book/stats/stats.html">Using the stats command &larr;</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/stats/snippets.html">&rarr; Snippet Statistics</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> &mdash; &copy; 2004-2010 <strong>Fabio Cevasco</strong> &mdash; <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=/stats_macros.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="http://www.google.com/jsapi?key=ABQIAAAA6h3j8Jri5D_da53UPbEbThRlq2n1sm52B5HDRR5tm6o8XM18FhTKn3v155RpPeD0kWnWG81QEhhifQ" type="text/javascript"></script>
					<script src="/js/jquery.js" type="text/javascript"></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/init.js" type="text/javascript"></script> 
				
				
					<script type="text/javascript"> 
						$(document).ready(function() {
								display_opinions(7);
								display_tweets(7);
								display_bookmarks(7);
								});
					</script> 
			</body>
		</html>