File Manager

Editing File: /usr/share/doc/texinfo/html/Using-texinfo_002dshow_002dstructure.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.  A copy of the license is included in the section entitled
"GNU Free Documentation License". -->

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Using texinfo-show-structure (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<span id="Using-texinfo_002dshow_002dstructure"></span><div class="header">
<p>
Next: <a href="Using-occur.html" accesskey="n" rel="next">Using <code>occur</code></a>, Previous: <a href="Debugging-with-TeX.html" accesskey="p" rel="prev">Debugging with TeX</a>, Up: <a href="Catching-Mistakes.html" accesskey="u" rel="up">Catching Mistakes</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Using-texinfo_002dshow_002dstructure-1"></span><h3 class="section">F.4 Using <code>texinfo-show-structure</code></h3>

<p>It is not always easy to keep track of the nodes, chapters, sections, and
subsections of a Texinfo file.  This is especially true if you are revising
or adding to a Texinfo file that someone else has written.
</p>
<p>In GNU Emacs, in Texinfo mode, the <code>texinfo-show-structure</code>
command lists all the lines that begin with the @-commands that
specify the structure: <code>@chapter</code>, <code>@section</code>,
<code>@appendix</code>, and so on.  With an argument (<kbd><span class="nolinebreak">C-u</span></kbd>
as prefix argument, if interactive),
the command also shows the <code>@node</code> lines.  The
<code>texinfo-show-structure</code> command is bound to <kbd>C-c C-s</kbd> in
Texinfo mode, by default.
</p>
<p>The lines are displayed in a buffer called the &lsquo;<samp>*Occur*</samp>&rsquo; buffer,
indented by hierarchical level.  For example, here is a part of what was
produced by running <code>texinfo-show-structure</code> on this manual:
</p>
<div class="example">
<pre class="example">Lines matching &quot;^@\\(chapter \\|sect\\|subs\\|subh\\|
unnum\\|major\\|chapheading \\|heading \\|appendix\\)&quot;
in buffer texinfo.texi.
&hellip;
4177:@chapter Nodes
4198:    @heading Two Paths
4231:    @section Node and Menu Illustration
4337:    @section The @code{@@node} Command
4393:        @subheading Choosing Node and Pointer Names
4417:        @subsection How to Write a @code{@@node} Line
4469:        @subsection @code{@@node} Line Tips
&hellip;
</pre></div>

<p>This says that lines 4337, 4393, and 4417 of <samp>texinfo.texi</samp> begin
with the <code>@section</code>, <code>@subheading</code>, and <code>@subsection</code>
commands respectively.  If you move your cursor into the &lsquo;<samp>*Occur*</samp>&rsquo;
window, you can position the cursor over one of the lines and use the
<kbd>C-c C-c</kbd> command (<code>occur-mode-goto-occurrence</code>), to jump to
the corresponding spot in the Texinfo file.  See <a href="../emacs/Other-Repeating-Search.html#Other-Repeating-Search">Using Occur</a> in <cite>The GNU Emacs Manual</cite>, for more
information about <code>occur-mode-goto-occurrence</code>.
</p>
<p>The first line in the &lsquo;<samp>*Occur*</samp>&rsquo; window describes the <em>regular
expression</em> specified by <var>texinfo-heading-pattern</var>.  This regular
expression is the pattern that <code>texinfo-show-structure</code> looks for.
See <a href="../emacs/Regexps.html#Regexps">Using Regular Expressions</a> in <cite>The GNU Emacs Manual</cite>,
for more information.
</p>
<p>When you invoke the <code>texinfo-show-structure</code> command, Emacs will
display the structure of the whole buffer.  If you want to see the
structure of just a part of the buffer, of one chapter, for example,
use the <kbd>C-x n n</kbd> (<code>narrow-to-region</code>) command to mark the
region.  (See <a href="../emacs/Narrowing.html#Narrowing">Narrowing</a> in <cite>The GNU Emacs Manual</cite>.)  This is
how the example used above was generated.  (To see the whole buffer
again, use <kbd>C-x n w</kbd> (<code>widen</code>).)
</p>
<p>If you call <code>texinfo-show-structure</code> with a prefix argument by
typing <kbd><span class="nolinebreak">C-u</span>&nbsp;<span class="nolinebreak">C-c</span>&nbsp;<span class="nolinebreak">C-s</span></kbd>, it will list lines beginning with
<code>@node</code> as well as the lines beginning with the @-sign commands
for <code>@chapter</code>, <code>@section</code>, and the like.
</p>
<p>You can remind yourself of the structure of a Texinfo file by looking at
the list in the &lsquo;<samp>*Occur*</samp>&rsquo; window; and if you have mis-named a node
or left out a section, you can correct the mistake.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Using-occur.html" accesskey="n" rel="next">Using <code>occur</code></a>, Previous: <a href="Debugging-with-TeX.html" accesskey="p" rel="prev">Debugging with TeX</a>, Up: <a href="Catching-Mistakes.html" accesskey="u" rel="up">Catching Mistakes</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>

</body>
</html>

Back to Directory File Manager