diff options
author | Karl Berry <karl@freefriends.org> | 2006-08-20 00:02:10 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2006-08-20 00:02:10 +0000 |
commit | 524b07990fd2040ab6ce24b015b9a2bd4544a3c1 (patch) | |
tree | 93d7c1e1089e6c5df66ce81b57ed93482321baaa /Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex | |
parent | affc79c45bfab740028ac1e6b8480c5465a42b01 (diff) |
koma-script 2.95b, using provided texmf zip
git-svn-id: svn://tug.org/texlive/trunk@1990 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex | 424 |
1 files changed, 424 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex new file mode 100644 index 00000000000..bfec76cae44 --- /dev/null +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex @@ -0,0 +1,424 @@ +% ====================================================================== +% guide-english.tex +% Copyright (c) Markus Kohm, 2002-2006 +% +% This file is part of the LaTeX2e KOMA-Script bundle. +% +% This work may be distributed and/or modified under the conditions of +% the LaTeX Project Public License, version 1.3b of the license. +% The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3b or later is part of all distributions of LaTeX +% version 2005/12/01 or later and of this work. +% +% This work has the LPPL maintenance status "author-maintained". +% +% The Current Maintainer and author of this work is Markus Kohm. +% +% This work consists of all files listed in manifest.txt. +% ---------------------------------------------------------------------- +% guide-english.tex +% Copyright (c) Markus Kohm, 2002-2006 +% +% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, +% Version 1.3b, verteilt und/oder veraendert werden. +% Die neuste Version dieser Lizenz ist +% http://www.latex-project.org/lppl.txt +% und Version 1.3b ist Teil aller Verteilungen von LaTeX +% Version 2005/12/01 oder spaeter und dieses Werks. +% +% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained" +% (allein durch den Autor verwaltet). +% +% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm. +% +% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien. +% ====================================================================== +% +% Language dependencies (english) of the KOMA-Script guide +% Maintained by Markus Kohm +% +% ---------------------------------------------------------------------- +% +% Sprachabhängigkeiten (english) der KOMA-Script-Anleitung +% Verwaltet von Markus Kohm +% +% ====================================================================== +% +\ProvidesFile{guide-english.tex}[{2006/05/10 + KOMA-Script guide language dependencies}] +% +% \section{Title} +% +% \begin{macro}{\GuideSubject} +% \begin{macro}{\GuideTitle} +% \begin{macro}{\GuideSubTitle} +% \begin{macro}{\GuideAuthorHeadline} +% \begin{macro}{\GuideWarrantyHeadline} +% \begin{macro}{\GuideWarranty} +% \begin{macro}{\GuideCopyright} +% \begin{macro}{\GuideDedication} +% Language dependencies of all the title pages. +% \begin{macrocode} +\newcommand*{\GuideSubject}{The Guide}% +\newcommand*{\GuideTitle}{\KOMAScript}% +\newcommand*{\GuideSubTitle}{a versatile \LaTeXe{} bundle}% +\newcommand*{\GuideAuthorHeadline}{Authors of the \KOMAScript{} Bundle}% +\newcommand*{\GuideWarrantyHeadline}{Legal Notes:}% +\newcommand*{\GuideWarranty}{There is no warranty for any part of the + documented Software. The authors have taken care in the preparation of this + book, but make no expressed or implied warranty of any kind and assume no + responsibility for errors or omissions. No liability is assumed for + incidental or consequential damages in connection with or arising out of the + use of the inromation or programs contained here.\par\medskip% + Many of the designations used by manufacturers and sellers to distinguish + their products are claimed as trademarks. Where those designations appear in + this book, and the authors were aware ot a trademark claim, the designations + have been printed with initial capital letters or in all capitals.}% +\newcommand*{\GuideCopyright}{Free screen version without any optimization of + paragraph and page breaks\par\medskip% + This guide is part of \KOMAScript{}, which is free under the terms and + conditions of LaTeX Project Public License Version 1.3b. A version of this + license, which is valid to \KOMAScript{}, is part of \KOMAScript{} (see + \File{lppl.txt}). Distribution of this manual\,---\,even if it is + printed\,---\,is allowed provided that all parts of \KOMAScript{} are + distributed. Distribution without the other parts of \KOMAScript{} needs a + explicit, additional authorization by the authors.}% +\newcommand*{\GuideDedication}{To All Friends of Typography!}% +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% +% +% \section{CTAN Server to be Used} +% +% \begin{macro}{\GuideCTANserver} +% \begin{macrocode} +\newcommand*{\GuideCTANserver}{ftp.ctan.org} +% \end{macrocode} +% \end{macro} +% +% +% \section{Terms} +% +% Some terms, e.g. used at index notes. +% +% \begin{macro}{\GuideClass} +% The term »class«. +% \begin{macrocode} +\newcommand*{\GuideClass}{class} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideCounter} +% The term »counter«. +% \begin{macrocode} +\newcommand*{\GuideCounter}{counter} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideEnvironment} +% The term »environment«. +% \begin{macrocode} +\newcommand*{\GuideEnvironment}{environment} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideExample} +% The term »Example« used at a kind of heading, so it should be upper case. +% \begin{macrocode} +\newcommand*{\GuideExample}{Example} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideFile} +% The term »file«. +% \begin{macrocode} +\newcommand*{\GuideFile}{file} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideFloatstyle} +% The term »\Package{float} style«. +% \begin{macrocode} +\newcommand*{\GuideFloatstyle}{\Package{float} style} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideFontElement} +% The term »element«. +% \begin{macrocode} +\newcommand*{\GuideFontElement}{element} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideLength} +% The term »length«. +% \begin{macrocode} +\newcommand*{\GuideLength}{length} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideMacro} +% \begin{macro}{\GuideCommand} +% The term »command«. +% \begin{macrocode} +\newcommand*{\GuideMacro}{command} +\let\GuideCommand\GuideMacro +% \end{macrocode} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\GuideOption} +% The term »option«. +% \begin{macrocode} +\newcommand*{\GuideOption}{option} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuidePackage} +% The term »package«. +% \begin{macrocode} +\newcommand*{\GuidePackage}{package} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuidePagestyle} +% The term »page style«. +% \begin{macrocode} +\newcommand*{\GuidePagestyle}{page style} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuidePLength} +% \begin{macro}{\GuidePseudoPrefix} +% The prefix »pseudo« at the term »pseudo length« and the term itself. +% \begin{macrocode} +\newcommand*{\GuidePseudoPrefix}{pseudo } +\newcommand*{\GuidePLength}{\GuidePseudoPrefix\GuideLength} +% \end{macrocode} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\GuideVariable} +% The termo »variable«. +% \begin{macrocode} +\newcommand*{\GuideVariable}{variable} +% \end{macrocode} +% \end{macro} +% +% +% \section{Index} +% +% \begin{macro}{\GuidegenIndex} +% \begin{macro}{\GuidecmdIndex} +% \begin{macro}{\GuidecmdIndexShort} +% \begin{macro}{\GuidelenIndex} +% \begin{macro}{\GuidelenIndexShort} +% \begin{macro}{\GuideelmIndex} +% \begin{macro}{\GuideelmIndexShort} +% \begin{macro}{\GuidefilIndex} +% \begin{macro}{\GuidefilIndexShort} +% \begin{macro}{\GuideoptIndex} +% \begin{macro}{\GuideoptIndexShort} +% The titles and short titles of each single index. +\newcommand*{\GuidegenIndex}{General Index}% +\newcommand*{\GuidecmdIndex}{Index of Commands, Environments, and Variables}% +\newcommand*{\GuidecmdIndexShort}{Index of Commands etc.}% +\newcommand*{\GuidelenIndex}{Index of Lengths and Counters}% +\newcommand*{\GuidelenIndexShort}{Index der Lengths etc.}% +\newcommand*{\GuideelmIndex}{Index of Elements with Capability of + Font Adjustment}% +\newcommand*{\GuideelmIndexShort}{Index of Elements}% +\newcommand*{\GuidefilIndex}{Index of Files, Classes, and Packages}% +\newcommand*{\GuidefilIndexShort}{Index of Files etc.}% +\newcommand*{\GuideoptIndex}{Index of Class and Package Options}% +\newcommand*{\GuideoptIndexShort}{Index of Options}% +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\GuideIndexPreamble} +% The preamble text of the whole index. +\newcommand*{\GuideIndexPreamble}{% + There are two kinds of page numbers at this index. The bold printed numbers + show the pages of declaration or explanation of the topic. The normal + printed numbers show the pages of using a topic.% +} +% \end{macro} +% +% +% \section{Bibliography} +% +% \begin{macro}{\GuideBibPreamble} +% \begin{macrocode} +\newcommand*{\GuideBibPreamble}{% + In the following you can find many references. All of them are referenced + from the main text. In many cases the reference points to documents or + directories which can be accessed via Internet. In these cases the + reference includes a URL instead of a publisher. If the reference points to + a \LaTeX{} package then the URL is written in the form + ``\url{CTAN://}\emph{destination}''. The prefix ``\url{CTAN://}'' means the + \TeX{} archive on a CTAN server or mirror. For example, you can substitude + the prefix with \url{ftp://\GuideCTANserver/tex-archive/}. For \LaTeX{} + packages it is also important to mention that we have tried to give a + version number appropriate to the text that cites the reference. But for + some packages is is very difficult to find a consistent version number and + release date. Additionally the given version is not always the current + version. If you want install new packages take care that the package is the + most up-to-date version and check first whether the package is already + available on your system or not.% +} +% \end{macrocode} +% \end{macro} +% +% +% \section{Change Log} +% +% \begin{macro}{\GuideChangeLogPreamble} +% The preamble of the change log index. +% \begin{macrocode} +\newcommand*{\GuideChangeLogPreamble}{% + At this list of changes you will find all significant changes of the user + interface of the \KOMAScript{} bundle at the last few versions. The list was + sorted about the names of the classes and packages and their version. The + numbers behind the versions are the pages, where the changes are + described. At the margins of these pages you will find corresponding version + marks.% +} +% \end{macrocode} +% \end{macro} +% +% +% \section{Jens-Uwe's Example Text} +% +% TODO: These should be merged with other example text. +% \begin{macro}{\XmpText} +% Example text command; the default definition (50) returns the whole text. +% \begin{macrocode} +\newcommand*{\XmpText}[1][50]{% + \ifnum #1<51 + This f\/ill text is currently seized by 130 million receptors + in your retina. + \ifnum #1>1 + Thereby the nerve cells are put in a state of stimulation, + which spreads + \ifnum #1>2 + into the rear part of your brain originating from + \ifnum #1>3 + the optic nerve. + From there the stimulation is transmitted in a split second + also in other parts of your cerebrum. + Your frontal lobe becomes stimulated. + Intention-impulses spread from there, which your + central nervous + \fi\fi\fi + \fi + \ifnum #1>49 + system transforms in actual deeds. + Head and eyes already react. + They follow the text, taking the informations present there + and transmit them via the optic nerve. + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\XmpTopText} +% \begin{macro}{\XmpBotText} +% These two commands are language-dependent, since in some languages +% additional commands may required. +% \begin{macrocode} +\newcommand*{\XmpTopText}{\XmpText[3]} +\newcommand*{\XmpBotText}{\XmpText[2]} +% \end{macrocode} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\XmpMarginTextA} +% \begin{macro}{\XmpMarginTextB} +% Margin notes. +% \begin{macrocode} +\newcommand*{\XmpMarginTextA}{Retina} +\newcommand*{\XmpMarginTextB}{} +% \end{macrocode} +% \end{macro} +% \end{macro} +% +% +% \section{Language Extensions} +% +% Some terms should be part of the captions of the language. +% \begin{macro}{\GuideLanguageExtensions} +% This macro has to be defined, because the class will add it to the language +% at |\begin{document}| and it will also call it. +% \begin{macrocode} +\newcommand*{\GuideLanguageExtensions}{% +% \end{macrocode} +% \begin{macro}{\pageautorefname} +% The term »page« that will be put before the reference of a page set by +% |\autopageref|. +% \begin{macrocode} + \def\pageautorefname{page}% +% \end{macrocode} +% \end{macro} +% \begin{macro}{\subsectionautorefname} +% \begin{macro}{\subsubsectionautorefname} +% \begin{macro}{\paragraphautorefname} +% \begin{macro}{\subparagraphautorefname} +% I'll call them all »section«. +% \begin{macrocode} + \def\figureautorefname{figure}% + \def\tableautorefname{table}% + \def\appendixautorefname{appendix}% + \let\subsectionautorefname=\sectionautorefname + \let\subsubsectionautorefname=\sectionautorefname + \let\paragraphautorefname=\sectionrefname + \let\subparagraphautorefname=\sectionrefname +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \begin{macro}{\changelogname} +% The name of the change log index. +% \begin{macrocode} + \def\changelogname{Change Log} +% \end{macrocode} +% \end{macro} +% \begin{macrocode} +} +% \end{macrocode} +% \end{macro} +% +% +% \section{Hyphenation} +% +% This is not realy a good place to put them~-- but better late than never: +% \begin{macrocode} +\hyphenation{% +} +% \end{macrocode} +% +% +% +\endinput +%%% Local Variables: +%%% mode: doctex +%%% TeX-master: "guide" +%%% End: |