diff options
author | Karl Berry <karl@freefriends.org> | 2016-10-27 21:23:31 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2016-10-27 21:23:31 +0000 |
commit | aa5b2a5b49cfcd05ec9d1a4f3051320f78c4afbf (patch) | |
tree | 1ab16e5892ca3503125823ab93802a5a5e5a6048 /Master/texmf-dist/doc | |
parent | df9414db777046cce78cd97a995a21ffb3175ce3 (diff) |
nameauth (27oct16)
git-svn-id: svn://tug.org/texlive/trunk@42368 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/nameauth/Makefile | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nameauth/README | 27 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nameauth/README.txt | 27 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nameauth/examples.tex | 372 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nameauth/nameauth.pdf | bin | 860872 -> 874877 bytes |
5 files changed, 122 insertions, 306 deletions
diff --git a/Master/texmf-dist/doc/latex/nameauth/Makefile b/Master/texmf-dist/doc/latex/nameauth/Makefile index e2d3263d43d..aa012f76403 100644 --- a/Master/texmf-dist/doc/latex/nameauth/Makefile +++ b/Master/texmf-dist/doc/latex/nameauth/Makefile @@ -21,7 +21,7 @@ $(NAME).pdf: $(NAME).dtx clean: rm -f $(NAME).{aux,fls,glo,gls,hd,idx,ilg,ind,ins,log,out,toc} README.txt distclean: clean - rm -f $(NAME).{dvi,pdf,sty} README + rm -f $(NAME).{dvi,pdf,sty,synctex.gz} README inst: all mkdir -p $(UTREE)/{tex,source,doc}/latex/$(NAME) cp $(NAME).dtx $(UTREE)/source/latex/$(NAME) diff --git a/Master/texmf-dist/doc/latex/nameauth/README b/Master/texmf-dist/doc/latex/nameauth/README index 418fc47a383..1e50e9ee7e3 100644 --- a/Master/texmf-dist/doc/latex/nameauth/README +++ b/Master/texmf-dist/doc/latex/nameauth/README @@ -1,6 +1,6 @@ | --------:| ---------------------------------------------------------------- -nameauth:| Name authority mechanism for consistency in text and index +nameauth:| Name authority management for consistency in text and index Author:| Charles P. Schaum E-mail:| charles dot schaum at comcast dot net License:| Released under the LaTeX Project Public License v1.3c or later @@ -8,9 +8,9 @@ nameauth:| Name authority mechanism for consistency in text and index Short description: -The nameauth package automates the formatting and indexing of names. -This aids the use of a name authority and the process of textual reordering -and revision without needing to retype name references. +The nameauth package automates the correct formatting and indexing of names +for professional writing. This aids the use of a name authority and the +editing process without needing to retype name references. Files Distribution @@ -29,9 +29,12 @@ www.ctan.org/tex-archive/macros/latex/contrib/nameauth Unpack nameauth.zip in an appropriate directory. -Note that the instructions below assume that you are using a *nix- -compatible computer. If that is otherwise, you will need to modify -these instructions to your needs. +Note that the instructions below assume that you are using a kind of +Unix, BSD, Linux, Mac, or Cygwin under Microsoft Windows. If you have +a different operating environment, you will need to modify these +instructions to your own needs. Please be aware that this package is +designed to be stored in a UTF-8 encoded text file and built in a +Unicode-capable environment. If you have a make utility compatible with GNU make you can type @@ -75,13 +78,16 @@ $TEXMFLOCAL/doc/latex/nameauth pdf file, README, examples.tex The above environment variables often are /usr/local/texlive/texmf-local and ~/texmf. +The make process normally renames the README.txt file created from the dtx file +to just README by using mv (move/rename utility in the *nix userland). Windows +distributions of TeX and LaTeX often keep the txt file as well. + Run mktexlsr with the appropriate level of permissions to complete the install. Testing notes: -This packages works and builds with latex, lualatex, pdflatex, and xelatex. -It can be used with makeindex and texindy. The documentation builds with -lualatex, pdflatex, and xelatex, using makeindex. +This package and documentation work and build with latex, lualatex, pdflatex, +and xelatex. It can be used with makeindex/texindy. For testing, the make file permits one to change the typesetting engine on the command line. The default is to build the package and documentation @@ -93,4 +99,3 @@ This material is subject to the LaTeX Project Public License: http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html Happy TeXing! - diff --git a/Master/texmf-dist/doc/latex/nameauth/README.txt b/Master/texmf-dist/doc/latex/nameauth/README.txt index 418fc47a383..1e50e9ee7e3 100644 --- a/Master/texmf-dist/doc/latex/nameauth/README.txt +++ b/Master/texmf-dist/doc/latex/nameauth/README.txt @@ -1,6 +1,6 @@ | --------:| ---------------------------------------------------------------- -nameauth:| Name authority mechanism for consistency in text and index +nameauth:| Name authority management for consistency in text and index Author:| Charles P. Schaum E-mail:| charles dot schaum at comcast dot net License:| Released under the LaTeX Project Public License v1.3c or later @@ -8,9 +8,9 @@ nameauth:| Name authority mechanism for consistency in text and index Short description: -The nameauth package automates the formatting and indexing of names. -This aids the use of a name authority and the process of textual reordering -and revision without needing to retype name references. +The nameauth package automates the correct formatting and indexing of names +for professional writing. This aids the use of a name authority and the +editing process without needing to retype name references. Files Distribution @@ -29,9 +29,12 @@ www.ctan.org/tex-archive/macros/latex/contrib/nameauth Unpack nameauth.zip in an appropriate directory. -Note that the instructions below assume that you are using a *nix- -compatible computer. If that is otherwise, you will need to modify -these instructions to your needs. +Note that the instructions below assume that you are using a kind of +Unix, BSD, Linux, Mac, or Cygwin under Microsoft Windows. If you have +a different operating environment, you will need to modify these +instructions to your own needs. Please be aware that this package is +designed to be stored in a UTF-8 encoded text file and built in a +Unicode-capable environment. If you have a make utility compatible with GNU make you can type @@ -75,13 +78,16 @@ $TEXMFLOCAL/doc/latex/nameauth pdf file, README, examples.tex The above environment variables often are /usr/local/texlive/texmf-local and ~/texmf. +The make process normally renames the README.txt file created from the dtx file +to just README by using mv (move/rename utility in the *nix userland). Windows +distributions of TeX and LaTeX often keep the txt file as well. + Run mktexlsr with the appropriate level of permissions to complete the install. Testing notes: -This packages works and builds with latex, lualatex, pdflatex, and xelatex. -It can be used with makeindex and texindy. The documentation builds with -lualatex, pdflatex, and xelatex, using makeindex. +This package and documentation work and build with latex, lualatex, pdflatex, +and xelatex. It can be used with makeindex/texindy. For testing, the make file permits one to change the typesetting engine on the command line. The default is to build the package and documentation @@ -93,4 +99,3 @@ This material is subject to the LaTeX Project Public License: http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html Happy TeXing! - diff --git a/Master/texmf-dist/doc/latex/nameauth/examples.tex b/Master/texmf-dist/doc/latex/nameauth/examples.tex index 00eaadd2635..f469316175f 100644 --- a/Master/texmf-dist/doc/latex/nameauth/examples.tex +++ b/Master/texmf-dist/doc/latex/nameauth/examples.tex @@ -1,11 +1,15 @@ -% This is an example file used with the nameauth package. -% See README and nameauth.pdf for copyright info. -% +\documentclass{article} +\usepackage{verbatim} +\begin{document} +%% This is an example file used with the nameauth package. +%% See README and nameauth.pdf for copyright info. +%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Test which LaTeX engine you are using +%% Test which LaTeX engine you are using %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% - +%% +\section*{Test for Latex Engine} +\begin{verbatim} \usepackage{ifxetex} \usepackage{ifluatex} @@ -23,17 +27,18 @@ \usepackage[TS1,T1]{fontenc} \fi \fi - +\end{verbatim} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Print the first use of a name in text and margin +%% Print the first use of a name in text and margin %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% -% Below we print the argument both in the text and in a margin paragraph -% unless we are in internal vertical mode. -% -% This macro is suitable to replace \NamesFormat and \FrontNamesFormat. -% - +%% +%% Below we print the argument both in the text and in a margin paragraph +%% unless we are in internal vertical mode. +%% +%% This macro is suitable to replace \NamesFormat and \FrontNamesFormat. +%% +\section*{First Use in Margin} +\begin{verbatim} \renewcommand*\NamesFormat[1]% {% #1% @@ -42,17 +47,19 @@ \marginpar{\raggedleft\scriptsize #1}% \fi } - +\end{verbatim} +\clearpage %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Print a text tag after first name use +%% Print a text tag after first name use %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% -% Below we print the argument in the text and then we query the text tag -% database to see if we can print a text tag after the argument. -% -% This macro is suitable to replace \NamesFormat and \FrontNamesFormat. -% - +%% +%% Below we print the argument in the text and then we query the text tag +%% database to see if we can print a text tag after the argument. +%% +%% This macro is suitable to replace \NamesFormat and \FrontNamesFormat. +%% +\section*{Text Tag With First Use} +\begin{verbatim} \newif\ifNoTextTag \makeatletter \renewcommand*\NamesFormat[1]% @@ -78,27 +85,27 @@ \global\NoTextTagfalse% } \makeatother - +\end{verbatim} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Surname index entries in small caps -% First surname instances in text are small caps +%% Surname index entries in small caps +%% First surname instances in text are small caps %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% -% Below we create a Boolean value \ifSC and set it true. That means -% the surnames in the index will be in small caps. -% -% We then create a macro \DoFormat that prints its argument in -% small caps if \ifSC is true, or makes no font change -% and prints the the argument. -% -% \MainNameHook ignores its argument, sets \SCfalse to suppress -% small caps in the text only, then uses control sequences and -% token registers internal to the naming macros to parse and -% print the current name values without any formatting. -% -% The hook macro can replace both \MainNameHook and \FrontNameHook. -% - +%% +%% Below we create a Boolean value \ifSC and set it true. That means +%% the surnames in the index will be in small caps. +%% +%% We then create a macro \DoFormat that prints its argument in +%% small caps if \ifSC is true, or makes no font change +%% and prints the the argument. +%% +%% \MainNameHook ignores its argument, sets \SCfalse to suppress +%% small caps in the text only, then calls the name parser used +%% specifically in formatting hooks. +%% +%% The hook macro can replace both \MainNameHook and \FrontNameHook. +%% +\section*{Continental Small Caps} +\begin{verbatim} \makeatletter \newif\ifSC @@ -112,139 +119,33 @@ \fi } -\renewcommand*\MainNameHook[1]{% - \let\ex\expandafter% - \SCfalse% - \protected@edef\arga{\ex\trim@spaces\ex{\the\@nameauth@toksa}}% - \protected@edef\argb{\ex\trim@spaces\ex{\the\@nameauth@toksb}}% - \protected@edef\testb{\ex\@nameauth@Root\ex{\the\@nameauth@toksb}}% - \protected@edef\argc{\ex\trim@spaces\ex{\the\@nameauth@toksc}}% - \ifx\argb\testb - \protected@edef\Suff{\@empty}% - \let\Reversed\argb% - \let\SNN\argb% - \let\Short\argb% - \else - \protected@edef\Suff{\ex\@nameauth@Suffix\ex{\the\@nameauth@toksb}}% - \protected@edef\Reversed{\Suff\Space\testb}% - \protected@edef\SNN{\testb\Space\Suff}% - \if@nameauth@RevThis - \let\Short\Suff% - \else - \let\Short\testb% - \fi - \fi - \if@nameauth@InAKA - \ifx\arga\@empty - \ifx\argc\@empty - \if@nameauth@RevThis - \Reversed% - \else - \SNN% - \fi - \else - \if@nameauth@AltAKA - \argc% - \else - \if@nameauth@RevThis - \ex\argc\ex\space\SNN% - \else - \ex\SNN\ex\space\argc% - \fi - \fi - \fi - \else - \ifx\argc\@empty - \let\FNN\arga% - \else - \let\FNN\argc% - \fi - \if@nameauth@AltAKA - \FNN% - \else - \if@nameauth@RevThis - \ex\SNN\ex\Space\FNN% - \else - \ex\FNN\ex\space\SNN% - \fi - \fi - \fi - \else - \ifx\arga\@empty - \ifx\argc\@empty - \if@nameauth@FullName - \if@nameauth@RevThis - \Reversed% - \else - \SNN% - \fi - \else - \Short% - \fi - \else - \if@nameauth@FullName - \if@nameauth@RevThis - \ex\argc\ex\space\SNN% - \else - \ex\SNN\ex\space\argc% - \fi - \else - \if@nameauth@RevThis - \argc% - \else - \Short% - \fi - \fi - \fi - \else - \ifx\argc\@empty - \let\FNN\arga% - \else - \let\FNN\argc% - \fi - \let\Short\FNN% - \if@nameauth@FullName - \if@nameauth@RevThis - \ex\SNN\ex\Space\FNN% - \else - \ex\FNN\ex\space\SNN% - \fi - \else - \if@nameauth@FirstName - \Short% - \else - \testb% - \fi - \fi - \fi - \fi -} -\makeatother - +\renewcommand*\MainNameHook[1]{\SCfalse\NameParser} +\let\FrontNameHook\MainNameHook +\end{verbatim} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Surname index entries in talic -% First surname instances in text are italic -% Capitalize name within that formatting +%% Surname index entries in talic +%% First surname instances in text are italic +%% Capitalize name within that formatting %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% -% Below we create a Boolean value \ifItal and set it true. -% This will trigger italics, similar to the Continental -% example above. -% -% We then create a macro \DoFormat that prints its argument in -% italic when \ifItal is true, or makes no font change otherwise. -% -% The \CP macro only capitalizies its argument inside \NamesFormat below. -% -% \Namesformat ignores its argument, sets \InHooktrue, then -% uses control sequences internal to the naming macros to -% parse and print the current name values with formatting. -% -% The hook macro is suitable to replace \NamesFormat and \FrontNamesFormat. -% To replace \MainNameHook and \FrontNameHook, wrap the hook macro -% between \Italfalse and \italtrue for first-only italic. -% - +%% +%% Below we create a Boolean value \ifItal and set it true. +%% This will trigger italics, similar to the Continental +%% example above. +%% +%% We then create a macro \DoFormat that prints its argument in +%% italic when \ifItal is true, or makes no font change otherwise. +%% +%% The \CP macro only capitalizies its argument inside \NamesFormat below. +%% +%% \Namesformat ignores its argument, sets \InHooktrue, then +%% calls the name parser used specifically in formatting hooks. +%% +%% The hook macro is suitable to replace \NamesFormat and \FrontNamesFormat. +%% To replace \MainNameHook and \FrontNameHook, wrap the hook macro +%% between \Italfalse and \italtrue for first-only italic. +%% +\section*{Formatting and Capping} +\begin{verbatim} \newif\ifItal \newif\ifFirstCap \newif\ifInHook @@ -255,7 +156,7 @@ } \def\CP#1{% \ifInHook - \ifFirstCap\uppercase{#1}\else#1\fi% + \ifFirstCap\uppercase{#1}\else#1\fi \else #1% \fi @@ -263,112 +164,17 @@ \newcommand*\CapMe{\FirstCaptrue} \makeatletter% -\renewcommand*\NamesFormat[1]{\ignorespaces% - \let\ex\expandafter\ignorespaces% - \InHooktrue\ignorespaces% - \protected@edef\arga{\ex\trim@spaces\ex{\the\@nameauth@toksa}}\ignorespaces% - \protected@edef\argb{\ex\trim@spaces\ex{\the\@nameauth@toksb}}\ignorespaces% - \protected@edef\testb{\ex\@nameauth@Root\ex{\the\@nameauth@toksb}}\ignorespaces% - \protected@edef\argc{\ex\trim@spaces\ex{\the\@nameauth@toksc}}\ignorespaces% - \ifx\argb\testb - \protected@edef\Suff{\@empty}\ignorespaces% - \let\Reversed\argb\ignorespaces% - \let\SNN\argb\ignorespaces% - \let\Short\argb\ignorespaces% - \else - \protected@edef\Suff{\ex\@nameauth@Suffix\ex{\the\@nameauth@toksb}}\ignorespaces% - \protected@edef\Reversed{\Suff\Space\testb}\ignorespaces% - \protected@edef\SNN{\testb\Space\Suff}\ignorespaces% - \if@nameauth@RevThis - \let\Short\Suff% - \else - \let\Short\testb% - \fi - \fi - \if@nameauth@InAKA - \ifx\arga\@empty - \ifx\argc\@empty - \if@nameauth@RevThis - \Reversed% - \else - \SNN% - \fi - \else - \if@nameauth@AltAKA - \argc% - \else - \if@nameauth@RevThis - \ex\argc\ex\space\SNN% - \else - \ex\SNN\ex\space\argc% - \fi - \fi - \fi - \else - \ifx\argc\@empty - \let\FNN\arga% - \else - \let\FNN\argc% - \fi - \if@nameauth@AltAKA - \FNN% - \else - \if@nameauth@RevThis - \ex\SNN\ex\Space\FNN% - \else - \ex\FNN\ex\space\SNN% - \fi - \fi - \fi - \else - \ifx\arga\@empty - \ifx\argc\@empty - \if@nameauth@FullName - \if@nameauth@RevThis - \Reversed% - \else - \SNN% - \fi - \else - \Short% - \fi - \else - \if@nameauth@FullName - \if@nameauth@RevThis - \ex\argc\ex\space\SNN% - \else - \ex\SNN\ex\space\argc% - \fi - \else - \if@nameauth@RevThis - \argc% - \else - \Short% - \fi - \fi - \fi - \else - \ifx\argc\@empty - \let\FNN\arga% - \else - \let\FNN\argc% - \fi - \let\Short\FNN% - \if@nameauth@FullName - \if@nameauth@RevThis - \ex\SNN\ex\Space\FNN% - \else - \ex\FNN\ex\space\SNN% - \fi - \else - \if@nameauth@FirstName - \Short% - \else - \testb% - \fi - \fi - \fi - \fi - \InHookfalse% +\renewcommand*\NamesFormat[1] +{% + \InHooktrue\NameParser\InHookfalse% \global\FirstCapfalse% -}
\ No newline at end of file +} +\renewcommand*\MainNameHook[1] +{% + \Italfalse\InHooktrue\NameParser\InHookfalse% + \global\FirstCapfalse\Italtrue% +} +\let\FrontNamesFormat\Namesformat +\let\FrontNameHook\MainNameHook +\end{verbatim} +\end{document} diff --git a/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf b/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf Binary files differindex defe59b63b3..e7741d41c8b 100644 --- a/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf +++ b/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf |