[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: * doc/texinfo.texi (Generic Definition Commands),
From: |
Gavin D. Smith |
Subject: |
branch master updated: * doc/texinfo.texi (Generic Definition Commands), NEWS: Document @defblock, @defline. |
Date: |
Sat, 04 Mar 2023 14:45:49 -0500 |
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 4b6413f5f4 * doc/texinfo.texi (Generic Definition Commands), NEWS:
Document @defblock, @defline.
4b6413f5f4 is described below
commit 4b6413f5f494f954a3cd7e8963e4706a3dadb172
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Sat Mar 4 19:04:34 2023 +0000
* doc/texinfo.texi (Generic Definition Commands), NEWS:
Document @defblock, @defline.
---
ChangeLog | 5 +++++
NEWS | 3 +++
doc/texinfo.texi | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 69 insertions(+)
diff --git a/ChangeLog b/ChangeLog
index b68b7f890d..fff52819b0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2023-03-04 Gavin Smith <gavinsmith0123@gmail.com>
+
+ * doc/texinfo.texi (Generic Definition Commands), NEWS:
+ Document @defblock, @defline.
+
2023-03-04 Patrice Dumas <pertusus@free.fr>
* tp/Texinfo/Common.pm (parse_node_manual): use same code as XS
diff --git a/NEWS b/NEWS
index 2d2eebfbf3..079b863040 100644
--- a/NEWS
+++ b/NEWS
@@ -10,6 +10,9 @@ See the manual for detailed information.
------------------------------------------------------------------------------
* Language
+ . new generic definition commands, @defblock and @defline, that do not
+ automatically create index entries
+ . index commands end paragraphs
. @cartouche takes an argument to specify the cartouche title
* texi2any
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 1adf13153e..a49c9361ba 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -12120,6 +12120,67 @@ The commands with information on return values are
affected by the
in Typed Languages}).
+@node Generic Definition Commands
+@section Generic Definition Commands
+
+Texinfo provides commands for definitions that do not produce automatic
+index entries.
+
+@findex defblock
+@findex defline
+You create a generic definition environment with @samp{@@defblock}
+paired with @samp{@@end defblock}. Within this environment, use a
+@code{@@defline} line for each symbol you document. For example:
+
+@example
+@@defblock
+@@defline Builtin foo (bar)
+Description of foo.
+@@defline Macro mac (arg1, arg2)
+Description of mac.
+@@end defblock
+@end example
+
+@iftex
+@c doesn't work with texi2any yet
+
+@noindent This produces the output:
+
+@defblock
+@defline Builtin foo (bar)
+Description of foo.
+@defline Macro mac (arg1, arg2)
+Description of mac.
+@end defblock
+
+@end iftex
+
+The syntax of @code{@@defline} is similar to that of @code{@@deffn}.
+The first argument gives a category for the definition. Follow this
+with the symbol name, followed by any parameters. You should surround
+any arguments containing spaces with braces.
+
+To share the same description for multiple symbols, you can put several
+@code{@@defline} lines together. For example:
+
+@example
+@@defblock
+@@defline Function set-var (value)
+@@defline @{Settable Variable@} var
+Description of set-var and var.
+@@end defblock
+@end example
+
+@noindent This produces the output:
+
+@defblock
+@defline Function set-var (value)
+@defline {Settable Variable} var
+Description of set-var and var.
+@end defblock
+
+
+
@node Def Cmd Conventions
@section Conventions for Writing Definitions
@cindex Definition conventions
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: * doc/texinfo.texi (Generic Definition Commands), NEWS: Document @defblock, @defline.,
Gavin D. Smith <=