summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/ifxetex/ifxetex.tex
blob: 5b0905f52c76e6070fe548e44d8010516364f6aa (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
\RequirePackage{filecontents}
\begin{filecontents*}{README.txt}
------------------------
THE IFXETEX PACKAGE v0.4

This very simple package, for both Plain TeX and LaTeX, 
defines the \ifxetex boolean for testing whether XeTeX 
is being used for typesetting.

Also provides the \RequireXeTeX command which throws
an error if XeTeX is not the engine in use.

To extract the package from the source file "ifxetex.tex", 
execute `latex ifxetex.ins`. Executing `xelatex ifxetex.tex`
compiles the documentation and generates this README.

-------------------
Will Robertson
Copyright 2006-2008
\end{filecontents*}
%%%%%%%%%1%%%%%%%%%2%%%%%%%%%3%%%%%%%%%4%%%%%%%%%5

\begin{filecontents}{ifxetex.sty}
% \iffalse
% Copyright 2006-2008 by Will Robertson <wspr81@gmail.com>
% 
% Distributable under the LaTeX Project Public License,
% version 1.3c or higher (your choice). The latest version of
% this license is at: http://www.latex-project.org/lppl.txt
%
% This work is "maintained" (as per LPPL maintenance status) 
% by Will Robertson.
% \fi

% Ensure loading a single time only
\csname ifxetexloaded\endcsname
\let\ifxetexloaded\endinput

% Declare ourselves to \LaTeX
\expandafter\ifx\csname ProvidesPackage\endcsname\relax\else
  \ProvidesPackage{ifxetex}
    [2008/09/18 v0.4 Provides ifxetex conditional]
\fi

% Create, if necessary, the \cmd\ifxetex\ conditional
\expandafter\ifx\csname ifxetex\endcsname\relax
  \newif\ifxetex
\fi

% Set \cmd\ifxetex\ accordingly
\expandafter\ifx\csname XeTeXrevision\endcsname\relax
  \xetexfalse
\else
  \xetextrue
\fi

% For \XeTeX-exclusive packages
\def\RequireXeTeX{%
  \ifxetex\else
    \begingroup
      \errorcontextlines=-1\relax
      \newlinechar=10\relax
      \errmessage{^^J
      ********************************************^^J
      * XeTeX is required to compile this document.^^J
      * Sorry!^^J
      ********************************************}%
    \endgroup
  \fi}
\end{filecontents}
%%%%%%%%%1%%%%%%%%%2%%%%%%%%%3%%%%%%%%%4%%%%%%%%%5



% Conditionally compile the documentation & generate the .ins file:
\providecommand\asyfigCompile{Y}
\makeatletter
\if\asyfigCompile N
  \expandafter\@@end
\fi




\begin{filecontents*}{ifxetex.ins}
%&latex
\def\asyfigCompile{N}
\input ifxetex.tex
\csname@@end\endcsname
\end{filecontents*}




\makeatletter
\documentclass{article}

\usepackage[it,medium]{titlesec}

\usepackage{bigfoot,ifthen,xcolor}
\usepackage[colorlinks,linktocpage]{hyperref}

\usepackage{gmdoc}
\usepackage{gmverb}
\dekclubs
\stanzaskip=\bigskipamount 
\CodeSpacesGrey

\usepackage{tocloft,varwidth}
\setcounter{tocdepth}{1}
\def\tocwidthA{0.45}
\def\tocwidthB{0.45}
\def\cftpartfont{\scshape}
\def\cftsecfont{\small}
\cftbeforesecskip=0pt
\def\cftpartleader{}
\def\cftpartafterpnum{\cftparfillskip}
\def\cftsecleader{}
\def\cftsecafterpnum{\cftparfillskip}

\let\pkg\textsf
\def\pkgopt#1{\texttt{[#1]}}

\def\PDF{\textsc{pdf}}
\def\PS{\textsc{ps}}
\def\DVI{\textsc{dvi}}
\def\EPS{\textsc{eps}}

\usepackage{amsmath,listings}
\lstset{basicstyle=\ttfamily,columns=fullflexible}

\usepackage{array,xltxtra}
\setmainfont{Georgia}
\setsansfont[Scale=MatchLowercase]{Helvetica}
\setmonofont[Scale=MatchLowercase]{Monaco}
\frenchspacing

\GetFileInfo{ifxetex.sty}
\begin{document}

\title{The \pkg{ifxetex} package}
\author{%
  \normalsize Will Robertson\footnote{\texttt{wspr81@gmail.com}}}
\date{\fileversion\qquad\filedate}

\maketitle

\section{User documentation}

This package provides a way to check if a document is being processed with \XeTeX. It may be loaded with

\bigskip
\begin{tabular}{l@{\quad}l}
{|\usepackage{ifxetex}|} & for \LaTeX, or \\ 
{|\input ifxetex.sty|} & for Plain \TeX.
\end{tabular}
\bigskip

\noindent
This defines the conditional \cmd\ifxetex\ that is used in the standard way:

\bigskip
|\ifxetex|\par
\hspace{2em}\meta{material for \XeTeX}\par
|\else|\par
\hspace{2em}\meta{material not for \XeTeX}\par
|\fi|
\bigskip

\noindent 
Users of \LaTeX's \pkg{ifthen} package can also use it as |\boolean{xetex}|:

\bigskip
|\ifthenelse{ \boolean{xetex} }{|\texttt{\char`\%}\par
\hspace{2em}\meta{material for \XeTeX}\par
|}{|\texttt{\char`\%}\par
\hspace{2em}\meta{material not for \XeTeX}\par
|}|
\bigskip

\noindent
Finally, the |\RequireXeTeX| command tests for \XeTeX\ use and
throws an error if a different engine is being used. This is used
for packages like \pkg{fontspec} that take advantage of \XeTeX's new
features and cannot be used otherwise.


\clearpage
\parindent=0pt
\section{Implementation}
\DocInput{ifxetex.sty}


\end{document}