summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.tex
blob: e03551bdb29bc5a55b88f6f6ebd6ca7b3175919a (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
\documentclass{rapport3}
\usepackage{url}
\usepackage{supertabular}
\usepackage{fontspec}
\usepackage{calc}
\usepackage{pifont}
\usepackage{bbding}
\usepackage[colorlinks=true,linkcolor=mybrown,urlcolor=mygreen]{hyperref}
\usepackage{bidicode}
\usepackage{bidi}
\newfontfamily\ParsiFont[Script=Arabic]{XB Roya}
\def\Pcs#1{\nxPLcs{#1}}
\def\nxPLcs#1{\RLE{\texttt{\symbol{92}\ParsiFont#1}}}
\def\Lenv#1{\texttt{#1}}
\def\Penv#1{\RLE{\ParsiFont#1}}
\let\parsitext\Penv
\def\xepersianversion{v1.0.8}
\def\xepersiancommit{commit 22}
\def\xepersiandate{2010/07/25}
\def\XeTeX{Xe\TeX}
\def\XeLaTeX{Xe\LaTeX}
\def\XePersian{XePersian}
\newcounter{local}
\renewcommand\theenumi{\protect\setcounter{local}%
  {201+\the\value{enumi}}\protect\ding{\value{local}}}
\renewcommand\labelenumi{\theenumi}
\renewcommand\labelitemi{\HandRight}
\renewcommand\labelitemii{\HandRightUp}
\renewcommand\labelitemiii{\HandCuffRight}
\renewcommand\labelitemiv{\HandPencilLeft}
\definecolor{mybrown}{rgb}{.6,0,0}
\definecolor{mygreen}{rgb}{0,.43,0}
\definecolor{Orange}{rgb}{1,.4,.2}
\title{The \textsf{\XePersian} Package\\ \href{http://bitbucket.org/vafa/xepersian}{\texttt{http://bitbucket.org/vafa/xepersian}}}
\author{Vafa Khalighi\\ \href{mailto:vafakh84@gmail.com}{\texttt{vafakh84@gmail.com}}}
\date{Version 1.0.8}
\begin{document}
\maketitle
\tableofcontents
\chapter{Introduction}
\XePersian\ is a package for typesetting Persian/English documents with \XeLaTeX. The package includes adaptations for use with many other commonly-used packages.
\section{Important Notes}
\begin{itemize}
\item The \textsf{\XePersian} package  only works with \XeTeX\ engine.
\item Before reading this documentation, you should have read the documentation of the version 1.1.0 of \textsf{bidi} package. The \textsf{\XePersian} package automatically loads \textsf{bidi} package with \texttt{RTLdocument} option enabled and hence any commands that \textsf{bidi} package offers, is also available in \textsf{\XePersian} package. Here, in this documentation, we will not repeat any of \textsf{bidi} package's commands.
\item In previous versions (\(\leq1.0.3\)) of \XePersian, a thesis class provided for typesetting thesis. As of version 1.0.4, I no longer provide this class because I am not familiar with specification of a thesis in Iran and even if I was, the specifications are different from University to University. \XePersian\ is a general package like \LaTeX\ and should not provide any class for typesetting thesis. So if you really want to have a class file for typesetting thesis, then you should ask your University/department to write one for you. 
\item To get help, please explore \url{http://forum.parsilatex.com} and ask your question there.

\end{itemize}
\section{\textsf{\XePersian} Info On The Terminal and In The Log File}
If you use \textsf{\XePersian} package to write any input \TeX\ document, and then run \texttt{xelatex} on your document, in addition to what \textsf{bidi} package writes  to the terminal and to the log file, the \XePersian\ package also writes some information about itself  to the terminal and to the log file, too. The information is something like:
\begin{lstlisting}[numbers=none,backgroundcolor=\color{skugga}]
xepersian package (Persian for LaTeX over XeTeX)
Description: The package supports Persian
typesetting, using fonts provided in the distribution.
Copyright © 2008-2010 Vafa Khalighi
v1.0.8, <commit 22>, 2010/07/25
License: LaTeX Project Public License, version 1.3c or higher (your choice)
Home: http://bitbucket.org/vafa/xepersian
Location on CTAN: /macros/xetex/latex/xepersian
\end{lstlisting}
\chapter{Basics\label{basics}}
\section{Loading The Package}
You can load the package in the ordinary way;
\begin{BDef}
\Lcs{usepackage}\OptArgs\Largb{xepersian}
\end{BDef}
Where \texttt{options} of the package are explained later in \autoref{options}.

When loading the package, it is important to know that:
\begin{enumerate}
\item \textsf{xepersian} should be the last package that you load, because otherwise you are certainly going to overwrite \textsf{bidi} and \textsf{\XePersian} package's definitions and consequently, you will not get the expected output.
\item In fact, in addition to \textsf{bidi}, \textsf{\XePersian} also makes sure that some specific packages are loaded before \textsf{bidi} and \textsf{\XePersian}; these are those packages that \textsf{bidi} and \textsf{\XePersian} modifies them for bidirectional and Persian/English typesetting. 

If you load \textsf{\XePersian} before any of these packages, then you will get an error saying that you should load \textsf{\XePersian} or \textsf{bidi} as your last package. When it says that you should load \textsf{bidi} package as your last package, it really means that you should load \textsf{\XePersian} as your last package  as \textsf{bidi} package is loaded automatically by \textsf{\XePersian} package.

For instance, consider the following minimal example:
\begin{lstlisting}[morekeywords={settextfont}]
\documentclass{minimal}
\usepackage{xepersian}
\usepackage{enumerate}
\settextfont{XB Niloofar}
\begin{document}
?\parsitext{این فقط یک آزمایش است}?
\end{document}
\end{lstlisting}
Where \textsf{enumerate} is loaded after \textsf{\XePersian}. If you run \texttt{xelatex} on this document, you will get an error which looks like this:
\begin{lstlisting}[numbers=none,backgroundcolor=\color{skugga}]
! Package xepersian Error: Oops! you have loaded package enumerate after xepers
ian package. Please load package enumerate before xepersian package, and then t
ry to run xelatex on your document again.

See the xepersian package documentation for explanation.
Type  H <return>  for immediate help.
 ...                                              
                                                  
l.5 \begin{document}
                    
? 

\end{lstlisting}
\end{enumerate}
\section{Commands for Version number, Mercurial commit number and Date of The Package}
\begin{BDef}
\Lcs{xepersianversion}\quad\Lcs{xepersiancommit}\quad\Lcs{xepersiandate}
\end{BDef}
\begin{itemize}
\item \Lcs{xepersianversion} gives the current version of the package.
\item \Lcs{xepersiancommit} gives the current Mercurial commit number of the package.
\item \Lcs{xepersiandate} gives the current date of the package.
\end{itemize}
\begin{lstlisting}[morekeywords={settextfont,XePersian,xepersianversion,xepersiancommit,xepersiandate}]
\documentclass{article}
\usepackage{xepersian}
\settextfont{XB Niloofar}
\begin{document}
\begin{latin}
This is typeset by \textsf{\XePersian} package,
 \xepersianversion, \xepersiancommit, \xepersiandate.
\end{latin}
\end{document}
\end{lstlisting}
\section{{Options of The Package\label{options}}}
There are two options:
\subsection{\texttt{Kashida} Option}
If you pass \texttt{Kashida} option to the package, you will use Kashida for stretching words for better output quality and getting rid of underfull or overfull \Lcs{hbox} messages.
\marginpar{This is the font issue not \XePersian's bug}Please note that X series fonts of IRMUG (Iranian Mac Users Group) have absolutely super poor quality and if you use any of these fonts with \texttt{Kashida} option enabled, the result on the PDF viewed on the monitor is the ugliest of any kind, however the print may look fine. Hence if you are going to enable \texttt{Kashida} option , then you are advised to use either ``Adobe Arabic'' or ``Scheherazade'' fonts.

Note that you can not use \texttt{Kashida} option when you are using Nastaliq-like font (well, you still can use \texttt{Kashida} option when you use any Nastaliq-like font, but I can not guarantee high quality output!).

\subsection{\texttt{localise} Option}
If you enable \texttt{localise} option, then you can use most frequently-used \LaTeX\ commands and environments in Persian, almost like what \TeX-e-Parsi offers. This is still work in progress and we wish to add lots more Persian equivalents of \LaTeX\ and \TeX\ commands and environments. The Persian equivalents of \LaTeX\ and \TeX\ commands are shown in \autoref{pcmd} and Persian equivalents of \LaTeX\  environments are shown in \autoref{penv}.

Please note that the Persian equivalents of \LaTeX\ and \TeX\ commands and environments are only available after loading \textsf{xepersian} package with \texttt{localise} option enabled. This means that even if you enable \texttt{localise} option, you still have to write all commands or environments that come before \Lcs{usepackage}\OptArg{localise}\Largb{xepersian}, in its original form, i.e. \Lcs{documentclass}.

When you enable the \texttt{localise} option, not only you can use Persian equivalents of \LaTeX\ and \TeX\ commands and environments, but still original \LaTeX\ and \TeX\ commands and environments work too.

The \TeX\ and \LaTeX\ commands and environments and their Persian equivalents listed in \autoref{pcmd} and \autoref{penv} is not the whole story; If any command and environment in \autoref{pcmd} and \autoref{penv} have a starred version, their starred version also work. For example in \autoref{pcmd}, the Persian equivalent of \Lcs{chapter}  is \Pcs{فصل}. I know that \Lcs{chapter} has a starred version, so this means \Pcs{فصل*} is also the Persian equivalent of \Lcs{chapter*}. Is that clear?

\bigskip
\begin{center}
\tablecaption{The Equivalent \LaTeX\ and \TeX\ Commands\label{pcmd}}
\tablehead
   {\bfseries Command in \TeX\ or \LaTeX\ &\bfseries  Equivalent Persian Command\\ \hline}
\tabletail
   {\hline \multicolumn{2}{r}{\emph{Continued on next page}}\\}
\tablelasttail{\hline}
\begin{supertabular}{lr}
\Lcs{abovedisplayshortskip}&\Pcs{پرش‌کوتاه‌بالای‌نمایش}\\
\Lcs{abovedisplayskip}&\Pcs{پرش‌بالای‌نمایش}\\
\Lcs{abstractname}&\Pcs{نام‌چکیده}\\
\Lcs{addcontentsline}&\Pcs{بیفزاخط‌فهرست}\\
\Lcs{address}&\Pcs{آدرس}\\
\Lcs{addtocontents}&\Pcs{بیفزابرفهرست}\\
\Lcs{addtocounter}&\Pcs{بیفزابرشمارنده}\\
\Lcs{addtolength}&\Pcs{بیفزابرطول}\\
\Lcs{addvspace}&\Pcs{بیفزافاصله‌ع}\\
\Lcs{aleph}&\Pcs{الف}\\
\Lcs{allowdisplaybreaks}&\Pcs{شکست‌نمایش‌مجاز}\\
\Lcs{Alph}&\Pcs{حروف‌ب}\\
\Lcs{alph}&\Pcs{حروف‌ک}\\
\Lcs{alsoname}&\Pcs{نام‌همچنین}\\
\Lcs{and}&\Pcs{و}\\
\Lcs{angle}&\Pcs{زاویه}\\
\Lcs{appendixname}&\Pcs{نام‌پیوست}\\
\Lcs{approx}&\Pcs{تقریب}\\
\Lcs{arabic}&\Pcs{عربی}\\
\Lcs{arg}&\Pcs{آرگ}\\
\Lcs{arraycolsep}&\Pcs{جداگرستون‌آرایه}\\
\Lcs{arrayrulewidth}&\Pcs{عرض‌نوارآرایه}\\
\Lcs{arraystretch}&\Pcs{کشیدگی‌آرایه}\\
\Lcs{AtBeginDocument}&\Pcs{درشروع‌نوشتار}\\
\Lcs{AtEndDocument}&\Pcs{درپایان‌نوشتار}\\
\Lcs{AtEndOfClass}&\Pcs{درپایان‌کلاس}\\
\Lcs{AtEndOfPackage}&\Pcs{درپایان‌بسته}\\
\Lcs{author}&\Pcs{نویسنده}\\
\Lcs{backmatter}&\Pcs{مطلب‌پشت}\\
\Lcs{backslash}&\Pcs{شکاف‌پشت}\\
\Lcs{bar}&\Pcs{میله}\\
\Lcs{baselineskip}&\Pcs{پرش‌خط‌کرسی}\\
\Lcs{baselinestretch}&\Pcs{کشیدگی‌خط‌کرسی}\\
\Lcs{begin}&\Pcs{شروع}\\
\Lcs{belowdisplayshortskip}&\Pcs{پرش‌کوتاه‌زیرنمایش}\\
\Lcs{belowdisplayskip}&\Pcs{پرش‌زیرنمایش}\\
\Lcs{bfdefault}&\Pcs{پیش‌فرض‌سیاه}\\
\Lcs{bfseries}&\Pcs{سری‌سیاه}\\
\Lcs{bibitem}&\Pcs{بندکتاب‌نامه}\\
\Lcs{bibliography}&\Pcs{کتاب‌نامه}\\
\Lcs{bibliographystyle}&\Pcs{سبک‌کتاب‌نامه}\\
\Lcs{bibname}&\Pcs{نام‌کتاب‌نامه}\\
\Lcs{bigskip}&\Pcs{پرش‌بزرگ}\\
\Lcs{bigskipamount}&\Pcs{مقدارپرش‌بزرگ}\\
\Lcs{botfigrule}&\Pcs{نوارپای‌عکس}\\
\Lcs{bottomfraction}&\Pcs{کسرپایین}\\
\Lcs{bullet}&\Pcs{گلوله}\\
\Lcs{caption}&\Pcs{شرح}\\
\Lcs{cc}&\Pcs{رونوشت}\\
\Lcs{ccname}&\Pcs{نام‌رونوشت}\\
\Lcs{cdot}&\Pcs{نقطه‌وسط}\\
\Lcs{cdots}&\Pcs{نقاط‌وسط}\\
\Lcs{centering}&\Pcs{وسط‌چین}\\
\Lcs{centerline}&\Pcs{خط‌وسط}\\
\Lcs{chapter}&\Pcs{فصل}\\
\Lcs{chaptername}&\Pcs{نام‌فصل}\\
\Lcs{cite}&\Pcs{سند}\\
\Lcs{ClassError}&\Pcs{خطای‌کلاس}\\
\Lcs{ClassInfo}&\Pcs{اطلاعات‌کلاس}\\
\Lcs{ClassWarning}&\Pcs{هشدارکلاس}\\
\Lcs{ClassWarningNoLine}&\Pcs{هشدارکلاس‌بدون‌خط}\\
\Lcs{cleardoublepage}&\Pcs{دوصفحه‌پاک}\\
\Lcs{clearpage}&\Pcs{صفحه‌پاک}\\
\Lcs{cline}&\Pcs{خط‌س}\\
\Lcs{closing}&\Pcs{بستن}\\
\Lcs{clubsuit}&\Pcs{خاج}\\
\Lcs{color}&\Pcs{رنگ}\\
\Lcs{colorbox}&\Pcs{کادررنگی}\\
\Lcs{columnsep}&\Pcs{جداگرستون}\\
\Lcs{columnseprule}&\Pcs{نوارجداگرستون}\\
\Lcs{contentsline}&\Pcs{خط‌فهرست}\\
\Lcs{contentsname}&\Pcs{نام‌فهرست}\\
\Lcs{copyright}&\Pcs{حق‌تالیف}\\
\Lcs{CurrentOption}&\Pcs{گزینه‌جاری}\\
\Lcs{dashbox}&\Pcs{کادربینابین}\\
\Lcs{dashv}&\Pcs{بینابین‌ع}\\
\Lcs{date}&\Pcs{تاریخ}\\
\Lcs{dblfigrule}&\Pcs{نوارشکل‌دولا}\\
\Lcs{dblfloatpagefraction}&\Pcs{کسرصفحه‌شناوردولا}\\
\Lcs{dblfloatsep}&\Pcs{جداگرشناوردولا}\\
\Lcs{dbltextfloatsep}&\Pcs{جداگرشناورمتن‌دولا}\\
\Lcs{dbltopfraction}&\Pcs{کسربالادولا}\\
\Lcs{DeclareGraphicsExtensions}&\Pcs{اعلام‌پسوندگرافیک}\\
\Lcs{DeclareGraphicsRule}&\Pcs{اعلام‌دستورگرافیک}\\
\Lcs{DeclareOption}&\Pcs{اعلام‌گزینه}\\
\Lcs{DeclareRobustCommand}&\Pcs{اعلام‌فرمان‌قوی}\\
\Lcs{definecolor}&\Pcs{معرفی‌رنگ}\\
\Lcs{deg}&\Pcs{درجه}\\
\Lcs{depth}&\Pcs{عمق}\\
\Lcs{diamondsuit}&\Pcs{خشت}\\
\Lcs{dim}&\Pcs{بعد}\\
\Lcs{discretionary}&\Pcs{احتیاطی}\\
\Lcs{displaybreak}&\Pcs{شکست‌نمایش}\\
\Lcs{displaystyle}&\Pcs{سبک‌نمایش}\\
\Lcs{documentclass}&\Pcs{کلاس‌نوشتار}\\
\Lcs{dot}&\Pcs{نقطه}\\
\Lcs{doteq}&\Pcs{نقطه‌مساوی}\\
\Lcs{dotfill}&\Pcs{پرنقطه}\\
\Lcs{dots}&\Pcs{نقاط}\\
\Lcs{doublebox}&\Pcs{کادردولا}\\
\Lcs{doublerulesep}&\Pcs{جداگرنواردولا}\\
\Lcs{downarrow}&\Pcs{فلش‌پایین}\\
\Lcs{em}&\Pcs{تا}\\
\Lcs{emph}&\Pcs{تاکید}\\
\Lcs{emptyset}&\Pcs{مجموعه‌تهی}\\
\Lcs{end}&\Pcs{پایان}\\
\Lcs{endfirsthead}&\Pcs{پایان‌اولین‌سر}\\
\Lcs{endfoot}&\Pcs{پایان‌پا}\\
\Lcs{endhead}&\Pcs{پایان‌سر}\\
\Lcs{endlastfoot}&\Pcs{پایان‌آخرین‌پا}\\
\Lcs{enlargethispage}&\Pcs{گسترش‌این‌صفحه}\\
\Lcs{eqref}&\Pcs{ارجاع‌فر}\\
\Lcs{euro}&\Pcs{یورو}\\
\Lcs{evensidemargin}&\Pcs{حاشیه‌طرف‌راست}\\
\Lcs{ExecuteOptions}&\Pcs{اجرای‌گزینه‌ها}\\
\Lcs{extracolsep}&\Pcs{جداگرستون‌اضافی}\\
\Lcs{fancypage}&\Pcs{صفحه‌تجملی}\\
\Lcs{fbox}&\Pcs{کادرف}\\
\Lcs{fboxrule}&\Pcs{نوارکادرف}\\
\Lcs{fboxsep}&\Pcs{جداگرکادرف}\\
\Lcs{fcolorbox}&\Pcs{کادرف‌رنگی}\\
\Lcs{figurename}&\Pcs{نام‌شکل}\\
\Lcs{fill}&\Pcs{پرر}\\
\Lcs{flat}&\Pcs{پهن}\\
\Lcs{floatpagefraction}&\Pcs{کسرصفحه‌شناور}\\
\Lcs{floatsep}&\Pcs{جداگرشناور}\\
\Lcs{flushbottom}&\Pcs{تنظیم‌پایین}\\
\Lcs{fnsymbol}&\Pcs{نمادپن}\\
\Lcs{fontfamily}&\Pcs{خانواده‌قلم}\\
\Lcs{fontseries}&\Pcs{سری‌قلم}\\
\Lcs{fontshape}&\Pcs{شکل‌قلم}\\
\Lcs{fontsize}&\Pcs{اندازه‌قلم}\\
\Lcs{LTRfootnote}&\Pcs{پانوشت‌چبر}\\
\Lcs{footnote}&\Pcs{پانوشت}\\
\Lcs{footnotemark}&\Pcs{نشان‌پانوشت}\\
\Lcs{footnoterule}&\Pcs{نوار‌پانوشت}\\
\Lcs{footnotesep}&\Pcs{جداگرپانوشت}\\
\Lcs{footnotesize}&\Pcs{اندازه‌پانوشت}\\
\Lcs{footnotetext}&\Pcs{متن‌پانوشت}\\
\Lcs{footskip}&\Pcs{پرش‌پا}\\
\Lcs{frame}&\Pcs{فریم}\\
\Lcs{framebox}&\Pcs{کادرفریم}\\
\Lcs{frenchspacing}&\Pcs{فاصله‌گذاری‌فرانسوی}\\
\Lcs{frontmatter}&\Pcs{مطلب‌پیش}\\
\Lcs{glossary}&\Pcs{فرهنگ}\\
\Lcs{glossaryentry}&\Pcs{فقره‌فرهنگ}\\
\Lcs{graphpaper}&\Pcs{کاغذگراف}\\
\Lcs{guillemotleft}&\Pcs{گیومه‌چپ}\\
\Lcs{guillemotright}&\Pcs{گیومه‌راست}\\
\Lcs{guilsinglleft}&\Pcs{گیومه‌تکی‌چپ}\\
\Lcs{guilsinglright}&\Pcs{گیومه‌تکی‌راست}\\
\Lcs{headheight}&\Pcs{ارتفاع‌سر}\\
\Lcs{headsep}&\Pcs{جداگرسر}\\
\Lcs{headtoname}&\Pcs{سربه‌نام}\\
\Lcs{heartsuit}&\Pcs{دل}\\
\Lcs{height}&\Pcs{ارتفاع}\\
\Lcs{hfill}&\Pcs{پرا}\\
\Lcs{hline}&\Pcs{خط‌ا}\\
\Lcs{hoffset}&\Pcs{مبداا}\\
\Lcs{hrulefill}&\Pcs{نواراپرر}\\
\Lcs{hspace}&\Pcs{فضاا}\\
\Lcs{huge}&\Pcs{بزرگ}\\
\Lcs{Huge}&\Pcs{بزرگ‌تر}\\
\Lcs{hyperlink}&\Pcs{ابرپیوند}\\
\Lcs{hypersetup}&\Pcs{بارگذاری‌ابر}\\
\Lcs{hypertarget}&\Pcs{هدف‌ابر}\\
\Lcs{hyphenation}&\Pcs{خط‌پیوند}\\
\Lcs{iff}&\Pcs{گرر}\\
\Lcs{IfFileExists}&\Pcs{گرپرونده‌موجود}\\
\Lcs{ifthenelse}&\Pcs{گرآنگاه‌دیگر}\\
\Lcs{include}&\Pcs{شامل}\\
\Lcs{includegraphics}&\Pcs{شامل‌گرافیک}\\
\Lcs{includeonly}&\Pcs{تنها‌شامل}\\
\Lcs{indent}&\Pcs{تورفته}\\
\Lcs{index}&\Pcs{نمایه}\\
\Lcs{indexentry}&\Pcs{فقره‌نمایه}\\
\Lcs{indexname}&\Pcs{نام‌نمایه}\\
\Lcs{indexspace}&\Pcs{فضای‌نمایه}\\
\Lcs{input}&\Pcs{ورود}\\
\Lcs{InputIfFileExists}&\Pcs{ورودگرپرونده‌موجود}\\
\Lcs{intertext}&\Pcs{بین‌متن}\\
\Lcs{intertextsep}&\Pcs{جداگربین‌متن}\\
\Lcs{invisible}&\Pcs{مخفی}\\
\Lcs{itdefault}&\Pcs{پیش‌فرض‌ای}\\
\Lcs{item}&\Pcs{بند}\\
\Lcs{itemindent}&\Pcs{تورفتگی‌بند}\\
\Lcs{itemsep}&\Pcs{جداگربند}\\
\Lcs{itshape}&\Pcs{شکل‌ای}\\
\Lcs{kill}&\Pcs{کشتن}\\
\Lcs{label}&\Pcs{برچسب}\\
\Lcs{labelenumi}&\Pcs{برچسب‌شمارش‌ی}\\
\Lcs{labelenumii}&\Pcs{برچسب‌شمارش‌د}\\
\Lcs{labelenumiii}&\Pcs{برچسب‌شمارش‌س}\\
\Lcs{labelenumiv}&\Pcs{برچسب‌شمارش‌چ}\\
\Lcs{labelitemi}&\Pcs{برچسب‌بندی}\\
\Lcs{labelitemii}&\Pcs{برچسب‌بندد}\\
\Lcs{labelitemiii}&\Pcs{برچسب‌بندس}\\
\Lcs{labelitemiv}&\Pcs{برچسب‌بندچ}\\
\Lcs{labelsep}&\Pcs{جداگربرچسب}\\
\Lcs{labelwidth}&\Pcs{عرض‌برچسب}\\
\Lcs{language}&\Pcs{زبان}\\
\Lcs{large}&\Pcs{درشت}\\
\Lcs{Large}&\Pcs{درشت‌تر}\\
\Lcs{LARGE}&\Pcs{درشت‌درشت}\\
\Lcs{LaTeX}&\Pcs{لاتک}\\
\Lcs{LaTeXe}&\Pcs{لاتک‌ای}\\
\Lcs{ldots}&\Pcs{نقاط‌خ}\\
\Lcs{left}&\Pcs{چپ}\\
\Lcs{leftmargin}&\Pcs{حاشیه‌چپ}\\
\Lcs{line}&\Pcs{خط}\\
\Lcs{linebreak}&\Pcs{شکست‌خط}\\
\Lcs{linethickness}&\Pcs{ضخامت‌خط}\\
\Lcs{linewidth}&\Pcs{عرض‌خط}\\
\Lcs{listfigurename}&\Pcs{نام‌لیست‌شکل}\\
\Lcs{listfiles}&\Pcs{لیست‌پرونده‌ها}\\
\Lcs{listoffigures}&\Pcs{لیست‌شکل‌ها}\\
\Lcs{listoftables}&\Pcs{لیست‌لوح‌ها}\\
\Lcs{listparindent}&\Pcs{تورفتگی‌پارلیست}\\
\Lcs{listtablename}&\Pcs{نام‌لیست‌جدول}\\
\Lcs{LoadClass}&\Pcs{بارگذاری‌کلاس}\\
\Lcs{LoadClassWithOptions}&\Pcs{بارگذاری‌کلاس‌باگزینه‌ها}\\
\Lcs{location}&\Pcs{مکان}\\
\Lcs{mainmatter}&\Pcs{مطلب‌اصلی}\\
\Lcs{makebox}&\Pcs{ساخت‌کادر}\\
\Lcs{makeglossary}&\Pcs{ساخت‌فرهنگ}\\
\Lcs{makeindex}&\Pcs{ساخت‌نمایه}\\
\Lcs{makelabel}&\Pcs{ساخت‌برچسب}\\
\Lcs{makelabels}&\Pcs{ساخت‌برچسب‌ها}\\
\Lcs{MakeLowercase}&\Pcs{ساخت‌حروف‌کوچک}\\
\Lcs{maketitle}&\Pcs{ساخت‌عنوان}\\
\Lcs{MakeUppercase}&\Pcs{ساخت‌حروف‌بزرگ}\\
\Lcs{marginpar}&\Pcs{حاشیه‌پار}\\
\Lcs{marginparsep}&\Pcs{جداگرحاشیه‌پار}\\
\Lcs{marginparwidth}&\Pcs{عرض‌جداگرپار}\\
\Lcs{markboth}&\Pcs{نشان‌هردو}\\
\Lcs{markright}&\Pcs{نشان‌راست}\\
\Lcs{mbox}&\Pcs{س‌کادر}\\
\Lcs{medskip}&\Pcs{پرش‌متوسط}\\
\Lcs{medskipamount}&\Pcs{مقدارپرش‌متوسط}\\
\Lcs{medspace}&\Pcs{فضای‌متوسط}\\
\Lcs{MessageBreak}&\Pcs{شکست‌پیام}\\
\Lcs{multicolumn}&\Pcs{چندستونی}\\
\Lcs{name}&\Pcs{نام}\\
\Lcs{natural}&\Pcs{طبیعی}\\
\Lcs{nearrow}&\Pcs{باریک}\\
\Lcs{NeedsTeXFormat}&\Pcs{نیازبه‌فرم‌تک}\\
\Lcs{neg}&\Pcs{منفی}\\
\Lcs{negmedspace}&\Pcs{فضای‌متوسط‌منفی}\\
\Lcs{negthickspace}&\Pcs{فضای‌ضخیم‌منفی}\\
\Lcs{negthinspace}&\Pcs{فضای‌نازک‌منفی}\\
\Lcs{newboolean}&\Pcs{بولی‌نو}\\
\Lcs{newcommand}&\Pcs{فرمان‌نو}\\
\Lcs{newcounter}&\Pcs{شمارنده‌نو}\\
\Lcs{newenvironment}&\Pcs{محیط‌نو}\\
\Lcs{newfont}&\Pcs{قلم‌نو}\\
\Lcs{newlength}&\Pcs{طول‌نو}\\
\Lcs{newline}&\Pcs{خط‌نو}\\
\Lcs{newpage}&\Pcs{صفحه‌نو}\\
\Lcs{newsavebox}&\Pcs{کادرذخیره‌نو}\\
\Lcs{newtheorem}&\Pcs{قضیه‌نو}\\
\Lcs{nocite}&\Pcs{بدون‌سند}\\
\Lcs{nofiles}&\Pcs{بدون‌پرونده}\\
\Lcs{noindent}&\Pcs{بدون‌تورفتگی}\\
\Lcs{nolimits}&\Pcs{بدون‌حد}\\
\Lcs{nolinebreak}&\Pcs{بدون‌شکست‌خط}\\
\Lcs{nonfrenchspacing}&\Pcs{فاصله‌گذاری‌غیرفرانسوی}\\
\Lcs{nonumber}&\Pcs{بدون‌شماره}\\
\Lcs{nopagebreak}&\Pcs{بدون‌شکست‌صفحه}\\
\Lcs{normalcolor}&\Pcs{رنگ‌نرمال}\\
\Lcs{normalfont}&\Pcs{قلم‌نرمال}\\
\Lcs{normalmarginpar}&\Pcs{حاشیه‌پارنرمال}\\
\Lcs{normalsize}&\Pcs{اندازه‌نرمال}\\
\Lcs{notag}&\Pcs{بدون‌اتیکت}\\
\Lcs{numberwithin}&\Pcs{شماره‌مطابق}\\
\Lcs{oddsidemargin}&\Pcs{حاشیه‌سمت‌چپ}\\
\Lcs{onecolumn}&\Pcs{یک‌ستون}\\
\Lcs{onlynotes}&\Pcs{تنها‌یادداشت‌ها}\\
\Lcs{onlyslides}&\Pcs{تنهااسلایدها}\\
\Lcs{OptionNotUsed}&\Pcs{گزینه‌استفاده‌نشد}\\
\Lcs{PackageError}&\Pcs{خطای‌بسته}\\
\Lcs{PackageInfo}&\Pcs{اطلاعات‌بسته}\\
\Lcs{PackageWarning}&\Pcs{هشداربسته}\\
\Lcs{PackageWarningNoLine}&\Pcs{هشداربسته‌بدون‌خط}\\
\Lcs{pagebreak}&\Pcs{شکست‌صفحه}\\
\Lcs{pagecolor}&\Pcs{رنگ‌صفحه}\\
\Lcs{pagename}&\Pcs{نام‌صفحه}\\
\Lcs{pagenumbering}&\Pcs{شماره‌گذاری‌صفحه}\\
\Lcs{pageref}&\Pcs{ارجاع‌صفحه}\\
\Lcs{pagestyle}&\Pcs{سبک‌صفحه}\\
\Lcs{paperheight}&\Pcs{ارتفاع‌برگ}\\
\Lcs{paperwidth}&\Pcs{عرض‌برگ}\\
\Lcs{par}&\Pcs{پار}\\
\Lcs{paragraph}&\Pcs{پاراگراف}\\
\Lcs{parallel}&\Pcs{موازی}\\
\Lcs{parbox}&\Pcs{کادرپار}\\
\Lcs{parindent}&\Pcs{تورفتگی‌پار}\\
\Lcs{parsep}&\Pcs{جداگرپار}\\
\Lcs{parskip}&\Pcs{پرش‌پار}\\
\Lcs{part}&\Pcs{قسمت}\\
\Lcs{partname}&\Pcs{نام‌قسمت}\\
\Lcs{partopsep}&\Pcs{جداگربالای‌پار}\\
\Lcs{PassOptionToClass}&\Pcs{پاس‌گزینه‌به‌کلاس}\\
\Lcs{PassOptionToPackage}&\Pcs{پاس‌گزینه‌به‌بسته}\\
\Lcs{path}&\Pcs{مسیر}\\
\Lcs{printindex}&\Pcs{چاپ‌نمایه}\\
\Lcs{ProcessOptions}&\Pcs{پردازش‌گزینه‌ها}\\
\Lcs{protect}&\Pcs{حمایت}\\
\Lcs{providecommand}&\Pcs{تهیه‌فرمان}\\
\Lcs{ProvidesClass}&\Pcs{تهیه‌کلاس}\\
\Lcs{ProvidesFile}&\Pcs{تهیه‌پرونده}\\
\Lcs{ProvidesPackage}&\Pcs{تهیه‌بسته}\\
\Lcs{raggedbottom}&\Pcs{تنظیم‌پایین}\\
\Lcs{raggedleft}&\Pcs{تنظیم‌چپ}\\
\Lcs{raggedright}&\Pcs{تنظیم‌راست}\\
\Lcs{raisebox}&\Pcs{ترفیع‌کادر}\\
\Lcs{raisetag}&\Pcs{ترفیع‌اتیکت}\\
\Lcs{rangle}&\Pcs{زاویه‌ر}\\
\Lcs{rceil}&\Pcs{سقف‌ر}\\
\Lcs{ref}&\Pcs{رجوع}\\
\Lcs{reflectbox}&\Pcs{انعکاس‌کادر}\\
\Lcs{refname}&\Pcs{نام‌رجوع}\\
\Lcs{refstepcounter}&\Pcs{گام‌رجوع‌شمارنده}\\
\Lcs{renewcommand}&\Pcs{فرمان‌ازنو}\\
\Lcs{renewenvironment}&\Pcs{محیط‌ازنو}\\
\Lcs{RequirePackage}&\Pcs{نیازبه‌بسته}\\
\Lcs{RequirePackageWithOptions}&\Pcs{نیازبه‌بسته‌باگزینه}\\
\Lcs{resizebox}&\Pcs{اندازه‌ازنوکادر}\\
\Lcs{reversemarginpar}&\Pcs{حاشیه‌پارمعکوس}\\
\Lcs{rfloor}&\Pcs{کف‌ر}\\
\Lcs{right}&\Pcs{راست}\\
\Lcs{rmdefault}&\Pcs{پیش‌فرض‌رم}\\
\Lcs{rmfamily}&\Pcs{خانواده‌رم}\\
\Lcs{Roman}&\Pcs{رومن‌بزرگ}\\
\Lcs{roman}&\Pcs{رومن}\\
\Lcs{rotatebox}&\Pcs{چرخاندن‌کادر}\\
\Lcs{rule}&\Pcs{نوار}\\
\Lcs{savebox}&\Pcs{ذخیره‌کادر}\\
\Lcs{sbox}&\Pcs{کادرذ}\\
\Lcs{scalebox}&\Pcs{کادرمقیاس}\\
\Lcs{scdefault}&\Pcs{پیش‌فرض‌تمام‌بزرگ}\\
\Lcs{scriptscriptstyle}&\Pcs{سبک‌ته‌نوشت‌ته‌نوشت}\\
\Lcs{scriptsize}&\Pcs{اندازه‌ته‌نوشت}\\
\Lcs{scripstyle}&\Pcs{سبک‌ته‌نوشت}\\
\Lcs{section}&\Pcs{بخش}\\
\Lcs{see}&\Pcs{ببینید}\\
\Lcs{seealso}&\Pcs{نیزببینید}\\
\Lcs{seename}&\Pcs{نام‌ببینید}\\
\Lcs{selectfont}&\Pcs{انتخاب‌قلم}\\
\Lcs{setboolean}&\Pcs{تنظیم‌بولی}\\
\Lcs{setcounter}&\Pcs{تنظیم‌شمارنده}\\
\Lcs{setlength}&\Pcs{تنظیم‌طول}\\
\Lcs{setminus}&\Pcs{تنظیم‌منها}\\
\Lcs{settodepth}&\Pcs{تنظیم‌به‌عمق}\\
\Lcs{settoheight}&\Pcs{تنظیم‌به‌ارتفاع}\\
\Lcs{settowidth}&\Pcs{تنظیم‌به‌عرض}\\
\Lcs{sfdefault}&\Pcs{پیش‌فرض‌س‌ف}\\
\Lcs{sffamily}&\Pcs{خانواده‌س‌ف}\\
\Lcs{shadowbox}&\Pcs{کادرسایه‌دار}\\
\Lcs{sharp}&\Pcs{تیز}\\
\Lcs{shortstack}&\Pcs{پشته‌کوتاه}\\
\Lcs{sldefault}&\Pcs{پیش‌فرض‌خو}\\
\Lcs{sloppy}&\Pcs{نامرتب}\\
\Lcs{slshape}&\Pcs{شمایل‌خو}\\
\Lcs{small}&\Pcs{کوچک}\\
\Lcs{smallskip}&\Pcs{پرش‌کوچک}\\
\Lcs{smallskipamount}&\Pcs{مقدار‌پرش‌کوچک}\\
\Lcs{smash}&\Pcs{کوب}\\
\Lcs{smile}&\Pcs{لبخند}\\
\Lcs{spadesuit}&\Pcs{پیک}\\
\Lcs{star}&\Pcs{ستاره}\\
\Lcs{stepcounter}&\Pcs{گام‌شمارنده}\\
\Lcs{stretch}&\Pcs{کشی}\\
\Lcs{subitem}&\Pcs{زیربند}\\
\Lcs{subparagraph}&\Pcs{زیرپاراگراف}\\
\Lcs{subsection}&\Pcs{زیربخش}\\
\Lcs{substack}&\Pcs{زیرپشته}\\
\Lcs{subsubitem}&\Pcs{زیرزیربند}\\
\Lcs{subsubsection}&\Pcs{زیرزیربخش}\\
\Lcs{subset}&\Pcs{زیرمجموعه}\\
\Lcs{subseteq}&\Pcs{زیرمجموعه‌مس}\\
\Lcs{tabbingsep}&\Pcs{جداگرجدول‌بندی}\\
\Lcs{tabcolsep}&\Pcs{جداگرستون‌جدول}\\
\Lcs{tableofcontents}&\Pcs{فهرست‌مطالب}\\
\Lcs{tablename}&\Pcs{نام‌لوح}\\
\Lcs{tabularnewline}&\Pcs{خط‌نوجدول}\\
\Lcs{tag}&\Pcs{اتیکت}\\
\Lcs{telephone}&\Pcs{تلفن}\\
\Lcs{TeX}&\Pcs{تک}\\
\Lcs{text}&\Pcs{متنی}\\
\Lcs{textbullet}&\Pcs{گلوله‌متنی}\\
\Lcs{textemdash}&\Pcs{ام‌دش‌متنی}\\
\Lcs{textendash}&\Pcs{ان‌دش‌متنی}\\
\Lcs{textexclamdown}&\Pcs{تعجب‌وارونه‌متنی}\\
\Lcs{textperiodcentered}&\Pcs{نقطه‌وسط‌متنی}\\
\Lcs{textquestiondown}&\Pcs{سوال‌وارونه‌متنی}\\
\Lcs{textquotedblleft}&\Pcs{نقل‌چپ‌متنی‌دولا}\\
\Lcs{textquotedblright}&\Pcs{نقل‌راست‌متنی‌دولا}\\
\Lcs{textquoteleft}&\Pcs{نقل‌متنی‌چپ}\\
\Lcs{textquoteright}&\Pcs{نقل‌متنی‌راست}\\
\Lcs{textvisiblespace}&\Pcs{فضای‌نمایان‌متنی}\\
\Lcs{textbackslash}&\Pcs{شکافت‌پشت‌متنی}\\
\Lcs{textbar}&\Pcs{میله‌متنی}\\
\Lcs{textgreater}&\Pcs{بزرگ‌تر‌متنی}\\
\Lcs{textless}&\Pcs{کمتر‌متنی}\\
\Lcs{textbf}&\Pcs{متن‌سیاه}\\
\Lcs{textcircled}&\Pcs{مدور‌متنی}\\
\Lcs{textcolor}&\Pcs{رنگ‌متن}\\
\Lcs{textcompwordmark}&\Pcs{نشان‌کلمه‌مرکب‌متن}\\
\Lcs{textfloatsep}&\Pcs{جداگرشناورمتن}\\
\Lcs{textfraction}&\Pcs{کسرمتن}\\
\Lcs{textheight}&\Pcs{ارتفاع‌متن}\\
\Lcs{textit}&\Pcs{متن‌ایتالیک}\\
\Lcs{textmd}&\Pcs{متن‌نازک}\\
\Lcs{textnormal}&\Pcs{متن‌نرمال}\\
\Lcs{textregistered}&\Pcs{ثبتی‌متنی}\\
\Lcs{textrm}&\Pcs{متن‌رومن}\\
\Lcs{textsc}&\Pcs{متن‌تمام‌بزرگ}\\
\Lcs{textsf}&\Pcs{متن‌سانزسریف}\\
\Lcs{textsl}&\Pcs{متن‌خوابیده}\\
\Lcs{textstyle}&\Pcs{سبک‌متنی}\\
\Lcs{textsuperscript}&\Pcs{بالانویس‌متنی}\\
\Lcs{texttrademark}&\Pcs{علامت‌تجاری‌متنی}\\
\Lcs{texttt}&\Pcs{متن‌تایپ}\\
\Lcs{textup}&\Pcs{متن‌بالا}\\
\Lcs{textwidth}&\Pcs{عرض‌متن}\\
\Lcs{thanks}&\Pcs{تشکر}\\
\Lcs{thicklines}&\Pcs{خط‌هاضخیم}\\
\Lcs{thickspace}&\Pcs{فضاضخیم}\\
\Lcs{thinlines}&\Pcs{خط‌هانازک}\\
\Lcs{thinspace}&\Pcs{فضانازک}\\
\Lcs{thisfancypage}&\Pcs{این‌صفحه‌تجملی}\\
\Lcs{thispagestyle}&\Pcs{سبک‌این‌صفحه}\\
\Lcs{tilde}&\Pcs{مد}\\
\Lcs{tiny}&\Pcs{ریز}\\
\Lcs{times}&\Pcs{ضرب}\\
\Lcs{title}&\Pcs{عنوان}\\
\Lcs{to}&\Pcs{به}\\
\Lcs{today}&\Pcs{امروز}\\
\Lcs{top}&\Pcs{بالا}\\
\Lcs{topfigrule}&\Pcs{نواربالای‌شکل}\\
\Lcs{topfraction}&\Pcs{کسر‌بالا}\\
\Lcs{topmargin}&\Pcs{حاشیه‌بالا}\\
\Lcs{topsep}&\Pcs{جداگربالا}\\
\Lcs{topskip}&\Pcs{پرش‌بالا}\\
\Lcs{totalheight}&\Pcs{ارتفاع‌کلی}\\
\Lcs{triangle}&\Pcs{مثلث}\\
\Lcs{ttdefault}&\Pcs{پیش‌فرض‌تایپ}\\
\Lcs{ttfamily}&\Pcs{خانواده‌تایپ}\\
\Lcs{twocolumn}&\Pcs{دوستون}\\
\Lcs{underline}&\Pcs{زیرخط}\\
\Lcs{updefault}&\Pcs{پیش‌فرض‌ایستاده}\\
\Lcs{usebox}&\Pcs{استفاده‌کادر}\\
\Lcs{usecounter}&\Pcs{استفاده‌شمارنده}\\
\Lcs{usefont}&\Pcs{استفاده‌فونت}\\
\Lcs{usepackage}&\Pcs{استفاده‌بسته}\\
\Lcs{value}&\Pcs{ارزش}\\
\Lcs{verb}&\Pcs{کبک}\\
\Lcs{vfill}&\Pcs{پررع}\\
\Lcs{visible}&\Pcs{نمایان}\\
\Lcs{vline}&\Pcs{خط‌ع}\\
\Lcs{voffset}&\Pcs{مبداع}\\
\Lcs{vpageref}&\Pcs{ارجاع‌صفحه‌ع}\\
\Lcs{vref}&\Pcs{ارجاع‌ع}\\
\Lcs{vspace}&\Pcs{فضای‌ع}\\
\Lcs{whiledo}&\Pcs{مادام‌بکن}\\
\Lcs{widehat}&\Pcs{کلاه‌پهن}\\
\Lcs{widetilde}&\Pcs{مدپهن}\\
\Lcs{width}&\Pcs{عرض}\\
\end{supertabular}
\end{center}

\bigskip
\begin{center}
\tablecaption{The Equivalent \LaTeX\ Environments\label{penv}}
\tablehead
   {\bfseries Environment in  \LaTeX\ &\bfseries  Equivalent Persian Environment\\ \hline}
\tabletail
   {\hline \multicolumn{2}{r}{\emph{Continued on next page}}\\}
\tablelasttail{\hline}
\begin{supertabular}{lr}
\Lenv{abstract}&\Penv{چکیده}\\
\Lenv{appendix}&\Penv{پیوست}\\
\Lenv{array}&\Penv{آرایه}\\
\Lenv{center}&\Penv{وسط}\\
\Lenv{description}&\Penv{توضیح}\\
\Lenv{document}&\Penv{نوشتار}\\
\Lenv{enumerate}&\Penv{شماره‌بندی}\\
\Lenv{figure}&\Penv{شکل}\\
\Lenv{filecontents}&\Penv{محتویات‌پرونده}\\
\Lenv{flushleft}&\Penv{چپ‌چین}\\
\Lenv{flushright}&\Penv{راست‌چین}\\
\Lenv{itemize}&\Penv{بنددار}\\
\Lenv{letter}&\Penv{نامه}\\
\Lenv{list}&\Penv{لیست}\\
\Lenv{longtable}&\Penv{جدول‌دراز}\\
\Lenv{lrbox}&\Penv{کادررچ}\\
\Lenv{math}&\Penv{ریاضی}\\
\Lenv{matrix}&\Penv{ماتریس}\\
\Lenv{minipage}&\Penv{صفحه‌کوچک}\\
\Lenv{multicols}&\Penv{چندستونی‌ها}\\
\Lenv{multline}&\Penv{چندخطی}\\
\Lenv{note}&\Penv{یادداشت}\\
\Lenv{overlay}&\Penv{انباشتن}\\
\Lenv{picture}&\Penv{تصویر}\\
\Lenv{quotation}&\Penv{اقتباس}\\
\Lenv{quote}&\Penv{نقل}\\
\Lenv{slide}&\Penv{اسلاید}\\
\Lenv{sloppypar}&\Penv{پارنامرتب}\\
\Lenv{split}&\Penv{شکافتن}\\
\Lenv{subarray}&\Penv{زیرآرایه}\\
\Lenv{tabbing}&\Penv{جدول‌بندی}\\
\Lenv{table}&\Penv{لوح}\\
\Lenv{tabular}&\Penv{جدول}\\
\Lenv{thebibliography}&\Penv{محتوای‌کتاب‌نامه}\\
\Lenv{theindex}&\Penv{محتوای‌نمایه}\\
\Lenv{titlepage}&\Penv{صفحه‌عنوان}\\
\Lenv{verbatim}&\Penv{کلمه‌به‌کلمه}\\
\Lenv{verse}&\Penv{شعر}\\
\end{supertabular}
\end{center}

\section{A Sample Input \TeX\ File}
\begin{lstlisting}[morekeywords={settextfont,maketitle,tableofcontents,subsection,subsubsection,part}]
\documentclass{article}
\usepackage{xepersian}
\settextfont{XB Niloofar}
\title{?\parsitext{یک سند نمونه}?}
\author{?\parsitext{نام نویسنده}?}
\begin{document}
\maketitle
\tableofcontents
\part{?\parsitext{عنوان بخش}?}
...
\section{?\parsitext{عنوان قسمت}?}
...
\subsection{?\parsitext{عنوان زیرقسمت}?}
...
\subsubsection{?\parsitext{عنوان زیر زیرقسمت}?}
...
\end{document}
\end{lstlisting}
\section{Font Commands}
\subsection{Basic Font Commands}
\begin{BDef}
\Lcs{settextfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{setlatintextfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{setdigitfont}\OptArgs\Largb{\Larga{font name}}
\end{BDef}
\begin{itemize}
\item Options in any font command in this documentation are anything that \textsf{fontspec} package provides as the option of loading fonts, except \texttt{Script} and \texttt{Mapping}.
\item \Lcs{settextfont} will choose the default font for Persian texts of your document. This command is compulsory and if you do not use it at least once, you will get error saying that you should choose a Persian font by using this command.
\item \Lcs{setlatintextfont} will choose the font for Latin texts of your document. If you do not use this command at all, the default \TeX\ font (fonts used in this documentation) will be used for Latin texts of your document.
\item \Lcs{setdigitfont} will choose the Persian font for digits in math mode. By using this command, digits in math mode will appear in Persian form and if you do not use this command at all, you will get default \TeX\ font for digits in math mode and digits appear in their original form (Western).
\end{itemize}
\subsection{Defining Extra Persian and Latin Fonts}
\begin{BDef}
\Lcs{defpersianfont}\Lcs{CS}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{deflatinfont}\Lcs{CS}\OptArgs\Largb{\Larga{font name}}
\end{BDef}
\begin{itemize}
\item With \Lcs{defpersianfont}, you can define extra Persian fonts.
\begin{lstlisting}[numbers=none,morekeywords={defpersianfont,Nastaliq}]
\defpersianfont\Nastaliq[Scale=1]{IranNastaliq}
\end{lstlisting}
In this example, we define \Lcs{Nastaliq} to stand for Nastaliq font.
\item With \Lcs{deflatinfont}, you can define extra Latin fonts.
\begin{lstlisting}[numbers=none,morekeywords={deflatinfont,junicode}]
\deflatinfont\junicode[Scale=1]{Junicode}
\end{lstlisting}
In this example, we define \Lcs{Junicode} to stand for Junicode font.
\end{itemize}
\subsection{Choosing Persian Sans Font}
\begin{BDef}
\Lcs{setpersiansansfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{persiansffamily}\quad\Lcs{textpersiansf}\Largb{\Larga{text}}
\end{BDef}
\subsection{Choosing Persian Mono Font}
\begin{BDef}
\Lcs{setpersianmonofont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{persianttfamily}\quad\Lcs{textpersiantt}\Largb{\Larga{text}}
\end{BDef}
\subsection{Choosing Persian Iranic Font}
\begin{BDef}
\Lcs{setiranicfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{iranicfamily}\quad\Lcs{textiranic}\Largb{\Larga{text}}
\end{BDef}

\subsection{Choosing Persian Navar Font}
\begin{BDef}
\Lcs{setnavarfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{navarfamily}\quad\Lcs{textnavar}\Largb{\Larga{text}}
\end{BDef}

\subsection{Choosing Persian Pook Font}
\begin{BDef}
\Lcs{setpookfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{pookfamily}\quad\Lcs{textpook}\Largb{\Larga{text}}
\end{BDef}

\subsection{Choosing Persian Sayeh Font}
\begin{BDef}
\Lcs{setsayehfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{sayehfamily}\quad\Lcs{textsayeh}\Largb{\Larga{text}}
\end{BDef}

\subsection{Choosing Latin Sans Font}
\begin{BDef}
\Lcs{setlatinsansfont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{sffamily}\quad\Lcs{textsf}\Largb{\Larga{text}}
\end{BDef}
\subsection{Choosing Latin Mono Font}
\begin{BDef}
\Lcs{setlatinmonofont}\OptArgs\Largb{\Larga{font name}}\\
\Lcs{ttfamily}\quad\Lcs{texttt}\Largb{\Larga{text}}
\end{BDef}
\section{Latin and Persian Environment}
\begin{BDef}
\LBEG{latin}\quad\Larga{text}\quad\LEND{latin}\\
\LBEG{persian}\quad\Larga{text}\quad\LEND{persian}
\end{BDef}
\begin{itemize}
\item \texttt{latin} environment both changes direction of the paragraphs to LTR and font to Latin font.
\item \texttt{persian} environment both changes direction of the Paragraphs to RTL and font to Persian font.
\end{itemize}

\section{Latin and Persian Commands}
\begin{BDef}
\Lcs{Latin}\quad\Lcs{Persian}
\end{BDef}
\begin{itemize}
\item \Lcs{Latin} command both changes direction of the paragraphs to LTR and font to Latin font.
\item \Lcs{Persian} command both changes direction of the Paragraphs to RTL and font to Persian font.
\end{itemize}
\section{Short Latin and Persian Texts}
\begin{BDef}
\Lcs{lr}\Largb{\Larga{text}}\quad\Lcs{rl}\Largb{\Larga{text}}
\end{BDef}
\begin{itemize}
\item With \Lcs{lr} command, you can typeset short LTR texts.
\item With \Lcs{rl} command, you can typeset short RTL texts.
\end{itemize}
\section{Miscellaneous Commands}
\begin{BDef}
\Lcs{today}\quad\Lcs{latintoday}\quad\Lcs{twocolumnstableofcontents}\quad\Lcs{XePersian}\\
\Lcs{plq}\quad\Lcs{prq}
\end{BDef}
\begin{itemize}
\item \Lcs{today} typesets current Persian date and \Lcs{latintoday} typesets current Latin date.
\item \Lcs{twocolumnstableofcontents} typesets table of contents in two columns. This requires that you have loaded \textsf{multicol} package before \textsf{\XePersian} package, otherwise an error will be issued.
\item \Lcs{XePersian} typesets \XePersian's logo.
\item \Lcs{plq} and \Lcs{prq} typeset Persian left quote and Persian right quote respectively.
\end{itemize}

\section{Additional Counters}
\XePersian\ defines several additional counters to what already \LaTeX\ offers. These counters are \texttt{harfi}, \texttt{adadi}, and \texttt{tartibi}.

\section{Things To Know About \Lcs{setdigitfont}}
\begin{BDef}
\Lcs{DefaultMathsDigits}\quad\Lcs{PersianMathsDigits}\quad\Lcs{AutoMathsDigits}
\end{BDef}
\begin{itemize}
\item  As we discussed before, \Lcs{setdigitfont} will choose the Persian font for digits in math mode. By using this command, digits in math mode will appear in Persian form and if you do not use this command at all, you will get default \TeX\ font for digits in math mode and digits appear in their original form (Western).

If you use \Lcs{setdigitfont}, you should the know that:
\begin{itemize}
\item By default, \Lcs{AutoMathsDigits} is active, which means that in Persian mode, you get Persian digits in math mode and in Latin mode, you get \TeX's default font and digits in math mode.
\item If you use \Lcs{PersianMathsDigits} anywhere, you will overwrite  \XePersian's default behaviour and you will always get Persian digits in math mode.
\item If you use \Lcs{DefaultMathsDigits} anywhere, again you will overwrite \XePersian's default behaviour and you will always get \TeX's default font and digits in math mode.
\end{itemize}
\end{itemize}
\section{Bilingual Captions}
\XePersian\ sets caption bilingually. This means if you are in RTL mode, you get Persian caption and if you are in LTR mode, you get English caption.
\section{Support For Various Packages}
In addition to what \textsf{bidi} package supports, \XePersian\ also support a few packages. This support is more about language aspect rather than directionality. These packages are \textsf{algorithmic}, \textsf{algorithm},\textsf{enumerate}, and \textsf{backref} packages.

\subsection{Things You Should Know about Support For \textsf{enumerate} Package}
The \textsf{enumerate} package gives the enumerate environment an optional argument
which determines the style in which the counter is printed.

An occurrence of one of the tokens \texttt{A}, \texttt{a}, \texttt{I}, \texttt{i}, or \texttt{1} produces the value
of the counter printed with (respectively) \Lcs{Alph}, \Lcs{alph}, \Lcs{Roman}, \Lcs{roman} or
\Lcs{arabic}.

In addition with the extra support that \XePersian\ provides, an occurrence of one of the tokens \Penv{ا}, \Penv{ی}, or \Penv{ت} produces the value of the counter printed with (respectively) \Lcs{harfi}, \Lcs{adadi}, or \Lcs{tartibi}.

These letters may be surrounded by any strings involving any other \TeX\
expressions, however the tokens \texttt{A}, \texttt{a}, \texttt{I}, \texttt{i},  \texttt{1}, \Penv{ا}, \Penv{ی}, \Penv{ت} must be inside a \Largb{} group if
they are not to be taken as special.

To see an Example, please look at \textsf{enumerate} package documentation.
\section{Index Generation}
For generating index, you are advised to use \textsf{xindy} program, any other program such as \textsf{makeindex} is not recommended.



\section{Converting Your Farsi\TeX\ Files To \XePersian\ or Unicode}
There is a python program written by Mostafa Vahedi that enables you to convert Farsi\TeX\ files to \XePersian\ or unicode. This program can be found in \textsf{doc} folder with the name \texttt{ftxe-0.11.py}. To convert your Farsi\TeX\ files to \XePersian, put \texttt{ftxe-0.11.py} in the same directory that your Farsi\TeX\ file is, and then open a terminal/command prompt and do the following:

\begin{BDef}\ttfamily
python ftxe-0.11.py file.ftx file.tex
\end{BDef}

This will convert your \texttt{file.ftx} (Farsi\TeX\ file) to \texttt{file.tex} (\XePersian\ file).

The general syntax syntax of using the python script is as follow:
\begin{BDef}\ttfamily
python ftxe-0.11.py [-r] [-s] [-x] [-u] input-filename1 input-filename2
\end{BDef}
Where
\begin{description}
\item[\texttt{-r}] (DEFAULT) recursively consider files included in the given files 
\item[\texttt{-s}] do not recursively consider files 
\item[\texttt{-x}] (DEFAULT) insert \XePersian\ related commands 
\item[\texttt{-u}] only convert to unicode (and not to \XePersian) 
\end{description}

Please note that the python script will not work with versions of python later than 2.6. So you are encouraged to use version 2.6 of python to benefit from this python script.

\chapter{Extra Packages And Classes}
\section{Magazine Typesetting}
\subsection{Introduction}
\textsf{xepersian-magazine} class allows you to create magazines, newspapers and any other types of papers. The output document has a front page and as many inner pages as desired. Articles appear one after another, telling the type, number of columns, heading, subheading, images, author and so forth. It is possible to change the aspect of (almost) everything therefore it is highly customisable. Commands to add different titles, headings and footers are also provided.
\subsection{Usage}
To create\footnote{For a sample file, please look at \texttt{magazine-sample.tex} in the \textsf{doc} folder} a magazine just load the class as usual\footnote{You also need to load \textsf{graphicx}, \textsf{xunicode} and \textsf{xepersian} packages respectively, after loading the document class and choose fonts for the main text, Latin text and digits in maths formulas. For more detail see  \autoref{basics} of the documentation.}, with
\begin{BDef}
\Lcs{documentclass}\OptArgs\Largb{xepersian-magazine}
\end{BDef}
at the beginning of your source file. The class options are  described in  \autoref{s-options}.

From this point it is possible to include packages and renew class commands described in  \autoref{s-custom}.
\subsection{Front Page}
As every magazine, \textsf{xepersian-magazine} has its own front page. It includes main headings, an index, the magazine logo and other useful information. This environment should be the first you use within \textsf{xepersian-magazine} class but it is not mandatory.

\begin{BDef}
\Lcs{firstimage}\quad\Lcs{firstarticle}
\end{BDef}
The first two commands you can use inside the \texttt{frontpage} environment are \Lcs{firstimage} and \Lcs{firstarticle} which include, respectively, the main image and the main heading in the front page. The first one takes two arguments \Larga{image} and \Larga{description}. Notice that second argument is optional and it declares the image caption; \Larga{image} defines the relative path to the image. In order to include the first piece of article use
\begin{BDef}
\Lcs{firstarticle}\Largb{\Larga{title}}\Largb{\Larga{opening}}\Largb{\Larga{time}}
\end{BDef}
first two arguments are mandatory and represent heading and the opening paragraph. Last argument is optional (you can leave it blank) and indicates the time when article happened.
\begin{BDef}
\Lcs{secondarticle}
\end{BDef}
The second piece of article is included using the command \Lcs{secondarticle} just as the first article. The main difference are that this second piece has two more arguments and it does not include an image.

\begin{BDef}
\Lcs{secondarticle}\Largb{\Larga{title}}\Largb{\Larga{subtitle}}\Largb{\Larga{opening}}\Largb{\Larga{pagesof}}\Largb{\Larga{time}}
\end{BDef}
The new arguments \Larga{subtitle} and \Larga{pagesof} define a subtitle and the name of the section for this piece of article.

\begin{BDef}
\Lcs{thirdarticle}
\end{BDef}
The third piece of article is the last one in the \textsf{xepersian-magazine} front page. It works like the \Lcs{secondarticle}.
\begin{BDef}
\Lcs{thirdarticle}\Largb{\Larga{title}}\Largb{\Larga{subtitle}}\Largb{\Larga{opening}}%
\Largb{\Larga{pagesof}}\Largb{\Larga{time}}
\end{BDef}
The arguments meaning is the same as \Lcs{secondarticle} command.

The front page includes three information blocks besides the news: \texttt{indexblock} which contains the index, \texttt{authorblock} which includes information about the author and a \texttt{weatherblock} containing a weather forecast. All these three environments are mostly a frame in the front page therefore they can be redefined to fit your personal wishes but I kept them to give an example and to respec the original \textsf{xepersian-magazine} format.

\begin{BDef}
\Lcs{indexitem}
\end{BDef}
The \texttt{indexblock} environment contains a manually editted index of \textsf{xepersian-magazine}. It takes one optional argument \Larga{title} and places a title over the index block. To add entries inside the index just type
\begin{BDef}
\Lcs{indexitem}\Largb{\Larga{title}}\Largb{\Larga{reference}}
\end{BDef}
inside the environment. The \Larga{title} is the index entry text and the \Larga{reference} points to a article inside \textsf{xepersian-magazine}. It will be more clear when you read  \autoref{sub-1}. In order to get a correct output, it is necessary to leave a blank line between index items.

The \texttt{authorblock} environment can include whatever you would like. I called it \texttt{authorblock} because I think it is nice to include some author reference in the front page: who you are, why are you doing this... This environment creates a frame box in the bottom right corner of the front page with your own logo at the top.

\begin{BDef}
\Lcs{weatheritem}
\end{BDef}
Finally, the  \texttt{weatherblock} lets you include a weather forecast. It takes one optional argument \Larga{title}                           that places a title over the weather block. It can
             fit up to three weather icons with maximum and minimum temperatures,
             description and name. To add each of the weather entries type the following

\begin{BDef}
\Lcs{weatheritem}\Largb{\Larga{image}}\Largb{\Larga{day-name}}\Largb{\Larga{max}}%
\Largb{\Larga{min}}\Largb{\Larga{short-des}}
\end{BDef}

The first argument includes the path to the weather icon (i.e. sunny or rainy), \Larga{day-name} like Monday, \Larga{max} and \Larga{min} are the highest and lowest day temperatures and \Larga{short-des} is a brief description of the weather condition: partly cloudy, sunny and windy \ldots
\subsection{Inside\label{sub-1}}
Once we have created the front page we should include all articles inside our magazine. \textsf{xepersian-magazine} arranges all articles one after each other, expanding headings all over the page and splitting the article text in the number of columns we wish. There are three different environments to define a piece of article: the \texttt{article} environment described in  \autoref{subsub-1}, the \texttt{editorial} environment \autoref{subsub-2} for opinion articles and the \texttt{shortarticle} environment explained in \autoref{subsub-3}.
\subsubsection{The article environment\label{subsub-1}}
The main environment to include a piece of article is called \texttt{article}. It takes four arguments that set up the headings and structure of the article.
\begin{BDef}
\LBEG{article}\Largb{\Larga{num-of-columns}}\Largb{\Larga{title}}\Largb{\Larga{subtitle}}%
\Largb{\Larga{pagesof}}\Largb{\Larga{label}}\\
\ldots\Larga{text}\ldots\\
\LEND{article}
\end{BDef}

The first argument \Larga{num-of-columns} sets the number of columns the article will be divided whereas \Larga{label}  is used when pointing an article from the index in the front page. The rest of the arguments are easy to understand.


Inside the \texttt{article} environment, besides the main text of the article, it is  possible to include additional information using several class commands.
\begin{BDef}
\Lcs{authorandplace}\quad\Lcs{timestamp}
\end{BDef}

The \Lcs{authorandplace}\Largb{\Larga{author}}\Largb{\Larga{place}} inserts the name of the editor and the place where the article happened in the way many magazines do. Another useful command is \Lcs{timestamp}\Largb{\Larga{time}} which includes the time and a separator just before the text. These two commands should be used before the text because they type the text as the same place they are executed.

\begin{BDef}
\Lcs{image}
\end{BDef}
To include images within the text of an article, \textsf{xepersian-magazine} provides an \Lcs{image} command. Since \textsf{multicol} package does not provide any float support for its \textsf{multicols} environment, I created a macro that includes an image only if that is possible, calculating if there is enough space for the image.It is not the best solution but it works quite well and I could not find a better one. To include an image use the command and its two arguments: the relative path to the image and a short description.
\begin{BDef}
\Lcs{image}\Largb{\Larga{image}}\Largb{\Larga{description}}
\end{BDef}

\begin{BDef}
\Lcs{columntitle}\quad\Lcs{expandedtitle}
\end{BDef}
Within the text of the article, it is possible to add column and expanded titles. The main difference between them is that the first one keeps inside the width of an article column whereas the second expands all over the width of the page, breaking all the columns. Their use is analogous, as follows

\begin{BDef}
\Lcs{columntitle}\Largb{\Larga{type}}\Largb{\Larga{text}}\\
\Lcs{expandedtitle}\Largb{\Larga{type}}\Largb{\Larga{text}}
\end{BDef}
These two commands use \textsf{fancybox} package features. That is why there are five different types of titles which correspond mainly with fancybox ones: \textsf{shadowbox},
\textsf{doublebox}, \textsf{ovalbox}, \textsf{Ovalbox} and \textsf{lines}.
\subsubsection{The editorial environment\label{subsub-2}}
In addition to the editorial article environment, one can use the editorial environment to create editorial or opinion texts. The main feature is that it transforms the style
of the heading. Although this environment accepts all the commands article takes, it does not make any sense to use the \Lcs{authorandplace} command within it since it includes an author argument. To create an editorial text use

\begin{BDef}
\LBEG{editorial}\Largb{\Larga{num-of-columns}}\Largb{\Larga{title}}\Largb{\Larga{author}}\Largb{\Larga{label}}\\
\ldots\Larga{text}\ldots\\
\LEND{editorial}
\end{BDef}

All arguments have the same meaning as article environment (see \autoref{subsub-1}).
\subsubsection{The shortarticle environment\label{subsub-3}}
The shortarticle environment creates a block of short article. Althought it has its own title and subtitle, each piece of article within it may have a title. To use it just
type:

\begin{BDef}
\LBEG{shortarticle}\Largb{\Larga{num-of-columns}}\Largb{\Larga{title}}\Largb{\Larga{subtitle}}\Largb{\Larga{label}}\\
\ldots\Larga{text}\ldots\\
\Lcs{shortarticleitem}\Largb{\Larga{title}}\Largb{\Larga{text}}\\
\ldots\\
\LEND{shortarticle}
\end{BDef}
You can also specify the number of columns of the block like editorial and article environments. To add a piece of article inside the shortarticle use the \Lcs{shortarticleitem}, indicating a title and the text of the issue.
\subsubsection{Commands between articles}
\begin{BDef}
\Lcs{articlesep}\quad\Lcs{newsection}
\end{BDef}

There are two commands you can use among the articles inside \textsf{xepersian-magazine}: \Lcs{articlesep}  and \Lcs{newsection}. The first one does not take any parameter and just draws a line between two articles. The second  changes the content of \Lcs{xepersian@section} to the new \Larga{section name}. From the point it is used, all articles which follow will be grouped within the new section.

\begin{BDef}
\Lcs{newsection}\Largb{\Larga{section name}}
\end{BDef}
\subsection{Customization\label{s-custom}}
\textsf{xepersian-magazine} includes many commands which can be used to customize its aspect, from the front page to the last page. I will list them grouped so it is easy to find
them. Treat them as standard \LaTeX\ commands, using \Lcs{renewcommand} to change
their behaviour.
\subsubsection{Front Page}

\begin{BDef}
\Lcs{customlogo}\quad\Lcs{customminilogo}\quad\Lcs{custommagazinename}
\end{BDef}
When creating a magazine, everyone  wants to show its own logo instead of \textsf{xepersian-magazine} default heading. To achieve this, you need to put the following command at the preamble of your document:

\begin{BDef}
\Lcs{customlogo}\Largb{\Larga{text}}\\
\Lcs{customminilogo}\Largb{\Larga{text}}\\
\Lcs{custommagazinename}\Largb{\Larga{text}}
\end{BDef}


\begin{BDef}
\Lcs{edition}\quad\Lcs{editionformat}
\end{BDef}

The edition text has to be declared in the preamble of the document. One important thing to know is that \Lcs{author}, \Lcs{date} and \Lcs{title} have no effect inside \textsf{xepersian-magazine} since the magazine date is taken from \Lcs{today} command and the other two are only for the title page (if using \Lcs{maketitle}).

\begin{BDef}
\Lcs{indexFormat}\quad\Lcs{indexEntryFormat}\quad\Lcs{indexEntryPageTxt}\\
\Lcs{indexEntryPageFormat}\quad%
\Lcs{indexEntrySeparator}
\end{BDef}

When defining the index in the front page, there are several commands to customize the final index style. \Lcs{indexFormat} sets the format of the title; \Lcs{indexEntryFormat}, the format of each index entry; \Lcs{indexEntryPageTxt} and \Lcs{indexEntryPageFormat} lets you define which is the text that goes with the page number  and its format. Finally, \textsf{xepersian-magazine} creates a thin line between index entries, you can redefine it using \Lcs{indexEntrySeparator}. To get the index with \Lcs{xepersian@indexwidth} is provided.

\begin{BDef}
\Lcs{weatherFormat}\quad\Lcs{weatherTempFormat}\quad\Lcs{weatherUnits}
\end{BDef}

Relating to the weather block, the title format can be changed redefining \Lcs{weatherFormat}. In order to customize the format of the temperature numbers and their units it is necessary to redefine \Lcs{weatherTempFormat} and \Lcs{weatherUnits} respectively.

\begin{BDef}
\Lcs{*TitleFormat}\quad\Lcs{*SubtitleFormat}\quad\Lcs{*TextFormat}
\end{BDef}
The main article that appear in the front page can change their formats. To obtain that there are three standard commands to modify the title, subtitle and text style. You just have to replace the star (\texttt{*}) with first, second or third depending on which article you are editing. Note that first piece of article has no subtitle therefore it does not make any sense to use the non-existent command \Lcs{firstSubtitleFormat}.

\begin{BDef}
\Lcs{pictureCaptionFormat}\quad\Lcs{pagesFormat}
\end{BDef}
Two other elements to configure are the picture captions and the pages or section format in the entire document. To proceed just redefine the macros \Lcs{pictureCaptionFormat} and \Lcs{pagesFormat}.
\subsubsection{Inside The Magazine}
\begin{BDef}
\Lcs{innerTitleFormat}\quad\Lcs{innerSubtitleFormat}\quad\Lcs{innerAuthorFormat}\\
\Lcs{innerPlaceFormat}
\end{BDef}

The articles inside \textsf{xepersian-magazine} may have a different format from the ones in the front page. To change their title or subtitle format redefine \Lcs{innerTitleFormat} and \Lcs{innerSubtitleFormat}. The article text format matches the document general definition. When using the \Lcs{authorandplace} command, you might want to change the default style. Just renew \Lcs{innerAuthorFormat} and \Lcs{innerPlaceFormat} to get the results.

\begin{BDef}
\Lcs{timestampTxt}\quad\Lcs{timestampSeparator}\quad\Lcs{timestampFormat}
\end{BDef}

The \Lcs{timestamp} command described in  \autoref{subsub-1} lets you introduce the time of the event before the article text. You can configure its appearance by altering
several commands: \Lcs{timestampTxt} which means the text after the timestamp; \Lcs{timestampSeparator} which defines the element between the actual timestamp and the beginning of the text and, finally, \Lcs{timestampFormat} to change the entire timestamp format.

\begin{BDef}
\Lcs{innerTextFinalMark}
\end{BDef}

\textsf{xepersian-magazine} puts a small black square at the end of the article. As I wanted to create a highly customizable \LaTeX\ class I added the macro \Lcs{innerTextFinalMark} to change this black square. This item will appear always following the last character of the text with the \texttt{\~} character.

\begin{BDef}
\Lcs{minraggedcols}\quad\Lcs{raggedFormat}
\end{BDef}

The \Lcs{minraggedcols} counter is used to tell \textsf{xepersian-magazine} when article text should be ragged instead of justified. The counter represents the minimum number of columns that are needed in order to use ragged texts. For example, if \Lcs{minraggedcols} is set to 3, all articles with 3 columns or more will be ragged. Articles with 1, 2 columns will have justified text. By default, \Lcs{minraggedcols} is set to 4. 

The \Lcs{raggedFormat} macro can be redefined to fit user ragged style. Default value is \Lcs{RaggedLeft}.

\begin{BDef}
\Lcs{heading}\quad\Lcs{foot}
\end{BDef}
\textsf{xepersian-magazine} includes package \textsf{fancyhdr} for changing headings and footers. Although it is possible to use its own commands to modify \textsf{xepersian-magazine} style, there are two commands to change headings and foot appearance. Place them in the preamble of your \textsf{xepersian-magazine} document.

\begin{BDef}
\Lcs{heading}\Largb{\Larga{left}}\Largb{\Larga{center}}\Largb{\Larga{right}}\\
\Lcs{foot}\Largb{\Larga{left}}\Largb{\Larga{center}}\Largb{\Larga{right}}
\end{BDef}

 If you still prefer to use fancyhdr macros, use them after the \texttt{frontpage} environment.

\textsf{xepersian-magazine} by default places no headers and footers. If you want headers and foooters, then after loading \textsf{xepersian} package, you should write \Lcs{pagestyle}\Largb{fancy} at the preamble of your document.

\subsection{Class Options\label{s-options}} 
The \textsf{xepersian-magazine} class is in itself an alteration of the standard \textsf{article} class, thus it inherits most of its class options but \textsf{twoside}, \textsf{twocolumn}, \textsf{notitlepage} and \textsf{a4paper}. If you find problems when loading other article features, please let me know to fix it. There are also five own options that \textsf{xepersian-magazine} implements. 
\begin{description}
\item[\textsf{a3paper}] (false) This option makes \textsf{xepersian-magazine} 297 mm width by 420 mm height. This option is implemented because the standard \textsf{article} class does not allow this document size.
\item[\textsf{9pt}] (false) Allows the 9pt font size that \textsf{article} class does not include (default is 10pt).
\item[\textsf{columnlines}] columnlines (false) Adds lines between columns in the entire \textsf{xepersian-magazine}. The default line width is 0.1pt but it is possible to change this by setting length \Lcs{columnlines} in the preamble.
\item[\textsf{showgrid}] (false) This option is only for developing purposes. Because the front page has a personal design using the textpos package, I created this grid to make easier the lay out.
\end{description}

\section{Typesetting Multiple-choice Questions}
\subsection{Introduction}
\textsf{xepersian-multiplechoice} is a package for making multiple choices questionnaires  under \LaTeX. A special environment
allows you to define questions and possible answers. You can specify which
answers are correct and which are not. \textsf{xepersian-multiplechoice} not only formats the questions
for you, but also generates a ``form'' (a grid that your students will have to fill
in), and a ``mask'' (the same grid, only with correct answers properly checked
in). You can then print the mask on a slide and correct the questionnaires
more easily by superimposing the mask on top of students' forms.

\subsection{Usage}
Here we now explain the usage of this package, however there are four example files, namely \texttt{test-question-only.tex}, \texttt{test-solution-form.tex}, \texttt{test-empty-form.tex} and \texttt{test-correction.tex}, available in \textsf{doc} folder that you may want to look at.
\subsubsection{Loading The Package}
You can load the package as usual by:
\begin{BDef}
\Lcs{usepackage}\OptArgs\Largb{xepersian-multiplechoice}
\end{BDef}
The available options are described along the text,
where appropriate.
\subsubsection{Creating Questions}
Here's a simple example demonstrating how to produce a new question:
\begin{lstlisting}[morekeywords={false,true}]
\begin{question}{?\parsitext{سؤال}?}
\false ?\parsitext{جواب ۱}?
\true ?\parsitext{جواب ۲}?
\false ?\parsitext{جواب ۳}?
\false ?\parsitext{جواب ۴}?
\end{question}
\begin{correction}
?\parsitext{جواب واقعی و علت اینکه این جواب، جواب واقعی هست}?
\end{correction}
\end{lstlisting}
\subsubsection{The \texttt{question} Environment}
The \texttt{question} environment allows you to insert questions into your document. It
takes one mandatory argument which specifies the actual question's text. The
question will be displayed in a frame box, the size of the line.
\begin{BDef}
\Lcs{true}\quad\Lcs{false}
\end{BDef}

The proposed answers are displayed below the question in a list fashion (the
question environment is a list-based one). Instead of using \Lcs{item} however, use
either \Lcs{true} or \Lcs{false} to insert a possible answer.

\subsubsection{Question Numbers}
The \texttt{question} environment is associated with a \LaTeX\ counter named \texttt{question}.
This counter stores the number of the next (or current) question. It is initialized
to 1, and automatically incremented at the end of \texttt{question} environments. You
might want to use it to format question titles. For instance, you could decide that
each question belongs to a subsection in the \texttt{article} class, and use something like
this before each question: \Lcs{subsection*}\Largb{Question \Lcs{thequestion}}

\subsubsection{The Form and the Mask}
\begin{BDef}
\Lcs{makeform}\quad\Lcs{makemask}
\end{BDef}
Based on the questions appearing in your document, \textsf{xepersian-multiplechoice} has the ability to
generate a ``form'' (a grid that your students will have to fill in), and a ``mask''
(the same grid, only with correct answers properly checked in). This can make
the correction process easier.

To generate a form and a mask, use the macros \Lcs{makeform} and \Lcs{makemask}.
\textsf{xepersian-multiplechoice} uses two auxiliary files to build them. These files have respectively an
extension of \texttt{frm} and \texttt{msk}. If you use these macros, you will need two passes of
\LaTeX\ in order to get a correctly formatted document.

\subsubsection{Typesetting corrections}
The ``correction'' mode  allows you to automatically
typeset and distribute corrections to your students. These corrections
are slightly modified versions of your questionnaire: each possible answer is prefixed with a small symbol (a visual clue) indicating whether the answer was correct
or wrong. In addition, you can typeset explanations below each question.

To activate the correction mode, use the \texttt{correction} option. It is off by
default.

To typeset explanations below the questions, use the \texttt{correction} environment
(no argument). The contents of this environment is displayed only in correction
mode. In normal mode, it is simply discarded.

In addition, note that \textsf{xepersian-multiplechoice} cancels the actions performed by \Lcs{makeform} and
\Lcs{makemask} in \texttt{correction} mode. This is to avoid further edition of the source
when typesetting a correction.

\subsection{Important Note}
Currently, \textsf{xepersian-multiplechoice} requires that you provide a constant number of proposed answers
across all questions in your \textsf{xepersian-multiplechoice}. This is something natural when you want to
build forms, but this might me too restrictive otherwise, I'm not sure, so it is
possible that this restriction will be removed in future versions.

Currently, there is a built-in mechanism for checking that the number of proposed
answers remains constant: when \textsf{xepersian-multiplechoice} encounters the first occurrence of the
\texttt{question} environment, it remembers the number of proposed answers from there.
Afterwards, any noticed difference in subsequent occurrences will generate an error.
As a consequence, you never have to tell \textsf{xepersian-multiplechoice} explicitly what that number
is.

\subsection{Customising The Package}
\subsubsection{The \texttt{question} environment}
\begin{BDef}
\Lcs{questionspace}\quad\Lcs{answerstitlefont}\quad\Lcs{answernumberfont}
\end{BDef}
\Lcs{questionspace} is the amount of extra vertical space to put under the question,
before the list of proposed answers. This is a \LaTeX\ length that defaults to \texttt{0pt}.

Before the list of possible answers, a short title is displayed (for English, it
reads ``Possible answers:''). The \Lcs{answerstitlefont} macro takes one mandatory
argument which redefines the font to use for the answers title. By default,
\Lcs{bfseries} is used.

Each proposed answer in the list is numbered automatically (and alphabetically).
The \Lcs{answernumberfont} macro takes one mandatory argument which
redefines the font to use for displaying the answer number. By default, \Lcs{bfseries}
is used.

\subsubsection{The Form and the Mask}
\begin{BDef}
\Lcs{headerfont}\quad\Lcs{X}
\end{BDef}

The \Lcs{headerfont} macro takes one mandatory argument which redefines the font
to use for the headers (first line and first column) of the form and mask arrays.
By default, \Lcs{bfseries} is used.

In the mask, correct answers are checked in by filling the corresponding cell
with an ``X'' character. If you want to change this, call the \Lcs{X} macro with one
(mandatory) argument.

\subsubsection{The correction}
\begin{BDef}
\Lcs{truesymbol}\quad\Lcs{falsesymbol}
\end{BDef}

In correction mode, labels in front of answers are modified to give a visual clue
about whether the answer was correct or wrong. By default, a cross and a small
arrow are used. You can change these symbols by using the \Lcs{truesymbol} and

\Lcs{falsesymbol} macros. For instance, you could give a fancier look to your correction
by using the \textsf{pifont} package and issuing:

\begin{lstlisting}[numbers=none,morekeywords={truesymbol,ding,falsesymbol}]
\truesymbol{\ding{'063}~}
\falsesymbol{\ding{'067}~}
\end{lstlisting}

\begin{BDef}
\Lcs{correctionstyle}
\end{BDef}
The appearance of the contents of the correction environment can be adjusted
by using the \Lcs{correctionstyle} macro. By default, \Lcs{itshape} is used.
\end{document}