summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-11-28 23:52:30 +0000
committerKarl Berry <karl@freefriends.org>2011-11-28 23:52:30 +0000
commit463fd919920032de4e274499ddce84791bfc914a (patch)
treefcd9189c282a11f60dedd2eb25ca00b7ec376251 /Master/texmf-dist/doc
parentdcd6c04aaf0753bb5c408f12a6487f780bda42c5 (diff)
new latex package fullwidth (28nov11)
git-svn-id: svn://tug.org/texlive/trunk@24684 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/fullwidth/README11
-rw-r--r--Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.pdfbin0 -> 30885 bytes
-rw-r--r--Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.tex14
-rw-r--r--Master/texmf-dist/doc/latex/fullwidth/fullwidth.pdfbin0 -> 251699 bytes
-rw-r--r--Master/texmf-dist/doc/latex/fullwidth/fullwidth.tex128
5 files changed, 153 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/fullwidth/README b/Master/texmf-dist/doc/latex/fullwidth/README
new file mode 100644
index 00000000000..b21b0f8473d
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fullwidth/README
@@ -0,0 +1,11 @@
+This package provides the environment fullwidth.
+The package was inspired by a question of stack exchange
+
+This package provides the environment fullwidth which allows to
+set the left and right margins in a very simple way. It also allows page breaks.
+If you are using the twoside mode you can set the inner and outer margins.
+
+see also: http://tex.stackexchange.com/questions/34368/how-to-switch-between-two-margin-sizes
+
+Author's name: Marco Daniel
+version: 0.1a
diff --git a/Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.pdf b/Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.pdf
new file mode 100644
index 00000000000..75633396e75
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.tex b/Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.tex
new file mode 100644
index 00000000000..5333dd739e8
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fullwidth/fullwidth-test.tex
@@ -0,0 +1,14 @@
+\setcounter{errorcontextlines}{999}
+\documentclass[twoside]{article}
+\usepackage{showframe,lipsum}
+\usepackage[innermargin=-2.0cm,]{fullwidth}
+\begin{document}
+\lipsum
+
+%\clearpage
+\begin{fullwidth}[width=\linewidth+2cm]
+Start\par
+\lipsum[1] \lipsum \lipsum
+ENDE
+\end{fullwidth}
+\end{document} \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/fullwidth/fullwidth.pdf b/Master/texmf-dist/doc/latex/fullwidth/fullwidth.pdf
new file mode 100644
index 00000000000..d901eb54690
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fullwidth/fullwidth.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/fullwidth/fullwidth.tex b/Master/texmf-dist/doc/latex/fullwidth/fullwidth.tex
new file mode 100644
index 00000000000..92e063b1fa3
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fullwidth/fullwidth.tex
@@ -0,0 +1,128 @@
+%Documenation of the package fullwidth
+\setcounter{errorcontextlines}{999}
+\documentclass[parskip=false,english,11pt]{ltxmdf}
+\makeatletter
+\renewcommand\tableofcontents{%
+\setcounter{tocdepth}{1}%
+ \begin{multicols}{2}[\centering\textbf{\sffamily\Large\contentsname}]
+ \@starttoc{toc}
+ \end{multicols}
+}
+\ifoot{}
+\makeatother
+\usepackage{babel}
+\usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
+\usepackage{lipsum}
+%\usepackage[T1,altbullet]{lucidabr}
+\usepackage[scaled=0.82]{beramono}
+
+\usepackage{fullwidth}
+%\fullwidthsetup
+
+\def\fwdname{\texttt{fullwidth}\xspace}
+\title{The \fwdname package}
+\subtitle{Environment with adjustable margins for onside and twoside documents}
+\author{\href{mailto:marco.daniel@mada-nada.de}{Marco Daniel}%
+ \footnote{Sorry for bad English.}}
+\version{\fwdversion}
+\date{\today}
+\introduction{This package provides the environment \fwdname which allows to set the left and right margins in a very simple way. It also allows page breaks. If you are using the \texttt{twoside} mode you can set the inner and outer margins. \par
+By defining new environments the user may choose between several individual designs.%
+}
+
+
+\begin{document}
+\maketitle
+
+\section{Motivation}
+The package is inspired by many questions on \href{http://tex.stackexchange.com/}{tex stackexchange}. For example in the question \href{http://tex.stackexchange.com/questions/34368/how-to-switch-between-two-margin-sizes}{\emph{How to switch between two margin sizes?}} I solved the problem by using the package \mdname. However, since the package wasn't designed for such a environment, I decided to create a new package based on the algorithm of \mdname.
+
+
+
+\section{Syntax}\label{sec:syntax}
+The package itself loads the packages \mdpack{kvoptions} and \mdpack{etoolbox}.
+
+Load the package as usual:
+\begin{mdexample}
+ \usepackage[<GLOBAL OPTIONS>]{fullwidth}
+\end{mdexample}
+
+The package defines only one environment with the following syntax:
+\begin{mdexample}
+ \begin{fullwidth}[<LOCAL OPTIONS>]
+ <CONTENT>
+ \end{fullwidth}
+\end{mdexample}
+
+
+\minisec{Autodetecting floats}
+I added a detection of \mdpack{float} and \mdpack{minipage} environments. If \fwdname would be used within such an environment, \fwdname it would automatically use the option \mdoption{nobreak}.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%
+\section{Options}
+The package provides various options for manipulating frames. All options are listed in the following section. Some internal macros are not shown in this documentation, though they can be manipulated.
+\mdDescribeCmd{fullwidthsetup}The listed option can also be set via \mdcommand{fullwidthsetup}.
+
+\subsection{Options with lengths}
+
+All lengths will be evaluated by the \eTeX-command \mdcommand{dimexpr}.
+
+I know that the predefined lengths are not well prepared. Maybe I will change it later.
+
+
+\mdDescribeMacro[0pt]{width} Sets the width of the whole \fwdname environment.
+
+\mdDescribeMacro[\textbackslash topskip]{skipabove} Sets an additional skip above the frame.
+\mdDescribeMacro[\textbackslash topskip]{skipbelow} Sets an additional skip below the frame.
+
+\mdDescribeMacro[0pt]{leftmargin} Sets the length of the left margin of the environment.
+\mdDescribeMacro[0pt]{rightmargin} Sets the length of the right margin of the environment.
+
+\mdDescribeMacro[.4\textbackslash baselineskip]{innertopmargin} Sets the length of the inner top margin of the environment.
+\mdDescribeMacro[.4\textbackslash baselineskip]{innerbottommargin} Sets the length of the inner bottom margin of the environment.
+
+\mdDescribeMacro[0pt]{outermargin} Sets the length of the outer margin. This option is only avaidable in \texttt{twoside} mode.
+\mdDescribeMacro[0pt]{innermargin} Sets the length of the inner margin. This option is only avaidable in \texttt{twoside} mode.
+
+
+\mdDescribeMacro[\textbackslash topsep]{splittopskip} Sets the length of the skip above the split part of the environment.
+\mdDescribeMacro[0pt]{splitbottomskip} Sets the length of the skip below the split part of the environment.
+
+
+\subsection{General options}\label{genopt}
+
+\mdDescribeMacro[true]{twosidemode} The package detects wether \mdcommand{twoside} mode is active and uses \mdoption{innermargin} and \mdoption{outermagin} by default. If you don't know this you can use this option.
+
+\mdDescribeMacro[0pt]{needspace} Sometimes it is useful to set a minimum height before the environment should be splitted. For such cases you can use \mdoption{needspace}. The option requires a length which sets the minimum height before a frame will be splitted.
+
+\subsection{Footnotes}
+Inside the environment you can use the command \mdcommand{footnote} as usual. \mdname uses the syntax of the environment \mdpack{minipage} with the same counter.
+
+Every footnote text will be collected inside a box and will be displayed at the end of the environment \fwdname.
+
+\mdDescribeMacro[\mbox{} \mdcommand{bigskipamount}]{footnotedistance} The length is the distance between the end of the environment \fwdname and the displaying of the \mdcommand{footnoterule}.
+
+%\mdDescribeMacro[true]{footnoteinside} The position of the footnotes can be changed with the option \mdoption{footnoteinside}. The footnotes will be displayed at the end of the environment but you can decide whether the output is inside \fwdname or after.
+%
+%\vskip\baselineskip
+%\noindent\textbf{Note}\qquad The output of the footnotes with the option \mdoption{footnoteinside=false} are not in a splitted frame. I think it isn't useful because the first line of a new page shouldn't be a footnote.
+
+
+\section{Known Problems}
+ In this section I will collect known problems. In case you encounter any further problems, please
+ drop me an email, \href{mailto:marco.daniel@mada-nada.de}{marco.daniel at mada-nada.de}.
+
+ Do you have any ideas / wishes on further extensions to this package? Please let me know!
+
+\section{Acknowledgements}
+Thanks to the members of \href{http://tex.stackexchange.com/}{tex stackexchange}.
+
+\subsection{Revision history}\label{rev}
+\raggedright
+\minisec{Version 0.1 submitted 26 Nov 2011}
+\begin{itemize*}
+\item first upload to \href{http://dante.ctan.org/upload}{CTAN}
+\end{itemize*}
+\end{document}