1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
|
% \CheckSum{1577}
% \iffalse^^A meta-comment
% ======================================================================
% scrlayer-notecolumn.dtx
% Copyright (c) Markus Kohm, 2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
% 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 and of this work.
%
% This work has the LPPL maintenance status "author-maintained".
%
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrlayer-notecolumn.dtx
% Copyright (c) Markus Kohm, 2013
%
% Diese Datei ist Teil der LaTeX2e KOMA-Script-Sammlung.
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c.
% Die neuste Version dieser Lizenz ist
% http://www.latex-project.org/lppl.txt
% und Version 1.3c ist Teil aller Verteilungen von LaTeX
% Version 2005/12/01 und dieses Werks.
%
% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained"
% (allein durch den Autor verwaltet).
%
% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm.
%
% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien.
% ======================================================================
% \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^^A meta-comment
%<identify>%%% From File: $Id: scrlayer-notecolumn.dtx 1514 2013-11-15 08:23:09Z mjk $ (identify)
%<init>%%% From File: $Id: scrlayer-notecolumn.dtx 1514 2013-11-15 08:23:09Z mjk $ (init)
%<options>%%% From File: $Id: scrlayer-notecolumn.dtx 1514 2013-11-15 08:23:09Z mjk $ (options)
%<body>%%% From File: $Id: scrlayer-notecolumn.dtx 1514 2013-11-15 08:23:09Z mjk $ (body)
%<*dtx>
\ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi
\begingroup
\def\filedate$#1: #2-#3-#4 #5${\gdef\filedate{#4/#3/#2}}
\filedate$Date: 2013-11-15 09:23:09 +0100 (Fr, 15. Nov 2013) $
\def\filerevision$#1: #2 ${\gdef\filerevision{v0.1.#2}}
\filerevision$Revision: 1514 $
\endgroup
\ProvidesFile{scrlayer-notecolumn.dtx}[\filedate\space\filerevision\space
%</dtx>
%<*identify|doc>
%<interface>\NeedsTeXFormat{LaTeX2e}[1995/12/01]
%<interface>\ProvidesPackage{scrlayer-notecolumn}[%
%<doc>\ProvidesFile{scrlayer-notecolumn.tex}[%
% Sometimes following will be replaced by !KOMASCRIPTVERSION:
%!SCRLAYERVERSION
%<interface> package
%</identify|doc>
%<*dtx|identify|doc>
(end user interface for scrlayer)]
%</dtx|identify|doc>
%<*dtx>
\ifx\documentclass\undefined
\input scrdocstrip.tex
\@@input scrkernel-version.dtx
\@@input scrstrip.inc
% Some time we will need:
% \KOMAdefVariable{COPYRIGHTFROM}{2013}
\KOMAdefVariable{SCRLAYERVERSION}{\space\space\filedate\space\filerevision}%
\expandafter\let\csname ifbetawas\expandafter\endcsname
\csname ifbeta\endcsname
\expandafter\let\csname ifbeta\expandafter\endcsname
\csname iftrue\endcsname
\generate{\usepreamble\defaultpreamble
\file{scrlayer-notecolumn.sty}{%
\from{scrlayer-notecolumn.dtx}{interface,trace,notecolumn,identify}%
\from{scrlayer.dtx}{interface,trace,notecolumn,init}%
\from{scrlayer-notecolumn.dtx}{interface,trace,notecolumn,init}%
\from{scrlayer.dtx}{interface,trace,notecolumn,options}%
\from{scrlayer-notecolumn.dtx}{interface,trace,notecolumn,options}%
\from{scrlayer.dtx}{interface,trace,notecolumn,body}%
\from{scrlayer-notecolumn.dtx}{interface,trace,notecolumn,body}%
\from{scrlayer-notecolumn.dtx}{interface,trace,notecolumn,final}%
\from{scrlogo.dtx}{logo}%
}%
\file{scrlayer-notecolumn.tex}{%
\from{scrlayer-notecolumn.dtx}{doc}%
}%
}
\expandafter\let\csname ifbeta\expandafter\endcsname
\csname ifbetawas\endcsname
\@@input scrstrop.inc
\else
\let\endbatchfile\relax
\fi
\endbatchfile
%</dtx>
%<*driver>
\documentclass{scrdoc}
\addtolength{\textwidth}{-1em}
\addtolength{\marginparwidth}{2em}
\addtolength{\oddsidemargin}{2em}
\usepackage[ngerman,english]{babel}
\usepackage{url,babelbib}\bibliographystyle{babalpha-fl}
\usepackage{listings}
\usepackage{scrhack}
\usepackage{etoolbox}
\pretocmd\DescribeMacro{\ifhmode\else\bigskip\noindent\fi}{}{}
\pretocmd\DescribeEnv{\ifhmode\else\bigskip\noindent\fi}{}{}
\pretocmd\DescribeOption{\ifhmode\else\bigskip\noindent\fi}{}{}
\CodelineIndex
\RecordChanges
\GetFileInfo{scrlayer-notecolumn.dtx}
\title{The \texttt{scrlayer} interface \texttt{scrlayer-notecolumn}%
\footnote{This is version \fileversion\ of file \texttt{\filename}.}}
\date{\filedate}
\author{Markus Kohm}
\newenvironment{Explain}{\par}{\par}
\newcommand*{\length}{}
\let\length\Length
\let\endlength\endLength
\let\Macro\cs
\let\Length\Macro
\let\Package\textsf
\let\Class\Package
\let\File\texttt
\let\Option\texttt
\newcommand*{\KOption}[1]{\Option{#1}\texttt{=}}
\newcommand*{\OptionValue}[2]{\Option{#1}\texttt{=}\PValue{#2}}
\let\Counter\texttt
\let\Environment\texttt
\let\ShowOutput\quote
\let\endShowOutput\endquote
\let\Pagestyle\texttt
\newcommand*{\Parameter}[1]{\texttt{\marg{#1}}\linebreak[1]}
\newcommand*{\OParameter}[1]{\texttt{\oarg{#1}}\linebreak[1]}
\newcommand*{\MParameter}[2]{\texttt{(\meta{#1},\meta{#2})}\linebreak[1]}
\providecommand\PParameter[1]{\mbox{\texttt{\{#1\}}}\linebreak[1]}
\let\PName\meta
\let\PValue\texttt
\providecommand*{\autoref}[1]{\expandafter\AUTOREF#1:}
\providecommand*{\AUTOREF}{}
\makeatletter
\def\AUTOREF#1:#2:{%
\edef\@tempa{#1}%
\edef\@tempb{tab}\ifx\@tempa\@tempb table~\fi
\edef\@tempb{sec}\ifx\@tempa\@tempb section~\fi
\ref{#1:#2}%
}
\providecommand*{\IndexCmd}[2][]{}
\providecommand*{\textnote}[2][]{}
\providecommand*\eTeX{\leavevmode\hbox{$\varepsilon$}-\TeX}
\providecommand*\NTS{%
\leavevmode\hbox{$\cal N\kern-0.35em\lower0.5ex\hbox{$\cal T$}%
\kern-0.2emS$}}
\lstnewenvironment{lstcode}{\lstset{language=[LaTeX]TeX}}{}
\makeatother
\sloppy% YOU SHOULD NOT DO THIS!!!
\begin{document}
\maketitle
\tableofcontents
\DocInput{\filename}
\PrintChanges
\PrintIndex
\end{document}
%</driver>
% \fi^^A meta-comment
%
% \selectlanguage{english}
%
% \changes{v0.0}{2013/04/26}{start of interface}
% \let\restorechapter\chapter
% \let\chapter\section
% \let\section\subsection
% \let\subsection\subsubsection
% \iffalse
%<*dtx|doc>
% \fi
\chapter[{End User Interface \Package{scrlayer-notecolumn}}]{End User
Interface \Package{scrlayer-notecolumn}\footnote{This is not a translation
of the corresponding chapter of the German \KOMAScript{} manual but the
tentative and primary implementation manual of package
\Package{scrlayer-notecolumn}. As long as \Package{scrlayer-notecolumn} is
primary a proof of concept this doesn't matter. But nevertheless, a
German to English translator would still be welcome.}}
\label{sec:scrlayer.notecolumn}
%\iffalse
\labelbase{scrlayer-notecolumn}
%\fi
Sometimes documents need an additional notes column beside the main text
column and maybe beside the marginal note column. Problematicly may be
having page breaks inside the notes column. This package provides a
solution based on the layer interface of \Package{scrlayer}. You may
define several notes columns, each of them with page breaks
inside. It supports automatic page break inside of notes and recognises
note collisions and solve them by moving notes.
The idea of this package raised while an e-mail contact with Heiner
Richter from FH~Stralsund, who told me of a book project, and asked
whether or not such a functionality may be added to another package of
mine easily. It couldn't, but design and implementation of a first test
alpha of \Package{scrlayer-notecolumn} has been done in about three
hours. So maybe it was a really good idea to ask me the question.
%\iffalse^^A meta-comment
\begin{Declaration}
%\fi^^A meta-comment
% \DescribeMacro{\DeclareNoteColumn}
% \DescribeMacro{\DeclareNewNoteColumn}
% \DescribeMacro{\ProvideNoteColumn}
% \DescribeMacro{\RedeclareNoteColumn}
% The command
\Macro{DeclareNoteColumn}%
\OParameter{option list}\Parameter{note column name}%
%\iffalse^^A meta-comment
\\
\Macro{DeclareNewNoteColumn}%
\OParameter{option list}\Parameter{note column name}\\%^^A
\Macro{ProvideNoteColumn}%
\OParameter{option list}\Parameter{note column name}\\%^^A
\Macro{RedeclareNoteColumn}%
\OParameter{option list}\Parameter{note column name}%
\end{Declaration}
\BeginIndex{Cmd}{DeclareNoteColumn}%
\BeginIndex{Cmd}{DeclareNewNoteColumn}%
\BeginIndex{Cmd}{ProvideNoteColumn}%
\BeginIndex{Cmd}{RedeclareNoteColumn}%
Command \Macro{DeclareNoteColumn}
%\fi^^A meta-comment
may be used to declare a note column. Each note column is referenced by its
name, defined by the obligatory argument \PName{note column name}. A note
column vertically span the text area.
By default its horizontal position is the current position of the marginal
note column. It also regards \Macro{reversemarginpar} and
\Macro{normalmarginpar}, while output of a note. Note that this is not the
same like making a margin note. The default width is
\Length{marginparwidth}. But you may use the optional argument \PName{option
list} to change this behaviour.
The \PName{option list} is a comma-separated list of
\texttt{\PName{key}=\PName{value}} options. Currently the following
\PName{key}s are supported:
\begin{labeling}[\ --]{\KOption{position}\PName{horizontal offset}}
\item [\KOption{font}\PName{font declaration}] set the initial font attributes
to be used for the note column. Everything, that is allowed to be set by
\Macro{setkomafont} or \Macro{addtokomafont} can be used as
\PName{font declaration}. Note, that
\Macro{normalfont}\Macro{normalsize} will be used
before. So you don't need one of them at your own initialisation.
\item [\Option{marginpar}] set up \Option{position} and \Option{width} to use
the marginal note column of \Macro{marginpar}.
\item [\Option{normalmarginpar}] set up \Option{position} and \Option{width}
to use the normal marginal note column and ignore \Macro{reversemarginpar}
and \Macro{normalmarginpar}.
\item [\KOption{position}\PName{horizontal offset}] set up the horizontal
offset of the note column from the left edge of the paper. The
\PName{horizontal offset} can be either a \LaTeX{} length, a \TeX{}
dimension, a \TeX{} skip, a length value, or a dimensional expression using
\texttt{+}, \texttt{-}, \texttt{*}, \texttt{/} and parenthesis (see
\cite[section~3.5]{manual:eTeX} for more information about dimensional
expressions). The value will be calculated at usage time not at definition
time. So you may even use more complex constructs like:
\begin{lstcode}
\ifodd\value{page}
\oddsidemargin+1in
+\textwidth+\marginparsep
\else
\evensidemargin+1in
-\marginparsep
-\marginparwidth
\fi
\end{lstcode}
\item [\Option{reversemarginpar}] set up \Option{position} and \Option{width}
to use the reverse marginal note column and ignore \Macro{reversemarginpar}
and \Macro{normalmarginpar}.
\item [\KOption{width}\PName{size}] set up the horizontal size of the note
column. You can use the same values for \PName{size} like for
\PName{horizontal offset} of option \Option{position}.
\end{labeling}
You may use as much note columns as \LaTeX{} provides free box registers,
because every note column needs one box register. You may use package
\Package{etex} to increase the normal amount of box registers from 256 to
32768. This should be enough to avoid the ``\texttt{no room for
\Macro{newbox}}'' error.
The implementation of note columns uses foreground layers from package
\Package{scrlayer}. Every \Macro{DeclareNoteColumn} generates a layer and adds
this layer to the pseudo page style \Pagestyle{@everystyle@}. Theoretically
you may modify the generated layer, but it is recommended not to modify them.
Overlapping of different note columns is allowed. There's one predefined note
column named ``\texttt{marginpar}''.
% \iffalse^^A meta-comment
\BeginIndex{FontElement}{notecolumn.\PName{note column name}}%
% \fi^^A meta-comment
Note, that if you change the initial font using
\begin{quote}
\Macro{setkomafont}\linebreak[1]\PParameter{marginnote.\PName{note column
name}}\Parameter{font declaration}
\end{quote}
or
\begin{quote}
\Macro{addtokomafont}\linebreak[1]\PParameter{marginnote.\PName{note column
name}}\Parameter{font declaration}
\end{quote}
the font of all succeeding note column outputs would change. This could make it
hard to find out, which notes will be affected by the change.
% \iffalse^^A meta-comment
See \autoref{sec:maincls.textmarkup},
\autopageref{desc:maincls.cmd.setkomafont} for more information about
\Macro{setkomafont} and \Macro{addtokomafont}.%
\EndIndex{FontElement}{notecolumn.\PName{note column name}}%
% \fi^^A meta-comment
The difference between \Macro{DeclareNoteColumn} and the other commands is,
that \Macro{DeclareNoteColumn} defines the note column independent whether a
note column with the same name has already been defined or
not. \Macro{DeclareNewNoteColumn} defined only note columns which names are
not yet used for another note column. It's an error to use it with an already
used \PName{note column name}. \Macro{ProvideNoteColumn} is like
\Macro{DeclareNewNoteColumn}, but if the \PName{note column name} is already
used for a note column nothing happens. \Macro{RedeclareNoteColumn} may be
used to declare a note column with a name, that is already used. Using it with
a new name is an error.
%\iffalse^^A meta-comment
\EndIndex{Cmd}{RedeclareNoteColumn}%^^A
\EndIndex{Cmd}{ProvideNoteColumn}%^^A
\EndIndex{Cmd}{DeclareNewNoteColumn}%^^A
\EndIndex{Cmd}{DeclareNoteColumn}%^^A
%\fi^^A meta-comment
%\iffalse^^A meta-comment
\begin{Declaration}
%\fi^^A meta-comment
% \DescribeMacro{\makenote}
% The command
\Macro{makenote}%
\OParameter{note column name}\Parameter{note text}
%\iffalse^^A meta-comment
\end{Declaration}
\BeginIndex{Cmd}{makenote}%
This command
%\fi^^A meta-comment
may be used to make a new note. The note will be written to a helper file with
extension \File{.slnc} in this run. In the next run, it will be
typeset. Normally it will be typeset with the same vertical position, that
would be used for a \Macro{parbox[t]}, but horizontally moved to the note
column. Collisions at this position of this note column (but not of other note
columns) will be recognised. In such a case the note may be moved down and
even to another page. Automatic page breaks at the note columns are
supported. This is something different to \Macro{marginpar},
\Macro{marginline} (\KOMAScript{} classes), or \Macro{marginnote} (package
\Package{marginnote}).
Note, that after changing the document, at least two \LaTeX{} runs are needed
to move the note to its final position.
Note, that fragile commands should be protected to avoid error messages while
writing or reading the helper file.
Note, that \Package{scrlayer-notecolumn} needs only one helper file for all
note columns together. You should not edit or change that helper file, because
the syntax is fragile. It won't be read using \Macro{input} but
\Macro{read}. Because of this, line breaks, empty lines and \Macro{par} should
be avoided.
Currently it is unknown where you may use \Macro{makenote} and where not. But
you must not use \Macro{makenote} inside of \Macro{makenote}!
The default for the optional argument \PName{makenote} is \PValue{marginpar},
that is the \PName{note column name} of the pre-defined note column.
%\iffalse^^A meta-comment
\EndIndex{Cmd}{makenote}
%\fi^^A meta-comment
%\iffalse^^A meta-comment
\begin{Declaration}
\KOption{autoclearnotecolumns}\PName{simple switch}\\
%\fi^^A meta-comment
% \DescribeMacro{\clearnotecolumn}
% The commands
\Macro{clearnotecolumn}\OParameter{name of a note column}%
% \iffalse^^A meta-comment
\\
% \fi^^A meta-comment
% and
\Macro{clearnotecolumns}\OParameter{list of note column names}
%\iffalse^^A meta-comment
\end{Declaration}
\BeginIndex{Cmd}{clearnotcolumn}%
\BeginIndex{Cmd}{clearnotcolumns}%
The commands
%\fi^^A meta-comment
may be used to output all hanging notes for either one or several note
columns. With \Macro{clearnotecolumn} only the notes of the note column with
the given \PName{name of a note column} will be output. If you omit the
optional argument (this is not the same like using an empty value!) note
column \PValue{marginnote} will be used.
With \Macro{clearnotecolumns} the notes of all note columns of the comma
separated \PName{list of note column names} will be output. If you omit the
optional Argument or if the optional Argument is empty (or start with
\Macro{relax}) the notes of all note columns will be output.
Macro \Macro{clearpage} will be used to output hanging notes and several
\LaTeX{} runs may be needed to terminate with the correct number of
\Macro{clearpage} for the whole document. You will get the message ``\LaTeX{}
Warning: Label(s) may have changed. Rerun to get cross-references right.'' as
long as the process hasn't been terminated.
But normally you don't need to us \Macro{clearnotecolum} or
\Macro{clearnotecolumns} yourself. Because by default option
\Option{autoclearnotecolumns} is switched on, which means, that
\Macro{clearnotecolumns} will be done at every \Macro{clearpage}. You may
change this, switching off \Macro{autoclearnotecolumns} using one of the
values for simple switches.
Note, that it is not allowed to use \Macro{clearnotecolumn} or
\Macro{clearnotecolumns} inside a note. You can use these commands only inside
the main text of the document.%
%\iffalse^^A meta-comment
\EndIndex{Cmd}{clearnotcolumns}%
\EndIndex{Cmd}{clearnotcolumn}%
%\fi^^A meta-comment
%\iffalse^^A meta-comment
\begin{Declaration}
%\fi^^A meta-comment
% \DescribeMacro{\syncwithnotecolumn}
% The commands
\Macro{syncwithnotecolumn}\OParameter{name of a note column}%
% \iffalse^^A meta-comment
\\
% \fi^^A meta-comment
% and
\Macro{syncwithnotecolumns}\OParameter{list of note column names}%
%\iffalse^^A meta-comment
\end{Declaration}
\BeginIndex{Cmd}{syncwithnotecolumn}%
\BeginIndex{Cmd}{syncwithnotecolumns}%
These commands
%\fi^^A meta-comment
may be used to synchronise the vertical position of the main text with one or
several note columns. If you use the optional argument of
\Macro{syncwithnotecolumn} it should be one \PName{name of a note column}. If
you omit it, \PValue{marginpar} will be used as the \PName{name of a note
column}. Usage of \Macro{syncwithnotecolumn} is exactly the same like usage
of \Macro{syncwithnotecolumns} with exactly one \PName{name of a note column}.
The optional argument of \Macro{syncwithnotecolumns} is a comma-separated list
of names of note columns. If you omit this optional argument or if you use an
empty argument or if the argument starts with \Macro{relax} synchronisation
will be done with all declared note columns.
Synchronisation with a note column means, that the current position of the
main text will be changed to be the current vertical position of the note
column after cleaning the note column. This differs in several point from
cleaning a note column:
\begin{itemize}
\item After cleaning a note column the text position would change to be at a
new page, even if the note column doesn't fill the whole page
before. Synchronisation will change the vertical position just after the
last vertical position of the note column.
\item Cleaning a note column needs less \LaTeX{} runs than synchronising a
note column.
\end{itemize}
Both, cleaning an synchronising a note column, uses the label mechanism of
\LaTeX{} without using \Macro{label}, \Macro{ref}, or \Macro{pageref} itself
(but \Macro{newlabel}). So you should have a look at \LaTeX{} rerun messages,
because of undefined or changed labels.
Note, that it is not allowed to use \Macro{syncwithnotecolumn} or
\Macro{syncwithnotecolumns} inside a note. If you do so, you need endless
\LaTeX{} runs without reaching a final state. But synchronisation of several
note columns in the main text of a document will also synchronise the notes
columns with each others.%
%\iffalse^^A meta-comment
\EndIndex{Cmd}{syncwithnotecolumns}
\EndIndex{Cmd}{syncwithnotecolumn}
%\fi^^A meta-comment
%\iffalse
%</dtx|doc>
%\fi
%
% \StopEventually{}
%
% \chapter{Implementation of \Package{scrlayer-notecolumn}}
%
% This section if for developers only.
%
% \iffalse
%<*interface>
%<*identify>
% \fi
%
%\iffalse
%</identify>
%\fi
%
%
% \section{Initialising some Values before the Options}
%
% \iffalse^^A meta-comment
%<*init>
% \fi^^A meta-comment
%
% Initialisation before all options (even the options from
% \File{scrlayer.dtx}).
%
% Here we test the used pdf\TeX{} primitives.
% \begin{macrocode}
\@tempswatrue
\scr@ifundefinedorrelax{pdfsavepos}{%
\expandafter\@tempswafalse
}{%
\scr@ifundefinedorrelax{pdflastypos}{%
\expandafter\@tempswafalse
}{}%
}
\if@tempswa\else
\PackageError{scrlayer-notecolumn}{missing pdfTeX features}{%
This package needs \string\pdfsavepos\space and
\string\pdflastypos.\MessageBreak
This error is fatal, because usage of the package without these
features\MessageBreak
cannot work!\MessageBreak
You shouldn't continue, but if you'd try, I'll try to abort the LaTeX run
}%
\batchmode\csname @@end\endcsname\end
\fi
% \end{macrocode}
%
% \iffalse^^A meta-comment
%</init>
% \fi^^A meta-comment
%
% \section{Making a Note Column}
%
% The package supports a various number of note columns. Each is referenced by
% a unique name.
%
% \begin{macro}{\DeclareNoteColumn}
% \begin{description}
% \item[\OParameter{option list}:] a comma-separated list of
% \texttt{\meta{key}=\meta{value}} pairs.
% \item[\Parameter{string}:] the name of the note column (must be fully
% expandable and expand to a string only).
% \end{description}
% That's the primary command for note columns. It defines everything, the note
% column needs.
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\DeclareNoteColumn{%
\newcommand*{\DeclareNoteColumn}[2][]{%
% \end{macrocode}
% First of all we need a box register. The contents of the note column will be
% build inside of this register. Since \eTeX{} registers shouldn't be a
% problem. User should use package \Package{etex}, if he or she runs out of
% registers. Note, that the registers will stay allocated, if the interface
% will be removed! Nevertheless, the name will be destroyed!
% \begin{macrocode}
\@ifundefined{slnc@#2@box}{%
\expandafter\newsavebox\csname slnc@#2@box\endcsname
\scrlayerOnAutoRemoveInterface[scrlayer-notecolumn.sty]{%
\expandafter\let\csname slnc@#2@box\endcsname\relax
}%
}{}%
% \end{macrocode}
% There's also a kind of item stack of unprocessed notes for each note column.
% \begin{macrocode}
\@ifundefined{slnc@#2@unprocessed}{%
\@namedef{slnc@#2@unprocessed}{}%
\scrlayerOnAutoRemoveInterface[scrlayer-notecolumn.sty]{%
\expandafter\let\csname slnc@#2@unprocessed\endcsname\relax
}%
}{}%
% \end{macrocode}
% Next we need a horizontal positions and a width for the note column. Neither
% the horizontal position nor the width are stretchable or shrinkable. The
% position should be variable depending on the page. So it's better to use a
% macro instead of a length. The width isn't more variable than, e.g., the
% text width. So we can use a macro too. Both will be initialised to the
% normal marginal note column.
% \begin{macrocode}
\@ifundefined{slnc@#2@pos}{%
\scrlayerOnAutoRemoveInterface[scrlayer-notecolumn.sty]{%
\expandafter\let\csname slnc@#2@pos\endcsname\relax
}%
}{}%
\@ifundefined{slnc@#2@width}{%
\scrlayerOnAutoRemoveInterface[scrlayer-notecolumn.sty]{%
\expandafter\let\csname slnc@#2@width\endcsname\relax
}%
}{}%
% \end{macrocode}
% If there isn't a font element for the (new) note column, we define a new one
% and add it to the auto-remove code:
% \begin{macrocode}
\@ifundefined{scr@fnt@notecolumn.#2}{%
\@ifundefined{@notecolumn.#2font}{%
\scrlayerOnAutoRemoveInterface[scrlayer-notecolumn.sty]{%
\expandafter\let\csname @notecolumn.#2font\endcsname\relax
}%
}{%
\PackageInfo{scrlayer-notecolumn}{using already defined
macro\MessageBreak
`\expandafter\string\csname @notecolumn.#2font\endcsname' for font
element\MessageBreak
`notecolumn.#2'%
}%
}%
\newkomafont{notecolumn.#2}{}%
\scrlayerOnAutoRemoveInterface[scrlayer-notecolumn.sty]{%
\expandafter\let\csname scr@fnt@notecolumn.#2\endcsname\relax
}%
}{%
\PackageInfo{scrlayer-notecolumn}{using already defined font
element\MessageBreak
`notecolumn.#2'%
}%
}%
% \end{macrocode}
% After the initialisation we process the options, that may change the initial
% values.
% \begin{macrocode}
\newcommand*{\slnc@name}{}%
\edef\slnc@name{#2}%
\FamilyExecuteOptions[.definenotecolumn]{KOMAarg}{marginpar,#1}%
\let\slnc@name\relax
% \end{macrocode}
% The values are set up, so they may be used to declare a layer.
% \begin{macrocode}
\DeclareLayer[%
foreground,%
align=tl,%
voffset=1in+\topmargin+\headheight+\headsep,%
height=\dimexpr\textheight+\topskip\relax,%
hoffset=\csname slnc@#2@pos\endcsname,%
width=\csname slnc@#2@width\endcsname,%
contents=\slnc@processnotes{#2}%
]{notecolumn.#2}
% \end{macrocode}
% We need to add the layer to every page style. The easiest way to do this is
% to add it to the pseudo layer page style \Pagestyle{@everystyle@}.
% \begin{macrocode}
\AddLayersToPageStyle{@everystyle@}{notecolumn.#2}%
% \end{macrocode}
% On auto-removing the interface, the layer should be removed from
% \Pagestyle{@everystyle@} and should be destroyed.
% \begin{macrocode}
\scrlayerOnAutoRemoveInterface[scrlayer-notecolumn.sty]{%
\RemoveLayersFromPageStyle{@everystyle@}{notecolumn.#2}%
\DestroyLayer{notecolumn.#2}%
}%
% \end{macrocode}
% Last but not least, we add the new note column to the note column procession
% list.
% \begin{macrocode}
\@cons\slnc@processnotecolumns{{#2}}%
}%
}
% \end{macrocode}
% \begin{macro}{\slnc@processnotecolumns}
% This is a list of all declared note columns in \LaTeX{} syntax (using
% \Macro{@cons} and \Macro{@elt} etc.).
% \begin{macrocode}
\scrlayerAddToInterface\slnc@processnotecolumns{%
\newcommand*{\slnc@processnotecolumns}{}%
}
% \end{macrocode}
% \end{macro}^^A \slnc@processnotecolumns
% \begin{macrocode}
%</body>
% \end{macrocode}
% One note column will be declared by default:
% \begin{macrocode}
%<*final>
\DeclareNoteColumn{marginpar}
%</final>
%<*body>
% \end{macrocode}
% \begin{macro}{\slnc@testforpagestylewarning}
% Not all page styles are layer page styles, but only layer page styles can be
% extended by the note column layers. So we warn, if another page style has
% been selected.
% \begin{macrocode}
\scrlayerAddToInterface\slnc@testforpagestylewarning{%
\newcommand*{\slnc@testforpagestylewarning}{%
\IfLayerPageStyleExists{\currentpagestyle}{}{%
\PackageWarning{scrlayer-notecolumn}{%
output of note columns delayed,\MessageBreak
because with `\currentpagestyle'\MessageBreak
a page style has been selected, that\MessageBreak
isn't a layer page style,%
}%
}%
}%
}
\AfterSelectAnyPageStyle{\slnc@testforpagestylewarning}
% \end{macrocode}
% \end{macro}%^^A \slnc@testforpagestylewarning
% \begin{option}{position}
% \begin{option}{width}
% \begin{option}{font}
% \begin{option}{marginpar}
% \begin{option}{normalmarginpar}
% \begin{option}{reversemarginpar}
% Last but not least we have to define the options for the \PName{option
% list}.
% \begin{macrocode}
\DefineFamilyMember[.definenotecolumn]{KOMAarg}
\DefineFamilyKey[.definenotecolumn]{KOMAarg}{position}{%
\@namedef{slnc@\slnc@name @pos}{\dimexpr #1\relax}%
\FamilyKeyStateProcessed
}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@position}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@position@default}
\DefineFamilyKey[.definenotecolumn]{KOMAarg}{width}{%
\@namedef{slnc@\slnc@name @width}{\dimexpr #1\relax}%
\FamilyKeyStateProcessed
}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@width}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@width@default}
\DefineFamilyKey[.definenotecolumn]{KOMAarg}{font}{%
\setkomafont{notecolumn.\slnc@name}{#1}%
\FamilyKeyStateProcessed
}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@font}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@font@default}
\DefineFamilyKey[.definenotecolumn]{KOMAarg}{marginpar}[\relax]{%
\FamilyKeyStateProcessed
\scrlayer@testunexpectedarg{marginpar}{#1}%
\edef\reserved@a{\noexpand\slnc@defpos{\slnc@name}}\reserved@a
\@namedef{slnc@\slnc@name @width}{\marginparwidth}%
}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@marginpar}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@marginpar@default}
% \end{macrocode}
% \begin{macro}{\slnc@defpos}
% Little helper for option \Option{marginpar}. The argument is the expanded
% name of the note column.
% \begin{macrocode}
\scrlayerAddToInterface\slnc@defpos{%
\newcommand*\slnc@defpos[1]{%
\@namedef{slnc@#1@pos}{%
\ifodd\value{page}
\if@reversemargin
% \end{macrocode}
% The reverse marginal note column on odd pages is at the left margin.
% \begin{macrocode}
\dimexpr \oddsidemargin+1in
-\marginparsep-\csname slnc@#1@width\endcsname\relax
\else
% \end{macrocode}
% The normal marginal note column on odd pages is the right margin.
% \begin{macrocode}
\dimexpr \oddsidemargin+1in
+\textwidth+\marginparsep\relax
\fi
\else
\if@twoside
\if@reversemargin
% \end{macrocode}
% The reverse marginal note column on even pages is the right margin.
% \begin{macrocode}
\dimexpr \evensidemargin+1in
+\textwidth+\marginparsep\relax
\else
% \end{macrocode}
% The normal marginal note column on even pages is at the left margin.
% \begin{macrocode}
\dimexpr \evensidemargin+1in
-\marginparsep-\csname slnc@#1@width\endcsname\relax
\fi
\else
% \end{macrocode}
% \begin{macrocode}
% If not in two-side mode, do the same already done for odd pages.
\if@reversemargin
\dimexpr \oddsidemargin+1in
-\marginparsep-\csname slnc@#1@width\endcsname\relax
\else
\dimexpr \oddsidemargin+1in
+\textwidth+\marginparsep\relax
\fi
\fi
\fi
}%
}%
}%
% \end{macrocode}
% \end{macro}%^^A \slnc@defpos
% \begin{macrocode}
\DefineFamilyKey[.definenotecolumn]{KOMAarg}{normalmarginpar}[\relax]{%
\FamilyKeyStateProcessed
\scrlayer@testunexpectedarg{normalmarginpar}{#1}%
\edef\reserved@a{\noexpand\slnc@defnormalpos{\slnc@name}}\reserved@a
\@namedef{slnc@\slnc@name @width}{\marginparwidth}%
}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@normalmarginpar}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@normalmarginpar@default}
% \end{macrocode}
% \begin{macro}{\slnc@defnormalpos}
% Little helper for option \Option{normalmarginpar}. The argument is the
% expanded name of the note column.
% \begin{macrocode}
\scrlayerAddToInterface\slnc@defnormalpos{%
\newcommand*\slnc@defnormalpos[1]{%
\@namedef{slnc@#1@pos}{%
\ifodd\value{page}
% \end{macrocode}
% The normal marginal note column on odd pages is the right margin.
% \begin{macrocode}
\dimexpr \oddsidemargin+1in
+\textwidth+\marginparsep\relax
\else
\if@twoside
% \end{macrocode}
% The normal marginal note column on even pages is at the left margin.
% \begin{macrocode}
\dimexpr \evensidemargin+1in
-\marginparsep-\csname slnc@#1@width\endcsname\relax
\else
% \end{macrocode}
% \begin{macrocode}
% If not in two-side mode, do the same already done for odd pages.
\dimexpr \oddsidemargin+1in
+\textwidth+\marginparsep\relax
\fi
\fi
}%
}%
}%
% \end{macrocode}
% \end{macro}%^^A \slnc@defnormalpos
% \begin{macrocode}
\DefineFamilyKey[.definenotecolumn]{KOMAarg}{reversemarginpar}[\relax]{%
\FamilyKeyStateProcessed
\scrlayer@testunexpectedarg{reversemarginpar}{#1}%
\edef\reserved@a{\noexpand\slnc@defreversepos{\slnc@name}}\reserved@a
\@namedef{slnc@\slnc@name @width}{\marginparwidth}%
}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@reversemarginpar}
\scrlayer@AddCsToInterface{KV@KOMAarg.definenotecolumn@reversemarginpar@default}
% \end{macrocode}
% \begin{macro}{\slnc@defreversepos}
% Little helper for option \Option{reversemarginpar}. The argument is the
% expanded name of the note column.
% \begin{macrocode}
\scrlayerAddToInterface\slnc@defreversepos{%
\newcommand*\slnc@defreversepos[1]{%
\@namedef{slnc@#1@pos}{%
\ifodd\value{page}
% \end{macrocode}
% The reverse marginal note column on odd pages is at the left margin.
% \begin{macrocode}
\dimexpr \oddsidemargin+1in
-\marginparsep-\csname slnc@#1@width\endcsname\relax
\else
\if@twoside
% \end{macrocode}
% The reverse marginal note column on even pages is the right margin.
% \begin{macrocode}
\dimexpr \evensidemargin+1in
+\textwidth+\marginparsep\relax
\else
% \end{macrocode}
% \begin{macrocode}
% If not in two-side mode, do the same already done for odd pages.
\dimexpr \oddsidemargin+1in
-\marginparsep-\csname slnc@#1@width\endcsname\relax
\fi
\fi
}%
}%
}%
% \end{macrocode}
% \end{macro}%^^A \slnc@defreversepos
% \begin{macrocode}
%</body>
% \end{macrocode}
% \end{option}%^^A reversemarginpar
% \end{option}%^^A normalmarginpar
% \end{option}%^^A marginpar
% \end{option}%^^A font
% \end{option}%^^A width
% \end{option}%^^A position
% \end{macro}%^^A \DeclareNoteColumn
%
% \begin{macro}{\DeclareNewNoteColumn}
% \begin{macro}{\ProvideNoteColumn}
% \begin{macro}{\RedeclareNoteColumn}
% Like \Macro{DeclareNoteColumn} but with restrictions, if the note column has
% (not) been declared already.
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\DeclareNewNoteColumn{%
\newcommand*{\DeclareNewNoteColumn}[2][]{%
\scr@ifundefinedorrelax{slnc@#2@box}{}{%
\PackageError{scrlayer-notecolumn}{note column `#2' already defined}{%
You may declare only note columns, that haven't been declared
previously using\MessageBreak
\string\DeclareNewNoteColumn. See also the alternatives
\string\RedeclareNoteColumn,\MessageBreak
\string\ProvideNoteColumn, and \string\DeclareNoteColumn.\MessageBreak
Nevertheless, if you'll continue, declaration will be done.%
}%
}%
\DeclareNoteColumn[{#1}]{#2}%
}%
}
\scrlayerAddToInterface\ProvideNoteColumn{%
\newcommand*{\ProvideNoteColumn}[2][]{%
\scr@ifundefinedorrelax{slnc@#2@box}{}{%
\PackageInfo{scrlayer-notecolumn}{\string\ProvideNoteColumn{#2}
ignored,\MessageBreak
because of already defined\MessageBreak
not column}%
}{%
\DeclareNoteColumn[{#1}]{#2}%
}%
}%
}
\scrlayerAddToInterface\RedeclareNoteColumn{%
\newcommand*{\RedeclareNoteColumn}[2][]{%
\scr@ifundefinedorrelax{slnc@#2@box}{%
\PackageError{scrlayer-notecolumn}{note column `#2' undefined}{%
You may declare only note columns, that have been declared
previously using\MessageBreak
\string\RedeclareNoteColumn. See also the alternatives
\string\DeclareNewNoteColumn,\MessageBreak
\string\ProvideNoteColumn, and \string\DeclareNoteColumn.\MessageBreak
Nevertheless, if you'll continue, declaration will be done.%
}%
}{}%
\DeclareNoteColumn[{#1}]{#2}%
}%
}
%</body>
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \section{Setting a Note Column}
%
% We already have commands to declare note columns. But we also need a command
% to put contents into the note columns and to output the note columns.
%
% \begin{macro}{\tf@slnc}
% \begin{macro}{\slnc@initwrite}
% \begin{macro}{\slnc@openwrite}
% First of all we need a file to write the notes to. We use the
% \File{aux}-file to write into the file, because we need to read the file
% while the document will be typeset and the same time we need to write into
% the file. Note, that the file will be still reserved on auto-removing the
% interface!
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\tf@slnc{%
\newwrite\tf@slnc
\AtBeginDocument{%
\immediate\write\@auxout{%
\noexpand\csname slnc@initwrite\noexpand\endcsname
}%
}%
\AtEndDocument{\let\slnc@initwrite\slnc@openwrite}%
}
\scrlayerAddToInterface\slnc@initwrite{}%
\scrlayerAddToInterface\slnc@openwrite{%
\newcommand*{\slnc@openwrite}{%
\immediate\closeout\slnc@file
%<*trace>
\PackageInfo{scrlayer-notecolumn}{%
Opening `\jobname.slnc'\MessageBreak
for writing}%
%</trace>
\immediate\openout\tf@slnc\jobname.slnc
}%
}
\AfterReadingMainAux{%
\immediate\closeout\tf@slnc
\scr@ifundefinedorrelax{pdfmdfivesum}{%
\PackageWarningNoLine{scrlayer-notecolumn}{%
\string\pdfmdfivesum\space unavailable.\MessageBreak
The package needs \string\pdfmdfivesum\space to test\MessageBreak
whether or not one more LaTeX run will\MessageBreak
be needed to make the note columns\MessageBreak
right. If this command is unavailable\MessageBreak
you have to do the decision without\MessageBreak
this help of the package.%
}%
}{%
\begingroup
\edef\reserved@a{\pdfmdfivesum file {\jobname.slnc}}%
\ifx \slnc@mdfivesum\reserved@a
%<*trace>
\PackageInfo{scrlayer-notecolumn}{%
MD5 of current `\jobname.slnc':\MessageBreak
\reserved@a}%
%</trace>
\else
%<*trace>
\PackageWarningNoLine{scrlayer-notecolumn}{%
MD5 of slnc-file changed.\MessageBreak
Last: \slnc@mdfivesum\MessageBreak
New: \space \reserved@a\MessageBreak
At least one more LaTeX rerun need to\MessageBreak
make note columns right%
}%
%</trace>
\aftergroup\@tempswatrue
\fi
\endgroup
}%
}
%</body>
% \end{macrocode}
% \end{macro}^^A \slnc@openwrite
% \end{macro}^^A \slnc@initwrite
% \end{macro}^^A \tf@slnc
%
% \begin{macro}{\makenote}
% \begin{description}
% \item[\OParameter{string}:] the name of the note column the note should be
% added to (must be fully expandable and expand to a string only). The
% default value is \PValue{marginpar}.
% \item[\Parameter{code}:] the code, that should become par of the note
% column. Note, that this will be written protected to a file. So you have
% to use \Macro{protect} if a macro shouldn't be expanded while writing or
% may break while writing.
% \end{description}
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\makenote{%
\newcommand{\makenote}[2][marginpar]{%
\@bsphack
\pdfsavepos
\addtocontents{slnc}{%
\string\slnc@note{#1}%
{\noexpand\number\value{slncpage}}%
{\noexpand\number\pdflastypos}%
{#2}%
}%
\@esphack
}%
}
% \end{macrocode}
%^^A \begin{counter}{slncpage}
% This counter should be increased once per page with note column. This may
% be done simply at a once per page executed hook of
% \Pagestyle{@everystyle@}. You should note, that auto-remove wouldn't
% remove the counter.
% \begin{macrocode}
\@ifundefined{c@slncpage}{%
\newcounter{slncpage}%
\AddToLayerPageStyleOptions{@everystyle@}{%
onbackground=\stepcounter{slncpage}%
}%
}{}
%</body>
% \end{macrocode}
%^^A \end{counter}^^A slncpage
% \end{macro}^^A \makenote
%
% \begin{macro}{\slnc@processnotes}
% \begin{description}
% \item[\Parameter{string}:] the name of the note column (must be fully
% expandable an expand to a string only).
% \end{description}
% Each note column typesets the notes with this command. It works in following
% steps:
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\slnc@processnotes{%
\newcommand*{\slnc@processnotes}[1]{%
% \end{macrocode}
% Read as long notes from the notes file until the number at \#2 of
% \Macro{slnc@note} in the file is greater than \Counter{slncpage}. Put all
% these to the corresponding unprocessed list.
% \begin{macrocode}
\begingroup
\slnc@readnotes{\value{slncpage}}%
% \end{macrocode}
% Process the unprocessed list of the current note column
% \begin{macrocode}
\expandafter\let\expandafter\reserved@a
\csname slnc@#1@unprocessed\endcsname
\expandafter\global
\expandafter\let\csname slnc@#1@unprocessed\endcsname\@empty
\def\slnc@notesyncfonttest##1{%
\ifhmode
\PackageError{scrlayer-notecolumn}{%
illegal font setting for `notecolumn.##1'%
}{%
Current setting of font for `notecolumn.##1' switches
from\MessageBreak
vertical mode to horizontal mode. This is
illegal!\MessageBreak
You have to change the font setting to fix
this.\MessageBreak
If you'll continue vertical alignment of notes may fail%
}%
\par\vskip-\dimexpr \baselineskip+\parskip\relax
\fi
}%
\long\def\slnc@note##1##2##3##4{%
\let\PackageInfo\PackageWarning
\ifnum ##2>\value{slncpage}\relax
\expandafter\g@addto@macro\csname slnc@#1@unprocessed\endcsname{%
\slnc@note{##1}{##2}{##3}{##4}%
}%
\else
\ifnum ##2<\value{slncpage}\relax
\PackageWarning{scrlayer-notecolumn}{note of type `#1' delayed.}%
\fi
\boxmaxdepth\maxdepth
\expandafter\setbox\csname slnc@#1@box\endcsname\vbox{%
\expandafter\hsize\csname slnc@#1@width\endcsname
\normalfont\normalsize
{%
% \end{macrocode}
% Question: Why is it not allowed to set a colour here?
% \begin{macrocode}
\let\color\@gobble
\usekomafont{notecolumn.#1}{%
\slnc@notesyncfonttest{#1}%
\expandafter\ifvoid\csname slnc@#1@box\endcsname
\expandafter\setbox\csname slnc@#1@box\endcsname\vbox{%
\kern\dimexpr\topskip-\baselineskip\relax
}%
\fi
\scr@ifundefinedorrelax{pdfpageheight}{%
\@tempdima=\paperheight
}{%
\@tempdima=\pdfpageheight
}%
\@tempdima=\dimexpr \@tempdima-##3sp
-1in-\topmargin
-\headheight-\headsep
-\baselineskip
\relax
\@tempdimb=\dimexpr \expandafter\ht\csname slnc@#1@box\endcsname
+\expandafter\dp\csname slnc@#1@box\endcsname
\relax
\typeout{Soll: \the\@tempdima^^JIst: \space\the\@tempdimb}%
\ifdim\@tempdima<\@tempdimb
%<*trace>
\PackageInfo{scrlayer-notecolumn}{%
Note moved down from\MessageBreak
\the\@tempdima\space to \the\@tempdimb\MessageBreak
at note box `#1'
}%
%</trace>
\else
\ifdim\@tempdima>\@tempdimb
%<*trace>
\PackageInfo{scrlayer-notecolumn}{%
Adding vertical white space from\MessageBreak
\the\@tempdimb\space to \the\@tempdima\MessageBreak
into note box `#1'
}%
%</trace>
\expandafter\setbox\csname slnc@#1@box\endcsname
\vbox {%
\expandafter\unvbox\csname slnc@#1@box\endcsname
\kern\dimexpr\@tempdima-\@tempdimb\relax
}%
\fi
\fi
\expandafter\ifvoid\expandafter\csname slnc@#1@box\endcsname
\else
\@tempdima\dimexpr
\dp\strutbox
-\dp\csname slnc@#1@box\endcsname
\relax
\expandafter\unvbox\csname slnc@#1@box\endcsname
\ifdim\@tempdima>\z@ \kern\@tempdima\fi
\fi
\strut\ignorespaces ##4\par
}%
}%
}%
\fi
}%
\def\slnc@sync##1##2##3##4{%
\ifnum ##2>\value{slncpage}\relax
\expandafter\g@addto@macro\csname slnc@#1@unprocessed\endcsname{%
\slnc@sync{##1}{##2}{##3}{}%
}%
\else
\if@filesw
\expandafter\setbox\csname slnc@#1@box\endcsname\vbox{%
\expandafter\unvbox\csname slnc@#1@box\endcsname
\pdfsavepos
\protected@write\@auxout{}{%
\string\newlabel{notecolumn.##1.##3.syncnote.label}{%
{%
\noexpand\number\pdflastypos
}{\thepage}%
}%
}%
}%
\fi
\fi
}%
\reserved@a
\expandafter\ifvoid\csname slnc@#1@box\endcsname
%<*trace>
\PackageInfo{scrlayer-notecolumn}{Note box `#1' empty}%
%</trace>
\else
\ifdim \dimexpr \expandafter\ht\csname slnc@#1@box\endcsname
+\expandafter\dp\csname slnc@#1@box\endcsname
\relax >\textheight\relax
%<*trace>
\PackageInfo{scrlayer-notecolumn}{Split note box `#1'}%
%</trace>
\splittopskip\topskip
\splitmaxdepth\baselineskip
% \end{macrocode}
% Bring back the colours:
% \begin{macrocode}
\usekomafont{notecolumn.#1}{%
\expandafter\vsplit\csname slnc@#1@box\endcsname to
\textheight\relax
}%
\expandafter\ifvoid\csname slnc@#1@box\endcsname
\else
\expandafter\setbox\csname slnc@#1@box\endcsname\vbox{%
\expandafter\unvbox\csname slnc@#1@box\endcsname
}%
\fi
\else
%<*trace>
\PackageInfo{scrlayer-notecolumn}{Flush note box `#1'}%
%</trace>
% \end{macrocode}
% Bring back the colours:
% \begin{macrocode}
\usekomafont{notecolumn.#1}{%
\expandafter\box\csname slnc@#1@box\endcsname%
}%
\fi
\fi
\expandafter\global
\expandafter\setbox\csname slnc@#1@box\expandafter\endcsname
\expandafter\box\csname slnc@#1@box\endcsname
\endgroup
}
}
% \end{macrocode}
% \begin{macro}{\slnc@readnotes}
% Read as long notes from the notes file until the number at \#2 of
% \Macro{slnc@note} or \Macro{slnc@sync} in the file is greater than
% \Counter{slncpage}. Put all these to the corresponding unprocessed list.
% \begin{macrocode}
\scrlayerAddToInterface\slnc@readnotes{%
\newcommand*\slnc@readnotes[1]{%
\ifeof\slnc@file\else
\ifnum \number #1<\slnc@unprocessed\relax
\@tempswafalse
\else
\@tempswatrue
\fi
\@whilesw\if@tempswa\fi{%
\edef\reserved@a{%
\noexpand\makeatletter
\endlinechar\m@ne
\read\noexpand\slnc@file to\noexpand\reserved@a
\endlinechar\the\endlinechar\relax
\catcode`\noexpand\@=\the\catcode`\@\relax
}%
\reserved@a
\expandafter\slnc@iofv\expandafter\reserved@b\reserved@a
\@empty\@empty\@empty\@empty\@empty
\@tempswafalse
\@for\reserved@c :={\slnc@note },{\slnc@sync }\do{%
\ifx\reserved@b\reserved@c \@tempswatrue\fi
}%
\if@tempswa
\@tempswafalse
\expandafter\slnc@iiiofv\expandafter\reserved@b\reserved@a
\@empty\@empty\@empty\@empty\@empty
\ifx\reserved@b\@empty
\PackageError{scrlayer-notecolumn}{internal syntax error}{%
Unexpected syntax of file `\jobname.slnc'.\MessageBreak
Second argument should be a number.\MessageBreak
I don't know what to do with\MessageBreak
\expandafter\detokenize\expandafter{\reserved@a}%
}%
\@tempswatrue
\else
\global\let\slnc@unprocessed\reserved@b
\expandafter\slnc@iiofv\expandafter\reserved@b\reserved@a
\@empty\@empty\@empty\@empty\@empty
\@ifundefined{slnc@\reserved@b @unprocessed}{%
\PackageWarning{scrlayer-notecolumn}{%
column `\reserved@b' undefined.\MessageBreak
You should declare the column before the usage.\MessageBreak
Notes will be lost
}%
}{%
\expandafter\g@addto@macro
\csname slnc@\reserved@b @unprocessed\expandafter\endcsname
\expandafter{%
\reserved@a
}%
}%
\ifnum \number #1<\slnc@unprocessed\relax
\@tempswafalse
\else
\@tempswatrue
\fi
\fi
\else
%<*trace>
\PackageInfo{scrlayer-notecolumn}{%
Ignoring `\expandafter\detokenize\expandafter{\reserved@a}'}%
%</trace>
\@tempswatrue
\fi
\ifeof\slnc@file\@tempswafalse\fi
}%
\fi
}%
}
% \end{macrocode}
% \end{macro}^^A \slnc@readnotes
% \begin{macro}{\slnc@iofv}
% \begin{macro}{\slnc@iiofv}
% \begin{macro}{\slnc@iiiofv}
% \begin{macrocode}
\scrlayerAddToInterface\slnc@iofv{%
\newcommand\slnc@iofv[6]{\def#1{#2}}%
}
\scrlayerAddToInterface\slnc@iiofiv{%
\newcommand\slnc@iiofv[6]{\def#1{#3}}%
}
\scrlayerAddToInterface\slnc@iiiofiv{%
\newcommand\slnc@iiiofv[6]{\def#1{#4}}%
}
% \end{macrocode}
% \end{macro}^^A \slnc@iiiofv
% \end{macro}^^A \slnc@iiofv
% \end{macro}^^A \slnc@iofv
% \begin{macro}{\slnc@unprocessed}
% The \#2 of the last read note column from notes file.
% \begin{macrocode}
\scrlayerAddToInterface\slnc@unprocessed{%
\newcommand*{\slnc@unprocessed}{0}%
}
%</body>
% \end{macrocode}
% \begin{macro}{\slnc@file}
% The input file with the unprocessed notes.
% \begin{macro}{\slnc@mdfivesum}
% The MD5 sum of the file before opening it for reading.
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\slnc@mdfivesum{%
\let\slnc@mdfivesum\@empty
}
\scrlayerAddToInterface\slnc@file{%
\scr@ifundefinedorrelax{pdfmdfivesum}{}{%
\xdef\slnc@mdfivesum{\pdfmdfivesum file {\jobname.slnc}}%
%<*trace>
\PackageInfo{scrlayer-notecolumn}{%
MD5 of last `\jobname.slnc':\MessageBreak
\slnc@mdfivesum}%
%</trace>
}%
\newread\slnc@file
\immediate\openin\slnc@file \jobname.slnc
\scrlayerOnAutoRemoveInterface{\immediate\closeout\slnc@file}%
}
%</body>
% \end{macrocode}
% \end{macro}^^A \slnc@mdfivesum
% \end{macro}^^A \slnc@file
% \end{macro}^^A \slnc@unprocessed
% \end{macro}^^A \slnc@processnotes
%
% \begin{option}{autoclearnotecolumns}
% \begin{macrocode}
%<*options>
\KOMA@ifkey{autoclearnotecolumns}{slnc@autoclearnotecolumns}\slnc@autoclearnotecolumnstrue
\scrlayer@AddCsToInterface{KV@KOMA.\@currname.\@currext @autoclearnotecolumns}
\scrlayer@AddCsToInterface{KV@KOMA.\@currname.\@currext @autoclearnotecolumns@default}
%</options>
%<*final>
\let\reserved@a\clearpage
\def\clearpage{%
\ifslnc@autoclearnotecolumns\clearnotecolumns\relax\fi
}%
\expandafter\g@addto@macro\expandafter\clearpage\expandafter{\reserved@a}
%</final>
% \end{macrocode}
% \end{option}
%
% \begin{macro}{\clearnotecolumn}
% \begin{description}
% \item[\OParameter{string}:] the name of the note column (must be fully
% expandable and expand to a string only). Default is \PValue{marginpar}.
% \end{description}
% Output as many (empty) pages as needed to output all unprocessed notes of
% one note column. Note, that the output of the first page may result in more
% unprocessed notes. But the output of the following (empty) pages shouldn't.
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\c@slnc@clearnote@label{%
\newcounter{slnc@clearnote@label}%
}
\scrlayerAddToInterface\clearnotecolumn{%
\newcommand*\clearnotecolumn[1][marginpar]{%
\begingroup
\slnc@autoclearnotecolumnsfalse
% \end{macrocode}
% First of all we need to know the note column page of this page.
% \begin{macrocode}
\stepcounter{slnc@clearnote@label}%
\if@filesw
\protected@write\@auxout{%
\let\theslncpage\relax
\let\slnc@voidtest\relax
}{%
\string\newlabel{notecolumn.\theslnc@clearnote@label}%
{{\theslncpage}{\slnc@voidtest{#1}}}%
}%
\fi
\scr@ifundefinedorrelax{r@notecolumn.\theslnc@clearnote@label}{%
\PackageInfo{scrlayer-notecolumn}{%
Using estimated to low value for clearing\MessageBreak
note colum `#1'%
}
\edef\slnc@cmp@value{\the\value{slncpage}}%
\let\reserved@a\z@
}{%
\edef\reserved@a{%
\@nameuse{r@notecolumn.\theslnc@clearnote@label}\@empty\@empty
}%
\edef\slnc@cmp@value{\expandafter\slnc@firstof\reserved@a\@nil}%
\edef\reserved@a{\expandafter\slnc@secondof\reserved@a\@nil}%
}%
\ifnum \reserved@a=\z@
% \end{macrocode}
% Next we read all notes until the end of the current page, but only
% if a \Macro{clearpage} wouldn't result in a new page.
% \begin{macrocode}
\ifvmode
\ifdim \pagetotal<\topskip
\else
\slnc@readnotes{\slnc@cmp@value}%
\fi
\else
\slnc@readnotes{\slnc@cmp@value}%
\fi
\begingroup
\aftergroup\@tempswafalse
\long\def\slnc@note##1##2##3##4{%
\ifnum ##2>\slnc@cmp@value\relax \else \aftergroup\@tempswatrue\fi
}%
\let\slnc@sync\slnc@note
\csname slnc@#1@unprocessed\endcsname
\endgroup
\else
\PackageInfo{scrlayer-notecolumn}{%
box of note column `#1'\MessageBreak
not empty after page of \string\clearnotecolumn}%
\@tempswatrue
\fi
\if@tempswa
% \end{macrocode}
% Yes, we have!
% \begin{macrocode}
\IfLayerPageStyleExists{\currentpagestyle}{}{%
\PackageWarning{scrlayer-notecolumn}{%
\string\clearnotecolumn\space while active non-layer page
style.\MessageBreak
Activate empty page style until note column\MessageBreak
has been cleared%
}%
\pagestyle{empty}%
}%
\@tempswatrue
\fi
\@whilesw\if@tempswa\fi{%
% \end{macrocode}
% Yes, we have (maybe again)!
% \begin{macrocode}
\clearpage
\expandafter\ifcase \slnc@voidtest{#1}%
\begingroup
\aftergroup\@tempswafalse
\long\def\slnc@note##1##2##3##4{%
\ifnum ##2>\slnc@cmp@value\relax \else \aftergroup\@tempswatrue\fi
}%
\let\slnc@sync\slnc@note
\csname slnc@#1@unprocessed\endcsname
\endgroup
\else
\@tempswatrue
\fi
\if@tempswa
% \end{macrocode}
% And we still have: So we have to output one more page.
% \begin{macrocode}
\null
\fi
}%
\endgroup
}%
}
% \end{macrocode}
% \begin{macro}{\slnc@firstof}
% \begin{macro}{\slnc@secondof}
% We need these little helpers, because some packages like
% \Package{hyperref} extend the label mechanism by additional arguments.
% \begin{macrocode}
\scrlayerAddToInterface{\slnc@firstof}{%
\def\slnc@firstof#1#2\@nil{#1}%
}
\scrlayerAddToInterface{slnc@secondof}{%
\def\slnc@secondof#1#2#3\@nil{#2}%
}
% \end{macrocode}
% \end{macro}^^A \slnc@firstof
% \end{macro}^^A \slnc@secondof
% \begin{macro}{\slnc@voidtest}
% \begin{description}
% \item[\Parameter{string}:] the name of a note column (must be fully
% expandable and expand to a string only).
% \end{description}
% If the box of the note column is empty/void it returns \Macro{z@} otherwise
% \Macro{@ne}.
% \begin{macrocode}
\scrlayerAddToInterface\slnc@voidtest{%
\newcommand*{\slnc@voidtest}[1]{%
\expandafter\ifvoid \csname slnc@#1@box\endcsname \z@\else \@ne\fi
}%
}
%</body>
% \end{macrocode}
% \end{macro}^^A \slnc@voidtest
% \end{macro}^^A \clearnotecolumn
%
% \begin{macro}{\clearnotecolumns}
% \begin{description}
% \item[\OParameter{string list}:] comma separated list of note column names
% (must be fully expandable and each element must expand to a string only,
% that is the name of a note column); if omitted or empty all note columns
% will be used.
% \end{description}
% Output as many (empty) pages as needed to output all unprocessed notes of
% all (given) note columns. Note, that the output of the first page may
% result in more unprocessed notes. But the output of the following (empty)
% pages shouldn't.
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface\clearnotecolumns{%
\newcommand*\clearnotecolumns[1][\relax]{%
\begingroup
\slnc@autoclearnotecolumnsfalse
\ifx\relax#1\relax\else
\let\slnc@processnotecolumns\@empty
\edef\reserved@a{#1}%
\expandafter\@for\expandafter\reserved@a\expandafter:\expandafter=%
\reserved@a\do {%
\ifx\reserved@a\@empty\else
\expandafter\l@addto@macro\expandafter\slnc@processnotecolumns
\expandafter{\expandafter\@elt\expandafter{\reserved@a}}%
\fi
}%
\fi
% \end{macrocode}
% First of all we need to know the note column page of this page.
% \begin{macrocode}
\stepcounter{slnc@clearnote@label}%
\if@filesw
\begingroup
\def\@elt##1{+\slnc@voidtest{##1}}%
\protected@write\@auxout{%
\let\theslncpage\relax
\let\slnc@voidtest\relax
}{%
\string\newlabel{notecolumn.\theslnc@clearnote@label}%
{{\theslncpage}{\numexpr \slnc@processnotecolumns\relax}}%
}%
\endgroup
\fi
\scr@ifundefinedorrelax{r@notecolumn.\theslnc@clearnote@label}{%
\begingroup
\def\@elt##1{, `##1'}%
\PackageInfo{scrlayer-notecolumn}{%
Using estimated to low value for\MessageBreak
clearing note colums\MessageBreak
\expandafter\@gobble\slnc@processnotecolumns
}%
\endgroup
\edef\slnc@cmp@value{\the\value{slncpage}}%
\let\reserved@a\z@
}{%
\edef\reserved@a{%
\@nameuse{r@notecolumn.\theslnc@clearnote@label}\@empty\@empty
}%
\edef\slnc@cmp@value{\expandafter\slnc@firstof\reserved@a\@nil}%
\edef\reserved@a{\expandafter\slnc@secondof\reserved@a\@nil}%
}%
\ifcase \reserved@a\relax
% \end{macrocode}
% Next we read all notes until the end of the current page, but only
% if a \Macro{clearpage} wouldn't result in a new page.
% \begin{macrocode}
\ifvmode
\ifdim \pagetotal<\topskip
\else
\slnc@readnotes{\slnc@cmp@value}%
\fi
\else
\slnc@readnotes{\slnc@cmp@value}%
\fi
\begingroup
\aftergroup\@tempswafalse
\long\def\slnc@note##1##2##3##4{%
\ifnum ##2>\slnc@cmp@value\relax \else \aftergroup\@tempswatrue\fi
}%
\let\slnc@sync\slnc@note
\def\@elt##1{\csname slnc@##1@unprocessed\endcsname}%
\slnc@processnotecolumns
\endgroup
\else
\PackageInfo{scrlayer-notecolumn}{%
box of at least one note column\MessageBreak
not empty after page of \string\clearnotecolumns}%
\@tempswatrue
\fi
\if@tempswa
% \end{macrocode}
% Yes, we have!
% \begin{macrocode}
\IfLayerPageStyleExists{\currentpagestyle}{}{%
\PackageWarning{scrlayer-notecolumn}{%
\string\clearnotecolumns\space while active non-layer page
style.\MessageBreak
Activate empty page style until note column\MessageBreak
has been cleared%
}%
\pagestyle{empty}%
}%
\@tempswatrue
\fi
\@whilesw\if@tempswa\fi{%
% \end{macrocode}
% Yes, we have (maybe again)!
% \begin{macrocode}
\clearpage
\begingroup
\def\@elt##1{+\slnc@voidtest{##1}}%
\ifcase \numexpr \slnc@processnotecolumns\relax
\aftergroup\@tempswafalse
\long\def\slnc@note##1##2##3##4{%
\ifnum ##2>\slnc@cmp@value\relax \else \aftergroup\@tempswatrue\fi
}%
\let\slnc@sync\slnc@note
\def\@elt##1{\csname slnc@##1@unprocessed\endcsname}%
\slnc@processnotecolumns
\else
\aftergroup\@tempswatrue
\fi
\endgroup
\if@tempswa
% \end{macrocode}
% And we still have: So we have to output one more page.
% \begin{macrocode}
\null
\fi
}%
\endgroup
}%
}
%</body>
% \end{macrocode}
% \end{macro}^^A \clearnotecolumns
%
%
% \section{Syncronisation of Text and Note}
% \label{sec:scrlayer-notecolumn.sync}
%
% Until yet we have the text and we have note columns. Normally note entries
% to a note column are in sync with the text position, that makes the
% note. But if there are collisions the sync may be lost. In this case the
% note may be later (but never earlier), so we need a mechanism to force
% synchronisation of the text with the note.
%
% \begin{macro}{\syncwithnotecolumn}
% \begin{description}
% \item[\OParameter{string}:] the name of the note column to sync with (this
% must be fully expandable and expand to the name of a note column). By
% default sync with note column \PValue{marginpar}.
% \end{description}
% Add at the \LaTeX{} run after the next \LaTeX{} run as much space to the
% text (not the note column!) as needed to reach the next position at the
% note column. This is not the same like \Macro{clearnotecolumn}, because it
% doesn't need to go to the next page, but it needs at least three \LaTeX{}
% runs to terminate.
% \begin{macrocode}
%<*body>
\scrlayerAddToInterface{\c@slnc@syncpoint}{%
\newcounter{slnc@syncpoint}%
}
\scrlayerAddToInterface{\syncwithnotecolumn}{%
\newcommand*{\syncwithnotecolumn}[1][marginpar]{%
\begingroup
\edef\reserved@a{\endgroup\noexpand\syncwithnotecolumns[{#1}]}%
\reserved@a
}%
}
\scrlayerAddToInterface{\syncwithnotecolumns}{%
\newcommand*{\syncwithnotecolumns}[1][\relax]{%
\begingroup
\ifx\relax#1\relax\else
\let\slnc@processnotecolumns\@empty
\edef\reserved@a{#1}%
\expandafter\@for\expandafter\reserved@a\expandafter:\expandafter=%
\reserved@a\do {%
\ifx\reserved@a\@empty\else
\expandafter\l@addto@macro\expandafter\slnc@processnotecolumns
\expandafter{\expandafter\@elt\expandafter{\reserved@a}}%
\fi
}%
\fi
\stepcounter{slnc@syncpoint}%
\def\@elt##1{%
\addtocontents{slnc}{%
\string\slnc@sync{##1}%
{\noexpand\number\value{slncpage}}%
{\theslnc@syncpoint}%
{}%
}%
}%
\slnc@processnotecolumns
\ifvmode
\let\slnc@voffset\@empty%
\expandafter\@firstofone
\else
\PackageWarning{scrlayer-notecolumn}{%
\string\syncwithnotecolumn\space in hmode.\MessageBreak
Using \string\syncwithnotecolumn\space in horizontal\MessageBreak
mode may result in unwanted vertical\MessageBreak
space inside paragraphs and may lost\MessageBreak
colours of text of notes. \space So perhaps you\MessageBreak
should move \string\syncwithnotecolumn\space before\MessageBreak
or after the paragraph%
}%
\let\slnc@voffset\@empty%\def\slnc@voffset{-\number\baselineskip}%
\expandafter\slnc@vadjust
\fi
{%
\if@filesw
\pdfsavepos
\protected@write\@auxout{}{%
\string\newlabel{notecolumn.\theslnc@syncpoint.synctext.label}{%
{%
\noexpand\number
\numexpr \pdflastypos\slnc@voffset\relax
}{\thepage}%
}%
}%
\fi
\@ifundefined{r@notecolumn.\theslnc@syncpoint.synctext.label}{%
\PackageInfo{scrlayer-notecolumn}{%
No text label for \string\syncwithnotecolumn.\MessageBreak
Need rerun to sync position}%
}{%
\edef\reserved@a{%
\@nameuse{r@notecolumn.\theslnc@syncpoint.synctext.label}%
\@empty\@empty
}%
\edef\slnc@textpos{\expandafter\slnc@firstof\reserved@a\@nil}%
\edef\slnc@textpage{\expandafter\slnc@secondof\reserved@a\@nil}%
\let\slnc@notepos\slnc@textpos
\let\slnc@notepage\slnc@textpage
\def\@elt##1{%
\@ifundefined{r@notecolumn.##1.\theslnc@syncpoint.syncnote.label}{%
\PackageInfo{scrlayer-notecolumn}{%
No note label for sync with note column\MessageBreak
`##1'.\MessageBreak
Need rerun to sync position}%
\G@refundefinedtrue
}{%
\edef\reserved@a{%
\@nameuse{r@notecolumn.##1.\theslnc@syncpoint.syncnote.label}%
\@empty\@empty
}%
\edef\reserved@b{\expandafter\slnc@firstof\reserved@a\@nil}%
\edef\reserved@c{\expandafter\slnc@secondof\reserved@a\@nil}%
\ifnum \slnc@notepage<\reserved@c\relax
\let\slnc@notepos=\reserved@b
\let\slnc@notepage=\reserved@c
\else
\ifnum \slnc@notepage=\reserved@c\relax
\ifnum \slnc@notepos>\reserved@b
\let\slnc@notepos=\reserved@b
\let\slnc@notepage=\reserved@c
\fi
\fi
\fi
}%
}%
\slnc@processnotecolumns
\ifnum\slnc@textpage>\slnc@notepage\relax
\PackageInfo{scrlayer-notecolumn}{%
Last note page before last text page.\MessageBreak
Need rerun to sync position}%
\else
\ifnum\slnc@textpage<\slnc@notepage\relax
\@whilenum \slnc@textpage<\slnc@notepage\do {%
\newpage\null\vskip-\dimexpr \baselineskip+\parskip\relax
\edef\slnc@textpage{\the\numexpr\slnc@textpage+1\relax}%
}%
\scr@ifundefinedorrelax{pdfpageheight}{%
\@tempdima=\paperheight
}{%
\@tempdima=\pdfpageheight
}%
\@tempdima=\dimexpr \@tempdima
-\topmargin-1in
-\headheight-\headsep
-\topskip+\baselineskip
\relax
\edef\slnc@textpos{\number\@tempdima}%
%<*trace>
\PackageInfo{scrlayer-notecolumn}{%
Top position is \slnc@textpos%
}%
%</trace>
\fi
\ifnum\slnc@notepos>\slnc@textpos\relax
\PackageInfo{scrlayer-notecolumn}{%
Last note position before last text\MessageBreak
position.\MessageBreak
Need rerun to sync position%
}%
\else
\ifnum\slnc@notepos<\slnc@textpos\relax
\@tempdima=\numexpr \slnc@textpos-\slnc@notepos\relax sp
\PackageInfo{scrlayer-notecolumn}{%
skipping \the\@tempdima\space to sync%
}%
\vskip\@tempdima
\fi
\fi
\fi
}%
}%
\endgroup
}%
}
% \end{macrocode}
% \begin{macro}{\slnc@vadjust}
% \begin{macrocode}
\scrlayerAddToInterface\slnc@vadjust{%
\newcommand{\slnc@vadjust}[1]{%
\@bsphack
\vadjust{#1}%
\@esphack
}%
}
%</body>
% \end{macrocode}
% \end{macro}^^A \slnc@vadjust
% \end{macro}^^A \syncwithnotecolumn
%
%
% \iffalse^^A meta-comment
%</interface>
% \fi^^A meta-comment
%
% \Finale
% \let\subsection\section
% \let\section\chapter
% \let\chapter\restorechapter
%
\endinput
%
% end of file `scrlayer-notecolumn.dtx'
%%% Local Variables:
%%% mode: doctex
%%% mode: flyspell
%%% ispell-local-dictionary: "en_GB"
%%% TeX-master: t
%%% End:
|