From 9fab25beeac99c0295f1a1f3db5aae711e564d72 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 10 Feb 2014 06:20:00 +0100 Subject: [doc] move documentation to ./doc --- doc/filegraph.dot | 287 +++++++ doc/luaotfload-tool.rst | 263 +++++++ doc/luaotfload.dtx | 1994 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 2544 insertions(+) create mode 100644 doc/filegraph.dot create mode 100644 doc/luaotfload-tool.rst create mode 100644 doc/luaotfload.dtx (limited to 'doc') diff --git a/doc/filegraph.dot b/doc/filegraph.dot new file mode 100644 index 0000000..47db9ea --- /dev/null +++ b/doc/filegraph.dot @@ -0,0 +1,287 @@ +strict digraph luaotfload_files { //looks weird with circo ... + compound = true; + +// label = "Schematic of the files included in Luaotfload."; +// labelloc = "b"; + + fontsize = "14.4"; + labelfontname = "Iwona Medium Regular"; + fontname = "Iwona Light Regular"; + size = "21cm"; + + rankdir = LR; + ranksep = 0.618; + nodesep = 1.618; + + edge [ + arrowhead = onormal, + fontname = "Iwona Cond Regular", + penwidth = 1.0, + ]; + node [ + //penwidth = 0.7, + fontname = "Liberation Mono", + fontsize = 12, + ]; + +/* ···································································· + * file structure + * ································································· */ + fontdbutil -> font_names [label="--update", + style=dashed] + + luaotfload -> otfl_fonts_merged [label="merged"] + luaotfload -> merged_lua_libs [label="unmerged", style=solid] + luaotfload -> merged_luatex_fonts [label="unmerged", style=solid] + luaotfload -> merged_context_libs [label="unmerged", style=solid] + + luaotfload -> luaotfload_libs + luaotfload -> otfl_blacklist_cnf + + otfl_fonts_merged -> merged_lua_libs [label="merged", + style=dotted, + lhead=cluster_merged] + otfl_fonts_merged -> merged_luatex_fonts [label="merged", + style=dotted, + lhead=cluster_merged] + otfl_fonts_merged -> merged_context_libs [label="merged", + style=dotted, + lhead=cluster_merged] + + merged_luatex_fonts -> font_age [label="luatex-fonts-enc.lua", + ltail=cluster_merged] + + fontdbutil -> fontdbutil_diagnostics [label="--diagnose"] + + fontdbutil -> status [label="version information"] + + fontdbutil_diagnostics -> status [constraint=no, label="hash files"] + + merged_luatex_fonts -> characters [label="luaotfload-auxiliary.lua", + ltail=cluster_merged] + + luaotfload_libs -> font_names [label="luaotfload-database.lua"] + + mkstatus -> status [label="generates from distribution files", + style=dashed] + + mkglyphlist -> font_age [label="generates from glyphlist.txt", + style=dashed] + + mkcharacters -> characters [label="generates from Context’s char-def.lua", + style=dashed] + + subgraph { rank = same; + mkcharacters; + mkglyphlist; + mkstatus; + fontdbutil; + luaotfload } + +/* ···································································· + * main files + * ································································· */ + + fontdbutil [label = "luaotfload-tool.lua", + shape = rect, + width = "3.2cm", + height = "1.2cm", + color = "#01012222", + style = "filled,rounded", + penwidth=2] + + fontdbutil_diagnostics [label = "luaotfload-diagnostics.lua", + shape = rect, + width = "3.2cm", + height = "1.2cm", + color = "#01012222", + style = "filled,rounded", + penwidth=2] + + mkstatus [label = "mkstatus", + shape = rect, + width = "3.2cm", + height = "1.2cm", + color = "#01012222", + style = "filled,rounded", + penwidth=2] + + mkglyphlist [label = "mkglyphlist", + shape = rect, + width = "3.2cm", + height = "1.2cm", + color = "#01012222", + style = "filled,rounded", + penwidth=2] + + mkcharacters [label = "mkcharacters", + shape = rect, + width = "3.2cm", + height = "1.2cm", + color = "#01012222", + style = "filled,rounded", + penwidth=2] + + luaotfload [label = "luaotfload-main.lua", + shape = rect, + width = "3.2cm", + height = "1.2cm", + color = "#01012222", + style = "filled,rounded", + penwidth=2] + /* + *otfl_fonts [label = "luaotfload-fonts.lua", + * shape = rect, + * width = "3.2cm", + * height = "1.2cm", + * color = "#01012222", + * style = "filled,rounded", + * penwidth=2] + */ + otfl_fonts_merged [label = "luaotfload-fontloader.lua", + shape = rect, + width = "3.2cm", + height = "1.2cm", + color = "#01012222", + style = "filled,rounded", + penwidth=2] + +/* ···································································· + * luaotfload files + * ································································· */ + + characters [style = "filled,dashed", + shape = rect, + width = "3.2cm", + fillcolor = "#01012222", + color = grey40, + style = "filled,dotted,rounded", + label = "luaotfload-characters.lua"] + + font_age [style = "filled,dashed", + shape = rect, + width = "3.2cm", + fillcolor = "#01012222", + color = grey40, + style = "filled,dotted,rounded", + label = "luaotfload-glyphlist.lua"] + + font_names [style = "filled,dashed", + shape = rect, + width = "3.2cm", + fillcolor = "#01012222", + color = grey40, + style = "filled,dotted,rounded", + label = "luaotfload-names.lua.gz\nluaotfload-names.luc"] + + status [style = "filled,dashed", + shape = rect, + width = "3.2cm", + fillcolor = "#01012222", + color = grey40, + style = "filled,dotted,rounded", + label = "luaotfload-status.lua"] + + otfl_blacklist_cnf [style = "filled,dashed", + shape = rect, + width = "3.2cm", + fillcolor = "#01012222", + color = grey40, + style = "filled,dotted,rounded", + label = "luaotfload-blacklist.cnf"] + + luaotfload_libs [ + shape = box, + style = "filled,rounded", + color = "grey90:goldenrod4", + fontsize = 10, + label = < + + + + + + + +
Luaotfload Libraries
luaotfload-auxiliary.lua luaotfload-features.lua
luaotfload-override.lua luaotfload-loaders.lua
luaotfload-log.lua luaotfload-letterspace.lua
luaotfload-parsers.lua luaotfload-database.lua
luaotfload-color.lua
+ >, + ] + +/* ···································································· + * merged files + * ································································· */ + + subgraph cluster_merged { + node [style=filled, color=white]; + style = "filled,rounded"; + color = "grey90:dodgerblue4"; + //nodesep = "3.0"; + rank = same; + label = "Merged Libraries"; + gradientangle=0; + merged_lua_libs; + merged_luatex_fonts; + merged_context_libs; + } + + otfl_fonts_merged -> merged_lua_libs + otfl_fonts_merged -> merged_luatex_fonts + otfl_fonts_merged -> merged_context_libs + + merged_lua_libs [ + shape = box, + style = "filled,rounded", + color = "#FFFFFFAA", + fontsize = 10, + label = < + + + + + + +
Lua Libraries from Context
l-lua.lua l-lpeg.lua l-function.lua
l-string.lua l-table.lua l-io.lua
l-file.lua l-boolean.lua l-math.lua
util-str.lua
+ >, + ] + + merged_luatex_fonts [ + shape = box, + style = "filled,rounded", + color = "#FFFFFFAA", + fontsize = 10, + label = < + + + + + + + + + + + + + +
Font Loader (LuaTeX-Fonts)
luatex-basics-gen.lua luatex-basics-nod.lua
luatex-fonts-enc.lua luatex-fonts-syn.lua
luatex-font-tfm.lua luatex-font-afm.lua
luatex-font-afk.lua luatex-fonts-tfm.lua
luatex-fonts-chr.lua luatex-fonts-lua.lua
luatex-fonts-inj.lua luatex-fonts-otn.lua
luatex-fonts-def.lua luatex-fonts-ext.lua
luatex-fonts-cbk.lua
+ >, + ] + + merged_context_libs [ + shape = box, + style = "filled,rounded", + color = "#FFFFFFAA", + fontsize = 10, + label = < + + + + + + +
Font and Node Libraries from Context
data-con.lua font-ini.lua font-con.lua
font-cid.lua font-map.lua font-oti.lua
font-otf.lua font-otb.lua font-ota.lua
font-def.lua
+ >, + ] +} + +// vim:ft=dot:sw=4:ts=4:expandtab diff --git a/doc/luaotfload-tool.rst b/doc/luaotfload-tool.rst new file mode 100644 index 0000000..6863918 --- /dev/null +++ b/doc/luaotfload-tool.rst @@ -0,0 +1,263 @@ +======================================================================= + luaotfload-tool +======================================================================= + +----------------------------------------------------------------------- + generate and query the Luaotfload font names database +----------------------------------------------------------------------- + +:Date: 2014-01-02 +:Copyright: GPL v2.0 +:Version: 2.5 +:Manual section: 1 +:Manual group: text processing + +SYNOPSIS +======================================================================= + +**luaotfload-tool** [ -bDfFiIlnpquvVhw ] + +**luaotfload-tool** --update [ --force ] [ --quiet ] [ --verbose ] + [ --prefer-texmf ] [ --dry-run ] + [ --formats=[+|-]EXTENSIONS ] + [ --no-compress ] [ --no-strip ] + +**luaotfload-tool** --find=FONTNAME [ --fuzzy ] [ --info ] [ --inspect ] + [ --no-reload ] + +**luaotfload-tool** --flush-lookups + +**luaotfload-tool** --cache=DIRECTIVE + +**luaotfload-tool** --list=CRITERION[:VALUE] [ --fields=F1,F2,...,Fn ] + +**luaotfload-tool** --help + +**luaotfload-tool** --version + +**luaotfload-tool** --show-blacklist + +**luaotfload-tool** --diagnose=CHECK + +DESCRIPTION +======================================================================= + +luaotfload-tool accesses the font names database that is required by +the *Luaotfload* package. There are two general modes: **update** and +**query**. + ++ **update**: update the database or rebuild it entirely; ++ **query**: resolve a font name or display close matches. + +OPTIONS +======================================================================= + +update mode +----------------------------------------------------------------------- +--update, -u Update the database; indexes new fonts. +--force, -f Force rebuilding of the database; re-indexes + all fonts. +--no-reload, -n Suppress auto-updates to the database (e.g. + when ``--find`` is passed an unknown name). +--no-strip Do not strip redundant information after + building the database. Warning: this will + inflate the index to about two to three times + the normal size. +--no-compress, -c Do not filter the plain text version of the + font index through gzip. Useful for debugging + if your editor is built without zlib. + +--prefer-texmf, -p Organize the file name database in a way so + that it prefer fonts in the *TEXMF* tree over + system fonts if they are installed in both. +--max-fonts=N Process at most *N* font files, including fonts + already indexed in the count. +--formats=EXTENSIONS Extensions of the font files to index. + Where *EXTENSIONS* is a comma-separated list of + supported file extensions (otf, ttf, ttc, + dfont, pfa, and pfb). If the list is prefixed + with a ``+`` sign, the given list is added to + the currently active one; ``-`` subtracts. + Default: *otf,ttf,ttc,dfont*. + Examples: + + 1) ``--formats=-ttc,ttf`` would skip + TrueType fonts and font collections; + 2) ``--formats=otf`` would scan only OpenType + files; + 3) ``--formats=+pfb`` includes binary + Postscript files. **Warning**: with a + standard TeX Live installation this will + grow the database considerably and slow down + font indexing. + +--dry-run, -D Don’t load fonts, scan directories only. + (For debugging file system related issues.) + +query mode +----------------------------------------------------------------------- +--find=NAME Resolve a font name; this looks up in + the database and prints the file name it is + mapped to. + ``--find`` also understands request syntax, + i.e. ``--find=file:foo.otf`` checks whether + ``foo.otf`` is indexed. +--fuzzy, -F Show approximate matches to the file name if + the lookup was unsuccessful (requires + ``--find``). + +--info, -i Display basic information to a resolved font + file (requires ``--find``). +--inspect, -I Display detailed information by loading the + font and analyzing the font table; very slow! + For the meaning of the returned fields see + the LuaTeX documentation. + (requires ``--find``). +--warnings, -w Print the warnings generated by the fontloader + library (assumes ``-I``). Automatically enabled + if the verbosity level exceeds 2. + +--show-blacklist, -b Show blacklisted files (not directories). +--list=CRITERION Show entries, where *CRITERION* is one of the + following: + + 1) the character ``*``, selecting all entries; + 2) a field of a database entry, for instance + *version* or *format**, according to which + the output will be sorted. + Information in an unstripped database (see + the option ``--no-strip`` above) is nested: + Subfields of a record can be addressed using + the ``->`` separator, e. g. + ``file->location``, ``style->units_per_em``, + or + ``names->sanitized->english->prefmodifiers``. + NB: shell syntax requires that arguments + containing ``->`` be properly quoted! + 3) an expression of the form ``field:value`` to + limit the output to entries whose ``field`` + matches ``value``. + + For example, in order to output file names and + corresponding versions, sorted by the font + format:: + + ./luaotfload-tool.lua --list="format" --fields="file->base,version" + + This prints:: + + otf latinmodern-math.otf Version 1.958 + otf lmromancaps10-oblique.otf 2.004 + otf lmmono8-regular.otf 2.004 + otf lmmonoproplt10-bold.otf 2.004 + otf lmsans10-oblique.otf 2.004 + otf lmromanslant8-regular.otf 2.004 + otf lmroman12-italic.otf 2.004 + otf lmsansdemicond10-oblique.otf 2.004 + ... + +--fields=FIELDS Comma-separated list of fields that should be + printed. + Information in an unstripped database (see the + option ``--no-strip`` above) is nested: + Subfields of a record can be addressed using + the ``->`` separator, e. g. + ``file->location``, ``style->units_per_em``, + or ``names->sanitized->english->subfamily``. + The default is plainname,version*. + (Only meaningful with ``--list``.) + +font and lookup caches +----------------------------------------------------------------------- +--flush-lookups Clear font name lookup cache (experimental). + +--cache=DIRECTIVE Cache control, where *DIRECTIVE* is one of the + following: + + 1) ``purge`` -> delete Lua files from cache; + 2) ``erase`` -> delete Lua and Luc files from + cache; + 3) ``show`` -> print stats. + +miscellaneous +----------------------------------------------------------------------- +--verbose=N, -v Set verbosity level to *n* or the number of + repetitions of ``-v``. +--quiet No verbose output (log level set to zero). +--log=CHANNEL Redirect log output (for database + troubleshooting), where *CHANNEL* can be + + 1) ``stdout`` -> all output will be + dumped to the terminal (default); or + 2) ``file`` -> write to a file to the temporary + directory (the name will be chosen + automatically. + +--version, -V Show version numbers of components as well as + some basic information and exit. +--help, -h Show help message and exit. + +--diagnose=CHECK Run the diagnostic procedure *CHECK*. Available + procedures are: + + 1) ``files`` -> check *Luaotfload* files for + modifications; + 2) ``permissions`` -> check permissions of + cache directories and files; + 3) ``environment`` -> print relevant + environment and kpse variables; + 4) ``repository`` -> check the git repository + for new releases, + 5) ``index`` -> check database, display + information about it. + + Procedures can be chained by concatenating with + commas, e.g. ``--diagnose=files,permissions``. + Specify ``thorough`` to run all checks. + +FILES +======================================================================= + +The font name database is usually located in the directory +``texmf-var/luatex-cache/generic/names/`` (``$TEXMFCACHE`` as set in +``texmf.cnf``) of your *TeX Live* distribution as a zlib-compressed +file ``luaotfload-names.lua.gz``. +The experimental lookup cache will be created as +``luaotfload-lookup-cache.lua`` in the same directory. +These Lua tables are not used directly by Luaotfload, though. +Instead, they are compiled to Lua bytecode which is written to +corresponding files with the extension ``.luc`` in the same directory. +When modifying the files by hand keep in mind that only if the bytecode +files are missing will Luaotfload use the plain version instead. +Both kinds of files are safe to delete, at the cost of regenerating +them with the next run of *LuaTeX*. + +SEE ALSO +======================================================================= + +**luatex** (1), **lua** (1) + +* ``texdoc luaotfload`` to display the manual for the *Luaotfload* + package +* Luaotfload development ``_ +* LuaLaTeX mailing list ``_ +* LuaTeX ``_ +* ConTeXt ``_ +* Luaotfload on CTAN ``_ + +BUGS +======================================================================= + +Tons, probably. + +AUTHORS +======================================================================= + +*Luaotfload* is maintained by the LuaLaTeX dev team +(``__). +The fontloader code is provided by Hans Hagen of Pragma ADE, Hasselt +NL (``__). + +This manual page was written by Philipp Gesang +. + diff --git a/doc/luaotfload.dtx b/doc/luaotfload.dtx new file mode 100644 index 0000000..e0311a4 --- /dev/null +++ b/doc/luaotfload.dtx @@ -0,0 +1,1994 @@ +% \iffalse meta-comment +% +% Copyright (C) 2009-2014 +% by Elie Roux +% and Khaled Hosny +% and Philipp Gesang +% +% Home: https://github.com/lualatex/luaotfload +% Support: . +% +% This work is under the GPL v2.0 license. +% +% This work consists of the main source file luaotfload.dtx +% and the derived files +% luaotfload.sty +% +% Unpacking: +% tex luaotfload.dtx +% +% Documentation: +% lualatex luaotfload.dtx +% +% The class ltxdoc loads the configuration file ltxdoc.cfg +% if available. Here you can specify further options, e.g. +% use A4 as paper format: +% \PassOptionsToClass{a4paper}{article} +% +% +% +%<*ignore> +\begingroup + \def\x{LaTeX2e}% +\expandafter\endgroup +\ifcase 0\ifx\install y1\fi\expandafter + \ifx\csname processbatchFile\endcsname\relax\else1\fi + \ifx\fmtname\x\else 1\fi\relax +\else\csname fi\endcsname +% +%<*install> +\input docstrip.tex +\Msg{************************************************************************} +\Msg{* Installation} +\Msg{* Package: luaotfload v2.5 OpenType layout system} +\Msg{************************************************************************} + +\keepsilent +\askforoverwritefalse + +\let\MetaPrefix\relax + +\preamble +This is a generated file. + +Copyright (C) 2009-2014 + by Elie Roux + and Khaled Hosny + and Philipp Gesang + + Home: https://github.com/lualatex/luaotfload + Support: . + +This work is under the GPL v2.0 license. + +This work consists of the main source file luaotfload.dtx +and the derived files + luaotfload.sty + +\endpreamble + +\obeyspaces +\Msg{************************************************************************} +\Msg{*} +\Msg{* To finish the installation you have to move the following} +\Msg{* files into a directory searched by TeX:} +\Msg{*} +\Msg{* luaotfload.sty} +\Msg{*} +\Msg{* Happy TeXing!} +\Msg{*} +\Msg{************************************************************************} + +\endbatchfile +% +%<*ignore> +\fi +% +%<*driver> +\NeedsTeXFormat{LaTeX2e} +\ProvidesFile{luaotfload.drv}% +[2014/**/** v2.5 OpenType layout system]% +\documentclass{ltxdoc} +\usepackage{metalogo,multicol,mdwlist,fancyvrb,xspace} +\usepackage[x11names]{xcolor} +% +\def\primarycolor{DodgerBlue4} %%-> rgb 16 78 139 | #104e8b +\def\secondarycolor{Goldenrod4} %%-> rgb 139 105 200 | #8b6914 +% +\usepackage[ + bookmarks=true, + colorlinks=true, + linkcolor=\primarycolor, + urlcolor=\secondarycolor, + citecolor=\primarycolor, + pdftitle={The luaotfload package}, + pdfsubject={OpenType layout system for Plain TeX and LaTeX}, + pdfauthor={Elie Roux & Khaled Hosny & Philipp Gesang}, + pdfkeywords={luatex, lualatex, unicode, opentype} +]{hyperref} +\usepackage{fontspec} +\usepackage{unicode-math} +\setmainfont[ +% Numbers = OldStyle, %% buggy with font cache + Ligatures = TeX, + BoldFont = {Linux Libertine O Bold}, + ItalicFont = {Linux Libertine O Italic}, + SlantedFont = {Linux Libertine O Italic}, +]{Linux Libertine O} +\setmonofont[Ligatures=TeX,Scale=MatchLowercase]{Liberation Mono} +%setsansfont[Ligatures=TeX]{Linux Biolinum O} +\setsansfont[Ligatures=TeX,Scale=MatchLowercase]{Iwona Medium} +%setmathfont{XITS Math} + +\usepackage{hologo} + +\newcommand\TEX {\TeX\xspace} +\newcommand\LUA {Lua\xspace} +\newcommand\PDFTEX {pdf\TeX\xspace} +\newcommand\LUATEX {Lua\TeX\xspace} +\newcommand\XETEX {\XeTeX\xspace} +\newcommand\LATEX {\LaTeX\xspace} +\newcommand\LUALATEX {Lua\LaTeX\xspace} +\newcommand\CONTEXT {Con\TeX t\xspace} +\newcommand\OpenType {\identifier{Open\kern-.25ex Type}\xspace} + +\def\definehighlight[#1][#2]% + {\ifcsname #1\endcsname\else + \expandafter\def\csname #1\endcsname% + {\bgroup#2\csname #1_indeed\endcsname} + \expandafter\def\csname #1_indeed\endcsname##1% + {##1\egroup}% + \fi} + +\def\restoreunderscore{\catcode`\_=12\relax} + +\definehighlight [fileent][\ttfamily\restoreunderscore] %% files, dirs +\definehighlight [texmacro][\sffamily\itshape\textbackslash] %% cs +\definehighlight[luafunction][\sffamily\itshape\restoreunderscore] %% lua identifiers +\definehighlight [identifier][\sffamily] %% names +\definehighlight [abbrev][\rmfamily\scshape] %% acronyms +\definehighlight [emphasis][\rmfamily\slshape] %% level 1 emph + +\newcommand*\email[1]{\href{mailto:#1}{#1}} + +\renewcommand\partname{Part}%% gets rid of the stupid “file” heading + +\usepackage{syntax}%% bnf for font request syntax + +\usepackage{titlesec} + +\def\movecountertomargin#1{\llap{\rmfamily\upshape#1\hskip2em}} +\def\zeropoint{0pt} +\titleformat \part + {\normalsize\rmfamily\bfseries} + {\movecountertomargin\thepart} \zeropoint {} +\titleformat \section + {\normalsize\rmfamily\scshape} + {\movecountertomargin\thesection} \zeropoint {} +\titleformat \subsection + {\small\rmfamily\itshape} + {\movecountertomargin\thesubsection} \zeropoint {} +\titleformat \subsubsection + {\normalsize\rmfamily\upshape} + {\movecountertomargin\thesubsubsection} \zeropoint {} + +\usepackage{tocloft} +\renewcommand \cftpartfont {\rmfamily\upshape} +\renewcommand \cftsecfont {\rmfamily\upshape} +\renewcommand \cftsubsecfont {\rmfamily\upshape} +\setlength \cftbeforepartskip {1ex} +\setlength \cftbeforesecskip {1ex} + +\VerbatimFootnotes +\begin{document} + \DocInput{luaotfload.dtx}% +\end{document} +% +% \fi +% +% \CheckSum{0} +% +% \CharacterTable +% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +% Digits \0\1\2\3\4\5\6\7\8\9 +% Exclamation \! Double quote \" Hash (number) \# +% Dollar \$ Percent \% Ampersand \& +% Acute accent \' Left paren \( Right paren \) +% Asterisk \* Plus \+ Comma \, +% Minus \- Point \. Solidus \/ +% Colon \: Semicolon \; Less than \< +% Equals \= Greater than \> Question mark \? +% Commercial at \@ Left bracket \[ Backslash \\ +% Right bracket \] Circumflex \^ Underscore \_ +% Grave accent \` Left brace \{ Vertical bar \| +% Right brace \} Tilde \~} +% +% \GetFileInfo{luaotfload.drv} +% +% \title{The \identifier{luaotfload} package} +% \date{2014/**/** v2.5} +% \author{Elie Roux · Khaled Hosny · Philipp Gesang\\ +% Home: \url{https://github.com/lualatex/luaotfload}\\ +% Support: \email{lualatex-dev@tug.org}} +% +% \maketitle +% +% \begin{abstract} +% This package is an adaptation of the \CONTEXT font loading system. +% It allows for loading \OpenType fonts with an extended syntax and adds +% support for a variety of font features. +% \end{abstract} +% +% \tableofcontents +% +% \part{Package Description} +% +% \section{Introduction} +% +% Font management and installation has always been painful with \TEX. A lot of +% files are needed for one font (\abbrev{tfm}, \abbrev{pfb}, \abbrev{map}, +% \abbrev{fd}, \abbrev{vf}), and due to the 8-Bit encoding each font is limited +% to 256 characters. +% But the font world has evolved since the original +% \TEX, and new typographic systems have appeared, most notably the so +% called \emphasis{smart font} technologies like \OpenType +% fonts (\abbrev{otf}). +% These fonts can contain many more characters than \TEX fonts, as well as additional +% functionality like ligatures, old-style numbers, small capitals, +% etc., and support more complex writing systems like Arabic and +% Indic\footnote{% +% Unfortunately, \identifier{luaotfload} doesn‘t support many Indic +% scripts right now. +% Assistance in implementing the prerequisites is greatly +% appreciated. +% } +% scripts. +% \OpenType fonts are widely deployed and available for all +% modern operating systems. +% As of 2013 they have become the de facto standard for advanced text +% layout. +% However, until recently the only way to use them directly in the \TEX +% world was with the \XETEX engine. +% +% Unlike \XETEX, \LUATEX has no built-in support for +% \OpenType or technologies other than the original \TEX fonts. +% Instead, it provides hooks for executing \LUA code during the \TEX run +% that allow implementing extensions for loading fonts and manipulating +% how input text is processed without modifying the underlying engine. +% This is where \identifier{luaotfload} comes into play: +% Based on code from \CONTEXT, it extends \LUATEX with functionality necessary +% for handling \OpenType fonts. +% Additionally, it provides means for accessing fonts known to the operating +% system conveniently by indexing the metadata. +% +% +% \section{Thanks} +% +% \identifier{Luaotfload} is part of \LUALATEX, the community-driven +% project to provide a foundation for using the \LATEX format with the +% full capabilites of the \LUATEX engine. +% As such, the distinction between end users, contributors, and project +% maintainers is intentionally kept less strict, lest we unduly +% personalize the common effort. +% +% Nevertheless, the current maintainers would like to express their +% gratitude to Khaled Hosny, Akira Kakuto, Hironori Kitagawa and Dohyun +% Kim. +% Their contributions -- be it patches, advice, or systematic +% testing -- made the switch from version 1.x to 2.2 possible. +% Also, Hans Hagen, the author of the font loader, made porting the +% code to \LATEX a breeze due to the extra effort he invested into +% isolating it from the rest of \CONTEXT, not to mention his assistance +% in the task and willingness to respond to our suggestions. +% +% +% \section{Loading Fonts} +% +% \identifier{luaotfload} supports an extended font request syntax: +% +% \begin{quote} +% |\font\foo={|% +% \meta{prefix}|:|% +% \meta{font name}|:|% +% \meta{font features}|}|% +% \meta{\TEX font features} +% \end{quote} +% +% \noindent +% The curly brackets are optional and escape the spaces in the enclosed +% font name. +% Alternatively, double quotes serve the same purpose. +% A selection of individual parts of the syntax are discussed below; +% for a more formal description see figure \ref{font-syntax}. +% +% \begin{figure}[b] +% \setlength\grammarparsep{12pt plus 2pt minus 2pt} +% \setlength\grammarindent{5cm} +% \begingroup +% \small +% \begin{grammar} +% ::= `\\font', {\sc csname}, `=', , [ ] ; +% +% ::= `at', {\sc dimension} ; +% +% ::= `"', `"' +% \alt `{', `}' +% \alt ; +% +% ::= , [`:', ] +% \alt `[', `]', [ [`:'], ] ; +% +% ::= , [ ], \{ \} +% \alt , \{ \} ; +% +% ::= `file:', +% \alt `name:', ; +% +% ::= \{ \} ; +% +% ::= \{ \} ; +% +% ::= {\sc tfmname} | ; +% +% ::= \{ {\sc all_characters} - `]' \} ; +% +% ::= `/', (`I' | `B' | `BI' | `IB' | `S=', \{ {\sc digit} \} ) ; +% +% ::= `(', \{ {\sc digit} \}, `)' ; +% +% ::= , \{ `;', \} ; +% +% ::= {\sc feature_id}, `=', {\sc feature_value} +% \alt , {\sc feature_id} ; +% +% ::= `+' | `-' ; +% +% ::= {\sc all_characters} - ( `(' | `/' | `:' ) ; +% \end{grammar} +% \endgroup +% \caption{Font request syntax. +% Braces or double quotes around the +% \emphasis{specification} rule will +% preserve whitespace in file names. +% In addition to the font style modifiers +% (\emphasis{slash-notation}) given above, there +% are others that are recognized but will be silently +% ignored: {\ttfamily aat}, +% {\ttfamily icu}, and +% {\ttfamily gr}. +% The special terminals are: +% {\sc feature\textunderscore id} for a valid font +% feature name and +% {\sc feature\textunderscore value} for the corresponding +% value. +% {\sc tfmname} is the name of a \abbrev{tfm} file. +% {\sc digit} again refers to bytes 48--57, and +% {\sc all\textunderscore characters} to all byte values. +% {\sc csname} and {\sc dimension} are the \TEX concepts.} +% \label{font-syntax} +% \end{figure} +% +% \subsection{Prefix -- the \identifier{luaotfload}{ }Way} +% +% In \identifier{luaotfload}, the canonical syntax for font requests +% requires a \emphasis{prefix}: +% \begin{quote} +% |\font\fontname=|\meta{prefix}|:|\meta{fontname}\dots +% \end{quote} +% where \meta{prefix} is either \verb|file:| or \verb|name:|.\footnote{% +% The development version also knows two further prefixes, +% \verb|kpse:| and \verb|my:|. +% A \verb|kpse| lookup is restricted to files that can be found by +% \identifier{kpathsea} and +% will not attempt to locate system fonts. +% This behavior can be of value when an extra degree of encapsulation is +% needed, for instance when supplying a customized tex distribution. +% +% The \verb|my| lookup takes this a step further: it lets you define +% a custom resolver function and hook it into the \luafunction{resolve_font} +% callback. +% This ensures full control over how a file is located. +% For a working example see the +% \href{https://bitbucket.org/phg/lua-la-tex-tests/src/5f6a535d/pln-lookup-callback-1.tex} +% {test repo}. +% } +% It determines whether the font loader should interpret the request as +% a \emphasis{file name} or +% \emphasis{font name}, respectively, +% which again influences how it will attempt to locate the font. +% Examples for font names are +% “Latin Modern Italic”, +% “GFS Bodoni Rg”, and +% “PT Serif Caption” +% -- they are the human readable identifiers +% usually listed in drop-down menus and the like.\footnote{% +% Font names may appear like a great choice at first because they +% offer seemingly more intuitive identifiers in comparison to arguably +% cryptic file names: +% “PT Sans Bold” is a lot more descriptive than \fileent{PTS75F.ttf}. +% On the other hand, font names are quite arbitrary and there is no +% universal method to determine their meaning. +% While \identifier{luaotfload} provides fairly sophisticated heuristic +% to figure out a matching font style, weight, and optical size, it +% cannot be relied upon to work satisfactorily for all font files. +% For an in-depth analysis of the situation and how broken font names +% are, please refer to +% \href{http://www.ntg.nl/pipermail/ntg-context/2013/073889.html} +% {this post} +% by Hans Hagen, the author of the font loader. +% If in doubt, use filenames. +% \fileent{luaotfload-tool} can perform the matching for you with the +% option \verb|--find=|, and you can use the file name it returns +% in your font definition. +% } +% In order for fonts installed both in system locations and in your +% \fileent{texmf} to be accessible by font name, \identifier{luaotfload} must +% first collect the metadata included in the files. +% Please refer to section~\ref{sec:fontdb} below for instructions on how to +% create the database. +% +% File names are whatever your file system allows them to be, except +% that that they may not contain the characters +% \verb|(|, +% \verb|:|, and +% \verb|/|. +% As is obvious from the last exception, the \verb|file:| lookup will +% not process paths to the font location -- only those +% files found when generating the database are addressable this way. +% Continue below in the \XETEX section if you need to load your fonts +% by path. +% The file names corresponding to the example font names above are +% \fileent{lmroman12-italic.otf}, +% \fileent{GFSBodoni.otf}, and +% \fileent{PTZ56F.ttf}. +% +% \subsection{Compatibility Layer} +% +% In addition to the regular prefixed requests, \identifier{luaotfload} +% accepts loading fonts the \XETEX way. +% There are again two modes: bracketed and unbracketed. +% A bracketed request looks as follows. +% +% \begin{quote} +% |\font\fontname=[|\meta{path to file}|]| +% \end{quote} +% +% \noindent +% Inside the square brackets, every character except for a closing +% bracket is permitted, allowing for specifying paths to a font file. +% Naturally, path-less file names are equally valid and processed the +% same way as an ordinary \verb|file:| lookup. +% +% \begin{quote} +% |\font\fontname=|\meta{font name} \dots +% \end{quote} +% +% Unbracketed (or, for lack of a better word: \emphasis{anonymous}) +% font requests resemble the conventional \TEX syntax. +% However, they have a broader spectrum of possible interpretations: +% before anything else, \identifier{luaotfload} attempts to load a +% traditional \TEX Font Metric (\abbrev{tfm} or \abbrev{ofm}). +% If this fails, it performs a \verb|name:| lookup, which itself will +% fall back to a \verb|file:| lookup if no database entry matches +% \meta{font name}. +% +% Furthermore, \identifier{luaotfload} supports the slashed (shorthand) +% font style notation from \XETEX. +% +% \begin{quote} +% |\font\fontname=|\meta{font name}|/|\meta{modifier}\dots +% \end{quote} +% +% \noindent +% Currently, four style modifiers are supported: +% \verb|I| for italic shape, +% \verb|B| for bold weight, +% \verb|BI| or \verb|IB| for the combination of both. +% Other “slashed” modifiers are too specific to the \XETEX engine and +% have no meaning in \LUATEX. +% +% \subsection{Examples} +% +% \subsubsection{Loading by File Name} +% +% For example, conventional \abbrev{type1} font can be loaded with a \verb|file:| +% request like so: +% +% \begin{quote} +% \begin{verbatim} +% \font\lmromanten={file:ec-lmr10} at 10pt +% \end{verbatim} +% \end{quote} +% +% The \OpenType version of Janusz Nowacki’s font \emphasis{Antykwa +% Półtawskiego}\footnote{% +% \url{http://jmn.pl/antykwa-poltawskiego/}, also available in +% in \TEX Live. +% } +% in its condensed variant can be loaded as follows: +% +% \begin{quote} +% \begin{verbatim} +% \font\apcregular=file:antpoltltcond-regular.otf at 42pt +% \end{verbatim} +% \end{quote} +% +% The next example shows how to load the \emphasis{Porson} font digitized by +% the Greek Font Society using \XETEX-style syntax and an absolute path from a +% non-standard directory: +% +% \begin{quote} +% \begin{verbatim} +% \font\gfsporson="[/tmp/GFSPorson.otf]" at 12pt +% \end{verbatim} +% \end{quote} +% +% \subsubsection{Loading by Font Name} +% +% The \verb|name:| lookup does not depend on cryptic filenames: +% +% \begin{quote} +% \begin{verbatim} +% \font\pagellaregular={name:TeX Gyre Pagella} at 9pt +% \end{verbatim} +% \end{quote} +% +% A bit more specific but essentially the same lookup would be: +% +% \begin{quote} +% \begin{verbatim} +% \font\pagellaregular={name:TeX Gyre Pagella Regular} at 9pt +% \end{verbatim} +% \end{quote} +% +% \noindent +% Which fits nicely with the whole set: +% +% \begin{quote} +% \begin{verbatim} +% \font\pagellaregular ={name:TeX Gyre Pagella Regular} at 9pt +% \font\pagellaitalic ={name:TeX Gyre Pagella Italic} at 9pt +% \font\pagellabold ={name:TeX Gyre Pagella Bold} at 9pt +% \font\pagellabolditalic={name:TeX Gyre Pagella Bolditalic} at 9pt +% +% {\pagellaregular foo bar baz\endgraf} +% {\pagellaitalic foo bar baz\endgraf} +% {\pagellabold foo bar baz\endgraf} +% {\pagellabolditalic foo bar baz\endgraf} +% +% ... +% \end{verbatim} +% \end{quote} +% +% \subsubsection{Modifiers} +% +% If the entire \emphasis{Iwona} family\footnote{% +% \url{http://jmn.pl/kurier-i-iwona/}, +% also in \TEX Live. +% } +% is installed in some location accessible by \identifier{luaotfload}, +% the regular shape can be loaded as follows: +% +% \begin{quote} +% \begin{verbatim} +% \font\iwona=Iwona at 20pt +% \end{verbatim} +% \end{quote} +% +% \noindent +% To load the most common of the other styles, the slash notation can +% be employed as shorthand: +% +% \begin{quote} +% \begin{verbatim} +% \font\iwonaitalic =Iwona/I at 20pt +% \font\iwonabold =Iwona/B at 20pt +% \font\iwonabolditalic=Iwona/BI at 20pt +% \end{verbatim} +% \end{quote} +% +% \noindent +% which is equivalent to these full names: +% +% \begin{quote} +% \begin{verbatim} +% \font\iwonaitalic ="Iwona Italic" at 20pt +% \font\iwonabold ="Iwona Bold" at 20pt +% \font\iwonabolditalic="Iwona BoldItalic" at 20pt +% \end{verbatim} +% \end{quote} +% +% \section{Font features} +% +% \emphasis{Font features} are the second to last component in the +% general scheme for font requests: +% +% \begin{quote} +% |\font\foo={|% +% \meta{prefix}|:|% +% \meta{font name}|:|% +% \meta{font features}|}|% +% \meta{\TEX font features} +% \end{quote} +% +% \noindent +% If style modifiers are present (\XETEX style), they must precede +% \meta{font features}. +% +% The element \meta{font features} is a semicolon-separated list of feature +% tags\footnote{% +% Cf. \url{http://www.microsoft.com/typography/otspec/featurelist.htm}. +% } +% and font options. +% Prepending a font feature with a |+| (plus sign) enables it, whereas +% a |-| (minus) disables it. For instance, the request +% +% \begin{quote} +% \begin{verbatim} +% \font\test=LatinModernRoman:+clig;-kern +% \end{verbatim} +% \end{quote} +% +% \noindent activates contextual ligatures (|clig|) and disables +% kerning (|kern|). +% Alternatively the options |true| or |false| can be passed to +% the feature in a key/value expression. +% The following request has the same meaning as the last one: +% +% \begin{quote} +% \begin{verbatim} +% \font\test=LatinModernRoman:clig=true;kern=false +% \end{verbatim} +% \end{quote} +% +% \noindent +% Furthermore, this second syntax is required should a font feature +% accept other options besides a true/false switch. +% For example, \emphasis{stylistic alternates} (|salt|) are variants of given +% glyphs. +% They can be selected either explicitly by supplying the variant +% index (starting from one), or randomly by setting the value to, +% obviously, |random|. +% +% \iffalse TODO verify that this actually works with a font that supports +% the salt/random feature!\fi +% \begin{quote} +% \begin{verbatim} +% \font\librmsaltfirst=LatinModernRoman:salt=1 +% \end{verbatim} +% \end{quote} +% +% \noindent Other font options include: +% +% \begin{description} +% +% \item [mode] \hfill \\ +% \identifier{luaotfload} has two \OpenType processing +% \emphasis{modes}: +% \identifier{base} and \identifier{node}. +% +% \identifier{base} mode works by mapping \OpenType +% features to traditional \TEX ligature and kerning mechanisms. +% Supporting only non-contextual substitutions and kerning +% pairs, it is the slightly faster, albeit somewhat limited, variant. +% \identifier{node} mode works by processing \TeX’s internal +% node list directly at the \LUA end and supports +% a wider range of \OpenType features. +% The downside is that the intricate operations required for +% \identifier{node} mode may slow down typesetting especially +% with complex fonts and it does not work in math mode. +% +% By default \identifier{luaotfload} is in \identifier{node} +% mode, and \identifier{base} mode has to be requested where needed, +% e.~g. for math fonts. +% +% \item [script] \label{script-tag} \hfill \\ +% An \OpenType script tag;\footnote{% +% See \url{http://www.microsoft.com/typography/otspec/scripttags.htm} +% for a list of valid values. +% For scripts derived from the Latin alphabet the value +% |latn| is good choice. +% } +% the default value is |dlft|. +% Some fonts, including very popular ones by foundries like Adobe, +% do not assign features to the |dflt| script, in +% which case the script needs to be set explicitly. +% +% \item [language] \hfill \\ +% An \OpenType language system identifier,\footnote{% +% Cf. \url{http://www.microsoft.com/typography/otspec/languagetags.htm}. +% } +% defaulting to |dflt|. +% +% \item [featurefile] \hfill \\ +% A comma-separated list of feature files to be applied to the +% font. +% Feature files contain a textual representation of +% \OpenType tables and extend the features of a font +% on fly. +% After they are applied to a font, features defined in a +% feature file can be enabled or disabled just like any +% other font feature. +% The syntax is documented in \identifier{Adobe}’s +% \OpenType Feature File Specification.\footnote{% +% Cf. \url{http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. +% } +% +% For a demonstration of how to set a |tkrn| feature consult +% the file |tkrn.fea| that is part of \identifier{luaotfload}. +% It can be read and applied as follows: +% +% |\font\test=Latin Modern Roman:featurefile=tkrn.fea;+tkrn| +% +% \item [color] \hfill \\ +% A font color, defined as a triplet of two-digit hexadecimal +% \abbrev{rgb} values, with an optional fourth value for +% transparency +% (where |00| is completely transparent and |FF| is opaque). +% +% For example, in order to set text in semitransparent red: +% +% \begin{quote} +% \begin{verbatim} +% \font\test={Latin Modern Roman}:color=FF0000BB +% \end{verbatim} +% \end{quote} +% +% \item [kernfactor \& letterspace] \hfill \\ +% Define a font with letterspacing (tracking) enabled. +% In \identifier{luaotfload}, letterspacing is implemented by +% inserting additional kerning between glyphs. +% +% This approach is derived from and still quite similar to the +% \emphasis{character kerning} (\texmacro{setcharacterkerning} / +% \texmacro{definecharacterkerning} \& al.) functionality of +% Context, see the file \fileent{typo-krn.lua} there. +% The main difference is that \identifier{luaotfload} does not +% use \LUATEX attributes to assign letterspacing to regions, +% but defines virtual letterspaced versions of a font. +% +% The option \identifier{kernfactor} accepts a numeric value that +% determines the letterspacing factor to be applied to the font +% size. +% E.~g. a kern factor of $0.42$ applied to a $10$ pt font +% results in $4.2$ pt of additional kerning applied to each +% pair of glyphs. +% Ligatures are split into their component glyphs unless +% explicitly ignored (see below). +% +% For compatibility with \XETEX an alternative +% \identifier{letterspace} option is supplied that interprets the +% supplied value as a \emphasis{percentage} of the font size but +% is otherwise identical to \identifier{kernfactor}. +% Consequently, both definitions in below snippet yield the same +% letterspacing width: +% +% \begin{quote} +% \begin{verbatim} +% \font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" +% \font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" +% \end{verbatim} +% \end{quote} +% +% Specific pairs of letters and ligatures may be exempt from +% letterspacing by defining the \LUA functions +% \luafunction{keeptogether} and \luafunction{keepligature}, +% respectively, inside the namespace \verb|luaotfload.letterspace|. +% Both functions are called whenever the letterspacing callback +% encounters an appropriate node or set of nodes. +% If they return a true-ish value, no extra kern is inserted at +% the current position. +% \luafunction{keeptogether} receives a pair of consecutive +% glyph nodes in order of their appearance in the node list. +% \luafunction{keepligature} receives a single node which can be +% analyzed into components. +% (For details refer to the \emphasis{glyph nodes} section in the +% \LUATEX reference manual.) +% The implementation of both functions is left entirely to the +% user. +% +% +% \item [protrusion \& expansion] \hfill \\ +% These keys control microtypographic features of the font, +% namely \emphasis{character protrusion} and \emphasis{font +% expansion}. +% Their arguments are names of \LUA tables that contain +% values for the respective features.\footnote{% +% For examples of the table layout please refer to the +% section of the file \fileent{luaotfload-fonts-ext.lua} where the +% default values are defined. +% Alternatively and with loss of information, you can dump +% those tables into your terminal by issuing +% \begin{verbatim} +% \directlua{inspect(fonts.protrusions.setups.default) +% inspect(fonts.expansions.setups.default)} +% \end{verbatim} +% at some point after loading \fileent{luaotfload.sty}. +% } +% For both, only the set \identifier{default} is predefined. +% +% For example, to define a font with the default +% protrusion vector applied\footnote{% +% You also need to set +% \verb|pdfprotrudechars=2| and +% \verb|pdfadjustspacing=2| +% to activate protrusion and expansion, respectively. +% See the +% \href{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% +% {\PDFTEX manual} +% for details. +% }: +% +% \begin{quote} +% \begin{verbatim} +% \font\test=LatinModernRoman:protrusion=default +% \end{verbatim} +% \end{quote} +% \end{description} +% +% \paragraph{Non-standard font features} +% \identifier{luaotfload} adds a number of features that are not defined +% in the original \OpenType specification, most of them +% aiming at emulating the behavior familiar from other \TEX engines. +% Currently (2014) there are three of them: +% +% \begin{description} +% +% \item [anum] +% Substitutes the glyphs in the \abbrev{ascii} number range +% with their counterparts from eastern Arabic or Persian, +% depending on the value of \identifier{language}. +% +% \item [tlig] +% Applies legacy \TEX ligatures: +% +% \begin{tabular}{rlrl} +% `` & \verb|``| & '' & \verb|''| \\ +% ` & \verb|`| & ' & \verb|'| \\ +% " & \verb|"| & -- & \verb|--| \\ +% --- & \verb|---| & !` & \verb|!`| \\ +% ?` & \verb|?`| & & \\ +% \end{tabular} +% +% \footnote{% +% These contain the feature set \verb|trep| of earlier +% versions of \identifier{luaotfload}. +% +% Note to \XETEX users: this is the equivalent of the +% assignment \verb|mapping=text-tex| using \XETEX's input +% remapping feature. +% } +% +% \item [itlc] +% Computes italic correction values (active by default). +% +% \end{description} +% +% +% +% \section{Font names database} +% \label{sec:fontdb} +% +% As mentioned above, \identifier{luaotfload} keeps track of which +% fonts are available to \LUATEX by means of a \emphasis{database}. +% This allows referring to fonts not only by explicit filenames but +% also by the proper names contained in the metadata which is often +% more accessible to humans.\footnote{% +% The tool \href{http://www.lcdf.org/type/}{\fileent{otfinfo}} (comes +% with \TEX Live), when invoked on a font file with the \verb|-i| +% option, lists the variety of name fields defined for it. +% } +% +% When \identifier{luaotfload} is asked to load a font by a font name, +% it will check if the database exists and load it, or else generate a +% fresh one. +% Should it then fail to locate the font, an update to the database is +% performed in case the font has been added to the system only +% recently. As soon as the database is updated, the resolver will try +% and look up the font again, all without user intervention. +% The goal is for \identifier{luaotfload} to act in the background and +% behave as unobtrusively as possible, while providing a convenient +% interface to the fonts installed on the system. +% +% Generating the database for the first time may take a while since it +% inspects every font file on your computer. +% This is particularly noticeable if it occurs during a typesetting run. +% In any case, subsequent updates to the database will be quite fast. +% +% \subsection[luaotfload-tool / mkluatexfontdb.lua]% +% {\fileent{luaotfload-tool} / +% \fileent{mkluatexfontdb.lua}\footnote{% +% The script may be named just \fileent{mkluatexfontdb} in your +% distribution. +% }} +% +% It can still be desirable at times to do some of these steps +% manually, and without having to compile a document. +% To this end, \identifier{luaotfload} comes with the utility +% \fileent{luaotfload-tool} that offers an interface to the database +% functionality. +% Being a \LUA script, there are two ways to run it: +% either make it executable (\verb|chmod +x| on unixoid systems) or +% pass it as an argument to \fileent{texlua}.\footnote{% +% Tests by the maintainer show only marginal performance gain by +% running with Luigi Scarso’s +% \href{https://foundry.supelec.fr/projects/luajittex/}% +% {\identifier{Luajit\kern-.25ex\TEX}}, +% which is probably due to the fact that most of the time is spent +% on file system operations. +% +% \emphasis{Note}: +% On \abbrev{MS} \identifier{Windows} systems, the script can be run +% either by calling the wrapper application +% \fileent{luaotfload-tool.exe} or as +% \verb|texlua.exe luaotfload-tool.lua|. +% } +% Invoked with the argument \verb|--update| it will perform a database +% update, scanning for fonts not indexed. +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool --update +% \end{verbatim} +% \end{quote} +% +% Adding the \verb|--force| switch will initiate a complete +% rebuild of the database. +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool --update --force +% \end{verbatim} +% \end{quote} +% +% For sake of backwards compatibility, \fileent{luaotfload-tool} may be +% renamed or symlinked to \fileent{mkluatexfontdb}. +% Whenever it is run under this name, it will update the database +% first, mimicking the behavior of earlier versions of +% \identifier{luaotfload}. +% +% \subsection{Search Paths} +% +% \identifier{luaotfload} scans those directories where fonts are +% expected to be located on a given system. +% On a Linux machine it follows the paths listed in the +% \identifier{Fontconfig} configuration files; +% consult \verb|man 5 fonts.conf| for further information. +% On \identifier{Windows} systems, the standard location is +% \verb|Windows\Fonts|, +% while \identifier{Mac OS~X} requires a multitude of paths to +% be examined. +% The complete list is is given in table \ref{table-searchpaths}. +% Other paths can be specified by setting the environment variable +% \verb+OSFONTDIR+. +% If it is non-empty, then search will be extended to the included +% directories. +% +% \begin{table}[t] +% \hrule +% \caption{List of paths searched for each supported operating +% system.} +% \renewcommand{\arraystretch}{1.2} +% \begin{center} +% \begin{tabular}{lp{.5\textwidth}} +% Windows & \verb|%WINDIR%\Fonts| +% \\ +% Linux & \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break +% \fileent{/etc/fonts/fonts.conf} +% \\ +% Mac & \fileent{\textasciitilde/Library/Fonts},\break +% \fileent{/Library/Fonts},\break +% \fileent{/System/Library/Fonts}, and\hfill\break +% \fileent{/Network/Library/Fonts} +% \\ +% \end{tabular} +% \end{center} +% \label{table-searchpaths} +% \hrule +% \end{table} +% +% \subsection{Querying from Outside} +% +% \fileent{luaotfload-tool} also provides rudimentary means of +% accessing the information collected in the font database. +% If the option \verb|--find=|\emphasis{name} is given, the script will +% try and search the fonts indexed by \identifier{luaotfload} for a +% matching name. +% For instance, the invocation +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool --find="Iwona Regular" +% \end{verbatim} +% \end{quote} +% +% \noindent +% will verify if “Iwona Regular” is found in the database and can be +% readily requested in a document. +% +% If you are unsure about the actual font name, then add the +% \verb|-F| (or \verb|--fuzzy|) switch to the command line to enable +% approximate matching. +% Suppose you cannot precisely remember if the variant of +% \identifier{Iwona} you are looking for was “Bright” or “Light”. +% The query +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool -F --find="Iwona Bright" +% \end{verbatim} +% \end{quote} +% +% \noindent +% will tell you that indeed the latter name is correct. +% +% Basic information about fonts in the database can be displayed +% using the \verb|-i| option (\verb|--info|). +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool -i --find="Iwona Light Italic" +% \end{verbatim} +% \end{quote} +% \noindent +% The meaning of the printed values is described in section 4.4 of the +% \LUATEX reference manual.\footnote{% +% In \TEX Live: \fileent{texmf-dist/doc/luatex/base/luatexref-t.pdf}. +% } +% +% For a much more detailed report about a given font try the \verb|-I| option +% instead (\verb|--inspect|). +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool -I --find="Iwona Light Italic" +% \end{verbatim} +% \end{quote} +% +% \verb|luaotfload-tool --help| will list the available command line +% switches, including some not discussed in detail here. +% For a full documentation of \identifier{luaotfload-tool} and its +% capabilities refer to the manpage +% (\verb|man 1 luaotfload-tool|).\footnote{% +% Or see \verb|luaotfload-tool.rst| in the source directory. +% } +% +% \subsection{Blacklisting Fonts} +% \label{font-blacklist} +% +% Some fonts are problematic in general, or just in \LUATEX. +% If you find that compiling your document takes far too long or eats +% away all your system’s memory, you can track down the culprit by +% running \verb|luaotfload-tool -v| to increase verbosity. +% Take a note of the \emphasis{filename} of the font that database +% creation fails with and append it to the file +% \fileent{luaotfload-blacklist.cnf}. +% +% A blacklist file is a list of font filenames, one per line. +% Specifying the full path to where the file is located is optional, the +% plain filename should suffice. +% File extensions (\fileent{.otf}, \fileent{.ttf}, etc.) may be omitted. +% Anything after a percent (|%|) character until the end of the line +% is ignored, so use this to add comments. +% Place this file to some location where the \identifier{kpse} +% library can find it, e.~g. +% \fileent{texmf-local/tex/luatex/luaotfload} if you are running +% \identifier{\TEX Live},\footnote{% +% You may have to run \verb|mktexlsr| if you created a new file in +% your \fileent{texmf} tree. +% } +% or just leave it in the working directory of your document. +% \identifier{luaotfload} reads all files named +% \fileent{luaotfload-blacklist.cnf} it finds, so the fonts in +% \fileent{./luaotfload-blacklist.cnf} extend the global blacklist. +% +% Furthermore, a filename prepended with a dash character (|-|) is +% removed from the blacklist, causing it to be temporarily whitelisted +% without modifying the global file. +% An example with explicit paths: +% +% \begin{verbatim} +% % example otf-blacklist.cnf +% /Library/Fonts/GillSans.ttc % Luaotfload ignores this font. +% -/Library/Fonts/Optima.ttc % This one is usable again, even if +% % blacklisted somewhere else. +% \end{verbatim} +% +% \section{Files from \CONTEXT and \LUATEX-Fonts} +% +% \identifier{luaotfload} relies on code originally written by Hans +% Hagen\footnote{% +% The creator of the \href{http://wiki.contextgarden.net}{\CONTEXT} +% format. +% } +% for and tested with \CONTEXT. +% It integrates the font loader as distributed in +% the \identifier{\LUATEX-Fonts} package. +% The original \LUA source files have been combined using the +% \fileent{mtx-package} script into a single, self-contained blob. +% In this form the font loader has no further dependencies\footnote{% +% It covers, however, to some extent the functionality of the +% \identifier{lualibs} package. +% } +% and requires only minor adaptions to integrate into +% \identifier{luaotfload}. +% The guiding principle is to let \CONTEXT/\LUATEX-Fonts take care of +% the implementation, and update the imported code from time to time. +% As maintainers, we aim at importing files from upstream essentially +% \emphasis{unmodified}, except for renaming them to prevent name +% clashes. +% This job has been greatly alleviated since the advent of +% \LUATEX-Fonts, prior to which the individual dependencies had to be +% manually spotted and extracted from the \CONTEXT source code in a +% complicated and error-prone fashion. +% +% Below is a commented list of the files distributed with +% \identifier{luaotfload} in one way or the other. +% See figure \ref{file-graph} on page \pageref{file-graph} for a +% graphical representation of the dependencies. +% From \LUATEX-Fonts, only the file \fileent{luatex-fonts-merged.lua} +% has been imported as \fileent{luaotfload-fontloader.lua}. +% It is generated by \fileent{mtx-package}, a \LUA source code merging +% too developed by Hans Hagen.\footnote{% +% \fileent{mtx-package} is +% \href +% {http://repo.or.cz/w/context.git/blob_plain/refs/heads/origin:/scripts/context/lua/mtx-package.lua} +% {part of \CONTEXT} +% and requires \fileent{mtxrun}. +% Run +% \verb|mtxrun --script package --help| +% to display further information. +% For the actual merging code see the file +% \fileent{util-mrg.lua} that is part of \CONTEXT. +% } +% It houses several \LUA files that can be classed in three +% categories. +% +% \begin{itemize} +% \let\normalitem=\item +% \def\incitem#1{% +% \normalitem{\fileent{#1}} +% } +% \normalitem \emphasis{\LUA utility libraries}, a subset +% of what is provided by the \identifier{lualibs} +% package. +% +% \begin{multicols}{2} +% \begin{itemize} +% \incitem{l-lua.lua} \incitem{l-lpeg.lua} +% \incitem{l-function.lua} \incitem{l-string.lua} +% \incitem{l-table.lua} \incitem{l-io.lua} +% \incitem{l-file.lua} \incitem{l-boolean.lua} +% \incitem{l-math.lua} \incitem{util-str.lua} +% \end{itemize} +% \end{multicols} +% +% \normalitem The \emphasis{font loader} itself. +% These files have been written for +% \LUATEX-Fonts and they are distributed along +% with \identifier{luaotfload}. +% \begin{multicols}{2} +% \begin{itemize} +% \incitem{luatex-basics-gen.lua} +% \incitem{luatex-basics-nod.lua} +% \incitem{luatex-fonts-enc.lua} +% \incitem{luatex-fonts-syn.lua} +% \incitem{luatex-fonts-tfm.lua} +% \incitem{luatex-fonts-chr.lua} +% \incitem{luatex-fonts-lua.lua} +% \incitem{luatex-fonts-inj.lua} +% \incitem{luatex-fonts-otn.lua} +% \incitem{luatex-fonts-def.lua} +% \incitem{luatex-fonts-ext.lua} +% \incitem{luatex-fonts-cbk.lua} +% \end{itemize} +% \end{multicols} +% +% \normalitem Code related to \emphasis{font handling and +% node processing}, taken directly from +% \CONTEXT. +% \begin{multicols}{2} +% \begin{itemize} +% \incitem{data-con.lua} \incitem{font-ini.lua} +% \incitem{font-con.lua} \incitem{font-cid.lua} +% \incitem{font-map.lua} \incitem{font-oti.lua} +% \incitem{font-otf.lua} \incitem{font-otb.lua} +% \incitem{font-ota.lua} \incitem{font-def.lua} +% \incitem{font-otp.lua} +% \end{itemize} +% \end{multicols} +% \end{itemize} +% +% Note that if \identifier{luaotfload} cannot locate the +% merged file, it will load the individual \LUA libraries +% instead. +% Their names remain the same as in \CONTEXT (without the +% \verb|otfl|-prefix) since we imported the relevant section of +% \fileent{luatex-fonts.lua} unmodified into \fileent{luaotfload-main.lua}. +% Thus if you prefer running bleeding edge code from the +% \CONTEXT beta, all you have to do is remove +% \fileent{luaotfload-merged.lua} from the search path. +% +% Also, the merged file at some point +% loads the Adobe Glyph List from a \LUA table that is contained in +% \fileent{luaotfload-glyphlist.lua}, which is automatically generated by the +% script \fileent{mkglyphlist}.\footnote{% +% See \fileent{luaotfload-font-enc.lua}. +% The hard-coded file name is why we have to replace the procedure +% that loads the file in \fileent{luaotfload-override.lua}. +% } +% There is a make target \identifier{glyphs} that will create a fresh +% glyph list so we don’t need to import it from \CONTEXT +% any longer. +% +% In addition to these, \identifier{luaotfload} requires a number of +% files not contained in the merge. Some of these have no equivalent in +% \LUATEX-Fonts or \CONTEXT, some were taken unmodified from the +% latter. +% +% \begin{itemize} +% \let\normalitem=\item +% \def\ouritem#1{% +% \normalitem{\fileent{#1}}% +% \space--\hskip1em +% } +% \ouritem {luaotfload-features.lua} font feature handling; +% incorporates some of the code from +% \fileent{font-otc} from \CONTEXT; +% \ouritem {luaotfload-override.lua} overrides the \CONTEXT logging +% functionality. +% \ouritem {luaotfload-loaders.lua} registers the \OpenType +% font reader as handler for +% Postscript fonts +% (\abbrev{pfa}, \abbrev{pfb}). +% \ouritem {luaotfload-parsers.lua} various \abbrev{lpeg}-based parsers. +% \ouritem {luaotfload-database.lua} font names database. +% \ouritem {luaotfload-colors.lua} color handling. +% \ouritem {luaotfload-auxiliary.lua} access to internal functionality +% for package authors +% (proposals for additions welcome). +% \ouritem {luaotfload-letterspace.lua} font-based letterspacing. +% \end{itemize} +% +% \begin{figure}[b] +% \caption{Schematic of the files in \identifier{Luaotfload}} +% \includegraphics[width=\textwidth]{filegraph.pdf} +% \label{file-graph} +% \end{figure} +% +% \section{Auxiliary Functions} +% +% With release version 2.2, \identifier{luaotfload} received +% additional functions for package authors to call from outside +% (see the file \fileent{luaotfload-auxiliary.lua} for details). +% The purpose of this addition twofold. +% Firstly, \identifier{luaotfload} failed to provide a stable interface +% to internals in the past which resulted in an unmanageable situation +% of different packages abusing the raw access to font objects by means +% of the \luafunction{patch_font} callback. +% When the structure of the font object changed due to an update, all +% of these imploded and several packages had to be fixed while +% simultaneously providing fallbacks for earlier versions. +% Now the patching is done on the \identifier{luaotfload} side and can +% be adapted with future modifications to font objects without touching +% the packages that depend on it. +% Second, some the capabilities of the font loader and the names +% database are not immediately relevant in \identifier{luaotfload} +% itself but might nevertheless be of great value to package authors or +% end users. +% +% Note that the current interface is not yet set in stone and the +% development team is open to suggestions for improvements or +% additions. +% +% \subsection{Callback Functions} +% +% The \luafunction{patch_font} callback is inserted in the wrapper +% \identifier{luaotfload} provides for the font definition callback +% (see below, page \pageref{define-font}). +% At this place it allows manipulating the font object immediately after +% the font loader is done creating it. +% For a short demonstration of its usefulness, here is a snippet that +% writes an entire font object to the file \fileent{fontdump.lua}: +% +% \begin{quote} +% \begin{verbatim} +% \input luaotfload.sty +% \directlua{ +% local dumpfile = "fontdump.lua" +% local dump_font = function (tfmdata) +% local data = table.serialize(tfmdata) +% io.savedata(dumpfile, data) +% end +% +% luatexbase.add_to_callback( +% "luaotfload.patch_font", +% dump_font, +% "my_private_callbacks.dump_font" +% ) +% } +% \font\dumpme=name:Iwona +% \bye +% \end{verbatim} +% \end{quote} +% +% \emphasis{Beware}: this creates a Lua file of around 150,000 lines of +% code, taking up 3~\abbrev{mb} of disk space. +% By inspecting the output you can get a first impression of how a font +% is structured in \LUATEX’s memory, what elements it is composed of, +% and in what ways it can be rearranged. +% +% \subsubsection{Compatibility with Earlier Versions} +% +% As has been touched on in the preface to this section, the structure +% of the object as returned by the fontloader underwent rather drastic +% changes during different stages of its development, and not all +% packages that made use of font patching have kept up with every one +% of it. +% To ensure compatibility with these as well as older versions of +% some packages, \identifier{luaotfload} sets up copies of or references +% to data in the font table where it used to be located. +% For instance, important parameters like the requested point size, the +% units factor, and the font name have again been made accessible from +% the toplevel of the table even though they were migrated to different +% subtables in the meantime. +% +% \subsubsection{Patches} +% +% These are mostly concerned with establishing compatibility with +% \XETEX. +% +% \begin{itemize} +% \let\normalitem=\item +% \def\ouritem#1{% +% \normalitem{\luafunction{#1}}% +% \hfill\break +% } +% +% \ouritem {set_sscale_dimens} +% Calculate \texmacro{fontdimen}s 10 and 11 to emulate \XETEX. +% +% \ouritem {set_capheight} +% Calculates \texmacro{fontdimen} 8 like \XETEX. +% +% \ouritem {patch_cambria_domh} +% Correct some values of the font \emphasis{Cambria Math}. +% +% \end{itemize} +% +% \subsection{Package Author’s Interface} +% +% As \LUATEX release 1.0 is nearing, the demand for a reliable interface +% for package authors increases. +% +% \subsubsection{Font Properties} +% +% Below functions mostly concern querying the different components of a +% font like for instance the glyphs it contains, or what font features +% are defined for which scripts. +% +% \begin{itemize} +% \let\normalitem=\item +% \def\ouritem#1{% +% \normalitem{\luafunction{#1}}% +% \hfill\break +% } +% +% \ouritem {aux.font_has_glyph (id : int, index : int)} +% Predicate that returns true if the font \luafunction{id} +% has glyph \luafunction{index}. +% +% \ouritem {aux.slot_of_name(name : string)} +% Translates an Adobe Glyph name to the corresponding glyph +% slot. +% +% \ouritem {aux.name_of_slot(slot : int)} +% The inverse of \luafunction{slot_of_name}; note that this +% might be incomplete as multiple glyph names may map to the +% same codepoint, only one of which is returned by +% \luafunction{name_of_slot}. +% +% \ouritem {aux.provides_script(id : int, script : string)} +% Test if a font supports \luafunction{script}. +% +% \ouritem {aux.provides_language(id : int, script : string, language : string)} +% Test if a font defines \luafunction{language} for a given +% \luafunction{script}. +% +% \ouritem {aux.provides_feature(id : int, script : string, +% language : string, feature : string)} +% Test if a font defines \luafunction{feature} for +% \luafunction{language} for a given \luafunction{script}. +% +% \ouritem {aux.get_math_dimension(id : int, dimension : string)} +% Get the dimension \luafunction{dimension} of font \luafunction{id}. +% +% \ouritem {aux.sprint_math_dimension(id : int, dimension : string)} +% Same as \luafunction{get_math_dimension()}, but output the value +% in scaled points at the \TEX end. +% +% \end{itemize} +% +% \subsubsection{Database} +% +% \begin{itemize} +% \let\normalitem=\item +% \def\ouritem#1{% +% \normalitem{\luafunction{#1}}% +% \hfill\break +% } +% +% \ouritem {aux.scan_external_dir(dir : string)} +% Include fonts in directory \luafunction{dir} in font lookups without +% adding them to the database. +% +% \end{itemize} +% +% \section{Troubleshooting} +% +% \subsection {Database Generation} +% If you encounter problems with some fonts, please first update to the latest +% version of this package before reporting a bug, as +% \identifier{luaotfload} is under active development and still a +% moving target. +% The development takes place on \identifier{github} at +% \url{https://github.com/lualatex/luaotfload} where there is an issue +% tracker for submitting bug reports, feature requests and the likes +% requests and the likes. +% +% Bug reports are more likely to be addressed if they contain the output of +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool --diagnose=environment,files,permissions +% \end{verbatim} +% \end{quote} +% +% \noindent Consult the man page for a description of these options. +% +% Errors during database generation can be traced by increasing the +% verbosity level and redirecting log output to \fileent{stdout}: +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool -fuvvv --log=stdout +% \end{verbatim} +% \end{quote} +% +% \noindent or to a file in \fileent{/tmp}: +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool -fuvvv --log=file +% \end{verbatim} +% \end{quote} +% +% \noindent In the latter case, invoke the \verb|tail(1)| utility on the file +% for live monitoring of the progress. +% +% If database generation fails, the font last printed to the terminal or log +% file is likely to be the culprit. +% Please specify it when reporting a bug, and blacklist it for the time +% being (see above, page \pageref{font-blacklist}). +% +% \subsection {Font Features} +% A common problem is the lack of features for some +% \OpenType fonts even when specified. +% This can be related to the fact that some fonts do not provide +% features for the \verb|dflt| script (see above on page +% \pageref{script-tag}), +% which is the default one in this package. +% If this happens, assigning a noth script when the font is defined should +% fix it. +% For example with \verb|latn|: +% +% \begin{quote} +% \begin{verbatim} +% \font\test=file:MyFont.otf:script=latn;+liga; +% \end{verbatim} +% \end{quote} +% +% You can get a list of features that a font defines for scripts and languages +% by querying it in \fileent{luaotfload-tool}: +% +% \begin{quote} +% \begin{verbatim} +% luaotfload-tool --find="Iwona" --inspect +% \end{verbatim} +% \end{quote} +% +% \subsection {\LUATEX Programming} +% Another strategy that helps avoiding problems is to not access raw \LUATEX +% internals directly. +% Some of them, even though they are dangerous to access, have not been +% overridden or disabled. +% Thus, whenever possible prefer the functions in the +% \luafunction{aux} namespace over direct manipulation of font objects. +% For example, raw access to the \luafunction{font.fonts} table like: +% +% \begin{quote} +% \begin{verbatim} +% local somefont = font.fonts[2] +% \end{verbatim} +% \end{quote} +% +% \noindent can render already defined fonts unusable. +% Instead, the function \luafunction{font.getfont()} should be used because +% it has been replaced by a safe variant. +% +% However, \luafunction{font.getfont()} only covers fonts handled by the font +% loader, e.~g. \identifier{OpenType} and \identifier{TrueType} fonts, but +% not \abbrev{tfm} or \abbrev{ofm}. +% Should you absolutely require access to all fonts known to \LUATEX, including +% the virtual and autogenerated ones, then you need to query both +% \luafunction{font.getfont()} and \luafunction{font.fonts}. +% In this case, best define you own accessor: +% +% \begin{quote} +% \begin{verbatim} +% local unsafe_getfont = function (id) +% local tfmdata = font.getfont (id) +% if not tfmdata then +% tfmdata = font.fonts[id] +% end +% return tfmdata +% end +% +% --- use like getfont() +% local somefont = unsafe_getfont (2) +% \end{verbatim} +% \end{quote} +% +% \part{Implementation} +% +% \section{\fileent{luaotfload.lua}} +% +% As of version 2.5, the file \fileent{luaotfload.lua} is no longer +% generated from the \abbrev{dtx}. +% Instead, it is maintained separately as a plain \identifier{Lua} file +% \fileent{luaotfload-main.lua} in the Luaotfload \identifier{git} tree. +% The file documentation which used to be found in this section has +% been preserved in the comments. +% +% \section{\fileent{luaotfload.sty}} +% +% As of version 2.5, the file \fileent{luaotfload.sty} is no longer +% generated from the \abbrev{dtx}. +% Instead, it is maintained separately as a plain \identifier{\TEX} file +% in the Luaotfload \identifier{git} tree. +% The file documentation which used to be found in this section has +% been preserved in the comments. +% +% \clearpage +% \section{The GNU GPL License v2} +% +% The GPL requires the complete license text to be distributed along +% with the code. I recommend the canonical source, instead: +% \url{http://www.gnu.org/licenses/old-licenses/gpl-2.0.html}. +% But if you insist on an included copy, here it is. +% You might want to zoom in. +% +% \newsavebox{\gpl} +% \begin{lrbox}{\gpl} +% \begin{minipage}{3\textwidth} +% \columnsep=3\columnsep +% \begin{multicols}{3} +% \begin{center} +% {\Large GNU GENERAL PUBLIC LICENSE\par} +% \bigskip +% {Version 2, June 1991} +% \end{center} +% +% \begin{center} +% {\parindent 0in +% +% Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. +% +% \bigskip +% +% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA +% +% \bigskip +% +% Everyone is permitted to copy and distribute verbatim copies +% of this license document, but changing it is not allowed. +% } +% \end{center} +% +% \begin{center} +% {\bf\large Preamble} +% \end{center} +% +% +% The licenses for most software are designed to take away your freedom to +% share and change it. By contrast, the GNU General Public License is +% intended to guarantee your freedom to share and change free software---to +% make sure the software is free for all its users. This General Public +% License applies to most of the Free Software Foundation's software and to +% any other program whose authors commit to using it. (Some other Free +% Software Foundation software is covered by the GNU Library General Public +% License instead.) You can apply it to your programs, too. +% +% When we speak of free software, we are referring to freedom, not price. +% Our General Public Licenses are designed to make sure that you have the +% freedom to distribute copies of free software (and charge for this service +% if you wish), that you receive source code or can get it if you want it, +% that you can change the software or use pieces of it in new free programs; +% and that you know you can do these things. +% +% To protect your rights, we need to make restrictions that forbid anyone to +% deny you these rights or to ask you to surrender the rights. These +% restrictions translate to certain responsibilities for you if you +% distribute copies of the software, or if you modify it. +% +% For example, if you distribute copies of such a program, whether gratis or +% for a fee, you must give the recipients all the rights that you have. You +% must make sure that they, too, receive or can get the source code. And +% you must show them these terms so they know their rights. +% +% We protect your rights with two steps: (1) copyright the software, and (2) +% offer you this license which gives you legal permission to copy, +% distribute and/or modify the software. +% +% Also, for each author's protection and ours, we want to make certain that +% everyone understands that there is no warranty for this free software. If +% the software is modified by someone else and passed on, we want its +% recipients to know that what they have is not the original, so that any +% problems introduced by others will not reflect on the original authors' +% reputations. +% +% Finally, any free program is threatened constantly by software patents. +% We wish to avoid the danger that redistributors of a free program will +% individually obtain patent licenses, in effect making the program +% proprietary. To prevent this, we have made it clear that any patent must +% be licensed for everyone's free use or not licensed at all. +% +% The precise terms and conditions for copying, distribution and +% modification follow. +% +% \begin{center} +% {\Large \sc Terms and Conditions For Copying, Distribution and +% Modification} +% \end{center} +% +% \begin{enumerate} +% \item +% This License applies to any program or other work which contains a notice +% placed by the copyright holder saying it may be distributed under the +% terms of this General Public License. The ``Program'', below, refers to +% any such program or work, and a ``work based on the Program'' means either +% the Program or any derivative work under copyright law: that is to say, a +% work containing the Program or a portion of it, either verbatim or with +% modifications and/or translated into another language. (Hereinafter, +% translation is included without limitation in the term ``modification''.) +% Each licensee is addressed as ``you''. +% +% Activities other than copying, distribution and modification are not +% covered by this License; they are outside its scope. The act of +% running the Program is not restricted, and the output from the Program +% is covered only if its contents constitute a work based on the +% Program (independent of having been made by running the Program). +% Whether that is true depends on what the Program does. +% +% \item You may copy and distribute verbatim copies of the Program's source +% code as you receive it, in any medium, provided that you conspicuously +% and appropriately publish on each copy an appropriate copyright notice +% and disclaimer of warranty; keep intact all the notices that refer to +% this License and to the absence of any warranty; and give any other +% recipients of the Program a copy of this License along with the Program. +% +% You may charge a fee for the physical act of transferring a copy, and you +% may at your option offer warranty protection in exchange for a fee. +% +% \item +% You may modify your copy or copies of the Program or any portion +% of it, thus forming a work based on the Program, and copy and +% distribute such modifications or work under the terms of Section 1 +% above, provided that you also meet all of these conditions: +% +% \begin{enumerate} +% +% \item +% You must cause the modified files to carry prominent notices stating that +% you changed the files and the date of any change. +% +% \item +% You must cause any work that you distribute or publish, that in +% whole or in part contains or is derived from the Program or any +% part thereof, to be licensed as a whole at no charge to all third +% parties under the terms of this License. +% +% \item +% If the modified program normally reads commands interactively +% when run, you must cause it, when started running for such +% interactive use in the most ordinary way, to print or display an +% announcement including an appropriate copyright notice and a +% notice that there is no warranty (or else, saying that you provide +% a warranty) and that users may redistribute the program under +% these conditions, and telling the user how to view a copy of this +% License. (Exception: if the Program itself is interactive but +% does not normally print such an announcement, your work based on +% the Program is not required to print an announcement.) +% +% \end{enumerate} +% +% +% These requirements apply to the modified work as a whole. If +% identifiable sections of that work are not derived from the Program, +% and can be reasonably considered independent and separate works in +% themselves, then this License, and its terms, do not apply to those +% sections when you distribute them as separate works. But when you +% distribute the same sections as part of a whole which is a work based +% on the Program, the distribution of the whole must be on the terms of +% this License, whose permissions for other licensees extend to the +% entire whole, and thus to each and every part regardless of who wrote it. +% +% Thus, it is not the intent of this section to claim rights or contest +% your rights to work written entirely by you; rather, the intent is to +% exercise the right to control the distribution of derivative or +% collective works based on the Program. +% +% In addition, mere aggregation of another work not based on the Program +% with the Program (or with a work based on the Program) on a volume of +% a storage or distribution medium does not bring the other work under +% the scope of this License. +% +% \item +% You may copy and distribute the Program (or a work based on it, +% under Section 2) in object code or executable form under the terms of +% Sections 1 and 2 above provided that you also do one of the following: +% +% \begin{enumerate} +% +% \item +% +% Accompany it with the complete corresponding machine-readable +% source code, which must be distributed under the terms of Sections +% 1 and 2 above on a medium customarily used for software interchange; or, +% +% \item +% +% Accompany it with a written offer, valid for at least three +% years, to give any third party, for a charge no more than your +% cost of physically performing source distribution, a complete +% machine-readable copy of the corresponding source code, to be +% distributed under the terms of Sections 1 and 2 above on a medium +% customarily used for software interchange; or, +% +% \item +% +% Accompany it with the information you received as to the offer +% to distribute corresponding source code. (This alternative is +% allowed only for noncommercial distribution and only if you +% received the program in object code or executable form with such +% an offer, in accord with Subsection b above.) +% +% \end{enumerate} +% +% +% The source code for a work means the preferred form of the work for +% making modifications to it. For an executable work, complete source +% code means all the source code for all modules it contains, plus any +% associated interface definition files, plus the scripts used to +% control compilation and installation of the executable. However, as a +% special exception, the source code distributed need not include +% anything that is normally distributed (in either source or binary +% form) with the major components (compiler, kernel, and so on) of the +% operating system on which the executable runs, unless that component +% itself accompanies the executable. +% +% If distribution of executable or object code is made by offering +% access to copy from a designated place, then offering equivalent +% access to copy the source code from the same place counts as +% distribution of the source code, even though third parties are not +% compelled to copy the source along with the object code. +% +% \item +% You may not copy, modify, sublicense, or distribute the Program +% except as expressly provided under this License. Any attempt +% otherwise to copy, modify, sublicense or distribute the Program is +% void, and will automatically terminate your rights under this License. +% However, parties who have received copies, or rights, from you under +% this License will not have their licenses terminated so long as such +% parties remain in full compliance. +% +% \item +% You are not required to accept this License, since you have not +% signed it. However, nothing else grants you permission to modify or +% distribute the Program or its derivative works. These actions are +% prohibited by law if you do not accept this License. Therefore, by +% modifying or distributing the Program (or any work based on the +% Program), you indicate your acceptance of this License to do so, and +% all its terms and conditions for copying, distributing or modifying +% the Program or works based on it. +% +% \item +% Each time you redistribute the Program (or any work based on the +% Program), the recipient automatically receives a license from the +% original licensor to copy, distribute or modify the Program subject to +% these terms and conditions. You may not impose any further +% restrictions on the recipients' exercise of the rights granted herein. +% You are not responsible for enforcing compliance by third parties to +% this License. +% +% \item +% If, as a consequence of a court judgment or allegation of patent +% infringement or for any other reason (not limited to patent issues), +% conditions are imposed on you (whether by court order, agreement or +% otherwise) that contradict the conditions of this License, they do not +% excuse you from the conditions of this License. If you cannot +% distribute so as to satisfy simultaneously your obligations under this +% License and any other pertinent obligations, then as a consequence you +% may not distribute the Program at all. For example, if a patent +% license would not permit royalty-free redistribution of the Program by +% all those who receive copies directly or indirectly through you, then +% the only way you could satisfy both it and this License would be to +% refrain entirely from distribution of the Program. +% +% If any portion of this section is held invalid or unenforceable under +% any particular circumstance, the balance of the section is intended to +% apply and the section as a whole is intended to apply in other +% circumstances. +% +% It is not the purpose of this section to induce you to infringe any +% patents or other property right claims or to contest validity of any +% such claims; this section has the sole purpose of protecting the +% integrity of the free software distribution system, which is +% implemented by public license practices. Many people have made +% generous contributions to the wide range of software distributed +% through that system in reliance on consistent application of that +% system; it is up to the author/donor to decide if he or she is willing +% to distribute software through any other system and a licensee cannot +% impose that choice. +% +% This section is intended to make thoroughly clear what is believed to +% be a consequence of the rest of this License. +% +% \item +% If the distribution and/or use of the Program is restricted in +% certain countries either by patents or by copyrighted interfaces, the +% original copyright holder who places the Program under this License +% may add an explicit geographical distribution limitation excluding +% those countries, so that distribution is permitted only in or among +% countries not thus excluded. In such case, this License incorporates +% the limitation as if written in the body of this License. +% +% \item +% The Free Software Foundation may publish revised and/or new versions +% of the General Public License from time to time. Such new versions will +% be similar in spirit to the present version, but may differ in detail to +% address new problems or concerns. +% +% Each version is given a distinguishing version number. If the Program +% specifies a version number of this License which applies to it and ``any +% later version'', you have the option of following the terms and conditions +% either of that version or of any later version published by the Free +% Software Foundation. If the Program does not specify a version number of +% this License, you may choose any version ever published by the Free Software +% Foundation. +% +% \item +% If you wish to incorporate parts of the Program into other free +% programs whose distribution conditions are different, write to the author +% to ask for permission. For software which is copyrighted by the Free +% Software Foundation, write to the Free Software Foundation; we sometimes +% make exceptions for this. Our decision will be guided by the two goals +% of preserving the free status of all derivatives of our free software and +% of promoting the sharing and reuse of software generally. +% +% \begin{center} +% {\Large\sc +% No Warranty +% } +% \end{center} +% +% \item +% {\sc Because the program is licensed free of charge, there is no warranty +% for the program, to the extent permitted by applicable law. Except when +% otherwise stated in writing the copyright holders and/or other parties +% provide the program ``as is'' without warranty of any kind, either expressed +% or implied, including, but not limited to, the implied warranties of +% merchantability and fitness for a particular purpose. The entire risk as +% to the quality and performance of the program is with you. Should the +% program prove defective, you assume the cost of all necessary servicing, +% repair or correction.} +% +% \item +% {\sc In no event unless required by applicable law or agreed to in writing +% will any copyright holder, or any other party who may modify and/or +% redistribute the program as permitted above, be liable to you for damages, +% including any general, special, incidental or consequential damages arising +% out of the use or inability to use the program (including but not limited +% to loss of data or data being rendered inaccurate or losses sustained by +% you or third parties or a failure of the program to operate with any other +% programs), even if such holder or other party has been advised of the +% possibility of such damages.} +% +% \end{enumerate} +% +% +% \begin{center} +% {\Large\sc End of Terms and Conditions} +% \end{center} +% +% +% \pagebreak[2] +% +% \section*{Appendix: How to Apply These Terms to Your New Programs} +% +% If you develop a new program, and you want it to be of the greatest +% possible use to the public, the best way to achieve this is to make it +% free software which everyone can redistribute and change under these +% terms. +% +% To do so, attach the following notices to the program. It is safest to +% attach them to the start of each source file to most effectively convey +% the exclusion of warranty; and each file should have at least the +% ``copyright'' line and a pointer to where the full notice is found. +% +% \begin{quote} +% one line to give the program's name and a brief idea of what it does. \\ +% Copyright (C) yyyy name of author \\ +% +% This program is free software; you can redistribute it and/or modify +% it under the terms of the GNU General Public License as published by +% the Free Software Foundation; either version 2 of the License, or +% (at your option) any later version. +% +% This program is distributed in the hope that it will be useful, +% but WITHOUT ANY WARRANTY; without even the implied warranty of +% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +% GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License +% along with this program; if not, write to the Free Software +% Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +% \end{quote} +% +% Also add information on how to contact you by electronic and paper mail. +% +% If the program is interactive, make it output a short notice like this +% when it starts in an interactive mode: +% +% \begin{quote} +% Gnomovision version 69, Copyright (C) yyyy name of author \\ +% Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ +% This is free software, and you are welcome to redistribute it +% under certain conditions; type `show c' for details. +% \end{quote} +% +% +% The hypothetical commands {\tt show w} and {\tt show c} should show the +% appropriate parts of the General Public License. Of course, the commands +% you use may be called something other than {\tt show w} and {\tt show c}; +% they could even be mouse-clicks or menu items---whatever suits your +% program. +% +% You should also get your employer (if you work as a programmer) or your +% school, if any, to sign a ``copyright disclaimer'' for the program, if +% necessary. Here is a sample; alter the names: +% +% \begin{quote} +% Yoyodyne, Inc., hereby disclaims all copyright interest in the program \\ +% `Gnomovision' (which makes passes at compilers) written by James Hacker. \\ +% +% signature of Ty Coon, 1 April 1989 \\ +% Ty Coon, President of Vice +% \end{quote} +% +% +% This General Public License does not permit incorporating your program +% into proprietary programs. If your program is a subroutine library, you +% may consider it more useful to permit linking proprietary applications +% with the library. If this is what you want to do, use the GNU Library +% General Public License instead of this License. +% +% \end{multicols} +% \end{minipage} +% \end{lrbox} +% +% \begin{center} +% \scalebox{0.33}{\usebox{\gpl}} +% \end{center} +% +% \Finale +\endinput -- cgit v1.2.3 From 708c689312e75953db431f8838846996ff447789 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 10 Feb 2014 07:14:53 +0100 Subject: [doc] add Makefile for doc subtree --- doc/Makefile | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 doc/Makefile (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..1ef7243 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,46 @@ +NAME = luaotfload +DOCPDF = $(NAME).pdf +DOCDTX = $(NAME).dtx + +SCRIPTNAME = luaotfload-tool +MANSOURCE = $(SCRIPTNAME).rst +MANPAGE = $(SCRIPTNAME).1 + +GRAPH = filegraph +DOTPDF = $(GRAPH).pdf +DOT = $(GRAPH).dot + +DOCS = $(DOTPDF) $(DOCPDF) $(MANPAGE) + +DO_LATEXMK = @latexmk -e '$$max_repeat = 5' -pdf -lualatex -silent $< >/dev/null +# latexmk does only one run on my machine, so we’re not going to rely on it +DO_LATEX = @lualatex -interaction=batchmode $< >/dev/null +DO_GRAPHVIZ = @dot -Tpdf -o $@ $< > /dev/null +DO_DOCUTILS = @rst2man $< >$@ 2>/dev/null + +doc: graph $(DOCPDF) +all: manual doc +graph: $(DOTPDF) +manual: $(MANPAGE) + +$(DOCPDF): $(DOCDTX) + @echo "creating PDF documentation ($(DOCPDF))" + $(DO_LATEX) + $(DO_LATEX) + +$(MANPAGE): $(MANSOURCE) + @echo "creating man page ($(MANPAGE))" + $(DO_DOCUTILS) + +$(DOTPDF): $(DOT) + @echo "creating file graph ($(DOTPDF))" + $(DO_GRAPHVIZ) + +.PHONY: clean mrproper + +clean: + @$(RM) -- *.log *.aux *.toc *.idx *.ind *.ilg *.out + +mrproper: clean + @$(RM) -- $(DOCS) + -- cgit v1.2.3 From 06e79fac8810293b5f3e9d03a1c0f838aefb4784 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 10 Feb 2014 08:00:50 +0100 Subject: [doc,*] fix TDS install rules in Makefile --- doc/Makefile | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile index 1ef7243..2040f5a 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,20 +1,20 @@ -NAME = luaotfload -DOCPDF = $(NAME).pdf -DOCDTX = $(NAME).dtx +NAME = luaotfload +DOCPDF = $(NAME).pdf +DOCDTX = $(NAME).dtx SCRIPTNAME = luaotfload-tool -MANSOURCE = $(SCRIPTNAME).rst -MANPAGE = $(SCRIPTNAME).1 +MANSOURCE = $(SCRIPTNAME).rst +MANPAGE = $(SCRIPTNAME).1 -GRAPH = filegraph -DOTPDF = $(GRAPH).pdf -DOT = $(GRAPH).dot +GRAPH = filegraph +DOTPDF = $(GRAPH).pdf +DOT = $(GRAPH).dot -DOCS = $(DOTPDF) $(DOCPDF) $(MANPAGE) +DOCS = $(DOTPDF) $(DOCPDF) $(MANPAGE) DO_LATEXMK = @latexmk -e '$$max_repeat = 5' -pdf -lualatex -silent $< >/dev/null # latexmk does only one run on my machine, so we’re not going to rely on it -DO_LATEX = @lualatex -interaction=batchmode $< >/dev/null +DO_LATEX = @lualatex -interaction=batchmode $< >/dev/null DO_GRAPHVIZ = @dot -Tpdf -o $@ $< > /dev/null DO_DOCUTILS = @rst2man $< >$@ 2>/dev/null @@ -44,3 +44,4 @@ clean: mrproper: clean @$(RM) -- $(DOCS) +# vim:set noexpandtab:tabstop=8:shiftwidth=2 -- cgit v1.2.3 From d93945a4fe46d821078fae758e76b0b0770b2d44 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Fri, 14 Feb 2014 23:25:42 +0100 Subject: =?UTF-8?q?[tool,doc]=20document=20=E2=80=9C--local=E2=80=9D=20opt?= =?UTF-8?q?ion=20in=20manual=20and=20usage=20messages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/luaotfload-tool.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc') diff --git a/doc/luaotfload-tool.rst b/doc/luaotfload-tool.rst index 6863918..761b0ec 100644 --- a/doc/luaotfload-tool.rst +++ b/doc/luaotfload-tool.rst @@ -21,6 +21,7 @@ SYNOPSIS [ --prefer-texmf ] [ --dry-run ] [ --formats=[+|-]EXTENSIONS ] [ --no-compress ] [ --no-strip ] + [ --local ] **luaotfload-tool** --find=FONTNAME [ --fuzzy ] [ --info ] [ --inspect ] [ --no-reload ] @@ -57,6 +58,13 @@ update mode --update, -u Update the database; indexes new fonts. --force, -f Force rebuilding of the database; re-indexes all fonts. +--local, -L Include font files in ``$PWD``. This option + will cause large parts of the database to be + rebuilt. Thus it is quite inefficient. + Additionally, if local font files are found, + the database is prevented from being saved + to disk, so the local fonts need to be parsed + with every invocation of ``luaotfload-tool``. --no-reload, -n Suppress auto-updates to the database (e.g. when ``--find`` is passed an unknown name). --no-strip Do not strip redundant information after -- cgit v1.2.3 From 91ea82ef8644f19a303674611c4ce9bfc47f1274 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sat, 15 Feb 2014 15:37:14 +0100 Subject: [doc] kill dtx The file ``luaotfload.dtx`` which made the documentation a huge PITA to extend, has finally been converted to ordinary Latex format. In the course of this conversion the style directives have been moved to file (``luaotfload-latex.tex``) so as to separate them from the content (``luaotfload-main.tex``). --- doc/luaotfload-latex.tex | 132 +++ doc/luaotfload-main.tex | 1944 ++++++++++++++++++++++++++++++++++++++++++++ doc/luaotfload.dtx | 1994 ---------------------------------------------- 3 files changed, 2076 insertions(+), 1994 deletions(-) create mode 100644 doc/luaotfload-latex.tex create mode 100644 doc/luaotfload-main.tex delete mode 100644 doc/luaotfload.dtx (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex new file mode 100644 index 0000000..615ad42 --- /dev/null +++ b/doc/luaotfload-latex.tex @@ -0,0 +1,132 @@ +%% Copyright (C) 2009-2014 +%% +%% by Elie Roux +%% and Khaled Hosny +%% and Philipp Gesang +%% +%% This file is part of Luaotfload. +%% +%% Home: https://github.com/lualatex/luaotfload +%% Support: . +%% +%% Luaotfload is under the GPL v2.0 (exactly) license. +%% +%% ---------------------------------------------------------------------------- +%% +%% Luaotfload is free software; you can redistribute it and/or +%% modify it under the terms of the GNU General Public License +%% as published by the Free Software Foundation; version 2 +%% of the License. +%% +%% Luaotfload is distributed in the hope that it will be useful, +%% but WITHOUT ANY WARRANTY; without even the implied warranty of +%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%% GNU General Public License for more details. +%% +%% You should have received a copy of the GNU General Public License +%% along with Luaotfload; if not, see . +%% +%% ---------------------------------------------------------------------------- +%% + +\documentclass{ltxdoc} + +\usepackage{metalogo,multicol,mdwlist,fancyvrb,xspace} +\usepackage[x11names]{xcolor} + +\def\primarycolor{DodgerBlue4} %%-> rgb 16 78 139 | #104e8b +\def\secondarycolor{Goldenrod4} %%-> rgb 139 105 200 | #8b6914 + +\usepackage[ + bookmarks=true, + colorlinks=true, + linkcolor=\primarycolor, + urlcolor=\secondarycolor, + citecolor=\primarycolor, + pdftitle={The luaotfload package}, + pdfsubject={OpenType layout system for Plain TeX and LaTeX}, + pdfauthor={Elie Roux & Khaled Hosny & Philipp Gesang}, + pdfkeywords={luatex, lualatex, unicode, opentype} +]{hyperref} + +\usepackage{fontspec} +\usepackage{unicode-math} + +\setmainfont[ +% Numbers = OldStyle, %% buggy with font cache + Ligatures = TeX, + BoldFont = {Linux Libertine O Bold}, + ItalicFont = {Linux Libertine O Italic}, + SlantedFont = {Linux Libertine O Italic}, +]{Linux Libertine O} +\setmonofont[Ligatures=TeX,Scale=MatchLowercase]{Liberation Mono} +%setsansfont[Ligatures=TeX]{Linux Biolinum O} +\setsansfont[Ligatures=TeX,Scale=MatchLowercase]{Iwona Medium} +%setmathfont{XITS Math} + +\usepackage{hologo} + +\newcommand\TEX {\TeX\xspace} +\newcommand\LUA {Lua\xspace} +\newcommand\PDFTEX {pdf\TeX\xspace} +\newcommand\LUATEX {Lua\TeX\xspace} +\newcommand\XETEX {\XeTeX\xspace} +\newcommand\LATEX {\LaTeX\xspace} +\newcommand\LUALATEX {Lua\LaTeX\xspace} +\newcommand\CONTEXT {Con\TeX t\xspace} +\newcommand\OpenType {\identifier{Open\kern-.25ex Type}\xspace} + +\def\definehighlight[#1][#2]% + {\ifcsname #1\endcsname\else + \expandafter\def\csname #1\endcsname% + {\bgroup#2\csname #1_indeed\endcsname} + \expandafter\def\csname #1_indeed\endcsname##1% + {##1\egroup}% + \fi} + +\def\restoreunderscore{\catcode`\_=12\relax} + +\definehighlight [fileent][\ttfamily\restoreunderscore] %% files, dirs +\definehighlight [texmacro][\sffamily\itshape\textbackslash] %% cs +\definehighlight[luafunction][\sffamily\itshape\restoreunderscore] %% lua identifiers +\definehighlight [identifier][\sffamily] %% names +\definehighlight [abbrev][\rmfamily\scshape] %% acronyms +\definehighlight [emphasis][\rmfamily\slshape] %% level 1 emph + +\newcommand*\email[1]{\href{mailto:#1}{#1}} + +\renewcommand\partname{Part}%% gets rid of the stupid “file” heading + +\usepackage{syntax}%% bnf for font request syntax + +\usepackage{titlesec} + +\def\movecountertomargin#1{\llap{\rmfamily\upshape#1\hskip2em}} +\def\zeropoint{0pt} +\titleformat \part + {\normalsize\rmfamily\bfseries} + {\movecountertomargin\thepart} \zeropoint {} +\titleformat \section + {\normalsize\rmfamily\scshape} + {\movecountertomargin\thesection} \zeropoint {} +\titleformat \subsection + {\small\rmfamily\itshape} + {\movecountertomargin\thesubsection} \zeropoint {} +\titleformat \subsubsection + {\normalsize\rmfamily\upshape} + {\movecountertomargin\thesubsubsection} \zeropoint {} + +\usepackage{tocloft} +\renewcommand \cftpartfont {\rmfamily\upshape} +\renewcommand \cftsecfont {\rmfamily\upshape} +\renewcommand \cftsubsecfont {\rmfamily\upshape} +\setlength \cftbeforepartskip {1ex} +\setlength \cftbeforesecskip {1ex} + +\VerbatimFootnotes + +\begin {document} + \input {luaotfload-main.tex} +\end {document} + + diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex new file mode 100644 index 0000000..49d1986 --- /dev/null +++ b/doc/luaotfload-main.tex @@ -0,0 +1,1944 @@ +%% Copyright (C) 2009-2014 +%% +%% by Elie Roux +%% and Khaled Hosny +%% and Philipp Gesang +%% +%% This file is part of Luaotfload. +%% +%% Home: https://github.com/lualatex/luaotfload +%% Support: . +%% +%% Luaotfload is under the GPL v2.0 (exactly) license. +%% +%% ---------------------------------------------------------------------------- +%% +%% Luaotfload is free software; you can redistribute it and/or +%% modify it under the terms of the GNU General Public License +%% as published by the Free Software Foundation; version 2 +%% of the License. +%% +%% Luaotfload is distributed in the hope that it will be useful, +%% but WITHOUT ANY WARRANTY; without even the implied warranty of +%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%% GNU General Public License for more details. +%% +%% You should have received a copy of the GNU General Public License +%% along with Luaotfload; if not, see . +%% +%% ---------------------------------------------------------------------------- +%% + +\title{The \identifier{luaotfload} package} +\date{2014/**/** v2.5} +\author{Elie Roux · Khaled Hosny · Philipp Gesang\\ + Home: \url {https://github.com/lualatex/luaotfload}\\ + Support: \email {lualatex-dev@tug.org}} + +\maketitle + +\begin{abstract} + This package is an adaptation of the \CONTEXT font loading system. + It allows for loading \OpenType fonts with an extended syntax and adds + support for a variety of font features. +\end{abstract} + + +\tableofcontents + +\part{Package Description} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Introduction} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +Font management and installation has always been painful with \TEX. A +lot of files are needed for one font (\abbrev{tfm}, \abbrev{pfb}, +\abbrev{map}, \abbrev{fd}, \abbrev{vf}), and due to the 8-Bit encoding +each font is limited to 256 characters. + +But the font world has evolved since the original \TEX, and new +typographic systems have appeared, most notably the so called +\emphasis{smart font} technologies like \OpenType fonts (\abbrev{otf}). + +These fonts can contain many more characters than \TEX fonts, as well +as additional functionality like ligatures, old-style numbers, small +capitals, etc., and support more complex writing systems like Arabic +and Indic\footnote{% + Unfortunately, \identifier{luaotfload} doesn‘t support many Indic + scripts right now. + Assistance in implementing the prerequisites is greatly + appreciated. +} +scripts. + +\OpenType fonts are widely deployed and available for all modern +operating systems. + +As of 2013 they have become the de facto standard for advanced text +layout. + +However, until recently the only way to use them directly in the \TEX +world was with the \XETEX engine. + +Unlike \XETEX, \LUATEX has no built-in support for \OpenType or +technologies other than the original \TEX fonts. + +Instead, it provides hooks for executing \LUA code during the \TEX run +that allow implementing extensions for loading fonts and manipulating +how input text is processed without modifying the underlying engine. + +This is where \identifier{luaotfload} comes into play: +Based on code from \CONTEXT, it extends \LUATEX with functionality necessary +for handling \OpenType fonts. + +Additionally, it provides means for accessing fonts known to the operating +system conveniently by indexing the metadata. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Thanks} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\identifier{Luaotfload} is part of \LUALATEX, the community-driven +project to provide a foundation for using the \LATEX format with the +full capabilites of the \LUATEX engine. +% +As such, the distinction between end users, contributors, and project +maintainers is intentionally kept less strict, lest we unduly +personalize the common effort. + +Nevertheless, the current maintainers would like to express their +gratitude to Khaled Hosny, Akira Kakuto, Hironori Kitagawa and Dohyun +Kim. +% +Their contributions -- be it patches, advice, or systematic +testing -- made the switch from version 1.x to 2.2 possible. +% +Also, Hans Hagen, the author of the font loader, made porting the +code to \LATEX a breeze due to the extra effort he invested into +isolating it from the rest of \CONTEXT, not to mention his assistance +in the task and willingness to respond to our suggestions. + + +\section{Loading Fonts} + +\identifier{luaotfload} supports an extended font request syntax: + +\begin{quote} + |\font\foo={|% + \meta{prefix}|:|% + \meta{font name}|:|% + \meta{font features}|}|% + \meta{\TEX font features} +\end{quote} + +\noindent +The curly brackets are optional and escape the spaces in the enclosed +font name. +% +Alternatively, double quotes serve the same purpose. +% +A selection of individual parts of the syntax are discussed below; +for a more formal description see figure \ref{font-syntax}. + +\begin {figure} [b] + \setlength\grammarparsep{12pt plus 2pt minus 2pt} + \setlength\grammarindent{5cm} + \begingroup + \small + \begin{grammar} + ::= `\\font', {\sc csname}, `=', , [ ] ; + + ::= `at', {\sc dimension} ; + + ::= `"', `"' + \alt `{', `}' + \alt ; + + ::= , [`:', ] + \alt `[', `]', [ [`:'], ] ; + + ::= , [ ], \{ \} + \alt , \{ \} ; + + ::= `file:', + \alt `name:', ; + + ::= \{ \} ; + + ::= \{ \} ; + + ::= {\sc tfmname} | ; + + ::= \{ {\sc all_characters} - `]' \} ; + + ::= `/', (`I' | `B' | `BI' | `IB' | `S=', \{ {\sc digit} \} ) ; + + ::= `(', \{ {\sc digit} \}, `)' ; + + ::= , \{ `;', \} ; + + ::= {\sc feature_id}, `=', {\sc feature_value} + \alt , {\sc feature_id} ; + + ::= `+' | `-' ; + + ::= {\sc all_characters} - ( `(' | `/' | `:' ) ; + \end{grammar} + \endgroup + \caption{Font request syntax. + Braces or double quotes around the + \emphasis{specification} rule will + preserve whitespace in file names. + In addition to the font style modifiers + (\emphasis{slash-notation}) given above, there + are others that are recognized but will be silently + ignored: {\ttfamily aat}, + {\ttfamily icu}, and + {\ttfamily gr}. + The special terminals are: + {\sc feature\textunderscore id} for a valid font + feature name and + {\sc feature\textunderscore value} for the corresponding + value. + {\sc tfmname} is the name of a \abbrev{tfm} file. + {\sc digit} again refers to bytes 48--57, and + {\sc all\textunderscore characters} to all byte values. + {\sc csname} and {\sc dimension} are the \TEX concepts.} + \label{font-syntax} +\end {figure} + +\subsection{Prefix -- the \identifier{luaotfload}{ }Way} + +In \identifier{luaotfload}, the canonical syntax for font requests +requires a \emphasis{prefix}: +% +\begin{quote} + |\font\fontname=|\meta{prefix}|:|\meta{fontname}\dots +\end{quote} +% +where \meta{prefix} is either \verb|file:| or \verb|name:|.\footnote{% + The development version also knows two further prefixes, + \verb|kpse:| and \verb|my:|. + % + A \verb|kpse| lookup is restricted to files that can be found by + \identifier{kpathsea} and + will not attempt to locate system fonts. + % + This behavior can be of value when an extra degree of encapsulation is + needed, for instance when supplying a customized tex distribution. + + The \verb|my| lookup takes this a step further: it lets you define + a custom resolver function and hook it into the \luafunction{resolve_font} + callback. + % + This ensures full control over how a file is located. + % + For a working example see the + \href{https://bitbucket.org/phg/lua-la-tex-tests/src/5f6a535d/pln-lookup-callback-1.tex} + {test repo}. +} +% +It determines whether the font loader should interpret the request as +a \emphasis{file name} or + \emphasis{font name}, respectively, +which again influences how it will attempt to locate the font. +% +Examples for font names are + “Latin Modern Italic”, + “GFS Bodoni Rg”, and + “PT Serif Caption” +-- they are the human readable identifiers +usually listed in drop-down menus and the like.\footnote{% + Font names may appear like a great choice at first because they + offer seemingly more intuitive identifiers in comparison to arguably + cryptic file names: + % + “PT Sans Bold” is a lot more descriptive than \fileent{PTS75F.ttf}. + On the other hand, font names are quite arbitrary and there is no + universal method to determine their meaning. + % + While \identifier{luaotfload} provides fairly sophisticated heuristic + to figure out a matching font style, weight, and optical size, it + cannot be relied upon to work satisfactorily for all font files. + % + For an in-depth analysis of the situation and how broken font names + are, please refer to + \href{http://www.ntg.nl/pipermail/ntg-context/2013/073889.html} + {this post} + by Hans Hagen, the author of the font loader. + % + If in doubt, use filenames. + % + \fileent{luaotfload-tool} can perform the matching for you with the + option \verb|--find=|, and you can use the file name it returns + in your font definition. +} +% +In order for fonts installed both in system locations and in your +\fileent{texmf} to be accessible by font name, \identifier{luaotfload} must +first collect the metadata included in the files. +% +Please refer to section~\ref{sec:fontdb} below for instructions on how to +create the database. + +File names are whatever your file system allows them to be, except +that that they may not contain the characters + \verb|(|, + \verb|:|, and + \verb|/|. +% +As is obvious from the last exception, the \verb|file:| lookup will +not process paths to the font location -- only those +files found when generating the database are addressable this way. +% +Continue below in the \XETEX section if you need to load your fonts +by path. +% +The file names corresponding to the example font names above are + \fileent{lmroman12-italic.otf}, + \fileent{GFSBodoni.otf}, and + \fileent{PTZ56F.ttf}. + +\subsection{Compatibility Layer} + +In addition to the regular prefixed requests, \identifier{luaotfload} +accepts loading fonts the \XETEX way. +% +There are again two modes: bracketed and unbracketed. +A bracketed request looks as follows. + +\begin{quote} + |\font\fontname=[|\meta{path to file}|]| +\end{quote} + +\noindent +Inside the square brackets, every character except for a closing +bracket is permitted, allowing for specifying paths to a font file. +% +Naturally, path-less file names are equally valid and processed the +same way as an ordinary \verb|file:| lookup. + +\begin{quote} + |\font\fontname=|\meta{font name} \dots +\end{quote} + +Unbracketed (or, for lack of a better word: \emphasis{anonymous}) +font requests resemble the conventional \TEX syntax. +% +However, they have a broader spectrum of possible interpretations: +before anything else, \identifier{luaotfload} attempts to load a +traditional \TEX Font Metric (\abbrev{tfm} or \abbrev{ofm}). +% +If this fails, it performs a \verb|name:| lookup, which itself will +fall back to a \verb|file:| lookup if no database entry matches +\meta{font name}. + +Furthermore, \identifier{luaotfload} supports the slashed (shorthand) +font style notation from \XETEX. + +\begin{quote} + |\font\fontname=|\meta{font name}|/|\meta{modifier}\dots +\end{quote} + +\noindent +Currently, four style modifiers are supported: + \verb|I| for italic shape, + \verb|B| for bold weight, + \verb|BI| or \verb|IB| for the combination of both. +% +Other “slashed” modifiers are too specific to the \XETEX engine and +have no meaning in \LUATEX. + +\subsection{Examples} + +\subsubsection{Loading by File Name} + +For example, conventional \abbrev{type1} font can be loaded with a \verb|file:| +request like so: + +\begin{quote} + \begin{verbatim} + \font\lmromanten={file:ec-lmr10} at 10pt + \end{verbatim} +\end{quote} + +The \OpenType version of Janusz Nowacki’s font \emphasis{Antykwa +Półtawskiego}\footnote{% + \url{http://jmn.pl/antykwa-poltawskiego/}, also available in + in \TEX Live. +} +in its condensed variant can be loaded as follows: + +\begin{quote} + \begin{verbatim} + \font\apcregular=file:antpoltltcond-regular.otf at 42pt + \end{verbatim} +\end{quote} + +The next example shows how to load the \emphasis{Porson} font digitized by +the Greek Font Society using \XETEX-style syntax and an absolute path from a +non-standard directory: + +\begin{quote} + \begin{verbatim} + \font\gfsporson="[/tmp/GFSPorson.otf]" at 12pt + \end{verbatim} +\end{quote} + +\subsubsection{Loading by Font Name} + +The \verb|name:| lookup does not depend on cryptic filenames: + +\begin{quote} + \begin{verbatim} + \font\pagellaregular={name:TeX Gyre Pagella} at 9pt + \end{verbatim} +\end{quote} + +A bit more specific but essentially the same lookup would be: + +\begin{quote} + \begin{verbatim} + \font\pagellaregular={name:TeX Gyre Pagella Regular} at 9pt + \end{verbatim} +\end{quote} + +\noindent +Which fits nicely with the whole set: + +\begin{quote} + \begin{verbatim} + \font\pagellaregular ={name:TeX Gyre Pagella Regular} at 9pt + \font\pagellaitalic ={name:TeX Gyre Pagella Italic} at 9pt + \font\pagellabold ={name:TeX Gyre Pagella Bold} at 9pt + \font\pagellabolditalic={name:TeX Gyre Pagella Bolditalic} at 9pt + + {\pagellaregular foo bar baz\endgraf} + {\pagellaitalic foo bar baz\endgraf} + {\pagellabold foo bar baz\endgraf} + {\pagellabolditalic foo bar baz\endgraf} + + ... + \end{verbatim} +\end{quote} + +\subsubsection{Modifiers} + +If the entire \emphasis{Iwona} family\footnote{% + \url{http://jmn.pl/kurier-i-iwona/}, + also in \TEX Live. +} +is installed in some location accessible by \identifier{luaotfload}, +the regular shape can be loaded as follows: + +\begin{quote} + \begin{verbatim} + \font\iwona=Iwona at 20pt + \end{verbatim} +\end{quote} + +\noindent +To load the most common of the other styles, the slash notation can +be employed as shorthand: + +\begin{quote} + \begin{verbatim} + \font\iwonaitalic =Iwona/I at 20pt + \font\iwonabold =Iwona/B at 20pt + \font\iwonabolditalic=Iwona/BI at 20pt + \end{verbatim} +\end{quote} + +\noindent +which is equivalent to these full names: + +\begin{quote} + \begin{verbatim} + \font\iwonaitalic ="Iwona Italic" at 20pt + \font\iwonabold ="Iwona Bold" at 20pt + \font\iwonabolditalic="Iwona BoldItalic" at 20pt + \end{verbatim} +\end{quote} + +\section {Font features} + +\emphasis{Font features} are the second to last component in the +general scheme for font requests: + +\begin{quote} + |\font\foo={|% + \meta{prefix}|:|% + \meta{font name}|:|% + \meta{font features}|}|% + \meta{\TEX font features} +\end{quote} + +\noindent +If style modifiers are present (\XETEX style), they must precede +\meta{font features}. + +The element \meta{font features} is a semicolon-separated list of feature +tags\footnote{% + Cf. \url{http://www.microsoft.com/typography/otspec/featurelist.htm}. +} +and font options. +% +Prepending a font feature with a |+| (plus sign) enables it, whereas +a |-| (minus) disables it. For instance, the request + +\begin{quote} + \begin{verbatim} + \font\test=LatinModernRoman:+clig;-kern + \end{verbatim} +\end{quote} + +\noindent activates contextual ligatures (|clig|) and disables +kerning (|kern|). +% +Alternatively the options |true| or |false| can be passed to +the feature in a key/value expression. +% +The following request has the same meaning as the last one: + +\begin{quote} + \begin{verbatim} + \font\test=LatinModernRoman:clig=true;kern=false + \end{verbatim} +\end{quote} + +\noindent +Furthermore, this second syntax is required should a font feature +accept other options besides a true/false switch. +% +For example, \emphasis{stylistic alternates} (|salt|) are variants of +given glyphs. +% +They can be selected either explicitly by supplying the variant +index (starting from one), or randomly by setting the value to, +obviously, |random|. + +%% TODO verify that this actually works with a font that supports +%% the salt/random feature!\fi +\begin{quote} + \begin{verbatim} + \font\librmsaltfirst=LatinModernRoman:salt=1 + \end{verbatim} +\end{quote} + +\noindent Other font options include: + +\begin{description} + +\item [mode] \hfill \\ + \identifier{luaotfload} has two \OpenType processing + \emphasis{modes}: + \identifier{base} and \identifier{node}. + + \identifier{base} mode works by mapping \OpenType + features to traditional \TEX ligature and kerning mechanisms. + % + Supporting only non-contextual substitutions and kerning + pairs, it is the slightly faster, albeit somewhat limited, variant. + % + \identifier{node} mode works by processing \TeX’s internal + node list directly at the \LUA end and supports + a wider range of \OpenType features. + % + The downside is that the intricate operations required for + \identifier{node} mode may slow down typesetting especially + with complex fonts and it does not work in math mode. + + By default \identifier{luaotfload} is in \identifier{node} + mode, and \identifier{base} mode has to be requested where needed, + e.~g. for math fonts. + +\item [script] \label{script-tag} \hfill \\ + An \OpenType script tag;\footnote{% + See \url{http://www.microsoft.com/typography/otspec/scripttags.htm} + for a list of valid values. + % + For scripts derived from the Latin alphabet the value + |latn| is good choice. + } + the default value is |dlft|. + % + Some fonts, including very popular ones by foundries like Adobe, + do not assign features to the |dflt| script, in + which case the script needs to be set explicitly. + +\item [language] \hfill \\ + An \OpenType language system identifier,\footnote{% + Cf. \url{http://www.microsoft.com/typography/otspec/languagetags.htm}. + } + defaulting to |dflt|. + +\item [featurefile] \hfill \\ + A comma-separated list of feature files to be applied to the + font. + % + Feature files contain a textual representation of + \OpenType tables and extend the features of a font + on fly. + % + After they are applied to a font, features defined in a + feature file can be enabled or disabled just like any + other font feature. + % + The syntax is documented in \identifier{Adobe}’s + \OpenType Feature File Specification.\footnote{% + Cf. \url{http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. + } + + For a demonstration of how to set a |tkrn| feature consult + the file |tkrn.fea| that is part of \identifier{luaotfload}. + It can be read and applied as follows: + + |\font\test=Latin Modern Roman:featurefile=tkrn.fea;+tkrn| + +\item [color] \hfill \\ + A font color, defined as a triplet of two-digit hexadecimal + \abbrev{rgb} values, with an optional fourth value for + transparency + (where |00| is completely transparent and |FF| is opaque). + + For example, in order to set text in semitransparent red: + + \begin{quote} + \begin{verbatim} + \font\test={Latin Modern Roman}:color=FF0000BB + \end{verbatim} + \end{quote} + +\item [kernfactor \& letterspace] \hfill \\ + Define a font with letterspacing (tracking) enabled. + % + In \identifier{luaotfload}, letterspacing is implemented by + inserting additional kerning between glyphs. + + This approach is derived from and still quite similar to the + \emphasis{character kerning} (\texmacro{setcharacterkerning} / + \texmacro{definecharacterkerning} \& al.) functionality of + Context, see the file \fileent{typo-krn.lua} there. + % + The main difference is that \identifier{luaotfload} does not + use \LUATEX attributes to assign letterspacing to regions, + but defines virtual letterspaced versions of a font. + + The option \identifier{kernfactor} accepts a numeric value that + determines the letterspacing factor to be applied to the font + size. + % + E.~g. a kern factor of $0.42$ applied to a $10$ pt font + results in $4.2$ pt of additional kerning applied to each + pair of glyphs. + % + Ligatures are split into their component glyphs unless + explicitly ignored (see below). + + For compatibility with \XETEX an alternative + \identifier{letterspace} option is supplied that interprets the + supplied value as a \emphasis{percentage} of the font size but + is otherwise identical to \identifier{kernfactor}. + % + Consequently, both definitions in below snippet yield the same + letterspacing width: + + \begin{quote} + \begin{verbatim} + \font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" + \font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" + \end{verbatim} + \end{quote} + + Specific pairs of letters and ligatures may be exempt from + letterspacing by defining the \LUA functions + \luafunction{keeptogether} and \luafunction{keepligature}, + respectively, inside the namespace \verb|luaotfload.letterspace|. + % + Both functions are called whenever the letterspacing callback + encounters an appropriate node or set of nodes. + % + If they return a true-ish value, no extra kern is inserted at + the current position. + % + \luafunction{keeptogether} receives a pair of consecutive + glyph nodes in order of their appearance in the node list. + % + \luafunction{keepligature} receives a single node which can be + analyzed into components. + % + (For details refer to the \emphasis{glyph nodes} section in the + \LUATEX reference manual.) + % + The implementation of both functions is left entirely to the + user. + + +\item [protrusion \& expansion] \hfill \\ + These keys control microtypographic features of the font, + namely \emphasis{character protrusion} and \emphasis{font + expansion}. + % + Their arguments are names of \LUA tables that contain + values for the respective features.\footnote{% + For examples of the table layout please refer to the + section of the file \fileent{luaotfload-fonts-ext.lua} where the + default values are defined. + % + Alternatively and with loss of information, you can dump + those tables into your terminal by issuing + \begin{verbatim} + \directlua{inspect(fonts.protrusions.setups.default) + inspect(fonts.expansions.setups.default)} + \end{verbatim} + at some point after loading \fileent{luaotfload.sty}. + } + % + For both, only the set \identifier{default} is predefined. + + For example, to define a font with the default + protrusion vector applied\footnote{% + You also need to set + \verb|pdfprotrudechars=2| and + \verb|pdfadjustspacing=2| + to activate protrusion and expansion, respectively. + See the + \href{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% + {\PDFTEX manual} + for details. + }: + + \begin{quote} + \begin{verbatim} + \font\test=LatinModernRoman:protrusion=default + \end{verbatim} + \end{quote} +\end{description} + +\paragraph{Non-standard font features} +\identifier{luaotfload} adds a number of features that are not defined +in the original \OpenType specification, most of them +aiming at emulating the behavior familiar from other \TEX engines. +% +Currently (2014) there are three of them: + +\begin{description} + + \item [anum] + Substitutes the glyphs in the \abbrev{ascii} number range + with their counterparts from eastern Arabic or Persian, + depending on the value of \identifier{language}. + + \item [tlig] + Applies legacy \TEX ligatures: + + \begin{tabular}{rlrl} + `` & \verb|``| & '' & \verb|''| \\ + ` & \verb|`| & ' & \verb|'| \\ + " & \verb|"| & -- & \verb|--| \\ + --- & \verb|---| & !` & \verb|!`| \\ + ?` & \verb|?`| & & \\ + \end{tabular} + + \footnote{% + These contain the feature set \verb|trep| of earlier + versions of \identifier{luaotfload}. + + Note to \XETEX users: this is the equivalent of the + assignment \verb|mapping=text-tex| using \XETEX's input + remapping feature. + } + + \item [itlc] + Computes italic correction values (active by default). + +\end{description} + + + +\section{Font names database} +\label{sec:fontdb} + +As mentioned above, \identifier{luaotfload} keeps track of which +fonts are available to \LUATEX by means of a \emphasis{database}. +% +This allows referring to fonts not only by explicit filenames but +also by the proper names contained in the metadata which is often +more accessible to humans.\footnote{% + The tool \href{http://www.lcdf.org/type/}{\fileent{otfinfo}} (comes + with \TEX Live), when invoked on a font file with the \verb|-i| + option, lists the variety of name fields defined for it. +} + +When \identifier{luaotfload} is asked to load a font by a font name, +it will check if the database exists and load it, or else generate a +fresh one. +% +Should it then fail to locate the font, an update to the database is +performed in case the font has been added to the system only +recently. +% +As soon as the database is updated, the resolver will try +and look up the font again, all without user intervention. +% +The goal is for \identifier{luaotfload} to act in the background and +behave as unobtrusively as possible, while providing a convenient +interface to the fonts installed on the system. + +Generating the database for the first time may take a while since it +inspects every font file on your computer. +% +This is particularly noticeable if it occurs during a typesetting run. +In any case, subsequent updates to the database will be quite fast. + +\subsection[luaotfload-tool / mkluatexfontdb.lua]% + {\fileent{luaotfload-tool} / + \fileent{mkluatexfontdb.lua}\footnote{% + The script may be named just \fileent{mkluatexfontdb} in your + distribution. +}} + +It can still be desirable at times to do some of these steps +manually, and without having to compile a document. +% +To this end, \identifier{luaotfload} comes with the utility +\fileent{luaotfload-tool} that offers an interface to the database +functionality. +% +Being a \LUA script, there are two ways to run it: +either make it executable (\verb|chmod +x| on unixoid systems) or +pass it as an argument to \fileent{texlua}.\footnote{% + Tests by the maintainer show only marginal performance gain by + running with Luigi Scarso’s + \href{https://foundry.supelec.fr/projects/luajittex/}% + {\identifier{Luajit\kern-.25ex\TEX}}, + which is probably due to the fact that most of the time is spent + on file system operations. + + \emphasis{Note}: + On \abbrev{MS} \identifier{Windows} systems, the script can be run + either by calling the wrapper application + \fileent{luaotfload-tool.exe} or as + \verb|texlua.exe luaotfload-tool.lua|. +} +% +Invoked with the argument \verb|--update| it will perform a database +update, scanning for fonts not indexed. + +\begin{quote} + \begin{verbatim} + luaotfload-tool --update + \end{verbatim} +\end{quote} + +Adding the \verb|--force| switch will initiate a complete +rebuild of the database. + +\begin{quote} + \begin{verbatim} + luaotfload-tool --update --force + \end{verbatim} +\end{quote} + +For sake of backwards compatibility, \fileent{luaotfload-tool} may be +renamed or symlinked to \fileent{mkluatexfontdb}. +% +Whenever it is run under this name, it will update the database +first, mimicking the behavior of earlier versions of +\identifier{luaotfload}. + +\subsection{Search Paths} + +\identifier{luaotfload} scans those directories where fonts are +expected to be located on a given system. +% +On a Linux machine it follows the paths listed in the +\identifier{Fontconfig} configuration files; +consult \verb|man 5 fonts.conf| for further information. +% +On \identifier{Windows} systems, the standard location is +\verb|Windows\Fonts|, +% +while \identifier{Mac OS~X} requires a multitude of paths to +be examined. +% +The complete list is is given in table \ref{table-searchpaths}. +Other paths can be specified by setting the environment variable +\verb+OSFONTDIR+. +% +If it is non-empty, then search will be extended to the included +directories. + +\begin{table}[t] + \hrule + \caption{List of paths searched for each supported operating + system.} + \renewcommand{\arraystretch}{1.2} + \begin{center} + \begin{tabular}{lp{.5\textwidth}} + Windows & \verb|%WINDIR%\Fonts| + \\ + Linux & \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break + \fileent{/etc/fonts/fonts.conf} + \\ + Mac & \fileent{\textasciitilde/Library/Fonts},\break + \fileent{/Library/Fonts},\break + \fileent{/System/Library/Fonts}, and\hfill\break + \fileent{/Network/Library/Fonts} + \\ + \end{tabular} + \end{center} + \label{table-searchpaths} + \hrule +\end{table} + +\subsection{Querying from Outside} + +\fileent{luaotfload-tool} also provides rudimentary means of +accessing the information collected in the font database. +% +If the option \verb|--find=|\emphasis{name} is given, the script will +try and search the fonts indexed by \identifier{luaotfload} for a +matching name. +% +For instance, the invocation + +\begin{quote} + \begin{verbatim} + luaotfload-tool --find="Iwona Regular" + \end{verbatim} +\end{quote} + +\noindent +will verify if “Iwona Regular” is found in the database and can be +readily requested in a document. + +If you are unsure about the actual font name, then add the +\verb|-F| (or \verb|--fuzzy|) switch to the command line to enable +approximate matching. +% +Suppose you cannot precisely remember if the variant of +\identifier{Iwona} you are looking for was “Bright” or “Light”. +The query + +\begin{quote} + \begin{verbatim} + luaotfload-tool -F --find="Iwona Bright" + \end{verbatim} +\end{quote} + +\noindent +will tell you that indeed the latter name is correct. + +Basic information about fonts in the database can be displayed +using the \verb|-i| option (\verb|--info|). +% +\begin{quote} + \begin{verbatim} + luaotfload-tool -i --find="Iwona Light Italic" + \end{verbatim} +\end{quote} +% +\noindent +The meaning of the printed values is described in section 4.4 of the +\LUATEX reference manual.\footnote{% + In \TEX Live: \fileent{texmf-dist/doc/luatex/base/luatexref-t.pdf}. +} + +For a much more detailed report about a given font try the \verb|-I| option +instead (\verb|--inspect|). +\begin{quote} + \begin{verbatim} + luaotfload-tool -I --find="Iwona Light Italic" + \end{verbatim} +\end{quote} + +\verb|luaotfload-tool --help| will list the available command line +switches, including some not discussed in detail here. +% +For a full documentation of \identifier{luaotfload-tool} and its +capabilities refer to the manpage +(\verb|man 1 luaotfload-tool|).\footnote{% + Or see \verb|luaotfload-tool.rst| in the source directory. +} + +\subsection{Blacklisting Fonts} +\label{font-blacklist} + +Some fonts are problematic in general, or just in \LUATEX. +% +If you find that compiling your document takes far too long or eats +away all your system’s memory, you can track down the culprit by +running \verb|luaotfload-tool -v| to increase verbosity. +% +Take a note of the \emphasis{filename} of the font that database +creation fails with and append it to the file +\fileent{luaotfload-blacklist.cnf}. + +A blacklist file is a list of font filenames, one per line. +Specifying the full path to where the file is located is optional, the +plain filename should suffice. +% +File extensions (\fileent{.otf}, \fileent{.ttf}, etc.) may be omitted. +% +Anything after a percent (|%|) character until the end of the line +is ignored, so use this to add comments. +% +Place this file to some location where the \identifier{kpse} +library can find it, e.~g. +\fileent{texmf-local/tex/luatex/luaotfload} if you are running +\identifier{\TEX Live},\footnote{% + You may have to run \verb|mktexlsr| if you created a new file in + your \fileent{texmf} tree. +} +or just leave it in the working directory of your document. +% +\identifier{luaotfload} reads all files named +\fileent{luaotfload-blacklist.cnf} it finds, so the fonts in +\fileent{./luaotfload-blacklist.cnf} extend the global blacklist. + +Furthermore, a filename prepended with a dash character (|-|) is +removed from the blacklist, causing it to be temporarily whitelisted +without modifying the global file. +% +An example with explicit paths: + +\begin{verbatim} +% example otf-blacklist.cnf +/Library/Fonts/GillSans.ttc % Luaotfload ignores this font. +-/Library/Fonts/Optima.ttc % This one is usable again, even if + % blacklisted somewhere else. +\end{verbatim} + +\section{Files from \CONTEXT and \LUATEX-Fonts} + +\identifier{luaotfload} relies on code originally written by Hans +Hagen\footnote{% + The creator of the \href{http://wiki.contextgarden.net}{\CONTEXT} + format. +} +for and tested with \CONTEXT. +% +It integrates the font loader as distributed in +the \identifier{\LUATEX-Fonts} package. +% +The original \LUA source files have been combined using the +\fileent{mtx-package} script into a single, self-contained blob. +In this form the font loader has no further dependencies\footnote{% + It covers, however, to some extent the functionality of the + \identifier{lualibs} package. +} +and requires only minor adaptions to integrate into +\identifier{luaotfload}. +% +The guiding principle is to let \CONTEXT/\LUATEX-Fonts take care of +the implementation, and update the imported code from time to time. +% +As maintainers, we aim at importing files from upstream essentially +\emphasis{unmodified}, except for renaming them to prevent name +clashes. +% +This job has been greatly alleviated since the advent of +\LUATEX-Fonts, prior to which the individual dependencies had to be +manually spotted and extracted from the \CONTEXT source code in a +complicated and error-prone fashion. + +Below is a commented list of the files distributed with +\identifier{luaotfload} in one way or the other. +% +See figure \ref{file-graph} on page \pageref{file-graph} for a +graphical representation of the dependencies. +% +From \LUATEX-Fonts, only the file \fileent{luatex-fonts-merged.lua} +has been imported as \fileent{luaotfload-fontloader.lua}. +% +It is generated by \fileent{mtx-package}, a \LUA source code merging +too developed by Hans Hagen.\footnote{% + \fileent{mtx-package} is + \href + {http://repo.or.cz/w/context.git/blob_plain/refs/heads/origin:/scripts/context/lua/mtx-package.lua} + {part of \CONTEXT} + and requires \fileent{mtxrun}. + Run + \verb|mtxrun --script package --help| + to display further information. + For the actual merging code see the file + \fileent{util-mrg.lua} that is part of \CONTEXT. +} +It houses several \LUA files that can be classed in three +categories. + + \begin{itemize} + \let\normalitem=\item + \def\incitem#1{% + \normalitem{\fileent{#1}} + } + \normalitem \emphasis{\LUA utility libraries}, a subset + of what is provided by the \identifier{lualibs} + package. + + \begin{multicols}{2} + \begin{itemize} + \incitem{l-lua.lua} \incitem{l-lpeg.lua} + \incitem{l-function.lua} \incitem{l-string.lua} + \incitem{l-table.lua} \incitem{l-io.lua} + \incitem{l-file.lua} \incitem{l-boolean.lua} + \incitem{l-math.lua} \incitem{util-str.lua} + \end{itemize} + \end{multicols} + + \normalitem The \emphasis{font loader} itself. + These files have been written for + \LUATEX-Fonts and they are distributed along + with \identifier{luaotfload}. + \begin{multicols}{2} + \begin{itemize} + \incitem{luatex-basics-gen.lua} + \incitem{luatex-basics-nod.lua} + \incitem{luatex-fonts-enc.lua} + \incitem{luatex-fonts-syn.lua} + \incitem{luatex-fonts-tfm.lua} + \incitem{luatex-fonts-chr.lua} + \incitem{luatex-fonts-lua.lua} + \incitem{luatex-fonts-inj.lua} + \incitem{luatex-fonts-otn.lua} + \incitem{luatex-fonts-def.lua} + \incitem{luatex-fonts-ext.lua} + \incitem{luatex-fonts-cbk.lua} + \end{itemize} + \end{multicols} + + \normalitem Code related to \emphasis{font handling and + node processing}, taken directly from + \CONTEXT. + \begin{multicols}{2} + \begin{itemize} + \incitem{data-con.lua} \incitem{font-ini.lua} + \incitem{font-con.lua} \incitem{font-cid.lua} + \incitem{font-map.lua} \incitem{font-oti.lua} + \incitem{font-otf.lua} \incitem{font-otb.lua} + \incitem{font-ota.lua} \incitem{font-def.lua} + \incitem{font-otp.lua} + \end{itemize} + \end{multicols} + \end{itemize} + +Note that if \identifier{luaotfload} cannot locate the +merged file, it will load the individual \LUA libraries +instead. +% +Their names remain the same as in \CONTEXT (without the +\verb|otfl|-prefix) since we imported the relevant section of +\fileent{luatex-fonts.lua} unmodified into \fileent{luaotfload-main.lua}. +Thus if you prefer running bleeding edge code from the +\CONTEXT beta, all you have to do is remove +\fileent{luaotfload-merged.lua} from the search path. + +Also, the merged file at some point loads the Adobe Glyph List from a +\LUA table that is contained in \fileent{luaotfload-glyphlist.lua}, +which is automatically generated by the script +\fileent{mkglyphlist}.\footnote{% + See \fileent{luaotfload-font-enc.lua}. + The hard-coded file name is why we have to replace the procedure + that loads the file in \fileent{luaotfload-override.lua}. +} +There is a make target \identifier{glyphs} that will create a fresh +glyph list so we don’t need to import it from \CONTEXT any longer. + +In addition to these, \identifier{luaotfload} requires a number of +files not contained in the merge. Some of these have no equivalent in +\LUATEX-Fonts or \CONTEXT, some were taken unmodified from the latter. + +\begin{itemize} + \let\normalitem=\item + \def\ouritem#1{% + \normalitem{\fileent{#1}}% + \space--\hskip1em + } + \ouritem {luaotfload-features.lua} font feature handling; + incorporates some of the code from + \fileent{font-otc} from \CONTEXT; + \ouritem {luaotfload-override.lua} overrides the \CONTEXT logging + functionality. + \ouritem {luaotfload-loaders.lua} registers the \OpenType + font reader as handler for + Postscript fonts + (\abbrev{pfa}, \abbrev{pfb}). + \ouritem {luaotfload-parsers.lua} various \abbrev{lpeg}-based parsers. + \ouritem {luaotfload-database.lua} font names database. + \ouritem {luaotfload-colors.lua} color handling. + \ouritem {luaotfload-auxiliary.lua} access to internal functionality + for package authors + (proposals for additions welcome). + \ouritem {luaotfload-letterspace.lua} font-based letterspacing. +\end{itemize} + +\begin{figure}[b] + \caption{Schematic of the files in \identifier{Luaotfload}} + \includegraphics[width=\textwidth]{filegraph.pdf} + \label{file-graph} +\end{figure} + +\section{Auxiliary Functions} + +With release version 2.2, \identifier{luaotfload} received +additional functions for package authors to call from outside +(see the file \fileent{luaotfload-auxiliary.lua} for details). +% +The purpose of this addition twofold. +% +Firstly, \identifier{luaotfload} failed to provide a stable interface +to internals in the past which resulted in an unmanageable situation +of different packages abusing the raw access to font objects by means +of the \luafunction{patch_font} callback. +% +When the structure of the font object changed due to an update, all +of these imploded and several packages had to be fixed while +simultaneously providing fallbacks for earlier versions. +% +Now the patching is done on the \identifier{luaotfload} side and can +be adapted with future modifications to font objects without touching +the packages that depend on it. +% +Second, some the capabilities of the font loader and the names +database are not immediately relevant in \identifier{luaotfload} +itself but might nevertheless be of great value to package authors or +end users. + +Note that the current interface is not yet set in stone and the +development team is open to suggestions for improvements or +additions. + +\subsection{Callback Functions} + +The \luafunction{patch_font} callback is inserted in the wrapper +\identifier{luaotfload} provides for the font definition callback +(see below, page \pageref{define-font}). +% +At this place it allows manipulating the font object immediately after +the font loader is done creating it. +% +For a short demonstration of its usefulness, here is a snippet that +writes an entire font object to the file \fileent{fontdump.lua}: + +\begin{quote} + \begin{verbatim} + \input luaotfload.sty + \directlua{ + local dumpfile = "fontdump.lua" + local dump_font = function (tfmdata) + local data = table.serialize(tfmdata) + io.savedata(dumpfile, data) + end + + luatexbase.add_to_callback( + "luaotfload.patch_font", + dump_font, + "my_private_callbacks.dump_font" + ) + } + \font\dumpme=name:Iwona + \bye + \end{verbatim} +\end{quote} + +\emphasis{Beware}: this creates a Lua file of around 150,000 lines of +code, taking up 3~\abbrev{mb} of disk space. +% +By inspecting the output you can get a first impression of how a font +is structured in \LUATEX’s memory, what elements it is composed of, +and in what ways it can be rearranged. + +\subsubsection{Compatibility with Earlier Versions} + +As has been touched on in the preface to this section, the structure +of the object as returned by the fontloader underwent rather drastic +changes during different stages of its development, and not all +packages that made use of font patching have kept up with every one +of it. +% +To ensure compatibility with these as well as older versions of +some packages, \identifier{luaotfload} sets up copies of or references +to data in the font table where it used to be located. +% +For instance, important parameters like the requested point size, the +units factor, and the font name have again been made accessible from +the toplevel of the table even though they were migrated to different +subtables in the meantime. + +\subsubsection{Patches} + +These are mostly concerned with establishing compatibility with \XETEX. + +\begin{itemize} + \let\normalitem=\item + \def\ouritem#1{% + \normalitem{\luafunction{#1}}% + \hfill\break + } + + \ouritem {set_sscale_dimens} + Calculate \texmacro{fontdimen}s 10 and 11 to emulate \XETEX. + + \ouritem {set_capheight} + Calculates \texmacro{fontdimen} 8 like \XETEX. + + \ouritem {patch_cambria_domh} + Correct some values of the font \emphasis{Cambria Math}. + +\end{itemize} + +\subsection{Package Author’s Interface} + +As \LUATEX release 1.0 is nearing, the demand for a reliable interface +for package authors increases. + +\subsubsection{Font Properties} + +Below functions mostly concern querying the different components of a +font like for instance the glyphs it contains, or what font features +are defined for which scripts. + +\begin{itemize} + \let\normalitem=\item + \def\ouritem#1{% + \normalitem{\luafunction{#1}}% + \hfill\break + } + + \ouritem {aux.font_has_glyph (id : int, index : int)} + Predicate that returns true if the font \luafunction{id} + has glyph \luafunction{index}. + + \ouritem {aux.slot_of_name(name : string)} + Translates an Adobe Glyph name to the corresponding glyph + slot. + + \ouritem {aux.name_of_slot(slot : int)} + The inverse of \luafunction{slot_of_name}; note that this + might be incomplete as multiple glyph names may map to the + same codepoint, only one of which is returned by + \luafunction{name_of_slot}. + + \ouritem {aux.provides_script(id : int, script : string)} + Test if a font supports \luafunction{script}. + + \ouritem {aux.provides_language(id : int, script : string, language : string)} + Test if a font defines \luafunction{language} for a given + \luafunction{script}. + + \ouritem {aux.provides_feature(id : int, script : string, + language : string, feature : string)} + Test if a font defines \luafunction{feature} for + \luafunction{language} for a given \luafunction{script}. + + \ouritem {aux.get_math_dimension(id : int, dimension : string)} + Get the dimension \luafunction{dimension} of font \luafunction{id}. + + \ouritem {aux.sprint_math_dimension(id : int, dimension : string)} + Same as \luafunction{get_math_dimension()}, but output the value + in scaled points at the \TEX end. + +\end{itemize} + +\subsubsection{Database} + +\begin{itemize} + \let\normalitem=\item + \def\ouritem#1{% + \normalitem{\luafunction{#1}}% + \hfill\break + } + + \ouritem {aux.scan_external_dir(dir : string)} + Include fonts in directory \luafunction{dir} in font lookups without + adding them to the database. + +\end{itemize} + +\section{Troubleshooting} + +\subsection {Database Generation} +If you encounter problems with some fonts, please first update to the +latest version of this package before reporting a bug, as +\identifier{luaotfload} is under active development and still a moving +target. +% +The development takes place on \identifier{github} at +\url{https://github.com/lualatex/luaotfload} where there is an issue +tracker for submitting bug reports, feature requests and the likes +requests and the likes. + +Bug reports are more likely to be addressed if they contain the output +of + +\begin{quote} + \begin{verbatim} + luaotfload-tool --diagnose=environment,files,permissions + \end{verbatim} +\end{quote} + +\noindent Consult the man page for a description of these options. + +Errors during database generation can be traced by increasing the +verbosity level and redirecting log output to \fileent{stdout}: + +\begin{quote} + \begin{verbatim} + luaotfload-tool -fuvvv --log=stdout + \end{verbatim} +\end{quote} + +\noindent or to a file in \fileent{/tmp}: + +\begin{quote} + \begin{verbatim} + luaotfload-tool -fuvvv --log=file + \end{verbatim} +\end{quote} + +\noindent In the latter case, invoke the \verb|tail(1)| utility on the +file for live monitoring of the progress. + +If database generation fails, the font last printed to the terminal or +log file is likely to be the culprit. +% +Please specify it when reporting a bug, and blacklist it for the time +being (see above, page \pageref{font-blacklist}). + +\subsection {Font Features} + +A common problem is the lack of features for some +\OpenType fonts even when specified. +% +This can be related to the fact that some fonts do not provide features +for the \verb|dflt| script (see above on page \pageref{script-tag}), +which is the default one in this package. +% +If this happens, assigning a noth script when the font is defined should +fix it. +% +For example with \verb|latn|: + +\begin{quote} + \begin{verbatim} + \font\test=file:MyFont.otf:script=latn;+liga; + \end{verbatim} +\end{quote} + +You can get a list of features that a font defines for scripts and +languages by querying it in \fileent{luaotfload-tool}: + +\begin{quote} + \begin{verbatim} + luaotfload-tool --find="Iwona" --inspect + \end{verbatim} +\end{quote} + +\subsection {\LUATEX Programming} + +Another strategy that helps avoiding problems is to not access raw +\LUATEX internals directly. +% +Some of them, even though they are dangerous to access, have not been +overridden or disabled. +% +Thus, whenever possible prefer the functions in the \luafunction{aux} +namespace over direct manipulation of font objects. For example, raw +access to the \luafunction{font.fonts} table like: + +\begin{quote} + \begin{verbatim} + local somefont = font.fonts[2] + \end{verbatim} +\end{quote} + +\noindent can render already defined fonts unusable. +% +Instead, the function \luafunction{font.getfont()} should be used +because it has been replaced by a safe variant. + +However, \luafunction{font.getfont()} only covers fonts handled by the +font loader, e.~g. \identifier{OpenType} and \identifier{TrueType} +fonts, but not \abbrev{tfm} or \abbrev{ofm}. +% +Should you absolutely require access to all fonts known to \LUATEX, +including the virtual and autogenerated ones, then you need to query +both \luafunction{font.getfont()} and \luafunction{font.fonts}. +% +In this case, best define you own accessor: + +\begin{quote} + \begin{verbatim} + local unsafe_getfont = function (id) + local tfmdata = font.getfont (id) + if not tfmdata then + tfmdata = font.fonts[id] + end + return tfmdata + end + + --- use like getfont() + local somefont = unsafe_getfont (2) + \end{verbatim} +\end{quote} + +\part{Implementation} + +\section {\fileent{luaotfload.lua}} + +As of version 2.5, the file \fileent{luaotfload.lua} is no longer +generated from the \abbrev{dtx}. +% +Instead, it is maintained separately as a plain \identifier{Lua} file +\fileent{luaotfload-main.lua} in the Luaotfload \identifier{git} tree. +% +The file documentation which used to be found in this section has been +preserved in the comments. + +\section{\fileent{luaotfload.sty}} + +As of version 2.5, the file \fileent{luaotfload.sty} is no longer +generated from the \abbrev{dtx}. +% +Instead, it is maintained separately as a plain \identifier{\TEX} file +in the Luaotfload \identifier{git} tree. +% +The file documentation which used to be found in this section has +been preserved in the comments. + +\clearpage +\section{The GNU GPL License v2} + +The GPL requires the complete license text to be distributed along +with the code. I recommend the canonical source, instead: +\url{http://www.gnu.org/licenses/old-licenses/gpl-2.0.html}. +But if you insist on an included copy, here it is. +You might want to zoom in. + +\newsavebox{\gpl} +\begin{lrbox}{\gpl} +\begin{minipage}{3\textwidth} +\columnsep=3\columnsep +\begin{multicols}{3} +\begin{center} +{\Large GNU GENERAL PUBLIC LICENSE\par} +\bigskip +{Version 2, June 1991} +\end{center} + +\begin{center} +{\parindent 0in + +Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. + +\bigskip + +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +\bigskip + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +} +\end{center} + +\begin{center} +{\bf\large Preamble} +\end{center} + + +The licenses for most software are designed to take away your freedom to +share and change it. By contrast, the GNU General Public License is +intended to guarantee your freedom to share and change free software---to +make sure the software is free for all its users. This General Public +License applies to most of the Free Software Foundation's software and to +any other program whose authors commit to using it. (Some other Free +Software Foundation software is covered by the GNU Library General Public +License instead.) You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. +Our General Public Licenses are designed to make sure that you have the +freedom to distribute copies of free software (and charge for this service +if you wish), that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free programs; +and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to +deny you these rights or to ask you to surrender the rights. These +restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must give the recipients all the rights that you have. You +must make sure that they, too, receive or can get the source code. And +you must show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If +the software is modified by someone else and passed on, we want its +recipients to know that what they have is not the original, so that any +problems introduced by others will not reflect on the original authors' +reputations. + +Finally, any free program is threatened constantly by software patents. +We wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program +proprietary. To prevent this, we have made it clear that any patent must +be licensed for everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and +modification follow. + +\begin{center} +{\Large \sc Terms and Conditions For Copying, Distribution and + Modification} +\end{center} + +\begin{enumerate} +\item +This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the +terms of this General Public License. The ``Program'', below, refers to +any such program or work, and a ``work based on the Program'' means either +the Program or any derivative work under copyright law: that is to say, a +work containing the Program or a portion of it, either verbatim or with +modifications and/or translated into another language. (Hereinafter, +translation is included without limitation in the term ``modification''.) +Each licensee is addressed as ``you''. + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + +\item You may copy and distribute verbatim copies of the Program's source + code as you receive it, in any medium, provided that you conspicuously + and appropriately publish on each copy an appropriate copyright notice + and disclaimer of warranty; keep intact all the notices that refer to + this License and to the absence of any warranty; and give any other + recipients of the Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you +may at your option offer warranty protection in exchange for a fee. + +\item +You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + +\begin{enumerate} + +\item +You must cause the modified files to carry prominent notices stating that +you changed the files and the date of any change. + +\item +You must cause any work that you distribute or publish, that in +whole or in part contains or is derived from the Program or any +part thereof, to be licensed as a whole at no charge to all third +parties under the terms of this License. + +\item +If the modified program normally reads commands interactively +when run, you must cause it, when started running for such +interactive use in the most ordinary way, to print or display an +announcement including an appropriate copyright notice and a +notice that there is no warranty (or else, saying that you provide +a warranty) and that users may redistribute the program under +these conditions, and telling the user how to view a copy of this +License. (Exception: if the Program itself is interactive but +does not normally print such an announcement, your work based on +the Program is not required to print an announcement.) + +\end{enumerate} + + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + +\item +You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + +\begin{enumerate} + +\item + +Accompany it with the complete corresponding machine-readable +source code, which must be distributed under the terms of Sections +1 and 2 above on a medium customarily used for software interchange; or, + +\item + +Accompany it with a written offer, valid for at least three +years, to give any third party, for a charge no more than your +cost of physically performing source distribution, a complete +machine-readable copy of the corresponding source code, to be +distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, + +\item + +Accompany it with the information you received as to the offer +to distribute corresponding source code. (This alternative is +allowed only for noncommercial distribution and only if you +received the program in object code or executable form with such +an offer, in accord with Subsection b above.) + +\end{enumerate} + + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + +\item +You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + +\item +You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +\item +Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + +\item +If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + +\item +If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + +\item +The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and ``any +later version'', you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + +\item +If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + +\begin{center} +{\Large\sc +No Warranty +} +\end{center} + +\item +{\sc Because the program is licensed free of charge, there is no warranty +for the program, to the extent permitted by applicable law. Except when +otherwise stated in writing the copyright holders and/or other parties +provide the program ``as is'' without warranty of any kind, either expressed +or implied, including, but not limited to, the implied warranties of +merchantability and fitness for a particular purpose. The entire risk as +to the quality and performance of the program is with you. Should the +program prove defective, you assume the cost of all necessary servicing, +repair or correction.} + +\item +{\sc In no event unless required by applicable law or agreed to in writing +will any copyright holder, or any other party who may modify and/or +redistribute the program as permitted above, be liable to you for damages, +including any general, special, incidental or consequential damages arising +out of the use or inability to use the program (including but not limited +to loss of data or data being rendered inaccurate or losses sustained by +you or third parties or a failure of the program to operate with any other +programs), even if such holder or other party has been advised of the +possibility of such damages.} + +\end{enumerate} + + +\begin{center} +{\Large\sc End of Terms and Conditions} +\end{center} + + +\pagebreak[2] + +\section*{Appendix: How to Apply These Terms to Your New Programs} + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to + attach them to the start of each source file to most effectively convey + the exclusion of warranty; and each file should have at least the + ``copyright'' line and a pointer to where the full notice is found. + +\begin{quote} +one line to give the program's name and a brief idea of what it does. \\ +Copyright (C) yyyy name of author \\ + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +\end{quote} + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + +\begin{quote} +Gnomovision version 69, Copyright (C) yyyy name of author \\ +Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ +This is free software, and you are welcome to redistribute it +under certain conditions; type `show c' for details. +\end{quote} + + +The hypothetical commands {\tt show w} and {\tt show c} should show the +appropriate parts of the General Public License. Of course, the commands +you use may be called something other than {\tt show w} and {\tt show c}; +they could even be mouse-clicks or menu items---whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a ``copyright disclaimer'' for the program, if +necessary. Here is a sample; alter the names: + +\begin{quote} +Yoyodyne, Inc., hereby disclaims all copyright interest in the program \\ +`Gnomovision' (which makes passes at compilers) written by James Hacker. \\ + +signature of Ty Coon, 1 April 1989 \\ +Ty Coon, President of Vice +\end{quote} + + +This General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications +with the library. If this is what you want to do, use the GNU Library +General Public License instead of this License. + +\end{multicols} +\end{minipage} +\end{lrbox} + +\begin{center} +\scalebox{0.33}{\usebox{\gpl}} +\end{center} + +\endinput + diff --git a/doc/luaotfload.dtx b/doc/luaotfload.dtx deleted file mode 100644 index e0311a4..0000000 --- a/doc/luaotfload.dtx +++ /dev/null @@ -1,1994 +0,0 @@ -% \iffalse meta-comment -% -% Copyright (C) 2009-2014 -% by Elie Roux -% and Khaled Hosny -% and Philipp Gesang -% -% Home: https://github.com/lualatex/luaotfload -% Support: . -% -% This work is under the GPL v2.0 license. -% -% This work consists of the main source file luaotfload.dtx -% and the derived files -% luaotfload.sty -% -% Unpacking: -% tex luaotfload.dtx -% -% Documentation: -% lualatex luaotfload.dtx -% -% The class ltxdoc loads the configuration file ltxdoc.cfg -% if available. Here you can specify further options, e.g. -% use A4 as paper format: -% \PassOptionsToClass{a4paper}{article} -% -% -% -%<*ignore> -\begingroup - \def\x{LaTeX2e}% -\expandafter\endgroup -\ifcase 0\ifx\install y1\fi\expandafter - \ifx\csname processbatchFile\endcsname\relax\else1\fi - \ifx\fmtname\x\else 1\fi\relax -\else\csname fi\endcsname -% -%<*install> -\input docstrip.tex -\Msg{************************************************************************} -\Msg{* Installation} -\Msg{* Package: luaotfload v2.5 OpenType layout system} -\Msg{************************************************************************} - -\keepsilent -\askforoverwritefalse - -\let\MetaPrefix\relax - -\preamble -This is a generated file. - -Copyright (C) 2009-2014 - by Elie Roux - and Khaled Hosny - and Philipp Gesang - - Home: https://github.com/lualatex/luaotfload - Support: . - -This work is under the GPL v2.0 license. - -This work consists of the main source file luaotfload.dtx -and the derived files - luaotfload.sty - -\endpreamble - -\obeyspaces -\Msg{************************************************************************} -\Msg{*} -\Msg{* To finish the installation you have to move the following} -\Msg{* files into a directory searched by TeX:} -\Msg{*} -\Msg{* luaotfload.sty} -\Msg{*} -\Msg{* Happy TeXing!} -\Msg{*} -\Msg{************************************************************************} - -\endbatchfile -% -%<*ignore> -\fi -% -%<*driver> -\NeedsTeXFormat{LaTeX2e} -\ProvidesFile{luaotfload.drv}% -[2014/**/** v2.5 OpenType layout system]% -\documentclass{ltxdoc} -\usepackage{metalogo,multicol,mdwlist,fancyvrb,xspace} -\usepackage[x11names]{xcolor} -% -\def\primarycolor{DodgerBlue4} %%-> rgb 16 78 139 | #104e8b -\def\secondarycolor{Goldenrod4} %%-> rgb 139 105 200 | #8b6914 -% -\usepackage[ - bookmarks=true, - colorlinks=true, - linkcolor=\primarycolor, - urlcolor=\secondarycolor, - citecolor=\primarycolor, - pdftitle={The luaotfload package}, - pdfsubject={OpenType layout system for Plain TeX and LaTeX}, - pdfauthor={Elie Roux & Khaled Hosny & Philipp Gesang}, - pdfkeywords={luatex, lualatex, unicode, opentype} -]{hyperref} -\usepackage{fontspec} -\usepackage{unicode-math} -\setmainfont[ -% Numbers = OldStyle, %% buggy with font cache - Ligatures = TeX, - BoldFont = {Linux Libertine O Bold}, - ItalicFont = {Linux Libertine O Italic}, - SlantedFont = {Linux Libertine O Italic}, -]{Linux Libertine O} -\setmonofont[Ligatures=TeX,Scale=MatchLowercase]{Liberation Mono} -%setsansfont[Ligatures=TeX]{Linux Biolinum O} -\setsansfont[Ligatures=TeX,Scale=MatchLowercase]{Iwona Medium} -%setmathfont{XITS Math} - -\usepackage{hologo} - -\newcommand\TEX {\TeX\xspace} -\newcommand\LUA {Lua\xspace} -\newcommand\PDFTEX {pdf\TeX\xspace} -\newcommand\LUATEX {Lua\TeX\xspace} -\newcommand\XETEX {\XeTeX\xspace} -\newcommand\LATEX {\LaTeX\xspace} -\newcommand\LUALATEX {Lua\LaTeX\xspace} -\newcommand\CONTEXT {Con\TeX t\xspace} -\newcommand\OpenType {\identifier{Open\kern-.25ex Type}\xspace} - -\def\definehighlight[#1][#2]% - {\ifcsname #1\endcsname\else - \expandafter\def\csname #1\endcsname% - {\bgroup#2\csname #1_indeed\endcsname} - \expandafter\def\csname #1_indeed\endcsname##1% - {##1\egroup}% - \fi} - -\def\restoreunderscore{\catcode`\_=12\relax} - -\definehighlight [fileent][\ttfamily\restoreunderscore] %% files, dirs -\definehighlight [texmacro][\sffamily\itshape\textbackslash] %% cs -\definehighlight[luafunction][\sffamily\itshape\restoreunderscore] %% lua identifiers -\definehighlight [identifier][\sffamily] %% names -\definehighlight [abbrev][\rmfamily\scshape] %% acronyms -\definehighlight [emphasis][\rmfamily\slshape] %% level 1 emph - -\newcommand*\email[1]{\href{mailto:#1}{#1}} - -\renewcommand\partname{Part}%% gets rid of the stupid “file” heading - -\usepackage{syntax}%% bnf for font request syntax - -\usepackage{titlesec} - -\def\movecountertomargin#1{\llap{\rmfamily\upshape#1\hskip2em}} -\def\zeropoint{0pt} -\titleformat \part - {\normalsize\rmfamily\bfseries} - {\movecountertomargin\thepart} \zeropoint {} -\titleformat \section - {\normalsize\rmfamily\scshape} - {\movecountertomargin\thesection} \zeropoint {} -\titleformat \subsection - {\small\rmfamily\itshape} - {\movecountertomargin\thesubsection} \zeropoint {} -\titleformat \subsubsection - {\normalsize\rmfamily\upshape} - {\movecountertomargin\thesubsubsection} \zeropoint {} - -\usepackage{tocloft} -\renewcommand \cftpartfont {\rmfamily\upshape} -\renewcommand \cftsecfont {\rmfamily\upshape} -\renewcommand \cftsubsecfont {\rmfamily\upshape} -\setlength \cftbeforepartskip {1ex} -\setlength \cftbeforesecskip {1ex} - -\VerbatimFootnotes -\begin{document} - \DocInput{luaotfload.dtx}% -\end{document} -% -% \fi -% -% \CheckSum{0} -% -% \CharacterTable -% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -% Digits \0\1\2\3\4\5\6\7\8\9 -% Exclamation \! Double quote \" Hash (number) \# -% Dollar \$ Percent \% Ampersand \& -% Acute accent \' Left paren \( Right paren \) -% Asterisk \* Plus \+ Comma \, -% Minus \- Point \. Solidus \/ -% Colon \: Semicolon \; Less than \< -% Equals \= Greater than \> Question mark \? -% Commercial at \@ Left bracket \[ Backslash \\ -% Right bracket \] Circumflex \^ Underscore \_ -% Grave accent \` Left brace \{ Vertical bar \| -% Right brace \} Tilde \~} -% -% \GetFileInfo{luaotfload.drv} -% -% \title{The \identifier{luaotfload} package} -% \date{2014/**/** v2.5} -% \author{Elie Roux · Khaled Hosny · Philipp Gesang\\ -% Home: \url{https://github.com/lualatex/luaotfload}\\ -% Support: \email{lualatex-dev@tug.org}} -% -% \maketitle -% -% \begin{abstract} -% This package is an adaptation of the \CONTEXT font loading system. -% It allows for loading \OpenType fonts with an extended syntax and adds -% support for a variety of font features. -% \end{abstract} -% -% \tableofcontents -% -% \part{Package Description} -% -% \section{Introduction} -% -% Font management and installation has always been painful with \TEX. A lot of -% files are needed for one font (\abbrev{tfm}, \abbrev{pfb}, \abbrev{map}, -% \abbrev{fd}, \abbrev{vf}), and due to the 8-Bit encoding each font is limited -% to 256 characters. -% But the font world has evolved since the original -% \TEX, and new typographic systems have appeared, most notably the so -% called \emphasis{smart font} technologies like \OpenType -% fonts (\abbrev{otf}). -% These fonts can contain many more characters than \TEX fonts, as well as additional -% functionality like ligatures, old-style numbers, small capitals, -% etc., and support more complex writing systems like Arabic and -% Indic\footnote{% -% Unfortunately, \identifier{luaotfload} doesn‘t support many Indic -% scripts right now. -% Assistance in implementing the prerequisites is greatly -% appreciated. -% } -% scripts. -% \OpenType fonts are widely deployed and available for all -% modern operating systems. -% As of 2013 they have become the de facto standard for advanced text -% layout. -% However, until recently the only way to use them directly in the \TEX -% world was with the \XETEX engine. -% -% Unlike \XETEX, \LUATEX has no built-in support for -% \OpenType or technologies other than the original \TEX fonts. -% Instead, it provides hooks for executing \LUA code during the \TEX run -% that allow implementing extensions for loading fonts and manipulating -% how input text is processed without modifying the underlying engine. -% This is where \identifier{luaotfload} comes into play: -% Based on code from \CONTEXT, it extends \LUATEX with functionality necessary -% for handling \OpenType fonts. -% Additionally, it provides means for accessing fonts known to the operating -% system conveniently by indexing the metadata. -% -% -% \section{Thanks} -% -% \identifier{Luaotfload} is part of \LUALATEX, the community-driven -% project to provide a foundation for using the \LATEX format with the -% full capabilites of the \LUATEX engine. -% As such, the distinction between end users, contributors, and project -% maintainers is intentionally kept less strict, lest we unduly -% personalize the common effort. -% -% Nevertheless, the current maintainers would like to express their -% gratitude to Khaled Hosny, Akira Kakuto, Hironori Kitagawa and Dohyun -% Kim. -% Their contributions -- be it patches, advice, or systematic -% testing -- made the switch from version 1.x to 2.2 possible. -% Also, Hans Hagen, the author of the font loader, made porting the -% code to \LATEX a breeze due to the extra effort he invested into -% isolating it from the rest of \CONTEXT, not to mention his assistance -% in the task and willingness to respond to our suggestions. -% -% -% \section{Loading Fonts} -% -% \identifier{luaotfload} supports an extended font request syntax: -% -% \begin{quote} -% |\font\foo={|% -% \meta{prefix}|:|% -% \meta{font name}|:|% -% \meta{font features}|}|% -% \meta{\TEX font features} -% \end{quote} -% -% \noindent -% The curly brackets are optional and escape the spaces in the enclosed -% font name. -% Alternatively, double quotes serve the same purpose. -% A selection of individual parts of the syntax are discussed below; -% for a more formal description see figure \ref{font-syntax}. -% -% \begin{figure}[b] -% \setlength\grammarparsep{12pt plus 2pt minus 2pt} -% \setlength\grammarindent{5cm} -% \begingroup -% \small -% \begin{grammar} -% ::= `\\font', {\sc csname}, `=', , [ ] ; -% -% ::= `at', {\sc dimension} ; -% -% ::= `"', `"' -% \alt `{', `}' -% \alt ; -% -% ::= , [`:', ] -% \alt `[', `]', [ [`:'], ] ; -% -% ::= , [ ], \{ \} -% \alt , \{ \} ; -% -% ::= `file:', -% \alt `name:', ; -% -% ::= \{ \} ; -% -% ::= \{ \} ; -% -% ::= {\sc tfmname} | ; -% -% ::= \{ {\sc all_characters} - `]' \} ; -% -% ::= `/', (`I' | `B' | `BI' | `IB' | `S=', \{ {\sc digit} \} ) ; -% -% ::= `(', \{ {\sc digit} \}, `)' ; -% -% ::= , \{ `;', \} ; -% -% ::= {\sc feature_id}, `=', {\sc feature_value} -% \alt , {\sc feature_id} ; -% -% ::= `+' | `-' ; -% -% ::= {\sc all_characters} - ( `(' | `/' | `:' ) ; -% \end{grammar} -% \endgroup -% \caption{Font request syntax. -% Braces or double quotes around the -% \emphasis{specification} rule will -% preserve whitespace in file names. -% In addition to the font style modifiers -% (\emphasis{slash-notation}) given above, there -% are others that are recognized but will be silently -% ignored: {\ttfamily aat}, -% {\ttfamily icu}, and -% {\ttfamily gr}. -% The special terminals are: -% {\sc feature\textunderscore id} for a valid font -% feature name and -% {\sc feature\textunderscore value} for the corresponding -% value. -% {\sc tfmname} is the name of a \abbrev{tfm} file. -% {\sc digit} again refers to bytes 48--57, and -% {\sc all\textunderscore characters} to all byte values. -% {\sc csname} and {\sc dimension} are the \TEX concepts.} -% \label{font-syntax} -% \end{figure} -% -% \subsection{Prefix -- the \identifier{luaotfload}{ }Way} -% -% In \identifier{luaotfload}, the canonical syntax for font requests -% requires a \emphasis{prefix}: -% \begin{quote} -% |\font\fontname=|\meta{prefix}|:|\meta{fontname}\dots -% \end{quote} -% where \meta{prefix} is either \verb|file:| or \verb|name:|.\footnote{% -% The development version also knows two further prefixes, -% \verb|kpse:| and \verb|my:|. -% A \verb|kpse| lookup is restricted to files that can be found by -% \identifier{kpathsea} and -% will not attempt to locate system fonts. -% This behavior can be of value when an extra degree of encapsulation is -% needed, for instance when supplying a customized tex distribution. -% -% The \verb|my| lookup takes this a step further: it lets you define -% a custom resolver function and hook it into the \luafunction{resolve_font} -% callback. -% This ensures full control over how a file is located. -% For a working example see the -% \href{https://bitbucket.org/phg/lua-la-tex-tests/src/5f6a535d/pln-lookup-callback-1.tex} -% {test repo}. -% } -% It determines whether the font loader should interpret the request as -% a \emphasis{file name} or -% \emphasis{font name}, respectively, -% which again influences how it will attempt to locate the font. -% Examples for font names are -% “Latin Modern Italic”, -% “GFS Bodoni Rg”, and -% “PT Serif Caption” -% -- they are the human readable identifiers -% usually listed in drop-down menus and the like.\footnote{% -% Font names may appear like a great choice at first because they -% offer seemingly more intuitive identifiers in comparison to arguably -% cryptic file names: -% “PT Sans Bold” is a lot more descriptive than \fileent{PTS75F.ttf}. -% On the other hand, font names are quite arbitrary and there is no -% universal method to determine their meaning. -% While \identifier{luaotfload} provides fairly sophisticated heuristic -% to figure out a matching font style, weight, and optical size, it -% cannot be relied upon to work satisfactorily for all font files. -% For an in-depth analysis of the situation and how broken font names -% are, please refer to -% \href{http://www.ntg.nl/pipermail/ntg-context/2013/073889.html} -% {this post} -% by Hans Hagen, the author of the font loader. -% If in doubt, use filenames. -% \fileent{luaotfload-tool} can perform the matching for you with the -% option \verb|--find=|, and you can use the file name it returns -% in your font definition. -% } -% In order for fonts installed both in system locations and in your -% \fileent{texmf} to be accessible by font name, \identifier{luaotfload} must -% first collect the metadata included in the files. -% Please refer to section~\ref{sec:fontdb} below for instructions on how to -% create the database. -% -% File names are whatever your file system allows them to be, except -% that that they may not contain the characters -% \verb|(|, -% \verb|:|, and -% \verb|/|. -% As is obvious from the last exception, the \verb|file:| lookup will -% not process paths to the font location -- only those -% files found when generating the database are addressable this way. -% Continue below in the \XETEX section if you need to load your fonts -% by path. -% The file names corresponding to the example font names above are -% \fileent{lmroman12-italic.otf}, -% \fileent{GFSBodoni.otf}, and -% \fileent{PTZ56F.ttf}. -% -% \subsection{Compatibility Layer} -% -% In addition to the regular prefixed requests, \identifier{luaotfload} -% accepts loading fonts the \XETEX way. -% There are again two modes: bracketed and unbracketed. -% A bracketed request looks as follows. -% -% \begin{quote} -% |\font\fontname=[|\meta{path to file}|]| -% \end{quote} -% -% \noindent -% Inside the square brackets, every character except for a closing -% bracket is permitted, allowing for specifying paths to a font file. -% Naturally, path-less file names are equally valid and processed the -% same way as an ordinary \verb|file:| lookup. -% -% \begin{quote} -% |\font\fontname=|\meta{font name} \dots -% \end{quote} -% -% Unbracketed (or, for lack of a better word: \emphasis{anonymous}) -% font requests resemble the conventional \TEX syntax. -% However, they have a broader spectrum of possible interpretations: -% before anything else, \identifier{luaotfload} attempts to load a -% traditional \TEX Font Metric (\abbrev{tfm} or \abbrev{ofm}). -% If this fails, it performs a \verb|name:| lookup, which itself will -% fall back to a \verb|file:| lookup if no database entry matches -% \meta{font name}. -% -% Furthermore, \identifier{luaotfload} supports the slashed (shorthand) -% font style notation from \XETEX. -% -% \begin{quote} -% |\font\fontname=|\meta{font name}|/|\meta{modifier}\dots -% \end{quote} -% -% \noindent -% Currently, four style modifiers are supported: -% \verb|I| for italic shape, -% \verb|B| for bold weight, -% \verb|BI| or \verb|IB| for the combination of both. -% Other “slashed” modifiers are too specific to the \XETEX engine and -% have no meaning in \LUATEX. -% -% \subsection{Examples} -% -% \subsubsection{Loading by File Name} -% -% For example, conventional \abbrev{type1} font can be loaded with a \verb|file:| -% request like so: -% -% \begin{quote} -% \begin{verbatim} -% \font\lmromanten={file:ec-lmr10} at 10pt -% \end{verbatim} -% \end{quote} -% -% The \OpenType version of Janusz Nowacki’s font \emphasis{Antykwa -% Półtawskiego}\footnote{% -% \url{http://jmn.pl/antykwa-poltawskiego/}, also available in -% in \TEX Live. -% } -% in its condensed variant can be loaded as follows: -% -% \begin{quote} -% \begin{verbatim} -% \font\apcregular=file:antpoltltcond-regular.otf at 42pt -% \end{verbatim} -% \end{quote} -% -% The next example shows how to load the \emphasis{Porson} font digitized by -% the Greek Font Society using \XETEX-style syntax and an absolute path from a -% non-standard directory: -% -% \begin{quote} -% \begin{verbatim} -% \font\gfsporson="[/tmp/GFSPorson.otf]" at 12pt -% \end{verbatim} -% \end{quote} -% -% \subsubsection{Loading by Font Name} -% -% The \verb|name:| lookup does not depend on cryptic filenames: -% -% \begin{quote} -% \begin{verbatim} -% \font\pagellaregular={name:TeX Gyre Pagella} at 9pt -% \end{verbatim} -% \end{quote} -% -% A bit more specific but essentially the same lookup would be: -% -% \begin{quote} -% \begin{verbatim} -% \font\pagellaregular={name:TeX Gyre Pagella Regular} at 9pt -% \end{verbatim} -% \end{quote} -% -% \noindent -% Which fits nicely with the whole set: -% -% \begin{quote} -% \begin{verbatim} -% \font\pagellaregular ={name:TeX Gyre Pagella Regular} at 9pt -% \font\pagellaitalic ={name:TeX Gyre Pagella Italic} at 9pt -% \font\pagellabold ={name:TeX Gyre Pagella Bold} at 9pt -% \font\pagellabolditalic={name:TeX Gyre Pagella Bolditalic} at 9pt -% -% {\pagellaregular foo bar baz\endgraf} -% {\pagellaitalic foo bar baz\endgraf} -% {\pagellabold foo bar baz\endgraf} -% {\pagellabolditalic foo bar baz\endgraf} -% -% ... -% \end{verbatim} -% \end{quote} -% -% \subsubsection{Modifiers} -% -% If the entire \emphasis{Iwona} family\footnote{% -% \url{http://jmn.pl/kurier-i-iwona/}, -% also in \TEX Live. -% } -% is installed in some location accessible by \identifier{luaotfload}, -% the regular shape can be loaded as follows: -% -% \begin{quote} -% \begin{verbatim} -% \font\iwona=Iwona at 20pt -% \end{verbatim} -% \end{quote} -% -% \noindent -% To load the most common of the other styles, the slash notation can -% be employed as shorthand: -% -% \begin{quote} -% \begin{verbatim} -% \font\iwonaitalic =Iwona/I at 20pt -% \font\iwonabold =Iwona/B at 20pt -% \font\iwonabolditalic=Iwona/BI at 20pt -% \end{verbatim} -% \end{quote} -% -% \noindent -% which is equivalent to these full names: -% -% \begin{quote} -% \begin{verbatim} -% \font\iwonaitalic ="Iwona Italic" at 20pt -% \font\iwonabold ="Iwona Bold" at 20pt -% \font\iwonabolditalic="Iwona BoldItalic" at 20pt -% \end{verbatim} -% \end{quote} -% -% \section{Font features} -% -% \emphasis{Font features} are the second to last component in the -% general scheme for font requests: -% -% \begin{quote} -% |\font\foo={|% -% \meta{prefix}|:|% -% \meta{font name}|:|% -% \meta{font features}|}|% -% \meta{\TEX font features} -% \end{quote} -% -% \noindent -% If style modifiers are present (\XETEX style), they must precede -% \meta{font features}. -% -% The element \meta{font features} is a semicolon-separated list of feature -% tags\footnote{% -% Cf. \url{http://www.microsoft.com/typography/otspec/featurelist.htm}. -% } -% and font options. -% Prepending a font feature with a |+| (plus sign) enables it, whereas -% a |-| (minus) disables it. For instance, the request -% -% \begin{quote} -% \begin{verbatim} -% \font\test=LatinModernRoman:+clig;-kern -% \end{verbatim} -% \end{quote} -% -% \noindent activates contextual ligatures (|clig|) and disables -% kerning (|kern|). -% Alternatively the options |true| or |false| can be passed to -% the feature in a key/value expression. -% The following request has the same meaning as the last one: -% -% \begin{quote} -% \begin{verbatim} -% \font\test=LatinModernRoman:clig=true;kern=false -% \end{verbatim} -% \end{quote} -% -% \noindent -% Furthermore, this second syntax is required should a font feature -% accept other options besides a true/false switch. -% For example, \emphasis{stylistic alternates} (|salt|) are variants of given -% glyphs. -% They can be selected either explicitly by supplying the variant -% index (starting from one), or randomly by setting the value to, -% obviously, |random|. -% -% \iffalse TODO verify that this actually works with a font that supports -% the salt/random feature!\fi -% \begin{quote} -% \begin{verbatim} -% \font\librmsaltfirst=LatinModernRoman:salt=1 -% \end{verbatim} -% \end{quote} -% -% \noindent Other font options include: -% -% \begin{description} -% -% \item [mode] \hfill \\ -% \identifier{luaotfload} has two \OpenType processing -% \emphasis{modes}: -% \identifier{base} and \identifier{node}. -% -% \identifier{base} mode works by mapping \OpenType -% features to traditional \TEX ligature and kerning mechanisms. -% Supporting only non-contextual substitutions and kerning -% pairs, it is the slightly faster, albeit somewhat limited, variant. -% \identifier{node} mode works by processing \TeX’s internal -% node list directly at the \LUA end and supports -% a wider range of \OpenType features. -% The downside is that the intricate operations required for -% \identifier{node} mode may slow down typesetting especially -% with complex fonts and it does not work in math mode. -% -% By default \identifier{luaotfload} is in \identifier{node} -% mode, and \identifier{base} mode has to be requested where needed, -% e.~g. for math fonts. -% -% \item [script] \label{script-tag} \hfill \\ -% An \OpenType script tag;\footnote{% -% See \url{http://www.microsoft.com/typography/otspec/scripttags.htm} -% for a list of valid values. -% For scripts derived from the Latin alphabet the value -% |latn| is good choice. -% } -% the default value is |dlft|. -% Some fonts, including very popular ones by foundries like Adobe, -% do not assign features to the |dflt| script, in -% which case the script needs to be set explicitly. -% -% \item [language] \hfill \\ -% An \OpenType language system identifier,\footnote{% -% Cf. \url{http://www.microsoft.com/typography/otspec/languagetags.htm}. -% } -% defaulting to |dflt|. -% -% \item [featurefile] \hfill \\ -% A comma-separated list of feature files to be applied to the -% font. -% Feature files contain a textual representation of -% \OpenType tables and extend the features of a font -% on fly. -% After they are applied to a font, features defined in a -% feature file can be enabled or disabled just like any -% other font feature. -% The syntax is documented in \identifier{Adobe}’s -% \OpenType Feature File Specification.\footnote{% -% Cf. \url{http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. -% } -% -% For a demonstration of how to set a |tkrn| feature consult -% the file |tkrn.fea| that is part of \identifier{luaotfload}. -% It can be read and applied as follows: -% -% |\font\test=Latin Modern Roman:featurefile=tkrn.fea;+tkrn| -% -% \item [color] \hfill \\ -% A font color, defined as a triplet of two-digit hexadecimal -% \abbrev{rgb} values, with an optional fourth value for -% transparency -% (where |00| is completely transparent and |FF| is opaque). -% -% For example, in order to set text in semitransparent red: -% -% \begin{quote} -% \begin{verbatim} -% \font\test={Latin Modern Roman}:color=FF0000BB -% \end{verbatim} -% \end{quote} -% -% \item [kernfactor \& letterspace] \hfill \\ -% Define a font with letterspacing (tracking) enabled. -% In \identifier{luaotfload}, letterspacing is implemented by -% inserting additional kerning between glyphs. -% -% This approach is derived from and still quite similar to the -% \emphasis{character kerning} (\texmacro{setcharacterkerning} / -% \texmacro{definecharacterkerning} \& al.) functionality of -% Context, see the file \fileent{typo-krn.lua} there. -% The main difference is that \identifier{luaotfload} does not -% use \LUATEX attributes to assign letterspacing to regions, -% but defines virtual letterspaced versions of a font. -% -% The option \identifier{kernfactor} accepts a numeric value that -% determines the letterspacing factor to be applied to the font -% size. -% E.~g. a kern factor of $0.42$ applied to a $10$ pt font -% results in $4.2$ pt of additional kerning applied to each -% pair of glyphs. -% Ligatures are split into their component glyphs unless -% explicitly ignored (see below). -% -% For compatibility with \XETEX an alternative -% \identifier{letterspace} option is supplied that interprets the -% supplied value as a \emphasis{percentage} of the font size but -% is otherwise identical to \identifier{kernfactor}. -% Consequently, both definitions in below snippet yield the same -% letterspacing width: -% -% \begin{quote} -% \begin{verbatim} -% \font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" -% \font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" -% \end{verbatim} -% \end{quote} -% -% Specific pairs of letters and ligatures may be exempt from -% letterspacing by defining the \LUA functions -% \luafunction{keeptogether} and \luafunction{keepligature}, -% respectively, inside the namespace \verb|luaotfload.letterspace|. -% Both functions are called whenever the letterspacing callback -% encounters an appropriate node or set of nodes. -% If they return a true-ish value, no extra kern is inserted at -% the current position. -% \luafunction{keeptogether} receives a pair of consecutive -% glyph nodes in order of their appearance in the node list. -% \luafunction{keepligature} receives a single node which can be -% analyzed into components. -% (For details refer to the \emphasis{glyph nodes} section in the -% \LUATEX reference manual.) -% The implementation of both functions is left entirely to the -% user. -% -% -% \item [protrusion \& expansion] \hfill \\ -% These keys control microtypographic features of the font, -% namely \emphasis{character protrusion} and \emphasis{font -% expansion}. -% Their arguments are names of \LUA tables that contain -% values for the respective features.\footnote{% -% For examples of the table layout please refer to the -% section of the file \fileent{luaotfload-fonts-ext.lua} where the -% default values are defined. -% Alternatively and with loss of information, you can dump -% those tables into your terminal by issuing -% \begin{verbatim} -% \directlua{inspect(fonts.protrusions.setups.default) -% inspect(fonts.expansions.setups.default)} -% \end{verbatim} -% at some point after loading \fileent{luaotfload.sty}. -% } -% For both, only the set \identifier{default} is predefined. -% -% For example, to define a font with the default -% protrusion vector applied\footnote{% -% You also need to set -% \verb|pdfprotrudechars=2| and -% \verb|pdfadjustspacing=2| -% to activate protrusion and expansion, respectively. -% See the -% \href{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% -% {\PDFTEX manual} -% for details. -% }: -% -% \begin{quote} -% \begin{verbatim} -% \font\test=LatinModernRoman:protrusion=default -% \end{verbatim} -% \end{quote} -% \end{description} -% -% \paragraph{Non-standard font features} -% \identifier{luaotfload} adds a number of features that are not defined -% in the original \OpenType specification, most of them -% aiming at emulating the behavior familiar from other \TEX engines. -% Currently (2014) there are three of them: -% -% \begin{description} -% -% \item [anum] -% Substitutes the glyphs in the \abbrev{ascii} number range -% with their counterparts from eastern Arabic or Persian, -% depending on the value of \identifier{language}. -% -% \item [tlig] -% Applies legacy \TEX ligatures: -% -% \begin{tabular}{rlrl} -% `` & \verb|``| & '' & \verb|''| \\ -% ` & \verb|`| & ' & \verb|'| \\ -% " & \verb|"| & -- & \verb|--| \\ -% --- & \verb|---| & !` & \verb|!`| \\ -% ?` & \verb|?`| & & \\ -% \end{tabular} -% -% \footnote{% -% These contain the feature set \verb|trep| of earlier -% versions of \identifier{luaotfload}. -% -% Note to \XETEX users: this is the equivalent of the -% assignment \verb|mapping=text-tex| using \XETEX's input -% remapping feature. -% } -% -% \item [itlc] -% Computes italic correction values (active by default). -% -% \end{description} -% -% -% -% \section{Font names database} -% \label{sec:fontdb} -% -% As mentioned above, \identifier{luaotfload} keeps track of which -% fonts are available to \LUATEX by means of a \emphasis{database}. -% This allows referring to fonts not only by explicit filenames but -% also by the proper names contained in the metadata which is often -% more accessible to humans.\footnote{% -% The tool \href{http://www.lcdf.org/type/}{\fileent{otfinfo}} (comes -% with \TEX Live), when invoked on a font file with the \verb|-i| -% option, lists the variety of name fields defined for it. -% } -% -% When \identifier{luaotfload} is asked to load a font by a font name, -% it will check if the database exists and load it, or else generate a -% fresh one. -% Should it then fail to locate the font, an update to the database is -% performed in case the font has been added to the system only -% recently. As soon as the database is updated, the resolver will try -% and look up the font again, all without user intervention. -% The goal is for \identifier{luaotfload} to act in the background and -% behave as unobtrusively as possible, while providing a convenient -% interface to the fonts installed on the system. -% -% Generating the database for the first time may take a while since it -% inspects every font file on your computer. -% This is particularly noticeable if it occurs during a typesetting run. -% In any case, subsequent updates to the database will be quite fast. -% -% \subsection[luaotfload-tool / mkluatexfontdb.lua]% -% {\fileent{luaotfload-tool} / -% \fileent{mkluatexfontdb.lua}\footnote{% -% The script may be named just \fileent{mkluatexfontdb} in your -% distribution. -% }} -% -% It can still be desirable at times to do some of these steps -% manually, and without having to compile a document. -% To this end, \identifier{luaotfload} comes with the utility -% \fileent{luaotfload-tool} that offers an interface to the database -% functionality. -% Being a \LUA script, there are two ways to run it: -% either make it executable (\verb|chmod +x| on unixoid systems) or -% pass it as an argument to \fileent{texlua}.\footnote{% -% Tests by the maintainer show only marginal performance gain by -% running with Luigi Scarso’s -% \href{https://foundry.supelec.fr/projects/luajittex/}% -% {\identifier{Luajit\kern-.25ex\TEX}}, -% which is probably due to the fact that most of the time is spent -% on file system operations. -% -% \emphasis{Note}: -% On \abbrev{MS} \identifier{Windows} systems, the script can be run -% either by calling the wrapper application -% \fileent{luaotfload-tool.exe} or as -% \verb|texlua.exe luaotfload-tool.lua|. -% } -% Invoked with the argument \verb|--update| it will perform a database -% update, scanning for fonts not indexed. -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool --update -% \end{verbatim} -% \end{quote} -% -% Adding the \verb|--force| switch will initiate a complete -% rebuild of the database. -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool --update --force -% \end{verbatim} -% \end{quote} -% -% For sake of backwards compatibility, \fileent{luaotfload-tool} may be -% renamed or symlinked to \fileent{mkluatexfontdb}. -% Whenever it is run under this name, it will update the database -% first, mimicking the behavior of earlier versions of -% \identifier{luaotfload}. -% -% \subsection{Search Paths} -% -% \identifier{luaotfload} scans those directories where fonts are -% expected to be located on a given system. -% On a Linux machine it follows the paths listed in the -% \identifier{Fontconfig} configuration files; -% consult \verb|man 5 fonts.conf| for further information. -% On \identifier{Windows} systems, the standard location is -% \verb|Windows\Fonts|, -% while \identifier{Mac OS~X} requires a multitude of paths to -% be examined. -% The complete list is is given in table \ref{table-searchpaths}. -% Other paths can be specified by setting the environment variable -% \verb+OSFONTDIR+. -% If it is non-empty, then search will be extended to the included -% directories. -% -% \begin{table}[t] -% \hrule -% \caption{List of paths searched for each supported operating -% system.} -% \renewcommand{\arraystretch}{1.2} -% \begin{center} -% \begin{tabular}{lp{.5\textwidth}} -% Windows & \verb|%WINDIR%\Fonts| -% \\ -% Linux & \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break -% \fileent{/etc/fonts/fonts.conf} -% \\ -% Mac & \fileent{\textasciitilde/Library/Fonts},\break -% \fileent{/Library/Fonts},\break -% \fileent{/System/Library/Fonts}, and\hfill\break -% \fileent{/Network/Library/Fonts} -% \\ -% \end{tabular} -% \end{center} -% \label{table-searchpaths} -% \hrule -% \end{table} -% -% \subsection{Querying from Outside} -% -% \fileent{luaotfload-tool} also provides rudimentary means of -% accessing the information collected in the font database. -% If the option \verb|--find=|\emphasis{name} is given, the script will -% try and search the fonts indexed by \identifier{luaotfload} for a -% matching name. -% For instance, the invocation -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool --find="Iwona Regular" -% \end{verbatim} -% \end{quote} -% -% \noindent -% will verify if “Iwona Regular” is found in the database and can be -% readily requested in a document. -% -% If you are unsure about the actual font name, then add the -% \verb|-F| (or \verb|--fuzzy|) switch to the command line to enable -% approximate matching. -% Suppose you cannot precisely remember if the variant of -% \identifier{Iwona} you are looking for was “Bright” or “Light”. -% The query -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool -F --find="Iwona Bright" -% \end{verbatim} -% \end{quote} -% -% \noindent -% will tell you that indeed the latter name is correct. -% -% Basic information about fonts in the database can be displayed -% using the \verb|-i| option (\verb|--info|). -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool -i --find="Iwona Light Italic" -% \end{verbatim} -% \end{quote} -% \noindent -% The meaning of the printed values is described in section 4.4 of the -% \LUATEX reference manual.\footnote{% -% In \TEX Live: \fileent{texmf-dist/doc/luatex/base/luatexref-t.pdf}. -% } -% -% For a much more detailed report about a given font try the \verb|-I| option -% instead (\verb|--inspect|). -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool -I --find="Iwona Light Italic" -% \end{verbatim} -% \end{quote} -% -% \verb|luaotfload-tool --help| will list the available command line -% switches, including some not discussed in detail here. -% For a full documentation of \identifier{luaotfload-tool} and its -% capabilities refer to the manpage -% (\verb|man 1 luaotfload-tool|).\footnote{% -% Or see \verb|luaotfload-tool.rst| in the source directory. -% } -% -% \subsection{Blacklisting Fonts} -% \label{font-blacklist} -% -% Some fonts are problematic in general, or just in \LUATEX. -% If you find that compiling your document takes far too long or eats -% away all your system’s memory, you can track down the culprit by -% running \verb|luaotfload-tool -v| to increase verbosity. -% Take a note of the \emphasis{filename} of the font that database -% creation fails with and append it to the file -% \fileent{luaotfload-blacklist.cnf}. -% -% A blacklist file is a list of font filenames, one per line. -% Specifying the full path to where the file is located is optional, the -% plain filename should suffice. -% File extensions (\fileent{.otf}, \fileent{.ttf}, etc.) may be omitted. -% Anything after a percent (|%|) character until the end of the line -% is ignored, so use this to add comments. -% Place this file to some location where the \identifier{kpse} -% library can find it, e.~g. -% \fileent{texmf-local/tex/luatex/luaotfload} if you are running -% \identifier{\TEX Live},\footnote{% -% You may have to run \verb|mktexlsr| if you created a new file in -% your \fileent{texmf} tree. -% } -% or just leave it in the working directory of your document. -% \identifier{luaotfload} reads all files named -% \fileent{luaotfload-blacklist.cnf} it finds, so the fonts in -% \fileent{./luaotfload-blacklist.cnf} extend the global blacklist. -% -% Furthermore, a filename prepended with a dash character (|-|) is -% removed from the blacklist, causing it to be temporarily whitelisted -% without modifying the global file. -% An example with explicit paths: -% -% \begin{verbatim} -% % example otf-blacklist.cnf -% /Library/Fonts/GillSans.ttc % Luaotfload ignores this font. -% -/Library/Fonts/Optima.ttc % This one is usable again, even if -% % blacklisted somewhere else. -% \end{verbatim} -% -% \section{Files from \CONTEXT and \LUATEX-Fonts} -% -% \identifier{luaotfload} relies on code originally written by Hans -% Hagen\footnote{% -% The creator of the \href{http://wiki.contextgarden.net}{\CONTEXT} -% format. -% } -% for and tested with \CONTEXT. -% It integrates the font loader as distributed in -% the \identifier{\LUATEX-Fonts} package. -% The original \LUA source files have been combined using the -% \fileent{mtx-package} script into a single, self-contained blob. -% In this form the font loader has no further dependencies\footnote{% -% It covers, however, to some extent the functionality of the -% \identifier{lualibs} package. -% } -% and requires only minor adaptions to integrate into -% \identifier{luaotfload}. -% The guiding principle is to let \CONTEXT/\LUATEX-Fonts take care of -% the implementation, and update the imported code from time to time. -% As maintainers, we aim at importing files from upstream essentially -% \emphasis{unmodified}, except for renaming them to prevent name -% clashes. -% This job has been greatly alleviated since the advent of -% \LUATEX-Fonts, prior to which the individual dependencies had to be -% manually spotted and extracted from the \CONTEXT source code in a -% complicated and error-prone fashion. -% -% Below is a commented list of the files distributed with -% \identifier{luaotfload} in one way or the other. -% See figure \ref{file-graph} on page \pageref{file-graph} for a -% graphical representation of the dependencies. -% From \LUATEX-Fonts, only the file \fileent{luatex-fonts-merged.lua} -% has been imported as \fileent{luaotfload-fontloader.lua}. -% It is generated by \fileent{mtx-package}, a \LUA source code merging -% too developed by Hans Hagen.\footnote{% -% \fileent{mtx-package} is -% \href -% {http://repo.or.cz/w/context.git/blob_plain/refs/heads/origin:/scripts/context/lua/mtx-package.lua} -% {part of \CONTEXT} -% and requires \fileent{mtxrun}. -% Run -% \verb|mtxrun --script package --help| -% to display further information. -% For the actual merging code see the file -% \fileent{util-mrg.lua} that is part of \CONTEXT. -% } -% It houses several \LUA files that can be classed in three -% categories. -% -% \begin{itemize} -% \let\normalitem=\item -% \def\incitem#1{% -% \normalitem{\fileent{#1}} -% } -% \normalitem \emphasis{\LUA utility libraries}, a subset -% of what is provided by the \identifier{lualibs} -% package. -% -% \begin{multicols}{2} -% \begin{itemize} -% \incitem{l-lua.lua} \incitem{l-lpeg.lua} -% \incitem{l-function.lua} \incitem{l-string.lua} -% \incitem{l-table.lua} \incitem{l-io.lua} -% \incitem{l-file.lua} \incitem{l-boolean.lua} -% \incitem{l-math.lua} \incitem{util-str.lua} -% \end{itemize} -% \end{multicols} -% -% \normalitem The \emphasis{font loader} itself. -% These files have been written for -% \LUATEX-Fonts and they are distributed along -% with \identifier{luaotfload}. -% \begin{multicols}{2} -% \begin{itemize} -% \incitem{luatex-basics-gen.lua} -% \incitem{luatex-basics-nod.lua} -% \incitem{luatex-fonts-enc.lua} -% \incitem{luatex-fonts-syn.lua} -% \incitem{luatex-fonts-tfm.lua} -% \incitem{luatex-fonts-chr.lua} -% \incitem{luatex-fonts-lua.lua} -% \incitem{luatex-fonts-inj.lua} -% \incitem{luatex-fonts-otn.lua} -% \incitem{luatex-fonts-def.lua} -% \incitem{luatex-fonts-ext.lua} -% \incitem{luatex-fonts-cbk.lua} -% \end{itemize} -% \end{multicols} -% -% \normalitem Code related to \emphasis{font handling and -% node processing}, taken directly from -% \CONTEXT. -% \begin{multicols}{2} -% \begin{itemize} -% \incitem{data-con.lua} \incitem{font-ini.lua} -% \incitem{font-con.lua} \incitem{font-cid.lua} -% \incitem{font-map.lua} \incitem{font-oti.lua} -% \incitem{font-otf.lua} \incitem{font-otb.lua} -% \incitem{font-ota.lua} \incitem{font-def.lua} -% \incitem{font-otp.lua} -% \end{itemize} -% \end{multicols} -% \end{itemize} -% -% Note that if \identifier{luaotfload} cannot locate the -% merged file, it will load the individual \LUA libraries -% instead. -% Their names remain the same as in \CONTEXT (without the -% \verb|otfl|-prefix) since we imported the relevant section of -% \fileent{luatex-fonts.lua} unmodified into \fileent{luaotfload-main.lua}. -% Thus if you prefer running bleeding edge code from the -% \CONTEXT beta, all you have to do is remove -% \fileent{luaotfload-merged.lua} from the search path. -% -% Also, the merged file at some point -% loads the Adobe Glyph List from a \LUA table that is contained in -% \fileent{luaotfload-glyphlist.lua}, which is automatically generated by the -% script \fileent{mkglyphlist}.\footnote{% -% See \fileent{luaotfload-font-enc.lua}. -% The hard-coded file name is why we have to replace the procedure -% that loads the file in \fileent{luaotfload-override.lua}. -% } -% There is a make target \identifier{glyphs} that will create a fresh -% glyph list so we don’t need to import it from \CONTEXT -% any longer. -% -% In addition to these, \identifier{luaotfload} requires a number of -% files not contained in the merge. Some of these have no equivalent in -% \LUATEX-Fonts or \CONTEXT, some were taken unmodified from the -% latter. -% -% \begin{itemize} -% \let\normalitem=\item -% \def\ouritem#1{% -% \normalitem{\fileent{#1}}% -% \space--\hskip1em -% } -% \ouritem {luaotfload-features.lua} font feature handling; -% incorporates some of the code from -% \fileent{font-otc} from \CONTEXT; -% \ouritem {luaotfload-override.lua} overrides the \CONTEXT logging -% functionality. -% \ouritem {luaotfload-loaders.lua} registers the \OpenType -% font reader as handler for -% Postscript fonts -% (\abbrev{pfa}, \abbrev{pfb}). -% \ouritem {luaotfload-parsers.lua} various \abbrev{lpeg}-based parsers. -% \ouritem {luaotfload-database.lua} font names database. -% \ouritem {luaotfload-colors.lua} color handling. -% \ouritem {luaotfload-auxiliary.lua} access to internal functionality -% for package authors -% (proposals for additions welcome). -% \ouritem {luaotfload-letterspace.lua} font-based letterspacing. -% \end{itemize} -% -% \begin{figure}[b] -% \caption{Schematic of the files in \identifier{Luaotfload}} -% \includegraphics[width=\textwidth]{filegraph.pdf} -% \label{file-graph} -% \end{figure} -% -% \section{Auxiliary Functions} -% -% With release version 2.2, \identifier{luaotfload} received -% additional functions for package authors to call from outside -% (see the file \fileent{luaotfload-auxiliary.lua} for details). -% The purpose of this addition twofold. -% Firstly, \identifier{luaotfload} failed to provide a stable interface -% to internals in the past which resulted in an unmanageable situation -% of different packages abusing the raw access to font objects by means -% of the \luafunction{patch_font} callback. -% When the structure of the font object changed due to an update, all -% of these imploded and several packages had to be fixed while -% simultaneously providing fallbacks for earlier versions. -% Now the patching is done on the \identifier{luaotfload} side and can -% be adapted with future modifications to font objects without touching -% the packages that depend on it. -% Second, some the capabilities of the font loader and the names -% database are not immediately relevant in \identifier{luaotfload} -% itself but might nevertheless be of great value to package authors or -% end users. -% -% Note that the current interface is not yet set in stone and the -% development team is open to suggestions for improvements or -% additions. -% -% \subsection{Callback Functions} -% -% The \luafunction{patch_font} callback is inserted in the wrapper -% \identifier{luaotfload} provides for the font definition callback -% (see below, page \pageref{define-font}). -% At this place it allows manipulating the font object immediately after -% the font loader is done creating it. -% For a short demonstration of its usefulness, here is a snippet that -% writes an entire font object to the file \fileent{fontdump.lua}: -% -% \begin{quote} -% \begin{verbatim} -% \input luaotfload.sty -% \directlua{ -% local dumpfile = "fontdump.lua" -% local dump_font = function (tfmdata) -% local data = table.serialize(tfmdata) -% io.savedata(dumpfile, data) -% end -% -% luatexbase.add_to_callback( -% "luaotfload.patch_font", -% dump_font, -% "my_private_callbacks.dump_font" -% ) -% } -% \font\dumpme=name:Iwona -% \bye -% \end{verbatim} -% \end{quote} -% -% \emphasis{Beware}: this creates a Lua file of around 150,000 lines of -% code, taking up 3~\abbrev{mb} of disk space. -% By inspecting the output you can get a first impression of how a font -% is structured in \LUATEX’s memory, what elements it is composed of, -% and in what ways it can be rearranged. -% -% \subsubsection{Compatibility with Earlier Versions} -% -% As has been touched on in the preface to this section, the structure -% of the object as returned by the fontloader underwent rather drastic -% changes during different stages of its development, and not all -% packages that made use of font patching have kept up with every one -% of it. -% To ensure compatibility with these as well as older versions of -% some packages, \identifier{luaotfload} sets up copies of or references -% to data in the font table where it used to be located. -% For instance, important parameters like the requested point size, the -% units factor, and the font name have again been made accessible from -% the toplevel of the table even though they were migrated to different -% subtables in the meantime. -% -% \subsubsection{Patches} -% -% These are mostly concerned with establishing compatibility with -% \XETEX. -% -% \begin{itemize} -% \let\normalitem=\item -% \def\ouritem#1{% -% \normalitem{\luafunction{#1}}% -% \hfill\break -% } -% -% \ouritem {set_sscale_dimens} -% Calculate \texmacro{fontdimen}s 10 and 11 to emulate \XETEX. -% -% \ouritem {set_capheight} -% Calculates \texmacro{fontdimen} 8 like \XETEX. -% -% \ouritem {patch_cambria_domh} -% Correct some values of the font \emphasis{Cambria Math}. -% -% \end{itemize} -% -% \subsection{Package Author’s Interface} -% -% As \LUATEX release 1.0 is nearing, the demand for a reliable interface -% for package authors increases. -% -% \subsubsection{Font Properties} -% -% Below functions mostly concern querying the different components of a -% font like for instance the glyphs it contains, or what font features -% are defined for which scripts. -% -% \begin{itemize} -% \let\normalitem=\item -% \def\ouritem#1{% -% \normalitem{\luafunction{#1}}% -% \hfill\break -% } -% -% \ouritem {aux.font_has_glyph (id : int, index : int)} -% Predicate that returns true if the font \luafunction{id} -% has glyph \luafunction{index}. -% -% \ouritem {aux.slot_of_name(name : string)} -% Translates an Adobe Glyph name to the corresponding glyph -% slot. -% -% \ouritem {aux.name_of_slot(slot : int)} -% The inverse of \luafunction{slot_of_name}; note that this -% might be incomplete as multiple glyph names may map to the -% same codepoint, only one of which is returned by -% \luafunction{name_of_slot}. -% -% \ouritem {aux.provides_script(id : int, script : string)} -% Test if a font supports \luafunction{script}. -% -% \ouritem {aux.provides_language(id : int, script : string, language : string)} -% Test if a font defines \luafunction{language} for a given -% \luafunction{script}. -% -% \ouritem {aux.provides_feature(id : int, script : string, -% language : string, feature : string)} -% Test if a font defines \luafunction{feature} for -% \luafunction{language} for a given \luafunction{script}. -% -% \ouritem {aux.get_math_dimension(id : int, dimension : string)} -% Get the dimension \luafunction{dimension} of font \luafunction{id}. -% -% \ouritem {aux.sprint_math_dimension(id : int, dimension : string)} -% Same as \luafunction{get_math_dimension()}, but output the value -% in scaled points at the \TEX end. -% -% \end{itemize} -% -% \subsubsection{Database} -% -% \begin{itemize} -% \let\normalitem=\item -% \def\ouritem#1{% -% \normalitem{\luafunction{#1}}% -% \hfill\break -% } -% -% \ouritem {aux.scan_external_dir(dir : string)} -% Include fonts in directory \luafunction{dir} in font lookups without -% adding them to the database. -% -% \end{itemize} -% -% \section{Troubleshooting} -% -% \subsection {Database Generation} -% If you encounter problems with some fonts, please first update to the latest -% version of this package before reporting a bug, as -% \identifier{luaotfload} is under active development and still a -% moving target. -% The development takes place on \identifier{github} at -% \url{https://github.com/lualatex/luaotfload} where there is an issue -% tracker for submitting bug reports, feature requests and the likes -% requests and the likes. -% -% Bug reports are more likely to be addressed if they contain the output of -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool --diagnose=environment,files,permissions -% \end{verbatim} -% \end{quote} -% -% \noindent Consult the man page for a description of these options. -% -% Errors during database generation can be traced by increasing the -% verbosity level and redirecting log output to \fileent{stdout}: -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool -fuvvv --log=stdout -% \end{verbatim} -% \end{quote} -% -% \noindent or to a file in \fileent{/tmp}: -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool -fuvvv --log=file -% \end{verbatim} -% \end{quote} -% -% \noindent In the latter case, invoke the \verb|tail(1)| utility on the file -% for live monitoring of the progress. -% -% If database generation fails, the font last printed to the terminal or log -% file is likely to be the culprit. -% Please specify it when reporting a bug, and blacklist it for the time -% being (see above, page \pageref{font-blacklist}). -% -% \subsection {Font Features} -% A common problem is the lack of features for some -% \OpenType fonts even when specified. -% This can be related to the fact that some fonts do not provide -% features for the \verb|dflt| script (see above on page -% \pageref{script-tag}), -% which is the default one in this package. -% If this happens, assigning a noth script when the font is defined should -% fix it. -% For example with \verb|latn|: -% -% \begin{quote} -% \begin{verbatim} -% \font\test=file:MyFont.otf:script=latn;+liga; -% \end{verbatim} -% \end{quote} -% -% You can get a list of features that a font defines for scripts and languages -% by querying it in \fileent{luaotfload-tool}: -% -% \begin{quote} -% \begin{verbatim} -% luaotfload-tool --find="Iwona" --inspect -% \end{verbatim} -% \end{quote} -% -% \subsection {\LUATEX Programming} -% Another strategy that helps avoiding problems is to not access raw \LUATEX -% internals directly. -% Some of them, even though they are dangerous to access, have not been -% overridden or disabled. -% Thus, whenever possible prefer the functions in the -% \luafunction{aux} namespace over direct manipulation of font objects. -% For example, raw access to the \luafunction{font.fonts} table like: -% -% \begin{quote} -% \begin{verbatim} -% local somefont = font.fonts[2] -% \end{verbatim} -% \end{quote} -% -% \noindent can render already defined fonts unusable. -% Instead, the function \luafunction{font.getfont()} should be used because -% it has been replaced by a safe variant. -% -% However, \luafunction{font.getfont()} only covers fonts handled by the font -% loader, e.~g. \identifier{OpenType} and \identifier{TrueType} fonts, but -% not \abbrev{tfm} or \abbrev{ofm}. -% Should you absolutely require access to all fonts known to \LUATEX, including -% the virtual and autogenerated ones, then you need to query both -% \luafunction{font.getfont()} and \luafunction{font.fonts}. -% In this case, best define you own accessor: -% -% \begin{quote} -% \begin{verbatim} -% local unsafe_getfont = function (id) -% local tfmdata = font.getfont (id) -% if not tfmdata then -% tfmdata = font.fonts[id] -% end -% return tfmdata -% end -% -% --- use like getfont() -% local somefont = unsafe_getfont (2) -% \end{verbatim} -% \end{quote} -% -% \part{Implementation} -% -% \section{\fileent{luaotfload.lua}} -% -% As of version 2.5, the file \fileent{luaotfload.lua} is no longer -% generated from the \abbrev{dtx}. -% Instead, it is maintained separately as a plain \identifier{Lua} file -% \fileent{luaotfload-main.lua} in the Luaotfload \identifier{git} tree. -% The file documentation which used to be found in this section has -% been preserved in the comments. -% -% \section{\fileent{luaotfload.sty}} -% -% As of version 2.5, the file \fileent{luaotfload.sty} is no longer -% generated from the \abbrev{dtx}. -% Instead, it is maintained separately as a plain \identifier{\TEX} file -% in the Luaotfload \identifier{git} tree. -% The file documentation which used to be found in this section has -% been preserved in the comments. -% -% \clearpage -% \section{The GNU GPL License v2} -% -% The GPL requires the complete license text to be distributed along -% with the code. I recommend the canonical source, instead: -% \url{http://www.gnu.org/licenses/old-licenses/gpl-2.0.html}. -% But if you insist on an included copy, here it is. -% You might want to zoom in. -% -% \newsavebox{\gpl} -% \begin{lrbox}{\gpl} -% \begin{minipage}{3\textwidth} -% \columnsep=3\columnsep -% \begin{multicols}{3} -% \begin{center} -% {\Large GNU GENERAL PUBLIC LICENSE\par} -% \bigskip -% {Version 2, June 1991} -% \end{center} -% -% \begin{center} -% {\parindent 0in -% -% Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. -% -% \bigskip -% -% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA -% -% \bigskip -% -% Everyone is permitted to copy and distribute verbatim copies -% of this license document, but changing it is not allowed. -% } -% \end{center} -% -% \begin{center} -% {\bf\large Preamble} -% \end{center} -% -% -% The licenses for most software are designed to take away your freedom to -% share and change it. By contrast, the GNU General Public License is -% intended to guarantee your freedom to share and change free software---to -% make sure the software is free for all its users. This General Public -% License applies to most of the Free Software Foundation's software and to -% any other program whose authors commit to using it. (Some other Free -% Software Foundation software is covered by the GNU Library General Public -% License instead.) You can apply it to your programs, too. -% -% When we speak of free software, we are referring to freedom, not price. -% Our General Public Licenses are designed to make sure that you have the -% freedom to distribute copies of free software (and charge for this service -% if you wish), that you receive source code or can get it if you want it, -% that you can change the software or use pieces of it in new free programs; -% and that you know you can do these things. -% -% To protect your rights, we need to make restrictions that forbid anyone to -% deny you these rights or to ask you to surrender the rights. These -% restrictions translate to certain responsibilities for you if you -% distribute copies of the software, or if you modify it. -% -% For example, if you distribute copies of such a program, whether gratis or -% for a fee, you must give the recipients all the rights that you have. You -% must make sure that they, too, receive or can get the source code. And -% you must show them these terms so they know their rights. -% -% We protect your rights with two steps: (1) copyright the software, and (2) -% offer you this license which gives you legal permission to copy, -% distribute and/or modify the software. -% -% Also, for each author's protection and ours, we want to make certain that -% everyone understands that there is no warranty for this free software. If -% the software is modified by someone else and passed on, we want its -% recipients to know that what they have is not the original, so that any -% problems introduced by others will not reflect on the original authors' -% reputations. -% -% Finally, any free program is threatened constantly by software patents. -% We wish to avoid the danger that redistributors of a free program will -% individually obtain patent licenses, in effect making the program -% proprietary. To prevent this, we have made it clear that any patent must -% be licensed for everyone's free use or not licensed at all. -% -% The precise terms and conditions for copying, distribution and -% modification follow. -% -% \begin{center} -% {\Large \sc Terms and Conditions For Copying, Distribution and -% Modification} -% \end{center} -% -% \begin{enumerate} -% \item -% This License applies to any program or other work which contains a notice -% placed by the copyright holder saying it may be distributed under the -% terms of this General Public License. The ``Program'', below, refers to -% any such program or work, and a ``work based on the Program'' means either -% the Program or any derivative work under copyright law: that is to say, a -% work containing the Program or a portion of it, either verbatim or with -% modifications and/or translated into another language. (Hereinafter, -% translation is included without limitation in the term ``modification''.) -% Each licensee is addressed as ``you''. -% -% Activities other than copying, distribution and modification are not -% covered by this License; they are outside its scope. The act of -% running the Program is not restricted, and the output from the Program -% is covered only if its contents constitute a work based on the -% Program (independent of having been made by running the Program). -% Whether that is true depends on what the Program does. -% -% \item You may copy and distribute verbatim copies of the Program's source -% code as you receive it, in any medium, provided that you conspicuously -% and appropriately publish on each copy an appropriate copyright notice -% and disclaimer of warranty; keep intact all the notices that refer to -% this License and to the absence of any warranty; and give any other -% recipients of the Program a copy of this License along with the Program. -% -% You may charge a fee for the physical act of transferring a copy, and you -% may at your option offer warranty protection in exchange for a fee. -% -% \item -% You may modify your copy or copies of the Program or any portion -% of it, thus forming a work based on the Program, and copy and -% distribute such modifications or work under the terms of Section 1 -% above, provided that you also meet all of these conditions: -% -% \begin{enumerate} -% -% \item -% You must cause the modified files to carry prominent notices stating that -% you changed the files and the date of any change. -% -% \item -% You must cause any work that you distribute or publish, that in -% whole or in part contains or is derived from the Program or any -% part thereof, to be licensed as a whole at no charge to all third -% parties under the terms of this License. -% -% \item -% If the modified program normally reads commands interactively -% when run, you must cause it, when started running for such -% interactive use in the most ordinary way, to print or display an -% announcement including an appropriate copyright notice and a -% notice that there is no warranty (or else, saying that you provide -% a warranty) and that users may redistribute the program under -% these conditions, and telling the user how to view a copy of this -% License. (Exception: if the Program itself is interactive but -% does not normally print such an announcement, your work based on -% the Program is not required to print an announcement.) -% -% \end{enumerate} -% -% -% These requirements apply to the modified work as a whole. If -% identifiable sections of that work are not derived from the Program, -% and can be reasonably considered independent and separate works in -% themselves, then this License, and its terms, do not apply to those -% sections when you distribute them as separate works. But when you -% distribute the same sections as part of a whole which is a work based -% on the Program, the distribution of the whole must be on the terms of -% this License, whose permissions for other licensees extend to the -% entire whole, and thus to each and every part regardless of who wrote it. -% -% Thus, it is not the intent of this section to claim rights or contest -% your rights to work written entirely by you; rather, the intent is to -% exercise the right to control the distribution of derivative or -% collective works based on the Program. -% -% In addition, mere aggregation of another work not based on the Program -% with the Program (or with a work based on the Program) on a volume of -% a storage or distribution medium does not bring the other work under -% the scope of this License. -% -% \item -% You may copy and distribute the Program (or a work based on it, -% under Section 2) in object code or executable form under the terms of -% Sections 1 and 2 above provided that you also do one of the following: -% -% \begin{enumerate} -% -% \item -% -% Accompany it with the complete corresponding machine-readable -% source code, which must be distributed under the terms of Sections -% 1 and 2 above on a medium customarily used for software interchange; or, -% -% \item -% -% Accompany it with a written offer, valid for at least three -% years, to give any third party, for a charge no more than your -% cost of physically performing source distribution, a complete -% machine-readable copy of the corresponding source code, to be -% distributed under the terms of Sections 1 and 2 above on a medium -% customarily used for software interchange; or, -% -% \item -% -% Accompany it with the information you received as to the offer -% to distribute corresponding source code. (This alternative is -% allowed only for noncommercial distribution and only if you -% received the program in object code or executable form with such -% an offer, in accord with Subsection b above.) -% -% \end{enumerate} -% -% -% The source code for a work means the preferred form of the work for -% making modifications to it. For an executable work, complete source -% code means all the source code for all modules it contains, plus any -% associated interface definition files, plus the scripts used to -% control compilation and installation of the executable. However, as a -% special exception, the source code distributed need not include -% anything that is normally distributed (in either source or binary -% form) with the major components (compiler, kernel, and so on) of the -% operating system on which the executable runs, unless that component -% itself accompanies the executable. -% -% If distribution of executable or object code is made by offering -% access to copy from a designated place, then offering equivalent -% access to copy the source code from the same place counts as -% distribution of the source code, even though third parties are not -% compelled to copy the source along with the object code. -% -% \item -% You may not copy, modify, sublicense, or distribute the Program -% except as expressly provided under this License. Any attempt -% otherwise to copy, modify, sublicense or distribute the Program is -% void, and will automatically terminate your rights under this License. -% However, parties who have received copies, or rights, from you under -% this License will not have their licenses terminated so long as such -% parties remain in full compliance. -% -% \item -% You are not required to accept this License, since you have not -% signed it. However, nothing else grants you permission to modify or -% distribute the Program or its derivative works. These actions are -% prohibited by law if you do not accept this License. Therefore, by -% modifying or distributing the Program (or any work based on the -% Program), you indicate your acceptance of this License to do so, and -% all its terms and conditions for copying, distributing or modifying -% the Program or works based on it. -% -% \item -% Each time you redistribute the Program (or any work based on the -% Program), the recipient automatically receives a license from the -% original licensor to copy, distribute or modify the Program subject to -% these terms and conditions. You may not impose any further -% restrictions on the recipients' exercise of the rights granted herein. -% You are not responsible for enforcing compliance by third parties to -% this License. -% -% \item -% If, as a consequence of a court judgment or allegation of patent -% infringement or for any other reason (not limited to patent issues), -% conditions are imposed on you (whether by court order, agreement or -% otherwise) that contradict the conditions of this License, they do not -% excuse you from the conditions of this License. If you cannot -% distribute so as to satisfy simultaneously your obligations under this -% License and any other pertinent obligations, then as a consequence you -% may not distribute the Program at all. For example, if a patent -% license would not permit royalty-free redistribution of the Program by -% all those who receive copies directly or indirectly through you, then -% the only way you could satisfy both it and this License would be to -% refrain entirely from distribution of the Program. -% -% If any portion of this section is held invalid or unenforceable under -% any particular circumstance, the balance of the section is intended to -% apply and the section as a whole is intended to apply in other -% circumstances. -% -% It is not the purpose of this section to induce you to infringe any -% patents or other property right claims or to contest validity of any -% such claims; this section has the sole purpose of protecting the -% integrity of the free software distribution system, which is -% implemented by public license practices. Many people have made -% generous contributions to the wide range of software distributed -% through that system in reliance on consistent application of that -% system; it is up to the author/donor to decide if he or she is willing -% to distribute software through any other system and a licensee cannot -% impose that choice. -% -% This section is intended to make thoroughly clear what is believed to -% be a consequence of the rest of this License. -% -% \item -% If the distribution and/or use of the Program is restricted in -% certain countries either by patents or by copyrighted interfaces, the -% original copyright holder who places the Program under this License -% may add an explicit geographical distribution limitation excluding -% those countries, so that distribution is permitted only in or among -% countries not thus excluded. In such case, this License incorporates -% the limitation as if written in the body of this License. -% -% \item -% The Free Software Foundation may publish revised and/or new versions -% of the General Public License from time to time. Such new versions will -% be similar in spirit to the present version, but may differ in detail to -% address new problems or concerns. -% -% Each version is given a distinguishing version number. If the Program -% specifies a version number of this License which applies to it and ``any -% later version'', you have the option of following the terms and conditions -% either of that version or of any later version published by the Free -% Software Foundation. If the Program does not specify a version number of -% this License, you may choose any version ever published by the Free Software -% Foundation. -% -% \item -% If you wish to incorporate parts of the Program into other free -% programs whose distribution conditions are different, write to the author -% to ask for permission. For software which is copyrighted by the Free -% Software Foundation, write to the Free Software Foundation; we sometimes -% make exceptions for this. Our decision will be guided by the two goals -% of preserving the free status of all derivatives of our free software and -% of promoting the sharing and reuse of software generally. -% -% \begin{center} -% {\Large\sc -% No Warranty -% } -% \end{center} -% -% \item -% {\sc Because the program is licensed free of charge, there is no warranty -% for the program, to the extent permitted by applicable law. Except when -% otherwise stated in writing the copyright holders and/or other parties -% provide the program ``as is'' without warranty of any kind, either expressed -% or implied, including, but not limited to, the implied warranties of -% merchantability and fitness for a particular purpose. The entire risk as -% to the quality and performance of the program is with you. Should the -% program prove defective, you assume the cost of all necessary servicing, -% repair or correction.} -% -% \item -% {\sc In no event unless required by applicable law or agreed to in writing -% will any copyright holder, or any other party who may modify and/or -% redistribute the program as permitted above, be liable to you for damages, -% including any general, special, incidental or consequential damages arising -% out of the use or inability to use the program (including but not limited -% to loss of data or data being rendered inaccurate or losses sustained by -% you or third parties or a failure of the program to operate with any other -% programs), even if such holder or other party has been advised of the -% possibility of such damages.} -% -% \end{enumerate} -% -% -% \begin{center} -% {\Large\sc End of Terms and Conditions} -% \end{center} -% -% -% \pagebreak[2] -% -% \section*{Appendix: How to Apply These Terms to Your New Programs} -% -% If you develop a new program, and you want it to be of the greatest -% possible use to the public, the best way to achieve this is to make it -% free software which everyone can redistribute and change under these -% terms. -% -% To do so, attach the following notices to the program. It is safest to -% attach them to the start of each source file to most effectively convey -% the exclusion of warranty; and each file should have at least the -% ``copyright'' line and a pointer to where the full notice is found. -% -% \begin{quote} -% one line to give the program's name and a brief idea of what it does. \\ -% Copyright (C) yyyy name of author \\ -% -% This program is free software; you can redistribute it and/or modify -% it under the terms of the GNU General Public License as published by -% the Free Software Foundation; either version 2 of the License, or -% (at your option) any later version. -% -% This program is distributed in the hope that it will be useful, -% but WITHOUT ANY WARRANTY; without even the implied warranty of -% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -% GNU General Public License for more details. -% -% You should have received a copy of the GNU General Public License -% along with this program; if not, write to the Free Software -% Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -% \end{quote} -% -% Also add information on how to contact you by electronic and paper mail. -% -% If the program is interactive, make it output a short notice like this -% when it starts in an interactive mode: -% -% \begin{quote} -% Gnomovision version 69, Copyright (C) yyyy name of author \\ -% Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ -% This is free software, and you are welcome to redistribute it -% under certain conditions; type `show c' for details. -% \end{quote} -% -% -% The hypothetical commands {\tt show w} and {\tt show c} should show the -% appropriate parts of the General Public License. Of course, the commands -% you use may be called something other than {\tt show w} and {\tt show c}; -% they could even be mouse-clicks or menu items---whatever suits your -% program. -% -% You should also get your employer (if you work as a programmer) or your -% school, if any, to sign a ``copyright disclaimer'' for the program, if -% necessary. Here is a sample; alter the names: -% -% \begin{quote} -% Yoyodyne, Inc., hereby disclaims all copyright interest in the program \\ -% `Gnomovision' (which makes passes at compilers) written by James Hacker. \\ -% -% signature of Ty Coon, 1 April 1989 \\ -% Ty Coon, President of Vice -% \end{quote} -% -% -% This General Public License does not permit incorporating your program -% into proprietary programs. If your program is a subroutine library, you -% may consider it more useful to permit linking proprietary applications -% with the library. If this is what you want to do, use the GNU Library -% General Public License instead of this License. -% -% \end{multicols} -% \end{minipage} -% \end{lrbox} -% -% \begin{center} -% \scalebox{0.33}{\usebox{\gpl}} -% \end{center} -% -% \Finale -\endinput -- cgit v1.2.3 From bf21af737122e0c904f305b3213b91710bb93216 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sat, 15 Feb 2014 15:51:10 +0100 Subject: [doc,*] adapt makefiles to new doc source --- doc/Makefile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile index 2040f5a..9e2d591 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,6 +1,6 @@ NAME = luaotfload DOCPDF = $(NAME).pdf -DOCDTX = $(NAME).dtx +DOCSRC = $(NAME)-latex.tex SCRIPTNAME = luaotfload-tool MANSOURCE = $(SCRIPTNAME).rst @@ -23,10 +23,11 @@ all: manual doc graph: $(DOTPDF) manual: $(MANPAGE) -$(DOCPDF): $(DOCDTX) - @echo "creating PDF documentation ($(DOCPDF))" +$(DOCPDF): $(DOCSRC) + @echo "creating PDF documentation ($@)" $(DO_LATEX) $(DO_LATEX) + mv -f -- $(<:tex=pdf) $@ $(MANPAGE): $(MANSOURCE) @echo "creating man page ($(MANPAGE))" @@ -44,4 +45,4 @@ clean: mrproper: clean @$(RM) -- $(DOCS) -# vim:set noexpandtab:tabstop=8:shiftwidth=2 +# vim:noexpandtab:tabstop=8:shiftwidth=2 -- cgit v1.2.3 From 8a24f30e6a055de51461304d40ece070511530bb Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 16 Feb 2014 13:43:19 +0100 Subject: [doc] use abstract macros --- doc/luaotfload-latex.tex | 147 +++++++++- doc/luaotfload-main.tex | 684 ++++++++++++++++++++++------------------------- 2 files changed, 461 insertions(+), 370 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 615ad42..d00a617 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -1,3 +1,4 @@ +\luatexsuppresslongerror1%% sigh ... %% Copyright (C) 2009-2014 %% %% by Elie Roux @@ -31,6 +32,8 @@ \documentclass{ltxdoc} +\makeatletter + \usepackage{metalogo,multicol,mdwlist,fancyvrb,xspace} \usepackage[x11names]{xcolor} @@ -125,8 +128,150 @@ \VerbatimFootnotes +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% structurals +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \definestructural #1{% + \expandafter \let \csname end#1\endcsname \relax + + \expandafter \def \csname begin#1\endcsname {% + \@ifnextchar[{\csname begin#1indeed\endcsname} + {\csname begin#1indeed\endcsname[]}% + } + + \expandafter \def \csname begin#1indeed\endcsname [##1]##2{% + \edef \first {##1}% + \ifx \first \empty + \csname #1\endcsname [##2]{##2}% + \else + \csname #1\endcsname [\first]{##2}% + \fi + } +} + +\definestructural {section} +\definestructural {subsection} +\definestructural {subsubsection} + +\def \fakesection #1{\section*{#1}} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% codelistings; this sucks hard since we lack access to buffers +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\newcount \othercatcode \othercatcode 12 +\newcount \activecatcode \othercatcode 13 + +\newluatexcatcodetable \vrbcatcodes +\setluatexcatcodetable \vrbcatcodes {% + \luatexcatcodetable \CatcodeTableIniTeX + \catcode 9 \othercatcode %% \tabasciicode + \catcode 13 \othercatcode %% \endoflineasciicode + \catcode 12 \othercatcode %% \formfeedasciicode + \catcode 26 \othercatcode %% \endoffileasciicode + \catcode 32 \othercatcode %% \spaceasciicode +} + +\newluatexcatcodetable \literalcatcodes +\setluatexcatcodetable \literalcatcodes {% + \luatexcatcodetable \CatcodeTableString + \catcode 32 \activecatcode %% \spaceasciicode +} + +\def \beginlisting {% + \begingroup + \luatexcatcodetable \vrbcatcodes + \beginlistingindeed% +} + +\directlua { + local texprint = tex.print + document = document or { } + document.printlines = function (buffer) + for _, line in next, string.explode (buffer, "\noexpand\n") do + texprint (-1, line) + texprint (-1, "") + end + end +} + +\def \beginlistingindeed#1\endlisting{% + \endgroup + \begingroup + \ttfamily + \small + \begin {quote} + \bgroup + \luatexcatcodetable \literalcatcodes + \obeyspaces + \obeylines + \directlua{document.printlines ([==[\detokenize {#1}]==])} + \egroup + \end {quote} + \endgroup +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% enumerations and lists +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \definelist [#1]#2{% name, itemcode + \expandafter \def \csname begin#1\endcsname {% + \begin {itemize} + \let \normalitem = \item + \def \altitem ####1{% + \def \first {####1}% + #2 + } + } + + \expandafter \def \csname end#1\endcsname {% + \end {itemize} + } +} + +\definelist [definitions]{\normalitem {\fileent {\first}}} +\definelist [filelist]{\normalitem {\fileent {\first}}\space--\hskip 1em} +\definelist [functionlist]{\normalitem {\luafunction {\first}}\hfill\break} + +\def \beginenumeration {\begin {enumerate}} +\def \endenumeration {\end {enumerate}} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% columns +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \begindoublecolumns {\begin {multicols} {2}} +\def \enddoublecolumns {\end {multicols}} + +\def \begintriplecolumns {\begin {multicols} {3}} +\def \endtriplecolumns {\end {multicols}} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% alignment +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \begincentered {\begin {center}} +\def \endcentered {\end {center}} +\makeatother + +\def \beginnarrower {\begin {quote}} +\def \endnarrower {\end {quote}} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% special elements +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \beginabstractcontent {\begin {abstract}} +\def \endabstractcontent {\end {abstract}} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% main +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \begin {document} - \input {luaotfload-main.tex} + \input {luaotfload-main.tex} \end {document} diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 49d1986..37127b7 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -37,19 +37,17 @@ \maketitle -\begin{abstract} +\beginabstractcontent This package is an adaptation of the \CONTEXT font loading system. It allows for loading \OpenType fonts with an extended syntax and adds support for a variety of font features. -\end{abstract} +\endabstractcontent \tableofcontents -\part{Package Description} - %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Introduction} +\beginsection {Introduction} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% Font management and installation has always been painful with \TEX. A @@ -95,8 +93,10 @@ for handling \OpenType fonts. Additionally, it provides means for accessing fonts known to the operating system conveniently by indexing the metadata. +\endsection + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Thanks} +\beginsection {Thanks} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \identifier{Luaotfload} is part of \LUALATEX, the community-driven @@ -119,18 +119,21 @@ code to \LATEX a breeze due to the extra effort he invested into isolating it from the rest of \CONTEXT, not to mention his assistance in the task and willingness to respond to our suggestions. +\endsection -\section{Loading Fonts} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\beginsection {Loading Fonts} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \identifier{luaotfload} supports an extended font request syntax: -\begin{quote} +\beginnarrower |\font\foo={|% \meta{prefix}|:|% \meta{font name}|:|% \meta{font features}|}|% \meta{\TEX font features} -\end{quote} +\endnarrower \noindent The curly brackets are optional and escape the spaces in the enclosed @@ -208,14 +211,14 @@ for a more formal description see figure \ref{font-syntax}. \label{font-syntax} \end {figure} -\subsection{Prefix -- the \identifier{luaotfload}{ }Way} +\beginsubsection{Prefix -- the \identifier{luaotfload}{ }Way} In \identifier{luaotfload}, the canonical syntax for font requests requires a \emphasis{prefix}: % -\begin{quote} +\beginnarrower |\font\fontname=|\meta{prefix}|:|\meta{fontname}\dots -\end{quote} +\endnarrower % where \meta{prefix} is either \verb|file:| or \verb|name:|.\footnote{% The development version also knows two further prefixes, @@ -300,7 +303,9 @@ The file names corresponding to the example font names above are \fileent{GFSBodoni.otf}, and \fileent{PTZ56F.ttf}. -\subsection{Compatibility Layer} +\endsubsection + +\beginsubsection {Compatibility Layer} In addition to the regular prefixed requests, \identifier{luaotfload} accepts loading fonts the \XETEX way. @@ -308,9 +313,9 @@ accepts loading fonts the \XETEX way. There are again two modes: bracketed and unbracketed. A bracketed request looks as follows. -\begin{quote} +\beginnarrower |\font\fontname=[|\meta{path to file}|]| -\end{quote} +\endnarrower \noindent Inside the square brackets, every character except for a closing @@ -319,9 +324,9 @@ bracket is permitted, allowing for specifying paths to a font file. Naturally, path-less file names are equally valid and processed the same way as an ordinary \verb|file:| lookup. -\begin{quote} +\beginnarrower |\font\fontname=|\meta{font name} \dots -\end{quote} +\endnarrower Unbracketed (or, for lack of a better word: \emphasis{anonymous}) font requests resemble the conventional \TEX syntax. @@ -337,9 +342,9 @@ fall back to a \verb|file:| lookup if no database entry matches Furthermore, \identifier{luaotfload} supports the slashed (shorthand) font style notation from \XETEX. -\begin{quote} +\beginnarrower |\font\fontname=|\meta{font name}|/|\meta{modifier}\dots -\end{quote} +\endnarrower \noindent Currently, four style modifiers are supported: @@ -350,18 +355,18 @@ Currently, four style modifiers are supported: Other “slashed” modifiers are too specific to the \XETEX engine and have no meaning in \LUATEX. -\subsection{Examples} +\endsubsection + +\beginsubsection{Examples} -\subsubsection{Loading by File Name} +\beginsubsubsection{Loading by File Name} For example, conventional \abbrev{type1} font can be loaded with a \verb|file:| request like so: -\begin{quote} - \begin{verbatim} - \font\lmromanten={file:ec-lmr10} at 10pt - \end{verbatim} -\end{quote} +\beginlisting + \font \lmromanten = {file:ec-lmr10} at 10pt +\endlisting The \OpenType version of Janusz Nowacki’s font \emphasis{Antykwa Półtawskiego}\footnote{% @@ -370,49 +375,42 @@ Półtawskiego}\footnote{% } in its condensed variant can be loaded as follows: -\begin{quote} - \begin{verbatim} - \font\apcregular=file:antpoltltcond-regular.otf at 42pt - \end{verbatim} -\end{quote} +\beginlisting + \font \apcregular = file:antpoltltcond-regular.otf at 42pt +\endlisting The next example shows how to load the \emphasis{Porson} font digitized by the Greek Font Society using \XETEX-style syntax and an absolute path from a non-standard directory: -\begin{quote} - \begin{verbatim} - \font\gfsporson="[/tmp/GFSPorson.otf]" at 12pt - \end{verbatim} -\end{quote} +\beginlisting + \font \gfsporson = "[/tmp/GFSPorson.otf]" at 12pt +\endlisting + +\endsubsubsection -\subsubsection{Loading by Font Name} +\beginsubsubsection{Loading by Font Name} The \verb|name:| lookup does not depend on cryptic filenames: -\begin{quote} - \begin{verbatim} - \font\pagellaregular={name:TeX Gyre Pagella} at 9pt - \end{verbatim} -\end{quote} +\beginlisting + \font \pagellaregular = {name:TeX Gyre Pagella} at 9pt +\endlisting A bit more specific but essentially the same lookup would be: -\begin{quote} - \begin{verbatim} - \font\pagellaregular={name:TeX Gyre Pagella Regular} at 9pt - \end{verbatim} -\end{quote} +\beginlisting + \font \pagellaregular = {name:TeX Gyre Pagella Regular} at 9pt +\endlisting \noindent Which fits nicely with the whole set: -\begin{quote} - \begin{verbatim} - \font\pagellaregular ={name:TeX Gyre Pagella Regular} at 9pt - \font\pagellaitalic ={name:TeX Gyre Pagella Italic} at 9pt - \font\pagellabold ={name:TeX Gyre Pagella Bold} at 9pt - \font\pagellabolditalic={name:TeX Gyre Pagella Bolditalic} at 9pt +\beginlisting + \font\pagellaregular = {name:TeX Gyre Pagella Regular} at 9pt + \font\pagellaitalic = {name:TeX Gyre Pagella Italic} at 9pt + \font\pagellabold = {name:TeX Gyre Pagella Bold} at 9pt + \font\pagellabolditalic = {name:TeX Gyre Pagella Bolditalic} at 9pt {\pagellaregular foo bar baz\endgraf} {\pagellaitalic foo bar baz\endgraf} @@ -420,10 +418,11 @@ Which fits nicely with the whole set: {\pagellabolditalic foo bar baz\endgraf} ... - \end{verbatim} -\end{quote} +\endlisting -\subsubsection{Modifiers} +\endsubsubsection + +\beginsubsubsection{Modifiers} If the entire \emphasis{Iwona} family\footnote{% \url{http://jmn.pl/kurier-i-iwona/}, @@ -432,47 +431,47 @@ If the entire \emphasis{Iwona} family\footnote{% is installed in some location accessible by \identifier{luaotfload}, the regular shape can be loaded as follows: -\begin{quote} - \begin{verbatim} +\beginlisting \font\iwona=Iwona at 20pt - \end{verbatim} -\end{quote} +\endlisting \noindent To load the most common of the other styles, the slash notation can be employed as shorthand: -\begin{quote} - \begin{verbatim} +\beginlisting \font\iwonaitalic =Iwona/I at 20pt \font\iwonabold =Iwona/B at 20pt \font\iwonabolditalic=Iwona/BI at 20pt - \end{verbatim} -\end{quote} +\endlisting \noindent which is equivalent to these full names: -\begin{quote} - \begin{verbatim} +\beginlisting \font\iwonaitalic ="Iwona Italic" at 20pt \font\iwonabold ="Iwona Bold" at 20pt \font\iwonabolditalic="Iwona BoldItalic" at 20pt - \end{verbatim} -\end{quote} +\endlisting + +\endsubsubsection +\endsubsection +\endsection -\section {Font features} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\beginsection {Font features} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \emphasis{Font features} are the second to last component in the general scheme for font requests: -\begin{quote} +\beginnarrower |\font\foo={|% \meta{prefix}|:|% \meta{font name}|:|% \meta{font features}|}|% \meta{\TEX font features} -\end{quote} +\endnarrower \noindent If style modifiers are present (\XETEX style), they must precede @@ -487,11 +486,9 @@ and font options. Prepending a font feature with a |+| (plus sign) enables it, whereas a |-| (minus) disables it. For instance, the request -\begin{quote} - \begin{verbatim} +\beginlisting \font\test=LatinModernRoman:+clig;-kern - \end{verbatim} -\end{quote} +\endlisting \noindent activates contextual ligatures (|clig|) and disables kerning (|kern|). @@ -501,11 +498,9 @@ the feature in a key/value expression. % The following request has the same meaning as the last one: -\begin{quote} - \begin{verbatim} +\beginlisting \font\test=LatinModernRoman:clig=true;kern=false - \end{verbatim} -\end{quote} +\endlisting \noindent Furthermore, this second syntax is required should a font feature @@ -520,11 +515,9 @@ obviously, |random|. %% TODO verify that this actually works with a font that supports %% the salt/random feature!\fi -\begin{quote} - \begin{verbatim} +\beginlisting \font\librmsaltfirst=LatinModernRoman:salt=1 - \end{verbatim} -\end{quote} +\endlisting \noindent Other font options include: @@ -604,11 +597,9 @@ obviously, |random|. For example, in order to set text in semitransparent red: - \begin{quote} - \begin{verbatim} + \beginlisting \font\test={Latin Modern Roman}:color=FF0000BB - \end{verbatim} - \end{quote} + \endlisting \item [kernfactor \& letterspace] \hfill \\ Define a font with letterspacing (tracking) enabled. @@ -644,12 +635,10 @@ obviously, |random|. Consequently, both definitions in below snippet yield the same letterspacing width: - \begin{quote} - \begin{verbatim} + \beginlisting \font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" \font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" - \end{verbatim} - \end{quote} + \endlisting Specific pairs of letters and ligatures may be exempt from letterspacing by defining the \LUA functions @@ -688,10 +677,10 @@ obviously, |random|. % Alternatively and with loss of information, you can dump those tables into your terminal by issuing - \begin{verbatim} + \beginlisting \directlua{inspect(fonts.protrusions.setups.default) inspect(fonts.expansions.setups.default)} - \end{verbatim} + \endlisting at some point after loading \fileent{luaotfload.sty}. } % @@ -709,11 +698,9 @@ obviously, |random|. for details. }: - \begin{quote} - \begin{verbatim} + \beginlisting \font\test=LatinModernRoman:protrusion=default - \end{verbatim} - \end{quote} + \endlisting \end{description} \paragraph{Non-standard font features} @@ -756,8 +743,12 @@ Currently (2014) there are three of them: \end{description} +\endsection + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\beginsection {Font names database} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Font names database} \label{sec:fontdb} As mentioned above, \identifier{luaotfload} keeps track of which @@ -792,12 +783,8 @@ inspects every font file on your computer. This is particularly noticeable if it occurs during a typesetting run. In any case, subsequent updates to the database will be quite fast. -\subsection[luaotfload-tool / mkluatexfontdb.lua]% - {\fileent{luaotfload-tool} / - \fileent{mkluatexfontdb.lua}\footnote{% - The script may be named just \fileent{mkluatexfontdb} in your - distribution. -}} +\beginsubsection[luaotfload-tool] + {\fileent{luaotfload-tool}} It can still be desirable at times to do some of these steps manually, and without having to compile a document. @@ -826,29 +813,23 @@ pass it as an argument to \fileent{texlua}.\footnote{% Invoked with the argument \verb|--update| it will perform a database update, scanning for fonts not indexed. -\begin{quote} - \begin{verbatim} - luaotfload-tool --update - \end{verbatim} -\end{quote} +\beginlisting + luaotfload-tool --update +\endlisting Adding the \verb|--force| switch will initiate a complete rebuild of the database. -\begin{quote} - \begin{verbatim} - luaotfload-tool --update --force - \end{verbatim} -\end{quote} - -For sake of backwards compatibility, \fileent{luaotfload-tool} may be -renamed or symlinked to \fileent{mkluatexfontdb}. -% +\beginlisting + luaotfload-tool --update --force +\endlisting Whenever it is run under this name, it will update the database first, mimicking the behavior of earlier versions of \identifier{luaotfload}. -\subsection{Search Paths} +\endsubsection + +\beginsubsection{Search Paths} \identifier{luaotfload} scans those directories where fonts are expected to be located on a given system. @@ -875,7 +856,7 @@ directories. \caption{List of paths searched for each supported operating system.} \renewcommand{\arraystretch}{1.2} - \begin{center} + \begincentered \begin{tabular}{lp{.5\textwidth}} Windows & \verb|%WINDIR%\Fonts| \\ @@ -888,12 +869,14 @@ directories. \fileent{/Network/Library/Fonts} \\ \end{tabular} - \end{center} + \endcentered \label{table-searchpaths} \hrule \end{table} -\subsection{Querying from Outside} +\endsubsection + +\beginsubsection{Querying from Outside} \fileent{luaotfload-tool} also provides rudimentary means of accessing the information collected in the font database. @@ -904,11 +887,9 @@ matching name. % For instance, the invocation -\begin{quote} - \begin{verbatim} - luaotfload-tool --find="Iwona Regular" - \end{verbatim} -\end{quote} +\beginlisting + luaotfload-tool --find="Iwona Regular" +\endlisting \noindent will verify if “Iwona Regular” is found in the database and can be @@ -922,11 +903,9 @@ Suppose you cannot precisely remember if the variant of \identifier{Iwona} you are looking for was “Bright” or “Light”. The query -\begin{quote} - \begin{verbatim} - luaotfload-tool -F --find="Iwona Bright" - \end{verbatim} -\end{quote} +\beginlisting + luaotfload-tool -F --find="Iwona Bright" +\endlisting \noindent will tell you that indeed the latter name is correct. @@ -934,11 +913,9 @@ will tell you that indeed the latter name is correct. Basic information about fonts in the database can be displayed using the \verb|-i| option (\verb|--info|). % -\begin{quote} - \begin{verbatim} - luaotfload-tool -i --find="Iwona Light Italic" - \end{verbatim} -\end{quote} +\beginlisting + luaotfload-tool -i --find="Iwona Light Italic" +\endlisting % \noindent The meaning of the printed values is described in section 4.4 of the @@ -948,11 +925,9 @@ The meaning of the printed values is described in section 4.4 of the For a much more detailed report about a given font try the \verb|-I| option instead (\verb|--inspect|). -\begin{quote} - \begin{verbatim} - luaotfload-tool -I --find="Iwona Light Italic" - \end{verbatim} -\end{quote} +\beginlisting + luaotfload-tool -I --find="Iwona Light Italic" +\endlisting \verb|luaotfload-tool --help| will list the available command line switches, including some not discussed in detail here. @@ -963,7 +938,9 @@ capabilities refer to the manpage Or see \verb|luaotfload-tool.rst| in the source directory. } -\subsection{Blacklisting Fonts} +\endsubsection + +\beginsubsection {Blacklisting Fonts} \label{font-blacklist} Some fonts are problematic in general, or just in \LUATEX. @@ -1004,14 +981,19 @@ without modifying the global file. % An example with explicit paths: -\begin{verbatim} +\beginlisting % example otf-blacklist.cnf /Library/Fonts/GillSans.ttc % Luaotfload ignores this font. -/Library/Fonts/Optima.ttc % This one is usable again, even if % blacklisted somewhere else. -\end{verbatim} +\endlisting -\section{Files from \CONTEXT and \LUATEX-Fonts} +\endsubsection +\endsection + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\beginsection {Files from \CONTEXT and \LUATEX-Fonts} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \identifier{luaotfload} relies on code originally written by Hans Hagen\footnote{% @@ -1069,60 +1051,56 @@ too developed by Hans Hagen.\footnote{% It houses several \LUA files that can be classed in three categories. - \begin{itemize} - \let\normalitem=\item - \def\incitem#1{% - \normalitem{\fileent{#1}} - } +\begindefinitions \normalitem \emphasis{\LUA utility libraries}, a subset of what is provided by the \identifier{lualibs} package. - \begin{multicols}{2} - \begin{itemize} - \incitem{l-lua.lua} \incitem{l-lpeg.lua} - \incitem{l-function.lua} \incitem{l-string.lua} - \incitem{l-table.lua} \incitem{l-io.lua} - \incitem{l-file.lua} \incitem{l-boolean.lua} - \incitem{l-math.lua} \incitem{util-str.lua} - \end{itemize} - \end{multicols} + \begindoublecolumns + \begindefinitions + \altitem{l-lua.lua} \altitem{l-lpeg.lua} + \altitem{l-function.lua} \altitem{l-string.lua} + \altitem{l-table.lua} \altitem{l-io.lua} + \altitem{l-file.lua} \altitem{l-boolean.lua} + \altitem{l-math.lua} \altitem{util-str.lua} + \enddefinitions + \enddoublecolumns \normalitem The \emphasis{font loader} itself. These files have been written for \LUATEX-Fonts and they are distributed along with \identifier{luaotfload}. - \begin{multicols}{2} - \begin{itemize} - \incitem{luatex-basics-gen.lua} - \incitem{luatex-basics-nod.lua} - \incitem{luatex-fonts-enc.lua} - \incitem{luatex-fonts-syn.lua} - \incitem{luatex-fonts-tfm.lua} - \incitem{luatex-fonts-chr.lua} - \incitem{luatex-fonts-lua.lua} - \incitem{luatex-fonts-inj.lua} - \incitem{luatex-fonts-otn.lua} - \incitem{luatex-fonts-def.lua} - \incitem{luatex-fonts-ext.lua} - \incitem{luatex-fonts-cbk.lua} - \end{itemize} - \end{multicols} + \begindoublecolumns + \begindefinitions + \altitem{luatex-basics-gen.lua} + \altitem{luatex-basics-nod.lua} + \altitem{luatex-fonts-enc.lua} + \altitem{luatex-fonts-syn.lua} + \altitem{luatex-fonts-tfm.lua} + \altitem{luatex-fonts-chr.lua} + \altitem{luatex-fonts-lua.lua} + \altitem{luatex-fonts-inj.lua} + \altitem{luatex-fonts-otn.lua} + \altitem{luatex-fonts-def.lua} + \altitem{luatex-fonts-ext.lua} + \altitem{luatex-fonts-cbk.lua} + \enddefinitions + \enddoublecolumns \normalitem Code related to \emphasis{font handling and node processing}, taken directly from \CONTEXT. - \begin{multicols}{2} - \begin{itemize} - \incitem{data-con.lua} \incitem{font-ini.lua} - \incitem{font-con.lua} \incitem{font-cid.lua} - \incitem{font-map.lua} \incitem{font-oti.lua} - \incitem{font-otf.lua} \incitem{font-otb.lua} - \incitem{font-ota.lua} \incitem{font-def.lua} - \incitem{font-otp.lua} - \end{itemize} - \end{multicols} - \end{itemize} + \begindoublecolumns + \begindefinitions + \altitem{data-con.lua} \altitem{font-ini.lua} + \altitem{font-con.lua} \altitem{font-cid.lua} + \altitem{font-map.lua} \altitem{font-oti.lua} + \altitem{font-otf.lua} \altitem{font-otb.lua} + \altitem{font-ota.lua} \altitem{font-def.lua} + \altitem{font-otp.lua} + \enddefinitions + \enddoublecolumns +\enddefinitions Note that if \identifier{luaotfload} cannot locate the merged file, it will load the individual \LUA libraries @@ -1150,29 +1128,25 @@ In addition to these, \identifier{luaotfload} requires a number of files not contained in the merge. Some of these have no equivalent in \LUATEX-Fonts or \CONTEXT, some were taken unmodified from the latter. -\begin{itemize} - \let\normalitem=\item - \def\ouritem#1{% - \normalitem{\fileent{#1}}% - \space--\hskip1em - } - \ouritem {luaotfload-features.lua} font feature handling; + +\beginfilelist + \altitem {luaotfload-features.lua} font feature handling; incorporates some of the code from \fileent{font-otc} from \CONTEXT; - \ouritem {luaotfload-override.lua} overrides the \CONTEXT logging + \altitem {luaotfload-override.lua} overrides the \CONTEXT logging functionality. - \ouritem {luaotfload-loaders.lua} registers the \OpenType + \altitem {luaotfload-loaders.lua} registers the \OpenType font reader as handler for Postscript fonts (\abbrev{pfa}, \abbrev{pfb}). - \ouritem {luaotfload-parsers.lua} various \abbrev{lpeg}-based parsers. - \ouritem {luaotfload-database.lua} font names database. - \ouritem {luaotfload-colors.lua} color handling. - \ouritem {luaotfload-auxiliary.lua} access to internal functionality + \altitem {luaotfload-parsers.lua} various \abbrev{lpeg}-based parsers. + \altitem {luaotfload-database.lua} font names database. + \altitem {luaotfload-colors.lua} color handling. + \altitem {luaotfload-auxiliary.lua} access to internal functionality for package authors (proposals for additions welcome). - \ouritem {luaotfload-letterspace.lua} font-based letterspacing. -\end{itemize} + \altitem {luaotfload-letterspace.lua} font-based letterspacing. +\endfilelist \begin{figure}[b] \caption{Schematic of the files in \identifier{Luaotfload}} @@ -1180,7 +1154,11 @@ files not contained in the merge. Some of these have no equivalent in \label{file-graph} \end{figure} -\section{Auxiliary Functions} +\endsection + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\beginsection {Auxiliary Functions} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% With release version 2.2, \identifier{luaotfload} received additional functions for package authors to call from outside @@ -1210,7 +1188,7 @@ Note that the current interface is not yet set in stone and the development team is open to suggestions for improvements or additions. -\subsection{Callback Functions} +\beginsubsection {Callback Functions} The \luafunction{patch_font} callback is inserted in the wrapper \identifier{luaotfload} provides for the font definition callback @@ -1222,8 +1200,7 @@ the font loader is done creating it. For a short demonstration of its usefulness, here is a snippet that writes an entire font object to the file \fileent{fontdump.lua}: -\begin{quote} - \begin{verbatim} +\beginlisting \input luaotfload.sty \directlua{ local dumpfile = "fontdump.lua" @@ -1240,8 +1217,7 @@ writes an entire font object to the file \fileent{fontdump.lua}: } \font\dumpme=name:Iwona \bye - \end{verbatim} -\end{quote} +\endlisting \emphasis{Beware}: this creates a Lua file of around 150,000 lines of code, taking up 3~\abbrev{mb} of disk space. @@ -1250,7 +1226,7 @@ By inspecting the output you can get a first impression of how a font is structured in \LUATEX’s memory, what elements it is composed of, and in what ways it can be rearranged. -\subsubsection{Compatibility with Earlier Versions} +\beginsubsubsection {Compatibility with Earlier Versions} As has been touched on in the preface to this section, the structure of the object as returned by the fontloader underwent rather drastic @@ -1267,99 +1243,100 @@ units factor, and the font name have again been made accessible from the toplevel of the table even though they were migrated to different subtables in the meantime. -\subsubsection{Patches} +\endsubsubsection + +\beginsubsubsection{Patches} These are mostly concerned with establishing compatibility with \XETEX. -\begin{itemize} - \let\normalitem=\item - \def\ouritem#1{% - \normalitem{\luafunction{#1}}% - \hfill\break - } +\beginfunctionlist - \ouritem {set_sscale_dimens} + \altitem {set_sscale_dimens} Calculate \texmacro{fontdimen}s 10 and 11 to emulate \XETEX. - \ouritem {set_capheight} + \altitem {set_capheight} Calculates \texmacro{fontdimen} 8 like \XETEX. - \ouritem {patch_cambria_domh} + \altitem {patch_cambria_domh} Correct some values of the font \emphasis{Cambria Math}. -\end{itemize} +\endfunctionlist -\subsection{Package Author’s Interface} +\endsubsection + +\beginsubsection {Package Author’s Interface} As \LUATEX release 1.0 is nearing, the demand for a reliable interface for package authors increases. -\subsubsection{Font Properties} +\endsubsubsection + +\beginsubsubsection{Font Properties} Below functions mostly concern querying the different components of a font like for instance the glyphs it contains, or what font features are defined for which scripts. -\begin{itemize} - \let\normalitem=\item - \def\ouritem#1{% - \normalitem{\luafunction{#1}}% - \hfill\break - } +\beginfunctionlist - \ouritem {aux.font_has_glyph (id : int, index : int)} + \altitem {aux.font_has_glyph (id : int, index : int)} Predicate that returns true if the font \luafunction{id} has glyph \luafunction{index}. - \ouritem {aux.slot_of_name(name : string)} + \altitem {aux.slot_of_name(name : string)} Translates an Adobe Glyph name to the corresponding glyph slot. - \ouritem {aux.name_of_slot(slot : int)} + \altitem {aux.name_of_slot(slot : int)} The inverse of \luafunction{slot_of_name}; note that this might be incomplete as multiple glyph names may map to the same codepoint, only one of which is returned by \luafunction{name_of_slot}. - \ouritem {aux.provides_script(id : int, script : string)} + \altitem {aux.provides_script(id : int, script : string)} Test if a font supports \luafunction{script}. - \ouritem {aux.provides_language(id : int, script : string, language : string)} + \altitem {aux.provides_language(id : int, script : string, language : string)} Test if a font defines \luafunction{language} for a given \luafunction{script}. - \ouritem {aux.provides_feature(id : int, script : string, + \altitem {aux.provides_feature(id : int, script : string, language : string, feature : string)} Test if a font defines \luafunction{feature} for \luafunction{language} for a given \luafunction{script}. - \ouritem {aux.get_math_dimension(id : int, dimension : string)} + \altitem {aux.get_math_dimension(id : int, dimension : string)} Get the dimension \luafunction{dimension} of font \luafunction{id}. - \ouritem {aux.sprint_math_dimension(id : int, dimension : string)} + \altitem {aux.sprint_math_dimension(id : int, dimension : string)} Same as \luafunction{get_math_dimension()}, but output the value in scaled points at the \TEX end. -\end{itemize} +\endfunctionlist -\subsubsection{Database} +\endsubsubsection -\begin{itemize} - \let\normalitem=\item - \def\ouritem#1{% - \normalitem{\luafunction{#1}}% - \hfill\break - } +%% not implemented, may come back later +% \beginsubsubsection{Database} +% +% \beginfunctionlist +% \altitem {aux.scan_external_dir(dir : string)} +% Include fonts in directory \luafunction{dir} in font lookups without +% adding them to the database. +% +% \endfunctionlist +% +% \endsubsubsection - \ouritem {aux.scan_external_dir(dir : string)} - Include fonts in directory \luafunction{dir} in font lookups without - adding them to the database. +\endsubsection +\endsection -\end{itemize} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\beginsection {Troubleshooting} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Troubleshooting} +\beginsubsection {Database Generation} -\subsection {Database Generation} If you encounter problems with some fonts, please first update to the latest version of this package before reporting a bug, as \identifier{luaotfload} is under active development and still a moving @@ -1373,30 +1350,24 @@ requests and the likes. Bug reports are more likely to be addressed if they contain the output of -\begin{quote} - \begin{verbatim} +\beginlisting luaotfload-tool --diagnose=environment,files,permissions - \end{verbatim} -\end{quote} +\endlisting \noindent Consult the man page for a description of these options. Errors during database generation can be traced by increasing the verbosity level and redirecting log output to \fileent{stdout}: -\begin{quote} - \begin{verbatim} +\beginlisting luaotfload-tool -fuvvv --log=stdout - \end{verbatim} -\end{quote} +\endlisting \noindent or to a file in \fileent{/tmp}: -\begin{quote} - \begin{verbatim} +\beginlisting luaotfload-tool -fuvvv --log=file - \end{verbatim} -\end{quote} +\endlisting \noindent In the latter case, invoke the \verb|tail(1)| utility on the file for live monitoring of the progress. @@ -1407,7 +1378,9 @@ log file is likely to be the culprit. Please specify it when reporting a bug, and blacklist it for the time being (see above, page \pageref{font-blacklist}). -\subsection {Font Features} +\endsubsection + +\beginsubsection {Font Features} A common problem is the lack of features for some \OpenType fonts even when specified. @@ -1421,22 +1394,20 @@ fix it. % For example with \verb|latn|: -\begin{quote} - \begin{verbatim} +\beginlisting \font\test=file:MyFont.otf:script=latn;+liga; - \end{verbatim} -\end{quote} +\endlisting You can get a list of features that a font defines for scripts and languages by querying it in \fileent{luaotfload-tool}: -\begin{quote} - \begin{verbatim} +\beginlisting luaotfload-tool --find="Iwona" --inspect - \end{verbatim} -\end{quote} +\endlisting + +\endsubsection -\subsection {\LUATEX Programming} +\beginsubsection {\LUATEX Programming} Another strategy that helps avoiding problems is to not access raw \LUATEX internals directly. @@ -1448,11 +1419,9 @@ Thus, whenever possible prefer the functions in the \luafunction{aux} namespace over direct manipulation of font objects. For example, raw access to the \luafunction{font.fonts} table like: -\begin{quote} - \begin{verbatim} +\beginlisting local somefont = font.fonts[2] - \end{verbatim} -\end{quote} +\endlisting \noindent can render already defined fonts unusable. % @@ -1469,8 +1438,7 @@ both \luafunction{font.getfont()} and \luafunction{font.fonts}. % In this case, best define you own accessor: -\begin{quote} - \begin{verbatim} +\beginlisting local unsafe_getfont = function (id) local tfmdata = font.getfont (id) if not tfmdata then @@ -1481,35 +1449,15 @@ In this case, best define you own accessor: --- use like getfont() local somefont = unsafe_getfont (2) - \end{verbatim} -\end{quote} +\endlisting -\part{Implementation} - -\section {\fileent{luaotfload.lua}} - -As of version 2.5, the file \fileent{luaotfload.lua} is no longer -generated from the \abbrev{dtx}. -% -Instead, it is maintained separately as a plain \identifier{Lua} file -\fileent{luaotfload-main.lua} in the Luaotfload \identifier{git} tree. -% -The file documentation which used to be found in this section has been -preserved in the comments. - -\section{\fileent{luaotfload.sty}} - -As of version 2.5, the file \fileent{luaotfload.sty} is no longer -generated from the \abbrev{dtx}. -% -Instead, it is maintained separately as a plain \identifier{\TEX} file -in the Luaotfload \identifier{git} tree. -% -The file documentation which used to be found in this section has -been preserved in the comments. +\endsubsection +\endsection \clearpage -\section{The GNU GPL License v2} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\beginsection {The GNU GPL License v2} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% The GPL requires the complete license text to be distributed along with the code. I recommend the canonical source, instead: @@ -1521,32 +1469,28 @@ You might want to zoom in. \begin{lrbox}{\gpl} \begin{minipage}{3\textwidth} \columnsep=3\columnsep -\begin{multicols}{3} -\begin{center} -{\Large GNU GENERAL PUBLIC LICENSE\par} -\bigskip -{Version 2, June 1991} -\end{center} +\begintriplecolumns +\begincentered + {\Large GNU GENERAL PUBLIC LICENSE\par} + \bigskip + {Version 2, June 1991} -\begin{center} -{\parindent 0in + {\parindent 0in -Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. + Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. -\bigskip + \bigskip -51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA -\bigskip + \bigskip -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. -} -\end{center} + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + } -\begin{center} -{\bf\large Preamble} -\end{center} + {\bf\large Preamble} +\endcentered The licenses for most software are designed to take away your freedom to @@ -1595,12 +1539,12 @@ be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. -\begin{center} -{\Large \sc Terms and Conditions For Copying, Distribution and - Modification} -\end{center} +\begincentered + {\Large \sc Terms and Conditions For Copying, Distribution and + Modification} +\endcentered -\begin{enumerate} +\beginenumeration \item This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the @@ -1635,7 +1579,7 @@ of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: -\begin{enumerate} +\beginenumeration \item You must cause the modified files to carry prominent notices stating that @@ -1659,7 +1603,7 @@ License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) -\end{enumerate} +\endenumeration These requirements apply to the modified work as a whole. If @@ -1687,7 +1631,7 @@ You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: -\begin{enumerate} +\beginenumeration \item @@ -1712,7 +1656,7 @@ allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) -\end{enumerate} +\endenumeration The source code for a work means the preferred form of the work for @@ -1825,11 +1769,9 @@ make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. -\begin{center} -{\Large\sc -No Warranty -} -\end{center} +\begincentered + {\Large\sc No Warranty} +\endcentered \item {\sc Because the program is licensed free of charge, there is no warranty @@ -1853,17 +1795,19 @@ you or third parties or a failure of the program to operate with any other programs), even if such holder or other party has been advised of the possibility of such damages.} -\end{enumerate} +\endenumeration -\begin{center} -{\Large\sc End of Terms and Conditions} -\end{center} +\begincentered + {\Large\sc End of Terms and Conditions} +\endcentered \pagebreak[2] -\section*{Appendix: How to Apply These Terms to Your New Programs} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\fakesection {Appendix: How to Apply These Terms to Your New Programs} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it @@ -1875,36 +1819,36 @@ terms. the exclusion of warranty; and each file should have at least the ``copyright'' line and a pointer to where the full notice is found. -\begin{quote} -one line to give the program's name and a brief idea of what it does. \\ -Copyright (C) yyyy name of author \\ +\beginnarrower + one line to give the program's name and a brief idea of what it does. \\ + Copyright (C) yyyy name of author \\ -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version. + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -\end{quote} + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +\endnarrower Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: -\begin{quote} -Gnomovision version 69, Copyright (C) yyyy name of author \\ -Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ -This is free software, and you are welcome to redistribute it -under certain conditions; type `show c' for details. -\end{quote} +\beginnarrower + Gnomovision version 69, Copyright (C) yyyy name of author \\ + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. +\endnarrower The hypothetical commands {\tt show w} and {\tt show c} should show the @@ -1917,13 +1861,13 @@ You should also get your employer (if you work as a programmer) or your school, if any, to sign a ``copyright disclaimer'' for the program, if necessary. Here is a sample; alter the names: -\begin{quote} +\beginnarrower Yoyodyne, Inc., hereby disclaims all copyright interest in the program \\ `Gnomovision' (which makes passes at compilers) written by James Hacker. \\ signature of Ty Coon, 1 April 1989 \\ Ty Coon, President of Vice -\end{quote} +\endnarrower This General Public License does not permit incorporating your program @@ -1932,13 +1876,15 @@ may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. -\end{multicols} +\endtriplecolumns \end{minipage} \end{lrbox} -\begin{center} -\scalebox{0.33}{\usebox{\gpl}} -\end{center} +\begincentered + \scalebox{0.33}{\usebox{\gpl}} +\endcentered + +\endsection \endinput -- cgit v1.2.3 From 5eedcacffc80114cd64523d1fca6fb8eb1d189e1 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 16 Feb 2014 13:48:17 +0100 Subject: [doc] add note concerning state of feature file support As suggested by @Crissov, https://github.com/lualatex/luaotfload/issues/200#issuecomment-35163810 --- doc/luaotfload-main.tex | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc') diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 37127b7..f5a068d 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -581,6 +581,13 @@ obviously, |random|. The syntax is documented in \identifier{Adobe}’s \OpenType Feature File Specification.\footnote{% Cf. \url{http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. + Feature file support is part of the engine which at the + time of this writing (2014) implements the spec only + partially. + See the + \href{http://tracker.luatex.org/view.php?id=231} + {\LUATEX tracker} + for details. } For a demonstration of how to set a |tkrn| feature consult -- cgit v1.2.3 From 22caa4363c76153ba2ac1ef896ca5d08f5c34236 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 17 Feb 2014 07:35:44 +0100 Subject: [doc] wrap further code in more abstract macros --- doc/luaotfload-latex.tex | 64 ++++++++- doc/luaotfload-main.tex | 364 ++++++++++++++++++++++------------------------- 2 files changed, 236 insertions(+), 192 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index d00a617..dcdcab2 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -156,6 +156,18 @@ \def \fakesection #1{\section*{#1}} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% inline verbatim +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%% Context offers both \type{…} and \type<<…>>, but not an unbalanced +%% one that we could map directly onto Latex’s \verb|…|. + +%% TODO +%\def \inlinecode·#1·{% + %\verb·#1·% +%} + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% codelistings; this sucks hard since we lack access to buffers %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -203,6 +215,7 @@ \small \begin {quote} \bgroup + \addfontfeature {RawFeature=-tlig;-liga}%% So one can’t just turn them all off at once using the ``Ligatures`` key? \luatexcatcodetable \literalcatcodes \obeyspaces \obeylines @@ -254,7 +267,6 @@ \def \begincentered {\begin {center}} \def \endcentered {\end {center}} -\makeatother \def \beginnarrower {\begin {quote}} \def \endnarrower {\end {quote}} @@ -266,10 +278,60 @@ \def \beginabstractcontent {\begin {abstract}} \def \endabstractcontent {\end {abstract}} +\let \setdocumenttitle \title +\let \setdocumentdate \date +\let \setdocumentauthor \author +\let \typesetdocumenttitle \maketitle + +\let \typesetcontent \tableofcontent + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% figure floats +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \beginsyntaxfloat #1{%% the request syntax diagram + \begin {figure} [b] + \def \syntaxcaption {#1}% + \setlength\grammarparsep{12pt plus 2pt minus 2pt}% + \setlength\grammarindent{5cm}% + \begingroup + \small + \begin {grammar} +} + +\def \endsyntaxfloat {% + \end {grammar} + \endgroup + \caption \syntaxcaption + \label{font-syntax} + \end {figure} +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% hyperlinks +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\protected \def \hyperlink{% + \@ifnextchar[{\hyperlinkindeed}% + {\hyperlinkindeed[]}% +} + +\def \hyperlinkindeed [#1]#2{% + \def \first {#1}% + \ifx \first \empty + \url {#2}% + \else + \href {#2}{#1}% + \fi% +} + + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% main %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\makeatother + \begin {document} \input {luaotfload-main.tex} \end {document} diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index f5a068d..6c0d0b6 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -29,21 +29,20 @@ %% ---------------------------------------------------------------------------- %% -\title{The \identifier{luaotfload} package} -\date{2014/**/** v2.5} -\author{Elie Roux · Khaled Hosny · Philipp Gesang\\ - Home: \url {https://github.com/lualatex/luaotfload}\\ - Support: \email {lualatex-dev@tug.org}} +\setdocumenttitle {The \identifier{luaotfload} package} +\setdocumentdate {2014/**/** v2.5} +\setdocumentauthor {Elie Roux · Khaled Hosny · Philipp Gesang\\ + Home: \hyperlink {https://github.com/lualatex/luaotfload}\\ + Support: \email {lualatex-dev@tug.org}} -\maketitle +\typesetdocumenttitle \beginabstractcontent - This package is an adaptation of the \CONTEXT font loading system. - It allows for loading \OpenType fonts with an extended syntax and adds - support for a variety of font features. + This package is an adaptation of the \CONTEXT font loading system. + It allows for loading \OpenType fonts with an extended syntax and adds + support for a variety of font features. \endabstractcontent - \tableofcontents %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -63,10 +62,10 @@ These fonts can contain many more characters than \TEX fonts, as well as additional functionality like ligatures, old-style numbers, small capitals, etc., and support more complex writing systems like Arabic and Indic\footnote{% - Unfortunately, \identifier{luaotfload} doesn‘t support many Indic - scripts right now. - Assistance in implementing the prerequisites is greatly - appreciated. + Unfortunately, \identifier{luaotfload} doesn‘t support many Indic + scripts right now. + Assistance in implementing the prerequisites is greatly + appreciated. } scripts. @@ -128,11 +127,11 @@ in the task and willingness to respond to our suggestions. \identifier{luaotfload} supports an extended font request syntax: \beginnarrower - |\font\foo={|% - \meta{prefix}|:|% - \meta{font name}|:|% - \meta{font features}|}|% - \meta{\TEX font features} + |\font\foo={|% + \meta{prefix}|:|% + \meta{font name}|:|% + \meta{font features}|}|% + \meta{\TEX font features} \endnarrower \noindent @@ -144,12 +143,27 @@ Alternatively, double quotes serve the same purpose. A selection of individual parts of the syntax are discussed below; for a more formal description see figure \ref{font-syntax}. -\begin {figure} [b] - \setlength\grammarparsep{12pt plus 2pt minus 2pt} - \setlength\grammarindent{5cm} - \begingroup - \small - \begin{grammar} +\beginsyntaxfloat + {Font request syntax. + Braces or double quotes around the + \emphasis{specification} rule will + preserve whitespace in file names. + In addition to the font style modifiers + (\emphasis{slash-notation}) given above, there + are others that are recognized but will be silently + ignored: {\ttfamily aat}, + {\ttfamily icu}, and + {\ttfamily gr}. + The special terminals are: + {\sc feature\textunderscore id} for a valid font + feature name and + {\sc feature\textunderscore value} for the corresponding + value. + {\sc tfmname} is the name of a \abbrev{tfm} file. + {\sc digit} again refers to bytes 48--57, and + {\sc all\textunderscore characters} to all byte values. + {\sc csname} and {\sc dimension} are the \TEX concepts.} +% ::= `\\font', {\sc csname}, `=', , [ ] ; ::= `at', {\sc dimension} ; @@ -187,29 +201,7 @@ for a more formal description see figure \ref{font-syntax}. ::= `+' | `-' ; ::= {\sc all_characters} - ( `(' | `/' | `:' ) ; - \end{grammar} - \endgroup - \caption{Font request syntax. - Braces or double quotes around the - \emphasis{specification} rule will - preserve whitespace in file names. - In addition to the font style modifiers - (\emphasis{slash-notation}) given above, there - are others that are recognized but will be silently - ignored: {\ttfamily aat}, - {\ttfamily icu}, and - {\ttfamily gr}. - The special terminals are: - {\sc feature\textunderscore id} for a valid font - feature name and - {\sc feature\textunderscore value} for the corresponding - value. - {\sc tfmname} is the name of a \abbrev{tfm} file. - {\sc digit} again refers to bytes 48--57, and - {\sc all\textunderscore characters} to all byte values. - {\sc csname} and {\sc dimension} are the \TEX concepts.} - \label{font-syntax} -\end {figure} +\endsyntaxfloat \beginsubsection{Prefix -- the \identifier{luaotfload}{ }Way} @@ -220,26 +212,25 @@ requires a \emphasis{prefix}: |\font\fontname=|\meta{prefix}|:|\meta{fontname}\dots \endnarrower % -where \meta{prefix} is either \verb|file:| or \verb|name:|.\footnote{% +where \meta{prefix} is either \inlinecode·file:· or \verb|name:|.\footnote{% The development version also knows two further prefixes, \verb|kpse:| and \verb|my:|. - % + % A \verb|kpse| lookup is restricted to files that can be found by \identifier{kpathsea} and will not attempt to locate system fonts. - % + % This behavior can be of value when an extra degree of encapsulation is needed, for instance when supplying a customized tex distribution. The \verb|my| lookup takes this a step further: it lets you define a custom resolver function and hook it into the \luafunction{resolve_font} callback. - % + % This ensures full control over how a file is located. - % + % For a working example see the - \href{https://bitbucket.org/phg/lua-la-tex-tests/src/5f6a535d/pln-lookup-callback-1.tex} - {test repo}. + \hyperlink [test repo]{https://bitbucket.org/phg/lua-la-tex-tests/src/5f6a535d/pln-lookup-callback-1.tex}. } % It determines whether the font loader should interpret the request as @@ -256,23 +247,22 @@ usually listed in drop-down menus and the like.\footnote{% Font names may appear like a great choice at first because they offer seemingly more intuitive identifiers in comparison to arguably cryptic file names: - % + % “PT Sans Bold” is a lot more descriptive than \fileent{PTS75F.ttf}. On the other hand, font names are quite arbitrary and there is no universal method to determine their meaning. - % + % While \identifier{luaotfload} provides fairly sophisticated heuristic to figure out a matching font style, weight, and optical size, it cannot be relied upon to work satisfactorily for all font files. - % + % For an in-depth analysis of the situation and how broken font names are, please refer to - \href{http://www.ntg.nl/pipermail/ntg-context/2013/073889.html} - {this post} + \hyperlink [this post]{http://www.ntg.nl/pipermail/ntg-context/2013/073889.html} by Hans Hagen, the author of the font loader. - % + % If in doubt, use filenames. - % + % \fileent{luaotfload-tool} can perform the matching for you with the option \verb|--find=|, and you can use the file name it returns in your font definition. @@ -287,9 +277,9 @@ create the database. File names are whatever your file system allows them to be, except that that they may not contain the characters - \verb|(|, - \verb|:|, and - \verb|/|. + \verb|(|, + \verb|:|, and + \verb|/|. % As is obvious from the last exception, the \verb|file:| lookup will not process paths to the font location -- only those @@ -299,9 +289,9 @@ Continue below in the \XETEX section if you need to load your fonts by path. % The file names corresponding to the example font names above are - \fileent{lmroman12-italic.otf}, - \fileent{GFSBodoni.otf}, and - \fileent{PTZ56F.ttf}. + \fileent{lmroman12-italic.otf}, + \fileent{GFSBodoni.otf}, and + \fileent{PTZ56F.ttf}. \endsubsection @@ -370,7 +360,7 @@ request like so: The \OpenType version of Janusz Nowacki’s font \emphasis{Antykwa Półtawskiego}\footnote{% - \url{http://jmn.pl/antykwa-poltawskiego/}, also available in + \hyperlink {http://jmn.pl/antykwa-poltawskiego/}, also available in in \TEX Live. } in its condensed variant can be loaded as follows: @@ -425,7 +415,7 @@ Which fits nicely with the whole set: \beginsubsubsection{Modifiers} If the entire \emphasis{Iwona} family\footnote{% - \url{http://jmn.pl/kurier-i-iwona/}, + \hyperlink {http://jmn.pl/kurier-i-iwona/}, also in \TEX Live. } is installed in some location accessible by \identifier{luaotfload}, @@ -479,7 +469,7 @@ If style modifiers are present (\XETEX style), they must precede The element \meta{font features} is a semicolon-separated list of feature tags\footnote{% - Cf. \url{http://www.microsoft.com/typography/otspec/featurelist.htm}. + Cf. \hyperlink {http://www.microsoft.com/typography/otspec/featurelist.htm}. } and font options. % @@ -513,8 +503,8 @@ They can be selected either explicitly by supplying the variant index (starting from one), or randomly by setting the value to, obviously, |random|. -%% TODO verify that this actually works with a font that supports -%% the salt/random feature!\fi +%% TODO verify that this actually works with a font that supports +%% the salt/random feature!\fi \beginlisting \font\librmsaltfirst=LatinModernRoman:salt=1 \endlisting @@ -530,14 +520,14 @@ obviously, |random|. \identifier{base} mode works by mapping \OpenType features to traditional \TEX ligature and kerning mechanisms. - % + % Supporting only non-contextual substitutions and kerning pairs, it is the slightly faster, albeit somewhat limited, variant. - % + % \identifier{node} mode works by processing \TeX’s internal node list directly at the \LUA end and supports a wider range of \OpenType features. - % + % The downside is that the intricate operations required for \identifier{node} mode may slow down typesetting especially with complex fonts and it does not work in math mode. @@ -548,46 +538,45 @@ obviously, |random|. \item [script] \label{script-tag} \hfill \\ An \OpenType script tag;\footnote{% - See \url{http://www.microsoft.com/typography/otspec/scripttags.htm} + See \hyperlink {http://www.microsoft.com/typography/otspec/scripttags.htm} for a list of valid values. - % + % For scripts derived from the Latin alphabet the value |latn| is good choice. } the default value is |dlft|. - % + % Some fonts, including very popular ones by foundries like Adobe, do not assign features to the |dflt| script, in which case the script needs to be set explicitly. \item [language] \hfill \\ An \OpenType language system identifier,\footnote{% - Cf. \url{http://www.microsoft.com/typography/otspec/languagetags.htm}. + Cf. \hyperlink {http://www.microsoft.com/typography/otspec/languagetags.htm}. } defaulting to |dflt|. \item [featurefile] \hfill \\ A comma-separated list of feature files to be applied to the font. - % + % Feature files contain a textual representation of \OpenType tables and extend the features of a font on fly. - % + % After they are applied to a font, features defined in a feature file can be enabled or disabled just like any other font feature. - % + % The syntax is documented in \identifier{Adobe}’s \OpenType Feature File Specification.\footnote{% - Cf. \url{http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. - Feature file support is part of the engine which at the - time of this writing (2014) implements the spec only - partially. - See the - \href{http://tracker.luatex.org/view.php?id=231} - {\LUATEX tracker} - for details. + Cf. \hyperlink {http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. + Feature file support is part of the engine which at the + time of this writing (2014) implements the spec only + partially. + See the + \hyperlink [\LUATEX tracker]{http://tracker.luatex.org/view.php?id=231} + for details. } For a demonstration of how to set a |tkrn| feature consult @@ -604,13 +593,13 @@ obviously, |random|. For example, in order to set text in semitransparent red: - \beginlisting + \beginlisting \font\test={Latin Modern Roman}:color=FF0000BB - \endlisting + \endlisting \item [kernfactor \& letterspace] \hfill \\ Define a font with letterspacing (tracking) enabled. - % + % In \identifier{luaotfload}, letterspacing is implemented by inserting additional kerning between glyphs. @@ -618,7 +607,7 @@ obviously, |random|. \emphasis{character kerning} (\texmacro{setcharacterkerning} / \texmacro{definecharacterkerning} \& al.) functionality of Context, see the file \fileent{typo-krn.lua} there. - % + % The main difference is that \identifier{luaotfload} does not use \LUATEX attributes to assign letterspacing to regions, but defines virtual letterspaced versions of a font. @@ -626,11 +615,11 @@ obviously, |random|. The option \identifier{kernfactor} accepts a numeric value that determines the letterspacing factor to be applied to the font size. - % + % E.~g. a kern factor of $0.42$ applied to a $10$ pt font results in $4.2$ pt of additional kerning applied to each pair of glyphs. - % + % Ligatures are split into their component glyphs unless explicitly ignored (see below). @@ -638,35 +627,35 @@ obviously, |random|. \identifier{letterspace} option is supplied that interprets the supplied value as a \emphasis{percentage} of the font size but is otherwise identical to \identifier{kernfactor}. - % + % Consequently, both definitions in below snippet yield the same letterspacing width: - \beginlisting + \beginlisting \font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" \font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" - \endlisting + \endlisting Specific pairs of letters and ligatures may be exempt from letterspacing by defining the \LUA functions \luafunction{keeptogether} and \luafunction{keepligature}, respectively, inside the namespace \verb|luaotfload.letterspace|. - % + % Both functions are called whenever the letterspacing callback encounters an appropriate node or set of nodes. - % + % If they return a true-ish value, no extra kern is inserted at the current position. - % + % \luafunction{keeptogether} receives a pair of consecutive glyph nodes in order of their appearance in the node list. - % + % \luafunction{keepligature} receives a single node which can be analyzed into components. - % + % (For details refer to the \emphasis{glyph nodes} section in the \LUATEX reference manual.) - % + % The implementation of both functions is left entirely to the user. @@ -675,22 +664,22 @@ obviously, |random|. These keys control microtypographic features of the font, namely \emphasis{character protrusion} and \emphasis{font expansion}. - % + % Their arguments are names of \LUA tables that contain values for the respective features.\footnote{% For examples of the table layout please refer to the section of the file \fileent{luaotfload-fonts-ext.lua} where the default values are defined. - % + % Alternatively and with loss of information, you can dump those tables into your terminal by issuing - \beginlisting + \beginlisting \directlua{inspect(fonts.protrusions.setups.default) inspect(fonts.expansions.setups.default)} - \endlisting + \endlisting at some point after loading \fileent{luaotfload.sty}. } - % + % For both, only the set \identifier{default} is predefined. For example, to define a font with the default @@ -700,14 +689,13 @@ obviously, |random|. \verb|pdfadjustspacing=2| to activate protrusion and expansion, respectively. See the - \href{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% - {\PDFTEX manual} + \hyperlink [\PDFTEX manual]{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% for details. }: - \beginlisting + \beginlisting \font\test=LatinModernRoman:protrusion=default - \endlisting + \endlisting \end{description} \paragraph{Non-standard font features} @@ -764,7 +752,7 @@ fonts are available to \LUATEX by means of a \emphasis{database}. This allows referring to fonts not only by explicit filenames but also by the proper names contained in the metadata which is often more accessible to humans.\footnote{% - The tool \href{http://www.lcdf.org/type/}{\fileent{otfinfo}} (comes + The tool \hyperlink[\fileent{otfinfo}]{http://www.lcdf.org/type/} (comes with \TEX Live), when invoked on a font file with the \verb|-i| option, lists the variety of name fields defined for it. } @@ -791,7 +779,7 @@ This is particularly noticeable if it occurs during a typesetting run. In any case, subsequent updates to the database will be quite fast. \beginsubsection[luaotfload-tool] - {\fileent{luaotfload-tool}} + {\fileent{luaotfload-tool}} It can still be desirable at times to do some of these steps manually, and without having to compile a document. @@ -805,8 +793,7 @@ either make it executable (\verb|chmod +x| on unixoid systems) or pass it as an argument to \fileent{texlua}.\footnote{% Tests by the maintainer show only marginal performance gain by running with Luigi Scarso’s - \href{https://foundry.supelec.fr/projects/luajittex/}% - {\identifier{Luajit\kern-.25ex\TEX}}, + \hyperlink [\identifier{Luajit\kern-.25ex\TEX}]{https://foundry.supelec.fr/projects/luajittex/}, which is probably due to the fact that most of the time is spent on file system operations. @@ -821,14 +808,14 @@ Invoked with the argument \verb|--update| it will perform a database update, scanning for fonts not indexed. \beginlisting - luaotfload-tool --update + luaotfload-tool --update \endlisting Adding the \verb|--force| switch will initiate a complete rebuild of the database. \beginlisting - luaotfload-tool --update --force + luaotfload-tool --update --force \endlisting Whenever it is run under this name, it will update the database first, mimicking the behavior of earlier versions of @@ -863,7 +850,7 @@ directories. \caption{List of paths searched for each supported operating system.} \renewcommand{\arraystretch}{1.2} - \begincentered + \begincentered \begin{tabular}{lp{.5\textwidth}} Windows & \verb|%WINDIR%\Fonts| \\ @@ -876,7 +863,7 @@ directories. \fileent{/Network/Library/Fonts} \\ \end{tabular} - \endcentered + \endcentered \label{table-searchpaths} \hrule \end{table} @@ -895,7 +882,7 @@ matching name. For instance, the invocation \beginlisting - luaotfload-tool --find="Iwona Regular" + luaotfload-tool --find="Iwona Regular" \endlisting \noindent @@ -911,7 +898,7 @@ Suppose you cannot precisely remember if the variant of The query \beginlisting - luaotfload-tool -F --find="Iwona Bright" + luaotfload-tool -F --find="Iwona Bright" \endlisting \noindent @@ -921,7 +908,7 @@ Basic information about fonts in the database can be displayed using the \verb|-i| option (\verb|--info|). % \beginlisting - luaotfload-tool -i --find="Iwona Light Italic" + luaotfload-tool -i --find="Iwona Light Italic" \endlisting % \noindent @@ -933,7 +920,7 @@ The meaning of the printed values is described in section 4.4 of the For a much more detailed report about a given font try the \verb|-I| option instead (\verb|--inspect|). \beginlisting - luaotfload-tool -I --find="Iwona Light Italic" + luaotfload-tool -I --find="Iwona Light Italic" \endlisting \verb|luaotfload-tool --help| will list the available command line @@ -1003,11 +990,8 @@ An example with explicit paths: %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \identifier{luaotfload} relies on code originally written by Hans -Hagen\footnote{% - The creator of the \href{http://wiki.contextgarden.net}{\CONTEXT} - format. -} -for and tested with \CONTEXT. +Hagen for the \hyperlink[\identifier\CONTEXT]{http://wiki.contextgarden.net} +format. % It integrates the font loader as distributed in the \identifier{\LUATEX-Fonts} package. @@ -1045,9 +1029,7 @@ has been imported as \fileent{luaotfload-fontloader.lua}. It is generated by \fileent{mtx-package}, a \LUA source code merging too developed by Hans Hagen.\footnote{% \fileent{mtx-package} is - \href - {http://repo.or.cz/w/context.git/blob_plain/refs/heads/origin:/scripts/context/lua/mtx-package.lua} - {part of \CONTEXT} + \hyperlink [part of \CONTEXT]{http://repo.or.cz/w/context.git/blob_plain/refs/heads/origin:/scripts/context/lua/mtx-package.lua} and requires \fileent{mtxrun}. Run \verb|mtxrun --script package --help| @@ -1063,22 +1045,22 @@ categories. of what is provided by the \identifier{lualibs} package. - \begindoublecolumns - \begindefinitions - \altitem{l-lua.lua} \altitem{l-lpeg.lua} - \altitem{l-function.lua} \altitem{l-string.lua} - \altitem{l-table.lua} \altitem{l-io.lua} - \altitem{l-file.lua} \altitem{l-boolean.lua} - \altitem{l-math.lua} \altitem{util-str.lua} - \enddefinitions - \enddoublecolumns + \begindoublecolumns + \begindefinitions + \altitem{l-lua.lua} \altitem{l-lpeg.lua} + \altitem{l-function.lua} \altitem{l-string.lua} + \altitem{l-table.lua} \altitem{l-io.lua} + \altitem{l-file.lua} \altitem{l-boolean.lua} + \altitem{l-math.lua} \altitem{util-str.lua} + \enddefinitions + \enddoublecolumns \normalitem The \emphasis{font loader} itself. These files have been written for \LUATEX-Fonts and they are distributed along with \identifier{luaotfload}. - \begindoublecolumns - \begindefinitions + \begindoublecolumns + \begindefinitions \altitem{luatex-basics-gen.lua} \altitem{luatex-basics-nod.lua} \altitem{luatex-fonts-enc.lua} @@ -1091,22 +1073,22 @@ categories. \altitem{luatex-fonts-def.lua} \altitem{luatex-fonts-ext.lua} \altitem{luatex-fonts-cbk.lua} - \enddefinitions - \enddoublecolumns + \enddefinitions + \enddoublecolumns \normalitem Code related to \emphasis{font handling and node processing}, taken directly from \CONTEXT. - \begindoublecolumns - \begindefinitions + \begindoublecolumns + \begindefinitions \altitem{data-con.lua} \altitem{font-ini.lua} \altitem{font-con.lua} \altitem{font-cid.lua} \altitem{font-map.lua} \altitem{font-oti.lua} \altitem{font-otf.lua} \altitem{font-otb.lua} \altitem{font-ota.lua} \altitem{font-def.lua} \altitem{font-otp.lua} - \enddefinitions - \enddoublecolumns + \enddefinitions + \enddoublecolumns \enddefinitions Note that if \identifier{luaotfload} cannot locate the @@ -1350,7 +1332,7 @@ latest version of this package before reporting a bug, as target. % The development takes place on \identifier{github} at -\url{https://github.com/lualatex/luaotfload} where there is an issue +\hyperlink {https://github.com/lualatex/luaotfload} where there is an issue tracker for submitting bug reports, feature requests and the likes requests and the likes. @@ -1468,7 +1450,7 @@ In this case, best define you own accessor: The GPL requires the complete license text to be distributed along with the code. I recommend the canonical source, instead: -\url{http://www.gnu.org/licenses/old-licenses/gpl-2.0.html}. +\hyperlink {http://www.gnu.org/licenses/old-licenses/gpl-2.0.html}. But if you insist on an included copy, here it is. You might want to zoom in. @@ -1478,25 +1460,25 @@ You might want to zoom in. \columnsep=3\columnsep \begintriplecolumns \begincentered - {\Large GNU GENERAL PUBLIC LICENSE\par} - \bigskip - {Version 2, June 1991} + {\Large GNU GENERAL PUBLIC LICENSE\par} + \bigskip + {Version 2, June 1991} - {\parindent 0in + {\parindent 0in - Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. + Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. - \bigskip + \bigskip - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - \bigskip + \bigskip - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - } + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + } - {\bf\large Preamble} + {\bf\large Preamble} \endcentered @@ -1547,8 +1529,8 @@ The precise terms and conditions for copying, distribution and modification follow. \begincentered - {\Large \sc Terms and Conditions For Copying, Distribution and - Modification} + {\Large \sc Terms and Conditions For Copying, Distribution and + Modification} \endcentered \beginenumeration @@ -1777,7 +1759,7 @@ of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. \begincentered - {\Large\sc No Warranty} + {\Large\sc No Warranty} \endcentered \item @@ -1806,7 +1788,7 @@ possibility of such damages.} \begincentered - {\Large\sc End of Terms and Conditions} + {\Large\sc End of Terms and Conditions} \endcentered @@ -1827,22 +1809,22 @@ terms. ``copyright'' line and a pointer to where the full notice is found. \beginnarrower - one line to give the program's name and a brief idea of what it does. \\ - Copyright (C) yyyy name of author \\ - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + one line to give the program's name and a brief idea of what it does. \\ + Copyright (C) yyyy name of author \\ + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. \endnarrower Also add information on how to contact you by electronic and paper mail. @@ -1851,10 +1833,10 @@ If the program is interactive, make it output a short notice like this when it starts in an interactive mode: \beginnarrower - Gnomovision version 69, Copyright (C) yyyy name of author \\ - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. + Gnomovision version 69, Copyright (C) yyyy name of author \\ + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. \endnarrower @@ -1888,7 +1870,7 @@ General Public License instead of this License. \end{lrbox} \begincentered - \scalebox{0.33}{\usebox{\gpl}} + \scalebox{0.33}{\usebox{\gpl}} \endcentered \endsection -- cgit v1.2.3 From a7d9c930f9f0c688a2530bd23e59f0cd830fc9d6 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Tue, 25 Feb 2014 07:02:39 +0100 Subject: [doc] move Latex inline verbatim commands to listings --- doc/luaotfload-latex.tex | 26 ++++++----- doc/luaotfload-main.tex | 109 ++++++++++++++++++++++++----------------------- 2 files changed, 70 insertions(+), 65 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index dcdcab2..58c8793 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -34,11 +34,11 @@ \makeatletter -\usepackage{metalogo,multicol,mdwlist,fancyvrb,xspace} -\usepackage[x11names]{xcolor} +\usepackage {metalogo,multicol,mdwlist,fancyvrb,xspace} +\usepackage [x11names] {xcolor} -\def\primarycolor{DodgerBlue4} %%-> rgb 16 78 139 | #104e8b -\def\secondarycolor{Goldenrod4} %%-> rgb 139 105 200 | #8b6914 +\def \primarycolor {DodgerBlue4} %%-> rgb 16 78 139 | #104e8b +\def \secondarycolor {Goldenrod4} %%-> rgb 139 105 200 | #8b6914 \usepackage[ bookmarks=true, @@ -46,14 +46,14 @@ linkcolor=\primarycolor, urlcolor=\secondarycolor, citecolor=\primarycolor, - pdftitle={The luaotfload package}, + pdftitle={The Luaotfload package}, pdfsubject={OpenType layout system for Plain TeX and LaTeX}, pdfauthor={Elie Roux & Khaled Hosny & Philipp Gesang}, pdfkeywords={luatex, lualatex, unicode, opentype} ]{hyperref} -\usepackage{fontspec} -\usepackage{unicode-math} +\usepackage {fontspec} +\usepackage {unicode-math} \setmainfont[ % Numbers = OldStyle, %% buggy with font cache @@ -163,10 +163,14 @@ %% Context offers both \type{…} and \type<<…>>, but not an unbalanced %% one that we could map directly onto Latex’s \verb|…|. -%% TODO -%\def \inlinecode·#1·{% - %\verb·#1·% -%} +\usepackage {listings} +\lstset { + basicstyle=\ttfamily, +} + +\def \inlinecode #1{% + \lstinline {#1}% +} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% codelistings; this sucks hard since we lack access to buffers diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 6c0d0b6..c7a7297 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -212,18 +212,18 @@ requires a \emphasis{prefix}: |\font\fontname=|\meta{prefix}|:|\meta{fontname}\dots \endnarrower % -where \meta{prefix} is either \inlinecode·file:· or \verb|name:|.\footnote{% +where \meta{prefix} is either \inlinecode{file:} or \inlinecode {name:}.\footnote{% The development version also knows two further prefixes, - \verb|kpse:| and \verb|my:|. + \inlinecode {kpse:} and \inlinecode {my:}. % - A \verb|kpse| lookup is restricted to files that can be found by + A \inlinecode {kpse} lookup is restricted to files that can be found by \identifier{kpathsea} and will not attempt to locate system fonts. % This behavior can be of value when an extra degree of encapsulation is needed, for instance when supplying a customized tex distribution. - The \verb|my| lookup takes this a step further: it lets you define + The \inlinecode {my} lookup takes this a step further: it lets you define a custom resolver function and hook it into the \luafunction{resolve_font} callback. % @@ -264,7 +264,7 @@ usually listed in drop-down menus and the like.\footnote{% If in doubt, use filenames. % \fileent{luaotfload-tool} can perform the matching for you with the - option \verb|--find=|, and you can use the file name it returns + option \inlinecode {--find=}, and you can use the file name it returns in your font definition. } % @@ -277,11 +277,11 @@ create the database. File names are whatever your file system allows them to be, except that that they may not contain the characters - \verb|(|, - \verb|:|, and - \verb|/|. + \inlinecode {(}, + \inlinecode {:}, and + \inlinecode {/}. % -As is obvious from the last exception, the \verb|file:| lookup will +As is obvious from the last exception, the \inlinecode {file:} lookup will not process paths to the font location -- only those files found when generating the database are addressable this way. % @@ -312,7 +312,7 @@ Inside the square brackets, every character except for a closing bracket is permitted, allowing for specifying paths to a font file. % Naturally, path-less file names are equally valid and processed the -same way as an ordinary \verb|file:| lookup. +same way as an ordinary \inlinecode {file:} lookup. \beginnarrower |\font\fontname=|\meta{font name} \dots @@ -325,8 +325,8 @@ However, they have a broader spectrum of possible interpretations: before anything else, \identifier{luaotfload} attempts to load a traditional \TEX Font Metric (\abbrev{tfm} or \abbrev{ofm}). % -If this fails, it performs a \verb|name:| lookup, which itself will -fall back to a \verb|file:| lookup if no database entry matches +If this fails, it performs a \inlinecode {name:} lookup, which itself will +fall back to a \inlinecode {file:} lookup if no database entry matches \meta{font name}. Furthermore, \identifier{luaotfload} supports the slashed (shorthand) @@ -338,9 +338,9 @@ font style notation from \XETEX. \noindent Currently, four style modifiers are supported: - \verb|I| for italic shape, - \verb|B| for bold weight, - \verb|BI| or \verb|IB| for the combination of both. + \inlinecode {I} for italic shape, + \inlinecode {B} for bold weight, + \inlinecode {BI} or \inlinecode {IB} for the combination of both. % Other “slashed” modifiers are too specific to the \XETEX engine and have no meaning in \LUATEX. @@ -351,8 +351,8 @@ have no meaning in \LUATEX. \beginsubsubsection{Loading by File Name} -For example, conventional \abbrev{type1} font can be loaded with a \verb|file:| -request like so: +For example, conventional \abbrev{type1} font can be loaded with a +\inlinecode {file:} request like so: \beginlisting \font \lmromanten = {file:ec-lmr10} at 10pt @@ -381,7 +381,7 @@ non-standard directory: \beginsubsubsection{Loading by Font Name} -The \verb|name:| lookup does not depend on cryptic filenames: +The \inlinecode {name:} lookup does not depend on cryptic filenames: \beginlisting \font \pagellaregular = {name:TeX Gyre Pagella} at 9pt @@ -639,7 +639,7 @@ obviously, |random|. Specific pairs of letters and ligatures may be exempt from letterspacing by defining the \LUA functions \luafunction{keeptogether} and \luafunction{keepligature}, - respectively, inside the namespace \verb|luaotfload.letterspace|. + respectively, inside the namespace \inlinecode {luaotfload.letterspace}. % Both functions are called whenever the letterspacing callback encounters an appropriate node or set of nodes. @@ -685,8 +685,8 @@ obviously, |random|. For example, to define a font with the default protrusion vector applied\footnote{% You also need to set - \verb|pdfprotrudechars=2| and - \verb|pdfadjustspacing=2| + \inlinecode {pdfprotrudechars=2} and + \inlinecode {pdfadjustspacing=2} to activate protrusion and expansion, respectively. See the \hyperlink [\PDFTEX manual]{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% @@ -716,19 +716,19 @@ Currently (2014) there are three of them: Applies legacy \TEX ligatures: \begin{tabular}{rlrl} - `` & \verb|``| & '' & \verb|''| \\ - ` & \verb|`| & ' & \verb|'| \\ - " & \verb|"| & -- & \verb|--| \\ - --- & \verb|---| & !` & \verb|!`| \\ - ?` & \verb|?`| & & \\ + `` & \inlinecode {``} & '' & \inlinecode {''} \\ + ` & \inlinecode {`} & ' & \inlinecode {'} \\ + " & \inlinecode {"} & -- & \inlinecode {--} \\ + --- & \inlinecode {---} & !` & \inlinecode {!`} \\ + ?` & \inlinecode {?`} & & \\ \end{tabular} \footnote{% - These contain the feature set \verb|trep| of earlier + These contain the feature set \inlinecode {trep} of earlier versions of \identifier{luaotfload}. Note to \XETEX users: this is the equivalent of the - assignment \verb|mapping=text-tex| using \XETEX's input + assignment \inlinecode {mapping=text-tex} using \XETEX's input remapping feature. } @@ -752,9 +752,10 @@ fonts are available to \LUATEX by means of a \emphasis{database}. This allows referring to fonts not only by explicit filenames but also by the proper names contained in the metadata which is often more accessible to humans.\footnote{% - The tool \hyperlink[\fileent{otfinfo}]{http://www.lcdf.org/type/} (comes - with \TEX Live), when invoked on a font file with the \verb|-i| - option, lists the variety of name fields defined for it. + The tool \hyperlink[\fileent{otfinfo}]{http://www.lcdf.org/type/} + (comes with \TEX Live), when invoked on a font file with the + \inlinecode {-i} option, lists the variety of name fields defined for + it. } When \identifier{luaotfload} is asked to load a font by a font name, @@ -789,7 +790,7 @@ To this end, \identifier{luaotfload} comes with the utility functionality. % Being a \LUA script, there are two ways to run it: -either make it executable (\verb|chmod +x| on unixoid systems) or +either make it executable (\inlinecode {chmod +x} on unixoid systems) or pass it as an argument to \fileent{texlua}.\footnote{% Tests by the maintainer show only marginal performance gain by running with Luigi Scarso’s @@ -801,17 +802,17 @@ pass it as an argument to \fileent{texlua}.\footnote{% On \abbrev{MS} \identifier{Windows} systems, the script can be run either by calling the wrapper application \fileent{luaotfload-tool.exe} or as - \verb|texlua.exe luaotfload-tool.lua|. + \inlinecode {texlua.exe luaotfload-tool.lua}. } % -Invoked with the argument \verb|--update| it will perform a database +Invoked with the argument \inlinecode {--update} it will perform a database update, scanning for fonts not indexed. \beginlisting luaotfload-tool --update \endlisting -Adding the \verb|--force| switch will initiate a complete +Adding the \inlinecode {--force} switch will initiate a complete rebuild of the database. \beginlisting @@ -830,17 +831,17 @@ expected to be located on a given system. % On a Linux machine it follows the paths listed in the \identifier{Fontconfig} configuration files; -consult \verb|man 5 fonts.conf| for further information. +consult \inlinecode {man 5 fonts.conf} for further information. % On \identifier{Windows} systems, the standard location is -\verb|Windows\Fonts|, +\inlinecode {Windows\\Fonts}, % while \identifier{Mac OS~X} requires a multitude of paths to be examined. % The complete list is is given in table \ref{table-searchpaths}. Other paths can be specified by setting the environment variable -\verb+OSFONTDIR+. +\inlinecode {OSFONTDIR}. % If it is non-empty, then search will be extended to the included directories. @@ -852,7 +853,7 @@ directories. \renewcommand{\arraystretch}{1.2} \begincentered \begin{tabular}{lp{.5\textwidth}} - Windows & \verb|%WINDIR%\Fonts| + Windows & \inlinecode {\%WINDIR\%\\Fonts} \\ Linux & \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break \fileent{/etc/fonts/fonts.conf} @@ -875,7 +876,7 @@ directories. \fileent{luaotfload-tool} also provides rudimentary means of accessing the information collected in the font database. % -If the option \verb|--find=|\emphasis{name} is given, the script will +If the option \inlinecode {--find=}\emphasis{name} is given, the script will try and search the fonts indexed by \identifier{luaotfload} for a matching name. % @@ -890,7 +891,7 @@ will verify if “Iwona Regular” is found in the database and can be readily requested in a document. If you are unsure about the actual font name, then add the -\verb|-F| (or \verb|--fuzzy|) switch to the command line to enable +\inlinecode {-F} (or \inlinecode {--fuzzy}) switch to the command line to enable approximate matching. % Suppose you cannot precisely remember if the variant of @@ -905,7 +906,7 @@ The query will tell you that indeed the latter name is correct. Basic information about fonts in the database can be displayed -using the \verb|-i| option (\verb|--info|). +using the \inlinecode {-i} option (\inlinecode {--info}). % \beginlisting luaotfload-tool -i --find="Iwona Light Italic" @@ -917,19 +918,19 @@ The meaning of the printed values is described in section 4.4 of the In \TEX Live: \fileent{texmf-dist/doc/luatex/base/luatexref-t.pdf}. } -For a much more detailed report about a given font try the \verb|-I| option -instead (\verb|--inspect|). +For a much more detailed report about a given font try the +\inlinecode {-I} option instead (\inlinecode {--inspect}). \beginlisting luaotfload-tool -I --find="Iwona Light Italic" \endlisting -\verb|luaotfload-tool --help| will list the available command line +\inlinecode {luaotfload-tool --help} will list the available command line switches, including some not discussed in detail here. % For a full documentation of \identifier{luaotfload-tool} and its capabilities refer to the manpage -(\verb|man 1 luaotfload-tool|).\footnote{% - Or see \verb|luaotfload-tool.rst| in the source directory. +(\inlinecode {man 1 luaotfload-tool}).\footnote{% + Or see \inlinecode {luaotfload-tool.rst} in the source directory. } \endsubsection @@ -941,7 +942,7 @@ Some fonts are problematic in general, or just in \LUATEX. % If you find that compiling your document takes far too long or eats away all your system’s memory, you can track down the culprit by -running \verb|luaotfload-tool -v| to increase verbosity. +running \inlinecode {luaotfload-tool -v} to increase verbosity. % Take a note of the \emphasis{filename} of the font that database creation fails with and append it to the file @@ -960,7 +961,7 @@ Place this file to some location where the \identifier{kpse} library can find it, e.~g. \fileent{texmf-local/tex/luatex/luaotfload} if you are running \identifier{\TEX Live},\footnote{% - You may have to run \verb|mktexlsr| if you created a new file in + You may have to run \inlinecode {mktexlsr} if you created a new file in your \fileent{texmf} tree. } or just leave it in the working directory of your document. @@ -1032,7 +1033,7 @@ too developed by Hans Hagen.\footnote{% \hyperlink [part of \CONTEXT]{http://repo.or.cz/w/context.git/blob_plain/refs/heads/origin:/scripts/context/lua/mtx-package.lua} and requires \fileent{mtxrun}. Run - \verb|mtxrun --script package --help| + \inlinecode {mtxrun --script package --help} to display further information. For the actual merging code see the file \fileent{util-mrg.lua} that is part of \CONTEXT. @@ -1096,7 +1097,7 @@ merged file, it will load the individual \LUA libraries instead. % Their names remain the same as in \CONTEXT (without the -\verb|otfl|-prefix) since we imported the relevant section of +\inlinecode {otfl}-prefix) since we imported the relevant section of \fileent{luatex-fonts.lua} unmodified into \fileent{luaotfload-main.lua}. Thus if you prefer running bleeding edge code from the \CONTEXT beta, all you have to do is remove @@ -1358,7 +1359,7 @@ verbosity level and redirecting log output to \fileent{stdout}: luaotfload-tool -fuvvv --log=file \endlisting -\noindent In the latter case, invoke the \verb|tail(1)| utility on the +\noindent In the latter case, invoke the \inlinecode {tail(1)} utility on the file for live monitoring of the progress. If database generation fails, the font last printed to the terminal or @@ -1375,13 +1376,13 @@ A common problem is the lack of features for some \OpenType fonts even when specified. % This can be related to the fact that some fonts do not provide features -for the \verb|dflt| script (see above on page \pageref{script-tag}), +for the \inlinecode {dflt} script (see above on page \pageref{script-tag}), which is the default one in this package. % If this happens, assigning a noth script when the font is defined should fix it. % -For example with \verb|latn|: +For example with \inlinecode {latn}: \beginlisting \font\test=file:MyFont.otf:script=latn;+liga; -- cgit v1.2.3 From 07d7f65c89e51d356145560dc6acfaded011398e Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Wed, 26 Feb 2014 07:08:04 +0100 Subject: [doc] move description and figure environment to more abstract macros --- doc/luaotfload-latex.tex | 29 +++- doc/luaotfload-main.tex | 407 ++++++++++++++++++++++++----------------------- 2 files changed, 228 insertions(+), 208 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 58c8793..0e86b83 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -248,9 +248,10 @@ } } -\definelist [definitions]{\normalitem {\fileent {\first}}} -\definelist [filelist]{\normalitem {\fileent {\first}}\space--\hskip 1em} -\definelist [functionlist]{\normalitem {\luafunction {\first}}\hfill\break} +\definelist [descriptions]{\normalitem {\textbf \first}\hfill\break} +\definelist [definitions]{\normalitem {\fileent {\first}}} +\definelist [filelist]{\normalitem {\fileent {\first}}\space--\hskip 1em} +\definelist [functionlist]{\normalitem {\luafunction {\first}}\hfill\break} \def \beginenumeration {\begin {enumerate}} \def \endenumeration {\end {enumerate}} @@ -293,9 +294,11 @@ %% figure floats %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\def \beginsyntaxfloat #1{%% the request syntax diagram +%% syntax definition +\def \beginsyntaxfloat #1#2{%% #1:label #2:caption \begin {figure} [b] - \def \syntaxcaption {#1}% + \edef \syntaxlabel {#1}% + \def \syntaxcaption {#2}% \setlength\grammarparsep{12pt plus 2pt minus 2pt}% \setlength\grammarindent{5cm}% \begingroup @@ -307,10 +310,24 @@ \end {grammar} \endgroup \caption \syntaxcaption - \label{font-syntax} + \label \syntaxlabel \end {figure} } +%% figures, e.g. the file graph +\def \beginfigurefloat #1#2{%% #1:label #2:caption + \begingroup + \begin {figure} [b] + \edef \figurelabel {#1}% + \caption {#2}% +} + +\def \endfigurefloat {% + \label \figurelabel + \end {figure} + \endgroup +} + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% hyperlinks %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index c7a7297..7a5526a 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -144,6 +144,7 @@ A selection of individual parts of the syntax are discussed below; for a more formal description see figure \ref{font-syntax}. \beginsyntaxfloat + {font-syntax} {Font request syntax. Braces or double quotes around the \emphasis{specification} rule will @@ -509,210 +510,212 @@ obviously, |random|. \font\librmsaltfirst=LatinModernRoman:salt=1 \endlisting -\noindent Other font options include: - -\begin{description} - -\item [mode] \hfill \\ - \identifier{luaotfload} has two \OpenType processing - \emphasis{modes}: - \identifier{base} and \identifier{node}. - - \identifier{base} mode works by mapping \OpenType - features to traditional \TEX ligature and kerning mechanisms. - % - Supporting only non-contextual substitutions and kerning - pairs, it is the slightly faster, albeit somewhat limited, variant. - % - \identifier{node} mode works by processing \TeX’s internal - node list directly at the \LUA end and supports - a wider range of \OpenType features. - % - The downside is that the intricate operations required for - \identifier{node} mode may slow down typesetting especially - with complex fonts and it does not work in math mode. - - By default \identifier{luaotfload} is in \identifier{node} - mode, and \identifier{base} mode has to be requested where needed, - e.~g. for math fonts. - -\item [script] \label{script-tag} \hfill \\ - An \OpenType script tag;\footnote{% - See \hyperlink {http://www.microsoft.com/typography/otspec/scripttags.htm} - for a list of valid values. +\beginsubsection {Basic font features} + +\begindescriptions + + \altitem {mode} + \identifier{luaotfload} has two \OpenType processing + \emphasis{modes}: + \identifier{base} and \identifier{node}. + + \identifier{base} mode works by mapping \OpenType + features to traditional \TEX ligature and kerning mechanisms. + % + Supporting only non-contextual substitutions and kerning + pairs, it is the slightly faster, albeit somewhat limited, variant. + % + \identifier{node} mode works by processing \TeX’s internal + node list directly at the \LUA end and supports + a wider range of \OpenType features. + % + The downside is that the intricate operations required for + \identifier{node} mode may slow down typesetting especially + with complex fonts and it does not work in math mode. + + By default \identifier{luaotfload} is in \identifier{node} + mode, and \identifier{base} mode has to be requested where needed, + e.~g. for math fonts. + + \altitem {script} \label{script-tag} + An \OpenType script tag;\footnote{% + See \hyperlink {http://www.microsoft.com/typography/otspec/scripttags.htm} + for a list of valid values. + % + For scripts derived from the Latin alphabet the value + |latn| is good choice. + } + the default value is |dlft|. + % + Some fonts, including very popular ones by foundries like Adobe, + do not assign features to the |dflt| script, in + which case the script needs to be set explicitly. + + \altitem {language} + An \OpenType language system identifier,\footnote{% + Cf. \hyperlink {http://www.microsoft.com/typography/otspec/languagetags.htm}. + } + defaulting to |dflt|. + + \altitem {featurefile} + A comma-separated list of feature files to be applied to the + font. + % + Feature files contain a textual representation of + \OpenType tables and extend the features of a font + on fly. + % + After they are applied to a font, features defined in a + feature file can be enabled or disabled just like any + other font feature. + % + The syntax is documented in \identifier{Adobe}’s + \OpenType Feature File Specification.\footnote{% + Cf. \hyperlink {http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. + Feature file support is part of the engine which at the + time of this writing (2014) implements the spec only + partially. + See the + \hyperlink [\LUATEX tracker]{http://tracker.luatex.org/view.php?id=231} + for details. + } + + For a demonstration of how to set a |tkrn| feature consult + the file |tkrn.fea| that is part of \identifier{luaotfload}. + It can be read and applied as follows: + + |\font\test=Latin Modern Roman:featurefile=tkrn.fea;+tkrn| + + \altitem {color} + A font color, defined as a triplet of two-digit hexadecimal + \abbrev{rgb} values, with an optional fourth value for + transparency + (where |00| is completely transparent and |FF| is opaque). + + For example, in order to set text in semitransparent red: + + \beginlisting +\font\test={Latin Modern Roman}:color=FF0000BB + \endlisting + + \altitem {kernfactor \& letterspace} + Define a font with letterspacing (tracking) enabled. + % + In \identifier{luaotfload}, letterspacing is implemented by + inserting additional kerning between glyphs. + + This approach is derived from and still quite similar to the + \emphasis{character kerning} (\texmacro{setcharacterkerning} / + \texmacro{definecharacterkerning} \& al.) functionality of + Context, see the file \fileent{typo-krn.lua} there. + % + The main difference is that \identifier{luaotfload} does not + use \LUATEX attributes to assign letterspacing to regions, + but defines virtual letterspaced versions of a font. + + The option \identifier{kernfactor} accepts a numeric value that + determines the letterspacing factor to be applied to the font + size. + % + E.~g. a kern factor of $0.42$ applied to a $10$ pt font + results in $4.2$ pt of additional kerning applied to each + pair of glyphs. + % + Ligatures are split into their component glyphs unless + explicitly ignored (see below). + + For compatibility with \XETEX an alternative + \identifier{letterspace} option is supplied that interprets the + supplied value as a \emphasis{percentage} of the font size but + is otherwise identical to \identifier{kernfactor}. + % + Consequently, both definitions in below snippet yield the same + letterspacing width: + + \beginlisting +\font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" +\font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" + \endlisting + + Specific pairs of letters and ligatures may be exempt from + letterspacing by defining the \LUA functions + \luafunction{keeptogether} and \luafunction{keepligature}, + respectively, inside the namespace \inlinecode {luaotfload.letterspace}. % - For scripts derived from the Latin alphabet the value - |latn| is good choice. - } - the default value is |dlft|. - % - Some fonts, including very popular ones by foundries like Adobe, - do not assign features to the |dflt| script, in - which case the script needs to be set explicitly. - -\item [language] \hfill \\ - An \OpenType language system identifier,\footnote{% - Cf. \hyperlink {http://www.microsoft.com/typography/otspec/languagetags.htm}. - } - defaulting to |dflt|. - -\item [featurefile] \hfill \\ - A comma-separated list of feature files to be applied to the - font. - % - Feature files contain a textual representation of - \OpenType tables and extend the features of a font - on fly. - % - After they are applied to a font, features defined in a - feature file can be enabled or disabled just like any - other font feature. - % - The syntax is documented in \identifier{Adobe}’s - \OpenType Feature File Specification.\footnote{% - Cf. \hyperlink {http://www.adobe.com/devnet/opentype/afdko/topic_feature_file_syntax.html}. - Feature file support is part of the engine which at the - time of this writing (2014) implements the spec only - partially. - See the - \hyperlink [\LUATEX tracker]{http://tracker.luatex.org/view.php?id=231} - for details. - } - - For a demonstration of how to set a |tkrn| feature consult - the file |tkrn.fea| that is part of \identifier{luaotfload}. - It can be read and applied as follows: - - |\font\test=Latin Modern Roman:featurefile=tkrn.fea;+tkrn| - -\item [color] \hfill \\ - A font color, defined as a triplet of two-digit hexadecimal - \abbrev{rgb} values, with an optional fourth value for - transparency - (where |00| is completely transparent and |FF| is opaque). - - For example, in order to set text in semitransparent red: - - \beginlisting - \font\test={Latin Modern Roman}:color=FF0000BB - \endlisting - -\item [kernfactor \& letterspace] \hfill \\ - Define a font with letterspacing (tracking) enabled. - % - In \identifier{luaotfload}, letterspacing is implemented by - inserting additional kerning between glyphs. - - This approach is derived from and still quite similar to the - \emphasis{character kerning} (\texmacro{setcharacterkerning} / - \texmacro{definecharacterkerning} \& al.) functionality of - Context, see the file \fileent{typo-krn.lua} there. - % - The main difference is that \identifier{luaotfload} does not - use \LUATEX attributes to assign letterspacing to regions, - but defines virtual letterspaced versions of a font. - - The option \identifier{kernfactor} accepts a numeric value that - determines the letterspacing factor to be applied to the font - size. - % - E.~g. a kern factor of $0.42$ applied to a $10$ pt font - results in $4.2$ pt of additional kerning applied to each - pair of glyphs. - % - Ligatures are split into their component glyphs unless - explicitly ignored (see below). - - For compatibility with \XETEX an alternative - \identifier{letterspace} option is supplied that interprets the - supplied value as a \emphasis{percentage} of the font size but - is otherwise identical to \identifier{kernfactor}. - % - Consequently, both definitions in below snippet yield the same - letterspacing width: - - \beginlisting - \font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" - \font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" - \endlisting - - Specific pairs of letters and ligatures may be exempt from - letterspacing by defining the \LUA functions - \luafunction{keeptogether} and \luafunction{keepligature}, - respectively, inside the namespace \inlinecode {luaotfload.letterspace}. - % - Both functions are called whenever the letterspacing callback - encounters an appropriate node or set of nodes. - % - If they return a true-ish value, no extra kern is inserted at - the current position. - % - \luafunction{keeptogether} receives a pair of consecutive - glyph nodes in order of their appearance in the node list. - % - \luafunction{keepligature} receives a single node which can be - analyzed into components. - % - (For details refer to the \emphasis{glyph nodes} section in the - \LUATEX reference manual.) - % - The implementation of both functions is left entirely to the - user. - - -\item [protrusion \& expansion] \hfill \\ - These keys control microtypographic features of the font, - namely \emphasis{character protrusion} and \emphasis{font - expansion}. - % - Their arguments are names of \LUA tables that contain - values for the respective features.\footnote{% - For examples of the table layout please refer to the - section of the file \fileent{luaotfload-fonts-ext.lua} where the - default values are defined. - % - Alternatively and with loss of information, you can dump - those tables into your terminal by issuing - \beginlisting - \directlua{inspect(fonts.protrusions.setups.default) - inspect(fonts.expansions.setups.default)} - \endlisting - at some point after loading \fileent{luaotfload.sty}. - } - % - For both, only the set \identifier{default} is predefined. - - For example, to define a font with the default - protrusion vector applied\footnote{% - You also need to set - \inlinecode {pdfprotrudechars=2} and - \inlinecode {pdfadjustspacing=2} - to activate protrusion and expansion, respectively. - See the - \hyperlink [\PDFTEX manual]{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% - for details. - }: - - \beginlisting - \font\test=LatinModernRoman:protrusion=default - \endlisting -\end{description} - -\paragraph{Non-standard font features} + Both functions are called whenever the letterspacing callback + encounters an appropriate node or set of nodes. + % + If they return a true-ish value, no extra kern is inserted at + the current position. + % + \luafunction{keeptogether} receives a pair of consecutive + glyph nodes in order of their appearance in the node list. + % + \luafunction{keepligature} receives a single node which can be + analyzed into components. + % + (For details refer to the \emphasis{glyph nodes} section in the + \LUATEX reference manual.) + % + The implementation of both functions is left entirely to the + user. + + + \altitem {protrusion \& expansion} + These keys control microtypographic features of the font, + namely \emphasis{character protrusion} and \emphasis{font + expansion}. + % + Their arguments are names of \LUA tables that contain + values for the respective features.\footnote{% + For examples of the table layout please refer to the + section of the file \fileent{luaotfload-fonts-ext.lua} where the + default values are defined. + % + Alternatively and with loss of information, you can dump + those tables into your terminal by issuing + \beginlisting +\directlua{inspect(fonts.protrusions.setups.default) + inspect(fonts.expansions.setups.default)} + \endlisting + at some point after loading \fileent{luaotfload.sty}. + } + % + For both, only the set \identifier{default} is predefined. + + For example, to define a font with the default + protrusion vector applied\footnote{% + You also need to set + \inlinecode {pdfprotrudechars=2} and + \inlinecode {pdfadjustspacing=2} + to activate protrusion and expansion, respectively. + See the + \hyperlink [\PDFTEX manual]{http://mirrors.ctan.org/systems/pdftex/manual/pdftex-a.pdf}% + for details. + }: + + \beginlisting +\font\test=LatinModernRoman:protrusion=default + \endlisting +\enddescriptions + +\endsubsection + +\beginsubsection {Non-standard font features} \identifier{luaotfload} adds a number of features that are not defined in the original \OpenType specification, most of them aiming at emulating the behavior familiar from other \TEX engines. % Currently (2014) there are three of them: -\begin{description} +\begindescriptions - \item [anum] + \altitem {anum} Substitutes the glyphs in the \abbrev{ascii} number range with their counterparts from eastern Arabic or Persian, depending on the value of \identifier{language}. - \item [tlig] + \altitem {tlig} Applies legacy \TEX ligatures: \begin{tabular}{rlrl} @@ -732,12 +735,12 @@ Currently (2014) there are three of them: remapping feature. } - \item [itlc] + \altitem {itlc} Computes italic correction values (active by default). -\end{description} - +\enddescriptions +\endsubsection \endsection %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -1138,11 +1141,11 @@ files not contained in the merge. Some of these have no equivalent in \altitem {luaotfload-letterspace.lua} font-based letterspacing. \endfilelist -\begin{figure}[b] - \caption{Schematic of the files in \identifier{Luaotfload}} +\beginfigurefloat + {file-graph} + {Schematic of the files in \identifier{Luaotfload}} \includegraphics[width=\textwidth]{filegraph.pdf} - \label{file-graph} -\end{figure} +\endfigurefloat \endsection @@ -1308,14 +1311,14 @@ are defined for which scripts. %% not implemented, may come back later % \beginsubsubsection{Database} -% +% % \beginfunctionlist % \altitem {aux.scan_external_dir(dir : string)} % Include fonts in directory \luafunction{dir} in font lookups without % adding them to the database. -% +% % \endfunctionlist -% +% % \endsubsubsection \endsubsection -- cgit v1.2.3 From 1c0ee1f4368f57f820392b8b5398c0503215656d Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 3 Mar 2014 07:57:00 +0100 Subject: [doc] conver GPL in manual to abstract macros --- doc/luaotfload-main.tex | 534 ++++++++++++++++++++++++------------------------ 1 file changed, 265 insertions(+), 269 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 7a5526a..4c848bf 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -1464,28 +1464,28 @@ You might want to zoom in. \columnsep=3\columnsep \begintriplecolumns \begincentered - {\Large GNU GENERAL PUBLIC LICENSE\par} + {\Largefont{GNU GENERAL PUBLIC LICENSE}\par} \bigskip {Version 2, June 1991} - {\parindent 0in + \begingroup + \parindent 0in - Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. + Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. - \bigskip + \bigskip - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - \bigskip + \bigskip - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - } + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + \endgroup {\bf\large Preamble} \endcentered - The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software---to @@ -1533,266 +1533,262 @@ The precise terms and conditions for copying, distribution and modification follow. \begincentered - {\Large \sc Terms and Conditions For Copying, Distribution and - Modification} + %% so … these aren’t actual headings‽ + \Largefont{\smallcaps{% + Terms and Conditions For Copying, Distribution and Modification + }} \endcentered \beginenumeration -\item -This License applies to any program or other work which contains a notice -placed by the copyright holder saying it may be distributed under the -terms of this General Public License. The ``Program'', below, refers to -any such program or work, and a ``work based on the Program'' means either -the Program or any derivative work under copyright law: that is to say, a -work containing the Program or a portion of it, either verbatim or with -modifications and/or translated into another language. (Hereinafter, -translation is included without limitation in the term ``modification''.) -Each licensee is addressed as ``you''. - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. +\item This License applies to any program or other work which contains + a notice placed by the copyright holder saying it may be + distributed under the terms of this General Public License. The + ``Program'', below, refers to any such program or work, and a + ``work based on the Program'' means either the Program or any + derivative work under copyright law: that is to say, a work + containing the Program or a portion of it, either verbatim or + with modifications and/or translated into another language. + (Hereinafter, translation is included without limitation in the + term ``modification''.) Each licensee is addressed as ``you''. + + Activities other than copying, distribution and modification are + not covered by this License; they are outside its scope. The act + of running the Program is not restricted, and the output from the + Program is covered only if its contents constitute a work based + on the Program (independent of having been made by running the + Program). Whether that is true depends on what the Program does. \item You may copy and distribute verbatim copies of the Program's source - code as you receive it, in any medium, provided that you conspicuously - and appropriately publish on each copy an appropriate copyright notice - and disclaimer of warranty; keep intact all the notices that refer to - this License and to the absence of any warranty; and give any other - recipients of the Program a copy of this License along with the Program. - -You may charge a fee for the physical act of transferring a copy, and you -may at your option offer warranty protection in exchange for a fee. - -\item -You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - -\beginenumeration - -\item -You must cause the modified files to carry prominent notices stating that -you changed the files and the date of any change. - -\item -You must cause any work that you distribute or publish, that in -whole or in part contains or is derived from the Program or any -part thereof, to be licensed as a whole at no charge to all third -parties under the terms of this License. - -\item -If the modified program normally reads commands interactively -when run, you must cause it, when started running for such -interactive use in the most ordinary way, to print or display an -announcement including an appropriate copyright notice and a -notice that there is no warranty (or else, saying that you provide -a warranty) and that users may redistribute the program under -these conditions, and telling the user how to view a copy of this -License. (Exception: if the Program itself is interactive but -does not normally print such an announcement, your work based on -the Program is not required to print an announcement.) - -\endenumeration - - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - -\item -You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - -\beginenumeration - -\item - -Accompany it with the complete corresponding machine-readable -source code, which must be distributed under the terms of Sections -1 and 2 above on a medium customarily used for software interchange; or, - -\item - -Accompany it with a written offer, valid for at least three -years, to give any third party, for a charge no more than your -cost of physically performing source distribution, a complete -machine-readable copy of the corresponding source code, to be -distributed under the terms of Sections 1 and 2 above on a medium -customarily used for software interchange; or, - -\item - -Accompany it with the information you received as to the offer -to distribute corresponding source code. (This alternative is -allowed only for noncommercial distribution and only if you -received the program in object code or executable form with such -an offer, in accord with Subsection b above.) - -\endenumeration - - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - -\item -You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - -\item -You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - -\item -Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - -\item -If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - -\item -If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - -\item -The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and ``any -later version'', you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - -\item -If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. + code as you receive it, in any medium, provided that you + conspicuously and appropriately publish on each copy an + appropriate copyright notice and disclaimer of warranty; keep + intact all the notices that refer to this License and to the + absence of any warranty; and give any other recipients of the + Program a copy of this License along with the Program. + + You may charge a fee for the physical act of transferring a copy, + and you may at your option offer warranty protection in exchange + for a fee. + +\item You may modify your copy or copies of the Program or any portion + of it, thus forming a work based on the Program, and copy and + distribute such modifications or work under the terms of Section + 1 above, provided that you also meet all of these conditions: + + \beginenumeration + + \item You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + \item You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + \item If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you + provide a warranty) and that users may redistribute the program + under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is + interactive but does not normally print such an announcement, + your work based on the Program is not required to print an + announcement.) + + \endenumeration + + + These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the + Program, and can be reasonably considered independent and + separate works in themselves, then this License, and its terms, + do not apply to those sections when you distribute them as + separate works. But when you distribute the same sections as + part of a whole which is a work based on the Program, the + distribution of the whole must be on the terms of this License, + whose permissions for other licensees extend to the entire whole, + and thus to each and every part regardless of who wrote it. + + Thus, it is not the intent of this section to claim rights or + contest your rights to work written entirely by you; rather, the + intent is to exercise the right to control the distribution of + derivative or collective works based on the Program. + + In addition, mere aggregation of another work not based on the + Program with the Program (or with a work based on the Program) on + a volume of a storage or distribution medium does not bring the + other work under the scope of this License. + +\item You may copy and distribute the Program (or a work based on it, + under Section 2) in object code or executable form under the + terms of Sections 1 and 2 above provided that you also do one of + the following: + + \beginenumeration + + \item Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Sections 1 and 2 above on a medium customarily used for software + interchange; or, + + \item Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + \item Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + + \endenumeration + + + The source code for a work means the preferred form of the work + for making modifications to it. For an executable work, complete + source code means all the source code for all modules it + contains, plus any associated interface definition files, plus + the scripts used to control compilation and installation of the + executable. However, as a special exception, the source code + distributed need not include anything that is normally + distributed (in either source or binary form) with the major + components (compiler, kernel, and so on) of the operating system + on which the executable runs, unless that component itself + accompanies the executable. + + If distribution of executable or object code is made by offering + access to copy from a designated place, then offering equivalent + access to copy the source code from the same place counts as + distribution of the source code, even though third parties are + not compelled to copy the source along with the object code. + +\item You may not copy, modify, sublicense, or distribute the Program + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense or distribute the Program + is void, and will automatically terminate your rights under this + License. However, parties who have received copies, or rights, + from you under this License will not have their licenses + terminated so long as such parties remain in full compliance. + +\item You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to modify + or distribute the Program or its derivative works. These actions + are prohibited by law if you do not accept this License. + Therefore, by modifying or distributing the Program (or any work + based on the Program), you indicate your acceptance of this + License to do so, and all its terms and conditions for copying, + distributing or modifying the Program or works based on it. + +\item Each time you redistribute the Program (or any work based on the + Program), the recipient automatically receives a license from the + original licensor to copy, distribute or modify the Program + subject to these terms and conditions. You may not impose any + further restrictions on the recipients' exercise of the rights + granted herein. You are not responsible for enforcing compliance + by third parties to this License. + +\item If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent + issues), conditions are imposed on you (whether by court order, + agreement or otherwise) that contradict the conditions of this + License, they do not excuse you from the conditions of this + License. If you cannot distribute so as to satisfy + simultaneously your obligations under this License and any other + pertinent obligations, then as a consequence you may not + distribute the Program at all. For example, if a patent license + would not permit royalty-free redistribution of the Program by + all those who receive copies directly or indirectly through you, + then the only way you could satisfy both it and this License + would be to refrain entirely from distribution of the Program. + + If any portion of this section is held invalid or unenforceable + under any particular circumstance, the balance of the section is + intended to apply and the section as a whole is intended to apply + in other circumstances. + + It is not the purpose of this section to induce you to infringe + any patents or other property right claims or to contest validity + of any such claims; this section has the sole purpose of + protecting the integrity of the free software distribution + system, which is implemented by public license practices. Many + people have made generous contributions to the wide range of + software distributed through that system in reliance on + consistent application of that system; it is up to the + author/donor to decide if he or she is willing to distribute + software through any other system and a licensee cannot impose + that choice. + + This section is intended to make thoroughly clear what is + believed to be a consequence of the rest of this License. + +\item If the distribution and/or use of the Program is restricted in + certain countries either by patents or by copyrighted interfaces, + the original copyright holder who places the Program under this + License may add an explicit geographical distribution limitation + excluding those countries, so that distribution is permitted only + in or among countries not thus excluded. In such case, this + License incorporates the limitation as if written in the body of + this License. + +\item The Free Software Foundation may publish revised and/or new + versions of the General Public License from time to time. Such + new versions will be similar in spirit to the present version, + but may differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the + Program specifies a version number of this License which applies + to it and ``any later version'', you have the option of following + the terms and conditions either of that version or of any later + version published by the Free Software Foundation. If the + Program does not specify a version number of this License, you + may choose any version ever published by the Free Software + Foundation. + +\item If you wish to incorporate parts of the Program into other free + programs whose distribution conditions are different, write to + the author to ask for permission. For software which is + copyrighted by the Free Software Foundation, write to the Free + Software Foundation; we sometimes make exceptions for this. Our + decision will be guided by the two goals of preserving the free + status of all derivatives of our free software and of promoting + the sharing and reuse of software generally. \begincentered - {\Large\sc No Warranty} + \Largefont{\smallcaps{No Warranty}} \endcentered -\item -{\sc Because the program is licensed free of charge, there is no warranty -for the program, to the extent permitted by applicable law. Except when -otherwise stated in writing the copyright holders and/or other parties -provide the program ``as is'' without warranty of any kind, either expressed -or implied, including, but not limited to, the implied warranties of -merchantability and fitness for a particular purpose. The entire risk as -to the quality and performance of the program is with you. Should the -program prove defective, you assume the cost of all necessary servicing, -repair or correction.} - -\item -{\sc In no event unless required by applicable law or agreed to in writing -will any copyright holder, or any other party who may modify and/or -redistribute the program as permitted above, be liable to you for damages, -including any general, special, incidental or consequential damages arising -out of the use or inability to use the program (including but not limited -to loss of data or data being rendered inaccurate or losses sustained by -you or third parties or a failure of the program to operate with any other -programs), even if such holder or other party has been advised of the -possibility of such damages.} +\item \smallcaps{Because the program is licensed free of charge, there + is no warranty for the program, to the extent permitted by + applicable law. Except when otherwise stated in writing the + copyright holders and/or other parties provide the program ``as + is'' without warranty of any kind, either expressed or implied, + including, but not limited to, the implied warranties of + merchantability and fitness for a particular purpose. The entire + risk as to the quality and performance of the program is with + you. Should the program prove defective, you assume the cost of + all necessary servicing, repair or correction.} + +\item \smallcaps{In no event unless required by applicable law or + agreed to in writing will any copyright holder, or any other + party who may modify and/or redistribute the program as permitted + above, be liable to you for damages, including any general, + special, incidental or consequential damages arising out of the + use or inability to use the program (including but not limited to + loss of data or data being rendered inaccurate or losses + sustained by you or third parties or a failure of the program to + operate with any other programs), even if such holder or other + party has been advised of the possibility of such damages.} \endenumeration \begincentered - {\Large\sc End of Terms and Conditions} + \Largefont{\smallcaps{End of Terms and Conditions}} \endcentered @@ -1807,10 +1803,10 @@ possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. - To do so, attach the following notices to the program. It is safest to - attach them to the start of each source file to most effectively convey - the exclusion of warranty; and each file should have at least the - ``copyright'' line and a pointer to where the full notice is found. +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +``copyright'' line and a pointer to where the full notice is found. \beginnarrower one line to give the program's name and a brief idea of what it does. \\ @@ -1844,22 +1840,22 @@ when it starts in an interactive mode: \endnarrower -The hypothetical commands {\tt show w} and {\tt show c} should show the -appropriate parts of the General Public License. Of course, the commands -you use may be called something other than {\tt show w} and {\tt show c}; -they could even be mouse-clicks or menu items---whatever suits your -program. +The hypothetical commands \proportional{show w} and \proportional{show +c} should show the appropriate parts of the General Public License. Of +course, the commands you use may be called something other than +\proportional{show w} and \proportional{show c}; they could even be +mouse-clicks or menu items---whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a ``copyright disclaimer'' for the program, if necessary. Here is a sample; alter the names: \beginnarrower -Yoyodyne, Inc., hereby disclaims all copyright interest in the program \\ -`Gnomovision' (which makes passes at compilers) written by James Hacker. \\ + Yoyodyne, Inc., hereby disclaims all copyright interest in the program \\ + `Gnomovision' (which makes passes at compilers) written by James Hacker. \\ -signature of Ty Coon, 1 April 1989 \\ -Ty Coon, President of Vice + signature of Ty Coon, 1 April 1989 \\ + Ty Coon, President of Vice \endnarrower -- cgit v1.2.3 From 959794804e53aaea76298cba35ccb6c3f347fb1c Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Tue, 4 Mar 2014 06:45:57 +0100 Subject: [doc] move table floats and inline code snippets to new macros --- doc/luaotfload-latex.tex | 43 ++++++++++++++++--- doc/luaotfload-main.tex | 108 +++++++++++++++++++++++------------------------ 2 files changed, 88 insertions(+), 63 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 0e86b83..e0afe45 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -89,12 +89,16 @@ \def\restoreunderscore{\catcode`\_=12\relax} -\definehighlight [fileent][\ttfamily\restoreunderscore] %% files, dirs -\definehighlight [texmacro][\sffamily\itshape\textbackslash] %% cs -\definehighlight[luafunction][\sffamily\itshape\restoreunderscore] %% lua identifiers -\definehighlight [identifier][\sffamily] %% names -\definehighlight [abbrev][\rmfamily\scshape] %% acronyms -\definehighlight [emphasis][\rmfamily\slshape] %% level 1 emph +\definehighlight [fileent][\ttfamily\restoreunderscore] %% files, dirs +\definehighlight [texmacro][\sffamily\itshape\textbackslash] %% cs +\definehighlight [luafunction][\sffamily\itshape\restoreunderscore] %% lua identifiers +\definehighlight [identifier][\sffamily] %% names +\definehighlight [abbrev][\rmfamily\scshape] %% acronyms +\definehighlight [emphasis][\rmfamily\slshape] %% level 1 emph + +\definehighlight [Largefont][\Large] %% font size +\definehighlight [smallcaps][\sc] %% font feature +\definehighlight [proportional][\tt] %% font switch \newcommand*\email[1]{\href{mailto:#1}{#1}} @@ -291,7 +295,7 @@ \let \typesetcontent \tableofcontent %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% figure floats +%% floats %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% syntax definition @@ -328,6 +332,24 @@ \endgroup } +%% tables + +\def \begintablefloat #1#2{%% #1:label #2:caption + \begingroup + \begin {table} [t] + \hrule + \edef \floatlabel {#1}% + \caption {#2}% +} + +\def \endtablefloat {% + \label \floatlabel + \hrule + \end {table} + \endgroup +} + + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% hyperlinks %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -347,6 +369,13 @@ } +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% escaped characters +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\let \charpercent \textpercent +\let \charbackslash \textbackslash + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% main %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 4c848bf..002b1bb 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -127,10 +127,10 @@ in the task and willingness to respond to our suggestions. \identifier{luaotfload} supports an extended font request syntax: \beginnarrower - |\font\foo={|% - \meta{prefix}|:|% - \meta{font name}|:|% - \meta{font features}|}|% + \inlinecode{\\font\\foo=\{}% + \meta{prefix}\inlinecode{:}% + \meta{font name}\inlinecode{:}% + \meta{font features}\inlinecode{\}}% \meta{\TEX font features} \endnarrower @@ -210,7 +210,7 @@ In \identifier{luaotfload}, the canonical syntax for font requests requires a \emphasis{prefix}: % \beginnarrower - |\font\fontname=|\meta{prefix}|:|\meta{fontname}\dots + \inlinecode{\\font\\fontname=}\meta{prefix}\inlinecode{:}\meta{fontname}\dots \endnarrower % where \meta{prefix} is either \inlinecode{file:} or \inlinecode {name:}.\footnote{% @@ -305,7 +305,7 @@ There are again two modes: bracketed and unbracketed. A bracketed request looks as follows. \beginnarrower - |\font\fontname=[|\meta{path to file}|]| + \inlinecode{\\font\\fontname=[}\meta{path to file}\inlinecode{]} \endnarrower \noindent @@ -316,7 +316,7 @@ Naturally, path-less file names are equally valid and processed the same way as an ordinary \inlinecode {file:} lookup. \beginnarrower - |\font\fontname=|\meta{font name} \dots + \inlinecode{\\font\\fontname=}\meta{font name} \dots \endnarrower Unbracketed (or, for lack of a better word: \emphasis{anonymous}) @@ -334,7 +334,7 @@ Furthermore, \identifier{luaotfload} supports the slashed (shorthand) font style notation from \XETEX. \beginnarrower - |\font\fontname=|\meta{font name}|/|\meta{modifier}\dots + \inlinecode{\\font\\fontname=}\meta{font name}\inlinecode{/}\meta{modifier}\dots \endnarrower \noindent @@ -423,7 +423,7 @@ is installed in some location accessible by \identifier{luaotfload}, the regular shape can be loaded as follows: \beginlisting - \font\iwona=Iwona at 20pt + \font \iwona = Iwona at 20pt \endlisting \noindent @@ -431,18 +431,18 @@ To load the most common of the other styles, the slash notation can be employed as shorthand: \beginlisting - \font\iwonaitalic =Iwona/I at 20pt - \font\iwonabold =Iwona/B at 20pt - \font\iwonabolditalic=Iwona/BI at 20pt + \font \iwonaitalic = Iwona/I at 20pt + \font \iwonabold = Iwona/B at 20pt + \font \iwonabolditalic = Iwona/BI at 20pt \endlisting \noindent which is equivalent to these full names: \beginlisting - \font\iwonaitalic ="Iwona Italic" at 20pt - \font\iwonabold ="Iwona Bold" at 20pt - \font\iwonabolditalic="Iwona BoldItalic" at 20pt + \font \iwonaitalic = "Iwona Italic" at 20pt + \font \iwonabold = "Iwona Bold" at 20pt + \font \iwonabolditalic = "Iwona BoldItalic" at 20pt \endlisting \endsubsubsection @@ -457,10 +457,10 @@ which is equivalent to these full names: general scheme for font requests: \beginnarrower - |\font\foo={|% - \meta{prefix}|:|% - \meta{font name}|:|% - \meta{font features}|}|% + \inlinecode{\\font\\foo=\{}% + \meta{prefix}\inlinecode{:}% + \meta{font name}\inlinecode{:}% + \meta{font features}\inlinecode{\}}% \meta{\TEX font features} \endnarrower @@ -474,40 +474,40 @@ tags\footnote{% } and font options. % -Prepending a font feature with a |+| (plus sign) enables it, whereas -a |-| (minus) disables it. For instance, the request +Prepending a font feature with a \inlinecode{+} (plus sign) enables it, +whereas a \inlinecode{-} (minus) disables it. For instance, the request \beginlisting - \font\test=LatinModernRoman:+clig;-kern + \font \test = LatinModernRoman:+clig;-kern \endlisting -\noindent activates contextual ligatures (|clig|) and disables -kerning (|kern|). +\noindent activates contextual ligatures (\inlinecode{clig}) and +disables kerning (\inlinecode{kern}). % -Alternatively the options |true| or |false| can be passed to -the feature in a key/value expression. +Alternatively the options \inlinecode{true} or \inlinecode{false} can +be passed to the feature in a key/value expression. % The following request has the same meaning as the last one: \beginlisting - \font\test=LatinModernRoman:clig=true;kern=false + \font \test = LatinModernRoman:clig=true;kern=false \endlisting \noindent Furthermore, this second syntax is required should a font feature accept other options besides a true/false switch. % -For example, \emphasis{stylistic alternates} (|salt|) are variants of -given glyphs. +For example, \emphasis{stylistic alternates} (\inlinecode{salt}) are +variants of given glyphs. % They can be selected either explicitly by supplying the variant index (starting from one), or randomly by setting the value to, -obviously, |random|. +obviously, \inlinecode{random}. %% TODO verify that this actually works with a font that supports %% the salt/random feature!\fi \beginlisting - \font\librmsaltfirst=LatinModernRoman:salt=1 + \font \librmsaltfirst = LatinModernRoman:salt=1 \endlisting \beginsubsection {Basic font features} @@ -543,19 +543,19 @@ obviously, |random|. for a list of valid values. % For scripts derived from the Latin alphabet the value - |latn| is good choice. + \inlinecode{latn} is good choice. } - the default value is |dlft|. + the default value is \inlinecode{dlft}. % Some fonts, including very popular ones by foundries like Adobe, - do not assign features to the |dflt| script, in + do not assign features to the \inlinecode{dflt} script, in which case the script needs to be set explicitly. \altitem {language} An \OpenType language system identifier,\footnote{% Cf. \hyperlink {http://www.microsoft.com/typography/otspec/languagetags.htm}. } - defaulting to |dflt|. + defaulting to \inlinecode{dflt}. \altitem {featurefile} A comma-separated list of feature files to be applied to the @@ -580,22 +580,23 @@ obviously, |random|. for details. } - For a demonstration of how to set a |tkrn| feature consult - the file |tkrn.fea| that is part of \identifier{luaotfload}. + For a demonstration of how to set a \inlinecode{tkrn} feature consult + the file \inlinecode{tkrn.fea} that is part of \identifier{luaotfload}. It can be read and applied as follows: - |\font\test=Latin Modern Roman:featurefile=tkrn.fea;+tkrn| + \inlinecode{\\font \\test = Latin Modern Roman:featurefile=tkrn.fea;+tkrn} \altitem {color} A font color, defined as a triplet of two-digit hexadecimal \abbrev{rgb} values, with an optional fourth value for transparency - (where |00| is completely transparent and |FF| is opaque). + (where \inlinecode{00} is completely transparent and + \inlinecode{FF} is opaque). For example, in order to set text in semitransparent red: \beginlisting -\font\test={Latin Modern Roman}:color=FF0000BB +\font \test = "Latin Modern Roman:color=FF0000BB" \endlisting \altitem {kernfactor \& letterspace} @@ -633,8 +634,8 @@ obviously, |random|. letterspacing width: \beginlisting -\font\iwonakernedA="file:Iwona-Regular.otf:kernfactor=0.125" -\font\iwonakernedB="file:Iwona-Regular.otf:letterspace=12.5" +\font \iwonakernedA = "file:Iwona-Regular.otf:kernfactor=0.125" +\font \iwonakernedB = "file:Iwona-Regular.otf:letterspace=12.5" \endlisting Specific pairs of letters and ligatures may be exempt from @@ -695,7 +696,7 @@ obviously, |random|. }: \beginlisting -\font\test=LatinModernRoman:protrusion=default +\font \test = LatinModernRoman:protrusion=default \endlisting \enddescriptions @@ -849,14 +850,11 @@ Other paths can be specified by setting the environment variable If it is non-empty, then search will be extended to the included directories. -\begin{table}[t] - \hrule - \caption{List of paths searched for each supported operating - system.} - \renewcommand{\arraystretch}{1.2} +\begintablefloat {table-searchpaths} + {List of paths searched for each supported operating system.} \begincentered \begin{tabular}{lp{.5\textwidth}} - Windows & \inlinecode {\%WINDIR\%\\Fonts} + Windows & \inlinecode {\% WINDIR\%\\ Fonts} \\ Linux & \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break \fileent{/etc/fonts/fonts.conf} @@ -868,9 +866,7 @@ directories. \\ \end{tabular} \endcentered - \label{table-searchpaths} - \hrule -\end{table} +\endtablefloat \endsubsection @@ -957,7 +953,7 @@ plain filename should suffice. % File extensions (\fileent{.otf}, \fileent{.ttf}, etc.) may be omitted. % -Anything after a percent (|%|) character until the end of the line +Anything after a percent (\inlinecode {\%}) character until the end of the line is ignored, so use this to add comments. % Place this file to some location where the \identifier{kpse} @@ -973,7 +969,7 @@ or just leave it in the working directory of your document. \fileent{luaotfload-blacklist.cnf} it finds, so the fonts in \fileent{./luaotfload-blacklist.cnf} extend the global blacklist. -Furthermore, a filename prepended with a dash character (|-|) is +Furthermore, a filename prepended with a dash character (\inlinecode{-}) is removed from the blacklist, causing it to be temporarily whitelisted without modifying the global file. % @@ -1208,7 +1204,7 @@ writes an entire font object to the file \fileent{fontdump.lua}: "my_private_callbacks.dump_font" ) } - \font\dumpme=name:Iwona + \font \dumpme = name:Iwona \bye \endlisting @@ -1388,7 +1384,7 @@ fix it. For example with \inlinecode {latn}: \beginlisting - \font\test=file:MyFont.otf:script=latn;+liga; + \font \test = file:MyFont.otf:script=latn;+liga; \endlisting You can get a list of features that a font defines for scripts and -- cgit v1.2.3 From fba29372991e64a7ee36366988d2da59be03f728 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Wed, 5 Mar 2014 22:42:53 +0100 Subject: [doc] move tables to more abstract syntax --- doc/luaotfload-latex.tex | 24 ++++++++++++++++++++++++ doc/luaotfload-main.tex | 41 ++++++++++++++++++++++------------------- 2 files changed, 46 insertions(+), 19 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index e0afe45..80e741c 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -369,12 +369,36 @@ } +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% tables +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Our tables aren’t anything special so we stick with “tabular” on the +%% Latex end. +%% +%% This is going to be largely incompatible with Context since format +%% specifications work quite differently (even between different +%% Context table variants). + +\def \begintabulate [#1]#2\endtabulate{% + \begingroup + \let \beginrow = \relax %% -> \NC in Context + \let \newcell = & %% -> \NC + \let \endrow = \cr %% -> \NC \NR + \begin {tabular}{#1}% + #2 + \end {tabular} + \endgroup +} + +\let \endtabulate \relax + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% escaped characters %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \let \charpercent \textpercent \let \charbackslash \textbackslash +\let \chartilde \textasciitilde %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% main diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 002b1bb..32a97fe 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -719,13 +719,13 @@ Currently (2014) there are three of them: \altitem {tlig} Applies legacy \TEX ligatures: - \begin{tabular}{rlrl} - `` & \inlinecode {``} & '' & \inlinecode {''} \\ - ` & \inlinecode {`} & ' & \inlinecode {'} \\ - " & \inlinecode {"} & -- & \inlinecode {--} \\ - --- & \inlinecode {---} & !` & \inlinecode {!`} \\ - ?` & \inlinecode {?`} & & \\ - \end{tabular} + \begintabulate [rlrl] + \beginrow `` \newcell \inlinecode {``} \newcell '' \newcell \inlinecode {''} \endrow + \beginrow ` \newcell \inlinecode {`} \newcell ' \newcell \inlinecode {'} \endrow + \beginrow " \newcell \inlinecode {"} \newcell -- \newcell \inlinecode {--} \endrow + \beginrow --- \newcell \inlinecode {---} \newcell !` \newcell \inlinecode {!`} \endrow + \beginrow ?` \newcell \inlinecode {?`} \newcell \newcell \endrow + \endtabulate \footnote{% These contain the feature set \inlinecode {trep} of earlier @@ -853,18 +853,21 @@ directories. \begintablefloat {table-searchpaths} {List of paths searched for each supported operating system.} \begincentered - \begin{tabular}{lp{.5\textwidth}} - Windows & \inlinecode {\% WINDIR\%\\ Fonts} - \\ - Linux & \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break - \fileent{/etc/fonts/fonts.conf} - \\ - Mac & \fileent{\textasciitilde/Library/Fonts},\break - \fileent{/Library/Fonts},\break - \fileent{/System/Library/Fonts}, and\hfill\break - \fileent{/Network/Library/Fonts} - \\ - \end{tabular} + \begintabulate [lp{.5\textwidth}] + \beginrow + Windows \newcell \inlinecode {\% WINDIR\%\\ Fonts} + \endrow + \beginrow + Linux \newcell \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break + \fileent{/etc/fonts/fonts.conf} + \endrow + \beginrow + Mac \newcell \fileent{\textasciitilde/Library/Fonts},\break + \fileent{/Library/Fonts},\break + \fileent{/System/Library/Fonts}, and\hfill\break + \fileent{/Network/Library/Fonts} + \endrow + \endtabulate \endcentered \endtablefloat -- cgit v1.2.3 From 7ccc3a604d4856e00c2274512bbca85d015ace2f Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Fri, 7 Mar 2014 06:54:25 +0100 Subject: [doc] erase gpl from pdf --- doc/luaotfload-latex.tex | 6 - doc/luaotfload-main.tex | 429 ----------------------------------------------- 2 files changed, 435 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 80e741c..42799bf 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -257,9 +257,6 @@ \definelist [filelist]{\normalitem {\fileent {\first}}\space--\hskip 1em} \definelist [functionlist]{\normalitem {\luafunction {\first}}\hfill\break} -\def \beginenumeration {\begin {enumerate}} -\def \endenumeration {\end {enumerate}} - %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% columns %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -267,9 +264,6 @@ \def \begindoublecolumns {\begin {multicols} {2}} \def \enddoublecolumns {\end {multicols}} -\def \begintriplecolumns {\begin {multicols} {3}} -\def \endtriplecolumns {\end {multicols}} - %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% alignment %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 32a97fe..1613eaa 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -1445,434 +1445,5 @@ In this case, best define you own accessor: \endsubsection \endsection - -\clearpage -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\beginsection {The GNU GPL License v2} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -The GPL requires the complete license text to be distributed along -with the code. I recommend the canonical source, instead: -\hyperlink {http://www.gnu.org/licenses/old-licenses/gpl-2.0.html}. -But if you insist on an included copy, here it is. -You might want to zoom in. - -\newsavebox{\gpl} -\begin{lrbox}{\gpl} -\begin{minipage}{3\textwidth} -\columnsep=3\columnsep -\begintriplecolumns -\begincentered - {\Largefont{GNU GENERAL PUBLIC LICENSE}\par} - \bigskip - {Version 2, June 1991} - - \begingroup - \parindent 0in - - Copyright \textcopyright\ 1989, 1991 Free Software Foundation, Inc. - - \bigskip - - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - - \bigskip - - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - \endgroup - - {\bf\large Preamble} -\endcentered - -The licenses for most software are designed to take away your freedom to -share and change it. By contrast, the GNU General Public License is -intended to guarantee your freedom to share and change free software---to -make sure the software is free for all its users. This General Public -License applies to most of the Free Software Foundation's software and to -any other program whose authors commit to using it. (Some other Free -Software Foundation software is covered by the GNU Library General Public -License instead.) You can apply it to your programs, too. - -When we speak of free software, we are referring to freedom, not price. -Our General Public Licenses are designed to make sure that you have the -freedom to distribute copies of free software (and charge for this service -if you wish), that you receive source code or can get it if you want it, -that you can change the software or use pieces of it in new free programs; -and that you know you can do these things. - -To protect your rights, we need to make restrictions that forbid anyone to -deny you these rights or to ask you to surrender the rights. These -restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - -For example, if you distribute copies of such a program, whether gratis or -for a fee, you must give the recipients all the rights that you have. You -must make sure that they, too, receive or can get the source code. And -you must show them these terms so they know their rights. - -We protect your rights with two steps: (1) copyright the software, and (2) -offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - -Also, for each author's protection and ours, we want to make certain that -everyone understands that there is no warranty for this free software. If -the software is modified by someone else and passed on, we want its -recipients to know that what they have is not the original, so that any -problems introduced by others will not reflect on the original authors' -reputations. - -Finally, any free program is threatened constantly by software patents. -We wish to avoid the danger that redistributors of a free program will -individually obtain patent licenses, in effect making the program -proprietary. To prevent this, we have made it clear that any patent must -be licensed for everyone's free use or not licensed at all. - -The precise terms and conditions for copying, distribution and -modification follow. - -\begincentered - %% so … these aren’t actual headings‽ - \Largefont{\smallcaps{% - Terms and Conditions For Copying, Distribution and Modification - }} -\endcentered - -\beginenumeration -\item This License applies to any program or other work which contains - a notice placed by the copyright holder saying it may be - distributed under the terms of this General Public License. The - ``Program'', below, refers to any such program or work, and a - ``work based on the Program'' means either the Program or any - derivative work under copyright law: that is to say, a work - containing the Program or a portion of it, either verbatim or - with modifications and/or translated into another language. - (Hereinafter, translation is included without limitation in the - term ``modification''.) Each licensee is addressed as ``you''. - - Activities other than copying, distribution and modification are - not covered by this License; they are outside its scope. The act - of running the Program is not restricted, and the output from the - Program is covered only if its contents constitute a work based - on the Program (independent of having been made by running the - Program). Whether that is true depends on what the Program does. - -\item You may copy and distribute verbatim copies of the Program's source - code as you receive it, in any medium, provided that you - conspicuously and appropriately publish on each copy an - appropriate copyright notice and disclaimer of warranty; keep - intact all the notices that refer to this License and to the - absence of any warranty; and give any other recipients of the - Program a copy of this License along with the Program. - - You may charge a fee for the physical act of transferring a copy, - and you may at your option offer warranty protection in exchange - for a fee. - -\item You may modify your copy or copies of the Program or any portion - of it, thus forming a work based on the Program, and copy and - distribute such modifications or work under the terms of Section - 1 above, provided that you also meet all of these conditions: - - \beginenumeration - - \item You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - \item You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - \item If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you - provide a warranty) and that users may redistribute the program - under these conditions, and telling the user how to view a copy - of this License. (Exception: if the Program itself is - interactive but does not normally print such an announcement, - your work based on the Program is not required to print an - announcement.) - - \endenumeration - - - These requirements apply to the modified work as a whole. If - identifiable sections of that work are not derived from the - Program, and can be reasonably considered independent and - separate works in themselves, then this License, and its terms, - do not apply to those sections when you distribute them as - separate works. But when you distribute the same sections as - part of a whole which is a work based on the Program, the - distribution of the whole must be on the terms of this License, - whose permissions for other licensees extend to the entire whole, - and thus to each and every part regardless of who wrote it. - - Thus, it is not the intent of this section to claim rights or - contest your rights to work written entirely by you; rather, the - intent is to exercise the right to control the distribution of - derivative or collective works based on the Program. - - In addition, mere aggregation of another work not based on the - Program with the Program (or with a work based on the Program) on - a volume of a storage or distribution medium does not bring the - other work under the scope of this License. - -\item You may copy and distribute the Program (or a work based on it, - under Section 2) in object code or executable form under the - terms of Sections 1 and 2 above provided that you also do one of - the following: - - \beginenumeration - - \item Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of - Sections 1 and 2 above on a medium customarily used for software - interchange; or, - - \item Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - \item Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - - \endenumeration - - - The source code for a work means the preferred form of the work - for making modifications to it. For an executable work, complete - source code means all the source code for all modules it - contains, plus any associated interface definition files, plus - the scripts used to control compilation and installation of the - executable. However, as a special exception, the source code - distributed need not include anything that is normally - distributed (in either source or binary form) with the major - components (compiler, kernel, and so on) of the operating system - on which the executable runs, unless that component itself - accompanies the executable. - - If distribution of executable or object code is made by offering - access to copy from a designated place, then offering equivalent - access to copy the source code from the same place counts as - distribution of the source code, even though third parties are - not compelled to copy the source along with the object code. - -\item You may not copy, modify, sublicense, or distribute the Program - except as expressly provided under this License. Any attempt - otherwise to copy, modify, sublicense or distribute the Program - is void, and will automatically terminate your rights under this - License. However, parties who have received copies, or rights, - from you under this License will not have their licenses - terminated so long as such parties remain in full compliance. - -\item You are not required to accept this License, since you have not - signed it. However, nothing else grants you permission to modify - or distribute the Program or its derivative works. These actions - are prohibited by law if you do not accept this License. - Therefore, by modifying or distributing the Program (or any work - based on the Program), you indicate your acceptance of this - License to do so, and all its terms and conditions for copying, - distributing or modifying the Program or works based on it. - -\item Each time you redistribute the Program (or any work based on the - Program), the recipient automatically receives a license from the - original licensor to copy, distribute or modify the Program - subject to these terms and conditions. You may not impose any - further restrictions on the recipients' exercise of the rights - granted herein. You are not responsible for enforcing compliance - by third parties to this License. - -\item If, as a consequence of a court judgment or allegation of patent - infringement or for any other reason (not limited to patent - issues), conditions are imposed on you (whether by court order, - agreement or otherwise) that contradict the conditions of this - License, they do not excuse you from the conditions of this - License. If you cannot distribute so as to satisfy - simultaneously your obligations under this License and any other - pertinent obligations, then as a consequence you may not - distribute the Program at all. For example, if a patent license - would not permit royalty-free redistribution of the Program by - all those who receive copies directly or indirectly through you, - then the only way you could satisfy both it and this License - would be to refrain entirely from distribution of the Program. - - If any portion of this section is held invalid or unenforceable - under any particular circumstance, the balance of the section is - intended to apply and the section as a whole is intended to apply - in other circumstances. - - It is not the purpose of this section to induce you to infringe - any patents or other property right claims or to contest validity - of any such claims; this section has the sole purpose of - protecting the integrity of the free software distribution - system, which is implemented by public license practices. Many - people have made generous contributions to the wide range of - software distributed through that system in reliance on - consistent application of that system; it is up to the - author/donor to decide if he or she is willing to distribute - software through any other system and a licensee cannot impose - that choice. - - This section is intended to make thoroughly clear what is - believed to be a consequence of the rest of this License. - -\item If the distribution and/or use of the Program is restricted in - certain countries either by patents or by copyrighted interfaces, - the original copyright holder who places the Program under this - License may add an explicit geographical distribution limitation - excluding those countries, so that distribution is permitted only - in or among countries not thus excluded. In such case, this - License incorporates the limitation as if written in the body of - this License. - -\item The Free Software Foundation may publish revised and/or new - versions of the General Public License from time to time. Such - new versions will be similar in spirit to the present version, - but may differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the - Program specifies a version number of this License which applies - to it and ``any later version'', you have the option of following - the terms and conditions either of that version or of any later - version published by the Free Software Foundation. If the - Program does not specify a version number of this License, you - may choose any version ever published by the Free Software - Foundation. - -\item If you wish to incorporate parts of the Program into other free - programs whose distribution conditions are different, write to - the author to ask for permission. For software which is - copyrighted by the Free Software Foundation, write to the Free - Software Foundation; we sometimes make exceptions for this. Our - decision will be guided by the two goals of preserving the free - status of all derivatives of our free software and of promoting - the sharing and reuse of software generally. - -\begincentered - \Largefont{\smallcaps{No Warranty}} -\endcentered - -\item \smallcaps{Because the program is licensed free of charge, there - is no warranty for the program, to the extent permitted by - applicable law. Except when otherwise stated in writing the - copyright holders and/or other parties provide the program ``as - is'' without warranty of any kind, either expressed or implied, - including, but not limited to, the implied warranties of - merchantability and fitness for a particular purpose. The entire - risk as to the quality and performance of the program is with - you. Should the program prove defective, you assume the cost of - all necessary servicing, repair or correction.} - -\item \smallcaps{In no event unless required by applicable law or - agreed to in writing will any copyright holder, or any other - party who may modify and/or redistribute the program as permitted - above, be liable to you for damages, including any general, - special, incidental or consequential damages arising out of the - use or inability to use the program (including but not limited to - loss of data or data being rendered inaccurate or losses - sustained by you or third parties or a failure of the program to - operate with any other programs), even if such holder or other - party has been advised of the possibility of such damages.} - -\endenumeration - - -\begincentered - \Largefont{\smallcaps{End of Terms and Conditions}} -\endcentered - - -\pagebreak[2] - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\fakesection {Appendix: How to Apply These Terms to Your New Programs} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these -terms. - -To do so, attach the following notices to the program. It is safest to -attach them to the start of each source file to most effectively convey -the exclusion of warranty; and each file should have at least the -``copyright'' line and a pointer to where the full notice is found. - -\beginnarrower - one line to give the program's name and a brief idea of what it does. \\ - Copyright (C) yyyy name of author \\ - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -\endnarrower - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - -\beginnarrower - Gnomovision version 69, Copyright (C) yyyy name of author \\ - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. \\ - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. -\endnarrower - - -The hypothetical commands \proportional{show w} and \proportional{show -c} should show the appropriate parts of the General Public License. Of -course, the commands you use may be called something other than -\proportional{show w} and \proportional{show c}; they could even be -mouse-clicks or menu items---whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a ``copyright disclaimer'' for the program, if -necessary. Here is a sample; alter the names: - -\beginnarrower - Yoyodyne, Inc., hereby disclaims all copyright interest in the program \\ - `Gnomovision' (which makes passes at compilers) written by James Hacker. \\ - - signature of Ty Coon, 1 April 1989 \\ - Ty Coon, President of Vice -\endnarrower - - -This General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications -with the library. If this is what you want to do, use the GNU Library -General Public License instead of this License. - -\endtriplecolumns -\end{minipage} -\end{lrbox} - -\begincentered - \scalebox{0.33}{\usebox{\gpl}} -\endcentered - -\endsection - \endinput -- cgit v1.2.3 From 3ac343c10c8a02f7758eb75034e513d5509b584c Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Fri, 7 Mar 2014 07:56:29 +0100 Subject: [doc] add license note to pdf manual --- doc/luaotfload-main.tex | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'doc') diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 1613eaa..0098405 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -1445,5 +1445,26 @@ In this case, best define you own accessor: \endsubsection \endsection + +\beginsection {License} + +\identifier {luaotfload} is licensed under the terms of the +\hyperlink [GNU General Public License version 2.0]% + {https://www.gnu.org/licenses/old-licenses/gpl-2.0.html}. +Following the underlying fontloader code \identifier {luaotfload} +recognizes only that exact version as its license. +The „any later version” clause of the original license text as +copyrighted by the \hyperlink [Free Software Foundation]{http://www.fsf.org/} +\emphasis {does not apply} to either \identifier {luaotfload} or the +code imported from \CONTEXT. + +The complete text of the license is given as a separate file \fileent +{COPYING} in the toplevel directory of the +\hyperlink [\fileent {Luaotfload} Git repository]{https://github.com/lualatex/luaotfload/blob/master/COPYING}. +Distributions probably package it as \fileent +{doc/luatex/luaotfload/COPYING} in the relevant \fileent {texmf} tree. + +\endsection + \endinput -- cgit v1.2.3 From b220b4598c6c09e3148fa42b987f9615b1e8f135 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 9 Mar 2014 14:17:30 +0100 Subject: [doc] introduce fake environment for items --- doc/luaotfload-latex.tex | 2 + doc/luaotfload-main.tex | 183 ++++++++++++++++++++++++++++++----------------- 2 files changed, 121 insertions(+), 64 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 42799bf..3045c26 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -245,6 +245,8 @@ \def \first {####1}% #2 } + \let \beginaltitem \altitem + \let \endaltitem \relax } \expandafter \def \csname end#1\endcsname {% diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 0098405..0e74aa9 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -1,3 +1,16 @@ +%\beginsection {foo} + %bar baz +%\endsection + +%\begindescriptions + + %\beginaltitem {mode} foo + %%\identifier{luaotfload} has two \OpenType processing + %%\emphasis{modes}: +%\enddescriptions + +%\endinput + %% Copyright (C) 2009-2014 %% %% by Elie Roux @@ -514,7 +527,7 @@ obviously, \inlinecode{random}. \begindescriptions - \altitem {mode} + \beginaltitem {mode} \identifier{luaotfload} has two \OpenType processing \emphasis{modes}: \identifier{base} and \identifier{node}. @@ -536,8 +549,9 @@ obviously, \inlinecode{random}. By default \identifier{luaotfload} is in \identifier{node} mode, and \identifier{base} mode has to be requested where needed, e.~g. for math fonts. + \endaltitem - \altitem {script} \label{script-tag} + \beginaltitem {script} \label{script-tag} An \OpenType script tag;\footnote{% See \hyperlink {http://www.microsoft.com/typography/otspec/scripttags.htm} for a list of valid values. @@ -550,14 +564,16 @@ obviously, \inlinecode{random}. Some fonts, including very popular ones by foundries like Adobe, do not assign features to the \inlinecode{dflt} script, in which case the script needs to be set explicitly. + \endaltitem - \altitem {language} + \beginaltitem {language} An \OpenType language system identifier,\footnote{% Cf. \hyperlink {http://www.microsoft.com/typography/otspec/languagetags.htm}. } defaulting to \inlinecode{dflt}. + \endaltitem - \altitem {featurefile} + \beginaltitem {featurefile} A comma-separated list of feature files to be applied to the font. % @@ -585,8 +601,9 @@ obviously, \inlinecode{random}. It can be read and applied as follows: \inlinecode{\\font \\test = Latin Modern Roman:featurefile=tkrn.fea;+tkrn} + \endaltitem - \altitem {color} + \beginaltitem {color} A font color, defined as a triplet of two-digit hexadecimal \abbrev{rgb} values, with an optional fourth value for transparency @@ -598,8 +615,9 @@ obviously, \inlinecode{random}. \beginlisting \font \test = "Latin Modern Roman:color=FF0000BB" \endlisting + \endaltitem - \altitem {kernfactor \& letterspace} + \beginaltitem {kernfactor \& letterspace} Define a font with letterspacing (tracking) enabled. % In \identifier{luaotfload}, letterspacing is implemented by @@ -660,9 +678,10 @@ obviously, \inlinecode{random}. % The implementation of both functions is left entirely to the user. + \endaltitem - \altitem {protrusion \& expansion} + \beginaltitem {protrusion \& expansion} These keys control microtypographic features of the font, namely \emphasis{character protrusion} and \emphasis{font expansion}. @@ -698,6 +717,7 @@ obviously, \inlinecode{random}. \beginlisting \font \test = LatinModernRoman:protrusion=default \endlisting + \endaltitem \enddescriptions \endsubsection @@ -711,12 +731,13 @@ Currently (2014) there are three of them: \begindescriptions - \altitem {anum} + \beginaltitem {anum} Substitutes the glyphs in the \abbrev{ascii} number range with their counterparts from eastern Arabic or Persian, depending on the value of \identifier{language}. + \endaltitem - \altitem {tlig} + \beginaltitem {tlig} Applies legacy \TEX ligatures: \begintabulate [rlrl] @@ -735,9 +756,11 @@ Currently (2014) there are three of them: assignment \inlinecode {mapping=text-tex} using \XETEX's input remapping feature. } + \endaltitem - \altitem {itlc} + \beginaltitem {itlc} Computes italic correction values (active by default). + \endaltitem \enddescriptions @@ -1050,11 +1073,16 @@ categories. \begindoublecolumns \begindefinitions - \altitem{l-lua.lua} \altitem{l-lpeg.lua} - \altitem{l-function.lua} \altitem{l-string.lua} - \altitem{l-table.lua} \altitem{l-io.lua} - \altitem{l-file.lua} \altitem{l-boolean.lua} - \altitem{l-math.lua} \altitem{util-str.lua} + \beginaltitem {l-lua.lua} \endaltitem + \beginaltitem {l-lpeg.lua} \endaltitem + \beginaltitem {l-function.lua} \endaltitem + \beginaltitem {l-string.lua} \endaltitem + \beginaltitem {l-table.lua} \endaltitem + \beginaltitem {l-io.lua} \endaltitem + \beginaltitem {l-file.lua} \endaltitem + \beginaltitem {l-boolean.lua} \endaltitem + \beginaltitem {l-math.lua} \endaltitem + \beginaltitem {util-str.lua} \endaltitem \enddefinitions \enddoublecolumns @@ -1064,18 +1092,18 @@ categories. with \identifier{luaotfload}. \begindoublecolumns \begindefinitions - \altitem{luatex-basics-gen.lua} - \altitem{luatex-basics-nod.lua} - \altitem{luatex-fonts-enc.lua} - \altitem{luatex-fonts-syn.lua} - \altitem{luatex-fonts-tfm.lua} - \altitem{luatex-fonts-chr.lua} - \altitem{luatex-fonts-lua.lua} - \altitem{luatex-fonts-inj.lua} - \altitem{luatex-fonts-otn.lua} - \altitem{luatex-fonts-def.lua} - \altitem{luatex-fonts-ext.lua} - \altitem{luatex-fonts-cbk.lua} + \beginaltitem{luatex-basics-gen.lua} \endaltitem + \beginaltitem{luatex-basics-nod.lua} \endaltitem + \beginaltitem{luatex-fonts-enc.lua} \endaltitem + \beginaltitem{luatex-fonts-syn.lua} \endaltitem + \beginaltitem{luatex-fonts-tfm.lua} \endaltitem + \beginaltitem{luatex-fonts-chr.lua} \endaltitem + \beginaltitem{luatex-fonts-lua.lua} \endaltitem + \beginaltitem{luatex-fonts-inj.lua} \endaltitem + \beginaltitem{luatex-fonts-otn.lua} \endaltitem + \beginaltitem{luatex-fonts-def.lua} \endaltitem + \beginaltitem{luatex-fonts-ext.lua} \endaltitem + \beginaltitem{luatex-fonts-cbk.lua} \endaltitem \enddefinitions \enddoublecolumns @@ -1084,12 +1112,17 @@ categories. \CONTEXT. \begindoublecolumns \begindefinitions - \altitem{data-con.lua} \altitem{font-ini.lua} - \altitem{font-con.lua} \altitem{font-cid.lua} - \altitem{font-map.lua} \altitem{font-oti.lua} - \altitem{font-otf.lua} \altitem{font-otb.lua} - \altitem{font-ota.lua} \altitem{font-def.lua} - \altitem{font-otp.lua} + \beginaltitem{data-con.lua} \endaltitem + \beginaltitem{font-ini.lua} \endaltitem + \beginaltitem{font-con.lua} \endaltitem + \beginaltitem{font-cid.lua} \endaltitem + \beginaltitem{font-map.lua} \endaltitem + \beginaltitem{font-oti.lua} \endaltitem + \beginaltitem{font-otf.lua} \endaltitem + \beginaltitem{font-otb.lua} \endaltitem + \beginaltitem{font-ota.lua} \endaltitem + \beginaltitem{font-def.lua} \endaltitem + \beginaltitem{font-otp.lua} \endaltitem \enddefinitions \enddoublecolumns \enddefinitions @@ -1122,22 +1155,33 @@ files not contained in the merge. Some of these have no equivalent in \beginfilelist - \altitem {luaotfload-features.lua} font feature handling; - incorporates some of the code from - \fileent{font-otc} from \CONTEXT; - \altitem {luaotfload-override.lua} overrides the \CONTEXT logging - functionality. - \altitem {luaotfload-loaders.lua} registers the \OpenType - font reader as handler for - Postscript fonts - (\abbrev{pfa}, \abbrev{pfb}). - \altitem {luaotfload-parsers.lua} various \abbrev{lpeg}-based parsers. - \altitem {luaotfload-database.lua} font names database. - \altitem {luaotfload-colors.lua} color handling. - \altitem {luaotfload-auxiliary.lua} access to internal functionality - for package authors - (proposals for additions welcome). - \altitem {luaotfload-letterspace.lua} font-based letterspacing. + \beginaltitem {luaotfload-features.lua} + font feature handling; incorporates some of the code from + \fileent{font-otc} from \CONTEXT; + \endaltitem + \beginaltitem {luaotfload-override.lua} + overrides the \CONTEXT logging functionality. + \endaltitem + \beginaltitem {luaotfload-loaders.lua} + registers the \OpenType font reader as handler for Postscript + fonts (\abbrev{pfa}, \abbrev{pfb}). + \endaltitem + \beginaltitem {luaotfload-parsers.lua} + various \abbrev{lpeg}-based parsers. + \endaltitem + \beginaltitem {luaotfload-database.lua} + font names database. + \endaltitem + \beginaltitem {luaotfload-colors.lua} + color handling. + \endaltitem + \beginaltitem {luaotfload-auxiliary.lua} + access to internal functionality for package authors (proposals + for additions welcome). + \endaltitem + \beginaltitem {luaotfload-letterspace.lua} + font-based letterspacing. + \endaltitem \endfilelist \beginfigurefloat @@ -1243,14 +1287,17 @@ These are mostly concerned with establishing compatibility with \XETEX. \beginfunctionlist - \altitem {set_sscale_dimens} - Calculate \texmacro{fontdimen}s 10 and 11 to emulate \XETEX. + \beginaltitem {set_sscale_dimens} + Calculate \texmacro{fontdimen}s 10 and 11 to emulate \XETEX. + \endaltitem - \altitem {set_capheight} - Calculates \texmacro{fontdimen} 8 like \XETEX. + \beginaltitem {set_capheight} + Calculates \texmacro{fontdimen} 8 like \XETEX. + \endaltitem - \altitem {patch_cambria_domh} - Correct some values of the font \emphasis{Cambria Math}. + \beginaltitem {patch_cambria_domh} + Correct some values of the font \emphasis{Cambria Math}. + \endaltitem \endfunctionlist @@ -1271,38 +1318,46 @@ are defined for which scripts. \beginfunctionlist - \altitem {aux.font_has_glyph (id : int, index : int)} + \beginaltitem {aux.font_has_glyph (id : int, index : int)} Predicate that returns true if the font \luafunction{id} has glyph \luafunction{index}. + \endaltitem - \altitem {aux.slot_of_name(name : string)} + \beginaltitem {aux.slot_of_name(name : string)} Translates an Adobe Glyph name to the corresponding glyph slot. + \endaltitem - \altitem {aux.name_of_slot(slot : int)} + \beginaltitem {aux.name_of_slot(slot : int)} The inverse of \luafunction{slot_of_name}; note that this might be incomplete as multiple glyph names may map to the same codepoint, only one of which is returned by \luafunction{name_of_slot}. + \endaltitem - \altitem {aux.provides_script(id : int, script : string)} + \beginaltitem {aux.provides_script(id : int, script : string)} Test if a font supports \luafunction{script}. + \endaltitem - \altitem {aux.provides_language(id : int, script : string, language : string)} + \beginaltitem {aux.provides_language(id : int, script : string, language : string)} Test if a font defines \luafunction{language} for a given \luafunction{script}. + \endaltitem - \altitem {aux.provides_feature(id : int, script : string, + \beginaltitem {aux.provides_feature(id : int, script : string, language : string, feature : string)} Test if a font defines \luafunction{feature} for \luafunction{language} for a given \luafunction{script}. + \endaltitem - \altitem {aux.get_math_dimension(id : int, dimension : string)} + \beginaltitem {aux.get_math_dimension(id : int, dimension : string)} Get the dimension \luafunction{dimension} of font \luafunction{id}. + \endaltitem - \altitem {aux.sprint_math_dimension(id : int, dimension : string)} + \beginaltitem {aux.sprint_math_dimension(id : int, dimension : string)} Same as \luafunction{get_math_dimension()}, but output the value in scaled points at the \TEX end. + \endaltitem \endfunctionlist @@ -1312,7 +1367,7 @@ are defined for which scripts. % \beginsubsubsection{Database} % % \beginfunctionlist -% \altitem {aux.scan_external_dir(dir : string)} +% \beginaltitem {aux.scan_external_dir(dir : string)} % Include fonts in directory \luafunction{dir} in font lookups without % adding them to the database. % -- cgit v1.2.3 From 0cc9acaf9a99206c53eb046517953a9ca1d9db51 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Thu, 13 Mar 2014 22:28:40 +0100 Subject: [doc] add first draft Context layer --- doc/luaotfload-context.tex | 457 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 457 insertions(+) create mode 100644 doc/luaotfload-context.tex (limited to 'doc') diff --git a/doc/luaotfload-context.tex b/doc/luaotfload-context.tex new file mode 100644 index 0000000..aeca7cb --- /dev/null +++ b/doc/luaotfload-context.tex @@ -0,0 +1,457 @@ +% macros=mkvi +%% Copyright (C) 2009-2014 +%% +%% by Elie Roux +%% and Khaled Hosny +%% and Philipp Gesang +%% +%% This file is part of Luaotfload. +%% +%% Home: https://github.com/lualatex/luaotfload +%% Support: . +%% +%% Luaotfload is under the GPL v2.0 (exactly) license. +%% +%% ---------------------------------------------------------------------------- +%% +%% Luaotfload is free software; you can redistribute it and/or +%% modify it under the terms of the GNU General Public License +%% as published by the Free Software Foundation; version 2 +%% of the License. +%% +%% Luaotfload is distributed in the hope that it will be useful, +%% but WITHOUT ANY WARRANTY; without even the implied warranty of +%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%% GNU General Public License for more details. +%% +%% You should have received a copy of the GNU General Public License +%% along with Luaotfload; if not, see . +%% +%% ---------------------------------------------------------------------------- +%% + +\unprotect + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% layout and paper +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\setuppapersize [A5] [A5] %% 148×210 + +\definelayout [mainlayout] [ + backspace=15mm, %% 133 + textwidth=103mm, + topspace=15mm, +] + +\setuplayout [mainlayout] + +\setuppagenumbering [location=,alternative=doublesided] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% colors +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\usecolors [x11] +\definecolor [primarycolor] [dodgerblue4] +\definecolor [secondarycolor] [goldenrod4] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% interaction +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\setupinteraction [ + state=start, + page=no, + click=yes, + style=italic, + color=primarycolor, + contrastcolor=secondarycolor, + title={The Luaotfload package}, + subtitle={OpenType layout system for Plain TeX and LaTeX}, + author={Elie Roux & Khaled Hosny & Philipp Gesang}, + keywords={luatex, lualatex, unicode, opentype}, +] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% fonts +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\usemodule [simplefonts] + +\definefontfeature [default] [default] [mode=base,liga=yes,dlig=yes,tlig=yes,onum=yes] +\definefontfeature [monospace] [liga=no,tlig=no,onum=no] + +\definefontfamily [mainface] [serif] [Linux Libertine O] [features=default] +%\definefontfamily [mainface] [serif] [Liberation Serif] [feature=default] +%\definefontfamily [mainface] [sans] [Iwona] [feature=default] +\definefontfamily [mainface] [sans] [Iwona Medium] [ + feature=default, + it=file:IwonaMedium-Italic.otf, + tf=file:IwonaMedium-Regular.otf, + bf=file:Iwona-Bold.otf, + bi=file:Iwona-BoldItalic.otf, +] +%definefontfamily [mainface] [sans] [DejaVu Sans] [feature=default] +\definefontfamily [mainface] [mono] [Liberation Mono] [scale=0.85,features=monospace] + +\setupbodyfont [mainface,10pt] + +\def \LUA {Lua} +\def \LUALATEX {Lua\LATEX} +\def \OpenType {\identifier{Open\kern-.25ex Type}} + +\definealternativestyle [emphasis:texmacro] [\ss \it \letterbackslash] [\ss \it \letterbackslash] +\definealternativestyle [emphasis:identifier] [\ss] [\ss] +\definealternativestyle [emphasis:normal] [\sl] [\sl] +\definealternativestyle [emphasis:abbrev] [{\feature [+][smallcaps]}] [{\feature [+][smallcaps]}] +\definealternativestyle [emphasis:Largefont] [{\switchtobodyfont[14pt]}] [{\switchtobodyfont[14pt]}] +\definealternativestyle [emphasis:smallcaps] [{\feature [+][smallcaps]}] [{\feature [+][smallcaps]}] +%definealternativestyle [emphasis:nonproportional] [\mono] [\mono] +\definealternativestyle [emphasis:nonproportional] [\tt] [\tt] +\definealternativestyle [head:section] [{\roman\feature[+][smallcaps]}] [{\roman\feature[+][smallcaps]}] +\definealternativestyle [head:subsection] [{\roman\feature[+][smallcaps]}] [{\roman\feature[+][smallcaps]}] +\definealternativestyle [head:subsubsection] [{\roman\feature[+][smallcaps]}] [{\roman\feature[+][smallcaps]}] +\definealternativestyle [typing:luafunction] [\italic] [\italic] +\definealternativestyle [typing:fileent] [\tt] [\tt] + +\definehighlight [texmacro] [style=emphasis:texmacro] %% cs +\definehighlight [identifier] [style=emphasis:identifier] %% names +\definehighlight [abbrev] [style=emphasis:abbrev] %% acronyms +\definehighlight [emphasis] [style=emphasis:normal] %% level 1 emph + +\definehighlight [Largefont] [style=emphasis:Largefont] %% font size +\definehighlight [smallcaps] [style=emphasis:smallcaps] %% font feature +\definehighlight [nonproportional] [style=emphasis:nonproportional] %% font switch + +\definetype [fileent] [style=typing:fileent] +\definetype [luafunction] [style=typing:luafunction] +\setuptyping [style=ttx] + +\definebodyfontenvironment [8pt] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% headings +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\setuphead [section] [style=head:section, alternative=inmargin] +\setuphead [subsection] [style=head:subsection, alternative=inmargin] +\setuphead [subsubsection] [style=head:subsubsection,alternative=inmargin] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% running headers +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\setupheadertexts + [{\tfx \getmarking[section]}] [pagenumber] + [pagenumber] [{\tfx \fileent{Luaotfload} Manual}] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% structurals +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%% section +\def \beginsection {\dosingleempty \section_begin_indeed} + +\def \section_begin_indeed [#ref]#title{% + \iffirstargument + \startsection [reference=#ref,title=#title]% + \else + \startsection [title=#title]% + \fi +} + +\let \endsection \stopsection + +%% subsection +\def \beginsubsection {\dosingleempty \section_begin_indeed} + +\def \subsection_begin_indeed [#ref]#title{% + \iffirstargument + \startsubsection [reference=#ref,title=#title]% + \else + \startsubsection [title=#title]% + \fi +} + +\let \endsubsection \stopsection + +%% subsubsection +\def \beginsubsubsection {\dosingleempty \section_begin_indeed} + +\def \subsubsection_begin_indeed [#ref]#title{% + \iffirstargument + \startsubsubsection [reference=#ref,title=#title]% + \else + \startsubsubsection [title=#title]% + \fi +} + +\let \endsubsubsection \stopsection + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% inline verbatim +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%% Context offers both \type{…} and \type<<…>>, but not an unbalanced +%% one that we could map directly onto Latex’s \verb|…|. + +\definetype [inlinecode] [style=emphasis:nonproportional] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% codelistings +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Now *that’s* what I call easy. + +\unexpanded \def \beginlisting {% + \grabbufferdatadirect{listing}{beginlisting}{endlisting}% +} + +\unexpanded \def \endlisting {\typebuffer [listing]} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% enumerations and lists +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\definedescription [descriptionitem] [ + align=right, + alternative=hanging, + width=2em, +] + +\def \begindescriptions {% + \begingroup + \def \beginnormalitem ##1\endnormalitem{% + \startitem##1\stopitem + } + \let \endnormalitem \relax + \let \beginaltitem \startdescriptionitem + \let \endaltitem \stopdescriptionitem +} + +\let \enddescriptions \endgroup + + +\definedescription [definitionitem] [ + align=right, + alternative=hanging, +] + +\def \begindefinitions {% + \begingroup + \def \beginnormalitem ##1\endnormalitem{% + \startitem##1\stopitem + } + \let \endnormalitem \relax + \let \beginaltitem \startdefinitionitem + \let \endaltitem \stopdefinitionitem +} + +\let \enddefinitions \endgroup + + +\definedescription [filelistitem] [ + align=normal, + alternative=hanging, + headstyle=typing:fileent, + width=4cm, +] + +\def \beginfilelist {% + \begingroup + \def \beginnormalitem ##1\endnormalitem{% + \startitem##1\stopitem + } + \let \endnormalitem \relax + \let \beginaltitem \startfilelistitem + \let \endaltitem \stopfilelistitem +} + +\let \endfilelist \endgroup + +\definedescription [functionlistitem] [ + align=normal, + alternative=hanging, + headstyle=typing:luafunction, + width=4cm, +] + +\def \beginfunctionlist {% + \begingroup + \def \beginnormalitem ##1\endnormalitem{% + \startitem##1\stopitem + } + \let \endnormalitem \relax + \let \beginaltitem \startfunctionlistitem + \let \endaltitem \stopfunctionlistitem +} + +\let \endfunctionlist \endgroup + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% columns +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \begindoublecolumns {\startcolumns [2]} +\let \enddoublecolumns \stopcolumns + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% alignment +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\setupnarrower [before={\blank[line]},after={\blank[line]}] +\let \beginnarrower \startnarrower +\let \endnarrower \stopnarrower + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% special elements +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def \meta #1{<{\italic #1}>} + +\def \beginabstractcontent {% + \grabbufferdatadirect{abstractcontent}{beginabstractcontent}{endabstractcontent}% +} + +\let \endabstractcontent \relax + +\def \setdocumenttitle #1{\setvalue {document_title}{#1}} +\def \setdocumentdate #1{\setvalue {document_date}{#1}} +\def \setdocumentauthor #1{\setvalue {document_author}{#1}} + +\let \typesetdocumenttitle \relax +\let \beginfrontmatter \relax + +\def \endfrontmatter { + \startstandardmakeup + \vfill + \strut \hfill + \startframed [frame=off,align=middle,width=.5\textwidth] + \Largefont{\getvalue {document_title}} + \stopframed + \hfill \strut \par + + \blank [2*big] + + \strut \hfill + \startframed [frame=off,align=middle,width=.65\textwidth] + \setuplocalinterlinespace [18pt] + \getvalue {document_author} + \stopframed + \hfill \strut \par + + \vfill + \strut \hfill \getvalue {document_date} \hfill \strut + \blank [2*big] + + \strut \hfill + \startframed [width=.7\textwidth,align=normal,style=tfx,frame=off]% + \getbuffer [abstractcontent] + \stopframed + \hfill \strut + \stopstandardmakeup +} + +\let \typesetcontent \completecontent + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% floats +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% XXX we can improve on this part later + +\usemodule [vim] +\definevimtyping [bnf] [syntax=bnf] +\definefloat [syntax] [figure] + +\def \beginsyntaxfloat #reference#caption{% + \begingroup + \edef \currentreference {#reference}% + \edef \currentcaption {#caption}% + \grabbufferdatadirect{rawsyntaxdata}{beginsyntaxfloat}{endsyntaxfloat}% +} + +\def \endsyntaxfloat {% + \savebuffer [rawsyntaxdata] [rawsyntaxdata] + \startplacesyntax [ + reference=\currentreference, + title={\currentcaption}, + ] + %% there’s no \typebnfbuffer in t-vim :( + \typebnffile {\jobname-rawsyntaxdata.tmp} + \stopplacesyntax + \endgroup% +} + +\def \figurefloat #reference#caption#file{% + \startplacefigure [ + reference=#reference, + title={#caption}, + ] + \externalfigure [#file] [width=\textwidth] + \stopplacefigure +} + + +\def \tablefloat #reference#caption#content{% + \startplacetable [ + reference=#reference, + title={#caption}, + ] + #content + \stopplacetable +} + + +%% tables + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% tables +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\setupxtable [frame=off,option=stretch,textwidth=\dimexpr(\textwidth/2)] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% hyperlinks and references +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\unexpanded \def \hyperlink{% + \dosingleempty \hyperlink_indeed% +} + +\def \hyperlink_indeed [#text]#url{% + \iffirstargument + \useURL [temporary_url] [#url] [] [#text]% + \else + \useURL [temporary_url] [#url]% + \fi% + \from [temporary_url]% +} + + +\def \email #1{\goto{#1}[url(mailto:#1)]} + +\def \label #tag{\reference [#tag]\empty} +\def \pageref #tag{\at{page}{#tag}} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% escaped characters +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\let \charpercent \letterpercent +\let \charbackslash \letterbackslash +\let \chartilde \lettertilde + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% main +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\protect + +\newif \ifcontextmkiv \contextmkivtrue + +\starttext + \input luaotfload-main.tex +\stoptext + -- cgit v1.2.3 From 4e1f4ca586bd51ccf70343411162103dfc96e1e0 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Thu, 20 Mar 2014 07:17:33 +0100 Subject: [doc] make inline code work consistently with both formats --- doc/luaotfload-context.tex | 38 +++++- doc/luaotfload-latex.tex | 124 +++++++++++------ doc/luaotfload-main.tex | 329 ++++++++++++++++++++++++++------------------- 3 files changed, 303 insertions(+), 188 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-context.tex b/doc/luaotfload-context.tex index aeca7cb..6c8d4b2 100644 --- a/doc/luaotfload-context.tex +++ b/doc/luaotfload-context.tex @@ -83,8 +83,8 @@ \definefontfeature [monospace] [liga=no,tlig=no,onum=no] \definefontfamily [mainface] [serif] [Linux Libertine O] [features=default] -%\definefontfamily [mainface] [serif] [Liberation Serif] [feature=default] -%\definefontfamily [mainface] [sans] [Iwona] [feature=default] +%definefontfamily [mainface] [serif] [Liberation Serif] [feature=default] +%definefontfamily [mainface] [sans] [Iwona] [feature=default] \definefontfamily [mainface] [sans] [Iwona Medium] [ feature=default, it=file:IwonaMedium-Italic.otf, @@ -128,7 +128,9 @@ \definetype [luafunction] [style=typing:luafunction] \setuptyping [style=ttx] -\definebodyfontenvironment [8pt] +\definebodyfontenvironment [8pt] +\definebodyfontenvironment [10pt] +\definebodyfontenvironment [12pt] %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% headings @@ -196,7 +198,26 @@ %% Context offers both \type{…} and \type<<…>>, but not an unbalanced %% one that we could map directly onto Latex’s \verb|…|. -\definetype [inlinecode] [style=emphasis:nonproportional] +\definetype [inlinecode_indeed] [style=emphasis:nonproportional] + +%% The listings macros don’t seem to handle backslashes and braces +%% well. We emulate this behavior by handling the escaping in Lua. + +\startluacode + local lpeg = require "lpeg" + local Cs, P, S = lpeg.Cs, lpeg.P, lpeg.S + local lpegmatch = lpeg.match + local unescape_char = S[[\letterbackslash\letterleftbrace\letterrightbrace]] + local backslash = P[[\letterbackslash]] + local unescape = Cs (((backslash / "" * unescape_char) + 1)^0) + commands.unescape_things = function (str) + context.type (lpegmatch (unescape, str)) + end +\stopluacode + +\unexpanded \def \inlinecode #content{% + \ctxcommand {unescape_things \!!bs \detokenize {#content}\!!es}% +} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% codelistings @@ -209,6 +230,7 @@ \unexpanded \def \endlisting {\typebuffer [listing]} + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% enumerations and lists %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -308,7 +330,13 @@ %% special elements %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\def \meta #1{<{\italic #1}>} +\definefont [lmromantenregular] [file:lmroman10-regular.otf*default] + +\def \meta #1{% + {\lmromantenregular<}% + {\italic #1}% + {\lmromantenregular>}% +} \def \beginabstractcontent {% \grabbufferdatadirect{abstractcontent}{beginabstractcontent}{endabstractcontent}% diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 3045c26..409adcf 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -79,26 +79,64 @@ \newcommand\CONTEXT {Con\TeX t\xspace} \newcommand\OpenType {\identifier{Open\kern-.25ex Type}\xspace} -\def\definehighlight[#1][#2]% - {\ifcsname #1\endcsname\else - \expandafter\def\csname #1\endcsname% - {\bgroup#2\csname #1_indeed\endcsname} - \expandafter\def\csname #1_indeed\endcsname##1% - {##1\egroup}% - \fi} +%% \groupedcommand, with some omissions taken from syst-aux.mkiv +\let \handlegroupnormalbefore \relax +\let \handlegroupnormalafter \relax + +\protected \def \handlegroupnormal #1#2{% + \bgroup % 1 + \def \handlegroupbefore {#1}% + \def \handlegroupafter {#2}% + \afterassignment \handlegroupnormalbefore + \let \next = +} + +\def \handlegroupnormalbefore {% + \bgroup % 2 + \handlegroupbefore + \bgroup % 3 + \aftergroup \handlegroupnormalafter% +} + +\def \handlegroupnormalafter {% + \handlegroupafter + \egroup % 3 + \egroup % 2 +} + +\let \groupedcommand \handlegroupnormal %% only the two arg version + +\def \definehighlight [#1][#2]{% + \ifcsname #1\endcsname\else + \expandafter\def\csname #1\endcsname{% + \leavevmode + \groupedcommand {#2}\empty% + } + \fi% +} + +%% old, simplistic definition: obsolete now that we have +%% \groupedcommand +%\def\definehighlight[#1][#2]% + %{\ifcsname #1\endcsname\else + %\expandafter\def\csname #1\endcsname% + %{\bgroup#2\csname #1_indeed\endcsname} + %\expandafter\def\csname #1_indeed\endcsname##1% + %{##1\egroup}% + %\fi} \def\restoreunderscore{\catcode`\_=12\relax} -\definehighlight [fileent][\ttfamily\restoreunderscore] %% files, dirs -\definehighlight [texmacro][\sffamily\itshape\textbackslash] %% cs -\definehighlight [luafunction][\sffamily\itshape\restoreunderscore] %% lua identifiers -\definehighlight [identifier][\sffamily] %% names -\definehighlight [abbrev][\rmfamily\scshape] %% acronyms -\definehighlight [emphasis][\rmfamily\slshape] %% level 1 emph +\definehighlight [fileent][\ttfamily\restoreunderscore] %% files, dirs +\definehighlight [texmacro][\sffamily\itshape\textbackslash] %% cs +\definehighlight [luafunction][\sffamily\itshape\restoreunderscore] %% lua identifiers +\definehighlight [identifier][\sffamily] %% names +\definehighlight [abbrev][\rmfamily\scshape] %% acronyms +\definehighlight [emphasis][\rmfamily\slshape] %% level 1 emph -\definehighlight [Largefont][\Large] %% font size -\definehighlight [smallcaps][\sc] %% font feature -\definehighlight [proportional][\tt] %% font switch +\definehighlight [Largefont][\Large] %% font size +\definehighlight [smallcaps][\sc] %% font feature +\definehighlight [nonproportional][\tt] %% font switch \newcommand*\email[1]{\href{mailto:#1}{#1}} @@ -170,6 +208,7 @@ \usepackage {listings} \lstset { basicstyle=\ttfamily, + escapechar=Ö, } \def \inlinecode #1{% @@ -245,8 +284,10 @@ \def \first {####1}% #2 } - \let \beginaltitem \altitem - \let \endaltitem \relax + \let \beginnormalitem \item + \let \endnormalitem \relax + \let \beginaltitem \altitem + \let \endaltitem \relax } \expandafter \def \csname end#1\endcsname {% @@ -280,6 +321,9 @@ %% special elements %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\let \beginfrontmatter \relax +\let \endfrontmatter \relax + \def \beginabstractcontent {\begin {abstract}} \def \endabstractcontent {\end {abstract}} @@ -288,7 +332,9 @@ \let \setdocumentauthor \author \let \typesetdocumenttitle \maketitle -\let \typesetcontent \tableofcontent +\AtBeginDocument {%% seriously? + \let \typesetcontent \tableofcontents% +} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% floats @@ -315,34 +361,22 @@ } %% figures, e.g. the file graph -\def \beginfigurefloat #1#2{%% #1:label #2:caption - \begingroup - \begin {figure} [b] - \edef \figurelabel {#1}% - \caption {#2}% -} - -\def \endfigurefloat {% - \label \figurelabel - \end {figure} - \endgroup +\def \figurefloat #1#2#3{%% #1:label #2:caption #3:file + \begin {figure} [b] + \caption {#2}% + \includegraphics[width=\textwidth]{#3}% + \label {#1} + \end {figure} } %% tables - -\def \begintablefloat #1#2{%% #1:label #2:caption - \begingroup - \begin {table} [t] - \hrule - \edef \floatlabel {#1}% - \caption {#2}% -} - -\def \endtablefloat {% - \label \floatlabel - \hrule - \end {table} - \endgroup +\def \tablefloat #1#2{%% #1:label #2:caption + \begin {table} [t] + \hrule + \caption {#2}% + \label {#1} + \hrule + \end {table} } @@ -402,6 +436,8 @@ \makeatother +\newif \ifcontextmkiv \contextmkivfalse + \begin {document} \input {luaotfload-main.tex} \end {document} diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 0e74aa9..5b033c0 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -1,16 +1,3 @@ -%\beginsection {foo} - %bar baz -%\endsection - -%\begindescriptions - - %\beginaltitem {mode} foo - %%\identifier{luaotfload} has two \OpenType processing - %%\emphasis{modes}: -%\enddescriptions - -%\endinput - %% Copyright (C) 2009-2014 %% %% by Elie Roux @@ -42,21 +29,25 @@ %% ---------------------------------------------------------------------------- %% -\setdocumenttitle {The \identifier{luaotfload} package} -\setdocumentdate {2014/**/** v2.5} -\setdocumentauthor {Elie Roux · Khaled Hosny · Philipp Gesang\\ - Home: \hyperlink {https://github.com/lualatex/luaotfload}\\ - Support: \email {lualatex-dev@tug.org}} +\beginfrontmatter -\typesetdocumenttitle + \setdocumenttitle {The \identifier{luaotfload} package} + \setdocumentdate {2014/**/** v2.5} + \setdocumentauthor {Elie Roux · Khaled Hosny · Philipp Gesang\\ + Home: \hyperlink {https://github.com/lualatex/luaotfload}\\ + Support: \email {lualatex-dev@tug.org}} -\beginabstractcontent - This package is an adaptation of the \CONTEXT font loading system. - It allows for loading \OpenType fonts with an extended syntax and adds - support for a variety of font features. -\endabstractcontent + \typesetdocumenttitle -\tableofcontents + \beginabstractcontent + This package is an adaptation of the \CONTEXT font loading system. + It allows for loading \OpenType fonts with an extended syntax and adds + support for a variety of font features. + \endabstractcontent + +\endfrontmatter + +\typesetcontent %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \beginsection {Introduction} @@ -140,10 +131,10 @@ in the task and willingness to respond to our suggestions. \identifier{luaotfload} supports an extended font request syntax: \beginnarrower - \inlinecode{\\font\\foo=\{}% - \meta{prefix}\inlinecode{:}% - \meta{font name}\inlinecode{:}% - \meta{font features}\inlinecode{\}}% + \nonproportional{\string\font\string\foo\space= \string{}% + \meta{prefix}\nonproportional{:}% + \meta{font name}\nonproportional{:}% + \meta{font features}\nonproportional{\string}}% \meta{\TEX font features} \endnarrower @@ -165,18 +156,18 @@ for a more formal description see figure \ref{font-syntax}. In addition to the font style modifiers (\emphasis{slash-notation}) given above, there are others that are recognized but will be silently - ignored: {\ttfamily aat}, - {\ttfamily icu}, and - {\ttfamily gr}. + ignored: \nonproportional{aat}, + \nonproportional{icu}, and + \nonproportional{gr}. The special terminals are: - {\sc feature\textunderscore id} for a valid font + \smallcaps {feature\textunderscore id} for a valid font feature name and - {\sc feature\textunderscore value} for the corresponding + \smallcaps {feature\textunderscore value} for the corresponding value. - {\sc tfmname} is the name of a \abbrev{tfm} file. - {\sc digit} again refers to bytes 48--57, and - {\sc all\textunderscore characters} to all byte values. - {\sc csname} and {\sc dimension} are the \TEX concepts.} + \smallcaps {tfmname} is the name of a \abbrev{tfm} file. + \smallcaps {digit} again refers to bytes 48--57, and + \smallcaps {all\textunderscore characters} to all byte values. + \smallcaps {csname} and \smallcaps {dimension} are the \TEX concepts.} % ::= `\\font', {\sc csname}, `=', , [ ] ; @@ -223,7 +214,11 @@ In \identifier{luaotfload}, the canonical syntax for font requests requires a \emphasis{prefix}: % \beginnarrower - \inlinecode{\\font\\fontname=}\meta{prefix}\inlinecode{:}\meta{fontname}\dots + \nonproportional{\string\font\string\fontname\space= }% + \meta{prefix}% + \nonproportional{:}% + \meta{fontname}% + \dots \endnarrower % where \meta{prefix} is either \inlinecode{file:} or \inlinecode {name:}.\footnote{% @@ -318,7 +313,9 @@ There are again two modes: bracketed and unbracketed. A bracketed request looks as follows. \beginnarrower - \inlinecode{\\font\\fontname=[}\meta{path to file}\inlinecode{]} + \nonproportional{\string\font\string\fontname\space = [}% + \meta{/path/to/file}% + \nonproportional{]} \endnarrower \noindent @@ -329,7 +326,9 @@ Naturally, path-less file names are equally valid and processed the same way as an ordinary \inlinecode {file:} lookup. \beginnarrower - \inlinecode{\\font\\fontname=}\meta{font name} \dots + \nonproportional{\string\font\string\fontname\space= }% + \meta{font name} + \dots \endnarrower Unbracketed (or, for lack of a better word: \emphasis{anonymous}) @@ -347,7 +346,11 @@ Furthermore, \identifier{luaotfload} supports the slashed (shorthand) font style notation from \XETEX. \beginnarrower - \inlinecode{\\font\\fontname=}\meta{font name}\inlinecode{/}\meta{modifier}\dots + \nonproportional{\string\font\string\fontname\space= }% + \meta{font name}% + \nonproportional{/}% + \meta{modifier} + \dots \endnarrower \noindent @@ -470,11 +473,14 @@ which is equivalent to these full names: general scheme for font requests: \beginnarrower - \inlinecode{\\font\\foo=\{}% - \meta{prefix}\inlinecode{:}% - \meta{font name}\inlinecode{:}% - \meta{font features}\inlinecode{\}}% - \meta{\TEX font features} + \nonproportional{\string\font\string\foo\space= "}% + \meta{prefix}% + \nonproportional{:}% + \meta{font name}% + \nonproportional{:}% + \meta{font features}% + \meta{\TEX font features}% + \nonproportional{"} \endnarrower \noindent @@ -680,6 +686,12 @@ obviously, \inlinecode{random}. user. \endaltitem +\ifcontextmkiv + \startbuffer [printvectors] + \directlua{inspect(fonts.protrusions.setups.default) + inspect(fonts.expansions.setups.default)} + \stopbuffer +\fi \beginaltitem {protrusion \& expansion} These keys control microtypographic features of the font, @@ -694,10 +706,14 @@ obviously, \inlinecode{random}. % Alternatively and with loss of information, you can dump those tables into your terminal by issuing - \beginlisting -\directlua{inspect(fonts.protrusions.setups.default) - inspect(fonts.expansions.setups.default)} - \endlisting + \unless \ifcontextmkiv + \beginlisting + \directlua{inspect(fonts.protrusions.setups.default) + inspect(fonts.expansions.setups.default)} + \endlisting + \else + \typebuffer [printvectors] + \fi at some point after loading \fileent{luaotfload.sty}. } % @@ -740,13 +756,28 @@ Currently (2014) there are three of them: \beginaltitem {tlig} Applies legacy \TEX ligatures: - \begintabulate [rlrl] - \beginrow `` \newcell \inlinecode {``} \newcell '' \newcell \inlinecode {''} \endrow - \beginrow ` \newcell \inlinecode {`} \newcell ' \newcell \inlinecode {'} \endrow - \beginrow " \newcell \inlinecode {"} \newcell -- \newcell \inlinecode {--} \endrow - \beginrow --- \newcell \inlinecode {---} \newcell !` \newcell \inlinecode {!`} \endrow - \beginrow ?` \newcell \inlinecode {?`} \newcell \newcell \endrow - \endtabulate + \unless \ifcontextmkiv + \begintabulate [rlrl] + \beginrow `` \newcell \inlinecode {``} \newcell '' \newcell \inlinecode {''} \endrow + \beginrow ` \newcell \inlinecode {`} \newcell ' \newcell \inlinecode {'} \endrow + \beginrow " \newcell \inlinecode {"} \newcell -- \newcell \inlinecode {--} \endrow + \beginrow --- \newcell \inlinecode {---} \newcell !` \newcell \inlinecode {!`} \endrow + \beginrow ?` \newcell \inlinecode {?`} \newcell \newcell \endrow + \endtabulate + \else + %% XXX find a way to wrap these in the tabulate environment + \startframed [frame=off,width=broad,align=middle] + \startframed [frame=off,width=\dimexpr(\textwidth/2)] + \startxtable [align=middle] + \startxrow \startxcell `` \stopxcell \startxcell \inlinecode {``} \stopxcell \startxcell '' \stopxcell \startxcell \inlinecode {''} \stopxcell \stopxrow + \startxrow \startxcell ` \stopxcell \startxcell \inlinecode {`} \stopxcell \startxcell ' \stopxcell \startxcell \inlinecode {'} \stopxcell \stopxrow + \startxrow \startxcell " \stopxcell \startxcell \inlinecode {"} \stopxcell \startxcell -- \stopxcell \startxcell \inlinecode {--} \stopxcell \stopxrow + \startxrow \startxcell --- \stopxcell \startxcell \inlinecode {---} \stopxcell \startxcell !` \stopxcell \startxcell \inlinecode {!`} \stopxcell \stopxrow + \startxrow \startxcell ?` \stopxcell \startxcell \inlinecode {?`} \stopxcell \startxcell \stopxcell \startxcell \stopxcell \stopxrow + \stopxtable + \stopframed + \stopframed + \fi \footnote{% These contain the feature set \inlinecode {trep} of earlier @@ -873,26 +904,41 @@ Other paths can be specified by setting the environment variable If it is non-empty, then search will be extended to the included directories. -\begintablefloat {table-searchpaths} +\tablefloat {table-searchpaths} {List of paths searched for each supported operating system.} - \begincentered - \begintabulate [lp{.5\textwidth}] - \beginrow - Windows \newcell \inlinecode {\% WINDIR\%\\ Fonts} - \endrow - \beginrow - Linux \newcell \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break - \fileent{/etc/fonts/fonts.conf} - \endrow - \beginrow - Mac \newcell \fileent{\textasciitilde/Library/Fonts},\break - \fileent{/Library/Fonts},\break - \fileent{/System/Library/Fonts}, and\hfill\break - \fileent{/Network/Library/Fonts} - \endrow - \endtabulate - \endcentered -\endtablefloat + {% + \unless \ifcontextmkiv + \begincentered + \begintabulate [lp{.5\textwidth}] + \beginrow + Windows \newcell \inlinecode {\% WINDIR\%\\ Fonts} + \endrow + \beginrow + Linux \newcell \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break + \fileent{/etc/fonts/fonts.conf} + \endrow + \beginrow + Mac \newcell \fileent{\textasciitilde/Library/Fonts},\break + \fileent{/Library/Fonts},\break + \fileent{/System/Library/Fonts}, and\hfill\break + \fileent{/Network/Library/Fonts} + \endrow + \endtabulate + \endcentered + \else + \setuplocalinterlinespace [14pt] + \starttabulate [|l|p(.5\textwidth)|] + \NC Windows \NC \inlinecode {\% WINDIR\%\\ Fonts} \NC \NR + \NC Linux \NC \fileent{/usr/local/etc/fonts/fonts.conf} and\crlf + \fileent{/etc/fonts/fonts.conf} \NC \NR + \NC + Mac \NC \fileent{\textasciitilde/Library/Fonts},\crlf + \fileent{/Library/Fonts},\break + \fileent{/System/Library/Fonts}, and\crlf + \fileent{/Network/Library/Fonts} \NC \NR + \stoptabulate + \fi% + } \endsubsection @@ -1016,7 +1062,7 @@ An example with explicit paths: %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \identifier{luaotfload} relies on code originally written by Hans -Hagen for the \hyperlink[\identifier\CONTEXT]{http://wiki.contextgarden.net} +Hagen for the \hyperlink[\identifier{\CONTEXT}]{http://wiki.contextgarden.net} format. % It integrates the font loader as distributed in @@ -1067,64 +1113,70 @@ It houses several \LUA files that can be classed in three categories. \begindefinitions - \normalitem \emphasis{\LUA utility libraries}, a subset - of what is provided by the \identifier{lualibs} - package. - - \begindoublecolumns - \begindefinitions - \beginaltitem {l-lua.lua} \endaltitem - \beginaltitem {l-lpeg.lua} \endaltitem - \beginaltitem {l-function.lua} \endaltitem - \beginaltitem {l-string.lua} \endaltitem - \beginaltitem {l-table.lua} \endaltitem - \beginaltitem {l-io.lua} \endaltitem - \beginaltitem {l-file.lua} \endaltitem - \beginaltitem {l-boolean.lua} \endaltitem - \beginaltitem {l-math.lua} \endaltitem - \beginaltitem {util-str.lua} \endaltitem - \enddefinitions - \enddoublecolumns - - \normalitem The \emphasis{font loader} itself. - These files have been written for - \LUATEX-Fonts and they are distributed along - with \identifier{luaotfload}. - \begindoublecolumns - \begindefinitions - \beginaltitem{luatex-basics-gen.lua} \endaltitem - \beginaltitem{luatex-basics-nod.lua} \endaltitem - \beginaltitem{luatex-fonts-enc.lua} \endaltitem - \beginaltitem{luatex-fonts-syn.lua} \endaltitem - \beginaltitem{luatex-fonts-tfm.lua} \endaltitem - \beginaltitem{luatex-fonts-chr.lua} \endaltitem - \beginaltitem{luatex-fonts-lua.lua} \endaltitem - \beginaltitem{luatex-fonts-inj.lua} \endaltitem - \beginaltitem{luatex-fonts-otn.lua} \endaltitem - \beginaltitem{luatex-fonts-def.lua} \endaltitem - \beginaltitem{luatex-fonts-ext.lua} \endaltitem - \beginaltitem{luatex-fonts-cbk.lua} \endaltitem - \enddefinitions - \enddoublecolumns - - \normalitem Code related to \emphasis{font handling and - node processing}, taken directly from - \CONTEXT. - \begindoublecolumns - \begindefinitions - \beginaltitem{data-con.lua} \endaltitem - \beginaltitem{font-ini.lua} \endaltitem - \beginaltitem{font-con.lua} \endaltitem - \beginaltitem{font-cid.lua} \endaltitem - \beginaltitem{font-map.lua} \endaltitem - \beginaltitem{font-oti.lua} \endaltitem - \beginaltitem{font-otf.lua} \endaltitem - \beginaltitem{font-otb.lua} \endaltitem - \beginaltitem{font-ota.lua} \endaltitem - \beginaltitem{font-def.lua} \endaltitem - \beginaltitem{font-otp.lua} \endaltitem - \enddefinitions - \enddoublecolumns + \beginnormalitem + \emphasis{\LUA utility libraries}, a subset + of what is provided by the \identifier{lualibs} + package. + + \begindoublecolumns + \begindefinitions + \beginaltitem {l-lua.lua} \endaltitem + \beginaltitem {l-lpeg.lua} \endaltitem + \beginaltitem {l-function.lua} \endaltitem + \beginaltitem {l-string.lua} \endaltitem + \beginaltitem {l-table.lua} \endaltitem + \beginaltitem {l-io.lua} \endaltitem + \beginaltitem {l-file.lua} \endaltitem + \beginaltitem {l-boolean.lua} \endaltitem + \beginaltitem {l-math.lua} \endaltitem + \beginaltitem {util-str.lua} \endaltitem + \enddefinitions + \enddoublecolumns + \endnormalitem + + \beginnormalitem + The \emphasis{font loader} itself. + These files have been written for + \LUATEX-Fonts and they are distributed along + with \identifier{luaotfload}. + \begindoublecolumns + \begindefinitions + \beginaltitem{luatex-basics-gen.lua} \endaltitem + \beginaltitem{luatex-basics-nod.lua} \endaltitem + \beginaltitem{luatex-fonts-enc.lua} \endaltitem + \beginaltitem{luatex-fonts-syn.lua} \endaltitem + \beginaltitem{luatex-fonts-tfm.lua} \endaltitem + \beginaltitem{luatex-fonts-chr.lua} \endaltitem + \beginaltitem{luatex-fonts-lua.lua} \endaltitem + \beginaltitem{luatex-fonts-inj.lua} \endaltitem + \beginaltitem{luatex-fonts-otn.lua} \endaltitem + \beginaltitem{luatex-fonts-def.lua} \endaltitem + \beginaltitem{luatex-fonts-ext.lua} \endaltitem + \beginaltitem{luatex-fonts-cbk.lua} \endaltitem + \enddefinitions + \enddoublecolumns + \endnormalitem + + \beginnormalitem + Code related to \emphasis{font handling and + node processing}, taken directly from + \CONTEXT. + \begindoublecolumns + \begindefinitions + \beginaltitem{data-con.lua} \endaltitem + \beginaltitem{font-ini.lua} \endaltitem + \beginaltitem{font-con.lua} \endaltitem + \beginaltitem{font-cid.lua} \endaltitem + \beginaltitem{font-map.lua} \endaltitem + \beginaltitem{font-oti.lua} \endaltitem + \beginaltitem{font-otf.lua} \endaltitem + \beginaltitem{font-otb.lua} \endaltitem + \beginaltitem{font-ota.lua} \endaltitem + \beginaltitem{font-def.lua} \endaltitem + \beginaltitem{font-otp.lua} \endaltitem + \enddefinitions + \enddoublecolumns + \endnormalitem \enddefinitions Note that if \identifier{luaotfload} cannot locate the @@ -1184,11 +1236,10 @@ files not contained in the merge. Some of these have no equivalent in \endaltitem \endfilelist -\beginfigurefloat +\figurefloat {file-graph} {Schematic of the files in \identifier{Luaotfload}} - \includegraphics[width=\textwidth]{filegraph.pdf} -\endfigurefloat + {filegraph.pdf} \endsection -- cgit v1.2.3 From d0d63530acf762f080e8c6255949398a918bf0bc Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 30 Mar 2014 11:54:45 +0200 Subject: [doc] workaround for inline code in tables --- doc/luaotfload-latex.tex | 6 ++---- doc/luaotfload-main.tex | 15 +++++++++------ 2 files changed, 11 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 409adcf..c886462 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -208,12 +208,10 @@ \usepackage {listings} \lstset { basicstyle=\ttfamily, - escapechar=Ö, } -\def \inlinecode #1{% - \lstinline {#1}% -} +%\let \inlinecode \lstinline +\protected \def \inlinecode {\lstinline} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% codelistings; this sucks hard since we lack access to buffers diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 5b033c0..5e7c1bc 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -757,12 +757,15 @@ Currently (2014) there are three of them: Applies legacy \TEX ligatures: \unless \ifcontextmkiv + %% Using braced arg syntax with inline code appears to be + %% impossible within Latex tables -- just ignore the weird + %% exclamation points below. \begintabulate [rlrl] - \beginrow `` \newcell \inlinecode {``} \newcell '' \newcell \inlinecode {''} \endrow - \beginrow ` \newcell \inlinecode {`} \newcell ' \newcell \inlinecode {'} \endrow - \beginrow " \newcell \inlinecode {"} \newcell -- \newcell \inlinecode {--} \endrow - \beginrow --- \newcell \inlinecode {---} \newcell !` \newcell \inlinecode {!`} \endrow - \beginrow ?` \newcell \inlinecode {?`} \newcell \newcell \endrow + \beginrow `` \newcell {\inlinecode !``! } \newcell '' \newcell {\inlinecode !''!} \endrow + \beginrow ` \newcell {\inlinecode !`! } \newcell ' \newcell {\inlinecode !'! } \endrow + \beginrow " \newcell {\inlinecode !"! } \newcell -- \newcell {\inlinecode !--!} \endrow + \beginrow --- \newcell {\inlinecode !---!} \newcell !` \newcell {\inlinecode ?!`?} \endrow + \beginrow ?` \newcell {\inlinecode !?`! } \newcell \newcell \endrow \endtabulate \else %% XXX find a way to wrap these in the tabulate environment @@ -911,7 +914,7 @@ directories. \begincentered \begintabulate [lp{.5\textwidth}] \beginrow - Windows \newcell \inlinecode {\% WINDIR\%\\ Fonts} + Windows \newcell \inlinecode !\% WINDIR\%\\ Fonts! \endrow \beginrow Linux \newcell \fileent{/usr/local/etc/fonts/fonts.conf} and\hfill\break -- cgit v1.2.3 From 9005dd121c14e97b2fe001a5543596047a9c141b Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 30 Mar 2014 12:01:33 +0200 Subject: =?UTF-8?q?[doc]=20move=20up=20footnote=20concerning=20the=20forme?= =?UTF-8?q?r=20=E2=80=9Ctrep=E2=80=9D=20set?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/luaotfload-main.tex | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index 5e7c1bc..a0df7f0 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -754,7 +754,14 @@ Currently (2014) there are three of them: \endaltitem \beginaltitem {tlig} - Applies legacy \TEX ligatures: + Applies legacy \TEX ligatures\footnote{% + These contain the feature set \inlinecode {trep} of earlier + versions of \identifier{luaotfload}. + + Note to \XETEX users: this is the equivalent of the + assignment \inlinecode {mapping=text-tex} using \XETEX's input + remapping feature. + }: \unless \ifcontextmkiv %% Using braced arg syntax with inline code appears to be @@ -781,15 +788,6 @@ Currently (2014) there are three of them: \stopframed \stopframed \fi - - \footnote{% - These contain the feature set \inlinecode {trep} of earlier - versions of \identifier{luaotfload}. - - Note to \XETEX users: this is the equivalent of the - assignment \inlinecode {mapping=text-tex} using \XETEX's input - remapping feature. - } \endaltitem \beginaltitem {itlc} -- cgit v1.2.3 From 086a3111ea33c65de1e527d4e21e403d489eec23 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 30 Mar 2014 12:39:45 +0200 Subject: [doc] document bisection in manpage --- doc/luaotfload-tool.rst | 66 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 60 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-tool.rst b/doc/luaotfload-tool.rst index 761b0ec..da88b21 100644 --- a/doc/luaotfload-tool.rst +++ b/doc/luaotfload-tool.rst @@ -6,16 +6,16 @@ generate and query the Luaotfload font names database ----------------------------------------------------------------------- -:Date: 2014-01-02 -:Copyright: GPL v2.0 -:Version: 2.5 -:Manual section: 1 -:Manual group: text processing +:Date: 2014-03-30 +:Copyright: GPL v2.0 +:Version: 2.5 +:Manual section: 1 +:Manual group: text processing SYNOPSIS ======================================================================= -**luaotfload-tool** [ -bDfFiIlnpquvVhw ] +**luaotfload-tool** [ -bcDfFiIlLnpqRSuvVhw ] **luaotfload-tool** --update [ --force ] [ --quiet ] [ --verbose ] [ --prefer-texmf ] [ --dry-run ] @@ -32,6 +32,8 @@ SYNOPSIS **luaotfload-tool** --list=CRITERION[:VALUE] [ --fields=F1,F2,...,Fn ] +**luaotfload-tool** --bisect=DIRECTIVE + **luaotfload-tool** --help **luaotfload-tool** --version @@ -187,6 +189,58 @@ font and lookup caches cache; 3) ``show`` -> print stats. +bisection +----------------------------------------------------------------------- +--bisect=DIRECTIVE Bisection of the font database. + This mode is intended as assistance in + debugging the Luatex engine, especially when + tracking memleaks or buggy fonts. + + *DIRECTIVE* can be one of the following: + + 1) ``run`` -> Make ``luaotfload-tool`` respect + the bisection progress when running. + Combined with ``--update`` and possibly + ``--force`` this will only process the files + from the start up until the pivot and ignore + the rest. + 2) ``start`` -> Start bisection: create a + bisection state file and initialize the low, + high, and pivot indices. + 3) ``stop`` -> Terminate the current bisection + session by deleting the state file. + 4) ``good`` | ``bad`` -> Mark the section + processed last as “good” or “bad”, + respectively. The next bisection step will + continue with the bad section. + 5) ``status`` -> Print status information about + the current bisection session. Hint: Use + with higher verbosity settings for more + output. + + A bisection session is initiated by issuing the + ``start`` directive. This sets the pivot to the + middle of the list of available font files. + Now run *luaotfload-tool* with the ``--update`` + flag set as well as ``--bisect=run``: only the + fonts up to the pivot will be considered. If + that task exhibited the issue you are tracking, + then tell Luaotfload using ``--bisect=bad``. + The next step of ``--bisect=run`` will continue + bisection with the part of the files below the + pivot. + Likewise, issue ``--bisect=good`` in order to + continue with the fonts above the pivot, + assuming the tested part of the list did not + trigger the bug. + + Once the culprit font is tracked down, ``good`` + or ``bad`` will have no effect anymore. ``run`` + will always end up processing the single font + file that was left. + Use ``--bisect=stop`` to clear the bisection + state. + miscellaneous ----------------------------------------------------------------------- --verbose=N, -v Set verbosity level to *n* or the number of -- cgit v1.2.3 From 1d53adbda253158348c4e921357114140a54c127 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 30 Mar 2014 12:44:57 +0200 Subject: [doc] group debugging related functionality in manpage --- doc/luaotfload-tool.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-tool.rst b/doc/luaotfload-tool.rst index da88b21..4b1a934 100644 --- a/doc/luaotfload-tool.rst +++ b/doc/luaotfload-tool.rst @@ -21,7 +21,7 @@ SYNOPSIS [ --prefer-texmf ] [ --dry-run ] [ --formats=[+|-]EXTENSIONS ] [ --no-compress ] [ --no-strip ] - [ --local ] + [ --local ] [ --max-fonts=N ] **luaotfload-tool** --find=FONTNAME [ --fuzzy ] [ --info ] [ --inspect ] [ --no-reload ] @@ -69,10 +69,6 @@ update mode with every invocation of ``luaotfload-tool``. --no-reload, -n Suppress auto-updates to the database (e.g. when ``--find`` is passed an unknown name). ---no-strip Do not strip redundant information after - building the database. Warning: this will - inflate the index to about two to three times - the normal size. --no-compress, -c Do not filter the plain text version of the font index through gzip. Useful for debugging if your editor is built without zlib. @@ -80,8 +76,6 @@ update mode --prefer-texmf, -p Organize the file name database in a way so that it prefer fonts in the *TEXMF* tree over system fonts if they are installed in both. ---max-fonts=N Process at most *N* font files, including fonts - already indexed in the count. --formats=EXTENSIONS Extensions of the font files to index. Where *EXTENSIONS* is a comma-separated list of supported file extensions (otf, ttf, ttc, @@ -101,9 +95,6 @@ update mode grow the database considerably and slow down font indexing. ---dry-run, -D Don’t load fonts, scan directories only. - (For debugging file system related issues.) - query mode ----------------------------------------------------------------------- --find=NAME Resolve a font name; this looks up in @@ -127,7 +118,6 @@ query mode library (assumes ``-I``). Automatically enabled if the verbosity level exceeds 2. ---show-blacklist, -b Show blacklisted files (not directories). --list=CRITERION Show entries, where *CRITERION* is one of the following: @@ -189,8 +179,18 @@ font and lookup caches cache; 3) ``show`` -> print stats. -bisection +debugging methods ----------------------------------------------------------------------- +--show-blacklist, -b Show blacklisted files (not directories). +--dry-run, -D Don’t load fonts when updating the database; + scan directories only. + (For debugging file system related issues.) +--no-strip Do not strip redundant information after + building the database. Warning: this will + inflate the index to about two to three times + the normal size. +--max-fonts=N Process at most *N* font files, including fonts + already indexed in the count. --bisect=DIRECTIVE Bisection of the font database. This mode is intended as assistance in debugging the Luatex engine, especially when -- cgit v1.2.3 From d36629e9b1e2bd0f4b0740d3d797534a04edd729 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Thu, 15 May 2014 22:32:38 +0200 Subject: [doc] remove dependency on mdwlist.sty --- doc/luaotfload-latex.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index c886462..3aab22b 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -34,7 +34,7 @@ \makeatletter -\usepackage {metalogo,multicol,mdwlist,fancyvrb,xspace} +\usepackage {metalogo,multicol,fancyvrb,xspace} \usepackage [x11names] {xcolor} \def \primarycolor {DodgerBlue4} %%-> rgb 16 78 139 | #104e8b -- cgit v1.2.3 From d167ce3c9134150a2da2287f162e56690995419e Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Thu, 15 May 2014 22:36:26 +0200 Subject: [doc] remove obsolete paragraph --- doc/luaotfload-main.tex | 3 --- 1 file changed, 3 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index a0df7f0..e4b28dc 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -877,9 +877,6 @@ rebuild of the database. \beginlisting luaotfload-tool --update --force \endlisting -Whenever it is run under this name, it will update the database -first, mimicking the behavior of earlier versions of -\identifier{luaotfload}. \endsubsection -- cgit v1.2.3 From 50e033bd254a087fccbe1a0bcaef208f5e106b2a Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Wed, 4 Jun 2014 22:58:08 +0200 Subject: doc: document user access to font index --- doc/luaotfload-main.tex | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex index e4b28dc..034b704 100644 --- a/doc/luaotfload-main.tex +++ b/doc/luaotfload-main.tex @@ -1412,17 +1412,35 @@ are defined for which scripts. \endsubsubsection +\beginsubsubsection{Database} + %% not implemented, may come back later -% \beginsubsubsection{Database} -% -% \beginfunctionlist +\beginfunctionlist % \beginaltitem {aux.scan_external_dir(dir : string)} % Include fonts in directory \luafunction{dir} in font lookups without % adding them to the database. % -% \endfunctionlist -% -% \endsubsubsection + \beginaltitem {aux.read_font_index (void)} + Read the index file from the appropriate location (usually + the bytecode file \fileent{luaotfload-names.luc} somewhere + in the \fileent{texmf-var} tree) and return the result as a + table. The file is processed with each call so it is up to + the user to store the result for later access. + \endaltitem + + \beginaltitem {aux.font_index (void)} + Return a reference of the font names table used internally + by \identifier{luaotfload}. The index will be read if it + has not been loaded up to this point. Also a font scan that + overwrites the current index file might be triggered. Since + the return value points to the actual index, any + modifications to the table might influence runtime behavior + of \identifier{luaotfload}. + \endaltitem + +\endfunctionlist + +\endsubsubsection \endsubsection \endsection @@ -1440,8 +1458,7 @@ target. % The development takes place on \identifier{github} at \hyperlink {https://github.com/lualatex/luaotfload} where there is an issue -tracker for submitting bug reports, feature requests and the likes -requests and the likes. +tracker for submitting bug reports, feature requests and the likes. Bug reports are more likely to be addressed if they contain the output of -- cgit v1.2.3 From 458e2556a1ea7426735486be11523cba8dff177d Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Wed, 4 Jun 2014 23:16:49 +0200 Subject: doc: fix indentation in listings --- doc/luaotfload-latex.tex | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc') diff --git a/doc/luaotfload-latex.tex b/doc/luaotfload-latex.tex index 3aab22b..34c494d 100644 --- a/doc/luaotfload-latex.tex +++ b/doc/luaotfload-latex.tex @@ -244,9 +244,14 @@ \directlua { local texprint = tex.print + local stringsub = string.sub + local backslash = string.byte (0x5c) document = document or { } document.printlines = function (buffer) for _, line in next, string.explode (buffer, "\noexpand\n") do + if stringsub (line, 1, 1) == " " then + line = backslash .. line + end texprint (-1, line) texprint (-1, "") end -- cgit v1.2.3 From 170f83f02682c3e91e784a303de0efb8e90d133d Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 9 Jun 2014 23:33:57 +0200 Subject: [doc] add skeleton for luaotfloadrc manpage --- doc/luaotfload.conf.rst | 68 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 doc/luaotfload.conf.rst (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst new file mode 100644 index 0000000..932afad --- /dev/null +++ b/doc/luaotfload.conf.rst @@ -0,0 +1,68 @@ +======================================================================= + luaotfload.conf +======================================================================= + Luaotfload configuration +----------------------------------------------------------------------- + +:Date: 2014-06-09 +:Copyright: GPL v2.0 +:Version: 2.5 +:Manual section: 5 +:Manual group: text processing + +SYNOPSIS +======================================================================= + +**XDG_CONFIG_HOME/luaotfload/luaotfload.conf** +**XDG_CONFIG_HOME/luaotfload/luaotfloadrc** +**~/.luaotfloadrc** + +DESCRIPTION +======================================================================= + + +EXAMPLE +======================================================================= + +* TODO, small example snippet + + +SYNTAX +======================================================================= + +* TODO, short intro to ``.ini`` file syntax + +VARIABLES +======================================================================= + +* TODO, list variables + + +FILES +======================================================================= + +* file locations + + +SEE ALSO +======================================================================= + +**luaotfload-tool** (1), **luatex** (1), **lua** (1) + +* ``texdoc luaotfload`` to display the PDF manual for the *Luaotfload* + package +* Luaotfload development ``_ +* LuaLaTeX mailing list ``_ +* LuaTeX ``_ +* Luaotfload on CTAN ``_ + + +AUTHORS +======================================================================= + +*Luaotfload* is maintained by the LuaLaTeX dev team +(``_). + +This manual page was written by Philipp Gesang +. + -- cgit v1.2.3 From fdea22314cb51cf514f6f1004f75b9d6bacafe2d Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 9 Jun 2014 23:47:01 +0200 Subject: [*] add rules for building config man page to makefiles --- doc/Makefile | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile index 9e2d591..ed340a4 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,14 +3,20 @@ DOCPDF = $(NAME).pdf DOCSRC = $(NAME)-latex.tex SCRIPTNAME = luaotfload-tool -MANSOURCE = $(SCRIPTNAME).rst -MANPAGE = $(SCRIPTNAME).1 +TOOLMANSRC = $(SCRIPTNAME).rst +TOOLMAN = $(SCRIPTNAME).1 + +CONFNAME = luaotfload.conf +CONFMANSRC = $(CONFNAME).rst +CONFMAN = $(CONFNAME).5 + +MANPAGES = $(TOOLMAN) $(CONFMAN) GRAPH = filegraph DOTPDF = $(GRAPH).pdf DOT = $(GRAPH).dot -DOCS = $(DOTPDF) $(DOCPDF) $(MANPAGE) +DOCS = $(DOTPDF) $(DOCPDF) $(MANPAGES) DO_LATEXMK = @latexmk -e '$$max_repeat = 5' -pdf -lualatex -silent $< >/dev/null # latexmk does only one run on my machine, so we’re not going to rely on it @@ -19,9 +25,9 @@ DO_GRAPHVIZ = @dot -Tpdf -o $@ $< > /dev/null DO_DOCUTILS = @rst2man $< >$@ 2>/dev/null doc: graph $(DOCPDF) -all: manual doc +all: manuals doc graph: $(DOTPDF) -manual: $(MANPAGE) +manuals: $(TOOLMAN) $(CONFMAN) $(DOCPDF): $(DOCSRC) @echo "creating PDF documentation ($@)" @@ -29,8 +35,12 @@ $(DOCPDF): $(DOCSRC) $(DO_LATEX) mv -f -- $(<:tex=pdf) $@ -$(MANPAGE): $(MANSOURCE) - @echo "creating man page ($(MANPAGE))" +$(TOOLMAN): $(TOOLMANSRC) + @echo "creating man page ($(TOOLMAN))" + $(DO_DOCUTILS) + +$(CONFMAN): $(CONFMANSRC) + @echo "creating man page ($(CONFMAN))" $(DO_DOCUTILS) $(DOTPDF): $(DOT) -- cgit v1.2.3 From 866d0a23432a936f74cd59eee787808f7968f11b Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 9 Jun 2014 23:50:49 +0200 Subject: [doc] make manpage source well-formed reStructuredText --- doc/luaotfload.conf.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index 932afad..bd080d1 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -1,6 +1,8 @@ ======================================================================= luaotfload.conf ======================================================================= + +----------------------------------------------------------------------- Luaotfload configuration ----------------------------------------------------------------------- -- cgit v1.2.3 From 992a8e8b1967486291cc1f480fd3ff83d904576c Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sat, 12 Jul 2014 13:55:04 +0200 Subject: [doc] describe config file search sequence in manpage --- doc/luaotfload.conf.rst | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index bd080d1..eb7788e 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -3,7 +3,7 @@ ======================================================================= ----------------------------------------------------------------------- - Luaotfload configuration + Luaotfload configuration file ----------------------------------------------------------------------- :Date: 2014-06-09 @@ -15,13 +15,16 @@ SYNOPSIS ======================================================================= -**XDG_CONFIG_HOME/luaotfload/luaotfload.conf** -**XDG_CONFIG_HOME/luaotfload/luaotfloadrc** -**~/.luaotfloadrc** +- **./luaotfload{.conf,rc}** +- **XDG_CONFIG_HOME/luaotfload/luaotfload{.conf,rc}** +- **~/.luaotfloadrc** DESCRIPTION ======================================================================= +The file ``luaotfload.conf`` contains configuration options for +*Luaotfload*, a font loading and font management component for LuaTeX. + EXAMPLE ======================================================================= @@ -37,13 +40,27 @@ SYNTAX VARIABLES ======================================================================= + * TODO, list variables FILES ======================================================================= -* file locations +Luaotfload only processes the first configuration file it encounters at +one of the search locations. The file name may be either +``luaotfload.conf`` or ``luaotfloadrc``, except for the dotfile in the +user’s home directory which is expected at ``~/.luaotfloadrc``. + +Configuration files are located following a series of steps. The search +terminates as soon as a suitable file is encountered. The sequence of +locations that Luaotfload looks at is + +i. The current working directory of the LuaTeX process. +ii. The subdirectory ``luaotfload/`` inside the XDG configuration + tree, e. g. ``/home/oenothea/config/luaotfload/``. +iii. The dotfile. +iv. The *TEXMF* (using kpathsea). SEE ALSO @@ -59,6 +76,12 @@ SEE ALSO * Luaotfload on CTAN ``_ +REFERENCES +======================================================================= + +* The XDG base specification + ``_. + AUTHORS ======================================================================= -- cgit v1.2.3 From cff9bd20679420af3e56b43d035f08c03f6a257e Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sat, 12 Jul 2014 22:21:21 +0200 Subject: [doc] describe configuration options --- doc/luaotfload.conf.rst | 176 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 174 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index eb7788e..9c8153a 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -40,8 +40,180 @@ SYNTAX VARIABLES ======================================================================= +Variables in belong into a configuration section and their values must +be of a certain type. Some of them have further constraints. For +example, the “color callback” must be a string of one of the values +``pre_linebreak_filter`` or ``pre_output_filter``, defined in the +section *run*. -* TODO, list variables +Currently, the configuration is organized into four sections: + +db + Options relating to the font index. + +misc + Options without a clearly defined category. + +paths + Path and file name settings. + +run + Options controlling runtime behavior of Luaotfload. + +The list of valid variables, the sections they are part of and their +type is given below. Types represent Lua types that the values must be +convertible to; they are abbreviated as follows: ``s`` for the *string* +type, ``n`` for *number*, ``b`` for *boolean*. A value of ``nil`` means +the variable is unset. + + +Section ``db`` +----------------------------------------------------------------------- + ++---------------+--------+---------------------------+ +| variable | type | default | ++---------------+--------+---------------------------+ +| compress | b | ``true`` | ++---------------+--------+---------------------------+ +| formats | s | ``"otf,ttf,ttc,dfont"`` | ++---------------+--------+---------------------------+ +| max_fonts | n | ``2^51`` | ++---------------+--------+---------------------------+ +| scan_local | b | ``false`` | ++---------------+--------+---------------------------+ +| skip_read | b | ``false`` | ++---------------+--------+---------------------------+ +| strip | b | ``true`` | ++---------------+--------+---------------------------+ +| update_live | b | ``true`` | ++---------------+--------+---------------------------+ + +The flag ``compress`` determines whether the font index (usually +``luaotfload-names.lua[.gz]`` will be stored in compressed forms. +If unset it is equivalent of passing ``--no-compress`` to +**luaotfload-tool**. Since the file is only created for convenience +and has no effect on the runtime behavior of Luaotfload, the flag +should remain set. Most editors come with zlib support anyways. + +The list of ``formats`` must be a comma separated sequence of strings +containing one or more of these elements: + +* ``otf`` (OpenType format), +* ``ttf`` and ``ttc`` (TrueType format), +* ``dfont`` (Macintosh TrueType format), +* ``afm`` (Adobe Font Metrics), +* ``pfb`` and ``pfa`` (PostScript format). + +It corresponds loosely to the ``--formats`` option to +**luaotfload-tool**. Invalid or duplicate members are ignored; if the +list does not contain any useful identifiers, the default list +``"otf,ttf,ttc,dfont"`` will be used. + +The variable ``max_fonts`` determines after processing how many font +files the font scanner will terminate the search. This is useful for +debugging issues with the font index and has the same effect as the +option ``--max-fonts`` to **luaotfload-tools**. + +The ``scan_local`` flag, if set, will incorporate the current working +directory as a font search location. NB: This will potentially slow +down document processing because a font index with local fonts will not +be saved to disk, so these fonts will have to be re-indexed whenever +the document is built. + +The ``skip_read`` flag is only useful for debugging: It makes +Luaotfload skip reading fonts. The font information for rebuilding the +index is taken from the presently existing one. + +Unsetting the ``strip`` flag prevents Luaotfload from removing data +from the index that is only useful when processing font files. NB: this +can increase the size of the index files significantly and has no +effect on the runtime behavior. + +If ``update_live`` is set, Luaotfload will reload the database if it +cannot find a requested font. Those who prefer to update manually using +**luaotfload-tool** should unset this flag. + + +Section ``misc`` +----------------------------------------------------------------------- + ++---------------+--------+-------------------------+ +| variable | type | default | ++---------------+--------+-------------------------+ +| statistics | b | ``false`` | ++---------------+--------+-------------------------+ +| termwidth | n | ``nil`` | ++---------------+--------+-------------------------+ +| version | s | ``luaotfload.version`` | ++---------------+--------+-------------------------+ + +With ``statistics`` enabled, extra statistics will be collected during +index creation and appended to the index file. It may then be queried +at the Lua end or inspected by reading the file itself. + +The value of ``termwidth``, if set, overrides the value retrieved by +querying the properties of the terminal in which Luatex runs. This is +useful if the engine runs with ``shell_escape`` disabled and the actual +terminal dimensions cannot be retrieved. + +The value of ``version`` is derived from the version string hard-coded +in the Luaotfload source. Override at your own risk. + + +Section ``paths`` +----------------------------------------------------------------------- + ++------------------+--------+------------------------------------+ +| variable | type | default | ++------------------+--------+------------------------------------+ +| cache_dir | s | ``"fonts"`` | ++------------------+--------+------------------------------------+ +| names_dir | s | ``"names"`` | ++------------------+--------+------------------------------------+ +| index_file | s | ``"luaotfload-names.lua"`` | ++------------------+--------+------------------------------------+ +| lookups_file | s | ``"luaotfload-lookup-cache.lua"`` | ++------------------+--------+------------------------------------+ + +The paths ``cache_dir`` and ``names_dir`` determine the subdirectory +inside the Luaotfload subtree of the ``luatex-cache`` directory where +the font cache and the font index will be stored, respectively. + +Inside the index directory, the names of the index file and the font +lookup cache will be derived from the respective values of +``index_file`` and ``lookups_file``. This is the filename base for the +bytecode compiled version as well as -- for the index -- the gzipped +version. + + +Section ``run`` +----------------------------------------------------------------------- + ++------------------+--------+------------------------------+ +| variable | type | default | ++------------------+--------+------------------------------+ +| color_callback | s | ``"pre_linebreak_filter"`` | ++------------------+--------+------------------------------+ +| definer | s | ``"patch"`` | ++------------------+--------+------------------------------+ +| log_level | n | ``0`` | ++------------------+--------+------------------------------+ +| resolver | s | ``"cached"`` | ++------------------+--------+------------------------------+ + +The ``color_callback`` option determines the stage at which fonts that +defined with a ``color=xxyyzz`` feature will be colorized. By default +this happens in a ``pre_linebreak_filter`` but alternatively the +``pre_output_filter`` may be chosen, which is faster but might produce +inconsistent output. The latter also was the default in the 1.x series +of Luaotfload. + +The value of ``log_level`` set the default verbosity of messages +printed by Luaotfload. Only messages defined with a verbosity of less +than or equal to the supplied value will be output on the terminal. +At a log level of five Luaotfload can be very noisy. Also, printing too +many messages will slow down the interpreter due to line buffering +being disabled (see **setbuf**\(3)). FILES @@ -66,7 +238,7 @@ iv. The *TEXMF* (using kpathsea). SEE ALSO ======================================================================= -**luaotfload-tool** (1), **luatex** (1), **lua** (1) +**luaotfload-tool**\(1), **luatex**\(1), **lua**\(1) * ``texdoc luaotfload`` to display the PDF manual for the *Luaotfload* package -- cgit v1.2.3 From 992b0150c8182c10cd3415d696bf66c10a381dd7 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 13 Jul 2014 12:19:47 +0200 Subject: [doc] extend documentation of config options in manpage --- doc/luaotfload.conf.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index 9c8153a..f25fc88 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -29,7 +29,7 @@ The file ``luaotfload.conf`` contains configuration options for EXAMPLE ======================================================================= -* TODO, small example snippet + SYNTAX @@ -208,13 +208,27 @@ this happens in a ``pre_linebreak_filter`` but alternatively the inconsistent output. The latter also was the default in the 1.x series of Luaotfload. -The value of ``log_level`` set the default verbosity of messages +The ``definer`` allows for switching the ``define_font`` callback. +Apart from the default ``patch`` one may also choose the ``generic`` +one that comes with the vanilla fontloader. Beware that this might +break tools like Fontspect that rely on the ``patch_font`` callback +provided by Luaotfload to perform important corrections on font data. + +The value of ``log_level`` sets the default verbosity of messages printed by Luaotfload. Only messages defined with a verbosity of less than or equal to the supplied value will be output on the terminal. At a log level of five Luaotfload can be very noisy. Also, printing too many messages will slow down the interpreter due to line buffering being disabled (see **setbuf**\(3)). +The ``resolver`` setting allows choosing the font name resolution +function: With the default value ``cached`` Luaotfload saves the result +of a successful font name request to a cache file to speed up +subsequent lookups. The alternative, ``normal`` circumvents the cache +and resolves every request individually. (Since to the restructuring of +the font name index in Luaotfload 2.4 the performance difference +between the cached and uncached lookups should be marginal.) + FILES ======================================================================= -- cgit v1.2.3 From 42554adf7de06013127c9a2d63431456c82f447f Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 13 Jul 2014 12:52:18 +0200 Subject: [doc] fix variable identifiers --- doc/luaotfload.conf.rst | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index f25fc88..762f412 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -77,15 +77,15 @@ Section ``db`` +---------------+--------+---------------------------+ | formats | s | ``"otf,ttf,ttc,dfont"`` | +---------------+--------+---------------------------+ -| max_fonts | n | ``2^51`` | +| max-fonts | n | ``2^51`` | +---------------+--------+---------------------------+ -| scan_local | b | ``false`` | +| scan-local | b | ``false`` | +---------------+--------+---------------------------+ -| skip_read | b | ``false`` | +| skip-read | b | ``false`` | +---------------+--------+---------------------------+ | strip | b | ``true`` | +---------------+--------+---------------------------+ -| update_live | b | ``true`` | +| update-live | b | ``true`` | +---------------+--------+---------------------------+ The flag ``compress`` determines whether the font index (usually @@ -109,18 +109,18 @@ It corresponds loosely to the ``--formats`` option to list does not contain any useful identifiers, the default list ``"otf,ttf,ttc,dfont"`` will be used. -The variable ``max_fonts`` determines after processing how many font +The variable ``max-fonts`` determines after processing how many font files the font scanner will terminate the search. This is useful for debugging issues with the font index and has the same effect as the option ``--max-fonts`` to **luaotfload-tools**. -The ``scan_local`` flag, if set, will incorporate the current working +The ``scan-local`` flag, if set, will incorporate the current working directory as a font search location. NB: This will potentially slow down document processing because a font index with local fonts will not be saved to disk, so these fonts will have to be re-indexed whenever the document is built. -The ``skip_read`` flag is only useful for debugging: It makes +The ``skip-read`` flag is only useful for debugging: It makes Luaotfload skip reading fonts. The font information for rebuilding the index is taken from the presently existing one. @@ -129,7 +129,7 @@ from the index that is only useful when processing font files. NB: this can increase the size of the index files significantly and has no effect on the runtime behavior. -If ``update_live`` is set, Luaotfload will reload the database if it +If ``update-live`` is set, Luaotfload will reload the database if it cannot find a requested font. Those who prefer to update manually using **luaotfload-tool** should unset this flag. @@ -166,22 +166,22 @@ Section ``paths`` +------------------+--------+------------------------------------+ | variable | type | default | +------------------+--------+------------------------------------+ -| cache_dir | s | ``"fonts"`` | +| cache-dir | s | ``"fonts"`` | +------------------+--------+------------------------------------+ -| names_dir | s | ``"names"`` | +| names-dir | s | ``"names"`` | +------------------+--------+------------------------------------+ -| index_file | s | ``"luaotfload-names.lua"`` | +| index-file | s | ``"luaotfload-names.lua"`` | +------------------+--------+------------------------------------+ -| lookups_file | s | ``"luaotfload-lookup-cache.lua"`` | +| lookups-file | s | ``"luaotfload-lookup-cache.lua"`` | +------------------+--------+------------------------------------+ -The paths ``cache_dir`` and ``names_dir`` determine the subdirectory +The paths ``cache-dir`` and ``names-dir`` determine the subdirectory inside the Luaotfload subtree of the ``luatex-cache`` directory where the font cache and the font index will be stored, respectively. Inside the index directory, the names of the index file and the font lookup cache will be derived from the respective values of -``index_file`` and ``lookups_file``. This is the filename base for the +``index-file`` and ``lookups-file``. This is the filename base for the bytecode compiled version as well as -- for the index -- the gzipped version. @@ -192,16 +192,16 @@ Section ``run`` +------------------+--------+------------------------------+ | variable | type | default | +------------------+--------+------------------------------+ -| color_callback | s | ``"pre_linebreak_filter"`` | +| color-callback | s | ``"pre_linebreak_filter"`` | +------------------+--------+------------------------------+ | definer | s | ``"patch"`` | +------------------+--------+------------------------------+ -| log_level | n | ``0`` | +| log-level | n | ``0`` | +------------------+--------+------------------------------+ | resolver | s | ``"cached"`` | +------------------+--------+------------------------------+ -The ``color_callback`` option determines the stage at which fonts that +The ``color-callback`` option determines the stage at which fonts that defined with a ``color=xxyyzz`` feature will be colorized. By default this happens in a ``pre_linebreak_filter`` but alternatively the ``pre_output_filter`` may be chosen, which is faster but might produce @@ -214,7 +214,7 @@ one that comes with the vanilla fontloader. Beware that this might break tools like Fontspect that rely on the ``patch_font`` callback provided by Luaotfload to perform important corrections on font data. -The value of ``log_level`` sets the default verbosity of messages +The value of ``log-level`` sets the default verbosity of messages printed by Luaotfload. Only messages defined with a verbosity of less than or equal to the supplied value will be output on the terminal. At a log level of five Luaotfload can be very noisy. Also, printing too -- cgit v1.2.3 From 18aceb2612c0352535aa07ca9628d9cbc5285c19 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 13 Jul 2014 13:02:17 +0200 Subject: [doc] add short example file to configuration man page --- doc/luaotfload.conf.rst | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index 762f412..561ca97 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -29,7 +29,33 @@ The file ``luaotfload.conf`` contains configuration options for EXAMPLE ======================================================================= - +A small Luaotfload configuration file with few customizations could +look as follows: :: + + [db] + formats = afm, pfa, pfb + compress = false + + [misc] + termwidth = 60 + + [run] + log-level = 6 + +This will make Luaotfload ignore all font files except for PostScript +formats. NB: With a default Tex Live install the PS fonts will take +much longer to index than OpenType or TrueType ones. Also, an +uncompressed index file will be dumped which is going to be much larger +due to the huge amount of PostScript fonts indexed. The terminal width +is truncated to 60 characters which influences the verbose output +during indexing. Finally, the verbosity is increased greatly: each font +file being processed will be printed to the stdout on a separate line, +along with lots of other information. + +To observe the difference in behavior, save above snippet to +``./luaotfload.conf`` and update the font index: :: + + luaotfload --update --force SYNTAX -- cgit v1.2.3 From dcbfa2c743d14a60037ac3c61f0d7cba339696cd Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 13 Jul 2014 13:17:18 +0200 Subject: [conf] add example configuration file --- doc/luaotfload.conf.example | 30 ++++++++++++++++++++++++++++++ doc/luaotfload.conf.rst | 2 +- 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 doc/luaotfload.conf.example (limited to 'doc') diff --git a/doc/luaotfload.conf.example b/doc/luaotfload.conf.example new file mode 100644 index 0000000..ddf438e --- /dev/null +++ b/doc/luaotfload.conf.example @@ -0,0 +1,30 @@ +;; Example configuration file for Luaotfload. This file contains the +;; defaults only. + +[db] + compress = true + formats = otf, ttf, ttc, dfont + max-fonts = 2.2517998136852e15 + scan-local = false + skip-read = false + strip = true + update-live = true + +[misc] + statistics = false + termwidth = nil + +[paths] + cache-dir = fonts + names-dir = names + index-file = luaotfload-names.lua + lookups-file = luaotfload-lookup-cache.lua + +[run] + color-callback = pre_linebreak_filter + definer = patch + log-level = 0 + resolver = cached + +;; vim:ft=dosini:et:sw=4:ts=8 + diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index 561ca97..9940be2 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -170,7 +170,7 @@ Section ``misc`` +---------------+--------+-------------------------+ | termwidth | n | ``nil`` | +---------------+--------+-------------------------+ -| version | s | ``luaotfload.version`` | +| version | s | | +---------------+--------+-------------------------+ With ``statistics`` enabled, extra statistics will be collected during -- cgit v1.2.3 From 16242a76f163e8b5b3d3ddc9076d4b0933e9441f Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 13 Jul 2014 13:17:43 +0200 Subject: [conf] add example configuration file --- doc/luaotfload.conf.example | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/luaotfload.conf.example b/doc/luaotfload.conf.example index ddf438e..2756d62 100644 --- a/doc/luaotfload.conf.example +++ b/doc/luaotfload.conf.example @@ -1,5 +1,5 @@ ;; Example configuration file for Luaotfload. This file contains the -;; defaults only. +;; defaults only, see luaotfload.conf(5) for more information. [db] compress = true -- cgit v1.2.3 From f66b2ffe8fdc30e517d00b4796c142acd0e4438d Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 13 Jul 2014 15:15:46 +0200 Subject: [doc] describe feature settings and config file syntax in manpage --- doc/luaotfload.conf.rst | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index 9940be2..774095b 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -61,7 +61,29 @@ To observe the difference in behavior, save above snippet to SYNTAX ======================================================================= -* TODO, short intro to ``.ini`` file syntax +The configuration file syntax follows the common INI format. For a more +detailed description please refer to the section “CONFIGURATION FILE” +of **git-config**\(1). A brief list of rules is given below: + + * Blank lines and lines starting with a semicolon (``;``) are ignored. + + * A configuration file is partitioned into sections that are declared + by specifying the section title in brackets on a separate line: :: + + [some-section] + ... section content ... + + * Sections consist of one or more variable assignments of the form + ``variable-name = value`` E. g.:: + + [foo] + bar = baz + quux = xyzzy + ... + + * Section and variable names may contain only uppercase and lowercase + letters as well as dashes (``-``). + VARIABLES ======================================================================= @@ -160,6 +182,26 @@ cannot find a requested font. Those who prefer to update manually using **luaotfload-tool** should unset this flag. +Section ``default-features`` +----------------------------------------------------------------------- + +By default Luaotfload enables ``node`` mode and picks the default font +features that are prescribed in the OpenType standard. This behavior +may be overridden in the ``default-features`` section. Global defaults +that will be applied for all scripts can be set via the ``global`` +option, others by the script they are to be applied to. For example, +a setting of :: + + [default-features] + global = mode=base,color=0000FF + dflt = smcp,onum + +would force *base* mode, tint all fonts blue and activate small +capitals and text figures globally. Features are specified as a comma +separated list of variables or variable-value pairs. Variables without +an explicit value are set to ``true``. + + Section ``misc`` ----------------------------------------------------------------------- -- cgit v1.2.3