summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/mltex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-01-09 00:49:07 +0000
committerKarl Berry <karl@freefriends.org>2006-01-09 00:49:07 +0000
commit007f67a693e4d031fd3d792df8e4d5f43e2cb2e7 (patch)
tree90d17e00e572ecb1e24764b6f29c80e098b08d29 /Master/texmf-dist/doc/latex/mltex
parent950209b26f70aa87ed07c54f82a95b6f03b7c3a0 (diff)
doc/latex
git-svn-id: svn://tug.org/texlive/trunk@84 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/mltex')
-rw-r--r--Master/texmf-dist/doc/latex/mltex/README81
-rw-r--r--Master/texmf-dist/doc/latex/mltex/mltex.txt87
-rw-r--r--Master/texmf-dist/doc/latex/mltex/testmlft.tex134
-rw-r--r--Master/texmf-dist/doc/latex/mltex/testmlsw.tex105
4 files changed, 407 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/mltex/README b/Master/texmf-dist/doc/latex/mltex/README
new file mode 100644
index 00000000000..80e5b5b9ed4
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/mltex/README
@@ -0,0 +1,81 @@
+------------ README - MLTeX support files for LaTeX ------------
+
+This directory contains the following files to be used with
+MLTeX v2.2 and LaTeX2e:
+
+ - README This file you are currently reading
+ - mltex.txt ``How to use MLTeX with LaTeX'', the end-user
+ documentation---please read it!
+ - mltex.sty This LaTeX package is the simplest way how to enable
+ the MLTeX extensions within LaTeX; it automatically
+ loads all needed files and contains all necessary
+ declarations.
+
+ - lo1enc.def Font encoding definition for the new LaTeX font
+ encoding ``LO1'' aka ``mLtex's Ot1''.
+ - mlltxchg.def This file contains all LaTeX NFSS kernel macro
+ redefinitions.
+
+ - testmlft.tex
+ testmlsw.tex Two LaTeX documents to test MLTeX, the MLTeX package
+ and definition files.
+
+
+The package ``mltex'' can be also used with standard TeX, in which
+case the result should be the same as without this package. To make
+full use of all the capabilities of this package, you have to use an
+MLTeX extended TeX (which can not be called ``TeX'' anymore).
+
+
+Installation:
+-------------
+
+Put the files
+
+ mltex.sty
+ lo1enc.def
+ mlltxchg.def
+
+in a place where TeX will look for macros files.
+
+If you TeX system uses the TeX Directory Structure (TDS) standard you
+have to create a new directory
+
+ texmf/tex/latex/mltex/
+
+and move the three files into this directory. After you have done it,
+don't forget to update the file lookup cache files on some TeX
+systems!
+
+
+Error Reports:
+--------------
+
+Error Reports in case of UNCHANGED versions to
+
+ Bernd Raichle
+ Stettener Str. 73
+ 73732 Esslingen
+ Federal Republic of Germany
+ Email: raichle@Informatik.Uni-Stuttgart.DE
+
+Please apply the test file ``mltextst.tex'' to your MLTeX binary to
+make sure that your are using the newest version of MLTeX. If you are
+using an old version, update to the newest version before reporting an
+error.
+
+Include a _short_ TeX input file and the output of the log file in
+your error report. Add a note about your environment: TeX version,
+implementation, operating system.
+
+
+
+MLTeX is copyright (C) 1990-1992 by Michael J. Ferguson;
+MLTeX Version 2.2 is copyright (C) 1995-1998 by B. Raichle;
+all rights are reserved.
+
+--- Copyright (C) 1996-1998 Bernd Raichle. All rights reserved ---
+This file can be redistributed and/or modified under the terms
+of the LaTeX Project Public License Distributed from CTAN
+archives in directory macros/latex/base/lppl.txt; either
+version 1 of the License, or any later version.
diff --git a/Master/texmf-dist/doc/latex/mltex/mltex.txt b/Master/texmf-dist/doc/latex/mltex/mltex.txt
new file mode 100644
index 00000000000..8b629aeb2a0
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/mltex/mltex.txt
@@ -0,0 +1,87 @@
+ How to use MLTeX with LaTeX
+
+ Bernd Raichle
+
+ 17 November 1998
+
+
+This document contains instructions on how to use MLTeX's \charsubdef
+extension with LaTeX. Before reading this file, you should read
+`install.txt', which will explain how the LaTeX installation works.
+
+This file describes:
+
+ * How to create the LaTeX format with MLTeX.
+
+ * How to use MLTeX with LaTeX.
+
+
+
+CREATING THE LaTeX FORMAT
+=========================
+
+To create the LaTeX format, you should follow the standard LaTeX
+installation guide.
+
+ - Do NOT include any MLTeX specific file into your LaTeX format!
+
+ - Do NOT use the obsolete files `compatible.tex', `extdef.tex',
+ `masthyph.tex', or any other file from the old MLTeX distribution!
+
+ - Depending on your TeX implementation there is either a special
+ version of the `initex' program provided which is called `mlinitex',
+ `initex -mltex', or `tex -ini -mltex'.
+ Use this program resp. command line options when creating the LaTeX
+ format.
+
+As a result your LaTeX format file `latex.fmt' should not contain any
+MLTeX specific definitions or declarations.
+
+
+
+USING THE MLTeX EXTENSION
+=========================
+
+To enable the MLTeX extension, you simply use the standard LaTeX
+package `fontenc' with the MLTeX font encoding LO1 instead of OT1,
+e.g. replace
+
+ \usepackage[T1,OT1]{fontenc}
+
+by
+
+ \usepackage[T1,LO1]{fontenc}
+
+which will choose LO1 as the default font encoding. If you want to
+choose another default font encoding, you can switch to LO1 by
+
+ \fontencoding{LO1}\selectfont
+
+within your document. Nonetheless you have to declare the new font
+encoding `LO1' by loading it using the package `fontenc'.
+
+For LaTeX's font encoding OT1 the associated MLTeX font encoding is
+provided with a basic set of fd files. This font encoding is called
+LO1 (for M_L_TeX's _O_T1) and is a superset of OT1.
+
+
+Another simpler way to use this MLTeX extended font encoding is
+provided by the package `mltex'. By including
+
+ \usepackage{mltex}
+
+in the document preamble all references to OT1 will get replaced by
+LO1. If you don't want to hide OT1 totally, you can select LO1 as
+usual default font encoding by using the package option `switchonly',
+e.g. by including
+
+ \usepackage[switchonly]{mltex}
+
+in the document preamble.
+
+
+--- Copyright (C) 1996-1998 Bernd Raichle. All rights reserved ---
+This file can be redistributed and/or modified under the terms
+of the LaTeX Project Public License Distributed from CTAN
+archives in directory macros/latex/base/lppl.txt; either
+version 1 of the License, or any later version.
diff --git a/Master/texmf-dist/doc/latex/mltex/testmlft.tex b/Master/texmf-dist/doc/latex/mltex/testmlft.tex
new file mode 100644
index 00000000000..878a9420d22
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/mltex/testmlft.tex
@@ -0,0 +1,134 @@
+%%
+%% This is file `testmlsw.tex'.
+%% Copyright (C) 1996-1998 Bernd Raichle; all rights reserved.
+%%
+%% See copyright statement in file `lo1enc.def'.
+%%
+%%
+%% - Checks hyphenation w.r.t font encoding alias.
+%% - Checks \DeclareTextComposite declarations.
+%% - Can and should be used with a standard TeX or MLTeX!
+%%
+%% CHANGES:
+%% 1998/11/17 0.9a
+%% First released version.
+%% 1999/03/09 0.9b
+%% Added lines with composite and special glyphs because
+%% I have missed a definition in `lo1enc.def' making the
+%% accent macros \d and \b fail for LO1.
+%%
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesFile{testmlft.tex}%
+ [1999/03/09 v0.9b Test file for MLTeX LaTeX support (br)]
+\documentclass{minimal}
+\nofiles
+\newcommand{\type}[1]{\typeout{^^J#1}#1}
+
+%% For non-MLTeX and/or TeX versions < 3.0
+%% define dummys for \charsubdefmax and \errorcontextlines,
+%% these registers are not changed within this test file.
+\ifx\charsubdefmax\undefined \chardef\charsubdefmax=0 \fi
+\ifx\errorcontextlines\undefined \else \errorcontextlines=2\fi
+
+\typeout{^^J=== charsubdefmax before: \number\charsubdefmax.^^J}
+\usepackage[switchonly]{mltex}
+\typeout{^^J=== charsubdefmax after: \number\charsubdefmax.^^J}
+
+\usepackage[latin1]{inputenc}
+
+\begin{document}
+
+\type{=== Current encoding is
+ \csname cf@encoding\endcsname\space
+ (\csname f@encoding\endcsname).}
+
+
+--- Simple Tests ---
+
+\type{=== Test using LO1 font encoding, accent macros, Latin-1 chars:}
+t\"ater \'el\`eve élève
+\showhyphens{\"ubertragen \'el\`eve élève}
+
+
+\expandafter\ifx\csname l@german\endcsname\relax \else
+{\language=\csname l@german\endcsname
+
+\type{=== Test using LO1 font encoding, german hyphenation patterns:}
+t\"ater \'el\`eve
+\showhyphens{\"ubertragen \'el\`eve}
+}
+\fi
+
+
+\expandafter\ifx\csname l@german\endcsname\relax \else
+{\language=\csname l@french\endcsname
+
+\type{=== Test using LO1 font encoding, french hyphenation patterns:}
+t\"ater \'el\`eve
+\showhyphens{\"ubertragen \'el\`eve}
+\showhyphens{abondamment abstinence anh\'eler d\'el\'egu\'e}
+
+\fontencoding{OT1}\selectfont
+\renewcommand{\encodingdefault}{OT1}%% for \showhyphens!
+\type{=== Test using OT1 font encoding, french hyphenation patterns:}
+t\"ater \'el\`eve d\'el\'egu\'e
+\showhyphens{\"ubertragen \'el\`eve}
+\showhyphens{abondamment abstinence anh\'eler d\'el\'egu\'e}
+}
+\fi
+
+
+\def\test{%
+
+\`A \'A \^A \~A \"A \u{A} \r{A}
+\`a \'a \^a \~a \"a \u{a} \r{a}
+
+\c{C} \'C \v{C} \c{c} \'c \v{c}
+\v{D}
+\u{G} \u{g}
+
+\`E \'E \^E \~E \"E \v{E}
+\`e \'e \^e \~e \"e \v{e}
+
+\`I \'I \^I \~I \"I \.I
+\`i \'i \^i \~i \"i \.i
+\`{\i} \'{\i} \^{\i} \~{\i} \"{\i} \.{\i}
+
+\~N \'N \v{N} \~n \'n \v{n}
+
+\`O \'O \^O \~O \"O \H{O}
+\`o \'o \^o \~o \"o \H{o}
+
+\'R \v{R} \'r \v{r}
+
+\'S \v{S} \c{S} \'s \v{s} \c{s}
+
+\v{T} \c{T} \c{t}
+
+\`U \'U \^U \~U \"U \H{U} \r{U}
+\`u \'u \^u \~u \"u \H{u} \r{u}
+
+\'Y \'y
+
+\'Z \v{Z} \.Z \'z \v{z} \.z
+
+composite glyphs:
+\"b \"B \'b \'B \.b \.B \=b \=B \^b \^B \`b \`B
+\~b \~B \H{b} \H{B} \u{b} \u{B} \v{b} \v{B} \r{b} \r{B}
+\b{b} \b{B} \c{b} \c{B} \d{b} \d{B}
+
+special glyphs: \AE \OE \O \ae \i \j \oe \o \ss
+\textemdash \textendash \textexclamdown \textquestiondown
+\textquotedblleft \textquotedblright
+\textquoteleft \textquoteright
+\L \l \textdollar \textsterling
+}
+
+--- Major Tests ---
+
+{\fontencoding{T1}\selectfont --- T1:\par \test\par}
+{\fontencoding{OT1}\selectfont --- OT1:\par \test\par}
+{\fontencoding{LO1}\selectfont --- LO1:\par \test\par}
+
+--- End of Tests ---
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/mltex/testmlsw.tex b/Master/texmf-dist/doc/latex/mltex/testmlsw.tex
new file mode 100644
index 00000000000..dac77de892a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/mltex/testmlsw.tex
@@ -0,0 +1,105 @@
+%%
+%% This is file `testmlsw.tex'.
+%% Copyright (C) 1996-1998 Bernd Raichle; all rights reserved.
+%%
+%% See copyright statement in file `lo1enc.def'.
+%%
+%%
+%% - Checks the font encoding switching/alias mechanism.
+%% - Can and should be used with a standard TeX or MLTeX!
+%%
+%% CHANGES:
+%% 1998/11/17 0.9a
+%% First released version.
+%% 1999/03/09 0.9b
+%% Added some comments in the output about the shown effects.
+%% Added \hfuzz=30pt to suppress overfull \hbox warnings.
+%%
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesFile{testmlsw.tex}%
+ [1999/03/09 v0.9b Test file for MLTeX LaTeX support (br)]
+\documentclass[a4paper]{article}
+\listfiles
+
+%%% Make MLTeX's OT1 called "LO1" the default encoding:
+\usepackage[LO1]{fontenc}
+
+%%% Make "OT1" (resp. "LO1") default encoding, load "LO1":
+%\usepackage[T1,LO1]{fontenc}
+
+%%% Make "T1" default encoding, load "LO1":
+%\usepackage[LO1,T1]{fontenc}
+
+%%% Make "T1" default encoding, do not load "LO1":
+%%% (this won't work, because the new font encoding "LO1" must
+%%% be declared before its first use, similar to "TS1").
+%\usepackage[T1]{fontenc}
+
+%% Make "LO1" default encoding, map all accesses
+%% of "OT1" to "LO1":
+%\usepackage{mltex}
+
+\usepackage[german]{babel}
+
+% Test for "Package Warning":
+\expandafter\ifx\csname charsubdef\endcsname\relax \else
+ \typeout{}\typeout{===== The following warning is ok:}
+ \charsubdef 228=\ifnum`\"=`\"24 \else 256\fi \ifx a\i16\else `Y\fi\relax
+\fi
+
+\typeout{}\typeout{===== OK, the NFSS system should be set up properly.}
+\begin{document}
+
+\typeout{======= \protect\encodingdefault=\encodingdefault\space =====}
+\setlength{\columnsep}{2pc}
+\twocolumn
+
+\newcommand{\testtext}{%
+ {\selectlanguage{german}%
+ Beim Treffen in M\"unster im M\"arz 1999 w\"urden \"au\ss erst
+ unerh\"orte \"Au\ss erungen \"uber verf\"ugbare \"Ubertragungen
+ st\"orender Einfl\"usse eingeschr\"ankter \"Offnungss\"atze
+ gew\"ohnlicher bl\"odsinniger G\"ansef\"u\ss chen \"uber
+ gebr\"auchliche Anf\"uhrungszeichen \"offentlich \"uberm\"a\ss ig
+ vorgef\"uhrt.
+ \par}%
+ %
+ Cette notice d\'ecrit comment utiliser l'option de style
+ ``french'' avec \TeX{} ou \LaTeX{} (appel\'ee \emph{extension}
+ dans ce dernier cas). Cette option a \'et\'e cr\'e\'ee pour
+ imprimer des documents typographiquement plus conformes \`a l'usage
+ fran\c{c}ais que ce que produisent \TeX{} et \LaTeX{} par d\'efaut.
+ Un grand nombre de commandes peuvent \^etre utilis\'ees mais
+ l'emploi courant de cette option ne n\'ecessite \emph{a priori}
+ aucune connaissance particuli\`ere ni une utilisation forcen\'ee de
+ commandes sp\'ecifiques. \ldots{} Son installation s'accompagne
+ normalement d'une cr\'eation de \emph{format} pour l'introduction,
+ notamment, des fichiers de motifs de c\'esure fran\c{c}ais.
+ \par
+}
+
+\newcommand{\maketest}[1]{\begingroup \hfuzz=30pt
+ \typeout{========== Format Text using Encoding: #1 ==========}%
+ \leavevmode\llap{#1: }%
+ \fontencoding{#1}\selectfont \testtext \par
+ \endgroup}
+
+
+{\slshape In the following paragraphs you can see the following
+ results. OT1: no hyphenation of words with umlauts and/or accents.
+ T1: hyphenation of these words. LO1: hyphenation of these words if
+ ML\TeX{} is used, otherwise no hyphenation. Additionally there can
+ be differences in paragraph breaking between LO1 and~T1 because of a
+ different font metric between CM and EC fonts.}
+
+
+
+\maketest{OT1}
+\maketest{LO1}
+\maketest{T1}
+\newpage
+\maketest{OT1}
+\textsl{-- Test of default enc.: ``\encodingdefault'' --}\par
+\maketest{\encodingdefault}
+
+\end{document}