%% This is part of OpTeX project, see http://petr.olsak.net/optex \_codedecl \maketoc {Macros for maketoc <2020-03-12>} % preloaded in format \_doc ------------------------------------ `\_Xtoc{}{}{}{}` (in `.ref` file) reads the specified data and saves it to the `\_toclist` as: \begtt \_tocline{}{}{}{}{}{} where: : 0 reserved, 1: chapter, 2: section, 3: subsection : the type of the level, i.e. chap, sec, secc : the number of the chapter/section/subsection in the format 1.2.3 : the title text : the page number numbered from 1 independently of pagination : the page number used in the pagination \endtt The last two parameters are restored from previous `\_Xpage{}{}`, data are saved in the `\_currpage` macro. \_cod ------------------------------------ \_def\_toclist{} \_newifi \_ifischap \_ischapfalse \def\_Xtoc#1#2#3#4{\_ifnum#1=0 \_ischaptrue\_fi \_addto\_toclist{\_tocline{#1}{#2}{#3}{#4}} \_ea\_addto\_ea\_toclist\_ea{\_currpage}% } \_doc ------------------------------------ `\_tocline{}{}{}{}{}{}` prints the record to the table of contents. It opens group, reduces `\_leftskip`, `\_rightskip`, runs the `\everytocline` (user can customise the design of TOC here) and runs `\_tocl: {}{}{}` macro. This macro starts with vertical mode, inserts one record with given and ends in horizontal mode. Then `\_tocline` appends `\_nobreak \_hskip-2\_iindent\_null \_par`. This causes that the last line of the record is shifted outside the margin given by `\_rightskip`. A typical record (with long ) looks like: \begtt | | \llap{} text text text text text text text text text text text text .................... \endtt Margins given by `\leftskip` and `\rightskip` are denoted by `|` in the examle above. \_cod ------------------------------------ \def\_tocline#1#2#3#4#5#6{% \_advance\_tocrefnum by1 \_bgroup \_leftskip=\_iindent \_rightskip=2\_iindent \_ifischap \_advance\_leftskip by \_iindent \_fi \_def\_pg{\_ilink[pg:#5]}% \_the\_everytocline \_ifcsname _tocl:#1\_endcsname \_cs{_tocl:#1}{#3}{#4}{#6}\_nobreak \_hskip-2\_iindent\_null \_par \_fi \_egroup } \_doc ----------------------------------- You can re-define default macros for each level of tocline if you want: \_cod ----------------------------------- \_sdef{_tocl:1}#1#2#3{\_nofirst\_bigskip \_bf\_llaptoclink{#1}{#2}\_hfill \_pg{#3}} \_sdef{_tocl:2}#1#2#3{\_llaptoclink{#1}{#2}\_tocdotfill \_pg{#3}} \_sdef{_tocl:3}#1#2#3{\_advance\_leftskip by\_iindent \_cs{_tocl:2}{#1}{#2}{#3}} \_doc ----------------------------------- The auxiliary macros are: \begitems * `\_llaptoclink` does `\_noindent\_llap{}`. * `\_tocdotfill` creates dots in the TOC. * `\_nofirst\macro` applies the `\macro` only if we don't print the first record of the TOC. * `\_pg{}` creates as link to real saved in `#6` of `\tocline`. \enditems \_cod ---------------------------------- \_def\_llaptoclink#1{\_noindent \_llap{\_ilink[toc:\_the\_tocrefnum]{\_enspace#1\_kern.4em}\kern.1em}} \_def\_tocdotfill{\_nobreak\_leaders\_hbox to.8em{\_hss.\_hss}\_hskip 1em plus1fill\_relax} \_def\_nofirst #1{\_ifnum \_lastpenalty=11333 \_else #1\_fi} \_doc ----------------------------------- `\maketoc` prints warning if TOC data is empty, lse it creates TOC by running `\_toclist` \_cod ---------------------------------- \_def\_maketoc{\_par \_ifx\_toclist\_empty \_opwarning{\_noexpand\maketoc -- data unavailable, TeX me again}\_openref \_else \_begingroup \_tocrefnum=0 \_penalty11333 \_the\_regtoc \_toclist \_endgroup \_fi } \_doc ----------------------------------- `\regmacro` appends its parameters to `\_regtoc`, `\_regmark` and `\_regoul`. These token lists are used in `\maketoc`, `\_begoutput` and `\pdfunidef`. \_cod \_fin ----------------------------- \_newtoks \_regtoc \_newtoks \_regmark \_newtoks \_regoul \_def\_regmacro #1#2#3{% \_toksapp\_regtoc{#1}\_toksapp\_regmark{#2}\_toksapp\_regoul{#3}% } \_public \maketoc \regmacro ; \_endcode