path: root/Master/texmf-dist/doc/latex/skeycommand/skeycommand-guide.tex

\documentclass[a4paper,10pt,final,language=UKenglish,fancysec,fancyfnote]{amltxdoc}
\makeatletter
\let\sectionbreak\medbreak

\begin{document}

\begin{frontmatter}
\suptitle{}
\title{The \texttt{\color{blue}skeycommand} Package\titleref{t1}}
\iftogon{pdf}{%
  \titlenote[t1]{The package is available at \url{\@titleurl}.}%
}{%
  \titlenote[t1]{The package is available at \url{\@shorttitleurl}.}%
}
\subtitle{Version 0.2}
\titleurl{http://www.ctan.org/tex-archive/macros/latex/contrib/skeycommand/}
\shorttitleurl{http://www.ctan.org/}
\author{Ahmed Musa\Email{a.musa@rocketmail.com}\\Preston, Lancashire, UK}

\redef*\abstractname{\vspace{-\baselineskip}}
\begin{abstract}
\frameshade[width=\hsize,fillcolor=yellow!20,framesep=2pt,framerule=2pt,
  framecolor=brown]{%
  \frameshade[fillcolor=white,width=2.5cm,framecolor=red!60,framerule=2pt]%
  {\centering SUMMARY}\small
  The \pkgm{skeycommand} provides tools for defining \latex-style commands and environments using parameters and keys together. The advantages of keys over parameters include the facts that the former aren't limited to nine but can rise as desired by the user, and keys are much easier to match to their values than parameters to arguments, especially if the parameters are many. Moreover, keys can have natural functions. The design approach and user interfaces in the \pkg{skeycommand} differ from those found in the \pkgm{keycommand}. This package also provides the \acmd{\newtwooptcmd} and \acmd{\newtwooptenviron} macros for defining new commands and environments with two options/optional arguments. At both key command definition and invocation times there is no reference by the user to the semantics of key parsing and management. All the complex semantics and calculations involved in defining and setting keys are transparent to the user. The user of the \pkg{skeycommand} has access to some (but not all) of the machinery of \asty{xkeyval} and \asty{skeyval} packages (including the pointer mechanism) at the much lesser cost of worrying only about the key names and their values. Native boolean keys are automatically recognized and handled appropriately. However, because of the need to keep the user interface simple, toggle boolean keys aren't available in this package; neither are choice keys.
}
\end{abstract}
\pkgm*{xkeyval,skeyval}

\NewLet\licname\licensename
\redef*\licensename{\vspace{-\baselineskip}}
\begin{license}
\frameshade[width=\hsize,fillcolor=white,framesep=2pt,framerule=2pt,
  framecolor=brown]{\small
  \vspace{1ex}\centerline{\licname}\endgraf
  This work (\ie, all the files in the \asty{skeycommand} bundle) may be distributed and/or modified under the conditions of the \lppl (LPPL), either version~1.3 of this license or any later version.
  \endgraf
  The \lppl maintenance status of this software is ``author-maintained''. This software is provided ``as it is,'' without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose.
  \endgraf
  \endgraf\centerline{\makered{\CopyrightYear}}%
}
\end{license}
\end{frontmatter}

\newpage
\frameshade[fillcolor=yellow!20,framecolor=brown,framerule=2pt,framesep=2pt,
  width=\hsize]{\tableofcontents}

\section{Package options}
\label{sec:pack-options}

The package has only one option (namely, \acmdm{verbose}) and can be invoked at the time of loading the package or via the \acmd{\skeycommand} macro. The option \fx{verbose} is a boolean, initially set to false (\ie, its complement, \acmdm{silent}, is true by default). Setting \fx{silent} to \fx{false} is tantamount to setting \fx{verbose} to \fx{true}.
\begin{example}
|comm(In style files:)
\RequirePackage[verbose=true |orr false |orr on |orr off]{skeycommand}

|comm(In document files:)
\usepackage[verbose=true |orr false |orr on |orr off]{skeycommand}

|comm(In all cases:)
\skeycommand{verbose=true |orr false |orr on |orr off}
\end{example}

If you enter the boolean  \fx{verbose} (or \fx{silent}) without value, the value is assumed to be \fx{true}. The \fx{verbose} option is simply passed on to the \pkgm{skeyval} to log informational messages in the transcript file. The major task of key parsing for the \pkg{skeycommand} is undertaken by the \pkgm{skeyval}.

\section{User interfaces}

\subsection{Defining new key commands and environments}

The user interfaces for defining new key commands and environments are as follows:
\begin{macro}
\newkeycmd|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\newkeycmd|redstar|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}

\renewkeycmd|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\renewkeycmd|redstar|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}

\newkeyenviron|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\newkeyenviron|redstar|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}

\renewkeyenviron|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\renewkeyenviron|redstar|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\end{macro}

Here, \ang{cmd} is the new control sequence; \ang{env} is the new environment name; \ang{mprefix} is the prefix for macros deriving from the defined keys whose values will be used in the new command or environment (this is called the \emph{macro prefix} in the parlance of keys); \ang{keyval} is the key-value list [\eg, (\fx{keya=valuea}, \fx{keyb=valueb})]; \ang{narg} is the number of arguments for the new command or environment (excluding the keys), as you would enter it in \fx{\newcommand} and \fx{\newenvironment}; \ang{default1} is the default value for your optional argument (normally the first argument in \fx{\newcommand} and \fx{\newenvironment}); \ang{defn} is the replacement text (as in \fx{\newcommand} and \fx{\newenvironment}). If you don't supply the optional \ang{mprefix}, the package will use the first three letters of the key command or environment name, excluding the escape character but including an added ``at sign'' (\fx{@}). The aim of default ``at sign'' is to aid the visual separation of key names from macro prefixes.

Please note the angle bracket surrounding \ang{mprefix}, and the parenthesis surrounding \ang{keyval} in the above syntaxes. The \ang{mprefix} can't be empty (\ie, don't  enter \texttt{<>}) because it will be used by the package to build unique names for the macros that will hold the key values. You can choose not to enter anything for \ang{mprefix}, and the package will happily use the default prefix \fx{<xxx@>}, where ``\fx{xxx}'' represents the first three letters of the new command or environment name. Also, \ang{keyval} can't be empty: if it was empty, then we should ask: why use key commands instead of \latex's \fx{\newcommand} and \fx{\newenvironment}?

In \ang{defn}, you refer to your arguments in the normal way. You refer to the values of the keys using macros whose first three characters (after the escape character) are the \ang{mprefix} or, if \ang{mprefix} is not supplied, the first three letters of the declared key command (excluding the escape character). The family name of the keys defined via a key command is the key command name itself (without the escape character). The package uses this internally in developing the keys.  The key prefix is always ``KV''. If any of your key values contains parenthesis, simply enclose it in braces, to avoid confusing it with \ang{keyval} list.

The starred variants (\RedStar) give ``short'' macros, while the unstarred variants yield ``long'' macros.

\Note The optional \ang{mprefix} will be useful if you fear clashes with previously defined key commands. Although, to be defined, key commands must be definable, two key commands may have their first three or four characters identical, thereby leading to clashes of their key-value prefixes.

\subsection{Invoking new key commands and environments}

The syntaxes for calling new key commands and environments are as follows:

\begin{macro}
\cmd[|vang(arg1)]{|vang(arg2)}...{|vang(argn)}|:|vang(keyval)|!

\begin{env}[|vang(arg1)]{|vang(arg2)}...{|vang(argn)}|:|vang(keyval)|!
  environment body
\end{env}
\end{macro}
where \fx{\cmd} and \fx{env} have been previously defined using key command and key environment. You refer to your arguments using parameter number one \hash{1} onwards, up to a maximum of \hash{8} (yes, \hash{8}, not \hash{9}). Here, \ang{keyval} (including the parenthesis) are optional arguments: you can omit them if you want to use the values of the keys set at key command definition time. Using keys is preferable to using parameters: you don't have to match parameters to arguments and, in principle, there is no limit to the number of keys that are permissible.

\subsection[Commands with two optional arguments]
{Commands and environments with two optional arguments}

The \pkg{skeycommand} uses the following macros internally. They can be used to define new commands and environments with two optional arguments. Their philosophy, intent, and use syntaxes differ from those of the \pkgm{twoopt}. They may be useful to some users, although I recommend the use of the above key commands.

\begin{macro}
\newtwooptcmd|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\newtwooptcmd|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}

\renewtwooptcmd|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\renewtwooptcmd|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}

\newtwooptenviron|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\newtwooptenviron|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}

\renewtwooptenviron|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\renewtwooptenviron|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\end{macro}

\ang{narg} is the total number of arguments, including the first and second optional arguments.
Where are the second optional arguments here, you might be wondering? The second optional argument is usually empty and doesn't appear at command definition time. The second optional argument isn't the second argument of your command (as in \pkg{twoopt}), but the last. At command invocation, if you don't supply a value for the second optional argument, the command will assume it to be empty. But how do you supply a value for the second optional argument? The next section shows how.

\subsubsection[Invoking commands and environments]
{Invoking commands and environments with two optional arguments}

The syntaxes for calling commands and environments with two optional arguments are as follows:

\begin{macro}
\cmd[|vang(1st optarg)]{|vang(arg2)}...{|vang(argn)}|:|vang(2nd optarg)|!

\begin{env}[|vang(1st optarg)]{|vang(arg2)}...{|vang(argn)}|:|vang(2nd optarg)|!
  environment body
\end{env}
\end{macro}

If \ang{2nd optarg} is empty at command or environment invocation, the command or environment will assume it to be empty. Now you can see the conceptual link between \fx{\newtwooptcmd} (and friends) and \fx{\newkeycmd} (and friends).

\section{Examples}

\begin{example}
|comm(The following is a macro of 3 parameters and 4 keys:)

|makered(\newkeycmd*)\demomacro|:name=Steve,height=1.60m,weight=75kg,
  tested=true|![3][Registered]{%
  \def\x{#1}\def\y{#2}\def\z{#3}%
  \ifdem@tested
    \edef\cleared{\dem@name}%
  \else
    \let\cleared\relax
  \fi
}
|comm(|makered(\dem@name) will hold the value supplied for |makered(`name'))
|comm(by the user of \demomacro. |makered(`dem') is from |makered(`demomacro').)
|comm(Notice the LaTeX-like syntax of this command.)
|comm(The user doesn't have to bother about the nitty-gritty)
|comm(of key infrastructure.)

|comm(You can use the following statement to instruct the user)
|comm(to always supply value for `name' in \demomacro macro:)

|makered(\uservaluekeys)[KV]{demomacro}{name}
\end{example}

Instead of using the macro \acmd{\uservaluekeys}, you can use the full pointer system of the \pkg{skeyval}. For example, the following requires the user to supply a value for `name' and the package will save that value for some later use:
\begin{example}
|makered(\newkeycmd)*\demomacro|:|makered(\uservalue\savevalue|mcolor({)name|mcolor(}))=Steve,
  height=1.60m,wieght=75kg,tested=true|![3][Registered]{%
  \def\x{#1}\def\y{#2}\def\z{#3}%
  \edef\xxx{\dem@name}%
}

|comm(User now calls the \demomacro macro:)
\demomacro[data1]{data2}{data3}|:name,height=1.55m,wieght=55kg,
  tested=true|!
  |makered(|tto Error: no value supplied for `name')
\end{example}

You can use the saved value of key \fx{name} within \fx{\demomacro}. Suppose, oddly, that the key \fx{height} can use the value of the key \fx{name}, then we can do

\begin{example}
\demomacro[data1]{data2}{data3}|:name=John,
  height=|makered(\usevalue){|mcolor(name)},wieght=55kg,tested=true|!
\end{example}

If in \fx{\demomacro} you don't supply a key-value pair, the macro will use the above defaults:
\begin{example}
\demomacro[data1]{data2}{data3}|:name=John,|comm(|makered(height) missing here.)
  weight=55kg,tested=true|!
\end{example}

\begin{example}
|makered(\newkeycmd*)\firstmacro<sk@>|:name=Steve,
  height=1.6m|![8][xxx]{%
  \noindent Name: \sk@name\newline
  Height: \sk@height\newline
  Details: #1#2#3#4#5#6#7#8%
  \newline\newline
}

\begin{document}
\firstmacro[1]{-2}{-3}{-4}{-5}{-6}{-7}{-8}%
  |:name=John {|:Winner|!},height=1.54m|!
\end{document}
\end{example}

\begin{example}
|makered(\newkeyenviron*){vdescription}<skv@>|:labelwidth=5pt,
  labelsep=5pt|![2][\qquad]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\skv@labelwidth
    +\labelsep+\skv@labelsep}}%
  \item[Description Preamble] #2%
}{\end{list}\ignorespacesafterend}

\begin{document}
\begin{vdescription}[Description Postamble]%
  {$\star\star\star$}|:labelwidth=10pt,labelsep=10pt|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] $\langle$End of my
    environment$\rangle$
\end{vdescription}
\end{document}
\end{example}

\begin{example}
\def\@barbara{An author writing an article for publication
  in TUGboat is encouraged to create it on a computer file
  and submit it on magnetic tape.}
\def\barbara{BARBARA BEETON,\\ \emph{How to Prepare a File For
  Publication in TUGboat} |:1981|!}
\def\@hieronymus{The printer should refuse to employ wandering
  men, foreigners who, after having committed some grievous
  error, can easily disappear and return to their own country.}
\def\hieronymus{HIERONYMUS HORNSCHUCH |:1608|!}
\def\@elgar{If I write

|comm(The macros \@barbara, \barbara, etc. are just shorthands:)
|comm(you can enter their contents directly in key commands,)
|comm(as we shall see later.)

|makered(\newkeyenviron){Quote}<mp@>|:leftmargin=\leftmargin,
  rightmargin=\rightmargin,mode=false,whoby=\null,
  source=\null|!{\begin{list}{}{%
    \setlength\leftmargin{\mp@leftmargin}%
    \setlength\rightmargin{\mp@rightmargin}%
  }%
  \item[]\makebox[0pt][r]{``}%
}{%
  \unskip\makebox[0pt][l]{''}%
  \item[] \flushright\mp@whoby
  \item[] \flushleft\small Source: \mp@source
  \end{list}
  \endgraf\vskip\baselineskip
}
\usepackage{lipsum}
\lipsum[1]
\begin{Quote}|:leftmargin=30pt,rightmargin=30pt,mode=false,
  whoby=\barbara,source={The \TeX Book}|!
  {\ifmp@mode\color{red}\else\color{blue}\fi\@barbara}
\end{Quote}

\lipsum[1]
\begin{Quote}|:leftmargin=20pt,rightmargin=20pt,mode=true,
  whoby=\hieronymus,source={The \TeX Book}|!
  {\ifmp@mode\color{red}\else\color{blue}\fi\@hieronymus}
\end{Quote}

\lipsum[1]
\begin{Quote}|:leftmargin=40pt,rightmargin=40pt,mode=false,
  whoby={Edward Elgar},source={Letter to A.\ J.\ Jaeger |:1898|!}|!
  {\ifmp@mode\color{red}\else\color{blue}\fi
    If I write a tune you all say it's commonplace---if I
    don't, you all say it's rot.%
  }%
\end{Quote}

\begin{Quote}|:leftmargin=40pt,rightmargin=40pt,mode=false,
  whoby={Albert Einstein},source={The World As I See It}|!
  {\ifmp@mode\color{red}\else\color{blue}\fi
    If you want to find out anything from the theoretical physicists
    about the methods they use, I advise you to stick closely to
    one principle: don't listen to their words, fix your attention
    on their deeds.%
  }%
\end{Quote}
\end{example}

\begin{example}
\usepackage{lipsum}
\newcounter{notecnt}
\def\noteparameters{\labelsep=\notelabelsep
  \itemindent=\noteitemindent \leftmargin=\noteleftmargin
  \rightmargin=\noterightmargin \labelwidth=\notelabelwidth}

|makered(\newkeyenviron*){note}<note>|:labelsep=8pt,itemindent=8pt,
  leftmargin=\parindent,rightmargin=\parindent,labelwidth=0pt,
  preskip=0ex|![1][\baselineskip]%
  {\begin{list}{\textsc{Note}~\arabic{notecnt}: }%
    {\noteparameters\usecounter{notecnt}}%
      \vskip#1}%
  {\end{list}\ignorespacesafterend}

\begin{document}
\noindent\lipsum[1]
\begin{note}[\notepreskip]|:labelsep=8pt,itemindent=8pt,
  leftmargin=30pt,rightmargin=30pt,labelwidth=0pt,preskip=2ex|!
\item \lipsum[1]
\item \lipsum[1]
\end{note}
\end{document}
\end{example}


\begin{example}
\def\sitation{}
\def\sitparameters{\leftmargin=\sit@leftmargin
  \rightmargin=\sit@rightmargin}
\newbox\sitname
|makered(\renewkeyenviron*){sitation}|:leftmargin=\parindent,
  rightmargin=\parindent,nolinebreak=1|![2][1]%
  {\def\cnolinebreak{#1}\sitparameters\sbox\sitname
    {\textit{#2}}%
    \begin{quote}%
  }%
  {\hspace*{\fill}\nolinebreak[\cnolinebreak]%
    \quad\hspace*{\fill}\finalhyphendemerits\z@
    \box\sitname
  \end{quote}\ignorespacesafterend}

\begin{document}
\begin{sitation}[\sit@nolinebreak]%
  {Hieronymus Hornschuch~|:1608|!}%
  |:leftmargin=30pt,rightmargin=30pt,nolinebreak=2|!
The printer should refuse to employ wandering men,
foreigners who, after having committed some grievous error,
can easily disappear and return to their own country.
\end{sitation}

\begin{sitation}{William Stanley Jevons~|:1878|!}%
Some compositors still object to work in offices where
type-composing machines are introduced. They are all afraid
that if the work is done too easily and rapidly, they will
not be wanted to do it. Justifying and page makeup can't be
done profitably by machines, so the employees needn't fear
losing their jobs.
\end{sitation}
\end{document}
\end{example}

\begin{example}
|makered(\newkeyenviron*){vdescription}|:labelwidth=5pt,
  labelsep=5pt|![2][\qquad]%
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\vde@labelwidth
      +\labelsep+\vde@labelsep}}%
    \item[Description Preamble] #2%
}{\end{list}\ignorespacesafterend}

\begin{document}
\begin{vdescription}[Description Postamble]{+++xxx+++}%
  |:labelwidth=10pt,labelsep=5pt|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] $\langle$End of my
    environment$\rangle$
\end{vdescription}
\end{document}
\end{example}

\begin{example}
|makered(\renewtwooptenviron*){vdescription}[3][\qquad]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\labelsep+#2}}%
    \item[Description Preamble] #3%
  }{\end{list}\ignorespacesafterend}

\begin{document}
\begin{vdescription}[Description Postamble]{4cm}|:{|:Begin
  environment no.\ 1|!}|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] |:End of environment no.\ 1|!
\end{vdescription}
\end{document}
\end{example}

\begin{example}
|makered(\newtwooptenviron*){udescription}[3][\hspace{1cm}]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\labelsep+#3}}%
    \item[Description Preamble] #2%
  }{\end{list}\ignorespacesafterend}

\begin{document}
\begin{udescription}[Description Postamble]{uuu}|:4cm|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] The End
\end{udescription}
\end{document}
\end{example}

\begin{example}
\def\firstmacro{}
|makered(\renewkeycmd*)\firstmacro<skv@>|:name=Steve,
  module=Martian logic,pass=true|![2][\@ptsize]{%
  \edef\x{\skv@name}%
  \wlog{\if0#1 10pt\else\if1#1 11pt\else
    \if2#1 12pt\fi\fi\fi\space font used}%
  \def\y{#2}%
}

\firstmacro[0]{aaa}|:name=John,module=Philosophy,pass=false|!
\end{example}

\begin{example}
|makered(\newtwooptcmd*)\macro[3][xxx]{\def\x{#1}\def\y{#2}\def\z{#3}}
\macro[uuu]{vvv}|:www|!
\macro{vvv}|:www|!
\macro{vvv}
\end{example}

\begin{example}
\SKV@undef\macro
|makered(\newtwooptcmd*)\macro[2][xxx]{\def\x{#1}\def\y{#2}}
\macro[uuu]|:vvv|!
\macro|:vvv|!
\end{example}

\begin{example}
|makered(\renewtwooptcmd)\macro[2][xxx]{\def\x{#1}\long\def\y{#2}}
\macro[uuu]|:\par|!
\macro|:\par|!
\end{example}

\begin{example}
\let\tcl\textcolor
|makered(\newkeycmd*)\firstrule|:raise=.5ex,width=1em,thick=2pt,
  proclaim=false|![1]{%
  \tcl{blue}{\rule[\fir@raise]{\fir@width}{\fir@thick}}%
  #1%
  \tcl{cyan}{\rule[\fir@raise]{\fir@width}{\fir@thick}}%
  \iffir@proclaim \color{red}\fi\textdaggerdbl
}

\usepackage[left=2cm,right=2cm]{geometry}
\begin{document}
\parindent\z@
\begin{tabular*}\textwidth{lr}
\verb+\firstrule{Hello World}|:width=2em,thick=4pt,
  proclaim|!+:|ampersand
  \firstrule{Hello World}|:width=2em,thick=4pt|!\cr
\verb+\firstrule{Hello}|:width=2em,thick=.5pt,
  proclaim=true|!+:|ampersand
  \firstrule{Hello}|:width=2em,thick=.5pt,proclaim=true|!\cr
\verb+\firstrule{Hello World}|:thick=2pt,
  proclaim=true|!+:|ampersand
  \firstrule{Hello World}|:thick=2pt,proclaim=true|!\cr
\verb+\firstrule{Hello World}|:raise=1ex,width=2em,
  thick=1pt|!+:|ampersand
  \firstrule{Hello}|:raise=1ex,width=2em,thick=1pt|!
\end{tabular*}
\end{document}
\end{example}


\begin{example}
\let\tcl\textcolor
|makered(\newkeycmd)\secondrule<mp@>|:raise=.5ex,width=1em,thick=2pt,
  proclaim=false|![2][\tcl{magenta}{$\star$}]{%
  \tcl{cyan}{\rule[\mp@raise]{\mp@width}{\mp@thick}}%
  #1#2#1%
  \tcl{blue}{\rule[\mp@raise]{\mp@width}{\mp@thick}}%
  \ifmp@proclaim \color{red}\fi\textdaggerdbl
}
\usepackage[left=2cm,right=2cm]{geometry}
\begin{document}
\parindent\z@
\begin{tabular*}\textwidth{lr}
\verb+\secondrule[\textbullet]{Hello World}|:width=2em,
  thick=4pt,proclaim|!+:|ampersand
  \secondrule[\textbullet]{Hello World}|:width=2em,
    thick=4pt|!\cr
\verb+\secondrule{Hello}|:width=2em,thick=.5pt,
  proclaim=true|!+:|ampersand
  \secondrule{Hello}|:width=2em,thick=.5pt,proclaim=true|!\cr
\verb+\secondrule{Hello World}|:thick=2pt,
  proclaim=true|!+:|ampersand
  \secondrule{Hello World}|:thick=2pt,proclaim=true|!\cr
\verb+\secondrule{Hello World}|:raise=1ex,width=2em,
  thick=1pt|!+:|ampersand
  \secondrule{Hello}|:raise=1ex,width=2em,thick=1pt|!
\end{tabular*}
\end{document}
\end{example}

\end{document}