[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6735] Quotations and Examples chapter some rearrangement
From: |
Gavin D. Smith |
Subject: |
[6735] Quotations and Examples chapter some rearrangement |
Date: |
Fri, 30 Oct 2015 17:32:38 +0000 |
Revision: 6735
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6735
Author: gavin
Date: 2015-10-30 17:32:36 +0000 (Fri, 30 Oct 2015)
Log Message:
-----------
Quotations and Examples chapter some rearrangement
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/texinfo.texi
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-10-29 19:55:48 UTC (rev 6734)
+++ trunk/ChangeLog 2015-10-30 17:32:36 UTC (rev 6735)
@@ -1,3 +1,12 @@
+2015-10-30 Gavin Smith <address@hidden>
+
+ * doc/texinfo.texi (@display, @table): Move advice about using
+ @table inside @display to @table node.
+ (@small...): Move later in chapter.
+ (@verbatiminclude): Move to Include Files chapter.
+ (@lisp): Remove footnote suggesting that C or Fortran could be
+ embedded inside Texinfo files.
+
2015-10-29 Gavin Smith <address@hidden>
* tp/tests/README: Mention purpose of htmlxref,
@@ -7,7 +16,7 @@
2015-10-29 Gavin Smith <address@hidden>
* doc/texinfo.tex (\utfeightchardefs): More definitions for
- mathematical symbols, from Karl.
+ mathematical symbols, from Karl, from Jim Hefferon.
2015-10-28 Gavin Smith <address@hidden>
Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi 2015-10-29 19:55:48 UTC (rev 6734)
+++ trunk/doc/texinfo.texi 2015-10-30 17:32:36 UTC (rev 6735)
@@ -6905,9 +6905,7 @@
* @code{@@indentedblock}:: Block of text indented on left.
* @code{@@example}:: Writing an example in a fixed-width
font.
* @code{@@verbatim}:: Writing a verbatim example.
-* @code{@@verbatiminclude}:: Including a file verbatim.
* @code{@@lisp}:: Illustrating Lisp code.
-* @code{@@address@hidden:: Examples in a smaller font.
* @code{@@display}:: Writing an example in the current font.
* @code{@@format}:: Writing an example without narrowed
margins.
* @code{@@exdent}:: Undo indentation on a line.
@@ -6916,6 +6914,7 @@
* @code{@@noindent}:: Preventing paragraph indentation.
* @code{@@indent}:: Forcing paragraph indentation.
* @code{@@cartouche}:: Drawing rounded rectangles around text.
+* @code{@@address@hidden:: Examples in a smaller font.
@end menu
@@ -7266,45 +7265,9 @@
Finally, a word of warning: it is not reliable to use
@code{@@verbatim} inside other Texinfo constructs.
+See also @address@hidden@@verbatiminclude}}.
address@hidden @code{@@verbatiminclude}
address@hidden @code{@@verbatiminclude} @var{file}: Include a File Verbatim
address@hidden@c old name
address@hidden verbatiminclude
address@hidden Verbatim, include file
address@hidden Including a file verbatim
-
-You can include the exact contents of a file in the document with the
address@hidden@@verbatiminclude} command:
-
address@hidden
-@@verbatiminclude @var{filename}
address@hidden example
-
-The contents of @var{filename} is printed in a verbatim environment
-(@address@hidden@@verbatim}}). Generally, the file is printed exactly
-as it is, with all special characters and white space retained. No
-indentation is added; if you want indentation, enclose the
address@hidden@@verbatiminclude} within @code{@@example}
-(@address@hidden@@example}}).
-
-The name of the file is taken literally, with a single exception:
address@hidden@@address@hidden@address@hidden references are expanded. This
makes it
-possible to include files in other directories within a distribution,
-for instance:
-
address@hidden
-@@verbatiminclude @@address@hidden@}/NEWS
address@hidden example
-
address@hidden (You still have to get @code{top_srcdir} defined in the
-first place.)
-
-For a method on printing the file contents in a smaller font size, see
-the end of the previous section on @code{@@verbatim}.
-
-
@node @code{@@lisp}
@section @code{@@lisp}: Marking a Lisp Example
@@ -7324,70 +7287,10 @@
regarding the nature of the example. This is useful, for example, if
you write a function that evaluates only and all the Lisp code in a
Texinfo file. Then you can use the Texinfo file as a Lisp
address@hidden would be straightforward to extend Texinfo to work
-in a similar fashion for C, Fortran, or other languages.}
+library. Mark the end of @code{@@lisp} with @code{@@end lisp} on a line
+by itself.
-Mark the end of @code{@@lisp} with @code{@@end lisp} on a line by
-itself.
-
address@hidden @code{@@address@hidden
address@hidden @code{@@address@hidden Block Commands
-
address@hidden@c old name
address@hidden smallexample
address@hidden smallformat
address@hidden smalllisp
address@hidden smallquotation
address@hidden Small examples
address@hidden Examples in smaller fonts
address@hidden Quotations in smaller fonts
address@hidden Lisp examples in smaller fonts
-
-In addition to the regular @code{@@example} and similar commands,
-Texinfo has ``small'' example-style commands. These are
address@hidden@@smallquotation}, @code{@@smallindentedblock},
address@hidden@@smalldisplay}, @code{@@smallexample}, @code{@@smallformat},
-and @code{@@smalllisp}.
-
-In Info output, the @code{@@address@hidden commands are equivalent to
-their non-small companion commands.
-
-In @TeX{}, however, the @code{@@address@hidden commands typeset text in
-a smaller font than the non-small example commands. Thus, for
-instance, code examples can contain longer lines and still fit on a
-page without needing to be rewritten.
-
-A smaller font size is also requested in HTML output, and (as usual)
-retained in the address@hidden transliteration.
-
-Mark the end of a @code{@@address@hidden block with a corresponding
address@hidden@@end address@hidden For example, pair @code{@@smallexample} with
address@hidden@@end smallexample}.
-
-Here is an example of the font used by the @code{@@smallexample}
-command (in Info, the output will be the same as usual):
-
address@hidden
address@hidden to make sure that you have the freedom to
-distribute copies of free software (and charge for
-this service if you wish), that you receive source
-code or can get it if you want it, that you can
-change the software or use pieces of it in new free
-programs; and that you know you can do these things.
address@hidden smallexample
-
-The @code{@@address@hidden commands use the same font style as their
-normal counterparts: @code{@@smallexample} and @code{@@smalllisp} use
-a fixed-width font, and everything else uses the regular font.
-They also have the same behavior in other respects---whether filling
-is done and whether margins are narrowed.
-
-As a general rule, a printed document looks better if you use only one
-of (for instance) @code{@@example} or @code{@@smallexample}
-consistently within a chapter.
-
-
@node @code{@@display}
@section @code{@@display}: Examples Using the Text Font
@@ -7411,13 +7314,7 @@
like @code{@@display} but uses a smaller font size.
@address@hidden@@address@hidden
-The @code{@@table} command (@address@hidden@@table}}) is not supported
-inside @code{@@display}. Since @code{@@display} is line-oriented, it
-doesn't make sense to use them together. If you want to indent a
-table, try @code{@@quotation} (@address@hidden@@quotation}}) or
address@hidden@@indentedblock} (@address@hidden@@indentedblock}}).
-
@node @code{@@format}
@section @code{@@format}: Examples Using the Full Line Width
@@ -7730,7 +7627,65 @@
@code{@@cartouche} also implies @code{@@group} (@address@hidden@@group}}).
address@hidden @code{@@address@hidden
address@hidden @code{@@address@hidden Block Commands
address@hidden@c old name
address@hidden smallexample
address@hidden smallformat
address@hidden smalllisp
address@hidden smallquotation
address@hidden Small examples
address@hidden Examples in smaller fonts
address@hidden Quotations in smaller fonts
address@hidden Lisp examples in smaller fonts
+
+In addition to the regular @code{@@example} and similar commands,
+Texinfo has ``small'' example-style commands. These are
address@hidden@@smallquotation}, @code{@@smallindentedblock},
address@hidden@@smalldisplay}, @code{@@smallexample}, @code{@@smallformat},
+and @code{@@smalllisp}.
+
+In Info output, the @code{@@address@hidden commands are equivalent to
+their non-small companion commands.
+
+In @TeX{}, however, the @code{@@address@hidden commands typeset text in
+a smaller font than the non-small example commands. Thus, for
+instance, code examples can contain longer lines and still fit on a
+page without needing to be rewritten.
+
+A smaller font size is also requested in HTML output, and (as usual)
+retained in the address@hidden transliteration.
+
+Mark the end of a @code{@@address@hidden block with a corresponding
address@hidden@@end address@hidden For example, pair @code{@@smallexample} with
address@hidden@@end smallexample}.
+
+Here is an example of the font used by the @code{@@smallexample}
+command (in Info, the output will be the same as usual):
+
address@hidden
address@hidden to make sure that you have the freedom to
+distribute copies of free software (and charge for
+this service if you wish), that you receive source
+code or can get it if you want it, that you can
+change the software or use pieces of it in new free
+programs; and that you know you can do these things.
address@hidden smallexample
+
+The @code{@@address@hidden commands use the same font style as their
+normal counterparts: @code{@@smallexample} and @code{@@smalllisp} use
+a fixed-width font, and everything else uses the regular font.
+They also have the same behavior in other respects---whether filling
+is done and whether margins are narrowed.
+
+As a general rule, a printed document looks better if you use only one
+of (for instance) @code{@@example} or @code{@@smallexample}
+consistently within a chapter.
+
+
+
+
@node Lists and Tables
@chapter Lists and Tables
@cindex Making lists and tables
@@ -8159,6 +8114,11 @@
If you want to list two or more named items with a single block of
text, use the @code{@@itemx} command. (@address@hidden@@itemx}}.)
+The @code{@@table} command (@address@hidden@@table}}) is not supported
+inside @code{@@display}. Since @code{@@display} is line-oriented, it
+doesn't make sense to use them together. If you want to indent a
+table, try @code{@@quotation} (@address@hidden@@quotation}}) or
address@hidden@@indentedblock} (@address@hidden@@indentedblock}}).
@node @code{@@ftable @@vtable}
@subsection @code{@@ftable} and @code{@@vtable}
@@ -14552,6 +14512,7 @@
* Include Files Requirements:: @code{texinfo-multiple-files-update} needs.
* Sample Include File:: A sample outer file with included files
within it; and a sample included file.
+* @code{@@verbatiminclude}:: Including a file verbatim.
* Include Files Evolution:: How use of the @code{@@include} command
has changed over time.
@end menu
@@ -14758,6 +14719,44 @@
files.
address@hidden @code{@@verbatiminclude}
address@hidden @code{@@verbatiminclude} @var{file}: Include a File Verbatim
+
address@hidden@c old name
address@hidden verbatiminclude
address@hidden Verbatim, include file
address@hidden Including a file verbatim
+
+You can include the exact contents of a file in the document with the
address@hidden@@verbatiminclude} command:
+
address@hidden
+@@verbatiminclude @var{filename}
address@hidden example
+
+The contents of @var{filename} is printed in a verbatim environment
+(@address@hidden@@verbatim}}). Generally, the file is printed exactly
+as it is, with all special characters and white space retained. No
+indentation is added; if you want indentation, enclose the
address@hidden@@verbatiminclude} within @code{@@example}
+(@address@hidden@@example}}).
+
+The name of the file is taken literally, with a single exception:
address@hidden@@address@hidden@address@hidden references are expanded. This
makes it
+possible to include files in other directories within a distribution,
+for instance:
+
address@hidden
+@@verbatiminclude @@address@hidden@}/NEWS
address@hidden example
+
address@hidden (You still have to get @code{top_srcdir} defined in the
+first place.)
+
+For a method on printing the file contents in a smaller font size, see
+the end of the section on @code{@@verbatim}.
+
+
@node Include Files Evolution
@section Evolution of Include Files
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6735] Quotations and Examples chapter some rearrangement,
Gavin D. Smith <=