[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/hyperdrive 195a1a0169 09/13: Docs: Use special formatting
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/hyperdrive 195a1a0169 09/13: Docs: Use special formatting for keybindings |
|
Date: |
Thu, 30 Nov 2023 04:00:14 -0500 (EST) |
branch: elpa/hyperdrive
commit 195a1a0169dbc7cfe1756bfa0d0553918f05e23b
Author: Joseph Turner <joseph@ushin.org>
Commit: Joseph Turner <joseph@ushin.org>
Docs: Use special formatting for keybindings
---
doc/hyperdrive.org | 140 ++++++++++++++++++++-----------
doc/hyperdrive.texi | 235 +++++++++++++++++++++++++++-------------------------
2 files changed, 216 insertions(+), 159 deletions(-)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 5e86e9d16a..74db482e8f 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -224,38 +224,68 @@ and a path inside it. ~hyperdrive-view-file~ is like
The following keybindings are available inside the directory view by
default:
-#+kindex: hyperdrive-dir-previous
-#+kindex: hyperdrive-dir-next
-- ~n~ and ~p~ move between entries
-#+kindex: hyperdrive-dir-find-file
-- ~RET~ or opens file or directory at point
-#+kindex: hyperdrive-dir-find-file-other-window
-- ~o~, left click, or middle click opens the file or directory at point
- in a new window
-#+kindex: hyperdrive-dir-view-file
-- ~v~ opens file or directory at point in [[info:emacs#View Mode][view-mode]].
-#+kindex: hyperdrive-up
-- ~^~ goes up to the parent directory
-#+kindex: revert-buffer
-- ~g~ refreshes the directory to display potential updates
-#+kindex: hyperdrive-dir-sort
-- ~s~ sorts directory contents by column (to sort by a different
- column, click on the column header or use the `C-u` universal
- prefix argument)
-#+kindex: hyperdrive-dir-download-file
-- ~d~ downloads the file at point to disk
-#+kindex: hyperdrive-delete
-- ~D~ deletes the file or directory (recursively) at point
-#+kindex: hyperdrive-dir-history
-- ~H~ opens the [[*View the hyperdrive version history][version history]] of
file at point
-#+kindex: hyperdrive-dir-copy-url
-- ~w~ copies the URL of the file or directory at point
-#+kindex: imenu
-- ~j~ opens ~imenu~ to quickly jump to a file in the current directory
-#+kindex: hyperdrive-menu
-- ~?~ opens ~hyperdrive-menu~ (see [[*Hyperdrive menu command][Hyperdrive menu
command]])
-#+kindex: hyperdrive-create-directory-no-op
-- ~+~ signals an error, because you cannot create empty directories ([[*No
empty directories]])
+#+attr_texinfo: :compact t
+- Key: n (hyperdrive-dir-next) ::
+- Key: p (hyperdrive-dir-previous) ::
+
+ Move between entries.
+
+- Key: RET (hyperdrive-dir-find-file) ::
+
+ Open the file or directory at point.
+
+- Key: o (hyperdrive-dir-find-file-other-window) ::
+- Key: <mouse-1> ::
+- Key: <mouse-2> ::
+
+ Open the file or directory at point in a new window.
+
+- Key: v (hyperdrive-dir-view-file) ::
+
+ Open the file or directory at point in [[info:emacs#View Mode][view-mode]].
+
+- Key: ^ (hyperdrive-up) ::
+
+ Go up to the parent directory.
+
+- Key: g (revert-buffer) ::
+
+ Refresh the directory to display potential updates.
+
+- Key: s (hyperdrive-dir-sort) ::
+
+ Sort directory contents by the current column. To sort by a
+ different column, click on the column header or use the universal
+ prefix argument (~C-u s~).
+
+- Key: d (hyperdrive-dir-download-file) ::
+
+ Download the file at point to disk.
+
+- Key: D (hyperdrive-delete) ::
+
+ Delete the file or directory (recursively) at point.
+
+- Key: H (hyperdrive-dir-history) ::
+
+ Open the [[*View the hyperdrive version history][version history]] of file
at point.
+
+- Key: w (hyperdrive-dir-copy-url) ::
+
+ Copy the URL of the file or directory at point.
+
+- Key: j (imenu) ::
+
+ Open ~imenu~ to quickly jump to a file in the current directory.
+
+- Key: ? (hyperdrive-menu) ::
+
+ Open ~hyperdrive-menu~ (see [[*Hyperdrive menu command][Hyperdrive menu
command]]).
+
+- Key: + (hyperdrive-create-directory-no-op) ::
+
+ This command signals an error, because you cannot create empty
+ directories ([[*No empty directories]]).
*** File view
@@ -387,22 +417,36 @@ For an explanation of the history buffer, see [[*Partial
version data]].
The following keybindings are available inside the directory view by
default:
-#+kindex: hyperdrive-history-fill-version-ranges
-- ~+~ loads version history for unknown ranges
-#+kindex: hyperdrive-history-find-file
-- ~RET~ opens the file at the start of the range at point
-#+kindex: hyperdrive-history-find-file-other-window
-- ~o~, left click, or middle click opens the file at the start of the
- range at point at point in a new window
-#+kindex: hyperdrive-history-view-file
-- ~v~ opens the file at the start of the range at point in [[info:emacs#View
Mode][view-mode]]
-#+kindex: hyperdrive-history-copy-url
-- ~w~ copies the URL of the file at the start of the range at point
-#+kindex: hyperdrive-history-download-file
-- ~d~ downloads the file at the start of the range at point
-#+kindex: hyperdrive-history-diff
-- ~=~ displays the differences between the version at point and the
- prior version
+- Key: + (hyperdrive-history-fill-version-ranges) ::
+
+ Load version history for unknown ranges.
+
+- Key: RET (hyperdrive-history-find-file) ::
+
+ Open the file at the start of the range at point.
+
+- Key: o (hyperdrive-history-find-file-other-window) ::
+- Key: <mouse-1> ::
+- Key: <mouse-2> ::
+
+ Open the file at the start of the range at point in a new window.
+
+- Key: v (hyperdrive-history-view-file) ::
+
+ Open the file at the start of the range at point in [[info:emacs#View
Mode][view-mode]].
+
+- Key: w (hyperdrive-history-copy-url) ::
+
+ Copy the URL of the file at the start of the range at point.
+
+- Key: d (hyperdrive-history-download-file) ::
+
+ Download the file at the start of the range at point.
+
+- Key: = (hyperdrive-history-diff) ::
+
+ Display the differences between the version at point and the prior
+ version.
To act on the latest known version of the file, use these keybindings
on the header line displaying the file description.
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index ebb1ff9412..2d84eab817 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -440,80 +440,87 @@ and a path inside it. @code{hyperdrive-view-file} is like
The following keybindings are available inside the directory view by
default:
-@kindex hyperdrive-dir-previous
-@kindex hyperdrive-dir-next
-@itemize
-@item
-@code{n} and @code{p} move between entries
-@end itemize
-@kindex hyperdrive-dir-find-file
-@itemize
-@item
-@code{RET} or opens file or directory at point
-@end itemize
-@kindex hyperdrive-dir-find-file-other-window
-@itemize
-@item
-@code{o}, left click, or middle click opens the file or directory at point
-in a new window
-@end itemize
-@kindex hyperdrive-dir-view-file
-@itemize
-@item
-@code{v} opens file or directory at point in @ref{View Mode,view-mode,,emacs,}.
-@end itemize
-@kindex hyperdrive-up
-@itemize
-@item
-@code{^} goes up to the parent directory
-@end itemize
-@kindex revert-buffer
-@itemize
-@item
-@code{g} refreshes the directory to display potential updates
-@end itemize
-@kindex hyperdrive-dir-sort
-@itemize
-@item
-@code{s} sorts directory contents by column (to sort by a different
-column, click on the column header or use the `C-u` universal
-prefix argument)
-@end itemize
-@kindex hyperdrive-dir-download-file
-@itemize
-@item
-@code{d} downloads the file at point to disk
-@end itemize
-@kindex hyperdrive-delete
-@itemize
-@item
-@code{D} deletes the file or directory (recursively) at point
-@end itemize
-@kindex hyperdrive-dir-history
-@itemize
-@item
-@code{H} opens the @ref{View the hyperdrive version history, , version
history} of file at point
-@end itemize
-@kindex hyperdrive-dir-copy-url
-@itemize
-@item
-@code{w} copies the URL of the file or directory at point
-@end itemize
-@kindex imenu
-@itemize
-@item
-@code{j} opens @code{imenu} to quickly jump to a file in the current directory
-@end itemize
-@kindex hyperdrive-menu
-@itemize
-@item
-@code{?} opens @code{hyperdrive-menu} (see @ref{Hyperdrive menu command})
-@end itemize
-@kindex hyperdrive-create-directory-no-op
-@itemize
-@item
-@code{+} signals an error, because you cannot create empty directories
(@ref{No empty directories})
-@end itemize
+@table @asis
+@item @kbd{n} (@code{hyperdrive-dir-next})
+@itemx @kbd{p} (@code{hyperdrive-dir-previous})
+@kindex n
+@kindex p
+@findex hyperdrive-dir-next
+@findex hyperdrive-dir-previous
+Move between entries.
+
+@item @kbd{@key{RET}} (@code{hyperdrive-dir-find-file})
+@kindex RET
+@findex hyperdrive-dir-find-file
+Open the file or directory at point.
+
+@item @kbd{o} (@code{hyperdrive-dir-find-file-other-window})
+@itemx @kbd{<mouse-1>}
+@itemx @kbd{<mouse-2>}
+@kindex o
+@kindex <mouse-1>
+@kindex <mouse-2>
+@findex hyperdrive-dir-find-file-other-window
+Open the file or directory at point in a new window.
+
+@item @kbd{v} (@code{hyperdrive-dir-view-file})
+@kindex v
+@findex hyperdrive-dir-view-file
+Open the file or directory at point in @ref{View Mode,view-mode,,emacs,}.
+
+@item @kbd{^} (@code{hyperdrive-up})
+@kindex ^
+@findex hyperdrive-up
+Go up to the parent directory.
+
+@item @kbd{g} (@code{revert-buffer})
+@kindex g
+@findex revert-buffer
+Refresh the directory to display potential updates.
+
+@item @kbd{s} (@code{hyperdrive-dir-sort})
+@kindex s
+@findex hyperdrive-dir-sort
+Sort directory contents by the current column. To sort by a
+different column, click on the column header or use the universal
+prefix argument (@code{C-u s}).
+
+@item @kbd{d} (@code{hyperdrive-dir-download-file})
+@kindex d
+@findex hyperdrive-dir-download-file
+Download the file at point to disk.
+
+@item @kbd{D} (@code{hyperdrive-delete})
+@kindex D
+@findex hyperdrive-delete
+Delete the file or directory (recursively) at point.
+
+@item @kbd{H} (@code{hyperdrive-dir-history})
+@kindex H
+@findex hyperdrive-dir-history
+Open the @ref{View the hyperdrive version history, , version history} of file
at point.
+
+@item @kbd{w} (@code{hyperdrive-dir-copy-url})
+@kindex w
+@findex hyperdrive-dir-copy-url
+Copy the URL of the file or directory at point.
+
+@item @kbd{j} (@code{imenu})
+@kindex j
+@findex imenu
+Open @code{imenu} to quickly jump to a file in the current directory.
+
+@item @kbd{?} (@code{hyperdrive-menu})
+@kindex ?
+@findex hyperdrive-menu
+Open @code{hyperdrive-menu} (see @ref{Hyperdrive menu command}).
+
+@item @kbd{+} (@code{hyperdrive-create-directory-no-op})
+@kindex +
+@findex hyperdrive-create-directory-no-op
+This command signals an error, because you cannot create empty
+directories (@ref{No empty directories}).
+@end table
@node File view
@subsection File view
@@ -679,43 +686,49 @@ For an explanation of the history buffer, see
@ref{Partial version data}.
The following keybindings are available inside the directory view by
default:
-@kindex hyperdrive-history-fill-version-ranges
-@itemize
-@item
-@code{+} loads version history for unknown ranges
-@end itemize
-@kindex hyperdrive-history-find-file
-@itemize
-@item
-@code{RET} opens the file at the start of the range at point
-@end itemize
-@kindex hyperdrive-history-find-file-other-window
-@itemize
-@item
-@code{o}, left click, or middle click opens the file at the start of the
-range at point at point in a new window
-@end itemize
-@kindex hyperdrive-history-view-file
-@itemize
-@item
-@code{v} opens the file at the start of the range at point in @ref{View
Mode,view-mode,,emacs,}
-@end itemize
-@kindex hyperdrive-history-copy-url
-@itemize
-@item
-@code{w} copies the URL of the file at the start of the range at point
-@end itemize
-@kindex hyperdrive-history-download-file
-@itemize
-@item
-@code{d} downloads the file at the start of the range at point
-@end itemize
-@kindex hyperdrive-history-diff
-@itemize
-@item
-@code{=} displays the differences between the version at point and the
-prior version
-@end itemize
+@table @asis
+@item @kbd{+} (@code{hyperdrive-history-fill-version-ranges})
+@kindex +
+@findex hyperdrive-history-fill-version-ranges
+Load version history for unknown ranges.
+
+@item @kbd{@key{RET}} (@code{hyperdrive-history-find-file})
+@kindex RET
+@findex hyperdrive-history-find-file
+Open the file at the start of the range at point.
+
+@item @kbd{o} (@code{hyperdrive-history-find-file-other-window})
+@kindex o
+@findex hyperdrive-history-find-file-other-window
+
+@item @kbd{<mouse-1>}
+@kindex <mouse-1>
+
+@item @kbd{<mouse-2>}
+@kindex <mouse-2>
+Open the file at the start of the range at point in a new window.
+
+@item @kbd{v} (@code{hyperdrive-history-view-file})
+@kindex v
+@findex hyperdrive-history-view-file
+Open the file at the start of the range at point in @ref{View
Mode,view-mode,,emacs,}.
+
+@item @kbd{w} (@code{hyperdrive-history-copy-url})
+@kindex w
+@findex hyperdrive-history-copy-url
+Copy the URL of the file at the start of the range at point.
+
+@item @kbd{d} (@code{hyperdrive-history-download-file})
+@kindex d
+@findex hyperdrive-history-download-file
+Download the file at the start of the range at point.
+
+@item @kbd{=} (@code{hyperdrive-history-diff})
+@kindex =
+@findex hyperdrive-history-diff
+Display the differences between the version at point and the prior
+version.
+@end table
To act on the latest known version of the file, use these keybindings
on the header line displaying the file description.
- [nongnu] elpa/hyperdrive updated (758c2444a5 -> 36fe1c9519), ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive aea64fbe1a 03/13: Docs: Add instructions for running hyper-gateway manually, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive fe79886ec8 04/13: Chore: Rebuild texi manual, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 36fe1c9519 13/13: Docs: Fix link, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 6d5a091027 07/13: Docs: Fix typo, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 056cf07150 05/13: Docs: Use special formatting for user options, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 18c1d9eb6e 01/13: Docs: Fix link, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 4650c4c057 02/13: Docs: Update installation instructions for Emacs 28.1+, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 195a1a0169 09/13: Docs: Use special formatting for keybindings,
ELPA Syncer <=
- [nongnu] elpa/hyperdrive 110d7098ca 12/13: Docs: Document hyperdrive-ewoc-{next, previous} in history buffer, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 28c81e2dcc 08/13: Docs: Use special formatting for revert-buffer-quick keybinding, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 8e43eba3db 10/13: Docs: Fix typo, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive 2cef5254bc 11/13: Docs: Fix link, ELPA Syncer, 2023/11/30
- [nongnu] elpa/hyperdrive aca944ef06 06/13: Docs: Put hyperdrive-download-directory option in Download section, ELPA Syncer, 2023/11/30