summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/ushort/ushort.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/ushort/ushort.txt')
-rw-r--r--Master/texmf-dist/doc/latex/ushort/ushort.txt28
1 files changed, 21 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/latex/ushort/ushort.txt b/Master/texmf-dist/doc/latex/ushort/ushort.txt
index 46128d5c222..06268642c1e 100644
--- a/Master/texmf-dist/doc/latex/ushort/ushort.txt
+++ b/Master/texmf-dist/doc/latex/ushort/ushort.txt
@@ -50,6 +50,7 @@
%%# insert a line like
%%# \catcode`\@=11\relax \input ushort.sty \catcode`\@=12\relax
%%#
+%%# For TeX insiders:
%%# The only LaTeX-specific commands used in `ushort.sty' are:
%%#
%%# \newcommand (only in the form \newcommand{\command}{} to ensure that
@@ -70,13 +71,22 @@
%%# This command is used analogously to \underline with the difference that
%%# the underlines are slightly shorter than usual (and so, in particular,
%%# in concatenations of `\ushort'ed variable names the underlines do not
-%%# merge).
-%%# \ushortd
+%%# merge). The length of the underline is chosen under the assumption that
+%%# the argument is a single character. If you want to underline a variable
+%%# name which consists of more than one character, use instead the command
+%%# \ushortw [Mnemonic: ushort word]
+%%# which is analogous to \ushort but such that the length of the underline
+%%# is chosen appropriate for a `long' argument. (This does not look as
+%%# good as \ushort if the argument is a single character).
+%%# \ushortd [Mnemonic: ushort double]
%%# This is analogous to \ushort except that the underline is doubled.
+%%# \ushortdw [Mnemonic: ushortd word]
+%%# This is analogous to \ushortw except that the underline is doubled.
%%# \ushortdline
%%# This is analogous to \underline except that the underline is doubled.
-%%# This command is internally used by \ushortd and thus redefinitions
-%%# change also the behavior of \ushortd correspondingly.
+%%# This command is internally used by \ushortd and \ushortdw and
+%%# thus redefinitions change also the behavior of \ushortd and \ushortdw
+%%# correspondingly.
%%# In Plain TeX, this macro can be used only in math mode.
%%# \ushortCreate
%%# This can be used to generate a macro which behaves similarly to \ushort
@@ -99,7 +109,9 @@
%%#
%%# This command creates a new macro \Name. It is not tested whether \Name
%%# already exists; if it exists already, it is overridden. In particular,
-%%# it is admissible to use \ushortCreate to redefine \ushort or \ushortd.
+%%# it is admissible to use \ushortCreate to redefine \ushort, \ushortw,
+%%# \ushortd, or \ushortdw. This is the recommended method, if you want to
+%%# change the default values.
%%#
%%# The macro \Name can be used analogously to \underline, but the precise
%%# behavior depends on the arguments of \ushortCreate.
@@ -139,11 +151,13 @@
%%#
%%# Examples:
%%#
-%%# The most important examples are the macros \ushort and \ushortd which
-%%# have been created by
+%%# The most important examples are the macros \ushort, \ushortw, \ushortd,
+%%# and \ushortdw which have been created by
%%#
%%# \ushortCreate{ushort}
+%%# \ushortCreate()[-.1em]{ushortw}
%%# \ushortCreate:\ushortdline{ushortd}
+%%# \ushortCreate:\ushortdline()[-.1em]{ushortdw}
%%#
%%# A further example demonstrating other parameters is
%%#