contents/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 |
-----
title: "Glyph - Macro Statistics"
content-type: page
-----
<nav class="navigation"><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>
<h3 id="h_62" class="toc">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="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Macros
<span class="line-numbers"> <a href="#n2" name="n2">2</a></span>-- Total Macro Instances: 2497
<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>-- Total Macro Definitions: 65
<span class="line-numbers"> <a href="#n4" name="n4">4</a></span>-- Total Macro Aliases: 57
<span class="line-numbers"> <a href="#n5" name="n5">5</a></span>-- Total Used Macro Definitions: 56
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span>-- Macro Definitions:
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span> #> $> %> alias: aliases
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span> anchor and article author block_example
<span class="line-numbers"> <a href="#n9" name="n9">9</a></span> book box class codeblock comment
<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> condition config config: config_table default
<span class="line-numbers"><a href="#n11" name="n11">11</a></span> document draftcomment eq error_table escape
<span class="line-numbers"><a href="#n12" name="n12">12</a></span> example examples features figure fmi
<span class="line-numbers"><a href="#n13" name="n13">13</a></span> head highlight image include issue
<span class="line-numbers"><a href="#n14" name="n14">14</a></span> link macro: markdown match navigation
<span class="line-numbers"><a href="#n15" name="n15">15</a></span> not note option or parameters
<span class="line-numbers"><a href="#n16" name="n16">16</a></span> pubdate ref_config ref_error ref_macro release
<span class="line-numbers"><a href="#n17" name="n17">17</a></span> revision rewrite: ruby section snippet
<span class="line-numbers"><a href="#n18" name="n18">18</a></span> snippet: stats_for style subtitle textile
<span class="line-numbers"><a href="#n19" name="n19">19</a></span> title toc todo values |xml|
<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span>
<span class="line-numbers"><a href="#n21" name="n21">21</a></span>-- Used Macro Definitions:
<span class="line-numbers"><a href="#n22" name="n22">22</a></span> #> $> %> aliases anchor
<span class="line-numbers"><a href="#n23" name="n23">23</a></span> and author block_example book box
<span class="line-numbers"><a href="#n24" name="n24">24</a></span> class codeblock comment condition config
<span class="line-numbers"><a href="#n25" name="n25">25</a></span> config_table default document eq error_table
<span class="line-numbers"><a href="#n26" name="n26">26</a></span> escape example examples features figure
<span class="line-numbers"><a href="#n27" name="n27">27</a></span> fmi head highlight image include
<span class="line-numbers"><a href="#n28" name="n28">28</a></span> issue link note option or
<span class="line-numbers"><a href="#n29" name="n29">29</a></span> parameters pubdate ref_config ref_error ref_macro
<span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span> release revision rewrite: ruby section
<span class="line-numbers"><a href="#n31" name="n31">31</a></span> snippet snippet: stats_for style subtitle
<span class="line-numbers"><a href="#n32" name="n32">32</a></span> textile title toc todo values
<span class="line-numbers"><a href="#n33" name="n33">33</a></span> |xml|</pre>
</div>
</div>
<section class="section">
<header>
<h3 id="h_63" class="toc">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>
<h3 id="h_64" class="toc">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="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Macro 'note'
<span class="line-numbers"> <a href="#n2" name="n2">2</a></span>-- Total Instances: 18
<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>-- Occurrences:
<span class="line-numbers"> <a href="#n4" name="n4">4</a></span> - text/compiling/compiling.glyph (2)
<span class="line-numbers"> <a href="#n5" name="n5">5</a></span> - text/compiling/programmatic_usage.glyph (1)
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span> - text/extending/params_attrs.glyph (1)
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span> - text/getting_started/configuration.glyph (1)
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span> - text/stats/macros.glyph (2)
<span class="line-numbers"> <a href="#n9" name="n9">9</a></span> - text/text_editing/attribute_intro.glyph (1)
<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> - text/text_editing/esc_quot.glyph (1)
<span class="line-numbers"><a href="#n11" name="n11">11</a></span> - text/text_editing/images.glyph (1)
<span class="line-numbers"><a href="#n12" name="n12">12</a></span> - text/text_editing/inclusions.glyph (3)
<span class="line-numbers"><a href="#n13" name="n13">13</a></span> - text/text_editing/links.glyph (1)
<span class="line-numbers"><a href="#n14" name="n14">14</a></span> - text/text_editing/raw_html.glyph (1)
<span class="line-numbers"><a href="#n15" name="n15">15</a></span> - text/text_editing/section_aliases.glyph (1)
<span class="line-numbers"><a href="#n16" name="n16">16</a></span> - text/text_editing/xml_fallback.glyph (2)</pre>
</div>
</div>
<section class="section">
<header>
<h3 id="h_65" class="toc">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://rubydoc.info/gems/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 class="navigation"><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>
|