From 102739aed82059cd5f00eaf19797597b9e8ecb6c Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 12 Aug 2016 22:20:45 +0000 Subject: latex-veryshortguide (12aug16) git-svn-id: svn://tug.org/texlive/trunk@41844 c570f23f-e606-0410-a88d-b1316a301751 --- .../doc/latex/latex-veryshortguide/README.md | 2 +- .../veryshortguide-A4-imposed.pdf | Bin 525435 -> 525535 bytes .../veryshortguide-Legal-imposed.pdf | Bin 522826 -> 523320 bytes .../latex/latex-veryshortguide/veryshortguide.pdf | Bin 283621 -> 285593 bytes .../latex/latex-veryshortguide/veryshortguide.tex | 135 +++++----- .../doc/latex/latex-veryshortguide/vsg.cls | 2 +- .../doc/latex/latex-veryshortguide/vsg.dtx | 282 +++++++++++++-------- .../doc/latex/latex-veryshortguide/vsg.ins | 2 +- .../doc/latex/latex-veryshortguide/vsg.pdf | Bin 635704 -> 642032 bytes 9 files changed, 242 insertions(+), 181 deletions(-) diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/README.md b/Master/texmf-dist/doc/latex/latex-veryshortguide/README.md index 2f961f837c9..c8f95f67353 100644 --- a/Master/texmf-dist/doc/latex/latex-veryshortguide/README.md +++ b/Master/texmf-dist/doc/latex/latex-veryshortguide/README.md @@ -101,7 +101,7 @@ No outstanding reported bugs at the time of this version. The following statement is included in the source code: Transformed from vsg.xml by ClassPack db2dtx.xsl - version 16.00 (Makefile with XeLaTeX) on Tuesday 9 August 2016 at 21:52:09 + version 16.00 (Makefile with XeLaTeX) on Friday 12 August 2016 at 10:42:12 vsg.cls is copyright © 2009-2016 by Peter Flynn This work may be distributed and/or modified under the diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-A4-imposed.pdf b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-A4-imposed.pdf index 0e5ed9c0587..32f1a8d6a99 100644 Binary files a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-A4-imposed.pdf and b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-A4-imposed.pdf differ diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-Legal-imposed.pdf b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-Legal-imposed.pdf index 5fdb4c6532e..91c859a7d46 100644 Binary files a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-Legal-imposed.pdf and b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide-Legal-imposed.pdf differ diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.pdf b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.pdf index c2f9c6f7af4..ea7d931eeb9 100644 Binary files a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.pdf and b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.pdf differ diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.tex b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.tex index 1540e1589d8..698e51ef644 100644 --- a/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.tex +++ b/Master/texmf-dist/doc/latex/latex-veryshortguide/veryshortguide.tex @@ -1,4 +1,4 @@ -%% The very short guide to typesetting with \LaTeX{} +%% The Very Short Guide to Typesetting with \LaTeX{} \documentclass[a5paper]{vsg} \addbibresource{veryshortguide.bib} \setlength{\bibnamesep}{-\itemsep} @@ -10,76 +10,78 @@ \date{\monthdate} \maketitle \subsection*{What's this all about? What's \LaTeX?} - -\LaTeX\ is a document preparation system which uses the \TeX\ typesetting -program. It enables you to produce publication-quality documents with -great accuracy and consistency. \LaTeX\ works on any computer and -produces industry-standard PDF. It is available both -in free (open-source) and commercial implementations. \LaTeX\ can be -used for any kind of document, but it is especially suited to those -with complex structures, repetitive formatting, or notations like -mathematics\footnote{For reasons of space this guide does not cover - details of mathematics typesetting.}; or where technical stability, -dimensional accuracy, or a persistent and non-proprietary file format -are needed. Install the software from +\LaTeX\ is a document preparation system which uses the \TeX\ +typesetting program. It enables you to produce +publication-quality documents with great accuracy and +consistency. \LaTeX\ works on any computer and produces +industry-standard PDF. It is available both in free (open-source) +and commercial implementations. \LaTeX\ can be used for any kind +of document, but it is especially suited to those with complex +structures, repetitive formatting, or notations like +mathematics\footnote{For reasons of space this guide does not +cover details of mathematics typesetting.}; or where technical +stability, dimensional accuracy, or a persistent and +non-proprietary file format are needed. Install the software from \url{www.tug.org/texlive/} or buy a commercially-supported -version from one of the vendors (see the list on p.\thinspace\pageref{comm}). - +version from one of the vendors (see the list on +p.\thinspace\pageref{comm}). \subsection*{Creating and typesetting your document} - \begin{enumerate}[noitemsep]\setlength{\fboxsep}{1pt} - \item Create your document using any suitable plain-text editor - with \LaTeX\ controls, eg \textit{\TeX shop} (Mac), \textit{\TeX - Maker} (Win), \textit{Kile} (Linux), \textit{Emacs} (all), - even \textit{vi}\thinspace! + \item Create your document using any suitable plain-text + editor with \LaTeX\ controls, eg \textit{\TeX shop} + (Mac), \textit{\TeX Maker} (Win), \textit{Kile} + (Linux), \textit{Emacs} (all), even + \textit{vi}\thinspace! \item Save the file with a name ending in \verb+.tex+ (\emph{never} use spaces in filenames!); - \item Use the {\small\keys{Build}} or {\small\keys{Compile}} - toolbar button or menu item in your editor to typeset and display - the document;\label{typeset} - \item Make any changes needed in your original document and repeat - step \ref{typeset}. + \item Use the {\small\keys{Build}} or + {\small\keys{Compile}} toolbar button or menu item in + your editor to typeset and display the + document;\label{typeset} + \item Make any changes needed in your original document + and repeat step \ref{typeset}. \end{enumerate} - -\subsection*{Syntax (how to type \LaTeX\ commands --- these are the rules)} - +\subsection*{Syntax (how to type \LaTeX\ commands --- these + are the rules)} \begin{itemize}[noitemsep] - \item \textbf{All \LaTeX\ commands begin with a backslash}.\\ - \example \verb+\tableofcontents+\endexample - \item \textbf{If a command needs text to work - with, it goes in curly braces}.\\ - \example \verb+\title{Irisches Tagebuch}\author{Heinrich Böll}+\endexample - \item \textbf{If options are used, they go in square brackets - before the curly braces}.\\ - \example \verb+\documentclass[a4paper,11pt]{book}+\endexample - \item \textbf{Spaces after commands \emph{without} braces get suppressed}.\\ - \example \verb+Copyright \copyright␣+\texttt{\number\year} - \gives{Copyright ©\number\year} \nobox\\ - To prevent this, put empty curly braces after the command:\\ - \example \verb+Copyright \copyright{}␣+\texttt{\number\year} + \item \textbf{All \LaTeX\ commands begin with a + backslash}.\\ \example + \verb+\tableofcontents+\endexample + \item \textbf{If a command needs text to work with, it + goes in curly braces}.\\ \example + \verb+\title{Irisches Tagebuch}\author{Heinrich Böll}+\endexample + \item \textbf{If options are used, they go in square + brackets before the curly braces}.\\ \example + \verb+\documentclass[a4paper,11pt]{book}+\endexample + \item \textbf{Spaces after commands \emph{without} braces + get suppressed}.\\ \example + \verb+Copyright \copyright␣+\texttt{\number\year} + \gives{Copyright ©\number\year} \nobox\\ To prevent + this, put empty curly braces after the + command:\\ \example + \verb+Copyright \copyright{}␣+\texttt{\number\year} \gives{Copyright ©~\number\year} \yesbox - \item \textbf{Curly braces are also used to restrict the scope of - effects inside them}.\\ - \example \verb+Some {\tiny little} word+ \gives{Some {\tiny little} word} + \item \textbf{Curly braces are also used to restrict the + scope of effects inside them}.\\ \example + \verb+Some {\tiny little} word+ \gives{Some {\tiny + little} word} \end{itemize} \begin{note} -This guide shows only a tiny fraction of \LaTeX's power. For more -information, visit the \TeX\ Users Group site (\url{www.tug.org}). For -help, see the FAQ (\url{www.tex.ac.uk/faq}), StackExchange +This guide shows only a tiny fraction of \LaTeX's power. For +more information, visit the \TeX\ Users Group site +(\url{www.tug.org}). For help, see the FAQ +(\url{www.tex.ac.uk/faq}), StackExchange (\url{tex.stackexchange.com}), or the Usenet newsgroup \url{comp.text.tex}. For packages (plugins), use CTAN, the -Comprehensive \TeX\ Archive Network (\url{www.ctan.org}). For -further details, see \citetitle{fi} -\parencite{fi} and other online resources. +Comprehensive \TeX\ Archive Network +(\url{www.ctan.org}). For further details, see +\citetitle{fi} \parencite{fi} and other online resources. \end{note} - \begin{multicols}{2}\small\parskip4pt \subsection*{Writing a \LaTeX\ document} \subsubsection{Basic document structure} - Here's the skeleton of a \LaTeX\ document. These three lines are \textsc{compulsory}: your document will not work without them: - \begin{Verbatim}[frame=single,fontsize=\small,commandchars=!<>] !added\documentclass[11pt]{article} !comment your Preamble goes here (extra setups, if any) @@ -88,20 +90,21 @@ Here's the skeleton of a \LaTeX\ document. These three lines are !added\end{document} \end{Verbatim} \vspace*{-.5\baselineskip} -{\fontsize67\selectfont\sffamily New material in each example is shown -in {\ttfamily\added blue}; material from previous examples is in -black. Comments and mnemonics are in \textcolor{DarkRed}{red}.\par} - +{\fontsize67\selectfont\sffamily New material in each example is +shown in {\ttfamily\added blue}; material from previous examples +is in black. Comments and mnemonics are in +\textcolor{DarkRed}{red}.\par} \begin{itemize}[noitemsep] - \item The document class name \textsc{must} be one of the standard - \verb+book+, \verb+article+, or \verb+report+, or one of the many - others preinstalled or downloadable (eg \verb+thesis+, - \verb+memoir+, etc); - \item There are body type size options \verb+10pt+ (the default), - \verb+11pt+, and \verb+12pt+; - \item There are paper size options including \verb+a4paper+ - (210\thinspace mm$\times$297\thinspace mm) and \verb+letterpaper+ - (8½$''\times$11$''$) [see below]. + \item The document class name \textsc{must} be one of the + standard \verb+book+, \verb+article+, or \verb+report+, + or one of the many others preinstalled or downloadable + (eg \verb+thesis+, \verb+memoir+, etc); + \item There are body type size options \verb+10pt+ (the + default), \verb+11pt+, and \verb+12pt+; + \item There are paper size options including + \verb+a4paper+ (210\thinspace mm$\times$297\thinspace + mm) and \verb+letterpaper+ (8½$''\times$11$''$) [see + below]. \end{itemize} \subsubsection{Front matter} diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.cls b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.cls index c053b1731b0..5193104c894 100644 --- a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.cls +++ b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.cls @@ -9,7 +9,7 @@ %% Amendments and corrections should be notified to the %% maintainer for inclusion in future versions. \NeedsTeXFormat{LaTeX2e}[2015/01/01] -\ProvidesClass{vsg}[2016/06/14 v0.4 +\ProvidesClass{vsg}[2016/08/12 v0.6 The Very Short Guide to LaTeX] \RequirePackage{fix-cm} \PassOptionsToPackage{svgnames}{xcolor} diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.dtx b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.dtx index 8659f82c125..995766a0665 100644 --- a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.dtx +++ b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.dtx @@ -1,7 +1,7 @@ % \iffalse meta-comment % % Transformed from vsg.xml by ClassPack db2dtx.xsl -% version 16.00 (Makefile with XeLaTeX) on Tuesday 9 August 2016 at 21:52:09 +% version 16.00 (Makefile with XeLaTeX) on Friday 12 August 2016 at 10:42:12 % vsg.dtx is copyright © 2009-2016 by Peter Flynn % % This work may be distributed and/or modified under the @@ -28,7 +28,7 @@ \ProvidesFile{vsg.dtx} % %\NeedsTeXFormat{LaTeX2e}[2015/01/01] -%\ProvidesClass{vsg}[2016/06/14 v0.4 +%\ProvidesClass{vsg}[2016/08/12 v0.6 % The Very Short Guide to LaTeX] %<*driver> \RequirePackage{fix-cm}% included by default. @@ -379,6 +379,8 @@ % Grave accent \` Left brace \{ Vertical bar \| % Right brace \} Tilde \~} % +% \changes{v0.6}{2016/08/12}{Fixed bug in imposition: Added -sPAPERSIZE to the reconversion to PDF. Thanks to Bruno Le Floch for spotting this..} +% \changes{v0.5}{2016/08/10}{Started documenting actual text: Trying to explain why I wrote what I wrote. This is unfinished at the moment..} % \changes{v0.4}{2016/06/14}{Moved into ClassPack: Added parameterisation for A4 and Legal.} % \changes{v0.3}{2016/06/04}{Updated to \XeLaTeX{}: Changed fonts again, switched to biber.} % \changes{v0.2}{2013/01/22}{Reissue: Fixed typos and changed font.} @@ -440,9 +442,10 @@ % \DoNotIndex{\classorpackage} % \DoNotIndex{\centering} % \DoNotIndex{\descriptionlabel} +% \DoNotIndex{\author} % -% \def\fileversion{0.4} -% \def\filedate{2016/06/14} +% \def\fileversion{0.6} +% \def\filedate{2016/08/12} % \title{The \textsf{vsg} \LaTeXe\ document class\thanks{% % This document corresponds to \textsf{vsg} % \textit{v.}\ \fileversion $\beta$, dated \filedate.} @@ -473,6 +476,19 @@ % \tableofcontents % \clearpage % \section*{Latest changes} +% \subsection*{v.0.6 (2016-08-12)} +% \paragraph*{Fixed bug in imposition} +% \begin{itemize} +% \item Added \texttt{-sPAPERSIZE} to the reconversion +% to \textsc{pdf}. Thanks to Bruno Le Floch for +% spotting this. +% \end{itemize} +% \subsection*{v.0.5 (2016-08-10)} +% \paragraph*{Started documenting actual text} +% \begin{itemize} +% \item Trying to explain why I wrote what I wrote. This +% is unfinished at the moment. +% \end{itemize} % \subsection*{v.0.4 (2016-06-14)} % \paragraph*{Moved into ClassPack} % \begin{itemize} @@ -484,16 +500,6 @@ % \item Changed fonts again, switched to % \emph{biber} % \end{itemize} -% \subsection*{v.0.2 (2013-01-22)} -% \paragraph*{Reissue} -% \begin{itemize} -% \item Fixed typos and changed font -% \end{itemize} -% \subsection*{v.0.1 (2009-10-01)} -% \paragraph*{Reworked from 2006 original} -% \begin{itemize} -% \item Changed to 4pp A4 -% \end{itemize} % See p.\thinspace\pageref{changehistory} for details of earlier changes. % \clearpage % \section{Acknowledgements} @@ -543,46 +549,47 @@ % \textsc{pdf} output to \textsc{ps}. Pass % it through the \emph{pstops} utility to % perform imposition, and then use -% \emph{ps2pdf} to convert the output back -% to \textsc{pdf}. For the A5/A4 format, this means:\par +% \emph{ps2pdf} to convert the output back +% to \textsc{pdf}. For each format generated, this +% means:\par % \iffalse %<*ignore> % \fi \begin{lstlisting}[language=bash] pdf2ps veryshortguide.pdf - |\ pstops -pa4 -b \ - "4:-3L(21cm,5mm)+0L(21cm,14.35cm),1L(21cm,5mm)+-2L(21cm,14.35cm)" |\ - ps2pdf - veryshortguide-imposed.pdf + "4:-3L(21cm,0mm)+0L(21cm,14.85cm),1L(21cm,0mm)+-2L(21cm,14.85cm)" |\ + ps2pdf -sPAPERSIZE=a4 - veryshortguide-A4-imposed.pdf + +pdf2ps veryshortguide.pdf - |\ + pstops -plegal -b \ + "4:-3L(8.5in,0in)+0L(8.5in,7in),1L(8.5in,0in)+-2L(8.5in,7in)" |\ + ps2pdf -sPAPERSIZE=legal - veryshortguide-Legal-imposed.pdf \end{lstlisting} % \iffalse % % \fi -% Pages are references from zero (the first page). This -% outputs page 3 (p.4) and page 0 (p.1) on the first side of -% A4. The 21cm places the reference point (top left corner) at -% that distance \emph{up} (\(y\)-axis, the short side of a piece of A4 -% landscape), and 5mm to the \emph{right} -% (\(x\)-axis, the long side) for p.4, and 14.35cm to -% the right for p.1.\par -% The verso is produced by the second expression, outputting -% page 1 (p.2) and page 2 (p.3) in exactly the same way.\par -% \clearpage -% \begin{figure}[p]\small\sffamily\centering -% \caption{Effect of imposition (A4 version) above: front and -% back; below: inside.}\medskip -% \includepdf[pages=1,scale=0.7,angle=270,offset=0 7.2cm,frame]{veryshortguide-A4-imposed.pdf} -% \par -% \includepdf[pages=2,scale=0.7,angle=270,offset=0 -4.2cm,frame]{veryshortguide-A4-imposed.pdf} -% \end{figure} -% \clearpage -% Normally, there would be no horizontal adjustment, but -% because my printer cannot print the bottom 12mm of a sheet -% (the last edge to emerge from the printer), if I print 2–up A5 -% pages on an A4 sheet like this, I need to allow for the fact -% that one edge of two of the pages must have a 12mm margin, so -% this amount of adjustment (5mm) was needed to make it -% symmetrical. If your printer can bleed off the trailing edge, -% then you can adjust the horizontal dimensions accordingly.\par +% Pages are referenced from zero (the first page). This +% outputs page 3 (p.4) and page 0 (p.1) on the first side. The +% 21cm or 8.5in places the reference point (top left corner) +% at that distance \emph{up} (\(y\)-axis, the short side of a piece of +% landscape paper), and 0mm/0in to the +% \emph{right} (\(x\)-axis, the long side) for p.4, and half the +% paper-length (14.85mm or 7in) to the right for p.1.\par +% The verso is produced by the second expression, +% outputting page 1 (p.2) and page 2 (p.3) in exactly the same +% way.\par +% You may need to adjust these dimensions if your printer +% cannot print all the way to the edge of the sheet. Normally, +% there would be no horizontal adjustment, but because my +% printer cannot print the bottom 12mm of a sheet (the last +% edge to emerge from the printer), if I print 2–up A5 pages +% on an A4 sheet like this, I need to allow for the fact that +% one edge of two of the pages must have a 12mm margin, so +% I have to add 5mm to the horizontal offset to make it +% symmetrical. If your printer can bleed off the trailing +% edge, then you can adjust the horizontal dimensions +% accordingly.\par % When printing from Acrobat Reader, it generates the % \emph{lpr}\thinspace(1) command that it % will use. The example below is from my own system:\par @@ -598,6 +605,15 @@ lpr -P \ % \iffalse % % \fi +% \clearpage +% \begin{figure}[p]\small\sffamily\centering +% \caption{Effect of imposition (A4 version) above: front and +% back; below: inside.}\medskip +% \includepdf[pages=1,scale=0.6,angle=270,offset=-5mm 7.2cm,frame]{veryshortguide-A4-imposed.pdf} +% \par +% \includepdf[pages=2,scale=0.6,angle=270,offset=-5mm -4.2cm,frame]{veryshortguide-A4-imposed.pdf} +% \end{figure} +% \clearpage % \StopEventually{\label{endcode} % \clearpage % \newgeometry{left=3cm} @@ -1156,15 +1172,26 @@ lpr -P \ %<*veryshortguide> % \fi % \clearpage -% \section{The very short guide to typesetting with \LaTeX{}}\label{veryshortguide} +% \section{The Very Short Guide to Typesetting with \LaTeX{}}\label{veryshortguide} % \iffalse -%% The very short guide to typesetting with \LaTeX{} +%% The Very Short Guide to Typesetting with \LaTeX{} % \fi -% This is the base text for the Very Short Guide.\par +% This is the base text for the Very Short Guide. The +% default layout is for A4 paper\par % \begin{macrocode} \documentclass[a5paper]{vsg} +% \end{macrocode} +% \subsection{Preamble} +% The \BibTeX{} file is generated from \vref{vsg-bib} (a future version should probably do this +% via \textsc{xml} too). To save space, we compress +% the space between entries.\par +% \begin{macrocode} \addbibresource{veryshortguide.bib} \setlength{\bibnamesep}{-\itemsep} +% \end{macrocode} +% Titling is standard except for the additional material +% in the {\ttfamily{}\textbackslash{}author}.\par +% \begin{macrocode} \begin{document} \title{The very short guide to typesetting with~\LaTeX} \author{Silmaril Consultants\\ @@ -1172,77 +1199,104 @@ lpr -P \ \protect\url{http://latex.silmaril.ie}} \date{\monthdate} \maketitle +% \end{macrocode} +% \subsection{Introduction on front page} +% The introduction needs to get across \begin{enumerate*}[label=\emph{\alph*})] +% \item what \LaTeX{} is +% \item what it’s for +% \item where you can get it +% \end{enumerate*}\par +% \begin{macrocode} \subsection*{What's this all about? What's \LaTeX?} - -\LaTeX\ is a document preparation system which uses the \TeX\ typesetting -program. It enables you to produce publication-quality documents with -great accuracy and consistency. \LaTeX\ works on any computer and -produces industry-standard PDF. It is available both -in free (open-source) and commercial implementations. \LaTeX\ can be -used for any kind of document, but it is especially suited to those -with complex structures, repetitive formatting, or notations like -mathematics\footnote{For reasons of space this guide does not cover - details of mathematics typesetting.}; or where technical stability, -dimensional accuracy, or a persistent and non-proprietary file format -are needed. Install the software from +\LaTeX\ is a document preparation system which uses the \TeX\ +typesetting program. It enables you to produce +publication-quality documents with great accuracy and +consistency. \LaTeX\ works on any computer and produces +industry-standard PDF. It is available both in free (open-source) +and commercial implementations. \LaTeX\ can be used for any kind +of document, but it is especially suited to those with complex +structures, repetitive formatting, or notations like +mathematics\footnote{For reasons of space this guide does not +cover details of mathematics typesetting.}; or where technical +stability, dimensional accuracy, or a persistent and +non-proprietary file format are needed. Install the software from \url{www.tug.org/texlive/} or buy a commercially-supported -version from one of the vendors (see the list on p.\thinspace\pageref{comm}). - +version from one of the vendors (see the list on +p.\thinspace\pageref{comm}). +% \end{macrocode} +% Summarise the process: show that it’s simple.\par +% \begin{macrocode} \subsection*{Creating and typesetting your document} - \begin{enumerate}[noitemsep]\setlength{\fboxsep}{1pt} - \item Create your document using any suitable plain-text editor - with \LaTeX\ controls, eg \textit{\TeX shop} (Mac), \textit{\TeX - Maker} (Win), \textit{Kile} (Linux), \textit{Emacs} (all), - even \textit{vi}\thinspace! + \item Create your document using any suitable plain-text + editor with \LaTeX\ controls, eg \textit{\TeX shop} + (Mac), \textit{\TeX Maker} (Win), \textit{Kile} + (Linux), \textit{Emacs} (all), even + \textit{vi}\thinspace! \item Save the file with a name ending in \verb+.tex+ (\emph{never} use spaces in filenames!); - \item Use the {\small\keys{Build}} or {\small\keys{Compile}} - toolbar button or menu item in your editor to typeset and display - the document;\label{typeset} - \item Make any changes needed in your original document and repeat - step \ref{typeset}. + \item Use the {\small\keys{Build}} or + {\small\keys{Compile}} toolbar button or menu item in + your editor to typeset and display the + document;\label{typeset} + \item Make any changes needed in your original document + and repeat step \ref{typeset}. \end{enumerate} - -\subsection*{Syntax (how to type \LaTeX\ commands --- these are the rules)} - +% \end{macrocode} +% And summarise the syntax to demystify it.\par +% \begin{macrocode} +\subsection*{Syntax (how to type \LaTeX\ commands --- these + are the rules)} \begin{itemize}[noitemsep] - \item \textbf{All \LaTeX\ commands begin with a backslash}.\\ - \example \verb+\tableofcontents+\endexample - \item \textbf{If a command needs text to work - with, it goes in curly braces}.\\ - \example \verb+\title{Irisches Tagebuch}\author{Heinrich Böll}+\endexample - \item \textbf{If options are used, they go in square brackets - before the curly braces}.\\ - \example \verb+\documentclass[a4paper,11pt]{book}+\endexample - \item \textbf{Spaces after commands \emph{without} braces get suppressed}.\\ - \example \verb+Copyright \copyright␣+\texttt{\number\year} - \gives{Copyright ©\number\year} \nobox\\ - To prevent this, put empty curly braces after the command:\\ - \example \verb+Copyright \copyright{}␣+\texttt{\number\year} + \item \textbf{All \LaTeX\ commands begin with a + backslash}.\\ \example + \verb+\tableofcontents+\endexample + \item \textbf{If a command needs text to work with, it + goes in curly braces}.\\ \example + \verb+\title{Irisches Tagebuch}\author{Heinrich Böll}+\endexample + \item \textbf{If options are used, they go in square + brackets before the curly braces}.\\ \example + \verb+\documentclass[a4paper,11pt]{book}+\endexample + \item \textbf{Spaces after commands \emph{without} braces + get suppressed}.\\ \example + \verb+Copyright \copyright␣+\texttt{\number\year} + \gives{Copyright ©\number\year} \nobox\\ To prevent + this, put empty curly braces after the + command:\\ \example + \verb+Copyright \copyright{}␣+\texttt{\number\year} \gives{Copyright ©~\number\year} \yesbox - \item \textbf{Curly braces are also used to restrict the scope of - effects inside them}.\\ - \example \verb+Some {\tiny little} word+ \gives{Some {\tiny little} word} + \item \textbf{Curly braces are also used to restrict the + scope of effects inside them}.\\ \example + \verb+Some {\tiny little} word+ \gives{Some {\tiny + little} word} \end{itemize} +% \end{macrocode} +% Point readers at sources of information. If they read +% nothing else but the front page, at least they now know what +% they’re dealing with.\par +% \begin{macrocode} \begin{note} -This guide shows only a tiny fraction of \LaTeX's power. For more -information, visit the \TeX\ Users Group site (\url{www.tug.org}). For -help, see the FAQ (\url{www.tex.ac.uk/faq}), StackExchange +This guide shows only a tiny fraction of \LaTeX's power. For +more information, visit the \TeX\ Users Group site +(\url{www.tug.org}). For help, see the FAQ +(\url{www.tex.ac.uk/faq}), StackExchange (\url{tex.stackexchange.com}), or the Usenet newsgroup \url{comp.text.tex}. For packages (plugins), use CTAN, the -Comprehensive \TeX\ Archive Network (\url{www.ctan.org}). For -further details, see \citetitle{fi} -\parencite{fi} and other online resources. +Comprehensive \TeX\ Archive Network +(\url{www.ctan.org}). For further details, see +\citetitle{fi} \parencite{fi} and other online resources. \end{note} - +% \end{macrocode} +% \subsection{Getting started with a short document} +% Now we start the meat: a skeleton document structure +% that shows the document class, Preamble, and where you put +% the text.\par +% \begin{macrocode} \begin{multicols}{2}\small\parskip4pt \subsection*{Writing a \LaTeX\ document} \subsubsection{Basic document structure} - Here's the skeleton of a \LaTeX\ document. These three lines are \textsc{compulsory}: your document will not work without them: - \begin{Verbatim}[frame=single,fontsize=\small,commandchars=!<>] !added\documentclass[11pt]{article} !comment your Preamble goes here (extra setups, if any) @@ -1251,20 +1305,24 @@ Here's the skeleton of a \LaTeX\ document. These three lines are !added\end{document} \end{Verbatim} \vspace*{-.5\baselineskip} -{\fontsize67\selectfont\sffamily New material in each example is shown -in {\ttfamily\added blue}; material from previous examples is in -black. Comments and mnemonics are in \textcolor{DarkRed}{red}.\par} - +{\fontsize67\selectfont\sffamily New material in each example is +shown in {\ttfamily\added blue}; material from previous examples +is in black. Comments and mnemonics are in +\textcolor{DarkRed}{red}.\par} +% \end{macrocode} +% Explain the rubrication.\par +% \begin{macrocode} \begin{itemize}[noitemsep] - \item The document class name \textsc{must} be one of the standard - \verb+book+, \verb+article+, or \verb+report+, or one of the many - others preinstalled or downloadable (eg \verb+thesis+, - \verb+memoir+, etc); - \item There are body type size options \verb+10pt+ (the default), - \verb+11pt+, and \verb+12pt+; - \item There are paper size options including \verb+a4paper+ - (210\thinspace mm$\times$297\thinspace mm) and \verb+letterpaper+ - (8½$''\times$11$''$) [see below]. + \item The document class name \textsc{must} be one of the + standard \verb+book+, \verb+article+, or \verb+report+, + or one of the many others preinstalled or downloadable + (eg \verb+thesis+, \verb+memoir+, etc); + \item There are body type size options \verb+10pt+ (the + default), \verb+11pt+, and \verb+12pt+; + \item There are paper size options including + \verb+a4paper+ (210\thinspace mm$\times$297\thinspace + mm) and \verb+letterpaper+ (8½$''\times$11$''$) [see + below]. \end{itemize} \subsubsection{Front matter} diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.ins b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.ins index 4a8879624d5..747ffebaeba 100644 --- a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.ins +++ b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.ins @@ -1,5 +1,5 @@ %% Transformed from vsg.xml by ClassPack db2dtx.xsl -% version 16.00 (Makefile with XeLaTeX) on Tuesday 9 August 2016 at 21:52:09 +% version 16.00 (Makefile with XeLaTeX) on Friday 12 August 2016 at 10:42:12 % vsg.ins is copyright © 2009-2016 by Peter Flynn % % This work may be distributed and/or modified under the diff --git a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.pdf b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.pdf index baf4cf6faab..e1507e64d0c 100644 Binary files a/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.pdf and b/Master/texmf-dist/doc/latex/latex-veryshortguide/vsg.pdf differ -- cgit v1.2.3