The Latexinfo Documentation Format Version 1.7
Total Page:16
File Type:pdf, Size:1020Kb
The LaTEXinfo Documentation Format Version 1.7 Richard M. Stallman and Robert J. Chassell The Free Software Foundation, 675 Massachusetts Ave., Cambridge MA, Michael Clarkson Centre for Earth and Space Science, York University, North York, Ontario, M3J 1P3 February 23, 1995 Copyright c 1988, 1990, 1991 Free Software Foundation, Inc. Copyleft c 1988, 1989, 1990, 1991 Michael E. Clarkson. a This is version 1.7 of the LTEXinfo documentation, and is for Version 18 of GNU Emacs. a This is the second edition of the LTEXinfo documentation, and is also consistent with version 2 of Texinfo documentation ‘texinfo.tex’. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another lan- guage, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Foundation. Contents 1 Overview of LaTeXinfo 3 1.1 Advantages of LaTeXinfo over TeXinfo ....................... 4 1.2 Info files ........................................ 5 1.3 Printed Manuals ................................... 7 1.4 \-commands ...................................... 7 1.5 A Short Sample LaTeXinfo File ........................... 9 1.6 The Structure of this Manual ............................ 12 ILaTeX 13 2 Beginning a LaTeXinfo File 15 2.1 General Syntactic Conventions ........................... 15 2.2 What a LaTeXinfo File Must Have ......................... 16 2.3 Six Parts of a LaTeXinfo File ............................ 17 2.4 The LaTeXinfo File Header ............................. 18 2.5 The Title and Copyright Pages ........................... 21 2.6 Generating a Table of Contents ........................... 23 2.7 The Top Node and Master Menu .......................... 24 2.8 Software Copying Conditions ............................ 26 2.9 Ending a LaTeXinfo File ............................... 27 3 Chapter Structuring 31 3.1 Tree Structure of Sections .............................. 31 3.2 Types of Structuring Command ........................... 33 3.3 Chapter ........................................ 33 3.4 Appendix ....................................... 33 3.5 Section ......................................... 34 3.6 Subsection ....................................... 34 3.7 Subsubsection ..................................... 34 i ii CONTENTS 4 Marking Words and Phrases 35 4.1 Indicating Definitions, Commands, etc. ....................... 35 4.2 Emphasizing Text .................................. 41 4.3 Special Insertions ................................... 44 5 Displaying Material 49 5.1 Quotations ...................................... 50 5.2 Justifying Text .................................... 51 5.3 Display Environments ................................ 52 5.4 Examples and Verbatim ............................... 52 5.5 Controlling Indentation ............................... 55 5.6 Drawing Cartouches Around Examples ....................... 55 5.7 Special Glyphs for Examples ............................ 56 5.8 Conditionally Visible Text .............................. 59 6 Making Lists Tables and Descriptions 61 6.1 Itemize Environment ................................. 62 6.2 Enumerate Environment ............................... 62 6.3 Description Environment .............................. 63 6.4 Tabular Environment ................................. 64 6.5 Figures and Tables .................................. 65 7 Formatting Paragraphs 67 7.1 Making and Preventing Breaks ........................... 67 7.2 The Line Breaking Commands ........................... 67 7.3 The Page Breaking Commands ........................... 69 7.4 Refilling Paragraphs ................................. 70 7.5 Always Refilling Paragraphs ............................. 71 8 Citations and Footnotes 73 8.1 Footnotes ....................................... 73 8.2 Citations ....................................... 74 9 Input and Include Files 75 9.1 Input Files ...................................... 75 9.2 Include Files ..................................... 75 10 Definition Commands 79 10.1 Untyped Languages Definition Commands ..................... 80 10.2 C Functions ...................................... 84 10.3 Object-Oriented Programming ........................... 87 10.4 A Sample Function Definition ............................ 90 CONTENTS iii II Info 93 11 Nodes and Menus 95 11.1 Node and Menu Illustration ............................. 95 11.2 \node ......................................... 96 11.3 Menu Environment .................................. 98 11.4 Referring to Other Info Files ............................ 101 12 Making Cross References 103 12.1 Different Cross Reference Commands ........................ 103 12.2 Parts of a Cross Reference .............................. 104 12.3 \xref ......................................... 105 12.4 Naming a ‘Top’ Node ................................ 110 12.5 \nxref ......................................... 110 12.6 \pxref ......................................... 111 12.7 \inforef ....................................... 112 13 Creating Indices 115 13.1 Making Index Entries ................................ 115 13.2 Defining the Entries of an Index .......................... 116 13.3 Combining Indices .................................. 118 14 Creating and Installing an Info File 121 14.1 Creating an Info file ................................. 121 14.2 Installing an Info File ................................ 123 III Emacs 127 15 Using LaTeXinfo Mode 129 15.1 Inserting Frequently Used Commands ....................... 130 15.2 Showing the Section Structure of a File ...................... 131 15.3 Updating Nodes and Menus ............................. 131 15.4 Formatting for Info .................................. 136 15.5 Formatting and Printing ............................... 137 15.6 LaTeXinfo Mode Summary ............................. 138 16 Printing Hardcopy 141 16.1 How to Print Using Shell Commands ........................ 141 16.2 Printing from an Emacs Shell ............................ 143 16.3 Formatting and Printing in LaTeXinfo Mode ................... 143 16.4 Using the Local Variables List ............................ 144 a ............................. 16.5 Preparing for Use of LTEX 145 16.6 Overfull “Hboxes” .................................. 145 iv CONTENTS 17 Catching Formatting Mistakes 147 17.1 Catching Errors with Info Formatting ....................... 147 a ...................... 17.2 Catching Errors with LTEX Formatting 148 17.3 Using latexinfo-show-structure ......................... 149 17.4 Using occur ...................................... 150 17.5 Finding Badly Referenced Nodes .......................... 151 18 Extending LaTeXinfo 155 18.1 Optional Style Files ................................. 155 18.2 LaTeXinfo support for European languages .................... 159 18.3 Writing Your Own Style Files ............................ 162 IV Appendices 163 A Installing LaTeXinfo 165 A.1 Compiling LaTeXinfo ................................ 165 A.2 Installing the LaTeXinfo Distribution ........................ 167 B Converting Files to LaTeXinfo 169 B.1 Converting LaTeX Files to LaTeXinfo ....................... 169 B.2 Converting TeXinfo Files into LaTeXinfo Files .................. 171 B.3 Converting Scribe Files to LaTeXinfo ........................ 173 a C Obtaining LTEX 175 D Command List 177 Command Index 189 Concept Index 193 List of Tables 6.1 The First Table’s Caption .............................. 65 10.1 The Definition Commands .............................. 79 16.1 Formatting a Buffer Commands ........................... 144 16.2 Formatting a Document Commands ........................ 145 18.1 The Clisp Definition Commands .......................... 157 v LaTeXinfo Copying Conditions a The programs currently being distributed that relate to LTEXinfo include portions of GNU Emacs, plus other separate programs (including latexinfo.sty, latexindex,andinfo). These programs are free; this means that everyone is free to use them and free to redistribute them on a free basis. The Latexinfo-related programs are not in the public domain; they are copyrighted and there are restrictions on their distribution, but these restrictions are designed to permit everything that a good cooperating citizen would want to do. What is not allowed is to try to prevent others from further sharing any version of these programs that they might get from you. Specifically, we want to make sure that you have the right to give away copies of the a programs that relate to LTEXinfo, that you receive source code or else can get it if you want it, that you can change these programs or use pieces of them in new free programs, and that you know you can do these things. To make sure that everyone has such rights, we have to forbid you to deprive anyone else of a these rights. For example, if you distribute copies of the LTEXinfo related programs, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. Also, for our own protection, we must make certain that