[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: * doc/refcard/txirefcard.tex: Document new comman
From: |
Gavin D. Smith |
Subject: |
branch master updated: * doc/refcard/txirefcard.tex: Document new commands. |
Date: |
Mon, 07 Aug 2023 13:10:58 -0400 |
This is an automated email from the git hooks/post-receive script.
gavin pushed a commit to branch master
in repository texinfo.
The following commit(s) were added to refs/heads/master by this push:
new f3de0fc0b1 * doc/refcard/txirefcard.tex: Document new commands.
f3de0fc0b1 is described below
commit f3de0fc0b15d05c0029b8e035041533433ddb8ea
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Mon Aug 7 18:10:47 2023 +0100
* doc/refcard/txirefcard.tex: Document new commands.
---
ChangeLog | 4 ++++
doc/refcard/txirefcard.tex | 10 ++++++++++
2 files changed, 14 insertions(+)
diff --git a/ChangeLog b/ChangeLog
index 967ac975cf..bb3e460d44 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2023-08-07 Gavin Smith <gavinsmith0123@gmail.com>
+
+ * doc/refcard/txirefcard.tex: Document new commands.
+
2023-08-07 Gavin Smith <gavinsmith0123@gmail.com>
* doc/refcard/txicmdcheck: ignore @item_LINE as this is not
diff --git a/doc/refcard/txirefcard.tex b/doc/refcard/txirefcard.tex
index f76a340299..f8b63f6b89 100644
--- a/doc/refcard/txirefcard.tex
+++ b/doc/refcard/txirefcard.tex
@@ -463,6 +463,9 @@ must be defined on the line immediately preceding
\code{@top}. The
of the Top node do not appear in printed output nor in DocBook output.}
\txicmd{@anchor}{\ttbraced{\var{name}}}{Define \var{name} as the current
location, for use as a cross-reference target.}
\txicmd{@novalidate}{}{Suppress validation of node references and omit
creation of auxiliary files with \TeX.}
+\txicmd{@nodedescription}{description}{Provide description for menu references
+to this node.}
+\txicmd{@nodedescriptionblock}{\dots\code{@end nodedescriptionblock}}{Provide
description for menu references to this node across several lines.}
\section{Chapter structuring}
@@ -517,6 +520,7 @@ of the Top node do not appear in printed output nor in
DocBook output.}
\txicmd{@xref}{\ttbraced{node, \rmbrack[entry], \rmbrack[node-title],
\rmbrack[info-file], \rmbrack[manual]}}{Makes a reference that starts with
`See' in a printed manual. Follow command with punctuation. Only the first
argument is mandatory.}
\txicmd{@pxref}{\ttbraced{node, \rmbrack[entry], \rmbrack[node-title],
\rmbrack[info-file], \rmbrack[manual]}}{Like \code{@xref}, but starts with
`see' instead of `See', and must be used inside parentheses.}
\txicmd{@ref}{\ttbraced{node, \rmbrack[entry], \rmbrack[node-title],
\rmbrack[info-file], \rmbrack[manual]}}{Like \code{@xref}, but produces only
the bare reference without `See' or `see'; must be followed by a punctuation
mark.}
+\txicmd{@link}{\ttbraced{node, \rmbrack[label], \rmbrack[manual]}}{Make a
plain link, with no visible markup. Does nothing for Info.}
References outside of the current manual, to a different Texinfo file have an
\rmbrack[info-file] and/or a \rmbrack[manual] argument. The \txicmdarg{node}
argument can be omitted in that case to refer to a manual as a whole.
@@ -823,6 +827,11 @@ Descriptive text follows, ended by \samp{@end
\var{defcmdname}}.
\txicmdx{@deftypemethod}{class data-type name arguments}{Format a description
for method with a return information in object-oriented programming; equivalent
to \samp{@deftypeop \ttbraced{Method on} \dots}.}
\txicmdx{@deftypeop}{category class data-type name arguments}{Format a
description for an operation with return information in object-oriented
programming.}
+\subsection{Generic definition commands}
+\txicmd{@defblock}{\dots\code{@end ignore}}{Create a block that can contain
definitions.}
+\txicmd{@defline}{category name arguments}{Like \code{@deffn}, but without
creating an index entry.}
+\txicmd{@deftypeline}{category type name arguments}{Like \code{@deftypefn},
but without creating an index entry.}
+
\section{Conditionally (in)visible text}
@@ -875,6 +884,7 @@ Descriptive text follows, ended by \samp{@end
\var{defcmdname}}.
\txicmd{@alias}{new\code{=}existing}{Make the command \code{@new} a synonym
for the existing command \code{@existing}.}
\txicmd{@macro}{macroname \ttbraced{\var{params}} \dots\code{@end
macro}}{Define a new Texinfo command \code{@\var{macroname}}.}
\txicmd{@unmacro}{macroname}{Undefine \code{@\var{macroname}} if it is
defined.}
+\txicmd{@linemacro}{macroname \ttbraced{\var{params}} \dots\code{@end
linemacro}}{Define a new Texinfo command using the rest of the line for
arguments.}
\section{File inclusion}
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: * doc/refcard/txirefcard.tex: Document new commands.,
Gavin D. Smith <=