%% Documentation for jumplines.sty
%%
%%
%%
%% -------------------------------------------------------------------------------------------
%% 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 `author-maintained'.
%%
%% This work consists of all files listed in README
%%


\documentclass[12pt,paper=a4]{ltxdoc}

\usepackage[lmargin=2cm,rmargin=2cm]{geometry}
\usepackage{savesym}%
\usepackage{bbding}%
\savesymbol{Cross}%

\usepackage{blindtext}%
\usepackage{imakeidx}%

\usepackage{datetime}%

\usepackage{scrpage2}%

\usepackage{enumitem}%

\usepackage{jumplines}


\tcbuselibrary{listingsutf8}%
\tcbuselibrary{documentation}%

\usepackage{hyperref}%
\usepackage{bookmark}%


\newcommand{\tcolorboxdoclink}{http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf}



\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}}}%
}%


\newtcolorbox{docCommandArgs}[1]{colbacktitle={blue},coltitle={white},title={Description of arguments of command \cs{#1}}}


\def\packageversion{0.1}%

\makeindex

\newcommand{\PackageDocName}{jumplines.sty}%



\begin{document}
\mmddyyyydate


\setlength{\parindent}{0pt}

\thispagestyle{empty}%

\begin{center}
\begin{tcolorbox}[boxrule=1mm,arc=4mm,colback=yellow!30!white,width=0.8\textwidth]
\large \bfseries%
\begin{center}%
\begin{tabular}{c}%
\textsc{\PackageDocName} \tabularnewline
\tabularnewline
Providing teaser headline articles continued later on \tabularnewline
\tabularnewline
Version \packageversion \tabularnewline
\tabularnewline
\today \tabularnewline
\tabularnewline
\addtocounter{footnote}{2}
Author: Christian Hupfer\(^\mathrm{\fnsymbol{footnote}}\)% }{\makeatletter christian.hupfer@yahoo.de}
\tabularnewline
\end{tabular}
\end{center}
\end{tcolorbox}
\makeatletter
\renewcommand{\thefootnote}{\fnsymbol{footnote}}%
\footnotetext{christian.hupfer@yahoo.de}%
\makeatother

\end{center}

\tableofcontents
\clearpage




\pagestyle{scrheadings}%
\setheadsepline{2pt}[\color{blue}]

\setcounter{footnote}{0}


\section{Introduction}

The aim of this package is to provide support for writing teaser articles which are common in newspapers, starting for example on the frontpage and are continued on another page, with some reference on which page this continuation happens.

\JumplineArticle[ArticleHeadline={Something to know},TeaserHeight=0.5in]{%
This is the first teaser, which is broken after some dummy text,\textcolor{blue}{\blindtext}\textcolor{red}{\blindtext}}%

\JumplineArticle[TeaserHeight=1.5in,ArticleHeadline={And another useless article}]{%
This is the second teaser headline, which is broken after some dummy text also\blindtext[1]}%

\ShipoutArticleTeasers%



\ShipoutArticleHangingArticles%


\section{Package options}%

As of version \packageversion~ the package has no options so far.



\section{Requirements and incompatibilities}%

\subsection{Required packages}

\begin{itemize}
\item \packagename{etex}
\item \packagename{etoolbox}
\item \packagename{xkeyval}
\item \packagename{xparse}%
\item \packagename{tcolorbox}%
\item \packagename{luacolor}%
\end{itemize}

\subsection{Incompatibilities}

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}}


\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.

\begin{docCommandArgs}{JumplineArticle}%

  \begin{enumerate}[label={\textcolor{blue}{\#\arabic*}}]
  \item \oarg{options}: 

    \begin{docKey}{TeaserHeight}{=\meta{true/false}}{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. 
    \end{docKey}

    \begin{docKey}{ArticleHeadline}{=\meta{arbitray text}}{no value}
      This sets an article headline after the article number. Should be enclosed in a \brackets{}-pair
    \end{docKey}

    \begin{docKey}{TeaserHeaderOptions}{=\meta{options for the teaser header}}{breakable,leftlower=0pt,rightlower=0pt,boxrule=0pt,left=0pt,right=0pt, arc=0pt,auto outer arc,colbacktitle=black,coltitle=white,toptitle=2mm,bottomtitle=2mm}
      This sets additional options for the display of the teaser header. All options are directly passed to the underlying \cs{tcolorbox}, see the \href{\tcolorboxdoclink}{\packagename{tcolorbox}} documentation on those options.  
   \end{docKey}
   
    \begin{docKey}{ContinuedArticleHeaderOptions}{=\meta{options for the continued article header}}{breakable,leftlower=0pt,rightlower=0pt,boxrule=0pt,left=0pt,right=0pt, arc=0pt,auto outer arc,colbacktitle=black,coltitle=white,toptitle=2mm,bottomtitle=2mm}
      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}{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}''. 
   \end{docKey}


 \item \marg{article content}
   This contains arbitrary content, as long no floating objects are involved. 
\end{enumerate}
\end{docCommandArgs}

\end{docCommand}%


\begin{docCommand}{ShipoutArticleTeasers}{}
This places all teasers consecutively without interruption. If this is placed after \refCom{ShipoutArticleHangingArticles}, the teasers are placed after the lower parts of the articles however.
\end{docCommand}

\begin{docCommand}{ShipoutArticleHangingArticles}{}
  This places all continued articles consecutively without interruption from this position. This macro should be placed \textbf{after} \refCom{ShipoutArticleHangingArticles}.
\end{docCommand}


\begin{docCommand}{listofarticle}{}
  This introduces a table of the articles with reference to starting page of the teaser.
\end{docCommand}

\begin{docCommand}{listofcontarticle}{}
  This introduces a table of the continued articles with reference to starting page of the continued article.
\end{docCommand}

\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}
  This command holds the name which is displayed as heading of the list of continued articles. Default value: \textbf{\listofcontinuedarticlesname}
\end{docCommand}



\clearpage

\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 Bookmarks
\item Better behaviour in multicol-environment
\item Improve documentation
\end{itemize}

If you 

\begin{itemize}
  \item find bugs
  \item errors in the documentation
  \item have suggestions
  \item have feature requests
\end{itemize}

don't hesitate and contact me via \makeatletter christian.hupfer@siebenfelsen.de\makeatother

\clearpage

\section{Acknowledgments}

I would like to express my gratitudes to the developpers of fine \LaTeX{} packages and of course
to the users at tex.stackexchange.com, especially to

\begin{itemize}
  \item Enrico Gregorio
  \item Joseph Wright
  \item David Carlisle
\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
write this documentation.

\clearpage


\clearpage

%%%% Index of commands

\printindex

\end{document}