summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/acro/acro_en.tex
blob: 11b05f82fff6ba01d675aff94d8b632a0c6aee84 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
% arara: pdflatex
% !arara: biber
% !arara: pdflatex
% !arara: pdflatex
% arara: pdflatex
% --------------------------------------------------------------------------
% the ACRO package
% 
%   Typeset Acronyms
% 
% --------------------------------------------------------------------------
% Clemens Niederberger
% Web:    http://www.mychemsitry.eu/forums/forum/acro/
% E-Mail: contact@mychemistry.eu
% --------------------------------------------------------------------------
% Copyright 2011-2015 Clemens Niederberger
% 
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
% 
% This work has the LPPL maintenance status `maintained'.
% 
% The Current Maintainer of this work is Clemens Niederberger.
% --------------------------------------------------------------------------
% The acro package consists of the files
%  - acro.sty, acro_en.tex, acro_en.pdf, README
% --------------------------------------------------------------------------
% If you have any ideas, questions, suggestions or bugs to report, please
% feel free to contact me.
% --------------------------------------------------------------------------
\documentclass[load-preamble+,scrartcl={DIV10}]{cnltx-doc}
\usepackage[utf8]{inputenc}
\usepackage[single,macros,accsupp,index]{acro}
\setcnltx{
  package  = {acro} ,
  authors  = Clemens Niederberger ,
  email    = contact@mychemistry.eu ,
  url      = https://bitbucket.org/cgnieder/acro/ ,
  abstract = {%
    \acro\ not only allows you to create acronyms in a simple way but also lets
    you add them to different classes of acronyms. Lists can be created of
    separate classes wherever you want the list to appear.\par
    \acro\ also provides an option \option{single} which ignores acronyms that are
    used only once in the whole document.\par
    As an experimental feature \acro\ also offers the option \option{sort} which
    automatically sorts the list created by \cs{printacronyms}.%
  } ,
  add-cmds = {
    ac, Ac, aca, Aca, acap, Acap, acdot, acf, Acf, acflike, acg, acfp, Acfp, 
      acfplike, aciftrailing, acl, Acl, aclp, Aclp, acp, Acp,
      AcroRegisterTrailing, acs, Acs, acsp, Acsp, acspace, acreset, 
      acresetall, acsetup,
    DeclareAcroCommand, DeclareAcronym, DeclareAcronymCitation,
      DeclareAcronymFormat, DeclareAcronymPDFString, DeclarePseudoAcroCommand,
    iac, Iac, iaca, Iaca, iacs, Iacs, iacl, Iacl, iacf, Iacf, iacflike,
      Iacflike,
    NewAcroCommand, NewPseudoAcroCommand,
    printacronyms,
    ProvideAcroCommand, ProvideAcroEnding, ProvidePseudoAcroCommand,
    RenewAcroCommand, RenewPseudoAcroCommand
  } ,
  add-silent-cmds = {
    addcolon, DeclareInstance, babelhyphen, ExplSyntaxOff, ExplSyntaxOn, nato,
    NewDocumentCommand, newlist, ny, setlist
  } ,
  index-setup = { level = \section , headers={\indexname}{\indexname} }
}

\acsetup{hyperref}

\defbibheading{bibliography}{\section{References}}

\usepackage{csquotes}

\usepackage[biblatex]{embrac}[2012/06/29]
\ChangeEmph{[}[,.02em]{]}[.055em,-.08em]
\ChangeEmph{(}[-.01em,.04em]{)}[.04em,-.05em]

\usepackage{filecontents}

\addbibresource{\jobname.bib}
\begin{filecontents}{\jobname.bib}
@online{wikipedia,
  author   = {Wikipedia},
  title    = {Acronym and initialism},
  urldate  = {2012-06-21},
  url      = {http://en.wikipedia.org/wiki/Acronyms},
  year     = {2012}
}
@online{NewYork,
  author   = {Wikipedia},
  title    = {New York City},
  urldate  = {2012-09-27},
  url      = {http://en.wikipedia.org/wiki/New_York_City},
  year     = {2012}
}
\end{filecontents}

% additional packages:
\usepackage{longtable,array,booktabs,enumitem,amssymb}

\newcommand*\wikipedia{%\libertineGlyph{W.alt}\kern-.055em
\textsc{Wikipedia}}
\newcommand*\h[1]{\textcolor{cnltx}{\textbf{#1}}}

\ProvideAcroEnding {possessive} {'s} {'s}

% declare acronyms
\DeclareAcronym{cd}
  {
    short        = cd ,
    long         = Compact Disc ,
    short-format = \scshape
  }
\let\ctan\relax
\DeclareAcronym{ctan}
  {
    short     = ctan ,
    long      = Comprehensive \TeX\ Archive Network ,
    format    = \scshape ,
    pdfstring = CTAN ,
    accsupp   = CTAN
  }
\def\ctan{\acs{ctan}}
\DeclareAcronym{ecu}
  {
    short   = ECU ,
    long    = Steuerger\"at ,
    foreign = Electronic Control Unit
  }
\DeclareAcronym{id}
  {
    short        = id ,
    long         = identification string ,
    short-format = \scshape
  }
\DeclareAcronym{jpg}
  {
    short = JPEG ,
    alt   = JPG ,
    long  = Joint Photographic Experts Group
  }
\DeclareAcronym{la}
  {
    short        = LA ,
    short-plural = ,
    long         = Los Angeles,
    long-plural  = ,
    class        = city
  }
\let\lppl\relax
\DeclareAcronym{lppl}
  {
    short     = lppl ,
    long      = \LaTeX\ Project Public License ,
    format    = \scshape ,
    pdfstring = LPPL ,
    accsupp   = LPPL ,
    index-cmd = \csname @gobble\endcsname
  }
\def\lppl{\acs{lppl}}
\DeclareAcronym{MP}
  {
    short = MP ,
    long  = Member of Parliament ,
    long-plural-form = Members of Parliament
  }
\DeclareAcronym{nato}
  {
    short        = nato ,
    long         = North Atlantic Treaty Organization ,
    extra        = \emph{deutsch}: Organisation des Nordatlantikvertrags ,
    short-format = \scshape
  }
\DeclareAcronym{ny}
  {
    short        = NY ,
    short-plural = ,
    long         = New York ,
    long-plural  = ,
    class        = city ,
    cite         = NewYork
  }
\DeclareAcronym{ot}
  {
    short        = ot ,
    long         = Other Test ,
    short-format = \scshape
  }
\DeclareAcronym{pdf}
  {
    short     = pdf ,
    long      = Portable Document Format ,
    format    = \scshape ,
    pdfstring = PDF ,
    accsupp   = PDF
  }
\DeclareAcronym{sw}
  {
    short       = SW ,
    long        = Sammelwerk ,
    long-plural = e
  }
\DeclareAcronym{test}
  {
    short = ST ,
    long  = Some Test
  }
\DeclareAcronym{tex.sx}
  {
    short = \TeX.sx ,
    sort  = TeX.sx ,
    long  = \TeX{} StackExchange
  }
\DeclareAcronym{ufo}{
   short           = UFO ,
   long            = unidentified flying object ,
   long-indefinite = an
}


\makeatletter
\protected\def\@versionstar{\raisebox{-.25em}{*}}
\newcommand\versionstar{\texorpdfstring{\@versionstar}{*}}
\makeatother

\newcommand*\latin{\textit}

\makeatletter
\newcommand*\TF{\textcolor{red}{\uline{\code{\textcolor{cs}{\textit{TF}}}}}}
\renewenvironment{commands}
  {%
    \cnltx@set@catcode_{12}%
    \let\command\cnltx@command
    \cnltxlist
  }
  {\endcnltxlist}
\makeatother

\begin{document}
\section{Licence and Requirements}
\license

\acro\ loads and needs the following packages:
\pkg{expl3}\footnote{\CTANurl{l3kernel}}, \pkg{xparse}, \pkg{xtemplate},
\pkg{l3keys2e}\footnote{\CTANurl{l3packages}},
\pkg{zref-abspage}\footnote{\CTANurl{oberdiek}} and
\needpackage{translations}~\cite{pkg:translations}.

\section{About}
\begin{cnltxquote}[\cite{wikipedia}]
  Acronyms and initialisms are abbreviations formed from the initial
  components in a phrase or a word.  These components may be individual
  letters (as in CEO) or parts of words (as in Benelux and Ameslan).  There is
  no universal agreement on the precise definition of the various terms nor on
  written usage.
\end{cnltxquote}
After \wikipedia{} told us what acronyms are and we won't confuse them with
units or other kinds of abbreviations -- why would we need another package for
them?  There are several already: \pkg{acronym}~\cite{pkg:acronym},
\pkg{acromake}~\cite{pkg:acromake}, \pkg{acroterm}~\cite{pkg:acroterm}, the
abbreviations package \pkg{abbrevs}~\cite{pkg:abbrevs} (the current version
1.4 has a bug\footnote{see \url{http://tex.stackexchange.com/q/59840/5049} for
  solutions.}, though), the nomenclature package
\pkg{nomencl}~\cite{pkg:nomencl}, and of course the mighty
\pkg{glossaries}~\cite{pkg:glossaries}. So there is really no \emph{need} for
a new package.

On the other hand \pkg{acronym}, the best of the acronym specific packages,
has one or two shortcomings and sometimes using \pkg{glossaries} seems a bit
of an overkill (or simply inconvenient as one has to run
\code{makeglossaries}, \code{makeindex} or \code{xindy}, then\footnote{Rumour
  has it there is going to be a version that can be used without running an
  external program}). So \acro\ stands somewhere in between (but closer to
\pkg{acronym}).

The main reason for the existance of \acro\ is a question on \acs{tex.sx}%
\footnote{\url{http://tex.stackexchange.com/q/59449/5049}} which intrigued me
and in consequence led to \acro\ and it's option \option{single}.

\acro\ has many similarities with the \pkg{acronym} package.  In fact, quite
some macros have the same name and meaning\footnote{\emph{Not} in the sense of
  \cs*{meaning}!}.

Please take a minute to think and decide which package will suit your needs
best.  Are you planning to add a glossary to your book?  You should probably
go with \pkg{glossaries}, then.  Are you planning to add a nomenclature?  You
may want to choose \pkg{nomencl} (or again: \pkg{glossaries}) and so on.
\acro\ does a good job for lists of abbreviations.

\section{Basics}
\subsection{Creating New Acronyms}
\noindent\changedversion{1.0}Acronyms are created with the command
\cs{DeclareAcronym} that can only be used in the preamble.
\begin{commands}
  \command{DeclareAcronym}[\marg{id}\marg{list of keys}]
    The basic command for declaring an acronym.
\end{commands}
This command understands a number of keys which are listed below.  Some of
them are not described immediately but at appropriate places in the
documentation.
\begin{options}
  %% short
  \keyval{short}{text}\Default!
    the short form of the acronym.  This option is required: an acronym must
    have a short form.  If this is set it \emph{must} be set as first option!
    If another option is set first and notices the \option{short} option
    missing it assumes that the \meta{id} should be used as short version and
    sets it accordingly.  A warning will be written to the log then.
  %% long
  \keyval{long}{text}\Default!
    the long form of the acronym.  This option is required: an acronym must
    have a description.
  %% short-plural
  \keyval{short-plural}{text}\Default{s}
    the plural ending appended to the short form.
  %% long-plural
  \keyval{long-plural}{text}\Default{s}
    the plural ending appended to the long form.
  %% long-plural-form
    \keyval{long-plural-form}{text}
      plural long form of the acronym; replaces the long form when used
      instead of appending the plural ending.
  %% list
  \keyval{list}{text}
    \sinceversion{1.4}if specified this will be written in the list as
    description instead of the long form.
  %% short-indefinite
  \keyval{short-indefinite}{text}\Default{a}
    \sinceversion{1.2}indefinite article for the short form.
  %% long-indefinite
  \keyval{long-indefinite}{text}\Default{a}
    \sinceversion{1.2}indefinite article for the long form.
  %% long-pre
  \keyval{long-pre}{text}
    \sinceversion{1.1}\meta{text} is prepended to the long form in the text
    but not in the list of acronyms.
  %% long-post
  \keyval{long-post}{text}
    \sinceversion{1.1}\meta{text} is appended to the long form in the text but
    not in the list of acronyms.
  %% alt
  \keyval{alt}{text}
    alternative short form.
  %% alt-indefinite
  \keyval{alt-indefinite}{text}\Default{a}
    \sinceversion{1.2}indefinite article for the alternative form.
  %% extra
  \keyval{extra}{text}
    extra information to be added in the list of acronyms.
  %% foreign
  \keyval{foreign}{original long form}
    \sinceversion{1.3}can be useful when dealing with acronyms in foreign
    languages, see section~\ref{ssec:foreign} for details.
  %% sort
  \keyval{sort}{text}
    if used the acronym will be sorted according to this key instead of its
    \acs{id}.
  %% class
  \keyval{class}{text}
    the class the acronym belongs to.
  %% cite
  \keylit{cite}{\oarg{prenote}\oarg{postnote}\marg{citation keys}}
    a citation that is printed to the acronym according to an option explained
    later.
  %% short-format
  \keyval{short-format}{\TeX{} code}
    the format used for the short form of the acronym.
  %% long-format
  \keyval{long-format}{\TeX{} code}
    the format used for the long form of the acronym.
  %% first-long-format
  \keyval{first-long-format}{\TeX{} code}
    the format used for the first long form of the acronym as set with \cs{ac},
    \cs{acf} or \cs{acflike} and their uppercase, plural and indefinite forms.
  %% pdfstring
  \keylit{pdfstring}{\Marg{\meta{text}/\meta{plural ending}}}
    used as \acs{pdf} string replacement in bookmarks when used together with the
    \pkg{hyperref} package.  The appended plural ending is optional.  If you
   leave it (\emph{and} the \code{/}) the default ending is used.
  %% accsupp
  \keyval{accsupp}{text}
    sets the \code{ActualText} key as presented by the \pkg{accsupp} package
    for the acronym.
  %% index-sort
  \keyval{index-sort}{text}
    \sinceversion{1.1}If you use the package option \option{index} every
    occurrence of an acronym is recorded to the index and sorted by its
    \ac{id} or (if set) by the value of the \option{sort} key.  This key
    allows to set an individual sorting option for the index.  See
    section~\ref{ssec:index} for details.
  %% index
  \keyval{index}{text}
    \sinceversion{1.1}This key allows to overwrite the automatic index entry
    with an arbitrary one.  See section~\ref{ssec:index} for details.
 %% index-cmd
  \keyval{index-cmd}{text}
    \sinceversion{1.1}This key let's you set an individual index creating
    command for this acronym.  It should be a command that takes one mandatory
    argument.  See section~\ref{ssec:index} for details.
\end{options}

In its simplest form an acronym needs a short and a long form.  Please note
that both keys \emph{must} be set and that the \option{short} key \emph{must}
always be the \emph{first} key that is set.
\begin{sourcecode}
  % preamble:
  \DeclareAcronym{test}{
    short = ST ,
    long  = Some Test
  }
\end{sourcecode}
This creates the acronym ``\acs{test}'' with the \acs{id} ``test'' and the
long form ``\acl{test}.''

The \option{format} key allows you to choose a specific format for the short
form of an acronym:
\begin{sourcecode}
  % preamble:
  \DeclareAcronym{ot}{
    short        = ot ,
    long         = Other Test ,
    short-format = \scshape
  }
\end{sourcecode}
The short form now looks like this: \acs{ot}.

The \option{cite} key needs a bit explaining.  It expects arguments like the
standard \cs*{cite} command, \latin{i.e.}, two optional arguments setting the
\meta{prenote} and \meta{postnote} and one mandatory argument setting the
citation key.
\begin{sourcecode}
  % preamble:
  \DeclareAcronym{ny}{
    short        = NY ,
    short-plural = ,
    long         = New York ,
    long-plural  = ,
    cite         = {NewYork} 
  }
\end{sourcecode}

\begin{sourcecode}[sourcecode-options={style=cnltx-bibtex}]
  % bib file for use with biber/biblatex:
  @online{NewYork,
    author  = {Wikipedia},
    title   = {New York City},
    urldate = {2012-09-27},
    url     = {http://en.wikipedia.org/wiki/New_York_City},
    year    = {2012}
  }
\end{sourcecode}
The first appearance now looks as follows\footnote{The appearance of the
  citation of course depends on the citation style you're using.}: \acf{ny}.

\subsection{Using the Acronyms -- the Commands}\label{sec:using-acronyms-comm}
Acronyms are used with one of the following commands:
\begin{commands}
  \command{ac}[\sarg\marg{id}]
    basic command; the first output is different from subsequent ones.
  \command{Ac}[\sarg\marg{id}]
    same as \cs{ac} but capitalizes the first letter of the long form.
  \command{acs}[\sarg\marg{id}]
    \h{s}hort form; the actual acronym.
  \command{acl}[\sarg\marg{id}]
    \h{l}ong form; the meaning of the acronym.
  \command{Acl}[\sarg\marg{id}] 
    same as \cs{acl} but capitalizes first letter.
  \command{aca}[\sarg\marg{id}]
    \h{a}lternative short form as specified in the \option{alt} key of
    \cs{DeclareAcronym}; if it hasn't been specified this is identical to
    \cs{acs}.
  \command{acf}[\sarg\marg{id}]
    first form; output like the first time \cs{ac} is output.
  \command{Acf}[\sarg\marg{id}]
    same as \cs{acf} but capitalizes first letter of the long form.
  \command{acp}[\sarg\marg{id}]
    \h{p}lural form of \cs{ac};
  \command{Acp}[\sarg\marg{id}]
    same as \cs{acp} but capitalizes first letter of the long form.
  \command{acsp}[\sarg\marg{id}]
    plural form of \cs{acs};
  \command{aclp}[\sarg\marg{id}]
    plural form of \cs{acl};
  \command{Aclp}[\sarg\marg{id}]
    same as \cs{aclp} but capitalizes first letter.
  \command{acap}[\sarg\marg{id}]
    plural form of \cs{aca};
  \command{acfp}[\sarg\marg{id}]
    plural form of \cs{acf};
  \command{Acfp}[\sarg\marg{id}]
    same as \cs{acfp} but capitalizes first letter of the long form.
\end{commands}
If an acronym is used the first time with \cs{ac} its output is different from
subsequent uses.  To be clear on this: the first time!  If the acronym has
been used with \emph{any} of the output commands before it is \emph{not} the
first time any more.

\sinceversion{0.5}If you use the starred variant an acronym will not be marked
as used.  This proves useful if an acronym is typeset in a section title, for
example, since then the appearance in the table of contents won't mark it as
used.

\begin{example}[side-by-side]
  % preamble:
  % \DeclareAcronym{cd}{
  %   short        = cd ,
  %   long         = Compact Disc ,
  %   short-format = \scshape
  % }
  first time: \ac{cd} \\
  second time: \ac{cd} \\
  short: \acs{cd} \\
  alternative: \aca{cd} \\
  first again: \acf{cd} \\
  long: \acl{cd} \\
  short plural: \acsp{cd} \\
  long plural: \aclp{cd}
\end{example}

\subsection{Plural Forms}
If an acronym is defined in the standard way \acro\ uses an `s' that's appended
to both the short and the long form when one of the plural commands is used.
However, that is not always the best solution.  For one thing not all acronyms
may have a plural form.  Second, the plural form especially of the long forms
may be formed differently.  And third, other languages can have other plural
endings.

For these reasons \cs{DeclareAcronym} can get the following keys:
\begin{options}
  \keyval{short-plural}{text}\Default{s}
    The plural ending of the short form.
  \keyval{long-plural}{text}\Default{s}
    The plural ending of the long form.
  \keyval{long-plural-form}{text}
    An alternative plural form for the long form.
\end{options}
These keys are optional.  If they're not used, the default setting is
\code{s}.  If you use \option{long-plural-form} the long form will be replaced
by the specified plural form when necessary.

Suppose we define the following acronyms:
\begin{sourcecode}
  \DeclareAcronym{cd}{
    short        = cd ,
    long         = Compact Disc ,
    short-format = \scshape
  }
  \DeclareAcronym{ny}{
    short        = NY ,
    short-plural = ,
    long         = New York ,
    long-plural  =
  }
  \DeclareAcronym{sw}{
    short       = SW ,
    long        = Sammelwerk ,
    long-plural = e
  }
  \DeclareAcronym{MP}{
    short            = MP ,
    long             = Member of Parliament ,
    long-plural-form = Members of Parliament
  }
\end{sourcecode}
These acronyms now have the following plural appearances:
\begin{example}[side-by-side]
  \acsp{cd}, \aclp{cd} \\
  \acsp{ny}, \aclp{ny} \\
  \acsp{sw}, \aclp{sw} \\
  \acsp{MP}, \aclp{MP}
\end{example}

\subsection{Alternative Short Forms}
For some acronyms it might be useful to have alternative forms.  For this
\cs{DeclareAcronym} has another key:
\begin{options}
 \keyval{alt}{text}
   Alternative short form.
\end{options}
\begin{example}
  % preamble:
  % \DeclareAcronym{jpg}{
  %   short = JPEG ,
  %   alt   = JPG ,
  %   long  = Joint Photographic Experts Group
  % }
  default: \acs{jpg} \\
  alt.: \aca{jpg}
\end{example}
The alternative form uses the same plural ending as the default short form and
is formatted in the same way.

\subsection{Extra Information for the List Entry}
Of course you can print a list of acronyms where their meaning is explained.
Sometimes it can be useful to add additional information there.  This is done
with another key to \cs{DeclareAcronym}:
\begin{options}
  \keyval{extra}{text}
    Additional information for the list of acronyms.
\end{options}
These information will only be displayed in the list.  See
section~\ref{sec:print_lists} for the impact of the following example.

\begin{example}
  % preamble:
  % \DeclareAcronym{nato}{
  %   short        = nato ,
  %   long         = North Atlantic Treaty Organization ,
  %   extra        = \textit{deutsch}: Organisation des Nordatlantikvertrags ,
  %   short-format = \scshape
  % }
  The \ac{nato} is an intergovernmental military alliance based on the
  North Atlantic Treaty which was signed on 4~April 1949. \ac{nato}
  headquarters are in Brussels, Belgium, one of the 28 member states
  across North America and Europe, the newest of which, Albania and
  Croatia, joined in April 2009.
\end{example}

\subsection{Foreign Language Acronyms}\label{ssec:foreign}
\noindent\sinceversion{1.3}I repeatedly read the wish for being able to add
translations to acronyms when the acronyms stem from another language than the
document language, \latin{i.e.}, something like the following in a German 
document:
\begin{example}[side-by-side]
  \ac{ecu}\\
  \ac{ecu}
\end{example}
That's why I decided to add the following key:
\begin{options}
  \keyval{foreign}{original long form}
    A description for an acronym originating in another language than the
    document language.
\end{options}

Here is the definition of the above mentioned \ac{ecu} acronym:
\begin{sourcecode}
  \DeclareAcronym{ecu}{
    short   = ECU ,
    long    = Steuerger\"at ,
    foreign = Electronic Control Unit
  }
\end{sourcecode}
As you have seen this adds the \option{foreign} entry to the first appearance
of an acronym.  It is also added in parentheses to the list of acronyms after
the \option{long} entry.  Actually the entry there is the argument to the
following command:
\begin{commands}
  \command{acroenparen}[\marg{argument}]
    Places \meta{argument} in parentheses: \cs{acroenparen}\Marg{example}:
    \acroenparen{example}.  See page~\pageref{key:list-foreign-format} for a
    way to customize this other than redefining it.
\end{commands}

\section{Additional Commands and Possibilities}
\subsection{Indefinite Forms}
\noindent\sinceversion{1.2}%
Unlike many other languages\footnote{Let's better say: unlike the other
  languages where I know at least the basics.} in English the indefinite
article is not determined by the grammatical case, gender or number but by the
pronounciation of the following word.  This means that the short and the long
form of an acronym can have different indefinite articles.  For these cases
\acro\ offers the keys \option{short-indefinite}, \option{alt-indefinite} and
\option{long-indefinite} whose default is \code{a}.  For every lowercase
singular command two alternatives exist, preceded by \code{i} and \code{I},
respectively, which output the lowercase and uppercase version of the
corresponding indefinite article.

\begin{example}
  % preamble:
  % \DeclareAcronym{ufo}{
  %   short           = UFO ,
  %   long            = unidentified flying object ,
  %   long-indefinite = an
  % }
  \Iac{ufo}; \iacs{ufo}; \iacl{ufo}
\end{example}

\subsection{Uppercasing}
\begin{commands}
  \command{acfirstupper}[\marg{token list}]
     \sinceversion{1.3e}This command uppercases the first token in \meta{token
       list}.  The command is less powerful than \cs{makefirstuc} that is
     provided by the \pkg{mfirstuc} package~\cite{pkg:mfirstuc} but it is
     expandable.  Obvious downsides are for example that it does not uppercase
     accented letters.
\end{commands}

\subsection{Simulating the First Appearance}
\noindent\sinceversion{1.2}%
Users told me\footnote{Well -- one, to be precise ;)} that there are cases
when it might be useful to have the the acronym typeset according to the
\option{first-style} but with another text than the long form.  For such cases
\acro\ offers the following commands.
\begin{commands}
  \command{acflike}[\sarg\marg{id}\marg{instead of long form}]
    Write some alternative long form for acronym \meta{id} as if it were the
    first time the acronym was used.
  \command{acfplike}[\sarg\marg{id}\marg{instead of long form}]
    Plural form of \cs{acflike}.
\end{commands}

\begin{example}[side-by-side]
  \acsetup{first-style=footnote}
  \acflike{ny}{the big apple}
\end{example}

The plural ending in \cs{acfplike} is only appended to the short form.  It
makes no sense to append it to the text that is inserted manually anyway.
Note that whatever text you're inserting might be gobbled depending on the
\option{first-style} you're using.

\subsection{Using Classes}
The acronyms of \acro\ can be divided into different classes.  This doesn't
change the output but allows different acronym lists, see
section~\ref{sec:print_lists}.  For this \cs{DeclareAcronym} has an additional
key:
\begin{options}
  \keyval{class}{text}
    Associated class for an acronym.
\end{options}

This might be useful if you can and want to divide your acronyms into
different types, technical and grammatical ones, say, that shall be listed in
different lists.

\begin{example}[side-by-side]
  % preamble:
  % \DeclareAcronym{la}{
  %   short        = LA ,
  %   short-plural = ,
  %   long         = Los Angeles ,
  %   long-plural  = ,
  %   class        = city
  % }
  % \DeclareAcronym{ny}{
  %   short        = NY ,
  %   short-plural = ,
  %   long         = New York ,
  %   long-plural  = ,
  %   class        = city ,
  %   cite         = NewYork
  % }
  \acl{la} (\acs{la}) \\
  \acl{ny} (\acs{ny})
\end{example}

\subsection{Reset or Mark as Used, Test if Acronym Has Been Used}

If you want for some reason to fool \acro\ into thinking that an acronym is
used for the first time you can call one of these commands:
\begin{commands}
  \command{acreset}[\marg{comma separated list of ids}]
    \sinceversion{0.5}This will reset a used acronym such that the next use of
    \cs{ac} will again print it as if it were used the first time.  This will
    \emph{not} remove an acronym from being printed in the list if it actually
    \emph{has} been used before.
  \command{acresetall}
    Reset all acronyms.
  \command{acifused}[\marg{id}\marg{true}\marg{false}]
    \sinceversion{1.3e}This command tests if the acronym with \ac{id}
    \meta{id} has already been used and either puts \code{true} or
    \code{false} in the input stream.
\end{commands}
\begin{example}[side-by-side]
  \acreset{ny}\ac{ny}
\end{example}
Beware that both commands act \emph{globally}!  There are also commands that
effectively do the opposite of \cs{acreset}, \latin{i.e.}, mark acronyms as
used:
\begin{commands}
  \command{acuse}[\marg{comma separated list of ids}]
    \sinceversion{0.5}This has the same effect as if an acronym had been used
    twice, that is, further uses of \cs{ac} will print the short form and the 
    acronym will in any case be printed in the list (as long as its class is
    not excluded).
  \command{acuseall}
    \sinceversion{0.6a}Mark all acronyms as used.
\end{commands}

\subsection{\cs*{ac} and Friends in \acs*{pdf} Bookmarks}
\noindent\sinceversion{0.5}\acro's commands usually are not expandable which
means they'd leave unallowed tokens in \acs{pdf} bookmarks.  \pkg{hyperref}
offers \cs*{texorpdfstring} to circumvent that issue manually but that isn't
really a nice solution.  What's the point of having macros to get output for
you if you have to specify it manually after all?

That is why \acro\ offers a preliminary solution for this.  In a bookmark
every \cs{ac} like command falls back to a simple text string typesetting what
\cs{acs} would do (or \cs{acsp} for plural forms).  These text strings both
can accessed manually and can be modified to an output reserved for \acs{pdf}
bookmarks.

\begin{commands}
  \command{acpdfstring}[\marg{id}]
    Access the text string used in \acs{pdf} bookmarks.
  \command{acpdfstringplural}[\marg{id}]
    Access the plural form of the text string used in \acs{pdf} bookmarks.
\end{commands}
\begin{options}
  \keylit{pdfstring}{\Marg{\meta{pdfstring}/\meta{plural ending}}}
    Key for \cs{DeclareAcronym} to declare a custom text string for \acs{pdf}
    bookmarks.  The plural ending can be set optionally.
  \keyval{accsupp}{text}
    \sinceversion{1.0}Key for \cs{DeclareAcronym} to set the \code{ActualText}
    property of \cs*{BeginAccSupp} (see \pkg{accsupp}'s documentation for
    details) to be used for an acronym.  It only has an effect when the
    package option \option{accsupp} is used, too.
\end{options}
  
For example the \acs{pdf} acronym used in the title for this section is defined
as follows:
\begin{sourcecode}
  \DeclareAcronym{pdf}{
    short     = pdf ,
    long      = Portable Document Format ,
    format    = \scshape ,
    pdfstring = PDF ,
    accsupp   = PDF
  }
\end{sourcecode}
 
This also demonstrates the \option{accsupp} key.  For this to work you need to
use the \emph{package option} \option{accsupp}, too, which will load the
package \pkg{accsupp}.  Then the key \option{accsupp} will set the
\code{ActualText} property of \cs*{BeginAccSupp}.  Please refer to
\pkg{accsupp}'s documentation for details.  To see its effect copy \ac{pdf}
and paste it into a text file.  You should get uppercase letters instead of
lowercase ones.

\subsection{Adding Acronyms to the Index}\label{ssec:index}
\noindent\sinceversion{1.1}\acro\ has the package option \option{index}.  If it is
used an index entry will be recorded every time an \emph{unstarred} acronym
command is used.  The index entry will be \code{\meta{id}@\meta{short}},
\code{\meta{sort}@\meta{short}} if the \option{sort} key has been set,
\code{\meta{index-sort}@\meta{short}} if the \option{index-sort} has been set,
or \meta{index} if the key \option{index} has been set for the specific
acronym.  The short versions appearing there are formatted according to the
chosen format of the corresponding acronym, of course.

This document demonstrates the feature.  You can find every acronym that has
been declared in the index.  In order to allow flexibility the indexing
command can be chosen both globally via package option and individually for
every acronym.  This would allow to add acronyms to a specific index if more
than one index is used, for example with help of the \pkg*{imakeidx} package.

I'm not yet convinced this is a feature many people if anyone needs and if
they do if it is flexible enough.  If you have any thoughts on this I'd
appreciate an email.

\section{Printing the List}\label{sec:print_lists}
\noindent\changedversion{1.0}Printing the whole list of acronyms is easy: just
place \cs{printacronyms} where ever you want the list to be.
\begin{commands}
  \command{printacronyms}[\oarg{options}]
    Print the list of acronyms.
\end{commands}
The commands takes a few options, namely the following ones:
\begin{options}
  \keyval{include-classes}{list of classes}
    Takes a comma-separated list of the classes of acronyms that should be in
    the list.
  \keyval{exclude-classes}{list of classes}
    Takes a comma-separated list of the classes of acronyms that should
    \emph{not} be in the list.
  \keyval{name}{name of the list}
    sets the name for the list.
  \keyval{heading}{sectioning command without leading backslash}%
    \Default{section*}
    \changedversion{1.3}Sets the sectioning command for the heading of the
    list.  A special value is \code{none} which suppresses the heading.
  \keybool{sort}\Default{true}
    \sinceversion{1.3}Set sorting for this list only.
\end{options}
\begin{sourcecode}
  \acsetup{extra-style=comma}
  \printacronyms[exclude-classes=city]
 
  \printacronyms[include-classes=city,name={City Acronyms}]
\end{sourcecode}
\acsetup{extra-style=comma}
\printacronyms[exclude-classes=city]

\printacronyms[include-classes=city,name={City Acronyms}]

You can see that the default layout is a \code{description} list with a
\cs*{section}\sarg\ title.  Both can be changed, see
section~\ref{sec:customization}.

The command \cs{printacronyms} needs two \LaTeX{} runs.  This is a precaution
to avoid error messages with a possibly empty list.  But since almost all
documents need at least two runs and often are compiled much more often than
that, this fact shouldn't cause too much inconvenience.

\section{Options and Customization}\label{sec:customization}
\subsection{General Options}
There are a few options which change the general behaviour of \acro.
\default{Underlined} values are used if no value is given.
\begin{options}
  %%
  % \keychoice{version}{0,1}\Default{1}
  %   Provide backwards compatibility for documents set with \acro\ in a version
  %   prior to v1.0.
  %%
  \keychoice{messages}{silent,loud}\Default{loud}
    \sinceversion{1.6}Setting \keyis{messages}{silent} will turn all of
    \acro's error messages into warnings and all of \acro's warnings into info
    messages.  Be sure to check the log file carefully if you decide to set
    this option.
  \keybool{single}\Default{false}
    If set to \code{true} an acronym that's used only once (with \cs{ac}) in a
    document will only print the acronym in a specified form and will not be
    printed in the list.
  %%
  \keychoice{single-form}{long,short,alt,first}\Default{long}
    \sinceversion{2.}Determines how a single appearance of an acronym is
    printed if \keyis{single}{true} has been chosen.
  %%
  \keybool{hyperref}\Default{false}
    If set to \code{true} the short forms of the acronyms will be linked to
    their list entry.
  %%
  \keybool{label}\Default{false}
    \sinceversion{1.5}If set to \code{true} this option will place
    \cs*{label}\Marg{\meta{prefix}\meta{id}} the first time the acronym with
    \ac{id} \meta{id} is used.
  %%
  \keyval{label-prefix}{text}\Default{ac:}
    \sinceversion{1.5}The prefix for the \cs*{label} that is placed when
    option \keyis{label}{true} is used.
  %%
  \keybool{record-pages}\Default{true}
    Since \acro\ can handle arabic, roman and Roman page numbers but
    \emph{not} any other kind of numbering this option allows to turn the page
    number recording off for these cases as it would lead to errors else.
    This affects the whole document and can only be set in the preamble!  It
    means you cannot have page numbers in the list of acronyms in this case.
    Or rather: you can if you use \keyis{pages}{first}.
  %%
  \keybool{only-used}\Default{true}
    This option is \code{true} as default.  It means that only acronyms that
    are actually used in the document are printed in the list.  If
    \code{false}, all acronyms defined with \cs{DeclareAcronym} will be
    written to the list.
  %%
  \keychoice{mark-as-used}{first,any}\Default{any}
    \sinceversion{1.2}%
    This option determines wether an acronym is mark as used when the
    \emph{first} form is used the first time (with \cs{ac}, \cs{acf} or
    \cs{acflike} and their uppercase, plural and indefinite forms) or when any
    of the \cs{ac}-like commands is used.   
  %%
  \keybool{macros}\Default{false}
    If set to \code{true} this option will create a macro \cs*{\meta{id}} for
    each acronym as a shortcut for \cs{ac}\marg{id}.  Already existing macros
    will \emph{not} be overwritten.
  %%
  \keybool{xspace}\Default{false}
    \sinceversion{0.6}If set to \code{true} this option will append
    \cs*{xspace} from the \pkg*{xspace} package to the commands created with
    the \option{macros} option.
  %%
  \keybool{strict}\Default{false}
    If set to \code{true} and the option \keyis{macros}{true} is in effect
    then already existing macros will be overwritten.
  %%
  \keybool{sort}\Default{true}
    If set to \code{true} the acronym list will be sorted automatically.  The
    entries are sorted by their \acs{id} ignoring upper and lower case.  This
    option needs the experimental package \pkg{l3sort} (from the
    \pkg{l3experimental} bundle) and can only be set in the preamble.
  %%
  \keychoice{cite}{\default{all},first,none}\Default{first}
    This option decides whether citations that are added via \option{cite} are
    added to each first, every or no appearance of an acronym.
  %%
  \keyval{cite-cmd}{control sequence}\Default{\cs*{cite}}
    This option determines which command is used for the citation.  Each
    citation command that takes the cite key as argument is valid, for example
    \pkg*{biblatex}'s \cs*{footcite}.
  %%
  \keyval{cite-connect}{code}\Default{\cs*{nobreakspace}}
    Depending on the citation command in use a space should be inserted before
    the citation or maybe not (e.g.\ \cs*{footcite}\ldots).  This option
    allows you to set this.  Actually it can be used to place arbitrary code
    right before the citation.
  %%
  \keybool{group-citation}\Default{false}
    \sinceversion{2.0}If set to true the short form (or the long form) and the
    citation of an acronym will be printed together in parentheses when an
    acronym is used the first time.
  %%
  \keyval{group-cite-cmd}{control sequence}\Default{\cs*{cite}}
    \sinceversion{2.0}This option determines which command is used for the
    citation when an acronym is used the first time \emph{and}
    \keyis{group-citation}{true}.  Each citation command that takes the cite
    key as argument is valid, for example \pkg*{biblatex}'s \cs*{footcite}.
  %%
  \keybool{index}\Default{false}
    \sinceversion{1.1}If set to \code{true} an index entry will be recorded
    every time an \emph{unstarred} acronym command is used for the
    corresponding acronym.
  %%
  \keyval{index-cmd}{control sequence}\Default{\cs*{index}}
    \sinceversion{1.1}Chooses the index command that is used when option
    \option{index} has been set to \code{true}.
  %%
  \keybool{accsupp}\Default{false}
    \sinceversion{1.0}Activates the access support as provided by the
    \pkg{accsupp} package.
  %%
  \keyval{uc-cmd}{control sequence}\Default{\cs{acfirstupper}}
    The command that is used to capitalize the first word in the \cs{Ac} and
    the like commands.  You can change it to another one like for example
    \cs*{makefirstuc}\footnote{from the \pkg{mfirstuc} package} or
    \cs*{MakeTextUppercase}\footnote{from the \pkg*{textcase} package}.
\end{options}
 
All options of this and the following sections can be set up either as package
options or via the setup command:
\begin{commands}
  \command{acsetup}[\marg{options}]
   Set up \acro\ anywhere in the document.  Or separate package loading from
   setup.
\end{commands}

\begin{example}
  % with \acsetup{macros}
  we could have used these before: \nato, \ny
\end{example}

\subsection{Options Regarding Acronyms}
The options described in this section all influence the layout of one of the
possible output forms of the acronyms.
\begin{options}
  %%
  \keyval{short-format}{format}\Default
    Sets a format for all short forms. For example
    \keyis{short-format}{\cs*{scshape}} would print all short forms in small
    caps.
  %%
  \keyval{long-format}{format}\Default
    The same for the long forms.
  %%
  \keyval{foreign-format}{format}\Default
    \sinceversion{1.3}%
    The format for the \option{foreign} entry when it appears as part of the
    first appearance of an acronym.
  %%
  \keyval{first-long-format}{format}\Default
    \sinceversion{1.2}%
    The format for the long form on first usage (with \cs{ac}, \cs{acf} or
    \cs{acflike} and their uppercase, plural and indefinite forms).
  %%
  \keyval{list-short-format}{format}\Default
    \sinceversion{1.1}An extra format for the short entries in the list.  If
    not used this is the same as \option{short-format}.  Please be aware that
    a call of \option{short-format} after this one will overwrite it again.
  %%
  \keyval{list-long-format}{format}\Default
    An extra format for the long entries in the list.  If not used this is the
    same as \option{long-format}.  Please be aware that a call of
    \option{long-format} after this one will overwrite it again.
  %%
  \keyval{list-foreign-format}{format}\Default{\cs{acroenparen}}
    \label{key:list-foreign-format}The format for the \option{foreign} entry
    as it appears in the list.  This may be code that ends with a macro that
    takes a mandatory argument.
  %%
  \keyval{extra-format}{format}\Default
    The same for the extra information.
  %%
  \keychoice{first-style}{default,plain,empty,square,short,reversed,plain-reversed,footnote,sidenote}\Default{default}
    \changedversion{1.1}The basic style of the first appearance of an
    acronym.  The value \code{sidenote} needs the command \cs*{sidenote} to be
    defined for example by the \pkg*{sidenotes} package.
  %%
  \keychoice{extra-style}{default,plain,comma,paren,bracket}\Default{default}
    Defines the way the extra information is printed in the list.
  %%
  \keyval{plural-ending}{tokenlist}\Default{s}
    With this option the default plural ending can be set.
\end{options}
 
\begin{example}[side-by-side]
  % (Keep in mind that we're in
  % a minipage here!)
  \acsetup{first-style=empty}
  \acf{ny} \\
  \acsetup{first-style=footnote}
  \acf{ny} \\
  \acsetup{first-style=square}
  \acf{ny} \\
  \acsetup{first-style=short}
  \acf{ny} \\
  \acsetup{first-style=reversed}
  \acf{ny} \\
  \acsetup{first-style=plain}
  \acf{ny} \\
  \acsetup{first-style=plain-reversed}
  \acf{ny}
\end{example}

\subsection{Options Regarding the List}
\begin{options}
  %%
  \keychoice{page-ref}{none,plain,comma,paren}\Default{none}
    If this option is set to a value other than \code{none} the page numbers
    of the an acronym appeared on are printed in the list.  Please note that
    this is an experimental feature and might fail in quite a number of cases.
    If you notice anything please send me an email!
  %%
  \keychoice{pages}{all,first}\Default{all}
    \sinceversion{1.5}If the option \option{page-ref} has any value other than
    \code{none} this option determines wether all usages of the acronyms are
    listed or only the first time.  Implicitly sets \keyis{label}{true}.
  \keyval{page-name}{page name}\Default{p.\cs*{@}\cs*{,}}
    The ``name'' of the page label.  This is automatically translated to the
    active language. However for the time being there are many translations
    missing, yet.  Please notify me if you find your language missing.
  %%
  \keyval{pages-name}{page name plural}\Default{pp.\cs*{@}\cs*{,}}
    \sinceversion{1.0}The ``name'' of the page label when there are more than
    one page.  This is automatically translated to the active language.
    However for the time being there are many translations missing, yet.
    Please notify me if you find your language missing.
  %%
  \keybool{following-page}\Default{false}
    \sinceversion{1.3}If set to \code{true} a page range in the list of
    acronyms that consists of two pages will be written by the first page and
    an appended \code{f}. This depends on the option \option{next-page}.
  %%
  \keybool{following-pages}\Default{false}
    \sinceversion{1.3}If set to \code{true} a page range in the list of
    acronyms that set consists of more than two pages will be written by the
    first page and an appended \code{ff}. This depends on the option
    \option{next-pages}.
  %%
  \keyval{next-page}{text}\Default{\cs*{,}f.\cs*{@}}
    \sinceversion{1.0}Appended to a page number when \option{following-page}
    is set to \code{true} and the range is only 2 pages long.  This is
    automatically translated to the active language.  However, for the time
    being there are many translations missing, yet.  Please notify me if you
    find your language missing.
  %%
  \keyval{next-pages}{text}\Default{\cs*{,}ff.\cs*{@}}
    \sinceversion{1.0}Appended to a page number when \option{following-pages}
    is set to \code{true} and the range is more than 2 pages long.  This is
    automatically translated to the active language.  However, for the time
    being there are many translations missing, yet.  Please notify me if you
    find your language missing.
  %%
  \keychoice{list-type}{table|\meta{list}}\Default{description}
    This option let's you choose how the list is printed.  \meta{list} can be
    any valid list like \env{itemize} or \env{description}.
  %%
  \keychoice{list-style}{list,tabular,longtable,extra-tabular,extra-longtable,%
    extra-tabular-rev,extra-longtable-rev}\Default{list}
    If you choose \keyis{list-type}{table} you have to specify which kind of
    table should be used.  If you choose \code{longtable},
    \code{extra-longtable} or \code{extra-longtable-rev} you have to load
    \pkg{longtable} in your preamble.  The values \code{extra-longtable} and
    \code{extra-longtable-rev} put the extra information in a column of its
    own.
  %%
  \keychoice{list-heading}{chapter,chapter*,section,section*,subsection,%
    subsection*,subsubsection,subsubsection*,addchap,addsec,none}\null
  \Default{section*}
    \changedversion{2.0}The heading type of the list. The last two only work
    with a \KOMAScript{} class that also defines the appropriate command.  A
    special value is \code{none} which suppresses the heading.
  %%
  \keyval{list-name}{list name}\Default{Acronyms}
    The name of the list.  This is what's written in the list-heading.  This
    is automatically translated to the active language.  However, for the time
    being there are many translations missing, yet.  Please notify me if you
    find your language missing.
  %%
  \keyval{list-table-width}{dimension}\Default{.7\cs*{linewidth}}
    This has only an effect if you chose \key{list-type}{table}.  The
    \emph{second} column (or the third if you choose one of the \code{-rev}
    styles) of the table is a \code{p} column whose width can be specified
    with this option.
  %%
  \keybool{list-caps}\Default{false}
    Print the first letters of the long form capitalized.
 \end{options}
  
If you for example have loaded \pkg{enumitem} you can define a custom list for
the acronym list:
\begin{sourcecode}
  % preamble:
  % \usepackage{enumitem}
  \newlist{acronyms}{description}{1}
  \newcommand*\addcolon[1]{#1:}
  \setlist[acronyms]{
    labelwidth=3em,
    leftmargin=3.5em,
    noitemsep,
    itemindent=0pt,
    font=\addcolon}
  \acsetup{list-type=acronyms,hyperref=false,extra-style=comma}
  \printacronyms
\end{sourcecode}
\newlist{acronyms}{description}{1}
\newcommand*\addcolon[1]{#1:}
\setlist[acronyms]{
  labelwidth=3em,
  leftmargin=3.5em,
  noitemsep,
  itemindent=0pt,
  font=\addcolon}
\acsetup{list-type=acronyms,extra-style=comma}
\printacronyms

\subsection{Other Heading Command}
If you want a \option{list-heading} which is not yet provided you can add your
own option:
\begin{sourcecode}
  \DeclareInstance{acro-title}{myname}{sectioning}
    { name-format = command that uses #1 }
\end{sourcecode}
After that you could use \keyis{list-heading}{myname}.

\section{Trailing Tokens and Special Action}

\acro\ has the possibility\sinceversion{2.0} to look ahead for certain tokens
and switch a boolean if it finds them.  Per default \acro\ knows about three
tokens: the \enquote{\code{dot}} (\code{.}), the \enquote{\code{dash}}
(\code{-}) and the \enquote{\code{babel-hyphen}} (\cs*{babelhyphen}).

A token is made known to \acro\ with the following macro:
\begin{commands}
  \command{AcroRegisterTrailing}[\meta{token}\marg{name}]
    This registers the token \meta{token} so \acro\ looks if it follows
    directly after an acronym macro.  \meta{name} is the internal name for
    this token.
\end{commands}
The \acro\ package already registers the above mentioned tokens:
\begin{sourcecode}
  \AcroRegisterTrailing . {dot}
  \AcroRegisterTrailing - {dash}
  \AcroRegisterTrailing \babelhyphen {babel-hyphen}
\end{sourcecode}

If a token is registered it doesn't mean that \acro\ looks for it.  The token
must first be activated for this:
\begin{options}
  \keyval{activate-trailing-tokens}{csv list of token names}
    Tell \acro\ to look for trailing tokens.  This is done by giving a csv
    list of the internal \emph{names} of the tokens.  Per default only
    \code{dot} is activated.
  \keyval{deactivate-trailing-tokens}{csv list of token names}
    Tell \acro\ not to look for trailing tokens.  This is done by giving a csv
    list of the internal \emph{names} of the tokens.
\end{options}

All the above on its own does nothing visible. However: inside of an acronym,
\ie, for example inside the long or the short form it can be tested for those
trailing options:
\begin{commands}
  \command{aciftrailing}[\marg{csv list of token
    names}\marg{true}\marg{false}]
    Check if one of the tokens listed in \meta{csv list of token names} is
    following and either place \meta{true} or \meta{false} in the input
    stream.
\end{commands}
\acro\ uses this to define to further macros:
\begin{commands}
  \command{acdot} Inserts a \code{.} if no \code{dot} follows.
  \command{acspace} Inserts a \cs*{space} if no \code{dash} or
    \code{babel-hyphen} follows.
\end{commands}
The definitions are equivalent to the following code:
\begin{sourcecode}
  \newcommand*\acdot{\aciftrailing{dot}{}{.}}
  \newcommand*\acspace{\aciftrailing{dash,babel-hyphen}{}{\space}}
\end{sourcecode}

This could be used to define an acronym as follows:
\begin{sourcecode}
  \DeclareAcronym{etc}{
    short = {\textit{etc}\acdot} ,
    long  = {\textit{et cetera}} ,
    short-plural = , long-plural =
  }
\end{sourcecode}
If now you somewhere use
\begin{sourcecode}
  \ac{etc}.
\end{sourcecode}
there won't be two dots printed.

The command \cs{acspace} is used already in the definition of the first
appearance of a macro.  Let's say you're a German chemist and you have
\begin{sourcecode}
  \DeclareAcronym{PU}{
    long = Polyurethan ,
    long-plural = e
  }
\end{sourcecode}
and you use it the first time like this:
\begin{sourcecode}
  \ac{PU}-Hartschaum
\end{sourcecode}
then according to German orthography and typesetting rules this should be
printed as
\begin{center}
  \enquote{Polyurethan(PU)-Hartschaum}
\end{center}
\ie, with \emph{no} space between long and short form.  This is exactly what
happens it you say
\begin{sourcecode}
  \acsetup{activate-trailing-tokens = {dash,babel-hyphen}}
\end{sourcecode}
in the preamble.

\section{About Page Ranges}
If you enable the \option{page-ref} option \acro\ adds page numbers to the list
of acronyms.  In version~0.\versionstar{} it would add a page reference for an
acronym in the list of acronyms that used \cs*{pageref} to refer to the first
appearance of an acronym.  This is retained using \keyis{pages}{first}.
Version~1.0 uses a different approach that doesn't use a label but instead
will list \emph{all} pages an acronym appeared on.  With \pkg{hyperref} the
pages are referenced using \cs*{hyperpage}.

There are some options that control how this list will be typeset, e.g.,
\option{following-page}, \option{next-pages} or the option \option{page-ref}
itself.  It is important to mention that the page list will always take at
least two compilation runs until changes in the options or the actual page
numbers affect it.  This is due to the fact that the updated sequence is first
written to the \code{aux} file and only read in during the next run.


\section{Language Support}
\acro\ detects if packages \pkg*{babel} or \pkg*{polyglossia} are being loaded
and tries to adapt certain strings to match the chosen language.  However, due
to my limited language knowledge only a few translations are provided.  I'll
show how the English translations are defined so you can add the translations
to your preamble if needed.  Even better would be you'd send me a short email
at \href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu} with the
appropriate translations for your language and I'll add them to \acro.

\begin{sourcecode}
  \DeclareTranslation{English}{acronym-list-name}{Acronyms}
  \DeclareTranslation{English}{acronym-page-name}{p.}
  \DeclareTranslation{English}{acronym-pages-name}{pp.}
  \DeclareTranslation{English}{acronym-next-page}{f.}
  \DeclareTranslation{English}{acronym-next-pages}{ff.}
\end{sourcecode}

\section{hyperref Support}
The option \keyis{hyperref}{true} adds internal links from all short (or
alternative) forms to their respective list entries.  Of course this only
works if you have loaded the \pkg{hyperref} package in your preamble.  You
should use this option with care: if you don't use \cs{printacronyms} anywhere
this option will result in loads of \pkg{hyperref} warnings.  Also printing
several lists can result in warnings if don't clearly separate the lists into
different classes.  If an acronym appears in more than one list there will
also be more than one hypertarget for this acronym.

Using \pkg{hyperref} will also add \cs*{hyperpage} to the page numbers in the
list (provided they are displayed in the style chosen).  Like with an index
the references will thus not point to the acronyms directly but to the page
they're on.

\section{Defining Own Acronym Macros}\label{sec:defining-own-acronym}

The commands\sinceversion{2.0}\sinceversion{2.0}\sinceversion{2.0} explained in
section~\ref{sec:using-acronyms-comm} have all been defined with a dedicated
command -- there is a family of dedicated commands, actually:
\begin{commands}
  \command{NewAcroCommand}[\marg{cs}\marg{code}]
    Defines a new \acro\ acronym command \meta{cs}.  This sets up the
    necessary framework needed by acronym commands and defines \meta{cs} with
    an optional star argument and a mandatory argument for the acronym id
    using \pkg{xparse}'s \cs*{NewDocumentCommand}. Inside \meta{code} one can
    refer to the id with \code{\#1}.
  \command{RenewAcroCommand}[\marg{cs}\marg{code}]
    Defines a new \acro\ acronym command \meta{cs}.  This sets up the
    necessary framework needed by acronym commands and defines \meta{cs} with
    an optional star argument and a mandatory argument for the acronym id
    using \pkg{xparse}'s \cs*{RenewDocumentCommand}. Inside \meta{code} one
    can refer to the id with \code{\#1}.
  \command{DeclareAcroCommand}[\marg{cs}\marg{code}]
    Defines a new \acro\ acronym command \meta{cs}.  This sets up the
    necessary framework needed by acronym commands and defines \meta{cs} with
    an optional star argument and a mandatory argument for the acronym id
    using \pkg{xparse}'s \cs*{DeclareDocumentCommand}. Inside \meta{code} one
    can refer to the id with \code{\#1}.
  \command{ProvideAcroCommand}[\marg{cs}\marg{code}]
    Defines a new \acro\ acronym command \meta{cs}.  This sets up the
    necessary framework needed by acronym commands and defines \meta{cs} with
    an optional star argument and a mandatory argument for the acronym id
    using \pkg{xparse}'s \cs*{ProvideDocumentCommand}. Inside \meta{code} one
    can refer to the id with \code{\#1}.
\end{commands}

Inside these macros one can use a number of low-level expl3
commands\footnote{Which is why you need to use them inside an expl3
  programming environment.  This means in the preamble surround the
  definitions with \cs*{ExplSyntaxOn} and \cs*{ExplSyntaxOff}.}.

\paragraph{Acronym fetching commands}
\begin{commands}
  \command*{acro_use:n}[ \marg{id}]
    Fetches the acronym using either the first or the long form depending on
    earlier uses.
  \command*{acro_short:n}[ \marg{id}]
    Fetches the short form of the acronym.
  \command*{acro_long:n}[ \marg{id}]
    Fetches the long form of the acronym.
  \command*{acro_alt:n}[ \marg{id}]
    Fetches the alternative short form of the acronym.
\end{commands}

\paragraph{Acronym setup commands}
\begin{commands}
  \command*{acro_first_upper:}
    \acro\ setup command which tells the macros above that we want to
    uppercase the first letter of the long version.  Should be used
    \emph{before} one of the acronym fetching commands.
  \command*{acro_plural:}
    \acro\ setup command which tells the macros above that we want to use
    plural forms. Should be used \emph{before} one of the acronym fetching
    commands.
  \command*{acro_indefinite:}
    \acro\ setup command which tells the macros above that we want to add the
    indefinite article.  Should be used \emph{before} one of the acronym
    fetching commands.
  \command*{acro_cite:}
    \acro\ setup command which tells the macros above that we want to add the
    citation in any case independent of the option \option{cite}.  Should be
    used \emph{before} one of the acronym fetching commands.
  \command*{acro_no_cite:}
    \acro\ setup command which tells the macros above that we want to have no
    citation independent of the option \option{cite}.  Should be used
    \emph{before} one of the acronym fetching commands.
  \command*{acro_index:}
    \acro\ setup command which tells the macros above that we want to add an
    index in any case independent of the option \option{index}.  Should be
    used \emph{before} one of the acronym fetching commands.
\end{commands}

\paragraph{Additional macros for further uses}
\begin{commands}
  \command*{acro_begin:}
    When an acronym macro is defined \enquote{by hand}, \ie, not using
    \cs{NewAcroCommand} then this should be the first macro in the code.  Must
    have a matching \cs*{acro_end:}.
  \command*{acro_end:}
    When an acronym macro is defined \enquote{by hand}, \ie, not using
    \cs{NewAcroCommand} then this should be the last macro in the code.  Must
    have a matching \cs*{acro_begin:}.
  \command*{acro_check_and_mark_if:nn}[ \marg{boolean expression} \marg{id}]
    Checks if the acronym \meta{id} exists and marks it as used when
    \meta{boolean} expression evaluates to \code{true}.  This macro is used
    inside \cs{NewAcroCommand} and friends.
  \command*{acro_check_acronym:nn}[ \marg{id} \Marg{true|false}]
    Checks if the acronym \meta{id} exists and marks it as used if \code{true}
    or doesn't.  This macro is used inside \cs*{acro_check_and_mark_if:nn}.
  \command*{acro_use_acronym:n}[ \Marg{true|false}]
    Mark an acronym as used or don't.  This macro is used inside
    \cs*{acro_check_acronym:nn}.  An acronym marked as used cannot be
    unmarked.
  \expandable\command*{acro_if_acronym_used:n}[\TF\ \marg{id} \marg{true}
  \marg{false}]
    The code-level version of \cs{acifused}.  This macro is expandable.
\end{commands}

\paragraph{Examples}
The usage of above macros is best explained with a few examples.  The
following definition is done by \acro:
\begin{sourcecode}
  \NewAcroCommand \ac { \acro_use:n {#1} }
\end{sourcecode}
An equivalent definition for \cs{ac} would be
\begin{sourcecode}
  \NewDocumentCommand \ac {sm}
    {
      \acro_begin:
        \acro_check_and_mark_if:nn {#1} {#2}
        \acro_use:n {#2}
      \acro_end:
    }
\end{sourcecode}
which should explain what the actual framework is which \cs{NewAcroCommand}
adds.

Other definitions by \acro\ are for example the following ones:
\begin{sourcecode}
  \NewAcroCommand \Ac
    {
      \acro_first_upper:
      \acro_use:n {#1}
    }
  \NewAcroCommand \acp
    {
      \acro_plural:
      \acro_use:n {#1}
    }
  \NewAcroCommand \Acp
    {
      \acro_plural:
      \acro_first_upper:
      \acro_use:n {#1}
    }
  \NewAcroCommand \Aclp
    {
      \acro_plural:
      \acro_first_upper:
      \acro_long:n {#1}
    }
\end{sourcecode}

\section{About Plural Forms, Possessive Forms and Similar Constructs -- the
  Concept of Endings}

\acro\ has a concept of \emph{endings}.  All of \acro's plural options are
defined by saying
\begin{sourcecode}
  \ProvideAcroEnding {plural} {s} {s}
\end{sourcecode}
The command's syntax and what it does is as follows:
\begin{commands}
  \command{ProvideAcroEnding}[\marg{name}\marg{short default}\marg{long default}]
    This macro defines the options
    \begin{itemize}
      \item \option*{\meta{name}-ending},
      \item \option*{short-\meta{name}-ending},
      \item \option*{alt-\meta{name}-ending} and
      \item \option*{long-\meta{name}-ending}.
    \end{itemize}
    It also defines the acronym properties
    \begin{itemize}
      \item \option*{short-\meta{name}},
      \item \option*{short-\meta{name}-form},
      \item \option*{alt-\meta{name}},
      \item \option*{alt-\meta{name}-form},
      \item \option*{long-\meta{name}} and
      \item \option*{long-\meta{name}-form}.
    \end{itemize}
    Additionally it defines a setup macro as
    described in section~\ref{sec:defining-own-acronym},
    \cs*{acro_\meta{name}:}.  If \meta{name} contains a \code{-} (dash) it is
    replaced by \code{\_} before \cs*{acro_\meta{name}:} is built.  So if you
    choose \code{my-name} the corresponding macro is named
    \cs*{acro_my_name:}.  If you use any other non-letters you are on your
    own.

    Note that you \emph{must use \cs{ProvideAcroEnding} before any acronym
      definition}!
\end{commands}

This could be used together with the macros described in
section~\ref{sec:defining-own-acronym} for adding support for possessive
forms:
\begin{example}
  \ExplSyntaxOn
  % this now only works because I've use the same already in the preamble so
  % it does nothing here:
  \ProvideAcroEnding {possessive} {'s} {'s}

  \NewAcroCommand \acg
    {
      \acro_possessive:
      \acro_use:n {#1}
    }
  \ExplSyntaxOff
  The \acg{cd} booklet says\ldots
\end{example}

Please note that different endings are cumulative which you probably want to
avoid! Imagine a macro
\begin{sourcecode}
  \NewAcroCommand \acgp
    {
      \acro_possessive:
      \acro_plural:
      \acro_use:n {#1}
    }
\end{sourcecode}
This would give \enquote{\ac{cd}s's} instead of \enquote{\ac{cd}s'}.  To solve
this you might want to consider
\begin{sourcecode}
    \ProvideAcroEnding {possessive-singular} {'s} {'s}
    \ProvideAcroEnding {possessive-plural}   {s'} {s'}
\end{sourcecode}

\appendix

\section{All Acronyms Used in this Documentation}\label{sec:documentation_acronyms}
\begin{sourcecode}
  \acsetup{
    list-type    = table,
    list-style   = longtable,
    list-heading = subsection*,
    extra-style  = comma,
    page-ref     = comma
  }
  \printacronyms[name=All Acronyms]
\end{sourcecode}
\acsetup{
  list-type    = table,
  list-style   = longtable,
  list-heading = subsection*,
  extra-style  = comma,
  page-ref     = comma
}
\printacronyms[name=All Acronyms]

\begin{sourcecode}
  \acsetup{
    list-type    = table,
    list-style   = longtable,
    list-heading = subsection*,
    page-ref     = comma
  }
  \printacronyms[include-classes=city,name=City Acronyms]
\end{sourcecode}
\printacronyms[include-classes=city,name=City Acronyms]

\end{document}