From 0af0572634ce4616e9f995d0b813686aa7b9700d Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 11 Feb 2011 19:54:48 +0000 Subject: new lualatex package luaindex (9feb11) git-svn-id: svn://tug.org/texlive/trunk@21373 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/lualatex/luaindex/README | 42 + .../doc/lualatex/luaindex/luaindex-example.ldx | 22 + .../doc/lualatex/luaindex/luaindex-example.ltx | 80 + .../doc/lualatex/luaindex/luaindex-example.pdf | Bin 0 -> 48304 bytes .../texmf-dist/doc/lualatex/luaindex/luaindex.ltx | 65 + .../texmf-dist/doc/lualatex/luaindex/luaindex.pdf | Bin 0 -> 121227 bytes Master/texmf-dist/scripts/luaindex/luaindex.lua | 329 +++++ .../source/lualatex/luaindex/luaindex.dtx | 1554 ++++++++++++++++++++ .../texmf-dist/tex/lualatex/luaindex/luaindex.sty | 247 ++++ Master/tlpkg/bin/tlpkg-ctan-check | 2 +- Master/tlpkg/libexec/ctan2tds | 3 + Master/tlpkg/tlpsrc/collection-luatex.tlpsrc | 1 + Master/tlpkg/tlpsrc/luaindex.tlpsrc | 0 13 files changed, 2344 insertions(+), 1 deletion(-) create mode 100644 Master/texmf-dist/doc/lualatex/luaindex/README create mode 100644 Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ldx create mode 100644 Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ltx create mode 100644 Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.pdf create mode 100644 Master/texmf-dist/doc/lualatex/luaindex/luaindex.ltx create mode 100644 Master/texmf-dist/doc/lualatex/luaindex/luaindex.pdf create mode 100755 Master/texmf-dist/scripts/luaindex/luaindex.lua create mode 100644 Master/texmf-dist/source/lualatex/luaindex/luaindex.dtx create mode 100644 Master/texmf-dist/tex/lualatex/luaindex/luaindex.sty create mode 100644 Master/tlpkg/tlpsrc/luaindex.tlpsrc diff --git a/Master/texmf-dist/doc/lualatex/luaindex/README b/Master/texmf-dist/doc/lualatex/luaindex/README new file mode 100644 index 00000000000..e44fa768213 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/luaindex/README @@ -0,0 +1,42 @@ +LuaLaTeX package luaindex +Copyright (c) Markus Kohm, 2011 + +This file is part of the luaTeX package `luaindex'. + +This work may be distributed and/or modified under the conditions of +the LaTeX Project Public License, version 1.3c of the license. +The latest version of this license is in + http://www.latex-project.org/lppl.txt +and version 1.3c or later is part of all distributions of LaTeX +version 2005/12/01 or later and of this work. + +This work has the LPPL maintenance status "maintained". + +The Current Maintainer and author of this work is Markus Kohm. + +This work consists of the files `luaindex.dtx' and `README'. + +============================================================================ + +luaindex is another index processor written in Lua. Currently usage of +LuaLaTeX is provided only, but plainLuaTeX, ConTeXt or other formats may +follow. + +luaindex provides more than one index. Like SplitIndex it needs only one +help file for all produced indexes. + +============================================================================ + +Note: This is an alpha version! +For additional version information see `lualatex.dtx.' + +============================================================================ + +To produce the package, the examples, and the manual from `luaindex.dtx' +you have to run + + lualatex --shell-escape luaindex.dtx + +simply. + +============================================================================ diff --git a/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ldx b/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ldx new file mode 100644 index 00000000000..65e4e8a57be --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ldx @@ -0,0 +1,22 @@ +os.setlocale("de_DE","collate") +koma.luaindex.insert("general", "{{3}}", "B ist der zweite Buchstabe", "B ist der zweite Buchstabe") +koma.luaindex.insert("general", "{{3}}", "aber ist ein Wort", "aber ist ein Wort") +koma.luaindex.insert("general", "{{3}}", "D ist der vierte Buchstabe", "D ist der vierte Buchstabe") +koma.luaindex.insert("general", "{{3}}", "A ist der erste Buchstabe", "A ist der erste Buchstabe") +koma.luaindex.insert("general", "{{3}}", "A ist der erste Buchstabe", "A ist der erste Buchstabe") +koma.luaindex.insert("general", "{{3}}", "C ist \"`der\"\' dritte Buchstabe", "C ist \"`der\"\' dritte Buchstabe") +koma.luaindex.insert("general", "{{3}}", "X ist der drittletzte Buchstabe", "X ist der drittletzte Buchstabe") +koma.luaindex.insert("general", "{{3}}", "\\textbf {D} ist der Buchstabe nach C", "\\textbf {D} ist der Buchstabe nach C") +koma.luaindex.insert("general", "{{3}}", "Y ist der \\textbf {vorletzte} Buchstabe", "Y ist der \\textbf {vorletzte} Buchstabe") +koma.luaindex.insert("general", "{{3}}", "Z ist der letzte Buchstabe", "Z ist der letzte Buchstabe") +koma.luaindex.insert("general", "{{3}}", "Ä ist auch ein Buchstabe", "Ä ist auch ein Buchstabe") +koma.luaindex.insert("general", "{\\emph {3}}", "Ä ist aber auch ein Buchstabe", "Ä ist wirklich auch ein Buchstabe (und hier stimmt die Sortierung nicht -- \\emph {aber eigentlich doch})") +koma.luaindex.insert("general", "{{4}}", "A ist der erste Buchstabe", "A ist der erste Buchstabe") +koma.luaindex.insert("general", "{{4}}", "Ae ist kein Buchstabe, sondern zwei", "Ae ist kein Buchstabe, sondern zwei") +koma.luaindex.insert("general", "{{4}}", "Diverses", "Diverses", + "Untereintrag", "Untereintrag") +koma.luaindex.insert("general", "{{4}}", "Diverses", "Diverses", + "Obereintrag", "Obereintrag") +koma.luaindex.insert("general", "{{4}}", "Diverses", "Diverses", + "Untereintrag", "Untereintrag", + "Unteruntereintrag", "Unteruntereintrag") diff --git a/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ltx b/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ltx new file mode 100644 index 00000000000..810d50fe956 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.ltx @@ -0,0 +1,80 @@ +%% +%% This is file `luaindex-example.ltx', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% luaindex.dtx (with options: `example') +%% +%% Copyright (c) 2011 by Markus Kohm +%% +%% This file was generated from file(s) of luaindex distribution. +%% -------------------------------------------------------------- +%% +%% This work may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License, version 1.3c of the license. +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3c or later is part of all distributions of LaTeX +%% version 2005/12/01 or later and of this work. +%% +%% This work has the LPPL maintenance status "maintained". +%% +%% The Current Maintainer and author of this work is Markus Kohm. +%% +%% This file may only be distributed together with the files listed in +%% `luaindex.dtx'. You may however distribute the files listed in +%% `luaindex.dtx' without this file. +%% +%% NOTE: THIS IS AN ALPHA-VERSION! +%% +\NeedsTeXFormat{LaTeX2e}[1995/06/01] +\ProvidesFile{luaindex-example.ltx} +\documentclass{article} +\usepackage[ngerman]{babel} +\usepackage{blindtext} +\usepackage{fontspec} +\usepackage[ + locale=de_DE, + singlepass % Wenn der Index ohnehin eine neue Seite produziert, + % dann kann er direkt beim ersten Lauf ein korrektes + % Ergebnis liefern. +]{luaindex} +\makeindex +\directlua{koma.luaindex.presortreplace('general',0, + '\luatexluaescapestring{\string\textbf}\space*\string\{([\string^\string\}]*)\string\}','\%1')} +\begin{document} + +\blindtext[10] +A\index{B ist der zweite Buchstabe} +aber\index{aber ist ein Wort} +D\index{D ist der vierte Buchstabe} +A\index{A ist der erste Buchstabe} +A\index{A ist der erste Buchstabe} +C\index{C ist "`der"' dritte Buchstabe} +X\index{X ist der drittletzte Buchstabe} +D\index{\textbf{D} ist der Buchstabe nach C} +Y\index{Y ist der \textbf{vorletzte} Buchstabe} +Z\index{Z ist der letzte Buchstabe} +A\index{Ä ist auch ein Buchstabe} +Ä\index[sort={Ä ist aber auch ein Buchstabe},% + pageformat=\emph]{Ä ist wirklich auch + ein Buchstabe (und hier stimmt die Sortierung + nicht -- \emph{aber eigentlich doch})} +\clearpage + +A\index{A ist der erste Buchstabe} +Ae\index{Ae ist kein Buchstabe, sondern zwei} + +Kompliziert\subindex{Diverses}{Untereintrag} +Noch komplizierter\subindex{Diverses}{Obereintrag} +Noch komplizierter\% +subindex{Diverses}[sort=Obereintra,pageformat=\emph]{Untereintrag} +Noch komplizierter% +\subsubindex{Diverses}{Untereintrag}{Unteruntereintrag} + +\printindex +\end{document} +\endinput +%% +%% End of file `luaindex-example.ltx'. diff --git a/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.pdf b/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.pdf new file mode 100644 index 00000000000..ad466e92eea Binary files /dev/null and b/Master/texmf-dist/doc/lualatex/luaindex/luaindex-example.pdf differ diff --git a/Master/texmf-dist/doc/lualatex/luaindex/luaindex.ltx b/Master/texmf-dist/doc/lualatex/luaindex/luaindex.ltx new file mode 100644 index 00000000000..55a69b7d372 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/luaindex/luaindex.ltx @@ -0,0 +1,65 @@ +%% +%% This is file `luaindex.ltx', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% luaindex.dtx (with options: `manual') +%% +%% Copyright (c) 2011 by Markus Kohm +%% +%% This file was generated from file(s) of luaindex distribution. +%% -------------------------------------------------------------- +%% +%% This work may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License, version 1.3c of the license. +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3c or later is part of all distributions of LaTeX +%% version 2005/12/01 or later and of this work. +%% +%% This work has the LPPL maintenance status "maintained". +%% +%% The Current Maintainer and author of this work is Markus Kohm. +%% +%% This file may only be distributed together with the files listed in +%% `luaindex.dtx'. You may however distribute the files listed in +%% `luaindex.dtx' without this file. +%% +%% NOTE: THIS IS AN ALPHA-VERSION! +%% +\ProvidesFile{luaindex.ltx} + [2011/02/09 v0.1a LuaLaTeX Package + documentation: + index processor]% +\documentclass{scrdoc} +\usepackage{tabularx} +\usepackage[english]{babel} +\usepackage{xcolor} +\colorlet{mcode}{teal} +\usepackage{fontspec} +\providecommand*{\LuaTeX}{Lua\kern-.125em\TeX} +\providecommand*{\LuaLaTeX}{Lua\kern-.025em\LaTeX} +\CodelineIndex +\RecordChanges +\GetFileInfo{luaindex.ltx} +\title{% + Usage of\\ + \LuaTeX{} module \texttt{koma.luaindex}\\ + and\\ + \LuaLaTeX{} Package \texttt{luaindex}\\ + for Generating Indexes\\ +} +\date{\fileversion} +\author{Markus Kohm\thanks{komascript% +@% +gmx% +.% +info}} +\begin{document} +\maketitle +\DocInput{luaindex.dtx} +\end{document} +\endinput +%% +%% End of file `luaindex.ltx'. diff --git a/Master/texmf-dist/doc/lualatex/luaindex/luaindex.pdf b/Master/texmf-dist/doc/lualatex/luaindex/luaindex.pdf new file mode 100644 index 00000000000..66404d7f5fe Binary files /dev/null and b/Master/texmf-dist/doc/lualatex/luaindex/luaindex.pdf differ diff --git a/Master/texmf-dist/scripts/luaindex/luaindex.lua b/Master/texmf-dist/scripts/luaindex/luaindex.lua new file mode 100755 index 00000000000..054cba020e0 --- /dev/null +++ b/Master/texmf-dist/scripts/luaindex/luaindex.lua @@ -0,0 +1,329 @@ +--- +--- This is file `luaindex.lua', +--- generated with the docstrip utility. +--- +--- The original source files were: +--- +--- luaindex.dtx (with options: `lua') +--- +--- Copyright (c) 2011 by Markus Kohm +--- +--- This file was generated from file(s) of luaindex distribution. +--- -------------------------------------------------------------- +--- +--- This work may be distributed and/or modified under the conditions of +--- the LaTeX Project Public License, version 1.3c of the license. +--- The latest version of this license is in +--- http://www.latex-project.org/lppl.txt +--- and version 1.3c or later is part of all distributions of LaTeX +--- version 2005/12/01 or later and of this work. +--- +--- This work has the LPPL maintenance status "maintained". +--- +--- The Current Maintainer and author of this work is Markus Kohm. +--- +--- This file may only be distributed together with the files listed in +--- `luaindex.dtx'. You may however distribute the files listed in +--- `luaindex.dtx' without this file. +--- +--- NOTE: THIS IS AN ALPHA-VERSION! +--- +module("koma.luaindex", package.seeall) +local indexes = {} +function newindex( indexname ) + indexes[indexname]={ presortreplaces = {}, + sortorderbychar = {} } +end +function sortorder( indexname, sortorder ) + local i, value + local index = indexes[indexname] + if index == nil then + tex.error( "Unknown index `" .. indexname .. "'", + { "You've tried to add a new sortorder to an index, but there's no index with the", + "given name.", + "You should define the index using lua function ", + " `koma.luaindex.newindex(\"" .. indexname .. "\")'", + "before." + } + ) + else + if type(sortorder) == "string" then + local value + i = 1 + repeat + value = unicode.utf8.sub( sortorder, i, i ) + if value then + index.sortorderbychar[value] = i + end + i = i + 1 + until value == "" + else -- should be table + for i, value in ipairs( sortorder ) do + index.sortorderbychar[value] = i + end + end + end +end +function presortreplace( indexname, pass, pattern, replace ) + local n + local index = indexes[indexname] + if index == nil then + tex.error( "Unknown index `" .. indexname .. "'", + { "You've tried to add a new presort-replace to an index, but there's no index", + "with the given name.", + "You should define the index using lua function ", + " `koma.luaindex.newindex(\"" .. indexname .. "\")'", + "before." + } + ) + else + for n = table.maxn(index.presortreplaces), pass, 1 do + if ( index.presortreplaces[n] == nil ) then + index.presortreplaces[n] = {} + end + end + index.presortreplaces[pass][pattern]=replace + end +end +local function getclass( utfc ) + local i + for i in unicode.utf8.gmatch( utfc, "%n" ) do + return 2 + end + for i in unicode.utf8.gmatch( utfc, "%a" ) do + return 3 + end + return 1 +end +local function do_presortreplaces( srcstr, presortreplace ) + if presortreplace then + local pat, rep + for pat, rep in pairs( presortreplace ) do + srcstr = unicode.utf8.gsub( srcstr, pat, rep ) + end + end + return srcstr +end +local function printsubindex( level, index, presortreplace_zero ) + local i,t,n,p,l + local group="" + local class=-1 + local item="\\" + for l = 1, level, 1 do + item = item .. "sub" + end + item = item .. "item " + for i,t in ipairs( index ) do + if ( level == 0 ) then + local sort=do_presortreplaces( t["sort"], presortreplace_zero ) + local firstchar=unicode.utf8.upper( unicode.utf8.sub( sort, 1, 1 ) ) + if ( firstchar ~= group ) then + local newclass + newclass=getclass( firstchar ) + if ( newclass == 1 and class ~= newclass ) then + tex.print( "\\indexgroup{\\symbolsname}" ) + elseif ( newclass == 3 ) then + tex.print( "\\indexgroup{" .. firstchar .. "}" ) + elseif ( newclass == 2 and class ~= newclass ) then + tex.print( "\\indexgroup{\\numbersname}" ) + end + group=firstchar + class=newclass + end + end + tex.sprint( item, t["value"] ) + if t["pages"] then + tex.sprint( "\\indexpagenumbers{" ) + for n,p in ipairs( t["pages"] ) do + tex.sprint( "\\indexpagenumber{", p, "}" ) + end + tex.print( "}" ) + end + if t["subindex"] then + printsubindex( level+1, t["subindex"], presortreplaces_zero ) + end + end +end +function printindex( indexname ) + local index=indexes[indexname] + if index == nil then + tex.error( "Unknown index `" .. indexname .. "'", + { "You've tried to print an index, but there's no index with the", + "given name.", + "You should define the index using lua function ", + " `koma.luaindex.newindex(\"" .. indexname .. "\")'", + "before." + } + ) + else + print( "Index: \"" .. indexname .. "\" with " .. table.maxn( index ) .. " level-0-entries" ) + tex.print( "\\begin{theindex}" ) + printsubindex(0,indexes[indexname],indexes[indexname].presortreplaces[0]) + tex.print( "\\end{theindex}" ) + end +end +local function getsubclass( utfc ) + local i + for i in unicode.utf8.gmatch( utfc, "%l" ) do + return 1 + end + for i in unicode.utf8.gmatch( utfc, "%u" ) do + return 2 + end + for i in unicode.utf8.gmatch( utfc, "%c" ) do + return 1 + end + for i in unicode.utf8.gmatch( utfc, "%s" ) do + return 2 + end + for i in unicode.utf8.gmatch( utfc, "%p" ) do + return 3 + end + for i in unicode.utf8.gmatch( utfc, "%n" ) do + return 4 + end + return 10 -- unkown is the biggest sub class +end +local function do_strcmp( first, second, sortorderbychar ) + local secondtable = string.explode( second, "" ) + local firstutf + local n = 1 + for firstutf in string.utfcharacters( first ) do + local secondutf = unicode.utf8.sub( second, n, n ) + n = n + 1; + if firstutf then + if secondutf ~= "" then + if firstutf ~= secondutf then + local firstn, secondn + if sortorderbychar then + firstn = sortorderbychar[firstutf] + secondn = sortorderbychar[secondutf] + end + if firstn and secondn then + if firstn < secondn then + return -1 + elseif firstn > secondn then + return 1 + end + else + local firstclass = getclass( firstutf ) + local secondclass = getclass( secondutf ) + if firstclass < secondclass then + return -1 + elseif firstclass == secondclass then + local firstsubclass = getsubclass( firstutf) + local secondsubclass = getsubclass( secondutf ) + if firstsubclass < secondsubclass then + return -1 + elseif firstsubclass == secondsubclass then + if firstutf < secondutf then + return -1 + else + return 1 + end + else + return 1 + end + else + return 1 + end + end + end + else + return 1 + end + else + if secondutf ~= "" then + return -1 + else + return 0 -- This should never happen! + end + end + end + if unicode.utf8.sub( second, n, n ) ~= "" then + return -1 + else + return 0 + end +end +local function do_indexcmp( firstsort, secondsort, + presortreplaces, sortorderbychar ) + local pass = 0 + local ncmp = 0 + repeat + if presortreplaces and presortreplaces[pass] then + firstsort = do_presortreplaces( firstsort, presortreplaces[pass] ) + secondsort = do_presortreplaces( secondsort, presortreplaces[pass] ) + end + pass = pass + 1 + ncmp = do_strcmp( firstsort, secondsort, sortorderbychar ) + until ( ncmp ~= 0 ) or ( pass > table.maxn( presortreplaces ) ) + return ncmp +end +local function subinsert( index, presortreplaces, sortorderbychar, + pagestring, sortvalue, outputvalue, ... ) + local min = 1 + local max = table.maxn(index) + local updown = 0 + + local n = math.ceil(( min + max ) / 2) + while min <= max do + updown = do_indexcmp( sortvalue, index[n].sort, + presortreplaces, sortorderbychar ) + if updown == 0 then + if outputvalue == index[n].value then + if ( ... ) then + if ( index[n].subindex == nil ) then + index[n].subindex = {} + end + subinsert( index[n].subindex, presortreplaces, sortorderbychar, + pagestring, ... ) + else + local i, p + for i, p in ipairs( index[n].pages ) do + if pagestring == p then + return + end + end + table.insert( index[n].pages, pagestring ) + end + return + else + repeat + n = n + 1 + if n <= max then + updown = do_indexcmp( sortvalue, index[min].sort, + presortreplaces, sortorderbychar ) + end + until n > max or updown ~= 0 + min = n + max = n-1 + end + elseif updown > 0 then + min = n+1 + else + max = n-1 + end + n = math.ceil(( min + max ) / 2) + end + if ( ... ) then + table.insert( index, n, + { sort=sortvalue, value=outputvalue, subindex={} } ) + subinsert( index[n].subindex, presortreplaces, sortorderbychar, + pagestring, ... ) + else + table.insert( index, n, + { sort=sortvalue, value=outputvalue, pages={pagestring} } ) + end +end +function insert( indexname, pagestring, sortvalue, outputvalue, ... ) + local index=indexes[indexname] + subinsert( index, index.presortreplaces, index.sortorderbychar, + pagestring, sortvalue, outputvalue, ... ) +end +function removeentries( indexname ) + local p = indexes[indexname].presortreplaces + local s = indexes[indexname].sortorderbychar + indexes[indexname]={ presortreplaces = p, + sortorderbychar = s } +end diff --git a/Master/texmf-dist/source/lualatex/luaindex/luaindex.dtx b/Master/texmf-dist/source/lualatex/luaindex/luaindex.dtx new file mode 100644 index 00000000000..219571170eb --- /dev/null +++ b/Master/texmf-dist/source/lualatex/luaindex/luaindex.dtx @@ -0,0 +1,1554 @@ +% \CheckSum{405} +% \iffalse meta-comment +% ========================================================================== +% luaindex.dtx +% Copyright (c) Markus Kohm, 2011 +% +% This file is part of the luaTeX package `luaindex'. +% +% This work may be distributed and/or modified under the conditions of +% the LaTeX Project Public License, version 1.3c of the license. +% The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3c or later is part of all distributions of LaTeX +% version 2005/12/01 or later and of this work. +% +% This work has the LPPL maintenance status "maintained". +% +% The Current Maintainer and author of this work is Markus Kohm. +% +% This work consists of the files `luaindex.dtx' and `README'. +% ========================================================================== +% \fi^^A meta-comment +% +% \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 \~} +% +% \iffalse meta-comment +%<*dtx|ins> +\def\batchfile{luaindex.dtx} +\input docstrip.tex +\ifToplevel{% + \Msg{********************************************************************} + \Msg{*} + \Msg{* Steps of luaindex generation:} + \Msg{* =============================} + \Msg{*} + \Msg{* - Generation of all needed files:} + \keepsilent + \askforoverwritefalse +} +{ +\obeyspaces\obeylines +\global\def\preambletext{ +\space +Copyright (c) 2011 by Markus Kohm + +This file was generated from file(s) of luaindex distribution. +-------------------------------------------------------------- + +This work may be distributed and/or modified under the conditions of +the LaTeX Project Public License, version 1.3c of the license. +The latest version of this license is in + http://www.latex-project.org/lppl.txt +and version 1.3c or later is part of all distributions of LaTeX +version 2005/12/01 or later and of this work. + +This work has the LPPL maintenance status "maintained". + +The Current Maintainer and author of this work is Markus Kohm. + +This file may only be distributed together with the files listed in +`luaindex.dtx'. You may however distribute the files listed in +`luaindex.dtx' without this file. + +NOTE: THIS IS AN ALPHA-VERSION! +} +} +\expandafter\preamble +\preambletext +\endpreamble +\def\ThreeHyphens{---} +\let\MetaPrefix\ThreeHyphens +\expandafter\declarepreamble\expandafter\luapreamble +\preambletext +\endpreamble + +\generate{% + \let\MetaPrefix\DoubleperCent + \usepreamble\defaultpreamble + \file{luaindex.ltx}{\from{luaindex.dtx}{manual}}% + \file{luaindex.sty}{\from{luaindex.dtx}{package}}% + \file{luaindex-example.ltx}{\from{luaindex.dtx}{example}}% + \let\MetaPrefix\ThreeHyphens + \usepreamble\luapreamble + \nopostamble + \file{luaindex.lua}{\from{luaindex.dtx}{lua}}% +} + +\ifToplevel{% + \Msg{* \space\space done.} + \Msg{* - Generation of examples:} + \directlua{% + local retval = os.execute( "lualatex --jobname=luaindex-example + --interaction=batchmode luaindex-example.ltx" ); + if ( retval == nil ) then + tex.error( "Shell escape not enabled!", + { "You should try", + " `luatex --shell-escape --jobname=luaindex luaindex.dtx'", + "to enable shell escape.", + "Otherwise you will get no example." } ) + elseif ( retval == 0 ) then + else + tex.error( "Failed to generate the example", + { "I've tried to call", + " `lualatex --jobname=luaindex luaindex-example.ltx'", + "but got unexpected return value:", + retval } + ) + end + }% +} + +\ifToplevel{% + \Msg{* \space\space implemented not yet.} + \Msg{* - Generation of manual:} + \directlua{% + local retval = os.execute( "lualatex --jobname=luaindex + --interaction=batchmode luaindex.ltx" ); + if ( retval == 0 ) then + retval = os.execute( "lualatex --jobname=luaindex + --interaction=batchmode luaindex.ltx" ); + end + if ( retval == 0 ) then + retval = os.execute( "makeindex -q -s gind.ist luaindex" ); + end + if ( retval == 0 ) then + retval = os.execute( "makeindex -q -s gglo.ist + -o luaindex.gls luaindex.glo" ); + end + if ( retval == 0 ) then + retval = os.execute( "lualatex --jobname=luaindex + --interaction=batchmode luaindex.ltx" ); + end + if ( retval == nil ) then + tex.error( "Shell escape not enabled!", + { "You should try", + " `luatex --shell-escape --jobname=luaindex luaindex.dtx'", + "to enable shell escape.", + "Otherwise you will get no manual." } ) + elseif ( retval == 0 ) then + else + tex.error( "Failed to generate the manual", + { "I've tried to call", + " `lualatex --jobname=luaindex luaindex.ltx'", + "but got unexpected return value:", + retval } + ) + end + }% +} + +\ifToplevel{% + \Msg{* \space\space done.} + \Msg{*} + \Msg{* Now you may install all the files.} + \Msg{*} + \Msg{********************************************************************} +} + +\csname endinput\endcsname +% +%<*dtx> +\ProvidesFile{luaindex.dtx} +% +%\NeedsTeXFormat{LaTeX2e}[1995/06/01] +%\ProvidesPackage{luaindex} +%\ProvidesFile{luaindex.ltx} +%\ProvidesFile{luaindex-example.ltx} +%<*package|manual|dtx> + [2011/02/09 v0.1a LuaLaTeX Package +%<*manual> + documentation: +% + index processor]% +% +%<*manual> +\documentclass{scrdoc} +\usepackage{tabularx} +\usepackage[english]{babel} +\usepackage{xcolor} +\colorlet{mcode}{teal} +\usepackage{fontspec} +\providecommand*{\LuaTeX}{Lua\kern-.125em\TeX} +\providecommand*{\LuaLaTeX}{Lua\kern-.025em\LaTeX} +\CodelineIndex +\RecordChanges +\GetFileInfo{luaindex.ltx} +\title{% + Usage of\\ + \LuaTeX{} module \texttt{koma.luaindex}\\ + and\\ + \LuaLaTeX{} Package \texttt{luaindex}\\ + for Generating Indexes\\ +} +\date{\fileversion} +\author{Markus Kohm\thanks{komascript% +@% +gmx% +.% +info}} +\begin{document} +\maketitle +\DocInput{luaindex.dtx} +\end{document} +% +%\fi^^A meta-comment +% +% \changes{v0.1}{2011/01/26}{start of new package} +% +% \begin{abstract} +% With \LuaTeX{} it would not be a problem to call an index processor like +% MakeIndex while running \LuaTeX{}. So the user would not longer require +% to call the index processor on his own. But on the other side Lua hat +% enough power to process the index itself. Package \texttt{luaindex} was +% made to do this. It consists primary of a Lua module: +% \texttt{luaindex.lua}. This provides functions to generate a new index +% (or several new indexes), add entries to it and print the index. To make +% the world easier there's an additional \LaTeX{} package: +% \texttt{luaindex.sty}. +% \end{abstract} +% +% \tableofcontents +% +% \section{Idea} +% +% We will explain this in a future release. +% +% \section{General Options} +% +% See implementation documentation. +% +% \section{Generating Index Entries} +% +% See implementation documentation. +% +% \section{Print an Index} +% +% See implementation documentation. +% +% \section{Known Issues} +% +% Currently the user documentation is not existing. Please use the +% implementation documentation and the example instead of. This will be +% changed in a future release but maybe not at a near future. +% +% Currently there are no attributes to give the different indexes different +% headings. You may redefine |\indexname| before printing an index to do +% so. Future releases will do this simply by option. +% +% Currently repeated pre-sort-replaces are not supported. Maybe they will in a +% future release. +% +% Currently page ranges are not supported. They will in a future release. +% +% Note: This is not even a beta version. It's only a proof of concept. Almost +% everything my be designed and implemented in a better kind. The author +% himself is just learning \LuaTeX{}. +% +% Nevertheless you may report bugs and patches to komascript^^A +% @^^A +% gmx^^A +% .^^A +% info. +% +% +% \StopEventually{% +% \PrintIndex +% \PrintChanges +% } +% +% \section{Implementation of Lua Module \texttt{luaindex.lua}} +% +% \iffalse meta-comment +%<*lua> +% \fi^^A meta-comment +% +% First of all wie define a new module named \texttt{koma.luaindex}. All +% variables and functions will be local to this module. +% \begin{macrocode} +module("koma.luaindex", package.seeall) +% \end{macrocode} +% +% To handle all indexes we have a variable named \texttt{indexes}. This is a +% table of index tables \emph{assoziated by the name of the index +% table}\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{}} +% \texttt{indexes}=\{\\ +% \enskip\emph{name}=\{\\ +% \enskip\enskip\texttt{presortreplaces}=\{\\ +% \enskip\enskip\enskip\{[\emph{pattern}]=\emph{replace}, \dots\kern.1em\}, +% \dots\\ +% \enskip\enskip\},\\ +% \enskip\enskip\texttt{sortorderbychar}=\{\\ +% \enskip\enskip\enskip[\emph{char}]=\emph{position}, \dots\\ +% \enskip\enskip\},\\ +% \enskip\enskip\{\\ +% \enskip\enskip\enskip\texttt{sort}="\dots\kern.1em",\\ +% \enskip\enskip\enskip\texttt{value}="\dots\kern.1em",\\ +% \enskip\enskip\enskip\texttt{pages}=\{\dots\kern.1em\},\\ +% \enskip\enskip\enskip\texttt{subindex}=\{\dots\kern.1em\}\\ +% \enskip\enskip\}\\ +% \enskip\}\\ +% \}\\ +% \end{tabular} +% }} +% \begin{itemize} +% \item Each index table has at least \emph{two elements} assoziated to +% \texttt{presortreplaces} and +% \texttt{sortorderbychar}. +% \item There may be additional numericly assoziated elements, the \emph{index +% entries}. +% \begin{itemize} +% \item Each index entry has a least \emph{two elements} assoziated to +% \texttt{sort} und \texttt{value}. Element \texttt{sort} is the sort key +% of the index entry. Element \texttt{value} is the print value of the +% index entry. +% \item Each index entry may have an element assoziated to +% \texttt{pages}. This is a table of print values, that will be used as +% page number of the entry. It need not to be numeric. This table hat +% numeric assoziations. Later addeed pages will be appended to the end of +% the table. +% \item Each index entry may habe an element assoziated to +% \texttt{subindex}. This is an index table too, but do not have elements +% \texttt{presortreplaces} or \texttt{sortorderbychar}. +% \end{itemize} +% \end{itemize} +% \begin{macrocode} +local indexes = {} +% \end{macrocode} +% +% Next we have a function\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \texttt{newindex(\emph{index name})}}} to generate a new \emph{index table} +% at \texttt{indexes}: +% \begin{macrocode} +function newindex( indexname ) + indexes[indexname]={ presortreplaces = {}, + sortorderbychar = {} } +end +% \end{macrocode} +% The function parameter is the name of the index. This is not realy a print +% name, but a simple assoziation name. +% +% Don't be impressed because of empty initialization of +% \texttt{presortreplaces} and \texttt{sortorderbychar}. We will have +% functions to change this. +% +% First of all, we have a function\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{}l@{}} +% \texttt{sortorder(} & \texttt{\emph{index name},} \\ +% & \texttt{\emph{sort-order})}\\ +% \end{tabular}% +% }} to add a new sort order. +% \begin{macrocode} +function sortorder( indexname, sortorder ) + local i, value +% \end{macrocode} +% The first parameter of the function is the name if the index table. If an +% index table with the given name does not exist, \TeX{} should release an +% error message with some optional help. +% \begin{macrocode} + local index = indexes[indexname] + if index == nil then + tex.error( "Unknown index `" .. indexname .. "'", + { "You've tried to add a new sortorder to an index, but there's no index with the", + "given name.", + "You should define the index using lua function ", + " `koma.luaindex.newindex(\"" .. indexname .. "\")'", + "before." + } + ) + else + if type(sortorder) == "string" then +% \end{macrocode} +% The second parameter of the function may be a string. The string simply is +% an concatenation of the character in the order that should be used to sort +% the index entries of this index. The index table assoziatione +% \texttt{sortorderbychar} is a table. The characters are the assoziation and +% the wanted sort position is the assoziated value. +% \begin{macrocode} + local value + i = 1 + repeat + value = unicode.utf8.sub( sortorder, i, i ) +% print( i, value ) + if value then + index.sortorderbychar[value] = i + end + i = i + 1 + until value == "" + else -- should be table +% \end{macrocode} +% The second parameter of the function may also be a table with numerical +% assoziations. +% \begin{macrocode} + for i, value in ipairs( sortorder ) do + index.sortorderbychar[value] = i + end + end + end +end +% \end{macrocode} +% +% Second manipulation function\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{}l@{}} +% \texttt{presortreplace(} & \texttt{\emph{index name},} \\ +% & \texttt{\emph{pass},} \\ +% & \texttt{\emph{pattern},} \\ +% & \texttt{\emph{replace})}\\ +% \end{tabular}% +% }} is to add presort entries to a presort pass of +% an index. \texttt{\emph{pattern}} and \texttt{\emph{replace}} are +% strings. See Lua function \texttt{unicode.utf8.sub} for more information +% about these. +% \begin{macrocode} +function presortreplace( indexname, pass, pattern, replace ) + local n +% \end{macrocode} +% The first parameter of the function is the name if the index table. If an +% index table with the given name does not exist, \TeX{} should release an +% error message with some optional help. +% \begin{macrocode} + local index = indexes[indexname] + if index == nil then + tex.error( "Unknown index `" .. indexname .. "'", + { "You've tried to add a new presort-replace to an index, but there's no index", + "with the given name.", + "You should define the index using lua function ", + " `koma.luaindex.newindex(\"" .. indexname .. "\")'", + "before." + } + ) + else +% \end{macrocode} +% If the index exists, we have to create replace tables for every pass until +% the given. +% \begin{macrocode} + for n = table.maxn(index.presortreplaces), pass, 1 do + if ( index.presortreplaces[n] == nil ) then + index.presortreplaces[n] = {} + end + end +% \end{macrocode} +% Last but not least we have to add a new replace to the pass: +% \begin{macrocode} + index.presortreplaces[pass][pattern]=replace + end +end +% \end{macrocode} +% +% Indexes are normally separated into single letters, all numbers and all +% other symbols. To do so, we have a new +% function\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[b]{@{}l@{~}l@{}} +% \texttt{local} & \texttt{getclass(} \\ +% & \enskip\texttt{\emph{utf8-char})}\\ +% \end{tabular}% +% }} that returns 1 for all other symbols, 2 for all numbers and 3 for all +% letters. Wether an UTF-8 character is a letter or not depends on the +% locale type ``\texttt{collate}''. You may set it using +% \texttt{os.setlocale("\emph{locale}", "collate")}. +% \begin{macrocode} +local function getclass( utfc ) + local i + for i in unicode.utf8.gmatch( utfc, "%n" ) do +% print( utfc .. " is a number" ) + return 2 + end + for i in unicode.utf8.gmatch( utfc, "%a" ) do +% print( utfc .. " is a letter" ) + return 3 + end +% print( utfc .. " is a symbol" ) + return 1 +end +% \end{macrocode} +% +% Before printing or sorting we may want to replace\marginpar{%^^A +% \makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{~}l@{}} +% \texttt{local} & \texttt{do\_presortreplaces(} \\ +% & \enskip\texttt{\emph{utf8-string},}\\ +% & \enskip\texttt{\emph{replace table})}\\ +% \end{tabular}% +% }} some strings. We have a table of those. At the string each occurence of +% the assoziation should be replaced by the assoziated value. +% \begin{macrocode} +local function do_presortreplaces( srcstr, presortreplace ) + if presortreplace then + local pat, rep + for pat, rep in pairs( presortreplace ) do + srcstr = unicode.utf8.gsub( srcstr, pat, rep ) + end + end + return srcstr +end +% \end{macrocode} +% +% Now let's print the index.\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{~}l@{}} +% \texttt{local} & \texttt{printsubindex(} \\ +% & \enskip\texttt{\emph{level},}\\ +% & \enskip\texttt{\emph{index},}\\ +% & \enskip\texttt{\emph{presortreplace\_zero})}\\ +% \end{tabular}% +% }} +% There aren't much differences in printing an index or a sub-index to an +% index entry. We only need to know the level of the (sub-) index. level 0 +% is the main index. +% \begin{macrocode} +local function printsubindex( level, index, presortreplace_zero ) + local i,t,n,p,l + local group="" + local class=-1 +% \end{macrocode} +% We build the \TeX{} index item command: \verb|\item|, \verb|\subitem|, +% \verb|\subsubitem| etc. depending on the level. So \texttt{level} is simply +% the number of \verb|sub| at the index item command. +% \begin{macrocode} + local item="\\" + for l = 1, level, 1 do + item = item .. "sub" + end + item = item .. "item " +% \end{macrocode} +% Walk through all index items. +% \begin{macrocode} + for i,t in ipairs( index ) do +% \end{macrocode} +% If \texttt{level} is 0, we are at the root index. We want to group this +% Index into numbers, symbols and single letters. To do so, we detect the +% class of the first character at the sort string and add \verb|\indexgroup| +% commands if neccessary. +% \begin{macrocode} + if ( level == 0 ) then + local sort=do_presortreplaces( t["sort"], presortreplace_zero ) + local firstchar=unicode.utf8.upper( unicode.utf8.sub( sort, 1, 1 ) ) + if ( firstchar ~= group ) then + local newclass +% \end{macrocode} +% The character differ, but we have to print the group only if the groups of +% the characters differ. +% \begin{macrocode} + newclass=getclass( firstchar ) + if ( newclass == 1 and class ~= newclass ) then + tex.print( "\\indexgroup{\\symbolsname}" ) + elseif ( newclass == 3 ) then + tex.print( "\\indexgroup{" .. firstchar .. "}" ) + elseif ( newclass == 2 and class ~= newclass ) then + tex.print( "\\indexgroup{\\numbersname}" ) + end + group=firstchar + class=newclass + end + end +% \end{macrocode} +% Now we have to print the index item. We use the \texttt{value} to be +% printed. If one or more pagenumbers are stored, we print them too. If the +% index entry has a sub index, we call \texttt{printsubindex} for this one +% with increased level. +% \begin{macrocode} + tex.sprint( item, t["value"] ) + if t["pages"] then + tex.sprint( "\\indexpagenumbers{" ) + for n,p in ipairs( t["pages"] ) do + tex.sprint( "\\indexpagenumber{", p, "}" ) + end + tex.print( "}" ) + end + if t["subindex"] then + printsubindex( level+1, t["subindex"], presortreplaces_zero ) + end + end +end +% \end{macrocode} +% Printing\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{}} +% \texttt{printindex(\emph{index name})}\\ +% \end{tabular}% +% }} a whole index is simply the same like printing a sub index, but before +% printing the index, we have to test, wether the named index exists or +% not. +% \begin{macrocode} +function printindex( indexname ) + local index=indexes[indexname] + if index == nil then + tex.error( "Unknown index `" .. indexname .. "'", + { "You've tried to print an index, but there's no index with the", + "given name.", + "You should define the index using lua function ", + " `koma.luaindex.newindex(\"" .. indexname .. "\")'", + "before." + } + ) + else + print( "Index: \"" .. indexname .. "\" with " .. table.maxn( index ) .. " level-0-entries" ) + tex.print( "\\begin{theindex}" ) + printsubindex(0,indexes[indexname],indexes[indexname].presortreplaces[0]) + tex.print( "\\end{theindex}" ) + end +end +% \end{macrocode} +% +% To sort the index character classes numbers, letters and other are not +% enough. So we build sub-classes\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[b]{@{}l@{~}l@{}} +% \texttt{local} & \texttt{getsubclass(} \\ +% & \enskip\texttt{\emph{utf8-char})}\\ +% \end{tabular}% +% }} inside these three classes. +% \begin{macrocode} +local function getsubclass( utfc ) + local i +% \end{macrocode} +% Inside letters we want so sort upper case before lower case. +% \begin{macrocode} + for i in unicode.utf8.gmatch( utfc, "%l" ) do + return 1 + end + for i in unicode.utf8.gmatch( utfc, "%u" ) do + return 2 + end +% \end{macrocode} +% Inside other symbols we want so sort controls before spaces before +% punctuations before numbers before unknown. +% \begin{macrocode} + for i in unicode.utf8.gmatch( utfc, "%c" ) do + return 1 + end + for i in unicode.utf8.gmatch( utfc, "%s" ) do + return 2 + end + for i in unicode.utf8.gmatch( utfc, "%p" ) do + return 3 + end + for i in unicode.utf8.gmatch( utfc, "%n" ) do + return 4 + end + return 10 -- unkown is the biggest sub class +end +% \end{macrocode} +% To compare\marginpar{\makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{~}l@{}} +% \texttt{local} & \texttt{do\_strcmp(} \\ +% & \enskip\texttt{\emph{first string},} \\ +% & \enskip\texttt{\emph{second string},} \\ +% & \enskip\texttt{\emph{sort order table})}\\ +% \end{tabular}% +% }} two UTF8-strings we could simply use the string compare of +% Lua. But for our purpose this is not enough. So we've added a configurable +% sort order and now have to compare character by character depeding on this +% sort order. +% \begin{macrocode} +local function do_strcmp( first, second, sortorderbychar ) + local secondtable = string.explode( second, "" ) + local firstutf + local n = 1 +% print( first .. ", " .. second ); + for firstutf in string.utfcharacters( first ) do + local secondutf = unicode.utf8.sub( second, n, n ) + n = n + 1; + if firstutf then + if secondutf ~= "" then +% print( " " .. firstutf .. ", " .. secondutf ) + if firstutf ~= secondutf then + local firstn, secondn + if sortorderbychar then + firstn = sortorderbychar[firstutf] + secondn = sortorderbychar[secondutf] + end +% \end{macrocode} +% If both characters were in the sort order table with different index we may +% return -1, if the index of first was lower than second, and 1, if the index +% of first was higher than second. +% \begin{macrocode} + if firstn and secondn then +% print( " n: " .. firstn .. ", " .. secondn ) + if firstn < secondn then + return -1 + elseif firstn > secondn then + return 1 + end + else +% \end{macrocode} +% If one character was not in the sort order table, we compare the classes and +% if same the sub-classes. +% \begin{macrocode} + local firstclass = getclass( firstutf ) + local secondclass = getclass( secondutf ) + if firstclass < secondclass then + return -1 + elseif firstclass == secondclass then + local firstsubclass = getsubclass( firstutf) + local secondsubclass = getsubclass( secondutf ) + if firstsubclass < secondsubclass then + return -1 + elseif firstsubclass == secondsubclass then + if firstutf < secondutf then + return -1 + else + return 1 + end + else + return 1 + end + else + return 1 + end + end + end + else +% \end{macrocode} +% If the first string was longer than the second, it is greater. +% \begin{macrocode} + return 1 + end + else +% \end{macrocode} +% If the first string was shorter than the second, it is lower. +% \begin{macrocode} + if secondutf ~= "" then + return -1 + else + return 0 -- This should never happen! + end + end + end +% \end{macrocode} +% If the first string was shorter than the second, it is lower. If not they +% are same. +% \begin{macrocode} + if unicode.utf8.sub( second, n, n ) ~= "" then + return -1 + else + return 0 + end +end +% \end{macrocode} +% +% Now we are able to compare\marginpar{%^^A +% \makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{~}l@{}} +% \texttt{local} & \texttt{do\_indexcmp(} \\ +% & \enskip\texttt{\emph{first string},}\\ +% & \enskip\texttt{\emph{second string},}\\ +% & \enskip\texttt{\emph{replace tables},}\\ +% & \enskip\texttt{\emph{sort order table})}\\ +% \end{tabular}% +% }} the sort value of two index entries. Before the +% first compare we do the first pre-sort replace. All other pre-sort replaces +% will be done only, if the sort entries are not same! +% \begin{macrocode} +local function do_indexcmp( firstsort, secondsort, + presortreplaces, sortorderbychar ) + local pass = 0 + local ncmp = 0 + repeat + if presortreplaces and presortreplaces[pass] then + firstsort = do_presortreplaces( firstsort, presortreplaces[pass] ) + secondsort = do_presortreplaces( secondsort, presortreplaces[pass] ) +% print( "Replace-Pass " .. pass .. ": " .. firstsort .. ", " .. secondsort ) + end + pass = pass + 1 + ncmp = do_strcmp( firstsort, secondsort, sortorderbychar ) + until ( ncmp ~= 0 ) or ( pass > table.maxn( presortreplaces ) ) +%<*debug> + if ncmp < 0 then + print( firstsort .. "<" .. secondsort ) + elseif ncmp == 0 then + print ( firstsort .. "=" .. secondsort ) + else + print( firstsort .. ">" .. secondsort ) + end +% + return ncmp +end +% \end{macrocode} +% +% Inserting\marginpar{%^^A +% \makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{~}l@{}} +% \texttt{local} & \texttt{subinsert(} \\ +% & \enskip\texttt{\emph{index table},}\\ +% & \enskip\texttt{\emph{replace tables},}\\ +% & \enskip\texttt{\emph{sort order table},}\\ +% & \enskip\texttt{\emph{page string},}\\ +% & \enskip\texttt{\emph{sort value},}\\ +% & \enskip\texttt{\emph{print value},}\\ +% & \enskip\dots\kern.1em\texttt{)}\\ +% \end{tabular}% +% }} a new entry to an index is same like inserting a new entry to a +% sub-index of an already existing entry. So we have only one local function +% for this. A new entry consists of a page string, that should be added to the +% page list of the entry, a sort value, that should be used to find the +% correct entry and a print value, that should be shown at the index. Entries +% are only same, if the compare of the sort value is 0 and the print values +% are same. A new entry may be not only a new entry to the top level but to +% sub levels. Because of this, there may be several pairs of sort- and print +% values. We use bisection search to find the insert position. +% \begin{macrocode} +local function subinsert( index, presortreplaces, sortorderbychar, + pagestring, sortvalue, outputvalue, ... ) + local min = 1 + local max = table.maxn(index) + local updown = 0 + + local n = math.ceil(( min + max ) / 2) + while min <= max do + updown = do_indexcmp( sortvalue, index[n].sort, + presortreplaces, sortorderbychar ) + if updown == 0 then +% \end{macrocode} +% The sort values are compared to be same (after serveral replaces). But only +% if the print values are (without any replaces) same, we have to use this +% entry. In this case we add a new sub-entry to this entry and if no new sub +% entry was given the page string to the page table. +% \begin{macrocode} + if outputvalue == index[n].value then +% print( "The entries are same." ) + if ( ... ) then +% print( " Adding subentry to already existing entry" ) + if ( index[n].subindex == nil ) then + index[n].subindex = {} + end + subinsert( index[n].subindex, presortreplaces, sortorderbychar, + pagestring, ... ) + else +% print( " Is the pagestring already at the pages table?" ) + local i, p + for i, p in ipairs( index[n].pages ) do + if pagestring == p then +% print( "The pagestring is already at the pages table." ) +% print( " We have nothing to do." ) + return + end +% print( pagestring, "!=", p ) + end +% print( "The pagestring was not at the pages table.", +% "Add the new pagestring to the pages table", +% "and stop processing." ) + table.insert( index[n].pages, pagestring ) + end + return + else +% \end{macrocode} +% If the print values are not same, we use sequential search for the position +% after the last entry with same sort value but different print value. This is +% the position to use for the new entry. +% \begin{macrocode} +% print( "The entries are not same.", +% "Search for the last entry, with same sort." ) + repeat + n = n + 1 + if n <= max then + updown = do_indexcmp( sortvalue, index[min].sort, + presortreplaces, sortorderbychar ) + end + until n > max or updown ~= 0 + min = n + max = n-1 + end + elseif updown > 0 then + min = n+1 + else + max = n-1 + end + n = math.ceil(( min + max ) / 2) +% print ( min, max, n ) + end +% \end{macrocode} +% if we have a new sub entry we add this to the new position. If not we simply +% add the new entry with the page table. +% \begin{macrocode} + if ( ... ) then +% print( "Generating new entry without page but subindex" ) + table.insert( index, n, + { sort=sortvalue, value=outputvalue, subindex={} } ) +% print( "Add subindex to new generated entry" ) + subinsert( index[n].subindex, presortreplaces, sortorderbychar, + pagestring, ... ) + else +% print( "Generating new entry with page" ) + table.insert( index, n, + { sort=sortvalue, value=outputvalue, pages={pagestring} } ) + end +end +% \end{macrocode} +% We've explained before, that inserting\marginpar{%^^A +% \makebox[0pt][l]{\color{mcode}^^A +% \begin{tabular}[t]{@{}l@{}} +% \texttt{insert(\emph{index name},}\\ +% \enskip\texttt{\emph{page string},}\\ +% \enskip\texttt{\emph{sort value},}\\ +% \enskip\texttt{\emph{print value},}\\ +% \enskip\dots\kern.1em\texttt{)}\\ +% \end{tabular}% +% }} a new entry is same like inserting a entry to a sub entry. There's only +% one tiny difference: the replace tables and sort order are members of the +% index table. +% \begin{macrocode} +function insert( indexname, pagestring, sortvalue, outputvalue, ... ) + local index=indexes[indexname] + subinsert( index, index.presortreplaces, index.sortorderbychar, + pagestring, sortvalue, outputvalue, ... ) +end +% \end{macrocode} +% +% Last we will need a function,\marginpar{^^A +% \makebox[0pt][l]{\color{mcode}^^A +% \texttt{removeentries(\emph{index name})}}} that only removes all index +% entries but not presortreplaces or sortorderbychar. +% \begin{macrocode} +function removeentries( indexname ) + local p = indexes[indexname].presortreplaces + local s = indexes[indexname].sortorderbychar + indexes[indexname]={ presortreplaces = p, + sortorderbychar = s } +end +% \end{macrocode} +% +% \iffalse meta-comment +% +% \fi^^A meta-comment +% +% \section{Implementation of \LaTeX{} Package \texttt{luaindex.sty}} +% +% \iffalse meta-comment +%<*package> +% \fi^^A meta-comment +% +% The \LaTeX{} package is user's candy but not necessary. You may use +% \texttt{luaindex.lua} directly, but \LaTeX{} users will expect a \LaTeX{} +% interface. +% +% \subsection{Package Startup} +% +% \LuaLaTeX{} must be used to use the package. +% \begin{macrocode} +\RequirePackage{ifluatex} +\ifluatex\else + \PackageError{luaindex}{lualatex needed}{% + Package `luaindex' needs LuaTeX.\MessageBreak + So you should use `lualatex' to process you document!\MessageBreak + See documentation of `luaindex' for further information.}% + \expandafter\expandafter\expandafter\csname endinput\endcsname +\fi +% \end{macrocode} +% +% Load an initialize lua module. We could do this much later, but it is very, +% very important, so we do is as soon as possible. +% \begin{macrocode} +\directlua{dofile("luaindex.lua")} +% \end{macrocode} +% +% With \texttt{luaindex} we use a temporary index file, too. This is +% necessary, because page numbers are only valid while output routine. So +% usage of a temporary index file is a good solution to have correct page +% numbers. If this file exists, we load it simply while |\begin{document}| and +% then produce an new one. But loading the old one is not simply an +% |\input|. Out temporary index file is a Lua file, so we use Lua function +% \texttt{dofile} to load it. +% \begin{macrocode} +\newwrite\@indexfile +\AtBeginDocument{% + \IfFileExists{\jobname.ldx}{\directlua{dofile("\jobname.ldx")}}{}% + \openout\@indexfile=\jobname.ldx +} +% \end{macrocode} +% +% \subsection{Options} +% +% We use a key-value interface even for options. Because of this we're using +% \KOMAScript{} package scrbase. +% \begin{macrocode} +\RequirePackage{scrbase} +\DefineFamily{luaindex} +\DefineFamilyMember{luaindex} +% \end{macrocode} +% +% \begin{option}{sortorder} +% \begin{macro}{\luaindex@sortorder} +% Support for individual sort order. Sort order is an attribute of the index +% root Lua table. Because of this the option simply saves it and it will be +% setup later while defining new indexes. +% \begin{macrocode} +\newcommand*{\luaindex@sortorder}{} +\DefineFamilyKey{luaindex}{sortorder}{% + \edef\luaindex@sortorder{#1}% +} +% \end{macrocode} +% \end{macro} +% \end{option} +% +% \begin{option}{locale} +% If no individual sort order is given, the \emph{collate} locale would cause +% the sort order. So we add an option make this locale changable. Note, that +% changing this locale may also affect to other Lua functions! +% \begin{macrocode} +\DefineFamilyKey{luaindex}{locale}{% + \if@atdocument + \expandafter\@firstofone + \else + \expandafter\AtBeginDocument + \fi + {% + \protected@write\@indexfile{}{% + os.setlocale("#1","collate") + }% + }% +} +% \end{macrocode} +% \end{option} +% +% \begin{option}{pageformat} +% \begin{macro}{\luaindex@pageformat} +% The page format is an attribute of every index entry. But you may define a +% primary page format to be used, if no individual page format will be given. +% \begin{macrocode} +\newcommand*{\luaindex@pageformat}{} +\DefineFamilyKey{luaindex}{pageformat}{% + \def\luaindex@pageformat{#1}% +} +% \end{macrocode} +% \end{macro} +% \end{option} +% +% \begin{option}{singlepass} +% This option changes the general behavior of |\printindex|. See definition of +% |\printindex| for more information about. +% \begin{macrocode} +\FamilyBoolKey{luaindex}{singlepass}{@luaindexsinglepass} +% \end{macrocode} +% \end{option} +% +% Processing all the options while loading the package. +% \begin{macrocode} +\FamilyProcessOptions{luaindex}\relax +% \end{macrocode} +% +% \begin{macro}{\setupluaindex} +% This is only an convenience command for run time setup of \texttt{luadindex} +% options. +% \begin{macrocode} +\newcommand*{\setupluaindex}{\FamilyOptions{luaindex}} +% \end{macrocode} +% \end{macro} +% +% \subsection{Some Usual Index Commands} +% +% \begin{macro}{\see} +% \begin{macro}{\seealso} +% |\see| and |\seealso| are common commands used at the page number +% format. They are defined for compatibility. ^^A Fixme: Is this a good idea? +% \begin{macro}{\seename} +% \begin{macro}{\alsoname} +% The two terms |\seename| and |\alsoname| are used by |\see| and |\seealso| +% and needed to be defined also. +% \begin{macrocode} +\newcommand*\see[2]{\emph{\seename} #1} +\providecommand*\seealso[2]{\emph{\alsoname} #1} +\providecommand\seename{see} +\providecommand*\alsoname{see also} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% +% +% \subsection{Generation of Indexes and Index Entries} +% +% \begin{macro}{\newindex} +% We can handle not only one index but several indexes. To do so, we have to +% create a new lua index table for each index. Just use +% \begin{quote}|\newindex|\marg{index name}\end{quote} to do so. Additional +% features may be set up using: \begin{quote}|\newindex|\oarg{index +% options}\marg{index name}\end{quote} Currently all global options are +% supported for \meta{index options}, but some will be ignored. +% \begin{macrocode} +\newcommand*{\newindex}[2][]{% + \directlua{koma.luaindex.newindex("\luatexluaescapestring{#2}")}% + \begingroup + \setupluaindex{#1}% + \ifx\luaindex@sortorder\@empty\else + \AtBeginDocument{% + \protected@write\@indexfile{}{% + koma.luaindex.sortorder("\luatexluaescapestring{#2}", + "\luaindex@sortorder") + }}% + \fi + \endgroup +} +% \end{macrocode} +% You may use |\newindex| at the document preamble only. +% \begin{macrocode} +\@onlypreamble\newindex +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\luaindex} +% This command will be used to add a new root level entry to an index: +% \begin{quote}|\luaindex|\marg{index +% name}\oarg{options}\marg{entry}\end{quote} +% \begin{description} +% \item[\normalfont\meta{index name}] -- the name of the index to be +% used. This has to be the same like you've used to create the new index +% using |\newindex|. +% \item[\normalfont\meta{options}] -- several options for the index +% entry. Currently supported are: +% \begin{description} +% \item[\normalfont\texttt{locale=}\meta{locale specifier}] -- just calls +% |\luaindexsetup|\marg{locale specifier}. Note, that this is a global +% action! +% \item[\normalfont\texttt{pageformat=}\meta{command}] -- is a command with +% at most one argument to format the page number of the index entry. You +% may, e.\,g., use |sort=\see|\marg{reference} or +% |sort=\seealso|{\marg{reference}} to produce a ``see'' or ``see also'' +% cross reference to \meta{reference} instead of showing a real page +% number. +% \item[\normalfont\texttt{sort=}\meta{sort entry}] -- destines the sort +% position of the index entry. If it is omitted \meta{entry} will be used +% instead. +% \end{description} +% \item[\normalfont\meta{entry}] -- this will be shown in the index. +% \end{description} +% Note: An index entry is only same, if \meta{sort entry} is same (after +% several presort replaces) and \meta{entry} is same. Index entries +% with same \meta{sort entry} but different \meta{entry} will be placed +% at the current end of the entries with same \meta{sort entry}. +% \begin{macrocode} +\newcommand*{\luaindex}[1]{% + \@bsphack + \begingroup + \edef\luaindex@name{#1}% + \lua@index +} +\newcommand*{\lua@index}[2][]{% + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \define@key{luaindex.setindex}{pageformat}{\def\luaindex@pageformat{##1}}% + \define@key{luaindex.setindex}{locale}{\luaindexsetup{locale=#1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + koma.luaindex.insert("\luatexluaescapestring{\luaindex@name}", + "{\luatexluaescapestring{\luaindex@pageformat{\thepage}}}", + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}") + }% + \endgroup + \@esphack +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\luasubindex} +% \begin{macro}{\lua@subindex} +% \begin{macro}{\lua@@subindex} +% Same like |\luaindex| but to produce a sub entry: +% \begin{quote}|\luasubindex|\marg{index name}\oarg{options}\marg{entry}^^A +% \linebreak[2]\oarg{options}\marg{sub-entry}\end{quote} Note, that the +% \meta{options} for the \meta{sub-entry} only allows a sub-set of the options +% shown for |\luaindex|. Currently only \texttt{sort=}\meta{sort entry}. +% \begin{macrocode} +\newcommand*{\luasubindex}[1]{% + \@bsphack + \begingroup + \edef\luaindex@name{#1}% + \lua@subindex +} +\newcommand*{\lua@subindex}[2][]{% + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \define@key{luaindex.setindex}{pageformat}{\def\luaindex@pageformat{##1}}% + \define@key{luaindex.setindex}{locale}{\luaindexsetup{locale=#1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + koma.luaindex.insert("\luatexluaescapestring{\luaindex@name}", + "{\luatexluaescapestring{\luaindex@pageformat{\thepage}}}", + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}", + }% + \aftergroup\lua@@subindex + \endgroup +} +\newcommand*{\lua@@subindex}[2][]{% + \begingroup + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + \@spaces + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}") + }% + \endgroup + \@esphack +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\luasubsubindex} +% \begin{macro}{\lua@subsubindex} +% \begin{macro}{\lua@@@subindex} +% Same like |\luaindex| but to produce a sub-sub-entry, that is a sub-entry to +% a sub-entry: +% \begin{quote}|\luasubindex|\marg{index +% name}\oarg{options}\marg{entry}\linebreak[2]^^A +% \oarg{options}\marg{sub-entry}\linebreak[2]^^A +% \oarg{options}\linebreak[2]\marg{sub-sub-entry}\end{quote} +% Note, that the \meta{options} for the \meta{sub-entry} and the +% \meta{sub-sub-entry} only allows a sub-set of the options shown for +% |\luaindex|. Currently only \texttt{sort=}\meta{sort entry}. +% \begin{macrocode} +\newcommand*{\luasubsubindex}[1]{% + \@bsphack + \begingroup + \edef\luaindex@name{#1}% + \lua@subsubindex +} +\newcommand*{\lua@subsubindex}[2][]{% + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \define@key{luaindex.setindex}{pageformat}{\def\luaindex@pageformat{##1}}% + \define@key{luaindex.setindex}{locale}{% + \luaindexsetup{locale=#1}% + } + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + koma.luaindex.insert("\luatexluaescapestring{\luaindex@name}", + "{\luatexluaescapestring{\luaindex@pageformat{\thepage}}}", + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}", + }% + \aftergroup\lua@@@subindex + \endgroup +} +\newcommand*{\lua@@@subindex}[2][]{% + \begingroup + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + \@spaces + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}", + }% + \aftergroup\lua@@subindex + \endgroup +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\makeindex} +% \begin{macro}{\index} +% \begin{macro}{\subindex} +% \begin{macro}{\subsubindex} +% These are defined to increase compatibility to old index packages +% only. Command |\makeindex| simply generates the new index named +% \texttt{general} and the other commands to add entries to that index. Note, +% that adding a sub-entry or sub-sub-entry is not yet compatible to other +% index packages. You need to use the command |\subindex| and |\subsubindex| +% instead of something like +% |\index{|\meta{entry}|!|\meta{sub-entry}|!|\meta{sub-sub-entry}|}|. Note +% also, that changing the format of the page number is not compatible with +% other index packages. You have to use |\index[pageformat=|\meta{page +% format}|]{|\dots\kern.1em|}| instead of something like +% |\index{|\meta{entry}\verb+|+\meta{page format}|}|. +% \begin{macrocode} +\renewcommand*{\makeindex}{% + \newindex{general}% + \renewcommand*\index{\luaindex{general}}% + \newcommand*\subindex{\luasubindex{general}}% + \newcommand*\subsubindex{\luasubsubindex{general}}% +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% +% +% \subsection{Printing an Index} +% +% We do not only want to create an index, we also need to print it. +% +% \begin{macro}{\printindex} +% With +% \begin{quote}|\printindex|\oarg{options}\end{quote} +% you can print an index. The known options are +% \begin{description} +% \item[\normalfont\texttt{index=}\meta{index name}] -- print the index with +% the given name as declared at |\newindex|. If you omit this option, index +% ``\texttt{general}'' will be printed. +% \item[\normalfont\texttt{singlepass=}\meta{boolean value}] -- you may switch +% on and of the single pass feature. For the differences of single pass +% feature on and off, see table~\ref{tab:singlepass} +% \begin{table} +% \centering +% \caption{Implications of option \texttt{singlepass} to +% \texttt{\string\printindex}} +% \label{tab:singlepass} +% \begin{tabularx}{\linewidth}{@{}>{\raggedright}X>{\raggedright}X} +% \firsthline +% \texttt{singlepass=false} & \texttt{singlepass=true} \tabularnewline +% \hline +% index of previous \LuaLaTeX{} run will be printed +% & index of current \LuaLaTeX{} run will be printed +% \tabularnewline[1ex] +% start of index depends on the class +% & start of the index at next page earliest +% \tabularnewline[1ex] +% index entries may be added to an index even after it has been printed +% & no more index entries may be added to the index after it has been +% printed +% \tabularnewline +% \lasthline +% \end{tabularx} +% \end{table} +% \end{description} +% \begin{macrocode} +\newcommand*{\printindex}[1][]{% + \begingroup + \edef\luaindex@name{general}% + \define@key{luaindex.setindex}{index}{\edef\luaindex@name{##1}}% + \define@key{luaindex.setindex}{singlepass}[true]{% + \setupluaindex{singlepass}{##1}% + }% + \setkeys{luaindex.setindex}{#1}% + \if@luaindexsinglepass + \closeout\@indexfile + \clearpage + \directlua{% + koma.luaindex.removeentries("\luatexluaescapestring{\luaindex@name}") + dofile("\jobname.ldx") + }% + \fi + \directlua{% + koma.luaindex.printindex("\luatexluaescapestring{\luaindex@name}") + }% + \endgroup +} +% \end{macrocode} +% \end{macro} +% +% \texttt{luaindex.lua} uses several macros while printing the index. First of +% all it uses the environment \texttt{theindex}. But several additional macros +% will be used: +% +% \begin{macro}{\indexgroup} +% \begin{macro}{\indexspace} +% \begin{macro}{\symbolsname} +% \begin{macro}{\numbersname} +% Each index is grouped. Index groups are symbols, numbers and each first +% letter. Each group starts with |\indexgroup|\marg{group} with group is +% either |\symbolsname|, |\numbersname| or a upper case letter. In difference +% to other index processors no automatic |\indexspace| will be added before +% each group. So we define |\indexgroup| to add it. +% \begin{macrocode} +\providecommand*{\indexgroup}[1]{% + \indexspace\textbf{#1}\nopagebreak +} +\providecommand*{\indexspace}{% + \def\indexspace{\vskip\baselineskip} +} +\providecommand*{\symbolsname}{Symbols} +\providecommand*{\numbersname}{Numbers} +\AtBeginDocument{% + \providecaptionname{english}\symbolsname{Symbols}% + \providecaptionname{english}\numbersname{Numbers}% + \providecaptionname{german}\symbolsname{Symbole}% + \providecaptionname{german}\numbersname{Zahlen}% + \providecaptionname{ngerman}\symbolsname{Symbole}% + \providecaptionname{ngerman}\numbersname{Zahlen}% + \providecaptionname{austrian}\symbolsname{Symbole}% + \providecaptionname{austrian}\numbersname{Zahlen}% + \providecaptionname{naustrian}\symbolsname{Symbole}% + \providecaptionname{naustrian}\numbersname{Zahlen}% + \providecaptionname{french}\symbolsname{Symbole}% + \providecaptionname{french}\numbersname{Chiffres}% + \providecaptionname{spanish}\symbolsname{Simbolos}% + \providecaptionname{spanish}\numbersname{N\'umeros}% +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% +% \begin{macro}{\indexpagenumbers} +% \begin{macro}{\indexpagenumber} +% \begin{macro}{\indexpagenumbersep} +% \begin{macro}{\index@pagenumbersep} +% The page numbers of an entry are printed all together as argument of +% |\indexpagenumbers|\marg{page number}. Each single page number is printed as +% argument of |\indexpagenumber|\marg{page number}. So separate the single +% page numbers |\indexpagenumber| is predefined to add internal macro +% |\index@pagenumbersep| before the page number. This will add +% |\indexpagenumbersep| before each page number but the first one. +% \begin{macrocode} +\providecommand*{\indexpagenumbers}[1]{% + \def\index@pagenumbersep{\let\index@pagenumbersep\indexpagenumbersep}% + \nobreakspace-- #1} +\providecommand*{\indexpagenumber}[1]{\index@pagenumbersep #1} +\providecommand*{\indexpagenumbersep}{, } +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% +% \iffalse meta-comment +% +% \fi^^A meta-comment +% +% \section{Examples} +% +% \iffalse meta-comment +%<*example> +% \fi^^A meta-comment +% +% Currently only one example file will be produced: +% \begin{description} +% \item[\normalfont\texttt{luaindex-example}] -- This should show index +% entries, index sub-entries, index sub-sub-entries. +% \begin{macrocode} +\documentclass{article} +\usepackage[ngerman]{babel} +\usepackage{blindtext} +\usepackage{fontspec} +% \end{macrocode} +% We load package \texttt{luaindex} with option \texttt{locale=de\_DE}. At +% least at Linux this will add \"A, \"O, \"U, \"a, \"o, \"u, and \ss{} to the +% letters and even set a valid sort order for those. +% +% We load package \texttt{luaindex} with option \texttt{singlepass} to produce +% a valid index with one \LuaLaTeX{} run instead of two or more. But with this +% printing of the index will produce a new page. +% \begin{macrocode} +\usepackage[ + locale=de_DE, + singlepass % Wenn der Index ohnehin eine neue Seite produziert, + % dann kann er direkt beim ersten Lauf ein korrektes + % Ergebnis liefern. +]{luaindex} +% \end{macrocode} +% +% We use the compatibility command |\makeindex| to generate the ``general'' +% index and the further compatibility commands, e.g., |\index|. +% \begin{macrocode} +\makeindex +% \end{macrocode} +% +% We want |\textbf| to be ignored at the sort: +% \begin{macrocode} +\directlua{koma.luaindex.presortreplace('general',0, + '\luatexluaescapestring{\string\textbf}\space*\string\{([\string^\string\}]*)\string\}','\%1')} +% \end{macrocode} +% +% Now we can start our document. This consist of some text and several index +% entries. +% \begin{macrocode} +\begin{document} + +\blindtext[10] +A\index{B ist der zweite Buchstabe} +aber\index{aber ist ein Wort} +D\index{D ist der vierte Buchstabe} +A\index{A ist der erste Buchstabe} +A\index{A ist der erste Buchstabe} +% \end{macrocode} +% Now, let's do something different. Let's show that babel shorthands may be +% used inside index entries: +% \begin{macrocode} +C\index{C ist "`der"' dritte Buchstabe} +X\index{X ist der drittletzte Buchstabe} +% \end{macrocode} +% And macros may also be used but change the sort sequence of the index! +% \begin{macrocode} +D\index{\textbf{D} ist der Buchstabe nach C} +Y\index{Y ist der \textbf{vorletzte} Buchstabe} +Z\index{Z ist der letzte Buchstabe} +A\index{Ä ist auch ein Buchstabe} +% \end{macrocode} +% We may change the sort sequence manually by adding the \texttt{sort} +% option. The page number format may also be changed using the +% \texttt{pageformat} option. +% \begin{macrocode} +Ä\index[sort={Ä ist aber auch ein Buchstabe},% + pageformat=\emph]{Ä ist wirklich auch + ein Buchstabe (und hier stimmt die Sortierung + nicht -- \emph{aber eigentlich doch})} +% \end{macrocode} +% Let's add one more page with some more index entries: +% \begin{macrocode} +\clearpage + +A\index{A ist der erste Buchstabe} +Ae\index{Ae ist kein Buchstabe, sondern zwei} + +% \end{macrocode} +% And now, let's have some sub-entries and even a sub-sub-entry. One of the +% sub-entries will become a different sort position and will be marked with an +% emphasized page number. +% \begin{macrocode} +Kompliziert\subindex{Diverses}{Untereintrag} +Noch komplizierter\subindex{Diverses}{Obereintrag} +Noch komplizierter\% +subindex{Diverses}[sort=Obereintra,pageformat=\emph]{Untereintrag} +Noch komplizierter% +\subsubindex{Diverses}{Untereintrag}{Unteruntereintrag} + +% \end{macrocode} +% That's enough. Time time to print the index. Remember, that this is already +% a valid index, because we are using option \texttt{singlepass}. +% \begin{macrocode} +\printindex +\end{document} +% \end{macrocode} +% \end{description} +% +% \iffalse meta-comment +% +% \fi^^A meta-comment +% +% \Finale +% +\endinput +%% Local Variables: +%% TeX-master: t +%% TeX-PDF-mode: t +%% TeX-engine: luatex +%% flyspell-mode: t +%% End: diff --git a/Master/texmf-dist/tex/lualatex/luaindex/luaindex.sty b/Master/texmf-dist/tex/lualatex/luaindex/luaindex.sty new file mode 100644 index 00000000000..01ad7ddf926 --- /dev/null +++ b/Master/texmf-dist/tex/lualatex/luaindex/luaindex.sty @@ -0,0 +1,247 @@ +%% +%% This is file `luaindex.sty', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% luaindex.dtx (with options: `package') +%% +%% Copyright (c) 2011 by Markus Kohm +%% +%% This file was generated from file(s) of luaindex distribution. +%% -------------------------------------------------------------- +%% +%% This work may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License, version 1.3c of the license. +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3c or later is part of all distributions of LaTeX +%% version 2005/12/01 or later and of this work. +%% +%% This work has the LPPL maintenance status "maintained". +%% +%% The Current Maintainer and author of this work is Markus Kohm. +%% +%% This file may only be distributed together with the files listed in +%% `luaindex.dtx'. You may however distribute the files listed in +%% `luaindex.dtx' without this file. +%% +%% NOTE: THIS IS AN ALPHA-VERSION! +%% +\NeedsTeXFormat{LaTeX2e}[1995/06/01] +\ProvidesPackage{luaindex} + [2011/02/09 v0.1a LuaLaTeX Package + index processor]% +\RequirePackage{ifluatex} +\ifluatex\else + \PackageError{luaindex}{lualatex needed}{% + Package `luaindex' needs LuaTeX.\MessageBreak + So you should use `lualatex' to process you document!\MessageBreak + See documentation of `luaindex' for further information.}% + \expandafter\expandafter\expandafter\csname endinput\endcsname +\fi +\directlua{dofile("luaindex.lua")} +\newwrite\@indexfile +\AtBeginDocument{% + \IfFileExists{\jobname.ldx}{\directlua{dofile("\jobname.ldx")}}{}% + \openout\@indexfile=\jobname.ldx +} +\RequirePackage{scrbase} +\DefineFamily{luaindex} +\DefineFamilyMember{luaindex} +\newcommand*{\luaindex@sortorder}{} +\DefineFamilyKey{luaindex}{sortorder}{% + \edef\luaindex@sortorder{#1}% +} +\DefineFamilyKey{luaindex}{locale}{% + \if@atdocument + \expandafter\@firstofone + \else + \expandafter\AtBeginDocument + \fi + {% + \protected@write\@indexfile{}{% + os.setlocale("#1","collate") + }% + }% +} +\newcommand*{\luaindex@pageformat}{} +\DefineFamilyKey{luaindex}{pageformat}{% + \def\luaindex@pageformat{#1}% +} +\FamilyBoolKey{luaindex}{singlepass}{@luaindexsinglepass} +\FamilyProcessOptions{luaindex}\relax +\newcommand*{\setupluaindex}{\FamilyOptions{luaindex}} +\newcommand*\see[2]{\emph{\seename} #1} +\providecommand*\seealso[2]{\emph{\alsoname} #1} +\providecommand\seename{see} +\providecommand*\alsoname{see also} +\newcommand*{\newindex}[2][]{% + \directlua{koma.luaindex.newindex("\luatexluaescapestring{#2}")}% + \begingroup + \setupluaindex{#1}% + \ifx\luaindex@sortorder\@empty\else + \AtBeginDocument{% + \protected@write\@indexfile{}{% + koma.luaindex.sortorder("\luatexluaescapestring{#2}", + "\luaindex@sortorder") + }}% + \fi + \endgroup +} +\@onlypreamble\newindex +\newcommand*{\luaindex}[1]{% + \@bsphack + \begingroup + \edef\luaindex@name{#1}% + \lua@index +} +\newcommand*{\lua@index}[2][]{% + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \define@key{luaindex.setindex}{pageformat}{\def\luaindex@pageformat{##1}}% + \define@key{luaindex.setindex}{locale}{\luaindexsetup{locale=#1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + koma.luaindex.insert("\luatexluaescapestring{\luaindex@name}", + "{\luatexluaescapestring{\luaindex@pageformat{\thepage}}}", + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}") + }% + \endgroup + \@esphack +} +\newcommand*{\luasubindex}[1]{% + \@bsphack + \begingroup + \edef\luaindex@name{#1}% + \lua@subindex +} +\newcommand*{\lua@subindex}[2][]{% + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \define@key{luaindex.setindex}{pageformat}{\def\luaindex@pageformat{##1}}% + \define@key{luaindex.setindex}{locale}{\luaindexsetup{locale=#1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + koma.luaindex.insert("\luatexluaescapestring{\luaindex@name}", + "{\luatexluaescapestring{\luaindex@pageformat{\thepage}}}", + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}", + }% + \aftergroup\lua@@subindex + \endgroup +} +\newcommand*{\lua@@subindex}[2][]{% + \begingroup + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + \@spaces + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}") + }% + \endgroup + \@esphack +} +\newcommand*{\luasubsubindex}[1]{% + \@bsphack + \begingroup + \edef\luaindex@name{#1}% + \lua@subsubindex +} +\newcommand*{\lua@subsubindex}[2][]{% + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \define@key{luaindex.setindex}{pageformat}{\def\luaindex@pageformat{##1}}% + \define@key{luaindex.setindex}{locale}{% + \luaindexsetup{locale=#1}% + } + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + koma.luaindex.insert("\luatexluaescapestring{\luaindex@name}", + "{\luatexluaescapestring{\luaindex@pageformat{\thepage}}}", + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}", + }% + \aftergroup\lua@@@subindex + \endgroup +} +\newcommand*{\lua@@@subindex}[2][]{% + \begingroup + \set@display@protect + \edef\luaindex@sort{#2}% + \define@key{luaindex.setindex}{sort}{\edef\luaindex@sort{##1}}% + \setkeys{luaindex.setindex}{#1}% + \protected@write\@indexfile{\let\luatexluaescapestring\relax}{% + \@spaces + "\luatexluaescapestring{\luaindex@sort}", + "\luatexluaescapestring{#2}", + }% + \aftergroup\lua@@subindex + \endgroup +} +\renewcommand*{\makeindex}{% + \newindex{general}% + \renewcommand*\index{\luaindex{general}}% + \newcommand*\subindex{\luasubindex{general}}% + \newcommand*\subsubindex{\luasubsubindex{general}}% +} +\newcommand*{\printindex}[1][]{% + \begingroup + \edef\luaindex@name{general}% + \define@key{luaindex.setindex}{index}{\edef\luaindex@name{##1}}% + \define@key{luaindex.setindex}{singlepass}[true]{% + \setupluaindex{singlepass}{##1}% + }% + \setkeys{luaindex.setindex}{#1}% + \if@luaindexsinglepass + \closeout\@indexfile + \clearpage + \directlua{% + koma.luaindex.removeentries("\luatexluaescapestring{\luaindex@name}") + dofile("\jobname.ldx") + }% + \fi + \directlua{% + koma.luaindex.printindex("\luatexluaescapestring{\luaindex@name}") + }% + \endgroup +} +\providecommand*{\indexgroup}[1]{% + \indexspace\textbf{#1}\nopagebreak +} +\providecommand*{\indexspace}{% + \def\indexspace{\vskip\baselineskip} +} +\providecommand*{\symbolsname}{Symbols} +\providecommand*{\numbersname}{Numbers} +\AtBeginDocument{% + \providecaptionname{english}\symbolsname{Symbols}% + \providecaptionname{english}\numbersname{Numbers}% + \providecaptionname{german}\symbolsname{Symbole}% + \providecaptionname{german}\numbersname{Zahlen}% + \providecaptionname{ngerman}\symbolsname{Symbole}% + \providecaptionname{ngerman}\numbersname{Zahlen}% + \providecaptionname{austrian}\symbolsname{Symbole}% + \providecaptionname{austrian}\numbersname{Zahlen}% + \providecaptionname{naustrian}\symbolsname{Symbole}% + \providecaptionname{naustrian}\numbersname{Zahlen}% + \providecaptionname{french}\symbolsname{Symbole}% + \providecaptionname{french}\numbersname{Chiffres}% + \providecaptionname{spanish}\symbolsname{Simbolos}% + \providecaptionname{spanish}\numbersname{N\'umeros}% +} +\providecommand*{\indexpagenumbers}[1]{% + \def\index@pagenumbersep{\let\index@pagenumbersep\indexpagenumbersep}% + \nobreakspace-- #1} +\providecommand*{\indexpagenumber}[1]{\index@pagenumbersep #1} +\providecommand*{\indexpagenumbersep}{, } +\endinput +%% +%% End of file `luaindex.sty'. diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check index f2b22a919db..e026b5727d7 100755 --- a/Master/tlpkg/bin/tlpkg-ctan-check +++ b/Master/tlpkg/bin/tlpkg-ctan-check @@ -213,7 +213,7 @@ my @TLP_working = qw( lshort-vietnamese ltabptch ltxdockit ltxindex ltxmisc ltxnew lua-alt-getopt luacode - luainputenc lualatex-doc lualibs luamplib luaotfload + luaindex luainputenc lualatex-doc lualibs luamplib luaotfload luasseq luatexbase luatextra lxfonts ly1 macqassign mafr magaz magyar mailing mailmerge diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds index 645680bbe10..7227ec3aa76 100755 --- a/Master/tlpkg/libexec/ctan2tds +++ b/Master/tlpkg/libexec/ctan2tds @@ -1542,6 +1542,7 @@ $standardsource='\.(c|drv|dtx|fea|fdd|ins|sfd)$|configure.*|install-sh'; 'lastpage', 'lastpage.dtx', 'lettre', 'NULL', 'localloc', 'localloc.dtx', + 'luaindex', 'luaindex.dtx', 'makecell', 'makecell.dtx', 'mylatexformat', 'mylatexformat.dtx', 'namespc', 'namespc.dtx', @@ -1597,6 +1598,7 @@ my $core_latex = "$Master/texmf-dist/tex/latex"; 'labelcas' => 'latex', # requires interaction 'lastpage' => 'tex', 'lcd' => 'latex -translate-file=empty.tcx', # no 8-bit + 'luaindex' => 'lualatex --shell-escape', 'mylatexformat'=> 'tex', 'nomentbl' => 'latex -translate-file=empty.tcx', # no 8-bit 'thumb' => 'latex -translate-file=empty.tcx', # no 8-bit @@ -1828,6 +1830,7 @@ $standardxmt='\.xmt'; 'latexmk' => '\.pl$', 'listings-ext' => '\.sh$', 'lua-alt-getopt' => '\.lua$', + 'luaindex' => '\.lua$', 'luasseq' => '\.lua$', 'mathspic' => '^mathspic\.pl$', 'mkgrkindex' => 'mkgrkindex$', diff --git a/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc b/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc index 62187be6995..b0b5dd869e5 100644 --- a/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc +++ b/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc @@ -6,6 +6,7 @@ longdesc as an embedded scripting and extension language. http://luatex.org/ depend collection-basic # depend luacode +depend luaindex depend luainputenc depend lualatex-doc depend lualibs diff --git a/Master/tlpkg/tlpsrc/luaindex.tlpsrc b/Master/tlpkg/tlpsrc/luaindex.tlpsrc new file mode 100644 index 00000000000..e69de29bb2d -- cgit v1.2.3