-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathdocumentation.ltx
1735 lines (1419 loc) · 67.4 KB
/
documentation.ltx
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
%------------------------------------------------------------------------------
% Template file for the submission of papers to IUCr journals in LaTeX2e
% using the iucr document class
% Copyright 1999-2003 International Union of Crystallography
% Version 1.2 (11 December 2002)
%------------------------------------------------------------------------------
\documentclass{iucr} % DO NOT DELETE THIS LINE
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\def\href#1{\relax}\let\foo\caption
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% To generate hyperlinked PDF, change the \documentclass line
% to say \documentclass[pdf]{iucr} and process with pdflatex
\ifPDF
\RequirePackage{hyperref}
\PassOptionsToPackage{pdftex,bookmarksopen,bookmarksnumbered}{hyperref}
\voffset=-0.5in
\fi
\let\caption\foo
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%------------------------------------------------------------------------------
% Information about the type of paper
%------------------------------------------------------------------------------
\paperprodcode{a000000} % Replace with production code if known
\paperref{xx9999} % Replace xx9999 with reference code if known
\papertype{IU} % Indicate type of article
% FA - research papers (full article)
% SC - short communications
% FC - fast communications
% LA - lead article
% TR - topical review
% XL - crystallization papers
% (Following categories rarely in LaTeX)
% AA - abstracts
% AD - addenda and errata
% AI - inorganic compounds
% AM - metal-organic compounds
% AO - organic compounds
% BC - books received
% BR - book reviews
% BI - biography
% CA - cif applications
% CD - crystal data
% CE - current events
% CI - inorganic compounds
% CL - calendar of events
% CM - metal-organic compounds
% CN - cryocrystallography papers
% CO - organic compounds
% CP - computer programs
% CR - crystallographers
% CS - scientific comment
% ED - editorial
% EI - inorganic compounds
% EM - metal-organic compounds
% EO - organic compounds
% FI - inorganic compounds
% FM - metal-organic compounds
% FO - organic compounds
% IP - issue preface
% IU - iucr
% LE - letters to the editor
% LN - laboratory notes
% ME - forthcoming meetings/short courses
% MR - meeting reports
% NN - notes and news
% NP - new commercial products
% OB - obituaries
% PA - computer program abstracts
% RI - reference information
% SG - structural genomics papers
% SI - short format inorganic compounds
% SM - short format metal-organic compounds
% SO - short format organic compounds
% SP - short structural papers
% SR - software reviews
% TE - teaching and education
\paperlang{english} % Can be english, french, german or russian
%------------------------------------------------------------------------------
% Information about journal to which submitted
%------------------------------------------------------------------------------
%\journalcode{A} % Indicate the journal to which submitted
% A - Acta Crystallographica Section A
% B - Acta Crystallographica Section B
% C - Acta Crystallographica Section C
% D - Acta Crystallographica Section D
% J - Journal of Applied Crystallography
% S - Journal of Synchrotron Radiation
%-------------------------------------------------------------------------
% The following entries will be changed as required by editorial staff
%-------------------------------------------------------------------------
\journalyr{2003}
%\journaliss{1}
%\journalvol{57}
%\journalfirstpage{1}
%\journallastpage{11}
\journalreceived{\relax}
\journalaccepted{\relax}
\journalonline{\relax}
\begin{document} % DO NOT DELETE THIS LINE
%-------------------------------------------------------------------------
% The introductory (header) part of the paper
%-------------------------------------------------------------------------
% The title of the paper. Use \shorttitle to indicate an abbreviated title
% for use in running heads (you will need to uncomment it).
\title{Sample Paper Using the IUCr \LaTeX{} Macro Package\footnote{Version 2}}
\shorttitle{IUCr LaTeX sample}
% Authors' names and addresses. Use \cauthor for the main (contact) author.
% Use \author for all other authors. Use \aff for authors' affiliations.
% Use lower-case letters in square brackets to link authors to their
% affiliations; if there is only one affiliation address, remove the [a].
\author[a,b]{J.}{Soape}
\author[b]{A. N.}{Author}
\cauthor[a]{John}{Doe}{[email protected]}{}\aufn{On leave from Institute of
Advanced Research, Albany, Ruritania.}
\aff[a]{Baskerville Lodge, \city{Dartmoor}, Devon, \country{England}}
\aff[b]{3 Watery Way, \city{Full Fathom} 5, \country{Atlantis}}
% Use \shortauthor to indicate an abbreviated author list for use in
% running heads (you will need to uncomment it).
\shortauthor{Soape, Author and Doe}
% Use \vita if required to give biographical details (for authors of
% invited review papers only). Uncomment it.
\vita{Joe Soape is an archetypal generic author, whose association with the
much-travelled Kilroy has extended over many years. He travels to work each
day on a Clapham omnibus.
\\
John Doe is also a generic individual with extensive experience of legal and
forensic matters.}
% Keywords (required for Journal of Synchrotron Radiation only)
% Use the \keyword macro for each word or phrase, e.g.
% \keyword{X-ray diffraction}\keyword{muscle}
\keyword{\LaTeX}
\keyword{class file}
\keyword{documentation}
% PDB and NDB reference codes for structures referenced in the article and
% deposited with the Protein Data Bank and Nucleic Acids Database (Acta
% Crystallographica Section D). Repeat for each separate structuree.g.
% \PDBref[dethiobiotin synthetase]{1byi} \NDBref[d(G$_4$CGC$_4$)]{ad0002}
%\PDBreference[optional name]{refcode}
%\NDBreference[optional name]{refcode}
\maketitle % DO NOT DELETE THIS LINE
\begin{synopsis}
Documentation of the IUCr \LaTeX{} macro package and a demonstration of its
use in constructing a paper for an IUCr journal.
\end{synopsis}
\begin{abstract}
This document describes how to obtain and use the \emph{iucr} \LaTeX{} macro
package for submitting articles in \LaTeX{}2$\varepsilon$ format to IUCr
journals (\emph{Acta Crystallographica, Journal of Applied Crystallography,
Journal of Synchrotron Radiation}).
\end{abstract}
%-------------------------------------------------------------------------
% The main body of the paper
%-------------------------------------------------------------------------
% Now enter the text of the document in multiple \section's, \subsection's
% and \subsubsection's as required.
\section{Purpose}
The International Union of Crystallography (IUCr) publishes a number of
specialist scientific journals, many containing complex mathematics. The
journal articles are held as electronic files for typesetting and electronic
publication. The common format for the article files is SGML, an ISO standard
that allows a specific structure to be defined for a class of documents
through a machine-readable \emph{document type definition} (DTD). Detailed
markup of the article with SGML codes allows portions of the article to be
indexed, hyperlinked or stored in databases. Mathematical formulae within the
document are encoded in \TeX{} \cite{knuth84}, a portable technical
typesetting language.
Authors may submit papers to the IUCr in a variety of electronic formats, some
more suitable than others for automated translation to SGML. A particularly
suitable format is already widespread in many scientific disciplines, namely
a structured dialect of \TeX{} known as \LaTeX{} \cite{lamport86}.
The IUCr has produced a macro package (\emph{iucr}) that may be used by
authors familiar with \LaTeX{} version 2$\varepsilon$ to create articles
that can easily be translated to SGML. This document describes how to use
the package. It has been prepared using the package itself, and refers to some
of its own contents to illustrate relevant points.
Full details of how to obtain the IUCr \LaTeX{} macro package are given in
Appendix~A.
\section{Structure of the paper}
The following skeleton outline indicates the structure of a typical paper in
\LaTeX{} format; portions in parentheses are optional. A file
\textbf{template.ltx} is available by ftp from the IUCr, and includes this
structure with some additional material that is described below. Frequent
reference will be made to this file (it will usually just be called `the
template'). Authors should acquire a copy of the template as the basis of
their journal submission; it is possible, however, to construct a
satisfactory paper from scratch by following the instructions in
this document.
A copy of the template is included as Appendix~D.
\begin{verbatim}
% ------ The front matter (heading section) ---
\documentclass{iucr}
\begin{document}
\title{...}
(\shorttitle{...})
(\author...)
\cauthor...
\aff...
(\shortauthor{...})
(\vita{...})
\maketitle
\begin{synopsis}
...
\end{synopsis}
\begin{abstract}
...
\end{abstract}
% ------ The main body of the text ------------
\section{...}
Text text text ...
\subsection{...}
Text text text ...
\subsubsection{...}
Text text text ...
\section{...}
Text text text ...
% ------ The back matter ----------------------
(\appendix
\section{...}
Text text text ...
)
(\ack{...})
\begin{references}
\reference{...}
\end{references}
\end{document}
\end{verbatim}
\section{Style of the paper}
The same template is used for submitting papers of all types to all the IUCr
journals. Different printing styles are used for different types of papers
and across different journals, and the author should indicate the required
style for the finished paper.
The article \emph{must} begin with a line invoking the IUCr document class;
the minimum required is
%
\begin{verbatim}
\documentclass{iucr}
\end{verbatim}
%
to indicate that \LaTeX{} should load and implement the macros for IUCr journal
articles.
\textbf{The initial submission to a journal Coeditor should use the `preprint'
option} to produce a single-column double-spaced version suitable for examination
and annotation by referees. This may be achieved by modifying the first
statement in the file to
%
\begin{verbatim}
\documentclass[preprint]{iucr}
\end{verbatim}
\textbf{The final version of the paper should then be prepared in the appropriate
style}, and adjustments made to the layout of mathematical equations, tables,
figure widths \emph{etc.} to ensure that such components fit the journals'
multi-column layout.
\emph{Note, however, that the actual page layout of the journals is \textbf{not}
performed using \LaTeX{}; it is therefore not worth spending time trying to
fit the figures and tables into a proper balanced page layout. Except when
used in the preparation of camera-ready conference proceedings, the different
page styles are used \textbf{only} to allow authors to break equations and
establish suitable scaling factors for figures.}
If the paper is intended for publication in \emph{Acta Crystallographica
Section A} (\emph{Acta A}) or \emph{Journal of Applied Crystallography}
(\emph{JAC}), the \verb|\documentclass| statement \emph{may} include the
option \verb|a| (in square brackets). If the paper is a
\emph{Short Communication}, the additional option \verb|short| is
\emph{required}.
If the paper is intended for publication in \emph{Acta Crystallographica
Section B} or \emph{Acta Crystallographica Section D} (\emph{Acta B},
\emph{Acta D}), the \verb|\documentclass| statement \emph{must}
include the option \verb|d| (in square brackets). If the paper is a
short contribution, such as a \emph{Short Communication} or
\emph{Crystallization Paper}, the additional option \verb|short| is required.
If the paper is intended for publication in \emph{Journal of Synchrotron
Radiation} (\emph{JSR}), the \verb|\documentclass| statement \emph{must}
include the option \verb|s| (in square brackets). If the paper is a
\emph{Short Communication}, the additional option \verb|short| is required.
\medskip
\begin{small}
\begin{tabular}{@{\hskip-1em}l>{\footnotesize}l}%
\emph{Acta A, JAC} full article & \verb|\documentclass{iucr}| \\
\emph{Acta B, D} full article & \verb|\documentclass[d]{iucr}| \\
\emph{JSR} full article & \verb|\documentclass[s]{iucr}| \\
\emph{Acta A, JAC} short article & \verb|\documentclass[short]{iucr}| \\
\emph{Acta B, D} short article & \verb|\documentclass[d,short]{iucr}| \\
\emph{JSR} short article & \verb|\documentclass[s,short]{iucr}| \\
\end{tabular}
\end{small}
If a paper has been submitted as a camera-ready document for a conference
proceedings issue of the journal, the option \verb|conference| should
be supplied, \emph{e.g.}
\medskip
\begin{small}
\begin{tabular}{@{\hskip-1em}l>{\footnotesize}l}%
\emph{JAC} conference paper & \verb|\documentclass[conference]{iucr}| \\
\emph{JSR} conference paper & \verb|\documentclass[s,conference]{iucr}| \\
\end{tabular}
\end{small}
For such papers, the submission instructions might also request that
authors use the \verb|nohead| option to remove the running headlines
and footers (these will be added by the editorial office during the
subsequent preparation for printing).
A full list of available package options is supplied as Appendix~B.
\penalty-500
\section{The header of the paper}
Information about the paper's title, its authors and their affiliations,
and such descriptive portions of the paper as the \emph{Abstract},
\emph{Synopsis} (which appears as a brief description of the paper in the
Table of Contents of an issue) or \emph{keywords} is included in the
\emph{header} or \emph{front matter} of the paper.
\subsection{The document preamble}
The template contains identifiers that encode bibliographic and production
information about the document. The author may not know all the details
that are required, but should fill in any information that is known, and
leave the remaining default values for IUCr editorial staff to update.
The template includes a complete list of allowed article type codes.
\begin{verbatim}
\paperprodcode{a000000} % Production code
\paperref{xx9999} % Editorial reference
\papertype{FA} % Type of article
% FA - Full article
% SC - Short Comm.
\paperlang{english} % Language
\journalcode{A} % Which journal?
% A - Acta Cryst. A
% B - Acta Cryst. B
% C - Acta Cryst. C
% D - Acta Cryst. D
% D - Acta Cryst. E
% J - J. Appl. Cryst.
% S - J. Synchr. Rad.
\journalyr{2000}
\journaliss{1}
\journalvol{56}
\journalfirstpage{000}
\journallastpage{000}
\journalreceived{0 XXXXXXX 0000}
\journalaccepted{0 XXXXXXX 0000}
\journalonline{0 XXXXXXX 0000}
\end{verbatim}
The printout of the article's dates of receipt and acceptance and its
online publication date can be suppressed by supplying the argument
\verb|\relax| to the last three commands.
\subsection{The document proper}
The body of the document is introduced with the line
%
\begin{verbatim}
\begin{document}
\end{verbatim}
This must appear \emph{after} the preamble, and \emph{before}
the title or any other content.
\subsection{Title}
Give the title of the paper as an argument to the macro \verb|\title|. The
title will usually be incorporated in a footer to the pages of the
journal. Often the full title is too long to fit within the footer.
If it is necessary to indicate a shorter form of the title for use
in the footer, use the macro \verb|\shorttitle|
%
\begin{verbatim}
\title{Sample Paper Using the IUCr \LaTeX{}
Macro Package}
\shorttitle{IUCr \LaTeX{} sample}
\end{verbatim}
If a title footnote is required, the \verb|\footnote| macro should be
invoked \emph{inside} the argument to the \verb|\title| macro, \emph{e.g.}
%
\begin{verbatim}
\title{Sample Paper Using the IUCr \LaTeX{}
Macro Package\footnote{Version 2}}
\end{verbatim}
\subsection{Author group}
The list of the authors' names and addresses forms the \emph{author group}
of the paper. The macros \verb|\cauthor|, \verb|\author| (for names of
correspondence and other authors respectively) and \verb|\aff| (for
\emph{affiliations}) should be used. If the paper has a single author, the
form of the entry will look like this:
%
\begin{verbatim}
\cauthor{J.}{Soape}{[email protected]}{}
\aff{Baskerville Lodge, \city{Dartmoor}, Devon,
\country{England}}
\end{verbatim}
%
The author's given name(s) or initial(s) appear within the first set
of curly braces, the surname (\emph{i.e.} family name) in the second set.
The third braces give the author's e-mail address, and the fourth the
correspondence address (where this differs from the affiliation printed in
the paper). \textbf{The third and fourth sets of braces must be present,
even if they are empty.}
The associated address is given as the argument to the \verb|\aff| macro.
The country should be indicated by the \verb|\country| macro; the
city of residence \emph{may} (but need not) be indicated by the \verb|\city|
macro. These are both included within the outer set of braces that delimit
the argument of the \verb|\aff| macro.
If there are multiple authors, the simpler \verb|\author| macro is used
for all but the correspondence author. A paper may have only \emph{one}
correspondence author. For example,
%
\begin{verbatim}
\author{J.}{Soape}
\author{A. N.}{Author}
\cauthor{John}{Doe}{[email protected]}{}
\aff{Baskerville Lodge, \city{Dartmoor}, Devon,
\country{England}}
\end{verbatim}
%
Where there are multiple addresses, each author should be linked to a
corresponding address by a small letter enclosed in square brackets
immediately following the name of the relevant macro,
%
\begin{verbatim}
\author[a,b]{J.}{Soape}
\author[b]{A. N.}{Author}
\cauthor[a]{John}{Doe}{[email protected]}{}
\aff[a]{Baskerville Lodge, \city{Dartmoor},
Devon, \country{England}}
\aff[b]{3 Watery Way, \city{Full Fathom} 5,
\country{Atlantis}}
\end{verbatim}
Two other macros exist to modify an author's name; these should both appear
\emph{inside} the braces delimiting the surname. They are \verb|\nee| to
describe a married woman's original surname (\emph{e.g.}
\verb|\author{J.}{Jackson \nee{Jones}}|, producing the text `J. Jackson
\nee{Jones}'), and \verb|\jr| to indicate a dynastic relationship.
The macro \verb|\jr| by itself produces the text `Jr'; with an argument
\emph{in square brackets} it produces the text provided, \emph{e.g.}
\verb|\author{H. H.}{Hackenbusch\jr[III]}| produces the
text `H. H. Hackenbusch\jr[III]'.
Footnotes associated with the authors' names \emph{must} use the
\verb|\aufn| macro, which must follow the last mandatory argument of
each occurrence of the
\verb|\author| or \verb|\cauthor| macros:
%
\begin{verbatim}
\cauthor[a]{John}{Doe}{[email protected]}{}\aufn{On
leave from Institute of Advanced Research,
Albany, Ruritania.}
\end{verbatim}
\subsection{Author biography}
Occasionally a biographical note for an author or authors is required
(usually for Lead Articles, Topical Reviews, or other invited contributions).
The \verb|\vita| macro is used to supply the required information;
if there is more than one author, a line containing \verb|\\| should
separate the individual entries:
%
\begin{verbatim}
\vita{Joe Soape is an archetypal generic
author, whose association with the
much-travelled Kilroy has extended
over many years. He travels to work
each day on a Clapham omnibus.
\\
John Doe is also a generic individual with
extensive experience of legal and
forensic matters.}
\end{verbatim}
\subsection{Other information}
Some journals require other ancillary information to be conveyed in the article
header. These may be supplied at this point in the document.
\emph{Journal of Synchrotron Radiation} requires one or more key words or
phrases for indexing purposes. These may be supplied with the macro
\verb|\keyword|, \emph{e.g.}
%
\begin{verbatim}
\keyword{X-ray diffraction}
\keyword{muscle}
\end{verbatim}
On rare occasions (especially for conference proceedings) an editor may
request that keywords be printed in other journals. In such a case the
document class line should be changed to include the \verb|keywords| option,
\emph{e.g.}
%
\begin{verbatim}
\documentclass[a,keywords]{iucr}
\end{verbatim}
Conversely, the \verb|nokeywords| option may be used to suppress the output
of the keywords terms in styles where they are printed by default.
\emph{Acta Crystallographica Section D} requires reference codes for structures
deposited in the Protein Data Bank. Use the macros \verb|\PDBref| and
\verb|\NDBref|, \emph{e.g.}
%
\begin{verbatim}
\PDBref[dethiobiotin synthetase]{1byi}
\NDBref[d(G$_4$CGC$_4$)]{ad0002}
\end{verbatim}
\subsection{maketitle}
The command \verb|\maketitle| should be included before the synopsis (or, if
no synopsis is present, before the abstract). This command instructs
\LaTeX{} to output the authors and affiliations in the correct style. If it
is not present, the information will in many cases nevertheless be output
correctly; but several error messages may be generated by \LaTeX{}.
\subsection{Synopsis}
All IUCr journals require the author to provide a brief synopsis of the
paper, a couple of sentences in length, which is printed on the journal
contents pages. There is a \emph{synopsis} environment which should be used
for this purpose:
\begin{verbatim}
\begin{synopsis}
Documentation of the IUCr \LaTeX{} macro
package and a demonstration of its
use in constructing a paper for an
IUCr journal.
\end{synopsis}
\end{verbatim}
By default, the synopsis is printed only for the \verb|preprint| option.
If it is necessary for some reason to display the synopsis within other
styles, the option \verb|synopsis| may be added, \emph{e.g.}
\begin{verbatim}
\documentclass[d,conference,synopsis,nohead]{iucr}
\end{verbatim}
%
will print the synopsis at the end of an unornamented conference-style paper
for \emph{Acta Crystallographica Section D}. When printed, the
synopsis appears on the \LaTeX{} printout within parallel horizontal
rules at the end of the document.
\subsection{Abstract}
The abstract of the paper should be given in the \emph{abstract}
environment,
%
\begin{verbatim}
\begin{abstract}
This document describes how to obtain and use
the \emph{iucr} \LaTeX{} macro package for
submitting articles in \LaTeX{}2$\varepsilon$
format to IUCr journals (\emph{Acta
Crystallographica, Journal of Applied
Crystallography, Journal of
Synchrotron Radiation}).
\end{abstract}
\end{verbatim}
The abstract must always be a single paragraph. It may \emph{not} contain
footnotes.
\section{The main body of the paper}
The main body of the paper has a relatively simple structure; it consists of
a sequence of sections, which may contain subsections or subsubsections. It
may also include appendices (introduced by the \verb|\appendix| command)
which themselves contain sections or sub- and subsubsections. (Details of
how to mark up appendices are included as Appendix~C.)
The sectional elements of the paper contain the text, broken into paragraphs
that are separated in the \LaTeX{} source by blank lines. The text may
include mathematics (discussed in a separate section below), figures and
tables.
\subsection{A note on single- and double-column formats}
The current template uses the \emph{multicol} package to permit
double-column typesetting in the style of the IUCr journals. The main
purpose of this is to ensure that the author knows where long mathematical
formulae should be broken in order to fit into the journal column widths.
It may occasionally be necessary to switch off double-column setting (or to
restrict it to certain portions of an article that relies heavily on long
mathematical formulae or wide tables that cannot conveniently be fitted into
a single column of the journal).
Within the body of the paper, double-column setting is switched off
by the statement
%
\begin{verbatim}
\onecolumn
\end{verbatim}
%
and may be re-invoked by the declaration
%
\begin{verbatim}
\twocolumn
\end{verbatim}
In short contributions to some sections of \emph{Acta Crystallographica}
three-column setting is used. The macro \verb|\threecolumn| is also
available for switching explicitly to such a mode.
The present version of the \emph{multicol} package does not
permit figures, tables or other `floats' within the multi-column portion of
the article; this is partly the reason why figures and tables should be
inserted at the end of the article (see later).
\subsection{Sectioning}
The text may contain sections nested to a depth of 3, \emph{i.e.} sections,
subsections and subsubsections, introduced respectively by the macros
\verb|\section|, \verb|\subsection| and \verb|\subsubsection|. The title of
the section should follow as an argument to the sectioning command.
\textbf{N.B. Please leave a blank line above and below these commands in the
source file.}
%
\begin{verbatim}
\subsection{Sectioning}
The text may contain sections nested to a depth
of 3, \emph{i.e.} sections, subsections
\end{verbatim}
Please employ the usual \LaTeX{} convention of leaving one or more blank
lines to indicate paragraph breaks. However, displayed equations and
embedded figures should \emph{not} be placed in separate paragraphs. If it is
desired to include some visual white space in the \LaTeX{} source file (and
it can certainly be helpful to lay out complex mathematics neatly and
clearly to permit later editing), lines containing only a \% symbol (the
\LaTeX{} comment code) may be used for visual punctuation, \emph{e.g.}
%
\begin{verbatim}
as seen in the equation
%
\begin{equation}
x^n + y^n = z^n
\end{equation
%
and discussed elsewhere...
\end{verbatim}
\subsection{Changes of typeface}
Within the body of the text, portions of italic or bold-face type may be
indicated by the \textit{textit} and \textbf{textbf} macros. The material to
be typeset in a different face should be passed as the argument to these
macros, and \emph{not}, as is sometimes done, included within an open macro
declaration inside braces; \emph{i.e.} use
%
\begin{verbatim}
\textbf{bold-face type}
\end{verbatim}
%
and \textbf{not}
%
\begin{verbatim}
{\textbf bold-face type}
\end{verbatim}
However, in keeping with the spirit of \LaTeX{}, it is generally better
style to use the \verb|\emph| macro to highlight text that is to be
emphasised, rather than using specific font commands such as \verb|\textit|.
\subsection{Footnotes}
The use of footnotes in the main body of the paper is discouraged, but
where their use is unavoidable they may normally be handled with the standard
\LaTeX{} \verb|\footnote| macro. This will produce footnotes across the
full width of the page, with automatic numbering.
Exceptionally, however (specifically where camera-ready documents are to
be prepared strictly in the style of the journals), manual placement of
footnotes is possible\fnmark{}.
The macro \verb|\fnmark| is used to indicate the location in the text of
the current footnote marker. Footnotes are numbered in sequence through an
article. If it is necessary to over-ride the automatic number generation,
an optional argument (in square brackets) may be supplied. The
\verb|\fnmark| macro does not print a space after the footnote marker, so
when used in the body of a sentence will often be followed by an empty
pair of braces to ensure that a space is printed,
\begin{verbatim}
The use of a footnote marker\fname{} causes a
superscript numeral to be printed; the numbers
are auto-incremented. Very occasionally\fname[3],
a specific number needs to be given in square
brackets.
\end{verbatim}
The actual text of the footnotes is given as an argument to the
\verb|\fntext| macro. Although the footnote numbers are automatically
tracked by the \verb|\fnmark| macro, the number associated with
each footnote \emph{must} be given in square brackets as the first
argument to the \verb|\fntext| macro. If the number is omitted, the
footnote will be printed without a number.
The user must collect together footnotes handled in this way at the relevant
location in the text so that they will be
printed at the foot of the
first or second column, as required. The macro \verb|\footnotes|,
immediately preceding the first \verb|\fntext| macro of a group, will
print the separator rule (horizontal line).
It is the responsibility of the user to ensure that paragraphs that
need to be broken to allow placement of the footnotes are correctly
formatted. An example of how to do this with the \verb|\breakpar| and
\verb|\noindent| commands is shown in the example.
\footnotes
\fntext[2]{The default placement of footnotes across the full page width
is a shortcoming of the way in which floats are handled by the
\emph{multicol} package. Use of the macros described here allows manual
placement in either column.}
\noindent
\begin{verbatim}
... may be necessary to break a paragraph
\breakpar
\footnotes
\fntext[1]{Note the use of empty braces after a call
to the fnmark macro to ensure that a
space is printed.}
\fntext[3]{When the normal numbering is overridden
by the use of an optional argument to
fnmark, one must remember to change the
footnote text numbering accordingly.}
\noindent
to allow placement of the footnotes.
\end{verbatim}
\section{Mathematics}
The standard \LaTeX{} conventions for typesetting mathematics should be
employed. In-line equations are delimited by the \verb|\(| and \verb|\)|
constructs, so that an equation embedded within running text such as
\verb|\(x^n+y^n=z^n\)| would print as \(x^n+y^n=z^n\). Displayed equations
without numbering are obtained with the \verb|\[| and \verb|\]| constructs,
\emph{e.g.}
\begin{verbatim}
\[ x = -b \pm \frac{\sqrt{b^2-4ac}}{2a} \]
\end{verbatim}
%
displays as
%
\[
x = -b \pm \frac{\sqrt{b^2-4ac}}{2a}
\]
Numbered display equations are obtained with the \emph{equation}
environment,
%
\begin{verbatim}
\begin{equation}
x = -b \pm \frac{\sqrt{b^2-4ac}}{2a}
\end{equation}
\end{verbatim}
%
yielding
%
\begin{equation}
x = -b \pm \frac{\sqrt{b^2-4ac}}{2a}
\end{equation}
\section{Acknowledgements and references}
\subsection{Acknowledgements}
The acknowledgements should appear in a single paragraph as argument to the
\verb|\ack| macro:
%
\begin{verbatim}
\ack{The assistance and knowledge of \TeX{},
\LaTeX{} and SGML of many members of the
IUCr editorial staff are acknowledged.}
\end{verbatim}
\subsection{References}
Reference lists may be built up in two ways: manually, or with the
assistance of the Bib\TeX{} program and associated bibliographic database
files.
\subsubsection{Plain citations}
If bibliographic references are being handled manually, they should be cited
in the text using the Harvard system which employs the surname of the author
and year of publication. Parenthetic allusions (Parth\'e \& Gelato, 1984)
may be made by including the authors' names and the date of publication
within parentheses; direct textual references normally have the date in
parentheses, as in this reference to the work of \citeasnoun{rauch76}.
The reference list is then built up by establishing a \emph{references}
environment, and placing each cited work within a \verb|\reference| entry:
%
\begin{verbatim}
\begin{references}
\reference{Parth\'e, E. \& Gelato, L. (1984).
\emph{Acta Cryst.} A\textbf{40}, 169--183.}
\reference{Rauch, H. \& Petrascheck, D. (1976).
\emph{Grundlagen f\"ur ein
Laue-Neutroneninterferometer Teil 1:
Dynamische Beugung.} Report AIAU 74405b.
Atominstitut der \"Osterreichischen
Universit\"aten, Austria.}
\end{references}
\end{verbatim}
\subsubsection{Using Bib\TeX{}}
The Bib\TeX{} program package may be used to handle citations and reference
lists, such as to the seminal work of \citeasnoun{pauling89}
and other multi-author articles \cite{pargel84}. The IUCr bibliography
style file \textbf{iucr.bst} should be obtained and loaded in a public
directory to obtain correctly-formatted reference lists and citations.
In this case the in-text citation is handled by the normal Bib\TeX{}
conventions. Note in the following listing the use of the commands
\verb|\citeasnoun| and \verb|\cite| to obtain citations that occur as
part of the running text or as parenthetic insertions respectively.
%
\begin{verbatim}
The Bib\TeX{} program package may be used to
handle citations and reference lists, such
as to the seminal work of \citeasnoun{pauling89}
and other multi-author articles \cite{pargel84}.
\end{verbatim}
The references section is invoked by placing the declaration
%
\begin{verbatim}
\referencelist[foo,bar]
\end{verbatim}
%
just before the \verb|\end{document}| statement. The \verb|\referencelist|
command takes a list of names of bibliographic databases as its argument in
square brackets (in this example, the references would be found in either of
the files \textbf{foo.bib} or \textbf{bar.bib} in the author's filesystem).
\textbf{Any such bibliographic database files must accompany the submission.}
If the \verb|\referencelist| command is given without any argument, the
bibliographic information is expected to be in a file called
\textbf{iucr.bib}. Generation and formatting of the reference list itself
is handled by Bib\TeX{}.
See Lamport \citeyear{lamport86} for further information about Bib\TeX{}. An
example of a sequence of \LaTeX{}/Bib\TeX{} runs necessary to generate the
final version of this document is given in Appendix~A.
\goodbreak
\section{Floating objects (tables and figures)}
As mentioned previously, floats such as tables and figures are not handled
properly within the double-column environment provided by the
\emph{multicol} package; they are also not yet automatically handled by the
page make-up software in use at the Editorial offices. Therefore, tables
and figures are best placed \emph{after} the rest of the document.
An exception is made for papers solicited as camera-ready conference
proceedings. In these cases, the author should manually place tables and
figures within the text at the top or bottom of columns where possible; or
between paragraphs if unavoidable.
\subsection{Tables}
Several \LaTeX{} styles exist for tables (because they are complicated
objects that exist in a variety of styles). It is likely that the table
translator will pose the greatest number of problems. Currently we recommend
authors to use the \emph{tabular} style for simple tables. Other table
packages, such as \emph{supertabular} or \emph{longtable} may be used for
complex tables at the author's discretion.
Authors should, however, be aware that it might be counterproductive for
them to expend too much effort in producing \LaTeX{} tables that are visually
attractive, since at a detailed level they may conflict with the layout
requirements of the SGML version of the tables that will ultimately be produced.
\subsubsection{Simple tables using the \emph{tabular} style}
Table 1 shows a simple table set using the following code:
%
\begin{verbatim}
\begin{table}
\caption{Example table}
\begin{tabular}{llccrc}
& Triplets & & & +ve quartets
& \\
$E_3$& no. & \% & $E_4$ & no. & \% \\
\hline
6.0 & 21 & 100 & 6.0 & 185 & 100 \\
4.0 & 143 & 100 & 4.0 & 1213 & 100 \\
3.0 & 353 & 100 & 3.0 & 3295 & 100 \\
2.5 & 583 & 99.8 & 2.5 & 5813 & 99.8 \\
2.0 & 980 & 99.7 & 2.0 & 10,006 & 99.5 \\
1.5 & 1823 & 99.2 & 1.5 & 13,114 & 98.8 \\
1.0 & 3395 & 96.9 & & & \\
\end{tabular}
\end{table}
\end{verbatim}
%
In this example, the \verb|{llccrc}| argument instructs the \verb|tabular|
environment to align material within the six tables of the columns against
the left margin (\verb|l|), centred (\verb|c|), or aginst the right margin
(\verb|r|) of each table cell.
\medskip
\begin{table}
\caption{Example table}
\begin{tabular}{llccrc}
& Triplets
& & & +ve quartets
& \\
$E_3$& no. & \% & $E_4$ & no. & \% \\
\hline
6.0 & 21 & 100 & 6.0 & 185 & 100 \\
4.0 & 143 & 100 & 4.0 & 1213 & 100 \\
3.0 & 353 & 100 & 3.0 & 3295 & 100 \\
2.5 & 583 & 99.8 & 2.5 & 5813 & 99.8 \\
2.0 & 980 & 99.7 & 2.0 & 10,006 & 99.5 \\