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
|
% ==================== %
% == RESOURCES USED == %
% ==================== %
\begin{filecontents*}[overwrite]{gallery-showcase-bw.tex}
\documentclass[theme = bw]{tutodoc}
% -- FORDOC -- %
\usepackage[french]{babel}
\frenchsetup{StandardItemLabels=true}
\usepackage{multicol}
\usepackage{lastpage}
\makeatletter
\renewcommand*\pagemark{%
\usekomafont{pagenumber}{%
\thepage\kern1pt/\kern1pt\pageref*{LastPage}%
}%
}
\makeatother
\newcommand\thisstyle{bw}
\newcommand\myexrmktext{
\tdocversion{1.7.0}[2024-12-04]
Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal.
}
\newcommand\myadmotext{
Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance.
}
\newcommand\myhighlightedtextnonote{
Que dire ?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\myhighlightedtext{
Que dire\,%
\footnote{
N'oublions pas les notes de bas de page...
}?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\mychgestext{
Dans un journal de bord, il est important de bien visualiser les types de changements. Ceci rend plus efficace la lecture côté utilisateur !
}
\ExplSyntaxOn
\int_new:N \g__tutodoc_for_doc_int
\ExplSyntaxOff
\begin{document}
\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
\section{Liens}
{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit.
\section{Des codes \LaTeX}
Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant.
\begin{tdoclatex}
Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ?
\begin{tdoclatex}<\tdoctcb{sbs}>
Du code \LaTeX\ mis en forme, c'est top: \\
$E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
\section{Mettre en avant, versionner et dater}
\subsection{tdocexa, tdocrem}
\myexrmktext
\ExplSyntaxOn
\seq_map_inline:Nn \g__tutodoc_focus_std_seq {
\begin{tdoc#1}
\myhighlightedtext
\end{tdoc#1}
}
\ExplSyntaxOff
\subsection{tdocnote, tdoctip...}
\myadmotext
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\ifcsundef{g__tutodoc_focus_color_seq}{
\prop_map_inline:Nn \g__tutodoc_focus_color_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
} {
\seq_map_inline:Nn \g__tutodoc_focus_color_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
}
\ExplSyntaxOff
\subsection{tdocbreak, tdocfix...}
\tdocstartproj{Une nouvelle section démonstrative...}
\begin{tdoctodo}
\item Une galerie serait bienvenue...
\end{tdoctodo}
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\mychgestext
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\begin{tabular}{%
@{\hskip 0pt}p{.26\linewidth}%
*{3}{@{\hskip 7pt}p{.23\linewidth}}@{\hskip 0pt}%
}
\ifcsundef{g__tutodoc_topic_change_seq}{
\prop_map_inline:Nn \g__tutodoc_topic_change_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-12pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}{
\seq_map_inline:Nn \g__tutodoc_topic_change_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-5pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}
\end{tabular}
\ExplSyntaxOff
\end{document}
\end{filecontents*}
\begin{filecontents*}[overwrite]{gallery-showcase-color.tex}
\documentclass[theme = color]{tutodoc}
% -- FORDOC -- %
\usepackage[french]{babel}
\frenchsetup{StandardItemLabels=true}
\usepackage{multicol}
\usepackage{lastpage}
\makeatletter
\renewcommand*\pagemark{%
\usekomafont{pagenumber}{%
\thepage\kern1pt/\kern1pt\pageref*{LastPage}%
}%
}
\makeatother
\newcommand\thisstyle{color}
\newcommand\myexrmktext{
\tdocversion{1.7.0}[2024-12-04]
Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal.
}
\newcommand\myadmotext{
Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance.
}
\newcommand\myhighlightedtextnonote{
Que dire ?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\myhighlightedtext{
Que dire\,%
\footnote{
N'oublions pas les notes de bas de page...
}?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\mychgestext{
Dans un journal de bord, il est important de bien visualiser les types de changements. Ceci rend plus efficace la lecture côté utilisateur !
}
\ExplSyntaxOn
\int_new:N \g__tutodoc_for_doc_int
\ExplSyntaxOff
\begin{document}
\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
\section{Liens}
{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit.
\section{Des codes \LaTeX}
Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant.
\begin{tdoclatex}
Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ?
\begin{tdoclatex}<\tdoctcb{sbs}>
Du code \LaTeX\ mis en forme, c'est top: \\
$E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
\section{Mettre en avant, versionner et dater}
\subsection{tdocexa, tdocrem}
\myexrmktext
\ExplSyntaxOn
\seq_map_inline:Nn \g__tutodoc_focus_std_seq {
\begin{tdoc#1}
\myhighlightedtext
\end{tdoc#1}
}
\ExplSyntaxOff
\subsection{tdocnote, tdoctip...}
\myadmotext
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\ifcsundef{g__tutodoc_focus_color_seq}{
\prop_map_inline:Nn \g__tutodoc_focus_color_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
} {
\seq_map_inline:Nn \g__tutodoc_focus_color_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
}
\ExplSyntaxOff
\subsection{tdocbreak, tdocfix...}
\tdocstartproj{Une nouvelle section démonstrative...}
\begin{tdoctodo}
\item Une galerie serait bienvenue...
\end{tdoctodo}
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\mychgestext
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\begin{tabular}{%
@{\hskip 0pt}p{.26\linewidth}%
*{3}{@{\hskip 7pt}p{.23\linewidth}}@{\hskip 0pt}%
}
\ifcsundef{g__tutodoc_topic_change_seq}{
\prop_map_inline:Nn \g__tutodoc_topic_change_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-12pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}{
\seq_map_inline:Nn \g__tutodoc_topic_change_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-5pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}
\end{tabular}
\ExplSyntaxOff
\end{document}
\end{filecontents*}
\begin{filecontents*}[overwrite]{gallery-showcase-dark.tex}
\documentclass[theme = dark]{tutodoc}
% -- FORDOC -- %
\usepackage[french]{babel}
\frenchsetup{StandardItemLabels=true}
\usepackage{multicol}
\usepackage{lastpage}
\makeatletter
\renewcommand*\pagemark{%
\usekomafont{pagenumber}{%
\thepage\kern1pt/\kern1pt\pageref*{LastPage}%
}%
}
\makeatother
\newcommand\thisstyle{dark}
\newcommand\myexrmktext{
\tdocversion{1.7.0}[2024-12-04]
Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal.
}
\newcommand\myadmotext{
Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance.
}
\newcommand\myhighlightedtextnonote{
Que dire ?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\myhighlightedtext{
Que dire\,%
\footnote{
N'oublions pas les notes de bas de page...
}?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\mychgestext{
Dans un journal de bord, il est important de bien visualiser les types de changements. Ceci rend plus efficace la lecture côté utilisateur !
}
\ExplSyntaxOn
\int_new:N \g__tutodoc_for_doc_int
\ExplSyntaxOff
\begin{document}
\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
\section{Liens}
{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit.
\section{Des codes \LaTeX}
Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant.
\begin{tdoclatex}
Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ?
\begin{tdoclatex}<\tdoctcb{sbs}>
Du code \LaTeX\ mis en forme, c'est top: \\
$E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
\section{Mettre en avant, versionner et dater}
\subsection{tdocexa, tdocrem}
\myexrmktext
\ExplSyntaxOn
\seq_map_inline:Nn \g__tutodoc_focus_std_seq {
\begin{tdoc#1}
\myhighlightedtext
\end{tdoc#1}
}
\ExplSyntaxOff
\subsection{tdocnote, tdoctip...}
\myadmotext
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\ifcsundef{g__tutodoc_focus_color_seq}{
\prop_map_inline:Nn \g__tutodoc_focus_color_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
} {
\seq_map_inline:Nn \g__tutodoc_focus_color_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
}
\ExplSyntaxOff
\subsection{tdocbreak, tdocfix...}
\tdocstartproj{Une nouvelle section démonstrative...}
\begin{tdoctodo}
\item Une galerie serait bienvenue...
\end{tdoctodo}
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\mychgestext
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\begin{tabular}{%
@{\hskip 0pt}p{.26\linewidth}%
*{3}{@{\hskip 7pt}p{.23\linewidth}}@{\hskip 0pt}%
}
\ifcsundef{g__tutodoc_topic_change_seq}{
\prop_map_inline:Nn \g__tutodoc_topic_change_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-12pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}{
\seq_map_inline:Nn \g__tutodoc_topic_change_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-5pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}
\end{tabular}
\ExplSyntaxOff
\end{document}
\end{filecontents*}
\begin{filecontents*}[overwrite]{gallery-showcase-draft.tex}
\documentclass[theme = draft]{tutodoc}
% -- FORDOC -- %
\usepackage[french]{babel}
\frenchsetup{StandardItemLabels=true}
\usepackage{multicol}
\usepackage{lastpage}
\makeatletter
\renewcommand*\pagemark{%
\usekomafont{pagenumber}{%
\thepage\kern1pt/\kern1pt\pageref*{LastPage}%
}%
}
\makeatother
\newcommand\thisstyle{draft}
\newcommand\myexrmktext{
\tdocversion{1.7.0}[2024-12-04]
Dans le flot du texte, il est toujours utile de pouvoir indiquer des exemples et des remarques qui viennent compléter le contenu principal.
}
\newcommand\myadmotext{
Suivant le contexte d'utilisation, il est parfois nécessaire de pouvoir mettre en avant des contenus en indiquant leur degré d'importance.
}
\newcommand\myhighlightedtextnonote{
Que dire ?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\myhighlightedtext{
Que dire\,%
\footnote{
N'oublions pas les notes de bas de page...
}?
Je ne sais pas, mais c'est sympathique. Non ?
}
\newcommand\mychgestext{
Dans un journal de bord, il est important de bien visualiser les types de changements. Ceci rend plus efficace la lecture côté utilisateur !
}
\ExplSyntaxOn
\int_new:N \g__tutodoc_for_doc_int
\ExplSyntaxOff
\begin{document}
\textsf{\Huge\bfseries Le thème \texttt{"\thisstyle"}}
\section{Liens}
{\Large\bfseries \href{https://github.com/bc-tools/for-latex/tree/main/tutodoc}{Un lien très gros}}, mais au moins on le voit.
\section{Des codes \LaTeX}
Taper du code \LaTeX\ en ligne comme \tdoclatexin{E = m c^2 \neq \pi \neq \frac{3}{14}} est utile, tout comme montrer des cas d'utilisation comme le suivant.
\begin{tdoclatex}
Du code \LaTeX\ mis en forme, c'est top : $E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
On dispose aussi d'un mode côte-à-côte moins envahissant. Sympa ! Non ?
\begin{tdoclatex}<\tdoctcb{sbs}>
Du code \LaTeX\ mis en forme, c'est top: \\
$E = m c^2$ ou $\pi \neq \frac{3}{14}$.
\end{tdoclatex}
\section{Mettre en avant, versionner et dater}
\subsection{tdocexa, tdocrem}
\myexrmktext
\ExplSyntaxOn
\seq_map_inline:Nn \g__tutodoc_focus_std_seq {
\begin{tdoc#1}
\myhighlightedtext
\end{tdoc#1}
}
\ExplSyntaxOff
\subsection{tdocnote, tdoctip...}
\myadmotext
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\ifcsundef{g__tutodoc_focus_color_seq}{
\prop_map_inline:Nn \g__tutodoc_focus_color_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
} {
\seq_map_inline:Nn \g__tutodoc_focus_color_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\begin{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 1 }
{ \myhighlightedtext }
{ \myhighlightedtextnonote }
\end{tdoc#1}
}
}
\ExplSyntaxOff
\subsection{tdocbreak, tdocfix...}
\tdocstartproj{Une nouvelle section démonstrative...}
\begin{tdoctodo}
\item Une galerie serait bienvenue...
\end{tdoctodo}
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\mychgestext
\ifcsundef{g__tutodoc_topic_change_seq}{
\medskip
}{}
\ExplSyntaxOn
\int_set:Nn \g__tutodoc_for_doc_int { 0 }
\begin{tabular}{%
@{\hskip 0pt}p{.26\linewidth}%
*{3}{@{\hskip 7pt}p{.23\linewidth}}@{\hskip 0pt}%
}
\ifcsundef{g__tutodoc_topic_change_seq}{
\prop_map_inline:Nn \g__tutodoc_topic_change_prop {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-12pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}{
\seq_map_inline:Nn \g__tutodoc_topic_change_seq {
\int_gincr:N \g__tutodoc_for_doc_int
\vspace{-5pt}
\begin{tdoc#1}
\item Infos...
\end{tdoc#1}
\int_compare:nTF
{\g__tutodoc_for_doc_int = 4 }
{ \\ }
{ & }
}
}
\end{tabular}
\ExplSyntaxOff
\end{document}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-tech.tex}
\begin{tdoctech}
\item Info 1...
\item Info 2...
\end{tdoctech}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-para-title.tex}
\paragraph{Un titre bien versionné.}
\tdocversion{1.2.3}[2024-11-23]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
Bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli...
Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo...
\tdocdate{2024-11-23}
\paragraph{Un titre mal versionné.}
Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu...
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-dating.tex}
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\medskip % ATTENTION ! Ceci évite le chevauchement.
\tdocdate{2023-09-24}
Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\medskip % ATTENTION ! Ceci évite le chevauchement.
\tdocdate[gray]{2020-05-08}
Bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli, bli...
Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo...
Blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu, blu...
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-user-choice-icon.tex}
\begin{tdoctopic}{À cacher}<\faEyeSlash>
% Une icône venant de fontawesome5.
\item Info 1...
\item Info 2...
\end{tdoctopic}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-user-choice.tex}
\begin{tdoctopic}{La fin des icônes}
\item Info 1...
\item Info 2...
\end{tdoctopic}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-versioning.tex}
\tdocversion[red]{10.2.0-beta}[2023-12-01]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\smallskip\bigskip % ATTENTION ! Ceci évite le chevauchement.
\tdocversion{10.2.0-alpha}
Ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble,
ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble,
ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble,
ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble, ble...
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-pb.tex}
\begin{tdocprob}
\item Info 1...
\item Info 2...
\end{tdocprob}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-todo.tex}
\begin{tdoctodo}
\item Info 1...
\item Info 2...
\end{tdoctodo}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-update.tex}
\begin{tdocupdate}
\item Info 1...
\item Info 2...
\end{tdocupdate}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-what-n-when.tex}
\begin{tdoctech}[date = 2024-10-29,
col-chges = red]
\item Info...
\end{tdoctech}
\begin{tdocupdate}[version = 1.2.3,
col-chges = ForestGreen,
col = ForestGreen]
\item Info...
\end{tdocupdate}
\begin{tdoctopic}{À cacher}<\faEyeSlash>%
[version = 4.5.6,
date = 2025-11-30]
\item Info...
\end{tdoctopic}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-new.tex}
\begin{tdocnew}
\item Info 1...
\item Info 2...
\end{tdocnew}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-manual-setting.tex}
Voilà ce que cela donne sans déplacement vertical.
\paragraph{Un réglage maison.}%
\tdocversion{1.2.3}[2024-10-29]<0pt>
Blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo, blo...
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-first.tex}
\tdocstartproj{Première version du projet.}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-color-chges-first.tex}
\tdocstartproj[DarkOrchid]%
{Version 1 chamarrée.}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-break.tex}
\begin{tdocbreak}
\item Info 1...
\item Info 2...
\end{tdocbreak}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-color-chges-fix.tex}
\begin{tdocfix}[col = CadetBlue]
\item Info...
\end{tdocfix}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-version-n-change-chges-fix.tex}
\begin{tdocfix}
\item Info 1...
\item Info 2...
\end{tdocfix}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-exa-leavevmode.tex}
\begin{tdocexa}
\leavevmode
\begin{enumerate}
\item Point 1.
\item Point 2.
\end{enumerate}
\end{tdocexa}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-important.tex}
\begin{tdocimp}
Un truc important sans danger.
\end{tdocimp}
\begin{tdocimp}[Mini titre]
Utile ?
\end{tdocimp}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-note.tex}
\begin{tdocnote}
Un truc utile à vous dire...
\end{tdocnote}
\begin{tdocnote}[Mini titre]
Utile ?
\end{tdocnote}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-caution.tex}
\begin{tdoccaut}
Prudence, prudence...
\end{tdoccaut}
\begin{tdoccaut}[Mini titre]
Utile ?
\end{tdoccaut}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-tip.tex}
\begin{tdoctip}
Une astuce.
\end{tdoctip}
\begin{tdoctip}[Mini titre]
Utile ?
\end{tdoctip}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-warn.tex}
\begin{tdocwarn}
Evitez les dangers...
\end{tdocwarn}
\begin{tdocwarn}[Mini titre]
Utile ?
\end{tdocwarn}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-exa.tex}
\begin{tdocexa}
Un exemple...
\end{tdocexa}
\begin{tdocexa}[Mini titre]
Utile ?
\end{tdocexa}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-leavevmode-items.tex}
\begin{tdoctip}[Peu élégant]
\begin{enumerate}
\item Point 1.
\item Point 2.
\end{enumerate}
\end{tdoctip}
VERSUS.
\begin{tdoctip}[Plus élégant]
\begin{enumerate}[wide]
\item Point 1.
\item Point 2.
\end{enumerate}
\end{tdoctip}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-admonitions-rmk.tex}
\begin{tdocrem}
Juste une remarque...
\end{tdocrem}
\begin{tdocrem}[Mini titre]
Utile ?
\end{tdocrem}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-full-hello-you.tex}
\NewDocumentCommand{\helloyou}{m}{%
\IfBlankTF{#1}{%
Ah, pas très bavard aujourd'hui !%
}{%
Bonjour #1.
Épatant ! En fait, pas du tout...%
}%
}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-full-input-hello-you-hs.tex}
\tdoccodeinput{hs}{examples-listing-full-hello-you.hs}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-full-hello-you.hs}
main :: IO ()
main = do
putStr "Qui êtes-vous ? "
name <- getLine
if name == ""
then putStrLn "Ah, pas très bavard aujourd'hui !"
else do
putStrLn ("Bonjour " ++ name ++ ".")
putStrLn "Épatant ! En fait, pas du tout..."
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-full-hello-you-lua.tex}
\begin{tdoccode}[style = solarized-light, linenos]%
<leftrule = 22pt, colback = orange!5, colframe = red!35>%
{lua}
io.write("Qui êtes-vous ? ")
local name = io.read()
if name == "" then
print("Ah, pas très bavard aujourd'hui !")
else
print("Bonjour " .. name .. ".")
print("Épatant ! En fait, pas du tout...")
end
\end{tdoccode}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-full-hello-you-perl.tex}
\begin{tdoccode}{pl}
print "Qui êtes-vous ? ";
my $name = <STDIN>;
chomp($name);
if ($name eq "") {
print "Ah, pas très bavard aujourd'hui !\n";
} else {
print "Bonjour $name.\n";
print "Épatant ! En fait, pas du tout...\n";
}
\end{tdoccode}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-full-input-hello-you-tex.tex}
\tdoccodeinput[style = solarized-light, linenos]%
<leftrule = 22pt, colback = orange!5, colframe = red!35>%
{tex}{examples-listing-full-hello-you.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-hook.tex}
\begin{tdocshowcase}[]
[Cela fonctionne...]
\end{tdocshowcase}
OU.
\begin{tdocshowcase}
\string[Cela fonctionne aussi...]
\end{tdocshowcase}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-rule.tex}
\begin{tdocshowcase}[style = rule]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-stripe-custom.tex}
\begin{tdocshowcase}[style = stripe,
col-stripe = green,
col-text = purple,
before = Mon début,
after = Ma fin à moi]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-input-stripe.tex}
\tdocshowcaseinput[style = stripe,
col-stripe = red,
col-text = LightCoral]%
{examples-showcase-external.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-rule-custom.tex}
\begin{tdocshowcase}[style = rule,
col-stripe = red,
col-text = orange!75!black,
before = Mon début,
after = Ma fin à moi]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-external.tex}
Blablobli, blablobli, blablobli, blablobli, blablobli, blablobli...
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-default.tex}
\begin{tdocshowcase}
\bfseries Un peu de code \LaTeX.
\bigskip
\emph{\large Fin de l'affreuse démo.}
\end{tdocshowcase}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-stripe.tex}
\begin{tdocshowcase}[style = stripe]
Bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla, bla...
\end{tdocshowcase}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-input-default.tex}
\tdocshowcaseinput{examples-showcase-external.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-showcase-input-rule.tex}
\tdocshowcaseinput[style = rule]{examples-showcase-external.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-latexshow-options.tex}
\tdoclatexshow[style = stripe,
col-stripe = orange,
col-text = blue!70!black,
before = Rendu ci-après.,
explain = Ce qui vient est coloré...,
after = Rendu fini.,]
{examples-listing-latex-xyz.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-ABC.tex}
\begin{tdoclatex}<\tdoctcb{sbs}>
$A = B + C$
\end{tdoclatex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-xyz.tex}
% Juste une démo.
$x y z = 1$
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-latexinput-option-std.tex}
\tdoclatexinput{examples-listing-latex-xyz.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-strange.tex}
\begin{tdoclatex}[]
[Étrange... Ou pas !]
\end{tdoclatex}
OU.
\begin{tdoclatex}<>
<Étrange... Ou pas !>
\end{tdoclatex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-ABC-custom.tex}
\begin{tdoclatex}%
[linenos, style = igor, showspaces]%
<\tdoctcb{sbs},
attach boxed title to top left = {yshift = -9pt},
fonttitle = \bfseries,
title = Modifications locales,
top = 10pt>
% Parfois utile, mais ne pas en abuser !
$A = B + C$
% Fin de cette démonstration.
\end{tdoclatex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-latexinput-option-sbs.tex}
\tdoclatexinput<\tdoctcb{sbs}>{examples-listing-latex-xyz.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-latexinput-option-code.tex}
\tdoclatexinput<\tdoctcb{code}>{examples-listing-latex-xyz.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-latexinput-option-perso.tex}
\tdoclatexinput[style = igor, showspaces]%
<colframe = purple, colback = red!5>%
{examples-listing-latex-xyz.tex}
\end{filecontents*}
\begin{filecontents*}[overwrite]{examples-listing-latex-strange-bis.tex}
\begin{tdoclatex}
\string[Étrange... Ou pas !]
\end{tdoclatex}
OU.
\begin{tdoclatex}
\string<Étrange... Ou pas !>
\end{tdoclatex}
\end{filecontents*}
% ======================== %
% == SOURCE FOR THE DOC == %
% ======================== %
\documentclass{tutodoc}
% Community tools
\usepackage[T1]{fontenc}
\usepackage{enumitem}
\usepackage[french]{babel, varioref}
\frenchsetup{StandardItemLabels=true}
\usepackage{multicol}
\usepackage{tasks}
\usepackage{pdfpages}
\includepdfset{
pages=-,
fitpaper=true
}
% Some useful commands.
\newcommand\thisproj{\tdoccls{tutodoc}}
\newcommand\thisrepo{\url{https://github.com/bc-tools/for-latex/tree/tutodoc}}
\newcommand\thismonorepo{\url{https://github.com/bc-tools/for-latex}}
\NewDocumentCommand{\trademark}{m}{\texttt{#1}}
\newcommand\ctan{\href{https://ctan.org/}{\trademark{CTAN}}}
\newcommand\git{\trademark{git}}
\newcommand\pdf{\trademark{PDF}}
\newcommand\brainfuck{\trademark{Brainfuck}}
\newcommand\lua{\trademark{Lua}}
\newcommand\perl{\trademark{Perl}}
\newcommand\python{\trademark{Python}}
\newcommand\pygmentsREF{\href{https://pygments.org/}{\trademark{Pygments}}}
\NewDocumentCommand{\mailsubject}{m}% <-- Translate me!
{sujet \tdocquote{\texttt{tutodoc - CONTRIB - #1}}}
% Source: https://tex.stackexchange.com/a/424061/6880
\newcommand{\FTdirO}{}
\def\FTdirO(#1,#2,#3){%
\FTfile(#1,{\color{blue!40!black}\faFolderOpen\hspace{-.35pt}}{\hspace{0.2em}#3})
(tmp.west)++(0.8em,-0.4em)node(#2){}
(tmp.west)++(1.5em,0)
++(0,-1.3em)
}
\newcommand{\FTdirC}{}
\def\FTdirC(#1,#2,#3){%
\FTfile(#1,{\color{blue!40!black}\faFolder\hspace{.75pt}}{\hspace{0.2em}#3})
(tmp.west)++(0.8em,-0.4em)node(#2){}
(tmp.west)++(1.5em,0)
++(0,-1.3em)
}
\newcommand{\FTfile}{}
\def\FTfile(#1,#2){%
node(tmp){}
(#1|-tmp)++(0.6em,0)
node(tmp)[anchor=west,black]{\texttt{#2}}
(#1)|-(tmp.west)
++(0,-1.2em)
}
\newcommand{\FTroot}{}
\def\FTroot{tmp.west}
\newcommand\contribtranslatedirtree{
\begin{tikzpicture}%
\draw[color=black, thick]
% en : parent = \FTroot
% normal dir: (parentID, currentID, label)
% file : (parentID, label)
\FTdirO(\FTroot,root,translate){
\FTdirC(root,changes,changes){
}
\FTdirO(root,en,en) {
\FTdirC(en,api,api) {
}
\FTdirC(en,doc,doc) {
}
}
\FTdirC(root,fr,fr){
}
\FTdirC(root,status,status){
\FTdirO(status,en,en) {
\FTfile(en,api.yaml)
\FTfile(en,manual.yaml)
}
\FTdirC(status,fr,fr){
}
}
\FTfile(root,README.md)
\FTfile(root,LICENSE.txt)
};
\end{tikzpicture}
}
\begin{document}
\title{La classe \texttt{tutodoc} \\ Documentation de type tutoriel}
\author{Christophe, BAL}
\date{18 déc. 2024 - Version 1.7.1}
\maketitle
\begin{abstract}
La classe \thisproj{}\,%
\footnote{
Le nom vient de \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}} qui se traduit en \tdocquote{documentation de type tutoriel}.
}
est utilisée par son auteur pour produire de façon sémantique des documentations de packages et de classes \LaTeX\ dans un style de type tutoriel\,%
\footnote{
L'idée est de produire un fichier \texttt{PDF} efficace à parcourir pour des besoins ponctuels. C'est généralement ce que l'on attend d'une documentation liée au codage.
}
avec un rendu sobre pour une lecture sur écran.
\smallskip
\noindent
\emph{\textbf{Remarque :} cette documentation est aussi disponible en anglais.}
\smallskip
\tdocsep
\small
\itshape
\vspace{-5pt}
\begin{center}
\textbf{Abstract.}
\end{center}
The \thisproj{} class\,%
\footnote{
The name comes from \tdocquote{\tdocprewhy{tuto.rial-type} \tdocprewhy{doc.umentation}}.
}
is used by its author to semantically produce documentation of \LaTeX\ packages and classes in a tutorial style\,%
\footnote{
The idea is to produce an efficient \texttt{PDF} file that can be browsed for one-off needs. This is generally what is expected for a coding documentation.
}
with a sober rendering for reading on screen.
\smallskip
\noindent
\emph{\textbf{Remark :} this documentation is also available in French.}
\end{abstract}
\tdocsep
{
\small
\bgroup
\addtokomafont{subsection}{\centering}
\subsection*{Derniers changements}
\egroup
\begin{tdocfix}
\item Documentation: les références aux outils pour indiquer des changements ont été incorrectement écrites comme caractéristiques des contenus colorés mis en avant.
\end{tdocfix}
\begin{tdocbreak}
\item La macro \tdocmacro{tdocenv} et sa version étoilée ne proposent plus d'option.
\item Cas d'utilisation \LaTeX: la présentation par défaut est plus sobre, et des options permettent d'ajouter les lignes cadrantes, ou la bande colorée. Voir juste après.
\end{tdocbreak}
\begin{tdocnew}
\item Mise en forme de codes informatiques en plus de ceux spécifiquement en \LaTeX.
%
\begin{enumerate}
\item Création de \tdocenv{tdoccode} et de \tdocmacro{tdoccodein}.
\item Pour les macros pour du code en ligne, et les environnements pour des blocs de code, des options de type \tdocpack{minted} s'indiquent à l'intérieur de crochet de manière traditionnelle: \tdoclatexin{[options minted]}\,.
\item Pour les environnements pour des blocs de code, des options de type \tdocpack{tcolorbox} s'indiquent à l'intérieur de chevrons: \tdoclatexin{<options tcolorbox>}\,.
\item La nouvelle macro \tdocmacro{tdoctcb} permet d'utiliser des raccourcis pour les styles \tdocpack{tcolorbox} régulièrement utilisés.
\end{enumerate}
\item Documentation: une nouvelle section présente les outils de mise en forme de codes informatiques autres que les cas d'utilisation de \LaTeX.
\end{tdocnew}
\begin{tdocupdate}
\item Les sous-sous-sections sont numérotées en lettres minuscules.
\item Thèmes.
%
\begin{enumerate}
\item Moins d'espace consommé.
\item Les ombres ont une meilleure coloration.
\item Pour tous les thèmes sauf le \tdoclatexin{draft}, le rayon des arcs des coins des cadres passe de \tdoclatexin{.75mm} à \tdoclatexin{.2pt}\,.
\item Cas d'utilisation de \LaTeX: avec le thème \tdoclatexin{color}, la couleur du fond passe de \tdoclatexin[bgcolor = yellow!4]{yellow!4} à \tdoclatexin{gray!5}.
\item Dernières modifications: avec le thème \tdoclatexin{dark}, le texte \tdoclatexin{[Init]} produit par la macro \tdocmacro{tdocstartproj} utilise la même police que celle des titres des environnements pour indiquer des changements.
\end{enumerate}
\end{tdocupdate}
}
\newpage
\tableofcontents
\newpage
\section{Dépendances}
\thisproj\ admet les dépendances suivantes (les dates entre parenthèses sont celles des versions utilisées lors des derniers tests).
%
\begin{tasks}[style=itemize](2)
\task \texttt{scrartcl.cls}
\hfill {\small (2024/10/24)}\kern10pt
\task \texttt{clrstrip.sty}
\hfill {\small (2021/08/28)}\kern10pt
\task \texttt{csquotes.sty}
\hfill {\small (2024/04/04)}\kern10pt
\task \texttt{fontawesome5.sty}
\hfill {\small (2022/05/02)}\kern10pt
\task \texttt{geometry.sty}
\hfill {\small (2020/01/02)}\kern10pt
\task \texttt{hyperref.sty}
\hfill {\small (2024/11/05)}\kern10pt
\task \texttt{inputenc.sty}
\hfill {\small (2024/02/08)}\kern10pt
\task \texttt{keytheorems.sty}
\hfill {\small (2024/11/11)}\kern10pt
\task \texttt{marginnote.sty}
\hfill {\small (2018/08/09)}\kern10pt
\task \texttt{minted.sty}
\hfill {\small (2024/11/17)}\kern10pt
\task \texttt{tcolorbox.sty}
\hfill {\small (2024/10/22)}\kern10pt
\end{tasks}
\section{Réglages généraux}
\subsection{Taille de la police et géométrie de la page}
La classe \tdoccls{scrartcl} est chargée via l'option \tdoclatexin{fontsize = 10pt}\,, et le package \tdocpack{geometry} gère les dimensions de la page.
\begin{tdocwarn}
Les macros pour dater et versionner présentées dans la section \ref{tutodoc-changes} page \pageref{tutodoc-changes} ont besoin de réglages fixes pour la géométrie des pages et la taille de la police.
\end{tdocwarn}
\subsection{Titres et table des matières}
Les réglages choisis sont directement visibles dans cette documentation.
\subsection{Liens dynamiques}
Le package \tdocpack{hyperref} est importé, si ce n'est pas fait, et les réglages choisis portent juste sur les couleurs des liens relatifs aux citations, aux fichiers, aux liens internes, et enfin aux \verb#url# (ces couleurs dépendent du thème choisi).
\section{Quelle langue est utilisée par la classe \thisproj\ ?}
Cette documentation charge le package \tdocpack{babel} via \tdoclatexin|\usepackage[french]{babel}|\, un package que \thisproj\ ne charge pas.
En revanche, la classe \thisproj\ identifie \tdoclatexin|fr| comme la langue principale utilisée par \tdocpack{babel}.%
\footnote{
Techniquement, on utilise \tdoclatexin|\BCPdata{language}| qui renvoie une langue au format court.
}
Comme cette langue fait partie de la liste des langues prises en compte, voir ci-dessous, la classe \thisproj\ produira les effets attendus.
\begin{tasks}[label=\small\textbullet](3)
\task \tdoclatexin|en| : anglais.
\task \tdoclatexin|es| : espagnol.
\task \tdoclatexin|fr| : français.
\end{tasks}
\begin{tdocnote}
Les packages \tdocpack{babel} et \tdocpack{polyglossia} sont pris en compte.
\end{tdocnote}
\begin{tdoccaut}
Si le choix de la langue principale n'est pas faite dans le préambule, le mécanisme employé échouera avec des effets de bord non voulus (voir l'avertissement qui suit).
\end{tdoccaut}
\begin{tdocwarn}
Lorsqu'une langue n'est pas prise en compte par \thisproj, un message d'avertissement est émis, et l'anglais est alors choisi comme langue vis-à-vis de \thisproj.
\end{tdocwarn}
\section{Cela veut dire quoi en \tdocquote{anglais}}
Penser aux non-anglophones est bien, même si ces derniers se font de plus en plus rares.
\begin{tdoclatex}
Cool et top signifient \tdocinEN*{cool} et \tdocinEN{top}.
\end{tdoclatex}
La macro \tdocmacro{tdocinEN} et sa version étoilée s'appuient sur \tdocmacro{tdocquote} : par exemple, \tdocquote{sémantique} s'obtient via \tdoclatexin|\tdocquote{sémantique}|\,.
\begin{tdocnote}
Le texte \tdocquote{en anglais} est traduit dans la langue détectée par \thisproj.
\end{tdocnote}
Dans le contenu entre guillemets, les règles linguistiques anglaises sont respectées comme le montre l'exemple suivant.
\begin{tdoclatex}<\tdoctcb{sbs}>
Test: \tdocquote{OK?} \\
\tdocinEN{Test: \tdocquote{OK?}}
\end{tdoclatex}
\section{Choisir son thème}
Pour modifier la mise en forme générale, la classe \thisproj\ propose l'option \tdoclatexin{theme = <choix>} où \tdoclatexin{<choix>} peut prendre les valeurs suivantes.
\begin{tasks}[style=itemize]
\task \tdoclatexin{bw}:
un thème de type noir-et-blanc avec certaines nuances de gris.
\task \tdoclatexin{color}:
un thème coloré : c'est \emph{la valeur par défaut}.
\task \tdoclatexin{dark}:
un thème sombre idéal pour se reposer les yeux.
\task \tdoclatexin{draft}:
un thème pour une impression papier à la recherche d'erreurs de contenu pas forcément simples à débusquer devant un écran.
\end{tasks}
\begin{tdocnote}
À la fin de ce document, après l'historique des changements, vous trouverez une galerie de cas d'utilisation de ces différents thèmes : se rendre à l'annexe page \pageref{tutodoc-theme-gallery}.
\end{tdocnote}
% ----------------------------- %
% -- AT END DOCUMENT - START -- %
% ----------------------------- %
% The following AT-END-DOCUMENT lines of codes have been generated
% automatically. Don't judge their relative beauty...
\AtEndDocument{
% An annex page for a pretty doc.
\newpage
\bgroup
\setkomafont{section}{\Huge\bfseries}
\addtokomafont{section}{\centering}
\phantomsection\section*{Annexe -- Galerie des thèmes}%
\label{tutodoc-theme-gallery}
\addcontentsline{toc}{section}{Annexe -- Galerie des thèmes}%
\egroup
\bigskip\bigskip
\begin{tdocnote}
Chaque exemple est un \pdf\ directement inséré dans ce document (ne soyez donc pas surpris par la numérotation des pages).
\end{tdocnote}
\newpage
% Let's build the PDFs.
\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-bw}
\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-color}
\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-dark}
\immediate\write18{SOURCE_DATE_EPOCH=0 FORCE_SOURCE_DATE=1 latexmk -shell-escape -pdflatex gallery-showcase-draft}
% The gallery starts here...
\includepdf{gallery-showcase-bw}
\includepdf{gallery-showcase-color}
\includepdf{gallery-showcase-dark}
\includepdf{gallery-showcase-draft}
}
% --------------------------- %
% -- AT END DOCUMENT - END -- %
% --------------------------- %
\section{Mettre en avant du contenu}
\begin{tdocnote}
Les environnements présentés dans cette section\,%
\footnote{
La mise en forme provient du package \tdocpack{keytheorems}.
}
ajoutent un court titre indiquant le type d'informations fournies.
Ce court texte sera toujours traduit dans la langue repérée par la classe \thisproj.
\end{tdocnote}
\subsection{Du contenu dans le flot de la lecture}
\begin{tdocimp}
Tous les environnements présentés dans cette section partagent le même compteur qui sera remis à zéro dès que \tdoclatexin|\section| est employée.
\end{tdocimp}
\subsubsection{Des exemples}
Des exemples numérotés s'indiquent via \tdocenv{tdocexa} qui propose un argument optionnel pour ajouter un mini-titre.
Voici deux usages possibles.
\tdoclatexinput<\tdoctcb{sbs}>{examples-admonitions-exa.tex}
\begin{tdoctip}
Il peut parfois être utile de revenir à la ligne dès le début du contenu. Le code suivant montre comment faire (ce tour de passe-passe reste valable pour l'environnement \verb#tdocrem# présenté juste après). Noter au passage que la numérotation suit celle de l'exemple précédent comme souhaité.
\end{tdoctip}
\tdoclatexinput<\tdoctcb{sbs}>{examples-admonitions-exa-leavevmode.tex}
%\subsection{Du contenu dans le flot de la lecture}
\subsubsection{Des remarques}
Tout se passe via \tdocenv{tdocrem} avec un fonctionnement identique à l'environnement \tdocenv*{tdocexa} comme le montre l'exemple suivant.
\tdoclatexinput<\tdoctcb{sbs}>{examples-admonitions-rmk.tex}
\subsection{Du contenu tape-à-l'oeil}
\label{tutodoc-admonitions}
\begin{tdocnote}
La mise en forme proposée ici est celle par défaut, mais d'autres sont possible en changeant de thème : voir la galerie de cas d'utilisation dans l'annexe page \pageref{tutodoc-theme-gallery}.
Quant aux icônes, elles sont obtenues via le package \tdocpack{fontawesome5} et la macro \tdocmacro{tdocicon} qui gère l'espacement vis-à-vis du texte.%
\footnote{
Par exemple,
\tdoclatexin|\fbox{\tdocicon{\faBed}{Fatigué}}|
produit\,
\fbox{\tdocicon{\faBed}{Fatigué}}\,.
}
\end{tdocnote}
\subsubsection{Une astuce}
L'environnement \tdocenv*{tdoctip} sert à donner des astuces. Voici comment l'employer.
\tdoclatexinput<\tdoctcb{sbs}, bottom = 3pt, top = 3pt>{examples-admonitions-tip.tex}
\smallskip
\begin{tdoctip}
Quelque fois, un contenu mis en avant peut se réduire à une liste. Dans ce cas, la mise en forme peut être améliorée comme suit où nous utilisons l'option \tdoclatexin{wide} du package \tdocpack{enumitem} qui est importé par cette documentation.
\tdoclatexinput<\tdoctcb{sbs}, bottom = 3pt, top = 3pt>{examples-admonitions-leavevmode-items.tex}
\end{tdoctip}
\foreach \sectitle/\desc/\filename in {
{Note informative}/% <-- Translate me!
{L'environnement \tdocenv*{tdocnote} sert à mettre en avant des informations utiles. Voici comment l'utiliser.}/% <-- Translate me!
note,
%
{Un truc important}/% <-- Translate me!
{L'environnement \tdocenv*{tdocimp} permet d'indiquer quelque chose d'important mais sans danger.}/% <-- Translate me!
important,
%
{Avertir d'un point très délicat}/% <-- Translate me!
{L'environnement \tdocenv*{tdoccaut} sert à pointer quelque chose de délicat. Voici comment l'employer.}/%<-- Translate me!
caution,
%
{Avertir d'un danger}/% <-- Translate me!
{L'environnement \tdocenv*{tdocwarn} permet d'avertir l'utilisateur d'un piège à éviter. Voici comment l'employer.}/% <-- Translate me!
warn%
} {
\subsubsection{\sectitle}
\desc
\tdoclatexinput<\tdoctcb{sbs}, bottom = 3pt, top = 3pt>{examples-admonitions-\filename.tex}
}
\section{Indiquer des packages, des classes, des macros ou des environnements}
Voici ce qu'il est possible de taper de façon sémantique.
\begin{tdoclatex}<\tdoctcb{sbs}>
\tdoccls{maclasse} sert à... \\
\tdocpack{monpackage} est pour... \\
\tdocmacro{unemacro} permet de... \\
\tdocenv{env} produit... \\
Juste \tdocenv*{env}...
\end{tdoclatex}
\begin{tdocrem}
Contrairement à \tdocmacro{tdoclatexin}, les macros \tdocmacro{tdocmacro}, \tdocmacro{tdocenv} et \tdocmacro{tdocenv*} ne colorent pas le texte produit.
De plus, \tdoclatexin{\tdocenv{monenv}} produit \tdocenv{monenv} avec des espaces sécables afin d'autoriser des retours à la ligne si besoin.
\end{tdocrem}
\section{Origine d'un préfixe ou d'un suffixe}
Pour expliquer les noms retenus, rien de tel que d'indiquer et expliciter les courts préfixes et suffixes employés. Ceci se fait facilement comme suit.
\begin{tdoclatex}<\tdoctcb{sbs}>
\tdocpre{sup} est relatif à... \\
\tdocprewhy{sup.erbe} signifie... \\
\emph{\tdocprewhy{sup.er} pour...}
\end{tdoclatex}
\begin{tdocrem}
Le choix du point pour scinder un mot permet d'utiliser des mots avec un tiret comme dans \tdoclatexin+\tdocprewhy{ca.sse-brique}+ qui donne \tdocprewhy{ca.sse-brique}.
\end{tdocrem}
\section{Un rendu en situation réelle}
\label{tutodoc-showcase}
Il est parfois utile d'obtenir directement le rendu d'un code dans la documentation. Ceci nécessite que ce type de rendu soit dissociable du texte donnant des explications.
\subsection{Un rendu minimaliste par défaut}
\begin{tdocexa}
Il peut être utile de montrer un rendu réel directement dans un document.%
\footnote{
Typiquement lorsque l'on fait une démo.
}
Ceci se tape via l'environnement \tdocenv*{tdocshowcase} comme suit.
\tdoclatexshow[explain = {On obtient alors le rendu suivant qui est la combinaison d'un faible espacement vertical et d'une simple importation.}]{examples-showcase-default.tex}
\end{tdocexa}
\begin{tdocrem}
La section \ref{tutodoc-listing-latexshow} page \pageref{tutodoc-listing-latexshow} explique comment obtenir, via la macro \tdocmacro{tdoclatexshow}, un code suivi de son rendu réel comme dans l'exemple précédent.
\end{tdocrem}
\begin{tdocwarn}
Avec les paramètres par défaut, si le code à formater commence par un crochet ouvrant, il faut utiliser l'une des astuces suivantes.
\tdoclatexshow[explain = {Ceci produira ce qui suit.}]{examples-showcase-hook.tex}
\end{tdocwarn}
\subsection{Avec des lignes cadrantes}
Pour rendre plus visible le code \LaTeX\ mis en forme, on peut faire appel au style \tdoclatexin{rule} comme dans les exemple suivants.
\begin{tdocexa}
L'option \tdoclatexin{style = rule} permet d'obtenir ce qui suit ce qui suit où les textes ajoutés automatiquement s'adapteront à la langue repéré par \thisproj.
\input{examples-showcase-rule.tex}
\end{tdocexa}
\begin{tdocexa}[Du texte et des couleurs modifiables]
On peut obtenir facilement l'horreur suivante.
\input{examples-showcase-rule-custom.tex}
Voici le code qui a été employé.%
\footnote{
La section suivante va justifier le choix, a priori étrange, de \tdoclatexin{col-stripe} au lieu de \tdoclatexin{col-rule}\,.
}
\tdoclatexinput<\tdoctcb{code}>{examples-showcase-rule-custom.tex}
\end{tdocexa}
\begin{tdocnote}
Dans l'exemple précédent, le texte utilise bien l'orange assombri proposé. Par contre, le rouge sert de base pour obtenir les couleurs utilisées pour les lignes cadrantes: les transformations utilisées dépendent du thème choisi.%
\footnote{
Par exemple, les thèmes \tdoclatexin{bw} et \tdoclatexin{draft} ne tiennent pas compte de la clé \tdoclatexin{col-stripe} !
}
%
Il faut également savoir qu'en coulisse, la macro \tdocmacro{tdocruler} est employée, elle fonctionne comme suit.
\begin{tdoclatex}<\tdoctcb{std}>
\tdocruler[red]{Un pseudo-titre décoré}
\end{tdoclatex}
\end{tdocnote}
\subsection{Avec une bande colorée}
Il est des situations où l'on doit pouvoir clairement identifier un exemple de code \LaTeX\ mis en forme. Ceci est faisable comme le montrent les exemples suivants.%
\footnote{
En coulisse, les bandes sont créées sans effort grâce au package \tdocpack{clrstrip}.
}
\begin{tdocexa}
L'option \tdoclatexin{style = stripe} fournit ce qui suit.
\input{examples-showcase-stripe.tex}
\end{tdocexa}
\begin{tdocexa}[Du texte et des couleurs modifiables]
On peut produire facilement une belle horreur comme celle qui arrive.
\input{examples-showcase-stripe-custom.tex}
Voici le code qui a été employé.%
\footnote{
On comprend maintenant le choix de \tdoclatexin{col-stripe} au lieu de \tdoclatexin{col-rule}\,.
}
\tdoclatexinput<\tdoctcb{code}>{examples-showcase-stripe-custom.tex}
\end{tdocexa}
\subsection{En important le code \LaTeX}
Pour obtenir des rendus en important le code depuis un fichier externe, au lieu de le taper, il suffit d'employer la macro \tdocmacro{tdocshowcaseinput} dont l'option reprend la syntaxe de celle de l'environnement \tdocenv*{tdocshowcase}, et l'argument obligatoire correspond au chemin du fichier. Voici des exemples d'utilisation.
\foreach \exatitle/\style in {
{Usage standard}/% <-- Translate me!
{default},
{Avec des lignes cadrantes}/% <-- Translate me!
{rule},
{Une bande colorée}/% <-- Translate me!
{stripe}%
}{
\begin{tdocexa}[\exatitle]
\leavevmode
\tdoclatexinput<\tdoctcb{code}>{examples-showcase-input-\style.tex}
Ceci donne:
\smallskip
\input{examples-showcase-input-\style.tex}
\end{tdocexa}
}
\section{Cas d'utilisation en \LaTeX}
\label{tutodoc-listing-latex}
Documenter un package, ou une classe, se fait efficacement via des cas d'utilisation montrant à la fois du code et le résultat correspondant.%
\footnote{
La mise en forme des codes se fait via les packages \tdocpack{minted} et \tdocpack{tcolorbox}.
}
\subsection{Codes \tdocquote{en ligne}}
\label{tutodoc-listing-latex-inline}
\begin{tdocexa}[Usage standard]
La macro \tdocmacro{tdoclatexin}\,%
\footnote{
Le nom de la macro \tdocmacro{tdoclatexin} vient de \tdocquote{\tdocprewhy{in.line} \LaTeX} soit \tdocinEN{\LaTeX\ en ligne}.
}
permet de taper du code en ligne via un usage similaire à \tdocmacro{verb}, ou bien comme une macro standard (voir la gestion des accolades dans le dernier cas ci-dessous).
Voici des exemples d'utilisation.%
\footnote{
Une couleur de fond est volontairement utilisée pour subtilement faire ressortir les codes \tdoclatexin{\LaTeX}\,.
}
\begin{tdoclatex}<\tdoctcb{sbs}>
1: \tdoclatexin|$a^b = c$| \\
2: \tdoclatexin+\tdoclatexin|$a^b = c$|+ \\
3: \tdoclatexin{\tdoclatexin{$a^b = c$}}
\end{tdoclatex}
\end{tdocexa}
\begin{tdocexa}[Des options possibles]
Comme la macro \tdocmacro{tdoclatexin} s'appuie sur \tdocpack{minted}, on peut utiliser toutes les options prises en compte par \tdocpack{minted}.
Voici des exemples d'utilisation.
\begin{tdoclatex}<\tdoctcb{sbs}>
1: \tdoclatexin[style = bw]{$a^b = c$} \\
2: \tdoclatexin[style = igor,
showspaces]{$a^b = c$}
\end{tdoclatex}
\end{tdocexa}
\begin{tdocnote}
La macro \tdocmacro{tdoclatexin} est utilisable dans une note de pied de page comme ci-dessous.%
\footnote{
\tdoclatexin+$minted = TOP$+ a été tapé \tdoclatexin|\tdoclatexin+$minted = TOP$+| dans cette note de bas de page.
}
\end{tdocnote}
\subsection{Codes tapés directement}
\label{tutodoc-listing-latex-direct}
\begin{tdocexa}[Face à face]
Afficher un code et son rendu côte à côte se fait comme suit où la macro \tdocmacro{tdoctcb} permet de juste taper \tdoclatexin{\tdoctcb{sbs}} au lieu de \tdoclatexin{listing side text} (\tdoclatexin#sbs# est pour \tdocquote{\tdocprewhy{s.ide} \tdocprewhy{b.y} \tdocprewhy{s.ide}}\,, soit \tdocinEN{côte à côte}, tandis que \tdoclatexin#tcb# est l'abréviation standard de \texttt{tcolorbox}). Bien noter l'emploi de chevrons, et non de crochets (nous revenons sur ceci un plus bas).
\tdoclatexshow{examples-listing-latex-ABC.tex}
\end{tdocexa}
\begin{tdocexa}[À la suite]
\tdocenv{tdoclatex} produit le résultat suivant (ce réglage par défaut s'obtient aussi via l'emploi de \tdoclatexin#\tdoctcb{std}#).%
\footnote{
\tdoclatexin{std} fait référence au comportement \tdocquote{standard} de \tdocpack{tcolorbox} vis à vis de la librairie \tdocpack{minted}.
}
\begin{tdoclatex}
$A = B + C$
\end{tdoclatex}
\end{tdocexa}
\begin{tdocexa}[Juste le code]
Via \tdoclatexin#\tdoctcb{code}#, on aura juste le code comme ci-après.
\begin{tdoclatex}<\tdoctcb{code}>
$A = B + C$
\end{tdoclatex}
\end{tdocexa}
\begin{tdocexa}[Personnaliser]
L'environnement \tdocenv*{tdoclatex} accepte deux types d'argument optionnel.
%
\begin{enumerate}
\item Entre de classiques crochets, on peut employer toute option prise en compte par \tdocpack{minted}.
\item Entre des chevrons, on peut employer toute option prise en compte par les environnements obtenus via \tdocpack{tcolorbox}.
\end{enumerate}
Par exemple, on peut faire les modifications suivantes si besoin.%
\footnote{
Cette documentation utilise les options entre chevrons pour obtenir des rendus corrects de codes \LaTeX\ produisant des cadres ombrés : voir la section \ref{tutodoc-admonitions} page \pageref{tutodoc-admonitions}.
}
\tdoclatexshow{examples-listing-latex-ABC-custom.tex}
\end{tdocexa}
\medskip
\begin{tdocwarn}
Pour obtenir la mise en forme par défaut d'un code commençant par un crochet, ou un chevron, il faudra bidouiller un peu comme ci-dessous.
\tdoclatexshow{examples-listing-latex-strange.tex}
\smallskip
Une autre méthode consiste à utiliser la primitive \tdocmacro{string} comme ci-après.
\tdoclatexshow{examples-listing-latex-strange-bis.tex}
\end{tdocwarn}
\subsection{Codes importés}
Pour les codes suivants, on considère un fichier de chemin relatif \verb+examples-listing-xyz.tex+, et ayant le contenu suivant.
\tdoclatexinput<\tdoctcb{code}>{examples-listing-latex-xyz.tex}
\medskip
La macro \tdocmacro{tdoclatexinput}, présentée ci-dessous, attend le chemin d'un fichier et propose le même système d'options entre crochets, ou entre chevrons, que l'environnement \tdocenv*{tdoclatex}.
\foreach \title/\extra/\fname in {%
{Face à face}/%
{}/%
sbs,
{À la suite}/%
{ qui correspond aussi à l'option \tdoclatexin{\tdoctcb{std}}\,}/%
std,%
{Juste le code}/%
{}/%
code,%
{Personnaliser}/%
{}/%
perso%
}{
\begin{tdocexa}[\title]
\leavevmode
\tdoclatexshow[explain=Ceci produit la mise en forme suivante\extra.]{examples-listing-latex-latexinput-option-\fname.tex}
\end{tdocexa}
}
\subsection{Codes importés et mis en situation}
\label{tutodoc-listing-latexshow}
\begin{tdocnote}
Les textes par défaut de la macro \tdocmacro{tdoclatexshow} tiennent compte de la langue détectée par \thisproj.
\end{tdocnote}
\begin{tdocexa}[Mise en situation]
\tdoclatexin+\tdoclatexshow{examples-listing-xyz.tex}+ produit ce qui suit.
\smallskip
\tdoclatexshow{examples-listing-latex-xyz.tex}
\end{tdocexa}
\begin{tdocexa}[Changer le texte explicatif]
Via la clé \tdoclatexin|explain|, on peut utiliser un texte personnalisé. Ainsi, \tdoclatexin|\tdoclatexshow[explain = Voici le rendu réel.]{examples-listing-xyz.tex}| produira ce qui suit.
\smallskip
\tdoclatexshow[explain = Voici le rendu réel.]{examples-listing-latex-xyz.tex}
\end{tdocexa}
\begin{tdocexa}[Les options disponibles]
En plus du texte explicatif, il est aussi possible d'utiliser toutes les options de l'environnement \tdocenv*{tdocshowcase}, voir la section \ref{tutodoc-showcase} page \pageref{tutodoc-showcase}.
Voici un exemple illustrant ceci.
\medskip
\tdoclatexinput<\tdoctcb{code}>{examples-listing-latex-latexshow-options.tex}
\smallskip
Ceci va produire ce qui suit.
\smallskip
\input{examples-listing-latex-latexshow-options.tex}
\end{tdocexa}
\section{Présenter du code informatique}
Certains packages proposent des fonctionnalités nécessitant de coder un peu en \lua.%
\footnote{
Pour les mathématiques, on peut citer \tdocpack{luacas} et \tdocpack{tkz-elements}.
}
Pour ces projets, la documentation doit pouvoir présenter des lignes de code \lua\,; c'est pour cette raison que \thisproj\ permet de faire cela aisément, et bien plus.%
\footnote{
La mise en forme des codes étant faite via les packages \tdocpack{minted} et \tdocpack{tcolorbox}, les macros et les environnements présentés dans cette section permettent la mise en forme de codes dans tous les langages supportés par \pygmentsREF, un projet \python\ utilisé en coulisse par \tdocpack{minted}.
}
\begin{tdocimp}
Les outils de cette section permettent aussi de présenter du code \LaTeX, mais il ne faut pas les utiliser pour de simples cas d'utilisation, car les macros et les environnements présentées juste après servent à étudier du code, et non juste à l'employer : se reporter à la section \ref{tutodoc-listing-latex} page \pageref{tutodoc-listing-latex} pour faire appel aux bons outils pour la mise en forme de cas d'utilisation \LaTeX.
\end{tdocimp}
\subsection{Codes \tdocquote{en ligne}}
La macro \tdocmacro{tdoccodein}\,%
\footnote{
Le nom de la macro \tdocmacro{tdoccodein} vient de \tdocquote{\tdocprewhy{in.line} \tdocpre{code}} soit \tdocinEN{code en ligne}.
}
attend deux arguments : le 1\ier\ indique le langage de programmation, et le 2\ieme\ donne le code à mettre en forme.
Il est possible d'utiliser une option de fonctionnement identique à ce que propose \tdocmacro{tdoclatexin} : voir la section \ref{tutodoc-listing-latex-inline} page \pageref{tutodoc-listing-latex-inline}.
Voici des cas d'utilisation possibles.%
\footnote{
Une couleur de fond est volontairement utilisée pour subtilement faire ressortir les codes mis en forme.
Par exemple, taper \tdoclatexin{\tdoccodein{py}{funny = "ah"*3}} produira \tdoccodein{py}{funny = "ah"*3}\,.
}
\begin{tdoclatex}
1: \tdoccodein{py}{print("OK" if i = 0 else "KO")} \\
2: \tdoccodein[style = bw]{py}{print("OK" if i = 0 else "KO")} \\
3: \tdoccodein[style = igor, showspaces]%
{py}{print("OK" if i = 0 else "KO")}
\end{tdoclatex}
\medskip
\begin{tdocnote}
Sur la page \url{https://pygments.org/languages/} se trouve la liste complète des langages supportés avec leur nom court.
Par exemple, il est possible de mettre en forme du code \brainfuck\ comme cette séquence \tdoccodein{bf}{++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.} qui sert à afficher \tdoccodein{text}{Hello}\,.
\end{tdocnote}
\subsection{Codes tapés directement}
On peut taper directement du code dans un document \LaTeX\ via \tdocenv{tdoccode} qui attend un argument indiquant le langage de programmation, et d'éventuelles options entre crochets et/ou entre chevrons de fonctionnements identiques à ce que propose \tdocenv{tdoclatex} : voir la section \ref{tutodoc-listing-latex-direct} page \pageref{tutodoc-listing-latex-direct}.%
\footnote{
Noter que la coloration des codes \LaTeX\ est correcte du point de vue lexical, mais fausse sémantiquement parlant.
}
% Strings "..." in the source codes must also be translated.
\foreach \title/\lang in {%
{Fonctionnement standard}/%
perl,%
{Personnalisation ponctuelle du rendu}/%
lua%
}{
\begin{tdocexa}[\title]
\leavevmode
\tdoclatexshow{examples-listing-full-hello-you-\lang}
\end{tdocexa}
}
\subsection{Codes importés}
La macro \tdocmacro{tdoccodeinput} attend le langage et le chemin d'un fichier à mettre en forme, et éventuellement d'options similaires à ce que propose l'environnement \tdocenv*{tdoccode}\,.
% Strings "..." in the source codes must also be translated.
\foreach \title/\lang in {%
{Fonctionnement standard}/%
hs,%
{Personnalisation ponctuelle du rendu}/%
tex%
}{
\begin{tdocexa}[\title]
\leavevmode
\tdoclatexinput<\tdoctcb{code}>{examples-listing-full-input-hello-you-\lang}
Ceci donne:
\input{examples-listing-full-input-hello-you-\lang}
\end{tdocexa}
}
\section{Indiquer les changements}
\label{tutodoc-changes}
Afin de faciliter le suivi d'un projet, il est indispensable de fournir un historique indiquant les changements effectués lors de la publication d'une nouvelle version.
\subsection{À quel moment ?}
\label{tutodoc-changes-when}
On peut dater et/ou versionner quelque chose.
\begin{tdocexa}[Dater des nouveautés]
La macro \tdocmacro{tdocdate} permet d'indiquer une date dans la marge comme dans l'exemple suivant.
\tdoclatexshow{examples-version-n-change-dating.tex}
\end{tdocexa}
\begin{tdocexa}[Versionner des nouveautés en les datant éventuellement]
Associer un numéro de version à une nouveauté se fait via la macro \tdocmacro{tdocversion}, la couleur et la date étant des arguments optionnels.
\tdoclatexshow{examples-version-n-change-versioning.tex}
\end{tdocexa}
\begin{tdocexa}[Attention avec les titres de paragraphe]
L'exemple suivant montre qu'il faut placer une dates et/ou une version juste après un titre de paragraphe, et non avant.
\tdoclatexshow{examples-version-n-change-para-title.tex}
\end{tdocexa}
\begin{tdocexa}[Régler le positionnement vertical]
Si besoin, on peut modifier le décalage vertical utilisé pour bien placer les dates et les versions dans la marge, la valeur par défaut étant $(-8\,\mathit{pt})$.
\tdoclatexshow{examples-version-n-change-manual-setting.tex}
\end{tdocexa}
\begin{tdocimp}
\begin{enumerate}[wide]
\item Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} nécessitent deux compilations.
\item Comme la langue détectée pour cette documentation est le français, la date dans le rendu final est au format \texttt{JJ/MM/AAAA} alors que dans le code celle-ci devra toujours être saisie au format anglais \texttt{AAAA-MM-JJ}.
\end{enumerate}
\end{tdocimp}
\begin{tdoccaut}
Seul l'emploi du format numérique \tdoclatexin+YYYY-MM-DD+ est vérifié,%
\footnote{
Techniquement, vérifier la validité d'une date, via \LaTeX3, ne présente pas de difficulté.
}
et ceci est un choix ! Pourquoi cela ? Tout simplement car dater et versionner des explications devrait se faire de façon semi-automatisée afin d'éviter tout bug humain.
\end{tdoccaut}
\subsection{Quoi de neuf ?}
\thisproj\ propose la macro \tdocmacro{tdocstartproj} et différents environnements pour indiquer rapidement et clairement ce qui a été fait lors des changements faits, ou à venir.%
\footnote{
L'utilisateur n'a pas besoin de tous les détails techniques.
}
\begin{tdocnote}
Concernant les icônes, voir la note au début de la section \ref{tutodoc-admonitions} page \pageref{tutodoc-admonitions}.
\end{tdocnote}
\subsubsection{La sobriété avant tout}
\foreach \exatitle/\filename in {
% Standard.
{Juste pour la toute première version}/%<-- Translate me!
first,
{Pour les nouveautés}/% <-- Translate me!
new,
{Pour les mises à jour}/% <-- Translate me!
update,
{Pour les bifurcations}/% <-- Translate me!
break,
{Pour les problèmes}/% <-- Translate me!
pb,
{Pour les réparations}/% <-- Translate me!
fix,
{Feuille de route}/% <-- Translate me!
todo,
{Informations techniques}/% <-- Translate me!
tech,
% Customized.
{Thématiques aux choix avec une icône}/%<-- Translate me!
user-choice-icon,
{Thématiques aux choix sans icône}/% <-- Translate me!
user-choice%
} {
\begin{tdocexa}[\exatitle]
\leavevmode
\tdoclatexinput<\tdoctcb{sbs}>{examples-version-n-change-chges-\filename.tex}
\end{tdocexa}
}
\subsubsection{De la couleur si besoin}
Il peut être utile de mettre en avant certains changements : ceci n'est faisable qu'en modifiant la couleur du contenu.
\foreach \exatitle/\filename in {
{Une première version tape-à-l'oeil}/%<-- Translate me!
first,
{Des réparations exceptionnelles}/% <-- Translate me!
fix%
} {
\begin{tdocexa}[\exatitle]
\leavevmode
\tdoclatexinput<\tdoctcb{sbs}>{examples-version-n-change-color-chges-\filename.tex}
\end{tdocexa}
}
\subsection{Le quoi et le quand}
Les clés optionnelles \tdoclatexin{col-chges}\,, \tdoclatexin{date} et \tdoclatexin{version} permettent de dater et/ou versionner directement un changement d'un type particulier. Voici des exemples d'utilisation.
\tdoclatexshow{examples-version-n-change-what-n-when.tex}
\section{Décoration}
Finissons cette documentation avec un petit outil de mise en forme qui peut rendre de grands services.
\begin{tdoclatex}<\tdoctcb{sbs}>
Bla, bla, bla...
\tdocsep % Pratique pour délimiter.
Ceci fonctionne avec des énumérations.
\begin{itemize}
\item Point souligné.
\end{itemize}
\tdocsep % Un comportement uniforme.
Ble, ble, ble...
\end{tdoclatex}
\section{Contribuer}
\begin{tdocnote}
\textbf{Nul besoin d'être un codeur pour participer aux traductions}, y compris pour celles utiles au fonctionnement de \thisproj.
\end{tdocnote}
%\section{Contribuer}
\subsection{Compléter les traductions}
\begin{tdocnote}
L'auteur de \thisproj\ gère les versions françaises et anglaises des traductions.
\end{tdocnote}
\begin{tdoccaut}
Même si nous allons expliquer comment traduire les documentations, il semble peu pertinent de le faire, car l'anglais devrait suffire de nos jours.%
\footnote{
L'existence d'une version française est une simple conséquence de la langue maternelle de l'auteur de \thisproj.
}
\end{tdoccaut}
\begin{figure}[ht]
\centering
\contribtranslatedirtree\
\caption{Vue simplifiée du dossier des traductions}
\label{tutodoc-contrib-translate-dir}
\end{figure}
Les traductions sont organisées grosso-modo comme dans la figure \ref{tutodoc-contrib-translate-dir} où seuls les dossiers importants pour les traductions ont été \tdocquote{ouverts}\,.%
\footnote{
Cette organisation était celle du 5 octobre 2024.
}
\textbf{Un peu plus bas, la section \ref{tutodoc-contrib-translate} donne les démarches à suivre pour ajouter de nouvelles traductions.}
\subsubsection{Les dossiers \texttt{fr} et \texttt{en}}
Ces deux dossiers, gérés par l'auteur de \thisproj, ont la même organisation ; ils contiennent des fichiers faciles à traduire même si l'on n'est pas un codeur.
\subsubsection{Le dossier \texttt{changes}}
Ce dossier est un outil de communication où sont indiqués les changements importants sans s'attarder sur les modifications mineures propres à une ou plusieurs traductions.
\subsubsection{Le dossier \texttt{status}}
Ce dossier permet de savoir où en sont les traductions du point de vue du projet. Tout se passe via des fichiers \verb#YAML# bien commentés, et lisibles par un non codeur.
\subsubsection{Les fichiers \texttt{README.md} et \texttt{LICENSE.txt}}
Le fichier \texttt{LICENSE.txt} est bien nommé, tandis que le fichier \texttt{README.md} reprend en anglais les points importants de ce qui est dit dans cette section à propos des nouvelles traductions.
\subsubsection{De nouvelles traductions}
\label{tutodoc-contrib-translate}
\begin{tdocimp}
Le dossier \verb#api# contient les traductions relatives aux fonctionnalités de \thisproj.
Vous y trouverez des fichiers de type \verb#TXT# à modifier via un éditeur de texte, ou de code, mais non via un traitement de texte.
Les contenus de ces fichiers utilisent des lignes commentées en anglais pour expliquer ce que fera \thisproj\ ; ces lignes commencent par \verb#//#\,. Voici un extrait de ce type de fichier où \textbf{les traductions se font après chaque signe \,$=$\, sans toucher à ce qui se trouve avant}, car ce morceau initial est utilisé en interne par le code de \thisproj..
\tdocsep
\vspace{-10pt}
\begin{verbatim}
// #1: year in format YYYY like 2023.
// #2: month in format MM like 04.
// #3: day in format DD like 29.
date = #1-#2-#3
// #1: the idea is to produce one text like
// "this word means #1 in English".
in_EN = #1 in english\end{verbatim}
\end{tdocimp}
\begin{tdocnote}
Le dossier \verb#doc# est réservé aux documentations. Il contient des fichiers \verb#TEX# compilables directement pour une validation en temps réel des traductions faites.
\end{tdocnote}
\begin{tdocwarn}
Ne partir que de l'un des dossiers \verb#fr# et \verb#en#, car ceux-ci sont de la responsabilité de l'auteur de \thisproj.
\end{tdocwarn}
\medskip
\emph{\textbf{Imaginons que vous souhaitiez ajouter le support de l'italien en partant de fichiers rédigés en anglais.}}%
\footnote{
Comme indiqué plus haut, il n'y a pas de besoin réel du côté du dossier \texttt{doc}.
}
\paragraph{Méthode 1 : utilisation de \git.}
\begin{enumerate}
\item Récupérer le dossier du projet via \thisrepo\,.
Ne pas passer via la branche \verb#main# qui sert à figer les dernières versions stables des projets du dépôt unique \thismonorepo\,.
\item Dans le dossier \verb#tutodoc/contrib/translate#, créer une copie \verb#it# du dossier \verb#en#\,, le nom court de la langue étant documenté dans
\href{https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags}%
{la page \tdocquote{IIETF language tag}}
de \texttt{Wikipédia}.
\item Une fois la traduction achevée dans le dossier \verb#it#, partager la via \thisrepo\ en usant d'un classique \verb#git push#\,.
\end{enumerate}
\paragraph{Méthode 2 : communiquer par courriels.}
\begin{enumerate}
\item Via un courriel de \mailsubject{en FOR italian}\,, demander une version des traductions anglaises (noter l'emploi du nom anglais de la nouvelle langue).
Bien respecter le sujet du courriel, car l'auteur de \thisproj\ automatise le pré-traitement de ce type de courriels.
\item Vous recevrez un dossier nommé \verb#italian# contenant la version anglaise des dernières traductions.
Ce dossier sera le lieu de votre contribution.
\item Une fois la traduction achevée, il faudra compresser votre dossier \verb#italian# au format \verb#zip# ou \verb#rar# avant de l'envoyer par courriel avec le \mailsubject{italian}\,.
\end{enumerate}
%\section{Contribuer}
\subsection{Améliorer le code source}
\begin{tdocimp}
Si vous souhaitez participer à \thisproj\,, il faudra privilégier le paradigme de programmation \LaTeX3.
\end{tdocimp}
La participation en tant que codeuse, ou codeur, se fait via le dépôt \thisrepo\ correspondant à la branche de développement \verb#tutodoc#.
\begin{tdoccaut}
Ne pas passer via la branche \verb#main# qui sert à figer les dernières versions stables des projets du dépôt unique \thismonorepo\,.
\end{tdoccaut}
\section{Historique}
\small
\begin{tdocfix}[version = 1.7.1, date = 2024-12-18]
\item Documentation: les références aux outils pour indiquer des changements ont été incorrectement écrites comme caractéristiques des contenus colorés mis en avant.
\end{tdocfix}
\begin{tdocbreak}
\item La macro \tdocmacro{tdocenv} et sa version étoilée ne proposent plus d'option.
\item Cas d'utilisation \LaTeX: la présentation par défaut est plus sobre, et des options permettent d'ajouter les lignes cadrantes, ou la bande colorée. Voir juste après.
\end{tdocbreak}
\begin{tdocnew}
\item Mise en forme de codes informatiques en plus de ceux spécifiquement en \LaTeX.
%
\begin{enumerate}
\item Création de \tdocenv{tdoccode} et de \tdocmacro{tdoccodein}.
\item Pour les macros pour du code en ligne, et les environnements pour des blocs de code, des options de type \tdocpack{minted} s'indiquent à l'intérieur de crochet de manière traditionnelle: \tdoclatexin{[options minted]}\,.
\item Pour les environnements pour des blocs de code, des options de type \tdocpack{tcolorbox} s'indiquent à l'intérieur de chevrons: \tdoclatexin{<options tcolorbox>}\,.
\item La nouvelle macro \tdocmacro{tdoctcb} permet d'utiliser des raccourcis pour les styles \tdocpack{tcolorbox} régulièrement utilisés.
\end{enumerate}
\item Documentation: une nouvelle section présente les outils de mise en forme de codes informatiques autres que les cas d'utilisation de \LaTeX.
\end{tdocnew}
\begin{tdocupdate}
\item Les sous-sous-sections sont numérotées en lettres minuscules.
\item Thèmes.
%
\begin{enumerate}
\item Moins d'espace consommé.
\item Les ombres ont une meilleure coloration.
\item Pour tous les thèmes sauf le \tdoclatexin{draft}, le rayon des arcs des coins des cadres passe de \tdoclatexin{.75mm} à \tdoclatexin{.2pt}\,.
\item Cas d'utilisation de \LaTeX: avec le thème \tdoclatexin{color}, la couleur du fond passe de \tdoclatexin[bgcolor = yellow!4]{yellow!4} à \tdoclatexin{gray!5}.
\item Dernières modifications: avec le thème \tdoclatexin{dark}, le texte \tdoclatexin{[Init]} produit par la macro \tdocmacro{tdocstartproj} utilise la même police que celle des titres des environnements pour indiquer des changements.
\end{enumerate}
\end{tdocupdate}
\tdocsep
% ------------------ %
\begin{tdocbreak}[version = 1.7.0, date = 2024-12-04]
\item Mise en forme : la classe \tdoccls{scrartcl} remplace la vénérable \tdoccls{article}. Cela implique un meilleur positionnement des notes de marge avec les options retenues pour charger \tdoccls{scrartcl}.
\item Code \LaTeX\ : la macro \tdocmacro{tdocinlatex} a été renommée \tdocmacro{tdoclatexin}.
\item Les noms des clés pour les couleurs utiliseront des traits d'union lorsque cela sera nécessaire : cela implique les changements suivants.
%
\begin{enumerate}
\item Indiquer les derniers changements : l'option \tdoclatexin{colchges} des environnements a été renommée \tdoclatexin{col-chges}.
\item Démonstration de codes \LaTeX\ : pour l'environnement \tdocenv*{tdocshowcase} et la macro \tdocmacro{tdocshowcaseinput}, les options \tdoclatexin{colstripe} et \tdoclatexin{coltext} ont été renommées \tdoclatexin{col-stripe} et \tdoclatexin{col-text}\,.
\end{enumerate}
\end{tdocbreak}
\begin{tdocfix}
\item Mise en avant colorée de contenus : pour les \tdocmacro{newkeytheorem} utilisés avec le thème \tdoclatexin{draft}, il a fallu ajouter \tdoclatexin{postheadhook = \leavevmode} (ceci est nécessaire car le contenu peut juste être de type liste).
\end{tdocfix}
\begin{tdocnew}
\item Documentation : ajout d'une section listant les dépendances.
\item Options de classe.
%
\begin{enumerate}
\item Les options qui ne sont pas spécifiques à \thisproj\ sont transmises à la classe chargée de la mise en forme générale.
\item Les options \tdoclatexin{fontsize} et \tdoclatexin{DIV} de la classe \tdoccls{scrartcl} ne peuvent pas être utilisées, car leurs valeurs sont fixées par \thisproj.
\end{enumerate}
\item La macro \tdocmacro{tdocinEN} respecte les règles linguistiques anglaises.
\item Indiquer les derniers changements.
%
\begin{enumerate}
\item Ajout de l'environnement \tdocenv{tdoctodo}\,.
\item Chaque environnement dispose d'une nouvelle option \tdoclatexin{col} pour la couleur du contenu indiquant les changements.
\end{enumerate}
\end{tdocnew}
\begin{tdocupdate}
\item Le thème \tdoclatexin{draft} et les changements : les environnements pour les derniers changements n'emploient plus d'icone.
\item Documentation : la galerie des thèmes utilise un meilleur exemple factice.
\end{tdocupdate}
\begin{tdoctech}
\item Organisation simplifiée des fichiers de configuration dans le projet final.
%
\begin{enumerate}
\item Emploi d'un fichier par thème avec des noms du type \texttt{tutodoc-*.css.cls}\,.
\item Localisation : utilisation de noms comme \texttt{tutodoc-*.loc.cls}\,.
\end{enumerate}
\end{tdoctech}
\tdocsep
% ------------------ %
\begin{tdocnew}[version = 1.6.2, date = 2024-10-30]
\item Les macros \tdocmacro{tdocdate} et \tdocmacro{tdocversion} ont un nouvel argument final facultatif \tdoclatexin{<voffset>} pour modifier le décalage vertical.
\item De meilleurs environnements pour indiquer les modifications apportées.
\begin{enumerate}
\item Les nouvelles clés facultatives \tdoclatexin{col}\,, \tdoclatexin{date} et \tdoclatexin{version} permettent d'indiquer la date et la version d'une modification apportée à un sujet spécifique.
\item Utilisation de \tdocmacro{paragraph} pour le titre.
\end{enumerate}
\end{tdocnew}
\begin{tdocupdate}
\item Changements : la police des notes de marge aura toujours une forme normale.
\item Ornement : utilisation d'un \tdoclatexin{\cleaders} pour éviter les lignes orphelines en bas de page.
\end{tdocupdate}
\tdocsep
% ------------------ %
\begin{tdoctech}[version = 1.6.1, date = 2024-10-28]
\item Les règles de nommage de \ctan\ nécessitent l'usage de noms du type \verb+tutodoc-*.css.cls.sty+ pour les fichiers à-la \trademark{CSS}.
\end{tdoctech}
\tdocsep
% ------------------ %
\begin{tdocbreak}[version = 1.6.0, date = 2024-10-27]
\item L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdoclatexin{color} a été renommée \tdoclatexin{colstripe}.
\item La macro \tdocmacro{tdoclinkcolor} devient la couleur \tdoclatexin{tutodoc@link@color} destinée à un usage interne.
\end{tdocbreak}
\begin{tdocnew}
\item L'option de classe \tdoclatexin{theme} permet de choisir différents thèmes de mise en forme.
\item Journal des modifications : ajout de l'environnement \tdocenv*{tdoctech} pour les informations techniques.
\item L'environnement \tdocenv*{showcase} et ses descendants : la clé \tdoclatexin{coltext} permet de changer aussi la couleur du texte.
\item Les nouvelles fonctionnalités ont été documentées.
\end{tdocnew}
\begin{tdocupdate}
\item Journal des modifications : l'environnement \tdocenv*{tdocupdate} utilise l'icône
\raisebox{0pt}[0pt][0pt]{\fbox{\reflectbox{\faHistory}}}
au lieu de
\raisebox{0pt}[0pt][0pt]{\fbox{\faMagic}}\,.
\end{tdocupdate}
\begin{tdocfix}
\item Les traductions espagnoles n'avaient pas été livrées dans la précédente version ! Ne pas rire trop fort...
\end{tdocfix}
\tdocsep
% ------------------ %
\begin{tdoctech}[version = 1.5.0, date = 2024-10-19]
\item La version 3 de \tdocpack{minted} est prise en compte.
\end{tdoctech}
\begin{tdocbreak}
\item La classe \thisproj\ remplace le défunt package \thisproj\ (pour le moment, la toute jeune classe ne propose aucune option spécifique).
\item La macro \tdocmacro{tdocruler} s'emploie via \tdoclatexin{\tdocruler[<color>]{<text>}} au lieu de \tdoclatexin{\tdocruler{<text>}{<color>}}\,.
\end{tdocbreak}
\begin{tdocnew}
\item La classe est utilisable en langue espagnole.
\item La documentation contient une nouvelle section expliquant comment contribuer.
\end{tdocnew}
\begin{tdocfix}
\item La macro \tdocmacro{tdocdate} ne gérait pas le format et la mise en forme de la date.
\item Les cadres colorés ne coloraient pas le texte après un saut de page.
\end{tdocfix}
\tdocsep
% ------------------ %
\begin{tdocbreak}[version = 1.4.0, date = 2024-09-28]
\item L'environnement \tdocenv*{tdoccaution} a été renommé \tdocenv*{tdoccaut} pour une saisie simplifiée.
\item Mise en avant de contenus : les exemples et remarques, indiqués via les environnements \tdocenv*{tdocexa} et \tdocenv*{tdocrem}, sont numérotés via un compteur commun.
\item La macro inutilisée \tdocmacro{tdocxspace} a été supprimée.
\end{tdocbreak}
\begin{tdocnew}
\item Journal des changements : la macro \tdocmacro{tdocstartproj} permet de gérer le cas de la première version publique.
\item Factorisation du code : la macro \tdocmacro{tdocicon} se charge de l'ajout d'icônes devant du texte.
\end{tdocnew}
\begin{tdocupdate}
\item Couleurs : les macros \tdocmacro{tdocdarkcolor} et \tdocmacro{tdoclightcolor} proposent un argument facultatif.
\begin{enumerate}
\item \tdocmacro{tdocdarkcolor} : la quantité de couleur par rapport au noir peut être définie de manière facultative.
\item \tdocmacro{tdoclightcolor} : le taux de transparence peut être défini de manière facultative.
\end{enumerate}
\item Mise en avant de contenus : réduction de l'espace autour du contenu dans les cadres colorés.
\item Gestion des versions: un meilleur espacement vertical via \tdocmacro{vphantom}.
\end{tdocupdate}
\tdocsep
% ------------------ %
\begin{tdocnew}[version = 1.3.1, date = 2024-09-26]
\item Version étoilée de \tdocmacro{tdocenv} pour n'avoir que le nom de l'environnement.
\end{tdocnew}
\tdocsep
% ------------------ %
\begin{tdoctech}[version = 1.3.0, date = 2024-09-25]
\item La version 3 de \tdocpack{minted} ne peut pas être prise en compte pour le moment car elle comporte des bugs : voir \url{https://github.com/gpoore/minted/issues/401}. On force donc temporairement l'usage de la version 2 de \tdocpack{minted}.
\end{tdoctech}
\begin{tdocbreak}
\item L'environnement \tdocenv*{tdocimportant} a été renommé \tdocenv*{tdocimp} pour une saisie simplifiée.
\end{tdocbreak}
\begin{tdocnew}
\item Journal des changements : les environnements proposés utilisent des icônes.
\item Mise en avant de contenus : des cadres colorés avec des icônes sont proposés pour les environnements suivants.
%
\begin{tasks}[label=\arabic*.](3)
\task \tdocenv*{tdoccaution}
\task \tdocenv*{tdocimp}
\task \tdocenv*{tdocnote}
\task \tdocenv*{tdoctip}
\task \tdocenv*{tdocwarn}
\end{tasks}
\end{tdocnew}
\tdocsep
% ------------------ %
\begin{tdocupdate}[version = 1.2.0-a, date = 2024-08-23]
\item \tdocmacro{tdocversion}
\begin{enumerate}
\item Le numéro de version est au-dessus de la date.
\item L'espacement est mieux géré lorsque la date est absente.
\end{enumerate}
\end{tdocupdate}
\begin{tdocfix}
\item Mise en avant de contenus : les traductions françaises de \tdocinEN*{caution} et \tdocinEN*{danger} étaient erronées.
\end{tdocfix}
\tdocsep
% ------------------ %
\begin{tdocnew}[version = 1.1.0, date = 2024-01-06]
\item Journal des changements : deux nouveaux environnements.
\begin{enumerate}
\item \tdocenv{tdocbreak} pour les \tdocquote{bifurcations}\,, c'est-à-dire les modifications non rétrocompatibles.
\item \tdocenv{tdocprob} pour les problèmes repérés.
\end{enumerate}
\item \tdocmacro{tdoclatexin}: un jaune léger est utilisé comme couleur de fond.
\end{tdocnew}
\tdocsep
% ------------------ %
\begin{tdocfix}[version = 1.0.1, date = 2023-12-08]
\item \tdocmacro{tdocenv}: l'espacement est maintenant correct, même si le paquet \tdocpack{babel} n'est pas chargé avec la langue française.
\item \tdocenv[{[nostripe]}]{tdocshowcase}: les sauts de page autour des lignes \tdocquote{cadrantes} devraient être rares dorénavant.
\end{tdocfix}
\tdocsep
% ------------------ %
\tdocversion{1.0.0}[2023-11-29]
\tdocstartproj{Première version publique du projet.}
\end{document}
|