[nongnu] elpa/hyperdrive 056cf07150 05/13: Docs: Use special formatting for user options

[ELPA Syncer]

branch: elpa/hyperdrive
commit 056cf071503ba11d25f2d547e612c783fc91061a
Author: Joseph Turner <joseph@ushin.org>
Commit: Joseph Turner <joseph@ushin.org>

    Docs: Use special formatting for user options
    
    Resolves #125
---
 doc/hyperdrive.org  | 184 +++++++++++++++++++++-------------------
 doc/hyperdrive.texi | 235 ++++++++++++++++++++++------------------------------
 2 files changed, 198 insertions(+), 221 deletions(-)

diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index e87c552815..dae5248bf7 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -818,92 +818,106 @@ DNS domains are checked for suspicious characters (see
 You can customize the following variables settings by running ~M-x
 customize-group RET hyperdrive RET~:
 
-#+vindex: hyperdrive-hyper-gateway-port
-- ~hyperdrive-hyper-gateway-port~ :: Port on which to run the
-  hyper-gateway server. Defaults to ~4973~.
-
-#+vindex: hyperdrive-honor-auto-mode-alist
-- ~hyperdrive-honor-auto-mode-alist~ :: If non-nil, use file extension
-  of hyperdrive file to set ~major-mode~. Defaults to ~t~.
-
-#+vindex: hyperdrive-persist-location
-- ~hyperdrive-persist-location~ :: Location where ~persist~ will store
-  data, currently ~hyperdrive-hyperdrives~ and ~hyperdrive-version-ranges~.
-  By default, uses the default ~persist~ location.
-
-#+vindex: hyperdrive-download-directory
-- ~hyperdrive-download-directory~ :: Location where
-  ~hyperdrive-download-url~ will download files. Defaults to
-  ~eww-download-directory~ or, if not bound, the home directory.
-
-#+vindex: hyperdrive-timestamp-format
-- ~hyperdrive-timestamp-format~ :: Format string used for
-  timestamps. Passed to ~format-time-string~, which see.
-
-#+vindex: hyperdrive-directory-display-buffer-action
-- ~hyperdrive-directory-display-buffer-action~ :: Display buffer action
-  for hyperdrive directories. Passed to ~display-buffer~, which see.
-
-#+vindex: hyperdrive-directory-sort
-- ~hyperdrive-directory-sort~ :: Column by which directory entries are sorted.
-Internally, a cons cell of (COLUMN . DIRECTION), the COLUMn being one
-of the directory listing columns (~name~, ~size~, or ~mtime~) and
-DIRECTION being one of ~:ascending~ or ~:descending~.
-
-#+vindex: hyperdrive-history-display-buffer-action
-- ~hyperdrive-history-display-buffer-action~ :: Display buffer action
-  for hyperdrive history buffers. Passed to ~display-buffer~, which see.
-
-#+vindex: hyperdrive-stream-player-command
-- ~hyperdrive-stream-player-command~ :: Command used to play streamable
-  URLs externally. Default uses [[https://mpv.io/][mpv]]. There also exists a 
preconfigured
-  option for [[https://www.videolan.org/vlc/][VLC media player]].
-
-#+vindex: hyperdrive-queue-limit
-- ~hyperdrive-queue-limit~ :: Default number of request sent to
-  ~hyper-gateway~ at a time in a queues. Defaults to ~20~.
-
-#+vindex: hyperdrive-fill-version-ranges-limit
-- ~hyperdrive-queue-limit~ :: Default maximum number of requests when
-  filling version history. Defaults to ~10~.
-
-#+vindex: hyperdrive-render-html
-- ~hyperdrive-render-html~ :: Control how HTML hyperdrive files are
-  displayed. By default, HTML pages are rendered in Emacs with 
[[info:eww#Top][EWW]]. If
-  ~nil~, raw HTML will be displayed.
-
-#+vindex: hyperdrive-reuse-buffers
-- ~hyperdrive-reuse-buffers~ :: How to reuse buffers when showing entries.
-  By default (~any-version~), opening a hyperdrive file or directory
-  reuses a buffer that is already visiting it, regardless of
-  version. To have separate buffers for each version of a
-  file/directory, use ~same-version~.
-
-#+vindex: hyperdrive-preferred-formats
-- ~hyperdrive-preferred-formats~ :: List of metadata types used to
-  display hyperdrives.  Hyperdrives are displayed using the first
-  available metadata type.  See [[*Naming][Naming]] section for what this 
means.
-
-#+vindex: hyperdrive-default-entry-format
-- ~hyperdrive-default-entry-format~ :: Format string for displaying
-  hyperdrive entries (files/directories).  By default, entries are
-  displayed with the preferred hyperdrive format in brackets (see
-  ~hyperdrive-preferred-formats~), followed by the full entry path,
-  followed by "version: " and version in parentheses.
-
-#+vindex: hyperdrive-buffer-name-format
-- ~hyperdrive-buffer-name-format~ :: Format string for buffer names of
-  buffers visiting hyperdrive files/directories.  By default, this
-  format is like ~hyperdrive-default-entry-format~ with the entry name
-  sans directory instead of the full path.
+- User Option: hyperdrive-hyper-gateway-port ::
 
-#+vindex: hyperdrive-formats
-- ~hyperdrive-formats~ :: Alist mapping hyperdrive and hyperdrive
-  entry metadata to a format string, used in
-  ~hyperdrive-default-entry-format~ and ~hyperdrive-buffer-name-format~ as
-  well as other places hyperdrives or entries are displayed.  By
-  default, each metadatum is prefixed by its type, e.g., the petname
-  ~foo~ is displayed by default as ~petname:foo~.
+  Port on which to run the hyper-gateway server.  Defaults to ~4973~.
+
+- User Option: hyperdrive-honor-auto-mode-alist ::
+
+  If non-nil, use file extension of hyperdrive file to set ~major-mode~.
+  Defaults to ~t~.
+
+- User Option: hyperdrive-persist-location ::
+
+  Location where ~persist~ will store data, currently
+  ~hyperdrive-hyperdrives~ and ~hyperdrive-version-ranges~.  By default,
+  uses the default ~persist~ location.
+
+- User Option: hyperdrive-download-directory ::
+
+  Location where ~hyperdrive-download-url~ will download files.  Defaults
+  to ~eww-download-directory~ or, if not bound, the home directory.
+
+- User Option: hyperdrive-timestamp-format ::
+
+  Format string used for timestamps.  Passed to ~format-time-string~,
+  which see.
+
+- User Option: hyperdrive-directory-display-buffer-action ::
+
+  Display buffer action for hyperdrive directories.  Passed to
+  ~display-buffer~, which see.
+
+- User Option: hyperdrive-directory-sort ::
+
+  Column by which directory entries are sorted by default.
+  Internally, a cons cell of (COLUMN .  DIRECTION), the COLUMN being
+  one of the directory listing columns (~name~, ~size~, or ~mtime~) and
+  DIRECTION being one of ~:ascending~ or ~:descending~.
+
+- User Option: hyperdrive-history-display-buffer-action ::
+
+  Display buffer action for hyperdrive history buffers.  Passed to
+  ~display-buffer~, which see.
+
+- User Option: hyperdrive-stream-player-command ::
+
+  Command used to play streamable URLs externally.  Default uses
+  [[https://mpv.io/][mpv]].  There also exists a preconfigured option for 
[[https://www.videolan.org/vlc/][VLC media player]].
+
+- User Option: hyperdrive-queue-limit ::
+
+  Default number of request sent to ~hyper-gateway~ at a time in a
+  queues.  Defaults to ~20~.
+
+- User Option: hyperdrive-fill-version-ranges-limit ::
+
+  Default maximum number of requests when filling version history.
+  Defaults to ~10~.
+
+- User Option: hyperdrive-render-html ::
+
+  Control how HTML hyperdrive files are displayed.  By default, HTML
+  pages are rendered in Emacs with [[info:eww#Top][EWW]].  If ~nil~, raw HTML 
will be
+  displayed.
+
+- User Option: hyperdrive-reuse-buffers ::
+
+  How to reuse buffers when showing entries.  By default
+  (~any-version~), opening a hyperdrive file or directory reuses a
+  buffer that is already visiting it, regardless of version.  To have
+  separate buffers for each version of a file/directory, use
+  ~same-version~.
+
+- User Option: hyperdrive-preferred-formats ::
+
+  List of metadata types used to display hyperdrives.  Hyperdrives are
+  displayed using the first available metadata type.  See [[*Naming][Naming]]
+  section for what this means.
+
+- User Option: hyperdrive-default-entry-format ::
+
+  Format string for displaying hyperdrive entries (files/directories).
+  By default, entries are displayed with the preferred hyperdrive
+  format in brackets (see ~hyperdrive-preferred-formats~), followed by
+  the full entry path, followed by "version: " and version in
+  parentheses.
+
+- User Option: hyperdrive-buffer-name-format ::
+
+  Format string for buffer names of buffers visiting hyperdrive
+  files/directories.  By default, this format is like
+  ~hyperdrive-default-entry-format~ with the entry name sans directory
+  instead of the full path.
+
+- User Option: hyperdrive-formats ::
+
+  Alist mapping hyperdrive and hyperdrive entry metadata to a format
+  string, used in ~hyperdrive-default-entry-format~ and
+  ~hyperdrive-buffer-name-format~ as well as other places hyperdrives or
+  entries are displayed.  By default, each metadatum is prefixed by
+  its type, e.g., the petname ~foo~ is displayed by default as
+  ~petname:foo~.
 
   Feel free to adjust the following example configuration for
   abbreviated labels:
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 14e92f523a..d0b6c2a0da 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -1246,142 +1246,105 @@ DNS domains are checked for suspicious characters (see
 You can customize the following variables settings by running @code{M-x
 customize-group RET hyperdrive RET}:
 
-@vindex hyperdrive-hyper-gateway-port
-@table @asis
-@item @code{hyperdrive-hyper-gateway-port}
-Port on which to run the
-hyper-gateway server. Defaults to @code{4973}.
-@end table
-
-@vindex hyperdrive-honor-auto-mode-alist
-@table @asis
-@item @code{hyperdrive-honor-auto-mode-alist}
-If non-nil, use file extension
-of hyperdrive file to set @code{major-mode}. Defaults to @code{t}.
-@end table
-
-@vindex hyperdrive-persist-location
-@table @asis
-@item @code{hyperdrive-persist-location}
-Location where @code{persist} will store
-data, currently @code{hyperdrive-hyperdrives} and 
@code{hyperdrive-version-ranges}.
-By default, uses the default @code{persist} location.
-@end table
-
-@vindex hyperdrive-download-directory
-@table @asis
-@item @code{hyperdrive-download-directory}
-Location where
-@code{hyperdrive-download-url} will download files. Defaults to
-@code{eww-download-directory} or, if not bound, the home directory.
-@end table
-
-@vindex hyperdrive-timestamp-format
-@table @asis
-@item @code{hyperdrive-timestamp-format}
-Format string used for
-timestamps. Passed to @code{format-time-string}, which see.
-@end table
-
-@vindex hyperdrive-directory-display-buffer-action
-@table @asis
-@item @code{hyperdrive-directory-display-buffer-action}
-Display buffer action
-for hyperdrive directories. Passed to @code{display-buffer}, which see.
-@end table
-
-@vindex hyperdrive-directory-sort
-@table @asis
-@item @code{hyperdrive-directory-sort}
-Column by which directory entries are sorted.
-@end table
-Internally, a cons cell of (COLUMN . DIRECTION), the COLUMn being one
-of the directory listing columns (@code{name}, @code{size}, or @code{mtime}) 
and
+@defopt hyperdrive-hyper-gateway-port
+Port on which to run the hyper-gateway server.  Defaults to @code{4973}.
+@end defopt
+
+@defopt hyperdrive-honor-auto-mode-alist
+If non-nil, use file extension of hyperdrive file to set @code{major-mode}.
+Defaults to @code{t}.
+@end defopt
+
+@defopt hyperdrive-persist-location
+Location where @code{persist} will store data, currently
+@code{hyperdrive-hyperdrives} and @code{hyperdrive-version-ranges}.  By 
default,
+uses the default @code{persist} location.
+@end defopt
+
+@defopt hyperdrive-download-directory
+Location where @code{hyperdrive-download-url} will download files.  Defaults
+to @code{eww-download-directory} or, if not bound, the home directory.
+@end defopt
+
+@defopt hyperdrive-timestamp-format
+Format string used for timestamps.  Passed to @code{format-time-string},
+which see.
+@end defopt
+
+@defopt hyperdrive-directory-display-buffer-action
+Display buffer action for hyperdrive directories.  Passed to
+@code{display-buffer}, which see.
+@end defopt
+
+@defopt hyperdrive-directory-sort
+Column by which directory entries are sorted by default.
+Internally, a cons cell of (COLUMN .  DIRECTION), the COLUMN being
+one of the directory listing columns (@code{name}, @code{size}, or 
@code{mtime}) and
 DIRECTION being one of @code{:ascending} or @code{:descending}.
-
-@vindex hyperdrive-history-display-buffer-action
-@table @asis
-@item @code{hyperdrive-history-display-buffer-action}
-Display buffer action
-for hyperdrive history buffers. Passed to @code{display-buffer}, which see.
-@end table
-
-@vindex hyperdrive-stream-player-command
-@table @asis
-@item @code{hyperdrive-stream-player-command}
-Command used to play streamable
-URLs externally. Default uses @uref{https://mpv.io/, mpv}. There also exists a 
preconfigured
-option for @uref{https://www.videolan.org/vlc/, VLC media player}.
-@end table
-
-@vindex hyperdrive-queue-limit
-@table @asis
-@item @code{hyperdrive-queue-limit}
-Default number of request sent to
-@code{hyper-gateway} at a time in a queues. Defaults to @code{20}.
-@end table
-
-@vindex hyperdrive-fill-version-ranges-limit
-@table @asis
-@item @code{hyperdrive-queue-limit}
-Default maximum number of requests when
-filling version history. Defaults to @code{10}.
-@end table
-
-@vindex hyperdrive-render-html
-@table @asis
-@item @code{hyperdrive-render-html}
-Control how HTML hyperdrive files are
-displayed. By default, HTML pages are rendered in Emacs with 
@ref{Top,EWW,,eww,}. If
-@code{nil}, raw HTML will be displayed.
-@end table
-
-@vindex hyperdrive-reuse-buffers
-@table @asis
-@item @code{hyperdrive-reuse-buffers}
-How to reuse buffers when showing entries.
-By default (@code{any-version}), opening a hyperdrive file or directory
-reuses a buffer that is already visiting it, regardless of
-version. To have separate buffers for each version of a
-file/directory, use @code{same-version}.
-@end table
-
-@vindex hyperdrive-preferred-formats
-@table @asis
-@item @code{hyperdrive-preferred-formats}
-List of metadata types used to
-display hyperdrives.  Hyperdrives are displayed using the first
-available metadata type.  See @ref{Naming} section for what this means.
-@end table
-
-@vindex hyperdrive-default-entry-format
-@table @asis
-@item @code{hyperdrive-default-entry-format}
-Format string for displaying
-hyperdrive entries (files/directories).  By default, entries are
-displayed with the preferred hyperdrive format in brackets (see
-@code{hyperdrive-preferred-formats}), followed by the full entry path,
-followed by ``version: '' and version in parentheses.
-@end table
-
-@vindex hyperdrive-buffer-name-format
-@table @asis
-@item @code{hyperdrive-buffer-name-format}
-Format string for buffer names of
-buffers visiting hyperdrive files/directories.  By default, this
-format is like @code{hyperdrive-default-entry-format} with the entry name
-sans directory instead of the full path.
-@end table
-
-@vindex hyperdrive-formats
-@table @asis
-@item @code{hyperdrive-formats}
-Alist mapping hyperdrive and hyperdrive
-entry metadata to a format string, used in
-@code{hyperdrive-default-entry-format} and 
@code{hyperdrive-buffer-name-format} as
-well as other places hyperdrives or entries are displayed.  By
-default, each metadatum is prefixed by its type, e.g., the petname
-@code{foo} is displayed by default as @code{petname:foo}.
+@end defopt
+
+@defopt hyperdrive-history-display-buffer-action
+Display buffer action for hyperdrive history buffers.  Passed to
+@code{display-buffer}, which see.
+@end defopt
+
+@defopt hyperdrive-stream-player-command
+Command used to play streamable URLs externally.  Default uses
+@uref{https://mpv.io/, mpv}.  There also exists a preconfigured option for 
@uref{https://www.videolan.org/vlc/, VLC media player}.
+@end defopt
+
+@defopt hyperdrive-queue-limit
+Default number of request sent to @code{hyper-gateway} at a time in a
+queues.  Defaults to @code{20}.
+@end defopt
+
+@defopt hyperdrive-fill-version-ranges-limit
+Default maximum number of requests when filling version history.
+Defaults to @code{10}.
+@end defopt
+
+@defopt hyperdrive-render-html
+Control how HTML hyperdrive files are displayed.  By default, HTML
+pages are rendered in Emacs with @ref{Top,EWW,,eww,}.  If @code{nil}, raw HTML 
will be
+displayed.
+@end defopt
+
+@defopt hyperdrive-reuse-buffers
+How to reuse buffers when showing entries.  By default
+(@code{any-version}), opening a hyperdrive file or directory reuses a
+buffer that is already visiting it, regardless of version.  To have
+separate buffers for each version of a file/directory, use
+@code{same-version}.
+@end defopt
+
+@defopt hyperdrive-preferred-formats
+List of metadata types used to display hyperdrives.  Hyperdrives are
+displayed using the first available metadata type.  See @ref{Naming}
+section for what this means.
+@end defopt
+
+@defopt hyperdrive-default-entry-format
+Format string for displaying hyperdrive entries (files/directories).
+By default, entries are displayed with the preferred hyperdrive
+format in brackets (see @code{hyperdrive-preferred-formats}), followed by
+the full entry path, followed by ``version: '' and version in
+parentheses.
+@end defopt
+
+@defopt hyperdrive-buffer-name-format
+Format string for buffer names of buffers visiting hyperdrive
+files/directories.  By default, this format is like
+@code{hyperdrive-default-entry-format} with the entry name sans directory
+instead of the full path.
+@end defopt
+
+@defopt hyperdrive-formats
+Alist mapping hyperdrive and hyperdrive entry metadata to a format
+string, used in @code{hyperdrive-default-entry-format} and
+@code{hyperdrive-buffer-name-format} as well as other places hyperdrives or
+entries are displayed.  By default, each metadatum is prefixed by
+its type, e.g., the petname @code{foo} is displayed by default as
+@code{petname:foo}.
 
 Feel free to adjust the following example configuration for
 abbreviated labels:
@@ -1400,7 +1363,7 @@ abbreviated labels:
 
 With this snippet, the petname @code{foo} now displays as @code{p:foo}.  For 
further
 customization, run @code{M-x customize-group RET ~hyperdrive-entry-format}.
-@end table
+@end defopt
 
 @menu
 * Additional customization::