File Manager

Editing File: /usr/share/doc/texinfo/html/Showing-the-Structure.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>Showing the Structure (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<div class="header">

Next: <a href="Updating-Nodes-and-Menus.html" accesskey="n" rel="next">Updating Nodes and Menus</a>, Previous: <a href="Inserting.html" accesskey="p" rel="prev">Inserting</a>, Up: <a href="Texinfo-Mode.html" accesskey="u" rel="up">Texinfo Mode</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>]
</div>
<hr>
<h3 class="section">D.4 Showing the Sectioning Structure of a File</h3>

You can show the sectioning structure of a Texinfo file by using the
<kbd>C-c C-s</kbd> command (<code>texinfo-show-structure</code>). This command
lists the lines that begin with the @-commands for <code>@chapter</code>,
<code>@section</code>, and the like. It constructs what amounts to a table
of contents. These lines are displayed in another buffer called the
&lsquo;<samp>*Occur*</samp>&rsquo; buffer. In that buffer, 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.

<dl compact="compact">
<dt><kbd>C-c C-s</kbd></dt>
<dt><kbd>M-x texinfo-show-structure</kbd></dt>
<dd>
Show the <code>@chapter</code>, <code>@section</code>, and such lines of a
Texinfo file.

</dd>
<dt><kbd>C-c C-c</kbd></dt>
<dt><kbd>M-x occur-mode-goto-occurrence</kbd></dt>
<dd>
Go to the line in the Texinfo file corresponding to the line under the
cursor in the <samp>*Occur*</samp> buffer.
</dd>
</dl>

If you call <code>texinfo-show-structure</code> with a prefix argument by
typing <kbd>C-u&nbsp;C-c&nbsp;C-s</kbd>, it will list not only those lines with the
@-commands for <code>@chapter</code>, <code>@section</code>, and the like, but
also the <code>@node</code> lines. You can use <code>texinfo-show-structure</code>
with a prefix argument to check whether the &lsquo;Next&rsquo;, &lsquo;Previous&rsquo;, and &lsquo;Up&rsquo;
pointers of an <code>@node</code> line are correct.

Often, when you are working on a manual, you will be interested only
in the structure of the current chapter. In this case, you can mark
off the region of the buffer that you are interested in by using the
<kbd>C-x n n</kbd> (<code>narrow-to-region</code>) command and
<code>texinfo-show-structure</code> will work on only that region. To see
the whole buffer again, use <kbd>C-x&nbsp;n&nbsp;w</kbd> (<code>widen</code>).
(See <a href="../emacs/Narrowing.html#Narrowing">Narrowing</a> in <cite>The GNU Emacs Manual</cite>, for more
information about the narrowing commands.)



In addition to providing the <code>texinfo-show-structure</code> command,
Texinfo mode sets the value of the page delimiter variable to match
the chapter-level @-commands. This enables you to use the <kbd>C-x
]</kbd> (<code>forward-page</code>) and <kbd>C-x [</kbd> (<code>backward-page</code>)
commands to move forward and backward by chapter, and to use the
<kbd>C-x n p</kbd> (<code>narrow-to-page</code>) command to narrow to a chapter.
See <a href="../emacs/Pages.html#Pages">Pages</a> in <cite>The GNU Emacs Manual</cite>, for more information
about the page commands.

<hr>
<div class="header">

Next: <a href="Updating-Nodes-and-Menus.html" accesskey="n" rel="next">Updating Nodes and Menus</a>, Previous: <a href="Inserting.html" accesskey="p" rel="prev">Inserting</a>, Up: <a href="Texinfo-Mode.html" accesskey="u" rel="up">Texinfo Mode</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>]
</div>

</body>
</html>

Back to Directory File Manager