[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/transient baebe85ceb 239/366: manual: Deal with texinfo
From: |
Jonas Bernoulli |
Subject: |
[elpa] externals/transient baebe85ceb 239/366: manual: Deal with texinfo cross reference idiocy |
Date: |
Tue, 25 Jan 2022 18:54:44 -0500 (EST) |
branch: externals/transient
commit baebe85cebd48442325a0071658226da8ce9dab1
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>
manual: Deal with texinfo cross reference idiocy
See see *note (texinfo)Cross Reference Commands*.
---
.gitignore | 1 +
docs/Makefile | 5 ++++-
docs/transient.org | 4 ++--
docs/transient.texi | 62 ++++++++++++++++++++++++++---------------------------
4 files changed, 38 insertions(+), 34 deletions(-)
diff --git a/.gitignore b/.gitignore
index 668ffb9639..5cde07e1df 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,7 @@
/docs/*.html
/docs/*.info
/docs/*.pdf
+/docs/*.pdf.texi
/docs/dir
/docs/transient/
/lisp/*.elc
diff --git a/docs/Makefile b/docs/Makefile
index 1a75646f56..054776b31e 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -25,6 +25,9 @@ texi:
@$(EMACS) $(ORG_ARGS) $(PKG).org $(ORG_EVAL)
@printf "\n" >> $(PKG).texi
@rm -f $(PKG).texi~
+ @printf "Generating $(PKG).pdf.texi\n"
+ @cp $(PKG).texi $(PKG).pdf.texi
+ @sed -i -e "s/see @ref/@ref/gi" -e ":a;N;$!ba;s/see\n@ref/\n@ref/gi"
$(PKG).texi
%.info: %.texi
@printf "Generating $@\n"
@@ -56,7 +59,7 @@ html-dir: $(PKG).texi
sed -i -e $(HTML_FIXUP_CSS) -e $(HTML_FIXUP_ONLOAD) -e
$(HTML_FIXUP_MENU) $$f ; \
done
-%.pdf: %.texi
+%.pdf: %.pdf.texi
@printf "Generating $@\n"
@texi2pdf --clean $< > /dev/null
diff --git a/docs/transient.org b/docs/transient.org
index fb8cd58ab0..967e351ebf 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -8,7 +8,7 @@
#+TEXINFO_DIR_CATEGORY: Emacs
#+TEXINFO_DIR_TITLE: Transient: (transient).
#+TEXINFO_DIR_DESC: Transient Commands
-#+SUBTITLE: for version 0.3.0
+#+SUBTITLE: for version 0.3.0 (v0.3.0+1)
#+TEXINFO_DEFFN: t
#+OPTIONS: H:4 num:4 toc:2
@@ -37,7 +37,7 @@ Calling a suffix command usually causes the transient to be
exited
but suffix commands can also be configured to not exit the transient.
#+TEXINFO: @noindent
-This manual is for Transient version 0.3.0.
+This manual is for Transient version 0.3.0 (v0.3.0+1).
#+BEGIN_QUOTE
Copyright (C) 2018-2021 Jonas Bernoulli <jonas@bernoul.li>
diff --git a/docs/transient.texi b/docs/transient.texi
index 8a4f956f80..484a1cf437 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -31,7 +31,7 @@ General Public License for more details.
@finalout
@titlepage
@title Transient User and Developer Manual
-@subtitle for version 0.3.0
+@subtitle for version 0.3.0 (v0.3.0+1)
@author Jonas Bernoulli
@page
@vskip 0pt plus 1filll
@@ -65,7 +65,7 @@ Calling a suffix command usually causes the transient to be
exited
but suffix commands can also be configured to not exit the transient.
@noindent
-This manual is for Transient version 0.3.0.
+This manual is for Transient version 0.3.0 (v0.3.0+1).
@quotation
Copyright (C) 2018-2021 Jonas Bernoulli <jonas@@bernoul.li>
@@ -255,14 +255,14 @@ One benefit of the Transient interface is that it
remembers history
not only on a global level ("this command was invoked using these
arguments and previously it was invoked using those other arguments"),
but also remembers the values of individual arguments independently.
-See @ref{Using History}.
+@ref{Using History}.
After a transient prefix command is invoked @code{C-h <key>} can be used to
show the documentation for the infix or suffix command that @code{<key>} is
-bound to (see @ref{Getting Help for Suffix Commands}) and infixes and
+bound to (@ref{Getting Help for Suffix Commands}) and infixes and
suffixes can be removed from the transient using @code{C-x l <key>}. Infixes
and suffixes that are disabled by default can be enabled the same way.
-See @ref{Enabling and Disabling Suffixes}.
+@ref{Enabling and Disabling Suffixes}.
Transient ships with support for a few different types of specialized
infix commands. A command that sets a command line option for example
@@ -421,7 +421,7 @@ The other common commands are described in either the
previous node or
in one of the following nodes.
Some of Transient's key bindings differ from the respective bindings
-of Magit-Popup; see @ref{FAQ} for more information.
+of Magit-Popup; @ref{FAQ} for more information.
@node Saving Values
@section Saving Values
@@ -440,7 +440,7 @@ than outlined above and even customizable.}
If the user does not save the value and just exits using a regular
suffix command, then the value is merely saved to the transient's
history. That value won't be used when the transient is next invoked
-but it is easily accessible (see @ref{Using History}).
+but it is easily accessible (@ref{Using History}).
@table @asis
@kindex C-x s
@@ -711,7 +711,7 @@ buffer. The transient popup buffer is displayed in a
window using
The value of this option has the form @code{(FUNCTION . ALIST)}, where
FUNCTION is a function or a list of functions. Each such function
should accept two arguments: a buffer to display and an alist of the
-same form as ALIST@. See @ref{Choosing Window,,,elisp,}.
+same form as ALIST@. @ref{Choosing Window,,,elisp,}.
The default is @code{(display-buffer-in-side-window (side . bottom))}.
This displays the window at the bottom of the selected frame.
@@ -742,7 +742,7 @@ thin line is drawn instead, using the background color of
the face
@code{transient-separator}. Termcap frames cannot display thin lines and
therefore fallback to treating @code{line} like @code{nil}.
-Otherwise this can be any mode-line format. See @ref{Mode Line
Format,,,elisp,} for details.
+Otherwise this can be any mode-line format. @ref{Mode Line Format,,,elisp,}
for details.
@end defopt
@defopt transient-read-with-initial-input
@@ -825,7 +825,7 @@ to be remapped to @code{fixed-pitch} in that buffer.
@node Modifying Existing Transients
@chapter Modifying Existing Transients
-To an extent transients can be customized interactively, see @ref{Enabling and
Disabling Suffixes}. This section explains how existing transients
+To an extent transients can be customized interactively, @ref{Enabling and
Disabling Suffixes}. This section explains how existing transients
can be further modified non-interactively.
The following functions share a few arguments:
@@ -840,10 +840,10 @@ SUFFIX is a transient infix or suffix specification in
the same form
as expected by @code{transient-define-prefix}. Note that an infix is a
special kind of suffix. Depending on context "suffixes" means
"suffixes (including infixes)" or "non-infix suffixes". Here it
-means the former. See @ref{Suffix Specifications}.
+means the former. @ref{Suffix Specifications}.
SUFFIX may also be a group in the same form as expected by
-@code{transient-define-prefix}. See @ref{Group Specifications}.
+@code{transient-define-prefix}. @ref{Group Specifications}.
@item
@@ -946,7 +946,7 @@ explicitly.
GROUPs add key bindings for infix and suffix commands and specify
how these bindings are presented in the popup buffer. At least one
-GROUP has to be specified. See @ref{Binding Suffix and Infix Commands}.
+GROUP has to be specified. @ref{Binding Suffix and Infix Commands}.
The BODY is optional. If it is omitted, then ARGLIST is ignored and
the function definition becomes:
@@ -980,11 +980,11 @@ the branch whose variables are being configured.
@section Binding Suffix and Infix Commands
The macro @code{transient-define-prefix} is used to define a transient.
-This defines the actual transient prefix command (see @ref{Defining
Transients}) and adds the transient's infix and suffix bindings, as
+This defines the actual transient prefix command (@ref{Defining Transients})
and adds the transient's infix and suffix bindings, as
described below.
Users and third-party packages can add additional bindings using
-functions such as @code{transient-insert-suffix} (See @ref{Modifying Existing
Transients}). These functions take a "suffix specification" as one of
+functions such as @code{transient-insert-suffix} (@ref{Modifying Existing
Transients}). These functions take a "suffix specification" as one of
their arguments, which has the same form as the specifications used in
@code{transient-define-prefix}.
@@ -1003,7 +1003,7 @@ for a set of suffixes.
Several group classes exist, some of which organize suffixes in
subgroups. In most cases the class does not have to be specified
-explicitly, but see @ref{Group Classes}.
+explicitly, but @ref{Group Classes}.
Groups are specified in the call to @code{transient-define-prefix}, using
vectors. Because groups are represented using vectors, we cannot use
@@ -1016,7 +1016,7 @@ Group specifications then have this form:
[@{LEVEL@} @{DESCRIPTION@} @{KEYWORD VALUE@}... ELEMENT...]
@end lisp
-The LEVEL is optional and defaults to 4. See @ref{Enabling and Disabling
Suffixes}.
+The LEVEL is optional and defaults to 4. @ref{Enabling and Disabling
Suffixes}.
The DESCRIPTION is optional. If present it is used as the heading of
the group.
@@ -1049,7 +1049,7 @@ useful while rebase is already in progress; and another
that uses
initiate a rebase.
These predicates can also be used on individual suffixes and are
-only documented once, see @ref{Predicate Slots}.
+only documented once, @ref{Predicate Slots}.
@item
@@ -1111,7 +1111,7 @@ prefix command is defined using
@code{transient-define-prefix}, see
individual suffix command.
The same form is also used when later binding additional commands
-using functions such as @code{transient-insert-suffix}, see @ref{Modifying
Existing Transients}.
+using functions such as @code{transient-insert-suffix}, @ref{Modifying
Existing Transients}.
Note that an infix is a special kind of suffix. Depending on context
"suffixes" means "suffixes (including infixes)" or "non-infix
@@ -1192,7 +1192,7 @@ guessed based on the long argument. If the argument ends
with "="
Finally, details can be specified using optional KEYWORD-VALUE pairs.
Each keyword has to be a keyword symbol, either @code{:class} or a keyword
-argument supported by the constructor of that class. See @ref{Suffix Slots}.
+argument supported by the constructor of that class. @ref{Suffix Slots}.
@node Defining Suffix and Infix Commands
@section Defining Suffix and Infix Commands
@@ -1680,7 +1680,7 @@ object should not affect later invocations.
@item
All suffix and infix classes derive from @code{transient-suffix}, which in
turn derives from @code{transient-child}, from which @code{transient-group}
also
-derives (see @ref{Group Classes}).
+derives (@ref{Group Classes}).
@item
@@ -1689,13 +1689,13 @@ which in turn derives from the @code{transient-suffix}
class.
Infixes are a special type of suffixes. The primary difference is
that infixes always use the @code{transient--do-stay} pre-command, while
-non-infix suffixes use a variety of pre-commands (see @ref{Transient State}).
Doing that is most easily achieved by using this class,
+non-infix suffixes use a variety of pre-commands (@ref{Transient State}).
Doing that is most easily achieved by using this class,
though theoretically it would be possible to define an infix class
that does not do so. If you do that then you get to implement many
methods.
Also, infixes and non-infix suffixes are usually defined using
-different macros (see @ref{Defining Suffix and Infix Commands}).
+different macros (@ref{Defining Suffix and Infix Commands}).
@item
@@ -1888,7 +1888,7 @@ probably don't want that.
@code{transient-suffix} and @code{transient-non-suffix} play a part when
determining whether the currently active transient prefix command
remains active/transient when a suffix or abitrary non-suffix
-command is invoked. See @ref{Transient State}.
+command is invoked. @ref{Transient State}.
@item
@@ -1923,7 +1923,7 @@ of the same symbol.
@item
@code{level} The level of the prefix commands. The suffix commands whose
-layer is equal or lower are displayed. See @ref{Enabling and Disabling
Suffixes}.
+layer is equal or lower are displayed. @ref{Enabling and Disabling Suffixes}.
@item
@@ -1945,7 +1945,7 @@ Here we document most of the slots that are only
available for suffix
objects. Some slots are shared by suffix and group objects, they are
documented in @ref{Predicate Slots}.
-Also see @ref{Suffix Classes}.
+Also @ref{Suffix Classes}.
@subsection Slots of @code{transient-suffix}
@@ -1959,7 +1959,7 @@ Also see @ref{Suffix Classes}.
@item
-@code{transient} Whether to stay transient. See @ref{Transient State}.
+@code{transient} Whether to stay transient. @ref{Transient State}.
@item
@@ -2110,7 +2110,7 @@ the slots documented above, it is a predicate, but it is
used for a
different purpose. The value has to be an integer between 1
and 7. @code{level} controls whether a suffix or a group should be
available depending on user preference.
-See @ref{Enabling and Disabling Suffixes}.
+@ref{Enabling and Disabling Suffixes}.
@node Related Abstractions and Packages
@chapter Related Abstractions and Packages
@@ -2144,7 +2144,7 @@ The following diagrams illustrate some of the differences.
@subsection Regular Prefix Commands
-See @ref{Prefix Keys,,,elisp,}.
+@ref{Prefix Keys,,,elisp,}.
@example
,--> command1 --> (c)
@@ -2156,7 +2156,7 @@ See @ref{Prefix Keys,,,elisp,}.
@subsection Regular Prefix Arguments
-See @ref{Prefix Command Arguments,,,elisp,}.
+@ref{Prefix Command Arguments,,,elisp,}.
@example
,----------------------------------,
@@ -2339,7 +2339,7 @@ covered elsewhere.
@subsection Magit-Popup
-Transient is the successor to Magit-Popup (see @ref{Top,,,magit-popup,}).
+Transient is the successor to Magit-Popup (@ref{Top,,,magit-popup,}).
One major difference between these two implementations of the same
ideas is that while Transient uses transient keymaps and embraces the
- [elpa] externals/transient bcd07e065b 172/366: transient--suffix-symbol: Split from transient--suffix-command, (continued)
- [elpa] externals/transient bcd07e065b 172/366: transient--suffix-symbol: Split from transient--suffix-command, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 293a437d66 206/366: Support padding of keys regardless of the group's class, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 3284f6a0fe 213/366: transient-init-value: Support per-object functions for prefixes, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 809fd048b1 223/366: transient--insert-suffix: Add comments, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient fd2695d12c 217/366: transient--with-emergency-exit: Wrap default debug function, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient f086cb620b 224/366: transient--insert-suffix: Allow same key with different predicates, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 7811dcff82 226/366: Add /docs/*.info to .gitignore, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 8ad5fb83c4 227/366: Remove async-bytecomp kludge, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient d48f2451ec 232/366: transient--pre-exit: Don't log clearing of minibuffer, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 48335f8370 237/366: transient-status: Prevent use while minibuffer is active, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient baebe85ceb 239/366: manual: Deal with texinfo cross reference idiocy,
Jonas Bernoulli <=
- [elpa] externals/transient 8c28b8a4fa 242/366: transient-prefix: Do not initially bind SUFFIX-DESCRIPTION, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient cc16a5eaa7 244/366: transient-{, base-}map: Mention related keymaps in doc-string, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 39c536eab6 245/366: make: Add bump-version target, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 4da0fab7d9 246/366: Release version 0.3.1, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient c145229a89 247/366: Add missing argument to user-error, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient a96818c93a 257/366: transient-display-buffer-action: Correct outdated doc-string, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient ef921d3048 258/366: transient--post-command: Deal with mystery quits, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient a9bdd013f9 259/366: transient-show-help: Use manpage of subprefixes, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient 37684a8cf7 263/366: manual: use ox-texinfo's notoc support, Jonas Bernoulli, 2022/01/25
- [elpa] externals/transient cf5e58a3a7 267/366: make: Automatically set date in changelog, Jonas Bernoulli, 2022/01/25