From 6f714441a5f4ecd5bc220e2f50cc98472bc079d0 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Wed, 2 Nov 2011 22:51:17 +0000 Subject: uk-tex-faq 3.24 (1nov11) git-svn-id: svn://tug.org/texlive/trunk@24465 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.24 | 41 ++ Master/texmf-dist/doc/generic/FAQ-en/ChangeLog | 209 ++++++++++ .../texmf-dist/doc/generic/FAQ-en/FAQ-html.tar.gz | Bin 434089 -> 438929 bytes Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex | 21 +- .../doc/generic/FAQ-en/faq-adj-types.tex | 159 ++++---- .../texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex | 133 ++++-- .../doc/generic/FAQ-en/faq-bits+pieces.tex | 453 ++++++++++----------- Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex | 95 +++-- Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex | 26 +- .../texmf-dist/doc/generic/FAQ-en/faq-jot-err.tex | 182 +++++++-- .../texmf-dist/doc/generic/FAQ-en/faq-mac-prog.tex | 109 ++++- .../texmf-dist/doc/generic/FAQ-en/faq-projects.tex | 70 +++- .../texmf-dist/doc/generic/FAQ-en/faq-support.tex | 26 +- .../texmf-dist/doc/generic/FAQ-en/faq-t-g-wr.tex | 5 +- .../texmf-dist/doc/generic/FAQ-en/faq-texsys.tex | 16 +- .../texmf-dist/doc/generic/FAQ-en/faq-the-end.tex | 107 +++-- Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex | 16 +- Master/texmf-dist/doc/generic/FAQ-en/faq.sty | 3 +- Master/texmf-dist/doc/generic/FAQ-en/filectan.tex | 6 +- .../doc/generic/FAQ-en/gather-faqbody.tex | 2 +- Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf | Bin 3844648 -> 3884390 bytes Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf | Bin 3749127 -> 3787926 bytes 22 files changed, 1156 insertions(+), 523 deletions(-) create mode 100644 Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.24 diff --git a/Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.24 b/Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.24 new file mode 100644 index 00000000000..9217a662a4a --- /dev/null +++ b/Master/texmf-dist/doc/generic/FAQ-en/CHANGES-3.24 @@ -0,0 +1,41 @@ +Changes since version 3.23 + +New answers: + +Label labelcount: use the "value" of a label in counter operations + +Label optclash: LaTeX package options clash + +Label printvar: print the contents of a "variable" + +Label unicode: "Unicode for TeX users" + +Relabelled answers: + + +Revised answers: + +Label bug: reworded in the light of more on-line help available + +Label dvi: tidied, mention of XeTeX and its XDV format + +Label ECfonts: brought up to date (a bit: more remains to be done) + +Label editors: updated comments about TeXworks + +Label include: clarification of page number constraint + +Label LaTeX3: add git repository link, mention state of formats + +Label latex-books: add "LaTeX Beginner's Guide" and Herbert Voss's UIT books + +Label mathml: outline the use of MathJax + +Label missbegdoc: rewritten to take account of the BOM issue + +Label multind: add amsmind and imakeidx packages + +Label music: reflect restructuring of fonts + +Label sysmac: mention root privilege requirement for MacTeX + +Label sysother: discourage any hope of a current VMS version + +Label tds: toned-down and untangled the text, a bit + +Label texthings: mention ProTeXt among distributions + +Label TUG* corrected contact details + +Label tutbitslatex: revise statement about Herbert Voss's mathmode book + incorporate para about TUG India tutorials from doc-dirs + +Label underline: remove obsolete statement about ulem docs + +Label virtualfonts: rewrite, improving clarity (I hope...) + +Label wordcount: add health warnings for detex-like counts + +Deleted answers: + +Label doc-dirs: subsumed in label tutbitslatex + +Web interface, etc.: + + +Robin Fairbairns diff --git a/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog b/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog index 568630f16fc..c3dd610d1b6 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog +++ b/Master/texmf-dist/doc/generic/FAQ-en/ChangeLog @@ -1,5 +1,214 @@ + *** release 3.24 *** + +2011-11-01 Robin Fairbairns + + * sanitize.pl (sanitize_line): add \FontFormat (from -beta) + + * gather-faqbody.tex: today (had hoped to release yesterday) + + * faq-adj-types.tex (q-music): more tweaking + +2011-10-31 Robin Fairbairns + + * faq-adj-types.tex (q-music): changes for musixtex-fonts, lots of + tweaking following advice from bob tennent + + * gather-faqbody.tex: v3.24, today + +2011-10-29 Robin Fairbairns + + * faq-support.tex (q-wordcount): add provisos about detex-like routes + + * faq-jot-err.tex (q-missbegdoc): restore a bit that got dropped + +2011-10-28 Robin Fairbairns + + * faq-the-end.tex (q-bug): reword advice on on-line help + (q-latexbug): moved _after_ q-bug + +2011-10-27 Robin Fairbairns + + * faq-jot-err.tex (q-missbegdoc): rewritten to include the bom issue + (taking the text of q-missing-begin) + +2011-10-26 Robin Fairbairns + + * add-general.tex (q-missing-begin): new answer + +2011-10-25 Robin Fairbairns + + * faq-bits+pieces.tex (q-unicode): new, from add-general (slight edits) + +2011-10-25 Robin Fairbairns + + * faq-bits+pieces.tex (q-tds): tone down some of the wilder claims + + * faq.sty: add \FontFormat + + * sanitize-beta.pl: add \FontFormat + + * dirctan.tex: add cm-unicode + + * faq-bits+pieces.tex (q-ecfonts): lots of edits (from work in kent) + +2011-10-20 Robin Fairbairns + + * faq-docs.tex (q-tex-books): clarifying edit ... of a comment ;-) + +2011-10-17 Robin Fairbairns + + * faq-projects.tex (q-mathml): mathtex rather than mimetex in sample! + +2011-10-17 Robin Fairbairns + + * faq-projects.tex (q-mathml): add stuff about MathJax + +2011-10-16 Robin Fairbairns + + * dirctan.tex: correct dvistd, marvosym-fonts + + * filectan.tex: remove varwidth, version + + * dirctan.tex: add varwidth, version + +2011-10-15 Robin Fairbairns + + * faq-bits+pieces.tex (q-specials,q-write): minor editorial + +2011-10-14 Robin Fairbairns + + * faq-t-g-wr.tex (q-underline): remove statement about ulem docs + (saying there's no "real" docs, now false) + +2011-10-12 Robin Fairbairns + + * faq-bits+pieces.tex (q-whatmacros): another challenging bit of + clarification (hem hem) + +2011-10-12 Robin Fairbairns + + * faq-bits+pieces.tex (q-virtualfonts): rearrange and clarify + + * faq-intro.tex: added david epstein to the grand list + + * faq-adj-types.tex (q-algorithms): minor tidy, add comment about + algorithmicx (as requested by David Epstein) + +2011-10-10 Robin Fairbairns + + * faq-bits+pieces.tex (q-driver,q-pk): tidied + (q-tfm): minor editorial + + * dirctan.tex: add dvistd + + * faq-bits+pieces.tex (q-dvi): tidy, mention xetex, ref dvistd + +2011-10-06 Robin Fairbairns + + * faq-intro.tex: editorial + +2011-10-06 Robin Fairbairns + + * faq-jot-err.tex (q-optclash): new, from add-general + + * add-general.tex (q-inputenc): further iterations towards an answer + +2011-10-05 Robin Fairbairns + + * faq-texsys.tex (q-sysmac): mention root requirement for installing + mactex + (q-sysother): hedge statements about vms tex + +2011-10-05 Robin Fairbairns + + * dirctan.tex: add enctex + + * faq-intro.tex: talk about the way the set of answers changes + + * faq-wdidt.tex (q-include): clarify page number constraints + +2011-10-04 Robin Fairbairns + + * faq-projects.tex (q-latex3): rehash stuff about acquiring the + sources, add comments about using l3 as a format + +2011-09-30 Robin Fairbairns + + * add-general.tex (q-fontfmt): typo + +2011-09-29 Robin Fairbairns + + * add-general.tex (q-fontfmt): draft replacement for q-adobetypen + +2011-09-26 Robin Fairbairns + + * faq-docs.tex (q-tutorials*): remove link to q-docdirs + + * faq-backgrnd.tex (q-texthings): remove link to q-docdirs + +2011-09-22 Robin Fairbairns + + * dirctan.tex: add tex-overview, remove texline, unstar mimetex + + * faq-backgrnd.tex (q-texthings): add protext to discussion of distrs, + link to ctan copy of tex-overview + +2011-09-21 Robin Fairbairns + + * faq-texsys.tex (q-editors): revise text on texworks + +2011-09-19 Robin Fairbairns + + * faq-backgrnd.tex (q-tug*): contact via web, only; all back tugboat + +2011-09-12 Robin Fairbairns + + * faq-docs.tex (q-tutbitslatex): removed "specialised" from title, add + old q-doc-dirs on tug india stuff, adjust statement about voss' + mathmode document book form + (q-doc-dirs): gone + +2011-09-10 Robin Fairbairns + + * faq-adj-types.tex (q-multind): describe amsmidx, imakeidx + + * dirctan.tex: add amscls, imakeidx; correct texmacs + +2011-09-09 Robin Fairbairns + + * faq-docs.tex (q-latex-books): add herbert voss's books under latex + +2011-09-09 Robin Fairbairns + + * faq-mac-prog.tex (q-printvar, q-labelcount): add \LastEdit* (oops) + + * faq-docs.tex (q-latex-books): add latex beginner's guide + +2011-09-08 Robin Fairbairns + + * faq-docs.tex (q-ref-doc): patch minor translation effect (\) + (q-doc-wiki): editorial, mostly + (q-doc-dirs): a lot more than two in tug india's thing, now + +2011-09-08 Robin Fairbairns + + * faq-intro.tex: list Gernot Hassenpflug + + * faq-mac-prog.tex: add q-printvar and q-labelcount from add-general + + * patchdates.tex: updated. this is silly. + +2011-09-07 Robin Fairbairns + + * faq-intro.tex (list of helpers): cite another thing from dan l + + * faq-backgrnd.tex (q-texthings): correct \input texinfo (!) + 2011-09-06 Robin Fairbairns + * faq-mac-prog.tex (q-keyval): tweak words about getoptk + (too late for release...) + *** Release 3.23 *** * texfaq2html, texfaq2html-beta: change "last modified" to "released" diff --git a/Master/texmf-dist/doc/generic/FAQ-en/FAQ-html.tar.gz b/Master/texmf-dist/doc/generic/FAQ-en/FAQ-html.tar.gz index d54bcd15760..7977e2f5142 100644 Binary files a/Master/texmf-dist/doc/generic/FAQ-en/FAQ-html.tar.gz and b/Master/texmf-dist/doc/generic/FAQ-en/FAQ-html.tar.gz differ diff --git a/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex b/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex index 6d1159275e1..74f02064f3c 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/dirctan.tex @@ -1,4 +1,4 @@ -% $Id: dirctan.tex,v 1.275 2011/09/03 18:56:20 rf10 Exp rf10 $ +% $Id: dirctan.tex,v 1.282 2011/10/25 18:22:56 rf10 Exp rf10 $ % % protect ourself against being read twice \csname readCTANdirs\endcsname @@ -9,7 +9,7 @@ \CTANdirectory{4spell}{support/4spell}[fourspell] \CTANdirectory*{Catalogue}{help/Catalogue} \CTANdirectory*{MathTeX}{support/mathtex}[mathtex] -\CTANdirectory*{MimeTeX}{support/mimetex}[mimetex] +\CTANdirectory{MimeTeX}{support/mimetex}[mimetex] \CTANdirectory{Tabbing}{macros/latex/contrib/Tabbing}[tabbing] \CTANdirectory*{TeXtelmExtel}{systems/msdos/emtex-contrib/TeXtelmExtel} \CTANdirectory{TftI}{info/impatient}[impatient] @@ -36,6 +36,7 @@ \CTANdirectory{algorithms}{macros/latex/contrib/algorithms}[algorithms] \CTANdirectory*{alpha}{systems/mac/support/alpha}[alpha] \CTANdirectory{amiga}{systems/amiga} +\CTANdirectory{amscls}{macros/latex/required/amslatex/amscls}[amscls] \CTANdirectory{amsfonts}{fonts/amsfonts}[amsfonts] \CTANdirectory{amslatex}{macros/latex/required/amslatex}[amslatex] \CTANdirectory{amslatex-primer}{info/amslatex/primer}[amslatex-primer] @@ -190,6 +191,7 @@ \CTANdirectory{cm}{fonts/cm} \CTANdirectory{cm-lgc}{fonts/ps-type1/cm-lgc}[cm-lgc] \CTANdirectory{cm-super}{fonts/ps-type1/cm-super}[cm-super] +\CTANdirectory{cm-unicode}{fonts/cm-unicode}[cm-unicode] \CTANdirectory{cmactex}{systems/mac/cmactex}[cmactex] \CTANdirectory{cmap}{macros/latex/contrib/cmap} \CTANdirectory{cmastro}{fonts/cmastro} @@ -300,6 +302,7 @@ \CTANdirectory{dvipng}{dviware/dvipng}[dvipng] \CTANdirectory{dvips-pc}{systems/msdos/dviware/dvips} \CTANdirectory{dvips}{dviware/dvips}[dvips] +\CTANdirectory{dvistd}{dviware/driv-standard} \CTANdirectory{dvisun}{dviware/dvisun} \CTANdirectory{dvitty}{dviware/dvitty} \CTANdirectory{dvivga}{dviware/dvivga} @@ -326,6 +329,7 @@ \CTANdirectory{emtex-contrib}{systems/msdos/emtex-contrib} \CTANdirectory{emtex-fonts}{systems/msdos/emtex-fonts} \CTANdirectory{emtextds}{obsolete/systems/os2/emtex-contrib/emtexTDS} +\CTANdirectory{enctex}{systems/enctex}[enctex] \CTANdirectory{endfloat}{macros/latex/contrib/endfloat}[endfloat] \CTANdirectory{english}{language/english} \CTANdirectory{engwar}{fonts/engwar} @@ -470,6 +474,7 @@ \CTANdirectory{ifmtarg}{macros/latex/contrib/ifmtarg}[ifmtarg] \CTANdirectory{ifmslide}{macros/latex/contrib/ifmslide}[ifmslide] \CTANdirectory{ifxetex}{macros/generic/ifxetex}[ifxetex] +\CTANdirectory{imakeidx}{macros/latex/contrib/imakeidx}[imakeidx] \CTANdirectory{imaketex}{support/imaketex} \CTANdirectory{impact}{web/systems/mac/impact} \CTANdirectory{import}{macros/latex/contrib/import}[import] @@ -502,7 +507,7 @@ \CTANdirectory{knot}{fonts/knot} \CTANdirectory{knuth}{systems/knuth} \CTANdirectory{knuth-dist}{systems/knuth/dist}[knuth-dist] -\CTANdirectory{koma-script}{macros/latex/contrib/koma-script} +\CTANdirectory{koma-script}{macros/latex/contrib/koma-script}[koma-script] \CTANdirectory{korean}{fonts/korean} \CTANdirectory{kpfonts}{fonts/kpfonts}[kpfonts] \CTANdirectory{kyocera}{dviware/kyocera} @@ -574,7 +579,7 @@ \CTANdirectory{malayalam}{language/malayalam} \CTANdirectory{malvern}{fonts/malvern} \CTANdirectory{mapleweb}{web/maple/mapleweb} -\CTANdirectory{marvosym-fonts}{fonts/psfonts/marvosym} +\CTANdirectory{marvosym-fonts}{fonts/marvosym} \CTANdirectory{mathabx}{fonts/mathabx}[mathabx] \CTANdirectory{mathabx-type1}{fonts/ps-type1/mathabx}[mathabx-type1] \CTANdirectory{mathastext}{macros/latex/contrib/mathastext}[mathastext] @@ -639,6 +644,7 @@ \CTANdirectory{multirow}{macros/latex/contrib/multirow}[multirow] \CTANdirectory{musictex}{macros/musictex}[musictex] \CTANdirectory{musixtex-egler}{obsolete/macros/musixtex/egler} +\CTANdirectory{musixtex-fonts}{fonts/musixtex-fonts}[musixtex-fonts] \CTANdirectory{musixtex}{macros/musixtex}[musixtex] \CTANdirectory{mutex}{macros/mtex} \CTANdirectory{mxedruli}{fonts/georgian/mxedruli} @@ -795,6 +801,7 @@ \CTANdirectory{schemeweb}{web/schemeweb}[schemeweb] \CTANdirectory{sciposter}{macros/latex/contrib/sciposter}[sciposter] \CTANdirectory{sectsty}{macros/latex/contrib/sectsty}[sectsty] +\CTANdirectory{selectp}{macros/latex/contrib/selectp}[selectp] \CTANdirectory{seminar}{macros/latex/contrib/seminar}[seminar] \CTANdirectory{shade}{macros/generic/shade}[shade] \CTANdirectory{showlabels}{macros/latex/contrib/showlabels}[showlabels] @@ -833,13 +840,13 @@ \CTANdirectory{texcount}{support/texcount}[texcount] \CTANdirectory{texdef}{support/texdef}[texdef] \CTANdirectory{tex-gpc}{systems/unix/tex-gpc}[tex-gpc] +\CTANdirectory{tex-overview}{info/tex-overview}[tex-overview] \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}[texlive] -\CTANdirectory*{texmacs}{systems/unix/TeXmacs}[texmacs] +\CTANdirectory*{texmacs}{support/TeXmacs}[texmacs] \CTANdirectory*{texniccenter}{systems/win32/TeXnicCenter}[texniccenter] \CTANdirectory{texpower}{macros/latex/contrib/texpower}[texpower] \CTANdirectory{texshell}{systems/msdos/texshell}[texshell] @@ -893,6 +900,8 @@ \CTANdirectory{urwchancal}{fonts/urwchancal}[urwchancal] \CTANdirectory{utopia}{fonts/utopia}[utopia] \CTANdirectory{varisize}{macros/plain/contrib/varisize}[varisize] +\CTANdirectory{varwidth}{macros/latex/contrib/varwidth}[varwidth] +\CTANdirectory{version}{macros/latex/contrib/version}[version] \CTANdirectory{vc}{support/vc}[vc] \CTANdirectory{verbdef}{macros/latex/contrib/verbdef}[verbdef] \CTANdirectory{vertbars}{macros/latex/contrib/vertbars}[vertbars] 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 index 473d6d4b4dc..b03de85315d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-adj-types.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-adj-types.tex @@ -1,4 +1,4 @@ -% $Id: faq-adj-types.tex,v 1.33 2011/06/01 19:57:21 rf10 Exp rf10 $ +% $Id: faq-adj-types.tex,v 1.35 2011/10/12 21:58:46 rf10 Exp rf10 $ \section{Adjusting the typesetting} @@ -2627,7 +2627,9 @@ 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. +with the \Package{algorithm} package. (There have been reports of +difficulty defining new commands to fit with the package; +unfortunately, the author is not available to comment.) The \Package{alg} package, like \Package{algorithms}, offers a floating algorithm environment with all of the ensuing niceties. @@ -2697,6 +2699,7 @@ algorithms to float like figures and tables. \item[program.sty]\CTANref{program} \item[pseudocode.sty]\CTANref{pseudocode} \end{ctanrefs} +\LastEdit{2011-10-12} \Question[Q-makeindex]{Generating an index in \AllTeX{}} @@ -2845,68 +2848,64 @@ is in the package files. \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 a further development called -MusiX\TeX{}, which is a three-pass system (with a processor program -that computes values for the element spacing in the music, and sorts -out spaces and ties (which Music\tex{} does ``woodenly''~--- playing -from a Music\tex{}-typeset page is entirely possible, but the look of -the slurs is very unsatisfying). Thus Musix\tex{} achieves finer -control than is possible with the unmodified \TeX{}-based mechanism -that Music\TeX{} uses. - -The original author of Musix\tex{}, Andreas Egler, withdrew from -development of the package; he has a further package Opus\tex{} (not -on \acro{CTAN}) which is focused on typesetting Gregorian chant and -the like. - -Daniel Taupin forked his development of MusiX\TeX{}, and his is the -only version currently maintained (by Daniel's successors, since -Daniel died). - -Input to MusiX\TeX{} is 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. +\Question[Q-music]{Typesetting music in \tex{}} + +The current best bet for music typesetting is to use +\Package{musixtex}. \Package{Musixtex} is a three-pass system that +has a \tex{}-based pass, a processing pass and then a further \tex{} +pass. The middle pass, a program called \ProgName{musixflx}, +optimises the spacing and sorts out slurs and ties. +\Package{Musixtex} is demanding of \tex{} resources, and any +significant score requires that typesetting is done using \etex{}, +whose expanded variable- and box-register ranges allow for more of the +``parallel'' activities that abound in a music score. +Of course, \Package{musixtex} also requires music fonts; those are +available in a separate package on the archive. + +\Package{Musixtex} requires pretty arcane input; most people using it +actually prepare (less obscure) input for \ProgName{pmx}, whose output +is \tex{} input suitable for \Package{musixtex}. + +A further preprocessor, \ProgName{M-Tx}, allows preparation of music +with lyrics; \ProgName{M-Tx}'s output is fed into \ProgName{pmx}, and +thence to \Package{musixtex}. + +An alternative path to music examples within a \alltex{} document is +\href{http://www.lilypond.org}{\ProgName{Lilypond}}. +\ProgName{Lilypond} is (at heart) a batch music typesetting system +with plain text input that does most of its work without \tex{}. +\ProgName{Lilypond}'s input syntax is less cryptic than is +MusiX\TeX{}'s, though similar quality is achieved. The +\ProgName{lilypond} +\href{http://lilypond.org/web/about/faq}{\acro{FAQ}} mentions +development of graphical user interfaces. + +Another alternative in the production of music is the \acro{ABC} +notation, which was developed to notate the traditional music of +Western Europe (which can be written on a single stave), though it can +be used much more widely. A front end to \Package{musictex} (see +below), \ProgName{abc2mtex}, makes \acro{ABC} typesetting possible. + +The program \ProgName{midi2tex} can also generate \Package{musictex} +output, from \acro{MIDI} files. + +The history of music in \tex{} goes back some time; the earliest +``working'' macros were Mu\tex{}, by Angelika Schofer and Andrea +Steinbach. Mu\tex{} was very limited, but it was some time before +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 no longer recommended. + +The first version of Musix\tex{} was developed by Andreas Egler, but +he withdrew from the project to work on another package, Opus\tex{}. +That never reached the mainstream, and is no longer maintained. The +current recommended way of doing Opus\tex{}'s job is +\href{http://home.gna.org/gregorio/}{\ProgName{gregorio}}, which can +in principle feed into a \tex{}-based document. + +Once Andreas Egler had withdrawn (his last version of +\Package{musixtex} is preserved on the archive), Daniel Taupin took up +the development, leading to the \Package{musixtex} used today. \begin{ctanrefs} \item[abc2mtex]\CTANref{abc2mtex} \item[M-Tx]\CTANref{mtx} @@ -2915,9 +2914,11 @@ Lilypond can also produce basic \acro{MIDI} output. % ! line breaks \item[musixtex \nothtml{\rmfamily}(Taupin's version)]\CTANref{musixtex} \item[musixtex \nothtml{\rmfamily}(Egler's version)]\CTANref{musixtex-egler} +\item[musixtex \nothtml{\rmfamily}fonts]\CTANref{musixtex-fonts} \item[mutex]\CTANref{mutex} \item[pmx]\CTANref{pmx} \end{ctanrefs} +\LastEdit{2011-11-01} \Question[Q-parskip]{Zero paragraph indent} @@ -3393,9 +3394,9 @@ 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 +from an old version of the \LaTeXo{} 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: @@ -3405,7 +3406,7 @@ To create a ``general'' and an ``authors'' index, one might write: \makeindex{general} \makeindex{authors} ... -\index{authors}{Another Idiot} +\index{authors}{Eccentric Professor} ... \index{general}{FAQs} ... @@ -3427,6 +3428,13 @@ 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{multind} package doesn't work with the % ! line break +\Qref*{\amslatex{} classes}{Q-AMSpkg}, but the \acro{AMS} provide a +substitute, the \Package{amsmidx} package. You use the +\Package{amsmidx} package pretty much the same as you would +\Package{multind}, but if things aren't clear, there \emph{is} +documentation (unlike \Package{multind}). + 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 @@ -3497,10 +3505,25 @@ from this trick, \Package{splitidx} supports the same sorts of things as does \Package{index}. An example of use appears in the documentation. +The \Package{imakeidx} can do a wide range of things (in particular, +it can run an index-builder~--- via % ! line break +\Qref*{\csx{write18} commands}{Q-spawnprog}~--- so as to simplify +business of making the final copy of a document). The package can +also make multiple indexes; it can do the job in the conventional +(\Package{multind}) way, or by using the external +\ProgName{splitindex} script provided with the \Package{splitindex} +package. (This arrangement allows efficient operation with small +numbers of indexes, while retaining the flexibility of permitting +large numbers of indexes without hitting the restriction of numbers of +active output streams.) + 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[amsmidx.sty]Part of the \acro{AMS} class distribution + \CTANref{amscls}[amsmidx] +\item[imakeidx.sty]\CTANref{imakeidx} \item[index.sty]\CTANref{index} \item[makeidx.sty]Part of the \LaTeX{} distribution \item[memoir.cls]\CTANref{memoir} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex index 2b1853c9fa8..60219017103 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-backgrnd.tex @@ -1,4 +1,4 @@ -% $Id: faq-backgrnd.tex,v 1.27 2011/09/03 18:56:20 rf10 Exp $ +% $Id: faq-backgrnd.tex,v 1.29 2011/10/02 20:13:05 rf10 Exp rf10 $ \section{The Background} @@ -189,10 +189,14 @@ A mailing list discussing \MP{} is available; \href{http://lists.tug.org/metapost}{\acro{TUG} \ProgName{mailman} interface}. \end{hyperversion} The \acro{TUG} website also hosts a % ! line break -\href{http://tug.org/metapost.html}{\MP{} summary page}. +\href{http://tug.org/metapost.html}{\MP{} summary page}, and the +\Package{tex-overview} document gives you a lot more detail (and some +explanatory background material). +\begin{ctanrefs} +\item[tex-overview.pdf]\CTANref{tex-overview} +\end{ctanrefs} \LastEdit{2011-09-01} -%**** \Question[Q-texthings]{Things with ``\TeX{}'' in the name} New \TeX{} users are often baffled by the myriad terms with ``\TeX{}'' @@ -251,9 +255,8 @@ that you are likely to encounter: See \Qref[questions]{Books on \TeX{} and its relations}{Q-latex-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}. + \Qref[]{Online introductions: \LaTeX{}}{Q-man-latex} and + \Qref[]{Specialized \AllTeX{} tutorials}{Q-tutbitslatex}. 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.~% @@ -271,7 +274,10 @@ that you are likely to encounter: \ProgName{texi2dvi} 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 + a Texinfo document must begin with + \begin{quote} + \csx{input}\texttt{ texinfo} + \end{quote} explicitly load the Texinfo macro package. \item[\Eplain{}~--- Extended Plain \TeX{} (executable: \ProgName{eplain})] @@ -358,7 +364,9 @@ 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{}. +\acro{CM}ac\TeX{} and te\TeX{}. \miktex{} is also available as the +basis of the Pro\TeX{}t bundle, distributed on the \texlive{} +\acro{DVD} mailing, as well as being available online. Some \TeX{} distributions target a specific operating system and/or processor architecture; others run on multiple platforms. Many \TeX{} @@ -378,7 +386,97 @@ name like ``blah\tex{}''. The subject matter covered by this answer is also addressed in a page on the \acro{TUG} site, % ! line break ``\href{http://tug.org/levels.html}{the Levels of \tex{}}''. -\LastEdit{2011-06-01} +\LastEdit{2011-09-26} + +\Question[Q-ctan]{What is \acro{CTAN}?} + +The acronym stands for ``Comprehensive \tex{} Archive Network'', which +more-or-less specifies what it's \emph{for}: +\begin{itemize} +\item The aim is to offer a comprehensive collection of \tex{} resources. +\item The content is to be made publicly accessible, via the internet. +\item \acro{CTAN} is a \emph{network} of archives, which strive to + stay in step with one another. +\end{itemize} +The basic framework was developed by a \acro{TUG} working group set up +to resolve the (then existing) requirement for users to \emph{know} on +which archive site a particular package might be found. + +Actual implementation offers three distinct types of host: +\begin{description} +\item[\emph{Core} archives]Which form a small, tightly-coupled set of + machines, which perform management functions as well as serving + files, and +\item[\emph{Mirror} archives]Which do no more than take regular copies + of core archives. +\item[Archive selector]Which is a meta-service, which routes requests + to an apparently ``local'' source (mirror or archive). +\end{description} +Note that there is nothing to prevent any archive from supporting +other functions, so a \acro{CTAN} mirror may also operate as a +\acro{CPAN} (Perl) mirror and as a SourceForge (general free software) +mirror, and \dots{} + +Functions that distinguish core archives are: +\begin{itemize} +\item Uploads: users may submit new (or updated) material, and + significant changes to the archive are reported via the mailing list + \Email{ctan-ann@dante.de} +\item Weak consistency: changes to the content of the archives are + rapidly distributed to all core archives. +\item Providing distribution (\texlive{} and \miktex{}) support. +\item Catalogue maintenance. +\item Mirror monitoring. +\end{itemize} +Not all core archives offer all of these functions. + +Users may contact the maintainers of the core archives via the mailing +list \mailto{ctan@dante.de} + +Users who have new material for the archive may submit it using the +\href{http://dante.ctan.org/upload/}{German} or +\href{http://www.tex.ac.uk/upload/}{UK} archive. + +Users should ordinarily download material from \acro{CTAN} via the +\href*{http://mirror.ctan.org/}{archive selector}: this uses the +mirror monitor's database, and uses the caller's geographical location to +offer an efficient choice of ``sufficiently up-to-date'' mirror site for +you to connect to. Note that all the download links, given in the web +representation of these \acro{FAQ}s, are set up to use the mirror +selector. +\LastEdit*{2011-04-21} + +\Question[Q-catalogue]{The (\acro{CTAN}) catalogue} + +Finding stuff on networks was always difficult, but in recent years, +search engines have become amazingly good at digging out unconsidered +trifles from the myriad items of information available on the net. + +Sadly, in the \tex{} context, search engines seem to excel in locating +out-of-date material, while the service users need a means of finding +relevant material on \acro{CTAN}~--- on the grounds that such material +is most likely to be up-to-date. The need to find such items, thus +alleviating tendency to end up with out-of-date \alltex{} material, +was the motivation for developing a specialised information source: +the \acro{CTAN} catalogue. The aim is that they contain enough +relevant information that they will appear early in a search engine's +evaluation. + +The basis of the catalogue is a collection of small +articles; each shows basic information about a package on \acro{CTAN}, +and includes pointers to download address, documentation and related +packages. Every \acro{CTAN} mirror holds a copy of the catalogue, +presented as a series of web pages; indexes (both alphabetic and +category-based) are provided. + +The core \acro{CTAN} sites also offer a simple text search of the +catalogue. This is a tolerable means of finding a package you need, +but it is not really a substitute for a good information retrieval +system: the problem of providing such a system has not yet been solved. +\begin{ctanrefs} +\item[\nothtml{\rmfamily}The CTAN catalogue]\CTANref{Catalogue} +\end{ctanrefs} +\LastEdit*{2011-05-19} \Question[Q-triptrap]{How can I be sure it's really \TeX{}?} @@ -1004,8 +1102,7 @@ conference, whose proceedings are published in \textsl{TUGboat}. 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. +\textsl{TUGboat} are also available. Some time ago, \acro{TUG} established a ``technical council'', whose task was to oversee the development of \TeX{}nical projects. Most @@ -1038,15 +1135,5 @@ too; \acro{TUG}'s web site maintains a list of \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} - +Contact \acro{TUG} itself via \URL{http://tug.org/contact} +LastEdit{2011-09-19} 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 index b8fade922fa..a6ed86b6617 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-bits+pieces.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-bits+pieces.tex @@ -1,120 +1,30 @@ -% $Id: faq-bits+pieces.tex,v 1.18 2011/08/28 10:13:19 rf10 Exp rf10 $ +% $Id: faq-bits+pieces.tex,v 1.23 2011/10/25 21:30:42 rf10 Exp rf10 $ \section{Bits and pieces of \AllTeX{}} -\Question[Q-ctan]{What is \acro{CTAN}?} - -The acronym stands for ``Comprehensive \tex{} Archive Network'', which -more-or-less specifies what it's \emph{for}: -\begin{itemize} -\item The aim is to offer a comprehensive collection of \tex{} resources. -\item The content is to be made publicly accessible, via the internet. -\item \acro{CTAN} is a \emph{network} of archives, which strive to - stay in step with one another. -\end{itemize} -The basic framework was developed by a \acro{TUG} working group set up -to resolve the (then existing) requirement for users to \emph{know} on -which archive site a particular package might be found. - -Actual implementation offers three distinct types of host: -\begin{description} -\item[\emph{Core} archives]Which form a small, tightly-coupled set of - machines, which perform management functions as well as serving - files, and -\item[\emph{Mirror} archives]Which do no more than take regular copies - of core archives. -\item[Archive selector]Which is a meta-service, which routes requests - to an apparently ``local'' source (mirror or archive). -\end{description} -Note that there is nothing to prevent any archive from supporting -other functions, so a \acro{CTAN} mirror may also operate as a -\acro{CPAN} (Perl) mirror and as a SourceForge (general free software) -mirror, and \dots{} - -Functions that distinguish core archives are: -\begin{itemize} -\item Uploads: users may submit new (or updated) material, and - significant changes to the archive are reported via the mailing list - \Email{ctan-ann@dante.de} -\item Weak consistency: changes to the content of the archives are - rapidly distributed to all core archives. -\item Providing distribution (\texlive{} and \miktex{}) support. -\item Catalogue maintenance. -\item Mirror monitoring. -\end{itemize} -Not all core archives offer all of these functions. - -Users may contact the maintainers of the core archives via the mailing -list \mailto{ctan@dante.de} - -Users who have new material for the archive may submit it using the -\href{http://dante.ctan.org/upload/}{German} or -\href{http://www.tex.ac.uk/upload/}{UK} archive. - -Users should ordinarily download material from \acro{CTAN} via the -\href*{http://mirror.ctan.org/}{archive selector}: this uses the -mirror monitor's database, and uses the caller's geographical location to -offer an efficient choice of ``sufficiently up-to-date'' mirror site for -you to connect to. Note that all the download links, given in the web -representation of these \acro{FAQ}s, are set up to use the mirror -selector. -\LastEdit*{2011-04-21} - -\Question[Q-catalogue]{The (\acro{CTAN}) catalogue} - -Finding stuff on networks was always difficult, but in recent years, -search engines have become amazingly good at digging out unconsidered -trifles from the myriad items of information available on the net. - -Sadly, in the \tex{} context, search engines seem to excel in locating -out-of-date material, while the service users need a means of finding -relevant material on \acro{CTAN}~--- on the grounds that such material -is most likely to be up-to-date. The need to find such items, thus -alleviating tendency to end up with out-of-date \alltex{} material, -was the motivation for developing a specialised information source: -the \acro{CTAN} catalogue. The aim is that they contain enough -relevant information that they will appear early in a search engine's -evaluation. - -The basis of the catalogue is a collection of small -articles; each shows basic information about a package on \acro{CTAN}, -and includes pointers to download address, documentation and related -packages. Every \acro{CTAN} mirror holds a copy of the catalogue, -presented as a series of web pages; indexes (both alphabetic and -category-based) are provided. - -The core \acro{CTAN} sites also offer a simple text search of the -catalogue. This is a tolerable means of finding a package you need, -but it is not really a substitute for a good information retrieval -system: the problem of providing such a system has not yet been solved. -\begin{ctanrefs} -\item[\nothtml{\rmfamily}The CTAN catalogue]\CTANref{Catalogue} -\end{ctanrefs} -\LastEdit*{2011-05-19} - \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, when we use -``original'' \TeX{} (later \TeX{} systems, such as -\begin{flatversion} - \PDFTeX{}~--- see \Qref[question]{\PDFTeX{}}{Q-whatpdftex}~--- -\end{flatversion} -\begin{hyperversion} - \Qref{\PDFTeX{}}{Q-whatpdftex} -\end{hyperversion} -may use other formats). - -`\acro{DVI}' is supposed to -be an acronym for \acro{D}e\acro{V}ice-\acro{I}ndependent, meaning -that the file can be processed for printing or viewing on most -kinds of typographic output device or display. The \acro{DVI} file -may be processed by a \Qref*{DVI driver}{Q-driver} to produce -further output designed specifically for a particular printer, or it -may be used by a previewer for display on a computer screen. -\acro{DVI} files use an internal coding designed for \TeX{}; a \TeX{} -input file should produce the same \acro{DVI} file regardless of which -implementation of \TeX{} is used to produce it. +``original'' \TeX{}; later \TeX{} systems, such as + \Qref*{\PDFTeX{}}{Q-whatpdftex} +may use other formats. \Qref*{\xetex}{Q-xetex} (released some time +after \pdftex{}) uses an +``extended \acro{DVI} format'' (\acro{XDV}) to send its output to its +close-coupled \Qref*{\acro{DVI} driver}{Q-driver}, +\ProgName{xdvipdfmx}. + +`\acro{DVI}' is supposed to be an acronym for +\acro{D}e\acro{V}ice-\acro{I}ndependent, meaning that the file can be +processed for printing or viewing on most kinds of typographic output +device or display. The \acro{DVI} file may be processed by a +\Qref*{DVI driver}{Q-driver} to produce further output designed +specifically for a particular printer, or it may be used by a +previewer for display on a computer screen. The character encoding of +a \acro{DVI} file is determined by the document itself~--- see % line break +``\Qref*{what are encodings}{Q-whatenc}'' for an explanation of what 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 @@ -123,58 +33,65 @@ possibly material to be introduced by means of 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). +as its name implies, was to view the content of a \acro{DVI} file), +and a partially complete ``standard'' for the way they should be +processed may offer further enlightenment. \begin{ctanrefs} +\item[\nothtml{rmfamily}DVI processing standard]\CTANref{dvistd} \item[dvitype]\CTANref{dvitype} \end{ctanrefs} -\LastEdit{2011-07-01} +\LastEdit{2011-10-10} \Question[Q-driver]{What is a \acro{DVI} driver?} A \acro{DVI} driver is a program that takes as input a -\begin{flatversion} - \acro{DVI} file (see \Qref[question]{}{Q-dvi}) -\end{flatversion} -\begin{hyperversion} - \Qref{\acro{DVI} file}{Q-dvi} -\end{hyperversion} -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 font information, -see \Qref[questions]{\acro{PK} files}{Q-pk}, +\Qref*{\acro{DVI} file}{Q-dvi} +and (usually) produces a file in a format that something \emph{other} +than a \TeX{}-related program can process. + +A driver may be designed for producing output for printing (e.g., +\PS{}), for later processing (e.g., \PS{} for inclusion in a later +document), or for document exchange (e.g., \acro{PDF}). + +As well as the \acro{DVI} file, the driver typically 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 a printer itself +provides. Each driver will expect the font information in a particular +form. + +For more information on the forms of font information, 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}. +\LastEdit{2011-10-10} \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. +\acro{PK} files (packed raster) are the canonical form of 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 of each +design (point) size for each weight for each font in 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. + +While this menagerie of bitmaps can (in principle) provide fonts that +are closely matched to the capabilities of each printer, the size of +the collection (and the resulting difficulty of maintaining it) has +been a potent driver to the move towards outline fonts such as +\Qref*{Adobe Type 1 fonts}{Q-adobetypen}. +\LastEdit{2011-10-10} \Question[Q-tfm]{What are \acro{TFM} files?} -\acro{TFM} stands for \TeX{} Font Metrics; \acro{TFM} files hold +\acro{TFM} is an acronym 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) @@ -191,7 +108,7 @@ Note that TrueType and OpenType fonts contain the necessary metrics, so that \Qref{\xetex{}}{Q-xetex} and \Qref{\luatex{}}{Q-luatex}, using such fonts, have no need of \acro{TFM} files. A corollary of this is that setting up fonts for use by these engines is far \emph{easier}. -\LastEdit{2011-07-10} +\LastEdit{2011-10-10} \Question[Q-virtualfonts]{Virtual fonts} @@ -200,29 +117,25 @@ 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 +An early instance of something like virtual fonts for \TeX{} was +implemented by David Fuchs to use an unusual printer. 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}). +published an % ! line break +\href{http:/tug.org/TUGboat/tb11-1/tb27knut.pdf}{article in \textsl{TUGboat}} +at the time; 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: +complicated than just a one-to-one character mapping. \TeX{} reads a +\acro{TFM} file of the font, just as before, but the \acro{DVI} +processor will read the \acro{VF} and use its content to specify how +each glyph is to be processed. + +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). +\item to `open' one or more (real) fonts for subsequent use, +\item to remap a glyph from one of the (real) fonts, +\item to build up a more complicated effect (using \acro{DVI} commands). \end{itemize} % !this has to be generated as a new paragraph by the translator, so @@ -237,16 +150,16 @@ 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 +Virtual fonts are normally created in a single \acro{ASCII} \acro{VPL} +(Virtual Property List) file, which includes two sets of information. +The \ProgName{vptovf} utility will use the \acro{VPL} file to 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 +hand. Despite the pleasures to be had, the commonest way (nowadays) +of generating an \acro{VPL} file is to use the +\ProgName{fontinst} package, which is described in more 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 @@ -258,6 +171,7 @@ fonts (it uses \TeX{} to parse a description of the virtual font, and \item[\nothtml{\rmfamily}Virtual fonts ``how to'']\CTANref{vf-howto} \item[qdtexvpl]\CTANref{qdtexvpl} \end{ctanrefs} +\LastEdit{2011-10-12} \Question[Q-whatmacros]{What are (\TeX{}) macros} @@ -269,7 +183,8 @@ 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, +\csx{TeX} is usually defined to produce ``TEX'' with the `E' lowered +(the original idea was Knuth's), 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 @@ -300,7 +215,7 @@ protecting users from themselves, but basically does the same thing: \newcommand{\foo}{bar} \end{verbatim} \end{quote} -Macros may have ``arguments'', which are used to substitute for marked +Macros may have ``arguments'' , which are used to substitute for marked bits of the macro expansion: \begin{quote} \begin{verbatim} @@ -327,13 +242,19 @@ which produces: \end{quote} (\latex{} users waltz through life, perhaps?) +You will have noticed that the arguments, above, were enclosed in +braces (\texttt{\obracesymbol{}\dots{}\cbracesymbol{}}); this is the +normal way of typing arguments, though \TeX{} is enormously flexible, +and you may find all sorts of other ways of passing arguments (if you +stick with it). + 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-tex-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. -\LastEdit{2011-07-10} +\LastEdit{2011-10-12} \Question[Q-specials]{\csx{special} commands} @@ -369,6 +290,7 @@ Note that \csx{special} behaves rather differently in \PDFTeX{}, since there is no device driver around. There \emph{is} a concept of \acro{PDF} specials, but in most cases \csx{special} will provoke a warning when used in \PDFTeX{}. +\LastEdit{2011-10-15} \Question[Q-write]{Writing (text) files from \tex{}} @@ -392,7 +314,7 @@ out. Now, there are times when you want to write something straight away: for example, to interact with the user. \TeX{} captures that -requirement, too, with the primitive \csx{immediate}: +requirement, too, with the primitive command \csx{immediate}: \begin{quote} \begin{verbatim} \immediate\write\terminal{I'm waiting...} @@ -410,6 +332,7 @@ its equivalent) is the first output stream ever set up (in most macro packages): it is never attached to a file, and if \tex{} is asked to write to \emph{any} stream that isn't attached to a file it will send the output to the terminal (and the log). +\LastEdit{2011-10-15} \Question[Q-spawnprog]{Spawning programs from \AllTeX{}: \csx{write18}} @@ -435,7 +358,7 @@ exact way it's done. However, there is a security issue. If you download some \alltex{} code from the Internet, can you be sure that there is not some command in it (perhaps in a hidden way) to do stuff that might be harmful to your -\acro{PC} (let's say: delete everything on the hard disk!)? In the +computer (let's say: delete everything on the hard disk!)? In the face of this problem, both \miktex{} and \tex{}~Live have, for some time, disabled \csx{write18} by default. To turn the facility on, both distributions support an additional argument when starting \tex{} @@ -483,6 +406,7 @@ when it starts. \item[epstopdf.sty]Distributed with Heiko Oberdiek's packages \CTANref{oberdiek}[epstopdf-pkg] \end{ctanrefs} +\LastEdit{2011-10-15} \Question[Q-hyphen]{How does hyphenation work in \TeX{}?} @@ -510,7 +434,8 @@ persuaded to think of as letters); things such as \TeX{}'s 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). +called \Package{patgen}, is not ordinarily a sport to be played by +ordinary mortals). 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 @@ -738,42 +663,37 @@ nearly so well, and the two packages provide the sort of symmetry the \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 +A font provides 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 +When \TeX{} version 3 arrived, most of the drivers 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 +necessary for Icelandic and Polish, for example, which the Cork fonts +do have, though even Cork encoding's coverage isn't complete.) +\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 +The first \MF{}-fonts to conform to the Cork encoding were the \acro{EC} +fonts. They look \acro{CM}-like, though their metrics differ from \acro{CM}-font +metrics in several areas. They have long been regarded as `stable' (in +the same sense that the \acro{CM} fonts are stable: their metrics are +unlikely ever to change). Each \acro{EC} font is, of course, roughly twice the +size of the corresponding \acro{CM} font, and there are far more of them than +there are 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} @@ -781,64 +701,105 @@ Type~1 or TrueType form (the latter only from % ( <- 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 +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 Metafont sources), are available. + +Note that the Cork encoding doesn't cover mathematics (so that no +``T1-encoded'' font families can not support it). 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 +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 \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 +necessarily as `stable' are the \acro{EC} fonts are. Note that modern +distributions tend not to distribute the \acro{EC} fonts in outline format, but +rather to provide Latin Modern for \acro{T}1-encoded Computer Modern-style +fonts. This can sometimes cause confusion when users are recompiling +old documents. 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 most other such fonts that have been developed (or otherwise -made available) for use with \AllTeX{}. +\acro{PSNFSS} system, for Adobe Type 1 fonts, and also by most other such +fonts that have been developed (or otherwise made available) for use +with \alltex{}. + +Note that \acro{T}1 (and other eight-bit font encodings) are superseded in +the developing \TeX{}-family members \Qref*{\xetex{}}{Q-xetex} and +\Qref*{\luatex{}}{Q-luatex}, which use Unicode as their base encoding, +and use Unicode-encoded fonts (typically in \FontFormat{ttf} or +\FontFormat{otf} formats). The \Package{cm-unicode} fonts carry the +flag in this arena, along with the Latin Modern set. \begin{ctanrefs} \item[CM-super fonts]\CTANref{cm-super} \item[CM-LGC fonts]\CTANref{cm-lgc} +\item[CM unicode fonts]\CTANref{cm-unicode} \item[EC and TC fonts]\CTANref{ec} \item[Latin Modern fonts]\CTANref{lm} \end{ctanrefs} +\Question[Q-unicode]{Unicode and \tex{}} + +Unicode is a character code scheme that has the capacity to express +the text of the languages of the world, as well as important symbols +(including mathematics). Any coding scheme that is directly +applicable to \tex{} may be expressed in single bytes (expressing up +to 256 characters); Unicode characters may require several bytes, and +the scheme may express a very large number of characters. + +For ``old-style'' applications (\tex{} or \pdftex{}) to deal with +Unicode input, the sequence of bytes to make up Unicode character is +processed by a set of macros, and converted to an 8-bit number +representing a character in an appropriate font (in practice, only the +standard \acro{UTF}-8 byte sequences are supported). \tex{} code that +reads these bytes is complicated, but works well enough; there is an +\pkgoption{utf8} option for the \latex{} distribution +\Package{inputenc} package. The separate package \Package{ucs} +provides wider, but less robust, coverage via an \Package{inputenc} +option \pkgoption{utf8x}. Broadly, the difference is that +\pkgoption{utf8} deals with ``standard \latex{} fonts'' (those for +which \latex{} has a defined encoding), while \pkgoption{utf8x} deals +with pretty much anything for which it knows a mapping of a Unicode +range to a font. + +The up-and-coming \tex{}-alike applications, \Qref*{\xetex{}}{Q-xetex} +and \Qref*{\luatex{}}{Q-luatex} read \acro{UTF}-8 representations of +Unicode as standard. They also use TrueType or OpenType fonts for +output; each such font ``declares'' which part(s) of the Unicode space +it covers, so that the \tex{}-alike engines can decide which font to +use for which character. +\begin{ctanrefs} +\item[inputenc.sty]Part of the \CTANref{latex} distribution +\item[ucs.sty]\CTANref{unicode} +\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 `distribution' and a (set of) `local' directory -trees containing \TeX{}-related files. The \acro{TDS} reserves the -name \texttt{texmf} as the name of the root directory (folder) of the -hierarchies, and most distributions use that name for their `own' -trees. Files supplied as part of the distribution are put into the -distribution's tree. The location of the distribution's hierarchy is -system dependent, but on a Unix system it might be at -\path{/usr/share/texmf} or -\path{/opt/texmf}, or -a similar location, but in each case the \TeX{} files will be in the -tree starting at the \path{/texmf} subdirectory. +\acro{TDS} is an acronym for ``\TeX{} Directory Structure''; it +specifies a standard way of organising all the \TeX{}-related files on +a computer system. + +Most modern distributions arrange their \tex{} files in conformance +with the \acro{TDS}, using both a `distribution' directory tree and a +(set of) `local' directory trees, each containing \TeX{}-related +files. The \acro{TDS} recommends the name \texttt{texmf} for the name +of the root directory (folder) of an hierarchy; in practice there are +typically several such trees, each of which has a name that compounds +that (e.g., \texttt{texmf-dist}, \texttt{texmf-var}). + +Files supplied as part of the distribution are put into the +distribution's tree, but the location of the distribution's hierarchy is +system dependent. (On a Unix system it might be at +\path{/usr/share/texmf} or \path{/opt/texmf}, or a similar location.) There may be more than one `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. +can be stored. An installation will also typically offer a local +hierarchy, while each user may have an individual local hierarchy. The \acro{TDS} itself is published as the output of a \acro{TUG} % ! line break \Qref*{Technical Working Group}{Q-TUG*}. You may browse an diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex index 95e7330c269..33a819732c5 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex @@ -1,4 +1,4 @@ -% $Id: faq-docs.tex,v 1.24 2011/07/19 18:58:57 rf10 Exp $ +% $Id: faq-docs.tex,v 1.29 2011/10/25 18:22:56 rf10 Exp rf10 $ \section{Documentation and Help} @@ -52,7 +52,7 @@ While Knuth's book is the definitive reference for both \TeX{} and \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) +% nos in comments 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) @@ -94,6 +94,8 @@ A collection of Knuth's publications about typography is also available: (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[\latex{} Beginner's Guide]by Stefan Kottwitz (Packt Publishing, + 2011, \ISBN*{1847199860}{978-1847199867}) \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}) @@ -123,9 +125,10 @@ A collection of Knuth's publications about typography is also available: 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} +% A list of errata for the first printing of Digital Typography Using +% \LaTeX{} is available from: +% \URL{http://www.springer-ny.com/catalog/np/jan99np/0-387-98708-8.html} +% (not any longer) \item[First Steps in \LaTeX{}]by George Gr\"atzer (Birkh\"auser, 1999, \ISBN{0-8176-4132-7}) \item[\LaTeX{}: Line by Line:]% @@ -135,6 +138,14 @@ A collection of Knuth's publications about typography is also available: \item[\LaTeX{} for Linux:]\emph{A Vade Mecum} by Bernice Sacks Lipkin (Springer-Verlag, 1999, \ISBN{0-387-98708-8}, second printing) +\item[Typesetting Mathematics with \latex{}]by Herbert Vo\ss {} (UIT + Cambridge, 2010, \ISBN{978-1-906-86017-2}) +% checked 2011-09-09 http://www.uit.co.uk/BK-TMWL/HomePage +\item[Typesetting Tables with \latex{}]by Herbert Vo\ss {}, (UIT + Cambridge, 2011, \ISBN{978-1-906-86025-7}) +% checked 2011-09-09 http://www.uit.co.uk/BK-TTWL/HomePage +\item[PSTricks: Graphics and PostScript for \tex{} and \latex{}]by + Herbert Vo\ss {}, (UIT Cambridge, 2011, \ISBN{978-1-906-86013-4}) \end{booklist} A sample of George Gr\"atzer's ``Math into \LaTeX{}'', in Adobe Acrobat format, and example files @@ -149,7 +160,7 @@ Gr\"atzer's ``First Steps in \LaTeX{}'', are all available on %\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} -\LastEdit*{2011-07-06} +\LastEdit*{2011-09-09} \Question[Q-other-books]{Books on other \tex{}-related matters} @@ -596,11 +607,7 @@ Next comes the (rather new) field of % ! line break 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. +\LastEdit{2011-09-26} \Question[Q-man-tex]{Online introductions: \plaintex{}} @@ -693,7 +700,8 @@ the source is also available). source also available: \CTANref{l2tabuen.src} \end{ctanrefs} -\Question[Q-tutbitslatex]{Specialised \AllTeX{} tutorials} +\Question[Q-tutbitslatex]{\AllTeX{} tutorials} +\AliasQuestion{Q-doc-dirs} The \acro{AMS} publishes a ``Short Math Guide for \LaTeX{}'', which is available (in several formats) via @@ -701,38 +709,41 @@ available (in several formats) via Documentation'' about half-way down the page. 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} +\LaTeX{}, and a development of it has been % ! line break +\Qref*{published as a book}{Q-latex-books}. Two documents written more than ten years apart about font usage in -\TeX{} are worth reading: % ! line breaks, next 3 lines +\TeX{} are worth reading: % ! line break \href{http://www.tug.org/TUGboat/Articles/tb14-2/tb39rahtz-nfss.pdf}{Essential NFSS} -by Sebastian Rahtz, and +by Sebastian Rahtz, and % ! line break \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}. +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/tutorials/tugindia}\nobreakspace--- there +are 17~chapters in the series, two of which are mostly introductory. + Peter Smith's \begin{narrowversion} ``\LaTeX{} for Logicians'' - (\URL{http://www.phil.cam.ac.uk/teaching_staff/Smith/LaTeX/}) + (\URL{http://www.logicmatters.net/latex-for-logicians/}) \end{narrowversion} \begin{wideversion} % ! line break - ``\href{http://www.phil.cam.ac.uk/teaching_staff/Smith/LaTeX/}{\LaTeX{} for Logicians}'' + ``\href{http://www.logicmatters.net/latex-for-logicians/}{\LaTeX{} for Logicians}'' \end{wideversion} -covers a rather smaller subject area, but is similarly comprehensive +page 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 +Keith Reckdahl's ``Using Imported Graphics in \LaTeXe{}'' +(\Package{epslatex}) is an excellent introduction to graphics use. It's available on -\acro{CTAN}, but the sources aren't available (though they were -promised some time back, they've not appeared, so the package is not -available in \texlive{} or \miktex{}). +\acro{CTAN}, but not in the \texlive{} or miktex{} distributions, for +lack of sources. Kjell Magne Fauske offers a set of examples of the use of the drawing packages % ! line break @@ -824,14 +835,16 @@ 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{}) +basic \LaTeX{} use. % line break +(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{}) For command organised references to \LaTeX{}, Karl Berry (et al)'s % !line break \href{http://home.gna.org/latexrefman}{LaTeX reference manual} is (to -an extent) work in progress, but is generally reliable. +an extent) work in progress, but is generally reliable (source is +available on the.archive as well). The reference provided by the Emerson Center of Emory University), % ! line break @@ -852,12 +865,14 @@ for chaos, there is evidence that a strong user community can keep a \acro{WIKI} under control. Following the encouraging performance of the % ! line break -\href{http://contextgarden.net/}{\CONTeXT{} \acro{WIKI}}, valiant efforts -have been made generating ``\acro{WIKI} books'' for \AllTeX{} users. Thus we -have \href{http://en.wikibooks.org/wiki/TeX}{(Plain) \TeX{} \acro{WIKI}} and -\href{http://en.wikibooks.org/wiki/LaTeX}{\LaTeX{} \acro{WIKI}} are well -established. Neither would seem yet to be of publication quality, but -they both seem useful reference sources. +\href{http://contextgarden.net/}{\CONTeXT{} \acro{WIKI}}, valiant +efforts have been made generating ``\acro{WIKI} books'' for \AllTeX{} +users. Thus we have % ! line break +\href{http://en.wikibooks.org/wiki/TeX}{(Plain) \TeX{} \acro{WIKI}} and +\href{http://en.wikibooks.org/wiki/LaTeX}{\LaTeX{} \acro{WIKI}}~--- +both well established. Neither would seem exactly of ``publication +quality'' (though that isn't really the aim), but they are both useful +reference sources. \Question[Q-typo-style]{Typography tutorials} @@ -884,16 +899,6 @@ of producing readable documents. \item[memdesign]\CTANref{memdesign} \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/tutorials/tugindia}\nobreakspace--- the -set comprises two parts, ``Text'' and ``Graphics'', so far. - -Once, there were other links like that, but all the others have faded -away, leaving the \acro{TUG} India set in splendid isolation. - \Question[Q-ol-books]{Freely available \AllTeX{} books} People have long argued for \AllTeX{} books to be made available on diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex index 85856d8cf1c..fdf37f9f92f 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-intro.tex @@ -1,4 +1,4 @@ -% $Id: faq-intro.tex,v 1.21 2011/05/25 18:57:21 rf10 Exp $ +% $Id: faq-intro.tex,v 1.25 2011/10/12 21:58:46 rf10 Exp rf10 $ % this environment is for the benefit of new-style file generation \begin{introduction} @@ -7,9 +7,16 @@ \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. +English-speaking users of \TeX{}. + +The questions answered here cover a wide range of topics, but +typesetting issues are mostly covered from the viewpoint of a \LaTeX{} +user. Some of the questions answered have little relevance to today's +users; this is inevitable~--- it's easier to add information than it +is to decide that information is no longer needed. The set of +answered questions is therefore in a state of slow flux: new questions +are answered, while old questions are deleted~\dots~but the whole +process depends on the time available for \acro{FAQ} maintenance. You may use the \acro{FAQ} \begin{itemize} @@ -18,12 +25,12 @@ You may use the \acro{FAQ} browsing: copies are available formatted so that they could be printed on \CTANhref{faq-a4}{A4 paper} or on % ! line break \CTANhref{faq-letter}{North American ``letter'' paper}, \htmlonly{or} -\htmlignore +\begin{typesetversion} \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 -\endhtmlignore +\end{typesetversion} \item via Scott Pakin's \CTANhref{visualFAQ}{Visual FAQ}, which shows \LaTeX{} constructions with links to \acro{FAQ} explanations of how they may be created. @@ -90,6 +97,7 @@ Damian Cugley, Michael Dewey, Michael Downes, % (RIP) on (ams)maths stuff Jean-Pierre Drucbert, % corrected my interpretation of minitoc +David Epstein, % comment on q-algorithms Michael Ernst, % alert on confusing colloquialism Thomas Esser, Ulrike Fischer, % spotted boondoggle in q-tabcellalign @@ -100,8 +108,9 @@ Norman Gray, Enrico Gregorio, % new definition for q-seccntfmt 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 +John Harper, % patient help with q-robust ;-) +Gernot Hassenpflug, % impetus and suggestions for q-printvar Troy Henderson, % metapost tutorials update Hartmut Henkel, Stephan Hennig, % text about vc in Q-RCS @@ -124,7 +133,7 @@ David Kraus, % help with tocbibind (spotted embarrassing typo :-} ) Ryszard Kubiak, % comment about q-driver Simon Law, Uwe L\"uck, % correction of typo -Daniel Luecking, +Daniel Luecking, % typos Aditya Mahajan, % rewrite of q-context Sanjoy Mahajan, Diego Andres Alvarez Marin, % suggestion of lacheck @@ -174,4 +183,5 @@ encountered on various lists, newsgroups or (lately) web forums. Many such people have helped, even if simply to highlight an area in which \acro{FAQ} work would be useful. \endhtmlignore +% \LastEdit{2011-10-12} % not to be typeset or converted to html... \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 index 9eec4396699..dad92238703 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-jot-err.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-jot-err.tex @@ -1,4 +1,4 @@ -% $Id: faq-jot-err.tex,v 1.9 2011/07/06 23:09:00 rf10 Exp rf10 $ +% $Id: faq-jot-err.tex,v 1.12 2011/10/29 07:43:12 rf10 Exp rf10 $ \section{The joy of \TeX{} errors} @@ -460,6 +460,89 @@ 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-optclash]{Option clash for package} + +The error message +\begin{quote} +\begin{verbatim} +! LaTeX Error: Option clash for package footmisc +\end{verbatim} +\end{quote} +means what it says~--- your document contains a (potentially) clashing +pair of options; sadly, it is not always obvious how the error has +arisen. + +If you simply write: +\begin{quote} +\begin{verbatim} +\usepackage[a]{foo} +... +\usepackage{foo} +\end{verbatim} +\end{quote} +\latex{} is happy, as it is with: +\begin{quote} +\begin{verbatim} +\usepackage[a]{foo} +... +\usepackage[a]{foo} +\end{verbatim} +\end{quote} +since \latex{} can see there's no conflict (in fact, the second load +does nothing). + +Similarly, +\begin{quote} +\begin{verbatim} +\usepackage[a,b]{foo} +... +\usepackage[a]{foo} +\end{verbatim} +\end{quote} +produces no error and does nothing for the second load. + +However +\begin{quote} +\begin{verbatim} +\usepackage[a]{foo} +... +\usepackage[b]{foo} +\end{verbatim} +\end{quote} +produces the error; even if option `\pkgoption{b}' is an alias for +option `\pkgoption{a}'~--- \latex{} doesn't ``look inside'' the package +to check anything like that. + +The general rule is: the first load of a package defines a set of +options; if a further \csx{usepackage} or \csx{RequirePackage} also +calls for the package, the options on that call may not extend the set +on the first load. + +Fortunately, the error (in that sort of case) is easily curable +once you've examined the preamble of your document. + +Now, suppose package \Package{foo} loads \Package{bar} with option +\pkgoption{b}, and your document says: +\begin{quote} +\begin{verbatim} +\usepackage{foo} +... +\usepackage[a]{bar} +\end{verbatim} +\end{quote} +or +\begin{quote} +\begin{verbatim} +\usepackage[a]{bar} +... +\usepackage{foo} +\end{verbatim} +\end{quote} +the error will be detected, even though you have only explicitly +loaded \Package{bar} once. Debugging such errors is tricky: it may +involve reading the logs (to spot which packages were called), or the +documentation of package \Package{foo}. + \Question[Q-tmupfl]{``Too many unprocessed floats''} If \LaTeX{} responds to a \cmdinvoke{begin}{figure} or @@ -1518,31 +1601,78 @@ If you're using the simpler \Package{graphics} package, use the \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. +The \emph{preamble} of your document is the stuff before +\cmdinvoke{begin}{document}; you put \csx{usepackage} commands and +your own macro definitions in there. \latex{} doesn't like +\emph{typesetting} anything in the preamble, so if you have: +\begin{itemize} +\item typed the odd grumble, +\item created a box with \csx{newsavebox} and put something in it + using \csx{sbox} (or the like), +\item forgotten to put \cmdinvoke{begin}{document} into the document, + at all, or even +\item gave it the wrong file +\end{itemize} +the error is inevitable and the solution is simple~--- judicious use +of comment markers (`\texttt{\textpercent{}}') at the beginning of a +line, moving things around, providing something that was +missing~\dots{} or switching to the correct file. + +The error may also occur while reading the \extension{aux} file from an +earlier processing run on the document; if so, delete the +\extension{aux} file and start again from scratch. If the error +recurs, it could well be due to a buggy class or package. + +However, it may be that none of the above solves the problem. + +If so, remember that things that appear before \csx{documentclass} are +also problematical: they are inevitably before +\cmdinvoke{begin}{document}! + +Unfortunately, modern editors are capable of putting things there, and +preventing you from seeing them. This can happen when your document +is being `written' in \Qref*{Unicode}{Q-unicode}. The Unicode +standard defines ``Byte Order Marks'' (\acro{BOM}), that reassure a +program (that reads the document) of the way the Unicode codes are +laid out. Sadly ordinary \latex{} or \pdflatex{} choke on +\acro{BOM}s, and consider them typesetting requests. The error +message you see will look like: +\begin{quote} +\begin{verbatim} +! LaTeX Error: Missing \begin{document}. +... +l.1 + \documentclass{article} +\end{verbatim} +\end{quote} +(Those \texttt{}s are your operating system's representation of an +unknown character; on the author's system it's a reverse video +`\texttt{?}' sign.) + +You can spot the \acro{BOM} by examining the bytes; for example, the +Unix \ProgName{hexdump} application can help: +\begin{quote} +\begin{verbatim} +$ hexdump -C +00000000 ef bb bf 5c 64 6f 63 75 ... +\end{verbatim} +\end{quote} +The \texttt{5c 64 6f 63 75} are the ``\csx{docu}'' at the start of +(the `real' part of) your document; the three bytes before it form the +\acro{BOM}. + +How to stop your editor from doing this to you depends, of course, on +the editor you use; if you are using \acro{GNU E}macs, you have to +change the encoding from \texttt{utf-8-with-signature} to `plain' +\texttt{utf-8}; instructions for that are found on +% ! line break +\href{http://stackoverflow.com/questions/3859274/}{the ``stack overflow'' site} + +(So far, all instances of this problem that the author has seen have +afflicted \acro{GNU E}macs users.) + +Fortunately \xetex{} and \luatex{} know about \acro{BOM}s and what to +do with them, so \latex{} using them is ``safe''. \Question[Q-normalszmiss]{\csx{normalsize} not defined} 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 index ddde1de0ab1..b71fbaece6d 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-mac-prog.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-mac-prog.tex @@ -1,4 +1,4 @@ -% $Id: faq-mac-prog.tex,v 1.23 2011/07/10 22:51:12 rf10 Exp rf10 $ +% $Id: faq-mac-prog.tex,v 1.25 2011/09/09 19:35:14 rf10 Exp rf10 $ \section{Macro programming} @@ -2481,6 +2481,113 @@ argument, so: \end{quote} is needed to produce a replica of the \csx{ghi} we defined earlier. +\Question[Q-printvar]{How to print contents of variables?} +\keywords{typeout, print variables, showthe} + +It is often useful to print out the values of variables in the log +file or on the terminal. Three possible ways to print out the +contents of \csx{textheight} variable are: +\begin{enumerate} +\item \csx{showthe}\csx{textheight} +\item \cmdinvoke{message}{The text height is \csx{the}\csx{textheight}} +\item \cmdinvoke{typeout}{The text height is \csx{the}\csx{textheight}} +\end{enumerate} +These techniques use the \TeX{} primitives \csx{the} (which provides +the value of a variable), \csx{showthe} (print a variable to the +terminal and the log, on a line of its own), and \csx{message}, which +interpolates something into the log. The command \csx{typeout} is +\LaTeX{}'s general message output mechanism. + +In each case, the variable's value is printed as a number of points. + +To typeset the value of \csx{textheight}, just +\csx{the}\csx{textheight} is enough, but a more flexible alternative is +to use the \Package{printlen} package. \Package{Printlen} allows you +to choose the units in which you print a variable; this is useful, +given that the most ordinary people don't think in points +(particularly Knuth's points, of which there are 72.27 to the inch). + +So, using \Package{printlen}, we could say: +\begin{quote} +\begin{verbatim} +\newlength{\foo} +\setlength{\foo}{12pt} +\verb|\foo| is \printlength{\foo} +\end{verbatim} +\end{quote} +and get: +\begin{quote} +\verb|\foo| is 12pt +\end{quote} +while, if we say: +\begin{quote} +\begin{verbatim} +\newlength{\foo} +\setlength{\foo}{12pt} +\uselengthunit{mm} +\verb|\foo| is \printlength{\foo} +\end{verbatim} +\end{quote} +we get: +\begin{quote} +\verb|\foo| is 4.21747mm +\end{quote} +\begin{ctanrefs} +\item[printlen.sty]\CTANref{printlen} +\end{ctanrefs} +\LastEdit*{2011-09-08} + +\Question[Q-labelcount]{Using labels as counter values} + +Labels are tempting sources of `numbers'~--- their most common use, +after all, is simply to typeset a number. However, their seeming +simplicity is deceptive; the packages \Package{babel} and +\Package{hyperref}, at least, fiddle with the definition of +\csx{ref} and \csx{pageref} in ways that make +\begin{quote} +\begin{verbatim} +\setcounter{foo}{\ref{bar}} +\end{verbatim} +\end{quote} +(etc.\@) not work; thus the technique may not be relied upon. + +The solution is to use the \Package{refcount} package (incidentally, +by the author of \Package{hyperref}). The package provides four +commands, all similar to: +\begin{quote} +\begin{verbatim} +\usepackage{refcount} +... +\label{bar} +... +\setcounterref{foo}{bar} +\end{verbatim} +\end{quote} +(the other three are \csx{addtocounterref}, \csx{setcounterpageref} +and \csx{addtocounterpageref}). + +The package also provides a command +\cmdinvoke*{getrefnumber}{label-name} that may be used where a +`number' value is needed. For example: +\begin{quote} +\begin{verbatim} +... \footnote{foo bar ...\label{foofoot}} +... +\footnotemark[\getrefnumber{foofoot}] +\end{verbatim} +\end{quote} +which gives you a second footnote mark reference the the footnote. +(There is also a command \csx{getpagerefnumber}, of course). + +The commands could be used by one determined not to use +\Package{changepage} to determine whether % ! line break +\Qref*{the current page is odd}{Q-oddpage}, but it's probably no more +trouble to use the fully-developed tool in this case. +\begin{ctanrefs} +\item[refount.sty]Distributed as part of \CTANref{oberdiek} +\end{ctanrefs} +\LastEdit*{2011-09-08} + \subsection{\LaTeX{} macro programming} \Question[Q-fixnam]{How to change \LaTeX{}'s ``fixed names''} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-projects.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-projects.tex index 2a6ee5c0bc9..8cee087f490 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-projects.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-projects.tex @@ -1,4 +1,4 @@ -% $Id: faq-projects.tex,v 1.24 2011/09/03 18:56:20 rf10 Exp rf10 $ +% $Id: faq-projects.tex,v 1.27 2011/10/17 23:24:32 rf10 Exp rf10 $ \section{Current \TeX{}-related projects} @@ -22,18 +22,28 @@ 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). Snapshots of two major collections -from the code, \Package{l3kernel} (supporting \LaTeX{}3 coding -conventions in a \LaTeXe{} environment), \Package{l3packages} (a -first cut of a ``document designer's interface'') and -\Package{l3experimental} (new stuff that's still under development) -are all available on -\acro{CTAN}. \Package{L3kernel} introduces a coding structure quite -different from earlier \latex{} code, but several authors are -nevertheless using it in their development work. +on the project web site (\URL{http://www.latex-project.org/papers/}). + +Some of the project's experimental code is visible on the net: +\begin{itemize} +\item via \URL{http://www.latex-project.org/code.html}, which points + to the project's \acro{SVN} repository; +\item via the project's + \href{https://github.com/latex3/svn-mirror}{\emph{GitHub} mirror}; +\item from \acro{CTAN}: snapshots of two major collections from the + code, \Package{l3kernel} (supporting \LaTeX{}3 coding conventions in + a \LaTeXe{} environment), \Package{l3packages} (a first cut of a + ``document designer's interface'') and \Package{l3experimental} (new + stuff that's still under development). +\end{itemize} +Note that \Package{L3kernel} introduces a coding structure quite +different from earlier \latex{} code, but a few authors, who are not +members of the project, are nevertheless using it in their development +work. + +While it is possible to build an experimental \latex{}3 format, it's +not (yet) a usable object; the team use it for debugging purposes, and +any other brave soul may also try it. Anyone may participate in discussions of the future of \LaTeX{} through the mailing list \texttt{latex-l}; some development work @@ -46,7 +56,7 @@ to \mailto{listserv@urz.Uni-Heidelberg.de} \item[\nothtml{\rmfamily}\LaTeX{} project publications]\CTANref{ltx3pub} \item[l3packages \nothtml{\rmfamily}bundle]\CTANref{l3packages} \end{ctanrefs} -\LastEdit{2011-08-30} +\LastEdit{2011-10-04} \Question[Q-mathml]{Future \acro{WWW} technologies and \AllTeX{}} @@ -112,6 +122,32 @@ support for new Web standards. %% is very much aware of the needs of one's conversion program %% and adapts one's usage of \AllTeX{} accordingly. + The \href{http://www.mathjax.org}{\ProgName{MathJax}} engine will process the + content of \latex{} \csx{[} \dots{}~\csx{]} and \csx{(} \dots{}~\csx{)} + `environments' in an \acro{HTML} document, to produce mathematical + output that may (for example) be cut-and-pasted into other programs. + + Incorporation into your document can be +\begin{wideversion} + as simple as incorporating: +\begin{verbatim} + +\end{verbatim} + into the header of your \acro{HTML} document, +\end{wideversion} +\begin{narrowversion} + incorporating the script~--- + \url{http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML} + ---~as the \texttt{src} tab of a \texttt{script type="text/javascript"} + element in the header of your \acro{HTML} document, +\end{narrowversion} + though the \href{http://www.mathjax.org/}{MathJax project's site} + also allows you to download your own copy and install it on one of + \emph{your} servers. \ProgName{MathJax} is open source software, so + you could, in principle, extend it to do even more eccentric tasks. + 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 @@ -154,12 +190,12 @@ support for new Web standards. \begin{quote} \begin{wideversion} \begin{verbatim} - + \end{verbatim} \end{wideversion} \begin{narrowversion} \begin{verbatim} - \end{verbatim} \end{narrowversion} @@ -176,7 +212,7 @@ support for new Web standards. \item[unicode-math.sty]\CTANref{unicode-math} \item[\nothtml{\rmfamily}XITS fonts]\CTANref{xits} \end{ctanrefs} -\LastEdit{2011-03-03} +\LastEdit{2011-10-17} \Question[Q-textrace]{Making outline fonts from \MF{}} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-support.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-support.tex index b874e907e61..e450af64c30 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-support.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-support.tex @@ -1,4 +1,4 @@ -% $Id: faq-support.tex,v 1.5 2011/05/08 10:16:43 rf10 Exp $ +% $Id: faq-support.tex,v 1.6 2011/10/29 22:03:32 rf10 Exp rf10 $ \section{Support Packages for \TeX{}} @@ -117,25 +117,29 @@ what's left. On a Unix-like system, this may be done using detex | wc -w \end{verbatim} \end{quote} +The technique is beguilingly simple, but it's not terribly accurate + 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. +Several \Qref*{editors and shells}{Q-editors} offer something similar. -\ProgName{TeXcount} also goes a long way with heuristics for counting, +\ProgName{TeXcount} 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} +\begin{hyperversion} \href{http://folk.uio.no/einarro/Comp/texwordcount.html}{package home page}. -\end{wideversion} -\begin{narrowversion} +\end{hyperversion} +\begin{flatversion} 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 +\end{flatversion} + +However, even quite sophisticated stripping of \AllTeX{} markup can +never be entirely reliable: markup itself may contribute typeset +words, or even consume words that appear in the text. + +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 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 index 7f1d6196a0d..ab839983542 100644 --- 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 @@ -1,4 +1,4 @@ -% $Id: faq-t-g-wr.tex,v 1.11 2011/03/09 21:09:24 rf10 Exp rf10 $ +% $Id: faq-t-g-wr.tex,v 1.12 2011/10/16 22:59:45 rf10 Exp rf10 $ \section{Things are Going Wrong\dots{}} @@ -238,7 +238,7 @@ Two packages are available that solve this problem. 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.) +too: read its documentation.) The \Package{soul} package defines an \csx{ul} command (after which the package is, in part, named) that underlines running text. @@ -250,7 +250,6 @@ loading the package with: \usepackage[normalem]{ulem} \end{verbatim} \end{quote} -Documentation of \Package{ulem} is in the package itself. \begin{ctanrefs} \item[ulem.sty]\CTANref{ulem} \item[soul.sty]\CTANref{soul} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-texsys.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-texsys.tex index f765bc8a9dc..1922410d2d7 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-texsys.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-texsys.tex @@ -1,4 +1,4 @@ -% $Id: faq-texsys.tex,v 1.12 2010/12/11 23:49:08 rf10 Exp $ +% $Id: faq-texsys.tex,v 1.13 2011/10/05 21:46:53 rf10 Exp rf10 $ \section{\TeX{} Systems} @@ -183,6 +183,12 @@ note that it's pretty big). Mac\TeX{} is an instance of \texlive{}, and has a Mac-tailored graphical \texlive{} manager, so that you can keep your distribution up-to-date. +Note that installing Mac\TeX{} requires \texttt{root} privilege. This +is a pity, since it offers several extras that aren't available via a +standard \texlive{}, which aren't therefore available to ``ordinary +folk'' at work. For those who don't have \texttt{root} privilege, the +option is to install using the \texlive{} \texttt{tlinstall} utility. + \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. @@ -225,7 +231,7 @@ German and English. Appropriate memory managers for using em\TeX{} with 386 (and better) processors and under pre-'9x Windows, are included in the distribution. (Em\TeX{} \emph{can} be made to operate under Windows, but even back when it was ``current'', such use wasn't -very actively encouraged. +very actively encouraged.) A version of em\TeX{}, packaged to use a % ! line break \Qref*{TDS directory structure}{Q-tds}, is separately available as an @@ -246,8 +252,10 @@ specialises in direct production of \acro{PDF} from \AllTeX{} input. supported.) For \acro{VAX} systems running Open\acro{VMS}, a \TeX{} distribution -is available, but it seems unlikely that the version on \acro{CTAN} is -the latest available. +is available \acro{CTAN}, but is almost certainly not the latest (it +is more than 10 years old). Whether a version is even available for +current \acro{VMS} (which typically runs on Intel 64-bit processors) +is not clear, but it seems unlikely. For the Atari \acro{ST} and \acro{TT}, \acro{CS}-\TeX{} is available from \acro{CTAN}; it's offered as a set of \acro{ZOO} archives. 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 index 7e6feabdb31..549315ed3be 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-the-end.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-the-end.tex @@ -1,4 +1,4 @@ -% $Id: faq-the-end.tex,v 1.1 2009/06/13 20:56:49 rf10 Exp $ +% $Id: faq-the-end.tex,v 1.2 2011/10/29 07:29:44 rf10 Exp rf10 $ \section{You're still stuck?} @@ -64,7 +64,59 @@ up to date for development purposes. \item[\nothtml{\rmfamily}\acro{FAQ} distribution]\CTANref{faq} \end{ctanrefs} +\Question[Q-bug]{What to do if you find a bug} + +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, the best +starting place is usually to ask in the ``usual places for % ! line break +\Qref*{help on-line}{Q-gethelp}, or just possibly one of the % ! line break +\Qref*{specialised mailing lists}{Q-maillists*}. +The author of the package may well answer on-line, but if no-one +offers any help, you may stand a chance if you mail the author +(presuming that you can find an address\dots{}). + +If you've found a bug in \LaTeXo{}, or some other such unsupported +software, your only real hope is \Qref*{help on-line}{Q-gethelp}. + +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}. +(This of course requires that you have the resources~--- and a +pressing enough need~--- to hire someone.) + + +\htmlignore +\par +\endhtmlignore \Question[Q-latexbug]{Reporting a \LaTeX{} bug} +\htmlignore +\par +\endhtmlignore +% +% This here isn't a reference to a question... +\label{lastquestion} The \LaTeX{} team supports \LaTeX{}, and will deal with % beware line wrap @@ -129,59 +181,6 @@ 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 diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex index 0d033a2c319..040767dec37 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-wdidt.tex @@ -774,10 +774,18 @@ 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. +numbers). As a direct result, it \emph{must} clear the current page +both before and after the \csx{include} command. (The requirement +derives from the difficulties of % ! line break +\begin{hyperversion} + \Qref*{observing page numbers}{Q-wrongpn}.) +\end{hyperversion} +\begin{flatversion} + observing page numbers~--- see \Qref{}{Q-wrongpn}.) +\end{flatversion} +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} diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq.sty b/Master/texmf-dist/doc/generic/FAQ-en/faq.sty index 8cb9690d2c4..5dcf6455821 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq.sty +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq.sty @@ -1,4 +1,4 @@ -% $Id: faq.sty,v 1.131 2011/08/28 10:13:19 rf10 Exp rf10 $ +% $Id: faq.sty,v 1.132 2011/10/25 18:22:56 rf10 Exp rf10 $ % % This is the LaTeX package that deals with the eccentricities of mark % up of the UK TeX FAQ. @@ -1214,6 +1214,7 @@ \newcommand\pkgoption[1]{\texttt{#1}} \newcommand\extension[1]{\texttt{.#1}} \newcommand\ltxcounter[1]{\texttt{#1}} +\newcommand\FontFormat[1]{\texttt{#1}} % deal with tabular: special defs to make texfaq2html doable \let\tbamp& diff --git a/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex b/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex index 40366d463eb..8adf42b3cab 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/filectan.tex @@ -1,4 +1,4 @@ -% $Id: filectan.tex,v 1.138 2011/07/21 19:16:13 rf10 Exp rf10 $ +% $Id: filectan.tex,v 1.139 2011/10/16 22:59:45 rf10 Exp rf10 $ % % protect ourself against being read twice \csname readCTANfiles\endcsname @@ -68,7 +68,6 @@ \CTANfile{modes-file}{fonts/modes/modes.mf}[modes] \CTANfile{mtw}{info/makingtexwork/mtw-1.0.1-html.tar.gz} \CTANfile{multind}{macros/latex209/contrib/misc/multind.sty}[multind] -\CTANfile{musixtex-type1}{fonts/musixtex/ps-type1/musixps-unix.tar.gz} \CTANfile{nextpage}{macros/latex/contrib/misc/nextpage.sty}[nextpage] \CTANfile{noTeX}{biblio/bibtex/utils/misc/noTeX.bst}[notex] \CTANfile{numline}{obsolete/macros/latex/contrib/numline/numline.sty}[numline] @@ -80,7 +79,6 @@ \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}[savesym] -\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.pdf}[simplified-latex] \CTANfile{sober}{macros/latex209/contrib/misc/sober.sty}[sober] @@ -99,8 +97,6 @@ \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{varwidth}{macros/latex/contrib/misc/varwidth.sty}[varwidth] -\CTANfile{version}{macros/latex/contrib/misc/version.sty}[version] \CTANfile{versions}{macros/latex/contrib/versions/versions.sty}[versions] \CTANfile{vf-howto}{info/virtualfontshowto/virtualfontshowto.txt}[vf-howto] \CTANfile{vf-knuth}{info/knuth/virtual-fonts}[vf-knuth] diff --git a/Master/texmf-dist/doc/generic/FAQ-en/gather-faqbody.tex b/Master/texmf-dist/doc/generic/FAQ-en/gather-faqbody.tex index 5febe506021..78a705368ad 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/gather-faqbody.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/gather-faqbody.tex @@ -1,4 +1,4 @@ -\def\faqfileversion{3.23} \def\faqfiledate{2011-09-06} +\def\faqfileversion{3.24} \def\faqfiledate{2011-11-01} % % The above line defines the file version and date, and must remain % the first line with any `assignment' in the file, or things will diff --git a/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf b/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf index 92069cb2b0e..a225aaaa38b 100644 Binary files a/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf and b/Master/texmf-dist/doc/generic/FAQ-en/letterfaq.pdf differ diff --git a/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf b/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf index ca9d685bafa..a6285a73b65 100644 Binary files a/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf and b/Master/texmf-dist/doc/generic/FAQ-en/newfaq.pdf differ -- cgit v1.2.3