[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6553] merge two introductory nodes in manual
From: |
Gavin D. Smith |
Subject: |
[6553] merge two introductory nodes in manual |
Date: |
Wed, 19 Aug 2015 14:59:01 +0000 |
Revision: 6553
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6553
Author: gavin
Date: 2015-08-19 14:59:00 +0000 (Wed, 19 Aug 2015)
Log Message:
-----------
merge two introductory nodes in manual
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/texinfo.texi
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-08-19 12:49:55 UTC (rev 6552)
+++ trunk/ChangeLog 2015-08-19 14:59:00 UTC (rev 6553)
@@ -1,5 +1,11 @@
2015-08-19 Gavin Smith <address@hidden>
+ * doc/texinfo.texi (Using Texinfo, Overview): Merge Using
+ Texinfo into the introductory material for the containing
+ chapter.
+
+2015-08-19 Gavin Smith <address@hidden>
+
* doc/texinfo.tex (\defmacro) <non-recursive 0-9 args>: Don't
call \scanmacro in a group. Add comments to distinguish
recursive and non-recursive definitions.
Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi 2015-08-19 12:49:55 UTC (rev 6552)
+++ trunk/doc/texinfo.texi 2015-08-19 14:59:00 UTC (rev 6553)
@@ -126,7 +126,7 @@
The first part of this master menu lists the major nodes in this Info
document, including the @@-command and concept indices. The rest of
-the menu lists all the lower level nodes in the document.
+the menu lists all the lower-level nodes in the document.
@end ifnottex
@menu
@@ -177,7 +177,6 @@
Overview of Texinfo
* Reporting Bugs:: Submitting effective bug reports.
-* Using Texinfo:: Create printed or online output.
* Output Formats:: Overview of the supported output formats.
* Adding Output Formats:: Man pages and implementing new formats.
* Texinfo Document Structure:: How Texinfo manuals are usually arranged.
@@ -771,47 +770,61 @@
@chapter Overview of Texinfo
@cindex Overview of Texinfo
@cindex Texinfo overview
address@hidden Using Texinfo in general
address@hidden Texinfo, introduction to
address@hidden Introduction to Texinfo
address@hidden Texinfo} @c merged node
@dfn{Texinfo} is a documentation system that uses a single source file
to produce both online information and printed output. This means
-that instead of writing two different documents, one for the online
-information and the other for a printed work, you need write only one
-document. Therefore, when the work is revised, you need revise only
-that one document.
+that instead of writing several different documents, one for each output
+format, you need only write one document.
+Using Texinfo, you can create a printed document (via the @TeX{}
+typesetting system) in PDF or PostScript format, including chapters,
+sections, cross-references, and indices. From the same Texinfo source
+file, you can create an HTML output file suitable for use with a web
+browser, you can create an Info file with special features to make
+browsing documentation easy, and also create a Docbook file or a
+transliteration to XML format.
+
address@hidden Source file format
@cindex Semantic markup
-Texinfo's markup commands are almost entirely @dfn{semantic}; that is,
-they specify the intended meaning of text in the document, rather than
-physical formatting instructions.
+A Texinfo source file is a plain text file containing text interspersed
+with @dfn{@@-commands} (words preceded by an @samp{@@}) that tell the
+Texinfo processors what to do. Texinfo's markup commands are almost
+entirely @dfn{semantic}; that is, they specify the intended meaning
+of text in the document, rather than physical formatting instructions.
+You can edit a Texinfo file with any text editor, but it is especially
+convenient to use GNU Emacs since that editor has a special mode,
+called Texinfo mode, that provides various Texinfo-related features.
+(@xref{Texinfo Mode}.)
@cindex Limited scope of Texinfo
-Texinfo was devised for the purpose of writing software documentation
-and manuals. It is not, and was never intended to be, a
-general-purpose formatting program. If you need to lay out a
-newspaper, devise a glossy magazine ad, or follow the exact formatting
-requirements of a publishing house, Texinfo is not the simplest tool.
-On the other hand, if you want to write a good manual for your
-program, Texinfo has many features that will make your job easier.
-Overall, it's intended to let you concentrate on the content, and thus
-provides almost no commands for controlling the final formatting.
+Texinfo was devised specifically for the purpose of writing software
+documentation and manuals. If you want to write a good manual for
+your program, Texinfo has many features which we hope will make your
+job easier. However, it provides almost no commands for controlling
+the final formatting. Texinfo is not intended to be a general-purpose
+formatting program, so if you need to lay out a newspaper, devise a
+glossy magazine ad, or follow the exact formatting requirements of
+a publishing house, Texinfo may not be the simplest tool.
address@hidden Pronounciation of Texinfo
address@hidden
@cindex Spelling of Texinfo
-The first syllable of ``Texinfo'' is pronounced like ``speck'', not
-``hex''. This odd pronunciation is derived from, but is not the same
-as, the pronunciation of @TeX{}. In the word @TeX{}, the @samp{X} is
-actually the Greek letter ``chi'' rather than the English letter
-``ex''. Pronounce @TeX{} as if the @samp{X} were the last sound in
-the name `Bach'; but pronounce Texinfo as if the @samp{x} were a `k'.
address@hidden Pronunciation of Texinfo
Spell ``Texinfo'' with a capital ``T'' and the other letters in
-lowercase.
+lowercase. The first syllable of ``Texinfo'' is pronounced like
+``speck'', not ``hex''. This odd pronunciation is derived from the
+pronunciation of @TeX{}. Pronounce @TeX{} as if the @samp{X} were
+the last sound in the name `Bach'. In the word @TeX{}, the @samp{X}
+is, rather than the English letter ``ex'', actually the Greek letter
+``chi''. } is the official documentation format of the GNU project.
+More information, including manuals for GNU packages, is available
+at the @uref{http://www.gnu.org/doc/, GNU documentation web page}.
-Manuals for most GNU packages are written in Texinfo, and available
-online at @url{http://www.gnu.org/doc}.
-
@menu
* Reporting Bugs:: Submitting effective bug reports.
-* Using Texinfo:: Create printed or online output.
* Output Formats:: Overview of the supported output formats.
* Adding Output Formats:: Man pages and implementing new formats.
* Texinfo Document Structure:: How Texinfo manuals are usually arranged.
@@ -867,41 +880,6 @@
emacs, The GNU Emacs Manual}), and follow the existing coding style.
address@hidden Using Texinfo
address@hidden Using Texinfo
-
address@hidden Using Texinfo in general
address@hidden Texinfo, introduction to
address@hidden Introduction to Texinfo
-
-Using Texinfo, you can create a printed document (via the @TeX{}
-typesetting system) with the normal features of a book, including
-chapters, sections, cross references, and indices. From the same
-Texinfo source file, you can create an Info file with special features
-to make documentation browsing easy. Also from that same source file,
-you can create an HTML output file suitable for use with a web
-browser, a Docbook file, or a transliteration in XML format. See the
-next section for details and sample commands to generate output from
-the source (@pxref{Output Formats}).
-
address@hidden works with virtually all printers; Info works with virtually
-all computer terminals; the HTML output works with virtually all web
-browsers. Thus Texinfo and its output can be used by almost any
-computer user.
-
address@hidden Source file format
-A Texinfo source file is a plain ASCII file containing text
-interspersed with @dfn{@@-commands} (words preceded by an @samp{@@})
-that tell the Texinfo processors what to do. You can edit a Texinfo
-file with any text editor, but it is especially convenient to use GNU
-Emacs since that editor has a special mode, called Texinfo mode, that
-provides various Texinfo-related features. (@xref{Texinfo Mode}.)
-
-Texinfo is the official documentation format of the GNU project. More
-information is available at the @uref{http://www.gnu.org/doc/, GNU
-documentation web page}.
-
-
@node Output Formats
@section Output Formats
@cindex Output formats
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6553] merge two introductory nodes in manual,
Gavin D. Smith <=