diff options
| author | Karl Berry <karl@freefriends.org> | 2009-10-09 22:55:11 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2009-10-09 22:55:11 +0000 |
| commit | 4be9896a3192173699de340a9f0475654efedb3a (patch) | |
| tree | da0e954012cd781f875c761c42f6a76e50e2f272 /Master | |
| parent | bd1227ad4919d2fbe17d63213bf48542f9c36f38 (diff) | |
faq 3.19a update (9oct09)
git-svn-id: svn://tug.org/texlive/trunk@15725 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
347 files changed, 27756 insertions, 27482 deletions
diff --git a/Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.19a b/Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.19a new file mode 100644 index 00000000000..a9d2e1b0a44 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.19a @@ -0,0 +1,44 @@ +Changes in version 3.19 + +This file lists changes since its most recent release (with version 3.18 +of the FAQ). + +New answers: +[none yet] + +Label grffilenames: "modern" file names in graphics + +Label keyval: using key-value input in macros and package + +Label linmacnames: why non-letters in macro names are a bad idea + +Label osf: using fonts with "old-style" numbers + +Label pdf-fig-chars: disappearing glyphs in pdfTeX figures (from Thanh) + +Label texorpdf: error "not allowed in PDFDocEncoded string" + +Label texthings: what all these <thing>TeX names are + +Label usesymb: using symbols + +Label whatmacros:brief outline of macros for "bits and pieces" section + +Label wideflt: centre a float wider than text area + +Relabelled answers: +[none yet] + +Label xfigetc: discusses xfig and asymptote (so far) (was label xfig) + +Revised answers: + +Label impgraph: changed the question title + +Label man-latex: mention Philip Hirschhorn's "getting up and running..." + +Label mathstext: correct discussion of \textrm in maths + +Deleted answers: +[none yet] + +Label outszwrng +(remember, as of the previous release, links to "old" labels remain +valid, pointing to an answer that is as near relevant as possible) + +Web interface: +[no changes yet] + The initial list of questions no longer gives a URL containing all + the answers -- Google was returning that for every match, which + didn't help! + All links to CTAN files, directory .zips and directories for + browsing are now http, and there's no longer any mention of .tar.gz + archives of CTAN directories (since they're no longer available) + +Robin Fairbairns +2009-06-16 diff --git a/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog b/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog index 3c437317f15..08c781e26bc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog +++ b/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog @@ -1,3 +1,342 @@ +2009-10-07 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * sanitize.pl: incorporate developments in -beta + + * texfaq2file: correct root addr (in reading archive.list) + +2009-10-06 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-how-do-i.tex (subsection{Document management}): add latex-make, + latex_maker and vpp discussion to q-make + + * dirctan.tex: add latex-make, latex_maker and vpp + +2009-10-04 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-docs.tex (section{Documentation and Help}): add texlive and + miktex maintainers to people it's not good to ask direct, in q-gethelp + +2009-09-11 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-biblio.tex (subsection{Creating bibliographies}): append further + stuff to the last sentence of q-capbibtex + +2009-08-31 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-wdidt.tex (subsection{Why shouldn't I?}): editorial in q-dolldoll + (subsection{Why shouldn't I?}): correct typo in q-2letterfontcmd + +2009-08-29 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-adj-types.tex (subsection{Document structure}): remove caveat + about front- and backmatter in q-secthead + + * faq-install.tex (section{Installing (La)TeX files}): another + editorial hack at q-instt1font + +2009-08-28 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-install.tex (section{Installing (La)TeX files}): minor editorial + in q-instt1font + +2009-08-26 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-install.tex (section{Installing (La)TeX files}): hack viciously + at q-inst1cm, move it to end of section + + * Makefile (clean): remove faqbody.tex too + (<web copying rules>): correct variable names, correct dependencies + +2009-08-25 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-install.tex (section{Installing (La)TeX files}): deal with + confusion at the start of q-instt1font (spotted by jos\'e carlos + santos, again...) + + * faq-bits+pieces.tex (section{Bits and pieces of (La)TeX}): tidy up + the shambles of q-ecfonts + +2009-08-25 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * dirctan.tex: correct three typos created while adding catalogue links + + * faq-mac-prog.tex (subsection{"Generic" macros and techniques}): in + q-patch, extend discussion of ted package, change patchcmd + accordingly, and do a few editorial diddles + +2009-08-23 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-fonts.tex (subsection{Macros for using fonts}): mention + font-change in q-fonts-pln + + * dirctan.tex: add font-change + +2009-08-02 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-intro.tex: add RIP note for Eitan Gurari ... much missed already + + * dirctan.tex: sort out a couple of catalogue links + + * check-ctan-lists: display missing cat entries + + * filectan.tex: add cat links + +2009-08-01 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * dirctan.tex: remove t1tidy,t1tools,t1utils,uktug,umddvi,umlaute, + ugaritic,umrand,unadobe,uncompressing,undump,unix,unpacked,untex,usl, + utthesis,va,vector,vector,vga2mf,vietnamese,vispeech,vm-cms,vplutils, + vrb,vslitex,vutex,w2latex,wasy2,webtoc,whatstex,williams,winw2ltx, + word2tex,word_tex,wsuipa,xetal,xypic -- cat links completed + +2009-07-31 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-docs.tex (section{Documentation and Help}): editorial in + q-maillists* + + * dirctan.tex: remove pstab, pxlgen, qfig, quicspool, ransom, + recycle, redit, reduce, relabel, review, rmit, rune, rweb, s2latex; + cat links to end r* + remove sanskrit,saiter,sbtex,schemetex,screenview,script,scripttex, + sisisi, slant,sml,softfonts,southarabian,spain,spelchek,spell, + spiderweb,srune,ssl,ssqqote,stmaryrd,subeqnarray,sueterlin,swebib, + swedish,sweet-tex,swiftex,syriac + cat links to end s* + remove tamil,tbe,tcd-manual,tde-macros,teencontrex,tek2eepic,telugu, + tengwar,tex--xet,tex-d-l,tex-implementors,tex-primer_vms-specific, + tex-surface,texcalc,texchord,texdraw,texed,texfilt,texgraph, + texi2roff,texix,texpert,texproc,text1,text2dvi,textool,textures, + textures_figs,texutils,texware,thai,tie,tiff,translit,tree,tsipa, + tspell,turing[+],turkish,twcal,tx1,typingtex + cat links to end t* + restore spiderweb,spain,swebib + + +2009-07-28 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * add-general.tex (subsection{Why does it do that?}): new q-emptynum + containing an offcut from q-nopageno + + * faq-adj-types.tex (subsection{Page layout}): further tidying of + q-nopageno, remove matter for q-emptynum + +2009-07-27 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-adj-types.tex (subsection{Page layout}): further tidying of + q-nopageno + +2009-07-21 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-adj-types.tex (subsection{Page layout}): amalgamate + q-nopageno and q-ps@empty (which talked about the same sorts of thing) + (subsection{Page layout}): change ref to \ps@empty in q-fancyhdr to + q-nopageno (not entirely reasonable just now, but we're getting there) + + * add-general.tex (subsection{Things have "gone away"}): new q-initex + +2009-07-20 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * sanitize-beta.pl (sanitize_line): \dots->… (not ellipsis!) + +2009-07-16 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * dirctan.tex: cat links to end p* + +2009-07-15 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * dirctan.tex: added lshort, more cat links (up to l* now) + + * filectan.tex: removed lshort (now in dirctan) + +2009-07-14 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-docs.tex (section{Documentation and Help}): add link to the + symbol classifier, in q-symbols + + * dirctan.tex: still more catalogue links + +2009-07-13 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * dirctan.tex: bunch of new catalogue links (no particular order) + + * texfaq2html-beta: deal with \CTANdirectory* and a cat link, and + \CTANfile ditto + + * sanitize-beta.pl (generate_CTAN_ref): generate refs for directories + +2009-07-12 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * dirctan.tex: catalogue links up to f* + +2009-07-10 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-support.tex (section{Support Packages for TeX}): add link to + cygwin installation advice in q-xfigetc + + * faq-projects.tex (section{Current TeX-related projects}): typo + spotted by fran\c{c}ois charette in q-biblatex, and further editorial + work starting from another of his observations + +2009-07-06 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-biblio.tex (section{References from articles}): add warning about + citeref's problems with cite.sty in q-backref + +2009-07-03 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * dirctan.tex: cat linkparallels up to cm-super + + * add-general.tex (subsection{Bits and pieces of (La)TeX}): new + q-howfonts + + * faq-mac-prog.tex (subsection{LaTeX macro programming}): correct one + instance of spelling of chngcntr in q-running-nos + +2009-07-02 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq.sty: get rid of optional args to \CTAN-(directory|file) + +2009-06-30 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * faq-fonts.tex (subsection{MF fonts}): bluesky fonts from amsfonts in + q-getbitmap + + * faq-install.tex (section{Installing (La)TeX files}): remove "bluesky" + from name of q-inst1cm + + * dirctan.tex: remove bluesky stuff + +2009-06-30 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * dirctan.tex: alpha now back to main tree + + * faq-t-g-wr.tex (subsection{Things have "gone away"}): use amsfonts + + * faq-install.tex (section{Installing (La)TeX files}): ams and cm fonts + type 1 links both go to amsfonts now + + * dirctan.tex: add amsfonts-only link + + * faq-fonts.tex (subsection{Adobe PS fonts}): replace refs to + ams-amstype1 + + * faq-symbols.tex (section{Symbols, etc.}): all ams things are in + amsfonts now + + * dirctan.tex: added catalogue links up to babel + +2009-06-29 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * texfaq2html-beta: revert to oldstyle css, having experienced a + stronger yuck reaction to hufthammer's other suggestions + + * dirctan.tex: add cat link for footmisc + + * texfaq2html-beta: decode catalogue entry name (trailing [foo]) after + \CTANdirectory, non-starred versions only pro tem + + * sanitize-beta.pl (generate_CTAN_ref): add catalogue link if available + +2009-06-24 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * add-general.tex (subsection{"Generic" macros and techniques}): a bit + of work on q-bgroup + +2009-06-23 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * texfaq2html-beta: try Steely style sheet for today... + + * faq-docs.tex (section{Documentation and Help}): add reference to a + "full" tug india latex guide on sarovar + +2009-06-22 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * texfaq2html-beta: add css link to header of docs (Oldstyle) + + * faq-docs.tex (section{Documentation and Help}): mention hisrchhorn's + amslatex-primer in q-man-latex + (section{Documentation and Help}): comment about difficulty of reading + in q-ref-doc + +2009-06-18 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-graphics.tex (section{Graphics}): change title of q-impgraph + + * patchdates.tex: update patch version and date (was 2007...) + + * add-general.tex (subsection{"Generic" macros and techniques}): new + answer q-bgroup + + * sanitize-beta.pl (sanitize_line): make \dots{} produce &ellipsis; + +2009-06-16 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * faq-how-do-i.tex (subsection{Mathematics}): correct statements about + \textrm in q-mathstext (after enlightenment from Philipp Stephani...) + +2009-06-15 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * letterfaq.tex,newfaq-patch.tex,newfaq.tex: use gather-faqbody in jf's + lovely \afterassignment\endinput\input line... + + * Makefile: include subdocuments.mk, add $(SUBDOCS) to BODY + + * subdocuments.mk: list of things gathered by gather-faqbody + +2009-06-13 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * newfaq.tex,newfaq-patch.tex,letterfaq.tex: use gather-faqbody + + * gather-faqbody.tex: new name for faqbody, as gutted (see below) + + * faq-intro.tex,faq-backgrnd.tex,faq-docs.tex,faq-bits+pieces.tex, + faq-getit.tex,faq-texsys.tex,faq-dvi.tex,faq-support.tex, + faq-litprog.tex,fmt-conv.tex,faq-install.tex,faq-fonts.tex, + faq-hyp+pdf.tex,faq-graphics.tex,faq-biblio.tex,faq-adj-types.tex, + faq-lab-ref.tex,faq-how-do-i.tex,faq-symbols.tex,faq-mac-prog.tex, + faq-t-g-wr.tex,faq-wdidt.tex,faq-jot-err.tex,faq-projects.tex, + faq-the-end.tex: split out sections of faqbody.tex + + * faqbody.tex: split sections out into their own faq-*.tex, make + this predominantly a set of \faqinput commands + + * faq.sty: deal with LastEdit* + + * sanitize-beta.pl (sanitize_line): process \LastEdit* + + * faqbody.tex: adding \LastEdit to q-texorpdf,q-recovertex, + q-linmacnames,q-latexpronounce,q-logos,q-mcite,q-texthings + +2009-06-11 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> + + * Makefile (newfaq.aux): move label to linf of its own + + * Makefile.CTAN (CHANGES): do this properly (may need -new rather than + -replace) + + * dirctan.tex: add figflow + + * faqbody.tex (subsection{Tables, figures and diagrams}): add figflow + to q-textflow (at bnb's suggestion), and remove "in latex" qualifier + in question title + + * faq.sty: add \LastEdit (to gobble, pro tem at least) + + * sanitize-beta.pl (sanitize_line): add \LastEdit + + * faqbody.tex: v3.19a, today + (paragraph{Modified tex executables}): a couple of typos spotted by + scott pakin in q-texthings, add experimental \LastEdit + + * sanitize-beta.pl (sanitize_line): move \ISBN .. \Newsgroup above + \section, etc., so that those things can be in section arguments + +2009-06-11 Robin Fairbairns <rf10@beret.cl.cam.ac.uk> + + * sanitize.pl (generate_CTAN_ref): change worked for -beta, so here too + + * sanitize-beta.pl (generate_CTAN_ref): missing "/" found by bnb + 2009-06-10 Robin Fairbairns <rf10@hehe.cl.cam.ac.uk> * CHANGES-3.19: final released version diff --git a/Master/texmf-dist/doc/generic/FAQ-en/Makefile b/Master/texmf-dist/doc/generic/FAQ-en/Makefile index 981a8bbcaa3..c261a5f276a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/Makefile +++ b/Master/texmf-dist/doc/generic/FAQ-en/Makefile @@ -1,23 +1,27 @@ -BODY = faqbody.tex filectan.tex dirctan.tex +# define variables WEB, WEB_BETA, CGI_BIN, HOME_DIR, CTAN_HOME, CTAN_ROOT +include locations.mk + +# list of subdocuments of gather-faqbody +include subdocuments.mk + +BODY = gather-faqbody.tex filectan.tex dirctan.tex $(SUBDOCS) MACROS = faq.cls faq.sty CONFIGS = archive.cfg CMFONTS = cmz -PATCH = newfaq-patch.tex additions.tex add-errors.tex add-biblio.tex \ - add-general.tex +PATCH = newfaq-patch.tex add-general.tex add-hammond.tex MAKEF = Makefile +HTML_TAR = FAQ-html.tar.gz + LATEX = latex PDFLATEX = pdflatex -DVIPS = dvips - -# define variables WEB, WEB_BETA, CGI_BIN, HOME_DIR, CTAN_HOME, CTAN_ROOT -include locations.mk CTAN_HOME = help/uk-tex-faq #h #hThe main targets of this Makefile are -#h all build a distribution +#h release build a distribution +#h #h patch build latest patched version #h #h ctan install distribution on CTAN @@ -27,18 +31,18 @@ CTAN_HOME = help/uk-tex-faq #h the CGI script) #h web-beta ditto, except beta distribution #h -#h inst-perl install texfaq2html in the cgi-bin directory -#h (to be run on the CTAN machine) -#h inst-perl-beta ditto, for texfaq2html-beta +#h inst-perl install texfaq2html and sanitize.pl +#h in the cgi-bin directory +#h inst-perl-beta ditto, for texfaq2html-beta, sanitize-beta +#h inst-perl-gamma ditto, for texfaq2html-gamma #h #h html make html files in html/ -#h inst-html export html/ files via ftp.cl.cam.ac.uk +#h html-gamma make html files in html, copy for -gamma tests help:; @sed -n 's/^#h//p' < $(MAKEF) -all: newfaq.pdf letterfaq.pdf \ - newfaq.ps letterfaq.ps \ - newfaq-cm.dvi letterfaq-cm.dvi +release: all html-tar +all: newfaq.pdf letterfaq.pdf # did have faqfont.cfg in here, but that caused problems, since it # typically doesn't exist... @@ -52,6 +56,8 @@ newfaq.pdf: newfaq.tex $(BODY) $(MACROS) $(CONFIGS) $(PDFLATEX) \\def\\Status{1} \\input pdf-newfaq ; \ grep "Rerun to get cross" pdf-newfaq.log > /dev/null ) do true ; \ done + thumbpdf pdf-newfaq + $(PDFLATEX) \\def\\Status{1} \\input pdf-newfaq mv pdf-newfaq.pdf newfaq.pdf rm pdf-newfaq.tex @@ -62,6 +68,8 @@ letterfaq.pdf: letterfaq.tex $(BODY) $(MACROS) $(CONFIGS) $(PDFLATEX) \\def\\Status{1} \\input pdf-letterfaq ; \ grep "Rerun to get cross" pdf-letterfaq.log > /dev/null ) do true ; \ done + thumbpdf pdf-letterfaq + $(PDFLATEX) \\def\\Status{1} \\input pdf-letterfaq mv pdf-letterfaq.pdf letterfaq.pdf rm pdf-letterfaq.tex @@ -72,36 +80,33 @@ newfaq-patch: newfaq-patch.pdf newfaq-patch.ps patch.pdf: newfaq-patch.pdf newfaq-patch.pdf: $(PATCH) $(BODY) $(MACROS) $(CONFIGS) + ./find-add-files ln -sf newfaq-patch.tex ./pdf-newfaq-patch.tex rm -f faqfont.cfg while ( \ $(PDFLATEX) \\def\\Status{1} \\input pdf-newfaq-patch ; \ grep "Rerun to get cross" pdf-newfaq-patch.log > /dev/null ) do true ; \ done + thumbpdf pdf-newfaq-patch + $(PDFLATEX) \\def\\Status{1} \\input pdf-newfaq-patch mv pdf-newfaq-patch.pdf newfaq-patch.pdf + ln -sf newfaq-patch.pdf patch.pdf rm pdf-newfaq-patch.tex -patch.ps: newfaq-patch.ps - -newfaq-patch.ps: newfaq-patch.dvi - $(DVIPS) -P$(CMFONTS) -j1 newfaq-patch - patch.dvi: newfaq-patch.dvi newfaq-patch.dvi: $(PATCH) $(BODY) $(MACROS) $(CONFIGS) - rm -f faqfont.cfg + ./find-add-files while ( \ $(LATEX) newfaq-patch ; \ grep "Rerun to get cross" newfaq-patch.log > /dev/null ) do true ; \ done + ln -sf newfaq-patch.dvi patch.dvi -newfaq.ps: newfaq.dvi - $(DVIPS) -P$(CMFONTS) -j1 newfaq +newfaq.aux: newfaq.dvi -letterfaq.ps: letterfaq.dvi - $(DVIPS) -t letter -P$(CMFONTS) -j1 letterfaq - -newfaq.dvi newfaq.aux: newfaq.tex $(BODY) $(MACROS) $(CONFIGS) +newfaq.dvi: newfaq.tex $(BODY) $(MACROS) $(CONFIGS) + echo $(LATEX) while ( \ $(LATEX) newfaq ; \ grep "Rerun to get cross" newfaq.log > /dev/null ) do true ; \ @@ -131,61 +136,88 @@ letterfaq-cm.dvi: letterfaq.tex $(BODY) $(MACROS) $(CONFIGS) done rm faqfont.cfg letterfaq-cm.tex -#install: -# (cd /homes/rf/FTP/faq; \ -# make -f /homes/rf/tex/faq/Makefile.FTP) +$(HTML_TAR): + tar czvf $(HTML_TAR) html/* -ctan: +ctan: $(HTML_TAR) (cd $(CTAN_ROOT)/$(CTAN_HOME); \ - really -u ctan make -f /homes/rf/tex/faq/Makefile.CTAN) + really -u ctan make -f /home/rf/tex/faq/Makefile.CTAN) -web: $(WEB)/dirctan.tex $(WEB)/filectan.tex $(WEB)/faqbody.tex $(WEB)/newfaq.aux $(WEB)/archive.list +# faqbody for all the webbery stuff +faqbody.tex: $(SUBDOCS) gather-faqbody.tex + ./build-faqbody -$(WEB)/dirctan.tex: $(HOME_DIR)/dirctan.tex -$(WEB)/filectan.tex: $(HOME_DIR)/filectan.tex -$(WEB)/faqbody.tex: $(HOME_DIR)/faqbody.tex -$(WEB)/newfaq.aux: $(HOME_DIR)/newfaq.aux -$(WEB)/archive.list: $(HOME_DIR)/archive.list +web: $(WEB)/dirctan.tex $(WEB)/filectan.tex $(WEB)/faqbody.tex $(WEB)/newfaq.aux $(WEB)/archive.list -$(WEB)/dirctan.tex $(WEB)/filectan.tex $(WEB)/faqbody.tex $(WEB)/newfaq.aux $(WEB)/archive.list: - rm -f $@ - copy -t $? $@ +$(WEB)/dirctan.tex: dirctan.tex +$(WEB)/filectan.tex: filectan.tex +$(WEB)/faqbody.tex: faqbody.tex +$(WEB)/newfaq.aux: newfaq.aux +$(WEB)/archive.list: archive.list +$(WEB)/aliasquestion.list: aliasquestion.list +$(WEB)/label-to-file.pl: label-to-file.pl + +$(WEB)/dirctan.tex $(WEB)/filectan.tex $(WEB)/faqbody.tex $(WEB)/newfaq.aux $(WEB)/archive.list $(WEB)/aliasquestion.list $(WEB)/label-to-file.pl: + if [ -f $@ ]; then \ + chmod 644 $@; \ + cp -p $< $@-t; \ + mv $@-t $@; \ + else \ + cp -p $< $@; \ + fi chmod 444 $@ -web-beta: $(WEB_BETA)/dirctan.tex $(WEB_BETA)/filectan.tex $(WEB_BETA)/faqbody.tex $(WEB_BETA)/newfaq.aux $(WEB_BETA)/archive.list - -$(WEB_BETA)/dirctan.tex: $(HOME_DIR)/dirctan.tex -$(WEB_BETA)/filectan.tex: $(HOME_DIR)/filectan.tex -$(WEB_BETA)/faqbody.tex: $(HOME_DIR)/faqbody.tex -$(WEB_BETA)/newfaq.aux: $(HOME_DIR)/newfaq.aux -$(WEB_BETA)/archive.list: $(HOME_DIR)/archive.list - -$(WEB_BETA)/dirctan.tex $(WEB_BETA)/filectan.tex $(WEB_BETA)/faqbody.tex $(WEB_BETA)/newfaq.aux $(WEB_BETA)/archive.list: - rm -f $@ - copy -t $? $@ +web-beta: $(WEB_BETA)/dirctan.tex $(WEB_BETA)/filectan.tex $(WEB_BETA)/faqbody.tex $(WEB_BETA)/newfaq.aux $(WEB_BETA)/archive.list $(WEB_BETA)/aliasquestion.list $(WEB_BETA)/label-to-file.pl + +$(WEB_BETA)/dirctan.tex: dirctan.tex +$(WEB_BETA)/filectan.tex: filectan.tex +$(WEB_BETA)/faqbody.tex: faqbody.tex +$(WEB_BETA)/newfaq.aux: newfaq.aux +$(WEB_BETA)/archive.list: archive.list +$(WEB_BETA)/aliasquestion.list: aliasquestion.list +$(WEB_BETA)/label-to-file.pl: label-to-file.pl + +$(WEB_BETA)/dirctan.tex $(WEB_BETA)/filectan.tex $(WEB_BETA)/faqbody.tex $(WEB_BETA)/newfaq.aux $(WEB_BETA)/archive.list $(WEB_BETA)/aliasquestion.list $(WEB_BETA)/label-to-file.pl: + if [ -f $@ ]; then \ + chmod 644 $@; \ + cp -p $< $@-t; \ + mv $@-t $@; \ + else \ + cp -p $< $@; \ + fi chmod 444 $@ inst-perl: $(CGI_BIN)/texfaq2html $(CGI_BIN)/sanitize.pl inst-perl-beta: $(CGI_BIN)/texfaq2html-beta $(CGI_BIN)/sanitize-beta.pl +inst-perl-gamma: $(CGI_BIN)/texfaq2html-gamma $(CGI_BIN)/texfaq2html: $(HOME_DIR)/texfaq2html $(CGI_BIN)/texfaq2html-beta: $(HOME_DIR)/texfaq2html-beta +$(CGI_BIN)/texfaq2html-gamma: $(HOME_DIR)/texfaq2html-gamma $(CGI_BIN)/sanitize.pl: $(HOME_DIR)/sanitize.pl -$(CGI_BIN)/sanitize-beta.pl: $(HOME_DIR)/sanitize.pl +$(CGI_BIN)/sanitize-beta.pl: $(HOME_DIR)/sanitize-beta.pl -$(CGI_BIN)/texfaq2html $(CGI_BIN)/texfaq2html-beta $(CGI_BIN)/sanitize.pl $(CGI_BIN)/sanitize-beta.pl: +$(CGI_BIN)/texfaq2html $(CGI_BIN)/texfaq2html-beta $(CGI_BIN)/texfaq2html-gamma $(CGI_BIN)/sanitize.pl $(CGI_BIN)/sanitize-beta.pl: co -l $@ - copy -t $? $@ + cp -p $? $@ ci -u -m"automatic check-in" $@ html: $(HTMLDIR)/index.html -$(HTMLDIR)/index.html: $(BODY) newfaq.aux +$(HTMLDIR)/index.html: $(BODY) newfaq.aux faqbody.tex ./texfaq2file -inst-html: $(HTMLDIR)/index.html - gtar czvf /homes/rf/FTP/faq/FAQ-html.tar.gz README html/* +html-tar: html + tar czf FAQ-html.tar.gz $(HTMLDIREL)/ + +html-gamma: $(HTMLDIR_GAMMA)/index.html + +$(HTMLDIR_GAMMA)/index.html: $(BODY) newfaq.aux + ./texfaq2file -2 -w + cp -p $(HTMLDIR_GAMMA)/* $(GAMMADIR)/ clean: - rm -f *.ps *.pdf *.dvi *.log *.bak *.toc *.out comment.cut - rm -f *.aux html/*.html + rm -f *.pdf *.dvi *.log *.bak *.toc *.out *.lab *.tpt *.png + rm -f *.aux html/*.html html_gamma/*.html htmltext/*.txt + rm -f pdf-newfaq*.tex comment.cut additions.tex aliasquestion.list + rm -f faqbody.tex FAQ-html.tar.gz diff --git a/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex b/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex index 6c8a31592aa..9dc47096673 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex @@ -1,79 +1,75 @@ - +% $Id: dirctan.tex,v 1.207 2009/10/06 22:23:45 rf10 Exp rf10 $ +% % protect ourself against being read twice \csname readCTANdirs\endcsname \let\readCTANdirs\endinput % % declarations of significant directories on CTAN -\CTANdirectory{2etools}{macros/latex/required/tools} -\CTANdirectory{4spell}{support/4spell} +\CTANdirectory{2etools}{macros/latex/required/tools}[tools] +\CTANdirectory{4spell}{support/4spell}[fourspell] \CTANdirectory*{Catalogue}{help/Catalogue} -\CTANdirectory*{CJK}{language/chinese/CJK} -\CTANdirectory*{MathTeX}{support/mathtex} -\CTANdirectory*{MimeTeX}{support/mimetex} -\CTANdirectory{Tabbing}{macros/latex/contrib/Tabbing} +\CTANdirectory*{MathTeX}{support/mathtex}[mathtex] +\CTANdirectory*{MimeTeX}{support/mimetex}[mimetex] +\CTANdirectory{Tabbing}{macros/latex/contrib/Tabbing}[tabbing] \CTANdirectory*{TeXtelmExtel}{systems/msdos/emtex-contrib/TeXtelmExtel} -\CTANdirectory{TftI}{info/impatient} -\CTANdirectory{a0poster}{macros/latex/contrib/a0poster} -\CTANdirectory{a2ping}{graphics/a2ping} -\CTANdirectory{a4}{macros/latex/contrib/a4} +\CTANdirectory{TftI}{info/impatient}[impatient] +\CTANdirectory{a0poster}{macros/latex/contrib/a0poster}[a0poster] +\CTANdirectory*{a2ping}{graphics/a2ping}[a2ping] +\CTANdirectory{a4}{macros/latex/contrib/a4}[a4] \CTANdirectory*{abc2mtex}{support/abc2mtex} -\CTANdirectory{abstract}{macros/latex/contrib/abstract} +\CTANdirectory{abstract}{macros/latex/contrib/abstract}[abstract] \CTANdirectory{abstyles}{biblio/bibtex/contrib/abstyles} \CTANdirectory{accents}{support/accents} \CTANdirectory*{acorn}{obsolete/systems/acorn} -\CTANdirectory{acronym}{macros/latex/contrib/acronym} +\CTANdirectory{acronym}{macros/latex/contrib/acronym}[acronym] \CTANdirectory*{ada}{web/ada/aweb} \CTANdirectory{addindex}{indexing/addindex} -\CTANdirectory{addlines}{macros/latex/contrib/addlines} +\CTANdirectory{addlines}{macros/latex/contrib/addlines}[addlines] \CTANdirectory{adjkerns}{fonts/utilities/adjkerns} -\CTANdirectory{ae}{fonts/ae} -\CTANdirectory{aeguill}{macros/latex/contrib/aeguill} +\CTANdirectory{ae}{fonts/ae}[ae] +\CTANdirectory{aeguill}{macros/latex/contrib/aeguill}[aeguill] \CTANdirectory{afmtopl}{fonts/utilities/afmtopl} \CTANdirectory{akletter}{macros/latex/contrib/akletter} \CTANdirectory{aleph}{systems/aleph} \CTANdirectory{alg}{macros/latex/contrib/alg} -\CTANdirectory{algorithm2e}{macros/latex/contrib/algorithm2e} -\CTANdirectory{algorithmicx}{macros/latex/contrib/algorithmicx} -\CTANdirectory{algorithms}{macros/latex/contrib/algorithms} -\CTANdirectory*{alpha}{nonfree/systems/mac/support/alpha} +\CTANdirectory{algorithm2e}{macros/latex/contrib/algorithm2e}[algorithm2e] +\CTANdirectory{algorithmicx}{macros/latex/contrib/algorithmicx}[algorithmicx] +\CTANdirectory{algorithms}{macros/latex/contrib/algorithms}[algorithms] +\CTANdirectory*{alpha}{systems/mac/support/alpha}[alpha] \CTANdirectory{amiga}{systems/amiga} -\CTANdirectory*{ams-AMStype1}{fonts/amsfonts/ps-type1} -\CTANdirectory{amsfonts-euler}{fonts/amsfonts/sources/euler} -\CTANdirectory{amsfonts-symbols}{fonts/amsfonts/sources/symbols} -\CTANdirectory{amsfonts-latex}{fonts/amsfonts/latex} -\CTANdirectory{amsfonts-plain}{fonts/amsfonts/plaintex} -\CTANdirectory{amslatex}{macros/latex/required/amslatex} -\CTANdirectory{amslatex-primer}{info/amslatex/primer} +\CTANdirectory{amsfonts}{fonts/amsfonts}[amsfonts] +\CTANdirectory{amslatex}{macros/latex/required/amslatex}[amslatex] +\CTANdirectory{amslatex-primer}{info/amslatex/primer}[amslatex-primer] \CTANdirectory{amspell}{support/amspell} -\CTANdirectory{amsrefs}{macros/latex/contrib/amsrefs} -\CTANdirectory{amstex}{macros/amstex} -\CTANdirectory{answers}{macros/latex/contrib/answers} -\CTANdirectory{ant}{systems/ant} +\CTANdirectory{amsrefs}{macros/latex/contrib/amsrefs}[amsrefs] +\CTANdirectory{amstex}{macros/amstex}[amstex] +\CTANdirectory{answers}{macros/latex/contrib/answers}[answers] +\CTANdirectory{ant}{systems/ant}[ant] \CTANdirectory{apl}{fonts/apl} \CTANdirectory{aplweb}{web/apl/aplweb} \CTANdirectory{appl}{web/reduce/rweb/appl} -\CTANdirectory{appendix}{macros/latex/contrib/appendix} +\CTANdirectory{appendix}{macros/latex/contrib/appendix}[appendix] \CTANdirectory{arabtex}{language/arabic/arabtex} \CTANdirectory{armenian}{fonts/armenian} -\CTANdirectory{aro-bend}{info/challenges/aro-bend} +\CTANdirectory{aro-bend}{info/challenges/aro-bend}[aro-bend] \CTANdirectory{asc2tex}{systems/msdos/asc2tex} \CTANdirectory{ascii}{fonts/ascii} -\CTANdirectory*{aspell}{support/aspell} +\CTANdirectory*{aspell}{support/aspell}[aspell] \CTANdirectory{astro}{fonts/astro} -\CTANdirectory{asymptote}{graphics/asymptote} +\CTANdirectory{asymptote}{graphics/asymptote}[asymptote] \CTANdirectory{atari}{systems/atari} \CTANdirectory{atops}{support/atops} -\CTANdirectory*{auctex}{support/auctex} +\CTANdirectory*{auctex}{support/auctex}[auctex] \CTANdirectory{autolatex}{support/autolatex} -\CTANdirectory{auto-pst-pdf}{macros/latex/contrib/auto-pst-pdf} +\CTANdirectory{auto-pst-pdf}{macros/latex/contrib/auto-pst-pdf}[auto-pst-pdf] \CTANdirectory{aweb}{web/ada/aweb} \CTANdirectory*{awk}{web/spiderweb/src/awk} -\CTANdirectory{axodraw}{graphics/axodraw} -\CTANdirectory{babel}{macros/latex/required/babel} -\CTANdirectory{babelbib}{biblio/bibtex/contrib/babelbib} +\CTANdirectory{axodraw}{graphics/axodraw}[axodraw] +\CTANdirectory{babel}{macros/latex/required/babel}[babel] +\CTANdirectory{babelbib}{biblio/bibtex/contrib/babelbib}[babelbib] \CTANdirectory{badge}{macros/plain/contrib/badge} -\CTANdirectory{bakoma}{fonts/cm/ps-type1/bakoma} -\CTANdirectory*{bakoma-tex}{systems/win32/bakoma} +\CTANdirectory{bakoma}{fonts/cm/ps-type1/bakoma}[bakoma-fonts] +\CTANdirectory*{bakoma-tex}{systems/win32/bakoma}[bakoma] \CTANdirectory*{bakoma-texfonts}{systems/win32/bakoma/fonts} \CTANdirectory*{bard}{fonts/bard} \CTANdirectory{barr}{macros/generic/diagrams/barr} @@ -81,14 +77,14 @@ \CTANdirectory{basix}{macros/generic/basix} \CTANdirectory{bbding}{fonts/bbding} \CTANdirectory{bbfig}{support/bbfig} -\CTANdirectory{bbm}{fonts/cm/bbm} -\CTANdirectory{bbm-macros}{macros/latex/contrib/bbm} -\CTANdirectory{bbold}{fonts/bbold} +\CTANdirectory{bbm}{fonts/cm/bbm}[bbm] +\CTANdirectory{bbm-macros}{macros/latex/contrib/bbm}[bbm-macros] +\CTANdirectory{bbold}{fonts/bbold}[bbold] \CTANdirectory{bdfchess}{fonts/chess/bdfchess} -\CTANdirectory{beamer}{macros/latex/contrib/beamer} +\CTANdirectory{beamer}{macros/latex/contrib/beamer}[beamer] \CTANdirectory{beebe}{dviware/beebe} -\CTANdirectory{beton}{macros/latex/contrib/beton} -\CTANdirectory{bezos}{macros/latex/contrib/bezos} +\CTANdirectory{beton}{macros/latex/contrib/beton}[beton] +\CTANdirectory{bezos}{macros/latex/contrib/bezos}[bezos] \CTANdirectory{bib-fr}{biblio/bibtex/contrib/bib-fr} \CTANdirectory{bib2dvi}{biblio/bibtex/utils/bib2dvi} \CTANdirectory{bib2xhtml}{biblio/bibtex/utils/bib2xhtml} @@ -98,41 +94,39 @@ \CTANdirectory{bibextract}{biblio/bibtex/utils/bibextract} \CTANdirectory{bibgerm}{biblio/bibtex/contrib/germbib} \CTANdirectory{bibindex}{biblio/bibtex/utils/bibindex} -\CTANdirectory{biblatex}{macros/latex/exptl/biblatex} +\CTANdirectory{biblatex}{macros/latex/exptl/biblatex}[biblatex] \CTANdirectory*{biblatex-contrib}{macros/latex/exptl/biblatex-contrib} \CTANdirectory{biblio}{info/biblio} \CTANdirectory{biblist}{macros/latex209/contrib/biblist} \CTANdirectory{bibsort}{biblio/bibtex/utils/bibsort} -\CTANdirectory{bibtex-doc}{biblio/bibtex/contrib/doc} +\CTANdirectory{bibtex-doc}{biblio/bibtex/contrib/doc}[bibtex] \CTANdirectory{bibtool}{biblio/bibtex/utils/bibtool} \CTANdirectory{bibtools}{biblio/bibtex/utils/bibtools} -\CTANdirectory{bibtopic}{macros/latex/contrib/bibtopic} -\CTANdirectory{bibunits}{macros/latex/contrib/bibunits} +\CTANdirectory{bibtopic}{macros/latex/contrib/bibtopic}[bibtopic] +\CTANdirectory{bibunits}{macros/latex/contrib/bibunits}[bibunits] \CTANdirectory{bibview}{biblio/bibtex/utils/bibview} -\CTANdirectory{bigfoot}{macros/latex/contrib/bigfoot} +\CTANdirectory{bigfoot}{macros/latex/contrib/bigfoot}[bigfoot] \CTANdirectory{bit2spr}{graphics/bit2spr} \CTANdirectory{black}{fonts/cm/utilityfonts/black} -\CTANdirectory{blackboard}{info/symbols/blackboard} +\CTANdirectory{blackboard}{info/symbols/blackboard}[blackboard] \CTANdirectory{blackletter}{fonts/blackletter} \CTANdirectory{blocks}{macros/text1/blocks} \CTANdirectory{blu}{macros/blu} -\CTANdirectory*{bluesky}{fonts/cm/ps-type1/bluesky} -\CTANdirectory{bluesky-maps}{fonts/cm/ps-type1/bluesky-contrib/dvips} \CTANdirectory{bm2font}{graphics/bm2font} -\CTANdirectory{bmeps}{support/bmeps} -\CTANdirectory{boites}{macros/latex/contrib/boites} +\CTANdirectory{bmeps}{support/bmeps}[bmeps] +\CTANdirectory{boites}{macros/latex/contrib/boites}[boites] \CTANdirectory{bold}{fonts/cm/mf-extra/bold} \CTANdirectory{bonus}{systems/msdos/emtex-contrib/bonus} -\CTANdirectory{booktabs}{macros/latex/contrib/booktabs} +\CTANdirectory{booktabs}{macros/latex/contrib/booktabs}[booktabs] \CTANdirectory{borceux}{macros/generic/diagrams/borceux} -\CTANdirectory{breakurl}{macros/latex/contrib/breakurl} +\CTANdirectory{breakurl}{macros/latex/contrib/breakurl}[breakurl] \CTANdirectory{bridge}{macros/plain/contrib/bridge} \CTANdirectory{brief_t}{support/brief_t} \CTANdirectory{bst}{biblio/bibtex/contrib/germbib/bst} \CTANdirectory{btable}{macros/plain/contrib/btable} \CTANdirectory{btex8fmt}{macros/generic/cptex/btex8fmt} \CTANdirectory{btOOL}{biblio/bibtex/utils/btOOL} -\CTANdirectory{bundledoc}{support/bundledoc} +\CTANdirectory{bundledoc}{support/bundledoc}[bundledoc] \CTANdirectory{c}{web/spiderweb/src/c} \CTANdirectory{c++}{web/spiderweb/src/c++} \CTANdirectory{c++2latex}{support/C++2LaTeX-1_1pl1} @@ -147,19 +141,19 @@ \CTANdirectory{calligra}{fonts/calligra} \CTANdirectory{calrsfs}{macros/latex/contrib/calrsfs} \CTANdirectory{camel}{macros/latex/contrib/camel} -\CTANdirectory{caption}{macros/latex/contrib/caption} -\CTANdirectory{carlisle}{macros/latex/contrib/carlisle} +\CTANdirectory{caption}{macros/latex/contrib/caption}[caption] +\CTANdirectory{carlisle}{macros/latex/contrib/carlisle}[carlisle] \CTANdirectory{cascover}{macros/plain/contrib/cascover} \CTANdirectory{casslbl}{macros/plain/contrib/casslbl} \CTANdirectory{catdvi}{dviware/catdvi} -\CTANdirectory{ccaption}{macros/latex/contrib/ccaption} -\CTANdirectory{ccfonts}{macros/latex/contrib/ccfonts} +\CTANdirectory{ccaption}{macros/latex/contrib/ccaption}[ccaption] +\CTANdirectory{ccfonts}{macros/latex/contrib/ccfonts}[ccfonts] \CTANdirectory{cellular}{macros/plain/contrib/cellular} -\CTANdirectory{cellspace}{macros/latex/contrib/cellspace} -\CTANdirectory{changebar}{macros/latex/contrib/changebar} -\CTANdirectory{changes}{macros/latex/contrib/changes} -\CTANdirectory{chappg}{macros/latex/contrib/chappg} -\CTANdirectory{chapterfolder}{macros/latex/contrib/chapterfolder} +\CTANdirectory{cellspace}{macros/latex/contrib/cellspace}[cellspace] +\CTANdirectory{changebar}{macros/latex/contrib/changebar}[changebar] +\CTANdirectory{changes}{macros/latex/contrib/changes}[changes] +\CTANdirectory{chappg}{macros/latex/contrib/chappg}[chappg] +\CTANdirectory{chapterfolder}{macros/latex/contrib/chapterfolder}[chapterfolder] \CTANdirectory{charconv}{support/charconv} \CTANdirectory{charter}{fonts/charter} \CTANdirectory{chbar}{macros/plain/contrib/chbar} @@ -176,15 +170,14 @@ \CTANdirectory{circ}{macros/generic/diagrams/circ} \CTANdirectory{circuit_macros}{graphics/circuit_macros} \CTANdirectory{cirth}{fonts/cirth} -\CTANdirectory{cite}{macros/latex/contrib/cite} -\CTANdirectory{citeref}{macros/latex/contrib/citeref} +\CTANdirectory{cite}{macros/latex/contrib/cite}[cite] +\CTANdirectory{citeref}{macros/latex/contrib/citeref}[citeref] \CTANdirectory{clark}{fonts/utilities/afmtopl/clark} -\CTANdirectory{clrscode}{macros/latex/contrib/clrscode} +\CTANdirectory{clrscode}{macros/latex/contrib/clrscode}[clrscode] \CTANdirectory{cm}{fonts/cm} -\CTANdirectory*{cm-AMStype1}{fonts/cm/ps-type1/bluesky} -\CTANdirectory{cm-lgc}{fonts/ps-type1/cm-lgc} -\CTANdirectory{cm-super}{fonts/ps-type1/cm-super} -\CTANdirectory{cmactex}{systems/mac/cmactex} +\CTANdirectory{cm-lgc}{fonts/ps-type1/cm-lgc}[cm-lgc] +\CTANdirectory{cm-super}{fonts/ps-type1/cm-super}[cm-super] +\CTANdirectory{cmactex}{systems/mac/cmactex}[cmactex] \CTANdirectory{cmap}{macros/latex/contrib/cmap} \CTANdirectory{cmastro}{fonts/cmastro} \CTANdirectory{cmcyralt}{macros/latex/contrib/cmcyralt} @@ -192,40 +185,40 @@ \CTANdirectory{cmfrak}{fonts/gothic/cmfrak} \CTANdirectory{cmoefont}{fonts/cmoefont} \CTANdirectory{cmolddig}{fonts/cmolddig} -\CTANdirectory{cmoutlines}{fonts/cm/cmoutlines} +\CTANdirectory{cmoutlines}{fonts/cm/cmoutlines}[cmoutlines] \CTANdirectory{cmpica}{fonts/cmpica} \CTANdirectory{cms_help_files}{macros/text1/cms_help_files} \CTANdirectory{cmtest}{fonts/cm/cmtest} \CTANdirectory{cnoweb}{web/c_cpp/cnoweb} \CTANdirectory{collref}{macros/latex/contrib/collref} -\CTANdirectory{combine}{macros/latex/contrib/combine} -\CTANdirectory{comment}{macros/latex/contrib/comment} +\CTANdirectory{combine}{macros/latex/contrib/combine}[combine] +\CTANdirectory{comment}{macros/latex/contrib/comment}[comment] \CTANdirectory{committee}{fonts/unsupported/committee} \CTANdirectory{comp-fonts-FAQ}{help/comp-fonts-FAQ} \CTANdirectory{components-of-TeX}{info/components-of-TeX} \CTANdirectory{compugraphics_8600}{macros/text1/compugraphics_8600} -\CTANdirectory{concmath}{macros/latex/contrib/concmath} -\CTANdirectory{concmath-f}{fonts/concmath} -\CTANdirectory{concrete}{fonts/concrete} +\CTANdirectory{concmath}{macros/latex/contrib/concmath}[concmath] +\CTANdirectory{concmath-f}{fonts/concmath}[concmath-fonts] +\CTANdirectory{concrete}{fonts/concrete}[concrete] \CTANdirectory{conrado}{web/noweb/contrib/conrado} -\CTANdirectory{context}{macros/context} +\CTANdirectory{context}{macros/context}[context] \CTANdirectory{convert}{support/convert} \CTANdirectory{cortex-email.dir}{language/typingtex/cortex-email.dir} %[fonts/courier] \CTANdirectory{cptex}{macros/generic/cptex} -\CTANdirectory{crop}{macros/latex/contrib/crop} -\CTANdirectory*{crosstex}{biblio/crosstex} +\CTANdirectory{crop}{macros/latex/contrib/crop}[crop] +\CTANdirectory*{crosstex}{biblio/crosstex}[crosstex] \CTANdirectory{crosswrd}{macros/latex/contrib/crosswrd} -\CTANdirectory{crudetype}{dviware/crudetype} +\CTANdirectory{crudetype}{dviware/crudetype}[crudetype] \CTANdirectory{crw}{macros/plain/contrib/crw} \CTANdirectory{cs-tex}{systems/atari/cs-tex} -\CTANdirectory{ctable}{macros/latex/contrib/ctable} +\CTANdirectory{ctable}{macros/latex/contrib/ctable}[ctable] \CTANdirectory{ctan}{help/ctan} \CTANdirectory{cun}{fonts/cun} -\CTANdirectory{currvita}{macros/latex/contrib/currvita} -\CTANdirectory{curve}{macros/latex/contrib/curve} +\CTANdirectory{currvita}{macros/latex/contrib/currvita}[currvita] +\CTANdirectory{curve}{macros/latex/contrib/curve}[curve] \CTANdirectory{curves}{macros/latex/contrib/curves} -\CTANdirectory{custom-bib}{macros/latex/contrib/custom-bib} +\CTANdirectory{custom-bib}{macros/latex/contrib/custom-bib}[custom-bib] \CTANdirectory{cweb}{web/c_cpp/cweb} \CTANdirectory{cweb-p}{web/c_cpp/cweb-p} \CTANdirectory{cypriote}{fonts/cypriote} @@ -240,7 +233,7 @@ \CTANdirectory{dbtex}{support/dbtex} \CTANdirectory{dc-latex}{language/hyphen-accent/dc-latex} \CTANdirectory{dc-nfss}{language/hyphen-accent/dc-nfss} -\CTANdirectory{detex}{support/detex} +\CTANdirectory{detex}{support/detex}[detex] \CTANdirectory{devanagari}{language/devanagari} \CTANdirectory{diagrams}{macros/generic/diagrams} \CTANdirectory{dijkstra}{web/spiderweb/src/dijkstra} @@ -256,20 +249,20 @@ \CTANdirectory{document}{biblio/bibtex/contrib/germbib/document} \CTANdirectory{dos-dc}{systems/msdos/dos-dc} \CTANdirectory{dos-psfonts}{systems/msdos/emtex-fonts/psfonts} -\CTANdirectory{doublestroke}{fonts/doublestroke} -\CTANdirectory{dpfloat}{macros/latex/contrib/dpfloat} +\CTANdirectory{doublestroke}{fonts/doublestroke}[doublestroke] +\CTANdirectory{dpfloat}{macros/latex/contrib/dpfloat}[dpfloat] \CTANdirectory{dpmigcc}{systems/msdos/dpmigcc} -\CTANdirectory{draftcopy}{macros/latex/contrib/draftcopy} -\CTANdirectory{draftwatermark}{macros/latex/contrib/draftwatermark} -\CTANdirectory{dratex}{graphics/dratex} +\CTANdirectory{draftcopy}{macros/latex/contrib/draftcopy}[draftcopy] +\CTANdirectory{draftwatermark}{macros/latex/contrib/draftwatermark}[draftwatermark] +\CTANdirectory{dratex}{graphics/dratex}[dratex] \CTANdirectory{drawing}{graphics/drawing} \CTANdirectory{dropcaps}{macros/latex209/contrib/dropcaps} -\CTANdirectory{dropping}{macros/latex/contrib/dropping} -\CTANdirectory{dtxtut}{info/dtxtut} +\CTANdirectory{dropping}{macros/latex/contrib/dropping}[dropping] +\CTANdirectory{dtxtut}{info/dtxtut}[dtxtut] \CTANdirectory{duerer}{fonts/duerer} \CTANdirectory{dvgt}{dviware/dvgt} \CTANdirectory{dvi-augsburg}{dviware/dvi-augsburg} -\CTANdirectory{dvi2bitmap}{dviware/dvi2bitmap} +\CTANdirectory{dvi2bitmap}{dviware/dvi2bitmap}[dvi2bitmap] \CTANdirectory{dvi2pcl}{dviware/dvi2pcl} \CTANdirectory{dvi2tty}{dviware/dvi2tty} \CTANdirectory{dvibit}{dviware/dvibit} @@ -285,11 +278,11 @@ \CTANdirectory{dvipage}{dviware/dvipage} \CTANdirectory{dvipaste}{dviware/dvipaste} \CTANdirectory{dvipdfm}{dviware/dvipdfm} -\CTANdirectory{dvipdfmx}{dviware/dvipdfmx} +\CTANdirectory{dvipdfmx}{dviware/dvipdfmx}[dvipdfmx] \CTANdirectory{dvipj}{dviware/dvipj} -\CTANdirectory{dvipng}{dviware/dvipng} +\CTANdirectory{dvipng}{dviware/dvipng}[dvipng] \CTANdirectory{dvips-pc}{systems/msdos/dviware/dvips} -\CTANdirectory{dvips}{dviware/dvips} +\CTANdirectory{dvips}{dviware/dvips}[dvips] \CTANdirectory{dvisun}{dviware/dvisun} \CTANdirectory{dvitty}{dviware/dvitty} \CTANdirectory{dvivga}{dviware/dvivga} @@ -297,13 +290,13 @@ \CTANdirectory*{e-TeX}{systems/e-tex} \CTANdirectory{easytex}{systems/msdos/easytex} \CTANdirectory{ebib}{biblio/bibtex/utils/ebib} -\CTANdirectory{ec}{fonts/ec} -\CTANdirectory{ec-plain}{macros/ec-plain} -\CTANdirectory{eco}{fonts/eco} +\CTANdirectory{ec}{fonts/ec}[ec] +\CTANdirectory{ec-plain}{macros/ec-plain}[ec-plain] +\CTANdirectory{eco}{fonts/eco}[eco] \CTANdirectory{economic}{biblio/bibtex/contrib/economic} -\CTANdirectory{edmac}{macros/plain/contrib/edmac} -\CTANdirectory{ednotes}{macros/latex/contrib/ednotes} -\CTANdirectory{eepic}{macros/latex/contrib/eepic} +\CTANdirectory{edmac}{macros/plain/contrib/edmac}[edmac] +\CTANdirectory{ednotes}{macros/latex/contrib/ednotes}[ednotes] +\CTANdirectory{eepic}{macros/latex/contrib/eepic}[eepic] \CTANdirectory{ega2mf}{fonts/utilities/ega2mf} \CTANdirectory{eiad}{fonts/eiad} \CTANdirectory{elsevier}{macros/latex/contrib/elsevier} @@ -314,28 +307,27 @@ \CTANdirectory{emtex-contrib}{systems/msdos/emtex-contrib} \CTANdirectory{emtex-fonts}{systems/msdos/emtex-fonts} \CTANdirectory{emtextds}{obsolete/systems/os2/emtex-contrib/emtexTDS} -\CTANdirectory{endfloat}{macros/latex/contrib/endfloat} +\CTANdirectory{endfloat}{macros/latex/contrib/endfloat}[endfloat] \CTANdirectory{english}{language/english} \CTANdirectory{engwar}{fonts/engwar} -\CTANdirectory{enumitem}{macros/latex/contrib/enumitem} +\CTANdirectory{enumitem}{macros/latex/contrib/enumitem}[enumitem] \CTANdirectory{environment}{support/lsedit/environment} -\CTANdirectory{epic}{macros/latex/contrib/epic} -\CTANdirectory{epigraph}{macros/latex/contrib/epigraph} -\CTANdirectory{eplain}{macros/eplain} +\CTANdirectory{epic}{macros/latex/contrib/epic}[epic] +\CTANdirectory{epigraph}{macros/latex/contrib/epigraph}[epigraph] +\CTANdirectory{eplain}{macros/eplain}[eplain] \CTANdirectory{epmtex}{systems/os2/epmtex} \CTANdirectory{epson}{dviware/epson} -\CTANdirectory*{epstopdf}{support/epstopdf} -\CTANdirectory{eqparbox}{macros/latex/contrib/eqparbox} +\CTANdirectory*{epstopdf}{support/epstopdf}[epstopdf] +\CTANdirectory{eqparbox}{macros/latex/contrib/eqparbox}[eqparbox] \CTANdirectory{ergotex}{systems/msdos/ergotex} \CTANdirectory{errata}{systems/knuth/dist/errata} -\CTANdirectory{eso-pic}{macros/latex/contrib/eso-pic} +\CTANdirectory{eso-pic}{macros/latex/contrib/eso-pic}[eso-pic] \CTANdirectory{et}{support/et} \CTANdirectory{ethiopia}{language/ethiopia} \CTANdirectory{ethtex}{language/ethiopia/ethtex} -\CTANdirectory{etoolbox}{macros/latex/contrib/etoolbox} -\CTANdirectory{euler}{fonts/amsfonts/sources/euler} -\CTANdirectory{euler-latex}{macros/latex/contrib/euler} -\CTANdirectory{eulervm}{fonts/eulervm} +\CTANdirectory{etoolbox}{macros/latex/contrib/etoolbox}[etoolbox] +\CTANdirectory{euler-latex}{macros/latex/contrib/euler}[euler] +\CTANdirectory{eulervm}{fonts/eulervm}[eulervm] \CTANdirectory{euro-ce}{fonts/euro-ce} \CTANdirectory{euro-fonts}{fonts/euro} \CTANdirectory{eurofont}{macros/latex/contrib/eurofont} @@ -346,51 +338,51 @@ \CTANdirectory{excel2latex}{support/excel2latex} \CTANdirectory{excerpt}{web/spiderweb/tools/excerpt} \CTANdirectory{expdlist}{macros/latex/contrib/expdlist} -\CTANdirectory{expl3}{macros/latex/contrib/expl3} -\CTANdirectory{extracm}{fonts/amsfonts/sources/extracm} -\CTANdirectory{extract}{macros/latex/contrib/extract} -\CTANdirectory{extsizes}{macros/latex/contrib/extsizes} -\CTANdirectory{fancyhdr}{macros/latex/contrib/fancyhdr} -\CTANdirectory{fancyvrb}{macros/latex/contrib/fancyvrb} +\CTANdirectory{expl3}{macros/latex/contrib/expl3}[expl3] +\CTANdirectory{extract}{macros/latex/contrib/extract}[extract] +\CTANdirectory{extsizes}{macros/latex/contrib/extsizes}[extsizes] +% cat links to here +\CTANdirectory{fancyhdr}{macros/latex/contrib/fancyhdr}[fancyhdr] +\CTANdirectory{fancyvrb}{macros/latex/contrib/fancyvrb}[fancyvrb] \CTANdirectory{fc}{fonts/jknappen/fc} \CTANdirectory{feyn}{fonts/feyn} \CTANdirectory{feynman}{macros/latex209/contrib/feynman} -\CTANdirectory{feynmf}{macros/latex/contrib/feynmf} +\CTANdirectory{feynmf}{macros/latex/contrib/feynmf}[feynmf] \CTANdirectory{fig2eng}{graphics/fig2eng} \CTANdirectory{fig2mf}{graphics/fig2mf} \CTANdirectory{fig2mfpic}{graphics/fig2mfpic} -\CTANdirectory{fink}{macros/latex/contrib/fink} +\CTANdirectory{figflow}{macros/plain/contrib/figflow}[figflow] +\CTANdirectory{fink}{macros/latex/contrib/fink}[fink] \CTANdirectory{first-latex-doc}{info/first-latex-doc} -\CTANdirectory{fixfoot}{macros/latex/contrib/fixfoot} -\CTANdirectory{float}{macros/latex/contrib/float} -\CTANdirectory{floatflt}{macros/latex/contrib/floatflt} +\CTANdirectory{fixfoot}{macros/latex/contrib/fixfoot}[fixfoot] +\CTANdirectory{float}{macros/latex/contrib/float}[float] +\CTANdirectory{floatflt}{macros/latex/contrib/floatflt}[floatflt] \CTANdirectory{flow}{support/flow} -\CTANdirectory{flowfram}{macros/latex/contrib/flowfram} -\CTANdirectory{fnbreak}{macros/latex/contrib/fnbreak} -\CTANdirectory{fncychap}{macros/latex/contrib/fncychap} -\CTANdirectory{foiltex}{macros/latex/contrib/foiltex} -\CTANdirectory{fontch}{macros/plain/contrib/fontch} -\CTANdirectory{fontinst}{fonts/utilities/fontinst} -\CTANdirectory{fontname}{info/fontname} +\CTANdirectory{flowfram}{macros/latex/contrib/flowfram}[flowfram] +\CTANdirectory{fnbreak}{macros/latex/contrib/fnbreak}[fnbreak] +\CTANdirectory{fncychap}{macros/latex/contrib/fncychap}[fncychap] +\CTANdirectory{foiltex}{macros/latex/contrib/foiltex}[foiltex] +\CTANdirectory{font-change}{macros/plain/contrib/font-change}[font-change] +\CTANdirectory{fontch}{macros/plain/contrib/fontch}[fontch] +\CTANdirectory{fontinst}{fonts/utilities/fontinst}[fontinst] +\CTANdirectory{fontname}{info/fontname}[fontname] \CTANdirectory{fontspec}{macros/xetex/latex/fontspec} -\CTANdirectory{font_selection}{macros/plain/contrib/font_selection} -\CTANdirectory{footbib}{macros/latex/contrib/footbib} -\CTANdirectory{footmisc}{macros/latex/contrib/footmisc} -\CTANdirectory{footnpag}{macros/latex/contrib/footnpag} +\CTANdirectory{font_selection}{macros/plain/contrib/font_selection}[font-selection] +\CTANdirectory{footbib}{macros/latex/contrib/footbib}[footbib] +\CTANdirectory{footmisc}{macros/latex/contrib/footmisc}[footmisc] +\CTANdirectory{footnpag}{macros/latex/contrib/footnpag}[footnpag] \CTANdirectory{for_tex}{biblio/bibtex/contrib/germbib/for_tex} \CTANdirectory{fourier}{fonts/fourier-GUT} \CTANdirectory{fouriernc}{fonts/fouriernc} -\CTANdirectory{frankenstein}{macros/latex/contrib/frankenstein} +\CTANdirectory{frankenstein}{macros/latex/contrib/frankenstein}[frankenstein] \CTANdirectory{french-faq}{help/LaTeX-FAQ-francaise} \CTANdirectory{funnelweb}{web/funnelweb} \CTANdirectory{futhark}{fonts/futhark} \CTANdirectory{futhorc}{fonts/futhorc} \CTANdirectory{fweb}{web/fweb} -\CTANdirectory{gellmu}{support/gellmu} +\CTANdirectory{gellmu}{support/gellmu}[gellmu] \CTANdirectory{genfam}{support/genfam} -\CTANdirectory{geometry}{macros/latex/contrib/geometry} -\CTANdirectory{georgian}{fonts/georgian} -\CTANdirectory{german}{language/german} +\CTANdirectory{geometry}{macros/latex/contrib/geometry}[geometry] \CTANdirectory{germbib}{biblio/bibtex/contrib/germbib} \CTANdirectory{gfs}{info/examples/FirstSteps} % gratzer's \CTANdirectory*{ghostscript}{support/ghostscript} @@ -399,18 +391,18 @@ \CTANdirectory{go}{fonts/go} \CTANdirectory{gothic}{fonts/gothic} \CTANdirectory{graphbase}{support/graphbase} -\CTANdirectory{graphics}{macros/latex/required/graphics} -\CTANdirectory{graphics-plain}{macros/plain/graphics} -\CTANdirectory{graphicx-psmin}{macros/latex/contrib/graphicx-psmin} +\CTANdirectory{graphics}{macros/latex/required/graphics}[graphics] +\CTANdirectory{graphics-plain}{macros/plain/graphics}[graphics-pln] +\CTANdirectory{graphicx-psmin}{macros/latex/contrib/graphicx-psmin}[graphicx-psmin] \CTANdirectory{gray}{fonts/cm/utilityfonts/gray} \CTANdirectory{greek}{fonts/greek} \CTANdirectory{greektex}{fonts/greek/greektex} \CTANdirectory{gregory}{web/noweb/contrib/gregory} \CTANdirectory{gsftopk}{fonts/utilities/gsftopk} -\CTANdirectory*{gsview}{support/ghostscript/ghostgum} +\CTANdirectory*{gsview}{support/ghostscript/ghostgum}[gsview] \CTANdirectory{gut}{usergrps/gut} -\CTANdirectory*{gv}{support/gv} -\CTANdirectory{ha-prosper}{macros/latex/contrib/ha-prosper} +\CTANdirectory*{gv}{support/gv}[gv] +\CTANdirectory{ha-prosper}{macros/latex/contrib/ha-prosper}[ha-prosper] \CTANdirectory{half}{fonts/cm/utilityfonts/half} \CTANdirectory{halftone}{fonts/halftone} \CTANdirectory{hands}{fonts/hands} @@ -431,32 +423,30 @@ \CTANdirectory{hptomf}{support/hptomf} \CTANdirectory{html2latex}{support/html2latex} \CTANdirectory{htmlhelp}{info/htmlhelp} -\CTANdirectory{hvfloat}{macros/latex/contrib/hvfloat} +\CTANdirectory{hvfloat}{macros/latex/contrib/hvfloat}[hvfloat] \CTANdirectory{hvmath}{fonts/micropress/hvmath} \CTANdirectory{hyacc-cm}{macros/generic/hyacc-cm} \CTANdirectory{hyper}{macros/latex/contrib/hyper} \CTANdirectory{hyperbibtex}{biblio/bibtex/utils/hyperbibtex} -\CTANdirectory{hyperref}{macros/latex/contrib/hyperref} +\CTANdirectory{hyperref}{macros/latex/contrib/hyperref}[hyperref] \CTANdirectory{hyphen-accent}{language/hyphen-accent} -\CTANdirectory{hyphenat}{macros/latex/contrib/hyphenat} +\CTANdirectory{hyphenat}{macros/latex/contrib/hyphenat}[hyphenat] \CTANdirectory{hyphenation}{language/hyphenation} \CTANdirectory{ibygrk}{fonts/greek/ibygrk} \CTANdirectory{iching}{fonts/iching} \CTANdirectory{icons}{support/icons} -\CTANdirectory{ifmslide}{macros/latex/contrib/ifmslide} -\CTANdirectory{ifxetex}{macros/generic/ifxetex} +\CTANdirectory{ifmslide}{macros/latex/contrib/ifmslide}[ifmslide] +\CTANdirectory{ifxetex}{macros/generic/ifxetex}[ifxetex] \CTANdirectory{imaketex}{support/imaketex} \CTANdirectory{impact}{web/systems/mac/impact} -\CTANdirectory{index}{macros/latex/contrib/index} -\CTANdirectory{indexing}{indexing} +\CTANdirectory{index}{macros/latex/contrib/index}[index] \CTANdirectory{indian}{language/indian} -\CTANdirectory{info}{info} \CTANdirectory{infpic}{macros/generic/infpic} \CTANdirectory{inlinebib}{biblio/bibtex/contrib/inlinebib} \CTANdirectory{inrsdoc}{macros/inrstex/inrsdoc} \CTANdirectory{inrsinputs}{macros/inrstex/inrsinputs} \CTANdirectory{inrstex}{macros/inrstex} -\CTANdirectory{isi2bibtex}{biblio/bibtex/utils/isi2bibtex} +\CTANdirectory{isi2bibtex}{biblio/bibtex/utils/isi2bibtex}[isi2bibtex] \CTANdirectory{iso-tex}{support/iso-tex} \CTANdirectory{ite}{support/ite} \CTANdirectory{ivd2dvi}{dviware/ivd2dvi} @@ -464,9 +454,9 @@ \CTANdirectory{jemtex2}{systems/msdos/jemtex2} \CTANdirectory{jknappen-macros}{macros/latex/contrib/jknappen} \CTANdirectory{jonkrom}{web/noweb/contrib/jonkrom} -\CTANdirectory{jpeg2ps}{support/jpeg2ps} -\CTANdirectory{jspell}{support/jspell} -\CTANdirectory{jurabib}{macros/latex/contrib/jurabib} +\CTANdirectory{jpeg2ps}{support/jpeg2ps}[jpeg2ps] +\CTANdirectory{jspell}{support/jspell}[jspell] +\CTANdirectory{jurabib}{macros/latex/contrib/jurabib}[jurabib] \CTANdirectory{kaelin}{web/noweb/contrib/kaelin} \CTANdirectory{kamal}{support/kamal} \CTANdirectory{kane}{dviware/kane} @@ -474,7 +464,7 @@ \CTANdirectory{kd}{fonts/greek/kd} \CTANdirectory{kelem}{web/spiderweb/src/kelem} \CTANdirectory{kelly}{fonts/greek/kelly} -\CTANdirectory{keys3}{macros/latex/exptl/keys3} +\CTANdirectory{keys3}{macros/latex/exptl/keys3}[keys3] \CTANdirectory{klinz}{fonts/klinz} \CTANdirectory{knit}{web/knit} \CTANdirectory{knot}{fonts/knot} @@ -484,14 +474,14 @@ %[language/korean] \CTANdirectory{kpfonts}{fonts/kpfonts} \CTANdirectory{kyocera}{dviware/kyocera} -\CTANdirectory{l2a}{support/l2a} +\CTANdirectory{l2a}{support/l2a}[l2a] \CTANdirectory{l2sl}{language/swedish/slatex/l2sl} \CTANdirectory*{l2tabu}{info/l2tabu} \CTANdirectory{l2x}{support/l2x} \CTANdirectory{la}{fonts/la} \CTANdirectory{laan}{macros/generic/laan} \CTANdirectory{laansort}{macros/generic/laansort} -\CTANdirectory{labelcas}{macros/latex/contrib/labelcas} +\CTANdirectory{labelcas}{macros/latex/contrib/labelcas}[labelcas] \CTANdirectory{labels}{macros/latex/contrib/labels} \CTANdirectory{labtex}{macros/generic/labtex} \CTANdirectory{lacheck}{support/lacheck} @@ -501,46 +491,49 @@ \CTANdirectory{latex4jed}{support/jed} \CTANdirectory{larch}{web/spiderweb/src/larch} \CTANdirectory{laserjet}{dviware/laserjet} -\CTANdirectory{lastpage}{macros/latex/contrib/lastpage} +\CTANdirectory{lastpage}{macros/latex/contrib/lastpage}[lastpage] \CTANdirectory{latex-essential}{info/latex-essential} \CTANdirectory{latex-help-texinfo}{info/latex-help-texinfo} -\CTANdirectory*{latex-tds}{macros/latex/contrib/latex-tds} -\CTANdirectory*{latex2html}{support/latex2html} +\CTANdirectory*{latex-tds}{macros/latex/contrib/latex-tds}[latex-tds] +\CTANdirectory*{latex2html}{support/latex2html}[latex2html] \CTANdirectory{latex2rtf}{support/latex2rtf} -\CTANdirectory{latexdiff}{support/latexdiff} -\CTANdirectory{latexdoc}{macros/latex/doc} +\CTANdirectory{latexdiff}{support/latexdiff}[latexdiff] +\CTANdirectory{latexdoc}{macros/latex/doc}[latex-doc] \CTANdirectory{latexhlp}{systems/atari/latexhlp} -\CTANdirectory{latexmake}{support/latexmake} -\CTANdirectory{latexmk}{support/latexmk} -\CTANdirectory{ledmac}{macros/latex/contrib/ledmac} +\CTANdirectory{latexmake}{support/latexmake}[latexmake] +\CTANdirectory{latex-make}{support/latex-make}[latex-make] +\CTANdirectory{latex_maker}{support/latex_maker}[mk] +\CTANdirectory{latexmk}{support/latexmk}[latexmk] +\CTANdirectory{ledmac}{macros/latex/contrib/ledmac}[ledmac] \CTANdirectory{leew}{web/noweb/contrib/leew} -\CTANdirectory{lettrine}{macros/latex/contrib/lettrine} +\CTANdirectory{lettrine}{macros/latex/contrib/lettrine}[lettrine] \CTANdirectory{levy}{fonts/greek/levy} \CTANdirectory{lextex}{macros/plain/contrib/lextex} \CTANdirectory{lgc}{info/examples/lgc} -\CTANdirectory{lgrind}{support/lgrind} -\CTANdirectory{lineno}{macros/latex/contrib/lineno} +\CTANdirectory{lgrind}{support/lgrind}[lgrind] +\CTANdirectory{lineno}{macros/latex/contrib/lineno}[lineno] \CTANdirectory{listbib}{macros/latex/contrib/listbib} -\CTANdirectory{listings}{macros/latex/contrib/listings} -\CTANdirectory{lm}{fonts/lm} -\CTANdirectory{lollipop}{macros/lollipop} +\CTANdirectory{listings}{macros/latex/contrib/listings}[listings] +\CTANdirectory{lm}{fonts/lm}[lm] +\CTANdirectory{lollipop}{macros/lollipop}[lollipop] \CTANdirectory{lookbibtex}{biblio/bibtex/utils/lookbibtex} \CTANdirectory{lsedit}{support/lsedit} -\CTANdirectory*{lshort-parent}{info/lshort} -\CTANdirectory{ltx3pub}{info/ltx3pub} -\CTANdirectory{ltxindex}{macros/latex/contrib/ltxindex} +\CTANdirectory{lshort}{info/lshort/english}[lshort-english] +\CTANdirectory*{lshort-parent}{info/lshort}[lshort] +\CTANdirectory{ltx3pub}{info/ltx3pub}[ltx3pub] +\CTANdirectory{ltxindex}{macros/latex/contrib/ltxindex}[ltxindex] \CTANdirectory{lucida}{fonts/psfonts/bh/lucida} \CTANdirectory{lucida-psnfss}{macros/latex/contrib/psnfssx/lucidabr} \CTANdirectory{luximono}{fonts/LuxiMono} \CTANdirectory{lwc}{info/examples/lwc} -\CTANdirectory{ly1}{macros/latex/contrib/psnfssx/ly1} -\CTANdirectory*{mactex}{systems/mac/mactex} +\CTANdirectory{ly1}{macros/latex/contrib/psnfssx/ly1}[ly1] +\CTANdirectory*{mactex}{systems/mac/mactex}[mactex] \CTANdirectory{mactotex}{graphics/mactotex} \CTANdirectory{mailing}{macros/latex/contrib/mailing} -\CTANdirectory{make_latex}{support/make_latex} +\CTANdirectory{make_latex}{support/make_latex}[make-latex] \CTANdirectory{makeafm.dir}{fonts/utilities/t1tools/makeafm.dir} -\CTANdirectory{makedtx}{support/makedtx} -\CTANdirectory{makeindex}{indexing/makeindex} +\CTANdirectory{makedtx}{support/makedtx}[makedtx] +\CTANdirectory{makeindex}{indexing/makeindex}[makeindex] \CTANdirectory{makeinfo}{macros/texinfo/texinfo/makeinfo} \CTANdirectory{makeprog}{support/makeprog} \CTANdirectory{maketexwork}{info/maketexwork} @@ -551,18 +544,18 @@ \CTANdirectory*{mathdesign}{fonts/mathdesign} \CTANdirectory{mathdots}{macros/generic/mathdots} \CTANdirectory{mathematica}{macros/mathematica} -\CTANdirectory{mathpazo}{fonts/mathpazo} +\CTANdirectory{mathpazo}{fonts/mathpazo}[mathpazo] \CTANdirectory{mathsci2bibtex}{biblio/bibtex/utils/mathsci2bibtex} -\CTANdirectory{mathspic}{graphics/mathspic} -\CTANdirectory{mcite}{macros/latex/contrib/mcite} -\CTANdirectory{mciteplus}{macros/latex/contrib/mciteplus} +\CTANdirectory{mathspic}{graphics/mathspic}[mathspic] +\CTANdirectory{mcite}{macros/latex/contrib/mcite}[mcite] +\CTANdirectory{mciteplus}{macros/latex/contrib/mciteplus}[mciteplus] \CTANdirectory{mctex}{support/mctex} -\CTANdirectory{mdwtools}{macros/latex/contrib/mdwtools} -\CTANdirectory{memoir}{macros/latex/contrib/memoir} +\CTANdirectory{mdwtools}{macros/latex/contrib/mdwtools}[mdwtools] +\CTANdirectory{memoir}{macros/latex/contrib/memoir}[memoir] \CTANdirectory{messtex}{support/messtex} \CTANdirectory{metafont}{systems/mac/metafont} \CTANdirectory{metapost}{graphics/metapost} -\CTANdirectory{metatype1}{fonts/utilities/metatype1} +\CTANdirectory{metatype1}{fonts/utilities/metatype1}[metatype1] \CTANdirectory{mewltx}{support/mewltx} \CTANdirectory{mf-extra}{fonts/cm/mf-extra} \CTANdirectory{mf2ps}{fonts/utilities/mf2ps} @@ -570,64 +563,64 @@ \CTANdirectory{mfbook}{fonts/cm/utilityfonts/mfbook} \CTANdirectory{mff-29}{fonts/utilities/mff-29} \CTANdirectory{mffiles}{language/telugu/mffiles} -\CTANdirectory{mflogo}{macros/latex/contrib/mflogo} +\CTANdirectory{mflogo}{macros/latex/contrib/mflogo}[mflogo] \CTANdirectory{mfnfss}{macros/latex/contrib/mfnfss} \CTANdirectory{mfpic}{graphics/mfpic} \CTANdirectory{mfware}{systems/knuth/dist/mfware} -\CTANdirectory{mh}{macros/latex/contrib/mh} -\CTANdirectory{microtype}{macros/latex/contrib/microtype} +\CTANdirectory{mh}{macros/latex/contrib/mh}[mh] +\CTANdirectory{microtype}{macros/latex/contrib/microtype}[microtype] \CTANdirectory{midi2tex}{support/midi2tex} \CTANdirectory{midnight}{macros/generic/midnight} \CTANdirectory{miktexppc}{obsolete/systems/win32/miktexppc} \CTANdirectory{miktex-AXP}{obsolete/systems/win32/miktex-AXP} -\CTANdirectory{minionpro}{fonts/minionpro} -\CTANdirectory{minitoc}{macros/latex/contrib/minitoc} +\CTANdirectory{minionpro}{fonts/minionpro}[minionpro] +\CTANdirectory{minitoc}{macros/latex/contrib/minitoc}[minitoc] \CTANdirectory{mma2ltx}{graphics/mma2ltx} -\CTANdirectory{mnsymbol}{fonts/mnsymbol} +\CTANdirectory{mnsymbol}{fonts/mnsymbol}[mnsymbol] \CTANdirectory{mnu}{support/mnu} \CTANdirectory{models}{macros/text1/models} -\CTANdirectory{moderncv}{macros/latex/contrib/moderncv} +\CTANdirectory{moderncv}{macros/latex/contrib/moderncv}[moderncv] \CTANdirectory{modes}{fonts/modes} -\CTANdirectory{moreverb}{macros/latex/contrib/moreverb} -\CTANdirectory{mparhack}{macros/latex/contrib/mparhack} +\CTANdirectory{moreverb}{macros/latex/contrib/moreverb}[moreverb] +\CTANdirectory{mparhack}{macros/latex/contrib/mparhack}[mparhack] \CTANdirectory{mps2eps}{support/mps2eps} -\CTANdirectory{ms}{macros/latex/contrib/ms} +\CTANdirectory{ms}{macros/latex/contrib/ms}[ms] \CTANdirectory{msdos}{systems/msdos} \CTANdirectory{msx2msa}{fonts/vf-files/msx2msa} \CTANdirectory{msym}{fonts/msym} \CTANdirectory{mtx}{support/mtx} -\CTANdirectory{multenum}{macros/latex/contrib/multenum} -\CTANdirectory{multibbl}{macros/latex/contrib/multibbl} -\CTANdirectory{multibib}{macros/latex/contrib/multibib} -\CTANdirectory{multirow}{macros/latex/contrib/multirow} -\CTANdirectory{musictex}{macros/musictex} +\CTANdirectory{multenum}{macros/latex/contrib/multenum}[multenum] +\CTANdirectory{multibbl}{macros/latex/contrib/multibbl}[multibbl] +\CTANdirectory{multibib}{macros/latex/contrib/multibib}[multibib] +\CTANdirectory{multirow}{macros/latex/contrib/multirow}[multirow] +\CTANdirectory{musictex}{macros/musictex}[musictex] \CTANdirectory{musixtex-egler}{macros/musixtex/egler} -\CTANdirectory{musixtex-taupin}{macros/musixtex/taupin} +\CTANdirectory{musixtex-taupin}{macros/musixtex/taupin}[musixtex] \CTANdirectory{mutex}{macros/mtex} \CTANdirectory{mxedruli}{fonts/georgian/mxedruli} -\CTANdirectory{nag}{macros/latex/contrib/nag} -\CTANdirectory{natbib}{macros/latex/contrib/natbib} +\CTANdirectory{nag}{macros/latex/contrib/nag}[nag] +\CTANdirectory{natbib}{macros/latex/contrib/natbib}[natbib] \CTANdirectory{nawk}{web/spiderweb/src/nawk} -\CTANdirectory{ncctools}{macros/latex/contrib/ncctools} -\CTANdirectory{newalg}{macros/latex/contrib/newalg} -\CTANdirectory{newcommand}{support/newcommand} -\CTANdirectory{newlfm}{macros/latex/contrib/newlfm} +\CTANdirectory{ncctools}{macros/latex/contrib/ncctools}[ncctools] +\CTANdirectory{newalg}{macros/latex/contrib/newalg}[newalg] +\CTANdirectory{newcommand}{support/newcommand}[newcommand] +\CTANdirectory{newlfm}{macros/latex/contrib/newlfm}[newlfm] \CTANdirectory{newsletr}{macros/plain/contrib/newsletr} \CTANdirectory{nedit-latex}{support/NEdit-LaTeX-Extensions} \CTANdirectory{norbib}{biblio/bibtex/contrib/norbib} \CTANdirectory{noweb}{web/noweb} \CTANdirectory{nrc}{macros/latex/contrib/nrc} \CTANdirectory{ntg}{usergrps/ntg} -\CTANdirectory{ntgclass}{macros/latex/contrib/ntgclass} -\CTANdirectory{ntheorem}{macros/latex/contrib/ntheorem} +\CTANdirectory{ntgclass}{macros/latex/contrib/ntgclass}[ntgclass] +\CTANdirectory{ntheorem}{macros/latex/contrib/ntheorem}[ntheorem] \CTANdirectory{nts-l}{digests/nts-l} \CTANdirectory{nts}{systems/nts} -\CTANdirectory{numparse3}{macros/latex/exptl/numparse3} -\CTANdirectory{numprint}{macros/latex/contrib/numprint} +\CTANdirectory{numparse3}{macros/latex/exptl/numparse3}[numparse3] +\CTANdirectory{numprint}{macros/latex/contrib/numprint}[numprint] \CTANdirectory{nuweb}{web/nuweb} \CTANdirectory{nuweb0.87b}{web/nuweb/nuweb0.87b} \CTANdirectory{nuweb_ami}{web/nuweb/nuweb_ami} -\CTANdirectory{oberdiek}{macros/latex/contrib/oberdiek} +\CTANdirectory{oberdiek}{macros/latex/contrib/oberdiek}[oberdiek] \CTANdirectory{objectz}{macros/latex/contrib/objectz} \CTANdirectory{ocr-a}{fonts/ocr-a} \CTANdirectory{ocr-b}{fonts/ocr-b} @@ -638,45 +631,45 @@ \CTANdirectory{omega}{systems/omega} \CTANdirectory{os2}{systems/os2} \CTANdirectory{osmanian}{fonts/osmanian} -\CTANdirectory{overpic}{macros/latex/contrib/overpic} +\CTANdirectory{overpic}{macros/latex/contrib/overpic}[overpic] \CTANdirectory{oztex}{systems/mac/oztex} \CTANdirectory{page}{support/lametex/page} \CTANdirectory{palladam}{language/tamil/palladam} \CTANdirectory{pandora}{fonts/pandora} -\CTANdirectory{paralist}{macros/latex/contrib/paralist} -\CTANdirectory{parallel}{macros/latex/contrib/parallel} -\CTANdirectory{passivetex}{macros/xmltex/contrib/passivetex} -\CTANdirectory{patchcmd}{macros/latex/contrib/patchcmd} +\CTANdirectory{paralist}{macros/latex/contrib/paralist}[paralist] +\CTANdirectory{parallel}{macros/latex/contrib/parallel}[parallel] +\CTANdirectory{passivetex}{macros/xmltex/contrib/passivetex}[passivetex] +\CTANdirectory{patchcmd}{macros/latex/contrib/patchcmd}[patchcmd] \CTANdirectory{pbm2tex}{support/pbm2tex} \CTANdirectory{pbmtopk}{graphics/pbmtopk} -\CTANdirectory{pbox}{macros/latex/contrib/pbox} +\CTANdirectory{pbox}{macros/latex/contrib/pbox}[pbox] \CTANdirectory{pcwritex}{support/pcwritex} \CTANdirectory{pdcmac}{macros/plain/contrib/pdcmac} -\CTANdirectory{pdfpages}{macros/latex/contrib/pdfpages} -\CTANdirectory{pdftex}{systems/pdftex} -\CTANdirectory{pdftex-graphics}{macros/pdftex/graphics} -\CTANdirectory{pdftricks}{macros/latex/contrib/pdftricks} +\CTANdirectory{pdfpages}{macros/latex/contrib/pdfpages}[pdfpages] +\CTANdirectory{pdftex}{systems/pdftex}[pdftex] +\CTANdirectory{pdftex-graphics}{macros/pdftex/graphics}[pdf-mps-supp] +\CTANdirectory{pdftricks}{macros/latex/contrib/pdftricks}[pdftricks] \CTANdirectory{penelope}{web/spiderweb/src/penelope} \CTANdirectory{pfm2afm}{fonts/utilities/pfm2afm} -\CTANdirectory{pgf}{graphics/pgf} +\CTANdirectory{pgf}{graphics/pgf}[pgf] \CTANdirectory{phonetic}{fonts/phonetic} \CTANdirectory{phy-bstyles}{biblio/bibtex/contrib/phy-bstyles} \CTANdirectory{physe}{macros/physe} \CTANdirectory{phyzzx}{macros/phyzzx} \CTANdirectory{picinpar}{macros/latex209/contrib/picinpar} -\CTANdirectory{picins}{macros/latex209/contrib/picins} -\CTANdirectory{pict2e}{macros/latex/contrib/pict2e} -\CTANdirectory{pictex}{graphics/pictex} -\CTANdirectory{pictex-addon}{graphics/pictex/addon} +\CTANdirectory{picins}{macros/latex209/contrib/picins}[picins] +\CTANdirectory{pict2e}{macros/latex/contrib/pict2e}[pict2e] +\CTANdirectory{pictex}{graphics/pictex}[pictex] +\CTANdirectory{pictex-addon}{graphics/pictex/addon}[pictexwd] \CTANdirectory{pictex-converter}{support/pictex-converter} -\CTANdirectory{pictex-summary}{info/pictex/summary} +\CTANdirectory{pictex-summary}{info/pictex/summary}[pictexsum] \CTANdirectory{pkbbox}{fonts/utilities/pkbbox} -\CTANdirectory{pkfix}{support/pkfix} -\CTANdirectory{pkfix-helper}{support/pkfix-helper} -\CTANdirectory{placeins}{macros/latex/contrib/placeins} -\CTANdirectory{plain}{macros/plain/base} -\CTANdirectory*{plastex}{support/plastex} -\CTANdirectory{plnfss}{macros/plain/plnfss} +\CTANdirectory{pkfix}{support/pkfix}[pkfix] +\CTANdirectory{pkfix-helper}{support/pkfix-helper}[pkfix-helper] +\CTANdirectory{placeins}{macros/latex/contrib/placeins}[placeins] +\CTANdirectory{plain}{macros/plain/base}[plain] +\CTANdirectory*{plastex}{support/plastex}[plastex] +\CTANdirectory{plnfss}{macros/plain/plnfss}[plnfss] \CTANdirectory{plttopic}{support/plttopic} \CTANdirectory{pmtex}{systems/os2/pmtex} \CTANdirectory{pmx}{support/pmx} @@ -684,305 +677,186 @@ \CTANdirectory{poorman}{fonts/poorman} \CTANdirectory{portuguese}{language/portuguese} \CTANdirectory{poster}{macros/generic/poster} -\CTANdirectory{powerdot}{macros/latex/contrib/powerdot} +\CTANdirectory{powerdot}{macros/latex/contrib/powerdot}[powerdot] \CTANdirectory{pp}{support/pp} -\CTANdirectory{preprint}{macros/latex/contrib/preprint} -\CTANdirectory{preview}{macros/latex/contrib/preview} +\CTANdirectory{preprint}{macros/latex/contrib/preprint}[preprint] +\CTANdirectory{preview}{macros/latex/contrib/preview}[preview] \CTANdirectory{print-fine}{support/print-fine} \CTANdirectory{printbib}{biblio/bibtex/utils/printbib} \CTANdirectory{printsamples}{fonts/utilities/mf2ps/doc/printsamples} -\CTANdirectory{program}{macros/latex/contrib/program} +\CTANdirectory{program}{macros/latex/contrib/program}[program] \CTANdirectory{proofs}{macros/generic/proofs} -\CTANdirectory*{protext}{systems/win32/protext} -\CTANdirectory{ppower4}{support/ppower4} -\CTANdirectory{ppr-prv}{macros/latex/contrib/ppr-prv} -\CTANdirectory{prosper}{macros/latex/contrib/prosper} -\CTANdirectory*{ps-type1}{fonts/cm/ps-type1} +\CTANdirectory*{protext}{systems/win32/protext}[protext] +\CTANdirectory{ppower4}{support/ppower4}[ppower4] +\CTANdirectory{ppr-prv}{macros/latex/contrib/ppr-prv}[ppr-prv] +\CTANdirectory{prosper}{macros/latex/contrib/prosper}[prosper] \CTANdirectory{ps-type3}{fonts/cm/ps-type3} \CTANdirectory{ps2mf}{fonts/utilities/ps2mf} \CTANdirectory{ps2pk}{fonts/utilities/ps2pk} \CTANdirectory{psbook}{systems/msdos/dviware/psbook} \CTANdirectory{psbox}{macros/generic/psbox} -\CTANdirectory{pseudocode}{macros/latex/contrib/pseudocode} -\CTANdirectory{psfig}{graphics/psfig} -\CTANdirectory{psfrag}{macros/latex/contrib/psfrag} -\CTANdirectory{psfragx}{macros/latex/contrib/psfragx} +\CTANdirectory{pseudocode}{macros/latex/contrib/pseudocode}[pseudocode] +\CTANdirectory{psfig}{graphics/psfig}[psfig] +\CTANdirectory{psfrag}{macros/latex/contrib/psfrag}[psfrag] +\CTANdirectory{psfragx}{macros/latex/contrib/psfragx}[psfragx] \CTANdirectory{psizzl}{macros/psizzl} -\CTANdirectory{psnfss}{macros/latex/required/psnfss} +\CTANdirectory{psnfss}{macros/latex/required/psnfss}[psnfss] \CTANdirectory{psnfss-addons}{macros/latex/contrib/psnfss-addons} \CTANdirectory{psnfssx-mathtime}{macros/latex/contrib/psnfssx/mathtime} -\CTANdirectory{pspicture}{macros/latex/contrib/pspicture} +\CTANdirectory{pspicture}{macros/latex/contrib/pspicture}[pspicture] \CTANdirectory{psprint}{dviware/psprint} -\CTANdirectory{pst-pdf}{macros/latex/contrib/pst-pdf} -\CTANdirectory{pstab}{support/pstab} -\CTANdirectory{pstoedit}{support/pstoedit} -\CTANdirectory{pstricks}{graphics/pstricks} +\CTANdirectory{pst-pdf}{macros/latex/contrib/pst-pdf}[pst-pdf] +\CTANdirectory{pstoedit}{support/pstoedit}[pstoedit] +\CTANdirectory{pstricks}{graphics/pstricks}[pstricks] \CTANdirectory{psutils}{support/psutils} \CTANdirectory{punk}{fonts/punk} -\CTANdirectory{purifyeps}{support/purifyeps} -\CTANdirectory{pxfonts}{fonts/pxfonts} -\CTANdirectory{pxlgen}{systems/msdos/pxlgen} -\CTANdirectory{qdtexvpl}{fonts/utilities/qdtexvpl} +\CTANdirectory{purifyeps}{support/purifyeps}[purifyeps] +\CTANdirectory{pxfonts}{fonts/pxfonts}[pxfonts] +\CTANdirectory{qdtexvpl}{fonts/utilities/qdtexvpl}[qdtexvpl] \CTANdirectory{qfig}{support/qfig} \CTANdirectory{qms}{dviware/qms} \CTANdirectory{quicspool}{dviware/quicspool} -\CTANdirectory{quotchap}{macros/latex/contrib/quotchap} -\CTANdirectory{r2bib}{biblio/bibtex/utils/r2bib} -\CTANdirectory{ransom}{fonts/ransom} -\CTANdirectory{rcs}{macros/latex/contrib/rcs} -\CTANdirectory{rcsinfo}{macros/latex/contrib/rcsinfo} +\CTANdirectory{quotchap}{macros/latex/contrib/quotchap}[quotchap] +\CTANdirectory{r2bib}{biblio/bibtex/utils/r2bib}[r2bib] +\CTANdirectory{rcs}{macros/latex/contrib/rcs}[rcs] +\CTANdirectory{rcsinfo}{macros/latex/contrib/rcsinfo}[rcsinfo] \CTANdirectory{realcalc}{macros/generic/realcalc} -\CTANdirectory{recycle}{fonts/recycle} -\CTANdirectory{redit}{support/redit} -\CTANdirectory{reduce}{web/reduce} -%[web/spiderweb/src/reduce] -\CTANdirectory{refcheck}{macros/latex/contrib/refcheck} +\CTANdirectory{refcheck}{macros/latex/contrib/refcheck}[refcheck] \CTANdirectory{refer-tools}{biblio/bibtex/utils/refer-tools} -\CTANdirectory{refman}{macros/latex/contrib/refman} -\CTANdirectory{relabel}{support/relabel} -\CTANdirectory{review}{support/lsedit/review} -\CTANdirectory{revtex}{macros/latex/contrib/revtex} -\CTANdirectory{rmit}{fonts/thai/rmit} -\CTANdirectory{rnototex}{support/rnototex} -\CTANdirectory{rotating}{macros/latex/contrib/rotating} -\CTANdirectory{rotfloat}{macros/latex/contrib/rotfloat} -\CTANdirectory{rsfs}{fonts/rsfs} -\CTANdirectory{rtf2tex}{support/rtf2tex} +\CTANdirectory{refman}{macros/latex/contrib/refman}[refman] +\CTANdirectory{revtex}{macros/latex/contrib/revtex}[revtex] +\CTANdirectory{rnototex}{support/rnototex}[rnototex] +\CTANdirectory{rotating}{macros/latex/contrib/rotating}[rotating] +\CTANdirectory{rotfloat}{macros/latex/contrib/rotfloat}[rotfloat] +\CTANdirectory{rsfs}{fonts/rsfs}[rsfs] +\CTANdirectory{rtf2tex}{support/rtf2tex}[rtf2tex] \CTANdirectory{rtf2html}{support/rtf2html} \CTANdirectory{rtf2latex}{support/rtf2latex} -\CTANdirectory{rtf2latex2e}{support/rtf2latex2e} +\CTANdirectory{rtf2latex2e}{support/rtf2latex2e}[rtf2latex2e] \CTANdirectory{rtflatex}{support/rtflatex} \CTANdirectory{rtfutils}{support/tex2rtf/rtfutils} \CTANdirectory{rumgraph}{support/rumgraph} -\CTANdirectory{rune}{fonts/rune} -\CTANdirectory{rweb}{web/reduce/rweb} -\CTANdirectory{s2latex}{support/s2latex} -\CTANdirectory{sam2p}{graphics/sam2p} -\CTANdirectory{sanskrit}{language/sanskrit} -\CTANdirectory{sauerj}{macros/latex/contrib/sauerj} -\CTANdirectory{sauter}{fonts/cm/sauter} -\CTANdirectory{savetrees}{macros/latex/contrib/savetrees} -\CTANdirectory{sbtex}{systems/msdos/sbtex} -\CTANdirectory{schemetex}{support/schemetex} -\CTANdirectory{schemeweb}{web/schemeweb} -\CTANdirectory{sciposter}{macros/latex/contrib/sciposter} -\CTANdirectory{screenview}{dviware/screenview} -\CTANdirectory{script}{macros/latex/contrib/script} -\CTANdirectory{scripttex}{macros/scripttex} -\CTANdirectory{sectsty}{macros/latex/contrib/sectsty} -\CTANdirectory{seminar}{macros/latex/contrib/seminar} -\CTANdirectory{sfware}{fonts/softfonts/sfware} -\CTANdirectory{shade}{macros/generic/shade} -\CTANdirectory{showlabels}{macros/latex/contrib/showlabels} -\CTANdirectory{sisisi}{systems/unix/sisisi} -\CTANdirectory{slant}{fonts/cm/utilityfonts/slant} -\CTANdirectory{slashbox}{macros/latex/contrib/slashbox} -\CTANdirectory{slatex}{language/swedish/slatex} -\CTANdirectory{smallcap}{macros/latex/contrib/smallcap} -\CTANdirectory{smartref}{macros/latex/contrib/smartref} -\CTANdirectory{sml}{web/spiderweb/src/sml} -\CTANdirectory{snapshot}{macros/latex/contrib/snapshot} -\CTANdirectory{softfonts}{fonts/softfonts} -\CTANdirectory{soul}{macros/latex/contrib/soul} -\CTANdirectory{southarabian}{fonts/southarabian} +\CTANdirectory{sam2p}{graphics/sam2p}[sam2p] +\CTANdirectory{sauerj}{macros/latex/contrib/sauerj}[sauerj] +\CTANdirectory{savetrees}{macros/latex/contrib/savetrees}[savetrees] +\CTANdirectory{schemeweb}{web/schemeweb}[schemeweb] +\CTANdirectory{sciposter}{macros/latex/contrib/sciposter}[sciposter] +\CTANdirectory{sectsty}{macros/latex/contrib/sectsty}[sectsty] +\CTANdirectory{seminar}{macros/latex/contrib/seminar}[seminar] +\CTANdirectory{shade}{macros/generic/shade}[shade] +\CTANdirectory{showlabels}{macros/latex/contrib/showlabels}[showlabels] +\CTANdirectory{slashbox}{macros/latex/contrib/slashbox}[slashbox] +\CTANdirectory{smallcap}{macros/latex/contrib/smallcap}[smallcap] +\CTANdirectory{smartref}{macros/latex/contrib/smartref}[smartref] +\CTANdirectory{snapshot}{macros/latex/contrib/snapshot}[snapshot] +\CTANdirectory{soul}{macros/latex/contrib/soul}[soul] \CTANdirectory{spain}{biblio/bibtex/contrib/spain} -\CTANdirectory{spelchek}{support/spelchek} -\CTANdirectory{spell}{support/spell} -\CTANdirectory{spiderweb}{web/spiderweb} -\CTANdirectory{splitbib}{macros/latex/contrib/splitbib} -\CTANdirectory{splitindex}{macros/latex/contrib/splitindex} -\CTANdirectory{srune}{fonts/srune} -\CTANdirectory{ssl}{web/spiderweb/src/ssl} -\CTANdirectory{ssqquote}{macros/latex/contrib/ssqquote} -\CTANdirectory{stmaryrd}{fonts/stmaryrd} -\CTANdirectory{sttools}{macros/latex/contrib/sttools} -\CTANdirectory{subeqnarray}{macros/latex/contrib/subeqnarray} -\CTANdirectory{subfig}{macros/latex/contrib/subfig} -\CTANdirectory{subfiles}{macros/latex/contrib/subfiles} -\CTANdirectory{sueterlin}{fonts/gothic/sueterlin} -\CTANdirectory{supertabular}{macros/latex/contrib/supertabular} -\CTANdirectory{svn}{macros/latex/contrib/svn} -\CTANdirectory{svninfo}{macros/latex/contrib/svninfo} +\CTANdirectory{spiderweb}{web/spiderweb}[spiderweb] +\CTANdirectory{splitbib}{macros/latex/contrib/splitbib}[splitbib] +\CTANdirectory{splitindex}{macros/latex/contrib/splitindex}[splitindex] +\CTANdirectory{sttools}{macros/latex/contrib/sttools}[sttools] +\CTANdirectory{subfig}{macros/latex/contrib/subfig}[subfig] +\CTANdirectory{subfiles}{macros/latex/contrib/subfiles}[subfiles] +\CTANdirectory{supertabular}{macros/latex/contrib/supertabular}[supertabular] +\CTANdirectory{svn}{macros/latex/contrib/svn}[svn] +\CTANdirectory{svninfo}{macros/latex/contrib/svninfo}[svninfo] \CTANdirectory{swebib}{biblio/bibtex/contrib/swebib} -\CTANdirectory{swedish}{language/swedish} -\CTANdirectory{sweet-tex}{systems/mac/sweet-tex} -\CTANdirectory{swetex}{language/swedish/swetex} -\CTANdirectory{swiftex}{support/emacs-modes/swiftex} -\CTANdirectory*{symbols}{info/symbols/comprehensive} -\CTANdirectory{syriac}{fonts/syriac} -\CTANdirectory{t1tidy}{fonts/utilities/t1tools/t1tidy} -\CTANdirectory{t1tools}{fonts/utilities/t1tools} -\CTANdirectory{t1utils}{fonts/utilities/t1utils} -\CTANdirectory{tabulary}{macros/latex/contrib/tabulary} -\CTANdirectory{talk}{macros/latex/contrib/talk} -\CTANdirectory{tamil}{language/tamil} -\CTANdirectory{tbe}{macros/plain/contrib/tbe} -\CTANdirectory{tcdmanual}{info/tcdmanual} -\CTANdirectory{tde-macros}{language/swedish/slatex/tde-macros} -\CTANdirectory{tds}{tds} -\CTANdirectory{ted}{macros/latex/contrib/ted} -\CTANdirectory{teencontrex}{info/spanish/TeEncontreX} -\CTANdirectory{tek2eepic}{support/tek2eepic} -\CTANdirectory{telugu}{language/telugu} -\CTANdirectory{tengwar}{fonts/tengwar} -\CTANdirectory*{testflow}{macros/latex/contrib/IEEEtran/testflow} -\CTANdirectory*{tetex}{obsolete/systems/unix/teTeX/current/distrib} -\CTANdirectory{tex--xet}{obsolete/systems/knuth/tex--xet} -\CTANdirectory{tex-d-l}{digests/tex-d-l} -\CTANdirectory{tex-implementors}{digests/tex-implementors} -\CTANdirectory{tex-mag}{digests/tex-mag} -\CTANdirectory{tex-primer_vms-specific}{info/tex-primer_vms-specific} -\CTANdirectory{tex-surface}{support/tex-surface} -\CTANdirectory{tex2mail}{support/tex2mail} -\CTANdirectory{tex2rtf}{support/tex2rtf} -\CTANdirectory{texbytopic}{info/texbytopic} -\CTANdirectory{texcalc}{support/texcalc} -\CTANdirectory{texchord}{macros/generic/texchord} -\CTANdirectory{texcnvfaq}{help/wp-conv} -\CTANdirectory{texcount}{support/texcount} -\CTANdirectory{texdraw}{graphics/texdraw} -\CTANdirectory{texed}{support/texed} -\CTANdirectory{texfilt}{support/texfilt} -\CTANdirectory{texgraph}{macros/inrstex/texgraph} -\CTANdirectory*{texhax}{digests/texhax} -\CTANdirectory{texi2html}{support/texi2html} -\CTANdirectory{texi2roff}{support/texi2roff} -\CTANdirectory{texindex}{indexing/texindex} -\CTANdirectory{texinfo}{macros/texinfo/texinfo} -\CTANdirectory{texix}{macros/text1/texix} +\CTANdirectory*{symbols}{info/symbols/comprehensive}[comprehensive] +\CTANdirectory{tabulary}{macros/latex/contrib/tabulary}[tabulary] +\CTANdirectory{talk}{macros/latex/contrib/talk}[talk] +\CTANdirectory{tds}{tds}[tds] +\CTANdirectory{ted}{macros/latex/contrib/ted}[ted] +\CTANdirectory*{testflow}{macros/latex/contrib/IEEEtran/testflow}[testflow] +\CTANdirectory*{tetex}{obsolete/systems/unix/teTeX/current/distrib}[tetex] +\CTANdirectory{tex2mail}{support/tex2mail}[tex2mail] +\CTANdirectory{tex2rtf}{support/tex2rtf}[tex2rtf] +\CTANdirectory{texbytopic}{info/texbytopic}[texbytopic] +\CTANdirectory{texcnvfaq}{help/wp-conv}[wp-conv] +\CTANdirectory{texcount}{support/texcount}[texcount] +\CTANdirectory*{texhax}{digests/texhax}[texhax] +\CTANdirectory{texi2html}{support/texi2html}[texi2html] +\CTANdirectory{texindex}{indexing/texindex}[texindex] +\CTANdirectory{texinfo}{macros/texinfo/texinfo}[texinfo] \CTANdirectory{texline}{digests/texline} -\CTANdirectory*{texlive}{systems/texlive} -\CTANdirectory*{texmacs}{systems/unix/TeXmacs} -\CTANdirectory*{texniccenter}{systems/win32/TeXnicCenter} -\CTANdirectory{texpert}{systems/msdos/texpert} -\CTANdirectory{texpower}{macros/latex/contrib/texpower} -\CTANdirectory{texproc}{support/texproc} -\CTANdirectory{texshell}{systems/msdos/texshell} -\CTANdirectory{texsis}{macros/texsis} -\CTANdirectory{text1}{macros/text1} -\CTANdirectory{text2dvi}{systems/msdos/text2dvi} -\CTANdirectory{textcase}{macros/latex/contrib/textcase} -\CTANdirectory{textfit}{macros/latex/contrib/textfit} -\CTANdirectory{textmerg}{macros/latex/contrib/textmerg} -\CTANdirectory{textpos}{macros/latex/contrib/textpos} -\CTANdirectory{textool}{dviware/textool} -\CTANdirectory{textures}{systems/mac/textures} +\CTANdirectory*{texlive}{systems/texlive}[texlive] +\CTANdirectory*{texmacs}{systems/unix/TeXmacs}[texmacs] +\CTANdirectory*{texniccenter}{systems/win32/TeXnicCenter}[texniccenter] +\CTANdirectory{texpower}{macros/latex/contrib/texpower}[texpower] +\CTANdirectory{texshell}{systems/msdos/texshell}[texshell] +\CTANdirectory{texsis}{macros/texsis}[texsis] +\CTANdirectory{textcase}{macros/latex/contrib/textcase}[textcase] +\CTANdirectory{textfit}{macros/latex/contrib/textfit}[textfit] +\CTANdirectory{textmerg}{macros/latex/contrib/textmerg}[textmerg] +\CTANdirectory{textpos}{macros/latex/contrib/textpos}[textpos] \CTANdirectory{textures_figs}{systems/mac/textures_figs} \CTANdirectory{texutils}{systems/atari/texutils} -\CTANdirectory{texware}{systems/knuth/dist/texware} -\CTANdirectory{tgrind}{support/tgrind} -\CTANdirectory{thai}{fonts/thai} -\CTANdirectory{tib}{biblio/tib} -\CTANdirectory{tie}{web/tie} -\CTANdirectory{tiff}{graphics/tiff} -\CTANdirectory{tiny_c2l}{support/tiny_c2l} +\CTANdirectory{tgrind}{support/tgrind}[tgrind] +\CTANdirectory{tib}{biblio/tib}[tib] +\CTANdirectory{tiny_c2l}{support/tiny_c2l}[tinyc2l] \CTANdirectory{tip}{info/examples/tip} -\CTANdirectory{titlesec}{macros/latex/contrib/titlesec} -\CTANdirectory{titling}{macros/latex/contrib/titling} +\CTANdirectory{titlesec}{macros/latex/contrib/titlesec}[titlesec] +\CTANdirectory{titling}{macros/latex/contrib/titling}[titling] \CTANdirectory{tlc2}{info/examples/tlc2} -\CTANdirectory{tmmath}{fonts/micropress/tmmath} -\CTANdirectory{tocbibind}{macros/latex/contrib/tocbibind} -\CTANdirectory{tocloft}{macros/latex/contrib/tocloft} -\CTANdirectory{tocvsec2}{macros/latex/contrib/tocvsec2} -\CTANdirectory{totpages}{macros/latex/contrib/totpages} -\CTANdirectory{tr2latex}{support/tr2latex} -\CTANdirectory{transfig}{graphics/transfig} -\CTANdirectory{translit}{support/translit} -\CTANdirectory{tree}{graphics/tree} -\CTANdirectory{troff}{indexing/makeindex/troff} -\CTANdirectory{tsipa}{fonts/tsipa} -\CTANdirectory{tspell}{support/tspell} -\CTANdirectory{tt2001}{fonts/ps-type1/tt2001} -\CTANdirectory{tth}{support/tth/dist} +\CTANdirectory{tmmath}{fonts/micropress/tmmath}[tmmath] +\CTANdirectory{tocbibind}{macros/latex/contrib/tocbibind}[tocbibind] +\CTANdirectory{tocloft}{macros/latex/contrib/tocloft}[tocloft] +\CTANdirectory{tocvsec2}{macros/latex/contrib/tocvsec2}[tocvsec2] +\CTANdirectory{totpages}{macros/latex/contrib/totpages}[totpages] +\CTANdirectory{tr2latex}{support/tr2latex}[tr2latex] +\CTANdirectory{transfig}{graphics/transfig}[transfig] +\CTANdirectory{tt2001}{fonts/ps-type1/tt2001}[tt2001] +\CTANdirectory{tth}{support/tth/dist}[tth] \CTANdirectory{ttn}{digests/ttn} \CTANdirectory{tug}{usergrps/tug} \CTANdirectory{tugboat}{digests/tugboat} -\CTANdirectory{turing}{web/spiderweb/src/turing} -\CTANdirectory{turing+}{web/spiderweb/src/turing+} -\CTANdirectory{turkish}{language/turkish} -\CTANdirectory{twcal}{fonts/twcal} -\CTANdirectory{tweb}{web/tweb} -\CTANdirectory{tx1}{systems/msdos/tx1} -\CTANdirectory{txfonts}{fonts/txfonts} -\CTANdirectory{txtdist}{support/txt} -\CTANdirectory{type1cm}{macros/latex/contrib/type1cm} -\CTANdirectory{typingtex}{language/typingtex} -\CTANdirectory{ucthesis}{macros/latex/contrib/ucthesis} -\CTANdirectory{ugaritic}{fonts/ugaritic} +\CTANdirectory{tweb}{web/tweb}[tweb] +\CTANdirectory{txfonts}{fonts/txfonts}[txfonts] +\CTANdirectory{txtdist}{support/txt}[txt] +\CTANdirectory{type1cm}{macros/latex/contrib/type1cm}[type1cm] +\CTANdirectory{ucthesis}{macros/latex/contrib/ucthesis}[ucthesis] \CTANdirectory{uktex}{digests/uktex} -\CTANdirectory{uktug}{usergrps/uktug} -\CTANdirectory{faq}{help/uk-tex-faq} -\CTANdirectory{umddvi}{dviware/umddvi} -\CTANdirectory{umlaute}{macros/latex/contrib/umlaute} +\CTANdirectory{faq}{help/uk-tex-faq}[uk-tex-faq] \CTANdirectory{umrand}{macros/generic/umrand} -\CTANdirectory{unadobe}{fonts/utilities/unadobe} -\CTANdirectory{uncompressing}{fonts/utilities/mf2ps/mf2ps/uncompressing} -\CTANdirectory{undump}{obsolete/support/undump} \CTANdirectory{unix}{systems/unix} \CTANdirectory{unpacked}{macros/latex/unpacked} -\CTANdirectory{untex}{support/untex} -\CTANdirectory{urlbst}{biblio/bibtex/contrib/urlbst} -\CTANdirectory{urw-base35}{fonts/urw/base35} -\CTANdirectory{usl}{fonts/thai/usl} -\CTANdirectory{utopia}{fonts/utopia} -\CTANdirectory{utthesis}{macros/latex/contrib/utthesis} -CTANdirectory{va}{fonts/va} -\CTANdirectory{varisize}{macros/plain/contrib/varisize} -\CTANdirectory{vc}{support/vc} -\CTANdirectory{vector}{macros/latex/contrib/vector} -\CTANdirectory{vertex}{macros/plain/contrib/vertex} -\CTANdirectory{vga2mf}{systems/msdos/vga2mf} -\CTANdirectory{vietnamese}{language/vietnamese} -\CTANdirectory{vispeech}{language/vispeech} -\CTANdirectory{vita}{macros/latex/contrib/vita} -\CTANdirectory{vm-cms}{obsolete/systems/vm-cms} -\CTANdirectory{vmargin}{macros/latex/contrib/vmargin} -\CTANdirectory{vmspell}{support/vmspell} -\CTANdirectory{vplutils}{fonts/utilities/vplutils} -\CTANdirectory{vrb}{macros/generic/vrb} -\CTANdirectory{vslitex}{fonts/vf-files/vslitex} +\CTANdirectory{untex}{support/untex}[untex] +\CTANdirectory{urlbst}{biblio/bibtex/contrib/urlbst}[urlbst] +\CTANdirectory{urw-base35}{fonts/urw/base35}[urw-base35] +\CTANdirectory{utopia}{fonts/utopia}[utopia] +\CTANdirectory{varisize}{macros/plain/contrib/varisize}[varisize] +\CTANdirectory{vc}{support/vc}[vc] +\CTANdirectory{vita}{macros/latex/contrib/vita}[vita] +\CTANdirectory{vmargin}{macros/latex/contrib/vmargin}[vmargin] +\CTANdirectory{vmspell}{support/vmspell}[vmspell] +\CTANdirectory{vpp}{support/view_print_ps_pdf}[vpp] \CTANdirectory{vtex-common}{systems/vtex/common} -\CTANdirectory{vtex-linux}{systems/vtex/linux} -\CTANdirectory{vtex-os2}{systems/vtex/os2} -\CTANdirectory{vutex}{dviware/vutex} -\CTANdirectory{w2latex}{support/w2latex} -\CTANdirectory{wallpaper}{macros/latex/contrib/wallpaper} -\CTANdirectory{was}{macros/latex/contrib/was} -\CTANdirectory{wasy2}{fonts/wasy2} -\CTANdirectory{wasysym}{macros/latex/contrib/wasysym} +\CTANdirectory{vtex-linux}{systems/vtex/linux}[vtex-free] +\CTANdirectory{vtex-os2}{systems/vtex/os2}[vtex-free] +\CTANdirectory{wallpaper}{macros/latex/contrib/wallpaper}[wallpaper] +\CTANdirectory{was}{macros/latex/contrib/was}[was] \CTANdirectory{wd2latex}{support/wd2latex} -\CTANdirectory{web}{systems/knuth/dist/web} -\CTANdirectory{webtoc}{support/makeprog/webtoc} -\CTANdirectory{whatstex}{info/whatstex} -\CTANdirectory{williams}{macros/latex/contrib/williams} -\CTANdirectory*{winedt}{systems/win32/winedt} -\CTANdirectory{winw2ltx}{support/winw2ltx} -\CTANdirectory{word2tex}{support/word2tex} -\CTANdirectory{word_tex}{support/word_tex} -\CTANdirectory{wordcount}{macros/latex/contrib/wordcount} -\CTANdirectory{wp2latex}{support/wp2latex} -\CTANdirectory{wrapfig}{macros/latex/contrib/wrapfig} -\CTANdirectory{wsuipa}{fonts/wsuipa} -\CTANdirectory{xargs}{macros/latex/contrib/xargs} -\CTANdirectory{xbibfile}{biblio/bibtex/utils/xbibfile} -\CTANdirectory{xcolor}{macros/latex/contrib/xcolor} -\CTANdirectory*{xdvi}{dviware/xdvi} -\CTANdirectory{xetal}{support/xetal} -\CTANdirectory{xettex}{language/xettex} -\CTANdirectory*{xfig}{graphics/xfig} -\CTANdirectory*{xindy}{indexing/xindy} -\CTANdirectory{xkeyval}{macros/latex/contrib/xkeyval} -\CTANdirectory{xmltex}{macros/xmltex/base} -\CTANdirectory{xpackages}{macros/latex/contrib/xpackages} -\CTANdirectory*{xpdf}{support/xpdf} -\CTANdirectory{xtab}{macros/latex/contrib/xtab} -\CTANdirectory{xypic}{macros/generic/diagrams/xypic/xy} -\CTANdirectory{yagusylo}{macros/latex/contrib/yagusylo} -\CTANdirectory{yhmath-fonts}{fonts/yhmath} +\CTANdirectory{web}{systems/knuth/dist/web}[web] +\CTANdirectory*{winedt}{systems/win32/winedt}[winedt] +\CTANdirectory{wordcount}{macros/latex/contrib/wordcount}[wordcount] +\CTANdirectory{wp2latex}{support/wp2latex}[wp2latex] +\CTANdirectory{wrapfig}{macros/latex/contrib/wrapfig}[wrapfig] +\CTANdirectory{xargs}{macros/latex/contrib/xargs}[xargs] +\CTANdirectory{xbibfile}{biblio/bibtex/utils/xbibfile}[xbibfile] +\CTANdirectory{xcolor}{macros/latex/contrib/xcolor}[xcolor] +\CTANdirectory*{xdvi}{dviware/xdvi}[xdvi] +\CTANdirectory*{xfig}{graphics/xfig}[xfig] +\CTANdirectory*{xindy}{indexing/xindy}[xindy] +\CTANdirectory{xkeyval}{macros/latex/contrib/xkeyval}[xkeyval] +\CTANdirectory{xmltex}{macros/xmltex/base}[xmltex] +\CTANdirectory{xpackages}{macros/latex/contrib/xpackages}[xpackages] +\CTANdirectory*{xpdf}{support/xpdf}[xpdf] +\CTANdirectory{xtab}{macros/latex/contrib/xtab}[xtab] +\CTANdirectory{yagusylo}{macros/latex/contrib/yagusylo}[yagusylo] +\CTANdirectory{yhmath-fonts}{fonts/yhmath}[yhmath] \CTANdirectory{yhmath-macros}{macros/latex/contrib/yhmath} -\CTANdirectory{zefonts}{fonts/zefonts} -\CTANdirectory{ziffer}{macros/latex/contrib/ziffer} -\CTANdirectory{zoon-mp-eg}{info/metapost/examples} +\CTANdirectory{zefonts}{fonts/zefonts}[zefonts] +\CTANdirectory{ziffer}{macros/latex/contrib/ziffer}[ziffer] +\CTANdirectory{zoon-mp-eg}{info/metapost/examples}[metapost-examples] \endinput %%% Local Variables: diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-adj-types.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-adj-types.tex new file mode 100644 index 00000000000..9f3cfc70d27 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-adj-types.tex @@ -0,0 +1,3296 @@ +% $Id: faq-adj-types.tex,v 1.4 2009/09/01 06:53:22 rf10 Exp rf10 $ + +\section{Adjusting the typesetting} + +\subsection{Alternative document classes} + +\Question[Q-replstdcls]{Replacing the standard classes} + +People are forever concocting classes that replace the standard ones: +the present author produced an \Class{ukart} class that used the +\Package{sober} package, and a few British-specific things (such as +appear in the \Package{babel} package's British-english +specialisation) in the 1980s, which is still occasionally used. + +Similar public efforts were available well back in the days of +\LaTeXo{}: a notable example, whose pleasing designs seem not to have +changed much over all that time, is the \Class{ntgclass} bundle. +Each of the standard classes is replaced by a selection of classes, +named in Dutch, sometimes with a single numeric digit attached. So we +have classes \Class{artikel2}, \Class{rapport1}, \Class{boek3} and +\Class{brief}. These classes are moderately well documented in +English. + +The \Class{KOMA-script} bundle (classes named \Class{scr...}) are a +strong current contender. They are actively supported, are +comprehensive in their coverage of significant typesetting issues, +produce good-looking output and are well documented in both English +and German (\Package{scrguien} in the distribution for English, +\Package{scrguide} for German). + +The other comparable class is \Class{memoir}. This aims to replace +\Class{book} and \Class{report} classes directly, and (like +\Class{KOMA-script}) is comprehensive in its coverage of small issues. +\Class{Memoir}'s documentation (\Package{memman}) is very highly +spoken of, and its lengthy introductory section is regularly +recommended as a tutorial on typesetting. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}KOMA-script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[\nothtml{\rmfamily}NTGclass bundle]\CTANref{ntgclass} +\item[sober.sty]\CTANref{sober} +\end{ctanrefs} + +\Question[Q-slidecls]{Producing slides} + +Lamport's original \LaTeX{} had a separate program (Sli\TeX{}) for +producing slides; it dates from the age when colour effects were +produced by printing separate slides in different-coloured inks, and +overlaying them, and was just about acceptable back then. When +\LaTeXe{} came along, the reason Sli\TeX{} had to be a separate +program went away, and its functionality was supplied by the +\Class{slides} class. While this makes life a little easier for +system administrators, it does nothing for the inferior functionality +of the class: no-one ``who knows'' uses \Class{slides} nowadays. + +The `classic' alternatives have been \Class{seminar} and \Class{foils} +(originally known as Foil\TeX{}). Both were originally designed to +produce output on acetate foils, though subsequent work has provided +environments in which they can be used with screen projectors (see +below). + +The advent of Microsoft \ProgName{PowerPoint} (feeble though early +versions of it were) has created a demand for ``dynamic'' slides~--- +images that develop their content in a more elaborate fashion than by +merely replacing one foil with the next in the way that was the norm +when \Class{slides}, \Class{foils} and \Class{seminar} were designed. + +The \Class{prosper} class builds on \Class{seminar} to provide dynamic +effects and the like; it retains the ability to provide \acro{PDF} for +a projected presentation, or to print foils for a foil-based +presentation. The add-on package \Package{ppr-prv} adds ``preview'' +facilities (that which is commonly called ``hand-out printing''). The +\Package{HA-prosper} package, which you load with \Class{prosper}, +mends a few bugs, and adds several facilities and slide design styles. +The (relatively new) \Class{powerdot} class is designed as a +replacement for \Class{prosper} and \Package{HA-prosper}, co-authored +by the author of \Package{HA-prosper}. + +\Class{Beamer} is a relatively easy-to-learn, yet powerful, class that +(as its name implies) was designed for use with projection displays. +It needs the \Package{pgf} package (for graphics support), which in +turn requires \Package{xcolor}; while this adds to the tedium of +installing \Class{beamer} ``from scratch'', both are good additions to +a modern \LaTeX{} installation. \Class{Beamer} has reasonable +facilities for producing printed copies of slides. + +\Class{Talk} is another highly functional, yet easy-to-learn class +which claims to differ from the systems mentioned above, such as +\Class{beamer}, in that it doesn't impose a slide style on you. You +get to specify a bunch of slide styles, and you can switch from one to +the other between slides, as you need. (The class itself provides +just the one style, in the package \Package{greybars}: the author +hopes users will contribute their own styles, based on +\Package{greybars}.) + +\ProgName{Ppower4} (commonly known as \ProgName{pp4}) is a +\ProgName{Java}-based support program that will postprocess +\acro{PDF}, to `animate' the file at places you've marked with +commands from one of the \ProgName{pp4} packages. The commands don't +work on \acro{PDF} that has come from \ProgName{dvips} output; they +work with \acro{PDF} generated by \PDFLaTeX{}, V\TeX{} \LaTeX{}, or +\ProgName{dvipdfm} running on \LaTeX{} output. + +\Package{Pdfscreen} and \Package{texpower} are add-on packages that +permit dynamic effects in documents formatted in ``more modest'' +classes; \Package{pdfscreen} will even allow you to plug +``presentation effects'' into an \Class{article}-class document. + +% ifmslide +%\noindent ifmslide: a few slides extolling virtues in \File{doc/ifmman.pdf} + +A more detailed examination of the alternatives (including examples +of code using many of them) may be found at Michael Wiedmann's fine +\URL{http://www.miwie.org/presentations/presentations.html} + +\CONTeXT{} users will find that much (if not all) of what they need is +already in \CONTeXT{} itself; there's a useful summary of what's +available, with examples, in +\URL{http://wiki.contextgarden.net/Presentation_Styles} +% +\begin{ctanrefs} +\item[beamer.cls]Download all of \CTANref{beamer} +\item[foils.cls]\CTANref{foiltex} +\item[greybars.sty]distributed with \CTANref{talk} +\item[HA-prosper.sty]\CTANref{ha-prosper} +%\item[ifmslide.sty]\CTANref{ifmslide} +\item[seminar.cls]\CTANref{seminar} +\item[pgf.sty]\CTANref{pgf} +\item[powerdot.cls]\CTANref{powerdot} +\item[pp4]\CTANref{ppower4} +\item[ppr-prv.sty]\CTANref{ppr-prv} +\item[prosper.cls]\CTANref{prosper} +\item[talk.cls]\CTANref{talk} +\item[texpower]\CTANref{texpower} +\item[xcolor.sty]\CTANref{xcolor} +\end{ctanrefs} + +\Question[Q-poster]{Creating posters with \LaTeX{}} + +There is no complete ``canned solution'' to creating a poster (as, for +example, classes like \Class{seminar}, \Class{powerdot} and +\Class{beamer} serve for creating presentations in a variety of +styles). + +The nearest approach to the complete solution is the \Class{sciposter} +class, which provides the means to produce really rather good posters +according to the author's required style. A complete worked example +is provided with the distribution + +Otherwise, there is a range of tools, most of which are based on the +\Class{a0poster} class, which sets up an appropriately-sized piece of +paper, sets font sizes appropriately, and leaves you to your own +devices. + +Having used \Class{a0poster}, you can of course slog it out, and write +all your poster as an unadorned \LaTeX{} document (presumably in +multiple columns, using the \Package{multicol} package), but it's not really +necessary: the (straightforward) \Package{textpos} package provides a +simple way of positioning chunks of text, or tables or figures, on the +poster page. + +More sophisticated is the \Package{flowfram} package, whose basic aim +in life is flowing text from one box on the page to the next. One of +the package's design aims seems to have been the production of +posters, and a worked example is provided. The author of +\Package{flowfram} has an experimental tool called +\href{http://theoval.cmp.uea.ac.uk/~nlct/jpgfdraw/}{JpgfDraw}, which +allows you to construct the outline of frames for use with +\Package{flowfram}. + +Despite the relative shortage of tools, there are a fair few web pages +that explain the process (mostly in terms of the \Class{a0poster} +route): +\begin{itemize} +\item from Norman Gray, + \href{http://nxg.me.uk/docs/posters/}{Producing posters using \LaTeX{}}; +\item from Nicola Talbot, % ! line break + \href{http://theoval.sys.uea.ac.uk/~nlct/latex/posters/index.html}{Creating technical posters with \LaTeX{}} +\item from ``\emph{awf}'' and ``\emph{capes}'' % ! line break + \href{http://www.robots.ox.ac.uk/~awf/latex-posters/}{Preparing conference posters in \LaTeX{}} + (the page discusses a sample, which you can download); +\item From Rob Clark % ! line break + \href{http://homepages.inf.ed.ac.uk/robert/posters/advanced.html}{Advanced LaTeX Posters} + (which has links to code samples); +\item from Brian Wolven, + \URL{http://fuse.pha.jhu.edu/~wolven/posters.html} (this page also + provides macros and other support suggestions); and +\item from ``\emph{pjh}'' % ! line break + \href{http://www.phys.ufl.edu/~pjh/posters/poster_howto_UF.html}{Making and printing a poster with \LaTeX{}}, + which covers the specific issue of dealing with University of + Florida styled poster (offering supporting material as necessary), + but has hints which are generally useful. +\end{itemize} +\begin{ctanrefs} +\item[a0poster.cls]\CTANref{a0poster} +\item[flowfram.sty]\CTANref{flowfram} +\item[multicol.sty]Distributed as part of \CTANref{2etools} +\item[sciposter.cls]\CTANref{sciposter} +\item[textpos.sty]\CTANref{textpos} +\end{ctanrefs} + +\Question[Q-thesis]{Formatting a thesis in \LaTeX{}} + +Thesis styles are usually very specific to your University, so it's +usually not profitable to ask around for a package outside your own +University. Since many Universities (in their eccentric way) still +require double-spaced thesis text, you may also need separately to set +up \Qref*{double spacing}{Q-linespace}. + +If you want to write a new thesis class of your own, a good place to +start is the University of California style, but remember that it's +often difficult to produce a thesis that both looks good and conforms +with the style that your Univeristy demands. +\begin{ctanrefs} +\item[UC thesis style]\CTANref{ucthesis} +\end{ctanrefs} + +\Question[Q-journalpaper]{Setting papers for journals} + +Publishers of journals have a wide range of requirements for the +presentation of papers, and while many publishers do accept electronic +submissions in \AllTeX{}, they don't often submit recommended macros to +public archives. + +Nevertheless, there are considerable numbers of macros of one sort or +another available on \acro{CTAN}; searching for your journal name in +the CTAN catalogue~--- see % ! line break +\Qref{searching \acro{CTAN}}{Q-findfiles})~--- +may well turn up what you're seeking. + +Failing that, you may be well advised to contact the prospective +publisher of your paper; many publishers have macros on their own web +sites, or otherwise available only upon application. + +Check that the publisher is offering you macros suitable to an +environment you can use: a few still have no macros for current +\LaTeX{}, for example, claiming that \LaTeXo{} is good enough\dots{} + +Some publishers rekey anything sent them anyway, so that it doesn't +really matter what macros you use. Others merely encourage you to use +as few extensions of a standard package as possible, so that they will +find it easy to transform your paper to their own internal form. + +\Question[Q-multidoc]{A `report' from lots of `article's} + +This is a requirement, for example, if one is preparing the +proceedings of a conference whose papers were submitted in \LaTeX{}. + +The nearest things to canned solutions are Peter Wilson's +\Class{combine} and Federico Garcia's \Class{subfiles} classes. + +\Class{Combine} defines the means to `\csx{import}' entire documents, +and provides means of specifying significant features of the layout of +the document, as well as a global table of contents, and so on. An +auxiliary package, \Package{combinet}, allows use of the \csx{title}s +and \csx{author}s (etc.\@) of the \csx{import}ed documents to appear in +the global table of contents. + +\Class{Subfiles} is used in the component files of a multi-file +project, and the corresponding \Package{subfiles} is used in the +master file; arrangements may be made so that the component files will +be typeset using different page format, etc., parameters than those +used when they are typeset as a part of the main file. + +A more `raw' toolkit is offered by Matt Swift's \Package{includex} and +\Package{newclude} packages, both part of the \Package{frankenstein} +bundle. Note that Matt believes \Package{includex} is obsolete +(though it continues to work for this author); furthermore, its +replacement, \Package{newclude} remains ``in development'', as it has +been since 1999. + +Both \Package{includex} and \Package{newclude} enable you to +`\csx{includedoc}' complete articles (in the way that you +`\csx{include}' chapter files in an ordinary report). The preamble +(everything up to \cmdinvoke{begin}{document}), and everything after +\cmdinvoke{end}{document}, is ignored by both packages. Thus the +packages don't ``do the whole job'' for you, though: you need to +analyse the package use of the individual papers, and ensure that a +consistent set is loaded in the preamble of the main report. (Both +packages require \Package{moredefs}, which is also part of the bundle.) + +A completely different approach is to use the \Package{pdfpages} +package, and to include articles submitted in \acro{PDF} format into a +a \acro{PDF} document produced by \PDFLaTeX{}. The package +defines an \csx{includepdf} command, which takes arguments similar to +those of the \csx{includegraphics} command. With keywords in the +optional argument of the command, you can specify which pages you want +to be included from the file named, and various details of the layout +of the included pages. +\begin{ctanrefs} +\item[combine.cls]\CTANref{combine} +\item[combinet.sty]\CTANref{combine} +\item[includex.sty]Distributed in the ``unsupported'' part of + \CTANref{frankenstein} +\item[moredefs.sty]Distributed as part of \CTANref{frankenstein} +\item[newclude.sty]Distributed as part of \CTANref{frankenstein} +\item[pdfpages.sty]\CTANref{pdfpages} +\item[subfiles.cls, etc.]\CTANref{subfiles} +\end{ctanrefs} + +\Question[Q-cv]{\emph{Curriculum Vitae} (R\'esum\'e)} + +Andrej Brodnik's class, \Class{vita}, offers a framework for producing +a \emph{curriculum vitae}. The class may be customised both for +subject (example class option files support both computer scientists +and singers), and for language (both the options provided are +available for both English and Slovene). Extensions may be written by +creating new class option files, or by using macros defined in the +class to define new entry types, etc. + +Didier Verna's class, \Class{curve}, is based on a model in which +the \acro{CV} is made of a set of \emph{rubrics} (each one dealing +with a major item that you want to discuss, such as `education', `work +experience', etc). The class's documentation is supported by a couple +of example files, and an emacs mode is provided. + +Xavier Danaux offers a class \Class{moderncv} which supports +typesetting modern \emph{curricula vitarum}, both in a classic and in a +casual style. It is fairly customizable, allowing you to define your +own style by changing the colours, the fonts, etc. + +The European Commission has recommended a format for % ! line break +\emph{curricula vitarum} within Europe, and Nicola Vitacolonna has +developed a class \Class{europecv} to produce it. While (by his own +admission) the class doesn't solve all problems, it seems well-thought +out and supports all current official EU languages (together with a +few non-official languages, such as Catalan, Galician and Serbian). + +The alternative to using a separate class is to impose a package on +one of the standard classes. An example, +Axel Reichert's \Package{currvita} package, has been recommended to the +\acro{FAQ} team. Its output certainly looks good. + +There is also a \LaTeXo{} package \Package{resume}, which comes with +little but advice \emph{against} trying to use it. +\begin{ctanrefs} +\item[currvita.sty]\CTANref{currvita} +\item[curve.cls]\CTANref{curve} +\item[europecv.cls]\CTANref{europecv} +\item[moderncv.cls]\CTANref{moderncv} +\item[resume.sty]\CTANref{resume} +\item[vita.cls]\CTANref{vita} +\end{ctanrefs} + +\Question[Q-letterclass]{Letters and the like} + +\LaTeX{} itself provides a \Class{letter} document class, which is +widely disliked; the present author long since gave up trying with +it. If you nevertheless want to try it, but are irritated by its way +of vertically-shifting a single-page letter, try the following hack: +\begin{verbatim} +\makeatletter +\let\@texttop\relax +\makeatother +\end{verbatim} +in the preamble of your file. + +Doing-it-yourself is a common strategy; Knuth (for use with +\plaintex{}, in the \TeX{}book), and Kopka and Daly (in their Guide to +\LaTeX{}) offer worked examples. + +Nevertheless, there \emph{are} contributed alternatives~--- in fact +there are an awfully large number of them: the following list, of +necessity, makes but a small selection. + +The largest, most comprehensive, class is \Class{newlfm}; the \texttt{lfm} +part of the name implies that the class can create letters, faxes and +memoranda. The documentation is voluminous, and the package seems +very flexible. + +Axel Kielhorn's \Class{akletter} class is the only other one, +recommended for inclusion in this \acro{FAQ}, whose documentation is +available in English. + +The \Class{dinbrief} class, while recommended, is only documented in +German. + +There are letter classes in each of the excellent +\Class{KOMA-script} (\Class{scrlttr2}: documentation is available in +English) and \Package{ntgclass} (\Class{brief}: documentation in Dutch +only) bundles. While these are probably good (since the bundles +themselves inspire trust) they've not been specifically recommended by +any users. +\begin{ctanrefs} +\item[akletter.cls]\CTANref{akletter} +\item[brief.cls]Distributed as part of \CTANref{ntgclass} +\item[dinbrief.cls]\CTANref{dinbrief} +\item[newlfm.cls]\CTANref{newlfm} +\item[scrlttr2.cls]Distributed as part of \CTANref{koma-script} +\end{ctanrefs} + +\Question[Q-extsizes]{Other ``document font'' sizes?} + +The \LaTeX{} standard classes have a concept of a (base) ``document +font'' size; this size is the basis on which other font sizes (those +from \csx{tiny} to \csx{Huge}) are determined. The classes are designed +on the assumption that they won't be used with sizes other than the +set that \LaTeX{} offers by default (10--12pt), but people regularly +find they need other sizes. The proper response to such a requirement +is to produce a new design for the document, but many people don't +fancy doing that. + +A simple solution is to use the \Package{extsizes} bundle. This +bundle offers ``extended'' versions of the article, report, book and +letter classes, at sizes of 8, 9, 14, 17 and 20pt as well as the +standard 10--12pt. Since little has been done to these classes other +than to adjust font sizes and things directly related to them, they +may not be optimal~--- but they're certainly practical. + +More satisfactory are the \emph{\acro{KOMA}-script} classes, which are +designed to work properly with the class option files that come with +\Package{extsizes}, and the \Class{memoir} class that has its own +options for document font sizes 9pt--12pt, 14pt, 17pt, 20pt, 25pt, +30pt, 36pt, 48pt and 60pt. +\begin{ctanrefs} +\item[extsizes bundle]\CTANref{extsizes} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\subsection{Document structure} + +\Question[Q-titlsty]{The style of document titles} + +The \Package{titling} package provides a number of facilities that +permit manipulation of the appearance of a \csx{maketitle} command, the +\csx{thanks} commands within it, and so on. The package also defines a +\environment{titlingpage} environment, that offers something in between the +standard classes' \pkgoption{titlepage} option and the \environment{titlepage} +environment, and is itself somewhat configurable. + +The memoir class includes all the functionality of the +\Package{titling} package, while the \Class{KOMA-script} classes have +their own range of different titling styles. + +Finally, the indefatigable Vincent Zoonekynd supplies examples of how +to program alternative % don't let this \href suffer a line-break +\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_title/0.html}{title styles}. +The web page is not useful to users unless they are willing to do +their own \LaTeX{} programming. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[titling.sty]\CTANref{titling} +\end{ctanrefs} + +\Question[Q-secthead]{The style of section headings} + +Suppose that the editor of your favourite journal has specified that section +headings must be centred, in small capitals, and subsection headings ragged +right in italic, but that you don't want to get involved in the sort of +programming described in section 2.2 of \emph{The \LaTeX{} Companion} +\begin{narrowversion} % really non-hyper + (\Qref{}{Q-books}; the programming itself is discussed in + \Qref[question]{}{Q-atsigns}). +\end{narrowversion} +\begin{wideversion} % really hyper + (see \Qref{\TeX{}-related books}{Q-books}; the + \Qref{programming}{Q-atsigns} itself is discussed elsewhere in this + \acro{FAQ}). +\end{wideversion} +The following hack will +probably satisfy your editor. Define yourself new commands +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\newcommand{\ssection}[1]{% + \section[#1]{\centering\normalfont\scshape #1}} +\newcommand{\ssubsection}[1]{% + \subsection[#1]{\raggedright\normalfont\itshape #1}} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} % really non-hyper +\begin{verbatim} +\newcommand{\ssection}[1]{% + \section[#1]{\centering + \normalfont\scshape #1}} +\newcommand{\ssubsection}[1]{% + \subsection[#1]{\raggedright + \normalfont\itshape #1}} +\end{verbatim} +\end{narrowversion} +\end{quote} +and then use \csx{ssection} and \csx{ssubsection} in place of +\csx{section} and \csx{subsection}. This isn't perfect: section numbers +remain in bold, and starred forms need a separate redefinition. + +The \Package{titlesec} package offers a structured approach to the +problem, based on redefinition of the sectioning and chapter commands +themselves. This approach allows it to offer radical adjustment: its +options provide (in effect) a toolbox for designing your own +sectioning commands' output. + +The \Package{sectsty} package provides a more simply structured set of +tools; while it is less powerful than is \Package{titlesec}, it is +perhaps preferable for minor adjustments, since you can use it after +having read a smaller proportion of the manual. + +The \Package{fncychap} package provides a nice collection of customised +chapter heading designs. The \Package{anonchap} package provides a +simple means of typesetting chapter headings ``like section headings'' +(i.e., without the ``Chapter'' part of the heading); the +\Package{tocbibind} package provides the same commands, in pursuit of +another end. + +The \Class{memoir} class includes facilities that match +\Package{sectsty} and \Package{titlesec}, as well as a bundle of +chapter heading styles (including an \Package{anonchap}-equivalent). +The \Class{KOMA-script} classes also have sets of tools that provide +equivalent functionality, notably formatting specifications \csx{partformat}, +\csx{chapterformat}, \csx{sectionformat}, \dots{}, as well as several +useful overall formatting specifications defined in class options. + +Finally, the indefatigable Vincent Zoonekynd supplies examples of how +to program alternative % don't let these \href suffer line-breaks +\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_chapter/0.html}{chapter heading styles} +and +\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_section/0.html}{section heading styles}. +The web pages provide programming examples, and expect users to adapt +them to their own \LaTeX{} use. +\begin{ctanrefs} +\item[anonchap.sty]\CTANref{anonchap} +\item[fncychap.sty]\CTANref{fncychap} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[sectsty.sty]\CTANref{sectsty} +\item[titlesec.sty]\CTANref{titlesec} +\item[tocbibind.sty]\CTANref{tocbibind} +\end{ctanrefs} + +\Question[Q-appendix]{Appendixes} + +\LaTeX{} provides an exceedingly simple mechanism for appendixes: the +command \csx{appendix} switches the document from generating sections +(in \Class{article} class) or chapters (in \Class{report} or +\Class{book} classes) to producing appendixes. Section or chapter +numbering is restarted and the representation of the counter switches +to alphabetic. So: +\begin{quote} +\begin{verbatim} +\section{My inspiration} +... + +\section{Developing the inspiration} +... + +\appendix +\section{How I became inspired} +... +\end{verbatim} +\end{quote} +would be typeset (in an \Class{article} document) something like: +\begin{quote} +\textbf{1~~My inspiration} + +\dots{} + +\textbf{2~~Developing the inspiration} + +\dots{} + +\textbf{A~~How I became inspired} + +\dots{} +\end{quote} +which is quite enough for many ordinary purposes. Note that, once +you've switched to typesetting appendixes, \LaTeX{} provides you with +no way back~--- once you've had an appendix, you can no longer have an +``ordinary'' \csx{section} or \csx{chapter}. + +The \Package{appendix} provides several ways of elaborating on this +simple setup. Straightforward use of the package allows you to have a +separate heading, both in the body of the document and the table of +contents; this would be achieved by +\begin{quote} +\begin{verbatim} +\usepackage{appendix} +... +\appendix +\appendixpage +\addappheadtotoc +\end{verbatim} +\end{quote} +The \csx{appendixpage} command adds a separate title ``Appendices'' +above the first appendix, and \csx{addappheadtotoc} adds a similar +title to the table of contents. These simple modifications cover many +people's needs about appendixes. + +The package also provides an \environment{appendices} environment, +which provides for fancier use. The environment is best controlled by +package options; the above example would be achieved by +\begin{quote} +\begin{verbatim} +\usepackage[toc,page]{appendix} +... +\begin{appendices} +... +\end{appendices} +\end{verbatim} +\end{quote} +The great thing that the \environment{appendices} environment gives +you, is that once the environment ends, you can carry on with sections +or chapters as before~--- numbering isn't affected by the intervening +appendixes. + +The package provides another alternative way of setting appendixes, as +inferior divisions in the document. The \environment{subappendices} +environment allows you to put separate appendixes for a particular +section, coded as \csx{subsection}s, or for a particular chapter, coded +as \csx{section}s. So one might write: +\begin{quote} +\begin{verbatim} +\usepackage{appendix} +... +\section{My inspiration} +... +\begin{subappendices} +\subsection{How I became inspired} +... +\end{subappendices} + +\section{Developing the inspiration} +... +\end{verbatim} +\end{quote} +Which will produce output something like: +\begin{quote} +\textbf{1~~My inspiration} + +\dots{} + +\textbf{1.A~~How I became inspired} + +\dots{} + +\textbf{2~~Developing the inspiration} + +\dots{} +\end{quote} + +There are many other merry things one may do with the package; the +user is referred to the package documentation for further details. + +The \Class{memoir} class includes the facilities of the +\Package{appendix} package. The \Class{KOMA-script} classes offer a +\csx{appendixprefix} command for manipulating the appearance of appendixes. +\begin{ctanrefs} +\item[appendix.sty]\CTANref{appendix} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-secindent]{Indent after section headings} + +\LaTeX{} implements a style that doesn't indent the first paragraph +after a section heading. There are coherent reasons for this, but not +everyone likes it. +The \Package{indentfirst} package +suppresses the mechanism, so that the first paragraph is +indented. +\begin{ctanrefs} +\item[indentfirst.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-subsubsub]{How to create a \csx{subsubsubsection}} + +\LaTeX{}'s set of ``sections'' stops at the level of +\csx{subsubsection}. This reflects a design decision by Lamport~--- +for, after all, who can reasonably want a section with such huge +strings of numbers in front of it? + +In fact, \LaTeX{} standard classes \emph{do} define ``sectioning'' +levels lower than \csx{subsubsection}, but they don't format them like +sections (they're not numbered, and the text is run-in after the +heading). These deeply inferior section commands are \csx{paragraph} +and \csx{subparagraph}; you can (if you \emph{must}) arrange that these +two commands produce numbered headings, so that you can use them as +\csx{subsubsubsection}s and lower. + +The \Package{titlesec} allows you to adjust the definitions of the +sectioning macros, and it may be used to +transform a \csx{paragraph}'s typesetting so that it looks like that +of a \csx{section}. + +If you want to program the change yourself, you'll find that the +commands (\csx{section} all the way down to \csx{subparagraph}) are +defined in terms of the internal \csx{@startsection} command, which +takes 6~arguments. Before attempting this sort of work, you are well +advised to read the \LaTeX{} sources (\File{ltsect.dtx} in the +\LaTeX{} distribution) and the source of the standard packages +(\File{classes.dtx}). The \Qref*{\LaTeX{} Companion}{Q-books} +discusses use of \csx{@startsection} for this sort of thing. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\LaTeX{} source]\CTANref{latex} +\item[titlesec.sty]\CTANref{titlesec} +\end{ctanrefs} + +\Question[Q-captsty]{The style of captions} + +Changes to the style of captions may be made by redefining the commands +that produce the caption. So, for example, \csx{fnum@figure} (which +produces the float number for figure floats) may be redefined, in a +package of your own, or between +\Qref*{\csx{makeatletter}--\csx{makeatother}}{Q-atsigns}: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\renewcommand{\fnum@figure}{\textbf{Fig.~\thefigure}} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\renewcommand{\fnum@figure}% + {\textbf{Fig.~\thefigure}} +\end{verbatim} +\end{narrowversion} +\end{quote} +which will cause the number to be typeset in bold face. (Note that +the original definition used \nothtml{\csx{figurename}~--- }% +\Qref{\csx{figurename}}{Q-fixnam}.) More elaborate changes can be +made by patching the \csx{caption} command, but since there are +packages to do the job, such changes (which can get rather tricky) +aren't recommended for ordinary users. + +The \Package{float} package provides some control of the appearance of +captions, though it's principally designed for the creation of +non-standard floats. The \Package{caption} and \Package{ccaption} +(note the double ``\emph{c}'') packages provide a range of different +formatting options. + +\Package{ccaption} also provides `continuation' captions and captions +that can be placed outside of float environments. The (very simple) +\Package{capt-of} package also allows captions outside a float +environment. Note that care is needed when doing things that assume +the sequence of floats (as in continuation captions), or potentially +mix non-floating captions with floating ones. + +The \Class{memoir} class includes the facilities of the +\Package{ccaption} package; the \Class{KOMA-script} classes also +provide a wide range of caption-formatting commands. + +The documentation of \Package{caption} is available by processing a +file \File{manual.tex}, which is created when you unpack +\File{caption.dtx} + +Note that the previously-recommended package \Package{caption2} has +now been overtaken again by \Package{caption}; however, +\Package{caption2} remains available for use in older documents. +\begin{ctanrefs} +\item[caption.sty]\CTANref{caption} +\item[capt-of.sty]\CTANref{capt-of} +\item[ccaption.sty]\CTANref{ccaption} +\item[float.sty]\CTANref{float} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-fancyhdr]{Alternative head- and footlines in \LaTeX{}} + +The standard \LaTeX{} document classes define a small set of `page +styles' which specify head- and footlines for your document (though +they can be used for other purposes, too). The standard set is very +limited, but \LaTeX{} is capable of much more. The internal +\LaTeX{} coding needed to change page styles is not particularly +challenging, but there's no need~--- there are packages that provide +useful abstractions that match the way we typically think about these +things. + +The \Package{fancyhdr} package provides +simple mechanisms for defining pretty much every head- or footline +variation you could want; the directory also contains some +documentation and one or two smaller packages. \Package{Fancyhdr} +also deals with the tedious behaviour of the standard styles with +\Qref*{initial pages}{Q-nopageno}, by enabling you to define +different page styles for initial and for body pages. + +While \Package{fancyhdr} will work with \Class{KOMA-script} classes, +an alternative package, \Package{scrpage2}, eases integration with the +classes. \Package{Scrpage2} may also be used as a \Package{fancyhdr} +replacement, providing similar facilities. The \Class{KOMA-script} +classes themselves permit some modest redefinition of head- and +footlines, without the use of the extra package. + +\Class{Memoir} also contains the functionality of \Package{fancyhdr}, +and has several predefined styles. + +Documentation of \Package{fancyhdr} is distributed with the package, +in a separate file; documentation of \Package{scrpage2} is integrated +with the \File{scrgui*} documentation files that are distributed with +the \Class{KOMA-script} classes. +\begin{ctanrefs} +\item[fancyhdr.sty]\CTANref{fancyhdr} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-widefigs]{Wide figures in two-column documents} + +Floating figures and tables ordinarily come out the same width as the +page, but in two-column documents they're restricted to the width of +the column. This is sometimes not good enough; so there are alternative +versions of the float environments~--- in two-column documents, +\texttt{figure*} provides a floating page-wide figure (and \texttt{table*} a +page-wide table) which will do the necessary. + +The ``\texttt{*}''ed float environments can only appear at the top of a page, +or on a whole page~--- \texttt{h} or \texttt{b} float placement directives are +simply ignored. + +Unfortunately, page-wide equations can only be accommodated inside +float environments. You should include them in \texttt{figure} environments, +or use the \Package{float} or \Package{ccaption}package to define a +new float type. +\begin{ctanrefs} +\item[ccaption.sty]\CTANref{ccaption} +\item[float.sty]\CTANref{float} +\end{ctanrefs} + +\Question[Q-onecolabs]{1-column abstract in 2-column document} + +One often requires that the abstract of a paper should appear across +the entire page, even in a two-column paper. The required trick is: +\begin{quote} +\begin{verbatim} +\documentclass[twocolumn]{article} +... +\begin{document} +... % \author, etc +\twocolumn[ + \begin{@twocolumnfalse} + \maketitle + \begin{abstract} + ... + \end{abstract} + \end{@twocolumnfalse} + ] +\end{verbatim} +\end{quote} +Unfortunately, with the above \csx{thanks} won't work in the +\csx{author} list. If you need such specially-numbered footnotes, you +can make them like this: +\begin{quote} +\begin{verbatim} +\title{Demonstration} +\author{Me, You\thanks{}} +\twocolumn[ + ... as above ... +] +{ + \renewcommand{\thefootnote}% + {\fnsymbol{footnote}} + \footnotetext[1]{Thanks for nothing} +} +\end{verbatim} +\end{quote} +and so on. + +As an alternative, among other facilities the \Package{abstract} package +provides a +\csx{saythanks} command and a \environment{onecolabstract} environment +which remove the need to fiddle with the \csx{thanks} and +footnoting. They can be used like this: +\begin{quote} +\begin{verbatim} +\twocolumn[ + \maketitle % full width title + \begin{onecolabstract} % ditto abstract + ... text + \end{onecolabstract} +] +\saythanks % typeset any \thanks +\end{verbatim} +\end{quote} +The \Class{memoir} class offers all the facilities of \Package{abstract}. +\begin{ctanrefs} +\item[abstract.sty]\CTANref{abstract} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-reallyblank]{Really blank pages between chapters} + +\Class{Book} (by default) and \Class{report} (with \pkgoption{openright} class +option) ensure that each chapter starts on a right-hand (recto) page; +they do this by inserting a \csx{cleardoublepage} command between +chapters (rather than a mere \csx{clearpage}). The empty page thus +created gets to have a normal running header, which some people don't +like. + +The (excellent) \Package{fancyhdr} manual covers this issue, basically +advising the creation of a command \csx{clearemptydoublepage}: +\begin{quote} +\begin{verbatim} +\let\origdoublepage\cleardoublepage +\newcommand{\clearemptydoublepage}{% + \clearpage + {\pagestyle{empty}\origdoublepage}% +} +\end{verbatim} +\end{quote} +The ``obvious'' thing is then to use this command to replace +\csx{cleardoublepage} in a patched version of the \csx{chapter} command. +(Make a package of your own containing a copy +of the command out of the class.) This isn't particularly difficult, +but you can instead simply subvert \csx{cleardoublepage} (which isn't +often used elsewhere): +\begin{quote} +\begin{verbatim} +\let\cleardoublepage\clearemptydoublepage +\end{verbatim} +\end{quote} +Note: this command works because \csx{clearemptydoublepage} uses a copy +of \csx{cleardoublepage}: instructions on macro programming +% beware line break +\Qref*[question]{patching techniques}{Q-patch} explain the problem and +why this is a solution. + +Note that the \emph{\acro{KOMA}-Script} replacements for the +\Class{book} and \Class{report} classes (\Class{scrbook} and +\Class{scrreprt} offers class options \pkgoption{cleardoubleempty}, +\pkgoption{cleardoubleplain} and \pkgoption{cleardoublestandard} +(using the running page style, as normal) that control the appearance +of these empty pages. The classes also offer do-it-yourself commands +\csx{cleardoubleempty} (etc.\@). + +The \Class{memoir} class (and the \Package{nextpage} package) +provide commands \csx{cleartooddpage} and \csx{cleartoevenpage}, +which both take an optional argument (the first, with no argument, +being an equivalent of \csx{cleardoublepage}). One can achieve +`special' effects by putting commands in the optional argument: the +\csx{clearemptydoublepage} we're after would be achieved by +\csx{cleartooddpage[}\cmdinvoke{thispagestyle}{empty}\texttt{]}. The +commands will also serve if you want the surreal effect of ``This page +intentionally left blank'' in the centre of an otherwise empty page. +\begin{ctanrefs} +\item[fancyhdr]\CTANref{fancyhdr} +\item[memoir.cls]\CTANref{memoir} +\item[nextpage.sty]\CTANref{nextpage} +\item[scrbook.cls, scrrept.cls]Part of \CTANref{koma-script} +\end{ctanrefs} + +\Question[Q-balance]{Balancing columns at the end of a document} + +The \Package{twocolumn} option of the standard classes causes +\LaTeX{} to set the text of a document in two columns. However, the last +page of the document typically ends up with columns of different +lengths~--- such columns are said to be ``unbalanced''. Many (most?) +people don't like unbalanced columns. + +The simplest solution to the problem is to use the \Package{multicol} +package in place of the \Package{twocolumn} option, as +\Package{multicol} balances the columns on the final page by default. +However, the use of \Package{multicol} does come at a cost: its +special output routine disallows the use of in-column floats, though +it does still permit full-width (e.g., \environment{figure*} +environment) floats. + +As a result, there is a constant push for a means of balancing columns +at the end of a \Package{twocolumn} document. Of course, the job can +be done manually: \csx{pagebreak} inserted at the appropriate place on +the last page can often produce the right effect, but this seldom +appeals, and if the last page is made up of automatically-generated +text (for example, bibliography or index) inserting the command will +be difficult. + +The \Package{flushend} package offers a solution to this problem. It's a +somewhat dangerous piece of macro code, which patches one of the most +intricate parts of the \LaTeX{} kernel without deploying any of the +safeguards discussed in \Qref[question]{patching commands}{Q-patch}. +The package only changes the behaviour at end document (its +\csx{flushend} command is enabled by default), and one other command +permits adjustment of the final balance; other packages in the bundle +provide means for insertion of full width material in two-column +documents. + +The \Package{balance} package also patches the output routine +(somewhat more carefully than \Package{flushend}). + +The user should be aware that any of these packages are liable to +become confused in the presence of floats: if problems arise, manual +adjustment of the floats in the document is likely to be necessary. +It is this difficulty (what's required in any instance can't really be +expressed in current \LaTeX{}) that led the author of +\Package{multicol} to suppress single-column-wide floats. +\begin{ctanrefs} +\item[balance.sty]Distributed as part of \CTANref{preprint} +\item[flushend.sty]Distributed as part of \CTANref{sttools} +\item[multicol.sty]Distributed as part of \CTANref{2etools} + +\end{ctanrefs} + +\Question[Q-runheadtoobig]{My section title is too wide for the page header} + +By default, \LaTeX{} sectioning commands make the chapter or section +title available for use by page headers and the like. Page headers +operate in a rather constrained area, and it's common for titles too +be too big to fit: the \LaTeX{} sectioning commands therefore take an +optional argument: +\begin{quote} +\begin{verbatim} +\section[short title]{full title} +\end{verbatim} +\end{quote} +If the \meta{short title} is present, it is used both for the table of +contents and for the page heading. The usual answer to people who +complain that their title is too big for the running head is to +suggest that they the optional argument. + +However, using the same text for the table of contents as for the +running head may also be unsatisfactory: if your chapter titles are +seriously long (like those of a Victorian novel), a valid and rational +scheme is to have a shortened table of contents entry, and a really +terse entry in the running head. + +One of the problems is the tendency of page headings to be set in +capitals (which take up more space); so why not set headings as written +for ``ordinary'' reading? It's not possible to do so with unmodified +\LaTeX{}, but the \Package{fancyhdr} package provides a command +\csx{nouppercase} for use in its header (and footer) lines to suppress +\LaTeX{}'s uppercasing tendencies. Classes in the \Class{KOMA-script} +bundle don't uppercase in the first place. + +In fact, the sectioning commands use `mark' commands to pass +information to the page headers. For example, \csx{chapter} uses +\csx{chaptermark}, \csx{section} uses \csx{sectionmark}, and so on. With +this knowledge, one can achieve a three-layer structure for chapters: +\begin{quote} +\begin{verbatim} +\chapter[middling version]{verbose version} +\chaptermark{terse version} +\end{verbatim} +\end{quote} +which should supply the needs of every taste. + +Chapters, however, have it easy: hardly any book design puts a page +header on a chapter start page. In the case of sections, one has +typically to take account of the nature of the \csx{*mark} commands: +the thing that goes in the heading is the first mark on the page (or, +failing any mark, the last mark on any previous page). As a result +the recipe for sections is more tiresome: +\begin{quote} +\begin{verbatim} +\section[middling version]{verbose version% + \sectionmark{terse version}} +\sectionmark{terse version} +\end{verbatim} +\end{quote} +(the first \csx{sectionmark} deals with the header of the page the +\csx{section} command falls on, and the second deal with subsequent +pages; note that here, you need the optional argument to \csx{section}, +even if ``\emph{middling version}'' is in fact the same text as +``\emph{long version''}.) + +A similar arrangement is necessary even for chapters if the class +you're using is odd enough that it puts a page header on a chapter's +opening page. + +Note that the \Package{titlesec} package manages the running heads in +a completely different fashion; users of that package should refer to +the documentation. + +The \Class{memoir} class avoids all the silliness by providing an +extra optional argument for chapter and sectioning commands, for +example: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\section[middling version][terse version]% + {verbose version} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\section[middling version][terse version]{verbose version} +\end{verbatim} +\end{wideversion} +\end{quote} +As a result, it is always possible for users of \Class{memoir} to +tailor the header text to fit, with very little trouble. +\begin{ctanrefs} +\item[fancyhdr.sty]\CTANref{fancyhdr} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[titlesec.sty]\CTANref{titlesec} +\end{ctanrefs} + +\nothtml{\begingroup\boldmath} +\Question[Q-nofm]{Page numbering ``\meta{n} of \meta{m}''} +\nothtml{\afterquestion} + +Finding the page number of the last page of a document, from within +the document, is somewhat tricky. The \Package{lastpage} package is +therefore supplied to make life easy for us all; it defines a label +\texttt{LastPage} whose number is \emph{right} (after sufficiently many +passes through \LaTeX{}, of course). The \Class{memoir} class also +defines a ``last page'' label. + +The documentation of the \Package{fancyhdr} package spells out exactly +how one might actually use this information to produce page numbering +as suggested in the question. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}fancyhdr documentation]\CTANref{fancyhdr} +\item[lastpage.sty]\CTANref{lastpage} +\end{ctanrefs} + +\Question[Q-pagebychap]{Page numbering by chapter} + +When I was a young man, a common arrangement for loose bound technical +manuals is to number pages by chapter. (It's quite a good scheme, in +those situations: even if your corrections add a whole page to the +chapter, the most you have to redistribute is that chapter.) + +The problem, at first sight, seems pretty much the same as that in +another answer on +% beware line break +\Qref*{running numbers within a chapter}{Q-running-nos}, +and the basic technique is indeed pretty similar. + +However, tidying-up loose ends, making sure the page number gets reset +to the correct value at the start of each chapter, and so on, is +slightly more challenging. This is why the \Package{chappg} package +was written: it does the obvious things, and more. + +Users have been known to ask for running page numbers within a +section, but this really doesn't make sense: you need to run page +numbers within document objects that always start on a fresh page. +\begin{ctanrefs} +\item[chappg.sty]\CTANref{chappg} +\end{ctanrefs} + +\subsection{Page layout} + +\Question[Q-papersize]{The size of printed output} + +The final product of a \AllTeX{} run is something for a person to +read. Often, nowadays, that product will be read ``on-screen'', but +the printed page remains a principal output form. + +When we come to print our output, it is important that the output fits +on the paper; in some cases, for the output to ``fit'' is good enough. +However, there are circumstances where the actual size of the printed +output, on the page, is crucial to the acceptance of the output. +(This might happen when the output is a book to be published, or when +it's a dissertation which must match the fancies of some bureaucrat +even to be considered.) + +Sadly, we often find that the printed output doesn't conform to our +expectations\dots{} + +The check-list for such problems has two entries: +\begin{itemize} +\item Your output is generated via Adobe \ProgName{Reader} (or + possibly ``\ProgName{Acrobat Reader}''~--- older versions of the + program had the qualified name). In this case, it may be that + \ProgName{Reader} is willfully changing the size of your output: + read \Qref*{\ProgName{Reader} antics}{Q-acroantics}. +\item Something in your \TeX{} system is producing the wrong size (or + shape) of output: read \Qref*{paper geometry}{Q-papergeom}. +\end{itemize} + +An alternative approach is to use the (excellent) \Package{testflow} +suite, that provides a detailed outline of the potential problems +together with a sample document and prototype outputs. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}testflow bundle]\CTANref{testflow} +\end{ctanrefs} + +\Question[Q-acroantics]{Adobe \ProgName{Reader} messing with print size} +\AliasQuestion{Q-outszwrng} + +Printing from Adobe \ProgName{Reader} shrinks the page ``to fit'' +(\emph{by default}). Unfortunately, its calculation doesn't consider +the existing margins of the document, so that it shrinks what it +believes is your whole page onto what it believes is its output page. +The effect typically looks as if your margins have expanded. + +Solve this problem by adjusting the \ProgName{Reader}'s default in the +print dialogue; unfortunately, this dialogue varies from one version +to the next: +\begin{itemize} +\item \ProgName{Reader} version 7:\\ + Page Scaling (default: ``Fit to printer margins'')~--- change to + ``None'', and\\ + Scale (default 95\textpercent{} of Normal size)~--- change to + ``100\textpercent''. +\item Adobe Reader 6:\\ + in the print dialogue, on the ``copies \& pages'' pane, you'll find a + popup menu/drop-down list titled ``Page Scaling''~--- change to ``None''. +\item Windows, Linux Acrobat (Reader) 5.0:\\ + In the print dialog, make sure the ``Shrink oversized pages to fit'' + checkbox is unchecked. It may also be useful to uncheck the + ``Expand small pages to fit paper size'' checkbox as well. +\end{itemize} + +\Question[Q-papergeom]{Getting the right paper geometry from \AllTeX{}} + +If your output is the wrong size, and you've checked that it's not due +to the \Qref*{ministrations of Adobe \ProgName{Reader}}{Q-acroantics}, +the problem is probably that your \AllTeX{} system is producing output +that specifies the wrong paper size. Paper sizes can be a pain: +they're a forgotten backwater~--- Knuth seems not to have considered +paper size as something the \TeX{} engine needs to know about. As a +result, there is no \acro{DVI} command to specify the paper on which +the document should be printed, which has led a dichotomy where macros +shape the text according to the needs of the author's chosen paper +size, and device drivers' choice happens independently of the macros' +ideas. + +In practice, one usually finds that macro packages (such as \plaintex{} and +\LaTeX{}) assume American ``letter'' paper size, by default; and since +most distributions nowadays originate in Europe, the drivers usually +default to \acro{ISO} ``A4'' paper size. + +This is (of course) pretty unsatisfactory. Users may select a +different paper size for their document (current \LaTeX{} offers a +range of sizes as options in the standard classes), pretty easily. +Nevertheless, the user also has to be sure that each time +\ProgName{xdvi}, \ProgName{dvips} (or whatever) runs, it uses the +paper size the document was designed for. + +The default paper size for \acro{DVI} drivers may be changed by a +distribution management command (\ProgName{texconfig} for \texlive{}, +the \ProgName{Options} application for \miktex{}), but this still +doesn't provide for people using the ``wrong'' sort of paper for some +reason. + +A different issue arises for users of \PDFTeX{}~--- the +\acro{PDF} format \emph{does} have the means of expressing paper size +and \PDFTeX{} has system variables \csx{pdfpagewidth} and +\csx{pdfpageheight}, that are written into the output \acro{PDF} file. +Unfortunately, most of the core software predates \PDFTeX{}, so not even +\PDFLaTeX{} sets the correct values into those variables, to match the +paper size specified in a \csx{documentclass} option. + +The \acro{DVI} drivers \ProgName{dvips} and \ProgName{dvipdfm} define +\csx{special} commands for the document to specify its own paper size; +so in those cases, as when \PDFTeX{} or V\TeX{} is being used, the +paper size can be programmed by the document. Users who wish to, may +of course consult the manuals of the various programs to write the +necessary code. + +The \Package{geometry} package (whose main business is defining +typeset page areas), also takes notice the size of the paper that the +document is going to be printed on, and can issue the commands +necessary to ensure the correct size of paper is used. If +\Package{geometry} is used when a document is being processed by +\PDFLaTeX{}, it can set the necessary dimensions ``in the output''. +If the document is being processed by \LaTeX{} on a \TeX{} or \eTeX{} +engine, there are package options which instruct \Package{geometry} +which \csx{special} commands to use. (Note that the options are +ignored if you are using either \PDFLaTeX{} or V\TeX{}.) + +So, the resolution of the problem is to add +\begin{quote} +\begin{verbatim} +\usepackage[dvixxx,...]{geometry} +\end{verbatim} +\end{quote} +(where \pkgoption{dvixxx} is your current favourite \acro{DVI} +driver~--- \Package{geometry} knows about \pkgoption{dvips} and +\pkgoption{dvipdfm}), and the document will run correctly with +\LaTeX{}. If you're using \PDFLaTeX{}, load with +\begin{quote} +\begin{verbatim} +\usepackage[pdftex,...]{geometry} +\end{verbatim} +\end{quote} + +Needless to say, both the ``big'' classes (\Class{koma-script} and +\Class{memoir}) provide their own ways to get the paper size +``right''. + +The \Package{typearea} package is the \Class{Koma-script} +distribution's way of providing page layout functionality. Load it +with the \pkgoption{pagesize} option and it will ensure the correct +paper is selected, for \acro{PDF} output from \PDFLaTeX{}, and for +\PS{} output from \LaTeX{} via \ProgName{dvips}. + +\Class{Memoir} has the standard classes' paper-size selections +(\pkgoption{a4paper}, \pkgoption{letterpaper} and so on), but also +permits the user to choose an arbitrary paper size, by setting the +length registers \csx{stockheight} and \csx{stockwidth}. The commands +\csx{fixdvipslayout} (for \LaTeX{} processing), and \csx{fixpdflayout} +(for \PDFLaTeX{} processing) then instruct the processor to produce +output that specifies the necessary paper size. +\begin{ctanrefs} +\item[geometry.sty]\CTANref{geometry} +\item[memoir.cls]\CTANref{memoir} +\item[typearea.sty]Distributed as part of \CTANref{koma-script} +\end{ctanrefs} + +\Question[Q-changemargin]{Changing the margins in \LaTeX{}} + +Changing the layout of a document's text on the page involves several +subtleties not often realised by the beginner. There are interactions +between fundamental \TeX{} constraints, constraints related to the +design of \LaTeX{}, and good typesetting and design practice, that +mean that any change must be very carefully considered, both to ensure +that it ``works'' and to ensure that the result is pleasing to the +eye. + +\LaTeX{}'s defaults sometimes seem excessively conservative, +but there are sound reasons behind how Lamport designed the layouts +themselves, whatever one may feel about his overall design. For +example, the common request for ``one-inch margins all round on A4 +paper'' is fine for 10- or 12-pitch typewriters, but not for 10pt (or +even 11pt or 12pt) type because readers find such wide, dense, lines +difficult to read. There should ideally be no more than 75 characters +per line (though the constraints change for two-column text). + +So Lamport's warning to beginners in his section on `Customizing the +Style'~--- ``don't do it''~--- should not lightly be ignored. + +This set of \acro{FAQ}s recommends that you use a package to establish +consistent settings of the parameters: the interrelationships are +taken care of in the established packages, without you \emph{needing} +to think about them, but remember~--- the packages only provide +consistent, working, mechanisms: they don't analyse the quality of +what you propose to do. + +The following answers deal with the ways one may choose to proceed: +\begin{itemize} +\item \Qref*{Choose which package to use}{Q-marginpkgs}. +\item \Qref*{Find advice on setting up page layout by hand}{Q-marginmanual}. +\end{itemize} +There is a related question~--- how to change the layout +temporarily~--- and there's an answer that covers that, too: +\begin{itemize} +\item \Qref*{Change the margins on the fly}{Q-chngmargonfly}. +\end{itemize} + +\Question[Q-marginpkgs]{Packages to set up page designs} + +The `ultimate' tool for adjusting the dimensions and position of the +printed material on the page is the \Package{geometry} package; a very +wide range of adjustments of the layout may be relatively +straightforwardly programmed, and package documentation is good and +comprehensive. + +As is usual, users of the \Class{memoir} class have built-in +facilities for this task, and users of the \Class{KOMA-script} classes +are recommended to use an alternative package, \Package{typearea}. In +either case it is difficult to argue that users should go for +\Package{geometry}: both alternatives are good. + +The documentation of \Package{geometry} is a bit overwhelming, and +learning all its capabilities may be more than you ever need. +Somewhat simpler to use is the \Package{vmargin} package, which has a +canned set of paper sizes (a superset of that provided in \LaTeXe{}), +provision for custom paper, margin adjustments and provision for +two-sided printing. +\begin{ctanrefs} +\item[geometry.sty]\CTANref{geometry} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[layout.sty]Distributed as part of \CTANref{2etools} +\item[memoir.cls]\CTANref{memoir} +\item[typearea.sty]Distributed as part of \CTANref{koma-script} +\item[vmargin.sty]\CTANref{vmargin} +\end{ctanrefs} + +\Question[Q-marginmanual]{How to set up page layout ``by hand''} + +So you're eager to do it yourself, notwithstanding the cautions +\begin{narrowversion} + outlined above (\Qref{}{Q-changemargin}). +\end{narrowversion} +\begin{wideversion} + outlined in ``\Qref{changing margins}{Q-changemargin}''. +\end{wideversion} + +It's important that you first start by familiarising yourself +with LaTeX's page layout parameters. For example, see section C.5.3 of the +\LaTeX{} manual (pp.~181-182), or corresponding sections in many of the other +good \LaTeX{} manuals (see \Qref[question]{\LaTeX{} books}{Q-books}). + +\LaTeX{} controls the page layout with a number of parameters, which +allow you to change the distance from the edges of a page to the left +and top edges of your typeset text, the width and height of the text, +and the placement of other text on the page. However, they are +somewhat complex, and it is easy to get their interrelationships wrong +when redefining the page layout. The layout package defines a +\csx{layout} command which draws a diagram of your existing page +layout, with the dimensions (but not their interrelationships) shown. + +Even changing the text height and width, \csx{textheight} and +\csx{textwidth}, requires more care than you might expect: the height +should be set to fit a whole number of text lines (in terms of +multiples of \csx{baselinskip}), and the width should be constrained +by the number of characters per line, as mentioned in % ! line break +``\Qref*{changing margins}{Q-changemargin}''. + +Margins are controlled by two parameters: \csx{oddsidemargin} and +\csx{evensidemargin}, whose names come from the convention that +odd-numbered pages appear on the right-hand side (`recto') of a +two-page spread and even-numbered pages on the left-hand side +(`verso'). Both parameters actually refer to the left-hand margin of +the relevant pages; in each case the right-hand margin is specified by +implication, from the value of \csx{textwidth} and the width of the +paper. (In a one-sided document, which is the default in many +classes, including the standard \Class{article} and \Class{report} +classes, \csx{oddsidemargin} stands for both.) + +The +``origin'' (the zero position) on the page is one inch from the top of +the paper and one inch from the left side; positive horizontal +measurements extend right across the page, and positive vertical +measurements extend down the page. Thus, the parameters +\csx{evensidemargin}, \csx{oddsidemargin} and \csx{topmargin}, should +be set to be 1~inch less than the true margin; for margins closer to +the left and top edges of the page than 1~inch, the margin parameters +must be set to negative values. + +\Question[Q-chngmargonfly]{Changing margins ``on the fly''} + +One of the surprises characteristic of \TeX{} use is that you cannot +change the width or height of the text within the document, simply by +modifying the text size parameters; \TeX{} can't change the text width +on the fly, and \LaTeX{} only ever looks at text height when starting +a new page. + +So the simple rule is that the parameters should only be +changed in the preamble of the document, i.e., before the +\cmdinvoke{begin}{document} statement (so before any typesetting has +happened. + +To adjust text width within a document we define an environment: +\begin{quote} +\begin{verbatim} +\newenvironment{changemargin}[2]{% + \begin{list}{}{% + \setlength{\topsep}{0pt}% + \setlength{\leftmargin}{#1}% + \setlength{\rightmargin}{#2}% + \setlength{\listparindent}{\parindent}% + \setlength{\itemindent}{\parindent}% + \setlength{\parsep}{\parskip}% + }% + \item[]}{\end{list}} +\end{verbatim} +\end{quote} +The environment takes two arguments, and will indent the left and +right margins, respectively, by the parameters' values. Negative +values will cause the margins to be narrowed, so +\cmdinvoke{begin}{changemargin}{-1cm}{-1cm} narrows the left and right +margins by 1 centimetre. + +Given that \TeX{} can't do this, how does it work?~--- well, the +environment (which is a close relation of the \LaTeX{} +\environment{quote} environment) \emph{doesn't} change the text width +as far as \TeX{} is concerned: it merely moves text around inside the +width that \TeX{} believes in. + +The \Package{changepage} package provides ready-built commands to do +the above; it includes provision for changing the shifts applied to +your text according to whether you're on an odd (\emph{recto}) or an +even (\emph{verso}) page of a two-sided document. +\Package{Changepage}'s structure matches that of the \Class{memoir} +class. + +The (earlier) package \Package{chngpage} provides the same facilities, +but it uses rather different syntax. \Package{Changepage}'s structure +matches that of the \Class{memoir} class, and it should be used for +any new work. + +Changing the vertical dimensions of a page is more clumsy still: the +\LaTeX{} command \csx{enlargethispage} adjusts the size of the current +page by the size of its argument. Common uses are +\begin{quote} +\begin{verbatim} +\enlargethispage{\baselineskip} +\end{verbatim} +\end{quote} +to make the page one line longer, or +\begin{quote} +\begin{verbatim} +\enlargethispage{-\baselineskip} +\end{verbatim} +\end{quote} +to make the page one line shorter. The process is (to an extent) +simplified by the \Package{addlines} package: its \csx{addlines} +command takes as argument the \emph{number} of lines to add to the +page (rather than a length): the package documentation also provides a +useful analysis of when the command may (or may not) be expected to +work. +\begin{ctanrefs} +\item[addlines.sty]\CTANref{addlines} +\item[changepage.sty]\CTANref{changepage} +\end{ctanrefs} + +\Question[Q-nopageno]{How to get rid of page numbers} +\AliasQuestion{ps@empty} + +Very occasionally, one wants a document with no page numbers. For +such occasions, the package \Package{nopageno} will make +\cmdinvoke{pagestyle}{plain} have the same effect as +\cmdinvoke{pagestyle}{empty}; in simple documents, this will suppress +all page numbering (it will not work, of course, if the document uses +some other pagestyle than \environment{plain}). + +To suppress page numbers from a sequence of pages, you may use +\cmdinvoke{pagestyle}{empty} at the start of the sequence, and restore +the original page style at the end. Unfortunately, you still have to +deal with the page numbers on pages containing a \csx{maketitle}, +\csx{part} or \csx{chapter} command, since the standard classes; deal +with those separately, as described below. + +To suppress page numbers on a single page, use +\cmdinvoke{thispagestyle}{empty} somewhere within the text of the +page. Note that, in the standard classes, \csx{maketitle} and +\csx{chapter} use \csx{thispagestyle} internally, so your call +must be \emph{after} those commands. + +Unfortunately, \csx{thispagestyle} doesn't work for \Class{book} or +\Class{report} \csx{part} commands: they set the page style (as do +\csx{chapter} commands), but then they advance to the next page so +that you have no opportunity to change the style using +\csx{thispagestyle}. The present author has proposed solving the +problem with the following ``grubby little patch'', on +\Newsgroup{comp.text.tex}: +\begin{quote} +\begin{verbatim} +\makeatletter +\let\sv@endpart\@endpart +\def\@endpart{\thispagestyle{empty}\sv@endpart} +\makeatother +\end{verbatim} +\end{quote} + +Both the \Class{KOMA-script} classes and \Class{memoir} have separate +page styles for the styles of various ``special'' pages, so, in a +\Class{KOMA} class document one might say: +\begin{quote} +\begin{verbatim} +\renewcommand*{\titlepagestyle}{empty} +\end{verbatim} +\end{quote} +while \Class{memoir} will do the job with +\begin{quote} + \cmdinvoke{aliaspagestyle}{title}{empty} +\end{quote} + +An alternative (in all classes) is to use the rather delightful +\cmdinvoke{pagenumbering}{gobble}; this has the simple effect that any +attempt to print a page number produces nothing, so there's no issue +about preventing any part of \LaTeX{} from printing the number. +However, the \csx{pagenumbering} command does have the side effect that +it resets the page number (to 1), so it is unlikely to be helpful +other than at the beginning of a document. + +The \Package{scrpage2} package separates out the representation of the +page number (it typesets the number using the \csx{pagemark} command) from +the construction of the page header and footer; so one can say +\begin{quote} +\begin{verbatim} +\renewcommand*{\pagemark}{} +\end{verbatim} +\end{quote} +which will also suppress the printing of the page number. + +Neither of these ``suppress the page number'' techniques touches the +page style in use; in practice this means they don't make sense unless +you are using \cmdinvoke{pagestyle}{plain} +\begin{ctanrefs} +\item[fancyhdr.sty]\CTANref{fancyhdr} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[nopageno.sty]\CTANref{nopageno} +\item[scrpage2.sty]Distributed as part of \CTANref{koma-script} +\end{ctanrefs} + +\Question[Q-crop]{How to create crop marks} + +If you're printing something that's eventually to be reproduced in +significant quantities, and bound, it's conventional to print on paper +larger than your target product, and to place ``crop marks'' outside +the printed area. These crop marks are available to the production +house, for lining up reproduction and trimming machines. + +You can save yourself the (considerable) trouble of programming these +marks for yourself by using the package \Package{crop}, which has +facilities to satisfy any conceivable production house. Users of the +\Class{memoir} class don't need the package, since \Class{memoir} has +its own facilities for programming crop marks. +\begin{ctanrefs} +\item[crop.sty]\CTANref{crop} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-watermark]{`Watermarks' on every page} + +It's often useful to place some text (such as `DRAFT') in the +background of every page of a document. For \LaTeX{} users, this can +be achieved with the \Package{draftcopy} package. This can deal with +many types of \acro{DVI} processors (in the same way that the graphics +package does) and knows translations for the word `DRAFT' into a wide +range of languages (though you can choose your own word, too). +Unfortunately, however, the package relies on \PS{} specials, and will +therefore fail if you are viewing your document with \ProgName{xdvi}, +and won't even compile if you're using \PDFLaTeX{}. (\PDFLaTeX{} +users need one of the other solutions below.) + +The \Package{wallpaper} package builds on \Package{eso-pic} (see +below). Apart from the single-image backdrops described above +(``wallpapers'', of course, to this package), the package provides +facilities for tiling images. All its commands come in pairs: one for +``general'' use, and one applying to the current page only. + +The \Package{draftwatermark} package uses the same author's +\Package{everypage} package to provide a simple interface for adding +textual (`DRAFT'-like) watermarks. + +More elaborate watermarks may be achieved using the \Package{eso-pic} +package, which in turn uses the package \Package{everyshi}, or by +using \Package{everypage}. \Package{Eso-pic} attaches a +\environment{picture} environment to every page as it is shipped out; +you can put things into that environment. The package provides +commands for placing things at certain useful points (like ``text +upper left'' or ``text centre'') in the picture, but you're at liberty +to do what you like. + +\Package{Everypage} allows you to add ``something'' to every page, or +to a particular page; you therefore need to construct your own +apparatus for anything complicated. +\begin{ctanrefs} +\item[draftcopy.sty]\CTANref{draftcopy} +\item[draftwatermark.sty]\CTANref{draftwatermark} +\item[eso-pic.sty]\CTANref{eso-pic} +\item[everypage.sty]\CTANref{everypage} +\item[everyshi.sty]Distributed as part of \CTANref{ms} +\item[wallpaper.sty]\CTANref{wallpaper} +\end{ctanrefs} + +\Question[Q-landscape]{Typesetting things in landscape orientation} + +It's often necessary to typeset part of a document in landscape +orientation; to achieve this, one needs not only to change the page +dimensions, but also to instruct the output device to print the +strange page differently. + +There are two ``ordinary'' mechanisms for doing two slight variations +of landscape typesetting: +\begin{itemize} +\item If you have a single floating object that is wider than it is + deep, and will only fit on the page in landscape orientation, use + the \Package{rotating} package; this defines + \environment{sidewaysfigure} and \environment{sidewaystable} + environments which create floats that occupy a whole page. + + Note that \Package{rotating} has problems in a document that also + loads the \Package{float} package, which recommended in other + answers in these \acro{FAQ}s, for example that on + \Qref*{float placement}{Q-floats}. The \Package{rotfloat} package + loads \Package{rotating} for you, and smooths the interaction with + \Package{float}. +\item If you have a long sequence of things that need to be typeset in + landscape (perhaps a code listing, a wide \environment{tabbing} + environment, or a huge table typeset using \Package{longtable} or + \Package{supertabular}), use the \Package{lscape} package (or + \Package{pdflscape} if you're generating \acro{PDF} output, whether + using \PDFLaTeX{} or \ProgName{dvips} and generating \acro{PDF} from + that). Both packages define an environment \environment{landscape}, which + clears the current page and restarts typesetting in landscape + orientation (and clears the page at the end of the environment + before returning to portrait orientation). +\end{itemize} +No currently available package makes direct provision for typesetting +in both portrait and landscape orientation on the same page (it's not +the sort of thing that \TeX{} is well set-up to do). If such +behaviour was an absolute necessity, one might use the techniques +described in +% beware line-wrap +\Qref[question]{"flowing text around figures"}{Q-textflow}, and would +rotate the landscape portion using the rotation facilities of the +\Package{graphics} package. (Returning from landscape to portrait +orientation would be somewhat easier: the portrait part of the page +would be a bottom float at the end of the landscape section, with its +content rotated.) + +To set an entire document in landscape orientation, one might use +\Package{lscape} around the whole document. A better option is the +\pkgoption{landscape} option of the \Package{geometry} package; if you +also give it \pkgoption{dvips} or \pkgoption{pdftex} option, +\Package{geometry} also emits the rotation instructions to cause the +output to be properly oriented. The \Class{memoir} class has the same +facilities, in this respect, as does \Package{geometry}. + +A word of warning: most current \TeX{} previewers do not honour +rotation requests in \acro{DVI} files. +%% (the exception is +%% (the exceptions are the +%% \begin{htmlversion} +%% (\Qref{commercial}{Q-commercial}) \YandY{} previewer +%% \ProgName{dviwindo}, +%% \end{htmlversion} +%% \htmlignore +%% (commercial) \YandY{} previewer \ProgName{dviwindo} +%% (\Qref{}{Q-commercial}), +%% \endhtmlignore +%% and +%% the fp\TeX{} previewer Win\acro{DVI}). If your previewer is not +%% capable of rotation, +Your best bet is to convert your output to \PS{} or to \acro{PDF}, and +to view these `final' forms with an appropriate viewer. +\begin{ctanrefs} +\item[geometry.sty]\CTANref{geometry} +\item[graphics.sty]Distributed as part of \CTANref{graphics} +\item[longtable.sty]Distributed as part of \CTANref{2etools} +\item[lscape.sty]Distributed as part of \CTANref{graphics} +\item[memoir.cls]\CTANref{memoir} +\item[pdflscape.sty]Distributed with Heiko Oberdiek's packages + \CTANref{oberdiek} +\item[rotating.sty]\CTANref{rotating} +\item[rotfloat.sty]\CTANref{rotfloat} +\item[supertabular.sty]\CTANref{supertabular} +\end{ctanrefs} + +\Question[Q-abspos]{Putting things at fixed positions on the page} + +\TeX{}'s model of the world is (broadly speaking) that the author +writes text, and \TeX{} and its macros decide how it all fits on the +page. This is not good news for the author who has, from whatever +source, a requirement that certain things go in exactly the right +place on the page. + +There \emph{are} places on the page, from which things may be hung, +and two \LaTeX{} packages allow you position things relative to such +points, thus providing a means of absolute positioning. + +The \Package{textpos} package aids the construction of pages from +``blobs'', dotted around over the page (as in a poster); you give it +the location, and it places your typeset box accordingly. + +The \Package{eso-pic} defines a ``shipout picture'' that covers the +page. The user may add \environment{picture}-mode commands to this +picture, which of course can include box placements as well as the +other rather stilted commands of \environment{picture}-mode. +(\Package{Eso-pic} requires the services of \Package{everyshi}, which +must therefore also be available.) +% +% Fortunately, in the \LaTeX{} world at least, there \emph{is} a fixed +% point on every page, to whit the page header. The package +% \Package{textpos} latches bits of typesetting to locations you +% specify, by fixing them to the page header, and thereby solves the +% problem. +\begin{ctanrefs} +\item[eso-pic.sty]\CTANref{eso-pic} +\item[everyshi.sty]Distributed as part of \CTANref{ms} +\item[textpos.sty]\CTANref{textpos} +\end{ctanrefs} + +\Question[Q-nopagebrk]{Preventing page breaks between lines} + +One commonly requires that a block of typeset material be kept on the +same page; it turns out to be surprisingly tricky to arrange this. + +\LaTeX{} provides a \environment{samepage} environment which claims it +does this sort of thing for you. It proceeds by setting infinite +penalties for all sorts of page-break situations; but in many +situations where you want to prevent a page break, +\environment{samepage} doesn't help. If you're trying to keep running +text together, you need to end the paragraph inside the environment +(see \Qref[question]{preserving paragraph parameters}{Q-paraparam}). +Also, if the things you are trying to keep together insert their own +pagebreak hints, \environment{samepage} has no power over them: a good +example is list items~--- they suggest page breaks between them. Even +if \environment{samepage} \emph{does} work, it's likely to leave stuff +jutting out at the bottom of the page. + +A convenient trick is to set all the relevant stuff in a \csx{parbox} +(or a \environment{minipage} if it contains things like verbatim text +that may not be in the argument of a \csx{parbox}). The resulting box +certainly \emph{won't} break between pages, but that's not to say that +it will actually do what you want it to do: again, the box may be left +jutting out at the bottom of the page. + +Why do neither of these obvious things work? Because \TeX{} can't +really distinguish between infinitely awful things. +\environment{Samepage} will make any possible break point ``infinitely +bad'' and boxes don't even offer the option of breaks, but if the +alternative is the leave an infinitely bad few centimetres of blank +paper at the bottom of the page, \TeX{} will take the line of least +resistance and do nothing. + +This problem still arises even if you have \csx{raggedbottom} in +effect: \TeX{} doesn't notice the value of \emph{that} until it starts +actually shipping a page out. One approach is to set: +\begin{quote} +\begin{verbatim} +\raggedbottom +\addtolength{\topskip}{0pt plus 10pt} +\end{verbatim} +\end{quote} +The \texttt{10pt} offers a hint to the output routine that the column is +stretchable; this will cause \TeX{} to be more tolerant of the need to +stretch while building the page. If you're doing this as a temporary +measure, cancel the change to \csx{topskip} by: +\begin{quote} +\begin{verbatim} +\addtolength{\topskip}{0pt plus-10pt} +\end{verbatim} +\end{quote} +as well as resetting \csx{flushbottom}. (Note that the \texttt{10pt} never +actually shows up, because it is overwhelmed when the page is shipped +out by the stretchability introduced by \csx{raggedbottom}; however, it +could well have an effect if \csx{flushbottom} was in effect.) + +An alternative (which derives from a suggestion by Knuth in the +\TeX{}book) is the package \Package{needspace} or the \Class{memoir} class, +which both define a command \csx{needspace} whose argument tells it +what space is needed. If the space isn't available, the current page +is cleared, and the matter that needs to be kept together will be +inserted on the new page. For example, if 4~lines of text need to be +kept together, the sequence +\begin{quote} +\begin{verbatim} +\par +\needspace{4\baselineskip} +% the stuff that must stay together +<text generating lines 1-4> +% now stuff we don't mind about +\end{verbatim} +\end{quote} +Yet another trick by Knuth is useful if you have a sequence of small +blocks of text that need, individually, to be kept on their own page. +Insert the command \csx{filbreak} before each small block, and the +effect is achieved. The technique can be used in the case of +sequences of \LaTeX{}-style sections, by incorporating \csx{filbreak} +into the definition of a command (as in % beware line break +\Qref[question]{patching commands}{Q-patch}). A simple and effective +patch would be: +\begin{quote} +\begin{verbatim} +\let\oldsubsubsection=\subsubsection +\renewcommand{\subsubsection}{% + \filbreak + \oldsubsubsection +} +\end{verbatim} +\end{quote} +While the trick works for consecutive sequences of blocks, it's +slightly tricky to get out of such sequences unless the sequence is +interrupted by a forced page break (such as \csx{clearpage}, which may +be introduced by a \csx{chapter} command, or the end of the document). +If the sequence is not interrupted, the last block is likely to be +forced onto a new page, regardless of whether it actually needs it. + +If one is willing to accept that not everything can be accomplished +totally automatically, the way to go is to typeset the document and to +check for things that have the potential to give trouble. In such a +scenario (which has Knuth's authority behind it, if one is to believe +the rather few words he says on the subject in the \TeX{}book) one can +decide, case by case, how to deal with problems at the last +proof-reading stage. The alternatives are to insert \csx{clearpage} +commands as necessary, or to use \csx{enlargethispage}. Supposing you +have a line or two that stray: issue the command +\cmdinvoke{enlargethispage}{2\csx{baselineskip}} and two lines are +added to the page you're typesetting. It depends on the document +whether this looks impossibly awful or entirely acceptable, but the +command remains a useful item in the armoury. +\begin{ctanrefs} +\item[memoir.cls]\CTANref{memoir} +\item[needspace.sty]\CTANref{needspace} +\end{ctanrefs} + +\Question[Q-parallel]{Parallel setting of text} + +It's commonly necessary to present text in two languages `together' on a +page, or on a two-page spread. For this to be satisfactory, one usually +needs some sort of alignment between the two texts. + +The \Package{parallel} package satisfies the need, permitting +typesetting in two columns (not necessarily of the same width) on one +page, or on the two opposing pages of a two-page spread. Use can be +as simple as +\begin{quote} +\begin{verbatim} +\usepackage{parallel} +... +\begin{Parallel}{<left-width>}{<right-width} + \ParallelLText{left-text} + \ParallelRText{right-text} + \ParallelPar + ... +\end{Parallel} +\end{verbatim} +\end{quote} +\Package{Parallel} can get terribly confused with colour changes, in +\PDFTeX{}; the indefatigable Heiko Oberdiek has a patch for this +issue~--- the \Package{pdfcolparallel}, which maintains separate +colour stacks for the columns. + +The \Package{parcolumns} package can (in principle) deal with any +number of columns: the documentation shows its use with three +columns. Usage is rather similar to that of \Package{parallel}, +though there is of course a ``number of columns to specify'': +\begin{quote} +\begin{verbatim} +\usepackage{parcolumns} +... +\begin{parcolumns}[<options>]{3} + \colchunk{<Column 1 text>} + \colchunk{<Column 2 text>} + \colchunk{<Column 3 text>} + \colplacechunks + ... +\end{parcolumns} +\end{verbatim} +\end{quote} +The \meta{options} can specify the widths of the columns, whether to +place rules between the columns, whether to set the columns sloppy, etc. + +The \Package{ledpar} package is distributed with (and integrated with) +the \Qref{\Package{ledmac} package}{Q-linenos}. It provides parallel +setting carefully integrated with the needs of a scholarly text, +permitting translation, or notes, or both, to be set in parallel with +the `base' text of the document. +\begin{ctanrefs} +\item[ledpar.sty]Distributed with \CTANref{ledmac} +\item[parallel.sty]\CTANref{parallel} +\item[parcolumns.sty]Distributed as part of \CTANref{sauerj} +\item[pdfcolparallel.sty]Distributed as part of \CTANref{oberdiek} +\end{ctanrefs} + +\Question[Q-epigraph]{Typesetting epigraphs} + +Epigraphs are those neat quotations that authors put at the start of +chapters (or even at the end of chapters: Knuth puts things at the +ends of chapters of the \TeX{}book). + +Typesetting them is a bit of a fiddle, but not impossible to do for +yourself. Fortunately, there are two packages that do the job, to +some extent; there are also facilities in the two ``big'' classes +(\Class{memoir} and \Class{koma-script}. + +The \Package{epigraph} package defines an \csx{epigraph} command, for +creating a single +epigraph (as at the top of a chapter): +\begin{quote} +\begin{verbatim} +\chapter{The Social Life of Rabbits} +\epigraph{Oh! My ears and whiskers!}% + {Lewis Carroll} +\end{verbatim} +\end{quote} +and an epigraphs environment, for entering more than one epigraph +consecutively, in a sort of list introduced by \csx{qitem} commands: +\begin{quote} +\begin{verbatim} +\begin{epigraphs} +\qitem{What I tell you three times is true}% + {Lewis Carroll} +\qitem{Oh listen do, I'm telling you!}% + {A.A. Milne} +\end{epigraphs} +\end{verbatim} +\end{quote} +The \csx{epigraphhead} command enables you to place your epigraph +\emph{above} a chapter header: +\begin{quote} +\begin{verbatim} +\setlength{\unitlength}{1pt} +... +\chapter{The Social Life of Rabbits} +\epigraphhead[<distance>]{% + \epigraph{Oh! My ears and whiskers!}% + {Lewis Carroll}% +} +\end{verbatim} +\end{quote} +The \meta{distance} says how far above the chapter heading the +epigraph is to go; it's expressed in terms of the \csx{unitlength} +that's used in the \environment{picture} environment; the package's +author recommends \texttt{70pt}. + +The package also offers various tricks for adjusting the layout of +chapter header (necessary if you've found a hugely long quotation for +an \csx{epigraphhead}), for patching the bibliography, for patching +\csx{part} pages, and so on. (Some of these suggested patches lead you +through writing your own package\dots{}) + +The \Package{quotchap} package redefines chapter headings (in a +moderately striking way), and provides an environment +\environment{savequotes} in which you can provide one (or more) +quotations to use as epigraphs. The facilities seem not as flexible +as those of \Package{epigraph}, but it's probably easier to use. + +The \Class{memoir} class offers all the facilities of the +\Package{epigraph} package. The \Class{Koma-script} classes have +commands \csx{setchapterpreamble} and \csx{dictum} to provide these +facilities. +\begin{ctanrefs} +\item[epigraph.sty]\CTANref{epigraph} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[quotchap.sty]\CTANref{quotchap} +\end{ctanrefs} + +% \Question[Q-outszwrng]{\AllTeX{} \acro{PDF} output prints at wrong size} + +% Having got everything \emph{else} right, you should be aware that the +% problem may have nothing to do with \AllTeX{} and everything to do +% with the program you use for printing. A regular cause for such +% problems lies with Acrobat Reader, which by default enables its option +% to scale pages to fit on the printable area of the paper. Since a +% printer can rarely print right to the edge, this means that pdf-files +% will be shrunk by some (small) factor (even if the pdf-file is +% formatted for A4, and your paper size is set to A4 as well). + +% Correcting this silliness is not very hard, but the exact details +% depend on the version of Acrobat Reader (or "Adobe Reader" from +% version 6.0 onwards) you have installed: +% \begin{itemize} +% \item Mac OS X, Adobe Reader 6:\\ +% in the print dialogue, on the ``copies \& pages'' pane, you'll find a +% popup menu titled ``Page Scaling''. Make sure that the menu reads +% ``None''. +% \item Windows, Adobe Reader 6:\\ +% in the print dialogue, select ``None'' from the drop-down list +% ``Page Scaling''. +% \item Windows, Linux Acrobat (Reader) 5.0:\\ +% In the print dialog, make sure the ``Shrink oversized pages to fit'' +% checkbox is unchecked. It may also be useful to uncheck the +% ``Expand small pages to fit paper size'' checkbox as well. +%\end{itemize} + +\subsection{Spacing of characters and lines} + +\Question[Q-linespace]{Double-spaced documents in \LaTeX{}} + +A quick and easy way of getting inter-line space for copy-editing is +to change \csx{baselinestretch}~--- \cmdinvoke{linespread}{1.2} (or, +equivalently \cmdinvoke{renewcommand}{\csx{baselinestretch}}{1.2}) may +be adequate. Note that \csx{baselinestretch} changes don't take +effect until you select a new font, so make the change in the preamble +before any font is selected. Don't try changing \csx{baselineskip}: +its value is reset at any size-changing command so that results will +be inconsistent. + +For preference (and certainly for a production document, such as a +dissertation or an article submission), use a line-spacing package. +The only one currently supported is \Package{setspace} (do \emph{not} +be tempted by \Package{doublespace}~--- its performance under current +\LaTeX{} is at best problematical). \Package{Setspace} switches off +double-spacing at places where even the most die-hard official would +doubt its utility (footnotes, figure captions, and so on); it's very +difficult to do this consistently if you're manipulating +\csx{baselinestretch} yourself. + +Of course, the real solution (other than for private copy editing) is +\emph{not} to use double-spacing at all. Universities, in particular, +have no excuse for specifying double-spacing in submitted +dissertations: \LaTeX{} is a typesetting system, not a +typewriter-substitute, and can (properly used) make single-spaced text +even more easily readable than double-spaced typewritten text. If you +have any influence on your university's system (for example, through +your dissertation supervisor), it may be worth attempting to get the +rules changed (at least to permit a ``well-designed book'' format). + +Double-spaced submissions are also commonly required when submitting +papers to conferences or journals. Fortunately (judging by the +questions from users in this author's department), this demand is +becoming less common. + +Documentation of \Package{setspace} appears as \TeX{} comments in the +package file itself. +\begin{ctanrefs} +\item[setspace.sty]\CTANref{setspace} +\end{ctanrefs} + +\Question[Q-letterspace]{Changing the space between letters} + +A common technique in advertising copy (and other text whose actual +content need not actually be \emph{read}) is to alter the space +between the letters (otherwise known as the tracking). As a general +rule, this is a very bad idea: it detracts from legibility, which is +contrary to the principles of typesetting (any respectable font you +might be using should already have optimum tracking built into it). + +The great type designer, Eric Gill, is credited with saying ``he who +would letterspace lower-case text, would steal sheep''. (The +attribution is probably apocryphal: others are also credited with the +remark. Stealing sheep was, in the 19th century, a capital offence in +Britain.) As the remark suggests, though, letterspacing of upper-case +text is less awful a crime; the technique used also to be used for +emphasis of text set in Fraktur (or similar) fonts. + +Straightforward macros (usable, in principle, with any \TeX{} macro +package) may be found in \Package{letterspacing} (which is the name of +the \extension{tex} file). + +%%% the package has a serious bug in it, so suppress mention pro tem +%The \Package{tracking} package has similar facilities. + +A more comprehensive solution is to be found in the \Package{soul} +package (which is optimised for use with \LaTeX{}, but also works with +\plaintex{}). Soul also permits hyphenation of letterspaced text; +Gill's view of such an activity is not (even apocryphally) recorded. +(Spacing-out forms part of the name of \Package{soul}; the other half +is described in \Qref[question]{another question}{Q-underline}.) + +Possibly the `ultimate' in this field is the \Package{microtype}, +which uses the micro-typography capabilities of current \PDFTeX{} to +provide a \csx{textls} command, which operates according to parameters +declared in a \csx{SetTracking} command. \Package{Microtype}'s +`tracking' facility expands the natural spacing font itself, rather +than inserting space between characters. Ordinarily, letter-spacing +will destroy ligatures; however, this is \emph{wrong} if the font is +of a fraktur style, and the package provides a means of protecting the +ligatures in a letter-spaced text. +\begin{ctanrefs} +\item[letterspacing.tex]\CTANref{letterspacing} +\item[microtype.sty]\CTANref{microtype} +\item[soul.sty]\CTANref{soul} +%\item[tracking.sty]\CTANref{tracking} +\end{ctanrefs} + +\Question[Q-ragright]{Setting text ragged right} + +The trick with typesetting ragged right is to be sure you've told the +\TeX{} engine ``make this paragraph ragged, but never \emph{too} +ragged''. The \LaTeX{} \csx{raggedright} command (and the +corresponding \environment{flushleft} environment) has a tendency to +miss the ``never'' part, and will often create ridiculously short +lines, for some minor benefit later in the paragraph. The +\plaintex{} version of the command doesn't suffer this failing, but +is rather conservative: it is loath to create too large a gap at the +end of the line, but in some circumstances~--- such as where +\Qref*{hyphenation is suppressed}{Q-hyphoff}~--- painfully large gaps +may sometimes be required. + +Martin Schr\"oder's \Package{ragged2e} package offers the best of both +worlds: it provides raggedness which is built on the \plaintex{} +model, but which is easily configurable. It defines easily-remembered +command (e.g., \csx{RaggedRight}) and environment (e.g., +\environment{FlushLeft}) names that are simply capitalised +transformations of the \LaTeX{} kernel originals. The documentation +discusses the issues and explains the significance of the various +parameters of \Package{ragged2e}'s operation. +\begin{ctanrefs} +\item[ragged2e.sty]Distributed as part of \CTANref{ms} +\end{ctanrefs} + +\Question[Q-flushboth]{Cancelling \csx{ragged} commands} + +\LaTeX{} provides commands \csx{raggedright} and \csx{raggedleft}, but +none to cancel their effect. The \csx{centering} command is +implemented in the same way as the \csx{ragged*} commands, and suffers +in the same way. + +The following code (to be inserted in a package of your own, or as +\nothtml{internal \LaTeX{} code~---}% beware line break +\Qref{internal \LaTeX{} code}{Q-atsigns}) defines a command that +restores flush justification at both margins: +\begin{verbatim} +\def\flushboth{% + \let\\\@normalcr + \@rightskip\z@skip \rightskip\@rightskip + \leftskip\z@skip + \parindent 1.5em\relax} +\end{verbatim} +There's a problem with the setting of \csx{parindent} in the code: it's +necessary because both the \csx{ragged} commands set \csx{parindent} to +zero, but the setting isn't a constant of nature: documents using a +standard \LaTeX{} class with \pkgoption{twocolumn} option will have +\texttt{1.0em} by default, and there's no knowing what you (or some +other class) will have done. + +Any but a really old copy of Martin Schr\"oder's \Package{ragged2e} +package has a \csx{justifying} command to match its % ! line break +\Qref*{versions of the \LaTeX{} `ragged' commands}{Q-ragright}. The +package also provides a \environment{justify} environment, which +permits areas of justified text in a larger area which is ragged. +\begin{ctanrefs} +\item[ragged2e.sty]Distributed as part of \CTANref{ms} +\end{ctanrefs} +% this package hasn't materialised, for some reason i don't now +% remember... +%% Donald Arseneau's \Package{flushboth} package provides this code, and +%% preserves a sensible value for \csx{parindent} (at begin document). +%% This still doesn't protect it against any change you might make to +%% \csx{parindent} within the body of your document. +%% \begin{ctanrefs} +%% \item[flushboth.sty]\CTANref{flushboth} +%% \end{ctanrefs} + +\subsection{Typesetting specialities} + +\Question[Q-verbfile]{Including a file verbatim in \LaTeX{}} + +A good way is to use Rainer Sch\"opf's \Package{verbatim} package, +which provides a command \csx{verbatiminput} that takes a file name as +argument: +\begin{quote} +\begin{verbatim} +\usepackage{verbatim} +... +\verbatiminput{verb.txt} +\end{verbatim} +\end{quote} +Another way is to use the \environment{alltt} environment, which +requires the \Package{alltt} package. The environment interprets its +contents `mostly' verbatim, but executes any \AllTeX{} commands it +finds: +\begin{quote} +\begin{verbatim} +\usepackage{alltt} +... +\begin{alltt} +\input{verb.txt} +\end{alltt} +\end{verbatim} +\end{quote} +of course, this is little use for inputting \AllTeX{} source +code\dots{} + +The \Package{moreverb} package extends the \Package{verbatim} package, +providing a \environment{listing} environment and a \csx{listinginput} +command, which line-number the text of the file. The package also has +a \csx{verbatimtabinput} command, that honours \acro{TAB} characters in +the input (the package's \environment{listing} environment and the +\csx{listinginput} command also both honour \acro{TAB}). + +The \Package{sverb} package provides verbatim input (without recourse +to the facilities of the \Package{verbatim} package): +\begin{quote} +\begin{verbatim} +\usepackage{sverb} +... +\verbinput{verb.txt} +\end{verbatim} +\end{quote} + +The \Package{fancyvrb} package offers configurable implementations of +everything \Package{verbatim}, \Package{sverb} and \Package{moreverb} +have, and more besides. It is nowadays the package of choice for the +discerning typesetter of verbatim text, but its wealth of facilities +makes it a complex beast and study of the documentation is strongly +advised. + +The \Class{memoir} class includes the relevant functionality of the +\Package{verbatim} and \Package{moreverb} packages. +\begin{ctanrefs} +\item[alltt.sty]Part of the \LaTeX{} distribution. +\item[fancyvrb.sty]\CTANref{fancyvrb} +\item[memoir.cls]\CTANref{memoir} +\item[moreverb.sty]\CTANref{moreverb} +\item[sverb.sty]Distributed as part of \CTANref{mdwtools} +\item[verbatim.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-linenos]{Including line numbers in typeset output} + +For general numbering of lines, there are two packages for use with +\LaTeX{}, \Package{lineno} (which permits labels attached to +individual lines of typeset output) and \Package{numline}. +(\Package{Numline} is considered obsolete, but remains available from +the archive.) + +Both of these packages play fast and loose with the \LaTeX{} output +routine, which can cause problems: the user should beware\dots{} + +If the requirement is for numbering verbatim text, \Package{moreverb}, +or \Package{fancyvrb} (see % ! line break +\Qref[question]{including files verbatim}{Q-verbfile}) may be used. +Class \Class{memoir} also provides the necessary facilities. + +One common use of line numbers is in critical editions of texts, and +for this the \Package{edmac} package offers comprehensive support; +\Package{ledmac} is a \LaTeX{} port of \Package{edmac}. + +The \Package{vruler} package sidesteps many of the problems associated +with line-numbering, by offering (as its name suggests) a rule that +numbers positions on the page. The effect is good, applied to +even-looking text, but is poor in texts that involve breaks such as +interpolated mathematics or figures. Documentation of the package, in +the package itself, is pretty tough going, though there is an example +(also inside the package file). +\begin{ctanrefs} +\item[edmac]\CTANref{edmac} +\item[fancyvrb.sty]\CTANref{fancyvrb} +\item[ledmac.sty]\CTANref{ledmac} +\item[lineno.sty]\CTANref{lineno} +\item[memoir.cls]\CTANref{memoir} +\item[moreverb.sty]\CTANref{moreverb} +\item[numline.sty]\CTANref{numline} +\item[vruler.sty]\CTANref{vruler} +\end{ctanrefs} + +\Question[Q-codelist]{Code listings in \LaTeX{}} + +`Pretty' code listings are sometimes considered worthwhile by the +``ordinary'' programmer, but they have a serious place in +the typesetting of dissertations by computer science and other +students who are expected to write programs. Simple verbatim listings +of programs are commonly useful, as well. + +\begin{wideversion} % really hyper + \Qref{Verbatim listings}{Q-verbfile} are dealt with elsewhere, +\end{wideversion} +\begin{narrowversion} + Verbatim listings are dealt with elsewhere (\Qref{}{Q-verbfile}), +\end{narrowversion} +as is the problem of % ! line break +\Qref*{typesetting algorithm specifications}{Q-algorithms}. + +The \Package{listings} package is widely regarded as the best bet for +formatted output (it is capable of parsing program source, within the +package itself), but there are several well-established packages that +rely on a pre-compiler of some sort. You may use \Package{listings} +to typeset snippets that you include within your source: +\begin{quote} +\begin{verbatim} +\usepackage{listings} +\lstset{language=C} +... +\begin{document} +\begin{lstlisting} +#include <stdio.h> + +int main(int argc, char ** argv) +{ + printf("Hello world!\n"); + return 0; +} +\end{lstlisting} +\end{document} +\end{verbatim} +\end{quote} +or you can have it typeset whole files: +\begin{quote} +\begin{verbatim} +\usepackage{listings} +\lstset{language=C} +... +\begin{document} +\lstinputlisting{main.c} +\end{document} +\end{verbatim} +\end{quote} +These very simple examples may be decorated in a huge variety of ways, +and of course there are other languages in the package's vocabulary +than just \ProgName{C}\dots{} + +Most people, advising others on \AllTeX{} lists, seem to regard +\Package{listings} as the be-all and end-all on this topic. But there +\emph{are} alternatives, which may be worth considering, in some +situations. + +\ProgName{Highlight} is attractive if you need more than one output +format for your program: as well as \AllTeX{} output, +\ProgName{highlight} will produce (\acro{X})\acro{HTML}, \acro{RTF} +and \acro{XSL}-\acro{FO} representations of your program listing. +Documentation is available on the % ! line break +\href{http://www.andre-simon.de/}{\ProgName{highlight} project site}. + +The \ProgName{lgrind} system is another well-established pre-compiler, +with all the facilities one might need and a wide repertoire of +languages; it is derived from the very long-established +\ProgName{tgrind}, whose output is based on \plaintex{} + +The \ProgName{tiny_c2l} system is more recent: users are encouraged to +generate their own driver files for languages it doesn't already deal +with. + +The \ProgName{C++2LaTeX} system comes with strong recommendations for +use with \acro{C} and \acro{C}++. + +An extremely simple system is \ProgName{c2latex}, for which you write +\LaTeX{} source in your \acro{C} program comments. The program then +converts your program into a \LaTeX{} document for processing. The +program (implicitly) claims to be ``self-documenting''. +\begin{ctanrefs} +\item[c2latex]\CTANref{c2latex} +\item[C++2LaTeX]\CTANref{c++2latex} +\item[highlight]\CTANref{highlight} +\item[lgrind]\CTANref{lgrind} +\item[listings.sty]\CTANref{listings} +\item[tgrind]\CTANref{tgrind} +\item[tiny\_c2l]\CTANref{tiny_c2l} +\end{ctanrefs} + +\Question[Q-algorithms]{Typesetting pseudocode in \LaTeX{}} + +There is no consensus on the `right' way to typeset pseudocode. +Consequently, there are a variety of \LaTeX{} packages to choose from +for producing \ae{}sthetically pleasing pseudocode listings. + +Pseudocode differs from actual program listings in that it lacks +strict syntax and semantics. Also, because pseudocode is supposed to +be a clear expression of an algorithm it may need to incorporate +mathematical notation, figures, tables, and other \LaTeX{} features +that do not appear in conventional programming languages. +\begin{wideversion} % hyper? + \Qref{Typesetting program listings}{Q-codelist} is described + elsewhere. +\end{wideversion} +\begin{narrowversion} % non-hyper + Typesetting program listings is described elsewhere + (\Qref{}{Q-codelist}). +\end{narrowversion} + +You can certainly create your own environment for typesetting +pseudocode using, for example, the \environment{tabbing} or +\environment{list} environments~--- it's not difficult, but it may +prove boring. So it's worth trying the following packages, all +designed specifically for typesetting pseudocode. + +The \Package{algorithms} bundle (which contains packages +\Package{algorithm} and \Package{algorithmic}, both of which are +needed for ordinary use) has a simple interface and produces fairly +nice output. It provides primitives for statements, which can contain +arbitrary \LaTeX{} commands, comments, and a set of iterative and +conditional constructs. These primitives can easily be redefined to +produce different text in the output. However, there is no support +for adding new primitives. Typesetting the pseudocode itself is +performed in \Package{algorithmic}; the \Package{algorithms} package +uses the facilities of the \Package{float} package to number +algorithms sequentially, enable algorithms to float like figures or +tables, and support including a List of Algorithms in a document's +front matter. + +Packages in the \Package{algorithmicx} bundle are similar both in +concept and output form to \Package{algorithmic} but additionally +provide support for adding new keywords and altering the formatting. +It provides the \Package{algpseudocode} package which is (almost) a +drop-in replacement for \Package{algorithmic}. Another package in the +bundle, \Package{algpascal}, uses Pascal-like keywords, indents +differently from \Package{algpseudocode}, and puts command arguments +in maths mode instead of text mode. There is no floating environment +but \Package{algorithmicx}, like \Package{algorithmic}, is compatible +with the \Package{algorithm} package. + +The \Package{alg} package, like \Package{algorithms}, offers a +floating algorithm environment with all of the ensuing niceties. +\Package{alg}, however, can caption its floats in a variety of +(natural) languages. In addition, \Package{alg} unlike +\Package{algorithms}, makes it easy to add new constructs. + +The \Package{newalg} package has a somewhat similar interface to +\Package{algorithms}, but its output is designed to mimic the rather +pleasant typesetting used in the book ``\emph{Introduction to Algorithms}'' +by Corman, Leiserson, Rivest and Stein. Unfortunately, +\Package{newalg} does not support a floating environment or any +customisation of the output. + +``\emph{Bona fide}'' use of the style of ``Introduction to +Algorithms'' may be achieved with Cormen's own \Package{clrscode}: +this is the package as used in the second edition of the book. + +Similarly, the style of % ! line break +``\emph{Combinatorial Algorithms: Generation, Enumeration and Search}'' +is supported by the \Package{pseudocode} package, written by the +authors of the book. It has the common `Pascal-like' style, and has +some interesting constructs for what one thinks of as Pascal blocks. + +The \Package{algorithm2e} is of very long standing, and is widely used +and recommended. It loads the \Package{float} package to provide the +option of floating algorithm descriptions, but you can always use the +``\texttt{H}'' option of \Package{float} to have the algorithm appear +``where you write it''. + +The usage of the \Package{program} package is a little different from +that of the other packages. It typesets programs in maths mode +instead of text mode; and linebreaks are significant. +\Package{program} lacks a floating environment but does number +algorithms like \Package{alg} and \Package{algorithms}. Customisation +and extension are not supported. Documentation of the +\Package{program} package (such as it is) appears in a file +\File{program.msg} in the distribution. + +None of the above are perfect. The factors that should influence your +choice of package include the output style you prefer, how much you +need to extend or modify the set of keywords, and whether you require +algorithms to float like figures and tables. +%% +%% Documentation availability: +%% \begin{description} +%% \item[\Package{algorithms} bundle] is provided in \File{algorithms.ps} +%% (also available as LaTeX{} source). The documentation speaks as if +%% the two packages of the bundle were indeed one, called +%% \Package{algorithms}. +%% \item[\Package{program} package] (such as it is) appears in a file +%% \File{program.msg}. +%% \item[\Package{clrscode} package] is to be found in +%% \File{clrscode.pdf} in the distribution. +%% \item[\Package{algorithm2e} package] is to be found in +%% \File{algorithm2e.tex} in the distribution (it needs the package +%% itself when you process it). +%% \end{description} +\begin{ctanrefs} +\item[algorithm2e.sty]\CTANref{algorithm2e} +\item[algorithmicx\nothtml{\rmfamily} bundle]\CTANref{algorithmicx} +\item[algorithms\nothtml{\rmfamily} bundle]\CTANref{algorithms} +\item[alg.sty]\CTANref{alg} +\item[clrscode.sty]\CTANref{clrscode} +\item[float.sty]\CTANref{float} +\item[newalg.sty]\CTANref{newalg} +\item[program.sty]\CTANref{program} +\item[pseudocode.sty]\CTANref{pseudocode} +\end{ctanrefs} + +\Question[Q-makeindex]{Generating an index in \AllTeX{}} + +Making an index is not trivial; what to index, and how to index it, is +difficult to decide, and uniform implementation is difficult to +achieve. You will need to mark all items to be indexed in your text +(typically with \csx{index} commands). + +It is not practical to sort a large index within \TeX{}, so a +post-processing program is used to sort the output of one \TeX{} run, +to be included into the document at the next run. + +The following programs are available: +\begin{description} +\item[makeindex] Comes with most distributions~--- a good workhorse, + but is not well-arranged to deal with other sort orders than the + canonical \acro{ASCII} ordering. + + The \Package{makeindex} documentation is a good source of + information on how to create your own index. \Package{Makeindex} can + be used with some \TeX{} + macro packages other than \LaTeX{}, such as \nothtml{\Eplain\ (}% + \Qref{Eplain}{Q-eplain}\nothtml{)}, and \TeX{} (whose macros can + be used independently with \plaintex{}). +\item[idxtex] for \LaTeX{} under \acro{VMS}, which comes with a + glossary-maker called \Package{glotex}. +\item[texindex] A witty little shell/\ProgName{sed}-script-based + utility for \LaTeX{} under Unix. + + The \Qref*{Texinfo}{Q-texinfo} system also uses a program + \ProgName{texindex}, whose source is to be found in the + \ProgName{texinfo} distribution. The \Package{ltxindex} package + provides macros to allow \LaTeX{} users to use \emph{this} + \ProgName{texindex}. +\item[xindy] arose from frustration at the difficulty of making a + multi-language version of \ProgName{makeindex}. It is designed to + be a successor to \ProgName{makeindex}, by a team that included the + then-current maintainer of \ProgName{makeindex}. It successfully + addresses many of \ProgName{makeindex}'s shortcomings, including + difficulties with collation order in different languages, and it is + highly flexible. Sadly, its take-up is proving rather slow. +\end{description} +\begin{ctanrefs} +\item[idxtex]\CTANref{glo+idxtex} +\item[ltxindex.sty]\CTANref{ltxindex} +\item[makeindex]\CTANref{makeindex} +\item[makeindex (Macintosh)]\CTANref{macmakeindex} +\item[texindex \nothtml{\upshape\rmfamily}(the script)]\CTANref{texindex} +\item[texindex \nothtml{\upshape\rmfamily}(the program)]Distributed + with \CTANref{texinfo} +\item[texsis (system)]\CTANref{texsis} +\item[texsis (makeindex support)]\CTANref{texsis-index} +\item[xindy]\CTANref{xindy} +\end{ctanrefs} + +\Question[Q-setURL]{Typesetting \acro{URL}s} + +\acro{URL}s tend to be very long, and contain characters that would +naturally prevent them being hyphenated even if they weren't typically +set in \csx{ttfamily}, verbatim. Therefore, without special treatment, +they often produce wildly overfull \csx{hbox}es, and their typeset +representation is awful. + +There are three packages that help solve this problem: +\begin{itemize} +\item The \Package{path} package, which defines a \csx{path} command. + The command defines each potential break character as a + \csx{discretionary}, and offers the user the opportunity of + specifying a personal list of potential break characters. Its chief + disadvantage is fragility in \LaTeX{} moving arguments. The +% beware line breaks + \Qref*{\Eplain{} macros}{Q-eplain}~--- define a similar \csx{path} command. + + \Package{Path}, though it works in simple situations, makes no + attempt to work with \LaTeX{} (it is irremediably fragile). Despite + its long and honourable history, it is no longer recommended for + \LaTeX{} use. +\item The \Package{url} package, which defines an \csx{url} command + (among others, including its own \csx{path} command). The command + gives each potential break character a maths-mode `personality', and + then sets the \acro{URL} itself (in the user's choice of font) in + maths mode. It can produce (\LaTeX{}-style) `robust' commands + % beware line break within paren + (\htmlonly{see }\Qref{use of \csx{protect}}{Q-protect}) for use + within moving arguments. + + The package ordinarily ignores spaces in the \acro{URL}, but + unfortunately \acro{URL}s that contain spaces do exist; to typeset + them, call the package with the \pkgoption{obeyspaces} option. Two + other useful options allow line breaks in the \acro{URL} in places + where they are ordinarily suppressed to avoid confusion: + \pkgoption{spaces} to allow breaks at spaces (note, this requires + \pkgoption{obeyspaces} as well, and \pkgoption{hyphens} to allow + breaks after hyphens. (Note that the package \emph{never} does + ``ordinary'' hyphenation of names inside an \acro{URL}.) + + It is possible to use the \Package{url} package in \plaintex{}, + with the assistance of the \Package{miniltx} package (which was + originally developed for using the \LaTeX{} graphics package in + \plaintex{}). A small patch is also necessary: the required + sequence is therefore: +\begin{narrowversion} +\begin{verbatim} +\input miniltx +\expandafter\def\expandafter\+% + \expandafter{\+} +\input url.sty +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\input miniltx +\expandafter\def\expandafter\+\expandafter{\+} +\input url.sty +\end{verbatim} +\end{wideversion} +\item The \Package{hyperref} package, which uses the typesetting code + of \Package{url}, in a context where the typeset text forms the + anchor of a link. +\end{itemize} + +The author of this answer prefers the (rather newer) \Package{url} +package (directly or indirectly); both \Package{path} and +\Package{url} work well with \plaintex{} (though of course, the fancy +\LaTeX{} facilities of \Package{url} don't have much place there). +(\Package{hyperref} isn't available in a version for use with \plaintex{}.) + +Note that neither \csx{path} (from package \Package{path}) nor \csx{url} (from +package \Package{url}) is robust (in the \LaTeX{} sense). If you need +a \acro{URL} to go in a moving argument, you need the command +\csx{urldef} from the \Package{url} package. So one might write: +\begin{quote} +\begin{verbatim} +\urldef\faqhome\url{http://www.tex.ac.uk/faq} +\end{verbatim} +\end{quote} +after which, \csx{faqhome} is robust. + +Documentation of both package \Package{path} and package \Package{url} +is in the package files. +\begin{ctanrefs} +\item[hyperref.sty]\CTANref{hyperref} +\item[miniltx.tex]Distributed as part of \CTANref{graphics-plain} +\item[path.sty]\CTANref{path} +\item[url.sty]\CTANref{url} +\end{ctanrefs} + +\Question[Q-music]{Typesetting music in \TeX{}} + +In the early days, a simple music package called Mu\TeX{} was +written by Angelika Schofer and Andrea Steinbach, which demonstrated +that music typesetting was possible; the package was very limited, and is +hardly ever used nowadays. Daniel Taupin took up the baton, and +developed Music\TeX{}, which allows the typesetting of polyphonic and +other multiple-stave music; Music\TeX{} remains available, but is most +definitely no longer recommended. + +Music\TeX{} has been superseded by its successor MusiX\TeX{}, which is +a three-pass system (with a processor program that computes values for +the element spacing in the music), and achieves finer control than is +possible in the unmodified \TeX{}-based mechanism that Music\TeX{} +uses. Daniel Taupin's is the only version of MusiX\TeX{} currently +being developed (the original author, Andreas Egler, had an +alternative version, but he is now working on a different package +altogether). + +Input to Musix\TeX{} is extremely tricky stuff, and Don Simons' +preprocessor \ProgName{pmx} is the preferred method of creating input +for Taupin's version. \ProgName{Pmx} greatly eases use of +Musix\TeX{}, but it doesn't support the full range of Musix\TeX{}'s +facilities directly; however, it does allow in-line Musix\TeX{} code +in \ProgName{pmx} sources. + +Dirk Laurie's \ProgName{M-Tx} allows preparation of music with lyrics; +it operates ``on top of'' \ProgName{pmx} + +Another simple notation is supported by \ProgName{abc2mtex}; this is a +package designed to notate tunes stored in an \acro{ASCII} format +(\texttt{abc} notation). It was designed primarily for folk and traditional +tunes of Western European origin (such as Irish, English and Scottish) +which can be written on one stave in standard classical notation, and +creates input intended for Music\TeX{}. However, it should be +extendable to many other types of music. + +Digital music fans can typeset notation for their efforts by using +\ProgName{midi2tex}, which translates \acro{MIDI} data files into +Music\TeX{} source code. + +There is a mailing list (\Email{TeX-music@icking-music-archive.org}) +for discussion of typesetting music in \TeX{}; it mostly covers +Musix\TeX{} and related systems. To subscribe, use +\URL{http://icking-music-archive.org/mailman/listinfo/tex-music/} + +An alternative (free) means of embedding music examples into \AllTeX{} +documents is \href{http://www.lilypond.org}{Lilypond}. Lilypond is +(at heart) a batch music typesetting system with plain text input that +does most of its work without TeX. Lilypond's input syntax is far +less cryptic than is Musix\TeX{}'s, and it handles much more stuff +automatically, yielding the same or better quality with less effort. +Lilypond can also produce basic \acro{MIDI} output. +\begin{ctanrefs} +\item[abc2mtex]\CTANref{abc2mtex} +\item[M-Tx]\CTANref{mtx} +\item[midi2tex]\CTANref{midi2tex} +\item[musictex]\CTANref{musictex} +% ! line breaks +\item[musixtex \nothtml{\rmfamily}(Taupin's version)]\CTANref{musixtex-taupin} +\item[musixtex \nothtml{\rmfamily}(Egler's version)]\CTANref{musixtex-egler} +\item[mutex]\CTANref{mutex} +\item[pmx]\CTANref{pmx} +\end{ctanrefs} + +\Question[Q-parskip]{Zero paragraph indent} + +The conventional way of typesetting running text has no separation +between paragraphs, and the first line of each paragraph in a block of +text indented. + +In contrast, one common convention for typewritten text was to have no +indentation of paragraphs; such a style is often required for +``brutalist'' publications such as technical manuals, and in styles +that hanker after typewritten manuscripts, such as +officially-specified dissertation formats. + +Anyone can see, after no more than a moment's thought, that if the +paragraph indent is zero, the paragraphs must be separated by blank +space: otherwise it is sometimes going to be impossible to see the +breaks between paragraphs. + +The simple-minded approach to zero paragraph indentation is thus: +\begin{verbatim} + \setlength{\parindent}{0pt} + \setlength{\parskip}{\baselineskip} +\end{verbatim} +and in the very simplest text, it's a fine solution. + +However, the non-zero \csx{parskip} interferes with lists and the like, +and the result looks pretty awful. The \Package{parskip} package +patches things up to look reasonable; it's not perfect, but it deals +with most problems. + +The Netherlands Users' Group's set of classes includes an +\Class{article} equivalent (\Class{artikel3}) and a \Class{report} +equivalent (\Class{rapport3}) whose design incorporates zero paragraph +indent and non-zero paragraph skip. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\acro{NTG} classes]\CTANref{ntgclass} +\item[parskip.sty]\CTANref{parskip} +\end{ctanrefs} + +\Question[Q-dropping]{Big letters at the start of a paragraph} + +A common style of typesetting, now seldom seen except in newspapers, +is to start a paragraph (in books, usually the first of a chapter) +with its first letter set large enough to span several lines. + +This style is known as ``dropped capitals'', or (in French) +\latexhtml{``lettrines''}{\htmlentity{laquo}lettrines\htmlentity{raquo}}, +and \TeX{}'s primitive facilities for hanging indentation make its +(simple) implementation pretty straightforward. + +The \Package{dropping} package does the job simply, but has a curious +attitude to the calculation of the size of the font to be used for the +big letters. Examples appear in the package documentation, so before +you process the \extension{dtx}, the package itself must already be +installed. Unfortunately, \Package{dropping} has an intimate relation +to the set of device drivers available in an early version of the +\LaTeX{} graphics package, and it cannot be trusted to work with +modern offerings such as \PDFTeX{}, V\TeX{} or \acro{DVI}pdfm, let +alone such modernisms as \xetex{}. As a result, the package is widely +deprecated, nowadays. + +The more recent \Package{lettrine} package is generally more reliable. +It has a well-constructed array of options, and an impressive set of +examples adds to the package's document. +\begin{ctanrefs} +\item[dropping]\CTANref{dropping} +\item[lettrine]\CTANref{lettrine} +\end{ctanrefs} + +\Question[Q-dec_comma]{The comma as a decimal separator} + +\TeX{} embodies the British/American cultural convention of using a +period as the separator between the whole number and the decimal +fraction part of a decimal number. Other cultures use a comma as +separator, but if you use a comma in maths mode you get a small space +after it; this space makes a comma that is used as a decimal separator +look untidy. + +A simple solution to this problem, in maths mode, is to type +\texttt{3}\marg{,}\texttt{14} in place of \texttt{3,14}. While such a +technique may produce the right results, it is plainly not a +comfortable way to undertake any but the most trivial amounts of +typing numbers. + +Therefore, if you need to use commas as decimal separator, you will +probably welcome macro support. There are two packages that +can help relieve the tedium: \Package{icomma} and \Package{ziffer}. + +\Package{Icomma} ensures that there will be no extra space after a +comma, unless you type a space after it (as in \texttt{f(x, y)}~--- in +the absence of the package, you don't need that space), in which case +the usual small space after the comma appears. \Package{Ziffer} is +specifically targeted at the needs of those typesetting German, but +covers the present need, as well as providing the double-minus sign +used in German (and other languages) for the empty `cents' part of an +amount of currency. + +The \Package{numprint} package provides a command +\cmdinvoke*{numprint}{number} that prints its argument according to +settings you give it, or according to settings chosen to match the +language you have selected in \Package{babel}. The formatting works +equally well in text or maths. The command is very flexible (it can also +group the digits of very `long' numbers), but is inevitably less +convenient than \Package{icomma} or \Package{ziffer} if you are typing a +lot of numbers. +\begin{ctanrefs} +\item[icomma.sty]Distributed as part of \CTANref{was} +\item[numprint.sty]\CTANref{numprint} +\item[ziffer.sty]\CTANref{ziffer} +\end{ctanrefs} + +\Question[Q-breakbox]{Breaking boxes of text} + +\AllTeX{} boxes may not be broken, in ordinary usage: once you've +typeset something into a box, it will stay there, and the box will jut +out beyond the side or the bottom of the page if it doesn't fit in the +typeset area. + +If you want a substantial portion of your text to be framed (or +coloured), the restriction starts to seem a real imposition. +Fortunately, there are ways around the problem. + +The \Package{framed} package provides \environment{framed} and +\environment{shaded} environments; both put their content into +something which looks like a framed (or coloured) box, but which +breaks as necessary at page end. The environments ``lose'' footnotes, +marginpars and head-line entries, and will not work with +\Package{multicol} or other column-balancing macros. The +\Class{memoir} class includes the functionality of the +\Package{framed} package. + +The \Package{boites} package provides a \environment{breakbox} +environment; examples of its use may be found in the distribution, and +the package's \File{README} file contains terse documentation. The +environments may be nested, and may appear inside +\environment{multicols} environments; however, floats, footnotes and +marginpars will be lost. + +For \plaintex{} users, the facilities of the \Package{backgrnd} +package may be useful; this package subverts the output routine to +provide vertical bars to mark text, and the macros are clearly marked +to show where coloured backgrounds may be introduced (this requires +\Package{shade}, which is distributed as tex macros and +device-independent \MF{} for the shading). The author of +\Package{backgrnd} claims that the package works with \LaTeXo{}, but +there are reasons to suspect that it may be unstable working with +current \LaTeX{}. +\begin{ctanrefs} +\item[backgrnd.tex]\CTANref{backgrnd} +\item[boites.sty]\CTANref{boites} +\item[framed.sty]\CTANref{framed} +\item[memoir.cls]\CTANref{memoir} +\item[shade.tex]\CTANref{shade} +\end{ctanrefs} + +\Question[Q-overstrike]{Overstriking characters} + +This may be used, for example, to indicate text deleted in the course +of editing. Both the \Package{ulem} and the \Package{soul} packages +provide the necessary facilities. + +Overstriking for % beware line break +\Qref*{cancellation in maths expressions}{Q-cancellation} is achieved +by a different mechanism. + +Documentation of \Package{ulem} is in the package file. +\begin{ctanrefs} +\item[soul.sty]\CTANref{soul} +\item[ulem.sty]\CTANref{ulem} +\end{ctanrefs} + +\Question[Q-upquot]{Realistic quotes for verbatim listings} + +The \texttt{cmtt} font has ``curly'' quotes\nothtml{ (\texttt{`thus'})}, +which are pleasing on the eye, but don't really tally with what one +sees on a modern % beware line break +\ProgName{xterm}\nothtml{ (which look like \texttt{\textasciigrave this\textquotesingle})}. + +The appearance of these quotes is critical in program listings, +particularly in those of Unix-like shell scripts. The +\Package{upquote} package modifies the behaviour of the +\environment{verbatim} environment so that the output is a clearer +representation of what the user must type. +\begin{ctanrefs} +\item[upquote.sty]\CTANref{upquote} +\end{ctanrefs} + +\Question[Q-time]{Printing the time} + +\TeX{} has a primitive register that contains ``the number of minutes +since midnight''; with this knowledge it's a moderately simple +programming job to print the time (one that no self-respecting +\plaintex{} user would bother with anyone else's code for). + +However, \LaTeX{} provides no primitive for ``time'', so the +non-programming \LaTeX{} user needs help. + +Two packages are available, both providing ranges of ways of printing +the date, as well as of the time: this question will concentrate on +the time-printing capabilities, and interested users can investigate +the documentation for details about dates. + +The \Package{datetime} package defines two time-printing functions: +\csx{xxivtime} (for 24-hour time), \csx{ampmtime} (for 12-hour time) and +\csx{oclock} (for time-as-words, albeit a slightly eccentric set of +words). + +The \Package{scrtime} package (part of the compendious +\Class{KOMA-Script} bundle) takes a package option (\pkgoption{12h} or +\pkgoption{24h}) to specify how times are to be printed. The command +\csx{thistime} then prints the time appropriately (though there's no +\emph{am} or \emph{pm} in \pkgoption{12h} mode). The \csx{thistime} +command also takes an optional argument, the character to separate the +hours and minutes: the default is of course \texttt{:}. +\begin{ctanrefs} +\item[datetime.sty]\CTANref{datetime} +\item[scrtime.sty]Distributed as part of \CTANref{koma-script} +\end{ctanrefs} + +\Question[Q-the-commands]{Redefining counters' \csx{the-}commands} + +Whenever you request a new \LaTeX{} counter, \LaTeX{} creates a bunch +of behind-the-scenes commands, as well as defining the counter +itself. + +Among other things, \cmdinvoke*{newcounter}{fred} creates a command +\csx{the}\texttt{\emph{fred}}, which expands to ``the value of +\texttt{\emph{fred}}'' when you're typesetting. + +The definition of \csx{the}\texttt{\emph{fred}} should express the +value of the counter: it is almost always always a mistake to use the +command to produce anything else. The value may reasonably be +expressed as an arabic, a roman or a greek number, as an alphabetic +expression, or even as a sequence (or pattern of) symbols. If you +need a decision process on whether to re-define +\csx{the}\texttt{\emph{fred}}, consider what might happen when you do +so. + +So, for example, if you want your section numbers to be terminated by +a period, you could make \csx{thesection} expand with a terminating +period. However, such a change to \csx{thesection} makes the +definition of \csx{thesubsection} look distinctly odd: you are going to +find yourself redefining things left, right and centre. Rather, use +the standard techniques for % beware line break +\Qref*{adjusting the presentation of section numbers}{Q-seccntfmt}. + +Or, suppose you want the page number to appear at the bottom of each +page surrounded by dashes (as in +``\texttt{-}{}\texttt{-\textasciitilde}\texttt{nnn\textasciitilde-}{}\texttt{-}''). +If you try to achieve this by redefining \csx{thepage}, problems will +arise from the use of the page number in the table of contents (each +number will have the dashes attached), and \csx{pageref} references +will be oddly modified. In this case, the change of appearance is +best done by redefining the page style itself, perhaps using +\Qref*{package \Package{fancyhdr}}{Q-fancyhdr}. + +\subsection{Tables of contents and indexes} + +\Question[Q-tocloft]{The format of the Table of Contents, etc.} + +The formats of entries in the table of contents (\acro{TOC}) are +controlled by a number of internal commands (discussed in section~2.3 +of \Qref*{\emph{The \LaTeX{} Companion}}{Q-books}. The commands +\csx{@pnumwidth}, \csx{@tocrmarg} and \csx{@dotsep} control the space +for page numbers, the indentation of the right-hand margin, and the +separation of the dots in the dotted leaders, respectively. The +series of commands named \csx{l@\emph{xxx}}, where \texttt{\emph{xxx}} +is the name of a sectional heading (such as \texttt{chapter} or +\texttt{section}, \dots{}\@) control the layout of the corresponding +heading, including the space for section numbers. All these internal +commands may be individually redefined to give the effect that you +want. + +Alternatively, the package \Package{tocloft} provides a set of +user-level commands that may be used to change the \acro{TOC} +formatting. Since exactly the same mechanisms are used for the List +of Figures and List of Tables, the layout of these sections may be +controlled in the same way. + +The \Class{KOMA-Script} classes provides an optional variant structure +for the table of contents, and calculates the space needed for the +numbers automatically. The \Class{memoir} class includes the functionality +of \Package{tocloft}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[tocloft.sty]\CTANref{tocloft} +\end{ctanrefs} + +\Question[Q-secnumdep]{Unnumbered sections in the Table of Contents} + +The way the relevant parts of sectioning commands work is exemplified +by the way the \csx{chapter} command uses the counter \texttt{secnumdepth} +(described in Appendix~C of the \LaTeX{} manual): +\begin{enumerate} +\item put something in the \extension{aux} file, which will appear in + the \extension{toc}; +\htmlignore +\item if \ensuremath{\texttt{secnumdepth} \geq 0}, +\endhtmlignore +\begin{htmlversion} +\item if the \texttt{secnumdepth} counter is greater than or equal to + zero, +\end{htmlversion} + increase the counter for the chapter and write it out. +\item write the chapter title. +\end{enumerate} +Other sectioning commands are similar, but with other values used in +the test. + +So a simple way to get headings of funny `sections' such as prefaces +in the table of contents is to use the counter: +\begin{quote} +\begin{verbatim} +\setcounter{secnumdepth}{-1} +\chapter{Preface} +\end{verbatim} +\end{quote} +Unfortunately, you have to set \texttt{secnumdepth} back to its usual +value (which is~2 in the standard styles) before you do any `section' +which you want to be numbered. + +Similar settings are made, automatically, in the \LaTeX{} book class by +the \csx{frontmatter} and \csx{backmatter} commands. + +The value of the counter \texttt{tocdepth} controls which headings +will be finally printed in the table of contents. This normally has +to be set in the preamble and is a constant for the document. The +package \Package{tocvsec2} package provides a convenient interface to +allow you to change the \texttt{secnumdepth} and/or the +\texttt{tocdepth} counter values at any point in the body of the +document; this provides convenient independent controls over the +sectional numbering and the table of contents. + +The package \Package{abstract} (see % line break! +\Qref[question]{one-column abstracts}{Q-onecolabs}) includes an option +to add the \texttt{abstract} to the table of contents, while the +package \Package{tocbibind} has options to include the table of +contents itself, the \texttt{bibliography}, \texttt{index}, etc., to +the table of contents. + +The \Class{KOMA-Script} classes have commands \csx{addchap} and +\csx{addled}, which work like \csx{chapter} and \csx{section} but +aren't numbered. The \Class{memoir} class incorporates the facilities +of all three of the \Package{abstract}, \Package{tocbibind} and +\Package{tocvsec2} packages. +\begin{ctanrefs} +\item[abstract.sty]\CTANref{abstract} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[tocbibind.sty]\CTANref{tocbibind} +\item[tocvsec2.sty]\CTANref{tocvsec2} +\end{ctanrefs} + +\Question[Q-tocbibind]{Bibliography, index, etc., in \acro{TOC}} + +The standard \LaTeX{} classes (and many others) use \csx{section*} or +\csx{chapter*} for auto-generated parts of the document (the tables of +contents, lists of figures and tables, the bibliography and the index). As a +result, these items aren't numbered (which most people don't mind), +and (more importantly) they don't appear in the table of contents. + +The correct solution (as always) is to have a class of your own that +formats your document according to your requirements. The macro to do +the job (\csx{addcontentsline}) is fairly simple, but there is always +an issue of ensuring that the contents entry quotes the correct page. +Supposing that our the document is chapter-based (class \Class{report} +or \Class{book}, for example), the text: +\begin{quote} +\begin{verbatim} +\bibliography{frooble} +\addcontentsline{toc}{chapter}{Bibliography} +\end{verbatim} +\end{quote} +will produce the \emph{wrong} answer if the bibliography is more than +one page long. Instead, one should say: +\begin{quote} +\begin{verbatim} +\cleardoublepage +\addcontentsline{toc}{chapter}{Bibliography} +\bibliography{frooble} +\end{verbatim} +\end{quote} +(Note that \csx{cleardoublepage} does the right thing, even if your +document is single-sided~--- in that case, it's a synonym for +\csx{clearpage}). Ensuring that the entry refers to the right place is +trickier still in a \csx{section}-based class. + +If you are using \Package{hyperref} (which will link entries in the +table of contents to the relevant place in the file), a slight +adjustment is necessary: +\begin{quote} +\begin{verbatim} +\cleardoublepage +\phantomsection +\addcontentsline{toc}{chapter}{Bibliography} +\bibliography{frooble} +\end{verbatim} +\end{quote} +The extra command (\csx{phantomsection}) gives \Package{hyperref} +something to ``hold on to'' when making the link. + +The common solution, therefore, is to use the \Package{tocbibind} +package, which provides many facilities to control the way these +entries appear in the table of contents. + +Classes of the \Class{KOMA-script} bundle provide this functionality +as a set of class options (e.g., \pkgoption{bibtotoc} to add the +bibliography to the table of contents); the \Class{memoir} class includes +\Package{tocbibind} itself. +\begin{ctanrefs} +\item[hyperref.sty]\CTANref{hyperref} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[tocbibind.sty]\CTANref{tocbibind} +\end{ctanrefs} + +\Question[Q-minitoc]{Table of contents, etc., per chapter} + +The common style, of a ``small'' table of contents for each part, +chapter, or even section, is supported by the \Package{minitoc} +package. The package also supports mini-lists of tables and figures; +but, as the documentation observes, mini-bibliographies are a +different problem~--- see +\Qref[question]{bibliographies per chapter}{Q-chapbib}. + +The package's basic scheme is to generate a little \extension{aux} file for +each chapter, and to process that within the chapter. Simple usage +would be: +\begin{quote} +\begin{verbatim} +\usepackage{minitoc} +... +\begin{document} +... +\dominitoc \tableofcontents +\dominilof \listoffigures +... +\chapter{blah blah} +\minitoc \mtcskip \minilof +... +\end{verbatim} +\end{quote} +though a lot of elaborations are possible (for example, you don't need +a \csx{minitoc} for every chapter). + +\Package{Babel} doesn't know about \Package{minitoc}, but +\Package{minitoc} makes provision for other document languages than +English~--- a wide variety is available. Fortunately, the current +version of the \Package{hyperref} package does know about +\Package{minitoc} and treats \csx{minitoc} tables in the +same way as ``real'' tables of contents. +\begin{ctanrefs} +\item[babel.sty]\CTANref{babel} +\item[hyperref.sty]\CTANref{hyperref} +\item[minitoc.sty]\CTANref{minitoc} +\end{ctanrefs} + +\Question[Q-multind]{Multiple indexes} + +\LaTeX{}'s standard indexing capabilities (those provided by the +\Package{makeidx} package) only provide for one index in your +document; even quite modest documents can be improved by indexes for +separate topics. + +The \Package{multind} package provides simple and straightforward +multiple indexing. You tag each \csx{makeindex}, \csx{index} and +\csx{printindex} command with a file name, and indexing commands are +written to (or read from) the name with the appropriate (\extension{idx} or +\extension{ind}) extension appended. The \csx{printindex} command is modified +from the \LaTeX{} standard so that it doesn't create its own chapter +or section heading; you therefore decide what names (or sectioning +level, even) to use for the indexes, and +\Qref*{\csx{indexname}}{Q-fixnam} is completely ignored. + +To create a ``general'' and an ``authors'' index, one might write: +\begin{quote} +\begin{verbatim} +\usepackage{multind} +\makeindex{general} +\makeindex{authors} +... +\index{authors}{Another Idiot} +... +\index{general}{FAQs} +... +\printindex{general}{General index} +\printindex{authors}{Author index} +\end{verbatim} +\end{quote} +To complete the job, run \LaTeX{} on your file enough times that +labels, etc., are stable, and then execute the commands +\begin{quote} +\begin{verbatim} +makeindex general +makeindex authors +\end{verbatim} +\end{quote} +before running \LaTeX{} again. Note that the names of the index files +to process are not necessarily related to the name of the \LaTeX{} +file you're processing, at all. (There's no documentation that comes +with the package: what you see above is as good as you will +get\dots{}) + +The \Package{index} package provides a comprehensive set of indexing +facilities, including a \csx{newindex} command that allows the +definition of new styles of index. \csx{newindex} takes a `tag' (for +use in indexing commands), replacements for the \extension{idx} and +\extension{ind} file extensions, and a title for the index when it's +finally printed; it can also change the item that's being indexed +against (for example, one might have an index of artists referenced by +the figure number where their work is shown). + +Using \Package{index}, to create an author index together with a +``normal'' index, one would start with preamble commands: +\begin{quote} +\begin{verbatim} +\usepackage{index} +\makeindex +\newindex{aut}{adx}{and}{Name Index} +\end{verbatim} +\end{quote} +which load the package, define a ``main'' (original-style) index, and +then define an author index. Then, in the body of the document, we +might find commands like: +\begin{quote} +\begin{verbatim} +\index[aut]{Another Idiot} +... +\index{FAQs} +\end{verbatim} +\end{quote} +Which place an entry in the author index, and then one in the main +index. At the end of the document, we have two commands: +\begin{quote} +\begin{verbatim} +\printindex +\printindex[aut] +\end{verbatim} +\end{quote} +Which will print the main index and then the author index. Supposing +this lot to be in \File{myfile.tex}, after enough runs through +\LaTeX{} that labels are stable, execute the following commands +(Unix-style shell commands shown here, but the principle is the same +whatever system you're using): +\begin{quote} +\begin{verbatim} +makeindex myfile +makeindex myfile.adx -o myfile.and +\end{verbatim} +\end{quote} +and rerun \LaTeX{}. The \ProgName{makeindex} commands process +\File{myfile.idx} to \File{myfile.ind} (the default action), and then +\File{myfile.adx} to \File{myfile.and}, the two files needed as input +by the two \csx{printindex} commands in \File{myfile.tex}. + +The \Package{splitidx} package can operate in the same way as the +others: load the package with the \pkgoption{split} option, and +declare each index with a \csx{newindex} command: +\begin{quote} + \cmdinvoke{newindex}[\meta{index name}]{\meta{shortcut}} +\end{quote} +and \Package{splitidx} will generate a file +\csx{jobname}\texttt{.\meta{shortcut}} to receive index entries +generated by commands like \cmdinvoke{sindex}[\meta{shortcut}]{\meta{item}}. +As with the other packages, this method is limited by \TeX{}'s total +number of output files. However, \Package{splitindex} also comes with +a small executable \ProgName{splitindex} (available for a variety of +operating systems); if you use this auxiliary program (and don't use +\pkgoption{split}), there's no limit to the number of indexes. Apart +from this trick, \Package{splitidx} supports the same sorts of things +as does \Package{index}. An example of use appears in +the documentation. + +The \Class{memoir} class has its own multiple-index functionality (as +well as its own index layout options, which other packages delegate to +the index style used by \ProgName{makeindex}). +\begin{ctanrefs} +\item[index.sty]\CTANref{index} +\item[makeidx.sty]Part of the \LaTeX{} distribution +\item[memoir.cls]\CTANref{memoir} +\item[multind.sty]\CTANref{multind} +\item[splitidx.sty \bgroup\nothtml{\normalfont}and \egroup splitindex]% + \CTANref{splitindex} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex new file mode 100644 index 00000000000..0e38dc60ca3 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex @@ -0,0 +1,987 @@ +% $Id: faq-backgrnd.tex,v 1.1 2009/06/13 20:56:34 rf10 Exp rf10 $ + +\section{The Background} + +\Question[Q-whatTeX]{What is \TeX{}?} + +\TeX{} is a typesetting system written by +\href{http://sunburn.stanford.edu/~knuth/}{Donald E. Knuth}, who +says in the Preface to his book on \TeX{} +(see \Qref[question]{books about TeX}{Q-books}) that it is +%% !line wrap avoided by two commands +``\emph{intended for the creation of beautiful books~---} +\emph{and especially for books that contain a lot of mathematics}''. +(If \TeX{} were \emph{only} good for mathematical books, much of its +use nowadays would not happen: it's actually a pretty good general +typesetting system.) + +Knuth is Emeritus Professor of the Art of Computer Programming at +Stanford University in California, \acro{USA}. Knuth developed the +first version of \TeX{} in 1978 to deal with revisions to his series +``the Art of Computer Programming''. The idea proved popular and +Knuth produced a second version (in 1982) which is the basis of what +we use today. + +Knuth developed a system of % ! line breaks +`\Qref*{literate programming}{Q-lit}' to write \TeX{}, +and he provides the literate (\acro{WEB}) source of \TeX{} free of charge, +together with tools for processing the |web| source into something +that can be compiled and something that can be printed; there's never +any mystery about what \TeX{} does. Furthermore, the \acro{WEB} system +provides mechanisms to port \TeX{} to new operating systems and +computers; and in order that one may have some confidence in the ports, +Knuth supplied a \Qref*{test}{Q-triptrap} by +means of which one may judge the fidelity of a \TeX{} system. \TeX{} +and its documents are therefore highly portable. + +\TeX{} is a macro processor, and offers its users a powerful +programming capability. For this reason, \TeX{} on its own is a +pretty difficult beast to deal with, so Knuth provided a package of +macros for use with \TeX{} called \plaintex{}; \plaintex{} is +effectively the minimum set of macros one can usefully employ with +\TeX{}, together with some demonstration versions of higher-level +commands (the latter are better regarded as models than used as-is). +When people say they're ``programming in \TeX{}'', they usually mean +they're programming in \plaintex{}. + +\Question[Q-TeXpronounce]{How should I pronounce ``\TeX{}''?} + +The `X' is ``really'' the Greek letter % ! line break +Chi\nothtml{ (\ensuremath{\chi}, in lower case)}, and is pronounced by +English-speakers either a bit like the `ch' in the Scots word `loch' +([x] in the IPA) or (at a pinch, if you can't do the Greek sound) like +`k'. It definitely is not pronounced `ks' (the Greek letter with that +sound doesn't look remotely like the Latin alphabet `X'). + +This curious usage derives from Knuth's explanation in the \TeX{}book +that the name comes from the Greek word for `art' or `craft' +(`\latexhtml{\ensuremath{\tau\epsilon\chi\nu\eta}}{\emph{techni}}'), +which is the root of the English word `technology'. Knuth's logo for \TeX{} is +merely the uppercase version of the first three (Greek) letters of the +word, jiggled about a bit; we don't use that logo (and logos like it) +in this \acro{FAQ} (see % ! line break +\Qref[question]{Typesetting \TeX{}-related logos}{Q-logos}). + +\Question[Q-MF]{What is \MF{}?} + +\MF{} was written by Knuth as a companion to \TeX{}; whereas \TeX{} +defines the layout of glyphs on a page, \MF{} defines the shapes of +the glyphs and the relations between them. \MF{} details the sizes of +glyphs, for \TeX{}'s benefit, and details the rasters used to +represent the glyphs, for the benefit of programs that will produce +printed output as post processes after a run of \TeX{}. + +\MF{}'s language for defining fonts permits the expression of several +classes of things: first (of course), the simple geometry of the +glyphs; second, the properties of the print engine for which the +output is intended; and third, `meta'-information which can +distinguish different design sizes of the same font, or the difference +between two fonts that belong to the same (or related) families. + +Knuth (and others) have designed a fair range of fonts using \MF{}, +but font design using \MF{} is much more of a minority skill than is +\TeX{} macro-writing. The complete \TeX{}-user nevertheless needs to +be aware of \MF{}, and to be able to run \MF{} to generate personal +copies of Meta-fonts that come her way. + +\Question[Q-MP]{What is \MP{}?} + +The \MP{} system (by John Hobby) implements a picture-drawing language +very much like that of \MF{} except that it outputs Encapsulated \PS{} +files instead of run-length-encoded bitmaps. \MP{} is a powerful +language for producing figures for documents to be printed on \PS{} +printers, either directly or embedded in \AllTeX{} documents. It +includes facilities for directly integrating \TeX{} text and +mathematics with the graphics. (Knuth tells us that he uses nothing +but \MP{} for diagrams in text that he is writing.) + +Although \PDFLaTeX{} cannot ordinarily handle \PS{} graphics, the +output of \MP{} is sufficiently simple and regular that \PDFLaTeX{} +can handle it direct, using code borrowed from \CONTeXT{}~--- see +\Qref[question]{graphics in \PDFLaTeX{}}{Q-pdftexgraphics}. + +Much of \MP{}'s source code was copied from \MF{}'s sources, with +Knuth's permission. + +A mailing list discussing \MP{} is available; +\begin{narrowversion} % really non-hyper + subscribe via the \acro{TUG} \ProgName{mailman} interface at + \URL{http://lists.tug.org/metapost} +\end{narrowversion} +\begin{wideversion} % really hyper + subscribe via the % ! line break + \href{http://lists.tug.org/metapost}{\acro{TUG} \ProgName{mailman} interface}. +\end{wideversion} +The \acro{TUG} website also hosts a % ! line break +\href{http://tug.org/metapost.html}{\MP{} summary page}. + +%**** +\Question[Q-texthings]{Things with ``\TeX{}'' in the name} + +New \TeX{} users are often baffled by the myriad terms with ``\TeX{}'' +in the name. The goal of this answer is to clarify some of the more +common \TeX{} terms. + +\paragraph{\TeX{} itself} +\TeX{} proper is a typesetting system based on a set of low-level +control sequences that instruct \TeX{} how to lay out text on the +page. For example, \csx{hskip} inserts a given amount of horizontal +space into the document, and \csx{font} makes a given font available +to \TeX{}. \TeX{} is fully programmable using an integrated macro +scripting language that supports variables, scoping, conditional +execution, control flow, and function (really, macro) definitions. +See % ! line break +\Qref[question]{What is \TeX{}?}{Q-whatTeX} for some background +information on \TeX{} and % ! line break +\Qref[question]{Reference documents}{Q-ref-doc} for pointers to +descriptions of \TeX{} control sequences, data types, and other key +parts of \TeX{}. + +\paragraph{\TeX{} macro packages (a.k.a.~\TeX{} formats)} +\TeX{}'s control sequences are tedious to use directly; they are +intended primarily as building blocks for higher-level---and therefore +more user-friendly---abstractions. For example, there is no way in +base \TeX{} to specify that a piece of text should be typeset in a +larger font. Instead, one must keep track of the current size and +typeface, load a new font with the same typeface but a (specified) +larger size, and tell \TeX{} to use that new font until instructed +otherwise. Fortunately, because \TeX{} is programmable, it is +possible to write a macro that hides this complexity behind a simple, +new control sequence. For example, +% +\cmdinvoke{larger}{my text} can be defined to typeset ``my text'' in +the next larger font). + +While some users write their own, perfectly customized set of +macros---which they then typically reuse across many documents---it is +far more common to rely upon a \emph{macro package}, a collection of +\TeX{} macros written by experts. For the user's convenience, these +macro packages are often combined with the base \TeX{} engine into a +standalone executable. The following are some of that macro packages +that you are likely to encounter: +\begin{description} + \item[Plain \TeX{} (executable: \ProgName{tex})] + See + \Qref[questions]{Books on \TeX{} and its relations}{Q-books}, + \Qref[]{Online introductions: \TeX{}}{Q-man-tex}, + \Qref[]{Should I use Plain \TeX{} or \LaTeX{}?}{Q-plainvltx} and + \Qref[]{Freely available \AllTeX{} books}{Q-ol-books}. + Note that the Plain \TeX{} executable is called \ProgName{tex}; the + base \TeX{} engine is generally provided by a separate executable + such as \ProgName{initex} or as a \texttt{-ini} flag to + \ProgName{tex}. + + \item[\LaTeX{} (executable: \ProgName{latex})] + See + \Qref[questions]{Books on \TeX{} and its relations}{Q-books}, + \Qref[]{\AllTeX{} Tutorials, etc.}{Q-tutorials*}, + \Qref[]{Online introductions: \LaTeX{}}{Q-man-latex}, + \Qref[]{Specialized \AllTeX{} tutorials}{Q-tutbitslatex} and + \Qref[]{Directories of \AllTeX{} information}{Q-doc-dirs}. + Note that there have been two major versions of \LaTeX{}: \LaTeXe{} + refers to the current version of \LaTeX{} while \LaTeXo{} is the + long-since-obsolete (since 1994) version (cf.~% + \Qref[question]{What is \LaTeXe{}?}{Q-latex2e} for more information). + + \item[\CONTeXT{} (executable: \ProgName{texexec})] + See + \Qref[question]{What is \CONTeXT{}?}{Q-context}. + + \item[Texinfo (executables: \ProgName{tex}, \ProgName{makeinfo})] + See + \Qref[question]{What is Texinfo?}{Q-texinfo}. \ProgName{makeinfo} + converts Texinfo documents to \acro{HTML}, DocBook, Emacs info, + \acro{XML}, and plain text. \ProgName{Tex} (or wrappers such as + \ProgName{texi2pdf} and \ProgName{texi2pdf}) produce one of \TeX{}'s + usual output formats such as \acro{DVI} or \acro{PDF}. Because + \ProgName{tex} loads the Plain \TeX{} macros, not the Texinfo ones, + a Texinfo document must begin with \cmdinvoke{input}{texinfo} to + explicitly load the Texinfo macro package. + + \item[\Eplain{}---Extended Plain \TeX{} (executable: \ProgName{eplain})] + See + \Qref[question]{What is \Eplain{}?}{Q-eplain}. +\end{description} + +\paragraph{Modified \ProgName{tex} executables} +The original \ProgName{tex} executable was produced in the late 1970s +(cf.~\Qref[question]{What is \TeX{}?}{Q-whatTeX}) and consequently +lacked some features that users have come to expect from today's +software. The following programs address these issues by augmenting +the \TeX{} engine with some additional useful features: + +\begin{description} + \item[\PDFTeX{} (executable: \ProgName{pdftex})] + \TeX{}, which predates the \acro{PDF} file format by a decade, + outputs files in a \TeX{}-specific format called \acro{DVI} + (cf.~\Qref[question]{What is a \acro{DVI} file?}{Q-dvi}). In + contrast, \PDFTeX{} can output both \acro{DVI} \emph{and} \acro{PDF} + files. In \acro{PDF} mode, it lets documents exploit various + \acro{PDF} features such as hyperlinks, bookmarks, and annotations, + \PDFTeX{} additionally supports two sophisticated micro-typographic + features: character protrusion and font expansion. See + \Qref[question]{What is \PDFTeX{}?}{Q-whatpdftex}. + + \item[\xetex{} (executable: \ProgName{xetex})] + \TeX{} not only predates all major font technologies in use today + (e.g.,~TrueType, OpenType, and PostScript Type~1) but also predates + the notion that fonts be included with an operating system. + Consequently, \TeX{} uses its own font formats, which are + incompatible with anything a user is likely to have preinstalled. + \xetex{} addresses this issue by enhancing \TeX{}'s \csx{font} + control sequence to support all of the fonts made available by the + operating system. See + \Qref[question]{What is \xetex{}?}{Q-xetex}. + + \item[\LuaTeX{} (executable: \ProgName{luatex})] + \TeX{} is programmed in its own, integrated, macro-based programming + language. Many users have criticized this language for being + needlessly difficult to program. \LuaTeX{} addresses that criticism + by integrating a modern scripting language, Lua, into the base + \TeX{} engine. See + \Qref[question]{What is \LuaTeX{}?}{Q-luatex}. + + \item[\eTeX{} (executable: \ProgName{etex})] + \eTeX{} provides a number of features that are only indirectly + useful to end users but that can be immensely useful to package + developers. Consequently, there is an increasing number of macro + packages that require the use of \eTeX{}. (Note: Be careful not to + confuse \eTeX{}, which enhances the \TeX{} engine, with \Eplain{}, + which enhances the Plain \TeX{} macro package.) See + \Qref[question]{What is \eTeX{}?}{Q-etex}. +\end{description} + +Because each of the above modifies only the base \TeX{} engine, it is +possible to combine any of those with any of the \TeX{} macro packages +listed earlier to produce executables with both sets of features. For +example, the \ProgName{pdflatex}, \ProgName{xelatex} and +\ProgName{lualatex} executables each combine +\LaTeX{} with an enhanced \TeX{} engine. Some executables combine the +features of multiple enhanced \TeX{} engines: \ProgName{pdfetex} +combines \PDFTeX{} and \eTeX{} into a single executable. + +As combining features is a generally desirable tendency, current +\TeX{} distributions (see below) incorporate the features of \PDFTeX{} +and \eTeX{} into a single executable. This executable may be +offered with a \LaTeX{} format (as \ProgName{latex} or +\ProgName{pdflatex}) or with a \plaintex{} format (as +\ProgName{pdftex}). (\ProgName{Tex} remains with an unadorned \TeX{} +executable using \plaintex{}, for people such as Knuth himself, who +want the certainty of the ``original''.) + +\paragraph{\TeX{} distributions} +A \emph{\TeX{} distribution} is a collection of \TeX{}-related +software. Generally, a \TeX{} distribution includes a set of core +\TeX{} executables such as \ProgName{tex} and \ProgName{latex}; +various fonts optimized for use with \TeX{}; helper programs such as +the \BibTeX{} bibliographic-database formatter, editors, integrated +development environments, file-format-conversion programs; numerous +\LaTeX{} packages; configuration tools; and any other goodies the +distributor chooses to include. Commonly encountered \TeX{} +distributions include \texlive{}, \miktex{} and Mac\TeX{}; older ones +include oz\TeX{}, \acro{CM}ac\TeX{} and te\TeX{}. Some \TeX{} +distributions target a specific operating system and/or processor +architecture; others run on multiple platforms. Some \TeX{} +distributions are free; others require payment. See % ! line break +\Qref[question]{\AllTeX{} for different machines}{Q-TeXsystems} for a +list of free and shareware \TeX{} distributions and % ! line break +\Qref[question]{Commercial \TeX{} implementations}{Q-commercial} for a +list of commercial \TeX{} distributions. + +\paragraph{Summary} +If your document begins with \csx{documentclass}, you're using some +form of the \LaTeX{} macro package. Even if hidden behind a button in +a \TeX{}-aware GUI, this document is getting compiled by a \TeX{} +executable---probably \ProgName{latex} or \ProgName{pdflatex}---to +produce an output file. The executable came bundled as part of a +\TeX{} distribution such as \miktex{}, which includes various other +\TeX{}-related components. +\LastEdit{2009-06-11} + + +\Question[Q-triptrap]{How can I be sure it's really \TeX{}?} + +\TeX{} (and \MF{} and \MP{}) are written in a +\begin{narrowversion} % really "non-hyper" + `literate' programming language called Web (\Qref{}{Q-lit}) +\end{narrowversion} +\begin{wideversion} + \Qref{`literate' programming}{Q-lit} language called Web +\end{wideversion} +which is designed to be portable across a wide range of computer +systems. How, then, is a new version of \TeX{} checked? + +Of course, any sensible software implementor will have his own suite +of tests to check that his software runs: those who port \TeX{} and +its friends to other platforms do indeed perform such tests. + +Knuth, however, provides a `conformance test' for both \TeX{} +(\texttt{trip}) and \MF{} (\texttt{trap}). +%%% Is there a similar one for \MP{}? +He characterises these as `torture tests': they are designed not to +check the obvious things that ordinary typeset documents, or font +designs, will exercise, but rather to explore small alleyways off the +main path through the code of \TeX{}. They are, to the casual reader, +pretty incomprehensible! + +Once an implementation of \TeX{} has passed its \texttt{trip} test, or an +implementation of \MF{} has passed its \texttt{trap} test, then it may +in principle be distributed as a working version. (In practice, any +distributor would test new versions against ``real'' documents or +fonts, too; \texttt{trip} and \texttt{trap} don't actually test any +for real world problems. + + +\Question[Q-y2k]{Are \TeX{} and friends Y2K compliant?} + +\begin{description} +\item[Crashing:] None of \TeX{}, \MF{} or \MP{} can themselves crash + due to any change whatever in the date of any sort. +\item[Timestamps:] In the original sources, a 2-digit year was + stored as the creation time for format files and that value is + printed in log-files. These items should not be of general concern, + since the only use of the date format file is to produce the log + output, and the log file is designed for human readers only. + + Knuth announced in 1998 that implementors could + alter this code without fear of being accused of non-compliance. + Nearly all implementations that are being actively maintained had + been modified to generate 4-digit years in the format file and the + log, by the end of 1998. The original sources themselves have now + been modified so that 4-digit year numbers are stored. +\item[The \csx{year} primitive:] Certification of a \TeX{} + implementation (see \Qref[question]{trip/trap testing}{Q-triptrap}) + does not require that \csx{year} return a meaningful value (which + means that \TeX{} can, in principle, be implemented on platforms + that don't make the value of the clock available to user programs). + The \emph{\TeX{}book} (see + \Qref[question]{TeX-related books}{Q-books}) defines \csx{year} as + ``the current year of our Lord'', which is the only correct meaning + for \csx{year} for those implementations which can supply a + meaningful value, which is to say nearly all of them. + + In short, \TeX{} implementations should provide a value in \csx{year} + giving the 4-digit year Anno Domini, or the value 1776 if the + platform does not support a date function. + + Note that if the system itself fails to deliver a correct date to + \TeX{}, then \csx{year} will of course return an incorrect value. + \TeX{} cannot be considered Y2K compliant, in this sense, on a +system that is not itself Y2K compliant. +\item[Macros:] \TeX{} macros can in principle perform calculations on + the basis of the value of \csx{year}. + The \Qref*{LaTeX suite}{Q-latex} + performs such calculations in a small number of places; the + calculations performed in the current (supported) version of \LaTeX{} are + known to be Y2K compliant. + + Other macros and macro packages should be individually checked. +\item[External software:] Software such as \acro{DVI} translators + needs to be individually checked. +\end{description} + +\Question[Q-etex]{What is \eTeX{}?} + +While Knuth has declared that \TeX{} will never % !line break +\Qref*{change in any substantial way}{Q-TeXfuture}, there remain +things that one might wish had been done differently, or indeed +implemented at all. + +The \acro{NTS} project set out to produce an advanced replacement for +\TeX{}, to provide a basis for developing such modifications: this +``New Typesetting System'' would share Knuth's aims, but would +implement the work in a modern way taking account of the lessons +learned with \TeX{}. While a first demonstrator \acro{NTS} did +appear, it wasn't practically useful, and the project seems no longer +active. + +In parallel with its work on \acro{NTS} itself, the project developed +a set of extensions that can be used with a (``true'') \TeX{} system. +Such a modified system is known as an \eTeX{} system, and the concept +has proved widely successful. Indeed, current \TeX{} distributions +are delivered with most formats built with an \eTeX{}-based system (for +those who don't want them, \eTeX{}'s extensions can be disabled, leaving +a functionally standard \TeX{} system). + +The extensions range from the seemingly simple (increasing the number +of available registers from 256 to 32768) through to extremely subtle +programming support. + +\Qref*{\CONTeXT{}}{Q-context} has required \eTeX{} for its operation +for some time. + +Some \LaTeX{} packages already specify the use of \eTeX{}. Some such +packages may not work at all on a non-\eTeX{} system; others will +work, but not as well as on an \eTeX{} system. The % ! line break +\Qref*{\LaTeX{} team}{Q-LaTeX3} has announced that future \LaTeX{} +packages (specifically those from the team, as opposed to those +individually contributed) may require \eTeX{} for optimum performance. + +\Question[Q-whatpdftex]{What is \PDFTeX{}?} + +One can reasonably say that \PDFTeX{} is (today) the main stream of +\TeX{} distributions: most \LaTeX{} and \CONTeXT{} users nowadays use +\PDFTeX{} whether they know it or not (more precisely, they use +\PDFTeX{} extended by +\begin{wideversion} + \Qref*{\eTeX{}}{Q-etex}). +\end{wideversion} +\begin{narrowversion} + \eTeX{}~--- \Qref{}{Q-etex}). +\end{narrowversion} +So what is \PDFTeX{}? + +\PDFTeX{} is a development of \TeX{} that is capable of generating +typeset \acro{PDF} output in place of \acro{DVI}. \PDFTeX{} has +other capabilities, most notably in the area of fine typographic +detail (for example, its support for % ! line break +\begin{wideversion} + \Qref{optimising line breaks}{Q-overfull}), +\end{wideversion} +\begin{narrowversion} + % ( <- dummy for paren balancing + optimising line breaks~--- \Qref{}{Q-overfull}), +\end{narrowversion} +but its greatest impact to date has been in the area of +\acro{PDF} output. + +\PDFTeX{} started as a topic for H\`an \The{} Th\`anh's Master's~thesis, +and seems first to have been published in \TUGboat{} 18(4), in 1997 +(though it was certainly discussed at the \acro{TUG}'96 conference in +Russia). + +While the world was making good use of ``pre-releases'' of \PDFTeX{}, +Th\`anh used it as a test-bed for the micro-typography which was the +prime subject of his Ph.D. research. Since Th\`anh was finally +awarded his Ph.D., day-to-day maintenance and development of +\PDFTeX{}~1.0 (and later) has been in the hands of a group of +\PDFTeX{} maintainers (which includes Th\`anh); the group has managed +to maintain a stable platform for general use. + +Development of \PDFTeX{} has (in essence) stopped: the brave new world +is to be \Qref*{\LuaTeX{}}{Q-luatex}. + +\Question[Q-latex]{What is \LaTeX{}?} + +\LaTeX{} is a \TeX{} macro package, originally written by Leslie Lamport, that +provides a document processing system. \LaTeX{} allows markup to +describe the structure of a document, so that the user +need not think about presentation. By using document classes and +add-on packages, the same document can be produced in a variety of +different layouts. + +Lamport says that \LaTeX{} +``\emph{represents a balance between functionality and ease of use}''. +This shows itself as a continual conflict that leads to +the need for such things as \acro{FAQ}s: \LaTeX{} \emph{can} +meet most user requirements, but finding out \emph{how} is often +tricky. + +\Question[Q-latex2e]{What is \LaTeXe{}?} + +Lamport's last version of \LaTeX{} (\LaTeXo{}, last updated in 1992) +was superseded in 1994 by a new version (\LaTeXe{}) provided by +\Qref*{the \LaTeX{} team}{Q-LaTeX3}. +\LaTeXe{} is now the only readily-available version of +\LaTeX{}, and draws together several threads of \LaTeX{} development +from the later days of \LaTeXo{}. The ``e'' of the name is (in the +% next (ghastly) line needed to maintain typesetting +\wideonly{\Qref{official logo}{Q-logos}}\narrowonly{official logo~--- \Qref{\relax}{Q-logos}}) +% the \relax allows sanitize to cope with the line. just don't ask... +a single-stroke epsilon +(\latexhtml{\ensuremath{\varepsilon}}{ε}, supposedly +indicative of no more than a small change. + +\LaTeXe{} has several enhancements over \LaTeXo{}, but they were all +rather minor, with a view to continuity and stability rather than the +``big push'' that some had expected from the team. \LaTeXe{} +continues to this day to offer a compatibility mode in which most +files prepared for use with \LaTeXo{} will run (albeit with somewhat +reduced performance, and subject to voluminous complaints in the log +file). Differences between \LaTeXe{} and \LaTeXo{} are +outlined in a series of `guide' files that are available in every +\LaTeX{} distribution (the same directory also contains ``news'' about +each new release of \LaTeXe{}). +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\LaTeX{} guides and news]\CTANref{latexdoc} +\end{ctanrefs} +\LastEdit{2009-06-07} + +\Question[Q-latexpronounce]{How should I pronounce ``\LaTeX{}(\twee{})''?} + +Lamport never recommended how one should pronounce \LaTeX{}, but a lot +of people pronounce it `Lay \TeX{}' or perhaps `Lah \TeX{}' (with +\TeX{} pronounced as the program itself; see +\Qref[question]{the rules for TeX}{Q-TeXpronounce}). It is definitely +\emph{not} to be pronounced in the same way as the rubber-tree gum +(which would be `lay teks'). + +The \LaTeXe{} logo is supposed to end with an +\latexhtml{\ensuremath{\varepsilon}}{ε}; nevertheless, most +people pronounce the name as `\LaTeX{}-two-ee'. +\LastEdit{2009-06-08} + +\Question[Q-plainvltx]{Should I use \plaintex{} or \LaTeX{}?} + +There's no straightforward answer to this question. Many people swear +by \plaintex{}, and produce highly respectable documents using it +(Knuth is an example of this, of course). But equally, many people +are happy to let someone else take the design decisions for them, +accepting a small loss of flexibility in exchange for a saving of +(mental) effort. + +The arguments around this topic can provoke huge amounts of noise and +heat, without offering much by way of light; your best bet may be to +find out what those around you are using, and to follow them in the +hope of some support. Later on, you can always switch your +allegiance; don't bother about it. + +If you are preparing a manuscript for a publisher or journal, ask them +what markup they want before you +develop your own; many big publishers have developed their own +\AllTeX{} styles for journals and books, and insist that authors stick +closely to their markup. + +\Question[Q-LaTeXandPlain]{How does \LaTeX{} relate to \plaintex{}?} + +\LaTeX{} is a program written in the programming language \TeX{}. (In +the same sense, any \LaTeX{} document is also a program, which is +designed to run `alongside', or `inside' \LaTeX{}, whichever metaphor +you prefer.) + +\plaintex{} is also a program written in the programming language +\TeX{}. + +Both exist because writing your documents in `raw' \TeX{} would +involve much reinventing of wheels for every document. They both +serve as convenient aids to make document writing more pleasant: +\LaTeX{} is a far more extensive aid. + +\LaTeX{} is close to being a superset of \plaintex{}. Many documents +designed for \plaintex{} will work with \LaTeX{} with no more than +minor modifications (though some will require substantial work). + +Interpretation of any \AllTeX{} program involves some data-driven +elements, and \LaTeX{} has a wider range of such elements than does +\plaintex{}. As a result, the mapping from \LaTeX{} to \plaintex{} +is far less clear than that in the other direction~--- see a later +answer about \Qref*{translating to \plaintex{}}{Q-LaTeXtoPlain}. + +\Question[Q-context]{What is \CONTeXT{}?} + +\href{http://www.pragma-ade.com/}{\CONTeXT{}} is a macro package +developed by Hans Hagen of Pragma-Ade. \CONTeXT{} is a +document-production system based, like \LaTeX{}, on the \TeX{} +typesetting system. Whereas \LaTeX{} insulates the writer from +typographical details, \CONTeXT{} takes a complementary approach by +providing structured interfaces for handling typography, including +extensive support for colors, backgrounds, hyperlinks, presentations, +figure-text integration, and conditional compilation. It gives the +user extensive control over formatting while making it easy to create +new layouts and styles without learning the \TeX{} macro +language. \CONTeXT{}'s unified design avoids the package clashes that +can happen with \LaTeX{}. + +\CONTeXT{} also integrates MetaFun, a superset of \MP{} and a powerful +system for vector graphics. MetaFun can be used as a stand-alone +system to produce figures, but its strength lies in enhancing +\CONTeXT{} documents with accurate graphic elements. + +\CONTeXT{} allows the users to specify formatting commands in English, +Dutch, German, French, or Italian, and to use different typesetting +engines (\PDFTeX{}, Xe\TeX{}, Aleph, and soon \LuaTeX{}) without +changing the user interface. \CONTeXT{} is developed rapidly, often in +response to requests from the user community. + +%%% RF's original version +%% developed by Hans Hagen, originally to +%% serve the needs of his (Dutch) firm Pragma. It was designed with the +%% same general-purpose aims as \LaTeX{}, but (being younger) reflects +%% much more recent thinking about the structure of markup, etc. In +%% particular, \CONTeXT{} can customise its markup to an +%% author's language (customising modules for Dutch, English and German +%% are provided, at present). +%% +%% \CONTeXT{} is well integrated, in all of its structure, +%% with the needs of hypertext markup, and in particular with the +%% facilities offered by \Qref*{\PDFTeX{}}{Q-whatpdftex}. +%% The default installation employs a version of \PDFTeX{} built with the +%% \Qref*{\eTeX{} extensions}{Q-etex}, which allows further flexibility. + +\CONTeXT{} doesn't yet have quite such a large developer community as +does \LaTeX{}, but those developers who are active seem to have +prodigious energy. Support is available via a % ! line break +\href{http://contextgarden.net}{\acro{WIKI} site} and via the +\href{http://www.ntg.nl/mailman/listinfo/ntg-context}{mailing list}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\CONTeXT{} distribution]\CTANref{context} +\end{ctanrefs} + +\Question[Q-AMSpkg]{What are the \acro{AMS} packages (\AMSTeX{}, \emph{etc}.)?} + +\AMSTeX{} is a \TeX{} macro package, originally written by Michael Spivak for +the American Mathematical Society (\acro{AMS}) during 1983--1985 and +is described in the book ``\Qref*{The Joy of \TeX{}}{Q-books}''. +It is based on \plaintex{}, and provides many +features for producing more professional-looking maths formulas with +less burden on authors. It pays attention to the finer details of +sizing and positioning that mathematical publishers care about. The +aspects covered include multi-line displayed equations, equation +numbering, ellipsis dots, matrices, double accents, multi-line +subscripts, syntax checking (faster processing on initial +error-checking \TeX{} runs), and other things. + +As \LaTeX{} increased in popularity, authors sought to submit papers to +the \acro{AMS} in \LaTeX{}, so \AMSLaTeX{} was developed. \AMSLaTeX{} +is a collection of \LaTeX{} packages and classes that offer authors most of +the functionality of \AMSTeX{}. +The \acro{AMS} no longer recommends the use of \AMSTeX{}, and urges +its authors to use \AMSLaTeX{} instead. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\AMSTeX{} distribution]\CTANref{amstex} +\item[\nothtml{\rmfamily}\AMSLaTeX{} distribution]\CTANref{amslatex} +\end{ctanrefs} + +\Question[Q-eplain]{What is \Eplain{}?} + +The \href{http://tug.org/eplain}{\Eplain{}} +macro package expands on and extends the definitions in \plaintex{}. +\Eplain{} is not intended to provide ``generic typesetting +capabilities'', as do \CONTeXT{}, \LaTeX{} or +\Qref*{Texinfo}{Q-texinfo}. Instead, it defines macro tools that +should be useful whatever commands you choose to use when you prepare +your manuscript. + +For example, \Eplain{} does not have a command \csx{section}, +which would format section headings in an ``appropriate'' way, as +\LaTeX{}'s \csx{section} does. The philosophy of \Eplain{} is that +some people will always need or want to go beyond the macro designer's +idea of ``appropriate''. Such canned macros are fine~--- as long as you +are willing to accept the resulting output. If you don't like the +results, or if you are trying to match a different format, you are out +of luck. + +On the other hand, almost everyone would like capabilities such as +cross-referencing by labels, so that you don't have to put actual page +numbers in the manuscript. The authors of \Eplain{} believe it is the +only generally available macro package that does not force its +typographic style on an author, and yet provides these such capabilities. + +Another useful feature of \Eplain{} is the ability to create PDF files +with hyperlinks. The cross-referencing macros can implicitly generate +hyperlinks for the cross-references, but you can also create explicit +hyperlinks, both internal (pointing to a destination within the +current document) and external (pointing to another local document or +a URL). + +Several \LaTeX{} packages provide capabilities which \plaintex{} +users are lacking, most notably text colouring and rotation provided by +the \Package{graphics} bundle (packages \Package{color} and +\Package{graphics}). Although the \Package{graphics} bundle provides +a \plaintex{} ``loader'' for some of the packages, it is not a +trivial job to pass options to those packages under \plaintex{}, and +much of the functionality of the packages is accessed through package +options. \Eplain{} extends the loader so that options can be passed +to the packages just as they are in \LaTeX{}. The following packages are +known to work with \Eplain{}: \Package{graphics}, \Package{graphicx}, +\Package{color}, \Package{autopict} (\LaTeX{} picture environment), +\Package{psfrag}, and \Package{url}. + +\href{http://tug.org/docs/html/eplain}{\Eplain{} documentation} is +available online, and there's +also a mailing list~--- sign up, or browse the list archives, via +\URL{http://tug.org/mailman/listinfo/tex-eplain} +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\Eplain{} distribution]\CTANref{eplain} +\end{ctanrefs} + +\Question[Q-lollipop]{What is Lollipop?} + +Lollipop is a macro package written by Victor Eijkhout; it was used in +the production of his book ``\emph{\TeX{} by Topic}'' (see +\Qref[question]{\AllTeX{} Tutorials}{Q-ol-books}). The manual says of +it: +\begin{quote} + Lollipop is `\TeX{} made easy'. Lollipop is a macro package that + functions as a toolbox for writing \TeX{} macros. It was my + intention to make macro writing so easy that implementing a fully + new layout in \TeX{} would become a matter of less than an hour for + an average document, and that it would be a task that could be + accomplished by someone with only a very basic training in \TeX{} + programming. + + Lollipop is an attempt to make structured text formatting available + for environments where previously only \WYSIWYG{} packages could be + used because adapting the layout is so much more easy with them than + with traditional \TeX{} macro packages. +\end{quote} + +The manual goes on to talk of ambitions to ``capture some of the +\LaTeX{} market share''; it's a very witty package, but little sign of +\htmlignore +it taking over from \LaTeX{} is detectable\dots{}\@ +\endhtmlignore +\begin{htmlversion} +it taking over from \LaTeX{} is detectable\dots{} +\end{htmlversion} +An article about Lollipop appeared in \TUGboat{} 13(3). +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Lollipop distribution]\CTANref{lollipop} +\end{ctanrefs} + +\Question[Q-texinfo]{What is Texinfo?} + +Texinfo is a documentation system that uses one source file to produce +both on-line information and printed output. So instead of writing +two different documents, one for the on-line help and the other for a +typeset manual, you need write only one document source file. When +the work is revised, you need only revise one document. By +convention, Texinfo source file names end with a \extension{texi} or +\extension{texinfo} extension. + +Texinfo is a macro language, somewhat similar to \LaTeX{}, but with +slightly less expressive power. Its appearance is of course rather +similar to any \TeX{}-based macro language, except that its macros +start with \texttt{@} rather than the |\| that's more commonly used in +\TeX{} systems. + +You can write and format Texinfo files into Info files within \acro{GNU} +\ProgName{emacs}, and read them using the \ProgName{emacs} Info +reader. You can also format Texinfo files into Info files using +\ProgName{makeinfo} and read them using \ProgName{info}, so you're not +dependent on \ProgName{emacs}. The distribution includes a +\ProgName{Perl} script, \ProgName{texi2html}, that will convert +Texinfo sources into \acro{HTML}: the language is a far better fit to +\acro{HTML} than is \LaTeX{}, so that the breast-beating agonies of +\Qref*{converting \LaTeX{} to \acro{HTML}}{Q-LaTeX2HTML} are largely +avoided. + +Finally, of course, you can also print the files, or convert them to +\acro{PDF} using \PDFTeX{}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Texinfo distribution]\CTANref{texinfo} +\end{ctanrefs} + +\Question[Q-whyfree]{If \TeX{} is so good, how come it's free?} + +It's free because Knuth chose to make it so. He is nevertheless +apparently happy +that others should earn money by selling \TeX{}-based services and +products. While several valuable \TeX{}-related tools and packages are +offered subject to restrictions imposed by the \acro{GNU} General Public +Licence (`Copyleft'), \TeX{} itself is not subject to Copyleft. + +There are commercial versions of \TeX{} available; for some users, +it's reassuring to have paid support. What is more, some of the +commercial implementations +have features that are not available in free versions. (The +reverse is also true: some free implementations have features +not available commercially.) + +This \acro{FAQ} concentrates on `free' distributions of \TeX{}, but we +do at least list the \Qref*{major vendors}{Q-commercial}. + +\Question[Q-TeXfuture]{What is the future of \TeX{}?} + +Knuth has declared that he will do no further development of \TeX{}; +he will continue to fix any bugs that are reported to him (though +bugs are rare). This decision was made soon after +\TeX{} version~3.0 was released; at each bug-fix release +the version number acquires one more digit, so that it tends to the +limit~\ensuremath{\pi} (at the time of writing, Knuth's latest release +is version 3.1415926). Knuth wants \TeX{} to be frozen at +version~\ensuremath{\pi} when he dies; thereafter, no further changes +may be made to Knuth's source. (A similar rule is applied to \MF{}; +its version number tends to the limit~\ensuremath{e}, and currently +stands at 2.718281.) + +Knuth explains his decision, and exhorts us all to respect it, in a +paper originally published in % ! line break +\href{http://tug.org/TUGboat/Articles/tb11-4/tb30knut.pdf}{\TUGboat{} 11(4)}, +and reprinted in the % ! line break +\href{http://www.ntg.nl/maps/pdf/5_34.pdf}{NTG journal MAPS}. + +There are projects (some of them long-term +projects: see, for example, +\Qref[question]{the LaTeX3 project}{Q-LaTeX3}) +%\Qref[and]{and the SGML work}{Q-SGML}) +to build substantial +new macro packages based on \TeX{}. For the even longer term, there +are various projects to build a \emph{successor} to \TeX{}; see, for example, +the +\begin{narrowversion} + \LuaTeX{}, Omega/Aleph and \ExTeX{} projects (questions +\end{narrowversion} +\Qref[\nothtml]{\LuaTeX}{Q-luatex}, +\Qref[\nothtml]{Omega/Aleph}{Q-omegaleph} and +\Qref[\nothtml]{\ExTeX{}}{Q-extex}\narrowonly{).} +\begin{wideversion} + projects. +\end{wideversion} + +\Question[Q-readtex]{Reading \AllTeX{} files} + +So you've been sent a \TeX{} file: what are you going to do with it? + +You can, of course, ``just read it'', since it's a plain text file, +but the markup tags in the document may prove distracting. Most of +the time, even \TeX{} experts will typeset a \TeX{} file before +attempting to read it. + +So, you need to typeset the document. The good news is that \TeX{} +systems are available, free, for most sorts of computer; the bad news +is that you need a pretty complete \TeX{} system even to read a single +file, and complete \TeX{} systems are pretty large. + +\TeX{} is a typesetting system that arose from a publishing project (see +\wideonly{``}\Qref[question]{what is \TeX{}}{Q-whatTeX}\wideonly{''}), +and its basic source is available free from its author. However, at +its root, it is \emph{just} a typesetting engine: even to view or to +print the typeset output, you will need ancillary programs. In short, +you need a \TeX{} \emph{distribution}~--- a collection of +\TeX{}-related programs tailored to your operating system: for details +of the sorts of things that are available, see +% beware line break +\htmlonly{``}\Qref[question]{\TeX{} distributions}{Q-TeXsystems}\htmlonly{''} +or +% beware line break +\htmlonly{``}\Qref[\htmlonly]{commercial \TeX{} distributions}{Q-commercial}\latexhtml{ (for commercial distributions)}{''}. + +But beware~--- \TeX{} makes no attempt to look like the sort of +\WYSIWYG{} system you're probably used to (see +% beware line wrap +\wideonly{``}\Qref[question]{why is \TeX{} not \WYSIWYG{}}{Q-notWYSIWYG}\wideonly{''}): +while many modern versions of \TeX{} have a compile--view cycle that +rivals the best commercial word processors in its responsiveness, what +you type is usually \emph{markup}, which typically defines a logical +(rather than a visual) view of what you want typeset. + +So there's a balance between the simplicity of the original +(marked-up) document, which can more-or-less be read in \emph{any} +editor, and the really rather large investment needed to install a +system to read a document ``as intended''. + +\Question[Q-notWYSIWYG]{Why is \TeX{} not a \WYSIWYG{} system?} + +\WYSIWYG{} is a marketing term (``What you see is what you get'') for +a particular style of text processor. \WYSIWYG{} systems are +characterised by two principal claims: that you type what you want to +print, and that what you see on the screen as you type is a close +approximation to how your text will finally be printed. + +The simple answer to the question is, of course, that \TeX{} was +conceived long before the marketing term, at a time when the marketing +imperative wasn't perceived as significant. However, that was a long +time ago: why has nothing been done with the ``wonder text processor'' +to make it fit with modern perceptions? + +There are two answers to this. First, the simple ``things \emph{have} +been done'' (but they've not taken over the \TeX{} world); and second, +``there are philosophical reasons why the way \TeX{} has developed is +ill-suited to the \WYSIWYG{} style''. +Indeed, there is a fundamental problem with applying \WYSIWYG{} techniques +to \TeX{}: the complexity of \TeX{} makes it hard to get the +equivalent of \TeX{}'s output without actually running \TeX{}. + +A celebrated early system offering ``\WYSIWYG{} using \TeX{}'' came from the +Vor\TeX{} project: a pair of (early) Sun workstations worked in +tandem, one handling the user interface while the other beavered away +in the background typesetting the result. Vor\TeX{} was quite +impressive for its time, but the two workstations combined had hugely less +power than the average sub-thousand dollar Personal Computer +nowadays, and its code has not proved portable (it never even made the +last `great' \TeX{} version change, at the turn of the 1990s, to +\TeX{} version 3). Modern systems that are similar in +their approach are Lightning Textures (an extension of +Blue Sky's original \TeX{} system for the Macintosh), and Scientific +Word (which can also cooperate with a computer algebra system); both +these systems are \Qref*{commercially available}{Q-commercial}. + +The issue has of recent years started to attract attention from \TeX{} +developers, and several interesting projects addressing the +``\Qref*{\TeX{} document preparation environment}{Q-WYGexpts}'' +are in progress. + +Nevertheless, the \TeX{} world has taken a long time to latch onto the +idea of \WYSIWYG{}. +Apart from simple arrogance (``we're better, and have no need to +consider the petty doings of the commercial word processor market''), +there is a real conceptual difference between the word processor model +of the world and the model \LaTeX{} and \CONTeXT{} employ~--- the idea of +``markup''. ``Pure'' markup expresses a logical model of a document, +where every object within the document is labelled according to what +it is rather than how it should appear: appearance is deduced from the +properties of the type of object. Properly applied, markup can +provide valuable assistance when it comes to re-use of documents. + +Established \WYSIWYG{} systems find the expression of this sort of +structured markup difficult; however, markup \emph{is} starting to +appear in the lists of the commercial world's requirements, for two +reasons. First, an element of markup helps impose style on a +document, and commercial users are increasingly obsessed with +uniformity of style; and second, the increasingly pervasive use of +\acro{XML}-derived document archival formats demands it. The same +challenges must needs be addressed by \TeX{}-based document +preparation support schemes, so we are +observing a degree of confluence of the needs of the two communities: +interesting times may be ahead of us. + +\Question[Q-TUG*]{\TeX{} User Groups} + +There has been a \TeX{} User Group since very near the time \TeX{} +first appeared. That first group, \acro{TUG}, is still active and its +journal \textsl{TUGboat} continues in regular publication +with articles about \TeX{}, \MF{} and related technologies, and about +document design, processing and production. \acro{TUG} holds a yearly +conference, whose proceedings are published in \textsl{TUGboat}. + +\acro{TUG}'s \href{http://www.tug.org}{web site} is a valuable +resource for all sorts of +\TeX{}-related matters, such as details of \TeX{} software, and lists +of \TeX{} vendors and \TeX{} consultants. Back articles from +\textsl{TUGboat} are slowly (subject to copyright issues, etc.\@) +making their way to the site, too. + +Some time ago, \acro{TUG} established a ``technical council'', whose +task was to oversee the development of \TeX{}nical projects. Most +such projects nowadays go on their way without any support from +\acro{TUG}, but \acro{TUG}'s web site lists its +\htmlignore +\ifpdf +\href{http://www.tug.org/twg.html}{Technical Working Groups (\acro{TWG}s)}. +\else +Technical Working Groups (\acro{TWG}s: see +\URL{http://www.tug.org/twg.html}). +\fi +\endhtmlignore +\begin{htmlversion} +\href{http://www.tug.org/twg.html}{Technical Working Groups (\acro{TWG}s)}. +\end{htmlversion} + +\acro{TUG} has a reasonable claim to be considered a world-wide +organisation, but there are many national and regional user groups, +too; \acro{TUG}'s web site maintains a list of +\htmlignore +\ifpdf +\href{http://www.tug.org/lugs.html}{``Local User Groups'' (\acro{LUG}s)}. +\else +``local user groups'' (\acro{LUG}s: see +\URL{http://www.tug.org/lugs.html}). +\fi +\endhtmlignore +\begin{htmlversion} +\href{http://www.tug.org/lugs.html}{``local user groups'' (\acro{LUG}s)}. +\end{htmlversion} + +Contact \acro{TUG} itself via: +\begin{quote} + \TeX{} Users Group\\ + 1466 NW Front Avenue, Suite 3141\\ + Portland, OR 97209\\ + \acro{USA}\\[.25\baselineskip] + Tel: +1 503-223-9994\\ + Fax: +1 503-223-3960\\ + Email: \mailto{tug@mail.tug.org}\\ + Web: \URL{http://www.tug.org/} +\end{quote} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-biblio.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-biblio.tex new file mode 100644 index 00000000000..df46ef355e4 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-biblio.tex @@ -0,0 +1,1415 @@ +% $Id: faq-biblio.tex,v 1.3 2009/10/06 22:18:51 rf10 Exp rf10 $ + +\section{Bibliographies and citations} + +\subsection{Creating bibliographies} + +\Question[Q-buildbib]{Creating a \BibTeX{} bibliography file} + +A \BibTeX{} bibliography file may reasonably be compared to a small +database, the entries in which are references to literature that may +be called up by citations in a document. + +Each entry in the bibliography has a \emph{type} and a unique +\emph{key}. The bibliography is read, by \BibTeX{}, using the details +specified in a \emph{bibliography style}. From the style, \BibTeX{} +finds what entry types are permissible, what \emph{fields} each entry +type has, and how to format the whole entry. + +The type specifies the type of document you're making reference to; it +may run all the way from things like ``\environment{Book}'' and +``\environment{Proceedings}'' (which may even contain other citations +of type ``\environment{InBook}'' or ``\environment{InProceedings}'') +through dissertation styles like ``\environment{PhdThesis}'' to +otherwise-uncategorisable things such as ``\environment{Misc}''. The +unique key is something you choose yourself: it's what you use when +you want to \Qref*{cite an entry in the file}{Q-usebibtex}. People +commonly create a key that combines the (primary) author's name and +the year of publication, possibly with a marker to distinguish +publications in the same year. So, for example, the Dyson, Eddington, +Davidson paper about deflection of starlight appears in my +experimental \extension{bib} file as \texttt{Dyson20.1}. + +So, noting the rules of the style, you have `simply' to write a +bibliography database. Fortunately, there are several tools to help +in this endeavour: +\begin{itemize} +\item Most of the better \Qref*{\AllTeX{}-oriented editors}{Q-editors} + have ``\BibTeX{} modes''. +\item If you have an existing \environment{thebibliography} + environment, the \ProgName{Perl} script \ProgName{tex2bib} will + probably help. +\item There are a number of \BibTeX{} bibliography management systems + available, some of which permit a graphical user interface to the + task. Sadly, none seems to be available with the ordinary \TeX{} + distributions. + + Tools such as \ProgName{Xbibfile} (a graphical user interface), + \ProgName{ebib} (a database application written to run `inside' + \ProgName{emacs}) and + \ProgName{btOOL} (a set of \ProgName{perl} tools for building + \BibTeX{} database handlers) are available from \acro{CTAN}. + + Other systems, such as + \href{http://refdb.sourceforge.net/}{\ProgName{RefDB}}, + \href{http://www.nongnu.org/biborb}{BibORB}, + \href{http://bibdesk.sourceforge.net/}{\ProgName{BibDesk}}, + \href{http://pybliographer.org}{\ProgName{pybliographer}} and the + \ProgName{Java}-based + \href{http://freshmeat.net/projects/bibkeeper/}{\ProgName{Bibkeeper}} + and \href{http://jabref.sourceforge.net}{\ProgName{JabRef}} (which + claims to supersede \ProgName{Bibkeeper}) + are only available from their development sites. +% review of web database offerings in textex_368 +\item Some commercial citation-management systems will export in + \BibTeX{} format; an example is + \href{http://www.endnote.com/}{EndNote}. +\item Data from on-line citation databases may often be translated to + \BibTeX{} format by utilities to be found on \acro{CTAN}. For + example, the \ProgName{Perl} script \ProgName{isi2bibtex} will + translate citations from \acro{ISI} ``Web of knowledge'' (a + subscription service, available to \acro{UK} academics via + \acro{BIDS}). UK academics may translate \acro{BIDS} downloads + using \ProgName{bids.to.bibtex} +\end{itemize} +\begin{ctanrefs} +\item[bids.to.bibtex]\CTANref{bidstobibtex} +\item[btOOL]\CTANref{btOOL} +\item[ebib]\CTANref{ebib} +\item[isi2bibtex]\CTANref{isi2bibtex} +\item[tex2bib]\CTANref{tex2bib} +\item[tex2bib.readme]\CTANref{tex2bib-doc} +\item[xbibfile]\CTANref{xbibfile} +\end{ctanrefs} + +\Question[Q-custbib]{Creating a bibliography style} + +It \emph{is} possible to write your own: the standard bibliography +styles are distributed in a commented form, and there is a description +of the language (see +% beware line-wrap +\Qref[question]{BibTeX documentation}{Q-BibTeXing}). +However, it must be admitted that the language in which \BibTeX{} +styles are written is pretty obscure, and one would not recommend +anyone who's not a confident programmer to write their own, though +minor changes to an existing style may be within the grasp of many. + +If your style isn't too `far out', you can probably generate it by +using the facilities of the \Package{custom-bib} bundle. This +contains a file \File{makebst.tex}, which runs you through a text menu +to produce a file of instructions, with which you can generate your +own \extension{bst} file. This technique doesn't offer entirely new styles +of document, but the system's ``master \BibTeX{} styles'' already +offer significantly more than the \BibTeX{} standard set. +\begin{ctanrefs} +\item[\nothtml{\normalfont}\BibTeX{} documentation]\CTANref{bibtex-doc} +\item[makebst.tex]Distributed with \CTANref{custom-bib} +\end{ctanrefs} + +\Question[Q-capbibtex]{Capitalisation in \BibTeX{}} + +The standard \BibTeX{} bibliography styles impose fixed ideas about +the capitalisation of titles of things in the bibliography. While +this is not unreasonable by \BibTeX{}'s lights (the rules come from +the \emph{Chicago Manual of Style}) it can be troublesome, since +\BibTeX{} fails to recognise special uses (such as acronyms, chemical +formulae, etc.). + +The solution is to enclose the letter or letters, whose capitalisation +\BibTeX{} should not touch, in braces, as: +\begin{quote} +\begin{verbatim} +title = {The {THE} operating system}, +\end{verbatim} +\end{quote} +Sometimes you find \BibTeX{} changing the case of a single letter +inappropriately. No matter: the technique can be applied to single +letters, as in: +\begin{quote} +\begin{verbatim} +title = {Te{X}niques and tips}, +\end{verbatim} +\end{quote} +If your document design specification requires a different style of +capitalisation, you should acquire a bibliography style that doesn't +enforce \BibTeX{}'s default rules. It is definitely \emph{not} a good +idea to enclose an entire title in braces, as in +\begin{quote} +\begin{verbatim} +title = {{TeXniques and tips}}, +\end{verbatim} +\end{quote} +though that does ensure that the capitalisation is not changed. Your +\BibTeX{} database should be a general-purpose thing, not something +tuned to the requirements of a particular document or bibliography +style, or to the way you are thinking today~--- for example, on a +future occasion, you might find yourself using a different \BibTeX{} +style with different capitalisation rules. + +There's more on the subject in the +% beware line wrap +\Qref*{\BibTeX{} documentation}{Q-BibTeXing}. + +\Question[Q-bibaccent]{Accents in bibliographies} + +\BibTeX{} not only has a tendency (by default) to mess about with the +% line wrap +\Qref*{case of letters in your bibliography}{Q-capbibtex}, +also makes a hash of accent commands: +``\texttt{ma}\csx{\textasciitilde}\texttt{nana}'' comes out as ``ma +nana'' (!). The solution is similar that of the letter case problem: +enclose the troublesome sequence in braces, as +``\texttt{\{}\csx{\textasciitilde}\texttt{n\}}'', in this example. + +\Question[Q-bibstrtl]{`String too long' in \BibTeX{}} + +The \BibTeX{} diagnostic ``Warning--you've exceeded 1000, the +\texttt{global-string-size}, for entry \texttt{foo}'' usually arises +from a very large abstract or annotation included in the database. +The diagnostic usually arises because of an infelicity in the coding of +\File{abstract.bst}, or styles derived from it. (One doesn't +ordinarily output annotations in other styles.) + +The solution is to make a copy of the style file (or get a clean copy +from \acro{CTAN}~--- \CTANref{abstract-bst}), and rename it (e.g., on a +long file-name system, to \File{abstract-long.bst}). Now edit it: find +function \texttt{output.nonnull} and +\begin{itemize} +\item change its first line (line 60 in the version on \acro{CTAN}) + from + \begin{quote} +\begin{verbatim} +{ 's := +\end{verbatim} + \end{quote} +to + \begin{quote} +\begin{verbatim} +{ swap$ +\end{verbatim} + \end{quote} + Finally, +\item delete the function's last line, which just says ``\texttt{s} + (line 84 in the version on \acro{CTAN}). +\end{itemize} +Finally, change your \csx{bibliographystyle} command to refer to the +name of the new file. + +This technique applies equally to any bibliography style: the same +change can be made to any similar \texttt{output.nonnull} function. + +If you're reluctant to make this sort of change, the only way forward +is to take the entry out of the database, so that you don't encounter +\BibTeX{}'s limit, but you may need to retain the entry because it +will be included in the typeset document. In such cases, put the body +of the entry in a separate file: +\begin{quote} +\begin{verbatim} +@article{long.boring, + author = "Fred Verbose", + ... + abstract = "{\input{abstracts/long.tex}}" +} +\end{verbatim} +\end{quote} +In this way, you arrange that all \BibTeX{} has to deal with is the +file name, though it will tell \TeX{} (when appropriate) to include +all the long text. + +\Question[Q-manyauthor]{\BibTeX{} doesn't understand lists of names} + +\BibTeX{} has a strict syntax for lists of authors' (or editors') +names in the \BibTeX{} data file; if you write the list of names in a +``natural''-seeming way, the chances are you will confuse \BibTeX{}, +and the output produced will be quite different from what you had +hoped. + +Names should be expressed in one of the forms +\begin{quote} +\begin{verbatim} +First Last +Last, First +Last, Suffix, First +\end{verbatim} +\end{quote} +and lists of names should be separated with ``\texttt{and}''. +For example: +\begin{quote} +\begin{verbatim} +AUTHOR = {Fred Q. Bloggs, John P. Doe \& + Another Idiot} +\end{verbatim} +\end{quote} +falls foul of two of the above rules: a syntactically significant +comma appears in an incorrect place, and `\csx{\&}' is being used as a +name separator. The output of the above might be something like: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +John P. Doe \& Another Idiot Fred Q. Bloggs +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +John P. Doe \& Another Idiot + Fred Q. Bloggs +\end{verbatim} +\end{narrowversion} +\end{quote} +because ``John P. Doe \& Another Idiot has become the `first name', +while ``Fred Q. Bloggs'' has become the `last name' of a single +person. The example should have been written: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +AUTHOR = {Fred Q. Bloggs and + John P. Doe and + Another Idiot} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +AUTHOR = {Fred Q. Bloggs and John P. Doe and + Another Idiot} +\end{verbatim} +\end{wideversion} +\end{quote} +Some bibliography styles implement clever acrobatics with very long +author lists. You can force truncation by using the pseudo-name +``\texttt{others}'', which will usually translate to something like +``\emph{et al}'' in the typeset output. So, if Mr.~Bloggs wanted to +distract attention from his co-authors, he would write: +\begin{quote} +\begin{verbatim} +AUTHOR = {Fred Q. Bloggs and others} +\end{verbatim} +\end{quote} + +\Question[Q-citeURL]{\acro{URL}s in \BibTeX{} bibliographies} + +There is no citation type for \acro{URL}s, \emph{per se}, in the +standard \BibTeX{} styles, though Oren Patashnik (the author of +\BibTeX{}) is believed to be considering developing one such for use +with the long-awaited \BibTeX{} version~1.0. + +The actual information that need be available in a citation of an +\acro{URL} is discussed at some length in the publicly available +on-line +\begin{narrowversion} + extracts of \acro{ISO}~690--2, available via + \URL{http://www.nlc-bnc.ca/iso/tc46sc9/standard/690-2e.htm}; + % checked 2004-01-15 +\end{narrowversion} +\begin{wideversion} +\href{http://www.nlc-bnc.ca/iso/tc46sc9/standard/690-2e.htm}{extracts of \acro{ISO}\nobreakspace690--2}; +\end{wideversion} +the techniques below do \emph{not} satisfy all the requirements of +\acro{ISO}~690--2, but they offer a solution that is at least +available to users of today's tools. + +Until the new version of \BibTeX{} arrives, the simplest technique is +to use the \texttt{howpublished} field of the standard styles' \texttt{@misc} +function. Of course, the strictures +about \Qref*{typesetting \acro{URL}s}{Q-setURL} still apply, so the +entry will look like: +\begin{quote} +\begin{verbatim} +@misc{..., + ..., + howpublished = "\url{http://...}" +} +\end{verbatim} +\end{quote} +A possible alternative approach is to use \BibTeX{} styles other than +the standard ones, that already have \acro{URL} entry types. +Candidates are: +\begin{itemize} +\item The \Package{natbib} styles (\Package{plainnat}, + \Package{unsrtnat} and \Package{abbrevnat}), which are extensions of + the standard styles, principally for use with \Package{natbib} + itself. However, they've acquired \acro{URL}s and other ``modern'' + entries along the way. The same author's \Package{custom-bib} is + also capable of generating styles that honour \acro{URL} entries. +\item The \Package{babelbib} bundle, which offers % ! line break + \Qref*{multilingual bibliographies}{Q-i18nbib}, similarly provides a + set of standard-style equivalents that have \acro{URL} entries. +\item More modern styles such as the \Package{harvard} package (if the + citation styles are otherwise satisfactory for you). + \Package{Harvard} bibliography styles all include a ``\texttt{url}'' + field in their specification; however, the typesetting offered is + somewhat feeble (though it does recognise and use + \ProgName{LaTeX2HTML} macros if they are available, to create + hyperlinks). +\end{itemize} +You can also acquire new \BibTeX{} styles by use of Norman Gray's +\Package{urlbst} system, which is based on a \ProgName{Perl} script +that edits an existing \BibTeX{} style file to produce a new +style. The new style thus generated has a \texttt{webpage} entry type, and +also offers support for \texttt{url} and \texttt{lastchecked} fields +in the other entry types. The \ProgName{Perl} script comes with a set +of converted versions of the standard bibliography styles. + +Another possibility is that some conventionally-published paper, +technical report (or even book) is also available on the Web. In such +cases, a useful technique is something like: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +@techreport{..., + ..., + note = "Also available as \url{http://...}" +} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +@techreport{..., + ..., + note = "Also available as + \url{http://...}" +} +\end{verbatim} +\end{narrowversion} +\end{quote} +There is good reason to use the \Package{url} or \Package{hyperref} +packages in this context: \BibTeX{} has a habit of splitting +lines it considers excessively long, and if there are no space +characters for it to use as `natural' breakpoints, \BibTeX{} will +insert a comment (`\texttt{\textpercent}') character~\dots{}\@ which +is an acceptable character in an \acro{URL}. Any current version of the +\Package{url} or \Package{hyperref} package detects this +``\texttt{\textpercent}--end-of-line'' structure in its argument, and +removes it. +\begin{ctanrefs} +\item[babelbib \nothtml{\rmfamily}bundle]\CTANref{babelbib} +\item[custom-bib \nothtml{\rmfamily}bundle]\CTANref{custom-bib} +\item[harvard.sty]\CTANref{harvard} +\item[hyperref.sty]\CTANref{hyperref} +\item[natbib \nothtml{\rmfamily}styles]\CTANref{natbib} +\item[url.sty]\CTANref{url} +\item[urlbst]\CTANref{urlbst} +\end{ctanrefs} + +\Question[Q-bibplain]{Using \BibTeX{} with \plaintex{}} + +The file \File{btxmac.tex} (which is part of the \Eplain{} system) +contains macros and documentation for using \BibTeX{} with +\plaintex{}, either directly or with \Qref*{\Eplain{}}{Q-eplain}. See +\Qref[question]{the use of \BibTeX{}}{Q-BibTeXing} for more +information about \BibTeX{} itself. +\begin{ctanrefs} +\item[btxmac.tex]\CTANref{btxmactex} +\item[eplain \nothtml{\rmfamily}system]\CTANref{eplain} +\end{ctanrefs} + +\Question[Q-makebib]{Reconstructing \extension{bib} files} + +Perhaps you've lost the \extension{bib} file you generated your document from, +or have been sent a document without one. Or even, you've realised +the error of building a substantial document without the benefit of +\BibTeX{}\dots{} + +The \ProgName{Perl} script, \Package{tex2bib} makes a reasonable job +of regenerating \extension{bib} files from \environment{thebibliography} +environments, provided that the original (whether automatically or +manually generated) doesn't deviate too far from the ``standard'' +styles. + +You are well-advised to check the output of the script. While it will +not usually destroy information, it can quite reasonably mislabel it. + +Documentation of the script is to be found in the file \File{tex2bib.readme} +\begin{ctanrefs} +\item[tex2bib]\CTANref{tex2bib} +\item[tex2bib.readme]\CTANref{tex2bib-doc} +\end{ctanrefs} + +\Question[Q-bibprefixsort]{\BibTeX{} sorting and name prefixes} + +\BibTeX{} recognises a bewildering array of name prefixes (mostly +those deriving from European language names); it ignores the prefixes +when sorting the bibliography~--- you want ``Ludwig van Beethoven'' +sorted under ``Beethoven'', not under ``van''. (Lamport made a witty +deliberate mistake with Beethoven's name, in the first edition of his +\LaTeX{} manual.) + +However, a recurring issue is the desire to quote Lord Rayleigh's +publications (``Lord'' isn't an acceptable prefix), or names from +languages that weren't considered when \BibTeX{} was designed such as +``al-Wakil'' (transcribed from the Arabic). What's needed is a +separate ``sort key'', but \BibTeX{} only allows such a thing in +citations of items that have no author or editor. + +The solution is to embed the sort key in the author's name, but to +prevent it from being typeset. Patashnik recommends a command +\csx{noopsort} (no-output-sortkey), which is defined and used as +follows: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +@PREAMBLE{ {\providecommand{\noopsort}[1]{}} } +... +@ARTICLE{Rayleigh1, +AUTHOR = "{\noopsort{Rayleigh}}{Lord Rayleigh}", +... +} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +@PREAMBLE{ + {\providecommand{\noopsort}[1]{}} +} +... +@ARTICLE{Rayleigh1, +AUTHOR = + "\noopsort{Rayleigh}{Lord Rayleigh}", +... +} +\end{verbatim} +\end{narrowversion} +\end{quote} +Note that this \csx{noopsort} applies to the last name in this kind of +construct, so an author with an Arabic name might be rendered: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +... +AUTHOR = "Ali {\noopsort{Hadiidii}}{al-Hadiidii}", +... +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +... +AUTHOR = + "Ali {\noopsort{Hadiidii}}{al-Hadiidii}", +... +\end{verbatim} +\end{quote} +\end{narrowversion} +A further use might deal with word order games, as in the famous +Vietnamese name: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +... +AUTHOR = "\noopsort{Thanh Han The}{Han The Thanh}", +... +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +... +AUTHOR = + "\noopsort{Thanh Han The}{Han The Thanh}", +... +\end{verbatim} +\end{quote} +\end{narrowversion} +though that author seems well-acquainted with Western confusion about +the significance of the parts of his name (even to the extent of +missing out the accentuation, as above\dots{}). + +\Question[Q-bibtranscinit]{`Multi-letter' initials in \BibTeX{}} +\keywords{compound initials, transcribed initials} + +If your bibliographic style uses initials~+ surname, you may encounter +a problem with some transcribed names (for example, Russian ones). +Consider the following example from the real world: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +@article{epifanov1997, + author = {Epifanov, S. Yu. and + Vigasin, A. A.}, + title = ... +} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +@article{epifanov1997, + author = {Epifanov, S. Yu. and Vigasin, A. A.}, + title = ... +} +\end{verbatim} +\end{wideversion} +\end{quote} +Note that the ``Yu'' is the initial, not a complete name. However, +\BibTeX{}'s algorithms will leave you with a citation~--- +slightly depending on the bibliographic style~--- that reads: +``S. Y. Epifanov and A. A. Vigasin, \dots{}''. instead of the intended +``S. Yu. Epifanov and A. A. Vigasin, \dots{}''. + +One solution is to replace each affected initial by a command that +prints the correct combination. To keep your bibliography portable, +you need to add that command to your bibliography with the +\texttt{@preamble} directive: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +@preamble{ {\providecommand{\BIBYu}{Yu} } } + +@article{epifanov1997, + author = {Epifanov, S. {\BIBYu}. and + Vigasin, A. A.}, + title = ... +} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +@preamble{ {\providecommand{\BIBYu}{Yu} } } + +@article{epifanov1997, + author = {Epifanov, S. {\BIBYu}. and Vigasin, A. A.}, + title = ... +} +\end{verbatim} +\end{wideversion} +\end{quote} +If you have many such commands, you may want to put them in a separate +file and \csx{input} that \LaTeX{} file in a \texttt{@preamble} +directive. + +An alternative is to make the transcription look like an accent, from +\BibTeX{}'s point of view. For this we need a control sequence that +does nothing: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +@article{epifanov1997, + author = {Epifanov, S. {\relax Yu}. and Vigasin, A. A.}, + title = ... +} +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +@article{epifanov1997, + author = {Epifanov, S. {\relax Yu}. and + Vigasin, A. A.}, + title = ... +} +\end{verbatim} +\end{quote} +\end{narrowversion} +Like the solution by generating extra commands, this involves tedious +extra typing; which of the two techniques is preferable for a given +bibliography will be determined by the names in it. It should be +noted that a preamble that introduces lots of odd commands is usually +undesirable if the bibliography is a shared one. + +``Compound'' initials (for single names made up of two or more words) +may be treated in the same way, so one can enter Forster's rather +complicated name as: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +@article{forster2006, + author = {Forster, P.M. {\relax de F.} and Collins, M.}, + title = ... +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +@article{forster2006, + author = {Forster, P.M. {\relax de F.} and + Collins, M.}, + title = ... +\end{verbatim} +\end{quote} +\end{narrowversion} +The same trick can be played if you're entering whole names: +\begin{quote} +\begin{verbatim} +... + author = {Epifanov, Sasha {\relax Yu}ri and +... +\end{verbatim} +\end{quote} +(though no guarantee, that either of those names is right, is +offered!) +However, if you're typing the names in the ``natural'' (Western) way, +with given names first, the trick: +\begin{quote} +\begin{verbatim} +... + author = {P.M. {\relax de F.} Forster and +... +\end{verbatim} +\end{quote} +doesn't work~--- ``de F. Forster'' is treated as a compound family +names. + + +\subsection{Creating citations} + +\Question[Q-usebibtex]{``Normal'' use of \BibTeX{} from \LaTeX{}} + +To create a bibliography for your document, you need to perform a +sequence of steps, some of which seem a bit odd. If you choose to use +\BibTeX{}, the sequence is: + +First: you need a \BibTeX{} bibliography file (a \extension{bib} file)~--- see +\nothtml{``creating a \BibTeX{} file'' (\Qref[question]{}{Q-buildbib}).} +\begin{htmlversion} +``\Qref[question]{creating a \BibTeX{} file}{Q-buildbib}''. +\end{htmlversion} + +Second: you must write your \LaTeX{} document to include a declaration +of the `style' of bibliography, citations, and a reference to the +bibliography file mentioned in the step 1. So we may have a \LaTeX{} +file containing: +\begin{quote} +\begin{verbatim} +\bibliographystyle{plain} +... +Pooh is heroic~\cite{Milne:1926}. +... +Alice struggles~\cite{Carroll:1865}. +... +\bibliography{mybooks} +\end{verbatim} +\end{quote} +Note: we have bibliography style \Package{plain}, above, which is +nearly the simplest of the lot: a sample text, showing the sorts of +style choices available, can be found on Ken Turner's web site: +\URL{http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html} + +Third: you must process the file. +\begin{quote} +\begin{verbatim} +latex myfile +\end{verbatim} +\end{quote} +As \LaTeX{} processes the file, the \csx{bibliographystyle} command +writes a note of the style to the \extension{aux} file; each +\csx{cite} command writes a note of the citation to the +\extension{aux} file, and the \csx{bibliography} command writes a note +of which \extension{bib} file is to be used, to the \extension{aux} file. + +Note that, at this stage, \LaTeX{} isn't ``resolving'' any of the +citations: at every \csx{cite} command, \LaTeX{} will warn you of the +undefined citation, and when the document finishes, there will be a +further warning of undefined references. + +%Some bibliography styles are designed to work with particular +%packages... + +Fourth: you must run \BibTeX{}: +\begin{quote} +\begin{verbatim} +bibtex myfile +\end{verbatim} +\end{quote} +Don't try to tell \BibTeX{} anything but the file name: say +\texttt{bibtex myfile.aux} (because you know it's going to read the +\extension{aux} file) and \BibTeX{} will blindly attempt to process +\texttt{myfile.aux.aux}. + +\BibTeX{} will scan the \extension{aux} file; it will find which bibliography +style it needs to use, and will ``compile'' that style; it will note +the citations; it will find which bibliography files it needs, and +will run through them matching citations to entries in the +bibliography; and finally it will sort the entries that have been +cited (if the bibliography style specifies that they should be +sorted), and outputs the resulting details to a \extension{bbl} file. + +Fifth: you run \LaTeX{} again. It warns, again, that each citation is +(still) undefined, but when it gets to the \csx{bibliography} command, +it finds a \extension{bbl} file, and reads it. As it encounters each +\csx{bibitem} command in the file, it notes a definition of the +citation. + +Sixth: you run \LaTeX{} yet again. This time, it finds values for all +the citations, in its \extension{aux} file. Other things being equal, you're +done\dots{} until you change the file. + +If, while editing, you change any of the citations, or add new ones, +you need to go through the process above from steps 3 (first run of +\LaTeX{}) to 6, again, before the document is once again stable. +These four mandatory runs of \LaTeX{} make processing a document with +a bibliography even more tiresome than the normal two runs required to +resolve labels. + +To summarise: processing to resolve citations requires: \LaTeX{}; +\BibTeX{}; \LaTeX{}; \LaTeX{}. + +\Question[Q-whatbst]{Choosing a bibliography style} + +A large proportion of people are satisfied with one of Patashnik's +original ``standard'' styles, \Package{plain}, \Package{unsrt}, +\Package{abbrv} and \Package{alpha}. However, no style in that set +supports the ``author-date'' citation style that is popular in many +fields; but there are a very large number of contributed styles +available, that \emph{do} support the format. + +(Note that author-date styles arose because the simple and clear +citation style that \Package{plain} produces is so awkward in a +traditional manuscript preparation scenario. However, \TeX{}-based +document production does away with all those difficulties, leaving us +free once again to use the simple option.) + +Fortunately, help is at hand, on the Web, with this problem: +\begin{itemize} +\item a sample text, showing the sorts of style choices available, can + be found on +\begin{narrowversion} + Ken Turner's web site: + \URL{http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html}; +\end{narrowversion} +\begin{wideversion} + % ! line break + \href{http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html}{Ken Turner's web site}; +\end{wideversion} +\item an excellent survey, that lists a huge variety of styles, + sorted into their nominal topics as well as providing a good range + of examples, is the Reed College % ! line break +\begin{narrowversion} + ``Choosing a \BibTeX{} style'' + (\URL{http://web.reed.edu/cis/help/LaTeX/bibtexstyles.html}). +\end{narrowversion} +\begin{wideversion} + % ! line break + ``\href{http://web.reed.edu/cis/help/LaTeX/bibtexstyles.html}{Choosing a \BibTeX{} style}''. +\end{wideversion} +\end{itemize} + +Of course, these pages don't cover everything; the problem the +inquisitive user faces, in fact, is to find what the various available +styles actually do. This is best achieved (if the links above don't +help) by using \Package{xampl.bib} from the \BibTeX{} documentation +distribution: one can get a pretty good feel for any style one has to +hand using this ``standard'' bibliography. For style +\Package{my-style.bst}, the simple \LaTeX{} document: +\begin{quote} +\begin{verbatim} +\documentclass{article} +\begin{document} +\bibliographystyle{my-style} +\nocite{*} +\bibliography{xampl} +\end{document} +\end{verbatim} +\end{quote} +will produce a representative sample of the citations the style will +produce. (Because \Package{xampl.bib} is so extreme in some of its +``examples'', the \BibTeX{} run will also give you an interesting +selection of \BibTeX{}'s error messages\dots{}) +\begin{ctanrefs} +\item[xampl.bib]\CTANref{xampl-bib} +\end{ctanrefs} + +\Question[Q-chapbib]{Separate bibliographies per chapter?} + +A separate bibliography for each `chapter' of a document can be provided +with the package \Package{chapterbib} (which comes with a bunch of +other good bibliographic things). The package allows you a +different bibliography for each \csx{include}d file (i.e., despite the +package's name, the availability of bibliographies is related to the +component source files of the document rather than to the chapters that +logically structure the document). + +The package \Package{bibunits} ties bibliographies to logical units +within the document: the package will deal with chapters and sections +(as defined by \LaTeX{} itself) and also defines a \environment{bibunit} +environment so that users can select their own structuring. +\begin{ctanrefs} +\item[chapterbib.sty]\CTANref{cite} +\item[bibunits.sty]\CTANref{bibunits} +\end{ctanrefs} + +\Question[Q-multbib]{Multiple bibliographies?} + +If you're thinking of multiple bibliographies tied to some part of +your document (such as the chapters within the document), please see +\Qref[question]{bibliographies per chapter}{Q-chapbib}. + +For more than one bibliography, there are three options. + +The \Package{multibbl} package offers a very simple interface: you use +a command \csx{newbibliography} to define a bibliography ``tag''. The package +redefines the other bibliography commands so that each time you use any one +of them, you give it the tag for the bibliography where you want the +citations to appear. The \csx{bibliography} command itself also takes +a further extra argument that says what title to use for the resulting +section or chapter (i.e., it patches +\nothtml{\csx{refname} and \csx{bibname}~---} +\Qref{\csx{refname} and \csx{bibname}}{Q-fixnam}\nothtml{~---} in a +\Package{babel}-safe way). So one might write: +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +\usepackage{multibbl} +\newbibliography{bk} +\bibliographystyle{bk}{alpha} +\newbibliography{art} +\bibliographystyle{art}{plain} +... +\cite[pp.~23--25]{bk}{milne:pooh-corner} +... +\cite{art}{einstein:1905} +... +\bibliography{bk}{book-bib}% + {References to books} +\bibliography{art}{art-bib}% + {References to articles} +\end{verbatim} +\end{quote} +\end{narrowversion} +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\usepackage{multibbl} +\newbibliography{bk} +\bibliographystyle{bk}{alpha} +\newbibliography{art} +\bibliographystyle{art}{plain} +... +\cite[pp.~23--25]{bk}{milne:pooh-corner} +... +\cite{art}{einstein:1905} +... +\bibliography{bk}{book-bib}{References to books} +\bibliography{art}{art-bib}{References to articles} +\end{verbatim} +\end{quote} +\end{wideversion} +(Note that the optional argument of \csx{cite} appears \emph{before} the +new tag argument, and that the \csx{bibliography} commands may list +more than one \extension{bib} file~--- indeed all \csx{bibliography} commands +may list the same set of files.) + +The \csx{bibliography} data goes into files whose names are +\meta{tag-name}\emph{.aux}, so you will need to run +\begin{quote} +\begin{verbatim} +bibtex bk +bibtex art +\end{verbatim} +\end{quote} +after the first run of \LaTeX{}, to get the citations in the correct +place. + +The \Package{multibib} package allows you to define a series of +``additional topics'', each of which comes with its own series of +bibliography commands. So one might write: +\begin{quote} +\begin{verbatim} +\usepackage{multibib} +\newcites{bk,art}% + {References from books,% + References from articles} +\bibliographystylebk{alpha} +\bibliographystyleart{plain} +... +\citebk[pp.~23--25]{milne:pooh-corner} +... +\citeart{einstein:1905} +... +\bibliographybk{book-bib} +\bibliographyart{art-bib} +\end{verbatim} +\end{quote} +Again, as for \Package{multibbl}, any \csx{bibliography...} command may +scan any list of \extension{bib} files. + +\BibTeX{} processing with \Package{multibib} is much like that with +\Package{multibbl}; with the above example, one needs: +\begin{quote} +\begin{verbatim} +bibtex bk +bibtex art +\end{verbatim} +\end{quote} +Note that, unlike \Package{multibbl}, \Package{multibib} allows a +simple, unmodified bibliography (as well as the ``topic'' ones). + +The \Package{bibtopic} package allows you separately to cite several +different bibliographies. At the appropriate place in your document, +you put a sequence of \environment{btSect} environments (each of which +specifies a bibliography database to scan) to typeset the separate +bibliographies. Thus, one might have a file \File{diss.tex} containing: +\begin{quote} +\begin{verbatim} +\usepackage{bibtopic} +\bibliographystyle{alpha} +... +\cite[pp.~23--25]{milne:pooh-corner} +... +\cite{einstein:1905} +... +\begin{btSect}{book-bib} +\section{References from books} +\btPrintCited +\end{btSect} +\begin{btSect}[plain]{art-bib} +\section{References from articles} +\btPrintCited +\end{btSect} +\end{verbatim} +\end{quote} +Note the different way of specifying a bibliographystyle: if you want +a different style for a particular bibliography, you may give it as an +optional argument to the \environment{btSect} environment. + +Processing with \BibTeX{}, in this case, uses \extension{aux} files whose names +are derived from the name of the base document. So in this example +you need to say: +\begin{quote} +\begin{verbatim} +bibtex diss1 +bibtex diss2 +\end{verbatim} +\end{quote} + +There is also a command \csx{btPrintNotCited}, which gives the rest of +the content of the database (if nothing has been cited from the +database, this is equivalent to \LaTeX{} standard \cmdinvoke{nocite}{*}). + +However, the \emph{real} difference from \Package{multibbl} and +\Package{multibib} is that selection of what appears in each +bibliography section is determined in \Package{bibtopic} by what's in +the \extension{bib} files. + +An entirely different approach is taken by the \Package{splitbib} +package. You provide a \environment{category} environment, in the +preamble of your document, for each category you want a separate +citation list for. In each environment, you list the \csx{cite} keys +that you want listed in each category. The \csx{bibliography} command +(or, more precisely, the \environment{thebibliography} environment it +uses) will sort the keys as requested. (Keys not mentioned in a +\environment{category} appear in a ``misc'' category created in the +sorting process.) A code example appears in the package documentation +(a \acro{PDF} file in the \acro{CTAN} directory, +\begin{htmlversion} + which you can browse to, from the link, below). +\end{htmlversion} +\htmlignore + see the file list, below). +\endhtmlignore +\begin{ctanrefs} +\item[bibtopic.sty]\CTANref{bibtopic} +\item[multibbl.sty]\CTANref{multibbl} +\item[multibib.sty]\CTANref{multibib} +\item[splitbib.sty]\CTANref{splitbib} +\end{ctanrefs} + + +\Question[Q-bibinline]{Putting bibliography entries in text} + +This is a common requirement for journals and other publications in +the humanities. Sometimes the requirement is for the entry to appear +in the running text of the document, while other styles require that +the entry appear in a footnote. + +Options for entries in running text are +\begin{itemize} +\item The package \Package{bibentry}, which puts slight restrictions + on the format of entry that your \extension{bst} file generates, but is + otherwise undemanding of the bibliography style. +\item The package \Package{inlinebib}, which requires that you use its + \File{inlinebib.bst}. \Package{Inlinebib} was actually designed for + footnote citations: its \emph{expected} use is that you place a + citation inline as the argument of a \csx{footnote} command. +\item The package \Package{jurabib}, which was originally designed for + German law documents, and has comprehensive facilities for the + manipulation of citations. The package comes with four bibliography + styles that you may use: \File{jurabib.bst}, \File{jhuman.bst} and + two Chicago-like ones. +\end{itemize} + +Options for entries in footnotes are +\begin{itemize} +\item The package \Package{footbib}, and +\item Packages \Package{jurabib} and \Package{inlinebib}, again. +\end{itemize} +Note that \Package{jurabib} does the job using \LaTeX{}'s standard +footnotes, whereas \Package{footbib} creates its own sequence of +footnotes. Therefore, in a document which has other footnotes, it may +be advisable to use \Package{jurabib} (or of course +\Package{inlinebib}), to avoid confusion of footnotes and foot-citations. +\begin{ctanrefs} +\item[bibentry.sty]\emph{Distributed with} \CTANref{natbib} +\item[footbib.sty]\CTANref{footbib} +\item[inlinebib.sty]\CTANref{inlinebib} +\item[jurabib.sty]\CTANref{jurabib} +\end{ctanrefs} + +\Question[Q-citesort]{Sorting and compressing citations} + +If you give \LaTeX{} +\cmdinvoke{cite}{fred,joe,harry,min}, its default commands could give +something like ``[2,6,4,3]''; +this looks awful. One can of course get the things in order by +rearranging the keys in the \csx{cite} command, but who wants to do +that sort of thing for no more improvement than ``[2,3,4,6]''? + +The \Package{cite} package sorts the numbers and detects consecutive +sequences, so creating ``[2--4,6]''. The \Package{natbib} package, +with the \texttt{numbers} and \texttt{sort\&compress} options, will +do the same when working with its own numeric bibliography styles +(\File{plainnat.bst} and \File{unsrtnat.bst}). + +If you might need to make hyperreferences to your citations, +\Package{cite} isn't adequate. If you add the \Package{hypernat} +package: +\begin{verbatim} + \usepackage[...]{hyperref} + \usepackage[numbers,sort&compress]{natbib} + \usepackage{hypernat} + ... + \bibliographystyle{plainnat} +\end{verbatim} +the \Package{natbib} and \Package{hyperref} packages will interwork. +\begin{ctanrefs} +\item[cite.sty]\CTANref{cite} +\item[hypernat.sty]\CTANref{hypernat} +\item[hyperref.sty]\CTANref{hyperref} +\item[plainnat.bst]Distributed with \CTANref{natbib} +\item[unsrtnat.bst]Distributed with \CTANref{natbib} +\end{ctanrefs} + +\Question[Q-mcite]{Multiple citations} + +A convention sometimes used in physics journals is to ``collapse'' a group of +related citations into a single entry in the bibliography. \BibTeX{}, +by default, can't cope with this arrangement, but the \Package{mcite} +and \Package{mciteplus} packages deal with the problem. + +\Package{mcite} overloads the \csx{cite} command to recognise a +``\texttt{*}'' at the start of a key, so that citations of the form +\begin{quote} +\begin{verbatim} +\cite{paper1,*paper2} +\end{verbatim} +\end{quote} +appear in the document as a single citation, and appear arranged +appropriately in the bibliography itself. You're not limited to +collapsing just two references. You can mix ``collapsed'' references +with ``ordinary'' ones, as in +\begin{quote} +\begin{verbatim} +\cite{paper0,paper1,*paper2,paper3} +\end{verbatim} +\end{quote} +Which will appear in the document as 3~citations ``[4,7,11]'' +(say)~--- citation `4' will refer to paper~0, `7' will refer to a +combined entry for paper~1 and paper~2, and `11' will refer to +paper~3. + +You need to make a small change to the bibliography style +(\extension{bst}) file you use; the \Package{mcite} package +documentation tells you how to do that. + +(Despite these multiple citations being primarily a physics-oriented +requirement, the \Class{RevTeX} (Physics support) class doesn't work +with \Package{mcite}. + +The \Package{mciteplus} package adresses many of the infelicites of +\Package{mcite}, and \emph{does} work with \Class{RevTeX}. Again, +`ordinary' \extension{bst} files will not work with +\Package{mciteplus}, but the package documentation explains how to +patch an existing \BibTeX{} style. + +The \Package{collref} package takes a rather different approach to the +problem, and will work with most (if not all) \BibTeX{} packages. +\Package{Collref} spots common subsets of the references, so if it +sees a sequence +\begin{quote} +\begin{verbatim} +\cite{paper0,paper1,paper2,paper3} +... +\cite{some_other_paper,paper1,paper2,and_another} +\end{verbatim} +\end{quote} +it will collect \texttt{paper1} and \texttt{paper2} as a multiple reference. +\begin{ctanrefs} +\item[collref.sty]\CTANref{collref} +\item[mcite.sty]\CTANref{mcite} +\item[mciteplus.sty]\CTANref{mciteplus} +\item[revtex \nothtml{\rmfamily}bundle]\CTANref{revtex} +\end{ctanrefs} +\LastEdit{2009-06-09} + +\Question[Q-backref]{References from the bibliography to the citation} + +A link (or at least a page reference), from the bibliography to the +citing command, is often useful in large documents. + +Two packages support this requirement, \Package{backref} and +\Package{citeref}. \Package{Backref} is part of the +\Package{hyperref} bundle, and supports hyperlinks back to the citing +command. + +\Package{Citeref} is the older, and seems to rely on rather simpler +(and therefore possibly more stable) code; it produces a list of page +references, only. It doesn't interact well with other citation +packages (for example, \Package{cite}), which probably reflects its +antiquity (it's derived from a \LaTeXo{} package). + +Neither collapses +lists of pages (``\texttt{5, 6, 7}'' comes out as such, rather than as +``\texttt{5--7}''), but neither package repeats the reference to a page that +holds multiple citations. (The failure to collapse lists is of course +forgiveable in the case of the \Package{hyperref}-related +\Package{backref}, since the concept of multiple hyperlinks from the +same anchor is less than appealing.) +\begin{ctanrefs} +\item[backref.sty]Distributed with \CTANref{hyperref} +\item[citeref.sty]\CTANref{citeref} +\end{ctanrefs} + +\Question[Q-sortbib]{Sorting lists of citations} + +\BibTeX{} has a sorting function, and most \BibTeX{} styles sort the +citation list they produce; most people find this desirable. + +However, it is perfectly possible to write a +\environment{thebibliography} environment that \emph{looks} as if it +came from \BibTeX{}, and many people do so (in order to save time in +the short term). + +The problem arises when \environment{thebibliography}-writers decide +their citations need to be sorted. A common misapprehension is to +insert \cmdinvoke{bibliographystyle}{alpha} (or similar) and expect +the typeset output to be sorted in some magical way. \BibTeX{} +doesn't work that way!~--- if you write \environment{thebibliography}, +you get to sort its contents. \BibTeX{} will only sort the contents +of a \environment{thebibliography} environment when it creates it, to +be inserted from a \extension{bbl} file by a \csx{bibliography} command. + +\Question[Q-compactbib]{Reducing spacing in the bibliography} + +Bibliographies are, in fact, implemented as lists, so all the +confusion about \Qref*{reducing list item spacing}{Q-complist} also +applies to bibliographies. + +If the \Package{natbib} package `works' for you (it may not if you are using +some special-purpose bibliography style), the solution is relatively +simple~--- add +\begin{quote} +\begin{verbatim} +\usepackage{natbib} +\setlength{\bibsep}{0.0pt} +\end{verbatim} +\end{quote} +to the preamble of your document. + +The \Package{compactbib} package has a similar effect. Its primary +purpose is to produce two bibliographies, and it seems to preclude use +of \BibTeX{} (though the package documentation, in the package file +itself, isn't particularly clear). + +Otherwise, one is into unseemly hacking of something or other. The +\Package{mdwlist} package actually does the job, but it doesn't work +here, because it makes a different-named list, while the name +``\environment{thebibliography}'' is built into \LaTeX{} and +\BibTeX{}. Therefore, we need to % ! line break +\Qref*{patch the underlying macro}{Q-patch}: +\begin{quote} +\begin{verbatim} +\let\oldbibliography\thebibliography +\renewcommand{\thebibliography}[1]{% + \oldbibliography{#1}% + \setlength{\itemsep}{0pt}% +} +\end{verbatim} +\end{quote} +The \Package{savetrees} package performs such a patch, among a +plethora of space-saving measures: you can, in principle, suppress all +its other actions, and have it provide you a compressed bibliography +\emph{only}. +\begin{ctanrefs} +\item[compactbib.sty]\CTANref{compactbib} +\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} +\item[natbib.sty]\CTANref{natbib} +\item[savetrees.sty]\CTANref{savetrees} +\end{ctanrefs} + +\Question[Q-bibtocorder]{Table of contents rearranges ``\Package{unsrt}'' ordering} + +If you're using the \Package{unsrt} bibliography style, you're +expecting that your bibliography will \emph{not} be sorted, but that +the entries will appear in the order that they first appeared in your +document. + +However, if you're unfortunate enough to need a citation in a section +title, and you also have a table of contents, the citations that now +appear in the table of contents will upset the ``natural'' ordering +produced by the \Package{unsrt} style. Similarly, if you have +citations in captions, and have a list of figures (or tables). + +There's a pretty simple ``manual'' method for dealing with the +problem~--- when you have the document stable: +\begin{enumerate} +\item Delete the \extension{aux} file, and any of \extension{toc}, + \extension{lof}, \extension{lot} files. +\item Run \LaTeX{}. +\item Run \BibTeX{} for the last time. +\item Run \LaTeX{} often enough that things are stable again. +\end{enumerate} +Which is indeed simple, but it's going to get tedious when you've +found errors in your ``stable'' version, often enough. + +The package \Package{notoccite} avoids the kerfuffle, and suppresses +citations while in the table of contents, or lists of figures, tables +(or other floating things: the code is quite general). +\begin{ctanrefs} +\item[notoccite.sty]\CTANref{notoccite} +\end{ctanrefs} + +\Question[Q-i18nbib]{Non-english bibliographies} + +Like so much of early \AllTeX{} software, \BibTeX{}'s assumptions were +firmly rooted in what its author knew well, viz., academic papers in +English (particularly those with a mathematical bent). \BibTeX{}'s +standard styles all address exactly that problem, leaving the user who +writes in another language (or who deal with citations in the style of +other disciplines than maths) to strike out into contributed software. + +For the user whose language is not English, there are several +alternatives. The simplest is to provide translations of \BibTeX{} +styles into the required language: the solitary \Package{finplain.bst} +does that for Finnish; others one can find are for Danish +(\Package{dk-bib}), French (\Package{bib-fr}), German +(\Package{bibgerm}), Norwegian (\Package{norbib}) and Swedish +(\Package{swebib}) bundles (of which the \Package{bib-fr} set is the +most extensive). The \Package{spain} style implements a traditional +Spanish citation style. + +These static approaches solve the problem, for the languages that have +been covered by them. Unfortunately, with such an approach, a lot of +work is needed for every language involved. Two routes to a solution +of the ``general'' problem are available~--- that offered by +\Package{babelbib}, and the % ! line break +\Qref*{\Package{custom-bib} mechanism for generating styles}{Q-custbib}. + +\Package{Babelbib} (which is a development of the ideas of the +\Package{bibgerm} package) co-operates with \Package{babel} to control +the language of presentation of citations (potentially at the level of +individual items). The package has a built-in set of languages it +`knows about', but the documentation includes instructions on defining +commands for other languages. \Package{Babelbib} comes with its own +set of bibliography styles, which could be a restriction if there +wasn't also a link from \Package{custom-bib}. + +The \Package{makebst} menu of \Package{custom-bib} allows you to +choose a language for the \BibTeX{} style you're generating (there are +14 languages to choose; it looks as if \Package{spain.bst}, mentioned +above, was generated this way). If, however, you opt not to specify a +language, you are asked whether you want the style to interact with +\Package{babelbib}; if you do so, you're getting the best of both +worlds~--- formatting freedom from \Package{custom-bib} and linguistic +freedom via the extensibility of \Package{babelbib} +\begin{ctanrefs} +\item[babelbib.sty]\CTANref{babelbib} +\item[bib-fr \nothtml{\rmfamily\upshape}bundle]\CTANref{bib-fr} +\item[bibgerm \nothtml{\rmfamily\upshape}bundle]\CTANref{bibgerm} +\item[custom-bib \nothtml{\rmfamily\upshape}bundle]\CTANref{custom-bib} +\item[finplain.bst]\CTANref{finplain} +\item[norbib \nothtml{\rmfamily\upshape}bundle]\CTANref{norbib} +\item[spain]\CTANref{spain} +\item[swebib \nothtml{\rmfamily\upshape}bundle]\CTANref{swebib} +\end{ctanrefs} + +\Question[Q-formbiblabel]{Format of numbers in the bibliography} + +By default, \LaTeX{} makes entries in the bibliography look like: +\begin{quote} + [1] Doe, Joe et al. Some journal. 2004.\\ {} + [2] Doe, Jane et al. Some journal. 2003. +\end{quote} +while many documents need something like: +\begin{quote} + 1. Doe, Joe et al. Some journal. 2004.\\ + 2. Doe, Jane et al. Some journal. 2003. +\end{quote} + +This sort of change may be achieved by many of the ``general'' +citation packages; for example, in \Package{natbib}, it's as simple as: +\begin{quote} +\begin{verbatim} +\renewcommand{\bibnumfmt}[1]{#1.} +\end{verbatim} +\end{quote} +but if you're not using such a package, the following internal +\LaTeX{} commands, in the preamble of your document, will do the job: +\begin{quote} +\begin{verbatim} +\makeatletter +\renewcommand*{\@biblabel}[1]{\hfill#1.} +\makeatother +\end{verbatim} +\end{quote} +\begin{ctanrefs} +\item[natbib.sty]\CTANref{natbib} +\end{ctanrefs} + +\subsection{Manipulating whole bibliographies} + +\Question[Q-nocite*]{Listing all your \BibTeX{} entries} + +\LaTeX{} and \BibTeX{} co-operate to offer special treatment of this +requirement. The command \cmdinvoke{nocite}{*} is specially treated, +and causes \BibTeX{} to generate bibliography entries for every entry +in each \extension{bib} file listed in your \csx{bibliography} statement, so +that after a \LaTeX{}--\BibTeX{}--\LaTeX{} sequence, you have a +document with the whole thing listed. + +Note that \LaTeX{} \emph{doesn't} produce +% beware line breaks +``\texttt{Citation ... undefined}'' or +``\texttt{There were undefined references}'' warnings in respect of +\cmdinvoke{nocite}{*}. This isn't a problem if you're running +\LaTeX{} ``by hand'' (you \emph{know} exactly how many times you have +to run things), but the lack might confuse automatic processors that +scan the log file to determine whether another run is necessary. + +A couple of packages are available, that aim to reduce the impact of +\cmdinvoke{nocite}{*} of a large citation database. \Package{Biblist} +was written for use under \LaTeXo{}, but seems to work well enough; +\Package{listbib} is more modern. Both provide their own +\extension{bst} files. (The impact of large databases was significant +in the old days of \LaTeX{} systems with very little free memory; this +problem is less significant now than it once was.) +\begin{ctanrefs} +\item[biblist.sty]\CTANref{biblist} +\item[listbib.sty]\CTANref{listbib} +\end{ctanrefs} + +\Question[Q-htmlbib]{Making \acro{HTML} of your Bibliography} + +A neat solution is offered by the \Package{noTeX} bibliography style. +This style produces a \extension{bbl} file which is in fact a series of +\acro{HTML} `\texttt{P}' elements of class \texttt{noTeX}, and which +may therefore be included in an \acro{HTML} file. Provision is made +for customising your bibliography so that its content when processed by +\Package{noTeX} is different from that presented when it is processed +in the ordinary way by \AllTeX{}. + +A thorough solution is offered by \Package{bib2xhtml}; using it, you +make use of one of its modified versions of many common \BibTeX{} +styles, and post-process the output so produced using a +\ProgName{perl} script. + +A more conventional translator is the \ProgName{awk} script +\ProgName{bbl2html}, which translates the \extension{bbl} file you've generated: +a sample of the script's output may be viewed on the web, at +\URL{http://rikblok.cjb.net/lib/refs.html} +\begin{ctanrefs} +\item[bbl2html.awk]\CTANref{bbl2html} +\item[bib2xhtml]\CTANref{bib2xhtml} +\item[noTeX.bst]\CTANref{noTeX} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-bits+pieces.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-bits+pieces.tex new file mode 100644 index 00000000000..fed5b685db2 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-bits+pieces.tex @@ -0,0 +1,762 @@ +% $Id: faq-bits+pieces.tex,v 1.2 2009/08/25 20:58:46 rf10 Exp rf10 $ + +\section{Bits and pieces of \AllTeX{}} + +\Question[Q-dvi]{What is a \acro{DVI} file?} + +A \acro{DVI} file (that is, a file with the type or extension +\extension{dvi}) is \TeX{}'s main output file, using \TeX{} in its +broadest sense to include \LaTeX{}, etc. `\acro{DVI}' is supposed to +be an acronym for \acro{D}e\acro{V}ice-\acro{I}ndependent, meaning +that the file can be printed on most +kinds of typographic output device. The \acro{DVI} file is designed to be +read by a driver (\Qref{DVI drivers}{Q-driver}) to produce +further output designed specifically for a particular printer (e.g., a +LaserJet) or to be used as input to a previewer for display on a +computer screen. \acro{DVI} files use \TeX{}'s internal coding; a \TeX{} +input file should produce the same \acro{DVI} file regardless of which +implementation of \TeX{} is used to produce it. + +A \acro{DVI} file contains all the information that is needed for printing +or previewing except for the actual bitmaps or outlines of fonts, and +possibly material to be introduced by means of +\Qref*{\csx{special} commands}{Q-specials}. + +The canonical reference for the structure of a \acro{DVI} file is the +source of Knuth's program \ProgName{dvitype} (whose original purpose, +as its name implies, was to view the content of a \acro{DVI} file). +\begin{ctanrefs} +\item[dvitype]\CTANref{dvitype} +\end{ctanrefs} + +\Question[Q-driver]{What is a \acro{DVI} driver?} + +A \acro{DVI} driver is a program that takes as input a \acro{DVI} file +(\Qref{\acro{DVI} files}{Q-dvi}) and +(usually) produces a file that can be sent to a typographic +output device (which we will call a printer, for short), or to another +format. + +A driver will usually be specific to a particular printer, +although any \PS{} printer ought to be able to print +the output from a \PS{} driver. +% (these are also called \PS{} conversion programs). + +As well as the \acro{DVI} file, the driver also needs font information. +Font information may be held as bitmaps or as outlines, or simply as a +set of pointers into the fonts that the printer itself `has'. +Each driver will expect the font information in +a particular form. For more information on the forms of fonts, +see \Qref[questions]{\acro{PK} files}{Q-pk}, +% ! line break +\Qref[]{\acro{TFM} files}{Q-tfm}, +\Qref[]{virtual fonts}{Q-virtualfonts} +and \Qref[]{Using \PS{} fonts with \TeX{}}{Q-usepsfont}. + +\Question[Q-pk]{What are \acro{PK} files?} + +\acro{PK} files (packed raster) contain font bitmaps. The output +from \Qref*{\MF{}}{Q-useMF} includes a generic font (\acro{GF}) file +and the utility \ProgName{gftopk} produces the \acro{PK} file from +that. There are a lot of \acro{PK} files, as one is needed for each +font, that is each magnification (size) of each design (point) size +for each weight for each family. Further, since the \acro{PK} files +for one printer do not necessarily work well for another, the whole +set needs to be duplicated for each printer type at a site. In a +modern \TeX{} distribution, files are arranged according to the \TeX{} +directory structure \Qref*{\acro{TDS}}{Q-tds}, which has provision for +all this variety. + +\Question[Q-tfm]{What are \acro{TFM} files?} + +\acro{TFM} stands for \TeX{} Font Metrics; \acro{TFM} files hold +information about the sizes of the characters of the font in question, +and about ligatures and kerns within that font. One \acro{TFM} file is +needed for each font used by \TeX{}, that is for each design (point) +size for each weight for each family; each \acro{TFM} file serves for all +magnifications of `its' font, so that there are (typically) fewer +\acro{TFM} files than there are \acro{PK} files. \TeX{} (\LaTeX{}, etc.\@) +itself needs only to know about the sizes of characters and their +interactions with each other, but not what characters look like. By +contrast, \acro{TFM} files are not, in principle, needed by the +\acro{DVI} driver, which only needs to know about the glyphs that each +character selects, so as to print or display them. + +\Question[Q-virtualfonts]{Virtual fonts} + +Virtual fonts provide a means of collecting bits and pieces together +to make the glyphs of a font: the bits and pieces may be other glyphs, +rules and other ``basic'' typesetting commands, and the positioning +information that specifies how everything comes together. + +Things that match the concept of virtual fonts for \TeX{} were first +implemented by David Fuchs in the very early days. However, for practical +purposes for the rest of us, virtual fonts date from when Knuth +specified a format and wrote some support software, in 1989 (he +published an article in \textsl{TUGboat} at the time, and a plain text +copy is available on \acro{CTAN}). + +Virtual fonts provide a way of telling \TeX{} about something more +complicated than just a one-to-one character mapping. The entities you +define in a virtual font look like characters to \TeX{} (they appear +with their sizes in a \acro{TFM} file), but the \acro{DVI} processor may +expand them to something quite different. + +From the virtual font file, the \acro{DVI} processor learns +details of what is in the virtual font, so as to know ``what to draw, +where''. The virtual font may contain commands: +\begin{itemize} +\item just to remap the glyphs of a single font, +\item to make a composite font with glyphs drawn from several + different fonts, or +\item to build up an effect in arbitrarily complicated ways (since a + virtual font may contain anything which is legal in a \acro{DVI} + file). +\end{itemize} + +% !this has to be generated as a new paragraph by the translator, so +% leave the blank line in place +In practice, the most common use of virtual fonts is to remap +Adobe Type 1 fonts (see \Qref[question]{font metrics}{Q-metrics}), +though there has also been useful useful work building `fake' maths +fonts (by bundling glyphs from several fonts into a single virtual +font). Virtual Computer Modern fonts, making a % ! line break +\Qref*{Cork encoded}{Q-ECfonts} font from Knuth's originals by using +remapping and fragments of \acro{DVI} for single-glyph `accented +characters', were the first ``Type~1 format'' Cork-encoded Computer +Modern fonts available. + +Virtual fonts are normally created in a single \acro{ASCII} +\acro{VPL} (Virtual Property List) file, which includes both sets of +information. The \ProgName{vptovf} program is then used to the create +the binary \acro{TFM} and \acro{VF} files. + +A ``how-to'' document, explaining how to generate a \acro{VPL}, +describes the endless hours of fun that may be had, doing the job by +hand. Despite the pleasures to be had of the manual method, the +commonest way (nowadays) of generating \acro{VPL} files is to use the +\ProgName{fontinst} package, which is described in detail +\htmlonly{together with the discussion of} +\Qref[in answer]{\PS{} font metrics}{Q-metrics}. +\Package{Qdtexvpl} is another utility for creating ad-hoc virtual +fonts (it uses \TeX{} to parse a description of the virtual font, and +\ProgName{qdtexvpl} itself processes the resulting \acro{DVI} file). +\begin{ctanrefs} +\item[fontinst]\CTANref{fontinst} +\item[\nothtml{\rmfamily}Knuth on virtual fonts]\CTANref{vf-knuth} +\item[\nothtml{\rmfamily}Virtual fonts ``how to'']\CTANref{vf-howto} +\item[qdtexvpl]\CTANref{qdtexvpl} +\end{ctanrefs} + +\Question[Q-whatmacros]{What are (\TeX{}) macros} + +\TeX{} is a \emph{macro processor}: this is a computer-science-y term +meaning ``text expander'' (more or less); \TeX{} typesets text as it +goes along, but \emph{expands} each macro it finds. \TeX{}'s macros +may include instructions to \TeX{} itself, on top of the simple text +generation one might expect. + +Macros are a \emph{good thing}, since they allow the user to +manipulate documents according to context. For example, the macro +\csx{TeX} is usually defined to produce ``TEX'' with the `E' lowered, +but in these \acro{FAQ}s the default definition of the macro is +overridden, and it simply expands to the letters ``TeX''. (\emph{You} +may not think this a good thing, but the author of the macros has his +reasons~-- see \Qref[question]{\TeX{}-related logos}{Q-logos}.) + +Macro names are conventionally built from a \texttt{\textbackslash } +followed by a sequence of letters, which may be upper or lower case +(as in \csx{TeX}, mentioned above). They may also be % ! line break +\texttt{\textbackslash \meta{any single character}}, which allows all +sorts of oddities (many built in to most \TeX{} macro sets, all the +way up from the apparently simple `\csx{ }' meaning ``insert a space +here''). + +Macro programming can be a complicated business, but at their very +simplest they need little introduction~--- you'll hardly need to be +told that: +\begin{quote} +\begin{verbatim} +\def\foo{bar} +\end{verbatim} +\end{quote} +replaces each instance of \csx{foo} with the text ``bar''. The +command \csx{def} is \plaintex{} syntax for defining commands; +\LaTeX{} offers a macro \csx{newcommand} that goes some way towards +protecting users from themselves, but basically does the same thing: +\begin{quote} +\begin{verbatim} +\newcommand{\foo}{bar} +\end{verbatim} +\end{quote} +Macros may have ``arguments'', which are used to substitute for marked +bits of the macro expansion: +\begin{quote} +\begin{verbatim} +\def\foo#1{This is a #1 bar} +... +\foo{2/4} +\end{verbatim} +\end{quote} +or, in \LaTeX{} speak: +\begin{quote} +\begin{verbatim} +\newcommand{\foo}[1]{This is a #1 bar} +... +\foo{3/4} +\end{verbatim} +\end{quote} +Macro writing can get very complicated, very quickly. If you are a +beginner \AllTeX{} programmer, you are well advised to read something +along the lines of the \Qref*{\TeX{}book}{Q-books}; once you're under +way, \Qref*{\TeX{} by Topic}{Q-ol-books} is possibly a more satisfactory +choice. Rather a lot of the answers in these \acro{FAQ}s tell you +about various issues of how to write macros. + +\Question[Q-specials]{\csx{special} commands} + +\TeX{} provides the means to express things that device drivers can +do, but about which \TeX{} itself knows nothing. For example, \TeX{} +itself knows nothing about how to include \PS{} figures into +documents, or how to set the colour of printed text; but some device +drivers do. + +Instructions for such things are introduced to your document by means +of \csx{special} commands; all that \TeX{} does with these commands is +to expand their +arguments and then pass the command to the \acro{DVI} file. In most +cases, there are macro packages provided (often with the driver) that +provide a human-friendly interface to the \csx{special}; for example, +there's little point including a figure if you leave no gap for it in +your text, and changing colour proves to be a particularly fraught +operation that requires real wizardry. \LaTeXe{} +has standard graphics and colour packages that make figure inclusion, +rotation and scaling, and colour typesetting relatively +straightforward, despite the rather daunting \csx{special} commands +involved. (\CONTeXT{} provides similar support, though not by way of +packages.) + +The allowable arguments of \csx{special} depend on the device driver +you're using. Apart from the examples above, there are \csx{special} +commands in the em\TeX{} drivers (e.g., \ProgName{dvihplj}, \ProgName{dviscr}, +\emph{etc}.)~that will draw lines at arbitrary orientations, and +commands in \ProgName{dvitoln03} that permit the page to be set in +landscape orientation. + +Note that \csx{special} provides rather different facilities in \PDFTeX{} +operation: since there is no device driver around, in this context. +In \PDFTeX{}, \csx{special} is only needed to generated \acro{PDF} for +which there is no existing defined \PDFTeX{} operation. + +\Question[Q-hyphen]{How does hyphenation work in \TeX{}?} + +Everyone knows what hyphenation is: we see it in most books we read, +and (if we're alert) will spot occasional ridiculous mis-hyphenation +(at one time, British newspapers were a fertile source). + +Hyphenation styles are culturally-determined, and the same language +may be hyphenated differently in different countries~--- for example, +British and American styles of hyphenation of English are very +different. As a result, a typesetting system that is not restricted +to a single language at a single locale needs to be able to change its +hyphenation rules from time to time. + +\TeX{} uses a pretty good system for hyphenation (originally designed +by Frank Liang~--- you may view his % ! line break +\href{http://tug.org/docs/liang/}{Ph.D.\ thesis online}), and while +it's capable of missing ``sensible'' hyphenation points, it seldom +selects grossly wrong ones. The +algorithm matches candidates for hyphenation against a set of +``hyphenation patterns''. The candidates for hyphenation must be +sequences of letters (or other single characters that \TeX{} may be +persuaded to think of as letters)~--- things such as \TeX{}'s +\csx{accent} primitive interrupt hyphenation. + +Sets of hyphenation patterns are usually derived from analysis of +a list of valid hyphenations (the process of derivation, using a tool +called \Package{patgen}, is not ordinarily a participatory sport). + +The patterns for the languages a \TeX{} system is going to deal with +may only be loaded when the system is installed. To change the set of +languages, a \Qref*{partial reinstallation}{Q-newlang} is necessary. + +\TeX{} provides two ``user-level'' commands for control of +hyphenation: \csx{language} (which selects a hyphenation style), and +\csx{hyphenation} (which gives explicit instructions to the hyphenation +engine, overriding the effect of the patterns). + +The ordinary \LaTeX{} user need not worry about \csx{language}, since +it is very thoroughly managed by the \Package{babel} package; use of +\csx{hyphenation} is discussed in +\begin{wideversion} + the context of +\end{wideversion} +% beware line wrap +\Qref[question]{hyphenation failure}{Q-nohyph}. + +\Question[Q-clsvpkg]{What are \LaTeX{} classes and packages?} + +Current \LaTeX{} makes a distinction between the macros that define the +overall layout of a document, and the macros that tweak that layout +(to one extent or another) to provide what the author \emph{really} +wants. + +The distinction was not very clear in \LaTeXo{}, and after some +discussion (in the later stages of development of current \LaTeX{}) +the names ``class'' and ``package'' were applied to the two concepts. + +The idea is that a document's \emph{class} tells \LaTeX{} what sort of +document it's dealing with, while the \emph{packages} the document +loads ``refine'' that overall specification. + +On the disc, the files only appear different by virtue of their name +``extension''~--- class files are called \texttt{*.cls} while package +files are called \texttt{*.sty}. Thus we find that the \LaTeX{} +standard \Class{article} class is represented on disc by a file called +\File{article.cls}, while the \Package{footmisc} package (which +refines \Class{article}'s definition of footnotes) is represented on +disc by a file called \File{footmisc.sty}. + +The user defines the class of his document with the +\csx{documentclass} command (typically the first command in a +document), and loads packages with the \csx{usepackage} command. A +document may have several \csx{usepackage} commands, but it may have +only one \csx{documentclass} command. (Note that there are +programming-interface versions of both commands, since a class may +choose to load another class to refine its capabilities, and both +classes and packages may choose to load other packages.) + +\Question[Q-dtx]{Documented \LaTeX{} sources (\extension{dtx} files)} + +\LaTeXe{}, and most contributed macro packages, are now written in a +\Qref*{literate programming style}{Q-lit}, with source and +documentation in the +same file. This format, known as `doc', in fact originated before the +days of the \LaTeX{} project as one of the ``Mainz'' series of +packages. A documented source file conventionally has the suffix +\extension{dtx}, and will normally be `stripped' before use with +\LaTeX{}; an installation file (\extension{ins}) is normally provided, +to automate this process of removing comments for speed of loading. +To read the comments, you can run \LaTeX{} on the +\extension{dtx} file to produce a nicely formatted version of the +documented code. Several +packages can be included in one \extension{dtx} file (they're sorted +out by the \extension{ins} file), with conditional +sections, and there are facilities for indexes of macros, etc. + +Anyone can write \extension{dtx} files; the format is explained in +\Qref*{The \LaTeX{} Companion}{Q-books}, and a tutorial is available +from \acro{CTAN} (which comes with skeleton \extension{dtx} and +\extension{ins} files). + +Composition of \extension{dtx} files is supported in \ProgName{emacs} by +\Qref*{\acro{AUC}-\TeX{}}{Q-editors}. + +Another useful way of generating \extension{dtx} files is to write the +documentation and the code separately, and then to combine them using +the \ProgName{makedtx} system. This technique has particular value in +that the documentation file can be used separately to generate +\acro{HTML} output; it is often quite difficult to make % ! line break +\Qref*{\LaTeX{} to \acro{HTML} conversion}{Q-LaTeX2HTML} tools deal +with \extension{dtx} files, since they use an unusual class file. + +The \extension{dtx} files are not used by \LaTeX{} after they have been +processed to produce \extension{sty} or \extension{cls} (or whatever) +files. They need not be kept with the working system; however, for +many packages the \extension{dtx} file is the primary source of +documentation, so you may want to keep \extension{dtx} files elsewhere. + +An interesting sideline to the story of \extension{dtx} files is the +\Package{docmfp} package, which extends the model of the \Package{doc} +package to +\begin{narrowversion} + \MF{} and \MP{} (\Qref[see questions]{}{Q-MF} and \Qref[\nothtml]{}{Q-MP}) +\end{narrowversion} +\begin{wideversion} + \Qref{\MF{}}{Q-MF} and \Qref{\MP{}}{Q-MP}, +\end{wideversion} +thus permitting documented distribution of bundles containing code for +\MF{} and \MP{} together with related \LaTeX{} code. +\begin{ctanrefs} +\item[clsguide.pdf]\CTANref{clsguide} +\item[docmfp.sty]\CTANref{docmfp} +\item[docstrip.tex]Part of the \LaTeX{} distribution +\item[DTX tutorial]\CTANref{dtxtut} +\item[makedtx]\CTANref{makedtx} +\end{ctanrefs} + +\Question[Q-whatenc]{What are encodings?} + +Let's start by defining two concepts, the \emph{character} and the +\emph{glyph}. +The character is the abstract idea of the `atom' of a +language or other dialogue: so it might be a letter in an alphabetic +language, a syllable in a syllabic language, or an ideogram in an +ideographic language. The glyph is the mark created on screen or +paper which represents a character. Of +course, if reading is to be possible, there must be some agreed +relationship between the glyph and the character, so while the precise +shape of the glyph can be affected by many other factors, such as the +capabilities of the writing medium and the designer's style, the +essence of the underlying character must be retained. + +Whenever a computer has to represent characters, someone has to define +the relationship between a set of numbers and the characters they +represent. This is the essence of an encoding: it is a mapping +between a set of numbers and a set of things to be represented. + +\TeX{} of course deals in encoded characters all the time: the +characters presented to it in its input are encoded, and it emits +encoded characters in its \acro{DVI} (or \acro{PDF}) output. These +encodings have rather different properties. + +The \TeX{} input stream was pretty unruly back in the days when Knuth +first implemented the language. Knuth himself prepared documents on +terminals that produced all sorts of odd characters, and as a result +\TeX{} contains some provision for translating the input encoding to +something regular. Nowadays, +the operating system translates keystrokes into a code appropriate for +the user's language: the encoding used is often a national or +international standard, though many operating systems use ``code +pages'' defined by Microsoft. These standards and code pages often +contain characters that can't appear in the \TeX{} system's input +stream. Somehow, these characters have to be dealt with~--- so +an input character like ``\'e'' needs to be interpreted by \TeX{} in +a way that that at least mimics the way it interprets ``\csx{'}\texttt{e}''. + +The \TeX{} output stream is in a somewhat different situation: +characters in it are to be used to select glyphs from the fonts to be +used. Thus the encoding of the output stream is notionally a font +encoding (though the font in question may be a +% beware line break (twice) +\nothtml{virtual one~--- see }% +\Qref[question]{virtual font}{Q-virtualfonts}). In principle, a +fair bit of what appears in the output stream could be direct +transcription of what arrived in the input, but the output stream +also contains the product of commands in the input, and translations +of the input such as ligatures like % +\texttt{fi}\nothtml{\ensuremath\Rightarrow``fi''}. + +Font encodings became a hot topic when the +\Qref*{Cork encoding}{Q-ECfonts} +appeared, because of the possibility of suppressing +\csx{accent} commands in the output stream (and hence improving the +quality of the hyphenation of text in inflected languages, which is +interrupted by the \csx{accent} commands~--- see +% beware line break +\Qref[question]{``how does hyphenation work''}{Q-hyphen}). +To take advantage of the diacriticised characters represented in the +fonts, it is necessary to arrange that whenever the +command sequence ``\csx{'}\texttt{e}'' has been input +(explicitly, or implicitly via the sort of mapping of input mentioned +above), the character that codes the position of the ``\'e'' glyph is +used. + +Thus we could have the odd arrangement that the diacriticised character in +the \TeX{} input stream is translated into \TeX{} commands that would +generate something looking like the input character; this sequence of +\TeX{} commands is then translated back again into a single +diacriticised glyph as the output is created. This is in fact +precisely what the \LaTeX{} packages \Package{inputenc} and +\Package{fontenc} do, if operated in tandem on (most) characters in +the \acro{ISO}~Latin-1 input encoding and the \acro{T}1 font encoding. +At first sight, it seems eccentric to have the first package do a thing, and +the second precisely undo it, but it doesn't always happen that way: +most font encodings can't match the corresponding input encoding +nearly so well, and the two packages provide the sort of symmetry the +\LaTeX{} system needs. + +\Question[Q-ECfonts]{What are the \acro{EC} fonts?} + +A font consists of a number of \emph{glyphs}. In order that the +glyphs may be printed, they are \Qref*{\emph{encoded}}{Q-whatenc}, and +the encoding is used as an index into tables within the font. For +various reasons, Knuth chose deeply eccentric encodings for his +Computer Modern family of fonts; in particular, he chose different +encodings for different fonts, so that the application using the fonts +has to remember which font of the family it's using before selecting a +particular glyph. + +When \TeX{} version 3 arrived, most of the excuses for the +eccentricity of Knuth's encodings went away, and at \acro{TUG}'s Cork +meeting, an encoding for a set of 256 glyphs, for use in \TeX{} text, +was defined. The intention was that these glyphs should cover `most' +European languages that use Latin alphabets, in the sense of including +all accented letters needed. (Knuth's \acro{CMR} fonts missed things +necessary for Icelandic and Polish, for example, but the Cork +fonts have them. Even Cork's coverage isn't complete: it misses +letters from Romanian, Eastern and Northern Sami, and Welsh, at +least. The Cork encoding does contain ``\acro{NG}'' glyphs that +allows it to support Southern Sami.) \LaTeX{} refers to the +Cork encoding as \acro{T}1, and +provides the means to use fonts thus encoded to avoid problems with +the interaction of accents and hyphenation % ! line break +(see \Qref[question]{hyphenation of accented words}{Q-hyphenaccents}). + +The only \MF{}-fonts that conform to the Cork encoding are the +\acro{EC} fonts. They look \acro{CM}-like, though their metrics +differ from \acro{CM}-font metrics in several areas. The fonts are +now regarded as `stable' (in the same sense that the \acro{CM} fonts +are stable: their metrics are unlikely ever to change). Their serious +disadvantages for the casual user are their size (each \acro{EC} font +is roughly twice the size of the corresponding \acro{CM} font), and +there are far more of them than there are \acro{CM} fonts. The simple +number of fonts proved problematic in the production of Type~1 +versions of the fonts, but \acro{EC} or \acro{EC}-equivalent fonts in +Type~1 or TrueType form (the latter only from +\begin{wideversion} + \Qref{commercial suppliers}{Q-commercial}). +\end{wideversion} +\begin{narrowversion} + % ( <- paren matching + commercial suppliers~--- \Qref{question}{Q-commercial}). +\end{narrowversion} +Free \Qref*{auto-traced versions}{Q-textrace}~--- the \acro{CM}-super +and the \acro{LGC} fonts, and the Latin Modern series (rather +directly generated from \MF{} sources), are available. + +%% Unfortunately, until corresponding fonts for mathematics are produced, +%% the \acro{CM} fonts must be retained, since some mathematical symbols +%% are drawn from text fonts in the \acro{CM} encodings. +Note that the Cork encoding doesn't cover mathematics (and neither do +``\acro{T}1-encoded'' font families, of course). If you're using +Computer-Modern-alike fonts, this doesn't actually matter: your system +will have the original Computer Modern mathematical fonts (or the those +distributed with the Latin Modern set), which cover `basic' +\TeX{} mathematics; more advanced mathematics are likely to need +separate fonts anyway. Suitable mathematics fonts for use with other +font families are discussed in % ! line break +``\Qref*{choice of scalable fonts}{Q-psfchoice}''. + +The \acro{EC} fonts are distributed with a +set of `Text Companion' (\acro{TC}) fonts that provide glyphs for +symbols commonly used in text. The \acro{TC} fonts are encoded +according to the \LaTeX{} \acro{TS}1 encoding, and are not viewed as +`stable' in the same way as are the \acro{EC} fonts are. + +The Cork encoding is also implemented by virtual fonts provided in the +\Qref*{\acro{PSNFSS} system}{Q-usepsfont}, +for Adobe Type~1 fonts, and also by the \Package{txfonts} and +\Package{pxfonts} font packages +% beware line wrap +(see \Qref[question]{``choice of scalable fonts''}{Q-psfchoice}). +\begin{ctanrefs} +\item[CM-super fonts]\CTANref{cm-super} +\item[CM-LGC fonts]\CTANref{cm-lgc} +\item[EC and TC fonts]\CTANref{ec} +\item[Latin Modern fonts]\CTANref{lm} +\end{ctanrefs} + +\Question[Q-tds]{What is the \acro{TDS}?} + + \acro{TDS} stands for the \TeX{} Directory Structure, which is a standard +way of organising all the \TeX{}-related files on a computer system. + + Most modern distributions conform to the \acro{TDS}, which +provides for both a `standard' and a (set of) `local' hierarchies of +directories containing \TeX{}-related files. The +\acro{TDS} reserves the name \texttt{texmf} as the name of the root directory +(folder) of the hierarchies. Files supplied as part of the +distribution are put into the standard hierarchy. The location of the +standard hierarchy is system dependent, but on a Unix system it might +be at +\path{/usr/local/texmf}, or +\path{/usr/local/share/texmf}, or +\path{/opt/texmf}, or +a similar location, but in each case the \TeX{} files will be under the +\path{/texmf} subdirectory. + +There may be more than on `local' hierarchy in which additional files +can be stored. In the extreme an installation can have a local +hierarchy and each user can also have an individual local hierarchy. The +location of any local hierarchy is not only system dependent but also user +dependent. Again, though, all files should be put under a local \path{/texmf} +directory. + +The \acro{TDS} is published as the output of a \acro{TUG} % beware line wrap +\Qref*{Technical Working Group}{Q-TUG*}. +You may browse an \href{http://tug.org/tds/}{on-line version} of the +standard, and copies in several other formats (including source) are +available on \acro{CTAN}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\acro{TDS} specification]\CTANref{tds} +\end{ctanrefs} + +\Question[Q-eps]{What is ``Encapsulated \PS{}'' (``\acro{EPS}'')?} + +\PS{} has been for many years a \emph{lingua franca} of powerful +printers (though modern high-quality printers now tend to require some +constrained form of Adobe Acrobat, instead); since \PS{} is also a +powerful graphical programming language, it is commonly used as an +output medium for drawing (and other) packages. + +However, since \PS{} \emph{is} such a powerful language, some +rules need to be imposed, so that the output drawing may be included +in a document as a figure without ``leaking'' (and thereby destroying +the surrounding document, or failing to draw at all). + +Appendix \acro{H} of the \PS{} Language Reference Manual (second +and subsequent editions), specifies a set of rules for \PS{} to +be used as figures in this way. The important features are: +\begin{itemize} +\item certain ``structured comments'' are required; important ones are + the identification of the file type, and information about the + ``bounding box'' of the figure (i.e., the minimum rectangle + enclosing it); +\item some commands are forbidden~--- for example, a \texttt{showpage} + command will cause the image to disappear, in most \TeX{}-output + environments; and +\item ``preview information'' is permitted, for the benefit of things + such as word processors that don't have the ability to draw + \PS{} in their own right~--- this preview information may be in + any one of a number of system-specific formats, and any viewing + program may choose to ignore it. +\end{itemize} +A \PS{} figure that conforms to these rules is said to be in +``Encapsulated \PS{}'' (\acro{EPS}) format. Most \AllTeX{} packages for +including \PS{} are structured to use Encapsulated \PS{}; +which of course leads to much hilarity as exasperated \AllTeX{} users +struggle to cope with the output of drawing software whose authors +don't know the rules. + +\Question[Q-adobetypen]{Adobe font formats} +\keywords{type1 type3} + +Adobe has specified a number of formats for files to represent fonts +in \PS{} files; this question doesn't attempt to be encyclopaedic, so +we only discuss the two formats most commonly encountered in the +\AllTeX{} context, types~1 and 3. In particular, we don't discuss the +OpenType format, whose has many advantages are somewhat ahead of the +\TeX{} world's mainstream (at time of writing). + +Adobe Type~1 format specifies a means to represent outlines of the glyphs +in a font. The `language' used is closely restricted, to ensure that +the font is rendered as quickly as possible. (Or rather, as quickly +as possible with Adobe's technology at the time the specification was +written: the structure could well be different if it were specified +now.) The format has long been the basis of the digital type-foundry +business, though nowadays most new fonts are released in OpenType format. + +%% Type~1 fonts are directly supported by some operating system software, +%% and at least one \TeX{} system, the commercial % line break! +%% \Qref*{\YandY{} system}{Q-commercial}, bases its entire +%% operation on the use of Type~1 fonts. + +In the \AllTeX{} context, Type~1 fonts are extremely important. Apart +from their simple +availability (there are thousands of commercial Type~1 text fonts around), the +commonest reader for \acro{PDF} files has long (in effect) \emph{insisted} on +their use (see below). + +Type~3 fonts have a more forgiving specification. A wide range of +\PS{} operators is permissible, including bitmap specifiers. Type~3 +is therefore the natural format to be used for programs such as +\ProgName{dvips} when they auto-generate something to represent +\MF{}-generated fonts in a \PS{} file. It's Adobe Acrobat Viewer's +treatment of bitmap Type~3 fonts that has made direct \MF{} output +increasingly unattractive, in recent years. If you have a \acro{PDF} +document in which the text looks fuzzy and uneven in Acrobat Reader, +ask Reader for the \texttt{File}\arrowhyph{}% +\texttt{Document Properties}\arrowhyph{}% +\texttt{Fonts ...}, and it will likely show some font or other as +``Type~3'' (usually with encoding ``Custom''). The problem has +disappeared with version 6 of Acrobat Reader. See % line break +\Qref[question]{\acro{PDF} quality}{Q-dvips-pdf} for a discussion of +the issue, and for ways of addressing it. + +Type~3 fonts should not entirely be dismissed, however. Acrobat +Reader's failure with them is entirely derived from its failure to use +the anti-aliasing techniques common in \TeX{}-ware. Choose a +different set of \PS{} graphical operators, and you can make pleasing +Type~3 fonts that don't ``annoy'' Reader. For example, you may not +change colour within a Type~1 font glyph, but there's no such +restriction on a Type~3 font, which opens opportunities for some +startling effects. + +\Question[Q-resolns]{What are ``resolutions''?} + +``Resolution'' is a word that is used with little concern for its +multiple meanings, in computer equipment marketing. The word suggests +a measure of what an observer (perhaps the human eye) can resolve; yet +we regularly see advertisements for printers whose resolution is +1200dpi~--- far finer than the unaided human eye can distinguish. The +advertisements are talking about the precision with which the printer +can place spots on the printed image, which affects the fineness of +the representation of fonts, and the accuracy of the placement of +glyphs and other marks on the page. + +In fact, there are two sorts of ``resolution'' on the printed page +that we need to consider for \AllTeX{}'s purposes: +\begin{itemize} +\item the positioning accuracy, and +\item the quality of the fonts. +\end{itemize} +In the case where \AllTeX{} output is being sent direct to a printer, +in the printer's ``native'' language, it's plain that the \acro{DVI} +processor must know all such details, and must take detailed account +of both types of resolution. + +In the case where output is being sent to an intermediate distribution +format, that has potential for printing (or displaying) we know not +where, the final translator, that connects to directly to the printer +or display, has the knowledge of the device's properties: the +\acro{DVI} processor need not know, and should not presume to guess. + +Both \PS{} and \acro{PDF} output are in this category. While \PS{} is +used less frequently for document distribution nowadays, it is +regularly used as the source for distillation into \acro{PDF}; and +\acro{PDF} is the workhorse of an enormous explosion of document +distribution. + +Therefore, we need \acro{DVI} processors that will produce +``resolution independent'' \PS{} or \acro{PDF} output; of course, the +independence needs to extend to both forms of independence outlined +above. + +Resolution-independence of fonts was for a long time forced upon the +world by the feebleness of Adobe's \ProgName{Acrobat} +\ProgName{Reader} at dealing with bitmap files: a sequence of answers +starting with one aiming at the % ! line break +\Qref*{quality of \acro{PDF} from \PS{}}{Q-dvips-pdf} addresses +the problems that arise. + +Resolution-independence of positioning is more troublesome: +\ProgName{dvips} is somewhat notorious for insisting on positioning to +the accuracy of the declared resolution of the printer. +One commonly-used approach is to declare a resolution of 8000 (``better +than any device''), and this is reasonably successful though it does +have its \Qref*{problems}{Q-8000}. + +\Question[Q-fontname]{What is the ``Berry naming scheme''?} + +In the olden days, \AllTeX{} distributions were limited by the +feebleness of file systems' ability to represent long names. (The +\MSDOS{} file system was a particular bugbear: fortunately any current +Microsoft system allows rather more freedom to specify file names. +Sadly, the ISO~9660 standard for the structure of \CDROM{}s has a +similar failing, but that too has been modified by various extension +mechanisms.) + +One area in which this was a particular problem was that of file names +for Type~1 fonts. These fonts are distributed by their vendors with +pretty meaningless short names, and there's a natural ambition to +change the name to something that identifies the font somewhat +precisely. Unfortunately, names such as ``BaskervilleMT'' are +already far beyond the abilities of the typical feeble file system, +and add the specifier of a font shape or variant, and the difficulties +spiral out of control. + +Thus arose the Berry naming scheme. + +The basis of the scheme is to encode the meanings of the various parts +of the file's specification in an extremely terse way, so that enough +font names can be expressed even in impoverished file name-spaces. The +encoding allocates one letter to the font ``foundry'', two to the +typeface name, one to the weight, and so on. The whole scheme is +outlined in the \Package{fontname} distribution, which includes +extensive documentation and a set of tables of fonts whose names have +been systematised. +\begin{ctanrefs} +\item[fontname distribution]\CTANref{fontname} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex new file mode 100644 index 00000000000..cecf4d3e1bb --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex @@ -0,0 +1,1115 @@ +% $id:$ + +\section{Documentation and Help} + +\Question[Q-books]{Books on \TeX{} and its relations} + +While Knuth's book is the definitive reference for \TeX{}, there are +other books covering \TeX{}: +\begin{booklist} +\item[The \TeX{}book]by Donald Knuth (Addison-Wesley, 1984, + \ISBN{0-201-13447-0}, paperback \ISBN{0-201-13448-9}) +\item[A Beginner's Book of \TeX{}]by Raymond Seroul and Silvio Levy, + (Springer Verlag, 1992, \ISBN{0-387-97562-4}) +\item[\TeX{} by Example: A Beginner's Guide]by Arvind Borde + (Academic Press, 1992, \ISBN{0-12-117650-9}~--- now out of print) +\item[Introduction to \TeX{}]by Norbert Schwarz (Addison-Wesley, + 1989, \ISBN{0-201-51141-X}~--- now out of print) +\item[A \plaintex{} Primer]by Malcolm Clark (Oxford University + Press, 1993, ISBNs~0-198-53724-7 (hardback) and~0-198-53784-0 + (paperback)) +\item[A \TeX{} Primer for Scientists]by Stanley Sawyer and Steven + Krantz (CRC Press, 1994, \ISBN{0-849-37159-7}) +\item[\TeX{} by Topic]by Victor Eijkhout (Addison-Wesley, 1992, + \ISBN{0-201-56882-9}~--- now out of print, but see + \Qref[question]{online books}{Q-ol-books}; you can now buy a copy + printed, on demand, by Lulu~--- see + \url{http://www.lulu.com/content/2555607}) +\item[\TeX{} for the Beginner]by Wynter Snow (Addison-Wesley, 1992, + \ISBN{0-201-54799-6}) +\item[\TeX{} for the Impatient]by Paul W.~Abrahams, Karl Berry and + Kathryn A.~Hargreaves (Addison-Wesley, 1990, + \ISBN{0-201-51375-7}~--- now out of print, but see + \Qref[question]{online books}{Q-ol-books}) +\item[\TeX{} in Practice]by Stephan von Bechtolsheim (Springer + Verlag, 1993, 4 volumes, \ISBN{3-540-97296-X} for the set, or +% nos in brackets are for German distribution (Springer Verlag, Berlin) + Vol.~1: \ISBN{0-387-97595-0}, % (3-540-97595-0) + Vol.~2: \ISBN{0-387-97596-9}, % (3-540-97596-9) + Vol.~3: \ISBN{0-387-97597-7}, and % (3-540-97597-7) + Vol.~4: \ISBN{0-387-97598-5})% (3-540-97598-5) +\htmlignore +\item[\TeX{}: Starting from \sqfbox{1}\,\footnotemark]% +\footnotetext{That's `Starting from Square One'}% +\endhtmlignore +\begin{htmlversion} +\item[\TeX{}: Starting from Square One] +\end{htmlversion} + by Michael Doob (Springer + Verlag, 1993, \ISBN{3-540-56441-1}~--- now out of print) +\item[The Joy of \TeX{}]by Michael D.~Spivak (second edition, + \acro{AMS}, 1990, \ISBN{0-821-82997-1}) +\item[The Advanced \TeX{}book]by David Salomon (Springer Verlag, 1995, + \ISBN{0-387-94556-3}) +\end{booklist} +A collection of Knuth's publications about typography is also available: +\begin{booklist} +\item[Digital Typography]by Donald Knuth (CSLI and Cambridge + University Press, 1999, \ISBN{1-57586-011-2}, paperback + \ISBN{1-57586-010-4}). +\end{booklist} +\nothtml{\noindent}and in late 2000, a ``Millennium Boxed Set'' of all +5 volumes of Knuth's ``Computers and Typesetting'' series (about +\TeX{} and \MF{}) was published by Addison Wesley: +\begin{booklist} +\item[Computers \& Typesetting, Volumes A--E Boxed Set]by Donald Knuth + (Addison-Wesley, 2001, \ISBN{0-201-73416-8}). +\end{booklist} +\checked{rf}{2000/02/12 -- http://cseng.aw.com/book/0,3828,0201734168,00.html} +For \LaTeX{}, see: +\begin{booklist} +\item[\LaTeX{}, a Document Preparation System]by Leslie Lamport + (second edition, Addison Wesley, 1994, \ISBN{0-201-52983-1}) +\item[Guide to \LaTeX{}]Helmut Kopka and Patrick W.~Daly (fourth + edition, Addison-Wesley, 2004, \ISBN{0-321-17385-6}) +\item[The \LaTeX{} Companion]by Frank Mittelbach, Michel Goossens, + Johannes Braams, David Carlisle and Chris Rowley (second edition, + Addison-Wesley, 2004, \ISBN*{0-201-36299-6}{978-0-201-36299-2}) +\item[The \LaTeX{} Graphics Companion:]% + \emph{Illustrating documents with \TeX{} and \PS{}} by Michel + Goossens, Sebastian Rahtz, Frank Mittelbach, Denis Roegel and + Herbert Vo\ss{} (second edition, Addison-Wesley, 2007, + \ISBN*{0-321-50892-0}{978-0-321-50892-8}) +\item[The \LaTeX{} Web Companion:]% + \emph{Integrating \TeX{}, \acro{HTML} and \acro{XML}} by Michel + Goossens and Sebastian Rahtz (Addison-Wesley, 1999, \ISBN{0-201-43311-7}) +\item[\TeX{} Unbound:]% + \emph{\LaTeX{} and \TeX{} strategies for fonts, graphics, and more} + by Alan Hoenig (Oxford University Press, 1998, \ISBN{0-19-509685-1} + hardback, \ISBN{0-19-509686-X} paperback) +\item[Math into \LaTeX{}:]\emph{An Introduction to \LaTeX{} and \AMSLaTeX{}} + by George Gr\"atzer (third edition Birkh\"auser and Springer Verlag, + 2000, \ISBN{0-8176-4431-9}, \ISBN{3-7643-4131-9}) +\checked{RF}{2001/01/16} +%% gr\"atzer's home page +%% http://www.maths.umanitoba.ca/homepages/gratzer.html/LaTeXBooks.html +\item[Digital Typography Using \LaTeX{}]Incorporating some + multilingual aspects, and use of \Qref*{Omega}{Q-omegaleph}, by + Apostolos Syropoulos, Antonis Tsolomitis and Nick Sofroniou + (Springer, 2003, \ISBN{0-387-95217-9}). + + A list of errata for the first printing is available from: + \URL{http://www.springer-ny.com/catalog/np/jan99np/0-387-98708-8.html} +\item[First Steps in \LaTeX{}]by George Gr\"atzer (Birkh\"auser, 1999, + \ISBN{0-8176-4132-7}) +\item[\LaTeX{}: Line by Line:]% + \emph{Tips and Techniques for Document Processing} + by Antoni Diller (second edition, John Wiley \& Sons, + 1999, \ISBN{0-471-97918-X}) +\item[\LaTeX{} for Linux:]\emph{A Vade Mecum} + by Bernice Sacks Lipkin (Springer-Verlag, 1999, + \ISBN{0-387-98708-8}, second printing) +\end{booklist} +A sample of George Gr\"atzer's ``Math into \LaTeX{}'', in Adobe +Acrobat format, and example files +%for von Bechtolsheim's ``\TeX{} in Practice'', +for the three \LaTeX{} Companions, and for +Gr\"atzer's ``First Steps in \LaTeX{}'', are all available on +\acro{CTAN}. + +There's a nicely-presented list of of ``recommended books'' to be had +on the web: \URL{http://www.macrotex.net/texbooks/} + +The list of \MF{} books is rather short: +\begin{booklist} +\item[The \MF{}book]by Donald Knuth (Addison Wesley, 1986, + \ISBN{0-201-13445-4}, \ISBN{0-201-52983-1} paperback) +\end{booklist} +Alan Hoenig's `\textsl{\TeX{} Unbound}' includes some discussion and +examples of using \MF{}. + +A book covering a wide range of topics (including installation and +maintenance) is: +\begin{booklist} +\item[Making \TeX{} Work]by Norman Walsh (O'Reilly and Associates, + Inc, 1994, \ISBN{1-56592-051-1}) +\end{booklist} +The book is decidedly dated, and is now out of print, but a copy is +available via \texttt{sourceforge} and on \acro{CTAN}, +and we list it under ``\Qref*{online books}{Q-ol-books}''. + + +This list only covers books in English: notices of new books, or +warnings that books are now out of print are always welcome. However, +this \acro{FAQ} does \emph{not} carry reviews of current published material. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}First Steps in \LaTeX{}]\CTANref{gfs} +\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Companion]\CTANref{tlc2} +\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Graphics Companion]\CTANref{lgc} +\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Web Companion]\CTANref{lwc} +%\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\TeX{} in Practice]\CTANref{tip} +\item[\nothtml{\rmfamily}Sample of \nothtml{\upshape}Math into \LaTeX{}]\CTANref{mil} +\end{ctanrefs} + +\Question[Q-typebooks]{Books on Type} + + The following is a partial listing of books on typography in general. +Of these, Bringhurst seems to be the one most often recommended. +\begin{booklist} +\item[The Elements of Typographic Style]by Robert Bringhurst + (Hartley \& Marks, 1992, \ISBN{0-88179-033-8}) +\item[Finer Points in the Spacing \& Arrangement of Type]by Geoffrey Dowding + (Hartley \& Marks, 1996, \ISBN{0-88179-119-9}) +\item[The Thames \& Hudson Manual of Typography]by Ruari McLean + (Thames \& Hudson, 1980, \ISBN{0-500-68022-1}) +\item[The Form of the Book]by Jan Tschichold + (Lund Humphries, 1991, \ISBN{0-85331-623-6}) +\item[Type \& Layout]by Colin Wheildon + (Strathmore Press, 2006, \ISBN{1-875750-22-3}) +\item[The Design of Books]by Adrian Wilson + (Chronicle Books, 1993, \ISBN{0-8118-0304-X}) +\item[Optical Letter Spacing]by David Kindersley and Lida Cardozo Kindersley + % ! line break + (\href{http://www.kindersleyworkshop.co.uk/}{The Cardozo Kindersley Workshop} + 2001, \ISBN{1-874426-139}) +\end{booklist} + + There are many catalogues of type specimens but the following books provide +a more interesting overall view of types in general and some of their history. +\begin{booklist} +\item[Alphabets Old \& New]by Lewis F.~Day + (Senate, 1995, \ISBN{1-85958-160-9}) +\item[An Introduction to the History of Printing Types]by Geoffrey Dowding + (British Library, 1998, UK \ISBN{0-7123-4563-9}; USA \ISBN{1-884718-44-2}) +\item[The Alphabet Abecedarium]by Richard A.~Firmage + (David R.~Godine, 1993, \ISBN{0-87923-998-0}) +\item[The Alphabet and Elements of Lettering]by Frederick Goudy + (Dover, 1963, \ISBN{0-486-20792-7}) +\item[Anatomy of a Typeface]by Alexander Lawson + (David R.~Godine, 1990, \ISBN{0-87923-338-8}) +\item[A Tally of Types]by Stanley Morison + (David R.~Godine, 1999, \ISBN{1-56792-004-7}) +\item[Counterpunch]by Fred Smeijers + (Hyphen, 1996, \ISBN{0-907259-06-5}) +\item[Treasury of Alphabets and Lettering]by Jan Tschichold + (W.~W.~Norton, 1992, \ISBN{0-393-70197-2}) +\item[A Short History of the Printed Word]by Warren Chappell and + Robert Bringhurst (Hartley \& Marks, 1999, \ISBN{0-88179-154-7}) +\end{booklist} + + The above lists are limited to books published in English. Typographic +styles are somewhat language-dependent, and similarly the `interesting' fonts +depend on the particular writing system involved. + +\Question[Q-whereFAQ]{Where to find \acro{FAQ}s} + +Bobby Bodenheimer's article, from which this \acro{FAQ} was developed, used +to be posted (nominally monthly) to newsgroup +\Newsgroup{comp.text.tex}. The (long +obsolete) last posted copy of that article is kept on \acro{CTAN} for +auld lang syne. + +\begin{pdfversion} +A version of the \href{http://www.tex.ac.uk/faq}{present \acro{FAQ}} +may be browsed via the World-Wide Web, and its sources +\end{pdfversion} +\begin{dviversion} +A version of the present \acro{FAQ} may be browsed via the World-Wide Web, at +\acro{URL} \URL{http://www.tex.ac.uk/faq}, and its sources +\end{dviversion} +\begin{htmlversion} +The sources of the present \acro{FAQ} +\end{htmlversion} +are available from \acro{CTAN}. + +This \acro{FAQ} and others are regularly mentioned, on +\Newsgroup{comp.text.tex} and elsewhere, in a ``pointer \acro{FAQ}'' +which is also saved at \URL{http://tug.org/tex-ptr-faq} + +A 2006 innovation from Scott Pakin is the ``visual'' \LaTeX{} \acro{FAQ}. +This is a document with (mostly rubbish) text formatted so as to +highlight things we discuss here, and providing Acrobat hyper-links to +the relevant answers in this \acro{FAQ} on the Web. The visual +\acro{FAQ} is provided in \acro{PDF} format, on \acro{CTAN}; it works +best using Adobe Acrobat Reader 7 (or later); some features are +missing with other readers, or with earlier versions of Acrobat Reader + +Another excellent information source, available in English, is the +\href{http://tex.loria.fr}{\AllTeX{} navigator}. + +Both the Francophone \TeX{} user group Gutenberg and the Czech/Slovak +user group CS-TUG have published translations of this \acro{FAQ}, with +extensions appropriate to their languages. + +Herbert Vo\ss{}'s excellent % beware line break +\href{http://texnik.de/}{\LaTeX{} tips and tricks} +provides excellent advice on most topics one might imagine (though +it's not strictly a \acro{FAQ})~--- highly recommended for most +ordinary mortals' use. + +The Open Directory Project (\acro{ODP}) maintains a list of sources of +\AllTeX{} help, including \acro{FAQ}s. View the \TeX{} area at +\URL{http://dmoz.org/Computers/Software/Typesetting/TeX/} + +Other non-English \acro{FAQ}s are available (off-\acro{CTAN}): +\begin{booklist} +\item[German]Posted regularly to \Newsgroup{de.comp.tex}, and archived + on \acro{CTAN}; the \acro{FAQ} also appears at + \URL{http://www.dante.de/faq/de-tex-faq/} +\item[French]% +%% An interactive (full-screen!) FAQ may be found at +%% \URL{http://www.frenchpro6.com/screen.pdf/FAQscreen.pdf}, and a copy +%% for printing at \URL{http://frenchle.free.fr/FAQ.pdf}; + A FAQ used to be posted regularly to + \Newsgroup{fr.comp.text.tex}, and is archived on \acro{CTAN}~--- + sadly, that effort seems to have fallen by the wayside. +%% \item[Spanish]See \URL{http://apolo.us.es/CervanTeX/FAQ/} +\item[Czech]See \URL{http://www.fi.muni.cz/cstug/csfaq/} +\end{booklist} + +Resources available on \acro{CTAN} are: +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Dante \acro{FAQ}]\CTANref{dante-faq} +\item[\nothtml{\rmfamily}French \acro{FAQ}]\CTANref{french-faq} +\item[\nothtml{\rmfamily}Sources of this \acro{FAQ}]\CTANref{faq} +\item[\nothtml{\rmfamily}Obsolete \texttt{comp.text.tex} \acro{FAQ}]% + \CTANref{TeX-FAQ} +\item[\nothtml{\rmfamily}The visual \acro{FAQ}]\CTANref{visualFAQ} +\end{ctanrefs} + +\Question[Q-gethelp]{How to get help} + +So you've looked at all relevant \Qref*{\acro{FAQ}s}{Q-whereFAQ} you +can find, you've looked in any \Qref*{books}{Q-books} you have, and +scanned relevant \Qref*{tutorials}{Q-tutorials*}\dots{} and still you +don't know what to do. + +If you are seeking a particular package or program, look on your own +system first: you might already have it~--- the better \TeX{} +distributions contain a wide range of supporting material. The +\acro{CTAN} Catalogue can also identify packages that might help: you +can \href{http://www.tex.ac.uk/search}{search it}, or you can browse it +% !!!! line break +``\href{http://www.tex.ac.uk/tex-archive/help/Catalogue/bytopic.html}{by topic}''. +A catalogue entry has a brief description of the package, and links to +any known documentation on the net. In fact, a large proportion of +\acro{CTAN} package directories now include documentation, so it's +often worth looking at the catalogue entry for a package you're considering +using. + +Failing all that, look to see if anyone else has had the problem +before; there are two places where people ask: browse or search the +newsgroup \Newsgroup{comp.text.tex} via +\href{http://groups.google.com/group/comp.text.tex}{Google groups}, +and the mailing list \texttt{texhax} via its +\href{http://tug.org/pipermail/texhax/}{archive}, or (as a long shot) +the archives of ancient posts on \acro{CTAN}. + +If those ``back question'' searches fail, you'll have to ask the world +at large. To ask a question on \Newsgroup{comp.text.tex}, you can use +your own news client (if you have one), or use the ``start a new +topic'' button on \URL{http://groups.google.com/group/comp.text.tex}. +To ask a question on \texttt{texhax}, you may simply send mail to +\mailto{texhax@tug.org}, but it's probably better to subscribe to the +list (via \URL{http://tug.org/mailman/listinfo/texhax}) % ! no ~ on this line +first~--- not everyone will answer to you as well as to the list. + +Do \textbf{not} try mailing the % ! line break +\Qref*{\LaTeX{} project team}{Q-LaTeX3}, +the maintainers of the \texlive{} or \miktex{} distributions +or the maintainers of these \acro{FAQ}s +for help; while all these addresses reach experienced \AllTeX{} +users, no small group can possibly have expertise in every area of +usage so that the ``big'' lists are a far better bet. +\begin{ctanrefs} +\item[texhax \nothtml{\rmfamily}`back copies']\CTANref{texhax} +\end{ctanrefs} + +\Question[Q-maillists*]{Specialist mailing lists} + +The previous question, ``\Qref*{getting help}{Q-gethelp}'', talked of +the two major forums in which \AllTeX{}, \MF{} and \MP{} are +discussed; however, these aren't the only ones available. + +The \acro{TUG} web site offers many mailing lists other than just +\texttt{texhax} via its % ! line break +\href{http://tug.org/mailman/listinfo}{mail list management page}. + +The French national \TeX{} user group, Gutenberg, offers a \MF{} (and, +de facto, \MP{}) mailing list, \mailto{metafont@ens.fr}: subscribe to +it by sending a message +\begin{quote} +\begin{verbatim} +subscribe metafont +\end{verbatim} +\end{quote} +to \mailto{sympa@ens.fr} + +(Note that there's also a \MP{}-specific mailing list available via the +\acro{TUG} list server; in fact there's little danger of becoming confused +by subscribing to both.) + +Announcements of \TeX{}-related installations on the \acro{CTAN} +archives are sent to the mailing list \texttt{ctan-ann}. Subscribe +to the list via its \ProgName{MailMan} web-site +\URL{https://lists.dante.de/mailman/listinfo/ctan-ann}; list archives +are available at the same address. The list archives may also be +browsed via \URL{http://www.mail-archive.com/ctan-ann@dante.de/}, and +an \acro{RSS} feed is also available: +\URL{http://www.mail-archive.com/ctan-ann@dante.de/maillist.xml} + +\Question[Q-askquestion]{How to ask a question} + +You want help from the community at large; you've decided where you're +going to \Qref*{ask your question}{Q-gethelp}, but how do you +phrase it? + +Excellent ``general'' advice (how to ask questions of anyone) is +contained in +%beware line break +\href{http://catb.org/~esr/faqs/smart-questions.html}{Eric Raymond's article on the topic}. +Eric's an extremely self-confident person, and this comes through in +his advice; but his guidelines are very good, even for us in the +un-self-confident majority. It's important to remember that you don't +have a right to advice from the world, but that if you express +yourself well, you will usually find someone who will be pleased to +help. + +So how do you express yourself in the \AllTeX{} world? There aren't +any comprehensive rules, but a few guidelines may help in the +application of your own common sense. +\begin{itemize} +\item Make sure you're asking the right people. Don't ask in a \TeX{} + forum about printer device drivers for the \ProgName{Foobar} + operating system. Yes, \TeX{} users need printers, but no, \TeX{} + users will typically \emph{not} be \ProgName{Foobar} systems + managers. + + Similarly, avoid posing a question in a language that the majority + of the group don't use: post in Ruritanian to + \Newsgroup{de.comp.text.tex} and you may have a long wait before a + German- and Ruritanian-speaking \TeX{} expert notices your + question. +\item If your question is (or may be) \TeX{}-system-specific, report + what system you're using, or intend to use: ``I can't install + \TeX{}'' is as good as useless, whereas ``I'm trying to install the + \ProgName{mumbleTeX} distribution on the \ProgName{Grobble} + operating system'' gives all the context a potential respondent + might need. Another common situation where this information is + important is when you're having trouble installing something new in + your system: ``I want to add the \Package{glugtheory} package to my + \ProgName{mumbleTeX v12.0} distribution on the \ProgName{Grobble 2024} + operating system''. +\item If you need to know how to do something, make clear what your + environment is: ``I want to do \emph{x} in \plaintex{}'', or ``I + want to do \emph{y} in \LaTeX{} running the \Class{boggle} + class''. If you thought you knew how, but your attempts are + failing, tell us what you've tried: ``I've already tried installing + the \Package{elephant} in the \Package{minicar} directory, and it + didn't work, even after refreshing the filename database''. +\item If something's going wrong within \AllTeX{}, pretend you're + \Qref*{submitting a \LaTeX{} bug report}{Q-latexbug}, + and try to generate a \Qref*{minimum failing example}{Q-minxampl}. + If your example + needs your local \Class{xyzthesis} class, or some other resource + not generally available, be sure to include a pointer to how the + resource can be obtained. +\item Figures are special, of course. Sometimes the figure itself is + \emph{really} needed, but most problems may be demonstrated with a + ``figure substitute'' in the form of a + \cmdinvoke*{rule}{width}{height} command, for some value of + \meta{width} and \meta{height}. If the (real) figure is needed, + don't try posting it: far better to put it on the web somewhere. +\item Be as succinct as possible. Your helpers don't usually need to + know \emph{why} you're doing something, just \emph{what} you're + doing and where the problem is. +\end{itemize} + +\Question[Q-minxampl]{How to make a ``minimum example''} + +\Qref[Question]{Our advice on asking questions}{Q-askquestion} +suggests that you prepare a ``minimum example'' (also commonly known +as a ``\emph{minimal} example'') of failing behaviour, +as a sample to post with your question. If you have a problem in a +two hundred page document, it may be unclear how to proceed from this +problem to a succinct demonstration of your problem. + +There are two valid approaches to this task: building up, and hacking +down. + +% ! line break +\latexhtml{The ``building up'' process}{\textbf{\emph{Building up}}} starts +with a basic document structure +(for \LaTeX{}, this would have \csx{documentclass}, +\cmdinvoke{begin}{document}, \cmdinvoke{end}{document}) and adds +things. First to add is a paragraph or so around the actual point +where the problem occurs. (It may prove difficult to find the actual +line that's provoking the problem. If the original problem is an +error, reviewing % ! line break +\Qref[the answer to question]{``the structure of \TeX{} errors''}{Q-errstruct} +may help.) + +Note that there are things that can go wrong in one part of the +document as a result of something in another part: the commonest is +problems in the table of contents (from something in a section title, +or whatever), or the list of \meta{something} (from something in a +\csx{caption}). In such a case, include the section title or caption +(the caption probably needs the \environment{figure} or +\environment{table} environment around it, but it \emph{doesn't} need +the figure or table itself). + +If this file you've built up shows the problem already, then you're done. +Otherwise, try adding packages; the optimum is a file with only one +package in it, but you may find that the guilty package won't even load +properly unless another package has been loaded. (Another common case +is that package \Package{A} only fails when package \Package{B} has been +loaded.) + +% ! line break +\latexhtml{The ``hacking down'' route}{\textbf{\emph{Hacking down}}} starts +with your entire document, and +removes bits until the file no longer fails (and then of course +restores the last thing removed). Don't forget to hack out any +unnecessary packages, but mostly, the difficulty is choosing what to +hack out of the body of the document; this is the mirror of the +problem above, in the ``building up'' route. + +If you've added a package (or more than one), add \csx{listfiles} to +the preamble too: that way, \LaTeX{} will produce a list of the +packages you've used and their version numbers. This information may +be useful evidence for people trying to help you. + +What if your document simply doesn't fail in any of these cut-down +scenarios? Whatever you do, don't post the whole of the document: if +you can, it may be useful to make a copy available on the web +somewhere: people will probably understand if it's impossible~\dots{}\ +or inadvisable, in the case of something confidential. + +If the whole document is necessary, it could be that it's an overflow +of some sort; the best you can do is to post the code ``around'' the +error, and (of course) the full text of the error. + +It may seem that all this work is rather excessive for preparing a +simple post. There are two responses to that, both based on the +relative inefficiency of asking a question on the internet. + +First, preparing a minimum document very often leads \emph{you} to the +answer, without all the fuss of posting and looking for responses. + +Second, your prime aim is to get an answer as quickly as possible; a +well-prepared example stands a good chance of attracting an answer +``in a single pass'': if the person replying to your post finds she +needs more information, you have to find that request, post again, and +wait for your benefactor to produce a second response. + +All things considered, a good example file can save you a day, for +perhaps half an hour's effort invested. + +The above advice, differently phrased, may also be read on the web at +\URL{http://www.minimalbeispiel.de/mini-en.html}; source of that +article may be found at \URL{http://www.minimalbeispiel.de/}, in +both German and English. + +\Question[Q-tutorials*]{\AllTeX{} Tutorials, etc.} + +From a situation where every \AllTeX{} user \emph{had} to buy a book +if she was not to find herself groping blindly along, we now have what +almost amounts to an embarrassment of riches of online documentation. +The following answers attempt to create lists of sources ``by topic''. + +First we have introductory manuals, for +\Qref*{\plaintex{}}{Q-man-tex} and \Qref*{\LaTeX{}}{Q-man-latex}. + +Next comes a selection of +\Qref*{``specialised'' \AllTeX{} tutorials}{Q-tutbitslatex}, +each of which concentrates on a single \LaTeX{} topic. + +A couple of reference documents (it would be good to have more) are +listed in an \Qref*{answer of their own}{Q-ref-doc}. + +Next comes the (rather new) field of % ! line break +\Qref*{\TeX{}-related WIKIs}{Q-doc-wiki}. + +A rather short list gives us a % ! line break +\Qref*{Typography style tutorial}{Q-typo-style}. + +Finally, we have a set of links to +\Qref*{Directories of \AllTeX{} information}{Q-doc-dirs}, and details +of some ``\Qref*{books}{Q-ol-books}'' that were once published +conventionally, but are now available on-line. + +\Question[Q-man-tex]{Online introductions: \plaintex{}} + +Michael Doob's splendid `Gentle Introduction' to \plaintex{} +(available on \acro{CTAN}) has been stable for a very long time. + +Another recommendable document is D. R.~Wilkins `Getting started with \TeX{}', +available on the web at \URL{http://www.ntg.nl/doc/wilkins/pllong.pdf} +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Gentle Introduction]\CTANref{gentle} +\end{ctanrefs} + +\Question[Q-man-latex]{Online introductions: \LaTeX{}} + +A pleasing little document, ``Getting something out of \LaTeX{}'' is +designed to give a feel of \LaTeX{} to someone who's never used it at +all. It's not a tutorial, merely helps the user to decide whether to +go on to a tutorial, and to `real' use of \LaTeX{}. + +Tobias Oetiker's `(Not so) Short Introduction to \LaTeXe{}', is +regularly updated, as people suggest better ways of explaining things, +etc. The introduction is available on \acro{CTAN}, together with +translations into a rather large set of languages. + +Peter Flynn's ``Beginner's \LaTeX{}'' (which started life as course +material) is a pleasing read. A complete copy may be found on +\acro{CTAN}, but it may also be browsed over the web +(\URL{http://www.tex.ac.uk/tex-archive/info/beginlatex/html/}). + +Harvey Greenberg's `Simplified Introduction to \LaTeX{}' was written +for a lecture course, and is also available on \acro{CTAN} (in \PS{} +only, unfortunately). + +The fourth edition of George Gr\"atzer's book ``Math into \LaTeX{}'' +contains a ``short course'' in \LaTeX{} itself, and that course has +been made publicly available on \acro{CTAN}. + +Philip Hirschhorn's ``Getting up and running with \AMSLaTeX{}'' has a +brief introduction to \LaTeX{} itself, followed by a substantial +introduction to the use of the \acro{AMS} classes and the +\Package{amsmath} package and other things that are potentially of +interest to those writing documents containing mathematics. + +Edith Hodgen's % beware line break +\href{http://www.mcs.vuw.ac.nz/~david/latex/notes.pdf}{\LaTeX{}, a Braindump} +starts you from the ground up~--- giving a basic tutorial in the use +of \ProgName{Linux} to get you going (rather a large file\dots{}). +Its parent site, David Friggens' % ! line break +\href{http://www.mcs.vuw.ac.nz/~david/latex/}{documentation page} is a +useful collection of links in itself. + +% ! line break +\href{http://www.andy-roberts.net/misc/latex/}{Andy Roberts' introductory material} +is a pleasing short introduction to the use of \AllTeX{}; some of the +slides for \emph{actual} tutorials are to be found on the page, as +well. + +Chris Harrison's % ! line break +\href{http://www.chrisharrison.co.uk/xophbook/mybooks/tex/index.html}{TeX book} +presents basic \LaTeX{} with useful hints for extensions + +Nicola Talbot's % ! line break +\href{http://theoval.cmp.uea.ac.uk/~nlct/latex/novices/}{\LaTeX{} for complete novices} +does what it claims: the author teaches \LaTeX{} at the University of +East Anglia. That is one of several of Nicola's % ! line break +\href{http://theoval.cmp.uea.ac.uk/~nlct/latex/}{introductory tutorials}, +which include exercises (with solutions). Other tutorials include +those for writing theses/dissertations with \LaTeX{}, and for using +\LaTeX{} in administrative work. (The page seems to be an adjunct to +her \LaTeX{} courses~--- fortunate people, the people of \acro{UEA}!). + +An interesting (and practical) tutorial about what \emph{not} to do is +\Package{l2tabu}, or ``A list of sins of \LaTeXe{} users'' by Mark +Trettin, translated into English by J\"urgen Fenn. The +tutorial is available from \acro{CTAN} as a \acro{PDF} file (though +the source is also available). +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Beginner's \LaTeX{}]\CTANref{beginlatex-pdf} +\item[\nothtml{\rmfamily}First \LaTeX{} document]\CTANref{first-latex-doc} +% ! line break +\item[\nothtml{\rmfamily}Getting up and running with \AMSLaTeX{}]\CTANref{amslatex-primer} +\item[\nothtml{\rmfamily}Not so Short Introduction]\CTANref{lshort} + (in English, you may browse for sources and other language versions at + \CTANref{lshort-parent}) +\item[\nothtml{\rmfamily}Simplified \LaTeX{}]\CTANref{simpl-latex} +\item[\nothtml{\rmfamily}Short Course in \LaTeX{}]\CTANref{mil-short} +% ! line break +\item[\nothtml{\rmfamily}The sins of \LaTeX{} users]\CTANref{l2tabuen}; + source also available: \CTANref{l2tabuen.src} +\end{ctanrefs} + +\Question[Q-tutbitslatex]{Specialised \AllTeX{} tutorials} + +The \acro{AMS} publishes a ``Short Math Guide for \LaTeX{}'', which is +available (in several formats) via +\URL{http://www.ams.org/tex/short-math-guide.html} + +Herbert Vo\ss{} has written an extensive guide to mathematics in +\LaTeX{} (a German version of which is published as a book). The +guide is part of his ``\Qref*{tips and tricks}{Q-doc-dirs}'' and +a copy is maintained on \acro{CTAN}. +%\URL{http://www.perce.de/LaTeX/math/Mathmode-TeX.pdf} + +Two documents written more than ten years apart about font usage in +\TeX{} are worth reading: % ! line breaks, next 3 lines +\href{href='http://www.tug.org/TUGboat/Articles/tb14-2/tb39rahtz-nfss.pdf}{Essential NFSS} +by Sebastian Rahtz, and +\href{http://tug.org/pracjourn/2006-1/schmidt/schmidt.pdf}{Font selection in LaTeX}, +cast in the form of an \acro{FAQ}, by Walter Schmidt. A general +compendium of font information (including the two above) may be found +on the \href{http://www.tug.org/fonts/}{TUG web site}. + +Peter Smith's +\begin{narrowversion} + ``\LaTeX{} for Logicians'' + (\URL{http://www.phil.cam.ac.uk/teaching_staff/Smith/LaTeX/}) +\end{narrowversion} +\begin{wideversion} + % ! line break + ``\href{http://www.phil.cam.ac.uk/teaching_staff/Smith/LaTeX/}{\LaTeX{} for Logicians}'' +\end{wideversion} +covers a rather smaller subject area, but is similarly comprehensive +(mostly by links to documents on relevant topics, rather than as a +monolithic document). + +Keith Reckdahl's ``Using Imported Graphics in \LaTeXe{}'' is an +excellent introduction to graphics use. It's available on +\acro{CTAN}, but the sources aren't available (promised ``some time +soon''). + +Kjell Magne Fauske offers a set of examples of the use of the drawing +packages % ! line break +\Qref*{\acro{PGF} and \acro{T}ik\acro{Z}}{Q-drawing}; the % ! line break +\href{http://www.texample.net/tikz/examples/}{examples catalogue} +includes examples (with output) from the package documentation as well +as code written by the author himself. + +Vincent Zoonekynd provides a set of excellent (and graphic) tutorials +on the programming of % !line breaks, ... +\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_title/0.html}{title page styles}, +\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_chapter/0.html}{chapter heading styles} +and +\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_section/0.html}{section heading styles}. +In each file, there is a selection of graphics representing an output +style, and for each style, the code that produces it is shown. + +An invaluable step-by-step setup guide for establishing a ``work +flow'' through your \AllTeX{} system, so that output appears at the +correct size and position on standard-sized paper, and that the print +quality is satisfactory, is Mike Shell's \Package{testflow}. The +tutorial consists of a large plain text document, and there is a +supporting \LaTeX{} file together with correct output, both in \PS{} and +\acro{PDF}, for each of \acro{A}4 and ``letter'' paper sizes. The +complete kit is available on \acro{CTAN} (distributed with the +author's macros for papers submitted for \acro{IEEE} publications). +The issues are also covered in a later % ! line break +\Qref{\acro{FAQ} answer}{Q-dvips-pdf}. + +Documentation of Japanese \TeX{} use appears at least twice on the web: +Haruhiko Okumura's page on +% ! line break +\href{http://oku.edu.mie-u.ac.jp/~okumura/texfaq/japanese/}{typesetting Japanese with Omega} +(the parent page is in Japanese, so out of the scope of this +\acro{FAQ}). + +One ``Tim'' documents p\TeX{} (a \TeX{} system widely used in Japan) +in his +\begin{narrowversion} + ``English notes on p\TeX{}'' (see + \url{http://www.users.waitrose.com/~nihilist/English_Notes_on_pTex.pdf}). +\end{narrowversion} +\begin{wideversion} + % ! line break + ``\href{http://www.users.waitrose.com/~nihilist/English_Notes_on_pTex.pdf}{English notes on p\TeX{}}''. +\end{wideversion} + +Some university departments make their local documentation available +on the web. Most straightforwardly, there's the simple translation of +existing documentation into \acro{HTML}, for example the \acro{INFO} +documentation of the \AllTeX{} installation, of which a sample is the +\LaTeX{} documentation available at +\URL{http://www.tac.dk/cgi-bin/info2www?(latex)} + +More ambitiously, some university departments have enthusiastic +documenters who +make public record of their \AllTeX{} support. For example, Tim Love +(of Cambridge University Engineering Department) maintains his +deparment's pages at +\URL{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/} +%% and Mimi +%% Burbank (of the School of Computer Science \& Information Technology +%% at the University of Florida) manages her department's at +%% \URL{http://www.csit.fsu.edu/~mimi/tex/}\nobreakspace--- both sets are fine +%% examples of good practice. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Graphics in \LaTeXe{}]the + document is available in \PS{} and \acro{PDF} formats as + \CTANref{epslatex_ps} and \CTANref{epslatex_pdf} respectively +\item[testflow]\CTANref{testflow} +\item[\nothtml{\rmfamily}Herbert Vo\ss{}'s Maths tutorial]\CTANref{voss-mathmode} +\end{ctanrefs} + +\Question[Q-ref-doc]{Reference documents} + +For \TeX{} primitive commands a rather nice % ! line break +\href{http://www.nmt.edu/tcc/help/pubs/texcrib.pdf}{quick reference booklet}, +by John W.~Shipman, is available; it's arranged in the same way as the +\TeX{}book. By contrast, you can view David Bausum's % ! line break +\href{http://www.tug.org/utilities/plain/cseq.html}{list of \TeX{} primitives} +alphabetically or arranged by ``family''. Either way, the list has a +link for each control sequence, that leads you to a detailed +description, which includes page references to the \TeX{}book. + +There doesn't seem to be a reference that takes in \plaintex{} as +well as the primitive commands. + +An interesting \LaTeX{} ``cheat sheet'' is available from \acro{CTAN}: +it's a list of (more or less) everything you `ought to' remember, for +basic \LaTeX{} use. (It's laid out very compactly for printing on N.\ +American `letter'; printed on \acro{ISO} \acro{A}4, using Adobe +Acrobat's ``shrink to fit'', it strains aged eyes\dots{}) + +Similarly, there's no completely reliable command-organised reference +to \LaTeX{}. The page (provided by \acro{NASA}) % ! line break +\href{http://www.giss.nasa.gov/latex/}{Hypertext Help with LaTeX} is +recently much improved. It still talks in \LaTeXo{}-isms in places, +but it's been updated for current \LaTeX{}. There are a number of +mirrors of the site, and it may be worth choosing a ``local'' one if +you're going to use it a lot. + +Another \LaTeXe{} reference (provided by the Emerson Center of Emory +University) is: % ! line break +\href{http://www.emerson.emory.edu/services/latex/latex2e/latex2e_toc.html}{LaTeXe help} +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Cheat sheet]\CTANref{latexcheat} +\end{ctanrefs} + +\Question[Q-doc-wiki]{WIKI pages for \TeX{} and friends} + +The \emph{WIKI} concept can be a boon to everyone, if used sensibly. +The ``general'' WIKI allows \emph{anyone} to add stuff, or to edit +stuff that someone else has added: while there is obvious potential +for chaos, there is evidence that a strong user community can keep a +WIKI under control. + +Following the encouraging performance of the % ! line break +\href{http://contextgarden.net/}{\CONTeXT{} WIKI}, valiant efforts +have been made generating ``WIKI books'' for \AllTeX{} users. Thus we +have \href{http://en.wikibooks.org/wiki/TeX}{(Plain) \TeX{} WIKI} and +\href{http://en.wikibooks.org/wiki/LaTeX}{\LaTeX{} WIKI} are well +established. Neither would seem yet to be of publication quality, but +they both seem useful reference sources. + +\Question[Q-typo-style]{Typography tutorials} + +Peter Wilson's manual for his \Class{memoir} class has a lengthy +introductory section on typographic considerations, which is a fine +tutorial, written by someone who is aware of the issues as they apply +to \AllTeX{} users. + +There's also (at least one) typographic style tutorial available on +the Web, the excellent % ! line break +``\href*{http://www.nbcs.rutgers.edu/~hedrick/typography/typography.janson-syntax.107514.pdf}{Guidelines for Typography in NBCS}''. +In fact, its % !! +\href*{http://www.nbcs.rutgers.edu/~hedrick/typography/index.html}{parent page} +is also worth a read: among other things, it provides copies of the +``guidelines'' document in a wide variety of primary fonts, for +comparison purposes. The author is careful to explain that he has no +ambition to supplant such excellent books as +\Qref*{Bringhurst's}{Q-typebooks}, but the document (though it does +contain its Rutgers-local matter) is a fine introduction to the issues +of producing readable documents. +\begin{ctanrefs} +\item[memoir \nothtml{\rmfamily}distribution]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-doc-dirs]{Directories of \AllTeX{} information} + +T\acro{UG} India is developing a series of online \LaTeX{} tutorials +which can be strongly recommended: select single chapters at a time +from \URL{http://www.tug.org.in/tutorials.html}\nobreakspace--- the +set comprises two parts, ``Text'' and ``Graphics'', so far. + +Herbert Vo\ss{}'s excellent % beware line break +\href{http://texnik.de/}{\LaTeX{} tips and tricks} is an excellent +source of small articles on the use of \LaTeX{}. + +\Question[Q-ol-books]{Freely available \AllTeX{} books} + +People have long argued for \AllTeX{} books to be made available on +the web, and until relatively recently this demand went un-answered. + +The first to appear was Victor Eijkhout's excellent ``\TeX{} by +Topic'' in 2001 (it had been published by Addison-Wesley, but was long +out of print). The book is now available on \acro{CTAN}; it's not a +beginner's tutorial but it's a fine reference. It's also available, +as a printed copy, via the on-line publishers +\href{http://www.lulu.com/content/2555607/}{Lulu} (not quite free, of +course, but not a \emph{bad} deal\dots{}). + +Addison-Wesley have also released the copyright of ``\TeX{} for the +Impatient'' by Paul W.~Abrahams, Karl Berry and Kathryn A.~Hargreaves, +another book whose unavailability many have lamented. The authors +have re-released the book under the \acro{GNU} Free Documentation +Licence, and it is available from \acro{CTAN}. + +Norm Walsh's ``Making \TeX{} Work'' (originally published by O'Reilly) +is also available (free) on the Web, at +\URL{http://makingtexwork.sourceforge.net/mtw/}; the sources of the +Web page are on \acro{CTAN}. The book was an excellent resource in +its day, but while it is now somewhat dated, it still has its uses, +and is a welcome addition to the list of on-line resources. A project +to update it is believed to be under way. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Making \TeX{} Work]\CTANref{mtw} +\item[\nothtml{\rmfamily}\TeX{} by Topic]\CTANref{texbytopic} +\item[\nothtml{\rmfamily}\TeX{} for the Impatient]\CTANref{TftI} +\end{ctanrefs} + +\Question[Q-pkgdoc]{Documentation of packages} + +These \acro{FAQ}s regularly suggest packages that will ``solve'' +particular problems. In some cases, the answer provides a recipe for +the job. In other cases, or when the solution needs elaborating, how +is the poor user to find out what to do? + +If you're lucky, the package you need is already in your installation. +If you're particularly lucky, you're using a distribution that gives +access to package documentation and the documentation is available in +a form that can easily be shown. For example, on many current +distributions, the \ProgName{texdoc} command often helps, as in: +\begin{quote} +\begin{verbatim} +texdoc footmisc +\end{verbatim} +\end{quote} +which opens a window showing documentation of the +\Package{footmisc} package. According to the type of file +\ProgName{texdoc} finds, it will launch a \acro{DVI} viewer +or a \acro{PDF} reader. + +If \ProgName{texdoc} can't find any documentation, it may launch a Web +browser to look at its copy of the \acro{CTAN} catalogue. The +catalogue has an entry for package documentation, and since the +\acro{CTAN} team asks authors documentation of their packages (and +members of the team even occasionally generate documentation that +seems useful), you will more often than not find documentation that +way. + +If your luck (as defined above) doesn't hold out, you've got to find +documentation by other means. This is where you need to exercise your +intelligence: you have to find the documentation for yourself. What +follows offers a range of possible techniques. + +The commonest form of documentation of \LaTeX{} add-ons is within the +\extension{dtx} file in which the code is distributed (see +\Qref[answer]{documented \LaTeX{} sources}{Q-dtx}). Such files +are supposedly processable by \LaTeX{} itself, but there are +occasional hiccups on the way to readable documentation. Common +problems are that the package itself is needed to process its own +documentation (so must be unpacked before processing), and that the +\extension{dtx} file will \emph{not} in fact process with \LaTeX{}. In the +latter case, the \extension{ins} file will usually produce a +\extension{drv} (or similarly-named) file, which you process with +\LaTeX{} instead. (Sometimes the package author even thinks to +mention this wrinkle in a package \texttt{README} file.) + +Another common form is the separate documentation file; particularly +if a package is ``conceptually large'' (and therefore needs a lot of +documentation), the documentation would prove a cumbersome extension +to the \extension{dtx} file. Examples of such cases are the \Class{memoir} +class (whose documentation, \File{memman}, is widely praised as an +introduction to typesetting concepts), the \Class{KOMA-script} bundle +(whose developers take the trouble to produce detailed documentation +in both German and English), and the \Package{fancyhdr} package (whose +documentation derives from a definitive tutorial in a mathematical +journal). Even if the documentation is not separately identified in a +\texttt{README} file, it should not be too difficult to recognise its +existence. + +Documentation within the package itself is the third common form. +Such documentation ordinarily appears in comments at the head of the +file, though at least one eminent author regularly places it after the +\csx{endinput} command in the package. (This is desirable, since +\csx{endinput} is a `logical' end-of-file, and \AllTeX{} doesn't read +beyond it: thus such documentation does not `cost' any package loading time.) + +The above suggestions cover most possible ways of finding +documentation. If, despite your best efforts, you can't find +it in any of the above places, there's the awful possibility that the +author didn't bother to document his package (on the ``if it was hard +to write, it should be hard to use'' philosophy). Most ordinary +mortals will seek support from some more experienced user at this +stage, though it \emph{is} possible to proceed in the way that the original +author apparently expected\dots{}by reading his code. + +\Question[Q-writecls]{Learning to write \LaTeX{} classes and packages} + +There's nothing particularly magic about the commands you use when +writing a package, so you can simply bundle up a set of \LaTeX{} +\csx{(re)newcommand} and \csx{(re)newenvironment} commands, put them in +a file \File{package.sty} and you have a package. + +However, any but the most trivial package will require rather more +sophistication. Some details of \LaTeX{} commands for the job are to +be found in `\LaTeXe{} for class and package writers' +(\File{clsguide}, part of the \LaTeX{} documentation distribution). +Beyond this, a good knowledge of \TeX{} itself is valuable: thus books +such as the \Qref*{\TeX{}book}{Q-books} or % ! line break +\Qref*{\TeX{} by topic}{Q-ol-books} are relevant. With good \TeX{} +knowledge it is possible to use the documented source of \LaTeX{} as +reference material (dedicated authors will acquaint themselves with the +source as a matter of course). A complete set of the documented +source of \LaTeX{} may be prepared by processing the file +\File{source2e.tex} in the \LaTeX{} distribution. Such processing is +noticeably tedious, but Heiko Oberdiek has prepared a well-linked +\acro{PDF} version, which is in the file \File{base.tds.zip} of his +\ProgName{latex-tds} distribution. Individual files in the \LaTeX{} +distribution may be processed separately with \LaTeX{}, like any +well-constructed \Qref*{\extension{dtx} file}{Q-dtx}. + +Writing good classes is not easy; it's a good idea to read some +established ones (\File{classes.dtx}, for example, is the documented +source of the standard classes other than \Class{Letter}, and may +itself be formatted with \LaTeX{}). Classes that are not part of the +distribution are commonly based on ones that are, and start by loading +the standard class with \csx{LoadClass}~--- an example of this +technique may be seen in \Package{ltxguide.cls} + +An % !! line break +\href{http://tug.org/TUGboat/Articles/tb28-1/tb88flynn.pdf}{annotated version of \Class{article}}, +as it appears in \File{classes.dtx}, was published in +\TUGboat{} 28(1). The article, by Peter Flynn, which is some help in +understanding \File{classes.dtx} +\begin{ctanrefs} +\item[classes.dtx]\CTANref{latex-classes} +\item[clsguide.pdf]\CTANref{clsguide} +\item[latex-tds \nothtml{rmfamily}collection]\CTANref{latex-tds} +\item[ltxguide.cls]\CTANref{ltxguide} +\item[\nothtml{\rmfamily}\LaTeX{} documentation]\CTANref{latexdoc} +\item[source2e.tex]\CTANref{latex-source} +\end{ctanrefs} + +\Question[Q-mfptutorials]{\MF{} and \MP{} Tutorials} + +Apart from Knuth's book, there seems to be only one publicly-available +\href{http://metafont.tutorial.free.fr/}{tutorial for \MF{}}, by +Christophe Grandsire (a copy in \acro{PDF} form may be downloaded). +Geoffrey Tobin's \textit{\MF{} for Beginners} % !! line break +(see \Qref[question]{using \MF{}}{Q-useMF}) describes how the \MF{} +system works and how to avoid some of the potential pitfalls. + +There is also an article on how to run both \MF{} and \MP{} (the +programs). Peter Wilson's % !! line break +\textit{Some Experiences in Running \MF{} and \MP{}} +offers the benefit of Peter's experience (he has designed a number of +`historical' fonts using \MF{}). For \MF{} the article is geared +towards testing and installing new \MF{} fonts, while its \MP{} +section describes how to use \MP{} illustrations in \LaTeX{} and +\PDFLaTeX{} documents, with an emphasis on how to use appropriate +fonts for any text or mathematics. + +% Hans Hagen (of \CONTeXT{} fame) offers a \MP{} tutorial called +% MetaFun (which admittedly concentrates on the use of \MP{} within +% \CONTeXT{}). It may be found on his company's % ! line break +% \href{http://www.pragma-ade.com/metapost.htm}{\MP{} page}. + +Other \MP{} tutorials that have appeared are two in English by % ! line breaks +\href{http://remote.science.uva.nl/~heck/Courses/mptut.pdf}{Andr\'e Heck} +and \href{http://www.tlhiv.org/MetaPost/tutorial/}{Urs Oswald}, +and one in French (listed here because it's clearly enough written +that even this author understands it), by +\href{http://pauillac.inria.fr/~cheno/metapost/metapost.pdf}{Laurent Ch\'eno}; +both have been recommended for inclusion in the \acro{FAQ} + +Urs Oswald's tutorial is accompanied by a super tool (by Troy +Henderson) for testing little bits of \MP{}, which is an invaluable +aid to the learner: \URL{http://www.tlhiv.org/mppreview} + +Vincent Zoonekynd's massive set of example \MP{} files is available on +\acro{CTAN}; the set includes a \ProgName{Perl} script to convert the +set to html, and the set may be % beware line break +\href{http://zoonek.free.fr/LaTeX/Metapost/metapost.html}{viewed on the web}. +While these examples don't exactly constitute a ``tutorial'', they're +most certainly valuable learning material. Urs Oswald presents a +\href{http://www.ursoswald.ch/metapost/tutorial.pdf}{similar document}, +written more as a document, and presented in \acro{PDF}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Beginners' guide]\CTANref{mf-beginners} +\item[\nothtml{\rmfamily}Peter Wilson's ``experiences'']\CTANref{metafp-pdf} +\item[\nothtml{\rmfamily}Vincent Zoonekynd's examples]\CTANref{zoon-mp-eg} +\end{ctanrefs} + +\Question[Q-BibTeXing]{\BibTeX{} Documentation} + +\BibTeX{}, a program originally designed to produce bibliographies in +conjunction with \LaTeX{}, is explained in Section~4.3 and Appendix~B +of Leslie Lamport's \LaTeX{} manual. +The document ``\BibTeX{}ing'', contained in the file \File{btxdoc.tex}, +expands on the chapter in Lamport's book. \emph{The \LaTeX{} Companion} +also has information on \BibTeX{} and writing \BibTeX{} style files. +(See \Qref[question]{TeX-related books}{Q-books} for details of both +books.) + +The document ``Designing \BibTeX{} Styles'', contained in the file +\File{btxhak.tex}, explains the postfix stack-based language used to +write \BibTeX{} styles (\File{.bst} files). The file \File{btxbst.doc} +is the template for the four standard styles (\Package{plain}, +\Package{abbrv}, \Package{alpha}, and \Package{unsrt}). It also +contains their documentation. The complete \BibTeX{} documentation +set (including all the files above) is available on \acro{CTAN}. + +A useful tutorial of the whole process of using \BibTeX{} is Nicolas +Markey's ``\emph{Tame the BeaST (The B to X of \BibTeX{})}'', which +may also be found on \acro{CTAN}. A summary and \acro{FAQ} +(\File{btxFAQ}), by Michael Shell and David Hoadley, is also to be +recommended. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\BibTeX{} documentation]\CTANref{bibtex-doc} +\item[btxFAQ.pdf]\CTANref{bibtex-faq} +\item[\nothtml{\rmfamily}Tame the BeaST]\CTANref{ttb-pdf} +\end{ctanrefs} + +\Question[Q-symbols]{Where can I find the symbol for\,\dots{}} +\keywords{assignment circular integral degrees diagonal dots Fourier transform} +\keywords{Laplace greater less complex integer natural real} +\keywords{cent euro} + +There is a wide range of symbols available for use with \TeX{}, most +of which are not shown (or even mentioned) in \AllTeX{} books. +\emph{The Comprehensive \LaTeX{} Symbol List} (by Scott Pakin +% beware line wrap +\emph{et al.}\@) illustrates over 2000 symbols, and details the +commands and the \LaTeX{} packages needed to produce them. + +Other questions in this \acro{FAQ} offer specific help on kinds of +symbols: +\begin{itemize} +\item \Qref*{Script fonts for mathematics}{Q-scriptfonts} +\item \Qref*{Fonts for the number sets}{Q-numbersets} +\item \Qref*{Typesetting the principal value integral}{Q-prinvalint} +\end{itemize} + +A useful new % ! line break +\href{http://detexify.kirelabs.org/classify.html}{symbol search} web +site is available. It provides you a scratch area on which you draw +the symbol you're thinking of, with your mouse; when you've finished +drawing, the classifier tries to match your sketch with symbols it +knows about. The matching process is pretty good, even for the +sketches of a \emph{really} poor draughtsman, and it's often worth +trying more than once. Given the huge size of the symbol list, this +tool can be very helpful. +\begin{ctanrefs} +\item[Symbol List]Browse \CTANref{symbols}; there are processed + versions in both \PS{} and \acro{PDF} forms for both A4 and + letter paper. +\end{ctanrefs} + +\Question[Q-docpictex]{The \PiCTeX{} manual} + +\PiCTeX{} is a set of macros by Michael Wichura for drawing diagrams +and pictures. The +macros are freely available; however, the +\PiCTeX{} manual itself is not free. +Unfortunately, \acro{TUG} is no longer able to supply copies of the +manual (as it once did), and it is now available only through Personal +\TeX{} Inc, the vendors of PC\TeX{} (\URL{http://www.pctex.com/}). The +manual is \emph{not} available electronically. + +However, there \emph{is} a summary of \PiCTeX{} commands available on +\acro{CTAN}, which is a great aide-memoire for those who basically +know the package to start with. +\begin{ctanrefs} +\item[pictex]\CTANref{pictex} +\item[PiCTeX summary]\CTANref{pictex-summary} +\end{ctanrefs} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-dvi.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-dvi.tex new file mode 100644 index 00000000000..5537fd2b3dc --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-dvi.tex @@ -0,0 +1,142 @@ +% $Id: faq-dvi.tex,v 1.1 2009/06/13 20:56:38 rf10 Exp rf10 $ + +\section{\acro{DVI} Drivers and Previewers} + +\Question[Q-dvips]{\acro{DVI} to \PS{} conversion programs} + +The best public domain \acro{DVI} to \PS{} conversion program, which +runs under many operating systems, is Tom Rokicki's \ProgName{dvips}. +\ProgName{dvips} is written in \acro{C} and ports easily. All current +development is in the context of Karl Berry's \ProgName{kpathsea} +library, and sources are available from the \texlive{} repository, +and versions are available in all \TeX{} distributions that recognise +the use of \PS{}. + +An \acro{VMS} versions is available as part of the \acro{CTAN} +distribution of \TeX{} for \acro{VMS}. + +A precompiled version to work with em\TeX{} is available on \acro{CTAN}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\MSDOS{} and \latexhtml{\acro{OS/}}{OS/}2]% + \CTANref{dvips-pc} +\item[\nothtml{\rmfamily}VMS distribution]\CTANref{OpenVMSTeX} +\end{ctanrefs} + +\Question[Q-HPdrivers]{\acro{DVI} drivers for \acro{HP} LaserJet} + +The em\TeX{} distribution (see \Qref[question]{\TeX{} systems}{Q-TeXsystems}) +contains a driver for the LaserJet, \ProgName{dvihplj}. + +Version 2.10 of the Beebe drivers supports the LaserJet. These drivers +will compile under Unix, \acro{VMS}, and on the Atari ST and +\acro{DEC}-20s. + +For Unix systems, Karl Berry's \ProgName{dviljk} uses the same +path-searching library as \ProgName{web2c}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Beebe drivers]\CTANref{beebe} +\item[dviljk]\CTANref{dviljk} +\end{ctanrefs} + +\Question[Q-otherprinters]{Output to ``other'' printers} + +In the early years of \TeX{}, there were masses of \acro{DVI} drivers +for any (then) imaginable kind of printer, but the steam seems rather +to have gone out of the market for production of drivers for +printer-specific formats. There are several reasons for this, but the +primary one is that few formats offer the flexibility available +through \PS{}, and \ProgName{ghostscript} is \emph{so} good, and +has \emph{such} a wide range of printer drivers (perhaps this is where +the \acro{DVI} output driver writers have all gone?). + +The general advice, then, is to \Qref*{generate \PS{}}{Q-dvips}, and +to process that with \ProgName{ghostscript} set to generate the format +for the printer you actually have. If you are using a Unix system of +some sort, it's generally quite easy to insert \ProgName{ghostscript} +into the print spooling process. +\begin{ctanrefs} +\item[ghostscript]Browse \CTANref{ghostscript} +\end{ctanrefs} + +\Question[Q-previewers]{\acro{DVI} previewers} + +Em\TeX{} for \acro{PC}s running \MSDOS{} or \acro{OS/}2, \miktex{} and +XEm\TeX{} for \acro{PC}s running Windows and Oz\TeX{} for the Macintosh, all +come with previewers that can be used on those platforms. Em\TeX{}'s +previewer can also be run under Windows~3.1. + +Commercial \acro{PC} \TeX{} packages (see % ! line break +\Qref[question]{commercial vendors}{Q-commercial}) +have good previewers for \acro{PC}s running Windows, or for Macintoshes. + +For Unix systems, there is one `canonical' viewer, \ProgName{xdvi}. +\ProgName{Xdvik} is a version of \ProgName{xdvi} using the +\ProgName{web2c} libraries; it is now built from the same distribution +as \ProgName{xdvi}. The \texlive{} distributions for Unix systems +include a version of \ProgName{xdvik}. + +Alternatives to previewing include +\begin{itemize} +\item conversion to `similar' \acro{ASCII} text (see + \Qref[question]{converting to \acro{ASCII}}{Q-toascii}) and using a + conventional text viewer to look at that, +\item generating a \PS{} version of your document and viewing it + with a \ProgName{Ghostscript}-based previewer (see + \Qref[question]{previewing \PS{} files}{Q-PSpreview}), and +\item generating \acro{PDF} output, and viewing that with + \ProgName{Acrobat} \ProgName{Reader} or one of the substitutes for that. +\end{itemize} +\begin{ctanrefs} +\item[xdvi]\CTANref{xdvi} +\end{ctanrefs} + +\Question[Q-dvi-bmp]{Generating bitmaps from \acro{DVI}} + +In the last analysis, any \acro{DVI} driver or previewer is generating +bitmaps: bitmaps for placing tiny dots on paper via a laser- or +inkjet-printer, or bitmaps for filling some portion of your screen. +However, it's usually difficult to extract any of those bitmaps any +way other than by screen capture, and the resolution of \emph{that} is +commonly lamentable. + +Why would one want separate bitmaps? Most often, the requirement is for +something that can be included in \acro{HTML} generated from \AllTeX{} +source~--- not everything that you can write in \AllTeX{} can be +translated to \acro{HTML} (at least, portable \acro{HTML} that may be +viewed in `most' browsers), so the commonest avoiding action is to +generate a bitmap of the missing bit. Examples are maths (a maths +extension to the `|*|\acro{ML}' family is available but not +universally supported by browsers), and `exotic' typescripts (ones +that you cannot guarantee your readers will have available). Other +common examples are generation of +sample bitmaps, and generation for insertion into some other +application's display~--- to insert equations into Microsoft +PowerPoint, or to support the enhanced-\ProgName{emacs} setup called +\Qref*{\ProgName{preview}-\ProgName{latex}}{Q-WYGexpts}. + +In the past, the commonest way of generating bitmaps was to generate a +\PS{} file of the \acro{DVI} and then use \ProgName{ghostscript} to +produce the required bitmap format (possibly by way of \acro{PNM} +format or something similar). This is an undesirable procedure (it is +very slow, and requires two or three steps) but it has served for a +long time. + +\AllTeX{} users may now take advantage of two bitmap `drivers'. The +longer-established, \ProgName{dvi2bitmap}, will generate \acro{XBM} and +\acro{XPM} formats, the long-deprecated \acro{GIF} format (which is +now obsolescent, but has finally been relieved of the patent +protection of the \acro{LZW} compression it uses), and also +the modern (\acro{ISO}-standardised) \acro{PNG} format. + +Dvipng started out as a PNG renderer; from version 1.2 it can also +render to the GIF format. It is designed for speed, in environments that +generate large numbers of \acro{PNG} files: the \File{README} mentions +\ProgName{preview}-\ProgName{latex}, \ProgName{LyX}, and a few +web-oriented environments. Note that \ProgName{dvipng} gives +high-quality output even though its internal operations are optimised +for speed. +\begin{ctanrefs} +\item[dvi2bitmap]\CTANref{dvi2bitmap} +\item[dvipng]\CTANref{dvipng} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-fmt-conv.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-fmt-conv.tex new file mode 100644 index 00000000000..9ea9dd55dbd --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-fmt-conv.tex @@ -0,0 +1,427 @@ +% $Id: faq-fmt-conv.tex,v 1.1 2009/06/13 20:56:40 rf10 Exp rf10 $ + +\section{Format conversions} + +\Question[Q-toascii]{Conversion from \AllTeX{} to plain text} + +The aim here is to emulate the Unix \ProgName{nroff}, which formats +text as best it can for the screen, from the same +input as the Unix typesetting program \ProgName{troff}. + +Converting \acro{DVI} to plain text is the basis of many of these +techniques; sometimes the simple conversion provides a good enough +response. Options are: +\begin{itemize} +\item \ProgName{dvi2tty} (one of the earliest), +\item \ProgName{crudetype} and +\item \ProgName{catdvi}, which is capable of generating Latin-1 + (ISO~8859-1) or \acro{UTF}-8 encoded output. \ProgName{Catdvi} was + conceived as a replacement for \ProgName{dvi2tty}, but can't (quite) + be recommended as a complete replacement yet. +\end{itemize} +A common problem is the hyphenation that \TeX{} inserts when +typesetting something: since the output is inevitably viewed using +fonts that don't match the original, the hyphenation usually looks +silly. + +Ralph Droms provides a \Package{txt} bundle of things in support of +\acro{ASCII} generation, +but it doesn't do a good job with tables and mathematics. An +alternative is the \Package{screen} package. + +Another possibility is to +use the \LaTeX{}-to-\acro{ASCII} conversion program, \ProgName{l2a}, +although this is really more of a de-\TeX{}ing program. + +The canonical de-\TeX{}ing program is \ProgName{detex}, which removes +all comments and control sequences +from its input before writing it to its output. Its original purpose +was to prepare input for a dumb spelling checker, and it's only usable +for preparing useful \acro{ASCII} versions of a document in highly +restricted circumstances. + +\ProgName{Tex2mail} is slightly more than a de-TeX{}er~--- it's a +\ProgName{Perl} script that converts \TeX{} files into +plain text files, expanding various mathematical symbols +(sums, products, integrals, sub/superscripts, fractions, square +roots, \dots{}\@) into ``\acro{ASCII} art'' that spreads over +multiple lines if necessary. The result is more readable to human +beings than the flat-style \TeX{} code. + +Another significant possibility is to use one of the +\Qref*{\acro{HTML}-generation solutions}{Q-LaTeX2HTML}, +and then to use a browser such as \ProgName{lynx} to dump the resulting +\acro{HTML} as plain text. +\begin{ctanrefs} +\item[catdvi]\CTANref{catdvi} +\item[crudetype]\CTANref{crudetype} +\item[detex]\CTANref{detex} +\item[dvi2tty]\CTANref{dvi2tty} +\item[l2a]\CTANref{l2a} +\item[screen.sty]\CTANref{screensty} +\item[tex2mail]\CTANref{tex2mail} +\item[txt]\CTANref{txtdist} +\end{ctanrefs} + +\Question[Q-SGML2TeX]{Conversion from \acro{SGML} or \acro{HTML} to \protect\TeX{}} + +\acro{SGML} is a very important system for document storage and interchange, +but it has no formatting features; its companion \acro{ISO} standard +\acro{DSSSL} +(see \URL{http://www.jclark.com/dsssl/}) is designed for writing +transformations and formatting, +but this has not yet been widely implemented. Some \acro{SGML} authoring +systems (e.g., SoftQuad \ProgName{Author/Editor}) have formatting +abilities, and +there are high-end specialist \acro{SGML} typesetting systems (e.g., Miles33's +\ProgName{Genera}). However, the majority of \acro{SGML} users probably transform +the source to an existing typesetting system when they want to print. +\TeX{} is a good candidate for this. There are three approaches to writing a +translator: +\begin{enumerate} +\item Write a free-standing translator in the traditional way, with + tools like \ProgName{yacc} and \ProgName{lex}; this is hard, in + practice, because of the complexity of \acro{SGML}. +\item Use a specialist language designed for \acro{SGML} transformations; the + best known are probably \ProgName{Omnimark} and \ProgName{Balise}. + They are expensive, but powerful, incorporating \acro{SGML} query and + transformation abilities as well as simple translation. +\item Build a translator on top of an existing \acro{SGML} parser. By far + the best-known (and free!) parser is James Clark's + \ProgName{nsgmls}, and this produces a much simpler output format, + called \acro{ESIS}, which can be parsed quite straightforwardly (one also + has the benefit of an \acro{SGML} parse against the \acro{DTD}). Two + good public domain packages use this method: + \begin{itemize} + \item +\begin{narrowversion} % really non-hyper + David Megginson's \ProgName{sgmlspm}, written in \ProgName{Perl} + 5, which is available from + \URL{http://www.perl.com/CPAN/modules/by-module/SGMLS} +\end{narrowversion} +\begin{wideversion} + David Megginson's + \href{http://www.perl.com/CPAN/modules/by-module/SGMLS}{\ProgName{sgmlspm}}, + written in \ProgName{Perl} 5. +\end{wideversion} + \item +\begin{narrowversion} % really non-hyper + Joachim Schrod and Christine Detig's \ProgName{STIL} + (`\acro{SGML} Transformations in Lisp'), which is available from + \URL{ftp://ftp.tu-darmstadt.de/pub/text/sgml/stil} +\end{narrowversion} +\begin{wideversion} + Joachim Schrod and Christine Detig's + \href{ftp://ftp.tu-darmstadt.de/pub/text/sgml/stil}{\ProgName{STIL}}, + (`\acro{SGML} Transformations in Lisp'). +\end{wideversion} + \end{itemize} + Both of these allow the user to write `handlers' for every \acro{SGML} + element, with plenty of access to attributes, entities, and + information about the context within the document tree. + + If these packages don't meet your needs for an average \acro{SGML} + typesetting job, you need the big commercial stuff. +\end{enumerate} + +Since \acro{HTML} is simply an example of \acro{SGML}, we do not need a specific +system for \acro{HTML}. However, Nathan Torkington developed +% (\Email{Nathan.Torkington@vuw.ac.nz}) +\ProgName{html2latex} from the \acro{HTML} parser in \acro{NCSA}'s +Xmosaic package. +The program takes an \acro{HTML} file and generates a \LaTeX{} file from it. +The conversion code is subject to \acro{NCSA} restrictions, but the whole +source is available on \acro{CTAN}. + +Michel Goossens and Janne Saarela published a very useful summary of +\acro{SGML}, and of public domain tools for writing and manipulating it, in +\TUGboat{} 16(2). +\begin{ctanrefs} +\item[html2latex \nothtml{\rmfamily}source]\CTANref{html2latex} +\end{ctanrefs} + +\Question[Q-LaTeX2HTML]{Conversion from \AllTeX{} to \acro{HTML}} + +\TeX{} and \LaTeX{} are well suited to producing electronically publishable +documents. However, it is important to realize the difference +between page layout and functional markup. \TeX{} is capable of +extremely detailed page layout; \acro{HTML} is not, because \acro{HTML} is a +functional markup language not a page layout language. \acro{HTML}'s exact +rendering is not specified by the document that is published but is, to +some degree, left to the discretion of the browser. If you require your +readers to see an exact replication of what your document looks like +to you, then you cannot use \acro{HTML} and you must use some other +publishing format such as \acro{PDF}. That is true for any \acro{HTML} +authoring tool. + +\TeX{}'s excellent mathematical capabilities remain a challenge in the +business of conversion to \acro{HTML}. There are only two generally +reliable techniques for generating mathematics on the web: creating +bitmaps of bits of typesetting that can't be translated, and using +symbols and table constructs. Neither technique is entirely +satisfactory. Bitmaps lead to a profusion of tiny files, are slow to +load, and are inaccessible to those with visual disabilities. The +symbol fonts offer poor coverage of mathematics, and their use +requires configuration of the browser. The future of mathematical +browsing may be brighter~--- see +% beware line break +\Qref[question]{future Web technologies}{Q-mathml}. + +For today, possible packages are: +\begin{description} +\item[\ProgName{LaTeX2HTML}]a \ProgName{Perl} script package that + supports \LaTeX{} only, and generates mathematics (and other + ``difficult'' things) using bitmaps. The original version was + written by Nikos Drakos for Unix systems, but the package now sports + an illustrious list of co-authors and is also available for Windows + systems. Michel Goossens and Janne Saarela published a detailed + discussion of \ProgName{LaTeX2HTML}, and how to tailor it, in + \TUGboat{} 16(2). + + A mailing list for users may be found via + \URL{http://tug.org/mailman/listinfo/latex2html} +\item[\ProgName{TtH}]a compiled program that supports either \LaTeX{} + or \plaintex{}, and uses the font/table technique for representing + mathematics. It is written by Ian Hutchinson, using + \ProgName{flex}. The distribution consists of a single \acro{C} + source (or a compiled executable), which is easy to install and very + fast-running. +\item[\ProgName{Tex4ht}]a compiled program that supports either + \LaTeX{} or \plaintex{}, by processing a \acro{DVI} file; it uses + bitmaps for mathematics, but can also use other technologies where + appropriate. Written by Eitan Gurari, it parses the \acro{DVI} + file generated when you run \AllTeX{} over your file with + \ProgName{tex4ht}'s macros included. As a result, it's pretty + robust against the macros you include in your document, and it's + also pretty fast. +\item[\ProgName{plasTeX}]a Python-based \LaTeX{} document processing + framework. It gives DOM-like access to a \LaTeX{} document, as + well as the ability to generate mulitple output formats + (e.g. HTML, DocBook, tBook, etc.). +\item[\ProgName{TeXpider}]a commercial program from + \Qref*{Micropress}{Q-commercial}, which is + described on \URL{http://www.micropress-inc.com/webb/wbstart.htm}; + it uses bitmaps for equations. +\item[\ProgName{Hevea}] a compiled program that supports \LaTeX{} + only, and uses the font/table technique for equations (indeed its + entire approach is very similar to \ProgName{TtH}). It is written + in Objective \acro{CAML} by Luc Maranget. \ProgName{Hevea} isn't + archived on \acro{CTAN}; details (including download points) are + available via \URL{http://pauillac.inria.fr/~maranget/hevea/} +\end{description} +An interesting set of samples, including conversion of the same text +by the four free programs listed above, is available at +\URL{http://www.mayer.dial.pipex.com/samples/example.htm}; a linked +page gives lists of pros and cons, by way of comparison. + +The World Wide Web Consortium maintains a list of ``filters'' to +\acro{HTML}, with sections on \AllTeX{} and \BibTeX{}~--- see +\URL{http://www.w3.org/Tools/Word_proc_filters.html} +\begin{ctanrefs} +\item[latex2html]Browse \CTANref{latex2html} +\item[plasTeX]Browse \CTANref{plastex} +\item[tex4ht]\CTANref{tex4ht} +\item[tth]\CTANref{tth} +\end{ctanrefs} + +\Question[Q-fmtconv]{Other conversions to and from \AllTeX{}} + +\begin{description} +\item[troff]\ProgName{Tr2latex}, assists in the translation of a + \ProgName{troff} document into \LaTeXo{} format. It recognises most + |-ms| and |-man| macros, plus most \ProgName{eqn} and some + \ProgName{tbl} preprocessor commands. Anything fancier needs to be + done by hand. Two style files are provided. There is also a man page + (which converts very well to \LaTeX{}\dots{}). + \ProgName{Tr2latex} is an enhanced version of the earlier + \ProgName{troff-to-latex} (which is no longer available). + +% The \acro{DECUS} \TeX{} distribution (see +% \Qref[question]{sources of software}{Q-archives}) +% also contains a program which converts \ProgName{troff} to \TeX{}. + +%\item[Scribe] Mark James (\Email{jamesm@dialogic.com}) has a copy of +% \ProgName{scribe2latex} he has been unable to test but which he will +% let anyone interested have. The program was written by Van Jacobson +% of Lawrence Berkeley Laboratory.% +% \checked{RF}{1994/11/18} + +\item[WordPerfect] \ProgName{wp2latex} is actively maintained, and is + available either for \MSDOS{} or for Unix systems. +\item[\acro{RTF}] \ProgName{Rtf2tex}, by Robert Lupton, is for + converting Microsoft's Rich Text Format to \TeX{}. There is also a + converter to \LaTeX{} by Erwin Wechtl, called \ProgName{rtf2latex}. + The latest converter, by Ujwal Sathyam and Scott Prahl, is + \ProgName{rtf2latex2e} which seems rather good, though development + of it seems to have stalled. + + Translation \emph{to} \acro{RTF} may be done (for a somewhat + constrained set of \LaTeX{} documents) by \TeX{}2\acro{RTF}, which + can produce ordinary \acro{RTF}, Windows Help \acro{RTF} (as well as + \acro{HTML}, \Qref{conversion to HTML}{Q-LaTeX2HTML}). + \TeX{}2\acro{RTF} is supported on various Unix platforms and under + Windows~3.1 +\item[Microsoft Word] A rudimentary (free) program for converting + MS-Word to \LaTeX{} is \ProgName{wd2latex}, which runs on \MSDOS{}. + \ProgName{Word2}\emph{\TeX{}} and \emph{\TeX{}}\ProgName{2Word} are + shareware translators from % beware line break + \href{http://www.chikrii.com/}{Chikrii Softlab}; users' reports are + very positive. + + The excellent \ProgName{tex4ht} will generate OpenOffice \acro{ODT} + format, which can be used as an intermediate to producing Word + format files. + + If cost is a constraint, the best bet is probably to use an + intermediate format such as \acro{RTF} or \acro{HTML}. + \ProgName{Word} outputs and reads both, so in principle this route + may be useful. + + You can also use \acro{PDF} as an intermediate format: Acrobat Reader + for Windows (version 5.0 and later) will output rather feeble + \acro{RTF} that \ProgName{Word} can read. +\item[Excel] \ProgName{Excel2Latex} converts an \ProgName{Excel} file + into a \LaTeX{} \environment{tabular} environment; it comes as a + \extension{xls} file which defines some \ProgName{Excel} macros to produce + output in a new format. +\item[runoff] Peter Vanroose's \ProgName{rnototex} + conversion program is written in \acro{VMS} Pascal. + The sources are distributed with a \acro{VAX} executable. +\item[refer/tib] There are a few programs for converting bibliographic + data between \BibTeX{} and \ProgName{refer}/\ProgName{tib} formats. + The collection includes a shell script converter from \BibTeX{} to + \ProgName{refer} format as well. The collection + is not maintained. +\item[\acro{PC}-Write]\ProgName{pcwritex.arc} is a + print driver for \acro{PC}-Write that ``prints'' a \acro{PC}-Write + V2.71 document to a \TeX{}-compatible disk file. It was written by Peter + Flynn at University College, Cork, Republic of Ireland. +\end{description} + +% beware line breaks +\href{http://www.tug.org/utilities/texconv/index.html}{Wilfried Hennings' \acro{FAQ}}, +which deals specifically with conversions between \TeX{}-based formats +and word processor formats, offers much detail as well as tables that +allow quick comparison of features. + +A group at Ohio State University (\acro{USA}) is working on +a common document format based on \acro{SGML}, with the ambition that any +format could be +translated to or from this one. \ProgName{FrameMaker} provides +``import filters'' to aid translation from alien formats +(presumably including \TeX{}) to \ProgName{FrameMaker}'s own. +\begin{ctanrefs} +\item[excel2latex]\CTANref{excel2latex} +\item[pcwritex.arc]\CTANref{pcwritex} +\item[refer and tib tools]\CTANref{refer-tools} +\item[rnototex]\CTANref{rnototex} +\item[rtf2latex]\CTANref{rtf2latex} +\item[rtf2latex2e]\CTANref{rtf2latex2e} +\item[rtf2tex]\CTANref{rtf2tex} +\item[tex2rtf]\CTANref{tex2rtf} +\item[tr2latex]\CTANref{tr2latex} +\item[wd2latex]\CTANref{wd2latex} +\item[wp2latex]\CTANref{wp2latex} +\item[\nothtml{\rmfamily}Word processor \acro{FAQ} (source)]% + \CTANref{texcnvfaq} +\end{ctanrefs} + +\Question[Q-readML]{Using \TeX{} to read \acro{SGML} or \acro{XML} directly} + +This can nowadays be done, with a certain amount of clever macro +programming. David Carlisle's \Package{xmltex} is the prime example; +it offers a practical solution to typesetting +\acro{XML} files. + +One use of a \TeX{} that can typeset \acro{XML} files is as a backend +processor for \acro{XSL} formatting objects, serialized as \acro{XML}. +Sebastian Rahtz's Passive\TeX{} uses \Package{xmltex} to +achieve this end. +\begin{ctanrefs} +\item[xmltex]\CTANref{xmltex} +\item[passivetex]\CTANref{passivetex} +\end{ctanrefs} + +\Question[Q-recovertex]{Retrieving \AllTeX{} from \acro{DVI}, etc.} + +The job just can't be done automatically: \acro{DVI}, \PS{} and +\acro{PDF} are ``final'' formats, supposedly not susceptible to +further editing~--- information about where things came from has been +discarded. So if you've lost your \AllTeX{} source (or never +had the source of a document you need to work on) you've a serious job +on your hands. In many circumstances, the best strategy is to retype +the whole document, but this strategy is to be tempered by +consideration of the size of the document and the potential typists' +skills. + +If automatic assistance is necessary, it's unlikely that any more than +text retrieval is going to be possible; the \AllTeX{} markup that +creates the typographic effects of the document needs to be recreated +by editing. + +If the file you have is in \acro{DVI} format, many of the techniques +for \Qref*{converting \AllTeX{} to \acro{ASCII}}{Q-toascii} are +applicable. Consider \ProgName{dvi2tty}, \ProgName{crudetype} and +\ProgName{catdvi}. Remember that there are likely to be problems +finding included material (such as included \PS{} figures, that +don't appear in the \acro{DVI} file itself), and mathematics is +unlikely to convert easily. + +To retrieve text from \PS{} files, the +\ProgName{ps2ascii} tool (part of the \ProgName{ghostscript} +distribution) is available. One could try applying this tool to +\PS{} derived from an \acro{PDF} file using \ProgName{pdf2ps} (also +from the \ProgName{ghostscript} distribution), or \ProgName{Acrobat} +\ProgName{Reader} itself; an alternative is \ProgName{pdftotext}, +which is distributed with \ProgName{xpdf}. + +Another avenue available to those with a \acro{PDF} file they want to +process is offered by Adobe \ProgName{Acrobat} (version 5 or later): +you can tag the \acro{PDF} file into an estructured document, output +thence to well-formed \acro{XHTML}, and import the results into +Microsoft \ProgName{Word} (2000 or later). From there, one may +convert to \AllTeX{} using one of the techniques discussed in +% beware line break +\wideonly{``}\Qref[question]{converting to and from \AllTeX{}}{Q-fmtconv}\wideonly{''}. + +The result will typically (at best) be poorly marked-up. Problems may +also arise from the oddity of typical \TeX{} font encodings (notably +those of the maths fonts), which \ProgName{Acrobat} doesn't know how +to map to its standard Unicode representation. +\begin{ctanrefs} +\item[catdvi]\CTANref{catdvi} +\item[crudetype]\CTANref{crudetype} +\item[dvi2tty]\CTANref{dvi2tty} +\item[ghostscript]Browse \CTANref{ghostscript} +\item[xpdf]Browse \CTANref{xpdf} +\end{ctanrefs} +\LastEdit{2009-05-29} + +\Question[Q-LaTeXtoPlain]{Translating \LaTeX{} to \plaintex{}} + +Unfortunately, no ``general'', simple, automatic process is likely to +succeed at this task. See % ! line break +``\Qref*{How does \LaTeX{} relate to \plaintex{}}{Q-LaTeXandPlain}'' +for further details. + +Translating a document designed to work with \LaTeX{} into one +designed to work with \plaintex{} is likely to amount to carefully +including (or otherwise re-implementing) all those parts of \LaTeX{}, +beyond the provisions of \plaintex{}, which the document uses. + +Some of this work is has (in a sense) been done, in the port of the +\LaTeX{} graphics package to \plaintex{}. However, while +\Package{graphics} is available, other complicated packages (notably +\Package{hyperref}) are not. The aspiring translator may find the +\Qref*{\Eplain{}}{Q-eplain} system a useful source of code. (In fact, +a light-weight system such as \Eplain{} might reasonably be adopted as +an alternative target of translation, though it undoubtedly gives the +user more than the ``bare minimum'' that \plaintex{} is designed to +offer.) +\begin{ctanrefs} +\item[\latexhtml{\textrm{The}}{The} eplain \nothtml{\rmfamily}system]% + \CTANref{eplain} +\item[\latexhtml{\textrm{`\plaintex{}'}}{\plaintex{}} graphics]% + \CTANref{graphics-plain} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-fonts.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-fonts.tex new file mode 100644 index 00000000000..3b13470b17d --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-fonts.tex @@ -0,0 +1,1153 @@ +% $Id: faq-fonts.tex,v 1.4 2009/08/25 06:49:51 rf10 Exp rf10 $ + +\section{Fonts} + +\subsection{\MF{} fonts} + +\Question[Q-useMF]{Getting \MF{} to do what you want} + +\MF{} allows you to create your own fonts, and most \TeX{} users +will never need to use it~--- modern \AllTeX{} systems contain +rather few \MF{} fonts of any significance, and when \MF{} output is +needed the font generation is done, automatically, ``on the fly''. + +If you find you have some special requirement that the system doesn't +satisfy, you need to know about \MF{} in rather more detail. \MF{}, +unlike \TeX{}, requires customisation for each output device: such +customisation is conventionally held in a ``mode'' associated with the +device. Modes are commonly defined using the \texttt{mode\_def} +convention described on page~94 of \emph{The \MF{}book} % ! line break +(see \Qref[question]{\TeX{}-related books}{Q-books}). You will need +a file, conventionally called \File{local.mf}, containing all the +\texttt{mode\_def}s you will be using. In the unlikely event that +\File{local.mf} doesn't already exist, Karl Berry's collection of +modes (\File{modes.mf}) is a good starting point +(it can be used as a `\File{local.mf}' without modification in a +typical modern implementation of \MF{}). Lists of +settings for various output devices are also published periodically in +\textsl{TUGboat} (see \Qref[question]{\acro{TUG}}{Q-TUG*}). Now create +a \texttt{plain} base file using \ProgName{mf} (in ``initialisation'' +mode), \texttt{plain.mf}, and \texttt{local.mf}: +\begin{htmlversion} +\begin{quote} +\begin{verbatim} +% mf -ini +This is METAFONT... +**plain # you type plain +(output) +*input local # you type this +(output) +*dump # you type this +Beginning to dump on file plain... +(output) +\end{verbatim} +\end{quote} +\end{htmlversion} +\htmlignore +\begin{list}{}{}\item\relax + \texttt{\% mf -ini}\\ + This is METAFONT\dots{}\\{} + \fullline{**\texttt{plain}\hss you type `\texttt{plain}'} + (\emph{output})\\{} + \fullline{*\texttt{input local}\hss you type this} + (\emph{output})\\{} + \fullline{*\texttt{dump}\hss you type this} + Beginning to dump on file plain\dots{}\\{} + (\emph{output}) +\end{list}\par +\endhtmlignore +This will create a base file named \File{plain.base} +(or something similar; for example, it will be \File{PLAIN.BAS} +on \MSDOS{} systems). Move the file to the directory containing +the base files on your system. + +Now you need to make sure \MF{} loads this new base when it starts up. If +\MF{} loads the \texttt{plain} base by default on your system, then you're +ready to go. Under Unix (using the default \texlive{} (and earlier) +distributions this does indeed happen, but we could for instance +define a command \ProgName{plainmf}% +\begin{footnoteenv} + On the grounds that a command \ProgName{plain} could be misconstrued + as a reference to \plaintex{} +\end{footnoteenv} +which executes `\texttt{mf -base=plain}' (or, in more traditional +style `\texttt{mf \&plain}') which loads the \texttt{plain} base +file. + +The usual way to create a font with \MF{} (with an appropriate base +file loaded) is to start \MF{}'s input with the +\begin{narrowversion} + lines + \begin{quote} + \csx{mode}\texttt{=<mode name>;}\\ + \texttt{mag=<magnification>;}\\ + \texttt{input <font file name>} + \end{quote} +\end{narrowversion} +\begin{wideversion} +line +\begin{verbatim} +\mode=<mode name>; mag=<magnification>; input <font file name> +\end{verbatim} +\end{wideversion} +in response to the `\texttt{**}' prompt or on the \MF{} command line. (If +\texttt{<mode name>} is unknown or omitted, the mode defaults to +`proof' mode and \MF{} will produce an output file called % ! line break +\File{<font file name>.2602gf}) +The \texttt{<magnification>} is a floating point number or +`magstep' (magsteps are defined in \emph{The \MF{}book} and +\emph{The \TeX{}book}). +If \texttt{mag=<magnification>} is omitted, then the default +is 1~(magstep 0). For example, to generate cmr10 at 12pt for an Epson +printer you might type +\begin{quote} +\begin{verbatim} +mf \mode=epson; mag=magstep 1; input cmr10 +\end{verbatim} +\end{quote} +Note that under Unix the \texttt{\textbackslash } and \texttt{;} +characters must usually be quoted or escaped, so this would typically +look something like +\begin{quote} +\begin{verbatim} + mf '\mode=epson; mag=magstep 1; input cmr10' +\end{verbatim} +\end{quote} +If you need a special mode that isn't in the base, you can put its +commands in a file (\emph{e.g.}, \File{ln03.mf}) and invoke it on the +fly with the \csx{smode} command. For example, to create +\File{cmr10.300gf} for an \acro{LN}03 printer, using the file +\begin{quote} +\begin{verbatim} +% This is ln03.mf as of 1990/02/27 +% mode_def courtesy of John Sauter +proofing:=0; +fontmaking:=1; +tracingtitles:=0; +pixels_per_inch:=300; +blacker:=0.65; +fillin:=-0.1; +o_correction:=.5; +\end{verbatim} +\end{quote} +(note the absence of the \texttt{mode\_def} and \texttt{enddef} +commands), you would type +\begin{quote} +\begin{verbatim} +mf \smode="ln03"; input cmr10 +\end{verbatim} +\end{quote} +This technique isn't one you should regularly use, but it may +prove useful if you acquire a new printer and want to experiment with +parameters, or for some other reason are regularly editing the +parameters you're using. Once you've settled on an appropriate set of +parameters, you should use them to rebuild the base file that you use. + +Other sources of help are discussed in our list of % ! line break +\Qref*{\MF{} and \MP{} Tutorials}{Q-mfptutorials}. +\begin{ctanrefs} +\item[modes.mf]\CTANref{modes-file} +\end{ctanrefs} + +\Question[Q-keepfonts]{Which font files should be kept} + +\MF{} produces from its run three files, a metrics (\acro{TFM}) file, a +generic font (\acro{GF}) file, and a log file; all of these files have the +same base name as does the input (\emph{e.g.}, if the input file was +\File{cmr10.mf}, the outputs will be \File{cmr10.tfm}, +\File{cmr10.nnngf}% +\begin{footnoteenv} + Note that the file name may be transmuted by such operating systems + as \MSDOS{}, which don't permit long file names +\end{footnoteenv} +and \File{cmr10.log}). + +For \TeX{} to use the font, you need a \acro{TFM} file, so you need +to keep that. However, you are likely to generate the same font +at more than one magnification, and each time you do so you'll +(incidentally) generate another \acro{TFM} file; these files are +all the same, so you only need to keep one of them. + +To preview or to produce printed output, the \acro{DVI} processor will need a +font raster file; this is what the \acro{GF} file provides. However, while +there used (once upon a time) to be \acro{DVI} processors that could use +\acro{GF} files, modern processors use packed raster (\acro{PK}) files. +Therefore, you need to generate a \acro{PK} file from the \acro{GF} file; the +program \ProgName{gftopk} does this for you, and once you've done that you +may throw the \acro{GF} file away. + +The log file should never need to be used, unless there was some sort +of problem in the \MF{} run, and need not be ordinarily kept. + +\Question[Q-getbitmap]{Acquiring bitmap fonts} + +When \acro{CTAN} was young, most people would start using \TeX{} +with a 300 dots-per-inch (dpi) laser printer, and sets of Computer +Modern bitmap fonts for this resolution are available on \acro{CTAN}. +(There are separate sets for write-black and write-white printers, as +well as sets at 120~dpi and 240~dpi.) + +Over the years, there have been regular requests that \acro{CTAN} should hold +a wider range of resolutions, but they were resisted for two reasons: +\begin{itemize} +\item The need to decide which printers to generate fonts for. The + broad-brush approach taken for 300~dpi printers was (more or less) + justified back then, given the dominance of certain printer + `engines', but nowadays one could not make any such assumption. +\item Given the above, justifying the space taken up by a huge array + of bitmap fonts. +\end{itemize} +Fortunately, \AllTeX{} distribution technology has put a stop to these +arguments: most (if not all) current distributions generate bitmap +fonts as needed, and cache them for later re-use. The impatient +user, who is determined that all bitmap fonts should be created once +and for all, may be supported by scripts such as \ProgName{allcm} +(distributed with \texlive{}, at least; otherwise such a +person should consult ``\Qref*{the use of \MF{}}{Q-useMF})''. + +If your output is to a \PS{}-capable device, or if your output is +destined to be converted to \acro{PDF}, you should switch to +using Type~1 versions of the \acro{CM} fonts. Two free +sets are available; the older (\Package{bakoma}) is +somewhat less well produced than the \Package{bluesky} fonts, which were +originally professionally produced and sold, but were then released +for general public use by their originators \YandY{} and Bluesky Research, +in association with the \acro{AMS} and other scientific publishers +(they are nowadays available under the SIL's Open Fonts Licence). The +two sets contain slightly different ranges of fonts, but you are +advised to use the +\Package{bluesky} set except when \Package{bakoma} is for some reason +absolutely unavoidable. In recent years, several other `\MF{}' fonts +have been converted to Type~1 format; it's common never to need to +generate bitmap fonts for any purpose other than previewing (see +% beware of line wrap +\Qref*{``previewing documents with Type~1 fonts''}{Q-PSpreview}), +if even then. + +More modern fonts may be used in place of the Computer Modern set. The +\Qref*{\acro{EC} fonts}{Q-ECfonts} and the % ! line break +\Qref*{Latin Modern fonts}{Q-uselmfonts} are both close relatives of +Computer Modern with wider ranges of glyphs to offer. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}BaKoMa fonts]\CTANref{bakoma} +\item[\nothtml{\rmfamily}Bluesky fonts]Distributed as part of + \CTANref{amsfonts} +\item[\nothtml{\rmfamily}CM fonts (write-black printers)]\CTANref{pk300} +\item[\nothtml{\rmfamily}CM fonts (write-white printers)]\CTANref{pk300w} +\item[\nothtml{\rmfamily}EC fonts (Type 1 format)]\CTANref{cm-super} +\item[\nothtml{\rmfamily}Latin Modern fonts]\CTANref{lm} +\end{ctanrefs} + +\subsection{Adobe Type~1 (``\PS{}'') fonts} + +\Question[Q-usepsfont]{Using \PS{} fonts with \protect\TeX{}} + +In order to use \PS{} fonts, \TeX{} needs +\emph{metric} (called \acro{TFM}) files. Several sets of metrics are +available from the archives; for mechanisms for generating new ones, +see \Qref[question]{metrics for \PS{} fonts}{Q-metrics}. You +also need the fonts themselves; \PS{} printers come with a set of +fonts built in, but to extend your repertoire you almost invariably +need to buy from one of the many commercial font vendors (see, for +example, \Qref[question]{``choice of fonts''}{Q-psfchoice}). + +If you use \LaTeXe{}, the best way to get \PS{} fonts into your +document is to use the \acro{PSNFSS} package maintained by Walter +Schmidt. The \LaTeX{}3 project team declare that \acro{PSNFSS} is +``required'', and bug reports may be submitted via the % line break +\Qref*{\LaTeX{} bugs system}{Q-latexbug}. +\acro{PSNFSS} gives you a set of packages for changing the default +roman, sans-serif and typewriter fonts; \emph{e.g}., the +\Package{mathptmx} package will set up \FontName{Times} +\FontName{Roman} as the main text font (and introduces mechanisms to +typeset mathematics using \FontName{Times} and various more-or-less +matching fonts), while package \Package{avant} changes the sans-serif +family to \FontName{AvantGarde}, and \Package{courier} changes the +typewriter font to \FontName{Courier}. To go with these +packages, you need the font metric files +and font description (\File{.fd}) files for each font family you +want to use. For convenience, +metrics for the `common 35' \PS{} fonts found in most \PS{} printers +are provided with \acro{PSNFSS}, packaged as the ``Laserwriter set''. + +For older versions of \LaTeX{} there are various schemes, of which the +simplest to use is probably the \acro{PS}\LaTeX{} macros distributed with +\ProgName{dvips}. + +For \plaintex{}, you load whatever fonts you like; if the encoding of +the fonts is not the same as Computer Modern it will be up to you to +redefine various macros and accents, or you can use the font +re-encoding mechanisms available in many drivers and in +\ProgName{ps2pk} and \ProgName{afm2tfm}. + +Victor Eijkhout's \Qref*{Lollipop package}{Q-lollipop} +supports declaration of font families and styles in a similar way to +\LaTeX{}'s \acro{NFSS}, and so is easy to use with \PS{} fonts. + +Some common problems encountered are discussed elsewhere +(see \Qref[question]{problems with \acro{PS} fonts}{Q-psfontprob}). +\begin{ctanrefs} +\item[Metrics for the `Laserwriter' set of 35 fonts]\CTANref{lw35nfss-zip} +\item[lollipop]\CTANref{lollipop} +\item[psnfss]\CTANref{psnfss} +\end{ctanrefs} + +\Question[Q-PSpreview]{Previewing files using Type 1 fonts} + +Until recently, free \TeX{} previewers have only been capable of +displaying bitmap \acro{PK} fonts, but current versions of +\ProgName{xdvi} sport a Type~1 font renderer. +%% \YandY{}'s commercial +%% previewer \Qref*{\acro{DVIW}indo}{Q-commercial} has in the past used +%% \ProgName{Adobe} \ProgName{Type} \ProgName{Manager} to display Type~1 +%% fonts directly and now uses the system-provided font renderer +%% available in Windows~2000 and~XP. + +Other (free) previewers of the current generation offer automatic +generation of the requisite \acro{PK} files (using \ProgName{gsftopk}, +or similar, behind the scenes). If your previewer isn't capable of +this, you have three options: +\begin{itemize} +\item Convert the \acro{DVI} file to \PS{} and use a + \PS{} previewer. Some systems offer this capability as + standard, but most people will need to use a separate previewer such + as \ProgName{ghostscript} or \ProgName{ghostscript}-based viewers + such as \ProgName{gv} or shareware offering \ProgName{GSview}. +\item Under Windows on a \acro{PC}, or on a Macintosh, let Adobe Type Manager + display the fonts (textures, on the Macintosh, works like this). +%% , and under +%% Windows you can use \YandY{}'s \ProgName{dviwindo} for bitmap-free +%% previewing. +\begin{narrowversion} % really hyper + (See \Qref[question]{}{Q-commercial} for details of these + suppliers.) +\end{narrowversion} +%\typeout{after narrowversion, before wideversion} +\begin{wideversion} + (See \Qref{commercial suppliers}{Q-commercial} for details.) +\end{wideversion} +%\typeout{after wideversion} +\item If you have the \PS{} fonts in Type~1 format, + use \ProgName{ps2pk} or \ProgName{gsftopk} + (designed for use with the \ProgName{ghostscript} fonts) to make + \acro{PK} bitmap fonts which your previewer + will understand. This can produce excellent results, also suitable + for printing with non-\PS{} devices. Check the legalities of + this if you have purchased the fonts. +\end{itemize} +\begin{ctanrefs} +\item[ghostscript]Browse \CTANref{ghostscript} +\item[gsftopk]\CTANref{gsftopk} +\item[GSview]Browse \CTANref{gsview} +\item[gv]Browse \CTANref{gv} +\item[ps2pk]\CTANref{ps2pk} +\item[xdvi]\CTANref{xdvi} +\end{ctanrefs} + +\Question[Q-metrics]{\protect\TeX{} font metric files for \PS{} fonts} + +Reputable font vendors such as Adobe supply metric files for each +font, in \acro{AFM} (Adobe Font Metric) form; these can be converted +to \acro{TFM} (\TeX{} Font Metric) form. Most modern distributions have +prebuilt metrics which will be more than enough for many people; but you may +need to do the conversion yourself if you have special needs or +acquire a new font. One important question is the \emph{encoding} of +(Latin character) fonts; while we all more or less agree about the +position of about 96 characters in fonts (the basic \acro{ASCII} set), the +rest of the (typically) 256 vary. The most obvious problems are with +floating accents and special characters such as the `pounds sterling' +sign. There are three ways of dealing with this: either you change the +\TeX{} macros which reference the characters (not much fun, and +error-prone); or you change the encoding of the font (easier than you +might think); or you use \Qref*{virtual fonts}{Q-virtualfonts} to +\emph{pretend} to \TeX{} that the encoding is the same as it is used to. +\LaTeXe{} has facilities for dealing with fonts in different +encodings; read the \Qref*{\emph{\LaTeX{} Companion}}{Q-books} for +more details. In practice, if you do much non-English (but Latin +script) typesetting, you are strongly recommended to use the +\Package{fontenc} package with option `\pkgoption{T1}' to select +\Qref*{`Cork'}{Q-ECfonts} encoding. +A useful alternative is \YandY{}'s ``private'' \acro{LY}1 encoding, +which is designed to sit well with ``Adobe standard'' encoded fonts. +Basic support of \acro{LY1} is available on \acro{CTAN}: note that the +``relation with Adobe's encoding'' means that there are no +virtual fonts in the \acro{LY}1 world. + +Alan Jeffrey's \ProgName{fontinst} package is an \acro{AFM} to +\acro{TFM} converter written in \TeX{}; it is used to generate the +files used by \LaTeXe{}'s \acro{PSNFSS} package to support use of +\PS{} fonts. It is a sophisticated package, not for the faint-hearted, +but is powerful enough to cope with most needs. Much of its power +relies on the use of \Qref*{virtual fonts}{Q-virtualfonts}. + +For slightly simpler problems, Rokicki's \ProgName{afm2tfm}, +distributed with \ProgName{dvips}, is fast and +efficient; note that the metrics and styles that come with +\ProgName{dvips} are \emph{not} currently \LaTeXe{} compatible. + +For the Macintosh (classic), there is a program called +\ProgName{EdMetrics} which does the job (and more). +\ProgName{EdMetrics} comes with the (commercial) +\Qref*{Textures}{Q-commercial} distribution, but is itself free +software, and is available on \acro{CTAN}. +%% \par +%% Windows users can buy \Qref*{\YandY{}'s}{Q-commercial} +%% Font Manipulation Tools package which includes a powerful +%% \ProgName{afmtotfm} program among many other goodies. +\begin{ctanrefs} +\item[dvips]\CTANref{dvips} +\item[EdMetrics]\CTANref{edmetrics} +\item[fontinst]\CTANref{fontinst} +\item[LY1 support]\CTANref{ly1} +\end{ctanrefs} + +\Question[Q-psfontprob]{Deploying Type 1 fonts} + +For the \LaTeX{} user trying to use the +\Qref*{\acro{PSNFSS}}{Q-usepsfont} package, three questions may arise. + +First, you have to declare to the \acro{DVI} driver that you are using +\PS{} fonts; in the case of \ProgName{dvips}, this means adding +lines to the \File{psfonts.map} file, so that \ProgName{dvips} will know +where the proper fonts are, and won't try to find \acro{PK} +files. If the font isn't built into the printer, you have to acquire +it (which may mean that you need to purchase the font files). + +Second, your previewer must know what to do with the fonts: see +\Qref[question]{previewing type 1 fonts}{Q-PSpreview}. + +Third, the stretch and shrink between words is a function of the +font metric; it is not specified in \acro{AFM} files, so different converters +choose different values. The \PS{} metrics that come with \acro{PSNFSS} +used to produce quite tight setting, but they were revised in mid 1995 +to produce a compromise between American and European practice. +Sophisticated users may not find even the new the values to their taste, and +want to override them. Even the casual user may find more +hyphenation or overfull boxes than Computer Modern produces; but \acro{CM} +is extremely generous. + +\Question[Q-psfchoice]{Choice of scalable outline fonts} + +If you are interested in text alone, you can in principle use any of +the huge numbers of text fonts in Adobe Type~1, TrueType or OpenType +formats. The constraint is, of course, that your previewer and +printer driver should support such fonts (\TeX{} itself \emph{only} +cares about metrics, not the actual character programs). + +If you also need mathematics, then you are severely limited by the +demands that \TeX{} makes of maths fonts (for details, see the papers +by +\begin{wideversion} +% !! line break !! + \href{http://tug.org/TUGboat/Articles/tb14-3/tb40horn.pdf}{B.K.P. Horn in \TUGboat{} 14(3)}, + or by % ! line break + \href{http://tug.org/TUGboat/Articles/tb19-2/tb59bouc.pdf}{Thierry Bouche in \TUGboat{} 19(2)}). +\end{wideversion} +\begin{narrowversion} + B.K.P. Horn in \TUGboat{} 14(3) or by Thierry Bouche in \TUGboat{} + 19(2), available as + \URL{http://tug.org/TUGboat/Articles/tb14-3/tb40horn.pdf} or + \URL{http://tug.org/TUGboat/Articles/tb19-2/tb59bouc.pdf}, respectively). +\end{narrowversion} +For mathematics, then, there are relatively few choices (though the list is +at last growing). There are several font families available that are +based on Knuth's original designs, and some that complement other +commercial text font designs; one set (MicroPress's `informal math') +stands alone. ``Free'' font families that will support \TeX{} +mathematics include: +\begin{booklist} +\item[Computer Modern](75 fonts~--- optical scaling) Donald E. Knuth\\ + The \acro{CM} fonts were originally designed in \MF{}, but are also + now available in scalable outline form. There are commercial as + well as public domain versions, and there are both Adobe Type~1 and + TrueType versions. A set of outline versions of the fonts was + developed as a commercial venture by \YandY{} and Blue Sky Research; + they have since assigned the copyright to the \acro{AMS}, and the + fonts are now freely available from \acro{CTAN}. Their quality is + such that they have become the \emph{de facto} standard for Type~1 + versions of the fonts. +\item[\acro{AMS} fonts](52 fonts, optical scaling) The \acro{AMS}\\ + This set of fonts offers adjuncts to the \acro{CM} set, including + two sets of symbol fonts (\FontName{msam} and \FontName{msbm}) and + Euler text fonts. + These are not a self-standing family, but merit discussion here (not + least because several other families mimic the symbol fonts). + Freely-available Type~1 versions of the fonts are available on + \acro{CTAN}. The \Package{eulervm} package permits use + of the Euler maths alphabet in conjunction with text fonts that do + not provide maths alphabets of their own (for instance, Adobe + Palatino or Minion). +\item[mathpazo version 1.003](5 fonts) Diego Puga\\ + The Pazo Math fonts are a family of type~1 fonts suitable for + typesetting maths in combination with the Palatino family of text + fonts. Four of the five fonts of the distribution are maths + alphabets, in upright and italic shapes, medium and bold weights; + the fifth font contains a small selection of ``blackboard bold'' + characters (chosen for their mathematical significance). Support + under \LaTeXe{} is available in + \Qref*{\acro{PSNFSS}}{Q-usepsfont}; the fonts are + licensed under the \acro{GPL}, with legalese permitting the use of + the fonts in published documents. +\item[Fourier/Utopia](15 fonts) Michel Bovani\\ + \FontName{Fourier} is a family built on Adobe \FontName{Utopia} + (which has been released for usage free of charge by Adobe). The + fonts provide the basic Computer Modern set of mathematical symbols, + and add many of the \acro{AMS} mathematical symbols (though you are + expected to use some from the \acro{AMS} fonts themselves). There + are also several other mathematical and decorative symbols. The + fonts come with a \Package{fourier} package for use with \LaTeX{}; + text support of \acro{OT}1 encoding is not provided~--- you are + expected to use \acro{T}1. + + For a sample, see \url{http://www.tug.dk/FontCatalogue/utopia/} +\item[Fourier/New Century Schoolbook]Michael Zedler\\ + \FontName{Fouriernc} is a configuration using the Fourier fonts in + the context of New Century Schoolbook text fonts. + + For a sample, see \url{http://www.tug.dk/FontCatalogue/newcent/} +\item[KP-fonts]The Johannes Kepler project\\ + The \FontName{kp-fonts} family provides a comprehensive set of text + and maths fonts. The set includes replacement fixed-width and sans + fonts (though some reports have suggested that these are less + successful, and their use may be suppressed when loading the fonts' + \Package{kpfonts} \LaTeX{} support package). + + For an example, see \url{http://www.tug.dk/FontCatalogue/kpserif/} +\item[MathDesign](4 entire families\dots{}so far) Paul Pichaureau\\ + This set so far offers mathematics fonts to match Adobe Utopia, URW + Garamond, Bitstream Charter (all of which are separately available, + on \acro{CTAN}, in Type~1 format) and Fontsite Garamond + (which is a commercial font, available from the % ! line wrap (twice) +\begin{wideversion} + \href{FontSite Web shop}{http://www.fontsite.com/Pages/FFDownloads.html}). +\end{wideversion} +\begin{narrowversion} + FontSite Web shop, \URL{http://www.fontsite.com/Pages/FFDownloads.html}). +\end{narrowversion} + There has been a little comment on these fonts, but none + from actual users posted to the public forums. Users, particularly + those who are willing to discuss their experiences, would obviously + be welcome. Browse the \acro{CTAN} directory and see which you + want: there is a wealth of documentation and examples. + + For samples of the free variants, see + \url{http://www.tug.dk/FontCatalogue/charter/} for URW Charter, + \url{http://www.tug.dk/FontCatalogue/garamond/} for URW Garamond and + \url{http://www.tug.dk/FontCatalogue/utopia-md/} for Adobe Utopia. +\item[Belleek](3 fonts) Richard Kinch\\ + Belleek is the upshot of Kinch's thoughts on how \MF{} might be used + in the future: they were published simultaneously as \MF{} source, + as Type~1 fonts, and as TrueType fonts. The fonts act as ``drop-in'' + replacements for the basic MathTime set (as an example of ``what might + be done''). + + The paper outlining Kinch's thoughts, proceeding from considerations + of the `intellectual' superiority of \MF{} to evaluations of why its + adoption is so limited and what might be done about the problem, is + to be found at \URL{http://truetex.com/belleek.pdf} (the paper is a + good read, but is set with Bitmap fonts, and can be difficult + on-screen in Acrobat reader 5 or earlier). +\item[mathptmx]Alan Jeffrey, Walter Schmidt and others.\\ + This set contains maths italic, symbol, extension, and roman virtual + fonts, built from Adobe Times, Symbol, Zapf Chancery, and the + Computer Modern fonts. The resulting mixture is not entirely + acceptable, but can pass in many circumstances. The real advantage + is that the mathptm fonts are (effectively) free, and the resulting + \PS{} files can be freely exchanged. Support under \LaTeXe{} + is available in \Qref*{\acro{PSNFSS}}{Q-usepsfont}. + + For a sample, see \url{http://www.tug.dk/FontCatalogue/times/} +\item[Computer Modern Bright]Free scalable outline versions of these + fonts do exist; they are covered below together with their + commercial parallels. +\end{booklist} +The excellent \emph{font catalogue} keeps an % ! line break +\href{http://www.tug.dk/FontCatalogue/mathfonts.html}{up-to-date list} +which describes the fonts by giving names and short examples, only. +(At the time of writing~--- June 2008~--- the list has several that +are only scheduled for inclusion here. + +Another useful document is Stephen Hartke's ``Free maths font +survey'', which is available on \acro{CTAN} in both \acro{PDF} and +\acro{HTML} formats. The survey covers most of the fonts mentioned in +the font catalogue, but also mentions some (such as \Package{Belleek} +that the catalogue omits. + +Fonts capable of setting \TeX{} mathematics, that are available +commercially, include: +\begin{booklist} +\item[BA Math](13 fonts) MicroPress Inc.\\ + BA Math is a family of serif fonts, inspired by the elegant + and graphically perfect font design of John Baskerville. BA + Math comprises the fonts necessary for mathematical typesetting + (maths italic, math symbols and extensions) in normal and bold + weights. The family also includes all \acro{OT}1 and \acro{T}1 + encoded text fonts of various shapes, as well as fonts with most + useful glyphs of the \acro{TS}1 encoding. Macros for using the + fonts with \plaintex{}, \LaTeXo{} and current \LaTeX{} are + provided. + + \nothtml{\bgroup\raggedwithindent} + For further details (including samples) see\\ + \URL{http://www.micropress-inc.com/fonts/bamath/bamain.htm} + \nothtml{\par\egroup} +\item[CH Math](15 fonts) MicroPress Inc.\\ + CH Math is a family of slab serif fonts, designed as a maths + companion for Bitstream Charter. (The distribution includes + four free Bitstream text fonts, in addition to the 15 hand-hinted + MicroPress fonts.) + \nothtml{\bgroup\raggedwithindent} + For further details (including samples) see\\ + \URL{http://www.micropress-inc.com/fonts/chmath/chmain.htm} + \nothtml{\par\egroup} +\item[Computer Modern Bright](62 fonts~--- optical scaling) Walter + Schmidt\\ + \acro{CM} Bright is a family of sans serif fonts, based on Knuth's + \acro{CM} fonts. It comprises the fonts necessary for mathematical + typesetting, including \acro{AMS} symbols, as well as text and text + symbol fonts of various shapes. The collection comes with its own + set of files for use with \LaTeX{}. The \acro{CM} Bright fonts are + supplied in Type~1 format by MicroPress, Inc. The + \Package{hfbright} bundle offers free Type~1 fonts for text using + the \acro{OT}1 encoding~--- the \Package{cm-super} fonts provide the + fonts in \acro{T}1 text encoding but don't support \acro{CM} bright + mathematics. + + \nothtml{\bgroup\raggedwithindent} + For further details of Micropress' offering (including samples) see\\ + \URL{http://www.micropress-inc.com/fonts/brmath/brmain.htm} + \nothtml{\par\egroup} +\item[Concrete Math](25 fonts~--- optical scaling) Ulrik Vieth\\ + The Concrete Math font set was derived from the Concrete Roman + typefaces designed by Knuth. The set provides a collection of math + italics, math symbol, and math extension fonts, and fonts of + \acro{AMS} symbols that fit with the Concrete set, so that Concrete + may be used as a complete replacement for Computer Modern. Since + Concrete is considerably darker than \acro{CM}, the family may + particularly attractive for use in low-resolution printing or in + applications such as posters or transparencies. Concrete Math + fonts, as well as Concrete Roman fonts, are supplied in Type 1 + format by MicroPress, Inc. + + \nothtml{\bgroup\raggedwithindent} + For further information (including samples) see\\ + \URL{http://www.micropress-inc.com/fonts/ccmath/ccmain.htm} + \nothtml{\par\egroup} +\item[HV Math](14 fonts) MicroPress Inc.\\ + HV Math is a family of sans serif fonts, inspired by the + Helvetica (\acro{TM}) typeface. HV Math comprises the fonts + necessary for mathematical typesetting (maths italic, maths symbols + and extensions) in normal and bold weights. The family also + includes all \acro{OT}1 and \acro{T}1 encoded text fonts of various + shapes, as well as fonts with most useful glyphs of the \acro{TS}1 + encoding. Macros for using the fonts with \plaintex{}, \LaTeXo{} + and current \LaTeX{} are provided. Bitmapped copies of the fonts + are available free, on \acro{CTAN}. + + \nothtml{\bgroup\raggedwithindent} + For further details (and samples) see\\ + \URL{http://www.micropress-inc.com/fonts/hvmath/hvmain.htm} + \nothtml{\par\egroup} +\item[Informal Math](7 outline fonts) MicroPress Inc.\\ + Informal Math is a family of fanciful fonts loosely based on the + Adobe's Tekton (\acro{TM}) family, fonts which imitate handwritten + text. Informal Math comprises the fonts necessary for + mathematical typesetting (maths italic, maths symbols and extensions) + in normal weight, as well as \acro{OT}1 encoded text fonts in + upright and oblique shapes. Macros for using the fonts with + \plaintex{}, \LaTeXo{} and current \LaTeX{} are provided. + + \nothtml{\bgroup\raggedwithindent} + For further details (including samples) see\\ + \URL{http://www.micropress-inc.com/fonts/ifmath/ifmain.htm} + \nothtml{\par\egroup} +\item[Lucida Bright \emph{with} Lucida New Math](25 fonts) Chuck Bigelow and + Kris Holmes\\ + Lucida is a family of related fonts including seriffed, sans serif, + sans serif fixed width, calligraphic, blackletter, fax, Kris Holmes' + connected handwriting font, \emph{etc}; they're not as `spindly' as + Computer Modern, with a large x-height, and include a larger set of + maths symbols, operators, relations and delimiters than \acro{CM} + (over 800 instead of 384: among others, it also includes the + \acro{AMS} \FontName{msam} and \FontName{msbm} symbol sets). `Lucida + Bright Expert' + (14 fonts) adds seriffed fixed width, another handwriting font, + smallcaps, bold maths, upright `maths italic', \emph{etc}., to the + set. Support under \LaTeX{} is available under the auspices of the + \acro{PSNFSS}, and pre-built metrics are also provided. + + \nothtml{\bgroup\raggedwithindent} + \acro{TUG} has the right to distribute these fonts; the web site +\begin{narrowversion} + \href{http://tug.org/lucida/}{``Lucida and TUG''} +\end{narrowversion} +\begin{wideversion} + ``\href{http://tug.org/lucida/}{Lucida and TUG}'' +\end{wideversion} + has details. + \nothtml{\par\egroup} +\item[Adobe Lucida, LucidaSans \emph{and} LucidaMath](12 fonts)\\ + Lucida and LucidaMath are generally considered to be a bit heavy. + The three maths fonts contain only the glyphs in the \acro{CM} maths + italic, symbol, and extension fonts. Support for using LucidaMath + with \TeX{} is not very good; you will need to do some work + reencoding fonts \emph{etc}. (In some sense this set is the + ancestor of the LucidaBright plus LucidaNewMath font set, which are + not currently available.) +\item[MathTime Pro2]Publish or Perish (Michael Spivak)\\ + This latest instance of the MathTime family covers all the weights + (medium, bold and heavy) and symbols of previous versions of + MathTime. In addition it has a much extended range of symbols, and + many typographic improvements that make for high-quality documents. + The fonts are supported under both \plaintex{} and \LaTeXe{}, and + are exclusively available for purchase from + \Qref*{Personal \TeX{} Inc}{Q-commercial}. + \par{} + \nothtml{\bgroup\raggedwithindent} + For further details and samples and fliers, see + \URL{http://www.pctex.com/mtpro2.html} + \nothtml{\par\egroup} +\item[Minion Pro and MnSymbol]Adobe, \LaTeX{} support and packaging by + Achim Blumensath \emph{et al}.\\ + \FontName{Minion Pro} derives from the widely-available commercial + OpenType font of the same name by Adobe; scripts are provided to + convert relevant parts of it to Adobe Type~1 format. The + \Package{MinionPro} package will set up text and maths support using + \FontName{Minion Pro}, but a separate (free) font set + \FontName{MnSymbol} greatly extends the symbol coverage. +\item[PA Math] PA~Math is a family of serif fonts + loosely based on the Palatino (\acro{TM}) typeface. PA~Math + comprises the fonts necessary for mathematical typesetting (maths + italics, maths, calligraphic and oldstyle symbols, and extensions) + in normal and bold weights. The family also includes all \acro{OT}1, + \acro{T}1 encoded text fonts of various shapes, as well as fonts + with the most useful glyphs of the \acro{TS}1 encoding. Macros for + using the fonts with \plaintex{}, \LaTeXo{} and current \LaTeX{} + are provided. + + \nothtml{\bgroup\raggedwithindent} + For further details (and samples) see\\ + \URL{http://www.micropress-inc.com/fonts/pamath/pamain.htm} + \nothtml{\par\egroup} +\item[TM Math](14 fonts) MicroPress Inc.\\ + TM Math is a family of serif fonts, inspired by the Times + (\acro{TM}) typeface. TM Math comprises the fonts necessary for + mathematical typesetting (maths italic, maths symbols and extensions) + in normal and bold weights. The family also includes all \acro{OT}1 + and \acro{T}1 encoded text fonts of various shapes, as well as fonts + with most useful glyphs of the \acro{TS}1 encoding. Macros for + using the fonts with \plaintex{}, \LaTeXo{} and current \LaTeX{} + are provided. Bitmapped copies of the fonts are available free, on + \acro{CTAN}. + + \nothtml{\bgroup\raggedwithindent} + For further details (and samples) see\\ + \URL{http://www.micropress-inc.com/fonts/tmmath/tmmain.htm} + \nothtml{\par\egroup} +\end{booklist} +Two other font sets should be mentioned, even though they don't +currently produce satisfactory output~--- their author is no longer +working on them, and several problems have been identified: +\begin{booklist} +\item[pxfonts set version 1.0](26 fonts) by Young Ryu\\ + The \FontName{pxfonts} set consists of + \begin{itemize} + \item virtual text fonts using \FontName{Adobe} \FontName{Palatino} (or the \acro{URW} + replacement used by \ProgName{ghostscript}) with modified plus, + equal and slash symbols; + \item maths alphabets using \FontName{Palatino}; + \item maths fonts of all symbols in the computer modern maths fonts + (\FontName{cmsy}, \FontName{cmmi}, \FontName{cmex} and the Greek + letters of \FontName{cmr}) + \item maths fonts of all symbols corresponding to the \acro{AMS} + fonts (\FontName{msam} and \FontName{msbm}); + \item additional maths fonts of various symbols. + \end{itemize} + The text fonts are available in \acro{OT}1, \acro{T}1 and \acro{LY}1 + encodings, and \acro{TS} encoded symbols are also available. The + sans serif and monospaced fonts supplied with the \FontName{txfonts} + set (see below) may be used with \FontName{pxfonts}; the + \FontName{txfonts} set should be installed whenever \FontName{pxfonts} + are. \LaTeX{}, \ProgName{dvips} and \PDFTeX{} support files are + included. +\begin{narrowversion} % really non-hyper version + Documentation + (\URL{http://www.tex.ac.uk/tex-archive/fonts/pxfonts/doc/pxfontsdocA4.pdf}) +\end{narrowversion} +\begin{wideversion} + \href{http://www.tex.ac.uk/tex-archive/fonts/pxfonts/doc/pxfontsdocA4.pdf}{Documentation} +\end{wideversion} + is readily available. + + The fonts are licensed under the \acro{GPL}; use in published + documents is permitted. +\item[txfonts set version 3.1](42 fonts) by Young Ryu\\ + The \FontName{txfonts} set consists of + \begin{itemize} + \item virtual text fonts using \FontName{Adobe} \FontName{Times} (or the \acro{URW} + replacement used by \ProgName{ghostscript}) with modified plus, + equal and slash symbols; + \item matching sets of sans serif and monospace (`typewriter') + fonts (the sans serif set is based on \FontName{Adobe} \FontName{Helvetica}); + \item maths alphabets using \FontName{Times}; + \item maths fonts of all symbols in the computer modern maths fonts + (\FontName{cmsy}, \FontName{cmmi}, \FontName{cmex} and the Greek letters of \FontName{cmr}) + \item maths fonts of all symbols corresponding to the \acro{AMS} + fonts (\FontName{msam} and \FontName{msbm}); + \item additional maths fonts of various symbols. + \end{itemize} + The text fonts are available in \acro{OT}1, \acro{T}1 and \acro{LY}1 + encodings, and \acro{TS} encoded symbols are also available. +\begin{narrowversion} % really non-hyper version + Documentation + (\URL{http://www.tex.ac.uk/tex-archive/fonts/txfonts/doc/txfontsdocA4.pdf}) +\end{narrowversion} +\begin{wideversion} + \href{http://www.tex.ac.uk/tex-archive/fonts/txfonts/doc/txfontsdocA4.pdf}{Documentation} +\end{wideversion} + is readily available. + + The fonts are licensed under the \acro{GPL}; use in published + documents is permitted. +\end{booklist} +Finally, one must not forget: +\begin{booklist} +\item[Proprietary fonts]Various sources.\\ + Since having a high quality font set in scalable outline form that + works with \TeX{} can give a publisher a real competitive advantage, + there are some publishers that have paid (a lot) to have such font + sets made for them. Unfortunately, these sets are not available on + the open market, despite the likelihood that they're more complete + than those that are. +\end{booklist} +We observe a very limited selection of commercial maths font sets; a +maths font has to be explicitly designed for use with \TeX{}, which is +an expensive business, and is of little appeal in other markets. +Furthermore, the \TeX{} market for commercial fonts is minute by +comparison with the huge sales of other font sets. + +Text fonts in Type~1 format are available from many vendors including +Adobe, Monotype and Bitstream. However, be careful with cheap font +``collections''; many of them dodge copyright restrictions by removing +(or crippling) parts of the font programs such as hinting. Such +behaviour is both unethical and bad for the consumer. +The fonts may not render well (or at all, under \acro{ATM}), may not have the +`standard' complement of 228 glyphs, or may not include metric files +(which you need to make \acro{TFM} files). + +TrueType remains the ``native'' format for Windows. Some \TeX{} +implementations such as \Qref*{True\TeX{}}{Q-commercial} use TrueType +versions of Computer Modern and Times Maths fonts to render \TeX{} +documents in Windows without the need for additional system software like +\acro{ATM}. (When used on a system running Windows~XP, True\TeX{} can +also use Type~1 fonts.) + +When choosing fonts, your own system environment may not be the only one of +interest. If you will be sending your finished documents to others for +further use, you should consider whether a given font format will introduce +compatibility problems. Publishers may require TrueType exclusively because +their systems are Windows-based, or Type~1 exclusively, because their systems +are based on the early popularity of that format in the publishing industry. +Many service bureaus don't care as long as you present them with a finished +print file (\PS{} or \acro{PDF}) for their output device. +\begin{ctanrefs} +\item[CM \nothtml{\normalfont}family collection]% + Distributed as part of \CTANref{amsfonts} +\item[AMS \nothtml{\normalfont}font collection]% + Distributed as part of \CTANref{amsfonts} +\item[Belleek \nothtml{\normalfont}fonts]% + \CTANref{belleek} +\item[CM-super \nothtml{\normalfont}collection]\CTANref{cm-super} +\item[eulervm.sty \nothtml{\normalfont}and supporting metrics]% + \CTANref{eulervm} +\item[fourier \nothtml{\normalfont}(including metrics and other support for \nothtml{\itshape}utopia]% + \CTANref{fourier} +\item[fouriernc]\CTANref{fouriernc} +\item[hfbright \nothtml{\normalfont}collection]\CTANref{hfbright} +\item[hvmath \nothtml{\normalfont\itshape}(free bitmapped version)]% + \CTANref{hvmath} +\item[kpfonts \nothtml{\normalfont}family]\CTANref{kpfonts} +\item[Lucida Bright/Math metrics]\CTANref{lucida} +\item[Lucida PSNFSS support]\CTANref{lucida-psnfss} +\item[MathDesign \nothtml{\normalfont}collection]\CTANref{mathdesign} +\item[\nothtml{\normalfont}Maths Font Survey]\CTANref{mathsurvey.pdf} + (\acro{PDF}) or \CTANref{mathsurvey.html} (\acro{HTML}) +\item[Minion Pro support]\CTANref{minionpro} +\item[MnSymbol \nothtml{\normalfont}family]\CTANref{mnsymbol} +\item[pxfonts]\CTANref{pxfonts} +\item[tmmath \nothtml{\normalfont\itshape}(free bitmapped version)]% + \CTANref{tmmath} +\item[txfonts]\CTANref{txfonts} +\item[utopia \nothtml{\normalfont}fonts]\CTANref{utopia} +\end{ctanrefs} + +\Question[Q-charshift]{Weird characters in \ProgName{dvips} output} +\keywords{fi ligature pound pounds sterling elephants} + +You've innocently generated output, using \ProgName{dvips}, and there +are weird transpositions in it: for example, the \texttt{fi} ligature has +appeared as a \textsterling{} symbol. +This is an unwanted side-effect of the precautions +outlined in \Qref*{generating \PS{} for PDF}{Q-dvips-pdf}. +The \texttt{-G1} switch discussed in that question is appropriate for +Knuth's text fonts, but doesn't work with text fonts that don't follow +Knuth's patterns (such as fonts supplied by Adobe). + +If the problem arises, suppress the \texttt{-G1} switch: if you were using it +explicitly, \emph{don't}; if you were using \texttt{-Ppdf}, add \texttt{-G0} to +suppress the implicit switch in the pseudo-printer file. + +The problem has been corrected in \ProgName{dvips} v~5.90 (and later +versions), which should be available in any recent \TeX{} distribution. + +\subsection{Macros for using fonts} + +\Question[Q-fonts-pln]{Using non-standard fonts in \plaintex{}} + +\plaintex{} (in accordance with its description) doesn't do anything +fancy with fonts: it sets up the fonts that Knuth found he needed when +writing the package, and leaves you to do the rest. + +To use something other than Knuth's default, the default mechanism is +to use the \csx{font} primitive: +\begin{quote} +\begin{verbatim} +\font\foo=nonstdfont +... +\foo +Text set using nonstdfont ... +\end{verbatim} +\end{quote} +The name you use (\texttt{nonstdfont}, above) is the name of the +\extension{tfm} file for the font you want. + +If you want to use an italic version of \csx{foo}, you need to use +\csx{font} again: +\begin{quote} +\begin{verbatim} +\font\fooi=nonstdfont-italic +... +\fooi +Text set using nonstdfont italic... +\end{verbatim} +\end{quote} +This is all very elementary stuff, and serves for simple use of fonts. +However, there are wrinkles, the most important of which is the matter +of \Qref*{font encodings}{Q-whatenc}. Unfortunately, many fonts that +have appeared recently simply don't come in versions using Knuth's +eccentric font encodings~--- but those encodings are built into +\plaintex{}, so that some macros of \plaintex{} need to be changed to +use the fonts. \LaTeX{} gets around all these problems by using a +``font selection scheme''~--- this `\acro{NFSS}' (`\acro{N}' for +`new', as opposed to what \LaTeXo{} had) carries around with it +separate information about the fonts you use, so the changes to +encoding-specific commands happen automagically. + +If you only want to use the \Qref*{\acro{EC} fonts}{Q-ECfonts}, you +can in principle use the \Package{ec-plain} bundle, which gives you a version +of \plaintex{} which you can run in the same way that you run +\plaintex{} using the original \acro{CM} fonts, by invoking +\ProgName{tex}. (\Package{Ec-plain} also extends the \acro{EC} fonts, +for reasons which aren't immediately clear, but which might cause +problems if you're hoping to use Type 1 versions of the fonts.) + +The \Package{font_selection} package provides a sort of halfway house: +it provides font face and size, but not family selection. This gives +you considerable freedom, but leaves you stuck with the original +\acro{CM} fonts. It's a compact solution, within its restrictions. + +Other \plaintex{} approaches to the problem (packages +\Package{plnfss}, \Package{fontch} and \Package{ofs}) break out of the +\plaintex{} model, towards the sort of font selection provided by +\CONTeXT{} and \LaTeX{}~--- font selection that allows you to change +family, as well as size and face. The remaining packages all make +provision for using encodings other than Knuth's \acro{OT}1. + +\Package{Plnfss} has a rather basic set of font family details; +however, it is capable of using font description (\extension{fd}) files +created for \LaTeX{}. (This is useful, since most modern mechanisms +for integrating outline fonts with \TeX{} generate \extension{fd} files +in their process.) + +\Package{Fontch} has special provision for \acro{T}1 and \acro{TS}1 +encodings, which you select by arcane commands, such as: +\begin{quote} +\begin{verbatim} +\let\LMTone\relax +\input fontch.tex +\end{verbatim} +\end{quote} +for \acro{T}1. + +\Package{Ofs} seems to be the most thoroughly thought-through of the +alternatives, and can select more than one encoding: as well as +\acro{T}1 it covers the encoding \acro{IL}2, which is favoured in the +Czech Republic and Slovakia. \Package{Ofs} also covers mathematical fonts, +allowing you the dubious pleasure of using fonts such as the % ! line break +\Qref*{\FontName{pxfonts} and \FontName{txfonts}}{Q-psfchoice}. + +The \Package{pdcmac} \plaintex{} macro package aims to be a complete +document preparation environment, like \Qref*{\Eplain{}}{Q-eplain}. One +of its components is a font selection scheme, \Package{pdcfsel}, which +is rather simple but adequately powerful for many uses. The package +doesn't preload fonts: the user is required to declare the fonts the +document is going to use, and the package provides commands to select +fonts as they're needed. The distribution includes a configuration to +use Adobe `standard' fonts for typesetting text. (\Eplain{} itself +seems not to offer a font selection scheme.) + +The \Package{font-change} collection takes a rather different +approach~--- it supplies what are (in effect) a series of templates +that may be included in a document to change font usage. The +package's documentation shows the effect rather well. + +Simply to change font \emph{size} in a document (i.e., not changing +the default font itself), may be done using the rather straightforward +\Package{varisize}, which offers font sizes ranging from 7~points to +20~points (nominal sizes, all). Font size commands are generated when +any of the package files is loaded, so the \File{11pt.tex} defines a +command \csx{elevenpoint}; each of the files ensures there's a ``way +back'', by defining a \csx{tenpoint} command. +\begin{ctanrefs} +\item[ec-plain]\CTANref{ec-plain} +\item[font-change]\CTANref{font-change} +\item[fontch]\CTANref{fontch} +\item[font_selection]\CTANref{font_selection} +\item[ofs]\CTANref{ofs} +\item[pdcmac]\CTANref{pdcmac} +\item[plnfss]\CTANref{plnfss} +\item[varisize]\CTANref{varisize} +\end{ctanrefs} + +\subsection{Particular font families} + +\Question[Q-concrete]{Using the ``Concrete'' fonts} + +The Concrete Roman fonts were designed by Don Knuth for a book called +``Concrete Mathematics'', which he wrote with Graham and Patashnik +(\emph{the} Patashnik, of \BibTeX{} fame). Knuth +only designed text fonts, since the book used the Euler fonts for +mathematics. The book was typeset using \plaintex{}, of course, with +additional macros that may be viewed in a file \File{gkpmac.tex}, +which is available on \acro{CTAN}. + +The packages \Package{beton}, \Package{concmath}, and +\Package{ccfonts} are \LaTeX{} packages that change the default text +fonts from Computer Modern to Concrete. Packages \Package{beton} and +\Package{ccfonts} also slightly increase the default value of +\csx{baselineskip} to account for the rather heavier weight of the +Concrete fonts. If you wish to use the \FontName{Euler} fonts for +mathematics, as Knuth did, there's the \Package{euler} package which +has been developed from Knuth's own \plaintex{}-based set: these +macros are currently deprecated (they clash with many things, including +\AMSLaTeX{}). The independently-developed \Package{eulervm} +bundle is therefore preferred to the \Package{euler} package. (Note +that installing the \Package{eulervm} bundle involves installing a +series of virtual fonts. While most modern distributions seem to have +the requisite files installed by default, you may find you have to +install them. If so, see the file \File{readme} in the +\Package{eulervm} distribution.) + +A few years after Knuth's original design, Ulrik Vieth +designed the Concrete Math fonts. Packages +\Package{concmath}, and \Package{ccfonts} also change the default math +fonts from Computer Modern to Concrete and use the Concrete versions +of the \acro{AMS} fonts (this last behaviour is optional in the case +of the \Package{concmath} package). + +There are no bold Concrete fonts, but it is generally accepted that +the Computer Modern Sans Serif demibold condensed fonts are an +adequate substitute. If you are using \Package{concmath} or +\Package{ccfonts} and you want to follow this suggestion, then use the +package with \pkgoption{boldsans} class option (in spite of the fact +that the \Package{concmath} documentation calls it +\pkgoption{sansbold} class option). If you are using \Package{beton}, +add +\begin{quote} + \cmdinvoke{renewcommand}{\csx{bfdefault}}{sbc} +\end{quote} +to the preamble of your document. + +Type~1 versions of the fonts are available. For \acro{OT}1 encoding, +they are available from \Qref*{MicroPress}{Q-psfchoice}. The +\Qref*{CM-Super fonts}{Q-textrace} contain Type~1 versions +of the Concrete fonts in \acro{T}1 encoding. +\begin{ctanrefs} +\item[beton.sty]\CTANref{beton} +\item[ccfonts.sty]\CTANref{ccfonts} +\item[\nothtml{\rmfamily}CM-Super fonts]\CTANref{cm-super} +\item[concmath.sty]\CTANref{concmath} +\item[\nothtml{\rmfamily}Concmath fonts]\CTANref{concmath-f} +\item[\nothtml{\rmfamily}Concrete fonts]\CTANref{concrete} +\item[euler.sty]\CTANref{euler-latex} +\item[eulervm \nothtml{\rmfamily}bundle]\CTANref{eulervm} +\item[gkpmac.tex]\CTANref{gkpmac} +\end{ctanrefs} + +\Question[Q-uselmfonts]{Using the Latin Modern fonts} + +The \Package{lm} fonts are an exciting addition to +the armoury of the \AllTeX{} user: high quality outlines of fonts that +were until recently difficult to obtain, all in a free and +relatively compact package. However, the spartan information file +that comes with the fonts remarks ``It is presumed that a potential +user knows what to do with all these files''. This answer aims to +fill in the requirements: the job is really not terribly difficult. + +Note that te\TeX{} distributions, from version~3.0, already have the +\Package{lm} fonts: all you need do is use them. The fonts may also +be installed via the package manager, in a current \miktex{} system. +The remainder of this answer, then, is for people who don't use such +systems. + +The font (and related) files appear on \acro{CTAN} as a set of +single-entry \Qref*{\acro{TDS} trees}{Q-tds}~--- +\File{fonts}, \File{dvips}, \File{tex} and \File{doc}. The \File{doc} +subtree really need not be copied (it's really a pair of sample +files), but copy the other three into your existing Local +\texttt{\$TEXMF} tree, and +% beware line break +\Qref*{update the filename database}{Q-inst-wlcf}. + +Now, incorporate the fonts in the set searched by \PDFLaTeX{}, +\ProgName{dvips}, \ProgName{dvipdfm}/\ProgName{dvipdfmx}, your +previewers and Type~1-to-\acro{PK} conversion programs, by +\begin{itemize} +\item On a te\TeX{} system earlier than version~2.0, edit the file + \File{$TEXMF/dvips/config/updmap} and insert an absolute path for + the \File{lm.map} just after the line that starts + \texttt{extra\_modules="} (and before the closing quotes). +\item On a te\TeX{} version~2.0 (or later), execute the command +\begin{verbatim} + updmap --enable Map lm.map +\end{verbatim} +\item On a \miktex{} system earlier than version~2.2, the ``Refresh + filename database'' operation, which you performed after installing + files, also updates the system's ``\PS{} resources database''. +\item On a \miktex{} system, version~2.2 or later, update + \File{updmap.cfg} as described in the \miktex{} % beware line break + \href{http://docs.miktex.org/manual/psfonts.html#chgupdmapcfg}{online documentation}. + Then execute the command \texttt{initexmf -\relax-mkmaps}, and the + job is done. +\end{itemize} + +To use the fonts in a \LaTeX{} document, you should +\begin{quote} + \cmdinvoke{usepackage}{lmodern} +\end{quote} +this will make the fonts the default +for all three \LaTeX{} font families (``roman'', ``sans-serif'' and +``typewriter''). You also need +\begin{quote} + \cmdinvoke{usepackage}[T1]{fontenc} +\end{quote} +for text, and +\begin{quote} + \cmdinvoke{usepackage}{textcomp} +\end{quote} +if you want to use any of the \acro{TS}1-encoding symbols. There is +no support for using fonts according to the \acro{OT}1 encoding. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Latin Modern fonts]\CTANref{lm} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-getit.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-getit.tex new file mode 100644 index 00000000000..733cb40d4a1 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-getit.tex @@ -0,0 +1,350 @@ +% $Id: faq-getit.tex,v 1.1 2009/06/13 20:56:37 rf10 Exp rf10 $ + +\section{Acquiring the Software} + +\Question[Q-archives]{Repositories of \TeX{} material} + +To aid the archiving and retrieval of of \TeX{}-related files, a +\acro{TUG} working group developed the Comprehensive \TeX{} Archive +Network (\acro{CTAN}). Each \acro{CTAN} site has identical material, +and maintains authoritative versions of its material. These +collections are extensive; in particular, almost everything mentioned +in this \acro{FAQ} +is archived at the \acro{CTAN} sites (see the lists of software at the +end of each answer). + +\begin{narrowversion} % non-hyper + The \acro{CTAN} sites are in Germany, the UK and the USA; the + directory layout is the same on each of the sites, starting from a + tree root of \path{tex-archive/} The sites are + \texttt{dante.ctan.org} (Dante, Germany), \texttt{cam.ctan.org} + (Cambridge, UK) and \texttt{tug.ctan.org} (TUG, USA). +\end{narrowversion} +\begin{wideversion} % hyper + The \acro{CTAN} sites are + \href{ftp://dante.ctan.org/tex-archive}{Dante (Germany)}, + \href{ftp://cam.ctan.org/tex-archive}{Cambridge (UK)} and + \href{ftp://tug.ctan.org/tex-archive}{TUG (USA)}; the links are to + the root of the \acro{CTAN} tree, above which the layout is + identical at each site. +\end{wideversion} + +The \TeX{} files at each \acro{CTAN} node may also be accessed via +the Web at \acro{URL}s \URL{http://www.dante.de/tex-archive}, +\URL{http://www.tex.ac.uk/tex-archive} and +\URL{http://www.ctan.org/tex-archive} respectively, but not all +\acro{CTAN} mirrors are Web-accessible. + +As a matter of course, to reduce network load, +please use the \acro{CTAN} site +or mirror closest to you. A complete and current list of \acro{CTAN} sites +and known mirrors is available as file \CTANref{CTAN-sites} on the +archives themselves. + +Better still, the script behind \URL{http://mirror.ctan.org/} will +cunningly choose a ``nearby'' mirror for you, using information from +the database `behind' \CTANref{CTAN-sites}; at present it uses +\texttt{ftp} protocol for transfers, but the intention is to convert +it to using \texttt{http} (web) protocol in the near future. + +To access a particular thing through the \texttt{mirror.ctan.org} +mechanism, simply place the \acro{CTAN} path after the base +\acro{URL}; so +\URL{http://mirror.ctan.org/macros/latex/contrib/footmisc/} will +connect you to the \Package{footmisc} directory at some \acro{CTAN} +site~--- note that the \File{tex-archive} part of the \acro{CTAN} path +isn't needed. + +For details of how to find files at \acro{CTAN} sites, see +``\Qref*{finding \AllTeX{} files}{Q-findfiles}''. + +The \TeX{} user who has no access to any sort of +network may buy a copy of the archive as part of the +\Qref*{\texlive{} distribution}{Q-CD}. + +\Question[Q-tds-zip]{Ready-built installation files on the archive} + +The \Qref*{\acro{TDS}}{Q-tds} is a simple structure, and almost all +files can be installed simply by putting them in the ``right'' place, +and updating a single index. (Note, this simple idea typically +doesn't work for fonts, unless they're distributed as \MF{} source.) + +The CTAN network is therefore acquiring ``\acro{TDS}-\acro{ZIP}'' files, +which have a built-in directory structure that matches the \acro{TDS}. +These files have to be built, and the \acro{CTAN} team has asked that +package authors supply them (the team will advise, of course, if the +author has trouble). The \acro{CTAN} team hopes that the extra work +involved will contribute to happier lives for package users, which in +turn must surely help keep the TeX community lively and active. + +At the time of writing, there are rather few \extension{tds.zip} +files (by comparison with the huge number of packages that are +available). As packages are updated, the number of files is +steadily increasing, but it will be a long time before the whole set +is covered. + +Use of the files is discussed in % ! line break +``\Qref*{installing using ready-built \acro{ZIP} files}{Q-inst-tds-zip}''. + +\Question[Q-nonfree]{What is the \acro{CTAN} \texttt{nonfree} tree?} + +When \acro{CTAN} was founded, in the 1990s, it was unusual to publish +the terms under which a \TeX{}-related package was distributed (or, at +any rate, to publish those terms formally). + +With the advent of the \TeX{} \emph{distributions}, however, people +started to realise the need for such information, to protect those who +create, distribute or sell the discs that hold the packages, etc. +With the licence information available, the distributors can decide +which packages may be distributed. + +The \acro{CTAN} team decided that it would be useful for users (and +distributors, not to say package authors) to separate packages that +were candidates for distribution, and those that were in some sense +``not free''. Thus was the \texttt{nonfree} tree born. + +From the start, the \texttt{nonfree} tree was controversial: the terms +under which a package would be placed on the tree were hotly +contested, and the \acro{CTAN} team were only able slowly to populate +the tree. It is now obvious to the team that the project would never +have been completed. + +The \acro{CTAN} catalogue now records the nature of the licences of a +good proportion of the packages it describes (though there remain +several for which the licence is unknown, which is as good, for the +distributors, as a licence forbidding distribution). Since the +catalogue's coverage of \acro{CTAN} is good (and slowly improving), +the general rule for distributors has become +\begin{quote} +``if the package is listed in the catalogue, check there to see +whether you should distribute; if the package is not listed in the +catalogue, don't think of distributing it''. +\end{quote} +(The catalogue only has a modest % ! line break +\CTANhref{cat-licences}{list of licences}, but it covers the set used +by packages on \acro{CTAN}, with a wild-card ``\texttt{other-free}'' +which covers packages that the \acro{CTAN} administrators believe to +be free even though the authors haven't used a standard licence.) + +There is a corollary to the `general rule': if you notice something +that ought to be in the distributions, for which there is no catalogue +entry, please let the \acro{CTAN} team (\mailto{ctan@dante.de}) know. +It may well be that the package has simply been missed, but some aren't +catalogued because there's no documentation and the team just doesn't +understand the package. + +In the light of the above, the \texttt{nonfree} tree is being +dismantled, and its contents moved (or moved \emph{back}) to the main +\acro{CTAN} tree. So the answer to the question is, now, ``the +nonfree tree is a part of \acro{CTAN}, and is now being merged with +the main tree''. + +\Question[Q-uploads]{Contributing a file to the archives} + +You have something to submit to the archive~--- great! Before we even +start, here's a check-list of things to sort out: +\begin{enumerate} +\item Licence: in the spirit of \TeX{}, we hope for free software; in + the spirit of today's lawyer-enthralled society, \acro{CTAN} + provides a % ! line break + \href{http://www.tex.ac.uk/tex-archive/help/Catalogue/licenses.html}{list of ``standard'' licence statements}. +\item Documentation: it's good for users to be able to browse + documentation before downloading a package. You need at least a + plain text \File{README} file (exactly that name); in addition a + \acro{PDF} file of the package documentation, prepared for screen + reading, is highly desirable. +\item Name: endless confusion is caused by name clashes. If your + package has the same name as one already on \acro{CTAN}, or if your + package installation generates files of the same name as something + in a ``normal'' distribution, the \acro{CTAN} team will delay + installation while they check that you're doing the right thing: + they may nag you to change the name, or to negotiate a take-over + with the author of the original package. % beware line break + \Qref*{Browse the archive}{Q-findfiles} to ensure uniqueness. + + The name you choose should also (as far as possible) be somewhat + descriptive of what your submission actually \emph{does}; while + ``descriptiveness'' is to some extent in the eye of the beholder, + it's clear that names such as \File{mypackage} or \File{jiffy} + aren't suitable. +\end{enumerate} + +If you are able to use anonymous \ProgName{ftp}, you can upload that +way. The file \File{README.uploads} on \acro{CTAN} tells you +where to upload, what to upload, and how to notify the \acro{CTAN} +management about what you want doing with your upload. + +You may also upload via the Web: each of the principal \acro{CTAN} +sites offers an upload page~--- choose from +\URL{http://www.ctan.org/upload.html}, +\URL{http://www.dante.de/CTAN/upload.html} or +\URL{http://www.tex.ac.uk/upload.html}; the pages lead you through the +process, showing you the information you need to supply. This method +enforces one file per upload: if you had intended to upload lots of +files, you need to bundle them into an `archive' file of some sort; +acceptable formats are \extension{zip} and \extension{tar.gz} (or +\extension{tar.bz2}). + +If you can use neither of these methods, or if you find something +confusing, ask advice of the +\begin{narrowversion} % really non-hyper version + \acro{CTAN} management (\mailto{ctan@dante.de}): +\end{narrowversion} +\begin{wideversion} + \href{mailto:ctan@dante.de}{\acro{CTAN} management}: +\end{wideversion} +if the worst comes to the worst, it may be possible to mail a +contribution. This really is a last-resort route: none of the +\acro{CTAN} sites is anyone's regular workstation, so if you mail to +one of the maintainers, that maintainer then has to upload to +\acro{CTAN}. + +If it's appropriate (if your package is large, or regularly updated), +the \acro{CTAN} management can arrange to \ProgName{mirror} your +contribution direct into the archive. At present this may only be +done if your contribution is available via \ProgName{ftp}, and of +course the directory structure on your repository must `fit'. +\begin{ctanrefs} +\item[README.uploads]\CTANref{CTAN-uploads} +\end{ctanrefs} + +\Question[Q-findfiles]{Finding \AllTeX{} files} + +Modern \TeX{} distributions contain a huge array of support files of +various sorts, but sooner or later most people need to find something +that's not in their present system (if nothing else, because they've +heard that something has been updated). + +But how to find the files? + +Some sources, such as these \acro{FAQ} answers, provide links to +files: so if you've learnt about a package here, you should be able to +retrieve it without too much fuss. + +Otherwise, the \acro{CTAN} sites provide searching facilities, via the web. +The simplest search, locating files by name, is to be found on the +Dante \acro{CTAN} +at \URL{http://www.dante.de/cgi-bin/ctan-index}; the script scans a +list of files (\File{FILES.byname}~--- see below) and returns a list +of matches, arranged very neatly as a series of links to directories +and to individual files. + +The \href{http://www.tex.ac.uk/search}{\acro{UK}} and +\href{http://www.ctan.org/search.html}{\acro{USA}} \acro{CTAN}s offer a +search page that provides +\begin{itemize} +\item a file-name search similar to the Dante machine's (above); +\item a keyword search of the archive catalogue (see below): this is a + pretty powerful tool: the results include links to the catalogue + ``short descriptions'', so you can assure yourself that the package + you've found is the one you want; and +\item a search form that allows you to use \ProgName{Google} to search + \acro{CTAN}. +\end{itemize} + +An alternative way to scan the catalogue is to use the catalogue's +% ! line break +\href{http://www.tex.ac.uk/tex-archive/help/Catalogue/bytopic.html}{``by topic'' index}; +this lists a series of topics, and \AllTeX{} projects that are worth +considering if you're working on matters related to the topic. + +In fact, \ProgName{Google}, and other search engines, can be useful +tools. Enter your search keywords, and you may pick up a package that +the author hasn't bothered to submit to \acro{CTAN}. If you're using +\ProgName{Google}, you can restrict your search to \acro{CTAN} by +entering +\begin{quote} + \texttt{site:ctan.org tex-archive \meta{search term(s)}} +\end{quote} +in \ProgName{Google}'s ``search box''. You can also enforce the +restriction using \ProgName{Google}'s ``advanced search'' mechanism; +other search engines (presumably) have similar facilities. + +Many people avoid the need to go over the network at all, for their +searches, by downloading the file list that the archives' web +file searches use. This file, \File{FILES.byname}, +presents a unified listing of the archive (omitting directory names and +cross-links). Its companion \File{FILES.last07days} is also useful, to +keep an eye on the changes on the archive. Since these files are +updated only once a day, a nightly automatic download (perhaps using +\ProgName{rsync}) makes good sense. +\begin{ctanrefs} +\item[FILES.byname]\CTANref{f-byname} +\item[FILES.last07days]\CTANref{f-last7} +\end{ctanrefs} + +\Question[Q-findfont]{Finding new fonts} + +A comprehensive list of \MF{} fonts used to be posted to +\Newsgroup{comp.fonts} and to \Newsgroup{comp.text.tex}, roughly +every six weeks, by Lee Quin. +Nowadays, authors of new material in \MF{} are few and far between +(and mostly designing highly specialised things with limited appeal to +ordinary users); as a result, no-one has taken over maintenance of the +list of fonts. If you need a font for some esoteric purpose, it may +be worth \Qref*{searching \acro{CTAN}}{Q-findfiles} using your purpose +as a search keyword. + +Most new fonts that appear are prepared in some scalable outline form +or other, and a large proportion is distributed under commercial +terms. However, once you have acquired such a font, converting it to +a form usable by your \AllTeX{} distribution is not (in principle) a +serious problem. + +The answer ``\Qref*{choice of scalable fonts}{Q-psfchoice}'' discusses +fonts that are configured for general (both textual and mathematical) +use with \AllTeX{}. The list of such fonts is sufficiently short that +they \emph{can} all be discussed in one answer here. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\MF{} font list]\CTANref{mf-list} +\end{ctanrefs} + +\Question[Q-CD]{The \TeX{} collection} + +If you don't have access to the Internet, there are obvious +attractions to \TeX{} collections on a disc. Even those with net +access will find large quantities of \TeX{}-related files to hand a +great convenience. + +The \TeX{} collection provides this, together with +ready-to-run \TeX{} systems for various architectures. Contents of +the collection are: +\begin{itemize} +\item The \texlive{} installation disc (a \acro{CD}) provides \TeX{} + systems for use on \acro{GNU}-Linux, MacOS/X and Win-32 + architectures; +\item The \texlive{} `Live' disc (a \acro{DVD}) providing \TeX{} for + a wider range of architectures; +\item Mac\TeX{}: an easy to install \TeX{} system for MacOS/X, based + on \texlive{}, and including the % ! line break + \href{http://www.uoregon.edu/~koch/texshop/}{texshop front-end} + and other tools; +\item Pro\TeX{}t: an easy to install \TeX{} system for Windows, based + on \miktex{}, and including an `active' document to guide + installation; and +\item A snapshot of \acro{CTAN}. +\end{itemize} +A fair number of national \TeX{} User Groups, as well as \acro{TUG}, +distribute copies to their members at no extra charge. Some user +groups are also able to sell additional copies: +contact your local user group or \Qref*{\acro{TUG}}{Q-TUG*}. + +You may also download disc images from \acro{CTAN}; the installation +disc, Pro\TeX{}t and Mac\TeX{} are all separately available. Beware: +they are all pretty large downloads. + +More details of the collection are available from its own +\begin{wideversion} % this really ought to be "hyperversion" or summat + \href{http://www.tug.org/texcollection/}{web page} + on the \acro{TUG} site. +\end{wideversion} +\begin{narrowversion} % and non-hyperversion? + web page on the + \acro{TUG} site \URL{http://www.tug.org/texcollection/} +\end{narrowversion} +\begin{ctanrefs} +\item[Mac\TeX{}]\CTANref{mactex} +\item[Pro\TeX{}t]\CTANref{protext} +\item[\TeX{}live install image]\CTANref{texlive} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-graphics.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-graphics.tex new file mode 100644 index 00000000000..45270301eb1 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-graphics.tex @@ -0,0 +1,880 @@ +% $Id: faq-graphics.tex,v 1.2 2009/06/18 23:13:04 rf10 Exp rf10 $ + +\section{Graphics} + +\Question[Q-impgraph]{Importing graphics into \AllTeX{} documents} + +Knuth, when designing the current version of \TeX{} back in the early +1980s, could discern no ``standard'' way of expressing graphics in +documents. He reasoned that this state could not persist for ever, +but that it would be foolish for him to define \TeX{} primitives that +allowed the import of graphical image definitions. He therefore +deferred the specification of the use of graphics to the writers of +\acro{DVI} drivers; \TeX{} documents would control the drivers by +means of \nothtml{\csx{special} commands (}% beware line breaks +\Qref{\csx{special} commands}{Q-specials}\nothtml{)}. + +There is therefore a straightforward way for anyone to import graphics +into their document: read the specification of the \csx{special} +commands your driver uses, and `just' code them. This is the +hair-shirt approach: it definitely works, but it's not for everyone. + +Over the years, therefore, ``graphics inclusion'' packages have sprung +up; most were designed for inclusion of +\nothtml{Encapsulated \PS{} graphics (}% beware line break +\Qref{Encapsulated \PS{} graphics}{Q-eps}\nothtml{)}\nobreakspace--- +which has become the \emph{lingua franca} of graphics inclusion over +the last decade or so. + +Notable examples are the \Package{epsf} package (distributed with +\ProgName{dvips}) and the \Package{psfig} package. (Both of these +packages were designed to work well with both \plaintex{} and +\LaTeXo{}; they are both still available.) All such packages were +tied to a particular \acro{DVI} driver (\ProgName{dvips}, in +the above two cases), but their code could be configured for others. + +The obvious next step was to make the code configurable dynamically. +The \LaTeX{} standard \Package{graphics} package and its derivatives +made this step: it is strongly preferred for all current work. + +Users of \plaintex{} have two options allowing them to use +\Package{graphicx}: the \Package{miniltx} ``\LaTeX{} emulator'' and +the \Package{graphicx.tex} front-end allow you to load +\Package{graphicx}, and \Qref*{\Eplain}{Q-eplain} allows you to load +it (using the full \LaTeX{} syntax) direct. + +The \Package{graphics} package takes a variety of ``driver +options''~--- package options that select code to generate the +commands appropriate to the \acro{DVI} driver in use. In most cases, +your \AllTeX{} distribution will provide a \File{graphics.cfg} file +that will select the correct driver for what you're doing (for +example, a distribution that provides both \LaTeX{} and \PDFLaTeX{} +will usually provide a configuration file that determines whether +\PDFLaTeX{} is running, and selects the definitions for it if so). + +The \Package{graphics} package provides a toolkit of commands (insert +graphics, scale a box, rotate a box), which may be composed to provide +most facilities you need; the basic command, \csx{includegraphics}, +takes one optional argument, which specifies the bounding box of the +graphics to be included. + +The \Package{graphicx} package uses the facilities of of +\Package{graphics} behind a rather more sophisticated command syntax +to provide a very powerful version of the \csx{includegraphics} +command. \Package{graphicx}'s version can combine scaling and +rotation, viewporting and clipping, and many other things. While this +is all a convenience (at some cost of syntax), it is also capable of +producing noticeably more efficient \PS{}, and some of its +combinations are simply not possible with the \Package{graphics} +package version. + +The \Package{epsfig} package provides the same facilities as +\Package{graphicx}, but via a \csx{psfig} command (also known as +\csx{epsfig}), capable of emulating +the behaviour (if not the bugs) the old \Package{psfig} package. +\Package{Epsfig} also supplies homely support for former users of the +\Package{epsf} package. However, there's a support issue: if you +declare you're using \Package{epsfig}, any potential mailing list or +usenet helper has to clear out of the equation the possibility that +you're using ``old'' \Package{epsfig}, so that support is slower +coming than it would otherwise be. + +There is no rational reason to stick with the old packages, which have +never been entirely satisfactory in the \LaTeX{} context. (One +irrational reason to leave them behind is that their replacement's +name tends not to imply that it's exclusively related to \PS{} +graphics. The reasoning also excludes \Package{epsfig}, of course.) + +A wide variety of detailed techniques and tricks have been developed +over the years, and Keith Reckdahl's \Package{epslatex} outlines them +in compendious detail: this highly recommendable document is available +from \acro{CTAN}. An invaluable review of the practicalities of +exchanging graphics between sites, +% beware multiple line break problems +\begin{wideversion} % hyperversion +``\href{http://silas.psfc.mit.edu/elec_fig/elec_figures.pdf}{Graphics for Inclusion in Electronic Documents}'' +\end{wideversion} +\begin{narrowversion} % non-hyper +\href{http://silas.psfc.mit.edu/elec_fig/elec_figures.pdf}% + {``Graphics for Inclusion in Electronic Documents''} +\end{narrowversion} +has been written by Ian Hutchinson; the document isn't on \acro{CTAN}, +but may also be +% beware line breaks +\href{http://silas.psfc.mit.edu/elec_fig/}{browsed on the Web}. +\begin{ctanrefs} +\item[epsf.tex]\CTANref{epsf} +\item[epsfig.sty]Part of the \CTANref{graphics} bundle +\item[epslatex.pdf]\CTANref{epslatex_pdf}; the document is also available + in \PS{} format as \CTANref{epslatex_ps} +\item[graphics.sty]\CTANref{graphics} +\item[graphicx.sty]Part of the \CTANref{graphics} bundle +\item[miniltx.tex]\CTANref{graphics-plain} +\item[psfig.sty]\CTANref{psfig} +\end{ctanrefs} + +\Question[Q-dvipsgraphics]{Imported graphics in \ProgName{dvips}} + +\ProgName{Dvips}, as originally conceived, can only import a single +graphics format: \nothtml{encapsulated \PS{} (\extension{eps} files, }% +\Qref{encapsulated \PS{}}{Q-eps}\htmlonly{ (\extension{eps} files}). +\ProgName{Dvips} also deals with the slightly eccentric \acro{EPS} that is +created by \Qref*{\MP{}}{Q-MP}. + +Apart from the fact that a depressing proportion of drawing +applications produce corrupt \acro{EPS} when asked for such output, +this is pretty satisfactory for vector graphics work. + +To include bitmap graphics, you need some means of converting them to +\PS{}; in fact many standard image manipulators (such as +\ProgName{ImageMagick}'s \ProgName{convert}) make a good job of +creating \acro{EPS} files (but be sure to ask for output at \PS{} +level~2 or higher). (\ProgName{Unix} users should beware of +\ProgName{xv}'s claims: it has a tendency to downsample your bitmap to +your screen resolution.) + +Special purpose applications \ProgName{jpeg2ps} (which converts +\acro{JPEG} files using \PS{} level 2 functionality), +\ProgName{bmeps} (which converts both \acro{JPEG} and \acro{PNG} +files) and \ProgName{a2ping}/\ProgName{sam2p} (which convert a +bewildering array of bitmap formats to \acro{EPS} or \acro{PDF} files; +\ProgName{sam2p} is one of the engines that \ProgName{a2ping} uses) +are also considered ``good bets''. + +\ProgName{Bmeps} comes with patches to produce your own version of +\ProgName{dvips} that can cope with \acro{JPEG} and \acro{PNG} direct, +using \ProgName{bmeps}'s conversion library. \ProgName{Dvips}, as +distributed by \miktex{}, comes with those patches built-in, but +assuming that capability destroys portability, and is only +recommendable if you are sure you will never want to share your +document. +\begin{ctanrefs} +\item[a2ping]\CTANref{a2ping} +\item[bmeps]\CTANref{bmeps} +\item[jpeg2ps]\CTANref{jpeg2ps} +\item[sam2p]\CTANref{sam2p} +\end{ctanrefs} + +\Question[Q-pdftexgraphics]{Imported graphics in \PDFLaTeX{}} + +\PDFTeX{} itself has a rather wide range of formats that it can +``natively'' incorporate into its output \acro{PDF} stream: +\acro{JPEG} (\extension{jpg} files) for photographs and similar images, +\acro{PNG} files for artificial bitmap images, and \acro{PDF} for +vector drawings. Old versions of \PDFTeX{} (prior to version~1.10a) +supported \acro{TIFF} (\extension{tif} files) format as an alternative +to \acro{PNG} files; don't rely on this facility, even if you +\emph{are} running an old enough version of \PDFTeX{}\dots{} + +In addition to the `native' formats, the standard \PDFLaTeX{} +\Package{graphics} package setup causes Hans Hagen's \File{supp-pdf} +macros to be loaded: these macros are capable of translating the +output of \MP{} to \acro{PDF} ``on the fly''; thus \MP{} output +(\extension{mps} files) may also be included in \PDFLaTeX{} documents. + +The commonest problem users encounter, when switching from \TeX{}, is +that there is no straightforward way to include \acro{EPS} files: +since \PDFTeX{} is its own ``driver'', and since it contains no means +of converting \PS{} to \acro{PDF}, there's no direct way the job can +be done. + +The simple solution is to convert the \acro{EPS} to an appropriate +\acro{PDF} file. The \ProgName{epstopdf} program will do this: it's +available either as a Windows executable or as a \ProgName{Perl} +script to run on Unix and other similar systems. A \LaTeX{} package, +\Package{epstopdf}, can be used to generate the requisite \acro{PDF} +files ``on the fly''; this is convenient, but requires that you +suppress one of \TeX{}'s security checks: don't allow its use in files +from sources you don't entirely trust. + +A similar package, \Package{pst-pdf}, permits other things than `mere' +graphics files in its argument. \Package{Pst-pdf} operates (the +authors suggest) ``like \BibTeX{}''~--- you process your file using +\PDFLaTeX{}, then use \LaTeX{}, \ProgName{dvips} and \ProgName{ps2pdf} +in succession, to produce a secondary file to input to your next +\PDFLaTeX{} run. (Scripts are provided to ease the production of the +secondary file.) + +An alternative solution is to use \ProgName{purifyeps}, a +\ProgName{Perl} script which uses the good offices of +\ProgName{pstoedit} and of \MP{} to convert your Encapsulated \PS{} to +``Encapsulated \PS{} that comes out of \MP{}'', and can therefore be +included directly. Sadly, \ProgName{purifyeps} doesn't work for all +\extension{eps} files. + +Good coverage of the problem is to be found in Herbert Vo\ss{}' +\href{http://pstricks.tug.org/main.cgi?file=pdf/pdfoutput}{\acro{PDF} support page}, +which is targeted at the use of \Package{pstricks} in +\PDFLaTeX{}, and also covers the \Package{pstricks}-specific package +\Package{pdftricks}. +\begin{ctanrefs} +\item[epstopdf]Browse \CTANref{epstopdf} +\item[epstopdf.sty]Distributed with Heiko Oberdiek's packages + \CTANref{oberdiek} +\item[pdftricks.sty]\CTANref{pdftricks} +\item[pst-pdf.sty]\CTANref{pst-pdf} +\item[pstoedit]\CTANref{pstoedit} +\item[purifyeps]\CTANref{purifyeps} +\end{ctanrefs} + +\Question[Q-dvipdfmgraphics]{Imported graphics in \ProgName{dvipdfm}} + +\ProgName{Dvipdfm} (and \ProgName{dvipdfmx}) translates direct from +\acro{DVI} to \acro{PDF} (all other available routes produce \PS{} +output using \ProgName{dvips} and then convert that to \acro{PDF} with +\ProgName{ghostscript} or \ProgName{Acrobat} \ProgName{Distiller}). + +\ProgName{Dvipdfm}/\ProgName{Dvipdfmx} are particularly flexible +applications. They permit the inclusion of bitmap and \acro{PDF} +graphics, as does \Qref*{\PDFTeX{}}{Q-pdftexgraphics}, but are also +capable of employing \ProgName{ghostscript} ``on the fly'' so as to be +able to permit the inclusion of encapsulated \PS{} (\extension{eps}) +files by translating them to \acro{PDF}. In this way, they combine the good +qualities of \ProgName{dvips} and of \PDFTeX{} as a means of +processing illustrated documents. + +Unfortunately, ``ordinary'' \LaTeX{} can't deduce the bounding box of +a binary bitmap file (such as \acro{JPEG} or \acro{PNG}), so you have +to specify the bounding box. This may be done explicitly, in the +document: +\begin{quote} +\begin{verbatim} +\usepackage[dvipdfm]{graphicx} +... +\includegraphics[bb=0 0 540 405]{photo.jpg} +\end{verbatim} +\end{quote} +It's usually not obvious what values to give the ``\texttt{bb}'' key, +but the program \ProgName{ebb} will generate a file +containing the information; the above numbers came from an +\ProgName{ebb} output file \File{photo.bb}: +\begin{quote} +\begin{verbatim} +%%Title: /home/gsm10/photo.jpg +%%Creator: ebb Version 0.5.2 +%%BoundingBox: 0 0 540 405 +%%CreationDate: Mon Mar 8 15:17:47 2004 +\end{verbatim} +\end{quote} +If such a file is available, you may abbreviate the inclusion +code, above, to read: +\begin{quote} +\begin{verbatim} +\usepackage[dvipdfm]{graphicx} +... +\includegraphics{photo} +\end{verbatim} +\end{quote} +which makes the operation feel as simple as does including +\extension{eps} images in a \LaTeX{} file for processing with +\ProgName{dvips}; the \Package{graphicx} package knows to look for a +\extension{bb} file if no bounding box is provided in the +\csx{includegraphics} command. + +The one place where usage isn't quite so simple is the need to quote +\ProgName{dvipdfm} explicitly, as an option when loading the +\Package{graphicx} package: if you are using \ProgName{dvips}, you +don't ordinarily need to specify the fact, since the default graphics +configuration file (of most distributions) ``guesses'' the +\texttt{dvips} option if you're using \TeX{}. +\begin{ctanrefs} +\item[dvipdfm]\CTANref{dvipdfm} +\item[dvipdfmx]\CTANref{dvipdfmx} +\item[ebb]Distributed as part of \CTANref{dvipdfm} +\end{ctanrefs} + +\Question[Q-grffilenames]{``Modern'' graphics file names} + +\TeX{} was designed in a world where file names were very simple +indeed, typically strictly limited both in character set and length. +In modern systems, such restrictions have largely disappeared, which +leaves \TeX{} rather at odds with its environment. Particular +problems arise with spaces in file names, but things like multiple +period characters can seriously confuse the \Package{graphics} +package. + +The specification of \TeX{} leaves some leeway for distributions to +adopt file access appropriate to their operating system, but this +hasn't got us very far. Many modern distributions allow you to +specify a file name as \texttt{"file name.tex"} (for example), which +helps somewhat, but while this allows us to say +\begin{quote} +\begin{verbatim} +\input "foo bar.tex" +\end{verbatim} +\end{quote} +the analogous usage +\begin{quote} +\begin{verbatim} +\includegraphics{"gappy graphics.eps"} +\end{verbatim} +\end{quote} +using ``ordinary'' \LaTeX{} causes confusion in \ProgName{xdvi} and +\ProgName{dvips}, even though it works at compilation time. Sadly, +even within such quotes, multiple dots give \csx{includegraphics} +difficulties. Note that +\begin{quote} +\begin{verbatim} +\includegraphics{"gappy graphics.pdf"} +\end{verbatim} +\end{quote} +works in a similar version of \PDFTeX{}. + +If you're using the \Package{graphics} package, the \Package{grffile} +package will help. The package offers several options, the simplest +of which are \pkgoption{multidot} (allowing more than one dot in a +file name) and \pkgoption{space} (allowing space in a file name). The +\pkgoption{space} option requires that you're running on a +sufficiently recent version of \PDFTeX{}, in \acro{PDF} mode~--- and +even then it won't work for \MP{} files, which are read as \TeX{} +input, and therefore use the standard input mechanism). +\begin{ctanrefs} +\item[grffile.sty]Distributed as part of \CTANref{oberdiek} +\end{ctanrefs} + +\Question[Q-graphicspath]{Importing graphics from ``somewhere else''} + +By default, graphics commands like \csx{includegraphics} look +``wherever \TeX{} files are found'' for the graphic file they're being +asked to use. This can reduce your flexibility if you choose to hold +your graphics files in a common directory, away from your \AllTeX{} +sources. + +The simplest solution is to patch \TeX{}'s path, by changing the +default path. On most systems, the default path is taken from the +environment variable \texttt{TEXINPUTS}, if it's present; you can adapt that +to take in the path it already has, by setting the variable to +\begin{quote} +\begin{verbatim} +TEXINPUTS=.:<graphics path(s)>: +\end{verbatim} +\end{quote} +on a Unix system; on a Windows system the separator will be ``\texttt{;}'' +rather than ``\texttt{:}''. The ``\texttt{.}'' is there to ensure +that the current directory is searched first; the trailing +``\texttt{:}'' says ``patch in the value of \texttt{TEXINPUTS} from +your configuration file, here''. + +This method has the merit of efficiency (\AllTeX{} does \emph{all} of +the searches, which is quick), but it's always clumsy and may prove +inconvenient to use in Windows setups (at least). + +The alternative is to use the \Package{graphics} package command +\csx{graphicspath}; this command is of course also available to users +of the \Package{graphicx} and the \Package{epsfig} packages. The +syntax of \csx{graphicspath}'s one argument is slightly odd: it's a +sequence of paths (typically relative paths), each of which is +enclosed in braces. A slightly odd sample, given in the +\Package{graphics} bundle documentation, is: +\begin{quote} +\begin{verbatim} +\graphicspath{{eps/}{tiff/}} +\end{verbatim} +\end{quote} +however, if the security checks on your \AllTeX{} system allow, the +path may be anything you choose (rather than strictly relative, like +those above); note that the trailing ``\texttt{/}'' \emph{is} required. + +Be aware that \csx{graphicspath} does not affect the operations of +graphics macros other than those from the graphics bundle~--- in +particular, those of the outdated \Package{epsf} and +\Package{psfig} packages are immune. + +The disadvantage of the \csx{graphicspath} method is inefficiency. The +package will call \AllTeX{} once for each entry in the list, which is +itself slows things. More seriously, \TeX{} remembers the file name, +thus effectively losing memory, every time it's +asked to look up a file, so a document that uses a huge number of +graphical inputs could be embarrassed by lack of memory. + +If your document is split into a variety of directories, and each +directory has its associated graphics, the \Package{import} package +may well be the thing for you; see the discussion % beware line break +\latexhtml{of ``bits of document in other directories'' (}{in the question ``}% +\Qref{bits of document in other directories}{Q-docotherdir}% +\latexhtml{)}{''}. +\begin{ctanrefs} +\item[graphics \nothtml{\rmfamily}bundle]\CTANref{graphics} +\item[import.sty]\CTANref{import} +\end{ctanrefs} + +\Question[Q-graph-pspdf]{Portable imported graphics} + +A regular need is a document to be distributed in more than +one format: commonly both \PS{} and \acro{PDF}. The +following advice is based on a post by one with much experience of +dealing with the problem of dealing with \acro{EPS} graphics in this +case. +\begin{itemize} +\item Don't specify a driver when loading loading whichever version of + the \Package{graphics} package you use. The scheme relies on the + distribution's ability to decide which driver is going to be used: + the choice is between \ProgName{dvips} and \PDFTeX{}, in this case. + Be sure to exclude options \pkgoption{dvips}, \pkgoption{pdftex} and + \pkgoption{dvipdfm} (\ProgName{dvipdfm} is not used in this scheme, + but the aspirant \acro{PDF}-maker may be using it for his output, + before switching to the scheme). +\item Use \cmdinvoke{includegraphics}[...]{filename} without + specifying the extension (i.e., neither \extension{eps} nor + \extension{pdf}). +\item For every \extension{eps} file you will be including, produce a + \extension{pdf} version, as described in % beware line break + \Qref[question]{Graphics in \PDFLaTeX{}}{Q-pdftexgraphics}. Having + done this, you will have two copies of each graphic (a \extension{eps} + and a \extension{pdf} file) in your directory. +\item Use \PDFLaTeX{} (rather than + \LaTeX{}--\ProgName{dvips}--distillation or + \LaTeX{}--\ProgName{dvipdfm}) to produce your \acro{PDF} output. +\end{itemize} +\ProgName{Dvipdfm}'s charms are less than attractive here: the +document itself needs to be altered from its default +(\ProgName{dvips}) state, before \ProgName{dvipdfm} will process it. + +\Question[Q-repeatgrf]{Repeated graphics in a document} + +A logo or ``watermark'' image, or any other image that is repeated in +your document, has the potential to make the processed version of the +document unmanageably large. The problem is, that the default +mechanisms of graphics usage add the image at every point it's to be +used, and when processed, the image appears in the output file at each +such point. + +Huge \PS{} files are embarrassing; explaining \emph{why} such a file +is huge, is more embarrassing still. + +The \Qref*{\File{epslatex} graphics tutorial}{Q-tutbitslatex} +describes a technique for avoiding the problem: basically, one +converts the image that's to be repeated into a \PS{} subroutine, and +load that as a \ProgName{dvips} prologue file. In place of the image, +you load a file (with the same bounding box as the image) containing +no more than an invocation of the subroutine defined in the prologue. + +The \File{epslatex} technique is tricky, but does the job. Trickier +still is the neat scheme of converting the figure to a one-character +Adobe Type~3 outline font. While this technique is for the ``real +experts'' only (the author of this answer has never even tried it), it has +potential for the same sort of space saving as the \File{epslatex} +technique, with greater flexibility in actual use. + +More practical is Hendri Adriaens' \Package{graphicx-psmin}; you load +this \emph{in place} of \Package{graphicx}, so rather than: +\begin{quote} +\begin{verbatim} +\usepackage[<options>]{graphicx} +\end{verbatim} +\end{quote} +you will write: +\begin{quote} +\begin{verbatim} +\usepackage[<options>]{graphicx-psmin} +\end{verbatim} +\end{quote} +and at the start of your document, you write: +\begin{quote} +\begin{verbatim} +\loadgraphics[<bb>]{<list of graphics>} +\end{verbatim} +\end{quote} +and each of the graphics in the list is converted to an ``object'' for +use within the resulting \PS{} output. (This is, in essence, an +automated version of the \File{epslatex} technique described above.) + +Having loaded the package as above, whenever you use +\csx{includegraphics}, the command checks if the file you've asked for +is one of the graphics in \csx{loadgraphics}' list. If so, the +operation is converted into a call to the ``object'' rather than a new +copy of the file; the resulting \PS{} can of course be \emph{much} smaller. + +Note that the package requires a recent \ProgName{dvips}, version +5.95b (this version isn't~--- yet~--- widely distributed). + +If your \PS{} is destined for conversion to \acro{PDF}, either by a +\ProgName{ghostscript}-based mechanism such as \ProgName{ps2pdf} or by +(for example) \ProgName{Acrobat} \ProgName{Distiller}, the issue isn't +so pressing, since the distillation mechanism will amalgamate graphics +objects whether or not the \PS{} has them amalgamated. \PDFTeX{} does +the same job with graphics, automatically converting multiple uses +into references to graphics objects. +\begin{ctanrefs} +\item[graphicx-psmin.sty]\CTANref{graphicx-psmin} +\end{ctanrefs} + +\Question[Q-grmaxwidth]{Limit the width of imported graphics} + +Suppose you have graphics which may or may not be able to fit within +the width of the page; if they will fit, you want to set them at their +natural size, but otherwise you want to scale the whole picture so +that it fits within the page width. + +You do this by delving into the innards of the graphics package (which +of course needs a little \LaTeX{} internals programming): +\begin{quote} +\begin{verbatim} +\makeatletter +\def\maxwidth{% + \ifdim\Gin@nat@width>\linewidth + \linewidth + \else + \Gin@nat@width + \fi +} +\makeatother +\end{verbatim} +\end{quote} +This defines a ``variable'' width which has the properties you want. +Replace \csx{linewidth} if you have a different constraint on the width +of the graphic. + +Use the command as follows: +\begin{quote} +\begin{verbatim} +\includegraphics[width=\maxwidth]{figure} +\end{verbatim} +\end{quote} + +\Question[Q-topgraph]{Top-aligning imported graphics} + +When \TeX{} sets a line of anything, it ensures that the base-line of +each object in the line is at the same level as the base-line of the +final object. (Apart, of course, from \csx{raisebox} commands\dots{}) + +Most imported graphics have their base-line set at the bottom of the +picture. When using packages such as \Package{subfig}, one often +wants to align figures by their tops. The following odd little bit of +code does this: +\begin{quote} +\begin{verbatim} +\vtop{% + \vskip0pt + \hbox{% + \includegraphics{figure}% + }% +} +\end{verbatim} +\end{quote} +The \csx{vtop} primitive sets the base-line of the resulting object to +that of the first ``line'' in it; the \csx{vskip} creates the illusion +of an empty line, so \csx{vtop} makes the very top of the box into the +base-line. + +In cases where the graphics are to be aligned with text, there is a +case for making the base-line one ex-height below the top of the box, +as in: +\begin{quote} +\begin{verbatim} +\vtop{% + \vskip-1ex + \hbox{% + \includegraphics{figure}% + }% +} +\end{verbatim} +\end{quote} +A more \LaTeX{}-y way of doing the job (somewhat inefficiently) uses +the \Package{calc} package: +\begin{quote} +\begin{verbatim} +\usepackage{calc} +... +\raisebox{1ex-\height}{\includegraphics{figure}} +\end{verbatim} +\end{quote} +(this has the same effect as the text-align version, above). + +The fact is, \emph{you} may choose where the base-line ends up. This +answer merely shows you sensible choices you might make. + +\Question[Q-mpprologues]{Displaying \MP{} output in \ProgName{ghostscript}} + +\MP{} ordinarily expects its output to be included in some context +where the `standard' \MF{} fonts (that you've specified) are already +defined~--- for example, as a figure in \TeX{} document. If you're +debugging your \MP{} code, you may want to view it in +\ProgName{ghostscript} (or some other \PS{} previewer). However, +the \PS{} `engine' in \ProgName{ghostscript} \emph{doesn't} +ordinarily have the fonts loaded, and you'll experience an error such +as +\begin{quote} +\begin{verbatim} +Error: /undefined in cmmi10 +\end{verbatim} +\end{quote} +There is provision in \MP{} for avoiding this problem: issue the +command \texttt{prologues := 2;} at the start of the \extension{mp} file. + +Unfortunately, the \PS{} that \MP{} inserts in its output, +following this command, is incompatible with ordinary use of the +\PS{} in inclusions into \AllTeX{} documents, so it's best to +make the \texttt{prologues} command optional. Furthermore, \MP{} takes a +very simple-minded approach to font encoding: since \TeX{} font +encodings regularly confuse sophisticated minds, this can prove +troublesome. If you're suffering such problems (the symptom is that +characters disappear, or are wrongly presented) the only solution is +to view the `original' \MP{} output after processing through +\LaTeX{} and \ProgName{dvips}. + +Conditional compilation may be done either +by inputting \File{MyFigure.mp} indirectly from a simple wrapper +\File{MyFigureDisplay.mp}: +\begin{quote} +\begin{verbatim} +prologues := 2; +input MyFigure +\end{verbatim} +\end{quote} +or by issuing a shell command such as +\begin{quote} +\begin{verbatim} +mp '\prologues:=2; input MyFigure' +\end{verbatim} +\end{quote} +(which will work without the quote marks if you're not using a Unix +shell). + +A suitable \LaTeX{} route would involve processing +\File{MyFigure.tex}, which contains: +\begin{quote} +\begin{verbatim} +\documentclass{article} +\usepackage{graphicx} +\begin{document} +\thispagestyle{empty} +\includegraphics{MyFigure.1} +\end{document} +\end{verbatim} +\end{quote} +Processing the resulting \acro{DVI} file with the \ProgName{dvips} +command +\begin{quote} +\begin{verbatim} +dvips -E -o MyFigure.eps MyFigure +\end{verbatim} +\end{quote} +would then give a satisfactory Encapsulated \PS{} file. This +procedure may be automated using the \ProgName{Perl} script +\ProgName{mps2eps}, thus saving a certain amount of tedium. + +The \plaintex{} user may use an adaptation of a jiffy of Knuth's, by +Dan Luecking. Dan's version \Package{mpsproof.tex} will work under +\TeX{} to produce a \acro{DVI} file for use with \ProgName{dvips}, or +under \PDFTeX{} to produce a \acro{PDF} file, direct. The output is +set up to look like a proof sheet. + +A script application, \ProgName{mptopdf}, is available in recent +\AllTeX{} distributions: it seems fairly reliably to produce +\acro{PDF} from \MP{}, so may reasonably be considered an answer to +the question\dots{} +\begin{ctanrefs} +\item[mps2eps]\CTANref{mps2eps} +\item[mpsproof.tex]\CTANref{mpsproof} +\item[mptopdf]Part of \CTANref{pdftex-graphics} +\end{ctanrefs} + +\Question[Q-drawing]{Drawing with \TeX{}} + +There are many packages to do pictures in \AllTeX{} itself (rather than +importing graphics created externally), ranging from simple use of +\LaTeX{} \environment{picture} environment, through enhancements like +\ProgName{eepic}, to +sophisticated (but slow) drawing with \PiCTeX{}. Depending on your type +of drawing, and setup, here are a few systems you may consider: +\begin{itemize} +\item \PiCTeX{} is a venerable, and very powerful, system, that draws + by placing dots on the page to give the effect of a line or curve. While + this has the potential of great power, it is (of course) much slower + than any of the other established packages. What's more, there + are problems with its \Qref*{documentation}{Q-docpictex}. +\item \Package{epic} was designed to make use of the \LaTeX{} + \environment{picture} environment somewhat less agonising; + \Package{eepic} extends it, and is capable of using \ProgName{tpic} + \csx{special} commands to improve printing performance. (If the + \csx{special}s aren't available, the \Package{eepicemu} will do the + business, far less efficiently. +\item \Package{pict2e}; this was advertised in % !line break + \Qref*{the \LaTeX{} manual}{Q-books}, but didn't appear for nearly + ten years after publication of the book! It removes all the petty + restrictions that surround the use of the \environment{picture} + environment. It therefore suffers \emph{only} from the rather + eccentric drawing language of the environment, and is a far more + useful tool than the original environment has ever been. (Note that + \Package{pict2e} supersedes David Carlisle's stop-gap + \Package{pspicture}.) +\item \Package{PSTricks}; this gives you access to all the power of + \PS{} from \TeX{} itself, by sophisticated use of + \Qref*{\csx{special} commands}{Q-specials}. Since \PS{} is itself a + pretty powerful programming language, many astounding things can in + principle be achieved using \Package{PSTricks} (a wide range of + contributed packages, ranging from world mapping to lens design + diagrams, is available). + \Package{Pstricks}' \csx{special}s are + by default specific to \ProgName{dvips}, but V\TeX{} (both in its + commercial and in its free versions) understands them. \PDFTeX{} + users may use \Package{pst-pdf}, which (like + \Package{epstopdf}~--- see % ! line break + \Qref[question]{\PDFLaTeX{} graphics}{Q-pdftexgraphics}) generates + \acro{PDF} files using an auxiliary program, from \Package{PSTricks} + commands (\Package{pst-pdf} also requires a recent installation of + the \Package{preview} package). + + There is a \Package{PSTricks} mailing list + (\mailto{pstricks@tug.org}) which you may + \href{http://tug.org/mailman/listinfo/pstricks}{join}, or you may + just browse the % ! line break + \href{http://tug.org/pipermail/pstricks/}{list archives}. +\item \Package{pgf}: while \Package{pstricks} is very powerful and + convenient, using it with \PDFLaTeX{} is an awful fidget: if you + simply want the graphical capabilities, \Package{pgf}, together with + its rather pleasing ``user-oriented'' interface \Package{tikz}, may be a good + bet for you. While \acro{PDF} has (in essence) the same graphical + capabilities as \PS{}, it isn't programmable; \Package{pgf} provides + common \LaTeX{} commands that will utilise the graphical + capabilities of both \PS{} and \acro{PDF} equally. +\item \MP{}; you liked \MF{}, but never got to grips with font files? + Try \Qref*{\MP{}}{Q-MP}~--- + all the power of \MF{}, but it generates \PS{} figures; \MP{} + is nowadays part of most serious \AllTeX{} distributions. Knuth + uses it for all his work\dots{} +\item \ProgName{Mfpic}; you liked \MF{}, but can't understand the + language? The package makes up \MF{} or \MP{} code for you + within using familiar-looking \TeX{} macros. Not \emph{quite} the + full power of \MP{}, but a friendlier interface; of course, with + \MP{} output, the results can be used equally well in either + \LaTeX{} or \PDFLaTeX{}. +\item You liked \PiCTeX{} but don't have enough memory or time? Look + at Eitan Gurari's \Package{dratex}, which is as powerful as most + other \TeX{} drawing packages, but is an entirely new + implementation, which is not as hard on memory, is much more + readable (and is fully documented). +\end{itemize} +\begin{ctanrefs} +\item[dratex.sty]\CTANref{dratex} +\item[epic.sty]\CTANref{epic} +\item[eepic.sty]\CTANref{eepic} +\item[eepicemu.sty]\CTANref{eepic} +\item[mfpic]\CTANref{mfpic} +\item[preview.sty]\CTANref{preview} +\item[pspicture.sty]\CTANref{pspicture} +\item[pst-pdf.sty]\CTANref{pst-pdf} +\item[pgf.sty]\CTANref{pgf} +\item[pict2e.sty]\CTANref{pict2e} +\item[pictex.sty]\CTANref{pictex} +\item[pstricks]\CTANref{pstricks} +\item[tikz.sty]Distributed with \CTANref{pgf} +\end{ctanrefs} + +\Question[Q-drawFeyn]{Drawing Feynman diagrams in \LaTeX{}} + +Michael Levine's \Package{feynman} bundle for drawing the diagrams in +\LaTeXo{} is still available. + +Thorsten Ohl's \Package{feynmf} is designed for use with current +\LaTeX{}, and works in +combination with \MF{} (or, in its \Package{feynmp} incarnation, with +\MP{}). The \ProgName{feynmf} or +\ProgName{feynmp} package reads a description of the diagram written +in \TeX{}, and writes out code. \MF{} (or \MP{}) can then produce a +font (or \PS{} file) for use in a subsequent \LaTeX{} run. For +new users, who have access to \MP{}, the \PS{} version is +probably the better route, for document portability and other reasons. +% checked rf 2001/03/22 + +Jos Vermaseren's \Package{axodraw} is mentioned as an alternative in +the documentation of \Package{feynmf}, but it is written entirely in +terms of \ProgName{dvips} \csx{special} commands, and is thus rather +imperfectly portable. + +An alternative approach is implemented by Norman Gray's \Package{feyn} +package. Rather than creating complete diagrams as postscript images, +\Package{feyn} provides a font (in a variety of sizes) containing +fragments, which you can compose to produce complete diagrams. It +offers fairly simple diagrams which look good in equations, rather +than complicated ones more suitable for display in figures. +\begin{ctanrefs} +\item[axodraw]\CTANref{axodraw} +\item[feyn \nothtml{\rmfamily}font bundle]\CTANref{feyn} +\item[feynman bundle]\CTANref{feynman} +\item[feynmf/feynmp bundle]\CTANref{feynmf} +\end{ctanrefs} + +\Question[Q-labelfig]{Labelling graphics} + +``Technical'' graphics (such as graphs and diagrams) are often +labelled with quite complex mathematical expressions: there are few +drawing or graphing tools that can do such things (the honourable +exception being \MP{}, which allows you to program the labels, in +\AllTeX{}, in the middle of specifying your graphic). + +Labels on graphics produced by all those \emph{other} tools is where +the \Package{psfrag} package can help. Place an unique +text in your graphic, using the normal text features of your tool, and +you can ask \Package{psfrag} to replace the text with arbitrary +\AllTeX{} material. \Package{Psfrag}'s ``operative'' command is +\cmdinvoke{psfrag}{\emph{PS text}}{\emph{Repl text}}, which instructs +the system to replace the original (``\texttt{PS}'') text with the +\TeX{}-typeset replacement text. Optional +arguments permit adjustment of position, scale and rotation; full +details may be found in \File{pfgguide} in the distribution. + +Since \Package{psfrag} works in terms of (encapsulated) \PS{} files, +it needs extra work for use with \PDFLaTeX{}. The % ! line break +\Qref*{\Package{pst-pdf} package}{Q-pdftexgraphics} can support such +usage. In fact, the \Package{pst-pdf} support package +\Package{auto-pst-pdf} offers a configuration setting precisely for +use with \Package{psfrag}. + +On the other hand, +\begin{narrowversion} + V\TeX{}'s GeX processor (\Qref{}{Q-commercial}) +\end{narrowversion} +\begin{wideversion} + \Qref*{V\TeX{}}{Q-commercial}'s GeX processor +\end{wideversion} +explicitly deals with \Package{psfrag}, both in its free and +commercial instances. + +The \Package{psfragx} package goes one step further than +\Package{psfrag}: it provides a means whereby you can put the +\Package{psfrag} commands into the preamble of your \acro{EPS} file +itself. \Package{Psfrag} has such a command itself, but deprecates +it; \Package{psfragx} has cleaned up the facility, and provides a +script \ProgName{laprint} for use with \ProgName{Matlab} to produce +appropriately tagged output. (In principle, other graphics +applications could provide a similar facility, but apparently none does.) + +\ProgName{Emacs} users may find the embedded editor \ProgName{iTe} a +useful tool for placing labels: it's a \AllTeX{}-oriented graphical +editor written in \ProgName{Emacs Lisp}. You create +\environment{iteblock} environments containing graphics and text, and +may then invoke \ProgName{iTe} to arrange the elements relative to one +another. + +Another useful approach is \Package{overpic}, which overlays a +\environment{picture} environment on a graphic included by use of +\csx{includegraphics}. This treatment lends itself to ready placement +of texts and the like on top of a graphic. The package can draw a +grid for planning your ``attack''; the distribution comes with simple +examples. + +\Package{Pstricks} can of course do everything that \Package{overpic} +can, with all the flexibility of \PS{} programming that it offers +The \Package{pstricks} web site has a page with several % ! line break +\href{http://pstricks.tug.org/main.cgi?file=Examples/overlay}{examples of labelling} +which will get you started; if \Package{pstricks} is % ! line break +\Qref*{an option for you}{Q-drawing}, this route is worth a try. + +The confident user may, of course, do the whole job in a picture +environment which itself includes the graphic. I would recommend +\Package{overpic} or the \Package{pstricks} approach, but such things +are plainly little more than a convenience over what is achievable +with the do-it-yourself approach. +\begin{ctanrefs} +\item[auto-pst-pdf.sty]\CTANref{auto-pst-pdf} +\item[iTe]\CTANref{ite} +\item[laprint]Distributed with \CTANref{psfragx} +\item[overpic.sty]\CTANref{overpic} +\item[psfrag.sty]\CTANref{psfrag} +\item[psfragx.sty]\CTANref{psfragx} +\item[pstricks.sty]\CTANref{pstricks} +\item[pst-pdf.sty]\CTANref{pst-pdf} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex new file mode 100644 index 00000000000..f6427148267 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex @@ -0,0 +1,3888 @@ +% $Id: faq-how-do-i.tex,v 1.3 2009/10/06 22:23:45 rf10 Exp rf10 $ + +\section{How do I do\dots{}?} + +\subsection{Mathematics} + +\Question[Q-proof]{Proof environment} + +It has long been thought impossible to make a \environment{proof} +environment which automatically includes an `end-of-proof' symbol. +Some proofs end in displayed maths; others do not. If the input file +contains +% beware line break +\texttt{...\csx{]} }\cmdinvoke{end}{proof} then \LaTeX{} finishes off +the displayed maths and gets ready for a new line before it reads any +instructions connected with ending the proof, so the code is very +tricky. You \emph{can} insert the symbol by hand, but the +\Package{ntheorem} package now solves the problem for \LaTeX{} users: +it does indeed provide an automatic way of signalling the end of a +proof. + +The \AMSLaTeX{} package \Package{amsthm} also provides a +\environment{proof} environment that does the job; though you need to +insert a \csx{qedhere} command if the proof ends with a displayed +equation: +\begin{quote} +\begin{verbatim} +\begin{proof} + text... + \begin{equation*} + maths... \tag*{\qedhere} + \end{equation*} +\end{proof} +\end{verbatim} +\end{quote} +The \cmdinvoke{tag*}{\csx{qedhere}} construction may be used in any of +\AMSLaTeX{}'s numbering environments. +\begin{ctanrefs} +\item[amsthm.sty]Distributed as part of the \AMSLaTeX{} bundle + \CTANref{amslatex} +\item[ntheorem.sty]\CTANref{ntheorem} +\end{ctanrefs} + +\Question[Q-theoremfmt]{Theorem bodies printed in a roman font} + +If you want to take advantage of the powerful \csx{newtheorem} command +without the constraint that the contents of the theorem is in a sloped +font (for example, you may want to use it to create remarks, examples, proofs, +\dots{}) then you can use the \AMSLaTeX{} \Package{amsthm} package +(which now supersedes the \Package{theorem} package previously +recommended in these answers). +Alternatively, the following sets up an environment +\environment{remark} whose content is in the default roman font. +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\newtheorem{preremark}{Remark} +\newenvironment{remark}% + {\begin{preremark}\upshape}% + {\end{preremark}} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\newtheorem{preremark}{Remark} +\newenvironment{remark}% + {\begin{preremark}\upshape}{\end{preremark}} +\end{verbatim} +\end{wideversion} +\end{quote} +The \Package{ntheorem} package provides control of the fonts used by +theorems, directly. +\begin{ctanrefs} +\item[amsthm.sty]Distributed as part of \CTANref{amslatex} +\item[ntheorem.sty]\CTANref{ntheorem} +\item[theorem.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-newfunction]{Defining a new log-like function in \LaTeX{}} + +Use the \csx{mathop} command, as in: +\begin{quote} +\begin{verbatim} +\newcommand{\diag}{\mathop{\mathrm{diag}}} +\end{verbatim} +\end{quote} + +Subscripts and superscripts on \csx{diag} will be placed below and +above the function name, as they are on +\csx{lim}. If you want your subscripts and superscripts always placed +to the right, do: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\newcommand{\diag}% + {\mathop{\mathrm{diag}}\nolimits} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\newcommand{\diag}{\mathop{\mathrm{diag}}\nolimits} +\end{verbatim} +\end{wideversion} +\end{quote} + +\AMSLaTeX{} (in its \Package{amsopn} package, which is automatically +loaded by \Package{amsmath}) provides a command +\csx{DeclareMathOperator} that takes does the same job as the first +definition above. To create our original \csx{diag} command, one would +say: +\begin{quote} +\begin{verbatim} +\DeclareMathOperator{\diag}{diag} +\end{verbatim} +\end{quote} +\csx{DeclareMathOperator*} declares the operator always to have its +sub- and superscripts in the % ! line break +``\Qref*{\csx{limits} position}{Q-limits}''. + +The \Package{amsopn} command \csx{operatorname} allows you to +introduce \emph{ad hoc} operators into your mathematics, so +\begin{quote} + \csx{[} \cmdinvoke{operatorname}{foo}\texttt{(bar)} \csx{]} +\end{quote} +typesets the same as +\begin{quote} +\begin{verbatim} +\DeclareMathOperator{\foo}{foo} +... +\[ \foo(bar) \] +\end{verbatim} +\end{quote} +As with \csx{DeclareMathOperator} there's a starred version +\csx{operatorname*} for sub- and superscripts in the limits position. + +(It should be noted that ``log-like'' was reportedly a \emph{joke} on +Lamport's part; it is of course clear what was meant.) +\begin{ctanrefs} +\item[amsopn.sty]In the \AMSLaTeX{} distribution \CTANref{amslatex} +\end{ctanrefs} + +\Question[Q-braket]{Set specifications and Dirac brackets} + +One of the few glaring omissions from \TeX{}'s mathematical +typesetting capabilities is a means of setting separators in the +middle of mathematical expressions. \TeX{} provides primitives called +\csx{left} and \csx{right}, which can be used to modify brackets (of +whatever sort) around a mathematical expression, as in: +% beware line wrap +\csx{left(}\texttt{ <expression> }\csx{right)}~--- the size of the +parentheses is matched to the vertical extent of the expression. + +However, in all sorts of mathematical enterprises one may find oneself +needing a \csx{middle} command, to be used in expressions like +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\left\{ x \in \mathbb{N} \middle| x \mbox{ even} \right\} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\left\{ x\in \mathbb{N} \middle| + x \mbox{ even} \right\} +\end{verbatim} +\end{narrowversion} +\end{quote} +to specify the set of even natural numbers. The % ! line break +\Qref*{\eTeX{} system}{Q-etex} +defines just such a command, but users of Knuth's original need some +support. Donald Arseneau's \Package{braket} package provides commands +for set specifications (as above) and for Dirac brackets (and bras and +kets). The package uses the \eTeX{} built-in command if it finds +itself running under \eTeX{}. +\begin{ctanrefs} +\item[braket.sty]\CTANref{braket} +\end{ctanrefs} + +\Question[Q-cancellation]{Cancelling terms in maths expressions} + +A technique used when explaining the behaviour of expressions or +equations (often for pedagogical purposes). The \Package{cancel} +package provides several variants of cancellation marks +(``\texttt{\textbackslash }'', ``\texttt{/}'' and ``\texttt{X}''), and +a means of cancelling `to' a particular value. + +Documentation of \Package{cancel} is in the package file. +\begin{ctanrefs} +\item[cancel.sty]\CTANref{cancel} +\end{ctanrefs} + +\Question[Q-mathsize]{Adjusting maths font sizes} + +In \plaintex{}, when you introduce a new font size you must also +declare what size fonts are to be used in mathematics with it. This +is done by declaring \csx{textfont}, \csx{scriptfont} and +\csx{scriptscriptfont} for the maths families you're using; all such +things are described in chapter~17 of the % line wrap! +\Qref*{\TeX{}book}{Q-books} and in other books and +\Qref*{tutorials}{Q-man-tex} that discuss \plaintex{} in sufficient +detail. + +In \LaTeX{}, of course, all this stuff is automated: there is a scheme +that, for each (text) font size, determines what maths font sizes are +to be used. The scheme first checks a set of ``known'' text sizes, +for each of which maths sizes are declared in advance. If the text +size isn't ``known'', the script- and scriptscriptfont sizes are +calculated as fixed ratios of the tex font size. (The values used are +\csx{defaultscriptratio}\ensuremath{=}0.7, and +\csx{defaultscriptscriptratio}\ensuremath{=}0.5.) + +The fixed-ratio formula is capable of producing inconvenient results +(particularly if you are using fonts which \LaTeX{} believes are only +available in a fixed set of sizes). You may also want to replace +\LaTeX{}'s ideas altogether, for example by setting maths noticeably +larger or smaller than its surrounding text. For this purpose, the +\LaTeX{} command +\cmdinvoke{DeclareMathSizes}{\meta{tfs}}{\meta{ts}}{\meta{ss}}{\meta{sss}} +may be used (this is the same command that \LaTeX{} itself uses to +define its own set of sizes). This establishes (or re-establishes) +the maths font sizes to be used when the surrounding text font size is +\texttt{\meta{tfs}}; (\texttt{\meta{ts}} being the size used for +\csx{textfont}, \texttt{\meta{ss}} for \csx{scriptfont} and +\texttt{\meta{sss}} for \csx{scriptscriptfont}). + +For example, you might want to use a font with a smaller body height +than Computer Modern, but still prefer \acro{CM} math to any of the +alternatives. In this case, you might use: +\begin{quote} +\begin{verbatim} +\DeclareMathSizes{10}{9}{7}{5} +\end{verbatim} +\end{quote} +to get 9pt maths when the surrounding body text is (nominal) 10pt. + +\csx{DeclareMathSizes} may only be used in the preamble of the +document: only one association is available for each text font size +for the whole document. The default settings are specified in +\File{fontdef.dtx} in the latex distribution, and are compiled into +\File{fontmath.ltx}; the arguments to the command are just numbers +(`\texttt{pt}' is assumed), but some of them are written using +\Qref*{\LaTeX{} abbreviations}{Q-ltxabbrv} for standard font sizes. +Beware simply copying (parts of) the \LaTeX{} definitions~--- since +they contain those internal abbreviations, they need to be treated as +\Qref{internal commands}{Q-atsigns}. +\begin{ctanrefs} +\item[fontdef.dtx]\CTANref{fontdef} +\item[fontmath.ltx]\CTANref{fontmath} +\end{ctanrefs} + +\Question[Q-mathlips]{Ellipses} +\keywords{\csx{dots} \csx{cdots} \csx{vdots} \csx{ddots}} + +Ellipses are commonly required, and \LaTeX{} natively supplies a fair +range (\csx{dots}, \csx{cdots}, \csx{vdots} and \csx{ddots}). By using +the \Package{graphics} package, one can change the slope of the +\csx{ddots} command, as in +\begin{verbatim} + $ ... \reflectbox{$\ddots$} ... $ +\end{verbatim} +While this works, it is not a recommended way of achieving the desired +result (see below). Moreover, \LaTeX{}'s range is not adequate to +everyone's requirements, and at least three packages provide +extensions to the set. + +The \AMSLaTeX{} bundle provides a range of ``semantically-named'' +ellipses, for use in different situations: \csx{dotsb} for use between +pairs of binary operators, \csx{dotsc} for use between pairs of commas, +and so on. + +The \Package{yhmath} package defines an \csx{adots} command, which is +the analogue of \csx{ddots}, sloping forwards rather than backwards. +The \Package{yhmath} package comes with a rather interesting font that +extends the standard \Package{cmex}; details are in the documentation. +The disadvantage of this setup is, that although \csx{adots} is merely +a macro, the package tries to load its own font and produces a +``missing font'' substitution warning message if you haven't installed +the font. + +The \Package{mathdots} package (besides fixing up the behaviour of +\AllTeX{} \csx{ddots} and \csx{vdots} when the font size changes) +provides an ``inverse diagonal'' ellipsis \csx{iddots} (doing the same +job as \Package{yhmath}'s \csx{adots}, but better). + +Documentation of \Package{yhmath} appears, processed, in the +distribution (thus saving you the bother of installing the package +before being able to read the documentation). Documentation of +\Package{mathdots} appears at the end the package file itself. +\begin{ctanrefs} +\item[amslatex]\CTANref{amslatex} +\item[graphics.sty]Part of the \CTANref{graphics} bundle +\item[mathdots.sty]\CTANref{mathdots} +\item[yhmath \nothtml{\rmfamily}(fonts)]\CTANref{yhmath-fonts} +\item[yhmath \nothtml{\rmfamily}(macros)]\CTANref{yhmath-macros} +\end{ctanrefs} + +\Question[Q-limits]{Sub- and superscript positioning for operators} + +The commonest hand-written style for expressions is to place the limit +expressions on operators such as \csx{sum} and \csx{int} physically +above and below the operator. In \AllTeX{}, we write these limit +expressions using sub- and superscripts applied to the operator, but +they don't always appear in the ``handwritten'' way in \TeX{}'s +output. + +The reason is, that when an expression appears in non-display maths, +in running text (and is therefore in \TeX{} \csx{textstyle}), placing +the limits thus could lead to ragged line spacing (and hence +difficult-to-read text). It is therefore common (in \csx{textstyle}) +to place the limits as one would sub- and superscripts of variables. + +This is not universally satisfactory, so the primitive \csx{limits} is +provided: +\begin{quote} +\begin{verbatim} +$\sum\limits_{n=1}^{m} ...$ +\end{verbatim} +\end{quote} +which will place the limits right above and below the symbol (and be +blowed to the typography\dots{}). + +Contrariwise, you may wish to change the arrangement of the limits +when in \csx{displaystyle}. For this purpose, there's a corresponding +\csx{nolimits}: +\begin{quote} +\begin{verbatim} +\[\sum\nolimits_{n=1}^{m} ...\] +\end{verbatim} +\end{quote} +which will place the limits as they would be in \csx{textstyle}. + +Alternatively, one can manipulate the +\csx{textstyle}/\csx{displaystyle} state of the mathematics. To get +``\csx{limits} placement'' in inline maths, +\begin{quote} +\begin{verbatim} +$\displaystyle\sum_{n=1}^{m} ...$ +\end{verbatim} +\end{quote} +and for ``\csx{nolimits} placement'' in display maths, +\csx{nolimits}: +\begin{quote} +\begin{verbatim} +\[\textstyle\sum_{n=1}^{m} ...\] +\end{verbatim} +\end{quote} +will serve. Either of these forms may have effects other than on the +operator you're considering, but there are still those who prefer this +formulation. + +Remember, if you're % ! line break +\Qref*{declaring a special operator of your own}{Q-newfunction}, the +\AMSLaTeX{} functions (that you ought to be using) allow you to choose +how limits are displayed, at definition time. + +(Note that the macro \csx{int} normally has \csx{nolimits} built in to +its definition. There is an example in the \TeX{}book to show how odd +\csx{int}\csx{limits} looks when typeset.) + +\Question[Q-mathstext]{Text inside maths} + +When we type maths in \AllTeX{}, the letters from which we make up +ordinary text assume a special significance: they all become +single-letter variable names. The letters appear in italics, but it's +not the same sort of italics that you see when you're typing ordinary +text: a run of maths letters (for example ``here'') looks oddly +``lumpy'' when compared with the word written in italic text. The +difference is that the italic text is kerned to make the letters fit +well together, whereas the maths is set to look as if you're +multiplying \emph{h} by \emph{e} by \emph{r} by \emph{e}. The other +way things are odd in \TeX{} maths typing is that spaces are ignored: +at best we can write single words in this oddly lumpy font. + +So, if we're going to have good-looking text in amongst maths we're +writing, we have to take special precautions. If you're using +\LaTeX{}, the following should help. + +The simplest is to use \csx{mbox} or \csx{textrm}: +\begin{quote} +\begin{verbatim} +$e = mc^2 \mbox{here we go again}$ +\end{verbatim} +\end{quote} +The problem is that, with either, the size of the text remains firmly +at the surrounding text size, so that +\begin{quote} +\begin{verbatim} +$z = a_{\mbox{other end}}$ +\end{verbatim} +\end{quote} +can look quite painfully wrong. + +The other simple technique, \csx{textrm}, is no more promising: +\begin{quote} +\begin{verbatim} +$z = a_{\textrm{other end}}$ +\end{verbatim} +\end{quote} +does the same as \csx{mbox}, by default. + +(The maths-mode instance of your roman font (\csx{mathrm}) gets the +size right, but since it's intended for use in maths, its spaces get +ignored~--- use \csx{mathrm} for upright roman alphabetic variable +names, but not otherwise.) + +You can correct these problems with size selectors in the text, as: +\begin{quote} +\begin{verbatim} +$z = a_{\mbox{\scriptsize other end}}$ +\end{verbatim} +\end{quote} +which works if your surrounding text is at default document size, but +gives you the wrong size otherwise. + +The \csx{mbox} short cut is (just about) \acro{OK} for ``occasional'' +use, but serious mathematics calls for a technique that +relieves the typist of the sort of thought required. As usual, the +\AMSLaTeX{} system provides what's necessary~--- the \csx{text} +command. (The command is actually provided by the \Package{amstext} +package, but the ``global'' \Package{amsmath} package loads it.) Thus +anyone using \AMSLaTeX{} proper has the command available, so even +this author can write: +\begin{quote} +\begin{verbatim} +\usepackage{amsmath} +... +$z = a_{\text{other end}}$ +\end{verbatim} +\end{quote} +and the text will be at the right size, and in the same font as +surrounding text. (The \Package{amstext} package also puts +\csx{textrm} to rights~--- but \csx{text} is easier to type than +\csx{textrm}!) + +\AMSLaTeX{} also makes provision for interpolated comments in the +middle of one of its multi-line display structures, through the +\csx{intertext} command. For example: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\begin{align} + A_1&=N_0(\lambda;\Omega')- + \phi(\lambda;\Omega'),\\ + A_2&=\phi(\lambda;\Omega')- + \phi(\lambda;\Omega),\\ +\intertext{and} + A_3&=\mathcal{N}(\lambda;\omega). +\end{align} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\begin{align} + A_1&=N_0(\lambda;\Omega')-\phi(\lambda;\Omega'),\\ + A_2&=\phi(\lambda;\Omega')-\phi(\lambda;\Omega),\\ + \intertext{and} A_3&=\mathcal{N}(\lambda;\omega). +\end{align} +\end{verbatim} +\end{wideversion} +\end{quote} +places the text ``and'' on a separate line before the last line of the +display. If the interjected text is short, or the equations +themselves are light-weight, you may find that \csx{intertext} leaves +too much space. Slightly more modest is the \csx{shortintertext} +command from the \Package{mathtools} package: +\begin{quote} +\begin{verbatim} +\begin{align} + a =& b + \shortintertext{or} + c =& b +\end{align} +\end{verbatim} +\end{quote} +To have the text on the same line as the second equation, one can use +the \environment{flalign} environment (from \Package{amsmath}) +with lots of dummy equations (represented by the double \texttt{\&} +signs): +\begin{quote} +\begin{verbatim} +\begin{flalign} + && a =& b && \\ + \text{or} && c =& b && +\end{flalign} +\end{verbatim} +\end{quote} + +Comprehensive documentation of \AMSLaTeX{} is to be found in +\File{amsldoc}, in the distribution; it is also available on the web +at \URL{ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf} +\begin{ctanrefs} +\item[amsldoc.tex]Distributed as part of \AMSLaTeX{} + \CTANref{amslatex} +\item[amsmath.sty]Distributed as part of \AMSLaTeX{} + \CTANref{amslatex} +\item[amstext.sty]Distributed as part of \AMSLaTeX{} + \CTANref{amslatex} +\item[mathtools.sty]Distributed as part of the \Package{mh} bundle + \CTANref{mh} +\end{ctanrefs} + +\Question[Q-reuseq]{Re-using an equation} + +To repeat an existing equation, one wants not only to have the same +mathematics in it, one also wants to re-use the original label it had. +The \Package{amsmath} package comes to our help, here: +\begin{quote} +\begin{verbatim} +\usepackage{amsmath} +... +\begin{equation} + a=b + \label{eq1} +\end{equation} +... +Remember that +\begin{equation} + a=b + \tag{\ref{eq1}} +\end{equation} +\end{verbatim} +\end{quote} +Here, the second instance of \ensuremath{a=b} will be +typeset with a copy, made by the \csx{tag} command, of the label of the +first instance. + +Comprehensive documentation of \AMSLaTeX{} is to be found in +\File{amsldoc}, in the distribution; it is also available on the web +at \URL{ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf} +\begin{ctanrefs} +\item[amsldoc.tex]Distributed as part of \AMSLaTeX{} + \CTANref{amslatex} +\item[amsmath.sty]Distributed as part of \AMSLaTeX{} + \CTANref{amslatex} +\end{ctanrefs} + +\Question[Q-brkinline]{Line-breaking in in-line maths} + +\TeX{}, by default, allows you to split a mathematical expression at +the end of the line; it allows breaks at relational operators (like +``='', ``\textless'', etc.) and at binary operators (like ``+'', +``-'', etc.). In the case of large expressions, this can sometimes be +a life-saver. + +However, in the case of simple expressions like \ensuremath{a=b+c}, a +break can be really disturbing to the reader, and one would like to +avoid it. + +Fortunately, these breaks are controllable: there are ``penalties'' +associated with each type of operator: the penalty + says how +undesirable a break at each point is. Default values are: +\begin{quote} +\begin{verbatim} +\relpenalty = 500 +\binoppenalty = 700 +\end{verbatim} +\end{quote} +You make the break progressively less attractive by increasing these +values. You can actually forbid all breaks, everywhere, by: +\begin{quote} +\begin{verbatim} +\relpenalty = 10000 +\binoppenalty = 10000 +\end{verbatim} +\end{quote} +If you want just to prevent breaks in a single expression, write: +\begin{quote} +\begin{verbatim} +{% + \relpenalty = 10000 + \binoppenalty = 10000 + $a=b+c$ +} +\end{verbatim} +\end{quote} +and the original values will remain undisturbed outside the braces. +This is tedious: there is often value in an alternative approach, +in which you say which parts of the expression may not break whatever +happens, and fortunately this is surprisingly easy. Suppose we want +to defer a break until after the equality, we could write: +\begin{quote} +\begin{verbatim} +${a+b+c+d} = z+y+x+w$ +\end{verbatim} +\end{quote} +The braces say ``treat this subformula as one atom'' and (in \TeX{} at +least) atoms don't get split: not a \csx{binoppenalty} change in sight. + +\Question[Q-mathonlyref]{Numbers for referenced equations only} + +There are those who consider that papers look untidy with numbers on +every equation; there is also a school of thought that claims that +there should be numbers everywhere, in case some reader wants to make +reference an equation to which the author made no cross-reference. + +If you hold to the ``only cross-referenced'' school of thought, you +can (using the \csx{nonumber} command on the relevant equations, or by +using the \AMSLaTeX{} unnumbered environments such as +\environment{equation*}) mark those of your equations to which you +make no reference. In a long or complex paper, this procedure could +well become deeply tedious. + +Fortunately, help is at hand: the \Package{mh} bundle's +\Package{mathtools} package offers a `\pkgoption{showonlyrefs}' +switch through its \csx{mathtoolsset} command; when that's in +operation, only those equations to which you make reference will be +numbered in the final output. See the package's documentation for +details of how to make references when the switch is in effect. +\begin{ctanrefs} +\item[mathtools.sty]Distributed as part of \CTANref{mh} +\end{ctanrefs} + +\subsection{Lists} + +\Question[Q-enumerate]{Fancy enumeration lists} + +The \Package{enumerate} package allows you to control the display of +the enumeration counter. The package adds an optional parameter to +the \environment{enumerate} environment, which is used to specify the +layout of the labels. The layout parameter contains an enumeration +type (`\texttt{1}' for arabic numerals, `\texttt{a}' or `\texttt{A}' +for alphabetic enumeration, and `\texttt{i}' or `\texttt{I}' for Roman +numerals), and things to act as decoration of the enumeration. So, +for example +\begin{quote} +\begin{verbatim} +\usepackage{enumerate} +... +\begin{enumerate}[(a)] +\item ... ... +\end{enumerate} +\end{verbatim} +\end{quote} +starts a list whose labels run (a), (b), (c), \dots{}; while +\begin{quote} +\begin{verbatim} +\usepackage{enumerate} +... +\begin{enumerate}[I/] +\item ... ... +\end{enumerate} +\end{verbatim} +\end{quote} +starts a list whose labels run I/, II/, III/, \dots{} + +The \Package{paralist} package, whose primary purpose is % beware line break +\Qref*{compaction of lists}{Q-complist}, provides the same facilities +for its \environment{enumerate}-like environments. + +If you need non-stereotyped designs, the \Package{enumitem} package +gives you most of the flexibility you might want to design your own. +The silly roman example above could be achieved by: +\begin{quote} +\begin{verbatim} +\usepackage{enumitem} +... +\begin{enumerate}[label=\Roman{*}/] +\item ... ... +\end{enumerate} +\end{verbatim} +\end{quote} +Note that the `\texttt{*}' in the key value stands for the list +counter at this level. You can also manipulate the format of +references to list item labels: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\usepackage{enumitem} +... +\begin{enumerate}[label=\Roman{*}/, + ref=(\roman{*})] +\item ... ... +\end{enumerate} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\usepackage{enumitem} +... +\begin{enumerate}[label=\Roman{*}/, ref=(\roman{*})] +\item ... ... +\end{enumerate} +\end{verbatim} +\end{wideversion} +\end{quote} +to make references to the list items format appear as (i), (ii), +(iii), etc. + +The \Class{memoir} class includes functions that match those in the +\Package{enumerate} package, and has similar functionality for +\environment{itemize} lists. +%% It is possible (if not particularly convenient) to do the same thing +%% yourself. Suppose you want your top-level \environment{enumerate}s to +%% be labelled I/, II/, III/, \dots{}, then give these commands: +%% \begin{verbatim} +%% \renewcommand{\theenumi}{\Roman{enumi}} +%% \renewcommand{\labelenumi}{\theenumi/} +%% \end{verbatim} +%% The possible styles of numbering are given in Section~6.3 of Lamport's +%% book (see \Qref[question]{\TeX{}-related books}{Q-books}). Both +%% \csx{theenumi} and \csx{labelenumi} must be changed, since +%% \csx{theenumi} is used in cross-references to the list. +%% +%% For lower level \environment{enumerate}s, replace |enumi| by |enumii|, +%% |enumiii| or |enumiv|, according to the level. If your label is much +%% larger than the default, you should also change \csx{leftmargini}, +%% \csx{leftmarginii}, \emph{etc}. +\begin{ctanrefs} +\item[enumerate.sty]Distributed as part of \CTANref{2etools} +\item[enumitem.sty]\CTANref{enumitem} +\item[memoir.cls]\CTANref{memoir} +\item[paralist.sty]\CTANref{paralist} +\end{ctanrefs} + +\Question[Q-complist]{How to adjust list spacing} + +\Qref*{Lamport's book}{Q-books} lists various +parameters for the layout of list (things like \csx{topsep}, +\csx{itemsep} and \csx{parsep}), but fails to mention that they're set +automatically within the list itself. This happens because each list +executes a command \csx{@list}\texttt{\meta{depth}} (the depth +appearing as a lower-case roman numeral); what's more, the top-level +\csx{@listi} is usually reset when the font size is changed. As a +result, it's rather tricky for +the user to control list spacing. Of course, the real answer is to use +a document class designed with more modest list spacing, but we all +know such things are hard to come by. The \Class{memoir} class wasn't +designed for more compact lists \emph{per se}, but offers the user +control over the list spacing. + +There are packages that provide some control of list spacing, but they +seldom address the separation from surrounding text (defined by +\csx{topsep}). The \Package{expdlist} package, among its many controls +of the appearance of \environment{description} lists, offers a +compaction parameter (see the documentation); the \Package{mdwlist} +package offers a \csx{makecompactlist} command for users' own list +definitions, and uses it to define compact lists +\environment{itemize*}, \environment{enumerate*} and +\environment{description*}. In fact, you can write lists such as +these commands define pretty straightforwardly~--- for example: +\begin{quote} +\begin{verbatim} +\newenvironment{itemize*}% + {\begin{itemize}% + \setlength{\itemsep}{0pt}% + \setlength{\parskip}{0pt}}% + {\end{itemize}} +\end{verbatim} +\end{quote} +The \Package{paralist} package provides several approaches to list +compaction: +\begin{itemize} +\item its \environment{asparaenum} environment formats each item as if + it were a paragraph introduced by the enumeration label (which saves + space if the item texts are long); +\item its \environment{compactenum} environment is the same sort of + compact list as is provided in \Package{expdlist} and + \Package{mdwlist}; and +\item its \environment{inparaenum} environment produces a list ``in + the paragraph'', i.e., with no line break between items, which is a + great space-saver if the list item texts are short. +\end{itemize} +The package will manipulate its \environment{enumerate} environment +labels just like the \Qref*{\Package{enumerate} package}{Q-enumerate} +does. + +\Package{Paralist} also provides \environment{itemize} equivalents +(\environment{asparaitem}, etc.), and \environment{description} +equivalents (\environment{asparadesc}, etc.). + +The \Package{multenum} package offers a more regular form of +\Package{paralist}'s \environment{inparaenum}; you define a notional +grid on which list entries are to appear, and list items will always +appear at positions on that grid. The effect is somewhat like that of +the `tab' keys on traditional typewriters; the package was designed +for example sheets, or lists of answers in the appendices of a book. + +The ultimate in compaction (of every sort) is offered by the +\Package{savetrees} package; compaction of lists is included. The +package's prime purpose is to save space at every touch and turn: +don't use it if you're under any design constraint whatever! + +The \Package{expdlist}, \Package{mdwlist} and \Package{paralist} +packages all offer other facilities for list configuration: you should +probably not try the ``do-it-yourself'' approaches outlined below if +you need one of the packages for some other list configuration +purpose. + +For ultimate flexibility (including manipulation of \csx{topsep}), the +\Package{enumitem} package permits adjustment of list parameters using +a ``\emph{key}\latexhtml{\ensuremath{=}}{=}\meta{value}'' format. +For example, one might write +\begin{quote} +\begin{verbatim} +\usepackage{enumitem} +... +\begin{enumerate}[topsep=0pt, partopsep=0pt] +\item ... +\item ... +\end{enumerate} +\end{verbatim} +\end{quote} +to suppress all spacing above and below your list, or +\begin{quote} +\begin{verbatim} +\usepackage{enumitem} +... +\begin{enumerate}[itemsep=2pt,parsep=2pt] +\item ... +\item ... +\end{enumerate} +\end{verbatim} +\end{quote} +to set spacing between items and between paragraphs within items. +\Package{Enumitem} also permits manipulation of the label format in a +more ``basic'' (and therefore more flexible) manner than the % ! line break +\Qref*{\Package{enumerate} package}{Q-enumerate} does. +\begin{ctanrefs} +\item[enumerate.sty]Distributed as part of \CTANref{2etools} +\item[enumitem.sty]\CTANref{enumitem} +\item[expdlist.sty]\CTANref{expdlist} +\item[memoir.cls]\CTANref{memoir} +\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} +\item[multenum.sty]\CTANref{multenum} +\item[paralist.sty]\CTANref{paralist} +\item[savetrees.sty]\CTANref{savetrees} +\end{ctanrefs} + +\Question[Q-interruptlist]{Interrupting enumerated lists} + +It's often convenient to have commentary text, `outside' the list, +between successive entries of a list. In the case of +\environment{itemize} lists this is no problem, since there's never +anything to distinguish successive items, while in the case of +\environment{description} lists, the item labels are under the user's +control so there's no automatic issue of continuity. + +For \environment{enumerate} lists, the labels are generated +automatically, and are context-sensitive, so the context (in this +case, the state of the enumeration counter) needs to be preserved. + +The belt-and-braces approach is to remember the state of the +enumeration in your own counter variable, and then restore it when +restarting enumerate: +\begin{quote} +\begin{verbatim} +\newcounter{saveenum} + ... +\begin{enumerate} + ... + \setcounter{saveenum}{\value{enumi}} +\end{enumerate} +<Commentary text> +\begin{enumerate} + \setcounter{enumi}{\value{saveenum}} + ... +\end{enumerate} +\end{verbatim} +\end{quote} + +This is reasonable, in small doses\dots{} Problems (apart from sheer +verbosity) are getting the level right (``should I use counter +\texttt{enumi}, \texttt{enumii}, \dots{}'') and remembering not to +nest the interruptions (i.e., not to have a separate list, that is +itself interrupted) in the ``commentary text''). + +The \Package{mdwlist} package defines commands \csx{suspend} and +\csx{resume} that simplify the process: +\begin{quote} +\begin{verbatim} +\begin{enumerate} + ... +\suspend{enumerate} +<Commentary text> +\resume{enumerate} + ... +\end{enumerate} +\end{verbatim} +\end{quote} +The package allows an optional name (as in +\cmdinvoke{suspend}[id]{enumerate}) to allow you to identify a +particular suspension, and hence provide a handle for manipulating +nested suspensions. + +If you're suspending a \Qref*{fancy-enumeration list}{Q-enumerate}, +you need to +re-supply the optional ``item label layout'' parameters required by +the \Package{enumerate} package when resuming the list, whether by the +belt-and-braces approach, or by the \Package{mdwlist} +\cmdinvoke{resume}{enumerate} technique. The task is a little tedious +in the \Package{mdwlist} case, since the optional argument has to be +encapsulated, whole, inside an optional argument to \csx{resume}, +which requires use of extra braces: +\begin{quote} +\begin{verbatim} +\begin{enumerate}[\textbf{Item} i] + ... +\suspend{enumerate} +<comment> +\resume{enumerate}[{[\textbf{Item} i]}] +... +\end{enumerate} +\end{verbatim} +\end{quote} +\nothtml{\noindent}The \Package{enumitem} package, in its most recent +release, will also allow you to resume lists: +\begin{quote} +\begin{verbatim} +\begin{enumerate} +... +\end{enumerate} +<comment> +\begin{enumerate}[resume] +... +\end{enumerate} +\end{verbatim} +\end{quote} +which feels just as ``natural'' as the \Package{mdwtools} facility, +and has the advantage of playing well with the other excellent +facilities of \Package{enumitem}. + +\Package{Expdlist} has a neat way of providing for comments, with its +\csx{listpart} command. The command's argument becomes a comment +between items of the list: +\begin{quote} +\begin{verbatim} +\begin{enumerate} +\item item 1 +\item item 2 + \listpart{interpolated comment} +\item item 3 +\end{enumerate} +\end{verbatim} +\end{quote} +This, you will realise, means it doesn't even have to think about +suspending or resuming the list, and of course it works equally well +in any of the list environments (thought it's not actually +\emph{necessary} for any but \environment{enumerate}). + +\Package{Enumitem} also allows multi-level suspension and resumption +of lists: +\begin{quote} +\begin{verbatim} +\begin{enumerate} +\item outer item 1 +\end{enumerate} +<comment> +\begin{enumerate}[resume] +\item outer item 2 +% nested enumerate +\begin{enumerate} +\item inner item 1 +\end{enumerate} +<nested comment> +% resume nested enumerate +\begin{enumerate}[resume] +\item inner item 2 +\end{enumerate} +\item outer item 3 +% end outer enumerate +\end{enumerate} +\end{verbatim} +\end{quote} +However, the `nested comment' interpolated in the nested enumeration +appears as if it were a second paragraph to ``outer item 2'', which is +hardly satisfactory. +\begin{ctanrefs} +\item[enumerate.sty]Distributed as part of \CTANref{2etools} +\item[enumitem.sty]\CTANref{enumitem} +\item[expdlist.sty]\CTANref{expdlist} +\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} +\end{ctanrefs} + +\subsection{Tables, figures and diagrams} + +\Question[Q-destable]{The design of tables} + +In recent years, several authors have argued that the examples, set +out by Lamport in his \Qref*{\LaTeX{} manual}{Q-books}, have cramped +authors' style and have led to extremely poor table design. It is in +fact difficult even to work out what many of the examples in Lamport's +book ``mean''. + +The criticism focuses on the excessive use of rules (both horizontal +and vertical) and on the poor vertical spacing that Lamport's macros +offer. + +The problem of vertical spacing is plain for all to see, and is +addressed in several packages~--- see % beware line breaks +``\Qref*[question]{spacing of lines in tables}{Q-struttab}''. + +The argument about rules is presented in the excellent essay that +prefaces the documentation of Simon Fear's \Package{booktabs} package, +which (of course) implements Fear's scheme for `comfortable' rules. +(The same rule commands are implemented in the \Class{memoir} class.) + +Lamport's \LaTeX{} was also inflexibly wrong in ``insisting'' that +captions should come at the bottom of a table. Since a table may +extend over several pages, traditional typography places the caption +at the top of a table float. The \csx{caption} command will get its +position wrong (by \texttt{10pt}) if you simply write: +\begin{quote} +\begin{verbatim} +\begin{table} + \caption{Example table} + \begin{tabular}{...} + ... + \end{tabular} +\end{table} +\end{verbatim} +\end{quote} +The \Package{topcapt} package solves this problem: +\begin{quote} +\begin{verbatim} +\usepackage{topcapt} +... +\begin{table} + \topcaption{Example table} + \begin{tabular}{...} + ... + \end{tabular} +\end{table} +\end{verbatim} +\end{quote} +The \Class{KOMA-script} classes provide a similar command +\csx{captionabove}; they also have a class option +\pkgoption{tablecaptionabove} which arranges that \csx{caption} +\emph{means} \csx{captionabove}, in table environments. The +\Package{caption} (from the release of 23 January, 2004) may be loaded +with an option that has the same effect: +\begin{quote} +\begin{verbatim} +\usepackage[tableposition=top]{caption} +\end{verbatim} +\end{quote} + +Doing the job yourself is pretty easy: \Package{topcapt} switches the +values of the \LaTeXe{} parameters \csx{abovecaptionskip} (default +value \texttt{10pt}) and \csx{belowcaptionskip} (default value +\texttt{0pt}), so: +\begin{quote} +\begin{verbatim} +\begin{table} + \setlength{\abovecaptionskip}{0pt} + \setlength{\belowcaptionskip}{10pt} + \caption{Example table} + \begin{tabular}{...} + ... + \end{tabular} +\end{table} +\end{verbatim} +\end{quote} +does the job. (The package itself is very slightly more elaborate\dots{}) +\begin{ctanrefs} +\item[booktabs.sty]\CTANref{booktabs} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\item[topcapt.sty]\CTANref{topcapt} +\end{ctanrefs} + +\Question[Q-fixwidtab]{Fixed-width tables} + +There are two basic techniques for making fixed-width tables in +\LaTeX{}: you can make the gaps between the columns stretch, or you +can stretch particular cells in the table. + +Basic \LaTeX{} can make the gaps stretch: the \environment{tabular*} +environment takes an extra argument (before the \texttt{clpr} layout one) +which takes a length specification: you can say things like ``\texttt{15cm}'' +or ``\csx{columnwidth}'' here. You must also have an \csx{extracolsep} +command in the \texttt{clpr} layout argument, inside an \texttt{@\{\}} +directive. So, for example, one might have +\begin{wideversion} +\begin{verbatim} +\begin{tabular*}{\columnwidth}{@{\extracolsep{\fill}}lllr} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\begin{tabular*}{\columnwidth}% + {@{\extracolsep{\fill}}lllr} +\end{verbatim} +\end{narrowversion} +The \csx{extracolsep} applies to all inter-column gaps to its right as +well; if you don't want all gaps stretched, add +\cmdinvoke{extracolsep}{0pt} to cancel the original. + +The \Package{tabularx} package defines an extra \texttt{clpr} column +specification, \texttt{X}; \texttt{X} columns behave as \texttt{p} +columns which expand to fill the space available. If there's more +than one \texttt{X} column in a table, the spare space is distributed +between them. + +The \Package{tabulary} package (by the same author) provides a way of +``balancing'' the space taken by the columns of a table. The package +defines column specifications \texttt{C}, \texttt{L}, \texttt{R} and +\texttt{J}, giving, respectively, centred, left, right and +fully-justified versions of space-sharing columns. The package +examines how long each column would be ``naturally'' (i.e., on a piece of paper of unlimited width), and +allocates space to each column accordingly. There are ``sanity +checks'' so that really large entries don't cause everything else to +collapse into nothingness (there's a ``maximum width'' that any column +can exert), and so that tiny entries can't get smaller than a +specified minimum. Of course, all this work means that the package +has to typeset each row several times, so things that leave +``side-effects'' (for example, a counter used to produce a row-number +somewhere) are inevitably unreliable, and should not even be tried. + +The \Package{ltxtable} package combines the features of the +\Package{longtable} and \Package{tabularx} packages. It's important +to read the documentation, since usage is distinctly odd; the +distribution contains no more than a file \File{ltxtable.tex}, which you +should process using \LaTeX{}. Processing will give you a \File{.sty} +file as well as the \File{.dvi} or \File{.pdf} output containing the +documentation. +\begin{ctanrefs} +\item[ltxtable.sty]Distributed as part of \CTANref{carlisle} +\item[tabularx.sty]Distributed as part of \CTANref{2etools} +\item[tabulary.sty]\CTANref{tabulary} +\end{ctanrefs} + +\Question[Q-varwidcol]{Variable-width columns in tables} + +This is a slightly different take on the problem addressed in +``\Qref*[question]{fixed-width tables}{Q-fixwidtab}''~--- here we have +a column whose size we can't absolutely predict when we design the +document. + +While the basic techniques (the \Package{tabularx}, \Package{tabulary} +and \Package{ltxtable} packages) are the same for this problem as for the +fixed-width \emph{table} problem, there's one extra tool that we can +call to our aid, which may be preferable in some situations. + +Suppose we have data in one column which we read from an external +source, and the source itself isn't entirely predictable. The data in +the column may end up pretty narrow in every row of the table, or it +may be wide enough that the table would run over the edge of the page; +however, we don't want to make the column as wide as possible ``just +in case'', by defining a fixed size for the table. We would like the +column to be as small as possible, but have the possibility to spread +to a maximum width and (if even that width is exceeded) turn into a +\texttt{p}-style column. + +The \Package{varwidth} package, discussed in % ! line break +``\Qref*[question]{automatic sizing of minipages}{Q-varwidth}'', provides +a solution. If you load it together with the \LaTeX{} ``required'' +\Package{array} package, i.e.: +\begin{quote} +\begin{verbatim} +\usepackage{array} +\usepackage{varwidth} +\end{verbatim} +\end{quote} +\Package{varwidth} defines a new column-type ``\texttt{V}'', which you +can use as follows: +\begin{quote} +\begin{verbatim} +\begin{tabular}{l V{3.5cm} r} + foo & blah & bar \\ + foo & blah blah & bar \\ +\end{tabular} +\end{verbatim} +\end{quote} +when the second column ends up less than 3.5cm wide; +or you can use it as follows: +\begin{quote} +\begin{verbatim} +\begin{tabular}{l V{3.5cm} r} + foo & blah & bar \\ + foo & blah blah & bar \\ + foo & blah blah blah blah blah blah + & bar \\ +\end{tabular} +\end{verbatim} +\end{quote} +where the second column will end up noticeably wider, and will wrap to +a second line in the third row. +\begin{ctanrefs} +\item[array.sty]Distributed as part of \CTANref{2etools} +\item[varwidth.sty]\CTANref{varwidth} +\end{ctanrefs} + +\Question[Q-struttab]{Spacing lines in tables} + +\AllTeX{} mechanisms for maintaining the space between lines (the +``\emph{leading}'') rely on \TeX{}'s paragraph builder, which compares +the shape of consecutive lines and adjusts the space between them. + +These mechanisms can't work in exactly the same way when \AllTeX{} is +building a table, because the paragraph builder doesn't get to see the +lines themselves. As a result, tables sometimes typeset with lines +uncomfortably close together (or occasionally ridiculously far apart). + +Traditional (moving metal type) typographers would adjust the spacing +between lines of a table by use of a ``\emph{strut}'' (a metal +spacer). A \TeX{} user can do exactly the same thing: most macro +packages define a \csx{strut} command, that defines a space appropriate +to the current size of the text; placing a \csx{strut} command at the +end of a troublesome row is the simplest solution to the problem~--- +if it works. Other solutions below are \LaTeX{}-specific, but some +may be simply translated to \plaintex{} commands. + +If your table exhibits a systematic problem (i.e., every row is wrong +by the same amount) use \csx{extrarowheight}, which is defined by the +\Package{array} package: +\begin{quote} +\begin{verbatim} +\usepackage{array}% in the preamble +... +\setlength{\extrarowheight}{length} +\begin{tabular}{....} +\end{verbatim} +\end{quote} + +To correct a single row whose maladjustment isn't corrected by a +\csx{strut} command, you can define your own, using +\cmdinvoke{rule}{0pt}{length}~--- which is a near approximation to the +command that goes inside a \csx{strut}. The \Package{bigstrut} package +defines a strut command that you can use for this purpose: +\csx{bigstrut} on its own opens up both above and below the current +line; \cmdinvoke{bigstrut}[t] opens up above the line, +\cmdinvoke{bigstrut}[b] opens up below the line. + +General solutions are available, however. The \Package{tabls} package +automatically generates an appropriately-sized strut at the end of +each row. Its disadvantages are that it's really rather slow in +operation (since it gets in the way of everything within tables) and +its (lack of) compatibility with other packages. + +The \Package{cellspace} package does a (possibly inferior) job by +defining a new table/array column type ``S'', which you apply to each +column specification. So, for example, +\begin{quote} +\begin{verbatim} +\cmdinvoke{begin}{tabular}{l l l p{3cm}} +\end{verbatim} +\end{quote} +would become +\begin{quote} +\begin{verbatim} +\cmdinvoke{begin}{tabular}{Sl Sl Sl Sp{3cm}} +\end{verbatim} +\end{quote} +and so on. This technique shows +promise of not interfering so much with other packages, but this +author has heard of no reports from the field. + +The \Package{booktabs} package comes with a thought-provoking essay +about how tables should be designed. Since table row-spacing problems +most often appear in collisions with rules, the author's thesis, +that \LaTeX{} users tend too often to rule their tables, is +interesting. The package provides rule commands to support the +author's scheme, but deals with inter-row spacing too. The most +recent release of \Package{booktabs} sports compatibility with +packages such as \Package{longtable}. + +Documentation of both \Package{bigstrut} and \Package{tabls} may be +found as comments in the package files themselves. +\begin{ctanrefs} +\item[array.sty]Distributed as part of \CTANref{2etools} +\item[bigstrut.sty]Distributed as part of \CTANref{multirow} +\item[booktabs.sty]\CTANref{booktabs} +\item[cellspace.sty]\CTANref{cellspace} +\item[tabls.sty]\CTANref{tabls} +\end{ctanrefs} + +\Question[Q-longtab]{Tables longer than a single page} + +Tables are, by default, set entirely in boxes of their own: as a +result, they won't split over a page boundary. Sadly, the world keeps +turning up tables longer than a single page that we need to typeset. + +For simple tables (whose shape is highly regular), the simplest +solution may well be to use the \environment{tabbing} environment, +which is slightly tedious to set up, but which doesn't force the whole alignment +onto a single page. + +The \Package{longtable} package builds the whole table (in chunks), in +a first pass, and then uses information it has written to the \extension{aux} +file during later passes to get the setting ``right'' (the package +ordinarily manages to set tables in just two passes). Since the +package has overview of the whole table at the time it's doing +``final'' setting, the table is set ``uniformly'' over its entire +length, with columns matching on consecutive pages. +\Package{longtable} has a reputation for failing to interwork with +other packages, but it does work with \Package{colortbl}, and its +author has provided the \Package{ltxtable} package to provide (most +of) the facilities of \Package{tabularx} (see +% beware line wrap +\Qref[question]{fixed-width tables}{Q-fixwidtab}) for long tables: +beware of its rather curious usage constraints~--- each long table +should be in a file of its own, and included by +\cmdinvoke*{LTXtable}{width}{file}. Since \Package{longtable}'s +multiple-page tables can't possibly live inside floats, the package +provides for captions within the \environment{longtable} environment +itself. + +A seeming alternative to \Package{ltxtable} is \Package{ltablex}; but +it is outdated and not fully functional. Its worst problem is its +strictly limited memory capacity (\Package{longtable} is not so +limited, at the cost of much complication in its code); +\Package{ltablex} can only deal with relatively small tables, it doesn't seem +likely that support is available; but its user interface is much +simpler than \Package{ltxtable}, so if its restrictions aren't a +problem for you, it may be worth a try. + +The \Package{supertabular} package starts and stops a +\environment{tabular} environment for each page of the table. As a +result, each `page worth' of the table is compiled independently, and +the widths of corresponding columns may differ on successive pages. +However, if the correspondence doesn't matter, or if your columns are +fixed-width, \Package{supertabular} has the great advantage of doing +its job in a single run. + +Both \Package{longtable} and \Package{supertabular} allow definition +of head- and footlines for the table; \Package{longtable} allows +distinction of the first and last head and foot. + +The \Package{xtab} package fixes some infelicities of +\Package{supertabular}, and also provides a ``last head'' facility +(though this, of course, destroys \Package{supertabular}'s advantage +of operating in a single run). + +The \Package{stabular} package provides a simple-to-use ``extension to +\environment{tabular}'' that allows it to typeset tables that run over +the end of a page; it also has usability extensions, but doesn't have +the head- and footline capabilities of the major packages. + +Documentation of \Package{ltablex} is to be found in the package file. +\begin{ctanrefs} +\item[longtable.sty]Distributed as part of \CTANref{2etools} +\item[ltablex.sty]\CTANref{ltablex} +\item[ltxtable.sty]Generate by running \CTANref{ltxtable} +\item[stabular.sty]Distributed as part of \CTANref{sttools} +\item[supertabular.sty]\CTANref{supertabular} +\item[xtab.sty]\CTANref{xtab} +\end{ctanrefs} + +\Question[Q-tabcellalign]{How to alter the alignment of tabular cells} + +One often needs to alter the alignment of a tabular \texttt{p} (`paragraph') +cell, but problems at the end of a table row are common. With a +\texttt{p} cell that looks like: +\begin{quote} +\begin{verbatim} +... & \centering blah ... \\ +\end{verbatim} +\end{quote} +one is liable to encounter errors that complain about a ``misplaced +\csx{noalign}'' or ``\Qref*{extra alignment tab}{Q-altabcr}'', or the like. +The problem is that the command \texttt{\bsbs } means different things in +different circumstances: the \environment{tabular} environment +switches the meaning to a value for use in the table, and +\csx{centering}, \csx{raggedright} and \csx{raggedleft} all change the +meaning to something incompatible. Note that the problem only +arises in the last cell of a row: since each cell is set into a box, +its settings are lost at the \texttt{\&} (or \texttt{\bsbs }) that +terminates it. + + +The technique using \csx{PBS} was developed in the days of \LaTeXo{} +because the actual value of \texttt{\bsbs } that the \environment{tabular} +environment uses was only available as an internal command. Nowadays, +the value is a public command, and you can in principle use it +explicitly: +\begin{quote} +\begin{verbatim} +... & \centering blah ... \tabularnewline +\end{verbatim} +\end{quote} + +The \Package{array} package provides a command \csx{arraybackslash} +which restores \texttt{\bsbs } to its correct (within table) meaning; +the command may be used in \Package{array}'s ``field format'' preamble +specifications: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\begin{tabular}{...% + >{\centering\arraybackslash}% + p{50mm}} +... +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\begin{tabular}{... >{\centering\arraybackslash}p{50mm}} +... +\end{verbatim} +\end{wideversion} +\end{quote} + +The \csx{tabularnewline} and \csx{arraybackslash} commands are +(somewhat) modern additions to \LaTeX{} and the \Package{array} +package, respectively. If neither is available, the user may try the +(old) solution which preserves the meaning of \texttt{\bsbs }: +\begin{quote} +\begin{verbatim} +\newcommand\PBS[1]{\let\temp=\\% + #1% + \let\\=\temp +} +\end{verbatim} +\end{quote} +which one uses within a table as: +\begin{quote} +\begin{verbatim} +... & \PBS\centering blah ... \\ +\end{verbatim} +\end{quote} +or in the preamble as: +\begin{quote} +\begin{verbatim} +\begin{tabular}{...>{\PBS\centering}p{5cm}} +\end{verbatim} +\end{quote} +\begin{ctanrefs} +\item[array.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} +\nothtml{\vskip 0pt plus 4ex} + +\Question[Q-rulethk]{The thickness of rules in \LaTeX{} tables} + +The rules in a \LaTeX{} table are by default \texttt{0.4pt} thick; +this is in fact a default built in at the lowest level, and applies to +all rules (including those separating blocks of running text). + +Sometimes, however, we look at a table and find we want the rules to +stand out~--- perhaps to separate the text from the rest of the body +text, or to make the sections of the table stand out from one another. +However, a quick review of any \LaTeX{} manual will reveal no +technique for making any one rule stand out, and a little +experimentation shows that it is indeed pretty difficult to prevent +a change ``bleeding'' out to affect other rules in the same table. + +If you look at what we have to say on the % ! line break +\Qref*{design of tables}{Q-destable}, elsewhere +among these \acro{FAQ}s, and you may sense that the design of \LaTeX{} +simply skipped the issues surrounding table design: \emph{that's} +presumably why there's no facilities to help you. + +Specifically, the length \csx{arrayrulewidth} affects the thickness of +the rules (both horizontal and vertical) within both +\environment{tabular} and \environment{array} environments. If you +change from the default (see above) only as far as +\begin{quote} +\begin{verbatim} +\setlength{\arrayrulewidth}{1pt} +\end{verbatim} +\end{quote} +the change is remarkably striking. However, really quite subtle user +level programming proves incapable of changing just \emph{one} rule: +it's necessary to delve into the (rather tricky) code of \csx{hline} +and \csx{cline} themselves. + +Fortunately, this job has already been done for the community: the +\Package{booktabs} package defines three different classes of rule +(\csx{toprule}, \csx{midrule} and \csx{bottomrule}), and the package +documentation offers hints on how to use them. You are +\emph{strongly} advised to read the documentation pretty carefully. + +The \Class{memoir} class includes the \Package{booktabs} package, and +repeats the documentation in its compendious manual. + +Note that none of the above mentions the issue of the weight of +vertical rules (except in passing). For the reasons, see the +documentation of the \Package{booktabs} package (again); vertical +rules in tables are in any case even more trickily coded than are +horizontal rules, and if their lack of configurability makes them +still less attractive, so much the better for the design of your +document. +\begin{ctanrefs} +\item[booktabs.sty]\CTANref{booktabs} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-textflow]{Flowing text around figures} + +There are several \LaTeX{} packages that purport to do this, but they +all have their limitations because the \TeX{} machine isn't really +designed to solve this sort of problem. Piet van Oostrum has +conducted a survey of the available packages; he recommends: +\begin{description} +\item[\texttt{floatflt}] \Package{floatflt} is an improved version + (for \LaTeXe{}) of \File{floatfig.sty}, and its syntax is: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\begin{floatingfigure}[options]{width of figure} + figure contents +\end{floatingfigure} +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} + \begin{quote} + \cmdinvoke{begin}{floatingfigure}[\emph{options}]{\emph{figure width}}\\ + \mbox{}\qquad\emph{figure contents}\\ + \cmdinvoke{end}{floatingfigure} + \end{quote} +\end{narrowversion} +There is a (more or less similar) \environment{floatingtable} +environment. + +The tables or figures can be set left or right, or alternating on +even/odd pages in a double-sided document. + +The package works with the \texttt{multicol} package, but doesn't work well +in the neighbourhood of list environments (unless you change your +\LaTeX{} document). +\item[\texttt{wrapfig}] \Package{wrapfig} has syntax: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\begin{wrapfigure}[height of figure in lines]{l,r,...}[overhang]{width} + figure, caption, etc. +\end{wrapfigure} +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} + \begin{quote} + \cmdinvoke{begin}{wrapfigure}\texttt{\%}\\ + \mbox{}% + \qquad\qquad\texttt{[\emph{figure height in lines}]\%}\\ + \mbox{}% + \qquad\qquad\texttt{\{l,r,\emph{etc}\}[\emph{overhang}]\{\emph{width}\}}\\ + \mbox{}\qquad\emph{figure, caption, etc.}\\ + \cmdinvoke{end}{wrapfigure} + \end{quote} +\end{narrowversion} + The syntax of the \environment{wraptable} environment is similar. + + Height can be omitted, in which case it will be calculated by the + package; the package will use the greater of the specified and the + actual width. The \texttt{\{l,r,\emph{etc}.\}} parameter may + also be specified as \texttt{i}\emph{(nside)} or + \texttt{o}\emph{(utside)} for two-sided documents, and uppercase + may be used to indicate that the picture should float. The + overhang allows the figure to be + moved into the margin. The figure or table will entered into the + list of figures or tables if you use the \csx{caption} command. + + The environments do not work within list environments that end + before the figure or table has finished, but can be used in a + parbox or minipage, and in twocolumn format. + \item[\texttt{picins}] \Package{Picins} is part of a large bundle + that allows inclusion of pictures (e.g., with shadow boxes, + various \MSDOS{} formats, etc.). The command for inserting a + picture at the start of a paragraph is: +\begin{wideversion} + \begin{quote} + \csx{parpic}\texttt{(width,height)(x-off,y-off)[Options][Position]\{Picture\}}\\ + \emph{Paragraph text} + \end{quote} +\end{wideversion} +\begin{narrowversion} + \begin{quote} + \cmdinvoke*{picins}(width,height)(x-off,y-off)\texttt{\%}\\ + \mbox{\qquad\qquad}\texttt{[\emph{options}][\emph{position}]\%}\\ + \mbox{\qquad\qquad}\texttt{\{\emph{Picture}\}}\\ + \emph{Paragraph text} + \end{quote} +\end{narrowversion} + All parameters except the \emph{Picture} are optional. The picture + can be positioned left or right, boxed with a rectangle, oval, + shadowbox, dashed box, and a caption can be given which will be + included in the list of figures. + + Unfortunately (for those of us whose understanding of German is not + good), the documentation is in German. Piet van Oostrum has written + a summary in English. +\end{description} +\plaintex{} users only have one option: \Package{figflow} (which +doesn't work in \LaTeX{}). \Package{Figflow} only offers flowed +figures at the start of the paragraph, but it seems perfectly +functional. Syntax is +\begin{quote} + \cmdinvoke*{figflow}{\meta{width}}{\meta{height}}{\meta{figure}} +\end{quote} +(the user is responsible for having the dimensions correct, and for +ensuring the figure fits on the page). +\begin{ctanrefs} +\item[figflow.tex]\CTANref{figflow} +\item[floatflt.sty]\CTANref{floatflt} +\item[picins.sty]\CTANref{picins} +\item[picins \nothtml{\rmfamily}documentation summary]\CTANref{picins-summary} +\item[wrapfig.sty]\CTANref{wrapfig} +\end{ctanrefs} +\LastEdit{2009-06-11} + +\Question[Q-slashbox]{Diagonal separation in corner cells of tables} +\keywords{tabular} + +You want to label both the top or bottom row and the left- or +rightmost column, somewhere at the corner of the table where the row +and column meet. A simple way to achieve the result is to construct +the table with an arrangement of rules (and possibly \csx{multicolumn} +entries), to look like: +\begin{quote} +\begin{verbatim} +----------------- +x y + -------------- + 1 2 3 4 5 +----------------- +1 +2 +3 +4 +5 +----------------- +\end{verbatim} +\end{quote} +However, this doesn't satisfy everyone: many want the labelling in a +single cell at the top left of the table. It sounds a simple enough +requirement, yet it calls for some slightly tricky \LaTeX{} coding. +The \Package{slashbox} package does the job for you: it defines +commands \csx{slashbox} and \csx{backslashbox}, each taking the two +labels as arguments. It draws a picture with the two labels on either +side of a slanting line; the command (and hence the picture) may be +placed in the corner cell, where the labelled row and column meet. + +The package isn't the world's neatest: it uses \LaTeX{} +\environment{picture} mode to draw its line, and picture mode has many +tedious restrictions (and doesn't, in all honesty, produce +particularly good pictures). Load slashbox with the \Package{pict2e} +package, and at least the picture quality will be improved. + +Documentation of \Package{slashbox} is less than satisfactory: a +\LaTeX{} source file of rather startling starkness accompanies the +package file in the distribution. It does, however, process to a +\acro{DVI} file that gives some idea of how the \csx{slashbox} may be +expected to look. (The third example in the file shows the effect of +\environment{picture} mode's restrictions: the dividing line doesn't +go from corner to corner in the box: to correct this requires revision +of \Package{slashbox}~--- \Package{pict2e} alone doesn't help in this +regard.) +\begin{ctanrefs} +\item[slashbox.sty]\CTANref{slashbox} +\end{ctanrefs} + +\Question[Q-wholerow]{How to change a whole row of a table} + +Each cell of a table is set in a box, so that a change of font style +(or whatever) only lasts to the end of the cell. If one has a +many-celled table, or a long one which needs lots of rows emphasising, +putting a font style change command in every cell will be impossibly +tedious. + +With the \Package{array} package, you can define column modifiers +which will change the font style for a whole \emph{column}. However, +with a bit of subtlety, one can make such modifiers affect rows rather +than columns. So, we set things up by: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\usepackage{array} +\newcolumntype{$}{>{% + \global\let\currentrowstyle\relax}% +} +\newcolumntype{^}{>{\currentrowstyle}} +\newcommand{\rowstyle}[1]{% + \gdef\currentrowstyle{#1}% + #1\ignorespaces +} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\usepackage{array} +\newcolumntype{$}{>{\global\let\currentrowstyle\relax}} +\newcolumntype{^}{>{\currentrowstyle}} +\newcommand{\rowstyle}[1]{\gdef\currentrowstyle{#1}% + #1\ignorespaces +} +\end{verbatim} +\end{wideversion} +\end{quote} +Now, we put `\texttt{\$}' before the first column specifier; and we +put `\texttt{\textasciicircum{}}' +before the modifiers of subsequent ones. We then use \csx{rowstyle} at +the start of each row we want to modify: +\begin{quote} +\begin{verbatim} +\begin{tabular}{|$l|^l|^l|} \hline + \rowstyle{\bfseries} + Heading & Big and & Bold \\ \hline + Meek & mild & entry \\ + Meek & mild & entry \\ + \rowstyle{\itshape} + Strange & and & italic \\ + Meek & mild & entry \\ \hline +\end{tabular} +\end{verbatim} +\end{quote} +The \Package{array} package works with several other +\environment{tabular}-like environments from other packages (for +example \environment{longtable}), but unfortunately this trick won't +always work. +\begin{ctanrefs} +\item[array.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-multirow]{Merging cells in a column of a table} + +It's easy to come up with a table design that requires a cell that +spans several rows. An example is something where the left-most +column labels the rest of the table; this can be done (in simple +cases) by using % beware line break +\Qref*{diagonal separation in corner cells}{Q-slashbox}, but that +technique rather strictly limits what can be used as the content of +the cell. + +The \Package{multirow} package enables you to construct such multi-row +cells, in a very simple manner. For the simplest possible use, one +might write: +\begin{quote} +\begin{verbatim} +\begin{tabular}{|c|c|} +\hline +\multirow{4}{*}{Common g text} + & Column g2a\\ + & Column g2b \\ + & Column g2c \\ + & Column g2d \\ +\hline +\end{tabular} +\end{verbatim} +\end{quote} +and \Package{multirow} will position ``Common g text'' at the vertical +centre of the space defined by the other rows. Note that the rows +that don't contain the ``multi-row'' specification must have empty +cells where the multi-row is going to appear. + +The ``\texttt{*}'' may be replaced by a column width specification. In this +case, the argument may contain forced line-breaks: +\begin{quote} +\begin{verbatim} +\begin{tabular}{|c|c|} +\hline +\multirow{4}{25mm}{Common\\g text} + & Column g2a\\ + & Column g2b \\ + & Column g2c \\ + & Column g2d \\ +\hline +\end{tabular} +\end{verbatim} +\end{quote} +A similar effect (with the possibility of a little more +sophistication) may be achieved by putting a smaller table that lines +up the text into a \texttt{*}-declared \csx{multirow}. + +The \csx{multirow} command may also used to write labels vertically +down one or other side of a table (with the help of the +\Package{graphics} or \Package{graphicx} package, which provide the +\csx{rotatebox} command): +\begin{quote} +\begin{verbatim} +\begin{tabular}{|l|l|} +\hline +\multirow{4}{*}{\rotatebox{90}{hi there}} + & Column g2a\\ + & Column g2b \\ + & Column g2c \\ + & Column g2d \\ +\hline +\end{tabular} +\end{verbatim} +\end{quote} +(which gives text going upwards; use angle \texttt{-90} for text going +downwards, of course). + +To make a \csx{multicolumn} multi-row ``cell'' in a table, you have to +enclose a \csx{multirow} inside a \csx{multicolumn}~--- the other way +around does not work, so: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\begin{tabular}{|c|c|c|}\hline +\multicolumn{2}{|c|}{\multirow{2}{*}{combined cells}} + &top right\\ \cline{3-3} +\multicolumn{2}{|c|}{} + &middle right\\ \hline +bottom left + &bottom center + &bottom right\\ \hline +\end{tabular} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\begin{tabular}{|c|c|c|}\hline +\multicolumn{2}{|c|}{\multirow{2}{*}% + {combined cells}} + &top right\\ \cline{3-3} +\multicolumn{2}{|c|}{} + &middle right\\ \hline +bottom left + &bottom center + &bottom right\\ \hline +\end{tabular} +\end{verbatim} +\end{narrowversion} +\end{quote} +\Package{Multirow} is set up to interact with the \Package{bigstrut} +package (which is also discussed in the answer to % beware line break +\Qref[question]{spacing lines in tables}{Q-struttab}). You use an +optional argument to the \csx{multirow} command to say how many of the +rows in the multi-row have been opened up with \csx{bigstrut}. + +The documentation of both \Package{multirow} and \Package{bigstrut} is +to be found, as comments, in the package files themselves. +\begin{ctanrefs} +\item[bigstrut.sty]Distributed as part of \CTANref{multirow} +\item[multirow.sty]\CTANref{multirow} +\end{ctanrefs} + +\subsection{Floating tables, figures, etc.} + +\Question[Q-floatpages]{Floats on their own on float pages} + +It's sometimes necessary to force a float to live on a page by itself. +(It's sometimes even necessary for \emph{every} float to live on a +page by itself.) When the float fails to `set', and waits for the end +of a chapter or of the document, the natural thing to do is to declare +the float as +\begin{quote} + \cmdinvoke{begin}{figure}[p!] +\end{quote} +but the overriding \texttt{!} modifier has no effect on float page floats; so +you have to make the float satisfy the parameters. +\Qref[Question]{Moving tables and figures}{Q-floats} offers some +suggestions, but doesn't solve the one-float-per-page question. + +The `obvious' solution, using the counter \texttt{totalnumber} +(``total number of floats per page'') doesn't work: +\texttt{totalnumber} only applies to floats on `text' pages (pages +containing text as well as one or more float). So, to allow any +size float to take a whole page, set \csx{floatpagefraction} really +small, and to ensure that no more than one float occupies a page, make +the separation between floats really big: +\begin{quote} +\begin{verbatim} +\renewcommand\floatpagefraction{.001} +\makeatletter +\setlength\@fpsep{\textheight} +\makeatother +\end{verbatim} +\end{quote} + +\Question[Q-vertspacefloat]{Extra vertical space in floats} + +A common complaint is that extra vertical space has crept into +\environment{figure} or \environment{table} floating environments. +More common still are users who post code that introduces this extra +space, and \emph{haven't noticed the problem}! + +The trouble arises from the fact that the \environment{center} +environment (and its siblings \environment{flushleft} and +\environment{flushright}) are actually based on \LaTeX{}'s +list-handling code; and lists always separate themselves from the +material around them. Meanwhile, there are parameters provided to +adjust the spacing between floating environments and their +surroundings; so if we have: +\begin{quote} +\begin{verbatim} +\begin{figure} + \begin{center} + \includegraphics{...} + \caption{...} + \end{center} +\end{figure} +\end{verbatim} +\end{quote} +\nothtml{\noindent}or worse still: +\begin{quote} +\begin{verbatim} +\begin{figure} + \begin{center} + \includegraphics{...} + \end{center} + \caption{...} +\end{figure} +\end{verbatim} +\end{quote} +unwarranted vertical space is going to appear. + +The solution is to let the float and the objects in it position +themselves, and to use ``generic'' layout commands rather than their +list-based encapsulations. +\begin{quote} +\begin{verbatim} +\begin{figure} + \centering + \includegraphics{...} + \caption{...} +\end{figure} +\end{verbatim} +\end{quote} +(which even involves less typing). + +This alternative code will work with any \LaTeX{} package. It will +not work with obsolete (pre-\LaTeXe{}) packages such as +\Package{psfig} or \Package{epsf}~--- see % beware line break +\Qref[question]{graphics inclusion}{Q-impgraph} for discussion of the +genesis of \csx{includegraphics}. + +\Question[Q-wideflt]{Centring a very wide figure or table} + +The normal means of centring a figure or table object is to include +\csx{centering} at the top of the float. This doesn't help if the +object is wider than \csx{textwidth}~--- the object starts at the left +margin and juts out into the right margin (which is actually doubly +unsatisfactory, since as well as looking bad, the float won't be +placed until the next \csx{clearpage} or the like.) + +You can avoid the problem by rescaling the figure or table to fit, but +this is often not satisfactory, for several reasons. + +Otherwise, if the object is wider than the printable area of the page, +you've no choice other than to \Qref*{rotate it}{Q-landscape}. If, +however, the object is \emph{just} wider than the text block, you can +make it pretend to be the right size by: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\begin{figure} + \noindent + \makebox[\textwidth]{\includegraphics{my-wide-figure}}% + \caption{This figure juts out into both margins} +\end{figure} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\begin{figure} + \noindent + \makebox[\textwidth]{% + \includegraphics{my-wide-figure}% + }% + \caption{This figure juts out into both margins} +\end{figure} +\end{verbatim} +\end{narrowversion} +\end{quote} +Note the \csx{noindent}: the \csx{makebox} starts a paragraph, and you +really don't want that indented by \csx{parindent}. + +\Question[Q-2colfloat]{Placing two-column floats at bottom of page} + +You specified placement `\texttt{[htbp]}' for your full-width figure or +table, but they always get placed at the top of the page\dots{} Well, +it \emph{is} what the documentation says: \LaTeX{}, unadorned, only +allows full-width floats at the top of a page, or occupying (part of) a +float page. + +The \Package{stfloats} package ameliorates the situation somewhat, and +makes \LaTeX{} honour `[b]' placement as well; the +\Package{dblfloatfix} package combines a tidied version of the changes +made in \Package{stfloats} with the +\begin{narrowversion} % non-hyper + float ordering corrections defined in \Package{fixltx2e} + (\Qref{}{Q-2colfltorder}). +\end{narrowversion} +\begin{wideversion} % hyper + \Qref{float ordering corrections}{Q-2colfltorder} defined in + \Package{fixltx2e}. +\end{wideversion} + +A particular problem with \Package{stfloats} and \Package{dblfloatfix} +is that the float will appear, at its earliest, on the page after it +is specified. This has two undesirable side-effects: first, there may +be no bottom float on the first page of a document, and second, float +numbers may become ``entangled'' (particularly if you're using +\Package{dblfloatfix} that ensures that the early-specified bottom +float is set \emph{before} any single column floats). + +(The \acro{FAQ} team doesn't know of any package that will make +\LaTeX{} honour `[h]' placement of double-column floats, but the +\Package{midfloat} package can be pressed into service to provide +something approximating the effect it would have.) +\begin{ctanrefs} +\item[dblfloatfix.sty]\CTANref{dblfloatfix} +\item[stfloats.sty, midfloat.sty]Distributed as part of + \CTANref{sttools} +\end{ctanrefs} + +\Question[Q-mcfloat]{Floats in multicolumn setting} + +If you use +\begin{quote} +\begin{verbatim} +\begin{figure} + ... +\end{figure} +\end{verbatim} +\end{quote} +in a \environment{multicols} environment, the figure won't appear. If +instead you use +\begin{quote} +\begin{verbatim} +\begin{figure*} + ... +\end{figure*} +\end{verbatim} +\end{quote} +the figure will stretch right across the page (just the same as a +\environment{figure*} in standard \LaTeX{}'s \pkgoption{twocolumn} option). + +It's possible to have single-column figures and tables with captions, +using the `\texttt{[H]}' placement option introduced by the \Package{float} +package but you might have to fiddle with the placement because they +won't `float', and exhibit other strange behaviours (such as silently +running off the end of the column at the end of the +\environment{multicols} environment). +\begin{ctanrefs} +\item[float.sty]\CTANref{float} +\item[multicol.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-dpfloat]{Facing floats on 2-page spread} + +If a pair of floats are to be forced to form a 2-page spread (in a +book, or whatever), the first must lie on the left side of the spread, +on an even-numbered page. The \Package{dpfloat} package provides for +this: the construction to use is: +\begin{quote} +\begin{verbatim} +\begin{figure}[p] + \begin{leftfullpage} + <left side figure> + \end{leftfullpage} +\end{figure} +\begin{figure}[p] + \begin{fullpage} + <right side figure> + \end{fullpage} +\end{figure} +\end{verbatim} +\end{quote} +The construction has no effect unless the standard class option +\pkgoption{twoside} is in effect. + +Full documentation of the package (such as it is) is to be found in +\File{README.dpfloat} +\begin{ctanrefs} +\item[dpfloat.sty]\CTANref{dpfloat} +\end{ctanrefs} + +\Question[Q-vertposfp]{Vertical layout of float pages} + +By default, \LaTeX{} vertically centres the floats on a float page; +the present author is not alone in not liking this arrangement. +Unfortunately, the control of the positioning is ``buried'' in +\LaTeX{}-internal commands, so some care is needed to change the +layout. + +Float pages use three \LaTeX{} lengths (i.e., \TeX{} skips) to define +their layout: +\begin{description} +\item[\nothtml{\normalfont}\csx{@fptop}] defines the distance from the + top of the page to the top of the first float, +\item[\nothtml{\normalfont}\csx{@fpsep}] defines the separation between + floats, and +\item[\nothtml{\normalfont}\csx{@fpbot}] defines the distance from the + bottom of the last float on the page to the bottom of the page. +\end{description} +(In fact, the output routine places a skip of \csx{@fpsep} above each float, so +the \csx{@fptop} skip is always followed by a correction for that.) + + +The \LaTeX{} defaults are: +\begin{quote} + \csx{@fptop} = \texttt{0pt + 1fil}\\ + \csx{@fpsep} = \texttt{8pt + 2fil}\\ + \csx{@fpbot} = \texttt{0pt + 1fil}\\ +\end{quote} +so that the gaps expand to fill the space not occupied by floats, but +if there is more than one float on the page, the gap between them will +expand to twice the space at top and bottom. + +Those who understand this stuff will be able to play elaborate games, +but the commonest requirement, that the floats start at the top of the +page, is a simple thing to do: +\begin{quote} +\begin{verbatim} +\makeatletter +\setlength{\@fptop}{0pt} +\makeatother +\end{verbatim} +\end{quote} +Surprisingly, you may find this setting leaves your floats too high on +the page. One can justify a value of \texttt{5pt} (in place of +\texttt{0pt})~--- it's roughly the difference between \csx{topskip} +and the height of normal (\texttt{10pt}) text. + +Note that this is a ``global'' setting (best established in a class +file, or at worst in the document preamble); making the change for a +single float page is likely (at the least) to be rather tricky. + +\Question[Q-figurehere]{Figure (or table) \emph{exactly} where I want it} + +This is of course a contradiction: \environment{figure} and +\environment{table} are \emph{designed} to float, and will always have +the potential to appear away from where you asked for them. Therefore +you have to find a means of getting the caption and other effects +without allowing the figure or table to float. + +The most straightforward way is to use the \Package{float} package; it +gives you a \texttt{[H]} float placement option that prevents +floating: +\begin{quote} +\begin{verbatim} +\begin{figure}[H] + \centering + \includegraphics{foo} + \caption{caption text} + \label{fig:nonfloat} +\end{figure} +\end{verbatim} +\end{quote} +As the example shows, these \texttt{[H]} figures (and correspondingly, +tables) offer all you need to cross-reference as well as typeset. + +However, you don't actually \emph{have} to use \Package{float} since +it is, in fact, doing rather little for you. You can place your +figure as you please, with a sequence like +\begin{quote} +\begin{verbatim} +\begin{center} + \includegraphics{foo} + \captionof{figure}{caption text} + \label{fig:nonfloat} +\end{center} +\end{verbatim} +\end{quote} +which relies on the \csx{captionof} command to place a caption in +ordinary running text. That command may be had from the extremely +simple-minded package \Package{capt-of} or from the highly +sophisticated \Package{caption} package. + +Using either method, you have to deal with the possibility of the +figure or table being too large for the page. (Floating objects will +float away in this circumstance; ``doing it by hand'', like this, you +take upon yourself the responsibility for avoiding % ! line break +`\textit{Overfull \csx{vbox}}' errors. + +A further problem is the possibility that such ``fixed floats'' will +overtake ``real floats'', so that the numbers of figures will be out +of order: figure 6 could be on page 12, while figure 5 had floated to +page 13. It's best, therefore, either to stay with floating figures +throughout a document, or to use fixed figures throughout. + +If it's really impossible to follow that counsel of perfection, you +can use the \Package{perpage} package's command \csx{MakeSorted} +command: +\begin{quote} +\begin{verbatim} +... +\usepackage{float} +\usepackage{perpage} +\MakeSorted{figure} +\MakeSorted{table} +... +\end{verbatim} +\end{quote} +and the sequence of float numbers is all correct. +\begin{ctanrefs} +\item[capt-of.sty]\CTANref{capt-of} +\item[caption.sty]\CTANref{caption} +\item[float.sty]\CTANref{float} +\item[perpage.sty]Distributed as part \CTANref{bigfoot} +\end{ctanrefs} + +\subsection{Footnotes} + +\Question[Q-footintab]{Footnotes in tables} + +The standard \LaTeX{} \csx{footnote} command doesn't work in tables; the table +traps the footnotes and they can't escape to the bottom of the page. + +If your table is floating, your best bet is (unfortunately) to put the +table in a \environment{minipage} environment and to put the notes +underneath the table, or to use Donald Arseneau's package +\Package{threeparttable} (which implements ``table notes'' proper). + +The \Package{ctable} package extends the model of +\Package{threeparttable}, and also uses the ideas of the +\Package{booktabs} package. The \csx{ctable} command does the complete +job of setting the table, placing the caption, and defining the +notes. The ``table'' may consist of diagrams, and a parameter in +\csx{ctable}'s optional argument makes the float that is created a +``figure'' rather than a ``table''. + +Otherwise, if your table is not floating (it's just a +`\texttt{tabular}' in the middle of some text), there are several +things you can do to fix the problem. +\begin{itemize} +\item Use \csx{footnotemark} to position the little marker + appropriately, and then put in \csx{footnotetext} commands to fill in + the text once you've closed the \environment{tabular} environment. + This is described in Lamport's book, but it gets messy if there's + more than one footnote. +\item Stick the table in a \texttt{minipage} anyway. This provides all the + ugliness of footnotes in a minipage with no extra effort. +\item Use \Package{threeparttable} anyway; the package is intended for + floating tables, and the result might look odd if the table is not + floating, but it will be reasonable. +\item Use \Package{tabularx} or \Package{longtable} from the \LaTeX{} + tools distribution; they're noticeably less efficient than the + standard \environment{tabular} environment, but they do allow + footnotes. +\item Use \Package{footnote}, which provides an + \environment{savenotes} which collects all footnotes and emits them + at the end of the environment; thus if you put your + \environment{tabular} environment inside the environment, the + footnotes will appear as needed. Alternatively, you may use + \cmdinvoke{makesavenoteenv}{tabular} in the preamble of your + document, and tables will all behave as if they were inside a + \environment{savenotes} environment. +\item Use \Package{mdwtab} from the same bundle; it will handle + footnotes properly, and has other facilities to increase the beauty + of your tables. Unfortunately, it may be incompatible with other + table-related packages, though not those in the standard `tools' + bundle. +\end{itemize} + +The documentation of \Package{threeparttable} appears in the package +file itself; that of \Package{ctable} is distributed as a \acro{PDF} +file (for convenience's sake). +\begin{ctanrefs} +\item[ctable.sty]\CTANref{ctable} +\item[footnote.sty]Distributed as part of \CTANref{mdwtools} +\item[longtable.sty]Distributed as part of \CTANref{2etools} +\item[mdwtab.sty]Distributed as part of \CTANref{mdwtools} +\item[threeparttable.sty]\CTANref{threeparttable} +\item[tabularx.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-ftnsect]{Footnotes in \LaTeX{} section headings} + +The \csx{footnote} command is fragile, so that simply placing the +command in \csx{section}'s arguments isn't satisfactory. Using +\csx{protect}\csx{footnote} isn't a good idea either: the arguments of a +section command are used in the table of contents and (more +dangerously) potentially also in page headers. While footnotes will +work in the table of contents, it's generally not thought a ``good +thing'' to have them there; in the page header, footnotes will simply +fail. Whatever the desirability of the matter, there's no mechanism +to suppress the footnote in the page header while allowing it in the table +of contents, so the footnote may only appear in the section heading itself. + +To suppress the footnote in headings and table of contents: +\begin{itemize} +\item Take advantage of the fact that the mandatory argument doesn't + `move' if the optional argument is present: + + \cmdinvoke{section}[title]% + \texttt{\{title}\cmdinvoke{footnote}{title ftnt}\texttt{\}} +\item Use the \Package{footmisc} package, with package option + \texttt{stable}~--- this modifies footnotes so that they softly and + silently vanish away if used in a moving argument. With this, you + simply need: +\begin{verbatim} +% in the document preamble +\usepackage[stable]{footmisc} +... +% in the body of the document +\section{title\footnote{title ftnt}} +\end{verbatim} +\end{itemize} +\begin{ctanrefs} +\item[footmisc.sty]\CTANref{footmisc} +\end{ctanrefs} + +\Question[Q-ftncapt]{Footnotes in captions} + +Footnotes in captions are especially tricky: they present problems of +their own, on top of the problems one experiences with +\Qref*{footnotes in section titles}{Q-ftnsect} (footnotes migrating to +to the list of figures or tables, or % ! line break +\Qref{apparently random errors}{Q-extrabrace} because +\csx{footnote} is a fragile command), and with % ! line break +\Qref*{footnotes in tables}{Q-footintab} (typically, the footnote +simply disappears). Fortunately, the requirement for footnotes in +captions is extremely rare: if you are experiencing problems, it is +worth reviewing what you are trying to say by placing this footnote: +other options are to place text at the bottom of the float, or to +place a footnote at the point where you refer to the float. + +Note that the \Package{threeparttable} scheme (see, again, % ! line break +\Qref[question]{footnotes in tables}{Q-footintab}) also applies +to notes in captions, and may very well be preferable to whatever you +were thinking of. + +If you \emph{are} going to proceed: +\begin{itemize} +\item use an optional argument in your \csx{caption} command, that + doesn't have the footnote in it; this prevents the footnote + appearing in the ``List of \dots{}'', and +\item put your whole float in a \environment{minipage} so as to keep + the footnotes with the float. +\end{itemize} +so we have: +\begin{quote} +\begin{verbatim} +\begin{figure} + \begin{minipage}{\textwidth} + ... + \caption[Caption for LOF]% + {Real caption\footnote{blah}} + \end{minipage} +\end{figure} +\end{verbatim} +\end{quote} +However, \emph{as well as} all of the above, one \emph{also} has to +deal with the tendency of the \csx{caption} command to produce the +footnote's text twice. For this last problem, there is no tidy +solution this author is aware of. + +If you're suffering the problem, a well-constructed \csx{caption} +command in a \environment{minipage} environment within a float (as +in the example above) can produce \emph{two} copies of the footnote +body ``blah''. (In fact, the effect only occurs with captions that are +long enough to require two lines to be typeset, and so wouldn't appear +with such a short caption as that in the example above.) + +The documentation of the \Package{ccaption} package describes a really +rather awful work-around for this problem. +\begin{ctanrefs} +\item[ccaption.sty]\CTANref{ccaption} +\item[threeparttable.sty]\CTANref{threeparttable} +\end{ctanrefs} + +\Question[Q-repfootnote]{Footnotes whose texts are identical} + +If the \emph{same} footnote turns up at several places within a +document, it's often inappropriate to repeat the footnote in its +entirety over and over again. We can avoid repetition by +semi-automatic means, or by simply labelling footnotes that we know +we're going to repeat and then referencing the result. There is no +completely automatic solution (that detects and suppresses repeats) +available. + +If you know you only have one footnote, which you want to repeat, the +solution is simple: merely use the optional argument of +\csx{footnotemark} to signify the repeats: +\begin{quote} +\begin{verbatim} +...\footnote{Repeating note} +... +...\footnotemark[1] +\end{verbatim} +\end{quote} +\dots{}\@ which is very easy, since we know there will only ever be a +footnote number 1. A similar technique can be used once the footnotes +are stable, reusing the number that \LaTeX{} has allocated. This can +be tiresome, though, as any change of typesetting could change the +relationships of footnote and repeat: labelling is inevitably better. + +Simple hand-labelling of footnotes is possible, using a counter dedicated +to the job: +\begin{quote} +\begin{verbatim} +\newcounter{fnnumber} +... +...\footnote{Text to repeat}% +\setcounter{fnnumber}{\thefootnote}% +... +...\footnotemark[\thefnnumber] +\end{verbatim} +\end{quote} +but this is somewhat tedious. \LaTeX{}'s labelling mechanism can be +summoned to our aid, but there are ugly error messages before the +\csx{ref} is resolved on a second run through \LaTeX{}: +\begin{quote} +\begin{verbatim} +...\footnote{Text to repeat\label{fn:repeat}} +... +...\footnotemark[\ref{fn:repeat}] +\end{verbatim} +\end{quote} +Alternatively, one may use the \csx{footref} command, which has the +advantage of working even when the footnote mark isn't expressed as a +number. The command is defined in the \Package{footmisc} package and +in the \Class{memoir} class (at least); \csx{footref} reduces the above +example to: +\begin{quote} +\begin{verbatim} +...\footnote{Text to repeat\label{fn:repeat}} +... +...\footref{fn:repeat} +\end{verbatim} +\end{quote} +This is the cleanest simple way of doing the job. Note that the +\csx{label} command \emph{must} be inside the argument of +\csx{footnote}. + +The \Package{fixfoot} package takes away some of the pain of the +matter: you declare footnotes you're going to reuse, typically in the +preamble of your document, using a \csx{DeclareFixedFoot} command, and +then use the command you've `declared' in the body of the document: +\begin{quote} +\begin{verbatim} +\DeclareFixedFootnote{\rep}{Text to repeat} +... +...\rep{} +...\rep{} +\end{verbatim} +\end{quote} +The package ensures that the repeated text appears at most once per +page: it will usually take more than one run of \LaTeX{} to get rid of +the repeats. +\begin{ctanrefs} +\item[fixfoot.sty]\CTANref{fixfoot} +\item[footmisc.sty]\CTANref{footmisc} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-multfoot]{More than one sequence of footnotes} + +The need for more than one series of footnotes is common in critical +editions (and other literary criticism), but occasionally arises in +other areas. + +Of course, the canonical critical edition package, \Package{edmac}, +offers the facility, as does its \LaTeX{} port, the \Package{ledmac} +package. + +Multiple ranges of footnotes are offered to \LaTeX{} users by the +\Package{manyfoot} package. The package provides a fair array of +presentation options, as well. Another critical edition +\Package{ednotes} package is built upon a basis that includes +\Package{manyfoot}, as its mechanism for multiple sets of footnotes. + +The \Package{bigfoot} package also uses \Package{manyfoot} as part of +its highly sophisticated structure of footnote facilities, which was +also designed to support typesetting critical editions. +\begin{ctanrefs} +\item[bigfoot]\CTANref{bigfoot} +\item[edmac]\CTANref{edmac} +\item[ednotes]\CTANref{ednotes} +\item[ledmac]\CTANref{ledmac} +\item[manyfoot.sty]Distributed as part of the \CTANref{ncctools} + bundle +\end{ctanrefs} + +\Question[Q-footnpp]{Footnotes numbered ``per page''} + +The obvious solution is to make the footnote number reset whenever the +page number is stepped, using the % ! line break +\Qref*{\LaTeX{} internal mechanism}{Q-addtoreset}. Sadly, the place +in the document where the page number is stepped is unpredictable, not +(``tidily'') at the end of the printed page; so changing the footnote +number only ever works by `luck'. + +As a result, resetting footnotes is inevitably a complicated process, +using labels of some sort. It's nevertheless important, given the +common requirement for footnotes marked by symbols (with painfully +small symbol sets). There are four packages that manage it, one way +or another. + +The \Package{perpage} package provides a general mechanism for +resetting counters per page, so can obviously be used for this task. +The interface is pretty simple: \cmdinvoke{MakePerPage}{footnote} will +do the job. If you want to restart the counter at something other +than~1 (for example to avoid something in the \LaTeX{} footnote symbol +list), you can use: \cmdinvoke{MakePerPage}[2]{footnote}. It's a +first-rate package, small and efficient. + +The \Package{zref} package provides the same facilities with its +\pkgoption{perpage} module, which defines a command \csx{zmakeperpage} +whose syntax is identical to that of \Package{perpage}, above. You can +load the module by \cmdinvoke{usepackage}[perpage]{zref} (or as +\cmdinvoke{usepackage}{zref-perpage}, if your needs so require~--- +look at \Package{zref}'s documentation for details). + +The \Package{footmisc} package provides a variety of means of +controlling footnote appearance, among them a package option +\pkgoption{perpage} that adjusts the numbering per page; if you're +doing something else odd about footnotes, it means you may only need +the one package to achieve your ends. + +The \Package{footnpag} package also does per-page footnotes (and +nothing else). With the competition from \Package{perpage}, it's +probably not particularly useful any more. (Documentation is +\File{footnpag-user.pdf} in the distribution.) +\begin{ctanrefs} +\item[footmisc.sty]\CTANref{footmisc} +\item[footnpag.sty]\CTANref{footnpag} +\item[perpage.sty]Distributed as part \CTANref{bigfoot} +\item[zref.sty]Distributed as a collection member in \CTANref{oberdiek} +\item[zref-perpage.sty]Distributed as a collection member in + \CTANref{oberdiek} +\end{ctanrefs} + +\Question[Q-run-fn-nos]{Not resetting footnote numbers per chapter} + +Some classes (for example, \Class{book} and \Class{report}) set up a +different set of footnotes per chapter, by resetting the footnote +number at the start of the chapter. This is essentially the same +action as that of % ! line break +\Qref*{equation, figure and table numbers}{Q-running-nos}, +except that footnote numbers don't get ``decorated'' with the chapter +number, as happens with those other numbers. + +The solution is the same: use the \Package{chngcntr} package; since the +numbers aren't ``decorated'' you can use the \csx{counterwithout*} +variant; the code: +\begin{quote} +\begin{verbatim} +\counterwithout*{footnote}{chapter} +\end{verbatim} +\end{quote} +is all you need +\begin{ctanrefs} +\item[chngcntr.sty]\CTANref{chngcntr} +\end{ctanrefs} + +\subsection{Document management} + +\Question[Q-filename]{What's the name of this file} + +One might want this so as to automatically generate a page header or +footer recording what file is being processed. It's not easy\dots{} + +\TeX{} retains what it considers the name of the \emph{job}, only, in +the primitive \csx{jobname}; this is the name of the file first +handed to \TeX{}, stripped of its directory name and of any extension +(such as \extension{tex}). If no file was passed (i.e., you're using +\TeX{} interactively), \csx{jobname} has the value \texttt{texput} +(the name that's given to \extension{log} files in this case). + +This is fine, for the case of a small document, held in a single file; +most significant documents will be held in a bunch of files, and +\TeX{} makes no attempt to keep track of files input to the +\emph{job}. So the user has to keep track, himself~--- the only way +is to patch the input commands and cause them to retain details of the +file name. This is particularly difficult in the case of \plaintex{}, +since the syntax of the \csx{input} command is so peculiar. + +In the case of \LaTeX{}, the input commands have pretty regular +syntax, and the simplest \Qref*{patching techniques}{Q-patch} can be +used on them. + +If you're not inputting things from a file that's already been input, +the job is almost trivial: +\begin{quote} +\begin{verbatim} +\def\ThisFile{\jobname} +\let\OldInput\input +\renewcommand{\input}[1]{% + \renewcommand{\ThisFile}{#1}% + \OldInput{#1}% +} +\end{verbatim} +\end{quote} +With that, the macro \csx{ThisFile} always contains the last thing +input: it starts pointing at the base file of your document +(\csx{jobname}), and thereafter changes every time you use +\cmdinvoke*{input}{file}. + +Most ordinary users will quickly become irritated with the simplicity +of of the \csx{ThisFile} mechanism above. The following code is more +cunning: it maintains details of the files you've `come through' to +get to where you are, and it restores \csx{ThisFile} to what the +previous file was before returning. +\begin{quote} +\begin{verbatim} +\def\ThisFile{\jobname} +\newcounter{FileStack} +\let\OrigInput\input +\renewcommand{\input}[1]{% + \stackinput{#1}{\OrigInput}% +} +\newcommand{\stackinput}[2]{% + \stepcounter{FileStack}% + \expandafter\let + \csname NameStack\theFileStack\endcsname + \ThisFile + \def\ThisFile{#1}% + #2{#1}% + \expandafter\let\expandafter + \ThisFile + \csname NameStack\theFileStack\endcsname + \addtocounter{FileStack}{-1}% +} +\end{verbatim} +\end{quote} +To do the same for \csx{include}, we need the simple addition: +\begin{quote} +\begin{verbatim} +\let\OrigInclude\include +\renewcommand{\include}[1]{% + \stackinput{#1}{\OrigInclude}% +} +\end{verbatim} +\end{quote} +Both examples of patching \csx{input} assume you always use +\LaTeX{} syntax, i.e., always use braces around the argument. + +The \Package{FiNK} (``File Name Keeper'') package provides a +regular means of keeping track of the current file name (with its +extension), in a macro \csx{finkfile}. If you need the unadorned file +name (without its `\extension{tex}'), use the commands: +\begin{quote} +\begin{verbatim} +\def\striptexext#1.tex{#1} +... +\edef\ThisFile{\expandafter\stripext\finkfile} +\end{verbatim} +\end{quote} +The \Package{FiNK} bundle includes a \File{fink.el} that provides +support under \ProgName{emacs} with \acro{AUC}-\TeX{}. +\begin{ctanrefs} +\item[fink.sty]\CTANref{fink} +\end{ctanrefs} + +\Question[Q-filesused]{All the files used by this document} + +When you're sharing a document with someone else (perhaps as part of a +co-development cycle) it's as well to arrange that both correspondents +have the same set of auxiliary files, as well as the document in +question. Your correspondent obviously needs the same set of files +(if you use the \Package{url} package, she has to have \Package{url} +too, for example). But suppose you have a bug-free version of the +\Package{shinynew} package but her copy is still the unstable +original; until you both realise what is happening, such a situation +can be very confusing. + +The simplest solution is the \LaTeX{} \csx{listfiles} command. This +places a list of the files used and their version numbers in the log +file. If you extract that list and transmit it with your file, it can +be used as a check-list in case that problems arise. + +Note that \csx{listfiles} only registers things that are input by the +``standard'' \LaTeX{} mechanisms (\csx{documentclass}, \csx{usepackage}, +\csx{input}, \csx{include}, \csx{includegraphics} and so on). But if you +use \TeX{} primitive syntax, as in +\begin{verbatim} + \input mymacros +\end{verbatim} +\File{mymacros.tex} \emph{won't} be listed by \csx{listfiles}, since +you've bypassed the mechanism that records its use. + +The \Package{snapshot} package helps the owner of a \LaTeX{} document +obtain a list of the external dependencies of the document, in a form +that can be embedded at the top of the document. The intended use of +the package is the creation of archival copies of documents, but it +has application in document exchange situations too. + +The \ProgName{bundledoc} system uses the \Package{snapshot} to produce an +archive (e.g., \extension{tar.gz} or \extension{zip}) of the files needed by your +document; it comes with configuration files for use with +\ProgName{teTeX} and \ProgName{\miktex{}}. It's plainly useful when +you're sending the first copy of a document. +\begin{ctanrefs} +\item[bundledoc]\CTANref{bundledoc} +\item[snapshot.sty]\CTANref{snapshot} +\end{ctanrefs} + +\Question[Q-changebars]{Marking changed parts of your document} + +One often needs clear indications of how a document has changed, but +the commonest technique, ``change bars'' (also known as ``revision +bars''), requires surprisingly much +trickery of the programmer (the problem being that \TeX{} `proper' +doesn't provide the programmer with any information about the +``current position'' from which a putative start- or end-point of a +bar might be calculated; \PDFTeX{} \emph{does} provide the +information, but we're not aware yet of any programmer taking +advantage of the fact to write a \PDFTeX{}-based changebar package). + +The simplest package that offers change bars is Peter Schmitt's +\Package{backgrnd.tex}; this was written as a \plaintex{} application +that patches the output routine, but it appears to work at least on +simple \LaTeX{} documents. Wise \LaTeX{} users will be alerted by the +information that \Package{backgrnd} patches their output routine, and +will watch its behaviour very carefully (patching the \LaTeX{} output +routine is not something to undertake lightly\dots{}). + +The longest-established \LaTeX{}-specific solution is the +\Package{changebar} package, +which uses \csx{special} commands supplied by the driver you're using. +You need therefore to tell the package which driver to generate +\csx{special}s for (in the same way that you need to tell the +\Package{graphics} package); the list of available drivers is pretty +wide, but does not include \ProgName{dvipdfm}. The package comes with +a shell script \ProgName{chbar.sh} (for use on Unix machines) that +will compare two documents and generate a third which is marked-up +with \Package{changebar} macros to highlight changes. The +shareware \ProgName{WinEDT} editor has a macro that will generate +\Package{changebar} (or other) macros to show differences from an +earlier version of your file, stored in an +\ProgName{RCS}-controlled repository~--- see +\URL{http://www.winedt.org/Macros/LaTeX/RCSdiff.php} + +The \Package{vertbars} package uses the techniques of the +\Package{lineno} package (which it loads, so the \Package{lineno} +itself must be installed); it's thus the smallest of the packages for +change bar marking, since it leaves all the trickery to another +package. \Package{Vertbars} defines a \environment{vertbar} +environment to create changebars. + +The \Package{framed} package is +another that provides bars as a side-effect of other desirable +functionality: its \environment{leftbar} environment is simply a +stripped-down frame (note, though, that the environment makes a +separate paragraph of its contents, so it is best used when the +convention is to mark a whole changed paragraph. + +Finally, the \Class{memoir} class allows marginal editorial comments, +which you can obviously use to delimit areas of changed text. + +An even more comprehensive way to keep track of changes is employed by +some word-processors~--- to produce a document that embodies both +``old'' and ``new'' versions. + +To this end, the package \Package{changes} allows the user to manually +markup changes of text, such as additions, deletions, or replacements. +Changed text is shown in a different colour; deleted text is crossed +out. The package allows you to define additional authors and their +associated colour; it also allows you to define a markup for authors +or annotations. The documentation (very clearly) demonstrates how the +various functions work. + +The \ProgName{Perl} script \ProgName{latexdiff} may also be used to +generate such markup for \LaTeX{} documents; you feed it the two +documents, and it produces a new \LaTeX{} document in which the +changes are very visible. An example of the output is embedded in the +documentation, +\begin{narrowversion} % actually non-hyperversion + \File{latexdiff-man.pdf}, in the distribution. +\end{narrowversion} +\begin{wideversion} % actually hyperversion + \href{http://www.tex.ac.uk/tex-archive/support/latexdiff/latexdiff-man.pdf}{latexdiff-man.pdf} + (part of the distribution). +\end{wideversion} +A rudimentary revision facility is provided by another +\ProgName{Perl} script, \ProgName{latexrevise}, which accepts or rejects +all changes. Manual editing of the difference file can be used to +accept or reject selected changes only. +\begin{ctanrefs} +\item[backgrnd.tex]\CTANref{backgrnd} +\item[changebar.sty]\CTANref{changebar} +\item[changes.sty]\CTANref{changes} +\item[framed.sty]\CTANref{framed} +\item[latexdiff, latexrevise]\CTANref{latexdiff} +\item[lineno.sty]\CTANref{lineno} +\item[memoir.cls]\CTANref{memoir} +\item[vertbars.sty]\CTANref{vertbars} +\end{ctanrefs} + +\Question[Q-conditional]{Conditional compilation and ``comments''} + +While \LaTeX{} (or any other \TeX{}-derived package) isn't really like a +compiler, people regularly want to do compiler-like things using it. +Common requirements are conditional `compilation' and `block +comments', and several \LaTeX{}-specific means to this end are available. + +The simple \cmdinvoke{newcommand}{\csx{gobble}}[1]\texttt{\{}\texttt{\}} +and \csx{iffalse}\texttt{ ... }\csx{fi} aren't really satisfactory (as +a general solution) for comments, since the matter being skipped is +nevertheless scanned by \TeX{}, not always as you would expect. The +scanning imposes restrictions on what you're allowed to skip; this may +not be a problem in \emph{today's} job, but could return to bite you +tomorrow. For an example of surprises that may come to bite you, +consider the following example (derived from real user experience): +\begin{quote} +\begin{verbatim} +\iffalse % ignoring this bit +consider what happens if we +use \verb+\iftrue+ -- a surprise +\fi +\end{verbatim} +\end{quote} +The \csx{iftrue} is spotted by \TeX{} as it scans, ignoring the +\csx{verb} command; so the \csx{iffalse} isn't terminated by the +following \csx{fi}. Also, \csx{gobble} is pretty inefficient at +consuming anything non-trivial, since all the matter to be skipped is +copied to the argument stack before being ignored. + +If your requirement is for a document from which whole chapters (or +the like) are missing, consider the \LaTeX{} +\csx{include}/\csx{includeonly} system. If you `\csx{include}' your +files (rather than \csx{input} them~--- see % line wrap! +\Qref[question]{What's going on in my \csx{include} commands?}{Q-include}), +\LaTeX{} writes macro traces of what's going on at the end of each +chapter to the \extension{aux} file; by using \csx{includeonly}, you can give +\LaTeX{} an exhaustive list of the files that are needed. Files that +don't get \csx{include}d are skipped entirely, but the document +processing continues as if they \emph{were} there, and page, footnote, +and other numbers are not disturbed. Note that you can choose which +sections you want included interactively, using the +\Package{askinclude} package. + +The inverse can be done using the \Package{excludeonly} package: this +allows you to exclude a (list of) \csx{include}d files from your +document, by means of an \csx{excludeonly} command. + +If you want to select particular pages of your document, use Heiko +Oberdiek's \Package{pagesel} or the \Package{selectp} packages. You +can do something similar with an existing \acro{PDF} document (which +you may have compiled using \ProgName{pdflatex} in the first place), +using the \Package{pdfpages} package. The job is then done with a +document looking like: +\begin{quote} +\begin{verbatim} +\documentclass{article} +\usepackage[final]{pdfpages} +\begin{document} +\includepdf[pages=30-40]{yoursource.pdf} +\end{document} +\end{verbatim} +\end{quote} +(To include all of the document, you write +\begin{quote} +\begin{verbatim} +\includepdf[pages=-]{yoursource.pdf} +\end{verbatim} +\end{quote} +omitting the start and end pages in the optional argument.) + +If you want flexible facilities for including or excluding small +portions of a file, consider the \Package{comment}, \Package{version} or +\Package{optional} packages. + +The \Package{comment} package allows you to declare areas of a document to be +included or excluded; you make these declarations in the preamble of +your file. The command \cmdinvoke*{includecomment}{version-name} +declares an environment \environment{version-name} whose content will +be included in your document, while +\cmdinvoke*{excludecomment}{version-name} defines an environment whose +content will be excluded from the document. The package uses a method +for exclusion that is pretty robust, and can cope with ill-formed +bunches of text (e.g., with unbalanced braces or \csx{if} commands). + +These FAQs employ the \Package{comment} package to alter layout +between the printed (two-column) version and the \acro{PDF} version +for browsing; there are \environment{narrowversion} and +\environment{wideversion} for the two versions of the file. + +\Package{version} offers similar facilities to \File{comment.sty} +(i.e., \csx{includeversion} and \csx{excludeversion} commands); +it's far ``lighter weight'', but is less robust (and in particular, +cannot deal with very large areas of text being included/excluded). + +A significant development of \Package{version}, confusingly called +\Package{versions} (i.e., merely a plural of the old package name). +\Package{Versions} adds a command +\cmdinvoke*{markversion}{version-name} which defines an environment +that prints the included text, with a clear printed mark around it. + +\Package{optional} defines a command \csx{opt}; its first argument is +an `inclusion flag', and its second is text to be included or +excluded. Text to be included or excluded must be well-formed +(nothing mismatched), and should not be too big~--- if a large body of +text is needed, \csx{input} should be used in the argument. +The documentation (in the package file itself) tells you +how to declare which sections are to be included: this can be done in +the document preamble, but the documentation also suggests ways in +which it can be done on the command line that invokes \LaTeX{}, or +interactively. + +And, not least of this style of conditional compilation, +\Package{verbatim} (which should be available in any distribution) +defines a \environment{comment} environment, which enables the +dedicated user of the source text editor to suppress bits of a +\LaTeX{} source file. The \Class{memoir} class offers the same +environment. + +An interesting variation is the \Package{xcomment} package. This +defines an environment whose body is all excluded, apart from +environments named in its argument. So, for example: +\begin{quote} +\begin{verbatim} +\begin{xcomment}{figure,table} + This text is not included + \begin{figure} + This figure is included + \end{figure} + This is not included, either + \begin{table} + This table also included + \end{table} + ... +\end{xcomment} +\end{verbatim} +\end{quote} + +A further valuable twist is offered by the \Package{extract} package. +This allows you to produce a ``partial copy'' of an existing document: +the package was developed to permit production of a ``book of +examples'' from a set of lecture notes. The package documentation +shows the following usage: +\begin{quote} +\begin{verbatim} +\usepackage[ + active, + generate=foobar, + extract-env={figure,table}, + extract-cmd={chapter,section} +]{extract} +\end{verbatim} +\end{quote} +which will cause the package to produce a file \File{foobar.tex} +containing all the \environment{figure} and \environment{table} +environments, and the \csx{chapter} and \csx{section} commands, from +the document being processed. The new file \File{foobar.tex} is +generated in the course of an otherwise ordinary run on the `master' +document. The package provides a good number of other facilities, +including (numeric or labelled) ranges of environments to extract, and +an \environment{extract} environment which you can use to create complete +ready-to-run \LaTeX{} documents with stuff you've extracted. +\begin{ctanrefs} +\item[askinclude.sty]Distributed with Heiko Oberdiek's packages~--- + \CTANref{oberdiek} +\item[comment.sty]\CTANref{comment} +\item[excludeonly.sty]\CTANref{excludeonly} +\item[extract.sty]\CTANref{extract} +\item[memoir.cls]\CTANref{memoir} +\item[optional.sty]\CTANref{optional} +\item[pagesel.sty]Distributed with Heiko Oberdiek's packages~--- + \CTANref{oberdiek} +\item[pdfpages.sty]\CTANref{pdfpages} +\item[selectp.sty]\CTANref{selectp} +\item[verbatim.sty]Distributed as part of \CTANref{2etools} +\item[version.sty]\CTANref{version} +\item[versions.sty]\CTANref{versions} +\item[xcomment.sty]Distributed as part of \CTANref{seminar} +\end{ctanrefs} + +\Question[Q-docotherdir]{Bits of document from other directories} + +A common way of constructing a large document is to break it into a +set of files (for example, one per chapter) and to keep everything +related to each of these subsidiary files in a subdirectory. + +Unfortunately, \TeX{} doesn't have a changeable ``current directory'', +so that all files you refer to have to be specified relative to the +same directory as the main file. Most people find this +counter-intuitive. + +It may be appropriate to use the ``path extension'' technique +% beware line break +\Qref[of question]{used in temporary installations}{Q-tempinst} to deal with +this problem. However, if there several files with the same name in +your document, such as \File{chapter1/fig1.eps} and +\File{chapter2/fig1.eps}, you're not giving \TeX{} any hint as to +which you're referring to when in the main chapter file you say +\cmdinvoke{input}{sect1}; while this is readily soluble in the case of +human-prepared files (just don't name them all the same), +automatically produced files have a way of having repetitious names, +and changing \emph{them} is a procedure prone to error. + +The \Package{import} package comes to your help here: it defines an +\csx{import} command that accepts a full path name and the name of a +file in that directory, and arranges things to ``work properly''. +So, for example, if \File{/home/friend/results.tex} contains +\begin{quote} +\begin{verbatim} +Graph: \includegraphics{picture} +\input{explanation} +\end{verbatim} +\end{quote} +then \cmdinvoke{import}{/home/friend/}{results} will include both +graph and explanation as one might hope. A \csx{subimport} command +does the same sort of thing for a subdirectory (a relative path rather +than an absolute one), and there are corresponding \csx{includefrom} +and \csx{subincludefrom} commands. + +The \Package{chapterfolder} package provides commands to deal with its +(fixed) model of file inclusion in a document. It provides commands +\csx{cfpart}, \csx{cfchapter}, \csx{cfsection} and \csx{cfsubsection}, +each of which takes directory and file arguments, e.g.: +\begin{quote} +\begin{verbatim} +\cfpart[pt 1]{Part One}{part1}{part} +\end{verbatim} +\end{quote} +which command will issue a `normal' command % ! line break +\cmdinvoke{part}[pt 1]{Part One} and then input the file +\File{part1/part.tex}, remembering that \File{part1/} is now the +``current folder''. There are also commands of the form +\csx{cfpartstar} (which corresponds to a \csx{part*} command). + +Once you're ``in'' a \Package{chapterfolder}-included document, you +may use \csx{cfinput} to input something relative to the ``current +folder'', or you may use \csx{input}, using \csx{cfcurrentfolder} to +provide a path to the file. (There are also +\csx{cfcurrentfolderfigure} for a \path{figure/} subdirectory and +\csx{cfcurrentfolderlistings} for a \path{listings/} subdirectory.) + +Documentation of \Package{chapterfolder} is in French, but the +\File{README} in the directory is in English. +\begin{ctanrefs} +\item[chapterfolder.sty]\CTANref{chapterfolder} +\item[import.sty]\CTANref{import} +\end{ctanrefs} + +\Question[Q-RCS]{Version control using \acro{RCS}, \acro{CVS} or the like} + +If you use \acro{RCS}, \acro{CVS}, \ProgName{Subversion}, +\ProgName{Bazaar} or \ProgName{Git} to maintain +your \AllTeX{} documents under version control, you may need some +mechanism for including the version details in your document, in such +a way that they can be typeset (that is, rather than just hiding them +inside a comment). + +The most complete solution for \acro{RCS} and \acro{CVS} is to use the +(\LaTeX{}) package \Package{rcs}, which allows you to parse and +display the contents of \acro{RCS} keyword fields in an extremely +flexible way. The package \Package{rcsinfo} is simpler, but does most +of what you want, and some people prefer it; it is explicitly +compatible with \ProgName{LaTeX2HTML}. + +If, however, you need a solution which works without using external +packages, or which will work in \plaintex{}, then you can use the +following minimal solution: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\def\RCS$#1: #2 ${\expandafter\def\csname RCS#1\endcsname{#2}} +\RCS$Revision: 1.3 $ % or any RCS keyword +\RCS$Date: 2009/10/06 22:23:45 $ +... +\date{Revision \RCSRevision, \RCSDate} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\def\RCS$#1: #2 ${\expandafter + \def\csname RCS#1\endcsname{#2}% +} +\RCS$Revision: 1.3 $ % or any RCS keyword +\RCS$Date: 2009/10/06 22:23:45 $ +... +\date{Revision \RCSRevision, \RCSDate} +\end{verbatim} +\end{narrowversion} +\end{quote} + +If you've entered the brave new world of \ProgName{Subversion}, the +package \Package{svn} may be for you. It has explicit cleverness +about dealing with dates: +\begin{quote} +\csx{documentclass}\texttt{\{\meta{foo}\}}\\ +\texttt{...}\\ +\cmdinvoke{usepackage}{svn}\\ +\csx{SVNdate}\texttt{ \$Date\$}\\ +\cmdinvoke{author}{...}\\ +\cmdinvoke{title}{...}\\ +\texttt{...}\\ +\cmdinvoke{begin}{document}\\ +\csx{maketitle}\\ +\texttt{...}\\ +\cmdinvoke{end}{document} +\end{quote} +will (once \ProgName{subversion} has committed a copy of the document) +cause \csx{maketitle} use the date that has been written into the +\texttt{\$Date\$} keyword. + +Another alternative for \ProgName{Subversion} users is the +\Package{svninfo} package, which has much the same mechanisms as does +\Package{svn} but with a rather different focus. \Package{Svninfo} +does the date trick that \Package{svn} performs (controlled by a +package option), and can set up page foot-lines using % ! line break +\Qref*{package \Package{fancyhdr}}{Q-fancyhdr}. There isn't much to +choose between the two packages: you should read the packages' +documentation to see which suits you best. + +An alternative script-based approach to version control has been taken +by the \Package{vc} bundle, that in certain situations might work more +reliably than any of the packages mentioned above. The \Package{vc} +bundle supports \ProgName{Bazaar}, \ProgName{Git} and +\ProgName{Subversion} usage and works with both \LaTeX{} and +\plaintex{}. Note that \Package{vc} is the only option that +currently claims to support \ProgName{Bazaar}- and +\ProgName{Git}-controlled repositories. +\begin{ctanrefs} +\item[rcs.sty]\CTANref{rcs} +\item[rcsinfo.sty]\CTANref{rcsinfo} +\item[svn.sty]\CTANref{svn} +\item[svninfo.sty]\CTANref{svninfo} +\item[vc]\CTANref{vc} +\end{ctanrefs} + +\Question[Q-make]{Makefiles for \LaTeX{} documents} + +\LaTeX{} is a tricky beast for running \ProgName{make} on: the need to +instruct \LaTeX{} to run several times for essentially different +reasons (for example, ``get the table of contents stable'', ``get the +labels stable'', ``add the bibliography'', ``add the index'') is +actually rather difficult to express in the `ordinary' sort of +dependency graph that one constructs for \ProgName{make}. + +The \ProgName{latex-make} package offers help with this task (far more +sophisticated techniques than in the \acro{FAQ} building script); it +looks good, but reports of its use (other than by its author) are scarce. + +For a long time, the only \ProgName{make}-like package on \acro{CTAN} +was \ProgName{latexmk}, which is a \ProgName{Perl} +script that analyses your \LaTeX{} source for its dependencies, runs +\BibTeX{} or \ProgName{makeindex} as and when it notices that those +programs' input (parts of the \extension{aux} file, or the +\extension{idx} file, respectively) has changed, and so on. +\ProgName{Latexmk} is a fine +solution (and was used in generating printable versions of these +\acro{FAQ}s for a long time); it has recently been upgraded and has +many bells and whistles that allow it to operate as if it were a poor +man's \WYSIWYG{} system. + +Apparently along the same lines, is Auto\LaTeX{}. The \File{README} +of the distribution is actual a Unix-type man-page output, and shows +great attention to the details of the document production process. + +The \ProgName{mk} (also, apparently, known as \ProgName{latex_maker}) +is a Ruby script for the task in hand; it works well with another of +the author's scripts script called \ProgName{vpp} (View and Print +\PS{}/\acro{PDF}). + +Windows users of the \miktex{} system may use that system's +\ProgName{texify} application. \ProgName{Texify} deals with basic +\LaTeX{} features, including generating a bibliography and an index; +it makes no claim to deal with other things (such as multiple +bibliographies or indexes, or lists of terminology, etc.), which +Auto\LaTeX{} can be configured to process. + +The \Qref*{\Package{texinfo} system}{Q-texinfo} comes with a similar +utility called \ProgName{texi2dvi}, which is capable of ``converting'' +either \LaTeX{} or \Package{texinfo} files into \acro{DVI} (or into +\acro{PDF}, using \PDFTeX{}). + +A later contribution is the bundle \Package{latexmake}, which +offers a set of \ProgName{make} rules that invoke \ProgName{texi2dvi} +as necessary. + +The curious may examine the rules employed to run the present +\acro{FAQ} through \LaTeX{}: we don't present them as a complete +solution, but some of the tricks employed are surely re-usable. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}AutoLaTeX]\CTANref{autolatex} +\item[\nothtml{\rmfamily}\acro{FAQ} distribution]\CTANref{faq} +\item[\nothtml{\rmfamily}latexmake]\CTANref{latexmake} +\item[latex-make]\CTANref{latex-make} +\item[latex\_make]\CTANref{latex_maker} +\item[latexmk]\CTANref{latexmk} +\item[texi2dvi]Distributed as part of \CTANref{texinfo} +\end{ctanrefs} + +\Question[Q-howmanypp]{How many pages are there in my document?} + +Simple documents (those that start at page 1, and don't have any +breaks in their page numbering until their last page) present no +problem to the seeker after this truth. The number of pages is +reported by the \Package{lastpage} package in its \texttt{LastPage} label. + +For more complicated documents (most obviously, books with frontmatter +in a different series of page numbers) this simple approach will not +do. + +The \Package{count1to} package defines a label \texttt{TotalPages}; this is +the value of its copy of \csx{count1} (a reserved \TeX{} count +register) at the end of the document. + +Package \Package{totpages} defines a label \texttt{TotPages}, but it also +makes the register it uses available as a \LaTeX{} counter, +\texttt{TotPages}, which you can also reference via \csx{theTotPages}. Of +course, the counter |TotPages| is asynchronous in the same way that +page numbers are, but snapshots may safely be taken in the output +routine. + +The \Class{memoir} class defines two counters \texttt{lastpage} and +\texttt{lastsheet}, which are set (after the first run of a document) +to the equivalent of the \texttt{LastPage} label and the +\texttt{TotalPages} labels. + +Both \Package{count1to} and \Package{totpages} need the support of +the \Package{everyshi} package. +\begin{ctanrefs} +\item[count1to.sty \nothtml{\bgroup\rmfamily}and\nothtml{\egroup} everyshi.sty]% line break!! + Distributed in \CTANref{ms} +\item[lastpage.sty]\CTANref{lastpage} +\item[memoir.cls]\CTANref{memoir} +\item[totpages.sty]\CTANref{totpages} +\end{ctanrefs} + +\Question[Q-inclplain]{Including \plaintex{} files in \LaTeX{}} + +\LaTeX{}, though originally \Qref*{based on \plaintex{}}{Q-LaTeXandPlain}, does not +contain all of \plaintex{}'s commands. Worse, some \plaintex{} +command names appear in \LaTeX{}, with different semantics. As a +result, special measures need to be taken to allow general \plaintex{} +documents (or parts of documents) to be typeset within \LaTeX{}. + +The truly reliable way is to translate the \plaintex{} commands, to +produce an equivalent of the original's semantics. However, this is +not practical in many circumstances, and for those occasions, the +\Package{plain} package will often come to your aid. The package +defines a \environment{plain} environment, in which a \plaintex{} +document may be processed: +\begin{quote} +\begin{verbatim} +\begin{plain} + \input{plain-doc} +\end{plain} +\end{verbatim} +\end{quote} +The package is known to fail, for example, with documents that use +\AMSTeX{}; no doubt it would also fail if asked to load \Eplain{}. +All these things can be overcome (although it's not often easy), but +the environment saves a lot of work on many occasions. +\begin{ctanrefs} +\item[plain.sty]Distributed as part of \CTANref{carlisle} +\end{ctanrefs} + +\subsection{Hyphenation} + +\Question[Q-nohyph]{My words aren't being hyphenated} + +Let's assume you've selected the right \TeX{} `language'~--- as +explained in \Qref[question]{``how hyphenation works''}{Q-hyphen}, +you're not likely to get the correct results typesetting one language +using the hyphenation rules of another. (Select the proper language, +using \Package{babel} if you're a \LaTeX{} user. This may reveal that +you need another set of hyphenation patterns; see +% beware line wrap +\Qref[question]{``using a new language''}{Q-newlang} for advice on how +to install it.) + +So what else can go wrong? +\begin{itemize} +\item Since \TeX{} version~3.0, the limits on how near to either end + of a word hyphenation may take place have been programmable (see + \Qref[question]{``weird hyphenation''}{Q-weirdhyphen}), and for some + reason the values in question may have been corrupted in some macros + you are using. \TeX{} won't hyphenate less than \csx{lefthyphenmin} + characters after the start of a word, nor less than + \csx{righthyphenmin} before the end of a word; thus it won't + hyphenate a word shorter than the sum of the two minima, at all. + For example, since the minima are 2 and 3 for English, \TeX{} won't + hyphenate a word shorter than 5 letters long, if it believes the + word to be English. +\item \TeX{} won't hyphenate a word that's already been hyphenated. + For example, the (caricature) English surname Smyth-Postlethwaite + wouldn't hyphenate, which could be troublesome. This is correct + English typesetting style (it may not be correct for other + languages), but if needs must, you can replace the hyphen in the + name with a \csx{hyph} command, defined +\begin{quote} +\begin{verbatim} +\def\hyph{-\penalty0\hskip0pt\relax} +\end{verbatim} +\end{quote} + This is \emph{not} the sort of thing this \acro{FAQ} would + ordinarily recommend\dots{} The \Package{hyphenat} package defines a + bundle of such commands (for introducing hyphenation points at + various punctuation characters). +\item There may be accents in the word. The causes of and remedies + for this effect are discussed in + % beware line break + \Qref[question]{accents and hyphens}{Q-hyphenaccents}. +\item The hyphenation may simply not have been spotted; while \TeX{}'s + algorithm is good, it's not infallible, and it does miss perfectly + good hyphenations in some languages. When this happens, you need to + give \TeX{} \emph{explicit} instructions on how to hyphenate. +\end{itemize} +The \csx{hyphenation} command allows you to give explicit instructions. +Provided that the word will hyphenate at all (that is, it is not +prevented from hyphenating by any of the other restrictions above), +the command will override anything the hyphenation patterns might +dictate. The command takes one or more hyphenated words as +argument~--- \cmdinvoke{hyphenation}{ana-lysis pot-able}; note that +(as here, for analysis) you can use the command to overrule \TeX{}'s +choice of hyphenation (ana-lysis is the British etymological +hyphenation; some feel the American hyphenation feels +`unfortunate'\dots{}). +\begin{ctanrefs} +\item[hyphenat.sty]\CTANref{hyphenat} +\end{ctanrefs} + +\Question[Q-weirdhyphen]{Weird hyphenation of words} + +If your words are being h-yphenated, like this, with jus-t single +letters at the +beginning or the end of the word, you may have a version mismatch +problem. \TeX{}'s hyphenation system changed between version~2.9 +and~3.0, and macros written for use with version~2.9 can have this +effect with a version~3.0 system. If you are using \plaintex{}, make +sure your \File{plain.tex} file has a version number which is at +least~3.0, and rebuild your format. If you are using \LaTeXo{} your +best plan is to upgrade to \LaTeXe{}. If for some reason you can't, +the last version of \LaTeXo{} (released on 25 March 1992) is still +available (for the time being at least) and ought to solve this +problem. + +If you're using \LaTeXe{}, the problem probably arises from your +|hyphen.cfg| file, which has to be created if you're using a +multi-lingual version. + +A further source of oddity can derive from the 1995 release of +\Qref*{Cork-encoded fonts}{Q-ECfonts}, +which introduced an alternative hyphen character. The \LaTeXe{} +configuration files in the font release specified use of the +alternative hyphen, and this could produce odd effects with words +containing an explicit hyphen. The font configuration files in the +December 1995 release of \LaTeXe{} do \emph{not} use the alternative +hyphen character, and therefore removed this source of problems; the +solution, again, is to upgrade your \LaTeX{}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\LaTeXo{}]\CTANref{latex209-base} +\item[plain.tex]\CTANref{plain} +\end{ctanrefs} + +\Question[Q-oddhyphen]{(Merely) peculiar hyphenation} + +You may have found that \TeX{}'s famed automatic word-division does +not produce the break-points recommended by your dictionary. This may be +because \TeX{} is set up for American English, whose rules for word +division (as specified, for example, in Webster's Dictionary) are +completely different from the British ones (as specified, for example, +in the Oxford Dictionaries). This problem is being addressed by the \acro{UK} +\TeX{} User community (see \BV{}, issue~4.4) but an entirely +satisfactory solution will take time; the current status is to be +found on \acro{CTAN} (see +% beware line-wrap +\Qref[question]{``using a new language''}{Q-newlang} for instructions +on adding this new ``language''). +\begin{ctanrefs} +\item[UK patterns]\CTANref{ukhyph} +\end{ctanrefs} + +\Question[Q-hyphenaccents]{Accented words aren't hyphenated} + +\TeX{}'s algorithm for hyphenation gives up when it encounters an +\csx{accent} command; there are good reasons for this, but it means +that quality typesetting in non-English languages can be difficult. + +For \TeX{} macro packages, you can avoiding the effect by using an +appropriately encoded font (for example, a Cork-encoded font~--- see +\Qref[question]{the \acro{EC} fonts}{Q-ECfonts}) which contains accented +letters as single glyphs. \LaTeX{} users can achieve this end simply +by adding the command +\begin{verbatim} + \usepackage[T1]{fontenc} +\end{verbatim} +to the preamble of their document. Other encodings (notably +\acro{LY}1, once promoted by \YandY{} inc) may be used +in place of \acro{T}1. Indeed, most current 8-bit \TeX{} font +encodings will `work' with the relevant sets of hyphenation patterns. + +One might hope that, with the many aspirant successors to \TeX{} such +as +\begin{wideversion} + \Qref{Omega}{Q-omegaleph}, \Qref{\LuaTeX{}}{Q-luatex} and + \Qref{Ex\TeX{}}{Q-extex}, +\end{wideversion} +\begin{narrowversion} + Omega, \LuaTeX{} and Ex\TeX{} + (\Qref[see questions]{}{Q-omegaleph}\Qref[,]{}{Q-luatex} + \Qref[and]{}{Q-extex}), +\end{narrowversion} +all of which base their operations on Unicode, that the whole basis of +encodings will change. + +\Question[Q-newlang]{Using a new language with Babel} + +\Package{Babel} is capable of working with a large range of +languages, and a new user often wants to use a language that her +\TeX{} installation is not set up to employ. Simply asking Babel to +use the language, with the command +\begin{verbatim} + \usepackage[catalan]{babel} +\end{verbatim} +provokes the warning message +\begin{wideversion} +\begin{verbatim} +Package babel Warning: No hyphenation patterns were loaded for +(babel) the language `Catalan' +(babel) I will use the patterns loaded for \language=0 instead. +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +Package babel Warning: No hyphenation patterns + were loaded for +(babel) the language `Catalan' +(babel) I will use the patterns + loaded for \language=0 instead. +\end{verbatim} +(The first and third lines above have been wrapped to fit in the +column.) +\end{narrowversion} + +The problem is that your \TeX{} system doesn't know how to hyphenate +Catalan text: you need to tell it how before Babel can do its work +properly. To do this, for \LaTeX{} installations, one needs to change +\File{language.dat} (which is part of the Babel installation); it will +contain a line +\begin{verbatim} +%catalan cahyphen.tex +\end{verbatim} +which, if you remove the comment marker, is supposed to instruct +\LaTeX{} to load Catalan hyphenation patterns when you tell it to build +a new format. + +Unfortunately, in many Babel distributions, the line just isn't +right~--- you need to check the name of the file containing the +patterns you're going to use. As you can see, in the author's system, +the name is supposed to be \File{cahyphen.tex}; however the file +actually present on the system is \File{cahyph.tex}~--- fortunately, +the error should prove little more than an inconvenience (most of the +files are in better distributions anyway, but an elusive one +may be found on \acro{CTAN}; if you have to retrieve +a new file, ensure that it's correctly installed, for which see +\Qref[question]{installing a new package}{Q-inst-wlcf}). + +Finally, you need to regenerate the formats used (in fact, most users +of Babel are using it in their \LaTeX{} documents, so regenerating the +\LaTeX{}-related formats will ordinarily be enough; however, the +author always generates the lot, regardless). +\begin{description} +\item[te\TeX{}]It's possible to do the whole operation in one go, by + using the \ProgName{texconfig} command: +\begin{verbatim} +texconfig hyphen latex +\end{verbatim} + which first enters an editor for you to edit \File{language.dat}, + and then regenerates the format you specify (\ProgName{latex} in + this case). + + Otherwise, to regenerate all formats, do: \\ + \texttt{fmtutil -\relax-all} + + If you're willing to think through what you're doing (this is + \emph{not} for the faint-hearted), you can select a sequence of + formats and for each one, run: \\ + \texttt{fmtutil -\relax-byfmt \meta{formatname}}\\ + where \emph{\texttt{formatname}} is something like `\texttt{latex}', + or: \\ + \texttt{fmtutil -\relax-byhyphen \meta{hyphenfile}}\\ + where \emph{\texttt{hyphenfile}} is the file specifying hyphenation + to the format~--- usually \texttt{language.dat} +\item[\miktex{}] On a \Package{\miktex{}} distribution earlier than v2.0, do: \\ + \texttt{Start}\arrowhyph{}% + \texttt{Programs}\arrowhyph{}% + \texttt{\miktex{}}\arrowhyph{}% + \texttt{Maintenance}\arrowhyph{}% + \texttt{Create all format files} +% this sequence suggested for miktex 1.20e, 2000/12/22, by Giuseppe Bilotta + + or get a DOS window and run:\\ + \texttt{initexmf -\relax-dump} + + On a \Package{\miktex{}} distribution v2.0 or later, the whole + procedure can be done via the \acro{GUI}. To select the new + language, do:\\ + \texttt{Start}\arrowhyph{}% + \texttt{Programs}\arrowhyph{}% + \texttt{\miktex{} 2}\arrowhyph{}% + \texttt{\miktex{} Options}, and select the \texttt{Languages} tab. + Select your language from the list, press the \texttt{Apply} button, + and then the \texttt{OK} button. Then select the \texttt{General} + tab and press the \texttt{Update Now} button. + + Otherwise, edit the \File{language.dat} file (as outlined above), + and then run:\\ + \texttt{initexmf -\relax-dump}\\ + just as for a pre-v2.0 system. +\end{description} + +\nothtml{\noindent}\textbf{\emph{Caveat}:} It is (just) possible that +your \TeX{} system may run out of ``pattern memory'' while generating +the new format. Most \TeX{} implementations have fixed-size arrays +for storing the details of hyphenation patterns, but although their +size is adjustable in most modern distributions, actually changing the +size is a fiddle. If you \emph{do} find you've run out of memory, +it may be worth scanning the list of languages in your +\File{language.dat} to see whether any could reasonably be removed. +\begin{ctanrefs} +\item[babel]\CTANref{babel} +\item[hyphenation patterns]\CTANref{hyphenation} +\end{ctanrefs} + +\Question[Q-hyphoff]{Stopping all hyphenation} + +It may seem an odd thing to want to do (after all, one of \TeX{}'s +great advertised virtues is the quality of its hyphenation) but it's +sometimes necessary. The real problem is, that the quality of +\TeX{}'s output is by default largely dependent on the presence of +hyphenation; if you want to abandon hyphenation, something has to +give. + +\TeX{} (slightly confusingly) offers four possible mechanisms for +suppressing hyphenation (there were only two prior to the extensions +that arrived with \TeX{} version~3). + +First, one can set the hyphenation penalties \csx{hyphenpenalty} and +\csx{exhyphenpenalty} to an `infinite' value (that is to say, 10000). +This means that all hyphenations will sufficiently penalise the line +that would contain them, that the hyphenation won't happen. The +disadvantage of this method is that \TeX{} will re-evaluate any +paragraph for which hyphenations might help, which will slow \TeX{} +down. + +Second, one can select a language for which no hyphenation patterns +exist. Some distributions create a language \texttt{nohyphenation}, +and the \Package{hyphenat} package uses this technique for its +\csx{nohyphens} command which sets its argument without any +hyphenation. You can load \Package{hyphenat} with the command +\begin{quote} + \cmdinvoke{usepckage}[none]{hyphenat} +\end{quote} +to prevent any hyphenation in a single-language document. The +technique cannot work in a document in which \Package{babel} controls +language selection, since \Package{babel} incorporates hyphenation +change into its language change facilities. + +Third, one can set \csx{left-} and/or \csx{righthyphenmin} to a +sufficiently large value that no hyphenation could possibly succeed, +since the minimum is larger than the length of the longest word +\TeX{} is willing to hyphenate (the appropriate value is 62). + +Fourth, one can suppress hyphenation for all text using the current +font by the command +\begin{quote} +\begin{verbatim} +\hyphenchar\font=-1 +\end{verbatim} +\end{quote} +This isn't a particularly practical way for users to suppress +hyphenation~--- the command has to be issued for every font the +document uses~--- but it's how \LaTeX{} itself suppresses hyphenation +in \texttt{tt} and other fixed-width fonts. + +Which of the techniques you should use depends on what you actually +want to do. If the text whose hyphenation is to be suppressed runs +for less than a paragraph, your only choice is the no-hyphens +language: the language value is preserved along with the text (in the +same way that the current font is); the values for penalties and +hyphen minima active at the end of a paragraph are used when +hyphenation is calculated. + +Contrariwise, if you are writing a multilanguage document using the +\Package{babel} package, you \emph{cannot} suppress hyphenation +throughout using either the no-hyphens language or the hyphen minima: +all those values get changed at a \Package{babel} language switch: use +the penalties instead. + +If you simply switch off hyphenation for a good bit of text, the +output will have a jagged edge (with many lines seriously overfull), +and your \AllTeX{} run will bombard you with warnings about overfull +and underfull lines. To avoid this you have two options. + +The simplest route is to use \csx{sloppy} (or its environment version +\environment{sloppypar}), and have \TeX{} stretch what would otherwise +be underfull lines to fill the space offered, while prematurely +wrapping overfull lines and stretching the remainder. + +Alternatively, you may set the text \Qref*{ragged right}{Q-ragright}, +and at least get rid of the overfull lines; this technique is +`traditional' (in the sense that typists do it) and may be expected to +appeal to the specifiers of eccentric document layouts (such as those +for dissertations), but for once their sense conforms with typographic +style. (Or at least, style constrained in this curious way.) +\begin{ctanrefs} +\item[hyphenat.sty]\CTANref{hyphenat} +\end{ctanrefs} + +\Question[Q-wdnohyph]{Preventing hyphenation of a particular word} + +It's quite possible for (\emph{any}) hyphenation of a particular word +to seem ``completely wrong'', so that you want to prevent it being +hyphenated. + +If the word occurs in just one place, put it in a box: +\begin{quote} +\begin{verbatim} +\mbox{oddword} +\end{verbatim} +\end{quote} +(\plaintex{} users should use \csx{hbox}, and take care at the start +of paragraphs.) However, boxing the word is not really advisable +unless you are sure it only occurs once. + +If the word occurs commonly, the best choice is to assert a +non-hyphenation for it: +\begin{quote} +\begin{verbatim} +\hyphenation{oddword} +\end{verbatim} +\end{quote} +This hyphenation exception (with no break points) will be used in +preference to what \TeX{}'s hyphenation algorithm may come up with. + +In a multilingual document, repeat the exception specification for +each language the word may appear in. So: +\begin{quote} +\begin{verbatim} +\usepackage[french,english]{babel} +\selectlanguage{english} +\hyphenation{oddword} +\selectlanguage{french} +\hyphenation{oddword} +\end{verbatim} +\end{quote} +(note that \Package{babel} will select the default language for the +document~--- English, in this case~--- at \cmdinvoke{begin}{document}.) + +A particular instance of this requirement is avoiding the hyphenation +of acronyms; a general rule for those that concoct acronyms seems to +be to make the capital-letter sequence read as near as is possible +like a ``real'' word, but hyphenating an acronym often looks silly. +The \TeX{} flag \csx{uchyph} is designed for suppressing such +behaviour: +\begin{quote} +\begin{verbatim} +\uchyph=0 +\end{verbatim} +\end{quote} +will stop hyphenation of upper-case words. (Note that \plaintex{} +syntax is needed here: there's no \LaTeX{} alternative for setting +this value.) + +\Question[Q-hyphexcept]{Hyphenation exceptions} + +While \TeX{}'s hyphenation rules are good, they're not infallible: you +will occasionally find words \TeX{} just gets \emph{wrong}. So for +example, \TeX{}'s default hyphenation rules (for American English) don't +know the word ``\emph{manuscript}'', and since it's a long word you +may find you need to hyphenate it. You \emph{can} ``write the +hyphenation out'' each time you use the word: +\begin{quote} +\begin{verbatim} +... man\-u\-script ... +\end{verbatim} +\end{quote} +Here, each of the \csx{-} commands is converted to a hyphenated break, +if (\emph{and only if}) necessary. + +That technique can rapidly become tedious: you'll probably only accept +it if there are no more than one or two wrongly-hyphenated words in +your document. The alternative is to set up hyphenations in the +document preamble. To do that, for the hyphenation above, you would +write: +\begin{quote} +\begin{verbatim} +\hyphenation{man-u-script} +\end{verbatim} +\end{quote} +and the hyphenation would be set for the whole document. Barbara +Beeton publishes articles containing lists of these ``hyphenation +exceptions'', in \textsl{TUGboat}; the hyphenation `man-u-script' +comes from one of those articles. + +What if you have more than one language in your document? Simple: +select the appropriate language, and do the same as above: +\begin{quote} +\begin{verbatim} +\usepackage[french]{babel} +\selectlanguage{french} +\hyphenation{re-cher-cher} +\end{verbatim} +\end{quote} +(nothing clever here: this is the ``correct'' hyphenation of the word, +in the current tables). However, there's a problem here: just as +words with accents in them won't break, so \csx{hyphenation} commands +with accents in them produce an error: +\begin{quote} +\begin{verbatim} +\usepackage[french]{babel} +\selectlanguage{french} +\hyphenation{r\'e-f\'e-rence} +\end{verbatim} +\end{quote} +tells us that the hyphenation is ``improper'', and that it will be ``flushed''. +But, just as hyphenation of words is enabled by selecting an 8-bit +font encoding, so \csx{hyphenation} commands are rendered proper again +by selecting that same 8-bit font encoding. For the hyphenation +patterns provided in the usual distributions, the encoding is +\Qref*{Cork}{Q-ECfonts}, so the complete sequence is: +\begin{quote} +\begin{verbatim} +\usepackage[T1]{fontenc} +\usepackage[french]{babel} +\selectlanguage{french} +\hyphenation{r\'e-f\'e-rence} +\end{verbatim} +\end{quote} + +The same sort of performance goes for any language for which 8-bit +fonts and corresponding hyphenation patterns are available. Since you +have to select both the language and the font encoding to have your +document typeset correctly, it should not be a great imposition to do +the selections before setting up hyphenation exceptions. + +\subsection{Odds and ends} + +\Question[Q-logos]{Typesetting all those \TeX{}-related logos} + +Knuth was making a particular point about the capabilities of \TeX{} +when he defined the logo. Unfortunately, many believe, he thereby +opened floodgates to give the world a whole range of rather silly +`bumpy road' logos for \TeX{} entities such as \AMSTeX{}, \PiCTeX{}, +\BibTeX{}, and so on, produced in a flurry of different fonts, sizes, +and baselines~--- indeed, everything one might hope to cause them to +obstruct the reading process. In particular, Lamport invented +\LaTeX{} (silly enough in itself, with a raised small `A' and a +lowered `E') and marketing input from Addison-Wesley led to the even +stranger current logo for \LaTeXe{}, which appends a lowered % !line break +\latexhtml{\ensuremath{\varepsilon}}{single-stroke Greek letter ε}. + +Sensible users don't have to follow this stuff wherever it goes, +but, for those who insist, a large collection of logos is defined in +the \Package{texnames} package (but note that this set of macros isn't +entirely reliable in \LaTeXe{}). +The \MF{} and \MP{} logos can be set in fonts that \LaTeXe{} +knows about (so that they scale with the surrounding text) using the +\Package{mflogo} package; but be aware that booby-traps surround the +use of the Knuthian font for \MP{} (you might get +\htmlignore +\textlogo{META\hphantom{P}O\hphantom{S}T}). +\endhtmlignore +% the following htmlversion stuff seems to do roughly what's required, +% which is nice, given the feebleness of representing all these silly +% logos in html otherwise... +\begin{htmlversion} + something like `META\ \ O\ \ T'). +\end{htmlversion} +You needn't despair, however~--- most versions of the logo font +distributed nowadays contain the missing letters, and the author +himself uses just `MetaPost'. + +For those who don't wish to acquire the `proper' logos, the canonical +thing to do is to say \texttt{AMS-}\cmdinvoke{TeX}{} +for \AMSTeX{}, \texttt{Pic}\cmdinvoke{TeX}{} +for \PiCTeX{}, \texttt{Bib}\cmdinvoke{TeX}{} +for \BibTeX{}, and so on. +\begin{ctanrefs} +\item[mflogo.sty]\CTANref{mflogo} +\item[texnames.sty]\CTANref{texnames} +\end{ctanrefs} +\LastEdit{2009-06-07} + +\Question[Q-bold-extras]{How to do bold-tt or bold-sc} + +\LaTeX{}, as delivered, offers no means of handling bold ``teletype'' +or small-caps fonts. There's a practical reason for this (Knuth never +designed such fonts), but there are typographical considerations too +(the ``medium weight'' \texttt{cmtt} font is already pretty bold (by +comparison with other fixed-width fonts), and bold small-caps is not +popular with many professional typographers). + +There's a set of ``extra'' \MF{} files on \acro{CTAN} that provide bold +versions of both \texttt{cmtt} and \texttt{cmcsc} (the small caps font). With +modern \TeX{} distributions, one may bring these fonts into use simply +by placing them in an % ! line break +\Qref*{appropriate place in the \emph{texmf} tree}{Q-install-where} +(these are \AllTeX{}-specific files, so the ``\emph{public}'' supplier +would be an appropriate place). Once you've % ! line break, again +\Qref*{rebuilt the file indexes as necessary}{Q-inst-wlcf}, +\TeX{} (and friends) will automatically build whatever font files they +need when you first make reference to them. There's a jiffy package +\Package{bold-extra} that builds the necessary font data structures +so that you can use the fonts within \LaTeX{}. + +Another alternative is to use the \Qref*{\acro{EC} fonts}{Q-ECfonts}, +which come with bold variants of the small-caps fonts. + +If you need to use Type~1 fonts, you can't proceed with Knuth-style +fonts, since there are no Type~1 versions of the \Package{mf-extra} +set. There are, however, Type~1 distributions of the EC~fonts, so you +can switch to EC and use them; alternatives are discussed in +\Qref[question]{8-bit Type~1 fonts}{Q-type1T1}. + +Of course, commercial fixed-width fonts (even the default +\FontName{Courier}) almost always come with a bold variant, so that's +not a problem. Furthermore \Qref*{\acro{PSNFSS}}{Q-usepsfont} +will usually provide ``faked'' small caps fonts, and has no +compunctions about providing them in a bold form. \FontName{Courier} +is (as we all know, to our cost) freely available; a far more +presentable monospace font is \FontName{LuxiMono}, which is also +freely available (monospace text in the typeset version of this +\acro{FAQ} uses \FontName{LuxiMono}, with the metrics and \LaTeX{} +support available on the archive. +\begin{ctanrefs} +\item[bold-extra.sty]\CTANref{bold-extra} +\item[bold tt and small caps fonts]\CTANref{bold} +\item[\nothtml{\rmfamily}LuxiMono fonts]\CTANref{luximono} +\end{ctanrefs} + +\Question[Q-varwidth]{Automatic sizing of \environment{minipage}} + +The \environment{minipage} environment requires you to specify the +width of the ``page'' you're going to create. This is sometimes +inconvenient: you would like to occupy less space, if possible, but +\environment{minipage} sets a box that is exactly the width you +specified. + +The \Package{pbox} package defines a \csx{pbox} whose width is exactly +that of the longest enclosed line, subject to a maximum width that you +give it. So while \cmdinvoke{parbox}{2cm}{Hello\bsbs world!} produces a +box of width exactly \texttt{2cm}, +\cmdinvoke{pbox}{2cm}{Hello\bsbs world!} produces one whose width is +\texttt{1.79cm} (if one's using the default \FontName{cmr} font for the +text, at least). The package also provides a +\cmdinvoke*{settominwidth}[min]{length}{text} (which looks (almost) +like the standard \csx{settowidth} command), and a \csx{widthofpbox} +function analogous to the \csx{widthof} command for use with the +\Package{calc} package. + +The \Package{eqparbox} package extends \Package{pbox}'s idea, by +allowing you to set a series of boxes, all with the same (minimised) +width. (Note that it doesn't accept a limiting maximum width +parameter.) The package documentation shows the following example +drawn from a joke \emph{curriculum vitae}: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\noindent% +\eqparbox{place}% + {\textbf{Widgets, Inc.}} + \hfill +\eqparbox{title}% + {\textbf{Senior Widget Designer}} + \hfill +\eqparbox{dates}{\textbf{1/95--present}} + +... + +\noindent% +\eqparbox{place}% + {\textbf{Thingamabobs, Ltd.}} + \hfill +\eqparbox{title}% + {\textbf{Lead Engineer}} + \hfill +\eqparbox{dates}{\textbf{9/92--12/94}} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\noindent% +\eqparbox{place}{\textbf{Widgets, Inc.}} \hfill +\eqparbox{title}{\textbf{Senior Widget Designer}} \hfill +\eqparbox{dates}{\textbf{1/95--present}} + +... + +\noindent% +\eqparbox{place}{\textbf{Thingamabobs, Ltd.}} \hfill +\eqparbox{title}{\textbf{Lead Engineer}} \hfill +\eqparbox{dates}{\textbf{9/92--12/94}} +\end{verbatim} +\end{wideversion} +\end{quote} +The code makes the three items on each of the heading lines have +exactly the same width, so that the lines as a whole produce a regular +pattern down the page. A command \csx{eqboxwidth} allows you to use +the measured width of a group: the documentation shows how the command +may be used to produce sensible-looking columns that mix \texttt{c}-, +\texttt{r}- or \texttt{l}-rows, with the equivalent of a |p{...}| +entry, by making the fixed-width rows an \Package{eqparbox} group, and +making the last from a \csx{parbox} using the width that's been +measured for the group. + +The \Package{varwidth} package defines a \environment{varwidth} +environment which sets the content of the box to match a ``narrower +natural width'' if it finds one. (You give it the same parameters as +you would give \environment{minipage}: in effect, it is a `drop-in' +replacement.) \Package{Varwidth} provides its own ragged text command: +\csx{narrowragged}, which aims to make narrower lines and to put more +text in the last line of the paragraph (thus producing lines with more +nearly equal lengths than typically happens with \csx{raggedright} +itself). + +The documentation (in the package file) lists various restrictions and +things still to be done, but the package is already proving useful for +a variety of jobs. +\begin{ctanrefs} +\item[eqparbox.sty]\CTANref{eqparbox} +\item[pbox.sty]\CTANref{pbox} +\item[varwidth.sty]\CTANref{varwidth} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-hyp+pdf.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-hyp+pdf.tex new file mode 100644 index 00000000000..018157e04bf --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-hyp+pdf.tex @@ -0,0 +1,564 @@ +% $Id: faq-hyp+pdf.tex,v 1.1 2009/06/13 20:56:41 rf10 Exp rf10 $ + +\section{Hypertext and \acro{PDF}} + +\Question[Q-hyper]{Making hypertext documents from \TeX{}} + +If you want on-line hypertext with a \AllTeX{} source, probably on the +World Wide Web, there are four technologies to consider: +\begin{itemize} +\item Direct \Qref{\AllTeX{} conversion to \acro{HTML}}{Q-LaTeX2HTML}; +% beware line break +\item Use \Qref*{\Package{Texinfo}}{Q-texinfo}, + and use the \ProgName{info} viewer, or convert the \Package{texinfo} + to \acro{HTML}; +\item Use Adobe Acrobat, which will preserve your typesetting + perfectly + \Qref*{Making Acrobat \acro{PDF} documents from \LaTeX{}}{Q-acrobat}; +\item The hyper\TeX{} conventions (standardised \csx{special} + commands); there are supporting macro packages for \plaintex{} and + \LaTeX{}). +\end{itemize} + +The Hyper\TeX{} project extended the functionality of all the +\LaTeX{} cross-referencing commands (including the table of contents) +to produce \csx{special} commands which are parsed by \acro{DVI} processors +conforming to the Hyper\TeX{} guidelines; +it provides general hypertext links, including those +to external documents. + +The Hyper\TeX{} specification says that conformant viewers/translators +must recognize the following set of \csx{special} commands: +\begin{description} +\item[href:] |html:<a href = "href_string">| +\item[name:] |html:<a name = "name_string">| +\item[end:] |html:</a>| +\item[image:] |html:<img src = "href_string">| +\item[base\_name:] |html:<base href = "href_string">| +\end{description} + +The \emph{href}, \emph{name} and \emph{end} commands are used to do +the basic hypertext operations of establishing links between sections +of documents. + +Further details are available on \URL{http://arXiv.org/hypertex/}; there +are two commonly-used implementations of the specification, a +modified \ProgName{xdvi} and (recent releases of) +\ProgName{dvips}. Output from the latter may be used in recent +releases of \ProgName{ghostscript} or Acrobat Distiller. + +\Question[Q-acrobat]{Making Acrobat \acro{PDF} documents from \AllTeX{}} + +There are three general routes to \acro{PDF} output: Adobe's original +`distillation' route (via \PS{} output), conversion of a +\acro{DVI} file, and the use of a direct \acro{PDF} generator such as +\Qref*{\PDFTeX{}}{Q-whatpdftex}) or +MicroPress's V\TeX{} (which comes both as a % ! line break +\Qref*{commercial version}{Q-commercial} for Windows PCs, and as a +\Qref*{`free' version)}{Q-TeXsystems} for \acro{OS}/2 and Linux systems). + +For simple documents (with no hyper-references), you can either +\begin{itemize} +\item process the document in the normal way, produce \PS{} + output and distill it; +\item (on a Windows or Macintosh machine with the appropriate Adobe + tools installed) pass the output through the + \acro{PDF}writer in place of a printer driver (this route is a dead + end: the \acro{PDF}writer cannot create hyperlinks); +\item process the document in the normal way and generate \acro{PDF} + direct from the \acro{DVI} using + \ProgName{dvipdfm}/\ProgName{dvipdfmx}; or +\item process the document direct to \acro{PDF} with \PDFTeX{} or + V\TeX{}. \PDFTeX{} has + the advantage of availability for a wide range of platforms, V\TeX{} + (available commercially for Windows, or free of charge, but + unsupported, for Linux or \acro{OS/}2) has wider graphics + capability, dealing with encapsulated \PS{} and some in-line \PS{}. +\end{itemize} + +To translate all the \LaTeX{} cross-referencing into Acrobat +links, you need a \LaTeX{} package to suitably redefine +the internal commands. There are two of these for \LaTeX{}, both +capable of conforming to the +\Qref{Hyper\TeX{} specification}{Q-hyper}: +Heiko Oberdiek's \Package{hyperref}, and Michael Mehlich's +\Package{hyper}. (In practice, almost everyone uses +\Package{hyperref}; \Package{hyper} hasn't been updated since 2000.) +\Package{Hyperref} can often determine how it should generate +hypertext from its environment, but there is a wide set of +configuration options you can give via \csx{usepackage}. The package +can operate using \PDFTeX{} primitives, the hyper\TeX{} +\csx{special}s, or \acro{DVI} driver-specific \csx{special} commands. +Both \ProgName{dvips} and \YandY{}'s \acro{\ProgName{DVIPSONE}} can +translate the \acro{DVI} with these \csx{special} commands into +\PS{} acceptable to Distiller, and +\ProgName{dvipdfm} and \ProgName{dvipdfmx} have \csx{special} commands of +its own. + +If you use \plaintex{}, the \Qref*{\Eplain{} macros}{Q-eplain} can +help you create \acro{PDF} documents with hyper-references. +It can operate using \PDFTeX{} primitives, or \csx{special} commands +for the \ProgName{dvipdfm}/\ProgName{dvipdfmx} \acro{DVI} drivers. + +While there is no free implementation of all of \ProgName{Adobe} +\ProgName{Distiller}'s +functionality, any but the very oldest versions of \ProgName{Ghostscript} +provide pretty reliable distillation (but beware of the problems with +\Qref*{\ProgName{dvips} output for distillation}{Q-dvips-pdf}). + +For viewing (and printing) the resulting files, Adobe's +\ProgName{Acrobat} \ProgName{Reader} is available for a fair range of +platforms; for those for which Adobe's reader is unavailable, remotely +current versions of \ProgName{ghostscript} combined with +\ProgName{gv} or \ProgName{GSview} can display and print \acro{PDF} +files, as can \ProgName{xpdf}. + +In many circumstances, \ProgName{Ghostscript} combined with a viewer +application is actually preferable to Acrobat Reader. For example, on +Windows Acrobat Reader locks the \extension{pdf} file it's displaying: this +makes the traditional (and highly effective) \AllTeX{} development +cycle of ``Edit\arrowhyph{}Process\arrowhyph{}Preview'' become +rather clumsy~--- \ProgName{GSview} doesn't make the same +mistake. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Acrobat Reader]browse + \URL{ftp://ftp.adobe.com/pub/adobe/acrobatreader} +\item[dvipdfm]\CTANref{dvipdfm} +\item[dvipdfmx]\CTANref{dvipdfmx} +\item[ghostscript]Browse \CTANref{ghostscript} +\item[GSview]Browse \CTANref{gsview} +\item[gv]Browse \CTANref{gv} +\item[hyper.sty]\CTANref{hyper} +\item[hyperref.sty]\CTANref{hyperref} +\end{ctanrefs} + +\Question[Q-dvips-pdf]{Quality of \acro{PDF} from \PS{}} +\keywords{blurry fuzzy crippled} + +Any reasonable \PS{}, including any output of \ProgName{dvips}, may be +converted to \acro{PDF}, using (for example) a sufficiently recent +version of \ProgName{ghostscript}, Frank Siegert's (shareware) +\href{http://www.pstill.com/}{\ProgName{PStill}}, or Adobe's (commercial) +\ProgName{Distiller}. + +But, although the job may (almost always) be done, the results are +often not acceptable: the most frequent problem is bad presentation of +the character glyphs that make up the document. The following answers +offer solutions to this (and other) problems of bad presentation. +Issues covered are: +\begin{itemize} +\item \Qref*{Wrong type of fonts used}{Q-fuzzy-type3}, which is + the commonest cause of fuzzy text. +\item \Qref*{\ProgName{Ghostscript} too old}{Q-fuzzy-gs}, + which can also result in fuzzy text. +% beware line breaks +\item \Qref*{Switching to font encoding \acro{T}1 encoding}{Q-fuzzy-T1}, + which is yet another possible cause of fuzzy text. +\item Another problem~--- missing characters~--- arises from an + % beware line breaks + \Qref*{aged version of \ProgName{Adobe}~\ProgName{Distiller}}{Q-distill-prob}. +\item Finally, there's the common confusion that arises from using the + \ProgName{dvips} configuration file \texttt{-Ppdf}, the % ! line br + \Qref*{weird characters}{Q-charshift}. +\end{itemize} +It should be noted that \ProgName{Adobe} % \ProgName{Acrobat} no longer + % part of the name +\ProgName{Reader}~6 (released in mid-2003, and later versions) does +not exhibit the ``fuzziness'' that so many of the answers below +address. This is of course good news: however, it will inevitably be +a long time before every user in the world has this (or later) +versions, so the remedies below are going to remain for some time to +come. + +The problems are also discussed, with practical examples, in Mike +Shell's \Package{testflow} package, which these FAQs recommend as a +``\Qref*{specialised tutorial}{Q-tutbitslatex}. +\begin{ctanrefs} +\item[testflow]\CTANref{testflow} +\end{ctanrefs} + +\Question[Q-fuzzy-type3]{The wrong type of fonts in \acro{PDF}} +\keywords{crippled blurry} + +This is far the commonest problem: the symptom is that text in the +document looks ``fuzzy''. + +Most people use \ProgName{Adobe} \ProgName{Acrobat} \ProgName{Reader} +to view their \acro{PDF}: \ProgName{Reader} is distributed free of +charge, and is widely available, for all its faults. One of those +faults is its failure to deal with bitmap fonts (at least, in all +versions earlier than the recently released version~6). + +So we don't want bitmap fonts in our \PS{}: with them, characters show +up in \ProgName{Reader}'s display as blurred blobs which are often not +recognisable as the original letter, and are often not properly placed +on the line. Nevertheless, even now, most \TeX{} systems have +\ProgName{dvips} configured to use +\Qref*{\extension{pk} files}{Q-pk} in its output. Even +\PDFTeX{} will use \extension{pk} files if it can see no alternative for +a font in the document it is processing. + +Our remedy is to use +``\Qref*{Adobe Type~1}{Q-adobetypen}'' +versions of the fonts we need. Since Adobe are in the +business of selling Type~1 fonts, \ProgName{Reader} was of course made +to deal with them really rather well, from the very beginning. + +Of course, if your document uses nothing but fonts that came from +Adobe in the first place~--- fonts such as \FontName{Times} that +appear in pretty much every \PS{} printer, or such as Adobe +\FontName{Sabon} that you pay extra for~--- then there's no problem. + +But most people use \FontName{Computer} \FontName{Modern} to start +with, and even those relative sophisticates who use something as +exotic as \ProgName{Sabon} often find themselves using odd characters +from \acro{CM} without really intending to do so. Fortunately, rather +good versions of the \acro{CM} fonts are available from the \acro{AMS} +(who have them courtesy of % ! line break +\Qref{Blue Sky Research}{Q-commercial} and \YandY{}). + +Most modern systems have the fonts installed ready to use; and any +system installed less than 3~years ago has a \ProgName{dvips} +configuration file `\texttt{pdf}' that signals the use of the +\acro{CM} fonts, and also sets a few other parameters to improve +\ProgName{dvips}' output. Use this configuration as: +\begin{verbatim} + dvips -Ppdf myfile -o myfile.ps +\end{verbatim} +This may produce a warning message about failing to find the +configuration file: +\begin{verbatim} + dvips: warning: no config file for `pdf' +\end{verbatim} +or something similar, or about failing to find a font file: +\begin{verbatim} + dvips: ! Couldn't find header file cmr10.pfb +\end{verbatim} +Either of these failures signals that your +system doesn't have the fonts in the first place. + +A way of using the fonts that doesn't involve the sophistication of +the \texttt{-Ppdf} mechanism is simply to load maps: +\begin{verbatim} + dvips -Pcmz -Pamz myfile -o myfile.ps +\end{verbatim} +You may encounter the same warning messages as listed above. + +If your system does not have the fonts, it won't have the +configuration file either; however, it might have the configuration +file without the fonts. In either case, you need to +\Qref*{install the fonts}{Q-inst1cm}. + +\Question[Q-fuzzy-gs]{Fuzzy fonts because \ProgName{Ghostscript} too old} +\keywords{crippled blurry} + +So you've done everything the \acro{FAQ} has told you that you need, +correct fonts properly installed and appearing in the \ProgName{dvips} +output, but \emph{still} you get fuzzy character output after +distilling with \ProgName{ghostscript}. + +The problem could arise from too old a version of +\ProgName{ghostscript}, which you may be using directly, or via a +script such as \ProgName{ps2pdf} (distributed with +\ProgName{ghostscript} itself), \ProgName{dvipdf}, or similar. +Though \ProgName{ghostscript} was capable of distillation from +version~5.50, that version could only produce bitmap Type~3 output of +any font other than the fundamental 35~fonts (\FontName{Times}, +\FontName{Helvetica}, etc.). Later versions added `complete' +distillation, but it wasn't until version~6.50 that one could rely on +it for everyday work. + +So, if your \acro{PDF} output still looks fuzzy in \ProgName{Acrobat} +\ProgName{Reader}, upgrade \ProgName{ghostscript}. The new version +should be at least version~6.50, of course, but it's usually good +policy to go to the most recent version (version~8.12 at the time of +writing~--- 2003). + +\Question[Q-fuzzy-T1]{Fonts go fuzzy when you switch to \acro{T}1} +\keywords{crippled blurry} + +You've been having problems with hyphenation, and someone has +suggested that you should use ``\cmdinvoke{usepackage}[T1]{fontenc}'' +to help sort them out. Suddenly you find that your final \acro{PDF} +has become fuzzy. The problem may arise whether you are using \PS{} +output and then distilling it, or you are using \PDFTeX{} for the +whole job. + +In fact, this is the same problem as most others about the +\Qref*{quality of \acro{PDF}}{Q-dvips-pdf}: you've abandoned +your previous setup using Type~1 versions of the \acro{CM} fonts, and +\ProgName{dvips} has inserted Type~3 versions of the \acro{EC} fonts +into your document output. (See % beware line break +``\Qref*{Adobe font types}{Q-adobetypen} +for details of these font types; also, note that the font +\emph{encoding}~\acro{T}1 +has nothing directly to do with the font \emph{format}~Type~1). + +However, as noted in % beware line break +\htmlonly{``}\Qref[question]{8-bit Type~1 fonts}{Q-type1T1}\htmlonly{''}, +Type~1 versions of \acro{CM}-like fonts in \acro{T}1 (or equivalent) encoding +are now available, both as ``real'' fonts, and as virtual font sets. +One solution, therefore, is to use one of these alternatives. + +The alternative is to switch font family altogether, to something like +\FontName{Times} (as a no-thought default) or one of the many more pleasing +Adobe-encoded fonts. The default action of \Package{fontinst}, when +creating metrics for such a font, is to create settings for both \acro{OT}1 +and \acro{T}1 encodings, so there's little change in what goes on (at the +user level) even if you have switched to \acro{T}1~encoding when using the +fonts. + +\Question[Q-distill-prob]{Characters missing from \acro{PDF} output} + +If you're using \ProgName{Acrobat} \ProgName{Distiller} to create your +\acro{PDF} output, you may find +characters missing. This may manifest +itself as messed-up maths equations (missing +``\latexhtml{\ensuremath{-}}{-}'' signs, for example), or bits missing +from large symbols. Early versions of \ProgName{Distiller} used to +ignore character positions 0--31 and 128--159 of every font: Adobe's +fonts never use such positions, so why should \ProgName{Distiller}? + +Well, the answer to this question is ``because Adobe don't produce all +the world's fonts''~--- fonts like \FontName{Computer} +\FontName{Modern} were around before Adobe came on the scene, and +\emph{they} use positions 0--31. Adobe don't react to complaints like +that in the previous sentence, but they do release new versions of +their programs; and \ProgName{Distiller}, since at least version~4.0, +\emph{has} recognised the font positions it used to shun. + +Meanwhile, \TeX{} users with old versions of \ProgName{Distiller} need +to deal with their fonts. \ProgName{Dvips} comes to our aid: the +switch \texttt{-G1} (``remap characters''), which moves the offending +characters out of the way. The \acro{PDF} configuration file +(\texttt{-Ppdf}), recommended % beware line break +\latexhtml{above}{in ``\Qref{the wrong type of fonts}{Q-fuzzy-type3}''}, +includes the switch. + +The switch is not without its problems; pre-2003 versions of +\ProgName{dvips} will apply it to Adobe fonts as well, causing +\Qref*{havoc}{Q-charshift}, but fortunately +that problem is usually soluble. However, a document using both +\acro{CM} and Adobe-specified fonts is stuck. The only real solution +is either to upgrade \ProgName{dvips}, or to spend money to upgrade +\ProgName{Distiller}. + +\Question[Q-type1T1]{Finding `8-bit' Type~1 fonts} +\keywords{eight} + +Elsewhere, answers to these \acro{FAQ}s recommend that you use an +`8-bit' font to permit % line break!! +\Qref*{accentuation of inflected languages}{Q-hyphenaccents}, +and also recommend the use of Type~1 fonts to ensure that +you get \Qref*{good quality \acro{PDF}}{Q-fuzzy-type3}. These +recommendations used to be contradictory: one could not just +``switch'' from the free \acro{CM} fonts to free Cork- (or similarly) +encoded Type~1 fonts. The first approach that started to alleviate +these problems, was the development of virtual fonts that make +a good approach to the Cork encoding (see below). Now, however, we +have ``true'' Type~1 fonts available: as always, we have an +embarrassment of riches with three free alternatives, and one +commercial and one shareware version. + +\Package{CM-super} is an +auto-traced set which encompasses all of the \acro{T}1 and \acro{TS}1 +encodings as well as the \acro{T}2* series (the family of encodings +that cover languages based on Cyrillic alphabets). These fonts are +pretty easy to install (the installation instructions are clear), but +they are huge: don't try to install them if you're short of disc +space. + +\Package{CM-LGC} is a similar ``super-font'' set, but of much more +modest size; it covers \acro{T}1, \acro{TS}1 and \acro{T}2{A} +encodings (as does \Package{CM-super}, and also covers the \acro{LGR} +encoding (for typesetting Greek, based on Claudio Beccari's \MF{} +sources). \Package{CM-LGC} manages to be small by going to the +opposite extreme from \Package{CM-super}, which includes fonts at all +the sizes supported by the original \acro{EC} (a huge range); +\Package{CM-LGC} has one font per font shape, getting other sizes by +scaling. There is an inevitable loss of quality inherent in this +approach, but for the disc-space-challenged machine, \Package{CM-LGC} +is an obvious choice. + +\Package{Tt2001} is a simple scan of the \acro{EC} and \acro{TC} +fonts, and has some virtues~--- it's noticeably smaller than +\Package{CM-super} while being less stark than \Package{CM-LGC}. + +\Package{Latin} \Package{Modern} is produced using the +program \Qref*{\ProgName{MetaType1}}{Q-textrace}. The +\Package{Latin} \Package{Modern} set comes with \acro{T}1, \acro{TS}1 +\acro{LY}1 encoded variants (as well as a variant using the Polish +\acro{QX} encoding); for the glyph set it covers, its outlines seem +rather cleaner than those of \Package{CM-super}. \Package{Latin} +\Package{Modern} is more modest in its disc space demands than is +\Package{CM-super}, while not being nearly as stark in its range of +design sizes as is \Package{CM-LGC}~--- \Package{Latin} +\Package{Modern}'s fonts are offered in the same set of sizes as the +original \Package{CM} fonts. It's hard to argue with the choice: +Knuth's range of sizes has stood the test of time, and is one of the +bases on which the excellence of the \TeX{} system rests. + +\Qref*{Virtual fonts}{Q-virtualfonts} help us deal with the problem, +since they allow us to map ``bits of \acro{DVI} file'' to single +characters in the virtual font; so we can create an ``\'e'' character +by recreating the \acro{DVI} commands that would result from the code +``\csx{'}\texttt{e}''. However, since this involves two characters being +selected from a font, the arrangement is sufficient to fool +\ProgName{Acrobat} \ProgName{Reader}: you can't use the program's +facilities for searching for text that contains inflected characters, +and if you \emph{cut} text from a window that contains such a +character, you'll find something unexpected (typically the accent and +the `base' characters separated by a space) when you \ProgName{paste} +the result. However, if you can live with this difficulty, virtual +fonts are a useful and straightforward solution to the problem. + +There are two virtual-font offerings of \acro{CM}-based 8-bit +fonts~--- the \Package{ae} (``almost \acro{EC}'') and +\Package{zefonts} sets; the \Package{zefonts} set has wider coverage +(though the \Package{ae} set may be extended to offer guillemets by +use of the \Package{aeguill} package). Neither offers characters such +as \texttt{eth} and \texttt{thorn} (used in, for example, in +Icelandic), but the \Package{aecompl} package works with the +\Package{ae} fonts to provide the missing characters from the +\acro{EC} fonts (i.e., as bitmaps). + +The sole remaining commercial \acro{CM}-like 8-bit font comes from +Micropress, who offer the complete \acro{EC} set +in Type~1 format, as part of their range of outline versions of fonts +that were originally distributed in \MF{} format. See +\Qref[question]{``commercial distributions''}{Q-commercial}. + +The shareware % ! line break +\Qref*{BaKoMa \TeX{} distribution}{Q-TeXsystems} offers a +set of Type~1 \acro{EC} fonts, as an extra shareware option. (As far +as the present author can tell, these fonts are \emph{only} available +to users of BaKoMa \TeX{}: they are stored in an archive format that +seems not to be publicly available.) + +Finally, you can use one of the myriad text fonts available in Type~1 +format (with appropriate \acro{PSNFSS} metrics for \acro{T}1 encoding, +or metrics for some other 8-bit encoding such as \acro{LY}1). However, +if you use someone else's text font (even something as simple as +Adobe's Times family) you have to find a matching family of +mathematical fonts, which is a non-trivial undertaking~--- +\htmlonly{see }\Qref{``choice of scalable fonts''}{Q-psfchoice}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}ae fonts]\CTANref{ae} +\item[aecompl.sty]Distributed with \CTANref{ae} +\item[aeguill.sty]\CTANref{aeguill} +\item[\nothtml{\rmfamily}BaKoMa fonts]Browse \CTANref{bakoma-texfonts} +\item[\nothtml{\rmfamily}CM-LGC fonts]\CTANref{cm-lgc} +\item[\nothtml{\rmfamily}CM-super fonts]\CTANref{cm-super} (beware: + very large download) +\item[\nothtml{\rmfamily}Latin Modern fonts]\CTANref{lm} +\item[\nothtml{\rmfamily}tt2001 fonts]\CTANref{tt2001} +\item[\nothtml{\rmfamily}zefonts]\CTANref{zefonts} +\end{ctanrefs} + +\Question[Q-pkfix]{Replacing Type 3 fonts in \PS{}} + +One often comes across a \PS{} file generated by +\ProgName{dvips} which contains embedded \acro{PK} fonts; if you try +to generate \acro{PDF} from such a file, the quality will be poor. + +Of course, the proper solution is to regenerate the \PS{} file, +but if neither the sources nor the \acro{DVI} file are available, one +must needs resort to some sort of patching to replace the bitmap fonts +in the file by outline fonts. + +The program \ProgName{pkfix} (by Heiko Oberdiek) will do this +patching, for files created by ``not too old versions'' of +\ProgName{dvips}: it finds the fonts to be replaced by examining the +\PS{} comments \ProgName{dvips} has put in the file. For each +font, \ProgName{pkfix} puts appropriate \TeX{} commands in a file, +which it then processes and runs through \ProgName{dvips} (with switch +\texttt{-Ppdf}) to acquire an appropriate copy of the font; these copies are +then patched back into the original file. + +If your source file is older than \ProgName{pkfix} can deal with, +there's still a modicum of hope: \ProgName{pkfix-helper} examines the +bitmap fonts in a document, compares them with the metric +(\extension{tfm}) fonts on your system and comes to a view of which +font might be which. The program reports on ``poor'' matches, and +there are options for confirming, or replacing, its guesses. The +technique (which sounds implausible) is successful enough to be worth +a try. + +A further option is Frank Siegert's (shareware) +\href{http://www.pstill.com}{PStill}, which is capable of processing +the \PS{} it is distilling, and one option is to replace bitmap fonts +in the file with Type~1 versions. +\begin{ctanrefs} +\item[pkfix]\CTANref{pkfix} +\item[pkfix-helper]\CTANref{pkfix-helper} +\end{ctanrefs} + +\Question[Q-pdfpagelabels]{\Package{Hyperref} and repeated page numbers} + +The \Class{book} class (and its friends and relations) automatically +changes the display of page numbers in the frontmatter of the document +to lower-case roman. This is fine for human readers, but it confuses +\Package{hyperref} since there are pages which seem (to +\Package{hyperref}) to have the same page number. Fortunately, there are +configuration options to make \Package{hyperref} ``do the right +thing''. + +The two options in question are: +\begin{description} +\item[\pkgoption{plainpages=false}] Make page anchors using the + formatted form of the page number. With this option, + \Package{hyperref} writes different anchors for pages `ii' and `2'. + (If the option is set `\texttt{true}'~--- the default~--- + \Package{hyperref} writes page anchors as the arabic form of the + absolute page number, rather than the formatted form.) +\item[\pkgoption{pdfpagelabels}] Set \acro{PDF} page labels; i.e., + write the value of \csx{thepage} to the \acro{PDF} file so that + \Package{Acrobat Reader} can display the page number as (say) `ii (4 + of 40)' rather than simply `4 of 40'. +\end{description} +The two should be used whenever page numbering is not just +`1\texttt{..}\ensuremath{n}'; they may be used independently, but usually are not. + +The recipe isn't perfect: it relies on \csx{thepage} being different +for every page in the document. A common problem arises when there is +an unnumbered title page, after which page numbers are reset: the +\PDFTeX{} warning of ``\Qref*{duplicate destinations}{Q-hyperdupdest}'' +will happen in this case, regardless of the options. +\begin{ctanrefs} +\item[hyperref.sty]\CTANref{hyperref} +\end{ctanrefs} + +\Question[Q-srchpdf]{Searching \acro{PDF} files} + +In principle, you can search a \acro{PDF} file: the text of the file +is available to the viewer, and at least some viewers provide a search +facility. (It's not the fastest thing in the world, but it does help +in some circumstances.) + +However, there is a problem: the viewer wants to look at Unicode text, +but no ordinary \TeX{}-based system deals in Unicode text. +Fortunately for us Anglophones, this is is hardly ever a problem for +our text, since even Knuth's ``\acro{OT}1'' encoding matches ASCII (and hence +the lowest 128 characters of Unicode) for most things printable. +However, using the inflected characters of Continental European +languages, or anything that doesn't use a Latin alphabet, there is +potential for problems, since \TeX{}'s view of what a font is doesn't +map \acro{PDF}'s and the reader won't understand\dots{} + +\dots{} Unless you use the \Package{cmap} package with \PDFLaTeX{}, +that is. The package will instruct \PDFTeX{} to load character +maps into your \acro{PDF} for output fonts encoded according to the \acro{T}1 +(Western European Languages), T2A, T2B, or T2C (Cyrillic Languages), +or T5 (Vietnamese) encodings. If your document uses such encodings, +viewers that can search will use the maps to interpret what they find +in the file. + +Unfortunately, the package only works with fonts that are directly +encoded, such as the \FontName{cm-super} distribution. Fonts like Adobe +Times Roman (which are encoded for \AllTeX{} use via virtual fonts) +are not amenable to this treatment. +\begin{ctanrefs} +\item[cmap.sty]\CTANref{cmap} +\item[cm-super \nothtml{\rmfamily}fonts]\CTANref{cm-super} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex new file mode 100644 index 00000000000..56e9c5f6a7b --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex @@ -0,0 +1,934 @@ +% $Id: faq-install.tex,v 1.5 2009/09/01 06:53:22 rf10 Exp rf10 $ + +\section{Installing \AllTeX{} files} + +\Question[Q-installthings]{Installing things on a \AllTeX{} system} +\AliasQuestion{Q-instpackages} + +Installing (or replacing) things on your \AllTeX{} system has the +potential to be rather complicated; the following questions attempt to +provide a step-by-step approach, starting from the point where you've +decided what it is that you want to install: +\begin{itemize} +\item You must \Qref*{find the file you need}{Q-install-find}; +\item If you are going to install a \LaTeX{} package, you may need to + \Qref*{unpack the distributed files}{Q-install-unpack}; +\item It may be necessary to % ! line break + \Qref*{generate some documentation to read}{Q-install-doc}; +\item You need to % ! line break + \Qref*{decide where to install the files}{Q-install-where}; +\item You must now \Qref*{install the files}{Q-inst-wlcf}; and + finally +\item You may need to \Qref*{tidy up}{Q-inst-tidy} after the installation. +\end{itemize} + +\Question[Q-install-find]{Finding packages to install} + +How did you learn about the package? + +If the information came from these \acro{FAQ}s, you should already +have a link to the file (there are lists at the end of each answer): +\begin{narrowversion} + make a browser link from \URL{http://mirror.ctan.org/} and the text + in the list; if the link returns a directory listing, you can + generally retrieve the whole directory by appending the link with + \extension{zip} +\end{narrowversion} +\begin{wideversion} + click on one of the links associated with the package, and you can + get the package (which may be one file or several). +% need searate wording for pdfversion and htmlversion, here +\end{wideversion} + +If you heard about the file somewhere else, it's possible that the +source told you where to look; if not, try the \acro{CTAN} searching +facilities, such as \URL{http://www.tex.ac.uk/search/}. That (rather +simple) search engine can return data from a search of the CTAN +catalogue (which covers most useful packages), or data from a search +of the names of files on the archive. + +Packages come in a variety of different styles of distribution; the +very simplest will actually offer just \File{package.sty}~--- in this +case, just download the file and % ! line break +\Qref*{get on with installation}{Q-inst-wlcf}. + +Normally, though, you will want \File{foo.sty} but that file is distributed +in a \LaTeX{} documented source file \File{foo.dtx}; thus you should +search just for \emph{foo}~--- \File{foo.sty} won't be visible +anywhere on the archive or in the catalogue. + +Since most packages are distributed in this +\extension{dtx}/\extension{ins} way, they usually occupy their own +directory on the archive. Even if that directory contains other +packages, you should download everything in the directory: as often as +not, packages grouped in this way depend on each other, so that you +really \emph{need} the other ones. + +Having acquired the package distribution, % ! line break +``\Qref*{unpacking \LaTeX{} packages}{Q-install-unpack}'' outlines +your next step. + +\Question[Q-install-unpack]{Unpacking \LaTeX{} packages} + +As discussed \Qref*{elsewhere}{Q-dtx}, the `ordinary' way to +distribute a \LaTeX{} package is as a pair of files \File{package.dtx} +and \File{package.ins}. If you've acquired such a pair, you simply +process \File{package.ins} with \LaTeX{}, and the files will appear, +ready for installation. + +Other sorts of provision should ordinarily be accompanied by a +\File{README} file, telling you what to do; we list a few example +configurations. + +Sometimes, a directory comes with a bunch of \extension{dtx} files, but +fewer (often only one) \extension{ins} files (\LaTeX{} itself comes +looking like this). If there is more than one \extension{ins} file, +and in the absence of any instruction in the \File{README} file, simply +process the \extension{ins} file(s) one by one. + +If you're missing the \File{package.ins} altogether, you need to play +around until something works. Some \extension{dtx} files are +``self-extracting''~--- they do without an \extension{ins} file, and once +you've processed the \File{package.dtx}, \File{package.sty} has +automagically appeared. Various other oddities may appear, but the +archivists aim to have \File{README} file in every package, which +should document anything out of the ordinary with the distribution. + +\Question[Q-install-doc]{Generating package documentation} + +We are faced with a range of ``normal'' provision, as well as several +oddities. One should note that documentation of many packages is +available on \acro{CTAN}, without the need of any further effort by +the user~--- such documentation can usually be browsed \emph{in situ}. + +However, if you find a package that does not offer documentation on +the archive, or if you need the documentation in some other format +than the archive offers, you can usually generate the documentation +yourself from what you download from the archive. + +The standard mechanism, for \LaTeX{} packages, is simply to run +\LaTeX{} on the \File{package.dtx} file, as you would any ordinary +\LaTeX{} file (i.e., repeatedly until the warnings go away). + +A variant is that the unpacking process provides a file +\File{package.drv}; if such a thing appears, process it in preference +to the \File{package.dtx} (it seems that when the documented \LaTeX{} +source mechanism was first discussed, the \File{.drv} mechanism was +suggested, but it's not widely used nowadays). + +Sometimes, the \LaTeX{} run will complain that it can't find +\File{package.ind} (the code line index) and/or \File{package.gls} +(the list of change records, not as you might imagine, a glossary). +Both types of file are processed with special \ProgName{makeindex} +style files; appropriate commands are: +\begin{quote} +\begin{verbatim} +makeindex -s gind package +makeindex -s gglo -o package.gls package.glo +\end{verbatim} +\end{quote} +This author finds that the second (the change record) is generally of +limited utility when reading package documentation; it is, however, +valuable if you're part of the package development team. If you don't +feel you need it, just leave out that step + +Another common (and reasonable) trick performed by package authors is +to provide a separate file \File{package-doc.tex} or even simply +\File{manual.tex}; if the file \File{package.dtx} doesn't help, simply +look around for such alternatives. The files are treated in the same +way as any ``ordinary'' \LaTeX{} file. + +\Question[Q-inst-wlcf]{Installing files ``where \AllTeX{} can find them''} +\AliasQuestion{Q-wherefiles} + +In the past, package documentation used always to tell you to put your +files ``where \LaTeX{} can find them''; this was always unhelpful~--- +if you knew where that \emph{was}, you didn't need telling, but if you +\emph{didn't} know, you were completely stuck. + +It was from this issue that the whole idea of the \acro{TDS} sprang; +``where to put'' questions now come down to ``where's the \acro{TDS} +tree?''. + +We therefore answer the question by considering: +\begin{itemize} +\item \Qref*{what tree to use}{Q-what-TDS}, and +\item \Qref*{where in the tree to put the files}{Q-install-where}. +\end{itemize} + +Once we know the answer to both questions, and we've created any +directories that are needed, we simply copy files to their rightful +location. + +This has done what the old requirement specified: \LaTeX{} (or +whatever) \emph{can} (in principle) find the files. However, in order +that the software \emph{will} find the files, we need to update an +index file. + +On a \miktex{} system, open the window + \texttt{Start}\arrowhyph{}% + \texttt{All Programs}\arrowhyph{}% + \texttt{\miktex{} \meta{version}}\arrowhyph{}% + \texttt{Settings}, +and click on \texttt{Refresh FNDB}. +The job may also be done in a command window, using the command: +\begin{quote} +\begin{verbatim} +initexmf --update-fndb +\end{verbatim} +\end{quote} +The % ! line break +\href{http://docs.miktex.org/manual/initexmf.html}{\miktex{} documentation} +gives further details about \texttt{initexmf}. + +On a te\TeX{} or \texlive{}-based system, use the command +\texttt{texhash} (or if that's not available, \texttt{mktexlsr}~--- +they ought to be different names for the same program). + +Having done all this, the new package will be available for use. + +\Question[Q-what-TDS]{Which tree to use} + +In almost all cases, new material that you install should go into the +``local'' tree of your \AllTeX{} installation. (A discussion of +reasons \emph{not} to use the local tree appears below.) + +On a Unix(-alike) system, using te\TeX{} or \texlive{}, the root +directory will be named something like \path{/usr/share/texmf-local/} +or \path{/usr/local/share/texmf/} +You can ask such a system where it believes a local tree should be: +\begin{quote} +\begin{verbatim} +kpsewhich -expand-var "\$TEXMFLOCAL" +\end{verbatim} +\end{quote} +the output being the actual path, for example (on the workstation the +author is using today): +\begin{quote} +\begin{verbatim} +/usr/local/share/texmf +\end{verbatim} +\end{quote} + +In a \miktex{} installation, the location will in fact typically be +something you specified yourself when you installed \miktex{} in the +first place, but you may find you need to create one. The \miktex{} +``Settings'' window (% + \texttt{Start}\arrowhyph{}% + \texttt{Programs}\arrowhyph{}% + \texttt{\miktex{}}\arrowhyph{}% + \texttt{Settings}) +has a tab ``\texttt{Roots}''; that tab gives a list of current +\acro{TDS} roots (they're typically not called +\texttt{texmf}-anything). If there's not one there with +``\texttt{local}'' in its name, create an appropriate one (see below), +and register it using the window's +``\texttt{Add}'' button. + +The % ! line break +\href{http://docs.miktex.org/faq/maintenance.html}{\miktex{} \acro{FAQ}} +suggests that you should create % ! line break +``\texttt{C:\textbackslash Local TeX Files}'', which is good if you +manage your own machine, but often not even possible in corporate, or +similar, environments~--- in such situations, the user may have no +control over the hard disc of the computer, at all. + +So the real criterion is that your local tree should be somewhere that +\emph{you}, rather than the system, control. Restrictive systems often +provide a ``home directory'' for each user, mounted as a network +drive; this is a natural home for the user's local tree. Other (often +academic) environments assume the user is going to provide a memory +stick, and will assign it a defined drive letter~--- another good +candidate location. Note that the semantics of such a tree are +indistinguishable from those of a % ! line break +\Qref*{``home'' \acro{TEXMF} tree}{Q-privinst}. + +There are circumstances when you might not wish to use the `local' tree: +\begin{itemize} +\item if the package, or whatever, is ``personal'' (for example, + something commercial that has been licensed to you alone, or + something you're developing yourself), it should go in your + \Qref*{``home'' \acro{TEXMF} tree}{Q-privinst}; +\item if you \emph{know} that the package you are installing is a + replacement for the copy on the \acro{TEXMF} tree of your \AllTeX{} + distribution, you should replace the existing copy in the + \acro{TEXMF} tree. +\end{itemize} +The reason one would put things on a local tree is to avoid their +disappearance if the system is upgraded (or otherwise re-installed). + +The reason one might place upgrades the distribution's main tree is to +avoid confusion. Suppose you were to place the file on the local +tree, and then install a new version of the distribution~--- you might +have an effect like: +\begin{itemize} +\item distribution comes with package version \ensuremath{n}; +\item you install package version \ensuremath{n+1} on the local tree; and +\item the updated distribution provides package version \ensuremath{n+2}. +\end{itemize} +In such a situation, you will find yourself using version +\ensuremath{n+1} (from the local tree) \emph{after} the new +distribution has been installed. + +If you install in the local tree, the only way to avoid such problems +is to carefully purge the local tree when installing a new +distribution. This is tedious, if you're maintaining a large +installation. + +\Question[Q-install-where]{Where to install packages} + +We assume here that you have decided what tree to put your files in, +after reading % ! line break +``\Qref*{choosing a \acro{TDS} tree}{Q-what-TDS}''. We will therefore +write \texttt{\$TEXMF} for it, and you need to substitute the tree +you decided on. + +The basic idea is to imitate the directory structure in your +existing tree(s). Here are some examples of where various sorts of +files should go: +\begin{quote} +\begin{verbatim} +.sty, .cls or .fd: $TEXMF/tex/<format>/<package>/ +.mf: $TEXMF/fonts/source/<supplier>/<font>/ +.tfm: $TEXMF/fonts/tfm/<supplier>/<font>/ +.vf: $TEXMF/fonts/vf/<supplier>/<font>/ +.afm: $TEXMF/fonts/afm/<supplier>/<font>/ +.pfb: $TEXMF/fonts/type1/<supplier>/<font>/ +.ttf: $TEXMF/fonts/truetype/<supplier>/<font>/ +.otf: $TEXMF/fonts/opentype/<supplier>/<font>/ +.pool, .fmt, .base or .mem: $TEXMF/web2c +\end{verbatim} +\end{quote} +and for modern systems (those distributed in 2005 or later, using \acro{TDS} +v1.1 layouts): +\begin{quote} +\begin{verbatim} +.map: $TEXMF/fonts/map/<syntax>/<bundle>/ +.enc: $TEXMF/fonts/enc/<syntax>/<bundle>/ +\end{verbatim} +\end{quote} +(Map and encoding files went to directories under +\File{$TEXMF/dvips/}, in earlier distributions.) + +In the lists above \meta{format} identifies the format the macros +are designed for~--- it can be things such as \texttt{plain}, +\texttt{generic} (i.e., any format), \texttt{latex} or +\texttt{context} (or several less common formats). + +For fonts, \meta{font} refers to the font family (such as \texttt{cm} +for Knuth's Computer Modern, \texttt{times} for Adobe's Times Roman). +The supplier is usually obvious~--- the supplier +``public'' is commonly used for free fonts. + +The \meta{syntax} (for \extension{map} and \extension{enc} files) is a +categorisation based on the way the files are written; candidates are +names of programs such as \ProgName{dvips} or \ProgName{pdftex}. + +``Straight'' \AllTeX{} input can take other forms than the +\extension{sty}, \extension{cls} or \extension{fd} listed above, too +(apart from the `obvious' \extension{tex}). Examples are (the +obvious) \extension{tex}, \extension{lfd} for \Package{babel} language +definitions, \extension{sto} and \extension{clo} for package and class +options, \extension{cfg} for configuration information, +\extension{def} for variants (such as the types of devices +\Package{graphics} drives). The \File{README} of the package should +tell you of any others, though sometimes that information is printed +when the package's \Qref*{comments are stripped}{Q-install-unpack}. +All of these files should live together with the main package files. + +Note that \meta{font} may stand for a single font or an entire family: +for example, files for all of Knuth's Computer Modern fonts are to be +found in \texttt{.../public/cm}, with various prefixes as appropriate. + +The font ``supplier'' \emph{public} is a sort of hold-all for +``free fonts produced for use with \AllTeX{}'': as well as Knuth's +fonts, \emph{public}'s directory holds fonts designed by others +(originally, but no longer exclusively, in \MF{}). + +Documentation for each package should all go, undifferentiated, into a +directory on the \path{doc/} subtree of the \acro{TDS}. The layout of +the subtree is slightly different: \path{doc/latex} hosts all +\LaTeX{} documentation directories, but more fundamental things are +covered, e.g., by \path{doc/etex} or \path{doc/xetex}. + +\Question[Q-inst-tidy]{Tidying up after installation} + +There's not usually a lot to do after you've completed the steps +above~--- indeed, if you're merely installed files direct from the +archive, or whatever, there will be precisely nothing left, by way of +debris. + +Things you might care to clean up are: +\begin{itemize} +\item the archive file, if you retrieved your data from the archive + as a \extension{zip} file, or the like; +\item the \extension{dtx} and \extension{ins} files, if you chose not + to install them with the documentation; and +\item the \extension{aux}, \extension{log}, \extension{idx}, etc., + from building the documentation. +\end{itemize} +A simple way of achieving all this is to download to a working +directory that was created for the purpose, and then to delete that +directory and all its contents after you've finished installing. + +\Question[Q-inst-scut]{Shortcuts to installing files} +\AliasQuestion{Q-inst-miktex} + +There are circumstances in which most of the fuss of installation can +be bypassed: +\begin{itemize} +\item If you are a \miktex{} user, the +\begin{wideversion} + \Qref{\miktex{} package management system}{Q-inst-miktex*} + can usually help; +\end{wideversion} +\begin{narrowversion} + \miktex{} package management system can usually help + (\Qref{}{Q-inst-miktex*}); +\end{narrowversion} +\item The package you want may already exist as a \acro{ZIP} file +\begin{wideversion} + formatted for \Qref{direct installation}{Q-inst-tds-zip}. +\end{wideversion} +\begin{narrowversion} + formatted for direct installation (\Qref{}{Q-inst-tds-zip}). +\end{narrowversion} +\end{itemize} + +\Question[Q-inst-miktex*]{Installation using \miktex{} package manager} + +Packages for use with \miktex{} are maintained very efficiently by the +project managers (new packages and updates on \acro{CTAN} ordinarily +make their way to the \miktex{} package repository within a week). +Thus it makes sense for the \miktex{} user to take advantage of the +system rather than grinding through the steps of installation. + +\miktex{} maintains a database of packages it ``knows about'', +together with (coded) installation instructions that enable it to +install the packages with minimal user intervention; you can update +the database over the internet. + +If \miktex{} does know about a package you need installed, it's worth +using the system: +first, open the \miktex{} packages window: click on + \texttt{Start}\arrowhyph{}% + \texttt{Programs}\arrowhyph{}% + \texttt{MiKTeX}\arrowhyph{}% + \texttt{MiKTeX Options}, and select the + \texttt{Packages} tab. + +On the tab, there is an Explorer-style display of packages. +Right-click on the root of the tree, ``\texttt{MiKTeX Packages}'', +and select ``\texttt{Search}'': enter the name of the package you're +interested in, and press the ``\texttt{Search}'' button. If +\miktex{} knows about your package, it will open up the tree to show +you a tick box for your package: check that box. + +If you prefer a command-line utility, there's \ProgName{mpm}. Open a +command shell, and type: +\begin{quote} +\begin{verbatim} +mpm --install=<package> +\end{verbatim} +\end{quote} +(which of course assumes you know the name by which \miktex{} refers to +your package). + +\Question[Q-inst-tds-zip]{Installing using ready-built \acro{ZIP} files} + +Installing packages, as they (``traditionally'') appear on +\acro{CTAN}, involves: +\begin{itemize} +\item identifying where to put the various files on an \acro{TDS} + tree, +\item installing them, and +\item a few housekeeping operations. +\end{itemize} +Most people, for most packages, find the first two steps onerous, the +last being easy (unless it is forgotten!). + +Ready-built \acro{ZIP} files~--- also known as % ! line break +\Qref*{\acro{TDS}-\acro{ZIP} files}{Q-tds-zip}~--- are designed to lighten +the load of performing the first two steps of installation: they +contain all the files that are that's to be installed for a given +package, in their ``correct'' locations in a % ! line break +\Qref*{\acro{TDS} tree}{Q-tds}. + +To install such a file on a Unix system (we assume that you'll install +into the local \acro{TEXMF} tree, at \texttt{\$TEXMFLOCAL}): +\begin{quote} +\begin{verbatim} +cd $TEXMFLOCAL +unzip $package.tds.zip +\end{verbatim} +\end{quote} + +On a Windows system that is modern enough that it has a built-in +\acro{ZIP} unpacker, simply double-click on the file, and browse to +where it's to be unpacked. (We trust that those using earlier +versions of Windows will already have experience of using +\ProgName{WinZIP} or the like.) + +Having unpacked the \extension{zip} archive, in most cases the only +remaining chore is to update the file indexes~--- as in % ! line break +\Qref*{normal installation instructions}{Q-inst-wlcf}. However, if +the package provides a font, you also need to enable the font's map, +which is discussed in % ! line break +``\Qref*{Installing a Type~1 font}{Q-instt1font}'' + +\Question[Q-tempinst]{``Temporary'' installation of \AllTeX{} files} + +Operating systems and applications need to know where to find files: +many files that they need are ``just named''~--- the user doesn't +necessarily know \emph{where} they are, but knows to ask for them. +The commonest case, of course, is the commands whose names you type to +a shell (yes, even Windows' ``\MSDOS{} prompt'') are using a shell to read what +you type: many of the commands simply involve loading and executing a +file, and the \texttt{PATH} variable tells the shell where to find those files. + +Modern \TeX{} implementations come with a bunch of search paths +built in to them. In most circumstances these paths are adequate, but +one sometimes needs to extend them to pick up files in strange +places: for example, we may wish to try a new bundle of packages +before \Qref*{installing them `properly'}{Q-installthings}. To do +this, we need to change the relevant path as \TeX{} perceives it. +However, we don't want to throw away \TeX{}'s built-in path (all of a +sudden, \TeX{} won't know how to deal with all sorts of things). + +To \emph{extend} a \TeX{} path, we define an operating system +environment variable in `path format', but leaving a gap which \TeX{} +will fill with its built-in value for the path. The commonest case is +that we want to place our extension in front of the path, so that our +new things will be chosen in preference, so we leave our `gap to be +filled' at the end of the environment variable. The syntax is simple +(though it depends which shell you're actually using): so on a +Unix-like system, using the \ProgName{bash} shell, the job might be +done like: +\begin{verbatim} + export TEXINPUTS=/tmp: +\end{verbatim} +while in a Windows system, within a \MSDOS{} window, it would be: +\begin{verbatim} + set TEXINPUTS=C:/temp; +\end{verbatim} +In either case, we're asking \TeX{} to load files from the root disc +temporary files directory; in the Unix case, the ``empty slot'' is +designated by putting the path separator `|:|' on its own at the end +of the line, while in the Windows case, the technique is the same, but +the path separator is `|;|'. + +Note that in either sort of system, the change will only affect +instances of \TeX{} that are started from the shell where the +environment variable was set. If you run \TeX{} from another window, +it will use the original input path. To make a change of input path +that will ``stick'' for all windows, set the environment variable in +your login script or profile (or whatever) in a Unix system and log +out and in again, or in \File{autoexec.bat} in a Windows system, and +reboot the system. + +While all of the above has talked about where \TeX{} finds its macro +files, it's applicable to pretty much any sort of file any +\TeX{}-related program reads~--- there are lots of these paths, and of +their corresponding environment variables. In a +\ProgName{web2c}-based system, the copious annotations in the +\File{texmf.cnf} system configuration file help you to learn which +path names correspond to which type of file. + +\Question[Q-privinst]{``Private'' installations of files} + +It sometimes happens that you need a new version of some macro package +or font, but that the machine you use is maintained by someone who's +unwilling to update and won't give you privileges to do the job +yourself. A \Qref*{``temporary'' installation}{Q-tempinst} is +sometimes the correct approach, but if there's the slightest chance +that the installation will be needed on more than one project, +temporary installations aren't right. + +In circumstances where you have plenty of quota on backed-up media, or +adequate local scratch space, the correct approach is to create a +private installation of \AllTeX{} which includes the new stuff you +need; this is the ideal, but is not generally possible. + +So, since you can't install into the public \texttt{texmf} tree, you +have to install into a \File{texmf} tree of your own; fortunately, the +\acro{TDS} standard allows for this, and modern distributions allow +you to do it. The most modern distributions refer to the tree as +\texttt{\$TEXMFHOME}, but it used to be called \texttt{\$HOMETEXMF}; +so to check that your \TeX{} system does indeed support the mechanism +you should start with +\begin{verbatim} +kpsewhich -expand-var "\$TEXMFHOME" +\end{verbatim} + +If you can confirm that the technique does indeed work, install your +new package (or whatever) in the \Qref*{correct place}{Q-install-where} +in a tree based on \File{$HOME/texmf}, and generate an index of that +tree +\begin{quote} +\begin{verbatim} +texhash $HOME/texmf +\end{verbatim} +\end{quote} +(the argument specifies which tree you are indexing: it's necessary +since you don't, by hypothesis, have access to the main tree, and +\ProgName{texhash} without the argument would try to write the main +tree. + +There are two wrinkles to this simple formula: first, the installation +you're using may \emph{not} define a home TEXMF directory, and second, +there may be some obstruction to using \File{$HOME/texmf} as the +default name. In either case, a good solution is to have your own +\File{texmf.cnf}~--- an idea that sounds more frightening that it +actually is. The installation's existing file may be located with the +command: +\begin{quote} +\begin{verbatim} +kpsewhich texmf.cnf +\end{verbatim} +\end{quote} +Take a copy of the file and put it into a directory of your own; this +could be any directory, but an obvious choice is the \File{web2c} +directory of the tree you want to create, i.e., +\File{$HOME/texmf/web2c} or the like. Make an environment variable to +point to this directory: +\begin{quote} +\begin{verbatim} +TEXMFCNF=$HOME/texmf/web2c +export TEXMFCNF +\end{verbatim} +\end{quote} +(for a Bourne shell style system), or +\begin{quote} +\begin{verbatim} +setenv TEXMFCNF $HOME/texmf/web2c +\end{verbatim} +\end{quote} +(for a C-shell style system). Now edit the copy of \File{texmf.cnf} + +There will be a line in the existing file that defines the tree where +everything searches; the simplest form of the line is: +\begin{quote} +\begin{verbatim} +TEXMF = !!$TEXMFMAIN +\end{verbatim} +\end{quote} +but, there are likely to be several alternative settings behind +comment markers (``\texttt{\textpercent}''), and the person who +installed your system may have left them there. Whatever, you need to +modify the line that's in effect: change the above to three lines: +\begin{quote} +\begin{verbatim} +HOMETEXMF = $HOME/texmf +TEXMF = {$HOMETEXMF,!!$TEXMFMAIN} +% TEXMF = !!$TEXMFMAIN +\end{verbatim} +\end{quote} +the important point being that \texttt{\$HOMETEXMF} must come before +whatever was there before, inside the braces. For example, if the +original was +\begin{quote} +\begin{verbatim} +TEXMF = {!!$LOCALTEXMF,!!$TEXMFMAIN} +\end{verbatim} +\end{quote} +it should be converted to: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +HOMETEXMF = $HOME/texmf +TEXMF = {$HOMETEXMF,!!$LOCALTEXMF, + !!$TEXMFMAIN} +% TEXMF = {!!$LOCALTEXMF,!!$TEXMFMAIN} +\end{verbatim} +{\small Note that the \texttt{TEXMF} line is only wrapped to make it + fit in the column; there should be no line break or space between + the final comma on the line and the \texttt{!!} on the next line.\par +}% +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +HOMETEXMF = $HOME/texmf +TEXMF = {$HOMETEXMF,!!$LOCALTEXMF,!!$TEXMFMAIN} +% TEXMF = {!!$LOCALTEXMF,!!$TEXMFMAIN} +\end{verbatim} +\end{wideversion} +\end{quote} +(retaining the original, as a comment, is merely an aide-memoir in +case you need to make another change, later). The \texttt{!!} signs +tell the file-searching library that it should insist on a +\ProgName{texhash}-ed directory tree; if you can count on yourself +remembering to run \ProgName{texhash} on your new tree every time you +change it, then it's worth adding the marks to your tree: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +TEXMF = {!!$HOMETEXMF,!!$LOCALTEXMF, + !!$TEXMFMAIN} +\end{verbatim} +{\small Note that the line is only wrapped to make it + fit in the column; there should be no line break or space between + the final comma on the line and the \texttt{!!} on the next line.\par +}% +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +TEXMF = {!!$HOMETEXMF,!!$LOCALTEXMF,!!$TEXMFMAIN} +\end{verbatim} +\end{wideversion} +\end{quote} +as this will make \AllTeX{} find its files marginally faster. + +Having made all these changes, \AllTeX{} should ``just use'' files in +your new tree, in preference to anything in the main tree~--- you can +use it for updates to packages in the main tree, as well as for +installing new versions of things. + +\Question[Q-instfont]{Installing a new font} + +Fonts are really ``just another package'', and so should be installed +in the same sort of way as packages. However, fonts tend to be more +complicated than the average package, and as a result it's sometimes +difficult to see the overall structure. + +Font files may appear in any of a large number of different formats; +each format has a different function in a \TeX{} system, and each is +stored in a directory its own sub-tree in the installation's +\acro{TDS} tree; all these sub-trees have the directory +\File{$TEXMF/fonts} as their root. A sequence of answers% +\nothtml{, below,} describes the installation of fonts\latexhtml{.}{:} +\begin{htmlversion} +follow the list through the ``next question'' links at the bottom of +this answer to view them all. +\end{htmlversion} +Other answers discuss specific font families~--- for example, +% ! line break +``\Qref*{using the concrete fonts}{Q-concrete}''. + +\Question[Q-instmffont]{Installing a font provided as \MF{} source} + +Metafont fonts are (by comparison with other sorts of font) rather +pleasingly simple. Nowadays, they are mostly distributed just as the +\MF{} source, since modern \TeX{} distributions are able to produce +everything the user needs ``on the fly''; however, if the distribution +\emph{does} include \acro{TFM} files, install them too, since they +save a little time and don't occupy much disc space. Always distrust +distributions of \acro{PK} font bitmap files: there's no way of +learning from them what printer they were generated for, and naming +schemes under different operating systems are another source of +confusion. + +``\Qref*{Where to install files}{Q-install-where}'' +specifies where the files should go. + +Further confusion is introduced by font families whose authors devise rules +for automatic generation of \MF{} sources for generating fonts at +particular sizes; the installation has to know about the rules, as +otherwise it cannot generate font files. + +\Question[Q-instprinterfont]{Installing a \PS{} printer built-in font} + +There is a ``standard'' set of fonts that has appeared in every \PS{} +printer since the second generation of the type. These fonts +(8~families of four text fonts each, and three special-purpose fonts) +are of course widely used, because of their simple availability. The +set consists of: +\begin{itemize} +\item \FontName{Times} family (4 fonts) +\item \FontName{Palatino} family (4 fonts) +\item \FontName{New} \FontName{Century} \FontName{Schoolbook} family (4 fonts) +\item \FontName{Bookman} family (4 fonts) +\item \FontName{Helvetica} family (4 fonts) +\item \FontName{Avant} \FontName{Garde} (4 fonts) +\item \FontName{Courier} family (4 fonts) +\item \FontName{Utopia} family (4 fonts) +\item Zapf \FontName{Chancery} (1 font) +\item Zapf \FontName{Dingbats} (1 font) +\item \FontName{Symbol} (1 font) +\end{itemize} +All these fonts are supported, for \LaTeX{} users, by the +\Package{psnfss} set of metrics and support files in the file +\File{lw35nfss.zip} on \acro{CTAN}. Almost any remotely modern \TeX{} +system will have some version of \Package{psnfss} installed, but +users should note that the most recent version has much improved +coverage of maths with \FontName{Times} (see package +\Package{mathptmx}) and with \FontName{Palatino} (see package +\Package{mathpazo}, as well as a more reliable set of font metrics. + +The archive \File{lw35nfss.zip} is laid out according to the +\acro{TDS}, so in principle, installation consists simply of +``unzipping'' the file at the root of a \path{texmf} tree. + +Documentation of the \Package{psnfss} bundle is provided in +\File{psnfss2e.pdf} in the distribution. +\begin{ctanrefs} +\item[mathpazo.sty]Part of the \Package{psnfss} bundle +\item[mathptmx.sty]Part of the \Package{psnfss} bundle +\item[psnfss \nothtml{\rmfamily}bundle]\CTANref{psnfss} +\end{ctanrefs} + +\Question[Q-prept1font]{Preparing a Type~1 font} + +The process of installing a Type~1 font set is rather convoluted, and +we will deal with it in two chunks: first (in the present answer) +preparing the font for installation, and second % ! line break +\Qref*{installing a Type~1 font}{Q-instt1font}). + +Many fonts are supplied in \AllTeX{} ready form: such fonts need no +preparation, and may be installed immediately. + +However, if you purchase a font from a Type foundry (either direct or +via one of the web stores), you are likely to need to `prepare' it for +use with \AllTeX{}. The rest of this answer discusses this preparation. +\begin{itemize} +\item Acquire the font. A very small set of Type~1 fonts is installed + in most \PS{} printers you will encounter. For those few (whose use + is covered by the basic \acro{PSNFSS} package), you don't need the + Type~1 font itself, to be able to print using the font. + + For all the myriad other Type~1 fonts, to be able to print using + the font you need the Type~1 file itself. Some of these are + available for free (they've either been donated to the public + domain, or were developed as part of a free software project), but + the vast majority are commercial products, requiring you to spend + real money. +\item Acquire the fonts' \acro{AFM} files. \acro{AFM} files contain + information from the font foundry, about the sizes of the characters + in the font, and how they fit together. One measure of the quality + of a font-supplier is that they provide the \acro{AFM} files by + default: if the files are not available, you are unlikely to be able + to use the font with \AllTeX{}. +\item Rename the \acro{AFM} files and the Type~1 files to match the + \Qref*{Berry font naming scheme}{Q-fontname}. +\item Generate \TeX{} metric files from the \acro{AFM} files. The + commonest tool for this task is \Package{fontinst}; the package + documentation helps, but other guides are available (see below). + The simplest possible script to pass to \Package{fontinst} is: + \begin{quote} +\begin{verbatim} +\latinfamily{xyz}{} +\bye +\end{verbatim} + \end{quote} + where \texttt{xyz} is the Berry name of the font family. This + simple script is adequate for most purposes: its output covers the + font family in both \acro{T}1 and \acro{OT}1 font encodings. Nevertheless, + with fancier fonts, more elaborate things are possible with + \Package{fontinst}: see its documentation for details. + + \Package{Fontinst} also generates map files, and \LaTeX{} font + definition (\extension{fd}) files. +\end{itemize} +Having traversed this list, you have a set of font files ready for +installation. +\begin{ctanrefs} +\item[fontinst.sty]\CTANref{fontinst} +\item[\nothtml{\rmfamily}Type 1 installation guide]\CTANref{T1instguide} +\end{ctanrefs} + + +\Question[Q-instt1font]{Installing a Type~1 font} + +Once you have a prepared Type~1 font, either direct from \acro{CTAN} +or the like, or having \Qref*{`prepared' it yourself}{Q-prept1font}, +you can get on with installation. + +The procedure is merely an extension of that for packages, etc., so +much of what follows will be familiar: +\begin{itemize} +\item Install the files, in your local \texttt{texmf} tree (the advice + about installing non-standard things applies here, too). The + following list gives reasonable destinations for the various files + related to a font family \meta{fname}: +\begin{verbatim} +.pfb, +.pfa .../fonts/type1/<foundry>/<fname> +.tfm .../fonts/tfm/<foundry>/<fname> +.vf .../fonts/vf/<foundry>/<fname> +.sty, +.fd .../tex/latex/<fname> +.map .../fonts/map/dvips/<foundry> +\end{verbatim} + but if you are lucky, you will be starting from a distribution from + \acro{CTAN} and there is a corresponding \extension{tds.zip} file: + using the \acro{TDS}-file saves the bother of deciding where to put + your files in the \acro{TDS} tree. +\item Regenerate the file indexes (as described in + \Qref[question]{package installation}{Q-inst-wlcf}). +\item Update the \ProgName{dvips}, \PDFTeX{} and other maps: + \begin{itemize} + \item On any current \texlive{}-based system, or a te\TeX{} v3.0 + system, execute the command + \begin{quote} +\begin{verbatim} +updmap-sys --enable Map <fname>.map +\end{verbatim} + \end{quote} + as root. (Do \emph{not} use plain \ProgName{updmap}: it's a + potent source of confusion, setting up different map sets + for different users.) + \item On a current \miktex{} system, update the system file + \File{updmap.cfg}, using the shell command + \begin{quote} +\begin{verbatim} +initexmf --edit-config-file updmap +\end{verbatim} + \end{quote} + adding a line at the end: + \begin{quote} +\begin{verbatim} +Map <fname>.map +\end{verbatim} + \end{quote} + for each font family \meta{fname} you are adding to the system. + Now generate revised maps with the shell command + \begin{quote} +\begin{verbatim} +initexmf --mkmaps +\end{verbatim} + \end{quote} + This, and other matters, are described in \miktex{} % beware line break + \href{http://docs.miktex.org/manual/advanced.html}{``advanced'' documentation}. + \end{itemize} +\end{itemize} +Both processes (preparing and installing a font) are very well (and +thoroughly) described in Philipp Lehman's guide to font installation, +which may be found on \acro{CTAN}. +\begin{ctanrefs} +\item[fontinst.sty]\CTANref{fontinst} +\item[\nothtml{\rmfamily}Type 1 installation guide]\CTANref{T1instguide} +\end{ctanrefs} + +\Question[Q-inst1cm]{Installing the Type~1 versions of the CM~fonts} + +This is a specialised case of \Qref*{installing a font}{Q-instfont}, +but it is almost never necessary~--- it's inconceivable that any (even +remotely) recent system will \emph{not} have the fonts already +installed. You can confirm this (near-inevitable) fact by trying the +fonts. On a system that uses \ProgName{dvips} (almost all do), try +the sequence: +\begin{quote} +\begin{verbatim} + latex sample2e + dvips -o sample2e.ps sample2e +\end{verbatim} +\end{quote} +at a ``command prompt'' (\ProgName{shell}, in a Unix-style system, +``\acro{DOS} box'' in a Windows system). + +If the command works at all, the console output of the command will +include a sequence of Type~1 font file names, listed as +\texttt{<cmr10.pfb>} and so on; this is \ProgName{dvips} telling you +it's copying information from the Type~1 font, and you need do no +more. + +If the test has failed, you need to install your own set of the fonts; +the distribution (including all the fonts the \acro{AMS} designed and +produced themselves) is now described as \Package{amsfonts}. The +bundle contains metric and map files~--- all you need to +\Qref*{install the fonts}{Q-instt1font}. + +\begin{ctanrefs} +\item[AMS and CM fonts, in Type 1 format]\CTANref{amsfonts} +\end{ctanrefs} + + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex new file mode 100644 index 00000000000..32510bde697 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex @@ -0,0 +1,139 @@ +% $Id: faq-intro.tex,v 1.2 2009/08/02 22:50:13 rf10 Exp rf10 $ + +% this environment is for the benefit of new-style file generation +\begin{introduction} +% suppress section numbers until end environment +\nothtml{\csname c@secnumdepth\endcsname=-1 } +\section{Introduction} + +This is a set of Frequently Asked Questions (\acro{FAQ}) for +English-speaking users of \TeX{}. The questions answered here cover +a wide range of topics, but the actual typesetting issues are mostly +covered from the viewpoint of a \LaTeX{} user. + +You may use the \acro{FAQ} +\begin{itemize} +\item by reading a printed document, +\item by viewing a \acro{PDF} file, with hyperlinks to assist + browsing: copies are available formatted for printing on + \CTANhref{faq-a4}{A4 paper} or on % ! line break + \CTANhref{faq-letter}{North American ``letter'' paper}, or +\item by using the \acro{FAQ}'s web interface (base \acro{URL}: + \URL{http://www.tex.ac.uk/faq}); this version provides simple + search capabilities, as well as a link to Google for a more + sophisticated search restricted to the \acro{FAQ} itself, or +\item via Scott Pakin's \CTANhref{visualFAQ}{Visual FAQ}. +\end{itemize} + +\subsection{Finding the Files} + +Unless otherwise specified, all files mentioned in this \acro{FAQ} +are available from a \acro{CTAN} archive, or from a mirror of +\acro{CTAN}~--- see \Qref[question]{later discussion}{Q-archives}% ! space +\narrowonly{, which gives details} of the \acro{CTAN} +archives\wideonly{ and}\narrowonly{, including} how to retrieve files +from them. If you don't have access to the internet, the +\Qref*{\texlive{} distribution}{Q-CD} offers off-line snapshots of the +archives. + +The reader should also note that the first directory name of the +path name of every file on \acro{CTAN} is omitted from what +follows, for the simple reason that, while it's always the same +(\path{tex-archive/}) on the main sites, mirror sites often choose +something else. + +To avoid confusion, we also omit the full stop from the end of +any sentence whose last item is a path name (such sentences are +rare, and only occur at the end of paragraphs). Though the path +names are set in a different font from running text, it's not easy +to distinguish the font of a single dot! + +\latexhtml{\subsection*{Origins}}{\textbf{Origins}} + +The \acro{FAQ} was originated by the Committee of the \acro{UK} +\TeX{} Users' Group (\acro{UK}~\acro{TUG}) as a development of a +regular posting to the \emph{Usenet} newsgroup +\Newsgroup{comp.text.tex} that was maintained for some time by Bobby +Bodenheimer. The first \acro{UK} version was much re-arranged and +corrected from the original, and little of Bodenheimer's work now +remains. + +The following people (at least~--- there are almost certainly others +whose names weren't correctly recorded) have contributed help or +advice on the development of the \acro{FAQ}: Donald Arseneau, +Rosemary Bailey, % lots of initial set of maths answers +Barbara Beeton, % one of first reviewers outside cttee +Karl Berry, % often provides comments & suggestions +Giuseppe Bilotta, +Charles Cameron, +Fran\c{c}ois Charette, % update of q-xetex +Damian Cugley, +Michael Dewey, +Michael Downes, % (RIP) on (ams)maths stuff +Jean-Pierre Drucbert, % corrected my interpretation of minitoc +Michael Ernst, % alert on confusing colloquialism +Thomas Esser, +Ulrike Fischer, % spotted boondoggle in q-tabcellalign + % args like \section improvement; general typos +Anthony Goreham, +Norman Gray, +Eitan Gurari, % (RIP) comparative html translators +William Hammond, % lots of work on xml-related answers +John Harper, % patient help with q-robust ;-) +John Hammond, % corrections to q-protect +Troy Henderson, % metapost tutorials update +Hartmut Henkel, +Stephan Hennig, % text about vc in Q-RCS +John Hobby, +Morten H\textoslash gholm, % eagle eyes in search for problems +Berthold Horn, % lots of stuff on fonts +Ian Hutchinson, % comparative html translators +Werner Icking, % (RIP) answer on tex-music +William Ingram, % extension of transcinit +Alan Jeffrey, % another founding father +Regnor Jernsletten, +David Kastrup, % inter alia, suggested mention of lilypond +Oleg Katsitadze, % revision of q-eplain +Isaac Khabaza, % kindersley book +Ulrich Klauer, % pointed out twaddle in TeXpronounce +Markus Kohm, % help with functionality of Koma-script +Stefan Kottwitz % picked up text of q-wideflt +David Kraus, % help with tocbibind (spotted embarrassing typo :-} ) +Ryszard Kubiak, % comment about q-driver +Simon Law, +Daniel Luecking, +Aditya Mahajan, % rewrite of q-context +Sanjoy Mahajan, +Andreas Matthias, +Brooks Moses, % editorial suggestion +Iain Murray, % alternative solution in q-hyperdupdest +Vilar Camara Neto, % explain breakurl pkg, suggest use of numprint +Dick Nickalls, +Ted Nieland, +Hans Nordhaug, +Pat Rau, +Heiko Oberdiek, +Piet van Oostrum, +Scott Pakin, +Oren Patashnik, +Manuel P\'egouri\'e-Gonnard, % improvement of q-luatex +Steve Peter, % comprehensive review, lots of typos etc +Sebastian Rahtz, % without whom there would be no... +Philip Ratcliffe, % help with a bibtex oddity +Chris Rowley, % founding father +Jos\'e Carlos Santos, % assiduous reader of new versions +Walter Schmidt, +Hans-Peter Schr\"ocker, +Joachim Schrod, +Maarten Sneep, % summary of c.t.t thread for outszwrng, inter alia +Axel Sommerfeldt, % suggested rewrite of q-hyperdupdest +Philipp Stephani, % xlation of komascript keyval stuff +James Szinger, % who responded on c.t.t to request for answer +Ulrik Vieth, +Mike Vulis, +Chris Walker, % revtex alert, ite suggestion (q-labelfig) +Peter Wilson, % several, incl functionality of memoir +Joseph Wright, % help with keyval +Rick Zaccone and +Reinhard Zierke. +\end{introduction} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-jot-err.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-jot-err.tex new file mode 100644 index 00000000000..30e7dc88121 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-jot-err.tex @@ -0,0 +1,2091 @@ +% $Id: faq-jot-err.tex,v 1.1 2009/06/13 20:56:47 rf10 Exp rf10 $ + +\section{The joy of \TeX{} errors} + +\Question[Q-erroradvice]{How to approach errors} + +Since \TeX{} is a macroprocessor, its error messages are often +difficult to understand; this is a (seemingly invariant) property of +macroprocessors. Knuth makes light of the problem in the \TeX{}book, +suggesting that you acquire the sleuthing skills of a latter-day +Sherlock Holmes; while this approach has a certain romantic charm to +it, it's not good for the `production' user of \AllTeX{}. This +answer (derived, in part, from an article by Sebastian Rahtz in +\TUGboat{} 16(4)) offers some general guidance in dealing with \TeX{} +error reports, and other answers in this section deal with common (but +perplexing) errors that you may encounter. There's a long list of +``hints'' in Sebastian's article, including the following: +\begin{itemize} +\item Look at \TeX{} errors; those messages may seem cryptic at first, + but they often contain a straightforward clue to the problem. See + \Qref[question]{the structure of errors}{Q-errstruct} for further + details. +\item Read the \extension{log} file; it contains hints to things you may + not understand, often things that have not even presented as error + messages. +\item Be aware of the amount of context that \TeX{} gives you. The + error messages gives you some bits of \TeX{} code (or of the + document itself), that show where the error ``actually happened''; + it's possible to control how much of this `context' \TeX{} actually + gives you. \LaTeX{} (nowadays) instructs \TeX{} only to give you + one line of context, but you may tell it otherwise by saying +\begin{quote} +\begin{verbatim} +\setcounter{errorcontextlines}{999} +\end{verbatim} +\end{quote} + in the preamble of your document. (If you're not a confident macro + programmer, don't be ashamed of cutting that 999 down a bit; some + errors will go on and \emph{on}, and spotting the differences + between those lines can be a significant challenge.) +\item As a last resort, tracing can be a useful tool; reading a full + \AllTeX{} trace takes a strong constitution, but once you know how, + the trace can lead you quickly to the source of a problem. You need + to have read the \TeX{}book (see +% beware line break + \Qref[question]{books about \TeX{}}{Q-books}) in some detail, fully + to understand the trace. + + The command \csx{tracingall} sets up maximum tracing; it also sets + the output to come to the interactive terminal, which is somewhat of + a mixed blessing (since the output tends to be so vast~--- all but + the simplest traces are best examined in a text editor after the event). + + The \LaTeX{} \Package{trace} package (first distributed with the + 2001 release of \LaTeX{}) provides more manageable tracing. Its + \csx{traceon} command gives you what \csx{tracingall} offers, but + suppresses tracing around some of the truly verbose parts of + \LaTeX{} itself. The package also provides a \csx{traceoff} + command (there's no ``off'' command for \csx{tracingall}), and a + package option (|logonly|) allows you to suppress output to the + terminal. +\end{itemize} +The best advice to those faced with \TeX{} errors is not to panic: +most of the common errors are plain to the eye when you go back to the +source line that \TeX{} tells you of. If that approach doesn't work, +the remaining answers in this section deal with some of the odder +error messages you may encounter. You should not ordinarily need to +appeal to the \Qref*[question]{wider public}{Q-gethelp} +for assistance, but if you do, be sure to +report full backtraces (see |errorcontextlines| above) and so on. +\begin{ctanrefs} +\item[trace.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-errstruct]{The structure of \TeX{} error messages} + +\TeX{}'s error messages are reminiscent of the time when \TeX{} itself +was conceived (the 1970s): they're not terribly user-friendly, though +they do contain all the information that \TeX{} can offer, usually in +a pretty concise way. + +\TeX{}'s error reports all have the same structure: +\begin{itemize} +\item An error message +\item Some `context' +\item An error prompt +\end{itemize} +The error message will relate to the \emph{\TeX{}} condition that is +causing a problem. Sadly, in the case of complex macro packages such +as \LaTeX{}, the underlying \TeX{} problem may be superficially +difficult to relate to the actual problem in the ``higher-level'' +macros. Many \LaTeX{}-detected problems manifest themselves as +`generic' errors, with error text provided by \LaTeX{} itself (or by a +\LaTeX{} class or package). + +The context of the error is a stylised representation of what \TeX{} +was doing at the point that it detected the error. As noted in +\Qref[question]{approaching errors}{Q-erroradvice}, a macro package +can tell \TeX{} how much context to display, and the user may need to +undo what the package has done. Each line of context is split at the +point of the error; if the error \emph{actually} occurred in a macro +called from the present line, the break is at the point of the call. +(If the called object is defined with arguments, the ``point of call'' +is after all the arguments have been scanned.) For example: +\begin{verbatim} +\blah and so on +\end{verbatim} +produces the error report +\begin{verbatim} +! Undefined control sequence. +l.4 \blah + and so on +\end{verbatim} +while: +\begin{verbatim} +\newcommand{\blah}[1]{\bleah #1} +\blah{to you}, folks +\end{verbatim} +produces the error report +\begin{verbatim} +! Undefined control sequence. +\blah #1->\bleah + #1 +l.5 \blah{to you} + , folks +\end{verbatim} +If the argument itself is in error, we will see things such as +\begin{verbatim} +\newcommand{\blah}[1]{#1 to you} +\blah{\bleah}, folks +\end{verbatim} +producing +\begin{verbatim} +! Undefined control sequence. +<argument> \bleah + +l.5 \blah{\bleah} + , folks +\end{verbatim} + +The prompt accepts single-character commands: the list of what's +available may be had by typing |?|\@. One immediately valuable +command is |h|, which gives you an expansion of \TeX{}s original +pr\'ecis message, sometimes accompanied by a hint on what to do to +work round the problem in the short term. If you simply type `return' +(or whatever else your system uses to signal the end of a line) at the +prompt, \TeX{} will attempt to carry on (often with rather little +success). + +\Question[Q-extrabrace]{An extra `\texttt{\cbracesymbol{}}'??} +\keywords{caption heading} + +You've looked at your \LaTeX{} source and there's no sign of a misplaced +\texttt{\cbracesymbol{}} on the line in question. + +Well, no: this is \TeX{}'s cryptic way of hinting that you've put a +\begin{wideversion} % hyper +\Qref{fragile command}{Q-protect} in a moving argument. +\end{wideversion} +\begin{narrowversion} +fragile command in a moving argument (\Qref{}{Q-protect}). +\end{narrowversion} + +For example, \csx{footnote} is fragile, and if we put that in the +moving argument of a \csx{section} command, as +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\section{Mumble\footnote{% + I couldn't think of anything better}} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\section{Mumble\footnote{I couldn't think of anything better}} +\end{verbatim} +\end{wideversion} +\end{quote} +we get told +\begin{quote} +\begin{verbatim} +! Argument of \@sect has an extra }. +\end{verbatim} +\end{quote} +The same happens with captions (the following is a simplification of a +\Newsgroup{comp.text.tex} post): +\begin{quote} +\begin{verbatim} +\caption{Energy: \[e=mc^2\]} +\end{verbatim} +\end{quote} +giving us the error message +\begin{quote} +\begin{verbatim} +! Argument of \@caption has an extra }. +\end{verbatim} +\end{quote} +The solution is usually to use a robust command in place of the one +you are using, or to force your command to be robust by prefixing it +with \csx{protect}, which in the \csx{section} case would show as +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\section{Mumble\protect\footnote{% + I couldn't think of anything better}} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\section{Mumble\protect\footnote{I couldn't think of anything better}} +\end{verbatim} +\end{wideversion} +\end{quote} +In both the \csx{section} case and the \csx{caption} case, you can +separate the moving argument, as in +\cmdinvoke*{section}[moving]{static}; this gives us another standard +route~--- simply to omit (or otherwise sanitise) the fragile command +in the moving argument. So, one might rewrite the \csx{caption} +example as: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\caption[Energy: $E=mc^2$]% + {Energy: \[E=mc^2\]} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\caption[Energy: $E=mc^2$]{Energy: \[E=mc^2\]} +\end{verbatim} +\end{wideversion} +\end{quote} +for, after all, even if you want display maths in a caption, you +surely don't want it in the list of figures. + +The case of footnotes is somewhat more complex; +``\Qref[question]{footnotes in \LaTeX{} section headings}{Q-ftnsect}'' +deals specifically with that issue. + +\Question[Q-semanticnest]{Capacity exceeded [semantic nest\,\dots{}]} + +\begin{narrowversion} +\begin{verbatim} +! TeX capacity exceeded, sorry [semantic nest + size=100]. +... +If you really absolutely need more capacity, +you can ask a wizard to enlarge me. +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +! TeX capacity exceeded, sorry [semantic nest size=100]. +... +If you really absolutely need more capacity, +you can ask a wizard to enlarge me. +\end{verbatim} +\end{wideversion} +Even though \TeX{} suggests (as always) that enlargement by a wizard +may help, this message usually results from a broken macro or bad +parameters to an otherwise working macro. + +The ``semantic nest'' \TeX{} talks about is the nesting +of boxes within boxes. A stupid macro can provoke the error pretty +easily: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\def\silly{\hbox{here's \silly + being executed}} +\silly +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\def\silly{\hbox{here's \silly being executed}} +\silly +\end{verbatim} +\end{wideversion} +\end{quote} +The extended traceback +% beware of filling this line... +(see \Qref{\emph{general advice} on errors}{Q-erroradvice}) +\emph{does} help, though it does rather run on. In the case above, +the traceback consists of +\begin{verbatim} +\silly ->\hbox { + here's \silly being executed} +\end{verbatim} +followed by 100 instances of +\begin{verbatim} +\silly ->\hbox {here's \silly + being executed} +\end{verbatim} +The repeated lines are broken at exactly the offending macro; of +course the loop need not be as simple as this~--- if \csx{silly} calls +\csx{dopy} which boxes \csx{silly}, the effect is just the same and +alternate lines in the traceback are broken at alternate positions. + +There are in fact two items being consumed when you nest boxes: the +other is the grouping level. Whether you exhaust your % !line wrap +\emph{semantic nest} or your permitted \emph{grouping levels} first is +controlled entirely by the relative size of the two different sets of +buffers in your \AllTeX{} executable. + +\Question[Q-noroom]{No room for a new `\emph{thing}'} + +The technology available to Knuth at the time \TeX{} was written is +said to have been particularly poor at managing dynamic storage; as a +result much of the storage used within \TeX{} is allocated as fixed +arrays, in the reference implementations. Many of these fixed arrays +are expandable in modern \TeX{} implementations, but size of the +arrays of ``registers'' is written into the specification as being 256 +(usually); this number may not be changed if you still wish to call +the result \TeX{} +%% beware line wrap +(see \Qref[question]{testing \TeX{} implementations}{Q-triptrap}). + +If you fill up one of these register arrays, you get a \TeX{} error +message saying +\begin{quote} +\begin{verbatim} +! No room for a new \<thing>. +\end{verbatim} +\end{quote} +The \csx{thing}s in question may be \csx{count} (the object underlying +\LaTeX{}'s \csx{newcounter} command), \csx{skip} (the object underlying +\LaTeX{}'s \csx{newlength} command), \csx{box} (the object underlying +\LaTeX{}'s \csx{newsavebox} command), or \csx{dimen}, \csx{muskip}, +\csx{toks}, \csx{read}, \csx{write} or \csx{language} (all types of object +whose use is ``hidden'' in \LaTeX{}; the limit on the number of +\csx{read} or \csx{write} objects is just 16). + +There is nothing that can directly be done about this error, as you can't +extend the number of available registers without extending \TeX{} +itself. +\begin{htmlversion} + Of course, \Qref{\eTeX{}}{Q-etex}, \Qref{Omega}{Q-omegaleph} and + \Qref{\LuaTeX{}}{Q-luatex} +\end{htmlversion} +\htmlignore +% beware line wrap here + Of course, \eTeX{}, \ensuremath{\Omega} and \LuaTeX{}~--- + \Qref[see questions]{}{Q-etex} \Qref[,]{}{Q-omegaleph} and + \Qref[and]{}{Q-luatex} respectively~--- +\endhtmlignore +all do this, as does \Qref*{MicroPress Inc's V\TeX{}}{Q-commercial}. + +One common way to encounter one of these error messages is to have +broken macros of some sort, or incorrect usage of macros (an example +is discussed in \Qref[question]{epsf problems}{Q-epsf}). + +However, sometimes one just \emph{needs} more than \TeX{} can offer, +and when this happens, you've just got to work out a different way of +doing things. An example is the % beware line wrap +\Qref*{difficulty of loading \PiCTeX{} with \LaTeX{}}{Q-usepictex}. +The more modern drawing package, \Package{pgf} with its higher-level +interface \Package{TikZ} is a common problem. + +In such cases, it is usually possible to use the +\Qref*{\eTeX{}}{Q-etex} extensions (all modern distributions provide +them). The \LaTeX{} package \Package{etex} modifies the register allocation +mechanism to make use of \eTeX{}'s extended register sets. +\Package{Etex} is a +derivative of the \plaintex{} macro file \Package{etex.src}, which is +used in building the \eTeX{} Plain format; both files are part of the +\eTeX{} distribution and are available in current distributions. + +It is possible that, even with \Package{etex} loaded, you still find +yourself running out of things. Problems could be caused by packages +that use large numbers of ``inserts'' (combinations of counter, box, +dimension and skip registers, used for storing floats and footnotes). +\Package{Morefloats} does this, of course (naturally enough, +allocating new floats), and footnote packages such as +\Package{manyfoot} and \Package{bigfoot} (which uses \Package{manyfoot} +can also give problems. The \Package{etex} allows you to deal with +these things: the command \cmdinvoke*{reserveinserts}{n} ensures there +is room for \meta{n} more inserts. (Hint: \Package{morefloats} needs +18 inserts, and \Package{manyfoot} seems to be happy with 10 +reserved.) Load \Package{etex} before any others, and reserve the +inserts immediately: +\begin{quote} +\begin{verbatim} +\documentclass[...]{...} +\usepackage{etex} +\reserveinserts{28} +\end{verbatim} +\end{quote} + +Unfortunately, \eTeX{} doesn't help with \csx{read} or \csx{write} +objects (and neither will the \Package{etex} package). + +\Question[Q-epsf]{\texttt{epsf} gives up after a bit} + +Some copies of the documentation of \File{epsf.tex} seem to suggest +that the command +\begin{verbatim} + \input epsf +\end{verbatim} +is needed for every figure included. If you follow this suggestion +too literally, you get an error +\begin{verbatim} + ! No room for a new \read . +\end{verbatim} +after a while; this is because each time \File{epsf.tex} is loaded, it +allocates itself a \emph{new} file-reading handle to check the figure +for its bounding box, and there just aren't enough of these things +(see \Qref[question]{no room for a new thing}{Q-noroom}). + +The solution is simple~--- this is in fact an example of misuse of +macros; one only need read \File{epsf.tex} once, so change +\begin{verbatim} + ... + \input epsf + \epsffile{...} + ... + \input epsf + \epsffile{...} +\end{verbatim} +(and so on) with a single +\begin{verbatim} + \input epsf +\end{verbatim} +somewhere near the start of your document, and then decorate your +\csx{epsffile} statements with no more than adjustments of +\csx{epsfxsize} and so on. + +\Question[Q-badhyph]{Improper \csx{hyphenation} will be flushed} + +For example +\begin{verbatim} +! Improper \hyphenation will be flushed. +\'#1->{ + \accent 19 #1} +<*> \hyphenation{Ji-m\'e + -nez} +\end{verbatim} +(in \plaintex{}) or +\begin{verbatim} +! Improper \hyphenation will be flushed. +\leavevmode ->\unhbox + \voidb@x +<*> \hyphenation{Ji-m\'e + -nez} +\end{verbatim} +in \LaTeX{}. + +As mentioned in \Qref[question]{``hyphenation failures''}{Q-nohyph}, +words with accents in them may not be hyphenated. As a result, any +such word is deemed improper in a \csx{hyphenation} command. + +The solution is to use a font that contains the character in question, +and to express the \csx{hyphenation} command in terms of that +character; this ``hides'' the accent from the hyphenation mechanisms. +\LaTeX{} users can be achieved this by use of the \Package{fontenc} +package (part of the \LaTeX{} distribution). If you select an 8-bit +font with the package, as in \cmdinvoke{usepackage}[T1]{fontenc}, +accented-letter commands such as the |\'||e| in +|\hyphenation{Ji-m\'||e-nez}| automatically become the single accented +character by the time the hyphenation gets to look at it. + +\Question[Q-tmupfl]{``Too many unprocessed floats''} + +If \LaTeX{} responds to a \cmdinvoke{begin}{figure} or +\cmdinvoke{begin}{table} command with the error message +\begin{htmlversion} +\begin{verbatim} +! LaTeX Error: Too many unprocessed floats. + +See the LaTeX manual or LaTeX Companion for explanation. +\end{verbatim} +\end{htmlversion} +\htmlignore +\ifpdf +\begin{verbatim} +! LaTeX Error: Too many unprocessed floats. + +See the LaTeX manual or LaTeX Companion for explanation. +\end{verbatim} +\else +\begin{verbatim} +! LaTeX Error: Too many unprocessed floats. + +See the LaTeX manual or LaTeX Companion +... for explanation. +\end{verbatim} +\fi +\endhtmlignore +your figures (or tables) are failing to be placed properly. \LaTeX{} +has a limited amount of storage for `floats' (figures, tables, or +floats you've defined yourself with the \Package{float} package); if +you don't let it ever actually typeset any floats, it will run out of +space. + +This failure usually occurs in extreme cases of +% beware line break +\nothtml{floats moving ``wrongly'' (see }% +\Qref[question]{floats moving ``wrongly''}{Q-floats}\latexhtml{);}{;} +\LaTeX{} has found it can't place a float, and floats of the same type +have piled up behind it. \LaTeX{}'s idea is to ensure that caption +numbers are sequential in the document: the caption number is +allocated when the figure (or whatever) is created, and can't be +changed, so that placement out of order would mean figure numbers +appearing out of order in the document (and in the list of figures, or +whatever). So a simple failure to place a figure means that no +subsequent figure can be placed; and hence (eventually) the error. + +Techniques for solving the problem are discussed in the +\nothtml{floats question (}% +\Qref[\htmlonly]{floats question}{Q-floats}\nothtml{)} +already referenced. + +The error also occurs in a +long sequence of \environment{figure} or \environment{table} +environments, with no intervening +text. Unless the environments will fit ``here'' (and you've allowed +them to go ``here''), there will never be a page break, and so there +will never be an opportunity for \LaTeX{} to reconsider placement. +(Of course, the floats can't all fit ``here'' if the sequence is +sufficiently prolonged: once the page fills, \LaTeX{} won't place any +more floats, leading to the error. + +Techniques for resolution may involve redefining the floats using the +\Package{float} package's \texttt{[H]} float qualifier, but you are unlikely +to get away without using \csx{clearpage} from time to time. +\begin{ctanrefs} +\item[float.sty]\CTANref{float} +\end{ctanrefs} + +\Question[Q-atvert]{\csx{spacefactor} complaints} + +The errors +\begin{verbatim} +! You can't use `\spacefactor' in vertical mode. +\@->\spacefactor + \@m +\end{verbatim} +or +\begin{verbatim} +! You can't use `\spacefactor' in math mode. +\@->\spacefactor + \@m +\end{verbatim} +or simply +\begin{verbatim} +! Improper \spacefactor. +... +\end{verbatim} +bites the \LaTeX{} programmer who uses an internal command without taking +``precautions''. The problem is discussed in detail in +% beware line wrap +``\Qref*[question]{\texttt{@} in macro names}{Q-atsigns}'', +together with solutions. + +\Question[Q-endingroup]{\csx{end} occurred inside a group} + +The actual error we observe is: + +\nothtml{\noindent}% +|(\end occurred inside a group at level <|\texttt{\emph{n}}|>)| + +\nothtml{\noindent}% +and it tells us that something we started in the document never got +finished before we ended the document itself. The things involved +(`groups') are what \TeX{} uses for restricting the scope of things: +you see them, for example, in the ``traditional'' font selection +commands: |{\it stuff\/}|~--- if the closing brace is left off such a +construct, the effect of \csx{it} will last to the end of the document, +and you'll get the diagnostic. + +\TeX{} itself doesn't tell you where your problem is, but you can +often spot it by looking at the typeset output in a previewer. +Otherwise, you can usually find mismatched braces using an intelligent +editor (at least \ProgName{emacs} and \ProgName{winedt} offer this facility). +However, groups are not \emph{only} created by matching +\texttt{\obracesymbol{}} with \texttt{\cbracesymbol{}}: +other grouping commands are discussed elsewhere in these \acro{FAQ}s, +and are also a potential source of unclosed group. + +\cmdinvoke{begin}{\meta{environment}} encloses the environment's body +in a group, and establishes its own diagnostic mechanism. If you end +the document before closing some other environment, you get the +`usual' \LaTeX{} diagnostic +\htmlignore +\begin{dviversion} +\begin{verbatim} +! LaTeX Error: \begin{blah} on input line 6 + ended by \end{document}. +\end{verbatim} +\end{dviversion} +\begin{pdfversion} +\begin{verbatim} +! LaTeX Error: \begin{blah} on input line 6 ended by \end{document}. +\end{verbatim} +\end{pdfversion} +\endhtmlignore +\begin{htmlversion} +\begin{verbatim} +! LaTeX Error: \begin{blah} on input line 6 ended by \end{document}. +\end{verbatim} +\end{htmlversion} +which (though it doesn't tell you which \emph{file} the +\cmdinvoke{begin}{blah} was in) is usually enough to locate the +immediate problem. If you press on past the \LaTeX{} error, you get +one or more repetitions of the ``occurred inside a group'' message +before \LaTeX{} finally exits. The \Package{checkend} package +recognises other unclosed \cmdinvoke{begin}{blob} commands, and +generates an ``ended by'' error message for each one, rather than +producing the ``occurred inside a group'' message, which is sometimes +useful (if you remember to load the package). + +In the absence of such information from \LaTeX{}, you need to use +``traditional'' binary search to find the offending group. Separate +the preamble from the body of your file, and process each half on its +own with the preamble; this tells you which half of the file is at +fault. Divide again and repeat. The process needs to be conducted +with care (it's obviously possible to split a correctly-written group +by chopping in the wrong place), but it will usually find the problem +fairly quickly. + +\eTeX{} (and \elatex{}~--- \LaTeX{} run on \eTeX{}) gives you +further diagnostics after the traditional infuriating \TeX{} one~--- it +actually keeps the information in a similar way to \LaTeX{}: +\htmlignore +\begin{dviversion} +\begin{verbatim} +(\end occurred inside a group at level 3) + +### semi simple group (level 3) entered + at line 6 (\begingroup) +### simple group (level 2) entered at line 5 ({) +### simple group (level 1) entered at line 4 ({) +### bottom level +\end{verbatim} +\end{dviversion} +\begin{pdfversion} +\begin{verbatim} +(\end occurred inside a group at level 3) + +### semi simple group (level 3) entered at line 6 (\begingroup) +### simple group (level 2) entered at line 5 ({) +### simple group (level 1) entered at line 4 ({) +### bottom level +\end{verbatim} +\end{pdfversion} +\endhtmlignore +\begin{htmlversion} +\begin{verbatim} +(\end occurred inside a group at level 3) + +### semi simple group (level 3) entered at line 6 (\begingroup) +### simple group (level 2) entered at line 5 ({) +### simple group (level 1) entered at line 4 ({) +### bottom level +\end{verbatim} +\end{htmlversion} +The diagnostic not only tells us where the group started, but also the +\emph{way} it started: \csx{begingroup} or |{| (which is an alias of +\csx{bgroup}, and the two are not distinguishable at the \TeX{}-engine +level). +\begin{ctanrefs} +\item[checkend.sty]Distributed as part of \CTANref{bezos} +\end{ctanrefs} + +\Question[Q-nonum]{``Missing number, treated as zero''} + +In general, this means you've tried to assign something to a count, +dimension or skip register that isn't (in \TeX{}'s view of things) a +number. Usually the problem will become clear using the +\Qref*{ordinary techniques of examining errors}{Q-erroradvice}. + +Two \LaTeX{}-specific errors are commonly aired on the newsgroups. + +The commonest arises from attempting to use an example from the +\Qref*{\emph{The \LaTeX{} Companion} (first edition)}{Q-books}, and is +exemplified by the following error text: +\begin{verbatim} +! Missing number, treated as zero. +<to be read again> + \relax +l.21 \begin{Ventry}{Return values} +\end{verbatim} +The problem arises because, in its first edition, the +\emph{Companion}'s examples always assumed that the \Package{calc} +package is loaded: this fact is mentioned in the book, but often not +noticed. The remedy is to load the \Package{calc} package in any +document using such examples from the \emph{Companion}. (The problem +does not really arise with the second edition; copies of all the +examples are available on the accompanying \CDROM{}, or on +\acro{CTAN}.) + +The other problem, which is increasingly rare nowadays, arises from +misconfiguration of a system that has been upgraded from \LaTeXo{}: +the document uses the \Package{times} package, and the error appears +at \cmdinvoke{begin}{document}. The file search paths are wrongly set +up, and your \cmdinvoke{usepackage}{times} has picked up a \LaTeXo{} +version of the package, which in its turn has invoked another which +has no equivalent in \LaTeXe{}. The obvious solution is to rewrite +the paths so that \LaTeXo{} packages are chosen only as a last resort +so that the startlingly simple \LaTeXe{} \Package{times} package will +be picked up. Better still is to replace the whole thing with +something more modern still; current \Package{psnfss} doesn't provide +a \Package{times} package~--- the alternative \Package{mathptmx} +incorporates \FontName{Times}-like mathematics, and a sans-serif face +based on \FontName{Helvetica}, but scaled to match \FontName{Times} +text rather better. +\begin{ctanrefs} +\item[calc.sty]Distributed as part of \CTANref{2etools} +\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Companion]\CTANref{tlc2} +\item[The psnfss bundle]\CTANref{psnfss} +\end{ctanrefs} + +\Question[Q-typend]{``Please type a command or say \csx{end}''} + +Sometimes, when you are running \AllTeX{}, it will abruptly stop and +present you with a prompt (by default, just a |*| character). Many +people (including this author) will reflexively hit the `return' +key, pretty much immediately, and of course this is no help at all~--- +\TeX{} just says: +\begin{verbatim} +(Please type a command or say `\end') +\end{verbatim} +and prompts you again. + +What's happened is that your \AllTeX{} file has finished prematurely, +and \TeX{} has fallen back to a supposed including file, from the +terminal. This could have happened simply because you've omitted +the \csx{bye} (\plaintex{}), \cmdinvoke{end}{document} (\LaTeX{}), or +whatever. Other common errors are failure to close the braces round a +command's argument, or (in \LaTeX{}) failure to close a verbatim +environment: in such cases you've already read and accepted an +error message about encountering end of file while scanning something. + +If the error is indeed because you've forgotten to end your document, +you can insert the missing text: if you're running \plaintex{}, the +advice, to ``say \csx{end}'' is good enough: it will kill the run; if +you're running \LaTeX{}, the argument will be necessary: +\cmdinvoke{end}{document}. + +However, as often as not this isn't the problem, and (short of +debugging the source of the document before ending) brute force is +probably necessary. Excessive force (killing the job that's +running \TeX{}) is to be avoided: there may well be evidence in the +\extension{log} file that will be useful in determining what the +problem is~--- so the aim is to persuade \TeX{} to shut itself down +and hence flush all log output to file. + +If you can persuade \TeX{} to read it, an end-of-file indication +(control-|D| under Unix, control-|Z| under Windows) will provoke +\TeX{} to report an error and exit immediately. Otherwise you should +attempt to provoke an error dialogue, from which you can exit (using +the |x| `command'). An accessible error could well be inserting an +illegal character: what it is will depend on what macros you are +running. If you can't make that work, try a silly command name or +two. + +\Question[Q-unkgrfextn]{``Unknown graphics extension''} + +The \LaTeX{} graphics package deals with several different types of +\acro{DVI} (or other) output drivers; each one of them has a potential +to deal with a different selection of graphics formats. The package +therefore has to be told what graphics file types its output driver +knows about; this is usually done in the \meta{driver}\extension{def} file +corresponding to the output driver you're using. + +The error message arises, then, if you have a graphics file whose +extension doesn't correspond with one your driver knows about. Most +often, this is because you're being optimistic: asking +\ProgName{dvips} to deal with a \extension{png} file, or \PDFTeX{} to deal with +a \extension{eps} file: the solution in this case is to transform the graphics +file to a format your driver knows about. + +If you happen to \emph{know} that your device driver deals with the +format of your file, you are probably falling foul of a limitation of +the file name parsing code that the graphics package uses. Suppose +you want to include a graphics file \File{home.bedroom.eps} using the +\ProgName{dvips} driver; the package will conclude that your file's +extension is \extension{bedroom.eps}, and will complain. + +The \Package{grffile} package deals with the last problem (and +others~--- see the package documentation); using the package, you may +write: +\begin{quote} +\begin{verbatim} +\usepackage{graphicx} +\usepackage{grffile} +... +\includegraphics{home.bedroom.eps} +\end{verbatim} +\end{quote} +or you may even write +\begin{quote} +\begin{verbatim} +\includegraphics{home.bedroom} +\end{verbatim} +\end{quote} +and \Package{graphicx} will find a \extension{eps} or \extension{pdf} +(or whatever) version, according to what version of \AllTeX{} you're +running. + +If for some reason you can't use \Package{grffile}, you have three +unsatisfactory alternatives: +\begin{itemize} +\item Rename the file~--- for example \File{home.bedroom.eps}\arrowhyph{}% + \File{home-bedroom.eps} +\item Mask the first dot in the file name: +\begin{verbatim} +\newcommand*{\DOT}{.} +\includegraphics{home\DOT bedroom.eps} +\end{verbatim} +\item Tell the graphics package what the file is, by means of options + to the \csx{includegraphics} command: +\begin{narrowversion} +\begin{verbatim} +\includegraphics[type=eps,ext=.eps, + read=.eps]{home.bedroom} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\includegraphics[type=eps,ext=.eps,read=.eps]{home.bedroom} +\end{verbatim} +\end{wideversion} +\end{itemize} +\begin{ctanrefs} +\item[grffile.sty]Distributed as part of the \CTANref{oberdiek} collection +\end{ctanrefs} + +\Question[Q-nodollar]{``Missing \texttt{\$} inserted''} + +There are certain things that \emph{only} work in maths mode. If your +document is not in maths mode and you have an |_| or a |^| character, +\TeX{} (and by inheritance, \LaTeX{} too) will say +\begin{verbatim} +! Missing $ inserted +\end{verbatim} +as if you couldn't possibly have misunderstood the import of what you +were typing, and the only possible interpretation is that you had +committed a typo in failing to enter maths mode. \TeX{}, therefore, +tries to patch things up by inserting the \texttt{\$} you `forgot', so that +the maths-only object will work; as often as not this will land you in +further confusion. + +It's not just the single-character maths sub- and superscript +operators: anything that's built in or declared as a maths operation, +from the simplest lower-case \csx{alpha} through the inscrutable +\csx{mathchoice} primitive, and beyond, will provoke the error if +misused in text mode. + +\LaTeX{} offers a command \csx{ensuremath}, which will put you in maths +mode for the execution of its argument, if necessary: so if you want +an \csx{alpha} in your running text, say +\cmdinvoke{ensuremath}{\csx{alpha}}; if the bit of running text somehow +transmutes into a bit of mathematics, the \csx{ensuremath} will become +a no-op, so it's pretty much always safe. + +\Question[Q-fontunavail]{Warning: ``Font shape \dots{}\ not available''} + +\LaTeX{}'s font selection scheme maintains tables of the font families +it has been told about. These tables list the font families that +\LaTeX{} knows about, and the shapes and series in which those font +families are available. In addition, in some cases, the tables list +the sizes at which \LaTeX{} is willing to load fonts from the family. + +When you specify a font, using one of the \LaTeX{} font selection +commands, \LaTeX{} looks for the font (that is, a font that matches +the encoding, family, shape, series and size that you want) in its +tables. If the font isn't there at the size you want, you will see a +message like: +\htmlignore +\begin{dviversion} +\begin{verbatim} +LaTeX Font Warning: Font shape `OT1/cmr/m/n' in +... size <11.5> not available +(Font) size <12> substituted on +... input line ... +\end{verbatim} +(All the message texts in this answer have been wrapped so that they +will fit in the narrow columns of this version of the \acro{FAQ}. The +continuation marker is |...| at the start of the broken-off portion of +the line.) + +\end{dviversion} +\begin{pdfversion} +\begin{verbatim} +LaTeX Font Warning: Font shape `OT1/cmr/m/n' in size <11.5> not available +(Font) size <12> substituted on input line ... +\end{verbatim} +\end{pdfversion} +\endhtmlignore +\begin{htmlversion} +\begin{verbatim} +LaTeX Font Warning: Font shape `OT1/cmr/m/n' in size <11.5> not available +(Font) size <12> substituted on input line ... +\end{verbatim} +\end{htmlversion} +There will also be a warning like: +\htmlignore +\begin{dviversion} +\begin{verbatim} +LaTeX Font Warning: Size substitutions with +... differences +(Font) up to 0.5pt have occurred. +\end{verbatim} +\end{dviversion} +\begin{pdfversion} +\begin{verbatim} +LaTeX Font Warning: Size substitutions with differences +(Font) up to 0.5pt have occurred. +\end{verbatim} +\end{pdfversion} +\endhtmlignore +\begin{htmlversion} +\begin{verbatim} +LaTeX Font Warning: Size substitutions with differences +(Font) up to 0.5pt have occurred. +\end{verbatim} +\end{htmlversion} +after \LaTeX{} has encountered \cmdinvoke{end}{document}. + +The message tells you that you've chosen a font size that is not in +\LaTeX{}'s list of ``allowed'' sizes for this font; \LaTeX{} has +chosen the nearest font size it knows is allowed. In fact, you can +tell \LaTeX{} to allow \emph{any} size: the restrictions come from the +days when only bitmap fonts were available, and they have never +applied to fonts that come in scaleable form in the first place. +Nowadays, most of the fonts that were once bitmap-only are also +available in scaleable (Adobe Type~1) form. If your installation uses +scaleable versions of the Computer Modern or European Computer Modern +(\acro{EC}) fonts, you can tell \LaTeX{} to remove the restrictions; +use the \Package{type1cm} or \Package{type1ec} package as appropriate. + +If the combination of font shape and series isn't available, \LaTeX{} +will usually have been told of a fall-back combination that may be +used, and will select that: +\htmlignore +\begin{dviversion} +\begin{verbatim} +LaTeX Font Warning: Font shape `OT1/cmr/bx/sc' +... undefined +(Font) using `OT1/cmr/bx/n' +... instead on input line 0. +\end{verbatim} +\end{dviversion} +\begin{pdfversion} +\begin{verbatim} +LaTeX Font Warning: Font shape `OT1/cmr/bx/sc' undefined +(Font) using `OT1/cmr/bx/n' instead on input line 0. +\end{verbatim} +\end{pdfversion} +\endhtmlignore +\begin{htmlversion} +\begin{verbatim} +LaTeX Font Warning: Font shape `OT1/cmr/bx/sc' undefined +(Font) using `OT1/cmr/bx/n' instead on input line 0. +\end{verbatim} +\end{htmlversion} + +Substitutions may also be ``silent''; in this case, there is no more +than an ``information'' message in the log file. For example, if you +specify an encoding for which there is no version in the current font +family, the `default family for the encoding' is selected. This +happens, for example, if you use command \csx{textbullet}, which is +normally taken from the maths symbols font, which is in |OMS| +encoding. My test log contained: +\htmlignore +\begin{dviversion} +\begin{verbatim} +LaTeX Font Info: Font shape `OMS/cmr/m/n' in +... size <10> not available +(Font) Font shape `OMS/cmsy/m/n' +... tried instead on input +... line ... +\end{verbatim} +\end{dviversion} +\begin{pdfversion} +\begin{verbatim} +LaTeX Font Info: Font shape `OMS/cmr/m/n' in size <10> not available +(Font) Font shape `OMS/cmsy/m/n' tried instead on input line ... +\end{verbatim} +\end{pdfversion} +\endhtmlignore +\begin{htmlversion} +\begin{verbatim} +LaTeX Font Info: Font shape `OMS/cmr/m/n' in size <10> not available +(Font) Font shape `OMS/cmsy/m/n' tried instead on input line ... +\end{verbatim} +\end{htmlversion} + +In summary, these messages are not so much error messages, as +information messages, that tell you what \LaTeX{} has made of your +text. You should check what the messages say, but you will ordinarily +not be surprised at their content. +\begin{ctanrefs} +\item[type1cm.sty]\CTANref{type1cm} +\item[type1ec.sty]\CTANref{type1ec} +\end{ctanrefs} + +\Question[Q-buffovl]{Unable to read an entire line} + +\TeX{} belongs to the generation of applications written for +environments that didn't offer the sophisticated string and i/o +manipulation we nowadays take for granted (\TeX{} was written in +Pascal, and the original Pascal standard made no mention of i/o, so +that anything but the most trivial operations were likely to be +unportable). + +When you overwhelm \TeX{}'s input mechanism, you get told: +\begin{verbatim} +! Unable to read an entire line---bufsize=3000. + Please ask a wizard to enlarge me. +\end{verbatim} +(for some value of `3000'~--- the quote was from a +\Newsgroup{comp.text.tex} posting by a someone who was presumably +using an old \TeX{}). + +As the message implies, there's (what \TeX{} thinks of as a) line in +your input that's ``too long'' (to \TeX{}'s way of thinking). Since +modern distributions tend to have tens of thousands of bytes of input +buffer, it's somewhat rare that these messages occur ``for real''. +Probable culprits are: +\begin{itemize} +\item A file transferred from another system, without translating + record endings. With the decline of fixed-format records (on + mainframe operating systems) and the increased intelligence of + \TeX{} distributions at recognising other systems' explicit + record-ending characters, this is nowadays rather a rare cause of + the problem. +\item A graphics input file, which a package is examining for its + bounding box, contains a binary preview section. Again, + sufficiently clever \TeX{} distributions recognise this situation, + and ignore the previews (which are only of interest, if at all, to a + \TeX{} previewer). +\end{itemize} + +The usual advice is to ignore what \TeX{} says (i.e., anything about +enlarging), and to put the problem right in the source. + +If the real problem is over-long text lines, most self-respecting text +editors will be pleased to automatically split long lines (while +preserving the ``word'' structure) so that they are nowhere any longer +than a given length; so the solution is just to edit the file. + +If the problem is a ridiculous preview section, try using +\ProgName{ghostscript} to reprocess the file, outputting a ``plain +\extension{eps}'' file. (\ProgName{Ghostscript} is distributed with a script +\ProgName{ps2epsi} which will regenerate the preview if necessary.) +Users of the shareware program \ProgName{GSview} will find buttons to +perform the required transformation of the file being displayed. +\begin{ctanrefs} +\item[ghostscript]Browse \CTANref{ghostscript} +\item[GSview]Browse \CTANref{gsview} +\end{ctanrefs} + +\Question[Q-formatstymy]{``Fatal format file error; I'm stymied''} + +\AllTeX{} applications often fail with this error when you've been +playing with the configuration, or have just installed a new version. + +The format file contains the macros that define the system you want to +use: anything from the simplest (\plaintex{}) all the way to the most +complicated, such as \LaTeX{} or \CONTeXT{}. From the command you +issue, \TeX{} knows which format you want. + +The error message +\begin{verbatim} + Fatal format file error; I'm stymied +\end{verbatim} +means that \TeX{} itself can't understand the format you want. +Obviously, this could happen if the format file had got corrupted, but +it usually doesn't. The commonest cause of the message, is that a new +binary has been installed in the system: no two \TeX{} binaries on the +same machine can +understand each other's formats. So the new version of \TeX{} you +have just installed, won't understand the format generated by the one +you installed last year. + +Resolve the problem by regenerating the format; of course, this +depends on which system you are using. +\begin{itemize} +\item On a te\TeX{}-based system, run +\begin{verbatim} + fmtutil --all +\end{verbatim} + or +\begin{verbatim} + fmtutil --byfmt=<format name> +\end{verbatim} + to build only the format that you are interested in. +\item On a \miktex{} system, click \texttt{Start}\arrowhyph{}% +\texttt{Programs}\arrowhyph{}% +\texttt{\miktex{} \emph{version}}\arrowhyph{}% +\texttt{\miktex{} Options}, and in the options window, click + \texttt{Update now}. +\end{itemize} + +\Question[Q-nonpdfsp]{Non-\acro{PDF} special ignored!} + +This is a \PDFTeX{} error: \PDFTeX{} is running in \acro{PDF} output +% beware line break at end line +mode, and it has encountered a \nothtml{\csx{special} command (}% +\Qref{\csx{special}}{Q-specials}\latexhtml{)}{ command}. \PDFTeX{} is +able to generate its own output, and in this mode of operation has no +need of \csx{special} commands (which allow the user to pass +information to the driver being used to generate output). + +Why does this happen? \LaTeX{} users, nowadays, hardly ever use +\csx{special} commands on their own~--- they employ packages to do the +job for them. Some packages will generate \csx{special} commands +however they are invoked: \Package{pstricks} is an example (it's very +raison d'\^etre is to emit \PS{} code in a sequence of \csx{special} +commands). \Package{Pstricks} may be dealt with by other means (the +\Package{pdftricks} package offers a usable technique). + +More amenable to correction, but more confusing, are packages (such as +\Package{color}, \Package{graphics} and \Package{hyperref}) that +specify a ``driver''. These packages have plug-in modules that +determine what \csx{special} (or other commands) are needed to generate +any given effect: the \texttt{pdftex} driver for such packages knows not to +generate \csx{special} commands. In most circumstances, you can let +the system itself choose which driver you need; in this case +everything will act properly when you switch to using \PDFLaTeX{}. If +you've been using \ProgName{dvips} (and specifying the |dvips| driver) +or \ProgName{dvipdfm} (for which you have to specify the driver), and +decide to try \PDFLaTeX{}, you \emph{must} remove the |dvips| or +|dvipdfm| driver specification from the package options, and let the +system recognise which driver is needed. +\begin{ctanrefs} +\item[pdftricks.sty]\CTANref{pdftricks} +\item[pstricks.sty]\CTANref{pstricks} +\end{ctanrefs} + +\Question[Q-8000]{Mismatched mode ljfour and resolution 8000} + +You're running \ProgName{dvips}, and you encounter a stream of error +messages, starting with ``\texttt{Mismatched mode}''. The mode is the +default used in your installation~--- it's set in the \ProgName{dvips} +configuration file, and \texttt{ljfour} is commonest (since it's the +default in most distributions), but not invariable. + +The problem is that \ProgName{dvips} has encountered a font for which +it must generate a bitmap (since it can't find it in Type~1 format), +and there is no proforma available to provide instructions to give to +\MF{}. + +So what to do? The number 8000 comes from the `\texttt{-Ppdf}' option +to \ProgName{dvips}, which you might have found from the answer +\nothtml{``wrong type of fonts'' (}% beware % beware line breaks +\Qref{``wrong type of fonts''}{Q-fuzzy-type3}\nothtml{)}. The obvious +solution is to switch to the trivial substitute `\texttt{-Pwww}', +which selects the necessary type~1 fonts for \acro{PDF} generation, +but nothing else: however, this will leave you with undesirable bitmap +fonts in your \acro{PDF} file. The ``proper'' solution is to find a +way of expressing what you want to do, using type~1 fonts. + +\Question[Q-toodeep]{``Too deeply nested''} + +This error appears when you start a \LaTeX{} list. + +\LaTeX{} keeps track of the nesting of one list inside another. There +is a set of list formatting parameters built-in for application to +each of the list nesting levels; the parameters determine indentation, +item separation, and so on. The \environment{list} environment (the +basis for list environments like \environment{itemize} and +\environment{enumerate}) ``knows'' there are only 6 of these sets. + +There are also different label definitions for the +\environment{enumerate} and \environment{itemize} environments at +their own private levels of nesting. Consider this example: +\begin{quote} +\begin{verbatim} +\begin{enumerate} +\item first item of first enumerate + \begin{itemize} + \item first item of first itemize + \begin{enumerate} + \item first item of second enumerate + ... + \end{enumerate} + ... + \end{itemize} +... +\end{enumerate} +\end{verbatim} +\end{quote} +In the example, +\begin{itemize} +\item the first \environment{enumerate} has labels as for a + first-level \environment{enumerate}, and is indented as for a + first-level list; +\item the first \environment{itemize} has labels as for a first level + \environment{itemize}, and is indented as for a second-level list; + and +\item the second \environment{enumerate} has labels as for a + second-level \environment{enumerate}, and is indented as for a + third-level list. +\end{itemize} +Now, as well as \LaTeX{} \emph{knowing} that there are 6~sets of +parameters for indentation, it also \emph{knows} that there are only +4~types of labels each, for the environments \environment{enumerate} +and \environment{itemize} (this ``knowledge'' spells out a requirement +for class writers, since the class supplies the sets of parameters). + +From the above, we can deduce that there are several ways we can run +out of space: we can have 6~lists (of any sort) nested, and try to +start a new one; we can have 4~\environment{enumerate} environments +somewhere among the set of nested lists, and try to add another one; +and we can have 4~\environment{itemize} environments somewhere among +the set of nested lists, and try to add another one. + +What can be done about the problem? Not much, short of rewriting +\LaTeX{}~--- you really need to rewrite your document in a slightly +less labyrinthine way. + +\Question[Q-inputlev]{Capacity exceeded~--- input levels} + +The error +\begin{wideversion} +\begin{verbatim} +! TeX capacity exceeded, sorry [text input levels=15]. +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +! TeX capacity exceeded, sorry + [text input levels=15]. +\end{verbatim} +\end{narrowversion} +is caused by nesting your input too deeply. You can provoke it with +the trivial (\plaintex{}) file \File{input.tex}, which contains +nothing but: +\begin{verbatim} +\input input +\end{verbatim} +In the real world, you are unlikely to encounter the error with a +modern \TeX{} distribution. Te\TeX{} (used to produce the error +message above) allows 15 files open for \TeX{} input at any one time, +which is improbably huge for a document generated by real human +beings. + +However, for those improbable (or machine-generated) situations, +some distributions offer the opportunity to adjust the parameter +|max_in_open| in a configuration file. + +\Question[Q-hyperdupdest]{\PDFTeX{} destination \dots{}\ ignored} + +The warning: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +! pdfTeX warning (ext4): destination with the same identifier +(name{page.1}) has been already used, duplicate ignored +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +! pdfTeX warning (ext4): destination with + the same identifier (name{page.1}) has + been already used, duplicate ignored +\end{verbatim} +{\small NB: message text wrapped to fit in the column\par} +\end{narrowversion} +\end{quote} +arises because of duplicate page numbers in your document. The +problem is usually soluble: see % beware line break +\Qref*[question]{\acro{PDF} page destinations}{Q-pdfpagelabels}~--- which +answer also describes the problem in more detail. + +If the identifier in the message is different, for example +|name{figure.1.1}|, the problem is (usually) due to a problem of +package interaction. Some packages are simply incompatible with +\Package{hyperref}, but most work simply by ignoring it. In most +cases, therefore, you should load your package before you load +\Package{hyperref}, and \Package{hyperref} will patch things up so +that they work, so you can utilise your (patched) package \emph{after} +loading both: +\begin{quote} + \cmdinvoke{usepackage}{\emph{your package}}\\ + \texttt{...}\\ + \cmdinvoke{usepackage}[\emph{opts}]{hyperref}\\ + \texttt{...}\\ + \meta{code that uses your package} +\end{quote} +\begin{wideversion} +For example: +\begin{quote} +\begin{verbatim} +\usepackage{float} % defines \newfloat +... +\usepackage[...]{hyperref} % patches \newfloat +... +\newfloat{...}{...}{...} +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +So, if we need \csx{newfloat}: +\begin{quote} +\cmdinvoke{usepackage}{float} +\end{quote} +will define the command, +\begin{quote} +\cmdinvoke{usepackage}[\emph{opts}]{hyperref} +\end{quote} +will patch it, and now: +\begin{quote} +\cmdinvoke{newfloat}{...}{...}{...} +\end{quote} +will use the command, patched to create `proper' hyperreferences. +\end{narrowversion} +You should load packages in this order as a matter of course, unless +the documentation of a package says you \emph{must} load it after +\Package{hyperref}. (There aren't many packages that require to be +loaded after hyperref: one such is \Class{memoir}'s +``\Package{hyperref} fixup'' package \Package{memhfixc}.) + +If loading your packages in the (seemingly) ``correct'' order doesn't +solve the problem, you need to \Qref*{seek further help}{Q-gethelp}. + +\Question[Q-altabcr]{Alignment tab changed to \csx{cr}} + +This is an error you may encounter in \LaTeX{} when a tabular +environment is being processed. ``Alignment tabs'' are the +\texttt{\&} signs that separate the columns of a tabular; so the error +message +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +! Extra alignment tab has been + changed to \cr +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +! Extra alignment tab has been changed to \cr +\end{verbatim} +\end{wideversion} +\end{quote} +could arise from a simple typo, such as: +\begin{quote} +\begin{verbatim} +\begin{tabular}{ll} + hello & there & jim \\ + goodbye & now +\end{tabular} +\end{verbatim} +\end{quote} +where the second \texttt{\&} in the first line of the table is more than the +two-column \texttt{ll} column specification can cope with. In this +case, an extra ``\texttt{l}'' in that solves the problem. (If you +continue from the error in this case, ``\texttt{jim}'' will be moved +to a row of his own.) Another simple typo that can provoke the error +is: +\begin{quote} +\begin{verbatim} +\begin{tabular}{ll} + hello & there + goodbye & now +\end{tabular} +\end{verbatim} +\end{quote} +where the `\texttt{\bsbs }' has been missed from the first line of the table. +In this case, if you continue from the error, you will find that +\LaTeX{} has made a table equivalent to: +\begin{quote} +\begin{verbatim} +\begin{tabular}{ll} + hello & there goodbye\\ + now +\end{tabular} +\end{verbatim} +\end{quote} +(with the second line of the table having only one cell). + +Rather more difficult to spot is the occurrence of the error when +you're using alignment instructions in a ``\texttt{p}'' column: +\begin{quote} +\begin{verbatim} +\usepackage{array} +... +\begin{tabular}{l>{\raggedright}p{2in}} +here & we are again \\ +happy & as can be +\end{tabular} +\end{verbatim} +\end{quote} +the problem here (as explained in % ! line break +\Qref[question]{tabular cell alignment}{Q-tabcellalign}) is that the +\csx{raggedright} command in the column specification has overwritten +\environment{tabular}'s definition of \texttt{\bsbs }, so that +``\texttt{happy}'' appears in a new line of the second column, and the +following \texttt{\&} appears to \LaTeX{} just like the second +\texttt{\&} in the first example above. + +Get rid of the error in the way described in % ! linebreak +\Qref[question]{tabular cell alignment}{Q-tabcellalign}~--- either use +\csx{tabularnewline} explicitly, or use the \csx{RBS} trick described +there. +\begin{ctanrefs} +\item[array.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-divzero]{Graphics division by zero} + +While the error +\begin{quote} +\begin{verbatim} +! Package graphics Error: Division by 0. +\end{verbatim} +\end{quote} +can actually be caused by offering the package a figure which claims +to have a zero dimension, it's more commonly caused by rotation. + +Objects in \TeX{} may have both height (the height above the baseline) +and depth (the distance the object goes below the baseline). If you +rotate an object by 180\,degrees, you convert its height into depth, +and vice versa; if the object started with zero depth, you've +converted it to a zero-height object. + +Suppose you're including your graphic with a command like: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\includegraphics[angle=180,height=5cm]{myfig.eps} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\includegraphics[angle=180,% + height=5cm]{myfig.eps} +\end{verbatim} +\end{narrowversion} +\end{quote} +In the case that \File{myfig.eps} has no depth to start with, the +scaling calculations will produce the division-by-zero error. + +Fortunately, the \Package{graphicx} package has a keyword +\pkgoption{totalheight}, which allows you to specify the size of the +image relative to the sum of the object's \pkgoption{height} and +\pkgoption{depth}, so +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\includegraphics[angle=180,totalheight=5cm]{myfig.eps} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\includegraphics[angle=180,% + totalheight=5cm]{myfig.eps} +\end{verbatim} +\end{narrowversion} +\end{quote} +will resolve the error, and will behave as you might hope. + +If you're using the simpler \Package{graphics} package, use the +\texttt{*} form of the \csx{resizebox} command to specify the use of +\pkgoption{totalheight}: +\begin{quote} +\begin{verbatim} +\resizebox*{!}{5cm}{% + \rotatebox{180}{% + \includegraphics{myfig.eps}% + }% +} +\end{verbatim} +\end{quote} +\begin{ctanrefs} +\item[graphics.sty,graphicx.sty]Both parts of the \CTANref{graphics} bundle +\end{ctanrefs} + +\Question[Q-missbegdoc]{Missing \csx{begin}\marg{document}} + +Give it a file of plain text, or a \LaTeX{} file that really does have no +\cmdinvoke{begin}{document} command in it, and \LaTeX{} will produce +this error, quite correctly. \LaTeX{} \emph{needs} +\cmdinvoke{begin}{document} so as to know when to execute the commands +that finish off the document preamble. + +Other than that, the error can occur as a result of an error of yours, +of a corrupt \extension{aux} file, or of a buggy class or package. + +The errors you might commit are absent-mindedly typing a document +command (such as \csx{section}) in the preamble of your document, +missing the comment marker from the beginning of a line, or giving too +many arguments to one of the setup commands related to the class or a +package that you have loaded. + +A corrupt \extension{aux} file might be due to any number of things; +delete the file and to run \LaTeX{} again, twice. If the error +recurs, it's probably due to a buggy class or package. + +If the error occurs while \LaTeX{} is reading a class or package, then +there's probably a bug in the file. The author of the class or +package stands the best chance of finding the bug, but with luck you +(or someone you ask on a mailing list or on \Newsgroup{comp.text.tex}) +will be able to spot the problem and provide a work-around. Always +report such bugs, even if you have found a work-around. + +\Question[Q-normalszmiss]{\csx{normalsize} not defined} + +The \LaTeX{} error: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +The font size command \normalsize is not + defined: there is probably something + wrong with the class file. +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +The font size command \normalsize is not defined: +there is probably something wrong with the class file. +\end{verbatim} +\end{wideversion} +\end{quote} +is reporting something pretty fundamental (document base font size not +set up). While this \emph{can}, as the message implies, be due to a +broken class file, the more common cause is that you have simply +forgotten to put a \csx{documentclass} command in your document. + +\Question[Q-manymathalph]{Too many math alphabets} + +\TeX{} mathematics is one of its most impressive features, yet the +internal structure of the mechanism that produces it is painfully +complicated and (in some senses) pathetically limited. One area of +limitation is that one is only allowed 16~''maths alphabets'' + +\LaTeX{} offers the user quite a lot of flexibility with allocating +maths alphabets, but few people use the flexibility directly. +Nevertheless, there are many packages that provide symbols, or that +manipulate them, which allocate themselves one or more maths alphabet. + +If you can't afford to drop any of these packages, there's +still hope if you're using the \Package{bm} package to support +\Qref*{bold maths}{Q-boldgreek}: \Package{bm} is capable +of gobbling alphabets as if there is no tomorrow. The package defines +two limiter commands: \csx{bmmax} (for \emph{bold} symbols; default~4) +and \csx{hmmax} (for \emph{heavy} symbols, if you have them; +default~3), which control the number of alphabets to be used. + +Any reduction of the \csx{\emph{xx}max} variables will slow +\Package{bm} down~--- but that's surely better than the document not +running at all. So unless you're using maths fonts (such as +\FontName{Mathtime Plus}) that feature a heavy symbol weight, suppress all +use of heavy families by +\begin{quote} +\begin{verbatim} + \renewcommand{\hmmax}{0} +\end{verbatim} +\end{quote} +and then steadily reduce the bold families, starting with +\begin{quote} +\begin{verbatim} + \renewcommand{\bmmax}{3} +\end{verbatim} +\end{quote} +until (with a bit of luck) the error goes away. +\begin{ctanrefs} +\item[bm.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-ouparmd]{Not in outer par mode} + +The error: +\begin{quote} +\begin{verbatim} +! LaTeX Error: Not in outer par mode. +\end{verbatim} +\end{quote} +comes when some ``main'' document feature is shut up somewhere it +doesn't like. + +The commonest occurrence is when the user wants a figure somewhere +inside a table: +\begin{quote} +\begin{verbatim} +\begin{tabular}{|l|} + \hline + \begin{figure} + \includegraphics{foo} + \end{figure} + \hline +\end{tabular} +\end{verbatim} +\end{quote} +a construction that was supposed to put a frame around the diagram, +but doesn't work, any more than: +\begin{quote} +\begin{verbatim} +\framebox{\begin{figure} + \includegraphics{foo} + \end{figure}% +} +\end{verbatim} +\end{quote} +The problem is, that the \environment{tabular} environment, and the +\csx{framebox} command restrain the \environment{figure} environment +from its natural m\'etier, which is to float around the document. + +The solution is simply not to use the \environment{figure} environment +here: +\begin{quote} +\begin{verbatim} +\begin{tabular}{|l|} + \hline + \includegraphics{foo} + \hline +\end{tabular} +\end{verbatim} +\end{quote} +What was the float for?~--- as written in the first two examples, it +serves no useful purpose; but perhaps you actually wanted a diagram +and its caption framed, in a float. + +It's simple to achieve this~--- just reverse the order of the +environments (or of the \environment{figure} environment and the +command): +\begin{quote} +\begin{verbatim} +\begin{figure} + \begin{tabular}{|l|} + \hline + \includegraphics{foo} + \caption{A foo} + \hline + \end{tabular} +\end{figure} +\end{verbatim} +\end{quote} +The same goes for \environment{table} environments (or any other sort +of float you've defined for yourself) inside tabulars or box commands; +you \emph{must} get the float environment out from inside, one way or +another. + +\Question[Q-errmissitem]{Perhaps a missing \csx{item}?} + +Sometimes, the error +\begin{quote} +\begin{verbatim} +Something's wrong--perhaps a missing \item +\end{verbatim} +\end{quote} +actually means what it says: +\begin{quote} +\begin{verbatim} +\begin{itemize} + boo! +\end{itemize} +\end{verbatim} +\end{quote} +produces the error, and is plainly in need of an \csx{item} command. + +You can also have the error appear when at first sight things are +correct: +\begin{quote} +\begin{verbatim} +\begin{tabular}{l} + \begin{enumerate} + \item foo\\ + \item bar + \end{enumerate} +\end{tabular} +\end{verbatim} +\end{quote} +produces the error at the \texttt{\bsbs }. This usage is just wrong; if you +want to number the cells in a table, you have to do it ``by hand'': +\begin{quote} +\begin{verbatim} +\newcounter{tablecell} +\begin{tabular}{l} + \stepcounter{tablecell} + \thetablecell. foo\\ + \stepcounter{tablecell} + \thetablecell. bar + \end{enumerate} +\end{tabular} +\end{verbatim} +\end{quote} +This is obviously untidy; a command \csx{numbercell} defined as: +\begin{quote} +\begin{verbatim} +\newcounter{tablecell} +\newcommand*{\numbercell}{% + \stepcounter{tablecell}% + \thetablecell. % ** +} +\end{verbatim} +\end{quote} +could make life easier: +\begin{quote} +\begin{verbatim} +\begin{tabular}{l} + \numbercell foo\\ + \numbercell bar + \end{enumerate} +\end{tabular} +\end{verbatim} +\end{quote} +(Note the deliberate introduction of a space as part of the command, +marked with asterisks.) + +However, the error regularly appears when you would never have thought +that a \csx{item} command might be appropriate. For example, the +seemingly innocent: +\begin{quote} +\begin{verbatim} +\fbox{% + \begin{alltt} + boo! + \end{alltt}% +} +\end{verbatim} +\end{quote} +produces the error (the same happens with \csx{mbox} in place of +\csx{fbox}, or with either of their ``big brothers'', \csx{framebox} and +\csx{makebox}). This is because the \environment{alltt} environment +uses a ``trivial'' list, hidden inside their definition. (The +\environment{itemize} environment also has this construct inside +itself, in fact, so \cmdinvoke{begin}{itemize} won't work inside an +\csx{fbox}, either.) The list construct wants to happen between +paragraphs, so it makes a new paragraph of its own. Inside the +\csx{fbox} command, that doesn't work, and subsequent macros convince +themselves that there's a missing \csx{item} command. + +To solve this rather cryptic error, one must put the +\environment{alltt} inside a paragraph-style box. The following +modification of the above \emph{does} work: +\begin{quote} +\begin{verbatim} +\fbox{% + \begin{minipage}{0.75\textwidth} + \begin{alltt} + hi, there! + \end{alltt} + \end{minipage} +} +\end{verbatim} +\end{quote} +The code above produces a box that's far too wide for the text. One +may want to use something that allows % ! line break +\Qref*{variable size boxes}{Q-varwidth} in place of the +\environment{minipage} environment. + +Oddly, although the \environment{verbatim} environment wouldn't work +inside a \csx{fbox} command argument (see % ! line break +\Qref[question]{verbatim in command arguments}{Q-verbwithin}), you +get an error that complains about \csx{item}: the environment's +internal list bites you before \environment{verbatim} has even had a +chance to create its own sort of chaos. + +Another (seemingly) obvious use of \csx{fbox} also falls foul of this +error: +\begin{quote} +\begin{verbatim} +\fbox{\section{Boxy section}} +\end{verbatim} +\end{quote} +This is a case where you've simply got to be more subtle; you should +either write your own macros to replace the insides of \LaTeX{}'s +sectioning macros, or look for some alternative in the packages +discussed in % ! line break +``\Qref*[question]{The style of section headings}{Q-secthead}''. + +\Question[Q-errparnum]{Illegal parameter number in definition} + +The error message means what it says. In the simple case, you've +attempted a definition like: +\begin{quote} +\begin{verbatim} +\newcommand{\abc}{joy, oh #1!} +\end{verbatim} +\end{quote} +or (using \TeX{} primitive definitions): +\begin{quote} +\begin{verbatim} +\def\abc{joy, oh #1!} +\end{verbatim} +\end{quote} +In either of the above, the definition uses an argument, but the +programmer did not tell \AllTeX{}, in advance, that she was going to. +The fix is simple~--- \cmdinvoke{newcommand}{\csx{abc}}[1], in the +\LaTeX{} case, |\def\abc#1| in the basic \TeX{} case. + +The more complicated case is exemplified by the attempted definition: +\begin{quote} +\begin{verbatim} +\newcommand{\abc}{joy, oh joy!% + \newcommand{\ghi}[1]{gloom, oh #1!}% +} +\end{verbatim} +\end{quote} +will also produce this error, as will its \TeX{} primitive equivalent: +\begin{quote} +\begin{verbatim} +\def\abc{joy, oh joy!% + \def\ghi#1{gloom, oh #1!}% +} +\end{verbatim} +\end{quote} +This is because special care is needed when defining one macro within +the code of another macro. This is explained elsewhere, separately +for \Qref*[question]{\LaTeX{} definitions}{Q-ltxhash} and for +\Qref*[question]{\TeX{} primitive definitions}{Q-hash} + +\Question[Q-fllost]{Float(s) lost} + +The error +\begin{quote} +\begin{verbatim} +! LaTeX Error: Float(s) lost. +\end{verbatim} +\end{quote} +seldom occurs, but always seems deeply cryptic when it \emph{does} +appear. + +The message means what it says: one or more figures, tables, etc., or +marginpars has not been typeset. (Marginpars are treated internally +as floats, which is how they come to be lumped into this error +message.) + +The most likely reason is that you placed a float or a \csx{marginpar} +command inside another float or marginpar, or inside a +\environment{minipage} environment, a \csx{parbox} or \csx{footnote}. +Note that the error may be detected a long way from the problematic +command(s), so the techniques of % ! line break +\Qref*{tracking down elusive errors}{Q-erroradvice} all need to be +called into play. + +This author has also encountered the error when developing macros that +used the \LaTeX{} internal float mechanisms. Most people doing that +sort of thing are expected to be able to work out their own problems\dots{} + +\Question[Q-texorpdf]{Token not allowed in PDFDocEncoded string} + +The package \Package{hyperref} produces this error when it doesn't +know how to make something into a ``character'' that will go into one +of its \acro{PDF} entries. For example, the (unlikely) sequence +\begin{quote} +\begin{verbatim} +\newcommand{\filled}[2]{% + #1% + \hfil + #2% +} +\section{\filled{foo}{bar}} +\end{verbatim} +\end{quote} +provokes the error. \Package{Hyperref} goes on to tell you: +\begin{quote} +\begin{verbatim} +removing `\hfil' on input line ... +\end{verbatim} +\end{quote} +It's not surprising: how would \emph{you} put the +typesetting instruction \csx{hfil} into a \acro{PDF} bookmark? + +\Package{Hyperref} allows you to define an alternative for such +things: the command \csx{texorpdfstring}, which takes two +arguments~--- the first is what is typeset, the second is what is put +into the bookmark. For example, what you would probably like in this +case is just a single space in the bookmark; if so, the erroneous +example above would become: +\begin{quote} +\begin{verbatim} +\newcommand{\filled}[2]{% + #1% + \texorpdfstring{\hfil}{\space}% + #2% +} +\section{\filled{foo}{bar}} +\end{verbatim} +\end{quote} +and with that definition, the example will compile succesfully +(\Package{hyperref} knows about the macro \csx{space}). +\LastEdit*{2009-05-29} + +\Question[Q-optionclash]{Option clash for package} + +So you've innocently added: +\begin{quote} +\cmdinvoke{usepackage}[draft]{graphics} +\end{quote} +to your document, and \LaTeX{} responds with +\begin{wideversion} +\begin{quote} +\begin{verbatim} +! LaTeX Error: Option clash for package graphics. +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +! LaTeX Error: Option clash for package + graphics. +\end{verbatim} +\end{quote} +\end{narrowversion} + +The error is a complaint about loading a package % ! line break +\emph{with options}, more than once (\LaTeX{} doesn't actually examine +what options there are: it complains because it can't do anything with +the multiple sets of options). You can load a package +any number of times, with no options, and \LaTeX{} will be happy, but +you may only supply options when you first load the package. + +So perhaps you weren't entirely innocent~--- the error would have +occurred on the second line of: +\begin{quote} +\cmdinvoke{usepackage}[dvips]{graphics}\\ +\cmdinvoke{usepackage}[draft]{graphics} +\end{quote} +which could quite reasonably (and indeed correctly) have been typed: +\begin{quote} +\cmdinvoke{usepackage}[dvips,draft]{graphics} +\end{quote} + +But if you've not made that mistake (even with several lines +separating the \csx{usepackage} commands, it's pretty easy to spot), +the problem could arise from something else loading the package for +you. How do you find the culprit? The "\texttt{h}" response to the +error message tells you which options were loaded each time. +Otherwise, it's down to the log analysis games discussed in % ! line break +``\Qref*{How to approach errors}{Q-erroradvice}''; the trick to remember +is that that the process of loading each file is parenthesised in the +log; so if package \Package{foo} loads \Package{graphics}, the log +will contain something like: +\begin{quote} +\begin{verbatim} +(<path>/foo.sty ... +... +(<path>/graphics.sty ... +...) +... +) +\end{verbatim} +\end{quote} +(the parentheses for \Package{graphics} are completely enclosed in +those for \Package{foo}; the same is of course true if your class +\Class{bar} is the culprit, except that the line will start with the +path to \texttt{bar.cls}). + +If we're dealing with a package that loads the package you are +interested in, you need to ask \LaTeX{} to slip in options when +\Package{foo} loads it. Instead of: +\begin{quote} +\cmdinvoke{usepackage}{foo}\\ +\cmdinvoke{usepackage}[draft]{graphics} +\end{quote} +you would write: +\begin{quote} +\cmdinvoke{PassOptionsToPackage}{draft}{graphics}\\ +\cmdinvoke{usepackage}{foo} +\end{quote} +The command \csx{PassOptionsToPackage} tells \LaTeX{} to behave as if +its options were passed, when it finally loads a package. As you would +expect from its name, \csx{PassOptionsToPackage} can deal with a list +of options, just as you would have in the the options brackets of +\csx{usepackage}. + +More trickily, instead of: +\begin{quote} +\cmdinvoke{documentclass}[...]{bar}\\ +\cmdinvoke{usepackage}[draft]{graphics} +\end{quote} +you would write: +\begin{quote} +\cmdinvoke{PassOptionsToPackage}{draft}{graphics}\\ +\cmdinvoke{documentclass}[...]{bar} +\end{quote} +with \csx{PassOptionsToPackage} \emph{before} the \csx{documentclass} +command. + +However, if the \Package{foo} package or the \Class{bar} class loads +\Package{graphics} with an option of its own that clashes with +what you need in some way, you're stymied. For example: +\begin{quote} +\cmdinvoke{PassOptionsToPackage}{draft}{graphics} +\end{quote} +where the package or class does: +\begin{quote} +\cmdinvoke{usepackage}[final]{graphics} +\end{quote} +sets \pkgoption{final} \emph{after} it's dealt with option you passed to +it, so your \pkgoption{draft} will get forgotten. In extreme cases, +the package might generate an error here (\Package{graphics} doesn't +go in for that kind of thing, and there's no indication that +\pkgoption{draft} has been forgotten). + +In such a case, you have to modify the package or class itself +(subject to the terms of its licence). It may prove useful to contact +the author: she may have a useful alternative to suggest. + +\Question[Q-checksum]{Checksum mismatch in font} + +When \MF{} generates a font it includes a checksum in the font bitmap +file, and in the font metrics file (\acro{TFM}). \AllTeX{} includes +the checksum from the \acro{TFM} file in the \acro{DVI} file. + +When \ProgName{dvips} (or other \acro{DVI} drivers) process a +\acro{DVI} file, they compare checksums in the \acro{DVI} file to +those in the bitmap fonts being used for character images. If the +checksums don't match, it means the font metric file used by \AllTeX{} +was not generated from the same \MF{} program that generated the +font. + +This commonly occurs when you're processing someone else's \acro{DVI} +file. + +The fonts on your system may also be at fault: possibilities are that +the new \acro{TFM} was not installed, or installed in a path after an +old \acro{TFM} file, or that you have a personal cache of bitmaps from +an old version of the font. + +In any case, look at the output -- the chances are that it's perfectly +\acro{OK}, since metrics tend not to change, even when the bitmaps are +improved. (Indeed, many font designers~--- Knuth included~--- +maintain the metrics come what may.) + +If the output \emph{does} look bad, your only chance is to regenerate +things from scratch. Options include: flushing your bitmap cache, +rebuild the \acro{TFM} file locally, and so on. + +\Question[Q-entercompmode]{Entering compatibility mode} + +You run your \LaTeX{} job, and it starts by saying +\begin{quote} +\begin{verbatim} +Entering LaTeX 2.09 COMPATIBILITY MODE +\end{verbatim} +\end{quote} +followed by lines of asterisks and \texttt{!!WARNING!!}. + +This means that the document is not written in ``current'' \LaTeX{} +syntax, and that there is no guarantee that all parts of the document +will be formatted correctly. + +If the document is someone else's, and you want no more than a copy to +read, ignore the error. The document may fail elsewhere, but as often +as not it will provide a \extension{dvi} or \extension{pdf} that's +adequate for most purposes. + +If it's a new document you have just started working on, you have been +misled by someone. You have written something like: +\begin{quote} + \cmdinvoke{documentstyle}{article} +\end{quote} +or, more generally: +\begin{quote} + \cmdinvoke*{documentstyle}[options]{class} +\end{quote} +These forms are (as the warning says) \LaTeXo{} syntax, and to get rid +of the warning, you must change the command. + +The simple form is easy to deal with: +\begin{quote} + \cmdinvoke{documentstyle}{article} +\end{quote} +should become: +\begin{quote} + \cmdinvoke{documentclass}{article} +\end{quote} +The complex form is more difficult, since \LaTeXo{} ``options'' +conflate two sorts of things~--- options for the class (such as +\pkgoption{11pt}, \pkgoption{fleqn}), and packages to be loaded. +So: +\begin{quote} + \cmdinvoke{documentstyle}[11pt,verbatim]{article} +\end{quote} +should become: +\begin{quote} + \cmdinvoke{documentclass}[11pt]{article}\\ + \cmdinvoke{usepackage}{verbatim} +\end{quote} +because \pkgoption{11pt} happens to be a class option, while +\Package{verbatim} is a package. + +There's no simple way to work out what are class options under +\LaTeXo{}; for \Class{article}, the list includes \pkgoption{10pt}, +\pkgoption{11pt}, \pkgoption{12pt}, \pkgoption{draft}, +\pkgoption{fleqn}, \pkgoption{leqno}, \pkgoption{twocolumn} and +\pkgoption{twoside}~--- anything else must be a package. + +Your document may well ``just work'' after changes like those above; +if not, you should think through what you're trying to do, and consult +documentation on how to do it~--- there are lots of % ! line break +\Qref*{free tutorials}{Q-tutorials*} to help you on your way, if you +don't have access to a \LaTeX{} manual of any sort. + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-lab-ref.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-lab-ref.tex new file mode 100644 index 00000000000..5f7f2cea0af --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-lab-ref.tex @@ -0,0 +1,184 @@ +% $Id: faq-lab-ref.tex,v 1.1 2009/06/13 20:56:44 rf10 Exp rf10 $ + +\subsection{Labels and references} + +\Question[Q-nameref]{Referring to things by their name} + +\LaTeX{}'s labelling mechanism is designed for the impersonal world of +the academic publication, in which everything has a number: an +extension is necessary if we are to record the \emph{name} of things +we've labelled. The two packages available extend the \LaTeX{} +sectioning commands to provide reference by the name of the section. + +The \Package{titleref} package is a simple extension which provides +the command \csx{titleref}; it is a stand-alone package~--- don't use it +in a document in which you also need to use \Package{hyperref}. + +The \Package{byname} package is part of the \Package{smartref} bundle +and works well with \Package{smartref}, and works (to an extent) with +\Package{hyperref}, but the links it defines are not hyperlinks. + +The \Class{memoir} class incorporates the functionality of +\Package{titleref}, but doesn't work with \Package{byname} (though a +search of \Newsgroup{comp.text.tex} on \URL{groups.google.com} will +find a patch to \Package{byname} to remedy the problem). + +The \Package{hyperref} bundle includes a package \Package{nameref}, +which will work standing alone (i.e., without \Package{hyperref}: of +course, in this mode its references are not hyperlinked). If you load +\Package{hyperref} itself, \Package{nameref} is automatically loaded. +\Class{Memoir} requires the \Package{memhfixc} when running with +\Package{hyperref}; following the sequence: +\begin{quote} +\begin{verbatim} +\documentclass[...]{memoir} +... +\usepackage[...]{hyperref} +\usepackage{memhfixc} +\end{verbatim} +\end{quote} +\Package{nameref} commands may be used in a \Class{memoir} document. + +\Package{Zref} defines a proposed replacement for all of the \LaTeX{} +reference mechanisms, and among other things provides +name-referencing mechanisms: +\begin{quote} +\begin{verbatim} +\usepackage[user,titleref]{zref} +... +\section{hello}\zlabel{sec:one} +The section name is: \ztitleref{sec:one}. +\end{verbatim} +\end{quote} +(One might hope that something of this sort would be the ``way of the +future'', but things move slowly in the \LaTeX{} world: don't hold +your breath.) + +Each of \Package{titleref}, \Package{byname} and \Package{nameref} +defines a reference command with the same name as the package: +\csx{titleref}, \csx{byname} and \csx{nameref}. The \Package{nameref} +package also defines a command \csx{byshortnameref}, which uses the +optional `short' title argument to the chapter and section commands. +(Although it comes from the same author, \Package{zref} \emph{doesn't} +define a short-name variant.) +\begin{ctanrefs} +\item[byname.sty]Distributed with \CTANref{smartref} +\item[hyperref.sty]\CTANref{hyperref} +\item[memoir.cls]\CTANref{memoir} +\item[nameref.sty]Distributed with \CTANref{hyperref} +\item[smartref.sty]\CTANref{smartref} +\item[titleref.sty]\CTANref{titleref} +\item[zref.sty]Distributed as part of \CTANref{oberdiek} +\end{ctanrefs} + +\Question[Q-extref]{Referring to labels in other documents} + +When producing a set of inter-related documents, you'll often want to +refer to labels in another document of the set; but \LaTeX{}, of its +own accord, doesn't permit this. + +So the package \Package{xr} was written: if you say +\begin{quote} +\begin{verbatim} +\usepackage{xr} +\externaldocument{volume1} +\end{verbatim} +\end{quote} +will load all the references from \File{volume1} into your present +document. + +But what if the documents both have a section labelled +``\environment{introduction}'' (likely enough, after all)? The +package provides a means to transform all the imported labels, so you +don't have to change label names in either document. For example: +\begin{quote} +\begin{verbatim} +\usepackage{xr} +\externaldocument[V1-]{volume1} +\end{verbatim} +\end{quote} +loads the references from \File{volume1}, but prefixes every one with +the string \texttt{V1-}. So you would refer to the introduction to volume~1 +as: +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +\usepackage{xr} +\externaldocument[V1-]{volume1} +... +... the introduction to volume1 + (\ref{V1-introduction})... +\end{verbatim} +\end{quote} +\end{narrowversion} +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\usepackage{xr} +\externaldocument[V1-]{volume1} +... +... the introduction to volume1 (\ref{V1-introduction})... +\end{verbatim} +\end{quote} +\end{wideversion} +To have the facilities of \Package{xr} working with +\Package{hyperref}, you need \Package{xr-hyper}. For simple +hyper-cross-referencing (i.e., to a local \acro{PDF} file you've just +compiled), write: +\begin{quote} +\begin{verbatim} +\usepackage{xr-hyper} +\usepackage{hyperref} +\externaldocument[V1-]{volume1} +... +... the \nameref{V1-introduction})... +\end{verbatim} +\end{quote} +and the name reference will appear as an active link to the +``introduction'' chapter of \File{volume1.pdf}. + +To link to a \acro{PDF} document on the Web, for which you happen to +have the .aux file, write: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\usepackage{xr-hyper} +\usepackage{hyperref} +\externaldocument[V1-]{volume1}[http://mybook.com/volume1.pdf] +... +... the \nameref{V1-introduction})... +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\usepackage{xr-hyper} +\usepackage{hyperref} +\externaldocument[V1-]{volume1}% + [http://mybook.com/volume1.pdf] +... +... the \nameref{V1-introduction})... +\end{verbatim} +\end{narrowversion} +\end{quote} +Heiko Oberdiek's experimental \Package{zref} bundle includes a +hyper-crossreferencing mechanism using its \Package{zref-xr} module. +Usage is closely modelled on \Package{xr} and \Package{xr-hyper}; a +trivial example (from a \Newsgroup{comp.text.tex} posting) is +\begin{quote} +\begin{verbatim} +\usepackage{zref-xr,zref-user} +\zexternaldocument*{xr02} +... +\zref{foo} +\end{verbatim} +\end{quote} +The module provides all the facilities of the older packages, and can +deal both with ``traditional'' \LaTeX{} labels and with +\Package{zref}'s style of labels. +\begin{ctanrefs} +\item[xr.sty]Distributed as part of \CTANref{2etools} +\item[xr-hyper.sty]Distributed with \CTANref{hyperref} +\item[zref \nothtml{\rmfamily\itshape}bundle]Distributed as part of + \CTANref{oberdiek} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-litprog.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-litprog.tex new file mode 100644 index 00000000000..277796e5969 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-litprog.tex @@ -0,0 +1,79 @@ +% $Id: faq-litprog.tex,v 1.1 2009/06/13 20:56:39 rf10 Exp rf10 $ + +\section{Literate programming} + +\Question[Q-lit]{What is Literate Programming?} + +Literate programming is the combination of documentation and source +together in a fashion suited for reading by human beings. +In general, literate programs combine source +and documentation in a single file. Literate programming tools then +parse the file to produce either readable documentation or compilable +source. The \acro{WEB} style of literate programming was created by +D.~E.~Knuth during the development of \TeX{}. + +\htmlignore +The ``documented \LaTeX{}'' style of programming (\Qref{}{Q-dtx}) +\endhtmlignore +\begin{htmlversion} + The ``\Qref{documented \LaTeX{}}{Q-dtx}'' style of programming +\end{htmlversion} +is regarded by some as a form of literate programming, though it only +contains a subset of the constructs Knuth used. + +Discussion of literate programming is conducted in the newsgroup +\Newsgroup{comp.programming.literate}, whose \acro{FAQ} is stored on +\acro{CTAN}. Another good source of information is +\URL{http://www.literateprogramming.com/} +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Literate Programming \acro{FAQ}]% + \CTANref{LitProg-FAQ} +\end{ctanrefs} + +\Question[Q-webpkgs]{\acro{WEB} systems for various languages} + +\TeX{} is written in the programming language \acro{WEB}; \acro{WEB} +is a tool to implement the concept of ``literate programming''. +Knuth's original implementation will be in any respectable +distribution of \TeX{}, but the sources of the two tools +(\ProgName{tangle} and \ProgName{weave}), together with a manual +outlining the programming techniques, may be had from \acro{CTAN}. + +\acro{\ProgName{CWEB}}, by Silvio Levy, is a \acro{WEB} for \acro{C} programs. + +Spidery \acro{WEB}, by Norman Ramsey, supports many +languages including Ada, \texttt{awk}, and \acro{C} +and, while not in the public domain, is usable without charge. It is +now superseded by \ProgName{noweb} (also by Norman Ramsay) which +incorporates the lessons learned in implementing spidery \acro{WEB}, +and which is a simpler, equally powerful, tool. + +\acro{\ProgName{FWEB}}, by John Krommes, is a version for Fortran, +Ratfor, and \acro{C}. + +\ProgName{Scheme}\acro{\ProgName{WEB}}, by John Ramsdell, is a Unix filter that +translates Scheme\acro{WEB} into \LaTeX{} source or Scheme source. + +\acro{\ProgName{APLWEB}} is a version of \acro{WEB} for \acro{APL}. + +\ProgName{FunnelWeb} is a version of \acro{WEB} that is language independent. + +Other language independent versions of \acro{WEB} are \ProgName{nuweb} (which +is written in \acro{ANSI} \acro{C}). + +\ProgName{Tweb} is a \acro{WEB} for \plaintex{} macro files, using +\ProgName{noweb}. +\begin{ctanrefs} +\item[aplweb]\CTANref{aplweb} +\item[cweb]\CTANref{cweb} +\item[funnelweb]\CTANref{funnelweb} +\item[fweb]\CTANref{fweb} +\item[noweb]\CTANref{noweb} +\item[nuweb]\CTANref{nuweb} +\item[schemeweb]\CTANref{schemeweb} +\item[spiderweb]\CTANref{spiderweb} +\item[tangle]\CTANref{web} +\item[tweb]\CTANref{tweb} +\item[weave]\CTANref{web} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-mac-prog.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-mac-prog.tex new file mode 100644 index 00000000000..b6a6b69f721 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-mac-prog.tex @@ -0,0 +1,2967 @@ +% $Id: faq-mac-prog.tex,v 1.3 2009/08/25 17:17:55 rf10 Exp rf10 $ + +\section{Macro programming} + +\subsection{``Generic'' macros and techniques} + +\Question[Q-linmacnames]{Non-letters in macro names} + +New \LaTeX{} users are often suprised that macro definitions +containing non-letters, such as +\begin{quote} +\begin{verbatim} +\newcommand{\cul8r}{Goodbye!} +\end{verbatim} +\end{quote} +fail to compile. The reason is that the \TeX{} macro language, unlike +most programming languages, allows % ! loin break (twatbili) +\Qref*{nothing but letters in macro names}{Q-whatmacros}. + +There are a number of techniques for defining a macro with a name like +\csx{cul8r}. Unfortunately, none of the techniques is particularly +good: +\begin{enumerate} +\item Use \csx{csname}\dots\csx{endcsname} to define and invoke the + macro: + \begin{quote} +\begin{narrowversion} +\begin{verbatim} +\expandafter\newcommand + \csname cul8r\endcsname{Goodbye!} +I said, ``\csname cul8r\endcsname''. +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\expandafter\newcommand\csname cul8r\endcsname{Goodbye!} +I said, ``\csname cul8r\endcsname''. +\end{verbatim} +\end{wideversion} + \end{quote} + \begin{description} + \item[Pro:] No unexpected side effects + \item[Con:] So verbose as to be unusable + \end{description} +\item Define a ``special-command generator'', and use the resulting + commands: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\newcommand{\DefineRemark}[2]{% + \expandafter\newcommand + \csname rmk-#1\endcsname{#2}% +} +\newcommand{\Remark}[1]{% + \csname rmk-#1\endcsname% +} +... +\DefineRemark{cul8r}{Goodbye!} +... +I said, ``\Remark{cul8r}''. +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\newcommand{\DefineRemark}[2]{% + \expandafter\newcommand\csname rmk-#1\endcsname{#2}% +} +\newcommand{\Remark}[1]{\csname rmk-#1\endcsname} +... +\DefineRemark{cul8r}{Goodbye!} +... +\Remark{cul8r} +\end{verbatim} +\end{wideversion} +\end{quote} + \begin{description} + \item[Pro:] Straightforward to use, not too untidy + \item[Con:] It's hardly doing what we set out to do (experts will + see that you are defining a macro, but others likely won't) + \end{description} +\item Convince \TeX{} that ``\texttt{8}'' is a letter: + \begin{quote} +\begin{verbatim} +\catcode`8 = 11 +\newcommand{\cul8r}{Goodbye!} +I said, ``\cul8r''. +\end{verbatim} + \end{quote} + \begin{description} + \item[Pro:] \csx{cul8r} can be used directly + \item[Con:] Likely to break other uses of ``\texttt{8}'' (such as + numbers or dimensions; so + \cmdinvoke{setlength}{\csx{paperwidth}}{8in} tells us: + \begin{quote} +\begin{verbatim} +! Missing number, treated as zero. +<to be read again> + 8 +\end{verbatim} + \end{quote} + \end{description} + As a general rule, changing category codes is something to use + \emph{in extremis}, after detailed examination of options. It is + conceivable that such drastic action could be useful for you, but + most ordinary users are well advised not even to try such a + technique. +\item Define a macro \csx{cul} which must always be followed by + ``\texttt{8r}'': + \begin{quote} +\begin{verbatim} +\def\cul8r{Goodbye!} +I said, ``\cul8r''. +\end{verbatim} + \end{quote} + \begin{description} + \item[Pro:] \csx{cul8r} can be used directly + \item[Con~\#1:] Breaks if \csx{cul} is followed by anything other + than ``\texttt{8r}'', with a confusing diagnostic~--- + \csx{cul99} produces: + \begin{quote} +\begin{wideversion} +\begin{verbatim} +! Use of \cul doesn't match its definition. +<*> \cul9 + 9 +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +! Use of \cul doesn't match its + definition. +<*> \cul9 + 9 +\end{verbatim} +\end{narrowversion} + \end{quote} + (which would confuse someone who hadn't even realised there + \emph{was} a definition of \csx{cul} in the document). + \item[Con~\#2:] Silently redefines existing \csx{cul}, if any; + as a result, the technique cannot be used to define both a + \csx{cul8r} and, say, a \csx{cul123} macro in the same + document. + \end{description} +\end{enumerate} +Technique~3 is in fact commonly used~--- in a limited form~--- within +most \LaTeX{} packages and within \LaTeX{} itself. The convention is to +use ``\texttt{@}'' within the names of internal macros to hide them +from the user and thereby prevent naming conflicts. To this end, +\LaTeX{} automatically treats ``\texttt{@}'' as a letter while +processing classes and packages and as a non-letter while processing +the user's document. The key to this technique is the separation: +internally a non-letter is used for macro names, and the user doesn't +see anything of it, while the status remains ``frozen'' in all the +definitions created within the class or package. See % ! line break +\Qref[question]{\csx{@} and \texttt{@} in macro names}{Q-atsigns} for +more information. + +Note that analogous use of technique~3 in this example would give us +\begin{quote} +\begin{verbatim} +\begingroup + \catcode`8 = 11 + \gdef\cul8r{Goodbye!} + \gdef\later{\cul8r} +\endgroup +I said, ``\later''. +\end{verbatim} +\end{quote} +which works, but rather defeats the object of the exercise. +(\csx{later} has the ``frozen'' catcode for `8', even though the value +has reverted to normal by the time it's used; note, also, the use of +the primitive command \csx{gdef}, since \csx{newcommand} can't make a +macro that's available outside the group.) + +\emph{Recommendation}: Either choose another mechanism (such as +\csx{DefineRemark} above), or choose another name for your macro, one +that contains only ordinary letters. A common approach is to use +roman numerals in place of arabic ones: +\begin{quote} +\begin{verbatim} +\newcommand{\culVIIIr}{Goodbye!} +\end{verbatim} +\end{quote} +which rather spoils the intent of the joke implicit in the example +\csx{cul8r}! +\LastEdit*{2009-06-03} + +\Question[Q-findwidth]{Finding the width of a letter, word, or phrase} + +Put the word in a box, and measure the width of the box. For example, +\begin{quote} +\begin{verbatim} +\newdimen\stringwidth +\setbox0=\hbox{hi} +\stringwidth=\wd0 +\end{verbatim} +\end{quote} +Note that if the quantity in the \csx{hbox} is a phrase, the actual +measurement only approximates the width that the phrase will occupy in +running text, since the inter-word glue can be adjusted in paragraph +mode. + +The same sort of thing is expressed in \LaTeX{} by: +\begin{quote} +\begin{verbatim} +\newlength{\gnat} +\settowidth{\gnat}{\textbf{small}} +\end{verbatim} +\end{quote} +This sets the value of the length command |\gnat| to the width of ``small'' +in bold-face text. + +\Question[Q-patch]{Patching existing commands} + +In the general case (possibly sticking something in the middle of an +existing command) this is difficult. However, the common requirement, +to add some code at the beginning or the end of an existing command, +is conceptually quite easy. Suppose we want to define a version of a +command that does some small extension of its original definition: we +would naturally write: +\begin{quote} +\begin{verbatim} +\renewcommand{\splat}{\mumble\splat} +\end{verbatim} +\end{quote} +However, this would not work: a call to \csx{splat} would execute +\csx{mumble}, and the call the redefined \csx{splat} again; this is an +unterminated recursion, that will quickly exhaust \TeX{}'s memory. + +Fortunately, the \TeX{} primitive \csx{let} command comes to our +rescue; it allows us to take a ``snapshot'' of the current state of a +command, which we can then use in the redefinition of the command. +So: +\begin{quote} +\begin{verbatim} +\let\OldSmooth\smooth +\renewcommand{\smooth}{\mumble\OldSmooth} +\end{verbatim} +\end{quote} +effects the required patch, safely. Adding things at the end of a +command works similarly. If \csx{smooth} takes arguments, one must +pass them on: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\renewcommand{\smooth}[2]{\mumble\OldSmooth{#1}{#2}} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\renewcommand{\smooth}[2]% + {\mumble\OldSmooth{#1}{#2}} +\end{verbatim} +\end{narrowversion} +\end{quote} + +The general case may be achieved in two ways. First, one can use the +\LaTeX{} command \csx{CheckCommand}; this compares an existing command +with the definition you give it, and issues a warning if two don't +match. Use is therefore: +\begin{quote} + |\CheckCommand{\complex}{|\meta{original definition}|}|\\ + |\renewcommand{\complex}{|\meta{new definition}|}| +\end{quote} +This technique is obviously somewhat laborious, but if the original +command comes from a source that's liable to change under the control +of someone else, it does at least warn you that your patch is in +danger of going wrong. + +Otherwise, \LaTeX{} users may use one of the \Package{patchcmd}, +\Package{ted} or \Package{etoolbox} packages. + +The \Package{patchcmd} package addresses a slightly simpler task, by +restricting the set of commands that you may patch; you mayn't patch +any command that has an optional argument, though it does deal with +the case of commands defined with \csx{DeclareRobustCommand}. The +package defines a \csx{patchcommand} command, that takes three +arguments: the command to patch, stuff to stick at the front of its +definition, and stuff to stick on the end of its definition. So, +after +\begin{quote} +\begin{verbatim} +\def\b{b} +\patchcmd\b{a}{c} +\end{verbatim} +\end{quote} +we will have a new version of \csx{b} defined as ``\texttt{abc}''. + +The \Package{ted} package is a `token list editor', and provides a +command \csx{substitute} which will patch the +contents of a macro, putting the result in a token-list, or +(in the form \csx{Substitute*}) using the result to (re)define a +macro. The following example defines a simple macro, and then changes +its definition: +\begin{quote} +\begin{verbatim} +\newcommand{\myfont}% + {\Large\sffamily\selectfont} +\Substitute*[\renewcommand{\myfont}]{\myfont}% + {\Large\sffamily}{\huge\itshape} +\end{verbatim} +\end{quote} +The macro's definition is now: +\begin{quote} +\begin{verbatim} +\huge\itshape\selectfont +\end{verbatim} +\end{quote} + +The package also offers a command \csx{ShowTokens}, which shows the +content of its argument, one token to a line, with details of the +token's category code, etc. This is recommended as a debugging tool. + +The \Package{etoolbox} (which provides user access to \eTeX{}'s +programming facilities) provides a command \csx{patchcmd} which is +very similar to \csx{Substitute}, except that it only replaces a +single instance of the token(s) in its search pattern. Since not all +commands may be patched in this way, \csx{patchcmd} takes extra +arguments for \emph{success} and \emph{failure} cases. The +package also provides commands that prepend (\csx{pretocmd}) or append +(\csx{apptocmd}) to the definition of a command. Not all commands may +be patched in this way; the package provides a command +\csx{ifpatchable} which checks the prerequisites, and checks that the +target command's body does indeed include the patch string you propose +to use. (The command \csx{ifpatchable*} omits the test on the patch +string.) + +Finally, we'll briefly consider a package that is (just about) +usable, but not really recommendable. \Package{Patch} gives you an +ingenious (and difficult to understand) mechanism, and comes as an +old-style \LaTeX{} documented macro file, which can no longer be +processed to \Qref*{produce formatted documentation, etc.\@}{Q-install-doc}. +Fortunately, the file (\File{patch.doc}) may be input directly, and +``documentation'' may found by reading the source of the package. +Roughly speaking, one gives the command a set of instructions +analogous to \ProgName{sed} substitutions, and it regenerates the +command thus amended. Unless you can't do your job any other way, +\Package{patch} is best avoided. +\begin{ctanrefs} +\item[etoolbox.sty]\CTANref{etoolbox} +\item[patch.doc]\CTANref{patch} +\item[patchcommand.sty]\CTANref{patchcmd} +\item[ted.sty]\CTANref{ted} +\end{ctanrefs} + +\Question[Q-compjobnam]{Comparing the ``job name''} + +The token \csx{jobname} amusingly produces a sequence of characters +whose category code is 12 (`other'), regardless of what the characters +actually are. Since one inevitably has to compare a macro with the +contents of another macro (using \csx{ifx}, somewhere) one needs to +create a macro whose expansion looks the same as the expansion of +\csx{jobname}. We find we can do this with \csx{meaning}, if we strip +the ``\csx{show} command'' prefix. + +The full command looks like: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\def\StripPrefix#1>{} +\def\jobis#1{FF\fi + \def\predicate{#1}% + \edef\predicate{\expandafter\StripPrefix\meaning\predicate}% + \edef\job{\jobname}% + \ifx\job\predicate +} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\def\StripPrefix#1>{} +\def\jobis#1{FF\fi + \def\predicate{#1}% + \edef\predicate{\expandafter\StripPrefix + \meaning\predicate}% + \edef\job{\jobname}% + \ifx\job\predicate +} +\end{verbatim} +\end{narrowversion} +\end{quote} +And it's used as: +\begin{quote} +\begin{verbatim} +\if\jobis{mainfile}% + \message{YES}% +\else + \message{NO}% +\fi +\end{verbatim} +\end{quote} +Note that the command \csx{StripPrefix} need not be defined if you're +using \LaTeX{}~--- there's already an % line break! +\Qref*{internal command}{Q-atsigns} \csx{strip@prefix} that you can +use. + +\Question[Q-isitanum]{Is the argument a number?} + +\TeX{}'s own lexical analysis doesn't offer the macro programmer +terribly much support: while category codes will distinguish letters +(or what \TeX{} currently thinks of as letters) from everything else, +there's no support for analysing numbers. + +The simple-minded solution is to compare numeric characters with the +characters of the argument, one by one, by a sequence of direct tests, +and to declare the argument ``not a number'' if any character fails +all comparisons: +\begin{quote} +\begin{verbatim} +\ifx1#1 +\else\ifx2#1 +... +\else\ifx9#1 +\else\isanumfalse +\fi\fi...\fi +\end{verbatim} +\end{quote} +which one would then use in a tail-recursing macro to gobble an +argument. One could do slightly better by assuming (pretty safely) +that the digits' character codes are consecutive: +\begin{quote} +\begin{verbatim} +\ifnum`#1<`0 \isanumfalse +\else\ifnum`#1>`9 \isanumfalse + \fi +\fi +\end{verbatim} +\end{quote} +again used in tail-recursion. However, these forms aren't very +satisfactory: getting the recursion ``right'' is troublesome (it has a +tendency to gobble spaces in the argument), and in any case \TeX{} +itself has mechanisms for reading numbers, and it would be nice to use +them. + +Donald Arseneau's \Package{cite} package offers the following test +for an argument being a strictly positive integer: +\begin{quote} +\begin{verbatim} +\def\IsPositive#1{% + TT\fi + \ifcat_\ifnum0<0#1 _\else A\fi +} +\end{verbatim} +\end{quote} +which can be adapted to a test for a non-negative integer thus: +\begin{quote} +\begin{verbatim} +\def\IsNonNegative{% + \ifcat_\ifnum9<1#1 _\else A\fi +} +\end{verbatim} +\end{quote} +or a test for any integer: +\begin{quote} +\begin{verbatim} +\def\gobbleminus#1{\ifx-#1\else#1\fi} +\def\IsInteger#1{% + TT\fi + \ifcat_\ifnum9<1\gobbleminus#1 _\else A\fi +} +\end{verbatim} +\end{quote} +but this surely stretches the technique further than is reasonable. + +If we don't care about the sign, we can use \TeX{} to remove the +entire number (sign and all) from the input stream, and then look at +what's left: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\def\testnum#1{\afterassignment\testresult + \count255=#1 \end} +\def\testresult#1\end{\ifx\end#1\end} +\def\IsInteger#1{TT\fi \testnum{#1}} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\def\testnum#1{\afterassignment\testresult\count255=#1 \end} +\def\testresult#1\end{\ifx\end#1\end\isanumtrue\else\isanumfalse\fi} +\end{verbatim} +\end{wideversion} +\end{quote} +(which technique is due to David Kastrup); this can provoke errors. +In a later thread on the same topic, Michael Downes offered: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\def\IsInteger#1{% + TT\fi + \begingroup \lccode`\-=`\0 \lccode`+=`\0 + \lccode`\1=`\0 \lccode`\2=`\0 \lccode`\3=`\0 + \lccode`\4=`\0 \lccode`\5=`\0 \lccode`\6=`\0 + \lccode`\7=`\0 \lccode`\8=`\0 \lccode`\9=`\0 + \lowercase{\endgroup + \expandafter\ifx\expandafter\delimiter + \romannumeral0\string#1}\delimiter +} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\def\IsInteger#1{% + TT\fi + \begingroup \lccode`\-=`\0 \lccode`+=`\0 + \lccode`\1=`\0 \lccode`\2=`\0 + \lccode`\3=`\0 \lccode`\4=`\0 + \lccode`\5=`\0 \lccode`\6=`\0 + \lccode`\7=`\0 \lccode`\8=`\0 + \lccode`\9=`\0 + \lowercase{\endgroup + \expandafter\ifx\expandafter\delimiter + \romannumeral0\string#1}\delimiter +} +\end{verbatim} +\end{narrowversion} +\end{quote} +which relies on \csx{romannumeral} producing an empty result if its +argument is zero. Sadly, this technique has the unfortunate property +that it accepts simple expressions such as `\texttt{1+2-3}'; this +could be solved by an initial \csx{gobbleminus}-like construction. + +All the complete functions above are designed to be used in \TeX{} +conditionals written ``naturally''~--- for example: +\begin{quote} +\begin{verbatim} +\if\IsInteger{<subject of test>}% + <deal with integer>% +\else + <deal with non-integer>% +\fi +\end{verbatim} +\end{quote} +The \LaTeX{} \Class{memoir} class has an internal command of its own, +\cmdinvoke*{checkifinteger}{num}, that sets the conditional command +\csx{ifinteger} according to whether the argument was an integer. + +Of course, all this kerfuffle would be (essentially) void if there was +a simple means of ``catching'' \TeX{} errors. Imagining an +error-catching primitive \csx{ifnoerror}, one might write: +\begin{quote} +\begin{verbatim} +\def\IsInteger#1{% + TT% + \ifnoerror + \tempcount=#1\relax +% carries on if no error + \expandafter\iftrue + \else +% here if there was an error + \expandafter\iffalse + \fi +} +\end{verbatim} +\end{quote} +thus using \TeX{}'s own integer-parsing code to do the check. It's a +pity that such a mechanism was never defined (it could be that it's +impossible to program within \TeX{}!). +\begin{ctanrefs} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-hash]{Defining macros within macros} + +The way to think of this is that |##| gets replaced by |#| in just the +same way that |#1| gets replaced by `whatever is the first argument'. + +So if you define a macro and use it as: +\begin{quote} +\begin{verbatim} +\def\a#1{+++#1+++#1+++#1+++} \a{b} +\end{verbatim} +\end{quote} +the macro expansion produces `+++b+++b+++b+++', +which people find normal. However, if we now replace part of the macro: +\begin{quote} +\begin{verbatim} +\def\a#1{+++#1+++\def\x #1{xxx#1}} +\end{verbatim} +\end{quote} +\cmdinvoke{a}{b} will expand to `+++b+++|\def\x b{xxxb}|'. This +defines \csx{x} to be a macro \emph{delimited} by |b|, and taking no +arguments, which people may find strange, even though it is just a +specialisation of the example above. If you want \csx{a} to +define \csx{x} to be a macro with one argument, you need to write: +\begin{quote} +\begin{verbatim} +\def\a#1{+++#1+++\def\x ##1{xxx##1}} +\end{verbatim} +\end{quote} +and \csx{a{b}} will expand to +`+++b+++|\def\x #1{xxx#1}|', because |#1| gets replaced by `b' +and |##| gets replaced by |#|. + +To nest a definition inside a definition inside a definition then +you need |####1|, as at each stage |##| is replaced by +|#|. At the next level you need 8~|#|s each time, and so on. + +\Question[Q-spinmacro]{Spaces in macros} + +It's very easy to write macros that produce space in the typeset +output where it's neither desired nor expected. Spaces introduced by +macros are particularly insidious because they don't amalgamate with +spaces around the macro (unlike consecutive spaces that you +type), so your output can have a single bloated space that proves +to be made up of two or even more spaces that haven't amalgamated. +And of course, your output can also have a space where none was wanted +at all. + +Spaces are produced, inside a macro as elsewhere, by space or tab +characters, or by end-of-line characters. There are two basic rules +to remember when writing a macro: first, the rules for ignoring spaces +when you're typing macros are just the same as the rules that apply +when you're typing ordinary text, and second, rules for ignoring +spaces do \emph{not} apply to spaces produced while a macro is being +obeyed (``expanded''). + +Spaces are ignored in vertical mode (between paragraphs), at the +beginning of a line, and after a command name. Since sequences of +spaces are collapsed into one, it `feels as if' spaces are ignored if +they follow another space. Space can have syntactic meaning after +certain sorts of non-braced arguments (e.g., \emph{count} and +\emph{dimen} variable assignments in \plaintex{}) and after certain +control words (e.g., in \csx{hbox} |to|, so again we have instances +where it `feels as if' spaces are being ignored when they're merely +working quietly for their living. + +Consider the following macro, fairly faithfully adapted from one that +appeared on \Newsgroup{comp.text.tex}: +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +\newcommand{\stline}[1] + { \bigskip \makebox[2cm]{ \textbf{#1} } } +\end{verbatim} +\end{quote} +(the original appeared on a single line: it's wrapped here to fit in +the printed \acro{FAQ}'s narrow columns). + +\noindent +\end{narrowversion} +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\newcommand{\stline}[1]{ \bigskip \makebox[2cm]{ \textbf{#1} } } +\end{verbatim} +\end{quote} +\end{wideversion} +The macro definition contains five spaces: +\begin{itemize} +\item after the opening |{| of the macro body; this space will be + ignored, not because ``because the macro appears at the start of a + line'', but rather because the macro was designed to operate between + paragraphs +\item after \csx{bigskip}; this space will be ignored (while the macro + is being defined) because it follows a command name +\item after the |{| of the mandatory argument of \csx{makebox}; even + though this space will inevitably appear at the start of an output + line, it will \emph{not} be ignored +\item after the |}| closing the argument of \csx{textbf}; this space + will not be ignored, but may be overlooked if the argument is well + within the |2cm| allowed for it +\item after the |}| closing the mandatory argument of \csx{makebox}; + this space will not be ignored +\end{itemize} +The original author of the macro had been concerned that the starts of +his lines with this macro in them were not at the left margin, and +that the text appearing after the macro wasn't always properly +aligned. These problems arose from the space at the start of the +mandatory argument of \csx{makebox} and the space immediately after the +same argument. He had written his macro in that way to emphasise the +meaning of its various parts; unfortunately the meaning was rather +lost in the problems the macro caused. + +The principal technique for suppressing spaces is the use of +\texttt{\textpercent} characters: everything after a +\texttt{\textpercent} is ignored, even the end of line itself (so +that not even the end of line can contribute an unwanted space). The +secondary technique is to ensure that the end of line is preceded by a +command name (since the end of line behaves like a space, it will be +ignored following a command name). Thus the above command would be +written (by an experienced programmer with a similar eye to +emphasising the structure): +\begin{quote} +\begin{verbatim} +\newcommand{\stline}[1]{% + \bigskip + \makebox[2cm]{% + \textbf{#1}\relax + }% +} +\end{verbatim} +\end{quote} +Care has been taken to ensure that every space in the revised +definition is ignored, so none appears in the output. The revised +definition takes the ``belt and braces'' approach, explicitly dealing +with every line ending (although, as noted above, a space introduced +at the end of the first line of the macro would have been ignored in +actual use of the macro. This is the best technique, in fact~--- it's +easier to blindly suppress spaces than to analyse at every point +whether you actually need to. Three techniques were used to suppress +spaces: +\begin{itemize} +\item placing a \texttt{\textpercent} character at the end of a line + (as in the 1st, 3rd and 5th lines), +\item ending a line `naturally' with a control sequence, as in line 2, + and +\item ending a line with an `artificial' control sequence, as in line + 4; the control sequence in this case (\csx{relax}) is a no-op in many + circumstances (as here), but this usage is deprecated~--- a + \texttt{\textpercent} character would have been better. +\end{itemize} +Beware of the (common) temptation to place a space \emph{before} a +\texttt{\textpercent} character: if you do this you might as well omit +the \texttt{\textpercent} altogether. + +In ``real life'', of course, the spaces that appear in macros are far +more cryptic than those in the example above. The most common spaces +arise from unprotected line ends, and this is an error that +occasionally appears even in macros written by the most accomplished +programmers. + +\Question[Q-moren9]{How to break the 9-argument limit} + +If you think about it, you will realise that Knuth's command +definition syntax: +\begin{quote} +\begin{verbatim} +\def\blah#1#2 ... #9{<macro body>} +\end{verbatim} +\end{quote} +is intrinsically limited to just 9 arguments. There's no direct way +round this: how would you express a 10th argument?~--- and ensure that +the syntax didn't gobble some other valid usage? + +If you really must have more than 9 arguments, the way to go is: +\begin{quote} +\begin{verbatim} +\def\blah#1#2 ... #9{% + \def\ArgI{{#1}}% + \def\ArgII{{#2}}% + ... + \def\ArgIX{{#9}}% + \BlahRelay +} +\def\BlahRelay#1#2#3{% + % arguments 1-9 are now in + % \ArgI-\ArgIX + % arguments 10-12 are in + % #1-#3 + <macro body>% +} +\end{verbatim} +\end{quote} +This technique is easily extendible by concert pianists of the \TeX{} +keyboard, but is really hard to recommend. + +\LaTeX{} users have the small convenience of merely giving a number of +arguments in the \csx{newcommand} that defines each part of the +relaying mechanism: Knuth's restriction applies to \csx{newcommand} +just as it does to \csx{def}. However, \LaTeX{} users also have the +way out of such barbarous command syntax: the \Package{keyval} +package. With \Package{keyval}, and a bit of programming, one can +write really quite sophisticated commands, whose invocation might look +like: +\begin{quote} +\begin{verbatim} +\flowerinstance{species=Primula veris, + family=Primulaceae, + location=Coldham's Common, + locationtype=Common grazing land, + date=1995/04/24, + numplants=50, + soiltype=alkaline +} +\end{verbatim} +\end{quote} +The merit of such verbosity is that it is self-explanatory: the typist +doesn't have to remember that argument twelve is |soiltype|, and so +on: the commands may be copied from field notes quickly and +accurately. +\begin{ctanrefs} +\item[keyval.sty]Distributed as part of \CTANref{graphics} +\end{ctanrefs} + +\Question[Q-keyval]{Key-value input for macros and package options} + +When we discussed % !line break +\Qref*{extending the number of arguments to a macro}{Q-moren9}, we +suggested that large numbers of arguments, distinguished only by their +position, aren't very kind to the user, and that a package such as +\Package{keyval} offers a more attractive user interface. We now +consider the packages that the macro programmer might use, to create +such a user interface. + +The simplest key-value processor remains \Package{keyval}; it has a +command \csx{define@key} to declare a key and a \emph{handler} to +process it, and a macro \csx{setkeys} to offer values to the handler +of one or more keys. Thus: +\begin{quote} +\begin{verbatim} +\define@key{my}{foo}{Foo is #1\par} +\define@key{my}{bar}[99]{Bar is #1\par} +... +\setkeys{my}{foo=3,bar} +\end{verbatim} +\end{quote} +will produce output saying: +\begin{quote} + Foo is 3\par{} + Bar is 99 +\end{quote} +This has defined two keys `\texttt{foo}' and `\texttt{bar}' in family +`\texttt{my}', and then executed them, the first with argument +`\texttt{3}' and the second with no argument, so that the default +value of `\texttt{99}' is picked up. In effect, the two calls to +\csx{define@key} are simply defining commands, as (for example): +\begin{quote} +\begin{verbatim} +\newcommand{\KV@my@foo}[1]{Foo is #1} +\end{verbatim} +\end{quote} +(the definition of \csx{KV@my@bar} is similar, but trickier). The +command \csx{setkeys} knows how to find those commands when it needs to +process each key~--- it is easy to regurgitate the structure of the +command name, with family name (`\texttt{my}', here) after the first +`\texttt{@}', and the key name after the second `\texttt{@}'. (The +`\texttt{KV}' part is fixed, in \Package{keyval}.) + +These simple commands are enough, in fact, to process the botanical +example offered as replacement for multi-argument commands in % ! line break +\Qref[question]{the question mentioned above}{Q-moren9}, or the +optional arguments of the \csx{includegraphics} command of the +\Package{graphicx} package. (The last is, in fact, what +\Package{keyval} was designed to do.) + +However, we need more if we're to to have package options in +`key-value' form. Packages like \Package{hyperref} have enormously +complicated package options which need key-value processing at +\csx{ProcessOptions} time: \Package{keyval} can't do that on its own. + +Heiko Oberdiek's \Package{kvoptions} package comes to our help: it +enables the programmer to declare class or package options that +operate as key and value pairs. The package defines commands +\csx{DeclareBoolOption} for options whose value should be either +\emph{true} or \emph{false}, and \csx{DeclareStringOption} for all +other options that have a value. Keys are declared using +\Package{keyval} and may remain available for use within the document, +or may be `cancelled' to avoid confusion. If you have loaded +\Package{kvoptions}, the \LaTeX{} kernel's \csx{DeclareOption} becomes +\csx{DeclareVoidOption} (it's an option with no value), and +\csx{DeclareOption*} becomes \csx{DeclareDefaultOption}. + +Heiko also provides \Package{kvsetkeys} which is a more robust version +of \Package{setkeys}, with some of the rough edges made smoother. + +Hendri Adriaens' \Package{xkeyval} offers more flexibility than +the original \Package{keyval} and is more robust than the original, +too. Like \Package{kvoptions}, the package also has mechanisms to +allow class and package options in key-value form (macros +\csx{DeclareOptionX}, \csx{ExecuteOptionsX} and \csx{ProcessOptionsX}. +\Package{Pstricks} bundle packages use a \Package{xkeyval} derivative +called \Package{pst-xkey} for their own key-value manipulation. +% xkvview? (i think we can ignore xkvltxp for these purposes) + +The (widely-respected) \Package{pgf} graphics package has its own +key-value package called \Package{pgfkeys}. The documentation of the +package (part of the huge \Package{pgf} manual, in part 5, +``utilities'') contains a useful comparison with other key-value +systems; some notable differences are: +\begin{itemize} +\item key organisation: \Package{pgfkeys} uses a tree structure, while + \Package{keyval} and \Package{xkeyval} both associate keys with a family; +\item \Package{pgfkeys} supports multi-argument key code; and +\item \Package{pgfkeys} can support call-backs when an unknown key + appears (these things are called \emph{handlers}. +\end{itemize} +Keys are organized in a tree that is reminiscent of the Unix fille +tree. A typical key might be, \File{/tikz/coordinate system/x} or +just \File{/x}. When you specify keys you can provide the complete +path of the key, but you usually just provide the name of the key +(corresponding to the file name without any path) and the path is +added automatically. So a \csx{pgfkeys} command might be: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\pgfkeys{/my key=hello,/your keys/main key=something\strange, + key name without path=something else} +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +\pgfkeys{/my key=hello, + /your keys/main key=something\strange, + key name without path=something else} +\end{verbatim} +\end{quote} +\end{narrowversion} +and for each key mentioned, the associated code will be executed. +\dots{} and that code is also set up using \csx{pgfkeys}: +\begin{quote} +\begin{verbatim} +\pgfkeys{/my key/.code=The value is '#1'.} +\end{verbatim} +\end{quote} +after which +\begin{quote} +\begin{verbatim} +\pgfkeys{/my key=hi!} +\end{verbatim} +\end{quote} +will produce just +\begin{quote} + The value is 'hi!'. +\end{quote} +The manual goes on, showing how to define a key with two arguments, +how to provide default value for a key, and how to define aliases for +particular key sequences (which are called ``styles''). All in all, +it seems a well thought-out system, offering a lot of flexibility that +isn't available with the other keys packages. However, there seems to +be no mechanism for using \Package{pgfkeys} keys as part of the +options of another package, in the way that \Package{kvoptions} does. + +Another key-value system that's part of larger set of macros is +\Package{scrbase}, which uses the facilities of \Package{keyval} to +build a larger set of facilities, originally for use within the +\Class{KOMA-script} bundle. For English-speaking authors, there are +difficulties from the German-only documentation; however, from a +partial translation available to the author of this answer, a summary +is possible. The package may build on the facilities either of +\Package{kyeval} or of \Package{xkeyval}, and builds its functionality +on the structure of the `key family'. The user may define family +`members' and keys are defined relative to the members. (For example, +the package \Package{scrbase} is part of the \Class{KOMA-script} +bundle; so its keys are all members of the \Package{scrbase.sty} +family within the \Package{KOMA} family. The function +\csx{FamilyProcessOptions} allows the programmer to decode the options +of the package in terms of the package's key family. Note that there +is no special provision made for ``traditional'' package options, as +in the \Package{kvoptions} package. + +This brief summary was guided by input from two sources: a draft article +for \textsl{TUGboat} by Joseph Wright, and the partial translation of the +documentation of package \Package{scrbase} prepared by Philipp +Stephani. At Joseph's suggestion, discussion of his \Package{keys3} +package, which is designed for use with the experimental \LaTeX{}3, +has been omitted. +\begin{ctanrefs} +\item[keyval.sty]Distributed as part of \CTANref{graphics} +\item[kvoptions.sty]Distributed as part of \CTANref{oberdiek} +\item[kvsetkeys.sty]Distributed as part of \CTANref{oberdiek} +\item[pgfkeys.sty]Distributed as part of \CTANref{pgf} +\item[scrbase.sty]Distributed as part of \CTANref{koma-script} +\item[xkeyval.sty]\CTANref{xkeyval} +\end{ctanrefs} + +\Question[Q-activechars]{Defining characters as macros} + +Single characters can act as macros (defined commands), and both +\plaintex{} and \LaTeX{} define the character +``\texttt{\textasciitilde}'' as a ``non-breakable space''. A +character is made definable, or ``active'', by setting its +\emph{category code} (catcode) to be \csx{active} (13): +|\catcode`_=\active|. + +Any character could, in principle, be activated this way and defined +as a macro (\csx{def}\texttt{\_\{}\csx{\_}\texttt{\}}~--- the simple answer to +% beware line break +\Qref[question]{using underscores}{Q-underscore}), but you must be +wary: whereas people expect an active tilde, other active characters +may be unexpected and interact badly with other macros. Furthermore, +by defining an active character, you preclude the character's use for +other purposes, and there are few characters ``free'' to be subverted +in this way. + +To define the character ``|z|'' as a command, one would say something +like: +\begin{quote} +\begin{verbatim} +\catcode`\z=\active +\def z{Yawn, I'm tired}% +\end{verbatim} +\end{quote} +and each subsequent ``|z|'' in the text would become a yawn. This would be +an astoundingly bad idea for most documents, but might have special +applications. (Note that, in ``|\def z|'', ``|z|'' is no longer interpreted as +a letter; the space is therefore not necessary~--- ``|\defz|'' would do; we +choose to retain the space, for what little clarity we can manage.) +Some \LaTeX{} packages facilitate such definitions. For example, the +\Package{shortvrb} package with its \csx{MakeShortVerb} command. + +\TeX{} uses category codes to interpret characters as they are read +from the input. +% beware line break +\emph{Changing a catcode value will not affect characters that have already been read}. +Therefore, it is best if characters have fixed category codes for the +duration of a document. If catcodes are changed for particular +purposes (the \csx{verb} command does this), then the altered +characters will not be interpreted properly when they appear in the +argument to another command (as, for example, in +% beware line-break +\htmlonly{``}\Qref[question]{\csx{verb} in command arguments}{Q-verbwithin}\htmlonly{''}). +An exemplary case is the \Package{doc} package, which processes .dtx +files using the \Package{shortvrb} package to define +\texttt{\textbar\dots{}\textbar} as a shorthand for +\csx{verb}\texttt{\textbar\dots{}\textbar}. But \texttt{\textbar} is +also used in the preambles of tabular environments, so that tables in +\extension{dtx} files can only have vertical line separation between +columns by employing special measures of some sort. + +Another consequence is that catcode assignments made +in macros often don't work as expected % beware linebreak +(\htmlonly{see ``}\Qref{Active characters in command arguments}{Q-actinarg}\htmlonly{''}). +For example, the definition +\begin{quote} +\begin{verbatim} +\def\mistake{% +\catcode`_=\active +\def_{\textunderscore\-}% +} +\end{verbatim} +\end{quote} +does not work because it attempts to define an ordinary |_| character: +When the macro is used, the category change does not apply to the +underscore character already in the macro definition. Instead, one may +use: +\begin{quote} +\begin{verbatim} +\begingroup +\catcode`_=\active +\gdef\works{% note the global \gdef + \catcode`_=\active + \def_{\textunderscore\-}% +} +\endgroup +\end{verbatim} +\end{quote} +The alternative (``tricksy'') way of creating such an isolated +definition depends on the curious properties of \csx{lowercase}, which +changes characters without altering their catcodes. Since there is +always \emph{one} active character (``\texttt{\textasciitilde}''), we +can fool \csx{lowercase} into patching up a definition without ever +explicitly changing a catcode: +\begin{quote} +\begin{verbatim} +\begingroup + \lccode`\~=`\_ + \lowercase{\endgroup + \def~{\textunderscore\-}% + }% +\end{verbatim} +\end{quote} +The two definitions have the same overall effect (the character is +defined as a command, but the character does not remain active), +except that the first defines a \csx{global} command. + +For active characters to be used only in maths mode, it is much better +to leave the character having its ordinary catcode, but assign it a +special active \emph{maths code}, as with +\begin{quote} +\begin{verbatim} +\begingroup + \lccode`~=`x + \lowercase{\endgroup + \def~{\times}% + }% +\mathcode`x="8000 +\end{verbatim} +\end{quote} +The special character does not need to be redefined whenever it is +made active~--- the definition of the command persists even if the +character's catcode reverts to its original value; the definition +becomes accessible again if the character once again becomes active. +\begin{ctanrefs} +\item[doc.sty]Distributed as part of the source of \LaTeX{}, \CTANref{latex} +\item[shortvrb.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + + +\Question[Q-actinarg]{Active characters in command arguments} + +Occasionally, it's nice to make one or two characters active in the +argument of a command, to make it easier for authors to code the +arguments. + +Active characters \emph{can} be used safely in such situations; but +care is needed. + +An example arose while this answer was being considered: an aspirant +macro writer posted to \Newsgroup{comp.text.tex} asking for help to +make |#| and |b| produce musical sharp and flat signs, respectively, +in a macro for specifying chords. + +The first problem is that both |#| and |b| have rather important uses +elsewhere in \TeX{} (to say the least!), so that the characters can +only be made active while the command is executing. + +Using the techniques discussed in % beware line break, next line +\htmlonly{``}\Qref[question]{characters as commands}{Q-activechars}\htmlonly{''}, +we can define: +\begin{quote} +\begin{verbatim} +\begingroup + \catcode`\#=\active + \gdef#{$\sharp$} +\endgroup +\end{verbatim} +\end{quote} +and: +\begin{quote} +\begin{verbatim} +\begingroup + \lccode`\~=`\b + \lowercase{\endgroup + \def~{$\flat$}% + } +\end{verbatim} +\end{quote} +The second problem is one of timing: the command has to make each +character active \emph{before} its arguments are read: this means that +the command can't actually ``have'' arguments itself, but must be +split in two. So we write: +\begin{quote} +\begin{verbatim} +\def\chord{% + \begingroup + \catcode`\#=\active + \catcode`\b=\active + \Xchord +} +\def\Xchord#1{% + \chordfont#1% + \endgroup +} +\end{verbatim} +\end{quote} +and we can use the command as \cmdinvoke{chord}{F\#} or +\cmdinvoke{chord}{Bb minor}. + +Two features of the coding are important: +\begin{itemize} +\item \csx{begingroup} in \csx{chord} opens a group that is closed by + \csx{endgroup} in \csx{Xchord}; this group limits the change of + category codes, which is the \emph{raison d'\^etre} of the whole + exercise. +\item Although |#| is active while \csx{Xchord} is executed, it's + \emph{not} active when it's being defined, so that the use of |#1| + doesn't require any special attention. +\end{itemize} + +Note that the technique used in such macros as \csx{chord}, here, is +analogous to that used in such commands as \csx{verb}; and, in just the +same way as \csx{verb} (see +% beware breaking long line +\htmlonly{``}\Qref[question]{\csx{verb} doesn't work in arguments}{Q-verbwithin}\htmlonly{''}), +\csx{chord} won't work inside the argument of another command (the +error messages, if they appear at all, will probably be rather odd). + + +\Question[Q-csname]{Defining a macro from an argument} + +It's common to want a command to create another command: often one +wants the new command's name to derive from an argument. \LaTeX{} +does this all the time: for example, \csx{newenvironment} creates +start- and end-environment commands whose names are derived from the +name of the environment command. + +The (seemingly) obvious approach: +\begin{quote} +\begin{verbatim} +\def\relay#1#2{\def\#1{#2}} +\end{verbatim} +\end{quote} +doesn't work (the \TeX{} engine interprets it +as a rather strange redefinition of |\#|). The trick is to use +\csx{csname}, which is a \TeX{} primitive for generating command names +from random text, together with \csx{expandafter}. The definition +above should read: +\begin{quote} +\begin{verbatim} +\def\relay#1#2{% + \expandafter\def\csname #1\endcsname{#2}% +} +\end{verbatim} +\end{quote} +With this definition, \cmdinvoke{relay}{blah}{bleah} is equivalent to +\csx{def}\cmdinvoke{blah}{bleah}. + +Note that the definition of \csx{relay} omits the braces round the +`command name' in the \csx{newcommand} it executes. This is +because they're not necessary (in fact they seldom are), and in this +circumstance they make the macro code slightly more tedious. + +The name created need not (of course) be \emph{just} the argument: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\def\newrace#1#2#3{\expandafter\def + \csname start#1\endcsname{% + #2% + }% + \expandafter\def + \csname finish#1\endcsname{% + #3% + }% +} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\def\newrace#1#2#3{% + \expandafter\def\csname start#1\endcsname{% + #2% + }% + \expandafter\def\csname finish#1\endcsname{% + #3% + }% +} +\end{verbatim} +\end{wideversion} +\end{quote} +With commands +\begin{quote} +\begin{verbatim} +\def\start#1{\csname start#1\endcsname} +\def\finish#1{\csname finish#1\endcsname} +\end{verbatim} +\end{quote} +these `races' could behave a bit like \LaTeX{} environments. + +\Question[Q-cvtlatex]{Transcribing \LaTeX{} command definitions} + +At several places in this \acro{FAQ}, questions are answered in terms +of how to program a \LaTeX{} macro. Sometimes, these macros might +also help users of \plaintex{} or other packages; this answer +attempts to provide a rough-and-ready guide to transcribing such macro +definitions for use in other packages. + +The reason \LaTeX{} has commands that replace \csx{def}, is that +there's a general philosophy within \LaTeX{} that the user should be +protected from himself: the user has different commands according to +whether the command to be defined exists (\csx{renewcommand}) or not +(\csx{newcommand}), and if its status proves not as the user expected, +an error is reported. A third definition command, +\csx{providecommand}, only defines if the target is not already +defined; \LaTeX{} has no direct equivalent of \csx{def}, which ignores +the present state of the command. The final command of this sort is +\csx{DeclareRobustCommand}, which creates a command which is ``robust'' +(i.e., will not expand if subjected to \LaTeX{} ``protected +expansion''); from the \plaintex{} user's point of view, +\csx{DeclareRobustCommand} should be treated as a non-checking version +of \csx{newcommand}. + +\LaTeX{} commands are, by default, defined \csx{long}; an optional \texttt{*} +between the \csx{newcommand} and its (other) arguments specifies that +the command is \emph{not} to be defined \csx{long}. The \texttt{*} is +detected by a command \csx{@ifstar} which uses \csx{futurelet} to switch +between two branches, and gobbles the \texttt{*}: \LaTeX{} users are +encouraged to think of the \texttt{*} as part of the command name. + +\LaTeX{}'s checks for unknown command are done by \csx{ifx} comparison +of a \csx{csname} construction with \csx{relax}; since the command name +argument is the desired control sequence name, this proves a little +long-winded. Since \texttt{\#1} is the requisite argument, we have: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\expandafter\ifx + \csname + \expandafter\@gobble\string#1% + \endcsname + \relax + ... +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\expandafter\ifx + \csname\expandafter\@gobble\string#1\endcsname + \relax + ... +\end{verbatim} +\end{wideversion} +\end{quote} +(\csx{@gobble} simply throws away its argument). + +The arguments of a \LaTeX{} command are specified by two optional +arguments to the defining command: a count of arguments (0--9: if the +count is 0, the optional count argument may be omitted), and a default +value for the first argument, if the defined command's first argument +is to be optional. So: +\begin{quote} +\begin{verbatim} +\newcommand\foo{...} +\newcommand\foo[0]{...} +\newcommand\foo[1]{...#1...} +\newcommand\foo[2][boo]{...#1...#2...} +\end{verbatim} +\end{quote} +In the last case, \csx{foo} may be called as \cmdinvoke{foo}{goodbye}, +which is equivalent to \cmdinvoke{foo}[boo]{goodbye} (employing the +default value given for the first argument), or as +\cmdinvoke{foo}[hello]{goodbye} (with an explicit first argument). + +Coding of commands with optional arguments is exemplified by the +coding of the last \csx{foo} above: +\begin{quote} +\begin{verbatim} +\def\foo{\futurelet\next\@r@foo} +\def\@r@foo{\ifx\next[% + \let\next\@x@foo + \else + \def\next{\@x@foo[boo]}% + \fi + \next +} +\def\@x@foo[#1]#2{...#1...#2...} +\end{verbatim} +\end{quote} + +\Question[Q-empty]{Detecting that something is empty} + +Suppose you need to know that the argument of your command is empty: +that is, to distinguish between \cmdinvoke{cmd}{\relax} % \relax doesn't print +and \cmdinvoke{cmd}{blah}. This is pretty simple: +\begin{quote} +\begin{verbatim} +\def\cmd#1{% + \def\tempa{}% + \def\tempb{#1}% + \ifx\tempa\tempb + <empty case> + \else + <non-empty case> + \fi +} +\end{verbatim} +\end{quote} +The case where you want to ignore an argument that consists of nothing +but spaces, rather than something completely empty, is more tricky. +It's solved in the code fragment \Package{ifmtarg}, which defines +commands \csx{@ifmtarg} and \csx{@ifnotmtarg}, which examine their +first argument, and select (in opposite directions) their second or +third argument. The package's code also appears in the \LaTeX{} +\Class{memoir} class. + +\Package{Ifmtarg} makes challenging reading; there's also a discussion of the +issue in number two of the ``around the bend'' articles by the late +lamented Mike Downes. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Around the bend series]\CTANref{aro-bend} +\item[ifmtarg.sty]\CTANref{ifmtarg} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-ifpdf]{Am I using \PDFTeX{}?} + +It's often useful to know whether your macros are operating within +\PDFTeX{} or within (``normal'') \TeX{}; getting the right answer is +surprisingly tricky. + +Suppose you need to test whether your output will be \acro{PDF} or +\acro{DVI}. The natural thing is to check whether you have access to +some \PDFTeX{}-only primitive; a good one to try (not least because it +was present in the very first releases of \PDFTeX{}) is +\csx{pdfoutput}. So you try +\begin{quote} +\begin{verbatim} +\ifx\pdfoutput\undefined + ... % not running PDFTeX +\else + ... % running PDFTeX +\fi +\end{verbatim} +\end{quote} +Except that neither branch of this conditional is rock-solid. The +first branch can be misleading, since the ``awkward'' user could have +written: +\begin{quote} +\begin{verbatim} +\let\pdfoutput\undefined +\end{verbatim} +\end{quote} +so that your test will falsely choose the first alternative. While +this is a theoretical problem, it is unlikely to be a major one. + +More important is the user who loads a package that uses +\LaTeX{}-style testing for the command name's existence (for example, +the \LaTeX{} \Package{graphics} package, which is useful even to the +\plaintex{} user). Such a package may have gone ahead of you, so the +test may need to be elaborated: +\begin{quote} +\begin{verbatim} +\ifx\pdfoutput\undefined + ... % not running PDFTeX +\else + \ifx\pdfoutput\relax + ... % not running PDFTeX + \else + ... % running PDFTeX + \fi +\fi +\end{verbatim} +\end{quote} +If you only want to know whether some \PDFTeX{} extension (such as +marginal kerning) is present, you can stop at this point: you know as +much as you need. + +However, if you need to know whether you're creating \acro{PDF} +output, you also need to know about the value of \csx{pdfoutput}: +\begin{quote} +\begin{verbatim} +\ifx\pdfoutput\undefined + ... % not running PDFTeX +\else + \ifx\pdfoutput\relax + ... % not running PDFTeX + \else + % running PDFTeX, with... + \ifnum\pdfoutput>0 + ... % PDF output + \else + ... % DVI output + \fi + \fi +\fi +\end{verbatim} +\end{quote} +The above is, in essence, what Heiko Oberdiek's \Package{ifpdf} +package does; the reasoning is the \acro{FAQ}'s interpretation of +Heiko's explanation. + +As an aside: there are now analogous packages \Package{ifxetex} and +\Package{ifluatex}, for the two up-and-coming \TeX{}-like engines (see +the ``\TeX{} project'' answers covering % ! line break +\Qref[\xetex{}~--- question]{\xetex{}}{Q-xetex}, and +\Qref[\LuaTeX{}~--- question]{\LuaTeX{}}{Q-luatex}). +\begin{ctanrefs} +\item[ifpdf.sty]Distributed with Heiko Oberdiek's packages \CTANref{oberdiek} +\item[ifluatex.sty]Distributed with Heiko Oberdiek's packages + \CTANref{oberdiek} +\item[ifxetex.sty]\CTANref{ifxetex} +\end{ctanrefs} + +\Question[Q-subverttoks]{Subverting a token register} + +A common requirement is to ``subvert'' a token register that other +macros may use. The requirement arises when you want to add something +to a system token register (\csx{output} or \csx{every*}), but know +that other macros use the token register, too. (A common requirement +is to work on \csx{everypar}, but \LaTeX{} changes \csx{everypar} at +every touch and turn.) + +The following technique, due to David Kastrup, does what you need, and +allows an independent package to play the exact same game: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\let\mypkg@@everypar\everypar +\newtoks\mypkg@everypar +\mypkg@everypar\expandafter{\the\everypar} +\mypkg@@everypar{\mypkgs@ownstuff\the\mypkg@everypar} +\def\mypkgs@ownstuff{% + <stuff to do at the start of the token register>% +} +\let\everypar\mypkg@everypar +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\let\mypkg@@everypar\everypar +\newtoks\mypkg@everypar +\mypkg@everypar\expandafter{\the\everypar} +\mypkg@@everypar{\mypkgs@ownstuff + \the\mypkg@everypar} +\def\mypkgs@ownstuff{% + <stuff to do at the start of + the token register>% +} +\let\everypar\mypkg@everypar +\end{verbatim} +\end{narrowversion} +\end{quote} +As you can see, the package (\Package{mypkg}) +\begin{itemize} +\item creates an alias for the existing ``system'' \csx{everypar} + (which is frozen into any surrounding environment, which will carry + on using the original); +\item creates a token register to subvert \csx{everypar} and + initialises it with the current contents of \csx{everypar}; +\item sets the ``old'' \csx{everypar} to execute its own extra code, + as well as the contents of its own token register; +\item defines the macro for the extra code; and +\item points the token \csx{everypar} at the new token register. +\end{itemize} +and away we go. + +The form \csx{mypkg@...} is (sort of) blessed for \LaTeX{} package +internal names, which is why this example uses macros of that form. + +\Question[Q-isdef]{Is this command defined?} + +Macro sets from the earliest days of \TeX{} programming may be +observed to test whether commands exist by using +\begin{quote} +\csx{ifx} \csx{}\texttt{\emph{command}} \csx{undefined} \meta{stuff} \dots{} +\end{quote} +(which of course actually tests that the command \emph{doesn't} +exist). \LaTeX{} programmers can make use of the internal command +\begin{quote} + \cmdinvoke*{@ifundefined}{cmd name}{action1}{action2} +\end{quote} +which executes \texttt{action1} if the command is undefined, and +\texttt{action2} if it is defined +(\emph{cmd name} is the command name only, omitting the `|\|' character). + +The \csx{@ifundefined} command is based on the sequence +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\expandafter + \ifx\csname cmd name\endcsname\relax +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\expandafter \ifx \csname cmd name\endcsname \relax +\end{verbatim} +\end{wideversion} +\end{quote} +which relies on the way \csx{csname} works: if the command doesn't +exist, it simply creates it as an alias for \csx{relax}. + +So: what is wrong with these techniques? + +Using \csx{undefined} blithely assumes that the command is indeed not +defined. This isn't entirely safe; one could make the name more +improbable, but that may simply make it more difficult to spot a +problem when things go wrong. \LaTeX{} programmers who use the +technique will typically employ \csx{@undefined}, adding a single +level of obscurity. + +The \csx{@ifundefined} mechanism has the unfortunate property of +polluting the name space: each test that turns out undefined adds a +name to the set \TeX{} is holding, and often all those ``\csx{relax}'' +names serve no purpose whatever. Even so (sadly) there are places in +the code of \LaTeX{} where the existence of the \csx{relax} is relied +upon, after the test, so we can't get away from \csx{@ifundefined} +altogether. + +David Kastrup offers the (rather tricky) +\begin{quote} +\begin{wideversion} +\begin{verbatim} +{\expandafter}\expandafter\ifx \csname cmd name\endcsname\relax ... +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +{\expandafter}\expandafter + \ifx \csname cmd name\endcsname \relax ... +\end{verbatim} +\end{narrowversion} +\end{quote} +which ``creates'' the \csx{relax}-command inside the group of the first +\csx{expandafter}, therefore forgets it again once the test is done. +The test is about as good as you can do with macros. + +The \Qref*{\eTeX{} system}{Q-etex} system comes to our help here: it +defines two new primitives: +\begin{itemize} +\item \csx{ifdefined}, which tests whether a thing is defined (the + negative of comparing with \csx{undefined}, as it were), and +\item \csx{ifcsname} \texttt{cmd name}\csx{endcsname}, which does the + negative of \csx{@ifundefined} without the \csx{relax}-command + side-effect. +\end{itemize} +So, in an \eTeX{}-based system, the following two conditional clauses do +the same thing: +\begin{quote} +\begin{verbatim} +\ifdefined\foo + \message{\string\foo\space is defined}% +\else + \message{no command \string\foo}% +\fi +% +\ifcsname foo\endcsname + \message{\string\foo\space is defined}% +\else + \message{no command \string\foo}% +\fi +\end{verbatim} +\end{quote} +However, after using the \LaTeX{} +\cmdinvoke{@ifundefined}{foo}\dots{}, the conditionals will detect the +command as ``existing'' (since it has been \csx{let} to \csx{relax}); +so it is important not to mix mechanisms for detecting the state of a +command. + +Since most distributions nowadays use \eTeX{} as their base executable +for most packages, these two primitives may be expected appear widely +in new macro packages. + +\subsection{\LaTeX{} macro tools and techniques} + +\Question[Q-plninltx*]{Using Plain or primitive commands in \LaTeX{}} + +It's well-known that \LaTeX{} commands tend to be more complex, and to +run more slowly than, any \plaintex{} (or primitive) command that they +replace. There is therefore great temptation not to use \LaTeX{} +commands when macro programming. Nevertheless, the general rule is +that you should use \LaTeX{} commands, if there are seeming +equivalents. The exception is when you are sure you know the +differences between the two commands and you know that you need the +\plaintex{} version. So, for example, use \csx{mbox} in place of \csx{hbox} +unless you know that the extras that \LaTeX{} provides in \csx{mbox} +would cause trouble in your application. Similarly, use +\csx{newcommand} (or one of its relatives) unless you need one of the +constructs that cannot be achieved without the use of \csx{def} (or friends). + +As a general rule, any \LaTeX{} text command will start a new +paragraph if necessary; this isn't the case with \plaintex{} +commands, a fact which has a potential to confuse. + +The commands \csx{smallskip}, \csx{medskip} and \csx{bigskip} exist both +in \plaintex{} and \LaTeX{}, but behave slightly differently: in +\plaintex{} they terminate the current paragraph, but in \LaTeX{} they +don't. The command \csx{line} is part of picture mode in \LaTeX{}, +whereas it's defined as ``\csx{hbox}\texttt{ to }\csx{hsize}'' in +\plaintex{}. (There's no equivalent for users of the \plaintex{} command in +\LaTeX{}: an equivalent appears as the internal command \csx{@@line}). + +Maths setting shows a case where the \LaTeX{} version \emph{is} +essentially equivalent to the \TeX{} primitive commands: the \LaTeX{} +\csx{(}\texttt{\ ...\ }\csx{)} does essentially no different to the +\TeX{} \texttt{\$\ ...\ \$} +(except for checking that you're not attempting to open a maths +environment when you're already in one, or vice versa). % ! line break +However, \csx{[}\texttt{\ ...\ }\csx{]} \emph{isn't} the same as +\texttt{\$\$\ ...\ \$\$}: the \TeX{} version, used +in \LaTeX{}, can miss the effect of the class option \pkgoption{fleqn}. + +Font handling is, of course, wildly different in \plaintex{} and +\LaTeX{}. \plaintex{}'s font loading command +(\csx{font}\csx{foo=}\meta{fontname}) and its \LaTeX{} equivalent +(\csx{newfont}) should be avoided wherever possible. They are only +safe in the most trivial contexts, and are potential sources of great +confusion in many circumstances. Further discussion of this issue +may be found in ``\Qref*{What's wrong with \csx{newfont}?}{Q-newfont*}''. +%% +%% Consider \csx{vskip} (or \plaintex{} users of it like \csx{medskip}) +%% \emph{vs}.\nothtml{\@} \csx{vspace} or \csx{vspace*}, but most +%% especially \csx{addvspace}. +%% \begin{ctanrefs} +%% \item[fntguide.pdf]\CTANref{fntguide.pdf} +%% \item[fntguide.tex]Distributed with \CTANref{latex} +%% \end{ctanrefs} + +\Question[Q-atsigns]{\csx{@} and \texttt{@} in macro names} + +Macro names containing \texttt{@} are \emph{internal} to \LaTeX{}, and +without special treatment just don't work in ordinary use. A nice +example of the problems caused is discussed in % ! beware line break +\Qref*{\csx{@} in vertical mode}{Q-atvert}''. + +The problems users see are caused by copying bits of a class +(\extension{cls} file) or +package (\extension{sty} file) into a document, or by including a class or +package file into a \LaTeX{} document by some means other than +\csx{documentclass} or \csx{usepackage}. \LaTeX{} defines internal +commands whose names contain the character \texttt{@} to +avoid clashes between its internal names and names that we would +normally use in our documents. In order that these commands may work +at all, \csx{documentclass} and \csx{usepackage} play around with the +meaning of \texttt{@}. + +If you've included a file some other way (for example, using +\csx{input}), you can probably solve the problem by using the correct +command. + +If you're using a fragment of a package or class, you may well feel +confused: books such as the first edition of the % ! line break +\Qref*{The \LaTeX{} Companion}{Q-books} +are full of fragments of packages as examples for you to employ. +The second edition of the \emph{Companion} makes clearer how you +should use these fragments, and in addition, the code of +all the examples is now available on \acro{CTAN}. +To see the technique in practice, look at the example below, from file +\File{2-2-7.ltx} in the \emph{Companion} examples directory: +\begin{quote} +\begin{verbatim} +\makeatletter +\renewcommand\subsection{\@startsection + {subsection}{2}{0mm}%name, level, indent + {-\baselineskip}% beforeskip + {0.5\baselineskip}% afterskip + {\normalfont\normalsize\itshape}}% style +\makeatother +\end{verbatim} +\end{quote} +(That example appears on page 29 of \emph{The \LaTeX{} Companion}, +second edition.) + +The alternative is to treat all these fragments as a package proper, +bundling them up into a \extension{sty} file and including them with +\csx{usepackage}; this way you hide your \LaTeX{} internal code somewhere +that \LaTeX{} internal code is expected, which often looks `tidier'. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}Examples from the Companion]\CTANref{tlc2} +\end{ctanrefs} + +\Question[Q-protect]{What's the reason for `protection'?} + +Sometimes \LaTeX{} saves data it will reread later. These data are +often the argument of some command; they are the so-called moving +arguments. (`Moving' because data are moved around.) Candidates +are all arguments that may go into table of contents, list of figures, +\emph{etc}.; namely, data that are written to an auxiliary file and +read in later. Other places are those data that might appear in head- +or footlines. Section headings and figure captions are the most +prominent examples; there's a complete list in Lamport's book +(see \Qref[question]{\TeX{}-related books}{Q-books}). + +What's going on really, behind the scenes? The commands in moving +arguments are normally expanded to their internal structure during the +process of saving. Sometimes this expansion results in invalid \TeX{} +code, which shows either during expansion or when the code is +processed again. Protecting a command, using +``\csx{protect}\csx{cmd}'' tells \LaTeX{} to save \csx{cmd} as +\csx{cmd}, without expanding it at all. + +So, what is a `fragile command'?~--- it's a command that expands into +illegal \TeX{} code during the save process. + +What is a `robust command'?~--- it's a command that expands into legal +\TeX{} code during the save process. + +Lamport's book says in its description of every LaTeX command whether +it is `robust' or `fragile'; it also says that every command with an +optional argument is fragile. The list isn't reliable, and neither +is the assertion about optional arguments; the statements may have +been true in early versions of \LaTeXe{} but are not any longer +necessarily so: +\begin{itemize} +\item Some fragile commands, such as \csx{cite}, have been made robust + in later revisions of \LaTeX{}. +\item Some commands, such as \csx{end} and \csx{nocite}, are fragile + even though they have no optional arguments. +\item The ``user's way'' of creating a command with an optional + argument (using \csx{newcommand} or \csx{newcommand*}) now always + creates a robust command (though macros without optional arguments + may still be fragile if they do things that are themselves fragile). +\item There is no reason that a package author should not also make + robust commands with optional arguments as part of the package. +\item Some robust commands are redefined by certain packages to be + fragile (the \csx{cite} command commonly suffers this treatment). +\end{itemize} +Further, simply ``hiding'' a fragile command in another command, has +no effect on fragility. So, if \csx{fred} is fragile, and you write: +\begin{quote} +\begin{verbatim} +\newcommand{\jim}{\fred} +\end{verbatim} +\end{quote} +then \csx{jim} is fragile too. There is, however, the +\csx{newcommand}-replacement \csx{DeclareRobustCommand}, which +\emph{always} creates a robust command (whether or not it has optional +arguments). The syntax of \csx{DeclareRobustCommand} is substantially +identical to that of \csx{newcommand}, and if you do the wrapping +trick above as: +\begin{quote} +\begin{verbatim} +\DeclareRobustCommand{\jim}{\fred} +\end{verbatim} +\end{quote} +then \csx{jim} is robust. + +Finally, we have the \Package{makerobust} package, which defines +\csx{MakeRobustCommand} to convert a command to be robust. With the +package, the ``wrapping'' above can simply be replaced by: +\begin{quote} +\begin{verbatim} +\MakeRobustCommand\fred +\end{verbatim} +\end{quote} +Whereafter, \csx{fred} is robust. Using the package may be reasonable +if you have lots of fragile commands that you need to use in moving +arguments. + +In short, the situation is confusing. No-one believes this is +satisfactory; the \LaTeX{} team have removed the need for +protection of some things, but the techniques available in +current \LaTeX{} mean that this is an expensive exercise. It remains +a long-term aim of the team to remove all need for \csx{protect}ion. +\begin{ctanrefs} +\item[makerobust.sty]Distributed with Heiko Oberdiek's packages + \CTANref{oberdiek} +\end{ctanrefs} + +\Question[Q-edef]{\csx{edef} does not work with \csx{protect}} + +Robust \LaTeX{} commands are either ``naturally robust''~--- meaning that +they never need \csx{protect}, or ``self-protected''~--- meaning that +they have \csx{protect} built in to their definition in some +way. Self-protected commands, and fragile commands with +\csx{protect}ion are only robust in a context where the \csx{protect} +mechanism is properly handled. The body of an \csx{edef} definition +doesn't handle \csx{protect} properly, since \csx{edef} is a \TeX{} +primitive rather than a \LaTeX{} command. + +This problem is resolved by a \LaTeX{} internal command +\csx{protected@edef}, which does the job of \csx{edef} while keeping the +\csx{protect} mechanism working. There's a corresponding +\csx{protected@xdef} which does the job of \csx{xdef}. + +Of course, these commands need to be tended carefully, since they're +% beware line break on next line +internal: see \Qref[question]{'@' in control sequence names}{Q-atsigns}. + +\Question[Q-ltxcmds]{The definitions of \LaTeX{} commands} + +There are several reasons to want to know the definitions of \LaTeX{} +commands: from the simplest ``idle curiosity'', to the pressing need +to patch something to make it ``work the way you want it''. None of +these are \emph{pure} motives, but knowledge and expertise seldom +arrive through the purest of motives. + +The simple answer is to try \csx{show}, in a run of \LaTeX{} that is +taking commands from the terminal: +\begin{quote} +\begin{verbatim} +*\makeatletter +*\show\protected@edef +> \protected@edef=macro: +->\let \@@protect \protect + \let \protect \@unexpandable@protect + \afterassignment \restore@protect \edef . +\end{verbatim} +\end{quote} +(I've rearranged the output there, from the rather confused version +\TeX{} itself produces.) We may perhaps, now, wonder about +\csx{@unexpandable@protect}: +\begin{quote} +\begin{verbatim} +*\show\@unexpandable@protect +> \@unexpandable@protect=macro: +->\noexpand \protect \noexpand . +\end{verbatim} +\end{quote} +and we're starting to see how one part of the \csx{protect}ion +mechanism works (one can probably fairly safely guess what +\csx{restore@protect} does). + +Many kernel commands are declared robust: +\begin{quote} +\begin{verbatim} +*\show\texttt +> \texttt=macro: +->\protect \texttt . +\end{verbatim} +\end{quote} +so that \csx{show} isn't much help. Define a command \csx{pshow} as +shown below, and use that instead: +\begin{quote} +\begin{verbatim} +*\def\pshow#1{{\let\protect\show #1}} +*\pshow\texttt +> \texttt =\long macro: +#1->\ifmmode \nfss@text {\ttfamily #1}% + \else \hmode@bgroup \text@command {#1}% + \ttfamily \check@icl #1\check@icr + \expandafter \egroup \fi . +\end{verbatim} +\end{quote} +Note that the command name that is protected is the `base' command, +with a space appended. This is cryptically visible, in a couple of +places above. (Again, the output has been sanitised.) + +If one has a malleable text editor, the same investigation may more +comfortably be conducted by examining the file \File{latex.ltx} (which +is usually to be found, in a \acro{TDS} system, in directory +\path{tex/latex/base}). + +In fact, \File{latex.ltx} is the product of a \ProgName{docstrip} +process on a large number of \Qref*{\extension{dtx} files}{Q-dtx}, and +you can refer to those instead. The \LaTeX{} distribution includes a file +\File{source2e.tex}, and most systems retain it, again in +\path{tex/latex/base}. \File{Source2e.tex} may be processed to +provide a complete source listing of the \LaTeX{} kernel (in fact the +process isn't entirely straightforward, but the file produces messages +advising you what to do). The result is a huge document, with a +line-number index of control sequences the entire kernel and a +separate index of changes recorded in each of the files since the +\LaTeX{} team took over. + +The printed kernel is a nice thing to have, but it's unwieldy and sits +on my shelves, seldom used. One problem is that the comments are +patchy: the different modules range from well and lucidly documented, +through modules documented only through an automatic process that +converted the documentation of the source of \LaTeXo{}, to modules +that hardly had any useful documentation even in the \LaTeXo{} original. + +In fact, each kernel module \extension{dtx} file will process separately +through \LaTeX{}, so you don't have to work with the whole of +\File{source2e}. You can easily determine which module defines the +macro you're interested in: use your ``malleable text editor'' to find +the definition in \File{latex.ltx}; then search backwards from that +point for a line that starts % ! line break +\texttt{\textpercent\textpercent\textpercent\ From File:}~--- that line +tells you which \extension{dtx} file contains the definition you are interested +in. Doing this for \csx{protected@edef}, we find: +\begin{quote} +\begin{verbatim} +%%% From File: ltdefns.dtx +\end{verbatim} +\end{quote} +When we come to look at it, \File{ltdefns.dtx} proves to contain +quite a dissertation on the methods of handling \csx{protect}ion; it +also contains some automatically-converted \LaTeXo{} documentation. + +And of course, the kernel isn't all of \LaTeX{}: your command may be +defined in one of \LaTeX{}'s class or package files. For example, we +find a definition of \csx{thebibliography} in \Class{article}, but +there's no \File{article.dtx}. Some such files are generated from +parts of the kernel, some from other files in the distribution. You +find which by looking at the start of the file: in \File{article.cls}, +we find: +\begin{quote} +\begin{verbatim} +%% This is file `article.cls', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% classes.dtx (with options: `article') +\end{verbatim} +\end{quote} +so we need to format \File{classes.dtx} to see the definition in +context. + +All these .dtx files are on \acro{CTAN} as part of the main \LaTeX{} +distribution. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\LaTeX{} distribution]\CTANref{latex} +\end{ctanrefs} + +\Question[Q-oarglikesect]{Optional arguments like \csx{section}} + +Optional arguments, in macros defined using \csx{newcommand}, don't +quite work like the optional argument to \csx{section}. The default +value of \csx{section}'s optional argument is the value of the +mandatory argument, but \csx{newcommand} requires that you `know' the +value of the default beforehand. + +The requisite trick is to use a macro in the optional argument: +\begin{quote} +\begin{verbatim} +\documentclass{article} +\newcommand\thing[2][\DefaultOpt]{% + \def\DefaultOpt{#2}% + optional arg: #1, mandatory arg: #2% +} +\begin{document} +\thing{manda}% #1=#2 + +\thing[opti]{manda}% #1="opti" +\end{document} +\end{verbatim} +\end{quote} +\LaTeX{} itself has a trickier (but less readily understandable) +method, using a macro \csx{@dblarg}; inside \LaTeX{}, the example +above would have been programmed: +\begin{quote} +\begin{verbatim} +\newcommand\thing{\@dblarg\@thing} +\newcommand\@thing[2][\@error]{% + optional arg: #1, mandatory arg: #2% +} +\end{verbatim} +\end{quote} +In that code, \csx{@thing} is only ever called with an optional and a +mandatory argument; if the default from the \csx{newcommand} is +invoked, a bug in user code has bitten\dots{} + +\Question[Q-twooptarg]{More than one optional argument} + +If you've already read % ! line break +``\Qref*[question]{breaking the 9-argument limit}{Q-moren9}''. +you can probably guess the ``simple'' solution to this problem: +command relaying. + +\LaTeX{} allows commands with a single optional argument thus: +\begin{verbatim} + \newcommand{\blah}[1][Default]{...} +\end{verbatim} + +You may legally call such a command either with its optional argument +present, as +\cmdinvoke{blah}[nonDefault] or without, as \csx{blah}; in the latter +case, the code of \csx{blah} will have an argument of |Default|. + +To define a command with two optional arguments, we use the relaying +technique, as follows: +\begin{verbatim} + \newcommand{\blah}[1][Default1]{% + \def\ArgI{{#1}}% + \BlahRelay + } + \newcommand\BlahRelay[1][Default2]{% + % the first optional argument is now in + % \ArgI + % the second is in #1 + ...% + } +\end{verbatim} +Of course, \csx{BlahRelay} may have as many mandatory arguments as are +allowed, after allowance for the one taken up with its own +optional argument~--- that is, 8. + +Variants of \csx{newcommand} (and friends), with names like +\csx{newcommandtwoopt}, are available in the \Package{twoopt} package. +However, if you can, it's probably better to learn to write the commands +yourself, just to see why they're not even a good idea from the +programming point of view. + +A command with two optional arguments strains the limit of what's +sensible: obviously you can extend the technique to provide as many +optional arguments as your fevered imagination can summon. However, +see the comments on the use of the \Package{keyval} package, in +``\Qref*[question]{breaking the 9-argument limit}{Q-moren9}'', +which offers an alternative way forward. + +If you must, however, consider the \Package{optparams} or +\Package{xargs} packages. \Package{Optparams} +provides a \csx{optparams} command that you use as an intermediate in +defining commands with up to nine optional arguments. The +documentation shows examples of commands with four optional arguments +(and this from an author who has his own key-value package!). + +The \Package{xargs} package uses a key-value package +(\Package{xkeyval}) to \emph{define} the layout of the optional +arguments. Thus +\begin{quote} +\begin{verbatim} +\usepackage{xargs} +... +\newcommandx{\foo}[3][1=1, 3=n]{...} +\end{verbatim} +\end{quote} +defines a command \csx{foo} that has an optional first argument +(default 1), a mandatory second argument, and an optional third +argument (default n). + +An alternative approach is offered by Scott Pakin's +\ProgName{newcommand} program, which takes a command name and a +definition of a set of command arguments (in a fairly +readily-understood language), and emits \AllTeX{} macros which enable +the command to be defined. The command requires that a +\ProgName{Python} interpreter (etc.\@) be installed on your computer. +\begin{ctanrefs} +\item[newcommand.py]\CTANref{newcommand} +\item[optparams.sty]Distributed as part of \CTANref{sauerj} +\item[twoopt.sty]Distributed as part of \CTANref{oberdiek} +\item[xargs.sty]\CTANref{xargs} +\item[xkeyval.sty]\CTANref{xkeyval} +\end{ctanrefs} + +\Question[Q-cmdstar]{Commands defined with * options} + +\LaTeX{} commands commonly have ``versions'' defined with an asterisk +tagged onto their name: for example \csx{newcommand} and +\csx{newcommand*} (the former defines a \csx{long} version of the +command). + +The simple-minded way for a user to write such a command involves use +of the \Package{ifthen} package: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\newcommand{\mycommand}[1]{\ifthenelse{\equal{#1}{*}}% + {\mycommandStar}% + {\mycommandNoStar{#1}}% +} +\newcommand{\mycommandStar}{starred version} +\newcommand{\mycommandNoStar}[1]{normal version} +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +\newcommand{\mycommand}[1]{% + \ifthenelse{\equal{#1}{*}}% + {\mycommandStar}% + {\mycommandNoStar{#1}}% +} +\newcommand{\mycommandStar}% + {starred version} +\newcommand{\mycommandNoStar}[1]% + {normal version} +\end{verbatim} +\end{quote} +\end{narrowversion} +This does the trick, for sufficiently simple commands, but it has +various tiresome failure modes, and it requires \csx{mycommandnostar} +to take an argument. + +Of course, the \LaTeX{} kernel has something slicker than this: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\newcommand{\mycommand}{\@ifstar + \mycommandStar% + \mycommandNoStar% +} +\newcommand{\mycommandStar}[2]{starred version} +\newcommand{\mycommandNoStar}[1]{normal version} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\newcommand{\mycommand}{\@ifstar + \mycommandStar% + \mycommandNoStar% +} +\newcommand{\mycommandStar}[2]{starred version} +\newcommand{\mycommandNoStar}[1]{normal version} +\end{verbatim} +\end{narrowversion} +\end{quote} +(Note that arguments to \csx{mycommandStar} and \csx{mycommandNoStar} +are independent~--- either can have their own arguments, unconstrained +by the technique we're using, unlike the trick described above.) +The \csx{@ifstar} trick is all very well, is fast and efficient, but +it requires the definition to be % ! line break +\Qref*{\csx{makeatletter} protected}{Q-atsigns}. + +A pleasing alternative is the \Package{suffix} package. This elegant +piece of code allows you to define variants of your commands: +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +\newcommand\mycommand{normal version} +\WithSuffix\newcommand\mycommand*% + {starred version} +\end{verbatim} +\end{quote} +\end{narrowversion} +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\newcommand\mycommand{normal version} +\WithSuffix\newcommand\mycommand*{starred version} +\end{verbatim} +\end{quote} +\end{wideversion} +The package needs \Qref*{\elatex{}}{Q-etex}, but any new enough +distribution defines \LaTeX{} as \elatex{} by default. Command +arguments may be specified in the normal way, in both command +definitions (after the ``\texttt{*}'' in the \csx{WithSuffix} +version). You can also use the \TeX{} primitive commands, creating a +definition like: +\begin{quote} +\begin{verbatim} +\WithSuffix\gdef\mycommand*{starred version} +\end{verbatim} +\end{quote} +\begin{ctanrefs} +\item[ifthen.sty]Part of the \LaTeX{} distribution +\item[suffix.sty]Distributed as part of \CTANref{bigfoot} +\end{ctanrefs} + +\nothtml{\hrule height 0pt \nobreak\vskip0pt plus2.5in\vskip 0pt\relax} +\Question[Q-ltxabbrv]{\LaTeX{} internal ``abbreviations'', etc.} + +In the deeps of time, when \TeX{} first happened, computers had +extremely limited memory, and were (by today's standards) painfully +slow. When \LaTeX{} came along, things weren't much better, and even +when \LaTeXe{} appeared, there was a strong imperative to save memory +space (and to a lesser extent) \acro{CPU} time. + +From the very earliest days, Knuth used shortcut macros to speed +things up. \LaTeX{}, over the years, has extended Knuth's list by a +substantial amount. An interesting feature of the ``abbreviations'' is +that on paper, they may look longer than the thing they stand for; +however, to \AllTeX{} they \emph{feel} smaller\dots{} + +The table at the end of this answer lists the commonest of these +``abbreviations''. It is not complete; as always, if the table +doesn't help, try the \LaTeX{} source. The table lists each +abbreviation's \emph{name} and its \emph{value}, which provide most of +what a user needs to know. The table also lists the abbreviation's +\emph{type}, which is a trickier concept: if you need to know, the +only real confusion is that the abbreviations labelled `defn' are +defined using an \csx{\emph{xxx}def} command. + +\begin{tabular}{lll} +Name \tbamp Type \tbamp Value \tbeol +\tbhline +\csx{m@ne} \tbamp count \tbamp \ensuremath{-1} \tbeol +\csx{p@} \tbamp dimen \tbamp 1pt \tbeol +\csx{z@} \tbamp dimen \tbamp 0pt \tbeol +\csx{z@skip} \tbamp skip \tbamp 0pt plus 0pt minus 0pt \tbeol +\tbhline +\csx{@ne} \tbamp defn \tbamp 1 \tbeol +\csx{tw@} \tbamp defn \tbamp 2\tbeol +\csx{thr@@} \tbamp defn \tbamp 3 \tbeol +\csx{sixt@@n} \tbamp defn \tbamp 16 \tbeol +\csx{@cclv} \tbamp defn \tbamp 255 \tbeol +\csx{@cclvi} \tbamp defn \tbamp 256 \tbeol +\csx{@m} \tbamp defn \tbamp 1000 \tbeol +\csx{@M} \tbamp defn \tbamp 10000 \tbeol +\csx{@MM} \tbamp defn \tbamp 20000 \tbeol +\tbhline +\csx{@vpt} \tbamp macro \tbamp 5 \tbeol +\csx{@vipt} \tbamp macro \tbamp 6 \tbeol +\csx{@viipt} \tbamp macro \tbamp 7 \tbeol +\csx{@viiipt} \tbamp macro \tbamp 8 \tbeol +\csx{@ixpt} \tbamp macro \tbamp 9 \tbeol +\csx{@xpt} \tbamp macro \tbamp 10 \tbeol +\csx{@xipt} \tbamp macro \tbamp 10.95 \tbeol +\csx{@xiipt} \tbamp macro \tbamp 12 \tbeol +\csx{@xivpt} \tbamp macro \tbamp 14.4 \tbeol +\csx{@xviipt} \tbamp macro \tbamp 17.28 \tbeol +\csx{@xxpt} \tbamp macro \tbamp 20.74 \tbeol +\csx{@xxvpt} \tbamp macro \tbamp 24.88 \tbeol +\tbhline +\csx{@plus} \tbamp macro \tbamp ``\texttt{plus}'' \tbeol +\csx{@minus} \tbamp macro \tbamp ``\texttt{minus}'' \tbeol +%\csx{hb@xt@} \tbamp macro \tbamp ``\csx{hbox} \texttt{to}'' +\end{tabular} + +\Question[Q-ltxhash]{Defining \LaTeX{} commands within other commands} + +\LaTeX{} command definition is significantly different from the \TeX{} +primitive form discussed in an % ! line break +\Qref*[\htmlonly]{earlier question}{Q-hash} about definitions within +macros. + +In most ways, the \LaTeX{} situation is simpler (at least in part +because it imposes more restrictions on the user); however, defining a +command within a command still requires some care. + +The earlier question said you have to double the |#| signs in command +definitions: in fact, the same rule holds, except that \LaTeX{} +already takes care of some of the issues, by generating argument lists +for you. + +The basic problem is that: +\begin{quote} +\begin{verbatim} +\newcommand{\abc}[1]{joy, oh #1!% + \newcommand{\ghi}[1]{gloom, oh #1!}% +} +\end{verbatim} +\end{quote} +followed by a call: +\begin{quote} +\begin{verbatim} +\cmdinvoke{abc}{joy} +\end{verbatim} +\end{quote} +typesets ``joy, oh joy!'', but defines a command \csx{ghi} that takes +one parameter, which it ignores; \cmdinvoke{ghi}{gloom} will expand to +``gloom, oh joy!'', which is presumably not what was expected. + +And (as you will probably guess, if you've read the earlier question) +the definition: +\begin{quote} +\begin{verbatim} +\newcommand{\abc}[1]{joy, oh #1!% + \newcommand{\ghi}[1]{gloom, oh ##1!}% +} +\end{verbatim} +\end{quote} +does what is required, and \cmdinvoke{ghi}{gloom} will expand to +``gloom, oh gloom!'', whatever the argument to \csx{abc}. + +The doubling is needed whether or not the enclosing command has an +argument, so: +\begin{quote} +\begin{verbatim} +\newcommand{\abc}{joy, oh joy!% + \newcommand{\ghi}[1]{gloom, oh ##1!}% +} +\end{verbatim} +\end{quote} +is needed to produce a replica of the \csx{ghi} we defined earlier. + +\subsection{\LaTeX{} macro programming} + +\Question[Q-fixnam]{How to change \LaTeX{}'s ``fixed names''} + +\LaTeX{} document classes define several typographic operations that +need `canned text' (text not supplied by the user). In the earliest +days of \LaTeXo{} these bits of text were built in to the body of +\LaTeX{}'s macros and were rather difficult to change, but ``fixed +name'' macros were introduced for the benefit of those wishing to use +\LaTeX{} in languages other than English. +For example, the special section produced by the \csx{tableofcontents} +command is always called \csx{contentsname} (or rather, what +\csx{contentsname} is defined to mean). +Changing the canned text is now one of the easiest customisations a +user can do to \LaTeX{}. + +The canned text macros are all of the form +\csx{\meta{thing}name}, and changing them is simplicity +itself. Put: +\begin{quote} +\cmdinvoke{renewcommand}{\csx{\meta{thing}name}}{Res minor} +\end{quote} +in the preamble of your document, and the job is done. +(However, beware of the \Package{babel} package, which requires you to +use a different mechanism: be sure to check +% beware line wrap +\Qref[question]{changing \Package{babel} names}{Q-latexwords} if +you're using it.) + +The names that are defined in the standard \LaTeX{} classes (and the +\Package{makeidx} package) are listed +below. Some of the names are only defined in a subset of the classes +(and the \Class{letter} class has a set of names all of its own); +the list shows the specialisation of each name, where appropriate. + +\nothtml{\noindent}\begin{tabular}{@{}ll} +\csx{abstractname} \tbamp Abstract\tbeol +\csx{alsoname} \tbamp see also (\Package{makeidx} package)\tbeol +\csx{appendixname} \tbamp Appendix\tbeol +\csx{bibname} \tbamp Bibliography (\Class{report},\Class{book})\tbeol +\csx{ccname} \tbamp cc (\Class{letter})\tbeol +\csx{chaptername} \tbamp Chapter (\Class{report},\Class{book})\tbeol +\csx{contentsname} \tbamp Contents\tbeol +\csx{enclname} \tbamp encl (\Class{letter})\tbeol +\csx{figurename} \tbamp Figure (for captions)\tbeol +\csx{headtoname} \tbamp To (\Class{letter})\tbeol +\csx{indexname} \tbamp Index\tbeol +\csx{listfigurename} \tbamp List of Figures\tbeol +\csx{listtablename} \tbamp List of Tables\tbeol +\csx{pagename} \tbamp Page (\Class{letter})\tbeol +\csx{partname} \tbamp Part\tbeol +\csx{refname} \tbamp References (\Class{article})\tbeol +\csx{seename} \tbamp see (\Package{makeidx} package)\tbeol +\csx{tablename} \tbamp Table (for caption) +\end{tabular} + +\Question[Q-latexwords]{Changing the words \Package{babel} uses} + +\LaTeX{} uses symbolic names for many of the automatically-generated +text it produces (special-purpose section headings, captions, etc.). +As noted in \Qref[question]{``\LaTeX fixed names''}{Q-fixnam} (which +includes a list of the names themselves), +this enables the user to change the +names used by the standard classes, which is particularly useful if +the document is being prepared in some language other than \LaTeX{}'s +default English. So, for example, a Danish author may wish that her +table of contents was called ``Indholdsfortegnelse'', and so +would expect to place a command +\begin{verbatim} +\renewcommand{\contentsname}% + {Indholdsfortegnelse} +\end{verbatim} +in the preamble of her document. + +However, it's natural for a user of a non-English language to use +\Package{babel}, because it offers many conveniences and typesetting +niceties for those preparing documents in those languages. In +particular, when \Package{babel} is selecting a new language, it +ensures that \LaTeX{}'s symbolic names are translated appropriately +for the language in question. Unfortunately, \Package{babel}'s choice +of names isn't always to everyone's choice, and there is still a need +for a mechanism to replace the `standard' names. + +Whenever a new language is selected, \Package{babel} resets all the +names to the settings for that language. In particular, +\Package{babel} selects the document's main language when +\cmdinvoke{begin}{document} is executed, which immediately destroys +any changes to these symbolic names made in the prologue of a document +that uses \Package{babel}. + +Therefore, babel defines a command to enable users to change the +definitions of the symbolic names, on a per-language basis: +\csx{addto}\csx{captions}\texttt{\meta{language}} is the thing +(\texttt{\meta{language}} being the language option you gave to +\Package{babel} in the first place). For example: +\begin{verbatim} +\addto\captionsdanish{% + \renewcommand{\contentsname}% + {Indholdsfortegnelse}% +} +\end{verbatim} + +\Question[Q-running-nos]{Running equation, figure and table numbering} + +Many \LaTeX{} classes (including the standard \Class{book} class) +number things per chapter; so figures in chapter 1 are numbered 1.1, +1.2, and so on. Sometimes this is not appropriate for the user's +needs. + +Short of rewriting the whole class, one may use the \Package{chngcntr} +package, which provides commands \csx{counterwithin} (which +establishes this nested numbering relationship) and +\csx{counterwithout} (which undoes it). + +So if you have figures numbered by chapter as 1.1, 1.2, 2.1, \dots{}, +the command +\begin{quote} +\begin{verbatim} +\counterwithout{figure}{chapter} +\end{verbatim} +\end{quote} +will convert them to figures 1, 2, 3, \dots{}. (Note that the command +has also removed the chapter number from the counter's definition.) + +More elaborate use could change things numbered per section to things +numbered per chapter: +\begin{quote} +\begin{verbatim} +\counterwithout{equation}{section} +\counterwithin{equation}{chapter} +\end{verbatim} +\end{quote} +(assuming there was a class that did such a thing in the first place...) + +The \Package{chngcntr} approach doesn't involve much programming, and +the enthusiastic \LaTeX{} programmer might choose to try the technique +that we had to use before the advent of \Package{chngcntr}. Each of +the packages \Package{removefr} and \Package{remreset} defines a +\csx{@removefromreset} command, and having included the package one +writes something like: +\begin{quote} +\begin{verbatim} +\makeatletter +\@removefromreset{figure}{chapter} +\makeatother +\end{verbatim} +\end{quote} +and the automatic renumbering stops. You may then need to redefine the +way in which the figure number (in this case) is printed: +\begin{quote} +\begin{verbatim} +\makeatletter +\renewcommand{\thefigure}{\@arabic\c@figure} +\makeatother +\end{verbatim} +\end{quote} +(remember to do the whole job, for every counter you want to +manipulate, within \csx{makeatletter} \dots{}\@ \csx{makeatother}). + +This technique, too, may be used to change where in a multilevel +structure a counter is reset. Suppose your class numbers figures as +\meta{chapter}.\meta{section}.\meta{figure}, and you want figures +numbered per chapter, try: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\makeatletter +\@removefromreset{figure}{section} +\@addtoreset{figure}{chapter} +\renewcommand{\thefigure}{\thechapter.\@arabic\c@figure} +\makeatother +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\makeatletter +\@removefromreset{figure}{section} +\@addtoreset{figure}{chapter} +\renewcommand{\thefigure}% + {\thechapter.\@arabic\c@figure} +\makeatother +\end{verbatim} +\end{narrowversion} +\end{quote} +(the command \csx{@addtoreset} is a part of \LaTeX{} itself). +\begin{ctanrefs} +\item[chngcntr.sty]\CTANref{chngcntr} +\item[memoir.cls]\CTANref{memoir} +\item[removefr.tex]\CTANref{removefr} (note, this is constructed as a + ``fragment'' for use within other packages: load by + \cmdinvoke{input}{removefr}) +\item[remreset.sty]Distributed as part of \CTANref{carlisle} +\end{ctanrefs} + +\Question[Q-labelctr]{Making labels from a counter} + +Suppose we have a \LaTeX{} counter, which we've defined with +\cmdinvoke{newcounter}{foo}. We can increment the value of the counter +by \cmdinvoke{addtocounter}{foo}{1}, but that's pretty clunky for an +operation that happens so often \dots{}~so there's a command +\cmdinvoke{stepcounter}{foo} that does this special case of +increasing-by-one. + +There's an internal \LaTeX{} variable, the ``current label'', that +remembers the last `labellable' thing that \LaTeX{} has processed. +You could (if you were to insist) set that value by the relevant +\TeX{} command (having taken the necessary precautions to ensure that +the internal command worked)~--- but it's not necessary. If, instead +of either of the stepping methods above, you say +\cmdinvoke{refstepcounter}{foo}, the internal variable is set to the +new value, and (until something else comes along), \csx{label} will +refer to the counter. + +\Question[Q-oddpage]{Finding if you're on an odd or an even page} + +\Qref[Question]{Another question}{Q-marginparside} discusses the issue +of getting \csx{marginpar} commands to put their output in the correct +margin of two-sided documents. This is an example of the general +problem of knowing where a particular bit of text lies: the output +routine is asynchronous, and \AllTeX{} will usually process quite a +bit of the ``next'' page before deciding to output any page. As a +result, the |page| counter (known internally in \LaTeX{} as +\csx{c@page}) is normally only reliable when you're actually \emph{in} +the output routine. + +The solution is to use some version of the \csx{label} mechanism to +determine which side of the page you're on; the value of the page +counter that appears in a \csx{pageref} command has been inserted in +the course of the output routine, and is therefore safe. + +However, \csx{pageref} itself isn't reliable: one might hope that +\begin{verbatim} +\ifthenelse{\isodd{\pageref{foo}}}{odd}{even} +\end{verbatim} +would do the necessary, but both the \Package{babel} and +\Package{hyperref} packages have been known to interfere with the +output of \csx{pageref}; be careful! + +The \Package{changepage} package needs to provide this functionality for +its own use, and therefore provides a command \csx{checkoddpage}; this +sets a private-use label, and the page reference part of that label is +then examined (in a \Package{hyperref}-safe way) to set a conditional +\csx{ifoddpage} true if the command was issued on an odd page. The +\Class{memoir} class has the same command setting a conditional +\csx{ifoddpage}. Of course, the \csx{label} contributes to \LaTeX{}'s +``Rerun to get cross-references right'' error messages\dots{} + +The Koma-Script classes have an \environment{addmargin*} environment +that also provides the sorts of facilities that the \Package{changepage} +offers. Koma-Script's supporting command is % !line break +\cmdinvoke{ifthispageodd}{<true>}{<false>} executes different things +depending on the page number. +\begin{ctanrefs} +\item[changepage.sty]\CTANref{changepage} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\item[memoir.cls]\CTANref{memoir} +\end{ctanrefs} + +\Question[Q-labelformat]{How to change the format of labels} + +By default, when a label is created, it takes on the appearance of the +counter labelled, so the label appears as +\csx{the}\texttt{\meta{counter}}~--- what would be used if you +asked to typeset the counter in your text. This isn't always what you +need: for example, if you have nested enumerated lists with the outer +numbered and the inner labelled with letters, one might expect to want +to refer to items in the inner list as ``2(c)''. (Remember, you can +\nothtml{change the structure of list items~--- }% +\Qref{change the structure of list items}{Q-enumerate}.) +The change is of course +possible by explicit labelling of the parent and using that label to +construct the typeset result~--- something like +\begin{quote} +\begin{verbatim} +\ref{parent-item}(\ref{child-item}) +\end{verbatim} +\end{quote} +which would be both tedious and error-prone. What's more, it would be +undesirable, since you would be constructing a visual representation +which is inflexible (you couldn't change all the references to elements +of a list at one fell swoop). + +\LaTeX{} in fact has a label-formatting command built into every label +definition; by default it's null, but it's available for the user to +program. For any label \meta{counter} there's a \LaTeX{} internal +command \csx{p@}\meta{\texttt{counter}}; for example, a label definition +on an inner list item is supposedly done using the command +\cmdinvoke{p@enumii}{\csx{theenumii}}. Unfortunately, the internal +workings of this aren't quite right, and you need to patch the +\csx{refstepcounter} command: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\renewcommand*\refstepcounter[1]{% + \stepcounter{#1}% + \protected@edef\@currentlabel{% + \csname p@#1\expandafter\endcsname + \csname the#1\endcsname + }% +} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\renewcommand*\refstepcounter[1]{\stepcounter{#1}% + \protected@edef\@currentlabel{% + \csname p@#1\expandafter\endcsname + \csname the#1\endcsname + }% +} +\end{verbatim} +\end{wideversion} +\end{quote} +With the patch in place you can now, for example, change the labels on +all inner lists by adding the following code in your preamble: +\begin{quote} +\begin{verbatim} +\makeatletter +\renewcommand{\p@enumii}[1]{\theenumi(#1)} +\makeatother +\end{verbatim} +\end{quote} +This would make the labels for second-level enumerated lists appear as +``1(a)'' (and so on). The analogous change works for any counter that +gets used in a \csx{label} command. + +In fact, the \Package{fncylab} package does all the above (including +the patch to \LaTeX{} itself). With the package, the code above is +(actually quite efficiently) rendered by the command: +\begin{quote} +\begin{verbatim} +\labelformat{enumii}{\theenumi(#1)} +\end{verbatim} +\end{quote} +In fact, the above example, which we can do in several different ways, +has been rendered obsolete by the appearance of the \Package{enumitem} +package, which is discussed in the answer about % ! line break +\Qref*{decorating enumeration lists}{Q-enumerate}. +\begin{ctanrefs} +\item[enumitem.sty]\CTANref{enumitem} +\item[fncylab.sty]\CTANref{fncylab} +\end{ctanrefs} + +\Question[Q-seccntfmt]{Adjusting the presentation of section numbers} + +The general issues of adjusting the appearance of section headings are +pretty complex, and are covered in % beware line breaks (2 lines) +\latexhtml{question}{the question on} +\Qref[\htmlonly]{the style of section headings}{Q-secthead}. + +However, people regularly want merely to change the way the section +number appears in the heading, and some such people don't mind writing +out a few macros. This answer is for \emph{them}. + +The section number is typeset using the +\begin{narrowversion} + \LaTeX{} internal +\end{narrowversion} +\begin{wideversion} + \Qref{\LaTeX{} internal}{Q-atsigns} +\end{wideversion} +\csx{@seccntformat} command, which is given the ``name'' (section, +subsection, \dots{}) of the heading, as argument. Ordinarily, +\csx{@seccntformat} +merely outputs the section number, and then a \csx{quad} of space. +Suppose you want to put a stop after every section (subsection, +subsubsection, \dots{}) number, a trivial change may be implemented by +simple modification of the command: +\begin{quote} +\begin{verbatim} +\renewcommand*{\@seccntformat}[1]{% + \csname the#1\endcsname.\quad +} +\end{verbatim} +\end{quote} + +Many people (for some reason) want a stop after a section number, but +not after a subsection number, or any of the others. +To do this, one must make \csx{@seccntformat} switch according to its +argument. The following technique for doing the job is slightly +wasteful, but is efficient enough for a relatively rare operation: +\begin{wideversion} +\begin{quote} +\begin{verbatim} +\let\@@seccntformat\@seccntformat +\renewcommand*{\@seccntformat}[1]{% + \expandafter\ifx\csname @seccntformat@#1\endcsname\relax + \expandafter\@@seccntformat + \else + \expandafter + \csname @seccntformat@#1\expandafter\endcsname + \fi + {#1}% +} +\end{verbatim} +\end{quote} +\end{wideversion} +\begin{narrowversion} +\begin{quote} +\begin{verbatim} +\let\@@seccntformat\@seccntformat +\renewcommand*{\@seccntformat}[1]{% + \expandafter\ifx + \csname @seccntformat@#1\endcsname + \relax + \expandafter\@@seccntformat + \else + \expandafter + \csname @seccntformat@#1\expandafter + \endcsname + \fi + {#1}% +} +\end{verbatim} +\end{quote} +\end{narrowversion} +which looks to see if a second-level command has been defined, and +uses it if so; otherwise it uses the original. The second-level +command to define stops after section numbers (only) has the same +definition as the original ``all levels alike'' version: +\begin{quote} +\begin{verbatim} +\newcommand*{\@seccntformat@section}[1]{% + \csname the#1\endcsname.\quad +} +\end{verbatim} +\end{quote} +Note that all the command definitions of this answer are dealing in +\Qref*{\LaTeX{} internal commands}{Q-atsigns}, so the above +code should be in a package file, for preference. + +The \Class{Koma-script} classes have different commands for specifying +changes to section number presentation: \csx{partformat}, +\csx{chapterformat} and \csx{othersectionlevelsformat}, but otherwise +their facilities are similar to those of ``raw'' \LaTeX{}. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} +\end{ctanrefs} + +\Question[Q-spaftend]{There's a space added after my environment} + +You've written your own environment \environment{env}, and it works +except that a space appears at the start of the first line of typeset +text after \cmdinvoke{end}{env}. This doesn't happen with similar +\LaTeX{}-supplied environments. + +You could impose the restriction that your users always put a +``\texttt{\textpercent}'' sign after the environment~\dots{}\nothtml{\@} but +\LaTeX{} environments don't require that, either. + +The \LaTeX{} environments' ``secret'' is an internal flag which causes +the unwanted spaces to be ignored. Fortunately, you don't have to use +the internal form: since 1996, \LaTeX{} has had a user command +\csx{ignorespacesafterend}, which sets the internal flag. + +\Question[Q-labundef]{Finding if a label is undefined} + +People seem to want to know (at run time) if a label is undefined (I +don't actually understand \emph{why}, particularly: it's a transient +state, and \LaTeX{} deals with it quite well). + +A resolved label is simply a command: +\csx{r@}\texttt{\meta{label-name}}; determining if the label is set is +then simply a matter of detecting if the command exists. The usual +\LaTeX{} internal way of doing this is to use the command +\csx{@ifundefined}: +\begin{quote} + \cmdinvoke*{@ifundefined}{\textup{r@}label-name}{undef-cmds}{def-cmds} +\end{quote} +In which, \meta{label-name} is exactly what you would use in +a \csx{label} command, and the remaining two arguments are command +sequences to be used if the label is undefined +(\meta{undef-cmds}) or if it is defined +(\meta{def-cmds}). + +Note that any command that incorporates \csx{@ifundefined} is naturally +fragile, so remember to create it with \csx{DeclareRobustCommand} or to +use it with \csx{protect} in a moving argument. + +If you're into this game, you may well not care about \LaTeX{}'s +warning about undefined labels at the end of the document; however, +if you are, include the command \csx{G@refundefinedtrue} in +\meta{\texttt{undef-cmds}}. + +And of course, remember you're dealing in internal commands, and pay +attention to the \Qref*{at-signs}{Q-atsigns}. + +All the above can be avoided by using the \Package{labelcas} package: +it provides commands that enable you to switch according to the state +of a single label, or the states of a list of labels. The package's +definition is a bit complicated, but the package itself is pretty +powerful. +\begin{ctanrefs} +\item[labelcas.sty]\CTANref{labelcas} +\end{ctanrefs} + +\Question[Q-addtoreset]{Master and slave counters} + +It's common to have things numbered ``per chapter'' (for example, in +the standard \Class{book} and \Class{report} classes, figures, tables +and footnotes are all numbered thus). The process of resetting is +done automatically, when the ``master'' counter is stepped (when the +\csx{chapter} command that starts chapter \meta{n} happens, the +\texttt{chapter} counter is stepped, and all the dependent counters are set +to zero). + +How would you do that for yourself? You might want to number +algorithms per section, or corollaries per theorem, for example. If +you're defining these things by hand, you declare the relationship +when you define the counter in the first place: +\begin{quote} +\cmdinvoke*{newcounter}{new-name}[master] +\end{quote} +says that every time counter \meta{master} is stepped, counter +\meta{new-name} will be reset. + +But what if you have an uncooperative package, that defines the +objects for you, but doesn't provide a programmer interface to make +the counters behave as you want? + +The \csx{newcounter} command uses a \LaTeX{} internal command, and you +can also use it: +\begin{quote} +\cmdinvoke*{@addtoreset}{new-name}{master} +\end{quote} +(but remember that it needs to be between \csx{makeatletter} and +\csx{makeatother}, or in a package of your own). + +The \Package{chngcntr} package encapsulates the \csx{@addtoreset} +command into a command \csx{counterwithin}. So: +\begin{quote} +\begin{verbatim} +\counterwithin*{corrollary}{theorem} +\end{verbatim} +\end{quote} +will make the corollary counter slave to theorem counters. The +command without its asterisk: +\begin{quote} +\begin{verbatim} +\counterwithin{corrollary}{theorem} +\end{verbatim} +\end{quote} +will do the same, and also redefine \csx{thecorollary} as % line brk! +\meta{theorem number}.\meta{corollary number}, which is a good scheme +if you ever want to refer to the corollaries~--- there are potentially +many ``corollary~1'' in any document, so it's as well to tie its number +to the counter of the theorem it belongs to. This is true of pretty +much any such counter-within-another; if you're not using the +\Package{chngcntr}, refer to the answer to % line break! +\Qref*{redefining counters' \csx{the-}commands}{Q-the-commands} for +the necessary techniques. + +Note that the technique doesn't work if the master counter is |page|, +the number of the current page. The |page| counter is stepped deep +inside the output routine, which usually gets called some time after +the text for the new page has started to appear: so special +techniques are required to deal with that. One special case is dealt +with elsewhere: \Qref*{footnotes numbered per page}{Q-footnpp}. One +of the techniques described there, using package \Package{perpage}, +may be applied to any counter. The command: +\begin{quote} +\cmdinvoke*{MakePerPage}{counter} +\end{quote} +will cause \meta{counter} to be reset for each page. The package uses +a label-like mechanism, and may require more than one run of \LaTeX{} +to stabilise counter values~--- \LaTeX{} will generate the usual +warnings about labels changing. +\begin{ctanrefs} +\item[chngcntr.sty]\CTANref{chngcntr} +\item[perpage.sty]Distributed as part \CTANref{bigfoot} +\end{ctanrefs} + +\Question[Q-fontsize]{Fonts at arbitrary sizes} + +Almost all fonts, nowadays, are provided with \LaTeX{} control +(\extension{fd}) files, so the temptation to risk the +\Qref*{problems of \csx{newfont}}{Q-newfont*} is usually easy to +resist. + +However, one temptation remains, arising from the way that \LaTeX{} +restricts the sizes of fonts. In fact, the restriction only +significantly applies to the default (Computer Modern) and the +Cork-encoded (\acro{T}1) EC fonts, but it is widely considered to be +anomalous, nowadays. In recognition of this problem, there is a +package \Package{fix-cm} which will allow you to use the fonts, within +\LaTeX{}, at any size you choose. If you're not using scaleable +versions of the fonts, most modern distributions will just generate an +appropriate bitmap for you. + +So, suppose you want to use Computer Modern Roman at 30 points, you +might be tempted to write: +\begin{quote} +\begin{verbatim} +\newfont{\bigfont}{cmr10 at 30pt} +\begin{center} + \bigfont Huge text +\end{center} +\end{verbatim} +\end{quote} +which will indeed work, but will actually produce a worse result than +\begin{quote} +\begin{verbatim} +\usepackage{fix-cm} +... +\begin{center} + \fontsize{30}{36}\selectfont + Huge text +\end{center} +\end{verbatim} +\end{quote} +Note that the \Package{fix-cm} package was not distributed until the +December 2003 edition of \LaTeX{}; if you have an older distribution, +the packages \Package{type1cm} (for \acro{CM} fonts) and +\Package{type1ec} (for \acro{EC} fonts) are available. +\begin{ctanrefs} +\item[fix-cm.sty]Distributed as part of \CTANref{latex} (an unpacked + version is available at \CTANref{fix-cm}) +\item[type1cm.sty]\CTANref{type1cm} +\item[type1ec.sty]\CTANref{type1ec} (the package is actually part of + the \CTANref{cm-super} distribution, but it works happily in + the absence of the scaled fonts) +\end{ctanrefs} + +\Question[Q-latexqual]{The quality of your \LaTeX{}} + +The \Package{l2tabu} tutorial (mentioned in % ! line break +\Qref[question]{online introductions}{Q-man-latex}) is undoubtedly a +good read. + +However, it's always difficult to remember the things you should +\emph{not} do, when there are so many things to remember that you +really must do: some automation is needed\dots{}. + +The nicely-named \Package{nag} allows you to apply a configurable set +of checks to your document, as you run it through \LaTeX{}; you get +messages like: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +Package nag Warning: Command \bf is an old LaTeX 2.09 command. +(nag) Use \bfseries or \textbf instead on input line 30. +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +Package nag Warning: Command \bf is an old + LaTeX 2.09 command. +(nag) Use \bfseries or \textbf + instead on input line 30. +\end{verbatim} +\end{narrowversion} +\end{quote} +\begin{wideversion} + (the package provides a demo file which contains most of the sorts + of errors you might make~--- this is one of them). +\end{wideversion} +\begin{narrowversion} + (the two error lines both wrapped above; the package provides a demo + file which contains most of the sorts of errors you might make~--- + this is one of them). +\end{narrowversion} + +There's also a web site +\href{http://www.kohm.name/markus/texidate.html}{TeXidate} +which will do a static analysis of your document (unfortunately, you +have to paste your document source into a text window). The site +doesn't seem as comprehensive as \Package{nag}, but it allows you to +download its script, which you can then juggle with to make it more +draconian. +\begin{ctanrefs} +\item[l2tabu]Browse \CTANref{l2tabu} for a copy in a language that's + convenient for you +\item[nag.sty]\CTANref{nag} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-projects.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-projects.tex new file mode 100644 index 00000000000..16410c01b3d --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-projects.tex @@ -0,0 +1,533 @@ +% $Id: faq-projects.tex,v 1.2 2009/07/11 12:28:34 rf10 Exp $ + +\section{Current \TeX{}-related projects} + +\Question[Q-LaTeX3]{The \LaTeX{} project} + +The \LaTeX{} project team (see \URL{http://www.latex-project.org/latex3.html}) +is a small group of volunteers whose aim is +to produce a major new document processing system based on the +principles pioneered by Leslie Lamport in the current \LaTeX{}. The +new system is (provisionally) called \LaTeX{}3; it +will remain freely available and it will be fully documented at +all levels. + +The \LaTeX{} team's first product (\LaTeXe{}) was delivered in 1994 +(it's now properly called ``\LaTeX{}'', since no other version is current). + +\LaTeXe{} was intended as a consolidation exercise, unifying several +sub-variants of \LaTeX{} while changing nothing whose change wasn't +absolutely necessary. This has permitted the team to support a single +version of \LaTeX{}, in parallel with development of \LaTeX{}3. + +Some of the older discussion papers about directions for \LaTeX{}3 are +to be found on \acro{CTAN}; other (published) articles are to be +found on the project web site +(\URL{http://www.latex-project.org/papers/}), as is some of the +project's experimental code +(see \URL{http://www.latex-project.org/code.html}, which allows you to +read the project's source repository); a recent snapshot of two major +collections from the code, \Package{expl3} and \Package{xpackages}, +are available. Contributed code, such as \Package{keys3} (for +key-value argument decoding) and \Package{numparse3} (for number +processing) are available in the \acro{CTAN} `\LaTeX{} experimental' tree. + +You can +participate in discussions of the future of \LaTeX{} through the +mailing list \texttt{latex-l}. Subscribe to the list by sending a +message `\texttt{subscribe latex-l <\emph{your name}>}' to +\mailto{listserv@urz.Uni-Heidelberg.de} +\begin{ctanrefs} +\item[expl3 \nothtml{\rmfamily}bundle]\CTANref{expl3} +\item[keys3.sty]\CTANref{keys3} +\item[\nothtml{\rmfamily}\LaTeX{} project publications]\CTANref{ltx3pub} +\item[xpackages \nothtml{\rmfamily}bundle]\CTANref{xpackages} +\end{ctanrefs} + +\Question[Q-mathml]{Future \acro{WWW} technologies and \AllTeX{}} + +An earlier answer % ! line break +(\Qref[number]{``converting to \acro{HTML}''}{Q-LaTeX2HTML}) +addresses the issue of converting existing \AllTeX{} documents for +viewing on the Web as \acro{HTML}. All the present techniques are +somewhat flawed: the answer explains why. + +However, things are changing, with +better font availability, cunning \acro{HTML} programming and the +support for new Web standards. +\begin{description} +\item[Font technologies] Direct representation of mathematics in + browsers has been hampered up to now by the limited range of symbols + in the fonts one can rely on being available. Some existing + \AllTeX{} to \acro{HTML} converters provide maths symbols by + hitching them to alternate font face specifications for standard + code points in a non-standard way. This does nothing for the + universality of the \acro{HTML} so generated. + + In the near future, we can expect rather wide availability of + Unicode fonts with good coverage of symbols, which should make life + easier for those who need to represent mathematics. +\item[\acro{XML}] The core of the range of new standards is + \acro{XML}, which provides a framework for better structured markup; + limited support for it has already appeared in some browsers. + + Conversion of \AllTeX{} source to \acro{XML} is already available + (through \TeX{}4ht at least), and work continues in that arena. The + alternative, authoring in \acro{XML} (thus producing documents that + are immediately Web-friendly, if not ready) and using \AllTeX{} to + typeset is also well advanced. One useful technique is + \Qref*{\emph{transforming} the \acro{XML} to \LaTeX{}}{Q-SGML2TeX}, + using an \acro{XSLT} stylesheet or code for an \acro{XML} library, + and then simply using \LaTeX{}; alternatively, one may + \Qref*{typeset direct from the \acro{XML} source}{Q-readML}. +\item[Direct representation of mathematics] + Math\acro{ML} is a standard for representing maths on the Web; its + original version was distinctly limited, but version 2 of Math\acro{ML} + has had major browser support since 2002 with richness of mathematical + content for online purposes approaching that of \TeX{} for print. + Browser support for Math\acro{ML} is provided by \ProgName{amaya}, the + `Open Source' browser \ProgName{mozilla} (and its derivatives + including \ProgName{NetScape}, \ProgName{Firefox} and \ProgName{Galeon}) and + \ProgName{Internet Explorer} when equipped with a suitable plug-in + such as \ProgName{MathPlayer}. + There's evidence that \AllTeX{} users are starting to use such + browsers. Some believe that \acro{XHTML}+Math\acro{ML} now provides + better online viewing than \acro{PDF}. + Work to produce \acro{XHTML}+Math\acro{ML} is well advanced in both the + \TeX{}4ht and \ProgName{TtH} projects for \AllTeX{} conversion. +%% Such conversion, however, has limits of soundness unless one +%% is very much aware of the needs of one's conversion program +%% and adapts one's usage of \AllTeX{} accordingly. + + An approach different from \AllTeX{} conversion is taken by + the \href{http://www.albany.edu/~hammond/gellmu/}{\emph{GELLMU} Project}. + Its \emph{article} \acro{XML} document type, which has a markup vocabulary + close to \LaTeX{} that can be edited using \LaTeX{}-like markup + (even though it is not \LaTeX{}~--- so far), comes with translators + that make both \acro{PDF} (via \emph{pdflatex}) and + \acro{XHTML}+Math\acro{ML}. Such an approach avoids the inherent + limitations of the ``traditional'' \AllTeX{} translation processes, + which have traps that can be sprung by unfettered use of \AllTeX{} + markup. +\item[Graphics] + \acro{SVG} is a standard for graphics representation on the web. + While the natural use is for converting existing figures, + representations of formulas are also possible, in place of the separate + bitmaps that have been used in the past (and while we wait for the + wider deployment of Math\acro{ML}). + + Browser plug-ins, that deal with \acro{SVG} are already available + (Adobe offer one, for example). More recently, the open source + graphics editor \href{http://www.inkscape.org/}{\ProgName{Inkscape}} + has appeared, and has been reported to be useful for + \acro{SVG}-related work in at least one \TeX{}-related project. Be + aware that the developers of \ProgName{Inkscape} have no illusions + about being able to replace commercial software, yet\dots{} +\item[Direct use of \TeX{} markup] + Some time back, \acro{IBM} developed a browser plug-in called + TechExplorer, which would display \AllTeX{} documents direct in a + browser. Over the years, it developed into a Math\acro{ML} browser + plug-in, while still retaining its \AllTeX{} abilities, but it's now + distributed (free for Linux and Windows platforms) by + \href{http://www.integretechpub.com/}{Integre Technical Publishing}. + + The disadvantage of the TechExplorer approach is that it places the + onus on the browser user; and however technically proficient + \emph{you} are, it's never safe to assume too much of your readers. + An interesting alternative is + \href{http://www.forkosh.com/mathtex.html}{Math\TeX{}}, which sits + on your server as a \acro{CGI} script, and you use it to include + your \TeX{}, in your \acro{HTML}, as if it were an image: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +<img src="/cgi-bin/mimetex.cgi?f(x)=\int\limits_{-\infty}^xe^{-t^2}dt"> +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +<img src="/cgi-bin/mimetex.cgi?f(x)= + \int\limits_{-\infty}^xe^{-t^2}dt"> +\end{verbatim} +\end{narrowversion} +\end{quote} +(\Package{Mathtex} supersedes the author's earlier \Package{mimetex}.) +\end{description} +\begin{ctanrefs} +\item[GELLMU]\CTANref{gellmu} +\item[MathTeX]\CTANref{MimeTeX} +\item[MimeTeX]\CTANref{MimeTeX} +\item[TeX4HT]\CTANref{tex4ht} +\end{ctanrefs} + +\Question[Q-textrace]{Making outline fonts from \MF{}} + +\ProgName{TeXtrace}, originally developed by P\'eter Szab\'o, is a +bundle of Unix scripts that use Martin Weber's freeware boundary +tracing package +\href{http://autotrace.sourceforge.net}{\ProgName{autotrace}} to +generate Type~1 outline fonts from \MF{} bitmap +font outputs. The result is unlikely ever to be of the quality of +the commercially-produced Type~1 font, but there's always the +\href{http://fontforge.sourceforge.net/}{\ProgName{FontForge}} font +editor to tidy things. Whatever, there +remain fonts which many people find useful and which fail to attract +the paid experts, and auto-tracing is providing a useful service here. +Notable sets of +fonts generated using \ProgName{TeXtrace} are P\'eter Szab\'o's own +\acro{EC}/\acro{TC} font set \FontName{tt2001} and Vladimir Volovich's +\acro{CM}-Super set, which covers the \acro{EC}, \acro{TC}, and the +Cyrillic \acro{LH} font sets (for details of both of which sets, see +\Qref[answer]{``8-bit'' type 1 fonts}{Q-type1T1}). + +Another system, which arrived slightly later, is +\href{http://www.cs.uu.nl/~hanwen/mftrace/}{\ProgName{mftrace}}: +this is a small \ProgName{Python} program that does the same job. +\ProgName{Mftrace} may use either \ProgName{autotrace} (like +\ProgName{TeXtrace}) or Peter Selinger's +\href{http://potrace.sourceforge.net}{\ProgName{potrace}} to produce +the initial outlines to process. \ProgName{Mftrace} is said to be +more flexible, and easier to use, than is \ProgName{TeXtrace}, but both systems +are increasingly being used to provide Type~1 fonts to the public domain. + +The \ProgName{MetaType1} system aims to use \MF{} font sources, by way +of \MP{} and a bunch of scripts and so on, to produce high-quality +Type~1 fonts. The first results, the % ! line break +\Qref*{\Package{Latin Modern} fonts}{Q-type1T1}, are now +well-established, and a bunch of existing designs have been reworked +in MetaType1 format. +\begin{ctanrefs} +\item[MetaType1]\CTANref{metatype1} +\end{ctanrefs} + +\Question[Q-WYGexpts]{The \TeX{} document preparation environment} + + +``\Qref*{Why \TeX{} is not \WYSIWYG{}}{Q-notWYSIWYG}'' +outlines the reasons (or excuses) for the huge disparity of user +interface between ``typical'' \TeX{} environments and commercial word +processors. + +Nowadays, at last, there is a range of tools available that try either +to bridge or to close the gap. One range modestly focuses on +providing the user with a legible source document. At the other +extreme we have \href{http://www.texmacs.org}{\ProgName{TeXmacs}}, +a~document processor using +\TeX{}'s algorithms and fonts for both editor display and printing. +\ProgName{TeXmacs} does not use the \TeX{} +language itself (though among other formats, \LaTeX{} may be exported +and imported). A bit closer to \LaTeX{} is +\href{http://www.lyx.org/}{LyX}, which has its own +editor display and file formats as well, but does its print output by +exporting to \LaTeX{}. The editor display merely resembles the +printed output, but you have the possibility of entering arbitrary +\LaTeX{} code. If you use constructs that LyX does not +understand, it will just display them as source text marked red, but +will properly export them. + +Since a lot of work is needed to create an editor from scratch that +actually is good at editing (as well as catering for \TeX{}), it is +perhaps no accident that several approaches have been implemented +using the extensible \ProgName{emacs} editor. The low end of the +prettifying range is occupied by syntax highlighting: marking \TeX{} +tokens, comments and other stuff with special colours. +Many free editors (including \ProgName{emacs}) can cater for \TeX{} in +this way. Under Windows, one of the more popular editors with such +support is the +Shareware product \href{http://www.winedt.com/}{\ProgName{winedt}}. +Continuing the range of +tools prettifying your input, we have the \ProgName{emacs} package +\href{http://x-symbol.sourceforge.net}{\Package{x-symbol}}, which does +the \WYSIWYG{} part of its work by replacing single \TeX{} tokens and +accented letter sequences with appropriate-looking characters on the +screen. + +A different type of tool focuses on making update and access to +previews of the typeset document more immediate. A recent addition +in several viewers, editors and \TeX{} executables are so-called +`source specials' for cross-navigation. When \TeX{} compiles a +document, it will upon request insert special markers for every input +line into the typeset output. The markers are interpreted by the \acro{DVI} +previewer which can be made to let its display track the page +corresponding to the editor input position, or to let the editor jump +to a source line corresponding to a click in the preview window. + +An \ProgName{emacs} package that combines this sort of editor movement +tracking with automatic fast recompilations (through the use of dumped +formats) is +\href{http://pauillac.inria.fr/whizzytex/}{\Package{WhizzyTeX}} + which is best used with a previewer by the +same author. A simpler package in a similar spirit is called +\href{http://www.activetex.org/}{\Package{InstantPreview}} and makes +use of a continuously running copy of \TeX{} +(under the moniker of \texttt{TeX daemon}) instead of dumping formats to +achieve its speed. + +Another \ProgName{emacs} package called +\href{http://preview-latex.sourceforge.net}{\Package{preview-latex}} +tries to solve +the problem of visual correlation between source and previews in a +more direct way: it uses a \LaTeX{} package to chop the document source +into interesting fragments (like figures, text or display math) which +it runs through \LaTeX{} and replaces the source text of those +fragments with the corresponding rendered output images. Since it +does not know about the structure of the images, at the actual cursor +position the source text is displayed while editing rather than the +preview. This approach is more or less a hybrid of the source +prettifying and fast preview approaches since it works in the source +buffer but uses actual previews rendered by \LaTeX{}. + +A more ambitious contender is called \TeX{}lite. This +system is only available on request from its author; +it continuously updates its screen with the help of a special version +of \TeX{} dumping its state in a compressed format at each page and +using hooks into \TeX{}'s line breaking mechanism for reformatting +paragraphs on the fly. That way, it can render the output from the +edited \TeX{} code with interactive speed on-screen, and it offers the +possibility of editing directly in the preview window. + +That many of these systems occupy slightly different niches can be +seen by comparing the range of the +\ProgName{emacs}-based solutions ranging from syntax highlighting to instant +previewing: all of them can be activated at the same time without +actually interfering in their respective tasks. + +The different approaches offer various choices differing in the +immediacy of their response, the screen area they work on (source or +separate window), degree of correspondence of the display to the final +output, and the balance they strike between visual aid and visual +distraction. +\begin{ctanrefs} +\item[preview-latex]Distributed as part of \CTANref{auctex} +\item[texmacs]Browse \CTANref{texmacs} +\end{ctanrefs} + +\Question[Q-omegaleph]{Omega and Aleph} + +Omega \nothtml{(\ensuremath{\Omega})} was developed as an extension of +\TeX{}, to use with multilingual texts, expressed in a variety of +input encodings. Omega uses 16-bit, Unicode-encoded, characters. It +provides many innovative concepts, notably including the ``translation +process'' that takes a character stream and transforms it according to +various processes that may be internally specified, or be a separate +program. + +While Omega showed a lot of promise at its mid-1990s announcement, +progress was slow, and development was essentially dead by the time +that one of the original developers withdrew (taking with him a bunch +of research students). + +Before that distressing event, a separate thread of development had +started, to produce a program % !avoid space between Aleph and comma +called Aleph\nothtml{ (\ensuremath{\aleph})}, which merged the facilities of +\Qref*{\eTeX{}}{Q-etex} into a stable Omega codebase and added other +extensions. Aleph also proved an attractive platform for many people; +but its development, too, has dried up. + +A presentation at Euro\TeX{} 2006 claimed that development of Omega +was picking up again, in parallel with research into what the (new) +developers consider a rational scheme for supporting \TeX{}-style +typesetting. The new system was to be known as Omega-2 +(\latexhtml{\ensuremath{\Omega_2}}{Omega subscript 2}), and was to be +designed in a modular fashion so that support of new facilities (such +as use of advanced OpenType fonts) could be added in a relatively +straightforward fashion. A quick web search leads to a recommendation +that potential users consider \Qref{\LuaTeX{}}{Q-luatex} instead. +Fortunately, lessons learned in Aleph project are being carried +forward in the \Qref*{\LuaTeX{}}{Q-luatex} project. + +\Question[Q-xetex]{The \xetex{} project} + +\href{http://scripts.sil.org/xetex}{\xetex{}}, by Jonathan Kew, is a +successor to the shareware \TeX{}/\acro{GX} program for Macintoshes. +It is a Unicode-based \TeX{} implementation which is able to make +direct use of the fonts installed on a system. It supports the +advanced typographical features available in modern font technology +(OpenType, \acro{AAT} on Mac~\acro{OS}~X, Graphite). \xetex{} was +originally developed for Mac~\acro{OS}~X but it is now fully +integrated in \texlive{} on a wide range of platforms, as well as +being available as part of \miktex{}. \xetex{} supports Unicode +character sets and bidirectional typesetting (via \eTeX{} primitives). +It is popular among linguists and scholars in the humanities, as well +as an increasing range of people working in other fields. Support for +mathematical Unicode fonts (such as Asana Math and Cambria) is +progressing. + +The project has an active % ! line break +\href{http://www.tug.org/mailman/listinfo/xetex}{mailing list}; a +collection of other information is to be found in a set of % ! line break +\href{http://www.tug.org/xetex/}{links on the \acro{TUG} web site}. + +\Question[Q-luatex]{\PDFTeX{} and \LuaTeX{}} + +As is said elsewhere in these \acro{FAQ}s, development of +\Qref*{\PDFTeX{}}{Q-whatpdftex} is ``in essence'' complete~--- +no new facilities are being developed, since the limitations of the +present structure mean that the returns on effort invested are +diminishing. The \PDFTeX{} team has announced that no further +developments will be added after the release of \PDFTeX{} 1.50.0, +which will be the next major release. + +In parallel with the running-down of \PDFTeX{} development, +development of a new system, \LuaTeX{} is under way. +\href{http://www.lua.org/}{\ProgName{Lua}} is a script +language, designed to offer an interpreter that may be incorporated +into other applications. \LuaTeX{} consists of a \TeX{}-like engine +with a \ProgName{lua} interpreter built into it; the \ProgName{lua} +interpreter has access to many of the data structures used for +typesetting, and the user may also interpolate chunks of +\ProgName{lua} code into their \AllTeX{} macros, or as `call-backs' +for use when the \TeX{}-like engine does certain operations. + +This arrangement offers the prospect of a ``semi-soft'' typesetting +engine: it will have its basic behaviour, but the user gets to +redefine functionality if an idea occurs~--- there will be no need to +persuade the world first, and then find a willing developer to work on +the sources of of the distribution. + +The \href{http://www.luatex.org/}{\LuaTeX{} project} is (with monetary +support from various sources) pursuing avenues that many of the other +current projects have in their sights, notably Unicode character +representations and support for OpenType fonts. The intention is +to integrate the extensions pioneered by \Qref*{Aleph}{Q-omegaleph}. + +A release of \LuaTeX{} whose functionality is declared (version 0.50) +has recently appeared. \texlive{} 2008 incorporates an early release +of \LuaTeX{}, and the upcoming \miktex{} version 2.8 (no current +release date) will probably incorporate \LuaTeX{}. \CONTeXT{} +distributions can already make use of \LuaTeX{}. + +\Question[Q-ant]{The \textsf{ANT} typesetting system} + +Achim Blumensath's \href{http://ant.berlios.de}{\textsf{ANT}} project +aims not to replicate \TeX{} with a different implementation +technique, but rather to provide a replacement for \TeX{} which uses +\TeX{}-like typesetting algorithms in a very different programming +environment. \textsf{ANT} remains under development, but it is now +approaching the status of a usable typesetting system. + +\textsf{ANT}'s markup language is immediately recognisable to the +\AllTeX{} user, but the scheme of implementing design in +\textsf{ANT}'s own implementation language (presently +\ProgName{OCaml}) comes as a pleasant surprise to the jaded \acro{FAQ} +writer. This architecture holds the promise of a system that avoids a +set of serious problems with \TeX{}'s user interface: those that +derive from the design language being the same as the markup language. +\begin{ctanrefs} +\item[\textsf{ANT}]\CTANref{ant} +\end{ctanrefs} + +\Question[Q-extex]{The \ExTeX{} project} + +\href{http://www.extex.org/}{The \ExTeX{} project} is +building on the experience of the many existing \TeX{} development and +extension projects, to develop a new \TeX{}-like system. The system +is to be developed in Java (like the ill-fated \NTS{} project). + +While \ExTeX{} will implement all of \TeX{}'s primitives, some may be +marked as obsolete, and ``modern'' alternatives provided (an obvious +example is the primitive \csx{input} command, whose syntax inevitably +makes life difficult for users of modern operating system file +paths). Desirable extensions from \Qref*{\eTeX{}}{Q-etex}, +\Qref*{\PDFTeX{}}{Q-whatpdftex} and \Qref*{\ensuremath{\Omega}}{Q-omegaleph} +have been identified. + +Usability will be another focus of the work: debugging support and log +filtering mechanisms will please those who have long struggled with +\TeX{} macros. + +\ExTeX{} will accept Unicode input, from the start. In the longer +term, drawing primitives are to be considered. + +\Question[Q-biblatex]{Replacing the \BibTeX{}--\LaTeX{} mechanism} + +Producing a successor to \BibTeX{} has long been a favoured activity +among a certain class of \TeX{}-users; the author has seen reports of +progress (on several projects), over the years, but few that claim to +be ready for ``real-world'' use. + +Few would deny that \BibTeX{} is ripe for renewal: as originally +conceived, it was a program for creating bibliographies for technical +documents, in English. People have contributed mechanisms for a +degree of multilingual use (whose techniques are arcane, and quite +likely inextensible); and specialist \BibTeX{} style files are +available for use in non-technical papers. + +\BibTeX{} uses a style language whose mechanisms are unfamiliar to +most current programmers: it's difficult to learn, but since there are +few opportunities to write the language, it's also difficult to become +fluent (in the way that so many people fluently write the equally +arcane \TeX{} macro language). + +Oren Patashnik (the author of \BibTeX{}) summarises the issues as he +sees them, in a % !line break +\href{http://tug.org/TUGboat/Articles/tb24-1/patashnik.pdf}{\acro{TUG} conference paper from 2003} +that seems to suggest that we might expect a +\BibTeX{}~1.0\dots{}which hasn't (yet) appeared. + +In the absence of \BibTeX{}~1.0, what do we need from the bibliography +system of the future?~--- simple: a superset of what \BibTeX{} does +(or can be made to do), implemented in a simpler style language, with +coherent multilingual capabilities. + +Of the direct \BibTeX{} replacements, the only one whose authors have +sufficient confidence to submit to \acro{CTAN} is Cross\TeX{}. +Cross\TeX{}'s language feels familiar to the existing user of +\BibTeX{}, but it's redesigned in an object-oriented style, and looks +(to a non-user) as if it may well be adequately flexible. + +Cross\TeX{}'s team respond to queries, and seem well aware of the +need for multilingual support. Cross\TeX{} is probably a development +to watch. + +Two interesting alternative approaches, that the author has +investigated, are \Package{amsrefs} and \Package{biblatex}. +\Package{Amsrefs} does away with \BibTeX{} altogether, while +\Package{biblatex} (at least for now) makes rather limited use of +\BibTeX{}. Both are heavily dependent on \LaTeX{}'s support. + +\Package{Amsrefs} uses a transformed \extension{bib} file, which is +expressed as \LaTeX{} macros. (The package provides a \BibTeX{} style +that performs the transformation, so that a \LaTeX{} source containing +a \cmdinvoke{nocite}{*} command enables \BibTeX{} to produce a usable +\Package{amsrefs} bibliography database.) + +\Package{Amsrefs} is maintained by the AMS as part of its author +support programme, + +\Package{Biblatex} uses \BibTeX{} simply to sort the citations using +\Package{biblatex}'s own style; the style of citations and of the +bibliography itself is determined by the way your \Package{biblatex} +style has been set up. This structure eliminates the collections of +\BibTeX{} styles, at a stroke; the package comes with a basic set of +styles, and details are determined by options, set at package loading +time. The author, Philipp Lehman, evaluated the whole field of +bibliography software before starting, and as a result the package +comes with answers to many of the questions asked in the bibliography +sections of these \acro{FAQ}s. + +\Package{Biblatex} is released as experimental software, but it's +clear that many users are already using it happily; Lehman is +responsive to problem reports, at the moment, but a set of expert +users is already establishing itself. A set of contributed styles has +appeared, which cover some of the trickier bibliography styles. The +road map of the project shows one more \emph{beta} release before the +``stable'' \Package{biblatex}~1.0. + +A related project is +\href{http://biblatex-biber.sourceforge.net/}{\ProgName{biber}} +(it's called \ProgName{biblatex-biber} on SourceForge simply to +distinguish it from an older, defunct, \BibTeX{} replacement +project). \ProgName{Biber} is a \ProgName{Perl}-based system to +produce a \BibTeX{} replacement that is specifically tuned to the +requirements of \Package{biblatex}. While it supports the +`traditional' \BibTeX{} interface, \ProgName{biber} provides an +interface language designed for \Package{biblatex}, including use of +Unicode to ease the generation of multilingual citations. +\begin{ctanrefs} +\item[amsrefs.sty]\CTANref{amsrefs} +\item[biblatex.sty]\CTANref{biblatex} +\item[\nothtml{\rmfamily}biblatex contributions]\CTANref{biblatex-contrib} +\item[\nothtml{\rmfamily}CrossTeX]\CTANref{crosstex} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-support.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-support.tex new file mode 100644 index 00000000000..b482a017d7f --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-support.tex @@ -0,0 +1,148 @@ +% $Id: faq-support.tex,v 1.2 2009/07/11 12:28:34 rf10 Exp $ + +\section{Support Packages for \TeX{}} + +\Question[Q-xfigetc]{\AllTeX{}-friendly drawing packages} +\AliasQuestion{Q-xfig} +\AliasQuestion{Q-figetc} + +\ProgName{(X)Fig} is a menu driven tool that allows you to +draw objects on the screen of an \acro{X} workstation; \ProgName{transfig} +is a set of tools which translate the code \ProgName{fig}. The list +of export formats is very long, and includes \MF{} and \MP{}, +Encapsulated \PS{} and \acro{PDF}, as well as combinations that wrap +a graphics format in a \LaTeX{} import file, which may include +\LaTeX{} commands to place text (compiled by \LaTeX{} itself) as +labels, etc., in the figures. + +There's no explicit port of \ProgName{xfig} to windows (although it is +said to work under \ProgName{cygwin} with their X-windows system~--- +\href{http://www.cs.usask.ca/~wew036/latex/xfig.html}{installation advice} +is available). +However, the program % ! line break +\href{http://tech-www.informatik.uni-hamburg.de/applets/javafig/}{\ProgName{jfig}} +is thought by many to be an acceptable substitute, written in Java. + +\ProgName{Asymptote} is a widely-praised development of the \MP{} +language, which can draw 2D or 3D diagrams, and can also label +diagrams with \LaTeX{} text; copious documentation is available via +\href{http://asymptote.sourceforge.net}{\ProgName{asymptote}'s web site}. +\begin{ctanrefs} +\item[asymptote]\CTANref{asymptote} +\item[xfig]\CTANref{xfig} +\item[transfig]\CTANref{transfig} +\end{ctanrefs} + +\Question[Q-texcad]{\TeX{}\acro{CAD}, a drawing package for \LaTeX{}} + +\TeX{}\acro{CAD} is a program for the \acro{PC} which enables the user to draw diagrams +on screen using a mouse or arrow keys, with an on-screen menu of available +picture-elements. Its output is code for the \LaTeX{} +\environment{picture} environment. +Optionally, it can be set to include lines at all angles using +the em\TeX{} driver-family +\htmlignore +\csx{special}s (\Qref{}{Q-specials}). +\endhtmlignore +\begin{htmlversion} +\Qref{\csx{special}s}{Q-specials}. +\end{htmlversion} +\TeX{}\acro{CAD} is part of the em\TeX{} distribution. + +A Unix port of the program (\ProgName{xtexcad}) has been made. +\begin{ctanrefs} +\item[emtex]\CTANref{emtex} +\item[xtexcad]\CTANref{xtexcad} +\end{ctanrefs} + +\Question[Q-spell]{Spelling checkers for work with \TeX{}} + +For Unix, \ProgName{ispell} was long the program of choice; it is well +integrated with \ProgName{emacs}, and deals with some \TeX{} syntax. +However, it has more-or-less been replaced everywhere, by +\ProgName{aspell}, which was designed as a successor, and certainly +performs better on most metrics; there remains some question as to its +performance with \AllTeX{} sources. + +For Windows, there is a good spell checker incorporated into many of +the \Qref*{shell/editor}{Q-editors} combinations that are available. +The spell checker from the (now defunct) 4All\TeX{} shell remains +available as a separate package, \ProgName{4spell}. + +For the Macintosh, \ProgName{Excalibur} is the program of choice. It +will run in native mode on both sorts of Macintosh. The distribution +comes with dictionaries for several languages. + +The \acro{VMS} Pascal program \ProgName{spell} makes special cases of +some important features of \LaTeX{} syntax. + +For \MSDOS{}, there are several programs. \ProgName{Amspell} can be +called from within an editor, and \ProgName{jspell} is an extended +version of \ProgName{ispell}. +\begin{ctanrefs} +\item[4spell]\CTANref{4spell} +\item[amspell]\CTANref{amspell} +\item[aspell]Browse \CTANref{aspell}~--- choose just those language + dictionaries (under subdirectory \File{dict/}) that you need. +\item[excalibur]\CTANref{Excalibur} +\item[ispell]\CTANref{ispell} +\item[jspell]\CTANref{jspell} +\item[\nothtml{\bgroup\rmfamily}\acro{VMS}\nothtml{\egroup} spell]% + \CTANref{vmspell} +\item[winedt]\CTANref{winedt} +\end{ctanrefs} + +\Question[Q-wordcount]{How many words have you written?} + +One often has to submit a document (e.g., a paper or a dissertation) +under some sort of constraint about its size. Sensible people set a +constraint in terms of numbers of pages, but there are some that +persist in limiting the numbers of words you type. + +A simple solution to the requirement can be achieved following a +simple observation: the powers that be are unlikely to count all the +words of a document submitted to them. Therefore, a statistical +method can be employed: find how many words there are on a full page; +find how many full pages there are in the document (allowing for +displays of various sorts, this number will probably not be an +integer); multiply the two. However, if the document to be submitted +is to determine the success of the rest of one's life, it takes a +brave person to thumb their nose at authority quite so +comprehensively\dots{} + +The simplest method is to strip out the \AllTeX{} markup, and to count +what's left. On a Unix-like system, this may be done using +\ProgName{detex} and the built-in \ProgName{wc}: +\begin{verbatim} + detex <filename> | wc -w +\end{verbatim} +The \ProgName{latexcount} script does the same sort of job, in one +``step''; being a \ProgName{perl} script, it is in principle rather +easily configured (see documentation inside the script). +\ProgName{Winedt} (see \Qref[question]{editors and shells}{Q-editors}) +provides this functionality direct in the Windows environment. + +\ProgName{TeXcount} also goes a long way with heuristics for counting, +starting from a \LaTeX{} file; the documentation is comprehensive, and +you may try the script on-line via the % ! line break +\begin{wideversion} + \href{http://folk.uio.no/einarro/Comp/texwordcount.html}{package home page}. +\end{wideversion} +\begin{narrowversion} + package home page~(see + \URL{http://folk.uio.no/einarro/Comp/texwordcount.html}). +\end{narrowversion} +Even quite sophisticated stripping of \AllTeX{} markup can never be +entirely reliable, however: that markup itself may contribute typeset +words, and this could be a problem. The \Package{wordcount} package +contains a Bourne shell (i.e., typically Unix) script for running a +\LaTeX{} file with a special piece of supporting \TeX{} code, and then +counting word indications in the log file. This is probably as +accurate automatic counting as you can get, if it works for you. +\begin{ctanrefs} +\item[detex]\CTANref{detex} +\item[latexcount.pl]\CTANref{latexcount} +\item[TeXcount]\CTANref{texcount} +\item[wordcount]\CTANref{wordcount} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-symbols.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-symbols.tex new file mode 100644 index 00000000000..b08e2ab44ac --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-symbols.tex @@ -0,0 +1,511 @@ +% $Id: faq-symbols.tex,v 1.2 2009/06/30 18:44:15 rf10 Exp $ + +\section{Symbols, etc.} + +\Question[Q-usesymb]{Using symbols} + +Most symbol font sets come with a package that defines commands for +every symbol in the font. While this is convenient, it can lead to +difficulties, particularly with name clashes when you load packages +that cover fonts which duplicate symbols~--- an issue which is +discussed in +\begin{narrowversion} + \Qref[question]{}{Q-alreadydef}. +\end{narrowversion} +\begin{wideversion} + ``\Qref{symbol already defined}{Q-alreadydef}''. +\end{wideversion} +Some font sets (for example, \FontName{MnSymbol}) are huge, and the +accompanying macros cover so many symbols that name clashes are surely +a serious problem. + +The \Package{pifont} package (originally designed to use the Adobe +\FontName{Zapf Dingbats} font) avoids this sort of problem: it requires +you to know the font position of any symbol you want to use (the +documentation provides font tables). The basic command is +\cmdinvoke*{ding}{number} for a single symbol; there are commands for +other fancier uses. \Package{Pifont} also allows you to select other +fonts, for similar use. + +The \Package{yagusylo} describes itself as ``an extended version of +\Package{pifont}, gone technicolor''. It provides all the facilities +of \Package{pifont}, but allows you to create your own mnemonic names +for symbols. Thus, while you can say % ! line break +\cmdinvoke*{yagding}[family]{symbol number}[colour], you can also +define symbol names with \csx{defdingname}, and then use them +with \cmdinvoke*{yagding*}{symbol name} (the defined name carries the +font family and colour specified in the arguments of +\csx{defdingname}). + +\Package{Yagusylo} is somewhat complicated, but its documentation is +clear; it is probably the best tool to use for picking and choosing +symbols from a variety of font families. +\begin{ctanrefs} +\item[mnsymbol \nothtml{\rmfamily}fonts]\CTANref{mnsymbol} +\item[pifont.sty]Distributed as part of \CTANref{psnfss} +\item[yagusylo.sty]\CTANref{yagusylo} +\end{ctanrefs} + +\Question[Q-numbersets]{Symbols for the number sets} + +Mathematicians commonly use special lettering for the real numbers and +other standard number sets. Traditionally these were typeset in bold. +Because, in the ordinary course of events, mathematicians do not have +access to bold chalk, they invented special symbols that are now +often used for the number sets; these symbols are known as +``blackboard bold'' (or double-stroked fonts); in place of the heavier +strokes of a bold font, (some) strokes of the letters are doubled. +The minimum useful set is upper-case letters `I', `N', `R', `Q' and +`Z'; some fonts offer a figure `1' (for a unit matrix~--- not a number +set at all). + +A set of blackboard bold capitals is available in the \acro{AMS} +\FontName{msbm} fonts (\FontName{msbm} is available at a range of +design sizes, with names such as \FontName{msbm10}). The pair of font +families (the other is called \FontName{msam}) have a large number of +mathematical symbols to supplement those provided in the Knuth's +original \TeX{} distribution, and are available in Type~1 format in +modern distributions. Support files for using the fonts, both under +\plaintex{} and \LaTeX{} (packages \Package{amssymb} and +\Package{amsfonts}), are available. The font shape is a rather +austere sans, which many people don't like (though it captures the +essence of quickly-chalked writing rather well). + +The \FontName{bbold} family is set of blackboard bold fonts written in +\MF{}. This set offers blackboard bold forms of lower-case letters; +the font source directory also contains sources for a \LaTeX{} package +that enables use of the fonts. The fonts are not available in Type~1 format. + +The \FontName{bbm} family claims to provide +`blackboard' versions of most of the \FontName{cm} fonts~\dots{} including +the bold and bold-extended series. Again, the fonts are designed in +\MF{} and are not available in Type~1 format. \LaTeX{} macro support +comes from a package by Torsten Hilbrich. + +The \FontName{doublestroke} family comes in just roman +and sans shapes, at a single weight, and is available both as \MF{} +sources and as Type~1; the font covers the uppercase latin letters, +lowercase `h' and 'k', and the digit `1'. + +A document that shows the \FontName{bbm}, \FontName{bbold}, +\FontName{doublestroke} and \FontName{msbm} fonts, so that you can get +a feel for their appearance, is available (\acro{CTAN} package +\Package{blackboard}). + +An alternative source of Type~1 fonts with blackboard bold characters +may be found in the steadily increasing set of complete families, both +commercial and free, that have been prepared for use with \AllTeX{} +(see % beware line break +\htmlonly{``}\Qref[question]{choice of outline fonts}{Q-psfchoice}\htmlonly{''}). +Of the free sets, the \FontName{txfonts} and \FontName{pxfonts} families +both come with replicas of \FontName{msam} and \FontName{msbm} +(though, as noted elsewhere, there are other reasons not to use these +fonts). The \FontName{mathpazo} family includes a ``mathematically +significant'' choice of blackboard bold characters, and the +\FontName{fourier} fonts contain blackboard bold upper-case letters, +the digit `1', and lower-case `k'. + +The ``lazy person's'' blackboard bold macros: +\begin{quote} +\begin{verbatim} +\newcommand{\R}{{\textsf{R}\hspace*{-0.9ex}% + \rule{0.15ex}{1.5ex}\hspace*{0.9ex}}} +\newcommand{\N}{{\textsf{N}\hspace*{-1.0ex}% + \rule{0.15ex}{1.3ex}\hspace*{1.0ex}}} +\newcommand{\Q}{{\textsf{Q}\hspace*{-1.1ex}% + \rule{0.15ex}{1.5ex}\hspace*{1.1ex}}} +\newcommand{\C}{{\textsf{C}\hspace*{-0.9ex}% + \rule{0.15ex}{1.3ex}\hspace*{0.9ex}}} +\end{verbatim} +\end{quote} +are almost acceptable at normal size if the surrounding text is +\FontName{cmr10} (the position of the vertical bar can be affected by +the surrounding font). However, they are not part of a proper maths font, +and do not work in sub- and superscripts. As we've seen, there are +plenty of alternatives: that mythical ``lazy'' person can inevitably +do better than the macros, or anything similar using capital `I' +(which looks even worse!). Voluntary \AllTeX{} effort has redefined +the meaning of laziness (in this respect!). +\begin{ctanrefs} +\item[AMS support files]Distributed as part of \CTANref{amsfonts} +\item[AMS symbol fonts]Distributed as part of \CTANref{amsfonts} +\item[bbm fonts]\CTANref{bbm} +\item[bbm macros]\CTANref{bbm-macros} +\item[bbold fonts]\CTANref{bbold} +\item[blackboard \nothtml{\rmfamily}evaluation set]\CTANref{blackboard} +\item[doublestroke fonts]\CTANref{doublestroke} +\item[fourier fonts]\CTANref{fourier} +\item[mathpazo fonts]\CTANref{mathpazo} +\item[pxfonts]\CTANref{pxfonts} +\item[txfonts]\CTANref{txfonts} +\end{ctanrefs} + +\Question[Q-scriptfonts]{Better script fonts for maths} + +The font selected by \csx{mathcal} is the only script font `built +in'. However, there are other useful calligraphic fonts included with +modern \TeX{} distributions. +\begin{description} +\item[Euler] The \Package{eucal} package (part of most sensible \TeX{} + distributions; the fonts are part of the \acro{AMS} font set) gives + a slightly curlier font than the default. The package changes the + font that is selected by \csx{mathcal}. + + Type 1 versions of the fonts are available in the \acro{AMS} fonts + distribution. +\item[RSFS] The \Package{mathrsfs} package uses a really fancy script + font (the name stands for ``Ralph Smith's Formal Script'') which is + already part of most modern \TeX{} distributions (Type~1 versions of + the font are also provided, courtesy of Taco Hoekwater). The package + creates a new command \csx{mathscr}. +\item[Zapf Chancery] is the standard \PS{} calligraphic font. There + is no package but you can easily make it available by means of the + command +\begin{verbatim} +\DeclareMathAlphabet{\mathscr}{OT1}{pzc}% + {m}{it} +\end{verbatim} + in your preamble. You may find the font rather too big; if so, you + can use a scaled version of it like this: +\begin{verbatim} +\DeclareFontFamily{OT1}{pzc}{} +\DeclareFontShape{OT1}{pzc}{m}{it}% + {<-> s * [0.900] pzcmi7t}{} +\DeclareMathAlphabet{\mathscr}{OT1}{pzc}% + {m}{it} +\end{verbatim} + + Adobe Zapf Chancery (which the above examples use) is distributed in + any but the most basic \PS{} printers. A substantially identical + font (to the extent that the same metrics may be used) is + available from \acro{URW}, called URW Chancery L: it is distributed + with Ghostscript, and as part of the ``URW base35'' bundle, which is + available in most distributions. +\end{description} +Examples of the available styles are available on \acro{CTAN}. +\begin{ctanrefs} +\item[eucal.sty]Distributed as part of \CTANref{amsfonts} +\item[euler fonts]Distributed as part of \CTANref{amsfonts} +\item[ghostscript]Browse \CTANref{ghostscript} +\item[mathrsfs.sty]Distributed as part of \CTANref{jknappen-macros} +\item[rsfs fonts]\CTANref{rsfs} +\item[Script font examples]\CTANref{mathscript} +\item[URW Chancery L]Distributed as part of \CTANref{urw-base35} +\end{ctanrefs} + +\Question[Q-boldgreek]{Setting bold Greek letters in \LaTeX{}} + +The issue here is complicated by the fact that \csx{mathbf} (the +command for setting bold \emph{text} in \TeX{} maths) affects a select +few mathematical symbols (the uppercase Greek letters). However +lower-case Greek letters behave differently from upper-case Greek +letters (due to Knuth's esoteric font encoding decisions). However, +\csx{mathbf} \emph{can't} be used even for upper-case Greek letters in +the \AMSLaTeX{} \Package{amsmath} package, which +disables this font-switching and you must use one of the techniques +outlined below. + +The \plaintex{} solution \emph{does} work, in a limited way: +\begin{quote} +\begin{verbatim} +{\boldmath$\theta$} +\end{verbatim} +\end{quote} +but \csx{boldmath} may not be used in maths mode, so this `solution' +requires arcana such as: +\begin{quote} +\begin{verbatim} +$... \mbox{\boldmath$\theta$} ...$ +\end{verbatim} +\end{quote} +which then causes problems in superscripts, etc. + +These problems may be addressed by using a bold mathematics package. +\begin{itemize} +\item The \Package{bm} package, which is part of the \LaTeX{} tools + distribution, defines a command \csx{bm} which may be used anywhere + in maths mode. +\item The \Package{amsbsy} package (which is part of \AMSLaTeX{}) + defines a command \csx{boldsymbol}, which (though slightly less + comprehensive than \csx{bm}) covers almost all common cases. +\end{itemize} + +All these solutions cover all mathematical symbols, not merely Greek +letters. +\begin{ctanrefs} +\item[bm.sty]Distributed as part of \CTANref{2etools} +\item[amsbsy.sty]Distributed as part of \AMSLaTeX{} \CTANref{amslatex} +\item[amsmath.sty]Distributed as part of \AMSLaTeX{} + \CTANref{amslatex} +\end{ctanrefs} + +\Question[Q-prinvalint]{The Principal Value Integral symbol} + +This symbol (an integral sign, `crossed') does not appear in any of +the fonts ordinarily available to \AllTeX{} users, but it can be +created by use of the following macros: +\begin{wideversion} +\begin{verbatim} +\def\Xint#1{\mathchoice + {\XXint\displaystyle\textstyle{#1}}% + {\XXint\textstyle\scriptstyle{#1}}% + {\XXint\scriptstyle\scriptscriptstyle{#1}}% + {\XXint\scriptscriptstyle\scriptscriptstyle{#1}}% + \!\int} +\def\XXint#1#2#3{{\setbox0=\hbox{$#1{#2#3}{\int}$} + \vcenter{\hbox{$#2#3$}}\kern-.5\wd0}} +\def\ddashint{\Xint=} +\def\dashint{\Xint-} +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\def\Xint#1{\mathchoice + {\XXint\displaystyle\textstyle{#1}}% + {\XXint\textstyle\scriptstyle{#1}}% + {\XXint\scriptstyle\scriptscriptstyle{#1}}% + {\XXint\scriptscriptstyle + \scriptscriptstyle{#1}}% + \!\int} +\def\XXint#1#2#3{{% + \setbox0=\hbox{$#1{#2#3}{\int}$} + \vcenter{\hbox{$#2#3$}}\kern-.5\wd0}} +\def\ddashint{\Xint=} +\def\dashint{\Xint-} +\end{verbatim} +\end{narrowversion} +\csx{dashint} gives a single-dashed integral sign, \csx{ddashint} a +double-dashed one. + +\Question[Q-underscore]{How to use the underscore character} + +The underscore character `\texttt{\_}' is ordinarily used in +\TeX{} to indicate a subscript in maths mode; if you type +\texttt{\_}, on its own, in the course of ordinary text, \TeX{} will +complain. If you're writing a document which will contain a large +number of underscore characters, the prospect of typing +\csx{\_} (or, worse, \csx{textunderscore}) for every one of +them will daunt most ordinary people. + +Moderately skilled macro programmers can readily generate a quick hack +to permit typing `\texttt{\_}' to mean `text underscore'. +However, the code \emph{is} somewhat tricky, and more importantly +there are significant points where it's easy to get it wrong. There +is therefore a package \Package{underscore} which provides a general +solution to this requirement. + +There is a problem, though: \acro{OT}1 text fonts don't contain an +underscore character, unless they're in the typewriter version of the +encoding (used by fixed-width fonts such as \texttt{cmtt}). So either +you must ensure that your underscore characters only occur in text set +in a typewriter font, or you must use a more modern encoding, such as +\acro{T}1, which has the same layout for every font, and thus an +underscore in every font. + +If the requirement is only for occasional uses of underscores, it may +be acceptable to use the following construct: +\begin{quote} +\begin{verbatim} +\def\us{\char`\_} +... +\texttt{create\us process} +\end{verbatim} +\end{quote} +The construction isn't in the least robust (in the normal English +sense of the word), but it \emph{is} robust under expansion (i.e., the +\LaTeX{} sense of the word); so use it with care, but don't worry +about section headings and the like. +\begin{ctanrefs} +\item[underscore.sty]\CTANref{underscore} +\end{ctanrefs} + +\Question[Q-atsign]{How to type an `@' sign?} + +Long ago, some packages used to use the `@' sign as a command, so that +special measures were needed to type it. While those packages are +still in principle available, few people use them, and those that do +use them have ready access to rather good documentation. + +Ordinary people (such as the author of this \acro{FAQ}) need only type +`@'. + +\Question[Q-euro]{Typesetting the Euro sign} + +The European currency ``Euro'' is represented by a symbol of somewhat +dubious design, but it's an important currency and \AllTeX{} users +need to typeset it. + +Note that the Commission of the European Community at first deemed +that the Euro symbol should always be set in a sans-serif font; +fortunately, this eccentric ruling has now been rescinded, and one may +apply best typesetting efforts to making it appear at least slightly +``respectable'' (typographically). + +The \acro{TS}1-encoded \acro{TC} fonts provided as part of the \acro{EC} font +distribution provide Euro glyphs. The fonts are called Text Companion +(\acro{TC}) fonts, and offer the same range +of faces as do the \acro{EC} fonts themselves. The +\Package{textcomp} package provides a \csx{texteuro} command for +accessing the symbol, which selects a symbol to match the surrounding +text. The design of the symbol in the \acro{TC} fonts is not +universally loved\dots{} +Nevertheless, use the \acro{TC} font version of the symbol if you are +producing documents using Knuth's Computer Modern Fonts. + +The \Package{latin9} input encoding defined by the \Package{inputenc} +package has a euro character defined (character position 164, occupied +in other \acro{ISO} Latin character sets by the ``currency symbol''). +The encoding uses the command \csx{texteuro} for the character; at +present that command is \emph{only} available from the +\Package{textcomp} package. There is a Microsoft code page position, +too, but standardisation of such things proceeds via rather different +routes and the \LaTeX{} project hasn't yet been given details of the +change. + +Outline fonts which contain nothing but Euro symbols are available +(free) from +\href{ftp://ftp.adobe.com/pub/adobe/type/win/all/eurofont.exe}{Adobe}\nobreakspace--- +the file is packaged as a \ProgName{Windows} self-extracting +executable, but it may be decoded as a \extension{zip} format archive +on other operating systems. +The \Package{euro} bundle contains metrics, \ProgName{dvips} map +files, and macros (for \plaintex{} and \LaTeX{}), for using these +fonts in documents. \LaTeX{} users will find two packages in the +bundle: \Package{eurosans} only offers the sans-serif version (to +conform with the obsolete ruling about sans-serif-only symbols; the +package provides the +command \csx{euro}), whereas \Package{europs} matches the Euro symbol +with the surrounding text (providing the command \csx{EUR}). To use +either package +with the \Package{latin9} encoding, you need to define \csx{texteuro} +as an alias for the euro command the package defines. + +The Adobe fonts are probably the best bet for use in non-Computer +Modern environments. They are apparently designed to fit with Adobe +Times, Helvetica and Courier, but can probably fit with a wider range +of modern fonts. + +The \Package{eurofont} package provides a compendious analysis of the +``problem of the euro symbol'' in its documentation, and offers macros +for configuring the source of the glyphs to be used; however, it seems +rather large for everyday use. + +The \Package{euro-ce} bundle is a rather pleasing \MF{}-only design +providing Euro symbols in a number of shapes. The file +\File{euro-ce.tex}, in the distribution, offers hints as to how a +\plaintex{} user might make use of the fonts. + +Euro symbols are found in several other places, which we list here for +completeness. + +The \Package{marvosym} fonts contain a Euro symbol among many other +good things. +%% ; the font on \acro{CTAN} is not Adobe \ProgName{ATM} +%% compatible, but a compatible version is available free from +%% \href{http://www.YandY.com/download/marvosym.zip}{\YandY{}}. The font +%% on \acro{CTAN} comes with a set of macros to typeset all the symbols +%% it contains. + +Other \MF{}-based bundles containing Euro symbols are to be found in +\Package{china2e} (whose primary aim is Chinese dates and suchlike +matters) and the \Package{eurosym} fonts. +\begin{ctanrefs} +\item[china2e bundle]\CTANref{china2e} +\item[EC fonts]\CTANref{ec} +\item[euro fonts]\CTANref{euro-fonts} +\item[euro-ce fonts]\CTANref{euro-ce} +\item[eurofont.sty]\CTANref{eurofont} +\item[eurosym fonts]\CTANref{eurosym} +\item[marvosym fonts]\CTANref{marvosym-fonts} +\item[textcomp.sty]Part of the \LaTeX{} distribution. +\end{ctanrefs} + +\Question[Q-tradesyms]{How to get copyright, trademark, etc.} + +The ``\nothtml{Comprehensive symbol list'' (}% beware line break +\Qref{Comprehensive symbol list}{Q-symbols}\latexhtml{)}{''}, lists +the symbol commands \csx{textcopyright}, +\csx{textregistered} and \csx{texttrademark}, which are available in +\acro{TS}1-encoded fonts, and which are enabled using the +\Package{textcomp} package. + +In fact, all three commands are enabled in default \LaTeX{}, but the +glyphs you get aren't terribly beautiful. In particular, +\csx{textregistered} behaves oddly when included in bold text (for +example, in a section heading), since it is composed of a small-caps +letter, which typically degrades to a regular shape letter when asked +to set in a bold font. This means that the glyph becomes a circled +``r'', whereas the proper symbol is a circled ``R''. + +This effect is of course avoided by use of \Package{textcomp}. + +Another problem arises if you want \csx{textregistered} in a +superscript position (to look similar to \csx{texttrademark}). +Using a maths-mode superscript to do this provokes lots of pointless +errors: you \emph{must} use +\begin{quote} +\begin{verbatim} +\textsuperscript{\textregistered} +\end{verbatim} +\end{quote} + +\Question[Q-osf]{Using ``old-style'' figures} + +These numbers are also called medieval or lowercase figures and their +use is mostly font-specific. Terminology is confusing since the +lining figures (which are now the default) are a relatively recent +development (19th century) and before they arrived, oldstyle figures +were the norm, even when setting mathematics. (An example is Thomas +Harriot's \emph{Artis Analyticae Praxis} published in 1631). In a +typical old style 3, 4, 5, 7 and 9 have descenders and 6 and 8 ascend +above the x-height; sometimes 2 will also ascend (this last seems to +be a variation associated with French typography). + +\LaTeX{} provides a command \cmdinvoke*{oldstylenums}{digits}, which +by default uses an old-style set embedded in Knuth's `math italic' +font. The command isn't sensitive to the font style of surrounding +text: the glyphs are only available to match the normal medium weight +Computer Modern Roman fonts. + +The \Package{textcomp} package changes \csx{oldstylenums} to use the +glyphs in the Text Companion fonts (\LaTeX{} \acro{TS}1 encoding) when +in text mode, and also makes them available using the macros of the +form \csx{text<number>oldstyle}, e.g., \csx{textzerooldstyle}. +(Of course, not all font families can provide this facility.) + +Some font packages (e.g., \Package{mathpazo}) make old-style figures +available and provide explicit support for making them the default: +\cmdinvoke{usepackage}[osf]{mathpazo} selects a form where digits are +always old-style in text. The \Package{fontinst} package will +automatically generate ``old-style versions'' of commercial Adobe Type +1 font families for which ``expert'' sets are available. + +It's also possible to make virtual fonts, that offer old-style digits, +from existing font packages. The \FontName{cmolddig} bundle provides +a such a virtual version of Knuth's originals, and the \FontName{eco} +or \FontName{hfoldsty} bundles both provide versions of the \acro{EC} +fonts. The \FontName{lm} family offers old-style figures to OpenType +users (see below), but we have no stable mapping for \FontName{lm} +with old-style digits from the Adobe Type 1 versions of the fonts. + +Originally, oldstyle figures were only to be found the expert sets of +commercial fonts, but now they are increasingly widely available. An +example is Matthew Carter's Georgia font, which has old-style figures +as its normal form (the font was created for inclusion with certain +Microsoft products and is intended for on-screen viewing). + +OpenType fonts have a pair of axes for number variations~--- +proportional/tabular and lining/oldstyle selections are commonly +available. ``Full feature access'' to OpenType fonts, making such +options available to the \AllTeX{} user, is already supported by +\Qref*{\xetex{}}{Q-xetex} using, for example, the \Package{fontspec} +package. Similar support is also in the works for +\Qref*{\LuaTeX{}}{Q-luatex}. +\begin{ctanrefs} +\item[cmolddig \nothtml{\rmfamily}fonts]\CTANref{cmolddig} +\item[eco \nothtml{\rmfamily}fonts]\CTANref{eco} +\item[fontinst]\CTANref{fontinst} +\item[fontspec.sty]\CTANref{fontspec} +\item[mathpazo \nothtml{\rmfamily}fonts]\CTANref{mathpazo} +\end{ctanrefs} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-t-g-wr.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-t-g-wr.tex new file mode 100644 index 00000000000..935869ad543 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-t-g-wr.tex @@ -0,0 +1,367 @@ +% $Id: faq-t-g-wr.tex,v 1.2 2009/06/30 18:44:15 rf10 Exp $ + +\section{Things are Going Wrong\dots{}} + +\subsection{Getting things to fit} +\Question[Q-enlarge]{Enlarging \TeX{}} + +The \TeX{} error message `capacity exceeded' covers a multitude of +problems. What has been exhausted is listed in brackets after the +error message itself, as in: +\begin{quote} +\begin{verbatim} +! TeX capacity exceeded, sorry +... [main memory size=263001]. +\end{verbatim} +\end{quote} +Most of the time this error can be fixed +\emph{without} enlarging \TeX{}. The most common causes are unmatched braces, +extra-long lines, and poorly-written macros. Extra-long lines are +often introduced when files are transferred incorrectly between +operating systems, and line-endings are not preserved properly (the +tell-tale sign of an extra-long line error is the complaint +that the `|buf_size|' has overflowed). + +If you really need to extend your \TeX{}'s capacity, the proper method +depends on your installation. There is no need (with modern \TeX{} +implementations) to change the defaults in Knuth's \acro{WEB} source; +but if you do need to do so, use a change file to modify the values set in +module 11, recompile your \TeX{} and regenerate all format files. + +Modern implementations allow the sizes of the various bits of \TeX{}'s +memory to be changed semi-dynamically. Some (such as em\TeX{}) allow +the memory parameters to be changed in command-line switches when +\TeX{} is started; most frequently, a configuration file is read which +specifies the size of the memory. On \ProgName{web2c}-based systems, +this file is called \File{texmf.cnf}: see the documentation that comes +with the distribution for other implementations. Almost invariably, +after such a change, the format files need to be regenerated after +changing the memory parameters. + +\Question[Q-usepictex]{Why can't I load \PiCTeX{}?} + +\PiCTeX{} is a resource hog; fortunately, most modern \TeX{} +implementations offer generous amounts of space, and most modern +computers are pretty fast, so users aren't too badly affected by its +performance. + +However, \PiCTeX{} has the further unfortunate tendency to fill up +\TeX{}'s fixed-size arrays~--- notably the array of 256 `dimension' +registers. This is a particular problem when you're using +\File{pictex.sty} with \LaTeX{} and some other packages that also need +dimension registers. When this happens, you will see the \TeX{} error +message: +\begin{quote} +\begin{verbatim} +! No room for a new \dimen. +\end{verbatim} +\end{quote} +There is nothing that can directly be done about this error: you +can't extend the number of available \csx{dimen} registers without +extending \TeX{} itself. +\begin{wideversion} % hyper + \Qref{\eTeX{}}{Q-etex} and \Qref{Omega}{Q-omegaleph} both do this, as + does \Qref{MicroPress Inc's V\TeX{}}{Q-commercial}. +\end{wideversion} +\begin{narrowversion} + \eTeX{} and \ensuremath{\Omega}~--- \Qref[see questions]{}{Q-etex} + \Qref[and]{}{Q-omegaleph} respectively~--- both do this, as does + MicroPress Inc's V\TeX{}~--- \Qref{}{Q-commercial}. +\end{narrowversion} + +It's actually quite practical (with most modern distributions) to use +\eTeX{}'s extended register set: use package \Package{etex} (which +comes with \eTeX{} distributions) and the allocation mechanism is +altered to cope with the larger register set: \PiCTeX{} will now load. + +If you're in some situation where you can't use \eTeX{}, you need to change +\PiCTeX{}; unfortunately \PiCTeX{}'s author is no longer active in the +\TeX{} world, so one must resort to patching. There are two solutions +available. + +The \CONTeXT{} module \File{m-pictex.tex} (for \plaintex{} and +variants) or the corresponding \LaTeX{} \Package{m-pictex} package provide +an ingenious solution to the problem based on hacking the code of +\csx{newdimen} itself. + +Alternatively, Andreas Schell's \Package{pictexwd} and related +packages replace \PiCTeX{} with a version that uses 33 fewer +\csx{dimen} registers; so use \Package{pictexwd} in place of +\Package{pictex} (either as a \LaTeX{} package, or as a file to read +into \plaintex{}). + +And how does one use \PiCTeX{} anyway, given that the +manual is so \Qref*{hard to come by}{Q-docpictex}? +Fortunately for us all, the \ProgName{MathsPic} +system may be used to translate a somewhat different language into +\PiCTeX{} commands; and the \ProgName{MathsPic} manual is free (and +part of the distribution). \ProgName{MathsPic} is available either as +a \ProgName{Basic} program for \acro{DOS}, or as a \ProgName{Perl} +program for other systems (including Windows, nowadays). +\begin{ctanrefs} +\item[m-pictex.sty]Distributed as part of \CTANref{context-tmf} +\item[m-pictex.tex]Distributed as part of \CTANref{context-tmf} +\item[MathsPic]\CTANref{mathspic} +\item[pictexwd.sty]Distributed as part of \CTANref{pictex-addon} +\end{ctanrefs} + +\subsection{Making things stay where you want them} + +\Question[Q-floats]{Moving tables and figures in \LaTeX{}} + +Tables and figures have a tendency to surprise, by \emph{floating} +away from where they were specified to appear. This is in fact +perfectly ordinary document design; any professional typesetting +package will float figures and tables to where they'll fit without +violating the certain typographic rules. Even if you use the +placement specifier~\texttt{h} for `here', the figure or table will not be +printed `here' if doing so would break the rules; the rules themselves +are pretty simple, and are given on page~198, section~C.9 of the +\LaTeX{} manual. In the worst case, \LaTeX{}'s rules can cause the +floating items to pile up to the extent that you get an error message +saying \Qref*{``Too many unprocessed floats''}{Q-tmupfl}. +What follows is a simple checklist of things to do to solve these +problems (the checklist talks throughout about figures, but applies +equally well to tables, or to ``non-standard'' floats defined by the +\Package{float} or other packages). +\begin{itemize} +\item Do your figures need to float at all? If not, look at the + recommendations for ``\Qref*{non-floating floats}{Q-figurehere}'' +\item Are the placement parameters on your figures right? The + default (\texttt{tbp}) is reasonable, but you can reasonably change it (for + example, to add an \texttt{h}). Whatever you do, \emph{don't} + omit the `\texttt{p}': doing so could cause \LaTeX{} to believe that if you + can't have your figure \emph{here}, you don't want it + \emph{anywhere}. (\LaTeX{} does try hard to avoid being confused in + this way\dots{}) +\item \LaTeX{}'s own float placement parameters could be preventing + placements that seem entirely ``reasonable'' to you~--- they're + notoriously rather conservative. To encourage \LaTeX{} not to move + your figure, you need to loosen its demands. (The most important + ones are the ratio of text to float on a given page, but it's + sensible to have a fixed set that changes the whole lot, to meet + every eventuality.) +\begin{verbatim} +\renewcommand{\topfraction}{.85} +\renewcommand{\bottomfraction}{.7} +\renewcommand{\textfraction}{.15} +\renewcommand{\floatpagefraction}{.66} +\renewcommand{\dbltopfraction}{.66} +\renewcommand{\dblfloatpagefraction}{.66} +\setcounter{topnumber}{9} +\setcounter{bottomnumber}{9} +\setcounter{totalnumber}{20} +\setcounter{dbltopnumber}{9} +\end{verbatim} + The meanings of these + parameters are described on pages~199--200, section~C.9 of the + \LaTeX{} manual. +\item Are there places in your document where you could `naturally' + put a \csx{clearpage} command? If so, do: the backlog of floats is + cleared after a \csx{clearpage}. (Note that the \csx{chapter} + command in the standard \Class{book} and \Class{report} classes + implicitly executes \csx{clearpage}, so you can't float past + the end of a chapter.) +\item Try the \Package{placeins} package: it defines a + \csx{FloatBarrier} command beyond which floats may not pass. A + package option allows you to declare that floats may not pass a + \csx{section} command, but you can place \csx{FloatBarrier}s wherever + you choose. +\item If you are bothered by floats appearing at the top of the page + (before they are specified in your text), try the \Package{flafter} + package, which avoids this problem by insisting that floats should + always appear after their definition. +\item Have a look at the \LaTeXe{} \Package{afterpage} package. + Its documentation gives as an example the idea + of putting \csx{clearpage} \emph{after} the current page (where it + will clear the backlog, but not cause an ugly gap in your text), but + also admits that the package is somewhat fragile. Use it as a last + resort if the other possibilities below don't help. +\item If you would actually \emph{like} great blocks of floats at the + end of each of your chapters, try the \Package{morefloats} package; + this `simply' increases the number of floating inserts that \LaTeX{} + can handle at one time (from~18 to~36). +\item If you actually \emph{wanted} all your figures to float to the + end (\emph{e.g}., for submitting a draft copy of a paper), don't + rely on \LaTeX{}'s mechanism: get the \Package{endfloat} package to do + the job for you. +\end{itemize} +\begin{ctanrefs} +\item[afterpage.sty]Distributed as part of \CTANref{2etools} +\item[endfloat.sty]\CTANref{endfloat} +\item[flafter.sty]Part of the \LaTeX{} distribution +\item[float.sty]\CTANref{float} +\item[morefloats.sty]\CTANref{morefloats} +\item[placeins.sty]\CTANref{placeins} +\end{ctanrefs} + +\Question[Q-underline]{Underlined text won't break} + +Knuth made no provision for underlining text: he took the view that +underlining is not a typesetting operation, but rather one that +provides emphasis on typewriters, which typically offer but one +typeface. The corresponding technique in typeset text is to switch +from upright to italic text (or vice-versa): the \LaTeX{} command +\csx{emph} does just that to its argument. + +Nevertheless, typographically illiterate people (such as those that +specify double-spaced +\nothtml{thesis styles~--- }\Qref{thesis styles}{Q-linespace}) +continue to require underlining of us, so \LaTeX{} as distributed +defines an \csx{underline} command that applies the mathematical +`underbar' operation to text. This technique is not entirely +satisfactory, however: the text gets stuck into a box, and won't break +at line end. + +Two packages are available that solve this problem. The +\Package{ulem} package redefines the +\csx{emph} command to underline its argument; the underlined text thus +produced behaves as ordinary emphasised text, and will break over the +end of a line. (The package is capable of other peculiar effects, +too: read its documentation, contained within the file itself.) +The \Package{soul} package defines an \csx{ul} command (after which the +package is, in part, named) that underlines running text. + +Beware of \Package{ulem}'s default behaviour, which is to convert the +\csx{emph} command into an underlining command; this can be avoided by +loading the package with: +\begin{verbatim} + \usepackage[normalem]{ulem} +\end{verbatim} +Documentation of \Package{ulem} is in the package itself. +\begin{ctanrefs} +\item[ulem.sty]\CTANref{ulem} +\item[soul.sty]\CTANref{soul} +\end{ctanrefs} + +\Question[Q-widows]{Controlling widows and orphans} + +Widows (the last line of a paragraph at the start of a page) and +orphans (the first line of paragraph at the end of a page) interrupt +the reader's flow, and are generally considered ``bad form''; +\AllTeX{} takes some precautions to avoid them, but completely +automatic prevention is often impossible. If you are typesetting your +own text, consider whether you can bring yourself to change the +wording slightly so that the page break will fall differently. + +The page maker, when forming a page, takes account of +\csx{widowpenalty} and \csx{clubpenalty} (which relates to orphans!). +These penalties are usually set to the moderate value of \texttt{150}; this +offers mild discouragement of bad breaks. You can increase the values +by saying (for example) \csx{widowpenalty}\texttt{=500}; however, vertical +lists (such as pages are made of) typically have rather little +stretchability or shrinkability, so if the page maker has to balance +the effect of stretching the unstretchable and being penalised, the +penalty will seldom win. Therefore, for typical layouts, there are +only two sensible settings for the penalties: finite (150 or 500, it +doesn't matter which) to allow widows and orphans, and infinite (10000 +or greater) to forbid them. + +The problem can be avoided by allowing +the pagemaker to run pages short, by using the \csx{raggedbottom} +directive; however, many publishers insist on the default +\csx{flushbottom}; it is seldom acceptable to introduce stretchability +into the vertical list, except at points (such as section headings) +where the document design explicitly permits it. + +Once you've exhausted the automatic measures, and have a final draft +you want to ``polish'', you should proceed to manual measures. To +get rid of an orphan is simple: precede the paragraph with +\csx{clearpage} and the paragraph can't start in the wrong place. + +Getting rid of a widow can be more tricky. If the paragraph is a long +one, it may be possible to set it `tight': say \csx{looseness}\texttt{=-1} +immediately after the last word of the paragraph. If that doesn't +work, try adjusting the page size: +\cmdinvoke{enlargethispage}{\csx{baselineskip}} may do the job, and +get the whole paragraph on one page. Reducing the size of the page by +\cmdinvoke{enlargethispage}{-\csx{baselineskip}} may produce a +(more-or-less) acceptable ``two-line widow''. (Note: +\csx{looseness}\texttt{=1}, +increasing the line length by one, seldom seems to work~--- the looser +paragraph typically has a one-word final line, which doesn't look much +better than the straight widow.) + +\subsection{Things have ``gone away''} + +\Question[Q-oldfontnames]{Old \LaTeX{} font references such as \csx{tenrm}} + +\LaTeXo{} defined a large set of commands for access to the fonts +that it had built in to itself. For example, various flavours of +|cmr| could be found as \csx{fivrm}, \csx{sixrm}, \csx{sevrm}, +\csx{egtrm}, \csx{ninrm}, \csx{tenrm}, \csx{elvrm}, \csx{twlrm}, +\csx{frtnrm}, \csx{svtnrm}, \csx{twtyrm} and \csx{twfvrm}. +These commands were never documented, but certain packages +nevertheless used them to achieve effects they needed. + +Since the commands weren't public, they weren't included in \LaTeXe{}; +to use the unconverted \LaTeXo{} packages under \LaTeXe{}, you need +also to include the \Package{rawfonts} package (which is part of the +\LaTeXe{} distribution). + +\Question[Q-misssymb]{Missing symbol commands} + +You're processing an old document, and some symbol commands such as +\csx{Box} and \csx{lhd} appear no longer to exist. These commands were +present in the core of \LaTeXo{}, but are not in current \LaTeX{}. +They are available in the \Package{latexsym} package (which is part of +the \LaTeX{} distribution), and in the \Package{amsfonts} package +(which is part of the \acro{AMS} distribution, and requires \acro{AMS} +symbol fonts). +\begin{ctanrefs} +\item[AMS fonts]\CTANref{amsfonts} +\end{ctanrefs} + +\Question[Q-msxy]{Where are the \texttt{msx} and \texttt{msy} fonts?} + +The \FontName{msx} and \FontName{msy} fonts were designed by the +American Mathematical Society in the very early days of \TeX{}, for +use in typesetting papers for mathematical journals. They were +designed using the `old' \MF{}, which wasn't portable and is no longer +available; for a long time they were only available in 300dpi versions +which only imperfectly matched modern printers. The \acro{AMS} has +now redesigned the fonts, using the current version of \MF{}, and the +new versions are called the \FontName{msa} and \FontName{msb} +families. + +Nevertheless, \FontName{msx} and \FontName{msy} continue to turn up to +plague us. There are, of course, still sites that haven't got around +to upgrading; but, even if everyone upgraded, there would still be the +problem of old documents that specify them. + +If you have a \extension{tex} source that requests \FontName{msx} and +\FontName{msy}, the best technique is to edit it so that it requests +\FontName{msa} and \FontName{msb} (you only need to change the single +letter in the font names). + +If you have a \acro{DVI} file that requests the fonts, there is a package +of \Qref*{virtual fonts}{Q-virtualfonts} to map the old to the new series. +\begin{ctanrefs} +\item[msa and msb fonts]Distributed as part of \CTANref{amsfonts} +\item[virtual font set]\CTANref{msx2msa} +\end{ctanrefs} + +%%%???%%% spell-checked to here....zzzyx + +\Question[Q-amfonts]{Where are the \texttt{am} fonts?} + +One \emph{still} occasionally comes across a request for the \FontName{am} +series of fonts. The initials stood for `Almost [Computer] Modern', +and they were the predecessors of the Computer Modern fonts that we +all know and love (or hate)% +\begin{footnoteenv} + The fonts acquired their label `Almost' following the realisation + that their first implementation in \MF{}79 still wasn't quite right; + Knuth's original intention had been that they were the final answer. +\end{footnoteenv}. +There's not a lot one can do with these +fonts; they are (as their name implies) almost (but not quite) the +same as the \FontName{cm} series; if you're faced with a document that requests +them, all you can reasonably do is to edit the document. The +appearance of \acro{DVI} files that request them is sufficiently rare that +no-one has undertaken the mammoth task of creating a translation of +them by means of virtual fonts; however, most drivers let you have a +configuration file in which you can specify font substitutions. If you +specify that every \FontName{am} font should be replaced by its corresponding +\FontName{cm} font, the output should be almost correct. + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-texsys.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-texsys.tex new file mode 100644 index 00000000000..04e502e3222 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-texsys.tex @@ -0,0 +1,513 @@ +% $Id: faq-texsys.tex,v 1.1 2009/06/13 20:56:37 rf10 Exp rf10 $ + +\section{\TeX{} Systems} + +\Question[Q-TeXsystems]{\AllTeX{} for different machines} +\keywords{windows,macintosh,macos,ms-dos,os/2,unix,linux} + +We list here the free or shareware packages; +\htmlignore +see \Qref{}{Q-commercial} for details of commercial packages. +\endhtmlignore +\begin{htmlversion} + another question addresses + \Qref{commercial \TeX{} vendors'}{Q-commercial} products. +\end{htmlversion} +\begin{description} +\item[Unix] The only current distribution of \TeX{} for Unix systems + (including \acro{GNU}/Linux and other free Unix-like systems) is + \texlive{}, which is distributed as part of the % ! line break + \Qref*{\TeX{} collection}{Q-CD}. + + Members of many \TeX{} user groups receive copies of the collection + (on \acro{DVD}), as part of their membership of the groups. + + MacOS/X is also a Unix-based system; however users should refer to + the information below, under item ``Mac''. + + \texlive{} may also be installed ``over the network''; a network + installer is provided, and once you have a system, a manager + (\ProgName{tlmgr}) can both keep your installation up-to-date and + add packages you didn't install at first. + + \begin{ctanrefs} + \item[texlive]Browse \CTANref{texlive} + \item[texlive installer (Unix)]\CTANref{texlive-unix} + \end{ctanrefs} +\item[Linux] GNU/Linux users are supported by \texlive{} (as noted + above). + + A free version of the commercial + \Qref*{V\TeX{} extended \TeX{} system}{Q-commercial} is available + for use under Linux, which among other things specialises in direct + production of \acro{PDF} from \AllTeX{} input. Sadly, it's no + longer supported, and the ready-built images are made for use with a + rather ancient Linux kernel. + + For the future, the \miktex{} developer intends to release a version + of that excellent (Windows) system for use on Linux; a beta version + is available via \href{http://miktex.org/unx/}{the \miktex{} site}. + \begin{ctanrefs} + \item[texlive]Browse \CTANref{texlive} + \item[vtex]\CTANref{vtex-linux} + \item[vtex \nothtml{\rmfamily}required common files]\CTANref{vtex-common} + \end{ctanrefs} +\item[\acro{PC}: Windows] + \miktex{}, by Christian Schenk, is a comprehensive distribution. It has + its own previewer, \acro{YAP}, which is itself capable of printing, + though the distribution also includes a port of \ProgName{dvips}. + The current version is available for file-by-file download (the + \acro{HTML} files in the directory offer hints on what you need to + get going). \miktex{} can automatically install packages that it + ``knows about'', but that aren't in your system (it gets them over + the network). Furthermore, users may keep their installation + up-to-date, over the network: the distribution contains a ``package + manager'', through which the user may select individual packages, or + request that every extant update be retrieved. + + \miktex{} may also be used in a configuration which involves no + installation at all: its ``portable'' distribution may be unpacked + on a memory stick, and used on any windows computer without making + any direct use of the hard drive. This is the first ``official'' + release of such a setup, though a similar object has been available + on the net for some time. + + The \miktex{} developers also provide a ready-to-run copy of the + distribution, on \acro{CD} (for purchase) via the % ! line break + \href{http://www.miktex.org/cd/}{\miktex{} web site}; otherwise the + \File{setup} executable is available on \acro{CTAN}, together with + all the optional packages. + + \href{http://tug.org/protext/}{Pro\TeX{}t}, part of the \TeX{} + collection by Thomas Feuerstack, is + a further option for installing \miktex{}. It bundles a \miktex{} + setup with some further useful utilities, together with a \acro{PDF} + file which contains clickable links for the various installation + steps, along with explanations. + + Windows users are also supported directly by the \texlive{} + distribution; a system is provided on the installation disc of the + \TeX{} collection. The system may also be installed over the + network, using an installer application tailored for use with Windows. + + \href{http://foundry.supelec.fr/projects/xemtex/}{XEm\TeX{}}, by + Fabrice Popineau (he who created the excellent, but now defunct, + fp\TeX{} distribution), is an integrated distribution of \TeX{}, \LaTeX{}, + \CONTeXT{}, \ProgName{XEmacs} and friends for Windows. All programs + have been compiled natively to take the best advantage of the + Windows environment. Configuration is provided so that the + resulting set of programs runs out-of-the-box. + + The (Japanese) \acro{W}32\acro{TEX} distribution was motivated by + the needs of Japanese users (Japanese won't fit in a ``simple'' + character set like \acro{ASCII}, but \TeX{} is based on a version of + \acro{ASCII}). Despite its origins, \acro{W}32\acro{TEX} is said to + be a good bet for Western users, notably those whose disks are short + of space: the minimum documented download is as small as + 95\,MBytes. Investigate the distribution at + \URL{http://www.fsci.fuk.kindai.ac.jp/kakuto/win32-ptex/web2c75-e.html} + + A further (free) option arises from the + \href{http://www.cygwin.com}{CygWin bundle}, which presents a + Unix-like environment over the Win32 interface; an X-windows server + is available. If you run CygWin on your Windows machine, you have + the option of using \texlive{}, too (you will need the X-server, to + run \ProgName{xdvi}). Of course, \texlive{} components will look like + Unix applications (of course, that's presumably what you wanted), + but \TeX{} under CygWin also reputedly somewhat slower than native + Win32 implementations such as \miktex{} or XEm\TeX{}. The (now + obsolete) te\TeX{} distribution is provided as part of the CygWin + distribution, and but you can build your own copy of \texlive{} from + the current sources. + + BaKoMa \TeX{}, by Basil Malyshev, is a comprehensive (shareware) + distribution, which focuses on support of Acrobat. The distribution + comes with a bunch of Type~1 fonts packaged to work with BaKoMa + \TeX{}, which further the focus. + \begin{ctanrefs} + \item[bakoma]\CTANref{bakoma-tex} + \item[miktex]Acquire \CTANref{miktex-setup} (also available from the + \miktex{} web site), and read installation instructions from % + % ! line break + \href{http://www.miktex.org/2.7/setup}{the \miktex{} installation page} + \item[\nothtml{\bgroup\rmfamily}Portable\nothtml{\egroup} miktex]\CTANref{miktex-portable} + \item[protext.exe]\CTANref{protext} + \item[texlive]Browse \CTANref{texlive} + \item[texlive installer (Windows)]\CTANref{texlive-windows} + \end{ctanrefs} +\item[\acro{PC}: \MSDOS{} or \acro{OS/}2] Em\TeX{}, by Eberhard Mattes, + includes \LaTeX{}, \BibTeX{}, previewers, and drivers, and is + available as a series of zip archives. Documentation is + available in both German and English. Appropriate memory managers + for using em\TeX{} with 386 (and better) processors and under + Windows, are included in the distribution. Em\TeX{} will operate + under Windows, but Windows users are better advised to use a + distribution tailored for the Windows environment. + + A version of em\TeX{}, packaged to use a + % beware line break + \Qref*{TDS directory structure}{Q-tds}, is separately available as + an em\TeX{} `contribution'. Note that neither em\TeX{} itself, nor + em\TeX{}\acro{TDS}, is maintained. Most users of Microsoft + operating systems, who want an up-to-date \AllTeX{} system, need to + migrate to Win32-based systems. + \begin{ctanrefs} + \item[emtex]\CTANref{emtex} + \item[emtexTDS]\CTANref{emtextds} + \end{ctanrefs} +\item[\acro{PC}: \MSDOS{}] The most recent \MSDOS{} offering is a + port of the Web2C~7.0 implementation, using the \acro{GNU} + \ProgName{djgpp} compiler. While this package is more recent than + em\TeX{}, it still implements a rather old instance of \AllTeX{}. + \begin{ctanrefs} + \item[djgpp]\CTANref{djgpp} + \end{ctanrefs} +\item[\acro{PC}: \acro{OS/}2] Em\TeX{}, by Eberhard Mattes (see + above), was actually developed under \acro{OS/}2, and lives happily + in that environment. + + \acro{OS/}2 users may also use a free version of the + commercial \Qref*{V\TeX{}}{Q-commercial}, which specialises + in direct production of \acro{PDF} from \AllTeX{} input. (This + version is, like the Linux version, unfortunately no longer supported.) + \begin{ctanrefs} + \item[emtex]\CTANref{emtex} + \item[emtexTDS]\CTANref{emtextds} + \item[vtex]\CTANref{vtex-os2} + \item[vtex \nothtml{\rmfamily}required common files]\CTANref{vtex-common} + \end{ctanrefs} +%% \item[Windows \acro{NT}, other platforms] Ports of \miktex{} for +%% \acro{NT} on Power \acro{PC} and \acro{AXP} are available. Neither +%% version has been updated for version~1.2 (or later) of +%% \miktex{}~--- they may not be satisfactory. +%% \begin{ctanrefs} +%% \item[miktex for AXP]\CTANref{miktex-AXP} +%% \item[miktex for Power PC]\CTANref{miktexppc} +%% \end{ctanrefs} +\item[Mac] \href{http://www.trevorrow.com/oztex/}{Oz\TeX{}}, by Andrew + Trevorrow, is a shareware version of + \TeX{} for the Macintosh. A \acro{DVI} previewer and \PS{} + driver are also included. (Members of \acro{UK}~\acro{TUG} may + acquire the software without further payment, as part of a + membership deal.) Oz\TeX{} does not run, natively, under MacOS/X, + but will run with a sufficiently recent CarbonLib (see + \URL{http://www.trevorrow.com/oztex/ozosx.html}). + Other questions about Oz\TeX{} itself may be directed to + \mailto{oztex@midway.uchicago.edu} + + Another partly shareware program is + \href{http://www.kiffe.com/cmactex.html}{CMac\TeX{}} , put together + by Tom Kiffe. CMac\TeX{} is much closer than Oz\TeX{} to the Unix + \TeX{} model of things (it uses \ProgName{dvips}, for instance). + CMac\TeX{} runs natively under includes a port of a version of + \Qref*{Omega}{Q-omegaleph}. + + Both Oz\TeX{} and \acro{CM}ac\TeX{} run on either MacOS/X or on a + sufficiently recent MacOS with CarbonLib + (v1.3~for Oz\TeX{}, v1.4~for CMac\TeX{}). + % beware line wrap + + From its 2005 release, the \Qref*{\texlive{} disc set}{Q-CD} + includes Mac\TeX{}. Details (and a downloadable distribution set) + may be found on the % ! line break + \href{http://tug.org/mactex}{\acro{TUG} web site}; the distribution + is also on \acro{CTAN}. + +\begin{narrowversion} % really, non-hyper version + A useful resource for Mac users is to be found at + \URL{http://www.esm.psu.edu/mac-tex/}; it has a news and `help' + section, as well as details of systems and tools. +\end{narrowversion} +\begin{wideversion} + A useful + \href{http://www.esm.psu.edu/mac-tex/}{resource for Mac users} + has a news and `help' section, as well as details of systems and + tools. +\end{wideversion} + The Mac\TeX{}-on-OSX mailing list is a useful resource for users; + mail \mailto{MacOSX-TeX-on@email.esm.psu.edu} to subscribe. +\begin{ctanrefs} + \item[cmactex]\CTANref{cmactex} + \item[mactex]\CTANref{mactex} + \item[oztex]\CTANref{oztex} +\end{ctanrefs} +\item[Open\acro{VMS}] \TeX{} for Open\acro{VMS} is available, though + it seems unlikely that the version on \acro{CTAN} is the latest + available. + \begin{ctanrefs} + \item[OpenVMS]\CTANref{OpenVMSTeX} + \end{ctanrefs} +\item[Atari] \TeX{} for the Atari \acro{ST} is available from \acro{CTAN}. + \begin{ctanrefs} + \item[Atari TeX]\CTANref{atari} + \end{ctanrefs} +\item[Amiga] Full implementations of \TeX{} 3.1 (Pas\TeX{}) and \MF{} + 2.7 are available. + \begin{ctanrefs} + \item[PasTeX]\CTANref{amiga} + \end{ctanrefs} +\item[\acro{TOPS}-20] \TeX{} was originally written on a \acro{DEC}-10 + under \acro{WAITS}, + and so was easily ported to \acro{TOPS}-20. A distribution that runs on + \acro{TOPS}-20 is available via anonymous \texttt{ftp} from + \FTP{ftp.math.utah.edu} in \path{pub/tex/pub/web} + \checked{RF}{2001/03/01} +\end{description} + +\Question[Q-editors]{\TeX{}-friendly editors and shells} + +There are good \TeX{}-writing environments and editors for most +operating systems; some are described below, but this is only a +personal selection: +\begin{description} +\item[Unix] The commonest choices are \ProgName{[X]Emacs} or + \ProgName{vim}, though several others are available. + + \href{http://www.gnu.org/software/emacs/emacs.html}{\acro{GNU}\nobreakspace\ProgName{emacs}} + and \href{http://www.xemacs.org/}{\ProgName{XEmacs}} are supported + by the \acro{AUC}-\TeX{} + bundle (available from \acro{CTAN}). \acro{AUC}-\TeX{} provides menu + items and control sequences for common constructs, checks syntax, + lays out markup nicely, lets you call \TeX{} and drivers from + within the editor, and everything else like this that you can think + of. Complex, but very powerful. + + \href{http://vim.sourceforge.net}{\ProgName{Vim}} is also highly + configurable (also available for Windows and Macintosh systems). + Many plugins are available to support the needs of the \AllTeX{} user, + including syntax highlighting, calling \TeX{} programs, + auto-insertion and -completion of common \AllTeX{} structures, and + browsing \LaTeX{} help. The scripts \File{auctex.vim} and + \File{bibtex.vim} seem to be the most common recommendations. + + The editor \href{http://nedit.org/}{\ProgName{NEdit}} is also free + and programmable, and is available for Unix systems. An + \acro{AUC}-\TeX{}-alike set of extensions for \ProgName{NEdit} is available + from \acro{CTAN}. + + \ProgName{LaTeX4Jed} provides much enhanced \LaTeX{} support for the + \href{http://www.jedsoft.org/jed/}{\ProgName{jed}} editor. + \ProgName{LaTeX4Jed} is similar to \acro{AUC}-\TeX{}: menus, + shortcuts, templates, syntax highlighting, document outline, + integrated debugging, symbol completion, full integration with + external programs, and more. It was designed with both the beginner + and the advanced LaTeX user in mind. + + The \ProgName{Kile} editor that is provided with the \acro{KDE} + window manager provides \acro{GUI} ``shell-like'' facilities, in a + similar way to the widely-praised \ProgName{Winedt} (see below); + details (and downloads) are available from the project's + \href{http://kile.sourceforge.net/}{home on SourceForge}. A newer + system (by \ProgName{Kile}'s original author), + \href{http://www.xm1math.net/texmaker/}{\ProgName{texmaker}} doesn't + rely on \acro{KDE}'s facilities, and so may be more easily portable. +\item[\MSDOS{}] \TeX{}shell is a simple, + easily-customisable environment, which can be used with the editor + of your choice. + + You can also use \acro{GNU}~\ProgName{emacs} and \acro{AUC}-\TeX{} + under \MSDOS{}. +\item[Windows '9x, NT, etc.]\ProgName{TeXnicCenter} is a (free) + \TeX{}-oriented development system, uniting a powerful platform for + executing \AllTeX{} and friends with a configurable editor. + + \ProgName{Winedt}, a shareware package, is also highly spoken of. + It too provides a shell for the use of \TeX{} and related programs, + as well as a powerful and well-configured editor. The editor can + generate its output in \acro{UTF}-8 (to some extent), which is + useful when working with \Qref*{\xetex{}}{Q-xetex} (and other + ``next-generation'' \AllTeX{} applications). + + Both \ProgName{emacs} and \ProgName{vim} are available in versions + for Windows systems. +\item[\acro{OS/}2] \ProgName{epmtex} offers an \acro{OS/}2-specific shell. +\item[Macintosh] The commercial Textures provides an excellent integrated + Macintosh environment with its own editor. More powerful still (as an + editor) is the shareware \ProgName{Alpha} which is + extensible enough to let you perform almost any \TeX{}-related job. It + works well with Oz\TeX{}. From release 2.2.0 (at least), Textures + works with MacOS~X. + + For MacOS~X users, the free tool of choice appears to be + \href{http://www.uoregon.edu/~koch/texshop/texshop.html}{\texshop{}}, which + combines an editor and a shell with a coherent philosophy of dealing + with \AllTeX{} in the OS~X environment. TeXShop is distributed as + part of the MacTeX system, and will therefore be available out of + the box on machines on which MacTeX has been installed. + + \ProgName{Vim} is also available for use on Macintosh systems. +\item[Wildcard] \acro{TUG} is sponsoring the development of a + cross-platform editor and shell, modelled on the excellent + \texshop{} for the Macintosh. While this program, + \href{http://www.tug.org/texworks/}{\texworks{}}, is still under + development, it is already quite usable: if you're looking for a + \AllTeX{} development environment, and are willing to step beyond + the boundaries, it may be for you. +\end{description} +Atari, Amiga and \acro{N}e\acro{XT} users also have nice +environments. \LaTeX{} users looking for \ProgName{make}-like +facilities should review the answer on +\Qref*{Makefiles for \LaTeX{} documents}{Q-make}. + +While many \AllTeX{}-oriented editors can support work on \BibTeX{} +files, there are many systems that provide specific ``database-like'' +access to your \BibTeX{} files~--- +\begin{wideversion} + see ``\Qref{creating a bibliography file}{Q-buildbib}''. +\end{wideversion} +\begin{narrowversion} + these are discussed in % ! line break + ``\Qref*{creating a bibliography file}{Q-buildbib}''. +\end{narrowversion} +\begin{ctanrefs} +\item[alpha]\CTANref{alpha} +\item[auctex]\CTANref{auctex} +\item[epmtex]\CTANref{epmtex} +\item[LaTeX4Jed]\CTANref{latex4jed} +\item[Nedit LaTeX support]\CTANref{nedit-latex} +\item[TeXnicCenter]\CTANref{texniccenter} +\item[TeXshell]\CTANref{texshell} +\item[TeXtelmExtel]\CTANref{TeXtelmExtel} +\item[winedt]\CTANref{winedt} +\end{ctanrefs} + +\Question[Q-commercial]{Commercial \TeX{} implementations} +\keywords{windows,macintosh,commercial} + +There are many commercial implementations of \TeX{}. The first +appeared not long after \TeX{} itself appeared. + +What follows is probably an incomplete list. Naturally, no warranty or +fitness for purpose is implied by the inclusion of any vendor in this +list. The source of the information is given to provide some clues to +its currency. + +In general, a commercial implementation will come `complete', that is, +with suitable previewers and printer drivers. They normally also have +extensive documentation (\emph{i.e}., not just the \TeX{}book!) and some +sort of support service. In some cases this is a toll free number +(probably applicable only within the \acro{USA} and or Canada), but others +also have email, and normal telephone and fax support. +\begin{description} +\item[\acro{PC}; True\TeX{}] Runs on all versions of Windows. + \begin{quote} + Richard J. Kinch\\ + TrueTeX Software\\ + 7890 Pebble Beach Court\\ + Lake Worth \acro{FL} 33467\\ + \acro{USA}\\[.25\baselineskip] + Tel: +1 561-966-8400\\ + Email: \mailto{kinch@truetex.com}\\ + Web: \URL{http://www.truetex.com/} + \end{quote} + Source: Mail from Richard Kinch, August 2004. +%% \item[\acro{PC}; \YandY{} \TeX{}] ``Bitmap free \TeX{} for Windows.'' +%% \begin{quote} +%% \YandY{}, Inc.\\ +%% 106 Indian Hill, \acro{MA} 01741-1747\\ +%% \acro{USA}\\[.25\baselineskip] +%% Tel: 800-742-4059 (within North America)\\ +%% Tel: +1 978-371-3286\\ +%% Fax: +1 978-371-2004\\ +%% Email: \mailto{sales-help@YandY.com} and +%% \nothtml{\\ \hphantom{Email: }}% +%% \mailto{tech-help@YandY.com}\\ +%% Web: \URL{http://www.YandY.com/} +%% \end{quote} +%% Source: Confirmed with \YandY{}, February 2003 +\item[pc\TeX{}] Long-established: pc\TeX{}32 is a Windows implementation. + \begin{quote} + Personal \TeX{} Inc\\ + 725 Greenwich Street, Suite 210 \\ + San Francisco, \acro{CA} 94133\\ + \acro{USA}\\[.25\baselineskip] + Tel: 800-808-7906 (within the \acro{USA})\\ + Tel: +1 415-296-7550\\ + Fax: +1 415-296-7501\\ + Email: \mailto{sales@pctex.com}\\ + Web: \URL{http://www.pctex.com/} + \end{quote} + Source: Personal \TeX{} Inc web site, December 2004 +\item[\acro{PC}; V\TeX{}] \acro{DVI}, \acro{PDF} and \acro{HTML} + backends, Visual Tools and Type 1 fonts + \begin{quote} + MicroPress Inc\\ + 68-30 Harrow Street\\ + Forest Hills, \acro{NY} 11375\\ + \acro{USA}\\[.25\baselineskip] + Tel: +1 718-575-1816\\ + Fax: +1 718-575-8038\\ + Email: \mailto{support@micropress-inc.com}\\ + Web: \URL{http://www.micropress-inc.com/} + \end{quote} + Source: Mail from MicroPress, Inc., July 1999 +\item[\acro{PC}; Scientific Word] Scientific Word and Scientific Workplace + offer a mechanism for near-\WYSIWYG{} input of \LaTeX{} documents; they + ship with True\TeX{} from Kinch (see above). Queries within the \acro{UK} + and Ireland should be addressed to Scientific Word Ltd., others should be + addressed directly to the publisher, MacKichan Software Inc. + \begin{quote} + Dr Christopher Mabb\\ + Scientific Word Ltd.\\ + 990 Anlaby Road,\\ + Hull,\\ + East Yorkshire,\\ + \acro{HU}4 6\acro{AT}\\ + \acro{UK}\\[0.25\baselineskip] + Tel: 0845 766\,0340 (within the \acro{UK}) \\ + Fax: 0845 603\,9443 (within the \acro{UK}) \\ + Email: \mailto{christopher@sciword.demon.co.uk} \\ + Web: \URL{http://www.sciword.demon.co.uk} + \end{quote} + \begin{quote} + MacKichan Software Inc.\\ + 19307 8th Avenue, Suite C\\ + Poulsbo \acro{WA} 98370-7370\\ + \acro{USA}\\[0.25\baselineskip] + Tel: +1 360 394\,6033\\ + Tel: 877 724\,9673 (within the \acro{USA}) + Fax: +1 360 394\,6039\\ + Email: \mailto{info@mackichan.com}\\ + Web: \URL{http://www.mackichan.com} + \end{quote} + Source: Mail from Christopher Mabb, August 2007 +\item[Macintosh; Textures] ``A \TeX{} system `for the rest of + us'\,''. A beta release of Textures for MacOS/X is + available~--- see \URL{http://www.bluesky.com/news/news_frames.html} + + (Blue Sky also gives away a \MF{} implementation and some + font manipulation tools for Macs.) + \begin{quote} + Blue Sky Research\\ + PO Box 80424\\ + Portland, \acro{OR} 97280\\ + \acro{USA}\\[.25\baselineskip] + Tel: 800-622-8398 (within the \acro{USA})\\ + Tel/Fax: +1 503-222-9571\\ + Fax: +1 503-246-4574\\ + Email: \mailto{sales@bluesky.com}\\ + Web: \URL{http://www.bluesky.com/} + \end{quote} + Source: Mail from Gordon Lee, April 2007 +\item[Amiga\TeX{}] A full implementation for the Commodore Amiga, + including full, on-screen and printing support for all \PS{} + graphics and fonts, IFF raster graphics, automatic font generation, + and all of the standard macros and utilities. + \begin{quote} + Radical Eye Software\\ + \acro{PO} Box 2081\\ + Stanford, \acro{CA} 94309\\ + \acro{USA} + \end{quote} + Source: Mail from Tom Rokicki, November 1994 +\end{description} +\checked{mc}{1994/11/09}% +\checked{RF}{1994/11/24}% + +Note that the company \YandY{} has gone out of business, and \YandY{} +\TeX{} (and support for it) is therefore no longer available. Users +of \YandY{} systems may care to use the self-help +\href*{http://tug.org/pipermail/yandytex/}{mailing list} +that was established in 2003; the remaining usable content of +\YandY{}'s web site is available at \URL{http://www.tug.org/yandy/} + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-the-end.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-the-end.tex new file mode 100644 index 00000000000..80f62200f31 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-the-end.tex @@ -0,0 +1,188 @@ +% $Id: faq-the-end.tex,v 1.1 2009/06/13 20:56:49 rf10 Exp rf10 $ + +\section{You're still stuck?} + +\Question[Q-noans]{You don't understand the answer} + +While the \acro{FAQ} maintainers don't offer a `help' service, they're +very keen that you understand the answers they've already written. +They're (almost) written ``in a vacuum'', to provide something to +cover a set of questions that have arisen; it's always possible that +they're written in a way that a novice won't understand them. + +Which is where you can help the community. Mail the +\begin{wideversion} + \href{mailto:faq-devel@tex.ac.uk}{maintainers} +\end{wideversion} +\begin{narrowversion} + maintainers (at \Email{faq-devel@tex.ac.uk}) +\end{narrowversion} +to report the answer that you find unclear, and (if you can) suggest +what we need to clarify. Time permitting (the team is small and all +its members are busy), we'll try and clarify the answer. This way, +with a bit of luck, we can together improve the value of this resource +to the whole community. + +Note that the \acro{FAQ} development email address is not for +answering questions: it's for you to suggest which questions we should +work on, or new questions we should answer in future editions. + +Those who simply ask questions at that address will be referred to +\mailto{texhax@tug.org} or to \Newsgroup{comp.text.tex}. + +\Question[Q-newans]{Submitting new material for the \acro{FAQ}} + +The \acro{FAQ} will never be complete, and we always expect that +there will be people out there who know better than we do about +something or other. We always need to be put right about whatever +we've got wrong, and suggestions for improvements, particularly +covering areas we've missed, are always needed: mail anything you have +to the +\begin{wideversion} + \href{mailto:faq-devel@tex.ac.uk}{maintainers} +\end{wideversion} +\begin{narrowversion} + maintainers (at \Email{faq-devel@tex.ac.uk}) +\end{narrowversion} + +If you have actual material to submit, your contribution is more than +ever welcome. Submission in plain text is entirely acceptable, but +if you're really willing, you may feel free to mark up your submission +in the form needed for the \acro{FAQ} itself. The markup is a +strongly-constrained version of \LaTeX{}~--- the constraints come from +the need to translate the marked-up text to \acro{HTML} on the fly +(and hence pretty efficiently). There is a file \File{markup-syntax} +in the \acro{FAQ} distribution that describes the structure of the +markup, but there's no real substitute for reading at least some of +the source (\File{faqbody.tex}) of the \acro{FAQ} itself. If you +understand \ProgName{Perl}, you may also care to look at the +translation code in \File{texfaq2file} and \File{sanitize.pl} in the +distribution: this isn't the code actually used on the Web site, but +it's a close relation and is kept +up to date for development purposes. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}\acro{FAQ} distribution]\CTANref{faq} +\end{ctanrefs} + +\Question[Q-latexbug]{Reporting a \LaTeX{} bug} + +The \LaTeX{} team supports \LaTeX{}, and will deal with +% beware line wrap +\emph{bona fide} bug reports. Note that the \LaTeX{} team does +\emph{not} deal with contributed packages~--- just the software that +is part of the \LaTeX{} distribution itself: \LaTeX{} and the +``required'' packages. +Furthermore, you need to be slightly +careful to produce a bug report that is usable by the team. The steps +are: + +\nothtml{\noindent}\textbf{1.} Are you still using current \LaTeX{}? Maintenance is only +available for sufficiently up-to-date versions of \LaTeX{}~--- if your +\LaTeX{} is more than two versions out of date, the bug reporting +mechanisms may reject your report. + +\nothtml{\noindent}\textbf{2.} Has your bug already been reported? Browse the +% beware line break +\href{http://www.latex-project.org/cgi-bin/ltxbugs2html?introduction=yes}{\LaTeX{} bugs database}, +to find any earlier instance of your bug. In many cases, the database +will list a work-around. + +\nothtml{\noindent}\textbf{3.} Prepare a % ! line break +\Qref*{``minimum'' file}{Q-minxampl} that exhibits the problem. +Ideally, such a file should contain no contributed packages~--- the +\LaTeX{} team as a whole takes no responsibility for such packages (if +they're supported at all, they're supported by their authors). The +``minimum'' file should be self-sufficient: if a member of the team +should run it in a clean directory, on a system with no contributed +packages, it should replicate your problem. + +\nothtml{\noindent}\textbf{4.} Run your file through \LaTeX{}: the bug +system needs the \extension{log} file that this process creates. + +You now have two possible ways to proceed: either create a mail report +to send to the bug processing mechanism (5, below), or submit your bug +report via the web (7, below). + +\nothtml{\noindent}\textbf{5.} Process the bug-report creation file, using \LaTeX{} itself: +\begin{verbatim} + latex latexbug +\end{verbatim} +\File{latexbug} asks you some questions, and then lets you describe +the bug you've found. It produces an output file \File{latexbug.msg}, +which includes the details you've supplied, your ``minimum'' example +file, and the log file you got after running the example. (I always +need to edit the result before submitting it: typing text into +\File{latexbug} isn't much fun.) + +\nothtml{\noindent}\textbf{6.} Mail the resulting file to +\Email{latex-bugs@latex-project.org}; the subject line of your email +should be the same as the bug title you gave to \File{latexbug}. The +file \File{latexbug.msg} should be included into your message in-line: +attachments are likely to be rejected by the bug processor. + +\nothtml{\noindent}\textbf{7.} Connect to the +% beware line break +\href{http://www.latex-project.org/bugs-upload.html}{latex bugs processing web page} +and enter details of your bug~--- category, summary and full +description, and the two important files (source and log file); note +that members of the \LaTeX{} team \emph{need} your name and email address, as +they may need to discuss the bug with you, or to advise you of a +work-around. + +\htmlignore +\par +\endhtmlignore +\Question[Q-bug]{What to do if you find a bug} +\htmlignore +\par +\endhtmlignore +% +% This here isn't a reference to a question... +\label{lastquestion} + +For a start, make entirely sure you \emph{have} found a bug. +Double-check with books about \TeX{}, \LaTeX{}, or whatever you're using; +compare what you're seeing against the other answers above; ask every +possible person you know who has any \TeX{}-related expertise. +The reasons for all this caution are various. + +If you've found a bug in \TeX{} itself, you're a rare animal indeed. +Don Knuth is so sure of the quality of his code that he offers real +money prizes to finders of bugs; the cheques he writes are +such rare items that they are seldom cashed. If \emph{you} +think you have found a genuine fault in \TeX{} itself (or \MF{}, or the +\acro{CM} fonts, or the \TeX{}book), don't immediately write to Knuth, +however. He only looks at bugs infrequently, and even then +only after they are agreed as bugs by a small vetting team. In the +first instance, contact Barbara Beeton at the \acro{AMS} +(\Email{bnb@ams.org}), or contact +\Qref*{\acro{TUG}}{Q-TUG*}. + +If you've found a bug in \LaTeXe{}, \Qref*{report it}{Q-latexbug} +using mechanisms supplied by the \LaTeX{} team. (Please be +careful to ensure you've got a \LaTeX{} bug, or a bug in one of the +``required'' packages distributed by the \LaTeX{} team.) + +If you've found a bug in a contributed \LaTeX{} package, you could try +contacting the author (if you can find a contact address). However, +it's generally best to treat any package as unsupported, in the first +instance, and only try the author \emph{after} mailing list/news group +support has failed you. + +If you've found a bug in \LaTeXo{}, or some other such unsupported +software, you may find help or +\emph{de facto} support on a newsgroup such as +\Newsgroup{comp.tex.tex} or on a mailing list such as +\mailto{texhax@tug.org}; be careful to include a % ! line wrap +\Qref*{code example}{Q-minxampl} of the +failure, if relevant. + +Failing all else, you may need to pay for +help~--- \acro{TUG} maintains a % ! line break +\href{http://www.tug.org/consultants.html}{register of \TeX{} consultants}. + + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: t +%%% End: diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex new file mode 100644 index 00000000000..c0c0d0a450f --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex @@ -0,0 +1,1783 @@ +% $Id: faq-wdidt.tex,v 1.2 2009/09/01 06:53:22 rf10 Exp rf10 $ + +\section{Why does it \emph{do} that?} + +\subsection{Common errors} + +\Question[Q-crossref]{\LaTeX{} gets cross-references wrong} + +Sometimes, however many times you run \LaTeX{}, the cross-references +are just wrong. Remember that +the \csx{label} command must come \emph{after} the \csx{caption} command, or +be part of it. For example, +\htmlignore +\par\noindent +\begin{tabular}{@{}lll} +| \begin{figure}| & & |\begin{figure}|\\ +| \caption{A Figure}| & or & |\caption{A Figure%| \\ +| \label{fig}| & & | \label{fig}}| \\ +| \end{figure}| & & |\end{figure}| \\ +\end{tabular} +\endhtmlignore +\begin{htmlversion} +\begin{verbatim} + \begin{figure} \begin{figure} + \caption{A Figure} or \caption{A Figure% + \label{fig} \label{fig}} + \end{figure} \end{figure} +\end{verbatim} +\end{htmlversion} + +You can, just as effectively, shield the \csx{caption} command from its +associated \csx{label} command, by enclosing the caption in an +environment of its own. For example, people commonly seek help after: +\begin{quote} +\begin{verbatim} +\begin{center} + \caption{A Figure} +\end{center} +\label{fig} +\end{verbatim} +\end{quote} +has failed to label correctly. If you really need this centring (and +those in the know commonly reject it), code it as: +\begin{quote} +\begin{verbatim} +\begin{center} + \caption{A Figure} + \label{fig} +\end{center} +\end{verbatim} +\end{quote} + +\Question[Q-newlineargs]{Start of line goes awry} +\keywords{asterisk square bracket start line} + +This answer concerns two sorts of problems: errors of the form +\begin{quote} +\begin{verbatim} +! Missing number, treated as zero. +<to be read again> + g +<*> [grump] +\end{verbatim} +\end{quote} +and those where a single asterisk at the start of a line mysteriously +fails to appear in the output. + +Both problems arise because |\|{}|\| takes optional arguments. The +command |\|{}|\*| means ``break the line here, and inhibit page break +following the line break''; the command |\|{}|\[|\meta{dimen}|]| +means ``break the line here and add \meta{dimen} extra vertical space +afterwards''. + +So why does |\|{}|\| get confused by these things at the start of a +line? It's looking for the first non-blank thing, and in the test it +uses ignores the end of the line in your input text. + +The solution is to enclose the stuff at the start of the new line in +braces: +\begin{quote} +\begin{verbatim} +{\ttfamily + /* C-language comment\\ + {[grump]} I don't like this format\\ + {*}/ +} +\end{verbatim} +\end{quote} +(The above text derives from an actual post to +\Newsgroup{comp.text.tex}; this particular bit of typesetting could +plainly also be done using the \environment{verbatim} environment.) + +The problem also appears in maths mode, in arrays and so on. In this +case, large-scale bracketing of things is \emph{not} a good idea; the +\TeX{} primitive \csx{relax} (which does nothing except to block +searches of this nature) may be used. From another +\Newsgroup{comp.text.tex} example: +\begin{quote} +\begin{verbatim} +\begin{eqnarray} + [a] &=& b \\ + \relax[a] &=& b +\end{eqnarray} +\end{verbatim} +\end{quote} +which is a usage this \acro{FAQ} would not recommend, anyway: refer +to the \Qref*{reason not to use \environment{eqnarray}}{Q-eqnarray}. + +Note that the \Package{amsmath} package modifies the behaviour of +\texttt{\bsbs } in maths. With \Package{amsmath}, the \environment{eqnarray} +example doesn't need any special measures. + +\Question[Q-verbwithin]{Why doesn't verbatim work within\,\dots{}?} + +The \LaTeX{} verbatim commands work by changing category codes. Knuth +says of this sort of thing ``Some care is needed to get the timing +right\dots{}'', since once the category code has been assigned to a +character, it doesn't change. So \csx{verb} and +\cmdinvoke{begin}{verbatim} have to assume that they are getting the +first look at the parameter text; if they aren't, \TeX{} has already +assigned category codes so that the verbatim command doesn't have a +chance. For example: +\begin{quote} +\begin{verbatim} +\verb+\error+ +\end{verbatim} +\end{quote} +will work (typesetting `\csx{error}'), but +\begin{quote} +\begin{verbatim} +\newcommand{\unbrace}[1]{#1} +\unbrace{\verb+\error+} +\end{verbatim} +\end{quote} +will not (it will attempt to execute \csx{error}). Other errors one +may encounter are `\csx{verb} ended by end of line', or even the +rather more helpful `\csx{verb} illegal in command argument'. The +same sorts of thing happen with \cmdinvoke{begin}{verbatim} \dots{} +\cmdinvoke{end}{verbatim}: +\begin{quote} +\begin{quoteverbatim} +\ifthenelse{\boolean{foo}}{% +\begin{verbatim} +foobar +\end{verbatim} +}{% +\begin{verbatim} +barfoo +\end{verbatim} +} +\end{quoteverbatim} +\end{quote} +provokes errors like `File ended while scanning use of +\csx{@xverbatim}', as \cmdinvoke{begin}{verbatim} fails to see its +matching \cmdinvoke{end}{verbatim}. + +This is why the \LaTeX{} book insists that verbatim +commands must not appear in the argument of any other command; they +aren't just fragile, they're quite unusable in any command parameter, +regardless of \Qref*{\csx{protect}ion}{Q-protect}. (The \csx{verb} +command tries hard to detect if you're misusing it; unfortunately, it +can't always do so, and the error message is therefore not a reliable +indication of problems.) + +The first question to ask yourself is: ``is \csx{verb} actually +necessary?''. +\begin{itemize} +\item If \cmdinvoke{texttt}{\emph{your text}} produces the same result + as \csx{verb}\texttt{+\emph{your text}+}, then there's no need of + \csx{verb} in the first place. +\item If you're using \csx{verb} to typeset a \acro{URL} or email + address or the like, then the \csx{url} command from the + \Package{url} will help: it doesn't suffer from all the problems of + \csx{verb}, though it's still not robust; % ! line break + ``\Qref*{typesetting \acro{URL}s}{Q-setURL}'' offers advice here. +\item If you're putting \csx{verb} into the argument of a boxing + command (such as \csx{fbox}), consider using the \environment{lrbox} + environment: +\begin{quote} +\begin{verbatim} +\newsavebox{\mybox} +... +\begin{lrbox}{\mybox} + \verb!VerbatimStuff! +\end{lrbox} +\fbox{\usebox{\mybox}} +\end{verbatim} +\end{quote} +\end{itemize} + +Otherwise, there are three partial solutions to the problem. +\begin{itemize} +\item Some packages have macros which are designed to be responsive + to verbatim text in their arguments. For example, + the \Package{fancyvrb} package defines a command + \csx{VerbatimFootnotes}, which redefines the \csx{footnotetext} + command, and hence also the behaviour of the \csx{footnote}) + command, in such a way that you can include \csx{verb} commands in + its argument. This approach could in principle be extended to the + arguments of other commands, but it can clash with other packages: + for example, \csx{VerbatimFootnotes} interacts poorly with the + \pkgoption{para} option of the \Package{footmisc} package. + + The \Class{memoir} class defines its \csx{footnote} command so that + it will accept verbatim in its arguments, without any supporting package. +\item The \Package{fancyvrb} package defines a command \csx{SaveVerb}, + with a corresponding \csx{UseVerb} command, that allow you to save + and then to reuse the content of its argument; for details of this + extremely powerful facility, see the package documentation. + + Rather simpler is the \Package{verbdef} package, whose \csx{verbdef} + command defines a (robust) command which expands to the verbatim + argument given. +\item If you have a single character that is giving trouble (in + its absence you could simply use \csx{texttt}), consider using + \csx{string}. \cmdinvoke{texttt}{my\csx{string}\_name} + typesets the same as + |\verb+my_name+|, and will work in the argument of a command. It + won't, however, work in a moving argument, and no amount of + \Qref*{\csx{protect}ion}{Q-protect} will make it work in + such a case. + + A robust alternative is: + \begin{quote} +\begin{verbatim} +\chardef\us=`\_ +... +\section{... \texttt{my\us name}} +\end{verbatim} + \end{quote} + Such a definition is `naturally' robust; the construction + ``\meta{back-tick}\csx{\meta{char}}'' may be used for any + troublesome character (though it's plainly not necessary for things + like percent signs for which \AllTeX{} already provides + robust macros). +\end{itemize} +Documentation of both \Package{url} and \Package{verbdef} is in the +package files. +\begin{ctanrefs} +\item[fancyvrb.sty]\CTANref{fancyvrb} +\item[memoir.cls]\CTANref{memoir} +\item[url.sty]\CTANref{url} +\item[verbdef.sty]\CTANref{verbdef} +\end{ctanrefs} + +\Question[Q-noline]{No line here to end} + +The error +\begin{quote} +\begin{wideversion} +\begin{verbatim} +! LaTeX Error: There's no line here to end. + +See the LaTeX manual or LaTeX Companion for explanation. +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +! LaTeX Error: There's no line here to end. + +See the LaTeX manual or LaTeX Companion +... for explanation. +\end{verbatim} +\end{narrowversion} +\end{quote} +comes in reaction to you giving \LaTeX{} a |\|{}|\| command at a time +when it's not expecting it. The commonest case is where you've +decided you want the label of a list item to be on a line of its own, +so you've written (for example): +\begin{quote} +\begin{verbatim} +\begin{description} +\item[Very long label] \\ + Text... +\end{description} +\end{verbatim} +\end{quote} +|\|{}|\| is actually a rather bad command to use in this case (even if +it worked), since it would force the `paragraph' that's made up of the +text of the item to terminate a line which has nothing on it but the +label. This would lead to an ``|Underfull \hbox|'' warning message +(usually with `infinite' badness of 10000); while this message doesn't +do any actual harm other than slowing down your \LaTeX{} run, any +message that doesn't convey any information distracts for no useful +purpose. + +The proper solution to the problem is to write a new sort of +\environment{description} environment, that does just what you're after. (The +\nothtml{\emph{\LaTeX{} Companion}~--- see }% ! line wrap +\Qref[question]{\emph{\LaTeX{} Companion}}{Q-books}\nothtml{~---} offers a +rather wide selection of variants of these things.) + +The quick-and-easy solution, which avoids the warning, is to write: +\begin{quote} +\begin{verbatim} +\begin{description} +\item[Very long label] \hspace*{\fill} \\ + Text... +\end{description} +\end{verbatim} +\end{quote} +which fills out the under-full line before forcing its closure. The +\Package{expdlist} package provides the same functionality with its +\csx{breaklabel} command, and \Package{mdwlist} provides it via its +\csx{desclabelstyle} command. + +The other common occasion for the message is when you're using the +\texttt{center} (or \environment{flushleft} or \environment{flushright}) +environment, and have decided you need extra separation between lines +in the environment: +\begin{quote} +\begin{verbatim} +\begin{center} + First (heading) line\\ + \\ + body of the centred text... +\end{center} +\end{verbatim} +\end{quote} +The solution here is plain: use the \texttt{\bsbs } command in the way it's +supposed to be used, to provide more than just a single line break +space. \texttt{\bsbs } takes an optional argument, which specifies +how much extra space to add; the required effect in the text above can +be had by saying: +\begin{quote} +\begin{verbatim} +\begin{center} + First (heading) line\\[\baselineskip] + body of the centred text... +\end{center} +\end{verbatim} +\end{quote} +\begin{ctanrefs} +\item[expdlist.sty]\CTANref{expdlist} +\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} +\end{ctanrefs} + +% other instances: \[no]linebreak in vertical mode + +\Question[Q-2colfltorder]{Two-column float numbers out of order} + +When \LaTeX{} can't place a float immediately, it places it on one of +several ``defer'' lists. If another float of the same type comes +along, and the ``defer'' list for that type still has something in it, +the later float has to wait for everything earlier in the list. + +Now, standard \LaTeX{} has different lists for single-column floats, +and double-column floats; this means that single-column figures can +overtake double-column figures (or vice-versa), and you observe later +figures appear in the document before early ones. The same is true, +of course, for tables, or for any user-defined float. + +The \LaTeX{} team recognise the problem, and provides a package +(\Package{fixltx2e}) to deal with it. \Package{Fixltx2e} amalgamates +the two defer lists, so that floats don't get out of order. + +For those who are still running an older \LaTeX{} distribution, the +package \Package{fix2col} should serve. This package (also by a +member of the \LaTeX{} team) was the basis of the relevant part of +\Package{fixltx2e}. The functionality has also been included in +\Package{dblfloatfix}, which also has code to place full-width floats +at \Qref*{\texttt{[b]} placement}{Q-2colfloat}. + +Once you have loaded the package, no more remains to be done: the +whole requirement is to patch the output routine; no extra commands +are needed. +\begin{ctanrefs} +\item[dblfloatfix.sty]\CTANref{dblfloatfix} +\item[fix2col.sty]Distributed as part of \CTANref{carlisle} +\item[fixltx2e.sty]Part of the \LaTeX{} distribution +\end{ctanrefs} + +\Question[Q-tabacc]{Accents misbehave in \environment{tabbing}} + +So you are constructing a \environment{tabbing} environment, and you +have the need of some diacriticised text~--- perhaps something as simple +as \cmdinvoke{'}{e}~--- and the accent disappears because it has been +interpreted as a \environment{tabbing} command, and everything goes +wrong. + +This is really a rather ghastly feature of the \environment{tabbing} +environment; in order to type accented characters you need to use the +\csx{a} kludge: so \cmdinvoke{a'}{e} inside \environment{tabbing} for +\cmdinvoke{'}{e} outside, and similarly \csx{a`} for \csx{`} and \csx{a=} +for \csx{=}. This whole procedure is of course hideous and +error-prone. + +The simplest alternative is to type in an encoding that has the +diacriticised characters in it, and to use an appropriate encoding +definition file in the \Package{inputenc} package. So for example, +type: +\begin{quote} + \cmdinvoke{usepackage}[latin1]{inputenc}\\ + \texttt{...}\\ + \cmdinvoke{begin}{tabbing}\\ + \texttt{...}\\ + \texttt{...} \csx{>} \texttt{voil\`a} \csx{>} \texttt{...} +\end{quote} +for: +\begin{quote} + \dots{}\quad voil\`a\quad \dots{} +\end{quote} +and the internal mechanisms of the \Package{inputenc} package will put +the right version of the accent command in there. + +A witty reversal of the r\^oles is introduced by the package +\Package{Tabbing} (note the capital ``T''): it provides a +\environment{Tabbing} environment which duplicates +\environment{tabbing}, but all the single-character commands become +complicated objects. So \environment{tabbing}'s \csx{>} becomes +\csx{TAB>}, \csx{=} becomes \csx{TAB=}, and so on. The above trivial +example would therefore become: +\begin{quote} +\begin{verbatim} +\usepackage{Tabbing} +... +\begin{Tabbing} + ... ... \TAB> voil\`a \TAB> ... +\end{verbatim} +\end{quote} +\begin{ctanrefs} +\item[Tabbing.sty]\CTANref{Tabbing} +\end{ctanrefs} + +\Question[Q-alreadydef]{Package reports ``command already defined''} + +You load a pair of packages, and the second reports that one of the +commands it defines is already present. For example, both the +\Package{txfonts} and \Package{amsmath} define a command \csx{iint} +(and \csx{iiint} and so on); so +\begin{quote} +\begin{verbatim} +... +\usepackage{txfonts} +\usepackage{amsmath} +\end{verbatim} +\end{quote} +produces a string of error messages of the form: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +! LaTeX Error: Command \iint already defined. + Or name \end... illegal, see p.192 of the manual. +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +! LaTeX Error: Command \iint already + defined. Or name \end... illegal, + see p.192 of the manual. +\end{verbatim} +\end{narrowversion} +\end{quote} +As a general rule, things that \Package{amsmath} defines, it defines +well; however, there is a good case for using the \Package{txfonts} +version of \csx{iint}~--- the associated \FontName{tx} fonts have a +double integral symbol that doesn't need to be ``faked'' in the way +\Package{amsmath} does. In the case that you are loading several +symbol packages, every one of which defines the same symbol, you are +likely to experience the problem in a big way (\csx{euro} is a common +victim). + +There are similar cases where one package redefines another's command, +but no error occurs because the redefining package doesn't use +\csx{newcommand}. Often, in such a case, you only notice the change +because you assume the definition given by the first package. The +\Package{amsmath}--\Package{txfonts} packages are just such a pair; +\Package{txfonts} doesn't provoke errors. + +You may deal with the problem by saving and restoring the command. +Macro programmers may care to do this for themselves; for the rest of +us, there's the package \Package{savesym}. The sequence: +\begin{quote} +\begin{verbatim} +\usepackage{savesym} +\usepackage{amsmath} +\savesymbol{iint} +\usepackage{txfonts} +\restoresymbol{TXF}{iint} +\end{verbatim} +\end{quote} +does the job; restoring the \Package{amsmath} version of the command, +and making the \Package{txfonts} version of the command available as +\csx{TXFiint}. + +Documentation of \Package{savesym} doesn't amount to much: the only +commands are \csx{savesymbol} and \csx{restoresymbol}, as noted above. +\begin{ctanrefs} +\item[amsmath.sty]Part of \CTANref{amslatex} +\item[savesym.sty]\CTANref{savesym} +\item[txfonts.sty]Part of \CTANref{txfonts} +\end{ctanrefs} + +\Question[Q-zerochap]{Why are my sections numbered 0.1\,\dots{}?} + +This happens when your document is using the standard \Class{book} or +\Class{report} class (or one similar), and you've got a \csx{section} +before your first \csx{chapter}. + +What happens is, that the class numbers sections as % ! line break +``\meta{chapter no}.\meta{section no}'', and until the first +chapter has appeared, the chapter number is 0. + +If you're doing this, it's quite likely that the \Class{article} class +is for you; try it and see. Otherwise, give your sections a +`superior' chapter, or do away with section numbering by using +\csx{section*} instead. An alternative way of avoiding numbering is +discussed in % ! line break +``\Qref*{unnumbered sections in the table of contents}{Q-secnumdep}''. + +\Question[Q-breaklinks]{Link text doesn't break at end line} +\keywords{hyperref overfull link} + +When using the \Package{hyperref} package, you make a block of text +``active'' when you define a hyper-link (when the user clicks on +that text, the reader program will divert to the \emph{target} of the +link). + +The \Package{hyperref} package uses a \emph{driver} (in the same way +as the \Package{graphics} package does), to determine how to implement +all that hyper-stuff. + +If you use the driver for \ProgName{dvips} output (presumably you want +to distill the resulting \PS{}), limitations in the way \ProgName{dvips} +deals with the \csx{special} commands mean that \Package{hyperref} +must prevent link anchors from breaking at the end of lines. Other +drivers (notably those for \PDFTeX{} and for \ProgName{dvipdfm}) don't +suffer from this problem. + +The problem may occur in a number of different circumstances. For a +couple of them, there are work-arounds: + +First, if you have an \acro{URL} which is active (so that clicking on +it will activate your web browser to ``go to'' the \acro{URL}). In +this case \Package{hyperref} employs the \Package{url} package to +split up the \acro{URL} (as described in % ! line break +\Qref[question]{typesetting \acro{URL}s}{Q-setURL}), but the +\ProgName{dvips} driver then suppresses the breaks. The way out is +the \Package{breakurl} package, which modifies the \csx{url} command +to produce several smaller pieces, between each of which a line break +is permitted. Each group of pieces, that ends up together in one +line, is converted to a single clickable link. + +Second, if you have a table of contents, list of figure or tables, or +the like, \Package{hyperref} will ordinarily make the titles in the +table of contents, or captions in the lists, active. If the title or +caption is long, it will need to break within the table, but the +\ProgName{dvips} driver will prevent that. In this case, load +\Package{hyperref} with the option \pkgoption{linktocpage}, and only +the page number will be made active. + +Otherwise, if you have a lengthy piece of text that you want active, +you have at present no simple solution: you have to rewrite your text, +or to use a different \acro{PDF} generation mechanism. +\begin{ctanrefs} +\item[breakurl.sty]\CTANref{breakurl} +\end{ctanrefs} + +\Question[Q-wrongpn]{Page number is wrong at start of page} + +This is a long story, whose sources are deep inside the workings of +\TeX{} itself; it all derives from the \TeX{}'s striving to generate +the best possible output. + +The page number is conventionally stored in \csx{count0}; \LaTeX{} +users see this as the counter \texttt{page}, and may typeset its value +using \csx{thepage}. + +The number (that is to say, \csx{count0}) is only updated when \TeX{} +actually outputs a page. \TeX{} only even tries to do this when it +detects a hint that it may be a good thing to do. From \TeX{}'s point +of view, the end of a paragraph is a good time to consider outputting +a page; it will output a page if it has \emph{more} than a page's +worth of material to output. (Ensuring it always has something in +hand makes some optimisations possible.) As a result, \csx{count0} +(\csx{thepage}) is almost always wrong in the first paragraph of a +page (the exception is where the page number has been ``forcibly'' +changed, either by changing its value directly, or by breaking the +page where \TeX{} wouldn't necessarily have chosen to break). + +\LaTeX{} provides a safe way of referring to the page number, by using +label references. So, rather than writing: +\begin{quote} +\begin{verbatim} +Here is page \thepage{}. +\end{verbatim} +\end{quote} +you should write: +\begin{quote} +\begin{verbatim} +Here is page \pageref{here}\label{here}. +\end{verbatim} +\end{quote} +(note: no space between the \csx{pageref} and the \csx{label}, since +that could potentially end up as a page-break space itself, which +rather defeats the purpose of the exercise!). + +\Question[Q-matchbrak]{My brackets don't match} + +\AllTeX{} has a low-level mechanism for matching braces in document +text. This means you can type something like: +\begin{quote} +\begin{verbatim} +\section{All \emph{OK} now.} +\end{verbatim} +\end{quote} +and know that the first brace (for the argument of \csx{section}) will +be matched with the last brace, and the internal pair of braces (for +the argument of \csx{emph}) will be matched with each other. It's all +very simple. + +However, \LaTeX{} has a convention of enclosing optional arguments in +brackets, as in: +\begin{quote} +\begin{verbatim} +\section[OK]{All \emph{OK} now.} +\end{verbatim} +\end{quote} +These brackets are not matched by \TeX{} mechanisms, despite the +superficial similarity of their use. As a result, +straightforward-looking usages like: +\begin{quote} +\begin{verbatim} +\section[All [OK] now]{All \emph{OK} now.} +\end{verbatim} +\end{quote} +aren't \acro{OK} at all~--- the optional argument comes to consist of +``All [OK'', and \csx{section} takes the single character ``n'' (of +the first ``now'') as its argument. + +Fortunately, \TeX{}'s scanning mechanisms helps us by accepting the +syntax ``\texttt{\{]\}}'' to `hide' the closing bracket from the +scanning mechanism that \LaTeX{} uses. In practice, the commonest way +to use this facility is: +\begin{quote} +\begin{verbatim} +\section[All {[OK]} now]{All \emph{OK} now.} +\end{verbatim} +\end{quote} +since bracing the bracket on its own ``looks odd''. + +\LaTeX{} has another argument syntax, even less regular, where the +argument is enclosed in parentheses, as in: +\begin{quote} +\begin{verbatim} +\put(1,2){foo} +\end{verbatim} +\end{quote} +(a picture environment command). + +This mechanism is also prone to problems with matching closing +parentheses, but the issue seldom arises since such arguments rarely +contain text. If it were to arise, the same solution (enclosing the +confused characters in braces) would solve the problem. + +\Question[Q-pdf-fig-chars]{Characters disappear from figures in \PDFTeX{}} + +You have a \acro{PDF} figure, which you want to use in your +\PDFLaTeX{} document. When you compile the document, \PDFTeX{} +complains about ``missing glyphs'', and some (or all) of the labelling +text or symbols in the original figure is no longer visible. + +What has happened is: +\begin{enumerate} +\item Your figure file (say \File{fig.pdf}) has a font \File{font.pfb} + embedded in it. +\item \PDFTeX{} notes that it has \File{font.pfb} on disc, and loads + that in place of the copy in \File{fig.pdf}. +\item It turns out that the copy in \File{fig.pdf} has glyphs that + aren't in \File{font.pfb} on disc, so that you get errors while + compiling and you see that characters are missing when you view the + output. (\PDFTeX{} can't know that the fonts are different, since + they have the same name.) +\end{enumerate} +Which is all very undesirable. + +\PDFTeX{} does this to keep file sizes down: suppose you have a +document that loads figures \File{fig1.pdf} and \File{fig2.pdf}; both +of those use font \File{font.pfb}. If \PDFTeX{} takes no action, +there will be \emph{two} copies of \File{font.pfb} in the output. +(If your document also uses the font, there could be three copies.) + +A real case is the \acro{URW} font \File{NimbusRomNo9L-Regu} (a clone +of Times Roman), which is available in a version with Cyrillic +letters, while the version in \TeX{} distributions doesn't have those +letters. Both versions, as distributed, have the same name. + +The simple (``quick and dirty'') solution is to add the command +\begin{quote} + \csx{pdfinclusioncopyfonts}\texttt{=1} +\end{quote} +to the preamble of your document. + +The ``real'' solution is that one or other font should be renamed. In +either case, this would require that you reconfigure some program's +(\TeX{}'s or your drawing package's) font tables~--- inevitably a +tiresome job. + +\subsection{Common misunderstandings} + +\Question[Q-include]{What's going on in my \csx{include} commands?} + +The original \LaTeX{} provided the \csx{include} command to address the +problem of long documents: with the relatively slow computers of the +time, the companion \csx{includeonly} facility was a boon. With the +vast increase in computer speed, \csx{includeonly} is less valuable +(though it still has its place in some very large projects). +Nevertheless, the facility is retained in current \LaTeX{}, and causes +some confusion to those who misunderstand it. + +In order for \csx{includeonly} to work, \csx{include} makes a separate +\extension{aux} file for each included file, and makes a `checkpoint' of +important parameters (such as page, figure, table and footnote +numbers); as a direct result, it \emph{must} clear the current page +both before and after the \csx{include} command. What's more, this +mechanism doesn't work if a \csx{include} command appears in a file +that was \csx{include}d itself: \LaTeX{} diagnoses this as an error. + +So, we can now answer the two commonest questions about \csx{include}: +\begin{itemize} +\item Why does \LaTeX{} throw a page before and after \csx{include} + commands? + + Answer: because it has to. If you don't like it, replace the + \csx{include} command with \csx{input}~--- you won't be able to use + \csx{includeonly} any more, but you probably don't need it anyway, so + don't worry. +\begin{htmlversion} + +\end{htmlversion} +\item Why can't I nest \csx{include}d files?~--- I always used to be + able to under \LaTeXo{}. + + Answer: in fact, you couldn't, even under \LaTeXo{}, but the failure + wasn't diagnosed. However, since you were happy with the behaviour + under \LaTeXo{}, replace the \csx{include} commands with \csx{input} + commands (with \csx{clearpage} as appropriate). +\end{itemize} + + +\Question[Q-paraparam]{Why does it ignore paragraph parameters?} + +When \TeX{} is laying out text, it doesn't work from word to word, or +from line to line; the smallest complete unit it formats is the +paragraph. The paragraph is laid down in a buffer, as it appears, and +isn't touched further until the end-paragraph marker is processed. +It's at this point that the paragraph parameters have effect; and it's +because of this sequence that one often makes mistakes that lead to +the paragraph parameters not doing what one would have hoped (or +expected). + +Consider the following sequence of \LaTeX{}: +\begin{quote} +\begin{verbatim} +{\raggedright % declaration for ragged text +Here's text to be ranged left in our output, +but it's the only such paragraph, so we now +end the group.} + +Here's more that needn't be ragged... +\end{verbatim} +\end{quote} +\TeX{} will open a group, and impose the ragged-setting parameters within +that group; it will then save a couple of sentences of text and +close the group (thus restoring the previous value of the +parameters that \csx{raggedright} set). Then \TeX{} encounters a blank +line, which it knows to treat as a \csx{par} token, so it typesets the +two sentences; but because the enclosing group has now been closed, +the parameter settings have been lost, and the paragraph will be +typeset normally. + +The solution is simple: close the paragraph inside the group, so that +the setting parameters remain in place. An appropriate way of doing +that is to replace the last three lines above with: +\begin{quote} +\begin{verbatim} +end the group.\par} +Here's more that needn't be ragged... +\end{verbatim} +\end{quote} +In this way, the paragraph is completed while \csx{raggedright}'s +parameters are still in force within the enclosing group. + +Another alternative is to define an environment that does the +appropriate job for you. For the above example, \LaTeX{} already +defines an appropriate one: +\begin{quote} +\begin{verbatim} +\begin{flushleft} +Here's text to be ranged left... +\end{flushleft} +\end{verbatim} +\end{quote} + +In fact, there are a number of parameters for which \TeX{} only +maintains one value per paragraph. A tiresome one is the set of upper +case/lower case translations, which (oddly enough) constrains +hyphenation of mutilingual texts. Another that regularly creates +confusion is \Qref*{\csx{baselineskip}}{Q-baselinepar}. + +\Question[Q-casechange]{Case-changing oddities} + +\TeX{} provides two primitive commands \csx{uppercase} and +\csx{lowercase} to change the case of text; they're not much used, but +are capable creating confusion. + +The two commands do not expand the text that is their parameter~--- +the result of \cmdinvoke{uppercase}{abc} is `\texttt{ABC}', but +\cmdinvoke{uppercase}{\csx{abc}} is always `\csx{abc}', whatever the +meaning of \csx{abc}. The commands are simply interpreting a table of +equivalences between upper- and lowercase characters. +They have (for example) no mathematical sense, and +\begin{quote} +\begin{verbatim} +\uppercase{About $y=f(x)$} +\end{verbatim} +\end{quote} +will produce +\begin{quote} +\begin{verbatim} +ABOUT $Y=F(X)$ +\end{verbatim} +\end{quote} +which is probably not what is wanted. + +In addition, \csx{uppercase} and \csx{lowercase} do not deal very well +with non-American characters, for example +\cmdinvoke{uppercase}{\csx{ae}} is the same as \csx{ae}. + +\LaTeX{} provides commands \csx{MakeUppercase} and \csx{MakeLowercase} +which fixes the latter problem. These commands are used in the +standard classes to produce upper case running heads for chapters +and sections. + +Unfortunately \csx{MakeUppercase} and \csx{MakeLowercase} do not solve +the other problems with \csx{uppercase}, so for example a section +title containing \cmdinvoke{begin}{tabular} \dots{} +\cmdinvoke{end}{tabular} will produce a running head containing +\cmdinvoke{begin}{TABULAR}. The simplest solution to this problem is +using a user-defined command, for example: +\begin{quote} +\begin{verbatim} +\newcommand{\mytable}{\begin{tabular}... + \end{tabular}} +\section{A section title \protect\mytable{} + with a table} +\end{verbatim} +\end{quote} +Note that \csx{mytable} has to be protected, otherwise it will be +expanded and made upper case; you can achieve the same result by +declaring it with \csx{DeclareRobustCommand}, in which case the +\csx{protect} won't be necessary. + +David Carlisle's \Package{textcase} package +addresses many of these problems in a transparent way. It defines +commands \csx{MakeTextUppercase} and \csx{MakeTextLowercase} which do +upper- or lowercase, with the fancier features of the \LaTeX{} +standard \csx{Make*}-commands but without the problems +mentioned above. Load the package with +\cmdinvoke{usepackage}[overload]{textcase}, and it will redefine the \LaTeX{} +commands (\emph{not} the \TeX{} primitive commands \csx{uppercase} and +\csx{lowercase}), so that section headings and the like don't produce +broken page headings. +\begin{ctanrefs} +\item[textcase.sty]\CTANref{textcase} +\end{ctanrefs} + +\Question[Q-splitfoot]{Why does \LaTeX{} split footnotes across pages?} + +\LaTeX{} splits footnotes when it can think of nothing better to do. +Typically, when this happens, the footnote mark is at the bottom of +the page, and the complete footnote would overfill the page. \LaTeX{} +could try to salvage this problem by making the page short of both the +footnote and the line with the footnote mark, but its priorities told +it that splitting the footnote would be preferable. + +As always, the best solution is to change your text so that the +problem doesn't occur in the first place. Consider whether the text +that bears the footnote could move earlier in the current page, or on +to the next page. + +If this isn't possible, you might want to change \LaTeX{}'s perception +of its priorities: they're controlled by +\csx{interfootnotelinepenalty}~--- the larger it is, the less willing +\LaTeX{} is to split footnotes. + +Setting +\begin{quote} +\begin{verbatim} +\interfootnotelinepenalty=10000 +\end{verbatim} +\end{quote} +inhibits split footnotes altogether, which will cause `\texttt{Underfull} +\csx{vbox}' messages unless you also specify \csx{raggedbottom}. The +default value of the penalty is \texttt{100}, which is rather mild. + +An alternative technique is to juggle with the actual size of the +pages. \csx{enlargethispage} changes the size of the current page by +its argument (for example, you might say +\cmdinvoke{enlargethispage}{\csx{baselineskip}} to add a single line +to the page, but you can use any ordinary \TeX{} length such as +\texttt{15mm} or \texttt{-20pt} as argument). Reducing the size of +the current page could force the offending text to the next page; +increasing the size of the page may allow the footnote to be included +in its entirety. It may be necessary to change the size of more than +one page. + +The \Package{fnbreak} package detects (and generates warnings about) +split footnotes. +\begin{ctanrefs} +\item[fnbreak.sty]\CTANref{fnbreak} +\end{ctanrefs} + +\Question[Q-marginparside]{Getting \csx{marginpar} on the right side} + +In an ideal world, marginal notes would be in ``analogous'' places on +every page: notes on an even-side page would be in the left margin, +while those on an odd-side page would be in the right margin. A +moment's thought shows that a marginal note on the left needs to be +typeset differently from a marginal note on the right. The \LaTeX{} +\csx{marginpar} command therefore takes two arguments in a +\texttt{twoside} documents: % beware line break +\cmdinvoke*{marginpar}[left text]{right text}. \LaTeX{} uses the +``obvious'' test to +get the \csx{marginpar}s in the correct margin, but a booby-trap arises +because \TeX{} runs its page maker asynchronously. If a +\csx{marginpar} is processed while page \ensuremath{n} is being built, but +doesn't get used until page \ensuremath{n}+1, then the \csx{marginpar} will turn +up on the wrong side of the page. This is an instance of a general +problem: see +% beware line break +``\Qref*{finding if you're on an odd or an even page}{Q-oddpage}''. + +The solution to the problem is for \LaTeX{} to `remember' which side +of the page each \csx{marginpar} \emph{should} be on. The +\Package{mparhack} package does this, using label-like marks stored in +the \extension{aux} file; the \Class{memoir} class does likewise. +\begin{ctanrefs} +\item[memoir.cls]\CTANref{memoir} +\item[mparhack.sty]\CTANref{mparhack} +\end{ctanrefs} + +\Question[Q-misschar]{Where have my characters gone?} + +You've typed some apparently reasonable text and processed it, but the +result contains no sign of some of the characters you typed. A likely +reason is that the font you selected just doesn't have a +representation for the character in question. + +For example, if I type ``that will be \pounds{}44.00'' into an ordinary +\AllTeX{} document, or if I select the font |rsfs10| (which contains +uppercase letters only) and type pretty much anything, the \pounds{} +sign, or any lowercase letters or digits will not appear in the +output. There's no actual error message, either: you have to read the +log file, where you'll find cryptic little messages like +\begin{quote} +\begin{wideversion} +\begin{verbatim} +Missing character: There is no ^^a3 in font cmr10! +Missing character: There is no 3 in font rsfs10! +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +Missing character: + There is no ^^a3 in font cmr10! +Missing character: + There is no 3 in font rsfs10! +\end{verbatim} +\end{narrowversion} +\end{quote} +(the former demonstrating my \TeX{}'s unwillingness to deal in characters +which have the eighth bit set, while the \texttt{rsfs10} example shows that +\TeX{} will log the actual character in error, if it thinks it's +possible). + +Somewhat more understandable are the diagnostics you may get from +\Package{dvips} when using the \acro{OT}1 and \acro{T}1 versions of +fonts that were supplied in Adobe standard encoding: +\begin{quote} +\begin{verbatim} +dvips: Warning: missing glyph `Delta' +\end{verbatim} +\end{quote} +The process that generates the metrics for using the fonts generates +an instruction to \Package{dvips} to produce these diagnostics, so +that their non-appearance in the printed output is less surprising +than it might be. Quite a few glyphs provided in Knuth's text +encodings and in the Cork encoding are not available in the Adobe +fonts. In these cases, there \emph{is} a typeset sign of the +character: \ProgName{dvips} produces a black rectangle of whatever +size the concocted font file has specified. + +\Question[Q-rerun]{``Rerun'' messages won't go away} + +The \LaTeX{} message ``Rerun to get crossreferences right'' is +supposed to warn the user that the job needs to be processed again, +since labels seem to have changed since the previous run. (\LaTeX{} +compares the labels it has created this time round with what it found +from the previous run when it started; it does this comparison at +\cmdinvoke{end}{document}.) + +Sometimes, the message won't go away: however often you reprocess your +document, \LaTeX{} still tells you that ``Label(s) may have +changed''. This can sometimes be caused by a broken package: both +\Package{footmisc} (with the |perpage| option) and \Package{hyperref} +have been known to give trouble, in the past: if you are using either, +check you have the latest version, and upgrade if possible. + +However, there \emph{is} a rare occasion when this error can happen +as a result of pathological structure of the document itself. Suppose +you have pages numbered in roman, and you add a reference to a label +on page ``ix'' (9). The presence of the reference pushes the thing +referred to onto page ``x'' (10), but since that's a shorter reference +the label moves back to page ``ix'' at the next run. Such a sequence +can obviously not terminate. + +The only solution to this problem is to make a small change to your +document (something as small as adding or deleting a comma will often +be enough). +\begin{ctanrefs} +\item[footmisc.sty]\CTANref{footmisc} +\item[hyperref.sty]\CTANref{hyperref} +\end{ctanrefs} + +\Question[Q-xspace]{Commands gobble following space} + +People are forever surprised that simple commands gobble the space +after them: this is just the way it is. The effect arises from the +way \TeX{} works, and Lamport describes a solution (place a pair of braces +after a command's invocation) in the description of \LaTeX{} syntax. +Thus the requirement is in effect part of the definition of \LaTeX{}. + +This \acro{FAQ}, +for example, is written with definitions that \emph{require} one to +type \cmdinvoke{fred}{\relax} % the \relax prevents {} being gobbled + % in html production (sigh) +for almost all macro invocations, regardless +of whether the following space is required: however, this \acro{FAQ} +is written by highly dedicated (and, some would say, eccentric) +people. Many users find all those braces become very tedious very +quickly, and would really rather not type them all. + +An alternative structure, that doesn't violate the design of \LaTeX{}, +is to say \csx{fred}\csx{ }~--- the \csx{ } command is ``self +terminating'' (like |\|{}|\|) and you don't need braces after +\emph{it}. Thus one can reduce to one the extra characters one needs +to type. + +If even that one character is too many, the package \Package{xspace} +defines a command \csx{xspace} that guesses whether there should have +been a space after it, and if so introduces that space. So +% beware line wrap +``\texttt{fred\csx{xspace} jim}'' produces ``fred jim'', while +``\texttt{fred\csx{xspace}.\@ jim}'' produces ``fred. jim''. Which +usage would of course be completely pointless; but you can incorporate +\csx{xspace} in your own macros: +\begin{quote} +\begin{wideversion} +\begin{verbatim} +\usepackage{xspace} +... +\newcommand{\restenergy}{\ensuremath{mc^2}\xspace} +... +and we find \restenergy available to us... +\end{verbatim} +\end{wideversion} +\begin{narrowversion} +\begin{verbatim} +\usepackage{xspace} +... +\newcommand{\restenergy}% + {\ensuremath{mc^2}\xspace} +... +and we find \restenergy available to us... +\end{verbatim} +\end{narrowversion} +\end{quote} +The \csx{xspace} command must be the last thing in your macro +definition (as in the example); it's not completely foolproof, but it +copes with most obvious situations in running text. + +The \Package{xspace} package doesn't save you anything if you only use +a modified macro once or twice within your document. In any case, be +careful with usage of \csx{xspace}~--- it changes your input syntax, +which can be confusing, notably to a collaborating author +(particularly if you create some commands which use it and some which +don't). Of course, no command built into \LaTeX{} or into any +``standard'' class or package will use \csx{xspace}. +\begin{ctanrefs} +\item[xspace.sty]Distributed as part of \CTANref{2etools} +\end{ctanrefs} + +\Question[Q-overfull]{\AllTeX{} makes overfull lines} + +When \TeX{} is building a paragraph, it can make several attempts to +get the line-breaking right; on each attempt it runs the same +algorithm, but gives it different parameters. You can affect the way +\TeX{}'s line breaking works by adjusting the parameters: this answer +deals with the ``tolerance'' and stretchability parameters. The other +vital `parameter' is the set of hyphenations to be applied: see +``\Qref*[question]{my words aren't being hyphenated}{Q-nohyph}'' +(and the questions it references) for advice. + +If you're getting an undesired ``overfull box'', what has happened is +that \TeX{} has given up: the parameters you gave it don't allow it to +produce a result that \emph{doesn't} overfill. In this circumstance, +Knuth decided the best thing to do was to produce a warning, and to +allow the user to solve the problem. (The alternative, silently to go +beyond the envelope of ``good taste'' defined for this run of \TeX{}, +would be distasteful to any discerning typographer.) The user can +almost always address the problem by rewriting the text that's +provoking the problem~--- but that's not always possible, and in some +cases it's impossible to solve the problem without adjusting the +parameters. This answer discusses the approaches one might take to +resolution of the problem, on the assumption that you've got the +hyphenation correct. + +The simplest case is where a `small' word fails to break at the end of +a line; pushing the entire word to a new line isn't going to make much +difference, but it might make things just bad enough that \TeX{} won't +do it by default. In such a case on can \emph{try} the \LaTeX{} +\csx{linebreak} command: it may solve the problem, and if it does, it +will save an awful lot of fiddling. Otherwise, one needs to adjust +parameters: to do that we need to recap the details of \TeX{}'s line +breaking mechanisms. + +\TeX{}'s first attempt at breaking lines is performed without even +trying hyphenation: \TeX{} sets its ``tolerance'' of line breaking +oddities to the internal value \csx{pretolerance}, and sees what +happens. If it can't get an acceptable break, \TeX{} adds the +hyphenation points allowed by the current patterns, and tries again +using the internal \csx{tolerance} value. If this pass also fails, and +the internal \csx{emergencystretch} value is positive, \TeX{} will try +a pass that allows \csx{emergencystretch} worth of extra stretchability +to the spaces in each line. + +In principle, therefore, there are three parameters (other than +hyphenation) that you can change: \csx{pretolerance}, \csx{tolerance} +and \csx{emergencystretch}. Both the \texttt{tolerance} values are +simple numbers, and should be set by \TeX{} primitive count +assignment~--- for example +\begin{quote} +\begin{verbatim} +\pretolerance=150 +\end{verbatim} +\end{quote} +For both, an ``infinite'' tolerance is represented by the value +|10|\nothtml{\,}|000|, but infinite tolerance is rarely +appropriate, since it can lead to very bad line breaks indeed. + +\csx{emergencystretch} is a \TeX{}-internal `dimen' register, and can +be set as normal for dimens in \plaintex{}; in \LaTeX{}, use +\csx{setlength}~--- for example: +\begin{quote} +\begin{verbatim} +\setlength{\emergencystretch}{3em} +\end{verbatim} +\end{quote} + +The choice of method has time implications~--- each of the +passes takes time, so adding a pass (by changing +\csx{emergencystretch}) is less desirable than suppressing one (by +changing \csx{pretolerance}). However, it's unusual nowadays to find a +computer that's slow enough that the extra passes are really +troublesome. + +In practice, \csx{pretolerance} is rarely used other than to manipulate +the use of hyphenation; \plaintex{} and \LaTeX{} both set its value +to |100|. To suppress the first scan of paragraphs, set +\csx{pretolerance} to |-1|. + +\csx{tolerance} is often a good method for adjusting spacing; +\plaintex{} and \LaTeX{} both set its value to |200|. \LaTeX{}'s +\csx{sloppy} command sets it to |9999|, as does the +\environment{sloppypar} environment. This value is the largest +available, this side of infinity, and can allow pretty poor-looking +breaks (this author rarely uses \csx{sloppy} ``bare'', though he does +occasionally use \environment{sloppypar}~--- that way, the change of +\csx{tolerance} is confined to the environment). More satisfactory is +to make small changes to \csx{tolerance}, incrementally, and then to look to +see how the change affects the result; very small increases can often +do what's necessary. Remember that \csx{tolerance} is a paragraph +parameter, so you need to ensure it's actually applied~--- see +``\Qref*[question]{ignoring paragraph parameters}{Q-paraparam}''. +\LaTeX{} users could use an environment like: +\begin{quote} +\begin{verbatim} +\newenvironment{tolerant}[1]{% + \par\tolerance=#1\relax +}{% + \par +} +\end{verbatim} +\end{quote} +enclosing entire paragraphs (or set of paragraphs) in it. + +The value of \csx{emergencystretch} is added to the assumed +stretchability of each line of a paragraph, in a further run of the +paragraph formatter in case that the paragraph can't be made to look +right any other way. (The extra scan happens if +\csx{emergencystretch\textgreater0pt}~--- if it's zero or negative, no gain +could be had from rerunning the paragraph setter.) The example above +set it to \texttt{3em}; the Computer Modern fonts ordinarily fit three +space skips to the \texttt{em}, so the change would allow anything up +to the equivalent of nine extra spaces in each line. In a line with +lots of spaces, this could be reasonable, but with (say) only three +spaces on the line, each could stretch to four times its natural +width. It is therefore clear that \csx{emergencystretch} needs to be +treated with a degree of caution. + +More subtle (but more tricky to manage) are the microtypographic +extensions provided by \PDFTeX{}. Since \PDFTeX{} is the default +`engine' for \LaTeX{} and \CONTeXT{} work in all distributions, +nowadays, the extensions are available to all. There are two +extensions, margin kerning and font expansion; margin kerning only +affects the visual effect of the typeset page, and has little effect +on the ability of the paragraph setter to ``get things right''. +Font expansion works like a subtler version of the trick that +\csx{emergencystretch} plays: \PDFTeX{} `knows' that your current font +may be stretched (or shrunk) to a certain extent, and will do that +``on the fly'' to optimise the setting of a paragraph. This is a +powerful tool in the armoury of the typesetter. + +As mentioned above, the microtypographic extensions are tricky beasts +to control; however, the \Package{microtype} package relieves the user +of the tedious work of specifying how to perform margin adjustments +and how much to scale each font~\dots{}\@ for the fonts the package +knows about; it's a good tool, and users who can take on the +specification of adjustments for yet more fonts are always welcome. +\begin{ctanrefs} +\item[microtype.sty]\CTANref{microtype} +\end{ctanrefs} + +\Question[Q-exscale]{Maths symbols don't scale up} + +By default, the ``large'' maths symbols stay at the same size +regardless of the font size of the text of the document. There's good +reason for this: the \FontName{cmex} fonts aren't really designed to +scale, so that \TeX{}'s maths placement algorithms don't perform as +well as they might when the fonts are scaled. + +However, this behaviour confounds user expectations, and can lead to +slightly odd-looking documents. If you want the fonts to scale, +despite the warning above, use the \Package{exscale} package~--- just +loading it is enough. +%% +%% (Note: if you are using bitmap versions of the \FontName{cmex} fonts, +%% you will find extra bitmaps are generated. The extended sizes are not +%% ordinarily generated for any other purpose.) +\begin{ctanrefs} +\item[exscale.sty]Part of the \LaTeX{} distribution. +\end{ctanrefs} + +\Question[Q-linespread]{Why doesn't \csx{linespread} work?} + +The command \cmdinvoke*{linespread}{factor} is supposed to multiply +the current \csx{baselineskip} by \meta{factor}; but, to all +appearances, it doesn't. + +In fact, the command is equivalent to +\cmdinvoke{renewcommand}{\csx{baselinestretch}}{factor}: written that +way, it somehow feels less surprising that the effect isn't immediate. +The \csx{baselinestretch} factor is only used when a font is selected; +a mere change of \csx{baselinestretch} doesn't change the font, any +more than does the command +\cmdinvoke*{fontsize}{size}{baselineskip}~--- you have to follow +either command with \csx{selectfont}. So: +\begin{quote} +\begin{verbatim} +\fontsize{10}{12}% +\selectfont +\end{verbatim} +\end{quote} +or: +\begin{quote} +\begin{verbatim} +\linespread{1.2}% +\selectfont +\end{verbatim} +\end{quote} +Of course, a package such as \Package{setspace}, whose job is to +manage the baseline, will deal with all this stuff~--- see +``\Qref*[question]{managing double-spaced documents}{Q-linespace}''. If +you want to avoid \Package{setspace}, beware the behaviour of +linespread changes within a paragraph: read % ! line break +``\Qref*[question]{\csx{baselineskip} is a paragraph parameter}{Q-baselinepar}''. +\begin{ctanrefs} +\item[setspace.sty]\CTANref{setspace} +\end{ctanrefs} + +\Question[Q-baselinepar]{Only one \csx{baselineskip} per paragraph} + +The \csx{baselineskip} is not (as one might hope) a property of a +line, but of a paragraph. As a result, in a \texttt{10pt} (nominal) +document (with a default \csx{baselineskip} of \texttt{12pt}), a +single character with a larger size, as: +\begin{quote} +\begin{verbatim} +{\Huge A} +\end{verbatim} +\end{quote} +will be squashed into the paragraph: \TeX{} will make sure it doesn't +scrape up against the line above, but won't give it ``room to +breathe'', as it does the text at standard size; that is, its size +(\texttt{24.88pt}) is taken account of, but its \csx{baselineskip} +(\texttt{30pt}) isn't. Similarly +\begin{quote} +\begin{verbatim} +Paragraph text ... +{\footnotesize Extended interjection ... + ... into the paragraph.} + ... paragraph continues ... +\end{verbatim} +\end{quote} +will look silly, since the \texttt{8pt} interjection will end up set +on the \texttt{12pt} \csx{baselineskip} of the paragraph, rather than +its preferred \texttt{8.5pt}. Finally, something like +\begin{quote} +\begin{verbatim} +Paragraph text ... + ... paragraph body ends. +{\footnotesize Short comment on paragraph.} + +Next paragraph starts... +\end{verbatim} +\end{quote} +will set the body of the first paragraph on the constricted +\csx{baselineskip} of the \csx{footnotesize} comment. + +So, how to deal with these problems? The oversized (short) section is +typically corrected by a \emph{strut}: this word comes from movable +metal typography, and refers to a spacer that held the boxes (that +contained the metal character shapes) apart. Every time you change +font size, \LaTeX{} redefines the command \csx{strut} to provide the +equivalent of a metal-type strut for the size chosen. So for the +example above, we would type +\begin{quote} +\begin{verbatim} +Paragraph text ... + {\Huge A\strut} + ... paragraph continues ... +\end{verbatim} +\end{quote} +However, more extended insertions (whether of larger or smaller text) +are always going to cause problems; while you can strut larger text, +ensuring that you strut every line will be tiresome, and there's no +such thing as a ``negative strut'' that pulls the lines together for +smaller text. + +The only satisfactory way to deal with an extended insertion at a +different size is to set it off as a separate paragraph. A +satisfactory route to achieving this is the \environment{quote} +environment, which sets its text modestly inset from the enclosing +paragraph: +\begin{quote} +\begin{verbatim} +Paragraph text ... +\begin{quote} + \footnotesize This is an inset account + of something relevant to the enclosing + paragraph... +\end{quote} +... paragraph continues ... +\end{verbatim} +\end{quote} +Such quote-bracketing also deals with the problem of a trailing +comment on the paragraph. + +\Question[Q-tocloftwrong]{Numbers too large in table of contents, etc.} + +\LaTeX{} constructs the table of contents, list of figures, tables, +and similar tables, on the basis of a layout specified in the class. +As a result, they do \emph{not} react to the sizes of things in them, +as they would if a \environment{tabular} environment (or something +similar) was used. + +This arrangement can provoke problems, most commonly with deep section +nesting or very large page numbers: the numbers in question just don't +fit in the space allowed for them in the class. + +A separate answer discusses % ! line break +\nothtml{re-designing the tables ---} % ! line break +\Qref{re-designing the tables}{Q-tocloft}\nothtml{ ---} +and those techniques can be employed to make the numbers fit. + +\Question[Q-gutter]{Why is the inside margin so narrow?} + +If you give the standard classes the \pkgoption{twoside} option, the +class sets the margins narrow on the left of odd-numbered pages, and +on the right of even-numbered pages. This is often thought to look +odd, but it is quite right. + +The idea is that the typographic urge for symmetry should also apply +to margins: if you lay an even numbered page to the left of an +odd-numbered one, you will see that you've three equal chunks of +un-printed paper: the left margin of the even page, the right margin +of the odd page, and the two abutting margins together. + +This is all very fine in the abstract, but in practical book(let) +production it only works ``sometimes''. + +If your booklet is produced on double-width paper and stapled, the +effect will be good; if your book(let) is produced using a so-called +``perfect'' binding, the effect will again be good. + +However, almost any ``quality'' book-binder will need some of your +paper to grab hold of, and a book bound in such a way won't exhibit +the treasured symmetry unless you've done something about the margin +settings. + +The packages recommended in % ! line break +``\Qref*{setting up margins}{Q-marginpkgs}'' mostly have provision for +a ``binding offset'' or a ``binding correction''~--- search for +``binding'' in the manuals (\Package{vmargin} doesn't help, here). + +If you're doing the job by hand (see % ! line break +\Qref[question]{manual margin setup}{Q-marginmanual}), the trick is to +calculate your page and margin dimensions as normal, and then: +\begin{itemize} +\item subtract the binding offset from \csx{evensidemargin}, and +\item add the binding offset to \csx{oddsidemargin}. +\end{itemize} +which can be achieved by: +\begin{quote} +\begin{verbatim} +\addtolength{\evensidemargin}{-offset} +\addtolength{\oddsidemargin}{offset} +\end{verbatim} +\end{quote} +(substituting something sensible like ``\texttt{5mm}'' for +``\texttt{offset}'', above). + +The above may not be the best you can do: you may well choose to +change the \csx{textwidth} in the presence of the binding offset; but +the changes do work for constant \csx{textwidth}. + +\subsection{Why shouldn't I?} + +\Question[Q-t1enc]{Why use \Package{fontenc} rather than \Package{t1enc}?} + +In the very earliest days of \LaTeXe{}, the only way to use the +\acro{T}1 encoding was \Package{t1enc}; with the summer 1994 +``production'' release, the \Package{fontenc} package appeared, and +provided comprehensive support for use of the encoding. + +Nevertheless, the \Package{t1enc} package remains (as part of the +\LaTeXo{} compatibility code), but it does very little: it merely +selects font encoding \acro{T}1, and leaves to the user the business +of generating the character codes required. + +Generating such character codes could be a simple matter, \emph{if} +the \acro{T}1 encoding matched any widely-supported encoding standard, +since in that case, one might expect one's keyboard to generate the +character codes. However, the \acro{T}1 encoding is a mix of several +standard encodings, and includes code points in areas of the table +which standard encodings specifically exclude, so no \acro{T}1 +keyboards have been (or ever will be) manufactured. + +By contrast, the \Package{fontenc} package generates the \acro{T}1 +code points from ordinary \LaTeX{} commands (e.g., it generates the +\texttt{\'e} character codepoint from the command |\'|{}|e|). So, unless you +have program-generated \acro{T}1 input, use +\cmdinvoke{usepackage}[T1]{fontenc} rather than +\cmdinvoke{usepackage}{t1enc}. + +\Question[Q-why-inp-font]{Why bother with \Package{inputenc} and \Package{fontenc}?} + +The standard input encoding for Western Europe (pending the arrival of +Unicode) is \acro{ISO}~8859--1 (commonly known by the standard's +subtitle `Latin-1'). Latin-1 is remarkably close, in the codepoints +it covers, to the \AllTeX{} \acro{T}1 encoding. + +In this circumstance, why should one bother with \Package{inputenc} +and \Package{fontenc}? Since they're pretty exactly mirroring each +other, one could do away with both, and use just \Package{t1enc}, +despite its \Qref*{shortcomings}{Q-t1enc}. + +One doesn't do this for a variety of small reasons: +\begin{description} +\item[Confusion] You've been happily working in this mode, and for + some reason find you're to switch to writing in German: the effect + of using ``\texttt{\ss}'' is somewhat startling, since \acro{T}1 + and Latin-1 treat the codepoint differently. +\item[Compatibility] You find yourself needing to work with a + colleague in Eastern Europe: their keyboard is likely to be set to + produce Latin-2, so that the simple mapping doesn't work. +\item[Traditional \LaTeX{}] You lapse and write something like + |\'|{}|e| rather than typing \texttt{\'e}; only \Package{fontenc} + has the means to convert this \LaTeX{} sequence into the \acro{T}1 + character, so an \csx{accent} primitive slips through into the + output, and hyphenation is in danger. +\end{description} +The \Package{inputenc}--\Package{fontenc} combination seems slow and +cumbersome, but it's safe. + +\Question[Q-eqnarray]{Why not use \environment{eqnarray}?} + +The environment \environment{eqnarray} is attractive for the +occasional user of mathematics in \LaTeX{} documents: it seems to +allow aligned systems of equations. Indeed it \emph{does} supply such +things, but it makes a serious mess of spacing. In the system: +\begin{quote} +\begin{verbatim} +\begin{eqnarray} + a & = & b + c \\ + x & = & y - z +\end{eqnarray} +\end{verbatim} +\end{quote} +the spacing around the ``='' signs is \emph{not} that defined in the +metrics for the font from which the glyph comes~--- it's +\csx{arraycolsep}, which may be set to some very odd value for reasons +associated with real arrays elsewhere in the document. + +The user is far better served by the \AMSLaTeX{} bundle, which +provides an \environment{align} environment, which is designed with +the needs of mathematicians in mind (as opposed to the convenience of +\LaTeX{} programmers). For this simple case (align is capable of far +greater things), code as: +\begin{quote} +\begin{verbatim} +\begin{align} + a & = b + c \\ + x & = y - z +\end{align} +\end{verbatim} +\end{quote} +The matter is discussed in more detail in a % ! line break +\href{http://tug.org/pracjourn/2006-4/madsen/madsen.pdf}{Prac\TeX{} journal paper} +by Lars Madsen. +\begin{ctanrefs} +\item[AMSLaTeX]\CTANref{amslatex} +\end{ctanrefs} + +\Question[Q-dolldoll]{Why use \csx{[}\,\dots{}\csx{]} in place of \texttt{\$\$}\,\dots{}\texttt{\$\$}?} + +\LaTeX{} defines inline- and display-maths commands, apparently +s those that derive from the \TeX{} primitive maths +sequences bracketing maths commands with single (or pairs of) dollar signs. + +As it turns out, \LaTeX{}'s inline maths grouping, % !line break +\csx{(}\texttt{ ... }\csx{)}, has precisely the same effect as the +\TeX{} primitive version \texttt{\$ ... \$}. (Except that +the \LaTeX{} version checks to ensure you don't put \csx{(} and +\csx{)} the wrong way round.) + +In this circumstance, one often finds \LaTeX{} users, who have some +experience of using \plaintex{}, merely assuming that \LaTeX{}'s +display maths grouping \csx{[}\texttt{ ... }\csx{]} may be replaced by +the \TeX{} primitive display maths \texttt{\$\$ ... \$\$}. + +Unfortunately, they are wrong: if \LaTeX{} code is going to patch display +maths, it can only do so by patching \csx{[} and \csx{]}. The most +obvious way this turns up, is that the class option \pkgoption{fleqn} +simply does not work for equations coded using % ! line break +\texttt{\$\$ ... \$\$}, whether you're using the standard classes +alone, or using package \Package{amsmath}. Also, the \csx{[} and +\csx{]} construct has code for rationalising vertical spacing in some extreme +cases; that code is not available in \texttt{\$\$ ... \$\$}, so if you +use the non-standard version, you may occasionally observe +inconsistent vertical spacing . + +There are more subtle effects (especially with package +\Package{amsmath}), and the simple rule is ``use % ! line break +\csx{[}\texttt{ ... }\csx{]} whenever displayed maths is needed in +\LaTeX{}''. + +\Question[Q-2letterfontcmd]{What's wrong with \csx{bf}, \csx{it}, etc.?} + +The font-selection commands of \LaTeXo{} were \csx{rm}, \csx{sf}, +\csx{tt}, \csx{it}, \csx{sl}, \csx{em} and \csx{bf}; they were modal +commands, so you used them as: +\begin{quote} +\begin{verbatim} +{\bf Fred} was {\it here\/}}. +\end{verbatim} +\end{quote} +with the font change enclosed in a group, so as to limit its effect; +note the italic correction command \csx{/} that was necessary at the +end of a section in italics. + +At the release of \LaTeXe{} in summer 1994, these simple commands were +deprecated, but recognising that their use is deeply embedded in the +brains of \LaTeX{} users, the commands themselves remain in \LaTeX{}, +\emph{with their \LaTeXo{} semantics}. Those semantics were part of +the reason they were deprecated: each |\|\emph{\texttt{xx}} overrides +any other font settings, keeping only the size. So, for example, +\begin{quote} +\begin{verbatim} +{\bf\it Here we are again\/} +\end{verbatim} +\end{quote} +ignores \csx{bf} and produces text in italic, medium weight (and the +italic correction has a real effect), whereas +\begin{quote} +\begin{verbatim} +{\it\bf happy as can be\/} +\end{verbatim} +\end{quote} +ignore \csx{it} and produces upright text at bold weight (and the +italic correction has nothing to do). The same holds if you mix +\LaTeXe{} font selections with the old style commands: +\begin{quote} +\begin{verbatim} +\textbf{\tt all good friends} +\end{verbatim} +\end{quote} +ignores the \csx{textbf} that encloses the text, and produces +typewriter text at medium weight. + +So why are these commands deprecated?~--- it is because of confusions +such as that in the last example. The alternative (\LaTeXe{}) +commands are discussed in the rest of this answer. + +\LaTeXe{}'s font commands come in two forms: modal commands and +text-block commands. The default set of modal commands offers weights +\csx{mdseries} and \csx{bfseries}, shapes \csx{upshape}, +\csx{itshape}, \csx{scshape} and \csx{slshape}, and families +\csx{rmfamily}, \csx{sffamily} and \csx{ttfamily}. A font selection +requires a family, a shape and a series (as well as a size, of +course). A few examples +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +{\bfseries\ttfamily + and jolly good company!} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +{\bfseries\ttfamily and jolly good company!} +\end{verbatim} +\end{wideversion} +\end{quote} +produces bold typewriter text (but note the lack of a % ! line break, big time +\begin{narrowversion} % non hyper version + bold typewriter font~--- \Qref{}{Q-bold-extras}~--- +\end{narrowversion} +\begin{wideversion} + \Qref{bold typewriter font}{Q-bold-extras} +\end{wideversion} +in the default Computer Modern fonts), or +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +{\slshape\sffamily + Never mind the weather\/} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +{\slshape\sffamily Never mind the weather\/} +\end{verbatim} +\end{wideversion} +\end{quote} +(note the italic correction needed on slanted fonts, too). + +\LaTeXe{}'s text block commands take the first two letters of the +modal commands, and form a \csx{text}\emph{\texttt{xx}} command from +them. Thus \csx{bfseries} becomes \cmdinvoke*{textbf}{text}, +\csx{itshape} becomes \cmdinvoke*{textit}{text}, and \csx{ttfamily} +becomes \cmdinvoke*{texttt}{text}. Block commands may be nested, as: +\begin{quote} +\begin{verbatim} +\textit{\textbf{Never mind the rain}} +\end{verbatim} +\end{quote} +to produce bold italic text (note that the block commands supply +italic corrections where necessary), and they be nested with the +\LaTeXe{} modal commands, too: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +\texttt{\bfseries + So long as we're together} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +\texttt{\bfseries So long as we're together} +\end{verbatim} +\end{wideversion} +\end{quote} +for bold typewriter, or +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +{\slshape\textbf{% + Whoops! she goes again}\/} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +{\slshape \textbf{Whoops! she goes again}\/} +\end{verbatim} +\end{wideversion} +\end{quote} +for a bold slanted instance of the current family (note the italic +correction applied at the end of the modal command group, again). + +The new commands (as noted above) override commands of the same type. +In almost all cases, this merely excludes ludicrous ideas such as +``upright slanted'' fonts, or ``teletype roman'' fonts. There are a +couple of immediate oddities, though. The first is the conflict +between \csx{itshape} (or \csx{slshape}) and \csx{scshape}: while many +claim that an italic small-caps font is typographically unsound, such +fonts do exist. Daniel Taupin's \Package{smallcap} package enables +use of the instances in the \Qref*{\acro{EC} fonts}{Q-ECfonts}, and +similar techniques could be brought to bear on many other font sets. +The second is the conflict between \csx{upshape} and \csx{itshape}: +Knuth actually offers an upright-italic font which \LaTeX{} uses for +the ``\pounds{}'' symbol in the default font set. The combination is +sufficiently weird that, while there's a defined font shape, no +default \LaTeX{} commands exist; to use the shape, the (eccentric) user +needs \LaTeX{}'s simplest font selection commands: +\begin{quote} +\begin{narrowversion} +\begin{verbatim} +{\fontshape{ui}\selectfont + Tra la la, di dee} +\end{verbatim} +\end{narrowversion} +\begin{wideversion} +\begin{verbatim} +{\fontshape{ui}\selectfont Tra la la, di dee} +\end{verbatim} +\end{wideversion} +\end{quote} +\begin{ctanrefs} +\item[smallcap.sty]\CTANref{smallcap} +\end{ctanrefs} + +\Question[Q-newfont*]{What's wrong with \csx{newfont}?} + +If all else fails, you \emph{can} specify a font using the \LaTeX{} +\csx{newfont} command. The font so specified doesn't fit into the +\LaTeX{} font selection mechanism, but the technique can be tempting +under several circumstances. The command is merely the thinnest of +wrappers around the \csx{font} primitive, and doesn't really fit with +\LaTeX{} at all. A simple, but really rather funny, example of the +problems it poses, may be seen in: +\begin{quote} +\begin{verbatim} +\documentclass[10pt]{article} +\begin{document} +\newfont{\myfont}{cmr17 scaled 2000} +\myfont +\LaTeX +\end{document} +\end{verbatim} +\end{quote} +(the reader is encouraged to try this). The ``A'' of \csx{LaTeX} pretty +much disappears: \LaTeX{} chooses the size on the ``A'' according to +\emph{its} idea of the font size (10pt), but positions it according to +the dimensions of ``\csx{myfont}'', which is more than three times +that size. + +Another ``\csx{myfont}'' example arises from an entirely different +source. The mini-document: +\begin{quote} +\begin{verbatim} +\documentclass{article} +\begin{document} +\newfont{\myfont}{ecrm1000} +{\myfont voil\`a} +\end{document} +\end{verbatim} +\end{quote} +gives you ``German low double quotes'' (under the ``a'') in place of +the grave accent. This happens because \FontName{ecrm1000} is in a +different \Qref*{font encoding}{Q-whatenc} than \LaTeX{} is +expecting~--- if you use the \LaTeX{} \Package{fontenc} package to +select the \acro{EC} fonts, all these tiresome encoding issues are +solved for you, behind the scenes. + +There does however remain a circumstance when you will be tempted to +use \csx{newfont}~--- viz., to get a font size that doesn't fall into +the Knuth standard set of sizes: \LaTeX{} (by default) won't allow you +to use such a size. Don't despair: see the answer % ! line break +``\Qref*{arbitrary font sizes}{Q-fontsize}''. + + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq.sty b/Master/texmf-dist/doc/generic/FAQ-en/faq.sty index 111c3f121d6..16ced807719 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq.sty +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq.sty @@ -579,33 +579,45 @@ \newcommand{\CTANdirectory}{\@ifstar\@CTANdirectory\@CTANdirectory} \fi \newcommand{\@CTANdirectory}[2]{\@ifundefined{ctan-#1}{% - \expandafter\gdef\csname ctan-#1\endcsname{\@CTAN\LocalCTAN{#2}\CTANDirFmt}% -}{% - \PackageWarningNoLine{faq}{Repeated definition of label: #1}% - \stepcounter{CTAN@replabs}% -}} -\ifpdf - \newcommand{\@sCTANdirectory}[2]{\@ifundefined{ctan-#1}{% - \expandafter\gdef\csname ctan-#1\endcsname{\@CTAN\LocalCTAN{#2}/}% + \expandafter\gdef\csname ctan-#1\endcsname{\@CTAN\LocalCTAN{#2}\CTANDirFmt}% }{% \PackageWarningNoLine{faq}{Repeated definition of label: #1}% \stepcounter{CTAN@replabs}% - }} + }% + \@faq@disposeopt +} +\ifpdf + \newcommand{\@sCTANdirectory}[2]{\@ifundefined{ctan-#1}{% + \expandafter\gdef\csname ctan-#1\endcsname{\@CTAN\LocalCTAN{#2}/}% + }{% + \PackageWarningNoLine{faq}{Repeated definition of label: #1}% + \stepcounter{CTAN@replabs}% + }% + \@faq@disposeopt + } \fi % % a package in a single file (the same appearance, but the WWW -- and % ultimately the pdf -- versions are different). \ifpdf \newcommand{\CTANfile}[2]{\@ifundefined{ctan-#1}{% - \expandafter\gdef\csname ctan-#1\endcsname{\@CTAN\LocalCTAN{#2}{}}% -}{% - \PackageWarningNoLine{faq}{Repeated definition of label: #1}% - \stepcounter{CTAN@replabs}% -}} + \expandafter\gdef\csname ctan-#1\endcsname{\@CTAN\LocalCTAN{#2}{}}% + }{% + \PackageWarningNoLine{faq}{Repeated definition of label: #1}% + \stepcounter{CTAN@replabs}% + }% + \@faq@disposeopt +} \else \let\CTANfile\CTANdirectory \fi % +% get rid of optional catalogue pointer in \CTAN(directory|file) +\newcommand\@faq@disposeopt{% + \@ifnextchar[\@faq@gobbleopt{}% ] +} +\def\@faq@gobbleopt[#1]{} +% % Make reference to a CTAN package % % counters for the undefined references and repeated labels @@ -986,6 +998,9 @@ \@gobble } % +% date question last edited +\def\LastEdit{\@ifstar\@gobble\@gobble} +% % \Qlabel and \Qref: define and refer to labels \ifpdf % hyperref version of \label doesn't get set until begin document @@ -1075,8 +1090,6 @@ % \cmdinvoke\cs<argument sequence> % \cs typeset as above % <argument sequence> may consist of optional or mandatory arguments; -% so far only "one mandatory" and "one optional, one mandatory" -% are supported by texfaq2html % % the `arguments' are simply typesett \texttt, as yet -- if something % fancier is needed, there's a bunch of code needs rewriting here... diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faqbody.tex b/Master/texmf-dist/doc/generic/FAQ-en/faqbody.tex deleted file mode 100644 index 2fd9eff8f33..00000000000 --- a/Master/texmf-dist/doc/generic/FAQ-en/faqbody.tex +++ /dev/null @@ -1,25397 +0,0 @@ -\def\faqfileversion{3.19} \def\faqfiledate{2009-06-10} -% -% The above line defines the file version and date, and must remain -% the first line with any `assignment' in the file, or things will -% blow up in a stupid fashion -% -% get lists of CTAN labels -% -% configuration for the lists, if we're going to need to generate urls -% for the files -\InputIfFileExists{archive.cfg}{}{} -% -% ... directories -\input{dirctan} -% -% ... files -\input{filectan} - -% this environment is for the benefit of new-style file generation -\begin{introduction} -% suppress section numbers until end environment -\nothtml{\csname c@secnumdepth\endcsname=-1 } -\section{Introduction} - -This is a set of Frequently Asked Questions (\acro{FAQ}) for -English-speaking users of \TeX{}. The questions answered here cover -a wide range of topics, but the actual typesetting issues are mostly -covered from the viewpoint of a \LaTeX{} user. - -You may use the \acro{FAQ} -\begin{itemize} -\item by reading a printed document, -\item by viewing a \acro{PDF} file, with hyperlinks to assist - browsing: copies are available formatted for printing on - \CTANhref{faq-a4}{A4 paper} or on % ! line break - \CTANhref{faq-letter}{North American ``letter'' paper}, or -\item by using the \acro{FAQ}'s web interface (base \acro{URL}: - \URL{http://www.tex.ac.uk/faq}); this version provides simple - search capabilities, as well as a link to Google for a more - sophisticated search restricted to the \acro{FAQ} itself, or -\item via Scott Pakin's \CTANhref{visualFAQ}{Visual FAQ}. -\end{itemize} - -\subsection{Finding the Files} - -Unless otherwise specified, all files mentioned in this \acro{FAQ} -are available from a \acro{CTAN} archive, or from a mirror of -\acro{CTAN}~--- see \Qref[question]{later discussion}{Q-archives}% ! space -\narrowonly{, which gives details} of the \acro{CTAN} -archives\wideonly{ and}\narrowonly{, including} how to retrieve files -from them. If you don't have access to the internet, the -\Qref*{\texlive{} distribution}{Q-CD} offers off-line snapshots of the -archives. - -The reader should also note that the first directory name of the -path name of every file on \acro{CTAN} is omitted from what -follows, for the simple reason that, while it's always the same -(\path{tex-archive/}) on the main sites, mirror sites often choose -something else. - -To avoid confusion, we also omit the full stop from the end of -any sentence whose last item is a path name (such sentences are -rare, and only occur at the end of paragraphs). Though the path -names are set in a different font from running text, it's not easy -to distinguish the font of a single dot! - -\latexhtml{\subsection*{Origins}}{\textbf{Origins}} - -The \acro{FAQ} was originated by the Committee of the \acro{UK} -\TeX{} Users' Group (\acro{UK}~\acro{TUG}) as a development of a -regular posting to the \emph{Usenet} newsgroup -\Newsgroup{comp.text.tex} that was maintained for some time by Bobby -Bodenheimer. The first \acro{UK} version was much re-arranged and -corrected from the original, and little of Bodenheimer's work now -remains. - -The following people (at least~--- there are almost certainly others -whose names weren't correctly recorded) have contributed help or -advice on the development of the \acro{FAQ}: Donald Arseneau, -Rosemary Bailey, % lots of initial set of maths answers -Barbara Beeton, % one of first reviewers outside cttee -Karl Berry, % often provides comments & suggestions -Giuseppe Bilotta, -Charles Cameron, -Fran\c{c}ois Charette, % update of q-xetex -Damian Cugley, -Michael Dewey, -Michael Downes, % (RIP) on (ams)maths stuff -Jean-Pierre Drucbert, % corrected my interpretation of minitoc -Michael Ernst, % alert on confusing colloquialism -Thomas Esser, -Ulrike Fischer, % spotted boondoggle in q-tabcellalign - % args like \section improvement; general typos -Anthony Goreham, -Norman Gray, -Eitan Gurari, % comparative html translators -William Hammond, % lots of work on xml-related answers -John Harper, % patient help with q-robust ;-) -John Hammond, % corrections to q-protect -Troy Henderson, % metapost tutorials update -Hartmut Henkel, -Stephan Hennig, % text about vc in Q-RCS -John Hobby, -Morten H\textoslash gholm, % eagle eyes in search for problems -Berthold Horn, % lots of stuff on fonts -Ian Hutchinson, % comparative html translators -Werner Icking, % (RIP) answer on tex-music -William Ingram, % extension of transcinit -Alan Jeffrey, % another founding father -Regnor Jernsletten, -David Kastrup, % inter alia, suggested mention of lilypond -Oleg Katsitadze, % revision of q-eplain -Isaac Khabaza, % kindersley book -Ulrich Klauer, % pointed out twaddle in TeXpronounce -Markus Kohm, % help with functionality of Koma-script -Stefan Kottwitz % picked up text of q-wideflt -David Kraus, % help with tocbibind (spotted embarrassing typo :-} ) -Ryszard Kubiak, % comment about q-driver -Simon Law, -Daniel Luecking, -Aditya Mahajan, % rewrite of q-context -Sanjoy Mahajan, -Andreas Matthias, -Brooks Moses, % editorial suggestion -Iain Murray, % alternative solution in q-hyperdupdest -Vilar Camara Neto, % explain breakurl pkg, suggest use of numprint -Dick Nickalls, -Ted Nieland, -Hans Nordhaug, -Pat Rau, -Heiko Oberdiek, -Piet van Oostrum, -Scott Pakin, -Oren Patashnik, -Manuel P\'egouri\'e-Gonnard, % improvement of q-luatex -Steve Peter, % comprehensive review, lots of typos etc -Sebastian Rahtz, % without whom there would be no... -Philip Ratcliffe, % help with a bibtex oddity -Chris Rowley, % founding father -Jos\'e Carlos Santos, % assiduous reader of new versions -Walter Schmidt, -Hans-Peter Schr\"ocker, -Joachim Schrod, -Maarten Sneep, % summary of c.t.t thread for outszwrng, inter alia -Axel Sommerfeldt, % suggested rewrite of q-hyperdupdest -Philipp Stephani, % xlation of komascript keyval stuff -James Szinger, % who responded on c.t.t to request for answer -Ulrik Vieth, -Mike Vulis, -Chris Walker, % revtex alert, ite suggestion (q-labelfig) -Peter Wilson, % several, incl functionality of memoir -Joseph Wright, % help with keyval -Rick Zaccone and -Reinhard Zierke. -\end{introduction} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{The Background} - -\Question[Q-whatTeX]{What is \TeX{}?} - -\TeX{} is a typesetting system written by -\href{http://sunburn.stanford.edu/~knuth/}{Donald E. Knuth}, who -says in the Preface to his book on \TeX{} -(see \Qref[question]{books about TeX}{Q-books}) that it is -%% !line wrap avoided by two commands -``\emph{intended for the creation of beautiful books~---} -\emph{and especially for books that contain a lot of mathematics}''. -(If \TeX{} were \emph{only} good for mathematical books, much of its -use nowadays would not happen: it's actually a pretty good general -typesetting system.) - -Knuth is Emeritus Professor of the Art of Computer Programming at -Stanford University in California, \acro{USA}. Knuth developed the -first version of \TeX{} in 1978 to deal with revisions to his series -``the Art of Computer Programming''. The idea proved popular and -Knuth produced a second version (in 1982) which is the basis of what -we use today. - -Knuth developed a system of % ! line breaks -`\Qref*{literate programming}{Q-lit}' to write \TeX{}, -and he provides the literate (\acro{WEB}) source of \TeX{} free of charge, -together with tools for processing the |web| source into something -that can be compiled and something that can be printed; there's never -any mystery about what \TeX{} does. Furthermore, the \acro{WEB} system -provides mechanisms to port \TeX{} to new operating systems and -computers; and in order that one may have some confidence in the ports, -Knuth supplied a \Qref*{test}{Q-triptrap} by -means of which one may judge the fidelity of a \TeX{} system. \TeX{} -and its documents are therefore highly portable. - -\TeX{} is a macro processor, and offers its users a powerful -programming capability. For this reason, \TeX{} on its own is a -pretty difficult beast to deal with, so Knuth provided a package of -macros for use with \TeX{} called \plaintex{}; \plaintex{} is -effectively the minimum set of macros one can usefully employ with -\TeX{}, together with some demonstration versions of higher-level -commands (the latter are better regarded as models than used as-is). -When people say they're ``programming in \TeX{}'', they usually mean -they're programming in \plaintex{}. - -\Question[Q-TeXpronounce]{How should I pronounce ``\TeX{}''?} - -The `X' is ``really'' the Greek letter % ! line break -Chi\nothtml{ (\ensuremath{\chi}, in lower case)}, and is pronounced by -English-speakers either a bit like the `ch' in the Scots word `loch' -([x] in the IPA) or (at a pinch, if you can't do the Greek sound) like -`k'. It definitely is not pronounced `ks' (the Greek letter with that -sound doesn't look remotely like the Latin alphabet `X'). - -This curious usage derives from Knuth's explanation in the \TeX{}book -that the name comes from the Greek word for `art' or `craft' -(`\latexhtml{\ensuremath{\tau\epsilon\chi\nu\eta}}{\emph{techni}}'), -which is the root of the English word `technology'. Knuth's logo for \TeX{} is -merely the uppercase version of the first three (Greek) letters of the -word, jiggled about a bit; we don't use that logo (and logos like it) -in this \acro{FAQ} (see % ! line break -\Qref[question]{Typesetting \TeX{}-related logos}{Q-logos}). - -\Question[Q-MF]{What is \MF{}?} - -\MF{} was written by Knuth as a companion to \TeX{}; whereas \TeX{} -defines the layout of glyphs on a page, \MF{} defines the shapes of -the glyphs and the relations between them. \MF{} details the sizes of -glyphs, for \TeX{}'s benefit, and details the rasters used to -represent the glyphs, for the benefit of programs that will produce -printed output as post processes after a run of \TeX{}. - -\MF{}'s language for defining fonts permits the expression of several -classes of things: first (of course), the simple geometry of the -glyphs; second, the properties of the print engine for which the -output is intended; and third, `meta'-information which can -distinguish different design sizes of the same font, or the difference -between two fonts that belong to the same (or related) families. - -Knuth (and others) have designed a fair range of fonts using \MF{}, -but font design using \MF{} is much more of a minority skill than is -\TeX{} macro-writing. The complete \TeX{}-user nevertheless needs to -be aware of \MF{}, and to be able to run \MF{} to generate personal -copies of Meta-fonts that come her way. - -\Question[Q-MP]{What is \MP{}?} - -The \MP{} system (by John Hobby) implements a picture-drawing language -very much like that of \MF{} except that it outputs Encapsulated \PS{} -files instead of run-length-encoded bitmaps. \MP{} is a powerful -language for producing figures for documents to be printed on \PS{} -printers, either directly or embedded in \AllTeX{} documents. It -includes facilities for directly integrating \TeX{} text and -mathematics with the graphics. (Knuth tells us that he uses nothing -but \MP{} for diagrams in text that he is writing.) - -Although \PDFLaTeX{} cannot ordinarily handle \PS{} graphics, the -output of \MP{} is sufficiently simple and regular that \PDFLaTeX{} -can handle it direct, using code borrowed from \CONTeXT{}~--- see -\Qref[question]{graphics in \PDFLaTeX{}}{Q-pdftexgraphics}. - -Much of \MP{}'s source code was copied from \MF{}'s sources, with -Knuth's permission. - -A mailing list discussing \MP{} is available; -\begin{narrowversion} % really non-hyper - subscribe via the \acro{TUG} \ProgName{mailman} interface at - \URL{http://lists.tug.org/metapost} -\end{narrowversion} -\begin{wideversion} % really hyper - subscribe via the % ! line break - \href{http://lists.tug.org/metapost}{\acro{TUG} \ProgName{mailman} interface}. -\end{wideversion} -The \acro{TUG} website also hosts a % ! line break -\href{http://tug.org/metapost.html}{\MP{} summary page}. - -%**** -\Question[Q-texthings]{Things with ``\TeX{}'' in the name} - -New \TeX{} users are often baffled by the myriad terms with ``\TeX{}'' -in the name. The goal of this answer is to clarify some of the more -common \TeX{} terms. - -\paragraph{\TeX{} itself} -\TeX{} proper is a typesetting system based on a set of low-level -control sequences that instruct \TeX{} how to lay out text on the -page. For example, \csx{hskip} inserts a given amount of horizontal -space into the document, and \csx{font} makes a given font available -to \TeX{}. \TeX{} is fully programmable using an integrated macro -scripting language that supports variables, scoping, conditional -execution, control flow, and function (really, macro) definitions. -See % ! line break -\Qref[question]{What is \TeX{}?}{Q-whatTeX} for some background -information on \TeX{} and % ! line break -\Qref[question]{Reference documents}{Q-ref-doc} for pointers to -descriptions of \TeX{} control sequences, data types, and other key -parts of \TeX{}. - -\paragraph{\TeX{} macro packages (a.k.a.~\TeX{} formats)} -\TeX{}'s control sequences are tedious to use directly; they are -intended primarily as building blocks for higher-level---and therefore -more user-friendly---abstractions. For example, there is no way in -base \TeX{} to specify that a piece of text should be typeset in a -larger font. Instead, one must keep track of the current size and -typeface, load a new font with the same typeface but a (specified) -larger size, and tell \TeX{} to use that new font until instructed -otherwise. Fortunately, because \TeX{} is programmable, it is -possible to write a macro that hides this complexity behind a simple, -new control sequence. For example, -% -\cmdinvoke{larger}{my text} can be defined to typeset ``my text'' in -the next larger font). - -While some users write their own, perfectly customized set of -macros---which they then typically reuse across many documents---it is -far more common to rely upon a \emph{macro package}, a collection of -\TeX{} macros written by experts. For the user's convenience, these -macro packages are often combined with the base \TeX{} engine into a -standalone executable. The following are some of that macro packages -that you are likely to encounter: -\begin{description} - \item[Plain \TeX{} (executable: \ProgName{tex})] - See - \Qref[questions]{Books on \TeX{} and its relations}{Q-books}, - \Qref[]{Online introductions: \TeX{}}{Q-man-tex}, - \Qref[]{Should I use Plain \TeX{} or \LaTeX{}?}{Q-plainvltx} and - \Qref[]{Freely available \AllTeX{} books}{Q-ol-books}. - Note that the Plain \TeX{} executable is called \ProgName{tex}; the - base \TeX{} engine is generally provided by a separate executable - such as \ProgName{initex} or as a \texttt{-ini} flag to - \ProgName{tex}. - - \item[\LaTeX{} (executable: \ProgName{latex})] - See - \Qref[questions]{Books on \TeX{} and its relations}{Q-books}, - \Qref[]{\AllTeX{} Tutorials, etc.}{Q-tutorials*}, - \Qref[]{Online introductions: \LaTeX{}}{Q-man-latex}, - \Qref[]{Specialized \AllTeX{} tutorials}{Q-tutbitslatex} and - \Qref[]{Directories of \AllTeX{} information}{Q-doc-dirs}. - Note that there have been two major versions of \LaTeX{}: \LaTeXe{} - refers to the current version of \LaTeX{} while \LaTeXo{} is the - long-since-obsolete (since 1994) version (cf.~% - \Qref[question]{What is \LaTeXe{}?}{Q-latex2e} for more information). - - \item[\CONTeXT{} (executable: \ProgName{texexec})] - See - \Qref[question]{What is \CONTeXT{}?}{Q-context}. - - \item[Texinfo (executables: \ProgName{tex}, \ProgName{makeinfo})] - See - \Qref[question]{What is Texinfo?}{Q-texinfo}. \ProgName{makeinfo} - converts Texinfo documents to \acro{HTML}, DocBook, Emacs info, - \acro{XML}, and plain text. \ProgName{Tex} (or wrappers such as - \ProgName{texi2pdf} and \ProgName{texi2pdf}) produce one of \TeX{}'s - usual output formats such as \acro{DVI} or \acro{PDF}. Because - \ProgName{tex} loads the Plain \TeX{} macros, not the Texinfo ones, - a Texinfo document must begin with \cmdinvoke{input}{texinfo} to - explicitly load the Texinfo macro package. - - \item[\Eplain{}---Extended Plain \TeX{} (executable: \ProgName{eplain})] - See - \Qref[question]{What is \Eplain{}?}{Q-eplain}. -\end{description} - -\paragraph{Modified \ProgName{tex} executables} -The original \ProgName{tex} executable was produced in the late 1970s -(cf.~\Qref[question]{What is \TeX{}?}{Q-whatTeX}) and consequently -lacked some features that users have come to expect from today's -software. The following programs address these issues by augmenting -the \TeX{} engine with some additional useful features: - -\begin{description} - \item[\PDFTeX{} (executable: \ProgName{pdftex})] - \TeX{}, which predates the \acro{PDF} file format by a decade, - outputs files in a \TeX{}-specific format called \acro{DVI} - (cf.~\Qref[question]{What is a \acro{DVI} file?}{Q-dvi}). In - contrast, \PDFTeX{} can output both \acro{DVI} \emph{and} \acro{PDF} - files. In \acro{PDF} mode, it lets documents exploit various - \acro{PDF} features such as hyperlinks, bookmarks, and annotations, - \PDFTeX{} additionally supports two sophisticated micro-typographic - features: character protrusion and font expansion. See - \Qref[question]{What is \PDFTeX{}?}{Q-whatpdftex}. - - \item[\xetex{} (executable: \ProgName{xetex})] - \TeX{} not only predates all major font technologies in use today - (e.g.,~TrueType, OpenType, and PostScript Type~1) but also predates - the notion that fonts be included with an operating system. - Consequently, \TeX{} uses its own font formats, which are - incompatible with anything a user is likely to have preinstalled. - \xetex{} addresses this issue by enhancing \TeX{}'s \csx{font} - control sequence to support all of the fonts made available by the - operating system. See - \Qref[question]{What is \xetex{}?}{Q-xetex}. - - \item[\LuaTeX{} (executable: \ProgName{luatex})] - \TeX{} is programmed in its own, integrated, macro-based programming - language. Many users have criticized this language for being - needlessly difficult to program. \LuaTeX{} addresses that criticism - by integrating a modern scripting language, Lua, into the base - \TeX{} engine. See - \Qref[question]{What is \LuaTeX{}?}{Q-luatex}. - - \item[\eTeX{} (executable: \ProgName{etex})] - \eTeX{} provides a number of features that are only indirectly - useful to end users but that can be immensely useful to package - developers. Consequently, there is an increasing number of macro - packages that require the use of \eTeX{}. (Note: Be careful not to - confuse \eTeX{}, which enhances the \TeX{} engine, with \Eplain{}, - which enhances the Plain \TeX{} macro package.) See - \Qref[question]{What is \eTeX{}?}{Q-etex}. -\end{description} - -Because each of the above modifies only the base \TeX{} engine, it is -possible to combine any of those with any of the \TeX{} macro packages -listed earlier to produce executables with both sets of features. For -example, the \ProgName{pdflatex}, \ProgName{xelatex} and -\ProgName{lualatex} executables each combine -\LaTeX{} with an enhanced \TeX{} engine. Some executables combine the -features of multiple enhanced \TeX{} engine: \ProgName{pdfetex} -combines \PDFTeX{} and \eTeX{} into a single executable. - -As combining features is a generally desirable tendency, current -\TeX{} distributions (see below) incorporate the features of \PDFTeX{} -and \eTeX{} into a single executable. This executable may be -offered with a \LaTeX{} format (as \ProgName{latex} or -\ProgName{pdflatex}) or with a \plaintex{} format (as -\ProgName{pdftex}). (\ProgName{Tex} remains with an unadorned \TeX{} -executable using \plaintex{}, for people such as Knuth himself, who -want the certainty of the ``original''.) - - -\paragraph{\TeX{} distributions} -A \emph{\TeX{} distribution} is a collection of \TeX{}-related -software. Generally, a \TeX{} distribution includes a set of core -\TeX{} executables such as \ProgName{tex} and \ProgName{latex}; -various fonts optimized for use with \TeX{}; helper programs such as -the \BibTeX{} bibliographic-database formatter, editors, integrated -development environments, file-format-conversion programs; numerous -\LaTeX{} packages; configuration tools; and any other goodies the -distributor chooses to include. Commonly encountered \TeX{} -distributions include \texlive{}, \miktex{} and Mac\TeX{}; older ones -include oz\TeX{}, \acro{CM}ac\TeX{} and te\TeX{}. Some \TeX{} -distributions target a specific operating system and/or processor -architecture; others run on multiple platforms. Some \TeX{} -distributions are free; others require payment. See % ! line break -\Qref[question]{\AllTeX{} for different machines}{Q-TeXsystems} for a -list of free and shareware \TeX{} distributions and % ! line break -\Qref[question]{Commercial \TeX{} implementations}{Q-commercial} for a -list of commercial \TeX{} distributions. - - -\paragraph{Summary} -If your document begins with \csx{documentclass}, you're using some -form of the \LaTeX{} macro package. Even if hidden behind a button in -a \TeX{}-aware GUI, this document is getting compiled by a \TeX{} -executable---probably \ProgName{latex} or \ProgName{pdflatex}---to -produce an output file. The executable came bundled as part of a -\TeX{} distribution such as \miktex{}, which includes various other -\TeX{}-related components. -%**** - -\Question[Q-triptrap]{How can I be sure it's really \TeX{}?} - -\TeX{} (and \MF{} and \MP{}) are written in a -\begin{narrowversion} % really "non-hyper" - `literate' programming language called Web (\Qref{}{Q-lit}) -\end{narrowversion} -\begin{wideversion} - \Qref{`literate' programming}{Q-lit} language called Web -\end{wideversion} -which is designed to be portable across a wide range of computer -systems. How, then, is a new version of \TeX{} checked? - -Of course, any sensible software implementor will have his own suite -of tests to check that his software runs: those who port \TeX{} and -its friends to other platforms do indeed perform such tests. - -Knuth, however, provides a `conformance test' for both \TeX{} -(\texttt{trip}) and \MF{} (\texttt{trap}). -%%% Is there a similar one for \MP{}? -He characterises these as `torture tests': they are designed not to -check the obvious things that ordinary typeset documents, or font -designs, will exercise, but rather to explore small alleyways off the -main path through the code of \TeX{}. They are, to the casual reader, -pretty incomprehensible! - -Once an implementation of \TeX{} has passed its \texttt{trip} test, or an -implementation of \MF{} has passed its \texttt{trap} test, then it may -in principle be distributed as a working version. (In practice, any -distributor would test new versions against ``real'' documents or -fonts, too; \texttt{trip} and \texttt{trap} don't actually test any -for real world problems. - - -\Question[Q-y2k]{Are \TeX{} and friends Y2K compliant?} - -\begin{description} -\item[Crashing:] None of \TeX{}, \MF{} or \MP{} can themselves crash - due to any change whatever in the date of any sort. -\item[Timestamps:] In the original sources, a 2-digit year was - stored as the creation time for format files and that value is - printed in log-files. These items should not be of general concern, - since the only use of the date format file is to produce the log - output, and the log file is designed for human readers only. - - Knuth announced in 1998 that implementors could - alter this code without fear of being accused of non-compliance. - Nearly all implementations that are being actively maintained had - been modified to generate 4-digit years in the format file and the - log, by the end of 1998. The original sources themselves have now - been modified so that 4-digit year numbers are stored. -\item[The \csx{year} primitive:] Certification of a \TeX{} - implementation (see \Qref[question]{trip/trap testing}{Q-triptrap}) - does not require that \csx{year} return a meaningful value (which - means that \TeX{} can, in principle, be implemented on platforms - that don't make the value of the clock available to user programs). - The \emph{\TeX{}book} (see - \Qref[question]{TeX-related books}{Q-books}) defines \csx{year} as - ``the current year of our Lord'', which is the only correct meaning - for \csx{year} for those implementations which can supply a - meaningful value, which is to say nearly all of them. - - In short, \TeX{} implementations should provide a value in \csx{year} - giving the 4-digit year Anno Domini, or the value 1776 if the - platform does not support a date function. - - Note that if the system itself fails to deliver a correct date to - \TeX{}, then \csx{year} will of course return an incorrect value. - \TeX{} cannot be considered Y2K compliant, in this sense, on a -system that is not itself Y2K compliant. -\item[Macros:] \TeX{} macros can in principle perform calculations on - the basis of the value of \csx{year}. - The \Qref*{LaTeX suite}{Q-latex} - performs such calculations in a small number of places; the - calculations performed in the current (supported) version of \LaTeX{} are - known to be Y2K compliant. - - Other macros and macro packages should be individually checked. -\item[External software:] Software such as \acro{DVI} translators - needs to be individually checked. -\end{description} - -\Question[Q-etex]{What is \eTeX{}?} - -While Knuth has declared that \TeX{} will never % !line break -\Qref*{change in any substantial way}{Q-TeXfuture}, there remain -things that one might wish had been done differently, or indeed -implemented at all. - -The \acro{NTS} project set out to produce an advanced replacement for -\TeX{}, to provide a basis for developing such modifications: this -``New Typesetting System'' would share Knuth's aims, but would -implement the work in a modern way taking account of the lessons -learned with \TeX{}. While a first demonstrator \acro{NTS} did -appear, it wasn't practically useful, and the project seems no longer -active. - -In parallel with its work on \acro{NTS} itself, the project developed -a set of extensions that can be used with a (``true'') \TeX{} system. -Such a modified system is known as an \eTeX{} system, and the concept -has proved widely successful. Indeed, current \TeX{} distributions -are delivered with most formats built with an \eTeX{}-based system (for -those who don't want them, \eTeX{}'s extensions can be disabled, leaving -a functionally standard \TeX{} system). - -The extensions range from the seemingly simple (increasing the number -of available registers from 256 to 32768) through to extremely subtle -programming support. - -\Qref*{\CONTeXT{}}{Q-context} has required \eTeX{} for its operation -for some time. - -Some \LaTeX{} packages already specify the use of \eTeX{}. Some such -packages may not work at all on a non-\eTeX{} system; others will -work, but not as well as on an \eTeX{} system. The % ! line break -\Qref*{\LaTeX{} team}{Q-LaTeX3} has announced that future \LaTeX{} -packages (specifically those from the team, as opposed to those -individually contributed) may require \eTeX{} for optimum performance. - -\Question[Q-whatpdftex]{What is \PDFTeX{}?} - -One can reasonably say that \PDFTeX{} is (today) the main stream of -\TeX{} distributions: most \LaTeX{} and \CONTeXT{} users nowadays use -\PDFTeX{} whether they know it or not (more precisely, they use -\PDFTeX{} extended by -\begin{wideversion} - \Qref*{\eTeX{}}{Q-etex}). -\end{wideversion} -\begin{narrowversion} - \eTeX{}~--- \Qref{}{Q-etex}). -\end{narrowversion} -So what is \PDFTeX{}? - -\PDFTeX{} is a development of \TeX{} that is capable of generating -typeset \acro{PDF} output in place of \acro{DVI}. \PDFTeX{} has -other capabilities, most notably in the area of fine typographic -detail (for example, its support for % ! line break -\begin{wideversion} - \Qref{optimising line breaks}{Q-overfull}), -\end{wideversion} -\begin{narrowversion} - % ( <- dummy for paren balancing - optimising line breaks~--- \Qref{}{Q-overfull}), -\end{narrowversion} -but its greatest impact to date has been in the area of -\acro{PDF} output. - -\PDFTeX{} started as a topic for H\`an \The{} Th\`anh's Master's~thesis, -and seems first to have been published in \TUGboat{} 18(4), in 1997 -(though it was certainly discussed at the \acro{TUG}'96 conference in -Russia). - -While the world was making good use of ``pre-releases'' of \PDFTeX{}, -Th\`anh used it as a test-bed for the micro-typography which was the -prime subject of his Ph.D. research. Since Th\`anh was finally -awarded his Ph.D., day-to-day maintenance and development of -\PDFTeX{}~1.0 (and later) has been in the hands of a group of -\PDFTeX{} maintainers (which includes Th\`anh); the group has managed -to maintain a stable platform for general use. - -Development of \PDFTeX{} has (in essence) stopped: the brave new world -is to be \Qref*{\LuaTeX{}}{Q-luatex}. - -\Question[Q-latex]{What is \LaTeX{}?} - -\LaTeX{} is a \TeX{} macro package, originally written by Leslie Lamport, that -provides a document processing system. \LaTeX{} allows markup to -describe the structure of a document, so that the user -need not think about presentation. By using document classes and -add-on packages, the same document can be produced in a variety of -different layouts. - -Lamport says that \LaTeX{} -``\emph{represents a balance between functionality and ease of use}''. -This shows itself as a continual conflict that leads to -the need for such things as \acro{FAQ}s: \LaTeX{} \emph{can} -meet most user requirements, but finding out \emph{how} is often -tricky. - -\Question[Q-latex2e]{What is \LaTeXe{}?} - -Lamport's last version of \LaTeX{} (\LaTeXo{}, last updated in 1992) -was superseded in 1994 by a new version (\LaTeXe{}) provided by -\Qref*{the \LaTeX{} team}{Q-LaTeX3}. -\LaTeXe{} is now the only readily-available version of -\LaTeX{}, and draws together several threads of \LaTeX{} development -from the later days of \LaTeXo{}. The ``e'' of the name is (in the -% next (ghastly) line needed to maintain typesetting -\wideonly{\Qref{official logo}{Q-logos}}\narrowonly{official logo~--- \Qref{\relax}{Q-logos}}) -% the \relax allows sanitize to cope with the line. just don't ask... -a single-stroke epsilon -(\latexhtml{\ensuremath{\varepsilon}}{ε}, supposedly -indicative of no more than a small change. - -\LaTeXe{} has several enhancements over \LaTeXo{}, but they were all -rather minor, with a view to continuity and stability rather than the -``big push'' that some had expected from the team. \LaTeXe{} -continues to this day to offer a compatibility mode in which most -files prepared for use with \LaTeXo{} will run (albeit with somewhat -reduced performance, and subject to voluminous complaints in the log -file). Differences between \LaTeXe{} and \LaTeXo{} are -outlined in a series of `guide' files that are available in every -\LaTeX{} distribution (the same directory also contains ``news'' about -each new release of \LaTeXe{}). -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\LaTeX{} guides and news]\CTANref{latexdoc} -\end{ctanrefs} - -\Question[Q-latexpronounce]{How should I pronounce ``\LaTeX{}(\twee{})''?} - -Lamport never recommended how one should pronounce \LaTeX{}, but a lot -of people pronounce it `Lay \TeX{}' or perhaps `Lah \TeX{}' (with -\TeX{} pronounced as the program itself; see -\Qref[question]{the rules for TeX}{Q-TeXpronounce}). It is definitely -\emph{not} to be pronounced in the same way as the rubber-tree gum -(which would be `lay teks'). - -The \LaTeXe{} logo is supposed to end with an -\latexhtml{\ensuremath{\varepsilon}}{ε}; nevertheless, most -people pronounce the name as `\LaTeX{}-two-ee'. - -\Question[Q-plainvltx]{Should I use \plaintex{} or \LaTeX{}?} - -There's no straightforward answer to this question. Many people swear -by \plaintex{}, and produce highly respectable documents using it -(Knuth is an example of this, of course). But equally, many people -are happy to let someone else take the design decisions for them, -accepting a small loss of flexibility in exchange for a saving of -(mental) effort. - -The arguments around this topic can provoke huge amounts of noise and -heat, without offering much by way of light; your best bet may be to -find out what those around you are using, and to follow them in the -hope of some support. Later on, you can always switch your -allegiance; don't bother about it. - -If you are preparing a manuscript for a publisher or journal, ask them -what markup they want before you -develop your own; many big publishers have developed their own -\AllTeX{} styles for journals and books, and insist that authors stick -closely to their markup. - -\Question[Q-LaTeXandPlain]{How does \LaTeX{} relate to \plaintex{}?} - -\LaTeX{} is a program written in the programming language \TeX{}. (In -the same sense, any \LaTeX{} document is also a program, which is -designed to run `alongside', or `inside' \LaTeX{}, whichever metaphor -you prefer.) - -\plaintex{} is also a program written in the programming language -\TeX{}. - -Both exist because writing your documents in `raw' \TeX{} would -involve much reinventing of wheels for every document. They both -serve as convenient aids to make document writing more pleasant: -\LaTeX{} is a far more extensive aid. - -\LaTeX{} is close to being a superset of \plaintex{}. Many documents -designed for \plaintex{} will work with \LaTeX{} with no more than -minor modifications (though some will require substantial work). - -Interpretation of any \AllTeX{} program involves some data-driven -elements, and \LaTeX{} has a wider range of such elements than does -\plaintex{}. As a result, the mapping from \LaTeX{} to \plaintex{} -is far less clear than that in the other direction~--- see a later -answer about \Qref*{translating to \plaintex{}}{Q-LaTeXtoPlain}. - -\Question[Q-context]{What is \CONTeXT{}?} - -\href{http://www.pragma-ade.com/}{\CONTeXT{}} is a macro package -developed by Hans Hagen of Pragma-Ade. \CONTeXT{} is a -document-production system based, like \LaTeX{}, on the \TeX{} -typesetting system. Whereas \LaTeX{} insulates the writer from -typographical details, \CONTeXT{} takes a complementary approach by -providing structured interfaces for handling typography, including -extensive support for colors, backgrounds, hyperlinks, presentations, -figure-text integration, and conditional compilation. It gives the -user extensive control over formatting while making it easy to create -new layouts and styles without learning the \TeX{} macro -language. \CONTeXT{}'s unified design avoids the package clashes that -can happen with \LaTeX{}. - -\CONTeXT{} also integrates MetaFun, a superset of \MP{} and a powerful -system for vector graphics. MetaFun can be used as a stand-alone -system to produce figures, but its strength lies in enhancing -\CONTeXT{} documents with accurate graphic elements. - -\CONTeXT{} allows the users to specify formatting commands in English, -Dutch, German, French, or Italian, and to use different typesetting -engines (\PDFTeX{}, Xe\TeX{}, Aleph, and soon \LuaTeX{}) without -changing the user interface. \CONTeXT{} is developed rapidly, often in -response to requests from the user community. - -%%% RF's original version -%% developed by Hans Hagen, originally to -%% serve the needs of his (Dutch) firm Pragma. It was designed with the -%% same general-purpose aims as \LaTeX{}, but (being younger) reflects -%% much more recent thinking about the structure of markup, etc. In -%% particular, \CONTeXT{} can customise its markup to an -%% author's language (customising modules for Dutch, English and German -%% are provided, at present). -%% -%% \CONTeXT{} is well integrated, in all of its structure, -%% with the needs of hypertext markup, and in particular with the -%% facilities offered by \Qref*{\PDFTeX{}}{Q-whatpdftex}. -%% The default installation employs a version of \PDFTeX{} built with the -%% \Qref*{\eTeX{} extensions}{Q-etex}, which allows further flexibility. - -\CONTeXT{} doesn't yet have quite such a large developer community as -does \LaTeX{}, but those developers who are active seem to have -prodigious energy. Support is available via a % ! line break -\href{http://contextgarden.net}{\acro{WIKI} site} and via the -\href{http://www.ntg.nl/mailman/listinfo/ntg-context}{mailing list}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\CONTeXT{} distribution]\CTANref{context} -\end{ctanrefs} - -\Question[Q-AMSpkg]{What are the \acro{AMS} packages (\AMSTeX{}, \emph{etc}.)?} - -\AMSTeX{} is a \TeX{} macro package, originally written by Michael Spivak for -the American Mathematical Society (\acro{AMS}) during 1983--1985 and -is described in the book ``\Qref*{The Joy of \TeX{}}{Q-books}''. -It is based on \plaintex{}, and provides many -features for producing more professional-looking maths formulas with -less burden on authors. It pays attention to the finer details of -sizing and positioning that mathematical publishers care about. The -aspects covered include multi-line displayed equations, equation -numbering, ellipsis dots, matrices, double accents, multi-line -subscripts, syntax checking (faster processing on initial -error-checking \TeX{} runs), and other things. - -As \LaTeX{} increased in popularity, authors sought to submit papers to -the \acro{AMS} in \LaTeX{}, so \AMSLaTeX{} was developed. \AMSLaTeX{} -is a collection of \LaTeX{} packages and classes that offer authors most of -the functionality of \AMSTeX{}. -The \acro{AMS} no longer recommends the use of \AMSTeX{}, and urges -its authors to use \AMSLaTeX{} instead. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\AMSTeX{} distribution]\CTANref{amstex} -\item[\nothtml{\rmfamily}\AMSLaTeX{} distribution]\CTANref{amslatex} -\end{ctanrefs} - -\Question[Q-eplain]{What is \Eplain{}?} - -The \href{http://tug.org/eplain}{\Eplain{}} -macro package expands on and extends the definitions in \plaintex{}. -\Eplain{} is not intended to provide ``generic typesetting -capabilities'', as do \CONTeXT{}, \LaTeX{} or -\Qref*{Texinfo}{Q-texinfo}. Instead, it defines macro tools that -should be useful whatever commands you choose to use when you prepare -your manuscript. - -For example, \Eplain{} does not have a command \csx{section}, -which would format section headings in an ``appropriate'' way, as -\LaTeX{}'s \csx{section} does. The philosophy of \Eplain{} is that -some people will always need or want to go beyond the macro designer's -idea of ``appropriate''. Such canned macros are fine~--- as long as you -are willing to accept the resulting output. If you don't like the -results, or if you are trying to match a different format, you are out -of luck. - -On the other hand, almost everyone would like capabilities such as -cross-referencing by labels, so that you don't have to put actual page -numbers in the manuscript. The authors of \Eplain{} believe it is the -only generally available macro package that does not force its -typographic style on an author, and yet provides these such capabilities. - -Another useful feature of \Eplain{} is the ability to create PDF files -with hyperlinks. The cross-referencing macros can implicitly generate -hyperlinks for the cross-references, but you can also create explicit -hyperlinks, both internal (pointing to a destination within the -current document) and external (pointing to another local document or -a URL). - -Several \LaTeX{} packages provide capabilities which \plaintex{} -users are lacking, most notably text colouring and rotation provided by -the \Package{graphics} bundle (packages \Package{color} and -\Package{graphics}). Although the \Package{graphics} bundle provides -a \plaintex{} ``loader'' for some of the packages, it is not a -trivial job to pass options to those packages under \plaintex{}, and -much of the functionality of the packages is accessed through package -options. \Eplain{} extends the loader so that options can be passed -to the packages just as they are in \LaTeX{}. The following packages are -known to work with \Eplain{}: \Package{graphics}, \Package{graphicx}, -\Package{color}, \Package{autopict} (\LaTeX{} picture environment), -\Package{psfrag}, and \Package{url}. - -\href{http://tug.org/docs/html/eplain}{\Eplain{} documentation} is -available online, and there's -also a mailing list~--- sign up, or browse the list archives, via -\URL{http://tug.org/mailman/listinfo/tex-eplain} -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\Eplain{} distribution]\CTANref{eplain} -\end{ctanrefs} - -\Question[Q-lollipop]{What is Lollipop?} - -Lollipop is a macro package written by Victor Eijkhout; it was used in -the production of his book ``\emph{\TeX{} by Topic}'' (see -\Qref[question]{\AllTeX{} Tutorials}{Q-ol-books}). The manual says of -it: -\begin{quote} - Lollipop is `\TeX{} made easy'. Lollipop is a macro package that - functions as a toolbox for writing \TeX{} macros. It was my - intention to make macro writing so easy that implementing a fully - new layout in \TeX{} would become a matter of less than an hour for - an average document, and that it would be a task that could be - accomplished by someone with only a very basic training in \TeX{} - programming. - - Lollipop is an attempt to make structured text formatting available - for environments where previously only \WYSIWYG{} packages could be - used because adapting the layout is so much more easy with them than - with traditional \TeX{} macro packages. -\end{quote} - -The manual goes on to talk of ambitions to ``capture some of the -\LaTeX{} market share''; it's a very witty package, but little sign of -\htmlignore -it taking over from \LaTeX{} is detectable\dots{}\@ -\endhtmlignore -\begin{htmlversion} -it taking over from \LaTeX{} is detectable\dots{} -\end{htmlversion} -An article about Lollipop appeared in \TUGboat{} 13(3). -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Lollipop distribution]\CTANref{lollipop} -\end{ctanrefs} - -\Question[Q-texinfo]{What is Texinfo?} - -Texinfo is a documentation system that uses one source file to produce -both on-line information and printed output. So instead of writing -two different documents, one for the on-line help and the other for a -typeset manual, you need write only one document source file. When -the work is revised, you need only revise one document. By -convention, Texinfo source file names end with a \extension{texi} or -\extension{texinfo} extension. - -Texinfo is a macro language, somewhat similar to \LaTeX{}, but with -slightly less expressive power. Its appearance is of course rather -similar to any \TeX{}-based macro language, except that its macros -start with \texttt{@} rather than the |\| that's more commonly used in -\TeX{} systems. - -You can write and format Texinfo files into Info files within \acro{GNU} -\ProgName{emacs}, and read them using the \ProgName{emacs} Info -reader. You can also format Texinfo files into Info files using -\ProgName{makeinfo} and read them using \ProgName{info}, so you're not -dependent on \ProgName{emacs}. The distribution includes a -\ProgName{Perl} script, \ProgName{texi2html}, that will convert -Texinfo sources into \acro{HTML}: the language is a far better fit to -\acro{HTML} than is \LaTeX{}, so that the breast-beating agonies of -\Qref*{converting \LaTeX{} to \acro{HTML}}{Q-LaTeX2HTML} are largely -avoided. - -Finally, of course, you can also print the files, or convert them to -\acro{PDF} using \PDFTeX{}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Texinfo distribution]\CTANref{texinfo} -\end{ctanrefs} - -\Question[Q-whyfree]{If \TeX{} is so good, how come it's free?} - -It's free because Knuth chose to make it so. He is nevertheless -apparently happy -that others should earn money by selling \TeX{}-based services and -products. While several valuable \TeX{}-related tools and packages are -offered subject to restrictions imposed by the \acro{GNU} General Public -Licence (`Copyleft'), \TeX{} itself is not subject to Copyleft. - -There are commercial versions of \TeX{} available; for some users, -it's reassuring to have paid support. What is more, some of the -commercial implementations -have features that are not available in free versions. (The -reverse is also true: some free implementations have features -not available commercially.) - -This \acro{FAQ} concentrates on `free' distributions of \TeX{}, but we -do at least list the \Qref*{major vendors}{Q-commercial}. - -\Question[Q-TeXfuture]{What is the future of \TeX{}?} - -Knuth has declared that he will do no further development of \TeX{}; -he will continue to fix any bugs that are reported to him (though -bugs are rare). This decision was made soon after -\TeX{} version~3.0 was released; at each bug-fix release -the version number acquires one more digit, so that it tends to the -limit~\ensuremath{\pi} (at the time of writing, Knuth's latest release -is version 3.1415926). Knuth wants \TeX{} to be frozen at -version~\ensuremath{\pi} when he dies; thereafter, no further changes -may be made to Knuth's source. (A similar rule is applied to \MF{}; -its version number tends to the limit~\ensuremath{e}, and currently -stands at 2.718281.) - -Knuth explains his decision, and exhorts us all to respect it, in a -paper originally published in % ! line break -\href{http://tug.org/TUGboat/Articles/tb11-4/tb30knut.pdf}{\TUGboat{} 11(4)}, -and reprinted in the % ! line break -\href{http://www.ntg.nl/maps/pdf/5_34.pdf}{NTG journal MAPS}. - -There are projects (some of them long-term -projects: see, for example, -\Qref[question]{the LaTeX3 project}{Q-LaTeX3}) -%\Qref[and]{and the SGML work}{Q-SGML}) -to build substantial -new macro packages based on \TeX{}. For the even longer term, there -are various projects to build a \emph{successor} to \TeX{}; see, for example, -the -\begin{narrowversion} - \LuaTeX{}, Omega/Aleph and \ExTeX{} projects (questions -\end{narrowversion} -\Qref[\nothtml]{\LuaTeX}{Q-luatex}, -\Qref[\nothtml]{Omega/Aleph}{Q-omegaleph} and -\Qref[\nothtml]{\ExTeX{}}{Q-extex}\narrowonly{).} -\begin{wideversion} - projects. -\end{wideversion} - -\Question[Q-readtex]{Reading \AllTeX{} files} - -So you've been sent a \TeX{} file: what are you going to do with it? - -You can, of course, ``just read it'', since it's a plain text file, -but the markup tags in the document may prove distracting. Most of -the time, even \TeX{} experts will typeset a \TeX{} file before -attempting to read it. - -So, you need to typeset the document. The good news is that \TeX{} -systems are available, free, for most sorts of computer; the bad news -is that you need a pretty complete \TeX{} system even to read a single -file, and complete \TeX{} systems are pretty large. - -\TeX{} is a typesetting system that arose from a publishing project (see -\wideonly{``}\Qref[question]{what is \TeX{}}{Q-whatTeX}\wideonly{''}), -and its basic source is available free from its author. However, at -its root, it is \emph{just} a typesetting engine: even to view or to -print the typeset output, you will need ancillary programs. In short, -you need a \TeX{} \emph{distribution}~--- a collection of -\TeX{}-related programs tailored to your operating system: for details -of the sorts of things that are available, see -% beware line break -\htmlonly{``}\Qref[question]{\TeX{} distributions}{Q-TeXsystems}\htmlonly{''} -or -% beware line break -\htmlonly{``}\Qref[\htmlonly]{commercial \TeX{} distributions}{Q-commercial}\latexhtml{ (for commercial distributions)}{''}. - -But beware~--- \TeX{} makes no attempt to look like the sort of -\WYSIWYG{} system you're probably used to (see -% beware line wrap -\wideonly{``}\Qref[question]{why is \TeX{} not \WYSIWYG{}}{Q-notWYSIWYG}\wideonly{''}): -while many modern versions of \TeX{} have a compile--view cycle that -rivals the best commercial word processors in its responsiveness, what -you type is usually \emph{markup}, which typically defines a logical -(rather than a visual) view of what you want typeset. - -So there's a balance between the simplicity of the original -(marked-up) document, which can more-or-less be read in \emph{any} -editor, and the really rather large investment needed to install a -system to read a document ``as intended''. - -\Question[Q-notWYSIWYG]{Why is \TeX{} not a \WYSIWYG{} system?} - -\WYSIWYG{} is a marketing term (``What you see is what you get'') for -a particular style of text processor. \WYSIWYG{} systems are -characterised by two principal claims: that you type what you want to -print, and that what you see on the screen as you type is a close -approximation to how your text will finally be printed. - -The simple answer to the question is, of course, that \TeX{} was -conceived long before the marketing term, at a time when the marketing -imperative wasn't perceived as significant. However, that was a long -time ago: why has nothing been done with the ``wonder text processor'' -to make it fit with modern perceptions? - -There are two answers to this. First, the simple ``things \emph{have} -been done'' (but they've not taken over the \TeX{} world); and second, -``there are philosophical reasons why the way \TeX{} has developed is -ill-suited to the \WYSIWYG{} style''. -Indeed, there is a fundamental problem with applying \WYSIWYG{} techniques -to \TeX{}: the complexity of \TeX{} makes it hard to get the -equivalent of \TeX{}'s output without actually running \TeX{}. - -A celebrated early system offering ``\WYSIWYG{} using \TeX{}'' came from the -Vor\TeX{} project: a pair of (early) Sun workstations worked in -tandem, one handling the user interface while the other beavered away -in the background typesetting the result. Vor\TeX{} was quite -impressive for its time, but the two workstations combined had hugely less -power than the average sub-thousand dollar Personal Computer -nowadays, and its code has not proved portable (it never even made the -last `great' \TeX{} version change, at the turn of the 1990s, to -\TeX{} version 3). Modern systems that are similar in -their approach are Lightning Textures (an extension of -Blue Sky's original \TeX{} system for the Macintosh), and Scientific -Word (which can also cooperate with a computer algebra system); both -these systems are \Qref*{commercially available}{Q-commercial}. - -The issue has of recent years started to attract attention from \TeX{} -developers, and several interesting projects addressing the -``\Qref*{\TeX{} document preparation environment}{Q-WYGexpts}'' -are in progress. - -Nevertheless, the \TeX{} world has taken a long time to latch onto the -idea of \WYSIWYG{}. -Apart from simple arrogance (``we're better, and have no need to -consider the petty doings of the commercial word processor market''), -there is a real conceptual difference between the word processor model -of the world and the model \LaTeX{} and \CONTeXT{} employ~--- the idea of -``markup''. ``Pure'' markup expresses a logical model of a document, -where every object within the document is labelled according to what -it is rather than how it should appear: appearance is deduced from the -properties of the type of object. Properly applied, markup can -provide valuable assistance when it comes to re-use of documents. - -Established \WYSIWYG{} systems find the expression of this sort of -structured markup difficult; however, markup \emph{is} starting to -appear in the lists of the commercial world's requirements, for two -reasons. First, an element of markup helps impose style on a -document, and commercial users are increasingly obsessed with -uniformity of style; and second, the increasingly pervasive use of -\acro{XML}-derived document archival formats demands it. The same -challenges must needs be addressed by \TeX{}-based document -preparation support schemes, so we are -observing a degree of confluence of the needs of the two communities: -interesting times may be ahead of us. - -\Question[Q-TUG*]{\TeX{} User Groups} - -There has been a \TeX{} User Group since very near the time \TeX{} -first appeared. That first group, \acro{TUG}, is still active and its -journal \textsl{TUGboat} continues in regular publication -with articles about \TeX{}, \MF{} and related technologies, and about -document design, processing and production. \acro{TUG} holds a yearly -conference, whose proceedings are published in \textsl{TUGboat}. - -\acro{TUG}'s \href{http://www.tug.org}{web site} is a valuable -resource for all sorts of -\TeX{}-related matters, such as details of \TeX{} software, and lists -of \TeX{} vendors and \TeX{} consultants. Back articles from -\textsl{TUGboat} are slowly (subject to copyright issues, etc.\@) -making their way to the site, too. - -Some time ago, \acro{TUG} established a ``technical council'', whose -task was to oversee the development of \TeX{}nical projects. Most -such projects nowadays go on their way without any support from -\acro{TUG}, but \acro{TUG}'s web site lists its -\htmlignore -\ifpdf -\href{http://www.tug.org/twg.html}{Technical Working Groups (\acro{TWG}s)}. -\else -Technical Working Groups (\acro{TWG}s: see -\URL{http://www.tug.org/twg.html}). -\fi -\endhtmlignore -\begin{htmlversion} -\href{http://www.tug.org/twg.html}{Technical Working Groups (\acro{TWG}s)}. -\end{htmlversion} - -\acro{TUG} has a reasonable claim to be considered a world-wide -organisation, but there are many national and regional user groups, -too; \acro{TUG}'s web site maintains a list of -\htmlignore -\ifpdf -\href{http://www.tug.org/lugs.html}{``Local User Groups'' (\acro{LUG}s)}. -\else -``local user groups'' (\acro{LUG}s: see -\URL{http://www.tug.org/lugs.html}). -\fi -\endhtmlignore -\begin{htmlversion} -\href{http://www.tug.org/lugs.html}{``local user groups'' (\acro{LUG}s)}. -\end{htmlversion} - -Contact \acro{TUG} itself via: -\begin{quote} - \TeX{} Users Group\\ - 1466 NW Front Avenue, Suite 3141\\ - Portland, OR 97209\\ - \acro{USA}\\[.25\baselineskip] - Tel: +1 503-223-9994\\ - Fax: +1 503-223-3960\\ - Email: \mailto{tug@mail.tug.org}\\ - Web: \URL{http://www.tug.org/} -\end{quote} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Documentation and Help} - -\Question[Q-books]{Books on \TeX{} and its relations} - -While Knuth's book is the definitive reference for \TeX{}, there are -other books covering \TeX{}: -\begin{booklist} -\item[The \TeX{}book]by Donald Knuth (Addison-Wesley, 1984, - \ISBN{0-201-13447-0}, paperback \ISBN{0-201-13448-9}) -\item[A Beginner's Book of \TeX{}]by Raymond Seroul and Silvio Levy, - (Springer Verlag, 1992, \ISBN{0-387-97562-4}) -\item[\TeX{} by Example: A Beginner's Guide]by Arvind Borde - (Academic Press, 1992, \ISBN{0-12-117650-9}~--- now out of print) -\item[Introduction to \TeX{}]by Norbert Schwarz (Addison-Wesley, - 1989, \ISBN{0-201-51141-X}~--- now out of print) -\item[A \plaintex{} Primer]by Malcolm Clark (Oxford University - Press, 1993, ISBNs~0-198-53724-7 (hardback) and~0-198-53784-0 - (paperback)) -\item[A \TeX{} Primer for Scientists]by Stanley Sawyer and Steven - Krantz (CRC Press, 1994, \ISBN{0-849-37159-7}) -\item[\TeX{} by Topic]by Victor Eijkhout (Addison-Wesley, 1992, - \ISBN{0-201-56882-9}~--- now out of print, but see - \Qref[question]{online books}{Q-ol-books}; you can now buy a copy - printed, on demand, by Lulu~--- see - \url{http://www.lulu.com/content/2555607}) -\item[\TeX{} for the Beginner]by Wynter Snow (Addison-Wesley, 1992, - \ISBN{0-201-54799-6}) -\item[\TeX{} for the Impatient]by Paul W.~Abrahams, Karl Berry and - Kathryn A.~Hargreaves (Addison-Wesley, 1990, - \ISBN{0-201-51375-7}~--- now out of print, but see - \Qref[question]{online books}{Q-ol-books}) -\item[\TeX{} in Practice]by Stephan von Bechtolsheim (Springer - Verlag, 1993, 4 volumes, \ISBN{3-540-97296-X} for the set, or -% nos in brackets are for German distribution (Springer Verlag, Berlin) - Vol.~1: \ISBN{0-387-97595-0}, % (3-540-97595-0) - Vol.~2: \ISBN{0-387-97596-9}, % (3-540-97596-9) - Vol.~3: \ISBN{0-387-97597-7}, and % (3-540-97597-7) - Vol.~4: \ISBN{0-387-97598-5})% (3-540-97598-5) -\htmlignore -\item[\TeX{}: Starting from \sqfbox{1}\,\footnotemark]% -\footnotetext{That's `Starting from Square One'}% -\endhtmlignore -\begin{htmlversion} -\item[\TeX{}: Starting from Square One] -\end{htmlversion} - by Michael Doob (Springer - Verlag, 1993, \ISBN{3-540-56441-1}~--- now out of print) -\item[The Joy of \TeX{}]by Michael D.~Spivak (second edition, - \acro{AMS}, 1990, \ISBN{0-821-82997-1}) -\item[The Advanced \TeX{}book]by David Salomon (Springer Verlag, 1995, - \ISBN{0-387-94556-3}) -\end{booklist} -A collection of Knuth's publications about typography is also available: -\begin{booklist} -\item[Digital Typography]by Donald Knuth (CSLI and Cambridge - University Press, 1999, \ISBN{1-57586-011-2}, paperback - \ISBN{1-57586-010-4}). -\end{booklist} -\nothtml{\noindent}and in late 2000, a ``Millennium Boxed Set'' of all -5 volumes of Knuth's ``Computers and Typesetting'' series (about -\TeX{} and \MF{}) was published by Addison Wesley: -\begin{booklist} -\item[Computers \& Typesetting, Volumes A--E Boxed Set]by Donald Knuth - (Addison-Wesley, 2001, \ISBN{0-201-73416-8}). -\end{booklist} -\checked{rf}{2000/02/12 -- http://cseng.aw.com/book/0,3828,0201734168,00.html} -For \LaTeX{}, see: -\begin{booklist} -\item[\LaTeX{}, a Document Preparation System]by Leslie Lamport - (second edition, Addison Wesley, 1994, \ISBN{0-201-52983-1}) -\item[Guide to \LaTeX{}]Helmut Kopka and Patrick W.~Daly (fourth - edition, Addison-Wesley, 2004, \ISBN{0-321-17385-6}) -\item[The \LaTeX{} Companion]by Frank Mittelbach, Michel Goossens, - Johannes Braams, David Carlisle and Chris Rowley (second edition, - Addison-Wesley, 2004, \ISBN*{0-201-36299-6}{978-0-201-36299-2}) -\item[The \LaTeX{} Graphics Companion:]% - \emph{Illustrating documents with \TeX{} and \PS{}} by Michel - Goossens, Sebastian Rahtz, Frank Mittelbach, Denis Roegel and - Herbert Vo\ss{} (second edition, Addison-Wesley, 2007, - \ISBN*{0-321-50892-0}{978-0-321-50892-8}) -\item[The \LaTeX{} Web Companion:]% - \emph{Integrating \TeX{}, \acro{HTML} and \acro{XML}} by Michel - Goossens and Sebastian Rahtz (Addison-Wesley, 1999, \ISBN{0-201-43311-7}) -\item[\TeX{} Unbound:]% - \emph{\LaTeX{} and \TeX{} strategies for fonts, graphics, and more} - by Alan Hoenig (Oxford University Press, 1998, \ISBN{0-19-509685-1} - hardback, \ISBN{0-19-509686-X} paperback) -\item[Math into \LaTeX{}:]\emph{An Introduction to \LaTeX{} and \AMSLaTeX{}} - by George Gr\"atzer (third edition Birkh\"auser and Springer Verlag, - 2000, \ISBN{0-8176-4431-9}, \ISBN{3-7643-4131-9}) -\checked{RF}{2001/01/16} -%% gr\"atzer's home page -%% http://www.maths.umanitoba.ca/homepages/gratzer.html/LaTeXBooks.html -\item[Digital Typography Using \LaTeX{}]Incorporating some - multilingual aspects, and use of \Qref*{Omega}{Q-omegaleph}, by - Apostolos Syropoulos, Antonis Tsolomitis and Nick Sofroniou - (Springer, 2003, \ISBN{0-387-95217-9}). - - A list of errata for the first printing is available from: - \URL{http://www.springer-ny.com/catalog/np/jan99np/0-387-98708-8.html} -\item[First Steps in \LaTeX{}]by George Gr\"atzer (Birkh\"auser, 1999, - \ISBN{0-8176-4132-7}) -\item[\LaTeX{}: Line by Line:]% - \emph{Tips and Techniques for Document Processing} - by Antoni Diller (second edition, John Wiley \& Sons, - 1999, \ISBN{0-471-97918-X}) -\item[\LaTeX{} for Linux:]\emph{A Vade Mecum} - by Bernice Sacks Lipkin (Springer-Verlag, 1999, - \ISBN{0-387-98708-8}, second printing) -\end{booklist} -A sample of George Gr\"atzer's ``Math into \LaTeX{}'', in Adobe -Acrobat format, and example files -%for von Bechtolsheim's ``\TeX{} in Practice'', -for the three \LaTeX{} Companions, and for -Gr\"atzer's ``First Steps in \LaTeX{}'', are all available on -\acro{CTAN}. - -There's a nicely-presented list of of ``recommended books'' to be had -on the web: \URL{http://www.macrotex.net/texbooks/} - -The list of \MF{} books is rather short: -\begin{booklist} -\item[The \MF{}book]by Donald Knuth (Addison Wesley, 1986, - \ISBN{0-201-13445-4}, \ISBN{0-201-52983-1} paperback) -\end{booklist} -Alan Hoenig's `\textsl{\TeX{} Unbound}' includes some discussion and -examples of using \MF{}. - -A book covering a wide range of topics (including installation and -maintenance) is: -\begin{booklist} -\item[Making \TeX{} Work]by Norman Walsh (O'Reilly and Associates, - Inc, 1994, \ISBN{1-56592-051-1}) -\end{booklist} -The book is decidedly dated, and is now out of print, but a copy is -available via \texttt{sourceforge} and on \acro{CTAN}, -and we list it under ``\Qref*{online books}{Q-ol-books}''. - - -This list only covers books in English: notices of new books, or -warnings that books are now out of print are always welcome. However, -this \acro{FAQ} does \emph{not} carry reviews of current published material. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}First Steps in \LaTeX{}]\CTANref{gfs} -\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Companion]\CTANref{tlc2} -\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Graphics Companion]\CTANref{lgc} -\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Web Companion]\CTANref{lwc} -%\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\TeX{} in Practice]\CTANref{tip} -\item[\nothtml{\rmfamily}Sample of \nothtml{\upshape}Math into \LaTeX{}]\CTANref{mil} -\end{ctanrefs} - -\Question[Q-typebooks]{Books on Type} - - The following is a partial listing of books on typography in general. -Of these, Bringhurst seems to be the one most often recommended. -\begin{booklist} -\item[The Elements of Typographic Style]by Robert Bringhurst - (Hartley \& Marks, 1992, \ISBN{0-88179-033-8}) -\item[Finer Points in the Spacing \& Arrangement of Type]by Geoffrey Dowding - (Hartley \& Marks, 1996, \ISBN{0-88179-119-9}) -\item[The Thames \& Hudson Manual of Typography]by Ruari McLean - (Thames \& Hudson, 1980, \ISBN{0-500-68022-1}) -\item[The Form of the Book]by Jan Tschichold - (Lund Humphries, 1991, \ISBN{0-85331-623-6}) -\item[Type \& Layout]by Colin Wheildon - (Strathmore Press, 2006, \ISBN{1-875750-22-3}) -\item[The Design of Books]by Adrian Wilson - (Chronicle Books, 1993, \ISBN{0-8118-0304-X}) -\item[Optical Letter Spacing]by David Kindersley and Lida Cardozo Kindersley - % ! line break - (\href{http://www.kindersleyworkshop.co.uk/}{The Cardozo Kindersley Workshop} - 2001, \ISBN{1-874426-139}) -\end{booklist} - - There are many catalogues of type specimens but the following books provide -a more interesting overall view of types in general and some of their history. -\begin{booklist} -\item[Alphabets Old \& New]by Lewis F.~Day - (Senate, 1995, \ISBN{1-85958-160-9}) -\item[An Introduction to the History of Printing Types]by Geoffrey Dowding - (British Library, 1998, UK \ISBN{0-7123-4563-9}; USA \ISBN{1-884718-44-2}) -\item[The Alphabet Abecedarium]by Richard A.~Firmage - (David R.~Godine, 1993, \ISBN{0-87923-998-0}) -\item[The Alphabet and Elements of Lettering]by Frederick Goudy - (Dover, 1963, \ISBN{0-486-20792-7}) -\item[Anatomy of a Typeface]by Alexander Lawson - (David R.~Godine, 1990, \ISBN{0-87923-338-8}) -\item[A Tally of Types]by Stanley Morison - (David R.~Godine, 1999, \ISBN{1-56792-004-7}) -\item[Counterpunch]by Fred Smeijers - (Hyphen, 1996, \ISBN{0-907259-06-5}) -\item[Treasury of Alphabets and Lettering]by Jan Tschichold - (W.~W.~Norton, 1992, \ISBN{0-393-70197-2}) -\item[A Short History of the Printed Word]by Warren Chappell and - Robert Bringhurst (Hartley \& Marks, 1999, \ISBN{0-88179-154-7}) -\end{booklist} - - The above lists are limited to books published in English. Typographic -styles are somewhat language-dependent, and similarly the `interesting' fonts -depend on the particular writing system involved. - -\Question[Q-whereFAQ]{Where to find \acro{FAQ}s} - -Bobby Bodenheimer's article, from which this \acro{FAQ} was developed, used -to be posted (nominally monthly) to newsgroup -\Newsgroup{comp.text.tex}. The (long -obsolete) last posted copy of that article is kept on \acro{CTAN} for -auld lang syne. - -\begin{pdfversion} -A version of the \href{http://www.tex.ac.uk/faq}{present \acro{FAQ}} -may be browsed via the World-Wide Web, and its sources -\end{pdfversion} -\begin{dviversion} -A version of the present \acro{FAQ} may be browsed via the World-Wide Web, at -\acro{URL} \URL{http://www.tex.ac.uk/faq}, and its sources -\end{dviversion} -\begin{htmlversion} -The sources of the present \acro{FAQ} -\end{htmlversion} -are available from \acro{CTAN}. - -This \acro{FAQ} and others are regularly mentioned, on -\Newsgroup{comp.text.tex} and elsewhere, in a ``pointer \acro{FAQ}'' -which is also saved at \URL{http://tug.org/tex-ptr-faq} - -A 2006 innovation from Scott Pakin is the ``visual'' \LaTeX{} \acro{FAQ}. -This is a document with (mostly rubbish) text formatted so as to -highlight things we discuss here, and providing Acrobat hyper-links to -the relevant answers in this \acro{FAQ} on the Web. The visual -\acro{FAQ} is provided in \acro{PDF} format, on \acro{CTAN}; it works -best using Adobe Acrobat Reader 7 (or later); some features are -missing with other readers, or with earlier versions of Acrobat Reader - -Another excellent information source, available in English, is the -\href{http://tex.loria.fr}{\AllTeX{} navigator}. - -Both the Francophone \TeX{} user group Gutenberg and the Czech/Slovak -user group CS-TUG have published translations of this \acro{FAQ}, with -extensions appropriate to their languages. - -Herbert Vo\ss{}'s excellent % beware line break -\href{http://texnik.de/}{\LaTeX{} tips and tricks} -provides excellent advice on most topics one might imagine (though -it's not strictly a \acro{FAQ})~--- highly recommended for most -ordinary mortals' use. - -The Open Directory Project (\acro{ODP}) maintains a list of sources of -\AllTeX{} help, including \acro{FAQ}s. View the \TeX{} area at -\URL{http://dmoz.org/Computers/Software/Typesetting/TeX/} - -Other non-English \acro{FAQ}s are available (off-\acro{CTAN}): -\begin{booklist} -\item[German]Posted regularly to \Newsgroup{de.comp.tex}, and archived - on \acro{CTAN}; the \acro{FAQ} also appears at - \URL{http://www.dante.de/faq/de-tex-faq/} -\item[French]% -%% An interactive (full-screen!) FAQ may be found at -%% \URL{http://www.frenchpro6.com/screen.pdf/FAQscreen.pdf}, and a copy -%% for printing at \URL{http://frenchle.free.fr/FAQ.pdf}; - A FAQ used to be posted regularly to - \Newsgroup{fr.comp.text.tex}, and is archived on \acro{CTAN}~--- - sadly, that effort seems to have fallen by the wayside. -%% \item[Spanish]See \URL{http://apolo.us.es/CervanTeX/FAQ/} -\item[Czech]See \URL{http://www.fi.muni.cz/cstug/csfaq/} -\end{booklist} - -Resources available on \acro{CTAN} are: -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Dante \acro{FAQ}]\CTANref{dante-faq} -\item[\nothtml{\rmfamily}French \acro{FAQ}]\CTANref{french-faq} -\item[\nothtml{\rmfamily}Sources of this \acro{FAQ}]\CTANref{faq} -\item[\nothtml{\rmfamily}Obsolete \texttt{comp.text.tex} \acro{FAQ}]% - \CTANref{TeX-FAQ} -\item[\nothtml{\rmfamily}The visual \acro{FAQ}]\CTANref{visualFAQ} -\end{ctanrefs} - -\Question[Q-gethelp]{How to get help} - -So you've looked at all relevant \Qref*{\acro{FAQ}s}{Q-whereFAQ} you -can find, you've looked in any \Qref*{books}{Q-books} you have, and -scanned relevant \Qref*{tutorials}{Q-tutorials*}\dots{} and still you -don't know what to do. - -If you are seeking a particular package or program, look on your own -system first: you might already have it~--- the better \TeX{} -distributions contain a wide range of supporting material. The -\acro{CTAN} Catalogue can also identify packages that might help: you -can \href{http://www.tex.ac.uk/search}{search it}, or you can browse it -% !!!! line break -``\href{http://www.tex.ac.uk/tex-archive/help/Catalogue/bytopic.html}{by topic}''. -A catalogue entry has a brief description of the package, and links to -any known documentation on the net. In fact, a large proportion of -\acro{CTAN} package directories now include documentation, so it's -often worth looking at the catalogue entry for a package you're considering -using. - -Failing all that, look to see if anyone else has had the problem -before; there are two places where people ask: browse or search the -newsgroup \Newsgroup{comp.text.tex} via -\href{http://groups.google.com/group/comp.text.tex}{Google groups}, -and the mailing list \texttt{texhax} via its -\href{http://tug.org/pipermail/texhax/}{archive} - -If those ``back question'' searches fail, you'll have to ask the world -at large. To ask a question on \Newsgroup{comp.text.tex}, you can use -your own news client (if you have one), or use the ``start a new -topic'' button on \URL{http://groups.google.com/group/comp.text.tex}. -To ask a question on \texttt{texhax}, you may simply send mail to -\mailto{texhax@tug.org}, but it's probably better to subscribe to the -list (via \URL{http://tug.org/mailman/listinfo/texhax}) % ! no ~ on this line -first~--- not everyone will answer to you as well as to the list. - -Do \textbf{not} try mailing the % ! line break -\Qref*{\LaTeX{} project team}{Q-LaTeX3} or the maintainers of these -\acro{FAQ}s for help; while both addresses reach experienced \AllTeX{} -users, no small group can possibly have expertise in every area of -usage so that the ``big'' lists are a far better bet. - -\Question[Q-maillists*]{Specialist mailing lists} - -The previous question, ``\Qref*{getting help}{Q-gethelp}'', talked of -the two major forums in which \AllTeX{}, \MF{} and \MP{} are -discussed; however, these aren't the only ones available. - -The \acro{TUG} web site offers many mailing lists other than just -\texttt{texhax} via its % ! line break -\href{http://tug.org/mailman/listinfo}{mail list management page}. - -The French national \TeX{} user group, Gutenberg, offers a \MF{} (and, -de facto, \MP{}) mailing list, \mailto{metafont@ens.fr}: subscribe to -it by sending a message -\begin{quote} -\begin{verbatim} -subscribe metafont -\end{verbatim} -\end{quote} -to \mailto{sympa@ens.fr} - -(Note that there's also a \MP{}-specific mailing list available via the -\acro{TUG} lists; in fact there's little danger of becoming confused -by subscribing to both.) - -Announcements of \TeX{}-related installations on the \acro{CTAN} -archives are sent to the mailing list \texttt{ctan-ann}. Subscribe -to the list via its \ProgName{MailMan} web-site -\URL{https://lists.dante.de/mailman/listinfo/ctan-ann}; list archives -are available at the same address. The list archives may also be -browsed via \URL{http://www.mail-archive.com/ctan-ann@dante.de/}, and -an \acro{RSS} feed is also available: -\URL{http://www.mail-archive.com/ctan-ann@dante.de/maillist.xml} - -\Question[Q-askquestion]{How to ask a question} - -You want help from the community at large; you've decided where you're -going to \Qref*{ask your question}{Q-gethelp}, but how do you -phrase it? - -Excellent ``general'' advice (how to ask questions of anyone) is -contained in -%beware line break -\href{http://catb.org/~esr/faqs/smart-questions.html}{Eric Raymond's article on the topic}. -Eric's an extremely self-confident person, and this comes through in -his advice; but his guidelines are very good, even for us in the -un-self-confident majority. It's important to remember that you don't -have a right to advice from the world, but that if you express -yourself well, you will usually find someone who will be pleased to -help. - -So how do you express yourself in the \AllTeX{} world? There aren't -any comprehensive rules, but a few guidelines may help in the -application of your own common sense. -\begin{itemize} -\item Make sure you're asking the right people. Don't ask in a \TeX{} - forum about printer device drivers for the \ProgName{Foobar} - operating system. Yes, \TeX{} users need printers, but no, \TeX{} - users will typically \emph{not} be \ProgName{Foobar} systems - managers. - - Similarly, avoid posing a question in a language that the majority - of the group don't use: post in Ruritanian to - \Newsgroup{de.comp.text.tex} and you may have a long wait before a - German- and Ruritanian-speaking \TeX{} expert notices your - question. -\item If your question is (or may be) \TeX{}-system-specific, report - what system you're using, or intend to use: ``I can't install - \TeX{}'' is as good as useless, whereas ``I'm trying to install the - \ProgName{mumbleTeX} distribution on the \ProgName{Grobble} - operating system'' gives all the context a potential respondent - might need. Another common situation where this information is - important is when you're having trouble installing something new in - your system: ``I want to add the \Package{glugtheory} package to my - \ProgName{mumbleTeX v12.0} distribution on the \ProgName{Grobble 2024} - operating system''. -\item If you need to know how to do something, make clear what your - environment is: ``I want to do \emph{x} in \plaintex{}'', or ``I - want to do \emph{y} in \LaTeX{} running the \Class{boggle} - class''. If you thought you knew how, but your attempts are - failing, tell us what you've tried: ``I've already tried installing - the \Package{elephant} in the \Package{minicar} directory, and it - didn't work, even after refreshing the filename database''. -\item If something's going wrong within \AllTeX{}, pretend you're - \Qref*{submitting a \LaTeX{} bug report}{Q-latexbug}, - and try to generate a \Qref*{minimum failing example}{Q-minxampl}. - If your example - needs your local \Class{xyzthesis} class, or some other resource - not generally available, be sure to include a pointer to how the - resource can be obtained. -\item Figures are special, of course. Sometimes the figure itself is - \emph{really} needed, but most problems may be demonstrated with a - ``figure substitute'' in the form of a - \cmdinvoke*{rule}{width}{height} command, for some value of - \meta{width} and \meta{height}. If the (real) figure is needed, - don't try posting it: far better to put it on the web somewhere. -\item Be as succinct as possible. Your helpers don't usually need to - know \emph{why} you're doing something, just \emph{what} you're - doing and where the problem is. -\end{itemize} - -\Question[Q-minxampl]{How to make a ``minimum example''} - -\Qref[Question]{Our advice on asking questions}{Q-askquestion} -suggests that you prepare a ``minimum example'' (also commonly known -as a ``\emph{minimal} example'') of failing behaviour, -as a sample to post with your question. If you have a problem in a -two hundred page document, it may be unclear how to proceed from this -problem to a succinct demonstration of your problem. - -There are two valid approaches to this task: building up, and hacking -down. - -% ! line break -\latexhtml{The ``building up'' process}{\textbf{\emph{Building up}}} starts -with a basic document structure -(for \LaTeX{}, this would have \csx{documentclass}, -\cmdinvoke{begin}{document}, \cmdinvoke{end}{document}) and adds -things. First to add is a paragraph or so around the actual point -where the problem occurs. (It may prove difficult to find the actual -line that's provoking the problem. If the original problem is an -error, reviewing % ! line break -\Qref[the answer to question]{``the structure of \TeX{} errors''}{Q-errstruct} -may help.) - -Note that there are things that can go wrong in one part of the -document as a result of something in another part: the commonest is -problems in the table of contents (from something in a section title, -or whatever), or the list of \meta{something} (from something in a -\csx{caption}). In such a case, include the section title or caption -(the caption probably needs the \environment{figure} or -\environment{table} environment around it, but it \emph{doesn't} need -the figure or table itself). - -If this file you've built up shows the problem already, then you're done. -Otherwise, try adding packages; the optimum is a file with only one -package in it, but you may find that the guilty package won't even load -properly unless another package has been loaded. (Another common case -is that package \Package{A} only fails when package \Package{B} has been -loaded.) - -% ! line break -\latexhtml{The ``hacking down'' route}{\textbf{\emph{Hacking down}}} starts -with your entire document, and -removes bits until the file no longer fails (and then of course -restores the last thing removed). Don't forget to hack out any -unnecessary packages, but mostly, the difficulty is choosing what to -hack out of the body of the document; this is the mirror of the -problem above, in the ``building up'' route. - -If you've added a package (or more than one), add \csx{listfiles} to -the preamble too: that way, \LaTeX{} will produce a list of the -packages you've used and their version numbers. This information may -be useful evidence for people trying to help you. - -What if your document simply doesn't fail in any of these cut-down -scenarios? Whatever you do, don't post the whole of the document: if -you can, it may be useful to make a copy available on the web -somewhere: people will probably understand if it's impossible~\dots{}\ -or inadvisable, in the case of something confidential. - -If the whole document is necessary, it could be that it's an overflow -of some sort; the best you can do is to post the code ``around'' the -error, and (of course) the full text of the error. - -It may seem that all this work is rather excessive for preparing a -simple post. There are two responses to that, both based on the -relative inefficiency of asking a question on the internet. - -First, preparing a minimum document very often leads \emph{you} to the -answer, without all the fuss of posting and looking for responses. - -Second, your prime aim is to get an answer as quickly as possible; a -well-prepared example stands a good chance of attracting an answer -``in a single pass'': if the person replying to your post finds she -needs more information, you have to find that request, post again, and -wait for your benefactor to produce a second response. - -All things considered, a good example file can save you a day, for -perhaps half an hour's effort invested. - -The above advice, differently phrased, may also be read on the web at -\URL{http://www.minimalbeispiel.de/mini-en.html}; source of that -article may be found at \URL{http://www.minimalbeispiel.de/}, in -both German and English. - -\Question[Q-tutorials*]{\AllTeX{} Tutorials, etc.} - -From a situation where every \AllTeX{} user \emph{had} to buy a book -if she was not to find herself groping blindly along, we now have what -almost amounts to an embarrassment of riches of online documentation. -The following answers attempt to create lists of sources ``by topic''. - -First we have introductory manuals, for -\Qref*{\plaintex{}}{Q-man-tex} and \Qref*{\LaTeX{}}{Q-man-latex}. - -Next comes a selection of -\Qref*{``specialised'' \AllTeX{} tutorials}{Q-tutbitslatex}, -each of which concentrates on a single \LaTeX{} topic. - -A couple of reference documents (it would be good to have more) are -listed in an \Qref*{answer of their own}{Q-ref-doc}. - -Next comes the (rather new) field of % ! line break -\Qref*{\TeX{}-related WIKIs}{Q-doc-wiki}. - -A rather short list gives us a % ! line break -\Qref*{Typography style tutorial}{Q-typo-style}. - -Finally, we have a set of links to -\Qref*{Directories of \AllTeX{} information}{Q-doc-dirs}, and details -of some ``\Qref*{books}{Q-ol-books}'' that were once published -conventionally, but are now available on-line. - -\Question[Q-man-tex]{Online introductions: \plaintex{}} - -Michael Doob's splendid `Gentle Introduction' to \plaintex{} -(available on \acro{CTAN}) has been stable for a very long time. - -Another recommendable document is D. R.~Wilkins `Getting started with \TeX{}', -available on the web at \URL{http://www.ntg.nl/doc/wilkins/pllong.pdf} -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Gentle Introduction]\CTANref{gentle} -\end{ctanrefs} - -\Question[Q-man-latex]{Online introductions: \LaTeX{}} - -A pleasing little document, ``Getting something out of \LaTeX{}'' is -designed to give a feel of \LaTeX{} to someone who's never used it at -all. It's not a tutorial, merely helps the user to decide whether to -go on to a tutorial, and to `real' use of \LaTeX{}. - -Tobias Oetiker's `(Not so) Short Introduction to \LaTeXe{}', is -regularly updated, as people suggest better ways of explaining things, -etc. The introduction is available on \acro{CTAN}, together with -translations into a rather large set of languages. - -Peter Flynn's ``Beginner's \LaTeX{}'' (which started life as course -material) is a pleasing read. A complete copy may be found on -\acro{CTAN}, but it may also be browsed over the web -(\URL{http://www.tex.ac.uk/tex-archive/info/beginlatex/html/}). - -Harvey Greenberg's `Simplified Introduction to \LaTeX{}' was written -for a lecture course, and is also available on \acro{CTAN} (in \PS{} -only, unfortunately). - -The fourth edition of George Gr\"atzer's book ``Math into \LaTeX{}'' -contains a ``short course'' in \LaTeX{} itself, and that course has -been made publicly available on \acro{CTAN}. - -Edith Hodgen's % beware line break -\href{http://www.mcs.vuw.ac.nz/~david/latex/notes.pdf}{\LaTeX{}, a Braindump} -starts you from the ground up~--- giving a basic tutorial in the use -of \ProgName{Linux} to get you going (rather a large file\dots{}). -Its parent site, David Friggens' % ! line break -\href{http://www.mcs.vuw.ac.nz/~david/latex/}{documentation page} is a -useful collection of links in itself. - -% ! line break -\href{http://www.andy-roberts.net/misc/latex/}{Andy Roberts' introductory material} -is a pleasing short introduction to the use of \AllTeX{}; some of the -slides for \emph{actual} tutorials are to be found on the page, as -well. - -Chris Harrison's % ! line break -\href{http://www.chrisharrison.co.uk/xophbook/mybooks/tex/index.html}{TeX book} -presents basic \LaTeX{} with useful hints for extensions - -Nicola Talbot's % ! line break -\href{http://theoval.cmp.uea.ac.uk/~nlct/latex/novices/}{\LaTeX{} for complete novices} -does what it claims: the author teaches \LaTeX{} at the University of -East Anglia. That is one of several of Nicola's % ! line break -\href{http://theoval.cmp.uea.ac.uk/~nlct/latex/}{introductory tutorials}, -which include exercises (with solutions). Other tutorials include -those for writing theses/dissertations with \LaTeX{}, and for using -\LaTeX{} in administrative work. (The page seems to be an adjunct to -her \LaTeX{} courses~--- fortunate people, the people of \acro{UEA}!). - -An interesting (and practical) tutorial about what \emph{not} to do is -\Package{l2tabu}, or ``A list of sins of \LaTeXe{} users'' by Mark -Trettin, translated into English by J\"urgen Fenn. The -tutorial is available from \acro{CTAN} as a \acro{PDF} file (though -the source is also available). -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Beginner's \LaTeX{}]\CTANref{beginlatex-pdf} -\item[\nothtml{\rmfamily}First \LaTeX{} document]\CTANref{first-latex-doc} -\item[\nothtml{\rmfamily}Not so Short Introduction]\CTANref{lshort} - (in English, you may browse for sources and other language versions at - \CTANref{lshort-parent}) -\item[\nothtml{\rmfamily}Simplified \LaTeX{}]\CTANref{simpl-latex} -\item[\nothtml{\rmfamily}Short Course in \LaTeX{}]\CTANref{mil-short} -% ! line break -\item[\nothtml{\rmfamily}The sins of \LaTeX{} users]\CTANref{l2tabuen}; - source also available: \CTANref{l2tabuen.src} -\end{ctanrefs} - -\Question[Q-tutbitslatex]{Specialised \AllTeX{} tutorials} - -The \acro{AMS} publishes a ``Short Math Guide for \LaTeX{}'', which is -available (in several formats) via -\URL{http://www.ams.org/tex/short-math-guide.html} - -Herbert Vo\ss{} has written an extensive guide to mathematics in -\LaTeX{} (a German version of which is published as a book). The -guide is part of his ``\Qref*{tips and tricks}{Q-doc-dirs}'' and -a copy is maintained on \acro{CTAN}. -%\URL{http://www.perce.de/LaTeX/math/Mathmode-TeX.pdf} - -Two documents written more than ten years apart about font usage in -\TeX{} are worth reading: % ! line breaks, next 3 lines -\href{href='http://www.tug.org/TUGboat/Articles/tb14-2/tb39rahtz-nfss.pdf}{Essential NFSS} -by Sebastian Rahtz, and -\href{http://tug.org/pracjourn/2006-1/schmidt/schmidt.pdf}{Font selection in LaTeX}, -cast in the form of an \acro{FAQ}, by Walter Schmidt. A general -compendium of font information (including the two above) may be found -on the \href{http://www.tug.org/fonts/}{TUG web site}. - -Peter Smith's -\begin{narrowversion} - ``\LaTeX{} for Logicians'' - (\URL{http://www.phil.cam.ac.uk/teaching_staff/Smith/LaTeX/}) -\end{narrowversion} -\begin{wideversion} - % ! line break - ``\href{http://www.phil.cam.ac.uk/teaching_staff/Smith/LaTeX/}{\LaTeX{} for Logicians}'' -\end{wideversion} -covers a rather smaller subject area, but is similarly comprehensive -(mostly by links to documents on relevant topics, rather than as a -monolithic document). - -Keith Reckdahl's ``Using Imported Graphics in \LaTeXe{}'' is an -excellent introduction to graphics use. It's available on -\acro{CTAN}, but the sources aren't available (promised ``some time -soon''). - -Kjell Magne Fauske offers a set of examples of the use of the drawing -packages % ! line break -\Qref*{\acro{PGF} and \acro{T}ik\acro{Z}}{Q-drawing}; the % ! line break -\href{http://www.texample.net/tikz/examples/}{examples catalogue} -includes examples (with output) from the package documentation as well -as code written by the author himself. - -Vincent Zoonekynd provides a set of excellent (and graphic) tutorials -on the programming of % !line breaks, ... -\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_title/0.html}{title page styles}, -\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_chapter/0.html}{chapter heading styles} -and -\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_section/0.html}{section heading styles}. -In each file, there is a selection of graphics representing an output -style, and for each style, the code that produces it is shown. - -An invaluable step-by-step setup guide for establishing a ``work -flow'' through your \AllTeX{} system, so that output appears at the -correct size and position on standard-sized paper, and that the print -quality is satisfactory, is Mike Shell's \Package{testflow}. The -tutorial consists of a large plain text document, and there is a -supporting \LaTeX{} file together with correct output, both in \PS{} and -\acro{PDF}, for each of \acro{A}4 and ``letter'' paper sizes. The -complete kit is available on \acro{CTAN} (distributed with the -author's macros for papers submitted for \acro{IEEE} publications). -The issues are also covered in a later % ! line break -\Qref{\acro{FAQ} answer}{Q-dvips-pdf}. - -Documentation of Japanese \TeX{} use appears at least twice on the web: -Haruhiko Okumura's page on -% ! line break -\href{http://oku.edu.mie-u.ac.jp/~okumura/texfaq/japanese/}{typesetting Japanese with Omega} -(the parent page is in Japanese, so out of the scope of this -\acro{FAQ}). - -One ``Tim'' documents p\TeX{} (a \TeX{} system widely used in Japan) -in his -\begin{narrowversion} - ``English notes on p\TeX{}'' (see - \url{http://www.users.waitrose.com/~nihilist/English_Notes_on_pTex.pdf}). -\end{narrowversion} -\begin{wideversion} - % ! line break - ``\href{http://www.users.waitrose.com/~nihilist/English_Notes_on_pTex.pdf}{English notes on p\TeX{}}''. -\end{wideversion} - -Some university departments make their local documentation available -on the web. Most straightforwardly, there's the simple translation of -existing documentation into \acro{HTML}, for example the \acro{INFO} -documentation of the \AllTeX{} installation, of which a sample is the -\LaTeX{} documentation available at -\URL{http://www.tac.dk/cgi-bin/info2www?(latex)} - -More ambitiously, some university departments have enthusiastic -documenters who -make public record of their \AllTeX{} support. For example, Tim Love -(of Cambridge University Engineering Department) maintains his -deparment's pages at -\URL{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/} -%% and Mimi -%% Burbank (of the School of Computer Science \& Information Technology -%% at the University of Florida) manages her department's at -%% \URL{http://www.csit.fsu.edu/~mimi/tex/}\nobreakspace--- both sets are fine -%% examples of good practice. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Graphics in \LaTeXe{}]the - document is available in \PS{} and \acro{PDF} formats as - \CTANref{epslatex_ps} and \CTANref{epslatex_pdf} respectively -\item[testflow]\CTANref{testflow} -\item[\nothtml{\rmfamily}Herbert Vo\ss{}'s Maths tutorial]\CTANref{voss-mathmode} -\end{ctanrefs} - -\Question[Q-ref-doc]{Reference documents} - -For \TeX{} primitive commands a rather nice % ! line break -\href{http://www.nmt.edu/tcc/help/pubs/texcrib.pdf}{quick reference booklet}, -by John W.~Shipman, is available; it's arranged in the same way as the -\TeX{}book. By contrast, you can view David Bausum's % ! line break -\href{http://www.tug.org/utilities/plain/cseq.html}{list of \TeX{} primitives} -alphabetically or arranged by ``family''. Either way, the list has a -link for each control sequence, that leads you to a detailed -description, which includes page references to the \TeX{}book. - -There doesn't seem to be a reference that takes in \plaintex{} as -well as the primitive commands. - -An interesting \LaTeX{} ``cheat sheet'' is available from \acro{CTAN}: -it's a list of (more or less) everything you `ought to' remember, for -basic \LaTeX{} use. (It's laid out very compactly for printing on N.\ -American `letter'; printed on \acro{ISO} \acro{A}4, it strains aged eyes\dots{}) - -Similarly, there's no completely reliable command-organised reference -to \LaTeX{}. The page (provided by NASA) % ! line break -\href{http://www.giss.nasa.gov/latex/}{Hypertext Help with LaTeX} is -recently much improved. It still talks in \LaTeXo{}-isms in places, -but it's been updated for current \LaTeX{}. There are a number of -mirrors of the site, and it may be worth choosing a ``local'' one if -you're going to use it a lot. - -Another \LaTeXe{} reference (provided by the Emerson Center of Emory -University) is: % ! line break -\href{http://www.emerson.emory.edu/services/latex/latex2e/latex2e_toc.html}{LaTeXe help} -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Cheat sheet]\CTANref{latexcheat} -\end{ctanrefs} - -\Question[Q-doc-wiki]{WIKI pages for \TeX{} and friends} - -The \emph{WIKI} concept can be a boon to everyone, if used sensibly. -The ``general'' WIKI allows \emph{anyone} to add stuff, or to edit -stuff that someone else has added: while there is obvious potential -for chaos, there is evidence that a strong user community can keep a -WIKI under control. - -Following the encouraging performance of the % ! line break -\href{http://contextgarden.net/}{\CONTeXT{} WIKI}, valiant efforts -have been made generating ``WIKI books'' for \AllTeX{} users. Thus we -have \href{http://en.wikibooks.org/wiki/TeX}{(Plain) \TeX{} WIKI} and -\href{http://en.wikibooks.org/wiki/LaTeX}{\LaTeX{} WIKI} are well -established. Neither would seem yet to be of publication quality, but -they both seem useful reference sources. - -\Question[Q-typo-style]{Typography tutorials} - -Peter Wilson's manual for his \Class{memoir} class has a lengthy -introductory section on typographic considerations, which is a fine -tutorial, written by someone who is aware of the issues as they apply -to \AllTeX{} users. - -There's also (at least one) typographic style tutorial available on -the Web, the excellent % ! line break -``\href*{http://www.nbcs.rutgers.edu/~hedrick/typography/typography.janson-syntax.107514.pdf}{Guidelines for Typography in NBCS}''. -In fact, its % !! -\href*{http://www.nbcs.rutgers.edu/~hedrick/typography/index.html}{parent page} -is also worth a read: among other things, it provides copies of the -``guidelines'' document in a wide variety of primary fonts, for -comparison purposes. The author is careful to explain that he has no -ambition to supplant such excellent books as -\Qref*{Bringhurst's}{Q-typebooks}, but the document (though it does -contain its Rutgers-local matter) is a fine introduction to the issues -of producing readable documents. -\begin{ctanrefs} -\item[memoir \nothtml{\rmfamily}distribution]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-doc-dirs]{Directories of \AllTeX{} information} - -T\acro{UG} India is developing a series of online \LaTeX{} tutorials -which can be strongly recommended: select single chapters at a time -from \URL{http://www.tug.org.in/tutorials.html}\nobreakspace--- the -set comprises two parts, ``Text'' and ``Graphics'', so far. - -Herbert Vo\ss{}'s excellent % beware line break -\href{http://texnik.de/}{\LaTeX{} tips and tricks} is an excellent -source of small articles on the use of \LaTeX{}. - -\Question[Q-ol-books]{Freely available \AllTeX{} books} - -People have long argued for \AllTeX{} books to be made available on -the web, and until relatively recently this demand went un-answered. - -The first to appear was Victor Eijkhout's excellent ``\TeX{} by -Topic'' in 2001 (it had been published by Addison-Wesley, but was long -out of print). The book is now available on \acro{CTAN}; it's not a -beginner's tutorial but it's a fine reference. It's also available, -as a printed copy, via the on-line publishers -\href{http://www.lulu.com/content/2555607/}{Lulu} (not quite free, of -course, but not a \emph{bad} deal\dots{}). - -Addison-Wesley have also released the copyright of ``\TeX{} for the -Impatient'' by Paul W.~Abrahams, Karl Berry and Kathryn A.~Hargreaves, -another book whose unavailability many have lamented. The authors -have re-released the book under the \acro{GNU} Free Documentation -Licence, and it is available from \acro{CTAN}. - -Norm Walsh's ``Making \TeX{} Work'' (originally published by O'Reilly) -is also available (free) on the Web, at -\URL{http://makingtexwork.sourceforge.net/mtw/}; the sources of the -Web page are on \acro{CTAN}. The book was an excellent resource in -its day, but while it is now somewhat dated, it still has its uses, -and is a welcome addition to the list of on-line resources. A project -to update it is believed to be under way. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Making \TeX{} Work]\CTANref{mtw} -\item[\nothtml{\rmfamily}\TeX{} by Topic]\CTANref{texbytopic} -\item[\nothtml{\rmfamily}\TeX{} for the Impatient]\CTANref{TftI} -\end{ctanrefs} - -\Question[Q-pkgdoc]{Documentation of packages} - -These \acro{FAQ}s regularly suggest packages that will ``solve'' -particular problems. In some cases, the answer provides a recipe for -the job. In other cases, or when the solution needs elaborating, how -is the poor user to find out what to do? - -If you're lucky, the package you need is already in your installation. -If you're particularly lucky, you're using a distribution that gives -access to package documentation and the documentation is available in -a form that can easily be shown. For example, on many current -distributions, the \ProgName{texdoc} command often helps, as in: -\begin{quote} -\begin{verbatim} -texdoc footmisc -\end{verbatim} -\end{quote} -which opens a window showing documentation of the -\Package{footmisc} package. According to the type of file -\ProgName{texdoc} finds, it will launch a \acro{DVI} viewer -or a \acro{PDF} reader. - -If \ProgName{texdoc} can't find any documentation, it may launch a Web -browser to look at its copy of the \acro{CTAN} catalogue. The -catalogue has an entry for package documentation, and since the -\acro{CTAN} team asks authors documentation of their packages (and -members of the team even occasionally generate documentation that -seems useful), you will more often than not find documentation that -way. - -If your luck (as defined above) doesn't hold out, you've got to find -documentation by other means. This is where you need to exercise your -intelligence: you have to find the documentation for yourself. What -follows offers a range of possible techniques. - -The commonest form of documentation of \LaTeX{} add-ons is within the -\extension{dtx} file in which the code is distributed (see -\Qref[answer]{documented \LaTeX{} sources}{Q-dtx}). Such files -are supposedly processable by \LaTeX{} itself, but there are -occasional hiccups on the way to readable documentation. Common -problems are that the package itself is needed to process its own -documentation (so must be unpacked before processing), and that the -\extension{dtx} file will \emph{not} in fact process with \LaTeX{}. In the -latter case, the \extension{ins} file will usually produce a -\extension{drv} (or similarly-named) file, which you process with -\LaTeX{} instead. (Sometimes the package author even thinks to -mention this wrinkle in a package \texttt{README} file.) - -Another common form is the separate documentation file; particularly -if a package is ``conceptually large'' (and therefore needs a lot of -documentation), the documentation would prove a cumbersome extension -to the \extension{dtx} file. Examples of such cases are the \Class{memoir} -class (whose documentation, \File{memman}, is widely praised as an -introduction to typesetting concepts), the \Class{KOMA-script} bundle -(whose developers take the trouble to produce detailed documentation -in both German and English), and the \Package{fancyhdr} package (whose -documentation derives from a definitive tutorial in a mathematical -journal). Even if the documentation is not separately identified in a -\texttt{README} file, it should not be too difficult to recognise its -existence. - -Documentation within the package itself is the third common form. -Such documentation ordinarily appears in comments at the head of the -file, though at least one eminent author regularly places it after the -\csx{endinput} command in the package. (This is desirable, since -\csx{endinput} is a `logical' end-of-file, and \AllTeX{} doesn't read -beyond it: thus such documentation does not `cost' any package loading time.) - -The above suggestions cover most possible ways of finding -documentation. If, despite your best efforts, you can't find -it in any of the above places, there's the awful possibility that the -author didn't bother to document his package (on the ``if it was hard -to write, it should be hard to use'' philosophy). Most ordinary -mortals will seek support from some more experienced user at this -stage, though it \emph{is} possible to proceed in the way that the original -author apparently expected\dots{}by reading his code. - -\Question[Q-writecls]{Learning to write \LaTeX{} classes and packages} - -There's nothing particularly magic about the commands you use when -writing a package, so you can simply bundle up a set of \LaTeX{} -\csx{(re)newcommand} and \csx{(re)newenvironment} commands, put them in -a file \File{package.sty} and you have a package. - -However, any but the most trivial package will require rather more -sophistication. Some details of \LaTeX{} commands for the job are to -be found in `\LaTeXe{} for class and package writers' -(\File{clsguide}, part of the \LaTeX{} documentation distribution). -Beyond this, a good knowledge of \TeX{} itself is valuable: thus books -such as the \Qref*{\TeX{}book}{Q-books} or % ! line break -\Qref*{\TeX{} by topic}{Q-ol-books} are relevant. With good \TeX{} -knowledge it is possible to use the documented source of \LaTeX{} as -reference material (dedicated authors will acquaint themselves with the -source as a matter of course). A complete set of the documented -source of \LaTeX{} may be prepared by processing the file -\File{source2e.tex} in the \LaTeX{} distribution. Such processing is -noticeably tedious, but Heiko Oberdiek has prepared a well-linked -\acro{PDF} version, which is in the file \File{base.tds.zip} of his -\ProgName{latex-tds} distribution. Individual files in the \LaTeX{} -distribution may be processed separately with \LaTeX{}, like any -well-constructed \Qref*{\extension{dtx} file}{Q-dtx}. - -Writing good classes is not easy; it's a good idea to read some -established ones (\File{classes.dtx}, for example, is the documented -source of the standard classes other than \Class{Letter}, and may -itself be formatted with \LaTeX{}). Classes that are not part of the -distribution are commonly based on ones that are, and start by loading -the standard class with \csx{LoadClass}~--- an example of this -technique may be seen in \Package{ltxguide.cls} - -An % !! line break -\href{http://tug.org/TUGboat/Articles/tb28-1/tb88flynn.pdf}{annotated version of \Class{article}}, -as it appears in \File{classes.dtx}, was published in -\TUGboat{} 28(1). The article, by Peter Flynn, which is some help in -understanding \File{classes.dtx} -\begin{ctanrefs} -\item[classes.dtx]\CTANref{latex-classes} -\item[clsguide.pdf]\CTANref{clsguide} -\item[latex-tds \nothtml{rmfamily}collection]\CTANref{latex-tds} -\item[ltxguide.cls]\CTANref{ltxguide} -\item[\nothtml{\rmfamily}\LaTeX{} documentation]\CTANref{latexdoc} -\item[source2e.tex]\CTANref{latex-source} -\end{ctanrefs} - -\Question[Q-mfptutorials]{\MF{} and \MP{} Tutorials} - -Apart from Knuth's book, there seems to be only one publicly-available -\href{http://metafont.tutorial.free.fr/}{tutorial for \MF{}}, by -Christophe Grandsire (a copy in \acro{PDF} form may be downloaded). -Geoffrey Tobin's \textit{\MF{} for Beginners} % !! line break -(see \Qref[question]{using \MF{}}{Q-useMF}) describes how the \MF{} -system works and how to avoid some of the potential pitfalls. - -There is also an article on how to run both \MF{} and \MP{} (the -programs). Peter Wilson's % !! line break -\textit{Some Experiences in Running \MF{} and \MP{}} -offers the benefit of Peter's experience (he has designed a number of -`historical' fonts using \MF{}). For \MF{} the article is geared -towards testing and installing new \MF{} fonts, while its \MP{} -section describes how to use \MP{} illustrations in \LaTeX{} and -\PDFLaTeX{} documents, with an emphasis on how to use appropriate -fonts for any text or mathematics. - -% Hans Hagen (of \CONTeXT{} fame) offers a \MP{} tutorial called -% MetaFun (which admittedly concentrates on the use of \MP{} within -% \CONTeXT{}). It may be found on his company's % ! line break -% \href{http://www.pragma-ade.com/metapost.htm}{\MP{} page}. - -Other \MP{} tutorials that have appeared are two in English by % ! line breaks -\href{http://remote.science.uva.nl/~heck/Courses/mptut.pdf}{Andr\'e Heck} -and \href{http://www.tlhiv.org/MetaPost/tutorial/}{Urs Oswald}, -and one in French (listed here because it's clearly enough written -that even this author understands it), by -\href{http://pauillac.inria.fr/~cheno/metapost/metapost.pdf}{Laurent Ch\'eno}; -both have been recommended for inclusion in the \acro{FAQ} - -Urs Oswald's tutorial is accompanied by a super tool (by Troy -Henderson) for testing little bits of \MP{}, which is an invaluable -aid to the learner: \URL{http://www.tlhiv.org/mppreview} - -Vincent Zoonekynd's massive set of example \MP{} files is available on -\acro{CTAN}; the set includes a \ProgName{Perl} script to convert the -set to html, and the set may be % beware line break -\href{http://zoonek.free.fr/LaTeX/Metapost/metapost.html}{viewed on the web}. -While these examples don't exactly constitute a ``tutorial'', they're -most certainly valuable learning material. Urs Oswald presents a -\href{http://www.ursoswald.ch/metapost/tutorial.pdf}{similar document}, -written more as a document, and presented in \acro{PDF}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Beginners' guide]\CTANref{mf-beginners} -\item[\nothtml{\rmfamily}Peter Wilson's ``experiences'']\CTANref{metafp-pdf} -\item[\nothtml{\rmfamily}Vincent Zoonekynd's examples]\CTANref{zoon-mp-eg} -\end{ctanrefs} - -\Question[Q-BibTeXing]{\BibTeX{} Documentation} - -\BibTeX{}, a program originally designed to produce bibliographies in -conjunction with \LaTeX{}, is explained in Section~4.3 and Appendix~B -of Leslie Lamport's \LaTeX{} manual. -The document ``\BibTeX{}ing'', contained in the file \File{btxdoc.tex}, -expands on the chapter in Lamport's book. \emph{The \LaTeX{} Companion} -also has information on \BibTeX{} and writing \BibTeX{} style files. -(See \Qref[question]{TeX-related books}{Q-books} for details of both -books.) - -The document ``Designing \BibTeX{} Styles'', contained in the file -\File{btxhak.tex}, explains the postfix stack-based language used to -write \BibTeX{} styles (\File{.bst} files). The file \File{btxbst.doc} -is the template for the four standard styles (\Package{plain}, -\Package{abbrv}, \Package{alpha}, and \Package{unsrt}). It also -contains their documentation. The complete \BibTeX{} documentation -set (including all the files above) is available on \acro{CTAN}. - -A useful tutorial of the whole process of using \BibTeX{} is Nicolas -Markey's ``\emph{Tame the BeaST (The B to X of \BibTeX{})}'', which -may also be found on \acro{CTAN}. A summary and \acro{FAQ} -(\File{btxFAQ}), by Michael Shell and David Hoadley, is also to be -recommended. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\BibTeX{} documentation]\CTANref{bibtex-doc} -\item[btxFAQ.pdf]\CTANref{bibtex-faq} -\item[\nothtml{\rmfamily}Tame the BeaST]\CTANref{ttb-pdf} -\end{ctanrefs} - -\Question[Q-symbols]{Where can I find the symbol for\,\dots{}} -\keywords{assignment circular integral degrees diagonal dots Fourier transform} -\keywords{Laplace greater less complex integer natural real} -\keywords{cent euro} - -There is a wide range of symbols available for use with \TeX{}, most -of which are not shown (or even mentioned) in \AllTeX{} books. -\emph{The Comprehensive \LaTeX{} Symbol List} (by Scott Pakin -% beware line wrap -\emph{et al.}\@) illustrates over 2000 symbols, and details the -commands and the \LaTeX{} packages needed to produce them. - -Other questions in this \acro{FAQ} offer specific help on kinds of -symbols: -\begin{itemize} -\item \Qref*{Script fonts for mathematics}{Q-scriptfonts} -\item \Qref*{Fonts for the number sets}{Q-numbersets} -\item \Qref*{Typesetting the principal value integral}{Q-prinvalint} -\end{itemize} -\begin{ctanrefs} -\item[Symbol List]Browse \CTANref{symbols}; there are processed - versions in both \PS{} and \acro{PDF} forms for both A4 and - letter paper. -\end{ctanrefs} - -\Question[Q-docpictex]{The \PiCTeX{} manual} - -\PiCTeX{} is a set of macros by Michael Wichura for drawing diagrams -and pictures. The -macros are freely available; however, the -\PiCTeX{} manual itself is not free. -Unfortunately, \acro{TUG} is no longer able to supply copies of the -manual (as it once did), and it is now available only through Personal -\TeX{} Inc, the vendors of PC\TeX{} (\URL{http://www.pctex.com/}). The -manual is \emph{not} available electronically. - -However, there \emph{is} a summary of \PiCTeX{} commands available on -\acro{CTAN}, which is a great aide-memoire for those who basically -know the package to start with. -\begin{ctanrefs} -\item[pictex]\CTANref{pictex} -\item[PiCTeX summary]\CTANref{pictex-summary} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Bits and pieces of \AllTeX{}} - -\Question[Q-dvi]{What is a \acro{DVI} file?} - -A \acro{DVI} file (that is, a file with the type or extension -\extension{dvi}) is \TeX{}'s main output file, using \TeX{} in its -broadest sense to include \LaTeX{}, etc. `\acro{DVI}' is supposed to -be an acronym for \acro{D}e\acro{V}ice-\acro{I}ndependent, meaning -that the file can be printed on most -kinds of typographic output device. The \acro{DVI} file is designed to be -read by a driver (\Qref{DVI drivers}{Q-driver}) to produce -further output designed specifically for a particular printer (e.g., a -LaserJet) or to be used as input to a previewer for display on a -computer screen. \acro{DVI} files use \TeX{}'s internal coding; a \TeX{} -input file should produce the same \acro{DVI} file regardless of which -implementation of \TeX{} is used to produce it. - -A \acro{DVI} file contains all the information that is needed for printing -or previewing except for the actual bitmaps or outlines of fonts, and -possibly material to be introduced by means of -\Qref*{\csx{special} commands}{Q-specials}. - -The canonical reference for the structure of a \acro{DVI} file is the -source of Knuth's program \ProgName{dvitype} (whose original purpose, -as its name implies, was to view the content of a \acro{DVI} file). -\begin{ctanrefs} -\item[dvitype]\CTANref{dvitype} -\end{ctanrefs} - -\Question[Q-driver]{What is a \acro{DVI} driver?} - -A \acro{DVI} driver is a program that takes as input a \acro{DVI} file -(\Qref{\acro{DVI} files}{Q-dvi}) and -(usually) produces a file that can be sent to a typographic -output device (which we will call a printer, for short), or to another -format. - -A driver will usually be specific to a particular printer, -although any \PS{} printer ought to be able to print -the output from a \PS{} driver. -% (these are also called \PS{} conversion programs). - -As well as the \acro{DVI} file, the driver also needs font information. -Font information may be held as bitmaps or as outlines, or simply as a -set of pointers into the fonts that the printer itself `has'. -Each driver will expect the font information in -a particular form. For more information on the forms of fonts, -see \Qref[questions]{\acro{PK} files}{Q-pk}, -% ! line break -\Qref[]{\acro{TFM} files}{Q-tfm}, -\Qref[]{virtual fonts}{Q-virtualfonts} -and \Qref[]{Using \PS{} fonts with \TeX{}}{Q-usepsfont}. - -\Question[Q-pk]{What are \acro{PK} files?} - -\acro{PK} files (packed raster) contain font bitmaps. The output -from \Qref*{\MF{}}{Q-useMF} includes a generic font (\acro{GF}) file -and the utility \ProgName{gftopk} produces the \acro{PK} file from -that. There are a lot of \acro{PK} files, as one is needed for each -font, that is each magnification (size) of each design (point) size -for each weight for each family. Further, since the \acro{PK} files -for one printer do not necessarily work well for another, the whole -set needs to be duplicated for each printer type at a site. In a -modern \TeX{} distribution, files are arranged according to the \TeX{} -directory structure \Qref*{\acro{TDS}}{Q-tds}, which has provision for -all this variety. - -\Question[Q-tfm]{What are \acro{TFM} files?} - -\acro{TFM} stands for \TeX{} Font Metrics; \acro{TFM} files hold -information about the sizes of the characters of the font in question, -and about ligatures and kerns within that font. One \acro{TFM} file is -needed for each font used by \TeX{}, that is for each design (point) -size for each weight for each family; each \acro{TFM} file serves for all -magnifications of `its' font, so that there are (typically) fewer -\acro{TFM} files than there are \acro{PK} files. \TeX{} (\LaTeX{}, etc.\@) -itself needs only to know about the sizes of characters and their -interactions with each other, but not what characters look like. By -contrast, \acro{TFM} files are not, in principle, needed by the -\acro{DVI} driver, which only needs to know about the glyphs that each -character selects, so as to print or display them. - -\Question[Q-virtualfonts]{Virtual fonts} - -Virtual fonts provide a means of collecting bits and pieces together -to make the glyphs of a font: the bits and pieces may be other glyphs, -rules and other ``basic'' typesetting commands, and the positioning -information that specifies how everything comes together. - -Things that match the concept of virtual fonts for \TeX{} were first -implemented by David Fuchs in the very early days. However, for practical -purposes for the rest of us, virtual fonts date from when Knuth -specified a format and wrote some support software, in 1989 (he -published an article in \textsl{TUGboat} at the time, and a plain text -copy is available on \acro{CTAN}). - -Virtual fonts provide a way of telling \TeX{} about something more -complicated than just a one-to-one character mapping. The entities you -define in a virtual font look like characters to \TeX{} (they appear -with their sizes in a \acro{TFM} file), but the \acro{DVI} processor may -expand them to something quite different. - -From the virtual font file, the \acro{DVI} processor learns -details of what is in the virtual font, so as to know ``what to draw, -where''. The virtual font may contain commands: -\begin{itemize} -\item just to remap the glyphs of a single font, -\item to make a composite font with glyphs drawn from several - different fonts, or -\item to build up an effect in arbitrarily complicated ways (since a - virtual font may contain anything which is legal in a \acro{DVI} - file). -\end{itemize} - -% !this has to be generated as a new paragraph by the translator, so -% leave the blank line in place -In practice, the most common use of virtual fonts is to remap -Adobe Type 1 fonts (see \Qref[question]{font metrics}{Q-metrics}), -though there has also been useful useful work building `fake' maths -fonts (by bundling glyphs from several fonts into a single virtual -font). Virtual Computer Modern fonts, making a % ! line break -\Qref*{Cork encoded}{Q-ECfonts} font from Knuth's originals by using -remapping and fragments of \acro{DVI} for single-glyph `accented -characters', were the first ``Type~1 format'' Cork-encoded Computer -Modern fonts available. - -Virtual fonts are normally created in a single \acro{ASCII} -\acro{VPL} (Virtual Property List) file, which includes both sets of -information. The \ProgName{vptovf} program is then used to the create -the binary \acro{TFM} and \acro{VF} files. - -A ``how-to'' document, explaining how to generate a \acro{VPL}, -describes the endless hours of fun that may be had, doing the job by -hand. Despite the pleasures to be had of the manual method, the -commonest way (nowadays) of generating \acro{VPL} files is to use the -\ProgName{fontinst} package, which is described in detail -\htmlonly{together with the discussion of} -\Qref[in answer]{\PS{} font metrics}{Q-metrics}. -\Package{Qdtexvpl} is another utility for creating ad-hoc virtual -fonts (it uses \TeX{} to parse a description of the virtual font, and -\ProgName{qdtexvpl} itself processes the resulting \acro{DVI} file). -\begin{ctanrefs} -\item[fontinst]\CTANref{fontinst} -\item[\nothtml{\rmfamily}Knuth on virtual fonts]\CTANref{vf-knuth} -\item[\nothtml{\rmfamily}Virtual fonts ``how to'']\CTANref{vf-howto} -\item[qdtexvpl]\CTANref{qdtexvpl} -\end{ctanrefs} - -\Question[Q-whatmacros]{What are (\TeX{}) macros} - -\TeX{} is a \emph{macro processor}: this is a computer-science-y term -meaning ``text expander'' (more or less); \TeX{} typesets text as it -goes along, but \emph{expands} each macro it finds. \TeX{}'s macros -may include instructions to \TeX{} itself, on top of the simple text -generation one might expect. - -Macros are a \emph{good thing}, since they allow the user to -manipulate documents according to context. For example, the macro -\csx{TeX} is usually defined to produce ``TEX'' with the `E' lowered, -but in these \acro{FAQ}s the default definition of the macro is -overridden, and it simply expands to the letters ``TeX''. (\emph{You} -may not think this a good thing, but the author of the macros has his -reasons~-- see \Qref[question]{\TeX{}-related logos}{Q-logos}.) - -Macro names are conventionally built from a \texttt{\textbackslash } -followed by a sequence of letters, which may be upper or lower case -(as in \csx{TeX}, mentioned above). They may also be % ! line break -\texttt{\textbackslash \meta{any single character}}, which allows all -sorts of oddities (many built in to most \TeX{} macro sets, all the -way up from the apparently simple `\csx{ }' meaning ``insert a space -here''). - -Macro programming can be a complicated business, but at their very -simplest they need little introduction~--- you'll hardly need to be -told that: -\begin{quote} -\begin{verbatim} -\def\foo{bar} -\end{verbatim} -\end{quote} -replaces each instance of \csx{foo} with the text ``bar''. The -command \csx{def} is \plaintex{} syntax for defining commands; -\LaTeX{} offers a macro \csx{newcommand} that goes some way towards -protecting users from themselves, but basically does the same thing: -\begin{quote} -\begin{verbatim} -\newcommand{\foo}{bar} -\end{verbatim} -\end{quote} -Macros may have ``arguments'', which are used to substitute for marked -bits of the macro expansion: -\begin{quote} -\begin{verbatim} -\def\foo#1{This is a #1 bar} -... -\foo{2/4} -\end{verbatim} -\end{quote} -or, in \LaTeX{} speak: -\begin{quote} -\begin{verbatim} -\newcommand{\foo}[1]{This is a #1 bar} -... -\foo{3/4} -\end{verbatim} -\end{quote} -Macro writing can get very complicated, very quickly. If you are a -beginner \AllTeX{} programmer, you are well advised to read something -along the lines of the \Qref*{\TeX{}book}{Q-books}; once you're under -way, \Qref*{\TeX{} by Topic}{Q-ol-books} is possibly a more satisfactory -choice. Rather a lot of the answers in these \acro{FAQ}s tell you -about various issues of how to write macros. - -\Question[Q-specials]{\csx{special} commands} - -\TeX{} provides the means to express things that device drivers can -do, but about which \TeX{} itself knows nothing. For example, \TeX{} -itself knows nothing about how to include \PS{} figures into -documents, or how to set the colour of printed text; but some device -drivers do. - -Instructions for such things are introduced to your document by means -of \csx{special} commands; all that \TeX{} does with these commands is -to expand their -arguments and then pass the command to the \acro{DVI} file. In most -cases, there are macro packages provided (often with the driver) that -provide a human-friendly interface to the \csx{special}; for example, -there's little point including a figure if you leave no gap for it in -your text, and changing colour proves to be a particularly fraught -operation that requires real wizardry. \LaTeXe{} -has standard graphics and colour packages that make figure inclusion, -rotation and scaling, and colour typesetting relatively -straightforward, despite the rather daunting \csx{special} commands -involved. (\CONTeXT{} provides similar support, though not by way of -packages.) - -The allowable arguments of \csx{special} depend on the device driver -you're using. Apart from the examples above, there are \csx{special} -commands in the em\TeX{} drivers (e.g., \ProgName{dvihplj}, \ProgName{dviscr}, -\emph{etc}.)~that will draw lines at arbitrary orientations, and -commands in \ProgName{dvitoln03} that permit the page to be set in -landscape orientation. - -Note that \csx{special} provides rather different facilities in \PDFTeX{} -operation: since there is no device driver around, in this context. -In \PDFTeX{}, \csx{special} is only needed to generated \acro{PDF} for -which there is no existing defined \PDFTeX{} operation. - -\Question[Q-hyphen]{How does hyphenation work in \TeX{}?} - -Everyone knows what hyphenation is: we see it in most books we read, -and (if we're alert) will spot occasional ridiculous mis-hyphenation -(at one time, British newspapers were a fertile source). - -Hyphenation styles are culturally-determined, and the same language -may be hyphenated differently in different countries~--- for example, -British and American styles of hyphenation of English are very -different. As a result, a typesetting system that is not restricted -to a single language at a single locale needs to be able to change its -hyphenation rules from time to time. - -\TeX{} uses a pretty good system for hyphenation (originally designed -by Frank Liang~--- you may view his % ! line break -\href{http://tug.org/docs/liang/}{Ph.D.\ thesis online}), and while -it's capable of missing ``sensible'' hyphenation points, it seldom -selects grossly wrong ones. The -algorithm matches candidates for hyphenation against a set of -``hyphenation patterns''. The candidates for hyphenation must be -sequences of letters (or other single characters that \TeX{} may be -persuaded to think of as letters)~--- things such as \TeX{}'s -\csx{accent} primitive interrupt hyphenation. - -Sets of hyphenation patterns are usually derived from analysis of -a list of valid hyphenations (the process of derivation, using a tool -called \Package{patgen}, is not ordinarily a participatory sport). - -The patterns for the languages a \TeX{} system is going to deal with -may only be loaded when the system is installed. To change the set of -languages, a \Qref*{partial reinstallation}{Q-newlang} is necessary. - -\TeX{} provides two ``user-level'' commands for control of -hyphenation: \csx{language} (which selects a hyphenation style), and -\csx{hyphenation} (which gives explicit instructions to the hyphenation -engine, overriding the effect of the patterns). - -The ordinary \LaTeX{} user need not worry about \csx{language}, since -it is very thoroughly managed by the \Package{babel} package; use of -\csx{hyphenation} is discussed in -\begin{wideversion} - the context of -\end{wideversion} -% beware line wrap -\Qref[question]{hyphenation failure}{Q-nohyph}. - -\Question[Q-clsvpkg]{What are \LaTeX{} classes and packages?} - -Current \LaTeX{} makes a distinction between the macros that define the -overall layout of a document, and the macros that tweak that layout -(to one extent or another) to provide what the author \emph{really} -wants. - -The distinction was not very clear in \LaTeXo{}, and after some -discussion (in the later stages of development of current \LaTeX{}) -the names ``class'' and ``package'' were applied to the two concepts. - -The idea is that a document's \emph{class} tells \LaTeX{} what sort of -document it's dealing with, while the \emph{packages} the document -loads ``refine'' that overall specification. - -On the disc, the files only appear different by virtue of their name -``extension''~--- class files are called \texttt{*.cls} while package -files are called \texttt{*.sty}. Thus we find that the \LaTeX{} -standard \Class{article} class is represented on disc by a file called -\File{article.cls}, while the \Package{footmisc} package (which -refines \Class{article}'s definition of footnotes) is represented on -disc by a file called \File{footmisc.sty}. - -The user defines the class of his document with the -\csx{documentclass} command (typically the first command in a -document), and loads packages with the \csx{usepackage} command. A -document may have several \csx{usepackage} commands, but it may have -only one \csx{documentclass} command. (Note that there are -programming-interface versions of both commands, since a class may -choose to load another class to refine its capabilities, and both -classes and packages may choose to load other packages.) - -\Question[Q-dtx]{Documented \LaTeX{} sources (\extension{dtx} files)} - -\LaTeXe{}, and most contributed macro packages, are now written in a -\Qref*{literate programming style}{Q-lit}, with source and -documentation in the -same file. This format, known as `doc', in fact originated before the -days of the \LaTeX{} project as one of the ``Mainz'' series of -packages. A documented source file conventionally has the suffix -\extension{dtx}, and will normally be `stripped' before use with -\LaTeX{}; an installation file (\extension{ins}) is normally provided, -to automate this process of removing comments for speed of loading. -To read the comments, you can run \LaTeX{} on the -\extension{dtx} file to produce a nicely formatted version of the -documented code. Several -packages can be included in one \extension{dtx} file (they're sorted -out by the \extension{ins} file), with conditional -sections, and there are facilities for indexes of macros, etc. - -Anyone can write \extension{dtx} files; the format is explained in -\Qref*{The \LaTeX{} Companion}{Q-books}, and a tutorial is available -from \acro{CTAN} (which comes with skeleton \extension{dtx} and -\extension{ins} files). - -Composition of \extension{dtx} files is supported in \ProgName{emacs} by -\Qref*{\acro{AUC}-\TeX{}}{Q-editors}. - -Another useful way of generating \extension{dtx} files is to write the -documentation and the code separately, and then to combine them using -the \ProgName{makedtx} system. This technique has particular value in -that the documentation file can be used separately to generate -\acro{HTML} output; it is often quite difficult to make % ! line break -\Qref*{\LaTeX{} to \acro{HTML} conversion}{Q-LaTeX2HTML} tools deal -with \extension{dtx} files, since they use an unusual class file. - -The \extension{dtx} files are not used by \LaTeX{} after they have been -processed to produce \extension{sty} or \extension{cls} (or whatever) -files. They need not be kept with the working system; however, for -many packages the \extension{dtx} file is the primary source of -documentation, so you may want to keep \extension{dtx} files elsewhere. - -An interesting sideline to the story of \extension{dtx} files is the -\Package{docmfp} package, which extends the model of the \Package{doc} -package to -\begin{narrowversion} - \MF{} and \MP{} (\Qref[see questions]{}{Q-MF} and \Qref[\nothtml]{}{Q-MP}) -\end{narrowversion} -\begin{wideversion} - \Qref{\MF{}}{Q-MF} and \Qref{\MP{}}{Q-MP}, -\end{wideversion} -thus permitting documented distribution of bundles containing code for -\MF{} and \MP{} together with related \LaTeX{} code. -\begin{ctanrefs} -\item[clsguide.pdf]\CTANref{clsguide} -\item[docmfp.sty]\CTANref{docmfp} -\item[docstrip.tex]Part of the \LaTeX{} distribution -\item[DTX tutorial]\CTANref{dtxtut} -\item[makedtx]\CTANref{makedtx} -\end{ctanrefs} - -\Question[Q-whatenc]{What are encodings?} - -Let's start by defining two concepts, the \emph{character} and the -\emph{glyph}. -The character is the abstract idea of the `atom' of a -language or other dialogue: so it might be a letter in an alphabetic -language, a syllable in a syllabic language, or an ideogram in an -ideographic language. The glyph is the mark created on screen or -paper which represents a character. Of -course, if reading is to be possible, there must be some agreed -relationship between the glyph and the character, so while the precise -shape of the glyph can be affected by many other factors, such as the -capabilities of the writing medium and the designer's style, the -essence of the underlying character must be retained. - -Whenever a computer has to represent characters, someone has to define -the relationship between a set of numbers and the characters they -represent. This is the essence of an encoding: it is a mapping -between a set of numbers and a set of things to be represented. - -\TeX{} of course deals in encoded characters all the time: the -characters presented to it in its input are encoded, and it emits -encoded characters in its \acro{DVI} (or \acro{PDF}) output. These -encodings have rather different properties. - -The \TeX{} input stream was pretty unruly back in the days when Knuth -first implemented the language. Knuth himself prepared documents on -terminals that produced all sorts of odd characters, and as a result -\TeX{} contains some provision for translating the input encoding to -something regular. Nowadays, -the operating system translates keystrokes into a code appropriate for -the user's language: the encoding used is often a national or -international standard, though many operating systems use ``code -pages'' defined by Microsoft. These standards and code pages often -contain characters that can't appear in the \TeX{} system's input -stream. Somehow, these characters have to be dealt with~--- so -an input character like ``\'e'' needs to be interpreted by \TeX{} in -a way that that at least mimics the way it interprets ``\csx{'}\texttt{e}''. - -The \TeX{} output stream is in a somewhat different situation: -characters in it are to be used to select glyphs from the fonts to be -used. Thus the encoding of the output stream is notionally a font -encoding (though the font in question may be a -% beware line break (twice) -\nothtml{virtual one~--- see }% -\Qref[question]{virtual font}{Q-virtualfonts}). In principle, a -fair bit of what appears in the output stream could be direct -transcription of what arrived in the input, but the output stream -also contains the product of commands in the input, and translations -of the input such as ligatures like % -\texttt{fi}\nothtml{\ensuremath\Rightarrow``fi''}. - -Font encodings became a hot topic when the -\Qref*{Cork encoding}{Q-ECfonts} -appeared, because of the possibility of suppressing -\csx{accent} commands in the output stream (and hence improving the -quality of the hyphenation of text in inflected languages, which is -interrupted by the \csx{accent} commands~--- see -% beware line break -\Qref[question]{``how does hyphenation work''}{Q-hyphen}). -To take advantage of the diacriticised characters represented in the -fonts, it is necessary to arrange that whenever the -command sequence ``\csx{'}\texttt{e}'' has been input -(explicitly, or implicitly via the sort of mapping of input mentioned -above), the character that codes the position of the ``\'e'' glyph is -used. - -Thus we could have the odd arrangement that the diacriticised character in -the \TeX{} input stream is translated into \TeX{} commands that would -generate something looking like the input character; this sequence of -\TeX{} commands is then translated back again into a single -diacriticised glyph as the output is created. This is in fact -precisely what the \LaTeX{} packages \Package{inputenc} and -\Package{fontenc} do, if operated in tandem on (most) characters in -the \acro{ISO}~Latin-1 input encoding and the \acro{T}1 font encoding. -At first sight, it seems eccentric to have the first package do a thing, and -the second precisely undo it, but it doesn't always happen that way: -most font encodings can't match the corresponding input encoding -nearly so well, and the two packages provide the sort of symmetry the -\LaTeX{} system needs. - -\Question[Q-ECfonts]{What are the \acro{EC} fonts?} - -A font consists of a number of \emph{glyphs}. In order that the -glyphs may be printed, they are \Qref*{\emph{encoded}}{Q-whatenc}, and -the encoding is used as an index into tables within the font. For -various reasons, Knuth chose deeply eccentric encodings for his -Computer Modern family of fonts; in particular, he chose different -encodings for different fonts, so that the application using the fonts -has to remember which font of the family it's using before selecting a -particular glyph. - -When \TeX{} version 3 arrived, most of the excuses for the -eccentricity of Knuth's encodings went away, and at \acro{TUG}'s Cork -meeting, an encoding for a set of 256 glyphs, for use in \TeX{} text, -was defined. The intention was that these glyphs should cover `most' -European languages that use Latin alphabets, in the sense of including -all accented letters needed. (Knuth's \acro{CMR} fonts missed things -necessary for Icelandic and Polish, for example, but the Cork -fonts have them. Even Cork's coverage isn't complete: it misses -letters from Romanian, Eastern and Northern Sami, and Welsh, at -least. The Cork encoding does contain ``\acro{NG}'' glyphs that -allows it to support Southern Sami.) \LaTeX{} refers to the -Cork encoding as \acro{T}1, and -provides the means to use fonts thus encoded to avoid problems with -the interaction of accents and hyphenation % ! line break -(see \Qref[question]{hyphenation of accented words}{Q-hyphenaccents}). - -The only \MF{}-fonts that conform to the Cork encoding are the -\acro{EC} fonts. They look \acro{CM}-like, though their metrics -differ from \acro{CM}-font metrics in several areas. The fonts are -now regarded as `stable' (in the same sense that the \acro{CM} fonts -are stable: their metrics are unlikely ever to change). Their serious -disadvantages for the casual user are their size (each \acro{EC} font -is roughly twice the size of the corresponding \acro{CM} font), and -there are far more of them than there are \acro{CM} fonts. The simple -number of fonts has acted as a disincentive to the production of Adobe -Type~1 versions of the fonts, but several commercial suppliers offer -\acro{EC} or -\acro{EC}-equivalent fonts in type~1 or TrueType form~--- see -% beware line fill -\Qref[question]{commercial suppliers}{Q-commercial}. Free -\Qref{auto-traced versions}{Q-textrace} (the \acro{CM}-super -and the \acro{LGC} fonts), and the Latin Modern series (rather -directly generated from \MF{} sources), are available. - -%% Unfortunately, until corresponding fonts for mathematics are produced, -%% the \acro{CM} fonts must be retained, since some mathematical symbols -%% are drawn from text fonts in the \acro{CM} encodings. -Note that the Cork encoding doesn't cover mathematics (and neither do -``\acro{T}1-encoded'' font families, of course). If you're using -Computer-Modern-alike fonts, this doesn't actually matter: your system -will have the original Computer Modern fonts, which cover `basic' -\TeX{} mathematics; more advanced mathematics are likely to need -separate fonts anyway. Suitable mathematics fonts for use with other -font families are discussed in % ! line break -``\Qref{choice of scalable fonts}{Q-psfchoice}''. - -The \acro{EC} fonts are distributed with a -set of `Text Companion' (\acro{TC}) fonts that provide glyphs for -symbols commonly used in text. The \acro{TC} fonts are encoded -according to the \LaTeX{} \acro{TS}1 encoding, and are not viewed as -`stable' in the same way as are the \acro{EC} fonts are. - -The Cork encoding is also implemented by virtual fonts provided in the -\Qref*{\acro{PSNFSS} system}{Q-usepsfont}, -for Adobe Type~1 fonts, and also by the \Package{txfonts} and -\Package{pxfonts} font packages -% beware line wrap -(see \Qref[question]{``choice of scalable fonts''}{Q-psfchoice}). -\begin{ctanrefs} -\item[CM-super fonts]\CTANref{cm-super} -\item[CM-LGC fonts]\CTANref{cm-lgc} -\item[EC and TC fonts]\CTANref{ec} -\item[Latin Modern fonts]\CTANref{lm} -\end{ctanrefs} - -\Question[Q-tds]{What is the \acro{TDS}?} - - \acro{TDS} stands for the \TeX{} Directory Structure, which is a standard -way of organising all the \TeX{}-related files on a computer system. - - Most modern distributions conform to the \acro{TDS}, which -provides for both a `standard' and a (set of) `local' hierarchies of -directories containing \TeX{}-related files. The -\acro{TDS} reserves the name \texttt{texmf} as the name of the root directory -(folder) of the hierarchies. Files supplied as part of the -distribution are put into the standard hierarchy. The location of the -standard hierarchy is system dependent, but on a Unix system it might -be at -\path{/usr/local/texmf}, or -\path{/usr/local/share/texmf}, or -\path{/opt/texmf}, or -a similar location, but in each case the \TeX{} files will be under the -\path{/texmf} subdirectory. - -There may be more than on `local' hierarchy in which additional files -can be stored. In the extreme an installation can have a local -hierarchy and each user can also have an individual local hierarchy. The -location of any local hierarchy is not only system dependent but also user -dependent. Again, though, all files should be put under a local \path{/texmf} -directory. - -The \acro{TDS} is published as the output of a \acro{TUG} % beware line wrap -\Qref*{Technical Working Group}{Q-TUG*}. -You may browse an \href{http://tug.org/tds/}{on-line version} of the -standard, and copies in several other formats (including source) are -available on \acro{CTAN}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\acro{TDS} specification]\CTANref{tds} -\end{ctanrefs} - -\Question[Q-eps]{What is ``Encapsulated \PS{}'' (``\acro{EPS}'')?} - -\PS{} has been for many years a \emph{lingua franca} of powerful -printers (though modern high-quality printers now tend to require some -constrained form of Adobe Acrobat, instead); since \PS{} is also a -powerful graphical programming language, it is commonly used as an -output medium for drawing (and other) packages. - -However, since \PS{} \emph{is} such a powerful language, some -rules need to be imposed, so that the output drawing may be included -in a document as a figure without ``leaking'' (and thereby destroying -the surrounding document, or failing to draw at all). - -Appendix \acro{H} of the \PS{} Language Reference Manual (second -and subsequent editions), specifies a set of rules for \PS{} to -be used as figures in this way. The important features are: -\begin{itemize} -\item certain ``structured comments'' are required; important ones are - the identification of the file type, and information about the - ``bounding box'' of the figure (i.e., the minimum rectangle - enclosing it); -\item some commands are forbidden~--- for example, a \texttt{showpage} - command will cause the image to disappear, in most \TeX{}-output - environments; and -\item ``preview information'' is permitted, for the benefit of things - such as word processors that don't have the ability to draw - \PS{} in their own right~--- this preview information may be in - any one of a number of system-specific formats, and any viewing - program may choose to ignore it. -\end{itemize} -A \PS{} figure that conforms to these rules is said to be in -``Encapsulated \PS{}'' (\acro{EPS}) format. Most \AllTeX{} packages for -including \PS{} are structured to use Encapsulated \PS{}; -which of course leads to much hilarity as exasperated \AllTeX{} users -struggle to cope with the output of drawing software whose authors -don't know the rules. - -\Question[Q-adobetypen]{Adobe font formats} -\keywords{type1 type3} - -Adobe has specified a number of formats for files to represent fonts -in \PS{} files; this question doesn't attempt to be encyclopaedic, so -we only discuss the two formats most commonly encountered in the -\AllTeX{} context, types~1 and 3. In particular, we don't discuss the -OpenType format, whose has many advantages are somewhat ahead of the -\TeX{} world's mainstream (at time of writing). - -Adobe Type~1 format specifies a means to represent outlines of the glyphs -in a font. The `language' used is closely restricted, to ensure that -the font is rendered as quickly as possible. (Or rather, as quickly -as possible with Adobe's technology at the time the specification was -written: the structure could well be different if it were specified -now.) The format has long been the basis of the digital type-foundry -business, though nowadays most new fonts are released in OpenType format. - -%% Type~1 fonts are directly supported by some operating system software, -%% and at least one \TeX{} system, the commercial % line break! -%% \Qref*{\YandY{} system}{Q-commercial}, bases its entire -%% operation on the use of Type~1 fonts. - -In the \AllTeX{} context, Type~1 fonts are extremely important. Apart -from their simple -availability (there are thousands of commercial Type~1 text fonts around), the -commonest reader for \acro{PDF} files has long (in effect) \emph{insisted} on -their use (see below). - -Type~3 fonts have a more forgiving specification. A wide range of -\PS{} operators is permissible, including bitmap specifiers. Type~3 -is therefore the natural format to be used for programs such as -\ProgName{dvips} when they auto-generate something to represent -\MF{}-generated fonts in a \PS{} file. It's Adobe Acrobat Viewer's -treatment of bitmap Type~3 fonts that has made direct \MF{} output -increasingly unattractive, in recent years. If you have a \acro{PDF} -document in which the text looks fuzzy and uneven in Acrobat Reader, -ask Reader for the \texttt{File}\arrowhyph{}% -\texttt{Document Properties}\arrowhyph{}% -\texttt{Fonts ...}, and it will likely show some font or other as -``Type~3'' (usually with encoding ``Custom''). The problem has -disappeared with version 6 of Acrobat Reader. See % line break -\Qref[question]{\acro{PDF} quality}{Q-dvips-pdf} for a discussion of -the issue, and for ways of addressing it. - -Type~3 fonts should not entirely be dismissed, however. Acrobat -Reader's failure with them is entirely derived from its failure to use -the anti-aliasing techniques common in \TeX{}-ware. Choose a -different set of \PS{} graphical operators, and you can make pleasing -Type~3 fonts that don't ``annoy'' Reader. For example, you may not -change colour within a Type~1 font glyph, but there's no such -restriction on a Type~3 font, which opens opportunities for some -startling effects. - -\Question[Q-resolns]{What are ``resolutions''?} - -``Resolution'' is a word that is used with little concern for its -multiple meanings, in computer equipment marketing. The word suggests -a measure of what an observer (perhaps the human eye) can resolve; yet -we regularly see advertisements for printers whose resolution is -1200dpi~--- far finer than the unaided human eye can distinguish. The -advertisements are talking about the precision with which the printer -can place spots on the printed image, which affects the fineness of -the representation of fonts, and the accuracy of the placement of -glyphs and other marks on the page. - -In fact, there are two sorts of ``resolution'' on the printed page -that we need to consider for \AllTeX{}'s purposes: -\begin{itemize} -\item the positioning accuracy, and -\item the quality of the fonts. -\end{itemize} -In the case where \AllTeX{} output is being sent direct to a printer, -in the printer's ``native'' language, it's plain that the \acro{DVI} -processor must know all such details, and must take detailed account -of both types of resolution. - -In the case where output is being sent to an intermediate distribution -format, that has potential for printing (or displaying) we know not -where, the final translator, that connects to directly to the printer -or display, has the knowledge of the device's properties: the -\acro{DVI} processor need not know, and should not presume to guess. - -Both \PS{} and \acro{PDF} output are in this category. While \PS{} is -used less frequently for document distribution nowadays, it is -regularly used as the source for distillation into \acro{PDF}; and -\acro{PDF} is the workhorse of an enormous explosion of document -distribution. - -Therefore, we need \acro{DVI} processors that will produce -``resolution independent'' \PS{} or \acro{PDF} output; of course, the -independence needs to extend to both forms of independence outlined -above. - -Resolution-independence of fonts was for a long time forced upon the -world by the feebleness of Adobe's \ProgName{Acrobat} -\ProgName{Reader} at dealing with bitmap files: a sequence of answers -starting with one aiming at the % ! line break -\Qref*{quality of \acro{PDF} from \PS{}}{Q-dvips-pdf} addresses -the problems that arise. - -Resolution-independence of positioning is more troublesome: -\ProgName{dvips} is somewhat notorious for insisting on positioning to -the accuracy of the declared resolution of the printer. -One commonly-used approach is to declare a resolution of 8000 (``better -than any device''), and this is reasonably successful though it does -have its \Qref*{problems}{Q-8000}. - -\Question[Q-fontname]{What is the ``Berry naming scheme''?} - -In the olden days, \AllTeX{} distributions were limited by the -feebleness of file systems' ability to represent long names. (The -\MSDOS{} file system was a particular bugbear: fortunately any current -Microsoft system allows rather more freedom to specify file names. -Sadly, the ISO~9660 standard for the structure of \CDROM{}s has a -similar failing, but that too has been modified by various extension -mechanisms.) - -One area in which this was a particular problem was that of file names -for Type~1 fonts. These fonts are distributed by their vendors with -pretty meaningless short names, and there's a natural ambition to -change the name to something that identifies the font somewhat -precisely. Unfortunately, names such as ``BaskervilleMT'' are -already far beyond the abilities of the typical feeble file system, -and add the specifier of a font shape or variant, and the difficulties -spiral out of control. - -Thus arose the Berry naming scheme. - -The basis of the scheme is to encode the meanings of the various parts -of the file's specification in an extremely terse way, so that enough -font names can be expressed even in impoverished file name-spaces. The -encoding allocates one letter to the font ``foundry'', two to the -typeface name, one to the weight, and so on. The whole scheme is -outlined in the \Package{fontname} distribution, which includes -extensive documentation and a set of tables of fonts whose names have -been systematised. -\begin{ctanrefs} -\item[fontname distribution]\CTANref{fontname} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Acquiring the Software} - -\Question[Q-archives]{Repositories of \TeX{} material} - -To aid the archiving and retrieval of of \TeX{}-related files, a -\acro{TUG} working group developed the Comprehensive \TeX{} Archive -Network (\acro{CTAN}). Each \acro{CTAN} site has identical material, -and maintains authoritative versions of its material. These -collections are extensive; in particular, almost everything mentioned -in this \acro{FAQ} -is archived at the \acro{CTAN} sites (see the lists of software at the -end of each answer). - -\begin{narrowversion} % non-hyper - The \acro{CTAN} sites are in Germany, the UK and the USA; the - directory layout is the same on each of the sites, starting from a - tree root of \path{tex-archive/} The sites are - \texttt{dante.ctan.org} (Dante, Germany), \texttt{cam.ctan.org} - (Cambridge, UK) and \texttt{tug.ctan.org} (TUG, USA). -\end{narrowversion} -\begin{wideversion} % hyper - The \acro{CTAN} sites are - \href{ftp://dante.ctan.org/tex-archive}{Dante (Germany)}, - \href{ftp://cam.ctan.org/tex-archive}{Cambridge (UK)} and - \href{ftp://tug.ctan.org/tex-archive}{TUG (USA)}; the links are to - the root of the \acro{CTAN} tree, above which the layout is - identical at each site. -\end{wideversion} - -The \TeX{} files at each \acro{CTAN} node may also be accessed via -the Web at \acro{URL}s \URL{http://www.dante.de/tex-archive}, -\URL{http://www.tex.ac.uk/tex-archive} and -\URL{http://www.ctan.org/tex-archive} respectively, but not all -\acro{CTAN} mirrors are Web-accessible. - -As a matter of course, to reduce network load, -please use the \acro{CTAN} site -or mirror closest to you. A complete and current list of \acro{CTAN} sites -and known mirrors is available as file \CTANref{CTAN-sites} on the -archives themselves. - -Better still, the script behind \URL{http://mirror.ctan.org/} will -cunningly choose a ``nearby'' mirror for you, using information from -the database `behind' \CTANref{CTAN-sites}; at present it uses -\texttt{ftp} protocol for transfers, but the intention is to convert -it to using \texttt{http} (web) protocol in the near future. - -To access a particular thing through the \texttt{mirror.ctan.org} -mechanism, simply place the \acro{CTAN} path after the base -\acro{URL}; so -\URL{http://mirror.ctan.org/macros/latex/contrib/footmisc/} will -connect you to the \Package{footmisc} directory at some \acro{CTAN} -site~--- note that the \File{tex-archive} part of the \acro{CTAN} path -isn't needed. - -For details of how to find files at \acro{CTAN} sites, see -``\Qref*{finding \AllTeX{} files}{Q-findfiles}''. - -The \TeX{} user who has no access to any sort of -network may buy a copy of the archive as part of the -\Qref*{\texlive{} distribution}{Q-CD}. - -\Question[Q-tds-zip]{Ready-built installation files on the archive} - -The \Qref*{\acro{TDS}}{Q-tds} is a simple structure, and almost all -files can be installed simply by putting them in the ``right'' place, -and updating a single index. (Note, this simple idea typically -doesn't work for fonts, unless they're distributed as \MF{} source.) - -The CTAN network is therefore acquiring ``\acro{TDS}-\acro{ZIP}'' files, -which have a built-in directory structure that matches the \acro{TDS}. -These files have to be built, and the \acro{CTAN} team has asked that -package authors supply them (the team will advise, of course, if the -author has trouble). The \acro{CTAN} team hopes that the extra work -involved will contribute to happier lives for package users, which in -turn must surely help keep the TeX community lively and active. - -At the time of writing, there are rather few \extension{tds.zip} -files (by comparison with the huge number of packages that are -available). As packages are updated, the number of files is -steadily increasing, but it will be a long time before the whole set -is covered. - -Use of the files is discussed in % ! line break -``\Qref*{installing using ready-built \acro{ZIP} files}{Q-inst-tds-zip}''. - -\Question[Q-nonfree]{What is the \acro{CTAN} \texttt{nonfree} tree?} - -When \acro{CTAN} was founded, in the 1990s, it was unusual to publish -the terms under which a \TeX{}-related package was distributed (or, at -any rate, to publish those terms formally). - -With the advent of the \TeX{} \emph{distributions}, however, people -started to realise the need for such information, to protect those who -create, distribute or sell the discs that hold the packages, etc. -With the licence information available, the distributors can decide -which packages may be distributed. - -The \acro{CTAN} team decided that it would be useful for users (and -distributors, not to say package authors) to separate packages that -were candidates for distribution, and those that were in some sense -``not free''. Thus was the \texttt{nonfree} tree born. - -From the start, the \texttt{nonfree} tree was controversial: the terms -under which a package would be placed on the tree were hotly -contested, and the \acro{CTAN} team were only able slowly to populate -the tree. It is now obvious to the team that the project would never -have been completed. - -The \acro{CTAN} catalogue now records the nature of the licences of a -good proportion of the packages it describes (though there remain -several for which the licence is unknown, which is as good, for the -distributors, as a licence forbidding distribution). Since the -catalogue's coverage of \acro{CTAN} is good (and slowly improving), -the general rule for distributors has become -\begin{quote} -``if the package is listed in the catalogue, check there to see -whether you should distribute; if the package is not listed in the -catalogue, don't think of distributing it''. -\end{quote} -(The catalogue only has a modest % ! line break -\CTANhref{cat-licences}{list of licences}, but it covers the set used -by packages on \acro{CTAN}, with a wild-card ``\texttt{other-free}'' -which covers packages that the \acro{CTAN} administrators believe to -be free even though the authors haven't used a standard licence.) - -There is a corollary to the `general rule': if you notice something -that ought to be in the distributions, for which there is no catalogue -entry, please let the \acro{CTAN} team (\mailto{ctan@dante.de}) know. -It may well be that the package has simply been missed, but some aren't -catalogued because there's no documentation and the team just doesn't -understand the package. - -In the light of the above, the \texttt{nonfree} tree is being -dismantled, and its contents moved (or moved \emph{back}) to the main -\acro{CTAN} tree. So the answer to the question is, now, ``the -nonfree tree is a part of \acro{CTAN}, and is now being merged with -the main tree''. - -\Question[Q-uploads]{Contributing a file to the archives} - -You have something to submit to the archive~--- great! Before we even -start, here's a check-list of things to sort out: -\begin{enumerate} -\item Licence: in the spirit of \TeX{}, we hope for free software; in - the spirit of today's lawyer-enthralled society, \acro{CTAN} - provides a % ! line break - \href{http://www.tex.ac.uk/tex-archive/help/Catalogue/licenses.html}{list of ``standard'' licence statements}. -\item Documentation: it's good for users to be able to browse - documentation before downloading a package. You need at least a - plain text \File{README} file (exactly that name); in addition a - \acro{PDF} file of the package documentation, prepared for screen - reading, is highly desirable. -\item Name: endless confusion is caused by name clashes. If your - package has the same name as one already on \acro{CTAN}, or if your - package installation generates files of the same name as something - in a ``normal'' distribution, the \acro{CTAN} team will delay - installation while they check that you're doing the right thing: - they may nag you to change the name, or to negotiate a take-over - with the author of the original package. % beware line break - \Qref*{Browse the archive}{Q-findfiles} to ensure uniqueness. - - The name you choose should also (as far as possible) be somewhat - descriptive of what your submission actually \emph{does}; while - ``descriptiveness'' is to some extent in the eye of the beholder, - it's clear that names such as \File{mypackage} or \File{jiffy} - aren't suitable. -\end{enumerate} - -If you are able to use anonymous \ProgName{ftp}, you can upload that -way. The file \File{README.uploads} on \acro{CTAN} tells you -where to upload, what to upload, and how to notify the \acro{CTAN} -management about what you want doing with your upload. - -You may also upload via the Web: each of the principal \acro{CTAN} -sites offers an upload page~--- choose from -\URL{http://www.ctan.org/upload.html}, -\URL{http://www.dante.de/CTAN/upload.html} or -\URL{http://www.tex.ac.uk/upload.html}; the pages lead you through the -process, showing you the information you need to supply. This method -enforces one file per upload: if you had intended to upload lots of -files, you need to bundle them into an `archive' file of some sort; -acceptable formats are \extension{zip} and \extension{tar.gz} (or -\extension{tar.bz2}). - -If you can use neither of these methods, or if you find something -confusing, ask advice of the -\begin{narrowversion} % really non-hyper version - \acro{CTAN} management (\mailto{ctan@dante.de}): -\end{narrowversion} -\begin{wideversion} - \href{mailto:ctan@dante.de}{\acro{CTAN} management}: -\end{wideversion} -if the worst comes to the worst, it may be possible to mail a -contribution. This really is a last-resort route: none of the -\acro{CTAN} sites is anyone's regular workstation, so if you mail to -one of the maintainers, that maintainer then has to upload to -\acro{CTAN}. - -If it's appropriate (if your package is large, or regularly updated), -the \acro{CTAN} management can arrange to \ProgName{mirror} your -contribution direct into the archive. At present this may only be -done if your contribution is available via \ProgName{ftp}, and of -course the directory structure on your repository must `fit'. -\begin{ctanrefs} -\item[README.uploads]\CTANref{CTAN-uploads} -\end{ctanrefs} - -\Question[Q-findfiles]{Finding \AllTeX{} files} - -Modern \TeX{} distributions contain a huge array of support files of -various sorts, but sooner or later most people need to find something -that's not in their present system (if nothing else, because they've -heard that something has been updated). - -But how to find the files? - -Some sources, such as these \acro{FAQ} answers, provide links to -files: so if you've learnt about a package here, you should be able to -retrieve it without too much fuss. - -Otherwise, the \acro{CTAN} sites provide searching facilities, via the web. -The simplest search, locating files by name, is to be found on the -Dante \acro{CTAN} -at \URL{http://www.dante.de/cgi-bin/ctan-index}; the script scans a -list of files (\File{FILES.byname}~--- see below) and returns a list -of matches, arranged very neatly as a series of links to directories -and to individual files. - -The \href{http://www.tex.ac.uk/search}{\acro{UK}} and -\href{http://www.ctan.org/search.html}{\acro{USA}} \acro{CTAN}s offer a -search page that provides -\begin{itemize} -\item a file-name search similar to the Dante machine's (above); -\item a keyword search of the archive catalogue (see below): this is a - pretty powerful tool: the results include links to the catalogue - ``short descriptions'', so you can assure yourself that the package - you've found is the one you want; and -\item a search form that allows you to use \ProgName{Google} to search - \acro{CTAN}. -\end{itemize} - -An alternative way to scan the catalogue is to use the catalogue's -% ! line break -\href{http://www.tex.ac.uk/tex-archive/help/Catalogue/bytopic.html}{``by topic'' index}; -this lists a series of topics, and \AllTeX{} projects that are worth -considering if you're working on matters related to the topic. - -In fact, \ProgName{Google}, and other search engines, can be useful -tools. Enter your search keywords, and you may pick up a package that -the author hasn't bothered to submit to \acro{CTAN}. If you're using -\ProgName{Google}, you can restrict your search to \acro{CTAN} by -entering -\begin{quote} - \texttt{site:ctan.org tex-archive \meta{search term(s)}} -\end{quote} -in \ProgName{Google}'s ``search box''. You can also enforce the -restriction using \ProgName{Google}'s ``advanced search'' mechanism; -other search engines (presumably) have similar facilities. - -Many people avoid the need to go over the network at all, for their -searches, by downloading the file list that the archives' web -file searches use. This file, \File{FILES.byname}, -presents a unified listing of the archive (omitting directory names and -cross-links). Its companion \File{FILES.last07days} is also useful, to -keep an eye on the changes on the archive. Since these files are -updated only once a day, a nightly automatic download (perhaps using -\ProgName{rsync}) makes good sense. -\begin{ctanrefs} -\item[FILES.byname]\CTANref{f-byname} -\item[FILES.last07days]\CTANref{f-last7} -\end{ctanrefs} - -\Question[Q-findfont]{Finding new fonts} - -A comprehensive list of \MF{} fonts used to be posted to -\Newsgroup{comp.fonts} and to \Newsgroup{comp.text.tex}, roughly -every six weeks, by Lee Quin. -Nowadays, authors of new material in \MF{} are few and far between -(and mostly designing highly specialised things with limited appeal to -ordinary users); as a result, no-one has taken over maintenance of the -list of fonts. If you need a font for some esoteric purpose, it may -be worth \Qref*{searching \acro{CTAN}}{Q-findfiles} using your purpose -as a search keyword. - -Most new fonts that appear are prepared in some scalable outline form -or other, and a large proportion is distributed under commercial -terms. However, once you have acquired such a font, converting it to -a form usable by your \AllTeX{} distribution is not (in principle) a -serious problem. - -The answer ``\Qref*{choice of scalable fonts}{Q-psfchoice}'' discusses -fonts that are configured for general (both textual and mathematical) -use with \AllTeX{}. The list of such fonts is sufficiently short that -they \emph{can} all be discussed in one answer here. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\MF{} font list]\CTANref{mf-list} -\end{ctanrefs} - -\Question[Q-CD]{The \TeX{} collection} - -If you don't have access to the Internet, there are obvious -attractions to \TeX{} collections on a disc. Even those with net -access will find large quantities of \TeX{}-related files to hand a -great convenience. - -The \TeX{} collection provides this, together with -ready-to-run \TeX{} systems for various architectures. Contents of -the collection are: -\begin{itemize} -\item The \texlive{} installation disc (a \acro{CD}) provides \TeX{} - systems for use on \acro{GNU}-Linux, MacOS/X and Win-32 - architectures; -\item The \texlive{} `Live' disc (a \acro{DVD}) providing \TeX{} for - a wider range of architectures; -\item Mac\TeX{}: an easy to install \TeX{} system for MacOS/X, based - on \texlive{}, and including the % ! line break - \href{http://www.uoregon.edu/~koch/texshop/}{texshop front-end} - and other tools; -\item Pro\TeX{}t: an easy to install \TeX{} system for Windows, based - on \miktex{}, and including an `active' document to guide - installation; and -\item A snapshot of \acro{CTAN}. -\end{itemize} -A fair number of national \TeX{} User Groups, as well as \acro{TUG}, -distribute copies to their members at no extra charge. Some user -groups are also able to sell additional copies: -contact your local user group or \Qref*{\acro{TUG}}{Q-TUG*}. - -You may also download disc images from \acro{CTAN}; the installation -disc, Pro\TeX{}t and Mac\TeX{} are all separately available. Beware: -they are all pretty large downloads. - -More details of the collection are available from its own -\begin{wideversion} % this really ought to be "hyperversion" or summat - \href{http://www.tug.org/texcollection/}{web page} - on the \acro{TUG} site. -\end{wideversion} -\begin{narrowversion} % and non-hyperversion? - web page on the - \acro{TUG} site \URL{http://www.tug.org/texcollection/} -\end{narrowversion} -\begin{ctanrefs} -\item[Mac\TeX{}]\CTANref{mactex} -\item[Pro\TeX{}t]\CTANref{protext} -\item[\TeX{}live install image]\CTANref{texlive} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{\TeX{} Systems} - -\Question[Q-TeXsystems]{\AllTeX{} for different machines} -\keywords{windows,macintosh,macos,ms-dos,os/2,unix,linux} - -We list here the free or shareware packages; -\htmlignore -see \Qref{}{Q-commercial} for details of commercial packages. -\endhtmlignore -\begin{htmlversion} - another question addresses - \Qref{commercial \TeX{} vendors'}{Q-commercial} products. -\end{htmlversion} -\begin{description} -\item[Unix] The only current distribution of \TeX{} for Unix systems - (including \acro{GNU}/Linux and other free Unix-like systems) is - \texlive{}, which is distributed as part of the % ! line break - \Qref*{\TeX{} collection}{Q-CD}. - - Members of many \TeX{} user groups receive copies of the collection - (on \acro{DVD}), as part of their membership of the groups. - - MacOS/X is also a Unix-based system; however users should refer to - the information below, under item ``Mac''. - - \texlive{} may also be installed ``over the network''; a network - installer is provided, and once you have a system, a manager - (\ProgName{tlmgr}) can both keep your installation up-to-date and - add packages you didn't install at first. - - \begin{ctanrefs} - \item[texlive]Browse \CTANref{texlive} - \item[texlive installer (Unix)]\CTANref{texlive-unix} - \end{ctanrefs} -\item[Linux] GNU/Linux users are supported by \texlive{} (as noted - above). - - A free version of the commercial - \Qref*{V\TeX{} extended \TeX{} system}{Q-commercial} is available - for use under Linux, which among other things specialises in direct - production of \acro{PDF} from \AllTeX{} input. Sadly, it's no - longer supported, and the ready-built images are made for use with a - rather ancient Linux kernel. - - For the future, the \miktex{} developer intends to release a version - of that excellent (Windows) system for use on Linux; a beta version - is available via \href{http://miktex.org/unx/}{the \miktex{} site}. - \begin{ctanrefs} - \item[texlive]Browse \CTANref{texlive} - \item[vtex]\CTANref{vtex-linux} - \item[vtex \nothtml{\rmfamily}required common files]\CTANref{vtex-common} - \end{ctanrefs} -\item[\acro{PC}: Windows] - \miktex{}, by Christian Schenk, is a comprehensive distribution. It has - its own previewer, \acro{YAP}, which is itself capable of printing, - though the distribution also includes a port of \ProgName{dvips}. - The current version is available for file-by-file download (the - \acro{HTML} files in the directory offer hints on what you need to - get going). \miktex{} can automatically install packages that it - ``knows about'', but that aren't in your system (it gets them over - the network). Furthermore, users may keep their installation - up-to-date, over the network: the distribution contains a ``package - manager'', through which the user may select individual packages, or - request that every extant update be retrieved. - - \miktex{} may also be used in a configuration which involves no - installation at all: its ``portable'' distribution may be unpacked - on a memory stick, and used on any windows computer without making - any direct use of the hard drive. This is the first ``official'' - release of such a setup, though a similar object has been available - on the net for some time. - - The \miktex{} developers also provide a ready-to-run copy of the - distribution, on \acro{CD} (for purchase) via the % ! line break - \href{http://www.miktex.org/cd/}{\miktex{} web site}; otherwise the - \File{setup} executable is available on \acro{CTAN}, together with - all the optional packages. - - \href{http://tug.org/protext/}{Pro\TeX{}t}, part of the \TeX{} - collection by Thomas Feuerstack, is - a further option for installing \miktex{}. It bundles a \miktex{} - setup with some further useful utilities, together with a \acro{PDF} - file which contains clickable links for the various installation - steps, along with explanations. - - Windows users are also supported directly by the \texlive{} - distribution; a system is provided on the installation disc of the - \TeX{} collection. The system may also be installed over the - network, using an installer application tailored for use with Windows. - - \href{http://foundry.supelec.fr/projects/xemtex/}{XEm\TeX{}}, by - Fabrice Popineau (he who created the excellent, but now defunct, - fp\TeX{} distribution), is an integrated distribution of \TeX{}, \LaTeX{}, - \CONTeXT{}, \ProgName{XEmacs} and friends for Windows. All programs - have been compiled natively to take the best advantage of the - Windows environment. Configuration is provided so that the - resulting set of programs runs out-of-the-box. - - The (Japanese) \acro{W}32\acro{TEX} distribution was motivated by - the needs of Japanese users (Japanese won't fit in a ``simple'' - character set like \acro{ASCII}, but \TeX{} is based on a version of - \acro{ASCII}). Despite its origins, \acro{W}32\acro{TEX} is said to - be a good bet for Western users, notably those whose disks are short - of space: the minimum documented download is as small as - 95\,MBytes. Investigate the distribution at - \URL{http://www.fsci.fuk.kindai.ac.jp/kakuto/win32-ptex/web2c75-e.html} - - A further (free) option arises from the - \href{http://www.cygwin.com}{CygWin bundle}, which presents a - Unix-like environment over the Win32 interface; an X-windows server - is available. If you run CygWin on your Windows machine, you have - the option of using \texlive{}, too (you will need the X-server, to - run \ProgName{xdvi}). Of course, \texlive{} components will look like - Unix applications (of course, that's presumably what you wanted), - but \TeX{} under CygWin also reputedly somewhat slower than native - Win32 implementations such as \miktex{} or XEm\TeX{}. The (now - obsolete) te\TeX{} distribution is provided as part of the CygWin - distribution, and but you can build your own copy of \texlive{} from - the current sources. - - BaKoMa \TeX{}, by Basil Malyshev, is a comprehensive (shareware) - distribution, which focuses on support of Acrobat. The distribution - comes with a bunch of Type~1 fonts packaged to work with BaKoMa - \TeX{}, which further the focus. - \begin{ctanrefs} - \item[bakoma]\CTANref{bakoma-tex} - \item[miktex]Acquire \CTANref{miktex-setup} (also available from the - \miktex{} web site), and read installation instructions from % - % ! line break - \href{http://www.miktex.org/2.7/setup}{the \miktex{} installation page} - \item[\nothtml{\bgroup\rmfamily}Portable\nothtml{\egroup} miktex]\CTANref{miktex-portable} - \item[protext.exe]\CTANref{protext} - \item[texlive]Browse \CTANref{texlive} - \item[texlive installer (Windows)]\CTANref{texlive-windows} - \end{ctanrefs} -\item[\acro{PC}: \MSDOS{} or \acro{OS/}2] Em\TeX{}, by Eberhard Mattes, - includes \LaTeX{}, \BibTeX{}, previewers, and drivers, and is - available as a series of zip archives. Documentation is - available in both German and English. Appropriate memory managers - for using em\TeX{} with 386 (and better) processors and under - Windows, are included in the distribution. Em\TeX{} will operate - under Windows, but Windows users are better advised to use a - distribution tailored for the Windows environment. - - A version of em\TeX{}, packaged to use a - % beware line break - \Qref*{TDS directory structure}{Q-tds}, is separately available as - an em\TeX{} `contribution'. Note that neither em\TeX{} itself, nor - em\TeX{}\acro{TDS}, is maintained. Most users of Microsoft - operating systems, who want an up-to-date \AllTeX{} system, need to - migrate to Win32-based systems. - \begin{ctanrefs} - \item[emtex]\CTANref{emtex} - \item[emtexTDS]\CTANref{emtextds} - \end{ctanrefs} -\item[\acro{PC}: \MSDOS{}] The most recent \MSDOS{} offering is a - port of the Web2C~7.0 implementation, using the \acro{GNU} - \ProgName{djgpp} compiler. While this package is more recent than - em\TeX{}, it still implements a rather old instance of \AllTeX{}. - \begin{ctanrefs} - \item[djgpp]\CTANref{djgpp} - \end{ctanrefs} -\item[\acro{PC}: \acro{OS/}2] Em\TeX{}, by Eberhard Mattes (see - above), was actually developed under \acro{OS/}2, and lives happily - in that environment. - - \acro{OS/}2 users may also use a free version of the - commercial \Qref*{V\TeX{}}{Q-commercial}, which specialises - in direct production of \acro{PDF} from \AllTeX{} input. (This - version is, like the Linux version, unfortunately no longer supported.) - \begin{ctanrefs} - \item[emtex]\CTANref{emtex} - \item[emtexTDS]\CTANref{emtextds} - \item[vtex]\CTANref{vtex-os2} - \item[vtex \nothtml{\rmfamily}required common files]\CTANref{vtex-common} - \end{ctanrefs} -%% \item[Windows \acro{NT}, other platforms] Ports of \miktex{} for -%% \acro{NT} on Power \acro{PC} and \acro{AXP} are available. Neither -%% version has been updated for version~1.2 (or later) of -%% \miktex{}~--- they may not be satisfactory. -%% \begin{ctanrefs} -%% \item[miktex for AXP]\CTANref{miktex-AXP} -%% \item[miktex for Power PC]\CTANref{miktexppc} -%% \end{ctanrefs} -\item[Mac] \href{http://www.trevorrow.com/oztex/}{Oz\TeX{}}, by Andrew - Trevorrow, is a shareware version of - \TeX{} for the Macintosh. A \acro{DVI} previewer and \PS{} - driver are also included. (Members of \acro{UK}~\acro{TUG} may - acquire the software without further payment, as part of a - membership deal.) Oz\TeX{} does not run, natively, under MacOS/X, - but will run with a sufficiently recent CarbonLib (see - \URL{http://www.trevorrow.com/oztex/ozosx.html}). - Other questions about Oz\TeX{} itself may be directed to - \mailto{oztex@midway.uchicago.edu} - - Another partly shareware program is - \href{http://www.kiffe.com/cmactex.html}{CMac\TeX{}} , put together - by Tom Kiffe. CMac\TeX{} is much closer than Oz\TeX{} to the Unix - \TeX{} model of things (it uses \ProgName{dvips}, for instance). - CMac\TeX{} runs natively under includes a port of a version of - \Qref*{Omega}{Q-omegaleph}. - - Both Oz\TeX{} and \acro{CM}ac\TeX{} run on either MacOS/X or on a - sufficiently recent MacOS with CarbonLib - (v1.3~for Oz\TeX{}, v1.4~for CMac\TeX{}). - % beware line wrap - - From its 2005 release, the \Qref*{\texlive{} disc set}{Q-CD} - includes Mac\TeX{}. Details (and a downloadable distribution set) - may be found on the % ! line break - \href{http://tug.org/mactex}{\acro{TUG} web site}; the distribution - is also on \acro{CTAN}. - -\begin{narrowversion} % really, non-hyper version - A useful resource for Mac users is to be found at - \URL{http://www.esm.psu.edu/mac-tex/}; it has a news and `help' - section, as well as details of systems and tools. -\end{narrowversion} -\begin{wideversion} - A useful - \href{http://www.esm.psu.edu/mac-tex/}{resource for Mac users} - has a news and `help' section, as well as details of systems and - tools. -\end{wideversion} - The Mac\TeX{}-on-OSX mailing list is a useful resource for users; - mail \mailto{MacOSX-TeX-on@email.esm.psu.edu} to subscribe. -\begin{ctanrefs} - \item[cmactex]\CTANref{cmactex} - \item[mactex]\CTANref{mactex} - \item[oztex]\CTANref{oztex} -\end{ctanrefs} -\item[Open\acro{VMS}] \TeX{} for Open\acro{VMS} is available, though - it seems unlikely that the version on \acro{CTAN} is the latest - available. - \begin{ctanrefs} - \item[OpenVMS]\CTANref{OpenVMSTeX} - \end{ctanrefs} -\item[Atari] \TeX{} for the Atari \acro{ST} is available from \acro{CTAN}. - \begin{ctanrefs} - \item[Atari TeX]\CTANref{atari} - \end{ctanrefs} -\item[Amiga] Full implementations of \TeX{} 3.1 (Pas\TeX{}) and \MF{} - 2.7 are available. - \begin{ctanrefs} - \item[PasTeX]\CTANref{amiga} - \end{ctanrefs} -\item[\acro{TOPS}-20] \TeX{} was originally written on a \acro{DEC}-10 - under \acro{WAITS}, - and so was easily ported to \acro{TOPS}-20. A distribution that runs on - \acro{TOPS}-20 is available via anonymous \texttt{ftp} from - \FTP{ftp.math.utah.edu} in \path{pub/tex/pub/web} - \checked{RF}{2001/03/01} -\end{description} - -\Question[Q-editors]{\TeX{}-friendly editors and shells} - -There are good \TeX{}-writing environments and editors for most -operating systems; some are described below, but this is only a -personal selection: -\begin{description} -\item[Unix] The commonest choices are \ProgName{[X]Emacs} or - \ProgName{vim}, though several others are available. - - \href{http://www.gnu.org/software/emacs/emacs.html}{\acro{GNU}\nobreakspace\ProgName{emacs}} - and \href{http://www.xemacs.org/}{\ProgName{XEmacs}} are supported - by the \acro{AUC}-\TeX{} - bundle (available from \acro{CTAN}). \acro{AUC}-\TeX{} provides menu - items and control sequences for common constructs, checks syntax, - lays out markup nicely, lets you call \TeX{} and drivers from - within the editor, and everything else like this that you can think - of. Complex, but very powerful. - - \href{http://vim.sourceforge.net}{\ProgName{Vim}} is also highly - configurable (also available for Windows and Macintosh systems). - Many plugins are available to support the needs of the \AllTeX{} user, - including syntax highlighting, calling \TeX{} programs, - auto-insertion and -completion of common \AllTeX{} structures, and - browsing \LaTeX{} help. The scripts \File{auctex.vim} and - \File{bibtex.vim} seem to be the most common recommendations. - - The editor \href{http://nedit.org/}{\ProgName{NEdit}} is also free - and programmable, and is available for Unix systems. An - \acro{AUC}-\TeX{}-alike set of extensions for \ProgName{NEdit} is available - from \acro{CTAN}. - - \ProgName{LaTeX4Jed} provides much enhanced \LaTeX{} support for the - \href{http://www.jedsoft.org/jed/}{\ProgName{jed}} editor. - \ProgName{LaTeX4Jed} is similar to \acro{AUC}-\TeX{}: menus, - shortcuts, templates, syntax highlighting, document outline, - integrated debugging, symbol completion, full integration with - external programs, and more. It was designed with both the beginner - and the advanced LaTeX user in mind. - - The \ProgName{Kile} editor that is provided with the \acro{KDE} - window manager provides \acro{GUI} ``shell-like'' facilities, in a - similar way to the widely-praised \ProgName{Winedt} (see below); - details (and downloads) are available from the project's - \href{http://kile.sourceforge.net/}{home on SourceForge}. A newer - system (by \ProgName{Kile}'s original author), - \href{http://www.xm1math.net/texmaker/}{\ProgName{texmaker}} doesn't - rely on \acro{KDE}'s facilities, and so may be more easily portable. -\item[\MSDOS{}] \TeX{}shell is a simple, - easily-customisable environment, which can be used with the editor - of your choice. - - You can also use \acro{GNU}~\ProgName{emacs} and \acro{AUC}-\TeX{} - under \MSDOS{}. -\item[Windows '9x, NT, etc.]\ProgName{TeXnicCenter} is a (free) - \TeX{}-oriented development system, uniting a powerful platform for - executing \AllTeX{} and friends with a configurable editor. - - \ProgName{Winedt}, a shareware package, is also highly spoken of. - It too provides a shell for the use of \TeX{} and related programs, - as well as a powerful and well-configured editor. The editor can - generate its output in \acro{UTF}-8 (to some extent), which is - useful when working with \Qref*{\xetex{}}{Q-xetex} (and other - ``next-generation'' \AllTeX{} applications). - - Both \ProgName{emacs} and \ProgName{vim} are available in versions - for Windows systems. -\item[\acro{OS/}2] \ProgName{epmtex} offers an \acro{OS/}2-specific shell. -\item[Macintosh] The commercial Textures provides an excellent integrated - Macintosh environment with its own editor. More powerful still (as an - editor) is the shareware \ProgName{Alpha} which is - extensible enough to let you perform almost any \TeX{}-related job. It - works well with Oz\TeX{}. From release 2.2.0 (at least), Textures - works with MacOS~X. - - For MacOS~X users, the free tool of choice appears to be - \href{http://www.uoregon.edu/~koch/texshop/texshop.html}{\texshop{}}, which - combines an editor and a shell with a coherent philosophy of dealing - with \AllTeX{} in the OS~X environment. TeXShop is distributed as - part of the MacTeX system, and will therefore be available out of - the box on machines on which MacTeX has been installed. - - \ProgName{Vim} is also available for use on Macintosh systems. -\item[Wildcard] \acro{TUG} is sponsoring the development of a - cross-platform editor and shell, modelled on the excellent - \texshop{} for the Macintosh. While this program, - \href{http://www.tug.org/texworks/}{\texworks{}}, is still under - development, it is already quite usable: if you're looking for a - \AllTeX{} development environment, and are willing to step beyond - the boundaries, it may be for you. -\end{description} -Atari, Amiga and \acro{N}e\acro{XT} users also have nice -environments. \LaTeX{} users looking for \ProgName{make}-like -facilities should review the answer on -\Qref*{Makefiles for \LaTeX{} documents}{Q-make}. - -While many \AllTeX{}-oriented editors can support work on \BibTeX{} -files, there are many systems that provide specific ``database-like'' -access to your \BibTeX{} files~--- -\begin{wideversion} - see ``\Qref{creating a bibliography file}{Q-buildbib}''. -\end{wideversion} -\begin{narrowversion} - these are discussed in % ! line break - ``\Qref*{creating a bibliography file}{Q-buildbib}''. -\end{narrowversion} -\begin{ctanrefs} -\item[alpha]\CTANref{alpha} -\item[auctex]\CTANref{auctex} -\item[epmtex]\CTANref{epmtex} -\item[LaTeX4Jed]\CTANref{latex4jed} -\item[Nedit LaTeX support]\CTANref{nedit-latex} -\item[TeXnicCenter]\CTANref{texniccenter} -\item[TeXshell]\CTANref{texshell} -\item[TeXtelmExtel]\CTANref{TeXtelmExtel} -\item[winedt]\CTANref{winedt} -\end{ctanrefs} - -\Question[Q-commercial]{Commercial \TeX{} implementations} -\keywords{windows,macintosh,commercial} - -There are many commercial implementations of \TeX{}. The first -appeared not long after \TeX{} itself appeared. - -What follows is probably an incomplete list. Naturally, no warranty or -fitness for purpose is implied by the inclusion of any vendor in this -list. The source of the information is given to provide some clues to -its currency. - -In general, a commercial implementation will come `complete', that is, -with suitable previewers and printer drivers. They normally also have -extensive documentation (\emph{i.e}., not just the \TeX{}book!) and some -sort of support service. In some cases this is a toll free number -(probably applicable only within the \acro{USA} and or Canada), but others -also have email, and normal telephone and fax support. -\begin{description} -\item[\acro{PC}; True\TeX{}] Runs on all versions of Windows. - \begin{quote} - Richard J. Kinch\\ - TrueTeX Software\\ - 7890 Pebble Beach Court\\ - Lake Worth \acro{FL} 33467\\ - \acro{USA}\\[.25\baselineskip] - Tel: +1 561-966-8400\\ - Email: \mailto{kinch@truetex.com}\\ - Web: \URL{http://www.truetex.com/} - \end{quote} - Source: Mail from Richard Kinch, August 2004. -%% \item[\acro{PC}; \YandY{} \TeX{}] ``Bitmap free \TeX{} for Windows.'' -%% \begin{quote} -%% \YandY{}, Inc.\\ -%% 106 Indian Hill, \acro{MA} 01741-1747\\ -%% \acro{USA}\\[.25\baselineskip] -%% Tel: 800-742-4059 (within North America)\\ -%% Tel: +1 978-371-3286\\ -%% Fax: +1 978-371-2004\\ -%% Email: \mailto{sales-help@YandY.com} and -%% \nothtml{\\ \hphantom{Email: }}% -%% \mailto{tech-help@YandY.com}\\ -%% Web: \URL{http://www.YandY.com/} -%% \end{quote} -%% Source: Confirmed with \YandY{}, February 2003 -\item[pc\TeX{}] Long-established: pc\TeX{}32 is a Windows implementation. - \begin{quote} - Personal \TeX{} Inc\\ - 725 Greenwich Street, Suite 210 \\ - San Francisco, \acro{CA} 94133\\ - \acro{USA}\\[.25\baselineskip] - Tel: 800-808-7906 (within the \acro{USA})\\ - Tel: +1 415-296-7550\\ - Fax: +1 415-296-7501\\ - Email: \mailto{sales@pctex.com}\\ - Web: \URL{http://www.pctex.com/} - \end{quote} - Source: Personal \TeX{} Inc web site, December 2004 -\item[\acro{PC}; V\TeX{}] \acro{DVI}, \acro{PDF} and \acro{HTML} - backends, Visual Tools and Type 1 fonts - \begin{quote} - MicroPress Inc\\ - 68-30 Harrow Street\\ - Forest Hills, \acro{NY} 11375\\ - \acro{USA}\\[.25\baselineskip] - Tel: +1 718-575-1816\\ - Fax: +1 718-575-8038\\ - Email: \mailto{support@micropress-inc.com}\\ - Web: \URL{http://www.micropress-inc.com/} - \end{quote} - Source: Mail from MicroPress, Inc., July 1999 -\item[\acro{PC}; Scientific Word] Scientific Word and Scientific Workplace - offer a mechanism for near-\WYSIWYG{} input of \LaTeX{} documents; they - ship with True\TeX{} from Kinch (see above). Queries within the \acro{UK} - and Ireland should be addressed to Scientific Word Ltd., others should be - addressed directly to the publisher, MacKichan Software Inc. - \begin{quote} - Dr Christopher Mabb\\ - Scientific Word Ltd.\\ - 990 Anlaby Road,\\ - Hull,\\ - East Yorkshire,\\ - \acro{HU}4 6\acro{AT}\\ - \acro{UK}\\[0.25\baselineskip] - Tel: 0845 766\,0340 (within the \acro{UK}) \\ - Fax: 0845 603\,9443 (within the \acro{UK}) \\ - Email: \mailto{christopher@sciword.demon.co.uk} \\ - Web: \URL{http://www.sciword.demon.co.uk} - \end{quote} - \begin{quote} - MacKichan Software Inc.\\ - 19307 8th Avenue, Suite C\\ - Poulsbo \acro{WA} 98370-7370\\ - \acro{USA}\\[0.25\baselineskip] - Tel: +1 360 394\,6033\\ - Tel: 877 724\,9673 (within the \acro{USA}) - Fax: +1 360 394\,6039\\ - Email: \mailto{info@mackichan.com}\\ - Web: \URL{http://www.mackichan.com} - \end{quote} - Source: Mail from Christopher Mabb, August 2007 -\item[Macintosh; Textures] ``A \TeX{} system `for the rest of - us'\,''. A beta release of Textures for MacOS/X is - available~--- see \URL{http://www.bluesky.com/news/news_frames.html} - - (Blue Sky also gives away a \MF{} implementation and some - font manipulation tools for Macs.) - \begin{quote} - Blue Sky Research\\ - PO Box 80424\\ - Portland, \acro{OR} 97280\\ - \acro{USA}\\[.25\baselineskip] - Tel: 800-622-8398 (within the \acro{USA})\\ - Tel/Fax: +1 503-222-9571\\ - Fax: +1 503-246-4574\\ - Email: \mailto{sales@bluesky.com}\\ - Web: \URL{http://www.bluesky.com/} - \end{quote} - Source: Mail from Gordon Lee, April 2007 -\item[Amiga\TeX{}] A full implementation for the Commodore Amiga, - including full, on-screen and printing support for all \PS{} - graphics and fonts, IFF raster graphics, automatic font generation, - and all of the standard macros and utilities. - \begin{quote} - Radical Eye Software\\ - \acro{PO} Box 2081\\ - Stanford, \acro{CA} 94309\\ - \acro{USA} - \end{quote} - Source: Mail from Tom Rokicki, November 1994 -\end{description} -\checked{mc}{1994/11/09}% -\checked{RF}{1994/11/24}% - -Note that the company \YandY{} has gone out of business, and \YandY{} -\TeX{} (and support for it) is therefore no longer available. Users -of \YandY{} systems may care to use the self-help -\href*{http://tug.org/pipermail/yandytex/}{mailing list} -that was established in 2003; the remaining usable content of -\YandY{}'s web site is available at \URL{http://www.tug.org/yandy/} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{\acro{DVI} Drivers and Previewers} - -\Question[Q-dvips]{\acro{DVI} to \PS{} conversion programs} - -The best public domain \acro{DVI} to \PS{} conversion program, which -runs under many operating systems, is Tom Rokicki's \ProgName{dvips}. -\ProgName{dvips} is written in \acro{C} and ports easily. All current -development is in the context of Karl Berry's \ProgName{kpathsea} -library, and sources are available from the \texlive{} repository, -and versions are available in all \TeX{} distributions that recognise -the use of \PS{}. - -An \acro{VMS} versions is available as part of the \acro{CTAN} -distribution of \TeX{} for \acro{VMS}. - -A precompiled version to work with em\TeX{} is available on \acro{CTAN}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\MSDOS{} and \latexhtml{\acro{OS/}}{OS/}2]% - \CTANref{dvips-pc} -\item[\nothtml{\rmfamily}VMS distribution]\CTANref{OpenVMSTeX} -\end{ctanrefs} - -\Question[Q-HPdrivers]{\acro{DVI} drivers for \acro{HP} LaserJet} - -The em\TeX{} distribution (see \Qref[question]{\TeX{} systems}{Q-TeXsystems}) -contains a driver for the LaserJet, \ProgName{dvihplj}. - -Version 2.10 of the Beebe drivers supports the LaserJet. These drivers -will compile under Unix, \acro{VMS}, and on the Atari ST and -\acro{DEC}-20s. - -For Unix systems, Karl Berry's \ProgName{dviljk} uses the same -path-searching library as \ProgName{web2c}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Beebe drivers]\CTANref{beebe} -\item[dviljk]\CTANref{dviljk} -\end{ctanrefs} - -\Question[Q-otherprinters]{Output to ``other'' printers} - -In the early years of \TeX{}, there were masses of \acro{DVI} drivers -for any (then) imaginable kind of printer, but the steam seems rather -to have gone out of the market for production of drivers for -printer-specific formats. There are several reasons for this, but the -primary one is that few formats offer the flexibility available -through \PS{}, and \ProgName{ghostscript} is \emph{so} good, and -has \emph{such} a wide range of printer drivers (perhaps this is where -the \acro{DVI} output driver writers have all gone?). - -The general advice, then, is to \Qref*{generate \PS{}}{Q-dvips}, and -to process that with \ProgName{ghostscript} set to generate the format -for the printer you actually have. If you are using a Unix system of -some sort, it's generally quite easy to insert \ProgName{ghostscript} -into the print spooling process. -\begin{ctanrefs} -\item[ghostscript]Browse \CTANref{ghostscript} -\end{ctanrefs} - -\Question[Q-previewers]{\acro{DVI} previewers} - -Em\TeX{} for \acro{PC}s running \MSDOS{} or \acro{OS/}2, \miktex{} and -XEm\TeX{} for \acro{PC}s running Windows and Oz\TeX{} for the Macintosh, all -come with previewers that can be used on those platforms. Em\TeX{}'s -previewer can also be run under Windows~3.1. - -Commercial \acro{PC} \TeX{} packages (see % ! line break -\Qref[question]{commercial vendors}{Q-commercial}) -have good previewers for \acro{PC}s running Windows, or for Macintoshes. - -For Unix systems, there is one `canonical' viewer, \ProgName{xdvi}. -\ProgName{Xdvik} is a version of \ProgName{xdvi} using the -\ProgName{web2c} libraries; it is now built from the same distribution -as \ProgName{xdvi}. The \texlive{} distributions for Unix systems -include a version of \ProgName{xdvik}. - -Alternatives to previewing include -\begin{itemize} -\item conversion to `similar' \acro{ASCII} text (see - \Qref[question]{converting to \acro{ASCII}}{Q-toascii}) and using a - conventional text viewer to look at that, -\item generating a \PS{} version of your document and viewing it - with a \ProgName{Ghostscript}-based previewer (see - \Qref[question]{previewing \PS{} files}{Q-PSpreview}), and -\item generating \acro{PDF} output, and viewing that with - \ProgName{Acrobat} \ProgName{Reader} or one of the substitutes for that. -\end{itemize} -\begin{ctanrefs} -\item[xdvi]\CTANref{xdvi} -\end{ctanrefs} - -\Question[Q-dvi-bmp]{Generating bitmaps from \acro{DVI}} - -In the last analysis, any \acro{DVI} driver or previewer is generating -bitmaps: bitmaps for placing tiny dots on paper via a laser- or -inkjet-printer, or bitmaps for filling some portion of your screen. -However, it's usually difficult to extract any of those bitmaps any -way other than by screen capture, and the resolution of \emph{that} is -commonly lamentable. - -Why would one want separate bitmaps? Most often, the requirement is for -something that can be included in \acro{HTML} generated from \AllTeX{} -source~--- not everything that you can write in \AllTeX{} can be -translated to \acro{HTML} (at least, portable \acro{HTML} that may be -viewed in `most' browsers), so the commonest avoiding action is to -generate a bitmap of the missing bit. Examples are maths (a maths -extension to the `|*|\acro{ML}' family is available but not -universally supported by browsers), and `exotic' typescripts (ones -that you cannot guarantee your readers will have available). Other -common examples are generation of -sample bitmaps, and generation for insertion into some other -application's display~--- to insert equations into Microsoft -PowerPoint, or to support the enhanced-\ProgName{emacs} setup called -\Qref*{\ProgName{preview}-\ProgName{latex}}{Q-WYGexpts}. - -In the past, the commonest way of generating bitmaps was to generate a -\PS{} file of the \acro{DVI} and then use \ProgName{ghostscript} to -produce the required bitmap format (possibly by way of \acro{PNM} -format or something similar). This is an undesirable procedure (it is -very slow, and requires two or three steps) but it has served for a -long time. - -\AllTeX{} users may now take advantage of two bitmap `drivers'. The -longer-established, \ProgName{dvi2bitmap}, will generate \acro{XBM} and -\acro{XPM} formats, the long-deprecated \acro{GIF} format (which is -now obsolescent, but has finally been relieved of the patent -protection of the \acro{LZW} compression it uses), and also -the modern (\acro{ISO}-standardised) \acro{PNG} format. - -Dvipng started out as a PNG renderer; from version 1.2 it can also -render to the GIF format. It is designed for speed, in environments that -generate large numbers of \acro{PNG} files: the \File{README} mentions -\ProgName{preview}-\ProgName{latex}, \ProgName{LyX}, and a few -web-oriented environments. Note that \ProgName{dvipng} gives -high-quality output even though its internal operations are optimised -for speed. -\begin{ctanrefs} -\item[dvi2bitmap]\CTANref{dvi2bitmap} -\item[dvipng]\CTANref{dvipng} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Support Packages for \TeX{}} - -\Question[Q-figetc]{\AllTeX{}-friendly drawing packages} -\AliasQuestion{Q-xfig} - -\ProgName{(X)Fig} is a menu driven tool that allows you to -draw objects on the screen of an \acro{X} workstation; \ProgName{transfig} -is a set of tools which translate the code \ProgName{fig}. The list -of export formats is very long, and includes \MF{} and \MP{}, -Encapsulated \PS{} and \acro{PDF}, as well as combinations that wrap -a graphics format in a \LaTeX{} import file, which may include -\LaTeX{} commands to place text (compiled by \LaTeX{} itself) as -labels, etc., in the figures. - -There's no explicit port of \ProgName{xfig} to windows (although it is -believed to work under \ProgName{cygwin} with their X-windows system). -However, the program % ! line break -\href{http://tech-www.informatik.uni-hamburg.de/applets/javafig/}{\ProgName{jfig}} -is thought by many to be an acceptable substitute, written in Java. - -\ProgName{Asymptote} is a widely-praised development of the \MP{} -language, which can draw 2D or 3D diagrams, and can also label -diagrams with \LaTeX{} text; copious documentation is available via -\href{http://asymptote.sourceforge.net}{\ProgName{asymptote}'s web site}. -\begin{ctanrefs} -\item[asymptote]\CTANref{asymptote} -\item[xfig]\CTANref{xfig} -\item[transfig]\CTANref{transfig} -\end{ctanrefs} - -\Question[Q-texcad]{\TeX{}\acro{CAD}, a drawing package for \LaTeX{}} - -\TeX{}\acro{CAD} is a program for the \acro{PC} which enables the user to draw diagrams -on screen using a mouse or arrow keys, with an on-screen menu of available -picture-elements. Its output is code for the \LaTeX{} -\environment{picture} environment. -Optionally, it can be set to include lines at all angles using -the em\TeX{} driver-family -\htmlignore -\csx{special}s (\Qref{}{Q-specials}). -\endhtmlignore -\begin{htmlversion} -\Qref{\csx{special}s}{Q-specials}. -\end{htmlversion} -\TeX{}\acro{CAD} is part of the em\TeX{} distribution. - -A Unix port of the program (\ProgName{xtexcad}) has been made. -\begin{ctanrefs} -\item[emtex]\CTANref{emtex} -\item[xtexcad]\CTANref{xtexcad} -\end{ctanrefs} - -\Question[Q-spell]{Spelling checkers for work with \TeX{}} - -For Unix, \ProgName{ispell} was long the program of choice; it is well -integrated with \ProgName{emacs}, and deals with some \TeX{} syntax. -However, it has more-or-less been replaced everywhere, by -\ProgName{aspell}, which was designed as a successor, and certainly -performs better on most metrics; there remains some question as to its -performance with \AllTeX{} sources. - -For Windows, there is a good spell checker incorporated into many of -the \Qref*{shell/editor}{Q-editors} combinations that are available. -The spell checker from the (now defunct) 4All\TeX{} shell remains -available as a separate package, \ProgName{4spell}. - -For the Macintosh, \ProgName{Excalibur} is the program of choice. It -will run in native mode on both sorts of Macintosh. The distribution -comes with dictionaries for several languages. - -The \acro{VMS} Pascal program \ProgName{spell} makes special cases of -some important features of \LaTeX{} syntax. - -For \MSDOS{}, there are several programs. \ProgName{Amspell} can be -called from within an editor, and \ProgName{jspell} is an extended -version of \ProgName{ispell}. -\begin{ctanrefs} -\item[4spell]\CTANref{4spell} -\item[amspell]\CTANref{amspell} -\item[aspell]Browse \CTANref{aspell}~--- choose just those language - dictionaries (under subdirectory \File{dict/}) that you need. -\item[excalibur]\CTANref{Excalibur} -\item[ispell]\CTANref{ispell} -\item[jspell]\CTANref{jspell} -\item[\nothtml{\bgroup\rmfamily}\acro{VMS}\nothtml{\egroup} spell]% - \CTANref{vmspell} -\item[winedt]\CTANref{winedt} -\end{ctanrefs} - -\Question[Q-wordcount]{How many words have you written?} - -One often has to submit a document (e.g., a paper or a dissertation) -under some sort of constraint about its size. Sensible people set a -constraint in terms of numbers of pages, but there are some that -persist in limiting the numbers of words you type. - -A simple solution to the requirement can be achieved following a -simple observation: the powers that be are unlikely to count all the -words of a document submitted to them. Therefore, a statistical -method can be employed: find how many words there are on a full page; -find how many full pages there are in the document (allowing for -displays of various sorts, this number will probably not be an -integer); multiply the two. However, if the document to be submitted -is to determine the success of the rest of one's life, it takes a -brave person to thumb their nose at authority quite so -comprehensively\dots{} - -The simplest method is to strip out the \AllTeX{} markup, and to count -what's left. On a Unix-like system, this may be done using -\ProgName{detex} and the built-in \ProgName{wc}: -\begin{verbatim} - detex <filename> | wc -w -\end{verbatim} -The \ProgName{latexcount} script does the same sort of job, in one -``step''; being a \ProgName{perl} script, it is in principle rather -easily configured (see documentation inside the script). -\ProgName{Winedt} (see \Qref[question]{editors and shells}{Q-editors}) -provides this functionality direct in the Windows environment. - -\ProgName{TeXcount} also goes a long way with heuristics for counting, -starting from a \LaTeX{} file; the documentation is comprehensive, and -you may try the script on-line via the % ! line break -\begin{wideversion} - \href{http://folk.uio.no/einarro/Comp/texwordcount.html}{package home page}. -\end{wideversion} -\begin{narrowversion} - package home page~(see - \URL{http://folk.uio.no/einarro/Comp/texwordcount.html}). -\end{narrowversion} -Even quite sophisticated stripping of \AllTeX{} markup can never be -entirely reliable, however: that markup itself may contribute typeset -words, and this could be a problem. The \Package{wordcount} package -contains a Bourne shell (i.e., typically Unix) script for running a -\LaTeX{} file with a special piece of supporting \TeX{} code, and then -counting word indications in the log file. This is probably as -accurate automatic counting as you can get, if it works for you. -\begin{ctanrefs} -\item[detex]\CTANref{detex} -\item[latexcount.pl]\CTANref{latexcount} -\item[TeXcount]\CTANref{texcount} -\item[wordcount]\CTANref{wordcount} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Literate programming} - -\Question[Q-lit]{What is Literate Programming?} - -Literate programming is the combination of documentation and source -together in a fashion suited for reading by human beings. -In general, literate programs combine source -and documentation in a single file. Literate programming tools then -parse the file to produce either readable documentation or compilable -source. The \acro{WEB} style of literate programming was created by -D.~E.~Knuth during the development of \TeX{}. - -\htmlignore -The ``documented \LaTeX{}'' style of programming (\Qref{}{Q-dtx}) -\endhtmlignore -\begin{htmlversion} - The ``\Qref{documented \LaTeX{}}{Q-dtx}'' style of programming -\end{htmlversion} -is regarded by some as a form of literate programming, though it only -contains a subset of the constructs Knuth used. - -Discussion of literate programming is conducted in the newsgroup -\Newsgroup{comp.programming.literate}, whose \acro{FAQ} is stored on -\acro{CTAN}. Another good source of information is -\URL{http://www.literateprogramming.com/} -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Literate Programming \acro{FAQ}]% - \CTANref{LitProg-FAQ} -\end{ctanrefs} - -\Question[Q-webpkgs]{\acro{WEB} systems for various languages} - -\TeX{} is written in the programming language \acro{WEB}; \acro{WEB} -is a tool to implement the concept of ``literate programming''. -Knuth's original implementation will be in any respectable -distribution of \TeX{}, but the sources of the two tools -(\ProgName{tangle} and \ProgName{weave}), together with a manual -outlining the programming techniques, may be had from \acro{CTAN}. - -\acro{\ProgName{CWEB}}, by Silvio Levy, is a \acro{WEB} for \acro{C} programs. - -Spidery \acro{WEB}, by Norman Ramsey, supports many -languages including Ada, \texttt{awk}, and \acro{C} -and, while not in the public domain, is usable without charge. It is -now superseded by \ProgName{noweb} (also by Norman Ramsay) which -incorporates the lessons learned in implementing spidery \acro{WEB}, -and which is a simpler, equally powerful, tool. - -\acro{\ProgName{FWEB}}, by John Krommes, is a version for Fortran, -Ratfor, and \acro{C}. - -\ProgName{Scheme}\acro{\ProgName{WEB}}, by John Ramsdell, is a Unix filter that -translates Scheme\acro{WEB} into \LaTeX{} source or Scheme source. - -\acro{\ProgName{APLWEB}} is a version of \acro{WEB} for \acro{APL}. - -\ProgName{FunnelWeb} is a version of \acro{WEB} that is language independent. - -Other language independent versions of \acro{WEB} are \ProgName{nuweb} (which -is written in \acro{ANSI} \acro{C}). - -\ProgName{Tweb} is a \acro{WEB} for \plaintex{} macro files, using -\ProgName{noweb}. -\begin{ctanrefs} -\item[aplweb]\CTANref{aplweb} -\item[cweb]\CTANref{cweb} -\item[funnelweb]\CTANref{funnelweb} -\item[fweb]\CTANref{fweb} -\item[noweb]\CTANref{noweb} -\item[nuweb]\CTANref{nuweb} -\item[schemeweb]\CTANref{schemeweb} -\item[spiderweb]\CTANref{spiderweb} -\item[tangle]\CTANref{web} -\item[tweb]\CTANref{tweb} -\item[weave]\CTANref{web} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Format conversions} - -\Question[Q-toascii]{Conversion from \AllTeX{} to plain text} - -The aim here is to emulate the Unix \ProgName{nroff}, which formats -text as best it can for the screen, from the same -input as the Unix typesetting program \ProgName{troff}. - -Converting \acro{DVI} to plain text is the basis of many of these -techniques; sometimes the simple conversion provides a good enough -response. Options are: -\begin{itemize} -\item \ProgName{dvi2tty} (one of the earliest), -\item \ProgName{crudetype} and -\item \ProgName{catdvi}, which is capable of generating Latin-1 - (ISO~8859-1) or \acro{UTF}-8 encoded output. \ProgName{Catdvi} was - conceived as a replacement for \ProgName{dvi2tty}, but can't (quite) - be recommended as a complete replacement yet. -\end{itemize} -A common problem is the hyphenation that \TeX{} inserts when -typesetting something: since the output is inevitably viewed using -fonts that don't match the original, the hyphenation usually looks -silly. - -Ralph Droms provides a \Package{txt} bundle of things in support of -\acro{ASCII} generation, -but it doesn't do a good job with tables and mathematics. An -alternative is the \Package{screen} package. - -Another possibility is to -use the \LaTeX{}-to-\acro{ASCII} conversion program, \ProgName{l2a}, -although this is really more of a de-\TeX{}ing program. - -The canonical de-\TeX{}ing program is \ProgName{detex}, which removes -all comments and control sequences -from its input before writing it to its output. Its original purpose -was to prepare input for a dumb spelling checker, and it's only usable -for preparing useful \acro{ASCII} versions of a document in highly -restricted circumstances. - -\ProgName{Tex2mail} is slightly more than a de-TeX{}er~--- it's a -\ProgName{Perl} script that converts \TeX{} files into -plain text files, expanding various mathematical symbols -(sums, products, integrals, sub/superscripts, fractions, square -roots, \dots{}\@) into ``\acro{ASCII} art'' that spreads over -multiple lines if necessary. The result is more readable to human -beings than the flat-style \TeX{} code. - -Another significant possibility is to use one of the -\Qref*{\acro{HTML}-generation solutions}{Q-LaTeX2HTML}, -and then to use a browser such as \ProgName{lynx} to dump the resulting -\acro{HTML} as plain text. -\begin{ctanrefs} -\item[catdvi]\CTANref{catdvi} -\item[crudetype]\CTANref{crudetype} -\item[detex]\CTANref{detex} -\item[dvi2tty]\CTANref{dvi2tty} -\item[l2a]\CTANref{l2a} -\item[screen.sty]\CTANref{screensty} -\item[tex2mail]\CTANref{tex2mail} -\item[txt]\CTANref{txtdist} -\end{ctanrefs} - -\Question[Q-SGML2TeX]{Conversion from \acro{SGML} or \acro{HTML} to \protect\TeX{}} - -\acro{SGML} is a very important system for document storage and interchange, -but it has no formatting features; its companion \acro{ISO} standard -\acro{DSSSL} -(see \URL{http://www.jclark.com/dsssl/}) is designed for writing -transformations and formatting, -but this has not yet been widely implemented. Some \acro{SGML} authoring -systems (e.g., SoftQuad \ProgName{Author/Editor}) have formatting -abilities, and -there are high-end specialist \acro{SGML} typesetting systems (e.g., Miles33's -\ProgName{Genera}). However, the majority of \acro{SGML} users probably transform -the source to an existing typesetting system when they want to print. -\TeX{} is a good candidate for this. There are three approaches to writing a -translator: -\begin{enumerate} -\item Write a free-standing translator in the traditional way, with - tools like \ProgName{yacc} and \ProgName{lex}; this is hard, in - practice, because of the complexity of \acro{SGML}. -\item Use a specialist language designed for \acro{SGML} transformations; the - best known are probably \ProgName{Omnimark} and \ProgName{Balise}. - They are expensive, but powerful, incorporating \acro{SGML} query and - transformation abilities as well as simple translation. -\item Build a translator on top of an existing \acro{SGML} parser. By far - the best-known (and free!) parser is James Clark's - \ProgName{nsgmls}, and this produces a much simpler output format, - called \acro{ESIS}, which can be parsed quite straightforwardly (one also - has the benefit of an \acro{SGML} parse against the \acro{DTD}). Two - good public domain packages use this method: - \begin{itemize} - \item -\begin{narrowversion} % really non-hyper - David Megginson's \ProgName{sgmlspm}, written in \ProgName{Perl} - 5, which is available from - \URL{http://www.perl.com/CPAN/modules/by-module/SGMLS} -\end{narrowversion} -\begin{wideversion} - David Megginson's - \href{http://www.perl.com/CPAN/modules/by-module/SGMLS}{\ProgName{sgmlspm}}, - written in \ProgName{Perl} 5. -\end{wideversion} - \item -\begin{narrowversion} % really non-hyper - Joachim Schrod and Christine Detig's \ProgName{STIL} - (`\acro{SGML} Transformations in Lisp'), which is available from - \URL{ftp://ftp.tu-darmstadt.de/pub/text/sgml/stil} -\end{narrowversion} -\begin{wideversion} - Joachim Schrod and Christine Detig's - \href{ftp://ftp.tu-darmstadt.de/pub/text/sgml/stil}{\ProgName{STIL}}, - (`\acro{SGML} Transformations in Lisp'). -\end{wideversion} - \end{itemize} - Both of these allow the user to write `handlers' for every \acro{SGML} - element, with plenty of access to attributes, entities, and - information about the context within the document tree. - - If these packages don't meet your needs for an average \acro{SGML} - typesetting job, you need the big commercial stuff. -\end{enumerate} - -Since \acro{HTML} is simply an example of \acro{SGML}, we do not need a specific -system for \acro{HTML}. However, Nathan Torkington developed -% (\Email{Nathan.Torkington@vuw.ac.nz}) -\ProgName{html2latex} from the \acro{HTML} parser in \acro{NCSA}'s -Xmosaic package. -The program takes an \acro{HTML} file and generates a \LaTeX{} file from it. -The conversion code is subject to \acro{NCSA} restrictions, but the whole -source is available on \acro{CTAN}. - -Michel Goossens and Janne Saarela published a very useful summary of -\acro{SGML}, and of public domain tools for writing and manipulating it, in -\TUGboat{} 16(2). -\begin{ctanrefs} -\item[html2latex \nothtml{\rmfamily}source]\CTANref{html2latex} -\end{ctanrefs} - -\Question[Q-LaTeX2HTML]{Conversion from \AllTeX{} to \acro{HTML}} - -\TeX{} and \LaTeX{} are well suited to producing electronically publishable -documents. However, it is important to realize the difference -between page layout and functional markup. \TeX{} is capable of -extremely detailed page layout; \acro{HTML} is not, because \acro{HTML} is a -functional markup language not a page layout language. \acro{HTML}'s exact -rendering is not specified by the document that is published but is, to -some degree, left to the discretion of the browser. If you require your -readers to see an exact replication of what your document looks like -to you, then you cannot use \acro{HTML} and you must use some other -publishing format such as \acro{PDF}. That is true for any \acro{HTML} -authoring tool. - -\TeX{}'s excellent mathematical capabilities remain a challenge in the -business of conversion to \acro{HTML}. There are only two generally -reliable techniques for generating mathematics on the web: creating -bitmaps of bits of typesetting that can't be translated, and using -symbols and table constructs. Neither technique is entirely -satisfactory. Bitmaps lead to a profusion of tiny files, are slow to -load, and are inaccessible to those with visual disabilities. The -symbol fonts offer poor coverage of mathematics, and their use -requires configuration of the browser. The future of mathematical -browsing may be brighter~--- see -% beware line break -\Qref[question]{future Web technologies}{Q-mathml}. - -For today, possible packages are: -\begin{description} -\item[\ProgName{LaTeX2HTML}]a \ProgName{Perl} script package that - supports \LaTeX{} only, and generates mathematics (and other - ``difficult'' things) using bitmaps. The original version was - written by Nikos Drakos for Unix systems, but the package now sports - an illustrious list of co-authors and is also available for Windows - systems. Michel Goossens and Janne Saarela published a detailed - discussion of \ProgName{LaTeX2HTML}, and how to tailor it, in - \TUGboat{} 16(2). - - A mailing list for users may be found via - \URL{http://tug.org/mailman/listinfo/latex2html} -\item[\ProgName{TtH}]a compiled program that supports either \LaTeX{} - or \plaintex{}, and uses the font/table technique for representing - mathematics. It is written by Ian Hutchinson, using - \ProgName{flex}. The distribution consists of a single \acro{C} - source (or a compiled executable), which is easy to install and very - fast-running. -\item[\ProgName{Tex4ht}]a compiled program that supports either - \LaTeX{} or \plaintex{}, by processing a \acro{DVI} file; it uses - bitmaps for mathematics, but can also use other technologies where - appropriate. Written by Eitan Gurari, it parses the \acro{DVI} - file generated when you run \AllTeX{} over your file with - \ProgName{tex4ht}'s macros included. As a result, it's pretty - robust against the macros you include in your document, and it's - also pretty fast. -\item[\ProgName{plasTeX}]a Python-based \LaTeX{} document processing - framework. It gives DOM-like access to a \LaTeX{} document, as - well as the ability to generate mulitple output formats - (e.g. HTML, DocBook, tBook, etc.). -\item[\ProgName{TeXpider}]a commercial program from - \Qref*{Micropress}{Q-commercial}, which is - described on \URL{http://www.micropress-inc.com/webb/wbstart.htm}; - it uses bitmaps for equations. -\item[\ProgName{Hevea}] a compiled program that supports \LaTeX{} - only, and uses the font/table technique for equations (indeed its - entire approach is very similar to \ProgName{TtH}). It is written - in Objective \acro{CAML} by Luc Maranget. \ProgName{Hevea} isn't - archived on \acro{CTAN}; details (including download points) are - available via \URL{http://pauillac.inria.fr/~maranget/hevea/} -\end{description} -An interesting set of samples, including conversion of the same text -by the four free programs listed above, is available at -\URL{http://www.mayer.dial.pipex.com/samples/example.htm}; a linked -page gives lists of pros and cons, by way of comparison. - -The World Wide Web Consortium maintains a list of ``filters'' to -\acro{HTML}, with sections on \AllTeX{} and \BibTeX{}~--- see -\URL{http://www.w3.org/Tools/Word_proc_filters.html} -\begin{ctanrefs} -\item[latex2html]Browse \CTANref{latex2html} -\item[plasTeX]Browse \CTANref{plastex} -\item[tex4ht]\CTANref{tex4ht} -\item[tth]\CTANref{tth} -\end{ctanrefs} - -\Question[Q-fmtconv]{Other conversions to and from \AllTeX{}} - -\begin{description} -\item[troff]\ProgName{Tr2latex}, assists in the translation of a - \ProgName{troff} document into \LaTeXo{} format. It recognises most - |-ms| and |-man| macros, plus most \ProgName{eqn} and some - \ProgName{tbl} preprocessor commands. Anything fancier needs to be - done by hand. Two style files are provided. There is also a man page - (which converts very well to \LaTeX{}\dots{}). - \ProgName{Tr2latex} is an enhanced version of the earlier - \ProgName{troff-to-latex} (which is no longer available). - -% The \acro{DECUS} \TeX{} distribution (see -% \Qref[question]{sources of software}{Q-archives}) -% also contains a program which converts \ProgName{troff} to \TeX{}. - -%\item[Scribe] Mark James (\Email{jamesm@dialogic.com}) has a copy of -% \ProgName{scribe2latex} he has been unable to test but which he will -% let anyone interested have. The program was written by Van Jacobson -% of Lawrence Berkeley Laboratory.% -% \checked{RF}{1994/11/18} - -\item[WordPerfect] \ProgName{wp2latex} is actively maintained, and is - available either for \MSDOS{} or for Unix systems. -\item[\acro{RTF}] \ProgName{Rtf2tex}, by Robert Lupton, is for - converting Microsoft's Rich Text Format to \TeX{}. There is also a - converter to \LaTeX{} by Erwin Wechtl, called \ProgName{rtf2latex}. - The latest converter, by Ujwal Sathyam and Scott Prahl, is - \ProgName{rtf2latex2e} which seems rather good, though development - of it seems to have stalled. - - Translation \emph{to} \acro{RTF} may be done (for a somewhat - constrained set of \LaTeX{} documents) by \TeX{}2\acro{RTF}, which - can produce ordinary \acro{RTF}, Windows Help \acro{RTF} (as well as - \acro{HTML}, \Qref{conversion to HTML}{Q-LaTeX2HTML}). - \TeX{}2\acro{RTF} is supported on various Unix platforms and under - Windows~3.1 -\item[Microsoft Word] A rudimentary (free) program for converting - MS-Word to \LaTeX{} is \ProgName{wd2latex}, which runs on \MSDOS{}. - \ProgName{Word2}\emph{\TeX{}} and \emph{\TeX{}}\ProgName{2Word} are - shareware translators from % beware line break - \href{http://www.chikrii.com/}{Chikrii Softlab}; users' reports are - very positive. - - The excellent \ProgName{tex4ht} will generate OpenOffice \acro{ODT} - format, which can be used as an intermediate to producing Word - format files. - - If cost is a constraint, the best bet is probably to use an - intermediate format such as \acro{RTF} or \acro{HTML}. - \ProgName{Word} outputs and reads both, so in principle this route - may be useful. - - You can also use \acro{PDF} as an intermediate format: Acrobat Reader - for Windows (version 5.0 and later) will output rather feeble - \acro{RTF} that \ProgName{Word} can read. -\item[Excel] \ProgName{Excel2Latex} converts an \ProgName{Excel} file - into a \LaTeX{} \environment{tabular} environment; it comes as a - \extension{xls} file which defines some \ProgName{Excel} macros to produce - output in a new format. -\item[runoff] Peter Vanroose's \ProgName{rnototex} - conversion program is written in \acro{VMS} Pascal. - The sources are distributed with a \acro{VAX} executable. -\item[refer/tib] There are a few programs for converting bibliographic - data between \BibTeX{} and \ProgName{refer}/\ProgName{tib} formats. - The collection includes a shell script converter from \BibTeX{} to - \ProgName{refer} format as well. The collection - is not maintained. -\item[\acro{PC}-Write]\ProgName{pcwritex.arc} is a - print driver for \acro{PC}-Write that ``prints'' a \acro{PC}-Write - V2.71 document to a \TeX{}-compatible disk file. It was written by Peter - Flynn at University College, Cork, Republic of Ireland. -\end{description} - -% beware line breaks -\href{http://www.tug.org/utilities/texconv/index.html}{Wilfried Hennings' \acro{FAQ}}, -which deals specifically with conversions between \TeX{}-based formats -and word processor formats, offers much detail as well as tables that -allow quick comparison of features. - -A group at Ohio State University (\acro{USA}) is working on -a common document format based on \acro{SGML}, with the ambition that any -format could be -translated to or from this one. \ProgName{FrameMaker} provides -``import filters'' to aid translation from alien formats -(presumably including \TeX{}) to \ProgName{FrameMaker}'s own. -\begin{ctanrefs} -\item[excel2latex]\CTANref{excel2latex} -\item[pcwritex.arc]\CTANref{pcwritex} -\item[refer and tib tools]\CTANref{refer-tools} -\item[rnototex]\CTANref{rnototex} -\item[rtf2latex]\CTANref{rtf2latex} -\item[rtf2latex2e]\CTANref{rtf2latex2e} -\item[rtf2tex]\CTANref{rtf2tex} -\item[tex2rtf]\CTANref{tex2rtf} -\item[tr2latex]\CTANref{tr2latex} -\item[wd2latex]\CTANref{wd2latex} -\item[wp2latex]\CTANref{wp2latex} -\item[\nothtml{\rmfamily}Word processor \acro{FAQ} (source)]% - \CTANref{texcnvfaq} -\end{ctanrefs} - -\Question[Q-readML]{Using \TeX{} to read \acro{SGML} or \acro{XML} directly} - -This can nowadays be done, with a certain amount of clever macro -programming. David Carlisle's \Package{xmltex} is the prime example; -it offers a practical solution to typesetting -\acro{XML} files. - -One use of a \TeX{} that can typeset \acro{XML} files is as a backend -processor for \acro{XSL} formatting objects, serialized as \acro{XML}. -Sebastian Rahtz's Passive\TeX{} uses \Package{xmltex} to -achieve this end. -\begin{ctanrefs} -\item[xmltex]\CTANref{xmltex} -\item[passivetex]\CTANref{passivetex} -\end{ctanrefs} - -\Question[Q-recovertex]{Retrieving \AllTeX{} from \acro{DVI}, etc.} - -The job just can't be done automatically: \acro{DVI}, \PS{} and -\acro{PDF} are ``final'' formats, supposedly not susceptible to -further editing~--- information about where things came from has been -discarded. So if you've lost your \AllTeX{} source (or never -had the source of a document you need to work on) you've a serious job -on your hands. In many circumstances, the best strategy is to retype -the whole document, but this strategy is to be tempered by -consideration of the size of the document and the potential typists' -skills. - -If automatic assistance is necessary, it's unlikely that any more than -text retrieval is going to be possible; the \AllTeX{} markup that -creates the typographic effects of the document needs to be recreated -by editing. - -If the file you have is in \acro{DVI} format, many of the techniques -for \Qref*{converting \AllTeX{} to \acro{ASCII}}{Q-toascii} are -applicable. Consider \ProgName{dvi2tty}, \ProgName{crudetype} and -\ProgName{catdvi}. Remember that there are likely to be problems -finding included material (such as included \PS{} figures, that -don't appear in the \acro{DVI} file itself), and mathematics is -unlikely to convert easily. - -To retrieve text from \PS{} files, the -\ProgName{ps2ascii} tool (part of the \ProgName{ghostscript} -distribution) is available. One could try applying this tool to -\PS{} derived from an \acro{PDF} file using \ProgName{pdf2ps} (also -from the \ProgName{ghostscript} distribution), or \ProgName{Acrobat} -\ProgName{Reader} itself; an alternative is \ProgName{pdftotext}, -which is distributed with \ProgName{xpdf}. - -Another avenue available to those with a \acro{PDF} file they want to -process is offered by Adobe \ProgName{Acrobat} (version 5 or later): -you can tag the \acro{PDF} file into an estructured document, output -thence to well-formed \acro{XHTML}, and import the results into -Microsoft \ProgName{Word} (2000 or later). From there, one may -convert to \AllTeX{} using one of the techniques discussed in -% beware line break -\wideonly{``}\Qref[question]{converting to and from \AllTeX{}}{Q-fmtconv}\wideonly{''}. - -The result will typically (at best) be poorly marked-up. Problems may -also arise from the oddity of typical \TeX{} font encodings (notably -those of the maths fonts), which \ProgName{Acrobat} doesn't know how -to map to its standard Unicode representation. -\begin{ctanrefs} -\item[catdvi]\CTANref{catdvi} -\item[crudetype]\CTANref{crudetype} -\item[dvi2tty]\CTANref{dvi2tty} -\item[ghostscript]Browse \CTANref{ghostscript} -\item[xpdf]Browse \CTANref{xpdf} -\end{ctanrefs} - -\Question[Q-LaTeXtoPlain]{Translating \LaTeX{} to \plaintex{}} - -Unfortunately, no ``general'', simple, automatic process is likely to -succeed at this task. See % ! line break -``\Qref*{How does \LaTeX{} relate to \plaintex{}}{Q-LaTeXandPlain}'' -for further details. - -Translating a document designed to work with \LaTeX{} into one -designed to work with \plaintex{} is likely to amount to carefully -including (or otherwise re-implementing) all those parts of \LaTeX{}, -beyond the provisions of \plaintex{}, which the document uses. - -Some of this work is has (in a sense) been done, in the port of the -\LaTeX{} graphics package to \plaintex{}. However, while -\Package{graphics} is available, other complicated packages (notably -\Package{hyperref}) are not. The aspiring translator may find the -\Qref*{\Eplain{}}{Q-eplain} system a useful source of code. (In fact, -a light-weight system such as \Eplain{} might reasonably be adopted as -an alternative target of translation, though it undoubtedly gives the -user more than the ``bare minimum'' that \plaintex{} is designed to -offer.) -\begin{ctanrefs} -\item[\latexhtml{\textrm{The}}{The} eplain \nothtml{\rmfamily}system]% - \CTANref{eplain} -\item[\latexhtml{\textrm{`\plaintex{}'}}{\plaintex{}} graphics]% - \CTANref{graphics-plain} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Installing \AllTeX{} files} - -\Question[Q-installthings]{Installing things on a \AllTeX{} system} -\AliasQuestion{Q-instpackages} - -Installing (or replacing) things on your \AllTeX{} system has the -potential to be rather complicated; the following questions attempt to -provide a step-by-step approach, starting from the point where you've -decided what it is that you want to install: -\begin{itemize} -\item You must \Qref*{find the file you need}{Q-install-find}; -\item If you are going to install a \LaTeX{} package, you may need to - \Qref*{unpack the distributed files}{Q-install-unpack}; -\item It may be necessary to % ! line break - \Qref*{generate some documentation to read}{Q-install-doc}; -\item You need to % ! line break - \Qref*{decide where to install the files}{Q-install-where}; -\item You must now \Qref*{install the files}{Q-inst-wlcf}; and - finally -\item You may need to \Qref*{tidy up}{Q-inst-tidy} after the installation. -\end{itemize} - -\Question[Q-install-find]{Finding packages to install} - -How did you learn about the package? - -If the information came from these \acro{FAQ}s, you should already -have a link to the file (there are lists at the end of each answer): -\begin{narrowversion} - make a browser link from \URL{http://mirror.ctan.org/} and the text - in the list; if the link returns a directory listing, you can - generally retrieve the whole directory by appending the link with - \extension{zip} -\end{narrowversion} -\begin{wideversion} - click on one of the links associated with the package, and you can - get the package (which may be one file or several). -% need searate wording for pdfversion and htmlversion, here -\end{wideversion} - -If you heard about the file somewhere else, it's possible that the -source told you where to look; if not, try the \acro{CTAN} searching -facilities, such as \URL{http://www.tex.ac.uk/search/}. That (rather -simple) search engine can return data from a search of the CTAN -catalogue (which covers most useful packages), or data from a search -of the names of files on the archive. - -Packages come in a variety of different styles of distribution; the -very simplest will actually offer just \File{package.sty}~--- in this -case, just download the file and % ! line break -\Qref*{get on with installation}{Q-inst-wlcf}. - -Normally, though, you will want \File{foo.sty} but that file is distributed -in a \LaTeX{} documented source file \File{foo.dtx}; thus you should -search just for \emph{foo}~--- \File{foo.sty} won't be visible -anywhere on the archive or in the catalogue. - -Since most packages are distributed in this -\extension{dtx}/\extension{ins} way, they usually occupy their own -directory on the archive. Even if that directory contains other -packages, you should download everything in the directory: as often as -not, packages grouped in this way depend on each other, so that you -really \emph{need} the other ones. - -Having acquired the package distribution, % ! line break -``\Qref*{unpacking \LaTeX{} packages}{Q-install-unpack}'' outlines -your next step. - -\Question[Q-install-unpack]{Unpacking \LaTeX{} packages} - -As discussed \Qref*{elsewhere}{Q-dtx}, the `ordinary' way to -distribute a \LaTeX{} package is as a pair of files \File{package.dtx} -and \File{package.ins}. If you've acquired such a pair, you simply -process \File{package.ins} with \LaTeX{}, and the files will appear, -ready for installation. - -Other sorts of provision should ordinarily be accompanied by a -\File{README} file, telling you what to do; we list a few example -configurations. - -Sometimes, a directory comes with a bunch of \extension{dtx} files, but -fewer (often only one) \extension{ins} files (\LaTeX{} itself comes -looking like this). If there is more than one \extension{ins} file, -and in the absence of any instruction in the \File{README} file, simply -process the \extension{ins} file(s) one by one. - -If you're missing the \File{package.ins} altogether, you need to play -around until something works. Some \extension{dtx} files are -``self-extracting''~--- they do without an \extension{ins} file, and once -you've processed the \File{package.dtx}, \File{package.sty} has -automagically appeared. Various other oddities may appear, but the -archivists aim to have \File{README} file in every package, which -should document anything out of the ordinary with the distribution. - -\Question[Q-install-doc]{Generating package documentation} - -We are faced with a range of ``normal'' provision, as well as several -oddities. One should note that documentation of many packages is -available on \acro{CTAN}, without the need of any further effort by -the user~--- such documentation can usually be browsed \emph{in situ}. - -However, if you find a package that does not offer documentation on -the archive, or if you need the documentation in some other format -than the archive offers, you can usually generate the documentation -yourself from what you download from the archive. - -The standard mechanism, for \LaTeX{} packages, is simply to run -\LaTeX{} on the \File{package.dtx} file, as you would any ordinary -\LaTeX{} file (i.e., repeatedly until the warnings go away). - -A variant is that the unpacking process provides a file -\File{package.drv}; if such a thing appears, process it in preference -to the \File{package.dtx} (it seems that when the documented \LaTeX{} -source mechanism was first discussed, the \File{.drv} mechanism was -suggested, but it's not widely used nowadays). - -Sometimes, the \LaTeX{} run will complain that it can't find -\File{package.ind} (the code line index) and/or \File{package.gls} -(the list of change records, not as you might imagine, a glossary). -Both types of file are processed with special \ProgName{makeindex} -style files; appropriate commands are: -\begin{quote} -\begin{verbatim} -makeindex -s gind package -makeindex -s gglo -o package.gls package.glo -\end{verbatim} -\end{quote} -This author finds that the second (the change record) is generally of -limited utility when reading package documentation; it is, however, -valuable if you're part of the package development team. If you don't -feel you need it, just leave out that step - -Another common (and reasonable) trick performed by package authors is -to provide a separate file \File{package-doc.tex} or even simply -\File{manual.tex}; if the file \File{package.dtx} doesn't help, simply -look around for such alternatives. The files are treated in the same -way as any ``ordinary'' \LaTeX{} file. - -\Question[Q-inst-wlcf]{Installing files ``where \AllTeX{} can find them''} -\AliasQuestion{Q-wherefiles} - -In the past, package documentation used always to tell you to put your -files ``where \LaTeX{} can find them''; this was always unhelpful~--- -if you knew where that \emph{was}, you didn't need telling, but if you -\emph{didn't} know, you were completely stuck. - -It was from this issue that the whole idea of the \acro{TDS} sprang; -``where to put'' questions now come down to ``where's the \acro{TDS} -tree?''. - -We therefore answer the question by considering: -\begin{itemize} -\item \Qref*{what tree to use}{Q-what-TDS}, and -\item \Qref*{where in the tree to put the files}{Q-install-where}. -\end{itemize} - -Once we know the answer to both questions, and we've created any -directories that are needed, we simply copy files to their rightful -location. - -This has done what the old requirement specified: \LaTeX{} (or -whatever) \emph{can} (in principle) find the files. However, in order -that the software \emph{will} find the files, we need to update an -index file. - -On a \miktex{} system, open the window - \texttt{Start}\arrowhyph{}% - \texttt{All Programs}\arrowhyph{}% - \texttt{\miktex{} \meta{version}}\arrowhyph{}% - \texttt{Settings}, -and click on \texttt{Refresh FNDB}. -The job may also be done in a command window, using the command: -\begin{quote} -\begin{verbatim} -initexmf --update-fndb -\end{verbatim} -\end{quote} -The % ! line break -\href{http://docs.miktex.org/manual/initexmf.html}{\miktex{} documentation} -gives further details about \texttt{initexmf}. - -On a te\TeX{} or \texlive{}-based system, use the command -\texttt{texhash} (or if that's not available, \texttt{mktexlsr}~--- -they ought to be different names for the same program). - -Having done all this, the new package will be available for use. - -\Question[Q-what-TDS]{Which tree to use} - -In almost all cases, new material that you install should go into the -``local'' tree of your \AllTeX{} installation. (A discussion of -reasons \emph{not} to use the local tree appears below.) - -On a Unix(-alike) system, using te\TeX{} or \texlive{}, the root -directory will be named something like \path{/usr/share/texmf-local/} -or \path{/usr/local/share/texmf/} -You can ask such a system where it believes a local tree should be: -\begin{quote} -\begin{verbatim} -kpsewhich -expand-var "\$TEXMFLOCAL" -\end{verbatim} -\end{quote} -the output being the actual path, for example (on the workstation the -author is using today): -\begin{quote} -\begin{verbatim} -/usr/local/share/texmf -\end{verbatim} -\end{quote} - -In a \miktex{} installation, the location will in fact typically be -something you specified yourself when you installed \miktex{} in the -first place, but you may find you need to create one. The \miktex{} -``Settings'' window (% - \texttt{Start}\arrowhyph{}% - \texttt{Programs}\arrowhyph{}% - \texttt{\miktex{}}\arrowhyph{}% - \texttt{Settings}) -has a tab ``\texttt{Roots}''; that tab gives a list of current -\acro{TDS} roots (they're typically not called -\texttt{texmf}-anything). If there's not one there with -``\texttt{local}'' in its name, create an appropriate one (see below), -and register it using the window's -``\texttt{Add}'' button. - -The % ! line break -\href{http://docs.miktex.org/faq/maintenance.html}{\miktex{} \acro{FAQ}} -suggests that you should create % ! line break -``\texttt{C:\textbackslash Local TeX Files}'', which is good if you -manage your own machine, but often not even possible in corporate, or -similar, environments~--- in such situations, the user may have no -control over the hard disc of the computer, at all. - -So the real criterion is that your local tree should be somewhere that -\emph{you}, rather than the system, control. Restrictive systems often -provide a ``home directory'' for each user, mounted as a network -drive; this is a natural home for the user's local tree. Other (often -academic) environments assume the user is going to provide a memory -stick, and will assign it a defined drive letter~--- another good -candidate location. Note that the semantics of such a tree are -indistinguishable from those of a % ! line break -\Qref*{``home'' \acro{TEXMF} tree}{Q-privinst}. - -There are circumstances when you might not wish to use the `local' tree: -\begin{itemize} -\item if the package, or whatever, is ``personal'' (for example, - something commercial that has been licensed to you alone, or - something you're developing yourself), it should go in your - \Qref*{``home'' \acro{TEXMF} tree}{Q-privinst}; -\item if you \emph{know} that the package you are installing is a - replacement for the copy on the \acro{TEXMF} tree of your \AllTeX{} - distribution, you should replace the existing copy in the - \acro{TEXMF} tree. -\end{itemize} -The reason one would put things on a local tree is to avoid their -disappearance if the system is upgraded (or otherwise re-installed). - -The reason one might place upgrades the distribution's main tree is to -avoid confusion. Suppose you were to place the file on the local -tree, and then install a new version of the distribution~--- you might -have an effect like: -\begin{itemize} -\item distribution comes with package version \ensuremath{n}; -\item you install package version \ensuremath{n+1} on the local tree; and -\item the updated distribution provides package version \ensuremath{n+2}. -\end{itemize} -In such a situation, you will find yourself using version -\ensuremath{n+1} (from the local tree) \emph{after} the new -distribution has been installed. - -If you install in the local tree, the only way to avoid such problems -is to carefully purge the local tree when installing a new -distribution. This is tedious, if you're maintaining a large -installation. - -\Question[Q-install-where]{Where to install packages} - -We assume here that you have decided what tree to put your files in, -after reading % ! line break -``\Qref*{choosing a \acro{TDS} tree}{Q-what-TDS}''. We will therefore -write \texttt{\$TEXMF} for it, and you need to substitute the tree -you decided on. - -The basic idea is to imitate the directory structure in your -existing tree(s). Here are some examples of where various sorts of -files should go: -\begin{quote} -\begin{verbatim} -.sty, .cls or .fd: $TEXMF/tex/<format>/<package>/ -.mf: $TEXMF/fonts/source/<supplier>/<font>/ -.tfm: $TEXMF/fonts/tfm/<supplier>/<font>/ -.vf: $TEXMF/fonts/vf/<supplier>/<font>/ -.afm: $TEXMF/fonts/afm/<supplier>/<font>/ -.pfb: $TEXMF/fonts/type1/<supplier>/<font>/ -.ttf: $TEXMF/fonts/truetype/<supplier>/<font>/ -.otf: $TEXMF/fonts/opentype/<supplier>/<font>/ -.pool, .fmt, .base or .mem: $TEXMF/web2c -\end{verbatim} -\end{quote} -and for modern systems (those distributed in 2005 or later, using \acro{TDS} -v1.1 layouts): -\begin{quote} -\begin{verbatim} -.map: $TEXMF/fonts/map/<syntax>/<bundle>/ -.enc: $TEXMF/fonts/enc/<syntax>/<bundle>/ -\end{verbatim} -\end{quote} -(Map and encoding files went to directories under -\File{$TEXMF/dvips/}, in earlier distributions.) - -In the lists above \meta{format} identifies the format the macros -are designed for~--- it can be things such as \texttt{plain}, -\texttt{generic} (i.e., any format), \texttt{latex} or -\texttt{context} (or several less common formats). - -For fonts, \meta{font} refers to the font family (such as \texttt{cm} -for Knuth's Computer Modern, \texttt{times} for Adobe's Times Roman). -The supplier is usually obvious~--- the supplier -``public'' is commonly used for free fonts. - -The \meta{syntax} (for \extension{map} and \extension{enc} files) is a -categorisation based on the way the files are written; candidates are -names of programs such as \ProgName{dvips} or \ProgName{pdftex}. - -``Straight'' \AllTeX{} input can take other forms than the -\extension{sty}, \extension{cls} or \extension{fd} listed above, too -(apart from the `obvious' \extension{tex}). Examples are (the -obvious) \extension{tex}, \extension{lfd} for \Package{babel} language -definitions, \extension{sto} and \extension{clo} for package and class -options, \extension{cfg} for configuration information, -\extension{def} for variants (such as the types of devices -\Package{graphics} drives). The \File{README} of the package should -tell you of any others, though sometimes that information is printed -when the package's \Qref*{comments are stripped}{Q-install-unpack}. -All of these files should live together with the main package files. - -Note that \meta{font} may stand for a single font or an entire family: -for example, files for all of Knuth's Computer Modern fonts are to be -found in \texttt{.../public/cm}, with various prefixes as appropriate. - -The font ``supplier'' \emph{public} is a sort of hold-all for -``free fonts produced for use with \AllTeX{}'': as well as Knuth's -fonts, \emph{public}'s directory holds fonts designed by others -(originally, but no longer exclusively, in \MF{}). - -Documentation for each package should all go, undifferentiated, into a -directory on the \path{doc/} subtree of the \acro{TDS}. The layout of -the subtree is slightly different: \path{doc/latex} hosts all -\LaTeX{} documentation directories, but more fundamental things are -covered, e.g., by \path{doc/etex} or \path{doc/xetex}. - -\Question[Q-inst-tidy]{Tidying up after installation} - -There's not usually a lot to do after you've completed the steps -above~--- indeed, if you're merely installed files direct from the -archive, or whatever, there will be precisely nothing left, by way of -debris. - -Things you might care to clean up are: -\begin{itemize} -\item the archive file, if you retrieved your data from the archive - as a \extension{zip} file, or the like; -\item the \extension{dtx} and \extension{ins} files, if you chose not - to install them with the documentation; and -\item the \extension{aux}, \extension{log}, \extension{idx}, etc., - from building the documentation. -\end{itemize} -A simple way of achieving all this is to download to a working -directory that was created for the purpose, and then to delete that -directory and all its contents after you've finished installing. - -\Question[Q-inst-scut]{Shortcuts to installing files} -\AliasQuestion{Q-inst-miktex} - -There are circumstances in which most of the fuss of installation can -be bypassed: -\begin{itemize} -\item If you are a \miktex{} user, the -\begin{wideversion} - \Qref{\miktex{} package management system}{Q-inst-miktex*} - can usually help; -\end{wideversion} -\begin{narrowversion} - \miktex{} package management system can usually help - (\Qref{}{Q-inst-miktex*}); -\end{narrowversion} -\item The package you want may already exist as a \acro{ZIP} file -\begin{wideversion} - formatted for \Qref{direct installation}{Q-inst-tds-zip}. -\end{wideversion} -\begin{narrowversion} - formatted for direct installation (\Qref{}{Q-inst-tds-zip}). -\end{narrowversion} -\end{itemize} - -\Question[Q-inst-miktex*]{Installation using \miktex{} package manager} - -Packages for use with \miktex{} are maintained very efficiently by the -project managers (new packages and updates on \acro{CTAN} ordinarily -make their way to the \miktex{} package repository within a week). -Thus it makes sense for the \miktex{} user to take advantage of the -system rather than grinding through the steps of installation. - -\miktex{} maintains a database of packages it ``knows about'', -together with (coded) installation instructions that enable it to -install the packages with minimal user intervention; you can update -the database over the internet. - -If \miktex{} does know about a package you need installed, it's worth -using the system: -first, open the \miktex{} packages window: click on - \texttt{Start}\arrowhyph{}% - \texttt{Programs}\arrowhyph{}% - \texttt{MiKTeX}\arrowhyph{}% - \texttt{MiKTeX Options}, and select the - \texttt{Packages} tab. - -On the tab, there is an Explorer-style display of packages. -Right-click on the root of the tree, ``\texttt{MiKTeX Packages}'', -and select ``\texttt{Search}'': enter the name of the package you're -interested in, and press the ``\texttt{Search}'' button. If -\miktex{} knows about your package, it will open up the tree to show -you a tick box for your package: check that box. - -If you prefer a command-line utility, there's \ProgName{mpm}. Open a -command shell, and type: -\begin{quote} -\begin{verbatim} -mpm --install=<package> -\end{verbatim} -\end{quote} -(which of course assumes you know the name by which \miktex{} refers to -your package). - -\Question[Q-inst-tds-zip]{Installing using ready-built \acro{ZIP} files} - -Installing packages, as they (``traditionally'') appear on -\acro{CTAN}, involves: -\begin{itemize} -\item identifying where to put the various files on an \acro{TDS} - tree, -\item installing them, and -\item a few housekeeping operations. -\end{itemize} -Most people, for most packages, find the first two steps onerous, the -last being easy (unless it is forgotten!). - -Ready-built \acro{ZIP} files~--- also known as % ! line break -\Qref*{\acro{TDS}-\acro{ZIP} files}{Q-tds-zip}~--- are designed to lighten -the load of performing the first two steps of installation: they -contain all the files that are that's to be installed for a given -package, in their ``correct'' locations in a % ! line break -\Qref*{\acro{TDS} tree}{Q-tds}. - -To install such a file on a Unix system (we assume that you'll install -into the local \acro{TEXMF} tree, at \texttt{\$TEXMFLOCAL}): -\begin{quote} -\begin{verbatim} -cd $TEXMFLOCAL -unzip $package.tds.zip -\end{verbatim} -\end{quote} - -On a Windows system that is modern enough that it has a built-in -\acro{ZIP} unpacker, simply double-click on the file, and browse to -where it's to be unpacked. (We trust that those using earlier -versions of Windows will already have experience of using -\ProgName{WinZIP} or the like.) - -Having unpacked the \extension{zip} archive, in most cases the only -remaining chore is to update the file indexes~--- as in % ! line break -\Qref*{normal installation instructions}{Q-inst-wlcf}. However, if -the package provides a font, you also need to enable the font's map, -which is discussed in % ! line break -``\Qref*{Installing a Type~1 font}{Q-instt1font}'' - -\Question[Q-tempinst]{``Temporary'' installation of \AllTeX{} files} - -Operating systems and applications need to know where to find files: -many files that they need are ``just named''~--- the user doesn't -necessarily know \emph{where} they are, but knows to ask for them. -The commonest case, of course, is the commands whose names you type to -a shell (yes, even Windows' ``\MSDOS{} prompt'') are using a shell to read what -you type: many of the commands simply involve loading and executing a -file, and the \texttt{PATH} variable tells the shell where to find those files. - -Modern \TeX{} implementations come with a bunch of search paths -built in to them. In most circumstances these paths are adequate, but -one sometimes needs to extend them to pick up files in strange -places: for example, we may wish to try a new bundle of packages -before \Qref*{installing them `properly'}{Q-installthings}. To do -this, we need to change the relevant path as \TeX{} perceives it. -However, we don't want to throw away \TeX{}'s built-in path (all of a -sudden, \TeX{} won't know how to deal with all sorts of things). - -To \emph{extend} a \TeX{} path, we define an operating system -environment variable in `path format', but leaving a gap which \TeX{} -will fill with its built-in value for the path. The commonest case is -that we want to place our extension in front of the path, so that our -new things will be chosen in preference, so we leave our `gap to be -filled' at the end of the environment variable. The syntax is simple -(though it depends which shell you're actually using): so on a -Unix-like system, using the \ProgName{bash} shell, the job might be -done like: -\begin{verbatim} - export TEXINPUTS=/tmp: -\end{verbatim} -while in a Windows system, within a \MSDOS{} window, it would be: -\begin{verbatim} - set TEXINPUTS=C:/temp; -\end{verbatim} -In either case, we're asking \TeX{} to load files from the root disc -temporary files directory; in the Unix case, the ``empty slot'' is -designated by putting the path separator `|:|' on its own at the end -of the line, while in the Windows case, the technique is the same, but -the path separator is `|;|'. - -Note that in either sort of system, the change will only affect -instances of \TeX{} that are started from the shell where the -environment variable was set. If you run \TeX{} from another window, -it will use the original input path. To make a change of input path -that will ``stick'' for all windows, set the environment variable in -your login script or profile (or whatever) in a Unix system and log -out and in again, or in \File{autoexec.bat} in a Windows system, and -reboot the system. - -While all of the above has talked about where \TeX{} finds its macro -files, it's applicable to pretty much any sort of file any -\TeX{}-related program reads~--- there are lots of these paths, and of -their corresponding environment variables. In a -\ProgName{web2c}-based system, the copious annotations in the -\File{texmf.cnf} system configuration file help you to learn which -path names correspond to which type of file. - -\Question[Q-privinst]{``Private'' installations of files} - -It sometimes happens that you need a new version of some macro package -or font, but that the machine you use is maintained by someone who's -unwilling to update and won't give you privileges to do the job -yourself. A \Qref*{``temporary'' installation}{Q-tempinst} is -sometimes the correct approach, but if there's the slightest chance -that the installation will be needed on more than one project, -temporary installations aren't right. - -In circumstances where you have plenty of quota on backed-up media, or -adequate local scratch space, the correct approach is to create a -private installation of \AllTeX{} which includes the new stuff you -need; this is the ideal, but is not generally possible. - -So, since you can't install into the public \texttt{texmf} tree, you -have to install into a \File{texmf} tree of your own; fortunately, the -\acro{TDS} standard allows for this, and modern distributions allow -you to do it. The most modern distributions refer to the tree as -\texttt{\$TEXMFHOME}, but it used to be called \texttt{\$HOMETEXMF}; -so to check that your \TeX{} system does indeed support the mechanism -you should start with -\begin{verbatim} -kpsewhich -expand-var "\$TEXMFHOME" -\end{verbatim} - -If you can confirm that the technique does indeed work, install your -new package (or whatever) in the \Qref*{correct place}{Q-install-where} -in a tree based on \File{$HOME/texmf}, and generate an index of that -tree -\begin{quote} -\begin{verbatim} -texhash $HOME/texmf -\end{verbatim} -\end{quote} -(the argument specifies which tree you are indexing: it's necessary -since you don't, by hypothesis, have access to the main tree, and -\ProgName{texhash} without the argument would try to write the main -tree. - -There are two wrinkles to this simple formula: first, the installation -you're using may \emph{not} define a home TEXMF directory, and second, -there may be some obstruction to using \File{$HOME/texmf} as the -default name. In either case, a good solution is to have your own -\File{texmf.cnf}~--- an idea that sounds more frightening that it -actually is. The installation's existing file may be located with the -command: -\begin{quote} -\begin{verbatim} -kpsewhich texmf.cnf -\end{verbatim} -\end{quote} -Take a copy of the file and put it into a directory of your own; this -could be any directory, but an obvious choice is the \File{web2c} -directory of the tree you want to create, i.e., -\File{$HOME/texmf/web2c} or the like. Make an environment variable to -point to this directory: -\begin{quote} -\begin{verbatim} -TEXMFCNF=$HOME/texmf/web2c -export TEXMFCNF -\end{verbatim} -\end{quote} -(for a Bourne shell style system), or -\begin{quote} -\begin{verbatim} -setenv TEXMFCNF $HOME/texmf/web2c -\end{verbatim} -\end{quote} -(for a C-shell style system). Now edit the copy of \File{texmf.cnf} - -There will be a line in the existing file that defines the tree where -everything searches; the simplest form of the line is: -\begin{quote} -\begin{verbatim} -TEXMF = !!$TEXMFMAIN -\end{verbatim} -\end{quote} -but, there are likely to be several alternative settings behind -comment markers (``\texttt{\textpercent}''), and the person who -installed your system may have left them there. Whatever, you need to -modify the line that's in effect: change the above to three lines: -\begin{quote} -\begin{verbatim} -HOMETEXMF = $HOME/texmf -TEXMF = {$HOMETEXMF,!!$TEXMFMAIN} -% TEXMF = !!$TEXMFMAIN -\end{verbatim} -\end{quote} -the important point being that \texttt{\$HOMETEXMF} must come before -whatever was there before, inside the braces. For example, if the -original was -\begin{quote} -\begin{verbatim} -TEXMF = {!!$LOCALTEXMF,!!$TEXMFMAIN} -\end{verbatim} -\end{quote} -it should be converted to: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -HOMETEXMF = $HOME/texmf -TEXMF = {$HOMETEXMF,!!$LOCALTEXMF, - !!$TEXMFMAIN} -% TEXMF = {!!$LOCALTEXMF,!!$TEXMFMAIN} -\end{verbatim} -{\small Note that the \texttt{TEXMF} line is only wrapped to make it - fit in the column; there should be no line break or space between - the final comma on the line and the \texttt{!!} on the next line.\par -}% -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -HOMETEXMF = $HOME/texmf -TEXMF = {$HOMETEXMF,!!$LOCALTEXMF,!!$TEXMFMAIN} -% TEXMF = {!!$LOCALTEXMF,!!$TEXMFMAIN} -\end{verbatim} -\end{wideversion} -\end{quote} -(retaining the original, as a comment, is merely an aide-memoir in -case you need to make another change, later). The \texttt{!!} signs -tell the file-searching library that it should insist on a -\ProgName{texhash}-ed directory tree; if you can count on yourself -remembering to run \ProgName{texhash} on your new tree every time you -change it, then it's worth adding the marks to your tree: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -TEXMF = {!!$HOMETEXMF,!!$LOCALTEXMF, - !!$TEXMFMAIN} -\end{verbatim} -{\small Note that the line is only wrapped to make it - fit in the column; there should be no line break or space between - the final comma on the line and the \texttt{!!} on the next line.\par -}% -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -TEXMF = {!!$HOMETEXMF,!!$LOCALTEXMF,!!$TEXMFMAIN} -\end{verbatim} -\end{wideversion} -\end{quote} -as this will make \AllTeX{} find its files marginally faster. - -Having made all these changes, \AllTeX{} should ``just use'' files in -your new tree, in preference to anything in the main tree~--- you can -use it for updates to packages in the main tree, as well as for -installing new versions of things. - -\Question[Q-instfont]{Installing a new font} - -Fonts are really ``just another package'', and so should be installed -in the same sort of way as packages. However, fonts tend to be more -complicated than the average package, and as a result it's sometimes -difficult to see the overall structure. - -Font files may appear in any of a large number of different formats; -each format has a different function in a \TeX{} system, and each is -stored in a directory its own sub-tree in the installation's -\acro{TDS} tree; all these sub-trees have the directory -\File{$TEXMF/fonts} as their root. A sequence of answers% -\nothtml{, below,} describes the installation of fonts\latexhtml{.}{:} -\begin{htmlversion} -follow the list through the ``next question'' links at the bottom of -this answer to view them all. -\end{htmlversion} -Other answers discuss specific font families~--- for example, -% ! line break -``\Qref*{using the concrete fonts}{Q-concrete}''. - -\Question[Q-instmffont]{Installing a font provided as \MF{} source} - -Metafont fonts are (by comparison with other sorts of font) rather -pleasingly simple. Nowadays, they are mostly distributed just as the -\MF{} source, since modern \TeX{} distributions are able to produce -everything the user needs ``on the fly''; however, if the distribution -\emph{does} include \acro{TFM} files, install them too, since they -save a little time and don't occupy much disc space. Always distrust -distributions of \acro{PK} font bitmap files: there's no way of -learning from them what printer they were generated for, and naming -schemes under different operating systems are another source of -confusion. - -``\Qref*{Where to install files}{Q-install-where}'' -specifies where the files should go. - -Further confusion is introduced by font families whose authors devise rules -for automatic generation of \MF{} sources for generating fonts at -particular sizes; the installation has to know about the rules, as -otherwise it cannot generate font files. - -\Question[Q-instprinterfont]{Installing a \PS{} printer built-in font} - -There is a ``standard'' set of fonts that has appeared in every \PS{} -printer since the second generation of the type. These fonts -(8~families of four text fonts each, and three special-purpose fonts) -are of course widely used, because of their simple availability. The -set consists of: -\begin{itemize} -\item \FontName{Times} family (4 fonts) -\item \FontName{Palatino} family (4 fonts) -\item \FontName{New} \FontName{Century} \FontName{Schoolbook} family (4 fonts) -\item \FontName{Bookman} family (4 fonts) -\item \FontName{Helvetica} family (4 fonts) -\item \FontName{Avant} \FontName{Garde} (4 fonts) -\item \FontName{Courier} family (4 fonts) -\item \FontName{Utopia} family (4 fonts) -\item Zapf \FontName{Chancery} (1 font) -\item Zapf \FontName{Dingbats} (1 font) -\item \FontName{Symbol} (1 font) -\end{itemize} -All these fonts are supported, for \LaTeX{} users, by the -\Package{psnfss} set of metrics and support files in the file -\File{lw35nfss.zip} on \acro{CTAN}. Almost any remotely modern \TeX{} -system will have some version of \Package{psnfss} installed, but -users should note that the most recent version has much improved -coverage of maths with \FontName{Times} (see package -\Package{mathptmx}) and with \FontName{Palatino} (see package -\Package{mathpazo}, as well as a more reliable set of font metrics. - -The archive \File{lw35nfss.zip} is laid out according to the -\acro{TDS}, so in principle, installation consists simply of -``unzipping'' the file at the root of a \path{texmf} tree. - -Documentation of the \Package{psnfss} bundle is provided in -\File{psnfss2e.pdf} in the distribution. -\begin{ctanrefs} -\item[mathpazo.sty]Part of the \Package{psnfss} bundle -\item[mathptmx.sty]Part of the \Package{psnfss} bundle -\item[psnfss \nothtml{\rmfamily}bundle]\CTANref{psnfss} -\end{ctanrefs} - -\Question[Q-inst1cm]{Installing the Bluesky versions of the CM~fonts} - -This is a specialised case of \Qref*{installing a font}{Q-instfont}, -but it comes easier -than most, since the font metrics are installed in every \AllTeX{} -system before you even start. Indeed, most recent systems will have -the Type~1 fonts themselves already installed, so that the job is -already done, and all you need is to start using them: -so the first thing to do is to just try it. On a system that uses -\ProgName{dvips} (most systems nowadays do), try the sequence: -\begin{verbatim} - latex sample2e - dvips -Pcmz -Pamz -o sample2e.ps sample2e -\end{verbatim} -at a ``command prompt'' (\ProgName{shell}, in a Unix-style system, -``\acro{DOS} box'' in a Windows system). - -If the command works at all, the console output of the command will -include a sequence of Type~1 font file names, listed as -\texttt{<cmr10.pfb>} and so on; -this is \ProgName{dvips} telling you it's including the Type~1 font, -and you need do no more. - -If the test has failed, you need to install your own set of the fonts. - -The \acro{CTAN} directories listed below contain compressed archives of -the Type~1 -files for various architectures, both for the Computer Modern fonts -and for the \acro{AMS} fonts of mathematical and other useful things. -Download the archives that are appropriate for your architecture, and -extract the files~--- you only actually need the contents of the -\File{pfb} directories, since you already have the fonts -installed in the ``ordinary'' way, so that the \acro{TFM} files are -already present. (You don't need the \PS{} font metric~--- \acro{AFM} -and \acro{PFM}~--- files in any case.) - -The files should go into your local \texttt{texmf} tree (\File{texmf.local}, -\File{texmf-local}, \File{localtexmf}, or whatever). Create -directories at offsets \path{fonts/type1/bluesky/cm} and -\path{fonts/type1/bluesky/ams}, and copy the \extension{pfb} files into them. - -Now you need to tell \ProgName{dvips}, \PDFTeX{}, etc., that the fonts -are available. This is done by use of a \emph{map file}, which lists -\emph{font name} (as \TeX{} understands it), \emph{font name} (as it -appears in the type~1 file itself), and where the program will find -the file. Map files are provided in the download bundles for the -\acro{AMS} fonts; for the \acro{CM} fonts, map files are available -separately. - -The set of map files includes files \texttt{config.*}; each of these contains -an instruction to load a single map file. For ordinary use, you -instruct \ProgName{dvips} to load the ``detailed'' map of the -\acro{CM} fonts by use of the command: -\begin{verbatim} - dvips -Pcmz myfile -\end{verbatim} -The same can be done with the \acro{AMS} fonts, and you may invoke -both sets of fonts with: -\begin{verbatim} - dvips -Pcmz -Pamz myfile -\end{verbatim} -Alternatively, the contents of \File{config.cmz} and \File{config.amz} -could be combined into a single file, perhaps \File{config.bluesky}, -loaded by the command -\begin{verbatim} - dvips -Pbluesky myfile -\end{verbatim} - -Remember, after all such changes, the % beware line breaks -\Qref*{file-name database must be refreshed}{Q-inst-wlcf}. -\begin{ctanrefs} -\item[AMS fonts]Browse \CTANref{ams-AMStype1} -\item[CM fonts]Browse \CTANref{bluesky} -\item[CM font maps]\CTANref{bluesky-maps} -\end{ctanrefs} - -\Question[Q-prept1font]{Preparing a Type~1 font} - -The process of installing a Type~1 font set is rather convoluted, but -it may be separated into a modest set of operations. - -The two basic stages are to prepare the font(s) for installation (this -question) and installing the result (see % ! line break -\Qref[question]{installing a Type~1 font}{Q-instt1font}). Each of -these basic stages - -Many fonts are supplied in \AllTeX{} ready form: such fonts need no -preparation, and may be \Qref*{installed immediately}{Q-instt1font}. -However, if you purchase a font from a Type foundry (either direct or -via one of the web stores), you are likely to need to `prepare' it for -use with \AllTeX{}. The rest of this answer discusses this preparation. -\begin{itemize} -\item Acquire the font. A very small set of Type~1 fonts is installed - in most \PS{} printers you will encounter. For those few (whose use - is covered by the basic \acro{PSNFSS} package), you don't need the - Type~1 font itself, to be able to print using the font. - - For all the myriad other Type~1 fonts, to be able to print using - the font you need the Type~1 file itself. Some of these are - available for free (they've either been donated to the public - domain, or were developed as part of a free software project), but - the vast majority are commercial products, requiring you to spend - real money. -\item Acquire the fonts' \acro{AFM} files. \acro{AFM} files contain - information from the font foundry, about the sizes of the characters - in the font, and how they fit together. One measure of the quality - of a font-supplier is that they provide the \acro{AFM} files by - default: if the files are not available, you are unlikely to be able - to use the font with \AllTeX{}. -\item Rename the \acro{AFM} files and the Type~1 files to match the - \Qref*{Berry font naming scheme}{Q-fontname}. -\item Generate \TeX{} metric files from the \acro{AFM} files. The - commonest tool for this task is \Package{fontinst}; the package - documentation helps, but other guides are available (see below). - The simplest possible script to pass to \Package{fontinst} is: - \begin{quote} -\begin{verbatim} -\latinfamily{xyz}{} -\bye -\end{verbatim} - \end{quote} - where \texttt{xyz} is the Berry name of the font family. This - simple script is adequate for most purposes: its output covers the - font family in both \acro{T}1 and \acro{OT}1 font encodings. Nevertheless, - with fancier fonts, more elaborate things are possible with - \Package{fontinst}: see its documentation for details. - - \Package{Fontinst} also generates map files, and \LaTeX{} font - definition (\extension{fd}) files. -\end{itemize} -Having traversed this list, you have a set of font files ready for -installation. - -\Question[Q-instt1font]{Installing a Type~1 font} - -Once you have a prepared Type~1 font, either direct from \acro{CTAN} -or the like, or having \Qref*{`prepared' it yourself}{Q-prept1font}, -you can get on with installation. - -The procedure is merely an extension of that for packages, etc., so -much of what follows will be familiar: -\begin{itemize} -\item Install the files, in your \texttt{texmf} tree. All the - strictures about installing non-standard things apply here: be sure - to put the files in the local tree. The list gives reasonable - destinations for the various files related to a font family \meta{fname}: -\begin{verbatim} -.pfb, -.pfa .../fonts/type1/<foundry>/<fname> -.tfm .../fonts/tfm/<foundry>/<fname> -.vf .../fonts/vf/<foundry>/<fname> -.sty, -.fd .../tex/latex/<fname> -.map .../fonts/map/dvips/<foundry> -\end{verbatim} - but if you are lucky, you will be starting from a distribution from - \acro{CTAN} and can make use of the corresponding - \extension{tds.zip} file, and not care about how to place your files - in the \acro{TDS} tree. -\item Regenerate the file indexes (as described in - \Qref[question]{package installation}{Q-inst-wlcf}). -\item Update the \ProgName{dvips}, \PDFTeX{} and other maps: - \begin{itemize} - \item On any current \texlive{}-based system, or a te\TeX{} v3.0 - system, execute the command - \begin{quote} -\begin{verbatim} -updmap-sys --enable Map <fname>.map -\end{verbatim} - \end{quote} - as root. (You \emph{can} use plain \ProgName{updmap}, but you - will be in danger of creating confusion with different map sets - for different users thereby.) - \item On a current \miktex{} system, update the system file - \File{updmap.cfg}, using the shell command - \begin{quote} -\begin{verbatim} -initexmf --edit-config-file updmap -\end{verbatim} - \end{quote} - adding a line at the end: - \begin{quote} -\begin{verbatim} -Map <fname>.map -\end{verbatim} - \end{quote} - for each font family \meta{fname} you are adding to the system. - Now generate revised maps with the shell command - \begin{quote} -\begin{verbatim} -initexmf --mkmaps -\end{verbatim} - \end{quote} - This, and other matters, are described in \miktex{} % beware line break - \href{http://docs.miktex.org/manual/advanced.html}{''advanced'' documentation}. - \end{itemize} -\end{itemize} -Both processes (preparing and installing a font) are very well (and -thoroughly) described in Philipp Lehman's guide to font installation, -which may be found on \acro{CTAN}. -\begin{ctanrefs} -\item[fontinst.sty]\CTANref{fontinst} -\item[\nothtml{\rmfamily}Type 1 installation guide]\CTANref{T1instguide} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Fonts} - -\subsection{\MF{} fonts} - -\Question[Q-useMF]{Getting \MF{} to do what you want} - -\MF{} allows you to create your own fonts, and most \TeX{} users -will never need to use it~--- modern \AllTeX{} systems contain -rather few \MF{} fonts of any significance, and when \MF{} output is -needed the font generation is done, automatically, ``on the fly''. - -If you find you have some special requirement that the system doesn't -satisfy, you need to know about \MF{} in rather more detail. \MF{}, -unlike \TeX{}, requires customisation for each output device: such -customisation is conventionally held in a ``mode'' associated with the -device. Modes are commonly defined using the \texttt{mode\_def} -convention described on page~94 of \emph{The \MF{}book} % ! line break -(see \Qref[question]{\TeX{}-related books}{Q-books}). You will need -a file, conventionally called \File{local.mf}, containing all the -\texttt{mode\_def}s you will be using. In the unlikely event that -\File{local.mf} doesn't already exist, Karl Berry's collection of -modes (\File{modes.mf}) is a good starting point -(it can be used as a `\File{local.mf}' without modification in a -typical modern implementation of \MF{}). Lists of -settings for various output devices are also published periodically in -\textsl{TUGboat} (see \Qref[question]{\acro{TUG}}{Q-TUG*}). Now create -a \texttt{plain} base file using \ProgName{mf} (in ``initialisation'' -mode), \texttt{plain.mf}, and \texttt{local.mf}: -\begin{htmlversion} -\begin{quote} -\begin{verbatim} -% mf -ini -This is METAFONT... -**plain # you type plain -(output) -*input local # you type this -(output) -*dump # you type this -Beginning to dump on file plain... -(output) -\end{verbatim} -\end{quote} -\end{htmlversion} -\htmlignore -\begin{list}{}{}\item\relax - \texttt{\% mf -ini}\\ - This is METAFONT\dots{}\\{} - \fullline{**\texttt{plain}\hss you type `\texttt{plain}'} - (\emph{output})\\{} - \fullline{*\texttt{input local}\hss you type this} - (\emph{output})\\{} - \fullline{*\texttt{dump}\hss you type this} - Beginning to dump on file plain\dots{}\\{} - (\emph{output}) -\end{list}\par -\endhtmlignore -This will create a base file named \File{plain.base} -(or something similar; for example, it will be \File{PLAIN.BAS} -on \MSDOS{} systems). Move the file to the directory containing -the base files on your system. - -Now you need to make sure \MF{} loads this new base when it starts up. If -\MF{} loads the \texttt{plain} base by default on your system, then you're -ready to go. Under Unix (using the default \texlive{} (and earlier) -distributions this does indeed happen, but we could for instance -define a command \ProgName{plainmf}% -\begin{footnoteenv} - On the grounds that a command \ProgName{plain} could be misconstrued - as a reference to \plaintex{} -\end{footnoteenv} -which executes `\texttt{mf -base=plain}' (or, in more traditional -style `\texttt{mf \&plain}') which loads the \texttt{plain} base -file. - -The usual way to create a font with \MF{} (with an appropriate base -file loaded) is to start \MF{}'s input with the -\begin{narrowversion} - lines - \begin{quote} - \csx{mode}\texttt{=<mode name>;}\\ - \texttt{mag=<magnification>;}\\ - \texttt{input <font file name>} - \end{quote} -\end{narrowversion} -\begin{wideversion} -line -\begin{verbatim} -\mode=<mode name>; mag=<magnification>; input <font file name> -\end{verbatim} -\end{wideversion} -in response to the `\texttt{**}' prompt or on the \MF{} command line. (If -\texttt{<mode name>} is unknown or omitted, the mode defaults to -`proof' mode and \MF{} will produce an output file called % ! line break -\File{<font file name>.2602gf}) -The \texttt{<magnification>} is a floating point number or -`magstep' (magsteps are defined in \emph{The \MF{}book} and -\emph{The \TeX{}book}). -If \texttt{mag=<magnification>} is omitted, then the default -is 1~(magstep 0). For example, to generate cmr10 at 12pt for an Epson -printer you might type -\begin{quote} -\begin{verbatim} -mf \mode=epson; mag=magstep 1; input cmr10 -\end{verbatim} -\end{quote} -Note that under Unix the \texttt{\textbackslash } and \texttt{;} -characters must usually be quoted or escaped, so this would typically -look something like -\begin{quote} -\begin{verbatim} - mf '\mode=epson; mag=magstep 1; input cmr10' -\end{verbatim} -\end{quote} -If you need a special mode that isn't in the base, you can put its -commands in a file (\emph{e.g.}, \File{ln03.mf}) and invoke it on the -fly with the \csx{smode} command. For example, to create -\File{cmr10.300gf} for an \acro{LN}03 printer, using the file -\begin{quote} -\begin{verbatim} -% This is ln03.mf as of 1990/02/27 -% mode_def courtesy of John Sauter -proofing:=0; -fontmaking:=1; -tracingtitles:=0; -pixels_per_inch:=300; -blacker:=0.65; -fillin:=-0.1; -o_correction:=.5; -\end{verbatim} -\end{quote} -(note the absence of the \texttt{mode\_def} and \texttt{enddef} -commands), you would type -\begin{quote} -\begin{verbatim} -mf \smode="ln03"; input cmr10 -\end{verbatim} -\end{quote} -This technique isn't one you should regularly use, but it may -prove useful if you acquire a new printer and want to experiment with -parameters, or for some other reason are regularly editing the -parameters you're using. Once you've settled on an appropriate set of -parameters, you should use them to rebuild the base file that you use. - -Other sources of help are discussed in our list of % ! line break -\Qref*{\MF{} and \MP{} Tutorials}{Q-mfptutorials}. -\begin{ctanrefs} -\item[modes.mf]\CTANref{modes-file} -\end{ctanrefs} - -\Question[Q-keepfonts]{Which font files should be kept} - -\MF{} produces from its run three files, a metrics (\acro{TFM}) file, a -generic font (\acro{GF}) file, and a log file; all of these files have the -same base name as does the input (\emph{e.g.}, if the input file was -\File{cmr10.mf}, the outputs will be \File{cmr10.tfm}, -\File{cmr10.nnngf}% -\begin{footnoteenv} - Note that the file name may be transmuted by such operating systems - as \MSDOS{}, which don't permit long file names -\end{footnoteenv} -and \File{cmr10.log}). - -For \TeX{} to use the font, you need a \acro{TFM} file, so you need -to keep that. However, you are likely to generate the same font -at more than one magnification, and each time you do so you'll -(incidentally) generate another \acro{TFM} file; these files are -all the same, so you only need to keep one of them. - -To preview or to produce printed output, the \acro{DVI} processor will need a -font raster file; this is what the \acro{GF} file provides. However, while -there used (once upon a time) to be \acro{DVI} processors that could use -\acro{GF} files, modern processors use packed raster (\acro{PK}) files. -Therefore, you need to generate a \acro{PK} file from the \acro{GF} file; the -program \ProgName{gftopk} does this for you, and once you've done that you -may throw the \acro{GF} file away. - -The log file should never need to be used, unless there was some sort -of problem in the \MF{} run, and need not be ordinarily kept. - -\Question[Q-getbitmap]{Acquiring bitmap fonts} - -When \acro{CTAN} was young, most people would start using \TeX{} -with a 300 dots-per-inch (dpi) laser printer, and sets of Computer -Modern bitmap fonts for this resolution are available on \acro{CTAN}. -(There are separate sets for write-black and write-white printers, as -well as sets at 120~dpi and 240~dpi.) - -Over the years, there have been regular requests that \acro{CTAN} should hold -a wider range of resolutions, but they were resisted for two reasons: -\begin{itemize} -\item The need to decide which printers to generate fonts for. The - broad-brush approach taken for 300~dpi printers was (more or less) - justified back then, given the dominance of certain printer - `engines', but nowadays one could not make any such assumption. -\item Given the above, justifying the space taken up by a huge array - of bitmap fonts. -\end{itemize} -Fortunately, \AllTeX{} distribution technology has put a stop to these -arguments: most (if not all) current distributions generate bitmap -fonts as needed, and cache them for later re-use. The impatient -user, who is determined that all bitmap fonts should be created once -and for all, may be supported by scripts such as \ProgName{allcm} -(distributed with \texlive{}, at least; otherwise such a -person should consult ``\Qref*{the use of \MF{}}{Q-useMF})''. - -If your output is to a \PS{}-capable device, or if your output is -destined to be converted to \acro{PDF}, you should switch to -using Type~1 versions of the \acro{CM} fonts. Two free -sets are available; the older (\Package{bakoma}) is -somewhat less well produced than the \Package{bluesky} fonts, which were -originally professionally produced and sold, but were then donated to -the public domain by their originators \YandY{} and Bluesky Research, -in association with the \acro{AMS}. The two sets contain slightly -different ranges of fonts, but you are advised to use the -\Package{bluesky} set except when \Package{bakoma} is for some reason -absolutely unavoidable. In recent years, several other `\MF{}' fonts -have been converted to Type~1 format; it's common never to need to -generate bitmap fonts for any purpose other than previewing (see -% beware of line wrap -\Qref*{``previewing documents with Type~1 fonts''}{Q-PSpreview}), -if even then. - -More modern fonts may be used in place of the Computer Modern set. The -\Qref*{\acro{EC} fonts}{Q-ECfonts} and the % ! line break -\Qref*{Latin Modern fonts}{Q-uselmfonts} are both close relatives of -Computer Modern with wider ranges of glyphs to offer. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}BaKoMa fonts]\CTANref{bakoma} -\item[\nothtml{\rmfamily}Bluesky fonts]Browse \CTANref{bluesky} -\item[\nothtml{\rmfamily}CM fonts (write-black printers)]\CTANref{pk300} -\item[\nothtml{\rmfamily}CM fonts (write-white printers)]\CTANref{pk300w} -\item[\nothtml{\rmfamily}EC fonts (Type 1 format)]\CTANref{cm-super} -\item[\nothtml{\rmfamily}Latin Modern fonts]\CTANref{lm} -\end{ctanrefs} - -\subsection{Adobe Type~1 (``\PS{}'') fonts} - -\Question[Q-usepsfont]{Using \PS{} fonts with \protect\TeX{}} - -In order to use \PS{} fonts, \TeX{} needs -\emph{metric} (called \acro{TFM}) files. Several sets of metrics are -available from the archives; for mechanisms for generating new ones, -see \Qref[question]{metrics for \PS{} fonts}{Q-metrics}. You -also need the fonts themselves; \PS{} printers come with a set of -fonts built in, but to extend your repertoire you almost invariably -need to buy from one of the many commercial font vendors (see, for -example, \Qref[question]{``choice of fonts''}{Q-psfchoice}). - -If you use \LaTeXe{}, the best way to get \PS{} fonts into your -document is to use the \acro{PSNFSS} package maintained by Walter -Schmidt. The \LaTeX{}3 project team declare that \acro{PSNFSS} is -``required'', and bug reports may be submitted via the % line break -\Qref*{\LaTeX{} bugs system}{Q-latexbug}. -\acro{PSNFSS} gives you a set of packages for changing the default -roman, sans-serif and typewriter fonts; \emph{e.g}., the -\Package{mathptmx} package will set up \FontName{Times} -\FontName{Roman} as the main text font (and introduces mechanisms to -typeset mathematics using \FontName{Times} and various more-or-less -matching fonts), while package \Package{avant} changes the sans-serif -family to \FontName{AvantGarde}, and \Package{courier} changes the -typewriter font to \FontName{Courier}. To go with these -packages, you need the font metric files -and font description (\File{.fd}) files for each font family you -want to use. For convenience, -metrics for the `common 35' \PS{} fonts found in most \PS{} printers -are provided with \acro{PSNFSS}, packaged as the ``Laserwriter set''. - -For older versions of \LaTeX{} there are various schemes, of which the -simplest to use is probably the \acro{PS}\LaTeX{} macros distributed with -\ProgName{dvips}. - -For \plaintex{}, you load whatever fonts you like; if the encoding of -the fonts is not the same as Computer Modern it will be up to you to -redefine various macros and accents, or you can use the font -re-encoding mechanisms available in many drivers and in -\ProgName{ps2pk} and \ProgName{afm2tfm}. - -Victor Eijkhout's \Qref*{Lollipop package}{Q-lollipop} -supports declaration of font families and styles in a similar way to -\LaTeX{}'s \acro{NFSS}, and so is easy to use with \PS{} fonts. - -Some common problems encountered are discussed elsewhere -(see \Qref[question]{problems with \acro{PS} fonts}{Q-psfontprob}). -\begin{ctanrefs} -\item[Metrics for the `Laserwriter' set of 35 fonts]\CTANref{lw35nfss-zip} -\item[lollipop]\CTANref{lollipop} -\item[psnfss]\CTANref{psnfss} -\end{ctanrefs} - -\Question[Q-PSpreview]{Previewing files using Type 1 fonts} - -Until recently, free \TeX{} previewers have only been capable of -displaying bitmap \acro{PK} fonts, but current versions of -\ProgName{xdvi} sport a Type~1 font renderer. -%% \YandY{}'s commercial -%% previewer \Qref*{\acro{DVIW}indo}{Q-commercial} has in the past used -%% \ProgName{Adobe} \ProgName{Type} \ProgName{Manager} to display Type~1 -%% fonts directly and now uses the system-provided font renderer -%% available in Windows~2000 and~XP. - -Other (free) previewers of the current generation offer automatic -generation of the requisite \acro{PK} files (using \ProgName{gsftopk}, -or similar, behind the scenes). If your previewer isn't capable of -this, you have three options: -\begin{itemize} -\item Convert the \acro{DVI} file to \PS{} and use a - \PS{} previewer. Some systems offer this capability as - standard, but most people will need to use a separate previewer such - as \ProgName{ghostscript} or \ProgName{ghostscript}-based viewers - such as \ProgName{gv} or shareware offering \ProgName{GSview}. -\item Under Windows on a \acro{PC}, or on a Macintosh, let Adobe Type Manager - display the fonts (textures, on the Macintosh, works like this). -%% , and under -%% Windows you can use \YandY{}'s \ProgName{dviwindo} for bitmap-free -%% previewing. -\begin{narrowversion} % really hyper - (See \Qref[question]{}{Q-commercial} for details of these - suppliers.) -\end{narrowversion} -%\typeout{after narrowversion, before wideversion} -\begin{wideversion} - (See \Qref{commercial suppliers}{Q-commercial} for details.) -\end{wideversion} -%\typeout{after wideversion} -\item If you have the \PS{} fonts in Type~1 format, - use \ProgName{ps2pk} or \ProgName{gsftopk} - (designed for use with the \ProgName{ghostscript} fonts) to make - \acro{PK} bitmap fonts which your previewer - will understand. This can produce excellent results, also suitable - for printing with non-\PS{} devices. Check the legalities of - this if you have purchased the fonts. -\end{itemize} -\begin{ctanrefs} -\item[ghostscript]Browse \CTANref{ghostscript} -\item[gsftopk]\CTANref{gsftopk} -\item[GSview]Browse \CTANref{gsview} -\item[gv]Browse \CTANref{gv} -\item[ps2pk]\CTANref{ps2pk} -\item[xdvi]\CTANref{xdvi} -\end{ctanrefs} - -\Question[Q-metrics]{\protect\TeX{} font metric files for \PS{} fonts} - -Reputable font vendors such as Adobe supply metric files for each -font, in \acro{AFM} (Adobe Font Metric) form; these can be converted -to \acro{TFM} (\TeX{} Font Metric) form. Most modern distributions have -prebuilt metrics which will be more than enough for many people; but you may -need to do the conversion yourself if you have special needs or -acquire a new font. One important question is the \emph{encoding} of -(Latin character) fonts; while we all more or less agree about the -position of about 96 characters in fonts (the basic \acro{ASCII} set), the -rest of the (typically) 256 vary. The most obvious problems are with -floating accents and special characters such as the `pounds sterling' -sign. There are three ways of dealing with this: either you change the -\TeX{} macros which reference the characters (not much fun, and -error-prone); or you change the encoding of the font (easier than you -might think); or you use \Qref*{virtual fonts}{Q-virtualfonts} to -\emph{pretend} to \TeX{} that the encoding is the same as it is used to. -\LaTeXe{} has facilities for dealing with fonts in different -encodings; read the \Qref*{\emph{\LaTeX{} Companion}}{Q-books} for -more details. In practice, if you do much non-English (but Latin -script) typesetting, you are strongly recommended to use the -\Package{fontenc} package with option `\pkgoption{T1}' to select -\Qref*{`Cork'}{Q-ECfonts} encoding. -A useful alternative is \YandY{}'s ``private'' \acro{LY}1 encoding, -which is designed to sit well with ``Adobe standard'' encoded fonts. -Basic support of \acro{LY1} is available on \acro{CTAN}: note that the -``relation with Adobe's encoding'' means that there are no -virtual fonts in the \acro{LY}1 world. - -Alan Jeffrey's \ProgName{fontinst} package is an \acro{AFM} to -\acro{TFM} converter written in \TeX{}; it is used to generate the -files used by \LaTeXe{}'s \acro{PSNFSS} package to support use of -\PS{} fonts. It is a sophisticated package, not for the faint-hearted, -but is powerful enough to cope with most needs. Much of its power -relies on the use of \Qref*{virtual fonts}{Q-virtualfonts}. - -For slightly simpler problems, Rokicki's \ProgName{afm2tfm}, -distributed with \ProgName{dvips}, is fast and -efficient; note that the metrics and styles that come with -\ProgName{dvips} are \emph{not} currently \LaTeXe{} compatible. - -For the Macintosh (classic), there is a program called -\ProgName{EdMetrics} which does the job (and more). -\ProgName{EdMetrics} comes with the (commercial) -\Qref*{Textures}{Q-commercial} distribution, but is itself free -software, and is available on \acro{CTAN}. -%% \par -%% Windows users can buy \Qref*{\YandY{}'s}{Q-commercial} -%% Font Manipulation Tools package which includes a powerful -%% \ProgName{afmtotfm} program among many other goodies. -\begin{ctanrefs} -\item[dvips]\CTANref{dvips} -\item[EdMetrics]\CTANref{edmetrics} -\item[fontinst]\CTANref{fontinst} -\item[LY1 support]\CTANref{ly1} -\end{ctanrefs} - -\Question[Q-psfontprob]{Deploying Type 1 fonts} - -For the \LaTeX{} user trying to use the -\Qref*{\acro{PSNFSS}}{Q-usepsfont} package, three questions may arise. - -First, you have to declare to the \acro{DVI} driver that you are using -\PS{} fonts; in the case of \ProgName{dvips}, this means adding -lines to the \File{psfonts.map} file, so that \ProgName{dvips} will know -where the proper fonts are, and won't try to find \acro{PK} -files. If the font isn't built into the printer, you have to acquire -it (which may mean that you need to purchase the font files). - -Second, your previewer must know what to do with the fonts: see -\Qref[question]{previewing type 1 fonts}{Q-PSpreview}. - -Third, the stretch and shrink between words is a function of the -font metric; it is not specified in \acro{AFM} files, so different converters -choose different values. The \PS{} metrics that come with \acro{PSNFSS} -used to produce quite tight setting, but they were revised in mid 1995 -to produce a compromise between American and European practice. -Sophisticated users may not find even the new the values to their taste, and -want to override them. Even the casual user may find more -hyphenation or overfull boxes than Computer Modern produces; but \acro{CM} -is extremely generous. - -\Question[Q-psfchoice]{Choice of scalable outline fonts} - -If you are interested in text alone, you can in principle use any of -the huge numbers of text fonts in Adobe Type~1, TrueType or OpenType -formats. The constraint is, of course, that your previewer and -printer driver should support such fonts (\TeX{} itself \emph{only} -cares about metrics, not the actual character programs). - -If you also need mathematics, then you are severely limited by the -demands that \TeX{} makes of maths fonts (for details, see the papers -by -\begin{wideversion} -% !! line break !! - \href{http://tug.org/TUGboat/Articles/tb14-3/tb40horn.pdf}{B.K.P. Horn in \TUGboat{} 14(3)}, - or by % ! line break - \href{http://tug.org/TUGboat/Articles/tb19-2/tb59bouc.pdf}{Thierry Bouche in \TUGboat{} 19(2)}). -\end{wideversion} -\begin{narrowversion} - B.K.P. Horn in \TUGboat{} 14(3) or by Thierry Bouche in \TUGboat{} - 19(2), available as - \URL{http://tug.org/TUGboat/Articles/tb14-3/tb40horn.pdf} or - \URL{http://tug.org/TUGboat/Articles/tb19-2/tb59bouc.pdf}, respectively). -\end{narrowversion} -For mathematics, then, there are relatively few choices (though the list is -at last growing). There are several font families available that are -based on Knuth's original designs, and some that complement other -commercial text font designs; one set (MicroPress's `informal math') -stands alone. ``Free'' font families that will support \TeX{} -mathematics include: -\begin{booklist} -\item[Computer Modern](75 fonts~--- optical scaling) Donald E. Knuth\\ - The \acro{CM} fonts were originally designed in \MF{}, but are also - now available in scalable outline form. There are commercial as - well as public domain versions, and there are both Adobe Type~1 and - TrueType versions. A set of outline versions of the fonts was - developed as a commercial venture by \YandY{} and Blue Sky Research; - they have since assigned the copyright to the \acro{AMS}, and the - fonts are now freely available from \acro{CTAN}. Their quality is - such that they have become the \emph{de facto} standard for Type~1 - versions of the fonts. -\item[\acro{AMS} fonts](52 fonts, optical scaling) The \acro{AMS}\\ - This set of fonts offers adjuncts to the \acro{CM} set, including - two sets of symbol fonts (\FontName{msam} and \FontName{msbm}) and - Euler text fonts. - These are not a self-standing family, but merit discussion here (not - least because several other families mimic the symbol fonts). - Freely-available Type~1 versions of the fonts are available on - \acro{CTAN}. The \Package{eulervm} package permits use - of the Euler maths alphabet in conjunction with text fonts that do - not provide maths alphabets of their own (for instance, Adobe - Palatino or Minion). -\item[mathpazo version 1.003](5 fonts) Diego Puga\\ - The Pazo Math fonts are a family of type~1 fonts suitable for - typesetting maths in combination with the Palatino family of text - fonts. Four of the five fonts of the distribution are maths - alphabets, in upright and italic shapes, medium and bold weights; - the fifth font contains a small selection of ``blackboard bold'' - characters (chosen for their mathematical significance). Support - under \LaTeXe{} is available in - \Qref*{\acro{PSNFSS}}{Q-usepsfont}; the fonts are - licensed under the \acro{GPL}, with legalese permitting the use of - the fonts in published documents. -\item[Fourier/Utopia](15 fonts) Michel Bovani\\ - \FontName{Fourier} is a family built on Adobe \FontName{Utopia} - (which has been released for usage free of charge by Adobe). The - fonts provide the basic Computer Modern set of mathematical symbols, - and add many of the \acro{AMS} mathematical symbols (though you are - expected to use some from the \acro{AMS} fonts themselves). There - are also several other mathematical and decorative symbols. The - fonts come with a \Package{fourier} package for use with \LaTeX{}; - text support of \acro{OT}1 encoding is not provided~--- you are - expected to use \acro{T}1. - - For a sample, see \url{http://www.tug.dk/FontCatalogue/utopia/} -\item[Fourier/New Century Schoolbook]Michael Zedler\\ - \FontName{Fouriernc} is a configuration using the Fourier fonts in - the context of New Century Schoolbook text fonts. - - For a sample, see \url{http://www.tug.dk/FontCatalogue/newcent/} -\item[KP-fonts]The Johannes Kepler project\\ - The \FontName{kp-fonts} family provides a comprehensive set of text - and maths fonts. The set includes replacement fixed-width and sans - fonts (though some reports have suggested that these are less - successful, and their use may be suppressed when loading the fonts' - \Package{kpfonts} \LaTeX{} support package). - - For an example, see \url{http://www.tug.dk/FontCatalogue/kpserif/} -\item[MathDesign](4 entire families\dots{}so far) Paul Pichaureau\\ - This set so far offers mathematics fonts to match Adobe Utopia, URW - Garamond, Bitstream Charter (all of which are separately available, - on \acro{CTAN}, in Type~1 format) and Fontsite Garamond - (which is a commercial font, available from the % ! line wrap (twice) -\begin{wideversion} - \href{FontSite Web shop}{http://www.fontsite.com/Pages/FFDownloads.html}). -\end{wideversion} -\begin{narrowversion} - FontSite Web shop, \URL{http://www.fontsite.com/Pages/FFDownloads.html}). -\end{narrowversion} - There has been a little comment on these fonts, but none - from actual users posted to the public forums. Users, particularly - those who are willing to discuss their experiences, would obviously - be welcome. Browse the \acro{CTAN} directory and see which you - want: there is a wealth of documentation and examples. - - For samples of the free variants, see - \url{http://www.tug.dk/FontCatalogue/charter/} for URW Charter, - \url{http://www.tug.dk/FontCatalogue/garamond/} for URW Garamond and - \url{http://www.tug.dk/FontCatalogue/utopia-md/} for Adobe Utopia. -\item[Belleek](3 fonts) Richard Kinch\\ - Belleek is the upshot of Kinch's thoughts on how \MF{} might be used - in the future: they were published simultaneously as \MF{} source, - as Type~1 fonts, and as TrueType fonts. The fonts act as ``drop-in'' - replacements for the basic MathTime set (as an example of ``what might - be done''). - - The paper outlining Kinch's thoughts, proceeding from considerations - of the `intellectual' superiority of \MF{} to evaluations of why its - adoption is so limited and what might be done about the problem, is - to be found at \URL{http://truetex.com/belleek.pdf} (the paper is a - good read, but is set with Bitmap fonts, and can be difficult - on-screen in Acrobat reader 5 or earlier). -\item[mathptmx]Alan Jeffrey, Walter Schmidt and others.\\ - This set contains maths italic, symbol, extension, and roman virtual - fonts, built from Adobe Times, Symbol, Zapf Chancery, and the - Computer Modern fonts. The resulting mixture is not entirely - acceptable, but can pass in many circumstances. The real advantage - is that the mathptm fonts are (effectively) free, and the resulting - \PS{} files can be freely exchanged. Support under \LaTeXe{} - is available in \Qref*{\acro{PSNFSS}}{Q-usepsfont}. - - For a sample, see \url{http://www.tug.dk/FontCatalogue/times/} -\item[Computer Modern Bright]Free scalable outline versions of these - fonts do exist; they are covered below together with their - commercial parallels. -\end{booklist} -The excellent \emph{font catalogue} keeps an % ! line break -\href{http://www.tug.dk/FontCatalogue/mathfonts.html}{up-to-date list} -which describes the fonts by giving names and short examples, only. -(At the time of writing~--- June 2008~--- the list has several that -are only scheduled for inclusion here. - -Another useful document is Stephen Hartke's ``Free maths font -survey'', which is available on \acro{CTAN} in both \acro{PDF} and -\acro{HTML} formats. The survey covers most of the fonts mentioned in -the font catalogue, but also mentions some (such as \Package{Belleek} -that the catalogue omits. - -Fonts capable of setting \TeX{} mathematics, that are available -commercially, include: -\begin{booklist} -\item[BA Math](13 fonts) MicroPress Inc.\\ - BA Math is a family of serif fonts, inspired by the elegant - and graphically perfect font design of John Baskerville. BA - Math comprises the fonts necessary for mathematical typesetting - (maths italic, math symbols and extensions) in normal and bold - weights. The family also includes all \acro{OT}1 and \acro{T}1 - encoded text fonts of various shapes, as well as fonts with most - useful glyphs of the \acro{TS}1 encoding. Macros for using the - fonts with \plaintex{}, \LaTeXo{} and current \LaTeX{} are - provided. - - \nothtml{\bgroup\raggedwithindent} - For further details (including samples) see\\ - \URL{http://www.micropress-inc.com/fonts/bamath/bamain.htm} - \nothtml{\par\egroup} -\item[CH Math](15 fonts) MicroPress Inc.\\ - CH Math is a family of slab serif fonts, designed as a maths - companion for Bitstream Charter. (The distribution includes - four free Bitstream text fonts, in addition to the 15 hand-hinted - MicroPress fonts.) - \nothtml{\bgroup\raggedwithindent} - For further details (including samples) see\\ - \URL{http://www.micropress-inc.com/fonts/chmath/chmain.htm} - \nothtml{\par\egroup} -\item[Computer Modern Bright](62 fonts~--- optical scaling) Walter - Schmidt\\ - \acro{CM} Bright is a family of sans serif fonts, based on Knuth's - \acro{CM} fonts. It comprises the fonts necessary for mathematical - typesetting, including \acro{AMS} symbols, as well as text and text - symbol fonts of various shapes. The collection comes with its own - set of files for use with \LaTeX{}. The \acro{CM} Bright fonts are - supplied in Type~1 format by MicroPress, Inc. The - \Package{hfbright} bundle offers free Type~1 fonts for text using - the \acro{OT}1 encoding~--- the \Package{cm-super} fonts provide the - fonts in \acro{T}1 text encoding but don't support \acro{CM} bright - mathematics. - - \nothtml{\bgroup\raggedwithindent} - For further details of Micropress' offering (including samples) see\\ - \URL{http://www.micropress-inc.com/fonts/brmath/brmain.htm} - \nothtml{\par\egroup} -\item[Concrete Math](25 fonts~--- optical scaling) Ulrik Vieth\\ - The Concrete Math font set was derived from the Concrete Roman - typefaces designed by Knuth. The set provides a collection of math - italics, math symbol, and math extension fonts, and fonts of - \acro{AMS} symbols that fit with the Concrete set, so that Concrete - may be used as a complete replacement for Computer Modern. Since - Concrete is considerably darker than \acro{CM}, the family may - particularly attractive for use in low-resolution printing or in - applications such as posters or transparencies. Concrete Math - fonts, as well as Concrete Roman fonts, are supplied in Type 1 - format by MicroPress, Inc. - - \nothtml{\bgroup\raggedwithindent} - For further information (including samples) see\\ - \URL{http://www.micropress-inc.com/fonts/ccmath/ccmain.htm} - \nothtml{\par\egroup} -\item[HV Math](14 fonts) MicroPress Inc.\\ - HV Math is a family of sans serif fonts, inspired by the - Helvetica (\acro{TM}) typeface. HV Math comprises the fonts - necessary for mathematical typesetting (maths italic, maths symbols - and extensions) in normal and bold weights. The family also - includes all \acro{OT}1 and \acro{T}1 encoded text fonts of various - shapes, as well as fonts with most useful glyphs of the \acro{TS}1 - encoding. Macros for using the fonts with \plaintex{}, \LaTeXo{} - and current \LaTeX{} are provided. Bitmapped copies of the fonts - are available free, on \acro{CTAN}. - - \nothtml{\bgroup\raggedwithindent} - For further details (and samples) see\\ - \URL{http://www.micropress-inc.com/fonts/hvmath/hvmain.htm} - \nothtml{\par\egroup} -\item[Informal Math](7 outline fonts) MicroPress Inc.\\ - Informal Math is a family of fanciful fonts loosely based on the - Adobe's Tekton (\acro{TM}) family, fonts which imitate handwritten - text. Informal Math comprises the fonts necessary for - mathematical typesetting (maths italic, maths symbols and extensions) - in normal weight, as well as \acro{OT}1 encoded text fonts in - upright and oblique shapes. Macros for using the fonts with - \plaintex{}, \LaTeXo{} and current \LaTeX{} are provided. - - \nothtml{\bgroup\raggedwithindent} - For further details (including samples) see\\ - \URL{http://www.micropress-inc.com/fonts/ifmath/ifmain.htm} - \nothtml{\par\egroup} -\item[Lucida Bright \emph{with} Lucida New Math](25 fonts) Chuck Bigelow and - Kris Holmes\\ - Lucida is a family of related fonts including seriffed, sans serif, - sans serif fixed width, calligraphic, blackletter, fax, Kris Holmes' - connected handwriting font, \emph{etc}; they're not as `spindly' as - Computer Modern, with a large x-height, and include a larger set of - maths symbols, operators, relations and delimiters than \acro{CM} - (over 800 instead of 384: among others, it also includes the - \acro{AMS} \FontName{msam} and \FontName{msbm} symbol sets). `Lucida - Bright Expert' - (14 fonts) adds seriffed fixed width, another handwriting font, - smallcaps, bold maths, upright `maths italic', \emph{etc}., to the - set. Support under \LaTeX{} is available under the auspices of the - \acro{PSNFSS}, and pre-built metrics are also provided. - - \nothtml{\bgroup\raggedwithindent} - \acro{TUG} has the right to distribute these fonts; the web site -\begin{narrowversion} - \href{http://tug.org/lucida/}{``Lucida and TUG''} -\end{narrowversion} -\begin{wideversion} - ``\href{http://tug.org/lucida/}{Lucida and TUG}'' -\end{wideversion} - has details. - \nothtml{\par\egroup} -\item[Adobe Lucida, LucidaSans \emph{and} LucidaMath](12 fonts)\\ - Lucida and LucidaMath are generally considered to be a bit heavy. - The three maths fonts contain only the glyphs in the \acro{CM} maths - italic, symbol, and extension fonts. Support for using LucidaMath - with \TeX{} is not very good; you will need to do some work - reencoding fonts \emph{etc}. (In some sense this set is the - ancestor of the LucidaBright plus LucidaNewMath font set, which are - not currently available.) -\item[MathTime Pro2]Publish or Perish (Michael Spivak)\\ - This latest instance of the MathTime family covers all the weights - (medium, bold and heavy) and symbols of previous versions of - MathTime. In addition it has a much extended range of symbols, and - many typographic improvements that make for high-quality documents. - The fonts are supported under both \plaintex{} and \LaTeXe{}, and - are exclusively available for purchase from - \Qref*{Personal \TeX{} Inc}{Q-commercial}. - \par{} - \nothtml{\bgroup\raggedwithindent} - For further details and samples and fliers, see - \URL{http://www.pctex.com/mtpro2.html} - \nothtml{\par\egroup} -\item[Minion Pro and MnSymbol]Adobe, \LaTeX{} support and packaging by - Achim Blumensath \emph{et al}.\\ - \FontName{Minion Pro} derives from the widely-available commercial - OpenType font of the same name by Adobe; scripts are provided to - convert relevant parts of it to Adobe Type~1 format. The - \Package{MinionPro} package will set up text and maths support using - \FontName{Minion Pro}, but a separate (free) font set - \FontName{MnSymbol} greatly extends the symbol coverage. -\item[PA Math] PA~Math is a family of serif fonts - loosely based on the Palatino (\acro{TM}) typeface. PA~Math - comprises the fonts necessary for mathematical typesetting (maths - italics, maths, calligraphic and oldstyle symbols, and extensions) - in normal and bold weights. The family also includes all \acro{OT}1, - \acro{T}1 encoded text fonts of various shapes, as well as fonts - with the most useful glyphs of the \acro{TS}1 encoding. Macros for - using the fonts with \plaintex{}, \LaTeXo{} and current \LaTeX{} - are provided. - - \nothtml{\bgroup\raggedwithindent} - For further details (and samples) see\\ - \URL{http://www.micropress-inc.com/fonts/pamath/pamain.htm} - \nothtml{\par\egroup} -\item[TM Math](14 fonts) MicroPress Inc.\\ - TM Math is a family of serif fonts, inspired by the Times - (\acro{TM}) typeface. TM Math comprises the fonts necessary for - mathematical typesetting (maths italic, maths symbols and extensions) - in normal and bold weights. The family also includes all \acro{OT}1 - and \acro{T}1 encoded text fonts of various shapes, as well as fonts - with most useful glyphs of the \acro{TS}1 encoding. Macros for - using the fonts with \plaintex{}, \LaTeXo{} and current \LaTeX{} - are provided. Bitmapped copies of the fonts are available free, on - \acro{CTAN}. - - \nothtml{\bgroup\raggedwithindent} - For further details (and samples) see\\ - \URL{http://www.micropress-inc.com/fonts/tmmath/tmmain.htm} - \nothtml{\par\egroup} -\end{booklist} -Two other font sets should be mentioned, even though they don't -currently produce satisfactory output~--- their author is no longer -working on them, and several problems have been identified: -\begin{booklist} -\item[pxfonts set version 1.0](26 fonts) by Young Ryu\\ - The \FontName{pxfonts} set consists of - \begin{itemize} - \item virtual text fonts using \FontName{Adobe} \FontName{Palatino} (or the \acro{URW} - replacement used by \ProgName{ghostscript}) with modified plus, - equal and slash symbols; - \item maths alphabets using \FontName{Palatino}; - \item maths fonts of all symbols in the computer modern maths fonts - (\FontName{cmsy}, \FontName{cmmi}, \FontName{cmex} and the Greek - letters of \FontName{cmr}) - \item maths fonts of all symbols corresponding to the \acro{AMS} - fonts (\FontName{msam} and \FontName{msbm}); - \item additional maths fonts of various symbols. - \end{itemize} - The text fonts are available in \acro{OT}1, \acro{T}1 and \acro{LY}1 - encodings, and \acro{TS} encoded symbols are also available. The - sans serif and monospaced fonts supplied with the \FontName{txfonts} - set (see below) may be used with \FontName{pxfonts}; the - \FontName{txfonts} set should be installed whenever \FontName{pxfonts} - are. \LaTeX{}, \ProgName{dvips} and \PDFTeX{} support files are - included. -\begin{narrowversion} % really non-hyper version - Documentation - (\URL{http://www.tex.ac.uk/tex-archive/fonts/pxfonts/doc/pxfontsdocA4.pdf}) -\end{narrowversion} -\begin{wideversion} - \href{http://www.tex.ac.uk/tex-archive/fonts/pxfonts/doc/pxfontsdocA4.pdf}{Documentation} -\end{wideversion} - is readily available. - - The fonts are licensed under the \acro{GPL}; use in published - documents is permitted. -\item[txfonts set version 3.1](42 fonts) by Young Ryu\\ - The \FontName{txfonts} set consists of - \begin{itemize} - \item virtual text fonts using \FontName{Adobe} \FontName{Times} (or the \acro{URW} - replacement used by \ProgName{ghostscript}) with modified plus, - equal and slash symbols; - \item matching sets of sans serif and monospace (`typewriter') - fonts (the sans serif set is based on \FontName{Adobe} \FontName{Helvetica}); - \item maths alphabets using \FontName{Times}; - \item maths fonts of all symbols in the computer modern maths fonts - (\FontName{cmsy}, \FontName{cmmi}, \FontName{cmex} and the Greek letters of \FontName{cmr}) - \item maths fonts of all symbols corresponding to the \acro{AMS} - fonts (\FontName{msam} and \FontName{msbm}); - \item additional maths fonts of various symbols. - \end{itemize} - The text fonts are available in \acro{OT}1, \acro{T}1 and \acro{LY}1 - encodings, and \acro{TS} encoded symbols are also available. -\begin{narrowversion} % really non-hyper version - Documentation - (\URL{http://www.tex.ac.uk/tex-archive/fonts/txfonts/doc/txfontsdocA4.pdf}) -\end{narrowversion} -\begin{wideversion} - \href{http://www.tex.ac.uk/tex-archive/fonts/txfonts/doc/txfontsdocA4.pdf}{Documentation} -\end{wideversion} - is readily available. - - The fonts are licensed under the \acro{GPL}; use in published - documents is permitted. -\end{booklist} -Finally, one must not forget: -\begin{booklist} -\item[Proprietary fonts]Various sources.\\ - Since having a high quality font set in scalable outline form that - works with \TeX{} can give a publisher a real competitive advantage, - there are some publishers that have paid (a lot) to have such font - sets made for them. Unfortunately, these sets are not available on - the open market, despite the likelihood that they're more complete - than those that are. -\end{booklist} -We observe a very limited selection of commercial maths font sets; a -maths font has to be explicitly designed for use with \TeX{}, which is -an expensive business, and is of little appeal in other markets. -Furthermore, the \TeX{} market for commercial fonts is minute by -comparison with the huge sales of other font sets. - -Text fonts in Type~1 format are available from many vendors including -Adobe, Monotype and Bitstream. However, be careful with cheap font -``collections''; many of them dodge copyright restrictions by removing -(or crippling) parts of the font programs such as hinting. Such -behaviour is both unethical and bad for the consumer. -The fonts may not render well (or at all, under \acro{ATM}), may not have the -`standard' complement of 228 glyphs, or may not include metric files -(which you need to make \acro{TFM} files). - -TrueType remains the ``native'' format for Windows. Some \TeX{} -implementations such as \Qref*{True\TeX{}}{Q-commercial} use TrueType -versions of Computer Modern and Times Maths fonts to render \TeX{} -documents in Windows without the need for additional system software like -\acro{ATM}. (When used on a system running Windows~XP, True\TeX{} can -also use Type~1 fonts.) - -When choosing fonts, your own system environment may not be the only one of -interest. If you will be sending your finished documents to others for -further use, you should consider whether a given font format will introduce -compatibility problems. Publishers may require TrueType exclusively because -their systems are Windows-based, or Type~1 exclusively, because their systems -are based on the early popularity of that format in the publishing industry. -Many service bureaus don't care as long as you present them with a finished -print file (\PS{} or \acro{PDF}) for their output device. -\begin{ctanrefs} -\item[CM \nothtml{\normalfont}family collection]% - Browse \CTANref{cm-AMStype1} -\item[AMS \nothtml{\normalfont}font collection]% - Browse \CTANref{ams-AMStype1} -\item[Belleek \nothtml{\normalfont}fonts]% - \CTANref{belleek} -\item[CM-super \nothtml{\normalfont}collection]\CTANref{cm-super} -\item[eulervm.sty \nothtml{\normalfont}and supporting metrics]% - \CTANref{eulervm} -\item[fourier \nothtml{\normalfont}(including metrics and other support for \nothtml{\itshape}utopia]% - \CTANref{fourier} -\item[fouriernc]\CTANref{fouriernc} -\item[hfbright \nothtml{\normalfont}collection]\CTANref{hfbright} -\item[hvmath \nothtml{\normalfont\itshape}(free bitmapped version)]% - \CTANref{hvmath} -\item[kpfonts \nothtml{\normalfont}family]\CTANref{kpfonts} -\item[Lucida Bright/Math metrics]\CTANref{lucida} -\item[Lucida PSNFSS support]\CTANref{lucida-psnfss} -\item[MathDesign \nothtml{\normalfont}collection]\CTANref{mathdesign} -\item[\nothtml{\normalfont}Maths Font Survey]\CTANref{mathsurvey.pdf} - (\acro{PDF}) or \CTANref{mathsurvey.html} (\acro{HTML}) -\item[Minion Pro support]\CTANref{minionpro} -\item[MnSymbol \nothtml{\normalfont}family]\CTANref{mnsymbol} -\item[pxfonts]\CTANref{pxfonts} -\item[tmmath \nothtml{\normalfont\itshape}(free bitmapped version)]% - \CTANref{tmmath} -\item[txfonts]\CTANref{txfonts} -\item[utopia \nothtml{\normalfont}fonts]\CTANref{utopia} -\end{ctanrefs} - -\Question[Q-charshift]{Weird characters in \ProgName{dvips} output} -\keywords{fi ligature pound pounds sterling elephants} - -You've innocently generated output, using \ProgName{dvips}, and there -are weird transpositions in it: for example, the \texttt{fi} ligature has -appeared as a \textsterling{} symbol. -This is an unwanted side-effect of the precautions -outlined in \Qref*{generating \PS{} for PDF}{Q-dvips-pdf}. -The \texttt{-G1} switch discussed in that question is appropriate for -Knuth's text fonts, but doesn't work with text fonts that don't follow -Knuth's patterns (such as fonts supplied by Adobe). - -If the problem arises, suppress the \texttt{-G1} switch: if you were using it -explicitly, \emph{don't}; if you were using \texttt{-Ppdf}, add \texttt{-G0} to -suppress the implicit switch in the pseudo-printer file. - -The problem has been corrected in \ProgName{dvips} v~5.90 (and later -versions), which should be available in any recent \TeX{} distribution. - -\subsection{Macros for using fonts} - -\Question[Q-fonts-pln]{Using non-standard fonts in \plaintex{}} - -\plaintex{} (in accordance with its description) doesn't do anything -fancy with fonts: it sets up the fonts that Knuth found he needed when -writing the package, and leaves you to do the rest. - -To use something other than Knuth's default, the default mechanism is -to use the \csx{font} primitive: -\begin{quote} -\begin{verbatim} -\font\foo=nonstdfont -... -\foo -Text set using nonstdfont ... -\end{verbatim} -\end{quote} -The name you use (\texttt{nonstdfont}, above) is the name of the -\extension{tfm} file for the font you want. - -If you want to use an italic version of \csx{foo}, you need to use -\csx{font} again: -\begin{quote} -\begin{verbatim} -\font\fooi=nonstdfont-italic -... -\fooi -Text set using nonstdfont italic... -\end{verbatim} -\end{quote} -This is all very elementary stuff, and serves for simple use of fonts. -However, there are wrinkles, the most important of which is the matter -of \Qref*{font encodings}{Q-whatenc}. Unfortunately, many fonts that -have appeared recently simply don't come in versions using Knuth's -eccentric font encodings~--- but those encodings are built into -\plaintex{}, so that some macros of \plaintex{} need to be changed to -use the fonts. \LaTeX{} gets around all these problems by using a -``font selection scheme''~--- this `\acro{NFSS}' (`\acro{N}' for -`new', as opposed to what \LaTeXo{} had) carries around with it -separate information about the fonts you use, so the changes to -encoding-specific commands happen automagically. - -If you only want to use the \Qref*{\acro{EC} fonts}{Q-ECfonts}, you -can in principle use the \Package{ec-plain} bundle, which gives you a version -of \plaintex{} which you can run in the same way that you run -\plaintex{} using the original \acro{CM} fonts, by invoking -\ProgName{tex}. (\Package{Ec-plain} also extends the \acro{EC} fonts, -for reasons which aren't immediately clear, but which might cause -problems if you're hoping to use Type 1 versions of the fonts.) - -The \Package{font_selection} package provides a sort of halfway house: -it provides font face and size, but not family selection. This gives -you considerable freedom, but leaves you stuck with the original -\acro{CM} fonts. It's a compact solution, within its restrictions. - -Other \plaintex{} approaches to the problem (packages -\Package{plnfss}, \Package{fontch} and \Package{ofs}) break out of the -\plaintex{} model, towards the sort of font selection provided by -\CONTeXT{} and \LaTeX{}~--- font selection that allows you to change -family, as well as size and face. The remaining packages all make -provision for using encodings other than Knuth's \acro{OT}1. - -\Package{Plnfss} has a rather basic set of font family details; -however, it is capable of using font description (\extension{fd}) files -created for \LaTeX{}. (This is useful, since most modern mechanisms -for integrating outline fonts with \TeX{} generate \extension{fd} files -in their process.) - -\Package{Fontch} has special provision for \acro{T}1 and \acro{TS}1 -encodings, which you select by arcane commands, such as: -\begin{quote} -\begin{verbatim} -\let\LMTone\relax -\input fontch.tex -\end{verbatim} -\end{quote} -for \acro{T}1. - -\Package{Ofs} seems to be the most thoroughly thought-through of the -alternatives, and can select more than one encoding: as well as -\acro{T}1 it covers the encoding \acro{IL}2, which is favoured in the -Czech Republic and Slovakia. \Package{Ofs} also covers mathematical fonts, -allowing you the dubious pleasure of using fonts such as the % ! line break -\Qref*{\FontName{pxfonts} and \FontName{txfonts}}{Q-psfchoice}. - -The \Package{pdcmac} \plaintex{} macro package aims to be a complete -document preparation environment, like \Qref*{\Eplain{}}{Q-eplain}. One -of its components is a font selection scheme, \Package{pdcfsel}, which -is rather simple but adequately powerful for many uses. The package -doesn't preload fonts: the user is required to declare the fonts the -document is going to use, and the package provides commands to select -fonts as they're needed. The distribution includes a configuration to -use Adobe `standard' fonts for typesetting text. (\Eplain{} itself -seems not to offer a font selection scheme.) - -Simply to change font \emph{size} in a document (i.e., not changing -the default font itself), may be done using the rather straightforward -\Package{varisize}, which offers font sizes ranging from 7~points to -20~points (nominal sizes, all). Font size commands are generated when -any of the package files is loaded, so the \File{11pt.tex} defines a -command \csx{elevenpoint}; each of the files ensures there's a ``way -back'', by defining a \csx{tenpoint} command. -\begin{ctanrefs} -\item[ec-plain]\CTANref{ec-plain} -\item[fontch]\CTANref{fontch} -\item[font_selection]\CTANref{font_selection} -\item[ofs]\CTANref{ofs} -\item[pdcmac]\CTANref{pdcmac} -\item[plnfss]\CTANref{plnfss} -\item[varisize]\CTANref{varisize} -\end{ctanrefs} - -\subsection{Particular font families} - -\Question[Q-concrete]{Using the ``Concrete'' fonts} - -The Concrete Roman fonts were designed by Don Knuth for a book called -``Concrete Mathematics'', which he wrote with Graham and Patashnik -(\emph{the} Patashnik, of \BibTeX{} fame). Knuth -only designed text fonts, since the book used the Euler fonts for -mathematics. The book was typeset using \plaintex{}, of course, with -additional macros that may be viewed in a file \File{gkpmac.tex}, -which is available on \acro{CTAN}. - -The packages \Package{beton}, \Package{concmath}, and -\Package{ccfonts} are \LaTeX{} packages that change the default text -fonts from Computer Modern to Concrete. Packages \Package{beton} and -\Package{ccfonts} also slightly increase the default value of -\csx{baselineskip} to account for the rather heavier weight of the -Concrete fonts. If you wish to use the \FontName{Euler} fonts for -mathematics, as Knuth did, there's the \Package{euler} package which -has been developed from Knuth's own \plaintex{}-based set: these -macros are currently deprecated (they clash with many things, including -\AMSLaTeX{}). The independently-developed \Package{eulervm} -bundle is therefore preferred to the \Package{euler} package. (Note -that installing the \Package{eulervm} bundle involves installing a -series of virtual fonts. While most modern distributions seem to have -the requisite files installed by default, you may find you have to -install them. If so, see the file \File{readme} in the -\Package{eulervm} distribution.) - -A few years after Knuth's original design, Ulrik Vieth -designed the Concrete Math fonts. Packages -\Package{concmath}, and \Package{ccfonts} also change the default math -fonts from Computer Modern to Concrete and use the Concrete versions -of the \acro{AMS} fonts (this last behaviour is optional in the case -of the \Package{concmath} package). - -There are no bold Concrete fonts, but it is generally accepted that -the Computer Modern Sans Serif demibold condensed fonts are an -adequate substitute. If you are using \Package{concmath} or -\Package{ccfonts} and you want to follow this suggestion, then use the -package with \pkgoption{boldsans} class option (in spite of the fact -that the \Package{concmath} documentation calls it -\pkgoption{sansbold} class option). If you are using \Package{beton}, -add -\begin{quote} - \cmdinvoke{renewcommand}{\csx{bfdefault}}{sbc} -\end{quote} -to the preamble of your document. - -Type~1 versions of the fonts are available. For \acro{OT}1 encoding, -they are available from \Qref*{MicroPress}{Q-psfchoice}. The -\Qref*{CM-Super fonts}{Q-textrace} contain Type~1 versions -of the Concrete fonts in \acro{T}1 encoding. -\begin{ctanrefs} -\item[beton.sty]\CTANref{beton} -\item[ccfonts.sty]\CTANref{ccfonts} -\item[\nothtml{\rmfamily}CM-Super fonts]\CTANref{cm-super} -\item[concmath.sty]\CTANref{concmath} -\item[\nothtml{\rmfamily}Concmath fonts]\CTANref{concmath-f} -\item[\nothtml{\rmfamily}Concrete fonts]\CTANref{concrete} -\item[euler.sty]\CTANref{euler-latex} -\item[eulervm \nothtml{\rmfamily}bundle]\CTANref{eulervm} -\item[gkpmac.tex]\CTANref{gkpmac} -\end{ctanrefs} - -\Question[Q-uselmfonts]{Using the Latin Modern fonts} - -The \Package{lm} fonts are an exciting addition to -the armoury of the \AllTeX{} user: high quality outlines of fonts that -were until recently difficult to obtain, all in a free and -relatively compact package. However, the spartan information file -that comes with the fonts remarks ``It is presumed that a potential -user knows what to do with all these files''. This answer aims to -fill in the requirements: the job is really not terribly difficult. - -Note that te\TeX{} distributions, from version~3.0, already have the -\Package{lm} fonts: all you need do is use them. The fonts may also -be installed via the package manager, in a current \miktex{} system. -The remainder of this answer, then, is for people who don't use such -systems. - -The font (and related) files appear on \acro{CTAN} as a set of -single-entry \Qref*{\acro{TDS} trees}{Q-tds}~--- -\File{fonts}, \File{dvips}, \File{tex} and \File{doc}. The \File{doc} -subtree really need not be copied (it's really a pair of sample -files), but copy the other three into your existing Local -\texttt{\$TEXMF} tree, and -% beware line break -\Qref*{update the filename database}{Q-inst-wlcf}. - -Now, incorporate the fonts in the set searched by \PDFLaTeX{}, -\ProgName{dvips}, \ProgName{dvipdfm}/\ProgName{dvipdfmx}, your -previewers and Type~1-to-\acro{PK} conversion programs, by -\begin{itemize} -\item On a te\TeX{} system earlier than version~2.0, edit the file - \File{$TEXMF/dvips/config/updmap} and insert an absolute path for - the \File{lm.map} just after the line that starts - \texttt{extra\_modules="} (and before the closing quotes). -\item On a te\TeX{} version~2.0 (or later), execute the command -\begin{verbatim} - updmap --enable Map lm.map -\end{verbatim} -\item On a \miktex{} system earlier than version~2.2, the ``Refresh - filename database'' operation, which you performed after installing - files, also updates the system's ``\PS{} resources database''. -\item On a \miktex{} system, version~2.2 or later, update - \File{updmap.cfg} as described in the \miktex{} % beware line break - \href{http://docs.miktex.org/manual/psfonts.html#chgupdmapcfg}{online documentation}. - Then execute the command \texttt{initexmf -\relax-mkmaps}, and the - job is done. -\end{itemize} - -To use the fonts in a \LaTeX{} document, you should -\begin{quote} - \cmdinvoke{usepackage}{lmodern} -\end{quote} -this will make the fonts the default -for all three \LaTeX{} font families (``roman'', ``sans-serif'' and -``typewriter''). You also need -\begin{quote} - \cmdinvoke{usepackage}[T1]{fontenc} -\end{quote} -for text, and -\begin{quote} - \cmdinvoke{usepackage}{textcomp} -\end{quote} -if you want to use any of the \acro{TS}1-encoding symbols. There is -no support for using fonts according to the \acro{OT}1 encoding. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Latin Modern fonts]\CTANref{lm} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Hypertext and \acro{PDF}} - -\Question[Q-hyper]{Making hypertext documents from \TeX{}} - -If you want on-line hypertext with a \AllTeX{} source, probably on the -World Wide Web, there are four technologies to consider: -\begin{itemize} -\item Direct \Qref{\AllTeX{} conversion to \acro{HTML}}{Q-LaTeX2HTML}; -% beware line break -\item Use \Qref*{\Package{Texinfo}}{Q-texinfo}, - and use the \ProgName{info} viewer, or convert the \Package{texinfo} - to \acro{HTML}; -\item Use Adobe Acrobat, which will preserve your typesetting - perfectly - \Qref*{Making Acrobat \acro{PDF} documents from \LaTeX{}}{Q-acrobat}; -\item The hyper\TeX{} conventions (standardised \csx{special} - commands); there are supporting macro packages for \plaintex{} and - \LaTeX{}). -\end{itemize} - -The Hyper\TeX{} project extended the functionality of all the -\LaTeX{} cross-referencing commands (including the table of contents) -to produce \csx{special} commands which are parsed by \acro{DVI} processors -conforming to the Hyper\TeX{} guidelines; -it provides general hypertext links, including those -to external documents. - -The Hyper\TeX{} specification says that conformant viewers/translators -must recognize the following set of \csx{special} commands: -\begin{description} -\item[href:] |html:<a href = "href_string">| -\item[name:] |html:<a name = "name_string">| -\item[end:] |html:</a>| -\item[image:] |html:<img src = "href_string">| -\item[base\_name:] |html:<base href = "href_string">| -\end{description} - -The \emph{href}, \emph{name} and \emph{end} commands are used to do -the basic hypertext operations of establishing links between sections -of documents. - -Further details are available on \URL{http://arXiv.org/hypertex/}; there -are two commonly-used implementations of the specification, a -modified \ProgName{xdvi} and (recent releases of) -\ProgName{dvips}. Output from the latter may be used in recent -releases of \ProgName{ghostscript} or Acrobat Distiller. - -\Question[Q-acrobat]{Making Acrobat \acro{PDF} documents from \AllTeX{}} - -There are three general routes to \acro{PDF} output: Adobe's original -`distillation' route (via \PS{} output), conversion of a -\acro{DVI} file, and the use of a direct \acro{PDF} generator such as -\Qref*{\PDFTeX{}}{Q-whatpdftex}) or -MicroPress's V\TeX{} (which comes both as a % ! line break -\Qref*{commercial version}{Q-commercial} for Windows PCs, and as a -\Qref*{`free' version)}{Q-TeXsystems} for \acro{OS}/2 and Linux systems). - -For simple documents (with no hyper-references), you can either -\begin{itemize} -\item process the document in the normal way, produce \PS{} - output and distill it; -\item (on a Windows or Macintosh machine with the appropriate Adobe - tools installed) pass the output through the - \acro{PDF}writer in place of a printer driver (this route is a dead - end: the \acro{PDF}writer cannot create hyperlinks); -\item process the document in the normal way and generate \acro{PDF} - direct from the \acro{DVI} using - \ProgName{dvipdfm}/\ProgName{dvipdfmx}; or -\item process the document direct to \acro{PDF} with \PDFTeX{} or - V\TeX{}. \PDFTeX{} has - the advantage of availability for a wide range of platforms, V\TeX{} - (available commercially for Windows, or free of charge, but - unsupported, for Linux or \acro{OS/}2) has wider graphics - capability, dealing with encapsulated \PS{} and some in-line \PS{}. -\end{itemize} - -To translate all the \LaTeX{} cross-referencing into Acrobat -links, you need a \LaTeX{} package to suitably redefine -the internal commands. There are two of these for \LaTeX{}, both -capable of conforming to the -\Qref{Hyper\TeX{} specification}{Q-hyper}: -Heiko Oberdiek's \Package{hyperref}, and Michael Mehlich's -\Package{hyper}. (In practice, almost everyone uses -\Package{hyperref}; \Package{hyper} hasn't been updated since 2000.) -\Package{Hyperref} can often determine how it should generate -hypertext from its environment, but there is a wide set of -configuration options you can give via \csx{usepackage}. The package -can operate using \PDFTeX{} primitives, the hyper\TeX{} -\csx{special}s, or \acro{DVI} driver-specific \csx{special} commands. -Both \ProgName{dvips} and \YandY{}'s \acro{\ProgName{DVIPSONE}} can -translate the \acro{DVI} with these \csx{special} commands into -\PS{} acceptable to Distiller, and -\ProgName{dvipdfm} and \ProgName{dvipdfmx} have \csx{special} commands of -its own. - -If you use \plaintex{}, the \Qref*{\Eplain{} macros}{Q-eplain} can -help you create \acro{PDF} documents with hyper-references. -It can operate using \PDFTeX{} primitives, or \csx{special} commands -for the \ProgName{dvipdfm}/\ProgName{dvipdfmx} \acro{DVI} drivers. - -While there is no free implementation of all of \ProgName{Adobe} -\ProgName{Distiller}'s -functionality, any but the very oldest versions of \ProgName{Ghostscript} -provide pretty reliable distillation (but beware of the problems with -\Qref*{\ProgName{dvips} output for distillation}{Q-dvips-pdf}). - -For viewing (and printing) the resulting files, Adobe's -\ProgName{Acrobat} \ProgName{Reader} is available for a fair range of -platforms; for those for which Adobe's reader is unavailable, remotely -current versions of \ProgName{ghostscript} combined with -\ProgName{gv} or \ProgName{GSview} can display and print \acro{PDF} -files, as can \ProgName{xpdf}. - -In many circumstances, \ProgName{Ghostscript} combined with a viewer -application is actually preferable to Acrobat Reader. For example, on -Windows Acrobat Reader locks the \extension{pdf} file it's displaying: this -makes the traditional (and highly effective) \AllTeX{} development -cycle of ``Edit\arrowhyph{}Process\arrowhyph{}Preview'' become -rather clumsy~--- \ProgName{GSview} doesn't make the same -mistake. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Acrobat Reader]browse - \URL{ftp://ftp.adobe.com/pub/adobe/acrobatreader} -\item[dvipdfm]\CTANref{dvipdfm} -\item[dvipdfmx]\CTANref{dvipdfmx} -\item[ghostscript]Browse \CTANref{ghostscript} -\item[GSview]Browse \CTANref{gsview} -\item[gv]Browse \CTANref{gv} -\item[hyper.sty]\CTANref{hyper} -\item[hyperref.sty]\CTANref{hyperref} -\end{ctanrefs} - -\Question[Q-dvips-pdf]{Quality of \acro{PDF} from \PS{}} -\keywords{blurry fuzzy crippled} - -Any reasonable \PS{}, including any output of \ProgName{dvips}, may be -converted to \acro{PDF}, using (for example) a sufficiently recent -version of \ProgName{ghostscript}, Frank Siegert's (shareware) -\href{http://www.pstill.com/}{\ProgName{PStill}}, or Adobe's (commercial) -\ProgName{Distiller}. - -But, although the job may (almost always) be done, the results are -often not acceptable: the most frequent problem is bad presentation of -the character glyphs that make up the document. The following answers -offer solutions to this (and other) problems of bad presentation. -Issues covered are: -\begin{itemize} -\item \Qref*{Wrong type of fonts used}{Q-fuzzy-type3}, which is - the commonest cause of fuzzy text. -\item \Qref*{\ProgName{Ghostscript} too old}{Q-fuzzy-gs}, - which can also result in fuzzy text. -% beware line breaks -\item \Qref*{Switching to font encoding \acro{T}1 encoding}{Q-fuzzy-T1}, - which is yet another possible cause of fuzzy text. -\item Another problem~--- missing characters~--- arises from an - % beware line breaks - \Qref*{aged version of \ProgName{Adobe}~\ProgName{Distiller}}{Q-distill-prob}. -\item Finally, there's the common confusion that arises from using the - \ProgName{dvips} configuration file \texttt{-Ppdf}, the % ! line br - \Qref*{weird characters}{Q-charshift}. -\end{itemize} -It should be noted that \ProgName{Adobe} % \ProgName{Acrobat} no longer - % part of the name -\ProgName{Reader}~6 (released in mid-2003, and later versions) does -not exhibit the ``fuzziness'' that so many of the answers below -address. This is of course good news: however, it will inevitably be -a long time before every user in the world has this (or later) -versions, so the remedies below are going to remain for some time to -come. - -The problems are also discussed, with practical examples, in Mike -Shell's \Package{testflow} package, which these FAQs recommend as a -``\Qref*{specialised tutorial}{Q-tutbitslatex}. -\begin{ctanrefs} -\item[testflow]\CTANref{testflow} -\end{ctanrefs} - -\Question[Q-fuzzy-type3]{The wrong type of fonts in \acro{PDF}} -\keywords{crippled blurry} - -This is far the commonest problem: the symptom is that text in the -document looks ``fuzzy''. - -Most people use \ProgName{Adobe} \ProgName{Acrobat} \ProgName{Reader} -to view their \acro{PDF}: \ProgName{Reader} is distributed free of -charge, and is widely available, for all its faults. One of those -faults is its failure to deal with bitmap fonts (at least, in all -versions earlier than the recently released version~6). - -So we don't want bitmap fonts in our \PS{}: with them, characters show -up in \ProgName{Reader}'s display as blurred blobs which are often not -recognisable as the original letter, and are often not properly placed -on the line. Nevertheless, even now, most \TeX{} systems have -\ProgName{dvips} configured to use -\Qref*{\extension{pk} files}{Q-pk} in its output. Even -\PDFTeX{} will use \extension{pk} files if it can see no alternative for -a font in the document it is processing. - -Our remedy is to use -``\Qref*{Adobe Type~1}{Q-adobetypen}'' -versions of the fonts we need. Since Adobe are in the -business of selling Type~1 fonts, \ProgName{Reader} was of course made -to deal with them really rather well, from the very beginning. - -Of course, if your document uses nothing but fonts that came from -Adobe in the first place~--- fonts such as \FontName{Times} that -appear in pretty much every \PS{} printer, or such as Adobe -\FontName{Sabon} that you pay extra for~--- then there's no problem. - -But most people use \FontName{Computer} \FontName{Modern} to start -with, and even those relative sophisticates who use something as -exotic as \ProgName{Sabon} often find themselves using odd characters -from \acro{CM} without really intending to do so. Fortunately, rather -good versions of the \acro{CM} fonts are available from the \acro{AMS} -(who have them courtesy of % ! line break -\Qref{Blue Sky Research}{Q-commercial} and \YandY{}). - -Most modern systems have the fonts installed ready to use; and any -system installed less than 3~years ago has a \ProgName{dvips} -configuration file `\texttt{pdf}' that signals the use of the -\acro{CM} fonts, and also sets a few other parameters to improve -\ProgName{dvips}' output. Use this configuration as: -\begin{verbatim} - dvips -Ppdf myfile -o myfile.ps -\end{verbatim} -This may produce a warning message about failing to find the -configuration file: -\begin{verbatim} - dvips: warning: no config file for `pdf' -\end{verbatim} -or something similar, or about failing to find a font file: -\begin{verbatim} - dvips: ! Couldn't find header file cmr10.pfb -\end{verbatim} -Either of these failures signals that your -system doesn't have the fonts in the first place. - -A way of using the fonts that doesn't involve the sophistication of -the \texttt{-Ppdf} mechanism is simply to load maps: -\begin{verbatim} - dvips -Pcmz -Pamz myfile -o myfile.ps -\end{verbatim} -You may encounter the same warning messages as listed above. - -If your system does not have the fonts, it won't have the -configuration file either; however, it might have the configuration -file without the fonts. In either case, you need to -\Qref*{install the fonts}{Q-inst1cm}. - -\Question[Q-fuzzy-gs]{Fuzzy fonts because \ProgName{Ghostscript} too old} -\keywords{crippled blurry} - -So you've done everything the \acro{FAQ} has told you that you need, -correct fonts properly installed and appearing in the \ProgName{dvips} -output, but \emph{still} you get fuzzy character output after -distilling with \ProgName{ghostscript}. - -The problem could arise from too old a version of -\ProgName{ghostscript}, which you may be using directly, or via a -script such as \ProgName{ps2pdf} (distributed with -\ProgName{ghostscript} itself), \ProgName{dvipdf}, or similar. -Though \ProgName{ghostscript} was capable of distillation from -version~5.50, that version could only produce bitmap Type~3 output of -any font other than the fundamental 35~fonts (\FontName{Times}, -\FontName{Helvetica}, etc.). Later versions added `complete' -distillation, but it wasn't until version~6.50 that one could rely on -it for everyday work. - -So, if your \acro{PDF} output still looks fuzzy in \ProgName{Acrobat} -\ProgName{Reader}, upgrade \ProgName{ghostscript}. The new version -should be at least version~6.50, of course, but it's usually good -policy to go to the most recent version (version~8.12 at the time of -writing~--- 2003). - -\Question[Q-fuzzy-T1]{Fonts go fuzzy when you switch to \acro{T}1} -\keywords{crippled blurry} - -You've been having problems with hyphenation, and someone has -suggested that you should use ``\cmdinvoke{usepackage}[T1]{fontenc}'' -to help sort them out. Suddenly you find that your final \acro{PDF} -has become fuzzy. The problem may arise whether you are using \PS{} -output and then distilling it, or you are using \PDFTeX{} for the -whole job. - -In fact, this is the same problem as most others about the -\Qref*{quality of \acro{PDF}}{Q-dvips-pdf}: you've abandoned -your previous setup using Type~1 versions of the \acro{CM} fonts, and -\ProgName{dvips} has inserted Type~3 versions of the \acro{EC} fonts -into your document output. (See % beware line break -``\Qref*{Adobe font types}{Q-adobetypen} -for details of these font types; also, note that the font -\emph{encoding}~\acro{T}1 -has nothing directly to do with the font \emph{format}~Type~1). - -However, as noted in % beware line break -\htmlonly{``}\Qref[question]{8-bit Type~1 fonts}{Q-type1T1}\htmlonly{''}, -Type~1 versions of \acro{CM}-like fonts in \acro{T}1 (or equivalent) encoding -are now available, both as ``real'' fonts, and as virtual font sets. -One solution, therefore, is to use one of these alternatives. - -The alternative is to switch font family altogether, to something like -\FontName{Times} (as a no-thought default) or one of the many more pleasing -Adobe-encoded fonts. The default action of \Package{fontinst}, when -creating metrics for such a font, is to create settings for both \acro{OT}1 -and \acro{T}1 encodings, so there's little change in what goes on (at the -user level) even if you have switched to \acro{T}1~encoding when using the -fonts. - -\Question[Q-distill-prob]{Characters missing from \acro{PDF} output} - -If you're using \ProgName{Acrobat} \ProgName{Distiller} to create your -\acro{PDF} output, you may find -characters missing. This may manifest -itself as messed-up maths equations (missing -``\latexhtml{\ensuremath{-}}{-}'' signs, for example), or bits missing -from large symbols. Early versions of \ProgName{Distiller} used to -ignore character positions 0--31 and 128--159 of every font: Adobe's -fonts never use such positions, so why should \ProgName{Distiller}? - -Well, the answer to this question is ``because Adobe don't produce all -the world's fonts''~--- fonts like \FontName{Computer} -\FontName{Modern} were around before Adobe came on the scene, and -\emph{they} use positions 0--31. Adobe don't react to complaints like -that in the previous sentence, but they do release new versions of -their programs; and \ProgName{Distiller}, since at least version~4.0, -\emph{has} recognised the font positions it used to shun. - -Meanwhile, \TeX{} users with old versions of \ProgName{Distiller} need -to deal with their fonts. \ProgName{Dvips} comes to our aid: the -switch \texttt{-G1} (``remap characters''), which moves the offending -characters out of the way. The \acro{PDF} configuration file -(\texttt{-Ppdf}), recommended % beware line break -\latexhtml{above}{in ``\Qref{the wrong type of fonts}{Q-fuzzy-type3}''}, -includes the switch. - -The switch is not without its problems; pre-2003 versions of -\ProgName{dvips} will apply it to Adobe fonts as well, causing -\Qref*{havoc}{Q-charshift}, but fortunately -that problem is usually soluble. However, a document using both -\acro{CM} and Adobe-specified fonts is stuck. The only real solution -is either to upgrade \ProgName{dvips}, or to spend money to upgrade -\ProgName{Distiller}. - -\Question[Q-type1T1]{Finding `8-bit' Type~1 fonts} -\keywords{eight} - -Elsewhere, answers to these \acro{FAQ}s recommend that you use an -`8-bit' font to permit % line break!! -\Qref*{accentuation of inflected languages}{Q-hyphenaccents}, -and also recommend the use of Type~1 fonts to ensure that -you get \Qref*{good quality \acro{PDF}}{Q-fuzzy-type3}. These -recommendations used to be contradictory: one could not just -``switch'' from the free \acro{CM} fonts to free Cork- (or similarly) -encoded Type~1 fonts. The first approach that started to alleviate -these problems, was the development of virtual fonts that make -a good approach to the Cork encoding (see below). Now, however, we -have ``true'' Type~1 fonts available: as always, we have an -embarrassment of riches with three free alternatives, and one -commercial and one shareware version. - -\Package{CM-super} is an -auto-traced set which encompasses all of the \acro{T}1 and \acro{TS}1 -encodings as well as the \acro{T}2* series (the family of encodings -that cover languages based on Cyrillic alphabets). These fonts are -pretty easy to install (the installation instructions are clear), but -they are huge: don't try to install them if you're short of disc -space. - -\Package{CM-LGC} is a similar ``super-font'' set, but of much more -modest size; it covers \acro{T}1, \acro{TS}1 and \acro{T}2{A} -encodings (as does \Package{CM-super}, and also covers the \acro{LGR} -encoding (for typesetting Greek, based on Claudio Beccari's \MF{} -sources). \Package{CM-LGC} manages to be small by going to the -opposite extreme from \Package{CM-super}, which includes fonts at all -the sizes supported by the original \acro{EC} (a huge range); -\Package{CM-LGC} has one font per font shape, getting other sizes by -scaling. There is an inevitable loss of quality inherent in this -approach, but for the disc-space-challenged machine, \Package{CM-LGC} -is an obvious choice. - -\Package{Tt2001} is a simple scan of the \acro{EC} and \acro{TC} -fonts, and has some virtues~--- it's noticeably smaller than -\Package{CM-super} while being less stark than \Package{CM-LGC}. - -\Package{Latin} \Package{Modern} is produced using the -program \Qref*{\ProgName{MetaType1}}{Q-textrace}. The -\Package{Latin} \Package{Modern} set comes with \acro{T}1, \acro{TS}1 -\acro{LY}1 encoded variants (as well as a variant using the Polish -\acro{QX} encoding); for the glyph set it covers, its outlines seem -rather cleaner than those of \Package{CM-super}. \Package{Latin} -\Package{Modern} is more modest in its disc space demands than is -\Package{CM-super}, while not being nearly as stark in its range of -design sizes as is \Package{CM-LGC}~--- \Package{Latin} -\Package{Modern}'s fonts are offered in the same set of sizes as the -original \Package{CM} fonts. It's hard to argue with the choice: -Knuth's range of sizes has stood the test of time, and is one of the -bases on which the excellence of the \TeX{} system rests. - -\Qref*{Virtual fonts}{Q-virtualfonts} help us deal with the problem, -since they allow us to map ``bits of \acro{DVI} file'' to single -characters in the virtual font; so we can create an ``\'e'' character -by recreating the \acro{DVI} commands that would result from the code -``\csx{'}\texttt{e}''. However, since this involves two characters being -selected from a font, the arrangement is sufficient to fool -\ProgName{Acrobat} \ProgName{Reader}: you can't use the program's -facilities for searching for text that contains inflected characters, -and if you \emph{cut} text from a window that contains such a -character, you'll find something unexpected (typically the accent and -the `base' characters separated by a space) when you \ProgName{paste} -the result. However, if you can live with this difficulty, virtual -fonts are a useful and straightforward solution to the problem. - -There are two virtual-font offerings of \acro{CM}-based 8-bit -fonts~--- the \Package{ae} (``almost \acro{EC}'') and -\Package{zefonts} sets; the \Package{zefonts} set has wider coverage -(though the \Package{ae} set may be extended to offer guillemets by -use of the \Package{aeguill} package). Neither offers characters such -as \texttt{eth} and \texttt{thorn} (used in, for example, in -Icelandic), but the \Package{aecompl} package works with the -\Package{ae} fonts to provide the missing characters from the -\acro{EC} fonts (i.e., as bitmaps). - -The sole remaining commercial \acro{CM}-like 8-bit font comes from -Micropress, who offer the complete \acro{EC} set -in Type~1 format, as part of their range of outline versions of fonts -that were originally distributed in \MF{} format. See -\Qref[question]{``commercial distributions''}{Q-commercial}. - -The shareware % ! line break -\Qref*{BaKoMa \TeX{} distribution}{Q-TeXsystems} offers a -set of Type~1 \acro{EC} fonts, as an extra shareware option. (As far -as the present author can tell, these fonts are \emph{only} available -to users of BaKoMa \TeX{}: they are stored in an archive format that -seems not to be publicly available.) - -Finally, you can use one of the myriad text fonts available in Type~1 -format (with appropriate \acro{PSNFSS} metrics for \acro{T}1 encoding, -or metrics for some other 8-bit encoding such as \acro{LY}1). However, -if you use someone else's text font (even something as simple as -Adobe's Times family) you have to find a matching family of -mathematical fonts, which is a non-trivial undertaking~--- -\htmlonly{see }\Qref{``choice of scalable fonts''}{Q-psfchoice}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}ae fonts]\CTANref{ae} -\item[aecompl.sty]Distributed with \CTANref{ae} -\item[aeguill.sty]\CTANref{aeguill} -\item[\nothtml{\rmfamily}BaKoMa fonts]Browse \CTANref{bakoma-texfonts} -\item[\nothtml{\rmfamily}CM-LGC fonts]\CTANref{cm-lgc} -\item[\nothtml{\rmfamily}CM-super fonts]\CTANref{cm-super} (beware: - very large download) -\item[\nothtml{\rmfamily}Latin Modern fonts]\CTANref{lm} -\item[\nothtml{\rmfamily}tt2001 fonts]\CTANref{tt2001} -\item[\nothtml{\rmfamily}zefonts]\CTANref{zefonts} -\end{ctanrefs} - -\Question[Q-pkfix]{Replacing Type 3 fonts in \PS{}} - -One often comes across a \PS{} file generated by -\ProgName{dvips} which contains embedded \acro{PK} fonts; if you try -to generate \acro{PDF} from such a file, the quality will be poor. - -Of course, the proper solution is to regenerate the \PS{} file, -but if neither the sources nor the \acro{DVI} file are available, one -must needs resort to some sort of patching to replace the bitmap fonts -in the file by outline fonts. - -The program \ProgName{pkfix} (by Heiko Oberdiek) will do this -patching, for files created by ``not too old versions'' of -\ProgName{dvips}: it finds the fonts to be replaced by examining the -\PS{} comments \ProgName{dvips} has put in the file. For each -font, \ProgName{pkfix} puts appropriate \TeX{} commands in a file, -which it then processes and runs through \ProgName{dvips} (with switch -\texttt{-Ppdf}) to acquire an appropriate copy of the font; these copies are -then patched back into the original file. - -If your source file is older than \ProgName{pkfix} can deal with, -there's still a modicum of hope: \ProgName{pkfix-helper} examines the -bitmap fonts in a document, compares them with the metric -(\extension{tfm}) fonts on your system and comes to a view of which -font might be which. The program reports on ``poor'' matches, and -there are options for confirming, or replacing, its guesses. The -technique (which sounds implausible) is successful enough to be worth -a try. - -A further option is Frank Siegert's (shareware) -\href{http://www.pstill.com}{PStill}, which is capable of processing -the \PS{} it is distilling, and one option is to replace bitmap fonts -in the file with Type~1 versions. -\begin{ctanrefs} -\item[pkfix]\CTANref{pkfix} -\item[pkfix-helper]\CTANref{pkfix-helper} -\end{ctanrefs} - -\Question[Q-pdfpagelabels]{\Package{Hyperref} and repeated page numbers} - -The \Class{book} class (and its friends and relations) automatically -changes the display of page numbers in the frontmatter of the document -to lower-case roman. This is fine for human readers, but it confuses -\Package{hyperref} since there are pages which seem (to -\Package{hyperref}) to have the same page number. Fortunately, there are -configuration options to make \Package{hyperref} ``do the right -thing''. - -The two options in question are: -\begin{description} -\item[\pkgoption{plainpages=false}] Make page anchors using the - formatted form of the page number. With this option, - \Package{hyperref} writes different anchors for pages `ii' and `2'. - (If the option is set `\texttt{true}'~--- the default~--- - \Package{hyperref} writes page anchors as the arabic form of the - absolute page number, rather than the formatted form.) -\item[\pkgoption{pdfpagelabels}] Set \acro{PDF} page labels; i.e., - write the value of \csx{thepage} to the \acro{PDF} file so that - \Package{Acrobat Reader} can display the page number as (say) `ii (4 - of 40)' rather than simply `4 of 40'. -\end{description} -The two should be used whenever page numbering is not just -`1\texttt{..}\ensuremath{n}'; they may be used independently, but usually are not. - -The recipe isn't perfect: it relies on \csx{thepage} being different -for every page in the document. A common problem arises when there is -an unnumbered title page, after which page numbers are reset: the -\PDFTeX{} warning of ``\Qref*{duplicate destinations}{Q-hyperdupdest}'' -will happen in this case, regardless of the options. -\begin{ctanrefs} -\item[hyperref.sty]\CTANref{hyperref} -\end{ctanrefs} - -\Question[Q-srchpdf]{Searching \acro{PDF} files} - -In principle, you can search a \acro{PDF} file: the text of the file -is available to the viewer, and at least some viewers provide a search -facility. (It's not the fastest thing in the world, but it does help -in some circumstances.) - -However, there is a problem: the viewer wants to look at Unicode text, -but no ordinary \TeX{}-based system deals in Unicode text. -Fortunately for us Anglophones, this is is hardly ever a problem for -our text, since even Knuth's ``\acro{OT}1'' encoding matches ASCII (and hence -the lowest 128 characters of Unicode) for most things printable. -However, using the inflected characters of Continental European -languages, or anything that doesn't use a Latin alphabet, there is -potential for problems, since \TeX{}'s view of what a font is doesn't -map \acro{PDF}'s and the reader won't understand\dots{} - -\dots{} Unless you use the \Package{cmap} package with \PDFLaTeX{}, -that is. The package will instruct \PDFTeX{} to load character -maps into your \acro{PDF} for output fonts encoded according to the \acro{T}1 -(Western European Languages), T2A, T2B, or T2C (Cyrillic Languages), -or T5 (Vietnamese) encodings. If your document uses such encodings, -viewers that can search will use the maps to interpret what they find -in the file. - -Unfortunately, the package only works with fonts that are directly -encoded, such as the \FontName{cm-super} distribution. Fonts like Adobe -Times Roman (which are encoded for \AllTeX{} use via virtual fonts) -are not amenable to this treatment. -\begin{ctanrefs} -\item[cmap.sty]\CTANref{cmap} -\item[cm-super \nothtml{\rmfamily}fonts]\CTANref{cm-super} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Graphics} - -\Question[Q-impgraph]{How to import graphics into \AllTeX{} documents} - -Knuth, when designing the current version of \TeX{} back in the early -1980s, could discern no ``standard'' way of expressing graphics in -documents. He reasoned that this state could not persist for ever, -but that it would be foolish for him to define \TeX{} primitives that -allowed the import of graphical image definitions. He therefore -deferred the specification of the use of graphics to the writers of -\acro{DVI} drivers; \TeX{} documents would control the drivers by -means of \nothtml{\csx{special} commands (}% beware line breaks -\Qref{\csx{special} commands}{Q-specials}\nothtml{)}. - -There is therefore a straightforward way for anyone to import graphics -into their document: read the specification of the \csx{special} -commands your driver uses, and `just' code them. This is the -hair-shirt approach: it definitely works, but it's not for everyone. - -Over the years, therefore, ``graphics inclusion'' packages have sprung -up; most were designed for inclusion of -\nothtml{Encapsulated \PS{} graphics (}% beware line break -\Qref{Encapsulated \PS{} graphics}{Q-eps}\nothtml{)}\nobreakspace--- -which has become the \emph{lingua franca} of graphics inclusion over -the last decade or so. - -Notable examples are the \Package{epsf} package (distributed with -\ProgName{dvips}) and the \Package{psfig} package. (Both of these -packages were designed to work well with both \plaintex{} and -\LaTeXo{}; they are both still available.) All such packages were -tied to a particular \acro{DVI} driver (\ProgName{dvips}, in -the above two cases), but their code could be configured for others. - -The obvious next step was to make the code configurable dynamically. -The \LaTeX{} standard \Package{graphics} package and its derivatives -made this step: it is strongly preferred for all current work. - -Users of \plaintex{} have two options allowing them to use -\Package{graphicx}: the \Package{miniltx} ``\LaTeX{} emulator'' and -the \Package{graphicx.tex} front-end allow you to load -\Package{graphicx}, and \Qref*{\Eplain}{Q-eplain} allows you to load -it (using the full \LaTeX{} syntax) direct. - -The \Package{graphics} package takes a variety of ``driver -options''~--- package options that select code to generate the -commands appropriate to the \acro{DVI} driver in use. In most cases, -your \AllTeX{} distribution will provide a \File{graphics.cfg} file -that will select the correct driver for what you're doing (for -example, a distribution that provides both \LaTeX{} and \PDFLaTeX{} -will usually provide a configuration file that determines whether -\PDFLaTeX{} is running, and selects the definitions for it if so). - -The \Package{graphics} package provides a toolkit of commands (insert -graphics, scale a box, rotate a box), which may be composed to provide -most facilities you need; the basic command, \csx{includegraphics}, -takes one optional argument, which specifies the bounding box of the -graphics to be included. - -The \Package{graphicx} package uses the facilities of of -\Package{graphics} behind a rather more sophisticated command syntax -to provide a very powerful version of the \csx{includegraphics} -command. \Package{graphicx}'s version can combine scaling and -rotation, viewporting and clipping, and many other things. While this -is all a convenience (at some cost of syntax), it is also capable of -producing noticeably more efficient \PS{}, and some of its -combinations are simply not possible with the \Package{graphics} -package version. - -The \Package{epsfig} package provides the same facilities as -\Package{graphicx}, but via a \csx{psfig} command (also known as -\csx{epsfig}), capable of emulating -the behaviour (if not the bugs) the old \Package{psfig} package. -\Package{Epsfig} also supplies homely support for former users of the -\Package{epsf} package. However, there's a support issue: if you -declare you're using \Package{epsfig}, any potential mailing list or -usenet helper has to clear out of the equation the possibility that -you're using ``old'' \Package{epsfig}, so that support is slower -coming than it would otherwise be. - -There is no rational reason to stick with the old packages, which have -never been entirely satisfactory in the \LaTeX{} context. (One -irrational reason to leave them behind is that their replacement's -name tends not to imply that it's exclusively related to \PS{} -graphics. The reasoning also excludes \Package{epsfig}, of course.) - -A wide variety of detailed techniques and tricks have been developed -over the years, and Keith Reckdahl's \Package{epslatex} outlines them -in compendious detail: this highly recommendable document is available -from \acro{CTAN}. An invaluable review of the practicalities of -exchanging graphics between sites, -% beware multiple line break problems -\begin{wideversion} % hyperversion -``\href{http://silas.psfc.mit.edu/elec_fig/elec_figures.pdf}{Graphics for Inclusion in Electronic Documents}'' -\end{wideversion} -\begin{narrowversion} % non-hyper -\href{http://silas.psfc.mit.edu/elec_fig/elec_figures.pdf}% - {``Graphics for Inclusion in Electronic Documents''} -\end{narrowversion} -has been written by Ian Hutchinson; the document isn't on \acro{CTAN}, -but may also be -% beware line breaks -\href{http://silas.psfc.mit.edu/elec_fig/}{browsed on the Web}. -\begin{ctanrefs} -\item[epsf.tex]\CTANref{epsf} -\item[epsfig.sty]Part of the \CTANref{graphics} bundle -\item[epslatex.pdf]\CTANref{epslatex_pdf}; the document is also available - in \PS{} format as \CTANref{epslatex_ps} -\item[graphics.sty]\CTANref{graphics} -\item[graphicx.sty]Part of the \CTANref{graphics} bundle -\item[miniltx.tex]\CTANref{graphics-plain} -\item[psfig.sty]\CTANref{psfig} -\end{ctanrefs} - -\Question[Q-dvipsgraphics]{Imported graphics in \ProgName{dvips}} - -\ProgName{Dvips}, as originally conceived, can only import a single -graphics format: \nothtml{encapsulated \PS{} (\extension{eps} files, }% -\Qref{encapsulated \PS{}}{Q-eps}\htmlonly{ (\extension{eps} files}). -\ProgName{Dvips} also deals with the slightly eccentric \acro{EPS} that is -created by \Qref*{\MP{}}{Q-MP}. - -Apart from the fact that a depressing proportion of drawing -applications produce corrupt \acro{EPS} when asked for such output, -this is pretty satisfactory for vector graphics work. - -To include bitmap graphics, you need some means of converting them to -\PS{}; in fact many standard image manipulators (such as -\ProgName{ImageMagick}'s \ProgName{convert}) make a good job of -creating \acro{EPS} files (but be sure to ask for output at \PS{} -level~2 or higher). (\ProgName{Unix} users should beware of -\ProgName{xv}'s claims: it has a tendency to downsample your bitmap to -your screen resolution.) - -Special purpose applications \ProgName{jpeg2ps} (which converts -\acro{JPEG} files using \PS{} level 2 functionality), -\ProgName{bmeps} (which converts both \acro{JPEG} and \acro{PNG} -files) and \ProgName{a2ping}/\ProgName{sam2p} (which convert a -bewildering array of bitmap formats to \acro{EPS} or \acro{PDF} files; -\ProgName{sam2p} is one of the engines that \ProgName{a2ping} uses) -are also considered ``good bets''. - -\ProgName{Bmeps} comes with patches to produce your own version of -\ProgName{dvips} that can cope with \acro{JPEG} and \acro{PNG} direct, -using \ProgName{bmeps}'s conversion library. \ProgName{Dvips}, as -distributed by \miktex{}, comes with those patches built-in, but -assuming that capability destroys portability, and is only -recommendable if you are sure you will never want to share your -document. -\begin{ctanrefs} -\item[a2ping]\CTANref{a2ping} -\item[bmeps]\CTANref{bmeps} -\item[jpeg2ps]\CTANref{jpeg2ps} -\item[sam2p]\CTANref{sam2p} -\end{ctanrefs} - -\Question[Q-pdftexgraphics]{Imported graphics in \PDFLaTeX{}} - -\PDFTeX{} itself has a rather wide range of formats that it can -``natively'' incorporate into its output \acro{PDF} stream: -\acro{JPEG} (\extension{jpg} files) for photographs and similar images, -\acro{PNG} files for artificial bitmap images, and \acro{PDF} for -vector drawings. Old versions of \PDFTeX{} (prior to version~1.10a) -supported \acro{TIFF} (\extension{tif} files) format as an alternative -to \acro{PNG} files; don't rely on this facility, even if you -\emph{are} running an old enough version of \PDFTeX{}\dots{} - -In addition to the `native' formats, the standard \PDFLaTeX{} -\Package{graphics} package setup causes Hans Hagen's \File{supp-pdf} -macros to be loaded: these macros are capable of translating the -output of \MP{} to \acro{PDF} ``on the fly''; thus \MP{} output -(\extension{mps} files) may also be included in \PDFLaTeX{} documents. - -The commonest problem users encounter, when switching from \TeX{}, is -that there is no straightforward way to include \acro{EPS} files: -since \PDFTeX{} is its own ``driver'', and since it contains no means -of converting \PS{} to \acro{PDF}, there's no direct way the job can -be done. - -The simple solution is to convert the \acro{EPS} to an appropriate -\acro{PDF} file. The \ProgName{epstopdf} program will do this: it's -available either as a Windows executable or as a \ProgName{Perl} -script to run on Unix and other similar systems. A \LaTeX{} package, -\Package{epstopdf}, can be used to generate the requisite \acro{PDF} -files ``on the fly''; this is convenient, but requires that you -suppress one of \TeX{}'s security checks: don't allow its use in files -from sources you don't entirely trust. - -A similar package, \Package{pst-pdf}, permits other things than `mere' -graphics files in its argument. \Package{Pst-pdf} operates (the -authors suggest) ``like \BibTeX{}''~--- you process your file using -\PDFLaTeX{}, then use \LaTeX{}, \ProgName{dvips} and \ProgName{ps2pdf} -in succession, to produce a secondary file to input to your next -\PDFLaTeX{} run. (Scripts are provided to ease the production of the -secondary file.) - -An alternative solution is to use \ProgName{purifyeps}, a -\ProgName{Perl} script which uses the good offices of -\ProgName{pstoedit} and of \MP{} to convert your Encapsulated \PS{} to -``Encapsulated \PS{} that comes out of \MP{}'', and can therefore be -included directly. Sadly, \ProgName{purifyeps} doesn't work for all -\extension{eps} files. - -Good coverage of the problem is to be found in Herbert Vo\ss{}' -\href{http://pstricks.tug.org/main.cgi?file=pdf/pdfoutput}{\acro{PDF} support page}, -which is targeted at the use of \Package{pstricks} in -\PDFLaTeX{}, and also covers the \Package{pstricks}-specific package -\Package{pdftricks}. -\begin{ctanrefs} -\item[epstopdf]Browse \CTANref{epstopdf} -\item[epstopdf.sty]Distributed with Heiko Oberdiek's packages - \CTANref{oberdiek} -\item[pdftricks.sty]\CTANref{pdftricks} -\item[pst-pdf.sty]\CTANref{pst-pdf} -\item[pstoedit]\CTANref{pstoedit} -\item[purifyeps]\CTANref{purifyeps} -\end{ctanrefs} - -\Question[Q-dvipdfmgraphics]{Imported graphics in \ProgName{dvipdfm}} - -\ProgName{Dvipdfm} (and \ProgName{dvipdfmx}) translates direct from -\acro{DVI} to \acro{PDF} (all other available routes produce \PS{} -output using \ProgName{dvips} and then convert that to \acro{PDF} with -\ProgName{ghostscript} or \ProgName{Acrobat} \ProgName{Distiller}). - -\ProgName{Dvipdfm}/\ProgName{Dvipdfmx} are particularly flexible -applications. They permit the inclusion of bitmap and \acro{PDF} -graphics, as does \Qref*{\PDFTeX{}}{Q-pdftexgraphics}, but are also -capable of employing \ProgName{ghostscript} ``on the fly'' so as to be -able to permit the inclusion of encapsulated \PS{} (\extension{eps}) -files by translating them to \acro{PDF}. In this way, they combine the good -qualities of \ProgName{dvips} and of \PDFTeX{} as a means of -processing illustrated documents. - -Unfortunately, ``ordinary'' \LaTeX{} can't deduce the bounding box of -a binary bitmap file (such as \acro{JPEG} or \acro{PNG}), so you have -to specify the bounding box. This may be done explicitly, in the -document: -\begin{quote} -\begin{verbatim} -\usepackage[dvipdfm]{graphicx} -... -\includegraphics[bb=0 0 540 405]{photo.jpg} -\end{verbatim} -\end{quote} -It's usually not obvious what values to give the ``\texttt{bb}'' key, -but the program \ProgName{ebb} will generate a file -containing the information; the above numbers came from an -\ProgName{ebb} output file \File{photo.bb}: -\begin{quote} -\begin{verbatim} -%%Title: /home/gsm10/photo.jpg -%%Creator: ebb Version 0.5.2 -%%BoundingBox: 0 0 540 405 -%%CreationDate: Mon Mar 8 15:17:47 2004 -\end{verbatim} -\end{quote} -If such a file is available, you may abbreviate the inclusion -code, above, to read: -\begin{quote} -\begin{verbatim} -\usepackage[dvipdfm]{graphicx} -... -\includegraphics{photo} -\end{verbatim} -\end{quote} -which makes the operation feel as simple as does including -\extension{eps} images in a \LaTeX{} file for processing with -\ProgName{dvips}; the \Package{graphicx} package knows to look for a -\extension{bb} file if no bounding box is provided in the -\csx{includegraphics} command. - -The one place where usage isn't quite so simple is the need to quote -\ProgName{dvipdfm} explicitly, as an option when loading the -\Package{graphicx} package: if you are using \ProgName{dvips}, you -don't ordinarily need to specify the fact, since the default graphics -configuration file (of most distributions) ``guesses'' the -\texttt{dvips} option if you're using \TeX{}. -\begin{ctanrefs} -\item[dvipdfm]\CTANref{dvipdfm} -\item[dvipdfmx]\CTANref{dvipdfmx} -\item[ebb]Distributed as part of \CTANref{dvipdfm} -\end{ctanrefs} - -\Question[Q-grffilenames]{``Modern'' graphics file names} - -\TeX{} was designed in a world where file names were very simple -indeed, typically strictly limited both in character set and length. -In modern systems, such restrictions have largely disappeared, which -leaves \TeX{} rather at odds with its environment. Particular -problems arise with spaces in file names, but things like multiple -period characters can seriously confuse the \Package{graphics} -package. - -The specification of \TeX{} leaves some leeway for distributions to -adopt file access appropriate to their operating system, but this -hasn't got us very far. Many modern distributions allow you to -specify a file name as \texttt{"file name.tex"} (for example), which -helps somewhat, but while this allows us to say -\begin{quote} -\begin{verbatim} -\input "foo bar.tex" -\end{verbatim} -\end{quote} -the analogous usage -\begin{quote} -\begin{verbatim} -\includegraphics{"gappy graphics.eps"} -\end{verbatim} -\end{quote} -using ``ordinary'' \LaTeX{} causes confusion in \ProgName{xdvi} and -\ProgName{dvips}, even though it works at compilation time. Sadly, -even within such quotes, multiple dots give \csx{includegraphics} -difficulties. Note that -\begin{quote} -\begin{verbatim} -\includegraphics{"gappy graphics.pdf"} -\end{verbatim} -\end{quote} -works in a similar version of \PDFTeX{}. - -If you're using the \Package{graphics} package, the \Package{grffile} -package will help. The package offers several options, the simplest -of which are \pkgoption{multidot} (allowing more than one dot in a -file name) and \pkgoption{space} (allowing space in a file name). The -\pkgoption{space} option requires that you're running on a -sufficiently recent version of \PDFTeX{}, in \acro{PDF} mode~--- and -even then it won't work for \MP{} files, which are read as \TeX{} -input, and therefore use the standard input mechanism). -\begin{ctanrefs} -\item[grffile.sty]Distributed as part of \CTANref{oberdiek} -\end{ctanrefs} - -\Question[Q-graphicspath]{Importing graphics from ``somewhere else''} - -By default, graphics commands like \csx{includegraphics} look -``wherever \TeX{} files are found'' for the graphic file they're being -asked to use. This can reduce your flexibility if you choose to hold -your graphics files in a common directory, away from your \AllTeX{} -sources. - -The simplest solution is to patch \TeX{}'s path, by changing the -default path. On most systems, the default path is taken from the -environment variable \texttt{TEXINPUTS}, if it's present; you can adapt that -to take in the path it already has, by setting the variable to -\begin{quote} -\begin{verbatim} -TEXINPUTS=.:<graphics path(s)>: -\end{verbatim} -\end{quote} -on a Unix system; on a Windows system the separator will be ``\texttt{;}'' -rather than ``\texttt{:}''. The ``\texttt{.}'' is there to ensure -that the current directory is searched first; the trailing -``\texttt{:}'' says ``patch in the value of \texttt{TEXINPUTS} from -your configuration file, here''. - -This method has the merit of efficiency (\AllTeX{} does \emph{all} of -the searches, which is quick), but it's always clumsy and may prove -inconvenient to use in Windows setups (at least). - -The alternative is to use the \Package{graphics} package command -\csx{graphicspath}; this command is of course also available to users -of the \Package{graphicx} and the \Package{epsfig} packages. The -syntax of \csx{graphicspath}'s one argument is slightly odd: it's a -sequence of paths (typically relative paths), each of which is -enclosed in braces. A slightly odd sample, given in the -\Package{graphics} bundle documentation, is: -\begin{quote} -\begin{verbatim} -\graphicspath{{eps/}{tiff/}} -\end{verbatim} -\end{quote} -however, if the security checks on your \AllTeX{} system allow, the -path may be anything you choose (rather than strictly relative, like -those above); note that the trailing ``\texttt{/}'' \emph{is} required. - -Be aware that \csx{graphicspath} does not affect the operations of -graphics macros other than those from the graphics bundle~--- in -particular, those of the outdated \Package{epsf} and -\Package{psfig} packages are immune. - -The disadvantage of the \csx{graphicspath} method is inefficiency. The -package will call \AllTeX{} once for each entry in the list, which is -itself slows things. More seriously, \TeX{} remembers the file name, -thus effectively losing memory, every time it's -asked to look up a file, so a document that uses a huge number of -graphical inputs could be embarrassed by lack of memory. - -If your document is split into a variety of directories, and each -directory has its associated graphics, the \Package{import} package -may well be the thing for you; see the discussion % beware line break -\latexhtml{of ``bits of document in other directories'' (}{in the question ``}% -\Qref{bits of document in other directories}{Q-docotherdir}% -\latexhtml{)}{''}. -\begin{ctanrefs} -\item[graphics \nothtml{\rmfamily}bundle]\CTANref{graphics} -\item[import.sty]\CTANref{import} -\end{ctanrefs} - -\Question[Q-graph-pspdf]{Portable imported graphics} - -A regular need is a document to be distributed in more than -one format: commonly both \PS{} and \acro{PDF}. The -following advice is based on a post by one with much experience of -dealing with the problem of dealing with \acro{EPS} graphics in this -case. -\begin{itemize} -\item Don't specify a driver when loading loading whichever version of - the \Package{graphics} package you use. The scheme relies on the - distribution's ability to decide which driver is going to be used: - the choice is between \ProgName{dvips} and \PDFTeX{}, in this case. - Be sure to exclude options \pkgoption{dvips}, \pkgoption{pdftex} and - \pkgoption{dvipdfm} (\ProgName{dvipdfm} is not used in this scheme, - but the aspirant \acro{PDF}-maker may be using it for his output, - before switching to the scheme). -\item Use \cmdinvoke{includegraphics}[...]{filename} without - specifying the extension (i.e., neither \extension{eps} nor - \extension{pdf}). -\item For every \extension{eps} file you will be including, produce a - \extension{pdf} version, as described in % beware line break - \Qref[question]{Graphics in \PDFLaTeX{}}{Q-pdftexgraphics}. Having - done this, you will have two copies of each graphic (a \extension{eps} - and a \extension{pdf} file) in your directory. -\item Use \PDFLaTeX{} (rather than - \LaTeX{}--\ProgName{dvips}--distillation or - \LaTeX{}--\ProgName{dvipdfm}) to produce your \acro{PDF} output. -\end{itemize} -\ProgName{Dvipdfm}'s charms are less than attractive here: the -document itself needs to be altered from its default -(\ProgName{dvips}) state, before \ProgName{dvipdfm} will process it. - -\Question[Q-repeatgrf]{Repeated graphics in a document} - -A logo or ``watermark'' image, or any other image that is repeated in -your document, has the potential to make the processed version of the -document unmanageably large. The problem is, that the default -mechanisms of graphics usage add the image at every point it's to be -used, and when processed, the image appears in the output file at each -such point. - -Huge \PS{} files are embarrassing; explaining \emph{why} such a file -is huge, is more embarrassing still. - -The \Qref*{\File{epslatex} graphics tutorial}{Q-tutbitslatex} -describes a technique for avoiding the problem: basically, one -converts the image that's to be repeated into a \PS{} subroutine, and -load that as a \ProgName{dvips} prologue file. In place of the image, -you load a file (with the same bounding box as the image) containing -no more than an invocation of the subroutine defined in the prologue. - -The \File{epslatex} technique is tricky, but does the job. Trickier -still is the neat scheme of converting the figure to a one-character -Adobe Type~3 outline font. While this technique is for the ``real -experts'' only (the author of this answer has never even tried it), it has -potential for the same sort of space saving as the \File{epslatex} -technique, with greater flexibility in actual use. - -More practical is Hendri Adriaens' \Package{graphicx-psmin}; you load -this \emph{in place} of \Package{graphicx}, so rather than: -\begin{quote} -\begin{verbatim} -\usepackage[<options>]{graphicx} -\end{verbatim} -\end{quote} -you will write: -\begin{quote} -\begin{verbatim} -\usepackage[<options>]{graphicx-psmin} -\end{verbatim} -\end{quote} -and at the start of your document, you write: -\begin{quote} -\begin{verbatim} -\loadgraphics[<bb>]{<list of graphics>} -\end{verbatim} -\end{quote} -and each of the graphics in the list is converted to an ``object'' for -use within the resulting \PS{} output. (This is, in essence, an -automated version of the \File{epslatex} technique described above.) - -Having loaded the package as above, whenever you use -\csx{includegraphics}, the command checks if the file you've asked for -is one of the graphics in \csx{loadgraphics}' list. If so, the -operation is converted into a call to the ``object'' rather than a new -copy of the file; the resulting \PS{} can of course be \emph{much} smaller. - -Note that the package requires a recent \ProgName{dvips}, version -5.95b (this version isn't~--- yet~--- widely distributed). - -If your \PS{} is destined for conversion to \acro{PDF}, either by a -\ProgName{ghostscript}-based mechanism such as \ProgName{ps2pdf} or by -(for example) \ProgName{Acrobat} \ProgName{Distiller}, the issue isn't -so pressing, since the distillation mechanism will amalgamate graphics -objects whether or not the \PS{} has them amalgamated. \PDFTeX{} does -the same job with graphics, automatically converting multiple uses -into references to graphics objects. -\begin{ctanrefs} -\item[graphicx-psmin.sty]\CTANref{graphicx-psmin} -\end{ctanrefs} - -\Question[Q-grmaxwidth]{Limit the width of imported graphics} - -Suppose you have graphics which may or may not be able to fit within -the width of the page; if they will fit, you want to set them at their -natural size, but otherwise you want to scale the whole picture so -that it fits within the page width. - -You do this by delving into the innards of the graphics package (which -of course needs a little \LaTeX{} internals programming): -\begin{quote} -\begin{verbatim} -\makeatletter -\def\maxwidth{% - \ifdim\Gin@nat@width>\linewidth - \linewidth - \else - \Gin@nat@width - \fi -} -\makeatother -\end{verbatim} -\end{quote} -This defines a ``variable'' width which has the properties you want. -Replace \csx{linewidth} if you have a different constraint on the width -of the graphic. - -Use the command as follows: -\begin{quote} -\begin{verbatim} -\includegraphics[width=\maxwidth]{figure} -\end{verbatim} -\end{quote} - -\Question[Q-topgraph]{Top-aligning imported graphics} - -When \TeX{} sets a line of anything, it ensures that the base-line of -each object in the line is at the same level as the base-line of the -final object. (Apart, of course, from \csx{raisebox} commands\dots{}) - -Most imported graphics have their base-line set at the bottom of the -picture. When using packages such as \Package{subfig}, one often -wants to align figures by their tops. The following odd little bit of -code does this: -\begin{quote} -\begin{verbatim} -\vtop{% - \vskip0pt - \hbox{% - \includegraphics{figure}% - }% -} -\end{verbatim} -\end{quote} -The \csx{vtop} primitive sets the base-line of the resulting object to -that of the first ``line'' in it; the \csx{vskip} creates the illusion -of an empty line, so \csx{vtop} makes the very top of the box into the -base-line. - -In cases where the graphics are to be aligned with text, there is a -case for making the base-line one ex-height below the top of the box, -as in: -\begin{quote} -\begin{verbatim} -\vtop{% - \vskip-1ex - \hbox{% - \includegraphics{figure}% - }% -} -\end{verbatim} -\end{quote} -A more \LaTeX{}-y way of doing the job (somewhat inefficiently) uses -the \Package{calc} package: -\begin{quote} -\begin{verbatim} -\usepackage{calc} -... -\raisebox{1ex-\height}{\includegraphics{figure}} -\end{verbatim} -\end{quote} -(this has the same effect as the text-align version, above). - -The fact is, \emph{you} may choose where the base-line ends up. This -answer merely shows you sensible choices you might make. - -\Question[Q-mpprologues]{Displaying \MP{} output in \ProgName{ghostscript}} - -\MP{} ordinarily expects its output to be included in some context -where the `standard' \MF{} fonts (that you've specified) are already -defined~--- for example, as a figure in \TeX{} document. If you're -debugging your \MP{} code, you may want to view it in -\ProgName{ghostscript} (or some other \PS{} previewer). However, -the \PS{} `engine' in \ProgName{ghostscript} \emph{doesn't} -ordinarily have the fonts loaded, and you'll experience an error such -as -\begin{quote} -\begin{verbatim} -Error: /undefined in cmmi10 -\end{verbatim} -\end{quote} -There is provision in \MP{} for avoiding this problem: issue the -command \texttt{prologues := 2;} at the start of the \extension{mp} file. - -Unfortunately, the \PS{} that \MP{} inserts in its output, -following this command, is incompatible with ordinary use of the -\PS{} in inclusions into \AllTeX{} documents, so it's best to -make the \texttt{prologues} command optional. Furthermore, \MP{} takes a -very simple-minded approach to font encoding: since \TeX{} font -encodings regularly confuse sophisticated minds, this can prove -troublesome. If you're suffering such problems (the symptom is that -characters disappear, or are wrongly presented) the only solution is -to view the `original' \MP{} output after processing through -\LaTeX{} and \ProgName{dvips}. - -Conditional compilation may be done either -by inputting \File{MyFigure.mp} indirectly from a simple wrapper -\File{MyFigureDisplay.mp}: -\begin{quote} -\begin{verbatim} -prologues := 2; -input MyFigure -\end{verbatim} -\end{quote} -or by issuing a shell command such as -\begin{quote} -\begin{verbatim} -mp '\prologues:=2; input MyFigure' -\end{verbatim} -\end{quote} -(which will work without the quote marks if you're not using a Unix -shell). - -A suitable \LaTeX{} route would involve processing -\File{MyFigure.tex}, which contains: -\begin{quote} -\begin{verbatim} -\documentclass{article} -\usepackage{graphicx} -\begin{document} -\thispagestyle{empty} -\includegraphics{MyFigure.1} -\end{document} -\end{verbatim} -\end{quote} -Processing the resulting \acro{DVI} file with the \ProgName{dvips} -command -\begin{quote} -\begin{verbatim} -dvips -E -o MyFigure.eps MyFigure -\end{verbatim} -\end{quote} -would then give a satisfactory Encapsulated \PS{} file. This -procedure may be automated using the \ProgName{Perl} script -\ProgName{mps2eps}, thus saving a certain amount of tedium. - -The \plaintex{} user may use an adaptation of a jiffy of Knuth's, by -Dan Luecking. Dan's version \Package{mpsproof.tex} will work under -\TeX{} to produce a \acro{DVI} file for use with \ProgName{dvips}, or -under \PDFTeX{} to produce a \acro{PDF} file, direct. The output is -set up to look like a proof sheet. - -A script application, \ProgName{mptopdf}, is available in recent -\AllTeX{} distributions: it seems fairly reliably to produce -\acro{PDF} from \MP{}, so may reasonably be considered an answer to -the question\dots{} -\begin{ctanrefs} -\item[mps2eps]\CTANref{mps2eps} -\item[mpsproof.tex]\CTANref{mpsproof} -\item[mptopdf]Part of \CTANref{pdftex-graphics} -\end{ctanrefs} - -\Question[Q-drawing]{Drawing with \TeX{}} - -There are many packages to do pictures in \AllTeX{} itself (rather than -importing graphics created externally), ranging from simple use of -\LaTeX{} \environment{picture} environment, through enhancements like -\ProgName{eepic}, to -sophisticated (but slow) drawing with \PiCTeX{}. Depending on your type -of drawing, and setup, here are a few systems you may consider: -\begin{itemize} -\item \PiCTeX{} is a venerable, and very powerful, system, that draws - by placing dots on the page to give the effect of a line or curve. While - this has the potential of great power, it is (of course) much slower - than any of the other established packages. What's more, there - are problems with its \Qref*{documentation}{Q-docpictex}. -\item \Package{epic} was designed to make use of the \LaTeX{} - \environment{picture} environment somewhat less agonising; - \Package{eepic} extends it, and is capable of using \ProgName{tpic} - \csx{special} commands to improve printing performance. (If the - \csx{special}s aren't available, the \Package{eepicemu} will do the - business, far less efficiently. -\item \Package{pict2e}; this was advertised in % !line break - \Qref*{the \LaTeX{} manual}{Q-books}, but didn't appear for nearly - ten years after publication of the book! It removes all the petty - restrictions that surround the use of the \environment{picture} - environment. It therefore suffers \emph{only} from the rather - eccentric drawing language of the environment, and is a far more - useful tool than the original environment has ever been. (Note that - \Package{pict2e} supersedes David Carlisle's stop-gap - \Package{pspicture}.) -\item \Package{PSTricks}; this gives you access to all the power of - \PS{} from \TeX{} itself, by sophisticated use of - \Qref*{\csx{special} commands}{Q-specials}. Since \PS{} is itself a - pretty powerful programming language, many astounding things can in - principle be achieved using \Package{PSTricks} (a wide range of - contributed packages, ranging from world mapping to lens design - diagrams, is available). - \Package{Pstricks}' \csx{special}s are - by default specific to \ProgName{dvips}, but V\TeX{} (both in its - commercial and in its free versions) understands them. \PDFTeX{} - users may use \Package{pst-pdf}, which (like - \Package{epstopdf}~--- see % ! line break - \Qref[question]{\PDFLaTeX{} graphics}{Q-pdftexgraphics}) generates - \acro{PDF} files using an auxiliary program, from \Package{PSTricks} - commands (\Package{pst-pdf} also requires a recent installation of - the \Package{preview} package). - - There is a \Package{PSTricks} mailing list - (\mailto{pstricks@tug.org}) which you may - \href{http://tug.org/mailman/listinfo/pstricks}{join}, or you may - just browse the % ! line break - \href{http://tug.org/pipermail/pstricks/}{list archives}. -\item \Package{pgf}: while \Package{pstricks} is very powerful and - convenient, using it with \PDFLaTeX{} is an awful fidget: if you - simply want the graphical capabilities, \Package{pgf}, together with - its rather pleasing ``user-oriented'' interface \Package{tikz}, may be a good - bet for you. While \acro{PDF} has (in essence) the same graphical - capabilities as \PS{}, it isn't programmable; \Package{pgf} provides - common \LaTeX{} commands that will utilise the graphical - capabilities of both \PS{} and \acro{PDF} equally. -\item \MP{}; you liked \MF{}, but never got to grips with font files? - Try \Qref*{\MP{}}{Q-MP}~--- - all the power of \MF{}, but it generates \PS{} figures; \MP{} - is nowadays part of most serious \AllTeX{} distributions. Knuth - uses it for all his work\dots{} -\item \ProgName{Mfpic}; you liked \MF{}, but can't understand the - language? The package makes up \MF{} or \MP{} code for you - within using familiar-looking \TeX{} macros. Not \emph{quite} the - full power of \MP{}, but a friendlier interface; of course, with - \MP{} output, the results can be used equally well in either - \LaTeX{} or \PDFLaTeX{}. -\item You liked \PiCTeX{} but don't have enough memory or time? Look - at Eitan Gurari's \Package{dratex}, which is as powerful as most - other \TeX{} drawing packages, but is an entirely new - implementation, which is not as hard on memory, is much more - readable (and is fully documented). -\end{itemize} -\begin{ctanrefs} -\item[dratex.sty]\CTANref{dratex} -\item[epic.sty]\CTANref{epic} -\item[eepic.sty]\CTANref{eepic} -\item[eepicemu.sty]\CTANref{eepic} -\item[mfpic]\CTANref{mfpic} -\item[preview.sty]\CTANref{preview} -\item[pspicture.sty]\CTANref{pspicture} -\item[pst-pdf.sty]\CTANref{pst-pdf} -\item[pgf.sty]\CTANref{pgf} -\item[pict2e.sty]\CTANref{pict2e} -\item[pictex.sty]\CTANref{pictex} -\item[pstricks]\CTANref{pstricks} -\item[tikz.sty]Distributed with \CTANref{pgf} -\end{ctanrefs} - -\Question[Q-drawFeyn]{Drawing Feynman diagrams in \LaTeX{}} - -Michael Levine's \Package{feynman} bundle for drawing the diagrams in -\LaTeXo{} is still available. - -Thorsten Ohl's \Package{feynmf} is designed for use with current -\LaTeX{}, and works in -combination with \MF{} (or, in its \Package{feynmp} incarnation, with -\MP{}). The \ProgName{feynmf} or -\ProgName{feynmp} package reads a description of the diagram written -in \TeX{}, and writes out code. \MF{} (or \MP{}) can then produce a -font (or \PS{} file) for use in a subsequent \LaTeX{} run. For -new users, who have access to \MP{}, the \PS{} version is -probably the better route, for document portability and other reasons. -% checked rf 2001/03/22 - -Jos Vermaseren's \Package{axodraw} is mentioned as an alternative in -the documentation of \Package{feynmf}, but it is written entirely in -terms of \ProgName{dvips} \csx{special} commands, and is thus rather -imperfectly portable. - -An alternative approach is implemented by Norman Gray's \Package{feyn} -package. Rather than creating complete diagrams as postscript images, -\Package{feyn} provides a font (in a variety of sizes) containing -fragments, which you can compose to produce complete diagrams. It -offers fairly simple diagrams which look good in equations, rather -than complicated ones more suitable for display in figures. -\begin{ctanrefs} -\item[axodraw]\CTANref{axodraw} -\item[feyn \nothtml{\rmfamily}font bundle]\CTANref{feyn} -\item[feynman bundle]\CTANref{feynman} -\item[feynmf/feynmp bundle]\CTANref{feynmf} -\end{ctanrefs} - -\Question[Q-labelfig]{Labelling graphics} - -``Technical'' graphics (such as graphs and diagrams) are often -labelled with quite complex mathematical expressions: there are few -drawing or graphing tools that can do such things (the honourable -exception being \MP{}, which allows you to program the labels, in -\AllTeX{}, in the middle of specifying your graphic). - -Labels on graphics produced by all those \emph{other} tools is where -the \Package{psfrag} package can help. Place an unique -text in your graphic, using the normal text features of your tool, and -you can ask \Package{psfrag} to replace the text with arbitrary -\AllTeX{} material. \Package{Psfrag}'s ``operative'' command is -\cmdinvoke{psfrag}{\emph{PS text}}{\emph{Repl text}}, which instructs -the system to replace the original (``\texttt{PS}'') text with the -\TeX{}-typeset replacement text. Optional -arguments permit adjustment of position, scale and rotation; full -details may be found in \File{pfgguide} in the distribution. - -Since \Package{psfrag} works in terms of (encapsulated) \PS{} files, -it needs extra work for use with \PDFLaTeX{}. The % ! line break -\Qref*{\Package{pst-pdf} package}{Q-pdftexgraphics} can support such -usage. In fact, the \Package{pst-pdf} support package -\Package{auto-pst-pdf} offers a configuration setting precisely for -use with \Package{psfrag}. - -On the other hand, -\begin{narrowversion} - V\TeX{}'s GeX processor (\Qref{}{Q-commercial}) -\end{narrowversion} -\begin{wideversion} - \Qref*{V\TeX{}}{Q-commercial}'s GeX processor -\end{wideversion} -explicitly deals with \Package{psfrag}, both in its free and -commercial instances. - -The \Package{psfragx} package goes one step further than -\Package{psfrag}: it provides a means whereby you can put the -\Package{psfrag} commands into the preamble of your \acro{EPS} file -itself. \Package{Psfrag} has such a command itself, but deprecates -it; \Package{psfragx} has cleaned up the facility, and provides a -script \ProgName{laprint} for use with \ProgName{Matlab} to produce -appropriately tagged output. (In principle, other graphics -applications could provide a similar facility, but apparently none does.) - -\ProgName{Emacs} users may find the embedded editor \ProgName{iTe} a -useful tool for placing labels: it's a \AllTeX{}-oriented graphical -editor written in \ProgName{Emacs Lisp}. You create -\environment{iteblock} environments containing graphics and text, and -may then invoke \ProgName{iTe} to arrange the elements relative to one -another. - -Another useful approach is \Package{overpic}, which overlays a -\environment{picture} environment on a graphic included by use of -\csx{includegraphics}. This treatment lends itself to ready placement -of texts and the like on top of a graphic. The package can draw a -grid for planning your ``attack''; the distribution comes with simple -examples. - -\Package{Pstricks} can of course do everything that \Package{overpic} -can, with all the flexibility of \PS{} programming that it offers -The \Package{pstricks} web site has a page with several % ! line break -\href{http://pstricks.tug.org/main.cgi?file=Examples/overlay}{examples of labelling} -which will get you started; if \Package{pstricks} is % ! line break -\Qref*{an option for you}{Q-drawing}, this route is worth a try. - -The confident user may, of course, do the whole job in a picture -environment which itself includes the graphic. I would recommend -\Package{overpic} or the \Package{pstricks} approach, but such things -are plainly little more than a convenience over what is achievable -with the do-it-yourself approach. -\begin{ctanrefs} -\item[auto-pst-pdf.sty]\CTANref{auto-pst-pdf} -\item[iTe]\CTANref{ite} -\item[laprint]Distributed with \CTANref{psfragx} -\item[overpic.sty]\CTANref{overpic} -\item[psfrag.sty]\CTANref{psfrag} -\item[psfragx.sty]\CTANref{psfragx} -\item[pstricks.sty]\CTANref{pstricks} -\item[pst-pdf.sty]\CTANref{pst-pdf} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Bibliographies and citations} - -\subsection{Creating bibliographies} - -\Question[Q-buildbib]{Creating a \BibTeX{} bibliography file} - -A \BibTeX{} bibliography file may reasonably be compared to a small -database, the entries in which are references to literature that may -be called up by citations in a document. - -Each entry in the bibliography has a \emph{type} and a unique -\emph{key}. The bibliography is read, by \BibTeX{}, using the details -specified in a \emph{bibliography style}. From the style, \BibTeX{} -finds what entry types are permissible, what \emph{fields} each entry -type has, and how to format the whole entry. - -The type specifies the type of document you're making reference to; it -may run all the way from things like ``\environment{Book}'' and -``\environment{Proceedings}'' (which may even contain other citations -of type ``\environment{InBook}'' or ``\environment{InProceedings}'') -through dissertation styles like ``\environment{PhdThesis}'' to -otherwise-uncategorisable things such as ``\environment{Misc}''. The -unique key is something you choose yourself: it's what you use when -you want to \Qref*{cite an entry in the file}{Q-usebibtex}. People -commonly create a key that combines the (primary) author's name and -the year of publication, possibly with a marker to distinguish -publications in the same year. So, for example, the Dyson, Eddington, -Davidson paper about deflection of starlight appears in my -experimental \extension{bib} file as \texttt{Dyson20.1}. - -So, noting the rules of the style, you have `simply' to write a -bibliography database. Fortunately, there are several tools to help -in this endeavour: -\begin{itemize} -\item Most of the better \Qref*{\AllTeX{}-oriented editors}{Q-editors} - have ``\BibTeX{} modes''. -\item If you have an existing \environment{thebibliography} - environment, the \ProgName{Perl} script \ProgName{tex2bib} will - probably help. -\item There are a number of \BibTeX{} bibliography management systems - available, some of which permit a graphical user interface to the - task. Sadly, none seems to be available with the ordinary \TeX{} - distributions. - - Tools such as \ProgName{Xbibfile} (a graphical user interface), - \ProgName{ebib} (a database application written to run `inside' - \ProgName{emacs}) and - \ProgName{btOOL} (a set of \ProgName{perl} tools for building - \BibTeX{} database handlers) are available from \acro{CTAN}. - - Other systems, such as - \href{http://refdb.sourceforge.net/}{\ProgName{RefDB}}, - \href{http://www.nongnu.org/biborb}{BibORB}, - \href{http://bibdesk.sourceforge.net/}{\ProgName{BibDesk}}, - \href{http://pybliographer.org}{\ProgName{pybliographer}} and the - \ProgName{Java}-based - \href{http://freshmeat.net/projects/bibkeeper/}{\ProgName{Bibkeeper}} - and \href{http://jabref.sourceforge.net}{\ProgName{JabRef}} (which - claims to supersede \ProgName{Bibkeeper}) - are only available from their development sites. -% review of web database offerings in textex_368 -\item Some commercial citation-management systems will export in - \BibTeX{} format; an example is - \href{http://www.endnote.com/}{EndNote}. -\item Data from on-line citation databases may often be translated to - \BibTeX{} format by utilities to be found on \acro{CTAN}. For - example, the \ProgName{Perl} script \ProgName{isi2bibtex} will - translate citations from \acro{ISI} ``Web of knowledge'' (a - subscription service, available to \acro{UK} academics via - \acro{BIDS}). UK academics may translate \acro{BIDS} downloads - using \ProgName{bids.to.bibtex} -\end{itemize} -\begin{ctanrefs} -\item[bids.to.bibtex]\CTANref{bidstobibtex} -\item[btOOL]\CTANref{btOOL} -\item[ebib]\CTANref{ebib} -\item[isi2bibtex]\CTANref{isi2bibtex} -\item[tex2bib]\CTANref{tex2bib} -\item[tex2bib.readme]\CTANref{tex2bib-doc} -\item[xbibfile]\CTANref{xbibfile} -\end{ctanrefs} - -\Question[Q-custbib]{Creating a bibliography style} - -It \emph{is} possible to write your own: the standard bibliography -styles are distributed in a commented form, and there is a description -of the language (see -% beware line-wrap -\Qref[question]{BibTeX documentation}{Q-BibTeXing}). -However, it must be admitted that the language in which \BibTeX{} -styles are written is pretty obscure, and one would not recommend -anyone who's not a confident programmer to write their own, though -minor changes to an existing style may be within the grasp of many. - -If your style isn't too `far out', you can probably generate it by -using the facilities of the \Package{custom-bib} bundle. This -contains a file \File{makebst.tex}, which runs you through a text menu -to produce a file of instructions, with which you can generate your -own \extension{bst} file. This technique doesn't offer entirely new styles -of document, but the system's ``master \BibTeX{} styles'' already -offer significantly more than the \BibTeX{} standard set. -\begin{ctanrefs} -\item[\nothtml{\normalfont}\BibTeX{} documentation]\CTANref{bibtex-doc} -\item[makebst.tex]Distributed with \CTANref{custom-bib} -\end{ctanrefs} - -\Question[Q-capbibtex]{Capitalisation in \BibTeX{}} - -The standard \BibTeX{} bibliography styles impose fixed ideas about -the capitalisation of titles of things in the bibliography. While -this is not unreasonable by \BibTeX{}'s lights (the rules come from -the \emph{Chicago Manual of Style}) it can be troublesome, since -\BibTeX{} fails to recognise special uses (such as acronyms, chemical -formulae, etc.). - -The solution is to enclose the letter or letters, whose capitalisation -\BibTeX{} should not touch, in braces, as: -\begin{quote} -\begin{verbatim} -title = {The {THE} operating system}, -\end{verbatim} -\end{quote} -Sometimes you find \BibTeX{} changing the case of a single letter -inappropriately. No matter: the technique can be applied to single -letters, as in: -\begin{quote} -\begin{verbatim} -title = {Te{X}niques and tips}, -\end{verbatim} -\end{quote} -If your document design specification requires a different style of -capitalisation, you should acquire a bibliography style that doesn't -enforce \BibTeX{}'s default rules. It is definitely \emph{not} a good -idea to enclose an entire title in braces, as in -\begin{quote} -\begin{verbatim} -title = {{TeXniques and tips}}, -\end{verbatim} -\end{quote} -though that does ensure that the capitalisation is not changed. Your -\BibTeX{} database should be a general-purpose thing, not something -tuned to the requirements of a particular document, or to the way you -are thinking today. - -There's more on the subject in the -% beware line wrap -\Qref*{\BibTeX{} documentation}{Q-BibTeXing}. - -\Question[Q-bibaccent]{Accents in bibliographies} - -\BibTeX{} not only has a tendency (by default) to mess about with the -% line wrap -\Qref*{case of letters in your bibliography}{Q-capbibtex}, -also makes a hash of accent commands: -``\texttt{ma}\csx{\textasciitilde}\texttt{nana}'' comes out as ``ma -nana'' (!). The solution is similar that of the letter case problem: -enclose the troublesome sequence in braces, as -``\texttt{\{}\csx{\textasciitilde}\texttt{n\}}'', in this example. - -\Question[Q-bibstrtl]{`String too long' in \BibTeX{}} - -The \BibTeX{} diagnostic ``Warning--you've exceeded 1000, the -\texttt{global-string-size}, for entry \texttt{foo}'' usually arises -from a very large abstract or annotation included in the database. -The diagnostic usually arises because of an infelicity in the coding of -\File{abstract.bst}, or styles derived from it. (One doesn't -ordinarily output annotations in other styles.) - -The solution is to make a copy of the style file (or get a clean copy -from \acro{CTAN}~--- \CTANref{abstract-bst}), and rename it (e.g., on a -long file-name system, to \File{abstract-long.bst}). Now edit it: find -function \texttt{output.nonnull} and -\begin{itemize} -\item change its first line (line 60 in the version on \acro{CTAN}) - from - \begin{quote} -\begin{verbatim} -{ 's := -\end{verbatim} - \end{quote} -to - \begin{quote} -\begin{verbatim} -{ swap$ -\end{verbatim} - \end{quote} - Finally, -\item delete the function's last line, which just says ``\texttt{s} - (line 84 in the version on \acro{CTAN}). -\end{itemize} -Finally, change your \csx{bibliographystyle} command to refer to the -name of the new file. - -This technique applies equally to any bibliography style: the same -change can be made to any similar \texttt{output.nonnull} function. - -If you're reluctant to make this sort of change, the only way forward -is to take the entry out of the database, so that you don't encounter -\BibTeX{}'s limit, but you may need to retain the entry because it -will be included in the typeset document. In such cases, put the body -of the entry in a separate file: -\begin{quote} -\begin{verbatim} -@article{long.boring, - author = "Fred Verbose", - ... - abstract = "{\input{abstracts/long.tex}}" -} -\end{verbatim} -\end{quote} -In this way, you arrange that all \BibTeX{} has to deal with is the -file name, though it will tell \TeX{} (when appropriate) to include -all the long text. - -\Question[Q-manyauthor]{\BibTeX{} doesn't understand lists of names} - -\BibTeX{} has a strict syntax for lists of authors' (or editors') -names in the \BibTeX{} data file; if you write the list of names in a -``natural''-seeming way, the chances are you will confuse \BibTeX{}, -and the output produced will be quite different from what you had -hoped. - -Names should be expressed in one of the forms -\begin{quote} -\begin{verbatim} -First Last -Last, First -Last, Suffix, First -\end{verbatim} -\end{quote} -and lists of names should be separated with ``\texttt{and}''. -For example: -\begin{quote} -\begin{verbatim} -AUTHOR = {Fred Q. Bloggs, John P. Doe \& - Another Idiot} -\end{verbatim} -\end{quote} -falls foul of two of the above rules: a syntactically significant -comma appears in an incorrect place, and `\csx{\&}' is being used as a -name separator. The output of the above might be something like: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -John P. Doe \& Another Idiot Fred Q. Bloggs -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -John P. Doe \& Another Idiot - Fred Q. Bloggs -\end{verbatim} -\end{narrowversion} -\end{quote} -because ``John P. Doe \& Another Idiot has become the `first name', -while ``Fred Q. Bloggs'' has become the `last name' of a single -person. The example should have been written: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -AUTHOR = {Fred Q. Bloggs and - John P. Doe and - Another Idiot} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -AUTHOR = {Fred Q. Bloggs and John P. Doe and - Another Idiot} -\end{verbatim} -\end{wideversion} -\end{quote} -Some bibliography styles implement clever acrobatics with very long -author lists. You can force truncation by using the pseudo-name -``\texttt{others}'', which will usually translate to something like -``\emph{et al}'' in the typeset output. So, if Mr.~Bloggs wanted to -distract attention from his co-authors, he would write: -\begin{quote} -\begin{verbatim} -AUTHOR = {Fred Q. Bloggs and others} -\end{verbatim} -\end{quote} - -\Question[Q-citeURL]{\acro{URL}s in \BibTeX{} bibliographies} - -There is no citation type for \acro{URL}s, \emph{per se}, in the -standard \BibTeX{} styles, though Oren Patashnik (the author of -\BibTeX{}) is believed to be considering developing one such for use -with the long-awaited \BibTeX{} version~1.0. - -The actual information that need be available in a citation of an -\acro{URL} is discussed at some length in the publicly available -on-line -\begin{narrowversion} - extracts of \acro{ISO}~690--2, available via - \URL{http://www.nlc-bnc.ca/iso/tc46sc9/standard/690-2e.htm}; - % checked 2004-01-15 -\end{narrowversion} -\begin{wideversion} -\href{http://www.nlc-bnc.ca/iso/tc46sc9/standard/690-2e.htm}{extracts of \acro{ISO}\nobreakspace690--2}; -\end{wideversion} -the techniques below do \emph{not} satisfy all the requirements of -\acro{ISO}~690--2, but they offer a solution that is at least -available to users of today's tools. - -Until the new version of \BibTeX{} arrives, the simplest technique is -to use the \texttt{howpublished} field of the standard styles' \texttt{@misc} -function. Of course, the strictures -about \Qref*{typesetting \acro{URL}s}{Q-setURL} still apply, so the -entry will look like: -\begin{quote} -\begin{verbatim} -@misc{..., - ..., - howpublished = "\url{http://...}" -} -\end{verbatim} -\end{quote} -A possible alternative approach is to use \BibTeX{} styles other than -the standard ones, that already have \acro{URL} entry types. -Candidates are: -\begin{itemize} -\item The \Package{natbib} styles (\Package{plainnat}, - \Package{unsrtnat} and \Package{abbrevnat}), which are extensions of - the standard styles, principally for use with \Package{natbib} - itself. However, they've acquired \acro{URL}s and other ``modern'' - entries along the way. The same author's \Package{custom-bib} is - also capable of generating styles that honour \acro{URL} entries. -\item The \Package{babelbib} bundle, which offers % ! line break - \Qref*{multilingual bibliographies}{Q-i18nbib}, similarly provides a - set of standard-style equivalents that have \acro{URL} entries. -\item More modern styles such as the \Package{harvard} package (if the - citation styles are otherwise satisfactory for you). - \Package{Harvard} bibliography styles all include a ``\texttt{url}'' - field in their specification; however, the typesetting offered is - somewhat feeble (though it does recognise and use - \ProgName{LaTeX2HTML} macros if they are available, to create - hyperlinks). -\end{itemize} -You can also acquire new \BibTeX{} styles by use of Norman Gray's -\Package{urlbst} system, which is based on a \ProgName{Perl} script -that edits an existing \BibTeX{} style file to produce a new -style. The new style thus generated has a \texttt{webpage} entry type, and -also offers support for \texttt{url} and \texttt{lastchecked} fields -in the other entry types. The \ProgName{Perl} script comes with a set -of converted versions of the standard bibliography styles. - -Another possibility is that some conventionally-published paper, -technical report (or even book) is also available on the Web. In such -cases, a useful technique is something like: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -@techreport{..., - ..., - note = "Also available as \url{http://...}" -} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -@techreport{..., - ..., - note = "Also available as - \url{http://...}" -} -\end{verbatim} -\end{narrowversion} -\end{quote} -There is good reason to use the \Package{url} or \Package{hyperref} -packages in this context: \BibTeX{} has a habit of splitting -lines it considers excessively long, and if there are no space -characters for it to use as `natural' breakpoints, \BibTeX{} will -insert a comment (`\texttt{\textpercent}') character~\dots{}\@ which -is an acceptable character in an \acro{URL}. Any current version of the -\Package{url} or \Package{hyperref} package detects this -``\texttt{\textpercent}--end-of-line'' structure in its argument, and -removes it. -\begin{ctanrefs} -\item[babelbib \nothtml{\rmfamily}bundle]\CTANref{babelbib} -\item[custom-bib \nothtml{\rmfamily}bundle]\CTANref{custom-bib} -\item[harvard.sty]\CTANref{harvard} -\item[hyperref.sty]\CTANref{hyperref} -\item[natbib \nothtml{\rmfamily}styles]\CTANref{natbib} -\item[url.sty]\CTANref{url} -\item[urlbst]\CTANref{urlbst} -\end{ctanrefs} - -\Question[Q-bibplain]{Using \BibTeX{} with \plaintex{}} - -The file \File{btxmac.tex} (which is part of the \Eplain{} system) -contains macros and documentation for using \BibTeX{} with -\plaintex{}, either directly or with \Qref*{\Eplain{}}{Q-eplain}. See -\Qref[question]{the use of \BibTeX{}}{Q-BibTeXing} for more -information about \BibTeX{} itself. -\begin{ctanrefs} -\item[btxmac.tex]\CTANref{btxmactex} -\item[eplain \nothtml{\rmfamily}system]\CTANref{eplain} -\end{ctanrefs} - -\Question[Q-makebib]{Reconstructing \extension{bib} files} - -Perhaps you've lost the \extension{bib} file you generated your document from, -or have been sent a document without one. Or even, you've realised -the error of building a substantial document without the benefit of -\BibTeX{}\dots{} - -The \ProgName{Perl} script, \Package{tex2bib} makes a reasonable job -of regenerating \extension{bib} files from \environment{thebibliography} -environments, provided that the original (whether automatically or -manually generated) doesn't deviate too far from the ``standard'' -styles. - -You are well-advised to check the output of the script. While it will -not usually destroy information, it can quite reasonably mislabel it. - -Documentation of the script is to be found in the file \File{tex2bib.readme} -\begin{ctanrefs} -\item[tex2bib]\CTANref{tex2bib} -\item[tex2bib.readme]\CTANref{tex2bib-doc} -\end{ctanrefs} - -\Question[Q-bibprefixsort]{\BibTeX{} sorting and name prefixes} - -\BibTeX{} recognises a bewildering array of name prefixes (mostly -those deriving from European language names); it ignores the prefixes -when sorting the bibliography~--- you want ``Ludwig van Beethoven'' -sorted under ``Beethoven'', not under ``van''. (Lamport made a witty -deliberate mistake with Beethoven's name, in the first edition of his -\LaTeX{} manual.) - -However, a recurring issue is the desire to quote Lord Rayleigh's -publications (``Lord'' isn't an acceptable prefix), or names from -languages that weren't considered when \BibTeX{} was designed such as -``al-Wakil'' (transcribed from the Arabic). What's needed is a -separate ``sort key'', but \BibTeX{} only allows such a thing in -citations of items that have no author or editor. - -The solution is to embed the sort key in the author's name, but to -prevent it from being typeset. Patashnik recommends a command -\csx{noopsort} (no-output-sortkey), which is defined and used as -follows: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -@PREAMBLE{ {\providecommand{\noopsort}[1]{}} } -... -@ARTICLE{Rayleigh1, -AUTHOR = "{\noopsort{Rayleigh}}{Lord Rayleigh}", -... -} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -@PREAMBLE{ - {\providecommand{\noopsort}[1]{}} -} -... -@ARTICLE{Rayleigh1, -AUTHOR = - "\noopsort{Rayleigh}{Lord Rayleigh}", -... -} -\end{verbatim} -\end{narrowversion} -\end{quote} -Note that this \csx{noopsort} applies to the last name in this kind of -construct, so an author with an Arabic name might be rendered: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -... -AUTHOR = "Ali {\noopsort{Hadiidii}}{al-Hadiidii}", -... -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -... -AUTHOR = - "Ali {\noopsort{Hadiidii}}{al-Hadiidii}", -... -\end{verbatim} -\end{quote} -\end{narrowversion} -A further use might deal with word order games, as in the famous -Vietnamese name: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -... -AUTHOR = "\noopsort{Thanh Han The}{Han The Thanh}", -... -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -... -AUTHOR = - "\noopsort{Thanh Han The}{Han The Thanh}", -... -\end{verbatim} -\end{quote} -\end{narrowversion} -though that author seems well-acquainted with Western confusion about -the significance of the parts of his name (even to the extent of -missing out the accentuation, as above\dots{}). - -\Question[Q-bibtranscinit]{`Multi-letter' initials in \BibTeX{}} -\keywords{compound initials, transcribed initials} - -If your bibliographic style uses initials~+ surname, you may encounter -a problem with some transcribed names (for example, Russian ones). -Consider the following example from the real world: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -@article{epifanov1997, - author = {Epifanov, S. Yu. and - Vigasin, A. A.}, - title = ... -} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -@article{epifanov1997, - author = {Epifanov, S. Yu. and Vigasin, A. A.}, - title = ... -} -\end{verbatim} -\end{wideversion} -\end{quote} -Note that the ``Yu'' is the initial, not a complete name. However, -\BibTeX{}'s algorithms will leave you with a citation~--- -slightly depending on the bibliographic style~--- that reads: -``S. Y. Epifanov and A. A. Vigasin, \dots{}''. instead of the intended -``S. Yu. Epifanov and A. A. Vigasin, \dots{}''. - -One solution is to replace each affected initial by a command that -prints the correct combination. To keep your bibliography portable, -you need to add that command to your bibliography with the -\texttt{@preamble} directive: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -@preamble{ {\providecommand{\BIBYu}{Yu} } } - -@article{epifanov1997, - author = {Epifanov, S. {\BIBYu}. and - Vigasin, A. A.}, - title = ... -} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -@preamble{ {\providecommand{\BIBYu}{Yu} } } - -@article{epifanov1997, - author = {Epifanov, S. {\BIBYu}. and Vigasin, A. A.}, - title = ... -} -\end{verbatim} -\end{wideversion} -\end{quote} -If you have many such commands, you may want to put them in a separate -file and \csx{input} that \LaTeX{} file in a \texttt{@preamble} -directive. - -An alternative is to make the transcription look like an accent, from -\BibTeX{}'s point of view. For this we need a control sequence that -does nothing: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -@article{epifanov1997, - author = {Epifanov, S. {\relax Yu}. and Vigasin, A. A.}, - title = ... -} -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -@article{epifanov1997, - author = {Epifanov, S. {\relax Yu}. and - Vigasin, A. A.}, - title = ... -} -\end{verbatim} -\end{quote} -\end{narrowversion} -Like the solution by generating extra commands, this involves tedious -extra typing; which of the two techniques is preferable for a given -bibliography will be determined by the names in it. It should be -noted that a preamble that introduces lots of odd commands is usually -undesirable if the bibliography is a shared one. - -``Compound'' initials (for single names made up of two or more words) -may be treated in the same way, so one can enter Forster's rather -complicated name as: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -@article{forster2006, - author = {Forster, P.M. {\relax de F.} and Collins, M.}, - title = ... -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -@article{forster2006, - author = {Forster, P.M. {\relax de F.} and - Collins, M.}, - title = ... -\end{verbatim} -\end{quote} -\end{narrowversion} -The same trick can be played if you're entering whole names: -\begin{quote} -\begin{verbatim} -... - author = {Epifanov, Sasha {\relax Yu}ri and -... -\end{verbatim} -\end{quote} -(though no guarantee, that either of those names is right, is -offered!) -However, if you're typing the names in the ``natural'' (Western) way, -with given names first, the trick: -\begin{quote} -\begin{verbatim} -... - author = {P.M. {\relax de F.} Forster and -... -\end{verbatim} -\end{quote} -doesn't work~--- ``de F. Forster'' is treated as a compound family -names. - - -\subsection{Creating citations} - -\Question[Q-usebibtex]{``Normal'' use of \BibTeX{} from \LaTeX{}} - -To create a bibliography for your document, you need to perform a -sequence of steps, some of which seem a bit odd. If you choose to use -\BibTeX{}, the sequence is: - -First: you need a \BibTeX{} bibliography file (a \extension{bib} file)~--- see -\nothtml{``creating a \BibTeX{} file'' (\Qref[question]{}{Q-buildbib}).} -\begin{htmlversion} -``\Qref[question]{creating a \BibTeX{} file}{Q-buildbib}''. -\end{htmlversion} - -Second: you must write your \LaTeX{} document to include a declaration -of the `style' of bibliography, citations, and a reference to the -bibliography file mentioned in the step 1. So we may have a \LaTeX{} -file containing: -\begin{quote} -\begin{verbatim} -\bibliographystyle{plain} -... -Pooh is heroic~\cite{Milne:1926}. -... -Alice struggles~\cite{Carroll:1865}. -... -\bibliography{mybooks} -\end{verbatim} -\end{quote} -Note: we have bibliography style \Package{plain}, above, which is -nearly the simplest of the lot: a sample text, showing the sorts of -style choices available, can be found on Ken Turner's web site: -\URL{http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html} - -Third: you must process the file. -\begin{quote} -\begin{verbatim} -latex myfile -\end{verbatim} -\end{quote} -As \LaTeX{} processes the file, the \csx{bibliographystyle} command -writes a note of the style to the \extension{aux} file; each -\csx{cite} command writes a note of the citation to the -\extension{aux} file, and the \csx{bibliography} command writes a note -of which \extension{bib} file is to be used, to the \extension{aux} file. - -Note that, at this stage, \LaTeX{} isn't ``resolving'' any of the -citations: at every \csx{cite} command, \LaTeX{} will warn you of the -undefined citation, and when the document finishes, there will be a -further warning of undefined references. - -%Some bibliography styles are designed to work with particular -%packages... - -Fourth: you must run \BibTeX{}: -\begin{quote} -\begin{verbatim} -bibtex myfile -\end{verbatim} -\end{quote} -Don't try to tell \BibTeX{} anything but the file name: say -\texttt{bibtex myfile.aux} (because you know it's going to read the -\extension{aux} file) and \BibTeX{} will blindly attempt to process -\texttt{myfile.aux.aux}. - -\BibTeX{} will scan the \extension{aux} file; it will find which bibliography -style it needs to use, and will ``compile'' that style; it will note -the citations; it will find which bibliography files it needs, and -will run through them matching citations to entries in the -bibliography; and finally it will sort the entries that have been -cited (if the bibliography style specifies that they should be -sorted), and outputs the resulting details to a \extension{bbl} file. - -Fifth: you run \LaTeX{} again. It warns, again, that each citation is -(still) undefined, but when it gets to the \csx{bibliography} command, -it finds a \extension{bbl} file, and reads it. As it encounters each -\csx{bibitem} command in the file, it notes a definition of the -citation. - -Sixth: you run \LaTeX{} yet again. This time, it finds values for all -the citations, in its \extension{aux} file. Other things being equal, you're -done\dots{} until you change the file. - -If, while editing, you change any of the citations, or add new ones, -you need to go through the process above from steps 3 (first run of -\LaTeX{}) to 6, again, before the document is once again stable. -These four mandatory runs of \LaTeX{} make processing a document with -a bibliography even more tiresome than the normal two runs required to -resolve labels. - -To summarise: processing to resolve citations requires: \LaTeX{}; -\BibTeX{}; \LaTeX{}; \LaTeX{}. - -\Question[Q-whatbst]{Choosing a bibliography style} - -A large proportion of people are satisfied with one of Patashnik's -original ``standard'' styles, \Package{plain}, \Package{unsrt}, -\Package{abbrv} and \Package{alpha}. However, no style in that set -supports the ``author-date'' citation style that is popular in many -fields; but there are a very large number of contributed styles -available, that \emph{do} support the format. - -(Note that author-date styles arose because the simple and clear -citation style that \Package{plain} produces is so awkward in a -traditional manuscript preparation scenario. However, \TeX{}-based -document production does away with all those difficulties, leaving us -free once again to use the simple option.) - -Fortunately, help is at hand, on the Web, with this problem: -\begin{itemize} -\item a sample text, showing the sorts of style choices available, can - be found on -\begin{narrowversion} - Ken Turner's web site: - \URL{http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html}; -\end{narrowversion} -\begin{wideversion} - % ! line break - \href{http://www.cs.stir.ac.uk/~kjt/software/latex/showbst.html}{Ken Turner's web site}; -\end{wideversion} -\item an excellent survey, that lists a huge variety of styles, - sorted into their nominal topics as well as providing a good range - of examples, is the Reed College % ! line break -\begin{narrowversion} - ``Choosing a \BibTeX{} style'' - (\URL{http://web.reed.edu/cis/help/LaTeX/bibtexstyles.html}). -\end{narrowversion} -\begin{wideversion} - % ! line break - ``\href{http://web.reed.edu/cis/help/LaTeX/bibtexstyles.html}{Choosing a \BibTeX{} style}''. -\end{wideversion} -\end{itemize} - -Of course, these pages don't cover everything; the problem the -inquisitive user faces, in fact, is to find what the various available -styles actually do. This is best achieved (if the links above don't -help) by using \Package{xampl.bib} from the \BibTeX{} documentation -distribution: one can get a pretty good feel for any style one has to -hand using this ``standard'' bibliography. For style -\Package{my-style.bst}, the simple \LaTeX{} document: -\begin{quote} -\begin{verbatim} -\documentclass{article} -\begin{document} -\bibliographystyle{my-style} -\nocite{*} -\bibliography{xampl} -\end{document} -\end{verbatim} -\end{quote} -will produce a representative sample of the citations the style will -produce. (Because \Package{xampl.bib} is so extreme in some of its -``examples'', the \BibTeX{} run will also give you an interesting -selection of \BibTeX{}'s error messages\dots{}) -\begin{ctanrefs} -\item[xampl.bib]\CTANref{xampl-bib} -\end{ctanrefs} - -\Question[Q-chapbib]{Separate bibliographies per chapter?} - -A separate bibliography for each `chapter' of a document can be provided -with the package \Package{chapterbib} (which comes with a bunch of -other good bibliographic things). The package allows you a -different bibliography for each \csx{include}d file (i.e., despite the -package's name, the availability of bibliographies is related to the -component source files of the document rather than to the chapters that -logically structure the document). - -The package \Package{bibunits} ties bibliographies to logical units -within the document: the package will deal with chapters and sections -(as defined by \LaTeX{} itself) and also defines a \environment{bibunit} -environment so that users can select their own structuring. -\begin{ctanrefs} -\item[chapterbib.sty]\CTANref{cite} -\item[bibunits.sty]\CTANref{bibunits} -\end{ctanrefs} - -\Question[Q-multbib]{Multiple bibliographies?} - -If you're thinking of multiple bibliographies tied to some part of -your document (such as the chapters within the document), please see -\Qref[question]{bibliographies per chapter}{Q-chapbib}. - -For more than one bibliography, there are three options. - -The \Package{multibbl} package offers a very simple interface: you use -a command \csx{newbibliography} to define a bibliography ``tag''. The package -redefines the other bibliography commands so that each time you use any one -of them, you give it the tag for the bibliography where you want the -citations to appear. The \csx{bibliography} command itself also takes -a further extra argument that says what title to use for the resulting -section or chapter (i.e., it patches -\nothtml{\csx{refname} and \csx{bibname}~---} -\Qref{\csx{refname} and \csx{bibname}}{Q-fixnam}\nothtml{~---} in a -\Package{babel}-safe way). So one might write: -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -\usepackage{multibbl} -\newbibliography{bk} -\bibliographystyle{bk}{alpha} -\newbibliography{art} -\bibliographystyle{art}{plain} -... -\cite[pp.~23--25]{bk}{milne:pooh-corner} -... -\cite{art}{einstein:1905} -... -\bibliography{bk}{book-bib}% - {References to books} -\bibliography{art}{art-bib}% - {References to articles} -\end{verbatim} -\end{quote} -\end{narrowversion} -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\usepackage{multibbl} -\newbibliography{bk} -\bibliographystyle{bk}{alpha} -\newbibliography{art} -\bibliographystyle{art}{plain} -... -\cite[pp.~23--25]{bk}{milne:pooh-corner} -... -\cite{art}{einstein:1905} -... -\bibliography{bk}{book-bib}{References to books} -\bibliography{art}{art-bib}{References to articles} -\end{verbatim} -\end{quote} -\end{wideversion} -(Note that the optional argument of \csx{cite} appears \emph{before} the -new tag argument, and that the \csx{bibliography} commands may list -more than one \extension{bib} file~--- indeed all \csx{bibliography} commands -may list the same set of files.) - -The \csx{bibliography} data goes into files whose names are -\meta{tag-name}\emph{.aux}, so you will need to run -\begin{quote} -\begin{verbatim} -bibtex bk -bibtex art -\end{verbatim} -\end{quote} -after the first run of \LaTeX{}, to get the citations in the correct -place. - -The \Package{multibib} package allows you to define a series of -``additional topics'', each of which comes with its own series of -bibliography commands. So one might write: -\begin{quote} -\begin{verbatim} -\usepackage{multibib} -\newcites{bk,art}% - {References from books,% - References from articles} -\bibliographystylebk{alpha} -\bibliographystyleart{plain} -... -\citebk[pp.~23--25]{milne:pooh-corner} -... -\citeart{einstein:1905} -... -\bibliographybk{book-bib} -\bibliographyart{art-bib} -\end{verbatim} -\end{quote} -Again, as for \Package{multibbl}, any \csx{bibliography...} command may -scan any list of \extension{bib} files. - -\BibTeX{} processing with \Package{multibib} is much like that with -\Package{multibbl}; with the above example, one needs: -\begin{quote} -\begin{verbatim} -bibtex bk -bibtex art -\end{verbatim} -\end{quote} -Note that, unlike \Package{multibbl}, \Package{multibib} allows a -simple, unmodified bibliography (as well as the ``topic'' ones). - -The \Package{bibtopic} package allows you separately to cite several -different bibliographies. At the appropriate place in your document, -you put a sequence of \environment{btSect} environments (each of which -specifies a bibliography database to scan) to typeset the separate -bibliographies. Thus, one might have a file \File{diss.tex} containing: -\begin{quote} -\begin{verbatim} -\usepackage{bibtopic} -\bibliographystyle{alpha} -... -\cite[pp.~23--25]{milne:pooh-corner} -... -\cite{einstein:1905} -... -\begin{btSect}{book-bib} -\section{References from books} -\btPrintCited -\end{btSect} -\begin{btSect}[plain]{art-bib} -\section{References from articles} -\btPrintCited -\end{btSect} -\end{verbatim} -\end{quote} -Note the different way of specifying a bibliographystyle: if you want -a different style for a particular bibliography, you may give it as an -optional argument to the \environment{btSect} environment. - -Processing with \BibTeX{}, in this case, uses \extension{aux} files whose names -are derived from the name of the base document. So in this example -you need to say: -\begin{quote} -\begin{verbatim} -bibtex diss1 -bibtex diss2 -\end{verbatim} -\end{quote} - -There is also a command \csx{btPrintNotCited}, which gives the rest of -the content of the database (if nothing has been cited from the -database, this is equivalent to \LaTeX{} standard \cmdinvoke{nocite}{*}). - -However, the \emph{real} difference from \Package{multibbl} and -\Package{multibib} is that selection of what appears in each -bibliography section is determined in \Package{bibtopic} by what's in -the \extension{bib} files. - -An entirely different approach is taken by the \Package{splitbib} -package. You provide a \environment{category} environment, in the -preamble of your document, for each category you want a separate -citation list for. In each environment, you list the \csx{cite} keys -that you want listed in each category. The \csx{bibliography} command -(or, more precisely, the \environment{thebibliography} environment it -uses) will sort the keys as requested. (Keys not mentioned in a -\environment{category} appear in a ``misc'' category created in the -sorting process.) A code example appears in the package documentation -(a \acro{PDF} file in the \acro{CTAN} directory, -\begin{htmlversion} - which you can browse to, from the link, below). -\end{htmlversion} -\htmlignore - see the file list, below). -\endhtmlignore -\begin{ctanrefs} -\item[bibtopic.sty]\CTANref{bibtopic} -\item[multibbl.sty]\CTANref{multibbl} -\item[multibib.sty]\CTANref{multibib} -\item[splitbib.sty]\CTANref{splitbib} -\end{ctanrefs} - - -\Question[Q-bibinline]{Putting bibliography entries in text} - -This is a common requirement for journals and other publications in -the humanities. Sometimes the requirement is for the entry to appear -in the running text of the document, while other styles require that -the entry appear in a footnote. - -Options for entries in running text are -\begin{itemize} -\item The package \Package{bibentry}, which puts slight restrictions - on the format of entry that your \extension{bst} file generates, but is - otherwise undemanding of the bibliography style. -\item The package \Package{inlinebib}, which requires that you use its - \File{inlinebib.bst}. \Package{Inlinebib} was actually designed for - footnote citations: its \emph{expected} use is that you place a - citation inline as the argument of a \csx{footnote} command. -\item The package \Package{jurabib}, which was originally designed for - German law documents, and has comprehensive facilities for the - manipulation of citations. The package comes with four bibliography - styles that you may use: \File{jurabib.bst}, \File{jhuman.bst} and - two Chicago-like ones. -\end{itemize} - -Options for entries in footnotes are -\begin{itemize} -\item The package \Package{footbib}, and -\item Packages \Package{jurabib} and \Package{inlinebib}, again. -\end{itemize} -Note that \Package{jurabib} does the job using \LaTeX{}'s standard -footnotes, whereas \Package{footbib} creates its own sequence of -footnotes. Therefore, in a document which has other footnotes, it may -be advisable to use \Package{jurabib} (or of course -\Package{inlinebib}), to avoid confusion of footnotes and foot-citations. -\begin{ctanrefs} -\item[bibentry.sty]\emph{Distributed with} \CTANref{natbib} -\item[footbib.sty]\CTANref{footbib} -\item[inlinebib.sty]\CTANref{inlinebib} -\item[jurabib.sty]\CTANref{jurabib} -\end{ctanrefs} - -\Question[Q-citesort]{Sorting and compressing citations} - -If you give \LaTeX{} -\cmdinvoke{cite}{fred,joe,harry,min}, its default commands could give -something like ``[2,6,4,3]''; -this looks awful. One can of course get the things in order by -rearranging the keys in the \csx{cite} command, but who wants to do -that sort of thing for no more improvement than ``[2,3,4,6]''? - -The \Package{cite} package sorts the numbers and detects consecutive -sequences, so creating ``[2--4,6]''. The \Package{natbib} package, -with the \texttt{numbers} and \texttt{sort\&compress} options, will -do the same when working with its own numeric bibliography styles -(\File{plainnat.bst} and \File{unsrtnat.bst}). - -If you might need to make hyperreferences to your citations, -\Package{cite} isn't adequate. If you add the \Package{hypernat} -package: -\begin{verbatim} - \usepackage[...]{hyperref} - \usepackage[numbers,sort&compress]{natbib} - \usepackage{hypernat} - ... - \bibliographystyle{plainnat} -\end{verbatim} -the \Package{natbib} and \Package{hyperref} packages will interwork. -\begin{ctanrefs} -\item[cite.sty]\CTANref{cite} -\item[hypernat.sty]\CTANref{hypernat} -\item[hyperref.sty]\CTANref{hyperref} -\item[plainnat.bst]Distributed with \CTANref{natbib} -\item[unsrtnat.bst]Distributed with \CTANref{natbib} -\end{ctanrefs} - -\Question[Q-mcite]{Multiple citations} - -A convention sometimes used in physics journals is to ``collapse'' a group of -related citations into a single entry in the bibliography. \BibTeX{}, -by default, can't cope with this arrangement, but the \Package{mcite} -and \Package{mciteplus} packages deal with the problem. - -\Package{mcite} overloads the \csx{cite} command to recognise a -``\texttt{*}'' at the start of a key, so that citations of the form -\begin{quote} -\begin{verbatim} -\cite{paper1,*paper2} -\end{verbatim} -\end{quote} -appear in the document as a single citation, and appear arranged -appropriately in the bibliography itself. You're not limited to -collapsing just two references. You can mix ``collapsed'' references -with ``ordinary'' ones, as in -\begin{quote} -\begin{verbatim} -\cite{paper0,paper1,*paper2,paper3} -\end{verbatim} -\end{quote} -Which will appear in the document as 3~citations ``[4,7,11]'' -(say)~--- citation `4' will refer to paper~0, `7' will refer to a -combined entry for paper~1 and paper~2, and `11' will refer to -paper~3. - -You need to make a small change to the bibliography style -(\extension{bst}) file you use; the \Package{mcite} package -documentation tells you how to do that. - -(Despite these multiple citations being primarily a physics-oriented -requirement, the \Class{RevTeX} (Physics support) class doesn't work -with \Package{mcite}. - -The \Package{mciteplus} package adresses many of the infelicites of -\Package{mcite}, and \emph{does} work with \Class{RevTeX}. Again, -`ordinary' \extension{bst} files will not work with -\Package{mciteplus}, but the package documentation explains how to -patch an existing \BibTeX{} style. - -The \Package{collref} package takes a rather different approach to the -problem, and will work with most (if not all) \BibTeX{} packages. -\Package{Collref} spots common subsets of the references, so if it -sees a sequence -\begin{quote} -\begin{verbatim} -\cite{paper0,paper1,paper2,paper3} -... -\cite{some_other_paper,paper1,paper2,and_another} -\end{verbatim} -\end{quote} -it will collect \texttt{paper1} and \texttt{paper2} as a multiple reference. -\begin{ctanrefs} -\item[collref.sty]\CTANref{collref} -\item[mcite.sty]\CTANref{mcite} -\item[mciteplus.sty]\CTANref{mciteplus} -\item[revtex \nothtml{\rmfamily}bundle]\CTANref{revtex} -\end{ctanrefs} - -\Question[Q-backref]{References from the bibliography to the citation} - -A link (or at least a page reference), from the bibliography to the -citing command, is often useful in large documents. - -Two packages support this requirement, \Package{backref} and -\Package{citeref}. \Package{Backref} is part of the -\Package{hyperref} bundle, and supports hyperlinks back to the citing -command. \Package{Citeref} is the older, and seems to rely on rather -simpler (and therefore possibly more stable) code. Neither collapses -lists of pages (``\texttt{5, 6, 7}'' comes out as such, rather than as -``\texttt{5--7}''), but neither package repeats the reference to a page that -holds multiple citations. (The failure to collapse lists is of course -forgiveable in the case of the \Package{hyperref}-related -\Package{backref}, since the concept of multiple hyperlinks from the -same anchor is less than appealing.) -\begin{ctanrefs} -\item[backref.sty]Distributed with \CTANref{hyperref} -\item[citeref.sty]\CTANref{citeref} -\end{ctanrefs} - -\Question[Q-sortbib]{Sorting lists of citations} - -\BibTeX{} has a sorting function, and most \BibTeX{} styles sort the -citation list they produce; most people find this desirable. - -However, it is perfectly possible to write a -\environment{thebibliography} environment that \emph{looks} as if it -came from \BibTeX{}, and many people do so (in order to save time in -the short term). - -The problem arises when \environment{thebibliography}-writers decide -their citations need to be sorted. A common misapprehension is to -insert \cmdinvoke{bibliographystyle}{alpha} (or similar) and expect -the typeset output to be sorted in some magical way. \BibTeX{} -doesn't work that way!~--- if you write \environment{thebibliography}, -you get to sort its contents. \BibTeX{} will only sort the contents -of a \environment{thebibliography} environment when it creates it, to -be inserted from a \extension{bbl} file by a \csx{bibliography} command. - -\Question[Q-compactbib]{Reducing spacing in the bibliography} - -Bibliographies are, in fact, implemented as lists, so all the -confusion about \Qref*{reducing list item spacing}{Q-complist} also -applies to bibliographies. - -If the \Package{natbib} package `works' for you (it may not if you are using -some special-purpose bibliography style), the solution is relatively -simple~--- add -\begin{quote} -\begin{verbatim} -\usepackage{natbib} -\setlength{\bibsep}{0.0pt} -\end{verbatim} -\end{quote} -to the preamble of your document. - -The \Package{compactbib} package has a similar effect. Its primary -purpose is to produce two bibliographies, and it seems to preclude use -of \BibTeX{} (though the package documentation, in the package file -itself, isn't particularly clear). - -Otherwise, one is into unseemly hacking of something or other. The -\Package{mdwlist} package actually does the job, but it doesn't work -here, because it makes a different-named list, while the name -``\environment{thebibliography}'' is built into \LaTeX{} and -\BibTeX{}. Therefore, we need to % ! line break -\Qref*{patch the underlying macro}{Q-patch}: -\begin{quote} -\begin{verbatim} -\let\oldbibliography\thebibliography -\renewcommand{\thebibliography}[1]{% - \oldbibliography{#1}% - \setlength{\itemsep}{0pt}% -} -\end{verbatim} -\end{quote} -The \Package{savetrees} package performs such a patch, among a -plethora of space-saving measures: you can, in principle, suppress all -its other actions, and have it provide you a compressed bibliography -\emph{only}. -\begin{ctanrefs} -\item[compactbib.sty]\CTANref{compactbib} -\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} -\item[natbib.sty]\CTANref{natbib} -\item[savetrees.sty]\CTANref{savetrees} -\end{ctanrefs} - -\Question[Q-bibtocorder]{Table of contents rearranges ``\Package{unsrt}'' ordering} - -If you're using the \Package{unsrt} bibliography style, you're -expecting that your bibliography will \emph{not} be sorted, but that -the entries will appear in the order that they first appeared in your -document. - -However, if you're unfortunate enough to need a citation in a section -title, and you also have a table of contents, the citations that now -appear in the table of contents will upset the ``natural'' ordering -produced by the \Package{unsrt} style. Similarly, if you have -citations in captions, and have a list of figures (or tables). - -There's a pretty simple ``manual'' method for dealing with the -problem~--- when you have the document stable: -\begin{enumerate} -\item Delete the \extension{aux} file, and any of \extension{toc}, - \extension{lof}, \extension{lot} files. -\item Run \LaTeX{}. -\item Run \BibTeX{} for the last time. -\item Run \LaTeX{} often enough that things are stable again. -\end{enumerate} -Which is indeed simple, but it's going to get tedious when you've -found errors in your ``stable'' version, often enough. - -The package \Package{notoccite} avoids the kerfuffle, and suppresses -citations while in the table of contents, or lists of figures, tables -(or other floating things: the code is quite general). -\begin{ctanrefs} -\item[notoccite.sty]\CTANref{notoccite} -\end{ctanrefs} - -\Question[Q-i18nbib]{Non-english bibliographies} - -Like so much of early \AllTeX{} software, \BibTeX{}'s assumptions were -firmly rooted in what its author knew well, viz., academic papers in -English (particularly those with a mathematical bent). \BibTeX{}'s -standard styles all address exactly that problem, leaving the user who -writes in another language (or who deal with citations in the style of -other disciplines than maths) to strike out into contributed software. - -For the user whose language is not English, there are several -alternatives. The simplest is to provide translations of \BibTeX{} -styles into the required language: the solitary \Package{finplain.bst} -does that for Finnish; others one can find are for Danish -(\Package{dk-bib}), French (\Package{bib-fr}), German -(\Package{bibgerm}), Norwegian (\Package{norbib}) and Swedish -(\Package{swebib}) bundles (of which the \Package{bib-fr} set is the -most extensive). The \Package{spain} style implements a traditional -Spanish citation style. - -These static approaches solve the problem, for the languages that have -been covered by them. Unfortunately, with such an approach, a lot of -work is needed for every language involved. Two routes to a solution -of the ``general'' problem are available~--- that offered by -\Package{babelbib}, and the % ! line break -\Qref*{\Package{custom-bib} mechanism for generating styles}{Q-custbib}. - -\Package{Babelbib} (which is a development of the ideas of the -\Package{bibgerm} package) co-operates with \Package{babel} to control -the language of presentation of citations (potentially at the level of -individual items). The package has a built-in set of languages it -`knows about', but the documentation includes instructions on defining -commands for other languages. \Package{Babelbib} comes with its own -set of bibliography styles, which could be a restriction if there -wasn't also a link from \Package{custom-bib}. - -The \Package{makebst} menu of \Package{custom-bib} allows you to -choose a language for the \BibTeX{} style you're generating (there are -14 languages to choose; it looks as if \Package{spain.bst}, mentioned -above, was generated this way). If, however, you opt not to specify a -language, you are asked whether you want the style to interact with -\Package{babelbib}; if you do so, you're getting the best of both -worlds~--- formatting freedom from \Package{custom-bib} and linguistic -freedom via the extensibility of \Package{babelbib} -\begin{ctanrefs} -\item[babelbib.sty]\CTANref{babelbib} -\item[bib-fr \nothtml{\rmfamily\upshape}bundle]\CTANref{bib-fr} -\item[bibgerm \nothtml{\rmfamily\upshape}bundle]\CTANref{bibgerm} -\item[custom-bib \nothtml{\rmfamily\upshape}bundle]\CTANref{custom-bib} -\item[finplain.bst]\CTANref{finplain} -\item[norbib \nothtml{\rmfamily\upshape}bundle]\CTANref{norbib} -\item[spain]\CTANref{spain} -\item[swebib \nothtml{\rmfamily\upshape}bundle]\CTANref{swebib} -\end{ctanrefs} - -\Question[Q-formbiblabel]{Format of numbers in the bibliography} - -By default, \LaTeX{} makes entries in the bibliography look like: -\begin{quote} - [1] Doe, Joe et al. Some journal. 2004.\\ {} - [2] Doe, Jane et al. Some journal. 2003. -\end{quote} -while many documents need something like: -\begin{quote} - 1. Doe, Joe et al. Some journal. 2004.\\ - 2. Doe, Jane et al. Some journal. 2003. -\end{quote} - -This sort of change may be achieved by many of the ``general'' -citation packages; for example, in \Package{natbib}, it's as simple as: -\begin{quote} -\begin{verbatim} -\renewcommand{\bibnumfmt}[1]{#1.} -\end{verbatim} -\end{quote} -but if you're not using such a package, the following internal -\LaTeX{} commands, in the preamble of your document, will do the job: -\begin{quote} -\begin{verbatim} -\makeatletter -\renewcommand*{\@biblabel}[1]{\hfill#1.} -\makeatother -\end{verbatim} -\end{quote} -\begin{ctanrefs} -\item[natbib.sty]\CTANref{natbib} -\end{ctanrefs} - -\subsection{Manipulating whole bibliographies} - -\Question[Q-nocite*]{Listing all your \BibTeX{} entries} - -\LaTeX{} and \BibTeX{} co-operate to offer special treatment of this -requirement. The command \cmdinvoke{nocite}{*} is specially treated, -and causes \BibTeX{} to generate bibliography entries for every entry -in each \extension{bib} file listed in your \csx{bibliography} statement, so -that after a \LaTeX{}--\BibTeX{}--\LaTeX{} sequence, you have a -document with the whole thing listed. - -Note that \LaTeX{} \emph{doesn't} produce -% beware line breaks -``\texttt{Citation ... undefined}'' or -``\texttt{There were undefined references}'' warnings in respect of -\cmdinvoke{nocite}{*}. This isn't a problem if you're running -\LaTeX{} ``by hand'' (you \emph{know} exactly how many times you have -to run things), but the lack might confuse automatic processors that -scan the log file to determine whether another run is necessary. - -A couple of packages are available, that aim to reduce the impact of -\cmdinvoke{nocite}{*} of a large citation database. \Package{Biblist} -was written for use under \LaTeXo{}, but seems to work well enough; -\Package{listbib} is more modern. Both provide their own -\extension{bst} files. (The impact of large databases was significant -in the old days of \LaTeX{} systems with very little free memory; this -problem is less significant now than it once was.) -\begin{ctanrefs} -\item[biblist.sty]\CTANref{biblist} -\item[listbib.sty]\CTANref{listbib} -\end{ctanrefs} - -\Question[Q-htmlbib]{Making \acro{HTML} of your Bibliography} - -A neat solution is offered by the \Package{noTeX} bibliography style. -This style produces a \extension{bbl} file which is in fact a series of -\acro{HTML} `\texttt{P}' elements of class \texttt{noTeX}, and which -may therefore be included in an \acro{HTML} file. Provision is made -for customising your bibliography so that its content when processed by -\Package{noTeX} is different from that presented when it is processed -in the ordinary way by \AllTeX{}. - -A thorough solution is offered by \Package{bib2xhtml}; using it, you -make use of one of its modified versions of many common \BibTeX{} -styles, and post-process the output so produced using a -\ProgName{perl} script. - -A more conventional translator is the \ProgName{awk} script -\ProgName{bbl2html}, which translates the \extension{bbl} file you've generated: -a sample of the script's output may be viewed on the web, at -\URL{http://rikblok.cjb.net/lib/refs.html} -\begin{ctanrefs} -\item[bbl2html.awk]\CTANref{bbl2html} -\item[bib2xhtml]\CTANref{bib2xhtml} -\item[noTeX.bst]\CTANref{noTeX} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Adjusting the typesetting} - -\subsection{Alternative document classes} - -\Question[Q-replstdcls]{Replacing the standard classes} - -People are forever concocting classes that replace the standard ones: -the present author produced an \Class{ukart} class that used the -\Package{sober} package, and a few British-specific things (such as -appear in the \Package{babel} package's British-english -specialisation) in the 1980s, which is still occasionally used. - -Similar public efforts were available well back in the days of -\LaTeXo{}: a notable example, whose pleasing designs seem not to have -changed much over all that time, is the \Class{ntgclass} bundle. -Each of the standard classes is replaced by a selection of classes, -named in Dutch, sometimes with a single numeric digit attached. So we -have classes \Class{artikel2}, \Class{rapport1}, \Class{boek3} and -\Class{brief}. These classes are moderately well documented in -English. - -The \Class{KOMA-script} bundle (classes named \Class{scr...}) are a -strong current contender. They are actively supported, are -comprehensive in their coverage of significant typesetting issues, -produce good-looking output and are well documented in both English -and German (\Package{scrguien} in the distribution for English, -\Package{scrguide} for German). - -The other comparable class is \Class{memoir}. This aims to replace -\Class{book} and \Class{report} classes directly, and (like -\Class{KOMA-script}) is comprehensive in its coverage of small issues. -\Class{Memoir}'s documentation (\Package{memman}) is very highly -spoken of, and its lengthy introductory section is regularly -recommended as a tutorial on typesetting. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}KOMA-script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[\nothtml{\rmfamily}NTGclass bundle]\CTANref{ntgclass} -\item[sober.sty]\CTANref{sober} -\end{ctanrefs} - -\Question[Q-slidecls]{Producing slides} - -Lamport's original \LaTeX{} had a separate program (Sli\TeX{}) for -producing slides; it dates from the age when colour effects were -produced by printing separate slides in different-coloured inks, and -overlaying them, and was just about acceptable back then. When -\LaTeXe{} came along, the reason Sli\TeX{} had to be a separate -program went away, and its functionality was supplied by the -\Class{slides} class. While this makes life a little easier for -system administrators, it does nothing for the inferior functionality -of the class: no-one ``who knows'' uses \Class{slides} nowadays. - -The `classic' alternatives have been \Class{seminar} and \Class{foils} -(originally known as Foil\TeX{}). Both were originally designed to -produce output on acetate foils, though subsequent work has provided -environments in which they can be used with screen projectors (see -below). - -The advent of Microsoft \ProgName{PowerPoint} (feeble though early -versions of it were) has created a demand for ``dynamic'' slides~--- -images that develop their content in a more elaborate fashion than by -merely replacing one foil with the next in the way that was the norm -when \Class{slides}, \Class{foils} and \Class{seminar} were designed. - -The \Class{prosper} class builds on \Class{seminar} to provide dynamic -effects and the like; it retains the ability to provide \acro{PDF} for -a projected presentation, or to print foils for a foil-based -presentation. The add-on package \Package{ppr-prv} adds ``preview'' -facilities (that which is commonly called ``hand-out printing''). The -\Package{HA-prosper} package, which you load with \Class{prosper}, -mends a few bugs, and adds several facilities and slide design styles. -The (relatively new) \Class{powerdot} class is designed as a -replacement for \Class{prosper} and \Package{HA-prosper}, co-authored -by the author of \Package{HA-prosper}. - -\Class{Beamer} is a relatively easy-to-learn, yet powerful, class that -(as its name implies) was designed for use with projection displays. -It needs the \Package{pgf} package (for graphics support), which in -turn requires \Package{xcolor}; while this adds to the tedium of -installing \Class{beamer} ``from scratch'', both are good additions to -a modern \LaTeX{} installation. \Class{Beamer} has reasonable -facilities for producing printed copies of slides. - -\Class{Talk} is another highly functional, yet easy-to-learn class -which claims to differ from the systems mentioned above, such as -\Class{beamer}, in that it doesn't impose a slide style on you. You -get to specify a bunch of slide styles, and you can switch from one to -the other between slides, as you need. (The class itself provides -just the one style, in the package \Package{greybars}: the author -hopes users will contribute their own styles, based on -\Package{greybars}.) - -\ProgName{Ppower4} (commonly known as \ProgName{pp4}) is a -\ProgName{Java}-based support program that will postprocess -\acro{PDF}, to `animate' the file at places you've marked with -commands from one of the \ProgName{pp4} packages. The commands don't -work on \acro{PDF} that has come from \ProgName{dvips} output; they -work with \acro{PDF} generated by \PDFLaTeX{}, V\TeX{} \LaTeX{}, or -\ProgName{dvipdfm} running on \LaTeX{} output. - -\Package{Pdfscreen} and \Package{texpower} are add-on packages that -permit dynamic effects in documents formatted in ``more modest'' -classes; \Package{pdfscreen} will even allow you to plug -``presentation effects'' into an \Class{article}-class document. - -% ifmslide -%\noindent ifmslide: a few slides extolling virtues in \File{doc/ifmman.pdf} - -A more detailed examination of the alternatives (including examples -of code using many of them) may be found at Michael Wiedmann's fine -\URL{http://www.miwie.org/presentations/presentations.html} - -\CONTeXT{} users will find that much (if not all) of what they need is -already in \CONTeXT{} itself; there's a useful summary of what's -available, with examples, in -\URL{http://wiki.contextgarden.net/Presentation_Styles} -% -\begin{ctanrefs} -\item[beamer.cls]Download all of \CTANref{beamer} -\item[foils.cls]\CTANref{foiltex} -\item[greybars.sty]distributed with \CTANref{talk} -\item[HA-prosper.sty]\CTANref{ha-prosper} -%\item[ifmslide.sty]\CTANref{ifmslide} -\item[seminar.cls]\CTANref{seminar} -\item[pgf.sty]\CTANref{pgf} -\item[powerdot.cls]\CTANref{powerdot} -\item[pp4]\CTANref{ppower4} -\item[ppr-prv.sty]\CTANref{ppr-prv} -\item[prosper.cls]\CTANref{prosper} -\item[talk.cls]\CTANref{talk} -\item[texpower]\CTANref{texpower} -\item[xcolor.sty]\CTANref{xcolor} -\end{ctanrefs} - -\Question[Q-poster]{Creating posters with \LaTeX{}} - -There is no complete ``canned solution'' to creating a poster (as, for -example, classes like \Class{seminar}, \Class{powerdot} and -\Class{beamer} serve for creating presentations in a variety of -styles). - -The nearest approach to the complete solution is the \Class{sciposter} -class, which provides the means to produce really rather good posters -according to the author's required style. A complete worked example -is provided with the distribution - -Otherwise, there is a range of tools, most of which are based on the -\Class{a0poster} class, which sets up an appropriately-sized piece of -paper, sets font sizes appropriately, and leaves you to your own -devices. - -Having used \Class{a0poster}, you can of course slog it out, and write -all your poster as an unadorned \LaTeX{} document (presumably in -multiple columns, using the \Package{multicol} package), but it's not really -necessary: the (straightforward) \Package{textpos} package provides a -simple way of positioning chunks of text, or tables or figures, on the -poster page. - -More sophisticated is the \Package{flowfram} package, whose basic aim -in life is flowing text from one box on the page to the next. One of -the package's design aims seems to have been the production of -posters, and a worked example is provided. The author of -\Package{flowfram} has an experimental tool called -\href{http://theoval.cmp.uea.ac.uk/~nlct/jpgfdraw/}{JpgfDraw}, which -allows you to construct the outline of frames for use with -\Package{flowfram}. - -Despite the relative shortage of tools, there are a fair few web pages -that explain the process (mostly in terms of the \Class{a0poster} -route): -\begin{itemize} -\item from Norman Gray, - \href{http://nxg.me.uk/docs/posters/}{Producing posters using \LaTeX{}}; -\item from Nicola Talbot, % ! line break - \href{http://theoval.sys.uea.ac.uk/~nlct/latex/posters/index.html}{Creating technical posters with \LaTeX{}} -\item from ``\emph{awf}'' and ``\emph{capes}'' % ! line break - \href{http://www.robots.ox.ac.uk/~awf/latex-posters/}{Preparing conference posters in \LaTeX{}} - (the page discusses a sample, which you can download); -\item From Rob Clark % ! line break - \href{http://homepages.inf.ed.ac.uk/robert/posters/advanced.html}{Advanced LaTeX Posters} - (which has links to code samples); -\item from Brian Wolven, - \URL{http://fuse.pha.jhu.edu/~wolven/posters.html} (this page also - provides macros and other support suggestions); and -\item from ``\emph{pjh}'' % ! line break - \href{http://www.phys.ufl.edu/~pjh/posters/poster_howto_UF.html}{Making and printing a poster with \LaTeX{}}, - which covers the specific issue of dealing with University of - Florida styled poster (offering supporting material as necessary), - but has hints which are generally useful. -\end{itemize} -\begin{ctanrefs} -\item[a0poster.cls]\CTANref{a0poster} -\item[flowfram.sty]\CTANref{flowfram} -\item[multicol.sty]Distributed as part of \CTANref{2etools} -\item[sciposter.cls]\CTANref{sciposter} -\item[textpos.sty]\CTANref{textpos} -\end{ctanrefs} - -\Question[Q-thesis]{Formatting a thesis in \LaTeX{}} - -Thesis styles are usually very specific to your University, so it's -usually not profitable to ask around for a package outside your own -University. Since many Universities (in their eccentric way) still -require double-spaced thesis text, you may also need separately to set -up \Qref*{double spacing}{Q-linespace}. - -If you want to write a new thesis class of your own, a good place to -start is the University of California style, but remember that it's -often difficult to produce a thesis that both looks good and conforms -with the style that your Univeristy demands. -\begin{ctanrefs} -\item[UC thesis style]\CTANref{ucthesis} -\end{ctanrefs} - -\Question[Q-journalpaper]{Setting papers for journals} - -Publishers of journals have a wide range of requirements for the -presentation of papers, and while many publishers do accept electronic -submissions in \AllTeX{}, they don't often submit recommended macros to -public archives. - -Nevertheless, there are considerable numbers of macros of one sort or -another available on \acro{CTAN}; searching for your journal name in -the CTAN catalogue~--- see % ! line break -\Qref{searching \acro{CTAN}}{Q-findfiles})~--- -may well turn up what you're seeking. - -Failing that, you may be well advised to contact the prospective -publisher of your paper; many publishers have macros on their own web -sites, or otherwise available only upon application. - -Check that the publisher is offering you macros suitable to an -environment you can use: a few still have no macros for current -\LaTeX{}, for example, claiming that \LaTeXo{} is good enough\dots{} - -Some publishers rekey anything sent them anyway, so that it doesn't -really matter what macros you use. Others merely encourage you to use -as few extensions of a standard package as possible, so that they will -find it easy to transform your paper to their own internal form. - -\Question[Q-multidoc]{A `report' from lots of `article's} - -This is a requirement, for example, if one is preparing the -proceedings of a conference whose papers were submitted in \LaTeX{}. - -The nearest things to canned solutions are Peter Wilson's -\Class{combine} and Federico Garcia's \Class{subfiles} classes. - -\Class{Combine} defines the means to `\csx{import}' entire documents, -and provides means of specifying significant features of the layout of -the document, as well as a global table of contents, and so on. An -auxiliary package, \Package{combinet}, allows use of the \csx{title}s -and \csx{author}s (etc.\@) of the \csx{import}ed documents to appear in -the global table of contents. - -\Class{Subfiles} is used in the component files of a multi-file -project, and the corresponding \Package{subfiles} is used in the -master file; arrangements may be made so that the component files will -be typeset using different page format, etc., parameters than those -used when they are typeset as a part of the main file. - -A more `raw' toolkit is offered by Matt Swift's \Package{includex} and -\Package{newclude} packages, both part of the \Package{frankenstein} -bundle. Note that Matt believes \Package{includex} is obsolete -(though it continues to work for this author); furthermore, its -replacement, \Package{newclude} remains ``in development'', as it has -been since 1999. - -Both \Package{includex} and \Package{newclude} enable you to -`\csx{includedoc}' complete articles (in the way that you -`\csx{include}' chapter files in an ordinary report). The preamble -(everything up to \cmdinvoke{begin}{document}), and everything after -\cmdinvoke{end}{document}, is ignored by both packages. Thus the -packages don't ``do the whole job'' for you, though: you need to -analyse the package use of the individual papers, and ensure that a -consistent set is loaded in the preamble of the main report. (Both -packages require \Package{moredefs}, which is also part of the bundle.) - -A completely different approach is to use the \Package{pdfpages} -package, and to include articles submitted in \acro{PDF} format into a -a \acro{PDF} document produced by \PDFLaTeX{}. The package -defines an \csx{includepdf} command, which takes arguments similar to -those of the \csx{includegraphics} command. With keywords in the -optional argument of the command, you can specify which pages you want -to be included from the file named, and various details of the layout -of the included pages. -\begin{ctanrefs} -\item[combine.cls]\CTANref{combine} -\item[combinet.sty]\CTANref{combine} -\item[includex.sty]Distributed in the ``unsupported'' part of - \CTANref{frankenstein} -\item[moredefs.sty]Distributed as part of \CTANref{frankenstein} -\item[newclude.sty]Distributed as part of \CTANref{frankenstein} -\item[pdfpages.sty]\CTANref{pdfpages} -\item[subfiles.cls, etc.]\CTANref{subfiles} -\end{ctanrefs} - -\Question[Q-cv]{\emph{Curriculum Vitae} (R\'esum\'e)} - -Andrej Brodnik's class, \Class{vita}, offers a framework for producing -a \emph{curriculum vitae}. The class may be customised both for -subject (example class option files support both computer scientists -and singers), and for language (both the options provided are -available for both English and Slovene). Extensions may be written by -creating new class option files, or by using macros defined in the -class to define new entry types, etc. - -Didier Verna's class, \Class{curve}, is based on a model in which -the \acro{CV} is made of a set of \emph{rubrics} (each one dealing -with a major item that you want to discuss, such as `education', `work -experience', etc). The class's documentation is supported by a couple -of example files, and an emacs mode is provided. - -Xavier Danaux offers a class \Class{moderncv} which supports -typesetting modern \emph{curricula vitarum}, both in a classic and in a -casual style. It is fairly customizable, allowing you to define your -own style by changing the colours, the fonts, etc. - -The European Commission has recommended a format for % ! line break -\emph{curricula vitarum} within Europe, and Nicola Vitacolonna has -developed a class \Class{europecv} to produce it. While (by his own -admission) the class doesn't solve all problems, it seems well-thought -out and supports all current official EU languages (together with a -few non-official languages, such as Catalan, Galician and Serbian). - -The alternative to using a separate class is to impose a package on -one of the standard classes. An example, -Axel Reichert's \Package{currvita} package, has been recommended to the -\acro{FAQ} team. Its output certainly looks good. - -There is also a \LaTeXo{} package \Package{resume}, which comes with -little but advice \emph{against} trying to use it. -\begin{ctanrefs} -\item[currvita.sty]\CTANref{currvita} -\item[curve.cls]\CTANref{curve} -\item[europecv.cls]\CTANref{europecv} -\item[moderncv.cls]\CTANref{moderncv} -\item[resume.sty]\CTANref{resume} -\item[vita.cls]\CTANref{vita} -\end{ctanrefs} - -\Question[Q-letterclass]{Letters and the like} - -\LaTeX{} itself provides a \Class{letter} document class, which is -widely disliked; the present author long since gave up trying with -it. If you nevertheless want to try it, but are irritated by its way -of vertically-shifting a single-page letter, try the following hack: -\begin{verbatim} -\makeatletter -\let\@texttop\relax -\makeatother -\end{verbatim} -in the preamble of your file. - -Doing-it-yourself is a common strategy; Knuth (for use with -\plaintex{}, in the \TeX{}book), and Kopka and Daly (in their Guide to -\LaTeX{}) offer worked examples. - -Nevertheless, there \emph{are} contributed alternatives~--- in fact -there are an awfully large number of them: the following list, of -necessity, makes but a small selection. - -The largest, most comprehensive, class is \Class{newlfm}; the \texttt{lfm} -part of the name implies that the class can create letters, faxes and -memoranda. The documentation is voluminous, and the package seems -very flexible. - -Axel Kielhorn's \Class{akletter} class is the only other one, -recommended for inclusion in this \acro{FAQ}, whose documentation is -available in English. - -The \Class{dinbrief} class, while recommended, is only documented in -German. - -There are letter classes in each of the excellent -\Class{KOMA-script} (\Class{scrlttr2}: documentation is available in -English) and \Package{ntgclass} (\Class{brief}: documentation in Dutch -only) bundles. While these are probably good (since the bundles -themselves inspire trust) they've not been specifically recommended by -any users. -\begin{ctanrefs} -\item[akletter.cls]\CTANref{akletter} -\item[brief.cls]Distributed as part of \CTANref{ntgclass} -\item[dinbrief.cls]\CTANref{dinbrief} -\item[newlfm.cls]\CTANref{newlfm} -\item[scrlttr2.cls]Distributed as part of \CTANref{koma-script} -\end{ctanrefs} - -\Question[Q-extsizes]{Other ``document font'' sizes?} - -The \LaTeX{} standard classes have a concept of a (base) ``document -font'' size; this size is the basis on which other font sizes (those -from \csx{tiny} to \csx{Huge}) are determined. The classes are designed -on the assumption that they won't be used with sizes other than the -set that \LaTeX{} offers by default (10--12pt), but people regularly -find they need other sizes. The proper response to such a requirement -is to produce a new design for the document, but many people don't -fancy doing that. - -A simple solution is to use the \Package{extsizes} bundle. This -bundle offers ``extended'' versions of the article, report, book and -letter classes, at sizes of 8, 9, 14, 17 and 20pt as well as the -standard 10--12pt. Since little has been done to these classes other -than to adjust font sizes and things directly related to them, they -may not be optimal~--- but they're certainly practical. - -More satisfactory are the \emph{\acro{KOMA}-script} classes, which are -designed to work properly with the class option files that come with -\Package{extsizes}, and the \Class{memoir} class that has its own -options for document font sizes 9pt--12pt, 14pt, 17pt, 20pt, 25pt, -30pt, 36pt, 48pt and 60pt. -\begin{ctanrefs} -\item[extsizes bundle]\CTANref{extsizes} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\subsection{Document structure} - -\Question[Q-titlsty]{The style of document titles} - -The \Package{titling} package provides a number of facilities that -permit manipulation of the appearance of a \csx{maketitle} command, the -\csx{thanks} commands within it, and so on. The package also defines a -\environment{titlingpage} environment, that offers something in between the -standard classes' \pkgoption{titlepage} option and the \environment{titlepage} -environment, and is itself somewhat configurable. - -The memoir class includes all the functionality of the -\Package{titling} package, while the \Class{KOMA-script} classes have -their own range of different titling styles. - -Finally, the indefatigable Vincent Zoonekynd supplies examples of how -to program alternative % don't let this \href suffer a line-break -\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_title/0.html}{title styles}. -The web page is not useful to users unless they are willing to do -their own \LaTeX{} programming. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[titling.sty]\CTANref{titling} -\end{ctanrefs} - -\Question[Q-secthead]{The style of section headings} - -Suppose that the editor of your favourite journal has specified that section -headings must be centred, in small capitals, and subsection headings ragged -right in italic, but that you don't want to get involved in the sort of -programming described in section 2.2 of \emph{The \LaTeX{} Companion} -\begin{narrowversion} % really non-hyper - (\Qref{}{Q-books}; the programming itself is discussed in - \Qref[question]{}{Q-atsigns}). -\end{narrowversion} -\begin{wideversion} % really hyper - (see \Qref{\TeX{}-related books}{Q-books}; the - \Qref{programming}{Q-atsigns} itself is discussed elsewhere in this - \acro{FAQ}). -\end{wideversion} -The following hack will -probably satisfy your editor. Define yourself new commands -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\newcommand{\ssection}[1]{% - \section[#1]{\centering\normalfont\scshape #1}} -\newcommand{\ssubsection}[1]{% - \subsection[#1]{\raggedright\normalfont\itshape #1}} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} % really non-hyper -\begin{verbatim} -\newcommand{\ssection}[1]{% - \section[#1]{\centering - \normalfont\scshape #1}} -\newcommand{\ssubsection}[1]{% - \subsection[#1]{\raggedright - \normalfont\itshape #1}} -\end{verbatim} -\end{narrowversion} -\end{quote} -and then use \csx{ssection} and \csx{ssubsection} in place of -\csx{section} and \csx{subsection}. This isn't perfect: section numbers -remain in bold, and starred forms need a separate redefinition. - -The \Package{titlesec} package offers a structured approach to the -problem, based on redefinition of the sectioning and chapter commands -themselves. This approach allows it to offer radical adjustment: its -options provide (in effect) a toolbox for designing your own -sectioning commands' output. - -The \Package{sectsty} package provides a more simply structured set of -tools; while it is less powerful than is \Package{titlesec}, it is -perhaps preferable for minor adjustments, since you can use it after -having read a smaller proportion of the manual. - -The \Package{fncychap} package provides a nice collection of customised -chapter heading designs. The \Package{anonchap} package provides a -simple means of typesetting chapter headings ``like section headings'' -(i.e., without the ``Chapter'' part of the heading); the -\Package{tocbibind} package provides the same commands, in pursuit of -another end. Unfortunately, \Package{fncychap} is not attuned to the -existence of front- and backmatter in \Class{book} class documents. - -The \Class{memoir} class includes facilities that match -\Package{sectsty} and \Package{titlesec}, as well as a bundle of -chapter heading styles (including an \Package{anonchap}-equivalent). -The \Class{KOMA-script} classes also have sets of tools that provide -equivalent functionality, notably formatting specifications \csx{partformat}, -\csx{chapterformat}, \csx{sectionformat}, \dots{}, as well as several -useful overall formatting specifications defined in class options. - -Finally, the indefatigable Vincent Zoonekynd supplies examples of how -to program alternative % don't let these \href suffer line-breaks -\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_chapter/0.html}{chapter heading styles} -and -\href{http://zoonek.free.fr/LaTeX/LaTeX_samples_section/0.html}{section heading styles}. -The web pages provide programming examples, and expect users to adapt -them to their own \LaTeX{} use. -\begin{ctanrefs} -\item[anonchap.sty]\CTANref{anonchap} -\item[fncychap.sty]\CTANref{fncychap} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[sectsty.sty]\CTANref{sectsty} -\item[titlesec.sty]\CTANref{titlesec} -\item[tocbibind.sty]\CTANref{tocbibind} -\end{ctanrefs} - -\Question[Q-appendix]{Appendixes} - -\LaTeX{} provides an exceedingly simple mechanism for appendixes: the -command \csx{appendix} switches the document from generating sections -(in \Class{article} class) or chapters (in \Class{report} or -\Class{book} classes) to producing appendixes. Section or chapter -numbering is restarted and the representation of the counter switches -to alphabetic. So: -\begin{quote} -\begin{verbatim} -\section{My inspiration} -... - -\section{Developing the inspiration} -... - -\appendix -\section{How I became inspired} -... -\end{verbatim} -\end{quote} -would be typeset (in an \Class{article} document) something like: -\begin{quote} -\textbf{1~~My inspiration} - -\dots{} - -\textbf{2~~Developing the inspiration} - -\dots{} - -\textbf{A~~How I became inspired} - -\dots{} -\end{quote} -which is quite enough for many ordinary purposes. Note that, once -you've switched to typesetting appendixes, \LaTeX{} provides you with -no way back~--- once you've had an appendix, you can no longer have an -``ordinary'' \csx{section} or \csx{chapter}. - -The \Package{appendix} provides several ways of elaborating on this -simple setup. Straightforward use of the package allows you to have a -separate heading, both in the body of the document and the table of -contents; this would be achieved by -\begin{quote} -\begin{verbatim} -\usepackage{appendix} -... -\appendix -\appendixpage -\addappheadtotoc -\end{verbatim} -\end{quote} -The \csx{appendixpage} command adds a separate title ``Appendices'' -above the first appendix, and \csx{addappheadtotoc} adds a similar -title to the table of contents. These simple modifications cover many -people's needs about appendixes. - -The package also provides an \environment{appendices} environment, -which provides for fancier use. The environment is best controlled by -package options; the above example would be achieved by -\begin{quote} -\begin{verbatim} -\usepackage[toc,page]{appendix} -... -\begin{appendices} -... -\end{appendices} -\end{verbatim} -\end{quote} -The great thing that the \environment{appendices} environment gives -you, is that once the environment ends, you can carry on with sections -or chapters as before~--- numbering isn't affected by the intervening -appendixes. - -The package provides another alternative way of setting appendixes, as -inferior divisions in the document. The \environment{subappendices} -environment allows you to put separate appendixes for a particular -section, coded as \csx{subsection}s, or for a particular chapter, coded -as \csx{section}s. So one might write: -\begin{quote} -\begin{verbatim} -\usepackage{appendix} -... -\section{My inspiration} -... -\begin{subappendices} -\subsection{How I became inspired} -... -\end{subappendices} - -\section{Developing the inspiration} -... -\end{verbatim} -\end{quote} -Which will produce output something like: -\begin{quote} -\textbf{1~~My inspiration} - -\dots{} - -\textbf{1.A~~How I became inspired} - -\dots{} - -\textbf{2~~Developing the inspiration} - -\dots{} -\end{quote} - -There are many other merry things one may do with the package; the -user is referred to the package documentation for further details. - -The \Class{memoir} class includes the facilities of the -\Package{appendix} package. The \Class{KOMA-script} classes offer a -\csx{appendixprefix} command for manipulating the appearance of appendixes. -\begin{ctanrefs} -\item[appendix.sty]\CTANref{appendix} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-secindent]{Indent after section headings} - -\LaTeX{} implements a style that doesn't indent the first paragraph -after a section heading. There are coherent reasons for this, but not -everyone likes it. -The \Package{indentfirst} package -suppresses the mechanism, so that the first paragraph is -indented. -\begin{ctanrefs} -\item[indentfirst.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-subsubsub]{How to create a \csx{subsubsubsection}} - -\LaTeX{}'s set of ``sections'' stops at the level of -\csx{subsubsection}. This reflects a design decision by Lamport~--- -for, after all, who can reasonably want a section with such huge -strings of numbers in front of it? - -In fact, \LaTeX{} standard classes \emph{do} define ``sectioning'' -levels lower than \csx{subsubsection}, but they don't format them like -sections (they're not numbered, and the text is run-in after the -heading). These deeply inferior section commands are \csx{paragraph} -and \csx{subparagraph}; you can (if you \emph{must}) arrange that these -two commands produce numbered headings, so that you can use them as -\csx{subsubsubsection}s and lower. - -The \Package{titlesec} allows you to adjust the definitions of the -sectioning macros, and it may be used to -transform a \csx{paragraph}'s typesetting so that it looks like that -of a \csx{section}. - -If you want to program the change yourself, you'll find that the -commands (\csx{section} all the way down to \csx{subparagraph}) are -defined in terms of the internal \csx{@startsection} command, which -takes 6~arguments. Before attempting this sort of work, you are well -advised to read the \LaTeX{} sources (\File{ltsect.dtx} in the -\LaTeX{} distribution) and the source of the standard packages -(\File{classes.dtx}). The \Qref*{\LaTeX{} Companion}{Q-books} -discusses use of \csx{@startsection} for this sort of thing. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\LaTeX{} source]\CTANref{latex} -\item[titlesec.sty]\CTANref{titlesec} -\end{ctanrefs} - -\Question[Q-captsty]{The style of captions} - -Changes to the style of captions may be made by redefining the commands -that produce the caption. So, for example, \csx{fnum@figure} (which -produces the float number for figure floats) may be redefined, in a -package of your own, or between -\Qref*{\csx{makeatletter}--\csx{makeatother}}{Q-atsigns}: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\renewcommand{\fnum@figure}{\textbf{Fig.~\thefigure}} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\renewcommand{\fnum@figure}% - {\textbf{Fig.~\thefigure}} -\end{verbatim} -\end{narrowversion} -\end{quote} -which will cause the number to be typeset in bold face. (Note that -the original definition used \nothtml{\csx{figurename}~--- }% -\Qref{\csx{figurename}}{Q-fixnam}.) More elaborate changes can be -made by patching the \csx{caption} command, but since there are -packages to do the job, such changes (which can get rather tricky) -aren't recommended for ordinary users. - -The \Package{float} package provides some control of the appearance of -captions, though it's principally designed for the creation of -non-standard floats. The \Package{caption} and \Package{ccaption} -(note the double ``\emph{c}'') packages provide a range of different -formatting options. - -\Package{ccaption} also provides `continuation' captions and captions -that can be placed outside of float environments. The (very simple) -\Package{capt-of} package also allows captions outside a float -environment. Note that care is needed when doing things that assume -the sequence of floats (as in continuation captions), or potentially -mix non-floating captions with floating ones. - -The \Class{memoir} class includes the facilities of the -\Package{ccaption} package; the \Class{KOMA-script} classes also -provide a wide range of caption-formatting commands. - -The documentation of \Package{caption} is available by processing a -file \File{manual.tex}, which is created when you unpack -\File{caption.dtx} - -Note that the previously-recommended package \Package{caption2} has -now been overtaken again by \Package{caption}; however, -\Package{caption2} remains available for use in older documents. -\begin{ctanrefs} -\item[caption.sty]\CTANref{caption} -\item[capt-of.sty]\CTANref{capt-of} -\item[ccaption.sty]\CTANref{ccaption} -\item[float.sty]\CTANref{float} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-fancyhdr]{Alternative head- and footlines in \LaTeX{}} - -The standard \LaTeX{} document classes define a small set of `page -styles' which specify head- and footlines for your document (though -they can be used for other purposes, too). The standard set is very -limited, but \LaTeX{} is capable of much more. The internal -\LaTeX{} coding needed to change page styles is not particularly -challenging, but there's no need~--- there are packages that provide -useful abstractions that match the way we typically think about these -things. - -The \Package{fancyhdr} package provides -simple mechanisms for defining pretty much every head- or footline -variation you could want; the directory also contains some -documentation and one or two smaller packages. \Package{Fancyhdr} -also deals with the tedious behaviour of the standard styles with -\Qref*{initial pages}{Q-ps@empty}, by enabling you to define -different page styles for initial and for body pages. - -While \Package{fancyhdr} will work with \Class{KOMA-script} classes, -an alternative package, \Package{scrpage2}, eases integration with the -classes. \Package{Scrpage2} may also be used as a \Package{fancyhdr} -replacement, providing similar facilities. The \Class{KOMA-script} -classes themselves permit some modest redefinition of head- and -footlines, without the use of the extra package. - -\Class{Memoir} also contains the functionality of \Package{fancyhdr}, -and has several predefined styles. - -Documentation of \Package{fancyhdr} is distributed with the package, -in a separate file; documentation of \Package{scrpage2} is integrated -with the \File{scrgui*} documentation files that are distributed with -the \Class{KOMA-script} classes. -\begin{ctanrefs} -\item[fancyhdr.sty]\CTANref{fancyhdr} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-widefigs]{Wide figures in two-column documents} - -Floating figures and tables ordinarily come out the same width as the -page, but in two-column documents they're restricted to the width of -the column. This is sometimes not good enough; so there are alternative -versions of the float environments~--- in two-column documents, -\texttt{figure*} provides a floating page-wide figure (and \texttt{table*} a -page-wide table) which will do the necessary. - -The ``\texttt{*}''ed float environments can only appear at the top of a page, -or on a whole page~--- \texttt{h} or \texttt{b} float placement directives are -simply ignored. - -Unfortunately, page-wide equations can only be accommodated inside -float environments. You should include them in \texttt{figure} environments, -or use the \Package{float} or \Package{ccaption}package to define a -new float type. -\begin{ctanrefs} -\item[ccaption.sty]\CTANref{ccaption} -\item[float.sty]\CTANref{float} -\end{ctanrefs} - -\Question[Q-onecolabs]{1-column abstract in 2-column document} - -One often requires that the abstract of a paper should appear across -the entire page, even in a two-column paper. The required trick is: -\begin{quote} -\begin{verbatim} -\documentclass[twocolumn]{article} -... -\begin{document} -... % \author, etc -\twocolumn[ - \begin{@twocolumnfalse} - \maketitle - \begin{abstract} - ... - \end{abstract} - \end{@twocolumnfalse} - ] -\end{verbatim} -\end{quote} -Unfortunately, with the above \csx{thanks} won't work in the -\csx{author} list. If you need such specially-numbered footnotes, you -can make them like this: -\begin{quote} -\begin{verbatim} -\title{Demonstration} -\author{Me, You\thanks{}} -\twocolumn[ - ... as above ... -] -{ - \renewcommand{\thefootnote}% - {\fnsymbol{footnote}} - \footnotetext[1]{Thanks for nothing} -} -\end{verbatim} -\end{quote} -and so on. - -As an alternative, among other facilities the \Package{abstract} package -provides a -\csx{saythanks} command and a \environment{onecolabstract} environment -which remove the need to fiddle with the \csx{thanks} and -footnoting. They can be used like this: -\begin{quote} -\begin{verbatim} -\twocolumn[ - \maketitle % full width title - \begin{onecolabstract} % ditto abstract - ... text - \end{onecolabstract} -] -\saythanks % typeset any \thanks -\end{verbatim} -\end{quote} -The \Class{memoir} class offers all the facilities of \Package{abstract}. -\begin{ctanrefs} -\item[abstract.sty]\CTANref{abstract} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-reallyblank]{Really blank pages between chapters} - -\Class{Book} (by default) and \Class{report} (with \pkgoption{openright} class -option) ensure that each chapter starts on a right-hand (recto) page; -they do this by inserting a \csx{cleardoublepage} command between -chapters (rather than a mere \csx{clearpage}). The empty page thus -created gets to have a normal running header, which some people don't -like. - -The (excellent) \Package{fancyhdr} manual covers this issue, basically -advising the creation of a command \csx{clearemptydoublepage}: -\begin{quote} -\begin{verbatim} -\let\origdoublepage\cleardoublepage -\newcommand{\clearemptydoublepage}{% - \clearpage - {\pagestyle{empty}\origdoublepage}% -} -\end{verbatim} -\end{quote} -The ``obvious'' thing is then to use this command to replace -\csx{cleardoublepage} in a patched version of the \csx{chapter} command. -(Make a package of your own containing a copy -of the command out of the class.) This isn't particularly difficult, -but you can instead simply subvert \csx{cleardoublepage} (which isn't -often used elsewhere): -\begin{quote} -\begin{verbatim} -\let\cleardoublepage\clearemptydoublepage -\end{verbatim} -\end{quote} -Note: this command works because \csx{clearemptydoublepage} uses a copy -of \csx{cleardoublepage}: instructions on macro programming -% beware line break -\Qref*[question]{patching techniques}{Q-patch} explain the problem and -why this is a solution. - -Note that the \emph{\acro{KOMA}-Script} replacements for the -\Class{book} and \Class{report} classes (\Class{scrbook} and -\Class{scrreprt} offers class options \pkgoption{cleardoubleempty}, -\pkgoption{cleardoubleplain} and \pkgoption{cleardoublestandard} -(using the running page style, as normal) that control the appearance -of these empty pages. The classes also offer do-it-yourself commands -\csx{cleardoubleempty} (etc.\@). - -The \Class{memoir} class (and the \Package{nextpage} package) -provide commands \csx{cleartooddpage} and \csx{cleartoevenpage}, -which both take an optional argument (the first, with no argument, -being an equivalent of \csx{cleardoublepage}). One can achieve -`special' effects by putting commands in the optional argument: the -\csx{clearemptydoublepage} we're after would be achieved by -\csx{cleartooddpage[}\cmdinvoke{thispagestyle}{empty}\texttt{]}. The -commands will also serve if you want the surreal effect of ``This page -intentionally left blank'' in the centre of an otherwise empty page. -\begin{ctanrefs} -\item[fancyhdr]\CTANref{fancyhdr} -\item[memoir.cls]\CTANref{memoir} -\item[nextpage.sty]\CTANref{nextpage} -\item[scrbook.cls, scrrept.cls]Part of \CTANref{koma-script} -\end{ctanrefs} - -\Question[Q-balance]{Balancing columns at the end of a document} - -The \Package{twocolumn} option of the standard classes causes -\LaTeX{} to set the text of a document in two columns. However, the last -page of the document typically ends up with columns of different -lengths~--- such columns are said to be ``unbalanced''. Many (most?) -people don't like unbalanced columns. - -The simplest solution to the problem is to use the \Package{multicol} -package in place of the \Package{twocolumn} option, as -\Package{multicol} balances the columns on the final page by default. -However, the use of \Package{multicol} does come at a cost: its -special output routine disallows the use of in-column floats, though -it does still permit full-width (e.g., \environment{figure*} -environment) floats. - -As a result, there is a constant push for a means of balancing columns -at the end of a \Package{twocolumn} document. Of course, the job can -be done manually: \csx{pagebreak} inserted at the appropriate place on -the last page can often produce the right effect, but this seldom -appeals, and if the last page is made up of automatically-generated -text (for example, bibliography or index) inserting the command will -be difficult. - -The \Package{flushend} package offers a solution to this problem. It's a -somewhat dangerous piece of macro code, which patches one of the most -intricate parts of the \LaTeX{} kernel without deploying any of the -safeguards discussed in \Qref[question]{patching commands}{Q-patch}. -The package only changes the behaviour at end document (its -\csx{flushend} command is enabled by default), and one other command -permits adjustment of the final balance; other packages in the bundle -provide means for insertion of full width material in two-column -documents. - -The \Package{balance} package also patches the output routine -(somewhat more carefully than \Package{flushend}). - -The user should be aware that any of these packages are liable to -become confused in the presence of floats: if problems arise, manual -adjustment of the floats in the document is likely to be necessary. -It is this difficulty (what's required in any instance can't really be -expressed in current \LaTeX{}) that led the author of -\Package{multicol} to suppress single-column-wide floats. -\begin{ctanrefs} -\item[balance.sty]Distributed as part of \CTANref{preprint} -\item[flushend.sty]Distributed as part of \CTANref{sttools} -\item[multicol.sty]Distributed as part of \CTANref{2etools} - -\end{ctanrefs} - -\Question[Q-runheadtoobig]{My section title is too wide for the page header} - -By default, \LaTeX{} sectioning commands make the chapter or section -title available for use by page headers and the like. Page headers -operate in a rather constrained area, and it's common for titles too -be too big to fit: the \LaTeX{} sectioning commands therefore take an -optional argument: -\begin{quote} -\begin{verbatim} -\section[short title]{full title} -\end{verbatim} -\end{quote} -If the \meta{short title} is present, it is used both for the table of -contents and for the page heading. The usual answer to people who -complain that their title is too big for the running head is to -suggest that they the optional argument. - -However, using the same text for the table of contents as for the -running head may also be unsatisfactory: if your chapter titles are -seriously long (like those of a Victorian novel), a valid and rational -scheme is to have a shortened table of contents entry, and a really -terse entry in the running head. - -One of the problems is the tendency of page headings to be set in -capitals (which take up more space); so why not set headings as written -for ``ordinary'' reading? It's not possible to do so with unmodified -\LaTeX{}, but the \Package{fancyhdr} package provides a command -\csx{nouppercase} for use in its header (and footer) lines to suppress -\LaTeX{}'s uppercasing tendencies. Classes in the \Class{KOMA-script} -bundle don't uppercase in the first place. - -In fact, the sectioning commands use `mark' commands to pass -information to the page headers. For example, \csx{chapter} uses -\csx{chaptermark}, \csx{section} uses \csx{sectionmark}, and so on. With -this knowledge, one can achieve a three-layer structure for chapters: -\begin{quote} -\begin{verbatim} -\chapter[middling version]{verbose version} -\chaptermark{terse version} -\end{verbatim} -\end{quote} -which should supply the needs of every taste. - -Chapters, however, have it easy: hardly any book design puts a page -header on a chapter start page. In the case of sections, one has -typically to take account of the nature of the \csx{*mark} commands: -the thing that goes in the heading is the first mark on the page (or, -failing any mark, the last mark on any previous page). As a result -the recipe for sections is more tiresome: -\begin{quote} -\begin{verbatim} -\section[middling version]{verbose version% - \sectionmark{terse version}} -\sectionmark{terse version} -\end{verbatim} -\end{quote} -(the first \csx{sectionmark} deals with the header of the page the -\csx{section} command falls on, and the second deal with subsequent -pages; note that here, you need the optional argument to \csx{section}, -even if ``\emph{middling version}'' is in fact the same text as -``\emph{long version''}.) - -A similar arrangement is necessary even for chapters if the class -you're using is odd enough that it puts a page header on a chapter's -opening page. - -Note that the \Package{titlesec} package manages the running heads in -a completely different fashion; users of that package should refer to -the documentation. - -The \Class{memoir} class avoids all the silliness by providing an -extra optional argument for chapter and sectioning commands, for -example: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\section[middling version][terse version]% - {verbose version} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\section[middling version][terse version]{verbose version} -\end{verbatim} -\end{wideversion} -\end{quote} -As a result, it is always possible for users of \Class{memoir} to -tailor the header text to fit, with very little trouble. -\begin{ctanrefs} -\item[fancyhdr.sty]\CTANref{fancyhdr} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[titlesec.sty]\CTANref{titlesec} -\end{ctanrefs} - -\nothtml{\begingroup\boldmath} -\Question[Q-nofm]{Page numbering ``\meta{n} of \meta{m}''} -\nothtml{\afterquestion} - -Finding the page number of the last page of a document, from within -the document, is somewhat tricky. The \Package{lastpage} package is -therefore supplied to make life easy for us all; it defines a label -\texttt{LastPage} whose number is \emph{right} (after sufficiently many -passes through \LaTeX{}, of course). The \Class{memoir} class also -defines a ``last page'' label. - -The documentation of the \Package{fancyhdr} package spells out exactly -how one might actually use this information to produce page numbering -as suggested in the question. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}fancyhdr documentation]\CTANref{fancyhdr} -\item[lastpage.sty]\CTANref{lastpage} -\end{ctanrefs} - -\Question[Q-pagebychap]{Page numbering by chapter} - -When I was a young man, a common arrangement for loose bound technical -manuals is to number pages by chapter. (It's quite a good scheme, in -those situations: even if your corrections add a whole page to the -chapter, the most you have to redistribute is that chapter.) - -The problem, at first sight, seems pretty much the same as that in -another answer on -% beware line break -\Qref*{running numbers within a chapter}{Q-running-nos}, -and the basic technique is indeed pretty similar. - -However, tidying-up loose ends, making sure the page number gets reset -to the correct value at the start of each chapter, and so on, is -slightly more challenging. This is why the \Package{chappg} package -was written: it does the obvious things, and more. - -Users have been known to ask for running page numbers within a -section, but this really doesn't make sense: you need to run page -numbers within document objects that always start on a fresh page. -\begin{ctanrefs} -\item[chappg.sty]\CTANref{chappg} -\end{ctanrefs} - -\subsection{Page layout} - -\Question[Q-papersize]{The size of printed output} - -The final product of a \AllTeX{} run is something for a person to -read. Often, nowadays, that product will be read ``on-screen'', but -the printed page remains a principal output form. - -When we come to print our output, it is important that the output fits -on the paper; in some cases, for the output to ``fit'' is good enough. -However, there are circumstances where the actual size of the printed -output, on the page, is crucial to the acceptance of the output. -(This might happen when the output is a book to be published, or when -it's a dissertation which must match the fancies of some bureaucrat -even to be considered.) - -Sadly, we often find that the printed output doesn't conform to our -expectations\dots{} - -The check-list for such problems has two entries: -\begin{itemize} -\item Your output is generated via Adobe \ProgName{Reader} (or - possibly ``\ProgName{Acrobat Reader}''~--- older versions of the - program had the qualified name). In this case, it may be that - \ProgName{Reader} is willfully changing the size of your output: - read \Qref*{\ProgName{Reader} antics}{Q-acroantics}. -\item Something in your \TeX{} system is producing the wrong size (or - shape) of output: read \Qref*{paper geometry}{Q-papergeom}. -\end{itemize} - -An alternative approach is to use the (excellent) \Package{testflow} -suite, that provides a detailed outline of the potential problems -together with a sample document and prototype outputs. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}testflow bundle]\CTANref{testflow} -\end{ctanrefs} - -\Question[Q-acroantics]{Adobe \ProgName{Reader} messing with print size} -\AliasQuestion{Q-outszwrng} - -Printing from Adobe \ProgName{Reader} shrinks the page ``to fit'' -(\emph{by default}). Unfortunately, its calculation doesn't consider -the existing margins of the document, so that it shrinks what it -believes is your whole page onto what it believes is its output page. -The effect typically looks as if your margins have expanded. - -Solve this problem by adjusting the \ProgName{Reader}'s default in the -print dialogue; unfortunately, this dialogue varies from one version -to the next: -\begin{itemize} -\item \ProgName{Reader} version 7:\\ - Page Scaling (default: ``Fit to printer margins'')~--- change to - ``None'', and\\ - Scale (default 95\textpercent{} of Normal size)~--- change to - ``100\textpercent''. -\item Adobe Reader 6:\\ - in the print dialogue, on the ``copies \& pages'' pane, you'll find a - popup menu/drop-down list titled ``Page Scaling''~--- change to ``None''. -\item Windows, Linux Acrobat (Reader) 5.0:\\ - In the print dialog, make sure the ``Shrink oversized pages to fit'' - checkbox is unchecked. It may also be useful to uncheck the - ``Expand small pages to fit paper size'' checkbox as well. -\end{itemize} - -\Question[Q-papergeom]{Getting the right paper geometry from \AllTeX{}} - -If your output is the wrong size, and you've checked that it's not due -to the \Qref*{ministrations of Adobe \ProgName{Reader}}{Q-acroantics}, -the problem is probably that your \AllTeX{} system is producing output -that specifies the wrong paper size. Paper sizes can be a pain: -they're a forgotten backwater~--- Knuth seems not to have considered -paper size as something the \TeX{} engine needs to know about. As a -result, there is no \acro{DVI} command to specify the paper on which -the document should be printed, which has led a dichotomy where macros -shape the text according to the needs of the author's chosen paper -size, and device drivers' choice happens independently of the macros' -ideas. - -In practice, one usually finds that macro packages (such as \plaintex{} and -\LaTeX{}) assume American ``letter'' paper size, by default; and since -most distributions nowadays originate in Europe, the drivers usually -default to \acro{ISO} ``A4'' paper size. - -This is (of course) pretty unsatisfactory. Users may select a -different paper size for their document (current \LaTeX{} offers a -range of sizes as options in the standard classes), pretty easily. -Nevertheless, the user also has to be sure that each time -\ProgName{xdvi}, \ProgName{dvips} (or whatever) runs, it uses the -paper size the document was designed for. - -The default paper size for \acro{DVI} drivers may be changed by a -distribution management command (\ProgName{texconfig} for \texlive{}, -the \ProgName{Options} application for \miktex{}), but this still -doesn't provide for people using the ``wrong'' sort of paper for some -reason. - -A different issue arises for users of \PDFTeX{}~--- the -\acro{PDF} format \emph{does} have the means of expressing paper size -and \PDFTeX{} has system variables \csx{pdfpagewidth} and -\csx{pdfpageheight}, that are written into the output \acro{PDF} file. -Unfortunately, most of the core software predates \PDFTeX{}, so not even -\PDFLaTeX{} sets the correct values into those variables, to match the -paper size specified in a \csx{documentclass} option. - -The \acro{DVI} drivers \ProgName{dvips} and \ProgName{dvipdfm} define -\csx{special} commands for the document to specify its own paper size; -so in those cases, as when \PDFTeX{} or V\TeX{} is being used, the -paper size can be programmed by the document. Users who wish to, may -of course consult the manuals of the various programs to write the -necessary code. - -The \Package{geometry} package (whose main business is defining -typeset page areas), also takes notice the size of the paper that the -document is going to be printed on, and can issue the commands -necessary to ensure the correct size of paper is used. If -\Package{geometry} is used when a document is being processed by -\PDFLaTeX{}, it can set the necessary dimensions ``in the output''. -If the document is being processed by \LaTeX{} on a \TeX{} or \eTeX{} -engine, there are package options which instruct \Package{geometry} -which \csx{special} commands to use. (Note that the options are -ignored if you are using either \PDFLaTeX{} or V\TeX{}.) - -So, the resolution of the problem is to add -\begin{quote} -\begin{verbatim} -\usepackage[dvixxx,...]{geometry} -\end{verbatim} -\end{quote} -(where \pkgoption{dvixxx} is your current favourite \acro{DVI} -driver~--- \Package{geometry} knows about \pkgoption{dvips} and -\pkgoption{dvipdfm}), and the document will run correctly with -\LaTeX{}. If you're using \PDFLaTeX{}, load with -\begin{quote} -\begin{verbatim} -\usepackage[pdftex,...]{geometry} -\end{verbatim} -\end{quote} - -Needless to say, both the ``big'' classes (\Class{koma-script} and -\Class{memoir}) provide their own ways to get the paper size -``right''. - -The \Package{typearea} package is the \Class{Koma-script} -distribution's way of providing page layout functionality. Load it -with the \pkgoption{pagesize} option and it will ensure the correct -paper is selected, for \acro{PDF} output from \PDFLaTeX{}, and for -\PS{} output from \LaTeX{} via \ProgName{dvips}. - -\Class{Memoir} has the standard classes' paper-size selections -(\pkgoption{a4paper}, \pkgoption{letterpaper} and so on), but also -permits the user to choose an arbitrary paper size, by setting the -length registers \csx{stockheight} and \csx{stockwidth}. The commands -\csx{fixdvipslayout} (for \LaTeX{} processing), and \csx{fixpdflayout} -(for \PDFLaTeX{} processing) then instruct the processor to produce -output that specifies the necessary paper size. -\begin{ctanrefs} -\item[geometry.sty]\CTANref{geometry} -\item[memoir.cls]\CTANref{memoir} -\item[typearea.sty]Distributed as part of \CTANref{koma-script} -\end{ctanrefs} - -\Question[Q-changemargin]{Changing the margins in \LaTeX{}} - -Changing the layout of a document's text on the page involves several -subtleties not often realised by the beginner. There are interactions -between fundamental \TeX{} constraints, constraints related to the -design of \LaTeX{}, and good typesetting and design practice, that -mean that any change must be very carefully considered, both to ensure -that it ``works'' and to ensure that the result is pleasing to the -eye. - -\LaTeX{}'s defaults sometimes seem excessively conservative, -but there are sound reasons behind how Lamport designed the layouts -themselves, whatever one may feel about his overall design. For -example, the common request for ``one-inch margins all round on A4 -paper'' is fine for 10- or 12-pitch typewriters, but not for 10pt (or -even 11pt or 12pt) type because readers find such wide, dense, lines -difficult to read. There should ideally be no more than 75 characters -per line (though the constraints change for two-column text). - -So Lamport's warning to beginners in his section on `Customizing the -Style'~--- ``don't do it''~--- should not lightly be ignored. - -This set of \acro{FAQ}s recommends that you use a package to establish -consistent settings of the parameters: the interrelationships are -taken care of in the established packages, without you \emph{needing} -to think about them, but remember~--- the packages only provide -consistent, working, mechanisms: they don't analyse the quality of -what you propose to do. - -The following answers deal with the ways one may choose to proceed: -\begin{itemize} -\item \Qref*{Choose which package to use}{Q-marginpkgs}. -\item \Qref*{Find advice on setting up page layout by hand}{Q-marginmanual}. -\end{itemize} -There is a related question~--- how to change the layout -temporarily~--- and there's an answer that covers that, too: -\begin{itemize} -\item \Qref*{Change the margins on the fly}{Q-chngmargonfly}. -\end{itemize} - -\Question[Q-marginpkgs]{Packages to set up page designs} - -The `ultimate' tool for adjusting the dimensions and position of the -printed material on the page is the \Package{geometry} package; a very -wide range of adjustments of the layout may be relatively -straightforwardly programmed, and package documentation is good and -comprehensive. - -As is usual, users of the \Class{memoir} class have built-in -facilities for this task, and users of the \Class{KOMA-script} classes -are recommended to use an alternative package, \Package{typearea}. In -either case it is difficult to argue that users should go for -\Package{geometry}: both alternatives are good. - -The documentation of \Package{geometry} is a bit overwhelming, and -learning all its capabilities may be more than you ever need. -Somewhat simpler to use is the \Package{vmargin} package, which has a -canned set of paper sizes (a superset of that provided in \LaTeXe{}), -provision for custom paper, margin adjustments and provision for -two-sided printing. -\begin{ctanrefs} -\item[geometry.sty]\CTANref{geometry} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[layout.sty]Distributed as part of \CTANref{2etools} -\item[memoir.cls]\CTANref{memoir} -\item[typearea.sty]Distributed as part of \CTANref{koma-script} -\item[vmargin.sty]\CTANref{vmargin} -\end{ctanrefs} - -\Question[Q-marginmanual]{How to set up page layout ``by hand''} - -So you're eager to do it yourself, notwithstanding the cautions -\begin{narrowversion} - outlined above (\Qref{}{Q-changemargin}). -\end{narrowversion} -\begin{wideversion} - outlined in ``\Qref{changing margins}{Q-changemargin}''. -\end{wideversion} - -It's important that you first start by familiarising yourself -with LaTeX's page layout parameters. For example, see section C.5.3 of the -\LaTeX{} manual (pp.~181-182), or corresponding sections in many of the other -good \LaTeX{} manuals (see \Qref[question]{\LaTeX{} books}{Q-books}). - -\LaTeX{} controls the page layout with a number of parameters, which -allow you to change the distance from the edges of a page to the left -and top edges of your typeset text, the width and height of the text, -and the placement of other text on the page. However, they are -somewhat complex, and it is easy to get their interrelationships wrong -when redefining the page layout. The layout package defines a -\csx{layout} command which draws a diagram of your existing page -layout, with the dimensions (but not their interrelationships) shown. - -Even changing the text height and width, \csx{textheight} and -\csx{textwidth}, requires more care than you might expect: the height -should be set to fit a whole number of text lines (in terms of -multiples of \csx{baselinskip}), and the width should be constrained -by the number of characters per line, as mentioned in % ! line break -``\Qref*{changing margins}{Q-changemargin}''. - -Margins are controlled by two parameters: \csx{oddsidemargin} and -\csx{evensidemargin}, whose names come from the convention that -odd-numbered pages appear on the right-hand side (`recto') of a -two-page spread and even-numbered pages on the left-hand side -(`verso'). Both parameters actually refer to the left-hand margin of -the relevant pages; in each case the right-hand margin is specified by -implication, from the value of \csx{textwidth} and the width of the -paper. (In a one-sided document, which is the default in many -classes, including the standard \Class{article} and \Class{report} -classes, \csx{oddsidemargin} stands for both.) - -The -``origin'' (the zero position) on the page is one inch from the top of -the paper and one inch from the left side; positive horizontal -measurements extend right across the page, and positive vertical -measurements extend down the page. Thus, the parameters -\csx{evensidemargin}, \csx{oddsidemargin} and \csx{topmargin}, should -be set to be 1~inch less than the true margin; for margins closer to -the left and top edges of the page than 1~inch, the margin parameters -must be set to negative values. - -\Question[Q-chngmargonfly]{Changing margins ``on the fly''} - -One of the surprises characteristic of \TeX{} use is that you cannot -change the width or height of the text within the document, simply by -modifying the text size parameters; \TeX{} can't change the text width -on the fly, and \LaTeX{} only ever looks at text height when starting -a new page. - -So the simple rule is that the parameters should only be -changed in the preamble of the document, i.e., before the -\cmdinvoke{begin}{document} statement (so before any typesetting has -happened. - -To adjust text width within a document we define an environment: -\begin{quote} -\begin{verbatim} -\newenvironment{changemargin}[2]{% - \begin{list}{}{% - \setlength{\topsep}{0pt}% - \setlength{\leftmargin}{#1}% - \setlength{\rightmargin}{#2}% - \setlength{\listparindent}{\parindent}% - \setlength{\itemindent}{\parindent}% - \setlength{\parsep}{\parskip}% - }% - \item[]}{\end{list}} -\end{verbatim} -\end{quote} -The environment takes two arguments, and will indent the left and -right margins, respectively, by the parameters' values. Negative -values will cause the margins to be narrowed, so -\cmdinvoke{begin}{changemargin}{-1cm}{-1cm} narrows the left and right -margins by 1 centimetre. - -Given that \TeX{} can't do this, how does it work?~--- well, the -environment (which is a close relation of the \LaTeX{} -\environment{quote} environment) \emph{doesn't} change the text width -as far as \TeX{} is concerned: it merely moves text around inside the -width that \TeX{} believes in. - -The \Package{changepage} package provides ready-built commands to do -the above; it includes provision for changing the shifts applied to -your text according to whether you're on an odd (\emph{recto}) or an -even (\emph{verso}) page of a two-sided document. -\Package{Changepage}'s structure matches that of the \Class{memoir} -class. - -The (earlier) package \Package{chngpage} provides the same facilities, -but it uses rather different syntax. \Package{Changepage}'s structure -matches that of the \Class{memoir} class, and it should be used for -any new work. - -Changing the vertical dimensions of a page is more clumsy still: the -\LaTeX{} command \csx{enlargethispage} adjusts the size of the current -page by the size of its argument. Common uses are -\begin{quote} -\begin{verbatim} -\enlargethispage{\baselineskip} -\end{verbatim} -\end{quote} -to make the page one line longer, or -\begin{quote} -\begin{verbatim} -\enlargethispage{-\baselineskip} -\end{verbatim} -\end{quote} -to make the page one line shorter. The process is (to an extent) -simplified by the \Package{addlines} package: its \csx{addlines} -command takes as argument the \emph{number} of lines to add to the -page (rather than a length): the package documentation also provides a -useful analysis of when the command may (or may not) be expected to -work. -\begin{ctanrefs} -\item[addlines.sty]\CTANref{addlines} -\item[changepage.sty]\CTANref{changepage} -\end{ctanrefs} - -\Question[Q-nopageno]{How to get rid of page numbers} - -The package \Package{nopageno} will suppress page numbers in a whole -document. - -To suppress page numbers from a single page, use -\cmdinvoke{thispagestyle}{empty} somewhere within the text of the -page. (Note that \csx{maketitle} and \csx{chapter} both use -\csx{thispagestyle} internally, so you need to call it after you've -called them.) - -To suppress page numbers from a sequence of pages, you may use -\cmdinvoke{pagestyle}{empty} at the start of the sequence, and restore -the original page style at the end. Unfortunately, you still have to -use \csx{thispagestyle} after any \csx{maketitle} or \csx{chapter} -command. - -In the \Class{memoir} class, the troublesome commands (\csx{maketitle}, -\csx{chapter}, etc.\@) invoke their own page style -(\environment{title}, \environment{chapter}, etc.\@), which you may -redefine using the class's own techniques to be equivalent to -``\environment{empty}''. The \Class{KOMA-script} classes have -commands that contain the page style to be used, so one might say: -\begin{quote} -\begin{verbatim} -\renewcommand*{\titlepagestyle}{empty} -\end{verbatim} -\end{quote} - -An alternative (in all classes) is to use the rather delightful -\cmdinvoke{pagenumbering}{gobble}; this has the simple effect that any -attempt to print a page number produces nothing, so there's no issue -about preventing any part of \LaTeX{} from printing the number. -However, the \csx{pagenumbering} command does have the side effect that -it resets the page number (to 1), which may be undesirable. - -The \Package{scrpage2} package separates out the representation from -the resetting; so one can say -\begin{quote} -\begin{verbatim} -\renewcommand*{\pagemark}{} -\end{verbatim} -\end{quote} -to have the same effect as the \texttt{gobble} trick, without -resetting the page number. -\begin{ctanrefs} -\item[nopageno]\CTANref{nopageno} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[scrpage2.sty]Distributed as part of \CTANref{koma-script} -\end{ctanrefs} - -\Question[Q-ps@empty]{\psatempty{} on first page in \LaTeX{}} - -If you use \cmdinvoke{pagestyle}{empty}, but the first page is numbered -anyway, you are probably using the \csx{maketitle} command too. The -behaviour is not a bug but a feature. The standard \LaTeX{} classes are -written so that initial pages (pages containing a \csx{maketitle}, -\csx{part}, or \csx{chapter}) have a different page style from the rest -of the document; to achieve this, the commands internally issue -\cmdinvoke{thispagestyle}{plain}. This is usually not acceptable -behaviour if the surrounding page style is `empty'. - -Possible workarounds include: -\begin{itemize} -\item Put \csx{thispagestyle{empty}} immediately after the - \csx{maketitle} command, with no blank line between them. -\item Use the \Package{fancyhdr} or \Package{scrpage2} packages, which - allow you to customise the style for initial pages independently of - that for body pages. - - For example, use \Package{fancyhdr} commands: -\begin{verbatim} -\fancypagestyle{plain}{% - \fancyhf{}% - \renewcommand{\headrulewidth}{0pt}% - \renewcommand{\footrulewidth}{0pt}% -} -\end{verbatim} - and the ``\texttt{empty}'' page style (invoked by \csx{chapter} - commands and title pages) will have no header or footer. -\item If you are using either the \Class{memoir} class or a - \Class{KOMA-script} class, use the techniques outlined for them in - ``\Qref*[question]{no page numbers}{Q-nopageno}''. -\end{itemize} -\begin{ctanrefs} -\item[fancyhdr.sty]\CTANref{fancyhdr} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[nopageno.sty]\CTANref{nopageno} -\item[scrpage2.sty]Distributed as part of \CTANref{koma-script} -\end{ctanrefs} - -\Question[Q-crop]{How to create crop marks} - -If you're printing something that's eventually to be reproduced in -significant quantities, and bound, it's conventional to print on paper -larger than your target product, and to place ``crop marks'' outside -the printed area. These crop marks are available to the production -house, for lining up reproduction and trimming machines. - -You can save yourself the (considerable) trouble of programming these -marks for yourself by using the package \Package{crop}, which has -facilities to satisfy any conceivable production house. Users of the -\Class{memoir} class don't need the package, since \Class{memoir} has -its own facilities for programming crop marks. -\begin{ctanrefs} -\item[crop.sty]\CTANref{crop} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-watermark]{`Watermarks' on every page} - -It's often useful to place some text (such as `DRAFT') in the -background of every page of a document. For \LaTeX{} users, this can -be achieved with the \Package{draftcopy} package. This can deal with -many types of \acro{DVI} processors (in the same way that the graphics -package does) and knows translations for the word `DRAFT' into a wide -range of languages (though you can choose your own word, too). -Unfortunately, however, the package relies on \PS{} specials, and will -therefore fail if you are viewing your document with \ProgName{xdvi}, -and won't even compile if you're using \PDFLaTeX{}. (\PDFLaTeX{} -users need one of the other solutions below.) - -The \Package{wallpaper} package builds on \Package{eso-pic} (see -below). Apart from the single-image backdrops described above -(``wallpapers'', of course, to this package), the package provides -facilities for tiling images. All its commands come in pairs: one for -``general'' use, and one applying to the current page only. - -The \Package{draftwatermark} package uses the same author's -\Package{everypage} package to provide a simple interface for adding -textual (`DRAFT'-like) watermarks. - -More elaborate watermarks may be achieved using the \Package{eso-pic} -package, which in turn uses the package \Package{everyshi}, or by -using \Package{everypage}. \Package{Eso-pic} attaches a -\environment{picture} environment to every page as it is shipped out; -you can put things into that environment. The package provides -commands for placing things at certain useful points (like ``text -upper left'' or ``text centre'') in the picture, but you're at liberty -to do what you like. - -\Package{Everypage} allows you to add ``something'' to every page, or -to a particular page; you therefore need to construct your own -apparatus for anything complicated. -\begin{ctanrefs} -\item[draftcopy.sty]\CTANref{draftcopy} -\item[draftwatermark.sty]\CTANref{draftwatermark} -\item[eso-pic.sty]\CTANref{eso-pic} -\item[everypage.sty]\CTANref{everypage} -\item[everyshi.sty]Distributed as part of \CTANref{ms} -\item[wallpaper.sty]\CTANref{wallpaper} -\end{ctanrefs} - -\Question[Q-landscape]{Typesetting things in landscape orientation} - -It's often necessary to typeset part of a document in landscape -orientation; to achieve this, one needs not only to change the page -dimensions, but also to instruct the output device to print the -strange page differently. - -There are two ``ordinary'' mechanisms for doing two slight variations -of landscape typesetting: -\begin{itemize} -\item If you have a single floating object that is wider than it is - deep, and will only fit on the page in landscape orientation, use - the \Package{rotating} package; this defines - \environment{sidewaysfigure} and \environment{sidewaystable} - environments which create floats that occupy a whole page. - - Note that \Package{rotating} has problems in a document that also - loads the \Package{float} package, which recommended in other - answers in these \acro{FAQ}s, for example that on - \Qref*{float placement}{Q-floats}. The \Package{rotfloat} package - loads \Package{rotating} for you, and smooths the interaction with - \Package{float}. -\item If you have a long sequence of things that need to be typeset in - landscape (perhaps a code listing, a wide \environment{tabbing} - environment, or a huge table typeset using \Package{longtable} or - \Package{supertabular}), use the \Package{lscape} package (or - \Package{pdflscape} if you're generating \acro{PDF} output, whether - using \PDFLaTeX{} or \ProgName{dvips} and generating \acro{PDF} from - that). Both packages define an environment \environment{landscape}, which - clears the current page and restarts typesetting in landscape - orientation (and clears the page at the end of the environment - before returning to portrait orientation). -\end{itemize} -No currently available package makes direct provision for typesetting -in both portrait and landscape orientation on the same page (it's not -the sort of thing that \TeX{} is well set-up to do). If such -behaviour was an absolute necessity, one might use the techniques -described in -% beware line-wrap -\Qref[question]{"flowing text around figures"}{Q-textflow}, and would -rotate the landscape portion using the rotation facilities of the -\Package{graphics} package. (Returning from landscape to portrait -orientation would be somewhat easier: the portrait part of the page -would be a bottom float at the end of the landscape section, with its -content rotated.) - -To set an entire document in landscape orientation, one might use -\Package{lscape} around the whole document. A better option is the -\pkgoption{landscape} option of the \Package{geometry} package; if you -also give it \pkgoption{dvips} or \pkgoption{pdftex} option, -\Package{geometry} also emits the rotation instructions to cause the -output to be properly oriented. The \Class{memoir} class has the same -facilities, in this respect, as does \Package{geometry}. - -A word of warning: most current \TeX{} previewers do not honour -rotation requests in \acro{DVI} files. -%% (the exception is -%% (the exceptions are the -%% \begin{htmlversion} -%% (\Qref{commercial}{Q-commercial}) \YandY{} previewer -%% \ProgName{dviwindo}, -%% \end{htmlversion} -%% \htmlignore -%% (commercial) \YandY{} previewer \ProgName{dviwindo} -%% (\Qref{}{Q-commercial}), -%% \endhtmlignore -%% and -%% the fp\TeX{} previewer Win\acro{DVI}). If your previewer is not -%% capable of rotation, -Your best bet is to convert your output to \PS{} or to \acro{PDF}, and -to view these `final' forms with an appropriate viewer. -\begin{ctanrefs} -\item[geometry.sty]\CTANref{geometry} -\item[graphics.sty]Distributed as part of \CTANref{graphics} -\item[longtable.sty]Distributed as part of \CTANref{2etools} -\item[lscape.sty]Distributed as part of \CTANref{graphics} -\item[memoir.cls]\CTANref{memoir} -\item[pdflscape.sty]Distributed with Heiko Oberdiek's packages - \CTANref{oberdiek} -\item[rotating.sty]\CTANref{rotating} -\item[rotfloat.sty]\CTANref{rotfloat} -\item[supertabular.sty]\CTANref{supertabular} -\end{ctanrefs} - -\Question[Q-abspos]{Putting things at fixed positions on the page} - -\TeX{}'s model of the world is (broadly speaking) that the author -writes text, and \TeX{} and its macros decide how it all fits on the -page. This is not good news for the author who has, from whatever -source, a requirement that certain things go in exactly the right -place on the page. - -There \emph{are} places on the page, from which things may be hung, -and two \LaTeX{} packages allow you position things relative to such -points, thus providing a means of absolute positioning. - -The \Package{textpos} package aids the construction of pages from -``blobs'', dotted around over the page (as in a poster); you give it -the location, and it places your typeset box accordingly. - -The \Package{eso-pic} defines a ``shipout picture'' that covers the -page. The user may add \environment{picture}-mode commands to this -picture, which of course can include box placements as well as the -other rather stilted commands of \environment{picture}-mode. -(\Package{Eso-pic} requires the services of \Package{everyshi}, which -must therefore also be available.) -% -% Fortunately, in the \LaTeX{} world at least, there \emph{is} a fixed -% point on every page, to whit the page header. The package -% \Package{textpos} latches bits of typesetting to locations you -% specify, by fixing them to the page header, and thereby solves the -% problem. -\begin{ctanrefs} -\item[eso-pic.sty]\CTANref{eso-pic} -\item[everyshi.sty]Distributed as part of \CTANref{ms} -\item[textpos.sty]\CTANref{textpos} -\end{ctanrefs} - -\Question[Q-nopagebrk]{Preventing page breaks between lines} - -One commonly requires that a block of typeset material be kept on the -same page; it turns out to be surprisingly tricky to arrange this. - -\LaTeX{} provides a \environment{samepage} environment which claims it -does this sort of thing for you. It proceeds by setting infinite -penalties for all sorts of page-break situations; but in many -situations where you want to prevent a page break, -\environment{samepage} doesn't help. If you're trying to keep running -text together, you need to end the paragraph inside the environment -(see \Qref[question]{preserving paragraph parameters}{Q-paraparam}). -Also, if the things you are trying to keep together insert their own -pagebreak hints, \environment{samepage} has no power over them: a good -example is list items~--- they suggest page breaks between them. Even -if \environment{samepage} \emph{does} work, it's likely to leave stuff -jutting out at the bottom of the page. - -A convenient trick is to set all the relevant stuff in a \csx{parbox} -(or a \environment{minipage} if it contains things like verbatim text -that may not be in the argument of a \csx{parbox}). The resulting box -certainly \emph{won't} break between pages, but that's not to say that -it will actually do what you want it to do: again, the box may be left -jutting out at the bottom of the page. - -Why do neither of these obvious things work? Because \TeX{} can't -really distinguish between infinitely awful things. -\environment{Samepage} will make any possible break point ``infinitely -bad'' and boxes don't even offer the option of breaks, but if the -alternative is the leave an infinitely bad few centimetres of blank -paper at the bottom of the page, \TeX{} will take the line of least -resistance and do nothing. - -This problem still arises even if you have \csx{raggedbottom} in -effect: \TeX{} doesn't notice the value of \emph{that} until it starts -actually shipping a page out. One approach is to set: -\begin{quote} -\begin{verbatim} -\raggedbottom -\addtolength{\topskip}{0pt plus 10pt} -\end{verbatim} -\end{quote} -The \texttt{10pt} offers a hint to the output routine that the column is -stretchable; this will cause \TeX{} to be more tolerant of the need to -stretch while building the page. If you're doing this as a temporary -measure, cancel the change to \csx{topskip} by: -\begin{quote} -\begin{verbatim} -\addtolength{\topskip}{0pt plus-10pt} -\end{verbatim} -\end{quote} -as well as resetting \csx{flushbottom}. (Note that the \texttt{10pt} never -actually shows up, because it is overwhelmed when the page is shipped -out by the stretchability introduced by \csx{raggedbottom}; however, it -could well have an effect if \csx{flushbottom} was in effect.) - -An alternative (which derives from a suggestion by Knuth in the -\TeX{}book) is the package \Package{needspace} or the \Class{memoir} class, -which both define a command \csx{needspace} whose argument tells it -what space is needed. If the space isn't available, the current page -is cleared, and the matter that needs to be kept together will be -inserted on the new page. For example, if 4~lines of text need to be -kept together, the sequence -\begin{quote} -\begin{verbatim} -\par -\needspace{4\baselineskip} -% the stuff that must stay together -<text generating lines 1-4> -% now stuff we don't mind about -\end{verbatim} -\end{quote} -Yet another trick by Knuth is useful if you have a sequence of small -blocks of text that need, individually, to be kept on their own page. -Insert the command \csx{filbreak} before each small block, and the -effect is achieved. The technique can be used in the case of -sequences of \LaTeX{}-style sections, by incorporating \csx{filbreak} -into the definition of a command (as in % beware line break -\Qref[question]{patching commands}{Q-patch}). A simple and effective -patch would be: -\begin{quote} -\begin{verbatim} -\let\oldsubsubsection=\subsubsection -\renewcommand{\subsubsection}{% - \filbreak - \oldsubsubsection -} -\end{verbatim} -\end{quote} -While the trick works for consecutive sequences of blocks, it's -slightly tricky to get out of such sequences unless the sequence is -interrupted by a forced page break (such as \csx{clearpage}, which may -be introduced by a \csx{chapter} command, or the end of the document). -If the sequence is not interrupted, the last block is likely to be -forced onto a new page, regardless of whether it actually needs it. - -If one is willing to accept that not everything can be accomplished -totally automatically, the way to go is to typeset the document and to -check for things that have the potential to give trouble. In such a -scenario (which has Knuth's authority behind it, if one is to believe -the rather few words he says on the subject in the \TeX{}book) one can -decide, case by case, how to deal with problems at the last -proof-reading stage. The alternatives are to insert \csx{clearpage} -commands as necessary, or to use \csx{enlargethispage}. Supposing you -have a line or two that stray: issue the command -\cmdinvoke{enlargethispage}{2\csx{baselineskip}} and two lines are -added to the page you're typesetting. It depends on the document -whether this looks impossibly awful or entirely acceptable, but the -command remains a useful item in the armoury. -\begin{ctanrefs} -\item[memoir.cls]\CTANref{memoir} -\item[needspace.sty]\CTANref{needspace} -\end{ctanrefs} - -\Question[Q-parallel]{Parallel setting of text} - -It's commonly necessary to present text in two languages `together' on a -page, or on a two-page spread. For this to be satisfactory, one usually -needs some sort of alignment between the two texts. - -The \Package{parallel} package satisfies the need, permitting -typesetting in two columns (not necessarily of the same width) on one -page, or on the two opposing pages of a two-page spread. Use can be -as simple as -\begin{quote} -\begin{verbatim} -\usepackage{parallel} -... -\begin{Parallel}{<left-width>}{<right-width} - \ParallelLText{left-text} - \ParallelRText{right-text} - \ParallelPar - ... -\end{Parallel} -\end{verbatim} -\end{quote} -\Package{Parallel} can get terribly confused with colour changes, in -\PDFTeX{}; the indefatigable Heiko Oberdiek has a patch for this -issue~--- the \Package{pdfcolparallel}, which maintains separate -colour stacks for the columns. - -The \Package{parcolumns} package can (in principle) deal with any -number of columns: the documentation shows its use with three -columns. Usage is rather similar to that of \Package{parallel}, -though there is of course a ``number of columns to specify'': -\begin{quote} -\begin{verbatim} -\usepackage{parcolumns} -... -\begin{parcolumns}[<options>]{3} - \colchunk{<Column 1 text>} - \colchunk{<Column 2 text>} - \colchunk{<Column 3 text>} - \colplacechunks - ... -\end{parcolumns} -\end{verbatim} -\end{quote} -The \meta{options} can specify the widths of the columns, whether to -place rules between the columns, whether to set the columns sloppy, etc. - -The \Package{ledpar} package is distributed with (and integrated with) -the \Qref{\Package{ledmac} package}{Q-linenos}. It provides parallel -setting carefully integrated with the needs of a scholarly text, -permitting translation, or notes, or both, to be set in parallel with -the `base' text of the document. -\begin{ctanrefs} -\item[ledpar.sty]Distributed with \CTANref{ledmac} -\item[parallel.sty]\CTANref{parallel} -\item[parcolumns.sty]Distributed as part of \CTANref{sauerj} -\item[pdfcolparallel.sty]Distributed as part of \CTANref{oberdiek} -\end{ctanrefs} - -\Question[Q-epigraph]{Typesetting epigraphs} - -Epigraphs are those neat quotations that authors put at the start of -chapters (or even at the end of chapters: Knuth puts things at the -ends of chapters of the \TeX{}book). - -Typesetting them is a bit of a fiddle, but not impossible to do for -yourself. Fortunately, there are two packages that do the job, to -some extent; there are also facilities in the two ``big'' classes -(\Class{memoir} and \Class{koma-script}. - -The \Package{epigraph} package defines an \csx{epigraph} command, for -creating a single -epigraph (as at the top of a chapter): -\begin{quote} -\begin{verbatim} -\chapter{The Social Life of Rabbits} -\epigraph{Oh! My ears and whiskers!}% - {Lewis Carroll} -\end{verbatim} -\end{quote} -and an epigraphs environment, for entering more than one epigraph -consecutively, in a sort of list introduced by \csx{qitem} commands: -\begin{quote} -\begin{verbatim} -\begin{epigraphs} -\qitem{What I tell you three times is true}% - {Lewis Carroll} -\qitem{Oh listen do, I'm telling you!}% - {A.A. Milne} -\end{epigraphs} -\end{verbatim} -\end{quote} -The \csx{epigraphhead} command enables you to place your epigraph -\emph{above} a chapter header: -\begin{quote} -\begin{verbatim} -\setlength{\unitlength}{1pt} -... -\chapter{The Social Life of Rabbits} -\epigraphhead[<distance>]{% - \epigraph{Oh! My ears and whiskers!}% - {Lewis Carroll}% -} -\end{verbatim} -\end{quote} -The \meta{distance} says how far above the chapter heading the -epigraph is to go; it's expressed in terms of the \csx{unitlength} -that's used in the \environment{picture} environment; the package's -author recommends \texttt{70pt}. - -The package also offers various tricks for adjusting the layout of -chapter header (necessary if you've found a hugely long quotation for -an \csx{epigraphhead}), for patching the bibliography, for patching -\csx{part} pages, and so on. (Some of these suggested patches lead you -through writing your own package\dots{}) - -The \Package{quotchap} package redefines chapter headings (in a -moderately striking way), and provides an environment -\environment{savequotes} in which you can provide one (or more) -quotations to use as epigraphs. The facilities seem not as flexible -as those of \Package{epigraph}, but it's probably easier to use. - -The \Class{memoir} class offers all the facilities of the -\Package{epigraph} package. The \Class{Koma-script} classes have -commands \csx{setchapterpreamble} and \csx{dictum} to provide these -facilities. -\begin{ctanrefs} -\item[epigraph.sty]\CTANref{epigraph} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[quotchap.sty]\CTANref{quotchap} -\end{ctanrefs} - -% \Question[Q-outszwrng]{\AllTeX{} \acro{PDF} output prints at wrong size} - -% Having got everything \emph{else} right, you should be aware that the -% problem may have nothing to do with \AllTeX{} and everything to do -% with the program you use for printing. A regular cause for such -% problems lies with Acrobat Reader, which by default enables its option -% to scale pages to fit on the printable area of the paper. Since a -% printer can rarely print right to the edge, this means that pdf-files -% will be shrunk by some (small) factor (even if the pdf-file is -% formatted for A4, and your paper size is set to A4 as well). - -% Correcting this silliness is not very hard, but the exact details -% depend on the version of Acrobat Reader (or "Adobe Reader" from -% version 6.0 onwards) you have installed: -% \begin{itemize} -% \item Mac OS X, Adobe Reader 6:\\ -% in the print dialogue, on the ``copies \& pages'' pane, you'll find a -% popup menu titled ``Page Scaling''. Make sure that the menu reads -% ``None''. -% \item Windows, Adobe Reader 6:\\ -% in the print dialogue, select ``None'' from the drop-down list -% ``Page Scaling''. -% \item Windows, Linux Acrobat (Reader) 5.0:\\ -% In the print dialog, make sure the ``Shrink oversized pages to fit'' -% checkbox is unchecked. It may also be useful to uncheck the -% ``Expand small pages to fit paper size'' checkbox as well. -%\end{itemize} - -\subsection{Spacing of characters and lines} - -\Question[Q-linespace]{Double-spaced documents in \LaTeX{}} - -A quick and easy way of getting inter-line space for copy-editing is -to change \csx{baselinestretch}~--- \cmdinvoke{linespread}{1.2} (or, -equivalently \cmdinvoke{renewcommand}{\csx{baselinestretch}}{1.2}) may -be adequate. Note that \csx{baselinestretch} changes don't take -effect until you select a new font, so make the change in the preamble -before any font is selected. Don't try changing \csx{baselineskip}: -its value is reset at any size-changing command so that results will -be inconsistent. - -For preference (and certainly for a production document, such as a -dissertation or an article submission), use a line-spacing package. -The only one currently supported is \Package{setspace} (do \emph{not} -be tempted by \Package{doublespace}~--- its performance under current -\LaTeX{} is at best problematical). \Package{Setspace} switches off -double-spacing at places where even the most die-hard official would -doubt its utility (footnotes, figure captions, and so on); it's very -difficult to do this consistently if you're manipulating -\csx{baselinestretch} yourself. - -Of course, the real solution (other than for private copy editing) is -\emph{not} to use double-spacing at all. Universities, in particular, -have no excuse for specifying double-spacing in submitted -dissertations: \LaTeX{} is a typesetting system, not a -typewriter-substitute, and can (properly used) make single-spaced text -even more easily readable than double-spaced typewritten text. If you -have any influence on your university's system (for example, through -your dissertation supervisor), it may be worth attempting to get the -rules changed (at least to permit a ``well-designed book'' format). - -Double-spaced submissions are also commonly required when submitting -papers to conferences or journals. Fortunately (judging by the -questions from users in this author's department), this demand is -becoming less common. - -Documentation of \Package{setspace} appears as \TeX{} comments in the -package file itself. -\begin{ctanrefs} -\item[setspace.sty]\CTANref{setspace} -\end{ctanrefs} - -\Question[Q-letterspace]{Changing the space between letters} - -A common technique in advertising copy (and other text whose actual -content need not actually be \emph{read}) is to alter the space -between the letters (otherwise known as the tracking). As a general -rule, this is a very bad idea: it detracts from legibility, which is -contrary to the principles of typesetting (any respectable font you -might be using should already have optimum tracking built into it). - -The great type designer, Eric Gill, is credited with saying ``he who -would letterspace lower-case text, would steal sheep''. (The -attribution is probably apocryphal: others are also credited with the -remark. Stealing sheep was, in the 19th century, a capital offence in -Britain.) As the remark suggests, though, letterspacing of upper-case -text is less awful a crime; the technique used also to be used for -emphasis of text set in Fraktur (or similar) fonts. - -Straightforward macros (usable, in principle, with any \TeX{} macro -package) may be found in \Package{letterspacing} (which is the name of -the \extension{tex} file). - -%%% the package has a serious bug in it, so suppress mention pro tem -%The \Package{tracking} package has similar facilities. - -A more comprehensive solution is to be found in the \Package{soul} -package (which is optimised for use with \LaTeX{}, but also works with -\plaintex{}). Soul also permits hyphenation of letterspaced text; -Gill's view of such an activity is not (even apocryphally) recorded. -(Spacing-out forms part of the name of \Package{soul}; the other half -is described in \Qref[question]{another question}{Q-underline}.) - -Possibly the `ultimate' in this field is the \Package{microtype}, -which uses the micro-typography capabilities of current \PDFTeX{} to -provide a \csx{textls} command, which operates according to parameters -declared in a \csx{SetTracking} command. \Package{Microtype}'s -`tracking' facility expands the natural spacing font itself, rather -than inserting space between characters. Ordinarily, letter-spacing -will destroy ligatures; however, this is \emph{wrong} if the font is -of a fraktur style, and the package provides a means of protecting the -ligatures in a letter-spaced text. -\begin{ctanrefs} -\item[letterspacing.tex]\CTANref{letterspacing} -\item[microtype.sty]\CTANref{microtype} -\item[soul.sty]\CTANref{soul} -%\item[tracking.sty]\CTANref{tracking} -\end{ctanrefs} - -\Question[Q-ragright]{Setting text ragged right} - -The trick with typesetting ragged right is to be sure you've told the -\TeX{} engine ``make this paragraph ragged, but never \emph{too} -ragged''. The \LaTeX{} \csx{raggedright} command (and the -corresponding \environment{flushleft} environment) has a tendency to -miss the ``never'' part, and will often create ridiculously short -lines, for some minor benefit later in the paragraph. The -\plaintex{} version of the command doesn't suffer this failing, but -is rather conservative: it is loath to create too large a gap at the -end of the line, but in some circumstances~--- such as where -\Qref*{hyphenation is suppressed}{Q-hyphoff}~--- painfully large gaps -may sometimes be required. - -Martin Schr\"oder's \Package{ragged2e} package offers the best of both -worlds: it provides raggedness which is built on the \plaintex{} -model, but which is easily configurable. It defines easily-remembered -command (e.g., \csx{RaggedRight}) and environment (e.g., -\environment{FlushLeft}) names that are simply capitalised -transformations of the \LaTeX{} kernel originals. The documentation -discusses the issues and explains the significance of the various -parameters of \Package{ragged2e}'s operation. -\begin{ctanrefs} -\item[ragged2e.sty]Distributed as part of \CTANref{ms} -\end{ctanrefs} - -\Question[Q-flushboth]{Cancelling \csx{ragged} commands} - -\LaTeX{} provides commands \csx{raggedright} and \csx{raggedleft}, but -none to cancel their effect. The \csx{centering} command is -implemented in the same way as the \csx{ragged*} commands, and suffers -in the same way. - -The following code (to be inserted in a package of your own, or as -\nothtml{internal \LaTeX{} code~---}% beware line break -\Qref{internal \LaTeX{} code}{Q-atsigns}) defines a command that -restores flush justification at both margins: -\begin{verbatim} -\def\flushboth{% - \let\\\@normalcr - \@rightskip\z@skip \rightskip\@rightskip - \leftskip\z@skip - \parindent 1.5em\relax} -\end{verbatim} -There's a problem with the setting of \csx{parindent} in the code: it's -necessary because both the \csx{ragged} commands set \csx{parindent} to -zero, but the setting isn't a constant of nature: documents using a -standard \LaTeX{} class with \pkgoption{twocolumn} option will have -\texttt{1.0em} by default, and there's no knowing what you (or some -other class) will have done. - -Any but a really old copy of Martin Schr\"oder's \Package{ragged2e} -package has a \csx{justifying} command to match its % ! line break -\Qref*{versions of the \LaTeX{} `ragged' commands}{Q-ragright}. The -package also provides a \environment{justify} environment, which -permits areas of justified text in a larger area which is ragged. -\begin{ctanrefs} -\item[ragged2e.sty]Distributed as part of \CTANref{ms} -\end{ctanrefs} -% this package hasn't materialised, for some reason i don't now -% remember... -%% Donald Arseneau's \Package{flushboth} package provides this code, and -%% preserves a sensible value for \csx{parindent} (at begin document). -%% This still doesn't protect it against any change you might make to -%% \csx{parindent} within the body of your document. -%% \begin{ctanrefs} -%% \item[flushboth.sty]\CTANref{flushboth} -%% \end{ctanrefs} - -\subsection{Typesetting specialities} - -\Question[Q-verbfile]{Including a file verbatim in \LaTeX{}} - -A good way is to use Rainer Sch\"opf's \Package{verbatim} package, -which provides a command \csx{verbatiminput} that takes a file name as -argument: -\begin{quote} -\begin{verbatim} -\usepackage{verbatim} -... -\verbatiminput{verb.txt} -\end{verbatim} -\end{quote} -Another way is to use the \environment{alltt} environment, which -requires the \Package{alltt} package. The environment interprets its -contents `mostly' verbatim, but executes any \AllTeX{} commands it -finds: -\begin{quote} -\begin{verbatim} -\usepackage{alltt} -... -\begin{alltt} -\input{verb.txt} -\end{alltt} -\end{verbatim} -\end{quote} -of course, this is little use for inputting \AllTeX{} source -code\dots{} - -The \Package{moreverb} package extends the \Package{verbatim} package, -providing a \environment{listing} environment and a \csx{listinginput} -command, which line-number the text of the file. The package also has -a \csx{verbatimtabinput} command, that honours \acro{TAB} characters in -the input (the package's \environment{listing} environment and the -\csx{listinginput} command also both honour \acro{TAB}). - -The \Package{sverb} package provides verbatim input (without recourse -to the facilities of the \Package{verbatim} package): -\begin{quote} -\begin{verbatim} -\usepackage{sverb} -... -\verbinput{verb.txt} -\end{verbatim} -\end{quote} - -The \Package{fancyvrb} package offers configurable implementations of -everything \Package{verbatim}, \Package{sverb} and \Package{moreverb} -have, and more besides. It is nowadays the package of choice for the -discerning typesetter of verbatim text, but its wealth of facilities -makes it a complex beast and study of the documentation is strongly -advised. - -The \Class{memoir} class includes the relevant functionality of the -\Package{verbatim} and \Package{moreverb} packages. -\begin{ctanrefs} -\item[alltt.sty]Part of the \LaTeX{} distribution. -\item[fancyvrb.sty]\CTANref{fancyvrb} -\item[memoir.cls]\CTANref{memoir} -\item[moreverb.sty]\CTANref{moreverb} -\item[sverb.sty]Distributed as part of \CTANref{mdwtools} -\item[verbatim.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-linenos]{Including line numbers in typeset output} - -For general numbering of lines, there are two packages for use with -\LaTeX{}, \Package{lineno} (which permits labels attached to -individual lines of typeset output) and \Package{numline}. -(\Package{Numline} is considered obsolete, but remains available from -the archive.) - -Both of these packages play fast and loose with the \LaTeX{} output -routine, which can cause problems: the user should beware\dots{} - -If the requirement is for numbering verbatim text, \Package{moreverb}, -or \Package{fancyvrb} (see % ! line break -\Qref[question]{including files verbatim}{Q-verbfile}) may be used. -Class \Class{memoir} also provides the necessary facilities. - -One common use of line numbers is in critical editions of texts, and -for this the \Package{edmac} package offers comprehensive support; -\Package{ledmac} is a \LaTeX{} port of \Package{edmac}. - -The \Package{vruler} package sidesteps many of the problems associated -with line-numbering, by offering (as its name suggests) a rule that -numbers positions on the page. The effect is good, applied to -even-looking text, but is poor in texts that involve breaks such as -interpolated mathematics or figures. Documentation of the package, in -the package itself, is pretty tough going, though there is an example -(also inside the package file). -\begin{ctanrefs} -\item[edmac]\CTANref{edmac} -\item[fancyvrb.sty]\CTANref{fancyvrb} -\item[ledmac.sty]\CTANref{ledmac} -\item[lineno.sty]\CTANref{lineno} -\item[memoir.cls]\CTANref{memoir} -\item[moreverb.sty]\CTANref{moreverb} -\item[numline.sty]\CTANref{numline} -\item[vruler.sty]\CTANref{vruler} -\end{ctanrefs} - -\Question[Q-codelist]{Code listings in \LaTeX{}} - -`Pretty' code listings are sometimes considered worthwhile by the -``ordinary'' programmer, but they have a serious place in -the typesetting of dissertations by computer science and other -students who are expected to write programs. Simple verbatim listings -of programs are commonly useful, as well. - -\begin{wideversion} % really hyper - \Qref{Verbatim listings}{Q-verbfile} are dealt with elsewhere, -\end{wideversion} -\begin{narrowversion} - Verbatim listings are dealt with elsewhere (\Qref{}{Q-verbfile}), -\end{narrowversion} -as is the problem of % ! line break -\Qref*{typesetting algorithm specifications}{Q-algorithms}. - -The \Package{listings} package is widely regarded as the best bet for -formatted output (it is capable of parsing program source, within the -package itself), but there are several well-established packages that -rely on a pre-compiler of some sort. You may use \Package{listings} -to typeset snippets that you include within your source: -\begin{quote} -\begin{verbatim} -\usepackage{listings} -\lstset{language=C} -... -\begin{document} -\begin{lstlisting} -#include <stdio.h> - -int main(int argc, char ** argv) -{ - printf("Hello world!\n"); - return 0; -} -\end{lstlisting} -\end{document} -\end{verbatim} -\end{quote} -or you can have it typeset whole files: -\begin{quote} -\begin{verbatim} -\usepackage{listings} -\lstset{language=C} -... -\begin{document} -\lstinputlisting{main.c} -\end{document} -\end{verbatim} -\end{quote} -These very simple examples may be decorated in a huge variety of ways, -and of course there are other languages in the package's vocabulary -than just \ProgName{C}\dots{} - -Most people, advising others on \AllTeX{} lists, seem to regard -\Package{listings} as the be-all and end-all on this topic. But there -\emph{are} alternatives, which may be worth considering, in some -situations. - -\ProgName{Highlight} is attractive if you need more than one output -format for your program: as well as \AllTeX{} output, -\ProgName{highlight} will produce (\acro{X})\acro{HTML}, \acro{RTF} -and \acro{XSL}-\acro{FO} representations of your program listing. -Documentation is available on the % ! line break -\href{http://www.andre-simon.de/}{\ProgName{highlight} project site}. - -The \ProgName{lgrind} system is another well-established pre-compiler, -with all the facilities one might need and a wide repertoire of -languages; it is derived from the very long-established -\ProgName{tgrind}, whose output is based on \plaintex{} - -The \ProgName{tiny_c2l} system is more recent: users are encouraged to -generate their own driver files for languages it doesn't already deal -with. - -The \ProgName{C++2LaTeX} system comes with strong recommendations for -use with \acro{C} and \acro{C}++. - -An extremely simple system is \ProgName{c2latex}, for which you write -\LaTeX{} source in your \acro{C} program comments. The program then -converts your program into a \LaTeX{} document for processing. The -program (implicitly) claims to be ``self-documenting''. -\begin{ctanrefs} -\item[c2latex]\CTANref{c2latex} -\item[C++2LaTeX]\CTANref{c++2latex} -\item[highlight]\CTANref{highlight} -\item[lgrind]\CTANref{lgrind} -\item[listings.sty]\CTANref{listings} -\item[tgrind]\CTANref{tgrind} -\item[tiny\_c2l]\CTANref{tiny_c2l} -\end{ctanrefs} - -\Question[Q-algorithms]{Typesetting pseudocode in \LaTeX{}} - -There is no consensus on the `right' way to typeset pseudocode. -Consequently, there are a variety of \LaTeX{} packages to choose from -for producing \ae{}sthetically pleasing pseudocode listings. - -Pseudocode differs from actual program listings in that it lacks -strict syntax and semantics. Also, because pseudocode is supposed to -be a clear expression of an algorithm it may need to incorporate -mathematical notation, figures, tables, and other \LaTeX{} features -that do not appear in conventional programming languages. -\begin{wideversion} % hyper? - \Qref{Typesetting program listings}{Q-codelist} is described - elsewhere. -\end{wideversion} -\begin{narrowversion} % non-hyper - Typesetting program listings is described elsewhere - (\Qref{}{Q-codelist}). -\end{narrowversion} - -You can certainly create your own environment for typesetting -pseudocode using, for example, the \environment{tabbing} or -\environment{list} environments~--- it's not difficult, but it may -prove boring. So it's worth trying the following packages, all -designed specifically for typesetting pseudocode. - -The \Package{algorithms} bundle (which contains packages -\Package{algorithm} and \Package{algorithmic}, both of which are -needed for ordinary use) has a simple interface and produces fairly -nice output. It provides primitives for statements, which can contain -arbitrary \LaTeX{} commands, comments, and a set of iterative and -conditional constructs. These primitives can easily be redefined to -produce different text in the output. However, there is no support -for adding new primitives. Typesetting the pseudocode itself is -performed in \Package{algorithmic}; the \Package{algorithms} package -uses the facilities of the \Package{float} package to number -algorithms sequentially, enable algorithms to float like figures or -tables, and support including a List of Algorithms in a document's -front matter. - -Packages in the \Package{algorithmicx} bundle are similar both in -concept and output form to \Package{algorithmic} but additionally -provide support for adding new keywords and altering the formatting. -It provides the \Package{algpseudocode} package which is (almost) a -drop-in replacement for \Package{algorithmic}. Another package in the -bundle, \Package{algpascal}, uses Pascal-like keywords, indents -differently from \Package{algpseudocode}, and puts command arguments -in maths mode instead of text mode. There is no floating environment -but \Package{algorithmicx}, like \Package{algorithmic}, is compatible -with the \Package{algorithm} package. - -The \Package{alg} package, like \Package{algorithms}, offers a -floating algorithm environment with all of the ensuing niceties. -\Package{alg}, however, can caption its floats in a variety of -(natural) languages. In addition, \Package{alg} unlike -\Package{algorithms}, makes it easy to add new constructs. - -The \Package{newalg} package has a somewhat similar interface to -\Package{algorithms}, but its output is designed to mimic the rather -pleasant typesetting used in the book ``\emph{Introduction to Algorithms}'' -by Corman, Leiserson, Rivest and Stein. Unfortunately, -\Package{newalg} does not support a floating environment or any -customisation of the output. - -``\emph{Bona fide}'' use of the style of ``Introduction to -Algorithms'' may be achieved with Cormen's own \Package{clrscode}: -this is the package as used in the second edition of the book. - -Similarly, the style of % ! line break -``\emph{Combinatorial Algorithms: Generation, Enumeration and Search}'' -is supported by the \Package{pseudocode} package, written by the -authors of the book. It has the common `Pascal-like' style, and has -some interesting constructs for what one thinks of as Pascal blocks. - -The \Package{algorithm2e} is of very long standing, and is widely used -and recommended. It loads the \Package{float} package to provide the -option of floating algorithm descriptions, but you can always use the -``\texttt{H}'' option of \Package{float} to have the algorithm appear -``where you write it''. - -The usage of the \Package{program} package is a little different from -that of the other packages. It typesets programs in maths mode -instead of text mode; and linebreaks are significant. -\Package{program} lacks a floating environment but does number -algorithms like \Package{alg} and \Package{algorithms}. Customisation -and extension are not supported. Documentation of the -\Package{program} package (such as it is) appears in a file -\File{program.msg} in the distribution. - -None of the above are perfect. The factors that should influence your -choice of package include the output style you prefer, how much you -need to extend or modify the set of keywords, and whether you require -algorithms to float like figures and tables. -%% -%% Documentation availability: -%% \begin{description} -%% \item[\Package{algorithms} bundle] is provided in \File{algorithms.ps} -%% (also available as LaTeX{} source). The documentation speaks as if -%% the two packages of the bundle were indeed one, called -%% \Package{algorithms}. -%% \item[\Package{program} package] (such as it is) appears in a file -%% \File{program.msg}. -%% \item[\Package{clrscode} package] is to be found in -%% \File{clrscode.pdf} in the distribution. -%% \item[\Package{algorithm2e} package] is to be found in -%% \File{algorithm2e.tex} in the distribution (it needs the package -%% itself when you process it). -%% \end{description} -\begin{ctanrefs} -\item[algorithm2e.sty]\CTANref{algorithm2e} -\item[algorithmicx\nothtml{\rmfamily} bundle]\CTANref{algorithmicx} -\item[algorithms\nothtml{\rmfamily} bundle]\CTANref{algorithms} -\item[alg.sty]\CTANref{alg} -\item[clrscode.sty]\CTANref{clrscode} -\item[float.sty]\CTANref{float} -\item[newalg.sty]\CTANref{newalg} -\item[program.sty]\CTANref{program} -\item[pseudocode.sty]\CTANref{pseudocode} -\end{ctanrefs} - -\Question[Q-makeindex]{Generating an index in \AllTeX{}} - -Making an index is not trivial; what to index, and how to index it, is -difficult to decide, and uniform implementation is difficult to -achieve. You will need to mark all items to be indexed in your text -(typically with \csx{index} commands). - -It is not practical to sort a large index within \TeX{}, so a -post-processing program is used to sort the output of one \TeX{} run, -to be included into the document at the next run. - -The following programs are available: -\begin{description} -\item[makeindex] Comes with most distributions~--- a good workhorse, - but is not well-arranged to deal with other sort orders than the - canonical \acro{ASCII} ordering. - - The \Package{makeindex} documentation is a good source of - information on how to create your own index. \Package{Makeindex} can - be used with some \TeX{} - macro packages other than \LaTeX{}, such as \nothtml{\Eplain\ (}% - \Qref{Eplain}{Q-eplain}\nothtml{)}, and \TeX{} (whose macros can - be used independently with \plaintex{}). -\item[idxtex] for \LaTeX{} under \acro{VMS}, which comes with a - glossary-maker called \Package{glotex}. -\item[texindex] A witty little shell/\ProgName{sed}-script-based - utility for \LaTeX{} under Unix. - - The \Qref*{Texinfo}{Q-texinfo} system also uses a program - \ProgName{texindex}, whose source is to be found in the - \ProgName{texinfo} distribution. The \Package{ltxindex} package - provides macros to allow \LaTeX{} users to use \emph{this} - \ProgName{texindex}. -\item[xindy] arose from frustration at the difficulty of making a - multi-language version of \ProgName{makeindex}. It is designed to - be a successor to \ProgName{makeindex}, by a team that included the - then-current maintainer of \ProgName{makeindex}. It successfully - addresses many of \ProgName{makeindex}'s shortcomings, including - difficulties with collation order in different languages, and it is - highly flexible. Sadly, its take-up is proving rather slow. -\end{description} -\begin{ctanrefs} -\item[idxtex]\CTANref{glo+idxtex} -\item[ltxindex.sty]\CTANref{ltxindex} -\item[makeindex]\CTANref{makeindex} -\item[makeindex (Macintosh)]\CTANref{macmakeindex} -\item[texindex \nothtml{\upshape\rmfamily}(the script)]\CTANref{texindex} -\item[texindex \nothtml{\upshape\rmfamily}(the program)]Distributed - with \CTANref{texinfo} -\item[texsis (system)]\CTANref{texsis} -\item[texsis (makeindex support)]\CTANref{texsis-index} -\item[xindy]\CTANref{xindy} -\end{ctanrefs} - -\Question[Q-setURL]{Typesetting \acro{URL}s} - -\acro{URL}s tend to be very long, and contain characters that would -naturally prevent them being hyphenated even if they weren't typically -set in \csx{ttfamily}, verbatim. Therefore, without special treatment, -they often produce wildly overfull \csx{hbox}es, and their typeset -representation is awful. - -There are three packages that help solve this problem: -\begin{itemize} -\item The \Package{path} package, which defines a \csx{path} command. - The command defines each potential break character as a - \csx{discretionary}, and offers the user the opportunity of - specifying a personal list of potential break characters. Its chief - disadvantage is fragility in \LaTeX{} moving arguments. The -% beware line breaks - \Qref*{\Eplain{} macros}{Q-eplain}~--- define a similar \csx{path} command. - - \Package{Path}, though it works in simple situations, makes no - attempt to work with \LaTeX{} (it is irremediably fragile). Despite - its long and honourable history, it is no longer recommended for - \LaTeX{} use. -\item The \Package{url} package, which defines an \csx{url} command - (among others, including its own \csx{path} command). The command - gives each potential break character a maths-mode `personality', and - then sets the \acro{URL} itself (in the user's choice of font) in - maths mode. It can produce (\LaTeX{}-style) `robust' commands - % beware line break within paren - (\htmlonly{see }\Qref{use of \csx{protect}}{Q-protect}) for use - within moving arguments. - - The package ordinarily ignores spaces in the \acro{URL}, but - unfortunately \acro{URL}s that contain spaces do exist; to typeset - them, call the package with the \pkgoption{obeyspaces} option. Two - other useful options allow line breaks in the \acro{URL} in places - where they are ordinarily suppressed to avoid confusion: - \pkgoption{spaces} to allow breaks at spaces (note, this requires - \pkgoption{obeyspaces} as well, and \pkgoption{hyphens} to allow - breaks after hyphens. (Note that the package \emph{never} does - ``ordinary'' hyphenation of names inside an \acro{URL}.) - - It is possible to use the \Package{url} package in \plaintex{}, - with the assistance of the \Package{miniltx} package (which was - originally developed for using the \LaTeX{} graphics package in - \plaintex{}). A small patch is also necessary: the required - sequence is therefore: -\begin{narrowversion} -\begin{verbatim} -\input miniltx -\expandafter\def\expandafter\+% - \expandafter{\+} -\input url.sty -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\input miniltx -\expandafter\def\expandafter\+\expandafter{\+} -\input url.sty -\end{verbatim} -\end{wideversion} -\item The \Package{hyperref} package, which uses the typesetting code - of \Package{url}, in a context where the typeset text forms the - anchor of a link. -\end{itemize} - -The author of this answer prefers the (rather newer) \Package{url} -package (directly or indirectly); both \Package{path} and -\Package{url} work well with \plaintex{} (though of course, the fancy -\LaTeX{} facilities of \Package{url} don't have much place there). -(\Package{hyperref} isn't available in a version for use with \plaintex{}.) - -Note that neither \csx{path} (from package \Package{path}) nor \csx{url} (from -package \Package{url}) is robust (in the \LaTeX{} sense). If you need -a \acro{URL} to go in a moving argument, you need the command -\csx{urldef} from the \Package{url} package. So one might write: -\begin{quote} -\begin{verbatim} -\urldef\faqhome\url{http://www.tex.ac.uk/faq} -\end{verbatim} -\end{quote} -after which, \csx{faqhome} is robust. - -Documentation of both package \Package{path} and package \Package{url} -is in the package files. -\begin{ctanrefs} -\item[hyperref.sty]\CTANref{hyperref} -\item[miniltx.tex]Distributed as part of \CTANref{graphics-plain} -\item[path.sty]\CTANref{path} -\item[url.sty]\CTANref{url} -\end{ctanrefs} - -\Question[Q-music]{Typesetting music in \TeX{}} - -In the early days, a simple music package called Mu\TeX{} was -written by Angelika Schofer and Andrea Steinbach, which demonstrated -that music typesetting was possible; the package was very limited, and is -hardly ever used nowadays. Daniel Taupin took up the baton, and -developed Music\TeX{}, which allows the typesetting of polyphonic and -other multiple-stave music; Music\TeX{} remains available, but is most -definitely no longer recommended. - -Music\TeX{} has been superseded by its successor MusiX\TeX{}, which is -a three-pass system (with a processor program that computes values for -the element spacing in the music), and achieves finer control than is -possible in the unmodified \TeX{}-based mechanism that Music\TeX{} -uses. Daniel Taupin's is the only version of MusiX\TeX{} currently -being developed (the original author, Andreas Egler, had an -alternative version, but he is now working on a different package -altogether). - -Input to Musix\TeX{} is extremely tricky stuff, and Don Simons' -preprocessor \ProgName{pmx} is the preferred method of creating input -for Taupin's version. \ProgName{Pmx} greatly eases use of -Musix\TeX{}, but it doesn't support the full range of Musix\TeX{}'s -facilities directly; however, it does allow in-line Musix\TeX{} code -in \ProgName{pmx} sources. - -Dirk Laurie's \ProgName{M-Tx} allows preparation of music with lyrics; -it operates ``on top of'' \ProgName{pmx} - -Another simple notation is supported by \ProgName{abc2mtex}; this is a -package designed to notate tunes stored in an \acro{ASCII} format -(\texttt{abc} notation). It was designed primarily for folk and traditional -tunes of Western European origin (such as Irish, English and Scottish) -which can be written on one stave in standard classical notation, and -creates input intended for Music\TeX{}. However, it should be -extendable to many other types of music. - -Digital music fans can typeset notation for their efforts by using -\ProgName{midi2tex}, which translates \acro{MIDI} data files into -Music\TeX{} source code. - -There is a mailing list (\Email{TeX-music@icking-music-archive.org}) -for discussion of typesetting music in \TeX{}; it mostly covers -Musix\TeX{} and related systems. To subscribe, use -\URL{http://icking-music-archive.org/mailman/listinfo/tex-music/} - -An alternative (free) means of embedding music examples into \AllTeX{} -documents is \href{http://www.lilypond.org}{Lilypond}. Lilypond is -(at heart) a batch music typesetting system with plain text input that -does most of its work without TeX. Lilypond's input syntax is far -less cryptic than is Musix\TeX{}'s, and it handles much more stuff -automatically, yielding the same or better quality with less effort. -Lilypond can also produce basic \acro{MIDI} output. -\begin{ctanrefs} -\item[abc2mtex]\CTANref{abc2mtex} -\item[M-Tx]\CTANref{mtx} -\item[midi2tex]\CTANref{midi2tex} -\item[musictex]\CTANref{musictex} -% ! line breaks -\item[musixtex \nothtml{\rmfamily}(Taupin's version)]\CTANref{musixtex-taupin} -\item[musixtex \nothtml{\rmfamily}(Egler's version)]\CTANref{musixtex-egler} -\item[mutex]\CTANref{mutex} -\item[pmx]\CTANref{pmx} -\end{ctanrefs} - -\Question[Q-parskip]{Zero paragraph indent} - -The conventional way of typesetting running text has no separation -between paragraphs, and the first line of each paragraph in a block of -text indented. - -In contrast, one common convention for typewritten text was to have no -indentation of paragraphs; such a style is often required for -``brutalist'' publications such as technical manuals, and in styles -that hanker after typewritten manuscripts, such as -officially-specified dissertation formats. - -Anyone can see, after no more than a moment's thought, that if the -paragraph indent is zero, the paragraphs must be separated by blank -space: otherwise it is sometimes going to be impossible to see the -breaks between paragraphs. - -The simple-minded approach to zero paragraph indentation is thus: -\begin{verbatim} - \setlength{\parindent}{0pt} - \setlength{\parskip}{\baselineskip} -\end{verbatim} -and in the very simplest text, it's a fine solution. - -However, the non-zero \csx{parskip} interferes with lists and the like, -and the result looks pretty awful. The \Package{parskip} package -patches things up to look reasonable; it's not perfect, but it deals -with most problems. - -The Netherlands Users' Group's set of classes includes an -\Class{article} equivalent (\Class{artikel3}) and a \Class{report} -equivalent (\Class{rapport3}) whose design incorporates zero paragraph -indent and non-zero paragraph skip. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\acro{NTG} classes]\CTANref{ntgclass} -\item[parskip.sty]\CTANref{parskip} -\end{ctanrefs} - -\Question[Q-dropping]{Big letters at the start of a paragraph} - -A common style of typesetting, now seldom seen except in newspapers, -is to start a paragraph (in books, usually the first of a chapter) -with its first letter set large enough to span several lines. - -This style is known as ``dropped capitals'', or (in French) -\latexhtml{``lettrines''}{\htmlentity{laquo}lettrines\htmlentity{raquo}}, -and \TeX{}'s primitive facilities for hanging indentation make its -(simple) implementation pretty straightforward. - -The \Package{dropping} package does the job simply, but has a curious -attitude to the calculation of the size of the font to be used for the -big letters. Examples appear in the package documentation, so before -you process the \extension{dtx}, the package itself must already be -installed. Unfortunately, \Package{dropping} has an intimate relation -to the set of device drivers available in an early version of the -\LaTeX{} graphics package, and it cannot be trusted to work with -modern offerings such as \PDFTeX{}, V\TeX{} or \acro{DVI}pdfm, let -alone such modernisms as \xetex{}. As a result, the package is widely -deprecated, nowadays. - -The more recent \Package{lettrine} package is generally more reliable. -It has a well-constructed array of options, and an impressive set of -examples adds to the package's document. -\begin{ctanrefs} -\item[dropping]\CTANref{dropping} -\item[lettrine]\CTANref{lettrine} -\end{ctanrefs} - -\Question[Q-dec_comma]{The comma as a decimal separator} - -\TeX{} embodies the British/American cultural convention of using a -period as the separator between the whole number and the decimal -fraction part of a decimal number. Other cultures use a comma as -separator, but if you use a comma in maths mode you get a small space -after it; this space makes a comma that is used as a decimal separator -look untidy. - -A simple solution to this problem, in maths mode, is to type -\texttt{3}\marg{,}\texttt{14} in place of \texttt{3,14}. While such a -technique may produce the right results, it is plainly not a -comfortable way to undertake any but the most trivial amounts of -typing numbers. - -Therefore, if you need to use commas as decimal separator, you will -probably welcome macro support. There are two packages that -can help relieve the tedium: \Package{icomma} and \Package{ziffer}. - -\Package{Icomma} ensures that there will be no extra space after a -comma, unless you type a space after it (as in \texttt{f(x, y)}~--- in -the absence of the package, you don't need that space), in which case -the usual small space after the comma appears. \Package{Ziffer} is -specifically targeted at the needs of those typesetting German, but -covers the present need, as well as providing the double-minus sign -used in German (and other languages) for the empty `cents' part of an -amount of currency. - -The \Package{numprint} package provides a command -\cmdinvoke*{numprint}{number} that prints its argument according to -settings you give it, or according to settings chosen to match the -language you have selected in \Package{babel}. The formatting works -equally well in text or maths. The command is very flexible (it can also -group the digits of very `long' numbers), but is inevitably less -convenient than \Package{icomma} or \Package{ziffer} if you are typing a -lot of numbers. -\begin{ctanrefs} -\item[icomma.sty]Distributed as part of \CTANref{was} -\item[numprint.sty]\CTANref{numprint} -\item[ziffer.sty]\CTANref{ziffer} -\end{ctanrefs} - -\Question[Q-breakbox]{Breaking boxes of text} - -\AllTeX{} boxes may not be broken, in ordinary usage: once you've -typeset something into a box, it will stay there, and the box will jut -out beyond the side or the bottom of the page if it doesn't fit in the -typeset area. - -If you want a substantial portion of your text to be framed (or -coloured), the restriction starts to seem a real imposition. -Fortunately, there are ways around the problem. - -The \Package{framed} package provides \environment{framed} and -\environment{shaded} environments; both put their content into -something which looks like a framed (or coloured) box, but which -breaks as necessary at page end. The environments ``lose'' footnotes, -marginpars and head-line entries, and will not work with -\Package{multicol} or other column-balancing macros. The -\Class{memoir} class includes the functionality of the -\Package{framed} package. - -The \Package{boites} package provides a \environment{breakbox} -environment; examples of its use may be found in the distribution, and -the package's \File{README} file contains terse documentation. The -environments may be nested, and may appear inside -\environment{multicols} environments; however, floats, footnotes and -marginpars will be lost. - -For \plaintex{} users, the facilities of the \Package{backgrnd} -package may be useful; this package subverts the output routine to -provide vertical bars to mark text, and the macros are clearly marked -to show where coloured backgrounds may be introduced (this requires -\Package{shade}, which is distributed as tex macros and -device-independent \MF{} for the shading). The author of -\Package{backgrnd} claims that the package works with \LaTeXo{}, but -there are reasons to suspect that it may be unstable working with -current \LaTeX{}. -\begin{ctanrefs} -\item[backgrnd.tex]\CTANref{backgrnd} -\item[boites.sty]\CTANref{boites} -\item[framed.sty]\CTANref{framed} -\item[memoir.cls]\CTANref{memoir} -\item[shade.tex]\CTANref{shade} -\end{ctanrefs} - -\Question[Q-overstrike]{Overstriking characters} - -This may be used, for example, to indicate text deleted in the course -of editing. Both the \Package{ulem} and the \Package{soul} packages -provide the necessary facilities. - -Overstriking for % beware line break -\Qref*{cancellation in maths expressions}{Q-cancellation} is achieved -by a different mechanism. - -Documentation of \Package{ulem} is in the package file. -\begin{ctanrefs} -\item[soul.sty]\CTANref{soul} -\item[ulem.sty]\CTANref{ulem} -\end{ctanrefs} - -\Question[Q-upquot]{Realistic quotes for verbatim listings} - -The \texttt{cmtt} font has ``curly'' quotes\nothtml{ (\texttt{`thus'})}, -which are pleasing on the eye, but don't really tally with what one -sees on a modern % beware line break -\ProgName{xterm}\nothtml{ (which look like \texttt{\textasciigrave this\textquotesingle})}. - -The appearance of these quotes is critical in program listings, -particularly in those of Unix-like shell scripts. The -\Package{upquote} package modifies the behaviour of the -\environment{verbatim} environment so that the output is a clearer -representation of what the user must type. -\begin{ctanrefs} -\item[upquote.sty]\CTANref{upquote} -\end{ctanrefs} - -\Question[Q-time]{Printing the time} - -\TeX{} has a primitive register that contains ``the number of minutes -since midnight''; with this knowledge it's a moderately simple -programming job to print the time (one that no self-respecting -\plaintex{} user would bother with anyone else's code for). - -However, \LaTeX{} provides no primitive for ``time'', so the -non-programming \LaTeX{} user needs help. - -Two packages are available, both providing ranges of ways of printing -the date, as well as of the time: this question will concentrate on -the time-printing capabilities, and interested users can investigate -the documentation for details about dates. - -The \Package{datetime} package defines two time-printing functions: -\csx{xxivtime} (for 24-hour time), \csx{ampmtime} (for 12-hour time) and -\csx{oclock} (for time-as-words, albeit a slightly eccentric set of -words). - -The \Package{scrtime} package (part of the compendious -\Class{KOMA-Script} bundle) takes a package option (\pkgoption{12h} or -\pkgoption{24h}) to specify how times are to be printed. The command -\csx{thistime} then prints the time appropriately (though there's no -\emph{am} or \emph{pm} in \pkgoption{12h} mode). The \csx{thistime} -command also takes an optional argument, the character to separate the -hours and minutes: the default is of course \texttt{:}. -\begin{ctanrefs} -\item[datetime.sty]\CTANref{datetime} -\item[scrtime.sty]Distributed as part of \CTANref{koma-script} -\end{ctanrefs} - -\Question[Q-the-commands]{Redefining counters' \csx{the-}commands} - -Whenever you request a new \LaTeX{} counter, \LaTeX{} creates a bunch -of behind-the-scenes commands, as well as defining the counter -itself. - -Among other things, \cmdinvoke*{newcounter}{fred} creates a command -\csx{the}\texttt{\emph{fred}}, which expands to ``the value of -\texttt{\emph{fred}}'' when you're typesetting. - -The definition of \csx{the}\texttt{\emph{fred}} should express the -value of the counter: it is almost always always a mistake to use the -command to produce anything else. The value may reasonably be -expressed as an arabic, a roman or a greek number, as an alphabetic -expression, or even as a sequence (or pattern of) symbols. If you -need a decision process on whether to re-define -\csx{the}\texttt{\emph{fred}}, consider what might happen when you do -so. - -So, for example, if you want your section numbers to be terminated by -a period, you could make \csx{thesection} expand with a terminating -period. However, such a change to \csx{thesection} makes the -definition of \csx{thesubsection} look distinctly odd: you are going to -find yourself redefining things left, right and centre. Rather, use -the standard techniques for % beware line break -\Qref*{adjusting the presentation of section numbers}{Q-seccntfmt}. - -Or, suppose you want the page number to appear at the bottom of each -page surrounded by dashes (as in -``\texttt{-}{}\texttt{-\textasciitilde}\texttt{nnn\textasciitilde-}{}\texttt{-}''). -If you try to achieve this by redefining \csx{thepage}, problems will -arise from the use of the page number in the table of contents (each -number will have the dashes attached), and \csx{pageref} references -will be oddly modified. In this case, the change of appearance is -best done by redefining the page style itself, perhaps using -\Qref*{package \Package{fancyhdr}}{Q-fancyhdr}. - -\subsection{Tables of contents and indexes} - -\Question[Q-tocloft]{The format of the Table of Contents, etc.} - -The formats of entries in the table of contents (\acro{TOC}) are -controlled by a number of internal commands (discussed in section~2.3 -of \Qref*{\emph{The \LaTeX{} Companion}}{Q-books}. The commands -\csx{@pnumwidth}, \csx{@tocrmarg} and \csx{@dotsep} control the space -for page numbers, the indentation of the right-hand margin, and the -separation of the dots in the dotted leaders, respectively. The -series of commands named \csx{l@\emph{xxx}}, where \texttt{\emph{xxx}} -is the name of a sectional heading (such as \texttt{chapter} or -\texttt{section}, \dots{}\@) control the layout of the corresponding -heading, including the space for section numbers. All these internal -commands may be individually redefined to give the effect that you -want. - -Alternatively, the package \Package{tocloft} provides a set of -user-level commands that may be used to change the \acro{TOC} -formatting. Since exactly the same mechanisms are used for the List -of Figures and List of Tables, the layout of these sections may be -controlled in the same way. - -The \Class{KOMA-Script} classes provides an optional variant structure -for the table of contents, and calculates the space needed for the -numbers automatically. The \Class{memoir} class includes the functionality -of \Package{tocloft}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[tocloft.sty]\CTANref{tocloft} -\end{ctanrefs} - -\Question[Q-secnumdep]{Unnumbered sections in the Table of Contents} - -The way the relevant parts of sectioning commands work is exemplified -by the way the \csx{chapter} command uses the counter \texttt{secnumdepth} -(described in Appendix~C of the \LaTeX{} manual): -\begin{enumerate} -\item put something in the \extension{aux} file, which will appear in - the \extension{toc}; -\htmlignore -\item if \ensuremath{\texttt{secnumdepth} \geq 0}, -\endhtmlignore -\begin{htmlversion} -\item if the \texttt{secnumdepth} counter is greater than or equal to - zero, -\end{htmlversion} - increase the counter for the chapter and write it out. -\item write the chapter title. -\end{enumerate} -Other sectioning commands are similar, but with other values used in -the test. - -So a simple way to get headings of funny `sections' such as prefaces -in the table of contents is to use the counter: -\begin{quote} -\begin{verbatim} -\setcounter{secnumdepth}{-1} -\chapter{Preface} -\end{verbatim} -\end{quote} -Unfortunately, you have to set \texttt{secnumdepth} back to its usual -value (which is~2 in the standard styles) before you do any `section' -which you want to be numbered. - -Similar settings are made, automatically, in the \LaTeX{} book class by -the \csx{frontmatter} and \csx{backmatter} commands. - -The value of the counter \texttt{tocdepth} controls which headings -will be finally printed in the table of contents. This normally has -to be set in the preamble and is a constant for the document. The -package \Package{tocvsec2} package provides a convenient interface to -allow you to change the \texttt{secnumdepth} and/or the -\texttt{tocdepth} counter values at any point in the body of the -document; this provides convenient independent controls over the -sectional numbering and the table of contents. - -The package \Package{abstract} (see % line break! -\Qref[question]{one-column abstracts}{Q-onecolabs}) includes an option -to add the \texttt{abstract} to the table of contents, while the -package \Package{tocbibind} has options to include the table of -contents itself, the \texttt{bibliography}, \texttt{index}, etc., to -the table of contents. - -The \Class{KOMA-Script} classes have commands \csx{addchap} and -\csx{addled}, which work like \csx{chapter} and \csx{section} but -aren't numbered. The \Class{memoir} class incorporates the facilities -of all three of the \Package{abstract}, \Package{tocbibind} and -\Package{tocvsec2} packages. -\begin{ctanrefs} -\item[abstract.sty]\CTANref{abstract} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[tocbibind.sty]\CTANref{tocbibind} -\item[tocvsec2.sty]\CTANref{tocvsec2} -\end{ctanrefs} - -\Question[Q-tocbibind]{Bibliography, index, etc., in \acro{TOC}} - -The standard \LaTeX{} classes (and many others) use \csx{section*} or -\csx{chapter*} for auto-generated parts of the document (the tables of -contents, lists of figures and tables, the bibliography and the index). As a -result, these items aren't numbered (which most people don't mind), -and (more importantly) they don't appear in the table of contents. - -The correct solution (as always) is to have a class of your own that -formats your document according to your requirements. The macro to do -the job (\csx{addcontentsline}) is fairly simple, but there is always -an issue of ensuring that the contents entry quotes the correct page. -Supposing that our the document is chapter-based (class \Class{report} -or \Class{book}, for example), the text: -\begin{quote} -\begin{verbatim} -\bibliography{frooble} -\addcontentsline{toc}{chapter}{Bibliography} -\end{verbatim} -\end{quote} -will produce the \emph{wrong} answer if the bibliography is more than -one page long. Instead, one should say: -\begin{quote} -\begin{verbatim} -\cleardoublepage -\addcontentsline{toc}{chapter}{Bibliography} -\bibliography{frooble} -\end{verbatim} -\end{quote} -(Note that \csx{cleardoublepage} does the right thing, even if your -document is single-sided~--- in that case, it's a synonym for -\csx{clearpage}). Ensuring that the entry refers to the right place is -trickier still in a \csx{section}-based class. - -If you are using \Package{hyperref} (which will link entries in the -table of contents to the relevant place in the file), a slight -adjustment is necessary: -\begin{quote} -\begin{verbatim} -\cleardoublepage -\phantomsection -\addcontentsline{toc}{chapter}{Bibliography} -\bibliography{frooble} -\end{verbatim} -\end{quote} -The extra command (\csx{phantomsection}) gives \Package{hyperref} -something to ``hold on to'' when making the link. - -The common solution, therefore, is to use the \Package{tocbibind} -package, which provides many facilities to control the way these -entries appear in the table of contents. - -Classes of the \Class{KOMA-script} bundle provide this functionality -as a set of class options (e.g., \pkgoption{bibtotoc} to add the -bibliography to the table of contents); the \Class{memoir} class includes -\Package{tocbibind} itself. -\begin{ctanrefs} -\item[hyperref.sty]\CTANref{hyperref} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[tocbibind.sty]\CTANref{tocbibind} -\end{ctanrefs} - -\Question[Q-minitoc]{Table of contents, etc., per chapter} - -The common style, of a ``small'' table of contents for each part, -chapter, or even section, is supported by the \Package{minitoc} -package. The package also supports mini-lists of tables and figures; -but, as the documentation observes, mini-bibliographies are a -different problem~--- see -\Qref[question]{bibliographies per chapter}{Q-chapbib}. - -The package's basic scheme is to generate a little \extension{aux} file for -each chapter, and to process that within the chapter. Simple usage -would be: -\begin{quote} -\begin{verbatim} -\usepackage{minitoc} -... -\begin{document} -... -\dominitoc \tableofcontents -\dominilof \listoffigures -... -\chapter{blah blah} -\minitoc \mtcskip \minilof -... -\end{verbatim} -\end{quote} -though a lot of elaborations are possible (for example, you don't need -a \csx{minitoc} for every chapter). - -\Package{Babel} doesn't know about \Package{minitoc}, but -\Package{minitoc} makes provision for other document languages than -English~--- a wide variety is available. Fortunately, the current -version of the \Package{hyperref} package does know about -\Package{minitoc} and treats \csx{minitoc} tables in the -same way as ``real'' tables of contents. -\begin{ctanrefs} -\item[babel.sty]\CTANref{babel} -\item[hyperref.sty]\CTANref{hyperref} -\item[minitoc.sty]\CTANref{minitoc} -\end{ctanrefs} - -\Question[Q-multind]{Multiple indexes} - -\LaTeX{}'s standard indexing capabilities (those provided by the -\Package{makeidx} package) only provide for one index in your -document; even quite modest documents can be improved by indexes for -separate topics. - -The \Package{multind} package provides simple and straightforward -multiple indexing. You tag each \csx{makeindex}, \csx{index} and -\csx{printindex} command with a file name, and indexing commands are -written to (or read from) the name with the appropriate (\extension{idx} or -\extension{ind}) extension appended. The \csx{printindex} command is modified -from the \LaTeX{} standard so that it doesn't create its own chapter -or section heading; you therefore decide what names (or sectioning -level, even) to use for the indexes, and -\Qref*{\csx{indexname}}{Q-fixnam} is completely ignored. - -To create a ``general'' and an ``authors'' index, one might write: -\begin{quote} -\begin{verbatim} -\usepackage{multind} -\makeindex{general} -\makeindex{authors} -... -\index{authors}{Another Idiot} -... -\index{general}{FAQs} -... -\printindex{general}{General index} -\printindex{authors}{Author index} -\end{verbatim} -\end{quote} -To complete the job, run \LaTeX{} on your file enough times that -labels, etc., are stable, and then execute the commands -\begin{quote} -\begin{verbatim} -makeindex general -makeindex authors -\end{verbatim} -\end{quote} -before running \LaTeX{} again. Note that the names of the index files -to process are not necessarily related to the name of the \LaTeX{} -file you're processing, at all. (There's no documentation that comes -with the package: what you see above is as good as you will -get\dots{}) - -The \Package{index} package provides a comprehensive set of indexing -facilities, including a \csx{newindex} command that allows the -definition of new styles of index. \csx{newindex} takes a `tag' (for -use in indexing commands), replacements for the \extension{idx} and -\extension{ind} file extensions, and a title for the index when it's -finally printed; it can also change the item that's being indexed -against (for example, one might have an index of artists referenced by -the figure number where their work is shown). - -Using \Package{index}, to create an author index together with a -``normal'' index, one would start with preamble commands: -\begin{quote} -\begin{verbatim} -\usepackage{index} -\makeindex -\newindex{aut}{adx}{and}{Name Index} -\end{verbatim} -\end{quote} -which load the package, define a ``main'' (original-style) index, and -then define an author index. Then, in the body of the document, we -might find commands like: -\begin{quote} -\begin{verbatim} -\index[aut]{Another Idiot} -... -\index{FAQs} -\end{verbatim} -\end{quote} -Which place an entry in the author index, and then one in the main -index. At the end of the document, we have two commands: -\begin{quote} -\begin{verbatim} -\printindex -\printindex[aut] -\end{verbatim} -\end{quote} -Which will print the main index and then the author index. Supposing -this lot to be in \File{myfile.tex}, after enough runs through -\LaTeX{} that labels are stable, execute the following commands -(Unix-style shell commands shown here, but the principle is the same -whatever system you're using): -\begin{quote} -\begin{verbatim} -makeindex myfile -makeindex myfile.adx -o myfile.and -\end{verbatim} -\end{quote} -and rerun \LaTeX{}. The \ProgName{makeindex} commands process -\File{myfile.idx} to \File{myfile.ind} (the default action), and then -\File{myfile.adx} to \File{myfile.and}, the two files needed as input -by the two \csx{printindex} commands in \File{myfile.tex}. - -The \Package{splitidx} package can operate in the same way as the -others: load the package with the \pkgoption{split} option, and -declare each index with a \csx{newindex} command: -\begin{quote} - \cmdinvoke{newindex}[\meta{index name}]{\meta{shortcut}} -\end{quote} -and \Package{splitidx} will generate a file -\csx{jobname}\texttt{.\meta{shortcut}} to receive index entries -generated by commands like \cmdinvoke{sindex}[\meta{shortcut}]{\meta{item}}. -As with the other packages, this method is limited by \TeX{}'s total -number of output files. However, \Package{splitindex} also comes with -a small executable \ProgName{splitindex} (available for a variety of -operating systems); if you use this auxiliary program (and don't use -\pkgoption{split}), there's no limit to the number of indexes. Apart -from this trick, \Package{splitidx} supports the same sorts of things -as does \Package{index}. An example of use appears in -the documentation. - -The \Class{memoir} class has its own multiple-index functionality (as -well as its own index layout options, which other packages delegate to -the index style used by \ProgName{makeindex}). -\begin{ctanrefs} -\item[index.sty]\CTANref{index} -\item[makeidx.sty]Part of the \LaTeX{} distribution -\item[memoir.cls]\CTANref{memoir} -\item[multind.sty]\CTANref{multind} -\item[splitidx.sty \bgroup\nothtml{\normalfont}and \egroup splitindex]% - \CTANref{splitindex} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\subsection{Labels and references} - -\Question[Q-nameref]{Referring to things by their name} - -\LaTeX{}'s labelling mechanism is designed for the impersonal world of -the academic publication, in which everything has a number: an -extension is necessary if we are to record the \emph{name} of things -we've labelled. The two packages available extend the \LaTeX{} -sectioning commands to provide reference by the name of the section. - -The \Package{titleref} package is a simple extension which provides -the command \csx{titleref}; it is a stand-alone package~--- don't use it -in a document in which you also need to use \Package{hyperref}. - -The \Package{byname} package is part of the \Package{smartref} bundle -and works well with \Package{smartref}, and works (to an extent) with -\Package{hyperref}, but the links it defines are not hyperlinks. - -The \Class{memoir} class incorporates the functionality of -\Package{titleref}, but doesn't work with \Package{byname} (though a -search of \Newsgroup{comp.text.tex} on \URL{groups.google.com} will -find a patch to \Package{byname} to remedy the problem). - -The \Package{hyperref} bundle includes a package \Package{nameref}, -which will work standing alone (i.e., without \Package{hyperref}: of -course, in this mode its references are not hyperlinked). If you load -\Package{hyperref} itself, \Package{nameref} is automatically loaded. -\Class{Memoir} requires the \Package{memhfixc} when running with -\Package{hyperref}; following the sequence: -\begin{quote} -\begin{verbatim} -\documentclass[...]{memoir} -... -\usepackage[...]{hyperref} -\usepackage{memhfixc} -\end{verbatim} -\end{quote} -\Package{nameref} commands may be used in a \Class{memoir} document. - -\Package{Zref} defines a proposed replacement for all of the \LaTeX{} -reference mechanisms, and among other things provides -name-referencing mechanisms: -\begin{quote} -\begin{verbatim} -\usepackage[user,titleref]{zref} -... -\section{hello}\zlabel{sec:one} -The section name is: \ztitleref{sec:one}. -\end{verbatim} -\end{quote} -(One might hope that something of this sort would be the ``way of the -future'', but things move slowly in the \LaTeX{} world: don't hold -your breath.) - -Each of \Package{titleref}, \Package{byname} and \Package{nameref} -defines a reference command with the same name as the package: -\csx{titleref}, \csx{byname} and \csx{nameref}. The \Package{nameref} -package also defines a command \csx{byshortnameref}, which uses the -optional `short' title argument to the chapter and section commands. -(Although it comes from the same author, \Package{zref} \emph{doesn't} -define a short-name variant.) -\begin{ctanrefs} -\item[byname.sty]Distributed with \CTANref{smartref} -\item[hyperref.sty]\CTANref{hyperref} -\item[memoir.cls]\CTANref{memoir} -\item[nameref.sty]Distributed with \CTANref{hyperref} -\item[smartref.sty]\CTANref{smartref} -\item[titleref.sty]\CTANref{titleref} -\item[zref.sty]Distributed as part of \CTANref{oberdiek} -\end{ctanrefs} - -\Question[Q-extref]{Referring to labels in other documents} - -When producing a set of inter-related documents, you'll often want to -refer to labels in another document of the set; but \LaTeX{}, of its -own accord, doesn't permit this. - -So the package \Package{xr} was written: if you say -\begin{quote} -\begin{verbatim} -\usepackage{xr} -\externaldocument{volume1} -\end{verbatim} -\end{quote} -will load all the references from \File{volume1} into your present -document. - -But what if the documents both have a section labelled -``\environment{introduction}'' (likely enough, after all)? The -package provides a means to transform all the imported labels, so you -don't have to change label names in either document. For example: -\begin{quote} -\begin{verbatim} -\usepackage{xr} -\externaldocument[V1-]{volume1} -\end{verbatim} -\end{quote} -loads the references from \File{volume1}, but prefixes every one with -the string \texttt{V1-}. So you would refer to the introduction to volume~1 -as: -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -\usepackage{xr} -\externaldocument[V1-]{volume1} -... -... the introduction to volume1 - (\ref{V1-introduction})... -\end{verbatim} -\end{quote} -\end{narrowversion} -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\usepackage{xr} -\externaldocument[V1-]{volume1} -... -... the introduction to volume1 (\ref{V1-introduction})... -\end{verbatim} -\end{quote} -\end{wideversion} -To have the facilities of \Package{xr} working with -\Package{hyperref}, you need \Package{xr-hyper}. For simple -hyper-cross-referencing (i.e., to a local \acro{PDF} file you've just -compiled), write: -\begin{quote} -\begin{verbatim} -\usepackage{xr-hyper} -\usepackage{hyperref} -\externaldocument[V1-]{volume1} -... -... the \nameref{V1-introduction})... -\end{verbatim} -\end{quote} -and the name reference will appear as an active link to the -``introduction'' chapter of \File{volume1.pdf}. - -To link to a \acro{PDF} document on the Web, for which you happen to -have the .aux file, write: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\usepackage{xr-hyper} -\usepackage{hyperref} -\externaldocument[V1-]{volume1}[http://mybook.com/volume1.pdf] -... -... the \nameref{V1-introduction})... -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\usepackage{xr-hyper} -\usepackage{hyperref} -\externaldocument[V1-]{volume1}% - [http://mybook.com/volume1.pdf] -... -... the \nameref{V1-introduction})... -\end{verbatim} -\end{narrowversion} -\end{quote} -Heiko Oberdiek's experimental \Package{zref} bundle includes a -hyper-crossreferencing mechanism using its \Package{zref-xr} module. -Usage is closely modelled on \Package{xr} and \Package{xr-hyper}; a -trivial example (from a \Newsgroup{comp.text.tex} posting) is -\begin{quote} -\begin{verbatim} -\usepackage{zref-xr,zref-user} -\zexternaldocument*{xr02} -... -\zref{foo} -\end{verbatim} -\end{quote} -The module provides all the facilities of the older packages, and can -deal both with ``traditional'' \LaTeX{} labels and with -\Package{zref}'s style of labels. -\begin{ctanrefs} -\item[xr.sty]Distributed as part of \CTANref{2etools} -\item[xr-hyper.sty]Distributed with \CTANref{hyperref} -\item[zref \nothtml{\rmfamily\itshape}bundle]Distributed as part of - \CTANref{oberdiek} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{How do I do\dots{}?} - -\subsection{Mathematics} - -\Question[Q-proof]{Proof environment} - -It has long been thought impossible to make a \environment{proof} -environment which automatically includes an `end-of-proof' symbol. -Some proofs end in displayed maths; others do not. If the input file -contains -% beware line break -\texttt{...\csx{]} }\cmdinvoke{end}{proof} then \LaTeX{} finishes off -the displayed maths and gets ready for a new line before it reads any -instructions connected with ending the proof, so the code is very -tricky. You \emph{can} insert the symbol by hand, but the -\Package{ntheorem} package now solves the problem for \LaTeX{} users: -it does indeed provide an automatic way of signalling the end of a -proof. - -The \AMSLaTeX{} package \Package{amsthm} also provides a -\environment{proof} environment that does the job; though you need to -insert a \csx{qedhere} command if the proof ends with a displayed -equation: -\begin{quote} -\begin{verbatim} -\begin{proof} - text... - \begin{equation*} - maths... \tag*{\qedhere} - \end{equation*} -\end{proof} -\end{verbatim} -\end{quote} -The \cmdinvoke{tag*}{\csx{qedhere}} construction may be used in any of -\AMSLaTeX{}'s numbering environments. -\begin{ctanrefs} -\item[amsthm.sty]Distributed as part of the \AMSLaTeX{} bundle - \CTANref{amslatex} -\item[ntheorem.sty]\CTANref{ntheorem} -\end{ctanrefs} - -\Question[Q-theoremfmt]{Theorem bodies printed in a roman font} - -If you want to take advantage of the powerful \csx{newtheorem} command -without the constraint that the contents of the theorem is in a sloped -font (for example, you may want to use it to create remarks, examples, proofs, -\dots{}) then you can use the \AMSLaTeX{} \Package{amsthm} package -(which now supersedes the \Package{theorem} package previously -recommended in these answers). -Alternatively, the following sets up an environment -\environment{remark} whose content is in the default roman font. -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\newtheorem{preremark}{Remark} -\newenvironment{remark}% - {\begin{preremark}\upshape}% - {\end{preremark}} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\newtheorem{preremark}{Remark} -\newenvironment{remark}% - {\begin{preremark}\upshape}{\end{preremark}} -\end{verbatim} -\end{wideversion} -\end{quote} -The \Package{ntheorem} package provides control of the fonts used by -theorems, directly. -\begin{ctanrefs} -\item[amsthm.sty]Distributed as part of \CTANref{amslatex} -\item[ntheorem.sty]\CTANref{ntheorem} -\item[theorem.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-newfunction]{Defining a new log-like function in \LaTeX{}} - -Use the \csx{mathop} command, as in: -\begin{quote} -\begin{verbatim} -\newcommand{\diag}{\mathop{\mathrm{diag}}} -\end{verbatim} -\end{quote} - -Subscripts and superscripts on \csx{diag} will be placed below and -above the function name, as they are on -\csx{lim}. If you want your subscripts and superscripts always placed -to the right, do: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\newcommand{\diag}% - {\mathop{\mathrm{diag}}\nolimits} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\newcommand{\diag}{\mathop{\mathrm{diag}}\nolimits} -\end{verbatim} -\end{wideversion} -\end{quote} - -\AMSLaTeX{} (in its \Package{amsopn} package, which is automatically -loaded by \Package{amsmath}) provides a command -\csx{DeclareMathOperator} that takes does the same job as the first -definition above. To create our original \csx{diag} command, one would -say: -\begin{quote} -\begin{verbatim} -\DeclareMathOperator{\diag}{diag} -\end{verbatim} -\end{quote} -\csx{DeclareMathOperator*} declares the operator always to have its -sub- and superscripts in the % ! line break -``\Qref*{\csx{limits} position}{Q-limits}''. - -The \Package{amsopn} command \csx{operatorname} allows you to -introduce \emph{ad hoc} operators into your mathematics, so -\begin{quote} - \csx{[} \cmdinvoke{operatorname}{foo}\texttt{(bar)} \csx{]} -\end{quote} -typesets the same as -\begin{quote} -\begin{verbatim} -\DeclareMathOperator{\foo}{foo} -... -\[ \foo(bar) \] -\end{verbatim} -\end{quote} -As with \csx{DeclareMathOperator} there's a starred version -\csx{operatorname*} for sub- and superscripts in the limits position. - -(It should be noted that ``log-like'' was reportedly a \emph{joke} on -Lamport's part; it is of course clear what was meant.) -\begin{ctanrefs} -\item[amsopn.sty]In the \AMSLaTeX{} distribution \CTANref{amslatex} -\end{ctanrefs} - -\Question[Q-braket]{Set specifications and Dirac brackets} - -One of the few glaring omissions from \TeX{}'s mathematical -typesetting capabilities is a means of setting separators in the -middle of mathematical expressions. \TeX{} provides primitives called -\csx{left} and \csx{right}, which can be used to modify brackets (of -whatever sort) around a mathematical expression, as in: -% beware line wrap -\csx{left(}\texttt{ <expression> }\csx{right)}~--- the size of the -parentheses is matched to the vertical extent of the expression. - -However, in all sorts of mathematical enterprises one may find oneself -needing a \csx{middle} command, to be used in expressions like -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\left\{ x \in \mathbb{N} \middle| x \mbox{ even} \right\} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\left\{ x\in \mathbb{N} \middle| - x \mbox{ even} \right\} -\end{verbatim} -\end{narrowversion} -\end{quote} -to specify the set of even natural numbers. The % ! line break -\Qref*{\eTeX{} system}{Q-etex} -defines just such a command, but users of Knuth's original need some -support. Donald Arseneau's \Package{braket} package provides commands -for set specifications (as above) and for Dirac brackets (and bras and -kets). The package uses the \eTeX{} built-in command if it finds -itself running under \eTeX{}. -\begin{ctanrefs} -\item[braket.sty]\CTANref{braket} -\end{ctanrefs} - -\Question[Q-cancellation]{Cancelling terms in maths expressions} - -A technique used when explaining the behaviour of expressions or -equations (often for pedagogical purposes). The \Package{cancel} -package provides several variants of cancellation marks -(``\texttt{\textbackslash }'', ``\texttt{/}'' and ``\texttt{X}''), and -a means of cancelling `to' a particular value. - -Documentation of \Package{cancel} is in the package file. -\begin{ctanrefs} -\item[cancel.sty]\CTANref{cancel} -\end{ctanrefs} - -\Question[Q-mathsize]{Adjusting maths font sizes} - -In \plaintex{}, when you introduce a new font size you must also -declare what size fonts are to be used in mathematics with it. This -is done by declaring \csx{textfont}, \csx{scriptfont} and -\csx{scriptscriptfont} for the maths families you're using; all such -things are described in chapter~17 of the % line wrap! -\Qref*{\TeX{}book}{Q-books} and in other books and -\Qref*{tutorials}{Q-man-tex} that discuss \plaintex{} in sufficient -detail. - -In \LaTeX{}, of course, all this stuff is automated: there is a scheme -that, for each (text) font size, determines what maths font sizes are -to be used. The scheme first checks a set of ``known'' text sizes, -for each of which maths sizes are declared in advance. If the text -size isn't ``known'', the script- and scriptscriptfont sizes are -calculated as fixed ratios of the tex font size. (The values used are -\csx{defaultscriptratio}\ensuremath{=}0.7, and -\csx{defaultscriptscriptratio}\ensuremath{=}0.5.) - -The fixed-ratio formula is capable of producing inconvenient results -(particularly if you are using fonts which \LaTeX{} believes are only -available in a fixed set of sizes). You may also want to replace -\LaTeX{}'s ideas altogether, for example by setting maths noticeably -larger or smaller than its surrounding text. For this purpose, the -\LaTeX{} command -\cmdinvoke{DeclareMathSizes}{\meta{tfs}}{\meta{ts}}{\meta{ss}}{\meta{sss}} -may be used (this is the same command that \LaTeX{} itself uses to -define its own set of sizes). This establishes (or re-establishes) -the maths font sizes to be used when the surrounding text font size is -\texttt{\meta{tfs}}; (\texttt{\meta{ts}} being the size used for -\csx{textfont}, \texttt{\meta{ss}} for \csx{scriptfont} and -\texttt{\meta{sss}} for \csx{scriptscriptfont}). - -For example, you might want to use a font with a smaller body height -than Computer Modern, but still prefer \acro{CM} math to any of the -alternatives. In this case, you might use: -\begin{quote} -\begin{verbatim} -\DeclareMathSizes{10}{9}{7}{5} -\end{verbatim} -\end{quote} -to get 9pt maths when the surrounding body text is (nominal) 10pt. - -\csx{DeclareMathSizes} may only be used in the preamble of the -document: only one association is available for each text font size -for the whole document. The default settings are specified in -\File{fontdef.dtx} in the latex distribution, and are compiled into -\File{fontmath.ltx}; the arguments to the command are just numbers -(`\texttt{pt}' is assumed), but some of them are written using -\Qref*{\LaTeX{} abbreviations}{Q-ltxabbrv} for standard font sizes. -Beware simply copying (parts of) the \LaTeX{} definitions~--- since -they contain those internal abbreviations, they need to be treated as -\Qref{internal commands}{Q-atsigns}. -\begin{ctanrefs} -\item[fontdef.dtx]\CTANref{fontdef} -\item[fontmath.ltx]\CTANref{fontmath} -\end{ctanrefs} - -\Question[Q-mathlips]{Ellipses} -\keywords{\csx{dots} \csx{cdots} \csx{vdots} \csx{ddots}} - -Ellipses are commonly required, and \LaTeX{} natively supplies a fair -range (\csx{dots}, \csx{cdots}, \csx{vdots} and \csx{ddots}). By using -the \Package{graphics} package, one can change the slope of the -\csx{ddots} command, as in -\begin{verbatim} - $ ... \reflectbox{$\ddots$} ... $ -\end{verbatim} -While this works, it is not a recommended way of achieving the desired -result (see below). Moreover, \LaTeX{}'s range is not adequate to -everyone's requirements, and at least three packages provide -extensions to the set. - -The \AMSLaTeX{} bundle provides a range of ``semantically-named'' -ellipses, for use in different situations: \csx{dotsb} for use between -pairs of binary operators, \csx{dotsc} for use between pairs of commas, -and so on. - -The \Package{yhmath} package defines an \csx{adots} command, which is -the analogue of \csx{ddots}, sloping forwards rather than backwards. -The \Package{yhmath} package comes with a rather interesting font that -extends the standard \Package{cmex}; details are in the documentation. -The disadvantage of this setup is, that although \csx{adots} is merely -a macro, the package tries to load its own font and produces a -``missing font'' substitution warning message if you haven't installed -the font. - -The \Package{mathdots} package (besides fixing up the behaviour of -\AllTeX{} \csx{ddots} and \csx{vdots} when the font size changes) -provides an ``inverse diagonal'' ellipsis \csx{iddots} (doing the same -job as \Package{yhmath}'s \csx{adots}, but better). - -Documentation of \Package{yhmath} appears, processed, in the -distribution (thus saving you the bother of installing the package -before being able to read the documentation). Documentation of -\Package{mathdots} appears at the end the package file itself. -\begin{ctanrefs} -\item[amslatex]\CTANref{amslatex} -\item[graphics.sty]Part of the \CTANref{graphics} bundle -\item[mathdots.sty]\CTANref{mathdots} -\item[yhmath \nothtml{\rmfamily}(fonts)]\CTANref{yhmath-fonts} -\item[yhmath \nothtml{\rmfamily}(macros)]\CTANref{yhmath-macros} -\end{ctanrefs} - -\Question[Q-limits]{Sub- and superscript positioning for operators} - -The commonest hand-written style for expressions is to place the limit -expressions on operators such as \csx{sum} and \csx{int} physically -above and below the operator. In \AllTeX{}, we write these limit -expressions using sub- and superscripts applied to the operator, but -they don't always appear in the ``handwritten'' way in \TeX{}'s -output. - -The reason is, that when an expression appears in non-display maths, -in running text (and is therefore in \TeX{} \csx{textstyle}), placing -the limits thus could lead to ragged line spacing (and hence -difficult-to-read text). It is therefore common (in \csx{textstyle}) -to place the limits as one would sub- and superscripts of variables. - -This is not universally satisfactory, so the primitive \csx{limits} is -provided: -\begin{quote} -\begin{verbatim} -$\sum\limits_{n=1}^{m} ...$ -\end{verbatim} -\end{quote} -which will place the limits right above and below the symbol (and be -blowed to the typography\dots{}). - -Contrariwise, you may wish to change the arrangement of the limits -when in \csx{displaystyle}. For this purpose, there's a corresponding -\csx{nolimits}: -\begin{quote} -\begin{verbatim} -\[\sum\nolimits_{n=1}^{m} ...\] -\end{verbatim} -\end{quote} -which will place the limits as they would be in \csx{textstyle}. - -Alternatively, one can manipulate the -\csx{textstyle}/\csx{displaystyle} state of the mathematics. To get -``\csx{limits} placement'' in inline maths, -\begin{quote} -\begin{verbatim} -$\displaystyle\sum_{n=1}^{m} ...$ -\end{verbatim} -\end{quote} -and for ``\csx{nolimits} placement'' in display maths, -\csx{nolimits}: -\begin{quote} -\begin{verbatim} -\[\textstyle\sum_{n=1}^{m} ...\] -\end{verbatim} -\end{quote} -will serve. Either of these forms may have effects other than on the -operator you're considering, but there are still those who prefer this -formulation. - -Remember, if you're % ! line break -\Qref*{declaring a special operator of your own}{Q-newfunction}, the -\AMSLaTeX{} functions (that you ought to be using) allow you to choose -how limits are displayed, at definition time. - -(Note that the macro \csx{int} normally has \csx{nolimits} built in to -its definition. There is an example in the \TeX{}book to show how odd -\csx{int}\csx{limits} looks when typeset.) - -\Question[Q-mathstext]{Text inside maths} - -When we type maths in \AllTeX{}, the letters from which we make up -ordinary text assume a special significance: they all become -single-letter variable names. The letters appear in italics, but it's -not the same sort of italics that you see when you're typing ordinary -text: a run of maths letters (for example ``here'') looks oddly -``lumpy'' when compared with the word written in italic text. The -difference is that the italic text is kerned to make the letters fit -well together, whereas the maths is set to look as if you're -multiplying \emph{h} by \emph{e} by \emph{r} by \emph{e}. The other -way things are odd in \TeX{} maths typing is that spaces are ignored: -at best we can write single words in this oddly lumpy font. - -So, if we're going to have good-looking text in amongst maths we're -writing, we have to take special precautions. If you're using -\LaTeX{}, the following should help. - -The simplest is to use \csx{mbox} or \csx{textrm}: -\begin{quote} -\begin{verbatim} -$e = mc^2 \mbox{here we go again}$ -\end{verbatim} -\end{quote} -The problem is that, with either, the size of the text remains firmly -at the surrounding text size, so that -\begin{quote} -\begin{verbatim} -$z = a_{\mbox{other end}}$ -\end{verbatim} -\end{quote} -looks quite painfully wrong. - -The other simple technique, \csx{textrm}, is more promising: -\begin{quote} -\begin{verbatim} -$z = a_{\textrm{other end}}$ -\end{verbatim} -\end{quote} -is definitely right. However, the surrounding text may not be in your -roman font; if you care about matching text, you need to choose -between \csx{textrm}, \csx{textsf}, and so on. - -(The maths-mode instance of your roman font (\csx{mathrm}) gets the -size right, but since it's intended for use in maths, its spaces get -ignored~--- use \csx{mathrm} for upright roman alphabetic variable -names, but not otherwise.) - -You can correct these problems with size selectors in the text, as: -\begin{quote} -\begin{verbatim} -$z = a_{\mbox{\scriptsize other end}}$ -\end{verbatim} -\end{quote} -which works if your surrounding text is at default document size, but -gives you the wrong size otherwise. - -These short cuts are (just about) \acro{OK} for the ``occasional'' -mathematician, but serious mathematics calls for a technique that -relieves the typist of the sort of thought required. As usual, the -\AMSLaTeX{} system provides what's necessary~--- the \csx{text} -command. The command is actually provided by the \Package{amstext} -package, but the ``global'' \Package{amsmath} package loads it, so -anyone using \AMSLaTeX{} proper has the command available, so even -joke mathematicians can write: -\begin{quote} -\begin{verbatim} -\usepackage{amsmath} -... -$z = a_{\text{other end}}$ -\end{verbatim} -\end{quote} -and the text will be at the right size, and in the same font as -surrounding text. - -\AMSLaTeX{} also makes provision for interpolated comments in the -middle of one of its multi-line display structures, through the -\csx{intertext} command. For example: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\begin{align} - A_1&=N_0(\lambda;\Omega')- - \phi(\lambda;\Omega'),\\ - A_2&=\phi(\lambda;\Omega')- - \phi(\lambda;\Omega),\\ -\intertext{and} - A_3&=\mathcal{N}(\lambda;\omega). -\end{align} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\begin{align} - A_1&=N_0(\lambda;\Omega')-\phi(\lambda;\Omega'),\\ - A_2&=\phi(\lambda;\Omega')-\phi(\lambda;\Omega),\\ - \intertext{and} A_3&=\mathcal{N}(\lambda;\omega). -\end{align} -\end{verbatim} -\end{wideversion} -\end{quote} -places the text ``and'' on a separate line before the last line of the -display. If the interjected text is short, or the equations -themselves are light-weight, you may find that \csx{intertext} leaves -too much space. Slightly more modest is the \csx{shortintertext} -command from the \Package{mathtools} package: -\begin{quote} -\begin{verbatim} -\begin{align} - a =& b - \shortintertext{or} - c =& b -\end{align} -\end{verbatim} -\end{quote} -To have the text on the same line as the second equation, one can use -the \environment{flalign} environment (from \Package{amsmath}) -with lots of dummy equations (represented by the double \texttt{\&} -signs): -\begin{quote} -\begin{verbatim} -\begin{flalign} - && a =& b && \\ - \text{or} && c =& b && -\end{flalign} -\end{verbatim} -\end{quote} - -Comprehensive documentation of \AMSLaTeX{} is to be found in -\File{amsldoc}, in the distribution; it is also available on the web -at \URL{ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf} -\begin{ctanrefs} -\item[amsldoc.tex]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} -\item[amsmath.sty]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} -\item[amstext.sty]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} -\item[mathtools.sty]Distributed as part of the \Package{mh} bundle - \CTANref{mh} -\end{ctanrefs} - -\Question[Q-reuseq]{Re-using an equation} - -To repeat an existing equation, one wants not only to have the same -mathematics in it, one also wants to re-use the original label it had. -The \Package{amsmath} package comes to our help, here: -\begin{quote} -\begin{verbatim} -\usepackage{amsmath} -... -\begin{equation} - a=b - \label{eq1} -\end{equation} -... -Remember that -\begin{equation} - a=b - \tag{\ref{eq1}} -\end{equation} -\end{verbatim} -\end{quote} -Here, the second instance of \ensuremath{a=b} will be -typeset with a copy, made by the \csx{tag} command, of the label of the -first instance. - -Comprehensive documentation of \AMSLaTeX{} is to be found in -\File{amsldoc}, in the distribution; it is also available on the web -at \URL{ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf} -\begin{ctanrefs} -\item[amsldoc.tex]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} -\item[amsmath.sty]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} -\end{ctanrefs} - -\Question[Q-brkinline]{Line-breaking in in-line maths} - -\TeX{}, by default, allows you to split a mathematical expression at -the end of the line; it allows breaks at relational operators (like -``='', ``\textless'', etc.) and at binary operators (like ``+'', -``-'', etc.). In the case of large expressions, this can sometimes be -a life-saver. - -However, in the case of simple expressions like \ensuremath{a=b+c}, a -break can be really disturbing to the reader, and one would like to -avoid it. - -Fortunately, these breaks are controllable: there are ``penalties'' -associated with each type of operator: the penalty - says how -undesirable a break at each point is. Default values are: -\begin{quote} -\begin{verbatim} -\relpenalty = 500 -\binoppenalty = 700 -\end{verbatim} -\end{quote} -You make the break progressively less attractive by increasing these -values. You can actually forbid all breaks, everywhere, by: -\begin{quote} -\begin{verbatim} -\relpenalty = 10000 -\binoppenalty = 10000 -\end{verbatim} -\end{quote} -If you want just to prevent breaks in a single expression, write: -\begin{quote} -\begin{verbatim} -{% - \relpenalty = 10000 - \binoppenalty = 10000 - $a=b+c$ -} -\end{verbatim} -\end{quote} -and the original values will remain undisturbed outside the braces. -This is tedious: there is often value in an alternative approach, -in which you say which parts of the expression may not break whatever -happens, and fortunately this is surprisingly easy. Suppose we want -to defer a break until after the equality, we could write: -\begin{quote} -\begin{verbatim} -${a+b+c+d} = z+y+x+w$ -\end{verbatim} -\end{quote} -The braces say ``treat this subformula as one atom'' and (in \TeX{} at -least) atoms don't get split: not a \csx{binoppenalty} change in sight. - -\Question[Q-mathonlyref]{Numbers for referenced equations only} - -There are those who consider that papers look untidy with numbers on -every equation; there is also a school of thought that claims that -there should be numbers everywhere, in case some reader wants to make -reference an equation to which the author made no cross-reference. - -If you hold to the ``only cross-referenced'' school of thought, you -can (using the \csx{nonumber} command on the relevant equations, or by -using the \AMSLaTeX{} unnumbered environments such as -\environment{equation*}) mark those of your equations to which you -make no reference. In a long or complex paper, this procedure could -well become deeply tedious. - -Fortunately, help is at hand: the \Package{mh} bundle's -\Package{mathtools} package offers a `\pkgoption{showonlyrefs}' -switch through its \csx{mathtoolsset} command; when that's in -operation, only those equations to which you make reference will be -numbered in the final output. See the package's documentation for -details of how to make references when the switch is in effect. -\begin{ctanrefs} -\item[mathtools.sty]Distributed as part of \CTANref{mh} -\end{ctanrefs} - -\subsection{Lists} - -\Question[Q-enumerate]{Fancy enumeration lists} - -The \Package{enumerate} package allows you to control the display of -the enumeration counter. The package adds an optional parameter to -the \environment{enumerate} environment, which is used to specify the -layout of the labels. The layout parameter contains an enumeration -type (`\texttt{1}' for arabic numerals, `\texttt{a}' or `\texttt{A}' -for alphabetic enumeration, and `\texttt{i}' or `\texttt{I}' for Roman -numerals), and things to act as decoration of the enumeration. So, -for example -\begin{quote} -\begin{verbatim} -\usepackage{enumerate} -... -\begin{enumerate}[(a)] -\item ... ... -\end{enumerate} -\end{verbatim} -\end{quote} -starts a list whose labels run (a), (b), (c), \dots{}; while -\begin{quote} -\begin{verbatim} -\usepackage{enumerate} -... -\begin{enumerate}[I/] -\item ... ... -\end{enumerate} -\end{verbatim} -\end{quote} -starts a list whose labels run I/, II/, III/, \dots{} - -The \Package{paralist} package, whose primary purpose is % beware line break -\Qref*{compaction of lists}{Q-complist}, provides the same facilities -for its \environment{enumerate}-like environments. - -If you need non-stereotyped designs, the \Package{enumitem} package -gives you most of the flexibility you might want to design your own. -The silly roman example above could be achieved by: -\begin{quote} -\begin{verbatim} -\usepackage{enumitem} -... -\begin{enumerate}[label=\Roman{*}/] -\item ... ... -\end{enumerate} -\end{verbatim} -\end{quote} -Note that the `\texttt{*}' in the key value stands for the list -counter at this level. You can also manipulate the format of -references to list item labels: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\usepackage{enumitem} -... -\begin{enumerate}[label=\Roman{*}/, - ref=(\roman{*})] -\item ... ... -\end{enumerate} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\usepackage{enumitem} -... -\begin{enumerate}[label=\Roman{*}/, ref=(\roman{*})] -\item ... ... -\end{enumerate} -\end{verbatim} -\end{wideversion} -\end{quote} -to make references to the list items format appear as (i), (ii), -(iii), etc. - -The \Class{memoir} class includes functions that match those in the -\Package{enumerate} package, and has similar functionality for -\environment{itemize} lists. -%% It is possible (if not particularly convenient) to do the same thing -%% yourself. Suppose you want your top-level \environment{enumerate}s to -%% be labelled I/, II/, III/, \dots{}, then give these commands: -%% \begin{verbatim} -%% \renewcommand{\theenumi}{\Roman{enumi}} -%% \renewcommand{\labelenumi}{\theenumi/} -%% \end{verbatim} -%% The possible styles of numbering are given in Section~6.3 of Lamport's -%% book (see \Qref[question]{\TeX{}-related books}{Q-books}). Both -%% \csx{theenumi} and \csx{labelenumi} must be changed, since -%% \csx{theenumi} is used in cross-references to the list. -%% -%% For lower level \environment{enumerate}s, replace |enumi| by |enumii|, -%% |enumiii| or |enumiv|, according to the level. If your label is much -%% larger than the default, you should also change \csx{leftmargini}, -%% \csx{leftmarginii}, \emph{etc}. -\begin{ctanrefs} -\item[enumerate.sty]Distributed as part of \CTANref{2etools} -\item[enumitem.sty]\CTANref{enumitem} -\item[memoir.cls]\CTANref{memoir} -\item[paralist.sty]\CTANref{paralist} -\end{ctanrefs} - -\Question[Q-complist]{How to adjust list spacing} - -\Qref*{Lamport's book}{Q-books} lists various -parameters for the layout of list (things like \csx{topsep}, -\csx{itemsep} and \csx{parsep}), but fails to mention that they're set -automatically within the list itself. This happens because each list -executes a command \csx{@list}\texttt{\meta{depth}} (the depth -appearing as a lower-case roman numeral); what's more, the top-level -\csx{@listi} is usually reset when the font size is changed. As a -result, it's rather tricky for -the user to control list spacing. Of course, the real answer is to use -a document class designed with more modest list spacing, but we all -know such things are hard to come by. The \Class{memoir} class wasn't -designed for more compact lists \emph{per se}, but offers the user -control over the list spacing. - -There are packages that provide some control of list spacing, but they -seldom address the separation from surrounding text (defined by -\csx{topsep}). The \Package{expdlist} package, among its many controls -of the appearance of \environment{description} lists, offers a -compaction parameter (see the documentation); the \Package{mdwlist} -package offers a \csx{makecompactlist} command for users' own list -definitions, and uses it to define compact lists -\environment{itemize*}, \environment{enumerate*} and -\environment{description*}. In fact, you can write lists such as -these commands define pretty straightforwardly~--- for example: -\begin{quote} -\begin{verbatim} -\newenvironment{itemize*}% - {\begin{itemize}% - \setlength{\itemsep}{0pt}% - \setlength{\parskip}{0pt}}% - {\end{itemize}} -\end{verbatim} -\end{quote} -The \Package{paralist} package provides several approaches to list -compaction: -\begin{itemize} -\item its \environment{asparaenum} environment formats each item as if - it were a paragraph introduced by the enumeration label (which saves - space if the item texts are long); -\item its \environment{compactenum} environment is the same sort of - compact list as is provided in \Package{expdlist} and - \Package{mdwlist}; and -\item its \environment{inparaenum} environment produces a list ``in - the paragraph'', i.e., with no line break between items, which is a - great space-saver if the list item texts are short. -\end{itemize} -The package will manipulate its \environment{enumerate} environment -labels just like the \Qref*{\Package{enumerate} package}{Q-enumerate} -does. - -\Package{Paralist} also provides \environment{itemize} equivalents -(\environment{asparaitem}, etc.), and \environment{description} -equivalents (\environment{asparadesc}, etc.). - -The \Package{multenum} package offers a more regular form of -\Package{paralist}'s \environment{inparaenum}; you define a notional -grid on which list entries are to appear, and list items will always -appear at positions on that grid. The effect is somewhat like that of -the `tab' keys on traditional typewriters; the package was designed -for example sheets, or lists of answers in the appendices of a book. - -The ultimate in compaction (of every sort) is offered by the -\Package{savetrees} package; compaction of lists is included. The -package's prime purpose is to save space at every touch and turn: -don't use it if you're under any design constraint whatever! - -The \Package{expdlist}, \Package{mdwlist} and \Package{paralist} -packages all offer other facilities for list configuration: you should -probably not try the ``do-it-yourself'' approaches outlined below if -you need one of the packages for some other list configuration -purpose. - -For ultimate flexibility (including manipulation of \csx{topsep}), the -\Package{enumitem} package permits adjustment of list parameters using -a ``\emph{key}\latexhtml{\ensuremath{=}}{=}\meta{value}'' format. -For example, one might write -\begin{quote} -\begin{verbatim} -\usepackage{enumitem} -... -\begin{enumerate}[topsep=0pt, partopsep=0pt] -\item ... -\item ... -\end{enumerate} -\end{verbatim} -\end{quote} -to suppress all spacing above and below your list, or -\begin{quote} -\begin{verbatim} -\usepackage{enumitem} -... -\begin{enumerate}[itemsep=2pt,parsep=2pt] -\item ... -\item ... -\end{enumerate} -\end{verbatim} -\end{quote} -to set spacing between items and between paragraphs within items. -\Package{Enumitem} also permits manipulation of the label format in a -more ``basic'' (and therefore more flexible) manner than the % ! line break -\Qref*{\Package{enumerate} package}{Q-enumerate} does. -\begin{ctanrefs} -\item[enumerate.sty]Distributed as part of \CTANref{2etools} -\item[enumitem.sty]\CTANref{enumitem} -\item[expdlist.sty]\CTANref{expdlist} -\item[memoir.cls]\CTANref{memoir} -\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} -\item[multenum.sty]\CTANref{multenum} -\item[paralist.sty]\CTANref{paralist} -\item[savetrees.sty]\CTANref{savetrees} -\end{ctanrefs} - -\Question[Q-interruptlist]{Interrupting enumerated lists} - -It's often convenient to have commentary text, `outside' the list, -between successive entries of a list. In the case of -\environment{itemize} lists this is no problem, since there's never -anything to distinguish successive items, while in the case of -\environment{description} lists, the item labels are under the user's -control so there's no automatic issue of continuity. - -For \environment{enumerate} lists, the labels are generated -automatically, and are context-sensitive, so the context (in this -case, the state of the enumeration counter) needs to be preserved. - -The belt-and-braces approach is to remember the state of the -enumeration in your own counter variable, and then restore it when -restarting enumerate: -\begin{quote} -\begin{verbatim} -\newcounter{saveenum} - ... -\begin{enumerate} - ... - \setcounter{saveenum}{\value{enumi}} -\end{enumerate} -<Commentary text> -\begin{enumerate} - \setcounter{enumi}{\value{saveenum}} - ... -\end{enumerate} -\end{verbatim} -\end{quote} - -This is reasonable, in small doses\dots{} Problems (apart from sheer -verbosity) are getting the level right (``should I use counter -\texttt{enumi}, \texttt{enumii}, \dots{}'') and remembering not to -nest the interruptions (i.e., not to have a separate list, that is -itself interrupted) in the ``commentary text''). - -The \Package{mdwlist} package defines commands \csx{suspend} and -\csx{resume} that simplify the process: -\begin{quote} -\begin{verbatim} -\begin{enumerate} - ... -\suspend{enumerate} -<Commentary text> -\resume{enumerate} - ... -\end{enumerate} -\end{verbatim} -\end{quote} -The package allows an optional name (as in -\cmdinvoke{suspend}[id]{enumerate}) to allow you to identify a -particular suspension, and hence provide a handle for manipulating -nested suspensions. - -If you're suspending a \Qref*{fancy-enumeration list}{Q-enumerate}, -you need to -re-supply the optional ``item label layout'' parameters required by -the \Package{enumerate} package when resuming the list, whether by the -belt-and-braces approach, or by the \Package{mdwlist} -\cmdinvoke{resume}{enumerate} technique. The task is a little tedious -in the \Package{mdwlist} case, since the optional argument has to be -encapsulated, whole, inside an optional argument to \csx{resume}, -which requires use of extra braces: -\begin{quote} -\begin{verbatim} -\begin{enumerate}[\textbf{Item} i] - ... -\suspend{enumerate} -<comment> -\resume{enumerate}[{[\textbf{Item} i]}] -... -\end{enumerate} -\end{verbatim} -\end{quote} -\nothtml{\noindent}The \Package{enumitem} package, in its most recent -release, will also allow you to resume lists: -\begin{quote} -\begin{verbatim} -\begin{enumerate} -... -\end{enumerate} -<comment> -\begin{enumerate}[resume] -... -\end{enumerate} -\end{verbatim} -\end{quote} -which feels just as ``natural'' as the \Package{mdwtools} facility, -and has the advantage of playing well with the other excellent -facilities of \Package{enumitem}. - -\Package{Expdlist} has a neat way of providing for comments, with its -\csx{listpart} command. The command's argument becomes a comment -between items of the list: -\begin{quote} -\begin{verbatim} -\begin{enumerate} -\item item 1 -\item item 2 - \listpart{interpolated comment} -\item item 3 -\end{enumerate} -\end{verbatim} -\end{quote} -This, you will realise, means it doesn't even have to think about -suspending or resuming the list, and of course it works equally well -in any of the list environments (thought it's not actually -\emph{necessary} for any but \environment{enumerate}). - -\Package{Enumitem} also allows multi-level suspension and resumption -of lists: -\begin{quote} -\begin{verbatim} -\begin{enumerate} -\item outer item 1 -\end{enumerate} -<comment> -\begin{enumerate}[resume] -\item outer item 2 -% nested enumerate -\begin{enumerate} -\item inner item 1 -\end{enumerate} -<nested comment> -% resume nested enumerate -\begin{enumerate}[resume] -\item inner item 2 -\end{enumerate} -\item outer item 3 -% end outer enumerate -\end{enumerate} -\end{verbatim} -\end{quote} -However, the `nested comment' interpolated in the nested enumeration -appears as if it were a second paragraph to ``outer item 2'', which is -hardly satisfactory. -\begin{ctanrefs} -\item[enumerate.sty]Distributed as part of \CTANref{2etools} -\item[enumitem.sty]\CTANref{enumitem} -\item[expdlist.sty]\CTANref{expdlist} -\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} -\end{ctanrefs} - -\subsection{Tables, figures and diagrams} - -\Question[Q-destable]{The design of tables} - -In recent years, several authors have argued that the examples, set -out by Lamport in his \Qref*{\LaTeX{} manual}{Q-books}, have cramped -authors' style and have led to extremely poor table design. It is in -fact difficult even to work out what many of the examples in Lamport's -book ``mean''. - -The criticism focuses on the excessive use of rules (both horizontal -and vertical) and on the poor vertical spacing that Lamport's macros -offer. - -The problem of vertical spacing is plain for all to see, and is -addressed in several packages~--- see % beware line breaks -``\Qref*[question]{spacing of lines in tables}{Q-struttab}''. - -The argument about rules is presented in the excellent essay that -prefaces the documentation of Simon Fear's \Package{booktabs} package, -which (of course) implements Fear's scheme for `comfortable' rules. -(The same rule commands are implemented in the \Class{memoir} class.) - -Lamport's \LaTeX{} was also inflexibly wrong in ``insisting'' that -captions should come at the bottom of a table. Since a table may -extend over several pages, traditional typography places the caption -at the top of a table float. The \csx{caption} command will get its -position wrong (by \texttt{10pt}) if you simply write: -\begin{quote} -\begin{verbatim} -\begin{table} - \caption{Example table} - \begin{tabular}{...} - ... - \end{tabular} -\end{table} -\end{verbatim} -\end{quote} -The \Package{topcapt} package solves this problem: -\begin{quote} -\begin{verbatim} -\usepackage{topcapt} -... -\begin{table} - \topcaption{Example table} - \begin{tabular}{...} - ... - \end{tabular} -\end{table} -\end{verbatim} -\end{quote} -The \Class{KOMA-script} classes provide a similar command -\csx{captionabove}; they also have a class option -\pkgoption{tablecaptionabove} which arranges that \csx{caption} -\emph{means} \csx{captionabove}, in table environments. The -\Package{caption} (from the release of 23 January, 2004) may be loaded -with an option that has the same effect: -\begin{quote} -\begin{verbatim} -\usepackage[tableposition=top]{caption} -\end{verbatim} -\end{quote} - -Doing the job yourself is pretty easy: \Package{topcapt} switches the -values of the \LaTeXe{} parameters \csx{abovecaptionskip} (default -value \texttt{10pt}) and \csx{belowcaptionskip} (default value -\texttt{0pt}), so: -\begin{quote} -\begin{verbatim} -\begin{table} - \setlength{\abovecaptionskip}{0pt} - \setlength{\belowcaptionskip}{10pt} - \caption{Example table} - \begin{tabular}{...} - ... - \end{tabular} -\end{table} -\end{verbatim} -\end{quote} -does the job. (The package itself is very slightly more elaborate\dots{}) -\begin{ctanrefs} -\item[booktabs.sty]\CTANref{booktabs} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\item[topcapt.sty]\CTANref{topcapt} -\end{ctanrefs} - -\Question[Q-fixwidtab]{Fixed-width tables} - -There are two basic techniques for making fixed-width tables in -\LaTeX{}: you can make the gaps between the columns stretch, or you -can stretch particular cells in the table. - -Basic \LaTeX{} can make the gaps stretch: the \environment{tabular*} -environment takes an extra argument (before the \texttt{clpr} layout one) -which takes a length specification: you can say things like ``\texttt{15cm}'' -or ``\csx{columnwidth}'' here. You must also have an \csx{extracolsep} -command in the \texttt{clpr} layout argument, inside an \texttt{@\{\}} -directive. So, for example, one might have -\begin{wideversion} -\begin{verbatim} -\begin{tabular*}{\columnwidth}{@{\extracolsep{\fill}}lllr} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\begin{tabular*}{\columnwidth}% - {@{\extracolsep{\fill}}lllr} -\end{verbatim} -\end{narrowversion} -The \csx{extracolsep} applies to all inter-column gaps to its right as -well; if you don't want all gaps stretched, add -\cmdinvoke{extracolsep}{0pt} to cancel the original. - -The \Package{tabularx} package defines an extra \texttt{clpr} column -specification, \texttt{X}; \texttt{X} columns behave as \texttt{p} -columns which expand to fill the space available. If there's more -than one \texttt{X} column in a table, the spare space is distributed -between them. - -The \Package{tabulary} package (by the same author) provides a way of -``balancing'' the space taken by the columns of a table. The package -defines column specifications \texttt{C}, \texttt{L}, \texttt{R} and -\texttt{J}, giving, respectively, centred, left, right and -fully-justified versions of space-sharing columns. The package -examines how long each column would be ``naturally'' (i.e., on a piece of paper of unlimited width), and -allocates space to each column accordingly. There are ``sanity -checks'' so that really large entries don't cause everything else to -collapse into nothingness (there's a ``maximum width'' that any column -can exert), and so that tiny entries can't get smaller than a -specified minimum. Of course, all this work means that the package -has to typeset each row several times, so things that leave -``side-effects'' (for example, a counter used to produce a row-number -somewhere) are inevitably unreliable, and should not even be tried. - -The \Package{ltxtable} package combines the features of the -\Package{longtable} and \Package{tabularx} packages. It's important -to read the documentation, since usage is distinctly odd; the -distribution contains no more than a file \File{ltxtable.tex}, which you -should process using \LaTeX{}. Processing will give you a \File{.sty} -file as well as the \File{.dvi} or \File{.pdf} output containing the -documentation. -\begin{ctanrefs} -\item[ltxtable.sty]Distributed as part of \CTANref{carlisle} -\item[tabularx.sty]Distributed as part of \CTANref{2etools} -\item[tabulary.sty]\CTANref{tabulary} -\end{ctanrefs} - -\Question[Q-varwidcol]{Variable-width columns in tables} - -This is a slightly different take on the problem addressed in -``\Qref*[question]{fixed-width tables}{Q-fixwidtab}''~--- here we have -a column whose size we can't absolutely predict when we design the -document. - -While the basic techniques (the \Package{tabularx}, \Package{tabulary} -and \Package{ltxtable} packages) are the same for this problem as for the -fixed-width \emph{table} problem, there's one extra tool that we can -call to our aid, which may be preferable in some situations. - -Suppose we have data in one column which we read from an external -source, and the source itself isn't entirely predictable. The data in -the column may end up pretty narrow in every row of the table, or it -may be wide enough that the table would run over the edge of the page; -however, we don't want to make the column as wide as possible ``just -in case'', by defining a fixed size for the table. We would like the -column to be as small as possible, but have the possibility to spread -to a maximum width and (if even that width is exceeded) turn into a -\texttt{p}-style column. - -The \Package{varwidth} package, discussed in % ! line break -``\Qref*[question]{automatic sizing of minipages}{Q-varwidth}'', provides -a solution. If you load it together with the \LaTeX{} ``required'' -\Package{array} package, i.e.: -\begin{quote} -\begin{verbatim} -\usepackage{array} -\usepackage{varwidth} -\end{verbatim} -\end{quote} -\Package{varwidth} defines a new column-type ``\texttt{V}'', which you -can use as follows: -\begin{quote} -\begin{verbatim} -\begin{tabular}{l V{3.5cm} r} - foo & blah & bar \\ - foo & blah blah & bar \\ -\end{tabular} -\end{verbatim} -\end{quote} -when the second column ends up less than 3.5cm wide; -or you can use it as follows: -\begin{quote} -\begin{verbatim} -\begin{tabular}{l V{3.5cm} r} - foo & blah & bar \\ - foo & blah blah & bar \\ - foo & blah blah blah blah blah blah - & bar \\ -\end{tabular} -\end{verbatim} -\end{quote} -where the second column will end up noticeably wider, and will wrap to -a second line in the third row. -\begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} -\item[varwidth.sty]\CTANref{varwidth} -\end{ctanrefs} - -\Question[Q-struttab]{Spacing lines in tables} - -\AllTeX{} mechanisms for maintaining the space between lines (the -``\emph{leading}'') rely on \TeX{}'s paragraph builder, which compares -the shape of consecutive lines and adjusts the space between them. - -These mechanisms can't work in exactly the same way when \AllTeX{} is -building a table, because the paragraph builder doesn't get to see the -lines themselves. As a result, tables sometimes typeset with lines -uncomfortably close together (or occasionally ridiculously far apart). - -Traditional (moving metal type) typographers would adjust the spacing -between lines of a table by use of a ``\emph{strut}'' (a metal -spacer). A \TeX{} user can do exactly the same thing: most macro -packages define a \csx{strut} command, that defines a space appropriate -to the current size of the text; placing a \csx{strut} command at the -end of a troublesome row is the simplest solution to the problem~--- -if it works. Other solutions below are \LaTeX{}-specific, but some -may be simply translated to \plaintex{} commands. - -If your table exhibits a systematic problem (i.e., every row is wrong -by the same amount) use \csx{extrarowheight}, which is defined by the -\Package{array} package: -\begin{quote} -\begin{verbatim} -\usepackage{array}% in the preamble -... -\setlength{\extrarowheight}{length} -\begin{tabular}{....} -\end{verbatim} -\end{quote} - -To correct a single row whose maladjustment isn't corrected by a -\csx{strut} command, you can define your own, using -\cmdinvoke{rule}{0pt}{length}~--- which is a near approximation to the -command that goes inside a \csx{strut}. The \Package{bigstrut} package -defines a strut command that you can use for this purpose: -\csx{bigstrut} on its own opens up both above and below the current -line; \cmdinvoke{bigstrut}[t] opens up above the line, -\cmdinvoke{bigstrut}[b] opens up below the line. - -General solutions are available, however. The \Package{tabls} package -automatically generates an appropriately-sized strut at the end of -each row. Its disadvantages are that it's really rather slow in -operation (since it gets in the way of everything within tables) and -its (lack of) compatibility with other packages. - -The \Package{cellspace} package does a (possibly inferior) job by -defining a new table/array column type ``S'', which you apply to each -column specification. So, for example, -\begin{quote} -\begin{verbatim} -\cmdinvoke{begin}{tabular}{l l l p{3cm}} -\end{verbatim} -\end{quote} -would become -\begin{quote} -\begin{verbatim} -\cmdinvoke{begin}{tabular}{Sl Sl Sl Sp{3cm}} -\end{verbatim} -\end{quote} -and so on. This technique shows -promise of not interfering so much with other packages, but this -author has heard of no reports from the field. - -The \Package{booktabs} package comes with a thought-provoking essay -about how tables should be designed. Since table row-spacing problems -most often appear in collisions with rules, the author's thesis, -that \LaTeX{} users tend too often to rule their tables, is -interesting. The package provides rule commands to support the -author's scheme, but deals with inter-row spacing too. The most -recent release of \Package{booktabs} sports compatibility with -packages such as \Package{longtable}. - -Documentation of both \Package{bigstrut} and \Package{tabls} may be -found as comments in the package files themselves. -\begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} -\item[bigstrut.sty]Distributed as part of \CTANref{multirow} -\item[booktabs.sty]\CTANref{booktabs} -\item[cellspace.sty]\CTANref{cellspace} -\item[tabls.sty]\CTANref{tabls} -\end{ctanrefs} - -\Question[Q-longtab]{Tables longer than a single page} - -Tables are, by default, set entirely in boxes of their own: as a -result, they won't split over a page boundary. Sadly, the world keeps -turning up tables longer than a single page that we need to typeset. - -For simple tables (whose shape is highly regular), the simplest -solution may well be to use the \environment{tabbing} environment, -which is slightly tedious to set up, but which doesn't force the whole alignment -onto a single page. - -The \Package{longtable} package builds the whole table (in chunks), in -a first pass, and then uses information it has written to the \extension{aux} -file during later passes to get the setting ``right'' (the package -ordinarily manages to set tables in just two passes). Since the -package has overview of the whole table at the time it's doing -``final'' setting, the table is set ``uniformly'' over its entire -length, with columns matching on consecutive pages. -\Package{longtable} has a reputation for failing to interwork with -other packages, but it does work with \Package{colortbl}, and its -author has provided the \Package{ltxtable} package to provide (most -of) the facilities of \Package{tabularx} (see -% beware line wrap -\Qref[question]{fixed-width tables}{Q-fixwidtab}) for long tables: -beware of its rather curious usage constraints~--- each long table -should be in a file of its own, and included by -\cmdinvoke*{LTXtable}{width}{file}. Since \Package{longtable}'s -multiple-page tables can't possibly live inside floats, the package -provides for captions within the \environment{longtable} environment -itself. - -A seeming alternative to \Package{ltxtable} is \Package{ltablex}; but -it is outdated and not fully functional. Its worst problem is its -strictly limited memory capacity (\Package{longtable} is not so -limited, at the cost of much complication in its code); -\Package{ltablex} can only deal with relatively small tables, it doesn't seem -likely that support is available; but its user interface is much -simpler than \Package{ltxtable}, so if its restrictions aren't a -problem for you, it may be worth a try. - -The \Package{supertabular} package starts and stops a -\environment{tabular} environment for each page of the table. As a -result, each `page worth' of the table is compiled independently, and -the widths of corresponding columns may differ on successive pages. -However, if the correspondence doesn't matter, or if your columns are -fixed-width, \Package{supertabular} has the great advantage of doing -its job in a single run. - -Both \Package{longtable} and \Package{supertabular} allow definition -of head- and footlines for the table; \Package{longtable} allows -distinction of the first and last head and foot. - -The \Package{xtab} package fixes some infelicities of -\Package{supertabular}, and also provides a ``last head'' facility -(though this, of course, destroys \Package{supertabular}'s advantage -of operating in a single run). - -The \Package{stabular} package provides a simple-to-use ``extension to -\environment{tabular}'' that allows it to typeset tables that run over -the end of a page; it also has usability extensions, but doesn't have -the head- and footline capabilities of the major packages. - -Documentation of \Package{ltablex} is to be found in the package file. -\begin{ctanrefs} -\item[longtable.sty]Distributed as part of \CTANref{2etools} -\item[ltablex.sty]\CTANref{ltablex} -\item[ltxtable.sty]Generate by running \CTANref{ltxtable} -\item[stabular.sty]Distributed as part of \CTANref{sttools} -\item[supertabular.sty]\CTANref{supertabular} -\item[xtab.sty]\CTANref{xtab} -\end{ctanrefs} - -\Question[Q-tabcellalign]{How to alter the alignment of tabular cells} - -One often needs to alter the alignment of a tabular \texttt{p} (`paragraph') -cell, but problems at the end of a table row are common. With a -\texttt{p} cell that looks like: -\begin{quote} -\begin{verbatim} -... & \centering blah ... \\ -\end{verbatim} -\end{quote} -one is liable to encounter errors that complain about a ``misplaced -\csx{noalign}'' or ``\Qref*{extra alignment tab}{Q-altabcr}'', or the like. -The problem is that the command \texttt{\bsbs } means different things in -different circumstances: the \environment{tabular} environment -switches the meaning to a value for use in the table, and -\csx{centering}, \csx{raggedright} and \csx{raggedleft} all change the -meaning to something incompatible. Note that the problem only -arises in the last cell of a row: since each cell is set into a box, -its settings are lost at the \texttt{\&} (or \texttt{\bsbs }) that -terminates it. - - -The technique using \csx{PBS} was developed in the days of \LaTeXo{} -because the actual value of \texttt{\bsbs } that the \environment{tabular} -environment uses was only available as an internal command. Nowadays, -the value is a public command, and you can in principle use it -explicitly: -\begin{quote} -\begin{verbatim} -... & \centering blah ... \tabularnewline -\end{verbatim} -\end{quote} - -The \Package{array} package provides a command \csx{arraybackslash} -which restores \texttt{\bsbs } to its correct (within table) meaning; -the command may be used in \Package{array}'s ``field format'' preamble -specifications: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\begin{tabular}{...% - >{\centering\arraybackslash}% - p{50mm}} -... -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\begin{tabular}{... >{\centering\arraybackslash}p{50mm}} -... -\end{verbatim} -\end{wideversion} -\end{quote} - -The \csx{tabularnewline} and \csx{arraybackslash} commands are -(somewhat) modern additions to \LaTeX{} and the \Package{array} -package, respectively. If neither is available, the user may try the -(old) solution which preserves the meaning of \texttt{\bsbs }: -\begin{quote} -\begin{verbatim} -\newcommand\PBS[1]{\let\temp=\\% - #1% - \let\\=\temp -} -\end{verbatim} -\end{quote} -which one uses within a table as: -\begin{quote} -\begin{verbatim} -... & \PBS\centering blah ... \\ -\end{verbatim} -\end{quote} -or in the preamble as: -\begin{quote} -\begin{verbatim} -\begin{tabular}{...>{\PBS\centering}p{5cm}} -\end{verbatim} -\end{quote} -\begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} -\nothtml{\vskip 0pt plus 4ex} - -\Question[Q-rulethk]{The thickness of rules in \LaTeX{} tables} - -The rules in a \LaTeX{} table are by default \texttt{0.4pt} thick; -this is in fact a default built in at the lowest level, and applies to -all rules (including those separating blocks of running text). - -Sometimes, however, we look at a table and find we want the rules to -stand out~--- perhaps to separate the text from the rest of the body -text, or to make the sections of the table stand out from one another. -However, a quick review of any \LaTeX{} manual will reveal no -technique for making any one rule stand out, and a little -experimentation shows that it is indeed pretty difficult to prevent -a change ``bleeding'' out to affect other rules in the same table. - -If you look at what we have to say on the % ! line break -\Qref*{design of tables}{Q-destable}, elsewhere -among these \acro{FAQ}s, and you may sense that the design of \LaTeX{} -simply skipped the issues surrounding table design: \emph{that's} -presumably why there's no facilities to help you. - -Specifically, the length \csx{arrayrulewidth} affects the thickness of -the rules (both horizontal and vertical) within both -\environment{tabular} and \environment{array} environments. If you -change from the default (see above) only as far as -\begin{quote} -\begin{verbatim} -\setlength{\arrayrulewidth}{1pt} -\end{verbatim} -\end{quote} -the change is remarkably striking. However, really quite subtle user -level programming proves incapable of changing just \emph{one} rule: -it's necessary to delve into the (rather tricky) code of \csx{hline} -and \csx{cline} themselves. - -Fortunately, this job has already been done for the community: the -\Package{booktabs} package defines three different classes of rule -(\csx{toprule}, \csx{midrule} and \csx{bottomrule}), and the package -documentation offers hints on how to use them. You are -\emph{strongly} advised to read the documentation pretty carefully. - -The \Class{memoir} class includes the \Package{booktabs} package, and -repeats the documentation in its compendious manual. - -Note that none of the above mentions the issue of the weight of -vertical rules (except in passing). For the reasons, see the -documentation of the \Package{booktabs} package (again); vertical -rules in tables are in any case even more trickily coded than are -horizontal rules, and if their lack of configurability makes them -still less attractive, so much the better for the design of your -document. -\begin{ctanrefs} -\item[booktabs.sty]\CTANref{booktabs} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-textflow]{Flowing text around figures in \LaTeX{}} - -There are several \LaTeX{} packages that purport to do this, but they -all have their limitations because the \TeX{} machine isn't really -designed to solve this sort of problem. Piet van Oostrum has -conducted a survey of the available packages; he recommends: -\begin{description} -\item[\texttt{floatflt}] \Package{floatflt} is an improved version - (for \LaTeXe{}) of \File{floatfig.sty}, and its syntax is: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\begin{floatingfigure}[options]{width of figure} - figure contents -\end{floatingfigure} -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} - \begin{quote} - \cmdinvoke{begin}{floatingfigure}[\emph{options}]{\emph{figure width}}\\ - \mbox{}\qquad\emph{figure contents}\\ - \cmdinvoke{end}{floatingfigure} - \end{quote} -\end{narrowversion} -There is a (more or less similar) \environment{floatingtable} -environment. - -The tables or figures can be set left or right, or alternating on -even/odd pages in a double-sided document. - -The package works with the \texttt{multicol} package, but doesn't work well -in the neighbourhood of list environments (unless you change your -\LaTeX{} document). -\item[\texttt{wrapfig}] \Package{wrapfig} has syntax: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\begin{wrapfigure}[height of figure in lines]{l,r,...}[overhang]{width} - figure, caption, etc. -\end{wrapfigure} -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} - \begin{quote} - \cmdinvoke{begin}{wrapfigure}\texttt{\%}\\ - \mbox{}% - \qquad\qquad\texttt{[\emph{figure height in lines}]\%}\\ - \mbox{}% - \qquad\qquad\texttt{\{l,r,\emph{etc}\}[\emph{overhang}]\{\emph{width}\}}\\ - \mbox{}\qquad\emph{figure, caption, etc.}\\ - \cmdinvoke{end}{wrapfigure} - \end{quote} -\end{narrowversion} - The syntax of the \environment{wraptable} environment is similar. - - Height can be omitted, in which case it will be calculated by the - package; the package will use the greater of the specified and the - actual width. The \texttt{\{l,r,\emph{etc}.\}} parameter may - also be specified as \texttt{i}\emph{(nside)} or - \texttt{o}\emph{(utside)} for two-sided documents, and uppercase - may be used to indicate that the picture should float. The - overhang allows the figure to be - moved into the margin. The figure or table will entered into the - list of figures or tables if you use the \csx{caption} command. - - The environments do not work within list environments that end - before the figure or table has finished, but can be used in a - parbox or minipage, and in twocolumn format. - \item[\texttt{picins}] \Package{Picins} is part of a large bundle - that allows inclusion of pictures (e.g., with shadow boxes, - various \MSDOS{} formats, etc.). The command for inserting a - picture at the start of a paragraph is: -\begin{wideversion} - \begin{quote} - \csx{parpic}\texttt{(width,height)(x-off,y-off)[Options][Position]\{Picture\}}\\ - \emph{Paragraph text} - \end{quote} -\end{wideversion} -\begin{narrowversion} - \begin{quote} - \cmdinvoke*{picins}(width,height)(x-off,y-off)\texttt{\%}\\ - \mbox{\qquad\qquad}\texttt{[\emph{options}][\emph{position}]\%}\\ - \mbox{\qquad\qquad}\texttt{\{\emph{Picture}\}}\\ - \emph{Paragraph text} - \end{quote} -\end{narrowversion} - All parameters except the \emph{Picture} are optional. The picture - can be positioned left or right, boxed with a rectangle, oval, - shadowbox, dashed box, and a caption can be given which will be - included in the list of figures. - - Unfortunately (for those of us whose understanding of German is not - good), the documentation is in German. Piet van Oostrum has written - a summary in English. -\end{description} -\begin{ctanrefs} -\item[floatflt.sty]\CTANref{floatflt} -\item[picins.sty]\CTANref{picins} -\item[picins \nothtml{\rmfamily}documentation summary]\CTANref{picins-summary} -\item[wrapfig.sty]\CTANref{wrapfig} -\end{ctanrefs} - -\Question[Q-slashbox]{Diagonal separation in corner cells of tables} -\keywords{tabular} - -You want to label both the top or bottom row and the left- or -rightmost column, somewhere at the corner of the table where the row -and column meet. A simple way to achieve the result is to construct -the table with an arrangement of rules (and possibly \csx{multicolumn} -entries), to look like: -\begin{quote} -\begin{verbatim} ------------------ -x y - -------------- - 1 2 3 4 5 ------------------ -1 -2 -3 -4 -5 ------------------ -\end{verbatim} -\end{quote} -However, this doesn't satisfy everyone: many want the labelling in a -single cell at the top left of the table. It sounds a simple enough -requirement, yet it calls for some slightly tricky \LaTeX{} coding. -The \Package{slashbox} package does the job for you: it defines -commands \csx{slashbox} and \csx{backslashbox}, each taking the two -labels as arguments. It draws a picture with the two labels on either -side of a slanting line; the command (and hence the picture) may be -placed in the corner cell, where the labelled row and column meet. - -The package isn't the world's neatest: it uses \LaTeX{} -\environment{picture} mode to draw its line, and picture mode has many -tedious restrictions (and doesn't, in all honesty, produce -particularly good pictures). Load slashbox with the \Package{pict2e} -package, and at least the picture quality will be improved. - -Documentation of \Package{slashbox} is less than satisfactory: a -\LaTeX{} source file of rather startling starkness accompanies the -package file in the distribution. It does, however, process to a -\acro{DVI} file that gives some idea of how the \csx{slashbox} may be -expected to look. (The third example in the file shows the effect of -\environment{picture} mode's restrictions: the dividing line doesn't -go from corner to corner in the box: to correct this requires revision -of \Package{slashbox}~--- \Package{pict2e} alone doesn't help in this -regard.) -\begin{ctanrefs} -\item[slashbox.sty]\CTANref{slashbox} -\end{ctanrefs} - -\Question[Q-wholerow]{How to change a whole row of a table} - -Each cell of a table is set in a box, so that a change of font style -(or whatever) only lasts to the end of the cell. If one has a -many-celled table, or a long one which needs lots of rows emphasising, -putting a font style change command in every cell will be impossibly -tedious. - -With the \Package{array} package, you can define column modifiers -which will change the font style for a whole \emph{column}. However, -with a bit of subtlety, one can make such modifiers affect rows rather -than columns. So, we set things up by: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\usepackage{array} -\newcolumntype{$}{>{% - \global\let\currentrowstyle\relax}% -} -\newcolumntype{^}{>{\currentrowstyle}} -\newcommand{\rowstyle}[1]{% - \gdef\currentrowstyle{#1}% - #1\ignorespaces -} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\usepackage{array} -\newcolumntype{$}{>{\global\let\currentrowstyle\relax}} -\newcolumntype{^}{>{\currentrowstyle}} -\newcommand{\rowstyle}[1]{\gdef\currentrowstyle{#1}% - #1\ignorespaces -} -\end{verbatim} -\end{wideversion} -\end{quote} -Now, we put `\texttt{\$}' before the first column specifier; and we -put `\texttt{\textasciicircum{}}' -before the modifiers of subsequent ones. We then use \csx{rowstyle} at -the start of each row we want to modify: -\begin{quote} -\begin{verbatim} -\begin{tabular}{|$l|^l|^l|} \hline - \rowstyle{\bfseries} - Heading & Big and & Bold \\ \hline - Meek & mild & entry \\ - Meek & mild & entry \\ - \rowstyle{\itshape} - Strange & and & italic \\ - Meek & mild & entry \\ \hline -\end{tabular} -\end{verbatim} -\end{quote} -The \Package{array} package works with several other -\environment{tabular}-like environments from other packages (for -example \environment{longtable}), but unfortunately this trick won't -always work. -\begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-multirow]{Merging cells in a column of a table} - -It's easy to come up with a table design that requires a cell that -spans several rows. An example is something where the left-most -column labels the rest of the table; this can be done (in simple -cases) by using % beware line break -\Qref*{diagonal separation in corner cells}{Q-slashbox}, but that -technique rather strictly limits what can be used as the content of -the cell. - -The \Package{multirow} package enables you to construct such multi-row -cells, in a very simple manner. For the simplest possible use, one -might write: -\begin{quote} -\begin{verbatim} -\begin{tabular}{|c|c|} -\hline -\multirow{4}{*}{Common g text} - & Column g2a\\ - & Column g2b \\ - & Column g2c \\ - & Column g2d \\ -\hline -\end{tabular} -\end{verbatim} -\end{quote} -and \Package{multirow} will position ``Common g text'' at the vertical -centre of the space defined by the other rows. Note that the rows -that don't contain the ``multi-row'' specification must have empty -cells where the multi-row is going to appear. - -The ``\texttt{*}'' may be replaced by a column width specification. In this -case, the argument may contain forced line-breaks: -\begin{quote} -\begin{verbatim} -\begin{tabular}{|c|c|} -\hline -\multirow{4}{25mm}{Common\\g text} - & Column g2a\\ - & Column g2b \\ - & Column g2c \\ - & Column g2d \\ -\hline -\end{tabular} -\end{verbatim} -\end{quote} -A similar effect (with the possibility of a little more -sophistication) may be achieved by putting a smaller table that lines -up the text into a \texttt{*}-declared \csx{multirow}. - -The \csx{multirow} command may also used to write labels vertically -down one or other side of a table (with the help of the -\Package{graphics} or \Package{graphicx} package, which provide the -\csx{rotatebox} command): -\begin{quote} -\begin{verbatim} -\begin{tabular}{|l|l|} -\hline -\multirow{4}{*}{\rotatebox{90}{hi there}} - & Column g2a\\ - & Column g2b \\ - & Column g2c \\ - & Column g2d \\ -\hline -\end{tabular} -\end{verbatim} -\end{quote} -(which gives text going upwards; use angle \texttt{-90} for text going -downwards, of course). - -To make a \csx{multicolumn} multi-row ``cell'' in a table, you have to -enclose a \csx{multirow} inside a \csx{multicolumn}~--- the other way -around does not work, so: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\begin{tabular}{|c|c|c|}\hline -\multicolumn{2}{|c|}{\multirow{2}{*}{combined cells}} - &top right\\ \cline{3-3} -\multicolumn{2}{|c|}{} - &middle right\\ \hline -bottom left - &bottom center - &bottom right\\ \hline -\end{tabular} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\begin{tabular}{|c|c|c|}\hline -\multicolumn{2}{|c|}{\multirow{2}{*}% - {combined cells}} - &top right\\ \cline{3-3} -\multicolumn{2}{|c|}{} - &middle right\\ \hline -bottom left - &bottom center - &bottom right\\ \hline -\end{tabular} -\end{verbatim} -\end{narrowversion} -\end{quote} -\Package{Multirow} is set up to interact with the \Package{bigstrut} -package (which is also discussed in the answer to % beware line break -\Qref[question]{spacing lines in tables}{Q-struttab}). You use an -optional argument to the \csx{multirow} command to say how many of the -rows in the multi-row have been opened up with \csx{bigstrut}. - -The documentation of both \Package{multirow} and \Package{bigstrut} is -to be found, as comments, in the package files themselves. -\begin{ctanrefs} -\item[bigstrut.sty]Distributed as part of \CTANref{multirow} -\item[multirow.sty]\CTANref{multirow} -\end{ctanrefs} - -\subsection{Floating tables, figures, etc.} - -\Question[Q-floatpages]{Floats on their own on float pages} - -It's sometimes necessary to force a float to live on a page by itself. -(It's sometimes even necessary for \emph{every} float to live on a -page by itself.) When the float fails to `set', and waits for the end -of a chapter or of the document, the natural thing to do is to declare -the float as -\begin{quote} - \cmdinvoke{begin}{figure}[p!] -\end{quote} -but the overriding \texttt{!} modifier has no effect on float page floats; so -you have to make the float satisfy the parameters. -\Qref[Question]{Moving tables and figures}{Q-floats} offers some -suggestions, but doesn't solve the one-float-per-page question. - -The `obvious' solution, using the counter \texttt{totalnumber} -(``total number of floats per page'') doesn't work: -\texttt{totalnumber} only applies to floats on `text' pages (pages -containing text as well as one or more float). So, to allow any -size float to take a whole page, set \csx{floatpagefraction} really -small, and to ensure that no more than one float occupies a page, make -the separation between floats really big: -\begin{quote} -\begin{verbatim} -\renewcommand\floatpagefraction{.001} -\makeatletter -\setlength\@fpsep{\textheight} -\makeatother -\end{verbatim} -\end{quote} - -\Question[Q-vertspacefloat]{Extra vertical space in floats} - -A common complaint is that extra vertical space has crept into -\environment{figure} or \environment{table} floating environments. -More common still are users who post code that introduces this extra -space, and \emph{haven't noticed the problem}! - -The trouble arises from the fact that the \environment{center} -environment (and its siblings \environment{flushleft} and -\environment{flushright}) are actually based on \LaTeX{}'s -list-handling code; and lists always separate themselves from the -material around them. Meanwhile, there are parameters provided to -adjust the spacing between floating environments and their -surroundings; so if we have: -\begin{quote} -\begin{verbatim} -\begin{figure} - \begin{center} - \includegraphics{...} - \caption{...} - \end{center} -\end{figure} -\end{verbatim} -\end{quote} -\nothtml{\noindent}or worse still: -\begin{quote} -\begin{verbatim} -\begin{figure} - \begin{center} - \includegraphics{...} - \end{center} - \caption{...} -\end{figure} -\end{verbatim} -\end{quote} -unwarranted vertical space is going to appear. - -The solution is to let the float and the objects in it position -themselves, and to use ``generic'' layout commands rather than their -list-based encapsulations. -\begin{quote} -\begin{verbatim} -\begin{figure} - \centering - \includegraphics{...} - \caption{...} -\end{figure} -\end{verbatim} -\end{quote} -(which even involves less typing). - -This alternative code will work with any \LaTeX{} package. It will -not work with obsolete (pre-\LaTeXe{}) packages such as -\Package{psfig} or \Package{epsf}~--- see % beware line break -\Qref[question]{graphics inclusion}{Q-impgraph} for discussion of the -genesis of \csx{includegraphics}. - -\Question[Q-wideflt]{Centring a very wide figure or table} - -The normal means of centring a figure or table object is to include -\csx{centering} at the top of the float. This doesn't help if the -object is wider than \csx{textwidth}~--- the object starts at the left -margin and juts out into the right margin (which is actually doubly -unsatisfactory, since as well as looking bad, the float won't be -placed until the next \csx{clearpage} or the like.) - -You can avoid the problem by rescaling the figure or table to fit, but -this is often not satisfactory, for several reasons. - -Otherwise, if the object is wider than the printable area of the page, -you've no choice other than to \Qref*{rotate it}{Q-landscape}. If, -however, the object is \emph{just} wider than the text block, you can -make it pretend to be the right size by: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\begin{figure} - \noindent - \makebox[\textwidth]{\includegraphics{my-wide-figure}}% - \caption{This figure juts out into both margins} -\end{figure} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\begin{figure} - \noindent - \makebox[\textwidth]{% - \includegraphics{my-wide-figure}% - }% - \caption{This figure juts out into both margins} -\end{figure} -\end{verbatim} -\end{narrowversion} -\end{quote} -Note the \csx{noindent}: the \csx{makebox} starts a paragraph, and you -really don't want that indented by \csx{parindent}. - -\Question[Q-2colfloat]{Placing two-column floats at bottom of page} - -You specified placement `\texttt{[htbp]}' for your full-width figure or -table, but they always get placed at the top of the page\dots{} Well, -it \emph{is} what the documentation says: \LaTeX{}, unadorned, only -allows full-width floats at the top of a page, or occupying (part of) a -float page. - -The \Package{stfloats} package ameliorates the situation somewhat, and -makes \LaTeX{} honour `[b]' placement as well; the -\Package{dblfloatfix} package combines a tidied version of the changes -made in \Package{stfloats} with the -\begin{narrowversion} % non-hyper - float ordering corrections defined in \Package{fixltx2e} - (\Qref{}{Q-2colfltorder}). -\end{narrowversion} -\begin{wideversion} % hyper - \Qref{float ordering corrections}{Q-2colfltorder} defined in - \Package{fixltx2e}. -\end{wideversion} - -A particular problem with \Package{stfloats} and \Package{dblfloatfix} -is that the float will appear, at its earliest, on the page after it -is specified. This has two undesirable side-effects: first, there may -be no bottom float on the first page of a document, and second, float -numbers may become ``entangled'' (particularly if you're using -\Package{dblfloatfix} that ensures that the early-specified bottom -float is set \emph{before} any single column floats). - -(The \acro{FAQ} team doesn't know of any package that will make -\LaTeX{} honour `[h]' placement of double-column floats, but the -\Package{midfloat} package can be pressed into service to provide -something approximating the effect it would have.) -\begin{ctanrefs} -\item[dblfloatfix.sty]\CTANref{dblfloatfix} -\item[stfloats.sty, midfloat.sty]Distributed as part of - \CTANref{sttools} -\end{ctanrefs} - -\Question[Q-mcfloat]{Floats in multicolumn setting} - -If you use -\begin{quote} -\begin{verbatim} -\begin{figure} - ... -\end{figure} -\end{verbatim} -\end{quote} -in a \environment{multicols} environment, the figure won't appear. If -instead you use -\begin{quote} -\begin{verbatim} -\begin{figure*} - ... -\end{figure*} -\end{verbatim} -\end{quote} -the figure will stretch right across the page (just the same as a -\environment{figure*} in standard \LaTeX{}'s \pkgoption{twocolumn} option). - -It's possible to have single-column figures and tables with captions, -using the `\texttt{[H]}' placement option introduced by the \Package{float} -package but you might have to fiddle with the placement because they -won't `float', and exhibit other strange behaviours (such as silently -running off the end of the column at the end of the -\environment{multicols} environment). -\begin{ctanrefs} -\item[float.sty]\CTANref{float} -\item[multicol.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-dpfloat]{Facing floats on 2-page spread} - -If a pair of floats are to be forced to form a 2-page spread (in a -book, or whatever), the first must lie on the left side of the spread, -on an even-numbered page. The \Package{dpfloat} package provides for -this: the construction to use is: -\begin{quote} -\begin{verbatim} -\begin{figure}[p] - \begin{leftfullpage} - <left side figure> - \end{leftfullpage} -\end{figure} -\begin{figure}[p] - \begin{fullpage} - <right side figure> - \end{fullpage} -\end{figure} -\end{verbatim} -\end{quote} -The construction has no effect unless the standard class option -\pkgoption{twoside} is in effect. - -Full documentation of the package (such as it is) is to be found in -\File{README.dpfloat} -\begin{ctanrefs} -\item[dpfloat.sty]\CTANref{dpfloat} -\end{ctanrefs} - -\Question[Q-vertposfp]{Vertical layout of float pages} - -By default, \LaTeX{} vertically centres the floats on a float page; -the present author is not alone in not liking this arrangement. -Unfortunately, the control of the positioning is ``buried'' in -\LaTeX{}-internal commands, so some care is needed to change the -layout. - -Float pages use three \LaTeX{} lengths (i.e., \TeX{} skips) to define -their layout: -\begin{description} -\item[\nothtml{\normalfont}\csx{@fptop}] defines the distance from the - top of the page to the top of the first float, -\item[\nothtml{\normalfont}\csx{@fpsep}] defines the separation between - floats, and -\item[\nothtml{\normalfont}\csx{@fpbot}] defines the distance from the - bottom of the last float on the page to the bottom of the page. -\end{description} -(In fact, the output routine places a skip of \csx{@fpsep} above each float, so -the \csx{@fptop} skip is always followed by a correction for that.) - - -The \LaTeX{} defaults are: -\begin{quote} - \csx{@fptop} = \texttt{0pt + 1fil}\\ - \csx{@fpsep} = \texttt{8pt + 2fil}\\ - \csx{@fpbot} = \texttt{0pt + 1fil}\\ -\end{quote} -so that the gaps expand to fill the space not occupied by floats, but -if there is more than one float on the page, the gap between them will -expand to twice the space at top and bottom. - -Those who understand this stuff will be able to play elaborate games, -but the commonest requirement, that the floats start at the top of the -page, is a simple thing to do: -\begin{quote} -\begin{verbatim} -\makeatletter -\setlength{\@fptop}{0pt} -\makeatother -\end{verbatim} -\end{quote} -Surprisingly, you may find this setting leaves your floats too high on -the page. One can justify a value of \texttt{5pt} (in place of -\texttt{0pt})~--- it's roughly the difference between \csx{topskip} -and the height of normal (\texttt{10pt}) text. - -Note that this is a ``global'' setting (best established in a class -file, or at worst in the document preamble); making the change for a -single float page is likely (at the least) to be rather tricky. - -\Question[Q-figurehere]{Figure (or table) \emph{exactly} where I want it} - -This is of course a contradiction: \environment{figure} and -\environment{table} are \emph{designed} to float, and will always have -the potential to appear away from where you asked for them. Therefore -you have to find a means of getting the caption and other effects -without allowing the figure or table to float. - -The most straightforward way is to use the \Package{float} package; it -gives you a \texttt{[H]} float placement option that prevents -floating: -\begin{quote} -\begin{verbatim} -\begin{figure}[H] - \centering - \includegraphics{foo} - \caption{caption text} - \label{fig:nonfloat} -\end{figure} -\end{verbatim} -\end{quote} -As the example shows, these \texttt{[H]} figures (and correspondingly, -tables) offer all you need to cross-reference as well as typeset. - -However, you don't actually \emph{have} to use \Package{float} since -it is, in fact, doing rather little for you. You can place your -figure as you please, with a sequence like -\begin{quote} -\begin{verbatim} -\begin{center} - \includegraphics{foo} - \captionof{figure}{caption text} - \label{fig:nonfloat} -\end{center} -\end{verbatim} -\end{quote} -which relies on the \csx{captionof} command to place a caption in -ordinary running text. That command may be had from the extremely -simple-minded package \Package{capt-of} or from the highly -sophisticated \Package{caption} package. - -Using either method, you have to deal with the possibility of the -figure or table being too large for the page. (Floating objects will -float away in this circumstance; ``doing it by hand'', like this, you -take upon yourself the responsibility for avoiding % ! line break -`\textit{Overfull \csx{vbox}}' errors. - -A further problem is the possibility that such ``fixed floats'' will -overtake ``real floats'', so that the numbers of figures will be out -of order: figure 6 could be on page 12, while figure 5 had floated to -page 13. It's best, therefore, either to stay with floating figures -throughout a document, or to use fixed figures throughout. - -If it's really impossible to follow that counsel of perfection, you -can use the \Package{perpage} package's command \csx{MakeSorted} -command: -\begin{quote} -\begin{verbatim} -... -\usepackage{float} -\usepackage{perpage} -\MakeSorted{figure} -\MakeSorted{table} -... -\end{verbatim} -\end{quote} -and the sequence of float numbers is all correct. -\begin{ctanrefs} -\item[capt-of.sty]\CTANref{capt-of} -\item[caption.sty]\CTANref{caption} -\item[float.sty]\CTANref{float} -\item[perpage.sty]Distributed as part \CTANref{bigfoot} -\end{ctanrefs} - -\subsection{Footnotes} - -\Question[Q-footintab]{Footnotes in tables} - -The standard \LaTeX{} \csx{footnote} command doesn't work in tables; the table -traps the footnotes and they can't escape to the bottom of the page. - -If your table is floating, your best bet is (unfortunately) to put the -table in a \environment{minipage} environment and to put the notes -underneath the table, or to use Donald Arseneau's package -\Package{threeparttable} (which implements ``table notes'' proper). - -The \Package{ctable} package extends the model of -\Package{threeparttable}, and also uses the ideas of the -\Package{booktabs} package. The \csx{ctable} command does the complete -job of setting the table, placing the caption, and defining the -notes. The ``table'' may consist of diagrams, and a parameter in -\csx{ctable}'s optional argument makes the float that is created a -``figure'' rather than a ``table''. - -Otherwise, if your table is not floating (it's just a -`\texttt{tabular}' in the middle of some text), there are several -things you can do to fix the problem. -\begin{itemize} -\item Use \csx{footnotemark} to position the little marker - appropriately, and then put in \csx{footnotetext} commands to fill in - the text once you've closed the \environment{tabular} environment. - This is described in Lamport's book, but it gets messy if there's - more than one footnote. -\item Stick the table in a \texttt{minipage} anyway. This provides all the - ugliness of footnotes in a minipage with no extra effort. -\item Use \Package{threeparttable} anyway; the package is intended for - floating tables, and the result might look odd if the table is not - floating, but it will be reasonable. -\item Use \Package{tabularx} or \Package{longtable} from the \LaTeX{} - tools distribution; they're noticeably less efficient than the - standard \environment{tabular} environment, but they do allow - footnotes. -\item Use \Package{footnote}, which provides an - \environment{savenotes} which collects all footnotes and emits them - at the end of the environment; thus if you put your - \environment{tabular} environment inside the environment, the - footnotes will appear as needed. Alternatively, you may use - \cmdinvoke{makesavenoteenv}{tabular} in the preamble of your - document, and tables will all behave as if they were inside a - \environment{savenotes} environment. -\item Use \Package{mdwtab} from the same bundle; it will handle - footnotes properly, and has other facilities to increase the beauty - of your tables. Unfortunately, it may be incompatible with other - table-related packages, though not those in the standard `tools' - bundle. -\end{itemize} - -The documentation of \Package{threeparttable} appears in the package -file itself; that of \Package{ctable} is distributed as a \acro{PDF} -file (for convenience's sake). -\begin{ctanrefs} -\item[ctable.sty]\CTANref{ctable} -\item[footnote.sty]Distributed as part of \CTANref{mdwtools} -\item[longtable.sty]Distributed as part of \CTANref{2etools} -\item[mdwtab.sty]Distributed as part of \CTANref{mdwtools} -\item[threeparttable.sty]\CTANref{threeparttable} -\item[tabularx.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-ftnsect]{Footnotes in \LaTeX{} section headings} - -The \csx{footnote} command is fragile, so that simply placing the -command in \csx{section}'s arguments isn't satisfactory. Using -\csx{protect}\csx{footnote} isn't a good idea either: the arguments of a -section command are used in the table of contents and (more -dangerously) potentially also in page headers. While footnotes will -work in the table of contents, it's generally not thought a ``good -thing'' to have them there; in the page header, footnotes will simply -fail. Whatever the desirability of the matter, there's no mechanism -to suppress the footnote in the page header while allowing it in the table -of contents, so the footnote may only appear in the section heading itself. - -To suppress the footnote in headings and table of contents: -\begin{itemize} -\item Take advantage of the fact that the mandatory argument doesn't - `move' if the optional argument is present: - - \cmdinvoke{section}[title]% - \texttt{\{title}\cmdinvoke{footnote}{title ftnt}\texttt{\}} -\item Use the \Package{footmisc} package, with package option - \texttt{stable}~--- this modifies footnotes so that they softly and - silently vanish away if used in a moving argument. With this, you - simply need: -\begin{verbatim} -% in the document preamble -\usepackage[stable]{footmisc} -... -% in the body of the document -\section{title\footnote{title ftnt}} -\end{verbatim} -\end{itemize} -\begin{ctanrefs} -\item[footmisc.sty]\CTANref{footmisc} -\end{ctanrefs} - -\Question[Q-ftncapt]{Footnotes in captions} - -Footnotes in captions are especially tricky: they present problems of -their own, on top of the problems one experiences with -\Qref*{footnotes in section titles}{Q-ftnsect} (footnotes migrating to -to the list of figures or tables, or % ! line break -\Qref{apparently random errors}{Q-extrabrace} because -\csx{footnote} is a fragile command), and with % ! line break -\Qref*{footnotes in tables}{Q-footintab} (typically, the footnote -simply disappears). Fortunately, the requirement for footnotes in -captions is extremely rare: if you are experiencing problems, it is -worth reviewing what you are trying to say by placing this footnote: -other options are to place text at the bottom of the float, or to -place a footnote at the point where you refer to the float. - -Note that the \Package{threeparttable} scheme (see, again, % ! line break -\Qref[question]{footnotes in tables}{Q-footintab}) also applies -to notes in captions, and may very well be preferable to whatever you -were thinking of. - -If you \emph{are} going to proceed: -\begin{itemize} -\item use an optional argument in your \csx{caption} command, that - doesn't have the footnote in it; this prevents the footnote - appearing in the ``List of \dots{}'', and -\item put your whole float in a \environment{minipage} so as to keep - the footnotes with the float. -\end{itemize} -so we have: -\begin{quote} -\begin{verbatim} -\begin{figure} - \begin{minipage}{\textwidth} - ... - \caption[Caption for LOF]% - {Real caption\footnote{blah}} - \end{minipage} -\end{figure} -\end{verbatim} -\end{quote} -However, \emph{as well as} all of the above, one \emph{also} has to -deal with the tendency of the \csx{caption} command to produce the -footnote's text twice. For this last problem, there is no tidy -solution this author is aware of. - -If you're suffering the problem, a well-constructed \csx{caption} -command in a \environment{minipage} environment within a float (as -in the example above) can produce \emph{two} copies of the footnote -body ``blah''. (In fact, the effect only occurs with captions that are -long enough to require two lines to be typeset, and so wouldn't appear -with such a short caption as that in the example above.) - -The documentation of the \Package{ccaption} package describes a really -rather awful work-around for this problem. -\begin{ctanrefs} -\item[ccaption.sty]\CTANref{ccaption} -\item[threeparttable.sty]\CTANref{threeparttable} -\end{ctanrefs} - -\Question[Q-repfootnote]{Footnotes whose texts are identical} - -If the \emph{same} footnote turns up at several places within a -document, it's often inappropriate to repeat the footnote in its -entirety over and over again. We can avoid repetition by -semi-automatic means, or by simply labelling footnotes that we know -we're going to repeat and then referencing the result. There is no -completely automatic solution (that detects and suppresses repeats) -available. - -If you know you only have one footnote, which you want to repeat, the -solution is simple: merely use the optional argument of -\csx{footnotemark} to signify the repeats: -\begin{quote} -\begin{verbatim} -...\footnote{Repeating note} -... -...\footnotemark[1] -\end{verbatim} -\end{quote} -\dots{}\@ which is very easy, since we know there will only ever be a -footnote number 1. A similar technique can be used once the footnotes -are stable, reusing the number that \LaTeX{} has allocated. This can -be tiresome, though, as any change of typesetting could change the -relationships of footnote and repeat: labelling is inevitably better. - -Simple hand-labelling of footnotes is possible, using a counter dedicated -to the job: -\begin{quote} -\begin{verbatim} -\newcounter{fnnumber} -... -...\footnote{Text to repeat}% -\setcounter{fnnumber}{\thefootnote}% -... -...\footnotemark[\thefnnumber] -\end{verbatim} -\end{quote} -but this is somewhat tedious. \LaTeX{}'s labelling mechanism can be -summoned to our aid, but there are ugly error messages before the -\csx{ref} is resolved on a second run through \LaTeX{}: -\begin{quote} -\begin{verbatim} -...\footnote{Text to repeat\label{fn:repeat}} -... -...\footnotemark[\ref{fn:repeat}] -\end{verbatim} -\end{quote} -Alternatively, one may use the \csx{footref} command, which has the -advantage of working even when the footnote mark isn't expressed as a -number. The command is defined in the \Package{footmisc} package and -in the \Class{memoir} class (at least); \csx{footref} reduces the above -example to: -\begin{quote} -\begin{verbatim} -...\footnote{Text to repeat\label{fn:repeat}} -... -...\footref{fn:repeat} -\end{verbatim} -\end{quote} -This is the cleanest simple way of doing the job. Note that the -\csx{label} command \emph{must} be inside the argument of -\csx{footnote}. - -The \Package{fixfoot} package takes away some of the pain of the -matter: you declare footnotes you're going to reuse, typically in the -preamble of your document, using a \csx{DeclareFixedFoot} command, and -then use the command you've `declared' in the body of the document: -\begin{quote} -\begin{verbatim} -\DeclareFixedFootnote{\rep}{Text to repeat} -... -...\rep{} -...\rep{} -\end{verbatim} -\end{quote} -The package ensures that the repeated text appears at most once per -page: it will usually take more than one run of \LaTeX{} to get rid of -the repeats. -\begin{ctanrefs} -\item[fixfoot.sty]\CTANref{fixfoot} -\item[footmisc.sty]\CTANref{footmisc} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-multfoot]{More than one sequence of footnotes} - -The need for more than one series of footnotes is common in critical -editions (and other literary criticism), but occasionally arises in -other areas. - -Of course, the canonical critical edition package, \Package{edmac}, -offers the facility, as does its \LaTeX{} port, the \Package{ledmac} -package. - -Multiple ranges of footnotes are offered to \LaTeX{} users by the -\Package{manyfoot} package. The package provides a fair array of -presentation options, as well. Another critical edition -\Package{ednotes} package is built upon a basis that includes -\Package{manyfoot}, as its mechanism for multiple sets of footnotes. - -The \Package{bigfoot} package also uses \Package{manyfoot} as part of -its highly sophisticated structure of footnote facilities, which was -also designed to support typesetting critical editions. -\begin{ctanrefs} -\item[bigfoot]\CTANref{bigfoot} -\item[edmac]\CTANref{edmac} -\item[ednotes]\CTANref{ednotes} -\item[ledmac]\CTANref{ledmac} -\item[manyfoot.sty]Distributed as part of the \CTANref{ncctools} - bundle -\end{ctanrefs} - -\Question[Q-footnpp]{Footnotes numbered ``per page''} - -The obvious solution is to make the footnote number reset whenever the -page number is stepped, using the % ! line break -\Qref*{\LaTeX{} internal mechanism}{Q-addtoreset}. Sadly, the place -in the document where the page number is stepped is unpredictable, not -(``tidily'') at the end of the printed page; so changing the footnote -number only ever works by `luck'. - -As a result, resetting footnotes is inevitably a complicated process, -using labels of some sort. It's nevertheless important, given the -common requirement for footnotes marked by symbols (with painfully -small symbol sets). There are four packages that manage it, one way -or another. - -The \Package{perpage} package provides a general mechanism for -resetting counters per page, so can obviously be used for this task. -The interface is pretty simple: \cmdinvoke{MakePerPage}{footnote} will -do the job. If you want to restart the counter at something other -than~1 (for example to avoid something in the \LaTeX{} footnote symbol -list), you can use: \cmdinvoke{MakePerPage}[2]{footnote}. It's a -first-rate package, small and efficient. - -The \Package{zref} package provides the same facilities with its -\pkgoption{perpage} module, which defines a command \csx{zmakeperpage} -whose syntax is identical to that of \Package{perpage}, above. You can -load the module by \cmdinvoke{usepackage}[perpage]{zref} (or as -\cmdinvoke{usepackage}{zref-perpage}, if your needs so require~--- -look at \Package{zref}'s documentation for details). - -The \Package{footmisc} package provides a variety of means of -controlling footnote appearance, among them a package option -\pkgoption{perpage} that adjusts the numbering per page; if you're -doing something else odd about footnotes, it means you may only need -the one package to achieve your ends. - -The \Package{footnpag} package also does per-page footnotes (and -nothing else). With the competition from \Package{perpage}, it's -probably not particularly useful any more. (Documentation is -\File{footnpag-user.pdf} in the distribution.) -\begin{ctanrefs} -\item[footmisc.sty]\CTANref{footmisc} -\item[footnpag.sty]\CTANref{footnpag} -\item[perpage.sty]Distributed as part \CTANref{bigfoot} -\item[zref.sty]Distributed as a collection member in \CTANref{oberdiek} -\item[zref-perpage.sty]Distributed as a collection member in - \CTANref{oberdiek} -\end{ctanrefs} - -\Question[Q-run-fn-nos]{Not resetting footnote numbers per chapter} - -Some classes (for example, \Class{book} and \Class{report}) set up a -different set of footnotes per chapter, by resetting the footnote -number at the start of the chapter. This is essentially the same -action as that of % ! line break -\Qref*{equation, figure and table numbers}{Q-running-nos}, -except that footnote numbers don't get ``decorated'' with the chapter -number, as happens with those other numbers. - -The solution is the same: use the \Package{chngcntr} package; since the -numbers aren't ``decorated'' you can use the \csx{counterwithout*} -variant; the code: -\begin{quote} -\begin{verbatim} -\counterwithout*{footnote}{chapter} -\end{verbatim} -\end{quote} -is all you need -\begin{ctanrefs} -\item[chngcntr.sty]\CTANref{chngcntr} -\end{ctanrefs} - -\subsection{Document management} - -\Question[Q-filename]{What's the name of this file} - -One might want this so as to automatically generate a page header or -footer recording what file is being processed. It's not easy\dots{} - -\TeX{} retains what it considers the name of the \emph{job}, only, in -the primitive \csx{jobname}; this is the name of the file first -handed to \TeX{}, stripped of its directory name and of any extension -(such as \extension{tex}). If no file was passed (i.e., you're using -\TeX{} interactively), \csx{jobname} has the value \texttt{texput} -(the name that's given to \extension{log} files in this case). - -This is fine, for the case of a small document, held in a single file; -most significant documents will be held in a bunch of files, and -\TeX{} makes no attempt to keep track of files input to the -\emph{job}. So the user has to keep track, himself~--- the only way -is to patch the input commands and cause them to retain details of the -file name. This is particularly difficult in the case of \plaintex{}, -since the syntax of the \csx{input} command is so peculiar. - -In the case of \LaTeX{}, the input commands have pretty regular -syntax, and the simplest \Qref*{patching techniques}{Q-patch} can be -used on them. - -If you're not inputting things from a file that's already been input, -the job is almost trivial: -\begin{quote} -\begin{verbatim} -\def\ThisFile{\jobname} -\let\OldInput\input -\renewcommand{\input}[1]{% - \renewcommand{\ThisFile}{#1}% - \OldInput{#1}% -} -\end{verbatim} -\end{quote} -With that, the macro \csx{ThisFile} always contains the last thing -input: it starts pointing at the base file of your document -(\csx{jobname}), and thereafter changes every time you use -\cmdinvoke*{input}{file}. - -Most ordinary users will quickly become irritated with the simplicity -of of the \csx{ThisFile} mechanism above. The following code is more -cunning: it maintains details of the files you've `come through' to -get to where you are, and it restores \csx{ThisFile} to what the -previous file was before returning. -\begin{quote} -\begin{verbatim} -\def\ThisFile{\jobname} -\newcounter{FileStack} -\let\OrigInput\input -\renewcommand{\input}[1]{% - \stackinput{#1}{\OrigInput}% -} -\newcommand{\stackinput}[2]{% - \stepcounter{FileStack}% - \expandafter\let - \csname NameStack\theFileStack\endcsname - \ThisFile - \def\ThisFile{#1}% - #2{#1}% - \expandafter\let\expandafter - \ThisFile - \csname NameStack\theFileStack\endcsname - \addtocounter{FileStack}{-1}% -} -\end{verbatim} -\end{quote} -To do the same for \csx{include}, we need the simple addition: -\begin{quote} -\begin{verbatim} -\let\OrigInclude\include -\renewcommand{\include}[1]{% - \stackinput{#1}{\OrigInclude}% -} -\end{verbatim} -\end{quote} -Both examples of patching \csx{input} assume you always use -\LaTeX{} syntax, i.e., always use braces around the argument. - -The \Package{FiNK} (``File Name Keeper'') package provides a -regular means of keeping track of the current file name (with its -extension), in a macro \csx{finkfile}. If you need the unadorned file -name (without its `\extension{tex}'), use the commands: -\begin{quote} -\begin{verbatim} -\def\striptexext#1.tex{#1} -... -\edef\ThisFile{\expandafter\stripext\finkfile} -\end{verbatim} -\end{quote} -The \Package{FiNK} bundle includes a \File{fink.el} that provides -support under \ProgName{emacs} with \acro{AUC}-\TeX{}. -\begin{ctanrefs} -\item[fink.sty]\CTANref{fink} -\end{ctanrefs} - -\Question[Q-filesused]{All the files used by this document} - -When you're sharing a document with someone else (perhaps as part of a -co-development cycle) it's as well to arrange that both correspondents -have the same set of auxiliary files, as well as the document in -question. Your correspondent obviously needs the same set of files -(if you use the \Package{url} package, she has to have \Package{url} -too, for example). But suppose you have a bug-free version of the -\Package{shinynew} package but her copy is still the unstable -original; until you both realise what is happening, such a situation -can be very confusing. - -The simplest solution is the \LaTeX{} \csx{listfiles} command. This -places a list of the files used and their version numbers in the log -file. If you extract that list and transmit it with your file, it can -be used as a check-list in case that problems arise. - -Note that \csx{listfiles} only registers things that are input by the -``standard'' \LaTeX{} mechanisms (\csx{documentclass}, \csx{usepackage}, -\csx{input}, \csx{include}, \csx{includegraphics} and so on). But if you -use \TeX{} primitive syntax, as in -\begin{verbatim} - \input mymacros -\end{verbatim} -\File{mymacros.tex} \emph{won't} be listed by \csx{listfiles}, since -you've bypassed the mechanism that records its use. - -The \Package{snapshot} package helps the owner of a \LaTeX{} document -obtain a list of the external dependencies of the document, in a form -that can be embedded at the top of the document. The intended use of -the package is the creation of archival copies of documents, but it -has application in document exchange situations too. - -The \ProgName{bundledoc} system uses the \Package{snapshot} to produce an -archive (e.g., \extension{tar.gz} or \extension{zip}) of the files needed by your -document; it comes with configuration files for use with -\ProgName{teTeX} and \ProgName{\miktex{}}. It's plainly useful when -you're sending the first copy of a document. -\begin{ctanrefs} -\item[bundledoc]\CTANref{bundledoc} -\item[snapshot.sty]\CTANref{snapshot} -\end{ctanrefs} - -\Question[Q-changebars]{Marking changed parts of your document} - -One often needs clear indications of how a document has changed, but -the commonest technique, ``change bars'' (also known as ``revision -bars''), requires surprisingly much -trickery of the programmer (the problem being that \TeX{} `proper' -doesn't provide the programmer with any information about the -``current position'' from which a putative start- or end-point of a -bar might be calculated; \PDFTeX{} \emph{does} provide the -information, but we're not aware yet of any programmer taking -advantage of the fact to write a \PDFTeX{}-based changebar package). - -The simplest package that offers change bars is Peter Schmitt's -\Package{backgrnd.tex}; this was written as a \plaintex{} application -that patches the output routine, but it appears to work at least on -simple \LaTeX{} documents. Wise \LaTeX{} users will be alerted by the -information that \Package{backgrnd} patches their output routine, and -will watch its behaviour very carefully (patching the \LaTeX{} output -routine is not something to undertake lightly\dots{}). - -The longest-established \LaTeX{}-specific solution is the -\Package{changebar} package, -which uses \csx{special} commands supplied by the driver you're using. -You need therefore to tell the package which driver to generate -\csx{special}s for (in the same way that you need to tell the -\Package{graphics} package); the list of available drivers is pretty -wide, but does not include \ProgName{dvipdfm}. The package comes with -a shell script \ProgName{chbar.sh} (for use on Unix machines) that -will compare two documents and generate a third which is marked-up -with \Package{changebar} macros to highlight changes. The -shareware \ProgName{WinEDT} editor has a macro that will generate -\Package{changebar} (or other) macros to show differences from an -earlier version of your file, stored in an -\ProgName{RCS}-controlled repository~--- see -\URL{http://www.winedt.org/Macros/LaTeX/RCSdiff.php} - -The \Package{vertbars} package uses the techniques of the -\Package{lineno} package (which it loads, so the \Package{lineno} -itself must be installed); it's thus the smallest of the packages for -change bar marking, since it leaves all the trickery to another -package. \Package{Vertbars} defines a \environment{vertbar} -environment to create changebars. - -The \Package{framed} package is -another that provides bars as a side-effect of other desirable -functionality: its \environment{leftbar} environment is simply a -stripped-down frame (note, though, that the environment makes a -separate paragraph of its contents, so it is best used when the -convention is to mark a whole changed paragraph. - -Finally, the \Class{memoir} class allows marginal editorial comments, -which you can obviously use to delimit areas of changed text. - -An even more comprehensive way to keep track of changes is employed by -some word-processors~--- to produce a document that embodies both -``old'' and ``new'' versions. - -To this end, the package \Package{changes} allows the user to manually -markup changes of text, such as additions, deletions, or replacements. -Changed text is shown in a different colour; deleted text is crossed -out. The package allows you to define additional authors and their -associated colour; it also allows you to define a markup for authors -or annotations. The documentation (very clearly) demonstrates how the -various functions work. - -The \ProgName{Perl} script \ProgName{latexdiff} may also be used to -generate such markup for \LaTeX{} documents; you feed it the two -documents, and it produces a new \LaTeX{} document in which the -changes are very visible. An example of the output is embedded in the -documentation, -\begin{narrowversion} % actually non-hyperversion - \File{latexdiff-man.pdf}, in the distribution. -\end{narrowversion} -\begin{wideversion} % actually hyperversion - \href{http://www.tex.ac.uk/tex-archive/support/latexdiff/latexdiff-man.pdf}{latexdiff-man.pdf} - (part of the distribution). -\end{wideversion} -A rudimentary revision facility is provided by another -\ProgName{Perl} script, \ProgName{latexrevise}, which accepts or rejects -all changes. Manual editing of the difference file can be used to -accept or reject selected changes only. -\begin{ctanrefs} -\item[backgrnd.tex]\CTANref{backgrnd} -\item[changebar.sty]\CTANref{changebar} -\item[changes.sty]\CTANref{changes} -\item[framed.sty]\CTANref{framed} -\item[latexdiff, latexrevise]\CTANref{latexdiff} -\item[lineno.sty]\CTANref{lineno} -\item[memoir.cls]\CTANref{memoir} -\item[vertbars.sty]\CTANref{vertbars} -\end{ctanrefs} - -\Question[Q-conditional]{Conditional compilation and ``comments''} - -While \LaTeX{} (or any other \TeX{}-derived package) isn't really like a -compiler, people regularly want to do compiler-like things using it. -Common requirements are conditional `compilation' and `block -comments', and several \LaTeX{}-specific means to this end are available. - -The simple \cmdinvoke{newcommand}{\csx{gobble}}[1]\texttt{\{}\texttt{\}} -and \csx{iffalse}\texttt{ ... }\csx{fi} aren't really satisfactory (as -a general solution) for comments, since the matter being skipped is -nevertheless scanned by \TeX{}, not always as you would expect. The -scanning imposes restrictions on what you're allowed to skip; this may -not be a problem in \emph{today's} job, but could return to bite you -tomorrow. For an example of surprises that may come to bite you, -consider the following example (derived from real user experience): -\begin{quote} -\begin{verbatim} -\iffalse % ignoring this bit -consider what happens if we -use \verb+\iftrue+ -- a surprise -\fi -\end{verbatim} -\end{quote} -The \csx{iftrue} is spotted by \TeX{} as it scans, ignoring the -\csx{verb} command; so the \csx{iffalse} isn't terminated by the -following \csx{fi}. Also, \csx{gobble} is pretty inefficient at -consuming anything non-trivial, since all the matter to be skipped is -copied to the argument stack before being ignored. - -If your requirement is for a document from which whole chapters (or -the like) are missing, consider the \LaTeX{} -\csx{include}/\csx{includeonly} system. If you `\csx{include}' your -files (rather than \csx{input} them~--- see % line wrap! -\Qref[question]{What's going on in my \csx{include} commands?}{Q-include}), -\LaTeX{} writes macro traces of what's going on at the end of each -chapter to the \extension{aux} file; by using \csx{includeonly}, you can give -\LaTeX{} an exhaustive list of the files that are needed. Files that -don't get \csx{include}d are skipped entirely, but the document -processing continues as if they \emph{were} there, and page, footnote, -and other numbers are not disturbed. Note that you can choose which -sections you want included interactively, using the -\Package{askinclude} package. - -The inverse can be done using the \Package{excludeonly} package: this -allows you to exclude a (list of) \csx{include}d files from your -document, by means of an \csx{excludeonly} command. - -If you want to select particular pages of your document, use Heiko -Oberdiek's \Package{pagesel} or the \Package{selectp} packages. You -can do something similar with an existing \acro{PDF} document (which -you may have compiled using \ProgName{pdflatex} in the first place), -using the \Package{pdfpages} package. The job is then done with a -document looking like: -\begin{quote} -\begin{verbatim} -\documentclass{article} -\usepackage[final]{pdfpages} -\begin{document} -\includepdf[pages=30-40]{yoursource.pdf} -\end{document} -\end{verbatim} -\end{quote} -(To include all of the document, you write -\begin{quote} -\begin{verbatim} -\includepdf[pages=-]{yoursource.pdf} -\end{verbatim} -\end{quote} -omitting the start and end pages in the optional argument.) - -If you want flexible facilities for including or excluding small -portions of a file, consider the \Package{comment}, \Package{version} or -\Package{optional} packages. - -The \Package{comment} package allows you to declare areas of a document to be -included or excluded; you make these declarations in the preamble of -your file. The command \cmdinvoke*{includecomment}{version-name} -declares an environment \environment{version-name} whose content will -be included in your document, while -\cmdinvoke*{excludecomment}{version-name} defines an environment whose -content will be excluded from the document. The package uses a method -for exclusion that is pretty robust, and can cope with ill-formed -bunches of text (e.g., with unbalanced braces or \csx{if} commands). - -These FAQs employ the \Package{comment} package to alter layout -between the printed (two-column) version and the \acro{PDF} version -for browsing; there are \environment{narrowversion} and -\environment{wideversion} for the two versions of the file. - -\Package{version} offers similar facilities to \File{comment.sty} -(i.e., \csx{includeversion} and \csx{excludeversion} commands); -it's far ``lighter weight'', but is less robust (and in particular, -cannot deal with very large areas of text being included/excluded). - -A significant development of \Package{version}, confusingly called -\Package{versions} (i.e., merely a plural of the old package name). -\Package{Versions} adds a command -\cmdinvoke*{markversion}{version-name} which defines an environment -that prints the included text, with a clear printed mark around it. - -\Package{optional} defines a command \csx{opt}; its first argument is -an `inclusion flag', and its second is text to be included or -excluded. Text to be included or excluded must be well-formed -(nothing mismatched), and should not be too big~--- if a large body of -text is needed, \csx{input} should be used in the argument. -The documentation (in the package file itself) tells you -how to declare which sections are to be included: this can be done in -the document preamble, but the documentation also suggests ways in -which it can be done on the command line that invokes \LaTeX{}, or -interactively. - -And, not least of this style of conditional compilation, -\Package{verbatim} (which should be available in any distribution) -defines a \environment{comment} environment, which enables the -dedicated user of the source text editor to suppress bits of a -\LaTeX{} source file. The \Class{memoir} class offers the same -environment. - -An interesting variation is the \Package{xcomment} package. This -defines an environment whose body is all excluded, apart from -environments named in its argument. So, for example: -\begin{quote} -\begin{verbatim} -\begin{xcomment}{figure,table} - This text is not included - \begin{figure} - This figure is included - \end{figure} - This is not included, either - \begin{table} - This table also included - \end{table} - ... -\end{xcomment} -\end{verbatim} -\end{quote} - -A further valuable twist is offered by the \Package{extract} package. -This allows you to produce a ``partial copy'' of an existing document: -the package was developed to permit production of a ``book of -examples'' from a set of lecture notes. The package documentation -shows the following usage: -\begin{quote} -\begin{verbatim} -\usepackage[ - active, - generate=foobar, - extract-env={figure,table}, - extract-cmd={chapter,section} -]{extract} -\end{verbatim} -\end{quote} -which will cause the package to produce a file \File{foobar.tex} -containing all the \environment{figure} and \environment{table} -environments, and the \csx{chapter} and \csx{section} commands, from -the document being processed. The new file \File{foobar.tex} is -generated in the course of an otherwise ordinary run on the `master' -document. The package provides a good number of other facilities, -including (numeric or labelled) ranges of environments to extract, and -an \environment{extract} environment which you can use to create complete -ready-to-run \LaTeX{} documents with stuff you've extracted. -\begin{ctanrefs} -\item[askinclude.sty]Distributed with Heiko Oberdiek's packages~--- - \CTANref{oberdiek} -\item[comment.sty]\CTANref{comment} -\item[excludeonly.sty]\CTANref{excludeonly} -\item[extract.sty]\CTANref{extract} -\item[memoir.cls]\CTANref{memoir} -\item[optional.sty]\CTANref{optional} -\item[pagesel.sty]Distributed with Heiko Oberdiek's packages~--- - \CTANref{oberdiek} -\item[pdfpages.sty]\CTANref{pdfpages} -\item[selectp.sty]\CTANref{selectp} -\item[verbatim.sty]Distributed as part of \CTANref{2etools} -\item[version.sty]\CTANref{version} -\item[versions.sty]\CTANref{versions} -\item[xcomment.sty]Distributed as part of \CTANref{seminar} -\end{ctanrefs} - -\Question[Q-docotherdir]{Bits of document from other directories} - -A common way of constructing a large document is to break it into a -set of files (for example, one per chapter) and to keep everything -related to each of these subsidiary files in a subdirectory. - -Unfortunately, \TeX{} doesn't have a changeable ``current directory'', -so that all files you refer to have to be specified relative to the -same directory as the main file. Most people find this -counter-intuitive. - -It may be appropriate to use the ``path extension'' technique -% beware line break -\Qref[of question]{used in temporary installations}{Q-tempinst} to deal with -this problem. However, if there several files with the same name in -your document, such as \File{chapter1/fig1.eps} and -\File{chapter2/fig1.eps}, you're not giving \TeX{} any hint as to -which you're referring to when in the main chapter file you say -\cmdinvoke{input}{sect1}; while this is readily soluble in the case of -human-prepared files (just don't name them all the same), -automatically produced files have a way of having repetitious names, -and changing \emph{them} is a procedure prone to error. - -The \Package{import} package comes to your help here: it defines an -\csx{import} command that accepts a full path name and the name of a -file in that directory, and arranges things to ``work properly''. -So, for example, if \File{/home/friend/results.tex} contains -\begin{quote} -\begin{verbatim} -Graph: \includegraphics{picture} -\input{explanation} -\end{verbatim} -\end{quote} -then \cmdinvoke{import}{/home/friend/}{results} will include both -graph and explanation as one might hope. A \csx{subimport} command -does the same sort of thing for a subdirectory (a relative path rather -than an absolute one), and there are corresponding \csx{includefrom} -and \csx{subincludefrom} commands. - -The \Package{chapterfolder} package provides commands to deal with its -(fixed) model of file inclusion in a document. It provides commands -\csx{cfpart}, \csx{cfchapter}, \csx{cfsection} and \csx{cfsubsection}, -each of which takes directory and file arguments, e.g.: -\begin{quote} -\begin{verbatim} -\cfpart[pt 1]{Part One}{part1}{part} -\end{verbatim} -\end{quote} -which command will issue a `normal' command % ! line break -\cmdinvoke{part}[pt 1]{Part One} and then input the file -\File{part1/part.tex}, remembering that \File{part1/} is now the -``current folder''. There are also commands of the form -\csx{cfpartstar} (which corresponds to a \csx{part*} command). - -Once you're ``in'' a \Package{chapterfolder}-included document, you -may use \csx{cfinput} to input something relative to the ``current -folder'', or you may use \csx{input}, using \csx{cfcurrentfolder} to -provide a path to the file. (There are also -\csx{cfcurrentfolderfigure} for a \path{figure/} subdirectory and -\csx{cfcurrentfolderlistings} for a \path{listings/} subdirectory.) - -Documentation of \Package{chapterfolder} is in French, but the -\File{README} in the directory is in English. -\begin{ctanrefs} -\item[chapterfolder.sty]\CTANref{chapterfolder} -\item[import.sty]\CTANref{import} -\end{ctanrefs} - -\Question[Q-RCS]{Version control using \acro{RCS}, \acro{CVS} or the like} - -If you use \acro{RCS}, \acro{CVS}, \ProgName{Subversion}, -\ProgName{Bazaar} or \ProgName{Git} to maintain -your \AllTeX{} documents under version control, you may need some -mechanism for including the version details in your document, in such -a way that they can be typeset (that is, rather than just hiding them -inside a comment). - -The most complete solution for \acro{RCS} and \acro{CVS} is to use the -(\LaTeX{}) package \Package{rcs}, which allows you to parse and -display the contents of \acro{RCS} keyword fields in an extremely -flexible way. The package \Package{rcsinfo} is simpler, but does most -of what you want, and some people prefer it; it is explicitly -compatible with \ProgName{LaTeX2HTML}. - -If, however, you need a solution which works without using external -packages, or which will work in \plaintex{}, then you can use the -following minimal solution: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\def\RCS$#1: #2 ${\expandafter\def\csname RCS#1\endcsname{#2}} -\RCS$Revision: 1.612 $ % or any RCS keyword -\RCS$Date: 2009/06/09 22:45:20 $ -... -\date{Revision \RCSRevision, \RCSDate} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\def\RCS$#1: #2 ${\expandafter - \def\csname RCS#1\endcsname{#2}% -} -\RCS$Revision: 1.612 $ % or any RCS keyword -\RCS$Date: 2009/06/09 22:45:20 $ -... -\date{Revision \RCSRevision, \RCSDate} -\end{verbatim} -\end{narrowversion} -\end{quote} - -If you've entered the brave new world of \ProgName{Subversion}, the -package \Package{svn} may be for you. It has explicit cleverness -about dealing with dates: -\begin{quote} -\csx{documentclass}\texttt{\{\meta{foo}\}}\\ -\texttt{...}\\ -\cmdinvoke{usepackage}{svn}\\ -\csx{SVNdate}\texttt{ \$Date\$}\\ -\cmdinvoke{author}{...}\\ -\cmdinvoke{title}{...}\\ -\texttt{...}\\ -\cmdinvoke{begin}{document}\\ -\csx{maketitle}\\ -\texttt{...}\\ -\cmdinvoke{end}{document} -\end{quote} -will (once \ProgName{subversion} has committed a copy of the document) -cause \csx{maketitle} use the date that has been written into the -\texttt{\$Date\$} keyword. - -Another alternative for \ProgName{Subversion} users is the -\Package{svninfo} package, which has much the same mechanisms as does -\Package{svn} but with a rather different focus. \Package{Svninfo} -does the date trick that \Package{svn} performs (controlled by a -package option), and can set up page foot-lines using % ! line break -\Qref*{package \Package{fancyhdr}}{Q-fancyhdr}. There isn't much to -choose between the two packages: you should read the packages' -documentation to see which suits you best. - -An alternative script-based approach to version control has been taken -by the \Package{vc} bundle, that in certain situations might work more -reliably than any of the packages mentioned above. The \Package{vc} -bundle supports \ProgName{Bazaar}, \ProgName{Git} and -\ProgName{Subversion} usage and works with both \LaTeX{} and -\plaintex{}. Note that \Package{vc} is the only option that -currently claims to support \ProgName{Bazaar}- and -\ProgName{Git}-controlled repositories. -\begin{ctanrefs} -\item[rcs.sty]\CTANref{rcs} -\item[rcsinfo.sty]\CTANref{rcsinfo} -\item[svn.sty]\CTANref{svn} -\item[svninfo.sty]\CTANref{svninfo} -\item[vc]\CTANref{vc} -\end{ctanrefs} - -\Question[Q-make]{Makefiles for \LaTeX{} documents} - -\LaTeX{} is a tricky beast for running \ProgName{make} on: the need to -instruct \LaTeX{} to run several times for essentially different -reasons (for example, ``get the table of contents stable'', ``get the -labels stable'', ``add the bibliography'', ``add the index'') is -actually rather difficult to express in the `ordinary' sort of -dependency graph that one constructs for \ProgName{make}. - -For this reason, the only \ProgName{make}-like package on \acro{CTAN} -(for a long time) was \ProgName{latexmk}, which is a \ProgName{Perl} -script that analyses your \LaTeX{} source for its dependencies, runs -\BibTeX{} or \ProgName{makeindex} as and when it notices that those -programs' input (parts of the \extension{aux} file, or the -\extension{idx} file, respectively) has changed, and so on. -\ProgName{Latexmk} is a fine -solution (and was used in generating printable versions of these -\acro{FAQ}s for a long time); it has recently been upgraded and has -many bells and whistles that allow it to operate as if it were a poor -man's \WYSIWYG{} system. - -Apparently along the same lines, and currently (2007) under active -development, is Auto\LaTeX{}. The \File{README} of the distribution is -actual a Unix-type man-page output, and shows great attention to the -details of the document production process. - -Windows users of the \miktex{} system may use that systems -\ProgName{texify} application. \ProgName{Texify} deals with basic -\LaTeX{} features, including generating a bibliography and an index; -it makes no claim to deal with other things (such as multiple -bibliographies or indexes, or lists of terminology, etc.), which -Auto\LaTeX{} can be configured to process. - -The \Qref*{\Package{texinfo} system}{Q-texinfo} comes with a similar -utility called \ProgName{texi2dvi}, which is capable of ``converting'' -either \LaTeX{} or \Package{texinfo} files into \acro{DVI} (or into -\acro{PDF}, using \PDFTeX{}). - -A later contribution is the bundle \Package{latexmake}, which -offers a set of \ProgName{make} rules that invoke \ProgName{texi2dvi} -as necessary. - -The curious may examine the rules employed to run the present -\acro{FAQ} through \LaTeX{}: we don't present them as a complete -solution, but some of the tricks employed are surely re-usable. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}AutoLaTeX]\CTANref{autolatex} -\item[\nothtml{\rmfamily}\acro{FAQ} distribution]\CTANref{faq} -\item[\nothtml{\rmfamily}latexmake]\CTANref{latexmake} -\item[latexmk]\CTANref{latexmk} -\item[texi2dvi]Distributed as part of \CTANref{texinfo} -\end{ctanrefs} - -\Question[Q-howmanypp]{How many pages are there in my document?} - -Simple documents (those that start at page 1, and don't have any -breaks in their page numbering until their last page) present no -problem to the seeker after this truth. The number of pages is -reported by the \Package{lastpage} package in its \texttt{LastPage} label. - -For more complicated documents (most obviously, books with frontmatter -in a different series of page numbers) this simple approach will not -do. - -The \Package{count1to} package defines a label \texttt{TotalPages}; this is -the value of its copy of \csx{count1} (a reserved \TeX{} count -register) at the end of the document. - -Package \Package{totpages} defines a label \texttt{TotPages}, but it also -makes the register it uses available as a \LaTeX{} counter, -\texttt{TotPages}, which you can also reference via \csx{theTotPages}. Of -course, the counter |TotPages| is asynchronous in the same way that -page numbers are, but snapshots may safely be taken in the output -routine. - -The \Class{memoir} class defines two counters \texttt{lastpage} and -\texttt{lastsheet}, which are set (after the first run of a document) -to the equivalent of the \texttt{LastPage} label and the -\texttt{TotalPages} labels. - -Both \Package{count1to} and \Package{totpages} need the support of -the \Package{everyshi} package. -\begin{ctanrefs} -\item[count1to.sty \nothtml{\bgroup\rmfamily}and\nothtml{\egroup} everyshi.sty]% line break!! - Distributed in \CTANref{ms} -\item[lastpage.sty]\CTANref{lastpage} -\item[memoir.cls]\CTANref{memoir} -\item[totpages.sty]\CTANref{totpages} -\end{ctanrefs} - -\Question[Q-inclplain]{Including \plaintex{} files in \LaTeX{}} - -\LaTeX{}, though originally \Qref*{based on \plaintex{}}{Q-LaTeXandPlain}, does not -contain all of \plaintex{}'s commands. Worse, some \plaintex{} -command names appear in \LaTeX{}, with different semantics. As a -result, special measures need to be taken to allow general \plaintex{} -documents (or parts of documents) to be typeset within \LaTeX{}. - -The truly reliable way is to translate the \plaintex{} commands, to -produce an equivalent of the original's semantics. However, this is -not practical in many circumstances, and for those occasions, the -\Package{plain} package will often come to your aid. The package -defines a \environment{plain} environment, in which a \plaintex{} -document may be processed: -\begin{quote} -\begin{verbatim} -\begin{plain} - \input{plain-doc} -\end{plain} -\end{verbatim} -\end{quote} -The package is known to fail, for example, with documents that use -\AMSTeX{}; no doubt it would also fail if asked to load \Eplain{}. -All these things can be overcome (although it's not often easy), but -the environment saves a lot of work on many occasions. -\begin{ctanrefs} -\item[plain.sty]Distributed as part of \CTANref{carlisle} -\end{ctanrefs} - -\subsection{Hyphenation} - -\Question[Q-nohyph]{My words aren't being hyphenated} - -Let's assume you've selected the right \TeX{} `language'~--- as -explained in \Qref[question]{``how hyphenation works''}{Q-hyphen}, -you're not likely to get the correct results typesetting one language -using the hyphenation rules of another. (Select the proper language, -using \Package{babel} if you're a \LaTeX{} user. This may reveal that -you need another set of hyphenation patterns; see -% beware line wrap -\Qref[question]{``using a new language''}{Q-newlang} for advice on how -to install it.) - -So what else can go wrong? -\begin{itemize} -\item Since \TeX{} version~3.0, the limits on how near to either end - of a word hyphenation may take place have been programmable (see - \Qref[question]{``weird hyphenation''}{Q-weirdhyphen}), and for some - reason the values in question may have been corrupted in some macros - you are using. \TeX{} won't hyphenate less than \csx{lefthyphenmin} - characters after the start of a word, nor less than - \csx{righthyphenmin} before the end of a word; thus it won't - hyphenate a word shorter than the sum of the two minima, at all. - For example, since the minima are 2 and 3 for English, \TeX{} won't - hyphenate a word shorter than 5 letters long, if it believes the - word to be English. -\item \TeX{} won't hyphenate a word that's already been hyphenated. - For example, the (caricature) English surname Smyth-Postlethwaite - wouldn't hyphenate, which could be troublesome. This is correct - English typesetting style (it may not be correct for other - languages), but if needs must, you can replace the hyphen in the - name with a \csx{hyph} command, defined -\begin{quote} -\begin{verbatim} -\def\hyph{-\penalty0\hskip0pt\relax} -\end{verbatim} -\end{quote} - This is \emph{not} the sort of thing this \acro{FAQ} would - ordinarily recommend\dots{} The \Package{hyphenat} package defines a - bundle of such commands (for introducing hyphenation points at - various punctuation characters). -\item There may be accents in the word. The causes of and remedies - for this effect are discussed in - % beware line break - \Qref[question]{accents and hyphens}{Q-hyphenaccents}. -\item The hyphenation may simply not have been spotted; while \TeX{}'s - algorithm is good, it's not infallible, and it does miss perfectly - good hyphenations in some languages. When this happens, you need to - give \TeX{} \emph{explicit} instructions on how to hyphenate. -\end{itemize} -The \csx{hyphenation} command allows you to give explicit instructions. -Provided that the word will hyphenate at all (that is, it is not -prevented from hyphenating by any of the other restrictions above), -the command will override anything the hyphenation patterns might -dictate. The command takes one or more hyphenated words as -argument~--- \cmdinvoke{hyphenation}{ana-lysis pot-able}; note that -(as here, for analysis) you can use the command to overrule \TeX{}'s -choice of hyphenation (ana-lysis is the British etymological -hyphenation; some feel the American hyphenation feels -`unfortunate'\dots{}). -\begin{ctanrefs} -\item[hyphenat.sty]\CTANref{hyphenat} -\end{ctanrefs} - -\Question[Q-weirdhyphen]{Weird hyphenation of words} - -If your words are being h-yphenated, like this, with jus-t single -letters at the -beginning or the end of the word, you may have a version mismatch -problem. \TeX{}'s hyphenation system changed between version~2.9 -and~3.0, and macros written for use with version~2.9 can have this -effect with a version~3.0 system. If you are using \plaintex{}, make -sure your \File{plain.tex} file has a version number which is at -least~3.0, and rebuild your format. If you are using \LaTeXo{} your -best plan is to upgrade to \LaTeXe{}. If for some reason you can't, -the last version of \LaTeXo{} (released on 25 March 1992) is still -available (for the time being at least) and ought to solve this -problem. - -If you're using \LaTeXe{}, the problem probably arises from your -|hyphen.cfg| file, which has to be created if you're using a -multi-lingual version. - -A further source of oddity can derive from the 1995 release of -\Qref*{Cork-encoded fonts}{Q-ECfonts}, -which introduced an alternative hyphen character. The \LaTeXe{} -configuration files in the font release specified use of the -alternative hyphen, and this could produce odd effects with words -containing an explicit hyphen. The font configuration files in the -December 1995 release of \LaTeXe{} do \emph{not} use the alternative -hyphen character, and therefore removed this source of problems; the -solution, again, is to upgrade your \LaTeX{}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\LaTeXo{}]\CTANref{latex209-base} -\item[plain.tex]\CTANref{plain} -\end{ctanrefs} - -\Question[Q-oddhyphen]{(Merely) peculiar hyphenation} - -You may have found that \TeX{}'s famed automatic word-division does -not produce the break-points recommended by your dictionary. This may be -because \TeX{} is set up for American English, whose rules for word -division (as specified, for example, in Webster's Dictionary) are -completely different from the British ones (as specified, for example, -in the Oxford Dictionaries). This problem is being addressed by the \acro{UK} -\TeX{} User community (see \BV{}, issue~4.4) but an entirely -satisfactory solution will take time; the current status is to be -found on \acro{CTAN} (see -% beware line-wrap -\Qref[question]{``using a new language''}{Q-newlang} for instructions -on adding this new ``language''). -\begin{ctanrefs} -\item[UK patterns]\CTANref{ukhyph} -\end{ctanrefs} - -\Question[Q-hyphenaccents]{Accented words aren't hyphenated} - -\TeX{}'s algorithm for hyphenation gives up when it encounters an -\csx{accent} command; there are good reasons for this, but it means -that quality typesetting in non-English languages can be difficult. - -For \TeX{} macro packages, you can avoiding the effect by using an -appropriately encoded font (for example, a Cork-encoded font~--- see -\Qref[question]{the \acro{EC} fonts}{Q-ECfonts}) which contains accented -letters as single glyphs. \LaTeX{} users can achieve this end simply -by adding the command -\begin{verbatim} - \usepackage[T1]{fontenc} -\end{verbatim} -to the preamble of their document. Other encodings (notably -\acro{LY}1, once promoted by \YandY{} inc) may be used -in place of \acro{T}1. Indeed, most current 8-bit \TeX{} font -encodings will `work' with the relevant sets of hyphenation patterns. - -One might hope that, with the many aspirant successors to \TeX{} such -as -\begin{wideversion} - \Qref{Omega}{Q-omegaleph}, \Qref{\LuaTeX{}}{Q-luatex} and - \Qref{Ex\TeX{}}{Q-extex}, -\end{wideversion} -\begin{narrowversion} - Omega, \LuaTeX{} and Ex\TeX{} - (\Qref[see questions]{}{Q-omegaleph}\Qref[,]{}{Q-luatex} - \Qref[and]{}{Q-extex}), -\end{narrowversion} -all of which base their operations on Unicode, that the whole basis of -encodings will change. - -\Question[Q-newlang]{Using a new language with Babel} - -\Package{Babel} is capable of working with a large range of -languages, and a new user often wants to use a language that her -\TeX{} installation is not set up to employ. Simply asking Babel to -use the language, with the command -\begin{verbatim} - \usepackage[catalan]{babel} -\end{verbatim} -provokes the warning message -\begin{wideversion} -\begin{verbatim} -Package babel Warning: No hyphenation patterns were loaded for -(babel) the language `Catalan' -(babel) I will use the patterns loaded for \language=0 instead. -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -Package babel Warning: No hyphenation patterns - were loaded for -(babel) the language `Catalan' -(babel) I will use the patterns - loaded for \language=0 instead. -\end{verbatim} -(The first and third lines above have been wrapped to fit in the -column.) -\end{narrowversion} - -The problem is that your \TeX{} system doesn't know how to hyphenate -Catalan text: you need to tell it how before Babel can do its work -properly. To do this, for \LaTeX{} installations, one needs to change -\File{language.dat} (which is part of the Babel installation); it will -contain a line -\begin{verbatim} -%catalan cahyphen.tex -\end{verbatim} -which, if you remove the comment marker, is supposed to instruct -\LaTeX{} to load Catalan hyphenation patterns when you tell it to build -a new format. - -Unfortunately, in many Babel distributions, the line just isn't -right~--- you need to check the name of the file containing the -patterns you're going to use. As you can see, in the author's system, -the name is supposed to be \File{cahyphen.tex}; however the file -actually present on the system is \File{cahyph.tex}~--- fortunately, -the error should prove little more than an inconvenience (most of the -files are in better distributions anyway, but an elusive one -may be found on \acro{CTAN}; if you have to retrieve -a new file, ensure that it's correctly installed, for which see -\Qref[question]{installing a new package}{Q-inst-wlcf}). - -Finally, you need to regenerate the formats used (in fact, most users -of Babel are using it in their \LaTeX{} documents, so regenerating the -\LaTeX{}-related formats will ordinarily be enough; however, the -author always generates the lot, regardless). -\begin{description} -\item[te\TeX{}]It's possible to do the whole operation in one go, by - using the \ProgName{texconfig} command: -\begin{verbatim} -texconfig hyphen latex -\end{verbatim} - which first enters an editor for you to edit \File{language.dat}, - and then regenerates the format you specify (\ProgName{latex} in - this case). - - Otherwise, to regenerate all formats, do: \\ - \texttt{fmtutil -\relax-all} - - If you're willing to think through what you're doing (this is - \emph{not} for the faint-hearted), you can select a sequence of - formats and for each one, run: \\ - \texttt{fmtutil -\relax-byfmt \meta{formatname}}\\ - where \emph{\texttt{formatname}} is something like `\texttt{latex}', - or: \\ - \texttt{fmtutil -\relax-byhyphen \meta{hyphenfile}}\\ - where \emph{\texttt{hyphenfile}} is the file specifying hyphenation - to the format~--- usually \texttt{language.dat} -\item[\miktex{}] On a \Package{\miktex{}} distribution earlier than v2.0, do: \\ - \texttt{Start}\arrowhyph{}% - \texttt{Programs}\arrowhyph{}% - \texttt{\miktex{}}\arrowhyph{}% - \texttt{Maintenance}\arrowhyph{}% - \texttt{Create all format files} -% this sequence suggested for miktex 1.20e, 2000/12/22, by Giuseppe Bilotta - - or get a DOS window and run:\\ - \texttt{initexmf -\relax-dump} - - On a \Package{\miktex{}} distribution v2.0 or later, the whole - procedure can be done via the \acro{GUI}. To select the new - language, do:\\ - \texttt{Start}\arrowhyph{}% - \texttt{Programs}\arrowhyph{}% - \texttt{\miktex{} 2}\arrowhyph{}% - \texttt{\miktex{} Options}, and select the \texttt{Languages} tab. - Select your language from the list, press the \texttt{Apply} button, - and then the \texttt{OK} button. Then select the \texttt{General} - tab and press the \texttt{Update Now} button. - - Otherwise, edit the \File{language.dat} file (as outlined above), - and then run:\\ - \texttt{initexmf -\relax-dump}\\ - just as for a pre-v2.0 system. -\end{description} - -\nothtml{\noindent}\textbf{\emph{Caveat}:} It is (just) possible that -your \TeX{} system may run out of ``pattern memory'' while generating -the new format. Most \TeX{} implementations have fixed-size arrays -for storing the details of hyphenation patterns, but although their -size is adjustable in most modern distributions, actually changing the -size is a fiddle. If you \emph{do} find you've run out of memory, -it may be worth scanning the list of languages in your -\File{language.dat} to see whether any could reasonably be removed. -\begin{ctanrefs} -\item[babel]\CTANref{babel} -\item[hyphenation patterns]\CTANref{hyphenation} -\end{ctanrefs} - -\Question[Q-hyphoff]{Stopping all hyphenation} - -It may seem an odd thing to want to do (after all, one of \TeX{}'s -great advertised virtues is the quality of its hyphenation) but it's -sometimes necessary. The real problem is, that the quality of -\TeX{}'s output is by default largely dependent on the presence of -hyphenation; if you want to abandon hyphenation, something has to -give. - -\TeX{} (slightly confusingly) offers four possible mechanisms for -suppressing hyphenation (there were only two prior to the extensions -that arrived with \TeX{} version~3). - -First, one can set the hyphenation penalties \csx{hyphenpenalty} and -\csx{exhyphenpenalty} to an `infinite' value (that is to say, 10000). -This means that all hyphenations will sufficiently penalise the line -that would contain them, that the hyphenation won't happen. The -disadvantage of this method is that \TeX{} will re-evaluate any -paragraph for which hyphenations might help, which will slow \TeX{} -down. - -Second, one can select a language for which no hyphenation patterns -exist. Some distributions create a language \texttt{nohyphenation}, -and the \Package{hyphenat} package uses this technique for its -\csx{nohyphens} command which sets its argument without any -hyphenation. You can load \Package{hyphenat} with the command -\begin{quote} - \cmdinvoke{usepckage}[none]{hyphenat} -\end{quote} -to prevent any hyphenation in a single-language document. The -technique cannot work in a document in which \Package{babel} controls -language selection, since \Package{babel} incorporates hyphenation -change into its language change facilities. - -Third, one can set \csx{left-} and/or \csx{righthyphenmin} to a -sufficiently large value that no hyphenation could possibly succeed, -since the minimum is larger than the length of the longest word -\TeX{} is willing to hyphenate (the appropriate value is 62). - -Fourth, one can suppress hyphenation for all text using the current -font by the command -\begin{quote} -\begin{verbatim} -\hyphenchar\font=-1 -\end{verbatim} -\end{quote} -This isn't a particularly practical way for users to suppress -hyphenation~--- the command has to be issued for every font the -document uses~--- but it's how \LaTeX{} itself suppresses hyphenation -in \texttt{tt} and other fixed-width fonts. - -Which of the techniques you should use depends on what you actually -want to do. If the text whose hyphenation is to be suppressed runs -for less than a paragraph, your only choice is the no-hyphens -language: the language value is preserved along with the text (in the -same way that the current font is); the values for penalties and -hyphen minima active at the end of a paragraph are used when -hyphenation is calculated. - -Contrariwise, if you are writing a multilanguage document using the -\Package{babel} package, you \emph{cannot} suppress hyphenation -throughout using either the no-hyphens language or the hyphen minima: -all those values get changed at a \Package{babel} language switch: use -the penalties instead. - -If you simply switch off hyphenation for a good bit of text, the -output will have a jagged edge (with many lines seriously overfull), -and your \AllTeX{} run will bombard you with warnings about overfull -and underfull lines. To avoid this you have two options. - -The simplest route is to use \csx{sloppy} (or its environment version -\environment{sloppypar}), and have \TeX{} stretch what would otherwise -be underfull lines to fill the space offered, while prematurely -wrapping overfull lines and stretching the remainder. - -Alternatively, you may set the text \Qref*{ragged right}{Q-ragright}, -and at least get rid of the overfull lines; this technique is -`traditional' (in the sense that typists do it) and may be expected to -appeal to the specifiers of eccentric document layouts (such as those -for dissertations), but for once their sense conforms with typographic -style. (Or at least, style constrained in this curious way.) -\begin{ctanrefs} -\item[hyphenat.sty]\CTANref{hyphenat} -\end{ctanrefs} - -\Question[Q-wdnohyph]{Preventing hyphenation of a particular word} - -It's quite possible for (\emph{any}) hyphenation of a particular word -to seem ``completely wrong'', so that you want to prevent it being -hyphenated. - -If the word occurs in just one place, put it in a box: -\begin{quote} -\begin{verbatim} -\mbox{oddword} -\end{verbatim} -\end{quote} -(\plaintex{} users should use \csx{hbox}, and take care at the start -of paragraphs.) However, boxing the word is not really advisable -unless you are sure it only occurs once. - -If the word occurs commonly, the best choice is to assert a -non-hyphenation for it: -\begin{quote} -\begin{verbatim} -\hyphenation{oddword} -\end{verbatim} -\end{quote} -This hyphenation exception (with no break points) will be used in -preference to what \TeX{}'s hyphenation algorithm may come up with. - -In a multilingual document, repeat the exception specification for -each language the word may appear in. So: -\begin{quote} -\begin{verbatim} -\usepackage[french,english]{babel} -\selectlanguage{english} -\hyphenation{oddword} -\selectlanguage{french} -\hyphenation{oddword} -\end{verbatim} -\end{quote} -(note that \Package{babel} will select the default language for the -document~--- English, in this case~--- at \cmdinvoke{begin}{document}.) - -A particular instance of this requirement is avoiding the hyphenation -of acronyms; a general rule for those that concoct acronyms seems to -be to make the capital-letter sequence read as near as is possible -like a ``real'' word, but hyphenating an acronym often looks silly. -The \TeX{} flag \csx{uchyph} is designed for suppressing such -behaviour: -\begin{quote} -\begin{verbatim} -\uchyph=0 -\end{verbatim} -\end{quote} -will stop hyphenation of upper-case words. (Note that \plaintex{} -syntax is needed here: there's no \LaTeX{} alternative for setting -this value.) - -\Question[Q-hyphexcept]{Hyphenation exceptions} - -While \TeX{}'s hyphenation rules are good, they're not infallible: you -will occasionally find words \TeX{} just gets \emph{wrong}. So for -example, \TeX{}'s default hyphenation rules (for American English) don't -know the word ``\emph{manuscript}'', and since it's a long word you -may find you need to hyphenate it. You \emph{can} ``write the -hyphenation out'' each time you use the word: -\begin{quote} -\begin{verbatim} -... man\-u\-script ... -\end{verbatim} -\end{quote} -Here, each of the \csx{-} commands is converted to a hyphenated break, -if (\emph{and only if}) necessary. - -That technique can rapidly become tedious: you'll probably only accept -it if there are no more than one or two wrongly-hyphenated words in -your document. The alternative is to set up hyphenations in the -document preamble. To do that, for the hyphenation above, you would -write: -\begin{quote} -\begin{verbatim} -\hyphenation{man-u-script} -\end{verbatim} -\end{quote} -and the hyphenation would be set for the whole document. Barbara -Beeton publishes articles containing lists of these ``hyphenation -exceptions'', in \textsl{TUGboat}; the hyphenation `man-u-script' -comes from one of those articles. - -What if you have more than one language in your document? Simple: -select the appropriate language, and do the same as above: -\begin{quote} -\begin{verbatim} -\usepackage[french]{babel} -\selectlanguage{french} -\hyphenation{re-cher-cher} -\end{verbatim} -\end{quote} -(nothing clever here: this is the ``correct'' hyphenation of the word, -in the current tables). However, there's a problem here: just as -words with accents in them won't break, so \csx{hyphenation} commands -with accents in them produce an error: -\begin{quote} -\begin{verbatim} -\usepackage[french]{babel} -\selectlanguage{french} -\hyphenation{r\'e-f\'e-rence} -\end{verbatim} -\end{quote} -tells us that the hyphenation is ``improper'', and that it will be ``flushed''. -But, just as hyphenation of words is enabled by selecting an 8-bit -font encoding, so \csx{hyphenation} commands are rendered proper again -by selecting that same 8-bit font encoding. For the hyphenation -patterns provided in the usual distributions, the encoding is -\Qref*{Cork}{Q-ECfonts}, so the complete sequence is: -\begin{quote} -\begin{verbatim} -\usepackage[T1]{fontenc} -\usepackage[french]{babel} -\selectlanguage{french} -\hyphenation{r\'e-f\'e-rence} -\end{verbatim} -\end{quote} - -The same sort of performance goes for any language for which 8-bit -fonts and corresponding hyphenation patterns are available. Since you -have to select both the language and the font encoding to have your -document typeset correctly, it should not be a great imposition to do -the selections before setting up hyphenation exceptions. - -\subsection{Odds and ends} - -\Question[Q-logos]{Typesetting all those \TeX{}-related logos} - -Knuth was making a particular point about the capabilities of \TeX{} -when he defined the logo. Unfortunately, many believe, he thereby -opened floodgates to give the world a whole range of rather silly -`bumpy road' logos for \TeX{} entities such as \AMSTeX{}, \PiCTeX{}, -\BibTeX{}, and so on, produced in a flurry of different fonts, sizes, -and baselines~--- indeed, everything one might hope to cause them to -obstruct the reading process. In particular, Lamport invented -\LaTeX{} (silly enough in itself, with a raised small `A' and a -lowered `E') and marketing input from Addison-Wesley led to the even -stranger current logo for \LaTeXe{}, which appends a lowered % !line break -\latexhtml{\ensuremath{\varepsilon}}{single-stroke Greek letter ε}. - -Sensible users don't have to follow this stuff wherever it goes, -but, for those who insist, a large collection of logos is defined in -the \Package{texnames} package (but note that this set of macros isn't -entirely reliable in \LaTeXe{}). -The \MF{} and \MP{} logos can be set in fonts that \LaTeXe{} -knows about (so that they scale with the surrounding text) using the -\Package{mflogo} package; but be aware that booby-traps surround the -use of the Knuthian font for \MP{} (you might get -\htmlignore -\textlogo{META\hphantom{P}O\hphantom{S}T}). -\endhtmlignore -% the following htmlversion stuff seems to do roughly what's required, -% which is nice, given the feebleness of representing all these silly -% logos in html otherwise... -\begin{htmlversion} - something like `META\ \ O\ \ T'). -\end{htmlversion} -You needn't despair, however~--- most versions of the logo font -distributed nowadays contain the missing letters, and the author -himself uses just `MetaPost'. - -For those who don't wish to acquire the `proper' logos, the canonical -thing to do is to say \texttt{AMS-}\cmdinvoke{TeX}{} -for \AMSTeX{}, \texttt{Pic}\cmdinvoke{TeX}{} -for \PiCTeX{}, \texttt{Bib}\cmdinvoke{TeX}{} -for \BibTeX{}, and so on. -\begin{ctanrefs} -\item[mflogo.sty]\CTANref{mflogo} -\item[texnames.sty]\CTANref{texnames} -\end{ctanrefs} - -\Question[Q-bold-extras]{How to do bold-tt or bold-sc} - -\LaTeX{}, as delivered, offers no means of handling bold ``teletype'' -or small-caps fonts. There's a practical reason for this (Knuth never -designed such fonts), but there are typographical considerations too -(the ``medium weight'' \texttt{cmtt} font is already pretty bold (by -comparison with other fixed-width fonts), and bold small-caps is not -popular with many professional typographers). - -There's a set of ``extra'' \MF{} files on \acro{CTAN} that provide bold -versions of both \texttt{cmtt} and \texttt{cmcsc} (the small caps font). With -modern \TeX{} distributions, one may bring these fonts into use simply -by placing them in an % ! line break -\Qref*{appropriate place in the \emph{texmf} tree}{Q-install-where} -(these are \AllTeX{}-specific files, so the ``\emph{public}'' supplier -would be an appropriate place). Once you've % ! line break, again -\Qref*{rebuilt the file indexes as necessary}{Q-inst-wlcf}, -\TeX{} (and friends) will automatically build whatever font files they -need when you first make reference to them. There's a jiffy package -\Package{bold-extra} that builds the necessary font data structures -so that you can use the fonts within \LaTeX{}. - -Another alternative is to use the \Qref*{\acro{EC} fonts}{Q-ECfonts}, -which come with bold variants of the small-caps fonts. - -If you need to use Type~1 fonts, you can't proceed with Knuth-style -fonts, since there are no Type~1 versions of the \Package{mf-extra} -set. There are, however, Type~1 distributions of the EC~fonts, so you -can switch to EC and use them; alternatives are discussed in -\Qref[question]{8-bit Type~1 fonts}{Q-type1T1}. - -Of course, commercial fixed-width fonts (even the default -\FontName{Courier}) almost always come with a bold variant, so that's -not a problem. Furthermore \Qref*{\acro{PSNFSS}}{Q-usepsfont} -will usually provide ``faked'' small caps fonts, and has no -compunctions about providing them in a bold form. \FontName{Courier} -is (as we all know, to our cost) freely available; a far more -presentable monospace font is \FontName{LuxiMono}, which is also -freely available (monospace text in the typeset version of this -\acro{FAQ} uses \FontName{LuxiMono}, with the metrics and \LaTeX{} -support available on the archive. -\begin{ctanrefs} -\item[bold-extra.sty]\CTANref{bold-extra} -\item[bold tt and small caps fonts]\CTANref{bold} -\item[\nothtml{\rmfamily}LuxiMono fonts]\CTANref{luximono} -\end{ctanrefs} - -\Question[Q-varwidth]{Automatic sizing of \environment{minipage}} - -The \environment{minipage} environment requires you to specify the -width of the ``page'' you're going to create. This is sometimes -inconvenient: you would like to occupy less space, if possible, but -\environment{minipage} sets a box that is exactly the width you -specified. - -The \Package{pbox} package defines a \csx{pbox} whose width is exactly -that of the longest enclosed line, subject to a maximum width that you -give it. So while \cmdinvoke{parbox}{2cm}{Hello\bsbs world!} produces a -box of width exactly \texttt{2cm}, -\cmdinvoke{pbox}{2cm}{Hello\bsbs world!} produces one whose width is -\texttt{1.79cm} (if one's using the default \FontName{cmr} font for the -text, at least). The package also provides a -\cmdinvoke*{settominwidth}[min]{length}{text} (which looks (almost) -like the standard \csx{settowidth} command), and a \csx{widthofpbox} -function analogous to the \csx{widthof} command for use with the -\Package{calc} package. - -The \Package{eqparbox} package extends \Package{pbox}'s idea, by -allowing you to set a series of boxes, all with the same (minimised) -width. (Note that it doesn't accept a limiting maximum width -parameter.) The package documentation shows the following example -drawn from a joke \emph{curriculum vitae}: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\noindent% -\eqparbox{place}% - {\textbf{Widgets, Inc.}} - \hfill -\eqparbox{title}% - {\textbf{Senior Widget Designer}} - \hfill -\eqparbox{dates}{\textbf{1/95--present}} - -... - -\noindent% -\eqparbox{place}% - {\textbf{Thingamabobs, Ltd.}} - \hfill -\eqparbox{title}% - {\textbf{Lead Engineer}} - \hfill -\eqparbox{dates}{\textbf{9/92--12/94}} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\noindent% -\eqparbox{place}{\textbf{Widgets, Inc.}} \hfill -\eqparbox{title}{\textbf{Senior Widget Designer}} \hfill -\eqparbox{dates}{\textbf{1/95--present}} - -... - -\noindent% -\eqparbox{place}{\textbf{Thingamabobs, Ltd.}} \hfill -\eqparbox{title}{\textbf{Lead Engineer}} \hfill -\eqparbox{dates}{\textbf{9/92--12/94}} -\end{verbatim} -\end{wideversion} -\end{quote} -The code makes the three items on each of the heading lines have -exactly the same width, so that the lines as a whole produce a regular -pattern down the page. A command \csx{eqboxwidth} allows you to use -the measured width of a group: the documentation shows how the command -may be used to produce sensible-looking columns that mix \texttt{c}-, -\texttt{r}- or \texttt{l}-rows, with the equivalent of a |p{...}| -entry, by making the fixed-width rows an \Package{eqparbox} group, and -making the last from a \csx{parbox} using the width that's been -measured for the group. - -The \Package{varwidth} package defines a \environment{varwidth} -environment which sets the content of the box to match a ``narrower -natural width'' if it finds one. (You give it the same parameters as -you would give \environment{minipage}: in effect, it is a `drop-in' -replacement.) \Package{Varwidth} provides its own ragged text command: -\csx{narrowragged}, which aims to make narrower lines and to put more -text in the last line of the paragraph (thus producing lines with more -nearly equal lengths than typically happens with \csx{raggedright} -itself). - -The documentation (in the package file) lists various restrictions and -things still to be done, but the package is already proving useful for -a variety of jobs. -\begin{ctanrefs} -\item[eqparbox.sty]\CTANref{eqparbox} -\item[pbox.sty]\CTANref{pbox} -\item[varwidth.sty]\CTANref{varwidth} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Symbols, etc.} - -\Question[Q-usesymb]{Using symbols} - -Most symbol font sets come with a package that defines commands for -every symbol in the font. While this is convenient, it can lead to -difficulties, particularly with name clashes when you load packages -that cover fonts which duplicate symbols~--- an issue which is -discussed in -\begin{narrowversion} - \Qref[question]{}{Q-alreadydef}. -\end{narrowversion} -\begin{wideversion} - ``\Qref{symbol already defined}{Q-alreadydef}''. -\end{wideversion} -Some font sets (for example, \FontName{MnSymbol}) are huge, and the -accompanying macros cover so many symbols that name clashes are surely -a serious problem. - -The \Package{pifont} package (originally designed to use the Adobe -\FontName{Zapf Dingbats} font) avoids this sort of problem: it requires -you to know the font position of any symbol you want to use (the -documentation provides font tables). The basic command is -\cmdinvoke*{ding}{number} for a single symbol; there are commands for -other fancier uses. \Package{Pifont} also allows you to select other -fonts, for similar use. - -The \Package{yagusylo} describes itself as ``an extended version of -\Package{pifont}, gone technicolor''. It provides all the facilities -of \Package{pifont}, but allows you to create your own mnemonic names -for symbols. Thus, while you can say % ! line break -\cmdinvoke*{yagding}[family]{symbol number}[colour], you can also -define symbol names with \csx{defdingname}, and then use them -with \cmdinvoke*{yagding*}{symbol name} (the defined name carries the -font family and colour specified in the arguments of -\csx{defdingname}). - -\Package{Yagusylo} is somewhat complicated, but its documentation is -clear; it is probably the best tool to use for picking and choosing -symbols from a variety of font families. -\begin{ctanrefs} -\item[mnsymbol \nothtml{\rmfamily}fonts]\CTANref{mnsymbol} -\item[pifont.sty]Distributed as part of \CTANref{psnfss} -\item[yagusylo.sty]\CTANref{yagusylo} -\end{ctanrefs} - -\Question[Q-numbersets]{Symbols for the number sets} - -Mathematicians commonly use special lettering for the real numbers and -other standard number sets. Traditionally these were typeset in bold. -Because, in the ordinary course of events, mathematicians do not have -access to bold chalk, they invented special symbols that are now -often used for the number sets; these symbols are known as -``blackboard bold'' (or double-stroked fonts); in place of the heavier -strokes of a bold font, (some) strokes of the letters are doubled. -The minimum useful set is upper-case letters `I', `N', `R', `Q' and -`Z'; some fonts offer a figure `1' (for a unit matrix~--- not a number -set at all). - -A set of blackboard bold capitals is available in the \acro{AMS} -\FontName{msbm} fonts (\FontName{msbm} is available at a range of -design sizes, with names such as \FontName{msbm10}). The pair of font -families (the other is called \FontName{msam}) have a large number of -mathematical symbols to supplement those provided in the Knuth's -original \TeX{} distribution, and are available in Type~1 format in -modern distributions. Support files for using the fonts, both under -\plaintex{} and \LaTeX{} (packages \Package{amssymb} and -\Package{amsfonts}), are available. The font shape is a rather -austere sans, which many people don't like (though it captures the -essence of quickly-chalked writing rather well). - -The \FontName{bbold} family is set of blackboard bold fonts written in -\MF{}. This set offers blackboard bold forms of lower-case letters; -the font source directory also contains sources for a \LaTeX{} package -that enables use of the fonts. The fonts are not available in Type~1 format. - -The \FontName{bbm} family claims to provide -`blackboard' versions of most of the \FontName{cm} fonts~\dots{} including -the bold and bold-extended series. Again, the fonts are designed in -\MF{} and are not available in Type~1 format. \LaTeX{} macro support -comes from a package by Torsten Hilbrich. - -The \FontName{doublestroke} family comes in just roman -and sans shapes, at a single weight, and is available both as \MF{} -sources and as Type~1; the font covers the uppercase latin letters, -lowercase `h' and 'k', and the digit `1'. - -A document that shows the \FontName{bbm}, \FontName{bbold}, -\FontName{doublestroke} and \FontName{msbm} fonts, so that you can get -a feel for their appearance, is available (\acro{CTAN} package -\Package{blackboard}). - -An alternative source of Type~1 fonts with blackboard bold characters -may be found in the steadily increasing set of complete families, both -commercial and free, that have been prepared for use with \AllTeX{} -(see % beware line break -\htmlonly{``}\Qref[question]{choice of outline fonts}{Q-psfchoice}\htmlonly{''}). -Of the free sets, the \FontName{txfonts} and \FontName{pxfonts} families -both come with replicas of \FontName{msam} and \FontName{msbm} -(though, as noted elsewhere, there are other reasons not to use these -fonts). The \FontName{mathpazo} family includes a ``mathematically -significant'' choice of blackboard bold characters, and the -\FontName{fourier} fonts contain blackboard bold upper-case letters, -the digit `1', and lower-case `k'. - -The ``lazy person's'' blackboard bold macros: -\begin{quote} -\begin{verbatim} -\newcommand{\R}{{\textsf{R}\hspace*{-0.9ex}% - \rule{0.15ex}{1.5ex}\hspace*{0.9ex}}} -\newcommand{\N}{{\textsf{N}\hspace*{-1.0ex}% - \rule{0.15ex}{1.3ex}\hspace*{1.0ex}}} -\newcommand{\Q}{{\textsf{Q}\hspace*{-1.1ex}% - \rule{0.15ex}{1.5ex}\hspace*{1.1ex}}} -\newcommand{\C}{{\textsf{C}\hspace*{-0.9ex}% - \rule{0.15ex}{1.3ex}\hspace*{0.9ex}}} -\end{verbatim} -\end{quote} -are almost acceptable at normal size if the surrounding text is -\FontName{cmr10} (the position of the vertical bar can be affected by -the surrounding font). However, they are not part of a proper maths font, -and do not work in sub- and superscripts. As we've seen, there are -plenty of alternatives: that mythical ``lazy'' person can inevitably -do better than the macros, or anything similar using capital `I' -(which looks even worse!). Voluntary \AllTeX{} effort has redefined -the meaning of laziness (in this respect!). -\begin{ctanrefs} -\item[AMS support files (Plain)]\CTANref{amsfonts-plain} -\item[AMS support files (LaTeX)]\CTANref{amsfonts-latex} -\item[AMS symbol fonts]\CTANref{amsfonts-symbols} -\item[AMS symbol fonts in Type~1 format]Browse \CTANref{ams-AMStype1} -\item[bbm fonts]\CTANref{bbm} -\item[bbm macros]\CTANref{bbm-macros} -\item[bbold fonts]\CTANref{bbold} -\item[blackboard \nothtml{\rmfamily}evaluation set]\CTANref{blackboard} -\item[doublestroke fonts]\CTANref{doublestroke} -\item[fourier fonts]\CTANref{fourier} -\item[mathpazo fonts]\CTANref{mathpazo} -\item[pxfonts]\CTANref{pxfonts} -\item[txfonts]\CTANref{txfonts} -\end{ctanrefs} - -\Question[Q-scriptfonts]{Better script fonts for maths} - -The font selected by \csx{mathcal} is the only script font `built -in'. However, there are other useful calligraphic fonts included with -modern \TeX{} distributions. -\begin{description} -\item[Euler] The \Package{eucal} package (part of most sensible \TeX{} - distributions; the fonts are part of the \acro{AMS} font set) gives - a slightly curlier font than the default. The package changes the - font that is selected by \csx{mathcal}. - - Type 1 versions of the fonts are available in the \acro{AMS} fonts - distribution. -\item[RSFS] The \Package{mathrsfs} package uses a really fancy script - font (the name stands for ``Ralph Smith's Formal Script'') which is - already part of most modern \TeX{} distributions (Type~1 versions of - the font are also provided, courtesy of Taco Hoekwater). The package - creates a new command \csx{mathscr}. -\item[Zapf Chancery] is the standard \PS{} calligraphic font. There - is no package but you can easily make it available by means of the - command -\begin{verbatim} -\DeclareMathAlphabet{\mathscr}{OT1}{pzc}% - {m}{it} -\end{verbatim} - in your preamble. You may find the font rather too big; if so, you - can use a scaled version of it like this: -\begin{verbatim} -\DeclareFontFamily{OT1}{pzc}{} -\DeclareFontShape{OT1}{pzc}{m}{it}% - {<-> s * [0.900] pzcmi7t}{} -\DeclareMathAlphabet{\mathscr}{OT1}{pzc}% - {m}{it} -\end{verbatim} - - Adobe Zapf Chancery (which the above examples use) is distributed in - any but the most basic \PS{} printers. A substantially identical - font (to the extent that the same metrics may be used) is - available from \acro{URW}, called URW Chancery L: it is distributed - with Ghostscript, and as part of the ``URW base35'' bundle, which is - available in most distributions. -\end{description} -Examples of the available styles are available on \acro{CTAN}. -\begin{ctanrefs} -\item[eucal.sty]\CTANref{eucal} -\item[euler fonts]\CTANref{amsfonts-euler} -\item[euler fonts, in Type 1 format]\CTANref{ams-AMStype1} -\item[ghostscript]Browse \CTANref{ghostscript} -\item[mathrsfs.sty]Distributed as part of \CTANref{jknappen-macros} -\item[rsfs fonts]\CTANref{rsfs} -\item[Script font examples]\CTANref{mathscript} -\item[URW Chancery L]Distributed as part of \CTANref{urw-base35} -\end{ctanrefs} - -\Question[Q-boldgreek]{Setting bold Greek letters in \LaTeX{}} - -The issue here is complicated by the fact that \csx{mathbf} (the -command for setting bold \emph{text} in \TeX{} maths) affects a select -few mathematical symbols (the uppercase Greek letters). However -lower-case Greek letters behave differently from upper-case Greek -letters (due to Knuth's esoteric font encoding decisions). However, -\csx{mathbf} \emph{can't} be used even for upper-case Greek letters in -the \AMSLaTeX{} \Package{amsmath} package, which -disables this font-switching and you must use one of the techniques -outlined below. - -The \plaintex{} solution \emph{does} work, in a limited way: -\begin{quote} -\begin{verbatim} -{\boldmath$\theta$} -\end{verbatim} -\end{quote} -but \csx{boldmath} may not be used in maths mode, so this `solution' -requires arcana such as: -\begin{quote} -\begin{verbatim} -$... \mbox{\boldmath$\theta$} ...$ -\end{verbatim} -\end{quote} -which then causes problems in superscripts, etc. - -These problems may be addressed by using a bold mathematics package. -\begin{itemize} -\item The \Package{bm} package, which is part of the \LaTeX{} tools - distribution, defines a command \csx{bm} which may be used anywhere - in maths mode. -\item The \Package{amsbsy} package (which is part of \AMSLaTeX{}) - defines a command \csx{boldsymbol}, which (though slightly less - comprehensive than \csx{bm}) covers almost all common cases. -\end{itemize} - -All these solutions cover all mathematical symbols, not merely Greek -letters. -\begin{ctanrefs} -\item[bm.sty]Distributed as part of \CTANref{2etools} -\item[amsbsy.sty]Distributed as part of \AMSLaTeX{} \CTANref{amslatex} -\item[amsmath.sty]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} -\end{ctanrefs} - -\Question[Q-prinvalint]{The Principal Value Integral symbol} - -This symbol (an integral sign, `crossed') does not appear in any of -the fonts ordinarily available to \AllTeX{} users, but it can be -created by use of the following macros: -\begin{wideversion} -\begin{verbatim} -\def\Xint#1{\mathchoice - {\XXint\displaystyle\textstyle{#1}}% - {\XXint\textstyle\scriptstyle{#1}}% - {\XXint\scriptstyle\scriptscriptstyle{#1}}% - {\XXint\scriptscriptstyle\scriptscriptstyle{#1}}% - \!\int} -\def\XXint#1#2#3{{\setbox0=\hbox{$#1{#2#3}{\int}$} - \vcenter{\hbox{$#2#3$}}\kern-.5\wd0}} -\def\ddashint{\Xint=} -\def\dashint{\Xint-} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\def\Xint#1{\mathchoice - {\XXint\displaystyle\textstyle{#1}}% - {\XXint\textstyle\scriptstyle{#1}}% - {\XXint\scriptstyle\scriptscriptstyle{#1}}% - {\XXint\scriptscriptstyle - \scriptscriptstyle{#1}}% - \!\int} -\def\XXint#1#2#3{{% - \setbox0=\hbox{$#1{#2#3}{\int}$} - \vcenter{\hbox{$#2#3$}}\kern-.5\wd0}} -\def\ddashint{\Xint=} -\def\dashint{\Xint-} -\end{verbatim} -\end{narrowversion} -\csx{dashint} gives a single-dashed integral sign, \csx{ddashint} a -double-dashed one. - -\Question[Q-underscore]{How to use the underscore character} - -The underscore character `\texttt{\_}' is ordinarily used in -\TeX{} to indicate a subscript in maths mode; if you type -\texttt{\_}, on its own, in the course of ordinary text, \TeX{} will -complain. If you're writing a document which will contain a large -number of underscore characters, the prospect of typing -\csx{\_} (or, worse, \csx{textunderscore}) for every one of -them will daunt most ordinary people. - -Moderately skilled macro programmers can readily generate a quick hack -to permit typing `\texttt{\_}' to mean `text underscore'. -However, the code \emph{is} somewhat tricky, and more importantly -there are significant points where it's easy to get it wrong. There -is therefore a package \Package{underscore} which provides a general -solution to this requirement. - -There is a problem, though: \acro{OT}1 text fonts don't contain an -underscore character, unless they're in the typewriter version of the -encoding (used by fixed-width fonts such as \texttt{cmtt}). So either -you must ensure that your underscore characters only occur in text set -in a typewriter font, or you must use a more modern encoding, such as -\acro{T}1, which has the same layout for every font, and thus an -underscore in every font. - -If the requirement is only for occasional uses of underscores, it may -be acceptable to use the following construct: -\begin{quote} -\begin{verbatim} -\def\us{\char`\_} -... -\texttt{create\us process} -\end{verbatim} -\end{quote} -The construction isn't in the least robust (in the normal English -sense of the word), but it \emph{is} robust under expansion (i.e., the -\LaTeX{} sense of the word); so use it with care, but don't worry -about section headings and the like. -\begin{ctanrefs} -\item[underscore.sty]\CTANref{underscore} -\end{ctanrefs} - -\Question[Q-atsign]{How to type an `@' sign?} - -Long ago, some packages used to use the `@' sign as a command, so that -special measures were needed to type it. While those packages are -still in principle available, few people use them, and those that do -use them have ready access to rather good documentation. - -Ordinary people (such as the author of this \acro{FAQ}) need only type -`@'. - -\Question[Q-euro]{Typesetting the Euro sign} - -The European currency ``Euro'' is represented by a symbol of somewhat -dubious design, but it's an important currency and \AllTeX{} users -need to typeset it. - -Note that the Commission of the European Community at first deemed -that the Euro symbol should always be set in a sans-serif font; -fortunately, this eccentric ruling has now been rescinded, and one may -apply best typesetting efforts to making it appear at least slightly -``respectable'' (typographically). - -The \acro{TS}1-encoded \acro{TC} fonts provided as part of the \acro{EC} font -distribution provide Euro glyphs. The fonts are called Text Companion -(\acro{TC}) fonts, and offer the same range -of faces as do the \acro{EC} fonts themselves. The -\Package{textcomp} package provides a \csx{texteuro} command for -accessing the symbol, which selects a symbol to match the surrounding -text. The design of the symbol in the \acro{TC} fonts is not -universally loved\dots{} -Nevertheless, use the \acro{TC} font version of the symbol if you are -producing documents using Knuth's Computer Modern Fonts. - -The \Package{latin9} input encoding defined by the \Package{inputenc} -package has a euro character defined (character position 164, occupied -in other \acro{ISO} Latin character sets by the ``currency symbol''). -The encoding uses the command \csx{texteuro} for the character; at -present that command is \emph{only} available from the -\Package{textcomp} package. There is a Microsoft code page position, -too, but standardisation of such things proceeds via rather different -routes and the \LaTeX{} project hasn't yet been given details of the -change. - -Outline fonts which contain nothing but Euro symbols are available -(free) from -\href{ftp://ftp.adobe.com/pub/adobe/type/win/all/eurofont.exe}{Adobe}\nobreakspace--- -the file is packaged as a \ProgName{Windows} self-extracting -executable, but it may be decoded as a \extension{zip} format archive -on other operating systems. -The \Package{euro} bundle contains metrics, \ProgName{dvips} map -files, and macros (for \plaintex{} and \LaTeX{}), for using these -fonts in documents. \LaTeX{} users will find two packages in the -bundle: \Package{eurosans} only offers the sans-serif version (to -conform with the obsolete ruling about sans-serif-only symbols; the -package provides the -command \csx{euro}), whereas \Package{europs} matches the Euro symbol -with the surrounding text (providing the command \csx{EUR}). To use -either package -with the \Package{latin9} encoding, you need to define \csx{texteuro} -as an alias for the euro command the package defines. - -The Adobe fonts are probably the best bet for use in non-Computer -Modern environments. They are apparently designed to fit with Adobe -Times, Helvetica and Courier, but can probably fit with a wider range -of modern fonts. - -The \Package{eurofont} package provides a compendious analysis of the -``problem of the euro symbol'' in its documentation, and offers macros -for configuring the source of the glyphs to be used; however, it seems -rather large for everyday use. - -The \Package{euro-ce} bundle is a rather pleasing \MF{}-only design -providing Euro symbols in a number of shapes. The file -\File{euro-ce.tex}, in the distribution, offers hints as to how a -\plaintex{} user might make use of the fonts. - -Euro symbols are found in several other places, which we list here for -completeness. - -The \Package{marvosym} fonts contain a Euro symbol among many other -good things. -%% ; the font on \acro{CTAN} is not Adobe \ProgName{ATM} -%% compatible, but a compatible version is available free from -%% \href{http://www.YandY.com/download/marvosym.zip}{\YandY{}}. The font -%% on \acro{CTAN} comes with a set of macros to typeset all the symbols -%% it contains. - -Other \MF{}-based bundles containing Euro symbols are to be found in -\Package{china2e} (whose primary aim is Chinese dates and suchlike -matters) and the \Package{eurosym} fonts. -\begin{ctanrefs} -\item[china2e bundle]\CTANref{china2e} -\item[EC fonts]\CTANref{ec} -\item[euro fonts]\CTANref{euro-fonts} -\item[euro-ce fonts]\CTANref{euro-ce} -\item[eurofont.sty]\CTANref{eurofont} -\item[eurosym fonts]\CTANref{eurosym} -\item[marvosym fonts]\CTANref{marvosym-fonts} -\item[textcomp.sty]Part of the \LaTeX{} distribution. -\end{ctanrefs} - -\Question[Q-tradesyms]{How to get copyright, trademark, etc.} - -The ``\nothtml{Comprehensive symbol list'' (}% beware line break -\Qref{Comprehensive symbol list}{Q-symbols}\latexhtml{)}{''}, lists -the symbol commands \csx{textcopyright}, -\csx{textregistered} and \csx{texttrademark}, which are available in -\acro{TS}1-encoded fonts, and which are enabled using the -\Package{textcomp} package. - -In fact, all three commands are enabled in default \LaTeX{}, but the -glyphs you get aren't terribly beautiful. In particular, -\csx{textregistered} behaves oddly when included in bold text (for -example, in a section heading), since it is composed of a small-caps -letter, which typically degrades to a regular shape letter when asked -to set in a bold font. This means that the glyph becomes a circled -``r'', whereas the proper symbol is a circled ``R''. - -This effect is of course avoided by use of \Package{textcomp}. - -Another problem arises if you want \csx{textregistered} in a -superscript position (to look similar to \csx{texttrademark}). -Using a maths-mode superscript to do this provokes lots of pointless -errors: you \emph{must} use -\begin{quote} -\begin{verbatim} -\textsuperscript{\textregistered} -\end{verbatim} -\end{quote} - -\Question[Q-osf]{Using ``old-style'' figures} - -These numbers are also called medieval or lowercase figures and their -use is mostly font-specific. Terminology is confusing since the -lining figures (which are now the default) are a relatively recent -development (19th century) and before they arrived, oldstyle figures -were the norm, even when setting mathematics. (An example is Thomas -Harriot's \emph{Artis Analyticae Praxis} published in 1631). In a -typical old style 3, 4, 5, 7 and 9 have descenders and 6 and 8 ascend -above the x-height; sometimes 2 will also ascend (this last seems to -be a variation associated with French typography). - -\LaTeX{} provides a command \cmdinvoke*{oldstylenums}{digits}, which -by default uses an old-style set embedded in Knuth's `math italic' -font. The command isn't sensitive to the font style of surrounding -text: the glyphs are only available to match the normal medium weight -Computer Modern Roman fonts. - -The \Package{textcomp} package changes \csx{oldstylenums} to use the -glyphs in the Text Companion fonts (\LaTeX{} \acro{TS}1 encoding) when -in text mode, and also makes them available using the macros of the -form \csx{text<number>oldstyle}, e.g., \csx{textzerooldstyle}. -(Of course, not all font families can provide this facility.) - -Some font packages (e.g., \Package{mathpazo}) make old-style figures -available and provide explicit support for making them the default: -\cmdinvoke{usepackage}[osf]{mathpazo} selects a form where digits are -always old-style in text. The \Package{fontinst} package will -automatically generate ``old-style versions'' of commercial Adobe Type -1 font families for which ``expert'' sets are available. - -It's also possible to make virtual fonts, that offer old-style digits, -from existing font packages. The \FontName{cmolddig} bundle provides -a such a virtual version of Knuth's originals, and the \FontName{eco} -or \FontName{hfoldsty} bundles both provide versions of the \acro{EC} -fonts. The \FontName{lm} family offers old-style figures to OpenType -users (see below), but we have no stable mapping for \FontName{lm} -with old-style digits from the Adobe Type 1 versions of the fonts. - -Originally, oldstyle figures were only to be found the expert sets of -commercial fonts, but now they are increasingly widely available. An -example is Matthew Carter's Georgia font, which has old-style figures -as its normal form (the font was created for inclusion with certain -Microsoft products and is intended for on-screen viewing). - -OpenType fonts have a pair of axes for number variations~--- -proportional/tabular and lining/oldstyle selections are commonly -available. ``Full feature access'' to OpenType fonts, making such -options available to the \AllTeX{} user, is already supported by -\Qref*{\xetex{}}{Q-xetex} using, for example, the \Package{fontspec} -package. Similar support is also in the works for -\Qref*{\LuaTeX{}}{Q-luatex}. -\begin{ctanrefs} -\item[cmolddig \nothtml{\rmfamily}fonts]\CTANref{cmolddig} -\item[eco \nothtml{\rmfamily}fonts]\CTANref{eco} -\item[fontinst]\CTANref{fontinst} -\item[fontspec.sty]\CTANref{fontspec} -\item[mathpazo \nothtml{\rmfamily}fonts]\CTANref{mathpazo} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Macro programming} - -\subsection{``Generic'' macros and techniques} - -\Question[Q-linmacnames]{Non-letters in macro names} - -New \LaTeX{} users are often suprised that macro definitions -containing non-letters, such as -\begin{quote} -\begin{verbatim} -\newcommand{\cul8r}{Goodbye!} -\end{verbatim} -\end{quote} -fail to compile. The reason is that the \TeX{} macro language, unlike -most programming languages, allows % ! loin break (twatbili) -\Qref*{nothing but letters in macro names}{Q-whatmacros}. - -There are a number of techniques for defining a macro with a name like -\csx{cul8r}. Unfortunately, none of the techniques is particularly -good: -\begin{enumerate} -\item Use \csx{csname}\dots\csx{endcsname} to define and invoke the - macro: - \begin{quote} -\begin{narrowversion} -\begin{verbatim} -\expandafter\newcommand - \csname cul8r\endcsname{Goodbye!} -I said, ``\csname cul8r\endcsname''. -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\expandafter\newcommand\csname cul8r\endcsname{Goodbye!} -I said, ``\csname cul8r\endcsname''. -\end{verbatim} -\end{wideversion} - \end{quote} - \begin{description} - \item[Pro:] No unexpected side effects - \item[Con:] So verbose as to be unusable - \end{description} -\item Define a ``special-command generator'', and use the resulting - commands: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\newcommand{\DefineRemark}[2]{% - \expandafter\newcommand - \csname rmk-#1\endcsname{#2}% -} -\newcommand{\Remark}[1]{% - \csname rmk-#1\endcsname% -} -... -\DefineRemark{cul8r}{Goodbye!} -... -I said, ``\Remark{cul8r}''. -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\newcommand{\DefineRemark}[2]{% - \expandafter\newcommand\csname rmk-#1\endcsname{#2}% -} -\newcommand{\Remark}[1]{\csname rmk-#1\endcsname} -... -\DefineRemark{cul8r}{Goodbye!} -... -\Remark{cul8r} -\end{verbatim} -\end{wideversion} -\end{quote} - \begin{description} - \item[Pro:] Straightforward to use, not too untidy - \item[Con:] It's hardly doing what we set out to do (experts will - see that you are defining a macro, but others likely won't) - \end{description} -\item Convince \TeX{} that ``\texttt{8}'' is a letter: - \begin{quote} -\begin{verbatim} -\catcode`8 = 11 -\newcommand{\cul8r}{Goodbye!} -I said, ``\cul8r''. -\end{verbatim} - \end{quote} - \begin{description} - \item[Pro:] \csx{cul8r} can be used directly - \item[Con:] Likely to break other uses of ``\texttt{8}'' (such as - numbers or dimensions; so - \cmdinvoke{setlength}{\csx{paperwidth}}{8in} tells us: - \begin{quote} -\begin{verbatim} -! Missing number, treated as zero. -<to be read again> - 8 -\end{verbatim} - \end{quote} - \end{description} - As a general rule, changing category codes is something to use - \emph{in extremis}, after detailed examination of options. It is - conceivable that such drastic action could be useful for you, but - most ordinary users are well advised not even to try such a - technique. -\item Define a macro \csx{cul} which must always be followed by - ``\texttt{8r}'': - \begin{quote} -\begin{verbatim} -\def\cul8r{Goodbye!} -I said, ``\cul8r''. -\end{verbatim} - \end{quote} - \begin{description} - \item[Pro:] \csx{cul8r} can be used directly - \item[Con~\#1:] Breaks if \csx{cul} is followed by anything other - than ``\texttt{8r}'', with a confusing diagnostic~--- - \csx{cul99} produces: - \begin{quote} -\begin{wideversion} -\begin{verbatim} -! Use of \cul doesn't match its definition. -<*> \cul9 - 9 -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -! Use of \cul doesn't match its - definition. -<*> \cul9 - 9 -\end{verbatim} -\end{narrowversion} - \end{quote} - (which would confuse someone who hadn't even realised there - \emph{was} a definition of \csx{cul} in the document). - \item[Con~\#2:] Silently redefines existing \csx{cul}, if any; - as a result, the technique cannot be used to define both a - \csx{cul8r} and, say, a \csx{cul123} macro in the same - document. - \end{description} -\end{enumerate} -Technique~3 is in fact commonly used~--- in a limited form~--- within -most \LaTeX{} packages and within \LaTeX{} itself. The convention is to -use ``\texttt{@}'' within the names of internal macros to hide them -from the user and thereby prevent naming conflicts. To this end, -\LaTeX{} automatically treats ``\texttt{@}'' as a letter while -processing classes and packages and as a non-letter while processing -the user's document. The key to this technique is the separation: -internally a non-letter is used for macro names, and the user doesn't -see anything of it, while the status remains ``frozen'' in all the -definitions created within the class or package. See % ! line break -\Qref[question]{\csx{@} and \texttt{@} in macro names}{Q-atsigns} for -more information. - -Note that analogous use of technique~3 in this example would give us -\begin{quote} -\begin{verbatim} -\begingroup - \catcode`8 = 11 - \gdef\cul8r{Goodbye!} - \gdef\later{\cul8r} -\endgroup -I said, ``\later''. -\end{verbatim} -\end{quote} -which works, but rather defeats the object of the exercise. -(\csx{later} has the ``frozen'' catcode for `8', even though the value -has reverted to normal by the time it's used; note, also, the use of -the primitive command \csx{gdef}, since \csx{newcommand} can't make a -macro that's available outside the group.) - -\emph{Recommendation}: Either choose another mechanism (such as -\csx{DefineRemark} above), or choose another name for your macro, one -that contains only ordinary letters. A common approach is to use -roman numerals in place of arabic ones: -\begin{quote} -\begin{verbatim} -\newcommand{\culVIIIr}{Goodbye!} -\end{verbatim} -\end{quote} -which rather spoils the intent of the joke implicit in the example -\csx{cul8r}! - -\Question[Q-findwidth]{Finding the width of a letter, word, or phrase} - -Put the word in a box, and measure the width of the box. For example, -\begin{quote} -\begin{verbatim} -\newdimen\stringwidth -\setbox0=\hbox{hi} -\stringwidth=\wd0 -\end{verbatim} -\end{quote} -Note that if the quantity in the \csx{hbox} is a phrase, the actual -measurement only approximates the width that the phrase will occupy in -running text, since the inter-word glue can be adjusted in paragraph -mode. - -The same sort of thing is expressed in \LaTeX{} by: -\begin{quote} -\begin{verbatim} -\newlength{\gnat} -\settowidth{\gnat}{\textbf{small}} -\end{verbatim} -\end{quote} -This sets the value of the length command |\gnat| to the width of ``small'' -in bold-face text. - -\Question[Q-patch]{Patching existing commands} - -In the general case (possibly sticking something in the middle of an -existing command) this is difficult. However, the common requirement, -to add some code at the beginning or the end of an existing command, -is conceptually quite easy. Suppose we want to define a version of a -command that does some small extension of its original definition: we -would naturally write: -\begin{quote} -\begin{verbatim} -\renewcommand{\splat}{\mumble\splat} -\end{verbatim} -\end{quote} -However, this would not work: a call to \csx{splat} would execute -\csx{mumble}, and the call the redefined \csx{splat} again; this is an -unterminated recursion, that will quickly exhaust \TeX{}'s memory. - -Fortunately, the \TeX{} primitive \csx{let} command comes to our -rescue; it allows us to take a ``snapshot'' of the current state of a -command, which we can then use in the redefinition of the command. -So: -\begin{quote} -\begin{verbatim} -\let\OldSmooth\smooth -\renewcommand{\smooth}{\mumble\OldSmooth} -\end{verbatim} -\end{quote} -effects the required patch, safely. Adding things at the end of a -command works similarly. If \csx{smooth} takes arguments, one must -pass them on: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\renewcommand{\smooth}[2]{\mumble\OldSmooth{#1}{#2}} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\renewcommand{\smooth}[2]% - {\mumble\OldSmooth{#1}{#2}} -\end{verbatim} -\end{narrowversion} -\end{quote} - -The general case may be achieved in two ways. First, one can use the -\LaTeX{} command \csx{CheckCommand}; this compares an existing command -with the definition you give it, and issues a warning if two don't -match. Use is therefore: -\begin{quote} - |\CheckCommand{\complex}{|\meta{original definition}|}|\\ - |\renewcommand{\complex}{|\meta{new definition}|}| -\end{quote} -This technique is obviously somewhat laborious, but if the original -command comes from a source that's liable to change under the control -of someone else, it does at least warn you that your patch is in -danger of going wrong. - -Otherwise, \LaTeX{} users may use one of the \Package{patchcmd}, -\Package{ted} or \Package{etoolbox} packages. - -The \Package{patchcmd} package addresses a slightly simpler task, by -restricting the set of commands that you may patch; you mayn't patch -any command that has an optional argument, though it does deal with -the case of commands defined with \csx{DeclareRobustCommand}. The -package defines a \csx{patchcommand} command, that takes three -arguments: the command to patch, stuff to stick at the front of its -definition, and stuff to stick on the end of its definition. So, -after -\begin{quote} -\begin{verbatim} -\def\b{b} -\patchcmd\b{a}{c} -\end{verbatim} -\end{quote} -we will have a new version of \csx{b} defined as ``\texttt{abc}''. - -The \Package{ted} package is a `token list editor', and provides a -command \csx{Substitute*} which will patch the contents of a macro, -putting the result in a token-list, or (optionally) using the result -to (re)define a macro. The package may also be used as a powerful -debugging tool. - -The \Package{etoolbox} (which provides user access to \eTeX{}'s -programming facilities) provides a command \csx{patchcmd} which will -perform a ``string substitution'' in a macro's definition. The -package also provides commands that prepend (\csx{pretocmd}) or append -(\csx{apptocmd}) to the definition of a command. Not all commands may -be patched in this way; the package provides a command -\csx{ifpatchable} which checks the prerequisites, and checks that the -target command's body does indeed include the patch string you propose -to use. (The command \csx{ifpatchable*} omits the test on the patch -string.) - -Finally, we'll briefly consider a package that is (just about) -usable, but not really recommendable. \Package{Patch} gives you an -ingenious (and difficult to understand) mechanism, and comes as an -old-style \LaTeX{} documented macro file, which can no longer be -processed (as in -\begin{narrowversion} - generating documentation for a new package~--- \Qref{}{Q-install-doc}). -\end{narrowversion} -\begin{wideversion} - \Qref{generating documentation for a new package}{Q-install-doc}). -\end{wideversion} -Fortunately, the file (\File{patch.doc}) may be input directly, and -``documentation'' may found by reading the source of the package. -Roughly speaking, one gives the command a set of instructions -analogous to \ProgName{sed} substitutions, and it regenerates the -command thus amended. Unless you can't do your job any other way, you -had probably best avoid \Package{patch}. -\begin{ctanrefs} -\item[etoolbox.sty]\CTANref{etoolbox} -\item[patch.doc]\CTANref{patch} -\item[patchcommand.sty]\CTANref{patchcmd} -\item[ted.sty]\CTANref{ted} -\end{ctanrefs} - -\Question[Q-compjobnam]{Comparing the ``job name''} - -The token \csx{jobname} amusingly produces a sequence of characters -whose category code is 12 (`other'), regardless of what the characters -actually are. Since one inevitably has to compare a macro with the -contents of another macro (using \csx{ifx}, somewhere) one needs to -create a macro whose expansion looks the same as the expansion of -\csx{jobname}. We find we can do this with \csx{meaning}, if we strip -the ``\csx{show} command'' prefix. - -The full command looks like: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\def\StripPrefix#1>{} -\def\jobis#1{FF\fi - \def\predicate{#1}% - \edef\predicate{\expandafter\StripPrefix\meaning\predicate}% - \edef\job{\jobname}% - \ifx\job\predicate -} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\def\StripPrefix#1>{} -\def\jobis#1{FF\fi - \def\predicate{#1}% - \edef\predicate{\expandafter\StripPrefix - \meaning\predicate}% - \edef\job{\jobname}% - \ifx\job\predicate -} -\end{verbatim} -\end{narrowversion} -\end{quote} -And it's used as: -\begin{quote} -\begin{verbatim} -\if\jobis{mainfile}% - \message{YES}% -\else - \message{NO}% -\fi -\end{verbatim} -\end{quote} -Note that the command \csx{StripPrefix} need not be defined if you're -using \LaTeX{}~--- there's already an % line break! -\Qref*{internal command}{Q-atsigns} \csx{strip@prefix} that you can -use. - -\Question[Q-isitanum]{Is the argument a number?} - -\TeX{}'s own lexical analysis doesn't offer the macro programmer -terribly much support: while category codes will distinguish letters -(or what \TeX{} currently thinks of as letters) from everything else, -there's no support for analysing numbers. - -The simple-minded solution is to compare numeric characters with the -characters of the argument, one by one, by a sequence of direct tests, -and to declare the argument ``not a number'' if any character fails -all comparisons: -\begin{quote} -\begin{verbatim} -\ifx1#1 -\else\ifx2#1 -... -\else\ifx9#1 -\else\isanumfalse -\fi\fi...\fi -\end{verbatim} -\end{quote} -which one would then use in a tail-recursing macro to gobble an -argument. One could do slightly better by assuming (pretty safely) -that the digits' character codes are consecutive: -\begin{quote} -\begin{verbatim} -\ifnum`#1<`0 \isanumfalse -\else\ifnum`#1>`9 \isanumfalse - \fi -\fi -\end{verbatim} -\end{quote} -again used in tail-recursion. However, these forms aren't very -satisfactory: getting the recursion ``right'' is troublesome (it has a -tendency to gobble spaces in the argument), and in any case \TeX{} -itself has mechanisms for reading numbers, and it would be nice to use -them. - -Donald Arseneau's \Package{cite} package offers the following test -for an argument being a strictly positive integer: -\begin{quote} -\begin{verbatim} -\def\IsPositive#1{% - TT\fi - \ifcat_\ifnum0<0#1 _\else A\fi -} -\end{verbatim} -\end{quote} -which can be adapted to a test for a non-negative integer thus: -\begin{quote} -\begin{verbatim} -\def\IsNonNegative{% - \ifcat_\ifnum9<1#1 _\else A\fi -} -\end{verbatim} -\end{quote} -or a test for any integer: -\begin{quote} -\begin{verbatim} -\def\gobbleminus#1{\ifx-#1\else#1\fi} -\def\IsInteger#1{% - TT\fi - \ifcat_\ifnum9<1\gobbleminus#1 _\else A\fi -} -\end{verbatim} -\end{quote} -but this surely stretches the technique further than is reasonable. - -If we don't care about the sign, we can use \TeX{} to remove the -entire number (sign and all) from the input stream, and then look at -what's left: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\def\testnum#1{\afterassignment\testresult - \count255=#1 \end} -\def\testresult#1\end{\ifx\end#1\end} -\def\IsInteger#1{TT\fi \testnum{#1}} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\def\testnum#1{\afterassignment\testresult\count255=#1 \end} -\def\testresult#1\end{\ifx\end#1\end\isanumtrue\else\isanumfalse\fi} -\end{verbatim} -\end{wideversion} -\end{quote} -(which technique is due to David Kastrup); this can provoke errors. -In a later thread on the same topic, Michael Downes offered: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\def\IsInteger#1{% - TT\fi - \begingroup \lccode`\-=`\0 \lccode`+=`\0 - \lccode`\1=`\0 \lccode`\2=`\0 \lccode`\3=`\0 - \lccode`\4=`\0 \lccode`\5=`\0 \lccode`\6=`\0 - \lccode`\7=`\0 \lccode`\8=`\0 \lccode`\9=`\0 - \lowercase{\endgroup - \expandafter\ifx\expandafter\delimiter - \romannumeral0\string#1}\delimiter -} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\def\IsInteger#1{% - TT\fi - \begingroup \lccode`\-=`\0 \lccode`+=`\0 - \lccode`\1=`\0 \lccode`\2=`\0 - \lccode`\3=`\0 \lccode`\4=`\0 - \lccode`\5=`\0 \lccode`\6=`\0 - \lccode`\7=`\0 \lccode`\8=`\0 - \lccode`\9=`\0 - \lowercase{\endgroup - \expandafter\ifx\expandafter\delimiter - \romannumeral0\string#1}\delimiter -} -\end{verbatim} -\end{narrowversion} -\end{quote} -which relies on \csx{romannumeral} producing an empty result if its -argument is zero. Sadly, this technique has the unfortunate property -that it accepts simple expressions such as `\texttt{1+2-3}'; this -could be solved by an initial \csx{gobbleminus}-like construction. - -All the complete functions above are designed to be used in \TeX{} -conditionals written ``naturally''~--- for example: -\begin{quote} -\begin{verbatim} -\if\IsInteger{<subject of test>}% - <deal with integer>% -\else - <deal with non-integer>% -\fi -\end{verbatim} -\end{quote} -The \LaTeX{} \Class{memoir} class has an internal command of its own, -\cmdinvoke*{checkifinteger}{num}, that sets the conditional command -\csx{ifinteger} according to whether the argument was an integer. - -Of course, all this kerfuffle would be (essentially) void if there was -a simple means of ``catching'' \TeX{} errors. Imagining an -error-catching primitive \csx{ifnoerror}, one might write: -\begin{quote} -\begin{verbatim} -\def\IsInteger#1{% - TT% - \ifnoerror - \tempcount=#1\relax -% carries on if no error - \expandafter\iftrue - \else -% here if there was an error - \expandafter\iffalse - \fi -} -\end{verbatim} -\end{quote} -thus using \TeX{}'s own integer-parsing code to do the check. It's a -pity that such a mechanism was never defined (it could be that it's -impossible to program within \TeX{}!). -\begin{ctanrefs} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-hash]{Defining macros within macros} - -The way to think of this is that |##| gets replaced by |#| in just the -same way that |#1| gets replaced by `whatever is the first argument'. - -So if you define a macro and use it as: -\begin{quote} -\begin{verbatim} -\def\a#1{+++#1+++#1+++#1+++} \a{b} -\end{verbatim} -\end{quote} -the macro expansion produces `+++b+++b+++b+++', -which people find normal. However, if we now replace part of the macro: -\begin{quote} -\begin{verbatim} -\def\a#1{+++#1+++\def\x #1{xxx#1}} -\end{verbatim} -\end{quote} -\cmdinvoke{a}{b} will expand to `+++b+++|\def\x b{xxxb}|'. This -defines \csx{x} to be a macro \emph{delimited} by |b|, and taking no -arguments, which people may find strange, even though it is just a -specialisation of the example above. If you want \csx{a} to -define \csx{x} to be a macro with one argument, you need to write: -\begin{quote} -\begin{verbatim} -\def\a#1{+++#1+++\def\x ##1{xxx##1}} -\end{verbatim} -\end{quote} -and \csx{a{b}} will expand to -`+++b+++|\def\x #1{xxx#1}|', because |#1| gets replaced by `b' -and |##| gets replaced by |#|. - -To nest a definition inside a definition inside a definition then -you need |####1|, as at each stage |##| is replaced by -|#|. At the next level you need 8~|#|s each time, and so on. - -\Question[Q-spinmacro]{Spaces in macros} - -It's very easy to write macros that produce space in the typeset -output where it's neither desired nor expected. Spaces introduced by -macros are particularly insidious because they don't amalgamate with -spaces around the macro (unlike consecutive spaces that you -type), so your output can have a single bloated space that proves -to be made up of two or even more spaces that haven't amalgamated. -And of course, your output can also have a space where none was wanted -at all. - -Spaces are produced, inside a macro as elsewhere, by space or tab -characters, or by end-of-line characters. There are two basic rules -to remember when writing a macro: first, the rules for ignoring spaces -when you're typing macros are just the same as the rules that apply -when you're typing ordinary text, and second, rules for ignoring -spaces do \emph{not} apply to spaces produced while a macro is being -obeyed (``expanded''). - -Spaces are ignored in vertical mode (between paragraphs), at the -beginning of a line, and after a command name. Since sequences of -spaces are collapsed into one, it `feels as if' spaces are ignored if -they follow another space. Space can have syntactic meaning after -certain sorts of non-braced arguments (e.g., \emph{count} and -\emph{dimen} variable assignments in \plaintex{}) and after certain -control words (e.g., in \csx{hbox} |to|, so again we have instances -where it `feels as if' spaces are being ignored when they're merely -working quietly for their living. - -Consider the following macro, fairly faithfully adapted from one that -appeared on \Newsgroup{comp.text.tex}: -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -\newcommand{\stline}[1] - { \bigskip \makebox[2cm]{ \textbf{#1} } } -\end{verbatim} -\end{quote} -(the original appeared on a single line: it's wrapped here to fit in -the printed \acro{FAQ}'s narrow columns). - -\noindent -\end{narrowversion} -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\newcommand{\stline}[1]{ \bigskip \makebox[2cm]{ \textbf{#1} } } -\end{verbatim} -\end{quote} -\end{wideversion} -The macro definition contains five spaces: -\begin{itemize} -\item after the opening |{| of the macro body; this space will be - ignored, not because ``because the macro appears at the start of a - line'', but rather because the macro was designed to operate between - paragraphs -\item after \csx{bigskip}; this space will be ignored (while the macro - is being defined) because it follows a command name -\item after the |{| of the mandatory argument of \csx{makebox}; even - though this space will inevitably appear at the start of an output - line, it will \emph{not} be ignored -\item after the |}| closing the argument of \csx{textbf}; this space - will not be ignored, but may be overlooked if the argument is well - within the |2cm| allowed for it -\item after the |}| closing the mandatory argument of \csx{makebox}; - this space will not be ignored -\end{itemize} -The original author of the macro had been concerned that the starts of -his lines with this macro in them were not at the left margin, and -that the text appearing after the macro wasn't always properly -aligned. These problems arose from the space at the start of the -mandatory argument of \csx{makebox} and the space immediately after the -same argument. He had written his macro in that way to emphasise the -meaning of its various parts; unfortunately the meaning was rather -lost in the problems the macro caused. - -The principal technique for suppressing spaces is the use of -\texttt{\textpercent} characters: everything after a -\texttt{\textpercent} is ignored, even the end of line itself (so -that not even the end of line can contribute an unwanted space). The -secondary technique is to ensure that the end of line is preceded by a -command name (since the end of line behaves like a space, it will be -ignored following a command name). Thus the above command would be -written (by an experienced programmer with a similar eye to -emphasising the structure): -\begin{quote} -\begin{verbatim} -\newcommand{\stline}[1]{% - \bigskip - \makebox[2cm]{% - \textbf{#1}\relax - }% -} -\end{verbatim} -\end{quote} -Care has been taken to ensure that every space in the revised -definition is ignored, so none appears in the output. The revised -definition takes the ``belt and braces'' approach, explicitly dealing -with every line ending (although, as noted above, a space introduced -at the end of the first line of the macro would have been ignored in -actual use of the macro. This is the best technique, in fact~--- it's -easier to blindly suppress spaces than to analyse at every point -whether you actually need to. Three techniques were used to suppress -spaces: -\begin{itemize} -\item placing a \texttt{\textpercent} character at the end of a line - (as in the 1st, 3rd and 5th lines), -\item ending a line `naturally' with a control sequence, as in line 2, - and -\item ending a line with an `artificial' control sequence, as in line - 4; the control sequence in this case (\csx{relax}) is a no-op in many - circumstances (as here), but this usage is deprecated~--- a - \texttt{\textpercent} character would have been better. -\end{itemize} -Beware of the (common) temptation to place a space \emph{before} a -\texttt{\textpercent} character: if you do this you might as well omit -the \texttt{\textpercent} altogether. - -In ``real life'', of course, the spaces that appear in macros are far -more cryptic than those in the example above. The most common spaces -arise from unprotected line ends, and this is an error that -occasionally appears even in macros written by the most accomplished -programmers. - -\Question[Q-moren9]{How to break the 9-argument limit} - -If you think about it, you will realise that Knuth's command -definition syntax: -\begin{quote} -\begin{verbatim} -\def\blah#1#2 ... #9{<macro body>} -\end{verbatim} -\end{quote} -is intrinsically limited to just 9 arguments. There's no direct way -round this: how would you express a 10th argument?~--- and ensure that -the syntax didn't gobble some other valid usage? - -If you really must have more than 9 arguments, the way to go is: -\begin{quote} -\begin{verbatim} -\def\blah#1#2 ... #9{% - \def\ArgI{{#1}}% - \def\ArgII{{#2}}% - ... - \def\ArgIX{{#9}}% - \BlahRelay -} -\def\BlahRelay#1#2#3{% - % arguments 1-9 are now in - % \ArgI-\ArgIX - % arguments 10-12 are in - % #1-#3 - <macro body>% -} -\end{verbatim} -\end{quote} -This technique is easily extendible by concert pianists of the \TeX{} -keyboard, but is really hard to recommend. - -\LaTeX{} users have the small convenience of merely giving a number of -arguments in the \csx{newcommand} that defines each part of the -relaying mechanism: Knuth's restriction applies to \csx{newcommand} -just as it does to \csx{def}. However, \LaTeX{} users also have the -way out of such barbarous command syntax: the \Package{keyval} -package. With \Package{keyval}, and a bit of programming, one can -write really quite sophisticated commands, whose invocation might look -like: -\begin{quote} -\begin{verbatim} -\flowerinstance{species=Primula veris, - family=Primulaceae, - location=Coldham's Common, - locationtype=Common grazing land, - date=1995/04/24, - numplants=50, - soiltype=alkaline -} -\end{verbatim} -\end{quote} -The merit of such verbosity is that it is self-explanatory: the typist -doesn't have to remember that argument twelve is |soiltype|, and so -on: the commands may be copied from field notes quickly and -accurately. -\begin{ctanrefs} -\item[keyval.sty]Distributed as part of \CTANref{graphics} -\end{ctanrefs} - -\Question[Q-keyval]{Key-value input for macros and package options} - -When we discussed % !line break -\Qref*{extending the number of arguments to a macro}{Q-moren9}, we -suggested that large numbers of arguments, distinguished only by their -position, aren't very kind to the user, and that a package such as -\Package{keyval} offers a more attractive user interface. We now -consider the packages that the macro programmer might use, to create -such a user interface. - -The simplest key-value processor remains \Package{keyval}; it has a -command \csx{define@key} to declare a key and a \emph{handler} to -process it, and a macro \csx{setkeys} to offer values to the handler -of one or more keys. Thus: -\begin{quote} -\begin{verbatim} -\define@key{my}{foo}{Foo is #1\par} -\define@key{my}{bar}[99]{Bar is #1\par} -... -\setkeys{my}{foo=3,bar} -\end{verbatim} -\end{quote} -will produce output saying: -\begin{quote} - Foo is 3\par{} - Bar is 99 -\end{quote} -This has defined two keys `\texttt{foo}' and `\texttt{bar}' in family -`\texttt{my}', and then executed them, the first with argument -`\texttt{3}' and the second with no argument, so that the default -value of `\texttt{99}' is picked up. In effect, the two calls to -\csx{define@key} are simply defining commands, as (for example): -\begin{quote} -\begin{verbatim} -\newcommand{\KV@my@foo}[1]{Foo is #1} -\end{verbatim} -\end{quote} -(the definition of \csx{KV@my@bar} is similar, but trickier). The -command \csx{setkeys} knows how to find those commands when it needs to -process each key~--- it is easy to regurgitate the structure of the -command name, with family name (`\texttt{my}', here) after the first -`\texttt{@}', and the key name after the second `\texttt{@}'. (The -`\texttt{KV}' part is fixed, in \Package{keyval}.) - -These simple commands are enough, in fact, to process the botanical -example offered as replacement for multi-argument commands in % ! line break -\Qref[question]{the question mentioned above}{Q-moren9}, or the -optional arguments of the \csx{includegraphics} command of the -\Package{graphicx} package. (The last is, in fact, what -\Package{keyval} was designed to do.) - -However, we need more if we're to to have package options in -`key-value' form. Packages like \Package{hyperref} have enormously -complicated package options which need key-value processing at -\csx{ProcessOptions} time: \Package{keyval} can't do that on its own. - -Heiko Oberdiek's \Package{kvoptions} package comes to our help: it -enables the programmer to declare class or package options that -operate as key and value pairs. The package defines commands -\csx{DeclareBoolOption} for options whose value should be either -\emph{true} or \emph{false}, and \csx{DeclareStringOption} for all -other options that have a value. Keys are declared using -\Package{keyval} and may remain available for use within the document, -or may be `cancelled' to avoid confusion. If you have loaded -\Package{kvoptions}, the \LaTeX{} kernel's \csx{DeclareOption} becomes -\csx{DeclareVoidOption} (it's an option with no value), and -\csx{DeclareOption*} becomes \csx{DeclareDefaultOption}. - -Heiko also provides \Package{kvsetkeys} which is a more robust version -of \Package{setkeys}, with some of the rough edges made smoother. - -Hendri Adriaens' \Package{xkeyval} offers more flexibility than -the original \Package{keyval} and is more robust than the original, -too. Like \Package{kvoptions}, the package also has mechanisms to -allow class and package options in key-value form (macros -\csx{DeclareOptionX}, \csx{ExecuteOptionsX} and \csx{ProcessOptionsX}. -\Package{Pstricks} bundle packages use a \Package{xkeyval} derivative -called \Package{pst-xkey} for their own key-value manipulation. -% xkvview? (i think we can ignore xkvltxp for these purposes) - -The (widely-respected) \Package{pgf} graphics package has its own -key-value package called \Package{pgfkeys}. The documentation of the -package (part of the huge \Package{pgf} manual, in part 5, -``utilities'') contains a useful comparison with other key-value -systems; some notable differences are: -\begin{itemize} -\item key organisation: \Package{pgfkeys} uses a tree structure, while - \Package{keyval} and \Package{xkeyval} both associate keys with a family; -\item \Package{pgfkeys} supports multi-argument key code; and -\item \Package{pgfkeys} can support call-backs when an unknown key - appears (these things are called \emph{handlers}. -\end{itemize} -Keys are organized in a tree that is reminiscent of the Unix fille -tree. A typical key might be, \File{/tikz/coordinate system/x} or -just \File{/x}. When you specify keys you can provide the complete -path of the key, but you usually just provide the name of the key -(corresponding to the file name without any path) and the path is -added automatically. So a \csx{pgfkeys} command might be: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\pgfkeys{/my key=hello,/your keys/main key=something\strange, - key name without path=something else} -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -\pgfkeys{/my key=hello, - /your keys/main key=something\strange, - key name without path=something else} -\end{verbatim} -\end{quote} -\end{narrowversion} -and for each key mentioned, the associated code will be executed. -\dots{} and that code is also set up using \csx{pgfkeys}: -\begin{quote} -\begin{verbatim} -\pgfkeys{/my key/.code=The value is '#1'.} -\end{verbatim} -\end{quote} -after which -\begin{quote} -\begin{verbatim} -\pgfkeys{/my key=hi!} -\end{verbatim} -\end{quote} -will produce just -\begin{quote} - The value is 'hi!'. -\end{quote} -The manual goes on, showing how to define a key with two arguments, -how to provide default value for a key, and how to define aliases for -particular key sequences (which are called ``styles''). All in all, -it seems a well thought-out system, offering a lot of flexibility that -isn't available with the other keys packages. However, there seems to -be no mechanism for using \Package{pgfkeys} keys as part of the -options of another package, in the way that \Package{kvoptions} does. - -Another key-value system that's part of larger set of macros is -\Package{scrbase}, which uses the facilities of \Package{keyval} to -build a larger set of facilities, originally for use within the -\Class{KOMA-script} bundle. For English-speaking authors, there are -difficulties from the German-only documentation; however, from a -partial translation available to the author of this answer, a summary -is possible. The package may build on the facilities either of -\Package{kyeval} or of \Package{xkeyval}, and builds its functionality -on the structure of the `key family'. The user may define family -`members' and keys are defined relative to the members. (For example, -the package \Package{scrbase} is part of the \Class{KOMA-script} -bundle; so its keys are all members of the \Package{scrbase.sty} -family within the \Package{KOMA} family. The function -\csx{FamilyProcessOptions} allows the programmer to decode the options -of the package in terms of the package's key family. Note that there -is no special provision made for ``traditional'' package options, as -in the \Package{kvoptions} package. - -This brief summary was guided by input from two sources: a draft article -for \textsl{TUGboat} by Joseph Wright, and the partial translation of the -documentation of package \Package{scrbase} prepared by Philipp -Stephani. At Joseph's suggestion, discussion of his \Package{keys3} -package, which is designed for use with the experimental \LaTeX{}3, -has been omitted. -\begin{ctanrefs} -\item[keyval.sty]Distributed as part of \CTANref{graphics} -\item[kvoptions.sty]Distributed as part of \CTANref{oberdiek} -\item[kvsetkeys.sty]Distributed as part of \CTANref{oberdiek} -\item[pgfkeys.sty]Distributed as part of \CTANref{pgf} -\item[scrbase.sty]Distributed as part of \CTANref{koma-script} -\item[xkeyval.sty]\CTANref{xkeyval} -\end{ctanrefs} - -\Question[Q-activechars]{Defining characters as macros} - -Single characters can act as macros (defined commands), and both -\plaintex{} and \LaTeX{} define the character -``\texttt{\textasciitilde}'' as a ``non-breakable space''. A -character is made definable, or ``active'', by setting its -\emph{category code} (catcode) to be \csx{active} (13): -|\catcode`_=\active|. - -Any character could, in principle, be activated this way and defined -as a macro (\csx{def}\texttt{\_\{}\csx{\_}\texttt{\}}~--- the simple answer to -% beware line break -\Qref[question]{using underscores}{Q-underscore}), but you must be -wary: whereas people expect an active tilde, other active characters -may be unexpected and interact badly with other macros. Furthermore, -by defining an active character, you preclude the character's use for -other purposes, and there are few characters ``free'' to be subverted -in this way. - -To define the character ``|z|'' as a command, one would say something -like: -\begin{quote} -\begin{verbatim} -\catcode`\z=\active -\def z{Yawn, I'm tired}% -\end{verbatim} -\end{quote} -and each subsequent ``|z|'' in the text would become a yawn. This would be -an astoundingly bad idea for most documents, but might have special -applications. (Note that, in ``|\def z|'', ``|z|'' is no longer interpreted as -a letter; the space is therefore not necessary~--- ``|\defz|'' would do; we -choose to retain the space, for what little clarity we can manage.) -Some \LaTeX{} packages facilitate such definitions. For example, the -\Package{shortvrb} package with its \csx{MakeShortVerb} command. - -\TeX{} uses category codes to interpret characters as they are read -from the input. -% beware line break -\emph{Changing a catcode value will not affect characters that have already been read}. -Therefore, it is best if characters have fixed category codes for the -duration of a document. If catcodes are changed for particular -purposes (the \csx{verb} command does this), then the altered -characters will not be interpreted properly when they appear in the -argument to another command (as, for example, in -% beware line-break -\htmlonly{``}\Qref[question]{\csx{verb} in command arguments}{Q-verbwithin}\htmlonly{''}). -An exemplary case is the \Package{doc} package, which processes .dtx -files using the \Package{shortvrb} package to define -\texttt{\textbar\dots{}\textbar} as a shorthand for -\csx{verb}\texttt{\textbar\dots{}\textbar}. But \texttt{\textbar} is -also used in the preambles of tabular environments, so that tables in -\extension{dtx} files can only have vertical line separation between -columns by employing special measures of some sort. - -Another consequence is that catcode assignments made -in macros often don't work as expected % beware linebreak -(\htmlonly{see ``}\Qref{Active characters in command arguments}{Q-actinarg}\htmlonly{''}). -For example, the definition -\begin{quote} -\begin{verbatim} -\def\mistake{% -\catcode`_=\active -\def_{\textunderscore\-}% -} -\end{verbatim} -\end{quote} -does not work because it attempts to define an ordinary |_| character: -When the macro is used, the category change does not apply to the -underscore character already in the macro definition. Instead, one may -use: -\begin{quote} -\begin{verbatim} -\begingroup -\catcode`_=\active -\gdef\works{% note the global \gdef - \catcode`_=\active - \def_{\textunderscore\-}% -} -\endgroup -\end{verbatim} -\end{quote} -The alternative (``tricksy'') way of creating such an isolated -definition depends on the curious properties of \csx{lowercase}, which -changes characters without altering their catcodes. Since there is -always \emph{one} active character (``\texttt{\textasciitilde}''), we -can fool \csx{lowercase} into patching up a definition without ever -explicitly changing a catcode: -\begin{quote} -\begin{verbatim} -\begingroup - \lccode`\~=`\_ - \lowercase{\endgroup - \def~{\textunderscore\-}% - }% -\end{verbatim} -\end{quote} -The two definitions have the same overall effect (the character is -defined as a command, but the character does not remain active), -except that the first defines a \csx{global} command. - -For active characters to be used only in maths mode, it is much better -to leave the character having its ordinary catcode, but assign it a -special active \emph{maths code}, as with -\begin{quote} -\begin{verbatim} -\begingroup - \lccode`~=`x - \lowercase{\endgroup - \def~{\times}% - }% -\mathcode`x="8000 -\end{verbatim} -\end{quote} -The special character does not need to be redefined whenever it is -made active~--- the definition of the command persists even if the -character's catcode reverts to its original value; the definition -becomes accessible again if the character once again becomes active. -\begin{ctanrefs} -\item[doc.sty]Distributed as part of the source of \LaTeX{}, \CTANref{latex} -\item[shortvrb.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - - -\Question[Q-actinarg]{Active characters in command arguments} - -Occasionally, it's nice to make one or two characters active in the -argument of a command, to make it easier for authors to code the -arguments. - -Active characters \emph{can} be used safely in such situations; but -care is needed. - -An example arose while this answer was being considered: an aspirant -macro writer posted to \Newsgroup{comp.text.tex} asking for help to -make |#| and |b| produce musical sharp and flat signs, respectively, -in a macro for specifying chords. - -The first problem is that both |#| and |b| have rather important uses -elsewhere in \TeX{} (to say the least!), so that the characters can -only be made active while the command is executing. - -Using the techniques discussed in % beware line break, next line -\htmlonly{``}\Qref[question]{characters as commands}{Q-activechars}\htmlonly{''}, -we can define: -\begin{quote} -\begin{verbatim} -\begingroup - \catcode`\#=\active - \gdef#{$\sharp$} -\endgroup -\end{verbatim} -\end{quote} -and: -\begin{quote} -\begin{verbatim} -\begingroup - \lccode`\~=`\b - \lowercase{\endgroup - \def~{$\flat$}% - } -\end{verbatim} -\end{quote} -The second problem is one of timing: the command has to make each -character active \emph{before} its arguments are read: this means that -the command can't actually ``have'' arguments itself, but must be -split in two. So we write: -\begin{quote} -\begin{verbatim} -\def\chord{% - \begingroup - \catcode`\#=\active - \catcode`\b=\active - \Xchord -} -\def\Xchord#1{% - \chordfont#1% - \endgroup -} -\end{verbatim} -\end{quote} -and we can use the command as \cmdinvoke{chord}{F\#} or -\cmdinvoke{chord}{Bb minor}. - -Two features of the coding are important: -\begin{itemize} -\item \csx{begingroup} in \csx{chord} opens a group that is closed by - \csx{endgroup} in \csx{Xchord}; this group limits the change of - category codes, which is the \emph{raison d'\^etre} of the whole - exercise. -\item Although |#| is active while \csx{Xchord} is executed, it's - \emph{not} active when it's being defined, so that the use of |#1| - doesn't require any special attention. -\end{itemize} - -Note that the technique used in such macros as \csx{chord}, here, is -analogous to that used in such commands as \csx{verb}; and, in just the -same way as \csx{verb} (see -% beware breaking long line -\htmlonly{``}\Qref[question]{\csx{verb} doesn't work in arguments}{Q-verbwithin}\htmlonly{''}), -\csx{chord} won't work inside the argument of another command (the -error messages, if they appear at all, will probably be rather odd). - - -\Question[Q-csname]{Defining a macro from an argument} - -It's common to want a command to create another command: often one -wants the new command's name to derive from an argument. \LaTeX{} -does this all the time: for example, \csx{newenvironment} creates -start- and end-environment commands whose names are derived from the -name of the environment command. - -The (seemingly) obvious approach: -\begin{quote} -\begin{verbatim} -\def\relay#1#2{\def\#1{#2}} -\end{verbatim} -\end{quote} -doesn't work (the \TeX{} engine interprets it -as a rather strange redefinition of |\#|). The trick is to use -\csx{csname}, which is a \TeX{} primitive for generating command names -from random text, together with \csx{expandafter}. The definition -above should read: -\begin{quote} -\begin{verbatim} -\def\relay#1#2{% - \expandafter\def\csname #1\endcsname{#2}% -} -\end{verbatim} -\end{quote} -With this definition, \cmdinvoke{relay}{blah}{bleah} is equivalent to -\csx{def}\cmdinvoke{blah}{bleah}. - -Note that the definition of \csx{relay} omits the braces round the -`command name' in the \csx{newcommand} it executes. This is -because they're not necessary (in fact they seldom are), and in this -circumstance they make the macro code slightly more tedious. - -The name created need not (of course) be \emph{just} the argument: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\def\newrace#1#2#3{\expandafter\def - \csname start#1\endcsname{% - #2% - }% - \expandafter\def - \csname finish#1\endcsname{% - #3% - }% -} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\def\newrace#1#2#3{% - \expandafter\def\csname start#1\endcsname{% - #2% - }% - \expandafter\def\csname finish#1\endcsname{% - #3% - }% -} -\end{verbatim} -\end{wideversion} -\end{quote} -With commands -\begin{quote} -\begin{verbatim} -\def\start#1{\csname start#1\endcsname} -\def\finish#1{\csname finish#1\endcsname} -\end{verbatim} -\end{quote} -these `races' could behave a bit like \LaTeX{} environments. - -\Question[Q-cvtlatex]{Transcribing \LaTeX{} command definitions} - -At several places in this \acro{FAQ}, questions are answered in terms -of how to program a \LaTeX{} macro. Sometimes, these macros might -also help users of \plaintex{} or other packages; this answer -attempts to provide a rough-and-ready guide to transcribing such macro -definitions for use in other packages. - -The reason \LaTeX{} has commands that replace \csx{def}, is that -there's a general philosophy within \LaTeX{} that the user should be -protected from himself: the user has different commands according to -whether the command to be defined exists (\csx{renewcommand}) or not -(\csx{newcommand}), and if its status proves not as the user expected, -an error is reported. A third definition command, -\csx{providecommand}, only defines if the target is not already -defined; \LaTeX{} has no direct equivalent of \csx{def}, which ignores -the present state of the command. The final command of this sort is -\csx{DeclareRobustCommand}, which creates a command which is ``robust'' -(i.e., will not expand if subjected to \LaTeX{} ``protected -expansion''); from the \plaintex{} user's point of view, -\csx{DeclareRobustCommand} should be treated as a non-checking version -of \csx{newcommand}. - -\LaTeX{} commands are, by default, defined \csx{long}; an optional \texttt{*} -between the \csx{newcommand} and its (other) arguments specifies that -the command is \emph{not} to be defined \csx{long}. The \texttt{*} is -detected by a command \csx{@ifstar} which uses \csx{futurelet} to switch -between two branches, and gobbles the \texttt{*}: \LaTeX{} users are -encouraged to think of the \texttt{*} as part of the command name. - -\LaTeX{}'s checks for unknown command are done by \csx{ifx} comparison -of a \csx{csname} construction with \csx{relax}; since the command name -argument is the desired control sequence name, this proves a little -long-winded. Since \texttt{\#1} is the requisite argument, we have: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\expandafter\ifx - \csname - \expandafter\@gobble\string#1% - \endcsname - \relax - ... -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\expandafter\ifx - \csname\expandafter\@gobble\string#1\endcsname - \relax - ... -\end{verbatim} -\end{wideversion} -\end{quote} -(\csx{@gobble} simply throws away its argument). - -The arguments of a \LaTeX{} command are specified by two optional -arguments to the defining command: a count of arguments (0--9: if the -count is 0, the optional count argument may be omitted), and a default -value for the first argument, if the defined command's first argument -is to be optional. So: -\begin{quote} -\begin{verbatim} -\newcommand\foo{...} -\newcommand\foo[0]{...} -\newcommand\foo[1]{...#1...} -\newcommand\foo[2][boo]{...#1...#2...} -\end{verbatim} -\end{quote} -In the last case, \csx{foo} may be called as \cmdinvoke{foo}{goodbye}, -which is equivalent to \cmdinvoke{foo}[boo]{goodbye} (employing the -default value given for the first argument), or as -\cmdinvoke{foo}[hello]{goodbye} (with an explicit first argument). - -Coding of commands with optional arguments is exemplified by the -coding of the last \csx{foo} above: -\begin{quote} -\begin{verbatim} -\def\foo{\futurelet\next\@r@foo} -\def\@r@foo{\ifx\next[% - \let\next\@x@foo - \else - \def\next{\@x@foo[boo]}% - \fi - \next -} -\def\@x@foo[#1]#2{...#1...#2...} -\end{verbatim} -\end{quote} - -\Question[Q-empty]{Detecting that something is empty} - -Suppose you need to know that the argument of your command is empty: -that is, to distinguish between \cmdinvoke{cmd}{\relax} % \relax doesn't print -and \cmdinvoke{cmd}{blah}. This is pretty simple: -\begin{quote} -\begin{verbatim} -\def\cmd#1{% - \def\tempa{}% - \def\tempb{#1}% - \ifx\tempa\tempb - <empty case> - \else - <non-empty case> - \fi -} -\end{verbatim} -\end{quote} -The case where you want to ignore an argument that consists of nothing -but spaces, rather than something completely empty, is more tricky. -It's solved in the code fragment \Package{ifmtarg}, which defines -commands \csx{@ifmtarg} and \csx{@ifnotmtarg}, which examine their -first argument, and select (in opposite directions) their second or -third argument. The package's code also appears in the \LaTeX{} -\Class{memoir} class. - -\Package{Ifmtarg} makes challenging reading; there's also a discussion of the -issue in number two of the ``around the bend'' articles by the late -lamented Mike Downes. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Around the bend series]\CTANref{aro-bend} -\item[ifmtarg.sty]\CTANref{ifmtarg} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-ifpdf]{Am I using \PDFTeX{}?} - -It's often useful to know whether your macros are operating within -\PDFTeX{} or within (``normal'') \TeX{}; getting the right answer is -surprisingly tricky. - -Suppose you need to test whether your output will be \acro{PDF} or -\acro{DVI}. The natural thing is to check whether you have access to -some \PDFTeX{}-only primitive; a good one to try (not least because it -was present in the very first releases of \PDFTeX{}) is -\csx{pdfoutput}. So you try -\begin{quote} -\begin{verbatim} -\ifx\pdfoutput\undefined - ... % not running PDFTeX -\else - ... % running PDFTeX -\fi -\end{verbatim} -\end{quote} -Except that neither branch of this conditional is rock-solid. The -first branch can be misleading, since the ``awkward'' user could have -written: -\begin{quote} -\begin{verbatim} -\let\pdfoutput\undefined -\end{verbatim} -\end{quote} -so that your test will falsely choose the first alternative. While -this is a theoretical problem, it is unlikely to be a major one. - -More important is the user who loads a package that uses -\LaTeX{}-style testing for the command name's existence (for example, -the \LaTeX{} \Package{graphics} package, which is useful even to the -\plaintex{} user). Such a package may have gone ahead of you, so the -test may need to be elaborated: -\begin{quote} -\begin{verbatim} -\ifx\pdfoutput\undefined - ... % not running PDFTeX -\else - \ifx\pdfoutput\relax - ... % not running PDFTeX - \else - ... % running PDFTeX - \fi -\fi -\end{verbatim} -\end{quote} -If you only want to know whether some \PDFTeX{} extension (such as -marginal kerning) is present, you can stop at this point: you know as -much as you need. - -However, if you need to know whether you're creating \acro{PDF} -output, you also need to know about the value of \csx{pdfoutput}: -\begin{quote} -\begin{verbatim} -\ifx\pdfoutput\undefined - ... % not running PDFTeX -\else - \ifx\pdfoutput\relax - ... % not running PDFTeX - \else - % running PDFTeX, with... - \ifnum\pdfoutput>0 - ... % PDF output - \else - ... % DVI output - \fi - \fi -\fi -\end{verbatim} -\end{quote} -The above is, in essence, what Heiko Oberdiek's \Package{ifpdf} -package does; the reasoning is the \acro{FAQ}'s interpretation of -Heiko's explanation. - -As an aside: there are now analogous packages \Package{ifxetex} and -\Package{ifluatex}, for the two up-and-coming \TeX{}-like engines (see -the ``\TeX{} project'' answers covering % ! line break -\Qref[\xetex{}~--- question]{\xetex{}}{Q-xetex}, and -\Qref[\LuaTeX{}~--- question]{\LuaTeX{}}{Q-luatex}). -\begin{ctanrefs} -\item[ifpdf.sty]Distributed with Heiko Oberdiek's packages \CTANref{oberdiek} -\item[ifluatex.sty]Distributed with Heiko Oberdiek's packages - \CTANref{oberdiek} -\item[ifxetex.sty]\CTANref{ifxetex} -\end{ctanrefs} - -\Question[Q-subverttoks]{Subverting a token register} - -A common requirement is to ``subvert'' a token register that other -macros may use. The requirement arises when you want to add something -to a system token register (\csx{output} or \csx{every*}), but know -that other macros use the token register, too. (A common requirement -is to work on \csx{everypar}, but \LaTeX{} changes \csx{everypar} at -every touch and turn.) - -The following technique, due to David Kastrup, does what you need, and -allows an independent package to play the exact same game: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\let\mypkg@@everypar\everypar -\newtoks\mypkg@everypar -\mypkg@everypar\expandafter{\the\everypar} -\mypkg@@everypar{\mypkgs@ownstuff\the\mypkg@everypar} -\def\mypkgs@ownstuff{% - <stuff to do at the start of the token register>% -} -\let\everypar\mypkg@everypar -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\let\mypkg@@everypar\everypar -\newtoks\mypkg@everypar -\mypkg@everypar\expandafter{\the\everypar} -\mypkg@@everypar{\mypkgs@ownstuff - \the\mypkg@everypar} -\def\mypkgs@ownstuff{% - <stuff to do at the start of - the token register>% -} -\let\everypar\mypkg@everypar -\end{verbatim} -\end{narrowversion} -\end{quote} -As you can see, the package (\Package{mypkg}) -\begin{itemize} -\item creates an alias for the existing ``system'' \csx{everypar} - (which is frozen into any surrounding environment, which will carry - on using the original); -\item creates a token register to subvert \csx{everypar} and - initialises it with the current contents of \csx{everypar}; -\item sets the ``old'' \csx{everypar} to execute its own extra code, - as well as the contents of its own token register; -\item defines the macro for the extra code; and -\item points the token \csx{everypar} at the new token register. -\end{itemize} -and away we go. - -The form \csx{mypkg@...} is (sort of) blessed for \LaTeX{} package -internal names, which is why this example uses macros of that form. - -\Question[Q-isdef]{Is this command defined?} - -Macro sets from the earliest days of \TeX{} programming may be -observed to test whether commands exist by using -\begin{quote} -\csx{ifx} \csx{}\texttt{\emph{command}} \csx{undefined} \meta{stuff} \dots{} -\end{quote} -(which of course actually tests that the command \emph{doesn't} -exist). \LaTeX{} programmers can make use of the internal command -\begin{quote} - \cmdinvoke*{@ifundefined}{cmd name}{action1}{action2} -\end{quote} -which executes \texttt{action1} if the command is undefined, and -\texttt{action2} if it is defined -(\emph{cmd name} is the command name only, omitting the `|\|' character). - -The \csx{@ifundefined} command is based on the sequence -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\expandafter - \ifx\csname cmd name\endcsname\relax -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\expandafter \ifx \csname cmd name\endcsname \relax -\end{verbatim} -\end{wideversion} -\end{quote} -which relies on the way \csx{csname} works: if the command doesn't -exist, it simply creates it as an alias for \csx{relax}. - -So: what is wrong with these techniques? - -Using \csx{undefined} blithely assumes that the command is indeed not -defined. This isn't entirely safe; one could make the name more -improbable, but that may simply make it more difficult to spot a -problem when things go wrong. \LaTeX{} programmers who use the -technique will typically employ \csx{@undefined}, adding a single -level of obscurity. - -The \csx{@ifundefined} mechanism has the unfortunate property of -polluting the name space: each test that turns out undefined adds a -name to the set \TeX{} is holding, and often all those ``\csx{relax}'' -names serve no purpose whatever. Even so (sadly) there are places in -the code of \LaTeX{} where the existence of the \csx{relax} is relied -upon, after the test, so we can't get away from \csx{@ifundefined} -altogether. - -David Kastrup offers the (rather tricky) -\begin{quote} -\begin{wideversion} -\begin{verbatim} -{\expandafter}\expandafter\ifx \csname cmd name\endcsname\relax ... -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -{\expandafter}\expandafter - \ifx \csname cmd name\endcsname \relax ... -\end{verbatim} -\end{narrowversion} -\end{quote} -which ``creates'' the \csx{relax}-command inside the group of the first -\csx{expandafter}, therefore forgets it again once the test is done. -The test is about as good as you can do with macros. - -The \Qref*{\eTeX{} system}{Q-etex} system comes to our help here: it -defines two new primitives: -\begin{itemize} -\item \csx{ifdefined}, which tests whether a thing is defined (the - negative of comparing with \csx{undefined}, as it were), and -\item \csx{ifcsname} \texttt{cmd name}\csx{endcsname}, which does the - negative of \csx{@ifundefined} without the \csx{relax}-command - side-effect. -\end{itemize} -So, in an \eTeX{}-based system, the following two conditional clauses do -the same thing: -\begin{quote} -\begin{verbatim} -\ifdefined\foo - \message{\string\foo\space is defined}% -\else - \message{no command \string\foo}% -\fi -% -\ifcsname foo\endcsname - \message{\string\foo\space is defined}% -\else - \message{no command \string\foo}% -\fi -\end{verbatim} -\end{quote} -However, after using the \LaTeX{} -\cmdinvoke{@ifundefined}{foo}\dots{}, the conditionals will detect the -command as ``existing'' (since it has been \csx{let} to \csx{relax}); -so it is important not to mix mechanisms for detecting the state of a -command. - -Since most distributions nowadays use \eTeX{} as their base executable -for most packages, these two primitives may be expected appear widely -in new macro packages. - -\subsection{\LaTeX{} macro tools and techniques} - -\Question[Q-plninltx*]{Using Plain or primitive commands in \LaTeX{}} - -It's well-known that \LaTeX{} commands tend to be more complex, and to -run more slowly than, any \plaintex{} (or primitive) command that they -replace. There is therefore great temptation not to use \LaTeX{} -commands when macro programming. Nevertheless, the general rule is -that you should use \LaTeX{} commands, if there are seeming -equivalents. The exception is when you are sure you know the -differences between the two commands and you know that you need the -\plaintex{} version. So, for example, use \csx{mbox} in place of \csx{hbox} -unless you know that the extras that \LaTeX{} provides in \csx{mbox} -would cause trouble in your application. Similarly, use -\csx{newcommand} (or one of its relatives) unless you need one of the -constructs that cannot be achieved without the use of \csx{def} (or friends). - -As a general rule, any \LaTeX{} text command will start a new -paragraph if necessary; this isn't the case with \plaintex{} -commands, a fact which has a potential to confuse. - -The commands \csx{smallskip}, \csx{medskip} and \csx{bigskip} exist both -in \plaintex{} and \LaTeX{}, but behave slightly differently: in -\plaintex{} they terminate the current paragraph, but in \LaTeX{} they -don't. The command \csx{line} is part of picture mode in \LaTeX{}, -whereas it's defined as ``\csx{hbox}\texttt{ to }\csx{hsize}'' in -\plaintex{}. (There's no equivalent for users of the \plaintex{} command in -\LaTeX{}: an equivalent appears as the internal command \csx{@@line}). - -Maths setting shows a case where the \LaTeX{} version \emph{is} -essentially equivalent to the \TeX{} primitive commands: the \LaTeX{} -\csx{(}\texttt{\ ...\ }\csx{)} does essentially no different to the -\TeX{} \texttt{\$\ ...\ \$} -(except for checking that you're not attempting to open a maths -environment when you're already in one, or vice versa). % ! line break -However, \csx{[}\texttt{\ ...\ }\csx{]} \emph{isn't} the same as -\texttt{\$\$\ ...\ \$\$}: the \TeX{} version, used -in \LaTeX{}, can miss the effect of the class option \pkgoption{fleqn}. - -Font handling is, of course, wildly different in \plaintex{} and -\LaTeX{}. \plaintex{}'s font loading command -(\csx{font}\csx{foo=}\meta{fontname}) and its \LaTeX{} equivalent -(\csx{newfont}) should be avoided wherever possible. They are only -safe in the most trivial contexts, and are potential sources of great -confusion in many circumstances. Further discussion of this issue -may be found in ``\Qref*{What's wrong with \csx{newfont}?}{Q-newfont*}''. -%% -%% Consider \csx{vskip} (or \plaintex{} users of it like \csx{medskip}) -%% \emph{vs}.\nothtml{\@} \csx{vspace} or \csx{vspace*}, but most -%% especially \csx{addvspace}. -%% \begin{ctanrefs} -%% \item[fntguide.pdf]\CTANref{fntguide.pdf} -%% \item[fntguide.tex]Distributed with \CTANref{latex} -%% \end{ctanrefs} - -\Question[Q-atsigns]{\csx{@} and \texttt{@} in macro names} - -Macro names containing \texttt{@} are \emph{internal} to \LaTeX{}, and -without special treatment just don't work in ordinary use. A nice -example of the problems caused is discussed in % ! beware line break -\Qref*{\csx{@} in vertical mode}{Q-atvert}''. - -The problems users see are caused by copying bits of a class -(\extension{cls} file) or -package (\extension{sty} file) into a document, or by including a class or -package file into a \LaTeX{} document by some means other than -\csx{documentclass} or \csx{usepackage}. \LaTeX{} defines internal -commands whose names contain the character \texttt{@} to -avoid clashes between its internal names and names that we would -normally use in our documents. In order that these commands may work -at all, \csx{documentclass} and \csx{usepackage} play around with the -meaning of \texttt{@}. - -If you've included a file some other way (for example, using -\csx{input}), you can probably solve the problem by using the correct -command. - -If you're using a fragment of a package or class, you may well feel -confused: books such as the first edition of the % ! line break -\Qref*{The \LaTeX{} Companion}{Q-books} -are full of fragments of packages as examples for you to employ. -The second edition of the \emph{Companion} makes clearer how you -should use these fragments, and in addition, the code of -all the examples is now available on \acro{CTAN}. -To see the technique in practice, look at the example below, from file -\File{2-2-7.ltx} in the \emph{Companion} examples directory: -\begin{quote} -\begin{verbatim} -\makeatletter -\renewcommand\subsection{\@startsection - {subsection}{2}{0mm}%name, level, indent - {-\baselineskip}% beforeskip - {0.5\baselineskip}% afterskip - {\normalfont\normalsize\itshape}}% style -\makeatother -\end{verbatim} -\end{quote} -(That example appears on page 29 of \emph{The \LaTeX{} Companion}, -second edition.) - -The alternative is to treat all these fragments as a package proper, -bundling them up into a \extension{sty} file and including them with -\csx{usepackage}; this way you hide your \LaTeX{} internal code somewhere -that \LaTeX{} internal code is expected, which often looks `tidier'. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}Examples from the Companion]\CTANref{tlc2} -\end{ctanrefs} - -\Question[Q-protect]{What's the reason for `protection'?} - -Sometimes \LaTeX{} saves data it will reread later. These data are -often the argument of some command; they are the so-called moving -arguments. (`Moving' because data are moved around.) Candidates -are all arguments that may go into table of contents, list of figures, -\emph{etc}.; namely, data that are written to an auxiliary file and -read in later. Other places are those data that might appear in head- -or footlines. Section headings and figure captions are the most -prominent examples; there's a complete list in Lamport's book -(see \Qref[question]{\TeX{}-related books}{Q-books}). - -What's going on really, behind the scenes? The commands in moving -arguments are normally expanded to their internal structure during the -process of saving. Sometimes this expansion results in invalid \TeX{} -code, which shows either during expansion or when the code is -processed again. Protecting a command, using -``\csx{protect}\csx{cmd}'' tells \LaTeX{} to save \csx{cmd} as -\csx{cmd}, without expanding it at all. - -So, what is a `fragile command'?~--- it's a command that expands into -illegal \TeX{} code during the save process. - -What is a `robust command'?~--- it's a command that expands into legal -\TeX{} code during the save process. - -Lamport's book says in its description of every LaTeX command whether -it is `robust' or `fragile'; it also says that every command with an -optional argument is fragile. The list isn't reliable, and neither -is the assertion about optional arguments; the statements may have -been true in early versions of \LaTeXe{} but are not any longer -necessarily so: -\begin{itemize} -\item Some fragile commands, such as \csx{cite}, have been made robust - in later revisions of \LaTeX{}. -\item Some commands, such as \csx{end} and \csx{nocite}, are fragile - even though they have no optional arguments. -\item The ``user's way'' of creating a command with an optional - argument (using \csx{newcommand} or \csx{newcommand*}) now always - creates a robust command (though macros without optional arguments - may still be fragile if they do things that are themselves fragile). -\item There is no reason that a package author should not also make - robust commands with optional arguments as part of the package. -\item Some robust commands are redefined by certain packages to be - fragile (the \csx{cite} command commonly suffers this treatment). -\end{itemize} -Further, simply ``hiding'' a fragile command in another command, has -no effect on fragility. So, if \csx{fred} is fragile, and you write: -\begin{quote} -\begin{verbatim} -\newcommand{\jim}{\fred} -\end{verbatim} -\end{quote} -then \csx{jim} is fragile too. There is, however, the -\csx{newcommand}-replacement \csx{DeclareRobustCommand}, which -\emph{always} creates a robust command (whether or not it has optional -arguments). The syntax of \csx{DeclareRobustCommand} is substantially -identical to that of \csx{newcommand}, and if you do the wrapping -trick above as: -\begin{quote} -\begin{verbatim} -\DeclareRobustCommand{\jim}{\fred} -\end{verbatim} -\end{quote} -then \csx{jim} is robust. - -Finally, we have the \Package{makerobust} package, which defines -\csx{MakeRobustCommand} to convert a command to be robust. With the -package, the ``wrapping'' above can simply be replaced by: -\begin{quote} -\begin{verbatim} -\MakeRobustCommand\fred -\end{verbatim} -\end{quote} -Whereafter, \csx{fred} is robust. Using the package may be reasonable -if you have lots of fragile commands that you need to use in moving -arguments. - -In short, the situation is confusing. No-one believes this is -satisfactory; the \LaTeX{} team have removed the need for -protection of some things, but the techniques available in -current \LaTeX{} mean that this is an expensive exercise. It remains -a long-term aim of the team to remove all need for \csx{protect}ion. -\begin{ctanrefs} -\item[makerobust.sty]Distributed with Heiko Oberdiek's packages - \CTANref{oberdiek} -\end{ctanrefs} - -\Question[Q-edef]{\csx{edef} does not work with \csx{protect}} - -Robust \LaTeX{} commands are either ``naturally robust''~--- meaning that -they never need \csx{protect}, or ``self-protected''~--- meaning that -they have \csx{protect} built in to their definition in some -way. Self-protected commands, and fragile commands with -\csx{protect}ion are only robust in a context where the \csx{protect} -mechanism is properly handled. The body of an \csx{edef} definition -doesn't handle \csx{protect} properly, since \csx{edef} is a \TeX{} -primitive rather than a \LaTeX{} command. - -This problem is resolved by a \LaTeX{} internal command -\csx{protected@edef}, which does the job of \csx{edef} while keeping the -\csx{protect} mechanism working. There's a corresponding -\csx{protected@xdef} which does the job of \csx{xdef}. - -Of course, these commands need to be tended carefully, since they're -% beware line break on next line -internal: see \Qref[question]{'@' in control sequence names}{Q-atsigns}. - -\Question[Q-ltxcmds]{The definitions of \LaTeX{} commands} - -There are several reasons to want to know the definitions of \LaTeX{} -commands: from the simplest ``idle curiosity'', to the pressing need -to patch something to make it ``work the way you want it''. None of -these are \emph{pure} motives, but knowledge and expertise seldom -arrive through the purest of motives. - -The simple answer is to try \csx{show}, in a run of \LaTeX{} that is -taking commands from the terminal: -\begin{quote} -\begin{verbatim} -*\makeatletter -*\show\protected@edef -> \protected@edef=macro: -->\let \@@protect \protect - \let \protect \@unexpandable@protect - \afterassignment \restore@protect \edef . -\end{verbatim} -\end{quote} -(I've rearranged the output there, from the rather confused version -\TeX{} itself produces.) We may perhaps, now, wonder about -\csx{@unexpandable@protect}: -\begin{quote} -\begin{verbatim} -*\show\@unexpandable@protect -> \@unexpandable@protect=macro: -->\noexpand \protect \noexpand . -\end{verbatim} -\end{quote} -and we're starting to see how one part of the \csx{protect}ion -mechanism works (one can probably fairly safely guess what -\csx{restore@protect} does). - -Many kernel commands are declared robust: -\begin{quote} -\begin{verbatim} -*\show\texttt -> \texttt=macro: -->\protect \texttt . -\end{verbatim} -\end{quote} -so that \csx{show} isn't much help. Define a command \csx{pshow} as -shown below, and use that instead: -\begin{quote} -\begin{verbatim} -*\def\pshow#1{{\let\protect\show #1}} -*\pshow\texttt -> \texttt =\long macro: -#1->\ifmmode \nfss@text {\ttfamily #1}% - \else \hmode@bgroup \text@command {#1}% - \ttfamily \check@icl #1\check@icr - \expandafter \egroup \fi . -\end{verbatim} -\end{quote} -Note that the command name that is protected is the `base' command, -with a space appended. This is cryptically visible, in a couple of -places above. (Again, the output has been sanitised.) - -If one has a malleable text editor, the same investigation may more -comfortably be conducted by examining the file \File{latex.ltx} (which -is usually to be found, in a \acro{TDS} system, in directory -\path{tex/latex/base}). - -In fact, \File{latex.ltx} is the product of a \ProgName{docstrip} -process on a large number of \Qref*{\extension{dtx} files}{Q-dtx}, and -you can refer to those instead. The \LaTeX{} distribution includes a file -\File{source2e.tex}, and most systems retain it, again in -\path{tex/latex/base}. \File{Source2e.tex} may be processed to -provide a complete source listing of the \LaTeX{} kernel (in fact the -process isn't entirely straightforward, but the file produces messages -advising you what to do). The result is a huge document, with a -line-number index of control sequences the entire kernel and a -separate index of changes recorded in each of the files since the -\LaTeX{} team took over. - -The printed kernel is a nice thing to have, but it's unwieldy and sits -on my shelves, seldom used. One problem is that the comments are -patchy: the different modules range from well and lucidly documented, -through modules documented only through an automatic process that -converted the documentation of the source of \LaTeXo{}, to modules -that hardly had any useful documentation even in the \LaTeXo{} original. - -In fact, each kernel module \extension{dtx} file will process separately -through \LaTeX{}, so you don't have to work with the whole of -\File{source2e}. You can easily determine which module defines the -macro you're interested in: use your ``malleable text editor'' to find -the definition in \File{latex.ltx}; then search backwards from that -point for a line that starts % ! line break -\texttt{\textpercent\textpercent\textpercent\ From File:}~--- that line -tells you which \extension{dtx} file contains the definition you are interested -in. Doing this for \csx{protected@edef}, we find: -\begin{quote} -\begin{verbatim} -%%% From File: ltdefns.dtx -\end{verbatim} -\end{quote} -When we come to look at it, \File{ltdefns.dtx} proves to contain -quite a dissertation on the methods of handling \csx{protect}ion; it -also contains some automatically-converted \LaTeXo{} documentation. - -And of course, the kernel isn't all of \LaTeX{}: your command may be -defined in one of \LaTeX{}'s class or package files. For example, we -find a definition of \csx{thebibliography} in \Class{article}, but -there's no \File{article.dtx}. Some such files are generated from -parts of the kernel, some from other files in the distribution. You -find which by looking at the start of the file: in \File{article.cls}, -we find: -\begin{quote} -\begin{verbatim} -%% This is file `article.cls', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% classes.dtx (with options: `article') -\end{verbatim} -\end{quote} -so we need to format \File{classes.dtx} to see the definition in -context. - -All these .dtx files are on \acro{CTAN} as part of the main \LaTeX{} -distribution. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\LaTeX{} distribution]\CTANref{latex} -\end{ctanrefs} - -\Question[Q-oarglikesect]{Optional arguments like \csx{section}} - -Optional arguments, in macros defined using \csx{newcommand}, don't -quite work like the optional argument to \csx{section}. The default -value of \csx{section}'s optional argument is the value of the -mandatory argument, but \csx{newcommand} requires that you `know' the -value of the default beforehand. - -The requisite trick is to use a macro in the optional argument: -\begin{quote} -\begin{verbatim} -\documentclass{article} -\newcommand\thing[2][\DefaultOpt]{% - \def\DefaultOpt{#2}% - optional arg: #1, mandatory arg: #2% -} -\begin{document} -\thing{manda}% #1=#2 - -\thing[opti]{manda}% #1="opti" -\end{document} -\end{verbatim} -\end{quote} -\LaTeX{} itself has a trickier (but less readily understandable) -method, using a macro \csx{@dblarg}; inside \LaTeX{}, the example -above would have been programmed: -\begin{quote} -\begin{verbatim} -\newcommand\thing{\@dblarg\@thing} -\newcommand\@thing[2][\@error]{% - optional arg: #1, mandatory arg: #2% -} -\end{verbatim} -\end{quote} -In that code, \csx{@thing} is only ever called with an optional and a -mandatory argument; if the default from the \csx{newcommand} is -invoked, a bug in user code has bitten\dots{} - -\Question[Q-twooptarg]{More than one optional argument} - -If you've already read % ! line break -``\Qref*[question]{breaking the 9-argument limit}{Q-moren9}''. -you can probably guess the ``simple'' solution to this problem: -command relaying. - -\LaTeX{} allows commands with a single optional argument thus: -\begin{verbatim} - \newcommand{\blah}[1][Default]{...} -\end{verbatim} - -You may legally call such a command either with its optional argument -present, as -\cmdinvoke{blah}[nonDefault] or without, as \csx{blah}; in the latter -case, the code of \csx{blah} will have an argument of |Default|. - -To define a command with two optional arguments, we use the relaying -technique, as follows: -\begin{verbatim} - \newcommand{\blah}[1][Default1]{% - \def\ArgI{{#1}}% - \BlahRelay - } - \newcommand\BlahRelay[1][Default2]{% - % the first optional argument is now in - % \ArgI - % the second is in #1 - ...% - } -\end{verbatim} -Of course, \csx{BlahRelay} may have as many mandatory arguments as are -allowed, after allowance for the one taken up with its own -optional argument~--- that is, 8. - -Variants of \csx{newcommand} (and friends), with names like -\csx{newcommandtwoopt}, are available in the \Package{twoopt} package. -However, if you can, it's probably better to learn to write the commands -yourself, just to see why they're not even a good idea from the -programming point of view. - -A command with two optional arguments strains the limit of what's -sensible: obviously you can extend the technique to provide as many -optional arguments as your fevered imagination can summon. However, -see the comments on the use of the \Package{keyval} package, in -``\Qref*[question]{breaking the 9-argument limit}{Q-moren9}'', -which offers an alternative way forward. - -If you must, however, consider the \Package{optparams} or -\Package{xargs} packages. \Package{Optparams} -provides a \csx{optparams} command that you use as an intermediate in -defining commands with up to nine optional arguments. The -documentation shows examples of commands with four optional arguments -(and this from an author who has his own key-value package!). - -The \Package{xargs} package uses a key-value package -(\Package{xkeyval}) to \emph{define} the layout of the optional -arguments. Thus -\begin{quote} -\begin{verbatim} -\usepackage{xargs} -... -\newcommandx{\foo}[3][1=1, 3=n]{...} -\end{verbatim} -\end{quote} -defines a command \csx{foo} that has an optional first argument -(default 1), a mandatory second argument, and an optional third -argument (default n). - -An alternative approach is offered by Scott Pakin's -\ProgName{newcommand} program, which takes a command name and a -definition of a set of command arguments (in a fairly -readily-understood language), and emits \AllTeX{} macros which enable -the command to be defined. The command requires that a -\ProgName{Python} interpreter (etc.\@) be installed on your computer. -\begin{ctanrefs} -\item[newcommand.py]\CTANref{newcommand} -\item[optparams.sty]Distributed as part of \CTANref{sauerj} -\item[twoopt.sty]Distributed as part of \CTANref{oberdiek} -\item[xargs.sty]\CTANref{xargs} -\item[xkeyval.sty]\CTANref{xkeyval} -\end{ctanrefs} - -\Question[Q-cmdstar]{Commands defined with * options} - -\LaTeX{} commands commonly have ``versions'' defined with an asterisk -tagged onto their name: for example \csx{newcommand} and -\csx{newcommand*} (the former defines a \csx{long} version of the -command). - -The simple-minded way for a user to write such a command involves use -of the \Package{ifthen} package: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\newcommand{\mycommand}[1]{\ifthenelse{\equal{#1}{*}}% - {\mycommandStar}% - {\mycommandNoStar{#1}}% -} -\newcommand{\mycommandStar}{starred version} -\newcommand{\mycommandNoStar}[1]{normal version} -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -\newcommand{\mycommand}[1]{% - \ifthenelse{\equal{#1}{*}}% - {\mycommandStar}% - {\mycommandNoStar{#1}}% -} -\newcommand{\mycommandStar}% - {starred version} -\newcommand{\mycommandNoStar}[1]% - {normal version} -\end{verbatim} -\end{quote} -\end{narrowversion} -This does the trick, for sufficiently simple commands, but it has -various tiresome failure modes, and it requires \csx{mycommandnostar} -to take an argument. - -Of course, the \LaTeX{} kernel has something slicker than this: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\newcommand{\mycommand}{\@ifstar - \mycommandStar% - \mycommandNoStar% -} -\newcommand{\mycommandStar}[2]{starred version} -\newcommand{\mycommandNoStar}[1]{normal version} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\newcommand{\mycommand}{\@ifstar - \mycommandStar% - \mycommandNoStar% -} -\newcommand{\mycommandStar}[2]{starred version} -\newcommand{\mycommandNoStar}[1]{normal version} -\end{verbatim} -\end{narrowversion} -\end{quote} -(Note that arguments to \csx{mycommandStar} and \csx{mycommandNoStar} -are independent~--- either can have their own arguments, unconstrained -by the technique we're using, unlike the trick described above.) -The \csx{@ifstar} trick is all very well, is fast and efficient, but -it requires the definition to be % ! line break -\Qref*{\csx{makeatletter} protected}{Q-atsigns}. - -A pleasing alternative is the \Package{suffix} package. This elegant -piece of code allows you to define variants of your commands: -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -\newcommand\mycommand{normal version} -\WithSuffix\newcommand\mycommand*% - {starred version} -\end{verbatim} -\end{quote} -\end{narrowversion} -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\newcommand\mycommand{normal version} -\WithSuffix\newcommand\mycommand*{starred version} -\end{verbatim} -\end{quote} -\end{wideversion} -The package needs \Qref*{\elatex{}}{Q-etex}, but any new enough -distribution defines \LaTeX{} as \elatex{} by default. Command -arguments may be specified in the normal way, in both command -definitions (after the ``\texttt{*}'' in the \csx{WithSuffix} -version). You can also use the \TeX{} primitive commands, creating a -definition like: -\begin{quote} -\begin{verbatim} -\WithSuffix\gdef\mycommand*{starred version} -\end{verbatim} -\end{quote} -\begin{ctanrefs} -\item[ifthen.sty]Part of the \LaTeX{} distribution -\item[suffix.sty]Distributed as part of \CTANref{bigfoot} -\end{ctanrefs} - -\nothtml{\hrule height 0pt \nobreak\vskip0pt plus2.5in\vskip 0pt\relax} -\Question[Q-ltxabbrv]{\LaTeX{} internal ``abbreviations'', etc.} - -In the deeps of time, when \TeX{} first happened, computers had -extremely limited memory, and were (by today's standards) painfully -slow. When \LaTeX{} came along, things weren't much better, and even -when \LaTeXe{} appeared, there was a strong imperative to save memory -space (and to a lesser extent) \acro{CPU} time. - -From the very earliest days, Knuth used shortcut macros to speed -things up. \LaTeX{}, over the years, has extended Knuth's list by a -substantial amount. An interesting feature of the ``abbreviations'' is -that on paper, they may look longer than the thing they stand for; -however, to \AllTeX{} they \emph{feel} smaller\dots{} - -The table at the end of this answer lists the commonest of these -``abbreviations''. It is not complete; as always, if the table -doesn't help, try the \LaTeX{} source. The table lists each -abbreviation's \emph{name} and its \emph{value}, which provide most of -what a user needs to know. The table also lists the abbreviation's -\emph{type}, which is a trickier concept: if you need to know, the -only real confusion is that the abbreviations labelled `defn' are -defined using an \csx{\emph{xxx}def} command. - -\begin{tabular}{lll} -Name \tbamp Type \tbamp Value \tbeol -\tbhline -\csx{m@ne} \tbamp count \tbamp \ensuremath{-1} \tbeol -\csx{p@} \tbamp dimen \tbamp 1pt \tbeol -\csx{z@} \tbamp dimen \tbamp 0pt \tbeol -\csx{z@skip} \tbamp skip \tbamp 0pt plus 0pt minus 0pt \tbeol -\tbhline -\csx{@ne} \tbamp defn \tbamp 1 \tbeol -\csx{tw@} \tbamp defn \tbamp 2\tbeol -\csx{thr@@} \tbamp defn \tbamp 3 \tbeol -\csx{sixt@@n} \tbamp defn \tbamp 16 \tbeol -\csx{@cclv} \tbamp defn \tbamp 255 \tbeol -\csx{@cclvi} \tbamp defn \tbamp 256 \tbeol -\csx{@m} \tbamp defn \tbamp 1000 \tbeol -\csx{@M} \tbamp defn \tbamp 10000 \tbeol -\csx{@MM} \tbamp defn \tbamp 20000 \tbeol -\tbhline -\csx{@vpt} \tbamp macro \tbamp 5 \tbeol -\csx{@vipt} \tbamp macro \tbamp 6 \tbeol -\csx{@viipt} \tbamp macro \tbamp 7 \tbeol -\csx{@viiipt} \tbamp macro \tbamp 8 \tbeol -\csx{@ixpt} \tbamp macro \tbamp 9 \tbeol -\csx{@xpt} \tbamp macro \tbamp 10 \tbeol -\csx{@xipt} \tbamp macro \tbamp 10.95 \tbeol -\csx{@xiipt} \tbamp macro \tbamp 12 \tbeol -\csx{@xivpt} \tbamp macro \tbamp 14.4 \tbeol -\csx{@xviipt} \tbamp macro \tbamp 17.28 \tbeol -\csx{@xxpt} \tbamp macro \tbamp 20.74 \tbeol -\csx{@xxvpt} \tbamp macro \tbamp 24.88 \tbeol -\tbhline -\csx{@plus} \tbamp macro \tbamp ``\texttt{plus}'' \tbeol -\csx{@minus} \tbamp macro \tbamp ``\texttt{minus}'' \tbeol -%\csx{hb@xt@} \tbamp macro \tbamp ``\csx{hbox} \texttt{to}'' -\end{tabular} - -\Question[Q-ltxhash]{Defining \LaTeX{} commands within other commands} - -\LaTeX{} command definition is significantly different from the \TeX{} -primitive form discussed in an % ! line break -\Qref*[\htmlonly]{earlier question}{Q-hash} about definitions within -macros. - -In most ways, the \LaTeX{} situation is simpler (at least in part -because it imposes more restrictions on the user); however, defining a -command within a command still requires some care. - -The earlier question said you have to double the |#| signs in command -definitions: in fact, the same rule holds, except that \LaTeX{} -already takes care of some of the issues, by generating argument lists -for you. - -The basic problem is that: -\begin{quote} -\begin{verbatim} -\newcommand{\abc}[1]{joy, oh #1!% - \newcommand{\ghi}[1]{gloom, oh #1!}% -} -\end{verbatim} -\end{quote} -followed by a call: -\begin{quote} -\begin{verbatim} -\cmdinvoke{abc}{joy} -\end{verbatim} -\end{quote} -typesets ``joy, oh joy!'', but defines a command \csx{ghi} that takes -one parameter, which it ignores; \cmdinvoke{ghi}{gloom} will expand to -``gloom, oh joy!'', which is presumably not what was expected. - -And (as you will probably guess, if you've read the earlier question) -the definition: -\begin{quote} -\begin{verbatim} -\newcommand{\abc}[1]{joy, oh #1!% - \newcommand{\ghi}[1]{gloom, oh ##1!}% -} -\end{verbatim} -\end{quote} -does what is required, and \cmdinvoke{ghi}{gloom} will expand to -``gloom, oh gloom!'', whatever the argument to \csx{abc}. - -The doubling is needed whether or not the enclosing command has an -argument, so: -\begin{quote} -\begin{verbatim} -\newcommand{\abc}{joy, oh joy!% - \newcommand{\ghi}[1]{gloom, oh ##1!}% -} -\end{verbatim} -\end{quote} -is needed to produce a replica of the \csx{ghi} we defined earlier. - -\subsection{\LaTeX{} macro programming} - -\Question[Q-fixnam]{How to change \LaTeX{}'s ``fixed names''} - -\LaTeX{} document classes define several typographic operations that -need `canned text' (text not supplied by the user). In the earliest -days of \LaTeXo{} these bits of text were built in to the body of -\LaTeX{}'s macros and were rather difficult to change, but ``fixed -name'' macros were introduced for the benefit of those wishing to use -\LaTeX{} in languages other than English. -For example, the special section produced by the \csx{tableofcontents} -command is always called \csx{contentsname} (or rather, what -\csx{contentsname} is defined to mean). -Changing the canned text is now one of the easiest customisations a -user can do to \LaTeX{}. - -The canned text macros are all of the form -\csx{\meta{thing}name}, and changing them is simplicity -itself. Put: -\begin{quote} -\cmdinvoke{renewcommand}{\csx{\meta{thing}name}}{Res minor} -\end{quote} -in the preamble of your document, and the job is done. -(However, beware of the \Package{babel} package, which requires you to -use a different mechanism: be sure to check -% beware line wrap -\Qref[question]{changing \Package{babel} names}{Q-latexwords} if -you're using it.) - -The names that are defined in the standard \LaTeX{} classes (and the -\Package{makeidx} package) are listed -below. Some of the names are only defined in a subset of the classes -(and the \Class{letter} class has a set of names all of its own); -the list shows the specialisation of each name, where appropriate. - -\nothtml{\noindent}\begin{tabular}{@{}ll} -\csx{abstractname} \tbamp Abstract\tbeol -\csx{alsoname} \tbamp see also (\Package{makeidx} package)\tbeol -\csx{appendixname} \tbamp Appendix\tbeol -\csx{bibname} \tbamp Bibliography (\Class{report},\Class{book})\tbeol -\csx{ccname} \tbamp cc (\Class{letter})\tbeol -\csx{chaptername} \tbamp Chapter (\Class{report},\Class{book})\tbeol -\csx{contentsname} \tbamp Contents\tbeol -\csx{enclname} \tbamp encl (\Class{letter})\tbeol -\csx{figurename} \tbamp Figure (for captions)\tbeol -\csx{headtoname} \tbamp To (\Class{letter})\tbeol -\csx{indexname} \tbamp Index\tbeol -\csx{listfigurename} \tbamp List of Figures\tbeol -\csx{listtablename} \tbamp List of Tables\tbeol -\csx{pagename} \tbamp Page (\Class{letter})\tbeol -\csx{partname} \tbamp Part\tbeol -\csx{refname} \tbamp References (\Class{article})\tbeol -\csx{seename} \tbamp see (\Package{makeidx} package)\tbeol -\csx{tablename} \tbamp Table (for caption) -\end{tabular} - -\Question[Q-latexwords]{Changing the words \Package{babel} uses} - -\LaTeX{} uses symbolic names for many of the automatically-generated -text it produces (special-purpose section headings, captions, etc.). -As noted in \Qref[question]{``\LaTeX fixed names''}{Q-fixnam} (which -includes a list of the names themselves), -this enables the user to change the -names used by the standard classes, which is particularly useful if -the document is being prepared in some language other than \LaTeX{}'s -default English. So, for example, a Danish author may wish that her -table of contents was called ``Indholdsfortegnelse'', and so -would expect to place a command -\begin{verbatim} -\renewcommand{\contentsname}% - {Indholdsfortegnelse} -\end{verbatim} -in the preamble of her document. - -However, it's natural for a user of a non-English language to use -\Package{babel}, because it offers many conveniences and typesetting -niceties for those preparing documents in those languages. In -particular, when \Package{babel} is selecting a new language, it -ensures that \LaTeX{}'s symbolic names are translated appropriately -for the language in question. Unfortunately, \Package{babel}'s choice -of names isn't always to everyone's choice, and there is still a need -for a mechanism to replace the `standard' names. - -Whenever a new language is selected, \Package{babel} resets all the -names to the settings for that language. In particular, -\Package{babel} selects the document's main language when -\cmdinvoke{begin}{document} is executed, which immediately destroys -any changes to these symbolic names made in the prologue of a document -that uses \Package{babel}. - -Therefore, babel defines a command to enable users to change the -definitions of the symbolic names, on a per-language basis: -\csx{addto}\csx{captions}\texttt{\meta{language}} is the thing -(\texttt{\meta{language}} being the language option you gave to -\Package{babel} in the first place). For example: -\begin{verbatim} -\addto\captionsdanish{% - \renewcommand{\contentsname}% - {Indholdsfortegnelse}% -} -\end{verbatim} - -\Question[Q-running-nos]{Running equation, figure and table numbering} - -Many \LaTeX{} classes (including the standard \Class{book} class) -number things per chapter; so figures in chapter 1 are numbered 1.1, -1.2, and so on. Sometimes this is not appropriate for the user's -needs. - -Short of rewriting the whole class, one may use the \Package{chngctr} -package, which provides commands \csx{counterwithin} (which -establishes this nested numbering relationship) and -\csx{counterwithout} (which undoes it). - -So if you have figures numbered by chapter as 1.1, 1.2, 2.1, \dots{}, -the command -\begin{quote} -\begin{verbatim} -\counterwithout{figure}{chapter} -\end{verbatim} -\end{quote} -will convert them to figures 1, 2, 3, \dots{}. (Note that the command -has also removed the chapter number from the counter's definition.) - -More elaborate use could change things numbered per section to things -numbered per chapter: -\begin{quote} -\begin{verbatim} -\counterwithout{equation}{section} -\counterwithin{equation}{chapter} -\end{verbatim} -\end{quote} -(assuming there was a class that did such a thing in the first place...) - -The \Package{chngcntr} approach doesn't involve much programming, and -the enthusiastic \LaTeX{} programmer might choose to try the technique -that we had to use before the advent of \Package{chngcntr}. Each of -the packages \Package{removefr} and \Package{remreset} defines a -\csx{@removefromreset} command, and having included the package one -writes something like: -\begin{quote} -\begin{verbatim} -\makeatletter -\@removefromreset{figure}{chapter} -\makeatother -\end{verbatim} -\end{quote} -and the automatic renumbering stops. You may then need to redefine the -way in which the figure number (in this case) is printed: -\begin{quote} -\begin{verbatim} -\makeatletter -\renewcommand{\thefigure}{\@arabic\c@figure} -\makeatother -\end{verbatim} -\end{quote} -(remember to do the whole job, for every counter you want to -manipulate, within \csx{makeatletter} \dots{}\@ \csx{makeatother}). - -This technique, too, may be used to change where in a multilevel -structure a counter is reset. Suppose your class numbers figures as -\meta{chapter}.\meta{section}.\meta{figure}, and you want figures -numbered per chapter, try: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\makeatletter -\@removefromreset{figure}{section} -\@addtoreset{figure}{chapter} -\renewcommand{\thefigure}{\thechapter.\@arabic\c@figure} -\makeatother -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\makeatletter -\@removefromreset{figure}{section} -\@addtoreset{figure}{chapter} -\renewcommand{\thefigure}% - {\thechapter.\@arabic\c@figure} -\makeatother -\end{verbatim} -\end{narrowversion} -\end{quote} -(the command \csx{@addtoreset} is a part of \LaTeX{} itself). -\begin{ctanrefs} -\item[chngcntr.sty]\CTANref{chngcntr} -\item[memoir.cls]\CTANref{memoir} -\item[removefr.tex]\CTANref{removefr} (note, this is constructed as a - ``fragment'' for use within other packages: load by - \cmdinvoke{input}{removefr}) -\item[remreset.sty]Distributed as part of \CTANref{carlisle} -\end{ctanrefs} - -\Question[Q-labelctr]{Making labels from a counter} - -Suppose we have a \LaTeX{} counter, which we've defined with -\cmdinvoke{newcounter}{foo}. We can increment the value of the counter -by \cmdinvoke{addtocounter}{foo}{1}, but that's pretty clunky for an -operation that happens so often \dots{}~so there's a command -\cmdinvoke{stepcounter}{foo} that does this special case of -increasing-by-one. - -There's an internal \LaTeX{} variable, the ``current label'', that -remembers the last `labellable' thing that \LaTeX{} has processed. -You could (if you were to insist) set that value by the relevant -\TeX{} command (having taken the necessary precautions to ensure that -the internal command worked)~--- but it's not necessary. If, instead -of either of the stepping methods above, you say -\cmdinvoke{refstepcounter}{foo}, the internal variable is set to the -new value, and (until something else comes along), \csx{label} will -refer to the counter. - -\Question[Q-oddpage]{Finding if you're on an odd or an even page} - -\Qref[Question]{Another question}{Q-marginparside} discusses the issue -of getting \csx{marginpar} commands to put their output in the correct -margin of two-sided documents. This is an example of the general -problem of knowing where a particular bit of text lies: the output -routine is asynchronous, and \AllTeX{} will usually process quite a -bit of the ``next'' page before deciding to output any page. As a -result, the |page| counter (known internally in \LaTeX{} as -\csx{c@page}) is normally only reliable when you're actually \emph{in} -the output routine. - -The solution is to use some version of the \csx{label} mechanism to -determine which side of the page you're on; the value of the page -counter that appears in a \csx{pageref} command has been inserted in -the course of the output routine, and is therefore safe. - -However, \csx{pageref} itself isn't reliable: one might hope that -\begin{verbatim} -\ifthenelse{\isodd{\pageref{foo}}}{odd}{even} -\end{verbatim} -would do the necessary, but both the \Package{babel} and -\Package{hyperref} packages have been known to interfere with the -output of \csx{pageref}; be careful! - -The \Package{changepage} package needs to provide this functionality for -its own use, and therefore provides a command \csx{checkoddpage}; this -sets a private-use label, and the page reference part of that label is -then examined (in a \Package{hyperref}-safe way) to set a conditional -\csx{ifoddpage} true if the command was issued on an odd page. The -\Class{memoir} class has the same command setting a conditional -\csx{ifoddpage}. Of course, the \csx{label} contributes to \LaTeX{}'s -``Rerun to get cross-references right'' error messages\dots{} - -The Koma-Script classes have an \environment{addmargin*} environment -that also provides the sorts of facilities that the \Package{changepage} -offers. Koma-Script's supporting command is % !line break -\cmdinvoke{ifthispageodd}{<true>}{<false>} executes different things -depending on the page number. -\begin{ctanrefs} -\item[changepage.sty]\CTANref{changepage} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\item[memoir.cls]\CTANref{memoir} -\end{ctanrefs} - -\Question[Q-labelformat]{How to change the format of labels} - -By default, when a label is created, it takes on the appearance of the -counter labelled, so the label appears as -\csx{the}\texttt{\meta{counter}}~--- what would be used if you -asked to typeset the counter in your text. This isn't always what you -need: for example, if you have nested enumerated lists with the outer -numbered and the inner labelled with letters, one might expect to want -to refer to items in the inner list as ``2(c)''. (Remember, you can -\nothtml{change the structure of list items~--- }% -\Qref{change the structure of list items}{Q-enumerate}.) -The change is of course -possible by explicit labelling of the parent and using that label to -construct the typeset result~--- something like -\begin{quote} -\begin{verbatim} -\ref{parent-item}(\ref{child-item}) -\end{verbatim} -\end{quote} -which would be both tedious and error-prone. What's more, it would be -undesirable, since you would be constructing a visual representation -which is inflexible (you couldn't change all the references to elements -of a list at one fell swoop). - -\LaTeX{} in fact has a label-formatting command built into every label -definition; by default it's null, but it's available for the user to -program. For any label \meta{counter} there's a \LaTeX{} internal -command \csx{p@}\meta{\texttt{counter}}; for example, a label definition -on an inner list item is supposedly done using the command -\cmdinvoke{p@enumii}{\csx{theenumii}}. Unfortunately, the internal -workings of this aren't quite right, and you need to patch the -\csx{refstepcounter} command: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\renewcommand*\refstepcounter[1]{% - \stepcounter{#1}% - \protected@edef\@currentlabel{% - \csname p@#1\expandafter\endcsname - \csname the#1\endcsname - }% -} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\renewcommand*\refstepcounter[1]{\stepcounter{#1}% - \protected@edef\@currentlabel{% - \csname p@#1\expandafter\endcsname - \csname the#1\endcsname - }% -} -\end{verbatim} -\end{wideversion} -\end{quote} -With the patch in place you can now, for example, change the labels on -all inner lists by adding the following code in your preamble: -\begin{quote} -\begin{verbatim} -\makeatletter -\renewcommand{\p@enumii}[1]{\theenumi(#1)} -\makeatother -\end{verbatim} -\end{quote} -This would make the labels for second-level enumerated lists appear as -``1(a)'' (and so on). The analogous change works for any counter that -gets used in a \csx{label} command. - -In fact, the \Package{fncylab} package does all the above (including -the patch to \LaTeX{} itself). With the package, the code above is -(actually quite efficiently) rendered by the command: -\begin{quote} -\begin{verbatim} -\labelformat{enumii}{\theenumi(#1)} -\end{verbatim} -\end{quote} -In fact, the above example, which we can do in several different ways, -has been rendered obsolete by the appearance of the \Package{enumitem} -package, which is discussed in the answer about % ! line break -\Qref*{decorating enumeration lists}{Q-enumerate}. -\begin{ctanrefs} -\item[enumitem.sty]\CTANref{enumitem} -\item[fncylab.sty]\CTANref{fncylab} -\end{ctanrefs} - -\Question[Q-seccntfmt]{Adjusting the presentation of section numbers} - -The general issues of adjusting the appearance of section headings are -pretty complex, and are covered in % beware line breaks (2 lines) -\latexhtml{question}{the question on} -\Qref[\htmlonly]{the style of section headings}{Q-secthead}. - -However, people regularly want merely to change the way the section -number appears in the heading, and some such people don't mind writing -out a few macros. This answer is for \emph{them}. - -The section number is typeset using the -\begin{narrowversion} - \LaTeX{} internal -\end{narrowversion} -\begin{wideversion} - \Qref{\LaTeX{} internal}{Q-atsigns} -\end{wideversion} -\csx{@seccntformat} command, which is given the ``name'' (section, -subsection, \dots{}) of the heading, as argument. Ordinarily, -\csx{@seccntformat} -merely outputs the section number, and then a \csx{quad} of space. -Suppose you want to put a stop after every section (subsection, -subsubsection, \dots{}) number, a trivial change may be implemented by -simple modification of the command: -\begin{quote} -\begin{verbatim} -\renewcommand*{\@seccntformat}[1]{% - \csname the#1\endcsname.\quad -} -\end{verbatim} -\end{quote} - -Many people (for some reason) want a stop after a section number, but -not after a subsection number, or any of the others. -To do this, one must make \csx{@seccntformat} switch according to its -argument. The following technique for doing the job is slightly -wasteful, but is efficient enough for a relatively rare operation: -\begin{wideversion} -\begin{quote} -\begin{verbatim} -\let\@@seccntformat\@seccntformat -\renewcommand*{\@seccntformat}[1]{% - \expandafter\ifx\csname @seccntformat@#1\endcsname\relax - \expandafter\@@seccntformat - \else - \expandafter - \csname @seccntformat@#1\expandafter\endcsname - \fi - {#1}% -} -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -\let\@@seccntformat\@seccntformat -\renewcommand*{\@seccntformat}[1]{% - \expandafter\ifx - \csname @seccntformat@#1\endcsname - \relax - \expandafter\@@seccntformat - \else - \expandafter - \csname @seccntformat@#1\expandafter - \endcsname - \fi - {#1}% -} -\end{verbatim} -\end{quote} -\end{narrowversion} -which looks to see if a second-level command has been defined, and -uses it if so; otherwise it uses the original. The second-level -command to define stops after section numbers (only) has the same -definition as the original ``all levels alike'' version: -\begin{quote} -\begin{verbatim} -\newcommand*{\@seccntformat@section}[1]{% - \csname the#1\endcsname.\quad -} -\end{verbatim} -\end{quote} -Note that all the command definitions of this answer are dealing in -\Qref*{\LaTeX{} internal commands}{Q-atsigns}, so the above -code should be in a package file, for preference. - -The \Class{Koma-script} classes have different commands for specifying -changes to section number presentation: \csx{partformat}, -\csx{chapterformat} and \csx{othersectionlevelsformat}, but otherwise -their facilities are similar to those of ``raw'' \LaTeX{}. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}KOMA script bundle]\CTANref{koma-script} -\end{ctanrefs} - -\Question[Q-spaftend]{There's a space added after my environment} - -You've written your own environment \environment{env}, and it works -except that a space appears at the start of the first line of typeset -text after \cmdinvoke{end}{env}. This doesn't happen with similar -\LaTeX{}-supplied environments. - -You could impose the restriction that your users always put a -``\texttt{\textpercent}'' sign after the environment~\dots{}\nothtml{\@} but -\LaTeX{} environments don't require that, either. - -The \LaTeX{} environments' ``secret'' is an internal flag which causes -the unwanted spaces to be ignored. Fortunately, you don't have to use -the internal form: since 1996, \LaTeX{} has had a user command -\csx{ignorespacesafterend}, which sets the internal flag. - -\Question[Q-labundef]{Finding if a label is undefined} - -People seem to want to know (at run time) if a label is undefined (I -don't actually understand \emph{why}, particularly: it's a transient -state, and \LaTeX{} deals with it quite well). - -A resolved label is simply a command: -\csx{r@}\texttt{\meta{label-name}}; determining if the label is set is -then simply a matter of detecting if the command exists. The usual -\LaTeX{} internal way of doing this is to use the command -\csx{@ifundefined}: -\begin{quote} - \cmdinvoke*{@ifundefined}{\textup{r@}label-name}{undef-cmds}{def-cmds} -\end{quote} -In which, \meta{label-name} is exactly what you would use in -a \csx{label} command, and the remaining two arguments are command -sequences to be used if the label is undefined -(\meta{undef-cmds}) or if it is defined -(\meta{def-cmds}). - -Note that any command that incorporates \csx{@ifundefined} is naturally -fragile, so remember to create it with \csx{DeclareRobustCommand} or to -use it with \csx{protect} in a moving argument. - -If you're into this game, you may well not care about \LaTeX{}'s -warning about undefined labels at the end of the document; however, -if you are, include the command \csx{G@refundefinedtrue} in -\meta{\texttt{undef-cmds}}. - -And of course, remember you're dealing in internal commands, and pay -attention to the \Qref*{at-signs}{Q-atsigns}. - -All the above can be avoided by using the \Package{labelcas} package: -it provides commands that enable you to switch according to the state -of a single label, or the states of a list of labels. The package's -definition is a bit complicated, but the package itself is pretty -powerful. -\begin{ctanrefs} -\item[labelcas.sty]\CTANref{labelcas} -\end{ctanrefs} - -\Question[Q-addtoreset]{Master and slave counters} - -It's common to have things numbered ``per chapter'' (for example, in -the standard \Class{book} and \Class{report} classes, figures, tables -and footnotes are all numbered thus). The process of resetting is -done automatically, when the ``master'' counter is stepped (when the -\csx{chapter} command that starts chapter \meta{n} happens, the -\texttt{chapter} counter is stepped, and all the dependent counters are set -to zero). - -How would you do that for yourself? You might want to number -algorithms per section, or corollaries per theorem, for example. If -you're defining these things by hand, you declare the relationship -when you define the counter in the first place: -\begin{quote} -\cmdinvoke*{newcounter}{new-name}[master] -\end{quote} -says that every time counter \meta{master} is stepped, counter -\meta{new-name} will be reset. - -But what if you have an uncooperative package, that defines the -objects for you, but doesn't provide a programmer interface to make -the counters behave as you want? - -The \csx{newcounter} command uses a \LaTeX{} internal command, and you -can also use it: -\begin{quote} -\cmdinvoke*{@addtoreset}{new-name}{master} -\end{quote} -(but remember that it needs to be between \csx{makeatletter} and -\csx{makeatother}, or in a package of your own). - -The \Package{chngcntr} package encapsulates the \csx{@addtoreset} -command into a command \csx{counterwithin}. So: -\begin{quote} -\begin{verbatim} -\counterwithin*{corrollary}{theorem} -\end{verbatim} -\end{quote} -will make the corollary counter slave to theorem counters. The -command without its asterisk: -\begin{quote} -\begin{verbatim} -\counterwithin{corrollary}{theorem} -\end{verbatim} -\end{quote} -will do the same, and also redefine \csx{thecorollary} as % line brk! -\meta{theorem number}.\meta{corollary number}, which is a good scheme -if you ever want to refer to the corollaries~--- there are potentially -many ``corollary~1'' in any document, so it's as well to tie its number -to the counter of the theorem it belongs to. This is true of pretty -much any such counter-within-another; if you're not using the -\Package{chngcntr}, refer to the answer to % line break! -\Qref*{redefining counters' \csx{the-}commands}{Q-the-commands} for -the necessary techniques. - -Note that the technique doesn't work if the master counter is |page|, -the number of the current page. The |page| counter is stepped deep -inside the output routine, which usually gets called some time after -the text for the new page has started to appear: so special -techniques are required to deal with that. One special case is dealt -with elsewhere: \Qref*{footnotes numbered per page}{Q-footnpp}. One -of the techniques described there, using package \Package{perpage}, -may be applied to any counter. The command: -\begin{quote} -\cmdinvoke*{MakePerPage}{counter} -\end{quote} -will cause \meta{counter} to be reset for each page. The package uses -a label-like mechanism, and may require more than one run of \LaTeX{} -to stabilise counter values~--- \LaTeX{} will generate the usual -warnings about labels changing. -\begin{ctanrefs} -\item[chngcntr.sty]\CTANref{chngcntr} -\item[perpage.sty]Distributed as part \CTANref{bigfoot} -\end{ctanrefs} - -\Question[Q-fontsize]{Fonts at arbitrary sizes} - -Almost all fonts, nowadays, are provided with \LaTeX{} control -(\extension{fd}) files, so the temptation to risk the -\Qref*{problems of \csx{newfont}}{Q-newfont*} is usually easy to -resist. - -However, one temptation remains, arising from the way that \LaTeX{} -restricts the sizes of fonts. In fact, the restriction only -significantly applies to the default (Computer Modern) and the -Cork-encoded (\acro{T}1) EC fonts, but it is widely considered to be -anomalous, nowadays. In recognition of this problem, there is a -package \Package{fix-cm} which will allow you to use the fonts, within -\LaTeX{}, at any size you choose. If you're not using scaleable -versions of the fonts, most modern distributions will just generate an -appropriate bitmap for you. - -So, suppose you want to use Computer Modern Roman at 30 points, you -might be tempted to write: -\begin{quote} -\begin{verbatim} -\newfont{\bigfont}{cmr10 at 30pt} -\begin{center} - \bigfont Huge text -\end{center} -\end{verbatim} -\end{quote} -which will indeed work, but will actually produce a worse result than -\begin{quote} -\begin{verbatim} -\usepackage{fix-cm} -... -\begin{center} - \fontsize{30}{36}\selectfont - Huge text -\end{center} -\end{verbatim} -\end{quote} -Note that the \Package{fix-cm} package was not distributed until the -December 2003 edition of \LaTeX{}; if you have an older distribution, -the packages \Package{type1cm} (for \acro{CM} fonts) and -\Package{type1ec} (for \acro{EC} fonts) are available. -\begin{ctanrefs} -\item[fix-cm.sty]Distributed as part of \CTANref{latex} (an unpacked - version is available at \CTANref{fix-cm}) -\item[type1cm.sty]\CTANref{type1cm} -\item[type1ec.sty]\CTANref{type1ec} (the package is actually part of - the \CTANref{cm-super} distribution, but it works happily in - the absence of the scaled fonts) -\end{ctanrefs} - -\Question[Q-latexqual]{The quality of your \LaTeX{}} - -The \Package{l2tabu} tutorial (mentioned in % ! line break -\Qref[question]{online introductions}{Q-man-latex}) is undoubtedly a -good read. - -However, it's always difficult to remember the things you should -\emph{not} do, when there are so many things to remember that you -really must do: some automation is needed\dots{}. - -The nicely-named \Package{nag} allows you to apply a configurable set -of checks to your document, as you run it through \LaTeX{}; you get -messages like: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -Package nag Warning: Command \bf is an old LaTeX 2.09 command. -(nag) Use \bfseries or \textbf instead on input line 30. -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -Package nag Warning: Command \bf is an old - LaTeX 2.09 command. -(nag) Use \bfseries or \textbf - instead on input line 30. -\end{verbatim} -\end{narrowversion} -\end{quote} -\begin{wideversion} - (the package provides a demo file which contains most of the sorts - of errors you might make~--- this is one of them). -\end{wideversion} -\begin{narrowversion} - (the two error lines both wrapped above; the package provides a demo - file which contains most of the sorts of errors you might make~--- - this is one of them). -\end{narrowversion} - -There's also a web site -\href{http://www.kohm.name/markus/texidate.html}{TeXidate} -which will do a static analysis of your document (unfortunately, you -have to paste your document source into a text window). The site -doesn't seem as comprehensive as \Package{nag}, but it allows you to -download its script, which you can then juggle with to make it more -draconian. -\begin{ctanrefs} -\item[l2tabu]Browse \CTANref{l2tabu} for a copy in a language that's - convenient for you -\item[nag.sty]\CTANref{nag} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Things are Going Wrong\dots{}} - -\subsection{Getting things to fit} -\Question[Q-enlarge]{Enlarging \TeX{}} - -The \TeX{} error message `capacity exceeded' covers a multitude of -problems. What has been exhausted is listed in brackets after the -error message itself, as in: -\begin{quote} -\begin{verbatim} -! TeX capacity exceeded, sorry -... [main memory size=263001]. -\end{verbatim} -\end{quote} -Most of the time this error can be fixed -\emph{without} enlarging \TeX{}. The most common causes are unmatched braces, -extra-long lines, and poorly-written macros. Extra-long lines are -often introduced when files are transferred incorrectly between -operating systems, and line-endings are not preserved properly (the -tell-tale sign of an extra-long line error is the complaint -that the `|buf_size|' has overflowed). - -If you really need to extend your \TeX{}'s capacity, the proper method -depends on your installation. There is no need (with modern \TeX{} -implementations) to change the defaults in Knuth's \acro{WEB} source; -but if you do need to do so, use a change file to modify the values set in -module 11, recompile your \TeX{} and regenerate all format files. - -Modern implementations allow the sizes of the various bits of \TeX{}'s -memory to be changed semi-dynamically. Some (such as em\TeX{}) allow -the memory parameters to be changed in command-line switches when -\TeX{} is started; most frequently, a configuration file is read which -specifies the size of the memory. On \ProgName{web2c}-based systems, -this file is called \File{texmf.cnf}: see the documentation that comes -with the distribution for other implementations. Almost invariably, -after such a change, the format files need to be regenerated after -changing the memory parameters. - -\Question[Q-usepictex]{Why can't I load \PiCTeX{}?} - -\PiCTeX{} is a resource hog; fortunately, most modern \TeX{} -implementations offer generous amounts of space, and most modern -computers are pretty fast, so users aren't too badly affected by its -performance. - -However, \PiCTeX{} has the further unfortunate tendency to fill up -\TeX{}'s fixed-size arrays~--- notably the array of 256 `dimension' -registers. This is a particular problem when you're using -\File{pictex.sty} with \LaTeX{} and some other packages that also need -dimension registers. When this happens, you will see the \TeX{} error -message: -\begin{quote} -\begin{verbatim} -! No room for a new \dimen. -\end{verbatim} -\end{quote} -There is nothing that can directly be done about this error: you -can't extend the number of available \csx{dimen} registers without -extending \TeX{} itself. -\begin{wideversion} % hyper - \Qref{\eTeX{}}{Q-etex} and \Qref{Omega}{Q-omegaleph} both do this, as - does \Qref{MicroPress Inc's V\TeX{}}{Q-commercial}. -\end{wideversion} -\begin{narrowversion} - \eTeX{} and \ensuremath{\Omega}~--- \Qref[see questions]{}{Q-etex} - \Qref[and]{}{Q-omegaleph} respectively~--- both do this, as does - MicroPress Inc's V\TeX{}~--- \Qref{}{Q-commercial}. -\end{narrowversion} - -It's actually quite practical (with most modern distributions) to use -\eTeX{}'s extended register set: use package \Package{etex} (which -comes with \eTeX{} distributions) and the allocation mechanism is -altered to cope with the larger register set: \PiCTeX{} will now load. - -If you're in some situation where you can't use \eTeX{}, you need to change -\PiCTeX{}; unfortunately \PiCTeX{}'s author is no longer active in the -\TeX{} world, so one must resort to patching. There are two solutions -available. - -The \CONTeXT{} module \File{m-pictex.tex} (for \plaintex{} and -variants) or the corresponding \LaTeX{} \Package{m-pictex} package provide -an ingenious solution to the problem based on hacking the code of -\csx{newdimen} itself. - -Alternatively, Andreas Schell's \Package{pictexwd} and related -packages replace \PiCTeX{} with a version that uses 33 fewer -\csx{dimen} registers; so use \Package{pictexwd} in place of -\Package{pictex} (either as a \LaTeX{} package, or as a file to read -into \plaintex{}). - -And how does one use \PiCTeX{} anyway, given that the -manual is so \Qref*{hard to come by}{Q-docpictex}? -Fortunately for us all, the \ProgName{MathsPic} -system may be used to translate a somewhat different language into -\PiCTeX{} commands; and the \ProgName{MathsPic} manual is free (and -part of the distribution). \ProgName{MathsPic} is available either as -a \ProgName{Basic} program for \acro{DOS}, or as a \ProgName{Perl} -program for other systems (including Windows, nowadays). -\begin{ctanrefs} -\item[m-pictex.sty]Distributed as part of \CTANref{context-tmf} -\item[m-pictex.tex]Distributed as part of \CTANref{context-tmf} -\item[MathsPic]\CTANref{mathspic} -\item[pictexwd.sty]Distributed as part of \CTANref{pictex-addon} -\end{ctanrefs} - -\subsection{Making things stay where you want them} - -\Question[Q-floats]{Moving tables and figures in \LaTeX{}} - -Tables and figures have a tendency to surprise, by \emph{floating} -away from where they were specified to appear. This is in fact -perfectly ordinary document design; any professional typesetting -package will float figures and tables to where they'll fit without -violating the certain typographic rules. Even if you use the -placement specifier~\texttt{h} for `here', the figure or table will not be -printed `here' if doing so would break the rules; the rules themselves -are pretty simple, and are given on page~198, section~C.9 of the -\LaTeX{} manual. In the worst case, \LaTeX{}'s rules can cause the -floating items to pile up to the extent that you get an error message -saying \Qref*{``Too many unprocessed floats''}{Q-tmupfl}. -What follows is a simple checklist of things to do to solve these -problems (the checklist talks throughout about figures, but applies -equally well to tables, or to ``non-standard'' floats defined by the -\Package{float} or other packages). -\begin{itemize} -\item Do your figures need to float at all? If not, look at the - recommendations for ``\Qref*{non-floating floats}{Q-figurehere}'' -\item Are the placement parameters on your figures right? The - default (\texttt{tbp}) is reasonable, but you can reasonably change it (for - example, to add an \texttt{h}). Whatever you do, \emph{don't} - omit the `\texttt{p}': doing so could cause \LaTeX{} to believe that if you - can't have your figure \emph{here}, you don't want it - \emph{anywhere}. (\LaTeX{} does try hard to avoid being confused in - this way\dots{}) -\item \LaTeX{}'s own float placement parameters could be preventing - placements that seem entirely ``reasonable'' to you~--- they're - notoriously rather conservative. To encourage \LaTeX{} not to move - your figure, you need to loosen its demands. (The most important - ones are the ratio of text to float on a given page, but it's - sensible to have a fixed set that changes the whole lot, to meet - every eventuality.) -\begin{verbatim} -\renewcommand{\topfraction}{.85} -\renewcommand{\bottomfraction}{.7} -\renewcommand{\textfraction}{.15} -\renewcommand{\floatpagefraction}{.66} -\renewcommand{\dbltopfraction}{.66} -\renewcommand{\dblfloatpagefraction}{.66} -\setcounter{topnumber}{9} -\setcounter{bottomnumber}{9} -\setcounter{totalnumber}{20} -\setcounter{dbltopnumber}{9} -\end{verbatim} - The meanings of these - parameters are described on pages~199--200, section~C.9 of the - \LaTeX{} manual. -\item Are there places in your document where you could `naturally' - put a \csx{clearpage} command? If so, do: the backlog of floats is - cleared after a \csx{clearpage}. (Note that the \csx{chapter} - command in the standard \Class{book} and \Class{report} classes - implicitly executes \csx{clearpage}, so you can't float past - the end of a chapter.) -\item Try the \Package{placeins} package: it defines a - \csx{FloatBarrier} command beyond which floats may not pass. A - package option allows you to declare that floats may not pass a - \csx{section} command, but you can place \csx{FloatBarrier}s wherever - you choose. -\item If you are bothered by floats appearing at the top of the page - (before they are specified in your text), try the \Package{flafter} - package, which avoids this problem by insisting that floats should - always appear after their definition. -\item Have a look at the \LaTeXe{} \Package{afterpage} package. - Its documentation gives as an example the idea - of putting \csx{clearpage} \emph{after} the current page (where it - will clear the backlog, but not cause an ugly gap in your text), but - also admits that the package is somewhat fragile. Use it as a last - resort if the other possibilities below don't help. -\item If you would actually \emph{like} great blocks of floats at the - end of each of your chapters, try the \Package{morefloats} package; - this `simply' increases the number of floating inserts that \LaTeX{} - can handle at one time (from~18 to~36). -\item If you actually \emph{wanted} all your figures to float to the - end (\emph{e.g}., for submitting a draft copy of a paper), don't - rely on \LaTeX{}'s mechanism: get the \Package{endfloat} package to do - the job for you. -\end{itemize} -\begin{ctanrefs} -\item[afterpage.sty]Distributed as part of \CTANref{2etools} -\item[endfloat.sty]\CTANref{endfloat} -\item[flafter.sty]Part of the \LaTeX{} distribution -\item[float.sty]\CTANref{float} -\item[morefloats.sty]\CTANref{morefloats} -\item[placeins.sty]\CTANref{placeins} -\end{ctanrefs} - -\Question[Q-underline]{Underlined text won't break} - -Knuth made no provision for underlining text: he took the view that -underlining is not a typesetting operation, but rather one that -provides emphasis on typewriters, which typically offer but one -typeface. The corresponding technique in typeset text is to switch -from upright to italic text (or vice-versa): the \LaTeX{} command -\csx{emph} does just that to its argument. - -Nevertheless, typographically illiterate people (such as those that -specify double-spaced -\nothtml{thesis styles~--- }\Qref{thesis styles}{Q-linespace}) -continue to require underlining of us, so \LaTeX{} as distributed -defines an \csx{underline} command that applies the mathematical -`underbar' operation to text. This technique is not entirely -satisfactory, however: the text gets stuck into a box, and won't break -at line end. - -Two packages are available that solve this problem. The -\Package{ulem} package redefines the -\csx{emph} command to underline its argument; the underlined text thus -produced behaves as ordinary emphasised text, and will break over the -end of a line. (The package is capable of other peculiar effects, -too: read its documentation, contained within the file itself.) -The \Package{soul} package defines an \csx{ul} command (after which the -package is, in part, named) that underlines running text. - -Beware of \Package{ulem}'s default behaviour, which is to convert the -\csx{emph} command into an underlining command; this can be avoided by -loading the package with: -\begin{verbatim} - \usepackage[normalem]{ulem} -\end{verbatim} -Documentation of \Package{ulem} is in the package itself. -\begin{ctanrefs} -\item[ulem.sty]\CTANref{ulem} -\item[soul.sty]\CTANref{soul} -\end{ctanrefs} - -\Question[Q-widows]{Controlling widows and orphans} - -Widows (the last line of a paragraph at the start of a page) and -orphans (the first line of paragraph at the end of a page) interrupt -the reader's flow, and are generally considered ``bad form''; -\AllTeX{} takes some precautions to avoid them, but completely -automatic prevention is often impossible. If you are typesetting your -own text, consider whether you can bring yourself to change the -wording slightly so that the page break will fall differently. - -The page maker, when forming a page, takes account of -\csx{widowpenalty} and \csx{clubpenalty} (which relates to orphans!). -These penalties are usually set to the moderate value of \texttt{150}; this -offers mild discouragement of bad breaks. You can increase the values -by saying (for example) \csx{widowpenalty}\texttt{=500}; however, vertical -lists (such as pages are made of) typically have rather little -stretchability or shrinkability, so if the page maker has to balance -the effect of stretching the unstretchable and being penalised, the -penalty will seldom win. Therefore, for typical layouts, there are -only two sensible settings for the penalties: finite (150 or 500, it -doesn't matter which) to allow widows and orphans, and infinite (10000 -or greater) to forbid them. - -The problem can be avoided by allowing -the pagemaker to run pages short, by using the \csx{raggedbottom} -directive; however, many publishers insist on the default -\csx{flushbottom}; it is seldom acceptable to introduce stretchability -into the vertical list, except at points (such as section headings) -where the document design explicitly permits it. - -Once you've exhausted the automatic measures, and have a final draft -you want to ``polish'', you should proceed to manual measures. To -get rid of an orphan is simple: precede the paragraph with -\csx{clearpage} and the paragraph can't start in the wrong place. - -Getting rid of a widow can be more tricky. If the paragraph is a long -one, it may be possible to set it `tight': say \csx{looseness}\texttt{=-1} -immediately after the last word of the paragraph. If that doesn't -work, try adjusting the page size: -\cmdinvoke{enlargethispage}{\csx{baselineskip}} may do the job, and -get the whole paragraph on one page. Reducing the size of the page by -\cmdinvoke{enlargethispage}{-\csx{baselineskip}} may produce a -(more-or-less) acceptable ``two-line widow''. (Note: -\csx{looseness}\texttt{=1}, -increasing the line length by one, seldom seems to work~--- the looser -paragraph typically has a one-word final line, which doesn't look much -better than the straight widow.) - -\subsection{Things have ``gone away''} - -\Question[Q-oldfontnames]{Old \LaTeX{} font references such as \csx{tenrm}} - -\LaTeXo{} defined a large set of commands for access to the fonts -that it had built in to itself. For example, various flavours of -|cmr| could be found as \csx{fivrm}, \csx{sixrm}, \csx{sevrm}, -\csx{egtrm}, \csx{ninrm}, \csx{tenrm}, \csx{elvrm}, \csx{twlrm}, -\csx{frtnrm}, \csx{svtnrm}, \csx{twtyrm} and \csx{twfvrm}. -These commands were never documented, but certain packages -nevertheless used them to achieve effects they needed. - -Since the commands weren't public, they weren't included in \LaTeXe{}; -to use the unconverted \LaTeXo{} packages under \LaTeXe{}, you need -also to include the \Package{rawfonts} package (which is part of the -\LaTeXe{} distribution). - -\Question[Q-misssymb]{Missing symbol commands} - -You're processing an old document, and some symbol commands such as -\csx{Box} and \csx{lhd} appear no longer to exist. These commands were -present in the core of \LaTeXo{}, but are not in current \LaTeX{}. -They are available in the \Package{latexsym} package (which is part of -the \LaTeX{} distribution), and in the \Package{amsfonts} package -(which is part of the \acro{AMS} distribution, and requires \acro{AMS} -symbol fonts). -\begin{ctanrefs} -\item[amsfonts.sty]\CTANref{amsfonts-latex} -\item[AMS symbol fonts]\CTANref{amsfonts-symbols} -\end{ctanrefs} - -\Question[Q-msxy]{Where are the \texttt{msx} and \texttt{msy} fonts?} - -The \FontName{msx} and \FontName{msy} fonts were designed by the -American Mathematical Society in the very early days of \TeX{}, for -use in typesetting papers for mathematical journals. They were -designed using the `old' \MF{}, which wasn't portable and is no longer -available; for a long time they were only available in 300dpi versions -which only imperfectly matched modern printers. The \acro{AMS} has -now redesigned the fonts, using the current version of \MF{}, and the -new versions are called the \FontName{msa} and \FontName{msb} -families. - -Nevertheless, \FontName{msx} and \FontName{msy} continue to turn up to -plague us. There are, of course, still sites that haven't got around -to upgrading; but, even if everyone upgraded, there would still be the -problem of old documents that specify them. - -If you have a \extension{tex} source that requests \FontName{msx} and -\FontName{msy}, the best technique is to edit it so that it requests -\FontName{msa} and \FontName{msb} (you only need to change the single -letter in the font names). - -If you have a \acro{DVI} file that requests the fonts, there is a package -of \Qref*{virtual fonts}{Q-virtualfonts} to map the old to the new series. -\begin{ctanrefs} -\item[msa and msb fonts]\CTANref{amsfonts-symbols} -\item[virtual font set]\CTANref{msx2msa} -\end{ctanrefs} - -%%%???%%% spell-checked to here....zzzyx - -\Question[Q-amfonts]{Where are the \texttt{am} fonts?} - -One \emph{still} occasionally comes across a request for the \FontName{am} -series of fonts. The initials stood for `Almost [Computer] Modern', -and they were the predecessors of the Computer Modern fonts that we -all know and love (or hate)% -\begin{footnoteenv} - The fonts acquired their label `Almost' following the realisation - that their first implementation in \MF{}79 still wasn't quite right; - Knuth's original intention had been that they were the final answer. -\end{footnoteenv}. -There's not a lot one can do with these -fonts; they are (as their name implies) almost (but not quite) the -same as the \FontName{cm} series; if you're faced with a document that requests -them, all you can reasonably do is to edit the document. The -appearance of \acro{DVI} files that request them is sufficiently rare that -no-one has undertaken the mammoth task of creating a translation of -them by means of virtual fonts; however, most drivers let you have a -configuration file in which you can specify font substitutions. If you -specify that every \FontName{am} font should be replaced by its corresponding -\FontName{cm} font, the output should be almost correct. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Why does it \emph{do} that?} - -\subsection{Common errors} - -\Question[Q-crossref]{\LaTeX{} gets cross-references wrong} - -Sometimes, however many times you run \LaTeX{}, the cross-references -are just wrong. Remember that -the \csx{label} command must come \emph{after} the \csx{caption} command, or -be part of it. For example, -\htmlignore -\par\noindent -\begin{tabular}{@{}lll} -| \begin{figure}| & & |\begin{figure}|\\ -| \caption{A Figure}| & or & |\caption{A Figure%| \\ -| \label{fig}| & & | \label{fig}}| \\ -| \end{figure}| & & |\end{figure}| \\ -\end{tabular} -\endhtmlignore -\begin{htmlversion} -\begin{verbatim} - \begin{figure} \begin{figure} - \caption{A Figure} or \caption{A Figure% - \label{fig} \label{fig}} - \end{figure} \end{figure} -\end{verbatim} -\end{htmlversion} - -You can, just as effectively, shield the \csx{caption} command from its -associated \csx{label} command, by enclosing the caption in an -environment of its own. For example, people commonly seek help after: -\begin{quote} -\begin{verbatim} -\begin{center} - \caption{A Figure} -\end{center} -\label{fig} -\end{verbatim} -\end{quote} -has failed to label correctly. If you really need this centring (and -those in the know commonly reject it), code it as: -\begin{quote} -\begin{verbatim} -\begin{center} - \caption{A Figure} - \label{fig} -\end{center} -\end{verbatim} -\end{quote} - -\Question[Q-newlineargs]{Start of line goes awry} -\keywords{asterisk square bracket start line} - -This answer concerns two sorts of problems: errors of the form -\begin{quote} -\begin{verbatim} -! Missing number, treated as zero. -<to be read again> - g -<*> [grump] -\end{verbatim} -\end{quote} -and those where a single asterisk at the start of a line mysteriously -fails to appear in the output. - -Both problems arise because |\|{}|\| takes optional arguments. The -command |\|{}|\*| means ``break the line here, and inhibit page break -following the line break''; the command |\|{}|\[|\meta{dimen}|]| -means ``break the line here and add \meta{dimen} extra vertical space -afterwards''. - -So why does |\|{}|\| get confused by these things at the start of a -line? It's looking for the first non-blank thing, and in the test it -uses ignores the end of the line in your input text. - -The solution is to enclose the stuff at the start of the new line in -braces: -\begin{quote} -\begin{verbatim} -{\ttfamily - /* C-language comment\\ - {[grump]} I don't like this format\\ - {*}/ -} -\end{verbatim} -\end{quote} -(The above text derives from an actual post to -\Newsgroup{comp.text.tex}; this particular bit of typesetting could -plainly also be done using the \environment{verbatim} environment.) - -The problem also appears in maths mode, in arrays and so on. In this -case, large-scale bracketing of things is \emph{not} a good idea; the -\TeX{} primitive \csx{relax} (which does nothing except to block -searches of this nature) may be used. From another -\Newsgroup{comp.text.tex} example: -\begin{quote} -\begin{verbatim} -\begin{eqnarray} - [a] &=& b \\ - \relax[a] &=& b -\end{eqnarray} -\end{verbatim} -\end{quote} -which is a usage this \acro{FAQ} would not recommend, anyway: refer -to the \Qref*{reason not to use \environment{eqnarray}}{Q-eqnarray}. - -Note that the \Package{amsmath} package modifies the behaviour of -\texttt{\bsbs } in maths. With \Package{amsmath}, the \environment{eqnarray} -example doesn't need any special measures. - -\Question[Q-verbwithin]{Why doesn't verbatim work within\,\dots{}?} - -The \LaTeX{} verbatim commands work by changing category codes. Knuth -says of this sort of thing ``Some care is needed to get the timing -right\dots{}'', since once the category code has been assigned to a -character, it doesn't change. So \csx{verb} and -\cmdinvoke{begin}{verbatim} have to assume that they are getting the -first look at the parameter text; if they aren't, \TeX{} has already -assigned category codes so that the verbatim command doesn't have a -chance. For example: -\begin{quote} -\begin{verbatim} -\verb+\error+ -\end{verbatim} -\end{quote} -will work (typesetting `\csx{error}'), but -\begin{quote} -\begin{verbatim} -\newcommand{\unbrace}[1]{#1} -\unbrace{\verb+\error+} -\end{verbatim} -\end{quote} -will not (it will attempt to execute \csx{error}). Other errors one -may encounter are `\csx{verb} ended by end of line', or even the -rather more helpful `\csx{verb} illegal in command argument'. The -same sorts of thing happen with \cmdinvoke{begin}{verbatim} \dots{} -\cmdinvoke{end}{verbatim}: -\begin{quote} -\begin{quoteverbatim} -\ifthenelse{\boolean{foo}}{% -\begin{verbatim} -foobar -\end{verbatim} -}{% -\begin{verbatim} -barfoo -\end{verbatim} -} -\end{quoteverbatim} -\end{quote} -provokes errors like `File ended while scanning use of -\csx{@xverbatim}', as \cmdinvoke{begin}{verbatim} fails to see its -matching \cmdinvoke{end}{verbatim}. - -This is why the \LaTeX{} book insists that verbatim -commands must not appear in the argument of any other command; they -aren't just fragile, they're quite unusable in any command parameter, -regardless of \Qref*{\csx{protect}ion}{Q-protect}. (The \csx{verb} -command tries hard to detect if you're misusing it; unfortunately, it -can't always do so, and the error message is therefore not a reliable -indication of problems.) - -The first question to ask yourself is: ``is \csx{verb} actually -necessary?''. -\begin{itemize} -\item If \cmdinvoke{texttt}{\emph{your text}} produces the same result - as \csx{verb}\texttt{+\emph{your text}+}, then there's no need of - \csx{verb} in the first place. -\item If you're using \csx{verb} to typeset a \acro{URL} or email - address or the like, then the \csx{url} command from the - \Package{url} will help: it doesn't suffer from all the problems of - \csx{verb}, though it's still not robust; % ! line break - ``\Qref*{typesetting \acro{URL}s}{Q-setURL}'' offers advice here. -\item If you're putting \csx{verb} into the argument of a boxing - command (such as \csx{fbox}), consider using the \environment{lrbox} - environment: -\begin{quote} -\begin{verbatim} -\newsavebox{\mybox} -... -\begin{lrbox}{\mybox} - \verb!VerbatimStuff! -\end{lrbox} -\fbox{\usebox{\mybox}} -\end{verbatim} -\end{quote} -\end{itemize} - -Otherwise, there are three partial solutions to the problem. -\begin{itemize} -\item Some packages have macros which are designed to be responsive - to verbatim text in their arguments. For example, - the \Package{fancyvrb} package defines a command - \csx{VerbatimFootnotes}, which redefines the \csx{footnotetext} - command, and hence also the behaviour of the \csx{footnote}) - command, in such a way that you can include \csx{verb} commands in - its argument. This approach could in principle be extended to the - arguments of other commands, but it can clash with other packages: - for example, \csx{VerbatimFootnotes} interacts poorly with the - \pkgoption{para} option of the \Package{footmisc} package. - - The \Class{memoir} class defines its \csx{footnote} command so that - it will accept verbatim in its arguments, without any supporting package. -\item The \Package{fancyvrb} package defines a command \csx{SaveVerb}, - with a corresponding \csx{UseVerb} command, that allow you to save - and then to reuse the content of its argument; for details of this - extremely powerful facility, see the package documentation. - - Rather simpler is the \Package{verbdef} package, whose \csx{verbdef} - command defines a (robust) command which expands to the verbatim - argument given. -\item If you have a single character that is giving trouble (in - its absence you could simply use \csx{texttt}), consider using - \csx{string}. \cmdinvoke{texttt}{my\csx{string}\_name} - typesets the same as - |\verb+my_name+|, and will work in the argument of a command. It - won't, however, work in a moving argument, and no amount of - \Qref*{\csx{protect}ion}{Q-protect} will make it work in - such a case. - - A robust alternative is: - \begin{quote} -\begin{verbatim} -\chardef\us=`\_ -... -\section{... \texttt{my\us name}} -\end{verbatim} - \end{quote} - Such a definition is `naturally' robust; the construction - ``\meta{back-tick}\csx{\meta{char}}'' may be used for any - troublesome character (though it's plainly not necessary for things - like percent signs for which \AllTeX{} already provides - robust macros). -\end{itemize} -Documentation of both \Package{url} and \Package{verbdef} is in the -package files. -\begin{ctanrefs} -\item[fancyvrb.sty]\CTANref{fancyvrb} -\item[memoir.cls]\CTANref{memoir} -\item[url.sty]\CTANref{url} -\item[verbdef.sty]\CTANref{verbdef} -\end{ctanrefs} - -\Question[Q-noline]{No line here to end} - -The error -\begin{quote} -\begin{wideversion} -\begin{verbatim} -! LaTeX Error: There's no line here to end. - -See the LaTeX manual or LaTeX Companion for explanation. -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -! LaTeX Error: There's no line here to end. - -See the LaTeX manual or LaTeX Companion -... for explanation. -\end{verbatim} -\end{narrowversion} -\end{quote} -comes in reaction to you giving \LaTeX{} a |\|{}|\| command at a time -when it's not expecting it. The commonest case is where you've -decided you want the label of a list item to be on a line of its own, -so you've written (for example): -\begin{quote} -\begin{verbatim} -\begin{description} -\item[Very long label] \\ - Text... -\end{description} -\end{verbatim} -\end{quote} -|\|{}|\| is actually a rather bad command to use in this case (even if -it worked), since it would force the `paragraph' that's made up of the -text of the item to terminate a line which has nothing on it but the -label. This would lead to an ``|Underfull \hbox|'' warning message -(usually with `infinite' badness of 10000); while this message doesn't -do any actual harm other than slowing down your \LaTeX{} run, any -message that doesn't convey any information distracts for no useful -purpose. - -The proper solution to the problem is to write a new sort of -\environment{description} environment, that does just what you're after. (The -\nothtml{\emph{\LaTeX{} Companion}~--- see }% ! line wrap -\Qref[question]{\emph{\LaTeX{} Companion}}{Q-books}\nothtml{~---} offers a -rather wide selection of variants of these things.) - -The quick-and-easy solution, which avoids the warning, is to write: -\begin{quote} -\begin{verbatim} -\begin{description} -\item[Very long label] \hspace*{\fill} \\ - Text... -\end{description} -\end{verbatim} -\end{quote} -which fills out the under-full line before forcing its closure. The -\Package{expdlist} package provides the same functionality with its -\csx{breaklabel} command, and \Package{mdwlist} provides it via its -\csx{desclabelstyle} command. - -The other common occasion for the message is when you're using the -\texttt{center} (or \environment{flushleft} or \environment{flushright}) -environment, and have decided you need extra separation between lines -in the environment: -\begin{quote} -\begin{verbatim} -\begin{center} - First (heading) line\\ - \\ - body of the centred text... -\end{center} -\end{verbatim} -\end{quote} -The solution here is plain: use the \texttt{\bsbs } command in the way it's -supposed to be used, to provide more than just a single line break -space. \texttt{\bsbs } takes an optional argument, which specifies -how much extra space to add; the required effect in the text above can -be had by saying: -\begin{quote} -\begin{verbatim} -\begin{center} - First (heading) line\\[\baselineskip] - body of the centred text... -\end{center} -\end{verbatim} -\end{quote} -\begin{ctanrefs} -\item[expdlist.sty]\CTANref{expdlist} -\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} -\end{ctanrefs} - -% other instances: \[no]linebreak in vertical mode - -\Question[Q-2colfltorder]{Two-column float numbers out of order} - -When \LaTeX{} can't place a float immediately, it places it on one of -several ``defer'' lists. If another float of the same type comes -along, and the ``defer'' list for that type still has something in it, -the later float has to wait for everything earlier in the list. - -Now, standard \LaTeX{} has different lists for single-column floats, -and double-column floats; this means that single-column figures can -overtake double-column figures (or vice-versa), and you observe later -figures appear in the document before early ones. The same is true, -of course, for tables, or for any user-defined float. - -The \LaTeX{} team recognise the problem, and provides a package -(\Package{fixltx2e}) to deal with it. \Package{Fixltx2e} amalgamates -the two defer lists, so that floats don't get out of order. - -For those who are still running an older \LaTeX{} distribution, the -package \Package{fix2col} should serve. This package (also by a -member of the \LaTeX{} team) was the basis of the relevant part of -\Package{fixltx2e}. The functionality has also been included in -\Package{dblfloatfix}, which also has code to place full-width floats -at \Qref*{\texttt{[b]} placement}{Q-2colfloat}. - -Once you have loaded the package, no more remains to be done: the -whole requirement is to patch the output routine; no extra commands -are needed. -\begin{ctanrefs} -\item[dblfloatfix.sty]\CTANref{dblfloatfix} -\item[fix2col.sty]Distributed as part of \CTANref{carlisle} -\item[fixltx2e.sty]Part of the \LaTeX{} distribution -\end{ctanrefs} - -\Question[Q-tabacc]{Accents misbehave in \environment{tabbing}} - -So you are constructing a \environment{tabbing} environment, and you -have the need of some diacriticised text~--- perhaps something as simple -as \cmdinvoke{'}{e}~--- and the accent disappears because it has been -interpreted as a \environment{tabbing} command, and everything goes -wrong. - -This is really a rather ghastly feature of the \environment{tabbing} -environment; in order to type accented characters you need to use the -\csx{a} kludge: so \cmdinvoke{a'}{e} inside \environment{tabbing} for -\cmdinvoke{'}{e} outside, and similarly \csx{a`} for \csx{`} and \csx{a=} -for \csx{=}. This whole procedure is of course hideous and -error-prone. - -The simplest alternative is to type in an encoding that has the -diacriticised characters in it, and to use an appropriate encoding -definition file in the \Package{inputenc} package. So for example, -type: -\begin{quote} - \cmdinvoke{usepackage}[latin1]{inputenc}\\ - \texttt{...}\\ - \cmdinvoke{begin}{tabbing}\\ - \texttt{...}\\ - \texttt{...} \csx{>} \texttt{voil\`a} \csx{>} \texttt{...} -\end{quote} -for: -\begin{quote} - \dots{}\quad voil\`a\quad \dots{} -\end{quote} -and the internal mechanisms of the \Package{inputenc} package will put -the right version of the accent command in there. - -A witty reversal of the r\^oles is introduced by the package -\Package{Tabbing} (note the capital ``T''): it provides a -\environment{Tabbing} environment which duplicates -\environment{tabbing}, but all the single-character commands become -complicated objects. So \environment{tabbing}'s \csx{>} becomes -\csx{TAB>}, \csx{=} becomes \csx{TAB=}, and so on. The above trivial -example would therefore become: -\begin{quote} -\begin{verbatim} -\usepackage{Tabbing} -... -\begin{Tabbing} - ... ... \TAB> voil\`a \TAB> ... -\end{verbatim} -\end{quote} -\begin{ctanrefs} -\item[Tabbing.sty]\CTANref{Tabbing} -\end{ctanrefs} - -\Question[Q-alreadydef]{Package reports ``command already defined''} - -You load a pair of packages, and the second reports that one of the -commands it defines is already present. For example, both the -\Package{txfonts} and \Package{amsmath} define a command \csx{iint} -(and \csx{iiint} and so on); so -\begin{quote} -\begin{verbatim} -... -\usepackage{txfonts} -\usepackage{amsmath} -\end{verbatim} -\end{quote} -produces a string of error messages of the form: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -! LaTeX Error: Command \iint already defined. - Or name \end... illegal, see p.192 of the manual. -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -! LaTeX Error: Command \iint already - defined. Or name \end... illegal, - see p.192 of the manual. -\end{verbatim} -\end{narrowversion} -\end{quote} -As a general rule, things that \Package{amsmath} defines, it defines -well; however, there is a good case for using the \Package{txfonts} -version of \csx{iint}~--- the associated \FontName{tx} fonts have a -double integral symbol that doesn't need to be ``faked'' in the way -\Package{amsmath} does. In the case that you are loading several -symbol packages, every one of which defines the same symbol, you are -likely to experience the problem in a big way (\csx{euro} is a common -victim). - -There are similar cases where one package redefines another's command, -but no error occurs because the redefining package doesn't use -\csx{newcommand}. Often, in such a case, you only notice the change -because you assume the definition given by the first package. The -\Package{amsmath}--\Package{txfonts} packages are just such a pair; -\Package{txfonts} doesn't provoke errors. - -You may deal with the problem by saving and restoring the command. -Macro programmers may care to do this for themselves; for the rest of -us, there's the package \Package{savesym}. The sequence: -\begin{quote} -\begin{verbatim} -\usepackage{savesym} -\usepackage{amsmath} -\savesymbol{iint} -\usepackage{txfonts} -\restoresymbol{TXF}{iint} -\end{verbatim} -\end{quote} -does the job; restoring the \Package{amsmath} version of the command, -and making the \Package{txfonts} version of the command available as -\csx{TXFiint}. - -Documentation of \Package{savesym} doesn't amount to much: the only -commands are \csx{savesymbol} and \csx{restoresymbol}, as noted above. -\begin{ctanrefs} -\item[amsmath.sty]Part of \CTANref{amslatex} -\item[savesym.sty]\CTANref{savesym} -\item[txfonts.sty]Part of \CTANref{txfonts} -\end{ctanrefs} - -\Question[Q-zerochap]{Why are my sections numbered 0.1\,\dots{}?} - -This happens when your document is using the standard \Class{book} or -\Class{report} class (or one similar), and you've got a \csx{section} -before your first \csx{chapter}. - -What happens is, that the class numbers sections as % ! line break -``\meta{chapter no}.\meta{section no}'', and until the first -chapter has appeared, the chapter number is 0. - -If you're doing this, it's quite likely that the \Class{article} class -is for you; try it and see. Otherwise, give your sections a -`superior' chapter, or do away with section numbering by using -\csx{section*} instead. An alternative way of avoiding numbering is -discussed in % ! line break -``\Qref*{unnumbered sections in the table of contents}{Q-secnumdep}''. - -\Question[Q-breaklinks]{Link text doesn't break at end line} -\keywords{hyperref overfull link} - -When using the \Package{hyperref} package, you make a block of text -``active'' when you define a hyper-link (when the user clicks on -that text, the reader program will divert to the \emph{target} of the -link). - -The \Package{hyperref} package uses a \emph{driver} (in the same way -as the \Package{graphics} package does), to determine how to implement -all that hyper-stuff. - -If you use the driver for \ProgName{dvips} output (presumably you want -to distill the resulting \PS{}), limitations in the way \ProgName{dvips} -deals with the \csx{special} commands mean that \Package{hyperref} -must prevent link anchors from breaking at the end of lines. Other -drivers (notably those for \PDFTeX{} and for \ProgName{dvipdfm}) don't -suffer from this problem. - -The problem may occur in a number of different circumstances. For a -couple of them, there are work-arounds: - -First, if you have an \acro{URL} which is active (so that clicking on -it will activate your web browser to ``go to'' the \acro{URL}). In -this case \Package{hyperref} employs the \Package{url} package to -split up the \acro{URL} (as described in % ! line break -\Qref[question]{typesetting \acro{URL}s}{Q-setURL}), but the -\ProgName{dvips} driver then suppresses the breaks. The way out is -the \Package{breakurl} package, which modifies the \csx{url} command -to produce several smaller pieces, between each of which a line break -is permitted. Each group of pieces, that ends up together in one -line, is converted to a single clickable link. - -Second, if you have a table of contents, list of figure or tables, or -the like, \Package{hyperref} will ordinarily make the titles in the -table of contents, or captions in the lists, active. If the title or -caption is long, it will need to break within the table, but the -\ProgName{dvips} driver will prevent that. In this case, load -\Package{hyperref} with the option \pkgoption{linktocpage}, and only -the page number will be made active. - -Otherwise, if you have a lengthy piece of text that you want active, -you have at present no simple solution: you have to rewrite your text, -or to use a different \acro{PDF} generation mechanism. -\begin{ctanrefs} -\item[breakurl.sty]\CTANref{breakurl} -\end{ctanrefs} - -\Question[Q-wrongpn]{Page number is wrong at start of page} - -This is a long story, whose sources are deep inside the workings of -\TeX{} itself; it all derives from the \TeX{}'s striving to generate -the best possible output. - -The page number is conventionally stored in \csx{count0}; \LaTeX{} -users see this as the counter \texttt{page}, and may typeset its value -using \csx{thepage}. - -The number (that is to say, \csx{count0}) is only updated when \TeX{} -actually outputs a page. \TeX{} only even tries to do this when it -detects a hint that it may be a good thing to do. From \TeX{}'s point -of view, the end of a paragraph is a good time to consider outputting -a page; it will output a page if it has \emph{more} than a page's -worth of material to output. (Ensuring it always has something in -hand makes some optimisations possible.) As a result, \csx{count0} -(\csx{thepage}) is almost always wrong in the first paragraph of a -page (the exception is where the page number has been ``forcibly'' -changed, either by changing its value directly, or by breaking the -page where \TeX{} wouldn't necessarily have chosen to break). - -\LaTeX{} provides a safe way of referring to the page number, by using -label references. So, rather than writing: -\begin{quote} -\begin{verbatim} -Here is page \thepage{}. -\end{verbatim} -\end{quote} -you should write: -\begin{quote} -\begin{verbatim} -Here is page \pageref{here}\label{here}. -\end{verbatim} -\end{quote} -(note: no space between the \csx{pageref} and the \csx{label}, since -that could potentially end up as a page-break space itself, which -rather defeats the purpose of the exercise!). - -\Question[Q-matchbrak]{My brackets don't match} - -\AllTeX{} has a low-level mechanism for matching braces in document -text. This means you can type something like: -\begin{quote} -\begin{verbatim} -\section{All \emph{OK} now.} -\end{verbatim} -\end{quote} -and know that the first brace (for the argument of \csx{section}) will -be matched with the last brace, and the internal pair of braces (for -the argument of \csx{emph}) will be matched with each other. It's all -very simple. - -However, \LaTeX{} has a convention of enclosing optional arguments in -brackets, as in: -\begin{quote} -\begin{verbatim} -\section[OK]{All \emph{OK} now.} -\end{verbatim} -\end{quote} -These brackets are not matched by \TeX{} mechanisms, despite the -superficial similarity of their use. As a result, -straightforward-looking usages like: -\begin{quote} -\begin{verbatim} -\section[All [OK] now]{All \emph{OK} now.} -\end{verbatim} -\end{quote} -aren't \acro{OK} at all~--- the optional argument comes to consist of -``All [OK'', and \csx{section} takes the single character ``n'' (of -the first ``now'') as its argument. - -Fortunately, \TeX{}'s scanning mechanisms helps us by accepting the -syntax ``\texttt{\{]\}}'' to `hide' the closing bracket from the -scanning mechanism that \LaTeX{} uses. In practice, the commonest way -to use this facility is: -\begin{quote} -\begin{verbatim} -\section[All {[OK]} now]{All \emph{OK} now.} -\end{verbatim} -\end{quote} -since bracing the bracket on its own ``looks odd''. - -\LaTeX{} has another argument syntax, even less regular, where the -argument is enclosed in parentheses, as in: -\begin{quote} -\begin{verbatim} -\put(1,2){foo} -\end{verbatim} -\end{quote} -(a picture environment command). - -This mechanism is also prone to problems with matching closing -parentheses, but the issue seldom arises since such arguments rarely -contain text. If it were to arise, the same solution (enclosing the -confused characters in braces) would solve the problem. - -\Question[Q-pdf-fig-chars]{Characters disappear from figures in \PDFTeX{}} - -You have a \acro{PDF} figure, which you want to use in your -\PDFLaTeX{} document. When you compile the document, \PDFTeX{} -complains about ``missing glyphs'', and some (or all) of the labelling -text or symbols in the original figure is no longer visible. - -What has happened is: -\begin{enumerate} -\item Your figure file (say \File{fig.pdf}) has a font \File{font.pfb} - embedded in it. -\item \PDFTeX{} notes that it has \File{font.pfb} on disc, and loads - that in place of the copy in \File{fig.pdf}. -\item It turns out that the copy in \File{fig.pdf} has glyphs that - aren't in \File{font.pfb} on disc, so that you get errors while - compiling and you see that characters are missing when you view the - output. (\PDFTeX{} can't know that the fonts are different, since - they have the same name.) -\end{enumerate} -Which is all very undesirable. - -\PDFTeX{} does this to keep file sizes down: suppose you have a -document that loads figures \File{fig1.pdf} and \File{fig2.pdf}; both -of those use font \File{font.pfb}. If \PDFTeX{} takes no action, -there will be \emph{two} copies of \File{font.pfb} in the output. -(If your document also uses the font, there could be three copies.) - -A real case is the \acro{URW} font \File{NimbusRomNo9L-Regu} (a clone -of Times Roman), which is available in a version with Cyrillic -letters, while the version in \TeX{} distributions doesn't have those -letters. Both versions, as distributed, have the same name. - -The simple (``quick and dirty'') solution is to add the command -\begin{quote} - \csx{pdfinclusioncopyfonts}\texttt{=1} -\end{quote} -to the preamble of your document. - -The ``real'' solution is that one or other font should be renamed. In -either case, this would require that you reconfigure some program's -(\TeX{}'s or your drawing package's) font tables~--- inevitably a -tiresome job. - -\subsection{Common misunderstandings} - -\Question[Q-include]{What's going on in my \csx{include} commands?} - -The original \LaTeX{} provided the \csx{include} command to address the -problem of long documents: with the relatively slow computers of the -time, the companion \csx{includeonly} facility was a boon. With the -vast increase in computer speed, \csx{includeonly} is less valuable -(though it still has its place in some very large projects). -Nevertheless, the facility is retained in current \LaTeX{}, and causes -some confusion to those who misunderstand it. - -In order for \csx{includeonly} to work, \csx{include} makes a separate -\extension{aux} file for each included file, and makes a `checkpoint' of -important parameters (such as page, figure, table and footnote -numbers); as a direct result, it \emph{must} clear the current page -both before and after the \csx{include} command. What's more, this -mechanism doesn't work if a \csx{include} command appears in a file -that was \csx{include}d itself: \LaTeX{} diagnoses this as an error. - -So, we can now answer the two commonest questions about \csx{include}: -\begin{itemize} -\item Why does \LaTeX{} throw a page before and after \csx{include} - commands? - - Answer: because it has to. If you don't like it, replace the - \csx{include} command with \csx{input}~--- you won't be able to use - \csx{includeonly} any more, but you probably don't need it anyway, so - don't worry. -\begin{htmlversion} - -\end{htmlversion} -\item Why can't I nest \csx{include}d files?~--- I always used to be - able to under \LaTeXo{}. - - Answer: in fact, you couldn't, even under \LaTeXo{}, but the failure - wasn't diagnosed. However, since you were happy with the behaviour - under \LaTeXo{}, replace the \csx{include} commands with \csx{input} - commands (with \csx{clearpage} as appropriate). -\end{itemize} - - -\Question[Q-paraparam]{Why does it ignore paragraph parameters?} - -When \TeX{} is laying out text, it doesn't work from word to word, or -from line to line; the smallest complete unit it formats is the -paragraph. The paragraph is laid down in a buffer, as it appears, and -isn't touched further until the end-paragraph marker is processed. -It's at this point that the paragraph parameters have effect; and it's -because of this sequence that one often makes mistakes that lead to -the paragraph parameters not doing what one would have hoped (or -expected). - -Consider the following sequence of \LaTeX{}: -\begin{quote} -\begin{verbatim} -{\raggedright % declaration for ragged text -Here's text to be ranged left in our output, -but it's the only such paragraph, so we now -end the group.} - -Here's more that needn't be ragged... -\end{verbatim} -\end{quote} -\TeX{} will open a group, and impose the ragged-setting parameters within -that group; it will then save a couple of sentences of text and -close the group (thus restoring the previous value of the -parameters that \csx{raggedright} set). Then \TeX{} encounters a blank -line, which it knows to treat as a \csx{par} token, so it typesets the -two sentences; but because the enclosing group has now been closed, -the parameter settings have been lost, and the paragraph will be -typeset normally. - -The solution is simple: close the paragraph inside the group, so that -the setting parameters remain in place. An appropriate way of doing -that is to replace the last three lines above with: -\begin{quote} -\begin{verbatim} -end the group.\par} -Here's more that needn't be ragged... -\end{verbatim} -\end{quote} -In this way, the paragraph is completed while \csx{raggedright}'s -parameters are still in force within the enclosing group. - -Another alternative is to define an environment that does the -appropriate job for you. For the above example, \LaTeX{} already -defines an appropriate one: -\begin{quote} -\begin{verbatim} -\begin{flushleft} -Here's text to be ranged left... -\end{flushleft} -\end{verbatim} -\end{quote} - -In fact, there are a number of parameters for which \TeX{} only -maintains one value per paragraph. A tiresome one is the set of upper -case/lower case translations, which (oddly enough) constrains -hyphenation of mutilingual texts. Another that regularly creates -confusion is \Qref*{\csx{baselineskip}}{Q-baselinepar}. - -\Question[Q-casechange]{Case-changing oddities} - -\TeX{} provides two primitive commands \csx{uppercase} and -\csx{lowercase} to change the case of text; they're not much used, but -are capable creating confusion. - -The two commands do not expand the text that is their parameter~--- -the result of \cmdinvoke{uppercase}{abc} is `\texttt{ABC}', but -\cmdinvoke{uppercase}{\csx{abc}} is always `\csx{abc}', whatever the -meaning of \csx{abc}. The commands are simply interpreting a table of -equivalences between upper- and lowercase characters. -They have (for example) no mathematical sense, and -\begin{quote} -\begin{verbatim} -\uppercase{About $y=f(x)$} -\end{verbatim} -\end{quote} -will produce -\begin{quote} -\begin{verbatim} -ABOUT $Y=F(X)$ -\end{verbatim} -\end{quote} -which is probably not what is wanted. - -In addition, \csx{uppercase} and \csx{lowercase} do not deal very well -with non-American characters, for example -\cmdinvoke{uppercase}{\csx{ae}} is the same as \csx{ae}. - -\LaTeX{} provides commands \csx{MakeUppercase} and \csx{MakeLowercase} -which fixes the latter problem. These commands are used in the -standard classes to produce upper case running heads for chapters -and sections. - -Unfortunately \csx{MakeUppercase} and \csx{MakeLowercase} do not solve -the other problems with \csx{uppercase}, so for example a section -title containing \cmdinvoke{begin}{tabular} \dots{} -\cmdinvoke{end}{tabular} will produce a running head containing -\cmdinvoke{begin}{TABULAR}. The simplest solution to this problem is -using a user-defined command, for example: -\begin{quote} -\begin{verbatim} -\newcommand{\mytable}{\begin{tabular}... - \end{tabular}} -\section{A section title \protect\mytable{} - with a table} -\end{verbatim} -\end{quote} -Note that \csx{mytable} has to be protected, otherwise it will be -expanded and made upper case; you can achieve the same result by -declaring it with \csx{DeclareRobustCommand}, in which case the -\csx{protect} won't be necessary. - -David Carlisle's \Package{textcase} package -addresses many of these problems in a transparent way. It defines -commands \csx{MakeTextUppercase} and \csx{MakeTextLowercase} which do -upper- or lowercase, with the fancier features of the \LaTeX{} -standard \csx{Make*}-commands but without the problems -mentioned above. Load the package with -\cmdinvoke{usepackage}[overload]{textcase}, and it will redefine the \LaTeX{} -commands (\emph{not} the \TeX{} primitive commands \csx{uppercase} and -\csx{lowercase}), so that section headings and the like don't produce -broken page headings. -\begin{ctanrefs} -\item[textcase.sty]\CTANref{textcase} -\end{ctanrefs} - -\Question[Q-splitfoot]{Why does \LaTeX{} split footnotes across pages?} - -\LaTeX{} splits footnotes when it can think of nothing better to do. -Typically, when this happens, the footnote mark is at the bottom of -the page, and the complete footnote would overfill the page. \LaTeX{} -could try to salvage this problem by making the page short of both the -footnote and the line with the footnote mark, but its priorities told -it that splitting the footnote would be preferable. - -As always, the best solution is to change your text so that the -problem doesn't occur in the first place. Consider whether the text -that bears the footnote could move earlier in the current page, or on -to the next page. - -If this isn't possible, you might want to change \LaTeX{}'s perception -of its priorities: they're controlled by -\csx{interfootnotelinepenalty}~--- the larger it is, the less willing -\LaTeX{} is to split footnotes. - -Setting -\begin{quote} -\begin{verbatim} -\interfootnotelinepenalty=10000 -\end{verbatim} -\end{quote} -inhibits split footnotes altogether, which will cause `\texttt{Underfull} -\csx{vbox}' messages unless you also specify \csx{raggedbottom}. The -default value of the penalty is \texttt{100}, which is rather mild. - -An alternative technique is to juggle with the actual size of the -pages. \csx{enlargethispage} changes the size of the current page by -its argument (for example, you might say -\cmdinvoke{enlargethispage}{\csx{baselineskip}} to add a single line -to the page, but you can use any ordinary \TeX{} length such as -\texttt{15mm} or \texttt{-20pt} as argument). Reducing the size of -the current page could force the offending text to the next page; -increasing the size of the page may allow the footnote to be included -in its entirety. It may be necessary to change the size of more than -one page. - -The \Package{fnbreak} package detects (and generates warnings about) -split footnotes. -\begin{ctanrefs} -\item[fnbreak.sty]\CTANref{fnbreak} -\end{ctanrefs} - -\Question[Q-marginparside]{Getting \csx{marginpar} on the right side} - -In an ideal world, marginal notes would be in ``analogous'' places on -every page: notes on an even-side page would be in the left margin, -while those on an odd-side page would be in the right margin. A -moment's thought shows that a marginal note on the left needs to be -typeset differently from a marginal note on the right. The \LaTeX{} -\csx{marginpar} command therefore takes two arguments in a -\texttt{twoside} documents: % beware line break -\cmdinvoke*{marginpar}[left text]{right text}. \LaTeX{} uses the -``obvious'' test to -get the \csx{marginpar}s in the correct margin, but a booby-trap arises -because \TeX{} runs its page maker asynchronously. If a -\csx{marginpar} is processed while page \ensuremath{n} is being built, but -doesn't get used until page \ensuremath{n}+1, then the \csx{marginpar} will turn -up on the wrong side of the page. This is an instance of a general -problem: see -% beware line break -``\Qref*{finding if you're on an odd or an even page}{Q-oddpage}''. - -The solution to the problem is for \LaTeX{} to `remember' which side -of the page each \csx{marginpar} \emph{should} be on. The -\Package{mparhack} package does this, using label-like marks stored in -the \extension{aux} file; the \Class{memoir} class does likewise. -\begin{ctanrefs} -\item[memoir.cls]\CTANref{memoir} -\item[mparhack.sty]\CTANref{mparhack} -\end{ctanrefs} - -\Question[Q-misschar]{Where have my characters gone?} - -You've typed some apparently reasonable text and processed it, but the -result contains no sign of some of the characters you typed. A likely -reason is that the font you selected just doesn't have a -representation for the character in question. - -For example, if I type ``that will be \pounds{}44.00'' into an ordinary -\AllTeX{} document, or if I select the font |rsfs10| (which contains -uppercase letters only) and type pretty much anything, the \pounds{} -sign, or any lowercase letters or digits will not appear in the -output. There's no actual error message, either: you have to read the -log file, where you'll find cryptic little messages like -\begin{quote} -\begin{wideversion} -\begin{verbatim} -Missing character: There is no ^^a3 in font cmr10! -Missing character: There is no 3 in font rsfs10! -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -Missing character: - There is no ^^a3 in font cmr10! -Missing character: - There is no 3 in font rsfs10! -\end{verbatim} -\end{narrowversion} -\end{quote} -(the former demonstrating my \TeX{}'s unwillingness to deal in characters -which have the eighth bit set, while the \texttt{rsfs10} example shows that -\TeX{} will log the actual character in error, if it thinks it's -possible). - -Somewhat more understandable are the diagnostics you may get from -\Package{dvips} when using the \acro{OT}1 and \acro{T}1 versions of -fonts that were supplied in Adobe standard encoding: -\begin{quote} -\begin{verbatim} -dvips: Warning: missing glyph `Delta' -\end{verbatim} -\end{quote} -The process that generates the metrics for using the fonts generates -an instruction to \Package{dvips} to produce these diagnostics, so -that their non-appearance in the printed output is less surprising -than it might be. Quite a few glyphs provided in Knuth's text -encodings and in the Cork encoding are not available in the Adobe -fonts. In these cases, there \emph{is} a typeset sign of the -character: \ProgName{dvips} produces a black rectangle of whatever -size the concocted font file has specified. - -\Question[Q-rerun]{``Rerun'' messages won't go away} - -The \LaTeX{} message ``Rerun to get crossreferences right'' is -supposed to warn the user that the job needs to be processed again, -since labels seem to have changed since the previous run. (\LaTeX{} -compares the labels it has created this time round with what it found -from the previous run when it started; it does this comparison at -\cmdinvoke{end}{document}.) - -Sometimes, the message won't go away: however often you reprocess your -document, \LaTeX{} still tells you that ``Label(s) may have -changed''. This can sometimes be caused by a broken package: both -\Package{footmisc} (with the |perpage| option) and \Package{hyperref} -have been known to give trouble, in the past: if you are using either, -check you have the latest version, and upgrade if possible. - -However, there \emph{is} a rare occasion when this error can happen -as a result of pathological structure of the document itself. Suppose -you have pages numbered in roman, and you add a reference to a label -on page ``ix'' (9). The presence of the reference pushes the thing -referred to onto page ``x'' (10), but since that's a shorter reference -the label moves back to page ``ix'' at the next run. Such a sequence -can obviously not terminate. - -The only solution to this problem is to make a small change to your -document (something as small as adding or deleting a comma will often -be enough). -\begin{ctanrefs} -\item[footmisc.sty]\CTANref{footmisc} -\item[hyperref.sty]\CTANref{hyperref} -\end{ctanrefs} - -\Question[Q-xspace]{Commands gobble following space} - -People are forever surprised that simple commands gobble the space -after them: this is just the way it is. The effect arises from the -way \TeX{} works, and Lamport describes a solution (place a pair of braces -after a command's invocation) in the description of \LaTeX{} syntax. -Thus the requirement is in effect part of the definition of \LaTeX{}. - -This \acro{FAQ}, -for example, is written with definitions that \emph{require} one to -type \cmdinvoke{fred}{\relax} % the \relax prevents {} being gobbled - % in html production (sigh) -for almost all macro invocations, regardless -of whether the following space is required: however, this \acro{FAQ} -is written by highly dedicated (and, some would say, eccentric) -people. Many users find all those braces become very tedious very -quickly, and would really rather not type them all. - -An alternative structure, that doesn't violate the design of \LaTeX{}, -is to say \csx{fred}\csx{ }~--- the \csx{ } command is ``self -terminating'' (like |\|{}|\|) and you don't need braces after -\emph{it}. Thus one can reduce to one the extra characters one needs -to type. - -If even that one character is too many, the package \Package{xspace} -defines a command \csx{xspace} that guesses whether there should have -been a space after it, and if so introduces that space. So -% beware line wrap -``\texttt{fred\csx{xspace} jim}'' produces ``fred jim'', while -``\texttt{fred\csx{xspace}.\@ jim}'' produces ``fred. jim''. Which -usage would of course be completely pointless; but you can incorporate -\csx{xspace} in your own macros: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\usepackage{xspace} -... -\newcommand{\restenergy}{\ensuremath{mc^2}\xspace} -... -and we find \restenergy available to us... -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\usepackage{xspace} -... -\newcommand{\restenergy}% - {\ensuremath{mc^2}\xspace} -... -and we find \restenergy available to us... -\end{verbatim} -\end{narrowversion} -\end{quote} -The \csx{xspace} command must be the last thing in your macro -definition (as in the example); it's not completely foolproof, but it -copes with most obvious situations in running text. - -The \Package{xspace} package doesn't save you anything if you only use -a modified macro once or twice within your document. In any case, be -careful with usage of \csx{xspace}~--- it changes your input syntax, -which can be confusing, notably to a collaborating author -(particularly if you create some commands which use it and some which -don't). Of course, no command built into \LaTeX{} or into any -``standard'' class or package will use \csx{xspace}. -\begin{ctanrefs} -\item[xspace.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-overfull]{\AllTeX{} makes overfull lines} - -When \TeX{} is building a paragraph, it can make several attempts to -get the line-breaking right; on each attempt it runs the same -algorithm, but gives it different parameters. You can affect the way -\TeX{}'s line breaking works by adjusting the parameters: this answer -deals with the ``tolerance'' and stretchability parameters. The other -vital `parameter' is the set of hyphenations to be applied: see -``\Qref*[question]{my words aren't being hyphenated}{Q-nohyph}'' -(and the questions it references) for advice. - -If you're getting an undesired ``overfull box'', what has happened is -that \TeX{} has given up: the parameters you gave it don't allow it to -produce a result that \emph{doesn't} overfill. In this circumstance, -Knuth decided the best thing to do was to produce a warning, and to -allow the user to solve the problem. (The alternative, silently to go -beyond the envelope of ``good taste'' defined for this run of \TeX{}, -would be distasteful to any discerning typographer.) The user can -almost always address the problem by rewriting the text that's -provoking the problem~--- but that's not always possible, and in some -cases it's impossible to solve the problem without adjusting the -parameters. This answer discusses the approaches one might take to -resolution of the problem, on the assumption that you've got the -hyphenation correct. - -The simplest case is where a `small' word fails to break at the end of -a line; pushing the entire word to a new line isn't going to make much -difference, but it might make things just bad enough that \TeX{} won't -do it by default. In such a case on can \emph{try} the \LaTeX{} -\csx{linebreak} command: it may solve the problem, and if it does, it -will save an awful lot of fiddling. Otherwise, one needs to adjust -parameters: to do that we need to recap the details of \TeX{}'s line -breaking mechanisms. - -\TeX{}'s first attempt at breaking lines is performed without even -trying hyphenation: \TeX{} sets its ``tolerance'' of line breaking -oddities to the internal value \csx{pretolerance}, and sees what -happens. If it can't get an acceptable break, \TeX{} adds the -hyphenation points allowed by the current patterns, and tries again -using the internal \csx{tolerance} value. If this pass also fails, and -the internal \csx{emergencystretch} value is positive, \TeX{} will try -a pass that allows \csx{emergencystretch} worth of extra stretchability -to the spaces in each line. - -In principle, therefore, there are three parameters (other than -hyphenation) that you can change: \csx{pretolerance}, \csx{tolerance} -and \csx{emergencystretch}. Both the \texttt{tolerance} values are -simple numbers, and should be set by \TeX{} primitive count -assignment~--- for example -\begin{quote} -\begin{verbatim} -\pretolerance=150 -\end{verbatim} -\end{quote} -For both, an ``infinite'' tolerance is represented by the value -|10|\nothtml{\,}|000|, but infinite tolerance is rarely -appropriate, since it can lead to very bad line breaks indeed. - -\csx{emergencystretch} is a \TeX{}-internal `dimen' register, and can -be set as normal for dimens in \plaintex{}; in \LaTeX{}, use -\csx{setlength}~--- for example: -\begin{quote} -\begin{verbatim} -\setlength{\emergencystretch}{3em} -\end{verbatim} -\end{quote} - -The choice of method has time implications~--- each of the -passes takes time, so adding a pass (by changing -\csx{emergencystretch}) is less desirable than suppressing one (by -changing \csx{pretolerance}). However, it's unusual nowadays to find a -computer that's slow enough that the extra passes are really -troublesome. - -In practice, \csx{pretolerance} is rarely used other than to manipulate -the use of hyphenation; \plaintex{} and \LaTeX{} both set its value -to |100|. To suppress the first scan of paragraphs, set -\csx{pretolerance} to |-1|. - -\csx{tolerance} is often a good method for adjusting spacing; -\plaintex{} and \LaTeX{} both set its value to |200|. \LaTeX{}'s -\csx{sloppy} command sets it to |9999|, as does the -\environment{sloppypar} environment. This value is the largest -available, this side of infinity, and can allow pretty poor-looking -breaks (this author rarely uses \csx{sloppy} ``bare'', though he does -occasionally use \environment{sloppypar}~--- that way, the change of -\csx{tolerance} is confined to the environment). More satisfactory is -to make small changes to \csx{tolerance}, incrementally, and then to look to -see how the change affects the result; very small increases can often -do what's necessary. Remember that \csx{tolerance} is a paragraph -parameter, so you need to ensure it's actually applied~--- see -``\Qref*[question]{ignoring paragraph parameters}{Q-paraparam}''. -\LaTeX{} users could use an environment like: -\begin{quote} -\begin{verbatim} -\newenvironment{tolerant}[1]{% - \par\tolerance=#1\relax -}{% - \par -} -\end{verbatim} -\end{quote} -enclosing entire paragraphs (or set of paragraphs) in it. - -The value of \csx{emergencystretch} is added to the assumed -stretchability of each line of a paragraph, in a further run of the -paragraph formatter in case that the paragraph can't be made to look -right any other way. (The extra scan happens if -\csx{emergencystretch\textgreater0pt}~--- if it's zero or negative, no gain -could be had from rerunning the paragraph setter.) The example above -set it to \texttt{3em}; the Computer Modern fonts ordinarily fit three -space skips to the \texttt{em}, so the change would allow anything up -to the equivalent of nine extra spaces in each line. In a line with -lots of spaces, this could be reasonable, but with (say) only three -spaces on the line, each could stretch to four times its natural -width. It is therefore clear that \csx{emergencystretch} needs to be -treated with a degree of caution. - -More subtle (but more tricky to manage) are the microtypographic -extensions provided by \PDFTeX{}. Since \PDFTeX{} is the default -`engine' for \LaTeX{} and \CONTeXT{} work in all distributions, -nowadays, the extensions are available to all. There are two -extensions, margin kerning and font expansion; margin kerning only -affects the visual effect of the typeset page, and has little effect -on the ability of the paragraph setter to ``get things right''. -Font expansion works like a subtler version of the trick that -\csx{emergencystretch} plays: \PDFTeX{} `knows' that your current font -may be stretched (or shrunk) to a certain extent, and will do that -``on the fly'' to optimise the setting of a paragraph. This is a -powerful tool in the armoury of the typesetter. - -As mentioned above, the microtypographic extensions are tricky beasts -to control; however, the \Package{microtype} package relieves the user -of the tedious work of specifying how to perform margin adjustments -and how much to scale each font~\dots{}\@ for the fonts the package -knows about; it's a good tool, and users who can take on the -specification of adjustments for yet more fonts are always welcome. -\begin{ctanrefs} -\item[microtype.sty]\CTANref{microtype} -\end{ctanrefs} - -\Question[Q-exscale]{Maths symbols don't scale up} - -By default, the ``large'' maths symbols stay at the same size -regardless of the font size of the text of the document. There's good -reason for this: the \FontName{cmex} fonts aren't really designed to -scale, so that \TeX{}'s maths placement algorithms don't perform as -well as they might when the fonts are scaled. - -However, this behaviour confounds user expectations, and can lead to -slightly odd-looking documents. If you want the fonts to scale, -despite the warning above, use the \Package{exscale} package~--- just -loading it is enough. -%% -%% (Note: if you are using bitmap versions of the \FontName{cmex} fonts, -%% you will find extra bitmaps are generated. The extended sizes are not -%% ordinarily generated for any other purpose.) -\begin{ctanrefs} -\item[exscale.sty]Part of the \LaTeX{} distribution. -\end{ctanrefs} - -\Question[Q-linespread]{Why doesn't \csx{linespread} work?} - -The command \cmdinvoke*{linespread}{factor} is supposed to multiply -the current \csx{baselineskip} by \meta{factor}; but, to all -appearances, it doesn't. - -In fact, the command is equivalent to -\cmdinvoke{renewcommand}{\csx{baselinestretch}}{factor}: written that -way, it somehow feels less surprising that the effect isn't immediate. -The \csx{baselinestretch} factor is only used when a font is selected; -a mere change of \csx{baselinestretch} doesn't change the font, any -more than does the command -\cmdinvoke*{fontsize}{size}{baselineskip}~--- you have to follow -either command with \csx{selectfont}. So: -\begin{quote} -\begin{verbatim} -\fontsize{10}{12}% -\selectfont -\end{verbatim} -\end{quote} -or: -\begin{quote} -\begin{verbatim} -\linespread{1.2}% -\selectfont -\end{verbatim} -\end{quote} -Of course, a package such as \Package{setspace}, whose job is to -manage the baseline, will deal with all this stuff~--- see -``\Qref*[question]{managing double-spaced documents}{Q-linespace}''. If -you want to avoid \Package{setspace}, beware the behaviour of -linespread changes within a paragraph: read % ! line break -``\Qref*[question]{\csx{baselineskip} is a paragraph parameter}{Q-baselinepar}''. -\begin{ctanrefs} -\item[setspace.sty]\CTANref{setspace} -\end{ctanrefs} - -\Question[Q-baselinepar]{Only one \csx{baselineskip} per paragraph} - -The \csx{baselineskip} is not (as one might hope) a property of a -line, but of a paragraph. As a result, in a \texttt{10pt} (nominal) -document (with a default \csx{baselineskip} of \texttt{12pt}), a -single character with a larger size, as: -\begin{quote} -\begin{verbatim} -{\Huge A} -\end{verbatim} -\end{quote} -will be squashed into the paragraph: \TeX{} will make sure it doesn't -scrape up against the line above, but won't give it ``room to -breathe'', as it does the text at standard size; that is, its size -(\texttt{24.88pt}) is taken account of, but its \csx{baselineskip} -(\texttt{30pt}) isn't. Similarly -\begin{quote} -\begin{verbatim} -Paragraph text ... -{\footnotesize Extended interjection ... - ... into the paragraph.} - ... paragraph continues ... -\end{verbatim} -\end{quote} -will look silly, since the \texttt{8pt} interjection will end up set -on the \texttt{12pt} \csx{baselineskip} of the paragraph, rather than -its preferred \texttt{8.5pt}. Finally, something like -\begin{quote} -\begin{verbatim} -Paragraph text ... - ... paragraph body ends. -{\footnotesize Short comment on paragraph.} - -Next paragraph starts... -\end{verbatim} -\end{quote} -will set the body of the first paragraph on the constricted -\csx{baselineskip} of the \csx{footnotesize} comment. - -So, how to deal with these problems? The oversized (short) section is -typically corrected by a \emph{strut}: this word comes from movable -metal typography, and refers to a spacer that held the boxes (that -contained the metal character shapes) apart. Every time you change -font size, \LaTeX{} redefines the command \csx{strut} to provide the -equivalent of a metal-type strut for the size chosen. So for the -example above, we would type -\begin{quote} -\begin{verbatim} -Paragraph text ... - {\Huge A\strut} - ... paragraph continues ... -\end{verbatim} -\end{quote} -However, more extended insertions (whether of larger or smaller text) -are always going to cause problems; while you can strut larger text, -ensuring that you strut every line will be tiresome, and there's no -such thing as a ``negative strut'' that pulls the lines together for -smaller text. - -The only satisfactory way to deal with an extended insertion at a -different size is to set it off as a separate paragraph. A -satisfactory route to achieving this is the \environment{quote} -environment, which sets its text modestly inset from the enclosing -paragraph: -\begin{quote} -\begin{verbatim} -Paragraph text ... -\begin{quote} - \footnotesize This is an inset account - of something relevant to the enclosing - paragraph... -\end{quote} -... paragraph continues ... -\end{verbatim} -\end{quote} -Such quote-bracketing also deals with the problem of a trailing -comment on the paragraph. - -\Question[Q-tocloftwrong]{Numbers too large in table of contents, etc.} - -\LaTeX{} constructs the table of contents, list of figures, tables, -and similar tables, on the basis of a layout specified in the class. -As a result, they do \emph{not} react to the sizes of things in them, -as they would if a \environment{tabular} environment (or something -similar) was used. - -This arrangement can provoke problems, most commonly with deep section -nesting or very large page numbers: the numbers in question just don't -fit in the space allowed for them in the class. - -A separate answer discusses % ! line break -\nothtml{re-designing the tables ---} % ! line break -\Qref{re-designing the tables}{Q-tocloft}\nothtml{ ---} -and those techniques can be employed to make the numbers fit. - -\Question[Q-gutter]{Why is the inside margin so narrow?} - -If you give the standard classes the \pkgoption{twoside} option, the -class sets the margins narrow on the left of odd-numbered pages, and -on the right of even-numbered pages. This is often thought to look -odd, but it is quite right. - -The idea is that the typographic urge for symmetry should also apply -to margins: if you lay an even numbered page to the left of an -odd-numbered one, you will see that you've three equal chunks of -un-printed paper: the left margin of the even page, the right margin -of the odd page, and the two abutting margins together. - -This is all very fine in the abstract, but in practical book(let) -production it only works ``sometimes''. - -If your booklet is produced on double-width paper and stapled, the -effect will be good; if your book(let) is produced using a so-called -``perfect'' binding, the effect will again be good. - -However, almost any ``quality'' book-binder will need some of your -paper to grab hold of, and a book bound in such a way won't exhibit -the treasured symmetry unless you've done something about the margin -settings. - -The packages recommended in % ! line break -``\Qref*{setting up margins}{Q-marginpkgs}'' mostly have provision for -a ``binding offset'' or a ``binding correction''~--- search for -``binding'' in the manuals (\Package{vmargin} doesn't help, here). - -If you're doing the job by hand (see % ! line break -\Qref[question]{manual margin setup}{Q-marginmanual}), the trick is to -calculate your page and margin dimensions as normal, and then: -\begin{itemize} -\item subtract the binding offset from \csx{evensidemargin}, and -\item add the binding offset to \csx{oddsidemargin}. -\end{itemize} -which can be achieved by: -\begin{quote} -\begin{verbatim} -\addtolength{\evensidemargin}{-offset} -\addtolength{\oddsidemargin}{offset} -\end{verbatim} -\end{quote} -(substituting something sensible like ``\texttt{5mm}'' for -``\texttt{offset}'', above). - -The above may not be the best you can do: you may well choose to -change the \csx{textwidth} in the presence of the binding offset; but -the changes do work for constant \csx{textwidth}. - -\subsection{Why shouldn't I?} - -\Question[Q-t1enc]{Why use \Package{fontenc} rather than \Package{t1enc}?} - -In the very earliest days of \LaTeXe{}, the only way to use the -\acro{T}1 encoding was \Package{t1enc}; with the summer 1994 -``production'' release, the \Package{fontenc} package appeared, and -provided comprehensive support for use of the encoding. - -Nevertheless, the \Package{t1enc} package remains (as part of the -\LaTeXo{} compatibility code), but it does very little: it merely -selects font encoding \acro{T}1, and leaves to the user the business -of generating the character codes required. - -Generating such character codes could be a simple matter, \emph{if} -the \acro{T}1 encoding matched any widely-supported encoding standard, -since in that case, one might expect one's keyboard to generate the -character codes. However, the \acro{T}1 encoding is a mix of several -standard encodings, and includes code points in areas of the table -which standard encodings specifically exclude, so no \acro{T}1 -keyboards have been (or ever will be) manufactured. - -By contrast, the \Package{fontenc} package generates the \acro{T}1 -code points from ordinary \LaTeX{} commands (e.g., it generates the -\texttt{\'e} character codepoint from the command |\'|{}|e|). So, unless you -have program-generated \acro{T}1 input, use -\cmdinvoke{usepackage}[T1]{fontenc} rather than -\cmdinvoke{usepackage}{t1enc}. - -\Question[Q-why-inp-font]{Why bother with \Package{inputenc} and \Package{fontenc}?} - -The standard input encoding for Western Europe (pending the arrival of -Unicode) is \acro{ISO}~8859--1 (commonly known by the standard's -subtitle `Latin-1'). Latin-1 is remarkably close, in the codepoints -it covers, to the \AllTeX{} \acro{T}1 encoding. - -In this circumstance, why should one bother with \Package{inputenc} -and \Package{fontenc}? Since they're pretty exactly mirroring each -other, one could do away with both, and use just \Package{t1enc}, -despite its \Qref*{shortcomings}{Q-t1enc}. - -One doesn't do this for a variety of small reasons: -\begin{description} -\item[Confusion] You've been happily working in this mode, and for - some reason find you're to switch to writing in German: the effect - of using ``\texttt{\ss}'' is somewhat startling, since \acro{T}1 - and Latin-1 treat the codepoint differently. -\item[Compatibility] You find yourself needing to work with a - colleague in Eastern Europe: their keyboard is likely to be set to - produce Latin-2, so that the simple mapping doesn't work. -\item[Traditional \LaTeX{}] You lapse and write something like - |\'|{}|e| rather than typing \texttt{\'e}; only \Package{fontenc} - has the means to convert this \LaTeX{} sequence into the \acro{T}1 - character, so an \csx{accent} primitive slips through into the - output, and hyphenation is in danger. -\end{description} -The \Package{inputenc}--\Package{fontenc} combination seems slow and -cumbersome, but it's safe. - -\Question[Q-eqnarray]{Why not use \environment{eqnarray}?} - -The environment \environment{eqnarray} is attractive for the -occasional user of mathematics in \LaTeX{} documents: it seems to -allow aligned systems of equations. Indeed it \emph{does} supply such -things, but it makes a serious mess of spacing. In the system: -\begin{quote} -\begin{verbatim} -\begin{eqnarray} - a & = & b + c \\ - x & = & y - z -\end{eqnarray} -\end{verbatim} -\end{quote} -the spacing around the ``='' signs is \emph{not} that defined in the -metrics for the font from which the glyph comes~--- it's -\csx{arraycolsep}, which may be set to some very odd value for reasons -associated with real arrays elsewhere in the document. - -The user is far better served by the \AMSLaTeX{} bundle, which -provides an \environment{align} environment, which is designed with -the needs of mathematicians in mind (as opposed to the convenience of -\LaTeX{} programmers). For this simple case (align is capable of far -greater things), code as: -\begin{quote} -\begin{verbatim} -\begin{align} - a & = b + c \\ - x & = y - z -\end{align} -\end{verbatim} -\end{quote} -\begin{ctanrefs} -\item[AMSLaTeX]\CTANref{amslatex} -\end{ctanrefs} - -\Question[Q-dolldoll]{Why use \csx{[}\,\dots{}\csx{]} in place of \texttt{\$\$}\,\dots{}\texttt{\$\$}?} - -\LaTeX{} defines inline- and display-maths commands, apparently -analogous to those that derive from the \TeX{} primitive maths -sequences bracketing maths commands with single dollar signs (or pairs -of dollar signs). - -As it turns out, \LaTeX{}'s inline maths grouping, % !line break -\csx{(}\texttt{ ... }\csx{)}, has precisely the same effect as the -\TeX{} primitive version \texttt{\$ ... \$}. (Except that -the \LaTeX{} version checks to ensure you don't put \csx{(} and -\csx{)} the wrong way round.) - -In this circumstance, one often finds \LaTeX{} users, who have some -experience of using \plaintex{}, merely assuming that \LaTeX{}'s -display maths grouping \csx{[}\texttt{ ... }\csx{]} may be replaced by -the \TeX{} primitive display maths \texttt{\$\$ ... \$\$}. - -Unfortunately, they are wrong: if \LaTeX{} code is going to patch display -maths, it can only do so by patching \csx{[} and \csx{]}. The most -obvious way this turns up, is that the class option \pkgoption{fleqn} -simply does not work for equations coded using % beware line break -\texttt{\$\$ ... \$\$}, whether you're using the standard classes -alone, or using package \Package{amsmath}. Also, the \csx{[} and -\csx{]} has code for rationalising vertical spacing in some extreme -cases; that code is not available in \texttt{\$\$ ... \$\$}, so if you -use the non-standard version, you may occasionally observe -inconsistent vertical spacing . - -There are more subtle effects (especially with package -\Package{amsmath}), and the simple rule is % ! line break -\csx{[}\texttt{ ... }\csx{]} whenever -unadorned displayed maths is needed in \LaTeX{}. - -\Question[Q-2letterfontcmd]{What's wrong with \csx{bf}, \csx{it}, etc.?} - -The font-selection commands of \LaTeXo{} were \csx{rm}, \csx{sf}, -\csx{tt}, \csx{it}, \csx{sl}, \csx{em} and \csx{bf}; they were modal -commands, so you used them as: -\begin{quote} -\begin{verbatim} -{\bf Fred} was {\it here\/}. -\end{verbatim} -\end{quote} -with the font change enclosed in a group, so as to limit its effect; -note the italic correction command \csx{/} that was necessary at the -end of a section in italics. - -At the release of \LaTeXe{} in summer 1994, these simple commands were -deprecated, but recognising that their use is deeply embedded in the -brains of \LaTeX{} users, the commands themselves remain in \LaTeX{}, -\emph{with their \LaTeXo{} semantics}. Those semantics were part of -the reason they were deprecated: each |\|\emph{\texttt{xx}} overrides -any other font settings, keeping only the size. So, for example, -\begin{quote} -\begin{verbatim} -{\bf\it Here we are again\/} -\end{verbatim} -\end{quote} -ignores \csx{bf} and produces text in italic, medium weight (and the -italic correction has a real effect), whereas -\begin{quote} -\begin{verbatim} -{\it\bf happy as can be\/} -\end{verbatim} -\end{quote} -ignore \csx{it} and produces upright text at bold weight (and the -italic correction has nothing to do). The same holds if you mix -\LaTeXe{} font selections with the old style commands: -\begin{quote} -\begin{verbatim} -\textbf{\tt all good friends} -\end{verbatim} -\end{quote} -ignores the \csx{textbf} that encloses the text, and produces -typewriter text at medium weight. - -So why are these commands deprecated?~--- it is because of confusions -such as that in the last example. The alternative (\LaTeXe{}) -commands are discussed in the rest of this answer. - -\LaTeXe{}'s font commands come in two forms: modal commands and -text-block commands. The default set of modal commands offers weights -\csx{mdseries} and \csx{bfseries}, shapes \csx{upshape}, -\csx{itshape}, \csx{scshape} and \csx{slshape}, and families -\csx{rmfamily}, \csx{sffamily} and \csx{ttfamily}. A font selection -requires a family, a shape and a series (as well as a size, of -course). A few examples -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -{\bfseries\ttfamily - and jolly good company!} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -{\bfseries\ttfamily and jolly good company!} -\end{verbatim} -\end{wideversion} -\end{quote} -produces bold typewriter text (but note the lack of a % ! line break, big time -\begin{narrowversion} % non hyper version - bold typewriter font~--- \Qref{}{Q-bold-extras}~--- -\end{narrowversion} -\begin{wideversion} - \Qref{bold typewriter font}{Q-bold-extras} -\end{wideversion} -in the default Computer Modern fonts), or -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -{\slshape\sffamily - Never mind the weather\/} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -{\slshape\sffamily Never mind the weather\/} -\end{verbatim} -\end{wideversion} -\end{quote} -(note the italic correction needed on slanted fonts, too). - -\LaTeXe{}'s text block commands take the first two letters of the -modal commands, and form a \csx{text}\emph{\texttt{xx}} command from -them. Thus \csx{bfseries} becomes \cmdinvoke*{textbf}{text}, -\csx{itshape} becomes \cmdinvoke*{textit}{text}, and \csx{ttfamily} -becomes \cmdinvoke*{texttt}{text}. Block commands may be nested, as: -\begin{quote} -\begin{verbatim} -\textit{\textbf{Never mind the rain}} -\end{verbatim} -\end{quote} -to produce bold italic text (note that the block commands supply -italic corrections where necessary), and they be nested with the -\LaTeXe{} modal commands, too: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\texttt{\bfseries - So long as we're together} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\texttt{\bfseries So long as we're together} -\end{verbatim} -\end{wideversion} -\end{quote} -for bold typewriter, or -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -{\slshape\textbf{% - Whoops! she goes again}\/} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -{\slshape \textbf{Whoops! she goes again}\/} -\end{verbatim} -\end{wideversion} -\end{quote} -for a bold slanted instance of the current family (note the italic -correction applied at the end of the modal command group, again). - -The new commands (as noted above) override commands of the same type. -In almost all cases, this merely excludes ludicrous ideas such as -``upright slanted'' fonts, or ``teletype roman'' fonts. There are a -couple of immediate oddities, though. The first is the conflict -between \csx{itshape} (or \csx{slshape}) and \csx{scshape}: while many -claim that an italic small-caps font is typographically unsound, such -fonts do exist. Daniel Taupin's \Package{smallcap} package enables -use of the instances in the \Qref*{\acro{EC} fonts}{Q-ECfonts}, and -similar techniques could be brought to bear on many other font sets. -The second is the conflict between \csx{upshape} and \csx{itshape}: -Knuth actually offers an upright-italic font which \LaTeX{} uses for -the ``\pounds{}'' symbol in the default font set. The combination is -sufficiently weird that, while there's a defined font shape, no -default \LaTeX{} commands exist; to use the shape, the (eccentric) user -needs \LaTeX{}'s simplest font selection commands: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -{\fontshape{ui}\selectfont - Tra la la, di dee} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -{\fontshape{ui}\selectfont Tra la la, di dee} -\end{verbatim} -\end{wideversion} -\end{quote} -\begin{ctanrefs} -\item[smallcap.sty]\CTANref{smallcap} -\end{ctanrefs} - -\Question[Q-newfont*]{What's wrong with \csx{newfont}?} - -If all else fails, you \emph{can} specify a font using the \LaTeX{} -\csx{newfont} command. The font so specified doesn't fit into the -\LaTeX{} font selection mechanism, but the technique can be tempting -under several circumstances. The command is merely the thinnest of -wrappers around the \csx{font} primitive, and doesn't really fit with -\LaTeX{} at all. A simple, but really rather funny, example of the -problems it poses, may be seen in: -\begin{quote} -\begin{verbatim} -\documentclass[10pt]{article} -\begin{document} -\newfont{\myfont}{cmr17 scaled 2000} -\myfont -\LaTeX -\end{document} -\end{verbatim} -\end{quote} -(the reader is encouraged to try this). The ``A'' of \csx{LaTeX} pretty -much disappears: \LaTeX{} chooses the size on the ``A'' according to -\emph{its} idea of the font size (10pt), but positions it according to -the dimensions of ``\csx{myfont}'', which is more than three times -that size. - -Another ``\csx{myfont}'' example arises from an entirely different -source. The mini-document: -\begin{quote} -\begin{verbatim} -\documentclass{article} -\begin{document} -\newfont{\myfont}{ecrm1000} -{\myfont voil\`a} -\end{document} -\end{verbatim} -\end{quote} -gives you ``German low double quotes'' (under the ``a'') in place of -the grave accent. This happens because \FontName{ecrm1000} is in a -different \Qref*{font encoding}{Q-whatenc} than \LaTeX{} is -expecting~--- if you use the \LaTeX{} \Package{fontenc} package to -select the \acro{EC} fonts, all these tiresome encoding issues are -solved for you, behind the scenes. - -There does however remain a circumstance when you will be tempted to -use \csx{newfont}~--- viz., to get a font size that doesn't fall into -the Knuth standard set of sizes: \LaTeX{} (by default) won't allow you -to use such a size. Don't despair: see the answer % ! line break -``\Qref*{arbitrary font sizes}{Q-fontsize}''. - -%*****************************************quote environments up to here - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{The joy of \TeX{} errors} - -\Question[Q-erroradvice]{How to approach errors} - -Since \TeX{} is a macroprocessor, its error messages are often -difficult to understand; this is a (seemingly invariant) property of -macroprocessors. Knuth makes light of the problem in the \TeX{}book, -suggesting that you acquire the sleuthing skills of a latter-day -Sherlock Holmes; while this approach has a certain romantic charm to -it, it's not good for the `production' user of \AllTeX{}. This -answer (derived, in part, from an article by Sebastian Rahtz in -\TUGboat{} 16(4)) offers some general guidance in dealing with \TeX{} -error reports, and other answers in this section deal with common (but -perplexing) errors that you may encounter. There's a long list of -``hints'' in Sebastian's article, including the following: -\begin{itemize} -\item Look at \TeX{} errors; those messages may seem cryptic at first, - but they often contain a straightforward clue to the problem. See - \Qref[question]{the structure of errors}{Q-errstruct} for further - details. -\item Read the \extension{log} file; it contains hints to things you may - not understand, often things that have not even presented as error - messages. -\item Be aware of the amount of context that \TeX{} gives you. The - error messages gives you some bits of \TeX{} code (or of the - document itself), that show where the error ``actually happened''; - it's possible to control how much of this `context' \TeX{} actually - gives you. \LaTeX{} (nowadays) instructs \TeX{} only to give you - one line of context, but you may tell it otherwise by saying -\begin{quote} -\begin{verbatim} -\setcounter{errorcontextlines}{999} -\end{verbatim} -\end{quote} - in the preamble of your document. (If you're not a confident macro - programmer, don't be ashamed of cutting that 999 down a bit; some - errors will go on and \emph{on}, and spotting the differences - between those lines can be a significant challenge.) -\item As a last resort, tracing can be a useful tool; reading a full - \AllTeX{} trace takes a strong constitution, but once you know how, - the trace can lead you quickly to the source of a problem. You need - to have read the \TeX{}book (see -% beware line break - \Qref[question]{books about \TeX{}}{Q-books}) in some detail, fully - to understand the trace. - - The command \csx{tracingall} sets up maximum tracing; it also sets - the output to come to the interactive terminal, which is somewhat of - a mixed blessing (since the output tends to be so vast~--- all but - the simplest traces are best examined in a text editor after the event). - - The \LaTeX{} \Package{trace} package (first distributed with the - 2001 release of \LaTeX{}) provides more manageable tracing. Its - \csx{traceon} command gives you what \csx{tracingall} offers, but - suppresses tracing around some of the truly verbose parts of - \LaTeX{} itself. The package also provides a \csx{traceoff} - command (there's no ``off'' command for \csx{tracingall}), and a - package option (|logonly|) allows you to suppress output to the - terminal. -\end{itemize} -The best advice to those faced with \TeX{} errors is not to panic: -most of the common errors are plain to the eye when you go back to the -source line that \TeX{} tells you of. If that approach doesn't work, -the remaining answers in this section deal with some of the odder -error messages you may encounter. You should not ordinarily need to -appeal to the \Qref*[question]{wider public}{Q-gethelp} -for assistance, but if you do, be sure to -report full backtraces (see |errorcontextlines| above) and so on. -\begin{ctanrefs} -\item[trace.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-errstruct]{The structure of \TeX{} error messages} - -\TeX{}'s error messages are reminiscent of the time when \TeX{} itself -was conceived (the 1970s): they're not terribly user-friendly, though -they do contain all the information that \TeX{} can offer, usually in -a pretty concise way. - -\TeX{}'s error reports all have the same structure: -\begin{itemize} -\item An error message -\item Some `context' -\item An error prompt -\end{itemize} -The error message will relate to the \emph{\TeX{}} condition that is -causing a problem. Sadly, in the case of complex macro packages such -as \LaTeX{}, the underlying \TeX{} problem may be superficially -difficult to relate to the actual problem in the ``higher-level'' -macros. Many \LaTeX{}-detected problems manifest themselves as -`generic' errors, with error text provided by \LaTeX{} itself (or by a -\LaTeX{} class or package). - -The context of the error is a stylised representation of what \TeX{} -was doing at the point that it detected the error. As noted in -\Qref[question]{approaching errors}{Q-erroradvice}, a macro package -can tell \TeX{} how much context to display, and the user may need to -undo what the package has done. Each line of context is split at the -point of the error; if the error \emph{actually} occurred in a macro -called from the present line, the break is at the point of the call. -(If the called object is defined with arguments, the ``point of call'' -is after all the arguments have been scanned.) For example: -\begin{verbatim} -\blah and so on -\end{verbatim} -produces the error report -\begin{verbatim} -! Undefined control sequence. -l.4 \blah - and so on -\end{verbatim} -while: -\begin{verbatim} -\newcommand{\blah}[1]{\bleah #1} -\blah{to you}, folks -\end{verbatim} -produces the error report -\begin{verbatim} -! Undefined control sequence. -\blah #1->\bleah - #1 -l.5 \blah{to you} - , folks -\end{verbatim} -If the argument itself is in error, we will see things such as -\begin{verbatim} -\newcommand{\blah}[1]{#1 to you} -\blah{\bleah}, folks -\end{verbatim} -producing -\begin{verbatim} -! Undefined control sequence. -<argument> \bleah - -l.5 \blah{\bleah} - , folks -\end{verbatim} - -The prompt accepts single-character commands: the list of what's -available may be had by typing |?|\@. One immediately valuable -command is |h|, which gives you an expansion of \TeX{}s original -pr\'ecis message, sometimes accompanied by a hint on what to do to -work round the problem in the short term. If you simply type `return' -(or whatever else your system uses to signal the end of a line) at the -prompt, \TeX{} will attempt to carry on (often with rather little -success). - -\Question[Q-extrabrace]{An extra `\texttt{\cbracesymbol{}}'??} -\keywords{caption heading} - -You've looked at your \LaTeX{} source and there's no sign of a misplaced -\texttt{\cbracesymbol{}} on the line in question. - -Well, no: this is \TeX{}'s cryptic way of hinting that you've put a -\begin{wideversion} % hyper -\Qref{fragile command}{Q-protect} in a moving argument. -\end{wideversion} -\begin{narrowversion} -fragile command in a moving argument (\Qref{}{Q-protect}). -\end{narrowversion} - -For example, \csx{footnote} is fragile, and if we put that in the -moving argument of a \csx{section} command, as -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\section{Mumble\footnote{% - I couldn't think of anything better}} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\section{Mumble\footnote{I couldn't think of anything better}} -\end{verbatim} -\end{wideversion} -\end{quote} -we get told -\begin{quote} -\begin{verbatim} -! Argument of \@sect has an extra }. -\end{verbatim} -\end{quote} -The same happens with captions (the following is a simplification of a -\Newsgroup{comp.text.tex} post): -\begin{quote} -\begin{verbatim} -\caption{Energy: \[e=mc^2\]} -\end{verbatim} -\end{quote} -giving us the error message -\begin{quote} -\begin{verbatim} -! Argument of \@caption has an extra }. -\end{verbatim} -\end{quote} -The solution is usually to use a robust command in place of the one -you are using, or to force your command to be robust by prefixing it -with \csx{protect}, which in the \csx{section} case would show as -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\section{Mumble\protect\footnote{% - I couldn't think of anything better}} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\section{Mumble\protect\footnote{I couldn't think of anything better}} -\end{verbatim} -\end{wideversion} -\end{quote} -In both the \csx{section} case and the \csx{caption} case, you can -separate the moving argument, as in -\cmdinvoke*{section}[moving]{static}; this gives us another standard -route~--- simply to omit (or otherwise sanitise) the fragile command -in the moving argument. So, one might rewrite the \csx{caption} -example as: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\caption[Energy: $E=mc^2$]% - {Energy: \[E=mc^2\]} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\caption[Energy: $E=mc^2$]{Energy: \[E=mc^2\]} -\end{verbatim} -\end{wideversion} -\end{quote} -for, after all, even if you want display maths in a caption, you -surely don't want it in the list of figures. - -The case of footnotes is somewhat more complex; -``\Qref[question]{footnotes in \LaTeX{} section headings}{Q-ftnsect}'' -deals specifically with that issue. - -\Question[Q-semanticnest]{Capacity exceeded [semantic nest\,\dots{}]} - -\begin{narrowversion} -\begin{verbatim} -! TeX capacity exceeded, sorry [semantic nest - size=100]. -... -If you really absolutely need more capacity, -you can ask a wizard to enlarge me. -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -! TeX capacity exceeded, sorry [semantic nest size=100]. -... -If you really absolutely need more capacity, -you can ask a wizard to enlarge me. -\end{verbatim} -\end{wideversion} -Even though \TeX{} suggests (as always) that enlargement by a wizard -may help, this message usually results from a broken macro or bad -parameters to an otherwise working macro. - -The ``semantic nest'' \TeX{} talks about is the nesting -of boxes within boxes. A stupid macro can provoke the error pretty -easily: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -\def\silly{\hbox{here's \silly - being executed}} -\silly -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\def\silly{\hbox{here's \silly being executed}} -\silly -\end{verbatim} -\end{wideversion} -\end{quote} -The extended traceback -% beware of filling this line... -(see \Qref{\emph{general advice} on errors}{Q-erroradvice}) -\emph{does} help, though it does rather run on. In the case above, -the traceback consists of -\begin{verbatim} -\silly ->\hbox { - here's \silly being executed} -\end{verbatim} -followed by 100 instances of -\begin{verbatim} -\silly ->\hbox {here's \silly - being executed} -\end{verbatim} -The repeated lines are broken at exactly the offending macro; of -course the loop need not be as simple as this~--- if \csx{silly} calls -\csx{dopy} which boxes \csx{silly}, the effect is just the same and -alternate lines in the traceback are broken at alternate positions. - -There are in fact two items being consumed when you nest boxes: the -other is the grouping level. Whether you exhaust your % !line wrap -\emph{semantic nest} or your permitted \emph{grouping levels} first is -controlled entirely by the relative size of the two different sets of -buffers in your \AllTeX{} executable. - -\Question[Q-noroom]{No room for a new `\emph{thing}'} - -The technology available to Knuth at the time \TeX{} was written is -said to have been particularly poor at managing dynamic storage; as a -result much of the storage used within \TeX{} is allocated as fixed -arrays, in the reference implementations. Many of these fixed arrays -are expandable in modern \TeX{} implementations, but size of the -arrays of ``registers'' is written into the specification as being 256 -(usually); this number may not be changed if you still wish to call -the result \TeX{} -%% beware line wrap -(see \Qref[question]{testing \TeX{} implementations}{Q-triptrap}). - -If you fill up one of these register arrays, you get a \TeX{} error -message saying -\begin{quote} -\begin{verbatim} -! No room for a new \<thing>. -\end{verbatim} -\end{quote} -The \csx{thing}s in question may be \csx{count} (the object underlying -\LaTeX{}'s \csx{newcounter} command), \csx{skip} (the object underlying -\LaTeX{}'s \csx{newlength} command), \csx{box} (the object underlying -\LaTeX{}'s \csx{newsavebox} command), or \csx{dimen}, \csx{muskip}, -\csx{toks}, \csx{read}, \csx{write} or \csx{language} (all types of object -whose use is ``hidden'' in \LaTeX{}; the limit on the number of -\csx{read} or \csx{write} objects is just 16). - -There is nothing that can directly be done about this error, as you can't -extend the number of available registers without extending \TeX{} -itself. -\begin{htmlversion} - Of course, \Qref{\eTeX{}}{Q-etex}, \Qref{Omega}{Q-omegaleph} and - \Qref{\LuaTeX{}}{Q-luatex} -\end{htmlversion} -\htmlignore -% beware line wrap here - Of course, \eTeX{}, \ensuremath{\Omega} and \LuaTeX{}~--- - \Qref[see questions]{}{Q-etex} \Qref[,]{}{Q-omegaleph} and - \Qref[and]{}{Q-luatex} respectively~--- -\endhtmlignore -all do this, as does \Qref*{MicroPress Inc's V\TeX{}}{Q-commercial}. - -One common way to encounter one of these error messages is to have -broken macros of some sort, or incorrect usage of macros (an example -is discussed in \Qref[question]{epsf problems}{Q-epsf}). - -However, sometimes one just \emph{needs} more than \TeX{} can offer, -and when this happens, you've just got to work out a different way of -doing things. An example is the % beware line wrap -\Qref*{difficulty of loading \PiCTeX{} with \LaTeX{}}{Q-usepictex}. -The more modern drawing package, \Package{pgf} with its higher-level -interface \Package{TikZ} is a common problem. - -In such cases, it is usually possible to use the -\Qref*{\eTeX{}}{Q-etex} extensions (all modern distributions provide -them). The \LaTeX{} package \Package{etex} modifies the register allocation -mechanism to make use of \eTeX{}'s extended register sets. -\Package{Etex} is a -derivative of the \plaintex{} macro file \Package{etex.src}, which is -used in building the \eTeX{} Plain format; both files are part of the -\eTeX{} distribution and are available in current distributions. - -It is possible that, even with \Package{etex} loaded, you still find -yourself running out of things. Problems could be caused by packages -that use large numbers of ``inserts'' (combinations of counter, box, -dimension and skip registers, used for storing floats and footnotes). -\Package{Morefloats} does this, of course (naturally enough, -allocating new floats), and footnote packages such as -\Package{manyfoot} and \Package{bigfoot} (which uses \Package{manyfoot} -can also give problems. The \Package{etex} allows you to deal with -these things: the command \cmdinvoke*{reserveinserts}{n} ensures there -is room for \meta{n} more inserts. (Hint: \Package{morefloats} needs -18 inserts, and \Package{manyfoot} seems to be happy with 10 -reserved.) Load \Package{etex} before any others, and reserve the -inserts immediately: -\begin{quote} -\begin{verbatim} -\documentclass[...]{...} -\usepackage{etex} -\reserveinserts{28} -\end{verbatim} -\end{quote} - -Unfortunately, \eTeX{} doesn't help with \csx{read} or \csx{write} -objects (and neither will the \Package{etex} package). - -\Question[Q-epsf]{\texttt{epsf} gives up after a bit} - -Some copies of the documentation of \File{epsf.tex} seem to suggest -that the command -\begin{verbatim} - \input epsf -\end{verbatim} -is needed for every figure included. If you follow this suggestion -too literally, you get an error -\begin{verbatim} - ! No room for a new \read . -\end{verbatim} -after a while; this is because each time \File{epsf.tex} is loaded, it -allocates itself a \emph{new} file-reading handle to check the figure -for its bounding box, and there just aren't enough of these things -(see \Qref[question]{no room for a new thing}{Q-noroom}). - -The solution is simple~--- this is in fact an example of misuse of -macros; one only need read \File{epsf.tex} once, so change -\begin{verbatim} - ... - \input epsf - \epsffile{...} - ... - \input epsf - \epsffile{...} -\end{verbatim} -(and so on) with a single -\begin{verbatim} - \input epsf -\end{verbatim} -somewhere near the start of your document, and then decorate your -\csx{epsffile} statements with no more than adjustments of -\csx{epsfxsize} and so on. - -\Question[Q-badhyph]{Improper \csx{hyphenation} will be flushed} - -For example -\begin{verbatim} -! Improper \hyphenation will be flushed. -\'#1->{ - \accent 19 #1} -<*> \hyphenation{Ji-m\'e - -nez} -\end{verbatim} -(in \plaintex{}) or -\begin{verbatim} -! Improper \hyphenation will be flushed. -\leavevmode ->\unhbox - \voidb@x -<*> \hyphenation{Ji-m\'e - -nez} -\end{verbatim} -in \LaTeX{}. - -As mentioned in \Qref[question]{``hyphenation failures''}{Q-nohyph}, -words with accents in them may not be hyphenated. As a result, any -such word is deemed improper in a \csx{hyphenation} command. - -The solution is to use a font that contains the character in question, -and to express the \csx{hyphenation} command in terms of that -character; this ``hides'' the accent from the hyphenation mechanisms. -\LaTeX{} users can be achieved this by use of the \Package{fontenc} -package (part of the \LaTeX{} distribution). If you select an 8-bit -font with the package, as in \cmdinvoke{usepackage}[T1]{fontenc}, -accented-letter commands such as the |\'||e| in -|\hyphenation{Ji-m\'||e-nez}| automatically become the single accented -character by the time the hyphenation gets to look at it. - -\Question[Q-tmupfl]{``Too many unprocessed floats''} - -If \LaTeX{} responds to a \cmdinvoke{begin}{figure} or -\cmdinvoke{begin}{table} command with the error message -\begin{htmlversion} -\begin{verbatim} -! LaTeX Error: Too many unprocessed floats. - -See the LaTeX manual or LaTeX Companion for explanation. -\end{verbatim} -\end{htmlversion} -\htmlignore -\ifpdf -\begin{verbatim} -! LaTeX Error: Too many unprocessed floats. - -See the LaTeX manual or LaTeX Companion for explanation. -\end{verbatim} -\else -\begin{verbatim} -! LaTeX Error: Too many unprocessed floats. - -See the LaTeX manual or LaTeX Companion -... for explanation. -\end{verbatim} -\fi -\endhtmlignore -your figures (or tables) are failing to be placed properly. \LaTeX{} -has a limited amount of storage for `floats' (figures, tables, or -floats you've defined yourself with the \Package{float} package); if -you don't let it ever actually typeset any floats, it will run out of -space. - -This failure usually occurs in extreme cases of -% beware line break -\nothtml{floats moving ``wrongly'' (see }% -\Qref[question]{floats moving ``wrongly''}{Q-floats}\latexhtml{);}{;} -\LaTeX{} has found it can't place a float, and floats of the same type -have piled up behind it. \LaTeX{}'s idea is to ensure that caption -numbers are sequential in the document: the caption number is -allocated when the figure (or whatever) is created, and can't be -changed, so that placement out of order would mean figure numbers -appearing out of order in the document (and in the list of figures, or -whatever). So a simple failure to place a figure means that no -subsequent figure can be placed; and hence (eventually) the error. - -Techniques for solving the problem are discussed in the -\nothtml{floats question (}% -\Qref[\htmlonly]{floats question}{Q-floats}\nothtml{)} -already referenced. - -The error also occurs in a -long sequence of \environment{figure} or \environment{table} -environments, with no intervening -text. Unless the environments will fit ``here'' (and you've allowed -them to go ``here''), there will never be a page break, and so there -will never be an opportunity for \LaTeX{} to reconsider placement. -(Of course, the floats can't all fit ``here'' if the sequence is -sufficiently prolonged: once the page fills, \LaTeX{} won't place any -more floats, leading to the error. - -Techniques for resolution may involve redefining the floats using the -\Package{float} package's \texttt{[H]} float qualifier, but you are unlikely -to get away without using \csx{clearpage} from time to time. -\begin{ctanrefs} -\item[float.sty]\CTANref{float} -\end{ctanrefs} - -\Question[Q-atvert]{\csx{spacefactor} complaints} - -The errors -\begin{verbatim} -! You can't use `\spacefactor' in vertical mode. -\@->\spacefactor - \@m -\end{verbatim} -or -\begin{verbatim} -! You can't use `\spacefactor' in math mode. -\@->\spacefactor - \@m -\end{verbatim} -or simply -\begin{verbatim} -! Improper \spacefactor. -... -\end{verbatim} -bites the \LaTeX{} programmer who uses an internal command without taking -``precautions''. The problem is discussed in detail in -% beware line wrap -``\Qref*[question]{\texttt{@} in macro names}{Q-atsigns}'', -together with solutions. - -\Question[Q-endingroup]{\csx{end} occurred inside a group} - -The actual error we observe is: - -\nothtml{\noindent}% -|(\end occurred inside a group at level <|\texttt{\emph{n}}|>)| - -\nothtml{\noindent}% -and it tells us that something we started in the document never got -finished before we ended the document itself. The things involved -(`groups') are what \TeX{} uses for restricting the scope of things: -you see them, for example, in the ``traditional'' font selection -commands: |{\it stuff\/}|~--- if the closing brace is left off such a -construct, the effect of \csx{it} will last to the end of the document, -and you'll get the diagnostic. - -\TeX{} itself doesn't tell you where your problem is, but you can -often spot it by looking at the typeset output in a previewer. -Otherwise, you can usually find mismatched braces using an intelligent -editor (at least \ProgName{emacs} and \ProgName{winedt} offer this facility). -However, groups are not \emph{only} created by matching -\texttt{\obracesymbol{}} with \texttt{\cbracesymbol{}}: -other grouping commands are discussed elsewhere in these \acro{FAQ}s, -and are also a potential source of unclosed group. - -\cmdinvoke{begin}{\meta{environment}} encloses the environment's body -in a group, and establishes its own diagnostic mechanism. If you end -the document before closing some other environment, you get the -`usual' \LaTeX{} diagnostic -\htmlignore -\begin{dviversion} -\begin{verbatim} -! LaTeX Error: \begin{blah} on input line 6 - ended by \end{document}. -\end{verbatim} -\end{dviversion} -\begin{pdfversion} -\begin{verbatim} -! LaTeX Error: \begin{blah} on input line 6 ended by \end{document}. -\end{verbatim} -\end{pdfversion} -\endhtmlignore -\begin{htmlversion} -\begin{verbatim} -! LaTeX Error: \begin{blah} on input line 6 ended by \end{document}. -\end{verbatim} -\end{htmlversion} -which (though it doesn't tell you which \emph{file} the -\cmdinvoke{begin}{blah} was in) is usually enough to locate the -immediate problem. If you press on past the \LaTeX{} error, you get -one or more repetitions of the ``occurred inside a group'' message -before \LaTeX{} finally exits. The \Package{checkend} package -recognises other unclosed \cmdinvoke{begin}{blob} commands, and -generates an ``ended by'' error message for each one, rather than -producing the ``occurred inside a group'' message, which is sometimes -useful (if you remember to load the package). - -In the absence of such information from \LaTeX{}, you need to use -``traditional'' binary search to find the offending group. Separate -the preamble from the body of your file, and process each half on its -own with the preamble; this tells you which half of the file is at -fault. Divide again and repeat. The process needs to be conducted -with care (it's obviously possible to split a correctly-written group -by chopping in the wrong place), but it will usually find the problem -fairly quickly. - -\eTeX{} (and \elatex{}~--- \LaTeX{} run on \eTeX{}) gives you -further diagnostics after the traditional infuriating \TeX{} one~--- it -actually keeps the information in a similar way to \LaTeX{}: -\htmlignore -\begin{dviversion} -\begin{verbatim} -(\end occurred inside a group at level 3) - -### semi simple group (level 3) entered - at line 6 (\begingroup) -### simple group (level 2) entered at line 5 ({) -### simple group (level 1) entered at line 4 ({) -### bottom level -\end{verbatim} -\end{dviversion} -\begin{pdfversion} -\begin{verbatim} -(\end occurred inside a group at level 3) - -### semi simple group (level 3) entered at line 6 (\begingroup) -### simple group (level 2) entered at line 5 ({) -### simple group (level 1) entered at line 4 ({) -### bottom level -\end{verbatim} -\end{pdfversion} -\endhtmlignore -\begin{htmlversion} -\begin{verbatim} -(\end occurred inside a group at level 3) - -### semi simple group (level 3) entered at line 6 (\begingroup) -### simple group (level 2) entered at line 5 ({) -### simple group (level 1) entered at line 4 ({) -### bottom level -\end{verbatim} -\end{htmlversion} -The diagnostic not only tells us where the group started, but also the -\emph{way} it started: \csx{begingroup} or |{| (which is an alias of -\csx{bgroup}, and the two are not distinguishable at the \TeX{}-engine -level). -\begin{ctanrefs} -\item[checkend.sty]Distributed as part of \CTANref{bezos} -\end{ctanrefs} - -\Question[Q-nonum]{``Missing number, treated as zero''} - -In general, this means you've tried to assign something to a count, -dimension or skip register that isn't (in \TeX{}'s view of things) a -number. Usually the problem will become clear using the -\Qref*{ordinary techniques of examining errors}{Q-erroradvice}. - -Two \LaTeX{}-specific errors are commonly aired on the newsgroups. - -The commonest arises from attempting to use an example from the -\Qref*{\emph{The \LaTeX{} Companion} (first edition)}{Q-books}, and is -exemplified by the following error text: -\begin{verbatim} -! Missing number, treated as zero. -<to be read again> - \relax -l.21 \begin{Ventry}{Return values} -\end{verbatim} -The problem arises because, in its first edition, the -\emph{Companion}'s examples always assumed that the \Package{calc} -package is loaded: this fact is mentioned in the book, but often not -noticed. The remedy is to load the \Package{calc} package in any -document using such examples from the \emph{Companion}. (The problem -does not really arise with the second edition; copies of all the -examples are available on the accompanying \CDROM{}, or on -\acro{CTAN}.) - -The other problem, which is increasingly rare nowadays, arises from -misconfiguration of a system that has been upgraded from \LaTeXo{}: -the document uses the \Package{times} package, and the error appears -at \cmdinvoke{begin}{document}. The file search paths are wrongly set -up, and your \cmdinvoke{usepackage}{times} has picked up a \LaTeXo{} -version of the package, which in its turn has invoked another which -has no equivalent in \LaTeXe{}. The obvious solution is to rewrite -the paths so that \LaTeXo{} packages are chosen only as a last resort -so that the startlingly simple \LaTeXe{} \Package{times} package will -be picked up. Better still is to replace the whole thing with -something more modern still; current \Package{psnfss} doesn't provide -a \Package{times} package~--- the alternative \Package{mathptmx} -incorporates \FontName{Times}-like mathematics, and a sans-serif face -based on \FontName{Helvetica}, but scaled to match \FontName{Times} -text rather better. -\begin{ctanrefs} -\item[calc.sty]Distributed as part of \CTANref{2etools} -\item[\nothtml{\rmfamily}Examples for \nothtml{\upshape}\LaTeX{} Companion]\CTANref{tlc2} -\item[The psnfss bundle]\CTANref{psnfss} -\end{ctanrefs} - -\Question[Q-typend]{``Please type a command or say \csx{end}''} - -Sometimes, when you are running \AllTeX{}, it will abruptly stop and -present you with a prompt (by default, just a |*| character). Many -people (including this author) will reflexively hit the `return' -key, pretty much immediately, and of course this is no help at all~--- -\TeX{} just says: -\begin{verbatim} -(Please type a command or say `\end') -\end{verbatim} -and prompts you again. - -What's happened is that your \AllTeX{} file has finished prematurely, -and \TeX{} has fallen back to a supposed including file, from the -terminal. This could have happened simply because you've omitted -the \csx{bye} (\plaintex{}), \cmdinvoke{end}{document} (\LaTeX{}), or -whatever. Other common errors are failure to close the braces round a -command's argument, or (in \LaTeX{}) failure to close a verbatim -environment: in such cases you've already read and accepted an -error message about encountering end of file while scanning something. - -If the error is indeed because you've forgotten to end your document, -you can insert the missing text: if you're running \plaintex{}, the -advice, to ``say \csx{end}'' is good enough: it will kill the run; if -you're running \LaTeX{}, the argument will be necessary: -\cmdinvoke{end}{document}. - -However, as often as not this isn't the problem, and (short of -debugging the source of the document before ending) brute force is -probably necessary. Excessive force (killing the job that's -running \TeX{}) is to be avoided: there may well be evidence in the -\extension{log} file that will be useful in determining what the -problem is~--- so the aim is to persuade \TeX{} to shut itself down -and hence flush all log output to file. - -If you can persuade \TeX{} to read it, an end-of-file indication -(control-|D| under Unix, control-|Z| under Windows) will provoke -\TeX{} to report an error and exit immediately. Otherwise you should -attempt to provoke an error dialogue, from which you can exit (using -the |x| `command'). An accessible error could well be inserting an -illegal character: what it is will depend on what macros you are -running. If you can't make that work, try a silly command name or -two. - -\Question[Q-unkgrfextn]{``Unknown graphics extension''} - -The \LaTeX{} graphics package deals with several different types of -\acro{DVI} (or other) output drivers; each one of them has a potential -to deal with a different selection of graphics formats. The package -therefore has to be told what graphics file types its output driver -knows about; this is usually done in the \meta{driver}\extension{def} file -corresponding to the output driver you're using. - -The error message arises, then, if you have a graphics file whose -extension doesn't correspond with one your driver knows about. Most -often, this is because you're being optimistic: asking -\ProgName{dvips} to deal with a \extension{png} file, or \PDFTeX{} to deal with -a \extension{eps} file: the solution in this case is to transform the graphics -file to a format your driver knows about. - -If you happen to \emph{know} that your device driver deals with the -format of your file, you are probably falling foul of a limitation of -the file name parsing code that the graphics package uses. Suppose -you want to include a graphics file \File{home.bedroom.eps} using the -\ProgName{dvips} driver; the package will conclude that your file's -extension is \extension{bedroom.eps}, and will complain. - -The \Package{grffile} package deals with the last problem (and -others~--- see the package documentation); using the package, you may -write: -\begin{quote} -\begin{verbatim} -\usepackage{graphicx} -\usepackage{grffile} -... -\includegraphics{home.bedroom.eps} -\end{verbatim} -\end{quote} -or you may even write -\begin{quote} -\begin{verbatim} -\includegraphics{home.bedroom} -\end{verbatim} -\end{quote} -and \Package{graphicx} will find a \extension{eps} or \extension{pdf} -(or whatever) version, according to what version of \AllTeX{} you're -running. - -If for some reason you can't use \Package{grffile}, you have three -unsatisfactory alternatives: -\begin{itemize} -\item Rename the file~--- for example \File{home.bedroom.eps}\arrowhyph{}% - \File{home-bedroom.eps} -\item Mask the first dot in the file name: -\begin{verbatim} -\newcommand*{\DOT}{.} -\includegraphics{home\DOT bedroom.eps} -\end{verbatim} -\item Tell the graphics package what the file is, by means of options - to the \csx{includegraphics} command: -\begin{narrowversion} -\begin{verbatim} -\includegraphics[type=eps,ext=.eps, - read=.eps]{home.bedroom} -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -\includegraphics[type=eps,ext=.eps,read=.eps]{home.bedroom} -\end{verbatim} -\end{wideversion} -\end{itemize} -\begin{ctanrefs} -\item[grffile.sty]Distributed as part of the \CTANref{oberdiek} collection -\end{ctanrefs} - -\Question[Q-nodollar]{``Missing \texttt{\$} inserted''} - -There are certain things that \emph{only} work in maths mode. If your -document is not in maths mode and you have an |_| or a |^| character, -\TeX{} (and by inheritance, \LaTeX{} too) will say -\begin{verbatim} -! Missing $ inserted -\end{verbatim} -as if you couldn't possibly have misunderstood the import of what you -were typing, and the only possible interpretation is that you had -committed a typo in failing to enter maths mode. \TeX{}, therefore, -tries to patch things up by inserting the \texttt{\$} you `forgot', so that -the maths-only object will work; as often as not this will land you in -further confusion. - -It's not just the single-character maths sub- and superscript -operators: anything that's built in or declared as a maths operation, -from the simplest lower-case \csx{alpha} through the inscrutable -\csx{mathchoice} primitive, and beyond, will provoke the error if -misused in text mode. - -\LaTeX{} offers a command \csx{ensuremath}, which will put you in maths -mode for the execution of its argument, if necessary: so if you want -an \csx{alpha} in your running text, say -\cmdinvoke{ensuremath}{\csx{alpha}}; if the bit of running text somehow -transmutes into a bit of mathematics, the \csx{ensuremath} will become -a no-op, so it's pretty much always safe. - -\Question[Q-fontunavail]{Warning: ``Font shape \dots{}\ not available''} - -\LaTeX{}'s font selection scheme maintains tables of the font families -it has been told about. These tables list the font families that -\LaTeX{} knows about, and the shapes and series in which those font -families are available. In addition, in some cases, the tables list -the sizes at which \LaTeX{} is willing to load fonts from the family. - -When you specify a font, using one of the \LaTeX{} font selection -commands, \LaTeX{} looks for the font (that is, a font that matches -the encoding, family, shape, series and size that you want) in its -tables. If the font isn't there at the size you want, you will see a -message like: -\htmlignore -\begin{dviversion} -\begin{verbatim} -LaTeX Font Warning: Font shape `OT1/cmr/m/n' in -... size <11.5> not available -(Font) size <12> substituted on -... input line ... -\end{verbatim} -(All the message texts in this answer have been wrapped so that they -will fit in the narrow columns of this version of the \acro{FAQ}. The -continuation marker is |...| at the start of the broken-off portion of -the line.) - -\end{dviversion} -\begin{pdfversion} -\begin{verbatim} -LaTeX Font Warning: Font shape `OT1/cmr/m/n' in size <11.5> not available -(Font) size <12> substituted on input line ... -\end{verbatim} -\end{pdfversion} -\endhtmlignore -\begin{htmlversion} -\begin{verbatim} -LaTeX Font Warning: Font shape `OT1/cmr/m/n' in size <11.5> not available -(Font) size <12> substituted on input line ... -\end{verbatim} -\end{htmlversion} -There will also be a warning like: -\htmlignore -\begin{dviversion} -\begin{verbatim} -LaTeX Font Warning: Size substitutions with -... differences -(Font) up to 0.5pt have occurred. -\end{verbatim} -\end{dviversion} -\begin{pdfversion} -\begin{verbatim} -LaTeX Font Warning: Size substitutions with differences -(Font) up to 0.5pt have occurred. -\end{verbatim} -\end{pdfversion} -\endhtmlignore -\begin{htmlversion} -\begin{verbatim} -LaTeX Font Warning: Size substitutions with differences -(Font) up to 0.5pt have occurred. -\end{verbatim} -\end{htmlversion} -after \LaTeX{} has encountered \cmdinvoke{end}{document}. - -The message tells you that you've chosen a font size that is not in -\LaTeX{}'s list of ``allowed'' sizes for this font; \LaTeX{} has -chosen the nearest font size it knows is allowed. In fact, you can -tell \LaTeX{} to allow \emph{any} size: the restrictions come from the -days when only bitmap fonts were available, and they have never -applied to fonts that come in scaleable form in the first place. -Nowadays, most of the fonts that were once bitmap-only are also -available in scaleable (Adobe Type~1) form. If your installation uses -scaleable versions of the Computer Modern or European Computer Modern -(\acro{EC}) fonts, you can tell \LaTeX{} to remove the restrictions; -use the \Package{type1cm} or \Package{type1ec} package as appropriate. - -If the combination of font shape and series isn't available, \LaTeX{} -will usually have been told of a fall-back combination that may be -used, and will select that: -\htmlignore -\begin{dviversion} -\begin{verbatim} -LaTeX Font Warning: Font shape `OT1/cmr/bx/sc' -... undefined -(Font) using `OT1/cmr/bx/n' -... instead on input line 0. -\end{verbatim} -\end{dviversion} -\begin{pdfversion} -\begin{verbatim} -LaTeX Font Warning: Font shape `OT1/cmr/bx/sc' undefined -(Font) using `OT1/cmr/bx/n' instead on input line 0. -\end{verbatim} -\end{pdfversion} -\endhtmlignore -\begin{htmlversion} -\begin{verbatim} -LaTeX Font Warning: Font shape `OT1/cmr/bx/sc' undefined -(Font) using `OT1/cmr/bx/n' instead on input line 0. -\end{verbatim} -\end{htmlversion} - -Substitutions may also be ``silent''; in this case, there is no more -than an ``information'' message in the log file. For example, if you -specify an encoding for which there is no version in the current font -family, the `default family for the encoding' is selected. This -happens, for example, if you use command \csx{textbullet}, which is -normally taken from the maths symbols font, which is in |OMS| -encoding. My test log contained: -\htmlignore -\begin{dviversion} -\begin{verbatim} -LaTeX Font Info: Font shape `OMS/cmr/m/n' in -... size <10> not available -(Font) Font shape `OMS/cmsy/m/n' -... tried instead on input -... line ... -\end{verbatim} -\end{dviversion} -\begin{pdfversion} -\begin{verbatim} -LaTeX Font Info: Font shape `OMS/cmr/m/n' in size <10> not available -(Font) Font shape `OMS/cmsy/m/n' tried instead on input line ... -\end{verbatim} -\end{pdfversion} -\endhtmlignore -\begin{htmlversion} -\begin{verbatim} -LaTeX Font Info: Font shape `OMS/cmr/m/n' in size <10> not available -(Font) Font shape `OMS/cmsy/m/n' tried instead on input line ... -\end{verbatim} -\end{htmlversion} - -In summary, these messages are not so much error messages, as -information messages, that tell you what \LaTeX{} has made of your -text. You should check what the messages say, but you will ordinarily -not be surprised at their content. -\begin{ctanrefs} -\item[type1cm.sty]\CTANref{type1cm} -\item[type1ec.sty]\CTANref{type1ec} -\end{ctanrefs} - -\Question[Q-buffovl]{Unable to read an entire line} - -\TeX{} belongs to the generation of applications written for -environments that didn't offer the sophisticated string and i/o -manipulation we nowadays take for granted (\TeX{} was written in -Pascal, and the original Pascal standard made no mention of i/o, so -that anything but the most trivial operations were likely to be -unportable). - -When you overwhelm \TeX{}'s input mechanism, you get told: -\begin{verbatim} -! Unable to read an entire line---bufsize=3000. - Please ask a wizard to enlarge me. -\end{verbatim} -(for some value of `3000'~--- the quote was from a -\Newsgroup{comp.text.tex} posting by a someone who was presumably -using an old \TeX{}). - -As the message implies, there's (what \TeX{} thinks of as a) line in -your input that's ``too long'' (to \TeX{}'s way of thinking). Since -modern distributions tend to have tens of thousands of bytes of input -buffer, it's somewhat rare that these messages occur ``for real''. -Probable culprits are: -\begin{itemize} -\item A file transferred from another system, without translating - record endings. With the decline of fixed-format records (on - mainframe operating systems) and the increased intelligence of - \TeX{} distributions at recognising other systems' explicit - record-ending characters, this is nowadays rather a rare cause of - the problem. -\item A graphics input file, which a package is examining for its - bounding box, contains a binary preview section. Again, - sufficiently clever \TeX{} distributions recognise this situation, - and ignore the previews (which are only of interest, if at all, to a - \TeX{} previewer). -\end{itemize} - -The usual advice is to ignore what \TeX{} says (i.e., anything about -enlarging), and to put the problem right in the source. - -If the real problem is over-long text lines, most self-respecting text -editors will be pleased to automatically split long lines (while -preserving the ``word'' structure) so that they are nowhere any longer -than a given length; so the solution is just to edit the file. - -If the problem is a ridiculous preview section, try using -\ProgName{ghostscript} to reprocess the file, outputting a ``plain -\extension{eps}'' file. (\ProgName{Ghostscript} is distributed with a script -\ProgName{ps2epsi} which will regenerate the preview if necessary.) -Users of the shareware program \ProgName{GSview} will find buttons to -perform the required transformation of the file being displayed. -\begin{ctanrefs} -\item[ghostscript]Browse \CTANref{ghostscript} -\item[GSview]Browse \CTANref{gsview} -\end{ctanrefs} - -\Question[Q-formatstymy]{``Fatal format file error; I'm stymied''} - -\AllTeX{} applications often fail with this error when you've been -playing with the configuration, or have just installed a new version. - -The format file contains the macros that define the system you want to -use: anything from the simplest (\plaintex{}) all the way to the most -complicated, such as \LaTeX{} or \CONTeXT{}. From the command you -issue, \TeX{} knows which format you want. - -The error message -\begin{verbatim} - Fatal format file error; I'm stymied -\end{verbatim} -means that \TeX{} itself can't understand the format you want. -Obviously, this could happen if the format file had got corrupted, but -it usually doesn't. The commonest cause of the message, is that a new -binary has been installed in the system: no two \TeX{} binaries on the -same machine can -understand each other's formats. So the new version of \TeX{} you -have just installed, won't understand the format generated by the one -you installed last year. - -Resolve the problem by regenerating the format; of course, this -depends on which system you are using. -\begin{itemize} -\item On a te\TeX{}-based system, run -\begin{verbatim} - fmtutil --all -\end{verbatim} - or -\begin{verbatim} - fmtutil --byfmt=<format name> -\end{verbatim} - to build only the format that you are interested in. -\item On a \miktex{} system, click \texttt{Start}\arrowhyph{}% -\texttt{Programs}\arrowhyph{}% -\texttt{\miktex{} \emph{version}}\arrowhyph{}% -\texttt{\miktex{} Options}, and in the options window, click - \texttt{Update now}. -\end{itemize} - -\Question[Q-nonpdfsp]{Non-\acro{PDF} special ignored!} - -This is a \PDFTeX{} error: \PDFTeX{} is running in \acro{PDF} output -% beware line break at end line -mode, and it has encountered a \nothtml{\csx{special} command (}% -\Qref{\csx{special}}{Q-specials}\latexhtml{)}{ command}. \PDFTeX{} is -able to generate its own output, and in this mode of operation has no -need of \csx{special} commands (which allow the user to pass -information to the driver being used to generate output). - -Why does this happen? \LaTeX{} users, nowadays, hardly ever use -\csx{special} commands on their own~--- they employ packages to do the -job for them. Some packages will generate \csx{special} commands -however they are invoked: \Package{pstricks} is an example (it's very -raison d'\^etre is to emit \PS{} code in a sequence of \csx{special} -commands). \Package{Pstricks} may be dealt with by other means (the -\Package{pdftricks} package offers a usable technique). - -More amenable to correction, but more confusing, are packages (such as -\Package{color}, \Package{graphics} and \Package{hyperref}) that -specify a ``driver''. These packages have plug-in modules that -determine what \csx{special} (or other commands) are needed to generate -any given effect: the \texttt{pdftex} driver for such packages knows not to -generate \csx{special} commands. In most circumstances, you can let -the system itself choose which driver you need; in this case -everything will act properly when you switch to using \PDFLaTeX{}. If -you've been using \ProgName{dvips} (and specifying the |dvips| driver) -or \ProgName{dvipdfm} (for which you have to specify the driver), and -decide to try \PDFLaTeX{}, you \emph{must} remove the |dvips| or -|dvipdfm| driver specification from the package options, and let the -system recognise which driver is needed. -\begin{ctanrefs} -\item[pdftricks.sty]\CTANref{pdftricks} -\item[pstricks.sty]\CTANref{pstricks} -\end{ctanrefs} - -\Question[Q-8000]{Mismatched mode ljfour and resolution 8000} - -You're running \ProgName{dvips}, and you encounter a stream of error -messages, starting with ``\texttt{Mismatched mode}''. The mode is the -default used in your installation~--- it's set in the \ProgName{dvips} -configuration file, and \texttt{ljfour} is commonest (since it's the -default in most distributions), but not invariable. - -The problem is that \ProgName{dvips} has encountered a font for which -it must generate a bitmap (since it can't find it in Type~1 format), -and there is no proforma available to provide instructions to give to -\MF{}. - -So what to do? The number 8000 comes from the `\texttt{-Ppdf}' option -to \ProgName{dvips}, which you might have found from the answer -\nothtml{``wrong type of fonts'' (}% beware % beware line breaks -\Qref{``wrong type of fonts''}{Q-fuzzy-type3}\nothtml{)}. The obvious -solution is to switch to the trivial substitute `\texttt{-Pwww}', -which selects the necessary type~1 fonts for \acro{PDF} generation, -but nothing else: however, this will leave you with undesirable bitmap -fonts in your \acro{PDF} file. The ``proper'' solution is to find a -way of expressing what you want to do, using type~1 fonts. - -\Question[Q-toodeep]{``Too deeply nested''} - -This error appears when you start a \LaTeX{} list. - -\LaTeX{} keeps track of the nesting of one list inside another. There -is a set of list formatting parameters built-in for application to -each of the list nesting levels; the parameters determine indentation, -item separation, and so on. The \environment{list} environment (the -basis for list environments like \environment{itemize} and -\environment{enumerate}) ``knows'' there are only 6 of these sets. - -There are also different label definitions for the -\environment{enumerate} and \environment{itemize} environments at -their own private levels of nesting. Consider this example: -\begin{quote} -\begin{verbatim} -\begin{enumerate} -\item first item of first enumerate - \begin{itemize} - \item first item of first itemize - \begin{enumerate} - \item first item of second enumerate - ... - \end{enumerate} - ... - \end{itemize} -... -\end{enumerate} -\end{verbatim} -\end{quote} -In the example, -\begin{itemize} -\item the first \environment{enumerate} has labels as for a - first-level \environment{enumerate}, and is indented as for a - first-level list; -\item the first \environment{itemize} has labels as for a first level - \environment{itemize}, and is indented as for a second-level list; - and -\item the second \environment{enumerate} has labels as for a - second-level \environment{enumerate}, and is indented as for a - third-level list. -\end{itemize} -Now, as well as \LaTeX{} \emph{knowing} that there are 6~sets of -parameters for indentation, it also \emph{knows} that there are only -4~types of labels each, for the environments \environment{enumerate} -and \environment{itemize} (this ``knowledge'' spells out a requirement -for class writers, since the class supplies the sets of parameters). - -From the above, we can deduce that there are several ways we can run -out of space: we can have 6~lists (of any sort) nested, and try to -start a new one; we can have 4~\environment{enumerate} environments -somewhere among the set of nested lists, and try to add another one; -and we can have 4~\environment{itemize} environments somewhere among -the set of nested lists, and try to add another one. - -What can be done about the problem? Not much, short of rewriting -\LaTeX{}~--- you really need to rewrite your document in a slightly -less labyrinthine way. - -\Question[Q-inputlev]{Capacity exceeded~--- input levels} - -The error -\begin{wideversion} -\begin{verbatim} -! TeX capacity exceeded, sorry [text input levels=15]. -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -! TeX capacity exceeded, sorry - [text input levels=15]. -\end{verbatim} -\end{narrowversion} -is caused by nesting your input too deeply. You can provoke it with -the trivial (\plaintex{}) file \File{input.tex}, which contains -nothing but: -\begin{verbatim} -\input input -\end{verbatim} -In the real world, you are unlikely to encounter the error with a -modern \TeX{} distribution. Te\TeX{} (used to produce the error -message above) allows 15 files open for \TeX{} input at any one time, -which is improbably huge for a document generated by real human -beings. - -However, for those improbable (or machine-generated) situations, -some distributions offer the opportunity to adjust the parameter -|max_in_open| in a configuration file. - -\Question[Q-hyperdupdest]{\PDFTeX{} destination \dots{}\ ignored} - -The warning: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -! pdfTeX warning (ext4): destination with the same identifier -(name{page.1}) has been already used, duplicate ignored -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -! pdfTeX warning (ext4): destination with - the same identifier (name{page.1}) has - been already used, duplicate ignored -\end{verbatim} -{\small NB: message text wrapped to fit in the column\par} -\end{narrowversion} -\end{quote} -arises because of duplicate page numbers in your document. The -problem is usually soluble: see % beware line break -\Qref*[question]{\acro{PDF} page destinations}{Q-pdfpagelabels}~--- which -answer also describes the problem in more detail. - -If the identifier in the message is different, for example -|name{figure.1.1}|, the problem is (usually) due to a problem of -package interaction. Some packages are simply incompatible with -\Package{hyperref}, but most work simply by ignoring it. In most -cases, therefore, you should load your package before you load -\Package{hyperref}, and \Package{hyperref} will patch things up so -that they work, so you can utilise your (patched) package \emph{after} -loading both: -\begin{quote} - \cmdinvoke{usepackage}{\emph{your package}}\\ - \texttt{...}\\ - \cmdinvoke{usepackage}[\emph{opts}]{hyperref}\\ - \texttt{...}\\ - \meta{code that uses your package} -\end{quote} -\begin{wideversion} -For example: -\begin{quote} -\begin{verbatim} -\usepackage{float} % defines \newfloat -... -\usepackage[...]{hyperref} % patches \newfloat -... -\newfloat{...}{...}{...} -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -So, if we need \csx{newfloat}: -\begin{quote} -\cmdinvoke{usepackage}{float} -\end{quote} -will define the command, -\begin{quote} -\cmdinvoke{usepackage}[\emph{opts}]{hyperref} -\end{quote} -will patch it, and now: -\begin{quote} -\cmdinvoke{newfloat}{...}{...}{...} -\end{quote} -will use the command, patched to create `proper' hyperreferences. -\end{narrowversion} -You should load packages in this order as a matter of course, unless -the documentation of a package says you \emph{must} load it after -\Package{hyperref}. (There aren't many packages that require to be -loaded after hyperref: one such is \Class{memoir}'s -``\Package{hyperref} fixup'' package \Package{memhfixc}.) - -If loading your packages in the (seemingly) ``correct'' order doesn't -solve the problem, you need to \Qref*{seek further help}{Q-gethelp}. - -\Question[Q-altabcr]{Alignment tab changed to \csx{cr}} - -This is an error you may encounter in \LaTeX{} when a tabular -environment is being processed. ``Alignment tabs'' are the -\texttt{\&} signs that separate the columns of a tabular; so the error -message -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -! Extra alignment tab has been - changed to \cr -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -! Extra alignment tab has been changed to \cr -\end{verbatim} -\end{wideversion} -\end{quote} -could arise from a simple typo, such as: -\begin{quote} -\begin{verbatim} -\begin{tabular}{ll} - hello & there & jim \\ - goodbye & now -\end{tabular} -\end{verbatim} -\end{quote} -where the second \texttt{\&} in the first line of the table is more than the -two-column \texttt{ll} column specification can cope with. In this -case, an extra ``\texttt{l}'' in that solves the problem. (If you -continue from the error in this case, ``\texttt{jim}'' will be moved -to a row of his own.) Another simple typo that can provoke the error -is: -\begin{quote} -\begin{verbatim} -\begin{tabular}{ll} - hello & there - goodbye & now -\end{tabular} -\end{verbatim} -\end{quote} -where the `\texttt{\bsbs }' has been missed from the first line of the table. -In this case, if you continue from the error, you will find that -\LaTeX{} has made a table equivalent to: -\begin{quote} -\begin{verbatim} -\begin{tabular}{ll} - hello & there goodbye\\ - now -\end{tabular} -\end{verbatim} -\end{quote} -(with the second line of the table having only one cell). - -Rather more difficult to spot is the occurrence of the error when -you're using alignment instructions in a ``\texttt{p}'' column: -\begin{quote} -\begin{verbatim} -\usepackage{array} -... -\begin{tabular}{l>{\raggedright}p{2in}} -here & we are again \\ -happy & as can be -\end{tabular} -\end{verbatim} -\end{quote} -the problem here (as explained in % ! line break -\Qref[question]{tabular cell alignment}{Q-tabcellalign}) is that the -\csx{raggedright} command in the column specification has overwritten -\environment{tabular}'s definition of \texttt{\bsbs }, so that -``\texttt{happy}'' appears in a new line of the second column, and the -following \texttt{\&} appears to \LaTeX{} just like the second -\texttt{\&} in the first example above. - -Get rid of the error in the way described in % ! linebreak -\Qref[question]{tabular cell alignment}{Q-tabcellalign}~--- either use -\csx{tabularnewline} explicitly, or use the \csx{RBS} trick described -there. -\begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-divzero]{Graphics division by zero} - -While the error -\begin{quote} -\begin{verbatim} -! Package graphics Error: Division by 0. -\end{verbatim} -\end{quote} -can actually be caused by offering the package a figure which claims -to have a zero dimension, it's more commonly caused by rotation. - -Objects in \TeX{} may have both height (the height above the baseline) -and depth (the distance the object goes below the baseline). If you -rotate an object by 180\,degrees, you convert its height into depth, -and vice versa; if the object started with zero depth, you've -converted it to a zero-height object. - -Suppose you're including your graphic with a command like: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\includegraphics[angle=180,height=5cm]{myfig.eps} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\includegraphics[angle=180,% - height=5cm]{myfig.eps} -\end{verbatim} -\end{narrowversion} -\end{quote} -In the case that \File{myfig.eps} has no depth to start with, the -scaling calculations will produce the division-by-zero error. - -Fortunately, the \Package{graphicx} package has a keyword -\pkgoption{totalheight}, which allows you to specify the size of the -image relative to the sum of the object's \pkgoption{height} and -\pkgoption{depth}, so -\begin{quote} -\begin{wideversion} -\begin{verbatim} -\includegraphics[angle=180,totalheight=5cm]{myfig.eps} -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -\includegraphics[angle=180,% - totalheight=5cm]{myfig.eps} -\end{verbatim} -\end{narrowversion} -\end{quote} -will resolve the error, and will behave as you might hope. - -If you're using the simpler \Package{graphics} package, use the -\texttt{*} form of the \csx{resizebox} command to specify the use of -\pkgoption{totalheight}: -\begin{quote} -\begin{verbatim} -\resizebox*{!}{5cm}{% - \rotatebox{180}{% - \includegraphics{myfig.eps}% - }% -} -\end{verbatim} -\end{quote} -\begin{ctanrefs} -\item[graphics.sty,graphicx.sty]Both parts of the \CTANref{graphics} bundle -\end{ctanrefs} - -\Question[Q-missbegdoc]{Missing \csx{begin}\marg{document}} - -Give it a file of plain text, or a \LaTeX{} file that really does have no -\cmdinvoke{begin}{document} command in it, and \LaTeX{} will produce -this error, quite correctly. \LaTeX{} \emph{needs} -\cmdinvoke{begin}{document} so as to know when to execute the commands -that finish off the document preamble. - -Other than that, the error can occur as a result of an error of yours, -of a corrupt \extension{aux} file, or of a buggy class or package. - -The errors you might commit are absent-mindedly typing a document -command (such as \csx{section}) in the preamble of your document, -missing the comment marker from the beginning of a line, or giving too -many arguments to one of the setup commands related to the class or a -package that you have loaded. - -A corrupt \extension{aux} file might be due to any number of things; -delete the file and to run \LaTeX{} again, twice. If the error -recurs, it's probably due to a buggy class or package. - -If the error occurs while \LaTeX{} is reading a class or package, then -there's probably a bug in the file. The author of the class or -package stands the best chance of finding the bug, but with luck you -(or someone you ask on a mailing list or on \Newsgroup{comp.text.tex}) -will be able to spot the problem and provide a work-around. Always -report such bugs, even if you have found a work-around. - -\Question[Q-normalszmiss]{\csx{normalsize} not defined} - -The \LaTeX{} error: -\begin{quote} -\begin{narrowversion} -\begin{verbatim} -The font size command \normalsize is not - defined: there is probably something - wrong with the class file. -\end{verbatim} -\end{narrowversion} -\begin{wideversion} -\begin{verbatim} -The font size command \normalsize is not defined: -there is probably something wrong with the class file. -\end{verbatim} -\end{wideversion} -\end{quote} -is reporting something pretty fundamental (document base font size not -set up). While this \emph{can}, as the message implies, be due to a -broken class file, the more common cause is that you have simply -forgotten to put a \csx{documentclass} command in your document. - -\Question[Q-manymathalph]{Too many math alphabets} - -\TeX{} mathematics is one of its most impressive features, yet the -internal structure of the mechanism that produces it is painfully -complicated and (in some senses) pathetically limited. One area of -limitation is that one is only allowed 16~''maths alphabets'' - -\LaTeX{} offers the user quite a lot of flexibility with allocating -maths alphabets, but few people use the flexibility directly. -Nevertheless, there are many packages that provide symbols, or that -manipulate them, which allocate themselves one or more maths alphabet. - -If you can't afford to drop any of these packages, there's -still hope if you're using the \Package{bm} package to support -\Qref*{bold maths}{Q-boldgreek}: \Package{bm} is capable -of gobbling alphabets as if there is no tomorrow. The package defines -two limiter commands: \csx{bmmax} (for \emph{bold} symbols; default~4) -and \csx{hmmax} (for \emph{heavy} symbols, if you have them; -default~3), which control the number of alphabets to be used. - -Any reduction of the \csx{\emph{xx}max} variables will slow -\Package{bm} down~--- but that's surely better than the document not -running at all. So unless you're using maths fonts (such as -\FontName{Mathtime Plus}) that feature a heavy symbol weight, suppress all -use of heavy families by -\begin{quote} -\begin{verbatim} - \renewcommand{\hmmax}{0} -\end{verbatim} -\end{quote} -and then steadily reduce the bold families, starting with -\begin{quote} -\begin{verbatim} - \renewcommand{\bmmax}{3} -\end{verbatim} -\end{quote} -until (with a bit of luck) the error goes away. -\begin{ctanrefs} -\item[bm.sty]Distributed as part of \CTANref{2etools} -\end{ctanrefs} - -\Question[Q-ouparmd]{Not in outer par mode} - -The error: -\begin{quote} -\begin{verbatim} -! LaTeX Error: Not in outer par mode. -\end{verbatim} -\end{quote} -comes when some ``main'' document feature is shut up somewhere it -doesn't like. - -The commonest occurrence is when the user wants a figure somewhere -inside a table: -\begin{quote} -\begin{verbatim} -\begin{tabular}{|l|} - \hline - \begin{figure} - \includegraphics{foo} - \end{figure} - \hline -\end{tabular} -\end{verbatim} -\end{quote} -a construction that was supposed to put a frame around the diagram, -but doesn't work, any more than: -\begin{quote} -\begin{verbatim} -\framebox{\begin{figure} - \includegraphics{foo} - \end{figure}% -} -\end{verbatim} -\end{quote} -The problem is, that the \environment{tabular} environment, and the -\csx{framebox} command restrain the \environment{figure} environment -from its natural m\'etier, which is to float around the document. - -The solution is simply not to use the \environment{figure} environment -here: -\begin{quote} -\begin{verbatim} -\begin{tabular}{|l|} - \hline - \includegraphics{foo} - \hline -\end{tabular} -\end{verbatim} -\end{quote} -What was the float for?~--- as written in the first two examples, it -serves no useful purpose; but perhaps you actually wanted a diagram -and its caption framed, in a float. - -It's simple to achieve this~--- just reverse the order of the -environments (or of the \environment{figure} environment and the -command): -\begin{quote} -\begin{verbatim} -\begin{figure} - \begin{tabular}{|l|} - \hline - \includegraphics{foo} - \caption{A foo} - \hline - \end{tabular} -\end{figure} -\end{verbatim} -\end{quote} -The same goes for \environment{table} environments (or any other sort -of float you've defined for yourself) inside tabulars or box commands; -you \emph{must} get the float environment out from inside, one way or -another. - -\Question[Q-errmissitem]{Perhaps a missing \csx{item}?} - -Sometimes, the error -\begin{quote} -\begin{verbatim} -Something's wrong--perhaps a missing \item -\end{verbatim} -\end{quote} -actually means what it says: -\begin{quote} -\begin{verbatim} -\begin{itemize} - boo! -\end{itemize} -\end{verbatim} -\end{quote} -produces the error, and is plainly in need of an \csx{item} command. - -You can also have the error appear when at first sight things are -correct: -\begin{quote} -\begin{verbatim} -\begin{tabular}{l} - \begin{enumerate} - \item foo\\ - \item bar - \end{enumerate} -\end{tabular} -\end{verbatim} -\end{quote} -produces the error at the \texttt{\bsbs }. This usage is just wrong; if you -want to number the cells in a table, you have to do it ``by hand'': -\begin{quote} -\begin{verbatim} -\newcounter{tablecell} -\begin{tabular}{l} - \stepcounter{tablecell} - \thetablecell. foo\\ - \stepcounter{tablecell} - \thetablecell. bar - \end{enumerate} -\end{tabular} -\end{verbatim} -\end{quote} -This is obviously untidy; a command \csx{numbercell} defined as: -\begin{quote} -\begin{verbatim} -\newcounter{tablecell} -\newcommand*{\numbercell}{% - \stepcounter{tablecell}% - \thetablecell. % ** -} -\end{verbatim} -\end{quote} -could make life easier: -\begin{quote} -\begin{verbatim} -\begin{tabular}{l} - \numbercell foo\\ - \numbercell bar - \end{enumerate} -\end{tabular} -\end{verbatim} -\end{quote} -(Note the deliberate introduction of a space as part of the command, -marked with asterisks.) - -However, the error regularly appears when you would never have thought -that a \csx{item} command might be appropriate. For example, the -seemingly innocent: -\begin{quote} -\begin{verbatim} -\fbox{% - \begin{alltt} - boo! - \end{alltt}% -} -\end{verbatim} -\end{quote} -produces the error (the same happens with \csx{mbox} in place of -\csx{fbox}, or with either of their ``big brothers'', \csx{framebox} and -\csx{makebox}). This is because the \environment{alltt} environment -uses a ``trivial'' list, hidden inside their definition. (The -\environment{itemize} environment also has this construct inside -itself, in fact, so \cmdinvoke{begin}{itemize} won't work inside an -\csx{fbox}, either.) The list construct wants to happen between -paragraphs, so it makes a new paragraph of its own. Inside the -\csx{fbox} command, that doesn't work, and subsequent macros convince -themselves that there's a missing \csx{item} command. - -To solve this rather cryptic error, one must put the -\environment{alltt} inside a paragraph-style box. The following -modification of the above \emph{does} work: -\begin{quote} -\begin{verbatim} -\fbox{% - \begin{minipage}{0.75\textwidth} - \begin{alltt} - hi, there! - \end{alltt} - \end{minipage} -} -\end{verbatim} -\end{quote} -The code above produces a box that's far too wide for the text. One -may want to use something that allows % ! line break -\Qref*{variable size boxes}{Q-varwidth} in place of the -\environment{minipage} environment. - -Oddly, although the \environment{verbatim} environment wouldn't work -inside a \csx{fbox} command argument (see % ! line break -\Qref[question]{verbatim in command arguments}{Q-verbwithin}), you -get an error that complains about \csx{item}: the environment's -internal list bites you before \environment{verbatim} has even had a -chance to create its own sort of chaos. - -Another (seemingly) obvious use of \csx{fbox} also falls foul of this -error: -\begin{quote} -\begin{verbatim} -\fbox{\section{Boxy section}} -\end{verbatim} -\end{quote} -This is a case where you've simply got to be more subtle; you should -either write your own macros to replace the insides of \LaTeX{}'s -sectioning macros, or look for some alternative in the packages -discussed in % ! line break -``\Qref*[question]{The style of section headings}{Q-secthead}''. - -\Question[Q-errparnum]{Illegal parameter number in definition} - -The error message means what it says. In the simple case, you've -attempted a definition like: -\begin{quote} -\begin{verbatim} -\newcommand{\abc}{joy, oh #1!} -\end{verbatim} -\end{quote} -or (using \TeX{} primitive definitions): -\begin{quote} -\begin{verbatim} -\def\abc{joy, oh #1!} -\end{verbatim} -\end{quote} -In either of the above, the definition uses an argument, but the -programmer did not tell \AllTeX{}, in advance, that she was going to. -The fix is simple~--- \cmdinvoke{newcommand}{\csx{abc}}[1], in the -\LaTeX{} case, |\def\abc#1| in the basic \TeX{} case. - -The more complicated case is exemplified by the attempted definition: -\begin{quote} -\begin{verbatim} -\newcommand{\abc}{joy, oh joy!% - \newcommand{\ghi}[1]{gloom, oh #1!}% -} -\end{verbatim} -\end{quote} -will also produce this error, as will its \TeX{} primitive equivalent: -\begin{quote} -\begin{verbatim} -\def\abc{joy, oh joy!% - \def\ghi#1{gloom, oh #1!}% -} -\end{verbatim} -\end{quote} -This is because special care is needed when defining one macro within -the code of another macro. This is explained elsewhere, separately -for \Qref*[question]{\LaTeX{} definitions}{Q-ltxhash} and for -\Qref*[question]{\TeX{} primitive definitions}{Q-hash} - -\Question[Q-fllost]{Float(s) lost} - -The error -\begin{quote} -\begin{verbatim} -! LaTeX Error: Float(s) lost. -\end{verbatim} -\end{quote} -seldom occurs, but always seems deeply cryptic when it \emph{does} -appear. - -The message means what it says: one or more figures, tables, etc., or -marginpars has not been typeset. (Marginpars are treated internally -as floats, which is how they come to be lumped into this error -message.) - -The most likely reason is that you placed a float or a \csx{marginpar} -command inside another float or marginpar, or inside a -\environment{minipage} environment, a \csx{parbox} or \csx{footnote}. -Note that the error may be detected a long way from the problematic -command(s), so the techniques of % ! line break -\Qref*{tracking down elusive errors}{Q-erroradvice} all need to be -called into play. - -This author has also encountered the error when developing macros that -used the \LaTeX{} internal float mechanisms. Most people doing that -sort of thing are expected to be able to work out their own problems\dots{} - -\Question[Q-texorpdf]{Token not allowed in PDFDocEncoded string} - -The package \Package{hyperref} produces this error when it doesn't -know how to make something into a ``character'' that will go into one -of its \acro{PDF} entries. For example, the (unlikely) sequence -\begin{quote} -\begin{verbatim} -\newcommand{\filled}[2]{% - #1% - \hfil - #2% -} -\section{\filled{foo}{bar}} -\end{verbatim} -\end{quote} -provokes the error. \Package{Hyperref} goes on to tell you: -\begin{quote} -\begin{verbatim} -removing `\hfil' on input line ... -\end{verbatim} -\end{quote} -It's not surprising: how would \emph{you} put the -typesetting instruction \csx{hfil} into a \acro{PDF} bookmark? - -\Package{Hyperref} allows you to define an alternative for such -things: the command \csx{texorpdfstring}, which takes two -arguments~--- the first is what is typeset, the second is what is put -into the bookmark. For example, what you would probably like in this -case is just a single space in the bookmark; if so, the erroneous -example above would become: -\begin{quote} -\begin{verbatim} -\newcommand{\filled}[2]{% - #1% - \texorpdfstring{\hfil}{\space}% - #2% -} -\section{\filled{foo}{bar}} -\end{verbatim} -\end{quote} -and with that definition, the example will compile succesfully -(\Package{hyperref} knows about the macro \csx{space}). - -\Question[Q-optionclash]{Option clash for package} - -So you've innocently added: -\begin{quote} -\cmdinvoke{usepackage}[draft]{graphics} -\end{quote} -to your document, and \LaTeX{} responds with -\begin{wideversion} -\begin{quote} -\begin{verbatim} -! LaTeX Error: Option clash for package graphics. -\end{verbatim} -\end{quote} -\end{wideversion} -\begin{narrowversion} -\begin{quote} -\begin{verbatim} -! LaTeX Error: Option clash for package - graphics. -\end{verbatim} -\end{quote} -\end{narrowversion} - -The error is a complaint about loading a package % ! line break -\emph{with options}, more than once (\LaTeX{} doesn't actually examine -what options there are: it complains because it can't do anything with -the multiple sets of options). You can load a package -any number of times, with no options, and \LaTeX{} will be happy, but -you may only supply options when you first load the package. - -So perhaps you weren't entirely innocent~--- the error would have -occurred on the second line of: -\begin{quote} -\cmdinvoke{usepackage}[dvips]{graphics}\\ -\cmdinvoke{usepackage}[draft]{graphics} -\end{quote} -which could quite reasonably (and indeed correctly) have been typed: -\begin{quote} -\cmdinvoke{usepackage}[dvips,draft]{graphics} -\end{quote} - -But if you've not made that mistake (even with several lines -separating the \csx{usepackage} commands, it's pretty easy to spot), -the problem could arise from something else loading the package for -you. How do you find the culprit? The "\texttt{h}" response to the -error message tells you which options were loaded each time. -Otherwise, it's down to the log analysis games discussed in % ! line break -``\Qref*{How to approach errors}{Q-erroradvice}''; the trick to remember -is that that the process of loading each file is parenthesised in the -log; so if package \Package{foo} loads \Package{graphics}, the log -will contain something like: -\begin{quote} -\begin{verbatim} -(<path>/foo.sty ... -... -(<path>/graphics.sty ... -...) -... -) -\end{verbatim} -\end{quote} -(the parentheses for \Package{graphics} are completely enclosed in -those for \Package{foo}; the same is of course true if your class -\Class{bar} is the culprit, except that the line will start with the -path to \texttt{bar.cls}). - -If we're dealing with a package that loads the package you are -interested in, you need to ask \LaTeX{} to slip in options when -\Package{foo} loads it. Instead of: -\begin{quote} -\cmdinvoke{usepackage}{foo}\\ -\cmdinvoke{usepackage}[draft]{graphics} -\end{quote} -you would write: -\begin{quote} -\cmdinvoke{PassOptionsToPackage}{draft}{graphics}\\ -\cmdinvoke{usepackage}{foo} -\end{quote} -The command \csx{PassOptionsToPackage} tells \LaTeX{} to behave as if -its options were passed, when it finally loads a package. As you would -expect from its name, \csx{PassOptionsToPackage} can deal with a list -of options, just as you would have in the the options brackets of -\csx{usepackage}. - -More trickily, instead of: -\begin{quote} -\cmdinvoke{documentclass}[...]{bar}\\ -\cmdinvoke{usepackage}[draft]{graphics} -\end{quote} -you would write: -\begin{quote} -\cmdinvoke{PassOptionsToPackage}{draft}{graphics}\\ -\cmdinvoke{documentclass}[...]{bar} -\end{quote} -with \csx{PassOptionsToPackage} \emph{before} the \csx{documentclass} -command. - -However, if the \Package{foo} package or the \Class{bar} class loads -\Package{graphics} with an option of its own that clashes with -what you need in some way, you're stymied. For example: -\begin{quote} -\cmdinvoke{PassOptionsToPackage}{draft}{graphics} -\end{quote} -where the package or class does: -\begin{quote} -\cmdinvoke{usepackage}[final]{graphics} -\end{quote} -sets \pkgoption{final} \emph{after} it's dealt with option you passed to -it, so your \pkgoption{draft} will get forgotten. In extreme cases, -the package might generate an error here (\Package{graphics} doesn't -go in for that kind of thing, and there's no indication that -\pkgoption{draft} has been forgotten). - -In such a case, you have to modify the package or class itself -(subject to the terms of its licence). It may prove useful to contact -the author: she may have a useful alternative to suggest. - -\Question[Q-checksum]{Checksum mismatch in font} - -When \MF{} generates a font it includes a checksum in the font bitmap -file, and in the font metrics file (\acro{TFM}). \AllTeX{} includes -the checksum from the \acro{TFM} file in the \acro{DVI} file. - -When \ProgName{dvips} (or other \acro{DVI} drivers) process a -\acro{DVI} file, they compare checksums in the \acro{DVI} file to -those in the bitmap fonts being used for character images. If the -checksums don't match, it means the font metric file used by \AllTeX{} -was not generated from the same \MF{} program that generated the -font. - -This commonly occurs when you're processing someone else's \acro{DVI} -file. - -The fonts on your system may also be at fault: possibilities are that -the new \acro{TFM} was not installed, or installed in a path after an -old \acro{TFM} file, or that you have a personal cache of bitmaps from -an old version of the font. - -In any case, look at the output -- the chances are that it's perfectly -\acro{OK}, since metrics tend not to change, even when the bitmaps are -improved. (Indeed, many font designers~--- Knuth included~--- -maintain the metrics come what may.) - -If the output \emph{does} look bad, your only chance is to regenerate -things from scratch. Options include: flushing your bitmap cache, -rebuild the \acro{TFM} file locally, and so on. - -\Question[Q-entercompmode]{Entering compatibility mode} - -You run your \LaTeX{} job, and it starts by saying -\begin{quote} -\begin{verbatim} -Entering LaTeX 2.09 COMPATIBILITY MODE -\end{verbatim} -\end{quote} -followed by lines of asterisks and \texttt{!!WARNING!!}. - -This means that the document is not written in ``current'' \LaTeX{} -syntax, and that there is no guarantee that all parts of the document -will be formatted correctly. - -If the document is someone else's, and you want no more than a copy to -read, ignore the error. The document may fail elsewhere, but as often -as not it will provide a \extension{dvi} or \extension{pdf} that's -adequate for most purposes. - -If it's a new document you have just started working on, you have been -misled by someone. You have written something like: -\begin{quote} - \cmdinvoke{documentstyle}{article} -\end{quote} -or, more generally: -\begin{quote} - \cmdinvoke*{documentstyle}[options]{class} -\end{quote} -These forms are (as the warning says) \LaTeXo{} syntax, and to get rid -of the warning, you must change the command. - -The simple form is easy to deal with: -\begin{quote} - \cmdinvoke{documentstyle}{article} -\end{quote} -should become: -\begin{quote} - \cmdinvoke{documentclass}{article} -\end{quote} -The complex form is more difficult, since \LaTeXo{} ``options'' -conflate two sorts of things~--- options for the class (such as -\pkgoption{11pt}, \pkgoption{fleqn}), and packages to be loaded. -So: -\begin{quote} - \cmdinvoke{documentstyle}[11pt,verbatim]{article} -\end{quote} -should become: -\begin{quote} - \cmdinvoke{documentclass}[11pt]{article}\\ - \cmdinvoke{usepackage}{verbatim} -\end{quote} -because \pkgoption{11pt} happens to be a class option, while -\Package{verbatim} is a package. - -There's no simple way to work out what are class options under -\LaTeXo{}; for \Class{article}, the list includes \pkgoption{10pt}, -\pkgoption{11pt}, \pkgoption{12pt}, \pkgoption{draft}, -\pkgoption{fleqn}, \pkgoption{leqno}, \pkgoption{twocolumn} and -\pkgoption{twoside}~--- anything else must be a package. - -Your document may well ``just work'' after changes like those above; -if not, you should think through what you're trying to do, and consult -documentation on how to do it~--- there are lots of % ! line break -\Qref*{free tutorials}{Q-tutorials*} to help you on your way, if you -don't have access to a \LaTeX{} manual of any sort. - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\section{Current \TeX{}-related projects} - -\Question[Q-LaTeX3]{The \LaTeX{} project} - -The \LaTeX{} project team (see \URL{http://www.latex-project.org/latex3.html}) -is a small group of volunteers whose aim is -to produce a major new document processing system based on the -principles pioneered by Leslie Lamport in the current \LaTeX{}. The -new system is (provisionally) called \LaTeX{}3; it -will remain freely available and it will be fully documented at -all levels. - -The \LaTeX{} team's first product (\LaTeXe{}) was delivered in 1994 -(it's now properly called ``\LaTeX{}'', since no other version is current). - -\LaTeXe{} was intended as a consolidation exercise, unifying several -sub-variants of \LaTeX{} while changing nothing whose change wasn't -absolutely necessary. This has permitted the team to support a single -version of \LaTeX{}, in parallel with development of \LaTeX{}3. - -Some of the older discussion papers about directions for \LaTeX{}3 are -to be found on \acro{CTAN}; other (published) articles are to be -found on the project web site -(\URL{http://www.latex-project.org/papers/}), as is some of the -project's experimental code -(see \URL{http://www.latex-project.org/code.html}, which allows you to -read the project's source repository); a recent snapshot of two major -collections from the code, \Package{expl3} and \Package{xpackages}, -are available. Contributed code, such as \Package{keys3} (for -key-value argument decoding) and \Package{numparse3} (for number -processing) are available in the \acro{CTAN} `\LaTeX{} experimental' tree. - -You can -participate in discussions of the future of \LaTeX{} through the -mailing list \texttt{latex-l}. Subscribe to the list by sending a -message `\texttt{subscribe latex-l <\emph{your name}>}' to -\mailto{listserv@urz.Uni-Heidelberg.de} -\begin{ctanrefs} -\item[expl3 \nothtml{\rmfamily}bundle]\CTANref{expl3} -\item[keys3.sty]\CTANref{keys3} -\item[\nothtml{\rmfamily}\LaTeX{} project publications]\CTANref{ltx3pub} -\item[xpackages \nothtml{\rmfamily}bundle]\CTANref{xpackages} -\end{ctanrefs} - -\Question[Q-mathml]{Future \acro{WWW} technologies and \AllTeX{}} - -An earlier answer % ! line break -(\Qref[number]{``converting to \acro{HTML}''}{Q-LaTeX2HTML}) -addresses the issue of converting existing \AllTeX{} documents for -viewing on the Web as \acro{HTML}. All the present techniques are -somewhat flawed: the answer explains why. - -However, things are changing, with -better font availability, cunning \acro{HTML} programming and the -support for new Web standards. -\begin{description} -\item[Font technologies] Direct representation of mathematics in - browsers has been hampered up to now by the limited range of symbols - in the fonts one can rely on being available. Some existing - \AllTeX{} to \acro{HTML} converters provide maths symbols by - hitching them to alternate font face specifications for standard - code points in a non-standard way. This does nothing for the - universality of the \acro{HTML} so generated. - - In the near future, we can expect rather wide availability of - Unicode fonts with good coverage of symbols, which should make life - easier for those who need to represent mathematics. -\item[\acro{XML}] The core of the range of new standards is - \acro{XML}, which provides a framework for better structured markup; - limited support for it has already appeared in some browsers. - - Conversion of \AllTeX{} source to \acro{XML} is already available - (through \TeX{}4ht at least), and work continues in that arena. The - alternative, authoring in \acro{XML} (thus producing documents that - are immediately Web-friendly, if not ready) and using \AllTeX{} to - typeset is also well advanced. One useful technique is - \Qref*{\emph{transforming} the \acro{XML} to \LaTeX{}}{Q-SGML2TeX}, - using an \acro{XSLT} stylesheet or code for an \acro{XML} library, - and then simply using \LaTeX{}; alternatively, one may - \Qref*{typeset direct from the \acro{XML} source}{Q-readML}. -\item[Direct representation of mathematics] - Math\acro{ML} is a standard for representing maths on the Web; its - original version was distinctly limited, but version 2 of Math\acro{ML} - has had major browser support since 2002 with richness of mathematical - content for online purposes approaching that of \TeX{} for print. - Browser support for Math\acro{ML} is provided by \ProgName{amaya}, the - `Open Source' browser \ProgName{mozilla} (and its derivatives - including \ProgName{NetScape}, \ProgName{Firefox} and \ProgName{Galeon}) and - \ProgName{Internet Explorer} when equipped with a suitable plug-in - such as \ProgName{MathPlayer}. - There's evidence that \AllTeX{} users are starting to use such - browsers. Some believe that \acro{XHTML}+Math\acro{ML} now provides - better online viewing than \acro{PDF}. - Work to produce \acro{XHTML}+Math\acro{ML} is well advanced in both the - \TeX{}4ht and \ProgName{TtH} projects for \AllTeX{} conversion. -%% Such conversion, however, has limits of soundness unless one -%% is very much aware of the needs of one's conversion program -%% and adapts one's usage of \AllTeX{} accordingly. - - An approach different from \AllTeX{} conversion is taken by - the \href{http://www.albany.edu/~hammond/gellmu/}{\emph{GELLMU} Project}. - Its \emph{article} \acro{XML} document type, which has a markup vocabulary - close to \LaTeX{} that can be edited using \LaTeX{}-like markup - (even though it is not \LaTeX{}~--- so far), comes with translators - that make both \acro{PDF} (via \emph{pdflatex}) and - \acro{XHTML}+Math\acro{ML}. Such an approach avoids the inherent - limitations of the ``traditional'' \AllTeX{} translation processes, - which have traps that can be sprung by unfettered use of \AllTeX{} - markup. -\item[Graphics] - \acro{SVG} is a standard for graphics representation on the web. - While the natural use is for converting existing figures, - representations of formulas are also possible, in place of the separate - bitmaps that have been used in the past (and while we wait for the - wider deployment of Math\acro{ML}). - - Browser plug-ins, that deal with \acro{SVG} are already available - (Adobe offer one, for example). More recently, the open source - graphics editor \href{http://www.inkscape.org/}{\ProgName{Inkscape}} - has appeared, and has been reported to be useful for - \acro{SVG}-related work in at least one \TeX{}-related project. Be - aware that the developers of \ProgName{Inkscape} have no illusions - about being able to replace commercial software, yet\dots{} -\item[Direct use of \TeX{} markup] - Some time back, \acro{IBM} developed a browser plug-in called - TechExplorer, which would display \AllTeX{} documents direct in a - browser. Over the years, it developed into a Math\acro{ML} browser - plug-in, while still retaining its \AllTeX{} abilities, but it's now - distributed (free for Linux and Windows platforms) by - \href{http://www.integretechpub.com/}{Integre Technical Publishing}. - - The disadvantage of the TechExplorer approach is that it places the - onus on the browser user; and however technically proficient - \emph{you} are, it's never safe to assume too much of your readers. - An interesting alternative is - \href{http://www.forkosh.com/mathtex.html}{Math\TeX{}}, which sits - on your server as a \acro{CGI} script, and you use it to include - your \TeX{}, in your \acro{HTML}, as if it were an image: -\begin{quote} -\begin{wideversion} -\begin{verbatim} -<img src="/cgi-bin/mimetex.cgi?f(x)=\int\limits_{-\infty}^xe^{-t^2}dt"> -\end{verbatim} -\end{wideversion} -\begin{narrowversion} -\begin{verbatim} -<img src="/cgi-bin/mimetex.cgi?f(x)= - \int\limits_{-\infty}^xe^{-t^2}dt"> -\end{verbatim} -\end{narrowversion} -\end{quote} -(\Package{Mathtex} supersedes the author's earlier \Package{mimetex}.) -\end{description} -\begin{ctanrefs} -\item[GELLMU]\CTANref{gellmu} -\item[MathTeX]\CTANref{MimeTeX} -\item[MimeTeX]\CTANref{MimeTeX} -\item[TeX4HT]\CTANref{tex4ht} -\end{ctanrefs} - -\Question[Q-textrace]{Making outline fonts from \MF{}} - -\ProgName{TeXtrace}, originally developed by P\'eter Szab\'o, is a -bundle of Unix scripts that use Martin Weber's freeware boundary -tracing package -\href{http://autotrace.sourceforge.net}{\ProgName{autotrace}} to -generate Type~1 outline fonts from \MF{} bitmap -font outputs. The result is unlikely ever to be of the quality of -the commercially-produced Type~1 font, but there's always the -\href{http://fontforge.sourceforge.net/}{\ProgName{FontForge}} font -editor to tidy things. Whatever, there -remain fonts which many people find useful and which fail to attract -the paid experts, and auto-tracing is providing a useful service here. -Notable sets of -fonts generated using \ProgName{TeXtrace} are P\'eter Szab\'o's own -\acro{EC}/\acro{TC} font set \FontName{tt2001} and Vladimir Volovich's -\acro{CM}-Super set, which covers the \acro{EC}, \acro{TC}, and the -Cyrillic \acro{LH} font sets (for details of both of which sets, see -\Qref[answer]{``8-bit'' type 1 fonts}{Q-type1T1}). - -Another system, which arrived slightly later, is -\href{http://www.cs.uu.nl/~hanwen/mftrace/}{\ProgName{mftrace}}: -this is a small \ProgName{Python} program that does the same job. -\ProgName{Mftrace} may use either \ProgName{autotrace} (like -\ProgName{TeXtrace}) or Peter Selinger's -\href{http://potrace.sourceforge.net}{\ProgName{potrace}} to produce -the initial outlines to process. \ProgName{Mftrace} is said to be -more flexible, and easier to use, than is \ProgName{TeXtrace}, but both systems -are increasingly being used to provide Type~1 fonts to the public domain. - -The \ProgName{MetaType1} system aims to use \MF{} font sources, by way -of \MP{} and a bunch of scripts and so on, to produce high-quality -Type~1 fonts. The first results, the % ! line break -\Qref*{\Package{Latin Modern} fonts}{Q-type1T1}, are now -well-established, and a bunch of existing designs have been reworked -in MetaType1 format. -\begin{ctanrefs} -\item[MetaType1]\CTANref{metatype1} -\end{ctanrefs} - -\Question[Q-WYGexpts]{The \TeX{} document preparation environment} - - -``\Qref*{Why \TeX{} is not \WYSIWYG{}}{Q-notWYSIWYG}'' -outlines the reasons (or excuses) for the huge disparity of user -interface between ``typical'' \TeX{} environments and commercial word -processors. - -Nowadays, at last, there is a range of tools available that try either -to bridge or to close the gap. One range modestly focuses on -providing the user with a legible source document. At the other -extreme we have \href{http://www.texmacs.org}{\ProgName{TeXmacs}}, -a~document processor using -\TeX{}'s algorithms and fonts for both editor display and printing. -\ProgName{TeXmacs} does not use the \TeX{} -language itself (though among other formats, \LaTeX{} may be exported -and imported). A bit closer to \LaTeX{} is -\href{http://www.lyx.org/}{LyX}, which has its own -editor display and file formats as well, but does its print output by -exporting to \LaTeX{}. The editor display merely resembles the -printed output, but you have the possibility of entering arbitrary -\LaTeX{} code. If you use constructs that LyX does not -understand, it will just display them as source text marked red, but -will properly export them. - -Since a lot of work is needed to create an editor from scratch that -actually is good at editing (as well as catering for \TeX{}), it is -perhaps no accident that several approaches have been implemented -using the extensible \ProgName{emacs} editor. The low end of the -prettifying range is occupied by syntax highlighting: marking \TeX{} -tokens, comments and other stuff with special colours. -Many free editors (including \ProgName{emacs}) can cater for \TeX{} in -this way. Under Windows, one of the more popular editors with such -support is the -Shareware product \href{http://www.winedt.com/}{\ProgName{winedt}}. -Continuing the range of -tools prettifying your input, we have the \ProgName{emacs} package -\href{http://x-symbol.sourceforge.net}{\Package{x-symbol}}, which does -the \WYSIWYG{} part of its work by replacing single \TeX{} tokens and -accented letter sequences with appropriate-looking characters on the -screen. - -A different type of tool focuses on making update and access to -previews of the typeset document more immediate. A recent addition -in several viewers, editors and \TeX{} executables are so-called -`source specials' for cross-navigation. When \TeX{} compiles a -document, it will upon request insert special markers for every input -line into the typeset output. The markers are interpreted by the \acro{DVI} -previewer which can be made to let its display track the page -corresponding to the editor input position, or to let the editor jump -to a source line corresponding to a click in the preview window. - -An \ProgName{emacs} package that combines this sort of editor movement -tracking with automatic fast recompilations (through the use of dumped -formats) is -\href{http://pauillac.inria.fr/whizzytex/}{\Package{WhizzyTeX}} - which is best used with a previewer by the -same author. A simpler package in a similar spirit is called -\href{http://www.activetex.org/}{\Package{InstantPreview}} and makes -use of a continuously running copy of \TeX{} -(under the moniker of \texttt{TeX daemon}) instead of dumping formats to -achieve its speed. - -Another \ProgName{emacs} package called -\href{http://preview-latex.sourceforge.net}{\Package{preview-latex}} -tries to solve -the problem of visual correlation between source and previews in a -more direct way: it uses a \LaTeX{} package to chop the document source -into interesting fragments (like figures, text or display math) which -it runs through \LaTeX{} and replaces the source text of those -fragments with the corresponding rendered output images. Since it -does not know about the structure of the images, at the actual cursor -position the source text is displayed while editing rather than the -preview. This approach is more or less a hybrid of the source -prettifying and fast preview approaches since it works in the source -buffer but uses actual previews rendered by \LaTeX{}. - -A more ambitious contender is called \TeX{}lite. This -system is only available on request from its author; -it continuously updates its screen with the help of a special version -of \TeX{} dumping its state in a compressed format at each page and -using hooks into \TeX{}'s line breaking mechanism for reformatting -paragraphs on the fly. That way, it can render the output from the -edited \TeX{} code with interactive speed on-screen, and it offers the -possibility of editing directly in the preview window. - -That many of these systems occupy slightly different niches can be -seen by comparing the range of the -\ProgName{emacs}-based solutions ranging from syntax highlighting to instant -previewing: all of them can be activated at the same time without -actually interfering in their respective tasks. - -The different approaches offer various choices differing in the -immediacy of their response, the screen area they work on (source or -separate window), degree of correspondence of the display to the final -output, and the balance they strike between visual aid and visual -distraction. -\begin{ctanrefs} -\item[preview-latex]Distributed as part of \CTANref{auctex} -\item[texmacs]Browse \CTANref{texmacs} -\end{ctanrefs} - -\Question[Q-omegaleph]{Omega and Aleph} - -Omega \nothtml{(\ensuremath{\Omega})} was developed as an extension of -\TeX{}, to use with multilingual texts, expressed in a variety of -input encodings. Omega uses 16-bit, Unicode-encoded, characters. It -provides many innovative concepts, notably including the ``translation -process'' that takes a character stream and transforms it according to -various processes that may be internally specified, or be a separate -program. - -While Omega showed a lot of promise at its mid-1990s announcement, -progress was slow, and development was essentially dead by the time -that one of the original developers withdrew (taking with him a bunch -of research students). - -Before that distressing event, a separate thread of development had -started, to produce a program % !avoid space between Aleph and comma -called Aleph\nothtml{ (\ensuremath{\aleph})}, which merged the facilities of -\Qref*{\eTeX{}}{Q-etex} into a stable Omega codebase and added other -extensions. Aleph also proved an attractive platform for many people; -but its development, too, has dried up. - -A presentation at Euro\TeX{} 2006 claimed that development of Omega -was picking up again, in parallel with research into what the (new) -developers consider a rational scheme for supporting \TeX{}-style -typesetting. The new system was to be known as Omega-2 -(\latexhtml{\ensuremath{\Omega_2}}{Omega subscript 2}), and was to be -designed in a modular fashion so that support of new facilities (such -as use of advanced OpenType fonts) could be added in a relatively -straightforward fashion. A quick web search leads to a recommendation -that potential users consider \Qref{\LuaTeX{}}{Q-luatex} instead. -Fortunately, lessons learned in Aleph project are being carried -forward in the \Qref*{\LuaTeX{}}{Q-luatex} project. - -\Question[Q-xetex]{The \xetex{} project} - -\href{http://scripts.sil.org/xetex}{\xetex{}}, by Jonathan Kew, is a -successor to the shareware \TeX{}/\acro{GX} program for Macintoshes. -It is a Unicode-based \TeX{} implementation which is able to make -direct use of the fonts installed on a system. It supports the -advanced typographical features available in modern font technology -(OpenType, \acro{AAT} on Mac~\acro{OS}~X, Graphite). \xetex{} was -originally developed for Mac~\acro{OS}~X but it is now fully -integrated in \texlive{} on a wide range of platforms, as well as -being available as part of \miktex{}. \xetex{} supports Unicode -character sets and bidirectional typesetting (via \eTeX{} primitives). -It is popular among linguists and scholars in the humanities, as well -as an increasing range of people working in other fields. Support for -mathematical Unicode fonts (such as Asana Math and Cambria) is -progressing. - -The project has an active % ! line break -\href{http://www.tug.org/mailman/listinfo/xetex}{mailing list}; a -collection of other information is to be found in a set of % ! line break -\href{http://www.tug.org/xetex/}{links on the \acro{TUG} web site}. - -\Question[Q-luatex]{\PDFTeX{} and \LuaTeX{}} - -As is said elsewhere in these \acro{FAQ}s, development of -\Qref*{\PDFTeX{}}{Q-whatpdftex} is ``in essence'' complete~--- -no new facilities are being developed, since the limitations of the -present structure mean that the returns on effort invested are -diminishing. The \PDFTeX{} team has announced that no further -developments will be added after the release of \PDFTeX{} 1.50.0, -which will be the next major release. - -In parallel with the running-down of \PDFTeX{} development, -development of a new system, \LuaTeX{} is under way. -\href{http://www.lua.org/}{\ProgName{Lua}} is a script -language, designed to offer an interpreter that may be incorporated -into other applications. \LuaTeX{} consists of a \TeX{}-like engine -with a \ProgName{lua} interpreter built into it; the \ProgName{lua} -interpreter has access to many of the data structures used for -typesetting, and the user may also interpolate chunks of -\ProgName{lua} code into their \AllTeX{} macros, or as `call-backs' -for use when the \TeX{}-like engine does certain operations. - -This arrangement offers the prospect of a ``semi-soft'' typesetting -engine: it will have its basic behaviour, but the user gets to -redefine functionality if an idea occurs~--- there will be no need to -persuade the world first, and then find a willing developer to work on -the sources of of the distribution. - -The \href{http://www.luatex.org/}{\LuaTeX{} project} is (with monetary -support from various sources) pursuing avenues that many of the other -current projects have in their sights, notably Unicode character -representations and support for OpenType fonts. The intention is -to integrate the extensions pioneered by \Qref*{Aleph}{Q-omegaleph}. - -A release of \LuaTeX{} whose functionality is declared (version 0.50) -has recently appeared. \texlive{} 2008 incorporates an early release -of \LuaTeX{}, and the upcoming \miktex{} version 2.8 (no current -release date) will probably incorporate \LuaTeX{}. \CONTeXT{} -distributions can already make use of \LuaTeX{}. - -\Question[Q-ant]{The \textsf{ANT} typesetting system} - -Achim Blumensath's \href{http://ant.berlios.de}{\textsf{ANT}} project -aims not to replicate \TeX{} with a different implementation -technique, but rather to provide a replacement for \TeX{} which uses -\TeX{}-like typesetting algorithms in a very different programming -environment. \textsf{ANT} remains under development, but it is now -approaching the status of a usable typesetting system. - -\textsf{ANT}'s markup language is immediately recognisable to the -\AllTeX{} user, but the scheme of implementing design in -\textsf{ANT}'s own implementation language (presently -\ProgName{OCaml}) comes as a pleasant surprise to the jaded \acro{FAQ} -writer. This architecture holds the promise of a system that avoids a -set of serious problems with \TeX{}'s user interface: those that -derive from the design language being the same as the markup language. -\begin{ctanrefs} -\item[\textsf{ANT}]\CTANref{ant} -\end{ctanrefs} - -\Question[Q-extex]{The \ExTeX{} project} - -\href{http://www.extex.org/}{The \ExTeX{} project} is -building on the experience of the many existing \TeX{} development and -extension projects, to develop a new \TeX{}-like system. The system -is to be developed in Java (like the ill-fated \NTS{} project). - -While \ExTeX{} will implement all of \TeX{}'s primitives, some may be -marked as obsolete, and ``modern'' alternatives provided (an obvious -example is the primitive \csx{input} command, whose syntax inevitably -makes life difficult for users of modern operating system file -paths). Desirable extensions from \Qref*{\eTeX{}}{Q-etex}, -\Qref*{\PDFTeX{}}{Q-whatpdftex} and \Qref*{\ensuremath{\Omega}}{Q-omegaleph} -have been identified. - -Usability will be another focus of the work: debugging support and log -filtering mechanisms will please those who have long struggled with -\TeX{} macros. - -\ExTeX{} will accept Unicode input, from the start. In the longer -term, drawing primitives are to be considered. - -\Question[Q-biblatex]{Replacing the \BibTeX{}--\LaTeX{} mechanism} - -Producing a successor to \BibTeX{} has long been a favoured activity -among a certain class of \TeX{}-users; the author has seen reports of -progress (on several projects), over the years, but few that claim to -be ready for ``real-world'' use. - -Few would deny that \BibTeX{} is ripe for renewal: as originally -conceived, it was a program for creating bibliographies for technical -documents, in English. People have contributed mechanisms for a -degree of multilingual use (whose techniques are arcane, and quite -likely inextensible); and specialist \BibTeX{} style files are -available for use in non-technical papers. - -\BibTeX{} uses a style language whose mechanisms are unfamiliar to -most current programmers: it's difficult to learn, but since there are -fewer opportunities to write the language, it's also difficult to become -fluent (in the way that so many people fluently write the equally -arcane \TeX{} macro language). - -Oren Patashnik (the author of \BibTeX{}) summarises the issues as he -sees them, in a % !line break -\href{http://tug.org/TUGboat/Articles/tb24-1/patashnik.pdf}{\acro{TUG} conference paper from 2003} -that seems to suggest that we might expect a -\BibTeX{}~1.0\dots{}which hasn't (yet) appeared. - -In the absence of \BibTeX{}~1.0, what do we need from the bibliography -system of the future?~--- simple: a superset of what \BibTeX{} does -(or can be made to do), implemented in a simpler style language, with -coherent multilingual capabilities. - -Of the direct \BibTeX{} replacements, the only one whose authors have -sufficient confidence to submit to \acro{CTAN} is Cross\TeX{}. -Cross\TeX{}'s language feels familiar to the existing user of -\BibTeX{}, but it's redesigned in an object-oriented style, and looks -(to a non-user) as if it may well be adequately flexible. - -Cross\TeX{}'s team respond to queries, and seem well aware of the -need for multilingual support. Cross\TeX{} is probably a development -to watch. - -Two interesting alternative approaches, that the author has -investigated, are \Package{amsrefs} and \Package{biblatex}. -\Package{Amsrefs} does away with \BibTeX{} altogether, while -\Package{biblatex} makes rather limited use of \BibTeX{}. Both are -heavily dependent on \LaTeX{}'s support. - -\Package{Amsrefs} uses a transformed \extension{bib} file, which is -expressed as \LaTeX{} macros. (The package provides a \BibTeX{} style -that performs the transformation, so that a \LaTeX{} source containing -a \cmdinvoke{nocite}{*} command enables \BibTeX{} to produce a usable -\Package{amsrefs} bibliography database.) - -\Package{Amsrefs} is maintained by the AMS as part of its author -support programme, - -\Package{Biblatex} uses \BibTeX{} simply to sort the citations using -\Package{biblatex}'s own style; the style of citations and of the -bibliography itself is determined by the way your \Package{biblatex} -style has been set up. This structure eliminates the collections of -\BibTeX{} styles, at a stroke; the package comes with a basic set of -styles, and details are determined by options, set at package loading -time. The author, Philipp Lehman, evaluated the whole field of -bibliography software before starting, and as a result the package -comes with answers to many of the questions asked in the bibliography -sections of these \acro{FAQ}s. - -\Package{Biblatex} is released as experimental software, but it's -clear that many users are already using it happily; Lehman is -responsive to problem reports, at the moment, but a set of expert -users is already establishing itself. A set of contributed styles has -appeared, which cover some of the trickier bibliography styles. The -road map of the project shows one more \emph{beta} release before the -``stable'' \Package{biblatex}~1.0. - -A related project is -\href{http://biblatex-biber.sourceforge.net/}{\ProgName{biber}} (or -\ProgName{biblatex-biber}, to distinguish it from an older, defunct, -\BibTeX{} replacement project). \ProgName{Biber} is a -\ProgName{Perl}-based system to produce a \BibTeX{} replacement that -is specifically tuned to the requirements of \Package{biblatex}. -While it supports `traditional' \BibTeX{}, \ProgName{biber} aims at an -interface language that is closely tuned to the requirements of -\Package{biblatex}, including use of a Unicode-based character set to -ease the generation multilingual citations. -\begin{ctanrefs} -\item[amsrefs.sty]\CTANref{amsrefs} -\item[biblatex.sty]\CTANref{biblatex} -\item[\nothtml{\rmfamily}biblatex contributions]\CTANref{biblatex-contrib} -\item[\nothtml{\rmfamily}CrossTeX]\CTANref{crosstex} -\end{ctanrefs} - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% -% This is the last section, and is to remain the last section... -\section{You're still stuck?} - -\Question[Q-noans]{You don't understand the answer} - -While the \acro{FAQ} maintainers don't offer a `help' service, they're -very keen that you understand the answers they've already written. -They're (almost) written ``in a vacuum'', to provide something to -cover a set of questions that have arisen; it's always possible that -they're written in a way that a novice won't understand them. - -Which is where you can help the community. Mail the -\begin{wideversion} - \href{mailto:faq-devel@tex.ac.uk}{maintainers} -\end{wideversion} -\begin{narrowversion} - maintainers (at \Email{faq-devel@tex.ac.uk}) -\end{narrowversion} -to report the answer that you find unclear, and (if you can) suggest -what we need to clarify. Time permitting (the team is small and all -its members are busy), we'll try and clarify the answer. This way, -with a bit of luck, we can together improve the value of this resource -to the whole community. - -Note that the \acro{FAQ} development email address is not for -answering questions: it's for you to suggest which questions we should -work on, or new questions we should answer in future editions. - -Those who simply ask questions at that address will be referred to -\mailto{texhax@tug.org} or to \Newsgroup{comp.text.tex}. - -\Question[Q-newans]{Submitting new material for the \acro{FAQ}} - -The \acro{FAQ} will never be complete, and we always expect that -there will be people out there who know better than we do about -something or other. We always need to be put right about whatever -we've got wrong, and suggestions for improvements, particularly -covering areas we've missed, are always needed: mail anything you have -to the -\begin{wideversion} - \href{mailto:faq-devel@tex.ac.uk}{maintainers} -\end{wideversion} -\begin{narrowversion} - maintainers (at \Email{faq-devel@tex.ac.uk}) -\end{narrowversion} - -If you have actual material to submit, your contribution is more than -ever welcome. Submission in plain text is entirely acceptable, but -if you're really willing, you may feel free to mark up your submission -in the form needed for the \acro{FAQ} itself. The markup is a -strongly-constrained version of \LaTeX{}~--- the constraints come from -the need to translate the marked-up text to \acro{HTML} on the fly -(and hence pretty efficiently). There is a file \File{markup-syntax} -in the \acro{FAQ} distribution that describes the structure of the -markup, but there's no real substitute for reading at least some of -the source (\File{faqbody.tex}) of the \acro{FAQ} itself. If you -understand \ProgName{Perl}, you may also care to look at the -translation code in \File{texfaq2file} and \File{sanitize.pl} in the -distribution: this isn't the code actually used on the Web site, but -it's a close relation and is kept -up to date for development purposes. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}\acro{FAQ} distribution]\CTANref{faq} -\end{ctanrefs} - -\Question[Q-latexbug]{Reporting a \LaTeX{} bug} - -The \LaTeX{} team supports \LaTeX{}, and will deal with -% beware line wrap -\emph{bona fide} bug reports. Note that the \LaTeX{} team does -\emph{not} deal with contributed packages~--- just the software that -is part of the \LaTeX{} distribution itself: \LaTeX{} and the -``required'' packages. -Furthermore, you need to be slightly -careful to produce a bug report that is usable by the team. The steps -are: - -\nothtml{\noindent}\textbf{1.} Are you still using current \LaTeX{}? Maintenance is only -available for sufficiently up-to-date versions of \LaTeX{}~--- if your -\LaTeX{} is more than two versions out of date, the bug reporting -mechanisms may reject your report. - -\nothtml{\noindent}\textbf{2.} Has your bug already been reported? Browse the -% beware line break -\href{http://www.latex-project.org/cgi-bin/ltxbugs2html?introduction=yes}{\LaTeX{} bugs database}, -to find any earlier instance of your bug. In many cases, the database -will list a work-around. - -\nothtml{\noindent}\textbf{3.} Prepare a % ! line break -\Qref*{``minimum'' file}{Q-minxampl} that exhibits the problem. -Ideally, such a file should contain no contributed packages~--- the -\LaTeX{} team as a whole takes no responsibility for such packages (if -they're supported at all, they're supported by their authors). The -``minimum'' file should be self-sufficient: if a member of the team -should run it in a clean directory, on a system with no contributed -packages, it should replicate your problem. - -\nothtml{\noindent}\textbf{4.} Run your file through \LaTeX{}: the bug -system needs the \extension{log} file that this process creates. - -You now have two possible ways to proceed: either create a mail report -to send to the bug processing mechanism (5, below), or submit your bug -report via the web (7, below). - -\nothtml{\noindent}\textbf{5.} Process the bug-report creation file, using \LaTeX{} itself: -\begin{verbatim} - latex latexbug -\end{verbatim} -\File{latexbug} asks you some questions, and then lets you describe -the bug you've found. It produces an output file \File{latexbug.msg}, -which includes the details you've supplied, your ``minimum'' example -file, and the log file you got after running the example. (I always -need to edit the result before submitting it: typing text into -\File{latexbug} isn't much fun.) - -\nothtml{\noindent}\textbf{6.} Mail the resulting file to -\Email{latex-bugs@latex-project.org}; the subject line of your email -should be the same as the bug title you gave to \File{latexbug}. The -file \File{latexbug.msg} should be included into your message in-line: -attachments are likely to be rejected by the bug processor. - -\nothtml{\noindent}\textbf{7.} Connect to the -% beware line break -\href{http://www.latex-project.org/bugs-upload.html}{latex bugs processing web page} -and enter details of your bug~--- category, summary and full -description, and the two important files (source and log file); note -that members of the \LaTeX{} team \emph{need} your name and email address, as -they may need to discuss the bug with you, or to advise you of a -work-around. - -\htmlignore -\par -\endhtmlignore -\Question[Q-bug]{What to do if you find a bug} -\htmlignore -\par -\endhtmlignore -% -% This here isn't a reference to a question... -\label{lastquestion} - -For a start, make entirely sure you \emph{have} found a bug. -Double-check with books about \TeX{}, \LaTeX{}, or whatever you're using; -compare what you're seeing against the other answers above; ask every -possible person you know who has any \TeX{}-related expertise. -The reasons for all this caution are various. - -If you've found a bug in \TeX{} itself, you're a rare animal indeed. -Don Knuth is so sure of the quality of his code that he offers real -money prizes to finders of bugs; the cheques he writes are -such rare items that they are seldom cashed. If \emph{you} -think you have found a genuine fault in \TeX{} itself (or \MF{}, or the -\acro{CM} fonts, or the \TeX{}book), don't immediately write to Knuth, -however. He only looks at bugs infrequently, and even then -only after they are agreed as bugs by a small vetting team. In the -first instance, contact Barbara Beeton at the \acro{AMS} -(\Email{bnb@ams.org}), or contact -\Qref*{\acro{TUG}}{Q-TUG*}. - -If you've found a bug in \LaTeXe{}, \Qref*{report it}{Q-latexbug} -using mechanisms supplied by the \LaTeX{} team. (Please be -careful to ensure you've got a \LaTeX{} bug, or a bug in one of the -``required'' packages distributed by the \LaTeX{} team.) - -If you've found a bug in a contributed \LaTeX{} package, you could try -contacting the author (if you can find a contact address). However, -it's generally best to treat any package as unsupported, in the first -instance, and only try the author \emph{after} mailing list/news group -support has failed you. - -If you've found a bug in \LaTeXo{}, or some other such unsupported -software, you may find help or -\emph{de facto} support on a newsgroup such as -\Newsgroup{comp.tex.tex} or on a mailing list such as -\mailto{texhax@tug.org}; be careful to include a % ! line wrap -\Qref*{code example}{Q-minxampl} of the -failure, if relevant. - -Failing all else, you may need to pay for -help~--- \acro{TUG} maintains a % ! line break -\href{http://www.tug.org/consultants.html}{register of \TeX{} consultants}. - - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: t -%%% End: diff --git a/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex b/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex index 6f11a17116a..a339a8809cb 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex @@ -1,3 +1,4 @@ +% $Id: filectan.tex,v 1.114 2009/08/02 22:50:13 rf10 Exp rf10 $ % % protect ourself against being read twice \csname readCTANfiles\endcsname @@ -6,7 +7,7 @@ % interesting/useful individual files to be found on CTAN \CTANfile{CTAN-sites}{CTAN.sites} \CTANfile{CTAN-uploads}{README.uploads}% yes, it really is in the root -\CTANfile{Excalibur}{systems/mac/support/excalibur/Excalibur-4.0.2.sit.hqx} +\CTANfile{Excalibur}{systems/mac/support/excalibur/Excalibur-4.0.2.sit.hqx}[excalibur] \CTANfile{f-byname}{FILES.byname} \CTANfile{f-last7}{FILES.last07days} \CTANfile{LitProg-FAQ}{help/comp.programming.literate_FAQ} @@ -14,133 +15,131 @@ \CTANfile{T1instguide}{info/Type1fonts/fontinstallationguide/fontinstallationguide.pdf} \CTANfile{TeX-FAQ}{obsolete/help/TeX,_LaTeX,_etc.:_Frequently_Asked_Questions_with_Answers} \CTANfile{abstract-bst}{biblio/bibtex/utils/bibtools/abstract.bst} -\CTANfile{anonchap}{macros/latex/contrib/misc/anonchap.sty} -\CTANfile{backgrnd}{macros/generic/misc/backgrnd.tex} -\CTANfile{bbl2html}{biblio/bibtex/utils/misc/bbl2html.awk} -\CTANfile{beginlatex-pdf}{info/beginlatex/beginlatex-3.6.pdf} -\CTANfile{belleek}{fonts/belleek/belleek.zip} +\CTANfile{anonchap}{macros/latex/contrib/misc/anonchap.sty}[anonchap] +\CTANfile{backgrnd}{macros/generic/misc/backgrnd.tex}[backgrnd] +\CTANfile{bbl2html}{biblio/bibtex/utils/misc/bbl2html.awk}[bbl2html] +\CTANfile{beginlatex-pdf}{info/beginlatex/beginlatex-3.6.pdf}[beginlatex] +\CTANfile{belleek}{fonts/belleek/belleek.zip}[belleek] \CTANfile{bibtex-faq}{biblio/bibtex/contrib/doc/btxFAQ.pdf} -\CTANfile{bidstobibtex}{biblio/bibtex/utils/bids/bids.to.bibtex} +\CTANfile{bidstobibtex}{biblio/bibtex/utils/bids/bids.to.bibtex}[bidstobibtex] \CTANfile{bold-extra}{macros/latex/contrib/misc/bold-extra.sty} -\CTANfile{braket}{macros/latex/contrib/misc/braket.sty} -\CTANfile{btxmactex}{macros/eplain/tex/eplain/btxmac.tex} -\CTANfile{cancel}{macros/latex/contrib/misc/cancel.sty} -\CTANfile{capt-of}{macros/latex/contrib/misc/capt-of.sty} +\CTANfile{braket}{macros/latex/contrib/misc/braket.sty}[braket] +\CTANfile{btxmactex}{macros/eplain/tex/eplain/btxmac.tex}[eplain] +\CTANfile{cancel}{macros/latex/contrib/misc/cancel.sty}[cancel] +\CTANfile{capt-of}{macros/latex/contrib/misc/capt-of.sty}[capt-of] \CTANfile{catalogue}{help/Catalogue/catalogue.html} \CTANfile{cat-licences}{help/Catalogue/licenses.html} \CTANfile{chngcntr}{macros/latex/contrib/misc/chngcntr.sty} -\CTANfile{changepage}{macros/latex/contrib/misc/changepage.sty} -\CTANfile{clsguide}{macros/latex/doc/clsguide.pdf} -\CTANfile{compactbib}{macros/latex/contrib/compactbib/compactbib.sty} +\CTANfile{changepage}{macros/latex/contrib/misc/changepage.sty}[changepage] +\CTANfile{clsguide}{macros/latex/doc/clsguide.pdf}[clsguide] +\CTANfile{compactbib}{macros/latex/contrib/compactbib/compactbib.sty}[compactbib] %\CTANfile{compan-ctan}{info/companion.ctan} -\CTANfile{context-tmf}{macros/context/current/cont-tmf.zip} -\CTANfile{dblfloatfix}{macros/latex/contrib/misc/dblfloatfix.sty} -\CTANfile{dvitype}{systems/knuth/dist/texware/dvitype.web} -\CTANfile{edmetrics}{systems/mac/textures/utilities/EdMetrics.sea.hqx} -\CTANfile{epsf}{macros/generic/epsf/epsf.tex} -\CTANfile{epslatex_pdf}{info/epslatex/english/epslatex.pdf} +\CTANfile{context-tmf}{macros/context/current/cont-tmf.zip}[context] +\CTANfile{dblfloatfix}{macros/latex/contrib/misc/dblfloatfix.sty}[dblfloatfix] +\CTANfile{dvitype}{systems/knuth/dist/texware/dvitype.web}[dvitype] +\CTANfile{edmetrics}{systems/mac/textures/utilities/EdMetrics.sea.hqx}[edmetrics] +\CTANfile{epsf}{macros/generic/epsf/epsf.tex}[epsf] +\CTANfile{epslatex_pdf}{info/epslatex/english/epslatex.pdf}[epslatex] \CTANfile{epslatex_ps}{info/epslatex/english/epslatex.ps} -\CTANfile{eucal}{fonts/amsfonts/latex/eucal.sty} -\CTANfile{excludeonly}{macros/latex/contrib/misc/excludeonly.sty} +\CTANfile{excludeonly}{macros/latex/contrib/misc/excludeonly.sty}[excludeonly] \CTANfile{figsinlatex}{obsolete/info/figsinltx.ps} \CTANfile{finplain}{biblio/bibtex/contrib/misc/finplain.bst} -\CTANfile{fix-cm}{macros/latex/unpacked/fix-cm.sty} +\CTANfile{fix-cm}{macros/latex/unpacked/fix-cm.sty}[fix-cm] \CTANfile{fncylab}{macros/latex/contrib/misc/fncylab.sty} -\CTANfile{fntguide.pdf}{macros/latex/doc/fntguide.pdf} +\CTANfile{fntguide.pdf}{macros/latex/doc/fntguide.pdf}[fntguide] \CTANfile{fontdef}{macros/latex/base/fontdef.dtx} \CTANfile{fontmath}{macros/latex/unpacked/fontmath.ltx} -\CTANfile{framed}{macros/latex/contrib/misc/framed.sty} -\CTANfile{gentle}{info/gentle/gentle.pdf} -\CTANfile{gkpmac}{systems/knuth/local/lib/gkpmac.tex} -\CTANfile{hypernat}{macros/latex/contrib/misc/hypernat.sty} -\CTANfile{ifmtarg}{macros/latex/contrib/misc/ifmtarg.sty} -\CTANfile{import}{macros/latex/contrib/misc/import.sty} -\CTANfile{ispell}{support/ispell/ispell-3.2.06.tar.gz} -\CTANfile{l2tabuen}{info/l2tabu/english/l2tabuen.pdf} -\CTANfile{l2tabuen.src}{info/l2tabu/english/l2tabuen.tex} -\CTANfile{latex209-base}{obsolete/macros/latex209/distribs/latex209.tar.gz} +\CTANfile{framed}{macros/latex/contrib/misc/framed.sty}[framed] +\CTANfile{gentle}{info/gentle/gentle.pdf}[gentle] +\CTANfile{gkpmac}{systems/knuth/local/lib/gkpmac.tex}[gkpmac] +\CTANfile{hypernat}{macros/latex/contrib/misc/hypernat.sty}[hypernat] +\CTANfile{ifmtarg}{macros/latex/contrib/misc/ifmtarg.sty}[ifmtarg] +\CTANfile{import}{macros/latex/contrib/misc/import.sty}[import] +\CTANfile{ispell}{support/ispell/ispell-3.2.06.tar.gz}[ispell] +\CTANfile{l2tabuen}{info/l2tabu/english/l2tabuen.pdf}[l2tabu-english] +\CTANfile{l2tabuen.src}{info/l2tabu/english/l2tabuen.tex}[l2tabu-english] +\CTANfile{latex209-base}{obsolete/macros/latex209/distribs/latex209.tar.gz}[latex209] \CTANfile{latex-classes}{macros/latex/base/classes.dtx} \CTANfile{latex-source}{macros/latex/base/source2e.tex} -\CTANfile{latexcount}{support/latexcount/latexcount.pl} -\CTANfile{latexcheat}{info/latexcheat/latexcheat/latexsheet.pdf} -\CTANfile{letterspacing}{macros/generic/misc/letterspacing.tex} -\CTANfile{lshort}{info/lshort/english/lshort.pdf} -\CTANfile{ltablex}{macros/latex/contrib/ltablex/ltablex.sty} +\CTANfile{latexcount}{support/latexcount/latexcount.pl}[latexcount] +\CTANfile{latexcheat}{info/latexcheat/latexcheat/latexsheet.pdf}[latexcheat] +\CTANfile{letterspacing}{macros/generic/misc/letterspacing.tex}[letterspacing] +\CTANfile{ltablex}{macros/latex/contrib/ltablex/ltablex.sty}[ltablex] \CTANfile{ltxguide}{macros/latex/base/ltxguide.cls} -\CTANfile{ltxtable}{macros/latex/contrib/carlisle/ltxtable.tex} -\CTANfile{lw35nfss-zip}{macros/latex/required/psnfss/lw35nfss.zip} +\CTANfile{ltxtable}{macros/latex/contrib/carlisle/ltxtable.tex}[ltxtable] +\CTANfile{lw35nfss-zip}{macros/latex/required/psnfss/lw35nfss.zip}[lw35nfss] \CTANfile{macmakeindex}{systems/mac/macmakeindex2.12.sea.hqx} \CTANfile{mathscript}{info/symbols/math/scriptfonts.pdf} \CTANfile{mathsurvey.html}{info/Free_Math_Font_Survey/en/survey.html} \CTANfile{mathsurvey.pdf}{info/Free_Math_Font_Survey/en/survey.pdf} \CTANfile{metafp-pdf}{info/metafont/metafp/metafp.pdf} -\CTANfile{mf-beginners}{info/metafont/beginners/metafont-for-beginners.pdf} +\CTANfile{mf-beginners}{info/metafont/beginners/metafont-for-beginners.pdf}[metafont-beginners] \CTANfile{mf-list}{info/metafont-list} \CTANfile{miktex-portable}{systems/win32/miktex/setup/miktex-portable.exe} -\CTANfile{miktex-setup}{systems/win32/miktex/setup/setup.exe} +\CTANfile{miktex-setup}{systems/win32/miktex/setup/setup.exe}[miktex] \CTANfile{miktex-usb}{info/MiKTeX+Ghostscript+GSview+USB-drive-HOWTO.txt} \CTANfile{mil}{info/mil/mil.pdf} -\CTANfile{mil-short}{info/Math_into_LaTeX-4/Short_Course.pdf} -\CTANfile{modes-file}{fonts/modes/modes.mf} -\CTANfile{morefloats}{macros/latex/contrib/misc/morefloats.sty} -\CTANfile{mpsproof}{graphics/metapost/contrib/misc/mpsproof.tex} +\CTANfile{mil-short}{info/Math_into_LaTeX-4/Short_Course.pdf}[math-into-latex-4] +\CTANfile{modes-file}{fonts/modes/modes.mf}[modes] +\CTANfile{morefloats}{macros/latex/contrib/misc/morefloats.sty}[morefloats] +\CTANfile{mpsproof}{graphics/metapost/contrib/misc/mpsproof.tex}[mpsproof] \CTANfile{mtw}{info/makingtexwork/mtw-1.0.1-html.tar.gz} -\CTANfile{multind}{macros/latex209/contrib/misc/multind.sty} +\CTANfile{multind}{macros/latex209/contrib/misc/multind.sty}[multind] \CTANfile{musixtex-type1}{fonts/musixtex/ps-type1/musixps-unix.tar.gz} -\CTANfile{needspace}{macros/latex/contrib/misc/needspace.sty} -\CTANfile{nextpage}{macros/latex/contrib/misc/nextpage.sty} -\CTANfile{notoccite}{macros/latex/contrib/misc/notoccite.sty} -\CTANfile{noTeX}{biblio/bibtex/utils/misc/noTeX.bst} -\CTANfile{nopageno}{macros/latex/contrib/carlisle/nopageno.sty} -\CTANfile{numline}{obsolete/macros/latex/contrib/numline/numline.sty} -\CTANfile{optional}{macros/latex/contrib/misc/optional.sty} -\CTANfile{parskip}{macros/latex/contrib/misc/parskip.sty} -\CTANfile{patch}{macros/generic/misc/patch.doc} -\CTANfile{path}{macros/latex/contrib/misc/path.sty} +\CTANfile{needspace}{macros/latex/contrib/misc/needspace.sty}[needspace] +\CTANfile{nextpage}{macros/latex/contrib/misc/nextpage.sty}[nextpage] +\CTANfile{notoccite}{macros/latex/contrib/misc/notoccite.sty}[notoccite] +\CTANfile{noTeX}{biblio/bibtex/utils/misc/noTeX.bst}[notex] +\CTANfile{nopageno}{macros/latex/contrib/carlisle/nopageno.sty}[nopageno] +\CTANfile{numline}{obsolete/macros/latex/contrib/numline/numline.sty}[numline] +\CTANfile{optional}{macros/latex/contrib/misc/optional.sty}[optional] +\CTANfile{parskip}{macros/latex/contrib/misc/parskip.sty}[parskip] +\CTANfile{patch}{macros/generic/misc/patch.doc}[patch] +\CTANfile{path}{macros/latex/contrib/misc/path.sty}[path] \CTANfile{pdftex-oztex}{nonfree/systems/mac/pdftex/pdftex_for_oztex.sit.bin} \CTANfile{picins-summary}{macros/latex209/contrib/picins/picins.txt} \CTANfile{pk300}{fonts/cm/pk/pk300.zip} \CTANfile{pk300w}{fonts/cm/pk/pk300w.zip} -\CTANfile{printlen}{macros/latex/contrib/misc/printlen.sty} -\CTANfile{removefr}{macros/latex/contrib/fragments/removefr.tex} +\CTANfile{printlen}{macros/latex/contrib/misc/printlen.sty}[printlen] +\CTANfile{removefr}{macros/latex/contrib/fragments/removefr.tex}[removefr] \CTANfile{resume}{obsolete/macros/latex209/contrib/resume/resume.sty} -\CTANfile{savesym}{macros/latex/contrib/savesym/savesym.sty} -\CTANfile{screensty}{macros/latex209/contrib/misc/screen.sty} -\CTANfile{selectp}{macros/latex/contrib/misc/selectp.sty} -\CTANfile{setspace}{macros/latex/contrib/setspace/setspace.sty} -\CTANfile{simpl-latex}{info/simplified-latex/simplified-intro.ps} -\CTANfile{sober}{macros/latex209/contrib/misc/sober.sty} -\CTANfile{tabls}{macros/latex/contrib/misc/tabls.sty} -\CTANfile{tex2bib}{biblio/bibtex/utils/tex2bib/tex2bib} +\CTANfile{savesym}{macros/latex/contrib/savesym/savesym.sty}[savesym] +\CTANfile{screensty}{macros/latex209/contrib/misc/screen.sty}[screen] +\CTANfile{selectp}{macros/latex/contrib/misc/selectp.sty}[selectp] +\CTANfile{setspace}{macros/latex/contrib/setspace/setspace.sty}[setspace] +\CTANfile{simpl-latex}{info/simplified-latex/simplified-intro.ps}[simplified-latex] +\CTANfile{sober}{macros/latex209/contrib/misc/sober.sty}[sober] +\CTANfile{tabls}{macros/latex/contrib/misc/tabls.sty}[tabls] +\CTANfile{tex2bib}{biblio/bibtex/utils/tex2bib/tex2bib}[tex2bib] \CTANfile{tex2bib-doc}{biblio/bibtex/utils/tex2bib/README} -\CTANfile{tex4ht}{support/TeX4ht/tex4ht-all.zip} +\CTANfile{tex4ht}{support/TeX4ht/tex4ht-all.zip}[tex4ht] \CTANfile{texlive-unix}{systems/texlive/tlnet/2008/install-tl-unx.tar.gz} \CTANfile{texlive-windows}{systems/texlive/tlnet/2008/install-tl.zip} \CTANfile{texnames}{info/biblio/texnames.sty} \CTANfile{texsis-index}{macros/texsis/index/index.tex} -\CTANfile{threeparttable}{macros/latex/contrib/misc/threeparttable.sty} -\CTANfile{titleref}{macros/latex/contrib/misc/titleref.sty} -\CTANfile{topcapt}{macros/latex/contrib/misc/topcapt.sty} -\CTANfile{tracking}{macros/latex/contrib/tracking/tracking.sty} -\CTANfile{ttb-pdf}{info/bibtex/tamethebeast/ttb_en.pdf} -\CTANfile{type1ec}{fonts/ps-type1/cm-super/type1ec.sty} +\CTANfile{threeparttable}{macros/latex/contrib/misc/threeparttable.sty}[threeparttable] +\CTANfile{titleref}{macros/latex/contrib/misc/titleref.sty}[titleref] +\CTANfile{topcapt}{macros/latex/contrib/misc/topcapt.sty}[topcapt] +\CTANfile{tracking}{macros/latex/contrib/tracking/tracking.sty}[tracking] +\CTANfile{ttb-pdf}{info/bibtex/tamethebeast/ttb_en.pdf}[tamethebeast] +\CTANfile{type1ec}{fonts/ps-type1/cm-super/type1ec.sty}[type1ec] \CTANfile{ukhyph}{language/hyphenation/ukhyphen.tex} -\CTANfile{upquote}{macros/latex/contrib/upquote/upquote.sty} +\CTANfile{upquote}{macros/latex/contrib/upquote/upquote.sty}[upquote] \CTANfile{faq-a4}{help/uk-tex-faq/newfaq.pdf} \CTANfile{faq-letter}{help/uk-tex-faq/letterfaq.pdf} -\CTANfile{ulem}{macros/latex/contrib/misc/ulem.sty} -\CTANfile{url}{macros/latex/contrib/misc/url.sty} -\CTANfile{underscore}{macros/latex/contrib/misc/underscore.sty} -\CTANfile{varwidth}{macros/latex/contrib/misc/varwidth.sty} -\CTANfile{verbdef}{macros/latex/contrib/misc/verbdef.sty} -\CTANfile{version}{macros/latex/contrib/misc/version.sty} -\CTANfile{versions}{macros/latex/contrib/versions/versions.sty} -\CTANfile{vertbars}{macros/latex/contrib/misc/vertbars.sty} +\CTANfile{ulem}{macros/latex/contrib/misc/ulem.sty}[ulem] +\CTANfile{url}{macros/latex/contrib/misc/url.sty}[url] +\CTANfile{underscore}{macros/latex/contrib/misc/underscore.sty}[underscore] +\CTANfile{varwidth}{macros/latex/contrib/misc/varwidth.sty}[varwidth] +\CTANfile{verbdef}{macros/latex/contrib/misc/verbdef.sty}[verbdef] +\CTANfile{version}{macros/latex/contrib/misc/version.sty}[version] +\CTANfile{versions}{macros/latex/contrib/versions/versions.sty}[versions] +\CTANfile{vertbars}{macros/latex/contrib/misc/vertbars.sty}[vertbars] \CTANfile{vf-howto}{info/virtualfontshowto/virtualfontshowto.txt} -\CTANfile{vf-knuth}{info/knuth/virtual-fonts} -\CTANfile{visualFAQ}{info/visualFAQ/visualFAQ.pdf} +\CTANfile{vf-knuth}{info/knuth/virtual-fonts}[vf-knuth] +\CTANfile{visualFAQ}{info/visualFAQ/visualFAQ.pdf}[visualfaq] \CTANfile{voss-mathmode}{info/math/voss/mathmode/Mathmode.pdf} -\CTANfile{vruler}{macros/latex/contrib/misc/vruler.sty} +\CTANfile{vruler}{macros/latex/contrib/misc/vruler.sty}[vruler] \CTANfile{wujastyk-txh}{digests/texhax/txh/wujastyk.txh} \CTANfile{xampl-bib}{biblio/bibtex/distribs/doc/xampl.bib} \CTANfile{xtexcad}{nonfree/graphics/xtexcad/xtexcad-2.4.1.tar.gz} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/gather-faqbody.tex b/Master/texmf-dist/doc/generic/FAQ-en/gather-faqbody.tex new file mode 100644 index 00000000000..46885e0e470 --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/gather-faqbody.tex @@ -0,0 +1,52 @@ +\def\faqfileversion{3.19a} \def\faqfiledate{2009-06-13} +% +% The above line defines the file version and date, and must remain +% the first line with any `assignment' in the file, or things will +% blow up in a stupid fashion +% +% get lists of CTAN labels +% +% configuration for the lists, if we're going to need to generate urls +% for the files +\InputIfFileExists{archive.cfg}{}{} +% +% ... directories +\input{dirctan} +% +% ... files +\input{filectan} + +% facilitate auto-processing of this stuff +\let\faqinput\input + +% the stuff to print +\faqinput{faq-intro} % introduction +\faqinput{faq-backgrnd} % background +\faqinput{faq-docs} % docs +\faqinput{faq-bits+pieces} % bits and pieces +\faqinput{faq-getit} % getting software +\faqinput{faq-texsys} % TeX systems +\faqinput{faq-dvi} % DVI drivers and previewers +\faqinput{faq-support} % support stuff +\faqinput{faq-litprog} % programming for literates +\faqinput{faq-fmt-conv} % format conversions +\faqinput{faq-install} % installation and so on +\faqinput{faq-fonts} % fonts and what to do +\faqinput{faq-hyp+pdf} % hyper-foodle and pdf +\faqinput{faq-graphics} % graphics +\faqinput{faq-biblio} % bib stuff +\faqinput{faq-adj-types} % adjusting typesetting +\faqinput{faq-lab-ref} % labels and references +\faqinput{faq-how-do-i} % how to do things +\faqinput{faq-symbols} % symbols, their natural history and use +\faqinput{faq-mac-prog} % macro programming +\faqinput{faq-t-g-wr} % things going wrong +\faqinput{faq-wdidt} % why does it do that +%*****************************************quote environments up to here +\faqinput{faq-jot-err} % joy (hem hem) of tex errors +\faqinput{faq-projects} % current projects + +% +% This is the last section, and is to remain the last section... +\faqinput{faq-the-end} % wrapping it all up + diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfloat.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfloat.html index 209b9b679f0..319fa4e9f9b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfloat.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfloat.html @@ -3,7 +3,7 @@ </head><body> <h3>Placing two-column floats at bottom of page</h3> <p/>You specified placement ‘<code>[htbp]</code>’ for your full-width figure or -table, but they always get placed at the top of the page... Well, +table, but they always get placed at the top of the page… Well, it <em>is</em> what the documentation says: LaTeX, unadorned, only allows full-width floats at the top of a page, or occupying (part of) a float page. @@ -26,9 +26,9 @@ LaTeX honour ‘[h]’ placement of double-column floats, but the <i>midfloat</i> package can be pressed into service to provide something approximating the effect it would have.) <dl> -<dt><tt><i>dblfloatfix.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/dblfloatfix.sty">macros/latex/contrib/misc/dblfloatfix.sty</a> +<dt><tt><i>dblfloatfix.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/dblfloatfix.sty">macros/latex/contrib/misc/dblfloatfix.sty</a> <dt><tt><i>stfloats.sty, midfloat.sty</i></tt><dd>Distributed as part of - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sttools.zip">macros/latex/contrib/sttools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sttools/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sttools.zip">macros/latex/contrib/sttools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sttools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfltorder.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfltorder.html index 9e5a041b7cb..2e26817db6b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfltorder.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2colfltorder.html @@ -24,8 +24,8 @@ at <a href="FAQ-2colfloat.html"><code>[b]</code> placement</a>. whole requirement is to patch the output routine; no extra commands are needed. <dl> -<dt><tt><i>dblfloatfix.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/dblfloatfix.sty">macros/latex/contrib/misc/dblfloatfix.sty</a> -<dt><tt><i>fix2col.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) +<dt><tt><i>dblfloatfix.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/dblfloatfix.sty">macros/latex/contrib/misc/dblfloatfix.sty</a> +<dt><tt><i>fix2col.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) <dt><tt><i>fixltx2e.sty</i></tt><dd>Part of the LaTeX distribution </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfltorder">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfltorder</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2letterfontcmd.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2letterfontcmd.html index 94904a00111..c84861521e0 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2letterfontcmd.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-2letterfontcmd.html @@ -7,7 +7,7 @@ commands, so you used them as: <blockquote> <pre> -{\bf Fred} was {\it here\/}. +{\bf Fred} was {\it here\/}}. </pre> </blockquote><p> with the font change enclosed in a group, so as to limit its effect; @@ -118,7 +118,7 @@ needs LaTeX’s simplest font selection commands: </pre> </blockquote><p> <dl> -<dt><tt><i>smallcap.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/smallcap.zip">macros/latex/contrib/smallcap</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/smallcap/">browse the directory</a>) +<dt><tt><i>smallcap.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/smallcap.zip">macros/latex/contrib/smallcap</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/smallcap/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2letterfontcmd">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2letterfontcmd</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-AMSpkg.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-AMSpkg.html index b1b38a44dcf..2f1467c4829 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-AMSpkg.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-AMSpkg.html @@ -20,8 +20,8 @@ the functionality of AMSTeX. The AMS no longer recommends the use of AMSTeX, and urges its authors to use AMSLaTeX instead. <dl> -<dt><tt><i>AMSTeX distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/amstex.zip">macros/amstex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/amstex/">browse the directory</a>) -<dt><tt><i>AMSLaTeX distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>AMSTeX distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/amstex.zip">macros/amstex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/amstex/">browse the directory</a>) +<dt><tt><i>AMSLaTeX distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=AMSpkg">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=AMSpkg</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-BibTeXing.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-BibTeXing.html index 0b8334cd9e5..c5029e60f5b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-BibTeXing.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-BibTeXing.html @@ -23,9 +23,9 @@ may also be found on CTAN. A summary and FAQ (<i>btxFAQ</i>), by Michael Shell and David Hoadley, is also to be recommended. <dl> -<dt><tt><i>BibTeX documentation</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/doc.zip">biblio/bibtex/contrib/doc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/doc/">browse the directory</a>) -<dt><tt><i>btxFAQ.pdf</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/contrib/doc/btxFAQ.pdf">biblio/bibtex/contrib/doc/btxFAQ.pdf</a> -<dt><tt><i>Tame the BeaST</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/bibtex/tamethebeast/ttb_en.pdf">info/bibtex/tamethebeast/ttb_en.pdf</a> +<dt><tt><i>BibTeX documentation</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/doc.zip">biblio/bibtex/contrib/doc</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/doc/">browse the directory</a>) +<dt><tt><i>btxFAQ.pdf</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/doc/btxFAQ.pdf">biblio/bibtex/contrib/doc/btxFAQ.pdf</a> +<dt><tt><i>Tame the BeaST</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/bibtex/tamethebeast/ttb_en.pdf">info/bibtex/tamethebeast/ttb_en.pdf</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=BibTeXing">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=BibTeXing</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-CD.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-CD.html index 988565eef92..42f4b0a63f8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-CD.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-CD.html @@ -36,9 +36,9 @@ they are all pretty large downloads. on the TUG site. <dl> -<dt><tt><i>MacTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/mac/mactex/">systems/mac/mactex/</a> -<dt><tt><i>ProTeXt</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/protext/">systems/win32/protext/</a> -<dt><tt><i>TeXlive install image</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/texlive/">systems/texlive/</a> +<dt><tt><i>MacTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/mactex/">systems/mac/mactex/</a> +<dt><tt><i>ProTeXt</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/win32/protext/">systems/win32/protext/</a> +<dt><tt><i>TeXlive install image</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/texlive/">systems/texlive/</a> </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=CD">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=CD</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ECfonts.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ECfonts.html index dc33c6e4351..e387e92d25a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ECfonts.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ECfonts.html @@ -33,14 +33,13 @@ are stable: their metrics are unlikely ever to change). Their serious disadvantages for the casual user are their size (each EC font is roughly twice the size of the corresponding CM font), and there are far more of them than there are CM fonts. The simple -number of fonts has acted as a disincentive to the production of Adobe -Type 1 versions of the fonts, but several commercial suppliers offer -EC or -EC-equivalent fonts in type 1 or TrueType form — see +number of fonts proved problematic in the production of Type 1 +versions of the fonts, but EC or EC-equivalent fonts in +Type 1 or TrueType form (the latter only from + <a href="FAQ-commercial.html">commercial suppliers</a>). -<a href="FAQ-commercial.html">commercial suppliers</a>. Free -<a href="FAQ-textrace.html">auto-traced versions</a> (the CM-super -and the LGC fonts), and the Latin Modern series (rather +Free <a href="FAQ-textrace.html">auto-traced versions</a> — the CM-super +and the LGC fonts, and the Latin Modern series (rather directly generated from Metafont sources), are available. <p/> @@ -48,7 +47,8 @@ directly generated from Metafont sources), are available. Note that the Cork encoding doesn’t cover mathematics (and neither do “T1-encoded” font families, of course). If you’re using Computer-Modern-alike fonts, this doesn’t actually matter: your system -will have the original Computer Modern fonts, which cover ‘basic’ +will have the original Computer Modern mathematical fonts (or the those +distributed with the Latin Modern set), which cover ‘basic’ TeX mathematics; more advanced mathematics are likely to need separate fonts anyway. Suitable mathematics fonts for use with other font families are discussed in @@ -65,10 +65,10 @@ for Adobe Type 1 fonts, and also by the <i>txfonts</i> and (see <a href="FAQ-psfchoice.html">“choice of scalable fonts”</a>). <dl> -<dt><tt><i>CM-super fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) -<dt><tt><i>CM-LGC fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-lgc.zip">fonts/ps-type1/cm-lgc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-lgc/">browse the directory</a>) -<dt><tt><i>EC and TC fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ec.zip">fonts/ec</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ec/">browse the directory</a>) -<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm/">browse the directory</a>) +<dt><tt><i>CM-super fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) +<dt><tt><i>CM-LGC fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-lgc.zip">fonts/ps-type1/cm-lgc</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-lgc/">browse the directory</a>) +<dt><tt><i>EC and TC fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ec.zip">fonts/ec</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ec/">browse the directory</a>) +<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/lm/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ECfonts">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ECfonts</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-HPdrivers.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-HPdrivers.html index 3df98306c6c..2ba04cf2681 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-HPdrivers.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-HPdrivers.html @@ -10,8 +10,8 @@ DEC-20s. <p/>For Unix systems, Karl Berry’s <i>dviljk</i> uses the same path-searching library as <i>web2c</i>. <dl> -<dt><tt><i>Beebe drivers</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/beebe.zip">dviware/beebe</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/beebe/">browse the directory</a>) -<dt><tt><i>dviljk</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dviljk.zip">dviware/dviljk</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dviljk/">browse the directory</a>) +<dt><tt><i>Beebe drivers</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/beebe.zip">dviware/beebe</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/beebe/">browse the directory</a>) +<dt><tt><i>dviljk</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dviljk.zip">dviware/dviljk</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dviljk/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=HPdrivers">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=HPdrivers</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX2HTML.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX2HTML.html index 151536cc4a7..10fc2d614f4 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX2HTML.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX2HTML.html @@ -74,10 +74,10 @@ page gives lists of pros and cons, by way of comparison. HTML, with sections on (La)TeX and BibTeX — see <a href="http://www.w3.org/Tools/Word_proc_filters.html">http://www.w3.org/Tools/Word_proc_filters.html</a> <dl> -<dt><tt><i>latex2html</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/latex2html/">support/latex2html/</a> -<dt><tt><i>plasTeX</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/plastex/">support/plastex/</a> -<dt><tt><i>tex4ht</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/TeX4ht/tex4ht-all.zip">support/TeX4ht/tex4ht-all.zip</a> -<dt><tt><i>tth</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tth/dist.zip">support/tth/dist</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tth/dist/">browse the directory</a>) +<dt><tt><i>latex2html</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/latex2html/">support/latex2html/</a> +<dt><tt><i>plasTeX</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/plastex/">support/plastex/</a> +<dt><tt><i>tex4ht</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/TeX4ht/tex4ht-all.zip">support/TeX4ht/tex4ht-all.zip</a> +<dt><tt><i>tth</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/tth/dist.zip">support/tth/dist</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/tth/dist/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=LaTeX2HTML">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=LaTeX2HTML</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX3.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX3.html index 2597c7adc45..2c15bac8e90 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX3.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeX3.html @@ -32,10 +32,10 @@ mailing list <code>latex-l</code>. Subscribe to the list by sending a message ‘<code>subscribe latex-l <<em>your name</em>></code>’ to <a href="mailto:listserv@urz.Uni-Heidelberg.de"><i>listserv@urz.Uni-Heidelberg.de</i></a> <dl> -<dt><tt><i>expl3 bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expl3.zip">macros/latex/contrib/expl3</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expl3/">browse the directory</a>) -<dt><tt><i>keys3.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/exptl/keys3.zip">macros/latex/exptl/keys3</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/exptl/keys3/">browse the directory</a>) -<dt><tt><i>LaTeX project publications</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/ltx3pub.zip">info/ltx3pub</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/ltx3pub/">browse the directory</a>) -<dt><tt><i>xpackages bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xpackages.zip">macros/latex/contrib/xpackages</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xpackages/">browse the directory</a>) +<dt><tt><i>expl3 bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expl3.zip">macros/latex/contrib/expl3</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expl3/">browse the directory</a>) +<dt><tt><i>keys3.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/exptl/keys3.zip">macros/latex/exptl/keys3</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/exptl/keys3/">browse the directory</a>) +<dt><tt><i>LaTeX project publications</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/ltx3pub.zip">info/ltx3pub</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/ltx3pub/">browse the directory</a>) +<dt><tt><i>xpackages bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xpackages.zip">macros/latex/contrib/xpackages</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xpackages/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=LaTeX3">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=LaTeX3</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeXtoPlain.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeXtoPlain.html index b62a3f12982..ac18ce88ac6 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeXtoPlain.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-LaTeXtoPlain.html @@ -21,9 +21,9 @@ user more than the “bare minimum” that Plain TeX is designed to offer.) <dl> <dt><tt><i>\latexhtml{\textrm{The}}{The} eplain system</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/eplain.zip">macros/eplain</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/eplain/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/eplain.zip">macros/eplain</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/eplain/">browse the directory</a>) <dt><tt><i>\latexhtml{\textrm{‘Plain TeX’}}{Plain TeX} graphics</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/graphics.zip">macros/plain/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/graphics/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/plain/graphics.zip">macros/plain/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/graphics/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=LaTeXtoPlain">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=LaTeXtoPlain</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-PSpreview.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-PSpreview.html index 2b2e0a382c1..a04b2b25ff3 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-PSpreview.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-PSpreview.html @@ -38,12 +38,12 @@ this, you have three options: this if you have purchased the fonts. </ul> <dl> -<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/">support/ghostscript/</a> -<dt><tt><i>gsftopk</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/gsftopk.zip">fonts/utilities/gsftopk</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/gsftopk/">browse the directory</a>) -<dt><tt><i>GSview</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/ghostgum/">support/ghostscript/ghostgum/</a> -<dt><tt><i>gv</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/gv/">support/gv/</a> -<dt><tt><i>ps2pk</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/ps2pk.zip">fonts/utilities/ps2pk</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/ps2pk/">browse the directory</a>) -<dt><tt><i>xdvi</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivedviware/xdvi/">dviware/xdvi/</a> +<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/">support/ghostscript/</a> +<dt><tt><i>gsftopk</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/gsftopk.zip">fonts/utilities/gsftopk</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/gsftopk/">browse the directory</a>) +<dt><tt><i>GSview</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/ghostgum/">support/ghostscript/ghostgum/</a> +<dt><tt><i>gv</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/gv/">support/gv/</a> +<dt><tt><i>ps2pk</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/ps2pk.zip">fonts/utilities/ps2pk</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/ps2pk/">browse the directory</a>) +<dt><tt><i>xdvi</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/xdvi/">dviware/xdvi/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=PSpreview">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=PSpreview</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-RCS.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-RCS.html index 81b1908c6af..96404c85be7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-RCS.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-RCS.html @@ -20,8 +20,8 @@ following minimal solution: <blockquote> <pre> \def\RCS$#1: #2 ${\expandafter\def\csname RCS#1\endcsname{#2}} -\RCS$Revision: 1.612 $ % or any RCS keyword -\RCS$Date: 2009/06/09 22:45:20 $ +\RCS$Revision: 1.3 $ % or any RCS keyword +\RCS$Date: 2009/10/06 22:23:45 $ ... \date{Revision \RCSRevision, \RCSDate} </pre> @@ -63,11 +63,11 @@ Plain TeX. Note that <i>vc</i> is the only option that currently claims to support <i>Bazaar</i>- and <i>Git</i>-controlled repositories. <dl> -<dt><tt><i>rcs.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rcs.zip">macros/latex/contrib/rcs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rcs/">browse the directory</a>) -<dt><tt><i>rcsinfo.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rcsinfo.zip">macros/latex/contrib/rcsinfo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rcsinfo/">browse the directory</a>) -<dt><tt><i>svn.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/svn.zip">macros/latex/contrib/svn</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/svn/">browse the directory</a>) -<dt><tt><i>svninfo.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/svninfo.zip">macros/latex/contrib/svninfo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/svninfo/">browse the directory</a>) -<dt><tt><i>vc</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/vc.zip">support/vc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/vc/">browse the directory</a>) +<dt><tt><i>rcs.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rcs.zip">macros/latex/contrib/rcs</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rcs/">browse the directory</a>) +<dt><tt><i>rcsinfo.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rcsinfo.zip">macros/latex/contrib/rcsinfo</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rcsinfo/">browse the directory</a>) +<dt><tt><i>svn.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/svn.zip">macros/latex/contrib/svn</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/svn/">browse the directory</a>) +<dt><tt><i>svninfo.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/svninfo.zip">macros/latex/contrib/svninfo</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/svninfo/">browse the directory</a>) +<dt><tt><i>vc</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/vc.zip">support/vc</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/vc/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=RCS">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=RCS</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-SGML2TeX.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-SGML2TeX.html index e828d3ed966..c24234e51a2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-SGML2TeX.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-SGML2TeX.html @@ -59,7 +59,7 @@ source is available on CTAN. SGML, and of public domain tools for writing and manipulating it, in <i>TUGboat</i> 16(2). <dl> -<dt><tt><i>html2latex source</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/html2latex.zip">support/html2latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/html2latex/">browse the directory</a>) +<dt><tt><i>html2latex source</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/html2latex.zip">support/html2latex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/html2latex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=SGML2TeX">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=SGML2TeX</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-TeXsystems.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-TeXsystems.html index 657afe58153..8a6eeaf1853 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-TeXsystems.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-TeXsystems.html @@ -21,8 +21,8 @@ (<i>tlmgr</i>) can both keep your installation up-to-date and add packages you didn’t install at first. <p/> <dl> - <dt><tt><i>texlive</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/texlive/">systems/texlive/</a> - <dt><tt><i>texlive installer (Unix)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/texlive/tlnet/2008/install-tl-unx.tar.gz">systems/texlive/tlnet/2008/install-tl-unx.tar.gz</a> + <dt><tt><i>texlive</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/systems/texlive/">systems/texlive/</a> + <dt><tt><i>texlive installer (Unix)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/texlive/tlnet/2008/install-tl-unx.tar.gz">systems/texlive/tlnet/2008/install-tl-unx.tar.gz</a> </dl> <dt>Linux<dd> GNU/Linux users are supported by TeX Live (as noted above). @@ -36,9 +36,9 @@ of that excellent (Windows) system for use on Linux; a beta version is available via <a href="http://miktex.org/unx/">the MiKTeX site</a>. <dl> - <dt><tt><i>texlive</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/texlive/">systems/texlive/</a> - <dt><tt><i>vtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/linux.zip">systems/vtex/linux</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/linux/">browse the directory</a>) - <dt><tt><i>vtex required common files</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/common.zip">systems/vtex/common</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/common/">browse the directory</a>) + <dt><tt><i>texlive</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/systems/texlive/">systems/texlive/</a> + <dt><tt><i>vtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/vtex/linux.zip">systems/vtex/linux</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/vtex/linux/">browse the directory</a>) + <dt><tt><i>vtex required common files</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/vtex/common.zip">systems/vtex/common</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/vtex/common/">browse the directory</a>) </dl> <dt>PC: Windows<dd> MiKTeX, by Christian Schenk, is a comprehensive distribution. It has @@ -105,15 +105,15 @@ comes with a bunch of Type 1 fonts packaged to work with BaKoMa TeX, which further the focus. <dl> - <dt><tt><i>bakoma</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/bakoma/">systems/win32/bakoma/</a> - <dt><tt><i>miktex</i></tt><dd>Acquire <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/miktex/setup/setup.exe">systems/win32/miktex/setup/setup.exe</a> (also available from the + <dt><tt><i>bakoma</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/win32/bakoma/">systems/win32/bakoma/</a> + <dt><tt><i>miktex</i></tt><dd>Acquire <a href="http://www.tex.ac.uk/tex-archive/systems/win32/miktex/setup/setup.exe">systems/win32/miktex/setup/setup.exe</a> (also available from the MiKTeX web site), and read installation instructions from <a href="http://www.miktex.org/2.7/setup">the MiKTeX installation page</a> - <dt><tt><i>Portable miktex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/miktex/setup/miktex-portable.exe">systems/win32/miktex/setup/miktex-portable.exe</a> - <dt><tt><i>protext.exe</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/protext/">systems/win32/protext/</a> - <dt><tt><i>texlive</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/texlive/">systems/texlive/</a> - <dt><tt><i>texlive installer (Windows)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/texlive/tlnet/2008/install-tl.zip">systems/texlive/tlnet/2008/install-tl.zip</a> + <dt><tt><i>Portable miktex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/win32/miktex/setup/miktex-portable.exe">systems/win32/miktex/setup/miktex-portable.exe</a> + <dt><tt><i>protext.exe</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/win32/protext/">systems/win32/protext/</a> + <dt><tt><i>texlive</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/systems/texlive/">systems/texlive/</a> + <dt><tt><i>texlive installer (Windows)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/texlive/tlnet/2008/install-tl.zip">systems/texlive/tlnet/2008/install-tl.zip</a> </dl> <dt>PC: MSDOS or OS/2<dd> EmTeX, by Eberhard Mattes, includes LaTeX, BibTeX, previewers, and drivers, and is @@ -131,15 +131,15 @@ operating systems, who want an up-to-date (La)TeX system, need to migrate to Win32-based systems. <dl> - <dt><tt><i>emtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/emtex.zip">systems/msdos/emtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/emtex/">browse the directory</a>) - <dt><tt><i>emtexTDS</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS.zip">obsolete/systems/os2/emtex-contrib/emtexTDS</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS/">browse the directory</a>) + <dt><tt><i>emtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/msdos/emtex.zip">systems/msdos/emtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/msdos/emtex/">browse the directory</a>) + <dt><tt><i>emtexTDS</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS.zip">obsolete/systems/os2/emtex-contrib/emtexTDS</a> (or <a href="http://www.tex.ac.uk/tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS/">browse the directory</a>) </dl> <dt>PC: MSDOS<dd> The most recent MSDOS offering is a port of the Web2C 7.0 implementation, using the GNU <i>djgpp</i> compiler. While this package is more recent than emTeX, it still implements a rather old instance of (La)TeX. <dl> - <dt><tt><i>djgpp</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/djgpp.zip">systems/msdos/djgpp</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/djgpp/">browse the directory</a>) + <dt><tt><i>djgpp</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/msdos/djgpp.zip">systems/msdos/djgpp</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/msdos/djgpp/">browse the directory</a>) </dl> <dt>PC: OS/2<dd> EmTeX, by Eberhard Mattes (see above), was actually developed under OS/2, and lives happily @@ -149,10 +149,10 @@ in direct production of PDF from (La)TeX input. (This version is, like the Linux version, unfortunately no longer supported.) <dl> - <dt><tt><i>emtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/emtex.zip">systems/msdos/emtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/emtex/">browse the directory</a>) - <dt><tt><i>emtexTDS</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS.zip">obsolete/systems/os2/emtex-contrib/emtexTDS</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS/">browse the directory</a>) - <dt><tt><i>vtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/os2.zip">systems/vtex/os2</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/os2/">browse the directory</a>) - <dt><tt><i>vtex required common files</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/common.zip">systems/vtex/common</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/vtex/common/">browse the directory</a>) + <dt><tt><i>emtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/msdos/emtex.zip">systems/msdos/emtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/msdos/emtex/">browse the directory</a>) + <dt><tt><i>emtexTDS</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS.zip">obsolete/systems/os2/emtex-contrib/emtexTDS</a> (or <a href="http://www.tex.ac.uk/tex-archive/obsolete/systems/os2/emtex-contrib/emtexTDS/">browse the directory</a>) + <dt><tt><i>vtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/vtex/os2.zip">systems/vtex/os2</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/vtex/os2/">browse the directory</a>) + <dt><tt><i>vtex required common files</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/vtex/common.zip">systems/vtex/common</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/vtex/common/">browse the directory</a>) </dl> @@ -195,24 +195,24 @@ The MacTeX-on-OSX mailing list is a useful resource for users; mail <a href="mailto:MacOSX-TeX-on@email.esm.psu.edu"><i>MacOSX-TeX-on@email.esm.psu.edu</i></a> to subscribe. <dl> - <dt><tt><i>cmactex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/mac/cmactex.zip">systems/mac/cmactex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/mac/cmactex/">browse the directory</a>) - <dt><tt><i>mactex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/mac/mactex/">systems/mac/mactex/</a> - <dt><tt><i>oztex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/mac/oztex.zip">systems/mac/oztex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/mac/oztex/">browse the directory</a>) + <dt><tt><i>cmactex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/cmactex.zip">systems/mac/cmactex</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/mac/cmactex/">browse the directory</a>) + <dt><tt><i>mactex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/mactex/">systems/mac/mactex/</a> + <dt><tt><i>oztex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/oztex.zip">systems/mac/oztex</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/mac/oztex/">browse the directory</a>) </dl> <dt>OpenVMS<dd> TeX for OpenVMS is available, though it seems unlikely that the version on CTAN is the latest available. <dl> - <dt><tt><i>OpenVMS</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/OpenVMS/TEX97_CTAN.ZIP">systems/OpenVMS/TEX97_CTAN.ZIP</a> + <dt><tt><i>OpenVMS</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/OpenVMS/TEX97_CTAN.ZIP">systems/OpenVMS/TEX97_CTAN.ZIP</a> </dl> <dt>Atari<dd> TeX for the Atari ST is available from CTAN. <dl> - <dt><tt><i>Atari TeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/atari.zip">systems/atari</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/atari/">browse the directory</a>) + <dt><tt><i>Atari TeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/atari.zip">systems/atari</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/atari/">browse the directory</a>) </dl> <dt>Amiga<dd> Full implementations of TeX 3.1 (PasTeX) and Metafont 2.7 are available. <dl> - <dt><tt><i>PasTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/amiga.zip">systems/amiga</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/amiga/">browse the directory</a>) + <dt><tt><i>PasTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/amiga.zip">systems/amiga</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/amiga/">browse the directory</a>) </dl> <dt>TOPS-20<dd> TeX was originally written on a DEC-10 under WAITS, diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-WYGexpts.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-WYGexpts.html index a01cbced43b..aaa3fbd52d7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-WYGexpts.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-WYGexpts.html @@ -89,8 +89,8 @@ separate window), degree of correspondence of the display to the final output, and the balance they strike between visual aid and visual distraction. <dl> -<dt><tt><i>preview-latex</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/auctex/">support/auctex/</a> -<dt><tt><i>texmacs</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/unix/TeXmacs/">systems/unix/TeXmacs/</a> +<dt><tt><i>preview-latex</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/support/auctex/">support/auctex/</a> +<dt><tt><i>texmacs</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/systems/unix/TeXmacs/">systems/unix/TeXmacs/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=WYGexpts">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=WYGexpts</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-abspos.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-abspos.html index 25c3448f6b6..fbfb5c43e07 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-abspos.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-abspos.html @@ -26,9 +26,9 @@ must therefore also be available.) <dl> -<dt><tt><i>eso-pic.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eso-pic.zip">macros/latex/contrib/eso-pic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eso-pic/">browse the directory</a>) -<dt><tt><i>everyshi.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms/">browse the directory</a>) -<dt><tt><i>textpos.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/textpos.zip">macros/latex/contrib/textpos</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/textpos/">browse the directory</a>) +<dt><tt><i>eso-pic.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eso-pic.zip">macros/latex/contrib/eso-pic</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eso-pic/">browse the directory</a>) +<dt><tt><i>everyshi.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms/">browse the directory</a>) +<dt><tt><i>textpos.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/textpos.zip">macros/latex/contrib/textpos</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/textpos/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=abspos">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=abspos</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-acrobat.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-acrobat.html index 047c6933ec3..85f7456945e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-acrobat.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-acrobat.html @@ -70,13 +70,13 @@ mistake. <dl> <dt><tt><i>Acrobat Reader</i></tt><dd>browse <a href="ftp://ftp.adobe.com/pub/adobe/acrobatreader">ftp://ftp.adobe.com/pub/adobe/acrobatreader</a> -<dt><tt><i>dvipdfm</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfm.zip">dviware/dvipdfm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfm/">browse the directory</a>) -<dt><tt><i>dvipdfmx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfmx.zip">dviware/dvipdfmx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfmx/">browse the directory</a>) -<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/">support/ghostscript/</a> -<dt><tt><i>GSview</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/ghostgum/">support/ghostscript/ghostgum/</a> -<dt><tt><i>gv</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/gv/">support/gv/</a> -<dt><tt><i>hyper.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyper.zip">macros/latex/contrib/hyper</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyper/">browse the directory</a>) -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>dvipdfm</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfm.zip">dviware/dvipdfm</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfm/">browse the directory</a>) +<dt><tt><i>dvipdfmx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfmx.zip">dviware/dvipdfmx</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfmx/">browse the directory</a>) +<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/">support/ghostscript/</a> +<dt><tt><i>GSview</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/ghostgum/">support/ghostscript/ghostgum/</a> +<dt><tt><i>gv</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/gv/">support/gv/</a> +<dt><tt><i>hyper.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyper.zip">macros/latex/contrib/hyper</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyper/">browse the directory</a>) +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=acrobat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=acrobat</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-activechars.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-activechars.html index 8f21c60a556..8ceaf24df9b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-activechars.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-activechars.html @@ -45,8 +45,8 @@ argument to another command (as, for example, in “<a href="FAQ-verbwithin.html"><code>\</code><code>verb</code> in command arguments</a>”). An exemplary case is the <i>doc</i> package, which processes .dtx files using the <i>shortvrb</i> package to define -<code>|...|</code> as a shorthand for -<code>\</code><code>verb</code><code>|...|</code>. But <code>|</code> is +<code>|…|</code> as a shorthand for +<code>\</code><code>verb</code><code>|…|</code>. But <code>|</code> is also used in the preambles of tabular environments, so that tables in <code>.dtx</code> files can only have vertical line separation between columns by employing special measures of some sort. @@ -113,8 +113,8 @@ made active — the definition of the command persists even if the character’s catcode reverts to its original value; the definition becomes accessible again if the character once again becomes active. <dl> -<dt><tt><i>doc.sty</i></tt><dd>Distributed as part of the source of LaTeX, <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base/">browse the directory</a>) -<dt><tt><i>shortvrb.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>doc.sty</i></tt><dd>Distributed as part of the source of LaTeX, <a href="http://www.tex.ac.uk/tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/">browse the directory</a>) +<dt><tt><i>shortvrb.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=activechars">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=activechars</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-addtoreset.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-addtoreset.html index 30c2fc51553..d70605711fc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-addtoreset.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-addtoreset.html @@ -67,8 +67,8 @@ a label-like mechanism, and may require more than one run of LaTeX to stabilise counter values — LaTeX will generate the usual warnings about labels changing. <dl> -<dt><tt><i>chngcntr.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/chngcntr.sty">macros/latex/contrib/misc/chngcntr.sty</a> -<dt><tt><i>perpage.sty</i></tt><dd>Distributed as part <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) +<dt><tt><i>chngcntr.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/chngcntr.sty">macros/latex/contrib/misc/chngcntr.sty</a> +<dt><tt><i>perpage.sty</i></tt><dd>Distributed as part <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=addtoreset">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=addtoreset</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-algorithms.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-algorithms.html index aaf4f057efb..440c54e28da 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-algorithms.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-algorithms.html @@ -93,15 +93,15 @@ algorithms to float like figures and tables. <dl> -<dt><tt><i>algorithm2e.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/algorithm2e.zip">macros/latex/contrib/algorithm2e</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/algorithm2e/">browse the directory</a>) -<dt><tt><i>algorithmicx bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/algorithmicx.zip">macros/latex/contrib/algorithmicx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/algorithmicx/">browse the directory</a>) -<dt><tt><i>algorithms bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/algorithms.zip">macros/latex/contrib/algorithms</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/algorithms/">browse the directory</a>) -<dt><tt><i>alg.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/alg.zip">macros/latex/contrib/alg</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/alg/">browse the directory</a>) -<dt><tt><i>clrscode.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/clrscode.zip">macros/latex/contrib/clrscode</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/clrscode/">browse the directory</a>) -<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float/">browse the directory</a>) -<dt><tt><i>newalg.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/newalg.zip">macros/latex/contrib/newalg</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/newalg/">browse the directory</a>) -<dt><tt><i>program.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/program.zip">macros/latex/contrib/program</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/program/">browse the directory</a>) -<dt><tt><i>pseudocode.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pseudocode.zip">macros/latex/contrib/pseudocode</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pseudocode/">browse the directory</a>) +<dt><tt><i>algorithm2e.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/algorithm2e.zip">macros/latex/contrib/algorithm2e</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/algorithm2e/">browse the directory</a>) +<dt><tt><i>algorithmicx bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/algorithmicx.zip">macros/latex/contrib/algorithmicx</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/algorithmicx/">browse the directory</a>) +<dt><tt><i>algorithms bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/algorithms.zip">macros/latex/contrib/algorithms</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/algorithms/">browse the directory</a>) +<dt><tt><i>alg.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/alg.zip">macros/latex/contrib/alg</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/alg/">browse the directory</a>) +<dt><tt><i>clrscode.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/clrscode.zip">macros/latex/contrib/clrscode</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/clrscode/">browse the directory</a>) +<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float/">browse the directory</a>) +<dt><tt><i>newalg.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/newalg.zip">macros/latex/contrib/newalg</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/newalg/">browse the directory</a>) +<dt><tt><i>program.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/program.zip">macros/latex/contrib/program</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/program/">browse the directory</a>) +<dt><tt><i>pseudocode.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pseudocode.zip">macros/latex/contrib/pseudocode</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pseudocode/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=algorithms">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=algorithms</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-alreadydef.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-alreadydef.html index 762e7a60d13..31442c04f3a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-alreadydef.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-alreadydef.html @@ -53,9 +53,9 @@ and making the <i>txfonts</i> version of the command available as <p/>Documentation of <i>savesym</i> doesn’t amount to much: the only commands are <code>\</code><code>savesymbol</code> and <code>\</code><code>restoresymbol</code>, as noted above. <dl> -<dt><tt><i>amsmath.sty</i></tt><dd>Part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) -<dt><tt><i>savesym.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/savesym/savesym.sty">macros/latex/contrib/savesym/savesym.sty</a> -<dt><tt><i>txfonts.sty</i></tt><dd>Part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/txfonts.zip">fonts/txfonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/txfonts/">browse the directory</a>) +<dt><tt><i>amsmath.sty</i></tt><dd>Part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>savesym.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/savesym/savesym.sty">macros/latex/contrib/savesym/savesym.sty</a> +<dt><tt><i>txfonts.sty</i></tt><dd>Part of <a href="http://www.tex.ac.uk/tex-archive/fonts/txfonts.zip">fonts/txfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/txfonts/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=alreadydef">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=alreadydef</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-altabcr.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-altabcr.html index 0d4e430e0a0..7bf9dbcb782 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-altabcr.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-altabcr.html @@ -71,7 +71,7 @@ following <code>&</code> appears to LaTeX just like the second <code>\</code><code>tabularnewline</code> explicitly, or use the <code>\</code><code>RBS</code> trick described there. <dl> -<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=altabcr">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=altabcr</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ant.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ant.html index a76e084feac..e8a9ce4eb1f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ant.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ant.html @@ -16,7 +16,7 @@ writer. This architecture holds the promise of a system that avoids a set of serious problems with TeX’s user interface: those that derive from the design language being the same as the markup language. <dl> -<dt><tt><i>ANT</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/ant.zip">systems/ant</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/ant/">browse the directory</a>) +<dt><tt><i>ANT</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/ant.zip">systems/ant</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/ant/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ant">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ant</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-appendix.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-appendix.html index 9f81f957890..a7f5e70c768 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-appendix.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-appendix.html @@ -24,11 +24,11 @@ to alphabetic. So: would be typeset (in an <i>article</i> document) something like: <blockquote> <b>1 My inspiration</b> -<p/>... +<p/>… <p/><b>2 Developing the inspiration</b> -<p/>... +<p/>… <p/><b>A How I became inspired</b> -<p/>... +<p/>… </blockquote><p> which is quite enough for many ordinary purposes. Note that, once you’ve switched to typesetting appendixes, LaTeX provides you with @@ -90,11 +90,11 @@ as <code>\</code><code>section</code>s. So one might write: Which will produce output something like: <blockquote> <b>1 My inspiration</b> -<p/>... +<p/>… <p/><b>1.A How I became inspired</b> -<p/>... +<p/>… <p/><b>2 Developing the inspiration</b> -<p/>... +<p/>… </blockquote><p> <p/>There are many other merry things one may do with the package; the user is referred to the package documentation for further details. @@ -102,9 +102,9 @@ user is referred to the package documentation for further details. <i>appendix</i> package. The <i>KOMA-script</i> classes offer a <code>\</code><code>appendixprefix</code> command for manipulating the appearance of appendixes. <dl> -<dt><tt><i>appendix.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/appendix.zip">macros/latex/contrib/appendix</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/appendix/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>appendix.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/appendix.zip">macros/latex/contrib/appendix</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/appendix/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=appendix">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=appendix</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-archives.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-archives.html index 262c0e4d2c9..4d6b1937244 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-archives.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-archives.html @@ -25,11 +25,11 @@ CTAN mirrors are Web-accessible. <p/>As a matter of course, to reduce network load, please use the CTAN site or mirror closest to you. A complete and current list of CTAN sites -and known mirrors is available as file <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveCTAN.sites">CTAN.sites</a> on the +and known mirrors is available as file <a href="http://www.tex.ac.uk/tex-archive/CTAN.sites">CTAN.sites</a> on the archives themselves. <p/>Better still, the script behind <a href="http://mirror.ctan.org/">http://mirror.ctan.org/</a> will cunningly choose a “nearby” mirror for you, using information from -the database ‘behind’ <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveCTAN.sites">CTAN.sites</a>; at present it uses +the database ‘behind’ <a href="http://www.tex.ac.uk/tex-archive/CTAN.sites">CTAN.sites</a>; at present it uses <code>ftp</code> protocol for transfers, but the intention is to convert it to using <code>http</code> (web) protocol in the near future. <p/>To access a particular thing through the <code>mirror.ctan.org</code> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-atsigns.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-atsigns.html index c4245c16ff3..e31404b1b9d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-atsigns.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-atsigns.html @@ -46,7 +46,7 @@ bundling them up into a <code>.sty</code> file and including them with <code>\</code><code>usepackage</code>; this way you hide your LaTeX internal code somewhere that LaTeX internal code is expected, which often looks ‘tidier’. <dl> -<dt><tt><i>Examples from the Companion</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/tlc2.zip">info/examples/tlc2</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/tlc2/">browse the directory</a>) +<dt><tt><i>Examples from the Companion</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/examples/tlc2.zip">info/examples/tlc2</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/examples/tlc2/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-backref.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-backref.html index 862ecf161be..8e6e7b78a87 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-backref.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-backref.html @@ -7,8 +7,13 @@ citing command, is often useful in large documents. <p/>Two packages support this requirement, <i>backref</i> and <i>citeref</i>. <i>Backref</i> is part of the <i>hyperref</i> bundle, and supports hyperlinks back to the citing -command. <i>Citeref</i> is the older, and seems to rely on rather -simpler (and therefore possibly more stable) code. Neither collapses +command. +<p/><i>Citeref</i> is the older, and seems to rely on rather simpler +(and therefore possibly more stable) code; it produces a list of page +references, only. It doesn’t interact well with other citation +packages (for example, <i>cite</i>), which probably reflects its +antiquity (it’s derived from a LaTeX 2.09 package). +<p/>Neither collapses lists of pages (“<code>5, 6, 7</code>” comes out as such, rather than as “<code>5–7</code>”), but neither package repeats the reference to a page that holds multiple citations. (The failure to collapse lists is of course @@ -16,8 +21,8 @@ forgiveable in the case of the <i>hyperref</i>-related <i>backref</i>, since the concept of multiple hyperlinks from the same anchor is less than appealing.) <dl> -<dt><tt><i>backref.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>citeref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/citeref.zip">macros/latex/contrib/citeref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/citeref/">browse the directory</a>) +<dt><tt><i>backref.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>citeref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/citeref.zip">macros/latex/contrib/citeref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/citeref/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=backref">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=backref</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-balance.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-balance.html index 4ffe7eac66a..87e8e1a875e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-balance.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-balance.html @@ -39,9 +39,9 @@ It is this difficulty (what’s required in any instance can’t really expressed in current LaTeX) that led the author of <i>multicol</i> to suppress single-column-wide floats. <dl> -<dt><tt><i>balance.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/preprint.zip">macros/latex/contrib/preprint</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/preprint/">browse the directory</a>) -<dt><tt><i>flushend.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sttools.zip">macros/latex/contrib/sttools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sttools/">browse the directory</a>) -<dt><tt><i>multicol.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>balance.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/preprint.zip">macros/latex/contrib/preprint</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/preprint/">browse the directory</a>) +<dt><tt><i>flushend.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sttools.zip">macros/latex/contrib/sttools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sttools/">browse the directory</a>) +<dt><tt><i>multicol.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) <p/></dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=balance">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=balance</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibinline.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibinline.html index feb98644284..9b102eb264d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibinline.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibinline.html @@ -32,10 +32,10 @@ footnotes. Therefore, in a document which has other footnotes, it may be advisable to use <i>jurabib</i> (or of course <i>inlinebib</i>), to avoid confusion of footnotes and foot-citations. <dl> -<dt><tt><i>bibentry.sty</i></tt><dd><em>Distributed with</em> <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) -<dt><tt><i>footbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footbib.zip">macros/latex/contrib/footbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footbib/">browse the directory</a>) -<dt><tt><i>inlinebib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/inlinebib.zip">biblio/bibtex/contrib/inlinebib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/inlinebib/">browse the directory</a>) -<dt><tt><i>jurabib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/jurabib.zip">macros/latex/contrib/jurabib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/jurabib/">browse the directory</a>) +<dt><tt><i>bibentry.sty</i></tt><dd><em>Distributed with</em> <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) +<dt><tt><i>footbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footbib.zip">macros/latex/contrib/footbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footbib/">browse the directory</a>) +<dt><tt><i>inlinebib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/inlinebib.zip">biblio/bibtex/contrib/inlinebib</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/inlinebib/">browse the directory</a>) +<dt><tt><i>jurabib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/jurabib.zip">macros/latex/contrib/jurabib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/jurabib/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibinline">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibinline</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-biblatex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-biblatex.html index 2b694e6a089..ef6c25db193 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-biblatex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-biblatex.html @@ -14,14 +14,14 @@ likely inextensible); and specialist BibTeX style files are available for use in non-technical papers. <p/>BibTeX uses a style language whose mechanisms are unfamiliar to most current programmers: it’s difficult to learn, but since there are -fewer opportunities to write the language, it’s also difficult to become +few opportunities to write the language, it’s also difficult to become fluent (in the way that so many people fluently write the equally arcane TeX macro language). <p/>Oren Patashnik (the author of BibTeX) summarises the issues as he sees them, in a <a href="http://tug.org/TUGboat/Articles/tb24-1/patashnik.pdf">TUG conference paper from 2003</a> that seems to suggest that we might expect a -BibTeX 1.0...which hasn’t (yet) appeared. +BibTeX 1.0…which hasn’t (yet) appeared. <p/>In the absence of BibTeX 1.0, what do we need from the bibliography system of the future? — simple: a superset of what BibTeX does (or can be made to do), implemented in a simpler style language, with @@ -37,8 +37,8 @@ to watch. <p/>Two interesting alternative approaches, that the author has investigated, are <i>amsrefs</i> and <i>biblatex</i>. <i>Amsrefs</i> does away with BibTeX altogether, while -<i>biblatex</i> makes rather limited use of BibTeX. Both are -heavily dependent on LaTeX’s support. +<i>biblatex</i> (at least for now) makes rather limited use of +BibTeX. Both are heavily dependent on LaTeX’s support. <p/><i>Amsrefs</i> uses a transformed <code>.bib</code> file, which is expressed as LaTeX macros. (The package provides a BibTeX style that performs the transformation, so that a LaTeX source containing @@ -64,23 +64,23 @@ appeared, which cover some of the trickier bibliography styles. The road map of the project shows one more <em>beta</em> release before the “stable” <i>biblatex</i> 1.0. <p/>A related project is -<a href="http://biblatex-biber.sourceforge.net/"><i>biber</a></i> (or -<i>biblatex-biber</i>, to distinguish it from an older, defunct, -BibTeX replacement project). <i>Biber</i> is a -<i>Perl</i>-based system to produce a BibTeX replacement that -is specifically tuned to the requirements of <i>biblatex</i>. -While it supports ‘traditional’ BibTeX, <i>biber</i> aims at an -interface language that is closely tuned to the requirements of -<i>biblatex</i>, including use of a Unicode-based character set to -ease the generation multilingual citations. +<a href="http://biblatex-biber.sourceforge.net/"><i>biber</a></i> +(it’s called <i>biblatex-biber</i> on SourceForge simply to +distinguish it from an older, defunct, BibTeX replacement +project). <i>Biber</i> is a <i>Perl</i>-based system to +produce a BibTeX replacement that is specifically tuned to the +requirements of <i>biblatex</i>. While it supports the +‘traditional’ BibTeX interface, <i>biber</i> provides an +interface language designed for <i>biblatex</i>, including use of +Unicode to ease the generation of multilingual citations. <dl> -<dt><tt><i>amsrefs.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/amsrefs.zip">macros/latex/contrib/amsrefs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/amsrefs/">browse the directory</a>) -<dt><tt><i>biblatex.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/exptl/biblatex.zip">macros/latex/exptl/biblatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/exptl/biblatex/">browse the directory</a>) -<dt><tt><i>biblatex contributions</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/exptl/biblatex-contrib/">macros/latex/exptl/biblatex-contrib/</a> -<dt><tt><i>CrossTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/crosstex/">biblio/crosstex/</a> +<dt><tt><i>amsrefs.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/amsrefs.zip">macros/latex/contrib/amsrefs</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/amsrefs/">browse the directory</a>) +<dt><tt><i>biblatex.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/exptl/biblatex.zip">macros/latex/exptl/biblatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/exptl/biblatex/">browse the directory</a>) +<dt><tt><i>biblatex contributions</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/exptl/biblatex-contrib/">macros/latex/exptl/biblatex-contrib/</a> +<dt><tt><i>CrossTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/crosstex/">biblio/crosstex/</a> </dl> -<p/> -<p/> +<p/><p/> -<p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=biblatex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=biblatex</a> + +<p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=biblatex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=biblatex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibplain.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibplain.html index 3f9f106fd16..e38d6c29144 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibplain.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibplain.html @@ -8,8 +8,8 @@ Plain TeX, either directly or with <a href="FAQ-eplain.html">Eplain</a>. See <a href="FAQ-BibTeXing.html">the use of BibTeX</a> for more information about BibTeX itself. <dl> -<dt><tt><i>btxmac.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/eplain/tex/eplain/btxmac.tex">macros/eplain/tex/eplain/btxmac.tex</a> -<dt><tt><i>eplain system</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/eplain.zip">macros/eplain</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/eplain/">browse the directory</a>) +<dt><tt><i>btxmac.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/eplain/tex/eplain/btxmac.tex">macros/eplain/tex/eplain/btxmac.tex</a> +<dt><tt><i>eplain system</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/eplain.zip">macros/eplain</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/eplain/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibplain">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibplain</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibprefixsort.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibprefixsort.html index e82194c6ae8..87f40f0844b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibprefixsort.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibprefixsort.html @@ -51,6 +51,6 @@ AUTHOR = "\noopsort{Thanh Han The}{Han The Thanh}", though that author seems well-acquainted with Western confusion about the significance of the parts of his name (even to the extent of -missing out the accentuation, as above...). +missing out the accentuation, as above…). <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibprefixsort">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibprefixsort</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibstrtl.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibstrtl.html index d9a5664bbf5..e3a0dfd830e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibstrtl.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibstrtl.html @@ -9,7 +9,7 @@ The diagnostic usually arises because of an infelicity in the coding of <i>abstract.bst</i>, or styles derived from it. (One doesn’t ordinarily output annotations in other styles.) <p/>The solution is to make a copy of the style file (or get a clean copy -from CTAN — <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/bibtools/abstract.bst">biblio/bibtex/utils/bibtools/abstract.bst</a>), and rename it (e.g., on a +from CTAN — <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/bibtools/abstract.bst">biblio/bibtex/utils/bibtools/abstract.bst</a>), and rename it (e.g., on a long file-name system, to <i>abstract-long.bst</i>). Now edit it: find function <code>output.nonnull</code> and <ul> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtocorder.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtocorder.html index 2356f4c392f..3025095cd19 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtocorder.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtocorder.html @@ -26,7 +26,7 @@ found errors in your “stable” version, often enough. citations while in the table of contents, or lists of figures, tables (or other floating things: the code is quite general). <dl> -<dt><tt><i>notoccite.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/notoccite.sty">macros/latex/contrib/misc/notoccite.sty</a> +<dt><tt><i>notoccite.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/notoccite.sty">macros/latex/contrib/misc/notoccite.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibtocorder">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bibtocorder</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtranscinit.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtranscinit.html index 4d2b65ca6cc..fd77e108c02 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtranscinit.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bibtranscinit.html @@ -18,8 +18,8 @@ Consider the following example from the real world: Note that the “Yu” is the initial, not a complete name. However, BibTeX’s algorithms will leave you with a citation — slightly depending on the bibliographic style — that reads: -“S. Y. Epifanov and A. A. Vigasin, ...”. instead of the intended -“S. Yu. Epifanov and A. A. Vigasin, ...”. +“S. Y. Epifanov and A. A. Vigasin, …”. instead of the intended +“S. Yu. Epifanov and A. A. Vigasin, …”. <p/>One solution is to replace each affected initial by a command that prints the correct combination. To keep your bibliography portable, you need to add that command to your bibliography with the diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bold-extras.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bold-extras.html index 52f5763c3e4..032644c53a1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bold-extras.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bold-extras.html @@ -38,9 +38,9 @@ freely available (monospace text in the typeset version of this FAQ uses <i>LuxiMono</i>, with the metrics and LaTeX support available on the archive. <dl> -<dt><tt><i>bold-extra.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/bold-extra.sty">macros/latex/contrib/misc/bold-extra.sty</a> -<dt><tt><i>bold tt and small caps fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/mf-extra/bold.zip">fonts/cm/mf-extra/bold</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/mf-extra/bold/">browse the directory</a>) -<dt><tt><i>LuxiMono fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/LuxiMono.zip">fonts/LuxiMono</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/LuxiMono/">browse the directory</a>) +<dt><tt><i>bold-extra.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/bold-extra.sty">macros/latex/contrib/misc/bold-extra.sty</a> +<dt><tt><i>bold tt and small caps fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/cm/mf-extra/bold.zip">fonts/cm/mf-extra/bold</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/cm/mf-extra/bold/">browse the directory</a>) +<dt><tt><i>LuxiMono fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/LuxiMono.zip">fonts/LuxiMono</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/LuxiMono/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bold-extras">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=bold-extras</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-boldgreek.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-boldgreek.html index 1248c3f4278..2824b5d1dc0 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-boldgreek.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-boldgreek.html @@ -37,10 +37,10 @@ which then causes problems in superscripts, etc. <p/>All these solutions cover all mathematical symbols, not merely Greek letters. <dl> -<dt><tt><i>bm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>amsbsy.sty</i></tt><dd>Distributed as part of AMSLaTeX <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>bm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>amsbsy.sty</i></tt><dd>Distributed as part of AMSLaTeX <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) <dt><tt><i>amsmath.sty</i></tt><dd>Distributed as part of AMSLaTeX - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=boldgreek">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=boldgreek</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-books.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-books.html index 609abc60c29..bb60a5da110 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-books.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-books.html @@ -130,12 +130,12 @@ and we list it under “<a href="FAQ-ol-books.html">online books</a>”. warnings that books are now out of print are always welcome. However, this FAQ does <em>not</em> carry reviews of current published material. <dl> -<dt><tt><i>Examples for First Steps in LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/FirstSteps.zip">info/examples/FirstSteps</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/FirstSteps/">browse the directory</a>) -<dt><tt><i>Examples for LaTeX Companion</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/tlc2.zip">info/examples/tlc2</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/tlc2/">browse the directory</a>) -<dt><tt><i>Examples for LaTeX Graphics Companion</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/lgc.zip">info/examples/lgc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/lgc/">browse the directory</a>) -<dt><tt><i>Examples for LaTeX Web Companion</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/lwc.zip">info/examples/lwc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/lwc/">browse the directory</a>) +<dt><tt><i>Examples for First Steps in LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/examples/FirstSteps.zip">info/examples/FirstSteps</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/examples/FirstSteps/">browse the directory</a>) +<dt><tt><i>Examples for LaTeX Companion</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/examples/tlc2.zip">info/examples/tlc2</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/examples/tlc2/">browse the directory</a>) +<dt><tt><i>Examples for LaTeX Graphics Companion</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/examples/lgc.zip">info/examples/lgc</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/examples/lgc/">browse the directory</a>) +<dt><tt><i>Examples for LaTeX Web Companion</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/examples/lwc.zip">info/examples/lwc</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/examples/lwc/">browse the directory</a>) -<dt><tt><i>Sample of Math into LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/mil/mil.pdf">info/mil/mil.pdf</a> +<dt><tt><i>Sample of Math into LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/mil/mil.pdf">info/mil/mil.pdf</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=books">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=books</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-braket.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-braket.html index b0aff775352..aa8f446d937 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-braket.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-braket.html @@ -26,7 +26,7 @@ for set specifications (as above) and for Dirac brackets (and bras and kets). The package uses the e-TeX built-in command if it finds itself running under e-TeX. <dl> -<dt><tt><i>braket.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/braket.sty">macros/latex/contrib/misc/braket.sty</a> +<dt><tt><i>braket.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/braket.sty">macros/latex/contrib/misc/braket.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=braket">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=braket</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breakbox.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breakbox.html index 71601d25a89..2da33de2c39 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breakbox.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breakbox.html @@ -33,11 +33,11 @@ device-independent Metafont for the shading). The author of there are reasons to suspect that it may be unstable working with current LaTeX. <dl> -<dt><tt><i>backgrnd.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/generic/misc/backgrnd.tex">macros/generic/misc/backgrnd.tex</a> -<dt><tt><i>boites.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/boites.zip">macros/latex/contrib/boites</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/boites/">browse the directory</a>) -<dt><tt><i>framed.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/framed.sty">macros/latex/contrib/misc/framed.sty</a> -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>shade.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/shade.zip">macros/generic/shade</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/shade/">browse the directory</a>) +<dt><tt><i>backgrnd.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/misc/backgrnd.tex">macros/generic/misc/backgrnd.tex</a> +<dt><tt><i>boites.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/boites.zip">macros/latex/contrib/boites</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/boites/">browse the directory</a>) +<dt><tt><i>framed.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/framed.sty">macros/latex/contrib/misc/framed.sty</a> +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>shade.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/shade.zip">macros/generic/shade</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/generic/shade/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=breakbox">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=breakbox</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breaklinks.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breaklinks.html index 67942462183..fd245eb4a86 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breaklinks.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-breaklinks.html @@ -39,7 +39,7 @@ the page number will be made active. you have at present no simple solution: you have to rewrite your text, or to use a different PDF generation mechanism. <dl> -<dt><tt><i>breakurl.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/breakurl.zip">macros/latex/contrib/breakurl</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/breakurl/">browse the directory</a>) +<dt><tt><i>breakurl.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/breakurl.zip">macros/latex/contrib/breakurl</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/breakurl/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=breaklinks">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=breaklinks</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buffovl.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buffovl.html index 0ad3217b462..0ca94465c24 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buffovl.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buffovl.html @@ -47,8 +47,8 @@ than a given length; so the solution is just to edit the file. Users of the shareware program <i>GSview</i> will find buttons to perform the required transformation of the file being displayed. <dl> -<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/">support/ghostscript/</a> -<dt><tt><i>GSview</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/ghostgum/">support/ghostscript/ghostgum/</a> +<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/">support/ghostscript/</a> +<dt><tt><i>GSview</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/ghostgum/">support/ghostscript/ghostgum/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=buffovl">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=buffovl</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bug.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bug.html index 3f58bef68bb..d56fdeeb58e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bug.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-bug.html @@ -45,4 +45,4 @@ help — TUG maintains a -</body> +<p/></body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buildbib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buildbib.html index 474d702057a..dc24844d14d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buildbib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-buildbib.html @@ -64,13 +64,13 @@ in this endeavour: using <i>bids.to.bibtex</i> </ul> <dl> -<dt><tt><i>bids.to.bibtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/bids/bids.to.bibtex">biblio/bibtex/utils/bids/bids.to.bibtex</a> -<dt><tt><i>btOOL</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/btOOL.zip">biblio/bibtex/utils/btOOL</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/btOOL/">browse the directory</a>) -<dt><tt><i>ebib</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/ebib.zip">biblio/bibtex/utils/ebib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/ebib/">browse the directory</a>) -<dt><tt><i>isi2bibtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/isi2bibtex.zip">biblio/bibtex/utils/isi2bibtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/isi2bibtex/">browse the directory</a>) -<dt><tt><i>tex2bib</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/tex2bib/tex2bib">biblio/bibtex/utils/tex2bib/tex2bib</a> -<dt><tt><i>tex2bib.readme</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/tex2bib/README">biblio/bibtex/utils/tex2bib/README</a> -<dt><tt><i>xbibfile</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/xbibfile.zip">biblio/bibtex/utils/xbibfile</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/xbibfile/">browse the directory</a>) +<dt><tt><i>bids.to.bibtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/bids/bids.to.bibtex">biblio/bibtex/utils/bids/bids.to.bibtex</a> +<dt><tt><i>btOOL</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/btOOL.zip">biblio/bibtex/utils/btOOL</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/btOOL/">browse the directory</a>) +<dt><tt><i>ebib</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/ebib.zip">biblio/bibtex/utils/ebib</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/ebib/">browse the directory</a>) +<dt><tt><i>isi2bibtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/isi2bibtex.zip">biblio/bibtex/utils/isi2bibtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/isi2bibtex/">browse the directory</a>) +<dt><tt><i>tex2bib</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/tex2bib/tex2bib">biblio/bibtex/utils/tex2bib/tex2bib</a> +<dt><tt><i>tex2bib.readme</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/tex2bib/README">biblio/bibtex/utils/tex2bib/README</a> +<dt><tt><i>xbibfile</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/xbibfile.zip">biblio/bibtex/utils/xbibfile</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/xbibfile/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=buildbib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=buildbib</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cancellation.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cancellation.html index 21eeacbd2fd..45159083262 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cancellation.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cancellation.html @@ -9,7 +9,7 @@ package provides several variants of cancellation marks a means of cancelling ‘to’ a particular value. <p/>Documentation of <i>cancel</i> is in the package file. <dl> -<dt><tt><i>cancel.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/cancel.sty">macros/latex/contrib/misc/cancel.sty</a> +<dt><tt><i>cancel.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/cancel.sty">macros/latex/contrib/misc/cancel.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=cancellation">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=cancellation</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-capbibtex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-capbibtex.html index 054ae10fb92..e8bb38151f2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-capbibtex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-capbibtex.html @@ -34,8 +34,10 @@ title = {{TeXniques and tips}}, </blockquote><p> though that does ensure that the capitalisation is not changed. Your BibTeX database should be a general-purpose thing, not something -tuned to the requirements of a particular document, or to the way you -are thinking today. +tuned to the requirements of a particular document or bibliography +style, or to the way you are thinking today — for example, on a +future occasion, you might find yourself using a different BibTeX +style with different capitalisation rules. <p/>There’s more on the subject in the <a href="FAQ-BibTeXing.html">BibTeX documentation</a>. diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-captsty.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-captsty.html index 98bbc9f1834..1940add6078 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-captsty.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-captsty.html @@ -40,12 +40,12 @@ file <i>manual.tex</i>, which is created when you unpack now been overtaken again by <i>caption</i>; however, <i>caption2</i> remains available for use in older documents. <dl> -<dt><tt><i>caption.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/caption.zip">macros/latex/contrib/caption</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/caption/">browse the directory</a>) -<dt><tt><i>capt-of.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/capt-of.sty">macros/latex/contrib/misc/capt-of.sty</a> -<dt><tt><i>ccaption.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccaption.zip">macros/latex/contrib/ccaption</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccaption/">browse the directory</a>) -<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>caption.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/caption.zip">macros/latex/contrib/caption</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/caption/">browse the directory</a>) +<dt><tt><i>capt-of.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/capt-of.sty">macros/latex/contrib/misc/capt-of.sty</a> +<dt><tt><i>ccaption.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccaption.zip">macros/latex/contrib/ccaption</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccaption/">browse the directory</a>) +<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=captsty">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=captsty</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-casechange.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-casechange.html index 2b51f342ba4..a2524a0427f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-casechange.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-casechange.html @@ -32,7 +32,7 @@ standard classes to produce upper case running heads for chapters and sections. <p/>Unfortunately <code>\</code><code>MakeUppercase</code> and <code>\</code><code>MakeLowercase</code> do not solve the other problems with <code>\</code><code>uppercase</code>, so for example a section -title containing <code>\</code><code>begin{tabular}</code> ... +title containing <code>\</code><code>begin{tabular}</code> … <code>\</code><code>end{tabular}</code> will produce a running head containing <code>\</code><code>begin{TABULAR}</code>. The simplest solution to this problem is using a user-defined command, for example: @@ -59,7 +59,7 @@ commands (<em>not</em> the TeX primitive commands <code>\</code><code>uppercase< <code>\</code><code>lowercase</code>), so that section headings and the like don’t produce broken page headings. <dl> -<dt><tt><i>textcase.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/textcase.zip">macros/latex/contrib/textcase</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/textcase/">browse the directory</a>) +<dt><tt><i>textcase.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/textcase.zip">macros/latex/contrib/textcase</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/textcase/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=casechange">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=casechange</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-changebars.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-changebars.html index 719a51a6840..808641d2e92 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-changebars.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-changebars.html @@ -17,7 +17,7 @@ that patches the output routine, but it appears to work at least on simple LaTeX documents. Wise LaTeX users will be alerted by the information that <i>backgrnd</i> patches their output routine, and will watch its behaviour very carefully (patching the LaTeX output -routine is not something to undertake lightly...). +routine is not something to undertake lightly…). <p/>The longest-established LaTeX-specific solution is the <i>changebar</i> package, which uses <code>\</code><code>special</code> commands supplied by the driver you’re using. @@ -70,14 +70,14 @@ A rudimentary revision facility is provided by another all changes. Manual editing of the difference file can be used to accept or reject selected changes only. <dl> -<dt><tt><i>backgrnd.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/generic/misc/backgrnd.tex">macros/generic/misc/backgrnd.tex</a> -<dt><tt><i>changebar.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/changebar.zip">macros/latex/contrib/changebar</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/changebar/">browse the directory</a>) -<dt><tt><i>changes.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/changes.zip">macros/latex/contrib/changes</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/changes/">browse the directory</a>) -<dt><tt><i>framed.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/framed.sty">macros/latex/contrib/misc/framed.sty</a> -<dt><tt><i>latexdiff, latexrevise</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/latexdiff.zip">support/latexdiff</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/latexdiff/">browse the directory</a>) -<dt><tt><i>lineno.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lineno.zip">macros/latex/contrib/lineno</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lineno/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>vertbars.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/vertbars.sty">macros/latex/contrib/misc/vertbars.sty</a> +<dt><tt><i>backgrnd.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/misc/backgrnd.tex">macros/generic/misc/backgrnd.tex</a> +<dt><tt><i>changebar.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/changebar.zip">macros/latex/contrib/changebar</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/changebar/">browse the directory</a>) +<dt><tt><i>changes.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/changes.zip">macros/latex/contrib/changes</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/changes/">browse the directory</a>) +<dt><tt><i>framed.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/framed.sty">macros/latex/contrib/misc/framed.sty</a> +<dt><tt><i>latexdiff, latexrevise</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/latexdiff.zip">support/latexdiff</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/latexdiff/">browse the directory</a>) +<dt><tt><i>lineno.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lineno.zip">macros/latex/contrib/lineno</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lineno/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>vertbars.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/vertbars.sty">macros/latex/contrib/misc/vertbars.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=changebars">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=changebars</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chapbib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chapbib.html index dacbbb004b7..89ce98f605f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chapbib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chapbib.html @@ -14,8 +14,8 @@ within the document: the package will deal with chapters and sections (as defined by LaTeX itself) and also defines a <code>bibunit</code> environment so that users can select their own structuring. <dl> -<dt><tt><i>chapterbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cite.zip">macros/latex/contrib/cite</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cite/">browse the directory</a>) -<dt><tt><i>bibunits.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bibunits.zip">macros/latex/contrib/bibunits</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bibunits/">browse the directory</a>) +<dt><tt><i>chapterbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cite.zip">macros/latex/contrib/cite</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cite/">browse the directory</a>) +<dt><tt><i>bibunits.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bibunits.zip">macros/latex/contrib/bibunits</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bibunits/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=chapbib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=chapbib</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chngmargonfly.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chngmargonfly.html index 8b35339f452..a7fbbcbe94b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chngmargonfly.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-chngmargonfly.html @@ -67,8 +67,8 @@ page (rather than a length): the package documentation also provides a useful analysis of when the command may (or may not) be expected to work. <dl> -<dt><tt><i>addlines.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/addlines.zip">macros/latex/contrib/addlines</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/addlines/">browse the directory</a>) -<dt><tt><i>changepage.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/changepage.sty">macros/latex/contrib/misc/changepage.sty</a> +<dt><tt><i>addlines.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/addlines.zip">macros/latex/contrib/addlines</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/addlines/">browse the directory</a>) +<dt><tt><i>changepage.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/changepage.sty">macros/latex/contrib/misc/changepage.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=chngmargonfly">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=chngmargonfly</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citeURL.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citeURL.html index 590e0c14874..0df2de38565 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citeURL.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citeURL.html @@ -71,19 +71,19 @@ There is good reason to use the <i>url</i> or <i>hyperref</i> packages in this context: BibTeX has a habit of splitting lines it considers excessively long, and if there are no space characters for it to use as ‘natural’ breakpoints, BibTeX will -insert a comment (‘<code>%</code>’) character ... which +insert a comment (‘<code>%</code>’) character … which is an acceptable character in an URL. Any current version of the <i>url</i> or <i>hyperref</i> package detects this “<code>%</code>–end-of-line” structure in its argument, and removes it. <dl> -<dt><tt><i>babelbib bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/babelbib.zip">biblio/bibtex/contrib/babelbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/babelbib/">browse the directory</a>) -<dt><tt><i>custom-bib bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/custom-bib.zip">macros/latex/contrib/custom-bib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/custom-bib/">browse the directory</a>) -<dt><tt><i>harvard.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/harvard.zip">macros/latex/contrib/harvard</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/harvard/">browse the directory</a>) -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>natbib styles</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) -<dt><tt><i>url.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/url.sty">macros/latex/contrib/misc/url.sty</a> -<dt><tt><i>urlbst</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/urlbst.zip">biblio/bibtex/contrib/urlbst</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/urlbst/">browse the directory</a>) +<dt><tt><i>babelbib bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/babelbib.zip">biblio/bibtex/contrib/babelbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/babelbib/">browse the directory</a>) +<dt><tt><i>custom-bib bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/custom-bib.zip">macros/latex/contrib/custom-bib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/custom-bib/">browse the directory</a>) +<dt><tt><i>harvard.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/harvard.zip">macros/latex/contrib/harvard</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/harvard/">browse the directory</a>) +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>natbib styles</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) +<dt><tt><i>url.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/url.sty">macros/latex/contrib/misc/url.sty</a> +<dt><tt><i>urlbst</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/urlbst.zip">biblio/bibtex/contrib/urlbst</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/urlbst/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citeURL">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citeURL</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citesort.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citesort.html index 613c7754485..f8e413a820d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citesort.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-citesort.html @@ -25,11 +25,11 @@ package: </pre> the <i>natbib</i> and <i>hyperref</i> packages will interwork. <dl> -<dt><tt><i>cite.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cite.zip">macros/latex/contrib/cite</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cite/">browse the directory</a>) -<dt><tt><i>hypernat.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/hypernat.sty">macros/latex/contrib/misc/hypernat.sty</a> -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>plainnat.bst</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) -<dt><tt><i>unsrtnat.bst</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) +<dt><tt><i>cite.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cite.zip">macros/latex/contrib/cite</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cite/">browse the directory</a>) +<dt><tt><i>hypernat.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/hypernat.sty">macros/latex/contrib/misc/hypernat.sty</a> +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>plainnat.bst</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) +<dt><tt><i>unsrtnat.bst</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citesort">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citesort</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cmdstar.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cmdstar.html index d25ad304643..8829ca86091 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cmdstar.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cmdstar.html @@ -62,7 +62,7 @@ definition like: </blockquote><p> <dl> <dt><tt><i>ifthen.sty</i></tt><dd>Part of the LaTeX distribution -<dt><tt><i>suffix.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) +<dt><tt><i>suffix.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) </dl> <p/> <p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=cmdstar">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=cmdstar</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-codelist.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-codelist.html index 3c949593ab1..35529469e9a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-codelist.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-codelist.html @@ -47,7 +47,7 @@ or you can have it typeset whole files: </blockquote><p> These very simple examples may be decorated in a huge variety of ways, and of course there are other languages in the package’s vocabulary -than just <i>C</i>... +than just <i>C</i>… <p/>Most people, advising others on (La)TeX lists, seem to regard <i>listings</i> as the be-all and end-all on this topic. But there <em>are</em> alternatives, which may be worth considering, in some @@ -72,13 +72,13 @@ LaTeX source in your C program comments. The program then converts your program into a LaTeX document for processing. The program (implicitly) claims to be “self-documenting”. <dl> -<dt><tt><i>c2latex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/c2latex.zip">support/c2latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/c2latex/">browse the directory</a>) -<dt><tt><i>C++2LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/C++2LaTeX-1_1pl1.zip">support/C++2LaTeX-1_1pl1</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/C++2LaTeX-1_1pl1/">browse the directory</a>) -<dt><tt><i>highlight</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/highlight.zip">support/highlight</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/highlight/">browse the directory</a>) -<dt><tt><i>lgrind</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/lgrind.zip">support/lgrind</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/lgrind/">browse the directory</a>) -<dt><tt><i>listings.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/listings.zip">macros/latex/contrib/listings</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/listings/">browse the directory</a>) -<dt><tt><i>tgrind</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tgrind.zip">support/tgrind</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tgrind/">browse the directory</a>) -<dt><tt><i>tiny_c2l</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tiny_c2l.zip">support/tiny_c2l</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tiny_c2l/">browse the directory</a>) +<dt><tt><i>c2latex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/c2latex.zip">support/c2latex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/c2latex/">browse the directory</a>) +<dt><tt><i>C++2LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/C++2LaTeX-1_1pl1.zip">support/C++2LaTeX-1_1pl1</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/C++2LaTeX-1_1pl1/">browse the directory</a>) +<dt><tt><i>highlight</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/highlight.zip">support/highlight</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/highlight/">browse the directory</a>) +<dt><tt><i>lgrind</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/lgrind.zip">support/lgrind</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/lgrind/">browse the directory</a>) +<dt><tt><i>listings.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/listings.zip">macros/latex/contrib/listings</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/listings/">browse the directory</a>) +<dt><tt><i>tgrind</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/tgrind.zip">support/tgrind</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/tgrind/">browse the directory</a>) +<dt><tt><i>tiny_c2l</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/tiny_c2l.zip">support/tiny_c2l</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/tiny_c2l/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=codelist">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=codelist</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-compactbib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-compactbib.html index 83cdbab4994..4f72dcc39f8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-compactbib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-compactbib.html @@ -27,7 +27,6 @@ BibTeX. Therefore, we need to <a href="FAQ-patch.html">patch the underlying macro</a>: <blockquote> <pre> -\let\oldbibliography\thebibliography \renewcommand{\thebibliography}[1]{% \oldbibliography{#1}% \setlength{\itemsep}{0pt}% @@ -39,10 +38,10 @@ plethora of space-saving measures: you can, in principle, suppress all its other actions, and have it provide you a compressed bibliography <em>only</em>. <dl> -<dt><tt><i>compactbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/compactbib/compactbib.sty">macros/latex/contrib/compactbib/compactbib.sty</a> -<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) -<dt><tt><i>natbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) -<dt><tt><i>savetrees.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/savetrees.zip">macros/latex/contrib/savetrees</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/savetrees/">browse the directory</a>) +<dt><tt><i>compactbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/compactbib/compactbib.sty">macros/latex/contrib/compactbib/compactbib.sty</a> +<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) +<dt><tt><i>natbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) +<dt><tt><i>savetrees.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/savetrees.zip">macros/latex/contrib/savetrees</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/savetrees/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=compactbib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=compactbib</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-complist.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-complist.html index af99daac92e..6f29d87105a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-complist.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-complist.html @@ -98,14 +98,14 @@ to set spacing between items and between paragraphs within items. more “basic” (and therefore more flexible) manner than the <a href="FAQ-enumerate.html"><i>enumerate</i> package</a> does. <dl> -<dt><tt><i>enumerate.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) -<dt><tt><i>expdlist.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expdlist.zip">macros/latex/contrib/expdlist</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expdlist/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) -<dt><tt><i>multenum.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multenum.zip">macros/latex/contrib/multenum</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multenum/">browse the directory</a>) -<dt><tt><i>paralist.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/paralist.zip">macros/latex/contrib/paralist</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/paralist/">browse the directory</a>) -<dt><tt><i>savetrees.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/savetrees.zip">macros/latex/contrib/savetrees</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/savetrees/">browse the directory</a>) +<dt><tt><i>enumerate.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) +<dt><tt><i>expdlist.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expdlist.zip">macros/latex/contrib/expdlist</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expdlist/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) +<dt><tt><i>multenum.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multenum.zip">macros/latex/contrib/multenum</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multenum/">browse the directory</a>) +<dt><tt><i>paralist.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/paralist.zip">macros/latex/contrib/paralist</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/paralist/">browse the directory</a>) +<dt><tt><i>savetrees.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/savetrees.zip">macros/latex/contrib/savetrees</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/savetrees/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=complist">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=complist</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-concrete.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-concrete.html index 86bfe9f8dd4..41554d90d28 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-concrete.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-concrete.html @@ -48,15 +48,15 @@ they are available from <a href="FAQ-psfchoice.html">MicroPress</a>. The <a href="FAQ-textrace.html">CM-Super fonts</a> contain Type 1 versions of the Concrete fonts in T1 encoding. <dl> -<dt><tt><i>beton.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/beton.zip">macros/latex/contrib/beton</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/beton/">browse the directory</a>) -<dt><tt><i>ccfonts.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccfonts.zip">macros/latex/contrib/ccfonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccfonts/">browse the directory</a>) -<dt><tt><i>CM-Super fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) -<dt><tt><i>concmath.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/concmath.zip">macros/latex/contrib/concmath</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/concmath/">browse the directory</a>) -<dt><tt><i>Concmath fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/concmath.zip">fonts/concmath</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/concmath/">browse the directory</a>) -<dt><tt><i>Concrete fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/concrete.zip">fonts/concrete</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/concrete/">browse the directory</a>) -<dt><tt><i>euler.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/euler.zip">macros/latex/contrib/euler</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/euler/">browse the directory</a>) -<dt><tt><i>eulervm bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eulervm.zip">fonts/eulervm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eulervm/">browse the directory</a>) -<dt><tt><i>gkpmac.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/knuth/local/lib/gkpmac.tex">systems/knuth/local/lib/gkpmac.tex</a> +<dt><tt><i>beton.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/beton.zip">macros/latex/contrib/beton</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/beton/">browse the directory</a>) +<dt><tt><i>ccfonts.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccfonts.zip">macros/latex/contrib/ccfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccfonts/">browse the directory</a>) +<dt><tt><i>CM-Super fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) +<dt><tt><i>concmath.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/concmath.zip">macros/latex/contrib/concmath</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/concmath/">browse the directory</a>) +<dt><tt><i>Concmath fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/concmath.zip">fonts/concmath</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/concmath/">browse the directory</a>) +<dt><tt><i>Concrete fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/concrete.zip">fonts/concrete</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/concrete/">browse the directory</a>) +<dt><tt><i>euler.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/euler.zip">macros/latex/contrib/euler</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/euler/">browse the directory</a>) +<dt><tt><i>eulervm bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/eulervm.zip">fonts/eulervm</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/eulervm/">browse the directory</a>) +<dt><tt><i>gkpmac.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/knuth/local/lib/gkpmac.tex">systems/knuth/local/lib/gkpmac.tex</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=concrete">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=concrete</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-conditional.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-conditional.html index b6aa1b47a08..30103c78d98 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-conditional.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-conditional.html @@ -150,20 +150,20 @@ an <code>extract</code> environment which you can use to create complete ready-to-run LaTeX documents with stuff you’ve extracted. <dl> <dt><tt><i>askinclude.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages — - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>comment.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/comment.zip">macros/latex/contrib/comment</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/comment/">browse the directory</a>) -<dt><tt><i>excludeonly.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/excludeonly.sty">macros/latex/contrib/misc/excludeonly.sty</a> -<dt><tt><i>extract.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/extract.zip">macros/latex/contrib/extract</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/extract/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>optional.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/optional.sty">macros/latex/contrib/misc/optional.sty</a> + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>comment.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/comment.zip">macros/latex/contrib/comment</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/comment/">browse the directory</a>) +<dt><tt><i>excludeonly.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/excludeonly.sty">macros/latex/contrib/misc/excludeonly.sty</a> +<dt><tt><i>extract.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/extract.zip">macros/latex/contrib/extract</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/extract/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>optional.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/optional.sty">macros/latex/contrib/misc/optional.sty</a> <dt><tt><i>pagesel.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages — - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>pdfpages.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdfpages.zip">macros/latex/contrib/pdfpages</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdfpages/">browse the directory</a>) -<dt><tt><i>selectp.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/selectp.sty">macros/latex/contrib/misc/selectp.sty</a> -<dt><tt><i>verbatim.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>version.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/version.sty">macros/latex/contrib/misc/version.sty</a> -<dt><tt><i>versions.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/versions/versions.sty">macros/latex/contrib/versions/versions.sty</a> -<dt><tt><i>xcomment.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/seminar.zip">macros/latex/contrib/seminar</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/seminar/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>pdfpages.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdfpages.zip">macros/latex/contrib/pdfpages</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdfpages/">browse the directory</a>) +<dt><tt><i>selectp.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/selectp.sty">macros/latex/contrib/misc/selectp.sty</a> +<dt><tt><i>verbatim.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>version.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/version.sty">macros/latex/contrib/misc/version.sty</a> +<dt><tt><i>versions.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/versions/versions.sty">macros/latex/contrib/versions/versions.sty</a> +<dt><tt><i>xcomment.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/seminar.zip">macros/latex/contrib/seminar</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/seminar/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=conditional">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=conditional</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-context.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-context.html index 7af37da0271..49539296ceb 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-context.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-context.html @@ -43,7 +43,7 @@ prodigious energy. Support is available via a <a href="http://contextgarden.net">WIKI site</a> and via the <a href="http://www.ntg.nl/mailman/listinfo/ntg-context">mailing list</a>. <dl> -<dt><tt><i>ConTeXt distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/context.zip">macros/context</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/context/">browse the directory</a>) +<dt><tt><i>ConTeXt distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/context.zip">macros/context</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/context/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=context">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=context</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-crop.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-crop.html index d7562f3743f..d081b632081 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-crop.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-crop.html @@ -13,8 +13,8 @@ facilities to satisfy any conceivable production house. Users of the <i>memoir</i> class don’t need the package, since <i>memoir</i> has its own facilities for programming crop marks. <dl> -<dt><tt><i>crop.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/crop.zip">macros/latex/contrib/crop</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/crop/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>crop.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/crop.zip">macros/latex/contrib/crop</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/crop/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=crop">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=crop</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-custbib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-custbib.html index d3e34e49a8b..6ee710d5dac 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-custbib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-custbib.html @@ -19,8 +19,8 @@ own <code>.bst</code> file. This technique doesn’t offer entirely new sty of document, but the system’s “master BibTeX styles” already offer significantly more than the BibTeX standard set. <dl> -<dt><tt><i>BibTeX documentation</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/doc.zip">biblio/bibtex/contrib/doc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/doc/">browse the directory</a>) -<dt><tt><i>makebst.tex</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/custom-bib.zip">macros/latex/contrib/custom-bib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/custom-bib/">browse the directory</a>) +<dt><tt><i>BibTeX documentation</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/doc.zip">biblio/bibtex/contrib/doc</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/doc/">browse the directory</a>) +<dt><tt><i>makebst.tex</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/custom-bib.zip">macros/latex/contrib/custom-bib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/custom-bib/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=custbib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=custbib</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cv.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cv.html index 41648d41839..294b9a306a4 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cv.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-cv.html @@ -31,12 +31,12 @@ FAQ team. Its output certainly looks good. <p/>There is also a LaTeX 2.09 package <i>resume</i>, which comes with little but advice <em>against</em> trying to use it. <dl> -<dt><tt><i>currvita.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/currvita.zip">macros/latex/contrib/currvita</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/currvita/">browse the directory</a>) -<dt><tt><i>curve.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/curve.zip">macros/latex/contrib/curve</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/curve/">browse the directory</a>) -<dt><tt><i>europecv.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/europecv.zip">macros/latex/contrib/europecv</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/europecv/">browse the directory</a>) -<dt><tt><i>moderncv.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/moderncv.zip">macros/latex/contrib/moderncv</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/moderncv/">browse the directory</a>) -<dt><tt><i>resume.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveobsolete/macros/latex209/contrib/resume/resume.sty">obsolete/macros/latex209/contrib/resume/resume.sty</a> -<dt><tt><i>vita.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/vita.zip">macros/latex/contrib/vita</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/vita/">browse the directory</a>) +<dt><tt><i>currvita.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/currvita.zip">macros/latex/contrib/currvita</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/currvita/">browse the directory</a>) +<dt><tt><i>curve.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/curve.zip">macros/latex/contrib/curve</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/curve/">browse the directory</a>) +<dt><tt><i>europecv.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/europecv.zip">macros/latex/contrib/europecv</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/europecv/">browse the directory</a>) +<dt><tt><i>moderncv.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/moderncv.zip">macros/latex/contrib/moderncv</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/moderncv/">browse the directory</a>) +<dt><tt><i>resume.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/obsolete/macros/latex209/contrib/resume/resume.sty">obsolete/macros/latex209/contrib/resume/resume.sty</a> +<dt><tt><i>vita.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/vita.zip">macros/latex/contrib/vita</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/vita/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=cv">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=cv</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dec_comma.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dec_comma.html index c1cde44104c..07856bead65 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dec_comma.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dec_comma.html @@ -33,9 +33,9 @@ group the digits of very ‘long’ numbers), but is inevitably less convenient than <i>icomma</i> or <i>ziffer</i> if you are typing a lot of numbers. <dl> -<dt><tt><i>icomma.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/was.zip">macros/latex/contrib/was</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/was/">browse the directory</a>) -<dt><tt><i>numprint.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/numprint.zip">macros/latex/contrib/numprint</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/numprint/">browse the directory</a>) -<dt><tt><i>ziffer.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ziffer.zip">macros/latex/contrib/ziffer</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ziffer/">browse the directory</a>) +<dt><tt><i>icomma.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/was.zip">macros/latex/contrib/was</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/was/">browse the directory</a>) +<dt><tt><i>numprint.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/numprint.zip">macros/latex/contrib/numprint</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/numprint/">browse the directory</a>) +<dt><tt><i>ziffer.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ziffer.zip">macros/latex/contrib/ziffer</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ziffer/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dec_comma">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dec_comma</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-destable.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-destable.html index 3f135df12c2..7ab757c942d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-destable.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-destable.html @@ -72,12 +72,12 @@ value <code>10pt</code>) and <code>\</code><code>belowcaptionskip</code> (defaul \end{table} </pre> </blockquote><p> -does the job. (The package itself is very slightly more elaborate...) +does the job. (The package itself is very slightly more elaborate…) <dl> -<dt><tt><i>booktabs.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/booktabs.zip">macros/latex/contrib/booktabs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/booktabs/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>topcapt.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/topcapt.sty">macros/latex/contrib/misc/topcapt.sty</a> +<dt><tt><i>booktabs.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/booktabs.zip">macros/latex/contrib/booktabs</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/booktabs/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>topcapt.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/topcapt.sty">macros/latex/contrib/misc/topcapt.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=destable">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=destable</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-divzero.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-divzero.html index 9c75637cdad..81e90ce4d86 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-divzero.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-divzero.html @@ -48,7 +48,7 @@ will resolve the error, and will behave as you might hope. </pre> </blockquote><p> <dl> -<dt><tt><i>graphics.sty,graphicx.sty</i></tt><dd>Both parts of the <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle +<dt><tt><i>graphics.sty,graphicx.sty</i></tt><dd>Both parts of the <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=divzero">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=divzero</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docotherdir.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docotherdir.html index 336f6561392..f8849de0a66 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docotherdir.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docotherdir.html @@ -58,8 +58,8 @@ provide a path to the file. (There are also <p/>Documentation of <i>chapterfolder</i> is in French, but the <i>README</i> in the directory is in English. <dl> -<dt><tt><i>chapterfolder.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/chapterfolder.zip">macros/latex/contrib/chapterfolder</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/chapterfolder/">browse the directory</a>) -<dt><tt><i>import.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/import.sty">macros/latex/contrib/misc/import.sty</a> +<dt><tt><i>chapterfolder.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/chapterfolder.zip">macros/latex/contrib/chapterfolder</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/chapterfolder/">browse the directory</a>) +<dt><tt><i>import.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/import.sty">macros/latex/contrib/misc/import.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=docotherdir">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=docotherdir</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docpictex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docpictex.html index 8d9776c5cf6..a4a33793dc3 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docpictex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-docpictex.html @@ -14,9 +14,9 @@ manual is <em>not</em> available electronically. CTAN, which is a great aide-memoire for those who basically know the package to start with. <dl> -<dt><tt><i>pictex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pictex.zip">graphics/pictex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pictex/">browse the directory</a>) -<dt><tt><i>PiCTeX summary</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/pictex/summary.zip">info/pictex/summary</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/pictex/summary/">browse the directory</a>) +<dt><tt><i>pictex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/pictex.zip">graphics/pictex</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pictex/">browse the directory</a>) +<dt><tt><i>PiCTeX summary</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/pictex/summary.zip">info/pictex/summary</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/pictex/summary/">browse the directory</a>) </dl> -<p/> + <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=docpictex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=docpictex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dolldoll.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dolldoll.html index 3c4ccb76671..f3a5438fc1a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dolldoll.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dolldoll.html @@ -1,11 +1,10 @@ <head> <title>UK TeX FAQ -- question label dolldoll</title> </head><body> -<h3>Why use <code>\</code><code>[</code> ...<code>\</code><code>]</code> in place of <code>$$</code> ...<code>$$</code>?</h3> +<h3>Why use <code>\</code><code>[</code> …<code>\</code><code>]</code> in place of <code>$$</code> …<code>$$</code>?</h3> <p/>LaTeX defines inline- and display-maths commands, apparently -analogous to those that derive from the TeX primitive maths -sequences bracketing maths commands with single dollar signs (or pairs -of dollar signs). +s those that derive from the TeX primitive maths +sequences bracketing maths commands with single (or pairs of) dollar signs. <p/>As it turns out, LaTeX’s inline maths grouping, <code>\</code><code>(</code><code> ... </code><code>\</code><code>)</code>, has precisely the same effect as the TeX primitive version <code>$ ... $</code>. (Except that @@ -21,13 +20,13 @@ obvious way this turns up, is that the class option <code>fleqn</code> simply does not work for equations coded using <code>$$ ... $$</code>, whether you’re using the standard classes alone, or using package <i>amsmath</i>. Also, the <code>\</code><code>[</code> and -<code>\</code><code>]</code> has code for rationalising vertical spacing in some extreme +<code>\</code><code>]</code> construct has code for rationalising vertical spacing in some extreme cases; that code is not available in <code>$$ ... $$</code>, so if you use the non-standard version, you may occasionally observe inconsistent vertical spacing . <p/>There are more subtle effects (especially with package -<i>amsmath</i>), and the simple rule is -<code>\</code><code>[</code><code> ... </code><code>\</code><code>]</code> whenever -unadorned displayed maths is needed in LaTeX. +<i>amsmath</i>), and the simple rule is “use +<code>\</code><code>[</code><code> ... </code><code>\</code><code>]</code> whenever displayed maths is needed in +LaTeX”. <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dolldoll">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dolldoll</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dpfloat.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dpfloat.html index 38a140ed293..756bea55c1c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dpfloat.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dpfloat.html @@ -25,7 +25,7 @@ The construction has no effect unless the standard class option <p/>Full documentation of the package (such as it is) is to be found in <i>README.dpfloat</i> <dl> -<dt><tt><i>dpfloat.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/dpfloat.zip">macros/latex/contrib/dpfloat</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/dpfloat/">browse the directory</a>) +<dt><tt><i>dpfloat.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/dpfloat.zip">macros/latex/contrib/dpfloat</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/dpfloat/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dpfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dpfloat</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawFeyn.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawFeyn.html index 5b36261fa5e..e51e84cde3a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawFeyn.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawFeyn.html @@ -25,10 +25,10 @@ fragments, which you can compose to produce complete diagrams. It offers fairly simple diagrams which look good in equations, rather than complicated ones more suitable for display in figures. <dl> -<dt><tt><i>axodraw</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/axodraw.zip">graphics/axodraw</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/axodraw/">browse the directory</a>) -<dt><tt><i>feyn font bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/feyn.zip">fonts/feyn</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/feyn/">browse the directory</a>) -<dt><tt><i>feynman bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex209/contrib/feynman.zip">macros/latex209/contrib/feynman</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex209/contrib/feynman/">browse the directory</a>) -<dt><tt><i>feynmf/feynmp bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/feynmf.zip">macros/latex/contrib/feynmf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/feynmf/">browse the directory</a>) +<dt><tt><i>axodraw</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/axodraw.zip">graphics/axodraw</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/axodraw/">browse the directory</a>) +<dt><tt><i>feyn font bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/feyn.zip">fonts/feyn</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/feyn/">browse the directory</a>) +<dt><tt><i>feynman bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/feynman.zip">macros/latex209/contrib/feynman</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/feynman/">browse the directory</a>) +<dt><tt><i>feynmf/feynmp bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/feynmf.zip">macros/latex/contrib/feynmf</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/feynmf/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=drawFeyn">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=drawFeyn</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawing.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawing.html index a541f5b6bfb..422c1df4074 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawing.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-drawing.html @@ -62,7 +62,7 @@ of drawing, and setup, here are a few systems you may consider: Try <a href="FAQ-MP.html">MetaPost</a> — all the power of Metafont, but it generates PostScript figures; MetaPost is nowadays part of most serious (La)TeX distributions. Knuth - uses it for all his work... + uses it for all his work… <li> <i>Mfpic</i>; you liked Metafont, but can’t understand the language? The package makes up Metafont or MetaPost code for you within using familiar-looking TeX macros. Not <em>quite</em> the @@ -76,19 +76,19 @@ of drawing, and setup, here are a few systems you may consider: readable (and is fully documented). </ul> <dl> -<dt><tt><i>dratex.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/dratex.zip">graphics/dratex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/dratex/">browse the directory</a>) -<dt><tt><i>epic.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/epic.zip">macros/latex/contrib/epic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/epic/">browse the directory</a>) -<dt><tt><i>eepic.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eepic.zip">macros/latex/contrib/eepic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eepic/">browse the directory</a>) -<dt><tt><i>eepicemu.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eepic.zip">macros/latex/contrib/eepic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eepic/">browse the directory</a>) -<dt><tt><i>mfpic</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/mfpic.zip">graphics/mfpic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/mfpic/">browse the directory</a>) -<dt><tt><i>preview.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/preview.zip">macros/latex/contrib/preview</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/preview/">browse the directory</a>) -<dt><tt><i>pspicture.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pspicture.zip">macros/latex/contrib/pspicture</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pspicture/">browse the directory</a>) -<dt><tt><i>pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pst-pdf.zip">macros/latex/contrib/pst-pdf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pst-pdf/">browse the directory</a>) -<dt><tt><i>pgf.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf/">browse the directory</a>) -<dt><tt><i>pict2e.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pict2e.zip">macros/latex/contrib/pict2e</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pict2e/">browse the directory</a>) -<dt><tt><i>pictex.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pictex.zip">graphics/pictex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pictex/">browse the directory</a>) -<dt><tt><i>pstricks</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pstricks.zip">graphics/pstricks</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pstricks/">browse the directory</a>) -<dt><tt><i>tikz.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf/">browse the directory</a>) +<dt><tt><i>dratex.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/dratex.zip">graphics/dratex</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/dratex/">browse the directory</a>) +<dt><tt><i>epic.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/epic.zip">macros/latex/contrib/epic</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/epic/">browse the directory</a>) +<dt><tt><i>eepic.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eepic.zip">macros/latex/contrib/eepic</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eepic/">browse the directory</a>) +<dt><tt><i>eepicemu.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eepic.zip">macros/latex/contrib/eepic</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eepic/">browse the directory</a>) +<dt><tt><i>mfpic</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/mfpic.zip">graphics/mfpic</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/mfpic/">browse the directory</a>) +<dt><tt><i>preview.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/preview.zip">macros/latex/contrib/preview</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/preview/">browse the directory</a>) +<dt><tt><i>pspicture.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pspicture.zip">macros/latex/contrib/pspicture</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pspicture/">browse the directory</a>) +<dt><tt><i>pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pst-pdf.zip">macros/latex/contrib/pst-pdf</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pst-pdf/">browse the directory</a>) +<dt><tt><i>pgf.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pgf/">browse the directory</a>) +<dt><tt><i>pict2e.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pict2e.zip">macros/latex/contrib/pict2e</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pict2e/">browse the directory</a>) +<dt><tt><i>pictex.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/pictex.zip">graphics/pictex</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pictex/">browse the directory</a>) +<dt><tt><i>pstricks</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/pstricks.zip">graphics/pstricks</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pstricks/">browse the directory</a>) +<dt><tt><i>tikz.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pgf/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=drawing">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=drawing</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dropping.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dropping.html index f58f8b286fd..36609a74587 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dropping.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dropping.html @@ -23,8 +23,8 @@ deprecated, nowadays. It has a well-constructed array of options, and an impressive set of examples adds to the package’s document. <dl> -<dt><tt><i>dropping</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/dropping.zip">macros/latex/contrib/dropping</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/dropping/">browse the directory</a>) -<dt><tt><i>lettrine</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lettrine.zip">macros/latex/contrib/lettrine</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lettrine/">browse the directory</a>) +<dt><tt><i>dropping</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/dropping.zip">macros/latex/contrib/dropping</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/dropping/">browse the directory</a>) +<dt><tt><i>lettrine</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lettrine.zip">macros/latex/contrib/lettrine</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lettrine/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dropping">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dropping</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dtx.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dtx.html index ff2da9b05b3..0a839e31d22 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dtx.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dtx.html @@ -43,11 +43,11 @@ package to thus permitting documented distribution of bundles containing code for Metafont and MetaPost together with related LaTeX code. <dl> -<dt><tt><i>clsguide.pdf</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/doc/clsguide.pdf">macros/latex/doc/clsguide.pdf</a> -<dt><tt><i>docmfp.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/docmfp.zip">macros/latex/contrib/docmfp</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/docmfp/">browse the directory</a>) +<dt><tt><i>clsguide.pdf</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/doc/clsguide.pdf">macros/latex/doc/clsguide.pdf</a> +<dt><tt><i>docmfp.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/docmfp.zip">macros/latex/contrib/docmfp</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/docmfp/">browse the directory</a>) <dt><tt><i>docstrip.tex</i></tt><dd>Part of the LaTeX distribution -<dt><tt><i>DTX tutorial</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/dtxtut.zip">info/dtxtut</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/dtxtut/">browse the directory</a>) -<dt><tt><i>makedtx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/makedtx.zip">support/makedtx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/makedtx/">browse the directory</a>) +<dt><tt><i>DTX tutorial</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/dtxtut.zip">info/dtxtut</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/dtxtut/">browse the directory</a>) +<dt><tt><i>makedtx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/makedtx.zip">support/makedtx</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/makedtx/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dtx">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dtx</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi-bmp.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi-bmp.html index 682f5bf0660..fe04daa45f2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi-bmp.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi-bmp.html @@ -42,8 +42,8 @@ web-oriented environments. Note that <i>dvipng</i> gives high-quality output even though its internal operations are optimised for speed. <dl> -<dt><tt><i>dvi2bitmap</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvi2bitmap.zip">dviware/dvi2bitmap</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvi2bitmap/">browse the directory</a>) -<dt><tt><i>dvipng</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipng.zip">dviware/dvipng</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipng/">browse the directory</a>) +<dt><tt><i>dvi2bitmap</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvi2bitmap.zip">dviware/dvi2bitmap</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvi2bitmap/">browse the directory</a>) +<dt><tt><i>dvipng</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvipng.zip">dviware/dvipng</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvipng/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvi-bmp">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvi-bmp</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi.html index 743f414dcce..ed120dff797 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvi.html @@ -22,7 +22,7 @@ possibly material to be introduced by means of source of Knuth’s program <i>dvitype</i> (whose original purpose, as its name implies, was to view the content of a DVI file). <dl> -<dt><tt><i>dvitype</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/knuth/dist/texware/dvitype.web">systems/knuth/dist/texware/dvitype.web</a> +<dt><tt><i>dvitype</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/knuth/dist/texware/dvitype.web">systems/knuth/dist/texware/dvitype.web</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvi">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvi</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipdfmgraphics.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipdfmgraphics.html index e962230257b..c9537b69397 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipdfmgraphics.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipdfmgraphics.html @@ -58,9 +58,9 @@ don’t ordinarily need to specify the fact, since the default graphics configuration file (of most distributions) “guesses” the <code>dvips</code> option if you’re using TeX. <dl> -<dt><tt><i>dvipdfm</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfm.zip">dviware/dvipdfm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfm/">browse the directory</a>) -<dt><tt><i>dvipdfmx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfmx.zip">dviware/dvipdfmx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfmx/">browse the directory</a>) -<dt><tt><i>ebb</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfm.zip">dviware/dvipdfm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvipdfm/">browse the directory</a>) +<dt><tt><i>dvipdfm</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfm.zip">dviware/dvipdfm</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfm/">browse the directory</a>) +<dt><tt><i>dvipdfmx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfmx.zip">dviware/dvipdfmx</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfmx/">browse the directory</a>) +<dt><tt><i>ebb</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfm.zip">dviware/dvipdfm</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvipdfm/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvipdfmgraphics">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvipdfmgraphics</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips-pdf.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips-pdf.html index 3ad634b39ac..9da7380561b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips-pdf.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips-pdf.html @@ -40,7 +40,7 @@ come. Shell’s <i>testflow</i> package, which these FAQs recommend as a “<a href="FAQ-tutbitslatex.html">specialised tutorial</a>. <dl> -<dt><tt><i>testflow</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/IEEEtran/testflow/">macros/latex/contrib/IEEEtran/testflow/</a> +<dt><tt><i>testflow</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/IEEEtran/testflow/">macros/latex/contrib/IEEEtran/testflow/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvips-pdf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvips-pdf</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips.html index 10f7e879ecd..115b02312e0 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvips.html @@ -14,8 +14,8 @@ distribution of TeX for VMS. <p/>A precompiled version to work with emTeX is available on CTAN. <dl> <dt><tt><i>MSDOS and OS/2</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/dviware/dvips.zip">systems/msdos/dviware/dvips</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/dviware/dvips/">browse the directory</a>) -<dt><tt><i>VMS distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/OpenVMS/TEX97_CTAN.ZIP">systems/OpenVMS/TEX97_CTAN.ZIP</a> + <a href="http://www.tex.ac.uk/tex-archive/systems/msdos/dviware/dvips.zip">systems/msdos/dviware/dvips</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/msdos/dviware/dvips/">browse the directory</a>) +<dt><tt><i>VMS distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/OpenVMS/TEX97_CTAN.ZIP">systems/OpenVMS/TEX97_CTAN.ZIP</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvips">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvips</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipsgraphics.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipsgraphics.html index 7f68af65f8c..d645229c75c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipsgraphics.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-dvipsgraphics.html @@ -32,10 +32,10 @@ assuming that capability destroys portability, and is only recommendable if you are sure you will never want to share your document. <dl> -<dt><tt><i>a2ping</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/a2ping.zip">graphics/a2ping</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/a2ping/">browse the directory</a>) -<dt><tt><i>bmeps</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/bmeps.zip">support/bmeps</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/bmeps/">browse the directory</a>) -<dt><tt><i>jpeg2ps</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/jpeg2ps.zip">support/jpeg2ps</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/jpeg2ps/">browse the directory</a>) -<dt><tt><i>sam2p</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/sam2p.zip">graphics/sam2p</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/sam2p/">browse the directory</a>) +<dt><tt><i>a2ping</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/a2ping/">graphics/a2ping/</a> +<dt><tt><i>bmeps</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/bmeps.zip">support/bmeps</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/bmeps/">browse the directory</a>) +<dt><tt><i>jpeg2ps</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/jpeg2ps.zip">support/jpeg2ps</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/jpeg2ps/">browse the directory</a>) +<dt><tt><i>sam2p</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/sam2p.zip">graphics/sam2p</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/sam2p/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvipsgraphics">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dvipsgraphics</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-editors.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-editors.html index 4173da13c93..f912a03fdbb 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-editors.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-editors.html @@ -90,15 +90,15 @@ access to your BibTeX files — see “<a href="FAQ-buildbib.html">creating a bibliography file</a>”. <dl> -<dt><tt><i>alpha</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivenonfree/systems/mac/support/alpha/">nonfree/systems/mac/support/alpha/</a> -<dt><tt><i>auctex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/auctex/">support/auctex/</a> -<dt><tt><i>epmtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/os2/epmtex.zip">systems/os2/epmtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/os2/epmtex/">browse the directory</a>) -<dt><tt><i>LaTeX4Jed</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/jed.zip">support/jed</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/jed/">browse the directory</a>) -<dt><tt><i>Nedit LaTeX support</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/NEdit-LaTeX-Extensions.zip">support/NEdit-LaTeX-Extensions</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/NEdit-LaTeX-Extensions/">browse the directory</a>) -<dt><tt><i>TeXnicCenter</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/TeXnicCenter/">systems/win32/TeXnicCenter/</a> -<dt><tt><i>TeXshell</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/texshell.zip">systems/msdos/texshell</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/texshell/">browse the directory</a>) -<dt><tt><i>TeXtelmExtel</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/msdos/emtex-contrib/TeXtelmExtel/">systems/msdos/emtex-contrib/TeXtelmExtel/</a> -<dt><tt><i>winedt</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/winedt/">systems/win32/winedt/</a> +<dt><tt><i>alpha</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/support/alpha/">systems/mac/support/alpha/</a> +<dt><tt><i>auctex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/auctex/">support/auctex/</a> +<dt><tt><i>epmtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/os2/epmtex.zip">systems/os2/epmtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/os2/epmtex/">browse the directory</a>) +<dt><tt><i>LaTeX4Jed</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/jed.zip">support/jed</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/jed/">browse the directory</a>) +<dt><tt><i>Nedit LaTeX support</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/NEdit-LaTeX-Extensions.zip">support/NEdit-LaTeX-Extensions</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/NEdit-LaTeX-Extensions/">browse the directory</a>) +<dt><tt><i>TeXnicCenter</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/win32/TeXnicCenter/">systems/win32/TeXnicCenter/</a> +<dt><tt><i>TeXshell</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/msdos/texshell.zip">systems/msdos/texshell</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/msdos/texshell/">browse the directory</a>) +<dt><tt><i>TeXtelmExtel</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/msdos/emtex-contrib/TeXtelmExtel/">systems/msdos/emtex-contrib/TeXtelmExtel/</a> +<dt><tt><i>winedt</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/win32/winedt/">systems/win32/winedt/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=editors">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=editors</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-empty.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-empty.html index ead243c365e..067680f0e85 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-empty.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-empty.html @@ -29,9 +29,9 @@ third argument. The package’s code also appears in the LaTeX issue in number two of the “around the bend” articles by the late lamented Mike Downes. <dl> -<dt><tt><i>Around the bend series</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/challenges/aro-bend.zip">info/challenges/aro-bend</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/challenges/aro-bend/">browse the directory</a>) -<dt><tt><i>ifmtarg.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/ifmtarg.sty">macros/latex/contrib/misc/ifmtarg.sty</a> -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>Around the bend series</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/challenges/aro-bend.zip">info/challenges/aro-bend</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/challenges/aro-bend/">browse the directory</a>) +<dt><tt><i>ifmtarg.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/ifmtarg.sty">macros/latex/contrib/misc/ifmtarg.sty</a> +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=empty">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=empty</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-endingroup.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-endingroup.html index 5f8eb472976..a2a3b776cc6 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-endingroup.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-endingroup.html @@ -63,7 +63,7 @@ The diagnostic not only tells us where the group started, but also the <code>\</code><code>bgroup</code>, and the two are not distinguishable at the TeX-engine level). <dl> -<dt><tt><i>checkend.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bezos.zip">macros/latex/contrib/bezos</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bezos/">browse the directory</a>) +<dt><tt><i>checkend.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bezos.zip">macros/latex/contrib/bezos</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bezos/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=endingroup">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=endingroup</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-enumerate.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-enumerate.html index d6a2196f96f..e88fd3b7053 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-enumerate.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-enumerate.html @@ -19,7 +19,7 @@ for example \end{enumerate} </pre> </blockquote><p> -starts a list whose labels run (a), (b), (c), ...; while +starts a list whose labels run (a), (b), (c), …; while <blockquote> <pre> \usepackage{enumerate} @@ -29,7 +29,7 @@ starts a list whose labels run (a), (b), (c), ...; while \end{enumerate} </pre> </blockquote><p> -starts a list whose labels run I/, II/, III/, ... +starts a list whose labels run I/, II/, III/, … <p/>The <i>paralist</i> package, whose primary purpose is <a href="FAQ-complist.html">compaction of lists</a>, provides the same facilities for its <code>enumerate</code>-like environments. @@ -80,10 +80,10 @@ to make references to the list items format appear as (i), (ii), <dl> -<dt><tt><i>enumerate.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>paralist.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/paralist.zip">macros/latex/contrib/paralist</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/paralist/">browse the directory</a>) +<dt><tt><i>enumerate.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>paralist.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/paralist.zip">macros/latex/contrib/paralist</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/paralist/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=enumerate">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=enumerate</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-epigraph.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-epigraph.html index eec51dad4d0..c71346ed210 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-epigraph.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-epigraph.html @@ -52,7 +52,7 @@ author recommends <code>70pt</code>. chapter header (necessary if you’ve found a hugely long quotation for an <code>\</code><code>epigraphhead</code>), for patching the bibliography, for patching <code>\</code><code>part</code> pages, and so on. (Some of these suggested patches lead you -through writing your own package...) +through writing your own package…) <p/>The <i>quotchap</i> package redefines chapter headings (in a moderately striking way), and provides an environment <code>savequotes</code> in which you can provide one (or more) @@ -63,10 +63,10 @@ as those of <i>epigraph</i>, but it’s probably easier to use. commands <code>\</code><code>setchapterpreamble</code> and <code>\</code><code>dictum</code> to provide these facilities. <dl> -<dt><tt><i>epigraph.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/epigraph.zip">macros/latex/contrib/epigraph</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/epigraph/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>quotchap.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/quotchap.zip">macros/latex/contrib/quotchap</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/quotchap/">browse the directory</a>) +<dt><tt><i>epigraph.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/epigraph.zip">macros/latex/contrib/epigraph</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/epigraph/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>quotchap.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/quotchap.zip">macros/latex/contrib/quotchap</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/quotchap/">browse the directory</a>) </dl> <p/> <p/> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eplain.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eplain.html index f7ffebe97fc..4ccda2bdc9b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eplain.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eplain.html @@ -45,7 +45,7 @@ available online, and there’s also a mailing list — sign up, or browse the list archives, via <a href="http://tug.org/mailman/listinfo/tex-eplain">http://tug.org/mailman/listinfo/tex-eplain</a> <dl> -<dt><tt><i>Eplain distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/eplain.zip">macros/eplain</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/eplain/">browse the directory</a>) +<dt><tt><i>Eplain distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/eplain.zip">macros/eplain</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/eplain/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=eplain">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=eplain</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eqnarray.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eqnarray.html index 289e2d3bc6a..862b17b9d3c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eqnarray.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-eqnarray.html @@ -31,8 +31,11 @@ greater things), code as: \end{align} </pre> </blockquote><p> +The matter is discussed in more detail in a +<a href="http://tug.org/pracjourn/2006-4/madsen/madsen.pdf">PracTeX journal paper</a> +by Lars Madsen. <dl> -<dt><tt><i>AMSLaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>AMSLaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=eqnarray">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=eqnarray</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-erroradvice.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-erroradvice.html index 8bef190c72e..3510b490da9 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-erroradvice.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-erroradvice.html @@ -65,7 +65,7 @@ appeal to the <a href="FAQ-gethelp.html">wider public</a> for assistance, but if you do, be sure to report full backtraces (see <code>errorcontextlines</code> above) and so on. <dl> -<dt><tt><i>trace.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>trace.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=erroradvice">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=erroradvice</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-euro.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-euro.html index 76a752be089..f841608a906 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-euro.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-euro.html @@ -17,7 +17,7 @@ of faces as do the EC fonts themselves. The <i>textcomp</i> package provides a <code>\</code><code>texteuro</code> command for accessing the symbol, which selects a symbol to match the surrounding text. The design of the symbol in the TC fonts is not -universally loved... +universally loved… Nevertheless, use the TC font version of the symbol if you are producing documents using Knuth’s Computer Modern Fonts. <p/>The <i>latin9</i> input encoding defined by the <i>inputenc</i> @@ -71,13 +71,13 @@ good things. <i>china2e</i> (whose primary aim is Chinese dates and suchlike matters) and the <i>eurosym</i> fonts. <dl> -<dt><tt><i>china2e bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/china2e.zip">macros/latex/contrib/china2e</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/china2e/">browse the directory</a>) -<dt><tt><i>EC fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ec.zip">fonts/ec</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ec/">browse the directory</a>) -<dt><tt><i>euro fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/euro.zip">fonts/euro</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/euro/">browse the directory</a>) -<dt><tt><i>euro-ce fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/euro-ce.zip">fonts/euro-ce</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/euro-ce/">browse the directory</a>) -<dt><tt><i>eurofont.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eurofont.zip">macros/latex/contrib/eurofont</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eurofont/">browse the directory</a>) -<dt><tt><i>eurosym fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eurosym.zip">fonts/eurosym</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eurosym/">browse the directory</a>) -<dt><tt><i>marvosym fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/psfonts/marvosym.zip">fonts/psfonts/marvosym</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/psfonts/marvosym/">browse the directory</a>) +<dt><tt><i>china2e bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/china2e.zip">macros/latex/contrib/china2e</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/china2e/">browse the directory</a>) +<dt><tt><i>EC fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ec.zip">fonts/ec</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ec/">browse the directory</a>) +<dt><tt><i>euro fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/euro.zip">fonts/euro</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/euro/">browse the directory</a>) +<dt><tt><i>euro-ce fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/euro-ce.zip">fonts/euro-ce</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/euro-ce/">browse the directory</a>) +<dt><tt><i>eurofont.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eurofont.zip">macros/latex/contrib/eurofont</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eurofont/">browse the directory</a>) +<dt><tt><i>eurosym fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/eurosym.zip">fonts/eurosym</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/eurosym/">browse the directory</a>) +<dt><tt><i>marvosym fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/psfonts/marvosym.zip">fonts/psfonts/marvosym</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/psfonts/marvosym/">browse the directory</a>) <dt><tt><i>textcomp.sty</i></tt><dd>Part of the LaTeX distribution. </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=euro">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=euro</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extref.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extref.html index 21d5af5a421..47d2299e8ad 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extref.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extref.html @@ -79,10 +79,10 @@ The module provides all the facilities of the older packages, and can deal both with “traditional” LaTeX labels and with <i>zref</i>’s style of labels. <dl> -<dt><tt><i>xr.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>xr-hyper.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>xr.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>xr-hyper.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) <dt><tt><i>zref bundle</i></tt><dd>Distributed as part of - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=extref">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=extref</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extsizes.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extsizes.html index 8ee78f010fd..1735b058661 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extsizes.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-extsizes.html @@ -22,9 +22,9 @@ designed to work properly with the class option files that come with options for document font sizes 9pt–12pt, 14pt, 17pt, 20pt, 25pt, 30pt, 36pt, 48pt and 60pt. <dl> -<dt><tt><i>extsizes bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/extsizes.zip">macros/latex/contrib/extsizes</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/extsizes/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>extsizes bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/extsizes.zip">macros/latex/contrib/extsizes</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/extsizes/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=extsizes">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=extsizes</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fancyhdr.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fancyhdr.html index 886edefe28b..40c14ef49c7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fancyhdr.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fancyhdr.html @@ -15,7 +15,7 @@ simple mechanisms for defining pretty much every head- or footline variation you could want; the directory also contains some documentation and one or two smaller packages. <i>Fancyhdr</i> also deals with the tedious behaviour of the standard styles with -<a href="FAQ-psatempty.html">initial pages</a>, by enabling you to define +<a href="FAQ-nopageno.html">initial pages</a>, by enabling you to define different page styles for initial and for body pages. <p/>While <i>fancyhdr</i> will work with <i>KOMA-script</i> classes, an alternative package, <i>scrpage2</i>, eases integration with the @@ -30,9 +30,9 @@ in a separate file; documentation of <i>scrpage2</i> is integrated with the <i>scrgui*</i> documentation files that are distributed with the <i>KOMA-script</i> classes. <dl> -<dt><tt><i>fancyhdr.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>fancyhdr.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fancyhdr">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fancyhdr</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-figurehere.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-figurehere.html index 6b2393bbe92..1e64ab3c2ae 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-figurehere.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-figurehere.html @@ -63,10 +63,10 @@ command: </blockquote><p> and the sequence of float numbers is all correct. <dl> -<dt><tt><i>capt-of.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/capt-of.sty">macros/latex/contrib/misc/capt-of.sty</a> -<dt><tt><i>caption.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/caption.zip">macros/latex/contrib/caption</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/caption/">browse the directory</a>) -<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float/">browse the directory</a>) -<dt><tt><i>perpage.sty</i></tt><dd>Distributed as part <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) +<dt><tt><i>capt-of.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/capt-of.sty">macros/latex/contrib/misc/capt-of.sty</a> +<dt><tt><i>caption.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/caption.zip">macros/latex/contrib/caption</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/caption/">browse the directory</a>) +<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float/">browse the directory</a>) +<dt><tt><i>perpage.sty</i></tt><dd>Distributed as part <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filename.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filename.html index 6947b5a95bb..74dbc3cf38a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filename.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filename.html @@ -3,7 +3,7 @@ </head><body> <h3>What’s the name of this file</h3> <p/>One might want this so as to automatically generate a page header or -footer recording what file is being processed. It’s not easy... +footer recording what file is being processed. It’s not easy… <p/>TeX retains what it considers the name of the <em>job</em>, only, in the primitive <code>\</code><code>jobname</code>; this is the name of the file first handed to TeX, stripped of its directory name and of any extension @@ -25,7 +25,6 @@ the job is almost trivial: <blockquote> <pre> \def\ThisFile{\jobname} -\let\OldInput\input \renewcommand{\input}[1]{% \renewcommand{\ThisFile}{#1}% \OldInput{#1}% @@ -45,7 +44,6 @@ previous file was before returning. <pre> \def\ThisFile{\jobname} \newcounter{FileStack} -\let\OrigInput\input \renewcommand{\input}[1]{% \stackinput{#1}{\OrigInput}% } @@ -66,7 +64,6 @@ previous file was before returning. To do the same for <code>\</code><code>include</code>, we need the simple addition: <blockquote> <pre> -\let\OrigInclude\include \renewcommand{\include}[1]{% \stackinput{#1}{\OrigInclude}% } @@ -88,7 +85,7 @@ name (without its ‘<code>.tex</code>’), use the commands: The <i>FiNK</i> bundle includes a <i>fink.el</i> that provides support under <i>emacs</i> with AUC-TeX. <dl> -<dt><tt><i>fink.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fink.zip">macros/latex/contrib/fink</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fink/">browse the directory</a>) +<dt><tt><i>fink.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fink.zip">macros/latex/contrib/fink</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fink/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=filename">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=filename</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filesused.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filesused.html index 48a43e2f463..abd9bdaa00c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filesused.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filesused.html @@ -35,8 +35,8 @@ document; it comes with configuration files for use with <i>teTeX</i> and <i>MiKTeX</i>. It’s plainly useful when you’re sending the first copy of a document. <dl> -<dt><tt><i>bundledoc</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/bundledoc.zip">support/bundledoc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/bundledoc/">browse the directory</a>) -<dt><tt><i>snapshot.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/snapshot.zip">macros/latex/contrib/snapshot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/snapshot/">browse the directory</a>) +<dt><tt><i>bundledoc</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/bundledoc.zip">support/bundledoc</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/bundledoc/">browse the directory</a>) +<dt><tt><i>snapshot.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/snapshot.zip">macros/latex/contrib/snapshot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/snapshot/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=filesused">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=filesused</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfiles.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfiles.html index 7e6bbc10c58..e708d20f520 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfiles.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfiles.html @@ -54,8 +54,8 @@ keep an eye on the changes on the archive. Since these files are updated only once a day, a nightly automatic download (perhaps using <i>rsync</i>) makes good sense. <dl> -<dt><tt><i>FILES.byname</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveFILES.byname">FILES.byname</a> -<dt><tt><i>FILES.last07days</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveFILES.last07days">FILES.last07days</a> +<dt><tt><i>FILES.byname</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/FILES.byname">FILES.byname</a> +<dt><tt><i>FILES.last07days</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/FILES.last07days">FILES.last07days</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=findfiles">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=findfiles</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfont.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfont.html index 07e87699760..4865441c532 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfont.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-findfont.html @@ -21,7 +21,7 @@ fonts that are configured for general (both textual and mathematical) use with (La)TeX. The list of such fonts is sufficiently short that they <em>can</em> all be discussed in one answer here. <dl> -<dt><tt><i>Metafont font list</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/metafont-list">info/metafont-list</a> +<dt><tt><i>Metafont font list</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/metafont-list">info/metafont-list</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=findfont">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=findfont</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fixwidtab.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fixwidtab.html index 6a781cf4208..13691993be0 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fixwidtab.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fixwidtab.html @@ -45,9 +45,9 @@ should process using LaTeX. Processing will give you a <i>.sty</i> file as well as the <i>.dvi</i> or <i>.pdf</i> output containing the documentation. <dl> -<dt><tt><i>ltxtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) -<dt><tt><i>tabularx.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>tabulary.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tabulary.zip">macros/latex/contrib/tabulary</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tabulary/">browse the directory</a>) +<dt><tt><i>ltxtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) +<dt><tt><i>tabularx.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>tabulary.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tabulary.zip">macros/latex/contrib/tabulary</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tabulary/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fixwidtab">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fixwidtab</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fllost.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fllost.html index 9d2d936517b..b48b61e4f00 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fllost.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fllost.html @@ -23,6 +23,6 @@ command(s), so the techniques of called into play. <p/>This author has also encountered the error when developing macros that used the LaTeX internal float mechanisms. Most people doing that -sort of thing are expected to be able to work out their own problems... +sort of thing are expected to be able to work out their own problems… <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fllost">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fllost</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-floats.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-floats.html index 2883465ec02..9f29c9791e1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-floats.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-floats.html @@ -26,7 +26,7 @@ equally well to tables, or to “non-standard” floats defined by the omit the ‘<code>p</code>’: doing so could cause LaTeX to believe that if you can’t have your figure <em>here</em>, you don’t want it <em>anywhere</em>. (LaTeX does try hard to avoid being confused in - this way...) + this way…) <li> LaTeX’s own float placement parameters could be preventing placements that seem entirely “reasonable” to you — they’re notoriously rather conservative. To encourage LaTeX not to move @@ -80,12 +80,12 @@ equally well to tables, or to “non-standard” floats defined by the the job for you. </ul> <dl> -<dt><tt><i>afterpage.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>endfloat.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/endfloat.zip">macros/latex/contrib/endfloat</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/endfloat/">browse the directory</a>) +<dt><tt><i>afterpage.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>endfloat.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/endfloat.zip">macros/latex/contrib/endfloat</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/endfloat/">browse the directory</a>) <dt><tt><i>flafter.sty</i></tt><dd>Part of the LaTeX distribution -<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float/">browse the directory</a>) -<dt><tt><i>morefloats.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/morefloats.sty">macros/latex/contrib/misc/morefloats.sty</a> -<dt><tt><i>placeins.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/placeins.zip">macros/latex/contrib/placeins</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/placeins/">browse the directory</a>) +<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float/">browse the directory</a>) +<dt><tt><i>morefloats.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/morefloats.sty">macros/latex/contrib/misc/morefloats.sty</a> +<dt><tt><i>placeins.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/placeins.zip">macros/latex/contrib/placeins</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/placeins/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-flushboth.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-flushboth.html index 1cbd16ad8e0..4b71a2e8d7e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-flushboth.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-flushboth.html @@ -29,7 +29,7 @@ package has a <code>\</code><code>justifying</code> command to match its package also provides a <code>justify</code> environment, which permits areas of justified text in a larger area which is ragged. <dl> -<dt><tt><i>ragged2e.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms/">browse the directory</a>) +<dt><tt><i>ragged2e.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms/">browse the directory</a>) </dl> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fmtconv.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fmtconv.html index f75dad32b2d..409f9348eef 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fmtconv.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fmtconv.html @@ -8,7 +8,7 @@ <code>-ms</code> and <code>-man</code> macros, plus most <i>eqn</i> and some <i>tbl</i> preprocessor commands. Anything fancier needs to be done by hand. Two style files are provided. There is also a man page - (which converts very well to LaTeX...). + (which converts very well to LaTeX…). <i>Tr2latex</i> is an enhanced version of the earlier <i>troff-to-latex</i> (which is no longer available). <p/> @@ -78,19 +78,19 @@ translated to or from this one. <i>FrameMaker</i> provides “import filters” to aid translation from alien formats (presumably including TeX) to <i>FrameMaker</i>’s own. <dl> -<dt><tt><i>excel2latex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/excel2latex.zip">support/excel2latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/excel2latex/">browse the directory</a>) -<dt><tt><i>pcwritex.arc</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pcwritex.zip">support/pcwritex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pcwritex/">browse the directory</a>) -<dt><tt><i>refer and tib tools</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/refer-tools.zip">biblio/bibtex/utils/refer-tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/refer-tools/">browse the directory</a>) -<dt><tt><i>rnototex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rnototex.zip">support/rnototex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rnototex/">browse the directory</a>) -<dt><tt><i>rtf2latex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rtf2latex.zip">support/rtf2latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rtf2latex/">browse the directory</a>) -<dt><tt><i>rtf2latex2e</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rtf2latex2e.zip">support/rtf2latex2e</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rtf2latex2e/">browse the directory</a>) -<dt><tt><i>rtf2tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rtf2tex.zip">support/rtf2tex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/rtf2tex/">browse the directory</a>) -<dt><tt><i>tex2rtf</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tex2rtf.zip">support/tex2rtf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tex2rtf/">browse the directory</a>) -<dt><tt><i>tr2latex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tr2latex.zip">support/tr2latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tr2latex/">browse the directory</a>) -<dt><tt><i>wd2latex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/wd2latex.zip">support/wd2latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/wd2latex/">browse the directory</a>) -<dt><tt><i>wp2latex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/wp2latex.zip">support/wp2latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/wp2latex/">browse the directory</a>) +<dt><tt><i>excel2latex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/excel2latex.zip">support/excel2latex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/excel2latex/">browse the directory</a>) +<dt><tt><i>pcwritex.arc</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/pcwritex.zip">support/pcwritex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/pcwritex/">browse the directory</a>) +<dt><tt><i>refer and tib tools</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/refer-tools.zip">biblio/bibtex/utils/refer-tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/refer-tools/">browse the directory</a>) +<dt><tt><i>rnototex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/rnototex.zip">support/rnototex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/rnototex/">browse the directory</a>) +<dt><tt><i>rtf2latex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/rtf2latex.zip">support/rtf2latex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/rtf2latex/">browse the directory</a>) +<dt><tt><i>rtf2latex2e</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/rtf2latex2e.zip">support/rtf2latex2e</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/rtf2latex2e/">browse the directory</a>) +<dt><tt><i>rtf2tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/rtf2tex.zip">support/rtf2tex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/rtf2tex/">browse the directory</a>) +<dt><tt><i>tex2rtf</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/tex2rtf.zip">support/tex2rtf</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/tex2rtf/">browse the directory</a>) +<dt><tt><i>tr2latex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/tr2latex.zip">support/tr2latex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/tr2latex/">browse the directory</a>) +<dt><tt><i>wd2latex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/wd2latex.zip">support/wd2latex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/wd2latex/">browse the directory</a>) +<dt><tt><i>wp2latex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/wp2latex.zip">support/wp2latex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/wp2latex/">browse the directory</a>) <dt><tt><i>Word processor FAQ (source)</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/wp-conv.zip">help/wp-conv</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/wp-conv/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/help/wp-conv.zip">help/wp-conv</a> (or <a href="http://www.tex.ac.uk/tex-archive/help/wp-conv/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fmtconv">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fmtconv</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontname.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontname.html index 9180524dba7..2fb347f95f3 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontname.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontname.html @@ -27,7 +27,7 @@ outlined in the <i>fontname</i> distribution, which includes extensive documentation and a set of tables of fonts whose names have been systematised. <dl> -<dt><tt><i>fontname distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/fontname.zip">info/fontname</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/fontname/">browse the directory</a>) +<dt><tt><i>fontname distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/fontname.zip">info/fontname</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/fontname/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fontname">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fontname</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fonts-pln.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fonts-pln.html index f0d23969a8d..e5dc84172b5 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fonts-pln.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fonts-pln.html @@ -64,7 +64,6 @@ in their process.) encodings, which you select by arcane commands, such as: <blockquote> <pre> -\let\LMTone\relax \input fontch.tex </pre> </blockquote><p> @@ -84,6 +83,10 @@ document is going to use, and the package provides commands to select fonts as they’re needed. The distribution includes a configuration to use Adobe ‘standard’ fonts for typesetting text. (Eplain itself seems not to offer a font selection scheme.) +<p/>The <i>font-change</i> collection takes a rather different +approach — it supplies what are (in effect) a series of templates +that may be included in a document to change font usage. The +package’s documentation shows the effect rather well. <p/>Simply to change font <em>size</em> in a document (i.e., not changing the default font itself), may be done using the rather straightforward <i>varisize</i>, which offers font sizes ranging from 7 points to @@ -92,13 +95,14 @@ any of the package files is loaded, so the <i>11pt.tex</i> defines a command <code>\</code><code>elevenpoint</code>; each of the files ensures there’s a “way back”, by defining a <code>\</code><code>tenpoint</code> command. <dl> -<dt><tt><i>ec-plain</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/ec-plain.zip">macros/ec-plain</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/ec-plain/">browse the directory</a>) -<dt><tt><i>fontch</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/fontch.zip">macros/plain/contrib/fontch</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/fontch/">browse the directory</a>) -<dt><tt><i>font_selection</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/font_selection.zip">macros/plain/contrib/font_selection</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/font_selection/">browse the directory</a>) -<dt><tt><i>ofs</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/ofs.zip">macros/generic/ofs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/ofs/">browse the directory</a>) -<dt><tt><i>pdcmac</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/pdcmac.zip">macros/plain/contrib/pdcmac</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/pdcmac/">browse the directory</a>) -<dt><tt><i>plnfss</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/plnfss.zip">macros/plain/plnfss</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/plnfss/">browse the directory</a>) -<dt><tt><i>varisize</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/varisize.zip">macros/plain/contrib/varisize</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/varisize/">browse the directory</a>) +<dt><tt><i>ec-plain</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/ec-plain.zip">macros/ec-plain</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/ec-plain/">browse the directory</a>) +<dt><tt><i>font-change</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/font-change.zip">macros/plain/contrib/font-change</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/font-change/">browse the directory</a>) +<dt><tt><i>fontch</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/fontch.zip">macros/plain/contrib/fontch</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/fontch/">browse the directory</a>) +<dt><tt><i>font_selection</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/font_selection.zip">macros/plain/contrib/font_selection</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/font_selection/">browse the directory</a>) +<dt><tt><i>ofs</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/ofs.zip">macros/generic/ofs</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/generic/ofs/">browse the directory</a>) +<dt><tt><i>pdcmac</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/pdcmac.zip">macros/plain/contrib/pdcmac</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/pdcmac/">browse the directory</a>) +<dt><tt><i>plnfss</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/plnfss.zip">macros/plain/plnfss</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/plnfss/">browse the directory</a>) +<dt><tt><i>varisize</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/varisize.zip">macros/plain/contrib/varisize</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/varisize/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fonts-pln">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fonts-pln</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontsize.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontsize.html index ccddaafadeb..6488fa57f3d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontsize.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontsize.html @@ -41,11 +41,11 @@ December 2003 edition of LaTeX; if you have an older distribution, the packages <i>type1cm</i> (for CM fonts) and <i>type1ec</i> (for EC fonts) are available. <dl> -<dt><tt><i>fix-cm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base/">browse the directory</a>) (an unpacked - version is available at <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/unpacked/fix-cm.sty">macros/latex/unpacked/fix-cm.sty</a>) -<dt><tt><i>type1cm.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/type1cm.zip">macros/latex/contrib/type1cm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/type1cm/">browse the directory</a>) -<dt><tt><i>type1ec.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/ps-type1/cm-super/type1ec.sty">fonts/ps-type1/cm-super/type1ec.sty</a> (the package is actually part of - the <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) distribution, but it works happily in +<dt><tt><i>fix-cm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/">browse the directory</a>) (an unpacked + version is available at <a href="http://www.tex.ac.uk/tex-archive/macros/latex/unpacked/fix-cm.sty">macros/latex/unpacked/fix-cm.sty</a>) +<dt><tt><i>type1cm.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/type1cm.zip">macros/latex/contrib/type1cm</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/type1cm/">browse the directory</a>) +<dt><tt><i>type1ec.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/type1ec.sty">fonts/ps-type1/cm-super/type1ec.sty</a> (the package is actually part of + the <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) distribution, but it works happily in the absence of the scaled fonts) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fontsize">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fontsize</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontunavail.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontunavail.html index a5e197ab006..a370c96e2a1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontunavail.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-fontunavail.html @@ -1,7 +1,7 @@ <head> <title>UK TeX FAQ -- question label fontunavail</title> </head><body> -<h3>Warning: “Font shape ... not available”</h3> +<h3>Warning: “Font shape … not available”</h3> <p/>LaTeX’s font selection scheme maintains tables of the font families it has been told about. These tables list the font families that LaTeX knows about, and the shapes and series in which those font @@ -60,8 +60,8 @@ information messages, that tell you what LaTeX has made of your text. You should check what the messages say, but you will ordinarily not be surprised at their content. <dl> -<dt><tt><i>type1cm.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/type1cm.zip">macros/latex/contrib/type1cm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/type1cm/">browse the directory</a>) -<dt><tt><i>type1ec.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/ps-type1/cm-super/type1ec.sty">fonts/ps-type1/cm-super/type1ec.sty</a> +<dt><tt><i>type1cm.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/type1cm.zip">macros/latex/contrib/type1cm</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/type1cm/">browse the directory</a>) +<dt><tt><i>type1ec.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/type1ec.sty">fonts/ps-type1/cm-super/type1ec.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fontunavail">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fontunavail</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footintab.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footintab.html index c0822d221e9..dc9d2c70415 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footintab.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footintab.html @@ -51,12 +51,12 @@ things you can do to fix the problem. file itself; that of <i>ctable</i> is distributed as a PDF file (for convenience’s sake). <dl> -<dt><tt><i>ctable.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ctable.zip">macros/latex/contrib/ctable</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ctable/">browse the directory</a>) -<dt><tt><i>footnote.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) -<dt><tt><i>longtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>mdwtab.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) -<dt><tt><i>threeparttable.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/threeparttable.sty">macros/latex/contrib/misc/threeparttable.sty</a> -<dt><tt><i>tabularx.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>ctable.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ctable.zip">macros/latex/contrib/ctable</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ctable/">browse the directory</a>) +<dt><tt><i>footnote.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) +<dt><tt><i>longtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>mdwtab.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) +<dt><tt><i>threeparttable.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/threeparttable.sty">macros/latex/contrib/misc/threeparttable.sty</a> +<dt><tt><i>tabularx.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=footintab">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=footintab</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footnpp.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footnpp.html index ed513725555..acb4a5c373f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footnpp.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-footnpp.html @@ -36,12 +36,12 @@ nothing else). With the competition from <i>perpage</i>, it’s probably not particularly useful any more. (Documentation is <i>footnpag-user.pdf</i> in the distribution.) <dl> -<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) -<dt><tt><i>footnpag.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footnpag.zip">macros/latex/contrib/footnpag</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footnpag/">browse the directory</a>) -<dt><tt><i>perpage.sty</i></tt><dd>Distributed as part <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) -<dt><tt><i>zref.sty</i></tt><dd>Distributed as a collection member in <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) +<dt><tt><i>footnpag.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footnpag.zip">macros/latex/contrib/footnpag</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footnpag/">browse the directory</a>) +<dt><tt><i>perpage.sty</i></tt><dd>Distributed as part <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) +<dt><tt><i>zref.sty</i></tt><dd>Distributed as a collection member in <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) <dt><tt><i>zref-perpage.sty</i></tt><dd>Distributed as a collection member in - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=footnpp">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=footnpp</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-formbiblabel.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-formbiblabel.html index bdfd3545bd0..04a06527bbc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-formbiblabel.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-formbiblabel.html @@ -29,7 +29,7 @@ LaTeX commands, in the preamble of your document, will do the job: </pre> </blockquote><p> <dl> -<dt><tt><i>natbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) +<dt><tt><i>natbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib.zip">macros/latex/contrib/natbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/natbib/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=formbiblabel">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=formbiblabel</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftncapt.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftncapt.html index 878f094aa45..44686d0708a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftncapt.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftncapt.html @@ -22,7 +22,7 @@ were thinking of. <ul> <li> use an optional argument in your <code>\</code><code>caption</code> command, that doesn’t have the footnote in it; this prevents the footnote - appearing in the “List of ...”, and + appearing in the “List of …”, and <li> put your whole float in a <code>minipage</code> so as to keep the footnotes with the float. </ul> @@ -51,8 +51,8 @@ with such a short caption as that in the example above.) <p/>The documentation of the <i>ccaption</i> package describes a really rather awful work-around for this problem. <dl> -<dt><tt><i>ccaption.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccaption.zip">macros/latex/contrib/ccaption</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccaption/">browse the directory</a>) -<dt><tt><i>threeparttable.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/threeparttable.sty">macros/latex/contrib/misc/threeparttable.sty</a> +<dt><tt><i>ccaption.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccaption.zip">macros/latex/contrib/ccaption</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccaption/">browse the directory</a>) +<dt><tt><i>threeparttable.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/threeparttable.sty">macros/latex/contrib/misc/threeparttable.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ftncapt">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ftncapt</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftnsect.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftnsect.html index 4b11f9fe6ed..819bdfc15d9 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftnsect.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ftnsect.html @@ -31,7 +31,7 @@ of contents, so the footnote may only appear in the section heading itself. </pre> </ul> <dl> -<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) +<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ftnsect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ftnsect</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-getbitmap.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-getbitmap.html index 129669ce9c1..4d9bdb0935d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-getbitmap.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-getbitmap.html @@ -29,10 +29,12 @@ destined to be converted to PDF, you should switch to using Type 1 versions of the CM fonts. Two free sets are available; the older (<i>bakoma</i>) is somewhat less well produced than the <i>bluesky</i> fonts, which were -originally professionally produced and sold, but were then donated to -the public domain by their originators Y&Y and Bluesky Research, -in association with the AMS. The two sets contain slightly -different ranges of fonts, but you are advised to use the +originally professionally produced and sold, but were then released +for general public use by their originators Y&Y and Bluesky Research, +in association with the AMS and other scientific publishers +(they are nowadays available under the SIL’s Open Fonts Licence). The +two sets contain slightly different ranges of fonts, but you are +advised to use the <i>bluesky</i> set except when <i>bakoma</i> is for some reason absolutely unavoidable. In recent years, several other ‘Metafont’ fonts have been converted to Type 1 format; it’s common never to need to @@ -45,12 +47,13 @@ if even then. <a href="FAQ-uselmfonts.html">Latin Modern fonts</a> are both close relatives of Computer Modern with wider ranges of glyphs to offer. <dl> -<dt><tt><i>BaKoMa fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/ps-type1/bakoma.zip">fonts/cm/ps-type1/bakoma</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/ps-type1/bakoma/">browse the directory</a>) -<dt><tt><i>Bluesky fonts</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/cm/ps-type1/bluesky/">fonts/cm/ps-type1/bluesky/</a> -<dt><tt><i>CM fonts (write-black printers)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/cm/pk/pk300.zip">fonts/cm/pk/pk300.zip</a> -<dt><tt><i>CM fonts (write-white printers)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/cm/pk/pk300w.zip">fonts/cm/pk/pk300w.zip</a> -<dt><tt><i>EC fonts (Type 1 format)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) -<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm/">browse the directory</a>) +<dt><tt><i>BaKoMa fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/cm/ps-type1/bakoma.zip">fonts/cm/ps-type1/bakoma</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/cm/ps-type1/bakoma/">browse the directory</a>) +<dt><tt><i>Bluesky fonts</i></tt><dd>Distributed as part of + <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) +<dt><tt><i>CM fonts (write-black printers)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/cm/pk/pk300.zip">fonts/cm/pk/pk300.zip</a> +<dt><tt><i>CM fonts (write-white printers)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/cm/pk/pk300w.zip">fonts/cm/pk/pk300w.zip</a> +<dt><tt><i>EC fonts (Type 1 format)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) +<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/lm/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=getbitmap">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=getbitmap</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-gethelp.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-gethelp.html index 112b14ca90a..ad4ea513847 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-gethelp.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-gethelp.html @@ -4,7 +4,7 @@ <h3>How to get help</h3> <p/>So you’ve looked at all relevant <a href="FAQ-whereFAQ.html">FAQs</a> you can find, you’ve looked in any <a href="FAQ-books.html">books</a> you have, and -scanned relevant <a href="FAQ-tutorialstar.html">tutorials</a>... and still you +scanned relevant <a href="FAQ-tutorialstar.html">tutorials</a>… and still you don’t know what to do. <p/>If you are seeking a particular package or program, look on your own system first: you might already have it — the better TeX @@ -23,7 +23,8 @@ before; there are two places where people ask: browse or search the newsgroup <i>comp.text.tex</i> via <a href="http://groups.google.com/group/comp.text.tex">Google groups</a>, and the mailing list <code>texhax</code> via its -<a href="http://tug.org/pipermail/texhax/">archive</a> +<a href="http://tug.org/pipermail/texhax/">archive</a>, or (as a long shot) +the archives of ancient posts on CTAN. <p/>If those “back question” searches fail, you’ll have to ask the world at large. To ask a question on <i>comp.text.tex</i>, you can use your own news client (if you have one), or use the “start a new @@ -33,9 +34,14 @@ To ask a question on <code>texhax</code>, you may simply send mail to list (via <a href="http://tug.org/mailman/listinfo/texhax">http://tug.org/mailman/listinfo/texhax</a>) first — not everyone will answer to you as well as to the list. <p/>Do <b>not</b> try mailing the -<a href="FAQ-LaTeX3.html">LaTeX project team</a> or the maintainers of these -FAQs for help; while both addresses reach experienced (La)TeX +<a href="FAQ-LaTeX3.html">LaTeX project team</a>, +the maintainers of the TeX Live or MiKTeX distributions +or the maintainers of these FAQs +for help; while all these addresses reach experienced (La)TeX users, no small group can possibly have expertise in every area of usage so that the “big” lists are a far better bet. +<dl> +<dt><tt><i>texhax ‘back copies’</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/digests/texhax/">digests/texhax/</a> +</dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=gethelp">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=gethelp</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-graphicspath.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-graphicspath.html index b6ab0dad344..0f5d1397ff8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-graphicspath.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-graphicspath.html @@ -56,8 +56,8 @@ in the question “ <a href="FAQ-docotherdir.html">bits of document in other directories</a> ”. <dl> -<dt><tt><i>graphics bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) -<dt><tt><i>import.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/import.sty">macros/latex/contrib/misc/import.sty</a> +<dt><tt><i>graphics bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) +<dt><tt><i>import.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/import.sty">macros/latex/contrib/misc/import.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=graphicspath">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=graphicspath</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-grffilenames.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-grffilenames.html index b7f2c80ced2..f3439f22df2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-grffilenames.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-grffilenames.html @@ -44,7 +44,7 @@ sufficiently recent version of PDFTeX, in PDF mode — and even then it won’t work for MetaPost files, which are read as TeX input, and therefore use the standard input mechanism). <dl> -<dt><tt><i>grffile.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>grffile.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=grffilenames">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=grffilenames</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-howmanypp.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-howmanypp.html index 010e0711c2e..90c263565be 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-howmanypp.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-howmanypp.html @@ -26,10 +26,10 @@ to the equivalent of the <code>LastPage</code> label and the the <i>everyshi</i> package. <dl> <dt><tt><i>count1to.sty and everyshi.sty</i></tt><dd> - Distributed in <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms/">browse the directory</a>) -<dt><tt><i>lastpage.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lastpage.zip">macros/latex/contrib/lastpage</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lastpage/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>totpages.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/totpages.zip">macros/latex/contrib/totpages</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/totpages/">browse the directory</a>) + Distributed in <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms/">browse the directory</a>) +<dt><tt><i>lastpage.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lastpage.zip">macros/latex/contrib/lastpage</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lastpage/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>totpages.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/totpages.zip">macros/latex/contrib/totpages</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/totpages/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=howmanypp">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=howmanypp</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-htmlbib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-htmlbib.html index a6e059153f5..a315dec9927 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-htmlbib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-htmlbib.html @@ -18,9 +18,9 @@ styles, and post-process the output so produced using a a sample of the script’s output may be viewed on the web, at <a href="http://rikblok.cjb.net/lib/refs.html">http://rikblok.cjb.net/lib/refs.html</a> <dl> -<dt><tt><i>bbl2html.awk</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/misc/bbl2html.awk">biblio/bibtex/utils/misc/bbl2html.awk</a> -<dt><tt><i>bib2xhtml</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/bib2xhtml.zip">biblio/bibtex/utils/bib2xhtml</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/utils/bib2xhtml/">browse the directory</a>) -<dt><tt><i>noTeX.bst</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/misc/noTeX.bst">biblio/bibtex/utils/misc/noTeX.bst</a> +<dt><tt><i>bbl2html.awk</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/misc/bbl2html.awk">biblio/bibtex/utils/misc/bbl2html.awk</a> +<dt><tt><i>bib2xhtml</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/bib2xhtml.zip">biblio/bibtex/utils/bib2xhtml</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/bib2xhtml/">browse the directory</a>) +<dt><tt><i>noTeX.bst</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/misc/noTeX.bst">biblio/bibtex/utils/misc/noTeX.bst</a> </dl> <p/> <p/><p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=htmlbib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=htmlbib</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyperdupdest.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyperdupdest.html index 49ca9f2012c..b733dc256e9 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyperdupdest.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyperdupdest.html @@ -1,7 +1,7 @@ <head> <title>UK TeX FAQ -- question label hyperdupdest</title> </head><body> -<h3>PDFTeX destination ... ignored</h3> +<h3>PDFTeX destination … ignored</h3> <p/>The warning: <blockquote> <pre> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyphoff.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyphoff.html index 1a3a813f310..0c79537ec74 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyphoff.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-hyphoff.html @@ -72,7 +72,7 @@ appeal to the specifiers of eccentric document layouts (such as those for dissertations), but for once their sense conforms with typographic style. (Or at least, style constrained in this curious way.) <dl> -<dt><tt><i>hyphenat.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyphenat.zip">macros/latex/contrib/hyphenat</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyphenat/">browse the directory</a>) +<dt><tt><i>hyphenat.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyphenat.zip">macros/latex/contrib/hyphenat</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyphenat/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=hyphoff">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=hyphoff</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-i18nbib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-i18nbib.html index 55b31c2e079..98ad3d8d427 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-i18nbib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-i18nbib.html @@ -40,14 +40,14 @@ language, you are asked whether you want the style to interact with worlds — formatting freedom from <i>custom-bib</i> and linguistic freedom via the extensibility of <i>babelbib</i> <dl> -<dt><tt><i>babelbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/babelbib.zip">biblio/bibtex/contrib/babelbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/babelbib/">browse the directory</a>) -<dt><tt><i>bib-fr bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/bib-fr.zip">biblio/bibtex/contrib/bib-fr</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/bib-fr/">browse the directory</a>) -<dt><tt><i>bibgerm bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/germbib.zip">biblio/bibtex/contrib/germbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/germbib/">browse the directory</a>) -<dt><tt><i>custom-bib bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/custom-bib.zip">macros/latex/contrib/custom-bib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/custom-bib/">browse the directory</a>) -<dt><tt><i>finplain.bst</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/contrib/misc/finplain.bst">biblio/bibtex/contrib/misc/finplain.bst</a> -<dt><tt><i>norbib bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/norbib.zip">biblio/bibtex/contrib/norbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/norbib/">browse the directory</a>) -<dt><tt><i>spain</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/spain.zip">biblio/bibtex/contrib/spain</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/spain/">browse the directory</a>) -<dt><tt><i>swebib bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/swebib.zip">biblio/bibtex/contrib/swebib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/biblio/bibtex/contrib/swebib/">browse the directory</a>) +<dt><tt><i>babelbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/babelbib.zip">biblio/bibtex/contrib/babelbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/babelbib/">browse the directory</a>) +<dt><tt><i>bib-fr bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/bib-fr.zip">biblio/bibtex/contrib/bib-fr</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/bib-fr/">browse the directory</a>) +<dt><tt><i>bibgerm bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/germbib.zip">biblio/bibtex/contrib/germbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/germbib/">browse the directory</a>) +<dt><tt><i>custom-bib bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/custom-bib.zip">macros/latex/contrib/custom-bib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/custom-bib/">browse the directory</a>) +<dt><tt><i>finplain.bst</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/misc/finplain.bst">biblio/bibtex/contrib/misc/finplain.bst</a> +<dt><tt><i>norbib bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/norbib.zip">biblio/bibtex/contrib/norbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/norbib/">browse the directory</a>) +<dt><tt><i>spain</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/spain.zip">biblio/bibtex/contrib/spain</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/spain/">browse the directory</a>) +<dt><tt><i>swebib bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/swebib.zip">biblio/bibtex/contrib/swebib</a> (or <a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/contrib/swebib/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=i18nbib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=i18nbib</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ifpdf.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ifpdf.html index 8c175c4600a..00810ad574e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ifpdf.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ifpdf.html @@ -24,7 +24,6 @@ first branch can be misleading, since the “awkward” user could have written: <blockquote> <pre> -\let\pdfoutput\undefined </pre> </blockquote><p> so that your test will falsely choose the first alternative. While @@ -79,10 +78,10 @@ the “TeX project” answers covering <a href="FAQ-xetex.html">XeTeX</a>, and <a href="FAQ-luatex.html">LuaTeX</a>). <dl> -<dt><tt><i>ifpdf.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>ifpdf.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) <dt><tt><i>ifluatex.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>ifxetex.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/ifxetex.zip">macros/generic/ifxetex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/ifxetex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>ifxetex.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/ifxetex.zip">macros/generic/ifxetex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/generic/ifxetex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ifpdf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ifpdf</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-impgraph.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-impgraph.html index 4d8e300ccba..ba9d038ddb5 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-impgraph.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-impgraph.html @@ -1,7 +1,7 @@ <head> <title>UK TeX FAQ -- question label impgraph</title> </head><body> -<h3>How to import graphics into (La)TeX documents</h3> +<h3>Importing graphics into (La)TeX documents</h3> <p/>Knuth, when designing the current version of TeX back in the early 1980s, could discern no “standard” way of expressing graphics in documents. He reasoned that this state could not persist for ever, @@ -85,14 +85,14 @@ but may also be <a href="http://silas.psfc.mit.edu/elec_fig/">browsed on the Web</a>. <dl> -<dt><tt><i>epsf.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/generic/epsf/epsf.tex">macros/generic/epsf/epsf.tex</a> -<dt><tt><i>epsfig.sty</i></tt><dd>Part of the <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle -<dt><tt><i>epslatex.pdf</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/epslatex/english/epslatex.pdf">info/epslatex/english/epslatex.pdf</a>; the document is also available - in PostScript format as <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/epslatex/english/epslatex.ps">info/epslatex/english/epslatex.ps</a> -<dt><tt><i>graphics.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) -<dt><tt><i>graphicx.sty</i></tt><dd>Part of the <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle -<dt><tt><i>miniltx.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/graphics.zip">macros/plain/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/graphics/">browse the directory</a>) -<dt><tt><i>psfig.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/psfig.zip">graphics/psfig</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/psfig/">browse the directory</a>) +<dt><tt><i>epsf.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/epsf/epsf.tex">macros/generic/epsf/epsf.tex</a> +<dt><tt><i>epsfig.sty</i></tt><dd>Part of the <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle +<dt><tt><i>epslatex.pdf</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/epslatex/english/epslatex.pdf">info/epslatex/english/epslatex.pdf</a>; the document is also available + in PostScript format as <a href="http://www.tex.ac.uk/tex-archive/info/epslatex/english/epslatex.ps">info/epslatex/english/epslatex.ps</a> +<dt><tt><i>graphics.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) +<dt><tt><i>graphicx.sty</i></tt><dd>Part of the <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle +<dt><tt><i>miniltx.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/graphics.zip">macros/plain/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/graphics/">browse the directory</a>) +<dt><tt><i>psfig.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/psfig.zip">graphics/psfig</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/psfig/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=impgraph">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=impgraph</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inclplain.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inclplain.html index 21ccf5980ae..edf5f310b5c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inclplain.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inclplain.html @@ -25,7 +25,7 @@ AMSTeX; no doubt it would also fail if asked to load Eplain. All these things can be overcome (although it’s not often easy), but the environment saves a lot of work on many occasions. <dl> -<dt><tt><i>plain.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) +<dt><tt><i>plain.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inclplain">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inclplain</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inst1cm.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inst1cm.html index 164577980c1..3070b9bb19c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inst1cm.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-inst1cm.html @@ -1,72 +1,34 @@ <head> <title>UK TeX FAQ -- question label inst1cm</title> </head><body> -<h3>Installing the Bluesky versions of the CM fonts</h3> +<h3>Installing the Type 1 versions of the CM fonts</h3> <p/>This is a specialised case of <a href="FAQ-instfont.html">installing a font</a>, -but it comes easier -than most, since the font metrics are installed in every (La)TeX -system before you even start. Indeed, most recent systems will have -the Type 1 fonts themselves already installed, so that the job is -already done, and all you need is to start using them: -so the first thing to do is to just try it. On a system that uses -<i>dvips</i> (most systems nowadays do), try the sequence: +but it is almost never necessary — it’s inconceivable that any (even +remotely) recent system will <em>not</em> have the fonts already +installed. You can confirm this (near-inevitable) fact by trying the +fonts. On a system that uses <i>dvips</i> (almost all do), try +the sequence: +<blockquote> <pre> latex sample2e - dvips -Pcmz -Pamz -o sample2e.ps sample2e + dvips -o sample2e.ps sample2e </pre> +</blockquote><p> at a “command prompt” (<i>shell</i>, in a Unix-style system, “DOS box” in a Windows system). <p/>If the command works at all, the console output of the command will include a sequence of Type 1 font file names, listed as -<code><cmr10.pfb></code> and so on; -this is <i>dvips</i> telling you it’s including the Type 1 font, -and you need do no more. -<p/>If the test has failed, you need to install your own set of the fonts. -<p/>The CTAN directories listed below contain compressed archives of -the Type 1 -files for various architectures, both for the Computer Modern fonts -and for the AMS fonts of mathematical and other useful things. -Download the archives that are appropriate for your architecture, and -extract the files — you only actually need the contents of the -<i>pfb</i> directories, since you already have the fonts -installed in the “ordinary” way, so that the TFM files are -already present. (You don’t need the PostScript font metric — AFM -and PFM — files in any case.) -<p/>The files should go into your local <code>texmf</code> tree (<i>texmf.local</i>, -<i>texmf-local</i>, <i>localtexmf</i>, or whatever). Create -directories at offsets <i>fonts/type1/bluesky/cm</i> and -<i>fonts/type1/bluesky/ams</i>, and copy the <code>.pfb</code> files into them. -<p/>Now you need to tell <i>dvips</i>, PDFTeX, etc., that the fonts -are available. This is done by use of a <em>map file</em>, which lists -<em>font name</em> (as TeX understands it), <em>font name</em> (as it -appears in the type 1 file itself), and where the program will find -the file. Map files are provided in the download bundles for the -AMS fonts; for the CM fonts, map files are available -separately. -<p/>The set of map files includes files <code>config.*</code>; each of these contains -an instruction to load a single map file. For ordinary use, you -instruct <i>dvips</i> to load the “detailed” map of the -CM fonts by use of the command: -<pre> - dvips -Pcmz myfile -</pre> -The same can be done with the AMS fonts, and you may invoke -both sets of fonts with: -<pre> - dvips -Pcmz -Pamz myfile -</pre> -Alternatively, the contents of <i>config.cmz</i> and <i>config.amz</i> -could be combined into a single file, perhaps <i>config.bluesky</i>, -loaded by the command -<pre> - dvips -Pbluesky myfile -</pre> -<p/>Remember, after all such changes, the -<a href="FAQ-inst-wlcf.html">file-name database must be refreshed</a>. -<dl> -<dt><tt><i>AMS fonts</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/amsfonts/ps-type1/">fonts/amsfonts/ps-type1/</a> -<dt><tt><i>CM fonts</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/cm/ps-type1/bluesky/">fonts/cm/ps-type1/bluesky/</a> -<dt><tt><i>CM font maps</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/ps-type1/bluesky-contrib/dvips.zip">fonts/cm/ps-type1/bluesky-contrib/dvips</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/ps-type1/bluesky-contrib/dvips/">browse the directory</a>) +<code><cmr10.pfb></code> and so on; this is <i>dvips</i> telling you +it’s copying information from the Type 1 font, and you need do no +more. +<p/>If the test has failed, you need to install your own set of the fonts; +the distribution (including all the fonts the AMS designed and +produced themselves) is now described as <i>amsfonts</i>. The +bundle contains metric and map files — all you need to +<a href="FAQ-instt1font.html">install the fonts</a>. +<p/><dl> +<dt><tt><i>AMS and CM fonts, in Type 1 format</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) </dl> -<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst1cm">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst1cm</a> +<p/><p/> +<p/><p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst1cm">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst1cm</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instprinterfont.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instprinterfont.html index a2e204a0b99..47e555859c1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instprinterfont.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instprinterfont.html @@ -36,7 +36,7 @@ TDS, so in principle, installation consists simply of <dl> <dt><tt><i>mathpazo.sty</i></tt><dd>Part of the <i>psnfss</i> bundle <dt><tt><i>mathptmx.sty</i></tt><dd>Part of the <i>psnfss</i> bundle -<dt><tt><i>psnfss bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss/">browse the directory</a>) +<dt><tt><i>psnfss bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instprinterfont">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instprinterfont</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instt1font.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instt1font.html index b114ce432fb..1a6d985500c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instt1font.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-instt1font.html @@ -8,10 +8,10 @@ you can get on with installation. <p/>The procedure is merely an extension of that for packages, etc., so much of what follows will be familiar: <ul> -<li> Install the files, in your <code>texmf</code> tree. All the - strictures about installing non-standard things apply here: be sure - to put the files in the local tree. The list gives reasonable - destinations for the various files related to a font family <<i>fname</i>>: +<li> Install the files, in your local <code>texmf</code> tree (the advice + about installing non-standard things applies here, too). The + following list gives reasonable destinations for the various files + related to a font family <<i>fname</i>>: <pre> .pfb, .pfa .../fonts/type1/<foundry>/<fname> @@ -22,9 +22,9 @@ much of what follows will be familiar: .map .../fonts/map/dvips/<foundry> </pre> but if you are lucky, you will be starting from a distribution from - CTAN and can make use of the corresponding - <code>.tds.zip</code> file, and not care about how to place your files - in the TDS tree. + CTAN and there is a corresponding <code>.tds.zip</code> file: + using the TDS-file saves the bother of deciding where to put + your files in the TDS tree. <li> Regenerate the file indexes (as described in <a href="FAQ-inst-wlcf.html">package installation</a>). <li> Update the <i>dvips</i>, PDFTeX and other maps: @@ -36,9 +36,9 @@ much of what follows will be familiar: updmap-sys --enable Map <fname>.map </pre> </blockquote><p> - as root. (You <em>can</em> use plain <i>updmap</i>, but you - will be in danger of creating confusion with different map sets - for different users thereby.) + as root. (Do <em>not</em> use plain <i>updmap</i>: it’s a + potent source of confusion, setting up different map sets + for different users.) <li> On a current MiKTeX system, update the system file <i>updmap.cfg</i>, using the shell command <blockquote> @@ -60,16 +60,15 @@ initexmf --mkmaps </pre> </blockquote><p> This, and other matters, are described in MiKTeX - <a href="http://docs.miktex.org/manual/advanced.html">”advanced” documentation</a>. + <a href="http://docs.miktex.org/manual/advanced.html">“advanced” documentation</a>. </ul> </ul> Both processes (preparing and installing a font) are very well (and thoroughly) described in Philipp Lehman’s guide to font installation, which may be found on CTAN. <dl> -<dt><tt><i>fontinst.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst/">browse the directory</a>) -<dt><tt><i>Type 1 installation guide</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/Type1fonts/fontinstallationguide/fontinstallationguide.pdf">info/Type1fonts/fontinstallationguide/fontinstallationguide.pdf</a> +<dt><tt><i>fontinst.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst/">browse the directory</a>) +<dt><tt><i>Type 1 installation guide</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/Type1fonts/fontinstallationguide/fontinstallationguide.pdf">info/Type1fonts/fontinstallationguide/fontinstallationguide.pdf</a> </dl> -<p/> -<p/><p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instt1font">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instt1font</a> +<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instt1font">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instt1font</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-interruptlist.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-interruptlist.html index 27d26d315f1..b4f1b4132ec 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-interruptlist.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-interruptlist.html @@ -29,9 +29,9 @@ restarting enumerate: \end{enumerate} </pre> </blockquote><p> -<p/>This is reasonable, in small doses... Problems (apart from sheer +<p/>This is reasonable, in small doses… Problems (apart from sheer verbosity) are getting the level right (“should I use counter -<code>enumi</code>, <code>enumii</code>, ...”) and remembering not to +<code>enumi</code>, <code>enumii</code>, …”) and remembering not to nest the interruptions (i.e., not to have a separate list, that is itself interrupted) in the “commentary text”). <p/>The <i>mdwlist</i> package defines commands <code>\</code><code>suspend</code> and @@ -132,10 +132,10 @@ However, the ‘nested comment’ interpolated in the nested enumeration appears as if it were a second paragraph to “outer item 2”, which is hardly satisfactory. <dl> -<dt><tt><i>enumerate.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) -<dt><tt><i>expdlist.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expdlist.zip">macros/latex/contrib/expdlist</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expdlist/">browse the directory</a>) -<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) +<dt><tt><i>enumerate.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) +<dt><tt><i>expdlist.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expdlist.zip">macros/latex/contrib/expdlist</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expdlist/">browse the directory</a>) +<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=interruptlist">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=interruptlist</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isdef.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isdef.html index beb30d35535..ae9732462f9 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isdef.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isdef.html @@ -5,7 +5,7 @@ <p/>Macro sets from the earliest days of TeX programming may be observed to test whether commands exist by using <blockquote> -<code>\</code><code>ifx</code> csx<code><em>command</em></code> <code>\</code><code>undefined</code> <<i>stuff</i>> ... +<code>\</code><code>ifx</code> csx<code><em>command</em></code> <code>\</code><code>undefined</code> <<i>stuff</i>> … </blockquote><p> (which of course actually tests that the command <em>doesn’t</em> exist). LaTeX programmers can make use of the internal command @@ -75,7 +75,7 @@ the same thing: </pre> </blockquote><p> However, after using the LaTeX -<code>\</code><code>@ifundefined{foo}</code>..., the conditionals will detect the +<code>\</code><code>@ifundefined{foo}</code>…, the conditionals will detect the command as “existing” (since it has been <code>\</code><code>let</code> to <code>\</code><code>relax</code>); so it is important not to mix mechanisms for detecting the state of a command. diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isitanum.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isitanum.html index 4cd7934b701..28e43afdc76 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isitanum.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-isitanum.html @@ -132,7 +132,7 @@ thus using TeX’s own integer-parsing code to do the check. It’s a pity that such a mechanism was never defined (it could be that it’s impossible to program within TeX!). <dl> -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=isitanum">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=isitanum</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-journalpaper.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-journalpaper.html index 7d2786c5114..936dbcda3ae 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-journalpaper.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-journalpaper.html @@ -16,7 +16,7 @@ publisher of your paper; many publishers have macros on their own web sites, or otherwise available only upon application. <p/>Check that the publisher is offering you macros suitable to an environment you can use: a few still have no macros for current -LaTeX, for example, claiming that LaTeX 2.09 is good enough... +LaTeX, for example, claiming that LaTeX 2.09 is good enough… <p/>Some publishers rekey anything sent them anyway, so that it doesn’t really matter what macros you use. Others merely encourage you to use as few extensions of a standard package as possible, so that they will diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-keyval.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-keyval.html index 6ca8497270c..00c52ee8f91 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-keyval.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-keyval.html @@ -99,7 +99,7 @@ added automatically. So a <code>\</code><code>pgfkeys</code> command might be: </blockquote><p> and for each key mentioned, the associated code will be executed. -... and that code is also set up using <code>\</code><code>pgfkeys</code>: +… and that code is also set up using <code>\</code><code>pgfkeys</code>: <blockquote> <pre> \pgfkeys{/my key/.code=The value is '#1'.} @@ -146,12 +146,12 @@ Stephani. At Joseph’s suggestion, discussion of his <i>keys3</i> package, which is designed for use with the experimental LaTeX3, has been omitted. <dl> -<dt><tt><i>keyval.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) -<dt><tt><i>kvoptions.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>kvsetkeys.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>pgfkeys.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf/">browse the directory</a>) -<dt><tt><i>scrbase.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>xkeyval.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xkeyval.zip">macros/latex/contrib/xkeyval</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xkeyval/">browse the directory</a>) +<dt><tt><i>keyval.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) +<dt><tt><i>kvoptions.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>kvsetkeys.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>pgfkeys.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pgf/">browse the directory</a>) +<dt><tt><i>scrbase.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>xkeyval.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xkeyval.zip">macros/latex/contrib/xkeyval</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xkeyval/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=keyval">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=keyval</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelctr.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelctr.html index c629c881aa0..c3f4bb9993b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelctr.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelctr.html @@ -5,7 +5,7 @@ <p/>Suppose we have a LaTeX counter, which we’ve defined with <code>\</code><code>newcounter{foo}</code>. We can increment the value of the counter by <code>\</code><code>addtocounter{foo}{1}</code>, but that’s pretty clunky for an -operation that happens so often ... so there’s a command +operation that happens so often … so there’s a command <code>\</code><code>stepcounter{foo}</code> that does this special case of increasing-by-one. <p/>There’s an internal LaTeX variable, the “current label”, that diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelfig.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelfig.html index 123112b3383..3ed767ecf10 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelfig.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelfig.html @@ -60,14 +60,14 @@ environment which itself includes the graphic. I would recommend are plainly little more than a convenience over what is achievable with the do-it-yourself approach. <dl> -<dt><tt><i>auto-pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/auto-pst-pdf.zip">macros/latex/contrib/auto-pst-pdf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/auto-pst-pdf/">browse the directory</a>) -<dt><tt><i>iTe</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/ite.zip">support/ite</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/ite/">browse the directory</a>) -<dt><tt><i>laprint</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psfragx.zip">macros/latex/contrib/psfragx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psfragx/">browse the directory</a>) -<dt><tt><i>overpic.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/overpic.zip">macros/latex/contrib/overpic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/overpic/">browse the directory</a>) -<dt><tt><i>psfrag.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psfrag.zip">macros/latex/contrib/psfrag</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psfrag/">browse the directory</a>) -<dt><tt><i>psfragx.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psfragx.zip">macros/latex/contrib/psfragx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psfragx/">browse the directory</a>) -<dt><tt><i>pstricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pstricks.zip">graphics/pstricks</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pstricks/">browse the directory</a>) -<dt><tt><i>pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pst-pdf.zip">macros/latex/contrib/pst-pdf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pst-pdf/">browse the directory</a>) +<dt><tt><i>auto-pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/auto-pst-pdf.zip">macros/latex/contrib/auto-pst-pdf</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/auto-pst-pdf/">browse the directory</a>) +<dt><tt><i>iTe</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/ite.zip">support/ite</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/ite/">browse the directory</a>) +<dt><tt><i>laprint</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psfragx.zip">macros/latex/contrib/psfragx</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psfragx/">browse the directory</a>) +<dt><tt><i>overpic.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/overpic.zip">macros/latex/contrib/overpic</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/overpic/">browse the directory</a>) +<dt><tt><i>psfrag.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psfrag.zip">macros/latex/contrib/psfrag</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psfrag/">browse the directory</a>) +<dt><tt><i>psfragx.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psfragx.zip">macros/latex/contrib/psfragx</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psfragx/">browse the directory</a>) +<dt><tt><i>pstricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/pstricks.zip">graphics/pstricks</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pstricks/">browse the directory</a>) +<dt><tt><i>pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pst-pdf.zip">macros/latex/contrib/pst-pdf</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pst-pdf/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=labelfig">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=labelfig</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelformat.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelformat.html index 707c10f802d..2f8db896a4f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelformat.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labelformat.html @@ -67,8 +67,8 @@ has been rendered obsolete by the appearance of the <i>enumitem</i> package, which is discussed in the answer about <a href="FAQ-enumerate.html">decorating enumeration lists</a>. <dl> -<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) -<dt><tt><i>fncylab.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/fncylab.sty">macros/latex/contrib/misc/fncylab.sty</a> +<dt><tt><i>enumitem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem.zip">macros/latex/contrib/enumitem</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/enumitem/">browse the directory</a>) +<dt><tt><i>fncylab.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/fncylab.sty">macros/latex/contrib/misc/fncylab.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=labelformat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=labelformat</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labundef.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labundef.html index 45066f0d621..a42e2954bd1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labundef.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-labundef.html @@ -33,7 +33,7 @@ of a single label, or the states of a list of labels. The package’s definition is a bit complicated, but the package itself is pretty powerful. <dl> -<dt><tt><i>labelcas.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/labelcas.zip">macros/latex/contrib/labelcas</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/labelcas/">browse the directory</a>) +<dt><tt><i>labelcas.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/labelcas.zip">macros/latex/contrib/labelcas</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/labelcas/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=labundef">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=labundef</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-landscape.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-landscape.html index d74fadd2f12..3fa879cb54e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-landscape.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-landscape.html @@ -68,16 +68,16 @@ rotation requests in DVI files. Your best bet is to convert your output to PostScript or to PDF, and to view these ‘final’ forms with an appropriate viewer. <dl> -<dt><tt><i>geometry.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/geometry.zip">macros/latex/contrib/geometry</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/geometry/">browse the directory</a>) -<dt><tt><i>graphics.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) -<dt><tt><i>longtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>lscape.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>geometry.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/geometry.zip">macros/latex/contrib/geometry</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/geometry/">browse the directory</a>) +<dt><tt><i>graphics.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) +<dt><tt><i>longtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>lscape.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) <dt><tt><i>pdflscape.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>rotating.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rotating.zip">macros/latex/contrib/rotating</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rotating/">browse the directory</a>) -<dt><tt><i>rotfloat.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rotfloat.zip">macros/latex/contrib/rotfloat</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/rotfloat/">browse the directory</a>) -<dt><tt><i>supertabular.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/supertabular.zip">macros/latex/contrib/supertabular</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/supertabular/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>rotating.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rotating.zip">macros/latex/contrib/rotating</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rotating/">browse the directory</a>) +<dt><tt><i>rotfloat.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rotfloat.zip">macros/latex/contrib/rotfloat</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/rotfloat/">browse the directory</a>) +<dt><tt><i>supertabular.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/supertabular.zip">macros/latex/contrib/supertabular</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/supertabular/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=landscape">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=landscape</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latex2e.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latex2e.html index 1eff11d50a3..47d1d7ed479 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latex2e.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latex2e.html @@ -25,7 +25,8 @@ outlined in a series of ‘guide’ files that are available in every LaTeX distribution (the same directory also contains “news” about each new release of LaTeX2e). <dl> -<dt><tt><i>LaTeX guides and news</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/doc.zip">macros/latex/doc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/doc/">browse the directory</a>) +<dt><tt><i>LaTeX guides and news</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/doc.zip">macros/latex/doc</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/doc/">browse the directory</a>) </dl> +<p><em>This answer last edited: 2009-06-07</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latex2e">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latex2e</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexpronounce.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexpronounce.html index a2496a1705f..b17da04d6dc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexpronounce.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexpronounce.html @@ -11,5 +11,6 @@ TeX pronounced as the program itself; see <p/>The LaTeX2e logo is supposed to end with an ε; nevertheless, most people pronounce the name as ‘LaTeX-two-ee’. +<p><em>This answer last edited: 2009-06-08</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexpronounce">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexpronounce</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexqual.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexqual.html index 880d273f99e..0a3b964d3a1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexqual.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexqual.html @@ -7,7 +7,7 @@ good read. <p/>However, it’s always difficult to remember the things you should <em>not</em> do, when there are so many things to remember that you -really must do: some automation is needed.... +really must do: some automation is needed…. <p/>The nicely-named <i>nag</i> allows you to apply a configurable set of checks to your document, as you run it through LaTeX; you get messages like: @@ -29,9 +29,9 @@ doesn’t seem as comprehensive as <i>nag</i>, but it allows you to download its script, which you can then juggle with to make it more draconian. <dl> -<dt><tt><i>l2tabu</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/l2tabu/">info/l2tabu/</a> for a copy in a language that’s +<dt><tt><i>l2tabu</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/info/l2tabu/">info/l2tabu/</a> for a copy in a language that’s convenient for you -<dt><tt><i>nag.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/nag.zip">macros/latex/contrib/nag</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/nag/">browse the directory</a>) +<dt><tt><i>nag.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/nag.zip">macros/latex/contrib/nag</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/nag/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexqual">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexqual</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterclass.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterclass.html index b2051c36aa4..7785a897137 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterclass.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterclass.html @@ -8,7 +8,6 @@ it. If you nevertheless want to try it, but are irritated by its way of vertically-shifting a single-page letter, try the following hack: <pre> \makeatletter -\let\@texttop\relax \makeatother </pre> in the preamble of your file. @@ -34,11 +33,11 @@ only) bundles. While these are probably good (since the bundles themselves inspire trust) they’ve not been specifically recommended by any users. <dl> -<dt><tt><i>akletter.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/akletter.zip">macros/latex/contrib/akletter</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/akletter/">browse the directory</a>) -<dt><tt><i>brief.cls</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntgclass.zip">macros/latex/contrib/ntgclass</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntgclass/">browse the directory</a>) -<dt><tt><i>dinbrief.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/dinbrief.zip">macros/latex/contrib/dinbrief</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/dinbrief/">browse the directory</a>) -<dt><tt><i>newlfm.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/newlfm.zip">macros/latex/contrib/newlfm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/newlfm/">browse the directory</a>) -<dt><tt><i>scrlttr2.cls</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>akletter.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/akletter.zip">macros/latex/contrib/akletter</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/akletter/">browse the directory</a>) +<dt><tt><i>brief.cls</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntgclass.zip">macros/latex/contrib/ntgclass</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntgclass/">browse the directory</a>) +<dt><tt><i>dinbrief.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/dinbrief.zip">macros/latex/contrib/dinbrief</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/dinbrief/">browse the directory</a>) +<dt><tt><i>newlfm.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/newlfm.zip">macros/latex/contrib/newlfm</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/newlfm/">browse the directory</a>) +<dt><tt><i>scrlttr2.cls</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=letterclass">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=letterclass</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterspace.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterspace.html index 4d1670c468e..f3436278743 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterspace.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-letterspace.html @@ -36,9 +36,9 @@ will destroy ligatures; however, this is <em>wrong</em> if the font is of a fraktur style, and the package provides a means of protecting the ligatures in a letter-spaced text. <dl> -<dt><tt><i>letterspacing.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/generic/misc/letterspacing.tex">macros/generic/misc/letterspacing.tex</a> -<dt><tt><i>microtype.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/microtype.zip">macros/latex/contrib/microtype</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/microtype/">browse the directory</a>) -<dt><tt><i>soul.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/soul.zip">macros/latex/contrib/soul</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/soul/">browse the directory</a>) +<dt><tt><i>letterspacing.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/misc/letterspacing.tex">macros/generic/misc/letterspacing.tex</a> +<dt><tt><i>microtype.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/microtype.zip">macros/latex/contrib/microtype</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/microtype/">browse the directory</a>) +<dt><tt><i>soul.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/soul.zip">macros/latex/contrib/soul</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/soul/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=letterspace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=letterspace</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-limits.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-limits.html index c09918b890b..e65a45b7e86 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-limits.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-limits.html @@ -21,7 +21,7 @@ $\sum\limits_{n=1}^{m} ...$ </pre> </blockquote><p> which will place the limits right above and below the symbol (and be -blowed to the typography...). +blowed to the typography…). <p/>Contrariwise, you may wish to change the arrangement of the limits when in <code>\</code><code>displaystyle</code>. For this purpose, there’s a corresponding <code>\</code><code>nolimits</code>: diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linenos.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linenos.html index 866a3e6fd94..29380d0849f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linenos.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linenos.html @@ -8,7 +8,7 @@ individual lines of typeset output) and <i>numline</i>. (<i>Numline</i> is considered obsolete, but remains available from the archive.) <p/>Both of these packages play fast and loose with the LaTeX output -routine, which can cause problems: the user should beware... +routine, which can cause problems: the user should beware… <p/>If the requirement is for numbering verbatim text, <i>moreverb</i>, or <i>fancyvrb</i> (see <a href="FAQ-verbfile.html">including files verbatim</a>) may be used. @@ -24,14 +24,14 @@ interpolated mathematics or figures. Documentation of the package, in the package itself, is pretty tough going, though there is an example (also inside the package file). <dl> -<dt><tt><i>edmac</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/edmac.zip">macros/plain/contrib/edmac</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/edmac/">browse the directory</a>) -<dt><tt><i>fancyvrb.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyvrb.zip">macros/latex/contrib/fancyvrb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyvrb/">browse the directory</a>) -<dt><tt><i>ledmac.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ledmac.zip">macros/latex/contrib/ledmac</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ledmac/">browse the directory</a>) -<dt><tt><i>lineno.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lineno.zip">macros/latex/contrib/lineno</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lineno/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>moreverb.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/moreverb.zip">macros/latex/contrib/moreverb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/moreverb/">browse the directory</a>) -<dt><tt><i>numline.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveobsolete/macros/latex/contrib/numline/numline.sty">obsolete/macros/latex/contrib/numline/numline.sty</a> -<dt><tt><i>vruler.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/vruler.sty">macros/latex/contrib/misc/vruler.sty</a> +<dt><tt><i>edmac</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/edmac.zip">macros/plain/contrib/edmac</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/edmac/">browse the directory</a>) +<dt><tt><i>fancyvrb.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyvrb.zip">macros/latex/contrib/fancyvrb</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyvrb/">browse the directory</a>) +<dt><tt><i>ledmac.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ledmac.zip">macros/latex/contrib/ledmac</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ledmac/">browse the directory</a>) +<dt><tt><i>lineno.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lineno.zip">macros/latex/contrib/lineno</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lineno/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>moreverb.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/moreverb.zip">macros/latex/contrib/moreverb</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/moreverb/">browse the directory</a>) +<dt><tt><i>numline.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/obsolete/macros/latex/contrib/numline/numline.sty">obsolete/macros/latex/contrib/numline/numline.sty</a> +<dt><tt><i>vruler.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/vruler.sty">macros/latex/contrib/misc/vruler.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linenos">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linenos</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespace.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespace.html index ad76a5fba16..9322e78470a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespace.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespace.html @@ -35,7 +35,7 @@ becoming less common. <p/>Documentation of <i>setspace</i> appears as TeX comments in the package file itself. <dl> -<dt><tt><i>setspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/setspace/setspace.sty">macros/latex/contrib/setspace/setspace.sty</a> +<dt><tt><i>setspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/setspace/setspace.sty">macros/latex/contrib/setspace/setspace.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespread.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespread.html index d08a9a6717f..9b88f051958 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespread.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linespread.html @@ -33,7 +33,7 @@ you want to avoid <i>setspace</i>, beware the behaviour of linespread changes within a paragraph: read “<a href="FAQ-baselinepar.html"><code>\</code><code>baselineskip</code> is a paragraph parameter</a>”. <dl> -<dt><tt><i>setspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/setspace/setspace.sty">macros/latex/contrib/setspace/setspace.sty</a> +<dt><tt><i>setspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/setspace/setspace.sty">macros/latex/contrib/setspace/setspace.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespread">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespread</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linmacnames.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linmacnames.html index af245d94c84..cb3a073af25 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linmacnames.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-linmacnames.html @@ -143,5 +143,6 @@ roman numerals in place of arabic ones: </blockquote><p> which rather spoils the intent of the joke implicit in the example <code>\</code><code>cul8r</code>! +<p><em>This answer was added: 2009-06-03</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linmacnames">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linmacnames</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lit.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lit.html index 4a0fddf3502..64685f090a7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lit.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lit.html @@ -19,7 +19,7 @@ CTAN. Another good source of information is <a href="http://www.literateprogramming.com/">http://www.literateprogramming.com/</a> <dl> <dt><tt><i>Literate Programming FAQ</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivehelp/comp.programming.literate_FAQ">help/comp.programming.literate_FAQ</a> + <a href="http://www.tex.ac.uk/tex-archive/help/comp.programming.literate_FAQ">help/comp.programming.literate_FAQ</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=lit">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=lit</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-logos.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-logos.html index 5a3df91fe7d..021f1107ee7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-logos.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-logos.html @@ -35,8 +35,9 @@ for AMSTeX, <code>Pic</code><code>\</code><code>TeX</code> for PicTeX, <code>Bib</code><code>\</code><code>TeX</code> for BibTeX, and so on. <dl> -<dt><tt><i>mflogo.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mflogo.zip">macros/latex/contrib/mflogo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mflogo/">browse the directory</a>) -<dt><tt><i>texnames.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/biblio/texnames.sty">info/biblio/texnames.sty</a> +<dt><tt><i>mflogo.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mflogo.zip">macros/latex/contrib/mflogo</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mflogo/">browse the directory</a>) +<dt><tt><i>texnames.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/biblio/texnames.sty">info/biblio/texnames.sty</a> </dl> +<p><em>This answer last edited: 2009-06-07</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=logos">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=logos</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lollipop.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lollipop.html index 224689ca94d..636c3768988 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lollipop.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-lollipop.html @@ -22,10 +22,10 @@ it: <p/>The manual goes on to talk of ambitions to “capture some of the LaTeX market share”; it’s a very witty package, but little sign of -it taking over from LaTeX is detectable... +it taking over from LaTeX is detectable… An article about Lollipop appeared in <i>TUGboat</i> 13(3). <dl> -<dt><tt><i>Lollipop distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/lollipop.zip">macros/lollipop</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/lollipop/">browse the directory</a>) +<dt><tt><i>Lollipop distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/lollipop.zip">macros/lollipop</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/lollipop/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=lollipop">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=lollipop</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-longtab.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-longtab.html index 294c0fc71c8..eecefd00baa 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-longtab.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-longtab.html @@ -56,12 +56,12 @@ the end of a page; it also has usability extensions, but doesn’t have the head- and footline capabilities of the major packages. <p/>Documentation of <i>ltablex</i> is to be found in the package file. <dl> -<dt><tt><i>longtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>ltablex.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/ltablex/ltablex.sty">macros/latex/contrib/ltablex/ltablex.sty</a> -<dt><tt><i>ltxtable.sty</i></tt><dd>Generate by running <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/carlisle/ltxtable.tex">macros/latex/contrib/carlisle/ltxtable.tex</a> -<dt><tt><i>stabular.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sttools.zip">macros/latex/contrib/sttools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sttools/">browse the directory</a>) -<dt><tt><i>supertabular.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/supertabular.zip">macros/latex/contrib/supertabular</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/supertabular/">browse the directory</a>) -<dt><tt><i>xtab.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xtab.zip">macros/latex/contrib/xtab</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xtab/">browse the directory</a>) +<dt><tt><i>longtable.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>ltablex.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ltablex/ltablex.sty">macros/latex/contrib/ltablex/ltablex.sty</a> +<dt><tt><i>ltxtable.sty</i></tt><dd>Generate by running <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle/ltxtable.tex">macros/latex/contrib/carlisle/ltxtable.tex</a> +<dt><tt><i>stabular.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sttools.zip">macros/latex/contrib/sttools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sttools/">browse the directory</a>) +<dt><tt><i>supertabular.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/supertabular.zip">macros/latex/contrib/supertabular</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/supertabular/">browse the directory</a>) +<dt><tt><i>xtab.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xtab.zip">macros/latex/contrib/xtab</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xtab/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=longtab">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=longtab</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxabbrv.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxabbrv.html index 0602a30cfc6..205177512e2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxabbrv.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxabbrv.html @@ -11,7 +11,7 @@ space (and to a lesser extent) CPU time. things up. LaTeX, over the years, has extended Knuth’s list by a substantial amount. An interesting feature of the “abbreviations” is that on paper, they may look longer than the thing they stand for; -however, to (La)TeX they <em>feel</em> smaller... +however, to (La)TeX they <em>feel</em> smaller… <p/>The table at the end of this answer lists the commonest of these “abbreviations”. It is not complete; as always, if the table doesn’t help, try the LaTeX source. The table lists each diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxcmds.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxcmds.html index 7f51a835ea0..b03e4365358 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxcmds.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ltxcmds.html @@ -116,7 +116,7 @@ context. <p/>All these .dtx files are on CTAN as part of the main LaTeX distribution. <dl> -<dt><tt><i>LaTeX distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base/">browse the directory</a>) +<dt><tt><i>LaTeX distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ltxcmds">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ltxcmds</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mailliststar.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mailliststar.html index c44c1de89f7..f85050a5024 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mailliststar.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mailliststar.html @@ -18,7 +18,7 @@ subscribe metafont </blockquote><p> to <a href="mailto:sympa@ens.fr"><i>sympa@ens.fr</i></a> <p/>(Note that there’s also a MetaPost-specific mailing list available via the -TUG lists; in fact there’s little danger of becoming confused +TUG list server; in fact there’s little danger of becoming confused by subscribing to both.) <p/>Announcements of TeX-related installations on the CTAN archives are sent to the mailing list <code>ctan-ann</code>. Subscribe diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-make.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-make.html index c70e2f5d5f3..a82c700079c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-make.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-make.html @@ -8,8 +8,11 @@ reasons (for example, “get the table of contents stable”, “get labels stable”, “add the bibliography”, “add the index”) is actually rather difficult to express in the ‘ordinary’ sort of dependency graph that one constructs for <i>make</i>. -<p/>For this reason, the only <i>make</i>-like package on CTAN -(for a long time) was <i>latexmk</i>, which is a <i>Perl</i> +<p/>The <i>latex-make</i> package offers help with this task (far more +sophisticated techniques than in the FAQ building script); it +looks good, but reports of its use (other than by its author) are scarce. +<p/>For a long time, the only <i>make</i>-like package on CTAN +was <i>latexmk</i>, which is a <i>Perl</i> script that analyses your LaTeX source for its dependencies, runs BibTeX or <i>makeindex</i> as and when it notices that those programs’ input (parts of the <code>.aux</code> file, or the @@ -19,11 +22,14 @@ solution (and was used in generating printable versions of these FAQs for a long time); it has recently been upgraded and has many bells and whistles that allow it to operate as if it were a poor man’s WYSIWYG system. -<p/>Apparently along the same lines, and currently (2007) under active -development, is AutoLaTeX. The <i>README</i> of the distribution is -actual a Unix-type man-page output, and shows great attention to the -details of the document production process. -<p/>Windows users of the MiKTeX system may use that systems +<p/>Apparently along the same lines, is AutoLaTeX. The <i>README</i> +of the distribution is actual a Unix-type man-page output, and shows +great attention to the details of the document production process. +<p/>The <i>mk</i> (also, apparently, known as <i>latex_maker</i>) +is a Ruby script for the task in hand; it works well with another of +the author’s scripts script called <i>vpp</i> (View and Print +PostScript/PDF). +<p/>Windows users of the MiKTeX system may use that system’s <i>texify</i> application. <i>Texify</i> deals with basic LaTeX features, including generating a bibliography and an index; it makes no claim to deal with other things (such as multiple @@ -40,11 +46,13 @@ as necessary. FAQ through LaTeX: we don’t present them as a complete solution, but some of the tricks employed are surely re-usable. <dl> -<dt><tt><i>AutoLaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/autolatex.zip">support/autolatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/autolatex/">browse the directory</a>) -<dt><tt><i>FAQ distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq.zip">help/uk-tex-faq</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq/">browse the directory</a>) -<dt><tt><i>latexmake</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/latexmake.zip">support/latexmake</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/latexmake/">browse the directory</a>) -<dt><tt><i>latexmk</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/latexmk.zip">support/latexmk</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/latexmk/">browse the directory</a>) -<dt><tt><i>texi2dvi</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texinfo/texinfo.zip">macros/texinfo/texinfo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texinfo/texinfo/">browse the directory</a>) +<dt><tt><i>AutoLaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/autolatex.zip">support/autolatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/autolatex/">browse the directory</a>) +<dt><tt><i>FAQ distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq.zip">help/uk-tex-faq</a> (or <a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq/">browse the directory</a>) +<dt><tt><i>latexmake</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/latexmake.zip">support/latexmake</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/latexmake/">browse the directory</a>) +<dt><tt><i>latex-make</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/latex-make.zip">support/latex-make</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/latex-make/">browse the directory</a>) +<dt><tt><i>latex_make</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/latex_maker.zip">support/latex_maker</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/latex_maker/">browse the directory</a>) +<dt><tt><i>latexmk</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/latexmk.zip">support/latexmk</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/latexmk/">browse the directory</a>) +<dt><tt><i>texi2dvi</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/texinfo/texinfo.zip">macros/texinfo/texinfo</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/texinfo/texinfo/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=make">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=make</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makebib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makebib.html index 22370d51f09..1a58a6828d2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makebib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makebib.html @@ -5,7 +5,7 @@ <p/>Perhaps you’ve lost the <code>.bib</code> file you generated your document from, or have been sent a document without one. Or even, you’ve realised the error of building a substantial document without the benefit of -BibTeX... +BibTeX… <p/>The <i>Perl</i> script, <i>tex2bib</i> makes a reasonable job of regenerating <code>.bib</code> files from <code>thebibliography</code> environments, provided that the original (whether automatically or @@ -15,8 +15,8 @@ styles. not usually destroy information, it can quite reasonably mislabel it. <p/>Documentation of the script is to be found in the file <i>tex2bib.readme</i> <dl> -<dt><tt><i>tex2bib</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/tex2bib/tex2bib">biblio/bibtex/utils/tex2bib/tex2bib</a> -<dt><tt><i>tex2bib.readme</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/utils/tex2bib/README">biblio/bibtex/utils/tex2bib/README</a> +<dt><tt><i>tex2bib</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/tex2bib/tex2bib">biblio/bibtex/utils/tex2bib/tex2bib</a> +<dt><tt><i>tex2bib.readme</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/utils/tex2bib/README">biblio/bibtex/utils/tex2bib/README</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=makebib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=makebib</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makeindex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makeindex.html index e9acda63103..4d1aa7df88a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makeindex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-makeindex.html @@ -38,16 +38,16 @@ to be included into the document at the next run. highly flexible. Sadly, its take-up is proving rather slow. </dl> <dl> -<dt><tt><i>idxtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/indexing/glo+idxtex.zip">indexing/glo+idxtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/indexing/glo+idxtex/">browse the directory</a>) -<dt><tt><i>ltxindex.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ltxindex.zip">macros/latex/contrib/ltxindex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ltxindex/">browse the directory</a>) -<dt><tt><i>makeindex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/indexing/makeindex.zip">indexing/makeindex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/indexing/makeindex/">browse the directory</a>) -<dt><tt><i>makeindex (Macintosh)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/mac/macmakeindex2.12.sea.hqx">systems/mac/macmakeindex2.12.sea.hqx</a> -<dt><tt><i>texindex (the script)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/indexing/texindex.zip">indexing/texindex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/indexing/texindex/">browse the directory</a>) +<dt><tt><i>idxtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/indexing/glo+idxtex.zip">indexing/glo+idxtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/indexing/glo+idxtex/">browse the directory</a>) +<dt><tt><i>ltxindex.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ltxindex.zip">macros/latex/contrib/ltxindex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ltxindex/">browse the directory</a>) +<dt><tt><i>makeindex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/indexing/makeindex.zip">indexing/makeindex</a> (or <a href="http://www.tex.ac.uk/tex-archive/indexing/makeindex/">browse the directory</a>) +<dt><tt><i>makeindex (Macintosh)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/macmakeindex2.12.sea.hqx">systems/mac/macmakeindex2.12.sea.hqx</a> +<dt><tt><i>texindex (the script)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/indexing/texindex.zip">indexing/texindex</a> (or <a href="http://www.tex.ac.uk/tex-archive/indexing/texindex/">browse the directory</a>) <dt><tt><i>texindex (the program)</i></tt><dd>Distributed - with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texinfo/texinfo.zip">macros/texinfo/texinfo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texinfo/texinfo/">browse the directory</a>) -<dt><tt><i>texsis (system)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texsis.zip">macros/texsis</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texsis/">browse the directory</a>) -<dt><tt><i>texsis (makeindex support)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/texsis/index/index.tex">macros/texsis/index/index.tex</a> -<dt><tt><i>xindy</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveindexing/xindy/">indexing/xindy/</a> + with <a href="http://www.tex.ac.uk/tex-archive/macros/texinfo/texinfo.zip">macros/texinfo/texinfo</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/texinfo/texinfo/">browse the directory</a>) +<dt><tt><i>texsis (system)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/texsis.zip">macros/texsis</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/texsis/">browse the directory</a>) +<dt><tt><i>texsis (makeindex support)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/texsis/index/index.tex">macros/texsis/index/index.tex</a> +<dt><tt><i>xindy</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/indexing/xindy/">indexing/xindy/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=makeindex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=makeindex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-latex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-latex.html index bab58558eec..0b1764aa377 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-latex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-latex.html @@ -20,10 +20,15 @@ only, unfortunately). <p/>The fourth edition of George Grätzer’s book “Math into LaTeX” contains a “short course” in LaTeX itself, and that course has been made publicly available on CTAN. +<p/>Philip Hirschhorn’s “Getting up and running with AMSLaTeX” has a +brief introduction to LaTeX itself, followed by a substantial +introduction to the use of the AMS classes and the +<i>amsmath</i> package and other things that are potentially of +interest to those writing documents containing mathematics. <p/>Edith Hodgen’s <a href="http://www.mcs.vuw.ac.nz/~david/latex/notes.pdf">LaTeX, a Braindump</a> starts you from the ground up — giving a basic tutorial in the use -of <i>Linux</i> to get you going (rather a large file...). +of <i>Linux</i> to get you going (rather a large file…). Its parent site, David Friggens’ <a href="http://www.mcs.vuw.ac.nz/~david/latex/">documentation page</a> is a useful collection of links in itself. @@ -50,16 +55,18 @@ Trettin, translated into English by Jürgen Fenn. The tutorial is available from CTAN as a PDF file (though the source is also available). <dl> -<dt><tt><i>Beginner’s LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/beginlatex/beginlatex-3.6.pdf">info/beginlatex/beginlatex-3.6.pdf</a> -<dt><tt><i>First LaTeX document</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/first-latex-doc.zip">info/first-latex-doc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/first-latex-doc/">browse the directory</a>) -<dt><tt><i>Not so Short Introduction</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/lshort/english/lshort.pdf">info/lshort/english/lshort.pdf</a> +<dt><tt><i>Beginner’s LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/beginlatex/beginlatex-3.6.pdf">info/beginlatex/beginlatex-3.6.pdf</a> +<dt><tt><i>First LaTeX document</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/first-latex-doc.zip">info/first-latex-doc</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/first-latex-doc/">browse the directory</a>) + +<dt><tt><i>Getting up and running with AMSLaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/amslatex/primer.zip">info/amslatex/primer</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/amslatex/primer/">browse the directory</a>) +<dt><tt><i>Not so Short Introduction</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/lshort/english.zip">info/lshort/english</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/lshort/english/">browse the directory</a>) (in English, you may browse for sources and other language versions at - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/lshort/">info/lshort/</a>) -<dt><tt><i>Simplified LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/simplified-latex/simplified-intro.ps">info/simplified-latex/simplified-intro.ps</a> -<dt><tt><i>Short Course in LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/Math_into_LaTeX-4/Short_Course.pdf">info/Math_into_LaTeX-4/Short_Course.pdf</a> + <a href="http://www.tex.ac.uk/tex-archive/info/lshort/">info/lshort/</a>) +<dt><tt><i>Simplified LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/simplified-latex/simplified-intro.ps">info/simplified-latex/simplified-intro.ps</a> +<dt><tt><i>Short Course in LaTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/Math_into_LaTeX-4/Short_Course.pdf">info/Math_into_LaTeX-4/Short_Course.pdf</a> -<dt><tt><i>The sins of LaTeX users</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/l2tabu/english/l2tabuen.pdf">info/l2tabu/english/l2tabuen.pdf</a>; - source also available: <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/l2tabu/english/l2tabuen.tex">info/l2tabu/english/l2tabuen.tex</a> +<dt><tt><i>The sins of LaTeX users</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/l2tabu/english/l2tabuen.pdf">info/l2tabu/english/l2tabuen.pdf</a>; + source also available: <a href="http://www.tex.ac.uk/tex-archive/info/l2tabu/english/l2tabuen.tex">info/l2tabu/english/l2tabuen.tex</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=man-latex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=man-latex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-tex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-tex.html index 457aee3f638..20699b466ce 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-tex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-man-tex.html @@ -7,7 +7,7 @@ <p/>Another recommendable document is D. R. Wilkins ‘Getting started with TeX’, available on the web at <a href="http://www.ntg.nl/doc/wilkins/pllong.pdf">http://www.ntg.nl/doc/wilkins/pllong.pdf</a> <dl> -<dt><tt><i>Gentle Introduction</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/gentle/gentle.pdf">info/gentle/gentle.pdf</a> +<dt><tt><i>Gentle Introduction</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/gentle/gentle.pdf">info/gentle/gentle.pdf</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=man-tex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=man-tex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-manymathalph.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-manymathalph.html index f35a28a3247..25be7aef46a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-manymathalph.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-manymathalph.html @@ -35,7 +35,7 @@ and then steadily reduce the bold families, starting with </blockquote><p> until (with a bit of luck) the error goes away. <dl> -<dt><tt><i>bm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>bm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=manymathalph">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=manymathalph</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginparside.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginparside.html index fd4f38b0dd7..b0b9d1769d3 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginparside.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginparside.html @@ -24,8 +24,8 @@ of the page each <code>\</code><code>marginpar</code> <em>should</em> be on. Th <i>mparhack</i> package does this, using label-like marks stored in the <code>.aux</code> file; the <i>memoir</i> class does likewise. <dl> -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>mparhack.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mparhack.zip">macros/latex/contrib/mparhack</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mparhack/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>mparhack.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mparhack.zip">macros/latex/contrib/mparhack</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mparhack/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=marginparside">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=marginparside</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginpkgs.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginpkgs.html index 1a5fca7b229..0d497fe6db9 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginpkgs.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-marginpkgs.html @@ -19,12 +19,12 @@ canned set of paper sizes (a superset of that provided in LaTeX2e), provision for custom paper, margin adjustments and provision for two-sided printing. <dl> -<dt><tt><i>geometry.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/geometry.zip">macros/latex/contrib/geometry</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/geometry/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>layout.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>typearea.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>vmargin.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/vmargin.zip">macros/latex/contrib/vmargin</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/vmargin/">browse the directory</a>) +<dt><tt><i>geometry.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/geometry.zip">macros/latex/contrib/geometry</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/geometry/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>layout.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>typearea.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>vmargin.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/vmargin.zip">macros/latex/contrib/vmargin</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/vmargin/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=marginpkgs">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=marginpkgs</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathlips.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathlips.html index 6c621cdea64..59dbe7d7559 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathlips.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathlips.html @@ -35,11 +35,11 @@ distribution (thus saving you the bother of installing the package before being able to read the documentation). Documentation of <i>mathdots</i> appears at the end the package file itself. <dl> -<dt><tt><i>amslatex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) -<dt><tt><i>graphics.sty</i></tt><dd>Part of the <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle -<dt><tt><i>mathdots.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/mathdots.zip">macros/generic/mathdots</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/generic/mathdots/">browse the directory</a>) -<dt><tt><i>yhmath (fonts)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/yhmath.zip">fonts/yhmath</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/yhmath/">browse the directory</a>) -<dt><tt><i>yhmath (macros)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/yhmath.zip">macros/latex/contrib/yhmath</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/yhmath/">browse the directory</a>) +<dt><tt><i>amslatex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>graphics.sty</i></tt><dd>Part of the <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) bundle +<dt><tt><i>mathdots.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/mathdots.zip">macros/generic/mathdots</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/generic/mathdots/">browse the directory</a>) +<dt><tt><i>yhmath (fonts)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/yhmath.zip">fonts/yhmath</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/yhmath/">browse the directory</a>) +<dt><tt><i>yhmath (macros)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/yhmath.zip">macros/latex/contrib/yhmath</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/yhmath/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathlips">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathlips</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathml.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathml.html index 331b1c4109f..9b1fb121139 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathml.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathml.html @@ -73,7 +73,7 @@ support for new Web standards. has appeared, and has been reported to be useful for SVG-related work in at least one TeX-related project. Be aware that the developers of <i>Inkscape</i> have no illusions - about being able to replace commercial software, yet... + about being able to replace commercial software, yet… <dt>Direct use of TeX markup<dd> Some time back, IBM developed a browser plug-in called TechExplorer, which would display (La)TeX documents direct in a @@ -97,10 +97,10 @@ support for new Web standards. (<i>Mathtex</i> supersedes the author’s earlier <i>mimetex</i>.) </dl> <dl> -<dt><tt><i>GELLMU</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/gellmu.zip">support/gellmu</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/gellmu/">browse the directory</a>) -<dt><tt><i>MathTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/mimetex/">support/mimetex/</a> -<dt><tt><i>MimeTeX</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/mimetex/">support/mimetex/</a> -<dt><tt><i>TeX4HT</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/TeX4ht/tex4ht-all.zip">support/TeX4ht/tex4ht-all.zip</a> +<dt><tt><i>GELLMU</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/gellmu.zip">support/gellmu</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/gellmu/">browse the directory</a>) +<dt><tt><i>MathTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/mimetex/">support/mimetex/</a> +<dt><tt><i>MimeTeX</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/mimetex/">support/mimetex/</a> +<dt><tt><i>TeX4HT</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/TeX4ht/tex4ht-all.zip">support/TeX4ht/tex4ht-all.zip</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathml">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathml</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathonlyref.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathonlyref.html index 1f280e7c9d2..7baff8732b4 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathonlyref.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathonlyref.html @@ -19,7 +19,7 @@ operation, only those equations to which you make reference will be numbered in the final output. See the package’s documentation for details of how to make references when the switch is in effect. <dl> -<dt><tt><i>mathtools.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mh.zip">macros/latex/contrib/mh</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mh/">browse the directory</a>) +<dt><tt><i>mathtools.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mh.zip">macros/latex/contrib/mh</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mh/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathonlyref">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathonlyref</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathsize.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathsize.html index ed50a94dcdc..a39320aab6c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathsize.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathsize.html @@ -51,8 +51,8 @@ Beware simply copying (parts of) the LaTeX definitions — since they contain those internal abbreviations, they need to be treated as <a href="FAQ-atsigns.html">internal commands</a>. <dl> -<dt><tt><i>fontdef.dtx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/base/fontdef.dtx">macros/latex/base/fontdef.dtx</a> -<dt><tt><i>fontmath.ltx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/unpacked/fontmath.ltx">macros/latex/unpacked/fontmath.ltx</a> +<dt><tt><i>fontdef.dtx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/fontdef.dtx">macros/latex/base/fontdef.dtx</a> +<dt><tt><i>fontmath.ltx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/unpacked/fontmath.ltx">macros/latex/unpacked/fontmath.ltx</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathsize">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathsize</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathstext.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathstext.html index 872da227970..47d164928cc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathstext.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mathstext.html @@ -29,16 +29,14 @@ at the surrounding text size, so that $z = a_{\mbox{other end}}$ </pre> </blockquote><p> -looks quite painfully wrong. -<p/>The other simple technique, <code>\</code><code>textrm</code>, is more promising: +can look quite painfully wrong. +<p/>The other simple technique, <code>\</code><code>textrm</code>, is no more promising: <blockquote> <pre> $z = a_{\textrm{other end}}$ </pre> </blockquote><p> -is definitely right. However, the surrounding text may not be in your -roman font; if you care about matching text, you need to choose -between <code>\</code><code>textrm</code>, <code>\</code><code>textsf</code>, and so on. +does the same as <code>\</code><code>mbox</code>, by default. <p/>(The maths-mode instance of your roman font (<code>\</code><code>mathrm</code>) gets the size right, but since it’s intended for use in maths, its spaces get ignored — use <code>\</code><code>mathrm</code> for upright roman alphabetic variable @@ -51,14 +49,14 @@ $z = a_{\mbox{\scriptsize other end}}$ </blockquote><p> which works if your surrounding text is at default document size, but gives you the wrong size otherwise. -<p/>These short cuts are (just about) OK for the “occasional” -mathematician, but serious mathematics calls for a technique that +<p/>The <code>\</code><code>mbox</code> short cut is (just about) OK for “occasional” +use, but serious mathematics calls for a technique that relieves the typist of the sort of thought required. As usual, the AMSLaTeX system provides what’s necessary — the <code>\</code><code>text</code> -command. The command is actually provided by the <i>amstext</i> -package, but the “global” <i>amsmath</i> package loads it, so +command. (The command is actually provided by the <i>amstext</i> +package, but the “global” <i>amsmath</i> package loads it.) Thus anyone using AMSLaTeX proper has the command available, so even -joke mathematicians can write: +this author can write: <blockquote> <pre> \usepackage{amsmath} @@ -67,7 +65,9 @@ $z = a_{\text{other end}}$ </pre> </blockquote><p> and the text will be at the right size, and in the same font as -surrounding text. +surrounding text. (The <i>amstext</i> package also puts +<code>\</code><code>textrm</code> to rights — but <code>\</code><code>text</code> is easier to type than +<code>\</code><code>textrm</code>!) <p/>AMSLaTeX also makes provision for interpolated comments in the middle of one of its multi-line display structures, through the <code>\</code><code>intertext</code> command. For example: @@ -112,13 +112,13 @@ signs): at <a href="ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf">ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf</a> <dl> <dt><tt><i>amsldoc.tex</i></tt><dd>Distributed as part of AMSLaTeX - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) <dt><tt><i>amsmath.sty</i></tt><dd>Distributed as part of AMSLaTeX - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) <dt><tt><i>amstext.sty</i></tt><dd>Distributed as part of AMSLaTeX - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) <dt><tt><i>mathtools.sty</i></tt><dd>Distributed as part of the <i>mh</i> bundle - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mh.zip">macros/latex/contrib/mh</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mh/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mh.zip">macros/latex/contrib/mh</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mh/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathstext">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mathstext</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcfloat.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcfloat.html index 7dae8d65509..e5b3cd9f26a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcfloat.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcfloat.html @@ -28,8 +28,8 @@ won’t ‘float’, and exhibit other strange behaviours (such as s running off the end of the column at the end of the <code>multicols</code> environment). <dl> -<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float/">browse the directory</a>) -<dt><tt><i>multicol.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float/">browse the directory</a>) +<dt><tt><i>multicol.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mcfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mcfloat</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcite.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcite.html index 64504221f1d..f6896650e09 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcite.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mcite.html @@ -50,10 +50,11 @@ sees a sequence </blockquote><p> it will collect <code>paper1</code> and <code>paper2</code> as a multiple reference. <dl> -<dt><tt><i>collref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/collref.zip">macros/latex/contrib/collref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/collref/">browse the directory</a>) -<dt><tt><i>mcite.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mcite.zip">macros/latex/contrib/mcite</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mcite/">browse the directory</a>) -<dt><tt><i>mciteplus.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mciteplus.zip">macros/latex/contrib/mciteplus</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mciteplus/">browse the directory</a>) -<dt><tt><i>revtex bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/revtex.zip">macros/latex/contrib/revtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/revtex/">browse the directory</a>) +<dt><tt><i>collref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/collref.zip">macros/latex/contrib/collref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/collref/">browse the directory</a>) +<dt><tt><i>mcite.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mcite.zip">macros/latex/contrib/mcite</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mcite/">browse the directory</a>) +<dt><tt><i>mciteplus.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mciteplus.zip">macros/latex/contrib/mciteplus</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mciteplus/">browse the directory</a>) +<dt><tt><i>revtex bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/revtex.zip">macros/latex/contrib/revtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/revtex/">browse the directory</a>) </dl> +<p><em>This answer last edited: 2009-06-09</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mcite">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mcite</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-metrics.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-metrics.html index 402bf048b4d..c691672103f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-metrics.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-metrics.html @@ -48,10 +48,10 @@ software, and is available on CTAN. <dl> -<dt><tt><i>dvips</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvips.zip">dviware/dvips</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvips/">browse the directory</a>) -<dt><tt><i>EdMetrics</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/mac/textures/utilities/EdMetrics.sea.hqx">systems/mac/textures/utilities/EdMetrics.sea.hqx</a> -<dt><tt><i>fontinst</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst/">browse the directory</a>) -<dt><tt><i>LY1 support</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psnfssx/ly1.zip">macros/latex/contrib/psnfssx/ly1</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psnfssx/ly1/">browse the directory</a>) +<dt><tt><i>dvips</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvips.zip">dviware/dvips</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvips/">browse the directory</a>) +<dt><tt><i>EdMetrics</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/textures/utilities/EdMetrics.sea.hqx">systems/mac/textures/utilities/EdMetrics.sea.hqx</a> +<dt><tt><i>fontinst</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst/">browse the directory</a>) +<dt><tt><i>LY1 support</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psnfssx/ly1.zip">macros/latex/contrib/psnfssx/ly1</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psnfssx/ly1/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=metrics">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=metrics</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mfptutorials.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mfptutorials.html index 5e527618748..cbb848ee5a9 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mfptutorials.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mfptutorials.html @@ -40,9 +40,9 @@ most certainly valuable learning material. Urs Oswald presents a <a href="http://www.ursoswald.ch/metapost/tutorial.pdf">similar document</a>, written more as a document, and presented in PDF. <dl> -<dt><tt><i>Beginners’ guide</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/metafont/beginners/metafont-for-beginners.pdf">info/metafont/beginners/metafont-for-beginners.pdf</a> -<dt><tt><i>Peter Wilson’s “experiences”</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/metafont/metafp/metafp.pdf">info/metafont/metafp/metafp.pdf</a> -<dt><tt><i>Vincent Zoonekynd’s examples</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/metapost/examples.zip">info/metapost/examples</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/metapost/examples/">browse the directory</a>) +<dt><tt><i>Beginners’ guide</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/metafont/beginners/metafont-for-beginners.pdf">info/metafont/beginners/metafont-for-beginners.pdf</a> +<dt><tt><i>Peter Wilson’s “experiences”</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/metafont/metafp/metafp.pdf">info/metafont/metafp/metafp.pdf</a> +<dt><tt><i>Vincent Zoonekynd’s examples</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/metapost/examples.zip">info/metapost/examples</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/metapost/examples/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mfptutorials">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mfptutorials</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minitoc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minitoc.html index 4ab91c8f3b7..59f00e55728 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minitoc.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minitoc.html @@ -34,9 +34,9 @@ version of the <i>hyperref</i> package does know about <i>minitoc</i> and treats <code>\</code><code>minitoc</code> tables in the same way as “real” tables of contents. <dl> -<dt><tt><i>babel.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/babel.zip">macros/latex/required/babel</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/babel/">browse the directory</a>) -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>minitoc.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/minitoc.zip">macros/latex/contrib/minitoc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/minitoc/">browse the directory</a>) +<dt><tt><i>babel.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/babel.zip">macros/latex/required/babel</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/babel/">browse the directory</a>) +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>minitoc.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/minitoc.zip">macros/latex/contrib/minitoc</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/minitoc/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minitoc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minitoc</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minxampl.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minxampl.html index 75e9c7b1b0f..3b6aeec0540 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minxampl.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-minxampl.html @@ -50,7 +50,7 @@ be useful evidence for people trying to help you. <p/>What if your document simply doesn’t fail in any of these cut-down scenarios? Whatever you do, don’t post the whole of the document: if you can, it may be useful to make a copy available on the web -somewhere: people will probably understand if it’s impossible ... +somewhere: people will probably understand if it’s impossible … or inadvisable, in the case of something confidential. <p/>If the whole document is necessary, it could be that it’s an overflow of some sort; the best you can do is to post the code “around” the diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-misssymb.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-misssymb.html index d9b2e197b70..97bac2f33e9 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-misssymb.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-misssymb.html @@ -10,8 +10,7 @@ the LaTeX distribution), and in the <i>amsfonts</i> package (which is part of the AMS distribution, and requires AMS symbol fonts). <dl> -<dt><tt><i>amsfonts.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/latex.zip">fonts/amsfonts/latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/latex/">browse the directory</a>) -<dt><tt><i>AMS symbol fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/symbols.zip">fonts/amsfonts/sources/symbols</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/symbols/">browse the directory</a>) +<dt><tt><i>AMS fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=misssymb">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=misssymb</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-moren9.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-moren9.html index 03732af2bad..0606222fef5 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-moren9.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-moren9.html @@ -58,7 +58,7 @@ doesn’t have to remember that argument twelve is <code>soiltype</code>, an on: the commands may be copied from field notes quickly and accurately. <dl> -<dt><tt><i>keyval.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/graphics/">browse the directory</a>) +<dt><tt><i>keyval.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics.zip">macros/latex/required/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/graphics/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=moren9">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=moren9</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mpprologues.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mpprologues.html index 6ff755deea3..b7430533bc6 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mpprologues.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-mpprologues.html @@ -74,11 +74,11 @@ set up to look like a proof sheet. <p/>A script application, <i>mptopdf</i>, is available in recent (La)TeX distributions: it seems fairly reliably to produce PDF from MetaPost, so may reasonably be considered an answer to -the question... +the question… <dl> -<dt><tt><i>mps2eps</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/mps2eps.zip">support/mps2eps</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/mps2eps/">browse the directory</a>) -<dt><tt><i>mpsproof.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivegraphics/metapost/contrib/misc/mpsproof.tex">graphics/metapost/contrib/misc/mpsproof.tex</a> -<dt><tt><i>mptopdf</i></tt><dd>Part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/pdftex/graphics.zip">macros/pdftex/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/pdftex/graphics/">browse the directory</a>) +<dt><tt><i>mps2eps</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/mps2eps.zip">support/mps2eps</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/mps2eps/">browse the directory</a>) +<dt><tt><i>mpsproof.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/metapost/contrib/misc/mpsproof.tex">graphics/metapost/contrib/misc/mpsproof.tex</a> +<dt><tt><i>mptopdf</i></tt><dd>Part of <a href="http://www.tex.ac.uk/tex-archive/macros/pdftex/graphics.zip">macros/pdftex/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/pdftex/graphics/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mpprologues">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=mpprologues</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-msxy.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-msxy.html index d163eb59b3a..014fb2e77a7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-msxy.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-msxy.html @@ -22,8 +22,8 @@ letter in the font names). <p/>If you have a DVI file that requests the fonts, there is a package of <a href="FAQ-virtualfonts.html">virtual fonts</a> to map the old to the new series. <dl> -<dt><tt><i>msa and msb fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/symbols.zip">fonts/amsfonts/sources/symbols</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/symbols/">browse the directory</a>) -<dt><tt><i>virtual font set</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/vf-files/msx2msa.zip">fonts/vf-files/msx2msa</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/vf-files/msx2msa/">browse the directory</a>) +<dt><tt><i>msa and msb fonts</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) +<dt><tt><i>virtual font set</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/vf-files/msx2msa.zip">fonts/vf-files/msx2msa</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/vf-files/msx2msa/">browse the directory</a>) </dl> <p/> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=msxy">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=msxy</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multbib.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multbib.html index 01a09a98fc7..89f59c8d41a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multbib.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multbib.html @@ -135,10 +135,10 @@ sorting process.) A code example appears in the package documentation which you can browse to, from the link, below). <dl> -<dt><tt><i>bibtopic.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bibtopic.zip">macros/latex/contrib/bibtopic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bibtopic/">browse the directory</a>) -<dt><tt><i>multibbl.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multibbl.zip">macros/latex/contrib/multibbl</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multibbl/">browse the directory</a>) -<dt><tt><i>multibib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multibib.zip">macros/latex/contrib/multibib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multibib/">browse the directory</a>) -<dt><tt><i>splitbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/splitbib.zip">macros/latex/contrib/splitbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/splitbib/">browse the directory</a>) +<dt><tt><i>bibtopic.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bibtopic.zip">macros/latex/contrib/bibtopic</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bibtopic/">browse the directory</a>) +<dt><tt><i>multibbl.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multibbl.zip">macros/latex/contrib/multibbl</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multibbl/">browse the directory</a>) +<dt><tt><i>multibib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multibib.zip">macros/latex/contrib/multibib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multibib/">browse the directory</a>) +<dt><tt><i>splitbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/splitbib.zip">macros/latex/contrib/splitbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/splitbib/">browse the directory</a>) </dl> <p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multbib">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multbib</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multfoot.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multfoot.html index cea1dcc0dbd..1f8f1c05cfc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multfoot.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multfoot.html @@ -17,11 +17,11 @@ presentation options, as well. Another critical edition its highly sophisticated structure of footnote facilities, which was also designed to support typesetting critical editions. <dl> -<dt><tt><i>bigfoot</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) -<dt><tt><i>edmac</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/edmac.zip">macros/plain/contrib/edmac</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/contrib/edmac/">browse the directory</a>) -<dt><tt><i>ednotes</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ednotes.zip">macros/latex/contrib/ednotes</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ednotes/">browse the directory</a>) -<dt><tt><i>ledmac</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ledmac.zip">macros/latex/contrib/ledmac</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ledmac/">browse the directory</a>) -<dt><tt><i>manyfoot.sty</i></tt><dd>Distributed as part of the <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ncctools.zip">macros/latex/contrib/ncctools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ncctools/">browse the directory</a>) +<dt><tt><i>bigfoot</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot.zip">macros/latex/contrib/bigfoot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bigfoot/">browse the directory</a>) +<dt><tt><i>edmac</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/edmac.zip">macros/plain/contrib/edmac</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/edmac/">browse the directory</a>) +<dt><tt><i>ednotes</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ednotes.zip">macros/latex/contrib/ednotes</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ednotes/">browse the directory</a>) +<dt><tt><i>ledmac</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ledmac.zip">macros/latex/contrib/ledmac</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ledmac/">browse the directory</a>) +<dt><tt><i>manyfoot.sty</i></tt><dd>Distributed as part of the <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ncctools.zip">macros/latex/contrib/ncctools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ncctools/">browse the directory</a>) bundle </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multfoot">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multfoot</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multidoc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multidoc.html index e729a4bbd0a..26bc1a42775 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multidoc.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multidoc.html @@ -41,14 +41,14 @@ optional argument of the command, you can specify which pages you want to be included from the file named, and various details of the layout of the included pages. <dl> -<dt><tt><i>combine.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/combine.zip">macros/latex/contrib/combine</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/combine/">browse the directory</a>) -<dt><tt><i>combinet.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/combine.zip">macros/latex/contrib/combine</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/combine/">browse the directory</a>) +<dt><tt><i>combine.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/combine.zip">macros/latex/contrib/combine</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/combine/">browse the directory</a>) +<dt><tt><i>combinet.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/combine.zip">macros/latex/contrib/combine</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/combine/">browse the directory</a>) <dt><tt><i>includex.sty</i></tt><dd>Distributed in the “unsupported” part of - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/frankenstein.zip">macros/latex/contrib/frankenstein</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/frankenstein/">browse the directory</a>) -<dt><tt><i>moredefs.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/frankenstein.zip">macros/latex/contrib/frankenstein</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/frankenstein/">browse the directory</a>) -<dt><tt><i>newclude.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/frankenstein.zip">macros/latex/contrib/frankenstein</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/frankenstein/">browse the directory</a>) -<dt><tt><i>pdfpages.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdfpages.zip">macros/latex/contrib/pdfpages</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdfpages/">browse the directory</a>) -<dt><tt><i>subfiles.cls, etc.</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/subfiles.zip">macros/latex/contrib/subfiles</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/subfiles/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/frankenstein.zip">macros/latex/contrib/frankenstein</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/frankenstein/">browse the directory</a>) +<dt><tt><i>moredefs.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/frankenstein.zip">macros/latex/contrib/frankenstein</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/frankenstein/">browse the directory</a>) +<dt><tt><i>newclude.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/frankenstein.zip">macros/latex/contrib/frankenstein</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/frankenstein/">browse the directory</a>) +<dt><tt><i>pdfpages.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdfpages.zip">macros/latex/contrib/pdfpages</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdfpages/">browse the directory</a>) +<dt><tt><i>subfiles.cls, etc.</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/subfiles.zip">macros/latex/contrib/subfiles</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/subfiles/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multidoc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multidoc</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multind.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multind.html index 1c5d7a50083..5cfa73dfebf 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multind.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multind.html @@ -42,7 +42,7 @@ before running LaTeX again. Note that the names of the index files to process are not necessarily related to the name of the LaTeX file you’re processing, at all. (There’s no documentation that comes with the package: what you see above is as good as you will -get...) +get…) <p/>The <i>index</i> package provides a comprehensive set of indexing facilities, including a <code>\</code><code>newindex</code> command that allows the definition of new styles of index. <code>\</code><code>newindex</code> takes a ‘tag’ (for @@ -114,12 +114,12 @@ the documentation. well as its own index layout options, which other packages delegate to the index style used by <i>makeindex</i>). <dl> -<dt><tt><i>index.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/index.zip">macros/latex/contrib/index</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/index/">browse the directory</a>) +<dt><tt><i>index.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/index.zip">macros/latex/contrib/index</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/index/">browse the directory</a>) <dt><tt><i>makeidx.sty</i></tt><dd>Part of the LaTeX distribution -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>multind.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex209/contrib/misc/multind.sty">macros/latex209/contrib/misc/multind.sty</a> +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>multind.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/misc/multind.sty">macros/latex209/contrib/misc/multind.sty</a> <dt><tt><i>splitidx.sty and splitindex</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/splitindex.zip">macros/latex/contrib/splitindex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/splitindex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/splitindex.zip">macros/latex/contrib/splitindex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/splitindex/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multirow.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multirow.html index a36fa952086..c14facf39ad 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multirow.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-multirow.html @@ -91,8 +91,8 @@ rows in the multi-row have been opened up with <code>\</code><code>bigstrut</cod <p/>The documentation of both <i>multirow</i> and <i>bigstrut</i> is to be found, as comments, in the package files themselves. <dl> -<dt><tt><i>bigstrut.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multirow.zip">macros/latex/contrib/multirow</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multirow/">browse the directory</a>) -<dt><tt><i>multirow.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multirow.zip">macros/latex/contrib/multirow</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multirow/">browse the directory</a>) +<dt><tt><i>bigstrut.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multirow.zip">macros/latex/contrib/multirow</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multirow/">browse the directory</a>) +<dt><tt><i>multirow.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multirow.zip">macros/latex/contrib/multirow</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multirow/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multirow">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multirow</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-music.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-music.html index 3c799ce6564..914123a4f8e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-music.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-music.html @@ -47,15 +47,15 @@ less cryptic than is MusixTeX’s, and it handles much more stuff automatically, yielding the same or better quality with less effort. Lilypond can also produce basic MIDI output. <dl> -<dt><tt><i>abc2mtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/abc2mtex/">support/abc2mtex/</a> -<dt><tt><i>M-Tx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/mtx.zip">support/mtx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/mtx/">browse the directory</a>) -<dt><tt><i>midi2tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/midi2tex.zip">support/midi2tex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/midi2tex/">browse the directory</a>) -<dt><tt><i>musictex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/musictex.zip">macros/musictex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/musictex/">browse the directory</a>) +<dt><tt><i>abc2mtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/abc2mtex/">support/abc2mtex/</a> +<dt><tt><i>M-Tx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/mtx.zip">support/mtx</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/mtx/">browse the directory</a>) +<dt><tt><i>midi2tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/midi2tex.zip">support/midi2tex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/midi2tex/">browse the directory</a>) +<dt><tt><i>musictex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/musictex.zip">macros/musictex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/musictex/">browse the directory</a>) -<dt><tt><i>musixtex (Taupin’s version)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/musixtex/taupin.zip">macros/musixtex/taupin</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/musixtex/taupin/">browse the directory</a>) -<dt><tt><i>musixtex (Egler’s version)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/musixtex/egler.zip">macros/musixtex/egler</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/musixtex/egler/">browse the directory</a>) -<dt><tt><i>mutex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/mtex.zip">macros/mtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/mtex/">browse the directory</a>) -<dt><tt><i>pmx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pmx.zip">support/pmx</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pmx/">browse the directory</a>) +<dt><tt><i>musixtex (Taupin’s version)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/musixtex/taupin.zip">macros/musixtex/taupin</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/musixtex/taupin/">browse the directory</a>) +<dt><tt><i>musixtex (Egler’s version)</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/musixtex/egler.zip">macros/musixtex/egler</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/musixtex/egler/">browse the directory</a>) +<dt><tt><i>mutex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/mtex.zip">macros/mtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/mtex/">browse the directory</a>) +<dt><tt><i>pmx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/pmx.zip">support/pmx</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/pmx/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=music">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=music</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nameref.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nameref.html index 4ac4c5e52fc..75cc2e990a8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nameref.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nameref.html @@ -54,13 +54,13 @@ optional ‘short’ title argument to the chapter and section commands. (Although it comes from the same author, <i>zref</i> <em>doesn’t</em> define a short-name variant.) <dl> -<dt><tt><i>byname.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/smartref.zip">macros/latex/contrib/smartref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/smartref/">browse the directory</a>) -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>nameref.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>smartref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/smartref.zip">macros/latex/contrib/smartref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/smartref/">browse the directory</a>) -<dt><tt><i>titleref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/titleref.sty">macros/latex/contrib/misc/titleref.sty</a> -<dt><tt><i>zref.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>byname.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/smartref.zip">macros/latex/contrib/smartref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/smartref/">browse the directory</a>) +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>nameref.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>smartref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/smartref.zip">macros/latex/contrib/smartref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/smartref/">browse the directory</a>) +<dt><tt><i>titleref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/titleref.sty">macros/latex/contrib/misc/titleref.sty</a> +<dt><tt><i>zref.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nameref">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nameref</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newans.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newans.html index ef30f7e75d9..70612a9a039 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newans.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newans.html @@ -26,7 +26,7 @@ distribution: this isn’t the code actually used on the Web site, but it’s a close relation and is kept up to date for development purposes. <dl> -<dt><tt><i>FAQ distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq.zip">help/uk-tex-faq</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq/">browse the directory</a>) +<dt><tt><i>FAQ distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq.zip">help/uk-tex-faq</a> (or <a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newans">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newans</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfontstar.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfontstar.html index 70ce959aeee..b539da2f62a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfontstar.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfontstar.html @@ -46,7 +46,7 @@ use <code>\</code><code>newfont</code> — viz., to get a font size that doe the Knuth standard set of sizes: LaTeX (by default) won’t allow you to use such a size. Don’t despair: see the answer “<a href="FAQ-fontsize.html">arbitrary font sizes</a>”. -<p/> -<p/> +<p/><p/> + <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newfont*">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newfont*</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfunction.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfunction.html index 10bc3a4b4a3..47f72afd9df 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfunction.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newfunction.html @@ -49,7 +49,7 @@ As with <code>\</code><code>DeclareMathOperator</code> there’s a starred v <p/>(It should be noted that “log-like” was reportedly a <em>joke</em> on Lamport’s part; it is of course clear what was meant.) <dl> -<dt><tt><i>amsopn.sty</i></tt><dd>In the AMSLaTeX distribution <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>amsopn.sty</i></tt><dd>In the AMSLaTeX distribution <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newfunction">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newfunction</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newlang.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newlang.html index 02178b00a16..3face68f978 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newlang.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-newlang.html @@ -94,8 +94,8 @@ size is a fiddle. If you <em>do</em> find you’ve run out of memory, it may be worth scanning the list of languages in your <i>language.dat</i> to see whether any could reasonably be removed. <dl> -<dt><tt><i>babel</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/babel.zip">macros/latex/required/babel</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/babel/">browse the directory</a>) -<dt><tt><i>hyphenation patterns</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/language/hyphenation.zip">language/hyphenation</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/language/hyphenation/">browse the directory</a>) +<dt><tt><i>babel</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/babel.zip">macros/latex/required/babel</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/babel/">browse the directory</a>) +<dt><tt><i>hyphenation patterns</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/language/hyphenation.zip">language/hyphenation</a> (or <a href="http://www.tex.ac.uk/tex-archive/language/hyphenation/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newlang">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=newlang</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nocitestar.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nocitestar.html index edc1d6231d9..64b7c2f1ad4 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nocitestar.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nocitestar.html @@ -24,8 +24,8 @@ was written for use under LaTeX 2.09, but seems to work well enough; in the old days of LaTeX systems with very little free memory; this problem is less significant now than it once was.) <dl> -<dt><tt><i>biblist.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex209/contrib/biblist.zip">macros/latex209/contrib/biblist</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex209/contrib/biblist/">browse the directory</a>) -<dt><tt><i>listbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/listbib.zip">macros/latex/contrib/listbib</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/listbib/">browse the directory</a>) +<dt><tt><i>biblist.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/biblist.zip">macros/latex209/contrib/biblist</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/biblist/">browse the directory</a>) +<dt><tt><i>listbib.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/listbib.zip">macros/latex/contrib/listbib</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/listbib/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nocite*">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nocite*</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nofm.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nofm.html index c8f0a7a9736..5dab769aeba 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nofm.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nofm.html @@ -13,8 +13,8 @@ defines a “last page” label. how one might actually use this information to produce page numbering as suggested in the question. <dl> -<dt><tt><i>fancyhdr documentation</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) -<dt><tt><i>lastpage.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lastpage.zip">macros/latex/contrib/lastpage</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/lastpage/">browse the directory</a>) +<dt><tt><i>fancyhdr documentation</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) +<dt><tt><i>lastpage.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lastpage.zip">macros/latex/contrib/lastpage</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/lastpage/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nofm">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nofm</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nohyph.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nohyph.html index 5e2b57939c7..439370de630 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nohyph.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nohyph.html @@ -36,7 +36,7 @@ to install it.) </pre> </blockquote><p> This is <em>not</em> the sort of thing this FAQ would - ordinarily recommend... The <i>hyphenat</i> package defines a + ordinarily recommend… The <i>hyphenat</i> package defines a bundle of such commands (for introducing hyphenation points at various punctuation characters). <li> There may be accents in the word. The causes of and remedies @@ -57,9 +57,9 @@ argument — <code>\</code><code>hyphenation{ana-lysis pot-able}</code>; not (as here, for analysis) you can use the command to overrule TeX’s choice of hyphenation (ana-lysis is the British etymological hyphenation; some feel the American hyphenation feels -‘unfortunate’...). +‘unfortunate’…). <dl> -<dt><tt><i>hyphenat.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyphenat.zip">macros/latex/contrib/hyphenat</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyphenat/">browse the directory</a>) +<dt><tt><i>hyphenat.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyphenat.zip">macros/latex/contrib/hyphenat</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyphenat/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nohyph">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nohyph</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-noline.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-noline.html index db215606036..5bc40aaa264 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-noline.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-noline.html @@ -76,8 +76,8 @@ be had by saying: </pre> </blockquote><p> <dl> -<dt><tt><i>expdlist.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expdlist.zip">macros/latex/contrib/expdlist</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/expdlist/">browse the directory</a>) -<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) +<dt><tt><i>expdlist.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expdlist.zip">macros/latex/contrib/expdlist</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/expdlist/">browse the directory</a>) +<dt><tt><i>mdwlist.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) </dl> <p/> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=noline">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=noline</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonfree.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonfree.html index 97507d39d63..a873fc08e0e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonfree.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonfree.html @@ -31,7 +31,7 @@ whether you should distribute; if the package is not listed in the catalogue, don’t think of distributing it”. </blockquote><p> (The catalogue only has a modest -<a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/Catalogue/licenses.html">list of licences</a>, but it covers the set used +<a href="http://www.tex.ac.uk/tex-archive/help/Catalogue/licenses.html">list of licences</a>, but it covers the set used by packages on CTAN, with a wild-card “<code>other-free</code>” which covers packages that the CTAN administrators believe to be free even though the authors haven’t used a standard licence.) diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonpdfsp.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonpdfsp.html index 9b284aedc42..d7062c80917 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonpdfsp.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonpdfsp.html @@ -30,8 +30,8 @@ decide to try PDFLaTeX, you <em>must</em> remove the <code>dvips</code> or <code>dvipdfm</code> driver specification from the package options, and let the system recognise which driver is needed. <dl> -<dt><tt><i>pdftricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdftricks.zip">macros/latex/contrib/pdftricks</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdftricks/">browse the directory</a>) -<dt><tt><i>pstricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pstricks.zip">graphics/pstricks</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pstricks/">browse the directory</a>) +<dt><tt><i>pdftricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdftricks.zip">macros/latex/contrib/pdftricks</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdftricks/">browse the directory</a>) +<dt><tt><i>pstricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/pstricks.zip">graphics/pstricks</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pstricks/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nonpdfsp">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nonpdfsp</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonum.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonum.html index 22040acfee4..a80532a32c6 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonum.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nonum.html @@ -40,9 +40,9 @@ incorporates <i>Times</i>-like mathematics, and a sans-serif face based on <i>Helvetica</i>, but scaled to match <i>Times</i> text rather better. <dl> -<dt><tt><i>calc.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>Examples for LaTeX Companion</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/tlc2.zip">info/examples/tlc2</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/examples/tlc2/">browse the directory</a>) -<dt><tt><i>The psnfss bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss/">browse the directory</a>) +<dt><tt><i>calc.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>Examples for LaTeX Companion</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/examples/tlc2.zip">info/examples/tlc2</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/examples/tlc2/">browse the directory</a>) +<dt><tt><i>The psnfss bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nonum">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nonum</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopagebrk.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopagebrk.html index 69ca8a59ea2..ba1e51f9b6f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopagebrk.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopagebrk.html @@ -77,7 +77,6 @@ into the definition of a command (as in patch would be: <blockquote> <pre> -\let\oldsubsubsection=\subsubsection \renewcommand{\subsubsection}{% \filbreak \oldsubsubsection @@ -104,8 +103,8 @@ added to the page you’re typesetting. It depends on the document whether this looks impossibly awful or entirely acceptable, but the command remains a useful item in the armoury. <dl> -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>needspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/needspace.sty">macros/latex/contrib/misc/needspace.sty</a> +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>needspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/needspace.sty">macros/latex/contrib/misc/needspace.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nopagebrk">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nopagebrk</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopageno.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopageno.html index 91dfc3e326e..c5abfd37492 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopageno.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-nopageno.html @@ -2,49 +2,74 @@ <title>UK TeX FAQ -- question label nopageno</title> </head><body> <h3>How to get rid of page numbers</h3> -<p/>The package <i>nopageno</i> will suppress page numbers in a whole -document. -<p/>To suppress page numbers from a single page, use -<code>\</code><code>thispagestyle{empty}</code> somewhere within the text of the -page. (Note that <code>\</code><code>maketitle</code> and <code>\</code><code>chapter</code> both use -<code>\</code><code>thispagestyle</code> internally, so you need to call it after you’ve -called them.) +<p/><p/>Very occasionally, one wants a document with no page numbers. For +such occasions, the package <i>nopageno</i> will make +<code>\</code><code>pagestyle{plain}</code> have the same effect as +<code>\</code><code>pagestyle{empty}</code>; in simple documents, this will suppress +all page numbering (it will not work, of course, if the document uses +some other pagestyle than <code>plain</code>). <p/>To suppress page numbers from a sequence of pages, you may use <code>\</code><code>pagestyle{empty}</code> at the start of the sequence, and restore the original page style at the end. Unfortunately, you still have to -use <code>\</code><code>thispagestyle</code> after any <code>\</code><code>maketitle</code> or <code>\</code><code>chapter</code> -command. -<p/>In the <i>memoir</i> class, the troublesome commands (<code>\</code><code>maketitle</code>, -<code>\</code><code>chapter</code>, etc.) invoke their own page style -(<code>title</code>, <code>chapter</code>, etc.), which you may -redefine using the class’s own techniques to be equivalent to -“<code>empty</code>”. The <i>KOMA-script</i> classes have -commands that contain the page style to be used, so one might say: +deal with the page numbers on pages containing a <code>\</code><code>maketitle</code>, +<code>\</code><code>part</code> or <code>\</code><code>chapter</code> command, since the standard classes; deal +with those separately, as described below. +<p/>To suppress page numbers on a single page, use +<code>\</code><code>thispagestyle{empty}</code> somewhere within the text of the +page. Note that, in the standard classes, <code>\</code><code>maketitle</code> and +<code>\</code><code>chapter</code> use <code>\</code><code>thispagestyle</code> internally, so your call +must be <em>after</em> those commands. +<p/>Unfortunately, <code>\</code><code>thispagestyle</code> doesn’t work for <i>book</i> or +<i>report</i> <code>\</code><code>part</code> commands: they set the page style (as do +<code>\</code><code>chapter</code> commands), but then they advance to the next page so +that you have no opportunity to change the style using +<code>\</code><code>thispagestyle</code>. The present author has proposed solving the +problem with the following “grubby little patch”, on +<i>comp.text.tex</i>: +<blockquote> +<pre> +\makeatletter +\def\@endpart{\thispagestyle{empty}\sv@endpart} +\makeatother +</pre> +</blockquote><p> +<p/>Both the <i>KOMA-script</i> classes and <i>memoir</i> have separate +page styles for the styles of various “special” pages, so, in a +<i>KOMA</i> class document one might say: <blockquote> <pre> \renewcommand*{\titlepagestyle}{empty} </pre> </blockquote><p> +while <i>memoir</i> will do the job with +<blockquote> + <code>\</code><code>aliaspagestyle{title}{empty}</code> +</blockquote><p> <p/>An alternative (in all classes) is to use the rather delightful <code>\</code><code>pagenumbering{gobble}</code>; this has the simple effect that any attempt to print a page number produces nothing, so there’s no issue about preventing any part of LaTeX from printing the number. However, the <code>\</code><code>pagenumbering</code> command does have the side effect that -it resets the page number (to 1), which may be undesirable. -<p/>The <i>scrpage2</i> package separates out the representation from -the resetting; so one can say +it resets the page number (to 1), so it is unlikely to be helpful +other than at the beginning of a document. +<p/>The <i>scrpage2</i> package separates out the representation of the +page number (it typesets the number using the <code>\</code><code>pagemark</code> command) from +the construction of the page header and footer; so one can say <blockquote> <pre> \renewcommand*{\pagemark}{} </pre> </blockquote><p> -to have the same effect as the <code>gobble</code> trick, without -resetting the page number. +which will also suppress the printing of the page number. +<p/>Neither of these “suppress the page number” techniques touches the +page style in use; in practice this means they don’t make sense unless +you are using <code>\</code><code>pagestyle{plain}</code> <dl> -<dt><tt><i>nopageno</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/carlisle/nopageno.sty">macros/latex/contrib/carlisle/nopageno.sty</a> -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>scrpage2.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>fancyhdr.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>nopageno.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle/nopageno.sty">macros/latex/contrib/carlisle/nopageno.sty</a> +<dt><tt><i>scrpage2.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nopageno">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=nopageno</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-numbersets.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-numbersets.html index c49e8968f3d..27a057382c5 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-numbersets.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-numbersets.html @@ -28,7 +28,7 @@ Metafont. This set offers blackboard bold forms of lower-case letters; the font source directory also contains sources for a LaTeX package that enables use of the fonts. The fonts are not available in Type 1 format. <p/>The <i>bbm</i> family claims to provide -‘blackboard’ versions of most of the <i>cm</i> fonts ... including +‘blackboard’ versions of most of the <i>cm</i> fonts … including the bold and bold-extended series. Again, the fonts are designed in Metafont and are not available in Type 1 format. LaTeX macro support comes from a package by Torsten Hilbrich. @@ -74,19 +74,17 @@ do better than the macros, or anything similar using capital ‘I’ (which looks even worse!). Voluntary (La)TeX effort has redefined the meaning of laziness (in this respect!). <dl> -<dt><tt><i>AMS support files (Plain)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/plaintex.zip">fonts/amsfonts/plaintex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/plaintex/">browse the directory</a>) -<dt><tt><i>AMS support files (LaTeX)</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/latex.zip">fonts/amsfonts/latex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/latex/">browse the directory</a>) -<dt><tt><i>AMS symbol fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/symbols.zip">fonts/amsfonts/sources/symbols</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/symbols/">browse the directory</a>) -<dt><tt><i>AMS symbol fonts in Type 1 format</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/amsfonts/ps-type1/">fonts/amsfonts/ps-type1/</a> -<dt><tt><i>bbm fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/bbm.zip">fonts/cm/bbm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cm/bbm/">browse the directory</a>) -<dt><tt><i>bbm macros</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bbm.zip">macros/latex/contrib/bbm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/bbm/">browse the directory</a>) -<dt><tt><i>bbold fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/bbold.zip">fonts/bbold</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/bbold/">browse the directory</a>) -<dt><tt><i>blackboard evaluation set</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/symbols/blackboard.zip">info/symbols/blackboard</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/symbols/blackboard/">browse the directory</a>) -<dt><tt><i>doublestroke fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/doublestroke.zip">fonts/doublestroke</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/doublestroke/">browse the directory</a>) -<dt><tt><i>fourier fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/fourier-GUT.zip">fonts/fourier-GUT</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/fourier-GUT/">browse the directory</a>) -<dt><tt><i>mathpazo fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mathpazo.zip">fonts/mathpazo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mathpazo/">browse the directory</a>) -<dt><tt><i>pxfonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/pxfonts.zip">fonts/pxfonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/pxfonts/">browse the directory</a>) -<dt><tt><i>txfonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/txfonts.zip">fonts/txfonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/txfonts/">browse the directory</a>) +<dt><tt><i>AMS support files</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) +<dt><tt><i>AMS symbol fonts</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) +<dt><tt><i>bbm fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/cm/bbm.zip">fonts/cm/bbm</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/cm/bbm/">browse the directory</a>) +<dt><tt><i>bbm macros</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bbm.zip">macros/latex/contrib/bbm</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/bbm/">browse the directory</a>) +<dt><tt><i>bbold fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/bbold.zip">fonts/bbold</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/bbold/">browse the directory</a>) +<dt><tt><i>blackboard evaluation set</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/symbols/blackboard.zip">info/symbols/blackboard</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/symbols/blackboard/">browse the directory</a>) +<dt><tt><i>doublestroke fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/doublestroke.zip">fonts/doublestroke</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/doublestroke/">browse the directory</a>) +<dt><tt><i>fourier fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/fourier-GUT.zip">fonts/fourier-GUT</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/fourier-GUT/">browse the directory</a>) +<dt><tt><i>mathpazo fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/mathpazo.zip">fonts/mathpazo</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/mathpazo/">browse the directory</a>) +<dt><tt><i>pxfonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/pxfonts.zip">fonts/pxfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/pxfonts/">browse the directory</a>) +<dt><tt><i>txfonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/txfonts.zip">fonts/txfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/txfonts/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=numbersets">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=numbersets</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oarglikesect.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oarglikesect.html index ee818a6709e..5c77745f5df 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oarglikesect.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oarglikesect.html @@ -35,6 +35,6 @@ above would have been programmed: </blockquote><p> In that code, <code>\</code><code>@thing</code> is only ever called with an optional and a mandatory argument; if the default from the <code>\</code><code>newcommand</code> is -invoked, a bug in user code has bitten... +invoked, a bug in user code has bitten… <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oarglikesect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oarglikesect</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddhyphen.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddhyphen.html index 0f63242f90a..cfc234fda50 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddhyphen.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddhyphen.html @@ -15,7 +15,7 @@ found on CTAN (see <a href="FAQ-newlang.html">“using a new language”</a> for instructions on adding this new “language”). <dl> -<dt><tt><i>UK patterns</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivelanguage/hyphenation/ukhyphen.tex">language/hyphenation/ukhyphen.tex</a> +<dt><tt><i>UK patterns</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/language/hyphenation/ukhyphen.tex">language/hyphenation/ukhyphen.tex</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddhyphen">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddhyphen</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddpage.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddpage.html index c282f3ac0b1..4e7f785ced8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddpage.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-oddpage.html @@ -29,16 +29,16 @@ then examined (in a <i>hyperref</i>-safe way) to set a conditional <code>\</code><code>ifoddpage</code> true if the command was issued on an odd page. The <i>memoir</i> class has the same command setting a conditional <code>\</code><code>ifoddpage</code>. Of course, the <code>\</code><code>label</code> contributes to LaTeX’s -“Rerun to get cross-references right” error messages... +“Rerun to get cross-references right” error messages… <p/>The Koma-Script classes have an <code>addmargin*</code> environment that also provides the sorts of facilities that the <i>changepage</i> offers. Koma-Script’s supporting command is <code>\</code><code>ifthispageodd{<true>}{<false>}</code> executes different things depending on the page number. <dl> -<dt><tt><i>changepage.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/changepage.sty">macros/latex/contrib/misc/changepage.sty</a> -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>changepage.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/changepage.sty">macros/latex/contrib/misc/changepage.sty</a> +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ol-books.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ol-books.html index ed4aae119f5..8983bd8dc8d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ol-books.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ol-books.html @@ -10,7 +10,7 @@ out of print). The book is now available on CTAN; it’s not a beginner’s tutorial but it’s a fine reference. It’s also available, as a printed copy, via the on-line publishers <a href="http://www.lulu.com/content/2555607/">Lulu</a> (not quite free, of -course, but not a <em>bad</em> deal...). +course, but not a <em>bad</em> deal…). <p/>Addison-Wesley have also released the copyright of “TeX for the Impatient” by Paul W. Abrahams, Karl Berry and Kathryn A. Hargreaves, another book whose unavailability many have lamented. The authors @@ -24,9 +24,9 @@ its day, but while it is now somewhat dated, it still has its uses, and is a welcome addition to the list of on-line resources. A project to update it is believed to be under way. <dl> -<dt><tt><i>Making TeX Work</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/makingtexwork/mtw-1.0.1-html.tar.gz">info/makingtexwork/mtw-1.0.1-html.tar.gz</a> -<dt><tt><i>TeX by Topic</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/texbytopic.zip">info/texbytopic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/texbytopic/">browse the directory</a>) -<dt><tt><i>TeX for the Impatient</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/impatient.zip">info/impatient</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/impatient/">browse the directory</a>) +<dt><tt><i>Making TeX Work</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/makingtexwork/mtw-1.0.1-html.tar.gz">info/makingtexwork/mtw-1.0.1-html.tar.gz</a> +<dt><tt><i>TeX by Topic</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/texbytopic.zip">info/texbytopic</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/texbytopic/">browse the directory</a>) +<dt><tt><i>TeX for the Impatient</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/impatient.zip">info/impatient</a> (or <a href="http://www.tex.ac.uk/tex-archive/info/impatient/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ol-books">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ol-books</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-onecolabs.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-onecolabs.html index 0ea836d3219..fc84d44c698 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-onecolabs.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-onecolabs.html @@ -56,8 +56,8 @@ footnoting. They can be used like this: </blockquote><p> The <i>memoir</i> class offers all the facilities of <i>abstract</i>. <dl> -<dt><tt><i>abstract.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/abstract.zip">macros/latex/contrib/abstract</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/abstract/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>abstract.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/abstract.zip">macros/latex/contrib/abstract</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/abstract/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=onecolabs">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=onecolabs</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-osf.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-osf.html index 52ac82cbca5..14d49d054e8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-osf.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-osf.html @@ -47,11 +47,11 @@ options available to the (La)TeX user, is already supported by package. Similar support is also in the works for <a href="FAQ-luatex.html">LuaTeX</a>. <dl> -<dt><tt><i>cmolddig fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cmolddig.zip">fonts/cmolddig</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/cmolddig/">browse the directory</a>) -<dt><tt><i>eco fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eco.zip">fonts/eco</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eco/">browse the directory</a>) -<dt><tt><i>fontinst</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst/">browse the directory</a>) -<dt><tt><i>fontspec.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/xetex/latex/fontspec.zip">macros/xetex/latex/fontspec</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/xetex/latex/fontspec/">browse the directory</a>) -<dt><tt><i>mathpazo fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mathpazo.zip">fonts/mathpazo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mathpazo/">browse the directory</a>) +<dt><tt><i>cmolddig fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/cmolddig.zip">fonts/cmolddig</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/cmolddig/">browse the directory</a>) +<dt><tt><i>eco fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/eco.zip">fonts/eco</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/eco/">browse the directory</a>) +<dt><tt><i>fontinst</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst/">browse the directory</a>) +<dt><tt><i>fontspec.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/xetex/latex/fontspec.zip">macros/xetex/latex/fontspec</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/xetex/latex/fontspec/">browse the directory</a>) +<dt><tt><i>mathpazo fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/mathpazo.zip">fonts/mathpazo</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/mathpazo/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-otherprinters.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-otherprinters.html index 599e93559e0..86dc97512a8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-otherprinters.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-otherprinters.html @@ -16,7 +16,7 @@ for the printer you actually have. If you are using a Unix system of some sort, it’s generally quite easy to insert <i>ghostscript</i> into the print spooling process. <dl> -<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/">support/ghostscript/</a> +<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/">support/ghostscript/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=otherprinters">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=otherprinters</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overfull.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overfull.html index 9ca948128bd..861205a5f0a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overfull.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overfull.html @@ -123,11 +123,11 @@ powerful tool in the armoury of the typesetter. <p/>As mentioned above, the microtypographic extensions are tricky beasts to control; however, the <i>microtype</i> package relieves the user of the tedious work of specifying how to perform margin adjustments -and how much to scale each font ... for the fonts the package +and how much to scale each font … for the fonts the package knows about; it’s a good tool, and users who can take on the specification of adjustments for yet more fonts are always welcome. <dl> -<dt><tt><i>microtype.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/microtype.zip">macros/latex/contrib/microtype</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/microtype/">browse the directory</a>) +<dt><tt><i>microtype.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/microtype.zip">macros/latex/contrib/microtype</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/microtype/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=overfull">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=overfull</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overstrike.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overstrike.html index 74571c32b9d..4282de7d7aa 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overstrike.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-overstrike.html @@ -10,8 +10,8 @@ provide the necessary facilities. by a different mechanism. <p/>Documentation of <i>ulem</i> is in the package file. <dl> -<dt><tt><i>soul.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/soul.zip">macros/latex/contrib/soul</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/soul/">browse the directory</a>) -<dt><tt><i>ulem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/ulem.sty">macros/latex/contrib/misc/ulem.sty</a> +<dt><tt><i>soul.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/soul.zip">macros/latex/contrib/soul</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/soul/">browse the directory</a>) +<dt><tt><i>ulem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/ulem.sty">macros/latex/contrib/misc/ulem.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=overstrike">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=overstrike</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pagebychap.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pagebychap.html index 802c17a1051..617b31411a1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pagebychap.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pagebychap.html @@ -19,7 +19,7 @@ was written: it does the obvious things, and more. section, but this really doesn’t make sense: you need to run page numbers within document objects that always start on a fresh page. <dl> -<dt><tt><i>chappg.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/chappg.zip">macros/latex/contrib/chappg</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/chappg/">browse the directory</a>) +<dt><tt><i>chappg.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/chappg.zip">macros/latex/contrib/chappg</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/chappg/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pagebychap">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pagebychap</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papergeom.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papergeom.html index d9ec57144b7..0be1b9af49e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papergeom.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papergeom.html @@ -82,9 +82,9 @@ length registers <code>\</code><code>stockheight</code> and <code>\</code><code> (for PDFLaTeX processing) then instruct the processor to produce output that specifies the necessary paper size. <dl> -<dt><tt><i>geometry.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/geometry.zip">macros/latex/contrib/geometry</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/geometry/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>typearea.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>geometry.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/geometry.zip">macros/latex/contrib/geometry</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/geometry/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>typearea.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=papergeom">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=papergeom</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papersize.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papersize.html index 60b3cb24ba9..b6c38f9fcbb 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papersize.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-papersize.html @@ -13,7 +13,7 @@ output, on the page, is crucial to the acceptance of the output. it’s a dissertation which must match the fancies of some bureaucrat even to be considered.) <p/>Sadly, we often find that the printed output doesn’t conform to our -expectations... +expectations… <p/>The check-list for such problems has two entries: <ul> <li> Your output is generated via Adobe <i>Reader</i> (or @@ -28,7 +28,7 @@ expectations... suite, that provides a detailed outline of the potential problems together with a sample document and prototype outputs. <dl> -<dt><tt><i>testflow bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/IEEEtran/testflow/">macros/latex/contrib/IEEEtran/testflow/</a> +<dt><tt><i>testflow bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/IEEEtran/testflow/">macros/latex/contrib/IEEEtran/testflow/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=papersize">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=papersize</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parallel.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parallel.html index 1c6f3a4255b..15271cf5c09 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parallel.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parallel.html @@ -50,10 +50,10 @@ setting carefully integrated with the needs of a scholarly text, permitting translation, or notes, or both, to be set in parallel with the ‘base’ text of the document. <dl> -<dt><tt><i>ledpar.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ledmac.zip">macros/latex/contrib/ledmac</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ledmac/">browse the directory</a>) -<dt><tt><i>parallel.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/parallel.zip">macros/latex/contrib/parallel</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/parallel/">browse the directory</a>) -<dt><tt><i>parcolumns.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sauerj.zip">macros/latex/contrib/sauerj</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sauerj/">browse the directory</a>) -<dt><tt><i>pdfcolparallel.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>ledpar.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ledmac.zip">macros/latex/contrib/ledmac</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ledmac/">browse the directory</a>) +<dt><tt><i>parallel.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/parallel.zip">macros/latex/contrib/parallel</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/parallel/">browse the directory</a>) +<dt><tt><i>parcolumns.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sauerj.zip">macros/latex/contrib/sauerj</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sauerj/">browse the directory</a>) +<dt><tt><i>pdfcolparallel.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=parallel">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=parallel</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parskip.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parskip.html index 61cf3c67f4c..5cfe623ba01 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parskip.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-parskip.html @@ -29,8 +29,8 @@ with most problems. equivalent (<i>rapport3</i>) whose design incorporates zero paragraph indent and non-zero paragraph skip. <dl> -<dt><tt><i>NTG classes</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntgclass.zip">macros/latex/contrib/ntgclass</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntgclass/">browse the directory</a>) -<dt><tt><i>parskip.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/parskip.sty">macros/latex/contrib/misc/parskip.sty</a> +<dt><tt><i>NTG classes</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntgclass.zip">macros/latex/contrib/ntgclass</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntgclass/">browse the directory</a>) +<dt><tt><i>parskip.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/parskip.sty">macros/latex/contrib/misc/parskip.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=parskip">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=parskip</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-patch.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-patch.html index 059f2bf68af..e28fd2f4b22 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-patch.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-patch.html @@ -22,7 +22,6 @@ command, which we can then use in the redefinition of the command. So: <blockquote> <pre> -\let\OldSmooth\smooth \renewcommand{\smooth}{\mumble\OldSmooth} </pre> </blockquote><p> @@ -65,13 +64,34 @@ after </blockquote><p> we will have a new version of <code>\</code><code>b</code> defined as “<code>abc</code>”. <p/>The <i>ted</i> package is a ‘token list editor’, and provides a -command <code>\</code><code>Substitute*</code> which will patch the contents of a macro, -putting the result in a token-list, or (optionally) using the result -to (re)define a macro. The package may also be used as a powerful -debugging tool. +command <code>\</code><code>substitute</code> which will patch the +contents of a macro, putting the result in a token-list, or +(in the form <code>\</code><code>Substitute*</code>) using the result to (re)define a +macro. The following example defines a simple macro, and then changes +its definition: +<blockquote> +<pre> +\newcommand{\myfont}% + {\Large\sffamily\selectfont} +\Substitute*[\renewcommand{\myfont}]{\myfont}% + {\Large\sffamily}{\huge\itshape} +</pre> +</blockquote><p> +The macro’s definition is now: +<blockquote> +<pre> +\huge\itshape\selectfont +</pre> +</blockquote><p> +<p/>The package also offers a command <code>\</code><code>ShowTokens</code>, which shows the +content of its argument, one token to a line, with details of the +token’s category code, etc. This is recommended as a debugging tool. <p/>The <i>etoolbox</i> (which provides user access to e-TeX’s -programming facilities) provides a command <code>\</code><code>patchcmd</code> which will -perform a “string substitution” in a macro’s definition. The +programming facilities) provides a command <code>\</code><code>patchcmd</code> which is +very similar to <code>\</code><code>Substitute</code>, except that it only replaces a +single instance of the token(s) in its search pattern. Since not all +commands may be patched in this way, <code>\</code><code>patchcmd</code> takes extra +arguments for <em>success</em> and <em>failure</em> cases. The package also provides commands that prepend (<code>\</code><code>pretocmd</code>) or append (<code>\</code><code>apptocmd</code>) to the definition of a command. Not all commands may be patched in this way; the package provides a command @@ -83,20 +103,18 @@ string.) usable, but not really recommendable. <i>Patch</i> gives you an ingenious (and difficult to understand) mechanism, and comes as an old-style LaTeX documented macro file, which can no longer be -processed (as in - - <a href="FAQ-install-doc.html">generating documentation for a new package</a>). +processed to <a href="FAQ-install-doc.html">produce formatted documentation, etc.</a>. Fortunately, the file (<i>patch.doc</i>) may be input directly, and “documentation” may found by reading the source of the package. Roughly speaking, one gives the command a set of instructions analogous to <i>sed</i> substitutions, and it regenerates the -command thus amended. Unless you can’t do your job any other way, you -had probably best avoid <i>patch</i>. +command thus amended. Unless you can’t do your job any other way, +<i>patch</i> is best avoided. <dl> -<dt><tt><i>etoolbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/etoolbox.zip">macros/latex/contrib/etoolbox</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/etoolbox/">browse the directory</a>) -<dt><tt><i>patch.doc</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/generic/misc/patch.doc">macros/generic/misc/patch.doc</a> -<dt><tt><i>patchcommand.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/patchcmd.zip">macros/latex/contrib/patchcmd</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/patchcmd/">browse the directory</a>) -<dt><tt><i>ted.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ted.zip">macros/latex/contrib/ted</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ted/">browse the directory</a>) +<dt><tt><i>etoolbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/etoolbox.zip">macros/latex/contrib/etoolbox</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/etoolbox/">browse the directory</a>) +<dt><tt><i>patch.doc</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/generic/misc/patch.doc">macros/generic/misc/patch.doc</a> +<dt><tt><i>patchcommand.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/patchcmd.zip">macros/latex/contrib/patchcmd</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/patchcmd/">browse the directory</a>) +<dt><tt><i>ted.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ted.zip">macros/latex/contrib/ted</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ted/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=patch">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=patch</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdfpagelabels.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdfpagelabels.html index afe786a8e73..79570cdffa0 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdfpagelabels.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdfpagelabels.html @@ -30,7 +30,7 @@ an unnumbered title page, after which page numbers are reset: the PDFTeX warning of “<a href="FAQ-hyperdupdest.html">duplicate destinations</a>” will happen in this case, regardless of the options. <dl> -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pdfpagelabels">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pdfpagelabels</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdftexgraphics.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdftexgraphics.html index 69569e372a5..2b6f3fee48b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdftexgraphics.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pdftexgraphics.html @@ -9,7 +9,7 @@ PNG files for artificial bitmap images, and PDF for vector drawings. Old versions of PDFTeX (prior to version 1.10a) supported TIFF (<code>.tif</code> files) format as an alternative to PNG files; don’t rely on this facility, even if you -<em>are</em> running an old enough version of PDFTeX... +<em>are</em> running an old enough version of PDFTeX… <p/>In addition to the ‘native’ formats, the standard PDFLaTeX <i>graphics</i> package setup causes Hans Hagen’s <i>supp-pdf</i> macros to be loaded: these macros are capable of translating the @@ -47,13 +47,13 @@ which is targeted at the use of <i>pstricks</i> in PDFLaTeX, and also covers the <i>pstricks</i>-specific package <i>pdftricks</i>. <dl> -<dt><tt><i>epstopdf</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/epstopdf/">support/epstopdf/</a> +<dt><tt><i>epstopdf</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/epstopdf/">support/epstopdf/</a> <dt><tt><i>epstopdf.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>pdftricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdftricks.zip">macros/latex/contrib/pdftricks</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pdftricks/">browse the directory</a>) -<dt><tt><i>pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pst-pdf.zip">macros/latex/contrib/pst-pdf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pst-pdf/">browse the directory</a>) -<dt><tt><i>pstoedit</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pstoedit.zip">support/pstoedit</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pstoedit/">browse the directory</a>) -<dt><tt><i>purifyeps</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/purifyeps.zip">support/purifyeps</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/purifyeps/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>pdftricks.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdftricks.zip">macros/latex/contrib/pdftricks</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pdftricks/">browse the directory</a>) +<dt><tt><i>pst-pdf.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pst-pdf.zip">macros/latex/contrib/pst-pdf</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pst-pdf/">browse the directory</a>) +<dt><tt><i>pstoedit</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/pstoedit.zip">support/pstoedit</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/pstoedit/">browse the directory</a>) +<dt><tt><i>purifyeps</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/purifyeps.zip">support/purifyeps</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/purifyeps/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pdftexgraphics">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pdftexgraphics</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkfix.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkfix.html index 5f92470c714..37458de9ed1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkfix.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkfix.html @@ -30,8 +30,8 @@ a try. the PostScript it is distilling, and one option is to replace bitmap fonts in the file with Type 1 versions. <dl> -<dt><tt><i>pkfix</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pkfix.zip">support/pkfix</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pkfix/">browse the directory</a>) -<dt><tt><i>pkfix-helper</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pkfix-helper.zip">support/pkfix-helper</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/pkfix-helper/">browse the directory</a>) +<dt><tt><i>pkfix</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/pkfix.zip">support/pkfix</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/pkfix/">browse the directory</a>) +<dt><tt><i>pkfix-helper</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/pkfix-helper.zip">support/pkfix-helper</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/pkfix-helper/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pkfix">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pkfix</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html index ca4bdaa4a55..3ef56eb782f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html @@ -68,6 +68,6 @@ author didn’t bother to document his package (on the “if it was hard to write, it should be hard to use” philosophy). Most ordinary mortals will seek support from some more experienced user at this stage, though it <em>is</em> possible to proceed in the way that the original -author apparently expected...by reading his code. +author apparently expected…by reading his code. <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pkgdoc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pkgdoc</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-poster.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-poster.html index a7bce7e5a0f..35851078514 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-poster.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-poster.html @@ -52,11 +52,11 @@ route): but has hints which are generally useful. </ul> <dl> -<dt><tt><i>a0poster.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/a0poster.zip">macros/latex/contrib/a0poster</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/a0poster/">browse the directory</a>) -<dt><tt><i>flowfram.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/flowfram.zip">macros/latex/contrib/flowfram</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/flowfram/">browse the directory</a>) -<dt><tt><i>multicol.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>sciposter.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sciposter.zip">macros/latex/contrib/sciposter</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sciposter/">browse the directory</a>) -<dt><tt><i>textpos.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/textpos.zip">macros/latex/contrib/textpos</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/textpos/">browse the directory</a>) +<dt><tt><i>a0poster.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/a0poster.zip">macros/latex/contrib/a0poster</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/a0poster/">browse the directory</a>) +<dt><tt><i>flowfram.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/flowfram.zip">macros/latex/contrib/flowfram</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/flowfram/">browse the directory</a>) +<dt><tt><i>multicol.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>sciposter.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sciposter.zip">macros/latex/contrib/sciposter</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sciposter/">browse the directory</a>) +<dt><tt><i>textpos.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/textpos.zip">macros/latex/contrib/textpos</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/textpos/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=poster">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=poster</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-prept1font.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-prept1font.html index 0c06f0651b0..7b38729cc53 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-prept1font.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-prept1font.html @@ -2,15 +2,13 @@ <title>UK TeX FAQ -- question label prept1font</title> </head><body> <h3>Preparing a Type 1 font</h3> -<p/>The process of installing a Type 1 font set is rather convoluted, but -it may be separated into a modest set of operations. -<p/>The two basic stages are to prepare the font(s) for installation (this -question) and installing the result (see -<a href="FAQ-instt1font.html">installing a Type 1 font</a>). Each of -these basic stages +<p/>The process of installing a Type 1 font set is rather convoluted, and +we will deal with it in two chunks: first (in the present answer) +preparing the font for installation, and second +<a href="FAQ-instt1font.html">installing a Type 1 font</a>). <p/>Many fonts are supplied in (La)TeX ready form: such fonts need no -preparation, and may be <a href="FAQ-instt1font.html">installed immediately</a>. -However, if you purchase a font from a Type foundry (either direct or +preparation, and may be installed immediately. +<p/>However, if you purchase a font from a Type foundry (either direct or via one of the web stores), you are likely to need to ‘prepare’ it for use with (La)TeX. The rest of this answer discusses this preparation. <ul> @@ -52,5 +50,9 @@ use with (La)TeX. The rest of this answer discusses this preparation. </ul> Having traversed this list, you have a set of font files ready for installation. -<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=prept1font">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=prept1font</a> +<dl> +<dt><tt><i>fontinst.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst/">browse the directory</a>) +<dt><tt><i>Type 1 installation guide</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/Type1fonts/fontinstallationguide/fontinstallationguide.pdf">info/Type1fonts/fontinstallationguide/fontinstallationguide.pdf</a> +</dl> +<p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=prept1font">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=prept1font</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-previewers.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-previewers.html index 606aa9b70dc..91239c026d7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-previewers.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-previewers.html @@ -26,7 +26,7 @@ include a version of <i>xdvik</i>. <i>Acrobat</i> <i>Reader</i> or one of the substitutes for that. </ul> <dl> -<dt><tt><i>xdvi</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivedviware/xdvi/">dviware/xdvi/</a> +<dt><tt><i>xdvi</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/xdvi/">dviware/xdvi/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=previewers">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=previewers</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-proof.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-proof.html index aecf3b5318a..a07f56f37f2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-proof.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-proof.html @@ -32,8 +32,8 @@ The <code>\</code><code>tag*{<code>\</code><code>qedhere</code>}</code> construc AMSLaTeX’s numbering environments. <dl> <dt><tt><i>amsthm.sty</i></tt><dd>Distributed as part of the AMSLaTeX bundle - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) -<dt><tt><i>ntheorem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntheorem.zip">macros/latex/contrib/ntheorem</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntheorem/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>ntheorem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntheorem.zip">macros/latex/contrib/ntheorem</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntheorem/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=proof">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=proof</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-protect.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-protect.html index 15ae9918a62..fe8c8307f86 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-protect.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-protect.html @@ -79,7 +79,7 @@ current LaTeX mean that this is an expensive exercise. It remains a long-term aim of the team to remove all need for <code>\</code><code>protect</code>ion. <dl> <dt><tt><i>makerobust.sty</i></tt><dd>Distributed with Heiko Oberdiek’s packages - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-psatempty.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-psatempty.html deleted file mode 100644 index ec33fd35608..00000000000 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-psatempty.html +++ /dev/null @@ -1,42 +0,0 @@ -<head> -<title>UK TeX FAQ -- question label ps@empty</title> -</head><body> -<h3><code>\pagestyle{empty}</code> on first page in LaTeX</h3> -<p/>If you use <code>\</code><code>pagestyle{empty}</code>, but the first page is numbered -anyway, you are probably using the <code>\</code><code>maketitle</code> command too. The -behaviour is not a bug but a feature. The standard LaTeX classes are -written so that initial pages (pages containing a <code>\</code><code>maketitle</code>, -<code>\</code><code>part</code>, or <code>\</code><code>chapter</code>) have a different page style from the rest -of the document; to achieve this, the commands internally issue -<code>\</code><code>thispagestyle{plain}</code>. This is usually not acceptable -behaviour if the surrounding page style is ‘empty’. -<p/>Possible workarounds include: -<ul> -<li> Put <code>\</code><code>thispagestyle{empty</code>} immediately after the - <code>\</code><code>maketitle</code> command, with no blank line between them. -<li> Use the <i>fancyhdr</i> or <i>scrpage2</i> packages, which - allow you to customise the style for initial pages independently of - that for body pages. -<p/> For example, use <i>fancyhdr</i> commands: -<pre> -\fancypagestyle{plain}{% - \fancyhf{}% - \renewcommand{\headrulewidth}{0pt}% - \renewcommand{\footrulewidth}{0pt}% -} -</pre> - and the “<code>empty</code>” page style (invoked by <code>\</code><code>chapter</code> - commands and title pages) will have no header or footer. -<li> If you are using either the <i>memoir</i> class or a - <i>KOMA-script</i> class, use the techniques outlined for them in - “<a href="FAQ-nopageno.html">no page numbers</a>”. -</ul> -<dl> -<dt><tt><i>fancyhdr.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>nopageno.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/carlisle/nopageno.sty">macros/latex/contrib/carlisle/nopageno.sty</a> -<dt><tt><i>scrpage2.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -</dl> -<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ps@empty">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ps@empty</a> -</body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-psfchoice.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-psfchoice.html index 493d67bb0aa..2e906cd87a4 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-psfchoice.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-psfchoice.html @@ -76,7 +76,7 @@ mathematics include: successful, and their use may be suppressed when loading the fonts’ <i>kpfonts</i> LaTeX support package). <p/> For an example, see \url{http://www.tug.dk/FontCatalogue/kpserif/} -<dt>MathDesign<dd>(4 entire families...so far) Paul Pichaureau<br> +<dt>MathDesign<dd>(4 entire families…so far) Paul Pichaureau<br> This set so far offers mathematics fonts to match Adobe Utopia, URW Garamond, Bitstream Charter (all of which are separately available, on CTAN, in Type 1 format) and Fontsite Garamond @@ -379,33 +379,33 @@ Many service bureaus don’t care as long as you present them with a finishe print file (PostScript or PDF) for their output device. <dl> <dt><tt><i>CM family collection</i></tt><dd> - Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/cm/ps-type1/bluesky/">fonts/cm/ps-type1/bluesky/</a> + Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) <dt><tt><i>AMS font collection</i></tt><dd> - Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/amsfonts/ps-type1/">fonts/amsfonts/ps-type1/</a> + Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) <dt><tt><i>Belleek fonts</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/belleek/belleek.zip">fonts/belleek/belleek.zip</a> -<dt><tt><i>CM-super collection</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/fonts/belleek/belleek.zip">fonts/belleek/belleek.zip</a> +<dt><tt><i>CM-super collection</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) <dt><tt><i>eulervm.sty and supporting metrics</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eulervm.zip">fonts/eulervm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/eulervm/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/fonts/eulervm.zip">fonts/eulervm</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/eulervm/">browse the directory</a>) <dt><tt><i>fourier (including metrics and other support for utopia</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/fourier-GUT.zip">fonts/fourier-GUT</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/fourier-GUT/">browse the directory</a>) -<dt><tt><i>fouriernc</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/fouriernc.zip">fonts/fouriernc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/fouriernc/">browse the directory</a>) -<dt><tt><i>hfbright collection</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/hfbright.zip">fonts/ps-type1/hfbright</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/hfbright/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/fonts/fourier-GUT.zip">fonts/fourier-GUT</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/fourier-GUT/">browse the directory</a>) +<dt><tt><i>fouriernc</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/fouriernc.zip">fonts/fouriernc</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/fouriernc/">browse the directory</a>) +<dt><tt><i>hfbright collection</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/hfbright.zip">fonts/ps-type1/hfbright</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/hfbright/">browse the directory</a>) <dt><tt><i>hvmath (free bitmapped version)</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/micropress/hvmath.zip">fonts/micropress/hvmath</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/micropress/hvmath/">browse the directory</a>) -<dt><tt><i>kpfonts family</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/kpfonts.zip">fonts/kpfonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/kpfonts/">browse the directory</a>) -<dt><tt><i>Lucida Bright/Math metrics</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/psfonts/bh/lucida.zip">fonts/psfonts/bh/lucida</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/psfonts/bh/lucida/">browse the directory</a>) -<dt><tt><i>Lucida PSNFSS support</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psnfssx/lucidabr.zip">macros/latex/contrib/psnfssx/lucidabr</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/psnfssx/lucidabr/">browse the directory</a>) -<dt><tt><i>MathDesign collection</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/mathdesign/">fonts/mathdesign/</a> -<dt><tt><i>Maths Font Survey</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/Free_Math_Font_Survey/en/survey.pdf">info/Free_Math_Font_Survey/en/survey.pdf</a> - (PDF) or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/Free_Math_Font_Survey/en/survey.html">info/Free_Math_Font_Survey/en/survey.html</a> (HTML) -<dt><tt><i>Minion Pro support</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/minionpro.zip">fonts/minionpro</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/minionpro/">browse the directory</a>) -<dt><tt><i>MnSymbol family</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mnsymbol.zip">fonts/mnsymbol</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mnsymbol/">browse the directory</a>) -<dt><tt><i>pxfonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/pxfonts.zip">fonts/pxfonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/pxfonts/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/fonts/micropress/hvmath.zip">fonts/micropress/hvmath</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/micropress/hvmath/">browse the directory</a>) +<dt><tt><i>kpfonts family</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/kpfonts.zip">fonts/kpfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/kpfonts/">browse the directory</a>) +<dt><tt><i>Lucida Bright/Math metrics</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/psfonts/bh/lucida.zip">fonts/psfonts/bh/lucida</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/psfonts/bh/lucida/">browse the directory</a>) +<dt><tt><i>Lucida PSNFSS support</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psnfssx/lucidabr.zip">macros/latex/contrib/psnfssx/lucidabr</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/psnfssx/lucidabr/">browse the directory</a>) +<dt><tt><i>MathDesign collection</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/mathdesign/">fonts/mathdesign/</a> +<dt><tt><i>Maths Font Survey</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/Free_Math_Font_Survey/en/survey.pdf">info/Free_Math_Font_Survey/en/survey.pdf</a> + (PDF) or <a href="http://www.tex.ac.uk/tex-archive/info/Free_Math_Font_Survey/en/survey.html">info/Free_Math_Font_Survey/en/survey.html</a> (HTML) +<dt><tt><i>Minion Pro support</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/minionpro.zip">fonts/minionpro</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/minionpro/">browse the directory</a>) +<dt><tt><i>MnSymbol family</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/mnsymbol.zip">fonts/mnsymbol</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/mnsymbol/">browse the directory</a>) +<dt><tt><i>pxfonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/pxfonts.zip">fonts/pxfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/pxfonts/">browse the directory</a>) <dt><tt><i>tmmath (free bitmapped version)</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/micropress/tmmath.zip">fonts/micropress/tmmath</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/micropress/tmmath/">browse the directory</a>) -<dt><tt><i>txfonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/txfonts.zip">fonts/txfonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/txfonts/">browse the directory</a>) -<dt><tt><i>utopia fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utopia.zip">fonts/utopia</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utopia/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/fonts/micropress/tmmath.zip">fonts/micropress/tmmath</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/micropress/tmmath/">browse the directory</a>) +<dt><tt><i>txfonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/txfonts.zip">fonts/txfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/txfonts/">browse the directory</a>) +<dt><tt><i>utopia fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utopia.zip">fonts/utopia</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utopia/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=psfchoice">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=psfchoice</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ragright.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ragright.html index 1468c85c57a..37c3571a503 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ragright.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ragright.html @@ -22,7 +22,7 @@ transformations of the LaTeX kernel originals. The documentation discusses the issues and explains the significance of the various parameters of <i>ragged2e</i>’s operation. <dl> -<dt><tt><i>ragged2e.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms/">browse the directory</a>) +<dt><tt><i>ragged2e.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ragright">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ragright</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-readML.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-readML.html index b690216648e..ad6e7e4d009 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-readML.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-readML.html @@ -11,8 +11,8 @@ processor for XSL formatting objects, serialized as XML. Sebastian Rahtz’s PassiveTeX uses <i>xmltex</i> to achieve this end. <dl> -<dt><tt><i>xmltex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/xmltex/base.zip">macros/xmltex/base</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/xmltex/base/">browse the directory</a>) -<dt><tt><i>passivetex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/xmltex/contrib/passivetex.zip">macros/xmltex/contrib/passivetex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/xmltex/contrib/passivetex/">browse the directory</a>) +<dt><tt><i>xmltex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/xmltex/base.zip">macros/xmltex/base</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/xmltex/base/">browse the directory</a>) +<dt><tt><i>passivetex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/xmltex/contrib/passivetex.zip">macros/xmltex/contrib/passivetex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/xmltex/contrib/passivetex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=readML">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=readML</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reallyblank.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reallyblank.html index dc398f1dabe..48469cecb20 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reallyblank.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reallyblank.html @@ -12,7 +12,6 @@ like. advising the creation of a command <code>\</code><code>clearemptydoublepage</code>: <blockquote> <pre> -\let\origdoublepage\cleardoublepage \newcommand{\clearemptydoublepage}{% \clearpage {\pagestyle{empty}\origdoublepage}% @@ -27,7 +26,6 @@ but you can instead simply subvert <code>\</code><code>cleardoublepage</code> (w often used elsewhere): <blockquote> <pre> -\let\cleardoublepage\clearemptydoublepage </pre> </blockquote><p> Note: this command works because <code>\</code><code>clearemptydoublepage</code> uses a copy @@ -52,10 +50,10 @@ being an equivalent of <code>\</code><code>cleardoublepage</code>). One can ach commands will also serve if you want the surreal effect of “This page intentionally left blank” in the centre of an otherwise empty page. <dl> -<dt><tt><i>fancyhdr</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>nextpage.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/nextpage.sty">macros/latex/contrib/misc/nextpage.sty</a> -<dt><tt><i>scrbook.cls, scrrept.cls</i></tt><dd>Part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>fancyhdr</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>nextpage.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/nextpage.sty">macros/latex/contrib/misc/nextpage.sty</a> +<dt><tt><i>scrbook.cls, scrrept.cls</i></tt><dd>Part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=reallyblank">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=reallyblank</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-recovertex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-recovertex.html index 7cab595fe98..0513dc7d8f4 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-recovertex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-recovertex.html @@ -42,11 +42,12 @@ also arise from the oddity of typical TeX font encodings (notably those of the maths fonts), which <i>Acrobat</i> doesn’t know how to map to its standard Unicode representation. <dl> -<dt><tt><i>catdvi</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/catdvi.zip">dviware/catdvi</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/catdvi/">browse the directory</a>) -<dt><tt><i>crudetype</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/crudetype.zip">dviware/crudetype</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/crudetype/">browse the directory</a>) -<dt><tt><i>dvi2tty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvi2tty.zip">dviware/dvi2tty</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvi2tty/">browse the directory</a>) -<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/">support/ghostscript/</a> -<dt><tt><i>xpdf</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/xpdf/">support/xpdf/</a> +<dt><tt><i>catdvi</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/catdvi.zip">dviware/catdvi</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/catdvi/">browse the directory</a>) +<dt><tt><i>crudetype</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/crudetype.zip">dviware/crudetype</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/crudetype/">browse the directory</a>) +<dt><tt><i>dvi2tty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvi2tty.zip">dviware/dvi2tty</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvi2tty/">browse the directory</a>) +<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/">support/ghostscript/</a> +<dt><tt><i>xpdf</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/xpdf/">support/xpdf/</a> </dl> +<p><em>This answer last edited: 2009-05-29</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=recovertex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=recovertex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ref-doc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ref-doc.html index 1e1ae0d85b3..c240f0e7332 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ref-doc.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-ref-doc.html @@ -15,7 +15,8 @@ well as the primitive commands. <p/>An interesting LaTeX “cheat sheet” is available from CTAN: it’s a list of (more or less) everything you ‘ought to’ remember, for basic LaTeX use. (It’s laid out very compactly for printing on N.\ -American ‘letter’; printed on ISO A4, it strains aged eyes...) +American ‘letter’; printed on ISO A4, using Adobe +Acrobat’s “shrink to fit”, it strains aged eyes…) <p/>Similarly, there’s no completely reliable command-organised reference to LaTeX. The page (provided by NASA) <a href="http://www.giss.nasa.gov/latex/">Hypertext Help with LaTeX</a> is @@ -27,7 +28,7 @@ you’re going to use it a lot. University) is: <a href="http://www.emerson.emory.edu/services/latex/latex2e/latex2e_toc.html">LaTeXe help</a> <dl> -<dt><tt><i>Cheat sheet</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/latexcheat/latexcheat/latexsheet.pdf">info/latexcheat/latexcheat/latexsheet.pdf</a> +<dt><tt><i>Cheat sheet</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/latexcheat/latexcheat/latexsheet.pdf">info/latexcheat/latexcheat/latexsheet.pdf</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ref-doc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=ref-doc</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repeatgrf.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repeatgrf.html index f63d981ebfa..bbafebbfbd1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repeatgrf.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repeatgrf.html @@ -59,7 +59,7 @@ objects whether or not the PostScript has them amalgamated. PDFTeX does the same job with graphics, automatically converting multiple uses into references to graphics objects. <dl> -<dt><tt><i>graphicx-psmin.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/graphicx-psmin.zip">macros/latex/contrib/graphicx-psmin</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/graphicx-psmin/">browse the directory</a>) +<dt><tt><i>graphicx-psmin.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/graphicx-psmin.zip">macros/latex/contrib/graphicx-psmin</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/graphicx-psmin/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=repeatgrf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=repeatgrf</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repfootnote.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repfootnote.html index 2ddf23e2dd4..aac95f3e4fb 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repfootnote.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-repfootnote.html @@ -19,7 +19,7 @@ solution is simple: merely use the optional argument of ...\footnotemark[1] </pre> </blockquote><p> -... which is very easy, since we know there will only ever be a +… which is very easy, since we know there will only ever be a footnote number 1. A similar technique can be used once the footnotes are stable, reusing the number that LaTeX has allocated. This can be tiresome, though, as any change of typesetting could change the @@ -77,9 +77,9 @@ The package ensures that the repeated text appears at most once per page: it will usually take more than one run of LaTeX to get rid of the repeats. <dl> -<dt><tt><i>fixfoot.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fixfoot.zip">macros/latex/contrib/fixfoot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fixfoot/">browse the directory</a>) -<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>fixfoot.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fixfoot.zip">macros/latex/contrib/fixfoot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fixfoot/">browse the directory</a>) +<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=repfootnote">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=repfootnote</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-replstdcls.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-replstdcls.html index 7bec8911b26..7f56c113063 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-replstdcls.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-replstdcls.html @@ -28,10 +28,10 @@ and German (<i>scrguien</i> in the distribution for English, spoken of, and its lengthy introductory section is regularly recommended as a tutorial on typesetting. <dl> -<dt><tt><i>KOMA-script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>NTGclass bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntgclass.zip">macros/latex/contrib/ntgclass</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntgclass/">browse the directory</a>) -<dt><tt><i>sober.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex209/contrib/misc/sober.sty">macros/latex209/contrib/misc/sober.sty</a> +<dt><tt><i>KOMA-script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>NTGclass bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntgclass.zip">macros/latex/contrib/ntgclass</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntgclass/">browse the directory</a>) +<dt><tt><i>sober.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/misc/sober.sty">macros/latex209/contrib/misc/sober.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=replstdcls">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=replstdcls</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rerun.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rerun.html index a4667839a70..7926de2b1db 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rerun.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rerun.html @@ -25,8 +25,8 @@ can obviously not terminate. document (something as small as adding or deleting a comma will often be enough). <dl> -<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>footmisc.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc.zip">macros/latex/contrib/footmisc</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/footmisc/">browse the directory</a>) +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=rerun">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=rerun</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reuseq.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reuseq.html index 46368c078b7..e7f3dea4ccd 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reuseq.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-reuseq.html @@ -29,9 +29,9 @@ first instance. at <a href="ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf">ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf</a> <dl> <dt><tt><i>amsldoc.tex</i></tt><dd>Distributed as part of AMSLaTeX - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) <dt><tt><i>amsmath.sty</i></tt><dd>Distributed as part of AMSLaTeX - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) + <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=reuseq">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=reuseq</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rulethk.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rulethk.html index 469e996c22a..6304b86a707 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rulethk.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-rulethk.html @@ -45,8 +45,8 @@ horizontal rules, and if their lack of configurability makes them still less attractive, so much the better for the design of your document. <dl> -<dt><tt><i>booktabs.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/booktabs.zip">macros/latex/contrib/booktabs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/booktabs/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>booktabs.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/booktabs.zip">macros/latex/contrib/booktabs</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/booktabs/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=rulethk">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=rulethk</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-run-fn-nos.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-run-fn-nos.html index 535690ab9df..7a46221f39b 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-run-fn-nos.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-run-fn-nos.html @@ -19,7 +19,7 @@ variant; the code: </blockquote><p> is all you need <dl> -<dt><tt><i>chngcntr.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/chngcntr.sty">macros/latex/contrib/misc/chngcntr.sty</a> +<dt><tt><i>chngcntr.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/chngcntr.sty">macros/latex/contrib/misc/chngcntr.sty</a> </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=run-fn-nos">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=run-fn-nos</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-runheadtoobig.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-runheadtoobig.html index 598c6c22cb2..9a7a49598ad 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-runheadtoobig.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-runheadtoobig.html @@ -75,10 +75,10 @@ example: As a result, it is always possible for users of <i>memoir</i> to tailor the header text to fit, with very little trouble. <dl> -<dt><tt><i>fancyhdr.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>titlesec.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titlesec.zip">macros/latex/contrib/titlesec</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titlesec/">browse the directory</a>) +<dt><tt><i>fancyhdr.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr.zip">macros/latex/contrib/fancyhdr</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyhdr/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>titlesec.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titlesec.zip">macros/latex/contrib/titlesec</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titlesec/">browse the directory</a>) </dl> <p/> <p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=runheadtoobig">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=runheadtoobig</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-running-nos.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-running-nos.html index 61fee569b15..70149030d49 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-running-nos.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-running-nos.html @@ -6,18 +6,18 @@ number things per chapter; so figures in chapter 1 are numbered 1.1, 1.2, and so on. Sometimes this is not appropriate for the user’s needs. -<p/>Short of rewriting the whole class, one may use the <i>chngctr</i> +<p/>Short of rewriting the whole class, one may use the <i>chngcntr</i> package, which provides commands <code>\</code><code>counterwithin</code> (which establishes this nested numbering relationship) and <code>\</code><code>counterwithout</code> (which undoes it). -<p/>So if you have figures numbered by chapter as 1.1, 1.2, 2.1, ..., +<p/>So if you have figures numbered by chapter as 1.1, 1.2, 2.1, …, the command <blockquote> <pre> \counterwithout{figure}{chapter} </pre> </blockquote><p> -will convert them to figures 1, 2, 3, .... (Note that the command +will convert them to figures 1, 2, 3, …. (Note that the command has also removed the chapter number from the counter’s definition.) <p/>More elaborate use could change things numbered per section to things numbered per chapter: @@ -51,7 +51,7 @@ way in which the figure number (in this case) is printed: </pre> </blockquote><p> (remember to do the whole job, for every counter you want to -manipulate, within <code>\</code><code>makeatletter</code> ... <code>\</code><code>makeatother</code>). +manipulate, within <code>\</code><code>makeatletter</code> … <code>\</code><code>makeatother</code>). <p/>This technique, too, may be used to change where in a multilevel structure a counter is reset. Suppose your class numbers figures as <<i>chapter</i>>.<<i>section</i>>.<<i>figure</i>>, and you want figures @@ -68,12 +68,12 @@ numbered per chapter, try: </blockquote><p> (the command <code>\</code><code>@addtoreset</code> is a part of LaTeX itself). <dl> -<dt><tt><i>chngcntr.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/chngcntr.sty">macros/latex/contrib/misc/chngcntr.sty</a> -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>removefr.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/fragments/removefr.tex">macros/latex/contrib/fragments/removefr.tex</a> (note, this is constructed as a +<dt><tt><i>chngcntr.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/chngcntr.sty">macros/latex/contrib/misc/chngcntr.sty</a> +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>removefr.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fragments/removefr.tex">macros/latex/contrib/fragments/removefr.tex</a> (note, this is constructed as a “fragment” for use within other packages: load by <code>\</code><code>input{removefr}</code>) -<dt><tt><i>remreset.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) +<dt><tt><i>remreset.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle.zip">macros/latex/contrib/carlisle</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/carlisle/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=running-nos">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=running-nos</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-scriptfonts.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-scriptfonts.html index 8e5a7800b34..4a867aa5607 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-scriptfonts.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-scriptfonts.html @@ -42,14 +42,13 @@ modern TeX distributions. </dl> Examples of the available styles are available on CTAN. <dl> -<dt><tt><i>eucal.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/amsfonts/latex/eucal.sty">fonts/amsfonts/latex/eucal.sty</a> -<dt><tt><i>euler fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/euler.zip">fonts/amsfonts/sources/euler</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/amsfonts/sources/euler/">browse the directory</a>) -<dt><tt><i>euler fonts, in Type 1 format</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/amsfonts/ps-type1/">fonts/amsfonts/ps-type1/</a> -<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ghostscript/">support/ghostscript/</a> -<dt><tt><i>mathrsfs.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/jknappen.zip">macros/latex/contrib/jknappen</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/jknappen/">browse the directory</a>) -<dt><tt><i>rsfs fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/rsfs.zip">fonts/rsfs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/rsfs/">browse the directory</a>) -<dt><tt><i>Script font examples</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/symbols/math/scriptfonts.pdf">info/symbols/math/scriptfonts.pdf</a> -<dt><tt><i>URW Chancery L</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/urw/base35.zip">fonts/urw/base35</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/urw/base35/">browse the directory</a>) +<dt><tt><i>eucal.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) +<dt><tt><i>euler fonts</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts.zip">fonts/amsfonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/amsfonts/">browse the directory</a>) +<dt><tt><i>ghostscript</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/ghostscript/">support/ghostscript/</a> +<dt><tt><i>mathrsfs.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/jknappen.zip">macros/latex/contrib/jknappen</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/jknappen/">browse the directory</a>) +<dt><tt><i>rsfs fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/rsfs.zip">fonts/rsfs</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/rsfs/">browse the directory</a>) +<dt><tt><i>Script font examples</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/symbols/math/scriptfonts.pdf">info/symbols/math/scriptfonts.pdf</a> +<dt><tt><i>URW Chancery L</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/fonts/urw/base35.zip">fonts/urw/base35</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/urw/base35/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=scriptfonts">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=scriptfonts</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-seccntfmt.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-seccntfmt.html index 22620f9e201..847c199c994 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-seccntfmt.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-seccntfmt.html @@ -13,11 +13,11 @@ out a few macros. This answer is for <em>them</em>. <a href="FAQ-atsigns.html">LaTeX internal</a> <code>\</code><code>@seccntformat</code> command, which is given the “name” (section, -subsection, ...) of the heading, as argument. Ordinarily, +subsection, …) of the heading, as argument. Ordinarily, <code>\</code><code>@seccntformat</code> merely outputs the section number, and then a <code>\</code><code>quad</code> of space. Suppose you want to put a stop after every section (subsection, -subsubsection, ...) number, a trivial change may be implemented by +subsubsection, …) number, a trivial change may be implemented by simple modification of the command: <blockquote> <pre> @@ -33,7 +33,6 @@ argument. The following technique for doing the job is slightly wasteful, but is efficient enough for a relatively rare operation: <blockquote> <pre> -\let\@@seccntformat\@seccntformat \renewcommand*{\@seccntformat}[1]{% \expandafter\ifx\csname @seccntformat@#1\endcsname\relax \expandafter\@@seccntformat @@ -65,7 +64,7 @@ changes to section number presentation: <code>\</code><code>partformat</code>, <code>\</code><code>chapterformat</code> and <code>\</code><code>othersectionlevelsformat</code>, but otherwise their facilities are similar to those of “raw” LaTeX. <dl> -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=seccntfmt">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=seccntfmt</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secindent.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secindent.html index c8bd1d44fc1..832c5b11044 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secindent.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secindent.html @@ -9,7 +9,7 @@ The <i>indentfirst</i> package suppresses the mechanism, so that the first paragraph is indented. <dl> -<dt><tt><i>indentfirst.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>indentfirst.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=secindent">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=secindent</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secnumdep.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secnumdep.html index 2e9acd39ec6..24aa9ca02ca 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secnumdep.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secnumdep.html @@ -49,11 +49,11 @@ aren’t numbered. The <i>memoir</i> class incorporates the facilities of all three of the <i>abstract</i>, <i>tocbibind</i> and <i>tocvsec2</i> packages. <dl> -<dt><tt><i>abstract.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/abstract.zip">macros/latex/contrib/abstract</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/abstract/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>tocbibind.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocbibind.zip">macros/latex/contrib/tocbibind</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocbibind/">browse the directory</a>) -<dt><tt><i>tocvsec2.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocvsec2.zip">macros/latex/contrib/tocvsec2</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocvsec2/">browse the directory</a>) +<dt><tt><i>abstract.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/abstract.zip">macros/latex/contrib/abstract</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/abstract/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>tocbibind.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocbibind.zip">macros/latex/contrib/tocbibind</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocbibind/">browse the directory</a>) +<dt><tt><i>tocvsec2.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocvsec2.zip">macros/latex/contrib/tocvsec2</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocvsec2/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=secnumdep">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=secnumdep</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secthead.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secthead.html index eecfc7e25df..b28b976c4e0 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secthead.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-secthead.html @@ -38,14 +38,13 @@ chapter heading designs. The <i>anonchap</i> package provides a simple means of typesetting chapter headings “like section headings” (i.e., without the “Chapter” part of the heading); the <i>tocbibind</i> package provides the same commands, in pursuit of -another end. Unfortunately, <i>fncychap</i> is not attuned to the -existence of front- and backmatter in <i>book</i> class documents. +another end. <p/>The <i>memoir</i> class includes facilities that match <i>sectsty</i> and <i>titlesec</i>, as well as a bundle of chapter heading styles (including an <i>anonchap</i>-equivalent). The <i>KOMA-script</i> classes also have sets of tools that provide equivalent functionality, notably formatting specifications <code>\</code><code>partformat</code>, -<code>\</code><code>chapterformat</code>, <code>\</code><code>sectionformat</code>, ..., as well as several +<code>\</code><code>chapterformat</code>, <code>\</code><code>sectionformat</code>, …, as well as several useful overall formatting specifications defined in class options. <p/>Finally, the indefatigable Vincent Zoonekynd supplies examples of how to program alternative @@ -55,13 +54,13 @@ and The web pages provide programming examples, and expect users to adapt them to their own LaTeX use. <dl> -<dt><tt><i>anonchap.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/anonchap.sty">macros/latex/contrib/misc/anonchap.sty</a> -<dt><tt><i>fncychap.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fncychap.zip">macros/latex/contrib/fncychap</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fncychap/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>sectsty.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sectsty.zip">macros/latex/contrib/sectsty</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sectsty/">browse the directory</a>) -<dt><tt><i>titlesec.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titlesec.zip">macros/latex/contrib/titlesec</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titlesec/">browse the directory</a>) -<dt><tt><i>tocbibind.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocbibind.zip">macros/latex/contrib/tocbibind</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocbibind/">browse the directory</a>) +<dt><tt><i>anonchap.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/anonchap.sty">macros/latex/contrib/misc/anonchap.sty</a> +<dt><tt><i>fncychap.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fncychap.zip">macros/latex/contrib/fncychap</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fncychap/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>sectsty.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sectsty.zip">macros/latex/contrib/sectsty</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sectsty/">browse the directory</a>) +<dt><tt><i>titlesec.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titlesec.zip">macros/latex/contrib/titlesec</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titlesec/">browse the directory</a>) +<dt><tt><i>tocbibind.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocbibind.zip">macros/latex/contrib/tocbibind</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocbibind/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=secthead">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=secthead</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-semanticnest.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-semanticnest.html index 13c48eee5fd..a65b44f6bcc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-semanticnest.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-semanticnest.html @@ -1,7 +1,7 @@ <head> <title>UK TeX FAQ -- question label semanticnest</title> </head><body> -<h3>Capacity exceeded [semantic nest ...]</h3> +<h3>Capacity exceeded [semantic nest …]</h3> <p/> <pre> ! TeX capacity exceeded, sorry [semantic nest size=100]. diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-setURL.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-setURL.html index 7c9dbac727d..802913c7841 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-setURL.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-setURL.html @@ -70,10 +70,10 @@ after which, <code>\</code><code>faqhome</code> is robust. <p/>Documentation of both package <i>path</i> and package <i>url</i> is in the package files. <dl> -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>miniltx.tex</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/graphics.zip">macros/plain/graphics</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/graphics/">browse the directory</a>) -<dt><tt><i>path.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/path.sty">macros/latex/contrib/misc/path.sty</a> -<dt><tt><i>url.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/url.sty">macros/latex/contrib/misc/url.sty</a> +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>miniltx.tex</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/plain/graphics.zip">macros/plain/graphics</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/graphics/">browse the directory</a>) +<dt><tt><i>path.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/path.sty">macros/latex/contrib/misc/path.sty</a> +<dt><tt><i>url.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/url.sty">macros/latex/contrib/misc/url.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=setURL">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=setURL</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slashbox.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slashbox.html index cd6c11f1b96..aa5338acbec 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slashbox.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slashbox.html @@ -46,7 +46,7 @@ go from corner to corner in the box: to correct this requires revision of <i>slashbox</i> — <i>pict2e</i> alone doesn’t help in this regard.) <dl> -<dt><tt><i>slashbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/slashbox.zip">macros/latex/contrib/slashbox</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/slashbox/">browse the directory</a>) +<dt><tt><i>slashbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/slashbox.zip">macros/latex/contrib/slashbox</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/slashbox/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=slashbox">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=slashbox</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slidecls.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slidecls.html index d4992bafcd8..ce5bf0b9aa8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slidecls.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-slidecls.html @@ -68,20 +68,20 @@ available, with examples, in <a href="http://wiki.contextgarden.net/Presentation_Styles">http://wiki.contextgarden.net/Presentation_Styles</a> <dl> -<dt><tt><i>beamer.cls</i></tt><dd>Download all of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/beamer.zip">macros/latex/contrib/beamer</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/beamer/">browse the directory</a>) -<dt><tt><i>foils.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/foiltex.zip">macros/latex/contrib/foiltex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/foiltex/">browse the directory</a>) -<dt><tt><i>greybars.sty</i></tt><dd>distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/talk.zip">macros/latex/contrib/talk</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/talk/">browse the directory</a>) -<dt><tt><i>HA-prosper.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ha-prosper.zip">macros/latex/contrib/ha-prosper</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ha-prosper/">browse the directory</a>) +<dt><tt><i>beamer.cls</i></tt><dd>Download all of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/beamer.zip">macros/latex/contrib/beamer</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/beamer/">browse the directory</a>) +<dt><tt><i>foils.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/foiltex.zip">macros/latex/contrib/foiltex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/foiltex/">browse the directory</a>) +<dt><tt><i>greybars.sty</i></tt><dd>distributed with <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/talk.zip">macros/latex/contrib/talk</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/talk/">browse the directory</a>) +<dt><tt><i>HA-prosper.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ha-prosper.zip">macros/latex/contrib/ha-prosper</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ha-prosper/">browse the directory</a>) -<dt><tt><i>seminar.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/seminar.zip">macros/latex/contrib/seminar</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/seminar/">browse the directory</a>) -<dt><tt><i>pgf.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pgf/">browse the directory</a>) -<dt><tt><i>powerdot.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/powerdot.zip">macros/latex/contrib/powerdot</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/powerdot/">browse the directory</a>) -<dt><tt><i>pp4</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/ppower4.zip">support/ppower4</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/ppower4/">browse the directory</a>) -<dt><tt><i>ppr-prv.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ppr-prv.zip">macros/latex/contrib/ppr-prv</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ppr-prv/">browse the directory</a>) -<dt><tt><i>prosper.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/prosper.zip">macros/latex/contrib/prosper</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/prosper/">browse the directory</a>) -<dt><tt><i>talk.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/talk.zip">macros/latex/contrib/talk</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/talk/">browse the directory</a>) -<dt><tt><i>texpower</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/texpower.zip">macros/latex/contrib/texpower</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/texpower/">browse the directory</a>) -<dt><tt><i>xcolor.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xcolor.zip">macros/latex/contrib/xcolor</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xcolor/">browse the directory</a>) +<dt><tt><i>seminar.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/seminar.zip">macros/latex/contrib/seminar</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/seminar/">browse the directory</a>) +<dt><tt><i>pgf.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/pgf.zip">graphics/pgf</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pgf/">browse the directory</a>) +<dt><tt><i>powerdot.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/powerdot.zip">macros/latex/contrib/powerdot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/powerdot/">browse the directory</a>) +<dt><tt><i>pp4</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/ppower4.zip">support/ppower4</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/ppower4/">browse the directory</a>) +<dt><tt><i>ppr-prv.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ppr-prv.zip">macros/latex/contrib/ppr-prv</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ppr-prv/">browse the directory</a>) +<dt><tt><i>prosper.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/prosper.zip">macros/latex/contrib/prosper</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/prosper/">browse the directory</a>) +<dt><tt><i>talk.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/talk.zip">macros/latex/contrib/talk</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/talk/">browse the directory</a>) +<dt><tt><i>texpower</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/texpower.zip">macros/latex/contrib/texpower</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/texpower/">browse the directory</a>) +<dt><tt><i>xcolor.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xcolor.zip">macros/latex/contrib/xcolor</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xcolor/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=slidecls">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=slidecls</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spaftend.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spaftend.html index d4f7d75150b..1a0a22b76db 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spaftend.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spaftend.html @@ -7,7 +7,7 @@ except that a space appears at the start of the first line of typeset text after <code>\</code><code>end{env}</code>. This doesn’t happen with similar LaTeX-supplied environments. <p/>You could impose the restriction that your users always put a -“<code>%</code>” sign after the environment ... but +“<code>%</code>” sign after the environment … but LaTeX environments don’t require that, either. <p/>The LaTeX environments’ “secret” is an internal flag which causes the unwanted spaces to be ignored. Fortunately, you don’t have to use diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spell.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spell.html index f43c7c08ef7..5fc4497eb6e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spell.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-spell.html @@ -21,16 +21,16 @@ some important features of LaTeX syntax. called from within an editor, and <i>jspell</i> is an extended version of <i>ispell</i>. <dl> -<dt><tt><i>4spell</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/4spell.zip">support/4spell</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/4spell/">browse the directory</a>) -<dt><tt><i>amspell</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/amspell.zip">support/amspell</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/amspell/">browse the directory</a>) -<dt><tt><i>aspell</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/aspell/">support/aspell/</a> — choose just those language +<dt><tt><i>4spell</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/4spell.zip">support/4spell</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/4spell/">browse the directory</a>) +<dt><tt><i>amspell</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/amspell.zip">support/amspell</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/amspell/">browse the directory</a>) +<dt><tt><i>aspell</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/support/aspell/">support/aspell/</a> — choose just those language dictionaries (under subdirectory <i>dict/</i>) that you need. -<dt><tt><i>excalibur</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/mac/support/excalibur/Excalibur-4.0.2.sit.hqx">systems/mac/support/excalibur/Excalibur-4.0.2.sit.hqx</a> -<dt><tt><i>ispell</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/ispell/ispell-3.2.06.tar.gz">support/ispell/ispell-3.2.06.tar.gz</a> -<dt><tt><i>jspell</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/jspell.zip">support/jspell</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/jspell/">browse the directory</a>) +<dt><tt><i>excalibur</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/mac/support/excalibur/Excalibur-4.0.2.sit.hqx">systems/mac/support/excalibur/Excalibur-4.0.2.sit.hqx</a> +<dt><tt><i>ispell</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/ispell/ispell-3.2.06.tar.gz">support/ispell/ispell-3.2.06.tar.gz</a> +<dt><tt><i>jspell</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/jspell.zip">support/jspell</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/jspell/">browse the directory</a>) <dt><tt><i>VMS spell</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/vmspell.zip">support/vmspell</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/vmspell/">browse the directory</a>) -<dt><tt><i>winedt</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/winedt/">systems/win32/winedt/</a> + <a href="http://www.tex.ac.uk/tex-archive/support/vmspell.zip">support/vmspell</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/vmspell/">browse the directory</a>) +<dt><tt><i>winedt</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/win32/winedt/">systems/win32/winedt/</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=spell">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=spell</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-splitfoot.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-splitfoot.html index 2abec7eed21..21ee50b5aee 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-splitfoot.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-splitfoot.html @@ -38,7 +38,7 @@ one page. <p/>The <i>fnbreak</i> package detects (and generates warnings about) split footnotes. <dl> -<dt><tt><i>fnbreak.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fnbreak.zip">macros/latex/contrib/fnbreak</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fnbreak/">browse the directory</a>) +<dt><tt><i>fnbreak.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fnbreak.zip">macros/latex/contrib/fnbreak</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fnbreak/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=splitfoot">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=splitfoot</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-srchpdf.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-srchpdf.html index f95bc5c506d..989e10562b7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-srchpdf.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-srchpdf.html @@ -14,8 +14,8 @@ the lowest 128 characters of Unicode) for most things printable. However, using the inflected characters of Continental European languages, or anything that doesn’t use a Latin alphabet, there is potential for problems, since TeX’s view of what a font is doesn’t -map PDF’s and the reader won’t understand... -<p/>... Unless you use the <i>cmap</i> package with PDFLaTeX, +map PDF’s and the reader won’t understand… +<p/>… Unless you use the <i>cmap</i> package with PDFLaTeX, that is. The package will instruct PDFTeX to load character maps into your PDF for output fonts encoded according to the T1 (Western European Languages), T2A, T2B, or T2C (Cyrillic Languages), @@ -27,8 +27,8 @@ encoded, such as the <i>cm-super</i> distribution. Fonts like Adobe Times Roman (which are encoded for (La)TeX use via virtual fonts) are not amenable to this treatment. <dl> -<dt><tt><i>cmap.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cmap.zip">macros/latex/contrib/cmap</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cmap/">browse the directory</a>) -<dt><tt><i>cm-super fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) +<dt><tt><i>cmap.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cmap.zip">macros/latex/contrib/cmap</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cmap/">browse the directory</a>) +<dt><tt><i>cm-super fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=srchpdf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=srchpdf</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-struttab.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-struttab.html index 0b327116ca7..32b5f4037aa 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-struttab.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-struttab.html @@ -69,11 +69,11 @@ packages such as <i>longtable</i>. <p/>Documentation of both <i>bigstrut</i> and <i>tabls</i> may be found as comments in the package files themselves. <dl> -<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>bigstrut.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multirow.zip">macros/latex/contrib/multirow</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/multirow/">browse the directory</a>) -<dt><tt><i>booktabs.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/booktabs.zip">macros/latex/contrib/booktabs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/booktabs/">browse the directory</a>) -<dt><tt><i>cellspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cellspace.zip">macros/latex/contrib/cellspace</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/cellspace/">browse the directory</a>) -<dt><tt><i>tabls.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/tabls.sty">macros/latex/contrib/misc/tabls.sty</a> +<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>bigstrut.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multirow.zip">macros/latex/contrib/multirow</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/multirow/">browse the directory</a>) +<dt><tt><i>booktabs.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/booktabs.zip">macros/latex/contrib/booktabs</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/booktabs/">browse the directory</a>) +<dt><tt><i>cellspace.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cellspace.zip">macros/latex/contrib/cellspace</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/cellspace/">browse the directory</a>) +<dt><tt><i>tabls.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/tabls.sty">macros/latex/contrib/misc/tabls.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=struttab">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=struttab</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subsubsub.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subsubsub.html index a8220a44101..5df1f34f09a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subsubsub.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subsubsub.html @@ -26,8 +26,8 @@ LaTeX distribution) and the source of the standard packages (<i>classes.dtx</i>). The <a href="FAQ-books.html">LaTeX Companion</a> discusses use of <code>\</code><code>@startsection</code> for this sort of thing. <dl> -<dt><tt><i>LaTeX source</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/base/">browse the directory</a>) -<dt><tt><i>titlesec.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titlesec.zip">macros/latex/contrib/titlesec</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titlesec/">browse the directory</a>) +<dt><tt><i>LaTeX source</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/base.zip">macros/latex/base</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/">browse the directory</a>) +<dt><tt><i>titlesec.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titlesec.zip">macros/latex/contrib/titlesec</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titlesec/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=subsubsub">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=subsubsub</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subverttoks.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subverttoks.html index 6becedead22..a83022861bd 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subverttoks.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-subverttoks.html @@ -12,14 +12,12 @@ every touch and turn.) allows an independent package to play the exact same game: <blockquote> <pre> -\let\mypkg@@everypar\everypar \newtoks\mypkg@everypar \mypkg@everypar\expandafter{\the\everypar} \mypkg@@everypar{\mypkgs@ownstuff\the\mypkg@everypar} \def\mypkgs@ownstuff{% <stuff to do at the start of the token register>% } -\let\everypar\mypkg@everypar </pre> </blockquote><p> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-symbols.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-symbols.html index 719785c5fe5..b986e1656e7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-symbols.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-symbols.html @@ -1,7 +1,7 @@ <head> <title>UK TeX FAQ -- question label symbols</title> </head><body> -<h3>Where can I find the symbol for ...</h3> +<h3>Where can I find the symbol for …</h3> <!-- assignment circular integral degrees diagonal dots Fourier transform --> <!-- Laplace greater less complex integer natural real --> <!-- cent euro --> @@ -18,8 +18,17 @@ symbols: <li> <a href="FAQ-numbersets.html">Fonts for the number sets</a> <li> <a href="FAQ-prinvalint.html">Typesetting the principal value integral</a> </ul> +<p/>A useful new +<a href="http://detexify.kirelabs.org/classify.html">symbol search</a> web +site is available. It provides you a scratch area on which you draw +the symbol you’re thinking of, with your mouse; when you’ve finished +drawing, the classifier tries to match your sketch with symbols it +knows about. The matching process is pretty good, even for the +sketches of a <em>really</em> poor draughtsman, and it’s often worth +trying more than once. Given the huge size of the symbol list, this +tool can be very helpful. <dl> -<dt><tt><i>Symbol List</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/symbols/comprehensive/">info/symbols/comprehensive/</a>; there are processed +<dt><tt><i>Symbol List</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/info/symbols/comprehensive/">info/symbols/comprehensive/</a>; there are processed versions in both PostScript and PDF forms for both A4 and letter paper. </dl> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabacc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabacc.html index fee3f89401c..5af40c48aea 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabacc.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabacc.html @@ -26,7 +26,7 @@ type: </blockquote><p> for: <blockquote> - ...\quad voilà\quad ... + …\quad voilà\quad … </blockquote><p> and the internal mechanisms of the <i>inputenc</i> package will put the right version of the accent command in there. @@ -46,7 +46,7 @@ example would therefore become: </pre> </blockquote><p> <dl> -<dt><tt><i>Tabbing.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/Tabbing.zip">macros/latex/contrib/Tabbing</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/Tabbing/">browse the directory</a>) +<dt><tt><i>Tabbing.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/Tabbing.zip">macros/latex/contrib/Tabbing</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/Tabbing/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tabacc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tabacc</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabcellalign.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabcellalign.html index 928e19b1a20..8aca9116776 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabcellalign.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tabcellalign.html @@ -66,7 +66,7 @@ or in the preamble as: </pre> </blockquote><p> <dl> -<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tabcellalign">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tabcellalign</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tds.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tds.html index bcfcbc93c3a..440768486bc 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tds.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tds.html @@ -29,7 +29,7 @@ You may browse an <a href="http://tug.org/tds/">on-line version</a> of the standard, and copies in several other formats (including source) are available on CTAN. <dl> -<dt><tt><i>TDS specification</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/tds.zip">tds</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/tds/">browse the directory</a>) +<dt><tt><i>TDS specification</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/tds.zip">tds</a> (or <a href="http://www.tex.ac.uk/tex-archive/tds/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texcad.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texcad.html index 23f50dced73..bb1667ff738 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texcad.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texcad.html @@ -13,8 +13,8 @@ the emTeX driver-family TeXCAD is part of the emTeX distribution. <p/>A Unix port of the program (<i>xtexcad</i>) has been made. <dl> -<dt><tt><i>emtex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/emtex.zip">systems/msdos/emtex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/msdos/emtex/">browse the directory</a>) -<dt><tt><i>xtexcad</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivenonfree/graphics/xtexcad/xtexcad-2.4.1.tar.gz">nonfree/graphics/xtexcad/xtexcad-2.4.1.tar.gz</a> +<dt><tt><i>emtex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/msdos/emtex.zip">systems/msdos/emtex</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/msdos/emtex/">browse the directory</a>) +<dt><tt><i>xtexcad</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/nonfree/graphics/xtexcad/xtexcad-2.4.1.tar.gz">nonfree/graphics/xtexcad/xtexcad-2.4.1.tar.gz</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texcad">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texcad</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texinfo.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texinfo.html index cff7f094121..9e14f5dda27 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texinfo.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texinfo.html @@ -27,7 +27,7 @@ avoided. <p/>Finally, of course, you can also print the files, or convert them to PDF using PDFTeX. <dl> -<dt><tt><i>Texinfo distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texinfo/texinfo.zip">macros/texinfo/texinfo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/texinfo/texinfo/">browse the directory</a>) +<dt><tt><i>Texinfo distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/texinfo/texinfo.zip">macros/texinfo/texinfo</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/texinfo/texinfo/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texinfo">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texinfo</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texorpdf.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texorpdf.html index a447959c26d..2ff090f1c68 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texorpdf.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texorpdf.html @@ -41,5 +41,6 @@ example above would become: </blockquote><p> and with that definition, the example will compile succesfully (<i>hyperref</i> knows about the macro <code>\</code><code>space</code>). +<p><em>This answer was added: 2009-05-29</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texorpdf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texorpdf</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textflow.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textflow.html index d97c88c01ca..c700ffe752d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textflow.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textflow.html @@ -1,7 +1,7 @@ <head> <title>UK TeX FAQ -- question label textflow</title> </head><body> -<h3>Flowing text around figures in LaTeX</h3> +<h3>Flowing text around figures</h3> <p/>There are several LaTeX packages that purport to do this, but they all have their limitations because the TeX machine isn’t really designed to solve this sort of problem. Piet van Oostrum has @@ -63,11 +63,22 @@ LaTeX document). good), the documentation is in German. Piet van Oostrum has written a summary in English. </dl> +Plain TeX users only have one option: <i>figflow</i> (which +doesn’t work in LaTeX). <i>Figflow</i> only offers flowed +figures at the start of the paragraph, but it seems perfectly +functional. Syntax is +<blockquote> + <code>\</code><code>figflow{</code><em><<i>width</i>></em><code>}{</code><em><<i>height</i>></em><code>}{</code><em><<i>figure</i>></em><code>}</code> +</blockquote><p> +(the user is responsible for having the dimensions correct, and for +ensuring the figure fits on the page). <dl> -<dt><tt><i>floatflt.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/floatflt.zip">macros/latex/contrib/floatflt</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/floatflt/">browse the directory</a>) -<dt><tt><i>picins.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex209/contrib/picins.zip">macros/latex209/contrib/picins</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex209/contrib/picins/">browse the directory</a>) -<dt><tt><i>picins documentation summary</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex209/contrib/picins/picins.txt">macros/latex209/contrib/picins/picins.txt</a> -<dt><tt><i>wrapfig.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/wrapfig.zip">macros/latex/contrib/wrapfig</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/wrapfig/">browse the directory</a>) +<dt><tt><i>figflow.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/figflow.zip">macros/plain/contrib/figflow</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/contrib/figflow/">browse the directory</a>) +<dt><tt><i>floatflt.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/floatflt.zip">macros/latex/contrib/floatflt</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/floatflt/">browse the directory</a>) +<dt><tt><i>picins.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/picins.zip">macros/latex209/contrib/picins</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/picins/">browse the directory</a>) +<dt><tt><i>picins documentation summary</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/picins/picins.txt">macros/latex209/contrib/picins/picins.txt</a> +<dt><tt><i>wrapfig.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/wrapfig.zip">macros/latex/contrib/wrapfig</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/wrapfig/">browse the directory</a>) </dl> +<p><em>This answer last edited: 2009-06-11</em></p> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=textflow">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=textflow</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texthings.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texthings.html index 4388082f856..bbc3749b3e0 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texthings.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-texthings.html @@ -79,7 +79,7 @@ that you are likely to encounter: See <a href="FAQ-eplain.html">What is Eplain?</a>. </dl> -<p/><p/><b>Modified <i>tex</b> executables</i> +<p/><p/><b>Modified <i>tex</i> executables</b> The original <i>tex</i> executable was produced in the late 1970s (cf. <a href="FAQ-whatTeX.html">What is TeX?</a>) and consequently lacked some features that users have come to expect from today’s @@ -128,7 +128,7 @@ listed earlier to produce executables with both sets of features. For example, the <i>pdflatex</i>, <i>xelatex</i> and <i>lualatex</i> executables each combine LaTeX with an enhanced TeX engine. Some executables combine the -features of multiple enhanced TeX engine: <i>pdfetex</i> +features of multiple enhanced TeX engines: <i>pdfetex</i> combines PDFTeX and e-TeX into a single executable. <p/>As combining features is a generally desirable tendency, current TeX distributions (see below) incorporate the features of PDFTeX @@ -138,7 +138,7 @@ offered with a LaTeX format (as <i>latex</i> or <i>pdftex</i>). (<i>Tex</i> remains with an unadorned TeX executable using Plain TeX, for people such as Knuth himself, who want the certainty of the “original”.) -<p/><p/><p/><b>TeX distributions</b> +<p/><p/><b>TeX distributions</b> A <em>TeX distribution</em> is a collection of TeX-related software. Generally, a TeX distribution includes a set of core TeX executables such as <i>tex</i> and <i>latex</i>; @@ -156,7 +156,7 @@ distributions are free; others require payment. See list of free and shareware TeX distributions and <a href="FAQ-commercial.html">Commercial TeX implementations</a> for a list of commercial TeX distributions. -<p/><p/><p/><b>Summary</b> +<p/><p/><b>Summary</b> If your document begins with <code>\</code><code>documentclass</code>, you’re using some form of the LaTeX macro package. Even if hidden behind a button in a TeX-aware GUI, this document is getting compiled by a TeX @@ -164,6 +164,6 @@ executable—probably <i>latex</i> or <i>pdflatex</i>—to produce an output file. The executable came bundled as part of a TeX distribution such as MiKTeX, which includes various other TeX-related components. - -<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texthings">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texthings</a> +<p><em>This answer last edited: 2009-06-11</em></p> +<p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texthings">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=texthings</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textrace.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textrace.html index fc6be497d44..1e06ca68cda 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textrace.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-textrace.html @@ -35,7 +35,7 @@ Type 1 fonts. The first results, the well-established, and a bunch of existing designs have been reworked in MetaType1 format. <dl> -<dt><tt><i>MetaType1</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/metatype1.zip">fonts/utilities/metatype1</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/metatype1/">browse the directory</a>) +<dt><tt><i>MetaType1</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/metatype1.zip">fonts/utilities/metatype1</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/metatype1/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=textrace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=textrace</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-theoremfmt.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-theoremfmt.html index 3a2c28ac8d2..709e96d6dfe 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-theoremfmt.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-theoremfmt.html @@ -5,7 +5,7 @@ <p/>If you want to take advantage of the powerful <code>\</code><code>newtheorem</code> command without the constraint that the contents of the theorem is in a sloped font (for example, you may want to use it to create remarks, examples, proofs, -...) then you can use the AMSLaTeX <i>amsthm</i> package +…) then you can use the AMSLaTeX <i>amsthm</i> package (which now supersedes the <i>theorem</i> package previously recommended in these answers). Alternatively, the following sets up an environment @@ -21,9 +21,9 @@ Alternatively, the following sets up an environment The <i>ntheorem</i> package provides control of the fonts used by theorems, directly. <dl> -<dt><tt><i>amsthm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/amslatex/">browse the directory</a>) -<dt><tt><i>ntheorem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntheorem.zip">macros/latex/contrib/ntheorem</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ntheorem/">browse the directory</a>) -<dt><tt><i>theorem.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>amsthm.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex.zip">macros/latex/required/amslatex</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/amslatex/">browse the directory</a>) +<dt><tt><i>ntheorem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntheorem.zip">macros/latex/contrib/ntheorem</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ntheorem/">browse the directory</a>) +<dt><tt><i>theorem.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=theoremfmt">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=theoremfmt</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-thesis.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-thesis.html index 4cd505fddf5..28562a9a095 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-thesis.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-thesis.html @@ -12,7 +12,7 @@ start is the University of California style, but remember that it’s often difficult to produce a thesis that both looks good and conforms with the style that your Univeristy demands. <dl> -<dt><tt><i>UC thesis style</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ucthesis.zip">macros/latex/contrib/ucthesis</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ucthesis/">browse the directory</a>) +<dt><tt><i>UC thesis style</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ucthesis.zip">macros/latex/contrib/ucthesis</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ucthesis/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=thesis">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=thesis</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-time.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-time.html index 20b45407be5..61cb21bb1bd 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-time.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-time.html @@ -24,8 +24,8 @@ words). command also takes an optional argument, the character to separate the hours and minutes: the default is of course <code>:</code>. <dl> -<dt><tt><i>datetime.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/datetime.zip">macros/latex/contrib/datetime</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/datetime/">browse the directory</a>) -<dt><tt><i>scrtime.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>datetime.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/datetime.zip">macros/latex/contrib/datetime</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/datetime/">browse the directory</a>) +<dt><tt><i>scrtime.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=time">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=time</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-titlsty.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-titlsty.html index 16510f85404..9f210684e62 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-titlsty.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-titlsty.html @@ -17,9 +17,9 @@ to program alternative The web page is not useful to users unless they are willing to do their own LaTeX programming. <dl> -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>titling.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titling.zip">macros/latex/contrib/titling</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/titling/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>titling.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titling.zip">macros/latex/contrib/titling</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/titling/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=titlsty">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=titlsty</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tmupfl.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tmupfl.html index 93228659a58..1fd97bad2ab 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tmupfl.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tmupfl.html @@ -44,7 +44,7 @@ more floats, leading to the error. <i>float</i> package’s <code>[H]</code> float qualifier, but you are unlikely to get away without using <code>\</code><code>clearpage</code> from time to time. <dl> -<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float/">browse the directory</a>) +<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tmupfl">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tmupfl</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-toascii.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-toascii.html index 81240cec872..c38deec3401 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-toascii.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-toascii.html @@ -37,7 +37,7 @@ restricted circumstances. <i>Perl</i> script that converts TeX files into plain text files, expanding various mathematical symbols (sums, products, integrals, sub/superscripts, fractions, square -roots, ...) into “ASCII art” that spreads over +roots, …) into “ASCII art” that spreads over multiple lines if necessary. The result is more readable to human beings than the flat-style TeX code. <p/>Another significant possibility is to use one of the @@ -45,14 +45,14 @@ beings than the flat-style TeX code. and then to use a browser such as <i>lynx</i> to dump the resulting HTML as plain text. <dl> -<dt><tt><i>catdvi</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/catdvi.zip">dviware/catdvi</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/catdvi/">browse the directory</a>) -<dt><tt><i>crudetype</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/crudetype.zip">dviware/crudetype</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/crudetype/">browse the directory</a>) -<dt><tt><i>detex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/detex.zip">support/detex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/detex/">browse the directory</a>) -<dt><tt><i>dvi2tty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvi2tty.zip">dviware/dvi2tty</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/dviware/dvi2tty/">browse the directory</a>) -<dt><tt><i>l2a</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/l2a.zip">support/l2a</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/l2a/">browse the directory</a>) -<dt><tt><i>screen.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex209/contrib/misc/screen.sty">macros/latex209/contrib/misc/screen.sty</a> -<dt><tt><i>tex2mail</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tex2mail.zip">support/tex2mail</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/tex2mail/">browse the directory</a>) -<dt><tt><i>txt</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/txt.zip">support/txt</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/txt/">browse the directory</a>) +<dt><tt><i>catdvi</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/catdvi.zip">dviware/catdvi</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/catdvi/">browse the directory</a>) +<dt><tt><i>crudetype</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/crudetype.zip">dviware/crudetype</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/crudetype/">browse the directory</a>) +<dt><tt><i>detex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/detex.zip">support/detex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/detex/">browse the directory</a>) +<dt><tt><i>dvi2tty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/dviware/dvi2tty.zip">dviware/dvi2tty</a> (or <a href="http://www.tex.ac.uk/tex-archive/dviware/dvi2tty/">browse the directory</a>) +<dt><tt><i>l2a</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/l2a.zip">support/l2a</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/l2a/">browse the directory</a>) +<dt><tt><i>screen.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex209/contrib/misc/screen.sty">macros/latex209/contrib/misc/screen.sty</a> +<dt><tt><i>tex2mail</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/tex2mail.zip">support/tex2mail</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/tex2mail/">browse the directory</a>) +<dt><tt><i>txt</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/txt.zip">support/txt</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/txt/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=toascii">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=toascii</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocbibind.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocbibind.html index 97548fe7cc3..81ab4ab1bb7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocbibind.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocbibind.html @@ -53,10 +53,10 @@ as a set of class options (e.g., <code>bibtotoc</code> to add the bibliography to the table of contents); the <i>memoir</i> class includes <i>tocbibind</i> itself. <dl> -<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>tocbibind.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocbibind.zip">macros/latex/contrib/tocbibind</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocbibind/">browse the directory</a>) +<dt><tt><i>hyperref.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref.zip">macros/latex/contrib/hyperref</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/hyperref/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>tocbibind.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocbibind.zip">macros/latex/contrib/tocbibind</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocbibind/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tocbibind">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tocbibind</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocloft.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocloft.html index a40ed9df058..82dae3223c6 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocloft.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tocloft.html @@ -10,7 +10,7 @@ for page numbers, the indentation of the right-hand margin, and the separation of the dots in the dotted leaders, respectively. The series of commands named <code>\</code><code>l@<em>xxx</code></em>, where <code><em>xxx</em></code> is the name of a sectional heading (such as <code>chapter</code> or -<code>section</code>, ...) control the layout of the corresponding +<code>section</code>, …) control the layout of the corresponding heading, including the space for section numbers. All these internal commands may be individually redefined to give the effect that you want. @@ -24,9 +24,9 @@ for the table of contents, and calculates the space needed for the numbers automatically. The <i>memoir</i> class includes the functionality of <i>tocloft</i>. <dl> -<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>tocloft.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocloft.zip">macros/latex/contrib/tocloft</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/tocloft/">browse the directory</a>) +<dt><tt><i>KOMA script bundle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script.zip">macros/latex/contrib/koma-script</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/koma-script/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>tocloft.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocloft.zip">macros/latex/contrib/tocloft</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/tocloft/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tocloft">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tocloft</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-topgraph.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-topgraph.html index 05632d25f2f..0486039e377 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-topgraph.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-topgraph.html @@ -4,7 +4,7 @@ <h3>Top-aligning imported graphics</h3> <p/>When TeX sets a line of anything, it ensures that the base-line of each object in the line is at the same level as the base-line of the -final object. (Apart, of course, from <code>\</code><code>raisebox</code> commands...) +final object. (Apart, of course, from <code>\</code><code>raisebox</code> commands…) <p/>Most imported graphics have their base-line set at the bottom of the picture. When using packages such as <i>subfig</i>, one often wants to align figures by their tops. The following odd little bit of diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tutbitslatex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tutbitslatex.html index ff55f5f2dc8..ccec610f379 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tutbitslatex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-tutbitslatex.html @@ -85,9 +85,9 @@ deparment’s pages at <dl> <dt><tt><i>Graphics in LaTeX2e</i></tt><dd>the document is available in PostScript and PDF formats as - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/epslatex/english/epslatex.ps">info/epslatex/english/epslatex.ps</a> and <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/epslatex/english/epslatex.pdf">info/epslatex/english/epslatex.pdf</a> respectively -<dt><tt><i>testflow</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/IEEEtran/testflow/">macros/latex/contrib/IEEEtran/testflow/</a> -<dt><tt><i>Herbert Voss’s Maths tutorial</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/math/voss/mathmode/Mathmode.pdf">info/math/voss/mathmode/Mathmode.pdf</a> + <a href="http://www.tex.ac.uk/tex-archive/info/epslatex/english/epslatex.ps">info/epslatex/english/epslatex.ps</a> and <a href="http://www.tex.ac.uk/tex-archive/info/epslatex/english/epslatex.pdf">info/epslatex/english/epslatex.pdf</a> respectively +<dt><tt><i>testflow</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/IEEEtran/testflow/">macros/latex/contrib/IEEEtran/testflow/</a> +<dt><tt><i>Herbert Voss’s Maths tutorial</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/math/voss/mathmode/Mathmode.pdf">info/math/voss/mathmode/Mathmode.pdf</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tutbitslatex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tutbitslatex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-twooptarg.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-twooptarg.html index 1d148d6af2e..9027a346d66 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-twooptarg.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-twooptarg.html @@ -68,11 +68,11 @@ readily-understood language), and emits (La)TeX macros which enable the command to be defined. The command requires that a <i>Python</i> interpreter (etc.) be installed on your computer. <dl> -<dt><tt><i>newcommand.py</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/newcommand.zip">support/newcommand</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/newcommand/">browse the directory</a>) -<dt><tt><i>optparams.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sauerj.zip">macros/latex/contrib/sauerj</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/sauerj/">browse the directory</a>) -<dt><tt><i>twoopt.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) -<dt><tt><i>xargs.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xargs.zip">macros/latex/contrib/xargs</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xargs/">browse the directory</a>) -<dt><tt><i>xkeyval.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xkeyval.zip">macros/latex/contrib/xkeyval</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/xkeyval/">browse the directory</a>) +<dt><tt><i>newcommand.py</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/newcommand.zip">support/newcommand</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/newcommand/">browse the directory</a>) +<dt><tt><i>optparams.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sauerj.zip">macros/latex/contrib/sauerj</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/sauerj/">browse the directory</a>) +<dt><tt><i>twoopt.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) +<dt><tt><i>xargs.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xargs.zip">macros/latex/contrib/xargs</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xargs/">browse the directory</a>) +<dt><tt><i>xkeyval.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xkeyval.zip">macros/latex/contrib/xkeyval</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/xkeyval/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=twooptarg">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=twooptarg</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-type1T1.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-type1T1.html index 7e119d8a2a6..ab8a79de8c3 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-type1T1.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-type1T1.html @@ -91,16 +91,16 @@ Adobe’s Times family) you have to find a matching family of mathematical fonts, which is a non-trivial undertaking — see <a href="FAQ-psfchoice.html">“choice of scalable fonts”</a>. <dl> -<dt><tt><i>ae fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ae.zip">fonts/ae</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ae/">browse the directory</a>) -<dt><tt><i>aecompl.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ae.zip">fonts/ae</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ae/">browse the directory</a>) -<dt><tt><i>aeguill.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/aeguill.zip">macros/latex/contrib/aeguill</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/aeguill/">browse the directory</a>) -<dt><tt><i>BaKoMa fonts</i></tt><dd>Browse <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesystems/win32/bakoma/fonts/">systems/win32/bakoma/fonts/</a> -<dt><tt><i>CM-LGC fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-lgc.zip">fonts/ps-type1/cm-lgc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-lgc/">browse the directory</a>) -<dt><tt><i>CM-super fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) (beware: +<dt><tt><i>ae fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ae.zip">fonts/ae</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ae/">browse the directory</a>) +<dt><tt><i>aecompl.sty</i></tt><dd>Distributed with <a href="http://www.tex.ac.uk/tex-archive/fonts/ae.zip">fonts/ae</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ae/">browse the directory</a>) +<dt><tt><i>aeguill.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/aeguill.zip">macros/latex/contrib/aeguill</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/aeguill/">browse the directory</a>) +<dt><tt><i>BaKoMa fonts</i></tt><dd>Browse <a href="http://www.tex.ac.uk/tex-archive/systems/win32/bakoma/fonts/">systems/win32/bakoma/fonts/</a> +<dt><tt><i>CM-LGC fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-lgc.zip">fonts/ps-type1/cm-lgc</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-lgc/">browse the directory</a>) +<dt><tt><i>CM-super fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super.zip">fonts/ps-type1/cm-super</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/cm-super/">browse the directory</a>) (beware: very large download) -<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm/">browse the directory</a>) -<dt><tt><i>tt2001 fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/tt2001.zip">fonts/ps-type1/tt2001</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/ps-type1/tt2001/">browse the directory</a>) -<dt><tt><i>zefonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/zefonts.zip">fonts/zefonts</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/zefonts/">browse the directory</a>) +<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/lm/">browse the directory</a>) +<dt><tt><i>tt2001 fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/tt2001.zip">fonts/ps-type1/tt2001</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/ps-type1/tt2001/">browse the directory</a>) +<dt><tt><i>zefonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/zefonts.zip">fonts/zefonts</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/zefonts/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=type1T1">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=type1T1</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-typo-style.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-typo-style.html index 125eebf8ba7..a5b5d494832 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-typo-style.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-typo-style.html @@ -19,7 +19,7 @@ ambition to supplant such excellent books as contain its Rutgers-local matter) is a fine introduction to the issues of producing readable documents. <dl> -<dt><tt><i>memoir distribution</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>memoir distribution</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=typo-style">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=typo-style</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underline.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underline.html index bed08505430..70200a3e798 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underline.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underline.html @@ -32,8 +32,8 @@ loading the package with: </pre> Documentation of <i>ulem</i> is in the package itself. <dl> -<dt><tt><i>ulem.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/ulem.sty">macros/latex/contrib/misc/ulem.sty</a> -<dt><tt><i>soul.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/soul.zip">macros/latex/contrib/soul</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/soul/">browse the directory</a>) +<dt><tt><i>ulem.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/ulem.sty">macros/latex/contrib/misc/ulem.sty</a> +<dt><tt><i>soul.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/soul.zip">macros/latex/contrib/soul</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/soul/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=underline">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=underline</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underscore.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underscore.html index 6f429744203..5f45096bdb3 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underscore.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-underscore.html @@ -36,7 +36,7 @@ sense of the word), but it <em>is</em> robust under expansion (i.e., the LaTeX sense of the word); so use it with care, but don’t worry about section headings and the like. <dl> -<dt><tt><i>underscore.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/underscore.sty">macros/latex/contrib/misc/underscore.sty</a> +<dt><tt><i>underscore.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/underscore.sty">macros/latex/contrib/misc/underscore.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=underscore">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=underscore</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-unkgrfextn.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-unkgrfextn.html index 243e9c862e8..15f17eb50d1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-unkgrfextn.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-unkgrfextn.html @@ -58,7 +58,7 @@ unsatisfactory alternatives: </pre> </ul> <dl> -<dt><tt><i>grffile.sty</i></tt><dd>Distributed as part of the <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) collection +<dt><tt><i>grffile.sty</i></tt><dd>Distributed as part of the <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek.zip">macros/latex/contrib/oberdiek</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/oberdiek/">browse the directory</a>) collection </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uploads.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uploads.html index a7c22ad08bf..49a9392eddb 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uploads.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uploads.html @@ -57,7 +57,7 @@ contribution direct into the archive. At present this may only be done if your contribution is available via <i>ftp</i>, and of course the directory structure on your repository must ‘fit’. <dl> -<dt><tt><i>README.uploads</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveREADME.uploads">README.uploads</a> +<dt><tt><i>README.uploads</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/README.uploads">README.uploads</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=uploads">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=uploads</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-upquot.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-upquot.html index 25f3ee117ab..57fe5142e5c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-upquot.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-upquot.html @@ -12,7 +12,7 @@ particularly in those of Unix-like shell scripts. The <code>verbatim</code> environment so that the output is a clearer representation of what the user must type. <dl> -<dt><tt><i>upquote.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/upquote/upquote.sty">macros/latex/contrib/upquote/upquote.sty</a> +<dt><tt><i>upquote.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/upquote/upquote.sty">macros/latex/contrib/upquote/upquote.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=upquot">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=upquot</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-useMF.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-useMF.html index 87d2f2d6d84..73e038bfe74 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-useMF.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-useMF.html @@ -112,7 +112,7 @@ parameters, you should use them to rebuild the base file that you use. <p/>Other sources of help are discussed in our list of <a href="FAQ-mfptutorials.html">Metafont and MetaPost Tutorials</a>. <dl> -<dt><tt><i>modes.mf</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivefonts/modes/modes.mf">fonts/modes/modes.mf</a> +<dt><tt><i>modes.mf</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/modes/modes.mf">fonts/modes/modes.mf</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=useMF">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=useMF</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usebibtex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usebibtex.html index 29f3864ad4c..84aad77577f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usebibtex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usebibtex.html @@ -68,7 +68,7 @@ it finds a <code>.bbl</code> file, and reads it. As it encounters each citation. <p/>Sixth: you run LaTeX yet again. This time, it finds values for all the citations, in its <code>.aux</code> file. Other things being equal, you’re -done... until you change the file. +done… until you change the file. <p/>If, while editing, you change any of the citations, or add new ones, you need to go through the process above from steps 3 (first run of LaTeX) to 6, again, before the document is once again stable. diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uselmfonts.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uselmfonts.html index 3bafe92ef36..212f6d76180 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uselmfonts.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-uselmfonts.html @@ -60,7 +60,7 @@ for text, and if you want to use any of the TS1-encoding symbols. There is no support for using fonts according to the OT1 encoding. <dl> -<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/lm/">browse the directory</a>) +<dt><tt><i>Latin Modern fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/lm.zip">fonts/lm</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/lm/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=uselmfonts">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=uselmfonts</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepictex.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepictex.html index 4a4b8870e88..be9a8d8a5f2 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepictex.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepictex.html @@ -49,10 +49,10 @@ part of the distribution). <i>MathsPic</i> is available either as a <i>Basic</i> program for DOS, or as a <i>Perl</i> program for other systems (including Windows, nowadays). <dl> -<dt><tt><i>m-pictex.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/context/current/cont-tmf.zip">macros/context/current/cont-tmf.zip</a> -<dt><tt><i>m-pictex.tex</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/context/current/cont-tmf.zip">macros/context/current/cont-tmf.zip</a> -<dt><tt><i>MathsPic</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/mathspic.zip">graphics/mathspic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/mathspic/">browse the directory</a>) -<dt><tt><i>pictexwd.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pictex/addon.zip">graphics/pictex/addon</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/pictex/addon/">browse the directory</a>) +<dt><tt><i>m-pictex.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/context/current/cont-tmf.zip">macros/context/current/cont-tmf.zip</a> +<dt><tt><i>m-pictex.tex</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/context/current/cont-tmf.zip">macros/context/current/cont-tmf.zip</a> +<dt><tt><i>MathsPic</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/mathspic.zip">graphics/mathspic</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/mathspic/">browse the directory</a>) +<dt><tt><i>pictexwd.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/graphics/pictex/addon.zip">graphics/pictex/addon</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/pictex/addon/">browse the directory</a>) </dl> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=usepictex">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=usepictex</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepsfont.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepsfont.html index 3766b77b1eb..6490fc4a377 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepsfont.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usepsfont.html @@ -42,9 +42,9 @@ LaTeX’s NFSS, and so is easy to use with PostScript fonts. <p/>Some common problems encountered are discussed elsewhere (see <a href="FAQ-psfontprob.html">problems with PS fonts</a>). <dl> -<dt><tt><i>Metrics for the ‘Laserwriter’ set of 35 fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/required/psnfss/lw35nfss.zip">macros/latex/required/psnfss/lw35nfss.zip</a> -<dt><tt><i>lollipop</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/lollipop.zip">macros/lollipop</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/lollipop/">browse the directory</a>) -<dt><tt><i>psnfss</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss/">browse the directory</a>) +<dt><tt><i>Metrics for the ‘Laserwriter’ set of 35 fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss/lw35nfss.zip">macros/latex/required/psnfss/lw35nfss.zip</a> +<dt><tt><i>lollipop</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/lollipop.zip">macros/lollipop</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/lollipop/">browse the directory</a>) +<dt><tt><i>psnfss</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=usepsfont">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=usepsfont</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usesymb.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usesymb.html index 334c1ac2c75..631682b7eef 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usesymb.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-usesymb.html @@ -32,9 +32,9 @@ font family and colour specified in the arguments of clear; it is probably the best tool to use for picking and choosing symbols from a variety of font families. <dl> -<dt><tt><i>mnsymbol fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mnsymbol.zip">fonts/mnsymbol</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/mnsymbol/">browse the directory</a>) -<dt><tt><i>pifont.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/psnfss/">browse the directory</a>) -<dt><tt><i>yagusylo.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/yagusylo.zip">macros/latex/contrib/yagusylo</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/yagusylo/">browse the directory</a>) +<dt><tt><i>mnsymbol fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/mnsymbol.zip">fonts/mnsymbol</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/mnsymbol/">browse the directory</a>) +<dt><tt><i>pifont.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss.zip">macros/latex/required/psnfss</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/psnfss/">browse the directory</a>) +<dt><tt><i>yagusylo.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/yagusylo.zip">macros/latex/contrib/yagusylo</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/yagusylo/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=usesymb">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=usesymb</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidcol.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidcol.html index 95382eadf83..d7d35f5f442 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidcol.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidcol.html @@ -54,8 +54,8 @@ or you can use it as follows: where the second column will end up noticeably wider, and will wrap to a second line in the third row. <dl> -<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) -<dt><tt><i>varwidth.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/varwidth.sty">macros/latex/contrib/misc/varwidth.sty</a> +<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>varwidth.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/varwidth.sty">macros/latex/contrib/misc/varwidth.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=varwidcol">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=varwidcol</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidth.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidth.html index 45aef83b16f..b3e19aedef4 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidth.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-varwidth.html @@ -61,9 +61,9 @@ itself). things still to be done, but the package is already proving useful for a variety of jobs. <dl> -<dt><tt><i>eqparbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eqparbox.zip">macros/latex/contrib/eqparbox</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eqparbox/">browse the directory</a>) -<dt><tt><i>pbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pbox.zip">macros/latex/contrib/pbox</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/pbox/">browse the directory</a>) -<dt><tt><i>varwidth.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/varwidth.sty">macros/latex/contrib/misc/varwidth.sty</a> +<dt><tt><i>eqparbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eqparbox.zip">macros/latex/contrib/eqparbox</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eqparbox/">browse the directory</a>) +<dt><tt><i>pbox.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pbox.zip">macros/latex/contrib/pbox</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/pbox/">browse the directory</a>) +<dt><tt><i>varwidth.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/varwidth.sty">macros/latex/contrib/misc/varwidth.sty</a> </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=varwidth">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=varwidth</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbfile.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbfile.html index 1d607ba94ea..02155e4c254 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbfile.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbfile.html @@ -26,7 +26,7 @@ finds: </pre> </blockquote><p> of course, this is little use for inputting (La)TeX source -code... +code… <p/>The <i>moreverb</i> package extends the <i>verbatim</i> package, providing a <code>listing</code> environment and a <code>\</code><code>listinginput</code> command, which line-number the text of the file. The package also has @@ -52,11 +52,11 @@ advised. <i>verbatim</i> and <i>moreverb</i> packages. <dl> <dt><tt><i>alltt.sty</i></tt><dd>Part of the LaTeX distribution. -<dt><tt><i>fancyvrb.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyvrb.zip">macros/latex/contrib/fancyvrb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyvrb/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>moreverb.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/moreverb.zip">macros/latex/contrib/moreverb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/moreverb/">browse the directory</a>) -<dt><tt><i>sverb.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) -<dt><tt><i>verbatim.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>fancyvrb.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyvrb.zip">macros/latex/contrib/fancyvrb</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyvrb/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>moreverb.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/moreverb.zip">macros/latex/contrib/moreverb</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/moreverb/">browse the directory</a>) +<dt><tt><i>sverb.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools.zip">macros/latex/contrib/mdwtools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/mdwtools/">browse the directory</a>) +<dt><tt><i>verbatim.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=verbfile">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=verbfile</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbwithin.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbwithin.html index 772dd0cfbf9..e1c69f4aa87 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbwithin.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-verbwithin.html @@ -1,10 +1,10 @@ <head> <title>UK TeX FAQ -- question label verbwithin</title> </head><body> -<h3>Why doesn’t verbatim work within ...?</h3> +<h3>Why doesn’t verbatim work within …?</h3> <p/>The LaTeX verbatim commands work by changing category codes. Knuth says of this sort of thing “Some care is needed to get the timing -right...”, since once the category code has been assigned to a +right…”, since once the category code has been assigned to a character, it doesn’t change. So <code>\</code><code>verb</code> and <code>\</code><code>begin{verbatim}</code> have to assume that they are getting the first look at the parameter text; if they aren’t, TeX has already @@ -25,7 +25,7 @@ will work (typesetting ‘<code>\</code><code>error</code>’), but will not (it will attempt to execute <code>\</code><code>error</code>). Other errors one may encounter are ‘<code>\</code><code>verb</code> ended by end of line’, or even the rather more helpful ‘<code>\</code><code>verb</code> illegal in command argument’. The -same sorts of thing happen with <code>\</code><code>begin{verbatim}</code> ... +same sorts of thing happen with <code>\</code><code>begin{verbatim}</code> … <code>\</code><code>end{verbatim}</code>: <blockquote> <pre> @@ -121,10 +121,10 @@ necessary?”. Documentation of both <i>url</i> and <i>verbdef</i> is in the package files. <dl> -<dt><tt><i>fancyvrb.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyvrb.zip">macros/latex/contrib/fancyvrb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/fancyvrb/">browse the directory</a>) -<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) -<dt><tt><i>url.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/url.sty">macros/latex/contrib/misc/url.sty</a> -<dt><tt><i>verbdef.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/misc/verbdef.sty">macros/latex/contrib/misc/verbdef.sty</a> +<dt><tt><i>fancyvrb.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyvrb.zip">macros/latex/contrib/fancyvrb</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/fancyvrb/">browse the directory</a>) +<dt><tt><i>memoir.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir.zip">macros/latex/contrib/memoir</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/memoir/">browse the directory</a>) +<dt><tt><i>url.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/url.sty">macros/latex/contrib/misc/url.sty</a> +<dt><tt><i>verbdef.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/misc/verbdef.sty">macros/latex/contrib/misc/verbdef.sty</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=verbwithin">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=verbwithin</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-virtualfonts.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-virtualfonts.html index 2cdef3b90d1..bc36b5a85f3 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-virtualfonts.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-virtualfonts.html @@ -54,10 +54,10 @@ together with the discussion of fonts (it uses TeX to parse a description of the virtual font, and <i>qdtexvpl</i> itself processes the resulting DVI file). <dl> -<dt><tt><i>fontinst</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/fontinst/">browse the directory</a>) -<dt><tt><i>Knuth on virtual fonts</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/knuth/virtual-fonts">info/knuth/virtual-fonts</a> -<dt><tt><i>Virtual fonts “how to”</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/virtualfontshowto/virtualfontshowto.txt">info/virtualfontshowto/virtualfontshowto.txt</a> -<dt><tt><i>qdtexvpl</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/qdtexvpl.zip">fonts/utilities/qdtexvpl</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/fonts/utilities/qdtexvpl/">browse the directory</a>) +<dt><tt><i>fontinst</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst.zip">fonts/utilities/fontinst</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/fontinst/">browse the directory</a>) +<dt><tt><i>Knuth on virtual fonts</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/knuth/virtual-fonts">info/knuth/virtual-fonts</a> +<dt><tt><i>Virtual fonts “how to”</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/virtualfontshowto/virtualfontshowto.txt">info/virtualfontshowto/virtualfontshowto.txt</a> +<dt><tt><i>qdtexvpl</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/qdtexvpl.zip">fonts/utilities/qdtexvpl</a> (or <a href="http://www.tex.ac.uk/tex-archive/fonts/utilities/qdtexvpl/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=virtualfonts">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=virtualfonts</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-watermark.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-watermark.html index f075966cd12..b15be120a2e 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-watermark.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-watermark.html @@ -32,12 +32,12 @@ to do what you like. to a particular page; you therefore need to construct your own apparatus for anything complicated. <dl> -<dt><tt><i>draftcopy.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/draftcopy.zip">macros/latex/contrib/draftcopy</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/draftcopy/">browse the directory</a>) -<dt><tt><i>draftwatermark.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/draftwatermark.zip">macros/latex/contrib/draftwatermark</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/draftwatermark/">browse the directory</a>) -<dt><tt><i>eso-pic.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eso-pic.zip">macros/latex/contrib/eso-pic</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/eso-pic/">browse the directory</a>) -<dt><tt><i>everypage.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/everypage.zip">macros/latex/contrib/everypage</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/everypage/">browse the directory</a>) -<dt><tt><i>everyshi.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ms/">browse the directory</a>) -<dt><tt><i>wallpaper.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/wallpaper.zip">macros/latex/contrib/wallpaper</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/wallpaper/">browse the directory</a>) +<dt><tt><i>draftcopy.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/draftcopy.zip">macros/latex/contrib/draftcopy</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/draftcopy/">browse the directory</a>) +<dt><tt><i>draftwatermark.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/draftwatermark.zip">macros/latex/contrib/draftwatermark</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/draftwatermark/">browse the directory</a>) +<dt><tt><i>eso-pic.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eso-pic.zip">macros/latex/contrib/eso-pic</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/eso-pic/">browse the directory</a>) +<dt><tt><i>everypage.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/everypage.zip">macros/latex/contrib/everypage</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/everypage/">browse the directory</a>) +<dt><tt><i>everyshi.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms.zip">macros/latex/contrib/ms</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ms/">browse the directory</a>) +<dt><tt><i>wallpaper.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/wallpaper.zip">macros/latex/contrib/wallpaper</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/wallpaper/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=watermark">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=watermark</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-webpkgs.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-webpkgs.html index b3c74170e6c..d8636e58596 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-webpkgs.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-webpkgs.html @@ -26,17 +26,17 @@ is written in ANSI C). <p/><i>Tweb</i> is a WEB for Plain TeX macro files, using <i>noweb</i>. <dl> -<dt><tt><i>aplweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/apl/aplweb.zip">web/apl/aplweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/apl/aplweb/">browse the directory</a>) -<dt><tt><i>cweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/c_cpp/cweb.zip">web/c_cpp/cweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/c_cpp/cweb/">browse the directory</a>) -<dt><tt><i>funnelweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/funnelweb.zip">web/funnelweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/funnelweb/">browse the directory</a>) -<dt><tt><i>fweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/fweb.zip">web/fweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/fweb/">browse the directory</a>) -<dt><tt><i>noweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/noweb.zip">web/noweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/noweb/">browse the directory</a>) -<dt><tt><i>nuweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/nuweb.zip">web/nuweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/nuweb/">browse the directory</a>) -<dt><tt><i>schemeweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/schemeweb.zip">web/schemeweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/schemeweb/">browse the directory</a>) -<dt><tt><i>spiderweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/spiderweb.zip">web/spiderweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/spiderweb/">browse the directory</a>) -<dt><tt><i>tangle</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/knuth/dist/web.zip">systems/knuth/dist/web</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/knuth/dist/web/">browse the directory</a>) -<dt><tt><i>tweb</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/tweb.zip">web/tweb</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/web/tweb/">browse the directory</a>) -<dt><tt><i>weave</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/knuth/dist/web.zip">systems/knuth/dist/web</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/systems/knuth/dist/web/">browse the directory</a>) +<dt><tt><i>aplweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/apl/aplweb.zip">web/apl/aplweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/apl/aplweb/">browse the directory</a>) +<dt><tt><i>cweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/c_cpp/cweb.zip">web/c_cpp/cweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/c_cpp/cweb/">browse the directory</a>) +<dt><tt><i>funnelweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/funnelweb.zip">web/funnelweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/funnelweb/">browse the directory</a>) +<dt><tt><i>fweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/fweb.zip">web/fweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/fweb/">browse the directory</a>) +<dt><tt><i>noweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/noweb.zip">web/noweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/noweb/">browse the directory</a>) +<dt><tt><i>nuweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/nuweb.zip">web/nuweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/nuweb/">browse the directory</a>) +<dt><tt><i>schemeweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/schemeweb.zip">web/schemeweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/schemeweb/">browse the directory</a>) +<dt><tt><i>spiderweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/spiderweb.zip">web/spiderweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/spiderweb/">browse the directory</a>) +<dt><tt><i>tangle</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/knuth/dist/web.zip">systems/knuth/dist/web</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/knuth/dist/web/">browse the directory</a>) +<dt><tt><i>tweb</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/web/tweb.zip">web/tweb</a> (or <a href="http://www.tex.ac.uk/tex-archive/web/tweb/">browse the directory</a>) +<dt><tt><i>weave</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/systems/knuth/dist/web.zip">systems/knuth/dist/web</a> (or <a href="http://www.tex.ac.uk/tex-archive/systems/knuth/dist/web/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=webpkgs">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=webpkgs</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-weirdhyphen.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-weirdhyphen.html index fe9630bf071..2902f4ba598 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-weirdhyphen.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-weirdhyphen.html @@ -27,8 +27,8 @@ December 1995 release of LaTeX2e do <em>not</em> use the alternative hyphen character, and therefore removed this source of problems; the solution, again, is to upgrade your LaTeX. <dl> -<dt><tt><i>LaTeX 2.09</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveobsolete/macros/latex209/distribs/latex209.tar.gz">obsolete/macros/latex209/distribs/latex209.tar.gz</a> -<dt><tt><i>plain.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/base.zip">macros/plain/base</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/plain/base/">browse the directory</a>) +<dt><tt><i>LaTeX 2.09</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/obsolete/macros/latex209/distribs/latex209.tar.gz">obsolete/macros/latex209/distribs/latex209.tar.gz</a> +<dt><tt><i>plain.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/plain/base.zip">macros/plain/base</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/plain/base/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=weirdhyphen">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=weirdhyphen</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whatbst.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whatbst.html index 9e2817a6bd1..e32179558f8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whatbst.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whatbst.html @@ -47,9 +47,9 @@ hand using this “standard” bibliography. For style will produce a representative sample of the citations the style will produce. (Because <i>xampl.bib</i> is so extreme in some of its “examples”, the BibTeX run will also give you an interesting -selection of BibTeX’s error messages...) +selection of BibTeX’s error messages…) <dl> -<dt><tt><i>xampl.bib</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivebiblio/bibtex/distribs/doc/xampl.bib">biblio/bibtex/distribs/doc/xampl.bib</a> +<dt><tt><i>xampl.bib</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/biblio/bibtex/distribs/doc/xampl.bib">biblio/bibtex/distribs/doc/xampl.bib</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=whatbst">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=whatbst</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whereFAQ.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whereFAQ.html index dc7a246a4ef..f0c97ef8a1d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whereFAQ.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-whereFAQ.html @@ -51,12 +51,12 @@ ordinary mortals’ use. </dl> <p/>Resources available on CTAN are: <dl> -<dt><tt><i>Dante FAQ</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/de-tex-faq.zip">help/de-tex-faq</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/de-tex-faq/">browse the directory</a>) -<dt><tt><i>French FAQ</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/LaTeX-FAQ-francaise.zip">help/LaTeX-FAQ-francaise</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/LaTeX-FAQ-francaise/">browse the directory</a>) -<dt><tt><i>Sources of this FAQ</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq.zip">help/uk-tex-faq</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq/">browse the directory</a>) +<dt><tt><i>Dante FAQ</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/help/de-tex-faq.zip">help/de-tex-faq</a> (or <a href="http://www.tex.ac.uk/tex-archive/help/de-tex-faq/">browse the directory</a>) +<dt><tt><i>French FAQ</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/help/LaTeX-FAQ-francaise.zip">help/LaTeX-FAQ-francaise</a> (or <a href="http://www.tex.ac.uk/tex-archive/help/LaTeX-FAQ-francaise/">browse the directory</a>) +<dt><tt><i>Sources of this FAQ</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq.zip">help/uk-tex-faq</a> (or <a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq/">browse the directory</a>) <dt><tt><i>Obsolete <code>comp.text.tex</code> FAQ</i></tt><dd> - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveobsolete/help/TeX,_LaTeX,_etc.:_Frequently_Asked_Questions_with_Answers">obsolete/help/TeX,_LaTeX,_etc.:_Frequently_Asked_Questions_with_Answers</a> -<dt><tt><i>The visual FAQ</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archiveinfo/visualFAQ/visualFAQ.pdf">info/visualFAQ/visualFAQ.pdf</a> + <a href="http://www.tex.ac.uk/tex-archive/obsolete/help/TeX,_LaTeX,_etc.:_Frequently_Asked_Questions_with_Answers">obsolete/help/TeX,_LaTeX,_etc.:_Frequently_Asked_Questions_with_Answers</a> +<dt><tt><i>The visual FAQ</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/info/visualFAQ/visualFAQ.pdf">info/visualFAQ/visualFAQ.pdf</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=whereFAQ">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=whereFAQ</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wholerow.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wholerow.html index 20880193f9f..77005140f8a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wholerow.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wholerow.html @@ -44,7 +44,7 @@ The <i>array</i> package works with several other example <code>longtable</code>), but unfortunately this trick won’t always work. <dl> -<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>array.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=wholerow">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=wholerow</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-widefigs.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-widefigs.html index e1fff76feb3..ecc75a165d8 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-widefigs.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-widefigs.html @@ -16,8 +16,8 @@ float environments. You should include them in <code>figure</code> environments or use the <i>float</i> or <i>ccaption</i>package to define a new float type. <dl> -<dt><tt><i>ccaption.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccaption.zip">macros/latex/contrib/ccaption</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/ccaption/">browse the directory</a>) -<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/float/">browse the directory</a>) +<dt><tt><i>ccaption.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccaption.zip">macros/latex/contrib/ccaption</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/ccaption/">browse the directory</a>) +<dt><tt><i>float.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float.zip">macros/latex/contrib/float</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/float/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=widefigs">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=widefigs</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wordcount.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wordcount.html index 16bd4cdafbf..0087b886837 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wordcount.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-wordcount.html @@ -15,7 +15,7 @@ displays of various sorts, this number will probably not be an integer); multiply the two. However, if the document to be submitted is to determine the success of the rest of one’s life, it takes a brave person to thumb their nose at authority quite so -comprehensively... +comprehensively… <p/>The simplest method is to strip out the (La)TeX markup, and to count what’s left. On a Unix-like system, this may be done using <i>detex</i> and the built-in <i>wc</i>: @@ -40,10 +40,10 @@ LaTeX file with a special piece of supporting TeX code, and then counting word indications in the log file. This is probably as accurate automatic counting as you can get, if it works for you. <dl> -<dt><tt><i>detex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/detex.zip">support/detex</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/detex/">browse the directory</a>) -<dt><tt><i>latexcount.pl</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivesupport/latexcount/latexcount.pl">support/latexcount/latexcount.pl</a> -<dt><tt><i>TeXcount</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/texcount.zip">support/texcount</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/support/texcount/">browse the directory</a>) -<dt><tt><i>wordcount</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/wordcount.zip">macros/latex/contrib/wordcount</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/contrib/wordcount/">browse the directory</a>) +<dt><tt><i>detex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/detex.zip">support/detex</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/detex/">browse the directory</a>) +<dt><tt><i>latexcount.pl</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/latexcount/latexcount.pl">support/latexcount/latexcount.pl</a> +<dt><tt><i>TeXcount</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/texcount.zip">support/texcount</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/texcount/">browse the directory</a>) +<dt><tt><i>wordcount</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/wordcount.zip">macros/latex/contrib/wordcount</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/wordcount/">browse the directory</a>) </dl> <p/> <p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=wordcount">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=wordcount</a> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-writecls.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-writecls.html index 6f25dd17fb9..f709a5c325c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-writecls.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-writecls.html @@ -36,12 +36,12 @@ as it appears in <i>classes.dtx</i>, was published in <i>TUGboat</i> 28(1). The article, by Peter Flynn, which is some help in understanding <i>classes.dtx</i> <dl> -<dt><tt><i>classes.dtx</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/base/classes.dtx">macros/latex/base/classes.dtx</a> -<dt><tt><i>clsguide.pdf</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/doc/clsguide.pdf">macros/latex/doc/clsguide.pdf</a> -<dt><tt><i>latex-tds collection</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/contrib/latex-tds/">macros/latex/contrib/latex-tds/</a> -<dt><tt><i>ltxguide.cls</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/base/ltxguide.cls">macros/latex/base/ltxguide.cls</a> -<dt><tt><i>LaTeX documentation</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/doc.zip">macros/latex/doc</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/doc/">browse the directory</a>) -<dt><tt><i>source2e.tex</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivemacros/latex/base/source2e.tex">macros/latex/base/source2e.tex</a> +<dt><tt><i>classes.dtx</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/classes.dtx">macros/latex/base/classes.dtx</a> +<dt><tt><i>clsguide.pdf</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/doc/clsguide.pdf">macros/latex/doc/clsguide.pdf</a> +<dt><tt><i>latex-tds collection</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/latex-tds/">macros/latex/contrib/latex-tds/</a> +<dt><tt><i>ltxguide.cls</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/ltxguide.cls">macros/latex/base/ltxguide.cls</a> +<dt><tt><i>LaTeX documentation</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/doc.zip">macros/latex/doc</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/doc/">browse the directory</a>) +<dt><tt><i>source2e.tex</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/base/source2e.tex">macros/latex/base/source2e.tex</a> </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=writecls">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=writecls</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-figetc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-xfigetc.html index ba201ccb0f1..e56861e665f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-figetc.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-xfigetc.html @@ -1,8 +1,8 @@ <head> -<title>UK TeX FAQ -- question label figetc</title> +<title>UK TeX FAQ -- question label xfigetc</title> </head><body> <h3>(La)TeX-friendly drawing packages</h3> -<p/><p/><i>(X)Fig</i> is a menu driven tool that allows you to +<p/><p/><p/><i>(X)Fig</i> is a menu driven tool that allows you to draw objects on the screen of an X workstation; <i>transfig</i> is a set of tools which translate the code <i>fig</i>. The list of export formats is very long, and includes Metafont and MetaPost, @@ -11,7 +11,9 @@ a graphics format in a LaTeX import file, which may include LaTeX commands to place text (compiled by LaTeX itself) as labels, etc., in the figures. <p/>There’s no explicit port of <i>xfig</i> to windows (although it is -believed to work under <i>cygwin</i> with their X-windows system). +said to work under <i>cygwin</i> with their X-windows system — +<a href="http://www.cs.usask.ca/~wew036/latex/xfig.html">installation advice</a> +is available). However, the program <a href="http://tech-www.informatik.uni-hamburg.de/applets/javafig/"><i>jfig</a></i> is thought by many to be an acceptable substitute, written in Java. @@ -20,9 +22,9 @@ language, which can draw 2D or 3D diagrams, and can also label diagrams with LaTeX text; copious documentation is available via <a href="http://asymptote.sourceforge.net"><i>asymptote</a>’s web site</i>. <dl> -<dt><tt><i>asymptote</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/asymptote.zip">graphics/asymptote</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/asymptote/">browse the directory</a>) -<dt><tt><i>xfig</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archivegraphics/xfig/">graphics/xfig/</a> -<dt><tt><i>transfig</i></tt><dd><a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/transfig.zip">graphics/transfig</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/graphics/transfig/">browse the directory</a>) +<dt><tt><i>asymptote</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/asymptote.zip">graphics/asymptote</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/asymptote/">browse the directory</a>) +<dt><tt><i>xfig</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/xfig/">graphics/xfig/</a> +<dt><tt><i>transfig</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/graphics/transfig.zip">graphics/transfig</a> (or <a href="http://www.tex.ac.uk/tex-archive/graphics/transfig/">browse the directory</a>) </dl> -<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figetc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figetc</a> +<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=xfigetc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=xfigetc</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-xspace.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-xspace.html index 60b55022c76..cb6d878c84a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-xspace.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-xspace.html @@ -50,7 +50,7 @@ which can be confusing, notably to a collaborating author don’t). Of course, no command built into LaTeX or into any “standard” class or package will use <code>\</code><code>xspace</code>. <dl> -<dt><tt><i>xspace.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/macros/latex/required/tools/">browse the directory</a>) +<dt><tt><i>xspace.sty</i></tt><dd>Distributed as part of <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools.zip">macros/latex/required/tools</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/required/tools/">browse the directory</a>) </dl> <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=xspace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=xspace</a> </body> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-zerochap.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-zerochap.html index a8fd0ecdc70..515140827cb 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-zerochap.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-zerochap.html @@ -1,7 +1,7 @@ <head> <title>UK TeX FAQ -- question label zerochap</title> </head><body> -<h3>Why are my sections numbered 0.1 ...?</h3> +<h3>Why are my sections numbered 0.1 …?</h3> <p/>This happens when your document is using the standard <i>book</i> or <i>report</i> class (or one similar), and you’ve got a <code>\</code><code>section</code> before your first <code>\</code><code>chapter</code>. diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/index.html b/Master/texmf-dist/doc/generic/FAQ-en/html/index.html index f74c52a4561..d5178ff1e30 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/index.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/index.html @@ -16,13 +16,13 @@ covered from the viewpoint of a LaTeX user. <li> by reading a printed document, <li> by viewing a PDF file, with hyperlinks to assist browsing: copies are available formatted for printing on - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq/newfaq.pdf">A4 paper</a> or on - <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/help/uk-tex-faq/letterfaq.pdf">North American “letter” paper</a>, or + <a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq/newfaq.pdf">A4 paper</a> or on + <a href="http://www.tex.ac.uk/tex-archive/help/uk-tex-faq/letterfaq.pdf">North American “letter” paper</a>, or <li> by using the FAQ’s web interface (base URL: <a href="http://www.tex.ac.uk/faq">http://www.tex.ac.uk/faq</a>); this version provides simple search capabilities, as well as a link to Google for a more sophisticated search restricted to the FAQ itself, or -<li> via Scott Pakin’s <a href="http://www.tex.ac.uk/www.tex.ac.uk tex-archive/info/visualFAQ/visualFAQ.pdf">Visual FAQ</a>. +<li> via Scott Pakin’s <a href="http://www.tex.ac.uk/tex-archive/info/visualFAQ/visualFAQ.pdf">Visual FAQ</a>. </ul> <p/> <p/>Unless otherwise specified, all files mentioned in this FAQ @@ -175,7 +175,7 @@ Reinhard Zierke. <li><a href="FAQ-writecls.html">Learning to write LaTeX classes and packages</a> <li><a href="FAQ-mfptutorials.html">Metafont and MetaPost Tutorials</a> <li><a href="FAQ-BibTeXing.html">BibTeX Documentation</a> -<li><a href="FAQ-symbols.html">Where can I find the symbol for ...</a> +<li><a href="FAQ-symbols.html">Where can I find the symbol for …</a> <li><a href="FAQ-docpictex.html">The PicTeX manual</a> </ul><h3>Bits and pieces of (La)TeX</h3><ul> <li><a href="FAQ-dvi.html">What is a DVI file?</a> @@ -214,7 +214,7 @@ Reinhard Zierke. <li><a href="FAQ-previewers.html">DVI previewers</a> <li><a href="FAQ-dvi-bmp.html">Generating bitmaps from DVI</a> </ul><h3>Support Packages for TeX</h3><ul> -<li><a href="FAQ-figetc.html">(La)TeX-friendly drawing packages</a> +<li><a href="FAQ-xfigetc.html">(La)TeX-friendly drawing packages</a> <li><a href="FAQ-texcad.html">TeXCAD, a drawing package for LaTeX</a> <li><a href="FAQ-spell.html">Spelling checkers for work with TeX</a> <li><a href="FAQ-wordcount.html">How many words have you written?</a> @@ -246,9 +246,9 @@ Reinhard Zierke. <li><a href="FAQ-instfont.html">Installing a new font</a> <li><a href="FAQ-instmffont.html">Installing a font provided as Metafont source</a> <li><a href="FAQ-instprinterfont.html">Installing a PostScript printer built-in font</a> -<li><a href="FAQ-inst1cm.html">Installing the Bluesky versions of the CM fonts</a> <li><a href="FAQ-prept1font.html">Preparing a Type 1 font</a> <li><a href="FAQ-instt1font.html">Installing a Type 1 font</a> +<li><a href="FAQ-inst1cm.html">Installing the Type 1 versions of the CM fonts</a> </ul><h3>Fonts</h3><ul> </ul><h4>Metafont fonts</h4><ul> <li><a href="FAQ-useMF.html">Getting Metafont to do what you want</a> @@ -279,7 +279,7 @@ Reinhard Zierke. <li><a href="FAQ-pdfpagelabels.html"><i>Hyperref</i> and repeated page numbers</a> <li><a href="FAQ-srchpdf.html">Searching PDF files</a> </ul><h3>Graphics</h3><ul> -<li><a href="FAQ-impgraph.html">How to import graphics into (La)TeX documents</a> +<li><a href="FAQ-impgraph.html">Importing graphics into (La)TeX documents</a> <li><a href="FAQ-dvipsgraphics.html">Imported graphics in <i>dvips</i></a> <li><a href="FAQ-pdftexgraphics.html">Imported graphics in PDFLaTeX</a> <li><a href="FAQ-dvipdfmgraphics.html">Imported graphics in <i>dvipdfm</i></a> @@ -358,7 +358,6 @@ Reinhard Zierke. <li><a href="FAQ-marginmanual.html">How to set up page layout “by hand”</a> <li><a href="FAQ-chngmargonfly.html">Changing margins “on the fly”</a> <li><a href="FAQ-nopageno.html">How to get rid of page numbers</a> -<li><a href="FAQ-psatempty.html"><code>\pagestyle{empty}</code> on first page in LaTeX</a> <li><a href="FAQ-crop.html">How to create crop marks</a> <li><a href="FAQ-watermark.html">‘Watermarks’ on every page</a> <li><a href="FAQ-landscape.html">Typesetting things in landscape orientation</a> @@ -396,7 +395,7 @@ Reinhard Zierke. </ul><h4>Labels and references</h4><ul> <li><a href="FAQ-nameref.html">Referring to things by their name</a> <li><a href="FAQ-extref.html">Referring to labels in other documents</a> -</ul><h3>How do I do...?</h3><ul> +</ul><h3>How do I do…?</h3><ul> </ul><h4>Mathematics</h4><ul> <li><a href="FAQ-proof.html">Proof environment</a> <li><a href="FAQ-theoremfmt.html">Theorem bodies printed in a roman font</a> @@ -422,7 +421,7 @@ Reinhard Zierke. <li><a href="FAQ-longtab.html">Tables longer than a single page</a> <li><a href="FAQ-tabcellalign.html">How to alter the alignment of tabular cells</a> <li><a href="FAQ-rulethk.html">The thickness of rules in LaTeX tables</a> -<li><a href="FAQ-textflow.html">Flowing text around figures in LaTeX</a> +<li><a href="FAQ-textflow.html">Flowing text around figures</a> <li><a href="FAQ-slashbox.html">Diagonal separation in corner cells of tables</a> <li><a href="FAQ-wholerow.html">How to change a whole row of a table</a> <li><a href="FAQ-multirow.html">Merging cells in a column of a table</a> @@ -520,7 +519,7 @@ Reinhard Zierke. <li><a href="FAQ-addtoreset.html">Master and slave counters</a> <li><a href="FAQ-fontsize.html">Fonts at arbitrary sizes</a> <li><a href="FAQ-latexqual.html">The quality of your LaTeX</a> -</ul><h3>Things are Going Wrong...</h3><ul> +</ul><h3>Things are Going Wrong…</h3><ul> </ul><h4>Getting things to fit</h4><ul> <li><a href="FAQ-enlarge.html">Enlarging TeX</a> <li><a href="FAQ-usepictex.html">Why can’t I load PicTeX?</a> @@ -537,12 +536,12 @@ Reinhard Zierke. </ul><h4>Common errors</h4><ul> <li><a href="FAQ-crossref.html">LaTeX gets cross-references wrong</a> <li><a href="FAQ-newlineargs.html">Start of line goes awry</a> -<li><a href="FAQ-verbwithin.html">Why doesn’t verbatim work within ...?</a> +<li><a href="FAQ-verbwithin.html">Why doesn’t verbatim work within …?</a> <li><a href="FAQ-noline.html">No line here to end</a> <li><a href="FAQ-2colfltorder.html">Two-column float numbers out of order</a> <li><a href="FAQ-tabacc.html">Accents misbehave in <code>tabbing</code></a> <li><a href="FAQ-alreadydef.html">Package reports “command already defined”</a> -<li><a href="FAQ-zerochap.html">Why are my sections numbered 0.1 ...?</a> +<li><a href="FAQ-zerochap.html">Why are my sections numbered 0.1 …?</a> <li><a href="FAQ-breaklinks.html">Link text doesn’t break at end line</a> <li><a href="FAQ-wrongpn.html">Page number is wrong at start of page</a> <li><a href="FAQ-matchbrak.html">My brackets don’t match</a> @@ -566,14 +565,14 @@ Reinhard Zierke. <li><a href="FAQ-t1enc.html">Why use <i>fontenc</i> rather than <i>t1enc</i>?</a> <li><a href="FAQ-why-inp-font.html">Why bother with <i>inputenc</i> and <i>fontenc</i>?</a> <li><a href="FAQ-eqnarray.html">Why not use <code>eqnarray</code>?</a> -<li><a href="FAQ-dolldoll.html">Why use <code>\</code><code>[</code> ...<code>\</code><code>]</code> in place of <code>$$</code> ...<code>$$</code>?</a> +<li><a href="FAQ-dolldoll.html">Why use <code>\</code><code>[</code> …<code>\</code><code>]</code> in place of <code>$$</code> …<code>$$</code>?</a> <li><a href="FAQ-2letterfontcmd.html">What’s wrong with <code>\</code><code>bf</code>, <code>\</code><code>it</code>, etc.?</a> <li><a href="FAQ-newfontstar.html">What’s wrong with <code>\</code><code>newfont</code>?</a> </ul><h3>The joy of TeX errors</h3><ul> <li><a href="FAQ-erroradvice.html">How to approach errors</a> <li><a href="FAQ-errstruct.html">The structure of TeX error messages</a> <li><a href="FAQ-extrabrace.html">An extra ‘<code>}</code>’??</a> -<li><a href="FAQ-semanticnest.html">Capacity exceeded [semantic nest ...]</a> +<li><a href="FAQ-semanticnest.html">Capacity exceeded [semantic nest …]</a> <li><a href="FAQ-noroom.html">No room for a new ‘<em>thing</em>’</a> <li><a href="FAQ-epsf.html"><code>epsf</code> gives up after a bit</a> <li><a href="FAQ-badhyph.html">Improper <code>\</code><code>hyphenation</code> will be flushed</a> @@ -584,14 +583,14 @@ Reinhard Zierke. <li><a href="FAQ-typend.html">“Please type a command or say <code>\</code><code>end</code>”</a> <li><a href="FAQ-unkgrfextn.html">“Unknown graphics extension”</a> <li><a href="FAQ-nodollar.html">“Missing <code>$</code> inserted”</a> -<li><a href="FAQ-fontunavail.html">Warning: “Font shape ... not available”</a> +<li><a href="FAQ-fontunavail.html">Warning: “Font shape … not available”</a> <li><a href="FAQ-buffovl.html">Unable to read an entire line</a> <li><a href="FAQ-formatstymy.html">“Fatal format file error; I’m stymied”</a> <li><a href="FAQ-nonpdfsp.html">Non-PDF special ignored!</a> <li><a href="FAQ-8000.html">Mismatched mode ljfour and resolution 8000</a> <li><a href="FAQ-toodeep.html">“Too deeply nested”</a> <li><a href="FAQ-inputlev.html">Capacity exceeded — input levels</a> -<li><a href="FAQ-hyperdupdest.html">PDFTeX destination ... ignored</a> +<li><a href="FAQ-hyperdupdest.html">PDFTeX destination … ignored</a> <li><a href="FAQ-altabcr.html">Alignment tab changed to <code>\</code><code>cr</code></a> <li><a href="FAQ-divzero.html">Graphics division by zero</a> <li><a href="FAQ-missbegdoc.html">Missing <code>\</code><code>begin</code><code>{document}</code></a> @@ -629,6 +628,6 @@ Reinhard Zierke. "<a href="FAQ-noans.html">Improving the FAQ</a>" or "<a href="FAQ-newans.html">Extending the FAQ</a>". <p> - This is FAQ version 3.19, last modified on 2009-06-10. + This is FAQ version 3.19a, last modified on 2009-06-13. </address> </body></html> diff --git a/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf b/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf Binary files differindex 10c73a57d33..d369299355c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf +++ b/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf diff --git a/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.tex b/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.tex index 12d0da7b8a3..dd0b4427d72 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.tex @@ -6,7 +6,7 @@ % % read the first two definitions of faqbody.tex for the file version % and date -\afterassignment\endinput\input faqbody +\afterassignment\endinput\input gather-faqbody % \typeout{The UK TeX FAQ, v\faqfileversion, date \faqfiledate} % @@ -53,10 +53,10 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \ifsinglecolumn - \input{faqbody} + \input{gather-faqbody} \else \begin{multicols}{2} - \input{faqbody} + \input{gather-faqbody} \end{multicols} \fi diff --git a/Master/texmf-dist/doc/generic/FAQ-en/logotst.tex b/Master/texmf-dist/doc/generic/FAQ-en/logotst.tex deleted file mode 100644 index 5ac611a8623..00000000000 --- a/Master/texmf-dist/doc/generic/FAQ-en/logotst.tex +++ /dev/null @@ -1,84 +0,0 @@ -\documentclass{ukart} -\setcounter{errorcontextlines}{999} -\makeatletter -% -% Twee, in its wisdom, has a redefined LaTeX logo -% -%\DeclareRobustCommand{\LaTeX}{L\kern-.36em -% {\setbox0\hbox{T}% -% \vbox to\ht0{\hbox{$\m@th$% -% \csname S@\f@size\endcsname -% \fontsize\sf@size\z@ -% \math@fontsfalse\selectfont -% A}% -% \vss}% -% }% -% \kern-.15em -% \TeX} -% -% which sets the A in scripstyle jammed up to the top of the T; it -% also has the advantage that it's set in the same font as the -% surrounding text. However, the esteemed bbeeton says the logo looks -% "squidge awful" in italic text (I agree; and the same is true of its -% behaviour in slanted text) -% -% So here's a version that allows for the italic slant of the leading L -\DeclareRobustCommand{\latex}{L% - {\setbox0\hbox{T}% - \setbox\@tempboxa\hbox{$\m@th$% - \csname S@\f@size\endcsname - \fontsize\sf@size\z@ - \math@fontsfalse\selectfont - A}% - \@tempdima\ht0 - \advance\@tempdima-\ht\@tempboxa - \@tempdima\strip@pt\fontdimen1\font\@tempdima - \advance\@tempdima-.36em - \kern\@tempdima - \vbox to\ht0{\box\@tempboxa - \vss}% - }% - \kern-.15em - \TeX} -% -% of course, we could modify this not to do all those awful sums when -% the font isn't slanted, but (perhaps) this isn't today's -% problem\dots -% -% Now for a few demonstrations of the effect achieved -\begin{document} -Demo with the modification of the current \LaTeX{} logo - -\begin{center} -\LARGE\begin{tabular}{l|ccc} -&\normalsize\sf roman&\normalsize\sf italic&\normalsize\sf slanted\\ -\hline -\normalsize\sf old & \LaTeX & \textit{\LaTeX} & \textsl{\LaTeX} \\ -\normalsize\sf new & \latex & \textit{\latex} & \textsl{\latex} \\ -\end{tabular} -\end{center} -% -% Here's something that does it with the `original' (Lamport's) -% definition. -% -% (In fact this is a bit of a cheat, since the last 2.09 had -% \reset@font\rm at the start, and of course, it got defined as a -% protected command in the LaTeX 2.09 fashion, but what the hell, eh?) -\def\LaTeX{L\kern-.36em\raise.3ex\hbox{\textsc{a}}\kern-.15em\TeX}% -\def\latex{\@tempdima.3ex - \@tempdima\strip@pt\fontdimen1\font\@tempdima - \advance\@tempdima-0.36em\relax - L\kern\@tempdima\raise.3ex\hbox{\textsc{a}}\kern-.15em\TeX}% -% -% and a demo of that -\par\noindent Demo with the modification of the original \LaTeX{} logo - -\begin{center} -\LARGE\begin{tabular}{l|ccc} -&\normalsize\sf roman&\normalsize\sf italic&\normalsize\sf slanted\\ -\hline -\normalsize\sf old & \LaTeX & \textit{\LaTeX} & \textsl{\LaTeX} \\ -\normalsize\sf new & \latex & \textit{\latex} & \textsl{\latex} \\ -\end{tabular} -\end{center} -\end{document} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/markup-syntax b/Master/texmf-dist/doc/generic/FAQ-en/markup-syntax index 087f32fd945..dc221b47e8a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/markup-syntax +++ b/Master/texmf-dist/doc/generic/FAQ-en/markup-syntax @@ -21,12 +21,8 @@ Rules for presentation of text - even if you prefer \TeX\ to ensure the name's delimited - even if the name's immediately followed by punctuation -3. Don't change the shortvrb character from `|'; it interacts with - other definitions. - -4. Avoid shortvrb syntax, anyway ... most common uses are now covered - by specific macros; if a need arises, more such macros can be - developed, rather than using shortvrb. +3. Don't use \verb or \shortvrb -- find alternatives in other + constructions like \csx, \cmdinvoke, etc. Rules for managing the text --------------------------- @@ -140,15 +136,18 @@ Environment dviversion (DVI output only) Environment pdfversion (PDF output only) Environment narrowversion (DVI output only -- narrow since 2-col output) Environment wideversion (HTML or PDF output only) + Note that we use narrow for non-hyper, and wide for hyper versions + of the source. + +\htmlonly{text} +\narrowonly{text} +\wideonly{text} + These three are command versions of the corresponding environments \nothtml{text} Text not to appear in the HTML version -\htmlonly{text} - - Text only to appear (after processing) in the HTML version - \latexhtml{latex text}{HTML text} Typesets latex text, or processes HTML text, according to context @@ -176,6 +175,10 @@ Environment wideversion (HTML or PDF output only) Records when an answer (or part of an answer) was checked, and by whom. Currently typsets as nothing. +\LastEdit{date} + + Date of last editing a Question; argument is yyyy-mm-dd (ISO form) + \keywords{<stuff>} For labelling questions. Doesn't currently have any effect at all. @@ -194,8 +197,8 @@ Environment wideversion (HTML or PDF output only) versions of the FAQ; \Email is for formatting a name (e.g., a finger identifier) that the reader is _not_ supposed to mail. -\Package{ackage name}(no .sty) -\Class{lass name} (no .cls) +\Package{package name}(no .sty) +\Class{class name} (no .cls) \ProgName{executable command name} Set the item in an appropriate fashion. _Please_ use these commands @@ -226,4 +229,4 @@ Other odds and ends: $\pi$, $...$, \$, \#, \ , \&, ~ [just produces a space] Robin Fairbairns -23 Oct 94 +2009-06-13 diff --git a/Master/texmf-dist/doc/generic/FAQ-en/mflogo.sty b/Master/texmf-dist/doc/generic/FAQ-en/mflogo.sty deleted file mode 100644 index f3f8ca02f40..00000000000 --- a/Master/texmf-dist/doc/generic/FAQ-en/mflogo.sty +++ /dev/null @@ -1,31 +0,0 @@ -%% -%% This is file `mflogo.sty', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% mflogo.dtx (with options: `package') -%% -%% Copyright (C) 1994,95 Ulrik Vieth -%% All rights reserved. -%% -%% This file is part of the mflogo package. -%% ---------------------------------------- -%% -%% This is a generated file. Permission is granted to customize the -%% declarations in this file to serve the needs of your installation. -%% However, no permission is granted to distribute a modified version -%% of this file under its original name. -%% -\NeedsTeXFormat{LaTeX2e}[1994/06/01] -\ProvidesPackage{mflogo} - [1995/12/04 v1.5c LaTeX package for METAFONT and MetaPost logos] -\DeclareRobustCommand\logofamily{% - \not@math@alphabet\logofamily\relax - \fontencoding{U}\fontfamily{logo}\selectfont} -\DeclareTextFontCommand{\textlogo}{\logofamily} -\def\MF{\textlogo{META}\@dischyph\textlogo{FONT}\@} -\def\MP{\textlogo{META}\@dischyph\textlogo{POST}\@} -\endinput -%% -%% End of file `mflogo.sty'. diff --git a/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf b/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf Binary files differindex c088527fe80..3b382429c8a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf +++ b/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf diff --git a/Master/texmf-dist/doc/generic/FAQ-en/newfaq.tex b/Master/texmf-dist/doc/generic/FAQ-en/newfaq.tex index a7e20206566..70286d5d135 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/newfaq.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/newfaq.tex @@ -6,7 +6,7 @@ % % read the first two definitions of faqbody.tex for the file version % and date -\afterassignment\endinput\input faqbody +\afterassignment\endinput\input gather-faqbody % \typeout{The UK TeX FAQ, v\faqfileversion, date \faqfiledate} % @@ -53,10 +53,10 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \ifsinglecolumn - \input{faqbody} + \input{gather-faqbody} \else \begin{multicols}{2} - \input{faqbody} + \input{gather-faqbody} \end{multicols} \fi diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds index e3ad0b46e25..433530d1f07 100755 --- a/Master/tlpkg/libexec/ctan2tds +++ b/Master/tlpkg/libexec/ctan2tds @@ -563,6 +563,7 @@ chdir $startdir || die "chdir($startdir) failed: $!"; # back to raw 'ucs', "&MAKEucs", 'uebungsblatt',"&MAKEflatten", 'uk-faq', "die 'skipping, use FAQ-en'", + 'uk-tex-faq', "die 'skipping, use FAQ-en'", 'ukrhyph', "&MAKEukrhyph", 'umrand', "die 'skipping, nonfree'", 'unitsdef', "&MAKEflatten", |