[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi util/htmlxref...
From: |
Karl Berry |
Subject: |
texinfo ChangeLog doc/texinfo.txi util/htmlxref... |
Date: |
Sat, 30 Oct 2010 17:27:15 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: Karl Berry <karl> 10/10/30 17:27:15
Modified files:
. : ChangeLog
doc : texinfo.txi
util : htmlxref.cnf
Log message:
(HTML Customization for External References): rename+edit; "cross
reference" not "cross-reference"
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1168&r2=1.1169
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.336&r2=1.337
http://cvs.savannah.gnu.org/viewcvs/texinfo/util/htmlxref.cnf?cvsroot=texinfo&r1=1.25&r2=1.26
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1168
retrieving revision 1.1169
diff -u -b -r1.1168 -r1.1169
--- ChangeLog 29 Oct 2010 17:50:20 -0000 1.1168
+++ ChangeLog 30 Oct 2010 17:27:11 -0000 1.1169
@@ -1,3 +1,10 @@
+2010-10-30 Karl Berry <address@hidden>
+
+ * doc/texinfo.txi (HTML Customization for External References):
+ rename+edit.
+ Change "cross-reference" to "cross reference" throughout,
+ for consistency.
+
2010-10-29 Karl Berry <address@hidden>
* doc/texinfo.txi (HTML Customization for Title Commands): rename+edit.
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.336
retrieving revision 1.337
diff -u -b -r1.336 -r1.337
--- doc/texinfo.txi 29 Oct 2010 17:50:21 -0000 1.336
+++ doc/texinfo.txi 30 Oct 2010 17:27:12 -0000 1.337
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.336 2010/10/29 17:50:21 karl Exp $
address@hidden $Id: texinfo.txi,v 1.337 2010/10/30 17:27:12 karl Exp $
@c Ordinarily, Texinfo files have the extension .texi. But texinfo.texi
@c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
@@ -298,7 +298,7 @@
* Node Menu Illustration:: A diagram, and sample nodes and menus.
* node:: Creating nodes, in detail.
* makeinfo Pointer Creation:: Letting makeinfo determine node pointers.
-* anchor:: Defining arbitrary cross-reference targets.
+* anchor:: Defining arbitrary cross reference targets.
The @code{@@node} Command
@@ -642,9 +642,9 @@
* HTML Translation:: Details of the HTML output.
* HTML Splitting:: How HTML output is split.
* HTML CSS:: Influencing HTML output with Cascading Style Sheets.
-* HTML Xref:: Cross-references in HTML output.
+* HTML Xref:: Cross references in HTML output.
-HTML Cross-references
+HTML Cross references
* Link Basics: HTML Xref Link Basics.
* Node Expansion: HTML Xref Node Name Expansion.
@@ -715,7 +715,7 @@
* Menu: Info Format Menu.
* Image: Info Format Image.
* Printindex: Info Format Printindex.
-* Cross-reference: Info Format Cross-reference.
+* Xref: Info Format Cross Reference.
@end detailmenu
@end menu
@@ -892,12 +892,12 @@
(Generated via @command{makeinfo}.) This format is essentially a
plain text transliteration of the Texinfo source. It adds a few
control characters to separate nodes and provide navigational
-information for menus, cross-references, indices, and so on. See the
+information for menus, cross references, indices, and so on. See the
next section (@pxref{Info Files}) for more details on this format.
The Emacs Info subsystem (@pxref{Top,,Getting Started,info, Info}),
-and the standalone @command{info} program (@pxref{Top
-,, Info Standalone, info-stnd, GNU Info}), among others, can read these
-files. @xref{Creating and Installing Info Files}.
+and the standalone @command{info} program (@pxref{Top ,, Info
+Standalone, info-stnd, GNU Info}), among others, can read these files.
address@hidden and Installing Info Files}.
@item Plain text
@cindex Plain text output
@@ -2967,8 +2967,8 @@
@pindex texinfo.cnf
The @code{@@setfilename} line produces no output when you typeset a
manual with @TeX{}, but it is nevertheless essential: it opens the
-index, cross-reference, and other auxiliary files used by Texinfo, and
-also reads @file{texinfo.cnf} if that file is present on your system
+index and other auxiliary files used by Texinfo, and also reads
address@hidden if that file is present on your system
(@pxref{Preparing for TeX,, Preparing for @TeX{}}).
If there is no @code{@@setfilename} line, @code{makeinfo} uses the
@@ -4811,7 +4811,7 @@
chapters, sections, subsections, and the like, provide structure for
printed books.
-Because node names are used in cross-references, it is not desirable
+Because node names are used in cross references, it is not desirable
to casually change them. Such name changes invalidate references from
other manuals, from mail archives, and so on.
@@ -4821,7 +4821,7 @@
* Node Menu Illustration:: A diagram, and sample nodes and menus.
* node:: Creating nodes, in detail.
* makeinfo Pointer Creation:: Letting makeinfo determine node pointers.
-* anchor:: Defining arbitrary cross-reference targets.
+* anchor:: Defining arbitrary cross reference targets.
@end menu
@@ -5354,16 +5354,16 @@
@node anchor
address@hidden @code{@@anchor}: Defining Arbitrary Cross-reference Targets
address@hidden @code{@@anchor}: Defining Arbitrary Cross Reference Targets
@findex anchor
@cindex Anchors
address@hidden Cross-reference targets, arbitrary
address@hidden Targets for cross-references, arbitrary
address@hidden Cross reference targets, arbitrary
address@hidden Targets for cross references, arbitrary
-An @dfn{anchor} is a position in your document, labeled so that
-cross-references can refer to it, just as they can to nodes. You create
-an anchor with the @code{@@anchor} command, and give the label as a
+An @dfn{anchor} is a position in your document, labeled so that cross
+references can refer to it, just as they can to nodes. You create an
+anchor with the @code{@@anchor} command, and give the label as a
normal brace-delimited argument. For example:
@example
@@ -5382,9 +5382,8 @@
As you can see, the @code{@@anchor} command itself produces no output.
This example defines an anchor `x-spot' just before the word `spot'.
-You can refer to it later with an @code{@@xref} or other cross-reference
-command, as shown. @xref{Cross References}, for details on the
-cross-reference commands.
+You can refer to it later with an @code{@@xref} or other cross
+reference command, as shown (@pxref{Cross References}).
It is best to put @code{@@anchor} commands just before the position you
wish to refer to; that way, the reader's eye is led on to the correct
@@ -5783,8 +5782,9 @@
@table @code
@item @@xref
-Used to start a sentence in the printed manual saying @w{`See @dots{}'}
-or an Info cross-reference saying @samp{*Note @var{name}: @var{node}.}.
+Used to start a sentence in the printed manual saying @w{`See
address@hidden'} or an Info cross reference saying @samp{*Note @var{name}:
address@hidden
@item @@ref
Used within or, more often, at the end of a sentence; same as
@@ -6435,7 +6435,7 @@
You should write a period or comma immediately after an @code{@@ref}
command with two or more arguments. If there is no such following
punctuation, @command{makeinfo} will generate a (grammatically
-incorrect) period in the Info output; otherwise, the cross-reference
+incorrect) period in the Info output; otherwise, the cross reference
would fail completely, due to the current syntax of Info format.
In general, it is best to use @code{@@ref} only when you need some
@@ -9354,9 +9354,9 @@
cross-referencing will simply use a bare number.
@item label
-Specifies a cross-reference label for this float. If given, this
+Specifies a cross reference label for this float. If given, this
float is automatically given a number, and will appear in any
address@hidden@@listoffloats} output (@pxref{listoffloats}). Cross-references
address@hidden@@listoffloats} output (@pxref{listoffloats}). Cross references
to @var{label} are allowed.
@cindex Floats, making unnumbered
@@ -9474,7 +9474,7 @@
HTML, each line is a link to the float. In printed output, the page
number is included.
-Unnumbered floats (those without cross-reference labels) are omitted
+Unnumbered floats (those without cross reference labels) are omitted
from the list of floats.
@@ -9740,7 +9740,7 @@
In Info, the reference mark for a footnote is a pair of parentheses
with the footnote number between them, like this: @samp{(1)}. The
-reference mark is followed by a cross-reference link to the footnote's
+reference mark is followed by a cross reference link to the footnote's
text.
In the HTML output, footnote references are marked with a small,
@@ -13883,7 +13883,7 @@
@cindex Document strings, translation of
For Info and other online output, this command changes the translation
-of various @dfn{document strings} such as ``see'' in cross-references
+of various @dfn{document strings} such as ``see'' in cross references
(@pxref{Cross References}), ``Function' in defuns (@pxref{Definition
Commands}), and so on. Some strings, such as ``Node:'', ``Next:'',
``Menu:'', etc., are keywords in Info output, so are not translated
@@ -14997,14 +14997,14 @@
up-to-date index entries.
Finally, you may need to run @code{tex} one more time, to get the page
-numbers in the cross-references correct.
+numbers in the cross references correct.
To summarize, this is a five step process:
@enumerate
@item
Run @code{tex} on your Texinfo file. This generates a DVI file (with
-undefined cross-references and no indices), and the raw index files
+undefined cross references and no indices), and the raw index files
(with two letter extensions).
@item
@@ -15013,15 +15013,16 @@
@item
Run @code{tex} again on your Texinfo file. This regenerates the DVI
-file, this time with indices and defined cross-references, but with page
-numbers for the cross-references from last time, generally incorrect.
+file, this time with indices and defined cross references, but with
+page numbers for the cross references from the previous run, generally
+incorrect.
@item
Sort the indices again, with @code{texindex}.
@item
Run @code{tex} one last time. This time the correct page numbers are
-written for the cross-references.
+written for the cross references.
@end enumerate
@pindex texi2dvi
@@ -15039,10 +15040,10 @@
@cindex Chapters, formatting one at a time
Sometimes you may wish to print a document while you know it is
incomplete, or to print just one chapter of a document. In that case,
-the usual auxiliary files that @TeX{} creates and warnings @TeX{} gives
-when cross-references are not satisfied are just nuisances. You can
-avoid them with the @code{@@novalidate} command, which you must give
address@hidden the @code{@@setfilename} command
+the usual auxiliary files that @TeX{} creates and warnings @TeX{}
+gives when cross references are not satisfied are just nuisances. You
+can avoid them with the @code{@@novalidate} command, which you must
+give @emph{before} the @code{@@setfilename} command
(@pxref{setfilename,,@code{@@setfilename}}). Thus, the beginning of
your file would look approximately like this:
@@ -15064,7 +15065,7 @@
The @code{texi2dvi} command automatically runs both @TeX{} and
@command{texindex} as many times as necessary to produce a DVI file
-with sorted indices and all cross-references resolved. It is
+with sorted indices and all cross references resolved. It is
therefore simpler than manually executing the
@address@hidden@address@hidden sequence
described in the previous section.
@@ -16464,9 +16465,9 @@
of the next chapter.
@item
-Every node except `Top' should be referenced by at least one other node,
-either via the `Previous' or `Next' links, or via a menu or a
-cross-reference.
+Every node except `Top' should be referenced by at least one other
+node, either via the `Previous' or `Next' links, or via a menu or a
+cross reference.
@end enumerate
@@ -16567,7 +16568,7 @@
on the value of other configuration variables or command line options,
like split, @code{NODE_FILENAMES}.
@item SHORT_REF
-For HTML. If this is set internal cross-references are given without the
+For HTML. If this is set internal cross references are given without the
@samp{section} word, even if the target of the reference is a section.
@item IDX_SUMMARY
If set, for each @code{@@printindex}, a file @file{<document name>_<index
name>.idx}
@@ -16686,7 +16687,7 @@
@item TOP_NODE_FILE
File used for the Top node, if @code{NODE_FILENAMES} is set.
@item TOP_NODE_FILE_TARGET
-File used for Top node in cross-reference.
+File used for Top node in cross reference.
@item SHOW_TITLE
For HTML.
If set, output the title at the beginning of the document.
@@ -16700,15 +16701,15 @@
Use simple headers formatting, not in a table and using node names.
@item USE_ACCESSKEY
For HTML.
-Use accesskey in cross-references.
+Use accesskey in cross references.
@item USE_REL_REV
For HTML.
-Use @code{rel} in cross-references.
+Use @code{rel} in cross references.
@item USE_LINKS
For HTML.
generate @code{<link>} elements in HTML @code{<head>}.
@item OVERVIEW_LINK_TO_TOC
-If set the cross-references in Overview link to the corresponding
+If set the cross references in Overview link to the corresponding
Table of Contents entry.
@item AVOID_MENU_REDUNDANCY
if set and menu entry equals menu description, then do not print
@@ -16742,9 +16743,9 @@
the image.
@item USE_NODE_TARGET
If set, use the node associated with a section for section target in
-cross-references.
+cross references.
@item NEW_CROSSREF_STYLE
-If unset use an old cross-reference schema. This is a backward compatibility
+If unset use an old cross reference schema. This is a backward compatibility
setting, you should certainly never unset this variable.
@item PROGRAM_NAME_IN_FOOTER
For HTML.
@@ -16767,7 +16768,7 @@
the classical charset name in HTML.
@item EXTERNAL_CROSSREF_SPLIT
-For cross-references to other manuals, this determines if the other
+For cross references to other manuals, this determines if the other
manual is considered to be split or monolithic. In the default case
set based on @code{SPLIT}. @xref{HTML Xref}, and see @ref{HTML Xref
Configuration}.
@@ -17719,7 +17720,7 @@
* HTML Translation:: Details of the HTML output.
* HTML Splitting:: How HTML output is split.
* HTML CSS:: Influencing HTML output with Cascading Style Sheets.
-* HTML Xref:: Cross-references in HTML output.
+* HTML Xref:: Cross references in HTML output.
@end menu
@@ -17788,7 +17789,7 @@
names are constructed after the name of the node associated with the
relevant sectioning command. Also, unless @option{--no-node-files} is
specified, a redirection file is output for every node in order to
-more reliably support cross-references to that manual (@pxref{HTML
+more reliably support cross references to that manual (@pxref{HTML
Xref}).
When splitting, the HTML output files are written into a subdirectory,
@@ -17924,11 +17925,11 @@
@node HTML Xref
address@hidden HTML Cross-references
address@hidden HTML cross-references
address@hidden Cross-references, in HTML output
address@hidden HTML Cross References
address@hidden HTML cross references
address@hidden Cross references, in HTML output
-Cross-references between Texinfo manuals in HTML format amount, in the
+Cross references between Texinfo manuals in HTML format amount, in the
end, to a standard HTML @code{<a>} link, but the details are
unfortunately complex. This section describes the algorithm used in
detail, so that Texinfo can cooperate with other programs, such as
@@ -17959,8 +17960,8 @@
@node HTML Xref Link Basics
address@hidden HTML Cross-reference Link Basics
address@hidden HTML cross-reference link basics
address@hidden HTML Cross Reference Link Basics
address@hidden HTML cross reference link basics
For our purposes, an HTML link consists of four components: a host
name, a directory part, a file part, and a target part. We
@@ -17971,7 +17972,7 @@
@end example
The information to construct a link comes from the node name and
-manual name in the cross-reference command in the Texinfo source
+manual name in the cross reference command in the Texinfo source
(@pxref{Cross References}), and from @dfn{external information}, which
is currently simply hardwired. In the future, it may come from an
external data file.
@@ -17984,7 +17985,7 @@
The @var{dir} and @var{file} parts are more complicated, and depend on
the relative split/mono nature of both the manual being processed and
-the manual that the cross-reference refers to. The underlying idea is
+the manual that the cross reference refers to. The underlying idea is
that there is one directory for Texinfo manuals in HTML, and a given
@var{manual} is either available as a monolithic file
@address@hidden, or a split subdirectory
@@ -18017,10 +18018,10 @@
kludge (due to XHTML rules) is not necessary for filenames, and is
therefore omitted.
-Any directory part in the filename argument of the source
-cross-reference command is ignored. Thus,
@code{@@address@hidden,,,../address@hidden
-and @code{@@address@hidden,,,address@hidden both use @samp{foo} as the manual
name.
-This is because any such attempted hardwiring of the directory is very
+Any directory part in the filename argument of the source cross
+reference command is ignored. Thus,
@code{@@address@hidden,,,../address@hidden and
address@hidden@@address@hidden,,,address@hidden both use @samp{foo} as the
manual name. This
+is because any such attempted hardwiring of the directory is very
unlikely to be useful for both Info and HTML output.
Finally, the @var{target} part is always the expanded node name.
@@ -18039,26 +18040,26 @@
@node HTML Xref Node Name Expansion
address@hidden HTML Cross-reference Node Name Expansion
address@hidden HTML cross-reference node name expansion
address@hidden node name expansion, in HTML cross-references
address@hidden expansion, of node names in HTML cross-references
-
-As mentioned in the previous section, the key part of the HTML
-cross-reference algorithm is the conversion of node names in the
-Texinfo source into strings suitable for XHTML identifiers and
-filenames. The restrictions are similar for each: plain ASCII
-letters, numbers, and the @samp{-} and @samp{_} characters are all
-that can be used. (Although HTML anchors can contain most characters,
-XHTML is more restrictive.)
address@hidden HTML Cross Reference Node Name Expansion
address@hidden HTML cross reference node name expansion
address@hidden node name expansion, in HTML cross references
address@hidden expansion, of node names in HTML cross references
+
+As mentioned in the previous section, the key part of the HTML cross
+reference algorithm is the conversion of node names in the Texinfo
+source into strings suitable for XHTML identifiers and filenames. The
+restrictions are similar for each: plain ASCII letters, numbers, and
+the @samp{-} and @samp{_} characters are all that can be used.
+(Although HTML anchors can contain most characters, XHTML is more
+restrictive.)
-Cross-references in Texinfo can actually refer either to nodes or
-anchors (@pxref{anchor}), but anchors are treated identically to nodes
+Cross references in Texinfo can refer either to nodes or anchors
+(@pxref{anchor}). However, anchors are treated identically to nodes
in this context, so we'll continue to say ``node'' names for
simplicity.
-(@@-commands and 8-bit characters are not presently handled by
address@hidden for HTML cross-references. See the next section.)
+@@-commands and 8-bit characters are not presently handled by
address@hidden for HTML cross references. See the next section.
A special exception: the Top node (@pxref{The Top Node}) is always
mapped to the file @file{index.html}, to match web server software.
@@ -18133,13 +18134,13 @@
@node HTML Xref Command Expansion
address@hidden HTML Cross-reference Command Expansion
address@hidden HTML cross-reference command expansion
address@hidden HTML Cross Reference Command Expansion
address@hidden HTML cross reference command expansion
In standard Texinfo, node names may not contain @@-commands. xxx
@command{makeinfo} supports @@-commands in node names, but @TeX{}
might not. Therefore, even if @command{makeinfo} implements this part
-of the HTML cross-reference algorithm, you should still avoid using
+of the HTML cross reference algorithm, you should still avoid using
@@-commands in node names.
First, comments are removed.
@@ -18227,11 +18228,11 @@
@node HTML Xref 8-bit Character Expansion
address@hidden HTML Cross-reference 8-bit Character Expansion
address@hidden HTML cross-reference 8-bit character expansion
address@hidden 8-bit characters, in HTML cross-references
address@hidden Expansion of 8-bit characters in HTML cross-references
address@hidden Transliteration of 8-bit characters in HTML cross-references
address@hidden HTML Cross Reference 8-bit Character Expansion
address@hidden HTML cross reference 8-bit character expansion
address@hidden 8-bit characters, in HTML cross references
address@hidden Expansion of 8-bit characters in HTML cross references
address@hidden Transliteration of 8-bit characters in HTML cross references
Usually, characters other than plain 7-bit ASCII are transformed into
the corresponding Unicode code point(s) in Normalization address@hidden,
@@ -18283,12 +18284,12 @@
@node HTML Xref Mismatch
address@hidden HTML Cross-reference Mismatch
address@hidden HTML cross-reference mismatch
address@hidden Mismatched HTML cross-reference source and target
address@hidden HTML Cross Reference Mismatch
address@hidden HTML cross reference mismatch
address@hidden Mismatched HTML cross reference source and target
As mentioned earlier (@pxref{HTML Xref Link Basics}), the generating
-software has to guess whether a given manual being cross-referenced is
+software has to guess whether a given manual being cross referenced is
available in split or monolithic form---and, inevitably, it might
guess wrong. However, when the referent manual is generated, it is
possible to handle at least some mismatches.
@@ -18326,20 +18327,20 @@
Once again, this is something the software which generated the
@emph{referent} manual has to do in advance, it's not something the
-software generating the cross-reference in the present manual can
+software generating the cross reference in the present manual can
control.
@node HTML Xref Configuration
address@hidden HTML Cross-reference Configuration: @file{htmlxref.cnf}
address@hidden HTML Cross Reference Configuration: @file{htmlxref.cnf}
@pindex htmlxref.cnf
address@hidden HTML cross-reference configuration
address@hidden Cross-reference configuration, for HTML
address@hidden HTML cross reference configuration
address@hidden Cross reference configuration, for HTML
@cindex Configuration, for HTML cross-manual references
@command{makeinfo} reads a file named @file{htmlxref.cnf} to gather
-information for cross-references to other manuals in HTML output. It
+information for cross references to other manuals in HTML output. It
is looked for in the following directories:
@table @file
@@ -18408,17 +18409,17 @@
hello chapter address@hidden@}/hello/manual/html_chapter/
@end smallexample
address@hidden monolithic manuals, for HTML cross-references
address@hidden monolithic manuals, for HTML cross references
If the keyword is @code{mono}, @var{urlprefix} gives the host,
directory, and file name for @var{manual} as one monolithic file.
address@hidden split manuals, for HTML cross-references
address@hidden split manuals, for HTML cross references
If the keyword is @code{node}, @code{section}, or @code{chapter},
@var{urlprefix} gives the host and directory for @var{manual} split
into nodes, sections, or chapters, respectively.
When available, @command{makeinfo} will use the ``corresponding''
-value for cross-references between manuals. That is, when generating
+value for cross references between manuals. That is, when generating
monolithic output (@option{--no-split}), the @code{mono} url will be
used, when generating output that is split by node, the @code{node}
url will be used, etc. However, if a manual is not available in that
@@ -18432,7 +18433,7 @@
mono @result{} mono, chapter, section, split
@end smallexample
address@hidden address@hidden, and HTML cross-references}
address@hidden address@hidden, and HTML cross references}
These section- and chapter-level cross-manual references can succeed
only when the target manual was created using @option{--node-files};
this is the default for split output.
@@ -18444,11 +18445,11 @@
@node HTML Xref Link Preservation
address@hidden HTML Cross-reference Link Preservation: @address@hidden
address@hidden HTML Cross Reference Link Preservation: @address@hidden
@pindex noderename.cnf
@pindex @var{manual}-noderename.cnf
address@hidden HTML cross-reference link preservation
address@hidden HTML cross reference link preservation
@cindex Preserving HTML links to old nodes
@cindex Old nodes, preserving links to
@cindex Renaming nodes, and preserving links
@@ -18521,7 +18522,7 @@
* Customizing Output-Related Names:: File names and target names.
* Customizing HTML Headings::
* Customizing HTML Basic Commands::
-* References and footnotes formatting::
+* Customizing HTML References::
* Block commands formatting::
* Paragraph and preformatted region::
* Lists tables and definitions formatting::
@@ -19413,7 +19414,7 @@
@vindex documentlanguage @r{configuration variable}
@command{texi2any} writes some fixed strings in the generated document
-at various places: for cross-references, in page footers, on the help
+at various places: for cross references, in page footers, on the help
page, alternate text for images, and so on. The string chosen depends
on the value of the configuration variable @code{documentlanguage} at
the time of the string being output (@pxref{documentlanguage}, for the
@@ -21501,54 +21502,92 @@
Customization}.
address@hidden References and footnotes formatting
address@hidden References and footnotes formatting
address@hidden Customizing HTML References
address@hidden Customizing HTML References
+
address@hidden References, HTML customization for
@menu
-* Formatting a reference to an external manual::
+* External: HTML Customization for External References.
* Formatting a reference within a manual::
* Footnotes formatting::
@end menu
address@hidden Formatting a reference to an external manual
address@hidden Formatting a reference to an external manual
address@hidden HTML Customization for External References
address@hidden HTML Customization for External References
-The references are produced with two function references, one for the
-hypertextual reference construction, the other for the full reference to
-external manual.
-
address@hidden {Function Reference} $href external_href $node $node_identifier
$xml_node_identifier $manual_file_name
address@hidden is the node name, with @@-commands. @var{$node_identifer} is the
-node name mapped to an identifier acceptable as a file name.
address@hidden is the
-node name mapped to an identifier acceptable as an @acronym{XML} identifier.
-Those identifiers are built as explained in @ref{HTML Xref,,,texinfo,GNU
Texinfo},
-thus allowing for cross references to external manuals. @var{$file} is the
-manual or file name of the external reference. This function should return an
-href leading to the external manual.
-
-In HTML, the default for this function is to make a reference compatible with
address@hidden Xref}.
address@hidden deftypefn
-
address@hidden {Function Reference} $text external_ref $command $section $book
$file $href $cross_ref_name \@@args_texi \@@formatted_args $node
-This function formats a reference to an external Texinfo manual.
-The @var{$command} is the reference command (@code{ref}, @code{xref},
address@hidden or @code{inforef}).
-The optionnal @var{$section} argument is the section in the book and
address@hidden is the book title.
address@hidden is the manual file name. @var{$href} is an hypertextual
-reference to the distant manual constructed using the above function.
address@hidden is an optionnal cross
-reference name appearing in the reference command.
address@hidden@@args_texi} is a reference on an array containing the @@-command
-arguments, not formatted, with @var{\@@formatted_args} contains the formatted
-@@-command arguments. @var{$node} is the node name, formatted.
-This function returns
-the text corresponding with the external html manual reference.
-This function returns the full formatted text of the external reference.
address@hidden HTML customization for external references
address@hidden External references, HTML customization for
+
+These references are produced by one of two function references:
address@hidden is used for menu items which refer to other
+manuals (@pxref{Other Info Files}), while @code{external_ref} is used
+for full external cross references (@pxref{Four and Five Arguments}).
+
address@hidden {Function Reference} $href external_href $node $node_identifier @
+ $xml_node_identifier $file
+This function formats a menu reference to an external Texinfo manual.
+
address@hidden @var
address@hidden $node
+The node name, with @@-commands.
+
address@hidden $node_identifer
+The node name mapped to an identifier acceptable as a file name.
+
address@hidden $xml_node_identifier
+The node name mapped to an identifier acceptable for XML.
+
address@hidden $file
+The manual file name of the external reference.
address@hidden table
+
+The function should return an HTML href for the external reference.
+
address@hidden Xref}, for how the identifiers are built in order to allow
+for cross references to external manuals to succeed.
address@hidden deftypefn
+
address@hidden {Function Reference} $text external_ref $command $section $book @
+ $file $href $cross_ref_name \@@args_texi \@@formatted_args $node
+This function formats a general cross reference to an external Texinfo manual.
+
address@hidden @var
address@hidden $command
+The reference command (@code{ref}, @code{xref}, @code{pxref} or
address@hidden).
+
address@hidden $section
+The section in the external manual; may be empty.
+
address@hidden $book
+The book title; may be empty.
+
address@hidden $file
+The manual file name.
+
address@hidden $href
+An href to the external manual constructed using the above
address@hidden function.
+
address@hidden $cross_ref_name
+Optional cross reference name appearing in the reference command.
+
address@hidden \@@args_texi
+An array reference containing the @@-command arguments, not formatted.
+
address@hidden \@@formatted_args
+Another array reference with the formatted @@-command arguments.
+
address@hidden $node
+The node name, formatted.
address@hidden table
+
+The function should return the HTML text for the external manual
+reference.
@end deftypefn
+
@node Formatting a reference within a manual
@subsection Formatting a reference within a manual
@@ -23115,7 +23154,7 @@
@samp{@@@var{existing}}. @xref{alias}.
@item @@address@hidden@address@hidden
-Define @var{name} as the current location for use as a cross-reference
+Define @var{name} as the current location for use as a cross reference
target. @xref{anchor,, @code{@@anchor}}.
@item @@appendix @var{title}
@@ -24867,7 +24906,7 @@
(@url{http://www.gnu.org/software/rcs}) version control systems, which
expand it into a string such as:
@example
-$Id: texinfo.txi,v 1.336 2010/10/29 17:50:21 karl Exp $
+$Id: texinfo.txi,v 1.337 2010/10/30 17:27:12 karl Exp $
@end example
(This is useful in all sources that use version control, not just manuals.)
You may wish to include the @samp{$Id:} comment in the @code{@@copying}
@@ -24946,7 +24985,7 @@
@verbatim
\input texinfo @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.336 2010/10/29 17:50:21 karl Exp $
address@hidden $Id: texinfo.txi,v 1.337 2010/10/30 17:27:12 karl Exp $
@comment %**start of header
@setfilename sample.info
@include version.texi
@@ -26762,7 +26801,7 @@
* Menu: Info Format Menu.
* Image: Info Format Image.
* Printindex: Info Format Printindex.
-* Cross-reference: Info Format Cross-reference.
+* Xref: Info Format Cross Reference.
@end menu
@@ -26868,10 +26907,10 @@
node `Weather Phenomena'.
address@hidden Info Format Cross-reference
address@hidden Info Format: Cross-reference
address@hidden Info Format Cross Reference
address@hidden Info Format: Cross Reference
address@hidden Cross-references, in Info format
address@hidden Cross references, in Info format
A general cross reference in Info format is written as follows:
@@ -26909,7 +26948,7 @@
on this particular reference.
The third example refers to the node `Top' in another manual, namely
address@hidden, with `Overview' being the label for this cross-reference.
address@hidden, with `Overview' being the label for this cross reference.
@xref{Cross References}.
Index: util/htmlxref.cnf
===================================================================
RCS file: /sources/texinfo/texinfo/util/htmlxref.cnf,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -b -r1.25 -r1.26
--- util/htmlxref.cnf 29 Oct 2010 17:50:22 -0000 1.25
+++ util/htmlxref.cnf 30 Oct 2010 17:27:13 -0000 1.26
@@ -1,6 +1,6 @@
# htmlxref.cnf - reference file for Texinfo files on the web.
-htmlxrefversion=2010-10-29.17; # UTC
+htmlxrefversion=2010-10-30.16; # UTC
# Copyright 2010 Free Software Foundation, Inc.
#
@@ -73,6 +73,8 @@
ddd mono ${GS}/ddd/manual/html_mono/ddd.html
+ddrescue mono ${GS}/ddrescue/manual/ddrescue_manual.html
+
diffutils mono ${GS}/diffutils/manual/diffutils.html
EMACS = ${GS}/emacs/manual
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., (continued)
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/10
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/11
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/12
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/13
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/14
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/15
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/25
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/27
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/28
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/29
- texinfo ChangeLog doc/texinfo.txi util/htmlxref...,
Karl Berry <=
- texinfo ChangeLog doc/texinfo.txi util/htmlxref..., Karl Berry, 2010/10/31