help / color / mirror / code / Atom feed
From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: zsh-workers@zsh.org
Subject: [PATCH 4/4] docs: Fix pointers to the `Widgets', `User-defined Widgets', and `Standard Widgets' sections.
Date: Sun, 26 Sep 2021 08:43:47 +0000	[thread overview]
Message-ID: <20210926084347.9927-4-danielsh@tarpaulin.shahaf.local2> (raw)
In-Reply-To: <20210926084347.9927-1-danielsh@tarpaulin.shahaf.local2>

The latter two didn't have their own texinode()s.  Various places, both
those sections' subsections and elsewhere in the manual, linked to the
first section rather than to the third.  For instance, zshcontrib(1)
pointed to "noderef(Miscellaneous) in noderef(Zle Widgets)", even though
the former (currently §18.6.6) is not under the latter (currently §18.4).

Add texinode()s and fix those pointers.
 Doc/Zsh/contrib.yo |  2 +-
 Doc/Zsh/zle.yo     | 22 +++++++++++++---------
 2 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 0781c7eb3..6aca14f04 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -2342,7 +2342,7 @@ directly.
 The tt(bracketed-paste) widget (see ifzman(the subsection `Miscellaneous' in
-zmanref(zshzle))ifnzman(noderef(Miscellaneous) in noderef(Zle Widgets)))
+zmanref(zshzle))ifnzman(noderef(Miscellaneous) in noderef(Standard Widgets)))
 inserts pasted text literally into the editor buffer rather than interpret
 it as keystrokes.  This disables some common usages where the self-insert
 widget is replaced in order to accomplish some extra processing.  An
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index 70dfec333..6948aa5ac 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -728,7 +728,7 @@ enditem()
-texinode(Zle Widgets)(Character Highlighting)(Zle Builtins)(Zsh Line Editor)
+texinode(Zle Widgets)(User-Defined Widgets)(Zle Builtins)(Zsh Line Editor)
 All actions in the editor are performed by `widgets'.  A widget's job is
@@ -736,7 +736,9 @@ simply to perform some small action.  The ZLE commands that key sequences
 in keymaps are bound to are in fact widgets.  Widgets can be user-defined
 or built in.
-The standard widgets built into ZLE are listed in Standard Widgets below.
+The standard widgets built into ZLE are listed in
+ifzman(the section `Standard Widgets' below)\
+ifnzman(noderef(Standard Widgets)).
 Other built-in widgets can be defined by other modules (see
 ifnzman(noderef(Zsh Modules))\
@@ -750,6 +752,7 @@ as shell functions.  When the widget is executed, the corresponding
 shell function is executed, and can perform editing (or other) actions.
 It is recommended that user-defined widgets should not have names
 starting with `tt(.)'.
+texinode(User-Defined Widgets)(Standard Widgets)(Zle Widgets)(Zsh Line Editor)
 sect(User-Defined Widgets)
 cindex(widgets, user-defined)
 User-defined widgets, being implemented as shell functions,
@@ -1206,6 +1209,7 @@ This can be used for detecting switches between the vi command
+texinode(Standard Widgets)(Character Highlighting)(User-Defined Widgets)(Zsh Line Editor)
 sect(Standard Widgets)
 cindex(widgets, standard)
 The following is a list of all the standard widgets,
@@ -1231,7 +1235,7 @@ menu(Completion)
 menu(Text Objects)
-texinode(Movement)(History Control)()(Zle Widgets)
+texinode(Movement)(History Control)()(Standard Widgets)
@@ -1378,7 +1382,7 @@ item(tt(up-line) (unbound) (unbound) (unbound))(
 Move up a line in the buffer.
-texinode(History Control)(Modifying Text)(Movement)(Zle Widgets)
+texinode(History Control)(Modifying Text)(Movement)(Standard Widgets)
 subsect(History Control)
@@ -1726,7 +1730,7 @@ the numeric argument. Zero for both local and imported lines and nonzero for
 only local lines.
-texinode(Modifying Text)(Arguments)(History Control)(Zle Widgets)
+texinode(Modifying Text)(Arguments)(History Control)(Standard Widgets)
 subsect(Modifying Text)
@@ -2052,7 +2056,7 @@ into the kill buffer.
 Arguably, this is what Y should do in vi, but it isn't what it actually does.
-texinode(Arguments)(Completion)(Modifying Text)(Zle Widgets)
+texinode(Arguments)(Completion)(Modifying Text)(Standard Widgets)
@@ -2100,7 +2104,7 @@ example(zle argument-base 16
 zle universal-argument)
-texinode(Completion)(Miscellaneous)(Arguments)(Zle Widgets)
+texinode(Completion)(Miscellaneous)(Arguments)(Standard Widgets)
@@ -2175,7 +2179,7 @@ When a previous completion displayed a list below the prompt, this
 widget can be used to move the prompt below the list.
-texinode(Miscellaneous)(Text Objects)(Completion)(Zle Widgets)
+texinode(Miscellaneous)(Text Objects)(Completion)(Standard Widgets)
@@ -2573,7 +2577,7 @@ If the last command executed was a digit as part of an argument,
 continue the argument.  Otherwise, execute vi-beginning-of-line.
-texinode(Text Objects)()(Miscellaneous)(Zle Widgets)
+texinode(Text Objects)()(Miscellaneous)(Standard Widgets)
 subsect(Text Objects)
 cindex(text objects)
 Text objects are commands that can be used to select a block of text

      parent reply	other threads:[~2021-09-26  8:48 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-26  8:43 [PATCH 1/4] docs: Clean up some subsection references Daniel Shahaf
2021-09-26  8:43 ` [PATCH 2/4] docs: Add texinode()s, so the next commit can link directly to a subsection Daniel Shahaf
2021-09-27 15:41   ` Bart Schaefer
2021-10-12 14:53     ` Daniel Shahaf
2021-09-26  8:43 ` [PATCH 3/4] docs: _wanted: Clarify the example and point to another one Daniel Shahaf
2021-09-27 15:38   ` Bart Schaefer
2021-09-27 15:55     ` Oliver Kiddle
2021-10-12 14:40       ` Daniel Shahaf
2021-09-26  8:43 ` Daniel Shahaf [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210926084347.9927-4-danielsh@tarpaulin.shahaf.local2 \
    --to=d.s@daniel.shahaf.name \
    --cc=zsh-workers@zsh.org \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).