summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/magaz/magaz.tex
blob: 8cae98006a80a2e11e5919e4fb76034149eb64b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
\documentclass[parskip=half, pagesize=auto]{scrartcl}

\usepackage{fixltx2e}
\usepackage{etex}
\usepackage{xspace}
\usepackage{lmodern}
\usepackage[T1]{fontenc}
\usepackage{textcomp}
\usepackage{microtype}
\usepackage{hyperref}

\newcommand*{\mail}[1]{\href{mailto:#1}{\texttt{#1}}}
\newcommand*{\pkg}[1]{\textsf{#1}}
\newcommand*{\cs}[1]{\texttt{\textbackslash#1}}
\makeatletter
\newcommand*{\cmd}[1]{\cs{\expandafter\@gobble\string#1}}
\makeatother
\addtokomafont{title}{\rmfamily}

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


\begin{document}

\maketitle

\begin{quote}
  \small
  This software may be freely used, transmitted, reproduced, or modified
  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}.

\medskip
\noindent Features:\\[4pt]
\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)           \\
  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)
\end{tabular}


\minisec{Instructions:}

The \cmd{\FirstLine} command takes one argument: Some 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.

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

\end{document}