diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/latex/jumplines/README | 12 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/jumplines/jumplines_doc.pdf | bin | 0 -> 141342 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/jumplines/jumplines_doc.tex (renamed from Master/texmf-dist/doc/latex/jumplines/jumplinesdoc.tex) | 112 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/jumplines/jumplines_example.pdf | bin | 111979 -> 110248 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/jumplines/jumplines_example.tex | 49 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/jumplines/jumplinesdoc.pdf | bin | 133629 -> 0 bytes |
6 files changed, 104 insertions, 69 deletions
diff --git a/Master/texmf-dist/doc/latex/jumplines/README b/Master/texmf-dist/doc/latex/jumplines/README index 8e988154a2a..84c72c21ee3 100644 --- a/Master/texmf-dist/doc/latex/jumplines/README +++ b/Master/texmf-dist/doc/latex/jumplines/README @@ -1,4 +1,4 @@ -%% LaTeX package jumplines - version 0.1 (2015/01/05) +%% LaTeX package jumplines - version 0.2 (2015/06/02) %% %% ------------------------------------------------------------------------------------------- %% Copyright (c) 2015 by Dr. Christian Hupfer <christian dot hupfer at yahoo dot de> @@ -28,8 +28,8 @@ colour maintenance of the broken boxes. Directory listing: - jumplinesdoc.pdf 133629 01/05/15 02:24:09 - jumplinesdoc.tex 8945 01/05/15 02:23:54 -jumplines_example.pdf 111979 01/05/15 02:24:08 -jumplines_example.tex 1647 01/05/15 02:23:54 - jumplines.sty 7542 01/05/15 02:24:09 + jumplines_doc.pdf 141342 06/02/15 00:06:18 + jumplines_doc.tex 10822 06/02/15 00:05:11 + jumplines_example.pdf 110248 06/02/15 00:06:16 + jumplines_example.tex 2815 06/02/15 00:05:11 + jumplines.sty 17996 06/02/15 00:06:18 diff --git a/Master/texmf-dist/doc/latex/jumplines/jumplines_doc.pdf b/Master/texmf-dist/doc/latex/jumplines/jumplines_doc.pdf Binary files differnew file mode 100644 index 00000000000..e8d9e89c56a --- /dev/null +++ b/Master/texmf-dist/doc/latex/jumplines/jumplines_doc.pdf diff --git a/Master/texmf-dist/doc/latex/jumplines/jumplinesdoc.tex b/Master/texmf-dist/doc/latex/jumplines/jumplines_doc.tex index 3be5c4ec6b8..cdc47dd7de2 100644 --- a/Master/texmf-dist/doc/latex/jumplines/jumplinesdoc.tex +++ b/Master/texmf-dist/doc/latex/jumplines/jumplines_doc.tex @@ -1,6 +1,6 @@ %% Documentation for jumplines.sty %% -%% +%% %% %% ------------------------------------------------------------------------------------------- %% Copyright (c) 2015 by Dr. Christian Hupfer <christian dot hupfer at yahoo dot de> @@ -14,66 +14,55 @@ %% 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 `author-maintained'. +%% This work has the LPPL maintenance status `maintained'. %% %% This work consists of all files listed in README %% - -\documentclass[12pt,paper=a4]{ltxdoc} - -\usepackage[lmargin=2cm,rmargin=2cm]{geometry} +\documentclass[12pt,english]{ltxdoc} +\usepackage{scrlayer-scrpage} +\usepackage[lmargin=3cm,rmargin=3cm,a4paper]{geometry} \usepackage{savesym}% \usepackage{bbding}% \savesymbol{Cross}% \usepackage{blindtext}% -\usepackage{imakeidx}% - -\usepackage{datetime}% - -\usepackage{scrpage2}% - \usepackage{enumitem}% +\usepackage{datetime}% +\usepackage{imakeidx}% +\usepackage[babel,style=english]{csquotes} +\newcommand{\myquotes}[1]{\enquote{#1}}% -\usepackage{jumplines} +\usepackage{array}% +\usepackage[languages={spanish,french,ngerman,english}]{jumplines} -\tcbuselibrary{listingsutf8}% -\tcbuselibrary{documentation}% +\newcolumntype{C}[1]{>{\centering\arraybackslash}p{#1}} -\usepackage{hyperref}% -\usepackage{bookmark}% +\tcbuselibrary{documentation} +\tcbset{color command={blue}} \newcommand{\tcolorboxdoclink}{http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf} +\newcommand{\packagename}[1]{\fbox{\textcolor{blue}{\textbf{\ding{41}~#1}}}\index{Package!#1}}% +\newcommand{\classname}[1]{\fbox{\textcolor{brown}{\textbf{\Writinghand~#1}}}\index{Class!#1}}% - - -\newcommand{\packagename}[1]{\textcolor{blue}{\textbf{\Envelope~#1}}\index{Paket!#1}}% - - -\newcommand{\MarkupPackageName}[2][lightgray]{% -\colorbox{#1}{\textcolor{black}{#2}}% -}% - -\newcommand{\MarkupCounterName}[2][yellow]{% -\colorbox{#1}{\textcolor{black}{\texttt{#2}}}% -}% - +\newcommand{\handrightnote}{\tcbdocmarginnote{\ding{43}}} \newtcolorbox{docCommandArgs}[1]{colbacktitle={blue},coltitle={white},title={Description of arguments of command \cs{#1}}} -\def\packageversion{0.1}% +\def\packageversion{0.2}% \makeindex \newcommand{\PackageDocName}{jumplines.sty}% +\hypersetup{breaklinks=true} \begin{document} +\selectlanguage{english} \mmddyyyydate @@ -85,7 +74,7 @@ \begin{tcolorbox}[boxrule=1mm,arc=4mm,colback=yellow!30!white,width=0.8\textwidth] \large \bfseries% \begin{center}% -\begin{tabular}{c}% +\begin{tabular}{C{0.7\textwidth}}% \textsc{\PackageDocName} \tabularnewline \tabularnewline Providing teaser headline articles continued later on \tabularnewline @@ -104,11 +93,10 @@ Author: Christian Hupfer\(^\mathrm{\fnsymbol{footnote}}\)% }{\makeatletter chris \renewcommand{\thefootnote}{\fnsymbol{footnote}}% \footnotetext{christian.hupfer@yahoo.de}% \makeatother - \end{center} -\tableofcontents \clearpage +\tableofcontents @@ -138,7 +126,7 @@ This is the second teaser headline, which is broken after some dummy text also\b \section{Package options}% -As of version \packageversion~ the package has no options so far. +As of version \packageversion~ the package has only the \oarg{languages} option so far. It is used to set the language of the articles. See section \ref{sec::language_support} for more information about the support for foreign languages. @@ -147,21 +135,21 @@ As of version \packageversion~ the package has no options so far. \subsection{Required packages} \begin{itemize} -\item \packagename{etex} -\item \packagename{etoolbox} -\item \packagename{xkeyval} +\item \packagename{etoolbox}% +\item \packagename{xkeyval}% \item \packagename{xparse}% \item \packagename{tcolorbox}% \item \packagename{luacolor}% +\item \packagename{hyperref}% \end{itemize} -\subsection{Incompatibilities} +Additionally, the features of \packagename{bookmark} package are used for more convenient bookmark generation if this package is loaded, otherwise it is restricted to the bookmarking capatibilities of \packagename{hyperref}. -This package does \textbf{not} work with floating contents \textbf{inside} of the articles, however, floats outside of such articles are possible. -\section{Documentation of Macros} -\tcbset{color command={blue}} +\subsection{Incompatibilities} +This package does \textbf{not} work with floating contents \textbf{inside} of the articles, however, floats outside of such articles are possible. Although it's possible to use \packagename{wrapfig} and its \docAuxEnvironment{wrapfigure} environment, it's advisable to adapt the teaser box height manually since the wrapping works but is continued later on too. +\section{Documentation of Macros} \begin{docCommand}{JumplineArticle}{\oarg{options}\marg{article content}} This provides the main command for typesetting a jumpline article. All of the article content is specified in the (2nd) mandatory argument. @@ -171,7 +159,7 @@ This provides the main command for typesetting a jumpline article. All of the ar \begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}] \item \oarg{options}: - \begin{docKey}{TeaserHeight}{=\meta{true/false}}{2in} + \begin{docKey}{TeaserHeight}{=\meta{length value}}{2in} Sets the cut off value for the height of the teaser -- this is not the height of the shown teaser itself, since this involves the teaser header box and some vertical spacings above and below the heading and the teaser content. If the height of the article is smaller than the \refKey{TeaserHeight} value the full article is displayed then and not broken into two pieces. @@ -189,8 +177,17 @@ This provides the main command for typesetting a jumpline article. All of the ar This sets additional options for the display of the continued article header. All options are directly passed to the underlying \cs{tcolorbox}, see the \packagename{tcolorbox} documentation for this. This option has the same meaning to the continued article as \refKey{TeaserHeaderOptions} to the teaser of the same article. \end{docKey} + \begin{docKey}{ContinuedOnTopskip}{=\meta{length}} + This key value holds the vertical spacing between the splitted teaser and the line \textit{Continued on}. + \end{docKey} + + \begin{docKey}{ContinuedOnBottomskip}{=\meta{length}} + This key value holds the vertical spacing between the line \textit{Continued on} and the next possible teaser header. + \end{docKey} + + \begin{docKey}{ArticleAuthor}{=\meta{}}{initially unset} - This sets a (list of) the author name(s) -- it will be displayed at the bottom of the teaser only, introduced by ``\textit{By}''. + This sets a (list of) the author name(s) -- it will be displayed at the bottom of the teaser only, introduced by \myquotes{\textit{By}}. \end{docKey} @@ -219,27 +216,41 @@ This places all teasers consecutively without interruption. If this is placed af This introduces a table of the continued articles with reference to starting page of the continued article. \end{docCommand} -\begin{docCommand}{\listofarticlesname}{} +\begin{docCommand}{listofarticlesname}{} This command holds the name which is displayed as heading of the list of articles. Default value: \textbf{\listofarticlesname} \end{docCommand} -\begin{docCommand}{\listofcontinuedarticlesname} +\begin{docCommand}{listofcontinuedarticlesname}{} This command holds the name which is displayed as heading of the list of continued articles. Default value: \textbf{\listofcontinuedarticlesname} \end{docCommand} +\subsection{Counters} + +The internal counter \docCounter{article} is used internal for counting issues of the articles -- it can't be changed as of version \packageversion. \clearpage +\section{Language support}\label{sec::language_support} + +The package uses \packagename{babel} in order to provide support for foreign languages. Default language is English, as of version \packageversion~ ngerman (New German) is the only other language which is used inside the package and command translations are given. + + + + + + \section{To-Do list} \begin{itemize} \item More options for fine control of the behaviour of teasers and continued articles \item Better height management of the articles/placement on pages \item Better option handling +\item Improve support for languages other than English or German \item Bookmarks \item Better behaviour in multicol-environment \item Improve documentation + \end{itemize} If you @@ -247,11 +258,12 @@ If you \begin{itemize} \item find bugs \item errors in the documentation - \item have suggestions + \item have suggestions \item have feature requests + \item want provide or improve translations of the language specific items \end{itemize} -don't hesitate and contact me via \makeatletter christian.hupfer@siebenfelsen.de\makeatother +don't hesitate and contact me via \makeatletter christian.hupfer@yahoo.de\makeatother \clearpage @@ -264,12 +276,14 @@ to the users at tex.stackexchange.com, especially to \item Enrico Gregorio \item Joseph Wright \item David Carlisle + \item Paulo Roberto Massa Cereda + \item Werner Doe ;-) \end{itemize} for their invaluable help on many questions on macros. \vspace{2\baselineskip} -A special gratitude goes to Prof. Dr. Dr. Thomas Sturm for providing the wonderful \MarkupPackageName{tcolorbox} package which was used to +A special gratitude goes to Prof. Dr. Dr. Thomas Sturm for providing the wonderful \packagename{tcolorbox} package which was used to write this documentation. \clearpage diff --git a/Master/texmf-dist/doc/latex/jumplines/jumplines_example.pdf b/Master/texmf-dist/doc/latex/jumplines/jumplines_example.pdf Binary files differindex d43a1e93234..9701d3351d8 100644 --- a/Master/texmf-dist/doc/latex/jumplines/jumplines_example.pdf +++ b/Master/texmf-dist/doc/latex/jumplines/jumplines_example.pdf diff --git a/Master/texmf-dist/doc/latex/jumplines/jumplines_example.tex b/Master/texmf-dist/doc/latex/jumplines/jumplines_example.tex index 7e49064c6bb..feb9af63df8 100644 --- a/Master/texmf-dist/doc/latex/jumplines/jumplines_example.tex +++ b/Master/texmf-dist/doc/latex/jumplines/jumplines_example.tex @@ -1,40 +1,61 @@ -\documentclass[12pt,a4paper,twocolumn]{article} +%% jumplines_example.tex -- Example usage file +%%% +%% ------------------------------------------------------------------------------------------- +%% Copyright (c) 2015 by Dr. Christian Hupfer <christian dot hupfer at yahoo dot de> +%% ------------------------------------------------------------------------------------------- +%% +%% 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. +%% The latest version of this license is in +%% 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'. +%% +%% This work consists of all files listed in README +%% + + +\documentclass[12pt,a4paper,twocolumn,languages=english]{article} \usepackage{graphicx}% \usepackage{blindtext}% -\usepackage{jumplines} +\usepackage[languages=spanish,ngerman]{jumplines} \usepackage{hyperref} +\usepackage{bookmark} +\usepackage[babel,style=english]{csquotes} +\newcommand{\myquotes}[1]{\enquote{#1}}% \begin{document} + \listofarticle \listofcontarticle + \clearpage \JumplineArticle[TeaserHeight=2.25in,ArticleHeadline={Breaking News}]{% \Large\textbf{Nothing special on the dark side of the moon}\par \begin{center}\includegraphics[scale=0.3]{example-image-a}\end{center}\par - \begin{tabular}{|c|c|} - Hello & World\tabularnewline - World & Hello \tabularnewline - \end{tabular} - \blindtext[2] } % -\JumplineArticle[TeaserHeight=2in,ArticleAuthor={Gandalf},ContinuedOnTopskip=1cm,ContinuedOnBottomskip=2cm,TeaserHeaderContent={A short article}]{\color{red}{\blindtext[10]}}% -\JumplineArticle[TeaserHeight=2in,ContinuedArticleHeaderContent={More information}]{\textcolor{blue}{\blindtext[1]\textcolor{Green}{Showing}\blindtext[2]}}% -\JumplineArticle[TeaserHeight=3in,ArticleHeadline={\Huge Breaking News}]{\Huge \sffamily The World is a Globe\par\begin{center}\includegraphics[scale=0.3]{example-image-b}\end{center}\par +\JumplineArticle[RightHere=true,TeaserHeight=2in,ArticleAuthor={Gandalf},ContinuedOnTopskip=0.5cm,ContinuedOnBottomskip=10cm,TeaserHeaderContent={A short article}]{\color{red}{\blindtext[10]}}% +\JumplineArticle[TeaserHeight=2in,ContinuedArticleHeaderContent={More information},TeaserHeaderColor={yellow}]{\textcolor{blue}{\blindtext[1]\textcolor{Green}{Showing}\blindtext[2]}}% +\JumplineArticle[TeaserHeight=3in,ArticleHeadline={\Huge Breaking News}][Breaking News]{\Huge \sffamily The World is a Globe\par\begin{center}\includegraphics[scale=0.3]{example-image-b}\end{center}\par {\color{violet}{\( E = mc^2\)}}}% -\JumplineArticle[TeaserHeight=2in]{{{\color{brown}{\blindtext[10]}}}}% -\JumplineArticle[TeaserHeight=8in]{\textcolor{blue}{\blindtext[10]}}% -\JumplineArticle[TeaserHeight=2in]{\textcolor{Goldenrod}{\blindtext[10]}}% -\JumplineArticle[TeaserHeight=2in,ArticleAuthor={\textcolor{violet}{Some guy from the LaTeX3 - team}}]{\Huge \begin{center}\includegraphics[scale=0.2]{example-image-c}\end{center} \centering "I can't wait for \LaTeX3"} +\selectlanguage{spanish} +\JumplineArticle[TeaserHeight=2in][My Headline]{\color{brown}{\blindtext[10]}}% +\JumplineArticle[TeaserHeight=8in,emptyarticleinbookmarks=true]{\textcolor{blue}{\blindtext[10]}}% +\JumplineArticle[TeaserHeight=2in,ArticleHeadline={A golden rod text},BookmarkEntry={\textcolor{GoldenRod}{Golden rod}}]{\textcolor{Goldenrod}{\blindtext[10]}}% +\JumplineArticle[TeaserHeight=2in,emptyarticleintoc=true,emptyarticleinbookmarks=true,autobookmark=false,ArticleAuthor={\textcolor{violet}{Some guy from the LaTeX3 - team}}]{\Huge \begin{center}\includegraphics[scale=0.2]{example-image-c}\end{center} \centering ``I can't wait for \LaTeX3 -- it's so exciting''} diff --git a/Master/texmf-dist/doc/latex/jumplines/jumplinesdoc.pdf b/Master/texmf-dist/doc/latex/jumplines/jumplinesdoc.pdf Binary files differdeleted file mode 100644 index ab2bfa6d4a1..00000000000 --- a/Master/texmf-dist/doc/latex/jumplines/jumplinesdoc.pdf +++ /dev/null |