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 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Macro Statistics – 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>Macro Statistics</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><a href="/glyph/book/stats/stats.html">Using the stats command ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/stats/snippets.html">→ Snippet Statistics</a></nav>
<section class="section">
<header><h1 id="h_53">Displaying stats about all macros</h1></header>
<p>To display statistics about all macros, execute <code>glyph stats --macros</code>. Glyph displays something like this:</p>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> ===== Macros
<span class="no"> 2</span> -- Total Macro Instances: 2497
<span class="no"> 3</span> -- Total Macro Definitions: 65
<span class="no"> 4</span> -- Total Macro Aliases: 57
<span class="no"> 5</span> -- Total Used Macro Definitions: 56
<span class="no"> 6</span> -- Macro Definitions:
<span class="no"> 7</span> #<span class="er">></span> $<span class="er">></span> %<span class="er">></span> alias: aliases
<span class="no"> 8</span> anchor and article author block_example
<span class="no"> 9</span> book box class codeblock comment
<span class="no"><strong>10</strong></span> condition config config: config_table default
<span class="no">11</span> document draftcomment eq error_table escape
<span class="no">12</span> example examples features figure fmi
<span class="no">13</span> head highlight image include issue
<span class="no">14</span> link macro: markdown match navigation
<span class="no">15</span> not note option or parameters
<span class="no">16</span> pubdate ref_config ref_error ref_macro release
<span class="no">17</span> revision rewrite: ruby section snippet
<span class="no">18</span> snippet: stats_for style subtitle textile
<span class="no">19</span> title toc todo values |xml|
<span class="no"><strong>20</strong></span>
<span class="no">21</span> -- Used Macro Definitions:
<span class="no">22</span> #<span class="er">></span> $<span class="er">></span> %<span class="er">></span> aliases anchor
<span class="no">23</span> and author block_example book box
<span class="no">24</span> class codeblock comment condition config
<span class="no">25</span> config_table default document eq error_table
<span class="no">26</span> escape example examples features figure
<span class="no">27</span> fmi head highlight image include
<span class="no">28</span> issue link note option or
<span class="no">29</span> parameters pubdate ref_config ref_error ref_macro
<span class="no"><strong>30</strong></span> release revision rewrite: ruby section
<span class="no">31</span> snippet snippet: stats_for style subtitle
<span class="no">32</span> textile title toc todo values
<span class="no">33</span> |xml|</pre></div>
</div>
<section class="section">
<header><h1 id="h_54">Remarks</h1></header>
<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’s no distinction between macros defined by the user and macros defined by Glyph itself.</li>
</ul>
</section>
</section>
<section class="section">
<header><h1 id="h_55">Displaying stats about a single macro</h1></header>
<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>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> ===== Macro 'note'
<span class="no"> 2</span> -- Total Instances: 18
<span class="no"> 3</span> -- Occurrences:
<span class="no"> 4</span> - text/compiling/compiling.glyph (2)
<span class="no"> 5</span> - text/compiling/programmatic_usage.glyph (1)
<span class="no"> 6</span> - text/extending/params_attrs.glyph (1)
<span class="no"> 7</span> - text/getting_started/configuration.glyph (1)
<span class="no"> 8</span> - text/stats/macros.glyph (2)
<span class="no"> 9</span> - text/text_editing/attribute_intro.glyph (1)
<span class="no"><strong>10</strong></span> - text/text_editing/esc_quot.glyph (1)
<span class="no">11</span> - text/text_editing/images.glyph (1)
<span class="no">12</span> - text/text_editing/inclusions.glyph (3)
<span class="no">13</span> - text/text_editing/links.glyph (1)
<span class="no">14</span> - text/text_editing/raw_html.glyph (1)
<span class="no">15</span> - text/text_editing/section_aliases.glyph (1)
<span class="no">16</span> - text/text_editing/xml_fallback.glyph (2)</pre></div>
</div>
<section class="section">
<header><h1 id="h_56">Remarks</h1></header>
<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’ll be also listed in each file where the rewritten macro is used.</li>
</ul>
</section>
</section>
<nav><a href="/glyph/book/stats/stats.html">Using the stats command ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/stats/snippets.html">→ Snippet Statistics</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.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>
|