summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/phfnote/phfnote.dtx
blob: a0632f999784be76e58785289af64bb20a678476 (plain)
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
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
% \iffalse meta-comment
%
% Copyright (C) 2019 by Philippe Faist, philippe.faist@bluewin.ch
% -------------------------------------------------------
% 
% This file may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in:
%
%    http://www.latex-project.org/lppl.txt
%
% and version 1.3 or later is part of all distributions of LaTeX 
% version 2005/12/01 or later.
%
% \fi
%
% \iffalse
%<*driver>
\ProvidesFile{phfnote.dtx}
%</driver>
%<package>\NeedsTeXFormat{LaTeX2e}[2005/12/01]
%<package>\ProvidesPackage{phfnote}
%<*package>
    [2021/10/08 v4.0 phfnote package]
%</package>
%<phfnotepreset>%This preset file for phfnote is used when you call `\usepackage[preset=<PRESET NAME>]{phfnote}'
%
%<*driver>
\documentclass{ltxdoc}
\usepackage{xcolor}
\usepackage{lipsum}
\usepackage[preset=xpkgdoc]{phfnote}

\usepackage{needspace}

\makeatletter

  % the factor by which to compress macro names in the margin
\def\phf@xpkgdoc@marginmacronamecompressfactor{0.9}

\newsavebox\phfnoteDocVirtualPage@contents
\newenvironment{phfnoteDocVirtualPage}{%
  \par%
  \begingroup%
  \makeatletter%
  \begin{lrbox}{\phfnoteDocVirtualPage@contents}%
  \begin{minipage}{12cm}\vspace*{0.5cm}\relax%
    \def\rmdefault{cmr}\def\sfdefault{cmbr}\normalfont%
    \def\shortlipsum{Lorem ipsum dolor sit amet, consectetuer
      adipiscing elit. Ut purus elit, vestibulum ut, placerat ac,
      adipiscing vitae, felis. Curabitur dictum gravida
      mauris. Nam arcu libero, nonummy eget, consectetuer id,
      vulputate a, magna.}%
    \def\@title{Notes on Lambda-Majorization}%
    \def\@author{Ph. Faist}%
    \def\@date{23.12.2011}%
    \let\RequirePackage\@gobble%
    \def\notetitletopspace{0pt}%
    \def\notetitlefont{\sffamily\bfseries}%
    \def\morepagecontents{\par\vspace{1em}\centering\ldots}%
    \ignorespaces%
  }%
  {%
  \end{minipage}%
  \end{lrbox}%
  %%\centering%
  \begin{tcolorbox}[text width=6cm,sharp corners,%
    before={\par\vspace{5pt}\centering\nopagebreak\parindent=0pt},after={\par\vspace{5pt}},%
    leftrule=0.4pt,toprule=0.4pt,rightrule=0.6pt,bottomrule=0.6pt,%
    colframe=black,colback=white]%
    \scalebox{0.5}{\usebox{\phfnoteDocVirtualPage@contents}}%
  \end{tcolorbox}%
  %%\par%
  \endgroup%
}

\def\eqsign@{=}
\def\eqsign{\protect\eqsign@}
\robustify\eqsign
\makeatother

\def\RevTeX{{\small R\raise-0.2ex\hbox{\textsc{ev}}}\TeX}

\EnableCrossrefs
\CodelineIndex
\RecordChanges

\begin{document}
  \DocInput{phfnote.dtx}
\end{document}
%</driver>
%<*package>
% \fi
%
% \CheckSum{0}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
%
% \changes{v1.0}{2016/04/20}{Initial version}
%
% \GetFileInfo{phfnote.dtx}
%
% \iffalse Bypass indexing for following commands: \fi
% \DoNotIndex{\newcommand,\newenvironment,\renewcommand,\long,\def,\edef,\gdef,\xdef,\if,\else,\fi,\par,\relax,\vspace,\vskip,\hspace,\hskip,\vbox,\hbox}
% 
% \title{\phfqitltxPkgTitle{phfnote}}
% \author{Philippe Faist\quad\email{philippe.faist@bluewin.ch}}
% \date{\pkgfmtdate\filedate}
% \maketitle
%
% \begin{abstract}
%   \pkgname{phfnote}---A handy \LaTeX{} package for typesetting short notes and
%   medium-length reports, full of goodies to make it look just right.
% \end{abstract}
%
% \phantomsection\label{sec:toc}
% \inlinetoc
%
% \section{Introduction}
%
% Have you ever thought, ``let me write up these short notes using \LaTeX,'' but
% then disliked the default style of the |article| class?  Have you ever asked
% yourself why half the page should be taken up by the title?  Yes?  Then
% welcome to \pkgname{phfnote}.
%
% The package \pkgname{phfnote} provides basic formatting for short
% documents, such as notes on a specific topic, short documentation, or
% quick memos.  It aims to cover all basic needs for such purposes: include
% a standard set of relevant packages, a nice title which doesn't take up
% too much space, better page margin sizes, and some basic styling to make
% the note look nicer.  At the same time, it is highly configurable so that
% nothing is really unchangeable.  And all overridden features can be
% restored individually to their defaults provided by the underlying class.
%
% This package has been designed to work optimally along with the |article|
% document class, but in principle any relatively standard \LaTeX{} class should
% work.  Notes can be typeset in \index{two-column} two-column mode with the
% |twocolumn| option of for example the |article| class.  Settings such as the
% page margins and font goodies are automatically adapted to look best according
% to the standard document font size (10pt, 11pt, or 12pt).
%
% Be aware that this package is not meant as a full-fledged formatting class for
% complicated articles.  For that, you should use a specialized class such as
% \RevTeX.\footnote{See \url{https://journals.aps.org/revtex}}
%
% In the following, we detail individual features of this package, and explain
% how to activate, deactivate, and customize them.
%
%
% \section{Basic Usage}
%
% \subsection{Loading the Package}
%
% You can get started with the minimal template:
%
% \begin{verbatim}
% \documentclass[11pt,a4paper]{article}
% \usepackage{phfnote}
%
% \begin{document}
% \title{Title of my notes}
% \author{Me}
% \date{\today}
% \maketitle
%
% ...
%
% \end{document}
% \end{verbatim}
%
% The package \pkgname{phfnote} introduces its default note formatting
% style, with a more compact title, and some formatting adjustments in the
% text and section headings.
%
% \subsection{Presets}
% \label{sec:presets}
%
% There are a number of package options which can be provided to activate,
% deactivate or adjust the formatting.  The most straightforward way of changing
% the formatting is to use \emph{presets}.
%
% Presets are processed immediately when given in the package option list,
% meaning that their position in the list is meaningful.  For example, the
% option list
% \begin{verbatim}
%   \usepackage[title=small,preset=article,par=skip]{phfnote}
% \end{verbatim}
% will set |title=small| only if it is not overridden by the |article| preset,
% but will enforce |par=skip| in any case.  You may in theory load several
% presets, e.g. |preset=sfnote,preset=article|, but this is essentially useless
% since presets tend to set a wide range of settings such that in any case the
% last preset specified is effectively applied.
%
% First, there is a set of presets which are different alternative ``note''
% styles.  All the following define the note to have spacing between paragraphs
% and no first line indentation, use the default note title style, and use a
% wider page geometry.
%
% \begin{pkgoptions}
% \item[preset=sfnote] {\fontfamily{cmbr}\selectfont Format the note in \LaTeX'
%   sans-serif ``Computer Modern Bright'' font.  This is a nice, light, font for
%   short notes, but I find it more difficult to read at smaller font sizes or
%   in longer paragraphs.}
% \item[preset=sfssnote] {\fontfamily{cmss}\selectfont Format the note in
%   \LaTeX' default sans-serif font.  A very nice sans serif font.  It might
%   look heavy though, depending on your taste.}
% \item[preset=opensansnote] {\opensans Format the note
%   in Open Sans font (using the `\pkgname{opensans}' package with some
%   default options).  A very beautiful and readable sans serif font.}
% \item[preset=utopianote] {\fontfamily{futs}\selectfont Format the note in
%   Utopia font (by using the \pkgname{fourier} package).  Perfect to my
%   taste for documenting code for example, but I find it a bit heavy for
%   scientific documents.}
% \item[preset=mnmynote] Format the note in Minion Pro font, with sans
%   serif text formatted with the Myriad Pro font (professional fonts by
%   Adobe which can be used in \LaTeX{} with the \pkgname{MinionPro} and
%   \pkgname{MyriadPro} packages\footnote{See
%   \url{https://github.com/sebschub/FontPro}; the fonts themselves ship
%   with some Adobe products}).  These beautiful fonts can be used for any
%   purpose.
% \end{pkgoptions}
% 
% Based essentially on |utopianote|, the preset |pkgdoc| sets up the
% document to look nice for a \LaTeX{} package documentation.  The preset
% |xpkgdoc| adds additional definitions to aid in documenting \LaTeX{}
% packages on top of |pkgdoc|.
% \begin{pkgoptions}
% \item[preset=pkgdoc] Basic formatting and settings for documenting \LaTeX{}
%   packages. This preset was used for the current document.
% \item[preset=xpkgdoc] Same as |preset=pkgdoc|, but in addition a set of useful
%   commands are also provided, the \pkgname{tcolorbox} package is loaded along
%   with some default boxes.  Also some commands are patched to achieve some
%   fixes.  This preset is used for the documentation of packages in the
%   \pkgname{phfqitltx} package suite.  (For details see the implementation of
%   the |xpkgdoc| preset in \autoref{sec:impl-xpkgdoc}.)
% \end{pkgoptions}
%
%
% The following preset makes the document look more like an article.  There are
% some slight minor differences with respect to the default |article| class'
% title in the choice of formatting the title and text.
%
% \begin{pkgoptions}
% \item[preset=article] Sets a more title style closer to |article|'s default
%   title style (but slightly more compact) and sets paragraphs to indent with
%   no skip.
% \end{pkgoptions}
%
% The last preset, |reset|, guarantees that including this package is
% non-invasive, meaning that only new \LaTeX{} macros are made available without
% altering any appearance.  This is useful if you want to use a small feature
% provided by this package, but you already have all the page geometry, title,
% etc.\@ set up and want to make sure those aren't touched.
%
% \begin{pkgoptions}
% \item[preset=reset] Deactivates all features of this package by default.
%   Individual settings can still later be switched on via specific package
%   options.  Use this to activate only a specific set of features:
%   |[preset=reset,...]| will ensure that only the additional given features are
%   set.
%
%   This is safer than deactivating individually all other features, because in
%   the future we may add new features which may be on by default.  In this
%   case, the preset |reset| will guarantee all features to be deactivated.
% \end{pkgoptions}
%
%
%
%
% \section{Summary of Package Options}
% \label{sec:package-options}
%
% \begin{pkgoptions}
% \item[preset=\meta{preset name}] Load a preset specifying a predefined set of
%   options for the general appearance of the document.  See documentation in
%   \autoref{sec:presets}
% \item[title=\meta{title style},notitle] Set the title style. Use
%   \pkgoptionfmt{notitle} to disable feature and use latex default.
%   Documentation in \autoref{sec:title-styles}
% \item[abstract=\meta{abstract attributes},noabstract] Set the abstract style by
%   specifying a comma-separated list of attributes.  Don't forget to
%   put the list of attributes within braces,
%   |[abstract={wide,noname,it}]|.  Documentation in
%   \autoref{sec:abstract-attributes}
% \item[pkgset=\meta{package set}] Specify a standard set of \LaTeX{}
%   packages to load.  See \autoref{sec:package-sets}.
% \item[pagegeom=\meta{geom style},nopagegeom] Set a page margin style.  Use |nopagegeom|
%   to leave page geometry unchanged.  Options are documented in
%   \autoref{sec:pagegeomdefs}.
% \item[secfmt=\meta{section formatting attributes},nosecfmt] A list of
%   attributes defining how section (and possibly paragraph) headings should
%   look like.  See \autoref{sec:secfmt}.
% \item[par=\meta{par style},nopar] Define how paragraphs should be spaced.
%   Refer to \autoref{sec:par-defs}.
% \item[spacingdefs,nospacingdefs] Adjust spacing of lines and words
%   (\autoref{sec:spacingdefs}).
% \item[fontdefs,nofontdefs] Adjust some fonts (\autoref{sec:fontdefs}).
% \item[footnotedefs,nofootnotedefs] Adjust slightly the appearance of
%   footnotes.  See \autoref{sec:footnotedefs}.
% \item[hyperrefdefs=\meta{settings},nohyperrefdefs] Load the \pkgname{hyperref}
%   package, and set some defaults settings.  See \autoref{sec:hyperrefdefs}.
% \item[bibliographydefs,nobibliographydefs] Adjust the appearance and style of
%   the bibliography.  See \autoref{sec:bibliographydefs}.
% \end{pkgoptions}
%
% \begin{pkgtip}
%   To activate only a subset of features, use \pkgoptionfmt{preset=reset} and then
%   enable only the features required.  In this way, you can ensure that only those
%   features which are explicitly specified are enabled.
% \end{pkgtip}
%
%
% \section{Features}
%
% This package provides a large collection of small features, which, put all
% together, make the document look nicer (hopefully).  Let's go through these
% features, one by one.
%
% Note also that some features provided in the presets, such changing the
% document font, are not provided as individual features here.  This is because
% they may be set and customized directly using few lines of \LaTeX{} code or
% directly by including an external package.  In those cases, you may have a
% look at the preset's definition for inspiration (see \autoref{impl:presets}).
%
% For a summary of package options, see \autoref{sec:package-options}.
%
%
% \subsection{Title Formatting}
%
% \subsubsection{Title Styles}
% \label{sec:title-styles}
% \label{sec:main-default-title-style}
%
% The \pkgname{phfnote} package allows a set of alternative title styles.
% By default, the |default| title style is used.  You may change this
% setting with the |title=...| package option.
%
% \begin{pkgoptions}
% \item[title=default] The default title style displays the title in large bold
%   sans serif font, left-aligned.  Below the title appears the information
%   about author and date, indented, followed by a horizontal rule.  It looks
%   like this:
%   \begin{phfnoteDocVirtualPage}
%     \notetitle@style@default\null \shortlipsum \morepagecontents
%   \end{phfnoteDocVirtualPage}
%   As you can see, it saves more space on the page compared to the default
%   article title.
%
%   \changed[chg-title-default-spacing]{v3.0}{2018/10/25}{The default title
%   style was redesigned to improved spacing of the elements in all cases
%   including multiline titles, author and/or date not specified, and presence
%   or absence of thanks notes.  Use \texttt{title\eqsign defaultv1}
%   for old behavior}
%
%   If you would like your document to appear exactly as with \pkgname{phfnote}
%   version 1.0, then you can set the special title style |title=defaultv1|.
%
% \item[title=pretty,title=pretty2] A prettier, fancier title style.  The title
%   is centered, with two side bars providing a visual guide.  The |pretty|
%   style looks like this:
%   \begin{phfnoteDocVirtualPage}
%     \notetitle@stylesetup@pretty
%     \notetitle@style@pretty\null \shortlipsum \morepagecontents
%   \end{phfnoteDocVirtualPage}
%   And the |pretty2| style looks like this:
%   \begin{phfnoteDocVirtualPage}
%     \csname notetitle@stylesetup@pretty2\endcsname
%     \csname notetitle@style@pretty2\endcsname\null \shortlipsum \morepagecontents
%   \end{phfnoteDocVirtualPage}
%
%   \changed[chg-title-add-style-pretty]{v3.0}{2018/10/25}{Added the
%   \phfverb{pretty} and \phfverb{pretty2} title styles}
%
%   This title style is highly customizable (see below), in fact the |pretty2|
%   style is an alias for the |pretty| style, with adjusted settings.
%
%   These styles require the |xcolor| package (it will be loaded automatically).
%
% \item[title=small] A smaller title style which displays all the relevant
%   information on a single line.  This is useful for when even the default
%   title style appears too large.  It looks like this:
%   \begin{phfnoteDocVirtualPage}
%     \notetitle@stylesetup@small
%     \notetitle@style@small\null \shortlipsum \morepagecontents
%   \end{phfnoteDocVirtualPage}
%
% \item[title=article] Mimics the default title style from the |article| class,
%   but saves a little more space.  It looks like this:
%   \begin{phfnoteDocVirtualPage}
%     \notetitle@stylesetup@article
%     \notetitle@style@article\null \shortlipsum \morepagecontents
%   \end{phfnoteDocVirtualPage}
%
%   \changed[chg-title-article-spacing]{v3.0}{2018/10/26}{The \phfverb{article}
%   title style was redesigned to use our new title engine, with improved
%   spacing of the elements in all cases including multiline titles, author
%   and/or date not specified, and presence or absence of thanks notes.
%   Use \texttt{title\eqsign articlev1} for old behavior}
%
%   If you would like your document to appear exactly as with \pkgname{phfnote}
%   version 1.0, then you can set the special title style |title=articlev1|.
%
% \item[notitle] Also equivalently, |title=false|. Instructs \pkgname{phfnote}
%   not to override any title definition, thus preserving the default class
%   title style.
%
%   Beware that some other title goodies, such as our more advanced |\thanks|
%   notes, or spacing adjustments for the abstract, will probably not work.
%
%   For compatibility with previous versions of |phfnote|, you may also specify
%   an empty option value ``|title=|''.
% \end{pkgoptions}
%
% \begin{pkgtip}
%   When using the |default| and |pretty*| title styles, the argument to
%   |\title| may contain blank lines.  In this case, each part is typeset on a
%   separate line with an appropriate spacing.  For instance:
% \begin{verbatim}
% \title{Letter of Motivation
%
% John Doe}
% \end{verbatim}
%   will be typeset as
%   \begin{phfnoteDocVirtualPage}
%     \expandafter\def\csname @title\endcsname{Letter of Motivation\par John Doe}
%     \expandafter\def\csname @author\endcsname{}
%     \expandafter\def\csname @date\endcsname{}
%     \notetitle@style@default\null \morepagecontents
%   \end{phfnoteDocVirtualPage}
% \end{pkgtip}
%
% \changed[chg-title-false-pkgoption]{v3.0}{2018/10/16}{Improved
% \phfverb{title,notitle} package options syntax}
%
% \subsubsection{Customizing the style of the \phfverb{default}, \phfverb{pretty}
% and \phfverb{small} title styles}
% \label{sec:title-styles-customization}
% 
% You may customize the appearance of the |default| and |small| title styles by
% overriding some macros.
%
% \needspace{3\baselineskip}
% \DescribeMacro{\notetitlefont}\DescribeMacro{\notetitleauthorfont}
% \DescribeMacro{\notetitledatefont} The macros
% |\notetitlefont|, |\notetitleauthorfont|, and |\notetitledatefont| set the
% default main font title, author text and date text.  You may override these
% settings with, for instance:
% \begin{verbatim}
% \renewcommand{\notetitlefont}[1]{\sffamily\bfseries #1}
% \renewcommand{\notetitleauthorfont}[1]{\itshape #1}
% \renewcommand{\notetitledatefont}[1]{\footnotesize #1}
% \end{verbatim}
% In these macros, the parameter is expanded to the value provided by |\title|,
% |\author|, and |\date|, respectively.\footnote{While you can normally define
% \string\notetitlefont, \string\notetitleauthorfont\space and
% \string\notetitledatefont\space without an explicit parameter, this might
% produce some unexpected errors in some cases since some title styles (for
% technical details see implementation of the \texttt{article} title style).}
%
% The spacing of the title may be adjusted with the macros
% \DescribeMacro{\notetitlebelowspace} |\notetitlebelowspace| and
% \DescribeMacro{\notetitletopspace} |\notetitletopspace|.  Override these with
% e.g.:
% \begin{verbatim}
% \renewcommand{\notetitlebelowspace}{4mm}
% \renewcommand{\notetitletopspace}{-1.2cm}
% \end{verbatim}
% Finally, you may override the command \DescribeMacro{\notetitlehrule}
% |\notetitlehrule| which draws the rule below the title:
% \begin{verbatim}
% \renewcommand{\notetitlehrule}{\hrule height 0.8pt}
% \end{verbatim}
%
% \DescribeMacro{\notetitleusempfootnotestrue}
% \DescribeMacro{\notetitleusempfootnotesfalse} The commands
% |\notetitleusempfootnotestrue| and |\notetitleusempfootnotesfalse| set
% respectively whether any |\thanks| commands in the title generate footnotes
% inside the title area (which is drawn within a minipage), i.e., all thanks
% notes are collected on an additional line below the date, or whether they
% appear as regular footnotes at the bottom of the page.  Simply call the
% relevant command to set either setting (don't redefine these).
%
%
% The |small| title style allows you to customize the separator between the
% author and the date:
% \begin{verbatim}
% \renewcommand\notetitlesmallauthordatesep{\hspace*{0.5em}\cdot\hspace*{0.5em}}
% \end{verbatim}
% 
%
% In addition to the above settings for the default title style, the |pretty|
% and |pretty2| styles provide a few macros that you can adjust some visual
% aspects to your needs:
% \begin{verbatim}
% \renewcommand\notetitleprettylsiderulewidth{10pt}
% \renewcommand\notetitleprettylsidespacewidth{10pt}
% \renewcommand\notetitleprettyrsiderulewidth{10pt}
% \renewcommand\notetitleprettyrsidespacewidth{10pt}
% \renewcommand\notetitleprettytopspace{10pt}
% \renewcommand\notetitleprettybottomspace{10pt}
% \renewcommand\notetitleprettytophrulewidth{0pt}
% \renewcommand\notetitleprettybottomhrulewidth{0pt}
%
% \colorlet{notetitleprettylsiderulecolor}{blue!40!black}
% \colorlet{notetitleprettyrsiderulecolor}{notetitleprettylsiderulecolor}
% \colorlet{notetitleprettytophrulecolor}{notetitleprettylsiderulecolor}
% \colorlet{notetitleprettybottomhrulecolor}{notetitleprettylsiderulecolor}
% \colorlet{notetitleprettytextcolor}{blue!20!black}
% \colorlet{notetitleprettybgcolor}{white!95!blue}
% \end{verbatim}
%
%
% \subsubsection{Title notes: \phfverb\thanks{} and \phfverb\thanksmark}
%
% \DescribeMacro{\thanks}
% Notes in the title can be introduced with the |\thanks| macro.  You may use
% this to specify an e-mail address, an affiliation, or any other more specific
% information.  |\thanks| may appear in all three title, authors and date.
%
% The appearance of this additional information depends on the title style.  In
% the default note title style, such thanks-notes appear directly below the
% title.  For example, with
% {\ttfamily|\|author\{Ph.\@ Faist|\|thanks\{|\|itshape Institute for Theoretical Physics, ETH Zurich\}\}}, you get:
% \begin{phfnoteDocVirtualPage}
%   \author{Ph. Faist\thanks{\itshape Institute for Theoretical Physics, ETH Zurich}}\relax
%   \notetitle@style@default\null \morepagecontents
% \end{phfnoteDocVirtualPage}
% whereas with the other styles, this information is typeset as regular footnotes.
%
% \leavevmode\PrintMarginLabel{\string\thanks[N]}\relax
% You may specify an optional argument to |\thanks|, forcing the footnote to a
% specific number (it must be a number).  For example, with
% {\ttfamily|\|author\{Ph.\@ Faist|\|thanks[9]\{|\|itshape Institute for
% Theoretical Physics, ETH Zurich\}\}}, you get:
% \begin{phfnoteDocVirtualPage}
%   \author{Ph. Faist\thanks[9]{\itshape Institute for Theoretical Physics, ETH Zurich}}\relax
%   \notetitle@style@default\null \morepagecontents
% \end{phfnoteDocVirtualPage}
%
% \DescribeMacro{\thanksmark} |\thanksmark[N]| works with |\thanks| as
% |\footnotemark| works with |\footnote|.  It just displays the given number as
% a footnote mark.  In this way, you can have for example several shared
% affiliations:
% \begin{phfnoteDocVirtualPage}
%   \title{Notes about Stuff}
%   \date{25.12.2015}
%   \author{First Author\thanks[1]{\itshape Institute ABC}, Second Author\thanks[2]{\itshape Somewhere else},
%      and Third Author\thanksmark[1]}\relax
%   \notetitle@style@default\null \morepagecontents
% \end{phfnoteDocVirtualPage}
% the author code was:
% \begin{verbatim}
% \author{First Author\thanks[1]{\itshape Institute ABC},
%     Second Author\thanks[2]{\itshape Somewhere else},
%     and Third Author\thanksmark[1]}
% \end{verbatim}
%
% Unfortunately, you still have to provide the numbering manually.  On the other
% hand, this package is not meant to replace \RevTeX, so if you're writing a
% complicated article with many authors and affiliations, you probably shouldn't
% be using \pkgname{phfnote} in the first place.
%
% \begin{pkgwarning}
%   The optional argument to |\thanks|, as well as the command |\thanksmark|,
%   are not made available if you don't use one of \pkgname{phfnote}'s title
%   styles.
%
%   This behavior is such as to prevent interference with more advanced class
%   mechanisms, such as \RevTeX's.
% \end{pkgwarning}
%
% \begin{pkgtip}
%   For \pkgname{phfnote}'s title styles, you can issue the commands
%   |\notetitleusempfootnotestrue| or |\notetitleusempfootnotesfalse|
%   (documentation in \autoref{sec:title-styles-customization}) to decide
%   whether the thanks notes are issued in a separate title line, or if they are
%   displayed as regular footnotes at the bottom of the page.
% \end{pkgtip}
%
%
% \subsection{Abstract}
% \label{sec:abstract-attributes}
%
% \DescribeEnv{abstract} The |abstract| environment renders indented text aimed
% to provide a short summary of the document.  We might use, for example, the
% following code:
% \begin{verbatim}
% \begin{abstract}
% Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus
% elit, vestibulum ut, placerat ac, adipiscing vitae, felis.
% Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
% consectetuer id, vulputate a, magna.
% \end{abstract}
% \end{verbatim}
%
% which would look like this:
% \begin{phfnoteDocVirtualPage}
%   \title{Notes about Stuff}\relax
%   \date{25.12.2015}\relax
%   \author{Me}\relax
%   \notetitle@style@default
%   \def\noteabstract@nameline{{\parskip=0pt\relax\par\centering\noteabstractnamefont\abstractname\par}\vskip 1ex\relax}%
%   \def\noteabstracttextwidth{0.8\textwidth}%
%   \begin{abstract}
% Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus
% elit, vestibulum ut, placerat ac, adipiscing vitae, felis.
% Curabitur dictum gravida mauris. Nam arcu libero, nonummy eget,
% consectetuer id, vulputate a, magna.
%   \end{abstract}
%   \morepagecontents
% \end{phfnoteDocVirtualPage}
%
% The |abstract| environment should be given \emph{after} the |\maketitle|
% command.  (In contrast to, e.g., \RevTeX.)
%
% You may customize the appearance of the abstract via a list of attributes
% given as argument to a package option.  When you combine arguments, make sure
% to put them in a braced group: |[abstract={wide,noname,it}]|.
%
% \begin{pkgoptions}
% \item[abstract=\pkgoptattrib{wide}] The abstract should not be indented, and
%   should instead be aligned to the rest of the text.
% \item[abstract=\pkgoptattrib{narrow}] The abstract should be indented narrower
%   then by default.
% \item[abstract=\pkgoptattrib{noname}] The title ``Abstract.'' above the text
%   will not be typeset.  The abstract text is typeset directly instead.
% \item[abstract=\pkgoptattrib{small}] Use a smaller font for the abstract text
%   (|\small| font).
% \item[abstract=\pkgoptattrib{compact}] Reduce spacing before and after the
%   abstract.  If the abstract is short, this might look slightly better.
% \item[abstract=\pkgoptattrib{it}] Typeset the abstract text using an italic
%   typeface.
% \item[noabstract] Do not (re)define the |abstract| environment, do not execute
%   abstract definitions.  This leaves the original |abstract| environment
%   definition of the underlying \LaTeX{} class.  You can also equivalently say
%   |abstract=false|.
% \end{pkgoptions}
%
% 
% The abstract environment's appearance can be customized more finely
% by redefining some macros.  (In fact, this is what the package
% options |abstract=...| actually do.)  The font used for the text of
% the abstract is set by \DescribeMacro{\noteabstracttextfont}
% |\noteabstracttextfont|.  This macro should expand to font selection
% commands, such as |\itshape|, |\bfseries|, |\small|, etc.  The title
% of the abstract (the word ``Abstract.\@'') is typeset in the font set
% by \DescribeMacro\noteabstractnamefont |\noteabstractnamefont|.  The
% width of the whole abstract text is determined by
% \DescribeMacro{\noteabstracttextwidth} |\noteabstracttextwidth|.
% Observe that |\noteabstracttextwidth| is a macro, and not a proper
% length, so that it can determine more dynamically the length.  The
% spacing below \DescribeMacro{\noteabstractafterspacing}
% (|\noteabstractafterspacing|) and above
% \DescribeMacro{\noteabstractbeforespacing}
% (|\noteabstractbeforespacing|) the abstract can further be
% specified, also as macros.
%
%
% Obsolete options:
% \begin{pkgoptions}
% \item[abstract=\pkgoptattrib{original}] Revert to the original class' default
%   implementation of the |abstract| environment before \pkgname{phfnote} was
%   loaded.  The original class' implementation is restored and no longer
%   tampered with.  This option is OBSOLETE, use |noabstract| instead.
% \end{pkgoptions}
%
% \changed[chg-noabstract-pkgoption]{v3.0}{2018/10/16}{Improved
% \phfverb{abstract,noabstract} package options syntax}
%
% \subsection{Table of Contents}
% \label{sec:inline-toc}
%
% \DescribeMacro{\inlinetoc} The package \pkgname{phfnote} also provides a
% table of contents typeset with reduced spacing to be more compact, and
% with horizontal rules before and after.  You can insert the table of
% contents with the command |\inlinetoc|.  It looks like this:
%
% \begin{phfnoteDocVirtualPage}
%   \title{Notes about Stuff}\relax
%   \date{25.12.2015}\relax
%   \author{Me}\relax
%   \notetitle@style@default
%   \def\noteabstract@nameline{{\parskip=0pt\relax\par\centering\noteabstractnamefont\abstractname\par}\vskip 1ex\relax}%
%   \def\noteabstracttextwidth{0.8\textwidth}%
%   \begin{abstract}
% Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus
% elit, vestibulum ut, placerat ac, adipiscing vitae, felis.
%   \end{abstract}
%   \def\@starttoc#1{\relax
%     \contentsline {section}{\numberline {1}Introduction}{2}{section.1}
%     \contentsline {section}{\numberline {2}Basic Usage}{3}{section.2}
%     \contentsline {subsection}{\numberline {2.1}Loading the Package}{3}{subsection.2.1}
%     \contentsline {subsection}{\numberline {2.2}Presets}{3}{subsection.2.2}
%   }\relax
%   \inlinetoc
%   \morepagecontents
% \end{phfnoteDocVirtualPage}
%
%
% \subsection{Predefined Package Sets}
% \label{sec:package-sets}
%
% The \pkgname{phfnote} package also provides sets of standard \LaTeX{}
% packages to load.  You may choose between a varying degree of
% ``richness'' of packages included.
%
% \begin{pkgoptions}
% \item[pkgset=none] Do not include any package set.
%
% \item[pkgset=minimal] Include some basic minimal set useful for
%   scientific notes: the \AmS{} packages \pkgname{amsmath},
%   \pkgname{amssymb}, \pkgname{amsfonts}, and \pkgname{amsthm}.  The
%   \pkgname{xcolor} package is also loaded.
%
% \item[pkgset=rich] Include a fair amount of packages which may be useful.  On
%   top of the |minimal| package set, this set includes the packages
%   \pkgname{enumitem}, \pkgname{graphicx}, \pkgname{microtype},
%   \pkgname{caption}, \pkgname{setspace}, as well as \pkgname{inputenc} with
%   the |utf8| option and \pkgname{fontenc} with the |T1| option (the packages
%   \pkgname{fontenc} and \pkgname{inputenc} are not loaded if running Xe(La)TeX
%   or Lua(La)TeX, or if they are already loaded with possibly different
%   options).
%
%   This package set is loaded by default.
%
%   \changed[chg-xe-luatex-input-fontenc-pkgset]{v1.1}{2018/08/27}{If running
%   XeTeX or LuaTeX, then do not load \pkgname{inputenc} and \pkgname{fontenc}
%   as part of \texttt{rich} and \texttt{extended} package sets.  Plus, do not
%   load \pkgname{inputenc} (resp. \pkgname{fontenc}) if the package is already
%   loaded}
%
% \item[pkgset=extended] Additionally, include packages \pkgname{float},
%   \pkgname{verbdef}, \pkgname{csquotes}, \pkgname{dsfont}, \pkgname{bbm}
%   and \pkgname{mathtools}.
%
% \end{pkgoptions}
%
%
% \subsection{Page Geometry}
% \label{sec:pagegeomdefs}
%
% Another important aspect of \pkgname{phfnote} is the handling of page
% margins.  Often the default page margins of the \pkgname{article} class
% are quite narrow.  While it is a good typographical practice to avoid
% long lines, on occasion we prefer to have notes typeset with wider text.
% The general answer is the \pkgname{geometry} package, which allows to set all
% margins in full detail.
%
% The \pkgname{phfnote} package provides some standard choices of options for the
% \pkgname{geometry} package, which are adjusted according to the document font size,
% and whether the document is typeset in two columns.
%
% If you want anything more complicated than what is provided by a default
% setting here, just use the |nopagegeom| package option and invoke the
% \pkgname{geometry} package directly with your preferred set of options.
%
% The page geometry predefined settings are the following.
%
% \begin{pkgoptions}
% \item[pagegeom=default] Default settings. Not too wide, not too
%   narrow. Settings vary according to single or double column setting, and
%   according to default font point size.
% \item[nopagegeom] Also, |pagegeom=false|.  Do not change page geometry
%   settings, do not load the \pkgname{geometry} package.
% \item[pagegeom=narrow] Narrower style.  For single-column documents, this is
%   closer to the typographically-advertised-optimal of 50--80 characters per
%   line, but it might look narrow to some.
% \item[pagegeom=wide] Wide, comfortable style.  Wastes less paper.
% \item[pagegeom=xwide] Extra wide.  Use if you pity trees.
% \item[pagegeom=bigmargin] Makes the margins asymmetric, so that a wide margin
%   note can fit.  This style is used in this package documentation, for
%   example.
% \end{pkgoptions}
%
% The following package options are OBSOLETE:
% \begin{pkgoptions}
% \item[pagegeomdefs=\meta{true or false}] Whether to care about page
%   margins. |nopagegeomdefs| is synonym for |pagegeomdefs=false|.  This option
%   is OBSOLETE, please use |nopagegeom| or |pagegeom=false| instead of
%   |pagegeomdefs=false| and |pagegeom| (or |pagegeom=...| with setting) instead
%   of |pagegeomdefs=true|.
% \end{pkgoptions}
%
% \changed[chg-pagegeom-pkgoption-onoff]{v3.0}{2018/10/16}{Changed how to turn
% on/off the page geometry settings by improving the \phfverb{pagegeom} package
% options, deprecated \phfverb{pagegeomdefs} option}
%
% \changed[chg-pagegeom-xwide]{v3.0}{2018/11/30}{Changed the \texttt{xwide} page
% geometry for tighter vertical margin for single-column text (use
% \texttt{pagegeom\eqsign xwidev1} instead for old behavior)}
%
%
% \subsection{Section Headers Styling}
% \label{sec:secfmt}
%
% The \pkgname{phfnote} package provides some limited styling of section
% headers.  The font, size and ``compactness'' of the headers can be adjusted
% with title options.  But really, these options are quite basic.  You should
% use \pkgname{titlesec} or \pkgname{sectsty} directly if you want anything
% serious.
%
% The section headings are customized using the \pkgname{sectsty} package.  If
% this conflicts in your document, then use the |nosecfmt| package option to
% indicate that section headings should NOT be styled by this package.  Then
% you have the full freedom to take care of section styling manually.
%
% Package options may be used to customize the appearance of the section
% headings by specifying a list of attributes.  When you combine arguments, make
% sure to put them in a braced group: |[secfmt={section,compact}]|.  Beware that
% attributes are not merged between different occurrences of the |secfmt|
% keyword in the package options; the last occurrence defines all set
% attributes.  If the |secfmt| package option is not given, then by default only
% the |section| attribute is set.
%
% \begin{pkgnote}
%   Don't forget to include the attribute `|section|' and/or `|paragraph|'
%   depending on which type of heading you want your settings to apply to.  For
%   example, \pkgoptionfmt{secfmt=\pkgoptattribnodots{sffamily}} has no effect,
%   you need to use e.g.\@
%   \pkgoptionfmt{secfmt=\pkgoptattribnodots{section,sffamily}}.
% \end{pkgnote}
% 
% Available attributes are the following:
%
% \begin{pkgoptions}
% \item[secfmt=\pkgoptattrib{section}] Use the |section| attribute to activate
%   the styling of section-level headings, that is, |\section|, |\subsection|
%   and |\subsubsection|.
% \item[secfmt=\pkgoptattrib{paragraph}] This attribute indicates that the
%   styling should apply to paragraph-level headings as well (|\paragraph| and
%   |\subparagraph|).
% \item[secfmt=\pkgoptattrib{compact}] Reduce the sizes of the section headings
%   (if the section-level headings are styled, i.e.\@ you need to specify the
%   |section| attribute), giving the document a more ``compact'' appearance.
% \item[secfmt=\pkgoptattrib{larger}] Increase the sizes of the section
%   headings.  Suitable for longer documents or for small document font sizes.
% \item[secfmt=\pkgoptattrib{secsquares}] Display black squares on the left side
%   of |\section|-level commands, making them stand out better.  This is useful
%   for documents (such as the present one) with several layers of sub-sections.
% \item[secfmt=\pkgoptattrib{secnummargin}] Display the section, subsection, and
%   subsubsection numbering in the left margin and have the title occupy the
%   full width of the text (such as for this document).  If you want both
%   \pkgoptionfmt{secsquares} and \pkgoptionfmt{secnummargin}, you must specify
%   them in that order, or the black square may end up overlapping with the
%   number.
% \item[secfmt=\pkgoptattrib{rmfamily}] Typeset headings in the regular
%   roman font of the document, instead of trying to apply the
%   {\fontfamily{ppl}\fontseries{bx}\selectfont Palatino font}.  This
%   applies to section-level and/or paragraph-level headings, depending on
%   which of the attributes |section| and/or |paragraph| have been
%   specified.
% \item[secfmt=\pkgoptattrib{sffamily}] Typeset headings in a sans-serif font.
%   The default document sans serif font is used.  This applies to section-level
%   and/or paragraph-level headings, depending on which of the attributes
%   |section| and/or |paragraph| have been specified.
% \item[secfmt=\pkgoptattrib{itpar}] Typeset paragraph-level headings in italic.
% \item[secfmt=\pkgoptattrib{blockpar}] Change the paragraph-level headings not
%   to be in ``run-in'' style, but to be typeset on their own line like section
%   headings.
% \item[nosecfmt] Keep the original class styling; nothing will be overridden
%   and the \pkgname{sectsty} package is not loaded.  (Equivalently, you may
%   specify |secfmt=false|.)
% \end{pkgoptions}
%
% You can also directly modify the section heading style by redefining some
% macros.  Note that these macros only affect those sectioning commands which we
% have decided to style, which is specified by the |section| and |paragraph|
% attributes to be specified in the |secfmt={...}| package option.
%
% \DescribeMacro{\notesectionallfont} The macro |\notesectionallfont| is invoked
% for every sectioning command (for those which are styled, see the |section|
% and |paragraph| attributes). The macro |\notesectionallfont| internally
% invokes \DescribeMacro{\notesectionallfontfamily} |\notesectionallfontfamily|
% to select which font family to use.  The family should be given as the font
% code, e.g.: |pbk| = {\fontfamily{pbk}\selectfont Bookman}; |bch| =
% {\fontfamily{bch}\selectfont Charter}; |ppl| = {\fontfamily{ppl}\selectfont
% Palatino}; |ptm| = {\fontfamily{ptm}\selectfont Adobe Times}; |phv| =
% {\fontfamily{phv}\selectfont Adobe Helvetica}; |pcr| =
% {\fontfamily{pcr}\selectfont Adobe Courier}; |put| =
% {\fontfamily{put}\selectfont Utopia}; |cmr| = {\fontfamily{cmr}\selectfont
% Computer Modern Roman}; |cmss| = {\fontfamily{cmss}\selectfont CM Sans Serif};
% |cmbr| = {\fontfamily{cmbr}\selectfont CM Bright}; google many more or look
% directly into the source of corresponding \LaTeX{} packages.
%
% You may customize these either via attributes or by redefining them directly.
% Beware that if you redefine |\notesectionallfont| then you are responsible for
% honoring, or ignoring, the value of |\notesectionallfontfamily|.
%
% \needspace{5\baselineskip}
% \DescribeMacro{\notesectionfont} \DescribeMacro{\notesubsectionfont}
% \DescribeMacro{\notesubsubsectionfont} \DescribeMacro{\noteparagraphfont}
% \DescribeMacro{\notesubparagraphfont} These macros define the font commands to
% apply for the section heading corresponding to the given sectioning command.
% This macro is invoked after |\notesectionallfont|, which means that font
% definitions in these macros take precedence over those in
% |\notesectionallfont|.
%
% \DescribeMacro{\notesectionsetfonts} The macro |\notesectionsetfonts| is a
% shorthand to set all section font definitions for the section-level commands
% |\section|, |\subsection|, and |\subsubsection|.  For example,
% \begin{verbatim}
%   \notesectionsetfonts{\Large}{\large}{\normalsize}
% \end{verbatim}
% will set the font sizes for |\section|, |\subsection| and |\subsubsection| in
% this order.
%
% \DescribeMacro{\noteparagraphsetfonts} The macro |\noteparagraphsetfonts| is
% the corresponding shorthand for the paragraph-level commands.  It takes two
% arguments, the font definitions to apply for headings of level |\paragraph|
% and |\subparagraph|.
%
% Obsolete options:
% \begin{pkgoptions}
% \item[secfmt=\pkgoptattribempty] Leave the argument empty to keep the original
%   class styling; nothing will be overridden and the \pkgname{sectsty} package
%   is not loaded.  This option is OBSOLETE, use |nosecfmt| instead.
% \end{pkgoptions}
% 
% \changed[chg-secfmt-false-pkgoption]{v3.0}{2018/10/16}{Improved
% \phfverb{secfmt,nosecfmt} package options syntax}
%
%
% \subsection{Appearance of Paragraphs}
% \label{sec:par-defs}
%
% Several presets may be set to define the appearance of paragraphs.  
%
% \begin{pkgoptions}
% \item[par=indent] Paragraphs are indented, bearing some
%   similarity to the \pkgname{article} class' default paragraph style.
% \item[par=skip] Paragraphs are separated by additional spacing,
%   and not indented.
% \item[par=indentminiskip] Paragraphs are indented, but there is also a small
%   space between each paragraph.
% \item[nopar] Do not modify the appearance of paragraphs, and leave the
%   original class' default.  
%   
%   You may also use |par=false|.
% \end{pkgoptions}
%
%
% Obsolete options:
% \begin{pkgoptions}
% \item[par=original] OBSOLETE---use |nopar| instead.
% \end{pkgoptions}
%
% \changed[chg-par-false-pkgoption]{v3.0}{2018/10/16}{Improved
% \phfverb{par,nopar} package options syntax}
%
%
% \subsection{Adjusting Spacing of Lines and Words}
% \label{sec:spacingdefs}
%
% The \pkgname{phfnote} package also provides definitions to adjust spacing of lines and
% words.
%
% This includes definitions to avoid overflowing words in the margin in case of
% long words.
% 
% \begin{pkgoptions}
% \item[spacingdefs] Apply adjustments to line and word spacing.
%
%   This feature is on by default.  You can also use |spacingdefs=true|.
%
% \item[nospacingdefs] Do not attempt any adjustments of line or word spacing.  You
%   can also use the alias |spacingdefs=false|.
% \end{pkgoptions}
%
%
%
% \subsection{Adjustments for Fonts}
% \label{sec:fontdefs}
%
% The \pkgname{phfnote} package provides as well some adjustments for fonts to make some
% fonts look nicer.
%
% Concretely, the {\fontfamily{cmbr}\selectfont Computer Modern Bright} font is
% used as sans serif font instead of {\fontfamily{cmss}\selectfont \LaTeX's
% default sans serif font}, and the more universal |T1| font encoding is used
% instead of the default |OT1|.
%
% \begin{pkgoptions}
% \item[fontdefs] Apply adjustments to fonts.  This is on by default, except on
%   Xe\TeX{} and Lua\TeX{}.
%
%   You can also use |fontdefs=true|.
%
% \item[nofontdefs] Do not apply adjustments to fonts.  You can also set
%   |fontdefs=false|.
%
% \end{pkgoptions}
%
%
% \subsection{Footnote Style}
% \label{sec:footnotedefs}
%
% The footnotes' appearance can also be slightly enhanced.
%
% \begin{pkgoptions}
% \item[footnotedefs] Changes the symbol appearance a little bit---the
%   footnote number is smaller and typeset in boldface.
%
%   You can also use |footnotedefs=true|. This feature is on by default.
%
% \item[nofootnotedefs] Do not change the footnote appearance.  You can also set
%   |footnotedefs=false|.
% \end{pkgoptions}
% 
%
% \subsection{Hyperref Loading}
% \label{sec:hyperrefdefs}
%
% There are many options for setting up the \pkgname{hyperref} package, and often, the
% defaults (with boxed links) are pretty ugly in my opinion.  Enable the
% |hyperrefdefs| feature of \pkgname{phfnote} to alter the defaults to something I
% personally like better (dark blue links as in this document).
%
% \begin{pkgoptions}
% \item[hyperrefdefs] Load the \pkgname{hyperref} package, and
%   set some sensible default settings.  Also ensures the |\email| and |\url| commands
%   are made available.
%
%   You can also use |hyperrefdefs=true|. This feature is on by default.
%
% \item[nohyperrefdefs] Do not load the \pkgname{hyperref} package.  Do not set
%   any settings.  Do not care to provide |\email| or |\url|.  Same as
%   |hyperrefdefs=false|.
%
%   Depending on the situation, you might prefer to specify |hyperrefdefs=defer|
%   or |hyperrefdefs=noload|, so that some basic setup (e.g. |\url|/|\email|
%   commands) can still be provided.  See below.
%
% \item[hyperrefdefs=\pkgoptattrib{defer}] Prepare the document for hyperlinks,
%   schedule settings for \pkgname{hyperref}, but do not actually load the
%   \pkgname{hyperref} package.
%
%   This is useful if you would like to load more packages that need to be
%   loaded before loading \pkgname{hyperref}.  A lot of packages need to be
%   loaded before \pkgname{hyperref} so if you load several other packages,
%   you're probably better off using this option and calling
%   |\usepackage{hyperref}| at the end of your preamble, i.e.\@ right before
%   |\begin{document}|, rather than chasing mysterious errors.
%     \iffalse \end{document} -- [...emacs indentation gets fooled easily...] \fi
%   
%   When using this option it is the user's responsibility to load the load the
%   package with |\usepackage{hyperref}| somewhere in the preamble.  You will
%   get an error if you don't do this.
%
% \item[hyperrefdefs=\pkgoptattrib{noemail}] Do not override any existing
%   |\email| command.  Use this for instance in Rev\TeX{}, where our
%   implementation of |\email| clashes with Rev\TeX{}'s |\email| command which
%   is used to specify e-mail addresses for authors.
%
%   The version of this command by \pkgname{phfnote} is still available as
%   |\phfnoteEmail|.
%
% \item[hyperrefdefs=\pkgoptattrib{noeqref}] Do not redefine the |\eqref|
%   command to include the parenthesis in the hyperlink.
%
%   \changed[chg-hyperref-redefeqref]{v3.2}{2021/07/29}{We now redefine
%   \phfverb{\eqref} by default to include the parentheses inside the hyperlink.
%   Use the \texttt{hyperrefdefs\eqsign noeqref} package option to disable this
%   feature}
%
% \item[hyperrefdefs=\pkgoptattrib{noload}] Do not load the \pkgname{hyperref}
%   package, and don't bother to set any related settings.  However,
%   \pkgname{url} package is loaded, and the commands |\url| and |\email| are
%   provided (they output the same visual text but don't produce a clickable
%   color link).
%
% \item[hyperrefdefs=\pkgoptattrib{clearoptions}] Do not attempt to set any
%   options via |\hypersetup| (and don't schedule setting any such options
%   later).  You'll get \pkgname{hyperref}'s default settings, so it's up to you
%   to call |\hypersetup| with however you'd like to see your links look like.
%
% \end{pkgoptions}
%
% Attributes may be combined, as in |hyperrefdefs={noemail,noload}|.  In this
% case make sure you put them in a braced group.  Also, beware that attributes
% are not merged between different occurrences of the |hyperrefdefs| keyword in
% the package options; the last occurrence defines all set attributes.
%
% When the |hyperref| package is loaded, it is done so with the |unicode=true|
% package option.  In case you need, you can specify your own package options
% with |hyperrefdefs=defer| and then calling |\usepackage[...]{hyperref}|.  For
% most options though it's simpler to use |\hypersetup{...}|.
%
%
% \DescribeMacro{\url} In order to typeset URLs, the |\url| command is made
% available from the package \pkgname{url} (which is then linkified by
% \pkgname{hyperref}).  For example, you can type
% |\url{https://github.com/phfaist/}|.
%
% \DescribeMacro{\email} \DescribeMacro{\phfnoteEmail} A similar command allows
% to typeset e-mail addresses.  The text is displayed as a hyperlink, which when
% clicked opens a e-mail composer to that address (via a |mailto:XXX| link).
% For example, try |\email{pulp_fiction@tarantino.com}|.  The command
% |\phfnoteEmail| is an alias for this, which is defined even if the |noemail|
% attribute is given.
%
% The commands |\url| and |\email| (along with |\phfnoteEmail|) are defined
% unless |nohyperrefs| (or |hyperrefdefs=false|) is specified.  If you would
% like to use these commands but not load the |hyperref| package, consider using
% |hyperrefdefs=noload|.
% 
%
% \DescribeMacro{\phfnotePdfLinkColor} The command |\phfnotePdfLinkColor| may by
% used to set the color of the links.  It takes one argument, a color
% specification understood by the \pkgname{xcolor} package.  For example:
% \begin{verbatim}
%   \phfnotePdfLinkColor{green!50!black}
% \end{verbatim}
%
% \begin{pkgnote}
%   The package \pkgname{xcolor} must be loaded for |\phfnotePdfLinkColor|
%   to work.  (The \pkgname{xcolor} package is automatically loaded as part
%   of a package set as long as you're not using the option |pkgset=none|;
%   see \autoref{sec:package-sets}.)
% \end{pkgnote}
%
% The internal name for the link color is |docnotelinkcolor|.  (This name is
% historical, and I'm not really willing to change it.)
%
%
% \subsection{Bibliography Definitions}
% \label{sec:bibliographydefs}
%
% This package also provides some definitions for the bibliography.
%
% It sets the |naturemagdoi| style by default, which is a hacked (by yours
% truly) version of the |naturemag| style to include the journal name as a
% hyperlink (as in APS bibliography styles).
%
% The bibliography is also typeset in a smaller font.
%
% Finally, an entry in the table of contents is generated.
%
% \begin{pkgoptions}
% \item[bibliographydefs] Set some default bibliography settings.
%
%   This feature is on by default.  You can also use |bibliographydefs=true|.
%
% \item[nobibliographydefs] Do not set some bibliography settings.  You may also
%   use |bibliographydefs=false|.
% \end{pkgoptions}
%
% \DescribeMacro{\bibliography} \DescribeMacro{\bibliographystyle} The
% |\bibliographystyle| and |\bibliography| macros can be used as usual, for
% example:
% \begin{verbatim}
%   \bibliographystyle{apsrmp4-1} % optional
%   \bibliography{mybibfile}
% \end{verbatim}
% bearing in mind that if the |\bibliographystyle| command is not present, our
% custom |naturemagdoi| bibliography style is used.
%
%
% \subsection{Inline Commenting in Documents}
% \label{sec:inline-commenting}
%
% Inline commenting features (|\phfMakeCommentingCommand|) have been moved to
% the separate dedicated package \pkgname{phfcc}.  If you were using these
% features in your document, simply do
% \begin{verbatim}
% \usepackage{phfcc}
% \end{verbatim}
% and everything should work as expected.
% 
% \changed[chg-inline-commenting]{v3.0}{2018/10/03}{Added support for inline
% commenting using \phfverb\phfMakeCommentingCommand}
%
% \changed[chg-inline-commenting-moved]{v3.1}{2020/04/02}{Moved support for
% inline commenting to the separate dedicated package \pkgname{phfcc}}
%
%
%
% \subsection{URL Styles}
% \label{sec:url-styles}
%
% As a bonus, the \pkgname{phfnote} package provides an alternative set of URL styles to
% use with the |\url| and |\email| commands (see \autoref{sec:hyperrefdefs}).
%
% All the styles described below typeset the URL in a slightly smaller size, so
% as to avoid a common issue with URLs that they tend to appear too large.
% Also, the tilde character is fixed so that it appears nicely, as in:\\
% \url{https://people.phys.ethz.ch/~pfaist/}.
%
% The URL style can be set with the command |\urlstyle|\marg{name of style}.
%
% \begin{description}[font=\ttfamily,labelwidth=8em]
% \item[notett] typewriter font
% \item[notesf] default sans serif font
% \item[notesfss] Computer Modern Sans Serif font
% \item[noteitsf] italic using default sans serif font 
% \item[noterm] normal roman typeface
% \item[noteit] just italic typeface
% \item[notesml] just smaller than surrounding text
% \end{description}
%
%
% \subsection{A \phfverb{\notesmaller} Command}
%
% This general-purpose command is handy to typeset text smaller than its
% surrounding text, for when you don't know what size the surrounding text is
% typeset at.  In some sense, this is a very very lightweight analogue of what
% the \pkgname{relsize} package does.  (This is used, for example, in our implementation
% of URL styles introduced in \autoref{sec:url-styles}.)
%
% \DescribeMacro{\notesmaller}\DescribeMacro{\notesmaller[0.8]} Set the font
% size to a fraction of the surrounding font size.  The fraction may be
% specified as an optional argument.  A fraction of 0.8 makes the text size 0.8
% times that of the surrounding text, that is, smaller than the surrounding
% text.  A value of~1 does not change the font size.  If the fraction is not
% specified, the value stored in |\notesmallerfrac| is used.
%
% \DescribeMacro{\notesmallerfrac} The fraction by which |\notesmaller| typesets
% smaller text when no optional argument is given.  You may redefine this
% command to set the default ``smaller'' size fraction.
%
% \subsection{Tools Mostly for Hackers}
%
% The \pkgname{phfnote} package also provides some small hacks.  They are documented
% further in \autoref{sec:impl-other-stand-alone-defs}.  These are:
% \DescribeMacro{\phfnoteHackSectionStarWithTOC} a macro
% |\phfnoteHackSectionStarWithTOC| to hack into a command which generates a
% |\section*|, in order for that command to also generate a corresponding entry
% in the table of contents; and
% \DescribeMacro{\phfnoteSaveDefs}\DescribeMacro{\phfnoteRestoreDefs} a pair of
% commands to save and restore \LaTeX{} definitions.
%
% 
%
%
%
%
%
% \StopEventually{\PrintChangesAndIndex}
%
% \section{Implementation}
%
% Here comes the gory code.
%
% Let's start by loading the \pkgname{kvoptions} package, which we need to
% parse the package options.  It's better to use \pkgname{xkeyval} as
% backend, because the |\setkeys| by \pkgname{keyval} is a little fragile:
% for example, it gets confused if, within a preset, we include a package
% or run a command which itself parses key-vals.
%
%    \begin{macrocode}
\RequirePackage{xkeyval}
\RequirePackage{kvoptions}
%    \end{macrocode}
%
% Also load \pkgname{etoolbox}, for various utilities and \pkgname{xparse}
% (for parsing optional arguments with recursive matching open/close brackets).
%    \begin{macrocode}
\RequirePackage{etoolbox}
\RequirePackage{xparse}
%    \end{macrocode}
%
% \subsection{Internal Generic Code}
%
% \begin{macro}{\phfnote@internal@execattribbs}
%   An internal general-purpose macro to execute all definitions given in list of
%   attributes.
%
%   Often, a list of attributes are given via a package option (e.g.\@ for the abstract),
%   and these attributes need to be executed, or implemented, in the order they are given.
%   This macro takes care of that.  Each possible attribute must be defined as a macro
%   with a common prefix, to which the attribute is appended.
%
%   The arguments are:
%   \begin{itemize}
%   \item |#1| = prefix to look for attributes (e.g.\@ |noteabstract@attr@|);
%   \item |#2| = a human-readable name of what |#1| represents, which is used in an error
%     message in case the required attribute is not found (e.g.\@ |{abstract attribute}|);
%   \item |#3| = the list of attributes specified by the user.
%   \end{itemize}
% 
%   For example, |\phfnote@internal@execattribs{noteabstract@attr@}|\hskip0pt\relax
%   |{abstract attribute}|\hskip0pt\relax |{noname,small}| causes the commands
%   |\noteabstract@attr@noname| and |\noteabstract@attr@small| to be invoked, in this
%   order.
%
%    \begin{macrocode}
\def\phfnote@internal@execattribs#1#2#3{%
  \@for\next:=#3\do{%
    \ifcsname #1\next\endcsname%
      \csname #1\next\endcsname%
    \else%
      \PackageError{phfnote}{Unknown #2: '\next'. Ignoring.}{The given #2 '\next'
        is invalid.  Consult the package documentation for information about
        valid attributes.}
    \fi
  }
}
%    \end{macrocode}
% \end{macro}
% 
% \subsection{Title Styling}
%
% See \autoref{sec:title-styles} for a description of the styles and which
% features are available.
%
% \subsubsection{First, some common simple definitions for our different styles}
%
% \needspace{3\baselineskip}
% \begin{macro}{\notetitlefont}
% \begin{macro}{\notetitleauthorfont}
% \begin{macro}{\notetitledatefont}
%   These may be redefined to adapt the font of the title, author and date.
%
%    \begin{macrocode}
\newcommand{\notetitlefont}[1]{\sffamily\bfseries #1}
\newcommand{\notetitleauthorfont}[1]{#1}
\newcommand{\notetitledatefont}[1]{\footnotesize #1}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% 
% \begin{macro}{\notetitlebelowspace}
% \begin{macro}{\notetitletopspace}
%   These macros may be redefined to adjust spacing above and after the title.  They are
%   macros, not lengths, so they can be adjusted dynamically on the spot.
%    \begin{macrocode}
\newcommand{\notetitlebelowspace}{4mm}
\newcommand{\notetitletopspace}{-1.2cm}
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\notetitlehrule}
%   Allow customization of the horizontal rule below the title.  The macro
%   |\notetitlehrule| expands to commands which generate the rule, such as
%   ``|\hrule height 1pt|''.
%    \begin{macrocode}
\newcommand{\notetitlehrule}{\hrule}
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\notetitle@title}
%   Provide a ``long'' definition for |\title|, so that the title can have several
%   paragraphs.  Our style handles this by putting the title on several lines, and it can
%   be useful depending on how you want to format the title.
%
%   This macro will replace |\title| when a title style is actually selected in
%   |\phfnote@do@notetitle|.
%    \begin{macrocode}
\long\def\notetitle@title#1{\long\gdef\@title{#1}}
%    \end{macrocode}
% \end{macro}
% 
%
% \subsubsection{Implementation of \phfverb\thanks{} and \phfverb\thanksmark}
%
% Here we provide a few fixes for the implementation of |\thanks|, both for our main
% `default' title style as well as for other simpler styles.  Our implementation supports
% |\thanks[N]{...}| and |\thanksmark[N]| as for footnotes.
%
% These newer implementations are only applied if one of our title styles is
% set.  Otherwise, the class defaults are left untouched (which may be needed,
% e.g., for \RevTeX).
%
% \paragraph{Implementation of \phfverb{\thanks} and friends for our main
% `default' title style}
%
% \begin{macro}{\phfnote@setupthanksmpfootnote}
%   Internal---called at the beginning of a |minipage| environment, it sets up necessary
%   stuff to support |\thanks| notes within the minipage, in a single paragraph.
%
%   Some of this code was taken or really inspired directly from |latex.ltx|.
%    \begin{macrocode}
\def\phfnote@setupthanksmpfootnote{%
%    \end{macrocode}
% 
% The |\thanks| macro is implemented as a |\footnote| in a minipage.  So we hack into the
% `mpfootnote' mechanism.
%    \begin{macrocode}
  \def\thempfootnote{\arabic{mpfootnote}}%
  \let\footnoterule\relax%
  \let\thanks\footnote%
%    \end{macrocode}
%
% All footnote material is stored in a macro |\phfnote@mpfootmaterial|, initially
% empty:\footnote{NOTE: this differs from how footnotes are usually treated (directly
% typeset into a vbox I think).  Not sure what the side-effects might be.  Because this is
% just for simple email/institute info/etc. in the title, hopefully this shouldn't have
% any serious consequences.}
%    \begin{macrocode}
  \def\phfnote@mpfootmaterial{}%
%    \end{macrocode}
% and locally define |\@mpfootnotetext| to store the footnote content into that buffer,
%    \begin{macrocode}
  \long\def\@mpfootnotetext##1{%
    \protected@edef\@currentlabel%
         {\csname p@mpfootnote\endcsname\@thefnmark}%
    \protected@edef\@tmpa{\protect\phfnote@mympfootnotemark{\@thefnmark}{##1}%
      \protect\phfnote@mpfootnoteglue}%
    \expandafter\g@addto@macro\expandafter\phfnote@mpfootmaterial%
      \expandafter{\@tmpa}%
  }%
%    \end{macrocode}
% 
% Also provide |\thanksmark|, so that we can refer to other thanks/footnote-marks.
%    \begin{macrocode}
  \def\thanksmark[##1]{\phfnote@mympfootnotemark{##1}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\phfnote@finalizempfootnotes}
%   Macro to call at the end of a |minipage| environment, to ensure that all |\footnote|'s
%   (and thus |\thanks|'s) are properly formatted.
%
%   This simply takes all the tokens collected in |\phfnote@mpfootmaterial| (see just
%   above), and typesets it in the |\@mpfootins| box.  The latter is automatically typeset
%   by the minipage in |\end{minipage}|.
%
%   The argument |#1| is the skip length between the text and the footnotes.
%  \begin{macrocode}
\def\phfnote@finalizempfootnotes#1{%
  \if\relax\detokenize\expandafter{\phfnote@mpfootmaterial}\relax
  \else
    \global\skip\@mpfootins=#1\relax
    \global\setbox\@mpfootins=\vbox{%
      \parskip=\z@\relax
      \parindent=\z@\relax
      \phfnote@mpfootnotes@fontparsetup
      \noindent\leavevmode%
      \reset@font\footnotesize%
      \phfnote@fmt@titlefootnotes%
      \phfnote@mpfootmaterial}%
  \fi
}
%    \end{macrocode}
% \end{macro}
%
% \needspace{3\baselineskip}
% \begin{macro}{\phfnote@fmt@titlefootnotes}
% \begin{macro}{\phfnote@mympfootnotemark}
% \begin{macro}{\phfnote@mpfootnoteglue}
%   Some formatting utilities which can be overridden if you know what you're doing.
%   |\phfnote@fmt@titlefootnotes| allows you to override the font in which the
%   title-footnotes/thanks are typeset.  |\phfnote@mympfootnotemark| is responsible for
%   formatting its argument as a footnote mark, usually in superscript.
%   |\phfnote@mpfootnoteglue| is the glue which is used between two footnote texts (as
%   they are typeset in a single paragraph).
%    \begin{macrocode}
\def\phfnote@mpfootnotes@fontparsetup{%
  \parshape 1 0.04\textwidth 0.96\textwidth\relax}
\def\phfnote@fmt@titlefootnotes{}
\def\phfnote@mympfootnotemark#1{\@textsuperscript{\normalfont#1}}
\def\phfnote@mpfootnoteglue{\hskip 1.2em plus 2em minus 0.5em\relax}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% 
%
% \paragraph{For those not using the main `default' title style}
%
% We use \LaTeX's own |\thanks| mechanism, however we patch on the possibility for using
% |\thanks[N]{text}| and |\thanksmark[N]| for overriding the number which is used.
%
% \begin{macro}{\notetitle@thanksmark}
%   The |\thanksmark| is trivially implemented by |\footnotemark|.  Very handy indeed.
%
%   Again, this macro is only made available as |\thanksmark| when a title style is set in
%   |\phfnote@do@notetitle|.
%    \begin{macrocode}
\def\notetitle@thanksmark{\footnotemark}
%    \end{macrocode}
% \end{macro}
% 
% Start by saving the old |\thanks| macro, just in case.
%    \begin{macrocode}
\let\phfnote@old@thanks\thanks
%    \end{macrocode}
%
% \begin{macro}{\notetitle@thanks}
%   Now, we need to extend \LaTeX's |\thanks| to allow an optional argument as for
%   footnotes.  This macro will be renamed |\thanks| in |\phfnote@do@notetitle|.
%
%   Check whether there is an optional argument; if there is none we execute \LaTeX's
%   original thanks code (replicated here), otherwise, we specify the optional argument
%   explicitly at the relevant location in \LaTeX's implementation:
%    \begin{macrocode}
\def\notetitle@thanks{\@ifnextchar[\phfnote@thanks{\phfnote@thanks[]}}%]
\long\def\phfnote@thanks[#1]#2{%
  \if\relax\detokenize{#1}\relax%
%    \end{macrocode}
% 
% The optional argument is empty---just execute \LaTeX's original |\thanks| code,
% replicated here:
%    \begin{macrocode}
    \footnotemark%
    \protected@xdef\@thanks{\@thanks\protect\footnotetext[\the\c@footnote]{#2}}%
%    \end{macrocode}
% 
% Otherwise, execute \LaTeX's original |\thanks| code, but with the optional argument
% inserted wherever needed:
%    \begin{macrocode}
  \else% argument, pass on to sub-commands:
    \footnotemark[#1]%
    \protected@xdef\@thanks{\@thanks\protect\footnotetext[#1]{#2}}%
  \fi%
}
%    \end{macrocode}
% \end{macro}
% 
%
% \subsubsection{Title Styles Definition}
%
% The title styles are documented in \autoref{sec:title-styles}.
%
% 
% \paragraph{Title style: `default'}
%
% Implementation our main `default' title style.  See
% \autoref{sec:main-default-title-style}.
%
% \begin{macro}{\notetitleinnervsep}
%   Controls the vertical spacing between individual elements of the title.
%    \begin{macrocode}
\newcommand\notetitleinnervsep{1.15ex}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\notetitlewidth}
%   Controls the width of the area in which the title content is typeset.  For
%   more complex titles (e.g., |pretty| style, the title is typeset in a smaller
%   width than the text width to allow room for decorations).
%    \begin{macrocode}
\def\notetitlewidth{\textwidth}
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\notetitleparskip}
%   The paragraph skip that is used if the title contains multiple paragraphs.
%    \begin{macrocode}
\def\notetitleparskip{1.4ex}% parskip for multiple pars in main title
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\notetitlefontparsetup}
% \begin{macro}{\notetitleaftertitleskip}
%   |\notetitlefontparsetup| sets up any necessary \LaTeX{} commands to typeset
%   the main title.  This should set the font size, and then maybe |\centering|,
%   a |\parshape|, or a text color.
%    \begin{macrocode}
\def\notetitlefontparsetup{\raggedright\setstretch{1.05}\Large}
%    \end{macrocode}
%   |\notetitleaftertitleskip| generates the spacing after the main title.  The
%   default implementation behaves differently whether the title was
%   multi-paragraph or not.
%    \begin{macrocode}
\def\notetitleaftertitleskip{%
  \ifnotetitle@default@ismultipar
    \vspace{\parskip}%
    %\gdef\phfnote@tmp@nextskip{\z@}%
    \gdef\phfnote@tmp@nextskip{0.5\dimexpr\notetitleinnervsep\relax}%
  \else
    \gdef\phfnote@tmp@nextskip{\notetitleinnervsep}%
  \fi
}
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\notetitleauthorfontparsetup}
% \begin{macro}{\notetitledatefontparsetup}
%   These macros set up any necessary \LaTeX{} commands to typeset the author
%   and the date.  This should set the font size, and then maybe |\centering|, a
%   |\parshape|, or a text color.  These should use calls to
%   |\notetitledontextvskip| to adjust vertical spacing between the title items.
%    \begin{macrocode}
\def\notetitleauthorfontparsetup{%
  \notetitledonextvskip[2]%
  \parshape 1 0.04\textwidth 0.96\textwidth\relax
  \strut
}
\def\notetitledatefontparsetup{%
  \notetitledonextvskip
  \parshape 1 0.04\textwidth 0.96\textwidth\relax
  \strut
}
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\notetitledonextvskip}
%   This helper macro is not meant to be redefined, but rather invoked from
%   |\notetitleauthorfontparsetup| and |\notetitledatefontparsetup|.  It adds
%   the vertical space that was stored in |\phfnote@tmp@nextskip|.
%    \begin{macrocode}
\newcommand\notetitledonextvskip[1][]{%
  \vspace{#1\dimexpr\phfnote@tmp@nextskip\relax}%
  \gdef\phfnote@tmp@nextskip{\notetitleinnervsep}%
}
%    \end{macrocode}
% \end{macro} 
%
% \begin{macro}{\notetitlemakecontents}
%   Helper command that produces the content of the title.  The default
%   implementation uses the set |\title|, |\author|, and |\date| to render
%   everything nicely.  Note that if you redefine this, then it's up to you to
%   honor what to do with |\notetitlefontparsetup|, |\notetitlefont|,
%   |\notetitleauthorfont|, etc.
%
%   The default implementation of |\notetitlemakecontents| allows
%   |\notetitle*fontparsetup| to take a single argument, the whole
%   title/author/date including necessary formatting.  In that case make sure to
%   enclose that argument in a group.
%    \begin{macrocode}
\newcommand\notetitlemakecontents{
  \notetitlemakecontentstop
  {\par
    \let\phfnote@old@par\par
    \notetitle@titledefault@preparetitle
    \expandafter\notetitlefontparsetup\expandafter{%
      \expandafter\notetitlefont\expandafter{\@title}}%
    \phfnote@old@par
    \notetitleaftertitleskip
  }%
  \if\relax\detokenize\expandafter{\@author}\relax\else
    \expandafter\notetitleauthorfontparsetup\expandafter{%
      \expandafter\notetitleauthorfont\expandafter{\@author}}\par
  \fi
  \if\relax\detokenize\expandafter{\@date}\relax\else
    \expandafter\notetitledatefontparsetup\expandafter{%
      \expandafter\notetitledatefont\expandafter{\@date}}\par
  \fi
  \notetitlemakecontentsbottom
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\notetitlemakecontentstop}
% \begin{macro}{\notetitlemakecontentsbottom}
%   If you just want to insert stuff before/after in the title box, then you
%   don't have to redefine all of |\notetitlemakecontents|, you can simply
%   redefine these macros to whatever you like.
%    \begin{macrocode}
\def\notetitlemakecontentstop{}
\def\notetitlemakecontentsbottom{}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% 
% \begin{macro}{\notetitlebeginrender}
% \begin{macro}{\notetitleendrender}
%   The title is rendered enclosed by calls to these macros.  By default, render
%   the title in a minipage.
%
%   WARNING: An important thing to note is that if you use
%   |\notetitle@default@usesavebox|, then the saved box is an |\hbox|, not a
%   |\vbox| (more flexibility).  That means that the |\notetitlebeginrender| and
%   |\notetitleendrender| commands must open and close some environment (or a
%   |\vbox| or something like that) so that the whole
%   |\notetitlebeginrender...\notetitleendrender| construction results in
%   something that can be placed in an |\hbox|.
%    \begin{macrocode}
\def\notetitlebeginrender{\begin{minipage}{\notetitlewidth}}
\def\notetitleendrender{\end{minipage}}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% 
% 
% \begin{macro}{\notetitleusemainbox}
%   This macro is the main formatting command for the title's global appearance.
%   After the title is typeset in a \TeX{} box register, this macro is invoked
%   to actually display it.  The default title style simply displays it with a
%   rule below, but the |pretty| title style does fancier things.  Note this is
%   only used if |\ifnotetitle@default@usesavebox| is true.
%    \begin{macrocode}
\newcommand\notetitleusemainbox[1]{%
  \par
  \box#1%
  \vspace*{\notetitleinnervsep}%
  \notetitlehrule\relax
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\notetitle@default@mainbox}
%   The main box register in which the title contents is saved.
%    \begin{macrocode}
\newsavebox\notetitle@default@mainbox
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\ifnotetitle@default@usesavebox}
%   This |if| controls whether or not we set up the title in a temporary \TeX{}
%   box register first, before displaying it.  This allows to play around with
%   the box, measure its height/width, place it into graphics, etc.  But if we
%   want a simple title, this is not necessary, and it might break some more
%   fragile constructions (footnotes, etc).
%
%   If this is true, then the macro |\notetitleusemainbox| is called to render
%   the box.  Otherwise, |\notetitleusemainbox| is not called and the title is
%   rendered directly.
%    \begin{macrocode}
\newif\ifnotetitle@default@usesavebox
\notetitle@default@usesaveboxtrue
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\ifnotetitleusempfootnotes}
%   Whether any |\thanks| commands in the title generate footnotes inside the
%   minipage (i.e., a line at the bottom with e.g.\ affiliations), or whether
%   they appear as regular footnotes at the bottom of the page.
%
%   This conditional may only be set to true if the rendering happens in a
%   minipage.  The minipage must be opened in |\notetitlebeginrender| and closed
%   in |\notetitleendrender|.
%    \begin{macrocode}
\newif\ifnotetitleusempfootnotes
\notetitleusempfootnotestrue
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\notetitle@default@setup}
%   Any additional setup to be done at the beginning.
%    \begin{macrocode}
\def\notetitle@default@setup{%
    \notetitle@default@ismultiparfalse
    \gdef\phfnote@tmp@nextskip{\z@}%
    \par\raggedright}
%    \end{macrocode}
% \end{macro}
%
% Now we have the main implementation of the default title style.
%
% \begin{macro}{\notetitle@style@default}
%   A default title style, providing a flexible engine with powerful
%   customization features (the same engine is used for the |pretty| title
%   style).
%
%   The strategy goes like this: First typeset everything in a minipage enclosed
%   in a box register, and then display that box register using
%   |\notetitleusemainbox|.
%    \begin{macrocode}
\newcommand{\notetitle@style@default}{%
  \begingroup
    \parskip=\z@\relax
    \parindent=\z@\relax
    \providecommand\singlespace{}%
    \notetitle@default@setup
    \ifnotetitleusempfootnotes
      \phfnote@setupthanksmpfootnote
    \fi
    \vspace*{\notetitletopspace}%
    \def\x{}%
%    \end{macrocode}
% 
% Now, draw the title (either in a box, or directly).  If we save in a box, use
% an |\hbox|, not a |\vbox|, because we get size problems otherwise.  See
% |\notetitlebeginrender| and |\notetitleendrender|.
%    \begin{macrocode}
    \ifnotetitle@default@usesavebox
      \def\x{\setbox\notetitle@default@mainbox=\hbox\bgroup}
    \fi
    \x\notetitlebeginrender
    \begingroup
          \singlespace%
          \notetitlemakecontents\par
          \ifnotetitleusempfootnotes
            \expandafter\ifstrequal\expandafter{\@mpfn}{mpfootnote}{}{%
              \PackageError{phfnote}{phfnote title: can only have
                'usempfootnotes' in a minipage}{Make sure you open a
                \string\begin{minipage} in the definition of
                  \string\notetitlebeginrender \space and correspondingly close
                  it with \string\end{minipage} in \string\notetitleendrender}%
            }
            \global\let\@thanks\@empty
            \phfnote@finalizempfootnotes{\phfnote@tmp@nextskip}%
          \fi
    \endgroup
    \notetitleendrender
    \def\x{}%
    \ifnotetitle@default@usesavebox
      \def\x{\egroup
        \notetitleusemainbox{\notetitle@default@mainbox}}%
    \fi
    \x
    \par
  \endgroup
  \vskip\notetitlebelowspace\relax% don't change this, abstract needs to \removelastskip
}
%    \end{macrocode}
% \end{macro}
%
%
% Some helpers for the default title style.
%
% \begin{macro}{\ifnotetitle@default@ismultipar}
%   This flag registers whether or not the title has multiple paragraphs (and
%   thus renders on several spaced lines).  It is set to |true| by redefining
%   the |\par| command in the title (see |\notetitle@titledefault@preparetitle|
%   below).
%    \begin{macrocode}
\newif\ifnotetitle@default@ismultipar
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\notetitle@titledefault@preparetitle}
%   This helper sets everything up to display the title.  It redefines |\par| to
%   register that the title has several paragraphs.  Also, note that |\parskip|
%   is inserted in |\leavevmode|, so that setting |\parskip| as below only
%   affects subsequent paragraphs.
%
%   To change the parskip amount, you may simply patch this command, e.g., as
%   |\appto\notetitle@titledefault@preparetitle{\parskip=1.2ex\relax}|.
%    \begin{macrocode}
\newcommand\notetitle@titledefault@preparetitle{%
  \def\par{\phfnote@old@par\global\notetitle@default@ismultipartrue}%
  \leavevmode\parskip=\notetitleparskip\relax}
%    \end{macrocode}
% \end{macro}
%
%
%
% \paragraph{Title style: `defaultv1'}
%
% \begin{macro}{\notetitle@style@defaultv1}
%   The default title style, copied from \pkgname{phfnote} v1.0.  DO NOT
%   CHANGE.  Kept only for backwards compatibility, in case someone had spent
%   lots of time fine-tuning their title and patching the v1 of this package, or
%   if they want the document to appear exactly as the v1 of the package.
%
%   [We need to use |\csdef| because of the ``1'' in the title name, which is
%   not valid in an \TeX{} usual escape sequence (!!)]
%    \begin{macrocode}
\csdef{notetitle@style@defaultv1}{%
  \begingroup\par\raggedright%
    \phfnote@setupthanksmpfootnote%
    \vspace*{\notetitletopspace}%
    \phfnote@title@checksetspace{defaultv1}%
    \begin{minipage}{\textwidth}%
      \begin{singlespace}%
        \parskip=0pt\parindent=0pt\relax%
        {\let\phfnote@old@par\par%
          \def\par{\phfnote@old@par%
            \parskip=1.5ex\relax\parshape 1 0pt \textwidth\relax%
            \noindent}%
          \par%
          \Large  {\notetitlefont \@title}\par}%
        \vskip 2mm\relax
        \if\relax\detokenize\expandafter{\@author}\relax\else%
          \par\parshape 1 0.04\textwidth 0.96\textwidth\relax%
          {\notetitleauthorfont \@author}%
          \vskip 2mm\relax%
        \fi
        \if\relax\detokenize\expandafter{\@date}\relax\else%
          \par\parshape 1 0.04\textwidth 0.96\textwidth\relax%
          {\notetitledatefont \@date}
          \vskip 2mm\relax%
        \fi
        \global\let\@thanks\@empty%
        \csname phfnote@finalizempfootnotes@v1\endcsname%
      \end{singlespace}%
    \end{minipage}\par%
    \vspace*{2mm}%
    \notetitlehrule\relax%
    \par%
  \endgroup%
  \vskip\notetitlebelowspace\relax% don't change this, abstract needs to \removelastskip
}
\csdef{phfnote@finalizempfootnotes@v1}{%
  \global\setbox\@mpfootins=\vbox{%
    \parskip=0pt\parindent=0pt\parshape 1 0.04\textwidth 0.96\textwidth\relax%
    \noindent\leavevmode%
    \reset@font\footnotesize%
    \phfnote@fmt@titlefootnotes%
    \phfnote@mpfootmaterial}%
}
\def\phfnote@title@checksetspace#1{%
  \ifdefined\singlespace\else%
    \PackageError{phfnote}{Note title style `#1' requires the
      `setspace' package to be loaded!  Please load it, or use a
      pkgset which loads it automatically}{}%
  \fi%
}
%    \end{macrocode}
% \end{macro}
%
%
% \paragraph{Title style: `pretty' and `pretty2'}
%
% The |pretty| \& |pretty2| styles uses the same engine as the default, with
% different settings.
%
% \begin{macro}{\notetitle@style@pretty}
% \begin{macro}{\notetitle@style@pretty2}
%   Alias the main maketitle engine to the default one.
%    \begin{macrocode}
\let\notetitle@style@pretty\notetitle@style@default
\cslet{notetitle@style@pretty2}\notetitle@style@default
%    \end{macrocode}
% \end{macro}
% \end{macro}
% 
% \begin{macro}{\notetitle@stylesetup@pretty}
%   Setup macro that makes everything nice.  Do all these defs in the macro
%   definition, and not directly in the global space, to avoid polluting the
%   \LaTeX{} environment with useless definitions if we don't use this title
%   style.
%    \begin{macrocode}
\def\notetitle@stylesetup@pretty{%
  \RequirePackage{xcolor}
  \long\def\notetitlefont##1{\bfseries ##1}
  \def\notetitlefontparsetup{%
    \color{notetitleprettytextcolor}\centering}
  \def\notetitleauthorfontparsetup{%
    \notetitledonextvskip[2]%
    \color{notetitleprettytextcolor}\centering}
  \def\notetitledatefontparsetup{%
    \notetitledonextvskip
    \color{notetitleprettytextcolor}\centering}
  \def\phfnote@mpfootnotes@fontparsetup{\color{notetitleprettytextcolor}}
  %
  \def\notetitlewidth{\dimexpr\textwidth
    -\notetitleprettylsiderulewidth
    -\notetitleprettyrsiderulewidth
    -\notetitleprettylsidespacewidth
    -\notetitleprettyrsidespacewidth\relax}
  \let\notetitleusemainbox\notetitle@pretty@usemainbox
  %
  \def\notetitleprettylsiderulewidth{10pt}
  \def\notetitleprettylsidespacewidth{10pt}
  \def\notetitleprettyrsiderulewidth{10pt}
  \def\notetitleprettyrsidespacewidth{10pt}
  \def\notetitleprettytopspace{10pt}
  \def\notetitleprettybottomspace{10pt}
  \def\notetitleprettytophrulewidth{0pt}
  \def\notetitleprettybottomhrulewidth{0pt}
  %
  \definecolor{notetitleprettylsiderulecolor}{RGB}{0,68,126}
  \colorlet{notetitleprettyrsiderulecolor}{notetitleprettylsiderulecolor}
  \colorlet{notetitleprettytophrulecolor}{notetitleprettylsiderulecolor}
  \colorlet{notetitleprettybottomhrulecolor}{notetitleprettylsiderulecolor}
  \definecolor{notetitleprettytextcolor}{RGB}{25,25,38}
  \colorlet{notetitleprettybgcolor}{white}
}
\newlength\notetitle@pretty@tmplenht
\newlength\notetitle@pretty@tmplendp
\def\notetitle@pretty@usemainbox#1{%
  \parskip=\z@\relax
  \parindent=\z@\relax
  \notetitle@pretty@tmplenht=\ht#1\relax%
  \notetitle@pretty@tmplendp=\dp#1\relax%
  \edef\tmp@dorule##1##2{%
    {\noexpand\color{notetitlepretty##1siderulecolor}%
      \noexpand\rule{##2}{%
        \dimexpr \notetitleprettytopspace+
            \notetitleprettybottomspace+
            \notetitleprettytophrulewidth+
            \notetitleprettybottomhrulewidth+
            \notetitle@pretty@tmplendp+
            \notetitle@pretty@tmplenht\relax}}}%
  \fboxsep=0pt% for \colorbox
  \par\hbox to \textwidth{%
    \hskip 0pt plus 0.1fil minus 0.1fil\relax%
    \tmp@dorule{l}{\notetitleprettylsiderulewidth}%
    \colorbox{notetitleprettybgcolor}{%
      \vbox{%
        {\color{notetitleprettytophrulecolor}%
          \hrule height \notetitleprettytophrulewidth\relax}%
        \hbox{%
          \hskip \notetitleprettylsidespacewidth\relax
          % \fbox% DEBUG
          {\vbox{\vskip \notetitleprettytopspace\relax
              \box#1%
              \vskip \notetitleprettybottomspace\relax}}%
          \hskip \notetitleprettyrsidespacewidth\relax
        }%
        {\color{notetitleprettybottomhrulecolor}%
          \hrule height \notetitleprettybottomhrulewidth\relax}%
      }}%
    \tmp@dorule{r}{\notetitleprettyrsiderulewidth}%
  \hskip 0pt plus 0.1fil minus 0.1fil\relax}%
  \par%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\notetitle@stylesetup@pretty2}
%   The |pretty2| style simply loads the |pretty| style, and ajusts some
%   settings.
%    \begin{macrocode}
\csdef{notetitle@stylesetup@pretty2}{%
  \notetitle@stylesetup@pretty
  %
  \definecolor{notetitleprettylsiderulecolor}{RGB}{0,68,126}
  \colorlet{notetitleprettyrsiderulecolor}{notetitleprettylsiderulecolor}
  \colorlet{notetitleprettytophrulecolor}{notetitleprettylsiderulecolor}
  \colorlet{notetitleprettybottomhrulecolor}{notetitleprettylsiderulecolor}
  \colorlet{notetitleprettytextcolor}{notetitleprettylsiderulecolor!50!black}
  \colorlet{notetitleprettybgcolor}{white!95!notetitleprettytextcolor}
  %
  \def\notetitleprettytophrulewidth{.4pt}
  \def\notetitleprettybottomhrulewidth{.4pt}
}
%    \end{macrocode}
% \end{macro}
% 
%
%
% \paragraph{Title style: `small'}
%
% Implementation an alternate `small' title style.
%
% \begin{macro}{\notetitle@style@small}
%    The small title style. Again, use the main title engine, but customize the settings.
%    \begin{macrocode}
\let\notetitle@style@small\notetitle@style@default
\newcommand\notetitle@stylesetup@small{%
  \notetitleusempfootnotesfalse
  %
  \def\notetitlemakecontents{%
    {\expandafter\notetitlefont\expandafter{\@title}}%
    \hfill\makebox{\fontsize{9pt}{10pt}\selectfont
      \notetitle@small@renderauthordate}%
  }
  %\notetitle@default@usesaveboxfalse
  %\def\notetitlebeginrender{\par}
  %\def\notetitleendrender{%
  %  \vspace*{\notetitleinnervsep}\notetitlehrule\relax\vspace*{\notetitleinnervsep}}
  \def\notetitleusemainbox##1{%
    \par\box##1%
    \vspace*{\notetitleinnervsep}\notetitlehrule\relax\vspace*{\notetitleinnervsep}}
  \def\notetitle@small@renderauthordate{%
    \expandafter\notblank\expandafter{\@author}{%
      \expandafter\notblank\expandafter{\@date}{% both not blank
        {\expandafter\notetitleauthorfont\expandafter{\@author}}%
        \notetitlesmallauthordatesep
        {\emph{\expandafter\notetitledatefont\expandafter{\@date}}}%
      }{% only author
        {\expandafter\notetitleauthorfont\expandafter{\@author}}%
      }%
    }{% only date
      {\emph{\expandafter\notetitledatefont\expandafter{\@date}}}%
    }}
  %
  \def\notetitleinnervsep{1mm}
  \def\notetitlesmallauthordatesep{\hspace*{2mm}--\hspace*{2mm}}
}
%    \end{macrocode}
% \end{macro}
% 
% Style |smallv1| provided for backwards compatibility, to make sure that all
% spacing and formatting is exactly the same as for \pkgname{phfnote} version
% 1.0.
%    \begin{macrocode}
\csdef{notetitle@style@smallv1}{%
  \begingroup\par\raggedright%
    \let\footnote\thanks%
    \vspace*{\notetitletopspace}%
    {\expandafter\notetitlefont\expandafter{\@title}}%
    \hfill\makebox{\fontsize{9pt}{10pt}\selectfont
      {\expandafter\notetitleauthorfont\expandafter{\@author}}%
      \hspace*{2mm}--\hspace*{2mm}{\emph{\expandafter\notetitledatefont\expandafter{\@date}}}}%
    \vspace*{1mm}\notetitlehrule\relax\vspace*{1mm}%
    \par%
  \endgroup%
  \vskip\notetitlebelowspace\relax% don't change this, abstract needs to \removelastskip
}
%    \end{macrocode}
%
% 
% \paragraph{Title style: `article'}
%
% Implementation the `article' title style.
%
% \begin{macro}{\notetitle@style@article}
% \begin{macro}{\notetitle@stylesetup@article}
%   Technical note. Here, by using a |tabular| environment for authors, we need
%   to assume that the macro |\notetitleauthorfont| takes one argument and does
%   not leave the author contents surrounded with full braces.  This would cause
%   `|\\|' tokens enclosed in the protective braces to cause errors in the
%   tabular environment.
%
%    \begin{macrocode}
\let\notetitle@style@article\notetitle@style@default
\newcommand{\notetitle@stylesetup@article}{
  %\def\notetitletopspace{-3em}
  \def\notetitlebottomspace{2.5em}
  \def\notetitleinnervsep{1.5em}
  \def\notetitlefont{}
  \def\notetitlefontparsetup{%
    \LARGE\centering}
  \long\def\notetitleauthorfontparsetup##1{%
    \notetitledonextvskip%
    {\large\centering
    \lineskip .5em\relax%
    \begin{tabular}[t]{c}%
      ##1%
    \end{tabular}\par}}
  \long\def\notetitleauthorfont##1{\large ##1}
  \def\notetitledatefontparsetup{%
    \notetitledonextvskip
    \centering}
  \def\phfnote@mpfootnotes@fontparsetup{}
  \def\notetitleusemainbox##1{%
    \par
    \box##1%
  }
  \appto\notetitle@default@setup{%
    %\def\singlespace{}%
  }
  %
  \notetitleusempfootnotesfalse
}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% 
%
% \begin{macro}{\notetitle@style@articlev1}
%    Backwards compatibility style |articlev1|.
%    \begin{macrocode}
\csdef{notetitle@style@articlev1}{%
  \vspace*{-3em}%
  \begingroup
    \centering
    \let\footnote\thanks%
    {\LARGE \@title \par}%
    \vskip 1.5em%
    {\large%
      \lineskip .5em%
      \begin{tabular}[t]{c}%
        \@author%
      \end{tabular}\par}%
    \vskip 1.5em%
    {\large \@date}%
    \par%
  \endgroup%
  \par%
  \vskip 2.5em\relax%
}
%    \end{macrocode}
% \end{macro}
% 
% \subsubsection{Plugging into \phfverb{\maketitle}}
%
% Actually perform the definitions to make |\maketitle| produce the title with
% the given style.  Specifically, we override |\@maketitle|. The latter is
% called internally by |\maketitle|, and the advantage of overriding
% |\@maketitle| only is that we inherit the mechanism provided by the original
% class (e.g., |article|) to deal with two-column layouts.
%
% \begin{macro}{\phfnote@do@notetitle}
%   This macro takes care of installing the correct title into the
%   document, by overriding |\@maketitle|.
%
%   This macro is called later after processing the package options.
%   Its argument |#1| is the style name, e.g., |default|.
%
%    \begin{macrocode}
\def\phfnote@do@notetitle#1{
%    \end{macrocode}
% If we have the title style |false|, or an empty title style, then we leave
% default title provided by the class.
%    \begin{macrocode}
  \ifstrequal{#1}{false}{}{%
    \if\relax\detokenize\expandafter{#1}\relax
    \else
%    \end{macrocode}
% Otherwise, we have a title style to set.  Do some checks that the given style is indeed
% defined.
%    \begin{macrocode}
      \ifcsname notetitle@style@#1\endcsname
        \def\phfnote@tmp@titsty{#1}%
      \else
        \PackageError{phfnote}{Unknown title style: '#1'.}{Unknown title
          style: '#1'. Please consult the package documentation for available
          styles.}
        \def\phfnote@tmp@titsty{default}%
      \fi
%    \end{macrocode}
% Apply new (default) definitions of |\thanks|, |\thanksmark| and |\title|.  Do this here
% only, because this can clash with more complicated versions from, e.g., \RevTeX.
%    \begin{macrocode}
      \let\title\notetitle@title
      \let\thanks\notetitle@thanks
      \let\thanksmark\notetitle@thanksmark
%    \end{macrocode}
% Also, LaTeX initializes |\@author| with code that generates a warning that no
% author is given.  We don't want that.  It's perfectly fine not to have an
% author, and in this case this must be empty so that our title routines can
% properly handle this case.
%    \begin{macrocode}
      \def\@author{}%
%    \end{macrocode}
% Now, actually overload the title style by redefining |\@maketitle|.  Also, if
% the style defines a ``setup'' macro |\notetitle@stylesetup@...|, then we
% invoke it.
%    \begin{macrocode}
      \ifcsname notetitle@stylesetup@\phfnote@tmp@titsty\endcsname
        \csname notetitle@stylesetup@\phfnote@tmp@titsty\endcsname
      \fi
      \def\@maketitle{\csname notetitle@style@\phfnote@tmp@titsty\endcsname}%
    \fi
  }%
}
%    \end{macrocode}
% \end{macro}
%
%
%
% \subsection{Abstract}
%
% Now we can take care of the abstract.  Unlike the title styles, the abstract has a base
% implementation.  Then, we may have attributes which change some parameters.
%
% 
% \begin{environment}{notedefaultabstract}
%   First, save the old environment |\begin{abstract}...\end{abstract}| provided by the
%   class (if any).
%    \begin{macrocode}
\let\notedefaultabstract\abstract
\let\endnotedefaultabstract\endabstract
%    \end{macrocode}
% \end{environment}
%
% \begin{macro}{\noteabstracttextfont}
% \begin{macro}{\noteabstractnamefont}
% \begin{macro}{\noteabstracttextwidth}
% \begin{macro}{\noteabstractafterspacing}
% \begin{macro}{\noteabstractbeforepacing}
%   Macros which can be overridden to customize the abstract.  See
%   \autoref{sec:abstract-attributes}.
%    \begin{macrocode}
\newcommand{\noteabstracttextfont}{}
\newcommand{\noteabstractnamefont}{\bfseries\small}
\if@twocolumn
  \newcommand\noteabstracttextwidth{\hsize}
\else
  \newcommand{\noteabstracttextwidth}{0.9\hsize}
\fi
\newcommand\noteabstractafterspacing{1.5em}
\newcommand\noteabstractbeforespacing{1.5em}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% 
% \begin{macro}{\noteabstract@nameline}
%   Create the line which contains the title of the abstract, that is, the word
%   ``Abstract.''  This can be overloaded, of course, for customization.
%    \begin{macrocode}
\def\noteabstract@nameline{
  {\parskip=0pt\relax\par\centering\noteabstractnamefont%
    \abstractname%
    \par}\vskip 1ex\relax%
}
%    \end{macrocode}
% \end{macro}
% 
% \begin{environment}{noteabstract}
%   The proper |noteabstract| environment.
%
%    \begin{macrocode}
\newenvironment{noteabstract}{%
  \removelastskip%
  \vspace{\noteabstractbeforespacing}%
  \begingroup%
    \par\noindent\centering%
    \begin{minipage}{\noteabstracttextwidth}%
      \noteabstract@nameline%
      \noteabstracttextfont%
    }%
    {%
    \end{minipage}%
    \par%
  \endgroup%
  \vspace{\noteabstractafterspacing}%
}
%    \end{macrocode}
% \end{environment}
% 
% The abstract can be customized by the attributes.  Here we define them:
%    \begin{macrocode}
\def\noteabstract@attr@wide{%
  \def\noteabstracttextwidth{\textwidth}%
}
\def\noteabstract@attr@narrow{%
  \if@twocolumn
  \else
    \def\noteabstracttextwidth{0.8\textwidth}%
  \fi
}
\def\noteabstract@attr@noname{%
  \def\noteabstract@nameline{}%\vspace*{1ex}}%
}
\def\noteabstract@attr@original{%
  \let\abstract\notedefaultabstract
  \let\endabstract\endnotedefaultabstract
}
\def\noteabstract@attr@small{%
  \g@addto@macro\noteabstracttextfont{\small}%
}
\def\noteabstract@attr@compact{%
  \renewcommand\noteabstractafterspacing{1ex}%
  \renewcommand\noteabstractbeforespacing{1ex}%
}
\def\noteabstract@attr@it{%
  \g@addto@macro\noteabstracttextfont{\itshape}%
}
%    \end{macrocode}
% 
% \begin{macro}{\phfnote@do@noteabstract}
%   This helper both defines the |abstract| environment, and also sets the abstract
%   attributes.  This macro will be called according to the package options.
%
%  |#1| = a comma-separated list of attributes, or the string |false|.
%    \begin{macrocode}
\def\phfnote@do@noteabstract#1{%
  \ifstrequal{#1}{false}{}{%
    \let\abstract\noteabstract
    \let\endabstract\endnoteabstract
    \phfnote@internal@execattribs{noteabstract@attr@}{abstract attribute}{#1}
  }%
}
%    \end{macrocode}
% \end{macro}
% 
%
%
% \subsection{Page Geometry Settings}
%
% For the page geometry settings, we just have a bunch of styles which we define as
% macros.  The macros just set up |\PassOptionsToPackage| for the \pkgname{geometry} package.
% Then the correct macro will be selected according to the current \pkgname{phfnote} package
% options.
%
% The description of these settings are given in \autoref{sec:pagegeomdefs}.
%
% \begin{macro}{\phfnote@pagegeomstyle@default}
%   Default setting.
%    \begin{macrocode}
\def\phfnote@pagegeomstyle@default{
  \if@twocolumn
    \PassOptionsToPackage{hmargin=1in,vmargin=0.75in,includeheadfoot}{geometry}%
  \else
    % fix the margins a bit to make text wider
    \ifcase\@ptsize% mods for 10 pt
      \PassOptionsToPackage{hmargin=1.5in,vmargin=1.25in}{geometry}%
    \or% mods for 11 pt
      \PassOptionsToPackage{hmargin=1.5in,vmargin=1.25in}{geometry}%
    \or% mods for 12 pt
      \PassOptionsToPackage{hmargin=1.25in,vmargin=1.25in}{geometry}%
    \fi%
  \fi
}
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\phfnote@pagegeomstyle@narrow}
%   Narrow style.
%    \begin{macrocode}
\def\phfnote@pagegeomstyle@narrow{
  \if@twocolumn
    \PassOptionsToPackage{hmargin=1.25in,vmargin=0.75in,includeheadfoot}{geometry}%
  \else
    % fix the margins a bit to make text wider
    \ifcase\@ptsize% mods for 10 pt
      \PassOptionsToPackage{hmargin=1.75in,vmargin=1.5in}{geometry}%
    \or% mods for 11 pt
      \PassOptionsToPackage{hmargin=1.75in,vmargin=1.5in}{geometry}%
    \or% mods for 12 pt
      \PassOptionsToPackage{hmargin=1.5in,vmargin=1.5in}{geometry}%
    \fi%
  \fi
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\phfnote@pagegeomstyle@wide}
%   Wide style.
%    \begin{macrocode}
\def\phfnote@pagegeomstyle@wide{
  \if@twocolumn
    \PassOptionsToPackage{hmargin=0.75in,vmargin=0.75in,includeheadfoot}{geometry}%
  \else
    % fix the margins a bit to make text wider
    \ifcase\@ptsize% mods for 10 pt
      \PassOptionsToPackage{hmargin=1.25in,vmargin=1.25in}{geometry}%
    \or% mods for 11 pt
      \PassOptionsToPackage{hmargin=1.25in,vmargin=1.25in}{geometry}%
    \or% mods for 12 pt
      \PassOptionsToPackage{hmargin=1in,vmargin=1.25in}{geometry}%
    \fi%
  \fi
}
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\phfnote@pagegeomstyle@xwide}
%   Extra wide.
%
%   \changedreftext{chg-pagegeom-xwide}
%    \begin{macrocode}
\def\phfnote@pagegeomstyle@xwide{
  \if@twocolumn
    \PassOptionsToPackage{hmargin=0.5in,vmargin=0.5in,includeheadfoot}{geometry}%
  \else
    % fix the margins a bit to make text wider
    \ifcase\@ptsize% mods for 10 pt
      \PassOptionsToPackage{hmargin=1in,vmargin=1in}{geometry}%
    \or% mods for 11 pt
      \PassOptionsToPackage{hmargin=1in,vmargin=1in}{geometry}%
    \or% mods for 12 pt
      \PassOptionsToPackage{hmargin=0.75in,vmargin=1in}{geometry}%
    \fi%
  \fi
}
\csdef{phfnote@pagegeomstyle@xwidev1}{
  \if@twocolumn
    \PassOptionsToPackage{hmargin=0.5in,vmargin=0.5in,includeheadfoot}{geometry}%
  \else
    % fix the margins a bit to make text wider
    \ifcase\@ptsize% mods for 10 pt
      \PassOptionsToPackage{hmargin=1in,vmargin=1.25in}{geometry}%
    \or% mods for 11 pt
      \PassOptionsToPackage{hmargin=1in,vmargin=1.25in}{geometry}%
    \or% mods for 12 pt
      \PassOptionsToPackage{hmargin=0.75in,vmargin=1.25in}{geometry}%
    \fi%
  \fi
}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\phfnote@pagegeomstyle@bigmargin}
%   |bigmargin| style.
%    \begin{macrocode}
\def\phfnote@pagegeomstyle@bigmargin{%
  \if@twocolumn
    \PassOptionsToPackage{hmargin=1.5in,vmargin=0.75in,includeheadfoot}{geometry}%
  \else
    % fix the margins a bit to make text wider
    \ifcase\@ptsize% mods for 10 pt
      \PassOptionsToPackage{hmargin={2.25in,1.75in},vmargin=1.25in}{geometry}%
    \or% mods for 11 pt
      \PassOptionsToPackage{hmargin={2.25in,1.75in},vmargin=1.25in}{geometry}%
    \or% mods for 12 pt
      \PassOptionsToPackage{hmargin={2in,1.5in},vmargin=1.25in}{geometry}%
    \fi%
  \fi
}
%    \end{macrocode}
% \end{macro}
% 
% 
% \begin{macro}{\phfnote@do@pagegeom}
%   Finally, provide a helper to set the page geometry.  Just call the right
%   macro.  If the argument is |false|, don't do anything.
%    \begin{macrocode}
\newcommand{\phfnote@do@pagegeom}[1]{
  \ifstrequal{#1}{false}{}{%
    \message{phfnote: Setting page geometry style #1}%
    \ifcsname phfnote@pagegeomstyle@#1\endcsname
      \csname phfnote@pagegeomstyle@#1\endcsname
    \else
      \PackageWarning{phfnote}{Unknown page geometry style: `#1'!}%
    \fi
    %
    \RequirePackage{geometry}%
  }%
}
%    \end{macrocode}
% \end{macro}
%
%
% \subsection{Text, Paragraph and Line Spacing}
%
% \paragraph{Text \& Line Spacing}
%
% \begin{macro}{\phfnote@do@spacing}
%   Some cosmetic definitions to adjust line spacing.  The line spacing is slightly
%   adjusted according to font size to make the document more readable.  Depending on
%   whether the \pkgname{setspace} package is loaded, we use it or go low-level with a
%   redefinition of \LaTeX{}' |\baselinestretch|.  If the \pkgname{captions} package is loaded,
%   the figure captions' line spacing is also adjusted.
%   
%   Also set an |\emergencystretch| so that lines get spaced out for underfull boxes,
%   rather than overflowing far into the margin.
%    \begin{macrocode}
\def\phfnote@do@spacingdefs#1{
  \ifstrequal{#1}{false}{}{%
    \@ifpackageloaded{setspace}{
      \def\phfnote@dostretch##1{%
        \setstretch{##1}\phfnote@docaptionstretch{##1}}
    }{
      \def\phfnote@dostretch##1{%
        \renewcommand\baselinestretch{##1}\phfnote@docaptionstretch{##1}}
    }
    \@ifpackageloaded{caption}{
      \def\phfnote@docaptionstretch##1{\captionsetup{font={stretch=##1}}}
    }{
      \def\phfnote@docaptionstretch##1{\PackageWarning{phfnote}{Can't
          set line spacing for captions, because the package `caption'
          is not loaded.  Please load it before `phfnote', or use an
          appropriate pkgset (e.g. `rich') which loads this package
          automatically.}}
    }
    \if@twocolumn
      \phfnote@dostretch{1.0} % leave default
      \emergencystretch=3em\relax
    \else
      \ifcase\@ptsize% 10pt
        \phfnote@dostretch{1.1}
      \or% 11pt
        \phfnote@dostretch{1.0} % 1.05? better 1.0...
      \or% 12pt
        \phfnote@dostretch{1.0} % 1.03? not really noticeable...
      \fi
      \emergencystretch=6em\relax
    \fi
  }
}
%    \end{macrocode}
% \end{macro}
% 
%
% \paragraph{Paragraph Spacing Presets}
%
% Here again, we define several possibilities for paragraph settings as
% individual macros (see \autoref{sec:par-defs}).  Depending on the package
% option, we execute the corresponding macro.
%
%    \begin{macrocode}
\def\phfnote@par@original{%
}
\def\phfnote@par@indent{%
  \parindent=1.5em\relax
  \parskip=0pt\relax
}
\def\phfnote@par@indentminiskip{%
  \parindent=1.5em\relax
  \parskip=0.3em plus 0.1em\relax
}
\def\phfnote@par@skip{%
  \parindent=0pt\relax
  \parskip=0.8em plus 0.2em minus 0.1em\relax
}
%    \end{macrocode}
% 
% \begin{macro}{\phfnote@do@par}
%   Execute the given paragraph setting.  The argument |#1| is the setting, for example,
%   |skip|.
%    \begin{macrocode}
\def\phfnote@do@par#1{%
  \ifstrequal{#1}{false}{}{%
    \ifcsname phfnote@par@#1\endcsname
      \csname phfnote@par@#1\endcsname
    \else
      \PackageWarning{phfnote}{Bad paragraph setting: #1. Leaving original}
    \fi
  }
}
%    \end{macrocode}
% \end{macro}
% 
%
%
%
% \subsection{Section Styling}
%
% Very limited support for styling section and paragraph headers
% (\autoref{sec:secfmt}).  If you want anything serious, use \pkgname{sectsty} or
% \pkgname{titlesec} directly.
%
% \begin{macro}{\notesectionallfont}
% \begin{macro}{\notesectionallfontfamily}
%   Define the |\notesectionallfont| and |\notesectionallfontfamily|, which
%   control the general font used in section headings.
%    \begin{macrocode}
\newcommand{\notesectionallfont}{%
  \fontfamily{\notesectionallfontfamily}\fontseries{bx}\selectfont}
\newcommand{\notesectionallfontfamily}{ppl}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% 
%
% \begin{macro}{\notesectionfont}
% \begin{macro}{\notesubsectionfont}
% \begin{macro}{\notesubsubsectionfont}
% \begin{macro}{\noteparagraphfont}
% \begin{macro}{\notesubparagraphfont}
%   These macros are called for their respective sectioning command,
%   after |\notesectionallfont| has been invoked. (Again, only for
%   those sectioning commands which are styled by us.)
%
%    \begin{macrocode}
\newcommand{\notesectionfont}{\large}
\newcommand{\notesubsectionfont}{\normalsize}
\newcommand{\notesubsubsectionfont}{\small}
\newcommand{\noteparagraphfont}{\normalsize}
\newcommand{\notesubparagraphfont}{\normalsize}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% 
%
% \begin{macro}{\notesectionsetfonts}
% \begin{macro}{\noteparagraphsetfonts}
%   Helpers to directly set the font commands for |\section|,
%   |\subsection| and |\subsubsection| (with |\notesectionsetfonts|),
%   and for |\paragraph| and |\subparagraph| (with |\noteparagraphsetfonts|).
%    \begin{macrocode}
\newcommand{\notesectionsetfonts}[3]{%
  \renewcommand{\notesectionfont}{#1}%
  \renewcommand{\notesubsectionfont}{#2}%
  \renewcommand{\notesubsubsectionfont}{#3}%
}
\newcommand{\noteparagraphsetfonts}[2]{%
  \renewcommand{\noteparagraphfont}{#1}%
  \renewcommand{\notesubparagraphfont}{#2}%
}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% 
%
% Define the attributes which the user can set.  See
% \autoref{sec:secfmt}.
%
%    \begin{macrocode}
\def\phfnote@do@secfmt@section{
  \RequirePackage{sectsty}
  \sectionfont{\notesectionallfont\notesectionfont}
  \subsectionfont{\notesectionallfont\notesubsectionfont}
  \subsubsectionfont{\notesectionallfont\notesubsubsectionfont}
}
\def\phfnote@do@secfmt@paragraph{
  \RequirePackage{sectsty}
  \paragraphfont{\notesectionallfont\noteparagraphfont}
  \subparagraphfont{\notesectionallfont\notesubparagraphfont}
}
\def\phfnote@do@secfmt@compact{
  \notesectionsetfonts{\normalsize}{\small}{\small}
}
\def\phfnote@do@secfmt@larger{
  \notesectionsetfonts{\Large}{\large}{\normalsize}
}

\def\phfnote@do@secfmt@secsquares{
  \RequirePackage{amssymb}
  \let\phfnote@secsquares@old@seccntformat\@seccntformat
  \def\@seccntformat##1{%
    \expandafter\ifx\csname ##1\endcsname\section\relax%
    \unexpanded{\makebox[0pt][r]{\raisebox{0.15ex}{{%
            \notesmaller[0.6]\ensuremath{\blacksquare}}}%
        \hspace*{1.2ex}}}%
    \fi%
    \phfnote@secsquares@old@seccntformat{##1}}
}
\def\phfnote@do@secfmt@secnummargin{
  \let\phfnote@secnummargin@old@seccntformat\@seccntformat
  \def\@seccntformat##1{%
    \protect\makebox[0pt][r]{\phfnote@secnummargin@old@seccntformat{##1}}}
}

\def\phfnote@do@secfmt@rmfamily{
  \renewcommand\notesectionallfontfamily{\rmdefault}
}
\def\phfnote@do@secfmt@sffamily{
  \renewcommand\notesectionallfontfamily{\sfdefault}
}
\def\phfnote@do@secfmt@itpar{
  \def\noteparagraphfont{\normalfont\normalsize\itshape}
  \def\notesubparagraphfont{\normalfont\normalsize\itshape}
}
\def\phfnote@do@secfmt@blockpar{
  \let\phfnote@old@paragraph\paragraph
  \def\paragraph##1{%
    \phfnote@old@paragraph{##1}%
    \hspace*{0pt}\par\nopagebreak% ugly hack!!
  }
}
%    \end{macrocode}
% 
%
% \begin{macro}{\phfnote@do@secfmt}
%   Actually perform the required styling, according to the package options
%   given as argument.  The argument is a comma-separated list of attributes
%   specified by the user, or the string |false|.
%    \begin{macrocode}
\def\phfnote@do@secfmt#1{%
  \ifstrequal{#1}{false}{}{%
    \phfnote@internal@execattribs{phfnote@do@secfmt@}{section formatting preset}{#1}%
  }
}
%    \end{macrocode}
% \end{macro}
% 
%
%
% \subsection{\LaTeX{} Package Sets}
%
% Define the package sets as macros.  Depending on the user-specified
% options we load the corresponding one(s) (several may be specified).
%
% See \autoref{sec:package-sets} for a description of what these
% package sets do.
%
% \begin{macro}{\phfnote@do@pkgset@none}
% \begin{macro}{\phfnote@do@pkgset@minimal}
% \begin{macro}{\phfnote@do@pkgset@rich}
% \begin{macro}{\phfnote@do@pkgset@extended}
%   Macros which implement the package sets.  Each macro invokes |\RequirePackage|
%   for the appropriate packages.
%    \begin{macrocode}
\def\phfnote@do@pkgset@none{
}

\def\phfnote@do@pkgset@minimal{

  \RequirePackage{amsmath}
  \RequirePackage{amsfonts}
  \RequirePackage{amssymb}
  \RequirePackage{amsthm}
  
  \RequirePackage{xcolor}

}


\def\phfnote@internal@setifxeorlua#1#2{%
  \ifXeTeX\let#1#2\fi
  \ifLuaTeX\let#1#2\fi
}

\def\phfnote@do@pkgset@rich{

  \phfnote@do@pkgset@minimal

  \RequirePackage{setspace}
  \RequirePackage{caption}

  \PassOptionsToPackage{shortlabels}{enumitem}
  \RequirePackage{enumitem}

  \RequirePackage{graphicx}

%    \end{macrocode}
% For this bit, use the \pkgname{iftex} package to determine if we're running
% XeTeX or LuaTeX; if that's the case then we inhibit the loading of
% \pkgname{inputenc} and \pkgname{fontenc}.  The |\IfFileExists| is to ensure
% the package runs on older LaTeX distributions without \pkgname{iftex}.
%
% Plus, load \pkgname{inputenc}, resp. \pkgname{fontenc}, only if it isn't
% already loaded.
%
% \changedreftext{chg-xe-luatex-input-fontenc-pkgset}
%    \begin{macrocode}
  \def\phfnote@tmp@requireinputencfontenc{
    \@ifpackageloaded{fontenc}{}{
      \PassOptionsToPackage{T1}{fontenc}
      \RequirePackage{fontenc}
    }
    \@ifpackageloaded{inputenc}{}{
      \PassOptionsToPackage{utf8}{inputenc}
      \RequirePackage{inputenc}
    }
  }
  \IfFileExists{iftex.sty}{
    \RequirePackage{iftex}
    \phfnote@internal@setifxeorlua\phfnote@tmp@requireinputencfontenc\relax
  }{}
  \phfnote@tmp@requireinputencfontenc

%    \end{macrocode}
% 
% Load \pkgname{microtype} after \pkgname{fontenc} (just in case).
%    \begin{macrocode}
  \RequirePackage{microtype}
}

\def\phfnote@do@pkgset@extended{

  \phfnote@do@pkgset@rich

  \RequirePackage{float}

  \RequirePackage{verbdef}

  \PassOptionsToPackage{autostyle,autopunct=true}{csquotes}
  \RequirePackage{csquotes}

  \RequirePackage{dsfont}
  \RequirePackage{bbm}
  \RequirePackage{mathtools}

}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
%
% \begin{macro}{\phfnote@do@pkgset}
%   Finally, define the helper which will load the required package sets.
%    \begin{macrocode}
\def\phfnote@do@pkgset#1{
  \phfnote@internal@execattribs{phfnote@do@pkgset@}{package set}{#1}
}
%    \end{macrocode}
% \end{macro}
% 
%
% \subsection{Hyperref Support and Hyperlinks}
%
% \begin{pkgnote}
%   The name `|docnotelinkcolor|' is historical and hard-coded in many
%   other files I've used, so I'm DEFINITELY NOT changing it.
% \end{pkgnote}
%
%
%
% Helpers---default set of hyperref options, and other helper macros.
%    \begin{macrocode}
\def\phfnote@hyperrefdefs@val@options{%
  bookmarksnumbered=false,bookmarksopen=false,bookmarksopenlevel=1,%
  breaklinks=true,pdfborder={0 0 0},colorlinks=true,%
  anchorcolor=docnotelinkcolor,citecolor=docnotelinkcolor,%
  filecolor=docnotelinkcolor,linkcolor=docnotelinkcolor,%
  menucolor=docnotelinkcolor,runcolor=docnotelinkcolor,%
  urlcolor=docnotelinkcolor%
}%
\def\phfnote@hyperrefdefs@deferredhypersetup#1{%
  \AtBeginDocument{%
    \@ifpackageloaded{hyperref}{%
      \hypersetup{#1}%
    }{%
      \PackageWarning{phfnote}{\MessageBreak\MessageBreak
        *** package `hyperref` was not loaded ***\MessageBreak
        Since you specified `hyperrefdefs=defer`, I was expecting you would call
        `\string\usepackage{hyperref}` at some point later in your preamble, but
        it does not appear you did so.  Your document might look weird.}%
    }%
  }%
}
\providecommand\phfnote@hyperrefdefs@dopkgoptions{%
  \PassOptionsToPackage{unicode=true}{hyperref}
}
\def\phfnote@hyperrefdefs@loadhyperref{%
    \phfnote@hyperrefdefs@dopkgoptions
    \RequirePackage{hyperref}}
\def\phfnote@hyperrefdefs@provideemail{\let\email\phfnote@email}
\def\phfnote@eqref#1{%
  \hyperref[{#1}]{\textup{\tagform@{\ref*{#1}}}}%
}
\def\phfnote@hyperrefdefs@redefeqref{%
  \let\eqref\phfnote@eqref
}
\def\phfnote@hyperrefdefs@afterhook{}
%    \end{macrocode}
%
% Define the attributes that can be set for hyperref-related options.  See
% \autoref{sec:hyperrefdefs}.
%
%    \begin{macrocode}
\def\phfnote@do@hyperrefdefs@attr@true{}% for explicit value "hyperrefdefs=true"
\def\phfnote@do@hyperrefdefs@attr@defer{
  \def\phfnote@hyperrefdefs@loadhyperref{%
    \phfnote@hyperrefdefs@dopkgoptions
    \let\hypersetup\phfnote@hyperrefdefs@deferredhypersetup}
}
\def\phfnote@do@hyperrefdefs@attr@clearoptions{
  \def\phfnote@hyperrefdefs@val@options{}
}
\def\phfnote@do@hyperrefdefs@attr@noemail{
  \def\phfnote@hyperrefdefs@provideemail{}
}
\def\phfnote@do@hyperrefdefs@attr@noeqref{
  \def\phfnote@hyperrefdefs@redefeqref{}
}
\def\phfnote@do@hyperrefdefs@attr@noload{
  \def\phfnote@hyperrefdefs@loadhyperref{}
  \def\phfnote@hyperrefdefs@redefeqref{}
  \let\hypersetup\@gobble
}
%    \end{macrocode}
%
%
% \begin{macro}{\phfnote@do@hyperrefdefs}
% \begin{macro}{\email}
% \begin{macro}{\url}
%   Do all stuff related to hyperref.
%    \begin{macrocode}
\def\phfnote@do@hyperrefdefs#1{%
  \ifstrequal{#1}{false}{}{%
%    \end{macrocode}
% Make sure a color-managing package is loaded, {color} or {xcolor}, and define
% our default link color:
%    \begin{macrocode}
    \phfnote@requirecolorpackage%
    \definecolor{docnotelinkcolor}{rgb}{0,0,0.4}%
%    \end{macrocode}
% Load the \pkgname{url} package, and save a version of |\url| which is not
% patched by \pkgname{hyperref} to format URLs, and provide |\phfnoteEmail| for
% emails (not |\email| right away because it might conflict with RevTeX. Provide
% |\email| later after parsing attribs):
%    \begin{macrocode}
    \RequirePackage{url}%
    \DeclareUrlCommand\phfnote@format@url{}%
    \let\phfnoteEmail\phfnote@email
%    \end{macrocode}
%
% Set up everything according to the user's selected attributes.
%    \begin{macrocode}
    \phfnote@internal@execattribs{phfnote@do@hyperrefdefs@attr@}{%
      phfnote hyperref-related option}{#1}%
%    \end{macrocode}
%
% And now, load the hyperref package (or don't, if it's deferred), and set some
% options.
%    \begin{macrocode}
    \phfnote@hyperrefdefs@loadhyperref
    \expandafter\hypersetup\expandafter{\phfnote@hyperrefdefs@val@options}
    \phfnote@hyperrefdefs@provideemail
    \phfnote@hyperrefdefs@redefeqref
    \urlstyle{notesf}
    \phfnote@hyperrefdefs@afterhook
  }
}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\phfnotePdfLinkColor}
%   Set links color.  Use as |\phfnotePdfLinkColor|\marg{color}.
%   Color may be any color name or specification recognized by the
%   \pkgname{xcolor} package.
%
%    \begin{macrocode}
\newcommand{\phfnotePdfLinkColor}[1]{%
  \@ifpackageloaded{xcolor}{%
    \colorlet{docnotelinkcolor}{#1}%
  }{% else:
    \PackageError{phfnote}{\protect\phfnotePdfLinkColor may only be
      used if the package xcolor is loaded.}{}%
  }%
}
%    \end{macrocode}
% \end{macro}
% 
%
% \needspace{3\baselineskip}
% \begin{macro}{\phfnote@sanitize@url}
% \begin{macro}{\phfnote@format@url}
% \begin{macro}{\phfnote@email}
%   Provide base macros to be able to build up |\email| command for emails and other
%   URL-like commands which should sanitize their arguments.
%
%   Also prepare the command |\phfnoteEmail| which will be renamed |\email| in our
%   \pkgname{hyperref} package setup (see above).
% 
%   NOTE: The commands |\phfnote@email| and |\phfnote@format@url| will only work
%   if you don't have |hyperrefdefs=false|.  They will work with
%   |hyperrefdefs=noload| if you don't want to load the |hyperref| package.
%    \begin{macrocode}
\def\phfnote@sanitize@url{%
  \catcode`\$12%
  \catcode`\&12%
  \catcode`\#12%
  \catcode`\^12%
  \catcode`\_12%
  \catcode`\%12%
  % \catcode`\^^J10%  newline = space
  % \catcode`\^^M10%  newline = space
  \relax%
}%
\def\phfnote@email{\begingroup\phfnote@sanitize@url\phfnote@impl@email@}%
\def\phfnote@impl@email@#1{\endgroup\href{mailto:#1}{\phfnote@format@url{#1}}}%
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
%
% 
% \begin{macro}{\phfnote@requirecolorpackage}
% And finally define an internal utility to make sure that a color package
% (either \pkgname{color} or \pkgname{xcolor}) is loaded.  If none are loaded,
% the \pkgname{xcolor} package is loaded.
%    \begin{macrocode}
\def\phfnote@requirecolorpackage{%
  \@ifpackageloaded{color}{%
  }{%
    \@ifpackageloaded{xcolor}{%
    }{%
      \RequirePackage{xcolor}%
    }%
  }%
}
%    \end{macrocode}
% \end{macro}
% 
%
% \subsection{Cosmetic Font Definitions}
%
% \begin{macro}{\phfnote@do@fontdefs}
%   Minimalist cosmetic definition for fonts: load the |T1| font
%   encoding which is better.  Also, use Computer Modern Bright as
%   sans-serif font by default instead of Computer Modern Sans Serif.
%
%   If on Xe\TeX{} or Lua\TeX{}, don't do anything.
%
%    \begin{macrocode}
\def\phfnote@do@fontdefs#1{
  \ifstrequal{#1}{false}{}{%
    \let\phfnote@tmp@do\@firstofone
    \IfFileExists{iftex.sty}{%
      \RequirePackage{iftex}%
      \phfnote@internal@setifxeorlua\phfnote@tmp@do\@gobble
    }{}
    \phfnote@tmp@do{
      \PassOptionsToPackage{T1}{fontenc}
      \RequirePackage{fontenc}
      \renewcommand\sfdefault{cmbr}
    }
  }
}
%    \end{macrocode}
% \end{macro}
% 
%
% \subsection{Bibliography Stuff}
%
%   Provide some fixes for the bibliography.
%
% \begin{macro}{\phfnote@bibstyle}
% \begin{macro}{\phfnote@bibfont}
%   Our default bibliography style is stored in |\phfnote@bibstyle|.
%   By default, it's our own hacked version of the |naturemag| style.
%   The font in which to typeset the bibliography is stored in
%   |\phfnote@bibfont|.  By default, it's a little smaller than the
%   main text.
%    \begin{macrocode}
\newcommand{\phfnote@bibstyle}{naturemagdoi}
\newcommand{\phfnote@bibfont}{\fontsize{9}{11}\selectfont}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% 
%
% \begin{macro}{\phfnote@bibliography}
%   These are a tentative implementation for |\bibliography|.  The latter will be set to
%   this implementation according to the user's package options.
%    \begin{macrocode}
\let\phfnote@old@bibliography\bibliography
\let\phfnote@old@bibliographystyle\bibliographystyle
\newcommand{\phfnote@bibliography}[1]{%
  \begingroup%
    \phfnote@bibfont%
    \phfnote@old@bibliographystyle{\phfnote@bibstyle}%
%    \end{macrocode}
% 
% Our hack: make sure that the next instance of |\section*| will generate a TOC
% entry. (See |\phfnoteHackSectionStarWithTOC|.)
%    \begin{macrocode}
    \phfnoteHackSectionStarWithTOC%
%    \end{macrocode}
% 
% Some special chars may appear in output of some ill-advised bibliography
% managers. Mostly the |&| symbol, such as in |Taylor & Francis|.  We won't be needing a
% \LaTeX{} alignment operator here, so just make |&| a normal printable character
% (``other'' catcode).
%    \begin{macrocode}
    \catcode`\&=12\relax% normal char
%    \end{macrocode}
%
% Adjust the appearance of e-prints. We assume e-prints refer to the arXiv; here we
% generate a hyperlink and format them better.
%
%    \begin{macrocode}
    \providecommand\eprint[2][]{\href{http://arxiv.org/abs/##2}{arXiv:##2}}
%    \end{macrocode}
%
% Fix for RevTeX styles that use |\doibase| with a newline following them ---
%    \begin{macrocode}
    \providecommand\doibase{\phfnote@doibasefix}
%    \end{macrocode}
% 
% Relay the call to the ``old'' |\bibliography| command to actually implement the
% bibliography.
%    \begin{macrocode}
    \phfnote@old@bibliography{#1}%
  \endgroup%
}
\def\phfnote@doibasefix#110.{https://doi.org/10.}
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\phfnote@bibliographystyle}
%   Tentative implementation of |\bibliographystyle|.  Just register the new style in an
%   internal variable, so that the style is actually loaded in |\phfnote@bibliography|.
%
%   This will be renamed to replace |\bibliographystyle| later, according to package
%   options.
%    \begin{macrocode}
\newcommand{\phfnote@bibliographystyle}[1]{%
  \renewcommand{\phfnote@bibstyle}{#1}%
}
%    \end{macrocode}
% \end{macro}
% 
%
% \begin{macro}{\phfnote@do@bibliographydefs}
%   Make our changes live.  Will be called later according to package options.
%    \begin{macrocode}
\def\phfnote@do@bibliographydefs#1{%
  \ifstrequal{#1}{false}{}{%
    \let\bibliographystyle\phfnote@bibliographystyle%
    \let\bibliography\phfnote@bibliography%
  }
}
%    \end{macrocode}
% \end{macro}
% 
%
%
% \subsection{Better Footnote Style}
%
% \begin{macro}{\phfnote@do@footnotedefs}
%   Adjust the formatting of footnotes so they look better.  Again,
%   this is called later according to the package options.
%    \begin{macrocode}
\def\phfnote@do@footnotedefs#1{
  \ifstrequal{#1}{false}{}{%
    \let\phfnote@orig@makefnmark\@makefnmark
%%    \def\@makefnmark{\hbox{\@textsuperscript{%
%%        \normalfont\tiny\fontseries{sb}\selectfont\@thefnmark}}}
    \def\@makefnmark{\hbox{\@textsuperscript{%
          \normalfont\tiny\bfseries\@thefnmark}}}
%%    \def\@makefnmark{\hbox{\@textsuperscript{%
%%        \normalfont\scriptsize\bfseries\@thefnmark}}}% too large
  }
}
%    \end{macrocode}
% \end{macro}
% 
% 
%
%
% \subsection{Other Stand-Alone Definitions and Helpers}
% \label{sec:impl-other-stand-alone-defs}
%
% \subsubsection{A \phfverb{\notesmaller} command}
%
%
% \begin{macro}{\notesmaller}
%   Relative font size command.  Makes the text a fraction smaller
%   than its surroundings.  The fraction is either given explicitly as
%   optional argument (1.0=same size) or is by default set by
%   |\notesmallerfrac|.
%
%   To impalement this, we exploit the fact that \LaTeX{} saves the
%   current font size in the macro |\f@size|.
%    \begin{macrocode}
\newcommand\notesmaller[1][\notesmallerfrac]{%
  \fontsize{#1\dimexpr\f@size pt\relax}{#1\dimexpr\f@baselineskip pt\relax}%
  \selectfont\ignorespaces%
}
%    \end{macrocode}
% \end{macro}
% \begin{macro}{\notesmallerfrac}
%   Default fraction by which |\notesmaller| acts.  Redefine to change defaults.
%    \begin{macrocode}
\def\notesmallerfrac{0.9}
%    \end{macrocode}
% \end{macro}
%
%
% \subsubsection{Customized, ``Inline,'' Table of Contents}
%
% \begin{macro}{\inlinetoc}
%   Just a customized table of contents.  Horizontal rules before and
%   after, and spacing is adjusted, and no ``Contents'' title.  The
%   table of contents looks just like at the \hyperref[sec:toc]{top of
%   this document}.  The command is described in
%   \autoref{sec:inline-toc}.
%
%   We call |\@starttoc| directly, bypassing the |\section*| included by
%   |\tableofcontents| (see definition |\tableofcontents| in latex sources).
%    \begin{macrocode}
\newcommand{\inlinetoc}{%
  \begingroup%
    \vspace*{2mm}%
    \hrule%
    \vspace*{2mm}%
    \parskip=1pt\relax%
    \@starttoc{toc}%
    \vspace*{4mm}%
    \hrule%
    \vspace*{6mm}%
  \endgroup%
}
%    \end{macrocode}
% 
% \end{macro}
%
% \subsubsection{Inline commenting in documents}
%
% The code that was initially here was moved into a separate package:
% \pkgname{phfcc}.
%
% \subsubsection{URL Styles}
%
% \needspace{7\baselineskip}
% \begin{macro}{\url@notettstyle}
% \begin{macro}{\url@notesfstyle}
% \begin{macro}{\url@notesfssstyle}
% \begin{macro}{\url@noteitsfstyle}
% \begin{macro}{\url@notermstyle}
% \begin{macro}{\url@noteitstyle}
% \begin{macro}{\url@notesmlstyle}
%   We also provide some URL styles.  These can directly set with
%   |\urlstyle|\marg{style-name}.
%
%    \begin{macrocode}
\def\url@notettstyle{%
  \def\UrlFont{\ttfamily\notesmaller}%
  \phfnote@urlstyle@common%
}
\def\url@notesfstyle{%
  \def\UrlFont{\sffamily\notesmaller}%
  \phfnote@urlstyle@common%
}
\def\url@notesfssstyle{%
  \def\UrlFont{\fontfamily{cmss}\selectfont\notesmaller}%
  \phfnote@urlstyle@common%
}
\def\url@noteitsfstyle{%
  \def\UrlFont{\sffamily\itshape\notesmaller}%
  \phfnote@urlstyle@common%
}
\def\url@notermstyle{%
  \def\UrlFont{\rmfamily\notesmaller}%
  \phfnote@urlstyle@common%
}
\def\url@noteitstyle{%
  \def\UrlFont{\itshape\notesmaller}%
  \phfnote@urlstyle@common%
}
\def\url@notesmlstyle{%
  \def\UrlFont{\notesmaller}%
  \phfnote@urlstyle@common%
}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\phfnote@urlstyle@common}
% The following code is common to all our styles. We do an ugly hack
% in which the tilde character (`\textasciitilde') is fixed to the
% tilde char in the Adobe Times font (|ptm| code), so that it looks
% nicer and its alignment is correct.
%    \begin{macrocode}
\def\phfnote@url@tilde{\hbox{\fontfamily{ptm}\selectfont\textasciitilde}}
%%\def\phfnote@url@tilde{\raise-0.8ex\hbox{%
%%    \kern-0.2ex\fontfamily{cmbr}\selectfont\textasciitilde}}
\def\phfnote@urlstyle@common{%
  \def\UrlTildeSpecial{\do\~{\phfnote@url@tilde}}%
  \let\Url@force@Tilde\UrlTildeSpecial%
}
%    \end{macrocode}
% \end{macro}
% 
%
% \subsubsection{Utility to Add TOC Entry For Starred Section }
%
% Here we provide an ugly hack which introduces an entry in the table
% of contents for |\section*| commands.
%
% [Note: An existing way of adding the toc entry in these cases is to issue
% a |\addcontentsline| command before the relevant command
% (say |\bibliography|).  However this is unreliable, because on page
% boundaries the |\addcontentsline| will pick up the previous page.  This
% is why |\addcontentsline| should be issued right \emph{after} the
% |\section*| command.]
%
% \begin{pkgwarning}
%   This command is truly a hack, don't apply it globally!  It forces
%   (locally) the |\section| command to be followed by a `|*|' !  Do this
%   within a group, just before a command which you are sure is
%   invoking |\section*| (such as |\bibliography| in the \pkgname{article}
%   class).
% \end{pkgwarning}
%
% \begin{macro}{\phfnoteHackSectionStarWithTOC}
%   Locally force |\section| to be followed by |*| and introduce an
%   entry in the table of contents.
%    \begin{macrocode}
\def\phfnoteHackSectionStarWithTOC{%
    \let\phfnote@old@section\section%
    \def\section*##1{\phfnote@old@section*{##1}\addcontentsline{toc}{section}{##1}}%
}
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\phfnoteHackSectionStarWithTOCInCommand}
%   Patches the given command (|#1|), which is known to invoke
%   |\section*|, to locally first invoke
%   |\phfnoteHackSectionStarWithTOC| and thus generate a TOC entry.
%
%    \begin{macrocode}
\def\phfnoteHackSectionStarWithTOCInCommand#1{%
  \expandafter\let\csname phfnote@old@\string#1\endcsname#1%
  \gdef#1{%
    \begingroup%
    \phfnoteHackSectionStarWithTOC%
    \csname phfnote@old@\string#1\endcsname%
    \endgroup%
  }%
}
%    \end{macrocode}
% \end{macro}
%
%
% \subsubsection{Hack to save \& restore a set of commands}
%
% Exactly what it sounds like.  You can store a set of commands, specified by
% their name, by specifying an identifier.  The commands corresponding to a
% given identifier can then later be restored.
%
% \begin{macro}{\phfnoteSaveDefs}
%   The command |\phfnoteSaveDefs|\marg{identifier}\marg{list of macro names}
%   saves the current definitions of the given list of macro and associates them
%   to the given identifier.
%   The list of macros is specified as a comma-separated list of macro names.
%    \begin{macrocode}
\def\phfnoteSaveDefs#1#2{%
%    \end{macrocode}
% 
% The macro |\phfnote@restoredefs@<identifier>| will store the code necessary to
% restore the macros.
%    \begin{macrocode}
  \csgdef{phfnote@restoredefs@#1}{}%
%    \end{macrocode}
% 
% Iterate over the macros we are supposed to store.
%    \begin{macrocode}
  \def\@tmpa{#2}%
  \@for\next:=\@tmpa\do{%
%    \end{macrocode}
% 
% For each macro we are supposed to store (whose name is given in |\next|), we
% |\let| |\phfnote@restoredefs@<identifier>@<macro-name>| store the current value
% of the macro.
%    \begin{macrocode}
    \global\csletcs{phfnote@restoredefs@#1@\next}{\next}%
%    \end{macrocode}
% 
% Then, we append to |\phfnote@restoredefs@<identifier>| the code necessary to
% restore this macro.  That code is simply a |\cslet| instruction.
%
% Recall that |\xappto| expands its second argument (as |\xdef| does), allowing
% us to expand the value of |\next|.
%    \begin{macrocode}
    \expandafter\xappto\csname phfnote@restoredefs@#1\endcsname{%
      \noexpand\csletcs{\next}{phfnote@restoredefs@#1@\next}%
    }%
  }%
}
%    \end{macrocode}
% \end{macro}
% 
% \begin{macro}{\phfnoteRestoreDefs}
%   Restores the macro saved by |\phfnoteSaveDefs|.  We simply execute the macro
%   |\phfnote@restoredefs@<identifier>|, in which we duly stored the code
%   necessary to restore all the saved macros.
%    \begin{macrocode}
\def\phfnoteRestoreDefs#1{%
  \ifcsname phfnote@restoredefs@#1\endcsname%
    \csname phfnote@restoredefs@#1\endcsname%
  \else%
    \PackageError{phfnote}{\string\phfnoteRestoreDefs: no such
      definitions stored (#1)}{}
  \fi%
}
%    \end{macrocode}
% \end{macro}
%
%
% \subsubsection{A utility for verbatim stuff in arguments of other macros}
%
% FIXME: DOCUMENT ME!
%
% A utility for using verbatim stuff in arguments of other macros---exploit
% |\detokenize|
%
%    \begin{macrocode}
\def\phfverb#1{%
  \ifx\protect\relax%
    \phfverbfmt{\detokenize{#1}\unskip}%
  \else%
    \noexpand\phfverb{\unexpanded{#1}}%
  \fi%
}
\def\phfverbfmt#1{{\normalfont\texttt{#1}}}
%    \end{macrocode}
%
% \subsection{Handle Package Options}
%
% \subsubsection{Define and Parse Package Options}
%
% Initialization code for \pkgname{kvoptions} for our package options.  See \autoref{sec:package-options}.
%
%    \begin{macrocode}
\SetupKeyvalOptions{
  family=phfnote,
  prefix=phfnote@opt@
}
%    \end{macrocode}
%
%
% The title style to use. \PrintMarginLabel{[title=...]}
% See \autoref{sec:title-styles}.
%    \begin{macrocode}
\DeclareStringOption[default]{title}
\DeclareVoidOption{notitle}{\def\phfnote@opt@title{false}}
%    \end{macrocode}
% 
%
% Option for abstract attributes \PrintMarginLabel{[abstract=...]}
% (\autoref{sec:abstract-attributes}).
%    \begin{macrocode}
\DeclareStringOption[]{abstract}
\DeclareVoidOption{noabstract}{\def\phfnote@opt@abstract{false}}
%    \end{macrocode}
%
% Option for Package sets \PrintMarginLabel{[pkgset=...]}
% (\autoref{sec:package-sets})
%    \begin{macrocode}
\DeclareStringOption[rich]{pkgset}
%    \end{macrocode}
%
% Define the page geometry.  \PrintMarginLabel{[pagegeomdefs=...]}
% \PrintMarginLabel{[pagegeom=...]}  See \autoref{sec:pagegeomdefs}.
%    \begin{macrocode}
\DeclareStringOption[default]{pagegeom}
\DeclareVoidOption{nopagegeom}{\def\phfnote@opt@pagegeom{false}}
%    \end{macrocode}
%
% Obsolete options---
%    \begin{macrocode}
\DeclareBoolOption[true]{pagegeomdefs}
\DeclareComplementaryOption{nopagegeomdefs}{pagegeomdefs}
%    \end{macrocode}
% ---we handle these as follows. By default, |\ifphfnote@opt@pagegeomdefs| is
% true. If it isn't, that means it was overridden and we need to respect that.
% 
%
% Styling of section headings.  \PrintMarginLabel{[secfmt=...]}
% See \autoref{sec:secfmt}.
%    \begin{macrocode}
\DeclareStringOption[section]{secfmt}
\DeclareVoidOption{nosecfmt}{\def\phfnote@opt@secfmt{false}}
%    \end{macrocode}
%
% How to treat paragraphs.  \PrintMarginLabel{[par=...]} See
% \autoref{sec:par-defs}.
%    \begin{macrocode}
\DeclareStringOption[skip]{par}
\DeclareVoidOption{nopar}{\def\phfnote@opt@par{false}}
%    \end{macrocode} 
% 
% Add definitions to adjust spacing of lines and
% words. \PrintMarginLabel{[spacingdefs=...]}  See \autoref{sec:spacingdefs}.
%    \begin{macrocode}
\DeclareStringOption[true]{spacingdefs}[true]
\DeclareVoidOption{nospacingdefs}{\def\phfnote@opt@spacingdefs{false}}
%    \end{macrocode}
%
%
% Do some adjustments to the fonts. \PrintMarginLabel{[fontdefs=...]}  See
% \autoref{sec:fontdefs}.
%    \begin{macrocode}
\DeclareStringOption[true]{fontdefs}[true]
\DeclareVoidOption{nofontdefs}{\def\phfnote@opt@fontdefs{false}}
%    \end{macrocode}
%
% Adjustments for footnotes. \PrintMarginLabel{[footnotedefs=...]}  See
% \autoref{sec:footnotedefs}.
%    \begin{macrocode}
\DeclareStringOption[true]{footnotedefs}[true]
\DeclareVoidOption{nofootnotedefs}{\def\phfnote@opt@footnotedefs{false}}
%    \end{macrocode}
%
% Load \pkgname{hyperref} and corresponding
% definitions. \PrintMarginLabel{[hyperrefdefs=...]} See
% \autoref{sec:hyperrefdefs}.
%    \begin{macrocode}
\DeclareStringOption[]{hyperrefdefs}[]
\DeclareVoidOption{nohyperrefdefs}{\def\phfnote@opt@hyperrefdefs{false}}
%    \end{macrocode}
%
% Adjustments for bibliography, including default
% style. \PrintMarginLabel{[bibliographydefs=...]} See
% \autoref{sec:bibliographydefs}.
%    \begin{macrocode}
\DeclareStringOption[true]{bibliographydefs}[true]
\DeclareVoidOption{nobibliographydefs}{\def\phfnote@opt@bibliographydefs{false}}
%    \end{macrocode}
% 
% \begin{macro}{\phfnote@loadpreset}
%   A helper macro to load presets.  Can be used by presets that want to extend
%   other presets.
%    \begin{macrocode}
\def\phfnote@loadpreset#1{%
  \IfFileExists{phfnotepreset-#1.def}{%
    \input{phfnotepreset-#1.def}%
  }{%
    \ifcsname phfnote@preset@#1\endcsname%
      \csname phfnote@preset@#1\endcsname%
    \else%
      \PackageError{phfnote}{Unknown preset: `#1'!}{You specified the
        option 'preset=...' with an invalid value.  Please look up the
        package documentation corresponding to your version of phfnote
        for possible values.  Additionally, no file named `phfnotepreset-#1.def'
        was found.}%
  \fi%
  }%
}
%    \end{macrocode}
% \end{macro}
%
% Preset option.  \PrintMarginLabel{[preset=...]} See \autoref{sec:presets}.
%    \begin{macrocode}
\define@key{phfnote}{preset}{%
  \phfnote@loadpreset{#1}%
}
%    \end{macrocode}
% 
%
% Provide the standard error message for unknown options.
%    \begin{macrocode}
\DeclareDefaultOption{%
  \@unknownoptionerror
}
%    \end{macrocode}
%
%
%
% Small utility to deal with obsolete |XXXdefs=true/false| options.  If the
% (obsolete) bool option |#1| is set to false (which means it was set
% explicitly, so this must be respected), then emit a package warning and set
% option |#2| (the regular option) to the string value |false|.
%    \begin{macrocode}
\def\phfnote@ifpkgoptfalsesetfalse#1#2{%
  \edef\x{%
    \expandafter\noexpand\csname ifphfnote@opt@#1\endcsname\noexpand\else
      \noexpand\PackageWarning{phfnote}{Option #1 is obsolete. Please use "#2=false'' instead.}%
      \noexpand\csgdef{phfnote@opt@#2}{false}\noexpand\fi}%
  \x
}
%    \end{macrocode}
% 
% \subsubsection{Define Global Presets}
% \label{impl:presets}
%
% Define the global presets here.  See \autoref{sec:presets} for a description
% of what these presets do.
%
% Some of the presets whose definitions are short are defined here directly
% here, in the |sty| file.  Other presets are placed in a separate
% |phfnotepreset-XXX.def| file to avoid bloating the main style file.
%
% \changed[chg-presets-dotdef-files]{v4.0}{2021/10/08}{Moved some presets to
% external \phfverb{.def} files}
%
% \begin{macro}{\phfnote@hook@atendload}
%   A hook for presets to do stuff at the end of package load.
%    \begin{macrocode}
\def\phfnote@hook@atendload{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\phfnote@preset@article}
%   Article preset.
%    \begin{macrocode}
\def\phfnote@preset@article{
  \def\phfnote@opt@title{article}
  \def\phfnote@opt@par{indent}
  \def\phfnote@opt@pagegeom{default}
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\phfnote@presetcommon@xnote}
%   Specify some common definitions for all our |*note| preset styles.  The
%   optional argument is the URL style to set.
%    \begin{macrocode}
\newcommand\phfnote@presetcommon@xnote[1][noteitsf]{
  \def\phfnote@opt@title{default}
  \def\phfnote@opt@par{skip}
  %\phfnote@opt@pagegeomdefstrue
  \def\phfnote@opt@pagegeom{wide}
  \setlength{\footnotesep}{5pt}
  \g@addto@macro\phfnote@hook@atendload{
    \ifdefined\urlstyle
      \urlstyle{#1}
    \fi
  }
}
%    \end{macrocode}
% \end{macro}
% 
% \needspace{5\baselineskip}
% \begin{macro}{\phfnote@preset@sfnote}
% \begin{macro}{\phfnote@preset@sfssnote}
% \begin{macro}{\phfnote@preset@opensansnote}
% \begin{macro}{\phfnote@preset@utopianote}
% \begin{macro}{\phfnote@preset@mnmynote}
%   Define the different |*note| styles.
%    \begin{macrocode}
\def\phfnote@preset@sfnote{
  \phfnote@presetcommon@xnote
  \def\phfnote@opt@footnotedefs{true}
  \def\phfnote@opt@fontdefs{true}
  \renewcommand\familydefault{\sfdefault}
  \renewcommand{\notesectionallfontfamily}{\sfdefault}
}
\def\phfnote@preset@sfssnote{
%    \end{macrocode}
% set up all the settings as for |sfnote| \ldots
%    \begin{macrocode}
  \phfnote@loadpreset{sfnote}%
%    \end{macrocode}
% \ldots but override:
%    \begin{macrocode}
  \def\phfnote@opt@fontdefs{false}
  \PassOptionsToPackage{T1}{fontenc}
  \RequirePackage{fontenc}
  \renewcommand\sfdefault{cmss}
}
\def\phfnote@preset@opensansnote{
%    \end{macrocode}
% set up all the settings as for |sfnote| \ldots
%    \begin{macrocode}
  \phfnote@loadpreset{sfnote}%
%    \end{macrocode}
% \ldots but override:
%    \begin{macrocode}
  \def\phfnote@opt@fontdefs{false}
  \PassOptionsToPackage{T1}{fontenc}
  \RequirePackage{fontenc}
  \PassOptionsToPackage{default,scale=0.9}{opensans}
  \RequirePackage{opensans}
}
\def\phfnote@preset@utopianote{
  \phfnote@presetcommon@xnote[noteit]
  \def\phfnote@opt@fontdefs{false}
  \PassOptionsToPackage{T1}{fontenc}
  \RequirePackage{fontenc}
  \RequirePackage{fourier}
  \renewcommand{\notesectionallfontfamily}{put}
  \renewcommand{\notetitlefont}{\bfseries}
  \renewcommand{\sfdefault}{phv}
}
\def\phfnote@preset@mnmynote{
  \phfnote@presetcommon@xnote[noteit]
  \def\phfnote@opt@footnotedefs{false}
  \def\phfnote@opt@fontdefs{false}
  \PassOptionsToPackage{T1}{fontenc}
  \RequirePackage{fontenc}
  \renewcommand{\notesectionallfontfamily}{\sfdefault}
%    \end{macrocode}
%
% Require these packages AFTER the default package set, because some symbols may
% be defined in package sets, and I've had problems with re-definitions
% etc\ldots anyway this seems to work this way:
%    \begin{macrocode}
  \g@addto@macro\phfnote@hook@atendload{
    \RequirePackage{MnSymbol}
    \PassOptionsToPackage{medfamily,textosf,mathlf,minionint,footnotefigures}{MinionPro}
    \RequirePackage{MinionPro}
    \PassOptionsToPackage{medfamily}{MyriadPro}
    \RequirePackage{MyriadPro}
  }
}
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\phfnote@preset@pkgdoc}
%   Preset for a package documentation.
%
%   Start by setting the same settings as for other |Xnote| presets.
%    \begin{macrocode}
\def\phfnote@preset@pkgdoc{
  \phfnote@presetcommon@xnote[noteit]
  \def\phfnote@opt@fontdefs{false}
%    \end{macrocode}
% 
% Then set up the font, which is done in a separate macro
% |\phfnote@pkgdoc@setupfont| in case individual documents would like more
% specific settings.  (For example, some packages may want a different math
% font.)
%    \begin{macrocode}
  \phfnote@pkgdoc@setupfont
%    \end{macrocode}
% 
% Finally, set up general appearance.
%    \begin{macrocode}
  \def\phfnote@opt@secfmt{section,paragraph,itpar,blockpar,larger,secsquares,secnummargin}
  \def\phfnote@opt@pagegeom{bigmargin}
  \def\phfnote@opt@abstract{noname}
}
%    \end{macrocode}
%
% Also provide a helper macro which is to load the font packages we
% want.  By default, we use Utopia fonts via the \pkgname{fourier}
% package, but some package documentations may want a different math
% font.  Override |\phfnote@pkgdoc@setupfont| to adjust the whole font
% set-up, or |\phfnote@pkgdoc@setupmainfont| to adjust only the main
% document font.
%
% \changed[chg-opensans-fosj]{v3.1}{2020/05/25}{Fixes for more recent
% versions of the \pkgname{opensans} package.}
%    \begin{macrocode}
\providecommand\phfnote@pkgdoc@setupfont{
  \PassOptionsToPackage{T1}{fontenc}
  \RequirePackage{fontenc}
  \phfnote@pkgdoc@setupmainfont
  \renewcommand{\notesectionallfontfamily}{put}
  \renewcommand{\notetitlefont}{\bfseries}
  \IfFileExists{opensans.sty}{}{\PackageError{phfnote}{Font OpenSans is not
      available (need `opensans' package)}{Please install the opensans
      package, which provides the OpenSans font.}}
  \PassOptionsToPackage{scale=0.85,defaultsans}{opensans}
  \RequirePackage{opensans}
}
\providecommand\phfnote@pkgdoc@setupmainfont{\RequirePackage{fourier}}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\phfnote@preset@reset}
%   Finally, the |reset| preset:
%    \begin{macrocode}
\def\phfnote@preset@reset{
  \def\phfnote@opt@pkgset{none}
  \def\phfnote@opt@title{false}
  \def\phfnote@opt@pagegeom{false}
  \def\phfnote@opt@spacingdefs{false}
  \def\phfnote@opt@par{false}
  \def\phfnote@opt@abstract{false}
  \def\phfnote@opt@hyperrefdefs{false}
  \def\phfnote@opt@fontdefs{false}
  \def\phfnote@opt@secfmt{false}
  \def\phfnote@opt@bibliographydefs{false}
  \def\phfnote@opt@footnotedefs{false}
%    \end{macrocode}
% 
% \begin{pkgwarning}
%   NOTE TO SELF: DO NOT FORGET TO ADD HERE RESET COMMANDS FOR ANY NEW OPTION
%   THAT WE PROVIDE IN THE FUTURE.
% \end{pkgwarning}
% 
%    \begin{macrocode}
}
%    \end{macrocode}
% \end{macro}
%
%
% \subsubsection{Finally, Process and Execute the Package Options}
%
%
%
% Process the options:
%
%    \begin{macrocode}
\ProcessKeyvalOptions*
%    \end{macrocode}
%
%
% Take action according to the user options.
%
% For the |pkgset| option.
%    \begin{macrocode}
\expandafter\phfnote@do@pkgset\expandafter{\phfnote@opt@pkgset}
%    \end{macrocode}
% 
% For the |title| option.
%    \begin{macrocode}
\expandafter\phfnote@do@notetitle\expandafter{\phfnote@opt@title}
%    \end{macrocode}
%
% For the |abstract| option.
%    \begin{macrocode}
\expandafter\phfnote@do@noteabstract\expandafter{\phfnote@opt@abstract}
%    \end{macrocode}
%
% For the |secfmt| option.
%    \begin{macrocode}
\expandafter\phfnote@do@secfmt\expandafter{\phfnote@opt@secfmt}
%    \end{macrocode}
%
% For the |pagegeomdefs| option.  Here, the first line is needed to deal with
% the obsolete option `|pagegeom|'.
%    \begin{macrocode}
\phfnote@ifpkgoptfalsesetfalse{pagegeomdefs}{pagegeom}
\expandafter\phfnote@do@pagegeom\expandafter{\phfnote@opt@pagegeom}
%    \end{macrocode}
%
% For the |spacingdefs| option.
%    \begin{macrocode}
\expandafter\phfnote@do@spacingdefs\expandafter{\phfnote@opt@spacingdefs}
%    \end{macrocode}
%
% For the |par| option.
%    \begin{macrocode}
\expandafter\phfnote@do@par\expandafter{\phfnote@opt@par}
%    \end{macrocode}
%
% For the |hyperrefdefs| option.
%    \begin{macrocode}
\expandafter\phfnote@do@hyperrefdefs\expandafter{\phfnote@opt@hyperrefdefs}
%    \end{macrocode}
%
% For the |fontdefs| option.
%    \begin{macrocode}
\expandafter\phfnote@do@fontdefs\expandafter{\phfnote@opt@fontdefs}
%    \end{macrocode}
%
% For the |bibliographydefs| option.
%    \begin{macrocode}
\expandafter\phfnote@do@bibliographydefs\expandafter{\phfnote@opt@bibliographydefs}
%    \end{macrocode}
%
% For the |footnotedefs| option.
%    \begin{macrocode}
\expandafter\phfnote@do@footnotedefs\expandafter{\phfnote@opt@footnotedefs}
%    \end{macrocode}
% 
% Finally, execute the hook we set up for definitions at the end of the package
% loading:
%    \begin{macrocode}
\phfnote@hook@atendload
%    \end{macrocode}
%
%
% \subsection{Helper files}
%
% Now we write some code to some external |.def| files for large chunks of code
% that are only needed in specific situations, in order to avoid bloating the
% main style file.
%
% \subsubsection{The \emph{xpkgdoc} preset}
% \label{sec:impl-xpkgdoc}
%
% The |xpkgdoc| preset is based on the |pkgdoc| preset.  It introduces multiple
% pretty involved tools and definitions on top of |pkgdoc|; these are not needed
% unless this preset is loaded.  Let's write all of the corresponding
% definitions into a separate |.def| file.
%
% \iffalse
%</package>
% \fi
%    \begin{verbatim}
%<*phfnotepreset-xpkgdoc>
%    \end{verbatim}
%
% Load the |pkgdoc| preset before anything else:
%    \begin{macrocode}
\phfnote@loadpreset{pkgdoc}
%    \end{macrocode}
% 
% Include the \pkgname{verbdef} package, because it's always useful.
%    \begin{macrocode}
\RequirePackage{verbdef}
%    \end{macrocode}
%
% \textbf{Some patching first:}
% Patch up |\PrintChanges| and |\PrintIndex|, if they are defined (for if we are
% using the \pkgname{ltxdoc} package for latex package documentation).  We want
% these to generate an entry in the table of contents.  Also provide the utility
% |\PrintChangesAndIndex|, which calls both |\PrintChanges| and |\PrintIndex| with
% some additional spacing.
%    \begin{macrocode}
\ifdefined\PrintChanges
  \phfnoteHackSectionStarWithTOCInCommand\PrintChanges
\fi
\ifdefined\PrintIndex
  \phfnoteHackSectionStarWithTOCInCommand\PrintIndex
\fi
\def\PrintChangesAndIndexSpacing{\vspace{3cm plus 2cm minus 2cm}}
\def\PrintChangesAndIndex{\PrintChangesAndIndexSpacing\PrintChanges
  \PrintChangesAndIndexSpacing\PrintIndex}
%    \end{macrocode}
%
% Set the index to TWO columns only (three is too tight).
%    \begin{macrocode}
\ifdefined\c@IndexColumns
  \setcounter{IndexColumns}{2}
\fi
%    \end{macrocode}
% 
% And set the glossary, that is, the list of changes history to single-column.
% For this, renew the environment completely to remove the |multicols|
% environment.
%    \begin{macrocode}
\let\phfnote@xpkgdoc@old@theglossary\theglossary
\let\phfnote@xpkgdoc@old@endtheglossary\endtheglossary
\renewenvironment{theglossary}{%
  \glossary@prologue%
  \GlossaryParms \let\item\@idxitem \ignorespaces}
{}
%    \end{macrocode}
%
% Tools to condense the macro names in the margins, and make them break at the
% margin width (at arbitrary points in the macro name) instead of overflowing on
% the documentation text.
%    \begin{macrocode}
\def\phf@fillwithdiscretionaries#1#2#3{%
  \def\phf@fillwithdescretionaries@a{#1}%
  \def\phf@fillwithdescretionaries@b{#2}%
  \edef\x{#3}%
  \expandafter \phf@fillwithdiscretionaries@ \x \@nil
}
\def\phf@fillwithdiscretionaries@#1#2\@nil{%
  \if\relax\detokenize{#1}\relax\else
    #1%
    \if\relax\detokenize{#2}\relax\else
      \discretionary{\phf@fillwithdescretionaries@a}{%
        \phf@fillwithdescretionaries@b}{}%
      \phf@fillwithdiscretionaries@#2\@nil
    \fi
  \fi
}
\definecolor{phfxpkgdocmacronamehyphencolor}{rgb}{0.6,0.6,0.7}
\def\phf@xpkgdoc@macrobreakhyphen{%
  \hbox{\textcolor{phfxpkgdocmacronamehyphencolor}{-}}}
\def\ScaleHorizontallyAndHyphenateAnywhere#1#2{% {hscale-factor}{text}
  \scalebox{#1}[1.0]{%
    \parbox{% compute inverse of #1 ...
      \dimexpr \marginparwidth*65536 /
      \number\dimexpr #1\p@ \relax \relax
    }{\raggedleft\phf@fillwithdiscretionaries{%
        \phf@xpkgdoc@macrobreakhyphen}{}{#2}\hfill}%
  }%
}
\def\phf@xpkgdoc@marginmacronamecompressfactor{0.85}
\def\phf@xpkgdoc@macrofont{\small\bfseries}% \footnotesize ?
\def\PrintMarginLabelContents#1{%
  \strut\MacroFont\phf@xpkgdoc@macrofont
  \ScaleHorizontallyAndHyphenateAnywhere{%
    \phf@xpkgdoc@marginmacronamecompressfactor}{#1}%
  \par
}
\def\PrintMarginLabel#1{\marginpar{\PrintMarginLabelContents{#1}}}
\def\PrintDescribeMacro#1{\PrintMarginLabelContents{\string#1}}
\let\PrintMacroName\PrintDescribeMacro
\let\PrintDescribeEnv\PrintMarginLabelContents
\let\PrintEnvName\PrintMarginLabelContents
%    \end{macrocode}
% 
% \textbf{Hyperref:} Request default \pkgname{hyperref} definitions with
% |hyperrefdefs=defer|, but we'll load \pkgname{hyperdoc} instead of
% \pkgname{hyperref}.
%    \begin{macrocode}
\def\phfnote@opt@hyperrefdefs{defer}
\g@addto@macro\phfnote@hook@atendload{
  \RequirePackage{hypdoc}
  \urlstyle{noteit}
}
%    \end{macrocode}
%
% \textbf{Provide Macro:} |\pkgname|\marg{package name} to format a package
% name.  Also place it in the general index.  This command is robust and
% can be used in section titles etc.
%    \begin{macrocode}
\def\pkgname#1{%
  \pkgnamefmt{#1}%
  \index{#1=\pkgnamefmt{#1}|hyperpage}%
  \index{packages:>#1=\pkgnamefmt{#1}|hyperpage}%
}
\robustify\pkgname
\def\pkgnamefmt#1{\textsf{#1}}
\robustify\pkgnamefmt
%    \end{macrocode}
% 
%
% \textbf{Provide Macros:} |\changed| and |\changedreftext|, with more
% advanced support for displaying changes in package functionality or API.
% 
% First, we need a counter for the x-ref system.
%    \begin{macrocode}
\newcounter{phfnotechanged}
%    \end{macrocode}
% 
% Mark changes in the implementation section of the package documentation
% with the command |\changed|\oarg{label
% name}\marg{v1.0}\marg{2016/05/22}\marg{description}.  This command
% automatically adds the change to the package's change history list, and
% allows you to refer to this change anywhere else in the package doc with
% |\changedreftext|.
%    \begin{macrocode}
\newcommand*\changed[4][]{%
%    \end{macrocode}
% 
% First, if no label is given as optional argument, then just display the
% change and add it to the package changes list.
%    \begin{macrocode}
  \if\relax\detokenize{#1}\relax%
    \changedtextfmt{#2}{#3}{#4}%
    \changes{#2}{#3}{#4}%
  \else%
%    \end{macrocode}
% 
% If a label name is provided as optional argument, then we need to write
% some stuff to the \texttt{.aux} file to make the change visible in the
% whole document.
%    \begin{macrocode}
    \protected@edef\phfnotechanged@tmpa{{#2}{#3}{#4}}%
    \immediate\write\@auxout{\string\phfnote@changed@set%
      {#1}{\expandonce\phfnotechanged@tmpa}}%
    \par\hspace*{0pt}\refstepcounter{phfnotechanged}\label{phfnotechanged:#1}%
    \begingroup\let\phfnote@changedreftext@par\relax
      \changedreftext[\@secondoftwo]{#1}%
    \endgroup
    \changes{#2}{#3}{\hyperref[phfnotechanged:#1]{#4}}%
  \fi
}
\def\phfnote@changed@set#1{%
  \expandafter\gdef\csname phfnote@changed@lbl@#1\endcsname%
}
%    \end{macrocode}
% 
% When you document changes with the help of |\changed|, you may refer to
% any specific change from anywhere else in the package doc with the help
% of |\changedreftext|\marg{label name}.
%    \begin{macrocode}
\def\phfnote@changedreftext@par{\par}
\newcommand*\changedreftext[2][\phfnote@changedrefto]{%
  \phfnote@changedreftext@par%
  \ifcsname phfnote@changed@lbl@#2\endcsname
    #1{#2}{%
      \expandafter\expandafter\expandafter\changedtextfmt%
          \csname phfnote@changed@lbl@#2\endcsname
    }
  \else
    \hyperref[phfnotechanged:#2]{%
      \changedtextfmt{???}{???}{[\textbf{missing ref}]}%
    }%
  \fi
  \par
}
\def\phfnote@changedrefto#1{\hyperref[phfnotechanged:#1]}
%    \end{macrocode}
% 
% The macro |\changedtextfmt|\marg{v1.0}\marg{2016/05/22}\marg{description}
% takes care of formatting the change on the spot.
%    \begin{macrocode}
\newcommand*\changedtextfmt[3]{%
  \textit{Changed in {#1\kern 0.3ex\relax[#2]}:} #3.
}
%    \end{macrocode}
% 
% \textbf{Provide environment \phfverb{pkgoptions}:} Set up an elaborate
% environment (based on a |description| environment) to describe package
% options.
%    \begin{macrocode}
\RequirePackage{enumitem}
\newlist{pkgoptions}{description}{1}
\setlist[pkgoptions]{font=\pkgoptionfmt@many[{\vspace*{5pt}}],style=nextline}
%    \end{macrocode}
% 
% But patch the |pkgoptions|' |\item| command, so that it puts an additional
% pair of braces around its argument.  In this way, the |font=| attribute for
% the list sees the full label as its next token, and can be used as a macro
% argument.  (This is not needed for newer versions of \pkgname{enumitem}.)
%    \begin{macrocode}
\def\pkgoptions@item{\@ifnextchar[\pkgoptions@item@\pkgoptions@item@@}%]
\def\pkgoptions@item@[#1]{\pkgoptions@old@item[{{#1}}]}%
\def\pkgoptions@item@@{\PackageWarning{phfnote}{{pkgoptions}: you must
    specify label to \string\item as \string\item[label].}%
  \pkgoptions@old@item}%
\apptocmd\pkgoptions{%
  \let\pkgoptions@old@item\item
  \let\item\pkgoptions@item
}{}{\PackageWarning{phfnote}{preset xpkgdoc: Failed to patch command
    \string\pkgoptions}}
%    \end{macrocode}
% 
% For convenience, also provide a |\meta|-like command for boolean arguments
% (|true| or |false|). `|\metatruefalsearg|' typesets as `\metatruefalsearg'.
%    \begin{macrocode}
\def\metatruefalsearg{\meta{\phfverb{true} $\mid$ \phfverb{false}}}
%    \end{macrocode}
% 
% Include also a command to format a package option.  Puts the option in a box
% in typewriter text style, and indexes it.  The optional argument is meant to
% be internal---it adds commands after the displayed text (use it to add, e.g.\@
% spacing).
%
% When indexing the packages, make sure to remove the protective braces if any.
%    \begin{macrocode}
\newcommand\pkgoptionfmt[2][]{%
  \begingroup\let\meta\pkgoptfmt@meta\pkgopt@fbox{\normalfont\ttfamily #2}\endgroup%
  \expandafter\phfnote@pkgdoc@index\expandafter{\@firstofone #2}%
  #1}
\newcommand\pkgoptionfmt@many[2][]{%
  \def\pkgoptionfmt@tmp@addcomma{}
  \def\do##1{\pkgoptionfmt@tmp@addcomma\pkgoptionfmt{\vphantom{#2}##1}%
    \def\pkgoptionfmt@tmp@addcomma{\hskip0.25em\relax,\hskip0.8em\relax}}%
  \expandafter\docsvlist\expandafter{\@firstofone #2}%
  #1}
\let\pkgopt@save@meta\meta
\def\pkgopt@fbox{\fbox}
\def\pkgoptfmt@meta#1{\begingroup\normalfont\itshape\pkgopt@save@meta{#1}\endgroup}
%    \end{macrocode}
% 
% Whenever a package option is formatted with |\pkgoptionfmt|, it is placed in
% the index.  Because package options may be of the form |key=val|, we want to
% split keys from values and put them independently in the index.  This is done
% by entering a \TeX{} group, and using an |\lccode| trick: the code is prepared
% to iterate over a list of comma-separated stuff, but then the ``lowercase''
% version of that code is executed instead, where the |=|'s have been replaced
% by |,|'s.
%    \begin{macrocode}
\def\phfnote@pkgdoc@index#1{%
  \begingroup\lccode`\= = `\,\relax%
    \def\x{\lowercase{\def\@tmpa{#1}}}%
    \x%
    \let\meta\@gobble%
    \let\marg\@gobble%
    \let\oarg\@gobble%
    \let\parg\@gobble%
    \let\vphantom\@gobble%
    \let\hphantom\@gobble%
    \let\pkgoptattrib\@firstofone%
    \let\pkgoptattribnodots\@firstofone%
    \let\pkgoptattribempty\@empty%
    \def\handleitemindex##1{%
      \edef\@tmpc{##1}%
      \if\relax\detokenize\expandafter{\@tmpc}\relax\else%
        \edef\@tmpb{{\expandonce\@tmpc=\string\verb!*+\expandonce\@tmpc+ (\pkgoptname)|hyperpage}}%
        \expandafter\index\@tmpb%
        \edef\@tmpb{{\packageoptionsname:>\expandonce\@tmpc=\string\verb!*+\expandonce\@tmpc+|hyperpage}}%
        \expandafter\index\@tmpb%
      \fi%
    }%
    \def\@tmpc{\forcsvlist{\handleitemindex}}%
    \expandafter\@tmpc\expandafter{\@tmpa}%
  \endgroup%
}
\def\pkgoptname{pkg. opt.}
\def\packageoptionsname{package options}
%    \end{macrocode}
%
% \textbf{Provide environment \phfverb{cmdoptions}:} hijack the |pkgoptions|
% environment to do the same thing, except we place the items in the index under
% ``command options'' instead of ``package options.''
%    \begin{macrocode}
\def\cmdoptions{\begingroup\setcmdnotpkgoptions
  \pkgoptions}
\def\endcmdoptions{\endpkgoptions\endgroup}
\newcommand\cmdoptionfmt[2][]{\begingroup\setcmdnotpkgoptions
  \pkgoptionfmt[{#1}]{#2}\endgroup}
\def\cmdoptname{cmd. opt.}
\def\commandoptionsname{command options}
\def\setcmdnotpkgoptions{\let\pkgoptname\cmdoptname
  \let\packageoptionsname\commandoptionsname
  \let\pkgopt@fbox\cmdoptionsfbox}
\def\cmdoptionsfbox#1{\ensuremath{\underline{{\text{#1}}}}}
%    \end{macrocode}
% 
% Provide the |\pkgoptattrib| command, which typesets its argument as
% |\{arg, ...\}|---useful to typeset attributes such as in
% \autoref{sec:abstract-attributes}.  The variant |\pkgoptattribondots{arg}|
% typesets |\{arg\}| while |\pkgoptattribempty| expands to |{}|.
%    \begin{macrocode}
\def\pkgoptattrib#1{\{#1,...\}}
\def\pkgoptattribnodots#1{\{#1\}}
\def\pkgoptattribempty{\{\}}
%    \end{macrocode}
% 
% \textbf{Colorful boxes: environments \phfverb{pkgnote},
%   \phfverb{pkgwarning}, and \phfverb{pkgtip}.}  Now, load the
% \pkgname{tcolorbox} package to provide visual ``Note,'' ``Warning,'' and
% ``Tip'' boxes.  Because \pkgname{tcolorbox} includes the
% \pkgname{verbatim} package which messes up the |verbatim| environment in
% latex dtx files (for which source lines all start with a |%| which needs
% to be stripped), we save the |verbatim|-related commands, and restore
% them after the interfering packages have been loaded.
%    \begin{macrocode}
\phfnoteSaveDefs{verbatimstuff}{%
  verbatim,@verbatim,@xverbatim,@sxverbatim,endverbatim}
\usepackage{tcolorbox}
\newtcolorbox{pkgnote}{
  colback=blue!5!white,
  colframe=blue!5!white,
  coltitle=blue!50!black,
  toptitle=1.5ex,
  fonttitle=\bfseries,
  title={NOTE}
}
\newtcolorbox{pkgwarning}{
  colback=red!5!white,
  colframe=red!5!white,
  coltitle=red!50!black,
  toptitle=1.5ex,
  fonttitle=\bfseries,
  title={WARNING}
}
\newtcolorbox{pkgtip}{
  colback=green!5!white,
  colframe=green!5!white,
  coltitle=green!50!black,
  toptitle=1.5ex,
  fonttitle=\bfseries,
  title={TIP}
}
\phfnoteRestoreDefs{verbatimstuff}
%    \end{macrocode}
%
% Patch the |verbatim| environment to remove extraneous space after the
% environment caused by I don't know what weird cause:
%    \begin{macrocode}
\appto\endverbatim{\vspace{-\baselineskip}}
%    \end{macrocode}
% 
% Common title stuff:
%    \begin{macrocode}
\def\phfqitltxPkgTitle#1{The \pkgname{#1} package\thanks{\itshape
  This document corresponds to \pkgname{#1}~\fileversion, dated \filedate. It
  is part of the
  \href{https://github.com/phfaist/phfqitltx/}{\pkgname{phfqitltx}} package
  suite, see \url{https://github.com/phfaist/phfqitltx}.}}
%    \end{macrocode}
% 
% Utility to parse package file date into ``|\today|''-style date: invoke as
% |\date{\pkgfmtdate\filedate}|.
%    \begin{macrocode}
\def\pkgfmtdate#1{%
  \edef\pkgfmtdate@thedate{#1}%
  \expandafter\pkgfmtdate@next\pkgfmtdate@thedate\@nil%
}
\def\pkgfmtdate@next#1/#2/#3\@nil{% YYYY/MM/DD
  \ifcase #2 \or January\or February\or March\or April\or May%
  \or June\or July\or August\or September\or October%
  \or November\or December\fi\space #3,%
  \space #1}
\robustify\pkgfmtdate@next
%    \end{macrocode}
%
%    \begin{verbatim}
%</phfnotepreset-xpkgdoc>
%    \end{verbatim}
% \iffalse
%<*package>
% \fi
%
%
%
%
%\Finale
%</package>
\endinput