diff options
author | Karl Berry <karl@freefriends.org> | 2011-11-30 00:19:59 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-11-30 00:19:59 +0000 |
commit | 99a32e30f2adbd8dd4a97967f8541b60300c04ef (patch) | |
tree | 04f8bf1e3db16491189501ca874285e820f4487a /Master/texmf-dist/doc/latex/magaz | |
parent | b2f7b1757cf1264270da016740bbdbf7d61983e8 (diff) |
magaz 0.4 (29nov11)
git-svn-id: svn://tug.org/texlive/trunk@24694 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/magaz')
-rw-r--r-- | Master/texmf-dist/doc/latex/magaz/magaz.pdf | bin | 163321 -> 244266 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/magaz/magaz.tex | 123 |
2 files changed, 92 insertions, 31 deletions
diff --git a/Master/texmf-dist/doc/latex/magaz/magaz.pdf b/Master/texmf-dist/doc/latex/magaz/magaz.pdf Binary files differindex 1a4fc6f6bca..61ae96222cd 100644 --- a/Master/texmf-dist/doc/latex/magaz/magaz.pdf +++ b/Master/texmf-dist/doc/latex/magaz/magaz.pdf diff --git a/Master/texmf-dist/doc/latex/magaz/magaz.tex b/Master/texmf-dist/doc/latex/magaz/magaz.tex index 8cae98006a8..6939578f20d 100644 --- a/Master/texmf-dist/doc/latex/magaz/magaz.tex +++ b/Master/texmf-dist/doc/latex/magaz/magaz.tex @@ -1,4 +1,4 @@ -\documentclass[parskip=half, pagesize=auto]{scrartcl} +\documentclass[parskip=half, pagesize=auto, 12pt]{scrartcl} \usepackage{fixltx2e} \usepackage{etex} @@ -7,21 +7,27 @@ \usepackage[T1]{fontenc} \usepackage{textcomp} \usepackage{microtype} -\usepackage{hyperref} +%\usepackage{hyperref} +\usepackage{shortvrb} \newcommand*{\mail}[1]{\href{mailto:#1}{\texttt{#1}}} \newcommand*{\pkg}[1]{\textsf{#1}} \newcommand*{\cs}[1]{\texttt{\textbackslash#1}} +\newcommand*{\meta}[1]{\ensuremath{\langle}\textsl{#1}\ensuremath{\rangle}} \makeatletter \newcommand*{\cmd}[1]{\cs{\expandafter\@gobble\string#1}} +\g@addto@macro\@listI{\itemsep\z@skip} \makeatother \addtokomafont{title}{\rmfamily} +\MakeShortVerb" +\frenchspacing + \sloppy -\title{The \pkg{magaz} package\thanks{This manual corresponds to \pkg{magaz}~v0.3, dated~22--Nov--2011.}} -\author{Donald Arseneau, \mail{asnd@triumf.ca}, Vancouver, Canada} -\date{22--Nov--2011} +\title{The \pkg{magaz} package\thanks{This manual corresponds to \pkg{magaz}~v0.4, dated~24--Nov--2011.}} +\author{Donald Arseneau, \texttt{asnd@triumf.ca}, Vancouver, Canada} +\date{24--Nov--2011} \begin{document} @@ -34,42 +40,97 @@ provided that the copyright notice and this permission is retained. \end{quote} -This version is just a single tool from a larger body of tools I am -unlikely to implement. I wrote this in 1999 in response to a request -on \texttt{comp.text.tex}. +This package was intended to eventually be a collection of tools to aid +magazine-style document formatting, but this version is just a single +tool I first wrote in 1999 in response to a request on \texttt{comp.text.tex}: +How to apply a formatting choice (font) the the first line of a paragraph. +The full list of features is: -\medskip -\noindent Features:\\[4pt] +\begin{center} \begin{tabular}{@{}rl@{}} Yes & Special formatting for first line of text in a paragraph \\ - No & Special formatting for for first $n$ lines (allow each different) \\ - No & Also for first character (drop caps) (working together) \\ - No & ``Continued on''/``continued from'' markers (like fwlw) \\ +Maybe & Special formatting for for first $n$ lines (allow each different) \\ +Maybe & Also for first character (drop caps) (working together) \\ + No & ``Continued on''/``continued from'' markers (like varioref marks) \\ No & wrapfig spanning columns \\ No & wrapfig placed at fixed location on page \\ - No & Integration with shapepar \\ - NO! & Piecing together fragments of gallies to fit page (maybe flowfram) + No & Integration with shapepar, especially cutouts \\ + No & Piecing together fragments of gallies to fit page (maybe flowfram) \end{tabular} +\end{center} +Most of those features are very unlikely to ever be added to this package. -\minisec{Instructions:} +\section*{First-Line Formatting} -The \cmd{\FirstLine} command takes one argument: Some text. +\noindent \cmd{\FirstLine}"{"\meta{text}"}" -The first line of this text will be formatted according to -\cmd{\FirstLineFont}; but if the text occupies less than a line, all -that text (and no more) will be affected by \cmd{\FirstLineFont}. -The argument should be ordinary text, not lists and displayed -equations. Such things will give you a `Bad text' error. +\medskip -This command is intended to be used in a replacement for a normal -sectioning command in a document class; \cmd{\paragraph} would be -appropriate. In particular, this \cmd{\paragraph} (or whatever) should -insert vertical space and penalties etc.,\ and probably \cmd{\noindent} -at the start of the argument. The document class should also define -\cmd{\FirstLineFont} appropriately as either a switch or a text-command; -as in \verb+\renewcommand\FirstLineFont{\MakeUppercase}+. The defult -definition performed in \pkg{magaz.sty} is -\verb+\providecommand\FirstLineFont{\scshape}+. +The "\FirstLine" command is placed at the beginning of a paragraph, +and takes one argument: Some text. The first line of this text will +be formatted according to "\FirstLineFont"; but if the text occupies +less than a full line of the paragraph, all that text (and no more) +will be affected by "\FirstLineFont". + +You should define "\FirstLineFont" appropriately as either a switch +or a text-command; as in "\renewcommand\FirstLineFont{\MakeUppercase}". +The defult definition performed in \pkg{magaz.sty} is +"\providecommand\FirstLineFont{\scshape}". + +The parameter for "\FirstLine" should be ordinary text, not containing +lists or displayed equations -- such things will give you a ``Bad text'' +error. If the parameter text ends with a space, that space will be +removed. A line break may sometimes be permitted after the parameter +text even if the ensuing text prohibits one (using "~"). Furthermore, +the text should be constant, or else the successive measurements made +internally will not be consistent, and the output may be corrupted +(with words missing or duplicated). Some subtle sources of inconstant +text are: +\begin{itemize} +\item Incrementing a counter (and printing the value). +\item "\everypar" that executes once and is cleared. (This occurs after + section heads and inside list/quotation/center/etc. environments, + but those cases are handled, somewhat.) +\item A "\FirstLineFont" that affects hyphenation (as "\texttt" or a + language setting will). +\item Changing paragraph-layout parameters in "\FirstLineFont". +\end{itemize} +Other deviations from simple text can give poor formatting. Here are some +`advanced' tips: +\begin{itemize} + \item Using "\FirstLine" in the middle of a paragraph will make a mess. + (It should be used to start a paragraph, or placed at the beginning + of one started with "\noindent". Using it after "\\" should also + work.) + \item Multiple "\vspace" or "\\*" or "\\[]" will cause failure; + a single "\vspace" will be ignored. + \item Although there is no corruption if used immediately after a + "\section" command (or similar) that suppresses indentation, + the paragraph will likely be indented anyway. The fix for + this (and similar problems) is to begin the paragraph with + "\noindent" before "\FirstLine". + \item Using an inflexible "\parfillskip" might cause some highlighted + first-line text to be dragged down to the second line. (Providing + more text in the argument will usually solve this.) (If you + don't know about "\parfillskip" you probably don't have to worry.) + \item A large font for "\FirstLineFont" may be too crowded with the + second line, and inserting "\vspace" will not help (this should + be improved) so you may need to resort to a "\strut", as with\\ + "\renewcommand\FirstLineFont{\large\strut\MakeUppercase}" + \end{itemize} + +The "\FirstLine" system is intended to be used in a replacement for +a normal sectioning command in a document class; "\paragraph" would be +appropriate. In particular, this "\paragraph" (or whatever) should +insert vertical space and penalties etc., and probably "\noindent" +at the start of the argument. The document class should also define +"\FirstLineFont" appropriately as either a switch or a text-command; +as in "\renewcommand\FirstLineFont{\scshape\textcolor{blue}}". The +defult definition is "\providecommand\FirstLineFont{\scshape}". + +\section*{All Other Features} + +Not implemented. \end{document} |