diff options
author | Karl Berry <karl@freefriends.org> | 2017-01-08 22:21:25 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2017-01-08 22:21:25 +0000 |
commit | 5f61b0622e152140271ccdbe55816b9c2446c85f (patch) | |
tree | 7452fe57beabaac2f2cace06a44d8bf8880dd476 | |
parent | f8b91d888f60b20880a9c0749883747cd913bc3f (diff) |
skdoc (8jan17)
git-svn-id: svn://tug.org/texlive/trunk@42901 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r-- | Master/texmf-dist/doc/latex/skdoc/README | 12 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/skdoc/skdoc.pdf | bin | 231969 -> 301197 bytes | |||
-rw-r--r-- | Master/texmf-dist/source/latex/skdoc/skdoc.dtx | 61 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/skdoc/skdoc.cls | 14 |
4 files changed, 44 insertions, 43 deletions
diff --git a/Master/texmf-dist/doc/latex/skdoc/README b/Master/texmf-dist/doc/latex/skdoc/README index 565b55df4a4..e75930e5252 100644 --- a/Master/texmf-dist/doc/latex/skdoc/README +++ b/Master/texmf-dist/doc/latex/skdoc/README @@ -1,7 +1,7 @@ %% skdoc documentation class %% -%% Copyright (C) 2012-2013 by Simon Sigurdhsson <sigurdhsson@gmail.com> -%% +%% Copyright (C) 2012-2016 by Simon Sigurdhsson <sigurdhsson@gmail.com> +%% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 %% of this license or (at your option) any later version. @@ -9,15 +9,15 @@ %% http://www.latex-project.org/lppl.txt %% and version 1.3 or later is part of all distributions of LaTeX %% version 2005/12/01 or later. -%% +%% %% This work has the LPPL maintenance status `maintained'. -%% +%% %% The Current Maintainer of this work is Simon Sigurdhsson. -%% +%% %% This work consists of the files skdoc.dtx %% and the derived filebase skdoc.cls. -This is version 1.4 of the skdoc document class. It is designed to +This is version 1.4b of the skdoc document class. It is designed to generate both documentation and derivative files using only LaTeX, i.e. without using docstrip and ins/dtx files. diff --git a/Master/texmf-dist/doc/latex/skdoc/skdoc.pdf b/Master/texmf-dist/doc/latex/skdoc/skdoc.pdf Binary files differindex 62adc6275b9..27055bc9ac6 100644 --- a/Master/texmf-dist/doc/latex/skdoc/skdoc.pdf +++ b/Master/texmf-dist/doc/latex/skdoc/skdoc.pdf diff --git a/Master/texmf-dist/source/latex/skdoc/skdoc.dtx b/Master/texmf-dist/source/latex/skdoc/skdoc.dtx index 7513b55c884..62c988d901f 100644 --- a/Master/texmf-dist/source/latex/skdoc/skdoc.dtx +++ b/Master/texmf-dist/source/latex/skdoc/skdoc.dtx @@ -1,8 +1,8 @@ % \iffalse %% skdoc documentation class %% -%% Copyright (C) 2012-2013 by Simon Sigurdhsson <sigurdhsson@gmail.com> -%% +%% Copyright (C) 2012-2016 by Simon Sigurdhsson <sigurdhsson@gmail.com> +%% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 %% of this license or (at your option) any later version. @@ -10,11 +10,11 @@ %% http://www.latex-project.org/lppl.txt %% and version 1.3 or later is part of all distributions of LaTeX %% version 2005/12/01 or later. -%% +%% %% This work has the LPPL maintenance status `maintained'. -%% +%% %% The Current Maintainer of this work is Simon Sigurdhsson. -%% +%% %% This work consists of the files skdoc.dtx %% and the derived filebase skdoc.cls. % @@ -73,7 +73,7 @@ %</driver> %<class>\ProvidesExplClass{skdoc} %<*class> - {2013/11/28}{1.4a}{skdoc documentation class} + {2017/01/08}{1.4b}{skdoc documentation class} %</class> % %<*driver> @@ -132,7 +132,7 @@ % {}{\small\pagemark} % \pagestyle{skdoc-class} % -% \version{1.4a} +% \version{1.4b} % \changes{1.0}{Initial version} % \changes{1.1}{Added support for syntax highlighting using \pkg{minted}} % \changes{1.1a}{Deprecate the use of \pkg{bibtex} in favour of \pkg{biblatex}} @@ -142,6 +142,7 @@ % \changes{1.3b}{Use \pkg{sourcecodepro} instead of \pkg{inconsolata}. Fix issue with index entries of different types with same name} % \changes{1.4}{Added option to control \pkg{babel}. Allow optional default value arguments in \env{macro} and friends. Fix spacing issue in \env{option} and friends} % \changes{1.4a}{Fix various compatibility issues with latest \pkg{glossaries}} +% \changes{1.4b}{Track \pkg{expl3} changes (thanks to Joseph Wright)} % \iffalse %%% Don't forget to update the version number and release date of %%% the package declaration on line 76! @@ -295,7 +296,7 @@ % % \DescribeMacro\theversion % Returns the version as defined by \cs{version}, with a leading -% \enquote{v}. That is, issuing \Macro\version{1.0} makes +% \enquote{v}. That is, issuing \Macro\version{1.0} makes % \cs{theversion} print \enquote{v1.0}. % % \DescribeMacro\thepackage @@ -340,7 +341,7 @@ % be of extra importance in the documentation. Such information is % categorized as either notices or warnings, which are treated % differently. -% +% % \DescribeMacro\Notice{<notice>} % A notice is a short piece of text that contains information that may % explain some unexpected but unharmful behaviour of a macro or similar. @@ -387,7 +388,7 @@ % Typesets a \hologo{BibTeX} entry type. The agument should be provided % without the leading \texttt{@} sign. The entry type will be typeset % in a monospace font. -% +% % \DescribeMacro\thm{<theme name>} % Typesets a theme name. As of \theversion, the theme name will be % typeset in an upright serif font. @@ -475,7 +476,7 @@ % Package options are of course important to describe, and to this % end four macros are provided. They aid in describing options of % both regular boolean and the more modern key-value syntax. They -% are intended to be used in a sequence: \\ +% are intended to be used in a sequence: \\ % \mbox{\Macro\Option{...} % \AlsoMacro\WithValues{...} % \AlsoMacro\AndDefault{...}} @@ -504,7 +505,7 @@ % \Macro\Options{<option>,no\meta{option}} % \AlsoMacro\AndDefault{no\meta{option}}} % \end{itemize} -% +% % \subsubsection{Macros} % The \thepkg\ class inherits a number of macros for describing the % package macros from the \pkg{ydoc} package. Only four of them are @@ -512,7 +513,7 @@ % \LongWarning{ % The macros \cs{MakeShortMacroArgs} and \cs{DeleteShortMacroArgs} % and the environments \env{DescribeMacros} and \env{DescribeMacrosTab} -% provided by \pkg{ydoc} are unsupported as of \thepkg\ \theversion. +% provided by \pkg{ydoc} are unsupported as of \thepkg\ \theversion. % They may work, but this is % not a guarantee and they are most likely broken or may break other % features of \thepkg. @@ -597,7 +598,7 @@ % \env{MacroCode} environment. Other than that, the implementation % environments should be compatible with or analogous to the standard % \pkg{ltxdoc} document class. -% +% % \subsubsection{Implementation environments}\label{sec:impl-env} % The environments described in this section indicate the % implementation of different concepts including macros, environments @@ -606,7 +607,7 @@ % does \Notice{inside these environments, \cs{changes} will refer to % the relevant entity instead of logging \enquote{general} changes}. % -% Some of the following environment can typeset descriptions of the +% Some of the following environment can typeset descriptions of the % internal arguments (\texttt{\#1}, \texttt{\#2} \emph{etc.}) to % improve readability of the implementation code. % @@ -635,7 +636,7 @@ % % \subsubsection{The \env{MacroCode} environment} % The \enquote{main event} of the \thepkg\ document class is the -% \env{MacroCode} environment. It has roughly the same role the +% \env{MacroCode} environment. It has roughly the same role the % \env{macrocode} environment has in the \pkg{docstrip} system, except % that it in addition to typesetting the implementation also saves it % to the target files. @@ -652,7 +653,7 @@ % key-value options, where the possible keys are \texttt{key} and % \texttt{preamble}. Here \meta{key} is a key that is used instead % of the filename in \env{MacroCode}, and \meta{preamble} is a -% token or command sequence expanding to a preamble which will be +% token or command sequence expanding to a preamble which will be % prepended to the file on output. % % \DescribeMacro\PreambleTo{<\textbackslash token>}{<filename>} @@ -719,19 +720,19 @@ % % \DescribeMacro\PrintChanges % This macro prints the list of changes. As explained earlier, this -% requires you to run \texttt{makeglossaries} between the two \LaTeX\ +% requires you to run \texttt{makeglossaries} between the two \LaTeX\ % runs. % % \subsection{Producing an index} % The macros previously discussed in sections~\ref{sec:ref-macros}, % \ref{sec:doc-macros} and \ref{sec:impl-env} automatically index their % aguments using \pkg{glossaries}. By running \texttt{makeglossaries} -% you can include an index of all macros, environments, packages and +% you can include an index of all macros, environments, packages and % such that are discussed, documented or implemented in your package. % % \DescribeMacro\PrintIndex % Much like the \cs{PrintChanges} macro, this prints the index. As with -% the list of changes, this requires that you run +% the list of changes, this requires that you run % \texttt{makeglossaries} between the two \LaTeX\ runs. % % \section{Known issues} @@ -743,7 +744,7 @@ % \item[\#?] ??? % \end{description} % \fi -% If you discover any bugs in this package, please report them to the +% If you discover any bugs in this package, please report them to the % issue tracker in the \thepackage\ Github repository. % % \Implementation \ExplHack @@ -909,7 +910,7 @@ % \end{macrocode} % % \subsection{Special case: syntax highlighting} -% We support syntax highlighting through \pkg{minted}, but only if +% We support syntax highlighting through \pkg{minted}, but only if % we're running with unrestricted \cs{write18} access \emph{and} % there exists a suitable executable (\texttt{pygmentize}). Since % \pkg{minted} bails out without \cs{write18} access, we have to test @@ -1224,9 +1225,9 @@ \DeclareDocumentCommand\DeclareFile{om}{ \group_begin: \keys_define:nn{skdoc@declarefile}{% - preamble .value_required:, + preamble .value_required:n = true, preamble .code:n = \edef\skdoc@preamble{##1}, - key .value_required:, + key .value_required:n = true, key .code:n = \def\skdoc@key{##1} }% \def\skdoc@preamble{}% @@ -1244,7 +1245,7 @@ \tl_set:Nx\l_tmpa_tl{\skdoc@preamble} \edef\skdoc@temp{\tl_head:N\l_tmpa_tl} \def\skdoc@preamble@extra{ - \skdoc@temp\skdoc@temp\space~This~is~file~`#2',~generated~from~`\c_job_name_tl.tex'~(key~`\skdoc@key'). + \skdoc@temp\skdoc@temp\space~This~is~file~`#2',~generated~from~`\c_sys_jobame_str.tex'~(key~`\skdoc@key'). } } \expandafter\xdef\csname skdoc@write@#2\endcsname{% @@ -1510,7 +1511,7 @@ % Shorthand to read preamble from current document. % \begin{macrocode} \DeclareDocumentCommand\SelfPreambleTo{m}{% - \PreambleTo{#1}{\c_job_name_tl}% + \PreambleTo{#1}{\c_sys_jobame_str}% } % \end{macrocode} % \end{macro} @@ -1804,7 +1805,7 @@ % \begin{macro}{\WithValues}[1] % {Values of a key-value option} % The \cs{WithValues} macro peeks ahead to see if there's an -% \cs{AndDefault} macro further down. It typesets the values of +% \cs{AndDefault} macro further down. It typesets the values of % a key-vaue option % \begin{macrocode} \DeclareDocumentCommand\WithValues{m}{ @@ -2387,7 +2388,7 @@ % These macros add an index entry with different contents depending % on the thing (macro, environment, etc.) that is being indexed. They % all have non-starred variants which are used by the referring -% macros (\cs{cs} \emph{et. al}), and starred variants used by the +% macros (\cs{cs} \emph{et. al}), and starred variants used by the % description macros (the star affects the style of the page number). % Each environment first test wether the given entry key exists, and % defines a new entry if it doesn't. Then, a usage of the entry is @@ -2866,7 +2867,7 @@ % \end{macro} % \begin{macro}{\Finale} % \changes{1.1a}{Hide references used in the hidden implementation} -% The \cs{Finale} macro basically just undoes what the +% The \cs{Finale} macro basically just undoes what the % \cs{Implementation} macro did. If \pkg{biblatex} is used, the % \env{refsection} environment is ended and the (local) bibliography % is printed. @@ -2908,7 +2909,7 @@ % \begin{macrocode} \DeclareDocumentCommand\package{om}{% \keys_define:nn{skdoc@package}{% - vcs .value_required:,% + vcs .value_required:n = true,% vcs .code:n = \repository{##1},% ctan .code:n = \ctan{##1},% ctan .default:n = #2% diff --git a/Master/texmf-dist/tex/latex/skdoc/skdoc.cls b/Master/texmf-dist/tex/latex/skdoc/skdoc.cls index 6e36c12bde1..f8ef5de16b7 100644 --- a/Master/texmf-dist/tex/latex/skdoc/skdoc.cls +++ b/Master/texmf-dist/tex/latex/skdoc/skdoc.cls @@ -8,7 +8,7 @@ %% %% skdoc documentation class %% -%% Copyright (C) 2012-2013 by Simon Sigurdhsson <sigurdhsson@gmail.com> +%% Copyright (C) 2012-2016 by Simon Sigurdhsson <sigurdhsson@gmail.com> %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -26,7 +26,7 @@ %% and the derived filebase skdoc.cls. \RequirePackage{expl3} \ProvidesExplClass{skdoc} - {2013/11/28}{1.4a}{skdoc documentation class} + {2017/01/08}{1.4b}{skdoc documentation class} \PassOptionsToPackage{log-declarations=false}{xparse} \LoadClass[ DIV7, headings=big, @@ -306,9 +306,9 @@ \DeclareDocumentCommand\DeclareFile{om}{ \group_begin: \keys_define:nn{skdoc@declarefile}{% - preamble .value_required:, + preamble .value_required:n = true, preamble .code:n = \edef\skdoc@preamble{##1}, - key .value_required:, + key .value_required:n = true, key .code:n = \def\skdoc@key{##1} }% \def\skdoc@preamble{}% @@ -326,7 +326,7 @@ \tl_set:Nx\l_tmpa_tl{\skdoc@preamble} \edef\skdoc@temp{\tl_head:N\l_tmpa_tl} \def\skdoc@preamble@extra{ - \skdoc@temp\skdoc@temp\space~This~is~file~`#2',~generated~from~`\c_job_name_tl.tex'~(key~`\skdoc@key'). + \skdoc@temp\skdoc@temp\space~This~is~file~`#2',~generated~from~`\c_sys_jobame_str.tex'~(key~`\skdoc@key'). } } \expandafter\xdef\csname skdoc@write@#2\endcsname{% @@ -476,7 +476,7 @@ \group_end: } \DeclareDocumentCommand\SelfPreambleTo{m}{% - \PreambleTo{#1}{\c_job_name_tl}% + \PreambleTo{#1}{\c_sys_jobame_str}% } \definecolorset{RGB}{}{}{ section,11,72,107; @@ -1221,7 +1221,7 @@ \let\@version\@empty% \DeclareDocumentCommand\package{om}{% \keys_define:nn{skdoc@package}{% - vcs .value_required:,% + vcs .value_required:n = true,% vcs .code:n = \repository{##1},% ctan .code:n = \ctan{##1},% ctan .default:n = #2% |