]> git.lyx.org Git - lyx.git/blob - lib/doc/Customization.lyx
Amend d6285d5, copy & paste error, urrrrg
[lyx.git] / lib / doc / Customization.lyx
1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
2 \lyxformat 541
3 \begin_document
4 \begin_header
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
7 \textclass scrbook
8 \begin_preamble
9 % DO NOT ALTER THIS PREAMBLE!!!
10 %
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected.  If you
14 % have problems LaTeXing this file, please contact 
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
17
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
22   \frontmatter
23   \pdfbookmark[1]{\contentsname}{}
24   \myTOC
25   \mainmatter }
26
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31  \addto\extrasenglish{%
32   \renewcommand*{\equationautorefname}[1]{}%
33   \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34   \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35   \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
36  }
37 }{}
38 \end_preamble
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
41 \begin_modules
42 logicalmkup
43 \end_modules
44 \maintain_unincluded_children false
45 \language english
46 \language_package default
47 \inputencoding auto
48 \fontencoding global
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
55 \font_sc false
56 \font_osf false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
59 \use_microtype false
60 \use_dash_ligatures true
61 \graphics default
62 \default_output_format pdf2
63 \output_sync 0
64 \bibtex_command default
65 \index_command default
66 \paperfontsize 12
67 \spacing single
68 \use_hyperref true
69 \pdf_title "LyX Configuration Manual"
70 \pdf_author "LyX Team"
71 \pdf_subject "LyX-documentation Customization"
72 \pdf_keywords "LyX, documentation, customization"
73 \pdf_bookmarks true
74 \pdf_bookmarksnumbered true
75 \pdf_bookmarksopen true
76 \pdf_bookmarksopenlevel 1
77 \pdf_breaklinks false
78 \pdf_pdfborder false
79 \pdf_colorlinks true
80 \pdf_backref false
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \papersize default
84 \use_geometry false
85 \use_package amsmath 0
86 \use_package amssymb 0
87 \use_package cancel 0
88 \use_package esint 0
89 \use_package mathdots 1
90 \use_package mathtools 0
91 \use_package mhchem 0
92 \use_package stackrel 0
93 \use_package stmaryrd 0
94 \use_package undertilde 0
95 \cite_engine basic
96 \cite_engine_type default
97 \biblio_style plain
98 \use_bibtopic false
99 \use_indices false
100 \paperorientation portrait
101 \suppress_date false
102 \justification true
103 \use_refstyle 0
104 \notefontcolor #0000ff
105 \branch OutDated
106 \selected 0
107 \filename_suffix 0
108 \color #f5fae7
109 \end_branch
110 \index Index
111 \shortcut idx
112 \color #008000
113 \end_index
114 \secnumdepth 3
115 \tocdepth 3
116 \paragraph_separation indent
117 \paragraph_indentation default
118 \is_math_indent 1
119 \quotes_style english
120 \dynamic_quotes 0
121 \papercolumns 1
122 \papersides 2
123 \paperpagestyle headings
124 \tracking_changes true
125 \output_changes false
126 \html_math_output 0
127 \html_css_as_file 0
128 \html_be_strict true
129 \author -712698321 "Jürgen Spitzmüller"
130 \author 2047637253 "Guillaume Munch"
131 \author 2089657418 "Usti"
132 \end_header
133
134 \begin_body
135
136 \begin_layout Title
137 Customizing \SpecialChar LyX
138 : Features for the Advanced User
139 \end_layout
140
141 \begin_layout Author
142 by the \SpecialChar LyX
143  Team
144 \begin_inset Foot
145 status collapsed
146
147 \begin_layout Plain Layout
148 \noindent
149 If you have comments or error corrections, please send them to the \SpecialChar LyX
150  Documentatio
151 n mailing list, 
152 \begin_inset CommandInset href
153 LatexCommand href
154 target "lyx-docs@lists.lyx.org"
155 type "mailto:"
156 literal "false"
157
158 \end_inset
159
160 .
161  Include 
162 \begin_inset Quotes eld
163 \end_inset
164
165 [Customization]
166 \begin_inset Quotes erd
167 \end_inset
168
169  in the subject header, and please cc the current maintainer of this file,
170  Richard Heck <rgheck@comcast.net>.
171 \end_layout
172
173 \end_inset
174
175
176 \begin_inset Newline newline
177 \end_inset
178
179
180 \begin_inset Newline newline
181 \end_inset
182
183 Version 2.2.x 
184 \end_layout
185
186 \begin_layout Standard
187 \begin_inset CommandInset toc
188 LatexCommand tableofcontents
189
190 \end_inset
191
192
193 \end_layout
194
195 \begin_layout Standard
196 \begin_inset Note Note
197 status open
198
199 \begin_layout Plain Layout
200 Please use change tracking when modifying this document.
201  This makes it easier for our translators to recognize things that have
202  been changed, and it helps the maintainer keep up-to-date with what's been
203  done.
204 \end_layout
205
206 \end_inset
207
208
209 \end_layout
210
211 \begin_layout Chapter
212 Introduction
213 \end_layout
214
215 \begin_layout Standard
216 This manual covers the customization features present in \SpecialChar LyX
217 .
218  In it, we discuss issues like keyboard shortcuts, screen previewing options,
219  printer options, sending commands to \SpecialChar LyX
220  via the \SpecialChar LyX
221  Server, internationalization,
222  installing new \SpecialChar LaTeX
223  classes and \SpecialChar LyX
224  layouts, etc.
225  We can't possibly hope to touch on everything you can change—our developers
226  add new features faster than we can document them—but we will explain the
227  most common customizations and hopefully point you in the right direction
228  for some of the more obscure ones.
229 \end_layout
230
231 \begin_layout Standard
232 \begin_inset Branch OutDated
233 inverted 0
234 status collapsed
235
236 \begin_layout Standard
237 Information from previous versions of this document that now seems to be
238  outdated is contained in the OutDated branch of this document.
239  By default, this information will not appear in the \SpecialChar LaTeX
240  output.
241 \end_layout
242
243 \end_inset
244
245
246 \end_layout
247
248 \begin_layout Chapter
249 \SpecialChar LyX
250  configuration files
251 \end_layout
252
253 \begin_layout Standard
254 This chapter aims to help you to find your way through the \SpecialChar LyX
255  configuration
256  files.
257  Before continuing to read this chapter, you should find out where your
258  \SpecialChar LyX
259  library and user directories are by using 
260 \begin_inset Flex Noun
261 status collapsed
262
263 \begin_layout Plain Layout
264 Help\SpecialChar menuseparator
265 About
266 \begin_inset space ~
267 \end_inset
268
269 LyX
270 \end_layout
271
272 \end_inset
273
274 .
275  The library directory is the place where \SpecialChar LyX
276  places its system-wide configuration
277  files; the user directory is where you can place your modified versions.
278  We will call the former 
279 \begin_inset Flex Code
280 status collapsed
281
282 \begin_layout Plain Layout
283 LyXDir
284 \end_layout
285
286 \end_inset
287
288  and the latter 
289 \begin_inset Flex Noun
290 status collapsed
291
292 \begin_layout Plain Layout
293 UserDir
294 \end_layout
295
296 \end_inset
297
298  in the remainder of this document.
299  
300 \end_layout
301
302 \begin_layout Section
303 What's in 
304 \begin_inset Flex Code
305 status collapsed
306
307 \begin_layout Plain Layout
308 LyXDir
309 \end_layout
310
311 \end_inset
312
313 ?
314 \end_layout
315
316 \begin_layout Standard
317 \begin_inset Flex Code
318 status collapsed
319
320 \begin_layout Plain Layout
321 LyXDir
322 \end_layout
323
324 \end_inset
325
326  and its sub-directories contain a number of files and that can be used
327  to customize \SpecialChar LyX
328 's behavior.
329  You can change many of these files from within \SpecialChar LyX
330  itself through the 
331 \begin_inset Flex Noun
332 status collapsed
333
334 \begin_layout Plain Layout
335 Tools\SpecialChar menuseparator
336 Preferences
337 \end_layout
338
339 \end_inset
340
341  dialog.
342  Most customization that you will want to do in \SpecialChar LyX
343  is possible through this
344  dialog.
345  However, many other inner aspects of \SpecialChar LyX
346  can be customized by modifying the
347  files in 
348 \begin_inset Flex Code
349 status collapsed
350
351 \begin_layout Plain Layout
352 LyXDir
353 \end_layout
354
355 \end_inset
356
357 .
358  These files fall in different categories, described in the following subsection
359 s.
360 \end_layout
361
362 \begin_layout Subsection
363 Automatically generated files
364 \end_layout
365
366 \begin_layout Standard
367 The files, which are to be found in 
368 \begin_inset Flex Noun
369 status collapsed
370
371 \begin_layout Plain Layout
372 UserDir
373 \end_layout
374
375 \end_inset
376
377 , are generated when you configure \SpecialChar LyX
378 .
379  They contain various default values that are guessed by inspection.
380  In general, it is not a good idea to modify them, since they might be overwritt
381 en at any time.
382 \end_layout
383
384 \begin_layout Labeling
385 \labelwidthstring 00.00.0000
386 \begin_inset Flex Code
387 status collapsed
388
389 \begin_layout Plain Layout
390 lyxrc.defaults
391 \end_layout
392
393 \end_inset
394
395  contains defaults for various commands.
396 \end_layout
397
398 \begin_layout Labeling
399 \labelwidthstring 00.00.0000
400 \begin_inset Flex Code
401 status collapsed
402
403 \begin_layout Plain Layout
404 packages.lst
405 \end_layout
406
407 \end_inset
408
409  contains the list of packages that have been recognized by \SpecialChar LyX
410 .
411  It is currently unused by the \SpecialChar LyX
412  program itself, but the information extracted,
413  and more, is made available with 
414 \begin_inset Flex Noun
415 status collapsed
416
417 \begin_layout Plain Layout
418 Help\SpecialChar menuseparator
419 \SpecialChar LaTeX
420
421 \begin_inset space ~
422 \end_inset
423
424 Configuration
425 \end_layout
426
427 \end_inset
428
429 .
430 \end_layout
431
432 \begin_layout Labeling
433 \labelwidthstring 00.00.0000
434 \begin_inset Flex Code
435 status collapsed
436
437 \begin_layout Plain Layout
438 textclass.lst
439 \end_layout
440
441 \end_inset
442
443  the list of text classes that have been found in your 
444 \begin_inset Flex Code
445 status collapsed
446
447 \begin_layout Plain Layout
448 layout/
449 \end_layout
450
451 \end_inset
452
453  directories, along with the associated \SpecialChar LaTeX
454  document class and their description.
455 \end_layout
456
457 \begin_layout Labeling
458 \labelwidthstring 00.00.0000
459 \begin_inset Flex Code
460 status collapsed
461
462 \begin_layout Plain Layout
463 lyxmodules.lst
464 \end_layout
465
466 \end_inset
467
468  the list of layout modules found in your 
469 \begin_inset Flex Code
470 status collapsed
471
472 \begin_layout Plain Layout
473 layout/
474 \end_layout
475
476 \end_inset
477
478  directories
479 \end_layout
480
481 \begin_layout Labeling
482 \labelwidthstring 00.00.0000
483 \begin_inset Flex Code
484 status collapsed
485
486 \begin_layout Plain Layout
487 *files.lst
488 \end_layout
489
490 \end_inset
491
492  lists of various sorts of \SpecialChar LaTeX
493 -related files found on your system
494 \end_layout
495
496 \begin_layout Labeling
497 \labelwidthstring 00.00.0000
498 \begin_inset Flex Code
499 status collapsed
500
501 \begin_layout Plain Layout
502 doc/\SpecialChar LaTeX
503 Config.lyx
504 \end_layout
505
506 \end_inset
507
508  is automatically generated during configuration from the file 
509 \begin_inset Flex Code
510 status collapsed
511
512 \begin_layout Plain Layout
513 \SpecialChar LaTeX
514 Config.lyx.in
515 \end_layout
516
517 \end_inset
518
519 .
520  It contains information on your \SpecialChar LaTeX
521  configuration.
522 \end_layout
523
524 \begin_layout Subsection
525 Directories
526 \end_layout
527
528 \begin_layout Standard
529 These directories are duplicated between 
530 \begin_inset Flex Code
531 status collapsed
532
533 \begin_layout Plain Layout
534 LyXDir
535 \end_layout
536
537 \end_inset
538
539  and 
540 \begin_inset Flex Code
541 status collapsed
542
543 \begin_layout Plain Layout
544 UserDir
545 \end_layout
546
547 \end_inset
548
549 .
550  If a particular files exists in both places, the one in 
551 \begin_inset Flex Code
552 status collapsed
553
554 \begin_layout Plain Layout
555 UserDir
556 \end_layout
557
558 \end_inset
559
560  will be used.
561 \end_layout
562
563 \begin_layout Labeling
564 \labelwidthstring 00.00.0000
565 \begin_inset Flex Code
566 status collapsed
567
568 \begin_layout Plain Layout
569 bind/
570 \end_layout
571
572 \end_inset
573
574  this directory contains files with the extension 
575 \begin_inset Flex Code
576 status collapsed
577
578 \begin_layout Plain Layout
579 .bind
580 \end_layout
581
582 \end_inset
583
584  that define the keybindings used in \SpecialChar LyX
585 .
586  If there exists an internationalized version of the bind file named 
587 \begin_inset Flex Code
588 status collapsed
589
590 \begin_layout Plain Layout
591 $LANG_xxx.bind
592 \end_layout
593
594 \end_inset
595
596 , that will be used first.
597 \change_inserted -712698321 1483535138
598
599 \end_layout
600
601 \begin_layout Labeling
602 \labelwidthstring 00.00.0000
603
604 \change_inserted -712698321 1483874001
605 \begin_inset Flex Code
606 status collapsed
607
608 \begin_layout Plain Layout
609
610 \change_inserted -712698321 1483535144
611 citeengines/
612 \end_layout
613
614 \end_inset
615
616  contains files with the extension 
617 \begin_inset Flex Code
618 status collapsed
619
620 \begin_layout Plain Layout
621
622 \change_inserted -712698321 1483869840
623 .citeengine
624 \change_unchanged
625
626 \end_layout
627
628 \end_inset
629
630  which define the diverse citation possibilities (natbib, biblatex etc.).
631  See 
632 \begin_inset CommandInset ref
633 LatexCommand ref
634 reference "subsec:Cite-Engine-Files"
635 plural "false"
636 caps "false"
637 noprefix "false"
638
639 \end_inset
640
641  for details.
642 \change_unchanged
643
644 \end_layout
645
646 \begin_layout Labeling
647 \labelwidthstring 00.00.0000
648 \begin_inset Flex Code
649 status collapsed
650
651 \begin_layout Plain Layout
652 clipart/
653 \end_layout
654
655 \end_inset
656
657  contains graphics files that can be included in documents.
658  
659 \end_layout
660
661 \begin_layout Labeling
662 \labelwidthstring 00.00.0000
663 \begin_inset Flex Code
664 status collapsed
665
666 \begin_layout Plain Layout
667 doc/
668 \end_layout
669
670 \end_inset
671
672  contains \SpecialChar LyX
673  documentation files (including the one you are currently reading).
674  The file 
675 \begin_inset Flex Code
676 status collapsed
677
678 \begin_layout Plain Layout
679 \SpecialChar LaTeX
680 Config.lyx
681 \end_layout
682
683 \end_inset
684
685  deserves special attention, as noted above.
686  The internationalized help docs are in subdirectories 
687 \begin_inset Flex Code
688 status collapsed
689
690 \begin_layout Plain Layout
691 doc/xx
692 \end_layout
693
694 \end_inset
695
696  where 
697 \begin_inset Quotes eld
698 \end_inset
699
700 xx
701 \begin_inset Quotes erd
702 \end_inset
703
704  is the ISO language code.
705  See 
706 \begin_inset CommandInset ref
707 LatexCommand ref
708 reference "cha:Internationalizing-LyX"
709
710 \end_inset
711
712  for details.
713 \end_layout
714
715 \begin_layout Labeling
716 \labelwidthstring 00.00.0000
717 \begin_inset Flex Code
718 status collapsed
719
720 \begin_layout Plain Layout
721 examples/
722 \end_layout
723
724 \end_inset
725
726  contains example files that explain how to use some features.
727  In the file browser, press the 
728 \begin_inset Flex Noun
729 status collapsed
730
731 \begin_layout Plain Layout
732 Examples
733 \end_layout
734
735 \end_inset
736
737  button to get there.
738 \end_layout
739
740 \begin_layout Labeling
741 \labelwidthstring 00.00.0000
742 \begin_inset Flex Code
743 status collapsed
744
745 \begin_layout Plain Layout
746 images/
747 \end_layout
748
749 \end_inset
750
751  contains image files that are used by the 
752 \begin_inset Flex Noun
753 status collapsed
754
755 \begin_layout Plain Layout
756 Document
757 \end_layout
758
759 \end_inset
760
761  dialog.
762  In addition, it also contains the individual icons used in the toolbar
763  and the banners that can be shown when \SpecialChar LyX
764  is launched.
765 \end_layout
766
767 \begin_layout Labeling
768 \labelwidthstring 00.00.0000
769 \begin_inset Flex Code
770 status collapsed
771
772 \begin_layout Plain Layout
773 kbd/
774 \end_layout
775
776 \end_inset
777
778  contains keyboard keymapping files.
779  See 
780 \begin_inset CommandInset ref
781 LatexCommand ref
782 reference "sec:International-Keymap-Stuff"
783
784 \end_inset
785
786  for details.
787 \end_layout
788
789 \begin_layout Labeling
790 \labelwidthstring 00.00.0000
791 \begin_inset Flex Code
792 status collapsed
793
794 \begin_layout Plain Layout
795 layouts/
796 \end_layout
797
798 \end_inset
799
800  contains the text class and module files described in 
801 \begin_inset CommandInset ref
802 LatexCommand ref
803 reference "cha:Installing-New-Document"
804
805 \end_inset
806
807 .
808 \end_layout
809
810 \begin_layout Labeling
811 \labelwidthstring 00.00.0000
812 \begin_inset Flex Code
813 status collapsed
814
815 \begin_layout Plain Layout
816 lyx2lyx
817 \end_layout
818
819 \end_inset
820
821  contains the 
822 \begin_inset Flex Code
823 status collapsed
824
825 \begin_layout Plain Layout
826 lyx2lyx
827 \end_layout
828
829 \end_inset
830
831  Python scripts used to convert between \SpecialChar LyX
832  versions.
833  These can be run from the command line if, say, you want to batch-convert
834  files.
835 \end_layout
836
837 \begin_layout Labeling
838 \labelwidthstring 00.00.0000
839 \begin_inset Flex Code
840 status collapsed
841
842 \begin_layout Plain Layout
843 scripts/
844 \end_layout
845
846 \end_inset
847
848  contains some files that demonstrate the capabilities of the 
849 \begin_inset Flex Noun
850 status collapsed
851
852 \begin_layout Plain Layout
853 External
854 \begin_inset space ~
855 \end_inset
856
857 Template
858 \end_layout
859
860 \end_inset
861
862  feature.
863  Also contains some scripts used by \SpecialChar LyX
864  itself.
865 \end_layout
866
867 \begin_layout Labeling
868 \labelwidthstring 00.00.0000
869 \begin_inset Flex Code
870 status collapsed
871
872 \begin_layout Plain Layout
873 templates/
874 \end_layout
875
876 \end_inset
877
878  contains the standard \SpecialChar LyX
879  template files described in 
880 \begin_inset CommandInset ref
881 LatexCommand ref
882 reference "subsec:Creating-Templates"
883
884 \end_inset
885
886 .
887 \end_layout
888
889 \begin_layout Labeling
890 \labelwidthstring 00.00.0000
891 \begin_inset Flex Code
892 status collapsed
893
894 \begin_layout Plain Layout
895 ui/
896 \end_layout
897
898 \end_inset
899
900  contains files with the extension 
901 \begin_inset Flex Code
902 status collapsed
903
904 \begin_layout Plain Layout
905 .ui
906 \end_layout
907
908 \end_inset
909
910  that define the user interface to \SpecialChar LyX
911 .
912  That is, the files define which items appear in which menus and the items
913  appearing on the toolbar.
914 \change_inserted -712698321 1490533733
915
916 \end_layout
917
918 \begin_layout Labeling
919 \labelwidthstring 00.00.0000
920
921 \change_inserted -712698321 1490533849
922 \begin_inset Flex Code
923 status collapsed
924
925 \begin_layout Plain Layout
926
927 \change_inserted -712698321 1490533738
928 xtemplates/
929 \end_layout
930
931 \end_inset
932
933  contains files with the extension 
934 \begin_inset Flex Code
935 status collapsed
936
937 \begin_layout Plain Layout
938
939 \change_inserted -712698321 1490533759
940 .xtemplate
941 \end_layout
942
943 \end_inset
944
945  which define the templates for the insertion of external material to a
946  \SpecialChar LyX
947  document; see 
948 \begin_inset CommandInset ref
949 LatexCommand ref
950 reference "chap:Including-External-Material"
951
952 \end_inset
953
954 .
955 \change_unchanged
956
957 \end_layout
958
959 \begin_layout Subsection
960 Files you don't want to modify
961 \end_layout
962
963 \begin_layout Standard
964 These files are used internally by \SpecialChar LyX
965  and you generally do not need to modify
966  them unless you are a developer.
967 \end_layout
968
969 \begin_layout Labeling
970 \labelwidthstring 00.00.0000
971 \begin_inset Flex Code
972 status collapsed
973
974 \begin_layout Plain Layout
975 CREDITS
976 \end_layout
977
978 \end_inset
979
980  this file contains the list of \SpecialChar LyX
981  developers.
982  The contents are displayed with the menu entry 
983 \begin_inset Flex Noun
984 status collapsed
985
986 \begin_layout Plain Layout
987 Help\SpecialChar menuseparator
988 About
989 \begin_inset space ~
990 \end_inset
991
992 LyX
993 \end_layout
994
995 \end_inset
996
997 .
998 \end_layout
999
1000 \begin_layout Labeling
1001 \labelwidthstring 00.00.0000
1002 \begin_inset Flex Code
1003 status collapsed
1004
1005 \begin_layout Plain Layout
1006 chkconfig.ltx
1007 \end_layout
1008
1009 \end_inset
1010
1011  this is a \SpecialChar LaTeX
1012  script used during the configuration process.
1013  Do not run directly.
1014 \end_layout
1015
1016 \begin_layout Labeling
1017 \labelwidthstring 00.00.0000
1018 \begin_inset Flex Code
1019 status collapsed
1020
1021 \begin_layout Plain Layout
1022 configure.py
1023 \end_layout
1024
1025 \end_inset
1026
1027  this is a Python script that is used to re-configure \SpecialChar LyX
1028 .
1029  It creates configuration files in the directory it was run from.
1030 \end_layout
1031
1032 \begin_layout Subsection
1033 Other files needing a line or two
1034 \end_layout
1035
1036 \begin_layout Labeling
1037 \labelwidthstring 00.00.0000
1038 \begin_inset Flex Code
1039 status collapsed
1040
1041 \begin_layout Plain Layout
1042 encodings
1043 \end_layout
1044
1045 \end_inset
1046
1047  this contains tables describing how different character encodings can be
1048  mapped to Unicode
1049 \end_layout
1050
1051 \begin_layout Labeling
1052 \labelwidthstring 00.00.0000
1053
1054 \change_deleted -712698321 1490533856
1055 \begin_inset Flex Code
1056 status collapsed
1057
1058 \begin_layout Plain Layout
1059 external_templates
1060 \end_layout
1061
1062 \end_inset
1063
1064  this file contains the templates available to the new 
1065 \begin_inset Flex Noun
1066 status collapsed
1067
1068 \begin_layout Plain Layout
1069 External
1070 \begin_inset space ~
1071 \end_inset
1072
1073 Template
1074 \end_layout
1075
1076 \end_inset
1077
1078  feature, see 
1079 \begin_inset CommandInset ref
1080 LatexCommand ref
1081 reference "chap:Including-External-Material"
1082
1083 \end_inset
1084
1085 .
1086 \change_unchanged
1087
1088 \end_layout
1089
1090 \begin_layout Labeling
1091 \labelwidthstring 00.00.0000
1092 \begin_inset Flex Code
1093 status collapsed
1094
1095 \begin_layout Plain Layout
1096 languages
1097 \end_layout
1098
1099 \end_inset
1100
1101  this file contains a list of all the languages currently supported by \SpecialChar LyX
1102 .
1103 \end_layout
1104
1105 \begin_layout Labeling
1106 \labelwidthstring 00.00.0000
1107 \begin_inset Flex Code
1108 status collapsed
1109
1110 \begin_layout Plain Layout
1111 latexfonts
1112 \end_layout
1113
1114 \end_inset
1115
1116  contains information about the supported fonts.
1117 \end_layout
1118
1119 \begin_layout Labeling
1120 \labelwidthstring 00.00.0000
1121 \begin_inset Flex Code
1122 status collapsed
1123
1124 \begin_layout Plain Layout
1125 layouttranslations
1126 \end_layout
1127
1128 \end_inset
1129
1130  this file contains translations for internationalized paragraph styles
1131  (see 
1132 \begin_inset CommandInset ref
1133 LatexCommand ref
1134 reference "subsec:I18n"
1135
1136 \end_inset
1137
1138 ).
1139 \end_layout
1140
1141 \begin_layout Labeling
1142 \labelwidthstring 00.00.0000
1143 \begin_inset Flex Code
1144 status collapsed
1145
1146 \begin_layout Plain Layout
1147 unicodesymbols
1148 \end_layout
1149
1150 \end_inset
1151
1152  this file contains information about unicode-encoded glyphs and the way
1153  they are supported by \SpecialChar LyX
1154  via \SpecialChar LaTeX
1155 .
1156 \end_layout
1157
1158 \begin_layout Section
1159 Your local configuration directory
1160 \end_layout
1161
1162 \begin_layout Standard
1163 Even if you are using \SpecialChar LyX
1164  as an unprivileged user, you might want to change
1165  \SpecialChar LyX
1166  configuration for your own use.
1167  The 
1168 \begin_inset Flex Code
1169 status collapsed
1170
1171 \begin_layout Plain Layout
1172 UserDir
1173 \end_layout
1174
1175 \end_inset
1176
1177  directory contains all your personal configuration files.
1178  This is the directory described as 
1179 \begin_inset Quotes eld
1180 \end_inset
1181
1182 user directory
1183 \begin_inset Quotes erd
1184 \end_inset
1185
1186  in 
1187 \begin_inset Flex Noun
1188 status collapsed
1189
1190 \begin_layout Plain Layout
1191 Help\SpecialChar menuseparator
1192 About
1193 \begin_inset space ~
1194 \end_inset
1195
1196 LyX
1197 \end_layout
1198
1199 \end_inset
1200
1201 .
1202  This directory is used as a mirror of 
1203 \begin_inset Flex Code
1204 status collapsed
1205
1206 \begin_layout Plain Layout
1207 LyXDir
1208 \end_layout
1209
1210 \end_inset
1211
1212 , which means that every file in 
1213 \begin_inset Flex Code
1214 status collapsed
1215
1216 \begin_layout Plain Layout
1217 UserDir
1218 \end_layout
1219
1220 \end_inset
1221
1222  is a replacement for the corresponding file in 
1223 \begin_inset Flex Code
1224 status collapsed
1225
1226 \begin_layout Plain Layout
1227 LyXDir
1228 \end_layout
1229
1230 \end_inset
1231
1232 .
1233  Any configuration file described in the above sections can be placed either
1234  in the system-wide directory, in which case it will affect all users, or
1235  in your local directory for your own use.
1236 \end_layout
1237
1238 \begin_layout Standard
1239 To make things clearer, let's provide a few examples:
1240 \end_layout
1241
1242 \begin_layout Itemize
1243 The preferences set in the 
1244 \begin_inset Flex Noun
1245 status collapsed
1246
1247 \begin_layout Plain Layout
1248 Tools\SpecialChar menuseparator
1249 Preferences
1250 \end_layout
1251
1252 \end_inset
1253
1254  dialog are saved to a file 
1255 \begin_inset Flex Code
1256 status collapsed
1257
1258 \begin_layout Plain Layout
1259 preferences
1260 \end_layout
1261
1262 \end_inset
1263
1264  in 
1265 \begin_inset Flex Code
1266 status collapsed
1267
1268 \begin_layout Plain Layout
1269 UserDir
1270 \end_layout
1271
1272 \end_inset
1273
1274 .
1275 \end_layout
1276
1277 \begin_layout Itemize
1278 When you reconfigure using 
1279 \begin_inset Flex Noun
1280 status collapsed
1281
1282 \begin_layout Plain Layout
1283 Tools\SpecialChar menuseparator
1284 Reconfigure
1285 \end_layout
1286
1287 \end_inset
1288
1289 , \SpecialChar LyX
1290  runs the 
1291 \begin_inset Flex Code
1292 status collapsed
1293
1294 \begin_layout Plain Layout
1295 configure.py
1296 \end_layout
1297
1298 \end_inset
1299
1300  script, and the resulting files are written in your local configuration
1301  directory.
1302  This means that any additional text class file that you might have added
1303  in 
1304 \begin_inset Flex Code
1305 status collapsed
1306
1307 \begin_layout Plain Layout
1308 UserDir/layouts
1309 \end_layout
1310
1311 \end_inset
1312
1313  will be added to the list of classes in the 
1314 \begin_inset Flex Noun
1315 status collapsed
1316
1317 \begin_layout Plain Layout
1318 Document\SpecialChar menuseparator
1319 Settings
1320 \end_layout
1321
1322 \end_inset
1323
1324  dialog.
1325 \end_layout
1326
1327 \begin_layout Itemize
1328 If you get some updated documentation from \SpecialChar LyX
1329  ftp site and cannot install
1330  it because you do not have sysadmin rights on your system, you can just
1331  copy the files in 
1332 \begin_inset Flex Code
1333 status collapsed
1334
1335 \begin_layout Plain Layout
1336 UserDir/doc/
1337 \end_layout
1338
1339 \end_inset
1340
1341  and the items in the 
1342 \begin_inset Flex Noun
1343 status collapsed
1344
1345 \begin_layout Plain Layout
1346 Help
1347 \end_layout
1348
1349 \end_inset
1350
1351  menu will open them!
1352 \end_layout
1353
1354 \begin_layout Section
1355 Running \SpecialChar LyX
1356  with multiple configurations
1357 \end_layout
1358
1359 \begin_layout Standard
1360 The configuration freedom of the local configuration directory may not suffice
1361  if you want to have more than one configuration at your disposal.
1362  For example, you may want to be use different key bindings or printer settings
1363  at different times.
1364  You can achieve this by having several such directories.
1365  You then specify which directory to use at run-time.
1366 \end_layout
1367
1368 \begin_layout Standard
1369 Invoking \SpecialChar LyX
1370  with the command line switch 
1371 \begin_inset Flex Code
1372 status collapsed
1373
1374 \begin_layout Plain Layout
1375 -userdir
1376 \end_layout
1377
1378 \end_inset
1379
1380  
1381 \emph on
1382 <some directory>
1383 \emph default
1384  instructs the program to read the configuration from that directory, and
1385  not from the default directory.
1386  (You can determine the default directory by running \SpecialChar LyX
1387  without the 
1388 \begin_inset Flex Code
1389 status collapsed
1390
1391 \begin_layout Plain Layout
1392 -userdir
1393 \end_layout
1394
1395 \end_inset
1396
1397  switch.) If the specified directory does not exist, \SpecialChar LyX
1398  offers to create it
1399  for you, just like it does for the default directory on the first time
1400  you run the program.
1401  You can modify the configuration options in this additional user directory
1402  exactly as you would for the default directory.
1403  These directories are completely independent (but read on).
1404  Note that setting the environment variable 
1405 \begin_inset Flex Code
1406 status collapsed
1407
1408 \begin_layout Plain Layout
1409 LYX_USERDIR_VER
1410 \end_layout
1411
1412 \end_inset
1413
1414  to some value has exactly the same effect.
1415 \end_layout
1416
1417 \begin_layout Standard
1418 Having several configurations also requires more maintenance: if you want
1419  to add a new layout to 
1420 \begin_inset Flex Code
1421 status collapsed
1422
1423 \begin_layout Plain Layout
1424 NewUserDir/layouts
1425 \end_layout
1426
1427 \end_inset
1428
1429  which you want available from all your configurations, you must add it
1430  to each directory separately.
1431  You can avoid this with the following trick: after \SpecialChar LyX
1432  creates the additional
1433  directory, most of the subdirectories (see above) are empty.
1434  If you want the new configuration to mirror an existing one, replace the
1435  empty subdirectory with a symbolic link to the matching subdirectory in
1436  the existing configuration.
1437  Take care with the 
1438 \begin_inset Flex Code
1439 status collapsed
1440
1441 \begin_layout Plain Layout
1442 doc/
1443 \end_layout
1444
1445 \end_inset
1446
1447  subdirectory, however, since it contains a file written by the configuration
1448  script (also accessible through 
1449 \begin_inset Flex Noun
1450 status collapsed
1451
1452 \begin_layout Plain Layout
1453 Tools\SpecialChar menuseparator
1454 Reconfigure
1455 \end_layout
1456
1457 \end_inset
1458
1459 ) which is configuration-specific.
1460 \end_layout
1461
1462 \begin_layout Chapter
1463 The Preferences dialog
1464 \end_layout
1465
1466 \begin_layout Standard
1467 All options of the preferences dialog are described in the Appendix 
1468 \emph on
1469 The Preferences Dialog
1470 \emph default
1471  in the 
1472 \emph on
1473 User's Guide
1474 \emph default
1475 .
1476  For some options you might find here more details.
1477 \end_layout
1478
1479 \begin_layout Section
1480 Formats
1481 \begin_inset CommandInset label
1482 LatexCommand label
1483 name "sec:Formats"
1484
1485 \end_inset
1486
1487
1488 \end_layout
1489
1490 \begin_layout Standard
1491 The first step is to define your file formats if they are not already defined.
1492  To do so, open the 
1493 \begin_inset Flex Noun
1494 status collapsed
1495
1496 \begin_layout Plain Layout
1497 Tools\SpecialChar menuseparator
1498 Preferences
1499 \end_layout
1500
1501 \end_inset
1502
1503  dialog.
1504  Under 
1505 \begin_inset Flex Noun
1506 status collapsed
1507
1508 \begin_layout Plain Layout
1509 File Handling\SpecialChar menuseparator
1510 File formats
1511 \end_layout
1512
1513 \end_inset
1514
1515  press the 
1516 \begin_inset Flex Noun
1517 status collapsed
1518
1519 \begin_layout Plain Layout
1520 New
1521 \end_layout
1522
1523 \end_inset
1524
1525  button to define your new format.
1526  The 
1527 \begin_inset Flex Noun
1528 status collapsed
1529
1530 \begin_layout Plain Layout
1531 Format
1532 \end_layout
1533
1534 \end_inset
1535
1536  field contains the name used to identify the format in the GUI.
1537  The 
1538 \begin_inset Flex Noun
1539 status collapsed
1540
1541 \begin_layout Plain Layout
1542 Short Name
1543 \end_layout
1544
1545 \end_inset
1546
1547  is used to identify the format internally.
1548  You will also need to enter a file extension.
1549  These are all required.
1550  The optional 
1551 \begin_inset Flex Noun
1552 status collapsed
1553
1554 \begin_layout Plain Layout
1555 Shortcut
1556 \end_layout
1557
1558 \end_inset
1559
1560  field is used to provide a keyboard shortcut on the menus.
1561  (For example, pressing 
1562 \begin_inset Flex Noun
1563 status collapsed
1564
1565 \begin_layout Plain Layout
1566 Ctrl+D
1567 \end_layout
1568
1569 \end_inset
1570
1571  will 
1572 \begin_inset Flex Noun
1573 status collapsed
1574
1575 \begin_layout Plain Layout
1576 Document\SpecialChar menuseparator
1577 View (Other Formats)\SpecialChar menuseparator
1578 DVI
1579 \end_layout
1580
1581 \end_inset
1582
1583 .) 
1584 \end_layout
1585
1586 \begin_layout Standard
1587 A Format can have a 
1588 \begin_inset Flex Noun
1589 status collapsed
1590
1591 \begin_layout Plain Layout
1592 Viewer
1593 \end_layout
1594
1595 \end_inset
1596
1597  and an 
1598 \begin_inset Flex Noun
1599 status collapsed
1600
1601 \begin_layout Plain Layout
1602 Editor
1603 \end_layout
1604
1605 \end_inset
1606
1607  associated with it.
1608  For example, you might want to use 
1609 \begin_inset Flex Noun
1610 status collapsed
1611
1612 \begin_layout Plain Layout
1613 Ghostview
1614 \end_layout
1615
1616 \end_inset
1617
1618  to view PostScript files.
1619  You can enter the command needed to start the program in the corresponding
1620  fields.
1621  In defining this command, you can use the four variables listed in the
1622  next section.
1623  The viewer is launched when you view an image in \SpecialChar LyX
1624  or use the 
1625 \begin_inset Flex Noun
1626 status collapsed
1627
1628 \begin_layout Plain Layout
1629 Document\SpecialChar menuseparator
1630 View
1631 \end_layout
1632
1633 \end_inset
1634
1635  menu.
1636  The editor is for example launched when you right-click on an image and
1637  choose 
1638 \begin_inset Flex Noun
1639 status collapsed
1640
1641 \begin_layout Plain Layout
1642 Edit externally
1643 \end_layout
1644
1645 \end_inset
1646
1647  in the appearing context menu.
1648 \end_layout
1649
1650 \begin_layout Standard
1651 The 
1652 \begin_inset Flex Noun
1653 status collapsed
1654
1655 \begin_layout Plain Layout
1656 MIME
1657 \end_layout
1658
1659 \end_inset
1660
1661  type of a format is optional, but if it is specified, it must be unique
1662  across all formats.
1663  It is used to detect files of this format from the file contents.
1664  For some important file formats there is no MIME type officially registered
1665  with the 
1666 \begin_inset CommandInset href
1667 LatexCommand href
1668 name "IANA"
1669 target "http://www.iana.org/assignments/media-types/"
1670 literal "false"
1671
1672 \end_inset
1673
1674 .
1675  Therefore \SpecialChar LyX
1676  uses the extended list of MIME types as specified by 
1677 \begin_inset CommandInset href
1678 LatexCommand href
1679 name "freedesktop.org"
1680 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1681 literal "false"
1682
1683 \end_inset
1684
1685 .
1686 \end_layout
1687
1688 \begin_layout Standard
1689 The 
1690 \begin_inset Flex Noun
1691 status collapsed
1692
1693 \begin_layout Plain Layout
1694 Document format
1695 \end_layout
1696
1697 \end_inset
1698
1699  option tells \SpecialChar LyX
1700  that a format is suitable for document export.
1701  If this is set and if a suitable conversion route exists (see 
1702 \begin_inset CommandInset ref
1703 LatexCommand ref
1704 reference "sec:Converters"
1705
1706 \end_inset
1707
1708 ), the format will appear in the 
1709 \begin_inset Flex Noun
1710 status collapsed
1711
1712 \begin_layout Plain Layout
1713 File\SpecialChar menuseparator
1714 Export
1715 \end_layout
1716
1717 \end_inset
1718
1719  menu.
1720  The format will also appear in the 
1721 \begin_inset Flex Noun
1722 status collapsed
1723
1724 \begin_layout Plain Layout
1725 Document\SpecialChar menuseparator
1726 View
1727 \end_layout
1728
1729 \end_inset
1730
1731  menu if a viewer is specified for the format.
1732  Pure image formats, such as 
1733 \begin_inset Flex Code
1734 status collapsed
1735
1736 \begin_layout Plain Layout
1737 png
1738 \end_layout
1739
1740 \end_inset
1741
1742 , should not use this option.
1743  Formats that can both represent vector graphics and documents like 
1744 \begin_inset Flex Code
1745 status collapsed
1746
1747 \begin_layout Plain Layout
1748 pdf
1749 \end_layout
1750
1751 \end_inset
1752
1753  should use it.
1754 \end_layout
1755
1756 \begin_layout Standard
1757 The option 
1758 \begin_inset Flex Noun
1759 status collapsed
1760
1761 \begin_layout Plain Layout
1762 Vector graphics format
1763 \end_layout
1764
1765 \end_inset
1766
1767  tells \SpecialChar LyX
1768  that a format can contain vector graphics.
1769  This information is used to determine the target format of included graphics
1770  for 
1771 \begin_inset Flex Noun
1772 status collapsed
1773
1774 \begin_layout Plain Layout
1775 pdflatex
1776 \end_layout
1777
1778 \end_inset
1779
1780  export.
1781  Included graphics may need to be converted to either 
1782 \begin_inset Flex Noun
1783 status collapsed
1784
1785 \begin_layout Plain Layout
1786 pdf
1787 \end_layout
1788
1789 \end_inset
1790
1791
1792 \begin_inset Flex Noun
1793 status collapsed
1794
1795 \begin_layout Plain Layout
1796 png
1797 \end_layout
1798
1799 \end_inset
1800
1801 , or 
1802 \begin_inset Flex Noun
1803 status collapsed
1804
1805 \begin_layout Plain Layout
1806 jpg
1807 \end_layout
1808
1809 \end_inset
1810
1811 , since 
1812 \begin_inset Flex Noun
1813 status collapsed
1814
1815 \begin_layout Plain Layout
1816 pdflatex
1817 \end_layout
1818
1819 \end_inset
1820
1821  cannot handle other image formats.
1822  If an included graphic is not already in 
1823 \begin_inset Flex Noun
1824 status collapsed
1825
1826 \begin_layout Plain Layout
1827 pdf
1828 \end_layout
1829
1830 \end_inset
1831
1832
1833 \begin_inset Flex Noun
1834 status collapsed
1835
1836 \begin_layout Plain Layout
1837 png
1838 \end_layout
1839
1840 \end_inset
1841
1842 , or 
1843 \begin_inset Flex Noun
1844 status collapsed
1845
1846 \begin_layout Plain Layout
1847 jpg
1848 \end_layout
1849
1850 \end_inset
1851
1852  format, it is converted to 
1853 \begin_inset Flex Noun
1854 status collapsed
1855
1856 \begin_layout Plain Layout
1857 pdf
1858 \end_layout
1859
1860 \end_inset
1861
1862  if the vector format option is set, and otherwise to 
1863 \begin_inset Flex Noun
1864 status collapsed
1865
1866 \begin_layout Plain Layout
1867 png
1868 \end_layout
1869
1870 \end_inset
1871
1872 .
1873 \end_layout
1874
1875 \begin_layout Section
1876 Copiers
1877 \end_layout
1878
1879 \begin_layout Standard
1880 Since all conversions from one format to another take place in \SpecialChar LyX
1881 's temporary
1882  directory, it is sometimes necessary to modify a file before copying it
1883  to the temporary directory in order that the conversion may be performed.
1884 \begin_inset Foot
1885 status collapsed
1886
1887 \begin_layout Plain Layout
1888 For example, the file may refer to other files—images, for example—using
1889  relative file names, and these may become invalid when the file is copied
1890  to the temporary directory.
1891 \end_layout
1892
1893 \end_inset
1894
1895  This is done by a Copier: It copies a file to (or from) the temporary directory
1896  and may modify it in the process.
1897 \end_layout
1898
1899 \begin_layout Standard
1900 The definitions of the copiers may use eight variables:
1901 \end_layout
1902
1903 \begin_layout Labeling
1904 \labelwidthstring 00.00.0000
1905 \begin_inset Flex Code
1906 status collapsed
1907
1908 \begin_layout Plain Layout
1909 $$s
1910 \end_layout
1911
1912 \end_inset
1913
1914  The \SpecialChar LyX
1915  system directory (e.
1916 \begin_inset space \thinspace{}
1917 \end_inset
1918
1919 g.
1920 \begin_inset space \space{}
1921 \end_inset
1922
1923
1924 \begin_inset Flex Noun
1925 status collapsed
1926
1927 \begin_layout Plain Layout
1928 /usr/share/lyx
1929 \end_layout
1930
1931 \end_inset
1932
1933 ).
1934 \end_layout
1935
1936 \begin_layout Labeling
1937 \labelwidthstring 00.00.0000
1938 \begin_inset Flex Code
1939 status collapsed
1940
1941 \begin_layout Plain Layout
1942 $$i
1943 \end_layout
1944
1945 \end_inset
1946
1947  The input file
1948 \end_layout
1949
1950 \begin_layout Labeling
1951 \labelwidthstring 00.00.0000
1952 \begin_inset Flex Code
1953 status collapsed
1954
1955 \begin_layout Plain Layout
1956 $$o
1957 \end_layout
1958
1959 \end_inset
1960
1961  The output file
1962 \end_layout
1963
1964 \begin_layout Labeling
1965 \labelwidthstring 00.00.0000
1966 \begin_inset Flex Code
1967 status collapsed
1968
1969 \begin_layout Plain Layout
1970 $$b
1971 \end_layout
1972
1973 \end_inset
1974
1975  The base name (without filename extension) in the \SpecialChar LyX
1976  temporary directory
1977 \end_layout
1978
1979 \begin_layout Labeling
1980 \labelwidthstring 00.00.0000
1981 \begin_inset Flex Code
1982 status collapsed
1983
1984 \begin_layout Plain Layout
1985 $$p
1986 \end_layout
1987
1988 \end_inset
1989
1990  The full directory path of the \SpecialChar LyX
1991  temporary directory
1992 \end_layout
1993
1994 \begin_layout Labeling
1995 \labelwidthstring 00.00.0000
1996 \begin_inset Flex Code
1997 status collapsed
1998
1999 \begin_layout Plain Layout
2000 $$r
2001 \end_layout
2002
2003 \end_inset
2004
2005  The full pathname to the original \SpecialChar LyX
2006  file being processed
2007 \end_layout
2008
2009 \begin_layout Labeling
2010 \labelwidthstring 00.00.0000
2011 \begin_inset Flex Code
2012 status collapsed
2013
2014 \begin_layout Plain Layout
2015 $$f
2016 \end_layout
2017
2018 \end_inset
2019
2020  The filename (without any directory path) of the \SpecialChar LyX
2021  file.
2022 \end_layout
2023
2024 \begin_layout Labeling
2025 \labelwidthstring 00.00.0000
2026 \begin_inset Flex Code
2027 status collapsed
2028
2029 \begin_layout Plain Layout
2030 $$l
2031 \end_layout
2032
2033 \end_inset
2034
2035  The `\SpecialChar LaTeX
2036  name'
2037 \end_layout
2038
2039 \begin_layout Standard
2040 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2041 's 
2042 \series bold
2043
2044 \backslash
2045 include
2046 \series default
2047  command.
2048  It is relevant only when exporting files suitable for such inclusion.
2049 \end_layout
2050
2051 \begin_layout Standard
2052 Copiers can be used to do almost anything with output files.
2053  For example, suppose you want generated pdf files to be copied to a special
2054  directory, 
2055 \begin_inset Flex Code
2056 status collapsed
2057
2058 \begin_layout Plain Layout
2059 /home/you/pdf/
2060 \end_layout
2061
2062 \end_inset
2063
2064 .
2065  Then you could write a shell script such as this one:
2066 \end_layout
2067
2068 \begin_layout Standard
2069 \begin_inset listings
2070 inline false
2071 status open
2072
2073 \begin_layout Plain Layout
2074
2075 #!/bin/bash
2076 \end_layout
2077
2078 \begin_layout Plain Layout
2079
2080 FROMFILE=$1
2081 \end_layout
2082
2083 \begin_layout Plain Layout
2084
2085 TOFILE=`basename $2`
2086 \end_layout
2087
2088 \begin_layout Plain Layout
2089
2090 cp $FROMFILE /home/you/pdf/$TOFILE
2091 \end_layout
2092
2093 \end_inset
2094
2095 Save it in your local \SpecialChar LyX
2096  directory—say, 
2097 \begin_inset Flex Code
2098 status collapsed
2099
2100 \begin_layout Plain Layout
2101 /home/you/.lyx/scripts/pdfcopier.sh
2102 \end_layout
2103
2104 \end_inset
2105
2106 —and make it executable, if you need to do so on your platform.
2107  Then, in the 
2108 \begin_inset Flex Noun
2109 status collapsed
2110
2111 \begin_layout Plain Layout
2112 Tools\SpecialChar menuseparator
2113 Preferences
2114 \end_layout
2115
2116 \end_inset
2117
2118  dialog, select under 
2119 \begin_inset Flex Noun
2120 status collapsed
2121
2122 \begin_layout Plain Layout
2123 File Handling\SpecialChar menuseparator
2124 File formats
2125 \end_layout
2126
2127 \end_inset
2128
2129  the 
2130 \begin_inset Flex Noun
2131 status collapsed
2132
2133 \begin_layout Plain Layout
2134 PDF(pdflatex)
2135 \end_layout
2136
2137 \end_inset
2138
2139  format—or one of the other pdf formats—and enter 
2140 \begin_inset Flex Code
2141 status collapsed
2142
2143 \begin_layout Plain Layout
2144 pdfcopier.sh $$i $$o
2145 \end_layout
2146
2147 \end_inset
2148
2149  into the 
2150 \begin_inset Flex Noun
2151 status collapsed
2152
2153 \begin_layout Plain Layout
2154 Copier
2155 \end_layout
2156
2157 \end_inset
2158
2159  field.
2160  
2161 \end_layout
2162
2163 \begin_layout Standard
2164 Copiers are used by \SpecialChar LyX
2165  in various of its own conversions.
2166  For example, if appropriate programs are found, \SpecialChar LyX
2167  will automatically install
2168  copiers for the 
2169 \begin_inset Flex Noun
2170 status collapsed
2171
2172 \begin_layout Plain Layout
2173 HTML
2174 \end_layout
2175
2176 \end_inset
2177
2178  and 
2179 \begin_inset Flex Noun
2180 status collapsed
2181
2182 \begin_layout Plain Layout
2183 HTML
2184 \begin_inset space ~
2185 \end_inset
2186
2187 (MS Word)
2188 \end_layout
2189
2190 \end_inset
2191
2192  formats.
2193  When these formats are exported, the copier sees that not just the main
2194  HTML file but various associated files (style files, images, etc.) are also
2195  copied.
2196  All these files are written to a subdirectory of the directory in which
2197  the original \SpecialChar LyX
2198  file was found.
2199 \begin_inset Foot
2200 status collapsed
2201
2202 \begin_layout Plain Layout
2203 This copier can be customized.
2204  The optional 
2205 \begin_inset Quotes eld
2206 \end_inset
2207
2208 -e
2209 \begin_inset Quotes erd
2210 \end_inset
2211
2212  argument takes a comma-separated list of extensions to be copied; if it
2213  is omitted, all files will be copied.
2214  The 
2215 \begin_inset Quotes eld
2216 \end_inset
2217
2218 -t
2219 \begin_inset Quotes erd
2220 \end_inset
2221
2222  argument determines the extension added to the generated directory.
2223  By default, it is 
2224 \begin_inset Quotes eld
2225 \end_inset
2226
2227
2228 \begin_inset Flex Noun
2229 status collapsed
2230
2231 \begin_layout Plain Layout
2232 LyXconv
2233 \end_layout
2234
2235 \end_inset
2236
2237
2238 \begin_inset Quotes erd
2239 \end_inset
2240
2241 , so HTML generated from 
2242 \begin_inset Flex Noun
2243 status collapsed
2244
2245 \begin_layout Plain Layout
2246 /path/to/filename.lyx
2247 \end_layout
2248
2249 \end_inset
2250
2251  will end up in 
2252 \begin_inset Flex Noun
2253 status collapsed
2254
2255 \begin_layout Plain Layout
2256 /path/to/filename.html.LyXconv
2257 \end_layout
2258
2259 \end_inset
2260
2261 .
2262  
2263 \end_layout
2264
2265 \end_inset
2266
2267
2268 \end_layout
2269
2270 \begin_layout Section
2271 Converters
2272 \begin_inset CommandInset label
2273 LatexCommand label
2274 name "sec:Converters"
2275
2276 \end_inset
2277
2278
2279 \end_layout
2280
2281 \begin_layout Standard
2282 You can define your own Converters to convert files between different formats.
2283  This is done in the 
2284 \begin_inset Flex Noun
2285 status collapsed
2286
2287 \begin_layout Plain Layout
2288 Tools\SpecialChar menuseparator
2289 Preferences\SpecialChar menuseparator
2290 File Handling\SpecialChar menuseparator
2291 Converters
2292 \end_layout
2293
2294 \end_inset
2295
2296  dialog.
2297 \end_layout
2298
2299 \begin_layout Standard
2300 To define a new converter, select the 
2301 \begin_inset Flex Noun
2302 status collapsed
2303
2304 \begin_layout Plain Layout
2305 From
2306 \begin_inset space ~
2307 \end_inset
2308
2309 format
2310 \end_layout
2311
2312 \end_inset
2313
2314  and 
2315 \begin_inset Flex Noun
2316 status collapsed
2317
2318 \begin_layout Plain Layout
2319 To
2320 \begin_inset space ~
2321 \end_inset
2322
2323 format
2324 \end_layout
2325
2326 \end_inset
2327
2328  from the drop-down lists, enter the command needed for the conversion,
2329  and then press the 
2330 \begin_inset Flex Noun
2331 status collapsed
2332
2333 \begin_layout Plain Layout
2334 Add
2335 \end_layout
2336
2337 \end_inset
2338
2339  button.
2340  Several variables can be used in the definition of converters:
2341 \end_layout
2342
2343 \begin_layout Labeling
2344 \labelwidthstring 00.00.0000
2345 \begin_inset Flex Code
2346 status collapsed
2347
2348 \begin_layout Plain Layout
2349 $$s
2350 \end_layout
2351
2352 \end_inset
2353
2354  The \SpecialChar LyX
2355  system directory
2356 \end_layout
2357
2358 \begin_layout Labeling
2359 \labelwidthstring 00.00.0000
2360 \begin_inset Flex Code
2361 status collapsed
2362
2363 \begin_layout Plain Layout
2364 $$i
2365 \end_layout
2366
2367 \end_inset
2368
2369  The input file
2370 \end_layout
2371
2372 \begin_layout Labeling
2373 \labelwidthstring 00.00.0000
2374 \begin_inset Flex Code
2375 status collapsed
2376
2377 \begin_layout Plain Layout
2378 $$o
2379 \end_layout
2380
2381 \end_inset
2382
2383  The output file
2384 \end_layout
2385
2386 \begin_layout Labeling
2387 \labelwidthstring 00.00.0000
2388 \begin_inset Flex Code
2389 status collapsed
2390
2391 \begin_layout Plain Layout
2392 $$b
2393 \end_layout
2394
2395 \end_inset
2396
2397  The base filename of the input file (i.
2398 \begin_inset space \thinspace{}
2399 \end_inset
2400
2401 g., without the extension)
2402 \end_layout
2403
2404 \begin_layout Labeling
2405 \labelwidthstring 00.00.0000
2406 \begin_inset Flex Code
2407 status collapsed
2408
2409 \begin_layout Plain Layout
2410 $$p
2411 \end_layout
2412
2413 \end_inset
2414
2415  The path to the input file
2416 \end_layout
2417
2418 \begin_layout Labeling
2419 \labelwidthstring 00.00.0000
2420 \begin_inset Flex Code
2421 status collapsed
2422
2423 \begin_layout Plain Layout
2424 $$r
2425 \end_layout
2426
2427 \end_inset
2428
2429  The path to the original input file (this is different from $$p when a
2430  chain of converters is called)
2431 \end_layout
2432
2433 \begin_layout Labeling
2434 \labelwidthstring 00.00.0000
2435 \begin_inset Flex Code
2436 status collapsed
2437
2438 \begin_layout Plain Layout
2439 $$e
2440 \end_layout
2441
2442 \end_inset
2443
2444  The iconv name for the encoding of the document.
2445 \end_layout
2446
2447 \begin_layout Standard
2448 In the 
2449 \begin_inset Flex Noun
2450 status collapsed
2451
2452 \begin_layout Plain Layout
2453 Extra
2454 \begin_inset space ~
2455 \end_inset
2456
2457 Flag
2458 \end_layout
2459
2460 \end_inset
2461
2462  field you can enter the following flags, separated by commas:
2463 \end_layout
2464
2465 \begin_layout Labeling
2466 \labelwidthstring 00.00.0000
2467 \begin_inset Flex Code
2468 status collapsed
2469
2470 \begin_layout Plain Layout
2471 latex
2472 \end_layout
2473
2474 \end_inset
2475
2476  This converter runs some form of \SpecialChar LaTeX
2477 .
2478  This will make \SpecialChar LyX
2479 's \SpecialChar LaTeX
2480  error logs available.
2481 \end_layout
2482
2483 \begin_layout Labeling
2484 \labelwidthstring 00.00.0000
2485 \begin_inset Flex Code
2486 status collapsed
2487
2488 \begin_layout Plain Layout
2489 needaux
2490 \end_layout
2491
2492 \end_inset
2493
2494  Needs the \SpecialChar LaTeX
2495  
2496 \begin_inset Flex Noun
2497 status collapsed
2498
2499 \begin_layout Plain Layout
2500 .aux
2501 \end_layout
2502
2503 \end_inset
2504
2505  file for the conversion.
2506 \end_layout
2507
2508 \begin_layout Labeling
2509 \labelwidthstring 00.00.0000
2510 \begin_inset Flex Code
2511 status collapsed
2512
2513 \begin_layout Plain Layout
2514 nice
2515 \end_layout
2516
2517 \end_inset
2518
2519  Needs a 
2520 \begin_inset Quotes eld
2521 \end_inset
2522
2523 nice
2524 \begin_inset Quotes erd
2525 \end_inset
2526
2527  file from the backend, which in practice means a \SpecialChar LaTeX
2528  file like the one we
2529  would export, without 
2530 \begin_inset Flex Code
2531 status collapsed
2532
2533 \begin_layout Plain Layout
2534 input@path
2535 \end_layout
2536
2537 \end_inset
2538
2539 .
2540 \end_layout
2541
2542 \begin_layout Labeling
2543 \labelwidthstring 00.00.0000
2544 \begin_inset Flex Code
2545 status collapsed
2546
2547 \begin_layout Plain Layout
2548 xml
2549 \end_layout
2550
2551 \end_inset
2552
2553  Output is XML.
2554 \end_layout
2555
2556 \begin_layout Standard
2557 The following three flags are not really flags at all because they take
2558  an argument in the 
2559 \begin_inset Flex Noun
2560 status collapsed
2561
2562 \begin_layout Plain Layout
2563 key
2564 \begin_inset space ~
2565 \end_inset
2566
2567 =
2568 \begin_inset space ~
2569 \end_inset
2570
2571 value
2572 \end_layout
2573
2574 \end_inset
2575
2576  format:
2577 \end_layout
2578
2579 \begin_layout Labeling
2580 \labelwidthstring 00.00.0000
2581 \begin_inset Flex Code
2582 status collapsed
2583
2584 \begin_layout Plain Layout
2585 parselog
2586 \end_layout
2587
2588 \end_inset
2589
2590  If set, the converter's standard error will be redirected to a file 
2591 \begin_inset Flex Code
2592 status collapsed
2593
2594 \begin_layout Plain Layout
2595 infile.out
2596 \end_layout
2597
2598 \end_inset
2599
2600 , and the script given as argument will be run as: 
2601 \begin_inset Flex Code
2602 status collapsed
2603
2604 \begin_layout Plain Layout
2605 script < infile.out > infile.log
2606 \end_layout
2607
2608 \end_inset
2609
2610 .
2611  The argument may contain 
2612 \begin_inset Flex Code
2613 status collapsed
2614
2615 \begin_layout Plain Layout
2616 $$s
2617 \end_layout
2618
2619 \end_inset
2620
2621 .
2622 \end_layout
2623
2624 \begin_layout Labeling
2625 \labelwidthstring 00.00.0000
2626 \begin_inset Flex Code
2627 status collapsed
2628
2629 \begin_layout Plain Layout
2630 resultdir
2631 \end_layout
2632
2633 \end_inset
2634
2635  The name of the directory in which the converter will dump the generated
2636  files.
2637  \SpecialChar LyX
2638  will not create this directory, and it does not copy anything into it,
2639  though it will copy this directory to the destination.
2640  The argument may contain 
2641 \begin_inset Flex Code
2642 status collapsed
2643
2644 \begin_layout Plain Layout
2645 $$b
2646 \end_layout
2647
2648 \end_inset
2649
2650 , which will be replaced by the base name of the input and output files,
2651  respectively, when the directory is copied.
2652 \begin_inset Newline newline
2653 \end_inset
2654
2655 Note that resultdir and usetempdir make no sense together.
2656  The latter will be ignored if the former is given.
2657 \end_layout
2658
2659 \begin_layout Labeling
2660 \labelwidthstring 00.00.0000
2661 \begin_inset Flex Code
2662 status collapsed
2663
2664 \begin_layout Plain Layout
2665 resultfile
2666 \end_layout
2667
2668 \end_inset
2669
2670  Determines the output file name and may, contain 
2671 \begin_inset Flex Code
2672 status collapsed
2673
2674 \begin_layout Plain Layout
2675 $$b
2676 \end_layout
2677
2678 \end_inset
2679
2680 .
2681  Sensible only with resultdir and optional even then; if not given, it defaults
2682  to `index'.
2683 \end_layout
2684
2685 \begin_layout Standard
2686 None of these last three are presently used in any of the converters that
2687  are installed with \SpecialChar LyX
2688 .
2689  
2690 \end_layout
2691
2692 \begin_layout Standard
2693 You do not have to define converters for all formats between which you want
2694  to convert.
2695  For example, you will note that there is no `\SpecialChar LyX
2696  to PostScript' converter,
2697  but \SpecialChar LyX
2698  will export PostScript.
2699  It does so by first creating a \SpecialChar LaTeX
2700  file (no converter needs to be defined
2701  for this) which is then converted to DVI using the `\SpecialChar LaTeX
2702  to DVI' converter,
2703  and finally converting the resulting DVI file to PostScript.
2704  \SpecialChar LyX
2705  finds such `chains' of converters automatically, and it will always choose
2706  the shortest possible chain.
2707  You can, though, still define multiple conversion methods between file
2708  formats.
2709  For example, the standard \SpecialChar LyX
2710  configuration provides five ways to convert
2711  \SpecialChar LaTeX
2712  to PDF:
2713 \end_layout
2714
2715 \begin_layout Enumerate
2716 Directly, using 
2717 \begin_inset Flex Noun
2718 status collapsed
2719
2720 \begin_layout Plain Layout
2721 pdflatex
2722 \end_layout
2723
2724 \end_inset
2725
2726
2727 \end_layout
2728
2729 \begin_layout Enumerate
2730 via (DVI and) PostScript, using 
2731 \begin_inset Flex Noun
2732 status collapsed
2733
2734 \begin_layout Plain Layout
2735 ps2pdf
2736 \end_layout
2737
2738 \end_inset
2739
2740
2741 \end_layout
2742
2743 \begin_layout Enumerate
2744 via DVI, using 
2745 \begin_inset Flex Noun
2746 status collapsed
2747
2748 \begin_layout Plain Layout
2749 dvipdfm
2750 \end_layout
2751
2752 \end_inset
2753
2754
2755 \end_layout
2756
2757 \begin_layout Enumerate
2758 directly using 
2759 \begin_inset Flex Noun
2760 status collapsed
2761
2762 \begin_layout Plain Layout
2763 Xe\SpecialChar TeX
2764
2765 \end_layout
2766
2767 \end_inset
2768
2769
2770 \end_layout
2771
2772 \begin_layout Enumerate
2773 directly using 
2774 \begin_inset Flex Noun
2775 status collapsed
2776
2777 \begin_layout Plain Layout
2778 Lua\SpecialChar TeX
2779
2780 \end_layout
2781
2782 \end_inset
2783
2784
2785 \end_layout
2786
2787 \begin_layout Standard
2788 To define such alternate chains, you must define multiple target `file formats',
2789  as described in 
2790 \begin_inset CommandInset ref
2791 LatexCommand ref
2792 reference "sec:Formats"
2793
2794 \end_inset
2795
2796 .
2797  For example, in the standard configuration, the formats named 
2798 \begin_inset Flex Noun
2799 status collapsed
2800
2801 \begin_layout Plain Layout
2802 pdf
2803 \end_layout
2804
2805 \end_inset
2806
2807  (for 
2808 \begin_inset Flex Noun
2809 status collapsed
2810
2811 \begin_layout Plain Layout
2812 ps2pdf
2813 \end_layout
2814
2815 \end_inset
2816
2817 ), 
2818 \begin_inset Flex Noun
2819 status collapsed
2820
2821 \begin_layout Plain Layout
2822 pdf2
2823 \end_layout
2824
2825 \end_inset
2826
2827  (for 
2828 \begin_inset Flex Noun
2829 status collapsed
2830
2831 \begin_layout Plain Layout
2832 pdflatex
2833 \end_layout
2834
2835 \end_inset
2836
2837 ), 
2838 \begin_inset Flex Noun
2839 status collapsed
2840
2841 \begin_layout Plain Layout
2842 pdf3
2843 \end_layout
2844
2845 \end_inset
2846
2847  (for 
2848 \begin_inset Flex Noun
2849 status collapsed
2850
2851 \begin_layout Plain Layout
2852 dvipdfm
2853 \end_layout
2854
2855 \end_inset
2856
2857 ), 
2858 \begin_inset Flex Noun
2859 status collapsed
2860
2861 \begin_layout Plain Layout
2862 pdf4
2863 \end_layout
2864
2865 \end_inset
2866
2867  (for 
2868 \begin_inset Flex Noun
2869 status collapsed
2870
2871 \begin_layout Plain Layout
2872 Xe\SpecialChar TeX
2873
2874 \end_layout
2875
2876 \end_inset
2877
2878 ), and 
2879 \begin_inset Flex Noun
2880 status collapsed
2881
2882 \begin_layout Plain Layout
2883 pdf5
2884 \end_layout
2885
2886 \end_inset
2887
2888  (for 
2889 \begin_inset Flex Noun
2890 status collapsed
2891
2892 \begin_layout Plain Layout
2893 Lua\SpecialChar TeX
2894
2895 \end_layout
2896
2897 \end_inset
2898
2899 ) are defined, all of which share the extension 
2900 \begin_inset Flex Noun
2901 status collapsed
2902
2903 \begin_layout Plain Layout
2904 .pdf
2905 \end_layout
2906
2907 \end_inset
2908
2909 , and which correspond to the conversion methods just mentioned.
2910 \end_layout
2911
2912 \begin_layout Chapter
2913 Internationalizing \SpecialChar LyX
2914
2915 \begin_inset CommandInset label
2916 LatexCommand label
2917 name "cha:Internationalizing-LyX"
2918
2919 \end_inset
2920
2921
2922 \end_layout
2923
2924 \begin_layout Standard
2925 \SpecialChar LyX
2926  supports using a translated interface.
2927  Last time we checked, \SpecialChar LyX
2928  provided text in thirty languages.
2929  The language of choice is called your 
2930 \emph on
2931 locale
2932 \emph default
2933 .
2934  (For further reading on locale settings, see also the documentation for
2935  locale that comes with your operating system.
2936  For Linux, the manual page for 
2937 \begin_inset Flex Code
2938 status collapsed
2939
2940 \begin_layout Plain Layout
2941 locale(5)
2942 \end_layout
2943
2944 \end_inset
2945
2946  could be a good place to start).
2947 \end_layout
2948
2949 \begin_layout Standard
2950 Notice that these translations will work, but do contain a few flaws.
2951  In particular, all dialogs have been designed with the English text in
2952  mind, which means that some of the translated text will be too large to
2953  fit within the space allocated.
2954  This is only a display problem and will not cause any harm.
2955  Also, you will find that some of the translations do not define shortcut
2956  keys for everything.
2957  Sometimes, there are simply not enough free letters to do it.
2958  Other times, the translator just hasn't got around to doing it yet.
2959  Our localization team, which you may wish to join,
2960 \begin_inset Foot
2961 status collapsed
2962
2963 \begin_layout Plain Layout
2964 If you are a fluent speaker of a language other than English, joining these
2965  teams is a great way to give back to the \SpecialChar LyX
2966  community!
2967 \end_layout
2968
2969 \end_inset
2970
2971  will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2972 .
2973 \end_layout
2974
2975 \begin_layout Section
2976 Translating \SpecialChar LyX
2977
2978 \end_layout
2979
2980 \begin_layout Subsection
2981 Translating the graphical user interface (text messages).
2982 \end_layout
2983
2984 \begin_layout Standard
2985 \SpecialChar LyX
2986  uses the GNU 
2987 \begin_inset Flex Code
2988 status collapsed
2989
2990 \begin_layout Plain Layout
2991 gettext
2992 \end_layout
2993
2994 \end_inset
2995
2996  library to handle the internationalization of the interface.
2997  To have \SpecialChar LyX
2998  speak your favorite language in all menus and dialogs, you need
2999  a 
3000 \begin_inset Flex Code
3001 status collapsed
3002
3003 \begin_layout Plain Layout
3004 po
3005 \end_layout
3006
3007 \end_inset
3008
3009 -file for that language.
3010  When this is available, you'll have to generate a 
3011 \begin_inset Flex Code
3012 status collapsed
3013
3014 \begin_layout Plain Layout
3015 mo
3016 \end_layout
3017
3018 \end_inset
3019
3020 -file from it and install the 
3021 \begin_inset Flex Code
3022 status collapsed
3023
3024 \begin_layout Plain Layout
3025 mo
3026 \end_layout
3027
3028 \end_inset
3029
3030 -file.
3031  The process of doing all of this is explained in the documentation for
3032  GNU 
3033 \begin_inset Flex Code
3034 status collapsed
3035
3036 \begin_layout Plain Layout
3037 gettext
3038 \end_layout
3039
3040 \end_inset
3041
3042 .
3043  It is possible to do this just for yourself, but if you're going to do
3044  it, you might as well share the results of your labors with the rest of
3045  the \SpecialChar LyX
3046  community.
3047  Send a message to the \SpecialChar LyX
3048  developers' list for more information about how
3049  to proceed.
3050 \end_layout
3051
3052 \begin_layout Standard
3053 In short, this is what you should do (xx denotes the language code):
3054 \end_layout
3055
3056 \begin_layout Itemize
3057 Check out the \SpecialChar LyX
3058  source code.
3059  (See the 
3060 \begin_inset CommandInset href
3061 LatexCommand href
3062 name "information on the web"
3063 target "http://www.lyx.org/HowToUseGIT"
3064 literal "false"
3065
3066 \end_inset
3067
3068 .)
3069 \end_layout
3070
3071 \begin_layout Itemize
3072 Copy the file 
3073 \begin_inset Flex Code
3074 status collapsed
3075
3076 \begin_layout Plain Layout
3077 lyx.pot
3078 \end_layout
3079
3080 \end_inset
3081
3082  to the folder of the 
3083 \begin_inset Flex Code
3084 status collapsed
3085
3086 \begin_layout Plain Layout
3087 **.po
3088 \end_layout
3089
3090 \end_inset
3091
3092  files.
3093  Then rename it to 
3094 \begin_inset Flex Code
3095 status collapsed
3096
3097 \begin_layout Plain Layout
3098 xx.po
3099 \end_layout
3100
3101 \end_inset
3102
3103 .
3104  (If 
3105 \begin_inset Flex Code
3106 status collapsed
3107
3108 \begin_layout Plain Layout
3109 lyx.pot
3110 \end_layout
3111
3112 \end_inset
3113
3114  doesn't exist anywhere, it can be remade with the console command 
3115 \begin_inset Flex Code
3116 status collapsed
3117
3118 \begin_layout Plain Layout
3119 make lyx.pot
3120 \end_layout
3121
3122 \end_inset
3123
3124  in that directory, or you can use an existing po-file for some other language
3125  as a template).
3126 \end_layout
3127
3128 \begin_layout Itemize
3129 Edit 
3130 \begin_inset Flex Code
3131 status collapsed
3132
3133 \begin_layout Plain Layout
3134 xx.po
3135 \end_layout
3136
3137 \end_inset
3138
3139 .
3140 \begin_inset Foot
3141 status collapsed
3142
3143 \begin_layout Plain Layout
3144 This is just a text file, so it can be edited in any text editor.
3145  But there are also specialized programs that support such editing, such
3146  as 
3147 \family typewriter
3148 Poedit
3149 \family default
3150  (for all platforms) or 
3151 \family typewriter
3152 KBabel
3153 \family default
3154  (for KDE).
3155  
3156 \family typewriter
3157 Emacs
3158 \family default
3159  contains a `mode' for editing 
3160 \begin_inset Flex Code
3161 status collapsed
3162
3163 \begin_layout Plain Layout
3164 po
3165 \end_layout
3166
3167 \end_inset
3168
3169  files, as well, see 
3170 \begin_inset Flex URL
3171 status open
3172
3173 \begin_layout Plain Layout
3174
3175 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3176 \backslash
3177 #PO-Mode
3178 \end_layout
3179
3180 \end_inset
3181
3182 .
3183 \end_layout
3184
3185 \end_inset
3186
3187  For some menu- and widget-labels, there are also shortcut keys that should
3188  be translated.
3189  Those keys are marked after a `|', and should be translated according to
3190  the words and phrases of the language.
3191  You should also fill also out the information at the beginning of the new
3192  
3193 \begin_inset Flex Code
3194 status collapsed
3195
3196 \begin_layout Plain Layout
3197 po
3198 \end_layout
3199
3200 \end_inset
3201
3202 -file with your email-address, etc., so people know where to reach you with
3203  suggestions and entertaining flames.
3204 \end_layout
3205
3206 \begin_layout Standard
3207 If you are just doing this on your own, then:
3208 \end_layout
3209
3210 \begin_layout Itemize
3211 Generate 
3212 \begin_inset Flex Code
3213 status collapsed
3214
3215 \begin_layout Plain Layout
3216 xx.mo
3217 \end_layout
3218
3219 \end_inset
3220
3221 .
3222  This can be done with 
3223 \begin_inset Flex Code
3224 status collapsed
3225
3226 \begin_layout Plain Layout
3227 msgfmt -o xx.mo < xx.po
3228 \end_layout
3229
3230 \end_inset
3231
3232 .
3233 \end_layout
3234
3235 \begin_layout Itemize
3236 Copy the 
3237 \begin_inset Flex Code
3238 status collapsed
3239
3240 \begin_layout Plain Layout
3241 mo
3242 \end_layout
3243
3244 \end_inset
3245
3246 -file to your locale-tree, at the correct directory for application messages
3247  for the language
3248 \series bold
3249  
3250 \series default
3251 xx, and under the name 
3252 \begin_inset Flex Code
3253 status collapsed
3254
3255 \begin_layout Plain Layout
3256 lyx.mo
3257 \end_layout
3258
3259 \end_inset
3260
3261  (e.
3262 \begin_inset space \thinspace{}
3263 \end_inset
3264
3265 g.
3266 \begin_inset space \space{}
3267 \end_inset
3268
3269
3270 \begin_inset Flex Code
3271 status collapsed
3272
3273 \begin_layout Plain Layout
3274 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3275 \end_layout
3276
3277 \end_inset
3278
3279
3280 \series bold
3281 .
3282 \end_layout
3283
3284 \begin_layout Standard
3285 As said, however, it would be best if the new 
3286 \begin_inset Flex Code
3287 status collapsed
3288
3289 \begin_layout Plain Layout
3290 po
3291 \end_layout
3292
3293 \end_inset
3294
3295  file could be added to the \SpecialChar LyX
3296  distribution, so others can use it.
3297  Adding it involves making additional changes to \SpecialChar LyX
3298 .
3299  So send an email to the developers' mailing list if you're interested in
3300  doing that.
3301 \end_layout
3302
3303 \begin_layout Subsubsection
3304 Ambiguous messages
3305 \end_layout
3306
3307 \begin_layout Standard
3308 Sometimes it turns out that one English message needs to be translated into
3309  different messages in the target language.
3310  One example is the message 
3311 \begin_inset Flex Code
3312 status collapsed
3313
3314 \begin_layout Plain Layout
3315 To
3316 \end_layout
3317
3318 \end_inset
3319
3320  which has the German translation 
3321 \lang german
3322 Nach
3323 \lang english
3324  or 
3325 \lang german
3326 Bis
3327 \lang english
3328 , depending upon exactly what the English 
3329 \begin_inset Quotes eld
3330 \end_inset
3331
3332 to
3333 \begin_inset Quotes erd
3334 \end_inset
3335
3336  means.
3337  GNU 
3338 \begin_inset Flex Code
3339 status collapsed
3340
3341 \begin_layout Plain Layout
3342 gettext
3343 \end_layout
3344
3345 \end_inset
3346
3347  does not handle such ambiguous translations.
3348  Therefore you have to add some context information to the message: Instead
3349  of 
3350 \begin_inset Flex Code
3351 status collapsed
3352
3353 \begin_layout Plain Layout
3354 To
3355 \end_layout
3356
3357 \end_inset
3358
3359  it becomes 
3360 \begin_inset Flex Code
3361 status collapsed
3362
3363 \begin_layout Plain Layout
3364 To[[as in 'From format x to format y']]
3365 \end_layout
3366
3367 \end_inset
3368
3369  and 
3370 \begin_inset Flex Code
3371 status collapsed
3372
3373 \begin_layout Plain Layout
3374 To[[as in 'From page x to page y']].
3375 \end_layout
3376
3377 \end_inset
3378
3379  Now the two occurrences of 
3380 \begin_inset Flex Code
3381 status collapsed
3382
3383 \begin_layout Plain Layout
3384 To
3385 \end_layout
3386
3387 \end_inset
3388
3389  are different for 
3390 \begin_inset Flex Code
3391 status collapsed
3392
3393 \begin_layout Plain Layout
3394 gettext
3395 \end_layout
3396
3397 \end_inset
3398
3399  and can be translated correctly to 
3400 \lang german
3401 Nach
3402 \lang english
3403  and 
3404 \lang german
3405 Bis
3406 \lang english
3407 , respectively.
3408 \end_layout
3409
3410 \begin_layout Standard
3411 Of course the context information needs to be stripped off the original
3412  message when no translation is used.
3413  Therefore you have to put it in double square brackets at the end of the
3414  message (see the example above).
3415  The translation mechanism of \SpecialChar LyX
3416  ensures that everything in double square
3417  brackets at the end of messages is removed before displaying the message.
3418 \end_layout
3419
3420 \begin_layout Subsection
3421 Translating the documentation.
3422 \end_layout
3423
3424 \begin_layout Standard
3425 The online documentation (in the 
3426 \begin_inset Flex Noun
3427 status collapsed
3428
3429 \begin_layout Plain Layout
3430 Help
3431 \end_layout
3432
3433 \end_inset
3434
3435 -menu) can (and should!) be translated.
3436  If there are translated versions of the documentation available
3437 \begin_inset Foot
3438 status collapsed
3439
3440 \begin_layout Plain Layout
3441 As of March 2008, at least some of the documents have been translated into
3442  fourteen languages, with the Tutorial available in a few more.
3443 \end_layout
3444
3445 \end_inset
3446
3447  and the locale is set accordingly, these will be used automagically by
3448  \SpecialChar LyX
3449 .
3450  \SpecialChar LyX
3451  looks for translated versions as 
3452 \begin_inset Flex Code
3453 status collapsed
3454
3455 \begin_layout Plain Layout
3456 LyXDir/doc/xx/DocName.lyx
3457 \end_layout
3458
3459 \end_inset
3460
3461 , where 
3462 \begin_inset Flex Code
3463 status collapsed
3464
3465 \begin_layout Plain Layout
3466 xx
3467 \end_layout
3468
3469 \end_inset
3470
3471  is the code for the language currently in use.
3472  If there are no translated documents, the default English versions will
3473  be displayed.
3474  Note that the translated versions must have the same filenames (
3475 \begin_inset Flex Code
3476 status collapsed
3477
3478 \begin_layout Plain Layout
3479 DocName
3480 \end_layout
3481
3482 \end_inset
3483
3484  above) as the original.
3485  If you feel up to translating the documentation (an excellent way to proof-read
3486  the original documentation by the way!), there are a few things you should
3487  do right away:
3488 \end_layout
3489
3490 \begin_layout Itemize
3491 Check out the documentation translation web page at 
3492 \begin_inset CommandInset href
3493 LatexCommand href
3494 name "http://www.lyx.org/Translation"
3495 target "http://www.lyx.org/Translation"
3496 literal "false"
3497
3498 \end_inset
3499
3500 .
3501  That way, you can find out which (if any) documents have already been translate
3502 d into your language.
3503  You can also find out who (if anyone) is organizing the effort to translate
3504  the documentation into your language.
3505  If no one is organizing the effort, please let us know that you're interested.
3506 \end_layout
3507
3508 \begin_layout Standard
3509 Once you get to actually translating, here's a few hints for you that may
3510  save you trouble:
3511 \end_layout
3512
3513 \begin_layout Itemize
3514 Join the documentation team! There is information on how to do that in 
3515 \begin_inset Flex Code
3516 status collapsed
3517
3518 \begin_layout Plain Layout
3519 Intro.lyx
3520 \end_layout
3521
3522 \end_inset
3523
3524  (
3525 \begin_inset Flex Noun
3526 status collapsed
3527
3528 \begin_layout Plain Layout
3529 Help\SpecialChar menuseparator
3530 Introduction
3531 \end_layout
3532
3533 \end_inset
3534
3535 ), which by the way is the first document you should translate.
3536 \end_layout
3537
3538 \begin_layout Itemize
3539 Learn the typographic conventions for the language you are translating to.
3540  Typography is an ancient art and over the centuries, a great variety of
3541  conventions have developed throughout different parts of the world.
3542  Also study the professional terminology amongst typographers in your country.
3543  Inventing your own terminology will only confuse the users.
3544  
3545 \emph on
3546 (Warning! Typography is addictive!)
3547 \end_layout
3548
3549 \begin_layout Itemize
3550 Make a copy of the document.
3551  This will be your working copy.
3552  You can use this as your personal translated help-file by placing it in
3553  your 
3554 \begin_inset Flex Code
3555 status collapsed
3556
3557 \begin_layout Plain Layout
3558 UserDir/doc/xx/
3559 \end_layout
3560
3561 \end_inset
3562
3563  directory.
3564 \begin_inset Note Greyedout
3565 status open
3566
3567 \begin_layout Plain Layout
3568
3569 \series bold
3570 Note:
3571 \series default
3572  For a complex document with external material (images, etc.), if you make
3573  a copy e.
3574 \begin_inset space \thinspace{}
3575 \end_inset
3576
3577 g.
3578 \begin_inset space \space{}
3579 \end_inset
3580
3581 in a temp dir, beware that the links to external material may be broken
3582  when the document is moved to a different place.
3583  The best way is to retrieve the \SpecialChar LyX
3584  tree from git (see 
3585 \begin_inset Flex URL
3586 status collapsed
3587
3588 \begin_layout Plain Layout
3589
3590 http://www.lyx.org/HowToUseGIT
3591 \end_layout
3592
3593 \end_inset
3594
3595 ) and to edit the doc file in place.
3596 \end_layout
3597
3598 \end_inset
3599
3600
3601 \end_layout
3602
3603 \begin_layout Itemize
3604 Sometimes the original document (from the \SpecialChar LyX
3605  team) will be updated.
3606  Use the source viewer at 
3607 \begin_inset CommandInset href
3608 LatexCommand href
3609 name "http://www.lyx.org/trac/timeline"
3610 target "http://www.lyx.org/trac/timeline"
3611 literal "false"
3612
3613 \end_inset
3614
3615  to see what has been changed.
3616  That way you can easily see which parts of the translated document need
3617  to be updated.
3618 \end_layout
3619
3620 \begin_layout Standard
3621 If you ever find an error in the original document, fix it and notify the
3622  rest of the documentation team of the changes! (You didn't forget to join
3623  the documentation team, did you?)
3624 \end_layout
3625
3626 \begin_layout Standard
3627 \begin_inset Branch OutDated
3628 inverted 0
3629 status collapsed
3630
3631 \begin_layout Section
3632 International Keyboard Support
3633 \end_layout
3634
3635 \begin_layout Standard
3636
3637 \emph on
3638 [Editor's Note: The following section is by
3639 \emph default
3640  
3641 \shape smallcaps
3642 \emph on
3643 Ivan Schreter
3644 \shape default
3645 .
3646  It needs to be fixed to conform to the new Documentation Style sheet and
3647  to make use of the new v1.0 features.
3648  The whole thing also needs to be merged with the section following it.-jw
3649  It may also be badly out of date.-rh (2008)]
3650 \end_layout
3651
3652 \begin_layout Subsection
3653 Defining Own Keymaps: Keymap File Format
3654 \end_layout
3655
3656 \begin_layout Standard
3657 Let's look at a keyboard definition file a little closer.
3658  It is a plain text file defining
3659 \end_layout
3660
3661 \begin_layout Itemize
3662 key-to-key or key-to-string translations
3663 \end_layout
3664
3665 \begin_layout Itemize
3666 dead keys
3667 \end_layout
3668
3669 \begin_layout Itemize
3670 dead keys exceptions
3671 \end_layout
3672
3673 \begin_layout Standard
3674 To define key-to-key or key-to-string translation, use this command:
3675 \end_layout
3676
3677 \begin_layout Quotation
3678 \begin_inset Flex Code
3679 status collapsed
3680
3681 \begin_layout Plain Layout
3682
3683 \backslash
3684 kmap
3685 \end_layout
3686
3687 \end_inset
3688
3689  
3690 \begin_inset Flex Code
3691 status collapsed
3692
3693 \begin_layout Plain Layout
3694 key
3695 \end_layout
3696
3697 \end_inset
3698
3699  outstring 
3700 \end_layout
3701
3702 \begin_layout Standard
3703 where 
3704 \begin_inset Flex Code
3705 status collapsed
3706
3707 \begin_layout Plain Layout
3708 key
3709 \end_layout
3710
3711 \end_inset
3712
3713  is the key to be translated and 
3714 \begin_inset Flex Code
3715 status collapsed
3716
3717 \begin_layout Plain Layout
3718 outstring
3719 \end_layout
3720
3721 \end_inset
3722
3723  is the string to be inserted into the document.
3724  To define dead keys, use:
3725 \end_layout
3726
3727 \begin_layout Quotation
3728 \begin_inset Flex Code
3729 status collapsed
3730
3731 \begin_layout Plain Layout
3732
3733 \backslash
3734 kmod
3735 \end_layout
3736
3737 \end_inset
3738
3739  
3740 \begin_inset Flex Code
3741 status collapsed
3742
3743 \begin_layout Plain Layout
3744 key
3745 \end_layout
3746
3747 \end_inset
3748
3749  deadkey
3750 \end_layout
3751
3752 \begin_layout Standard
3753 where 
3754 \begin_inset Flex Code
3755 status collapsed
3756
3757 \begin_layout Plain Layout
3758 key
3759 \end_layout
3760
3761 \end_inset
3762
3763  is a keyboard key and 
3764 \begin_inset Flex Code
3765 status collapsed
3766
3767 \begin_layout Plain Layout
3768 deadkey
3769 \end_layout
3770
3771 \end_inset
3772
3773  is dead key name.
3774  The following dead keys are supported (shortcut name is in parentheses):
3775 \end_layout
3776
3777 \begin_layout Quotation
3778
3779 \emph on
3780 Name
3781 \begin_inset space \hfill{}
3782 \end_inset
3783
3784 Example
3785 \end_layout
3786
3787 \begin_layout Quotation
3788 acute (acu)
3789 \begin_inset space \hfill{}
3790 \end_inset
3791
3792 áéíóú
3793 \end_layout
3794
3795 \begin_layout Quotation
3796 grave (gra)
3797 \begin_inset space \hfill{}
3798 \end_inset
3799
3800 àèìòù
3801 \end_layout
3802
3803 \begin_layout Quotation
3804 macron (mac)
3805 \begin_inset space \hfill{}
3806 \end_inset
3807
3808  ō
3809 \end_layout
3810
3811 \begin_layout Quotation
3812 tilde (til)
3813 \begin_inset space \hfill{}
3814 \end_inset
3815
3816 ñÑ
3817 \end_layout
3818
3819 \begin_layout Quotation
3820 underbar (underb)
3821 \begin_inset space \hfill{}
3822 \end_inset
3823
3824
3825 \begin_inset ERT
3826 status open
3827
3828 \begin_layout Plain Layout
3829
3830
3831 \backslash
3832 b o
3833 \end_layout
3834
3835 \end_inset
3836
3837
3838 \end_layout
3839
3840 \begin_layout Quotation
3841 cedilla (ced)
3842 \begin_inset space \hfill{}
3843 \end_inset
3844
3845 çÇ
3846 \end_layout
3847
3848 \begin_layout Quotation
3849 underdot (underd)
3850 \begin_inset space \hfill{}
3851 \end_inset
3852
3853
3854 \begin_inset ERT
3855 status open
3856
3857 \begin_layout Plain Layout
3858
3859
3860 \backslash
3861 d o
3862 \end_layout
3863
3864 \end_inset
3865
3866
3867 \end_layout
3868
3869 \begin_layout Quotation
3870 circumflex (circu)
3871 \begin_inset space \hfill{}
3872 \end_inset
3873
3874 âêîôû
3875 \end_layout
3876
3877 \begin_layout Quotation
3878 circle (circl)
3879 \begin_inset space \hfill{}
3880 \end_inset
3881
3882 ÅůŮ
3883 \end_layout
3884
3885 \begin_layout Quotation
3886 tie (tie)
3887 \begin_inset space \hfill{}
3888 \end_inset
3889
3890
3891 \begin_inset ERT
3892 status open
3893
3894 \begin_layout Plain Layout
3895
3896
3897 \backslash
3898 t o
3899 \end_layout
3900
3901 \end_inset
3902
3903
3904 \end_layout
3905
3906 \begin_layout Quotation
3907 breve (bre)
3908 \begin_inset space \hfill{}
3909 \end_inset
3910
3911 ă
3912 \begin_inset ERT
3913 status open
3914
3915 \begin_layout Plain Layout
3916
3917
3918 \backslash
3919 u o
3920 \end_layout
3921
3922 \end_inset
3923
3924
3925 \end_layout
3926
3927 \begin_layout Quotation
3928 caron (car)
3929 \begin_inset space \hfill{}
3930 \end_inset
3931
3932 čšž
3933 \end_layout
3934
3935 \begin_layout Quotation
3936 hungarian umlaut (hug)
3937 \begin_inset space \hfill{}
3938 \end_inset
3939
3940 őű
3941 \end_layout
3942
3943 \begin_layout Quotation
3944 umlaut (uml)
3945 \begin_inset space \hfill{}
3946 \end_inset
3947
3948 äöü
3949 \end_layout
3950
3951 \begin_layout Quotation
3952 dot (dot)
3953 \begin_inset space \hfill{}
3954 \end_inset
3955
3956 ż
3957 \begin_inset ERT
3958 status open
3959
3960 \begin_layout Plain Layout
3961
3962
3963 \backslash
3964 .s
3965 \end_layout
3966
3967 \end_inset
3968
3969
3970 \end_layout
3971
3972 \begin_layout Standard
3973 Since in many international keyboards there are exceptions to what some
3974  dead keys should do, you can define them using
3975 \end_layout
3976
3977 \begin_layout Quotation
3978 \begin_inset Flex Code
3979 status collapsed
3980
3981 \begin_layout Plain Layout
3982
3983 \backslash
3984 kxmod
3985 \end_layout
3986
3987 \end_inset
3988
3989  deadkey key outstring
3990 \end_layout
3991
3992 \begin_layout Standard
3993 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3994 , so you put in
3995 \end_layout
3996
3997 \begin_layout Quotation
3998 \begin_inset Flex Code
3999 status collapsed
4000
4001 \begin_layout Plain Layout
4002
4003 \backslash
4004 kxmod
4005 \end_layout
4006
4007 \end_inset
4008
4009  caron o "
4010 \backslash
4011 ^o"
4012 \end_layout
4013
4014 \begin_layout Standard
4015 to make it work correctly.
4016  Also, you have to define as exceptions dead keys over i and j, to remove
4017  the dot from them before inserting an accent mark.
4018  I will change this when the time comes, but so far I haven't had time.
4019 \end_layout
4020
4021 \begin_layout Standard
4022 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4023  double backslash.
4024  Also, quotes and 
4025 \begin_inset Flex Code
4026 status collapsed
4027
4028 \begin_layout Plain Layout
4029 #
4030 \end_layout
4031
4032 \end_inset
4033
4034  have different meaning.
4035  
4036 \begin_inset Flex Code
4037 status collapsed
4038
4039 \begin_layout Plain Layout
4040 #
4041 \end_layout
4042
4043 \end_inset
4044
4045  marks comments, quotes start and end \SpecialChar LaTeX
4046 -style commands.
4047  To enter quote, you'll need to use 
4048 \begin_inset Flex Code
4049 status collapsed
4050
4051 \begin_layout Plain Layout
4052
4053 \backslash
4054 "
4055 \end_layout
4056
4057 \end_inset
4058
4059 , to enter 
4060 \begin_inset Flex Code
4061 status collapsed
4062
4063 \begin_layout Plain Layout
4064 #
4065 \end_layout
4066
4067 \end_inset
4068
4069 , use 
4070 \begin_inset Flex Code
4071 status collapsed
4072
4073 \begin_layout Plain Layout
4074
4075 \backslash
4076 #
4077 \end_layout
4078
4079 \end_inset
4080
4081 .
4082 \end_layout
4083
4084 \begin_layout Standard
4085 If you make a keyboard description file that works for your language, please
4086  mail it to me, so I can include it in the next keymap distribution.
4087 \end_layout
4088
4089 \begin_layout Standard
4090 More keywords will be supported in keymap configuration file in future,
4091  like
4092 \end_layout
4093
4094 \begin_layout Itemize
4095 \begin_inset Flex Code
4096 status collapsed
4097
4098 \begin_layout Plain Layout
4099
4100 \backslash
4101 kinclude filename
4102 \end_layout
4103
4104 \end_inset
4105
4106
4107 \emph on
4108
4109 \begin_inset space \hfill{}
4110 \end_inset
4111
4112
4113 \begin_inset Flex Code
4114 status collapsed
4115
4116 \begin_layout Plain Layout
4117 include
4118 \end_layout
4119
4120 \end_inset
4121
4122  another file
4123 \end_layout
4124
4125 \begin_layout Itemize
4126 \begin_inset Flex Code
4127 status collapsed
4128
4129 \begin_layout Plain Layout
4130
4131 \backslash
4132 kprog program
4133 \end_layout
4134
4135 \end_inset
4136
4137
4138 \emph on
4139
4140 \begin_inset space \hfill{}
4141 \end_inset
4142
4143
4144 \begin_inset Flex Code
4145 status collapsed
4146
4147 \begin_layout Plain Layout
4148 define
4149 \end_layout
4150
4151 \end_inset
4152
4153  an external keymap translation program 
4154 \end_layout
4155
4156 \begin_layout Standard
4157 Also, it should look into 
4158 \begin_inset Flex Code
4159 status collapsed
4160
4161 \begin_layout Plain Layout
4162 lyxrc
4163 \end_layout
4164
4165 \end_inset
4166
4167  file for defaults, too (for example, a 
4168 \begin_inset Flex Code
4169 status collapsed
4170
4171 \begin_layout Plain Layout
4172
4173 \backslash
4174 kinclude
4175 \end_layout
4176
4177 \end_inset
4178
4179  option to include default keyboard).
4180 \end_layout
4181
4182 \end_inset
4183
4184
4185 \end_layout
4186
4187 \begin_layout Section
4188 International Keymap Stuff
4189 \begin_inset CommandInset label
4190 LatexCommand label
4191 name "sec:International-Keymap-Stuff"
4192
4193 \end_inset
4194
4195
4196 \end_layout
4197
4198 \begin_layout Standard
4199 \begin_inset Note Note
4200 status open
4201
4202 \begin_layout Plain Layout
4203 In doing the revisions on this document in March 2008, I did not look over
4204  this stuff, as I do not understand it.
4205  It would be good if someone else could do so.
4206  (RH)
4207 \end_layout
4208
4209 \end_inset
4210
4211
4212 \end_layout
4213
4214 \begin_layout Standard
4215 The next two sections describe the 
4216 \begin_inset Flex Code
4217 status collapsed
4218
4219 \begin_layout Plain Layout
4220
4221 \shape up
4222 .kmap
4223 \end_layout
4224
4225 \end_inset
4226
4227  and 
4228 \begin_inset Flex Code
4229 status collapsed
4230
4231 \begin_layout Plain Layout
4232
4233 \shape up
4234 .cdef
4235 \end_layout
4236
4237 \end_inset
4238
4239  file syntax in detail.
4240  These sections should help you design your own key map if the ones provided
4241  do not meet your needs.
4242 \end_layout
4243
4244 \begin_layout Subsection
4245 The .kmap File
4246 \end_layout
4247
4248 \begin_layout Standard
4249
4250 \shape up
4251 .
4252 \begin_inset Flex Code
4253 status collapsed
4254
4255 \begin_layout Plain Layout
4256 kmap
4257 \end_layout
4258
4259 \end_inset
4260
4261  file maps keystrokes to characters or strings.
4262  As the name suggests, it sets a keyboard mapping.
4263  The 
4264 \begin_inset Flex Code
4265 status collapsed
4266
4267 \begin_layout Plain Layout
4268 .kmap
4269 \end_layout
4270
4271 \end_inset
4272
4273
4274 \shape default
4275  file keywords 
4276 \shape up
4277
4278 \begin_inset Flex Code
4279 status collapsed
4280
4281 \begin_layout Plain Layout
4282
4283 \shape up
4284 kmap
4285 \end_layout
4286
4287 \end_inset
4288
4289
4290 \shape default
4291 ,
4292 \shape up
4293  
4294 \shape default
4295
4296 \begin_inset Flex Code
4297 status collapsed
4298
4299 \begin_layout Plain Layout
4300
4301 \shape up
4302 kmod
4303 \end_layout
4304
4305 \end_inset
4306
4307 ,
4308 \shape up
4309  
4310 \shape default
4311
4312 \begin_inset Flex Code
4313 status collapsed
4314
4315 \begin_layout Plain Layout
4316
4317 \shape up
4318 kxmod
4319 \end_layout
4320
4321 \end_inset
4322
4323 , and 
4324 \begin_inset Flex Code
4325 status collapsed
4326
4327 \begin_layout Plain Layout
4328
4329 \shape up
4330 kcomb
4331 \end_layout
4332
4333 \end_inset
4334
4335  are described in this section.
4336 \end_layout
4337
4338 \begin_layout Labeling
4339 \labelwidthstring 00.00.0000
4340 \begin_inset Flex Code
4341 status collapsed
4342
4343 \begin_layout Plain Layout
4344
4345 \shape up
4346 kmap
4347 \end_layout
4348
4349 \end_inset
4350
4351  Map a character to a string
4352 \end_layout
4353
4354 \begin_layout LyX-Code
4355
4356 \backslash
4357 kmap 
4358 \family roman
4359 \emph on
4360 char
4361 \family default
4362 \emph default
4363  
4364 \family roman
4365 \emph on
4366 string
4367 \end_layout
4368
4369 \begin_layout Standard
4370 This will ma
4371 \family roman
4372 p
4373 \family default
4374  
4375 \family roman
4376 \emph on
4377 char
4378 \family default
4379 \emph default
4380  
4381 \family roman
4382 to
4383 \family default
4384  
4385 \family roman
4386 \emph on
4387 string
4388 \emph default
4389 .
4390  Note that in
4391 \family default
4392  
4393 \family roman
4394 \emph on
4395 string
4396 \emph default
4397 ,
4398 \family default
4399  
4400 \family roman
4401 \shape up
4402 the double-quote (")
4403 \family default
4404 \shape default
4405  
4406 \family roman
4407 and
4408 \family default
4409  
4410 \family roman
4411 \shape up
4412 the backslash (
4413 \backslash
4414 )
4415 \family default
4416 \shape default
4417  
4418 \family roman
4419 must be escaped with a preceding backslash (
4420 \shape up
4421
4422 \backslash
4423
4424 \shape default
4425 )
4426 \family default
4427 .
4428 \end_layout
4429
4430 \begin_layout Standard
4431 An example of a 
4432 \begin_inset Flex Noun
4433 status collapsed
4434
4435 \begin_layout Plain Layout
4436
4437 \shape up
4438 kmap
4439 \end_layout
4440
4441 \end_inset
4442
4443  statement to cause the symbol 
4444 \begin_inset Flex Noun
4445 status collapsed
4446
4447 \begin_layout Plain Layout
4448
4449 \shape up
4450 /
4451 \end_layout
4452
4453 \end_inset
4454
4455  to be output for the keystroke 
4456 \begin_inset Flex Noun
4457 status collapsed
4458
4459 \begin_layout Plain Layout
4460
4461 \shape up
4462 &
4463 \end_layout
4464
4465 \end_inset
4466
4467  is:
4468 \end_layout
4469
4470 \begin_layout LyX-Code
4471
4472 \backslash
4473 kmap & /
4474 \end_layout
4475
4476 \begin_layout Labeling
4477 \labelwidthstring 00.00.0000
4478 \begin_inset Flex Code
4479 status collapsed
4480
4481 \begin_layout Plain Layout
4482
4483 \shape up
4484 kmod
4485 \end_layout
4486
4487 \end_inset
4488
4489  Specify an accent character
4490 \end_layout
4491
4492 \begin_layout LyX-Code
4493
4494 \backslash
4495 kmod 
4496 \family roman
4497 \emph on
4498 char accent allowed
4499 \end_layout
4500
4501 \begin_layout Standard
4502 This will make the cha
4503 \family roman
4504 racter
4505 \family default
4506  
4507 \family roman
4508 \emph on
4509 char
4510 \family default
4511 \emph default
4512  
4513 \family roman
4514 \shape up
4515 \emph on
4516 be an accent
4517 \family default
4518 \shape default
4519 \emph default
4520  
4521 \family roman
4522 \shape up
4523 on the
4524 \family default
4525 \shape default
4526  
4527 \family roman
4528 \shape up
4529 \emph on
4530 allowed
4531 \family default
4532 \shape default
4533 \emph default
4534  
4535 \family roman
4536 \shape up
4537 cha
4538 \family default
4539 racter(s).
4540  This is the dead key
4541 \begin_inset Foot
4542 status collapsed
4543
4544 \begin_layout Plain Layout
4545 The term 
4546 \family roman
4547 \emph on
4548 dead key
4549 \family default
4550 \emph default
4551  refers to a key that does not produce a character by itself, but when followed
4552  with another key, produces the desired accent character.
4553  For example, a German characte
4554 \family roman
4555 r with an umlaut like
4556 \family default
4557  
4558 \family roman
4559 \emph on
4560 ä
4561 \family default
4562 \emph default
4563  
4564 \family roman
4565 can be produced in this manner.
4566 \end_layout
4567
4568 \end_inset
4569
4570  mechanism.
4571  
4572 \end_layout
4573
4574 \begin_layout Standard
4575 If you 
4576 \family roman
4577 hit
4578 \family default
4579  
4580 \family roman
4581 \emph on
4582 char
4583 \family default
4584 \emph default
4585  
4586 \family roman
4587 and then another key not in
4588 \family default
4589  
4590 \family roman
4591 \emph on
4592 allowed
4593 \emph default
4594 , you will get a
4595 \family default
4596  
4597 \family roman
4598 \emph on
4599 char
4600 \family default
4601 \emph default
4602  
4603 \family roman
4604 followed by the other, not allowed key, as output.
4605
4606 \family default
4607  Note that a 
4608 \begin_inset Flex Noun
4609 status collapsed
4610
4611 \begin_layout Plain Layout
4612
4613 \shape up
4614 Backspace
4615 \end_layout
4616
4617 \end_inset
4618
4619  cancels a dead key, so if 
4620 \family roman
4621 you hit
4622 \family default
4623  
4624 \family roman
4625 \emph on
4626 char
4627 \family default
4628 \emph default
4629  
4630 \begin_inset Flex Noun
4631 status collapsed
4632
4633 \begin_layout Plain Layout
4634
4635 \shape up
4636 \emph on
4637 Backspace
4638 \end_layout
4639
4640 \end_inset
4641
4642 , the cursor will not go one position backwards but will instead cancel
4643  the effect t
4644 \family roman
4645 hat
4646 \family default
4647  
4648 \family roman
4649 \shape up
4650 \emph on
4651 char
4652 \family default
4653 \shape default
4654 \emph default
4655  
4656 \family roman
4657 \shape up
4658 might have had on the next keystroke.
4659  
4660 \end_layout
4661
4662 \begin_layout Standard
4663 The following example specifies that the character ' is to be an acute accent,
4664  allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4665 \end_layout
4666
4667 \begin_layout LyX-Code
4668
4669 \backslash
4670 kmod ' acute aeiouAEIOU
4671 \end_layout
4672
4673 \begin_layout Labeling
4674 \labelwidthstring 00.00.0000
4675 \begin_inset Flex Code
4676 status collapsed
4677
4678 \begin_layout Plain Layout
4679 kxmod
4680 \end_layout
4681
4682 \end_inset
4683
4684  Specify an exception to the accent character
4685 \end_layout
4686
4687 \begin_layout LyX-Code
4688
4689 \backslash
4690 kxmod  
4691 \family roman
4692 \emph on
4693 accent char result
4694 \end_layout
4695
4696 \begin_layout Standard
4697 This defines an exce
4698 \family roman
4699 ption for
4700 \family default
4701  
4702 \family roman
4703 \emph on
4704 accent
4705 \family default
4706 \emph default
4707  
4708 \family roman
4709 on
4710 \family default
4711  
4712 \family roman
4713 \emph on
4714 char
4715 \emph default
4716 .
4717  T
4718 \shape up
4719 he
4720 \family default
4721 \shape default
4722  
4723 \family roman
4724 \shape up
4725 \emph on
4726 accent
4727 \family default
4728 \shape default
4729 \emph default
4730  
4731 \family roman
4732 \shape up
4733 must
4734 \family default
4735 \shape default
4736  
4737 \shape up
4738 have been assigned a keystroke with a previous
4739 \shape default
4740  
4741 \begin_inset Flex Code
4742 status collapsed
4743
4744 \begin_layout Plain Layout
4745
4746 \shape up
4747
4748 \backslash
4749 kmo
4750 \shape default
4751 d
4752 \end_layout
4753
4754 \end_inset
4755
4756  declar
4757 \family roman
4758 ation and
4759 \family default
4760  
4761 \family roman
4762 \emph on
4763 char
4764 \family default
4765 \emph default
4766  
4767 \family roman
4768 must not belong in the
4769 \family default
4770  
4771 \family roman
4772 \emph on
4773 allowed
4774 \family default
4775 \emph default
4776  
4777 \family roman
4778 set of
4779 \family default
4780  
4781 \family roman
4782 \emph on
4783 accent
4784 \emph default
4785 .
4786  When
4787 \family default
4788  
4789 \family roman
4790 \shape up
4791 you enter the
4792 \family default
4793 \shape default
4794  
4795 \family roman
4796 \shape up
4797 \emph on
4798 accent char
4799 \family default
4800 \shape default
4801 \emph default
4802  
4803 \family roman
4804 \shape up
4805 sequence,
4806 \family default
4807 \shape default
4808  
4809 \family roman
4810 \shape up
4811 \emph on
4812 result
4813 \emph default
4814  is produced.
4815  If such a declaration does not exist in
4816 \family default
4817 \shape default
4818  
4819 \shape up
4820 the
4821 \shape default
4822  
4823 \begin_inset Flex Code
4824 status collapsed
4825
4826 \begin_layout Plain Layout
4827
4828 \shape up
4829 .kmap
4830 \end_layout
4831
4832 \end_inset
4833
4834  file and yo
4835 \family roman
4836 u enter
4837 \family default
4838  
4839 \family roman
4840 \emph on
4841 accent char
4842 \emph default
4843 , you get
4844 \family default
4845  
4846 \family roman
4847 \emph on
4848 accent_key char
4849 \emph default
4850  where
4851 \family default
4852  
4853 \family roman
4854 \emph on
4855 accent_key
4856 \emph default
4857  is the first arg
4858 \family default
4859 ument of the 
4860 \begin_inset Flex Code
4861 status collapsed
4862
4863 \begin_layout Plain Layout
4864
4865 \shape up
4866
4867 \backslash
4868 kmod
4869 \end_layout
4870
4871 \end_inset
4872
4873  declaration.
4874  
4875 \end_layout
4876
4877 \begin_layout Standard
4878 The following command produces causes äi to be produced when you enter acute-i
4879  ('i):
4880 \end_layout
4881
4882 \begin_layout LyX-Code
4883
4884 \backslash
4885 kxmod acute i "
4886 \backslash
4887
4888 \backslash
4889 '{
4890 \backslash
4891
4892 \backslash
4893 i}"
4894 \end_layout
4895
4896 \begin_layout Labeling
4897 \labelwidthstring 00.00.0000
4898 \begin_inset Flex Code
4899 status collapsed
4900
4901 \begin_layout Plain Layout
4902 kcomb
4903 \end_layout
4904
4905 \end_inset
4906
4907  Combine two accent characters
4908 \end_layout
4909
4910 \begin_layout LyX-Code
4911
4912 \backslash
4913 kcomb 
4914 \family roman
4915 \emph on
4916 accent1 accent2 allowed
4917 \end_layout
4918
4919 \begin_layout Standard
4920 This one is getting pretty esoteric.
4921  It allows you to combine the effect 
4922 \family roman
4923 of
4924 \family default
4925  
4926 \family roman
4927 \emph on
4928 accent1
4929 \family default
4930 \emph default
4931  
4932 \family roman
4933 and
4934 \family default
4935  
4936 \family roman
4937 \emph on
4938 accent2
4939 \family default
4940 \emph default
4941  
4942 \family roman
4943 (in that order!) on
4944 \family default
4945  
4946 \family roman
4947 \emph on
4948 allowed
4949 \family default
4950 \emph default
4951  
4952 \family roman
4953 chars.
4954  The keystrokes for
4955 \family default
4956  
4957 \family roman
4958 \emph on
4959 accent1
4960 \family default
4961 \emph default
4962  
4963 \family roman
4964 and
4965 \family default
4966  
4967 \family roman
4968 \emph on
4969 accent2
4970 \family default
4971 \emph default
4972  
4973 \family roman
4974 must have be
4975 \family default
4976 en set with a 
4977 \begin_inset Flex Code
4978 status collapsed
4979
4980 \begin_layout Plain Layout
4981
4982 \shape up
4983
4984 \backslash
4985 kmod
4986 \end_layout
4987
4988 \end_inset
4989
4990  command at 
4991 \family roman
4992 a
4993 \family default
4994  
4995 \family roman
4996 \emph on
4997 previous
4998 \family default
4999 \emph default
5000  
5001 \family roman
5002 point in the
5003 \family default
5004  file.
5005  
5006 \end_layout
5007
5008 \begin_layout Standard
5009 Consider this example from the 
5010 \begin_inset Flex Code
5011 status collapsed
5012
5013 \begin_layout Plain Layout
5014
5015 \shape up
5016 greek.kmap
5017 \end_layout
5018
5019 \end_inset
5020
5021  file:
5022 \end_layout
5023
5024 \begin_layout LyX-Code
5025
5026 \backslash
5027 kmod ; acute aeioyvhAEIOYVH 
5028 \backslash
5029 kmod : umlaut iyIY 
5030 \backslash
5031 kcomb acute umlaut iyIY
5032 \end_layout
5033
5034 \begin_layout Standard
5035 This allows you to press 
5036 \begin_inset Flex Noun
5037 status collapsed
5038
5039 \begin_layout Plain Layout
5040
5041 \shape up
5042 ;:i
5043 \end_layout
5044
5045 \end_inset
5046
5047  and get the effect of 
5048 \begin_inset Flex Code
5049 status collapsed
5050
5051 \begin_layout Plain Layout
5052
5053 \shape up
5054
5055 \backslash
5056 '{
5057 \backslash
5058 "{i}}
5059 \end_layout
5060
5061 \end_inset
5062
5063 .
5064  
5065 \family roman
5066 \shape up
5067 A backspace
5068 \family default
5069 \shape default
5070  in this case cancels the last dead key, so if you press 
5071 \begin_inset Flex Noun
5072 status collapsed
5073
5074 \begin_layout Plain Layout
5075
5076 \shape up
5077 ;: Backspace i
5078 \end_layout
5079
5080 \end_inset
5081
5082  you get 
5083 \begin_inset Flex Code
5084 status collapsed
5085
5086 \begin_layout Plain Layout
5087
5088 \shape up
5089
5090 \backslash
5091 '{i}
5092 \end_layout
5093
5094 \end_inset
5095
5096 .
5097 \end_layout
5098
5099 \begin_layout Subsection
5100 The .cdef File
5101 \end_layout
5102
5103 \begin_layout Standard
5104 After the 
5105 \begin_inset Flex Code
5106 status collapsed
5107
5108 \begin_layout Plain Layout
5109
5110 \shape up
5111 .kmap
5112 \end_layout
5113
5114 \end_inset
5115
5116  mapping is performed, a 
5117 \begin_inset Flex Code
5118 status collapsed
5119
5120 \begin_layout Plain Layout
5121
5122 \shape up
5123 .cde
5124 \shape default
5125 f
5126 \end_layout
5127
5128 \end_inset
5129
5130  file maps the strings that the symbols generate to characters in the current
5131  font.
5132  The \SpecialChar LyX
5133  distribution currently includes at least the 
5134 \begin_inset Flex Code
5135 status collapsed
5136
5137 \begin_layout Plain Layout
5138
5139 \shape up
5140 iso8859-1.cdef
5141 \end_layout
5142
5143 \end_inset
5144
5145  and 
5146 \begin_inset Flex Code
5147 status collapsed
5148
5149 \begin_layout Plain Layout
5150
5151 \shape up
5152 iso8859-2.cdef
5153 \end_layout
5154
5155 \end_inset
5156
5157  files.
5158 \end_layout
5159
5160 \begin_layout Standard
5161 In general the 
5162 \begin_inset Flex Code
5163 status collapsed
5164
5165 \begin_layout Plain Layout
5166
5167 \shape up
5168 .cdef
5169 \end_layout
5170
5171 \end_inset
5172
5173  file is a sequence of declarations of the form
5174 \end_layout
5175
5176 \begin_layout LyX-Code
5177
5178 \family roman
5179 \emph on
5180 char_index_in_set
5181 \family default
5182 \emph default
5183  
5184 \family roman
5185 \emph on
5186  string
5187 \end_layout
5188
5189 \begin_layout Standard
5190 For example, in order to map 
5191 \begin_inset Flex Noun
5192 status collapsed
5193
5194 \begin_layout Plain Layout
5195
5196 \shape up
5197
5198 \backslash
5199 '{e}
5200 \end_layout
5201
5202 \end_inset
5203
5204  to the corresponding character in the iso-8859-1 set (233), the following
5205  declaration is used
5206 \end_layout
5207
5208 \begin_layout LyX-Code
5209 233 "
5210 \backslash
5211
5212 \backslash
5213 '{e}"
5214 \end_layout
5215
5216 \begin_layout Standard
5217 with 
5218 \begin_inset Flex Code
5219 status collapsed
5220
5221 \begin_layout Plain Layout
5222
5223 \backslash
5224
5225 \end_layout
5226
5227 \end_inset
5228
5229  and 
5230 \begin_inset Flex Code
5231 status collapsed
5232
5233 \begin_layout Plain Layout
5234 "
5235 \end_layout
5236
5237 \end_inset
5238
5239  being escap
5240 \family roman
5241 ed in
5242 \family default
5243  
5244 \family roman
5245 \emph on
5246 string
5247 \emph default
5248 .
5249  Note that
5250 \family default
5251  the same character can apply to more than one string.
5252  In the 
5253 \begin_inset Flex Code
5254 status collapsed
5255
5256 \begin_layout Plain Layout
5257 i
5258 \shape up
5259 so-8859-7.cdef
5260 \end_layout
5261
5262 \end_inset
5263
5264  file you have
5265 \end_layout
5266
5267 \begin_layout LyX-Code
5268 192 "
5269 \backslash
5270
5271 \backslash
5272 '{
5273 \backslash
5274
5275 \backslash
5276
5277 \backslash
5278 "{i}}"
5279 \begin_inset Newline newline
5280 \end_inset
5281
5282 192 "
5283 \backslash
5284
5285 \backslash
5286
5287 \backslash
5288 "{
5289 \backslash
5290
5291 \backslash
5292 '{i}}"
5293 \end_layout
5294
5295 \begin_layout Standard
5296 If \SpecialChar LyX
5297  cannot find a mapping for the string produced by the keystroke or a
5298  deadkey sequence, it will check if it looks like an accented char and try
5299  to draw an accent over the character on screen.
5300 \end_layout
5301
5302 \begin_layout Subsection
5303 Dead Keys
5304 \end_layout
5305
5306 \begin_layout Standard
5307 There is a second way to add support for international characters through
5308  so-called dead-keys.
5309  A dead-key works in combination with a letter to produce an accented character.
5310  Here, we'll explain how to create a really simple dead-key to illustrate
5311  how they work.
5312 \end_layout
5313
5314 \begin_layout Standard
5315 Suppose you happen to need the circumflex character, 
5316 \begin_inset Quotes eld
5317 \end_inset
5318
5319  ̂
5320 \begin_inset Quotes erd
5321 \end_inset
5322
5323 .
5324  You could bind the 
5325 \begin_inset Flex Noun
5326 status collapsed
5327
5328 \begin_layout Plain Layout
5329 ^
5330 \end_layout
5331
5332 \end_inset
5333
5334 -key [a.k.a.
5335 \begin_inset space ~
5336 \end_inset
5337
5338
5339 \begin_inset Flex Noun
5340 status collapsed
5341
5342 \begin_layout Plain Layout
5343 Shift-6
5344 \end_layout
5345
5346 \end_inset
5347
5348 ] to the \SpecialChar LyX
5349  command 
5350 \begin_inset Flex Code
5351 status collapsed
5352
5353 \begin_layout Plain Layout
5354 accent-circumflex
5355 \end_layout
5356
5357 \end_inset
5358
5359  in your 
5360 \begin_inset Flex Code
5361 status collapsed
5362
5363 \begin_layout Plain Layout
5364 lyxrc
5365 \end_layout
5366
5367 \end_inset
5368
5369  file.
5370  Now, whenever you type the 
5371 \begin_inset Flex Noun
5372 status collapsed
5373
5374 \begin_layout Plain Layout
5375 ^
5376 \end_layout
5377
5378 \end_inset
5379
5380 -key followed by a letter, that letter will have a circumflex accent on
5381  it.
5382  For example, the sequence 
5383 \begin_inset Quotes eld
5384 \end_inset
5385
5386
5387 \begin_inset Flex Noun
5388 status collapsed
5389
5390 \begin_layout Plain Layout
5391 ^e
5392 \end_layout
5393
5394 \end_inset
5395
5396
5397 \begin_inset Quotes erd
5398 \end_inset
5399
5400  produces the letter: 
5401 \begin_inset Quotes eld
5402 \end_inset
5403
5404 ê
5405 \begin_inset Quotes erd
5406 \end_inset
5407
5408 .
5409  If you tried to type 
5410 \begin_inset Quotes eld
5411 \end_inset
5412
5413
5414 \begin_inset Flex Noun
5415 status collapsed
5416
5417 \begin_layout Plain Layout
5418 ^t
5419 \end_layout
5420
5421 \end_inset
5422
5423
5424 \begin_inset Quotes erd
5425 \end_inset
5426
5427 , however, \SpecialChar LyX
5428  will complain with a beep, since a 
5429 \begin_inset Quotes eld
5430 \end_inset
5431
5432
5433 \begin_inset Flex Noun
5434 status collapsed
5435
5436 \begin_layout Plain Layout
5437 t
5438 \end_layout
5439
5440 \end_inset
5441
5442
5443 \begin_inset Quotes erd
5444 \end_inset
5445
5446  never takes a circumflex accent.
5447  Hitting 
5448 \begin_inset Flex Noun
5449 status collapsed
5450
5451 \begin_layout Plain Layout
5452 Space
5453 \end_layout
5454
5455 \end_inset
5456
5457  after a dead-key produces the bare-accent.
5458  Please note this last point! If you bind a key to a dead-key, you'll need
5459  to rebind the character on that key to yet another key.
5460  Binding the 
5461 \begin_inset Flex Noun
5462 status collapsed
5463
5464 \begin_layout Plain Layout
5465 ,-key
5466 \end_layout
5467
5468 \end_inset
5469
5470  to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5471 \end_layout
5472
5473 \begin_layout Standard
5474 One common way to bind dead-keys is to use 
5475 \begin_inset Flex Noun
5476 status collapsed
5477
5478 \begin_layout Plain Layout
5479 Meta-
5480 \end_layout
5481
5482 \end_inset
5483
5484
5485 \begin_inset Flex Noun
5486 status collapsed
5487
5488 \begin_layout Plain Layout
5489 Ctrl-
5490 \end_layout
5491
5492 \end_inset
5493
5494 , and 
5495 \begin_inset Flex Noun
5496 status collapsed
5497
5498 \begin_layout Plain Layout
5499 Shift-
5500 \end_layout
5501
5502 \end_inset
5503
5504  in combination with an accent, like 
5505 \begin_inset Quotes eld
5506 \end_inset
5507
5508
5509 \begin_inset Flex Noun
5510 status collapsed
5511
5512 \begin_layout Plain Layout
5513 ~
5514 \end_layout
5515
5516 \end_inset
5517
5518
5519 \begin_inset Quotes erd
5520 \end_inset
5521
5522  or 
5523 \begin_inset Quotes eld
5524 \end_inset
5525
5526
5527 \begin_inset Flex Noun
5528 status collapsed
5529
5530 \begin_layout Plain Layout
5531 ,
5532 \end_layout
5533
5534 \end_inset
5535
5536
5537 \begin_inset Quotes erd
5538 \end_inset
5539
5540  or 
5541 \begin_inset Quotes eld
5542 \end_inset
5543
5544
5545 \begin_inset Flex Noun
5546 status collapsed
5547
5548 \begin_layout Plain Layout
5549 ^
5550 \end_layout
5551
5552 \end_inset
5553
5554
5555 \begin_inset Quotes erd
5556 \end_inset
5557
5558 .
5559  Another way involves using 
5560 \begin_inset Flex Code
5561 status collapsed
5562
5563 \begin_layout Plain Layout
5564 xmodmap
5565 \end_layout
5566
5567 \end_inset
5568
5569  and 
5570 \begin_inset Flex Code
5571 status collapsed
5572
5573 \begin_layout Plain Layout
5574 xkeycaps
5575 \end_layout
5576
5577 \end_inset
5578
5579  to set up the special 
5580 \begin_inset Flex Code
5581 status collapsed
5582
5583 \begin_layout Plain Layout
5584 Mode_Switch
5585 \end_layout
5586
5587 \end_inset
5588
5589  key.
5590  The 
5591 \begin_inset Flex Code
5592 status collapsed
5593
5594 \begin_layout Plain Layout
5595 Mode_Switch
5596 \end_layout
5597
5598 \end_inset
5599
5600  acts in some ways just like 
5601 \begin_inset Flex Noun
5602 status collapsed
5603
5604 \begin_layout Plain Layout
5605 Shift
5606 \end_layout
5607
5608 \end_inset
5609
5610  and permits you to bind keys to accented characters.
5611  You can also turn keys into dead-keys by binding them to something like
5612  
5613 \begin_inset Flex Code
5614 status collapsed
5615
5616 \begin_layout Plain Layout
5617 usldead_cedilla
5618 \end_layout
5619
5620 \end_inset
5621
5622  and then binding this symbolic key to the corresponding \SpecialChar LyX
5623  command.
5624 \begin_inset Foot
5625 status collapsed
5626
5627 \begin_layout Plain Layout
5628 Note from 
5629 \noun on
5630 John Weiss
5631 \noun default
5632 : This is exactly what I do in my 
5633 \begin_inset Flex Code
5634 status collapsed
5635
5636 \begin_layout Plain Layout
5637 ~/.lyx/lyxrc
5638 \end_layout
5639
5640 \end_inset
5641
5642  and my 
5643 \begin_inset Flex Code
5644 status collapsed
5645
5646 \begin_layout Plain Layout
5647 ~/.xmodmap
5648 \end_layout
5649
5650 \end_inset
5651
5652  files.
5653  I have my 
5654 \begin_inset Flex Noun
5655 status collapsed
5656
5657 \begin_layout Plain Layout
5658 Scroll
5659 \begin_inset space ~
5660 \end_inset
5661
5662 Lock
5663 \end_layout
5664
5665 \end_inset
5666
5667  key set up as 
5668 \begin_inset Flex Code
5669 status collapsed
5670
5671 \begin_layout Plain Layout
5672 Mode_Shift
5673 \end_layout
5674
5675 \end_inset
5676
5677  and a bunch of these 
5678 \begin_inset Quotes eld
5679 \end_inset
5680
5681
5682 \begin_inset Flex Code
5683 status collapsed
5684
5685 \begin_layout Plain Layout
5686 usldead_*
5687 \end_layout
5688
5689 \end_inset
5690
5691
5692 \begin_inset Quotes erd
5693 \end_inset
5694
5695  symbolic keys bound such things as 
5696 \begin_inset Flex Noun
5697 status collapsed
5698
5699 \begin_layout Plain Layout
5700 Scroll
5701 \begin_inset space ~
5702 \end_inset
5703
5704 Lock-^
5705 \end_layout
5706
5707 \end_inset
5708
5709  and 
5710 \begin_inset Flex Noun
5711 status collapsed
5712
5713 \begin_layout Plain Layout
5714 Scroll
5715 \begin_inset space ~
5716 \end_inset
5717
5718 Lock-~
5719 \end_layout
5720
5721 \end_inset
5722
5723 .
5724  This is how I produce my accented characters.
5725 \end_layout
5726
5727 \end_inset
5728
5729  You can make just about anything into the 
5730 \begin_inset Flex Code
5731 status collapsed
5732
5733 \begin_layout Plain Layout
5734 Mode_Switch
5735 \end_layout
5736
5737 \end_inset
5738
5739  key: One of the 
5740 \begin_inset Flex Noun
5741 status collapsed
5742
5743 \begin_layout Plain Layout
5744 Ctrl-
5745 \end_layout
5746
5747 \end_inset
5748
5749  keys, a spare function key, etc.
5750  As for the \SpecialChar LyX
5751  commands that produce accents, check the entry for 
5752 \begin_inset Flex Code
5753 status collapsed
5754
5755 \begin_layout Plain Layout
5756 accent-acute
5757 \end_layout
5758
5759 \end_inset
5760
5761  in the 
5762 \emph on
5763 Reference Manual
5764 \emph default
5765 .
5766  You'll find the complete list there.
5767 \end_layout
5768
5769 \begin_layout Subsection
5770 Saving your Language Configuration
5771 \end_layout
5772
5773 \begin_layout Standard
5774 You can edit your preferences so that your desired language environment
5775  is automatically configured when \SpecialChar LyX
5776  starts up, via the 
5777 \begin_inset Flex Noun
5778 status collapsed
5779
5780 \begin_layout Plain Layout
5781 Edit\SpecialChar menuseparator
5782 Preferences
5783 \end_layout
5784
5785 \end_inset
5786
5787  dialog.
5788 \end_layout
5789
5790 \begin_layout Chapter
5791 Installing New Document Classes, Layouts, and Templates
5792 \begin_inset CommandInset label
5793 LatexCommand label
5794 name "cha:Installing-New-Document"
5795
5796 \end_inset
5797
5798
5799 \begin_inset Argument 1
5800 status collapsed
5801
5802 \begin_layout Plain Layout
5803 Installing New Document Classes
5804 \end_layout
5805
5806 \end_inset
5807
5808
5809 \end_layout
5810
5811 \begin_layout Standard
5812 In this chapter, we describe the procedures for creating and installing
5813  new \SpecialChar LyX
5814  layout and template files, as well as offer a refresher on correctly
5815  installing new \SpecialChar LaTeX
5816  document classes.
5817  
5818 \end_layout
5819
5820 \begin_layout Standard
5821 First, let us a say a few words about how one ought to think about the relation
5822  between \SpecialChar LyX
5823  and \SpecialChar LaTeX
5824 .
5825  The thing to understand is that, in a certain sense, \SpecialChar LyX
5826  doesn't know anything
5827  about \SpecialChar LaTeX
5828 .
5829  Indeed, from \SpecialChar LyX
5830 's point of view, \SpecialChar LaTeX
5831  is just one of several 
5832 \begin_inset Quotes eld
5833 \end_inset
5834
5835 backend formats
5836 \begin_inset Quotes erd
5837 \end_inset
5838
5839  in which it is capable of producing output.
5840  Other such formats are DocBook, plaintext, and XHTML.
5841  \SpecialChar LaTeX
5842  is, of course, a particularly important format, but very little of the
5843  information \SpecialChar LyX
5844  has about \SpecialChar LaTeX
5845  is actually contained in the program itself.
5846 \begin_inset Foot
5847 status collapsed
5848
5849 \begin_layout Plain Layout
5850 Some commands are sufficiently complex that they are 
5851 \begin_inset Quotes eld
5852 \end_inset
5853
5854 hardcoded
5855 \begin_inset Quotes erd
5856 \end_inset
5857
5858  into \SpecialChar LyX
5859 .
5860  But the developers generally regard this as a Bad Thing.
5861 \end_layout
5862
5863 \end_inset
5864
5865  Rather, that information, even for the standard classes like 
5866 \begin_inset Flex Code
5867 status collapsed
5868
5869 \begin_layout Plain Layout
5870 article.cls
5871 \end_layout
5872
5873 \end_inset
5874
5875 , is contained in `layout files'.
5876  Similarly, \SpecialChar LyX
5877  itself does not know much about DocBook or XHTML.
5878  What it knows is contained in layout files.
5879 \end_layout
5880
5881 \begin_layout Standard
5882 You can think of the layout file for a given document class as a translation
5883  manual between \SpecialChar LyX
5884  constructs—paragraphs with their corresponding styles,
5885  certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5886 , DocBook, or XHTML
5887  constructs.
5888  Almost everything \SpecialChar LyX
5889  knows about 
5890 \begin_inset Flex Code
5891 status collapsed
5892
5893 \begin_layout Plain Layout
5894 article.cls
5895 \end_layout
5896
5897 \end_inset
5898
5899 , for example, is contained in the file 
5900 \begin_inset Flex Code
5901 status collapsed
5902
5903 \begin_layout Plain Layout
5904 article.layout
5905 \end_layout
5906
5907 \end_inset
5908
5909  and in various other files it includes.
5910  For this reason, anyone intending to write layout files should plan to
5911  study the existing files.
5912  A good place to start is with 
5913 \begin_inset Flex Code
5914 status collapsed
5915
5916 \begin_layout Plain Layout
5917 stdsections.inc
5918 \end_layout
5919
5920 \end_inset
5921
5922 , which is included in 
5923 \begin_inset Flex Code
5924 status collapsed
5925
5926 \begin_layout Plain Layout
5927 article.layout
5928 \end_layout
5929
5930 \end_inset
5931
5932
5933 \begin_inset Flex Code
5934 status collapsed
5935
5936 \begin_layout Plain Layout
5937 book.layout
5938 \end_layout
5939
5940 \end_inset
5941
5942 , and many of the other layout files for document classes.
5943  This file is where sections and the like are defined: 
5944 \begin_inset Flex Code
5945 status collapsed
5946
5947 \begin_layout Plain Layout
5948 stdsections.inc
5949 \end_layout
5950
5951 \end_inset
5952
5953  tells \SpecialChar LyX
5954  how paragraphs that are marked with the Section, Subsection, etc,
5955  styles can be translated into corresponding \SpecialChar LaTeX
5956 , DocBook, and XHTML commands
5957  and tags.
5958  The 
5959 \begin_inset Flex Code
5960 status collapsed
5961
5962 \begin_layout Plain Layout
5963 article.layout
5964 \end_layout
5965
5966 \end_inset
5967
5968  file basically just includes several of these 
5969 \begin_inset Flex Code
5970 status collapsed
5971
5972 \begin_layout Plain Layout
5973 std*.inc
5974 \end_layout
5975
5976 \end_inset
5977
5978  files.
5979 \end_layout
5980
5981 \begin_layout Standard
5982 Defining the \SpecialChar LyX
5983 –\SpecialChar LaTeX
5984  correspondence is not the only thing layout files do, though.
5985  Their other job is to define how the \SpecialChar LyX
5986  constructs themselves will appear
5987  on-screen.
5988  The fact that layout files have these two jobs is often a source of confusion,
5989  because they are completely separate.
5990  Telling \SpecialChar LyX
5991  how to translate a certain paragraph style into \SpecialChar LaTeX
5992  does not tell
5993  \SpecialChar LyX
5994  how to display it; conversely, telling \SpecialChar LyX
5995  how to display a certain paragraph
5996  style does not tell \SpecialChar LyX
5997  how to translate it into \SpecialChar LaTeX
5998  (let alone tell \SpecialChar LaTeX
5999  how to
6000  display it).
6001  So, in general, when you define a new \SpecialChar LyX
6002  construct, you must always do two
6003  quite separate things: (i)
6004 \begin_inset space ~
6005 \end_inset
6006
6007 tell \SpecialChar LyX
6008  how to translate it into \SpecialChar LaTeX
6009  and (ii)
6010 \begin_inset space ~
6011 \end_inset
6012
6013 tell \SpecialChar LyX
6014  how to display it.
6015 \end_layout
6016
6017 \begin_layout Standard
6018 Much the same is true, of course, as regards \SpecialChar LyX
6019 's other backend formats, though
6020  XHTML is in some ways different, because in that case \SpecialChar LyX
6021  
6022 \emph on
6023 is
6024 \emph default
6025  able, to some extent, to use information about how it should display a
6026  paragraph on the screen to output information (in the form of CSS) about
6027  how the paragraph should be displayed in a browser.
6028  Even in this case, however, the distinction between what \SpecialChar LyX
6029  does internally
6030  and how things are rendered externally remains in force, and the two can
6031  be controlled separately.
6032  See 
6033 \begin_inset CommandInset ref
6034 LatexCommand ref
6035 reference "sec:Tags-for-XHTML"
6036
6037 \end_inset
6038
6039  for the details.
6040 \end_layout
6041
6042 \begin_layout Section
6043 Installing new \SpecialChar LaTeX
6044  files
6045 \end_layout
6046
6047 \begin_layout Standard
6048 Some installations may not include a \SpecialChar LaTeX
6049  package or class file that you would
6050  like to use within \SpecialChar LyX
6051 .
6052  For example, you might need Foil\SpecialChar TeX
6053 , a package for preparing slides for overhead
6054  projectors.
6055  Modern \SpecialChar LaTeX
6056  distributions like \SpecialChar TeX
6057 Live (2008 or newer) or MiK\SpecialChar TeX
6058  provide a user interface
6059  for installing such packages.
6060  For example, with MiK\SpecialChar TeX
6061 , you start the program 
6062 \begin_inset Quotes eld
6063 \end_inset
6064
6065 Package
6066 \begin_inset space ~
6067 \end_inset
6068
6069 Manager
6070 \begin_inset Quotes erd
6071 \end_inset
6072
6073  to get a list of available packages.
6074  To install one of them, right click on it or use the corresponding toolbar
6075  button.
6076 \end_layout
6077
6078 \begin_layout Standard
6079 If your \SpecialChar LaTeX
6080  distribution does not provide such a `package manager', or if the
6081  package is not available from your distribution, then follow these steps
6082  to install it manually:
6083 \end_layout
6084
6085 \begin_layout Enumerate
6086 Get the package from 
6087 \begin_inset CommandInset href
6088 LatexCommand href
6089 name "CTAN"
6090 target "http://www.ctan.org/"
6091 literal "false"
6092
6093 \end_inset
6094
6095  or wherever.
6096 \end_layout
6097
6098 \begin_layout Enumerate
6099 If the package contains a file with the ending 
6100 \begin_inset Quotes eld
6101 \end_inset
6102
6103
6104 \begin_inset Flex Code
6105 status collapsed
6106
6107 \begin_layout Plain Layout
6108 .ins
6109 \end_layout
6110
6111 \end_inset
6112
6113
6114 \begin_inset Quotes erd
6115 \end_inset
6116
6117  (is the case for Foil\SpecialChar TeX
6118 ) then open a console, change to the folder of this
6119  file and execute the command 
6120 \begin_inset Flex Code
6121 status collapsed
6122
6123 \begin_layout Plain Layout
6124 latex foiltex.ins
6125 \end_layout
6126
6127 \end_inset
6128
6129 .
6130  You have now unpacked the package and have all files to install it.
6131  Most \SpecialChar LaTeX
6132 -packages are not packed and you can skip this step.
6133 \end_layout
6134
6135 \begin_layout Enumerate
6136 Now you need to decide if the package should be available for all users
6137  or only for you.
6138 \end_layout
6139
6140 \begin_deeper
6141 \begin_layout Enumerate
6142 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6143  for all users on your system, then install it in your `local' \SpecialChar TeX
6144  tree, otherwise
6145  install it in your own `user' \SpecialChar TeX
6146  tree.
6147  Where these trees should be created, if they do not already exist, depends
6148  on your system.
6149  To find this out, look in the file 
6150 \begin_inset Flex Code
6151 status collapsed
6152
6153 \begin_layout Plain Layout
6154 texmf.cnf
6155 \end_layout
6156
6157 \end_inset
6158
6159 .
6160 \begin_inset Foot
6161 status collapsed
6162
6163 \begin_layout Plain Layout
6164 This is usually in the directory 
6165 \begin_inset Flex Code
6166 status collapsed
6167
6168 \begin_layout Plain Layout
6169 $TEXMF/web2c
6170 \end_layout
6171
6172 \end_inset
6173
6174 , though you can execute the command 
6175 \begin_inset Flex Code
6176 status collapsed
6177
6178 \begin_layout Plain Layout
6179 kpsewhich texmf.cnf
6180 \end_layout
6181
6182 \end_inset
6183
6184  to locate it.
6185 \end_layout
6186
6187 \end_inset
6188
6189  The location of the `local' \SpecialChar TeX
6190  tree is defined by the 
6191 \begin_inset Flex Code
6192 status collapsed
6193
6194 \begin_layout Plain Layout
6195 TEXMFLOCAL
6196 \end_layout
6197
6198 \end_inset
6199
6200  variable; this is usually somewhere like 
6201 \begin_inset Flex Code
6202 status collapsed
6203
6204 \begin_layout Plain Layout
6205 /usr/local/share/texmf
6206 \end_layout
6207
6208 \end_inset
6209
6210  or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6211 Live
6212  distribution.
6213  The location of the `user' \SpecialChar TeX
6214  tree is defined by 
6215 \begin_inset Flex Code
6216 status collapsed
6217
6218 \begin_layout Plain Layout
6219 TEXMFHOME
6220 \end_layout
6221
6222 \end_inset
6223
6224  and is commonly 
6225 \begin_inset Flex Code
6226 status collapsed
6227
6228 \begin_layout Plain Layout
6229 $HOME/texmf
6230 \end_layout
6231
6232 \end_inset
6233
6234  or 
6235 \begin_inset Flex Code
6236 status collapsed
6237
6238 \begin_layout Plain Layout
6239
6240 \family sans
6241 \lang french
6242 $HOME/.texliveXXXX
6243 \end_layout
6244
6245 \end_inset
6246
6247 .
6248  (If these variables are not predefined, you have to define them.) You'll
6249  probably need root permissions to create or modify the `local' tree, but
6250  not for your `user' tree.
6251 \begin_inset Newline newline
6252 \end_inset
6253
6254 In general, it is recommended to install in the user tree because your user
6255  will not be modified or even overwritten when you upgrade your system.
6256  It will typically also be backed up together with everything else when
6257  you backup your home directory (which, of course, you do on a regular basis).
6258 \end_layout
6259
6260 \begin_layout Enumerate
6261 On Windows, if you want the new package to be available for all users on
6262  your system, change to the folder where \SpecialChar LaTeX
6263  is installed and then change to
6264  the subfolder 
6265 \begin_inset Flex Code
6266 status collapsed
6267
6268 \begin_layout Plain Layout
6269 ~
6270 \backslash
6271 tex
6272 \backslash
6273 latex
6274 \end_layout
6275
6276 \end_inset
6277
6278 .
6279  (For MiK\SpecialChar TeX
6280 , this would be by default the folder 
6281 \begin_inset Flex Code
6282 status collapsed
6283
6284 \begin_layout Plain Layout
6285 ~:
6286 \backslash
6287 Programs
6288 \backslash
6289 MiKTeX
6290 \backslash
6291 tex
6292 \backslash
6293 latex
6294 \end_layout
6295
6296 \end_inset
6297
6298 .)
6299 \begin_inset Foot
6300 status collapsed
6301
6302 \begin_layout Plain Layout
6303 Note that this will be the correct path only on English installations.
6304  On a German one, it would be 
6305 \begin_inset Flex Code
6306 status collapsed
6307
6308 \begin_layout Plain Layout
6309 ~:
6310 \backslash
6311 Programme
6312 \backslash
6313 MiKTeX
6314 \backslash
6315 tex
6316 \backslash
6317 latex
6318 \end_layout
6319
6320 \end_inset
6321
6322 , and similarly for other languages.
6323 \end_layout
6324
6325 \end_inset
6326
6327  Create there a new folder 
6328 \begin_inset Flex Code
6329 status collapsed
6330
6331 \begin_layout Plain Layout
6332 foiltex
6333 \end_layout
6334
6335 \end_inset
6336
6337  and copy all files of the package into it.
6338  
6339 \begin_inset Newline newline
6340 \end_inset
6341
6342 If the package should only available for you or you don't have admin permissions
6343 , do the same, but in the local \SpecialChar LaTeX
6344  folder.
6345  E.
6346 \begin_inset space \thinspace{}
6347 \end_inset
6348
6349 g., for MiK\SpecialChar TeX
6350
6351 \begin_inset space ~
6352 \end_inset
6353
6354 2.8 under Windows XP, this would be the folder:
6355 \begin_inset Newline newline
6356 \end_inset
6357
6358
6359 \family sans
6360
6361 \begin_inset Flex Code
6362 status collapsed
6363
6364 \begin_layout Plain Layout
6365 ~:
6366 \backslash
6367 Documents and Settings
6368 \backslash
6369 <username>
6370 \backslash
6371 Application Data
6372 \backslash
6373
6374 \end_layout
6375
6376 \end_inset
6377
6378
6379 \begin_inset Newline newline
6380 \end_inset
6381
6382
6383 \family default
6384
6385 \begin_inset Phantom HPhantom
6386 status open
6387
6388 \begin_layout Plain Layout
6389
6390 \family sans
6391 ~:
6392 \backslash
6393
6394 \end_layout
6395
6396 \end_inset
6397
6398
6399 \begin_inset Flex Code
6400 status collapsed
6401
6402 \begin_layout Plain Layout
6403 MiKTeX
6404 \backslash
6405 2.8
6406 \backslash
6407 tex
6408 \backslash
6409 latex
6410 \end_layout
6411
6412 \end_inset
6413
6414
6415 \begin_inset Newline newline
6416 \end_inset
6417
6418 On Vista, it would be:
6419 \begin_inset Newline newline
6420 \end_inset
6421
6422
6423 \begin_inset Flex Code
6424 status collapsed
6425
6426 \begin_layout Plain Layout
6427 ~:
6428 \backslash
6429 Users
6430 \backslash
6431 <username>
6432 \backslash
6433 AppData
6434 \backslash
6435 Roaming
6436 \backslash
6437 2.8
6438 \backslash
6439 MiKTeX
6440 \backslash
6441 tex
6442 \backslash
6443 latex
6444 \end_layout
6445
6446 \end_inset
6447
6448
6449 \end_layout
6450
6451 \end_deeper
6452 \begin_layout Enumerate
6453 Now one only need to tell \SpecialChar LaTeX
6454  that there are new files.
6455  This depends on the used \SpecialChar LaTeX
6456 -Distribution:
6457 \end_layout
6458
6459 \begin_deeper
6460 \begin_layout Enumerate
6461 For \SpecialChar TeX
6462 Live execute the command 
6463 \begin_inset Flex Code
6464 status collapsed
6465
6466 \begin_layout Plain Layout
6467 texhash
6468 \end_layout
6469
6470 \end_inset
6471
6472  from a console.
6473  If you installed the package for all users, then you will probably need
6474  to have root permissions for that.
6475 \end_layout
6476
6477 \begin_layout Enumerate
6478 For MiK\SpecialChar TeX
6479 , if you have installed the package for all users, start the program
6480  
6481 \begin_inset Quotes eld
6482 \end_inset
6483
6484 Settings
6485 \begin_inset space ~
6486 \end_inset
6487
6488 (Admin)
6489 \begin_inset Quotes erd
6490 \end_inset
6491
6492  and press the button marked 
6493 \begin_inset Quotes eld
6494 \end_inset
6495
6496 Refresh FNDB
6497 \begin_inset Quotes erd
6498 \end_inset
6499
6500 .
6501  Otherwise start the program 
6502 \begin_inset Quotes eld
6503 \end_inset
6504
6505 Settings
6506 \begin_inset Quotes erd
6507 \end_inset
6508
6509  and do the same.
6510 \end_layout
6511
6512 \end_deeper
6513 \begin_layout Enumerate
6514 Finally, you need to tell \SpecialChar LyX
6515  that there are new packages available.
6516  So, in \SpecialChar LyX
6517 , use the menu 
6518 \begin_inset Flex Noun
6519 status collapsed
6520
6521 \begin_layout Plain Layout
6522 Tools
6523 \family sans
6524 \SpecialChar menuseparator
6525 Reconfigure
6526 \end_layout
6527
6528 \end_inset
6529
6530  and then restart \SpecialChar LyX
6531 .
6532 \end_layout
6533
6534 \begin_layout Standard
6535 Now the package is installed.
6536  In our example, the document class 
6537 \begin_inset Flex Code
6538 status collapsed
6539
6540 \begin_layout Plain Layout
6541 Slides
6542 \begin_inset space ~
6543 \end_inset
6544
6545 (FoilTex)
6546 \end_layout
6547
6548 \end_inset
6549
6550  will now be available under 
6551 \begin_inset Flex Noun
6552 status collapsed
6553
6554 \begin_layout Plain Layout
6555 Document\SpecialChar menuseparator
6556 Settings\SpecialChar menuseparator
6557 Document Class
6558 \end_layout
6559
6560 \end_inset
6561
6562 .
6563  
6564 \end_layout
6565
6566 \begin_layout Standard
6567 If you would like to use a \SpecialChar LaTeX
6568  document class that is not even listed in the
6569  menu 
6570 \begin_inset Flex Noun
6571 status collapsed
6572
6573 \begin_layout Plain Layout
6574 Document\SpecialChar menuseparator
6575 Settings\SpecialChar menuseparator
6576 Document Class
6577 \end_layout
6578
6579 \end_inset
6580
6581 , then you need to create a `layout' file for it.
6582  That is the topic of the next section.
6583 \end_layout
6584
6585 \begin_layout Section
6586 Types of layout files
6587 \end_layout
6588
6589 \begin_layout Standard
6590 This section describes the various sorts of \SpecialChar LyX
6591  files that contain layout informati
6592 on.
6593  These files describe various paragraph and character styles, determining
6594  how \SpecialChar LyX
6595  should display them and how they should be translated into \SpecialChar LaTeX
6596 , DocBook,
6597  XHTML, or whatever output format is being used.
6598  
6599 \end_layout
6600
6601 \begin_layout Standard
6602 We shall try to provide a thorough description of the process of writing
6603  layout files here.
6604  However, there are so many different types of documents supported even
6605  by just \SpecialChar LaTeX
6606  that we can't hope to cover every different possibility or problem
6607  you might encounter.
6608  The \SpecialChar LyX
6609  users' list is frequented by people with lots of experience with layout
6610  design who are willing to share what they've learned, so please feel free
6611  to ask questions there.
6612 \end_layout
6613
6614 \begin_layout Standard
6615 As you prepare to write a new layout, it is extremely helpful to look at
6616  the layouts distributed with \SpecialChar LyX
6617 .
6618  If you write a \SpecialChar LyX
6619  layout for a \SpecialChar LaTeX
6620  document class that might also be used by
6621  others, or write a module that might be useful to others, then you should
6622  consider posting your layout to the 
6623 \begin_inset CommandInset href
6624 LatexCommand href
6625 name "layout section on the LyX wiki"
6626 target "http://wiki.lyx.org/Layouts/Layouts"
6627 literal "false"
6628
6629 \end_inset
6630
6631  or even to the \SpecialChar LyX
6632  developers' list, so that it might be included in \SpecialChar LyX
6633  itself.
6634 \begin_inset Foot
6635 status collapsed
6636
6637 \begin_layout Plain Layout
6638 Note that \SpecialChar LyX
6639  is licensed under the General Public License, so any material
6640  that is contributed to \SpecialChar LyX
6641  must be similarly licensed.
6642 \end_layout
6643
6644 \end_inset
6645
6646
6647 \end_layout
6648
6649 \begin_layout Subsection
6650 Layout modules
6651 \begin_inset CommandInset label
6652 LatexCommand label
6653 name "subsec:Layout-modules"
6654
6655 \end_inset
6656
6657
6658 \end_layout
6659
6660 \begin_layout Standard
6661 We have spoken to this point about `layout files'.
6662  But there are different sorts of files that contain layout information.
6663  Layout files, strictly so called, have the 
6664 \begin_inset Flex Code
6665 status collapsed
6666
6667 \begin_layout Plain Layout
6668 .layout
6669 \end_layout
6670
6671 \end_inset
6672
6673  extension and provide \SpecialChar LyX
6674  with information about document classes.
6675  Since \SpecialChar LyX
6676  1.6 layout information can also be contained in layout 
6677 \emph on
6678 modules
6679 \emph default
6680 , which have the 
6681 \begin_inset Flex Code
6682 status collapsed
6683
6684 \begin_layout Plain Layout
6685 .module
6686 \end_layout
6687
6688 \end_inset
6689
6690  extension.
6691  Modules are to \SpecialChar LaTeX
6692  packages much as layouts are to \SpecialChar LaTeX
6693  classes, and some modules—such
6694  as the 
6695 \begin_inset Flex Code
6696 status collapsed
6697
6698 \begin_layout Plain Layout
6699 endnotes
6700 \end_layout
6701
6702 \end_inset
6703
6704  module—specifically provide support for one package.
6705  In a sense, layout modules are similar to included
6706 \begin_inset Foot
6707 status collapsed
6708
6709 \begin_layout Plain Layout
6710 These can have any extension, but by convention have the 
6711 \begin_inset Flex Code
6712 status collapsed
6713
6714 \begin_layout Plain Layout
6715 .inc
6716 \end_layout
6717
6718 \end_inset
6719
6720  extension.
6721 \end_layout
6722
6723 \end_inset
6724
6725  files—files like 
6726 \begin_inset Flex Code
6727 status collapsed
6728
6729 \begin_layout Plain Layout
6730 stdsections.inc
6731 \end_layout
6732
6733 \end_inset
6734
6735 —in that modules are not specific to a given document class but may be used
6736  with many different classes.
6737  The difference is that using an included file with 
6738 \begin_inset Flex Code
6739 status collapsed
6740
6741 \begin_layout Plain Layout
6742 article.cls
6743 \end_layout
6744
6745 \end_inset
6746
6747  requires editing that file.
6748  Modules, by contrast, are selected in the 
6749 \begin_inset Flex Noun
6750 status collapsed
6751
6752 \begin_layout Plain Layout
6753 Document\SpecialChar menuseparator
6754 Settings
6755 \end_layout
6756
6757 \end_inset
6758
6759  dialog.
6760 \end_layout
6761
6762 \begin_layout Standard
6763 Building modules is the easiest way to get started with layout editing,
6764  since it can be as simple as adding a single new paragraph style or flex
6765  inset.
6766  But modules may, in principle, contain anything a layout file can contain.
6767 \end_layout
6768
6769 \begin_layout Standard
6770 After creating a new module and copying it to the 
6771 \begin_inset Flex Code
6772 status collapsed
6773
6774 \begin_layout Plain Layout
6775 layouts/
6776 \end_layout
6777
6778 \end_inset
6779
6780  folder, you will need to reconfigure and then restart \SpecialChar LyX
6781  for the module to
6782  appear in the menu.
6783  However, changes you make to the module will be seen immediately, if you
6784  open 
6785 \begin_inset Flex Noun
6786 status collapsed
6787
6788 \begin_layout Plain Layout
6789 Document\SpecialChar menuseparator
6790 Settings
6791 \end_layout
6792
6793 \end_inset
6794
6795 , highlight something, and then hit 
6796 \begin_inset Quotes eld
6797 \end_inset
6798
6799 OK
6800 \begin_inset Quotes erd
6801 \end_inset
6802
6803 .
6804  
6805 \emph on
6806 It is strongly recommended that you save your work before doing this
6807 \emph default
6808 .
6809  In fact, 
6810 \emph on
6811 it is strongly recommended that you not attempt to edit modules while simultaneo
6812 usly working on actual documents
6813 \emph default
6814 .
6815  Though of course the developers strive to keep \SpecialChar LyX
6816  stable in such situations,
6817  syntax errors and the like in your module file could cause strange behavior.
6818 \end_layout
6819
6820 \begin_layout Subsubsection
6821 Local Layout
6822 \end_layout
6823
6824 \begin_layout Standard
6825 Modules are to \SpecialChar LyX
6826  as packages are to \SpecialChar LaTeX
6827 .
6828  Sometimes, however, you find yourself wanting a specific inset or character
6829  style just for one document and writing a module that will also be available
6830  to other documents makes little sense.
6831  What you need is \SpecialChar LyX
6832 's 
6833 \begin_inset Quotes eld
6834 \end_inset
6835
6836 Local Layout
6837 \begin_inset Quotes erd
6838 \end_inset
6839
6840 .
6841 \end_layout
6842
6843 \begin_layout Standard
6844 You will find it under 
6845 \family sans
6846 Document\SpecialChar menuseparator
6847 Settings\SpecialChar menuseparator
6848 Local Layout
6849 \family default
6850 .
6851  The large text box allows you to enter anything that you might enter in
6852  a layout file or module.
6853  You can think of a document's local layout, in fact, as a module that belongs
6854  just to it.
6855  So, in particular, you must enter a 
6856 \begin_inset Flex Code
6857 status collapsed
6858
6859 \begin_layout Plain Layout
6860 Format
6861 \end_layout
6862
6863 \end_inset
6864
6865  tag.
6866  Any format is acceptable, but one would normally use the format current
6867  at the time.
6868  (In \SpecialChar LyX
6869  2.2, the current layout format is 60.)
6870 \end_layout
6871
6872 \begin_layout Standard
6873 When you have entered something in the 
6874 \begin_inset Flex Code
6875 status collapsed
6876
6877 \begin_layout Plain Layout
6878 Local Layout
6879 \end_layout
6880
6881 \end_inset
6882
6883  pane, \SpecialChar LyX
6884  will enable the 
6885 \begin_inset Quotes eld
6886 \end_inset
6887
6888 Validate
6889 \begin_inset Quotes erd
6890 \end_inset
6891
6892  button at the bottom.
6893  Clicking this button will cause \SpecialChar LyX
6894  to determine whether what you have entered
6895  is valid layout information for the chosen format.
6896  \SpecialChar LyX
6897  will report the result but, unfortunately, will not tell you what errors
6898  there might have been.
6899  These will be written to the terminal, however, if \SpecialChar LyX
6900  is started from a terminal.
6901  You will not be permitted to save your local layout until you have entered
6902  something valid.
6903 \end_layout
6904
6905 \begin_layout Standard
6906 The warnings at the end of the previous section apply here, too.
6907  Do not play with local layout while you are actually working, especially
6908  if you have not saved your document.
6909  That said, using local layout with a test document can be a very convenient
6910  way to try out layout ideas, or even to start developing a module.
6911 \end_layout
6912
6913 \begin_layout Subsection
6914 Layout for 
6915 \begin_inset Flex Noun
6916 status collapsed
6917
6918 \begin_layout Plain Layout
6919 .sty
6920 \end_layout
6921
6922 \end_inset
6923
6924  files
6925 \end_layout
6926
6927 \begin_layout Standard
6928 There are two situations you are likely to encounter when wanting to support
6929  a new \SpecialChar LaTeX
6930  document class, involving style (
6931 \begin_inset Flex Code
6932 status collapsed
6933
6934 \begin_layout Plain Layout
6935 .sty
6936 \end_layout
6937
6938 \end_inset
6939
6940 ) files and \SpecialChar LaTeX2e
6941  class (
6942 \begin_inset Flex Code
6943 status collapsed
6944
6945 \begin_layout Plain Layout
6946 .cls
6947 \end_layout
6948
6949 \end_inset
6950
6951 ) .
6952  Supporting a style file is usually fairly easy.
6953  Supporting a new class file is a bit harder.
6954  We'll discuss the former in this section and the latter in the next.
6955  Similar remarks apply, of course, if you want to support a new DocBook
6956  DTD.
6957 \end_layout
6958
6959 \begin_layout Standard
6960 The easier case is the one in which your new document class is provided
6961  as a style file that is to be used in conjunction with an already supported
6962  document class.
6963  For the sake of the example, we'll assume that the style file is called
6964  
6965 \begin_inset Flex Noun
6966 status collapsed
6967
6968 \begin_layout Plain Layout
6969 myclass.sty
6970 \end_layout
6971
6972 \end_inset
6973
6974  and that it is meant to be used with 
6975 \begin_inset Flex Noun
6976 status collapsed
6977
6978 \begin_layout Plain Layout
6979 report.cls
6980 \end_layout
6981
6982 \end_inset
6983
6984 , which is a standard class.
6985  
6986 \end_layout
6987
6988 \begin_layout Standard
6989 Start by copying the existing class's layout file into your local directory:
6990 \begin_inset Foot
6991 status collapsed
6992
6993 \begin_layout Plain Layout
6994 Of course, which directory is your local directory will vary by platform,
6995  and \SpecialChar LyX
6996  allows you to specify your local directory on startup, too, using
6997  the 
6998 \begin_inset Flex Code
6999 status collapsed
7000
7001 \begin_layout Plain Layout
7002 -userdir
7003 \end_layout
7004
7005 \end_inset
7006
7007  option.
7008 \end_layout
7009
7010 \end_inset
7011
7012
7013 \end_layout
7014
7015 \begin_layout LyX-Code
7016 cp report.layout ~/.lyx/layouts/myclass.layout
7017 \end_layout
7018
7019 \begin_layout Standard
7020 Then edit 
7021 \begin_inset Flex Code
7022 status collapsed
7023
7024 \begin_layout Plain Layout
7025 myclass.layout
7026 \end_layout
7027
7028 \end_inset
7029
7030  and change the line: 
7031 \end_layout
7032
7033 \begin_layout LyX-Code
7034
7035 \backslash
7036 DeclareLaTeXClass{report}
7037 \end_layout
7038
7039 \begin_layout Standard
7040 to read
7041 \end_layout
7042
7043 \begin_layout LyX-Code
7044
7045 \backslash
7046 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
7047 \end_layout
7048
7049 \begin_layout Standard
7050 Then add:
7051 \end_layout
7052
7053 \begin_layout LyX-Code
7054 Preamble 
7055 \begin_inset Newline newline
7056 \end_inset
7057
7058     
7059 \backslash
7060 usepackage{myclass}
7061 \begin_inset Newline newline
7062 \end_inset
7063
7064 EndPreamble
7065 \end_layout
7066
7067 \begin_layout Standard
7068 near the top of the file.
7069 \end_layout
7070
7071 \begin_layout Standard
7072 Start \SpecialChar LyX
7073  and select 
7074 \begin_inset Flex Noun
7075 status collapsed
7076
7077 \begin_layout Plain Layout
7078 Tools\SpecialChar menuseparator
7079 Reconfigure
7080 \end_layout
7081
7082 \end_inset
7083
7084 .
7085  Then restart \SpecialChar LyX
7086  and try creating a new document.
7087  You should see "
7088 \begin_inset Flex Noun
7089 status collapsed
7090
7091 \begin_layout Plain Layout
7092 report (myclass)
7093 \end_layout
7094
7095 \end_inset
7096
7097 " as a document class option in the 
7098 \begin_inset Flex Noun
7099 status collapsed
7100
7101 \begin_layout Plain Layout
7102 Document\SpecialChar menuseparator
7103 Settings
7104 \end_layout
7105
7106 \end_inset
7107
7108  dialog.
7109  It is likely that some of the sectioning commands and such in your new
7110  class will work differently from how they worked in the base class—
7111 \begin_inset Flex Code
7112 status collapsed
7113
7114 \begin_layout Plain Layout
7115 report
7116 \end_layout
7117
7118 \end_inset
7119
7120  in this example—so you can fiddle around with the settings for the different
7121  sections if you wish.
7122  The layout information for sections is contained in 
7123 \begin_inset Flex Code
7124 status collapsed
7125
7126 \begin_layout Plain Layout
7127 stdsections.inc
7128 \end_layout
7129
7130 \end_inset
7131
7132 , but you do not need to copy and change this file.
7133  Instead, you can simply add your changes to your layout file, after the
7134  line 
7135 \begin_inset Flex Code
7136 status collapsed
7137
7138 \begin_layout Plain Layout
7139 Input stdclass.inc
7140 \end_layout
7141
7142 \end_inset
7143
7144 , which itself includes 
7145 \begin_inset Flex Code
7146 status collapsed
7147
7148 \begin_layout Plain Layout
7149 stdsections.inc
7150 \end_layout
7151
7152 \end_inset
7153
7154 .
7155  For example, you might add these lines:
7156 \end_layout
7157
7158 \begin_layout LyX-Code
7159 Style Chapter
7160 \end_layout
7161
7162 \begin_layout LyX-Code
7163     Font
7164 \end_layout
7165
7166 \begin_layout LyX-Code
7167         Family Sans
7168 \end_layout
7169
7170 \begin_layout LyX-Code
7171     EndFont
7172 \end_layout
7173
7174 \begin_layout LyX-Code
7175 End
7176 \end_layout
7177
7178 \begin_layout Standard
7179 to change the font for chapter headings to sans-serif.
7180  This will override (or, in this case, add to) the existing declaration
7181  for the Chapter style.
7182  
7183 \end_layout
7184
7185 \begin_layout Standard
7186 Your new package may also provide commands or environments not present in
7187  the base class.
7188  In this case, you will want to add these to the layout file.
7189  See 
7190 \begin_inset CommandInset ref
7191 LatexCommand ref
7192 reference "sec:TextClass"
7193
7194 \end_inset
7195
7196  for information on how to do so.
7197 \end_layout
7198
7199 \begin_layout Standard
7200 If 
7201 \begin_inset Flex Noun
7202 status collapsed
7203
7204 \begin_layout Plain Layout
7205 myclass.sty
7206 \end_layout
7207
7208 \end_inset
7209
7210  can be used with several different document classes, and even if it cannot,
7211  you might find it easiest just to write a module that you can load with
7212  the base class.
7213  The simplest possible such module would be:
7214 \end_layout
7215
7216 \begin_layout LyX-Code
7217 #
7218 \backslash
7219 DeclareLyXModule{My Package} 
7220 \end_layout
7221
7222 \begin_layout LyX-Code
7223 #DescriptionBegin 
7224 \end_layout
7225
7226 \begin_layout LyX-Code
7227 #Support for mypkg.sty.
7228 \end_layout
7229
7230 \begin_layout LyX-Code
7231 #DescriptionEnd
7232 \begin_inset Newline newline
7233 \end_inset
7234
7235
7236 \end_layout
7237
7238 \begin_layout LyX-Code
7239 Format 60
7240 \begin_inset Newline newline
7241 \end_inset
7242
7243
7244 \end_layout
7245
7246 \begin_layout LyX-Code
7247 Preamble
7248 \begin_inset Newline newline
7249 \end_inset
7250
7251     
7252 \backslash
7253 usepackage{mypkg}
7254 \begin_inset Newline newline
7255 \end_inset
7256
7257 EndPreamble
7258 \end_layout
7259
7260 \begin_layout Standard
7261 A more complex module might modify the behavior of some existing constructs
7262  or define some new ones.
7263  Again, see 
7264 \begin_inset CommandInset ref
7265 LatexCommand ref
7266 reference "sec:TextClass"
7267
7268 \end_inset
7269
7270  for discussion.
7271 \end_layout
7272
7273 \begin_layout Subsection
7274 Layout for 
7275 \begin_inset Flex Noun
7276 status collapsed
7277
7278 \begin_layout Plain Layout
7279 .cls
7280 \end_layout
7281
7282 \end_inset
7283
7284  files
7285 \end_layout
7286
7287 \begin_layout Standard
7288 There are two possibilities here.
7289  One is that the class file is itself based upon an existing document class.
7290  For example, many thesis classes are based upon 
7291 \begin_inset Flex Noun
7292 status collapsed
7293
7294 \begin_layout Plain Layout
7295 book.cls
7296 \end_layout
7297
7298 \end_inset
7299
7300 .
7301  To see whether yours is, look for a line like
7302 \end_layout
7303
7304 \begin_layout LyX-Code
7305
7306 \backslash
7307 LoadClass{book}
7308 \end_layout
7309
7310 \begin_layout Standard
7311 in the file.
7312  If so, then you may proceed largely as in the previous section, though
7313  the 
7314 \begin_inset Flex Code
7315 status collapsed
7316
7317 \begin_layout Plain Layout
7318 Declare\SpecialChar LaTeX
7319 Class
7320 \end_layout
7321
7322 \end_inset
7323
7324  line will be different.
7325  If your new class is 
7326 \begin_inset Flex Code
7327 status collapsed
7328
7329 \begin_layout Plain Layout
7330 thesis
7331 \end_layout
7332
7333 \end_inset
7334
7335  and it is based upon 
7336 \begin_inset Flex Code
7337 status collapsed
7338
7339 \begin_layout Plain Layout
7340 book
7341 \end_layout
7342
7343 \end_inset
7344
7345 , then the line should read:
7346 \begin_inset Foot
7347 status collapsed
7348
7349 \begin_layout Plain Layout
7350 And it will be easiest if you save the file to 
7351 \begin_inset Flex Code
7352 status collapsed
7353
7354 \begin_layout Plain Layout
7355 thesis.layout
7356 \end_layout
7357
7358 \end_inset
7359
7360 : \SpecialChar LyX
7361  assumes that the document class has the same name as the layout file.
7362  
7363 \end_layout
7364
7365 \end_inset
7366
7367
7368 \end_layout
7369
7370 \begin_layout LyX-Code
7371
7372 \backslash
7373 DeclareLaTeXClass[thesis,book]{thesis}
7374 \end_layout
7375
7376 \begin_layout Standard
7377 If, on the other hand, the new class is not based upon an existing class,
7378  you will probably have to 
7379 \begin_inset Quotes eld
7380 \end_inset
7381
7382 roll your own
7383 \begin_inset Quotes erd
7384 \end_inset
7385
7386  layout.
7387  We strongly suggest copying an existing layout file which uses a similar
7388  \SpecialChar LaTeX
7389  class and then modifying it, if you can do so.
7390  At least use an existing file as a starting point so you can find out what
7391  items you need to worry about.
7392  Again, the specifics are covered below.
7393 \end_layout
7394
7395 \begin_layout Subsection
7396 Creating templates
7397 \begin_inset CommandInset label
7398 LatexCommand label
7399 name "subsec:Creating-Templates"
7400
7401 \end_inset
7402
7403
7404 \end_layout
7405
7406 \begin_layout Standard
7407 Once you have written a layout file for a new document class, you might
7408  want to consider writing a 
7409 \emph on
7410 template
7411 \emph default
7412  for it, too.
7413  A template acts as a kind of tutorial for your layout, showing how it might
7414  be used, though containing dummy content.
7415  You can of course look at the various templates included with \SpecialChar LyX
7416  for ideas.
7417 \end_layout
7418
7419 \begin_layout Standard
7420 Templates are created just like usual documents: using \SpecialChar LyX
7421 .
7422  The only difference is that usual documents contain all possible settings,
7423  including the font scheme and the paper size.
7424  Usually a user doesn't want a template to overwrite his preferred settings
7425  for such parameters.
7426  For that reason, the designer of a template should remove the corresponding
7427  commands like 
7428 \begin_inset Flex Code
7429 status collapsed
7430
7431 \begin_layout Plain Layout
7432
7433 \backslash
7434 font_roman
7435 \end_layout
7436
7437 \end_inset
7438
7439  or 
7440 \begin_inset Flex Code
7441 status collapsed
7442
7443 \begin_layout Plain Layout
7444
7445 \backslash
7446 papersize
7447 \end_layout
7448
7449 \end_inset
7450
7451  from the template \SpecialChar LyX
7452  file.
7453  This can be done with any simple text-editor, for example 
7454 \begin_inset Flex Code
7455 status collapsed
7456
7457 \begin_layout Plain Layout
7458 vi
7459 \end_layout
7460
7461 \end_inset
7462
7463  or 
7464 \begin_inset Flex Code
7465 status collapsed
7466
7467 \begin_layout Plain Layout
7468 notepad
7469 \end_layout
7470
7471 \end_inset
7472
7473 .
7474 \end_layout
7475
7476 \begin_layout Standard
7477 Put the edited template files you create in 
7478 \begin_inset Flex Code
7479 status collapsed
7480
7481 \begin_layout Plain Layout
7482 UserDir/templates/
7483 \end_layout
7484
7485 \end_inset
7486
7487 , copy the ones you use from the global template directory in 
7488 \begin_inset Flex Code
7489 status collapsed
7490
7491 \begin_layout Plain Layout
7492 LyXDir/templates/
7493 \end_layout
7494
7495 \end_inset
7496
7497  to the same place, and redefine the template path in the 
7498 \begin_inset Flex Noun
7499 status collapsed
7500
7501 \begin_layout Plain Layout
7502 Tools\SpecialChar menuseparator
7503 Preferences\SpecialChar menuseparator
7504 Paths
7505 \end_layout
7506
7507 \end_inset
7508
7509  dialog.
7510 \end_layout
7511
7512 \begin_layout Standard
7513 Note, by the way, that there is a template which has a particular meaning:
7514  
7515 \begin_inset Flex Code
7516 status collapsed
7517
7518 \begin_layout Plain Layout
7519 defaults.lyx
7520 \end_layout
7521
7522 \end_inset
7523
7524 .
7525  This template is loaded every time you create a new document with 
7526 \begin_inset Flex Noun
7527 status collapsed
7528
7529 \begin_layout Plain Layout
7530 File\SpecialChar menuseparator
7531 New
7532 \end_layout
7533
7534 \end_inset
7535
7536  in order to provide useful defaults.
7537  To create this template from inside \SpecialChar LyX
7538 , all you have to do is to open a document
7539  with the correct settings, and use the 
7540 \begin_inset Flex Noun
7541 status collapsed
7542
7543 \begin_layout Plain Layout
7544 Save as Document Defaults
7545 \end_layout
7546
7547 \end_inset
7548
7549  button.
7550 \end_layout
7551
7552 \begin_layout Subsection
7553 Upgrading old layout files
7554 \end_layout
7555
7556 \begin_layout Standard
7557 The format of layout files changes with each \SpecialChar LyX
7558  release, so old layout files
7559  need to be converted to the new format.
7560  If \SpecialChar LyX
7561  reads a layout file in an older format, it automatically calls the
7562  script 
7563 \begin_inset Flex Code
7564 status collapsed
7565
7566 \begin_layout Plain Layout
7567 layout2layout.py
7568 \end_layout
7569
7570 \end_inset
7571
7572  to convert it to a temporary file in current format.
7573  The original file is left untouched.
7574  If you use the layout file often, then, you may want to convert it permanently,
7575  so that \SpecialChar LyX
7576  does not have to do so itself every time.
7577  To do this, you can call the converter manually:
7578 \end_layout
7579
7580 \begin_layout Enumerate
7581 rename the file 
7582 \begin_inset Flex Code
7583 status collapsed
7584
7585 \begin_layout Plain Layout
7586 myclass.layout
7587 \end_layout
7588
7589 \end_inset
7590
7591  to 
7592 \begin_inset Flex Code
7593 status collapsed
7594
7595 \begin_layout Plain Layout
7596 myclass.old
7597 \end_layout
7598
7599 \end_inset
7600
7601
7602 \end_layout
7603
7604 \begin_layout Enumerate
7605 Call the command
7606 \begin_inset Newline newline
7607 \end_inset
7608
7609
7610 \begin_inset Flex Code
7611 status collapsed
7612
7613 \begin_layout Plain Layout
7614 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7615 \end_layout
7616
7617 \end_inset
7618
7619
7620 \begin_inset Newline newline
7621 \end_inset
7622
7623 where 
7624 \begin_inset Flex Code
7625 status collapsed
7626
7627 \begin_layout Plain Layout
7628 LyXDir
7629 \end_layout
7630
7631 \end_inset
7632
7633  is the name of your \SpecialChar LyX
7634  system directory.
7635 \end_layout
7636
7637 \begin_layout Standard
7638 Note that manual conversion does not affect included files, so these will
7639  have to be converted separately.
7640 \change_inserted -712698321 1483873435
7641
7642 \end_layout
7643
7644 \begin_layout Subsection
7645
7646 \change_inserted -712698321 1483875083
7647 \begin_inset CommandInset label
7648 LatexCommand label
7649 name "subsec:Cite-Engine-Files"
7650
7651 \end_inset
7652
7653 Cite engine files
7654 \end_layout
7655
7656 \begin_layout Standard
7657
7658 \change_inserted -712698321 1483874213
7659 A specific form of layout files are the so-called 
7660 \begin_inset Flex Code
7661 status collapsed
7662
7663 \begin_layout Plain Layout
7664
7665 \change_inserted -712698321 1483873546
7666 *.citeengine
7667 \end_layout
7668
7669 \end_inset
7670
7671  files that are located in the 
7672 \begin_inset Flex Code
7673 status collapsed
7674
7675 \begin_layout Plain Layout
7676
7677 \change_inserted -712698321 1483873546
7678 citeengines/
7679 \end_layout
7680
7681 \end_inset
7682
7683  sub-directory.
7684  Their purpose is to define the specifics of \SpecialChar LaTeX
7685  packages aimed at bibliography
7686  generation, such as 
7687 \family sans
7688 natbib
7689 \family default
7690 ,
7691 \family sans
7692  jurabib
7693 \family default
7694  or 
7695 \family sans
7696 biblatex
7697 \family default
7698 , but also the way how normal Bib\SpecialChar TeX
7699  citations (without additional packages)
7700  are handled in \SpecialChar LyX
7701  is defined in such a file.
7702  
7703 \end_layout
7704
7705 \begin_layout Standard
7706
7707 \change_inserted -712698321 1483874969
7708 More specifically, it is defined which packages \SpecialChar LyX
7709  needs to load, which citation
7710  commands are available, how these are to be displayed in \SpecialChar LyX
7711  (in the workarea,
7712  the dialogs, the context menus) as well as in the XHTML and plain text
7713  output.
7714  Furthermore, the files specify available style variants (author-year, numerical
7715 , etc.) and their specifics.
7716  The cite engine files are also used to generate the options that are available
7717  in 
7718 \family sans
7719 Document\SpecialChar menuseparator
7720 Settings\SpecialChar ldots
7721 \SpecialChar menuseparator
7722 Bibliography\SpecialChar menuseparator
7723 Style engine
7724 \family default
7725 .
7726 \end_layout
7727
7728 \begin_layout Standard
7729
7730 \change_inserted -712698321 1483875180
7731 Even though a cite engine file is essentially a normal layout file that
7732  could theoretically include any layout information, it usually primarily
7733  includes some specific parameters such as 
7734 \begin_inset Flex Code
7735 status collapsed
7736
7737 \begin_layout Plain Layout
7738
7739 \change_inserted -712698321 1483874688
7740 MaxCiteNames
7741 \change_unchanged
7742
7743 \end_layout
7744
7745 \end_inset
7746
7747
7748 \begin_inset Flex Code
7749 status collapsed
7750
7751 \begin_layout Plain Layout
7752
7753 \change_inserted -712698321 1483875180
7754 CiteFramework
7755 \change_unchanged
7756
7757 \end_layout
7758
7759 \end_inset
7760
7761
7762 \begin_inset Flex Code
7763 status collapsed
7764
7765 \begin_layout Plain Layout
7766
7767 \change_inserted -712698321 1483874477
7768 CiteEngine
7769 \change_unchanged
7770
7771 \end_layout
7772
7773 \end_inset
7774
7775  and 
7776 \begin_inset Flex Code
7777 status collapsed
7778
7779 \begin_layout Plain Layout
7780
7781 \change_inserted -712698321 1483874482
7782 CiteFormat
7783 \change_unchanged
7784
7785 \end_layout
7786
7787 \end_inset
7788
7789  blocks.
7790  The syntax of the latter two is described in 
7791 \begin_inset CommandInset ref
7792 LatexCommand ref
7793 reference "subsec:Citation-engine-description"
7794 plural "false"
7795 caps "false"
7796 noprefix "false"
7797
7798 \end_inset
7799
7800  and 
7801 \begin_inset CommandInset ref
7802 LatexCommand ref
7803 reference "subsec:Citation-format-description"
7804
7805 \end_inset
7806
7807 , as well as in the files themselves.
7808 \change_unchanged
7809
7810 \end_layout
7811
7812 \begin_layout Section
7813 \begin_inset CommandInset label
7814 LatexCommand label
7815 name "sec:TextClass"
7816
7817 \end_inset
7818
7819 The layout file format
7820 \end_layout
7821
7822 \begin_layout Standard
7823 The following sections describe how layout files are structured and written.
7824  Our advice is to go slowly, save and test often.
7825  It is really not that hard, except that the multitude of options can become
7826  overwhelming, especially if you try to check out too many at once.
7827  It becomes easier if you use existing layouts of \SpecialChar LyX
7828  as examples/reference
7829  or if you modify an existing layout to your needs.
7830 \end_layout
7831
7832 \begin_layout Standard
7833 Note that all the tags used in layout files are case-insensitive.
7834  This means that 
7835 \begin_inset Flex Code
7836 status collapsed
7837
7838 \begin_layout Plain Layout
7839 Style
7840 \end_layout
7841
7842 \end_inset
7843
7844
7845 \begin_inset Flex Code
7846 status collapsed
7847
7848 \begin_layout Plain Layout
7849 style
7850 \end_layout
7851
7852 \end_inset
7853
7854  and 
7855 \begin_inset Flex Code
7856 status collapsed
7857
7858 \begin_layout Plain Layout
7859 StYlE
7860 \end_layout
7861
7862 \end_inset
7863
7864  are really the same tag.
7865  The possible arguments are printed in brackets after the tag's name.
7866  The default argument is typeset 
7867 \begin_inset Flex Code
7868 status collapsed
7869
7870 \begin_layout Plain Layout
7871
7872 \emph on
7873 emphasized
7874 \end_layout
7875
7876 \end_inset
7877
7878 .
7879  If the argument has a data type like 
7880 \begin_inset Quotes eld
7881 \end_inset
7882
7883 string
7884 \begin_inset Quotes erd
7885 \end_inset
7886
7887  or 
7888 \begin_inset Quotes eld
7889 \end_inset
7890
7891 float
7892 \begin_inset Quotes erd
7893 \end_inset
7894
7895 , the default is shown like this: 
7896 \begin_inset Flex Code
7897 status collapsed
7898
7899 \begin_layout Plain Layout
7900 float=
7901 \emph on
7902 default
7903 \end_layout
7904
7905 \end_inset
7906
7907 .
7908 \end_layout
7909
7910 \begin_layout Subsection
7911 The document class declaration and classification
7912 \end_layout
7913
7914 \begin_layout Standard
7915 Lines in a layout file which begin with 
7916 \begin_inset Flex Code
7917 status collapsed
7918
7919 \begin_layout Plain Layout
7920 #
7921 \end_layout
7922
7923 \end_inset
7924
7925  are comments.
7926  There is one exception to this rule.
7927  All 
7928 \begin_inset Flex Code
7929 status collapsed
7930
7931 \begin_layout Plain Layout
7932 *.layout
7933 \end_layout
7934
7935 \end_inset
7936
7937  files should begin with lines like:
7938 \end_layout
7939
7940 \begin_layout LyX-Code
7941
7942 \size small
7943 #% Do not delete the line below; configure depends on this 
7944 \end_layout
7945
7946 \begin_layout LyX-Code
7947
7948 \size small
7949 #  
7950 \backslash
7951 DeclareLaTeXClass{Article (Standard Class)}
7952 \end_layout
7953
7954 \begin_layout LyX-Code
7955
7956 \size small
7957 #  
7958 \backslash
7959 DeclareCategory{Articles}
7960 \end_layout
7961
7962 \begin_layout Standard
7963 The second and third lines are used when you (re)configure \SpecialChar LyX
7964 .
7965  The layout file is read by the \SpecialChar LaTeX
7966  script 
7967 \begin_inset Flex Code
7968 status collapsed
7969
7970 \begin_layout Plain Layout
7971 chkconfig.ltx
7972 \end_layout
7973
7974 \end_inset
7975
7976 , in a special mode where 
7977 \begin_inset Flex Code
7978 status collapsed
7979
7980 \begin_layout Plain Layout
7981 #
7982 \end_layout
7983
7984 \end_inset
7985
7986  is ignored.
7987  The first line is just a \SpecialChar LaTeX
7988  comment, the second one contains the mandatory
7989  declaration of the text class and the third line contains the optional
7990  classification of the class.
7991  If these lines appear in a file named 
7992 \begin_inset Flex Code
7993 status collapsed
7994
7995 \begin_layout Plain Layout
7996 article.layout
7997 \end_layout
7998
7999 \end_inset
8000
8001 , then they define a text class of name 
8002 \begin_inset Flex Code
8003 status collapsed
8004
8005 \begin_layout Plain Layout
8006 article
8007 \end_layout
8008
8009 \end_inset
8010
8011  (the name of the layout file) which uses the \SpecialChar LaTeX
8012  document class 
8013 \begin_inset Flex Code
8014 status collapsed
8015
8016 \begin_layout Plain Layout
8017 article.cls
8018 \end_layout
8019
8020 \end_inset
8021
8022  (the default is to use the same name as the layout).
8023  The string 
8024 \begin_inset Quotes eld
8025 \end_inset
8026
8027 Article (Standard Class)
8028 \begin_inset Quotes erd
8029 \end_inset
8030
8031  that appears above is used as a description of the text class in the 
8032 \begin_inset Flex Noun
8033 status collapsed
8034
8035 \begin_layout Plain Layout
8036 Document\SpecialChar menuseparator
8037 Settings
8038 \end_layout
8039
8040 \end_inset
8041
8042  dialog.
8043  The category (
8044 \begin_inset Quotes eld
8045 \end_inset
8046
8047 Articles
8048 \begin_inset Quotes erd
8049 \end_inset
8050
8051  in the example) is also used in the 
8052 \begin_inset Flex Noun
8053 status collapsed
8054
8055 \begin_layout Plain Layout
8056 Document\SpecialChar menuseparator
8057 Settings
8058 \end_layout
8059
8060 \end_inset
8061
8062  dialog: the text classes are grouped by these categories (which are usually
8063  genres, so typical categories are 
8064 \begin_inset Quotes eld
8065 \end_inset
8066
8067 Articles
8068 \begin_inset Quotes erd
8069 \end_inset
8070
8071
8072 \begin_inset Quotes eld
8073 \end_inset
8074
8075 Books
8076 \begin_inset Quotes erd
8077 \end_inset
8078
8079
8080 \begin_inset Quotes eld
8081 \end_inset
8082
8083 Reports
8084 \begin_inset Quotes erd
8085 \end_inset
8086
8087
8088 \begin_inset Quotes eld
8089 \end_inset
8090
8091 Letters
8092 \begin_inset Quotes erd
8093 \end_inset
8094
8095
8096 \begin_inset Quotes eld
8097 \end_inset
8098
8099 Presentations
8100 \begin_inset Quotes erd
8101 \end_inset
8102
8103
8104 \begin_inset Quotes eld
8105 \end_inset
8106
8107 Curricula Vitae
8108 \begin_inset Quotes erd
8109 \end_inset
8110
8111  etc.).
8112  If no category has been declared, the class will be put in the 
8113 \begin_inset Quotes eld
8114 \end_inset
8115
8116 Uncategorized
8117 \begin_inset Quotes erd
8118 \end_inset
8119
8120  group.
8121 \end_layout
8122
8123 \begin_layout Standard
8124 Let's assume that you wrote your own text class that uses the 
8125 \begin_inset Flex Code
8126 status collapsed
8127
8128 \begin_layout Plain Layout
8129 article.cls
8130 \end_layout
8131
8132 \end_inset
8133
8134  document class, but where you changed the appearance of the section headings.
8135  If you put it in a file 
8136 \begin_inset Flex Code
8137 status collapsed
8138
8139 \begin_layout Plain Layout
8140 myarticle.layout
8141 \end_layout
8142
8143 \end_inset
8144
8145 , the header of this file should be:
8146 \end_layout
8147
8148 \begin_layout LyX-Code
8149
8150 \size small
8151 #% Do not delete the line below; configure depends on this 
8152 \end_layout
8153
8154 \begin_layout LyX-Code
8155
8156 \size small
8157 #  
8158 \backslash
8159 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8160 \end_layout
8161
8162 \begin_layout LyX-Code
8163
8164 \size small
8165 #  
8166 \backslash
8167 DeclareCategory{Articles}
8168 \end_layout
8169
8170 \begin_layout Standard
8171 This declares a text class 
8172 \begin_inset Flex Code
8173 status collapsed
8174
8175 \begin_layout Plain Layout
8176 myarticle
8177 \end_layout
8178
8179 \end_inset
8180
8181 , associated with the \SpecialChar LaTeX
8182  document class 
8183 \begin_inset Flex Code
8184 status collapsed
8185
8186 \begin_layout Plain Layout
8187 article.cls
8188 \end_layout
8189
8190 \end_inset
8191
8192  and described as 
8193 \begin_inset Quotes eld
8194 \end_inset
8195
8196 Article (with My Own Headings)
8197 \begin_inset Quotes erd
8198 \end_inset
8199
8200 .
8201  If your text class depends on several packages, you can declare it as:
8202 \end_layout
8203
8204 \begin_layout LyX-Code
8205
8206 \size small
8207 #% Do not delete the line below; configure depends on this 
8208 \end_layout
8209
8210 \begin_layout LyX-Code
8211
8212 \size small
8213 #  
8214 \backslash
8215 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8216 \end_layout
8217
8218 \begin_layout LyX-Code
8219
8220 \size small
8221 #  
8222 \backslash
8223 DeclareCategory{Articles}
8224 \end_layout
8225
8226 \begin_layout Standard
8227 This indicates that your text class uses the 
8228 \begin_inset Flex Code
8229 status collapsed
8230
8231 \begin_layout Plain Layout
8232 foo.sty
8233 \end_layout
8234
8235 \end_inset
8236
8237  package.
8238  Finally, it is also possible to declare classes for DocBook code.
8239  Typical declarations will look like:
8240 \end_layout
8241
8242 \begin_layout LyX-Code
8243
8244 \size small
8245 #% Do not delete the line below; configure depends on this 
8246 \end_layout
8247
8248 \begin_layout LyX-Code
8249
8250 \size small
8251
8252 \backslash
8253 DeclareDocBookClass[article]{SGML (DocBook Article)}
8254 \end_layout
8255
8256 \begin_layout LyX-Code
8257
8258 \size small
8259
8260 \backslash
8261 DeclareCategory{Articles (DocBook)}
8262 \end_layout
8263
8264 \begin_layout Standard
8265 Note that these declarations can also be given an optional parameter declaring
8266  the name of the document class (but not a list).
8267 \end_layout
8268
8269 \begin_layout Standard
8270 So, to be as explicit as possible, the form of the layout declaration is:
8271 \end_layout
8272
8273 \begin_layout LyX-Code
8274
8275 \size small
8276 #  
8277 \backslash
8278 DeclareLaTeXClass[class,package.sty]{layout description}
8279 \end_layout
8280
8281 \begin_layout LyX-Code
8282
8283 \size small
8284 #  
8285 \backslash
8286 DeclareCategory{category}
8287 \end_layout
8288
8289 \begin_layout Standard
8290 The class need only be specified if the name of the \SpecialChar LaTeX
8291  class file and the
8292  name of the layout file are different or if there are packages to load.
8293  If the name of the class file is not specified, then \SpecialChar LyX
8294  will simply assume
8295  that it is the same as the name of the layout file.
8296 \end_layout
8297
8298 \begin_layout Standard
8299 When the text class has been modified to your taste, all you have to do
8300  is to copy it either to 
8301 \begin_inset Flex Code
8302 status collapsed
8303
8304 \begin_layout Plain Layout
8305 LyXDir/layouts/
8306 \end_layout
8307
8308 \end_inset
8309
8310  or to 
8311 \begin_inset Flex Code
8312 status collapsed
8313
8314 \begin_layout Plain Layout
8315 UserDir/layouts
8316 \end_layout
8317
8318 \end_inset
8319
8320 , run 
8321 \begin_inset Flex Noun
8322 status collapsed
8323
8324 \begin_layout Plain Layout
8325 Tools\SpecialChar menuseparator
8326 Reconfigure
8327 \end_layout
8328
8329 \end_inset
8330
8331 , exit \SpecialChar LyX
8332  and restart.
8333  Then your new text class should be available along with the others.
8334 \end_layout
8335
8336 \begin_layout Standard
8337 Once the layout file is installed, you can edit it and see your changes
8338  without having to reconfigure or to restart \SpecialChar LyX
8339 .
8340  
8341 \begin_inset Foot
8342 status collapsed
8343
8344 \begin_layout Plain Layout
8345 In versions of \SpecialChar LyX
8346  prior to 1.6, this was not true.
8347  As a result, editing layout files was very time consuming, since you had
8348  constantly to restart \SpecialChar LyX
8349  to see changes.
8350 \end_layout
8351
8352 \end_inset
8353
8354  You can force a reload of the current layout by using the \SpecialChar LyX
8355  function 
8356 \begin_inset Flex Noun
8357 status collapsed
8358
8359 \begin_layout Plain Layout
8360 layout-reload
8361 \end_layout
8362
8363 \end_inset
8364
8365 .
8366  There is no default binding for this function—though, of course, you can
8367  bind it to a key yourself.
8368  But you will normally use this function simply by entering it in the mini-buffe
8369 r.
8370  
8371 \end_layout
8372
8373 \begin_layout Standard
8374
8375 \emph on
8376 Warning
8377 \emph default
8378
8379 \begin_inset Flex Noun
8380 status collapsed
8381
8382 \begin_layout Plain Layout
8383 layout-reload
8384 \end_layout
8385
8386 \end_inset
8387
8388  is very much an `advanced feature'.
8389  It is 
8390 \emph on
8391 strongly
8392 \emph default
8393  recommended that you save your work before using this function.
8394  In fact, it is 
8395 \emph on
8396 strongly
8397 \emph default
8398  recommended that you not attempt to edit layout information while simultaneousl
8399 y working on a document that you care about.
8400  Use a test document.
8401  Syntax errors and the like in your layout file could cause peculiar behavior.
8402  In particular, such errors could cause \SpecialChar LyX
8403  to regard the current layout as
8404  invalid and to attempt to switch to some other layout.
8405 \begin_inset Foot
8406 status collapsed
8407
8408 \begin_layout Plain Layout
8409 Really bad syntax errors may even caused \SpecialChar LyX
8410  to exit.
8411  This is because certain sorts of errors may make \SpecialChar LyX
8412  unable to read 
8413 \emph on
8414 any
8415 \emph default
8416  layout information.
8417  Please be careful.
8418 \end_layout
8419
8420 \end_inset
8421
8422  The \SpecialChar LyX
8423  team strives to keep \SpecialChar LyX
8424  stable in such situations, but safe is better
8425  than sorry.
8426 \begin_inset Foot
8427 status collapsed
8428
8429 \begin_layout Plain Layout
8430 While we're giving advice: make regular backups.
8431  And be nice to your mother.
8432 \end_layout
8433
8434 \end_inset
8435
8436
8437 \end_layout
8438
8439 \begin_layout Subsection
8440 The Module declaration
8441 \end_layout
8442
8443 \begin_layout Standard
8444 A module must begin with a line like the following:
8445 \end_layout
8446
8447 \begin_layout LyX-Code
8448 #
8449 \backslash
8450 DeclareLyXModule[endnotes.sty]{Endnotes} 
8451 \end_layout
8452
8453 \begin_layout Standard
8454 The mandatory argument, in curly brackets, is the name of the module, as
8455  it should appear in 
8456 \begin_inset Flex Noun
8457 status collapsed
8458
8459 \begin_layout Plain Layout
8460 Document\SpecialChar menuseparator
8461 Settings\SpecialChar menuseparator
8462 Modules
8463 \end_layout
8464
8465 \end_inset
8466
8467 .
8468  The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8469  packages
8470  on which the module depends.
8471  It is also possible to use the form 
8472 \begin_inset Flex Noun
8473 status collapsed
8474
8475 \begin_layout Plain Layout
8476 from->to
8477 \end_layout
8478
8479 \end_inset
8480
8481  as an optional argument, which declares that the module can only be used
8482  when there exists a conversion chain between the formats `
8483 \begin_inset Flex Code
8484 status collapsed
8485
8486 \begin_layout Plain Layout
8487 from
8488 \end_layout
8489
8490 \end_inset
8491
8492 ' and `
8493 \begin_inset Flex Code
8494 status collapsed
8495
8496 \begin_layout Plain Layout
8497 to
8498 \end_layout
8499
8500 \end_inset
8501
8502 '.
8503 \end_layout
8504
8505 \begin_layout Standard
8506 The module declaration should then be followed by lines like the following
8507 \begin_inset Foot
8508 status collapsed
8509
8510 \begin_layout Plain Layout
8511 Preferably in English if the module should be published with \SpecialChar LyX
8512 .
8513  This description will appear in the list of messages to be translated and
8514  will be thus translated with the next interface update.
8515 \end_layout
8516
8517 \end_inset
8518
8519 :
8520 \end_layout
8521
8522 \begin_layout LyX-Code
8523 #DescriptionBegin 
8524 \end_layout
8525
8526 \begin_layout LyX-Code
8527 #Adds an endnote command, in addition to footnotes.
8528  
8529 \end_layout
8530
8531 \begin_layout LyX-Code
8532 #You will need to add  
8533 \backslash
8534 theendnotes in TeX code where you 
8535 \end_layout
8536
8537 \begin_layout LyX-Code
8538 #want the endnotes to appear.
8539  
8540 \end_layout
8541
8542 \begin_layout LyX-Code
8543 #DescriptionEnd 
8544 \end_layout
8545
8546 \begin_layout LyX-Code
8547 #Requires: somemodule | othermodule
8548 \end_layout
8549
8550 \begin_layout LyX-Code
8551 #Excludes: badmodule
8552 \end_layout
8553
8554 \begin_layout Standard
8555 The description is used in 
8556 \begin_inset Flex Noun
8557 status collapsed
8558
8559 \begin_layout Plain Layout
8560 Document\SpecialChar menuseparator
8561 Settings\SpecialChar menuseparator
8562 Modules
8563 \end_layout
8564
8565 \end_inset
8566
8567  to provide the user with information about what the module does.
8568  The 
8569 \begin_inset Flex Code
8570 status collapsed
8571
8572 \begin_layout Plain Layout
8573 Requires
8574 \end_layout
8575
8576 \end_inset
8577
8578  line is used to identify other modules with which this one must be used;
8579  the 
8580 \begin_inset Flex Code
8581 status collapsed
8582
8583 \begin_layout Plain Layout
8584 Excludes
8585 \end_layout
8586
8587 \end_inset
8588
8589  line is used to identify modules with which this one may not be used.
8590  Both are optional, and, as shown, multiple modules should be separated
8591  with the pipe symbol: |.
8592  Note that the required modules are treated disjunctively: 
8593 \emph on
8594 at least one
8595 \emph default
8596  of the required modules must be used.
8597  Similarly, 
8598 \emph on
8599 no
8600 \emph default
8601  excluded module may be used.
8602  Note that modules are identified here by their filenames without the 
8603 \begin_inset Flex Code
8604 status collapsed
8605
8606 \begin_layout Plain Layout
8607 .module
8608 \end_layout
8609
8610 \end_inset
8611
8612  extension.
8613  So 
8614 \begin_inset Flex Code
8615 status collapsed
8616
8617 \begin_layout Plain Layout
8618 somemodule
8619 \end_layout
8620
8621 \end_inset
8622
8623  is really 
8624 \begin_inset Flex Code
8625 status collapsed
8626
8627 \begin_layout Plain Layout
8628 somemodule.module
8629 \end_layout
8630
8631 \end_inset
8632
8633 .
8634 \change_inserted -712698321 1483873000
8635
8636 \end_layout
8637
8638 \begin_layout Subsection
8639
8640 \change_inserted -712698321 1483873010
8641 The CiteEngine file declaration
8642 \end_layout
8643
8644 \begin_layout Standard
8645
8646 \change_inserted -712698321 1483873022
8647 A cite engine file must begin with a line like the following:
8648 \end_layout
8649
8650 \begin_layout LyX-Code
8651
8652 \change_inserted -712698321 1483873047
8653 #
8654 \backslash
8655 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8656 \end_layout
8657
8658 \begin_layout Standard
8659
8660 \change_inserted -712698321 1483873077
8661 The mandatory argument, in curly brackets, is the name of the module, as
8662  it should appear in 
8663 \begin_inset Flex Noun
8664 status collapsed
8665
8666 \begin_layout Plain Layout
8667
8668 \change_inserted -712698321 1483873068
8669 Document\SpecialChar menuseparator
8670 Settings\SpecialChar menuseparator
8671 Bibliography
8672 \end_layout
8673
8674 \end_inset
8675
8676 .
8677  The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8678  packages
8679  on which the cite engine depends.
8680 \end_layout
8681
8682 \begin_layout Standard
8683
8684 \change_inserted -712698321 1483873102
8685 The cite engine declaration should then be followed by lines like the following
8686 \begin_inset Foot
8687 status collapsed
8688
8689 \begin_layout Plain Layout
8690
8691 \change_inserted -712698321 1483873000
8692 Preferably in English if the module should be published with \SpecialChar LyX
8693 .
8694  This description will appear in the list of messages to be translated and
8695  will be thus translated with the next interface update.
8696 \end_layout
8697
8698 \end_inset
8699
8700 :
8701 \end_layout
8702
8703 \begin_layout LyX-Code
8704
8705 \change_inserted -712698321 1483873128
8706 # DescriptionBegin
8707 \end_layout
8708
8709 \begin_layout LyX-Code
8710
8711 \change_inserted -712698321 1483873140
8712 #   Biblatex supports many author-year and numerical styles.
8713 \end_layout
8714
8715 \begin_layout LyX-Code
8716
8717 \change_inserted -712698321 1483873152
8718 #   It is mainly aimed at the Humanities.
8719  It is highly
8720 \end_layout
8721
8722 \begin_layout LyX-Code
8723
8724 \change_inserted -712698321 1483873160
8725 #   customizable, fully localized and provides many features
8726 \end_layout
8727
8728 \begin_layout LyX-Code
8729
8730 \change_inserted -712698321 1483873170
8731 #   that are not possible with BibTeX.
8732  The use of 'biber' as
8733 \end_layout
8734
8735 \begin_layout LyX-Code
8736
8737 \change_inserted -712698321 1483873174
8738 #   bibliography processor is advised.
8739 \end_layout
8740
8741 \begin_layout LyX-Code
8742
8743 \change_inserted -712698321 1483873224
8744 # DescriptionEnd
8745 \end_layout
8746
8747 \begin_layout Standard
8748
8749 \change_inserted -712698321 1483873207
8750 The description is used in 
8751 \begin_inset Flex Noun
8752 status collapsed
8753
8754 \begin_layout Plain Layout
8755
8756 \change_inserted -712698321 1483873194
8757 Document\SpecialChar menuseparator
8758 Settings\SpecialChar menuseparator
8759 Bibliography
8760 \end_layout
8761
8762 \end_inset
8763
8764  to provide the user with information about the cite engine.
8765 \change_unchanged
8766
8767 \end_layout
8768
8769 \begin_layout Subsection
8770 Format number
8771 \end_layout
8772
8773 \begin_layout Standard
8774 The first non-comment line of any layout file, included file, or module
8775  
8776 \emph on
8777 must
8778 \emph default
8779  contain the file format number:
8780 \end_layout
8781
8782 \begin_layout Description
8783 \begin_inset Flex Code
8784 status collapsed
8785
8786 \begin_layout Plain Layout
8787 Format
8788 \end_layout
8789
8790 \end_inset
8791
8792  [
8793 \begin_inset Flex Code
8794 status collapsed
8795
8796 \begin_layout Plain Layout
8797 int
8798 \end_layout
8799
8800 \end_inset
8801
8802 ] The format number of the layout file.
8803 \end_layout
8804
8805 \begin_layout Standard
8806 This tag was introduced with \SpecialChar LyX
8807
8808 \begin_inset space ~
8809 \end_inset
8810
8811 1.4.0.
8812  Layout files from older \SpecialChar LyX
8813  versions do not have an explicit file format and
8814  are considered to have 
8815 \begin_inset Flex Code
8816 status collapsed
8817
8818 \begin_layout Plain Layout
8819 Format
8820 \begin_inset space ~
8821 \end_inset
8822
8823 1
8824 \end_layout
8825
8826 \end_inset
8827
8828 .
8829  The format for the present version of \SpecialChar LyX
8830  is format 60.
8831  But each version of \SpecialChar LyX
8832  is capable of reading earlier versions' layout files,
8833  just as they are capable of reading files produced by earlier versions
8834  of \SpecialChar LyX
8835 .
8836  There is, however, no provision for converting to earlier formats.
8837 \end_layout
8838
8839 \begin_layout Subsection
8840 \begin_inset CommandInset label
8841 LatexCommand label
8842 name "subsec:General-text-class"
8843
8844 \end_inset
8845
8846 General text class parameters
8847 \end_layout
8848
8849 \begin_layout Standard
8850 These are general parameters that govern the behavior of an entire document
8851  class.
8852  (This does 
8853 \emph on
8854 not
8855 \emph default
8856  mean that they must appear in 
8857 \begin_inset Flex Code
8858 status collapsed
8859
8860 \begin_layout Plain Layout
8861 .layout
8862 \end_layout
8863
8864 \end_inset
8865
8866  files rather than in modules.
8867  A module can contain any layout tag.)
8868 \end_layout
8869
8870 \begin_layout Description
8871 \begin_inset Flex Code
8872 status collapsed
8873
8874 \begin_layout Plain Layout
8875 AddToHTMLPreamble
8876 \end_layout
8877
8878 \end_inset
8879
8880  Adds information that will be output in the 
8881 \begin_inset Flex Code
8882 status collapsed
8883
8884 \begin_layout Plain Layout
8885 <head>
8886 \end_layout
8887
8888 \end_inset
8889
8890  block when the document is output to XHTML.
8891  Typically, this would be used to output CSS style information, but it can
8892  be used for anything that can appear in 
8893 \begin_inset Flex Code
8894 status collapsed
8895
8896 \begin_layout Plain Layout
8897 <head>
8898 \end_layout
8899
8900 \end_inset
8901
8902 .
8903  Must end with 
8904 \begin_inset Quotes eld
8905 \end_inset
8906
8907
8908 \begin_inset Flex Code
8909 status collapsed
8910
8911 \begin_layout Plain Layout
8912 EndPreamble
8913 \end_layout
8914
8915 \end_inset
8916
8917
8918 \begin_inset Quotes erd
8919 \end_inset
8920
8921 .
8922 \end_layout
8923
8924 \begin_layout Description
8925 \begin_inset Flex Code
8926 status collapsed
8927
8928 \begin_layout Plain Layout
8929 AddToPreamble
8930 \end_layout
8931
8932 \end_inset
8933
8934  Adds information to the document preamble.
8935  Must end with
8936 \begin_inset Newline newline
8937 \end_inset
8938
8939
8940 \begin_inset Quotes eld
8941 \end_inset
8942
8943
8944 \begin_inset Flex Code
8945 status collapsed
8946
8947 \begin_layout Plain Layout
8948 EndPreamble
8949 \end_layout
8950
8951 \end_inset
8952
8953
8954 \begin_inset Quotes erd
8955 \end_inset
8956
8957 .
8958 \change_inserted -712698321 1483872509
8959
8960 \end_layout
8961
8962 \begin_layout Description
8963
8964 \change_inserted -712698321 1483874560
8965 \begin_inset Flex Code
8966 status collapsed
8967
8968 \begin_layout Plain Layout
8969
8970 \change_inserted -712698321 1483872558
8971 CiteEngine <engine>
8972 \end_layout
8973
8974 \end_inset
8975
8976  Defines the possibilities for displaying citation references.
8977  See 
8978 \begin_inset CommandInset ref
8979 LatexCommand ref
8980 reference "subsec:Citation-engine-description"
8981 plural "false"
8982 caps "false"
8983 noprefix "false"
8984
8985 \end_inset
8986
8987  for details.
8988  Must end with 
8989 \begin_inset Quotes eld
8990 \end_inset
8991
8992
8993 \begin_inset Flex Code
8994 status collapsed
8995
8996 \begin_layout Plain Layout
8997
8998 \change_inserted -712698321 1483872548
8999 End
9000 \end_layout
9001
9002 \end_inset
9003
9004
9005 \begin_inset Quotes erd
9006 \end_inset
9007
9008 .
9009  Primarily used in cite engine files (see 
9010 \begin_inset CommandInset ref
9011 LatexCommand ref
9012 reference "subsec:Cite-Engine-Files"
9013 plural "false"
9014 caps "false"
9015 noprefix "false"
9016
9017 \end_inset
9018
9019 ).
9020 \change_unchanged
9021
9022 \end_layout
9023
9024 \begin_layout Description
9025 \begin_inset Flex Code
9026 status collapsed
9027
9028 \begin_layout Plain Layout
9029 CiteFormat
9030 \end_layout
9031
9032 \end_inset
9033
9034  Defines formats for use in the display of bibliographic information.
9035  See 
9036 \begin_inset CommandInset ref
9037 LatexCommand ref
9038 reference "subsec:Citation-format-description"
9039
9040 \end_inset
9041
9042  for details.
9043  Must end with 
9044 \begin_inset Quotes eld
9045 \end_inset
9046
9047
9048 \begin_inset Flex Code
9049 status collapsed
9050
9051 \begin_layout Plain Layout
9052 End
9053 \end_layout
9054
9055 \end_inset
9056
9057
9058 \begin_inset Quotes erd
9059 \end_inset
9060
9061 .
9062
9063 \change_inserted -712698321 1483875199
9064  Primarily used in cite engine files (see 
9065 \begin_inset CommandInset ref
9066 LatexCommand ref
9067 reference "subsec:Cite-Engine-Files"
9068 plural "false"
9069 caps "false"
9070 noprefix "false"
9071
9072 \end_inset
9073
9074 ).
9075 \change_unchanged
9076
9077 \end_layout
9078
9079 \begin_layout Description
9080
9081 \change_inserted -712698321 1483874578
9082 \begin_inset Flex Code
9083 status collapsed
9084
9085 \begin_layout Plain Layout
9086
9087 \change_inserted -712698321 1483872820
9088 CiteFramework
9089 \end_layout
9090
9091 \end_inset
9092
9093  [
9094 \begin_inset Flex Code
9095 status collapsed
9096
9097 \begin_layout Plain Layout
9098
9099 \change_inserted -712698321 1483872852
9100
9101 \emph on
9102 bibtex
9103 \change_unchanged
9104
9105 \end_layout
9106
9107 \end_inset
9108
9109 ,
9110 \begin_inset Flex Code
9111 status collapsed
9112
9113 \begin_layout Plain Layout
9114
9115 \change_inserted -712698321 1483872857
9116 biblatex
9117 \change_unchanged
9118
9119 \end_layout
9120
9121 \end_inset
9122
9123 ] Determines whether 
9124 \family sans
9125 Biblatex
9126 \family default
9127  or Bib\SpecialChar TeX
9128  is used to generate a Bibliography.
9129  Primarily used in cite engine files (see 
9130 \begin_inset CommandInset ref
9131 LatexCommand ref
9132 reference "subsec:Cite-Engine-Files"
9133 plural "false"
9134 caps "false"
9135 noprefix "false"
9136
9137 \end_inset
9138
9139 ).
9140 \change_unchanged
9141
9142 \end_layout
9143
9144 \begin_layout Description
9145 \begin_inset Flex Code
9146 status collapsed
9147
9148 \begin_layout Plain Layout
9149 ClassOptions
9150 \end_layout
9151
9152 \end_inset
9153
9154  Describes various global options supported by the document class.
9155  See 
9156 \begin_inset CommandInset ref
9157 LatexCommand ref
9158 reference "subsec:ClassOptions"
9159
9160 \end_inset
9161
9162  for a description.
9163  Must end with 
9164 \begin_inset Quotes eld
9165 \end_inset
9166
9167
9168 \begin_inset Flex Code
9169 status collapsed
9170
9171 \begin_layout Plain Layout
9172 End
9173 \end_layout
9174
9175 \end_inset
9176
9177
9178 \begin_inset Quotes erd
9179 \end_inset
9180
9181 .
9182 \end_layout
9183
9184 \begin_layout Description
9185 \begin_inset Flex Code
9186 status collapsed
9187
9188 \begin_layout Plain Layout
9189 Columns
9190 \end_layout
9191
9192 \end_inset
9193
9194  [
9195 \begin_inset Flex Code
9196 status collapsed
9197
9198 \begin_layout Plain Layout
9199
9200 \emph on
9201 1
9202 \end_layout
9203
9204 \end_inset
9205
9206 ,
9207 \begin_inset space \thinspace{}
9208 \end_inset
9209
9210
9211 \begin_inset Flex Code
9212 status collapsed
9213
9214 \begin_layout Plain Layout
9215 2
9216 \end_layout
9217
9218 \end_inset
9219
9220 ] Whether the class should 
9221 \emph on
9222 default
9223 \emph default
9224  to having one or two columns.
9225  Can be changed in the 
9226 \begin_inset Flex Noun
9227 status collapsed
9228
9229 \begin_layout Plain Layout
9230 Document\SpecialChar menuseparator
9231 Settings
9232 \end_layout
9233
9234 \end_inset
9235
9236  dialog.
9237 \end_layout
9238
9239 \begin_layout Description
9240 \begin_inset Flex Code
9241 status collapsed
9242
9243 \begin_layout Plain Layout
9244 Counter
9245 \end_layout
9246
9247 \end_inset
9248
9249  [
9250 \begin_inset Flex Code
9251 status collapsed
9252
9253 \begin_layout Plain Layout
9254 string
9255 \end_layout
9256
9257 \end_inset
9258
9259 ] This sequence defines the properties for a counter.
9260  If the counter does not yet exist, it is created; if it does exist, it
9261  is modified.
9262  Must end with 
9263 \begin_inset Quotes eld
9264 \end_inset
9265
9266
9267 \begin_inset Flex Code
9268 status collapsed
9269
9270 \begin_layout Plain Layout
9271 End
9272 \end_layout
9273
9274 \end_inset
9275
9276
9277 \begin_inset Quotes erd
9278 \end_inset
9279
9280 .
9281 \begin_inset Newline newline
9282 \end_inset
9283
9284 See 
9285 \begin_inset CommandInset ref
9286 LatexCommand ref
9287 reference "subsec:Counters"
9288
9289 \end_inset
9290
9291  for details on counters.
9292 \end_layout
9293
9294 \begin_layout Description
9295 \begin_inset Flex Code
9296 status collapsed
9297
9298 \begin_layout Plain Layout
9299 DefaultFont
9300 \end_layout
9301
9302 \end_inset
9303
9304  Sets the default font used to display the document.
9305  See 
9306 \begin_inset CommandInset ref
9307 LatexCommand ref
9308 reference "subsec:Font-description"
9309
9310 \end_inset
9311
9312  for how to declare fonts.
9313  Must end with 
9314 \begin_inset Quotes eld
9315 \end_inset
9316
9317
9318 \begin_inset Flex Code
9319 status collapsed
9320
9321 \begin_layout Plain Layout
9322 EndFont
9323 \end_layout
9324
9325 \end_inset
9326
9327
9328 \begin_inset Quotes erd
9329 \end_inset
9330
9331 .
9332 \end_layout
9333
9334 \begin_layout Description
9335 \begin_inset Flex Code
9336 status collapsed
9337
9338 \begin_layout Plain Layout
9339 DefaultModule
9340 \end_layout
9341
9342 \end_inset
9343
9344  [
9345 \begin_inset Flex Code
9346 status collapsed
9347
9348 \begin_layout Plain Layout
9349 <module>
9350 \end_layout
9351
9352 \end_inset
9353
9354 ] Specifies a module to be included by default with this document class.
9355  The module is specified as filename without the 
9356 \begin_inset Flex Code
9357 status collapsed
9358
9359 \begin_layout Plain Layout
9360 .module
9361 \end_layout
9362
9363 \end_inset
9364
9365  extension.
9366  The user can still remove the module, but it will be active at the outset.
9367  (This applies only when new files are created, or when this class is chosen
9368  for an existing document.)
9369 \end_layout
9370
9371 \begin_layout Description
9372 \begin_inset Flex Code
9373 status collapsed
9374
9375 \begin_layout Plain Layout
9376 DefaultStyle
9377 \end_layout
9378
9379 \end_inset
9380
9381  [
9382 \begin_inset Flex Code
9383 status collapsed
9384
9385 \begin_layout Plain Layout
9386 <style>
9387 \end_layout
9388
9389 \end_inset
9390
9391 ] This is the style that will be assigned to new paragraphs, usually 
9392 \begin_inset Flex Noun
9393 status collapsed
9394
9395 \begin_layout Plain Layout
9396 Standard
9397 \end_layout
9398
9399 \end_inset
9400
9401 .
9402  This will default to the first defined style if not given, but you are
9403  encouraged to use this directive.
9404 \end_layout
9405
9406 \begin_layout Description
9407 \begin_inset Flex Code
9408 status collapsed
9409
9410 \begin_layout Plain Layout
9411 ExcludesModule
9412 \end_layout
9413
9414 \end_inset
9415
9416  [
9417 \begin_inset Flex Code
9418 status collapsed
9419
9420 \begin_layout Plain Layout
9421 <module>
9422 \end_layout
9423
9424 \end_inset
9425
9426 ] This tag indicates that the module (which is specified by filename without
9427  the 
9428 \begin_inset Flex Code
9429 status collapsed
9430
9431 \begin_layout Plain Layout
9432 .module
9433 \end_layout
9434
9435 \end_inset
9436
9437  extension) cannot be used with this document class.
9438  This might be used in a journal-specific layout file to prevent, say, the
9439  use of the 
9440 \begin_inset Flex Code
9441 status collapsed
9442
9443 \begin_layout Plain Layout
9444 theorems-sec
9445 \end_layout
9446
9447 \end_inset
9448
9449  module that numbers theorems by section.
9450  This tag may 
9451 \emph on
9452 not
9453 \emph default
9454  be used in a module.
9455  Modules have their own way of excluding other modules (see 
9456 \begin_inset CommandInset ref
9457 LatexCommand ref
9458 reference "subsec:Layout-modules"
9459
9460 \end_inset
9461
9462 ).
9463 \end_layout
9464
9465 \begin_layout Description
9466 \begin_inset Flex Code
9467 status collapsed
9468
9469 \begin_layout Plain Layout
9470 Float
9471 \end_layout
9472
9473 \end_inset
9474
9475  Defines a new float.
9476  See 
9477 \begin_inset CommandInset ref
9478 LatexCommand ref
9479 reference "subsec:Floats"
9480
9481 \end_inset
9482
9483  for details.
9484  Must end with 
9485 \begin_inset Quotes eld
9486 \end_inset
9487
9488
9489 \begin_inset Flex Code
9490 status collapsed
9491
9492 \begin_layout Plain Layout
9493 End
9494 \end_layout
9495
9496 \end_inset
9497
9498
9499 \begin_inset Quotes erd
9500 \end_inset
9501
9502 .
9503 \end_layout
9504
9505 \begin_layout Description
9506 \begin_inset Flex Code
9507 status collapsed
9508
9509 \begin_layout Plain Layout
9510 HTMLPreamble
9511 \end_layout
9512
9513 \end_inset
9514
9515  Sets the information that will be output in the 
9516 \begin_inset Flex Code
9517 status collapsed
9518
9519 \begin_layout Plain Layout
9520 <head>
9521 \end_layout
9522
9523 \end_inset
9524
9525  block when this document class is output to XHTML.
9526  Note that this will completely override any prior 
9527 \begin_inset Flex Code
9528 status collapsed
9529
9530 \begin_layout Plain Layout
9531 HTMLPreamble
9532 \end_layout
9533
9534 \end_inset
9535
9536  or 
9537 \begin_inset Flex Code
9538 status collapsed
9539
9540 \begin_layout Plain Layout
9541 AddToHTMLPreamble
9542 \end_layout
9543
9544 \end_inset
9545
9546  declarations.
9547  (Use
9548 \begin_inset Newline newline
9549 \end_inset
9550
9551
9552 \begin_inset Flex Code
9553 status collapsed
9554
9555 \begin_layout Plain Layout
9556 AddToHTMLPreamble
9557 \end_layout
9558
9559 \end_inset
9560
9561  if you just want to add material to the preamble.) Must end with 
9562 \begin_inset Quotes eld
9563 \end_inset
9564
9565
9566 \begin_inset Flex Code
9567 status collapsed
9568
9569 \begin_layout Plain Layout
9570 EndPreamble
9571 \end_layout
9572
9573 \end_inset
9574
9575
9576 \begin_inset Quotes erd
9577 \end_inset
9578
9579 .
9580 \end_layout
9581
9582 \begin_layout Description
9583 \begin_inset Flex Code
9584 status collapsed
9585
9586 \begin_layout Plain Layout
9587 HTMLTOCSection
9588 \end_layout
9589
9590 \end_inset
9591
9592  [
9593 \begin_inset Flex Code
9594 status collapsed
9595
9596 \begin_layout Plain Layout
9597 <style>
9598 \end_layout
9599
9600 \end_inset
9601
9602 ] The style to use for the table of contents, bibliography, and so forth,
9603  when the document is output to HTML.
9604  For articles, this should normally be 
9605 \begin_inset Flex Code
9606 status collapsed
9607
9608 \begin_layout Plain Layout
9609 Section
9610 \end_layout
9611
9612 \end_inset
9613
9614 ; for books 
9615 \begin_inset Flex Code
9616 status collapsed
9617
9618 \begin_layout Plain Layout
9619 Chapter
9620 \end_layout
9621
9622 \end_inset
9623
9624 .
9625  If it is not given, then \SpecialChar LyX
9626  will attempt to figure out which layout to use.
9627 \end_layout
9628
9629 \begin_layout Description
9630 \begin_inset Flex Code
9631 status collapsed
9632
9633 \begin_layout Plain Layout
9634 IfCounter
9635 \end_layout
9636
9637 \end_inset
9638
9639  [
9640 \begin_inset Flex Code
9641 status collapsed
9642
9643 \begin_layout Plain Layout
9644 <counter>
9645 \end_layout
9646
9647 \end_inset
9648
9649 ] Modifies the properties of the given counter.
9650  If the counter does not exist, the statement is ignored.
9651  Must end with 
9652 \begin_inset Quotes eld
9653 \end_inset
9654
9655
9656 \begin_inset Flex Code
9657 status collapsed
9658
9659 \begin_layout Plain Layout
9660 End
9661 \end_layout
9662
9663 \end_inset
9664
9665
9666 \begin_inset Quotes erd
9667 \end_inset
9668
9669 .
9670 \begin_inset Newline newline
9671 \end_inset
9672
9673 See 
9674 \begin_inset CommandInset ref
9675 LatexCommand ref
9676 reference "subsec:Counters"
9677
9678 \end_inset
9679
9680  for details on counters.
9681 \end_layout
9682
9683 \begin_layout Description
9684 \begin_inset Flex Code
9685 status collapsed
9686
9687 \begin_layout Plain Layout
9688 Input
9689 \end_layout
9690
9691 \end_inset
9692
9693  [
9694 \begin_inset Flex Code
9695 status collapsed
9696
9697 \begin_layout Plain Layout
9698 <filename>
9699 \end_layout
9700
9701 \end_inset
9702
9703 ] This allows you to include another layout definition file within yours
9704  to avoid duplicating commands.
9705  Common examples are the standard layout files, for example, 
9706 \begin_inset Flex Code
9707 status collapsed
9708
9709 \begin_layout Plain Layout
9710 stdclass.inc
9711 \end_layout
9712
9713 \end_inset
9714
9715 , which contains most of the basic layouts.
9716 \end_layout
9717
9718 \begin_layout Description
9719 \begin_inset Flex Code
9720 status collapsed
9721
9722 \begin_layout Plain Layout
9723 InsetLayout
9724 \end_layout
9725
9726 \end_inset
9727
9728  [
9729 \begin_inset Flex Code
9730 status collapsed
9731
9732 \begin_layout Plain Layout
9733 <type>
9734 \end_layout
9735
9736 \end_inset
9737
9738 ] This section (re-)defines the layout of an inset.
9739  It can be applied to an existing inset or to a new, user-defined inset,
9740  e.g., a new character style.
9741  Must end with 
9742 \begin_inset Quotes eld
9743 \end_inset
9744
9745
9746 \begin_inset Flex Code
9747 status collapsed
9748
9749 \begin_layout Plain Layout
9750 End
9751 \end_layout
9752
9753 \end_inset
9754
9755
9756 \begin_inset Quotes erd
9757 \end_inset
9758
9759 .
9760 \begin_inset Newline newline
9761 \end_inset
9762
9763 See 
9764 \begin_inset CommandInset ref
9765 LatexCommand ref
9766 reference "subsec:Flex-insets-and"
9767
9768 \end_inset
9769
9770  for more information.
9771  
9772 \end_layout
9773
9774 \begin_layout Description
9775 \begin_inset Flex Code
9776 status collapsed
9777
9778 \begin_layout Plain Layout
9779 LeftMargin
9780 \end_layout
9781
9782 \end_inset
9783
9784  [
9785 \begin_inset Flex Code
9786 status collapsed
9787
9788 \begin_layout Plain Layout
9789 string
9790 \end_layout
9791
9792 \end_inset
9793
9794 ] A string that indicates the width of the left margin on the screen, for
9795  example, 
9796 \begin_inset Quotes eld
9797 \end_inset
9798
9799
9800 \begin_inset Flex Code
9801 status collapsed
9802
9803 \begin_layout Plain Layout
9804 MMMMM
9805 \end_layout
9806
9807 \end_inset
9808
9809
9810 \begin_inset Quotes erd
9811 \end_inset
9812
9813 .
9814  (Note that this is not a `length', like 
9815 \begin_inset Quotes eld
9816 \end_inset
9817
9818 2ex
9819 \begin_inset Quotes erd
9820 \end_inset
9821
9822 .)
9823 \change_inserted -712698321 1483872681
9824
9825 \end_layout
9826
9827 \begin_layout Description
9828
9829 \change_inserted -712698321 1483874598
9830 \begin_inset Flex Code
9831 status collapsed
9832
9833 \begin_layout Plain Layout
9834
9835 \change_inserted -712698321 1483872687
9836 MaxCiteNames
9837 \end_layout
9838
9839 \end_inset
9840
9841  [
9842 \begin_inset Flex Code
9843 status collapsed
9844
9845 \begin_layout Plain Layout
9846
9847 \change_inserted -712698321 1483872692
9848 integer
9849 \end_layout
9850
9851 \end_inset
9852
9853 ] An integer that determines the maximal number of names displayed in an
9854  author-year citation before the citation switches to 
9855 \begin_inset Quotes eld
9856 \end_inset
9857
9858 FirstAuthor et al.
9859 \begin_inset Quotes erd
9860 \end_inset
9861
9862 .
9863  Primarily used in cite engine files (see 
9864 \begin_inset CommandInset ref
9865 LatexCommand ref
9866 reference "subsec:Cite-Engine-Files"
9867 plural "false"
9868 caps "false"
9869 noprefix "false"
9870
9871 \end_inset
9872
9873 ).
9874 \change_unchanged
9875
9876 \end_layout
9877
9878 \begin_layout Description
9879 \begin_inset Flex Code
9880 status collapsed
9881
9882 \begin_layout Plain Layout
9883 ModifyStyle
9884 \end_layout
9885
9886 \end_inset
9887
9888  [
9889 \begin_inset Flex Code
9890 status collapsed
9891
9892 \begin_layout Plain Layout
9893 <style>
9894 \end_layout
9895
9896 \end_inset
9897
9898 ] Modifies the properties of the given paragraph style.
9899  If the style does not exist, this section is ignored.
9900  Must end with 
9901 \begin_inset Quotes eld
9902 \end_inset
9903
9904
9905 \begin_inset Flex Code
9906 status collapsed
9907
9908 \begin_layout Plain Layout
9909 End
9910 \end_layout
9911
9912 \end_inset
9913
9914
9915 \begin_inset Quotes erd
9916 \end_inset
9917
9918 .
9919 \end_layout
9920
9921 \begin_layout Description
9922 \begin_inset Flex Code
9923 status collapsed
9924
9925 \begin_layout Plain Layout
9926 NoCounter
9927 \end_layout
9928
9929 \end_inset
9930
9931  [
9932 \begin_inset Flex Code
9933 status collapsed
9934
9935 \begin_layout Plain Layout
9936 <counter>
9937 \end_layout
9938
9939 \end_inset
9940
9941 ] Deletes an existing counter, usually one defined in an included file.
9942 \end_layout
9943
9944 \begin_layout Description
9945 \begin_inset Flex Code
9946 status collapsed
9947
9948 \begin_layout Plain Layout
9949 NoFloat
9950 \end_layout
9951
9952 \end_inset
9953
9954  [
9955 \begin_inset Flex Code
9956 status collapsed
9957
9958 \begin_layout Plain Layout
9959 <float>
9960 \end_layout
9961
9962 \end_inset
9963
9964 ] Deletes an existing float.
9965  This is particularly useful when you want to suppress a float that has
9966  been defined in an input file.
9967 \end_layout
9968
9969 \begin_layout Description
9970 \begin_inset Flex Code
9971 status collapsed
9972
9973 \begin_layout Plain Layout
9974 NoStyle
9975 \end_layout
9976
9977 \end_inset
9978
9979  [
9980 \begin_inset Flex Code
9981 status collapsed
9982
9983 \begin_layout Plain Layout
9984 <style>
9985 \end_layout
9986
9987 \end_inset
9988
9989 ] Deletes an existing style.
9990 \change_inserted 2047637253 1483900342
9991
9992 \end_layout
9993
9994 \begin_layout Description
9995
9996 \change_inserted 2047637253 1483900479
9997 \begin_inset Flex Code
9998 status collapsed
9999
10000 \begin_layout Plain Layout
10001
10002 \change_inserted 2047637253 1483900346
10003 OutlinerName
10004 \end_layout
10005
10006 \end_inset
10007
10008  [
10009 \begin_inset Flex Code
10010 status collapsed
10011
10012 \begin_layout Plain Layout
10013
10014 \change_inserted 2047637253 1483900369
10015 <type>
10016 \end_layout
10017
10018 \end_inset
10019
10020 ] [
10021 \begin_inset Flex Code
10022 status collapsed
10023
10024 \begin_layout Plain Layout
10025
10026 \change_inserted 2047637253 1483900418
10027 <string>
10028 \end_layout
10029
10030 \end_inset
10031
10032 ] Define a new table of contents with type 
10033 \begin_inset Flex Code
10034 status collapsed
10035
10036 \begin_layout Plain Layout
10037
10038 \change_inserted 2047637253 1483900414
10039 <type>
10040 \end_layout
10041
10042 \end_inset
10043
10044  and name 
10045 \begin_inset Flex Code
10046 status collapsed
10047
10048 \begin_layout Plain Layout
10049
10050 \change_inserted 2047637253 1483900419
10051 <string>
10052 \end_layout
10053
10054 \end_inset
10055
10056 .
10057  See also the AddToToc commands.
10058 \change_unchanged
10059
10060 \end_layout
10061
10062 \begin_layout Description
10063 \begin_inset Flex Code
10064 status collapsed
10065
10066 \begin_layout Plain Layout
10067 OutputFormat
10068 \end_layout
10069
10070 \end_inset
10071
10072  [
10073 \begin_inset Flex Code
10074 status collapsed
10075
10076 \begin_layout Plain Layout
10077 <format>
10078 \end_layout
10079
10080 \end_inset
10081
10082 ] The file format (as defined in the \SpecialChar LyX
10083  preferences) produced by this document
10084  class.
10085  It is mainly useful when 
10086 \begin_inset Flex Code
10087 status collapsed
10088
10089 \begin_layout Plain Layout
10090 OutputType
10091 \end_layout
10092
10093 \end_inset
10094
10095  is 
10096 \begin_inset Flex Code
10097 status collapsed
10098
10099 \begin_layout Plain Layout
10100 literate
10101 \end_layout
10102
10103 \end_inset
10104
10105  and one wants to define a new type of literate document.
10106  The format is reset to 
10107 \begin_inset Quotes eld
10108 \end_inset
10109
10110
10111 \begin_inset Flex Code
10112 status collapsed
10113
10114 \begin_layout Plain Layout
10115 docbook
10116 \end_layout
10117
10118 \end_inset
10119
10120
10121 \begin_inset Quotes erd
10122 \end_inset
10123
10124  or 
10125 \begin_inset Quotes eld
10126 \end_inset
10127
10128
10129 \begin_inset Flex Code
10130 status collapsed
10131
10132 \begin_layout Plain Layout
10133 latex
10134 \end_layout
10135
10136 \end_inset
10137
10138
10139 \begin_inset Quotes erd
10140 \end_inset
10141
10142  when the corresponding 
10143 \begin_inset Flex Code
10144 status collapsed
10145
10146 \begin_layout Plain Layout
10147 OutputType
10148 \end_layout
10149
10150 \end_inset
10151
10152  parameter is encountered.
10153 \end_layout
10154
10155 \begin_layout Description
10156 \begin_inset Flex Code
10157 status collapsed
10158
10159 \begin_layout Plain Layout
10160 OutputType
10161 \end_layout
10162
10163 \end_inset
10164
10165  [
10166 \begin_inset Flex Code
10167 status collapsed
10168
10169 \begin_layout Plain Layout
10170
10171 \emph on
10172 lat
10173 \emph default
10174 ex
10175 \end_layout
10176
10177 \end_inset
10178
10179
10180 \begin_inset Flex Code
10181 status collapsed
10182
10183 \begin_layout Plain Layout
10184 docbook
10185 \end_layout
10186
10187 \end_inset
10188
10189
10190 \begin_inset Flex Code
10191 status collapsed
10192
10193 \begin_layout Plain Layout
10194 literate
10195 \end_layout
10196
10197 \end_inset
10198
10199 ] Specifies what sort of output documents using this class will produce.
10200 \end_layout
10201
10202 \begin_layout Description
10203 \begin_inset Flex Code
10204 status collapsed
10205
10206 \begin_layout Plain Layout
10207 PackageOptions
10208 \end_layout
10209
10210 \end_inset
10211
10212  [
10213 \begin_inset Flex Code
10214 status collapsed
10215
10216 \begin_layout Plain Layout
10217 string
10218 \end_layout
10219
10220 \end_inset
10221
10222  
10223 \begin_inset Flex Code
10224 status collapsed
10225
10226 \begin_layout Plain Layout
10227 string
10228 \end_layout
10229
10230 \end_inset
10231
10232 ] Specifies options, given in the second string, for the package named by
10233  the first string.
10234  For example, 
10235 \begin_inset Quotes eld
10236 \end_inset
10237
10238
10239 \begin_inset Flex Code
10240 status collapsed
10241
10242 \begin_layout Plain Layout
10243 PackageOptions natbib square
10244 \end_layout
10245
10246 \end_inset
10247
10248
10249 \begin_inset Quotes erd
10250 \end_inset
10251
10252  will cause 
10253 \begin_inset Flex Code
10254 status collapsed
10255
10256 \begin_layout Plain Layout
10257 natbib
10258 \end_layout
10259
10260 \end_inset
10261
10262  to be loaded with the 
10263 \begin_inset Flex Code
10264 status collapsed
10265
10266 \begin_layout Plain Layout
10267 square
10268 \end_layout
10269
10270 \end_inset
10271
10272  option.
10273  (For \SpecialChar TeX
10274 perts, this causes \SpecialChar LyX
10275  to output: 
10276 \begin_inset Flex Code
10277 status collapsed
10278
10279 \begin_layout Plain Layout
10280
10281 \backslash
10282 PassOptionsToPackage{natbib}{square}
10283 \end_layout
10284
10285 \end_inset
10286
10287  prior to loading 
10288 \begin_inset Flex Code
10289 status collapsed
10290
10291 \begin_layout Plain Layout
10292 natbib
10293 \end_layout
10294
10295 \end_inset
10296
10297 .)
10298 \end_layout
10299
10300 \begin_layout Description
10301 \begin_inset Flex Code
10302 status collapsed
10303
10304 \begin_layout Plain Layout
10305 PageStyle
10306 \end_layout
10307
10308 \end_inset
10309
10310  [
10311 \begin_inset Flex Code
10312 status collapsed
10313
10314 \begin_layout Plain Layout
10315
10316 \emph on
10317 plain
10318 \end_layout
10319
10320 \end_inset
10321
10322
10323 \begin_inset Flex Code
10324 status collapsed
10325
10326 \begin_layout Plain Layout
10327 empty
10328 \end_layout
10329
10330 \end_inset
10331
10332
10333 \begin_inset Flex Code
10334 status collapsed
10335
10336 \begin_layout Plain Layout
10337 headings
10338 \end_layout
10339
10340 \end_inset
10341
10342 ] The default pagestyle.
10343  Can be changed in the 
10344 \begin_inset Flex Noun
10345 status collapsed
10346
10347 \begin_layout Plain Layout
10348 Document\SpecialChar menuseparator
10349 Settings
10350 \end_layout
10351
10352 \end_inset
10353
10354  dialog.
10355 \end_layout
10356
10357 \begin_layout Description
10358 \begin_inset Flex Code
10359 status collapsed
10360
10361 \begin_layout Plain Layout
10362 Preamble
10363 \end_layout
10364
10365 \end_inset
10366
10367  Sets the preamble for the \SpecialChar LaTeX
10368  document.
10369  Note that this will completely override any prior 
10370 \begin_inset Flex Code
10371 status collapsed
10372
10373 \begin_layout Plain Layout
10374 Preamble
10375 \end_layout
10376
10377 \end_inset
10378
10379  or 
10380 \begin_inset Flex Code
10381 status collapsed
10382
10383 \begin_layout Plain Layout
10384 AddToPreamble
10385 \end_layout
10386
10387 \end_inset
10388
10389  declarations.
10390  (Use 
10391 \begin_inset Flex Code
10392 status collapsed
10393
10394 \begin_layout Plain Layout
10395 AddToPreamble
10396 \end_layout
10397
10398 \end_inset
10399
10400  if you just want to add material to the preamble.) Must end with 
10401 \begin_inset Quotes eld
10402 \end_inset
10403
10404
10405 \begin_inset Flex Code
10406 status collapsed
10407
10408 \begin_layout Plain Layout
10409 EndPreamble
10410 \end_layout
10411
10412 \end_inset
10413
10414
10415 \begin_inset Quotes erd
10416 \end_inset
10417
10418 .
10419 \end_layout
10420
10421 \begin_layout Description
10422 \begin_inset Flex Code
10423 status collapsed
10424
10425 \begin_layout Plain Layout
10426 Provides
10427 \end_layout
10428
10429 \end_inset
10430
10431  [
10432 \begin_inset Flex Code
10433 status collapsed
10434
10435 \begin_layout Plain Layout
10436 string
10437 \end_layout
10438
10439 \end_inset
10440
10441 ] [
10442 \begin_inset Flex Code
10443 status collapsed
10444
10445 \begin_layout Plain Layout
10446
10447 \emph on
10448 0
10449 \end_layout
10450
10451 \end_inset
10452
10453 ,
10454 \begin_inset space \thinspace{}
10455 \end_inset
10456
10457
10458 \begin_inset Flex Code
10459 status collapsed
10460
10461 \begin_layout Plain Layout
10462 1
10463 \end_layout
10464
10465 \end_inset
10466
10467 ] Whether the class already provides the feature 
10468 \begin_inset Flex Code
10469 status collapsed
10470
10471 \begin_layout Plain Layout
10472 string
10473 \end_layout
10474
10475 \end_inset
10476
10477 .
10478  A feature is in general the name of a package (e.
10479 \begin_inset space \thinspace{}
10480 \end_inset
10481
10482 g.
10483 \begin_inset space \space{}
10484 \end_inset
10485
10486
10487 \begin_inset Flex Code
10488 status collapsed
10489
10490 \begin_layout Plain Layout
10491 amsmath
10492 \end_layout
10493
10494 \end_inset
10495
10496  or 
10497 \begin_inset Flex Code
10498 status collapsed
10499
10500 \begin_layout Plain Layout
10501 makeidx
10502 \end_layout
10503
10504 \end_inset
10505
10506 ) or a macro (e.
10507 \begin_inset space \thinspace{}
10508 \end_inset
10509
10510 g.
10511 \begin_inset space \space{}
10512 \end_inset
10513
10514
10515 \begin_inset Flex Code
10516 status collapsed
10517
10518 \begin_layout Plain Layout
10519 url
10520 \end_layout
10521
10522 \end_inset
10523
10524  or 
10525 \begin_inset Flex Code
10526 status collapsed
10527
10528 \begin_layout Plain Layout
10529 boldsymbol
10530 \end_layout
10531
10532 \end_inset
10533
10534 ).
10535  See 
10536 \begin_inset CommandInset ref
10537 LatexCommand ref
10538 reference "chap:List-of-functions"
10539
10540 \end_inset
10541
10542  for the list of features.
10543 \end_layout
10544
10545 \begin_layout Description
10546 \begin_inset Flex Code
10547 status collapsed
10548
10549 \begin_layout Plain Layout
10550 ProvidesModule
10551 \end_layout
10552
10553 \end_inset
10554
10555  [
10556 \begin_inset Flex Code
10557 status collapsed
10558
10559 \begin_layout Plain Layout
10560 string
10561 \end_layout
10562
10563 \end_inset
10564
10565 ] Indicates that this layout provides the functionality of the module mentioned,
10566  which should be specified by the filename without the 
10567 \begin_inset Flex Code
10568 status collapsed
10569
10570 \begin_layout Plain Layout
10571 .module
10572 \end_layout
10573
10574 \end_inset
10575
10576  extension.
10577  This will typically be used if the layout includes the module directly,
10578  rather than using the 
10579 \begin_inset Flex Code
10580 status collapsed
10581
10582 \begin_layout Plain Layout
10583 DefaultModule
10584 \end_layout
10585
10586 \end_inset
10587
10588  tag to indicate that it ought to be used.
10589  It could also be used in a module that provided an alternate implementation
10590  of the same functionality.
10591 \end_layout
10592
10593 \begin_layout Description
10594 \begin_inset Flex Code
10595 status collapsed
10596
10597 \begin_layout Plain Layout
10598 ProvideStyle
10599 \end_layout
10600
10601 \end_inset
10602
10603  [
10604 \begin_inset Flex Code
10605 status collapsed
10606
10607 \begin_layout Plain Layout
10608 <style>
10609 \end_layout
10610
10611 \end_inset
10612
10613 ] Creates a new paragraph style if it does not already exist.
10614  If the style does exist, this section is ignored.
10615  Must end with 
10616 \begin_inset Quotes eld
10617 \end_inset
10618
10619
10620 \begin_inset Flex Code
10621 status collapsed
10622
10623 \begin_layout Plain Layout
10624 End
10625 \end_layout
10626
10627 \end_inset
10628
10629
10630 \begin_inset Quotes erd
10631 \end_inset
10632
10633 .
10634 \end_layout
10635
10636 \begin_layout Description
10637 \begin_inset Flex Code
10638 status collapsed
10639
10640 \begin_layout Plain Layout
10641 Requires
10642 \end_layout
10643
10644 \end_inset
10645
10646  [
10647 \begin_inset Flex Code
10648 status collapsed
10649
10650 \begin_layout Plain Layout
10651 string
10652 \end_layout
10653
10654 \end_inset
10655
10656 ] Whether the class requires the feature 
10657 \begin_inset Flex Code
10658 status collapsed
10659
10660 \begin_layout Plain Layout
10661 string
10662 \end_layout
10663
10664 \end_inset
10665
10666 .
10667  Multiple features must be separated by commas.
10668  Note that you can only request supported features.
10669  (See 
10670 \begin_inset CommandInset ref
10671 LatexCommand ref
10672 reference "chap:List-of-functions"
10673
10674 \end_inset
10675
10676  for the list of features.).
10677  If you require a package with specific options, you can additionally use
10678  
10679 \begin_inset Flex Code
10680 status collapsed
10681
10682 \begin_layout Plain Layout
10683 PackageOptions
10684 \end_layout
10685
10686 \end_inset
10687
10688 .
10689 \end_layout
10690
10691 \begin_layout Description
10692 \begin_inset Flex Code
10693 status collapsed
10694
10695 \begin_layout Plain Layout
10696 RightMargin
10697 \end_layout
10698
10699 \end_inset
10700
10701  [
10702 \begin_inset Flex Code
10703 status collapsed
10704
10705 \begin_layout Plain Layout
10706 string
10707 \end_layout
10708
10709 \end_inset
10710
10711 ] A string that indicates the width of the right margin on the screen, for
10712  example, 
10713 \begin_inset Quotes eld
10714 \end_inset
10715
10716
10717 \begin_inset Flex Code
10718 status collapsed
10719
10720 \begin_layout Plain Layout
10721 MMMMM
10722 \end_layout
10723
10724 \end_inset
10725
10726
10727 \begin_inset Quotes erd
10728 \end_inset
10729
10730 .
10731 \end_layout
10732
10733 \begin_layout Description
10734 \begin_inset Flex Code
10735 status collapsed
10736
10737 \begin_layout Plain Layout
10738 SecNumDepth
10739 \end_layout
10740
10741 \end_inset
10742
10743  [
10744 \begin_inset Flex Code
10745 status collapsed
10746
10747 \begin_layout Plain Layout
10748 int=3
10749 \end_layout
10750
10751 \end_inset
10752
10753 ] Sets which divisions get numbered.
10754  Corresponds to the
10755 \begin_inset Newline newline
10756 \end_inset
10757
10758
10759 \begin_inset Flex Code
10760 status collapsed
10761
10762 \begin_layout Plain Layout
10763 secnumdepth
10764 \end_layout
10765
10766 \end_inset
10767
10768  counter in \SpecialChar LaTeX
10769 .
10770 \end_layout
10771
10772 \begin_layout Description
10773 \begin_inset Flex Code
10774 status collapsed
10775
10776 \begin_layout Plain Layout
10777 Sides
10778 \end_layout
10779
10780 \end_inset
10781
10782  [
10783 \begin_inset Flex Code
10784 status collapsed
10785
10786 \begin_layout Plain Layout
10787
10788 \emph on
10789 1
10790 \end_layout
10791
10792 \end_inset
10793
10794 ,
10795 \begin_inset space \thinspace{}
10796 \end_inset
10797
10798
10799 \begin_inset Flex Code
10800 status collapsed
10801
10802 \begin_layout Plain Layout
10803 2
10804 \end_layout
10805
10806 \end_inset
10807
10808 ] Whether the class-default should be printing on one or both sides of the
10809  paper.
10810  Can be changed in the 
10811 \begin_inset Flex Noun
10812 status collapsed
10813
10814 \begin_layout Plain Layout
10815 Document\SpecialChar menuseparator
10816 Settings
10817 \end_layout
10818
10819 \end_inset
10820
10821  dialog.
10822 \end_layout
10823
10824 \begin_layout Description
10825 \begin_inset Flex Code
10826 status collapsed
10827
10828 \begin_layout Plain Layout
10829 Style
10830 \end_layout
10831
10832 \end_inset
10833
10834  [
10835 \begin_inset Flex Code
10836 status collapsed
10837
10838 \begin_layout Plain Layout
10839 <name>
10840 \end_layout
10841
10842 \end_inset
10843
10844 ] This sequence defines a paragraph style.
10845  If the style does not yet exist, it is created; if it does exist, its parameter
10846 s are modified.
10847  Must end with 
10848 \begin_inset Quotes eld
10849 \end_inset
10850
10851
10852 \begin_inset Flex Code
10853 status collapsed
10854
10855 \begin_layout Plain Layout
10856 End
10857 \end_layout
10858
10859 \end_inset
10860
10861
10862 \begin_inset Quotes erd
10863 \end_inset
10864
10865 .
10866 \begin_inset Newline newline
10867 \end_inset
10868
10869 See 
10870 \begin_inset CommandInset ref
10871 LatexCommand ref
10872 reference "subsec:Paragraph-Styles"
10873
10874 \end_inset
10875
10876  for details on paragraph styles.
10877 \end_layout
10878
10879 \begin_layout Description
10880 \begin_inset Flex Code
10881 status collapsed
10882
10883 \begin_layout Plain Layout
10884 TitleLatexName
10885 \end_layout
10886
10887 \end_inset
10888
10889  [
10890 \begin_inset Flex Code
10891 status collapsed
10892
10893 \begin_layout Plain Layout
10894 string="maketitle"
10895 \end_layout
10896
10897 \end_inset
10898
10899 ] The name of the command or environment to be used with 
10900 \begin_inset Flex Code
10901 status collapsed
10902
10903 \begin_layout Plain Layout
10904 TitleLatexType
10905 \end_layout
10906
10907 \end_inset
10908
10909 .
10910 \end_layout
10911
10912 \begin_layout Description
10913 \begin_inset Flex Code
10914 status collapsed
10915
10916 \begin_layout Plain Layout
10917 TitleLatexType
10918 \end_layout
10919
10920 \end_inset
10921
10922  [
10923 \begin_inset Flex Code
10924 status collapsed
10925
10926 \begin_layout Plain Layout
10927
10928 \emph on
10929 CommandAfter
10930 \end_layout
10931
10932 \end_inset
10933
10934
10935 \begin_inset Flex Code
10936 status collapsed
10937
10938 \begin_layout Plain Layout
10939 Environment
10940 \end_layout
10941
10942 \end_inset
10943
10944 ] Indicates what kind of markup is used to define the title of a document.
10945  
10946 \begin_inset Flex Code
10947 status collapsed
10948
10949 \begin_layout Plain Layout
10950 CommandAfter
10951 \end_layout
10952
10953 \end_inset
10954
10955  means that the macro with name 
10956 \begin_inset Flex Code
10957 status collapsed
10958
10959 \begin_layout Plain Layout
10960 TitleLatexName
10961 \end_layout
10962
10963 \end_inset
10964
10965  will be inserted after the last layout which has 
10966 \begin_inset Quotes eld
10967 \end_inset
10968
10969
10970 \begin_inset Flex Code
10971 status collapsed
10972
10973 \begin_layout Plain Layout
10974 InTitle
10975 \begin_inset space ~
10976 \end_inset
10977
10978 1
10979 \end_layout
10980
10981 \end_inset
10982
10983
10984 \begin_inset Quotes erd
10985 \end_inset
10986
10987 .
10988  
10989 \begin_inset Flex Code
10990 status collapsed
10991
10992 \begin_layout Plain Layout
10993 Environment
10994 \end_layout
10995
10996 \end_inset
10997
10998  corresponds to the case where all layouts which have 
10999 \begin_inset Quotes eld
11000 \end_inset
11001
11002
11003 \begin_inset Flex Code
11004 status collapsed
11005
11006 \begin_layout Plain Layout
11007 InTitle
11008 \begin_inset space ~
11009 \end_inset
11010
11011 1
11012 \end_layout
11013
11014 \end_inset
11015
11016
11017 \begin_inset Quotes erd
11018 \end_inset
11019
11020  should be enclosed into the 
11021 \begin_inset Flex Code
11022 status collapsed
11023
11024 \begin_layout Plain Layout
11025 TitleLatexName
11026 \end_layout
11027
11028 \end_inset
11029
11030  environment.
11031 \end_layout
11032
11033 \begin_layout Description
11034 \begin_inset Flex Code
11035 status collapsed
11036
11037 \begin_layout Plain Layout
11038 TocDepth
11039 \end_layout
11040
11041 \end_inset
11042
11043  [
11044 \begin_inset Flex Code
11045 status collapsed
11046
11047 \begin_layout Plain Layout
11048 int=3
11049 \end_layout
11050
11051 \end_inset
11052
11053 ] Sets which divisions are included in the table of contents.
11054  Corresponds to the 
11055 \begin_inset Flex Code
11056 status collapsed
11057
11058 \begin_layout Plain Layout
11059 tocdepth
11060 \end_layout
11061
11062 \end_inset
11063
11064  counter in \SpecialChar LaTeX
11065 .
11066 \end_layout
11067
11068 \begin_layout Subsection
11069 \begin_inset Flex Code
11070 status collapsed
11071
11072 \begin_layout Plain Layout
11073 ClassOptions
11074 \end_layout
11075
11076 \end_inset
11077
11078  section
11079 \begin_inset CommandInset label
11080 LatexCommand label
11081 name "subsec:ClassOptions"
11082
11083 \end_inset
11084
11085
11086 \end_layout
11087
11088 \begin_layout Standard
11089 The 
11090 \begin_inset Flex Code
11091 status collapsed
11092
11093 \begin_layout Plain Layout
11094 ClassOptions
11095 \end_layout
11096
11097 \end_inset
11098
11099  section can contain the following entries:
11100 \end_layout
11101
11102 \begin_layout Description
11103 \begin_inset Flex Code
11104 status collapsed
11105
11106 \begin_layout Plain Layout
11107 FontSize
11108 \end_layout
11109
11110 \end_inset
11111
11112  [
11113 \begin_inset Flex Code
11114 status collapsed
11115
11116 \begin_layout Plain Layout
11117 string="10|11|12"
11118 \end_layout
11119
11120 \end_inset
11121
11122 ] The list of available font sizes for the document's main font, separated
11123  by 
11124 \begin_inset Quotes eld
11125 \end_inset
11126
11127
11128 \begin_inset Flex Code
11129 status collapsed
11130
11131 \begin_layout Plain Layout
11132 |
11133 \end_layout
11134
11135 \end_inset
11136
11137
11138 \begin_inset Quotes erd
11139 \end_inset
11140
11141 .
11142 \end_layout
11143
11144 \begin_layout Description
11145 \begin_inset Flex Code
11146 status collapsed
11147
11148 \begin_layout Plain Layout
11149 Header
11150 \end_layout
11151
11152 \end_inset
11153
11154  Used to set the DTD line with XML-based output classes.
11155  E.
11156 \begin_inset space \thinspace{}
11157 \end_inset
11158
11159 g.: PUBLIC 
11160 \begin_inset Quotes eld
11161 \end_inset
11162
11163 -//OASIS//DTD DocBook V4.2//EN
11164 \begin_inset Quotes erd
11165 \end_inset
11166
11167 .
11168 \end_layout
11169
11170 \begin_layout Description
11171 \begin_inset Flex Code
11172 status collapsed
11173
11174 \begin_layout Plain Layout
11175 PageStyle
11176 \end_layout
11177
11178 \end_inset
11179
11180  [
11181 \begin_inset Flex Code
11182 status collapsed
11183
11184 \begin_layout Plain Layout
11185 string="empty|plain|headings|fancy"
11186 \end_layout
11187
11188 \end_inset
11189
11190 ] The list of available page sty\SpecialChar softhyphen
11191 les, separated by 
11192 \begin_inset Quotes eld
11193 \end_inset
11194
11195
11196 \begin_inset Flex Code
11197 status collapsed
11198
11199 \begin_layout Plain Layout
11200 |
11201 \end_layout
11202
11203 \end_inset
11204
11205
11206 \begin_inset Quotes erd
11207 \end_inset
11208
11209 .
11210 \end_layout
11211
11212 \begin_layout Description
11213 \begin_inset Flex Code
11214 status collapsed
11215
11216 \begin_layout Plain Layout
11217 Other
11218 \end_layout
11219
11220 \end_inset
11221
11222  [
11223 \begin_inset Flex Code
11224 status collapsed
11225
11226 \begin_layout Plain Layout
11227 string=""
11228 \end_layout
11229
11230 \end_inset
11231
11232 ] Some document class options, separated by a comma, that will be added
11233  to the optional part of the 
11234 \begin_inset Flex Code
11235 status collapsed
11236
11237 \begin_layout Plain Layout
11238
11239 \backslash
11240 documentclass
11241 \end_layout
11242
11243 \end_inset
11244
11245  command.
11246 \end_layout
11247
11248 \begin_layout Standard
11249 The 
11250 \begin_inset Flex Code
11251 status collapsed
11252
11253 \begin_layout Plain Layout
11254 ClassOptions
11255 \end_layout
11256
11257 \end_inset
11258
11259  section must end with 
11260 \begin_inset Quotes eld
11261 \end_inset
11262
11263
11264 \begin_inset Flex Code
11265 status collapsed
11266
11267 \begin_layout Plain Layout
11268 End
11269 \end_layout
11270
11271 \end_inset
11272
11273
11274 \begin_inset Quotes erd
11275 \end_inset
11276
11277 .
11278 \end_layout
11279
11280 \begin_layout Subsection
11281 Paragraph styles
11282 \begin_inset CommandInset label
11283 LatexCommand label
11284 name "subsec:Paragraph-Styles"
11285
11286 \end_inset
11287
11288
11289 \end_layout
11290
11291 \begin_layout Standard
11292 A paragraph style description looks like this:
11293 \begin_inset Foot
11294 status collapsed
11295
11296 \begin_layout Plain Layout
11297 Note that this will either define a new style or modify an existing one.
11298 \end_layout
11299
11300 \end_inset
11301
11302
11303 \end_layout
11304
11305 \begin_layout LyX-Code
11306 Style 
11307 \family roman
11308 \emph on
11309 name
11310 \end_layout
11311
11312 \begin_layout LyX-Code
11313  ...
11314 \end_layout
11315
11316 \begin_layout LyX-Code
11317 End
11318 \end_layout
11319
11320 \begin_layout Standard
11321 where the following commands are allowed:
11322 \end_layout
11323
11324 \begin_layout Description
11325
11326 \change_inserted 2047637253 1483963019
11327 \begin_inset Flex Code
11328 status collapsed
11329
11330 \begin_layout Plain Layout
11331
11332 \change_inserted 2047637253 1483901753
11333 AddToToc
11334 \end_layout
11335
11336 \end_inset
11337
11338  [
11339 \begin_inset Flex Code
11340 status collapsed
11341
11342 \begin_layout Plain Layout
11343
11344 \change_inserted 2047637253 1483963007
11345 string
11346 \end_layout
11347
11348 \end_inset
11349
11350 =""] This paragraph will appear in the table of contents of the given type.
11351  An empty string disables.
11352  See also the OutlinerName and the IsTocCaption commands.
11353  Default: disabled.
11354 \end_layout
11355
11356 \begin_layout Description
11357 \begin_inset Flex Code
11358 status collapsed
11359
11360 \begin_layout Plain Layout
11361 Align
11362 \end_layout
11363
11364 \end_inset
11365
11366  [
11367 \begin_inset Flex Code
11368 status collapsed
11369
11370 \begin_layout Plain Layout
11371
11372 \emph on
11373 block
11374 \emph default
11375 , left, right, center
11376 \end_layout
11377
11378 \end_inset
11379
11380 ] Paragraph alignment.
11381 \end_layout
11382
11383 \begin_layout Description
11384 \begin_inset Flex Code
11385 status collapsed
11386
11387 \begin_layout Plain Layout
11388 AlignPossible
11389 \end_layout
11390
11391 \end_inset
11392
11393  [
11394 \begin_inset Flex Code
11395 status collapsed
11396
11397 \begin_layout Plain Layout
11398
11399 \emph on
11400 block
11401 \emph default
11402 , left, right, center
11403 \end_layout
11404
11405 \end_inset
11406
11407 ] A comma separated list of permitted alignments.
11408  (Some \SpecialChar LaTeX
11409  styles prohibit certain alignments, since those wouldn't make sense.
11410  For example a right-aligned or centered enumeration isn't possible.)
11411 \end_layout
11412
11413 \begin_layout Description
11414 \begin_inset Flex Code
11415 status collapsed
11416
11417 \begin_layout Plain Layout
11418 Argument
11419 \end_layout
11420
11421 \end_inset
11422
11423  [
11424 \begin_inset Flex Code
11425 status collapsed
11426
11427 \begin_layout Plain Layout
11428 int
11429 \end_layout
11430
11431 \end_inset
11432
11433 ] Defines argument number <int> of a command\SpecialChar breakableslash
11434 environment associated with
11435  the current style.
11436  This is useful for things like section headings, and only makes sense with
11437  \SpecialChar LaTeX
11438 .
11439  Every (optional or required) argument of a command or environment – except
11440  for the required argument that is associated with the content of the paragraph
11441  itself – has a separate definition, where the number specifies the order
11442  of the arguments.
11443  The definition must end with 
11444 \begin_inset Flex Code
11445 status collapsed
11446
11447 \begin_layout Plain Layout
11448 EndArgument
11449 \end_layout
11450
11451 \end_inset
11452
11453 .
11454  So a command with two optional arguments has:
11455 \end_layout
11456
11457 \begin_deeper
11458 \begin_layout Quote
11459
11460 \family typewriter
11461 Argument 1
11462 \end_layout
11463
11464 \begin_layout Quote
11465
11466 \family typewriter
11467 ...
11468 \end_layout
11469
11470 \begin_layout Quote
11471
11472 \family typewriter
11473 EndArgument
11474 \end_layout
11475
11476 \begin_layout Quote
11477
11478 \family typewriter
11479 Argument 2
11480 \end_layout
11481
11482 \begin_layout Quote
11483
11484 \family typewriter
11485 ...
11486 \end_layout
11487
11488 \begin_layout Quote
11489
11490 \family typewriter
11491 EndArgument
11492 \end_layout
11493
11494 \begin_layout Standard
11495 Inside the 
11496 \begin_inset Flex Code
11497 status collapsed
11498
11499 \begin_layout Plain Layout
11500 Argument
11501 \end_layout
11502
11503 \end_inset
11504
11505  definition, the following specifications are possible:
11506 \end_layout
11507
11508 \begin_layout Itemize
11509 \begin_inset Flex Code
11510 status collapsed
11511
11512 \begin_layout Plain Layout
11513 LabelString
11514 \end_layout
11515
11516 \end_inset
11517
11518  
11519 \begin_inset Flex Code
11520 status collapsed
11521
11522 \begin_layout Plain Layout
11523 [string]
11524 \end_layout
11525
11526 \end_inset
11527
11528  The string that will appear both in the menu (to insert this argument)
11529  and on the argument inset button (unless you also specify a separate 
11530 \begin_inset Flex Code
11531 status collapsed
11532
11533 \begin_layout Plain Layout
11534 MenuString
11535 \end_layout
11536
11537 \end_inset
11538
11539 ).
11540  For the menu, you can define an accelerator by appending the respective
11541  character to the string, divided by 
11542 \begin_inset Quotes eld
11543 \end_inset
11544
11545 |
11546 \begin_inset Quotes erd
11547 \end_inset
11548
11549  (e.
11550 \begin_inset space \thinspace{}
11551 \end_inset
11552
11553 g.
11554 \begin_inset space \space{}
11555 \end_inset
11556
11557
11558 \begin_inset Quotes eld
11559 \end_inset
11560
11561
11562 \begin_inset Flex Code
11563 status collapsed
11564
11565 \begin_layout Plain Layout
11566 Short Title|S
11567 \end_layout
11568
11569 \end_inset
11570
11571
11572 \begin_inset Quotes erd
11573 \end_inset
11574
11575 ).
11576 \end_layout
11577
11578 \begin_layout Itemize
11579 \begin_inset Flex Code
11580 status collapsed
11581
11582 \begin_layout Plain Layout
11583 MenuString
11584 \end_layout
11585
11586 \end_inset
11587
11588  
11589 \begin_inset Flex Code
11590 status collapsed
11591
11592 \begin_layout Plain Layout
11593 [string]
11594 \end_layout
11595
11596 \end_inset
11597
11598  A separate string for the menu.
11599  You can define an accelerator by appending the respective character to
11600  the string, divided by 
11601 \begin_inset Quotes eld
11602 \end_inset
11603
11604 |
11605 \begin_inset Quotes erd
11606 \end_inset
11607
11608  (e.
11609 \begin_inset space \thinspace{}
11610 \end_inset
11611
11612 g.
11613 \begin_inset space \space{}
11614 \end_inset
11615
11616
11617 \begin_inset Quotes eld
11618 \end_inset
11619
11620
11621 \begin_inset Flex Code
11622 status collapsed
11623
11624 \begin_layout Plain Layout
11625 Short Title|S
11626 \end_layout
11627
11628 \end_inset
11629
11630
11631 \begin_inset Quotes erd
11632 \end_inset
11633
11634 ).
11635  This specification is optional.
11636  If it is not given the 
11637 \begin_inset Flex Code
11638 status collapsed
11639
11640 \begin_layout Plain Layout
11641 LabelString
11642 \end_layout
11643
11644 \end_inset
11645
11646  will be used instead for the menu.
11647 \end_layout
11648
11649 \begin_layout Itemize
11650 \begin_inset Flex Code
11651 status collapsed
11652
11653 \begin_layout Plain Layout
11654 Tooltip
11655 \end_layout
11656
11657 \end_inset
11658
11659  
11660 \begin_inset Flex Code
11661 status collapsed
11662
11663 \begin_layout Plain Layout
11664 [string]
11665 \end_layout
11666
11667 \end_inset
11668
11669  A longer explanatory text that appears in the tooltip when hovering over
11670  the argument inset.
11671 \end_layout
11672
11673 \begin_layout Itemize
11674 \begin_inset Flex Code
11675 status collapsed
11676
11677 \begin_layout Plain Layout
11678 Mandatory
11679 \end_layout
11680
11681 \end_inset
11682
11683  [
11684 \begin_inset Flex Code
11685 status collapsed
11686
11687 \begin_layout Plain Layout
11688
11689 \emph on
11690 0
11691 \end_layout
11692
11693 \end_inset
11694
11695 ,
11696 \begin_inset space \thinspace{}
11697 \end_inset
11698
11699
11700 \begin_inset Flex Code
11701 status collapsed
11702
11703 \begin_layout Plain Layout
11704 1
11705 \end_layout
11706
11707 \end_inset
11708
11709 ] Declare if this is a mandatory (1) or an optional (0) argument.
11710  Mandatory arguments will be output empty if not given, while optional arguments
11711  will not be output at all.
11712  By default, mandatory arguments are delimited by 
11713 \begin_inset Flex Code
11714 status collapsed
11715
11716 \begin_layout Plain Layout
11717 {...}
11718 \end_layout
11719
11720 \end_inset
11721
11722 , while optional arguments are delimited by 
11723 \begin_inset Flex Code
11724 status collapsed
11725
11726 \begin_layout Plain Layout
11727 [...]
11728 \end_layout
11729
11730 \end_inset
11731
11732
11733 \end_layout
11734
11735 \begin_layout Itemize
11736 \begin_inset Flex Code
11737 status collapsed
11738
11739 \begin_layout Plain Layout
11740 Requires
11741 \end_layout
11742
11743 \end_inset
11744
11745  
11746 \begin_inset Flex Code
11747 status collapsed
11748
11749 \begin_layout Plain Layout
11750 [int=0]
11751 \end_layout
11752
11753 \end_inset
11754
11755  defines another argument (by its number) which this argument requires to
11756  be output if it is itself output.
11757  E.
11758 \begin_inset space \thinspace{}
11759 \end_inset
11760
11761 g., in \SpecialChar LaTeX
11762  commands, optional arguments often require previous optional arguments
11763  to be output (at least empty), as in 
11764 \begin_inset Flex Code
11765 status collapsed
11766
11767 \begin_layout Plain Layout
11768
11769 \backslash
11770 command[][argument]{text}
11771 \end_layout
11772
11773 \end_inset
11774
11775 .
11776  This can be achieved by the statement 
11777 \begin_inset Flex Code
11778 status collapsed
11779
11780 \begin_layout Plain Layout
11781 Requires 1
11782 \end_layout
11783
11784 \end_inset
11785
11786  within 
11787 \begin_inset Flex Code
11788 status collapsed
11789
11790 \begin_layout Plain Layout
11791 Argument 2
11792 \end_layout
11793
11794 \end_inset
11795
11796 .
11797 \end_layout
11798
11799 \begin_layout Itemize
11800 \begin_inset Flex Code
11801 status collapsed
11802
11803 \begin_layout Plain Layout
11804 LeftDelim
11805 \end_layout
11806
11807 \end_inset
11808
11809  
11810 \begin_inset Flex Code
11811 status collapsed
11812
11813 \begin_layout Plain Layout
11814 [string]
11815 \end_layout
11816
11817 \end_inset
11818
11819  defines a custom left delimiter (instead of 
11820 \begin_inset Flex Code
11821 status collapsed
11822
11823 \begin_layout Plain Layout
11824 {
11825 \end_layout
11826
11827 \end_inset
11828
11829  or 
11830 \begin_inset Flex Code
11831 status collapsed
11832
11833 \begin_layout Plain Layout
11834 [
11835 \end_layout
11836
11837 \end_inset
11838
11839 ).
11840  A line break in the output can be indicated by 
11841 \begin_inset Flex Code
11842 status collapsed
11843
11844 \begin_layout Plain Layout
11845 <br/>
11846 \end_layout
11847
11848 \end_inset
11849
11850 .
11851 \end_layout
11852
11853 \begin_layout Itemize
11854 \begin_inset Flex Code
11855 status collapsed
11856
11857 \begin_layout Plain Layout
11858 RightDelim
11859 \end_layout
11860
11861 \end_inset
11862
11863  
11864 \begin_inset Flex Code
11865 status collapsed
11866
11867 \begin_layout Plain Layout
11868 [string]
11869 \end_layout
11870
11871 \end_inset
11872
11873  defines a custom right delimiter (instead of 
11874 \begin_inset Flex Code
11875 status collapsed
11876
11877 \begin_layout Plain Layout
11878 }
11879 \end_layout
11880
11881 \end_inset
11882
11883  or 
11884 \begin_inset Flex Code
11885 status collapsed
11886
11887 \begin_layout Plain Layout
11888 ]
11889 \end_layout
11890
11891 \end_inset
11892
11893 ).
11894  A line break in the output can be indicated by 
11895 \begin_inset Flex Code
11896 status collapsed
11897
11898 \begin_layout Plain Layout
11899 <br/>
11900 \end_layout
11901
11902 \end_inset
11903
11904 .
11905 \end_layout
11906
11907 \begin_layout Itemize
11908 \begin_inset Flex Code
11909 status collapsed
11910
11911 \begin_layout Plain Layout
11912 DefaultArg
11913 \end_layout
11914
11915 \end_inset
11916
11917  
11918 \begin_inset Flex Code
11919 status collapsed
11920
11921 \begin_layout Plain Layout
11922 [string]
11923 \end_layout
11924
11925 \end_inset
11926
11927  defines an argument that is inserted if and only if no user-specified arguments
11928  were given, i.
11929 \begin_inset space \thinspace{}
11930 \end_inset
11931
11932 e.
11933 \begin_inset space \space{}
11934 \end_inset
11935
11936 if no argument inset has been inserted (note that also an empty argument
11937  inset omits the DefaultArg).
11938  Multiple arguments need to be separated by comma.
11939 \end_layout
11940
11941 \begin_layout Itemize
11942 \begin_inset Flex Code
11943 status collapsed
11944
11945 \begin_layout Plain Layout
11946 PresetArg
11947 \end_layout
11948
11949 \end_inset
11950
11951  
11952 \begin_inset Flex Code
11953 status collapsed
11954
11955 \begin_layout Plain Layout
11956 [string]
11957 \end_layout
11958
11959 \end_inset
11960
11961  defines an argument that is inserted in any case (alone or in addition
11962  to user-specified arguments).
11963  Multiple arguments need to be separated by comma.
11964 \end_layout
11965
11966 \begin_layout Itemize
11967 \begin_inset Flex Code
11968 status collapsed
11969
11970 \begin_layout Plain Layout
11971 Font
11972 \end_layout
11973
11974 \end_inset
11975
11976  The font used for the argument content, see 
11977 \begin_inset CommandInset ref
11978 LatexCommand ref
11979 reference "subsec:Font-description"
11980
11981 \end_inset
11982
11983 .
11984 \end_layout
11985
11986 \begin_layout Itemize
11987 \begin_inset Flex Code
11988 status collapsed
11989
11990 \begin_layout Plain Layout
11991 LabelFont
11992 \end_layout
11993
11994 \end_inset
11995
11996  The font used for the label; see 
11997 \begin_inset CommandInset ref
11998 LatexCommand ref
11999 reference "subsec:Font-description"
12000
12001 \end_inset
12002
12003 .
12004 \end_layout
12005
12006 \begin_layout Itemize
12007 \begin_inset Flex Code
12008 status collapsed
12009
12010 \begin_layout Plain Layout
12011 Decoration
12012 \end_layout
12013
12014 \end_inset
12015
12016  [
12017 \begin_inset Flex Code
12018 status collapsed
12019
12020 \begin_layout Plain Layout
12021
12022 \emph on
12023 Classic
12024 \emph default
12025 , Minimalistic, Conglomerate
12026 \end_layout
12027
12028 \end_inset
12029
12030 ] describes the rendering style used for the inset's frame and buttons.
12031 \end_layout
12032
12033 \begin_layout Itemize
12034 \begin_inset Flex Code
12035 status collapsed
12036
12037 \begin_layout Plain Layout
12038 AutoInsert
12039 \end_layout
12040
12041 \end_inset
12042
12043  
12044 \begin_inset Flex Code
12045 status collapsed
12046
12047 \begin_layout Plain Layout
12048 [int=0]
12049 \end_layout
12050
12051 \end_inset
12052
12053  If this is set to 
12054 \begin_inset Flex Code
12055 status collapsed
12056
12057 \begin_layout Plain Layout
12058 1
12059 \end_layout
12060
12061 \end_inset
12062
12063 , this argument is automatically inserted when the respective style is selected.
12064  Currently, only one argument per style\SpecialChar breakableslash
12065 layout can be automatically inserted.
12066 \end_layout
12067
12068 \begin_layout Itemize
12069 \begin_inset Flex Code
12070 status collapsed
12071
12072 \begin_layout Plain Layout
12073 InsertCotext
12074 \end_layout
12075
12076 \end_inset
12077
12078  
12079 \begin_inset Flex Code
12080 status collapsed
12081
12082 \begin_layout Plain Layout
12083 [int=0]
12084 \end_layout
12085
12086 \end_inset
12087
12088  If this is set to 
12089 \begin_inset Flex Code
12090 status collapsed
12091
12092 \begin_layout Plain Layout
12093 1
12094 \end_layout
12095
12096 \end_inset
12097
12098 , this argument will be inserted with a copy of the co-text (either selected
12099  text or the whole paragraph) as content.
12100 \change_inserted -712698321 1477038290
12101
12102 \end_layout
12103
12104 \begin_layout Itemize
12105
12106 \change_inserted -712698321 1477038425
12107 \begin_inset Flex Code
12108 status collapsed
12109
12110 \begin_layout Plain Layout
12111
12112 \change_inserted -712698321 1477038295
12113 PassThru
12114 \end_layout
12115
12116 \end_inset
12117
12118  [
12119 \begin_inset Flex Code
12120 status collapsed
12121
12122 \begin_layout Plain Layout
12123
12124 \change_inserted -712698321 1477038311
12125
12126 \emph on
12127 inherited
12128 \emph default
12129 , true, false
12130 \end_layout
12131
12132 \end_inset
12133
12134 ] Whether the contents of this argument should be output in raw form, meaning
12135  without special translations that \SpecialChar LaTeX
12136  would require.
12137  By default, the 
12138 \begin_inset Flex Code
12139 status collapsed
12140
12141 \begin_layout Plain Layout
12142
12143 \change_inserted -712698321 1477038356
12144 PassThru
12145 \end_layout
12146
12147 \end_inset
12148
12149  status is inherited by the inset or paragraph layout the argument belongs
12150  to, true and false change the status for the given argument only.
12151 \change_unchanged
12152
12153 \end_layout
12154
12155 \begin_layout Itemize
12156 \begin_inset Flex Code
12157 status collapsed
12158
12159 \begin_layout Plain Layout
12160 PassThruChars
12161 \end_layout
12162
12163 \end_inset
12164
12165  [
12166 \begin_inset Flex Code
12167 status collapsed
12168
12169 \begin_layout Plain Layout
12170 string of characters
12171 \end_layout
12172
12173 \end_inset
12174
12175 ]
12176 \family typewriter
12177  
12178 \family default
12179 Defines individual characters that should be output in raw form, meaning
12180  without special translations that \SpecialChar LaTeX
12181  would require.
12182  Note that, contrary to PassThru, this needs to be explicitly defined for
12183  arguments.
12184  That is, arguments do not inherit PassThruChars from their parent inset
12185  or layout.
12186 \change_inserted 2047637253 1483899840
12187
12188 \end_layout
12189
12190 \begin_layout Itemize
12191
12192 \change_inserted 2047637253 1483900841
12193 \begin_inset Flex Code
12194 status collapsed
12195
12196 \begin_layout Plain Layout
12197
12198 \change_inserted 2047637253 1483900841
12199 IsTocCaption
12200 \end_layout
12201
12202 \end_inset
12203
12204  [
12205 \begin_inset Flex Code
12206 status collapsed
12207
12208 \begin_layout Plain Layout
12209
12210 \change_inserted 2047637253 1483900841
12211
12212 \emph on
12213 0
12214 \end_layout
12215
12216 \end_inset
12217
12218 ,
12219 \begin_inset space \thinspace{}
12220 \end_inset
12221
12222
12223 \begin_inset Flex Code
12224 status collapsed
12225
12226 \begin_layout Plain Layout
12227
12228 \change_inserted 2047637253 1483900841
12229 1
12230 \end_layout
12231
12232 \end_inset
12233
12234 ] If this is set to 1, the argument will output its content in the corresponding
12235  item in the table of contents.
12236  See AddToToc.
12237 \change_unchanged
12238
12239 \end_layout
12240
12241 \begin_layout Standard
12242 By default, the text entered in the \SpecialChar LyX
12243  workarea in the respective layout is
12244  the last (mandatory) argument of a command if the 
12245 \begin_inset Flex Code
12246 status collapsed
12247
12248 \begin_layout Plain Layout
12249 LatexType
12250 \end_layout
12251
12252 \end_inset
12253
12254  is 
12255 \begin_inset Flex Code
12256 status collapsed
12257
12258 \begin_layout Plain Layout
12259 Command
12260 \end_layout
12261
12262 \end_inset
12263
12264 .
12265  However, arguments with the prefix 
12266 \begin_inset Flex Code
12267 status collapsed
12268
12269 \begin_layout Plain Layout
12270 post:
12271 \end_layout
12272
12273 \end_inset
12274
12275  are output after this workarea argument.
12276  Note that post-argument numbering restarts at 1, so the first argument
12277  following the workarea argument is 
12278 \begin_inset Flex Code
12279 status collapsed
12280
12281 \begin_layout Plain Layout
12282 post:1
12283 \end_layout
12284
12285 \end_inset
12286
12287 .
12288  Post-arguments are ignored in any other 
12289 \begin_inset Flex Code
12290 status collapsed
12291
12292 \begin_layout Plain Layout
12293 LatexType
12294 \end_layout
12295
12296 \end_inset
12297
12298  than 
12299 \begin_inset Flex Code
12300 status collapsed
12301
12302 \begin_layout Plain Layout
12303 Command
12304 \end_layout
12305
12306 \end_inset
12307
12308 .
12309 \end_layout
12310
12311 \begin_layout Standard
12312 Arguments for list 
12313 \begin_inset Flex Code
12314 status collapsed
12315
12316 \begin_layout Plain Layout
12317
12318 \backslash
12319 item
12320 \end_layout
12321
12322 \end_inset
12323
12324 s (as in 
12325 \begin_inset Flex Code
12326 status collapsed
12327
12328 \begin_layout Plain Layout
12329
12330 \backslash
12331 item[foo]
12332 \end_layout
12333
12334 \end_inset
12335
12336 ) have the prefix 
12337 \begin_inset Flex Code
12338 status collapsed
12339
12340 \begin_layout Plain Layout
12341 item:
12342 \end_layout
12343
12344 \end_inset
12345
12346  followed by the number (e.
12347 \begin_inset space \thinspace{}
12348 \end_inset
12349
12350 g.
12351 \begin_inset space \space{}
12352 \end_inset
12353
12354
12355 \begin_inset Flex Code
12356 status collapsed
12357
12358 \begin_layout Plain Layout
12359 Argument item:1
12360 \end_layout
12361
12362 \end_inset
12363
12364 ).
12365 \end_layout
12366
12367 \end_deeper
12368 \begin_layout Description
12369 \begin_inset Flex Code
12370 status collapsed
12371
12372 \begin_layout Plain Layout
12373 BabelPreamble
12374 \end_layout
12375
12376 \end_inset
12377
12378  Note that this will completely override any prior 
12379 \begin_inset Flex Code
12380 status collapsed
12381
12382 \begin_layout Plain Layout
12383 BabelPreamble
12384 \end_layout
12385
12386 \end_inset
12387
12388  declaration for this style.
12389  Must end with 
12390 \begin_inset Quotes eld
12391 \end_inset
12392
12393
12394 \begin_inset Flex Code
12395 status collapsed
12396
12397 \begin_layout Plain Layout
12398 EndBabelPreamble
12399 \end_layout
12400
12401 \end_inset
12402
12403
12404 \begin_inset Quotes erd
12405 \end_inset
12406
12407 .
12408  See 
12409 \begin_inset CommandInset ref
12410 LatexCommand ref
12411 reference "subsec:I18n"
12412
12413 \end_inset
12414
12415  for details on its use.
12416 \end_layout
12417
12418 \begin_layout Description
12419 \begin_inset Flex Code
12420 status collapsed
12421
12422 \begin_layout Plain Layout
12423 BottomSep
12424 \end_layout
12425
12426 \end_inset
12427
12428  [
12429 \begin_inset Flex Code
12430 status collapsed
12431
12432 \begin_layout Plain Layout
12433 float=0
12434 \end_layout
12435
12436 \end_inset
12437
12438 ]
12439 \begin_inset Foot
12440 status collapsed
12441
12442 \begin_layout Plain Layout
12443 Note that a `float' here is a real number, such as: 1.5.
12444 \end_layout
12445
12446 \end_inset
12447
12448  The vertical space with which the last of a chain of paragraphs with this
12449  style is separated from the following paragraph.
12450  If the next paragraph has another style, the separations are not simply
12451  added, but the maximum is taken.
12452 \end_layout
12453
12454 \begin_layout Description
12455 \begin_inset Flex Code
12456 status collapsed
12457
12458 \begin_layout Plain Layout
12459 Category
12460 \end_layout
12461
12462 \end_inset
12463
12464  [
12465 \begin_inset Flex Code
12466 status collapsed
12467
12468 \begin_layout Plain Layout
12469 string
12470 \end_layout
12471
12472 \end_inset
12473
12474 ] The category for this style.
12475  This is used to group related styles in the style combobox on the toolbar.
12476  Any string can be used, but you may want to use existing categories with
12477  your own styles.
12478  
12479 \end_layout
12480
12481 \begin_layout Description
12482 \begin_inset Flex Code
12483 status collapsed
12484
12485 \begin_layout Plain Layout
12486 CommandDepth
12487 \end_layout
12488
12489 \end_inset
12490
12491  Depth of XML command.
12492  Used only with XML-type formats.
12493 \end_layout
12494
12495 \begin_layout Description
12496 \begin_inset Flex Code
12497 status collapsed
12498
12499 \begin_layout Plain Layout
12500 CopyStyle
12501 \end_layout
12502
12503 \end_inset
12504
12505  [
12506 \begin_inset Flex Code
12507 status collapsed
12508
12509 \begin_layout Plain Layout
12510 string
12511 \end_layout
12512
12513 \end_inset
12514
12515 ] Copies all the features of an existing style into the current one.
12516  
12517 \end_layout
12518
12519 \begin_layout Description
12520 \begin_inset Flex Code
12521 status collapsed
12522
12523 \begin_layout Plain Layout
12524 DependsOn
12525 \end_layout
12526
12527 \end_inset
12528
12529  [
12530 \begin_inset Flex Code
12531 status collapsed
12532
12533 \begin_layout Plain Layout
12534 <name>
12535 \end_layout
12536
12537 \end_inset
12538
12539 ] The name of a style whose preamble should be output 
12540 \emph on
12541 before
12542 \emph default
12543  this one.
12544  This allows to ensure some ordering of the preamble snippets when macros
12545  definitions depend on one another.
12546 \begin_inset Foot
12547 status collapsed
12548
12549 \begin_layout Plain Layout
12550 Note that, besides that functionality, there is no way to ensure any ordering
12551  of preambles.
12552  The ordering that you see in a given version of \SpecialChar LyX
12553  may change without warning
12554  in later versions.
12555 \end_layout
12556
12557 \end_inset
12558
12559
12560 \end_layout
12561
12562 \begin_layout Description
12563 \begin_inset Flex Code
12564 status collapsed
12565
12566 \begin_layout Plain Layout
12567 EndLabeltype
12568 \end_layout
12569
12570 \end_inset
12571
12572  [
12573 \begin_inset Flex Code
12574 status collapsed
12575
12576 \begin_layout Plain Layout
12577
12578 \emph on
12579 No_Label
12580 \emph default
12581 , Box, Filled_Box, Static
12582 \end_layout
12583
12584 \end_inset
12585
12586 ] The type of label that stands at the end of the paragraph (or sequence
12587  of paragraphs if 
12588 \begin_inset Flex Code
12589 status collapsed
12590
12591 \begin_layout Plain Layout
12592 LatexType
12593 \end_layout
12594
12595 \end_inset
12596
12597  is
12598 \begin_inset Newline newline
12599 \end_inset
12600
12601
12602 \begin_inset Flex Code
12603 status collapsed
12604
12605 \begin_layout Plain Layout
12606 Environment
12607 \end_layout
12608
12609 \end_inset
12610
12611
12612 \begin_inset Flex Code
12613 status collapsed
12614
12615 \begin_layout Plain Layout
12616 Item_Environment
12617 \end_layout
12618
12619 \end_inset
12620
12621  or 
12622 \begin_inset Flex Code
12623 status collapsed
12624
12625 \begin_layout Plain Layout
12626 List_Environment
12627 \end_layout
12628
12629 \end_inset
12630
12631 ).
12632  
12633 \begin_inset Flex Code
12634 status collapsed
12635
12636 \begin_layout Plain Layout
12637 No_Label
12638 \end_layout
12639
12640 \end_inset
12641
12642  means 
12643 \begin_inset Quotes eld
12644 \end_inset
12645
12646 nothing
12647 \begin_inset Quotes erd
12648 \end_inset
12649
12650
12651 \begin_inset Flex Code
12652 status collapsed
12653
12654 \begin_layout Plain Layout
12655 Box
12656 \end_layout
12657
12658 \end_inset
12659
12660  (resp.
12661 \begin_inset space \space{}
12662 \end_inset
12663
12664
12665 \begin_inset Flex Code
12666 status collapsed
12667
12668 \begin_layout Plain Layout
12669 Filled_Box
12670 \end_layout
12671
12672 \end_inset
12673
12674 ) is a white (resp.
12675 \begin_inset space ~
12676 \end_inset
12677
12678 black) square suitable for end of proof markers, 
12679 \begin_inset Flex Code
12680 status collapsed
12681
12682 \begin_layout Plain Layout
12683 Static
12684 \end_layout
12685
12686 \end_inset
12687
12688  is an explicit text string.
12689 \end_layout
12690
12691 \begin_layout Description
12692 \begin_inset Flex Code
12693 status collapsed
12694
12695 \begin_layout Plain Layout
12696 EndLabelString
12697 \end_layout
12698
12699 \end_inset
12700
12701  [
12702 \begin_inset Flex Code
12703 status collapsed
12704
12705 \begin_layout Plain Layout
12706 string=""
12707 \end_layout
12708
12709 \end_inset
12710
12711 ] The string used for a label with a 
12712 \begin_inset Flex Code
12713 status collapsed
12714
12715 \begin_layout Plain Layout
12716 Static
12717 \end_layout
12718
12719 \end_inset
12720
12721
12722 \begin_inset Newline newline
12723 \end_inset
12724
12725
12726 \begin_inset Flex Code
12727 status collapsed
12728
12729 \begin_layout Plain Layout
12730 EndLabelType
12731 \end_layout
12732
12733 \end_inset
12734
12735 .
12736  
12737 \end_layout
12738
12739 \begin_layout Description
12740 \begin_inset Flex Code
12741 status collapsed
12742
12743 \begin_layout Plain Layout
12744 Font
12745 \end_layout
12746
12747 \end_inset
12748
12749  The font used for both the text body 
12750 \emph on
12751 and
12752 \emph default
12753  the label.
12754  See 
12755 \begin_inset CommandInset ref
12756 LatexCommand ref
12757 reference "subsec:Font-description"
12758
12759 \end_inset
12760
12761 .
12762  Note that defining this font automatically defines the 
12763 \begin_inset Flex Code
12764 status collapsed
12765
12766 \begin_layout Plain Layout
12767 LabelFont
12768 \end_layout
12769
12770 \end_inset
12771
12772  to the same value.
12773  So you should define this one first if you also want to define 
12774 \begin_inset Flex Code
12775 status collapsed
12776
12777 \begin_layout Plain Layout
12778 LabelFont
12779 \end_layout
12780
12781 \end_inset
12782
12783 .
12784 \end_layout
12785
12786 \begin_layout Description
12787 \begin_inset Flex Code
12788 status collapsed
12789
12790 \begin_layout Plain Layout
12791 ForceLocal
12792 \end_layout
12793
12794 \end_inset
12795
12796  [
12797 \begin_inset Flex Code
12798 status collapsed
12799
12800 \begin_layout Plain Layout
12801 int=0
12802 \end_layout
12803
12804 \end_inset
12805
12806 ] Used for backporting new styles to stable \SpecialChar LyX
12807  versions.
12808  The first stable version that supports this tag is \SpecialChar LyX
12809  2.1.0.
12810  The argument is a number which may either be 0, -1 or any value greater
12811  than zero.
12812  If the 
12813 \begin_inset Flex Code
12814 status collapsed
12815
12816 \begin_layout Plain Layout
12817 ForceLocal
12818 \end_layout
12819
12820 \end_inset
12821
12822  flag of a style is greater than zero, it will always be written to the
12823  document header.
12824  If a .lyx file is read, the style definitions from the document header are
12825  added to the document class.
12826  Therefore even older \SpecialChar LyX
12827  versions can handle the style.
12828  The argument of 
12829 \begin_inset Flex Code
12830 status collapsed
12831
12832 \begin_layout Plain Layout
12833 ForceLocal
12834 \end_layout
12835
12836 \end_inset
12837
12838  is a version number: if the style is read, and the version number is less
12839  than the version number of the already existing style in the document class,
12840  the new style is ignored.
12841  If the version number is greater, the new style replaces the existing style.
12842  A value of -1 means an infinite version number, i.
12843 \begin_inset space \thinspace{}
12844 \end_inset
12845
12846 e.
12847 \begin_inset space \space{}
12848 \end_inset
12849
12850 the style is always used.
12851 \end_layout
12852
12853 \begin_layout Description
12854 \begin_inset Flex Code
12855 status collapsed
12856
12857 \begin_layout Plain Layout
12858 FreeSpacing
12859 \end_layout
12860
12861 \end_inset
12862
12863  [
12864 \begin_inset Flex Code
12865 status collapsed
12866
12867 \begin_layout Plain Layout
12868
12869 \emph on
12870 0
12871 \end_layout
12872
12873 \end_inset
12874
12875 ,
12876 \begin_inset space \thinspace{}
12877 \end_inset
12878
12879
12880 \begin_inset Flex Code
12881 status collapsed
12882
12883 \begin_layout Plain Layout
12884 1
12885 \end_layout
12886
12887 \end_inset
12888
12889 ] Usually \SpecialChar LyX
12890  does not allow you to insert more than one space between words,
12891  since a space is considered as the separation between two words, not a
12892  character or symbol of its own.
12893  This is a very fine thing but sometimes annoying, for example, when typing
12894  program code or plain \SpecialChar LaTeX
12895  code.
12896  For this reason, 
12897 \begin_inset Flex Code
12898 status collapsed
12899
12900 \begin_layout Plain Layout
12901 FreeSpacing
12902 \end_layout
12903
12904 \end_inset
12905
12906  can be enabled.
12907  Note that \SpecialChar LyX
12908  will create protected blanks for the additional blanks when
12909  in another mode than \SpecialChar LaTeX
12910 -mode.
12911 \end_layout
12912
12913 \begin_layout Description
12914 \begin_inset Flex Code
12915 status collapsed
12916
12917 \begin_layout Plain Layout
12918 HTML*
12919 \end_layout
12920
12921 \end_inset
12922
12923  These tags are used with XHTML output.
12924  See 
12925 \begin_inset CommandInset ref
12926 LatexCommand ref
12927 reference "subsec:Paragraph-Style-XHTML"
12928
12929 \end_inset
12930
12931 .
12932 \end_layout
12933
12934 \begin_layout Description
12935 \begin_inset Flex Code
12936 status collapsed
12937
12938 \begin_layout Plain Layout
12939 InnerTag
12940 \end_layout
12941
12942 \end_inset
12943
12944  [FIXME] (Used only with XML-type formats.)
12945 \end_layout
12946
12947 \begin_layout Description
12948 \begin_inset Flex Code
12949 status collapsed
12950
12951 \begin_layout Plain Layout
12952 InPreamble
12953 \end_layout
12954
12955 \end_inset
12956
12957  [
12958 \begin_inset Flex Code
12959 status collapsed
12960
12961 \begin_layout Plain Layout
12962
12963 \emph on
12964 0
12965 \end_layout
12966
12967 \end_inset
12968
12969 ,
12970 \begin_inset space \thinspace{}
12971 \end_inset
12972
12973
12974 \begin_inset Flex Code
12975 status collapsed
12976
12977 \begin_layout Plain Layout
12978 1
12979 \end_layout
12980
12981 \end_inset
12982
12983 ] If 
12984 \begin_inset Flex Code
12985 status collapsed
12986
12987 \begin_layout Plain Layout
12988 1
12989 \end_layout
12990
12991 \end_inset
12992
12993 , marks the style as to be included in the document preamble and not in
12994  the document body.
12995  This is useful for document classes that want such information as the title
12996  and author to appear in the preamble.
12997  Note that this works only for styles for which the 
12998 \begin_inset Flex Code
12999 status collapsed
13000
13001 \begin_layout Plain Layout
13002 LatexType
13003 \end_layout
13004
13005 \end_inset
13006
13007  is 
13008 \begin_inset Flex Code
13009 status collapsed
13010
13011 \begin_layout Plain Layout
13012 Command
13013 \end_layout
13014
13015 \end_inset
13016
13017  or 
13018 \begin_inset Flex Code
13019 status collapsed
13020
13021 \begin_layout Plain Layout
13022 Paragraph
13023 \end_layout
13024
13025 \end_inset
13026
13027 .
13028 \end_layout
13029
13030 \begin_layout Description
13031 \begin_inset Flex Code
13032 status collapsed
13033
13034 \begin_layout Plain Layout
13035 InTitle
13036 \end_layout
13037
13038 \end_inset
13039
13040  [
13041 \begin_inset Flex Code
13042 status collapsed
13043
13044 \begin_layout Plain Layout
13045
13046 \emph on
13047 0
13048 \end_layout
13049
13050 \end_inset
13051
13052 ,
13053 \begin_inset space \thinspace{}
13054 \end_inset
13055
13056
13057 \begin_inset Flex Code
13058 status collapsed
13059
13060 \begin_layout Plain Layout
13061 1
13062 \end_layout
13063
13064 \end_inset
13065
13066 ] If 
13067 \begin_inset Flex Code
13068 status collapsed
13069
13070 \begin_layout Plain Layout
13071 1
13072 \end_layout
13073
13074 \end_inset
13075
13076 , marks the style as being part of a title block (see also the 
13077 \begin_inset Flex Code
13078 status collapsed
13079
13080 \begin_layout Plain Layout
13081 TitleLatexType
13082 \end_layout
13083
13084 \end_inset
13085
13086  and 
13087 \begin_inset Flex Code
13088 status collapsed
13089
13090 \begin_layout Plain Layout
13091 TitleLatexName
13092 \end_layout
13093
13094 \end_inset
13095
13096  global entries).
13097 \end_layout
13098
13099 \begin_layout Description
13100
13101 \change_inserted 2047637253 1483902824
13102 \begin_inset Flex Code
13103 status collapsed
13104
13105 \begin_layout Plain Layout
13106
13107 \change_inserted 2047637253 1483902211
13108 IsTocCaption
13109 \end_layout
13110
13111 \end_inset
13112
13113  [
13114 \begin_inset Flex Code
13115 status collapsed
13116
13117 \begin_layout Plain Layout
13118
13119 \change_inserted 2047637253 1483902211
13120
13121 \emph on
13122 0
13123 \end_layout
13124
13125 \end_inset
13126
13127 ,
13128 \begin_inset space \thinspace{}
13129 \end_inset
13130
13131
13132 \begin_inset Flex Code
13133 status collapsed
13134
13135 \begin_layout Plain Layout
13136
13137 \change_inserted 2047637253 1483902211
13138 1
13139 \end_layout
13140
13141 \end_inset
13142
13143 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13144  of its contents in its item in the table of contents.
13145  Otherwise, only the label, if it exists, appears.
13146 \end_layout
13147
13148 \begin_layout Description
13149 \begin_inset Flex Code
13150 status collapsed
13151
13152 \begin_layout Plain Layout
13153 ItemCommand
13154 \end_layout
13155
13156 \end_inset
13157
13158  [
13159 \begin_inset Flex Code
13160 status collapsed
13161
13162 \begin_layout Plain Layout
13163 string="item"
13164 \end_layout
13165
13166 \end_inset
13167
13168 ] The \SpecialChar LaTeX
13169  command sequence declaring an item in a list.
13170  The command is to be defined without the preceding backslash (the default
13171  is 
13172 \begin_inset Quotes eld
13173 \end_inset
13174
13175 item
13176 \begin_inset Quotes erd
13177 \end_inset
13178
13179 , resulting in 
13180 \begin_inset Flex Code
13181 status collapsed
13182
13183 \begin_layout Plain Layout
13184
13185 \backslash
13186 item
13187 \end_layout
13188
13189 \end_inset
13190
13191  in the \SpecialChar LaTeX
13192  output).
13193 \end_layout
13194
13195 \begin_layout Description
13196 \begin_inset Flex Code
13197 status collapsed
13198
13199 \begin_layout Plain Layout
13200 ItemSep
13201 \end_layout
13202
13203 \end_inset
13204
13205  [
13206 \begin_inset Flex Code
13207 status collapsed
13208
13209 \begin_layout Plain Layout
13210 float=0
13211 \end_layout
13212
13213 \end_inset
13214
13215 ] This provides extra space between paragraphs that have the same style.
13216  If you put other styles into an environment, each is separated with the
13217  environment's 
13218 \begin_inset Flex Code
13219 status collapsed
13220
13221 \begin_layout Plain Layout
13222 ParSep
13223 \end_layout
13224
13225 \end_inset
13226
13227 .
13228  But the whole items of the environment are additionally separated with
13229  this 
13230 \begin_inset Flex Code
13231 status collapsed
13232
13233 \begin_layout Plain Layout
13234 ItemSep
13235 \end_layout
13236
13237 \end_inset
13238
13239 .
13240  Note that this is a
13241 \emph on
13242  multiplier.
13243 \end_layout
13244
13245 \begin_layout Description
13246 \begin_inset Flex Code
13247 status collapsed
13248
13249 \begin_layout Plain Layout
13250 ItemTag
13251 \end_layout
13252
13253 \end_inset
13254
13255  [FIXME] (Used only with XML-type formats.)
13256 \end_layout
13257
13258 \begin_layout Description
13259 \begin_inset Flex Code
13260 status collapsed
13261
13262 \begin_layout Plain Layout
13263 KeepEmpty
13264 \end_layout
13265
13266 \end_inset
13267
13268  [
13269 \begin_inset Flex Code
13270 status collapsed
13271
13272 \begin_layout Plain Layout
13273
13274 \emph on
13275 0
13276 \end_layout
13277
13278 \end_inset
13279
13280 ,
13281 \begin_inset space \thinspace{}
13282 \end_inset
13283
13284
13285 \begin_inset Flex Code
13286 status collapsed
13287
13288 \begin_layout Plain Layout
13289 1
13290 \end_layout
13291
13292 \end_inset
13293
13294 ] Usually \SpecialChar LyX
13295  does not allow you to leave a paragraph empty, since it would
13296  lead to empty \SpecialChar LaTeX
13297  output.
13298  There are some cases where this could be desirable however: in a letter
13299  template, the required fields can be provided as empty fields, so that
13300  people do not forget them; in some special classes, a style can be used
13301  as some kind of break, which does not contain actual text.
13302 \end_layout
13303
13304 \begin_layout Description
13305 \begin_inset Flex Code
13306 status collapsed
13307
13308 \begin_layout Plain Layout
13309 LabelBottomsep
13310 \end_layout
13311
13312 \end_inset
13313
13314  [
13315 \begin_inset Flex Code
13316 status collapsed
13317
13318 \begin_layout Plain Layout
13319 float=0
13320 \end_layout
13321
13322 \end_inset
13323
13324 ] The vertical space between the label and the text body.
13325  Only used for labels that are above the text body (
13326 \begin_inset Flex Code
13327 status collapsed
13328
13329 \begin_layout Plain Layout
13330 Top_Environment
13331 \end_layout
13332
13333 \end_inset
13334
13335  and
13336 \begin_inset Newline newline
13337 \end_inset
13338
13339
13340 \begin_inset Flex Code
13341 status collapsed
13342
13343 \begin_layout Plain Layout
13344 Centered_Top_Environment
13345 \end_layout
13346
13347 \end_inset
13348
13349 ).
13350 \end_layout
13351
13352 \begin_layout Description
13353 \begin_inset Flex Code
13354 status collapsed
13355
13356 \begin_layout Plain Layout
13357 LabelCounter
13358 \end_layout
13359
13360 \end_inset
13361
13362  [
13363 \begin_inset Flex Code
13364 status collapsed
13365
13366 \begin_layout Plain Layout
13367 string=""
13368 \end_layout
13369
13370 \end_inset
13371
13372 ] The name of the counter for automatic numbering.
13373  In order to have the counter appear with your label, you will need to reference
13374  it in the 
13375 \begin_inset Flex Code
13376 status collapsed
13377
13378 \begin_layout Plain Layout
13379
13380 \family typewriter
13381 LabelString
13382 \end_layout
13383
13384 \end_inset
13385
13386 .
13387  This will work with 
13388 \begin_inset Flex Code
13389 status collapsed
13390
13391 \begin_layout Plain Layout
13392 LabelType
13393 \end_layout
13394
13395 \end_inset
13396
13397 s, 
13398 \begin_inset Flex Code
13399 status collapsed
13400
13401 \begin_layout Plain Layout
13402 Static
13403 \end_layout
13404
13405 \end_inset
13406
13407
13408 \begin_inset Flex Code
13409 status collapsed
13410
13411 \begin_layout Plain Layout
13412 Above
13413 \end_layout
13414
13415 \end_inset
13416
13417  and 
13418 \begin_inset Flex Code
13419 status collapsed
13420
13421 \begin_layout Plain Layout
13422 Centered
13423 \end_layout
13424
13425 \end_inset
13426
13427 , at least.
13428 \begin_inset Newline newline
13429 \end_inset
13430
13431 This 
13432 \emph on
13433 may
13434 \emph default
13435  also be given if 
13436 \begin_inset Flex Code
13437 status collapsed
13438
13439 \begin_layout Plain Layout
13440 LabelType
13441 \end_layout
13442
13443 \end_inset
13444
13445  is 
13446 \begin_inset Flex Code
13447 status collapsed
13448
13449 \begin_layout Plain Layout
13450 Enumerate
13451 \end_layout
13452
13453 \end_inset
13454
13455 , though this case is a bit complicated.
13456  Suppose you declare 
13457 \begin_inset Quotes eld
13458 \end_inset
13459
13460
13461 \begin_inset Flex Code
13462 status collapsed
13463
13464 \begin_layout Plain Layout
13465 LabelCounter myenum
13466 \end_layout
13467
13468 \end_inset
13469
13470
13471 \begin_inset Quotes erd
13472 \end_inset
13473
13474 .
13475  Then the actual counters used are 
13476 \begin_inset Flex Code
13477 status collapsed
13478
13479 \begin_layout Plain Layout
13480 myenumi
13481 \end_layout
13482
13483 \end_inset
13484
13485
13486 \begin_inset Flex Code
13487 status collapsed
13488
13489 \begin_layout Plain Layout
13490 myenumii
13491 \end_layout
13492
13493 \end_inset
13494
13495
13496 \begin_inset Flex Code
13497 status collapsed
13498
13499 \begin_layout Plain Layout
13500 myenumiii
13501 \end_layout
13502
13503 \end_inset
13504
13505  and 
13506 \begin_inset Flex Code
13507 status collapsed
13508
13509 \begin_layout Plain Layout
13510 myenumiv
13511 \end_layout
13512
13513 \end_inset
13514
13515 , much as in \SpecialChar LaTeX
13516 .
13517  These counters must all be declared separately.
13518 \begin_inset Newline newline
13519 \end_inset
13520
13521 See 
13522 \begin_inset CommandInset ref
13523 LatexCommand ref
13524 reference "subsec:Counters"
13525
13526 \end_inset
13527
13528  for details on counters.
13529 \end_layout
13530
13531 \begin_layout Description
13532 \begin_inset Flex Code
13533 status collapsed
13534
13535 \begin_layout Plain Layout
13536 LabelFont
13537 \end_layout
13538
13539 \end_inset
13540
13541  The font used for the label.
13542  See 
13543 \begin_inset CommandInset ref
13544 LatexCommand ref
13545 reference "subsec:Font-description"
13546
13547 \end_inset
13548
13549 .
13550 \end_layout
13551
13552 \begin_layout Description
13553 \begin_inset Flex Code
13554 status collapsed
13555
13556 \begin_layout Plain Layout
13557 LabelIndent
13558 \end_layout
13559
13560 \end_inset
13561
13562  [
13563 \begin_inset Flex Code
13564 status collapsed
13565
13566 \begin_layout Plain Layout
13567 string=""
13568 \end_layout
13569
13570 \end_inset
13571
13572 ] Text that indicates how far a label should be indented.
13573 \end_layout
13574
13575 \begin_layout Description
13576 \begin_inset Flex Code
13577 status collapsed
13578
13579 \begin_layout Plain Layout
13580 LabelSep
13581 \end_layout
13582
13583 \end_inset
13584
13585  [
13586 \begin_inset Flex Code
13587 status collapsed
13588
13589 \begin_layout Plain Layout
13590 string=""
13591 \end_layout
13592
13593 \end_inset
13594
13595 ] Text that indicates the amount of horizontal space between the label and
13596  the text body.
13597  Only used for labels that are not above the text body.
13598 \end_layout
13599
13600 \begin_layout Description
13601 \begin_inset Flex Code
13602 status collapsed
13603
13604 \begin_layout Plain Layout
13605 LabelString
13606 \end_layout
13607
13608 \end_inset
13609
13610  [
13611 \begin_inset Flex Code
13612 status collapsed
13613
13614 \begin_layout Plain Layout
13615 string=""
13616 \end_layout
13617
13618 \end_inset
13619
13620 ] The string used for the label.
13621  When 
13622 \begin_inset Flex Code
13623 status collapsed
13624
13625 \begin_layout Plain Layout
13626 LabelCounter
13627 \end_layout
13628
13629 \end_inset
13630
13631  is set, this string can be contain the special formatting commands described
13632  in 
13633 \begin_inset CommandInset ref
13634 LatexCommand ref
13635 reference "subsec:Counters"
13636
13637 \end_inset
13638
13639 .
13640 \end_layout
13641
13642 \begin_layout Description
13643 \begin_inset Flex Code
13644 status collapsed
13645
13646 \begin_layout Plain Layout
13647 LabelStringAppendix
13648 \end_layout
13649
13650 \end_inset
13651
13652  [
13653 \begin_inset Flex Code
13654 status collapsed
13655
13656 \begin_layout Plain Layout
13657 string=""
13658 \end_layout
13659
13660 \end_inset
13661
13662 ] This is used inside the appendix instead of
13663 \begin_inset Newline newline
13664 \end_inset
13665
13666
13667 \begin_inset Flex Code
13668 status collapsed
13669
13670 \begin_layout Plain Layout
13671 LabelString
13672 \end_layout
13673
13674 \end_inset
13675
13676 .
13677  Note that every 
13678 \begin_inset Flex Code
13679 status collapsed
13680
13681 \begin_layout Plain Layout
13682 LabelString
13683 \end_layout
13684
13685 \end_inset
13686
13687  statement resets
13688 \begin_inset Newline newline
13689 \end_inset
13690
13691
13692 \begin_inset Flex Code
13693 status collapsed
13694
13695 \begin_layout Plain Layout
13696 LabelStringAppendix
13697 \end_layout
13698
13699 \end_inset
13700
13701  too.
13702 \end_layout
13703
13704 \begin_layout Description
13705 \begin_inset Flex Code
13706 status collapsed
13707
13708 \begin_layout Plain Layout
13709 LabelTag
13710 \end_layout
13711
13712 \end_inset
13713
13714  [FIXME] (Used only with XML-type formats.)
13715 \end_layout
13716
13717 \begin_layout Description
13718 \begin_inset Flex Code
13719 status collapsed
13720
13721 \begin_layout Plain Layout
13722 LabelType
13723 \end_layout
13724
13725 \end_inset
13726
13727  [
13728 \begin_inset Flex Code
13729 status collapsed
13730
13731 \begin_layout Plain Layout
13732
13733 \emph on
13734 No_Label
13735 \emph default
13736 , Manual, Static, Above, 
13737 \begin_inset Newline newline
13738 \end_inset
13739
13740 Centered, Sensitive, Enumerate,
13741 \begin_inset Newline newline
13742 \end_inset
13743
13744 Itemize, Bibliography
13745 \end_layout
13746
13747 \end_inset
13748
13749 ]
13750 \end_layout
13751
13752 \begin_deeper
13753 \begin_layout Description
13754 \begin_inset Flex Code
13755 status collapsed
13756
13757 \begin_layout Plain Layout
13758 Manual
13759 \end_layout
13760
13761 \end_inset
13762
13763  means the label is the very first word (up to the first real blank).
13764  Use protected spaces if you want more than one word as the label.
13765  
13766 \end_layout
13767
13768 \begin_layout Description
13769 \begin_inset Flex Code
13770 status collapsed
13771
13772 \begin_layout Plain Layout
13773 Static
13774 \end_layout
13775
13776 \end_inset
13777
13778  means the label is simply what is declared as 
13779 \begin_inset Flex Code
13780 status collapsed
13781
13782 \begin_layout Plain Layout
13783 LabelString
13784 \end_layout
13785
13786 \end_inset
13787
13788 .
13789  This will be displayed 
13790 \begin_inset Quotes eld
13791 \end_inset
13792
13793 inline
13794 \begin_inset Quotes erd
13795 \end_inset
13796
13797 , at the beginning of the paragraph.
13798  If the 
13799 \begin_inset Flex Code
13800 status collapsed
13801
13802 \begin_layout Plain Layout
13803 LatexType
13804 \end_layout
13805
13806 \end_inset
13807
13808  is 
13809 \begin_inset Flex Code
13810 status collapsed
13811
13812 \begin_layout Plain Layout
13813 Environment
13814 \end_layout
13815
13816 \end_inset
13817
13818 , then it will be displayed only in the first paragraph of any sequence
13819  of paragraphs with the same 
13820 \begin_inset Flex Code
13821 status collapsed
13822
13823 \begin_layout Plain Layout
13824 Style
13825 \end_layout
13826
13827 \end_inset
13828
13829 .
13830 \end_layout
13831
13832 \begin_layout Description
13833 \begin_inset Flex Code
13834 status collapsed
13835
13836 \begin_layout Plain Layout
13837 Above
13838 \end_layout
13839
13840 \end_inset
13841
13842
13843 \begin_inset space ~
13844 \end_inset
13845
13846 and
13847 \begin_inset space ~
13848 \end_inset
13849
13850
13851 \begin_inset Flex Code
13852 status collapsed
13853
13854 \begin_layout Plain Layout
13855 Centered
13856 \end_layout
13857
13858 \end_inset
13859
13860  are special cases of 
13861 \begin_inset Flex Code
13862 status collapsed
13863
13864 \begin_layout Plain Layout
13865 Static
13866 \end_layout
13867
13868 \end_inset
13869
13870 .
13871  The label will be printed above the paragraph either at the beginning of
13872  the line or centered.
13873 \end_layout
13874
13875 \begin_layout Description
13876 \begin_inset Flex Code
13877 status collapsed
13878
13879 \begin_layout Plain Layout
13880 Sensitive
13881 \end_layout
13882
13883 \end_inset
13884
13885  is a special case for the caption-labels 
13886 \begin_inset Quotes eld
13887 \end_inset
13888
13889 Figure
13890 \begin_inset Quotes erd
13891 \end_inset
13892
13893  and 
13894 \begin_inset Quotes eld
13895 \end_inset
13896
13897 Table
13898 \begin_inset Quotes erd
13899 \end_inset
13900
13901 .
13902 \begin_inset Newline newline
13903 \end_inset
13904
13905
13906 \begin_inset Flex Code
13907 status collapsed
13908
13909 \begin_layout Plain Layout
13910 Sensitive
13911 \end_layout
13912
13913 \end_inset
13914
13915  means the (hardcoded) label string depends on the kind of float: It is
13916  hardcoded to be `FloatType N', where N is the value of the counter associated
13917  with the float.
13918  For the case that a caption is inserted outside of a float the 
13919 \begin_inset Flex Code
13920 status collapsed
13921
13922 \begin_layout Plain Layout
13923 LabelString
13924 \end_layout
13925
13926 \end_inset
13927
13928  will appear as 
13929 \begin_inset Quotes eld
13930 \end_inset
13931
13932 Senseless!
13933 \begin_inset Quotes erd
13934 \end_inset
13935
13936 .
13937 \end_layout
13938
13939 \begin_layout Description
13940 \begin_inset Flex Code
13941 status collapsed
13942
13943 \begin_layout Plain Layout
13944 Enumerate
13945 \end_layout
13946
13947 \end_inset
13948
13949  produces the usual sort of enumeration labels.
13950  At present, it is hardcoded to use Arabic numerals, lowercase letters,
13951  small Roman numerals, and uppercase letters for the four possible depths.
13952 \end_layout
13953
13954 \begin_layout Description
13955 \begin_inset Flex Code
13956 status collapsed
13957
13958 \begin_layout Plain Layout
13959 Itemize
13960 \end_layout
13961
13962 \end_inset
13963
13964  produces various bullets at the different levels.
13965  It is also hardcoded.
13966 \end_layout
13967
13968 \begin_layout Description
13969 \begin_inset Flex Code
13970 status collapsed
13971
13972 \begin_layout Plain Layout
13973 Bibliography
13974 \end_layout
13975
13976 \end_inset
13977
13978  should be used only with 
13979 \begin_inset Flex Code
13980 status collapsed
13981
13982 \begin_layout Plain Layout
13983 LatexType BibEnvironment
13984 \end_layout
13985
13986 \end_inset
13987
13988 .
13989 \end_layout
13990
13991 \end_deeper
13992 \begin_layout Description
13993 \begin_inset Flex Code
13994 status collapsed
13995
13996 \begin_layout Plain Layout
13997 LangPreamble
13998 \end_layout
13999
14000 \end_inset
14001
14002  Note that this will completely override any prior 
14003 \begin_inset Flex Code
14004 status collapsed
14005
14006 \begin_layout Plain Layout
14007 LangPreamble
14008 \end_layout
14009
14010 \end_inset
14011
14012  declaration for this style.
14013  Must end with 
14014 \begin_inset Quotes eld
14015 \end_inset
14016
14017
14018 \begin_inset Flex Code
14019 status collapsed
14020
14021 \begin_layout Plain Layout
14022 EndLangPreamble
14023 \end_layout
14024
14025 \end_inset
14026
14027
14028 \begin_inset Quotes erd
14029 \end_inset
14030
14031 .
14032  See 
14033 \begin_inset CommandInset ref
14034 LatexCommand ref
14035 reference "subsec:I18n"
14036
14037 \end_inset
14038
14039  for details on its use.
14040 \end_layout
14041
14042 \begin_layout Description
14043 \begin_inset Flex Code
14044 status collapsed
14045
14046 \begin_layout Plain Layout
14047 LatexName
14048 \end_layout
14049
14050 \end_inset
14051
14052  [
14053 \begin_inset Flex Code
14054 status collapsed
14055
14056 \begin_layout Plain Layout
14057 <name>
14058 \end_layout
14059
14060 \end_inset
14061
14062 ] The name of the corresponding \SpecialChar LaTeX
14063  stuff.
14064  Either the environment or command name.
14065 \end_layout
14066
14067 \begin_layout Description
14068 \begin_inset Flex Code
14069 status collapsed
14070
14071 \begin_layout Plain Layout
14072 LatexParam
14073 \end_layout
14074
14075 \end_inset
14076
14077  [
14078 \begin_inset Flex Code
14079 status collapsed
14080
14081 \begin_layout Plain Layout
14082 <parameter>
14083 \end_layout
14084
14085 \end_inset
14086
14087 ] An optional parameter for the corresponding 
14088 \begin_inset Flex Code
14089 status collapsed
14090
14091 \begin_layout Plain Layout
14092 LatexName
14093 \end_layout
14094
14095 \end_inset
14096
14097  stuff.
14098  This parameter cannot be changed from within \SpecialChar LyX
14099  (use 
14100 \begin_inset Flex Code
14101 status collapsed
14102
14103 \begin_layout Plain Layout
14104 Argument
14105 \end_layout
14106
14107 \end_inset
14108
14109  for customizable parameters).
14110  This will be output as is after all \SpecialChar LaTeX
14111  
14112 \begin_inset Flex Code
14113 status collapsed
14114
14115 \begin_layout Plain Layout
14116 Argument
14117 \end_layout
14118
14119 \end_inset
14120
14121 s.
14122 \end_layout
14123
14124 \begin_layout Description
14125 \begin_inset Flex Code
14126 status collapsed
14127
14128 \begin_layout Plain Layout
14129 LatexType
14130 \end_layout
14131
14132 \end_inset
14133
14134  [
14135 \begin_inset Flex Code
14136 status collapsed
14137
14138 \begin_layout Plain Layout
14139
14140 \emph on
14141 Paragraph
14142 \emph default
14143 , Command, Environment, Item_Environment,
14144 \begin_inset Newline newline
14145 \end_inset
14146
14147 List_Environment, Bib_Environment
14148 \end_layout
14149
14150 \end_inset
14151
14152 ] How the style should be translated into \SpecialChar LaTeX
14153 .
14154 \begin_inset Foot
14155 status collapsed
14156
14157 \begin_layout Plain Layout
14158 \begin_inset Flex Code
14159 status collapsed
14160
14161 \begin_layout Plain Layout
14162 LatexType
14163 \end_layout
14164
14165 \end_inset
14166
14167  is perhaps a bit misleading, since these rules apply to SGML classes, too.
14168  Visit the SGML class files for specific examples.
14169 \end_layout
14170
14171 \end_inset
14172
14173
14174 \end_layout
14175
14176 \begin_deeper
14177 \begin_layout Description
14178 \begin_inset Flex Code
14179 status collapsed
14180
14181 \begin_layout Plain Layout
14182 Paragraph
14183 \end_layout
14184
14185 \end_inset
14186
14187  means nothing special.
14188 \end_layout
14189
14190 \begin_layout Description
14191 \begin_inset Flex Code
14192 status collapsed
14193
14194 \begin_layout Plain Layout
14195 Command
14196 \end_layout
14197
14198 \end_inset
14199
14200  means 
14201 \begin_inset Flex Code
14202 status collapsed
14203
14204 \begin_layout Plain Layout
14205
14206 \backslash
14207
14208 \emph on
14209 LatexName
14210 \emph default
14211 {\SpecialChar ldots
14212 }
14213 \end_layout
14214
14215 \end_inset
14216
14217 .
14218 \end_layout
14219
14220 \begin_layout Description
14221 \begin_inset Flex Code
14222 status collapsed
14223
14224 \begin_layout Plain Layout
14225 Environment
14226 \end_layout
14227
14228 \end_inset
14229
14230  means 
14231 \begin_inset Flex Code
14232 status collapsed
14233
14234 \begin_layout Plain Layout
14235
14236 \backslash
14237 begin{
14238 \emph on
14239 LatexName
14240 \emph default
14241 }\SpecialChar ldots
14242
14243 \backslash
14244 end{
14245 \emph on
14246 LatexName
14247 \emph default
14248 }
14249 \end_layout
14250
14251 \end_inset
14252
14253 .
14254  
14255 \end_layout
14256
14257 \begin_layout Description
14258 \begin_inset Flex Code
14259 status collapsed
14260
14261 \begin_layout Plain Layout
14262 Item_Environment
14263 \end_layout
14264
14265 \end_inset
14266
14267  is the same as 
14268 \begin_inset Flex Code
14269 status collapsed
14270
14271 \begin_layout Plain Layout
14272 Environment
14273 \end_layout
14274
14275 \end_inset
14276
14277 , except that an 
14278 \begin_inset Flex Code
14279 status collapsed
14280
14281 \begin_layout Plain Layout
14282
14283 \backslash
14284 item
14285 \end_layout
14286
14287 \end_inset
14288
14289  is generated for each paragraph of this environment.
14290  
14291 \end_layout
14292
14293 \begin_layout Description
14294 \begin_inset Flex Code
14295 status collapsed
14296
14297 \begin_layout Plain Layout
14298 List_Environment
14299 \end_layout
14300
14301 \end_inset
14302
14303  is the same as 
14304 \begin_inset Flex Code
14305 status collapsed
14306
14307 \begin_layout Plain Layout
14308 Item_Environment
14309 \end_layout
14310
14311 \end_inset
14312
14313 , except that
14314 \begin_inset Newline newline
14315 \end_inset
14316
14317
14318 \begin_inset Flex Code
14319 status collapsed
14320
14321 \begin_layout Plain Layout
14322 LabelWidthString
14323 \end_layout
14324
14325 \end_inset
14326
14327  is passed as an argument to the environment.
14328 \begin_inset Newline newline
14329 \end_inset
14330
14331
14332 \begin_inset Flex Code
14333 status collapsed
14334
14335 \begin_layout Plain Layout
14336 LabelWidthString
14337 \end_layout
14338
14339 \end_inset
14340
14341  can be defined in the 
14342 \begin_inset Flex Noun
14343 status collapsed
14344
14345 \begin_layout Plain Layout
14346 Edit\SpecialChar menuseparator
14347 Paragraph
14348 \begin_inset space ~
14349 \end_inset
14350
14351 settings
14352 \end_layout
14353
14354 \end_inset
14355
14356  dialog.
14357 \end_layout
14358
14359 \begin_layout Description
14360 \begin_inset Flex Code
14361 status collapsed
14362
14363 \begin_layout Plain Layout
14364 Bib_Environment
14365 \end_layout
14366
14367 \end_inset
14368
14369  is like 
14370 \begin_inset Flex Code
14371 status collapsed
14372
14373 \begin_layout Plain Layout
14374 Environment
14375 \end_layout
14376
14377 \end_inset
14378
14379  but adds the necessary mandatory argument (the longest label) to the begin
14380  statement of the bibliography environment:
14381 \begin_inset Newline newline
14382 \end_inset
14383
14384
14385 \begin_inset Flex Code
14386 status collapsed
14387
14388 \begin_layout Plain Layout
14389
14390 \backslash
14391 begin{thebibliography}{99}
14392 \end_layout
14393
14394 \end_inset
14395
14396 .
14397  It is therefore only useful for bibliography environments.
14398  The default longest label 
14399 \begin_inset Quotes eld
14400 \end_inset
14401
14402 99
14403 \begin_inset Quotes erd
14404 \end_inset
14405
14406  can be changed by the user in the paragraph settings of a bibliography
14407  item.
14408 \end_layout
14409
14410 \begin_layout Standard
14411 Putting the last few things together, the \SpecialChar LaTeX
14412  output will be either: 
14413 \end_layout
14414
14415 \begin_layout LyX-Code
14416
14417 \backslash
14418 LatexName[LatexParam]{\SpecialChar ldots
14419 }
14420 \end_layout
14421
14422 \begin_layout Standard
14423 or: 
14424 \end_layout
14425
14426 \begin_layout LyX-Code
14427
14428 \backslash
14429 begin{LatexName}[LatexParam] \SpecialChar ldots
14430  
14431 \backslash
14432 end{LatexName}.
14433 \end_layout
14434
14435 \begin_layout Standard
14436 depending upon the \SpecialChar LaTeX
14437  type.
14438 \end_layout
14439
14440 \end_deeper
14441 \begin_layout Description
14442 \begin_inset Flex Code
14443 status collapsed
14444
14445 \begin_layout Plain Layout
14446 LeftDelim
14447 \end_layout
14448
14449 \end_inset
14450
14451  [
14452 \begin_inset Flex Code
14453 status collapsed
14454
14455 \begin_layout Plain Layout
14456 string
14457 \end_layout
14458
14459 \end_inset
14460
14461 ] A string that is put at the beginning of the style content.
14462  A line break in the output can be indicated by 
14463 \begin_inset Flex Code
14464 status collapsed
14465
14466 \begin_layout Plain Layout
14467 <br/>
14468 \end_layout
14469
14470 \end_inset
14471
14472 .
14473 \end_layout
14474
14475 \begin_layout Description
14476 \begin_inset Flex Code
14477 status collapsed
14478
14479 \begin_layout Plain Layout
14480 LeftMargin
14481 \end_layout
14482
14483 \end_inset
14484
14485  [
14486 \begin_inset Flex Code
14487 status collapsed
14488
14489 \begin_layout Plain Layout
14490 string=""
14491 \end_layout
14492
14493 \end_inset
14494
14495 ] If you put styles into environments, the different 
14496 \begin_inset Flex Code
14497 status collapsed
14498
14499 \begin_layout Plain Layout
14500 LeftMargin
14501 \end_layout
14502
14503 \end_inset
14504
14505  are not simply added, but added with a factor 
14506 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14507 \end_inset
14508
14509 .
14510  Note that this parameter is also used when 
14511 \begin_inset Flex Code
14512 status collapsed
14513
14514 \begin_layout Plain Layout
14515 Margin
14516 \end_layout
14517
14518 \end_inset
14519
14520  is defined as 
14521 \begin_inset Flex Code
14522 status collapsed
14523
14524 \begin_layout Plain Layout
14525 Manual
14526 \end_layout
14527
14528 \end_inset
14529
14530  or 
14531 \begin_inset Flex Code
14532 status collapsed
14533
14534 \begin_layout Plain Layout
14535 Dynamic
14536 \end_layout
14537
14538 \end_inset
14539
14540 .
14541  Then it is added to the manual or dynamic margin.
14542 \begin_inset Newline newline
14543 \end_inset
14544
14545 For example 
14546 \begin_inset Quotes eld
14547 \end_inset
14548
14549
14550 \begin_inset Flex Code
14551 status collapsed
14552
14553 \begin_layout Plain Layout
14554 MM
14555 \end_layout
14556
14557 \end_inset
14558
14559
14560 \begin_inset Quotes erd
14561 \end_inset
14562
14563  means that the paragraph is indented with the width of 
14564 \begin_inset Quotes eld
14565 \end_inset
14566
14567
14568 \begin_inset Flex Code
14569 status collapsed
14570
14571 \begin_layout Plain Layout
14572 MM
14573 \end_layout
14574
14575 \end_inset
14576
14577
14578 \begin_inset Quotes erd
14579 \end_inset
14580
14581  in the normal font.
14582  You can get a negative width by prefixing the string with 
14583 \begin_inset Quotes eld
14584 \end_inset
14585
14586
14587 \begin_inset Flex Code
14588 status collapsed
14589
14590 \begin_layout Plain Layout
14591 -
14592 \end_layout
14593
14594 \end_inset
14595
14596
14597 \begin_inset Quotes erd
14598 \end_inset
14599
14600 .
14601  This way was chosen so that the look is the same with each used screen
14602  font.
14603 \end_layout
14604
14605 \begin_layout Description
14606 \begin_inset Flex Code
14607 status collapsed
14608
14609 \begin_layout Plain Layout
14610 Margin
14611 \end_layout
14612
14613 \end_inset
14614
14615  [
14616 \begin_inset Flex Code
14617 status collapsed
14618
14619 \begin_layout Plain Layout
14620
14621 \emph on
14622 Static
14623 \emph default
14624 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14625 \end_layout
14626
14627 \end_inset
14628
14629
14630 \begin_inset Newline newline
14631 \end_inset
14632
14633 The kind of margin that the style has on the left side.
14634 \end_layout
14635
14636 \begin_deeper
14637 \begin_layout Description
14638 \begin_inset Flex Code
14639 status collapsed
14640
14641 \begin_layout Plain Layout
14642 Static
14643 \end_layout
14644
14645 \end_inset
14646
14647  just means a fixed margin.
14648 \end_layout
14649
14650 \begin_layout Description
14651 \begin_inset Flex Code
14652 status collapsed
14653
14654 \begin_layout Plain Layout
14655 Manual
14656 \end_layout
14657
14658 \end_inset
14659
14660  means that the left margin depends on the string entered in the 
14661 \begin_inset Flex Noun
14662 status collapsed
14663
14664 \begin_layout Plain Layout
14665 Edit\SpecialChar menuseparator
14666 Paragraph
14667 \begin_inset space ~
14668 \end_inset
14669
14670 Settings
14671 \end_layout
14672
14673 \end_inset
14674
14675  dialog.
14676  This is used to typeset nice lists without tabulators.
14677 \end_layout
14678
14679 \begin_layout Description
14680 \begin_inset Flex Code
14681 status collapsed
14682
14683 \begin_layout Plain Layout
14684 Dynamic
14685 \end_layout
14686
14687 \end_inset
14688
14689  means that the margin depends on the size of the label.
14690  This is used for automatic enumerated headlines.
14691  It is obvious that the headline 
14692 \begin_inset Quotes eld
14693 \end_inset
14694
14695 5.4.3.2.1 Very long headline
14696 \begin_inset Quotes erd
14697 \end_inset
14698
14699  must have a wider left margin (as wide as 
14700 \begin_inset Quotes eld
14701 \end_inset
14702
14703 5.4.3.2.1
14704 \begin_inset Quotes erd
14705 \end_inset
14706
14707  plus the space) than 
14708 \begin_inset Quotes eld
14709 \end_inset
14710
14711 3.2 Very long headline
14712 \begin_inset Quotes erd
14713 \end_inset
14714
14715 , even if standard 
14716 \begin_inset Quotes eld
14717 \end_inset
14718
14719 word processors
14720 \begin_inset Quotes erd
14721 \end_inset
14722
14723  are not able to do this.
14724 \end_layout
14725
14726 \begin_layout Description
14727 \begin_inset Flex Code
14728 status collapsed
14729
14730 \begin_layout Plain Layout
14731 First_Dynamic
14732 \end_layout
14733
14734 \end_inset
14735
14736  is similar, but only the very first row of the paragraph is dynamic, while
14737  the others are static; this is used, for example, for descriptions.
14738 \end_layout
14739
14740 \begin_layout Description
14741 \begin_inset Flex Code
14742 status collapsed
14743
14744 \begin_layout Plain Layout
14745 Right_Address_Box
14746 \end_layout
14747
14748 \end_inset
14749
14750  means the margin is chosen in a way that the longest row of this paragraph
14751  fits to the right margin.
14752  This is used to typeset an address on the right edge of the page.
14753 \end_layout
14754
14755 \end_deeper
14756 \begin_layout Description
14757 \begin_inset Flex Code
14758 status collapsed
14759
14760 \begin_layout Plain Layout
14761 NeedProtect
14762 \end_layout
14763
14764 \end_inset
14765
14766  [
14767 \begin_inset Flex Code
14768 status collapsed
14769
14770 \begin_layout Plain Layout
14771
14772 \emph on
14773 0
14774 \end_layout
14775
14776 \end_inset
14777
14778 ,
14779 \begin_inset space \thinspace{}
14780 \end_inset
14781
14782
14783 \begin_inset Flex Code
14784 status collapsed
14785
14786 \begin_layout Plain Layout
14787 1
14788 \end_layout
14789
14790 \end_inset
14791
14792 ] Whether fragile commands in this style should be 
14793 \begin_inset Flex Code
14794 status collapsed
14795
14796 \begin_layout Plain Layout
14797
14798 \backslash
14799 protect
14800 \end_layout
14801
14802 \end_inset
14803
14804 'ed.
14805  (Note: This is 
14806 \emph on
14807 not
14808 \emph default
14809  whether this command should itself be protected.)
14810 \end_layout
14811
14812 \begin_layout Description
14813 \begin_inset Flex Code
14814 status collapsed
14815
14816 \begin_layout Plain Layout
14817 Newline
14818 \end_layout
14819
14820 \end_inset
14821
14822  [
14823 \begin_inset Flex Code
14824 status collapsed
14825
14826 \begin_layout Plain Layout
14827 0
14828 \end_layout
14829
14830 \end_inset
14831
14832 ,
14833 \begin_inset space \thinspace{}
14834 \end_inset
14835
14836
14837 \begin_inset Flex Code
14838 status collapsed
14839
14840 \begin_layout Plain Layout
14841
14842 \emph on
14843 1
14844 \end_layout
14845
14846 \end_inset
14847
14848 ] Whether newlines are translated into \SpecialChar LaTeX
14849  newlines (
14850 \begin_inset Flex Code
14851 status collapsed
14852
14853 \begin_layout Plain Layout
14854
14855 \backslash
14856
14857 \backslash
14858
14859 \end_layout
14860
14861 \end_inset
14862
14863 ) or not.
14864  The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14865  editing
14866  inside \SpecialChar LyX
14867 .
14868 \end_layout
14869
14870 \begin_layout Description
14871 \begin_inset Flex Code
14872 status collapsed
14873
14874 \begin_layout Plain Layout
14875 NextNoIndent
14876 \end_layout
14877
14878 \end_inset
14879
14880  [
14881 \begin_inset Flex Code
14882 status collapsed
14883
14884 \begin_layout Plain Layout
14885
14886 \emph on
14887 0
14888 \end_layout
14889
14890 \end_inset
14891
14892 ,
14893 \begin_inset space \thinspace{}
14894 \end_inset
14895
14896
14897 \begin_inset Flex Code
14898 status collapsed
14899
14900 \begin_layout Plain Layout
14901 1
14902 \end_layout
14903
14904 \end_inset
14905
14906 ] If set to true, and if 
14907 \begin_inset Flex Code
14908 status collapsed
14909
14910 \begin_layout Plain Layout
14911 DefaultStyle
14912 \end_layout
14913
14914 \end_inset
14915
14916  (usually 
14917 \begin_inset Flex Code
14918 status collapsed
14919
14920 \begin_layout Plain Layout
14921 Standard
14922 \end_layout
14923
14924 \end_inset
14925
14926 ) paragraphs are being indented, then the indentation of such a paragraph
14927  following one of this type will be suppressed.
14928  (So this will not affect the display of non-default paragraphs.)
14929 \end_layout
14930
14931 \begin_layout Description
14932 \begin_inset Flex Code
14933 status collapsed
14934
14935 \begin_layout Plain Layout
14936 ObsoletedBy
14937 \end_layout
14938
14939 \end_inset
14940
14941  [
14942 \begin_inset Flex Code
14943 status collapsed
14944
14945 \begin_layout Plain Layout
14946 <name>
14947 \end_layout
14948
14949 \end_inset
14950
14951 ] Name of a style that has replaced this style.
14952  This is used to rename a style, while keeping backward compatibility.
14953 \end_layout
14954
14955 \begin_layout Description
14956 \begin_inset Flex Code
14957 status collapsed
14958
14959 \begin_layout Plain Layout
14960 ParagraphGroup
14961 \end_layout
14962
14963 \end_inset
14964
14965  [
14966 \begin_inset Flex Code
14967 status collapsed
14968
14969 \begin_layout Plain Layout
14970 0
14971 \end_layout
14972
14973 \end_inset
14974
14975 ,
14976 \begin_inset space \thinspace{}
14977 \end_inset
14978
14979
14980 \begin_inset Flex Code
14981 status collapsed
14982
14983 \begin_layout Plain Layout
14984 1
14985 \end_layout
14986
14987 \end_inset
14988
14989 ] Determines whether consecutive pragraphs of the same type are treated
14990  as belonging together.
14991  This has the effect that the 
14992 \begin_inset Flex Code
14993 status collapsed
14994
14995 \begin_layout Plain Layout
14996 GuiLabel
14997 \end_layout
14998
14999 \end_inset
15000
15001  is only printed once before such a group.
15002  By default, this is true for 
15003 \begin_inset Flex Code
15004 status collapsed
15005
15006 \begin_layout Plain Layout
15007 LaTeXType
15008 \end_layout
15009
15010 \end_inset
15011
15012  
15013 \begin_inset Flex Code
15014 status collapsed
15015
15016 \begin_layout Plain Layout
15017 Environment
15018 \end_layout
15019
15020 \end_inset
15021
15022  and 
15023 \begin_inset Flex Code
15024 status collapsed
15025
15026 \begin_layout Plain Layout
15027 Bib_Environment
15028 \end_layout
15029
15030 \end_inset
15031
15032  and false for all other types.
15033 \end_layout
15034
15035 \begin_layout Description
15036 \begin_inset Flex Code
15037 status collapsed
15038
15039 \begin_layout Plain Layout
15040 ParbreakIsNewline
15041 \end_layout
15042
15043 \end_inset
15044
15045  [
15046 \begin_inset Flex Code
15047 status collapsed
15048
15049 \begin_layout Plain Layout
15050
15051 \emph on
15052 0
15053 \end_layout
15054
15055 \end_inset
15056
15057 ,
15058 \begin_inset space \thinspace{}
15059 \end_inset
15060
15061
15062 \begin_inset Flex Code
15063 status collapsed
15064
15065 \begin_layout Plain Layout
15066 1
15067 \end_layout
15068
15069 \end_inset
15070
15071 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15072  output,
15073  but only by a line break; together with 
15074 \begin_inset Flex Code
15075 status collapsed
15076
15077 \begin_layout Plain Layout
15078 PassThru 1
15079 \end_layout
15080
15081 \end_inset
15082
15083 , this allows to emulate a plain text editor (like the ERT inset).
15084 \end_layout
15085
15086 \begin_layout Description
15087 \begin_inset Flex Code
15088 status collapsed
15089
15090 \begin_layout Plain Layout
15091 ParIndent
15092 \end_layout
15093
15094 \end_inset
15095
15096  [
15097 \begin_inset Flex Code
15098 status collapsed
15099
15100 \begin_layout Plain Layout
15101 string=""
15102 \end_layout
15103
15104 \end_inset
15105
15106 ] The indent of the very first line of a paragraph.
15107  The
15108 \begin_inset Newline newline
15109 \end_inset
15110
15111
15112 \begin_inset Flex Code
15113 status collapsed
15114
15115 \begin_layout Plain Layout
15116 Parindent
15117 \end_layout
15118
15119 \end_inset
15120
15121  will be fixed for a certain style.
15122  The exception is the default style, since the indentation for these paragraphs
15123  can be prohibited with 
15124 \begin_inset Flex Code
15125 status collapsed
15126
15127 \begin_layout Plain Layout
15128 NextNoIndent
15129 \end_layout
15130
15131 \end_inset
15132
15133 .
15134  Also, 
15135 \begin_inset Flex Code
15136 status collapsed
15137
15138 \begin_layout Plain Layout
15139 Standard
15140 \end_layout
15141
15142 \end_inset
15143
15144  style paragraphs inside environments use the 
15145 \begin_inset Flex Code
15146 status collapsed
15147
15148 \begin_layout Plain Layout
15149 Parindent
15150 \end_layout
15151
15152 \end_inset
15153
15154  of the environment, not their native one.
15155  For example, 
15156 \begin_inset Flex Code
15157 status collapsed
15158
15159 \begin_layout Plain Layout
15160 Standard
15161 \end_layout
15162
15163 \end_inset
15164
15165  paragraphs inside an enumeration are not indented.
15166 \end_layout
15167
15168 \begin_layout Description
15169 \begin_inset Flex Code
15170 status collapsed
15171
15172 \begin_layout Plain Layout
15173 ParSep
15174 \end_layout
15175
15176 \end_inset
15177
15178  [
15179 \begin_inset Flex Code
15180 status collapsed
15181
15182 \begin_layout Plain Layout
15183 float=0
15184 \end_layout
15185
15186 \end_inset
15187
15188 ] The vertical space between two paragraphs of this style.
15189 \end_layout
15190
15191 \begin_layout Description
15192 \begin_inset Flex Code
15193 status collapsed
15194
15195 \begin_layout Plain Layout
15196 Parskip
15197 \end_layout
15198
15199 \end_inset
15200
15201  [
15202 \begin_inset Flex Code
15203 status collapsed
15204
15205 \begin_layout Plain Layout
15206 float=0
15207 \end_layout
15208
15209 \end_inset
15210
15211 ] \SpecialChar LyX
15212  allows the user to choose either 
15213 \begin_inset Quotes eld
15214 \end_inset
15215
15216 indent
15217 \begin_inset Quotes erd
15218 \end_inset
15219
15220  or 
15221 \begin_inset Quotes eld
15222 \end_inset
15223
15224 skip
15225 \begin_inset Quotes erd
15226 \end_inset
15227
15228  to separate paragraphs.
15229  When 
15230 \begin_inset Quotes eld
15231 \end_inset
15232
15233 indent
15234 \begin_inset Quotes erd
15235 \end_inset
15236
15237  is chosen, 
15238 \begin_inset Flex Code
15239 status collapsed
15240
15241 \begin_layout Plain Layout
15242 Parskip
15243 \end_layout
15244
15245 \end_inset
15246
15247  is ignored.
15248  When 
15249 \begin_inset Quotes eld
15250 \end_inset
15251
15252 skip
15253 \begin_inset Quotes erd
15254 \end_inset
15255
15256  is chosen, 
15257 \begin_inset Flex Code
15258 status collapsed
15259
15260 \begin_layout Plain Layout
15261 ParIndent
15262 \end_layout
15263
15264 \end_inset
15265
15266  is ignored and all paragraphs are separated by the 
15267 \begin_inset Flex Code
15268 status collapsed
15269
15270 \begin_layout Plain Layout
15271 Parskip
15272 \end_layout
15273
15274 \end_inset
15275
15276  argument.
15277  The vertical space is calculated with 
15278 \begin_inset Flex Code
15279 status collapsed
15280
15281 \begin_layout Plain Layout
15282 Parskip
15283 \begin_inset space ~
15284 \end_inset
15285
15286 * DefaultHeight
15287 \end_layout
15288
15289 \end_inset
15290
15291  where 
15292 \begin_inset Flex Code
15293 status collapsed
15294
15295 \begin_layout Plain Layout
15296 DefaultHeight
15297 \end_layout
15298
15299 \end_inset
15300
15301  is the height of a row with the normal font.
15302  This way, the look stays the same with different screen fonts.
15303 \end_layout
15304
15305 \begin_layout Description
15306 \begin_inset Flex Code
15307 status collapsed
15308
15309 \begin_layout Plain Layout
15310 PassThru
15311 \end_layout
15312
15313 \end_inset
15314
15315  [
15316 \begin_inset Flex Code
15317 status collapsed
15318
15319 \begin_layout Plain Layout
15320
15321 \emph on
15322 0
15323 \end_layout
15324
15325 \end_inset
15326
15327 ,
15328 \begin_inset space \thinspace{}
15329 \end_inset
15330
15331
15332 \begin_inset Flex Code
15333 status collapsed
15334
15335 \begin_layout Plain Layout
15336 1
15337 \end_layout
15338
15339 \end_inset
15340
15341 ] Whether the contents of this paragraph should be output in raw form, meaning
15342  without special translations that \SpecialChar LaTeX
15343  would require.
15344 \end_layout
15345
15346 \begin_layout Description
15347 \begin_inset Flex Code
15348 status collapsed
15349
15350 \begin_layout Plain Layout
15351 PassThruChars
15352 \end_layout
15353
15354 \end_inset
15355
15356  [
15357 \begin_inset Flex Code
15358 status collapsed
15359
15360 \begin_layout Plain Layout
15361 string
15362 \end_layout
15363
15364 \end_inset
15365
15366 ]
15367 \family typewriter
15368  
15369 \family default
15370 Defines individual characters that should be output in raw form, meaning
15371  without special translations that \SpecialChar LaTeX
15372  would require.
15373 \end_layout
15374
15375 \begin_layout Description
15376 \begin_inset Flex Code
15377 status collapsed
15378
15379 \begin_layout Plain Layout
15380 Preamble
15381 \end_layout
15382
15383 \end_inset
15384
15385  Information to be included in the \SpecialChar LaTeX
15386  preamble when this style is used.
15387  Used to define macros, load packages, etc., required by this particular
15388  style.
15389  Must end with 
15390 \begin_inset Quotes eld
15391 \end_inset
15392
15393
15394 \begin_inset Flex Code
15395 status collapsed
15396
15397 \begin_layout Plain Layout
15398 EndPreamble
15399 \end_layout
15400
15401 \end_inset
15402
15403
15404 \begin_inset Quotes erd
15405 \end_inset
15406
15407 .
15408 \end_layout
15409
15410 \begin_layout Description
15411 \begin_inset Flex Code
15412 status collapsed
15413
15414 \begin_layout Plain Layout
15415 RefPrefix
15416 \end_layout
15417
15418 \end_inset
15419
15420  [
15421 \begin_inset Flex Code
15422 status collapsed
15423
15424 \begin_layout Plain Layout
15425 string
15426 \end_layout
15427
15428 \end_inset
15429
15430 ] The prefix to use when creating labels referring to paragraphs of this
15431  type.
15432  This allows the use of formatted references.
15433 \end_layout
15434
15435 \begin_layout Description
15436 \begin_inset Flex Code
15437 status collapsed
15438
15439 \begin_layout Plain Layout
15440 Requires 
15441 \end_layout
15442
15443 \end_inset
15444
15445  [
15446 \begin_inset Flex Code
15447 status collapsed
15448
15449 \begin_layout Plain Layout
15450 string
15451 \end_layout
15452
15453 \end_inset
15454
15455 ] Whether the style requires the feature 
15456 \begin_inset Flex Code
15457 status collapsed
15458
15459 \begin_layout Plain Layout
15460 string
15461 \end_layout
15462
15463 \end_inset
15464
15465  (see 
15466 \begin_inset CommandInset ref
15467 LatexCommand ref
15468 reference "chap:List-of-functions"
15469
15470 \end_inset
15471
15472  for the list of features).
15473  If you require a package with specific options, you can additionally use
15474  
15475 \begin_inset Flex Code
15476 status collapsed
15477
15478 \begin_layout Plain Layout
15479 PackageOptions
15480 \end_layout
15481
15482 \end_inset
15483
15484  as a general text class parameter (see 
15485 \begin_inset CommandInset ref
15486 LatexCommand ref
15487 reference "subsec:General-text-class"
15488
15489 \end_inset
15490
15491 ).
15492 \end_layout
15493
15494 \begin_layout Description
15495 \begin_inset Flex Code
15496 status collapsed
15497
15498 \begin_layout Plain Layout
15499 ResetArgs
15500 \end_layout
15501
15502 \end_inset
15503
15504  [
15505 \begin_inset Flex Code
15506 status collapsed
15507
15508 \begin_layout Plain Layout
15509
15510 \emph on
15511 0
15512 \end_layout
15513
15514 \end_inset
15515
15516 ,
15517 \begin_inset Flex Code
15518 status collapsed
15519
15520 \begin_layout Plain Layout
15521 1
15522 \end_layout
15523
15524 \end_inset
15525
15526 ] Resets the \SpecialChar LaTeX
15527  arguments of this style (as defined via the 
15528 \begin_inset Flex Code
15529 status collapsed
15530
15531 \begin_layout Plain Layout
15532 Argument
15533 \end_layout
15534
15535 \end_inset
15536
15537  tag).
15538  This is useful if you have copied a style via 
15539 \begin_inset Flex Code
15540 status collapsed
15541
15542 \begin_layout Plain Layout
15543 CopyStyle
15544 \end_layout
15545
15546 \end_inset
15547
15548 , but you do not want to inherit its (required and optional) arguments.
15549 \change_inserted 2089657418 1476488475
15550
15551 \end_layout
15552
15553 \begin_layout Description
15554
15555 \change_inserted 2089657418 1476488475
15556 \begin_inset Flex Code
15557 status collapsed
15558
15559 \begin_layout Plain Layout
15560
15561 \change_inserted 2089657418 1476488475
15562 ResumeCounter
15563 \end_layout
15564
15565 \end_inset
15566
15567  [
15568 \begin_inset Flex Code
15569 status collapsed
15570
15571 \begin_layout Plain Layout
15572
15573 \change_inserted 2089657418 1476488475
15574
15575 \emph on
15576 0
15577 \end_layout
15578
15579 \end_inset
15580
15581 ,
15582 \begin_inset Flex Code
15583 status collapsed
15584
15585 \begin_layout Plain Layout
15586
15587 \change_inserted 2089657418 1476488475
15588 1
15589 \end_layout
15590
15591 \end_inset
15592
15593 ] Resumes a counter that is usually reset at each new sequence of layouts.
15594  This is currently only useful when 
15595 \begin_inset Flex Code
15596 status collapsed
15597
15598 \begin_layout Plain Layout
15599
15600 \change_inserted 2089657418 1476488475
15601 LabelType
15602 \end_layout
15603
15604 \end_inset
15605
15606  is 
15607 \begin_inset Flex Code
15608 status collapsed
15609
15610 \begin_layout Plain Layout
15611
15612 \change_inserted 2089657418 1476488475
15613 Enumerate
15614 \end_layout
15615
15616 \end_inset
15617
15618 .
15619 \change_unchanged
15620
15621 \end_layout
15622
15623 \begin_layout Description
15624 \begin_inset Flex Code
15625 status collapsed
15626
15627 \begin_layout Plain Layout
15628 RightDelim
15629 \end_layout
15630
15631 \end_inset
15632
15633  [
15634 \begin_inset Flex Code
15635 status collapsed
15636
15637 \begin_layout Plain Layout
15638 string
15639 \end_layout
15640
15641 \end_inset
15642
15643 ] A string that is put at the end of the layout content.
15644  A line break in the output can be indicated by 
15645 \begin_inset Flex Code
15646 status collapsed
15647
15648 \begin_layout Plain Layout
15649 <br/>
15650 \end_layout
15651
15652 \end_inset
15653
15654 .
15655 \end_layout
15656
15657 \begin_layout Description
15658 \begin_inset Flex Code
15659 status collapsed
15660
15661 \begin_layout Plain Layout
15662 RightMargin
15663 \end_layout
15664
15665 \end_inset
15666
15667  [
15668 \begin_inset Flex Code
15669 status collapsed
15670
15671 \begin_layout Plain Layout
15672 string=""
15673 \end_layout
15674
15675 \end_inset
15676
15677 ] Similar to 
15678 \begin_inset Flex Code
15679 status collapsed
15680
15681 \begin_layout Plain Layout
15682 LeftMargin
15683 \end_layout
15684
15685 \end_inset
15686
15687 .
15688 \end_layout
15689
15690 \begin_layout Description
15691 \begin_inset Flex Code
15692 status collapsed
15693
15694 \begin_layout Plain Layout
15695 Spacing
15696 \end_layout
15697
15698 \end_inset
15699
15700  [
15701 \begin_inset Flex Code
15702 status collapsed
15703
15704 \begin_layout Plain Layout
15705
15706 \emph on
15707 single
15708 \end_layout
15709
15710 \end_inset
15711
15712
15713 \begin_inset Flex Code
15714 status collapsed
15715
15716 \begin_layout Plain Layout
15717 onehalf
15718 \end_layout
15719
15720 \end_inset
15721
15722
15723 \begin_inset Flex Code
15724 status collapsed
15725
15726 \begin_layout Plain Layout
15727 double
15728 \end_layout
15729
15730 \end_inset
15731
15732
15733 \begin_inset Flex Code
15734 status collapsed
15735
15736 \begin_layout Plain Layout
15737 other
15738 \begin_inset space ~
15739 \end_inset
15740
15741 <value>
15742 \end_layout
15743
15744 \end_inset
15745
15746 ] This defines what the default spacing should be in the style.
15747  The arguments 
15748 \begin_inset Flex Code
15749 status collapsed
15750
15751 \begin_layout Plain Layout
15752 single
15753 \end_layout
15754
15755 \end_inset
15756
15757
15758 \begin_inset Flex Code
15759 status collapsed
15760
15761 \begin_layout Plain Layout
15762 onehalf
15763 \end_layout
15764
15765 \end_inset
15766
15767  and 
15768 \begin_inset Flex Code
15769 status collapsed
15770
15771 \begin_layout Plain Layout
15772 double
15773 \end_layout
15774
15775 \end_inset
15776
15777  correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15778  If you specify the argument 
15779 \begin_inset Flex Code
15780 status collapsed
15781
15782 \begin_layout Plain Layout
15783 other
15784 \end_layout
15785
15786 \end_inset
15787
15788 , then you must also provide a value argument which will be the actual multiplie
15789 r value.
15790  Note that, contrary to other parameters, 
15791 \begin_inset Flex Code
15792 status collapsed
15793
15794 \begin_layout Plain Layout
15795 Spacing
15796 \end_layout
15797
15798 \end_inset
15799
15800  implies the generation of specific \SpecialChar LaTeX
15801  code, using the \SpecialChar LaTeX
15802  package 
15803 \family roman
15804
15805 \begin_inset Flex Code
15806 status collapsed
15807
15808 \begin_layout Plain Layout
15809 setspace
15810 \end_layout
15811
15812 \end_inset
15813
15814 .
15815 \end_layout
15816
15817 \begin_layout Description
15818 \begin_inset Flex Code
15819 status collapsed
15820
15821 \begin_layout Plain Layout
15822 Spellcheck
15823 \end_layout
15824
15825 \end_inset
15826
15827  [
15828 \begin_inset Flex Code
15829 status collapsed
15830
15831 \begin_layout Plain Layout
15832 0
15833 \end_layout
15834
15835 \end_inset
15836
15837 ,
15838 \begin_inset space \thinspace{}
15839 \end_inset
15840
15841
15842 \begin_inset Flex Code
15843 status collapsed
15844
15845 \begin_layout Plain Layout
15846
15847 \emph on
15848 1
15849 \end_layout
15850
15851 \end_inset
15852
15853 ] Allow spell-checking paragraphs of this style.
15854  Default is true.
15855 \change_inserted 2089657418 1476488264
15856
15857 \end_layout
15858
15859 \begin_layout Description
15860
15861 \change_inserted 2089657418 1476488264
15862 \begin_inset Flex Code
15863 status collapsed
15864
15865 \begin_layout Plain Layout
15866
15867 \change_inserted 2089657418 1476488264
15868 StepMasterCounter
15869 \end_layout
15870
15871 \end_inset
15872
15873  [
15874 \begin_inset Flex Code
15875 status collapsed
15876
15877 \begin_layout Plain Layout
15878
15879 \change_inserted 2089657418 1476488264
15880
15881 \emph on
15882 0
15883 \end_layout
15884
15885 \end_inset
15886
15887 ,
15888 \begin_inset Flex Code
15889 status collapsed
15890
15891 \begin_layout Plain Layout
15892
15893 \change_inserted 2089657418 1476488264
15894 1
15895 \end_layout
15896
15897 \end_inset
15898
15899 ] Steps the master counter of a given counter at the beginning of a new
15900  sequence of layouts.
15901  This is currently only useful when 
15902 \begin_inset Flex Code
15903 status collapsed
15904
15905 \begin_layout Plain Layout
15906
15907 \change_inserted 2089657418 1476488264
15908 LabelType
15909 \end_layout
15910
15911 \end_inset
15912
15913  is 
15914 \begin_inset Flex Code
15915 status collapsed
15916
15917 \begin_layout Plain Layout
15918
15919 \change_inserted 2089657418 1476488264
15920 Enumerate
15921 \end_layout
15922
15923 \end_inset
15924
15925 .
15926 \change_unchanged
15927
15928 \end_layout
15929
15930 \begin_layout Description
15931 \begin_inset Flex Code
15932 status collapsed
15933
15934 \begin_layout Plain Layout
15935 TextFont
15936 \end_layout
15937
15938 \end_inset
15939
15940  The font used for the text body .
15941  See 
15942 \begin_inset CommandInset ref
15943 LatexCommand ref
15944 reference "subsec:Font-description"
15945
15946 \end_inset
15947
15948 .
15949 \end_layout
15950
15951 \begin_layout Description
15952 \begin_inset Flex Code
15953 status collapsed
15954
15955 \begin_layout Plain Layout
15956 TocLevel
15957 \end_layout
15958
15959 \end_inset
15960
15961
15962 \series medium
15963  [
15964 \begin_inset Flex Code
15965 status collapsed
15966
15967 \begin_layout Plain Layout
15968
15969 \series medium
15970 int=3
15971 \end_layout
15972
15973 \end_inset
15974
15975 ]
15976 \series default
15977  The level of the style in the table of contents.
15978  This is used for automatic numbering of section headings.
15979 \end_layout
15980
15981 \begin_layout Description
15982 \begin_inset Flex Code
15983 status collapsed
15984
15985 \begin_layout Plain Layout
15986 ToggleIndent
15987 \end_layout
15988
15989 \end_inset
15990
15991  [
15992 \emph on
15993
15994 \begin_inset Flex Code
15995 status collapsed
15996
15997 \begin_layout Plain Layout
15998
15999 \emph on
16000 default
16001 \end_layout
16002
16003 \end_inset
16004
16005
16006 \emph default
16007
16008 \begin_inset Flex Code
16009 status collapsed
16010
16011 \begin_layout Plain Layout
16012 always
16013 \end_layout
16014
16015 \end_inset
16016
16017
16018 \begin_inset Flex Code
16019 status collapsed
16020
16021 \begin_layout Plain Layout
16022 never
16023 \end_layout
16024
16025 \end_inset
16026
16027 ] This tag determines whether the first line indentation of this paragraph
16028  can be toggled via the Paragraph settings dialog.
16029  If 
16030 \emph on
16031
16032 \begin_inset Flex Code
16033 status collapsed
16034
16035 \begin_layout Plain Layout
16036
16037 \emph off
16038 default
16039 \end_layout
16040
16041 \end_inset
16042
16043
16044 \emph default
16045  is set, indentation can be toggled if the document settings use 
16046 \begin_inset Quotes eld
16047 \end_inset
16048
16049 indent
16050 \begin_inset Quotes erd
16051 \end_inset
16052
16053  paragraph style, with 
16054 \begin_inset Flex Code
16055 status collapsed
16056
16057 \begin_layout Plain Layout
16058 always
16059 \end_layout
16060
16061 \end_inset
16062
16063 , indentation can always be toggled, notwithstanding the document settings,
16064  with 
16065 \begin_inset Flex Code
16066 status collapsed
16067
16068 \begin_layout Plain Layout
16069 never
16070 \end_layout
16071
16072 \end_inset
16073
16074 , indentation can never be toggled.
16075 \end_layout
16076
16077 \begin_layout Description
16078 \begin_inset Flex Code
16079 status collapsed
16080
16081 \begin_layout Plain Layout
16082 TopSep
16083 \end_layout
16084
16085 \end_inset
16086
16087  [
16088 \begin_inset Flex Code
16089 status collapsed
16090
16091 \begin_layout Plain Layout
16092 float=0
16093 \end_layout
16094
16095 \end_inset
16096
16097 ] The vertical space with which the very first of a chain of paragraphs
16098  with this style is separated from the previous paragraph.
16099  If the previous paragraph has another style, the separations are not simply
16100  added, but the maximum is taken.
16101 \end_layout
16102
16103 \begin_layout Subsection
16104 \begin_inset CommandInset label
16105 LatexCommand label
16106 name "subsec:I18n"
16107
16108 \end_inset
16109
16110 Internationalization of Paragraph Styles
16111 \end_layout
16112
16113 \begin_layout Standard
16114 \SpecialChar LyX
16115  has long supported internationalization of layout information, but, until
16116  version 2.0, this applied only to the user interface and not to, say, PDF
16117  output.
16118  Thus, French authors were forced to resort to ugly hacks if they wanted
16119  `
16120 \lang french
16121 Théorème
16122 \lang english
16123  1' instead of `Theorem 1'.
16124  Thanks to Georg Baum, that is no longer the case.
16125 \end_layout
16126
16127 \begin_layout Standard
16128 If a 
16129 \begin_inset Flex Code
16130 status collapsed
16131
16132 \begin_layout Plain Layout
16133 Style
16134 \end_layout
16135
16136 \end_inset
16137
16138  defines text that is to appear in the typeset document, it may use 
16139 \begin_inset Flex Code
16140 status collapsed
16141
16142 \begin_layout Plain Layout
16143 LangPreamble
16144 \end_layout
16145
16146 \end_inset
16147
16148  and 
16149 \begin_inset Flex Code
16150 status collapsed
16151
16152 \begin_layout Plain Layout
16153 BabelPreamble
16154 \end_layout
16155
16156 \end_inset
16157
16158  to support non-English and even multi-language documents correctly.
16159  The following excerpt (from the 
16160 \begin_inset Flex Code
16161 status collapsed
16162
16163 \begin_layout Plain Layout
16164 theorems-ams.inc
16165 \end_layout
16166
16167 \end_inset
16168
16169  file) shows how this works:
16170 \end_layout
16171
16172 \begin_layout LyX-Code
16173 Preamble
16174 \end_layout
16175
16176 \begin_deeper
16177 \begin_layout LyX-Code
16178   
16179 \backslash
16180 theoremstyle{remark}
16181 \end_layout
16182
16183 \begin_layout LyX-Code
16184   
16185 \backslash
16186 newtheorem{claim}[thm]{
16187 \backslash
16188 protect
16189 \backslash
16190 claimname}
16191 \end_layout
16192
16193 \begin_layout LyX-Code
16194 EndPreamble
16195 \end_layout
16196
16197 \begin_layout LyX-Code
16198 LangPreamble
16199 \end_layout
16200
16201 \begin_layout LyX-Code
16202   
16203 \backslash
16204 providecommand{
16205 \backslash
16206 claimname}{_(Claim)}
16207 \end_layout
16208
16209 \begin_layout LyX-Code
16210 EndLangPreamble
16211 \end_layout
16212
16213 \begin_layout LyX-Code
16214 BabelPreamble
16215 \end_layout
16216
16217 \begin_layout LyX-Code
16218     
16219 \backslash
16220 addto
16221 \backslash
16222 captions$$lang{
16223 \backslash
16224 renewcommand{
16225 \backslash
16226 claimname}{_(Claim)}}
16227 \end_layout
16228
16229 \begin_layout LyX-Code
16230 EndBabelPreamble
16231 \end_layout
16232
16233 \end_deeper
16234 \begin_layout Standard
16235 In principle, any legal \SpecialChar LaTeX
16236  may appear in the 
16237 \begin_inset Flex Code
16238 status collapsed
16239
16240 \begin_layout Plain Layout
16241 LangPreamble
16242 \end_layout
16243
16244 \end_inset
16245
16246  and 
16247 \begin_inset Flex Code
16248 status collapsed
16249
16250 \begin_layout Plain Layout
16251 BabelPreamble
16252 \end_layout
16253
16254 \end_inset
16255
16256  tags, but in practice they will typically look as they do here.
16257  The key to correct translation of the typeset text is the definition of
16258  the \SpecialChar LaTeX
16259  command 
16260 \begin_inset Flex Code
16261 status collapsed
16262
16263 \begin_layout Plain Layout
16264
16265 \backslash
16266 claimname
16267 \end_layout
16268
16269 \end_inset
16270
16271  and its use in 
16272 \begin_inset Flex Code
16273 status collapsed
16274
16275 \begin_layout Plain Layout
16276
16277 \backslash
16278 newtheorem
16279 \end_layout
16280
16281 \end_inset
16282
16283 .
16284  
16285 \end_layout
16286
16287 \begin_layout Standard
16288 The 
16289 \begin_inset Flex Code
16290 status collapsed
16291
16292 \begin_layout Plain Layout
16293 LangPreamble
16294 \end_layout
16295
16296 \end_inset
16297
16298  tag provides for internationalization based upon the overall language of
16299  the document.
16300  The contents of the tag will be included in the preamble, just as with
16301  the 
16302 \begin_inset Flex Code
16303 status collapsed
16304
16305 \begin_layout Plain Layout
16306 Preamble
16307 \end_layout
16308
16309 \end_inset
16310
16311  tag.
16312  What makes it special is the use of the 
16313 \begin_inset Quotes eld
16314 \end_inset
16315
16316 function
16317 \begin_inset Quotes erd
16318 \end_inset
16319
16320  
16321 \begin_inset Flex Code
16322 status collapsed
16323
16324 \begin_layout Plain Layout
16325 _()
16326 \end_layout
16327
16328 \end_inset
16329
16330 , which will be replaced, when \SpecialChar LyX
16331  produces \SpecialChar LaTeX
16332  output, with the translation of
16333  its argument into the document language.
16334 \end_layout
16335
16336 \begin_layout Standard
16337 The 
16338 \begin_inset Flex Code
16339 status collapsed
16340
16341 \begin_layout Plain Layout
16342 BabelPreamble
16343 \end_layout
16344
16345 \end_inset
16346
16347  tag is more complex, since it is meant to provide support for multi-language
16348  documents and so offers an interface to the 
16349 \begin_inset Flex Code
16350 status collapsed
16351
16352 \begin_layout Plain Layout
16353 babel
16354 \end_layout
16355
16356 \end_inset
16357
16358  package.
16359  Its contents will be added to the preamble once for each language that
16360  appears in the document.
16361  In this case, the argument to 
16362 \begin_inset Flex Code
16363 status collapsed
16364
16365 \begin_layout Plain Layout
16366 _()
16367 \end_layout
16368
16369 \end_inset
16370
16371  will be replaced with its translation into the language in question; the
16372  expression 
16373 \begin_inset Flex Code
16374 status collapsed
16375
16376 \begin_layout Plain Layout
16377 $$lang
16378 \end_layout
16379
16380 \end_inset
16381
16382  is replaced by the language name (as used by the babel package).
16383 \end_layout
16384
16385 \begin_layout Standard
16386 A German document that also included a French section would thus have the
16387  following in the preamble:
16388 \end_layout
16389
16390 \begin_layout LyX-Code
16391
16392 \backslash
16393 addto
16394 \backslash
16395 captionsfrench{
16396 \backslash
16397 renewcommand{
16398 \backslash
16399 claimname}{Affirmation}}
16400 \begin_inset Newline newline
16401 \end_inset
16402
16403
16404 \backslash
16405 addto
16406 \backslash
16407 captionsngerman{
16408 \backslash
16409 renewcommand{
16410 \backslash
16411 claimname}{Behauptung}}
16412 \begin_inset Newline newline
16413 \end_inset
16414
16415
16416 \backslash
16417 providecommand{
16418 \backslash
16419 claimname}{Behauptung}
16420 \end_layout
16421
16422 \begin_layout Standard
16423 \SpecialChar LaTeX
16424  and 
16425 \begin_inset Flex Code
16426 status collapsed
16427
16428 \begin_layout Plain Layout
16429 babel
16430 \end_layout
16431
16432 \end_inset
16433
16434  will then conspire to produce the correct text in the output.
16435 \end_layout
16436
16437 \begin_layout Standard
16438 One important point to note here is that the translations are provided by
16439  \SpecialChar LyX
16440  itself, through the file 
16441 \begin_inset Flex Code
16442 status collapsed
16443
16444 \begin_layout Plain Layout
16445 layouttranslations
16446 \end_layout
16447
16448 \end_inset
16449
16450 .
16451  This means, in effect, that 
16452 \begin_inset Flex Code
16453 status collapsed
16454
16455 \begin_layout Plain Layout
16456 LangPreamble
16457 \end_layout
16458
16459 \end_inset
16460
16461  and 
16462 \begin_inset Flex Code
16463 status collapsed
16464
16465 \begin_layout Plain Layout
16466 BabelPreamble
16467 \end_layout
16468
16469 \end_inset
16470
16471  are really only of use in layout files that are provided with \SpecialChar LyX
16472 , since text
16473  entered in user-created layout files will not be seen by \SpecialChar LyX
16474 's internationalizatio
16475 n routines unless the 
16476 \begin_inset Flex Code
16477 status collapsed
16478
16479 \begin_layout Plain Layout
16480 layouttranslations
16481 \end_layout
16482
16483 \end_inset
16484
16485  file is modified accordingly.
16486  That said, however, any layout created with the intention that it will
16487  be included with \SpecialChar LyX
16488  should use these tags where appropriate.
16489  Please note that the paragraph style translations provided by \SpecialChar LyX
16490  will never
16491  change with a minor update (e.
16492 \begin_inset space \thinspace{}
16493 \end_inset
16494
16495 g.
16496 \begin_inset space \space{}
16497 \end_inset
16498
16499 from version 2.1.x to 2.1.y).
16500  It is however quite likely that a major update (e.
16501 \begin_inset space \thinspace{}
16502 \end_inset
16503
16504 g.
16505 \begin_inset space \space{}
16506 \end_inset
16507
16508 from 2.0.x to 2.1.y) will introduce new translations or corrections.
16509 \end_layout
16510
16511 \begin_layout Subsection
16512 Floats
16513 \begin_inset CommandInset label
16514 LatexCommand label
16515 name "subsec:Floats"
16516
16517 \end_inset
16518
16519
16520 \end_layout
16521
16522 \begin_layout Standard
16523 It is necessary to define the floats (
16524 \begin_inset Flex Noun
16525 status collapsed
16526
16527 \begin_layout Plain Layout
16528 figure
16529 \end_layout
16530
16531 \end_inset
16532
16533
16534 \begin_inset Flex Noun
16535 status collapsed
16536
16537 \begin_layout Plain Layout
16538 table
16539 \end_layout
16540
16541 \end_inset
16542
16543 , \SpecialChar ldots
16544 ) in the text class itself.
16545  Standard floats are included in the file 
16546 \begin_inset Flex Code
16547 status collapsed
16548
16549 \begin_layout Plain Layout
16550 stdfloats.inc
16551 \end_layout
16552
16553 \end_inset
16554
16555 , so you may have to do no more than add
16556 \end_layout
16557
16558 \begin_layout LyX-Code
16559 Input stdfloats.inc
16560 \end_layout
16561
16562 \begin_layout Standard
16563 to your layout file.
16564  If you want to implement a text class that proposes some other float types
16565  (like the AGU class bundled with \SpecialChar LyX
16566 ), the information below will hopefully
16567  help you:
16568 \end_layout
16569
16570 \begin_layout Description
16571 \begin_inset Flex Code
16572 status collapsed
16573
16574 \begin_layout Plain Layout
16575 AllowedPlacement
16576 \end_layout
16577
16578 \end_inset
16579
16580  [
16581 \begin_inset Flex Code
16582 status collapsed
16583
16584 \begin_layout Plain Layout
16585 string
16586 \end_layout
16587
16588 \end_inset
16589
16590 =!htbpH] Allowed placement options for this float type.
16591  The value is a string of placement characters.
16592  Possible characters include: 
16593 \emph on
16594 h
16595 \emph default
16596  (
16597 \begin_inset Quotes eld
16598 \end_inset
16599
16600 here if possible
16601 \begin_inset Quotes erd
16602 \end_inset
16603
16604 ), 
16605 \emph on
16606 t
16607 \emph default
16608  (
16609 \begin_inset Quotes eld
16610 \end_inset
16611
16612 top of page
16613 \begin_inset Quotes erd
16614 \end_inset
16615
16616 ), 
16617 \emph on
16618 b
16619 \emph default
16620  (
16621 \begin_inset Quotes eld
16622 \end_inset
16623
16624 bottom of page
16625 \begin_inset Quotes erd
16626 \end_inset
16627
16628 ), 
16629 \emph on
16630 p
16631 \emph default
16632  (
16633 \begin_inset Quotes eld
16634 \end_inset
16635
16636 page of floats
16637 \begin_inset Quotes erd
16638 \end_inset
16639
16640 ), 
16641 \emph on
16642 H
16643 \emph default
16644  (
16645 \begin_inset Quotes eld
16646 \end_inset
16647
16648 here definitely
16649 \begin_inset Quotes erd
16650 \end_inset
16651
16652 ) and 
16653 \emph on
16654 !
16655 \emph default
16656  (
16657 \begin_inset Quotes eld
16658 \end_inset
16659
16660 ignore LaTeX rules
16661 \begin_inset Quotes erd
16662 \end_inset
16663
16664 ).
16665  The order of the characters in the string does not matter.
16666  If no placement options are allowed, use the string 
16667 \emph on
16668 none
16669 \emph default
16670 .
16671 \end_layout
16672
16673 \begin_layout Description
16674 \begin_inset Flex Code
16675 status collapsed
16676
16677 \begin_layout Plain Layout
16678 AllowsSideways
16679 \end_layout
16680
16681 \end_inset
16682
16683  [
16684 \begin_inset Flex Code
16685 status collapsed
16686
16687 \begin_layout Plain Layout
16688
16689 \emph off
16690 0
16691 \end_layout
16692
16693 \end_inset
16694
16695 ,
16696 \begin_inset space \thinspace{}
16697 \end_inset
16698
16699
16700 \emph on
16701
16702 \begin_inset Flex Code
16703 status collapsed
16704
16705 \begin_layout Plain Layout
16706
16707 \emph on
16708 1
16709 \end_layout
16710
16711 \end_inset
16712
16713
16714 \emph default
16715 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16716 -package 
16717 \family typewriter
16718 rotfloat
16719 \family default
16720  (sidewaysfloat).
16721  Set to 
16722 \begin_inset Flex Code
16723 status collapsed
16724
16725 \begin_layout Plain Layout
16726 0
16727 \end_layout
16728
16729 \end_inset
16730
16731  if the float does not support this feature.
16732 \end_layout
16733
16734 \begin_layout Description
16735 \begin_inset Flex Code
16736 status collapsed
16737
16738 \begin_layout Plain Layout
16739 AllowsWide
16740 \end_layout
16741
16742 \end_inset
16743
16744  [
16745 \begin_inset Flex Code
16746 status collapsed
16747
16748 \begin_layout Plain Layout
16749
16750 \emph off
16751 0
16752 \end_layout
16753
16754 \end_inset
16755
16756 ,
16757 \begin_inset space \thinspace{}
16758 \end_inset
16759
16760
16761 \emph on
16762
16763 \begin_inset Flex Code
16764 status collapsed
16765
16766 \begin_layout Plain Layout
16767
16768 \emph on
16769 1
16770 \end_layout
16771
16772 \end_inset
16773
16774
16775 \emph default
16776 ] Defines whether the float has a starred variant that spans columns in
16777  a two column paragraph.
16778  Set to 
16779 \begin_inset Flex Code
16780 status collapsed
16781
16782 \begin_layout Plain Layout
16783 0
16784 \end_layout
16785
16786 \end_inset
16787
16788  if the float does not support this feature.
16789 \end_layout
16790
16791 \begin_layout Description
16792 \begin_inset Flex Code
16793 status collapsed
16794
16795 \begin_layout Plain Layout
16796 Extension
16797 \end_layout
16798
16799 \end_inset
16800
16801  [
16802 \begin_inset Flex Code
16803 status collapsed
16804
16805 \begin_layout Plain Layout
16806 string
16807 \end_layout
16808
16809 \end_inset
16810
16811 =
16812 \begin_inset Quotes erd
16813 \end_inset
16814
16815
16816 \begin_inset Quotes erd
16817 \end_inset
16818
16819 ] The file name extension of an auxiliary file for the list of figures (or
16820  whatever).
16821  \SpecialChar LaTeX
16822  writes the captions to this file.
16823 \end_layout
16824
16825 \begin_layout Description
16826 \begin_inset Flex Code
16827 status collapsed
16828
16829 \begin_layout Plain Layout
16830 GuiName
16831 \end_layout
16832
16833 \end_inset
16834
16835  [
16836 \begin_inset Flex Code
16837 status collapsed
16838
16839 \begin_layout Plain Layout
16840 string
16841 \end_layout
16842
16843 \end_inset
16844
16845 =
16846 \begin_inset Quotes erd
16847 \end_inset
16848
16849
16850 \begin_inset Quotes erd
16851 \end_inset
16852
16853 ] The string that will be used in the menus and also for the caption.
16854  This is translated to the current language if babel is used.
16855 \end_layout
16856
16857 \begin_layout Description
16858 \begin_inset Flex Code
16859 status collapsed
16860
16861 \begin_layout Plain Layout
16862 HTML*
16863 \end_layout
16864
16865 \end_inset
16866
16867  These tags control the XHTML output.
16868  See 
16869 \begin_inset CommandInset ref
16870 LatexCommand ref
16871 reference "sec:Tags-for-XHTML"
16872
16873 \end_inset
16874
16875 .
16876 \end_layout
16877
16878 \begin_layout Description
16879 \begin_inset Flex Code
16880 status collapsed
16881
16882 \begin_layout Plain Layout
16883 IsPredefined
16884 \end_layout
16885
16886 \end_inset
16887
16888  [
16889 \emph on
16890
16891 \begin_inset Flex Code
16892 status collapsed
16893
16894 \begin_layout Plain Layout
16895 0
16896 \end_layout
16897
16898 \end_inset
16899
16900
16901 \emph default
16902 ,
16903 \begin_inset space \thinspace{}
16904 \end_inset
16905
16906
16907 \begin_inset Flex Code
16908 status collapsed
16909
16910 \begin_layout Plain Layout
16911 1
16912 \end_layout
16913
16914 \end_inset
16915
16916 ] Indicates whether the float is already defined in the document class or
16917  if instead the \SpecialChar LaTeX
16918  package 
16919 \begin_inset Flex Code
16920 status collapsed
16921
16922 \begin_layout Plain Layout
16923 float
16924 \end_layout
16925
16926 \end_inset
16927
16928  needs to be loaded to define it on-the-fly.
16929  The default is 
16930 \begin_inset Flex Code
16931 status collapsed
16932
16933 \begin_layout Plain Layout
16934 0
16935 \end_layout
16936
16937 \end_inset
16938
16939 , which means: 
16940 \begin_inset Flex Code
16941 status collapsed
16942
16943 \begin_layout Plain Layout
16944 float
16945 \end_layout
16946
16947 \end_inset
16948
16949  is used.
16950  It should be set to 
16951 \begin_inset Flex Code
16952 status collapsed
16953
16954 \begin_layout Plain Layout
16955 1
16956 \end_layout
16957
16958 \end_inset
16959
16960  if the float is already defined by the \SpecialChar LaTeX
16961  document class.
16962 \end_layout
16963
16964 \begin_layout Description
16965 \begin_inset Flex Code
16966 status collapsed
16967
16968 \begin_layout Plain Layout
16969 ListCommand
16970 \end_layout
16971
16972 \end_inset
16973
16974  [
16975 \begin_inset Flex Code
16976 status collapsed
16977
16978 \begin_layout Plain Layout
16979 string
16980 \end_layout
16981
16982 \end_inset
16983
16984 =
16985 \begin_inset Quotes erd
16986 \end_inset
16987
16988
16989 \begin_inset Quotes erd
16990 \end_inset
16991
16992 ] The command used to generate a list of floats of this type; the leading
16993  `
16994 \backslash
16995 ' must be omitted.
16996  This 
16997 \emph on
16998 must
16999 \emph default
17000  be given if 
17001 \begin_inset Flex Code
17002 status collapsed
17003
17004 \begin_layout Plain Layout
17005 UsesFloatPkg
17006 \end_layout
17007
17008 \end_inset
17009
17010  is false, since there is no standard way to generate this command.
17011  It is ignored if 
17012 \begin_inset Flex Code
17013 status collapsed
17014
17015 \begin_layout Plain Layout
17016 UsesFloatPkg
17017 \end_layout
17018
17019 \end_inset
17020
17021  is true, since in that case there is a standard way to define the command.
17022 \end_layout
17023
17024 \begin_layout Description
17025 \begin_inset Flex Code
17026 status collapsed
17027
17028 \begin_layout Plain Layout
17029 ListName
17030 \end_layout
17031
17032 \end_inset
17033
17034  [
17035 \begin_inset Flex Code
17036 status collapsed
17037
17038 \begin_layout Plain Layout
17039 string
17040 \end_layout
17041
17042 \end_inset
17043
17044 =
17045 \begin_inset Quotes erd
17046 \end_inset
17047
17048
17049 \begin_inset Quotes erd
17050 \end_inset
17051
17052 ] A title for a list of floats of this kind (list of figures, tables, or
17053  whatever).
17054  It is used for the screen label within \SpecialChar LyX
17055 , it is used by \SpecialChar LaTeX
17056  for the title and
17057  it is used as the title in the XHTML output.
17058  It will be translated to the document language.
17059 \end_layout
17060
17061 \begin_layout Description
17062 \begin_inset Flex Code
17063 status collapsed
17064
17065 \begin_layout Plain Layout
17066 NumberWithin
17067 \end_layout
17068
17069 \end_inset
17070
17071  [
17072 \begin_inset Flex Code
17073 status collapsed
17074
17075 \begin_layout Plain Layout
17076 string
17077 \end_layout
17078
17079 \end_inset
17080
17081 =
17082 \begin_inset Quotes erd
17083 \end_inset
17084
17085
17086 \begin_inset Quotes erd
17087 \end_inset
17088
17089 ] This (optional) argument determines whether floats of this class will
17090  be numbered within some sectional unit of the document.
17091  For example, if 
17092 \begin_inset Flex Code
17093 status collapsed
17094
17095 \begin_layout Plain Layout
17096 NumberWithin
17097 \end_layout
17098
17099 \end_inset
17100
17101  is set to 
17102 \begin_inset Quotes eld
17103 \end_inset
17104
17105
17106 \begin_inset Flex Code
17107 status collapsed
17108
17109 \begin_layout Plain Layout
17110 chapter
17111 \end_layout
17112
17113 \end_inset
17114
17115
17116 \begin_inset Quotes erd
17117 \end_inset
17118
17119 , the floats will be numbered within chapters.
17120  
17121 \end_layout
17122
17123 \begin_layout Description
17124 \begin_inset Flex Code
17125 status collapsed
17126
17127 \begin_layout Plain Layout
17128 Placement
17129 \end_layout
17130
17131 \end_inset
17132
17133  [
17134 \begin_inset Flex Code
17135 status collapsed
17136
17137 \begin_layout Plain Layout
17138 string
17139 \end_layout
17140
17141 \end_inset
17142
17143 =
17144 \begin_inset Quotes erd
17145 \end_inset
17146
17147
17148 \begin_inset Quotes erd
17149 \end_inset
17150
17151 ] The default placement for the given class of floats.
17152  The string should be as in standard \SpecialChar LaTeX
17153
17154 \begin_inset Flex Code
17155 status collapsed
17156
17157 \begin_layout Plain Layout
17158 t
17159 \end_layout
17160
17161 \end_inset
17162
17163
17164 \begin_inset Flex Code
17165 status collapsed
17166
17167 \begin_layout Plain Layout
17168 b
17169 \end_layout
17170
17171 \end_inset
17172
17173
17174 \begin_inset Flex Code
17175 status collapsed
17176
17177 \begin_layout Plain Layout
17178 p
17179 \end_layout
17180
17181 \end_inset
17182
17183  and 
17184 \begin_inset Flex Code
17185 status collapsed
17186
17187 \begin_layout Plain Layout
17188 h
17189 \end_layout
17190
17191 \end_inset
17192
17193  for top, bottom, page, and here, respectively.
17194 \begin_inset Foot
17195 status collapsed
17196
17197 \begin_layout Plain Layout
17198 Note that the order of these letters in the string is irrelevant, like in
17199  \SpecialChar LaTeX
17200 .
17201 \end_layout
17202
17203 \end_inset
17204
17205  On top of that there is a new type, 
17206 \begin_inset Flex Code
17207 status collapsed
17208
17209 \begin_layout Plain Layout
17210 H
17211 \end_layout
17212
17213 \end_inset
17214
17215 , which does not really correspond to a float, since it means: put it 
17216 \begin_inset Quotes eld
17217 \end_inset
17218
17219 here
17220 \begin_inset Quotes erd
17221 \end_inset
17222
17223  and nowhere else.
17224  Note however that the 
17225 \begin_inset Flex Code
17226 status collapsed
17227
17228 \begin_layout Plain Layout
17229 H
17230 \end_layout
17231
17232 \end_inset
17233
17234  specifier is special and, because of implementation details, cannot be
17235  used in non-built in float types.
17236  If you do not understand what this means, just use 
17237 \begin_inset Quotes eld
17238 \end_inset
17239
17240
17241 \begin_inset Flex Code
17242 status collapsed
17243
17244 \begin_layout Plain Layout
17245 tbp
17246 \end_layout
17247
17248 \end_inset
17249
17250
17251 \begin_inset Quotes erd
17252 \end_inset
17253
17254 .
17255 \end_layout
17256
17257 \begin_layout Description
17258 \begin_inset Flex Code
17259 status collapsed
17260
17261 \begin_layout Plain Layout
17262 RefPrefix
17263 \end_layout
17264
17265 \end_inset
17266
17267  [
17268 \begin_inset Flex Code
17269 status collapsed
17270
17271 \begin_layout Plain Layout
17272 string
17273 \end_layout
17274
17275 \end_inset
17276
17277 ] The prefix to use when creating labels referring to floats of this type.
17278  This allows the use of formatted references.
17279  Note that you can remove any 
17280 \begin_inset Flex Code
17281 status collapsed
17282
17283 \begin_layout Plain Layout
17284 RefPrefix
17285 \end_layout
17286
17287 \end_inset
17288
17289  set by a copied style by using the special value 
17290 \begin_inset Quotes eld
17291 \end_inset
17292
17293 OFF
17294 \begin_inset Quotes erd
17295 \end_inset
17296
17297 , which must be all caps.
17298 \end_layout
17299
17300 \begin_layout Description
17301 \begin_inset Flex Code
17302 status collapsed
17303
17304 \begin_layout Plain Layout
17305 Style
17306 \end_layout
17307
17308 \end_inset
17309
17310  [
17311 \begin_inset Flex Code
17312 status collapsed
17313
17314 \begin_layout Plain Layout
17315 string
17316 \end_layout
17317
17318 \end_inset
17319
17320 =
17321 \begin_inset Quotes erd
17322 \end_inset
17323
17324
17325 \begin_inset Quotes erd
17326 \end_inset
17327
17328 ] The style used when defining the float using 
17329 \begin_inset Flex Code
17330 status collapsed
17331
17332 \begin_layout Plain Layout
17333
17334 \backslash
17335 newfloat
17336 \end_layout
17337
17338 \end_inset
17339
17340 .
17341 \end_layout
17342
17343 \begin_layout Description
17344 \begin_inset Flex Code
17345 status collapsed
17346
17347 \begin_layout Plain Layout
17348 Type
17349 \end_layout
17350
17351 \end_inset
17352
17353  [
17354 \begin_inset Flex Code
17355 status collapsed
17356
17357 \begin_layout Plain Layout
17358 string
17359 \end_layout
17360
17361 \end_inset
17362
17363 =
17364 \begin_inset Quotes erd
17365 \end_inset
17366
17367
17368 \begin_inset Quotes erd
17369 \end_inset
17370
17371 ] The 
17372 \begin_inset Quotes eld
17373 \end_inset
17374
17375 type
17376 \begin_inset Quotes erd
17377 \end_inset
17378
17379  of the new class of floats, like program or algorithm.
17380  After the appropriate 
17381 \begin_inset Flex Code
17382 status collapsed
17383
17384 \begin_layout Plain Layout
17385
17386 \backslash
17387 newfloat
17388 \end_layout
17389
17390 \end_inset
17391
17392 , commands such as 
17393 \begin_inset Flex Code
17394 status collapsed
17395
17396 \begin_layout Plain Layout
17397
17398 \backslash
17399 begin{program}
17400 \end_layout
17401
17402 \end_inset
17403
17404  or 
17405 \begin_inset Flex Code
17406 status collapsed
17407
17408 \begin_layout Plain Layout
17409
17410 \backslash
17411 end{algorithm*}
17412 \end_layout
17413
17414 \end_inset
17415
17416  will be available.
17417 \end_layout
17418
17419 \begin_layout Description
17420 \begin_inset Flex Code
17421 status collapsed
17422
17423 \begin_layout Plain Layout
17424 UsesFloatPkg
17425 \end_layout
17426
17427 \end_inset
17428
17429  [
17430 \begin_inset Flex Code
17431 status collapsed
17432
17433 \begin_layout Plain Layout
17434 0
17435 \end_layout
17436
17437 \end_inset
17438
17439 ,
17440 \begin_inset space \thinspace{}
17441 \end_inset
17442
17443
17444 \begin_inset Flex Code
17445 status collapsed
17446
17447 \begin_layout Plain Layout
17448
17449 \emph on
17450 1
17451 \end_layout
17452
17453 \end_inset
17454
17455 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17456  package 
17457 \begin_inset Flex Code
17458 status collapsed
17459
17460 \begin_layout Plain Layout
17461 float
17462 \end_layout
17463
17464 \end_inset
17465
17466 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17467  itself.
17468 \end_layout
17469
17470 \begin_layout Standard
17471 Note that defining a float with type 
17472 \begin_inset Flex Code
17473 status collapsed
17474
17475 \begin_layout Plain Layout
17476
17477 \emph on
17478 type
17479 \end_layout
17480
17481 \end_inset
17482
17483  automatically defines the corresponding counter with name 
17484 \begin_inset Flex Code
17485 status collapsed
17486
17487 \begin_layout Plain Layout
17488
17489 \emph on
17490 type
17491 \end_layout
17492
17493 \end_inset
17494
17495 .
17496 \end_layout
17497
17498 \begin_layout Subsection
17499 Flex insets and InsetLayout
17500 \begin_inset CommandInset label
17501 LatexCommand label
17502 name "subsec:Flex-insets-and"
17503
17504 \end_inset
17505
17506
17507 \end_layout
17508
17509 \begin_layout Standard
17510 Flex insets come in three different kinds: 
17511 \end_layout
17512
17513 \begin_layout Itemize
17514 character style (
17515 \begin_inset Flex Code
17516 status collapsed
17517
17518 \begin_layout Plain Layout
17519 CharStyle
17520 \end_layout
17521
17522 \end_inset
17523
17524 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17525  commands as 
17526 \begin_inset Flex Code
17527 status collapsed
17528
17529 \begin_layout Plain Layout
17530
17531 \backslash
17532 noun
17533 \end_layout
17534
17535 \end_inset
17536
17537  and 
17538 \begin_inset Flex Code
17539 status collapsed
17540
17541 \begin_layout Plain Layout
17542
17543 \backslash
17544 code
17545 \end_layout
17546
17547 \end_inset
17548
17549 .
17550 \end_layout
17551
17552 \begin_layout Itemize
17553 user custom (
17554 \begin_inset Flex Code
17555 status collapsed
17556
17557 \begin_layout Plain Layout
17558 Custom
17559 \end_layout
17560
17561 \end_inset
17562
17563 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17564  code,
17565  footnote, and the like.
17566  An obvious example is an endnote inset, which is defined in the 
17567 \begin_inset Flex Code
17568 status collapsed
17569
17570 \begin_layout Plain Layout
17571 endnote
17572 \end_layout
17573
17574 \end_inset
17575
17576  module.
17577 \end_layout
17578
17579 \begin_layout Itemize
17580 XML elements (
17581 \begin_inset Flex Code
17582 status collapsed
17583
17584 \begin_layout Plain Layout
17585 Element
17586 \end_layout
17587
17588 \end_inset
17589
17590 ): For use with DocBook classes.
17591 \end_layout
17592
17593 \begin_layout Standard
17594 Flex insets are defined using the 
17595 \begin_inset Flex Code
17596 status collapsed
17597
17598 \begin_layout Plain Layout
17599 InsetLayout
17600 \end_layout
17601
17602 \end_inset
17603
17604  tag, which shall be explained in a moment.
17605 \end_layout
17606
17607 \begin_layout Standard
17608 The 
17609 \begin_inset Flex Code
17610 status collapsed
17611
17612 \begin_layout Plain Layout
17613 InsetLayout
17614 \end_layout
17615
17616 \end_inset
17617
17618  tag also serves another function: It can be used to customize the general
17619  layout of many different types of insets.
17620  Currently, 
17621 \begin_inset Flex Code
17622 status collapsed
17623
17624 \begin_layout Plain Layout
17625 InsetLayout
17626 \end_layout
17627
17628 \end_inset
17629
17630  can be used to customize the layout parameters for footnotes, marginal
17631  notes, note insets, \SpecialChar TeX
17632  code (ERT) insets, branches, listings, indexes, boxes,
17633  tables, algorithms, URLs, and captions, as well as to define Flex insets.
17634 \end_layout
17635
17636 \begin_layout Standard
17637 The 
17638 \begin_inset Flex Code
17639 status collapsed
17640
17641 \begin_layout Plain Layout
17642 InsetLayout
17643 \end_layout
17644
17645 \end_inset
17646
17647  definition must begin with a line of the form:
17648 \end_layout
17649
17650 \begin_layout LyX-Code
17651 InsetLayout <type>
17652 \end_layout
17653
17654 \begin_layout Standard
17655 Here 
17656 \begin_inset Flex Code
17657 status collapsed
17658
17659 \begin_layout Plain Layout
17660 <Type>
17661 \end_layout
17662
17663 \end_inset
17664
17665  indicates the inset whose layout is being defined, and here there are four
17666  cases.
17667 \end_layout
17668
17669 \begin_layout Enumerate
17670 The layout for a pre-existing inset is being modified.
17671  In this case, can be 
17672 \begin_inset Flex Code
17673 status collapsed
17674
17675 \begin_layout Plain Layout
17676 <Type>
17677 \end_layout
17678
17679 \end_inset
17680
17681  any one of the following: 
17682 \begin_inset Flex Code
17683 status collapsed
17684
17685 \begin_layout Plain Layout
17686 Algorithm
17687 \end_layout
17688
17689 \end_inset
17690
17691
17692 \begin_inset Flex Code
17693 status collapsed
17694
17695 \begin_layout Plain Layout
17696 Branch
17697 \end_layout
17698
17699 \end_inset
17700
17701
17702 \begin_inset Flex Code
17703 status collapsed
17704
17705 \begin_layout Plain Layout
17706 Box
17707 \end_layout
17708
17709 \end_inset
17710
17711
17712 \begin_inset Flex Code
17713 status collapsed
17714
17715 \begin_layout Plain Layout
17716 Box:shaded
17717 \end_layout
17718
17719 \end_inset
17720
17721
17722 \begin_inset Flex Code
17723 status collapsed
17724
17725 \begin_layout Plain Layout
17726 Caption:Standard
17727 \end_layout
17728
17729 \end_inset
17730
17731
17732 \begin_inset Flex Code
17733 status collapsed
17734
17735 \begin_layout Plain Layout
17736 ERT
17737 \end_layout
17738
17739 \end_inset
17740
17741
17742 \begin_inset Flex Code
17743 status collapsed
17744
17745 \begin_layout Plain Layout
17746 Figure
17747 \end_layout
17748
17749 \end_inset
17750
17751
17752 \begin_inset Flex Code
17753 status collapsed
17754
17755 \begin_layout Plain Layout
17756 Foot
17757 \end_layout
17758
17759 \end_inset
17760
17761
17762 \begin_inset Flex Code
17763 status collapsed
17764
17765 \begin_layout Plain Layout
17766 Index
17767 \end_layout
17768
17769 \end_inset
17770
17771
17772 \begin_inset Flex Code
17773 status collapsed
17774
17775 \begin_layout Plain Layout
17776 Info
17777 \end_layout
17778
17779 \end_inset
17780
17781
17782 \begin_inset Flex Code
17783 status collapsed
17784
17785 \begin_layout Plain Layout
17786 Info:menu
17787 \end_layout
17788
17789 \end_inset
17790
17791
17792 \begin_inset Flex Code
17793 status collapsed
17794
17795 \begin_layout Plain Layout
17796 Info:shortcut
17797 \end_layout
17798
17799 \end_inset
17800
17801
17802 \begin_inset Flex Code
17803 status collapsed
17804
17805 \begin_layout Plain Layout
17806 Info:shortcuts
17807 \end_layout
17808
17809 \end_inset
17810
17811
17812 \begin_inset Flex Code
17813 status collapsed
17814
17815 \begin_layout Plain Layout
17816 Listings
17817 \end_layout
17818
17819 \end_inset
17820
17821
17822 \begin_inset Flex Code
17823 status collapsed
17824
17825 \begin_layout Plain Layout
17826 Marginal
17827 \end_layout
17828
17829 \end_inset
17830
17831
17832 \begin_inset Flex Code
17833 status collapsed
17834
17835 \begin_layout Plain Layout
17836 Note:Comment
17837 \end_layout
17838
17839 \end_inset
17840
17841
17842 \begin_inset Flex Code
17843 status collapsed
17844
17845 \begin_layout Plain Layout
17846 Note:Note
17847 \end_layout
17848
17849 \end_inset
17850
17851
17852 \begin_inset Flex Code
17853 status collapsed
17854
17855 \begin_layout Plain Layout
17856 Note:Greyedout
17857 \end_layout
17858
17859 \end_inset
17860
17861
17862 \begin_inset Flex Code
17863 status collapsed
17864
17865 \begin_layout Plain Layout
17866 Table
17867 \end_layout
17868
17869 \end_inset
17870
17871 , or 
17872 \begin_inset Flex Code
17873 status collapsed
17874
17875 \begin_layout Plain Layout
17876 URL
17877 \end_layout
17878
17879 \end_inset
17880
17881 .
17882 \end_layout
17883
17884 \begin_layout Enumerate
17885 The layout for a Flex inset is being defined.
17886  In this case, 
17887 \begin_inset Flex Code
17888 status collapsed
17889
17890 \begin_layout Plain Layout
17891 <Type>
17892 \end_layout
17893
17894 \end_inset
17895
17896  must be of the form 
17897 \begin_inset Quotes eld
17898 \end_inset
17899
17900
17901 \begin_inset Flex Code
17902 status collapsed
17903
17904 \begin_layout Plain Layout
17905 Flex:<name>
17906 \end_layout
17907
17908 \end_inset
17909
17910
17911 \begin_inset Quotes erd
17912 \end_inset
17913
17914 , where 
17915 \begin_inset Flex Code
17916 status collapsed
17917
17918 \begin_layout Plain Layout
17919 name
17920 \end_layout
17921
17922 \end_inset
17923
17924  may be be any valid identifier not used by a pre-existing Flex inset.
17925  The identifier may include spaces, but in that case the whole thing must
17926  be wrapped in quotes.
17927  Note that the definition of a flex inset 
17928 \emph on
17929 must 
17930 \emph default
17931 also include a 
17932 \begin_inset Flex Code
17933 status collapsed
17934
17935 \begin_layout Plain Layout
17936 LyXType
17937 \end_layout
17938
17939 \end_inset
17940
17941  entry, declaring which type of inset it defines.
17942 \end_layout
17943
17944 \begin_layout Enumerate
17945 The layout for user specific branch is being defined.
17946  In this case, 
17947 \begin_inset Flex Code
17948 status collapsed
17949
17950 \begin_layout Plain Layout
17951 <Type>
17952 \end_layout
17953
17954 \end_inset
17955
17956  must be of the form 
17957 \begin_inset Quotes eld
17958 \end_inset
17959
17960
17961 \begin_inset Flex Code
17962 status collapsed
17963
17964 \begin_layout Plain Layout
17965 Branch:<name>
17966 \end_layout
17967
17968 \end_inset
17969
17970
17971 \begin_inset Quotes erd
17972 \end_inset
17973
17974 , where 
17975 \begin_inset Flex Code
17976 status collapsed
17977
17978 \begin_layout Plain Layout
17979 name
17980 \end_layout
17981
17982 \end_inset
17983
17984  may be be any valid identifier of branch defined in user's document.
17985  The identifier may include spaces, but in that case the whole thing must
17986  be wrapped in quotes.
17987  The main purpose of this feature is to allow \SpecialChar LaTeX
17988  wrapping around specific
17989  branches as user needs.
17990 \end_layout
17991
17992 \begin_layout Enumerate
17993 The layout of a user (or class) specific caption is being defined.
17994  In this case, 
17995 \begin_inset Flex Code
17996 status collapsed
17997
17998 \begin_layout Plain Layout
17999 <Type>
18000 \end_layout
18001
18002 \end_inset
18003
18004  must be of the form 
18005 \begin_inset Quotes eld
18006 \end_inset
18007
18008
18009 \begin_inset Flex Code
18010 status collapsed
18011
18012 \begin_layout Plain Layout
18013 Caption:<name>
18014 \end_layout
18015
18016 \end_inset
18017
18018
18019 \begin_inset Quotes erd
18020 \end_inset
18021
18022 , where 
18023 \begin_inset Flex Code
18024 status collapsed
18025
18026 \begin_layout Plain Layout
18027 name
18028 \end_layout
18029
18030 \end_inset
18031
18032  specifies the name of the caption as it appears in the menu.
18033  Have a look at the standard caption (
18034 \begin_inset Flex Code
18035 status collapsed
18036
18037 \begin_layout Plain Layout
18038 Caption:Standard
18039 \end_layout
18040
18041 \end_inset
18042
18043 ), the specific captions of the KOMA-Script classes (
18044 \begin_inset Flex Code
18045 status collapsed
18046
18047 \begin_layout Plain Layout
18048 Caption:Above
18049 \end_layout
18050
18051 \end_inset
18052
18053
18054 \begin_inset Flex Code
18055 status collapsed
18056
18057 \begin_layout Plain Layout
18058 Caption:Below
18059 \end_layout
18060
18061 \end_inset
18062
18063 ) or the module 
18064 \family sans
18065 Multilingual
18066 \begin_inset space ~
18067 \end_inset
18068
18069 Captions 
18070 \family default
18071 (
18072 \begin_inset Flex Code
18073 status collapsed
18074
18075 \begin_layout Plain Layout
18076 Caption:Bicaption
18077 \end_layout
18078
18079 \end_inset
18080
18081 ) for applications.
18082 \end_layout
18083
18084 \begin_layout Standard
18085 The 
18086 \begin_inset Flex Code
18087 status collapsed
18088
18089 \begin_layout Plain Layout
18090 InsetLayout
18091 \end_layout
18092
18093 \end_inset
18094
18095  definition can contain the following entries:
18096 \end_layout
18097
18098 \begin_layout Description
18099
18100 \change_inserted 2047637253 1483963036
18101 \begin_inset Flex Code
18102 status collapsed
18103
18104 \begin_layout Plain Layout
18105
18106 \change_inserted 2047637253 1483900123
18107 AddToToc
18108 \end_layout
18109
18110 \end_inset
18111
18112  [
18113 \begin_inset Flex Code
18114 status collapsed
18115
18116 \begin_layout Plain Layout
18117
18118 \change_inserted 2047637253 1483962897
18119 string
18120 \end_layout
18121
18122 \end_inset
18123
18124 =""] This inset will appear in the table of contents of the given type.
18125  An empty string disables.
18126  See also the OutlinerName and the IsTocCaption commands.
18127  This is only implemented for Flex insets.
18128  Default: disabled.
18129 \end_layout
18130
18131 \begin_layout Description
18132 \begin_inset Flex Code
18133 status collapsed
18134
18135 \begin_layout Plain Layout
18136 Argument
18137 \end_layout
18138
18139 \end_inset
18140
18141  [
18142 \begin_inset Flex Code
18143 status collapsed
18144
18145 \begin_layout Plain Layout
18146 int
18147 \end_layout
18148
18149 \end_inset
18150
18151 ] Defines argument number of a command\SpecialChar breakableslash
18152 environment associated with the current
18153  layout.
18154  The definition must end with 
18155 \begin_inset Flex Code
18156 status collapsed
18157
18158 \begin_layout Plain Layout
18159 EndArgument
18160 \end_layout
18161
18162 \end_inset
18163
18164 .
18165  See 
18166 \begin_inset CommandInset ref
18167 LatexCommand ref
18168 reference "subsec:Paragraph-Styles"
18169
18170 \end_inset
18171
18172  for details.
18173 \end_layout
18174
18175 \begin_layout Description
18176 \begin_inset Flex Code
18177 status collapsed
18178
18179 \begin_layout Plain Layout
18180 BabelPreamble
18181 \end_layout
18182
18183 \end_inset
18184
18185  Preamble for changing language commands; see 
18186 \begin_inset CommandInset ref
18187 LatexCommand ref
18188 reference "subsec:I18n"
18189
18190 \end_inset
18191
18192 .
18193 \end_layout
18194
18195 \begin_layout Description
18196 \begin_inset Flex Code
18197 status collapsed
18198
18199 \begin_layout Plain Layout
18200 BgColor
18201 \end_layout
18202
18203 \end_inset
18204
18205  [
18206 \begin_inset Flex Code
18207 status collapsed
18208
18209 \begin_layout Plain Layout
18210 <name>
18211 \end_layout
18212
18213 \end_inset
18214
18215 ] The color for the inset's background.
18216  See 
18217 \begin_inset CommandInset ref
18218 LatexCommand ref
18219 reference "chap:Names-of-colors"
18220
18221 \end_inset
18222
18223  for a list of the available color names.
18224 \end_layout
18225
18226 \begin_layout Description
18227 \begin_inset Flex Code
18228 status collapsed
18229
18230 \begin_layout Plain Layout
18231 ContentAsLabel
18232 \end_layout
18233
18234 \end_inset
18235
18236  [
18237 \begin_inset Flex Code
18238 status collapsed
18239
18240 \begin_layout Plain Layout
18241
18242 \emph on
18243 0
18244 \end_layout
18245
18246 \end_inset
18247
18248 ,
18249 \begin_inset space \thinspace{}
18250 \end_inset
18251
18252
18253 \begin_inset Flex Code
18254 status collapsed
18255
18256 \begin_layout Plain Layout
18257 1
18258 \end_layout
18259
18260 \end_inset
18261
18262 ] Whether to use the content of the inset as the label, when the inset is
18263  closed.
18264  Default is false.
18265 \end_layout
18266
18267 \begin_layout Description
18268 \begin_inset Flex Code
18269 status collapsed
18270
18271 \begin_layout Plain Layout
18272 CopyStyle
18273 \end_layout
18274
18275 \end_inset
18276
18277  [
18278 \begin_inset Flex Code
18279 status collapsed
18280
18281 \begin_layout Plain Layout
18282 <type>
18283 \end_layout
18284
18285 \end_inset
18286
18287 ] As with paragraph styles, see 
18288 \begin_inset CommandInset ref
18289 LatexCommand ref
18290 reference "subsec:Paragraph-Styles"
18291
18292 \end_inset
18293
18294 .
18295  Note that you need to specify the complete type, e.
18296 \begin_inset space \thinspace{}
18297 \end_inset
18298
18299 g.
18300 \begin_inset space ~
18301 \end_inset
18302
18303
18304 \begin_inset Flex Code
18305 status collapsed
18306
18307 \begin_layout Plain Layout
18308 CopyStyle Flex:<name>
18309 \end_layout
18310
18311 \end_inset
18312
18313 .
18314 \end_layout
18315
18316 \begin_layout Description
18317 \begin_inset Flex Code
18318 status collapsed
18319
18320 \begin_layout Plain Layout
18321 CustomPars
18322 \end_layout
18323
18324 \end_inset
18325
18326  [
18327 \begin_inset Flex Code
18328 status collapsed
18329
18330 \begin_layout Plain Layout
18331
18332 \emph on
18333 0
18334 \end_layout
18335
18336 \end_inset
18337
18338 ,
18339 \begin_inset space \thinspace{}
18340 \end_inset
18341
18342
18343 \begin_inset Flex Code
18344 status collapsed
18345
18346 \begin_layout Plain Layout
18347 1
18348 \end_layout
18349
18350 \end_inset
18351
18352 ] Indicates whether the user may employ the Paragraph Settings dialog to
18353  customize the paragraph.
18354 \end_layout
18355
18356 \begin_layout Description
18357 \begin_inset Flex Code
18358 status collapsed
18359
18360 \begin_layout Plain Layout
18361 Decoration
18362 \end_layout
18363
18364 \end_inset
18365
18366  can be 
18367 \begin_inset Flex Code
18368 status collapsed
18369
18370 \begin_layout Plain Layout
18371 Classic
18372 \end_layout
18373
18374 \end_inset
18375
18376
18377 \begin_inset Flex Code
18378 status collapsed
18379
18380 \begin_layout Plain Layout
18381 Minimalistic
18382 \end_layout
18383
18384 \end_inset
18385
18386 , or 
18387 \begin_inset Flex Code
18388 status collapsed
18389
18390 \begin_layout Plain Layout
18391 Conglomerate
18392 \end_layout
18393
18394 \end_inset
18395
18396 , describing the rendering style used for the inset's frame and buttons.
18397  Footnotes generally use 
18398 \begin_inset Flex Code
18399 status collapsed
18400
18401 \begin_layout Plain Layout
18402 Classic
18403 \end_layout
18404
18405 \end_inset
18406
18407 , ERT insets generally 
18408 \begin_inset Flex Code
18409 status collapsed
18410
18411 \begin_layout Plain Layout
18412 Minimalistic
18413 \end_layout
18414
18415 \end_inset
18416
18417 , and character styles 
18418 \begin_inset Flex Code
18419 status collapsed
18420
18421 \begin_layout Plain Layout
18422 Conglomerate
18423 \end_layout
18424
18425 \end_inset
18426
18427 .
18428 \end_layout
18429
18430 \begin_layout Description
18431 \begin_inset Flex Code
18432 status collapsed
18433
18434 \begin_layout Plain Layout
18435 Display
18436 \end_layout
18437
18438 \end_inset
18439
18440  [
18441 \begin_inset Flex Code
18442 status collapsed
18443
18444 \begin_layout Plain Layout
18445 0
18446 \end_layout
18447
18448 \end_inset
18449
18450 ,
18451 \emph on
18452
18453 \begin_inset space \thinspace{}
18454 \end_inset
18455
18456
18457 \emph default
18458
18459 \begin_inset Flex Code
18460 status collapsed
18461
18462 \begin_layout Plain Layout
18463
18464 \emph on
18465 1
18466 \end_layout
18467
18468 \end_inset
18469
18470 ] Only useful if 
18471 \begin_inset Flex Code
18472 status collapsed
18473
18474 \begin_layout Plain Layout
18475 LatexType
18476 \end_layout
18477
18478 \end_inset
18479
18480  is 
18481 \begin_inset Flex Code
18482 status collapsed
18483
18484 \begin_layout Plain Layout
18485 Environment
18486 \end_layout
18487
18488 \end_inset
18489
18490 .
18491  Indicates whether the environment will stand on its own in the output or
18492  will appear inline with the surrounding text.
18493  If set to false, it is supposed that the \SpecialChar LaTeX
18494  environment ignores white space
18495  (including one newline character) after the 
18496 \begin_inset Flex Code
18497 status collapsed
18498
18499 \begin_layout Plain Layout
18500
18501 \backslash
18502 begin{
18503 \emph on
18504 LatexName
18505 \emph default
18506 }
18507 \end_layout
18508
18509 \end_inset
18510
18511  and 
18512 \begin_inset Flex Code
18513 status collapsed
18514
18515 \begin_layout Plain Layout
18516
18517 \backslash
18518 end{
18519 \emph on
18520 LatexName
18521 \emph default
18522 }
18523 \end_layout
18524
18525 \end_inset
18526
18527  tags.
18528  Default is true.
18529 \end_layout
18530
18531 \begin_layout Description
18532 \begin_inset Flex Code
18533 status collapsed
18534
18535 \begin_layout Plain Layout
18536 End
18537 \end_layout
18538
18539 \end_inset
18540
18541  Required at the end of the 
18542 \begin_inset Flex Code
18543 status collapsed
18544
18545 \begin_layout Plain Layout
18546 InsetLayout
18547 \end_layout
18548
18549 \end_inset
18550
18551  declarations.
18552 \end_layout
18553
18554 \begin_layout Description
18555 \begin_inset Flex Code
18556 status collapsed
18557
18558 \begin_layout Plain Layout
18559 Font
18560 \end_layout
18561
18562 \end_inset
18563
18564  The font used for both the text body 
18565 \emph on
18566 and
18567 \emph default
18568  the label.
18569  See 
18570 \begin_inset CommandInset ref
18571 LatexCommand ref
18572 reference "subsec:Font-description"
18573
18574 \end_inset
18575
18576 .
18577  Note that defining this font automatically defines the 
18578 \begin_inset Flex Code
18579 status collapsed
18580
18581 \begin_layout Plain Layout
18582 LabelFont
18583 \end_layout
18584
18585 \end_inset
18586
18587  to the same value, so define this first and define 
18588 \begin_inset Flex Code
18589 status collapsed
18590
18591 \begin_layout Plain Layout
18592 LabelFont
18593 \end_layout
18594
18595 \end_inset
18596
18597  later if you want them to be different.
18598 \end_layout
18599
18600 \begin_layout Description
18601 \begin_inset Flex Code
18602 status collapsed
18603
18604 \begin_layout Plain Layout
18605 FixedWidthPreambleEncoding
18606 \end_layout
18607
18608 \end_inset
18609
18610  [
18611 \begin_inset Flex Code
18612 status collapsed
18613
18614 \begin_layout Plain Layout
18615
18616 \emph on
18617 0
18618 \end_layout
18619
18620 \end_inset
18621
18622 ,
18623 \begin_inset space \thinspace{}
18624 \end_inset
18625
18626
18627 \begin_inset Flex Code
18628 status collapsed
18629
18630 \begin_layout Plain Layout
18631 1
18632 \end_layout
18633
18634 \end_inset
18635
18636 ] Force a fixed width encoding for the translated contents of 
18637 \begin_inset Flex Code
18638 status collapsed
18639
18640 \begin_layout Plain Layout
18641 BabelPreamble
18642 \end_layout
18643
18644 \end_inset
18645
18646  and 
18647 \begin_inset Flex Code
18648 status collapsed
18649
18650 \begin_layout Plain Layout
18651 LangPreamble
18652 \end_layout
18653
18654 \end_inset
18655
18656  code generated by this layout.
18657  This is needed for special \SpecialChar LaTeX
18658 -packages like 
18659 \family typewriter
18660 listings
18661 \family default
18662  that do not work with variable width encodings such as 
18663 \family sans
18664 utf8
18665 \family default
18666 .
18667  This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18668  backends such as Xe\SpecialChar TeX
18669  or
18670  Lua\SpecialChar TeX
18671  are used.
18672 \end_layout
18673
18674 \begin_layout Description
18675 \begin_inset Flex Code
18676 status collapsed
18677
18678 \begin_layout Plain Layout
18679 ForceLocalFontSwitch
18680 \end_layout
18681
18682 \end_inset
18683
18684  [
18685 \begin_inset Flex Code
18686 status collapsed
18687
18688 \begin_layout Plain Layout
18689
18690 \emph on
18691 0
18692 \end_layout
18693
18694 \end_inset
18695
18696 ,
18697 \begin_inset space \thinspace{}
18698 \end_inset
18699
18700
18701 \begin_inset Flex Code
18702 status collapsed
18703
18704 \begin_layout Plain Layout
18705 1
18706 \end_layout
18707
18708 \end_inset
18709
18710 ] When using babel, always use a local font switch (
18711 \begin_inset Flex Code
18712 status collapsed
18713
18714 \begin_layout Plain Layout
18715
18716 \backslash
18717 foreignlanguage
18718 \end_layout
18719
18720 \end_inset
18721
18722 ), never a global one (such as 
18723 \begin_inset Flex Code
18724 status collapsed
18725
18726 \begin_layout Plain Layout
18727
18728 \backslash
18729 selectlanguage
18730 \end_layout
18731
18732 \end_inset
18733
18734 ).
18735 \end_layout
18736
18737 \begin_layout Description
18738 \begin_inset Flex Code
18739 status collapsed
18740
18741 \begin_layout Plain Layout
18742 ForceLTR
18743 \end_layout
18744
18745 \end_inset
18746
18747  [
18748 \begin_inset Flex Code
18749 status collapsed
18750
18751 \begin_layout Plain Layout
18752
18753 \emph on
18754 0
18755 \end_layout
18756
18757 \end_inset
18758
18759 ,
18760 \begin_inset space \thinspace{}
18761 \end_inset
18762
18763
18764 \begin_inset Flex Code
18765 status collapsed
18766
18767 \begin_layout Plain Layout
18768 1
18769 \end_layout
18770
18771 \end_inset
18772
18773 ] Force the 
18774 \begin_inset Quotes eld
18775 \end_inset
18776
18777 latex
18778 \begin_inset Quotes erd
18779 \end_inset
18780
18781  language, leading to Left-to-Right (Latin) output, e.
18782 \begin_inset space \thinspace{}
18783 \end_inset
18784
18785 g.
18786 \begin_inset space \space{}
18787 \end_inset
18788
18789 in \SpecialChar TeX
18790  code or URL.
18791  A kludge.
18792 \end_layout
18793
18794 \begin_layout Description
18795 \begin_inset Flex Code
18796 status collapsed
18797
18798 \begin_layout Plain Layout
18799 ForceOwnlines
18800 \end_layout
18801
18802 \end_inset
18803
18804  [
18805 \begin_inset Flex Code
18806 status collapsed
18807
18808 \begin_layout Plain Layout
18809
18810 \emph on
18811 0
18812 \end_layout
18813
18814 \end_inset
18815
18816 ,
18817 \begin_inset space \thinspace{}
18818 \end_inset
18819
18820
18821 \begin_inset Flex Code
18822 status collapsed
18823
18824 \begin_layout Plain Layout
18825 1
18826 \end_layout
18827
18828 \end_inset
18829
18830 ] Force a a line break in the \SpecialChar LaTeX
18831  output before the inset starts and after
18832  the inset ends.
18833  This assures the inset itself is output on its own lines, for parsing purposes.
18834 \end_layout
18835
18836 \begin_layout Description
18837 \begin_inset Flex Code
18838 status collapsed
18839
18840 \begin_layout Plain Layout
18841 ForcePlain
18842 \end_layout
18843
18844 \end_inset
18845
18846  [
18847 \begin_inset Flex Code
18848 status collapsed
18849
18850 \begin_layout Plain Layout
18851
18852 \emph on
18853 0
18854 \end_layout
18855
18856 \end_inset
18857
18858 ,
18859 \begin_inset space \thinspace{}
18860 \end_inset
18861
18862
18863 \begin_inset Flex Code
18864 status collapsed
18865
18866 \begin_layout Plain Layout
18867 1
18868 \end_layout
18869
18870 \end_inset
18871
18872 ] Indicates whether the 
18873 \begin_inset Flex Code
18874 status collapsed
18875
18876 \begin_layout Plain Layout
18877 PlainLayout
18878 \end_layout
18879
18880 \end_inset
18881
18882  should be used or, instead, the user can change the paragraph style used
18883  in the inset.
18884  Default is false.
18885 \end_layout
18886
18887 \begin_layout Description
18888 \begin_inset Flex Code
18889 status collapsed
18890
18891 \begin_layout Plain Layout
18892 FreeSpacing
18893 \end_layout
18894
18895 \end_inset
18896
18897  [
18898 \begin_inset Flex Code
18899 status collapsed
18900
18901 \begin_layout Plain Layout
18902
18903 \emph on
18904 0
18905 \end_layout
18906
18907 \end_inset
18908
18909 ,
18910 \begin_inset space \thinspace{}
18911 \end_inset
18912
18913
18914 \begin_inset Flex Code
18915 status collapsed
18916
18917 \begin_layout Plain Layout
18918 1
18919 \end_layout
18920
18921 \end_inset
18922
18923 ] As with paragraph styles, see 
18924 \begin_inset CommandInset ref
18925 LatexCommand ref
18926 reference "subsec:Paragraph-Styles"
18927
18928 \end_inset
18929
18930 .
18931 \end_layout
18932
18933 \begin_layout Description
18934 \begin_inset Flex Code
18935 status collapsed
18936
18937 \begin_layout Plain Layout
18938 HTML*
18939 \end_layout
18940
18941 \end_inset
18942
18943  These tags control the XHTML output.
18944  See 
18945 \begin_inset CommandInset ref
18946 LatexCommand ref
18947 reference "sec:Tags-for-XHTML"
18948
18949 \end_inset
18950
18951 .
18952 \end_layout
18953
18954 \begin_layout Description
18955 \begin_inset Flex Code
18956 status collapsed
18957
18958 \begin_layout Plain Layout
18959 InToc
18960 \end_layout
18961
18962 \end_inset
18963
18964  [
18965 \begin_inset Flex Code
18966 status collapsed
18967
18968 \begin_layout Plain Layout
18969
18970 \emph on
18971 0
18972 \end_layout
18973
18974 \end_inset
18975
18976 ,
18977 \begin_inset space \thinspace{}
18978 \end_inset
18979
18980
18981 \begin_inset Flex Code
18982 status collapsed
18983
18984 \begin_layout Plain Layout
18985 1
18986 \end_layout
18987
18988 \end_inset
18989
18990 ] Whether to include the contents of this inset in the strings generated
18991  for the `Outline' pane
18992 \change_inserted 2047637253 1483900773
18993  for all table of contents, regardless of the AddToToc setting
18994 \change_unchanged
18995 .
18996  One would not, for example, want the content of a footnote in a section
18997  header to be included in the TOC displayed in the outline, but one would
18998  normally want the content of a character style displayed.
18999  Default is false: not to include.
19000 \change_inserted 2047637253 1483900609
19001
19002 \end_layout
19003
19004 \begin_layout Description
19005
19006 \change_inserted 2047637253 1483901257
19007 \begin_inset Flex Code
19008 status collapsed
19009
19010 \begin_layout Plain Layout
19011
19012 \change_inserted 2047637253 1483900725
19013 IsTocCaption
19014 \end_layout
19015
19016 \end_inset
19017
19018  [
19019 \begin_inset Flex Code
19020 status collapsed
19021
19022 \begin_layout Plain Layout
19023
19024 \change_inserted 2047637253 1483900620
19025
19026 \emph on
19027 0
19028 \end_layout
19029
19030 \end_inset
19031
19032 ,
19033 \begin_inset space \thinspace{}
19034 \end_inset
19035
19036
19037 \begin_inset Flex Code
19038 status collapsed
19039
19040 \begin_layout Plain Layout
19041
19042 \change_inserted 2047637253 1483900620
19043 1
19044 \end_layout
19045
19046 \end_inset
19047
19048 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19049  of its contents in its item in the table of contents.
19050  Otherwise, only the label appears.
19051 \change_unchanged
19052
19053 \end_layout
19054
19055 \begin_layout Description
19056 \begin_inset Flex Code
19057 status collapsed
19058
19059 \begin_layout Plain Layout
19060 KeepEmpty
19061 \end_layout
19062
19063 \end_inset
19064
19065  [
19066 \emph on
19067
19068 \begin_inset Flex Code
19069 status collapsed
19070
19071 \begin_layout Plain Layout
19072 0
19073 \end_layout
19074
19075 \end_inset
19076
19077
19078 \emph default
19079 ,
19080 \begin_inset space \thinspace{}
19081 \end_inset
19082
19083
19084 \begin_inset Flex Code
19085 status collapsed
19086
19087 \begin_layout Plain Layout
19088 1
19089 \end_layout
19090
19091 \end_inset
19092
19093 ] As with paragraph styles, see 
19094 \begin_inset CommandInset ref
19095 LatexCommand ref
19096 reference "subsec:Paragraph-Styles"
19097
19098 \end_inset
19099
19100 .
19101 \end_layout
19102
19103 \begin_layout Description
19104 \begin_inset Flex Code
19105 status collapsed
19106
19107 \begin_layout Plain Layout
19108 LabelFont
19109 \end_layout
19110
19111 \end_inset
19112
19113  The font used for the label.
19114  See 
19115 \begin_inset CommandInset ref
19116 LatexCommand ref
19117 reference "subsec:Font-description"
19118
19119 \end_inset
19120
19121 .
19122  Note that this definition can never appear before 
19123 \begin_inset Flex Code
19124 status collapsed
19125
19126 \begin_layout Plain Layout
19127 Font
19128 \end_layout
19129
19130 \end_inset
19131
19132 , lest it be ineffective.
19133 \end_layout
19134
19135 \begin_layout Description
19136 \begin_inset Flex Code
19137 status collapsed
19138
19139 \begin_layout Plain Layout
19140 LabelString
19141 \end_layout
19142
19143 \end_inset
19144
19145  [
19146 \begin_inset Flex Code
19147 status collapsed
19148
19149 \begin_layout Plain Layout
19150 string
19151 \end_layout
19152
19153 \end_inset
19154
19155 =
19156 \begin_inset Quotes erd
19157 \end_inset
19158
19159
19160 \begin_inset Quotes erd
19161 \end_inset
19162
19163 ] What will be displayed on the button or elsewhere as the inset label.
19164  Some inset types (
19165 \begin_inset Flex Code
19166 status collapsed
19167
19168 \begin_layout Plain Layout
19169 \SpecialChar TeX
19170  code
19171 \end_layout
19172
19173 \end_inset
19174
19175  and 
19176 \begin_inset Flex Code
19177 status collapsed
19178
19179 \begin_layout Plain Layout
19180 Branch
19181 \end_layout
19182
19183 \end_inset
19184
19185 ) modify this label on the fly.
19186 \end_layout
19187
19188 \begin_layout Description
19189 \begin_inset Flex Code
19190 status collapsed
19191
19192 \begin_layout Plain Layout
19193 LangPreamble
19194 \end_layout
19195
19196 \end_inset
19197
19198  Language dependent preamble; see 
19199 \begin_inset CommandInset ref
19200 LatexCommand ref
19201 reference "subsec:I18n"
19202
19203 \end_inset
19204
19205 .
19206 \end_layout
19207
19208 \begin_layout Description
19209 \begin_inset Flex Code
19210 status collapsed
19211
19212 \begin_layout Plain Layout
19213 LatexName
19214 \end_layout
19215
19216 \end_inset
19217
19218  [
19219 \begin_inset Flex Code
19220 status collapsed
19221
19222 \begin_layout Plain Layout
19223 <name>
19224 \end_layout
19225
19226 \end_inset
19227
19228 ] The name of the corresponding \SpecialChar LaTeX
19229  stuff.
19230  Either the environment or command name.
19231 \end_layout
19232
19233 \begin_layout Description
19234 \begin_inset Flex Code
19235 status collapsed
19236
19237 \begin_layout Plain Layout
19238 LatexParam
19239 \end_layout
19240
19241 \end_inset
19242
19243  [
19244 \begin_inset Flex Code
19245 status collapsed
19246
19247 \begin_layout Plain Layout
19248 <parameter>
19249 \end_layout
19250
19251 \end_inset
19252
19253 ] The optional parameter for the corresponding 
19254 \begin_inset Flex Code
19255 status collapsed
19256
19257 \begin_layout Plain Layout
19258 LatexName
19259 \end_layout
19260
19261 \end_inset
19262
19263  stuff, including possible bracket pairs like 
19264 \begin_inset Flex Code
19265 status collapsed
19266
19267 \begin_layout Plain Layout
19268 []
19269 \end_layout
19270
19271 \end_inset
19272
19273 .
19274  This parameter cannot be changed from within \SpecialChar LyX
19275  (use 
19276 \begin_inset Flex Code
19277 status collapsed
19278
19279 \begin_layout Plain Layout
19280 Argument
19281 \end_layout
19282
19283 \end_inset
19284
19285  for customizable parameters).
19286  It will be output as is after all \SpecialChar LaTeX
19287  
19288 \begin_inset Flex Code
19289 status collapsed
19290
19291 \begin_layout Plain Layout
19292 Argument
19293 \end_layout
19294
19295 \end_inset
19296
19297 s.
19298 \end_layout
19299
19300 \begin_layout Description
19301 \begin_inset Flex Code
19302 status collapsed
19303
19304 \begin_layout Plain Layout
19305 LatexType
19306 \end_layout
19307
19308 \end_inset
19309
19310  [
19311 \begin_inset Flex Code
19312 status collapsed
19313
19314 \begin_layout Plain Layout
19315 Command, Environment, None
19316 \end_layout
19317
19318 \end_inset
19319
19320 ] How the style should be translated into \SpecialChar LaTeX
19321 .
19322 \begin_inset Foot
19323 status collapsed
19324
19325 \begin_layout Plain Layout
19326 \begin_inset Flex Code
19327 status collapsed
19328
19329 \begin_layout Plain Layout
19330 LatexType
19331 \end_layout
19332
19333 \end_inset
19334
19335  is perhaps a bit misleading, since these rules apply to SGML classes too.
19336  Visit the SGML class files for specific examples.
19337 \end_layout
19338
19339 \end_inset
19340
19341
19342 \end_layout
19343
19344 \begin_deeper
19345 \begin_layout Description
19346 \begin_inset Flex Code
19347 status collapsed
19348
19349 \begin_layout Plain Layout
19350 None
19351 \end_layout
19352
19353 \end_inset
19354
19355  means nothing special
19356 \end_layout
19357
19358 \begin_layout Description
19359 \begin_inset Flex Code
19360 status collapsed
19361
19362 \begin_layout Plain Layout
19363 Command
19364 \end_layout
19365
19366 \end_inset
19367
19368  means 
19369 \begin_inset Flex Code
19370 status collapsed
19371
19372 \begin_layout Plain Layout
19373
19374 \backslash
19375
19376 \emph on
19377 LatexName
19378 \emph default
19379 {\SpecialChar ldots
19380 }
19381 \end_layout
19382
19383 \end_inset
19384
19385
19386 \end_layout
19387
19388 \begin_layout Description
19389 \begin_inset Flex Code
19390 status collapsed
19391
19392 \begin_layout Plain Layout
19393 Environment
19394 \end_layout
19395
19396 \end_inset
19397
19398  means 
19399 \begin_inset Flex Code
19400 status collapsed
19401
19402 \begin_layout Plain Layout
19403
19404 \backslash
19405 begin{
19406 \emph on
19407 LatexName
19408 \emph default
19409 }\SpecialChar ldots
19410
19411 \backslash
19412 end{
19413 \emph on
19414 LatexName
19415 \emph default
19416 }
19417 \end_layout
19418
19419 \end_inset
19420
19421
19422 \end_layout
19423
19424 \begin_layout Standard
19425 Putting the last few things together, the \SpecialChar LaTeX
19426  output will be either: 
19427 \end_layout
19428
19429 \begin_layout LyX-Code
19430
19431 \backslash
19432 LatexName[LatexParam]{\SpecialChar ldots
19433 }
19434 \end_layout
19435
19436 \begin_layout Standard
19437 or: 
19438 \end_layout
19439
19440 \begin_layout LyX-Code
19441
19442 \backslash
19443 begin{LatexName}[LatexParam] \SpecialChar ldots
19444  
19445 \backslash
19446 end{LatexName}
19447 \end_layout
19448
19449 \begin_layout Standard
19450 depending upon the \SpecialChar LaTeX
19451  type.
19452 \end_layout
19453
19454 \end_deeper
19455 \begin_layout Description
19456 \begin_inset Flex Code
19457 status collapsed
19458
19459 \begin_layout Plain Layout
19460 LeftDelim
19461 \end_layout
19462
19463 \end_inset
19464
19465  [
19466 \begin_inset Flex Code
19467 status collapsed
19468
19469 \begin_layout Plain Layout
19470 string
19471 \end_layout
19472
19473 \end_inset
19474
19475 ] A string that is put at the beginning of the layout content.
19476  A line break in the output can be indicated by 
19477 \begin_inset Flex Code
19478 status collapsed
19479
19480 \begin_layout Plain Layout
19481 <br/>
19482 \end_layout
19483
19484 \end_inset
19485
19486 .
19487 \end_layout
19488
19489 \begin_layout Description
19490 \begin_inset Flex Code
19491 status collapsed
19492
19493 \begin_layout Plain Layout
19494 LyxType
19495 \end_layout
19496
19497 \end_inset
19498
19499  Can be 
19500 \begin_inset Flex Code
19501 status collapsed
19502
19503 \begin_layout Plain Layout
19504 charstyle
19505 \end_layout
19506
19507 \end_inset
19508
19509
19510 \begin_inset Flex Code
19511 status collapsed
19512
19513 \begin_layout Plain Layout
19514 custom
19515 \end_layout
19516
19517 \end_inset
19518
19519
19520 \begin_inset Flex Code
19521 status collapsed
19522
19523 \begin_layout Plain Layout
19524 element
19525 \end_layout
19526
19527 \end_inset
19528
19529  or 
19530 \begin_inset Flex Code
19531 status collapsed
19532
19533 \begin_layout Plain Layout
19534 end
19535 \end_layout
19536
19537 \end_inset
19538
19539  (indicating a dummy definition ending definitions of charstyles, etc).
19540  This entry is required in and is only meaningful for Flex insets.
19541  Among other things, it determines on which menu this inset will appear.
19542  Setting 
19543 \begin_inset Flex Code
19544 status collapsed
19545
19546 \begin_layout Plain Layout
19547 LyxType
19548 \end_layout
19549
19550 \end_inset
19551
19552  to 
19553 \begin_inset Flex Code
19554 status collapsed
19555
19556 \begin_layout Plain Layout
19557 charstyle
19558 \end_layout
19559
19560 \end_inset
19561
19562  will automatically set 
19563 \begin_inset Flex Code
19564 status collapsed
19565
19566 \begin_layout Plain Layout
19567 MultiPar
19568 \end_layout
19569
19570 \end_inset
19571
19572  to false and 
19573 \begin_inset Flex Code
19574 status collapsed
19575
19576 \begin_layout Plain Layout
19577 ForcePlain
19578 \end_layout
19579
19580 \end_inset
19581
19582  to true.
19583  
19584 \begin_inset Flex Code
19585 status collapsed
19586
19587 \begin_layout Plain Layout
19588 MultiPar
19589 \end_layout
19590
19591 \end_inset
19592
19593  can be set to true, or 
19594 \begin_inset Flex Code
19595 status collapsed
19596
19597 \begin_layout Plain Layout
19598 ForcePlain
19599 \end_layout
19600
19601 \end_inset
19602
19603  to false, for 
19604 \begin_inset Flex Code
19605 status collapsed
19606
19607 \begin_layout Plain Layout
19608 charstyle
19609 \end_layout
19610
19611 \end_inset
19612
19613  insets by setting it 
19614 \emph on
19615 after
19616 \emph default
19617  you set the 
19618 \begin_inset Flex Code
19619 status collapsed
19620
19621 \begin_layout Plain Layout
19622 LyxType
19623 \end_layout
19624
19625 \end_inset
19626
19627 .
19628 \end_layout
19629
19630 \begin_layout Description
19631 \begin_inset Flex Code
19632 status collapsed
19633
19634 \begin_layout Plain Layout
19635 MultiPar
19636 \end_layout
19637
19638 \end_inset
19639
19640  [
19641 \begin_inset Flex Code
19642 status collapsed
19643
19644 \begin_layout Plain Layout
19645
19646 \emph on
19647 0
19648 \end_layout
19649
19650 \end_inset
19651
19652 ,
19653 \begin_inset space \thinspace{}
19654 \end_inset
19655
19656
19657 \begin_inset Flex Code
19658 status collapsed
19659
19660 \begin_layout Plain Layout
19661 1
19662 \end_layout
19663
19664 \end_inset
19665
19666 ] Whether multiple paragraphs are permitted in this inset.
19667  This will also set 
19668 \begin_inset Flex Code
19669 status collapsed
19670
19671 \begin_layout Plain Layout
19672 CustomPars
19673 \end_layout
19674
19675 \end_inset
19676
19677  to the same value and 
19678 \begin_inset Flex Code
19679 status collapsed
19680
19681 \begin_layout Plain Layout
19682 ForcePlain
19683 \end_layout
19684
19685 \end_inset
19686
19687  to the opposite value.
19688  These can be reset to other values, if they are used 
19689 \emph on
19690 after
19691 \emph default
19692  
19693 \begin_inset Flex Code
19694 status collapsed
19695
19696 \begin_layout Plain Layout
19697 MultiPar
19698 \end_layout
19699
19700 \end_inset
19701
19702 .
19703  Default is true.
19704 \end_layout
19705
19706 \begin_layout Description
19707 \begin_inset Flex Code
19708 status collapsed
19709
19710 \begin_layout Plain Layout
19711 NeedProtect
19712 \end_layout
19713
19714 \end_inset
19715
19716  [
19717 \begin_inset Flex Code
19718 status collapsed
19719
19720 \begin_layout Plain Layout
19721
19722 \emph on
19723 0
19724 \end_layout
19725
19726 \end_inset
19727
19728 ,
19729 \begin_inset space \thinspace{}
19730 \end_inset
19731
19732
19733 \begin_inset Flex Code
19734 status collapsed
19735
19736 \begin_layout Plain Layout
19737 1
19738 \end_layout
19739
19740 \end_inset
19741
19742 ] Whether fragile commands in this inset should be 
19743 \begin_inset Flex Code
19744 status collapsed
19745
19746 \begin_layout Plain Layout
19747
19748 \backslash
19749 protect
19750 \end_layout
19751
19752 \end_inset
19753
19754 'ed.
19755  (Note: This is 
19756 \emph on
19757 not
19758 \emph default
19759  whether the command should itself be protected.) Default is false.
19760 \end_layout
19761
19762 \begin_layout Description
19763 \begin_inset Flex Code
19764 status collapsed
19765
19766 \begin_layout Plain Layout
19767 NoInsetLayout
19768 \end_layout
19769
19770 \end_inset
19771
19772  [
19773 \begin_inset Flex Code
19774 status collapsed
19775
19776 \begin_layout Plain Layout
19777 <layout>
19778 \end_layout
19779
19780 \end_inset
19781
19782 ] Deletes an existing 
19783 \begin_inset Flex Code
19784 status collapsed
19785
19786 \begin_layout Plain Layout
19787 InsetLayout
19788 \end_layout
19789
19790 \end_inset
19791
19792 .
19793 \end_layout
19794
19795 \begin_layout Description
19796 \begin_inset Flex Code
19797 status collapsed
19798
19799 \begin_layout Plain Layout
19800 ObsoletedBy
19801 \end_layout
19802
19803 \end_inset
19804
19805  [
19806 \begin_inset Flex Code
19807 status collapsed
19808
19809 \begin_layout Plain Layout
19810 <layout>
19811 \end_layout
19812
19813 \end_inset
19814
19815 ] Name of an 
19816 \begin_inset Flex Code
19817 status collapsed
19818
19819 \begin_layout Plain Layout
19820 InsetLayout
19821 \end_layout
19822
19823 \end_inset
19824
19825  that has replaced this 
19826 \begin_inset Flex Code
19827 status collapsed
19828
19829 \begin_layout Plain Layout
19830 InsetLayout
19831 \end_layout
19832
19833 \end_inset
19834
19835 .
19836  This is used to rename an 
19837 \begin_inset Flex Code
19838 status collapsed
19839
19840 \begin_layout Plain Layout
19841 InsetLayout
19842 \end_layout
19843
19844 \end_inset
19845
19846 , while keeping backward compatibility.
19847 \end_layout
19848
19849 \begin_layout Description
19850 \begin_inset Flex Code
19851 status collapsed
19852
19853 \begin_layout Plain Layout
19854 ParbreakIsNewline
19855 \end_layout
19856
19857 \end_inset
19858
19859  [
19860 \begin_inset Flex Code
19861 status collapsed
19862
19863 \begin_layout Plain Layout
19864
19865 \emph on
19866 0
19867 \end_layout
19868
19869 \end_inset
19870
19871 ,
19872 \begin_inset space \thinspace{}
19873 \end_inset
19874
19875
19876 \begin_inset Flex Code
19877 status collapsed
19878
19879 \begin_layout Plain Layout
19880 1
19881 \end_layout
19882
19883 \end_inset
19884
19885 ] As with paragraph styles, see 
19886 \begin_inset CommandInset ref
19887 LatexCommand ref
19888 reference "subsec:Paragraph-Styles"
19889
19890 \end_inset
19891
19892 .
19893  Default is false.
19894 \end_layout
19895
19896 \begin_layout Description
19897 \begin_inset Flex Code
19898 status collapsed
19899
19900 \begin_layout Plain Layout
19901 PassThru
19902 \end_layout
19903
19904 \end_inset
19905
19906  [
19907 \begin_inset Flex Code
19908 status collapsed
19909
19910 \begin_layout Plain Layout
19911
19912 \emph on
19913 0
19914 \end_layout
19915
19916 \end_inset
19917
19918 ,
19919 \begin_inset space \thinspace{}
19920 \end_inset
19921
19922
19923 \begin_inset Flex Code
19924 status collapsed
19925
19926 \begin_layout Plain Layout
19927 1
19928 \end_layout
19929
19930 \end_inset
19931
19932 ] As with paragraph styles, see 
19933 \begin_inset CommandInset ref
19934 LatexCommand ref
19935 reference "subsec:Paragraph-Styles"
19936
19937 \end_inset
19938
19939 .
19940  Default is false.
19941 \end_layout
19942
19943 \begin_layout Description
19944 \begin_inset Flex Code
19945 status collapsed
19946
19947 \begin_layout Plain Layout
19948 Preamble
19949 \end_layout
19950
19951 \end_inset
19952
19953  As with paragraph styles, see 
19954 \begin_inset CommandInset ref
19955 LatexCommand ref
19956 reference "subsec:Paragraph-Styles"
19957
19958 \end_inset
19959
19960 .
19961 \end_layout
19962
19963 \begin_layout Description
19964 \begin_inset Flex Code
19965 status collapsed
19966
19967 \begin_layout Plain Layout
19968 RefPrefix
19969 \end_layout
19970
19971 \end_inset
19972
19973  [
19974 \begin_inset Flex Code
19975 status collapsed
19976
19977 \begin_layout Plain Layout
19978 string
19979 \end_layout
19980
19981 \end_inset
19982
19983 ] The prefix to use when creating labels referring to insets of this type.
19984  This allows the use of formatted references.
19985 \end_layout
19986
19987 \begin_layout Description
19988 \begin_inset Flex Code
19989 status collapsed
19990
19991 \begin_layout Plain Layout
19992 Requires
19993 \end_layout
19994
19995 \end_inset
19996
19997  [
19998 \begin_inset Flex Code
19999 status collapsed
20000
20001 \begin_layout Plain Layout
20002 string
20003 \end_layout
20004
20005 \end_inset
20006
20007 ] As with paragraph styles, see 
20008 \begin_inset CommandInset ref
20009 LatexCommand ref
20010 reference "subsec:Paragraph-Styles"
20011
20012 \end_inset
20013
20014 .
20015 \end_layout
20016
20017 \begin_layout Description
20018 \begin_inset Flex Code
20019 status collapsed
20020
20021 \begin_layout Plain Layout
20022 ResetArgs
20023 \end_layout
20024
20025 \end_inset
20026
20027  [
20028 \begin_inset Flex Code
20029 status collapsed
20030
20031 \begin_layout Plain Layout
20032
20033 \emph on
20034 0
20035 \end_layout
20036
20037 \end_inset
20038
20039 ,
20040 \begin_inset space \thinspace{}
20041 \end_inset
20042
20043
20044 \begin_inset Flex Code
20045 status collapsed
20046
20047 \begin_layout Plain Layout
20048 1
20049 \end_layout
20050
20051 \end_inset
20052
20053 ] Resets the \SpecialChar LaTeX
20054  arguments of this layout (as defined via the 
20055 \begin_inset Flex Code
20056 status collapsed
20057
20058 \begin_layout Plain Layout
20059 Argument
20060 \end_layout
20061
20062 \end_inset
20063
20064  tag).
20065  This is useful if you have copied a style via 
20066 \begin_inset Flex Code
20067 status collapsed
20068
20069 \begin_layout Plain Layout
20070 CopyStyle
20071 \end_layout
20072
20073 \end_inset
20074
20075 , but you do not want to inherit its (required and optional) arguments.
20076 \end_layout
20077
20078 \begin_layout Description
20079 \begin_inset Flex Code
20080 status collapsed
20081
20082 \begin_layout Plain Layout
20083 ResetsFont
20084 \end_layout
20085
20086 \end_inset
20087
20088  [
20089 \begin_inset Flex Code
20090 status collapsed
20091
20092 \begin_layout Plain Layout
20093 0
20094 \end_layout
20095
20096 \end_inset
20097
20098 ,
20099 \begin_inset space \thinspace{}
20100 \end_inset
20101
20102
20103 \begin_inset Flex Code
20104 status collapsed
20105
20106 \begin_layout Plain Layout
20107
20108 \emph on
20109 1
20110 \end_layout
20111
20112 \end_inset
20113
20114 ] Whether this inset should use the font of its surrounding environment
20115  or uses its own.
20116  Default is false: use the font of the surrounding environment.
20117 \end_layout
20118
20119 \begin_layout Description
20120 \begin_inset Flex Code
20121 status collapsed
20122
20123 \begin_layout Plain Layout
20124 RightDelim
20125 \end_layout
20126
20127 \end_inset
20128
20129  [
20130 \begin_inset Flex Code
20131 status collapsed
20132
20133 \begin_layout Plain Layout
20134 string
20135 \end_layout
20136
20137 \end_inset
20138
20139 ] A string that is put at the end of the layout content.
20140  A line break in the output can be indicated by 
20141 \begin_inset Flex Code
20142 status collapsed
20143
20144 \begin_layout Plain Layout
20145 <br/>
20146 \end_layout
20147
20148 \end_inset
20149
20150 .
20151 \end_layout
20152
20153 \begin_layout Description
20154 \begin_inset Flex Code
20155 status collapsed
20156
20157 \begin_layout Plain Layout
20158 Spellcheck
20159 \end_layout
20160
20161 \end_inset
20162
20163  [
20164 \begin_inset Flex Code
20165 status collapsed
20166
20167 \begin_layout Plain Layout
20168 0
20169 \end_layout
20170
20171 \end_inset
20172
20173 ,
20174 \begin_inset space \thinspace{}
20175 \end_inset
20176
20177
20178 \begin_inset Flex Code
20179 status collapsed
20180
20181 \begin_layout Plain Layout
20182
20183 \emph on
20184 1
20185 \end_layout
20186
20187 \end_inset
20188
20189 ] Allow spell-checking the contents of this inset.
20190  Default is true.
20191 \end_layout
20192
20193 \begin_layout Subsection
20194 Counters
20195 \begin_inset CommandInset label
20196 LatexCommand label
20197 name "subsec:Counters"
20198
20199 \end_inset
20200
20201
20202 \end_layout
20203
20204 \begin_layout Standard
20205 It is necessary to define the counters (
20206 \begin_inset Flex Noun
20207 status collapsed
20208
20209 \begin_layout Plain Layout
20210 chapter
20211 \end_layout
20212
20213 \end_inset
20214
20215
20216 \begin_inset Flex Noun
20217 status collapsed
20218
20219 \begin_layout Plain Layout
20220 figure
20221 \end_layout
20222
20223 \end_inset
20224
20225 , \SpecialChar ldots
20226 ) in the text class itself.
20227  The standard counters are defined in the file 
20228 \begin_inset Flex Code
20229 status collapsed
20230
20231 \begin_layout Plain Layout
20232 stdcounters.inc
20233 \end_layout
20234
20235 \end_inset
20236
20237 , so you may have to do no more than add
20238 \end_layout
20239
20240 \begin_layout LyX-Code
20241 Input stdcounters.inc
20242 \end_layout
20243
20244 \begin_layout Standard
20245 to your layout file to get them to work.
20246  But if you want to define custom counters, then you can do so.
20247  The counter declaration must begin with:
20248 \end_layout
20249
20250 \begin_layout LyX-Code
20251 Counter CounterName
20252 \end_layout
20253
20254 \begin_layout Standard
20255 where of course `
20256 \begin_inset Flex Code
20257 status collapsed
20258
20259 \begin_layout Plain Layout
20260 CounterName
20261 \end_layout
20262
20263 \end_inset
20264
20265 ' is replaced by the name of the counter.
20266  And it must end with 
20267 \begin_inset Quotes eld
20268 \end_inset
20269
20270
20271 \begin_inset Flex Code
20272 status collapsed
20273
20274 \begin_layout Plain Layout
20275 End
20276 \end_layout
20277
20278 \end_inset
20279
20280
20281 \begin_inset Quotes erd
20282 \end_inset
20283
20284 .
20285  The following parameters can also be used:
20286 \end_layout
20287
20288 \begin_layout Description
20289 \begin_inset Flex Code
20290 status collapsed
20291
20292 \begin_layout Plain Layout
20293 InitialValue
20294 \end_layout
20295
20296 \end_inset
20297
20298  [
20299 \begin_inset Flex Code
20300 status collapsed
20301
20302 \begin_layout Plain Layout
20303 int=1
20304 \end_layout
20305
20306 \end_inset
20307
20308 ] Sets the initial value for the counter, to which it will be reset whenever
20309  that happens.
20310  Normally, one will want the default, 1.
20311 \end_layout
20312
20313 \begin_layout Description
20314 \begin_inset Flex Code
20315 status collapsed
20316
20317 \begin_layout Plain Layout
20318 LabelString
20319 \end_layout
20320
20321 \end_inset
20322
20323  [
20324 \begin_inset Flex Code
20325 status collapsed
20326
20327 \begin_layout Plain Layout
20328 string
20329 \end_layout
20330
20331 \end_inset
20332
20333 =
20334 \begin_inset Quotes erd
20335 \end_inset
20336
20337
20338 \begin_inset Quotes erd
20339 \end_inset
20340
20341 ] When defined, this string defines how the counter is displayed.
20342  Setting this value sets 
20343 \begin_inset Flex Code
20344 status collapsed
20345
20346 \begin_layout Plain Layout
20347 LabelStringAppendix
20348 \end_layout
20349
20350 \end_inset
20351
20352  to the same value.
20353  The following special constructs can be used in the string:
20354 \end_layout
20355
20356 \begin_deeper
20357 \begin_layout Itemize
20358 \begin_inset Flex Code
20359 status collapsed
20360
20361 \begin_layout Plain Layout
20362
20363 \backslash
20364 thecounter
20365 \end_layout
20366
20367 \end_inset
20368
20369  will be replaced by the expansion of the 
20370 \begin_inset Flex Code
20371 status collapsed
20372
20373 \begin_layout Plain Layout
20374 LabelString
20375 \end_layout
20376
20377 \end_inset
20378
20379  (or 
20380 \begin_inset Flex Code
20381 status collapsed
20382
20383 \begin_layout Plain Layout
20384 LabelStringAppendix
20385 \end_layout
20386
20387 \end_inset
20388
20389 ) of the counter 
20390 \begin_inset Flex Code
20391 status collapsed
20392
20393 \begin_layout Plain Layout
20394 counter
20395 \end_layout
20396
20397 \end_inset
20398
20399 .
20400  
20401 \end_layout
20402
20403 \begin_layout Itemize
20404 counter values can be expressed using \SpecialChar LaTeX
20405 -like macros
20406 \begin_inset Newline newline
20407 \end_inset
20408
20409
20410 \begin_inset Flex Code
20411 status collapsed
20412
20413 \begin_layout Plain Layout
20414
20415 \backslash
20416
20417 \emph on
20418 numbertype
20419 \emph default
20420 {
20421 \emph on
20422 counter
20423 \emph default
20424 }
20425 \end_layout
20426
20427 \end_inset
20428
20429 , where 
20430 \begin_inset Flex Code
20431 status collapsed
20432
20433 \begin_layout Plain Layout
20434
20435 \emph on
20436 numbertype
20437 \end_layout
20438
20439 \end_inset
20440
20441  can be:
20442 \begin_inset Foot
20443 status collapsed
20444
20445 \begin_layout Plain Layout
20446
20447 \family roman
20448 \series medium
20449 \shape up
20450 \size normal
20451 \emph off
20452 \bar no
20453 \noun off
20454 \color none
20455 Actually, the situation is a bit more complicated: any
20456 \family default
20457 \series default
20458 \shape default
20459 \emph default
20460 \bar default
20461  
20462 \size default
20463 \emph on
20464 \noun default
20465 \color inherit
20466 numbertype
20467 \family roman
20468 \series medium
20469 \shape up
20470 \size normal
20471 \emph off
20472 \bar no
20473 \noun off
20474  other than those described below will produce arabic numerals.
20475  It would not be surprising to see this change in the future.
20476 \end_layout
20477
20478 \end_inset
20479
20480  
20481 \begin_inset Flex Code
20482 status collapsed
20483
20484 \begin_layout Plain Layout
20485 arabic
20486 \end_layout
20487
20488 \end_inset
20489
20490 : 1, 2, 3,\SpecialChar ldots
20491
20492 \begin_inset Flex Code
20493 status collapsed
20494
20495 \begin_layout Plain Layout
20496 alph
20497 \end_layout
20498
20499 \end_inset
20500
20501  for lower-case letters: a, b, c, \SpecialChar ldots
20502
20503 \begin_inset Flex Code
20504 status collapsed
20505
20506 \begin_layout Plain Layout
20507 Alph
20508 \end_layout
20509
20510 \end_inset
20511
20512  for upper-case letters: A, B, C, \SpecialChar ldots
20513
20514 \begin_inset Flex Code
20515 status collapsed
20516
20517 \begin_layout Plain Layout
20518 roman
20519 \end_layout
20520
20521 \end_inset
20522
20523  for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20524
20525 \begin_inset Flex Code
20526 status collapsed
20527
20528 \begin_layout Plain Layout
20529 Roman
20530 \end_layout
20531
20532 \end_inset
20533
20534  for upper-case roman numerals: I, II, III\SpecialChar ldots
20535
20536 \begin_inset Flex Code
20537 status collapsed
20538
20539 \begin_layout Plain Layout
20540 hebrew
20541 \end_layout
20542
20543 \end_inset
20544
20545  for hebrew numerals.
20546 \end_layout
20547
20548 \end_deeper
20549 \begin_layout Standard
20550 If LabelString is not defined, a default value is constructed as follows:
20551  if the counter has a master counter 
20552 \begin_inset Flex Code
20553 status collapsed
20554
20555 \begin_layout Plain Layout
20556 master
20557 \end_layout
20558
20559 \end_inset
20560
20561  (defined via 
20562 \begin_inset Flex Code
20563 status collapsed
20564
20565 \begin_layout Plain Layout
20566 Within
20567 \end_layout
20568
20569 \end_inset
20570
20571 ), the string
20572 \begin_inset Newline newline
20573 \end_inset
20574
20575
20576 \begin_inset Flex Code
20577 status collapsed
20578
20579 \begin_layout Plain Layout
20580
20581 \backslash
20582 themaster.
20583 \backslash
20584 arabic{counter}
20585 \end_layout
20586
20587 \end_inset
20588
20589  is used; otherwise the string 
20590 \begin_inset Flex Code
20591 status collapsed
20592
20593 \begin_layout Plain Layout
20594
20595 \backslash
20596 arabic{counter}
20597 \end_layout
20598
20599 \end_inset
20600
20601  is used.
20602 \end_layout
20603
20604 \begin_layout Description
20605 \begin_inset Flex Code
20606 status collapsed
20607
20608 \begin_layout Plain Layout
20609 LabelStringAppendix
20610 \end_layout
20611
20612 \end_inset
20613
20614  [
20615 \begin_inset Flex Code
20616 status collapsed
20617
20618 \begin_layout Plain Layout
20619 string
20620 \end_layout
20621
20622 \end_inset
20623
20624 =
20625 \begin_inset Quotes erd
20626 \end_inset
20627
20628
20629 \begin_inset Quotes erd
20630 \end_inset
20631
20632 ] Same as 
20633 \begin_inset Flex Code
20634 status collapsed
20635
20636 \begin_layout Plain Layout
20637 LabelString
20638 \end_layout
20639
20640 \end_inset
20641
20642 , but for use in the Appendix.
20643 \end_layout
20644
20645 \begin_layout Description
20646 \begin_inset Flex Code
20647 status collapsed
20648
20649 \begin_layout Plain Layout
20650 PrettyFormat
20651 \end_layout
20652
20653 \end_inset
20654
20655  [
20656 \begin_inset Flex Code
20657 status collapsed
20658
20659 \begin_layout Plain Layout
20660 string
20661 \end_layout
20662
20663 \end_inset
20664
20665 =
20666 \begin_inset Quotes erd
20667 \end_inset
20668
20669
20670 \begin_inset Quotes erd
20671 \end_inset
20672
20673 ] A format for use with formatted references to this counter.
20674  For example, one might want to have references to section numbers appear
20675  as 
20676 \begin_inset Quotes eld
20677 \end_inset
20678
20679 Section 2.4
20680 \begin_inset Quotes erd
20681 \end_inset
20682
20683 .
20684  The string should contain 
20685 \begin_inset Quotes eld
20686 \end_inset
20687
20688 ##
20689 \begin_inset Quotes erd
20690 \end_inset
20691
20692 .
20693  This will be replaced by the counter number itself.
20694  So, for sections, it would be: Section ##.
20695 \end_layout
20696
20697 \begin_layout Description
20698 \begin_inset Flex Code
20699 status collapsed
20700
20701 \begin_layout Plain Layout
20702 Within
20703 \end_layout
20704
20705 \end_inset
20706
20707  [
20708 \begin_inset Flex Code
20709 status collapsed
20710
20711 \begin_layout Plain Layout
20712 string
20713 \end_layout
20714
20715 \end_inset
20716
20717 =
20718 \begin_inset Quotes erd
20719 \end_inset
20720
20721
20722 \begin_inset Quotes erd
20723 \end_inset
20724
20725 ] If this is set to the name of another counter, the present counter will
20726  be reset every time the other one is increased.
20727  For example, 
20728 \begin_inset Flex Code
20729 status collapsed
20730
20731 \begin_layout Plain Layout
20732 subsection
20733 \end_layout
20734
20735 \end_inset
20736
20737  is numbered inside 
20738 \begin_inset Flex Code
20739 status collapsed
20740
20741 \begin_layout Plain Layout
20742 section
20743 \end_layout
20744
20745 \end_inset
20746
20747 .
20748 \end_layout
20749
20750 \begin_layout Subsection
20751 Font description
20752 \begin_inset CommandInset label
20753 LatexCommand label
20754 name "subsec:Font-description"
20755
20756 \end_inset
20757
20758
20759 \end_layout
20760
20761 \begin_layout Standard
20762 A font description looks like this:
20763 \end_layout
20764
20765 \begin_layout LyX-Code
20766 Font 
20767 \family roman
20768 \emph on
20769 or
20770 \family default
20771 \emph default
20772  LabelFont
20773 \emph on
20774  or
20775 \emph default
20776  DefaultFont
20777 \end_layout
20778
20779 \begin_layout LyX-Code
20780  ...
20781 \end_layout
20782
20783 \begin_layout LyX-Code
20784 EndFont
20785 \end_layout
20786
20787 \begin_layout Standard
20788 The following commands are available:
20789 \end_layout
20790
20791 \begin_layout Description
20792 \begin_inset Flex Code
20793 status collapsed
20794
20795 \begin_layout Plain Layout
20796 Color
20797 \end_layout
20798
20799 \end_inset
20800
20801  [
20802 \begin_inset Flex Code
20803 status collapsed
20804
20805 \begin_layout Plain Layout
20806
20807 \emph on
20808 none
20809 \end_layout
20810
20811 \end_inset
20812
20813
20814 \begin_inset Flex Code
20815 status collapsed
20816
20817 \begin_layout Plain Layout
20818 black
20819 \end_layout
20820
20821 \end_inset
20822
20823
20824 \begin_inset Flex Code
20825 status collapsed
20826
20827 \begin_layout Plain Layout
20828 white
20829 \end_layout
20830
20831 \end_inset
20832
20833
20834 \begin_inset Flex Code
20835 status collapsed
20836
20837 \begin_layout Plain Layout
20838 red
20839 \end_layout
20840
20841 \end_inset
20842
20843
20844 \begin_inset Flex Code
20845 status collapsed
20846
20847 \begin_layout Plain Layout
20848 green
20849 \end_layout
20850
20851 \end_inset
20852
20853
20854 \begin_inset Flex Code
20855 status collapsed
20856
20857 \begin_layout Plain Layout
20858 blue
20859 \end_layout
20860
20861 \end_inset
20862
20863
20864 \begin_inset Flex Code
20865 status collapsed
20866
20867 \begin_layout Plain Layout
20868 cyan
20869 \end_layout
20870
20871 \end_inset
20872
20873
20874 \begin_inset Flex Code
20875 status collapsed
20876
20877 \begin_layout Plain Layout
20878 magenta
20879 \end_layout
20880
20881 \end_inset
20882
20883
20884 \begin_inset Flex Code
20885 status collapsed
20886
20887 \begin_layout Plain Layout
20888 yellow
20889 \end_layout
20890
20891 \end_inset
20892
20893
20894 \begin_inset Flex Code
20895 status collapsed
20896
20897 \begin_layout Plain Layout
20898 brown
20899 \end_layout
20900
20901 \end_inset
20902
20903
20904 \begin_inset Flex Code
20905 status collapsed
20906
20907 \begin_layout Plain Layout
20908 darkgray
20909 \end_layout
20910
20911 \end_inset
20912
20913
20914 \begin_inset Flex Code
20915 status collapsed
20916
20917 \begin_layout Plain Layout
20918 gray
20919 \end_layout
20920
20921 \end_inset
20922
20923
20924 \begin_inset Flex Code
20925 status collapsed
20926
20927 \begin_layout Plain Layout
20928 lightgray
20929 \end_layout
20930
20931 \end_inset
20932
20933
20934 \begin_inset Flex Code
20935 status collapsed
20936
20937 \begin_layout Plain Layout
20938 lime
20939 \end_layout
20940
20941 \end_inset
20942
20943
20944 \begin_inset Flex Code
20945 status collapsed
20946
20947 \begin_layout Plain Layout
20948 orange
20949 \end_layout
20950
20951 \end_inset
20952
20953
20954 \begin_inset Flex Code
20955 status collapsed
20956
20957 \begin_layout Plain Layout
20958 olive
20959 \end_layout
20960
20961 \end_inset
20962
20963
20964 \begin_inset Flex Code
20965 status collapsed
20966
20967 \begin_layout Plain Layout
20968 pink
20969 \end_layout
20970
20971 \end_inset
20972
20973
20974 \begin_inset Flex Code
20975 status collapsed
20976
20977 \begin_layout Plain Layout
20978 purple
20979 \end_layout
20980
20981 \end_inset
20982
20983
20984 \begin_inset Flex Code
20985 status collapsed
20986
20987 \begin_layout Plain Layout
20988 teal
20989 \end_layout
20990
20991 \end_inset
20992
20993
20994 \begin_inset Flex Code
20995 status collapsed
20996
20997 \begin_layout Plain Layout
20998 violet
20999 \end_layout
21000
21001 \end_inset
21002
21003 ]
21004 \end_layout
21005
21006 \begin_layout Description
21007 \begin_inset Flex Code
21008 status collapsed
21009
21010 \begin_layout Plain Layout
21011 Family
21012 \end_layout
21013
21014 \end_inset
21015
21016  [
21017 \begin_inset Flex Code
21018 status collapsed
21019
21020 \begin_layout Plain Layout
21021
21022 \emph on
21023 Roman
21024 \end_layout
21025
21026 \end_inset
21027
21028
21029 \begin_inset Flex Code
21030 status collapsed
21031
21032 \begin_layout Plain Layout
21033 Sans
21034 \end_layout
21035
21036 \end_inset
21037
21038
21039 \begin_inset Flex Code
21040 status collapsed
21041
21042 \begin_layout Plain Layout
21043 Typewriter
21044 \end_layout
21045
21046 \end_inset
21047
21048 ]
21049 \end_layout
21050
21051 \begin_layout Description
21052 \begin_inset Flex Code
21053 status collapsed
21054
21055 \begin_layout Plain Layout
21056 Misc
21057 \end_layout
21058
21059 \end_inset
21060
21061  [
21062 \begin_inset Flex Code
21063 status collapsed
21064
21065 \begin_layout Plain Layout
21066 string
21067 \end_layout
21068
21069 \end_inset
21070
21071 ] Valid arguments are: 
21072 \begin_inset Flex Code
21073 status collapsed
21074
21075 \begin_layout Plain Layout
21076 emph
21077 \end_layout
21078
21079 \end_inset
21080
21081
21082 \begin_inset Flex Code
21083 status collapsed
21084
21085 \begin_layout Plain Layout
21086 noun
21087 \end_layout
21088
21089 \end_inset
21090
21091
21092 \begin_inset Flex Code
21093 status collapsed
21094
21095 \begin_layout Plain Layout
21096 strikeout
21097 \end_layout
21098
21099 \end_inset
21100
21101
21102 \begin_inset Flex Code
21103 status collapsed
21104
21105 \begin_layout Plain Layout
21106 underbar
21107 \end_layout
21108
21109 \end_inset
21110
21111
21112 \begin_inset Flex Code
21113 status collapsed
21114
21115 \begin_layout Plain Layout
21116 uuline
21117 \end_layout
21118
21119 \end_inset
21120
21121
21122 \begin_inset Flex Code
21123 status collapsed
21124
21125 \begin_layout Plain Layout
21126 uwave
21127 \end_layout
21128
21129 \end_inset
21130
21131
21132 \begin_inset Flex Code
21133 status collapsed
21134
21135 \begin_layout Plain Layout
21136 no_emph
21137 \end_layout
21138
21139 \end_inset
21140
21141
21142 \begin_inset Flex Code
21143 status collapsed
21144
21145 \begin_layout Plain Layout
21146 no_noun
21147 \end_layout
21148
21149 \end_inset
21150
21151
21152 \begin_inset Flex Code
21153 status collapsed
21154
21155 \begin_layout Plain Layout
21156 no_strikeout
21157 \end_layout
21158
21159 \end_inset
21160
21161
21162 \begin_inset Flex Code
21163 status collapsed
21164
21165 \begin_layout Plain Layout
21166 no_bar
21167 \end_layout
21168
21169 \end_inset
21170
21171
21172 \begin_inset Flex Code
21173 status collapsed
21174
21175 \begin_layout Plain Layout
21176 no_uuline
21177 \end_layout
21178
21179 \end_inset
21180
21181  and 
21182 \begin_inset Flex Code
21183 status collapsed
21184
21185 \begin_layout Plain Layout
21186 no_uwave
21187 \end_layout
21188
21189 \end_inset
21190
21191 .
21192  Each of these turns on or off the corresponding attribute.
21193  For example, 
21194 \begin_inset Flex Code
21195 status collapsed
21196
21197 \begin_layout Plain Layout
21198 emph
21199 \end_layout
21200
21201 \end_inset
21202
21203  turns on emphasis, and 
21204 \begin_inset Flex Code
21205 status collapsed
21206
21207 \begin_layout Plain Layout
21208 no_emph
21209 \end_layout
21210
21211 \end_inset
21212
21213  turns it off.
21214  
21215 \begin_inset Newline newline
21216 \end_inset
21217
21218 If the latter seems puzzling, remember that the font settings for the present
21219  context are generally inherited from the surrounding context.
21220  So 
21221 \begin_inset Flex Code
21222 status collapsed
21223
21224 \begin_layout Plain Layout
21225 no_emph
21226 \end_layout
21227
21228 \end_inset
21229
21230  would turn off the emphasis that was anyway in effect, say, in a theorem
21231  environment.
21232 \end_layout
21233
21234 \begin_layout Description
21235 \begin_inset Flex Code
21236 status collapsed
21237
21238 \begin_layout Plain Layout
21239 Series
21240 \end_layout
21241
21242 \end_inset
21243
21244  [
21245 \begin_inset Flex Code
21246 status collapsed
21247
21248 \begin_layout Plain Layout
21249
21250 \emph on
21251 Medium
21252 \end_layout
21253
21254 \end_inset
21255
21256
21257 \begin_inset Flex Code
21258 status collapsed
21259
21260 \begin_layout Plain Layout
21261 Bold
21262 \end_layout
21263
21264 \end_inset
21265
21266
21267 \end_layout
21268
21269 \begin_layout Description
21270 \begin_inset Flex Code
21271 status collapsed
21272
21273 \begin_layout Plain Layout
21274 Shape
21275 \end_layout
21276
21277 \end_inset
21278
21279  [
21280 \begin_inset Flex Code
21281 status collapsed
21282
21283 \begin_layout Plain Layout
21284
21285 \emph on
21286 Up
21287 \end_layout
21288
21289 \end_inset
21290
21291
21292 \begin_inset Flex Code
21293 status collapsed
21294
21295 \begin_layout Plain Layout
21296 Italic
21297 \end_layout
21298
21299 \end_inset
21300
21301
21302 \begin_inset Flex Code
21303 status collapsed
21304
21305 \begin_layout Plain Layout
21306 SmallCaps
21307 \end_layout
21308
21309 \end_inset
21310
21311
21312 \begin_inset Flex Code
21313 status collapsed
21314
21315 \begin_layout Plain Layout
21316 Slanted
21317 \end_layout
21318
21319 \end_inset
21320
21321
21322 \end_layout
21323
21324 \begin_layout Description
21325 \begin_inset Flex Code
21326 status collapsed
21327
21328 \begin_layout Plain Layout
21329 Size
21330 \end_layout
21331
21332 \end_inset
21333
21334  [
21335 \begin_inset Flex Code
21336 status collapsed
21337
21338 \begin_layout Plain Layout
21339 tiny
21340 \end_layout
21341
21342 \end_inset
21343
21344
21345 \begin_inset Flex Code
21346 status collapsed
21347
21348 \begin_layout Plain Layout
21349 small
21350 \end_layout
21351
21352 \end_inset
21353
21354
21355 \begin_inset Flex Code
21356 status collapsed
21357
21358 \begin_layout Plain Layout
21359
21360 \emph on
21361 normal
21362 \end_layout
21363
21364 \end_inset
21365
21366
21367 \begin_inset Flex Code
21368 status collapsed
21369
21370 \begin_layout Plain Layout
21371 large
21372 \end_layout
21373
21374 \end_inset
21375
21376
21377 \begin_inset Flex Code
21378 status collapsed
21379
21380 \begin_layout Plain Layout
21381 larger
21382 \end_layout
21383
21384 \end_inset
21385
21386
21387 \begin_inset Flex Code
21388 status collapsed
21389
21390 \begin_layout Plain Layout
21391 largest
21392 \end_layout
21393
21394 \end_inset
21395
21396
21397 \begin_inset Flex Code
21398 status collapsed
21399
21400 \begin_layout Plain Layout
21401 huge
21402 \end_layout
21403
21404 \end_inset
21405
21406
21407 \begin_inset Flex Code
21408 status collapsed
21409
21410 \begin_layout Plain Layout
21411 giant
21412 \end_layout
21413
21414 \end_inset
21415
21416 ]
21417 \end_layout
21418
21419 \begin_layout Subsection
21420
21421 \change_inserted -712698321 1483869872
21422 \begin_inset CommandInset label
21423 LatexCommand label
21424 name "subsec:Citation-engine-description"
21425
21426 \end_inset
21427
21428 Citation engine description
21429 \end_layout
21430
21431 \begin_layout Standard
21432
21433 \change_inserted -712698321 1483875281
21434 The 
21435 \begin_inset Flex Code
21436 status collapsed
21437
21438 \begin_layout Plain Layout
21439
21440 \change_inserted -712698321 1483869913
21441 CiteEngine
21442 \change_unchanged
21443
21444 \end_layout
21445
21446 \end_inset
21447
21448  blocks, as used mainly in cite engine files (see 
21449 \begin_inset CommandInset ref
21450 LatexCommand ref
21451 reference "subsec:Cite-Engine-Files"
21452 plural "false"
21453 caps "false"
21454 noprefix "false"
21455
21456 \end_inset
21457
21458 ), define the citation commands provided by a specific 
21459 \begin_inset Quotes eld
21460 \end_inset
21461
21462 cite engine
21463 \begin_inset Quotes erd
21464 \end_inset
21465
21466 .
21467  A cite engine, in \SpecialChar LyX
21468  terms, is way specific way to format citations, using
21469  numbers, author names and/or years.
21470  Currently, \SpecialChar LyX
21471  supports three such engine types, namely:
21472 \end_layout
21473
21474 \begin_layout Enumerate
21475
21476 \change_inserted -712698321 1483875764
21477 \begin_inset Flex Code
21478 status collapsed
21479
21480 \begin_layout Plain Layout
21481
21482 \change_inserted -712698321 1483870430
21483 default
21484 \change_unchanged
21485
21486 \end_layout
21487
21488 \end_inset
21489
21490 : the default Bib\SpecialChar TeX
21491  way to format citations, a simple numeric style (e.
21492 \begin_inset space \thinspace{}
21493 \end_inset
21494
21495 g., 
21496 \begin_inset Quotes eld
21497 \end_inset
21498
21499 [1]
21500 \begin_inset Quotes erd
21501 \end_inset
21502
21503 )
21504 \end_layout
21505
21506 \begin_layout Enumerate
21507
21508 \change_inserted -712698321 1483875766
21509 \begin_inset Flex Code
21510 status collapsed
21511
21512 \begin_layout Plain Layout
21513
21514 \change_inserted -712698321 1483870434
21515 authoryear
21516 \change_unchanged
21517
21518 \end_layout
21519
21520 \end_inset
21521
21522 : Harvard-styled citations using author names and publication year (e.
21523 \begin_inset space \thinspace{}
21524 \end_inset
21525
21526 g., 
21527 \begin_inset Quotes eld
21528 \end_inset
21529
21530 Smith and Miller (2017b)
21531 \begin_inset Quotes erd
21532 \end_inset
21533
21534 )
21535 \end_layout
21536
21537 \begin_layout Enumerate
21538
21539 \change_inserted -712698321 1483875769
21540 \begin_inset Flex Code
21541 status collapsed
21542
21543 \begin_layout Plain Layout
21544
21545 \change_inserted -712698321 1483870457
21546 numerical
21547 \change_unchanged
21548
21549 \end_layout
21550
21551 \end_inset
21552
21553 : extended numerical citations that also allow for author or title next
21554  to the number (e.
21555 \begin_inset space \thinspace{}
21556 \end_inset
21557
21558 g., 
21559 \begin_inset Quotes eld
21560 \end_inset
21561
21562 Smith and Miller [1]
21563 \begin_inset Quotes erd
21564 \end_inset
21565
21566 )
21567 \end_layout
21568
21569 \begin_layout Standard
21570
21571 \change_inserted -712698321 1483870566
21572 \begin_inset Flex Code
21573 status collapsed
21574
21575 \begin_layout Plain Layout
21576
21577 \change_inserted -712698321 1483870552
21578 CiteEngine
21579 \end_layout
21580
21581 \end_inset
21582
21583  blocks look like this:
21584 \end_layout
21585
21586 \begin_layout LyX-Code
21587
21588 \change_inserted -712698321 1483870590
21589 CiteEngine default
21590 \end_layout
21591
21592 \begin_layout LyX-Code
21593
21594 \change_inserted -712698321 1483870615
21595  cite
21596 \end_layout
21597
21598 \begin_layout LyX-Code
21599
21600 \change_inserted -712698321 1483870633
21601  Citep*[][]
21602 \end_layout
21603
21604 \begin_layout LyX-Code
21605
21606 \change_inserted -712698321 1483870652
21607  citeyearpar[][]=parencite*
21608 \end_layout
21609
21610 \begin_layout LyX-Code
21611
21612 \change_inserted -712698321 1483870652
21613  ...
21614 \end_layout
21615
21616 \begin_layout LyX-Code
21617
21618 \change_inserted -712698321 1483870668
21619 End
21620 \end_layout
21621
21622 \begin_layout Standard
21623
21624 \change_inserted -712698321 1483871113
21625 The tag following 
21626 \begin_inset Flex Code
21627 status collapsed
21628
21629 \begin_layout Plain Layout
21630
21631 \change_inserted -712698321 1483871085
21632 CiteEngine
21633 \end_layout
21634
21635 \end_inset
21636
21637  denotes the engine.
21638  The individual lines respectively define a cite command or cite command
21639  paradigm supported by this engine.
21640  The line can be as simple as a cite command that is used both to name the
21641  respective \SpecialChar LyX
21642  command and the \SpecialChar LaTeX
21643  output or more complex in order to differentiate
21644  things.
21645  
21646 \change_deleted -712698321 1483871114
21647
21648 \end_layout
21649
21650 \begin_layout Standard
21651
21652 \change_inserted -712698321 1483871119
21653 The full syntax is:
21654 \end_layout
21655
21656 \begin_layout LyX-Code
21657
21658 \change_inserted -712698321 1484997816
21659 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21660 \end_layout
21661
21662 \begin_layout Itemize
21663
21664 \change_inserted -712698321 1483871222
21665 \begin_inset Flex Code
21666 status collapsed
21667
21668 \begin_layout Plain Layout
21669
21670 \change_inserted -712698321 1483871181
21671 LyXName
21672 \change_unchanged
21673
21674 \end_layout
21675
21676 \end_inset
21677
21678 : The name as used in the 
21679 \begin_inset Flex Code
21680 status collapsed
21681
21682 \begin_layout Plain Layout
21683
21684 \change_inserted -712698321 1483871216
21685 *.lyx
21686 \change_unchanged
21687
21688 \end_layout
21689
21690 \end_inset
21691
21692  file.
21693 \end_layout
21694
21695 \begin_deeper
21696 \begin_layout Standard
21697
21698 \change_inserted -712698321 1483871487
21699 For portability reasons, we try to use the same name for same-formatted
21700  commands in different cite packages (thus many names stem from natbib,
21701  and thus we need to differentiate a 
21702 \begin_inset Flex Code
21703 status collapsed
21704
21705 \begin_layout Plain Layout
21706
21707 \change_inserted -712698321 1483871402
21708 latexcmd
21709 \end_layout
21710
21711 \end_inset
21712
21713  sometimes, if the \SpecialChar LaTeX
21714  command names differ).
21715 \end_layout
21716
21717 \end_deeper
21718 \begin_layout Itemize
21719
21720 \change_inserted -712698321 1483871583
21721 \begin_inset Flex Code
21722 status collapsed
21723
21724 \begin_layout Plain Layout
21725
21726 \change_inserted -712698321 1483871186
21727 alias
21728 \change_unchanged
21729
21730 \end_layout
21731
21732 \end_inset
21733
21734 : a (comma-separated) list of commands that fall back to the given 
21735 \begin_inset Flex Code
21736 status collapsed
21737
21738 \begin_layout Plain Layout
21739
21740 \change_inserted -712698321 1483871257
21741 LyXName
21742 \end_layout
21743
21744 \end_inset
21745
21746  in the current engine.
21747  This eases the switch of citation packages and engines.
21748  The 
21749 \begin_inset Flex Code
21750 status collapsed
21751
21752 \begin_layout Plain Layout
21753
21754 \change_inserted -712698321 1483871559
21755 alias
21756 \end_layout
21757
21758 \end_inset
21759
21760  can be compared to 
21761 \begin_inset Flex Code
21762 status collapsed
21763
21764 \begin_layout Plain Layout
21765
21766 \change_inserted -712698321 1483871278
21767 ObsoletedBy
21768 \change_unchanged
21769
21770 \end_layout
21771
21772 \end_inset
21773
21774  in layout definitions.
21775 \end_layout
21776
21777 \begin_layout Itemize
21778
21779 \change_inserted -712698321 1483871307
21780 \begin_inset Flex Code
21781 status collapsed
21782
21783 \begin_layout Plain Layout
21784
21785 \change_inserted -712698321 1483871296
21786 latexcmd
21787 \change_unchanged
21788
21789 \end_layout
21790
21791 \end_inset
21792
21793 : The actual \SpecialChar LaTeX
21794  command that is output.
21795  
21796 \end_layout
21797
21798 \begin_layout Standard
21799
21800 \change_inserted -712698321 1483871348
21801 \begin_inset Flex Code
21802 status collapsed
21803
21804 \begin_layout Plain Layout
21805
21806 \change_inserted -712698321 1483871316
21807 Alias
21808 \change_unchanged
21809
21810 \end_layout
21811
21812 \end_inset
21813
21814  and 
21815 \begin_inset Flex Code
21816 status collapsed
21817
21818 \begin_layout Plain Layout
21819
21820 \change_inserted -712698321 1483871321
21821 latexcmd
21822 \change_unchanged
21823
21824 \end_layout
21825
21826 \end_inset
21827
21828  are optional.
21829  If no 
21830 \begin_inset Flex Code
21831 status collapsed
21832
21833 \begin_layout Plain Layout
21834
21835 \change_inserted -712698321 1483871333
21836 latexcmd
21837 \end_layout
21838
21839 \end_inset
21840
21841  is given, the 
21842 \begin_inset Flex Code
21843 status collapsed
21844
21845 \begin_layout Plain Layout
21846
21847 \change_inserted -712698321 1483871340
21848 LyXName
21849 \end_layout
21850
21851 \end_inset
21852
21853  will be output to \SpecialChar LaTeX
21854 .
21855 \end_layout
21856
21857 \begin_layout Standard
21858
21859 \change_inserted -712698321 1483871604
21860 Note further:
21861 \end_layout
21862
21863 \begin_layout Itemize
21864
21865 \change_inserted -712698321 1483871664
21866 Capitalization indicates that the command also has a capitalized form (
21867 \begin_inset Flex Code
21868 status collapsed
21869
21870 \begin_layout Plain Layout
21871
21872 \change_inserted -712698321 1483871622
21873
21874 \backslash
21875 Latexcmd
21876 \change_unchanged
21877
21878 \end_layout
21879
21880 \end_inset
21881
21882  vs.
21883  
21884 \begin_inset Flex Code
21885 status collapsed
21886
21887 \begin_layout Plain Layout
21888
21889 \change_inserted -712698321 1483871626
21890
21891 \backslash
21892 latexcmd
21893 \change_unchanged
21894
21895 \end_layout
21896
21897 \end_inset
21898
21899 ).
21900  These usually enforce up-casing of name prefixes (
21901 \emph on
21902 von Goethe
21903 \emph default
21904  
21905 \begin_inset Formula $\Rightarrow$
21906 \end_inset
21907
21908  
21909 \emph on
21910 Von Goethe
21911 \emph default
21912 ).
21913 \end_layout
21914
21915 \begin_layout Itemize
21916
21917 \change_inserted -712698321 1483871690
21918 Brackets 
21919 \begin_inset Flex Code
21920 status collapsed
21921
21922 \begin_layout Plain Layout
21923
21924 \change_inserted -712698321 1483871670
21925 []
21926 \change_unchanged
21927
21928 \end_layout
21929
21930 \end_inset
21931
21932  indicate the number of optional arguments (there can be 0–2).
21933 \end_layout
21934
21935 \begin_layout Itemize
21936
21937 \change_inserted -712698321 1483871747
21938 A star 
21939 \begin_inset Flex Code
21940 status collapsed
21941
21942 \begin_layout Plain Layout
21943
21944 \change_inserted -712698321 1483871698
21945 *
21946 \change_unchanged
21947
21948 \end_layout
21949
21950 \end_inset
21951
21952  indicates there is a starred version of the command (
21953 \begin_inset Flex Code
21954 status collapsed
21955
21956 \begin_layout Plain Layout
21957
21958 \change_inserted -712698321 1483871718
21959
21960 \backslash
21961 latexcmd*
21962 \change_unchanged
21963
21964 \end_layout
21965
21966 \end_inset
21967
21968  vs.
21969  
21970 \begin_inset Flex Code
21971 status collapsed
21972
21973 \begin_layout Plain Layout
21974
21975 \change_inserted -712698321 1483871724
21976
21977 \backslash
21978 latexcmd
21979 \change_unchanged
21980
21981 \end_layout
21982
21983 \end_inset
21984
21985 ).
21986  
21987 \end_layout
21988
21989 \begin_deeper
21990 \begin_layout Standard
21991
21992 \change_inserted -712698321 1483871864
21993 By default, the starred version means: Output all authors even if it should
21994  be shortened with 
21995 \begin_inset Quotes eld
21996 \end_inset
21997
21998 et al.
21999 \begin_inset Quotes erd
22000 \end_inset
22001
22002  due to the 
22003 \begin_inset Flex Code
22004 status collapsed
22005
22006 \begin_layout Plain Layout
22007
22008 \change_inserted -712698321 1483871835
22009 MaxCiteNames
22010 \change_unchanged
22011
22012 \end_layout
22013
22014 \end_inset
22015
22016  threshold.
22017 \end_layout
22018
22019 \begin_layout Standard
22020
22021 \change_inserted -712698321 1483872045
22022 If the star has a different meaning for a given command, it can be specified
22023  in angle brackets: 
22024 \begin_inset Flex Code
22025 status collapsed
22026
22027 \begin_layout Plain Layout
22028
22029 \change_inserted -712698321 1483871856
22030 <!_stardesc!_stardesctooltip>
22031 \change_unchanged
22032
22033 \end_layout
22034
22035 \end_inset
22036
22037 .
22038  Maximal two translatable macro keywords, marked by the prefix 
22039 \begin_inset Flex Code
22040 status collapsed
22041
22042 \begin_layout Plain Layout
22043
22044 \change_inserted -712698321 1483872014
22045 !_
22046 \change_unchanged
22047
22048 \end_layout
22049
22050 \end_inset
22051
22052 , can be given.
22053  The first points to the string that replaces the 
22054 \begin_inset Quotes eld
22055 \end_inset
22056
22057 Full aut&hor list
22058 \begin_inset Quotes erd
22059 \end_inset
22060
22061  checkbox label in the citation dialog, the second one to an optional tool
22062  tip for this checkbox.
22063  
22064 \end_layout
22065
22066 \begin_layout Standard
22067
22068 \change_inserted -712698321 1483872164
22069 Note that these two macros have to be defined in a 
22070 \begin_inset Flex Code
22071 status collapsed
22072
22073 \begin_layout Plain Layout
22074
22075 \change_inserted -712698321 1483871983
22076 CiteFormat
22077 \change_unchanged
22078
22079 \end_layout
22080
22081 \end_inset
22082
22083  (see next section), dropping the 
22084 \begin_inset Flex Code
22085 status collapsed
22086
22087 \begin_layout Plain Layout
22088
22089 \change_inserted -712698321 1483872023
22090 !
22091 \change_unchanged
22092
22093 \end_layout
22094
22095 \end_inset
22096
22097  from the prefix, like this: 
22098 \end_layout
22099
22100 \begin_layout LyX-Code
22101
22102 \change_inserted -712698321 1483872092
22103 _stardesc Sta&rred command label
22104 \end_layout
22105
22106 \begin_layout LyX-Code
22107
22108 \change_inserted -712698321 1484997832
22109 _stardesctooltip Tooltip for the starred command checkbox.
22110 \end_layout
22111
22112 \end_deeper
22113 \begin_layout Itemize
22114
22115 \change_inserted -712698321 1484997948
22116 A dollar sign 
22117 \begin_inset Flex Code
22118 status collapsed
22119
22120 \begin_layout Plain Layout
22121
22122 \change_inserted -712698321 1484997871
22123 $
22124 \change_unchanged
22125
22126 \end_layout
22127
22128 \end_inset
22129
22130  indicates that this command features 
22131 \begin_inset Quotes eld
22132 \end_inset
22133
22134 qualified citation lists
22135 \begin_inset Quotes erd
22136 \end_inset
22137
22138 .
22139  This is a 
22140 \family sans
22141 Biblatex
22142 \family default
22143 -specific feature for multi-reference citations where an individual pre-
22144  and postnote can be given to each reference in the list.
22145  Please refer to the 
22146 \family sans
22147 Biblatex
22148 \family default
22149  manual for details.
22150 \end_layout
22151
22152 \begin_layout Subsection
22153 \begin_inset CommandInset label
22154 LatexCommand label
22155 name "subsec:Citation-format-description"
22156
22157 \end_inset
22158
22159 Citation format description
22160 \end_layout
22161
22162 \begin_layout Standard
22163 The 
22164 \begin_inset Flex Code
22165 status collapsed
22166
22167 \begin_layout Plain Layout
22168 CiteFormat
22169 \end_layout
22170
22171 \end_inset
22172
22173  blocks are used to describe how bibliographic information should be displayed,
22174  both within \SpecialChar LyX
22175  itself (in the citation dialog and in tooltips, for example)
22176  and in XHTML output.
22177  Such a block might look like this:
22178 \end_layout
22179
22180 \begin_layout LyX-Code
22181 CiteFormat
22182 \end_layout
22183
22184 \begin_layout LyX-Code
22185  article ...
22186 \end_layout
22187
22188 \begin_layout LyX-Code
22189  book ...
22190 \end_layout
22191
22192 \begin_layout LyX-Code
22193 End
22194 \change_inserted -712698321 1483867197
22195
22196 \end_layout
22197
22198 \begin_layout Standard
22199
22200 \change_inserted -712698321 1483867200
22201 or
22202 \end_layout
22203
22204 \begin_layout LyX-Code
22205
22206 \change_inserted -712698321 1483867195
22207 CiteFormat
22208 \end_layout
22209
22210 \begin_layout LyX-Code
22211
22212 \change_inserted -712698321 1483867204
22213  cite ...
22214 \end_layout
22215
22216 \begin_layout LyX-Code
22217
22218 \change_inserted -712698321 1483867359
22219  citet*[][] ...
22220 \end_layout
22221
22222 \begin_layout LyX-Code
22223
22224 \change_inserted -712698321 1483867195
22225 End
22226 \change_unchanged
22227
22228 \end_layout
22229
22230 \begin_layout Standard
22231
22232 \change_inserted -712698321 1483867269
22233 In the first case, 
22234 \change_deleted -712698321 1483867270
22235 T
22236 \change_inserted -712698321 1483867270
22237 t
22238 \change_unchanged
22239 he individual lines define how the bibliographic information associated
22240  with an article or book, respectively, is to be displayed, and such a definitio
22241 n can be given for any 
22242 \change_deleted -712698321 1483867550
22243 `
22244 \change_inserted -712698321 1483867550
22245
22246 \begin_inset Quotes els
22247 \end_inset
22248
22249
22250 \change_unchanged
22251 entry type
22252 \change_deleted -712698321 1483867552
22253 '
22254 \change_inserted -712698321 1483867552
22255
22256 \begin_inset Quotes ers
22257 \end_inset
22258
22259
22260 \change_unchanged
22261  that might be present in a Bib\SpecialChar TeX
22262  file.
22263  \SpecialChar LyX
22264  defines a default format in the source code that will be used if no specific
22265  definition has been given.
22266  \SpecialChar LyX
22267  predefines several formats in the file 
22268 \begin_inset Flex Code
22269 status collapsed
22270
22271 \begin_layout Plain Layout
22272 stdciteformats.inc
22273 \end_layout
22274
22275 \end_inset
22276
22277 , which is included in most of \SpecialChar LyX
22278 's document classes.
22279 \change_inserted -712698321 1483867288
22280
22281 \end_layout
22282
22283 \begin_layout Standard
22284
22285 \change_inserted -712698321 1483875512
22286 In the second case, the lines define how a specific citation command (in
22287  the example 
22288 \begin_inset Flex Code
22289 status collapsed
22290
22291 \begin_layout Plain Layout
22292
22293 \change_inserted -712698321 1483867674
22294
22295 \backslash
22296 cite
22297 \change_unchanged
22298
22299 \end_layout
22300
22301 \end_inset
22302
22303
22304 \begin_inset Flex Code
22305 status collapsed
22306
22307 \begin_layout Plain Layout
22308
22309 \change_inserted -712698321 1483867679
22310
22311 \backslash
22312 citet
22313 \change_unchanged
22314
22315 \end_layout
22316
22317 \end_inset
22318
22319 ) is to be displayed on the citation inset label, in the citation dialog,
22320  menu or XHTML output.
22321  \SpecialChar LyX
22322  defines such formats for the citation style variants it supports via 
22323 \family sans
22324 Document\SpecialChar menuseparator
22325 Setting\SpecialChar menuseparator
22326 Bibliography\SpecialChar ldots
22327
22328 \family default
22329  in specific 
22330 \begin_inset Flex Code
22331 status collapsed
22332
22333 \begin_layout Plain Layout
22334
22335 \change_inserted -712698321 1483875503
22336 *.citeengine
22337 \end_layout
22338
22339 \end_inset
22340
22341  files that are shipped with \SpecialChar LyX
22342  (see 
22343 \begin_inset CommandInset ref
22344 LatexCommand ref
22345 reference "subsec:Cite-Engine-Files"
22346 plural "false"
22347 caps "false"
22348 noprefix "false"
22349
22350 \end_inset
22351
22352 ).
22353 \change_unchanged
22354
22355 \end_layout
22356
22357 \begin_layout Standard
22358 The definitions use a simple language that allows Bib\SpecialChar TeX
22359  keys to be replaced
22360  with their values.
22361  Keys should be enclosed in 
22362 \begin_inset Flex Code
22363 status collapsed
22364
22365 \begin_layout Plain Layout
22366 %
22367 \end_layout
22368
22369 \end_inset
22370
22371  signs, e.g.: 
22372 \begin_inset Flex Code
22373 status collapsed
22374
22375 \begin_layout Plain Layout
22376 %author%
22377 \end_layout
22378
22379 \end_inset
22380
22381 .
22382  So a simple definition might look like this:
22383 \end_layout
22384
22385 \begin_layout LyX-Code
22386 misc %author%, 
22387 \begin_inset Quotes eld
22388 \end_inset
22389
22390 %title%
22391 \begin_inset Quotes erd
22392 \end_inset
22393
22394 .
22395 \end_layout
22396
22397 \begin_layout Standard
22398 This would print the author, followed by a comma, followed by the title,
22399  in quotes, followed by a period.
22400 \end_layout
22401
22402 \begin_layout Standard
22403 Of course, sometimes you may want to print a key only if it exists.
22404  This can be done by using a conditional construction, such as: 
22405 \begin_inset Flex Code
22406 status collapsed
22407
22408 \begin_layout Plain Layout
22409 {%volume%[[vol.
22410 \begin_inset space ~
22411 \end_inset
22412
22413 %volume%]]}
22414 \end_layout
22415
22416 \end_inset
22417
22418 .
22419  This says: If the 
22420 \begin_inset Flex Code
22421 status collapsed
22422
22423 \begin_layout Plain Layout
22424 volume
22425 \end_layout
22426
22427 \end_inset
22428
22429  key exists, then print 
22430 \begin_inset Quotes eld
22431 \end_inset
22432
22433 vol.
22434 \begin_inset space ~
22435 \end_inset
22436
22437
22438 \begin_inset Quotes erd
22439 \end_inset
22440
22441  followed by the volume key.
22442  It is also possible to have an else clause in the conditional, such as:
22443 \begin_inset Newline newline
22444 \end_inset
22445
22446
22447 \begin_inset Flex Code
22448 status collapsed
22449
22450 \begin_layout Plain Layout
22451 {%author%[[%author%]][[%editor%, ed.]]}
22452 \end_layout
22453
22454 \end_inset
22455
22456 .
22457 \begin_inset Newline newline
22458 \end_inset
22459
22460 Here, the 
22461 \begin_inset Flex Code
22462 status collapsed
22463
22464 \begin_layout Plain Layout
22465 author
22466 \end_layout
22467
22468 \end_inset
22469
22470  key is printed if it exists; otherwise, the editor key is printed, followed
22471  by 
22472 \begin_inset Quotes eld
22473 \end_inset
22474
22475 ,
22476 \begin_inset space ~
22477 \end_inset
22478
22479 ed.
22480 \begin_inset Quotes erd
22481 \end_inset
22482
22483  Note that the key is again enclosed in 
22484 \begin_inset Flex Code
22485 status collapsed
22486
22487 \begin_layout Plain Layout
22488 %
22489 \end_layout
22490
22491 \end_inset
22492
22493  signs; the entire conditional is enclosed in braces; and the if and else
22494  clauses are enclosed in double brackets, 
22495 \begin_inset Quotes eld
22496 \end_inset
22497
22498
22499 \begin_inset Flex Code
22500 status collapsed
22501
22502 \begin_layout Plain Layout
22503 [[
22504 \end_layout
22505
22506 \end_inset
22507
22508
22509 \begin_inset Quotes eld
22510 \end_inset
22511
22512  and 
22513 \begin_inset Quotes eld
22514 \end_inset
22515
22516
22517 \begin_inset Flex Code
22518 status collapsed
22519
22520 \begin_layout Plain Layout
22521 ]]
22522 \end_layout
22523
22524 \end_inset
22525
22526
22527 \begin_inset Quotes erd
22528 \end_inset
22529
22530 .
22531  There must be no space between any of these.
22532 \change_inserted -712698321 1483867855
22533
22534 \end_layout
22535
22536 \begin_layout Standard
22537
22538 \change_inserted -712698321 1483867910
22539 Next to the entry keys, there are some special keys that can be used for
22540  these conditionals:
22541 \end_layout
22542
22543 \begin_layout Itemize
22544
22545 \change_inserted -712698321 1483868049
22546 \begin_inset Flex Code
22547 status collapsed
22548
22549 \begin_layout Plain Layout
22550
22551 \change_inserted -712698321 1483867962
22552 {%dialog%[[true]][[false]]}
22553 \change_unchanged
22554
22555 \end_layout
22556
22557 \end_inset
22558
22559 : process the 
22560 \begin_inset Quotes eld
22561 \end_inset
22562
22563 true
22564 \begin_inset Quotes erd
22565 \end_inset
22566
22567  part for dialogs and menus, the 
22568 \begin_inset Quotes eld
22569 \end_inset
22570
22571 false
22572 \begin_inset Quotes erd
22573 \end_inset
22574
22575  part for other contexts (workarea, export)
22576 \end_layout
22577
22578 \begin_layout Itemize
22579
22580 \change_inserted -712698321 1483868068
22581 \begin_inset Flex Code
22582 status collapsed
22583
22584 \begin_layout Plain Layout
22585
22586 \change_inserted -712698321 1483868052
22587 {%export%[[true]][[false]]}
22588 \end_layout
22589
22590 \end_inset
22591
22592 : process the 
22593 \begin_inset Quotes eld
22594 \end_inset
22595
22596 true
22597 \begin_inset Quotes erd
22598 \end_inset
22599
22600  part for export and menus, the 
22601 \begin_inset Quotes eld
22602 \end_inset
22603
22604 false
22605 \begin_inset Quotes erd
22606 \end_inset
22607
22608  part for other contexts (workarea, dialog)
22609 \end_layout
22610
22611 \begin_layout Itemize
22612
22613 \change_inserted -712698321 1483868138
22614 \begin_inset Flex Code
22615 status collapsed
22616
22617 \begin_layout Plain Layout
22618
22619 \change_inserted -712698321 1483868076
22620 {%next%[[true]]}
22621 \end_layout
22622
22623 \end_inset
22624
22625 : process the 
22626 \begin_inset Quotes eld
22627 \end_inset
22628
22629 true
22630 \begin_inset Quotes erd
22631 \end_inset
22632
22633  part if another item follows (e.
22634 \begin_inset space \thinspace{}
22635 \end_inset
22636
22637 g., in a citation with multiple keys)
22638 \end_layout
22639
22640 \begin_layout Itemize
22641
22642 \change_inserted -712698321 1483868174
22643 \begin_inset Flex Code
22644 status collapsed
22645
22646 \begin_layout Plain Layout
22647
22648 \change_inserted -712698321 1483868144
22649 {%second%[[true]][[false]]}
22650 \end_layout
22651
22652 \end_inset
22653
22654 : process the 
22655 \begin_inset Quotes eld
22656 \end_inset
22657
22658 true
22659 \begin_inset Quotes erd
22660 \end_inset
22661
22662  if this is the second of multiple items, else the 
22663 \begin_inset Quotes eld
22664 \end_inset
22665
22666 false
22667 \begin_inset Quotes erd
22668 \end_inset
22669
22670  part
22671 \end_layout
22672
22673 \begin_layout Itemize
22674
22675 \change_inserted -712698321 1483868321
22676 \begin_inset Flex Code
22677 status collapsed
22678
22679 \begin_layout Plain Layout
22680
22681 \change_inserted -712698321 1483868259
22682 {%ifstar%[[true]][[false]]}
22683 \end_layout
22684
22685 \end_inset
22686
22687 : process the 
22688 \begin_inset Quotes eld
22689 \end_inset
22690
22691 true
22692 \begin_inset Quotes erd
22693 \end_inset
22694
22695  part for starred citation commands (such as 
22696 \begin_inset Flex Code
22697 status collapsed
22698
22699 \begin_layout Plain Layout
22700
22701 \change_inserted -712698321 1483868310
22702
22703 \backslash
22704 cite*
22705 \change_unchanged
22706
22707 \end_layout
22708
22709 \end_inset
22710
22711 ), the false part for unstarred
22712 \end_layout
22713
22714 \begin_layout Itemize
22715
22716 \change_inserted -712698321 1483978485
22717 \begin_inset Flex Code
22718 status collapsed
22719
22720 \begin_layout Plain Layout
22721
22722 \change_inserted -712698321 1483868330
22723 {%ifentrytype:<type>%[[true]][[false]]}
22724 \end_layout
22725
22726 \end_inset
22727
22728 : process the 
22729 \begin_inset Quotes eld
22730 \end_inset
22731
22732 true
22733 \begin_inset Quotes erd
22734 \end_inset
22735
22736  if the current entry type matches 
22737 \begin_inset Flex Code
22738 status collapsed
22739
22740 \begin_layout Plain Layout
22741
22742 \change_inserted -712698321 1483868364
22743 <type>
22744 \change_unchanged
22745
22746 \end_layout
22747
22748 \end_inset
22749
22750 , else the false part (e.g., in a citation definition: 
22751 \begin_inset Flex Code
22752 status collapsed
22753
22754 \begin_layout Plain Layout
22755
22756 \change_inserted -712698321 1483868420
22757 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22758 \change_unchanged
22759
22760 \end_layout
22761
22762 \end_inset
22763
22764 )
22765 \end_layout
22766
22767 \begin_layout Itemize
22768
22769 \change_inserted -712698321 1484997600
22770 \begin_inset Flex Code
22771 status collapsed
22772
22773 \begin_layout Plain Layout
22774
22775 \change_inserted -712698321 1483978499
22776 {%ifmultiple:<authortype>%[[true]][[false]]}
22777 \end_layout
22778
22779 \end_inset
22780
22781 : process the 
22782 \begin_inset Quotes eld
22783 \end_inset
22784
22785 true
22786 \begin_inset Quotes erd
22787 \end_inset
22788
22789  if the current author type (author, editor etc.) has multiple authors, else
22790  the false part (e.g., in a bibliography definition: 
22791 \begin_inset Flex Code
22792 status collapsed
22793
22794 \begin_layout Plain Layout
22795
22796 \change_inserted -712698321 1483978571
22797 {%ifmultiple:editor%[[eds.]][[ed.]]}
22798 \end_layout
22799
22800 \end_inset
22801
22802 )
22803 \end_layout
22804
22805 \begin_layout Itemize
22806
22807 \change_inserted -712698321 1484997681
22808 \begin_inset Flex Code
22809 status collapsed
22810
22811 \begin_layout Plain Layout
22812
22813 \change_inserted -712698321 1484997608
22814 {%ifqualified%[[true]][[false]]}
22815 \end_layout
22816
22817 \end_inset
22818
22819 : process the 
22820 \begin_inset Quotes eld
22821 \end_inset
22822
22823 true
22824 \begin_inset Quotes erd
22825 \end_inset
22826
22827  part if the current citation is a qualified citation list (a specific 
22828 \family sans
22829 Biblatex
22830 \family default
22831  format for multi-reference citations), the false part if this is not the
22832  case.
22833 \change_unchanged
22834
22835 \end_layout
22836
22837 \begin_layout Standard
22838
22839 \change_inserted -712698321 1483978958
22840 We said that 
22841 \begin_inset Flex Code
22842 status collapsed
22843
22844 \begin_layout Plain Layout
22845
22846 \change_inserted -712698321 1483978693
22847 %author%
22848 \end_layout
22849
22850 \end_inset
22851
22852  prints the author key as it is recorded in the bibliography file.
22853  This might not be what you want, since it will result in a string such
22854  as 
22855 \begin_inset Quotes eld
22856 \end_inset
22857
22858 Miller, Peter and Smith, Mary and White, Jane
22859 \begin_inset Quotes erd
22860 \end_inset
22861
22862  (since 
22863 \begin_inset Quotes eld
22864 \end_inset
22865
22866 and
22867 \begin_inset Quotes erd
22868 \end_inset
22869
22870  is used by Bib\SpecialChar TeX
22871  to delimit authors).
22872  \SpecialChar LyX
22873  therefore provides some methods to get properly formatted name lists (which
22874  will also get translated).
22875  The following keys are provided:
22876 \end_layout
22877
22878 \begin_layout Enumerate
22879
22880 \change_inserted -712698321 1483979807
22881 For name lists with pre- and surname, suitable for the main authors/editors
22882  of a bibliography item.
22883  The 
22884 \begin_inset Flex Code
22885 status collapsed
22886
22887 \begin_layout Plain Layout
22888
22889 \change_inserted -712698321 1483979800
22890 <nametype>
22891 \change_unchanged
22892
22893 \end_layout
22894
22895 \end_inset
22896
22897  part denotes the kind of list that is requested (e.g.
22898  
22899 \begin_inset Flex Code
22900 status collapsed
22901
22902 \begin_layout Plain Layout
22903
22904 \change_inserted -712698321 1483979807
22905 <nametype:author>
22906 \change_unchanged
22907
22908 \end_layout
22909
22910 \end_inset
22911
22912 ):
22913 \end_layout
22914
22915 \begin_deeper
22916 \begin_layout Itemize
22917
22918 \change_inserted -712698321 1483979186
22919 \begin_inset Flex Code
22920 status collapsed
22921
22922 \begin_layout Plain Layout
22923
22924 \change_inserted -712698321 1483979743
22925 %abbrvnames:<nametype>%
22926 \change_unchanged
22927
22928 \end_layout
22929
22930 \end_inset
22931
22932 : Provides a name list which is abbreviated (with 
22933 \begin_inset Quotes eld
22934 \end_inset
22935
22936 et al.
22937 \begin_inset Quotes erd
22938 \end_inset
22939
22940 ) when 
22941 \begin_inset Flex Code
22942 status collapsed
22943
22944 \begin_layout Plain Layout
22945
22946 \change_inserted -712698321 1483979186
22947 MaxCiteNames
22948 \change_unchanged
22949
22950 \end_layout
22951
22952 \end_inset
22953
22954  is reached.
22955 \end_layout
22956
22957 \begin_layout Itemize
22958
22959 \change_inserted -712698321 1483979527
22960 \begin_inset Flex Code
22961 status collapsed
22962
22963 \begin_layout Plain Layout
22964
22965 \change_inserted -712698321 1483979748
22966 %fullnames:<nametype>%
22967 \change_unchanged
22968
22969 \end_layout
22970
22971 \end_inset
22972
22973 : Provides a full name list (never abbreviated with 
22974 \begin_inset Quotes eld
22975 \end_inset
22976
22977 et al.
22978 \begin_inset Quotes erd
22979 \end_inset
22980
22981 ).
22982 \end_layout
22983
22984 \begin_layout Itemize
22985
22986 \change_inserted -712698321 1483979553
22987 \begin_inset Flex Code
22988 status collapsed
22989
22990 \begin_layout Plain Layout
22991
22992 \change_inserted -712698321 1483980138
22993 %forceabbrvnames:<nametype>%
22994 \change_unchanged
22995
22996 \end_layout
22997
22998 \end_inset
22999
23000 : Provides a name list which is always abbreviated (with 
23001 \begin_inset Quotes eld
23002 \end_inset
23003
23004 et al.
23005 \begin_inset Quotes erd
23006 \end_inset
23007
23008 ) irrespective of 
23009 \begin_inset Flex Code
23010 status collapsed
23011
23012 \begin_layout Plain Layout
23013
23014 \change_inserted -712698321 1483979535
23015 MaxCiteNames
23016 \end_layout
23017
23018 \end_inset
23019
23020 .
23021 \change_unchanged
23022
23023 \end_layout
23024
23025 \end_deeper
23026 \begin_layout Enumerate
23027
23028 \change_inserted -712698321 1483979413
23029 Alternative name lists with pre- and surname, if the order of pre- and surname
23030  inside the bibliography item differs (as in: 
23031 \begin_inset Quotes eld
23032 \end_inset
23033
23034 Miller, John: Some text, in: Mary Smith, ed.: A volume
23035 \begin_inset Quotes erd
23036 \end_inset
23037
23038 ):
23039 \change_unchanged
23040
23041 \end_layout
23042
23043 \begin_deeper
23044 \begin_layout Itemize
23045
23046 \change_inserted -712698321 1483979565
23047 \begin_inset Flex Code
23048 status collapsed
23049
23050 \begin_layout Plain Layout
23051
23052 \change_inserted -712698321 1483979751
23053 %abbrvbynames:<nametype>%
23054 \change_unchanged
23055
23056 \end_layout
23057
23058 \end_inset
23059
23060 : Provides a name list which is abbreviated (with 
23061 \begin_inset Quotes eld
23062 \end_inset
23063
23064 et al.
23065 \begin_inset Quotes erd
23066 \end_inset
23067
23068 ) when 
23069 \begin_inset Flex Code
23070 status collapsed
23071
23072 \begin_layout Plain Layout
23073
23074 \change_inserted -712698321 1483979565
23075 MaxCiteNames
23076 \end_layout
23077
23078 \end_inset
23079
23080  is reached.
23081 \change_unchanged
23082
23083 \end_layout
23084
23085 \begin_layout Itemize
23086
23087 \change_inserted -712698321 1483979570
23088 \begin_inset Flex Code
23089 status collapsed
23090
23091 \begin_layout Plain Layout
23092
23093 \change_inserted -712698321 1483979753
23094 %fullbynames:<nametype>%
23095 \change_unchanged
23096
23097 \end_layout
23098
23099 \end_inset
23100
23101 : Provides a full name list (never abbreviated with 
23102 \begin_inset Quotes eld
23103 \end_inset
23104
23105 et al.
23106 \begin_inset Quotes erd
23107 \end_inset
23108
23109 ).
23110 \change_unchanged
23111
23112 \end_layout
23113
23114 \begin_layout Itemize
23115
23116 \change_inserted -712698321 1483979576
23117 \begin_inset Flex Code
23118 status collapsed
23119
23120 \begin_layout Plain Layout
23121
23122 \change_inserted -712698321 1483980143
23123 %forceabbrvbynames:<nametype>%
23124 \change_unchanged
23125
23126 \end_layout
23127
23128 \end_inset
23129
23130 : Provides a name list which is always abbreviated (with 
23131 \begin_inset Quotes eld
23132 \end_inset
23133
23134 et al.
23135 \begin_inset Quotes erd
23136 \end_inset
23137
23138 ) irrespective of 
23139 \begin_inset Flex Code
23140 status collapsed
23141
23142 \begin_layout Plain Layout
23143
23144 \change_inserted -712698321 1483979574
23145 MaxCiteNames
23146 \end_layout
23147
23148 \end_inset
23149
23150 .
23151 \end_layout
23152
23153 \end_deeper
23154 \begin_layout Enumerate
23155
23156 \change_inserted -712698321 1483980219
23157 And finally name lists which consist of family names only, as used in author-yea
23158 r citation labels.
23159  these do not take a 
23160 \begin_inset Flex Code
23161 status collapsed
23162
23163 \begin_layout Plain Layout
23164
23165 \change_inserted -712698321 1483979871
23166 <nametype>
23167 \change_unchanged
23168
23169 \end_layout
23170
23171 \end_inset
23172
23173  part, but always return either an author list or, if this does not exist,
23174  an editor list (as common in author-year labels):
23175 \change_unchanged
23176
23177 \end_layout
23178
23179 \begin_deeper
23180 \begin_layout Itemize
23181
23182 \change_inserted -712698321 1483979715
23183 \begin_inset Flex Code
23184 status collapsed
23185
23186 \begin_layout Plain Layout
23187
23188 \change_inserted -712698321 1483979700
23189 %abbrvciteauthor%
23190 \change_unchanged
23191
23192 \end_layout
23193
23194 \end_inset
23195
23196 : Provides a name list which is abbreviated (with 
23197 \begin_inset Quotes eld
23198 \end_inset
23199
23200 et al.
23201 \begin_inset Quotes erd
23202 \end_inset
23203
23204 ) when 
23205 \begin_inset Flex Code
23206 status collapsed
23207
23208 \begin_layout Plain Layout
23209
23210 \change_inserted -712698321 1483979715
23211 MaxCiteNames
23212 \end_layout
23213
23214 \end_inset
23215
23216  is reached.
23217 \change_unchanged
23218
23219 \end_layout
23220
23221 \begin_layout Itemize
23222
23223 \change_inserted -712698321 1483979721
23224 \begin_inset Flex Code
23225 status collapsed
23226
23227 \begin_layout Plain Layout
23228
23229 \change_inserted -712698321 1483979703
23230 %fullciteauthor%
23231 \change_unchanged
23232
23233 \end_layout
23234
23235 \end_inset
23236
23237 : Provides a full name list (never abbreviated with 
23238 \begin_inset Quotes eld
23239 \end_inset
23240
23241 et al.
23242 \begin_inset Quotes erd
23243 \end_inset
23244
23245 ).
23246 \change_unchanged
23247
23248 \end_layout
23249
23250 \begin_layout Itemize
23251
23252 \change_inserted -712698321 1483980272
23253 \begin_inset Flex Code
23254 status collapsed
23255
23256 \begin_layout Plain Layout
23257
23258 \change_inserted -712698321 1483979705
23259 %forceabbrvciteauthor%
23260 \change_unchanged
23261
23262 \end_layout
23263
23264 \end_inset
23265
23266 : Provides a name list which is always abbreviated (with 
23267 \begin_inset Quotes eld
23268 \end_inset
23269
23270 et al.
23271 \begin_inset Quotes erd
23272 \end_inset
23273
23274 ) irrespective of 
23275 \begin_inset Flex Code
23276 status collapsed
23277
23278 \begin_layout Plain Layout
23279
23280 \change_inserted -712698321 1483979726
23281 MaxCiteNames
23282 \end_layout
23283
23284 \end_inset
23285
23286 .
23287 \end_layout
23288
23289 \end_deeper
23290 \begin_layout Standard
23291
23292 \change_inserted -712698321 1483980314
23293 The order of pre- and surname in the former two lists can be adjusted by
23294  these macros:
23295 \end_layout
23296
23297 \begin_layout Itemize
23298
23299 \change_inserted -712698321 1483980535
23300 \begin_inset Flex Code
23301 status collapsed
23302
23303 \begin_layout Plain Layout
23304
23305 \change_inserted -712698321 1483980354
23306 !firstnameform %surname%, %prename%
23307 \change_unchanged
23308
23309 \end_layout
23310
23311 \end_inset
23312
23313  (first author in lists of type 1)
23314 \end_layout
23315
23316 \begin_layout Itemize
23317
23318 \change_inserted -712698321 1483980557
23319 \begin_inset Flex Code
23320 status collapsed
23321
23322 \begin_layout Plain Layout
23323
23324 \change_inserted -712698321 1483980367
23325 !othernameform %surname%, %prename%
23326 \change_unchanged
23327
23328 \end_layout
23329
23330 \end_inset
23331
23332  (other authors in lists of type 1)
23333 \change_unchanged
23334
23335 \end_layout
23336
23337 \begin_layout Itemize
23338
23339 \change_inserted -712698321 1483980550
23340 \begin_inset Flex Code
23341 status collapsed
23342
23343 \begin_layout Plain Layout
23344
23345 \change_inserted -712698321 1483980373
23346 !firstbynameform %prename% %surname%
23347 \change_unchanged
23348
23349 \end_layout
23350
23351 \end_inset
23352
23353  (first author in lists of type 2)
23354 \end_layout
23355
23356 \begin_layout Itemize
23357
23358 \change_inserted -712698321 1483980570
23359 \begin_inset Flex Code
23360 status collapsed
23361
23362 \begin_layout Plain Layout
23363
23364 \change_inserted -712698321 1483980381
23365 !otherbynameform %prename% %surname%
23366 \change_unchanged
23367
23368 \end_layout
23369
23370 \end_inset
23371
23372  (other authors in lists of type 2)
23373 \end_layout
23374
23375 \begin_layout Standard
23376
23377 \change_inserted -712698321 1483980643
23378 This allows you to configure namings like 
23379 \begin_inset Quotes eld
23380 \end_inset
23381
23382 Miller, Peter and Mary Smith: \SpecialChar ldots
23383 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23384
23385 \begin_inset Quotes erd
23386 \end_inset
23387
23388 .
23389 \change_unchanged
23390
23391 \end_layout
23392
23393 \begin_layout Standard
23394 There is one other piece of syntax available in definitions, which looks
23395  like this: 
23396 \begin_inset Flex Code
23397 status collapsed
23398
23399 \begin_layout Plain Layout
23400 {!<i>!}
23401 \end_layout
23402
23403 \end_inset
23404
23405 .
23406  This defines a piece of formatting information that is to be used when
23407  creating 
23408 \begin_inset Quotes eld
23409 \end_inset
23410
23411 rich text
23412 \begin_inset Quotes erd
23413 \end_inset
23414
23415 .
23416  Obviously, we do not want to output HTML tags when writing plain text,
23417  so they should be wrapped in 
23418 \begin_inset Quotes eld
23419 \end_inset
23420
23421 {!
23422 \begin_inset Quotes erd
23423 \end_inset
23424
23425  and 
23426 \begin_inset Quotes eld
23427 \end_inset
23428
23429 !}
23430 \begin_inset Quotes erd
23431 \end_inset
23432
23433 .
23434 \end_layout
23435
23436 \begin_layout Standard
23437 Two special sorts of definitions are also possible in a 
23438 \begin_inset Flex Code
23439 status collapsed
23440
23441 \begin_layout Plain Layout
23442 CiteFormat
23443 \end_layout
23444
23445 \end_inset
23446
23447  block.
23448  An example of the first would be:
23449 \end_layout
23450
23451 \begin_layout LyX-Code
23452 !quotetitle 
23453 \begin_inset Quotes eld
23454 \end_inset
23455
23456 %title%
23457 \begin_inset Quotes erd
23458 \end_inset
23459
23460
23461 \end_layout
23462
23463 \begin_layout Standard
23464 This is an abbreviation, or macro, and it can be used by treating it as
23465  if it were a key: 
23466 \begin_inset Flex Code
23467 status collapsed
23468
23469 \begin_layout Plain Layout
23470 %!quotetitle%
23471 \end_layout
23472
23473 \end_inset
23474
23475 .
23476  \SpecialChar LyX
23477  will treat 
23478 \begin_inset Flex Code
23479 status collapsed
23480
23481 \begin_layout Plain Layout
23482 %!quotetitle%
23483 \end_layout
23484
23485 \end_inset
23486
23487  exactly as it would treat its definition.
23488  So, let us issue the obvious 
23489 \emph on
23490 warning
23491 \emph default
23492 .
23493  Do not do this:
23494 \end_layout
23495
23496 \begin_layout LyX-Code
23497 !funfun %funfun%
23498 \end_layout
23499
23500 \begin_layout Standard
23501 or anything like it.
23502  \SpecialChar LyX
23503  shouldn't go into an infinite loop, but it may go into a long one before
23504  it gives up.
23505 \end_layout
23506
23507 \begin_layout Standard
23508 The second sort of special definition might look like this:
23509 \end_layout
23510
23511 \begin_layout LyX-Code
23512 _pptext pp.
23513 \end_layout
23514
23515 \begin_layout Standard
23516 This defines a translatable piece of text, which allows relevant parts of
23517  the bibliography 
23518 \change_inserted -712698321 1483868477
23519 or citation 
23520 \change_unchanged
23521 to be translated.
23522  It can be included in a definition by treating it as a key: 
23523 \begin_inset Flex Code
23524 status collapsed
23525
23526 \begin_layout Plain Layout
23527 %_pptext%
23528 \end_layout
23529
23530 \end_inset
23531
23532 .
23533  Several of these are predefined in 
23534 \begin_inset Flex Code
23535 status collapsed
23536
23537 \begin_layout Plain Layout
23538 stdciteformats.inc
23539 \end_layout
23540
23541 \end_inset
23542
23543
23544 \change_inserted -712698321 1483868503
23545  and the diverse 
23546 \begin_inset Flex Code
23547 status collapsed
23548
23549 \begin_layout Plain Layout
23550
23551 \change_inserted -712698321 1483868503
23552 *.citeengine
23553 \change_unchanged
23554
23555 \end_layout
23556
23557 \end_inset
23558
23559  files
23560 \change_unchanged
23561 .
23562  Note that these are not macros, in the sense just defined.
23563  They will not be expanded.
23564 \end_layout
23565
23566 \begin_layout Standard
23567 So here then is an example that use all these features:
23568 \begin_inset VSpace defskip
23569 \end_inset
23570
23571
23572 \end_layout
23573
23574 \begin_layout Standard
23575 \noindent
23576
23577 \family typewriter
23578 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
23579 \end_layout
23580
23581 \begin_layout Standard
23582 \begin_inset VSpace defskip
23583 \end_inset
23584
23585 This defines a macro that prints the author, followed by a comma, if the
23586  
23587 \begin_inset Flex Code
23588 status collapsed
23589
23590 \begin_layout Plain Layout
23591 author
23592 \end_layout
23593
23594 \end_inset
23595
23596  key is defined, or else prints the name of the editor, followed by the
23597  
23598 \begin_inset Flex Code
23599 status collapsed
23600
23601 \begin_layout Plain Layout
23602 _edtext
23603 \end_layout
23604
23605 \end_inset
23606
23607  or its translation (it is by default 
23608 \begin_inset Quotes eld
23609 \end_inset
23610
23611 ed.
23612 \begin_inset Quotes erd
23613 \end_inset
23614
23615 ), if the 
23616 \begin_inset Flex Code
23617 status collapsed
23618
23619 \begin_layout Plain Layout
23620 editor
23621 \end_layout
23622
23623 \end_inset
23624
23625  key is defined.
23626  Note that this is in fact defined in 
23627 \begin_inset Flex Code
23628 status collapsed
23629
23630 \begin_layout Plain Layout
23631 stdciteformats.inc
23632 \end_layout
23633
23634 \end_inset
23635
23636 , so you can use it in your own definitions, or re-definitions, if you load
23637  that file first.
23638 \end_layout
23639
23640 \begin_layout Section
23641 \begin_inset CommandInset label
23642 LatexCommand label
23643 name "sec:Tags-for-XHTML"
23644
23645 \end_inset
23646
23647 Tags for XHTML output
23648 \end_layout
23649
23650 \begin_layout Standard
23651 As with \SpecialChar LaTeX
23652  or DocBook, the format of \SpecialChar LyX
23653 's XHTML output is also controlled by
23654  layout information.
23655  In general, \SpecialChar LyX
23656  provides sensible defaults and, as mentioned earlier, it will
23657  even construct default CSS style rules from the other layout tags.
23658  For example, \SpecialChar LyX
23659  will attempt to use the information provided in the 
23660 \begin_inset Flex Code
23661 status collapsed
23662
23663 \begin_layout Plain Layout
23664 Font
23665 \end_layout
23666
23667 \end_inset
23668
23669  declaration for the Chapter style to write CSS that will appropriately
23670  format chapter headings.
23671 \end_layout
23672
23673 \begin_layout Standard
23674 In many cases, then, you may not have to do anything at all to get acceptable
23675  XHTML output for your own environments, custom insets, and so forth.
23676  But in some cases you will, and so \SpecialChar LyX
23677  provides a number of layout tags that
23678  can be used to customize the XHTML and CSS that are generated.
23679 \end_layout
23680
23681 \begin_layout Standard
23682 Note that there are two tags, 
23683 \begin_inset Flex Code
23684 status collapsed
23685
23686 \begin_layout Plain Layout
23687 HTMLPreamble
23688 \end_layout
23689
23690 \end_inset
23691
23692  and 
23693 \begin_inset Flex Code
23694 status collapsed
23695
23696 \begin_layout Plain Layout
23697 AddToHTMLPreamble
23698 \end_layout
23699
23700 \end_inset
23701
23702  that may appear outside style and inset declarations.
23703  See 
23704 \begin_inset CommandInset ref
23705 LatexCommand ref
23706 reference "subsec:General-text-class"
23707
23708 \end_inset
23709
23710  for details on these.
23711 \end_layout
23712
23713 \begin_layout Subsection
23714 \begin_inset CommandInset label
23715 LatexCommand label
23716 name "subsec:Paragraph-Style-XHTML"
23717
23718 \end_inset
23719
23720 Paragraph styles
23721 \end_layout
23722
23723 \begin_layout Standard
23724 The sort of XHTML \SpecialChar LyX
23725  outputs for a paragraph depends upon whether we are dealing
23726  with a normal paragraph, a command, or an environment, where this is itself
23727  determined by the contents of the corresponding 
23728 \begin_inset Flex Code
23729 status collapsed
23730
23731 \begin_layout Plain Layout
23732 \SpecialChar LaTeX
23733 Type
23734 \end_layout
23735
23736 \end_inset
23737
23738  tag.
23739  
23740 \end_layout
23741
23742 \begin_layout Standard
23743 For a command or normal paragraph, the output XHTML has the following form:
23744 \end_layout
23745
23746 \begin_layout LyX-Code
23747 <tag attr=
23748 \begin_inset Quotes erd
23749 \end_inset
23750
23751 value
23752 \begin_inset Quotes erd
23753 \end_inset
23754
23755 >
23756 \end_layout
23757
23758 \begin_layout LyX-Code
23759 <labeltag attr=
23760 \begin_inset Quotes erd
23761 \end_inset
23762
23763 value
23764 \begin_inset Quotes erd
23765 \end_inset
23766
23767 >Label</labeltag>
23768 \end_layout
23769
23770 \begin_layout LyX-Code
23771 Contents of the paragraph.
23772 \end_layout
23773
23774 \begin_layout LyX-Code
23775 </tag>
23776 \end_layout
23777
23778 \begin_layout Standard
23779 The label tags are of course omitted if the paragraph does not have a label.
23780 \end_layout
23781
23782 \begin_layout Standard
23783 For an environment that is not some sort of list, the XHTML takes this form:
23784 \end_layout
23785
23786 \begin_layout LyX-Code
23787 <tag attr=
23788 \begin_inset Quotes erd
23789 \end_inset
23790
23791 value
23792 \begin_inset Quotes erd
23793 \end_inset
23794
23795 >
23796 \end_layout
23797
23798 \begin_layout LyX-Code
23799 <itemtag attr=
23800 \begin_inset Quotes erd
23801 \end_inset
23802
23803 value
23804 \begin_inset Quotes erd
23805 \end_inset
23806
23807 ><labeltag attr=
23808 \begin_inset Quotes erd
23809 \end_inset
23810
23811 value
23812 \begin_inset Quotes erd
23813 \end_inset
23814
23815 >Environment Label</labeltag>First paragraph.</itemtag>
23816 \end_layout
23817
23818 \begin_layout LyX-Code
23819 <itemtag>Second paragraph.</itemtag>
23820 \end_layout
23821
23822 \begin_layout LyX-Code
23823 </tag>
23824 \end_layout
23825
23826 \begin_layout Standard
23827 Note that the label is output only for the first paragraph, as it should
23828  be for a theorem, for example.
23829  
23830 \end_layout
23831
23832 \begin_layout Standard
23833 For a list, we have one of these forms:
23834 \end_layout
23835
23836 \begin_layout LyX-Code
23837 <tag attr=
23838 \begin_inset Quotes erd
23839 \end_inset
23840
23841 value
23842 \begin_inset Quotes erd
23843 \end_inset
23844
23845 >
23846 \end_layout
23847
23848 \begin_layout LyX-Code
23849 <itemtag attr=
23850 \begin_inset Quotes erd
23851 \end_inset
23852
23853 value
23854 \begin_inset Quotes erd
23855 \end_inset
23856
23857 ><labeltag attr=
23858 \begin_inset Quotes erd
23859 \end_inset
23860
23861 value
23862 \begin_inset Quotes erd
23863 \end_inset
23864
23865 >List Label</labeltag>First item.</itemtag>
23866 \end_layout
23867
23868 \begin_layout LyX-Code
23869 <itemtag attr=
23870 \begin_inset Quotes erd
23871 \end_inset
23872
23873 value
23874 \begin_inset Quotes erd
23875 \end_inset
23876
23877 ><labeltag attr=
23878 \begin_inset Quotes erd
23879 \end_inset
23880
23881 value
23882 \begin_inset Quotes erd
23883 \end_inset
23884
23885 >List Label</labeltag>Second item.</itemtag>
23886 \end_layout
23887
23888 \begin_layout LyX-Code
23889 </tag>
23890 \end_layout
23891
23892 \begin_layout LyX-Code
23893
23894 \end_layout
23895
23896 \begin_layout LyX-Code
23897 <tag attr=
23898 \begin_inset Quotes erd
23899 \end_inset
23900
23901 value
23902 \begin_inset Quotes erd
23903 \end_inset
23904
23905 >
23906 \end_layout
23907
23908 \begin_layout LyX-Code
23909 <labeltag attr=
23910 \begin_inset Quotes erd
23911 \end_inset
23912
23913 value
23914 \begin_inset Quotes erd
23915 \end_inset
23916
23917 >List Label</labeltag><itemtag attr=
23918 \begin_inset Quotes erd
23919 \end_inset
23920
23921 value
23922 \begin_inset Quotes erd
23923 \end_inset
23924
23925 >First item.</itemtag>
23926 \end_layout
23927
23928 \begin_layout LyX-Code
23929 <labeltag attr=
23930 \begin_inset Quotes erd
23931 \end_inset
23932
23933 value
23934 \begin_inset Quotes erd
23935 \end_inset
23936
23937 >List Label</labeltag><itemtag attr=
23938 \begin_inset Quotes erd
23939 \end_inset
23940
23941 value
23942 \begin_inset Quotes erd
23943 \end_inset
23944
23945 >Second item.</itemtag>
23946 \end_layout
23947
23948 \begin_layout LyX-Code
23949 </tag>
23950 \end_layout
23951
23952 \begin_layout Standard
23953 Note the different orders of 
23954 \begin_inset Flex Code
23955 status collapsed
23956
23957 \begin_layout Plain Layout
23958 labeltag
23959 \end_layout
23960
23961 \end_inset
23962
23963  and 
23964 \begin_inset Flex Code
23965 status collapsed
23966
23967 \begin_layout Plain Layout
23968 itemtag
23969 \end_layout
23970
23971 \end_inset
23972
23973 .
23974  Which order we get depends upon the setting of 
23975 \begin_inset Flex Code
23976 status collapsed
23977
23978 \begin_layout Plain Layout
23979 HTMLLabelFirst
23980 \end_layout
23981
23982 \end_inset
23983
23984 : If 
23985 \begin_inset Flex Code
23986 status collapsed
23987
23988 \begin_layout Plain Layout
23989 HTMLLabelFirst
23990 \end_layout
23991
23992 \end_inset
23993
23994  is false (the default), you get the first of these, with the label within
23995  the item; if true, you get the second, with the label outside the item.
23996 \end_layout
23997
23998 \begin_layout Standard
23999 The specific tags and attributes output for each paragraph type can be controlle
24000 d by means of the layout tags we are about to describe.
24001  As mentioned earlier, however, \SpecialChar LyX
24002  uses sensible defaults for many of these,
24003  so you often may not need to do very much to get good XHTML output.
24004  Think of the available tags as there so you can tweak things to your liking.
24005 \end_layout
24006
24007 \begin_layout Description
24008 \begin_inset Flex Code
24009 status collapsed
24010
24011 \begin_layout Plain Layout
24012 HTMLAttr
24013 \end_layout
24014
24015 \end_inset
24016
24017  [
24018 \begin_inset Flex Code
24019 status collapsed
24020
24021 \begin_layout Plain Layout
24022 string
24023 \end_layout
24024
24025 \end_inset
24026
24027 ] Specifies attribute information to be output with the main tag.
24028  For example, 
24029 \begin_inset Quotes eld
24030 \end_inset
24031
24032
24033 \begin_inset Flex Code
24034 status collapsed
24035
24036 \begin_layout Plain Layout
24037 class=`mydiv'
24038 \end_layout
24039
24040 \end_inset
24041
24042
24043 \begin_inset Quotes erd
24044 \end_inset
24045
24046 .
24047  By default, \SpecialChar LyX
24048  will output 
24049 \begin_inset Quotes eld
24050 \end_inset
24051
24052
24053 \begin_inset Flex Code
24054 status collapsed
24055
24056 \begin_layout Plain Layout
24057 class=`layoutname'
24058 \end_layout
24059
24060 \end_inset
24061
24062
24063 \begin_inset Quotes erd
24064 \end_inset
24065
24066 , where 
24067 \begin_inset Flex Code
24068 status collapsed
24069
24070 \begin_layout Plain Layout
24071 layoutname
24072 \end_layout
24073
24074 \end_inset
24075
24076  is the \SpecialChar LyX
24077  name of the layout, made lowercase, for example: chapter.
24078  This should 
24079 \emph on
24080 not
24081 \emph default
24082  contain any style information.
24083  Use 
24084 \begin_inset Flex Code
24085 status collapsed
24086
24087 \begin_layout Plain Layout
24088 HTMLStyle
24089 \end_layout
24090
24091 \end_inset
24092
24093  for that purpose.
24094 \end_layout
24095
24096 \begin_layout Description
24097 \begin_inset Flex Code
24098 status collapsed
24099
24100 \begin_layout Plain Layout
24101 HTMLForceCSS
24102 \end_layout
24103
24104 \end_inset
24105
24106  [
24107 \begin_inset Flex Code
24108 status collapsed
24109
24110 \begin_layout Plain Layout
24111
24112 \emph on
24113 0
24114 \emph default
24115 ,1
24116 \end_layout
24117
24118 \end_inset
24119
24120 ] Whether to output the default CSS information \SpecialChar LyX
24121  generates for this layout,
24122  even if additional information is explicitly provided via 
24123 \begin_inset Flex Code
24124 status collapsed
24125
24126 \begin_layout Plain Layout
24127 HTMLStyle
24128 \end_layout
24129
24130 \end_inset
24131
24132 .
24133  Setting this to 
24134 \begin_inset Flex Code
24135 status collapsed
24136
24137 \begin_layout Plain Layout
24138 1
24139 \end_layout
24140
24141 \end_inset
24142
24143  allows you to alter or augment the generated CSS, rather than to override
24144  it completely.
24145  Default is 
24146 \begin_inset Flex Code
24147 status collapsed
24148
24149 \begin_layout Plain Layout
24150 0
24151 \end_layout
24152
24153 \end_inset
24154
24155 .
24156 \end_layout
24157
24158 \begin_layout Description
24159 \begin_inset Flex Code
24160 status collapsed
24161
24162 \begin_layout Plain Layout
24163 HTMLItem
24164 \end_layout
24165
24166 \end_inset
24167
24168  [
24169 \begin_inset Flex Code
24170 status collapsed
24171
24172 \begin_layout Plain Layout
24173 string
24174 \end_layout
24175
24176 \end_inset
24177
24178 ] The tag to be used for individual paragraphs of environments, replacing
24179  
24180 \begin_inset Flex Code
24181 status collapsed
24182
24183 \begin_layout Plain Layout
24184 itemtag
24185 \end_layout
24186
24187 \end_inset
24188
24189  in the examples above.
24190  Defaults to 
24191 \begin_inset Flex Code
24192 status collapsed
24193
24194 \begin_layout Plain Layout
24195 div
24196 \end_layout
24197
24198 \end_inset
24199
24200 .
24201 \end_layout
24202
24203 \begin_layout Description
24204 \begin_inset Flex Code
24205 status collapsed
24206
24207 \begin_layout Plain Layout
24208 HTMLItemAttr
24209 \end_layout
24210
24211 \end_inset
24212
24213  [
24214 \begin_inset Flex Code
24215 status collapsed
24216
24217 \begin_layout Plain Layout
24218 string
24219 \end_layout
24220
24221 \end_inset
24222
24223 ] Attributes for the item tag.
24224  Defaults to 
24225 \begin_inset Quotes eld
24226 \end_inset
24227
24228
24229 \begin_inset Flex Code
24230 status collapsed
24231
24232 \begin_layout Plain Layout
24233 class=`layoutname_item'
24234 \end_layout
24235
24236 \end_inset
24237
24238
24239 \begin_inset Quotes erd
24240 \end_inset
24241
24242 .
24243  This should 
24244 \emph on
24245 not
24246 \emph default
24247  contain any style information.
24248  Use 
24249 \begin_inset Flex Code
24250 status collapsed
24251
24252 \begin_layout Plain Layout
24253 HTMLStyle
24254 \end_layout
24255
24256 \end_inset
24257
24258  for that purpose.
24259 \end_layout
24260
24261 \begin_layout Description
24262 \begin_inset Flex Code
24263 status collapsed
24264
24265 \begin_layout Plain Layout
24266 HTMLLabel
24267 \end_layout
24268
24269 \end_inset
24270
24271  [
24272 \begin_inset Flex Code
24273 status collapsed
24274
24275 \begin_layout Plain Layout
24276 string
24277 \end_layout
24278
24279 \end_inset
24280
24281 ] The tag to be used for paragraph and item labels, replacing 
24282 \begin_inset Flex Code
24283 status collapsed
24284
24285 \begin_layout Plain Layout
24286 labeltag
24287 \end_layout
24288
24289 \end_inset
24290
24291  in the examples above.
24292  Defaults to 
24293 \begin_inset Flex Code
24294 status collapsed
24295
24296 \begin_layout Plain Layout
24297 span
24298 \end_layout
24299
24300 \end_inset
24301
24302 , unless 
24303 \begin_inset Flex Code
24304 status collapsed
24305
24306 \begin_layout Plain Layout
24307 LabelType
24308 \end_layout
24309
24310 \end_inset
24311
24312  is either 
24313 \begin_inset Flex Code
24314 status collapsed
24315
24316 \begin_layout Plain Layout
24317 Top_Environment
24318 \end_layout
24319
24320 \end_inset
24321
24322  or 
24323 \begin_inset Flex Code
24324 status collapsed
24325
24326 \begin_layout Plain Layout
24327 Centered_Top_Environment
24328 \end_layout
24329
24330 \end_inset
24331
24332 , in which case it defaults to 
24333 \begin_inset Flex Code
24334 status collapsed
24335
24336 \begin_layout Plain Layout
24337 div
24338 \end_layout
24339
24340 \end_inset
24341
24342 .
24343 \end_layout
24344
24345 \begin_layout Description
24346 \begin_inset Flex Code
24347 status collapsed
24348
24349 \begin_layout Plain Layout
24350 HTMLLabelAttr
24351 \end_layout
24352
24353 \end_inset
24354
24355  [
24356 \begin_inset Flex Code
24357 status collapsed
24358
24359 \begin_layout Plain Layout
24360 string
24361 \end_layout
24362
24363 \end_inset
24364
24365 ] Attributes for the label tag.
24366  Defaults to 
24367 \begin_inset Quotes eld
24368 \end_inset
24369
24370
24371 \begin_inset Flex Code
24372 status collapsed
24373
24374 \begin_layout Plain Layout
24375 class=`layoutname_label'
24376 \end_layout
24377
24378 \end_inset
24379
24380
24381 \begin_inset Quotes erd
24382 \end_inset
24383
24384 .
24385  This should 
24386 \emph on
24387 not
24388 \emph default
24389  contain any style information.
24390  Use 
24391 \begin_inset Flex Code
24392 status collapsed
24393
24394 \begin_layout Plain Layout
24395 HTMLStyle
24396 \end_layout
24397
24398 \end_inset
24399
24400  for that purpose.
24401 \end_layout
24402
24403 \begin_layout Description
24404 \begin_inset Flex Code
24405 status collapsed
24406
24407 \begin_layout Plain Layout
24408 HTMLLabelFirst
24409 \end_layout
24410
24411 \end_inset
24412
24413  [
24414 \begin_inset Flex Code
24415 status collapsed
24416
24417 \begin_layout Plain Layout
24418
24419 \emph on
24420 0
24421 \emph default
24422 ,1
24423 \end_layout
24424
24425 \end_inset
24426
24427 ] Meaningful only for list-like environments, this tag controls whether
24428  the label tag is output before or inside the item tag.
24429  This is used, for example, in the description environment, where we want
24430  `
24431 \begin_inset Flex Code
24432 status collapsed
24433
24434 \begin_layout Plain Layout
24435 <dt>\SpecialChar ldots
24436 </dt><dd>\SpecialChar ldots
24437 </dd>
24438 \end_layout
24439
24440 \end_inset
24441
24442 .
24443  Default is 
24444 \begin_inset Flex Code
24445 status collapsed
24446
24447 \begin_layout Plain Layout
24448 0
24449 \end_layout
24450
24451 \end_inset
24452
24453 : The label tag is output inside the item tag.
24454 \end_layout
24455
24456 \begin_layout Description
24457 \begin_inset Flex Code
24458 status collapsed
24459
24460 \begin_layout Plain Layout
24461 HTMLPreamble
24462 \end_layout
24463
24464 \end_inset
24465
24466  Information to be output in the 
24467 \begin_inset Flex Code
24468 status collapsed
24469
24470 \begin_layout Plain Layout
24471 <head>
24472 \end_layout
24473
24474 \end_inset
24475
24476  section when this style is used.
24477  This might, for example, be used to include a 
24478 \begin_inset Flex Code
24479 status collapsed
24480
24481 \begin_layout Plain Layout
24482 <script>
24483 \end_layout
24484
24485 \end_inset
24486
24487  block defining an 
24488 \begin_inset Flex Code
24489 status collapsed
24490
24491 \begin_layout Plain Layout
24492 onclick
24493 \end_layout
24494
24495 \end_inset
24496
24497  handler.
24498 \end_layout
24499
24500 \begin_layout Description
24501 \begin_inset Flex Code
24502 status collapsed
24503
24504 \begin_layout Plain Layout
24505 HTMLStyle
24506 \end_layout
24507
24508 \end_inset
24509
24510  CSS style information to be included when this style is used.
24511  Note that this will automatically be wrapped in a layout-generated 
24512 \begin_inset Flex Code
24513 status collapsed
24514
24515 \begin_layout Plain Layout
24516 <style>
24517 \end_layout
24518
24519 \end_inset
24520
24521  block, so only the CSS itself need be included.
24522  Must end with 
24523 \begin_inset Flex Code
24524 status collapsed
24525
24526 \begin_layout Plain Layout
24527 EndHTMLStyle
24528 \end_layout
24529
24530 \end_inset
24531
24532 .
24533 \end_layout
24534
24535 \begin_layout Description
24536 \begin_inset Flex Code
24537 status collapsed
24538
24539 \begin_layout Plain Layout
24540 HTMLTag
24541 \end_layout
24542
24543 \end_inset
24544
24545  [
24546 \begin_inset Flex Code
24547 status collapsed
24548
24549 \begin_layout Plain Layout
24550 string
24551 \end_layout
24552
24553 \end_inset
24554
24555 ] The tag to be used for the main label, replacing 
24556 \begin_inset Flex Code
24557 status collapsed
24558
24559 \begin_layout Plain Layout
24560 tag
24561 \end_layout
24562
24563 \end_inset
24564
24565  in the examples above.
24566  Defaults to 
24567 \begin_inset Flex Code
24568 status collapsed
24569
24570 \begin_layout Plain Layout
24571 div
24572 \end_layout
24573
24574 \end_inset
24575
24576 .
24577 \end_layout
24578
24579 \begin_layout Description
24580 \begin_inset Flex Code
24581 status collapsed
24582
24583 \begin_layout Plain Layout
24584 HTMLTitle
24585 \end_layout
24586
24587 \end_inset
24588
24589  [
24590 \begin_inset Flex Code
24591 status collapsed
24592
24593 \begin_layout Plain Layout
24594
24595 \emph on
24596 0
24597 \emph default
24598 ,1
24599 \end_layout
24600
24601 \end_inset
24602
24603 ] Marks this style as the one to be used to generate the 
24604 \begin_inset Flex Code
24605 status collapsed
24606
24607 \begin_layout Plain Layout
24608 <title>
24609 \end_layout
24610
24611 \end_inset
24612
24613  tag for the XHTML file.
24614  By default, it is false.
24615  The 
24616 \begin_inset Flex Code
24617 status collapsed
24618
24619 \begin_layout Plain Layout
24620 stdtitle.inc
24621 \end_layout
24622
24623 \end_inset
24624
24625  file sets it to true for the 
24626 \begin_inset Flex Code
24627 status collapsed
24628
24629 \begin_layout Plain Layout
24630 title
24631 \end_layout
24632
24633 \end_inset
24634
24635  environment.
24636  
24637 \end_layout
24638
24639 \begin_layout Subsection
24640 InsetLayout XHTML
24641 \end_layout
24642
24643 \begin_layout Standard
24644 The XHTML output of insets can also be controlled by information in layout
24645  files.
24646 \begin_inset Foot
24647 status collapsed
24648
24649 \begin_layout Plain Layout
24650 At present, this is true only for 
24651 \begin_inset Quotes eld
24652 \end_inset
24653
24654 text
24655 \begin_inset Quotes erd
24656 \end_inset
24657
24658  insets (insets you can type into) and is not true for 
24659 \begin_inset Quotes eld
24660 \end_inset
24661
24662 command
24663 \begin_inset Quotes erd
24664 \end_inset
24665
24666  insets (insets that are associated with dialog boxes).
24667 \end_layout
24668
24669 \end_inset
24670
24671  Here, too, \SpecialChar LyX
24672  tries to provide sensible defaults, and it constructs default
24673  CSS style rules.
24674  But everything can be customized.
24675 \end_layout
24676
24677 \begin_layout Standard
24678 The XHTML \SpecialChar LyX
24679  outputs for an inset has the following form:
24680 \end_layout
24681
24682 \begin_layout LyX-Code
24683 <tag attr=
24684 \begin_inset Quotes erd
24685 \end_inset
24686
24687 value
24688 \begin_inset Quotes erd
24689 \end_inset
24690
24691 >
24692 \end_layout
24693
24694 \begin_layout LyX-Code
24695 <labeltag>Label</labeltag>
24696 \end_layout
24697
24698 \begin_layout LyX-Code
24699 <innertag attr=
24700 \begin_inset Quotes erd
24701 \end_inset
24702
24703 value
24704 \begin_inset Quotes erd
24705 \end_inset
24706
24707 >Contents of the inset.</innertag>
24708 \end_layout
24709
24710 \begin_layout LyX-Code
24711 </tag>
24712 \end_layout
24713
24714 \begin_layout Standard
24715 If the inset permits multiple paragraphs—that is, if 
24716 \begin_inset Flex Code
24717 status collapsed
24718
24719 \begin_layout Plain Layout
24720 MultiPar
24721 \end_layout
24722
24723 \end_inset
24724
24725  is true—then the contents of the inset will itself be output as paragraphs
24726  formatted according to the styles used for those paragraphs (standard,
24727  quote, and the like).
24728  The label tag is of course omitted if the paragraph does not have a label
24729  and, at present, is always 
24730 \begin_inset Flex Code
24731 status collapsed
24732
24733 \begin_layout Plain Layout
24734 span
24735 \end_layout
24736
24737 \end_inset
24738
24739 .
24740  The inner tag is optional and, by default, does not appear.
24741 \end_layout
24742
24743 \begin_layout Standard
24744 The specific tags and attributes output for each inset can be controlled
24745  by means of the following layout tags.
24746 \end_layout
24747
24748 \begin_layout Description
24749 \begin_inset Flex Code
24750 status collapsed
24751
24752 \begin_layout Plain Layout
24753 HTMLAttr
24754 \end_layout
24755
24756 \end_inset
24757
24758  [
24759 \begin_inset Flex Code
24760 status collapsed
24761
24762 \begin_layout Plain Layout
24763 string
24764 \end_layout
24765
24766 \end_inset
24767
24768 ] Specifies attribute information to be output with the main tag.
24769  For example, 
24770 \begin_inset Quotes eld
24771 \end_inset
24772
24773
24774 \begin_inset Flex Code
24775 status collapsed
24776
24777 \begin_layout Plain Layout
24778 class=`myinset' onclick=`\SpecialChar ldots
24779 '
24780 \end_layout
24781
24782 \end_inset
24783
24784
24785 \begin_inset Quotes erd
24786 \end_inset
24787
24788 .
24789  By default, \SpecialChar LyX
24790  will output 
24791 \begin_inset Quotes eld
24792 \end_inset
24793
24794
24795 \begin_inset Flex Code
24796 status collapsed
24797
24798 \begin_layout Plain Layout
24799 class=`insetname'
24800 \end_layout
24801
24802 \end_inset
24803
24804
24805 \begin_inset Quotes erd
24806 \end_inset
24807
24808 , where 
24809 \begin_inset Flex Code
24810 status collapsed
24811
24812 \begin_layout Plain Layout
24813 insetname
24814 \end_layout
24815
24816 \end_inset
24817
24818  is the \SpecialChar LyX
24819  name of the inset, made lowercase and with non-alphanumeric characters
24820  converted to underscores, for example: footnote.
24821 \end_layout
24822
24823 \begin_layout Description
24824 \begin_inset Flex Code
24825 status collapsed
24826
24827 \begin_layout Plain Layout
24828 HTMLForceCSS
24829 \end_layout
24830
24831 \end_inset
24832
24833  [
24834 \begin_inset Flex Code
24835 status collapsed
24836
24837 \begin_layout Plain Layout
24838
24839 \emph on
24840 0
24841 \emph default
24842 ,1
24843 \end_layout
24844
24845 \end_inset
24846
24847 ] Whether to output the default CSS information \SpecialChar LyX
24848  generates for this layout,
24849  even if additional information is explicitly provided via 
24850 \begin_inset Flex Code
24851 status collapsed
24852
24853 \begin_layout Plain Layout
24854 HTMLStyle
24855 \end_layout
24856
24857 \end_inset
24858
24859 .
24860  Setting this to 
24861 \begin_inset Flex Code
24862 status collapsed
24863
24864 \begin_layout Plain Layout
24865 1
24866 \end_layout
24867
24868 \end_inset
24869
24870  allows you to alter or augment the generated CSS, rather than to override
24871  it completely.
24872  Default is 0.
24873 \end_layout
24874
24875 \begin_layout Description
24876 \begin_inset Flex Code
24877 status collapsed
24878
24879 \begin_layout Plain Layout
24880 HTMLInnerAttr
24881 \end_layout
24882
24883 \end_inset
24884
24885  [
24886 \begin_inset Flex Code
24887 status collapsed
24888
24889 \begin_layout Plain Layout
24890 string
24891 \end_layout
24892
24893 \end_inset
24894
24895 ] Attributes for the inner tag.
24896  Defaults to 
24897 \begin_inset Quotes eld
24898 \end_inset
24899
24900
24901 \begin_inset Flex Code
24902 status collapsed
24903
24904 \begin_layout Plain Layout
24905 class=`insetname_inner'
24906 \end_layout
24907
24908 \end_inset
24909
24910
24911 \begin_inset Quotes erd
24912 \end_inset
24913
24914 .
24915 \end_layout
24916
24917 \begin_layout Description
24918 \begin_inset Flex Code
24919 status collapsed
24920
24921 \begin_layout Plain Layout
24922 HTMLInnerTag
24923 \end_layout
24924
24925 \end_inset
24926
24927  [
24928 \begin_inset Flex Code
24929 status collapsed
24930
24931 \begin_layout Plain Layout
24932 string
24933 \end_layout
24934
24935 \end_inset
24936
24937 ] The inner tag, replacing 
24938 \begin_inset Flex Code
24939 status collapsed
24940
24941 \begin_layout Plain Layout
24942 innertag
24943 \end_layout
24944
24945 \end_inset
24946
24947  in the examples above.
24948  By default, there is none.
24949 \end_layout
24950
24951 \begin_layout Description
24952 \begin_inset Flex Code
24953 status collapsed
24954
24955 \begin_layout Plain Layout
24956 HTMLIsBlock
24957 \end_layout
24958
24959 \end_inset
24960
24961  [
24962 \begin_inset Flex Code
24963 status collapsed
24964
24965 \begin_layout Plain Layout
24966 0,
24967 \emph on
24968 1
24969 \end_layout
24970
24971 \end_inset
24972
24973 ] Whether this inset represents a standalone block of text (such as a footnote)
24974  or instead represents material that is included in the surrounding text
24975  (such as a branch).
24976  Defaults to 1.
24977 \end_layout
24978
24979 \begin_layout Description
24980 \begin_inset Flex Code
24981 status collapsed
24982
24983 \begin_layout Plain Layout
24984 HTMLLabel
24985 \end_layout
24986
24987 \end_inset
24988
24989  [
24990 \begin_inset Flex Code
24991 status collapsed
24992
24993 \begin_layout Plain Layout
24994 string
24995 \end_layout
24996
24997 \end_inset
24998
24999 ] A label for this inset, possibly including a reference to a counter.
25000  For example, for footnote, it might be: 
25001 \begin_inset Flex Code
25002 status collapsed
25003
25004 \begin_layout Plain Layout
25005
25006 \backslash
25007 arabic{footnote}
25008 \end_layout
25009
25010 \end_inset
25011
25012 .
25013  This is optional, and there is no default.
25014 \end_layout
25015
25016 \begin_layout Description
25017 \begin_inset Flex Code
25018 status collapsed
25019
25020 \begin_layout Plain Layout
25021 HTMLPreamble
25022 \end_layout
25023
25024 \end_inset
25025
25026  Information to be output in the 
25027 \begin_inset Flex Code
25028 status collapsed
25029
25030 \begin_layout Plain Layout
25031 <head>
25032 \end_layout
25033
25034 \end_inset
25035
25036  section when this style is used.
25037  This might, for example, be used to include a 
25038 \begin_inset Flex Code
25039 status collapsed
25040
25041 \begin_layout Plain Layout
25042 <script>
25043 \end_layout
25044
25045 \end_inset
25046
25047  block defining an 
25048 \begin_inset Flex Code
25049 status collapsed
25050
25051 \begin_layout Plain Layout
25052 onclick
25053 \end_layout
25054
25055 \end_inset
25056
25057  handler.
25058 \end_layout
25059
25060 \begin_layout Description
25061 \begin_inset Flex Code
25062 status collapsed
25063
25064 \begin_layout Plain Layout
25065 HTMLStyle
25066 \end_layout
25067
25068 \end_inset
25069
25070  CSS style information to be included when this style is used.
25071  Note that this will automatically be wrapped in a layout-generated 
25072 \begin_inset Flex Code
25073 status collapsed
25074
25075 \begin_layout Plain Layout
25076 <style>
25077 \end_layout
25078
25079 \end_inset
25080
25081  block, so only the CSS itself need be included.
25082 \end_layout
25083
25084 \begin_layout Description
25085 \begin_inset Flex Code
25086 status collapsed
25087
25088 \begin_layout Plain Layout
25089 HTMLTag
25090 \end_layout
25091
25092 \end_inset
25093
25094  [
25095 \begin_inset Flex Code
25096 status collapsed
25097
25098 \begin_layout Plain Layout
25099 string
25100 \end_layout
25101
25102 \end_inset
25103
25104 ] The tag to be used for the main label, replacing 
25105 \begin_inset Flex Code
25106 status collapsed
25107
25108 \begin_layout Plain Layout
25109 tag
25110 \end_layout
25111
25112 \end_inset
25113
25114  in the examples above.
25115  The default depends upon the setting of 
25116 \begin_inset Flex Code
25117 status collapsed
25118
25119 \begin_layout Plain Layout
25120 MultiPar
25121 \end_layout
25122
25123 \end_inset
25124
25125 : If 
25126 \begin_inset Flex Code
25127 status collapsed
25128
25129 \begin_layout Plain Layout
25130 MultiPar
25131 \end_layout
25132
25133 \end_inset
25134
25135  is true, the default is 
25136 \begin_inset Flex Code
25137 status collapsed
25138
25139 \begin_layout Plain Layout
25140 div
25141 \end_layout
25142
25143 \end_inset
25144
25145 ; if it is false, the default is 
25146 \begin_inset Flex Code
25147 status collapsed
25148
25149 \begin_layout Plain Layout
25150 span
25151 \end_layout
25152
25153 \end_inset
25154
25155 .
25156 \end_layout
25157
25158 \begin_layout Subsection
25159 Float XHTML
25160 \end_layout
25161
25162 \begin_layout Standard
25163 The XHTML output for floats too can be controlled by layout information.
25164  The output has the following form:
25165 \end_layout
25166
25167 \begin_layout LyX-Code
25168 <tag attr=
25169 \begin_inset Quotes erd
25170 \end_inset
25171
25172 value
25173 \begin_inset Quotes erd
25174 \end_inset
25175
25176 >
25177 \end_layout
25178
25179 \begin_layout LyX-Code
25180 Contents of the float.
25181 \end_layout
25182
25183 \begin_layout LyX-Code
25184 </tag>
25185 \end_layout
25186
25187 \begin_layout Standard
25188 The caption, if there is one, is a separate inset and will be output as
25189  such.
25190  Its appearance can be controlled via the InsetLayout for caption insets.
25191  
25192 \end_layout
25193
25194 \begin_layout Description
25195 \begin_inset Flex Code
25196 status collapsed
25197
25198 \begin_layout Plain Layout
25199 HTMLAttr
25200 \end_layout
25201
25202 \end_inset
25203
25204  [
25205 \begin_inset Flex Code
25206 status collapsed
25207
25208 \begin_layout Plain Layout
25209 string
25210 \end_layout
25211
25212 \end_inset
25213
25214 ] Specifies attribute information to be output with the main tag.
25215  For example, 
25216 \begin_inset Quotes eld
25217 \end_inset
25218
25219
25220 \begin_inset Flex Code
25221 status collapsed
25222
25223 \begin_layout Plain Layout
25224 class=`myfloat' onclick=`\SpecialChar ldots
25225 '
25226 \end_layout
25227
25228 \end_inset
25229
25230
25231 \begin_inset Quotes erd
25232 \end_inset
25233
25234 .
25235  By default, \SpecialChar LyX
25236  will output 
25237 \begin_inset Quotes eld
25238 \end_inset
25239
25240
25241 \begin_inset Flex Code
25242 status collapsed
25243
25244 \begin_layout Plain Layout
25245 class=`float float-floattype'
25246 \end_layout
25247
25248 \end_inset
25249
25250
25251 \begin_inset Quotes erd
25252 \end_inset
25253
25254 , where 
25255 \begin_inset Flex Code
25256 status collapsed
25257
25258 \begin_layout Plain Layout
25259 floattype
25260 \end_layout
25261
25262 \end_inset
25263
25264  is \SpecialChar LyX
25265 's name for this type of float, as determined by the float declaration
25266  (see 
25267 \begin_inset CommandInset ref
25268 LatexCommand ref
25269 reference "subsec:Floats"
25270
25271 \end_inset
25272
25273 ), though made lowercase and with non-alphanumeric characters converted
25274  to underscores, for example: float-table.
25275 \end_layout
25276
25277 \begin_layout Description
25278 \begin_inset Flex Code
25279 status collapsed
25280
25281 \begin_layout Plain Layout
25282 HTMLStyle
25283 \end_layout
25284
25285 \end_inset
25286
25287  CSS style information to be included when this float is used.
25288  Note that this will automatically be wrapped in a layout-generated 
25289 \begin_inset Flex Code
25290 status collapsed
25291
25292 \begin_layout Plain Layout
25293 <style>
25294 \end_layout
25295
25296 \end_inset
25297
25298  block, so only the CSS itself need be included.
25299 \end_layout
25300
25301 \begin_layout Description
25302 \begin_inset Flex Code
25303 status collapsed
25304
25305 \begin_layout Plain Layout
25306 HTMLTag
25307 \end_layout
25308
25309 \end_inset
25310
25311  [
25312 \begin_inset Flex Code
25313 status collapsed
25314
25315 \begin_layout Plain Layout
25316 string
25317 \end_layout
25318
25319 \end_inset
25320
25321 ] The tag to be used for this float, replacing 
25322 \begin_inset Quotes eld
25323 \end_inset
25324
25325
25326 \begin_inset Flex Code
25327 status collapsed
25328
25329 \begin_layout Plain Layout
25330 tag
25331 \end_layout
25332
25333 \end_inset
25334
25335
25336 \begin_inset Quotes erd
25337 \end_inset
25338
25339  in the example above.
25340  The default is 
25341 \begin_inset Flex Code
25342 status collapsed
25343
25344 \begin_layout Plain Layout
25345 div
25346 \end_layout
25347
25348 \end_inset
25349
25350  and will rarely need changing.
25351 \end_layout
25352
25353 \begin_layout Subsection
25354 Bibliography formatting
25355 \end_layout
25356
25357 \begin_layout Standard
25358 The bibliography can be formatted using 
25359 \begin_inset Flex Code
25360 status collapsed
25361
25362 \begin_layout Plain Layout
25363 CiteFormat
25364 \end_layout
25365
25366 \end_inset
25367
25368  blocks.
25369  See 
25370 \begin_inset CommandInset ref
25371 LatexCommand ref
25372 reference "subsec:Citation-format-description"
25373
25374 \end_inset
25375
25376  for the details.
25377 \end_layout
25378
25379 \begin_layout Subsection
25380 \SpecialChar LyX
25381 -generated CSS
25382 \end_layout
25383
25384 \begin_layout Standard
25385 We have several times mentioned that \SpecialChar LyX
25386  will generate default CSS style rules
25387  for both insets and paragraph styles, based upon the other layout information
25388  that is provided.
25389  In this section, we shall say a word about which layout information \SpecialChar LyX
25390  uses
25391  and how.
25392 \end_layout
25393
25394 \begin_layout Standard
25395 At present, \SpecialChar LyX
25396  auto-generates CSS only for font information, making use of
25397  the 
25398 \begin_inset Flex Code
25399 status collapsed
25400
25401 \begin_layout Plain Layout
25402 Family
25403 \end_layout
25404
25405 \end_inset
25406
25407
25408 \begin_inset Flex Code
25409 status collapsed
25410
25411 \begin_layout Plain Layout
25412 Series
25413 \end_layout
25414
25415 \end_inset
25416
25417
25418 \begin_inset Flex Code
25419 status collapsed
25420
25421 \begin_layout Plain Layout
25422 Shape
25423 \end_layout
25424
25425 \end_inset
25426
25427 , and 
25428 \begin_inset Flex Code
25429 status collapsed
25430
25431 \begin_layout Plain Layout
25432 Size
25433 \end_layout
25434
25435 \end_inset
25436
25437  specified in the 
25438 \begin_inset Flex Code
25439 status collapsed
25440
25441 \begin_layout Plain Layout
25442 Font
25443 \end_layout
25444
25445 \end_inset
25446
25447  declaration (see 
25448 \begin_inset CommandInset ref
25449 LatexCommand ref
25450 reference "subsec:Font-description"
25451
25452 \end_inset
25453
25454 ).
25455  The translation is mostly straightforward and obvious.
25456  For example, 
25457 \begin_inset Quotes eld
25458 \end_inset
25459
25460
25461 \begin_inset Flex Code
25462 status collapsed
25463
25464 \begin_layout Plain Layout
25465 Family Sans
25466 \end_layout
25467
25468 \end_inset
25469
25470
25471 \begin_inset Quotes erd
25472 \end_inset
25473
25474  becomes 
25475 \begin_inset Quotes eld
25476 \end_inset
25477
25478
25479 \begin_inset Flex Code
25480 status collapsed
25481
25482 \begin_layout Plain Layout
25483 font-family: sans-serif;
25484 \end_layout
25485
25486 \end_inset
25487
25488
25489 \begin_inset Quotes erd
25490 \end_inset
25491
25492 .
25493  The correspondence of \SpecialChar LyX
25494  sizes and CSS sizes is a little less obvious but
25495  nonetheless intuitive.
25496  See the 
25497 \begin_inset Flex Code
25498 status collapsed
25499
25500 \begin_layout Plain Layout
25501 getSizeCSS()
25502 \end_layout
25503
25504 \end_inset
25505
25506  function in 
25507 \begin_inset Flex URL
25508 status collapsed
25509
25510 \begin_layout Plain Layout
25511
25512 src/FontInfo.cpp
25513 \end_layout
25514
25515 \end_inset
25516
25517  for the details.
25518 \end_layout
25519
25520 \begin_layout Chapter
25521 Including External Material
25522 \begin_inset CommandInset label
25523 LatexCommand label
25524 name "chap:Including-External-Material"
25525
25526 \end_inset
25527
25528
25529 \end_layout
25530
25531 \begin_layout Standard
25532 \begin_inset Box Shadowbox
25533 position "t"
25534 hor_pos "c"
25535 has_inner_box 1
25536 inner_pos "t"
25537 use_parbox 0
25538 use_makebox 0
25539 width "100col%"
25540 special "none"
25541 height "1in"
25542 height_special "totalheight"
25543 thickness "0.4pt"
25544 separation "3pt"
25545 shadowsize "4pt"
25546 framecolor "black"
25547 backgroundcolor "none"
25548 status open
25549
25550 \begin_layout Plain Layout
25551 WARNING: This portion of the documentation has not been updated for some
25552  time.
25553  We certainly hope that it is still accurate, but there are no guarantees.
25554 \end_layout
25555
25556 \end_inset
25557
25558
25559 \end_layout
25560
25561 \begin_layout Standard
25562 The use of material from sources external to \SpecialChar LyX
25563  is covered in detail in the
25564  
25565 \emph on
25566 Embedded Objects
25567 \emph default
25568  manual.
25569  This part of the manual covers what needs to happen behind the scenes for
25570  new sorts of material to be included.
25571 \end_layout
25572
25573 \begin_layout Section
25574 How does it work?
25575 \end_layout
25576
25577 \begin_layout Standard
25578 The external material feature is based on the concept of a 
25579 \emph on
25580 template
25581 \emph default
25582 .
25583  A template is a specification of how \SpecialChar LyX
25584  should interface with a certain kind
25585  of material.
25586  As bundled, \SpecialChar LyX
25587  comes with predefined templates for Xfig figures, various
25588  raster format images, chess diagrams, and LilyPond music notation.
25589  You can check the actual list by using the menu 
25590 \begin_inset Flex Noun
25591 status collapsed
25592
25593 \begin_layout Plain Layout
25594 Insert\SpecialChar menuseparator
25595 File\SpecialChar menuseparator
25596 External Material
25597 \end_layout
25598
25599 \end_inset
25600
25601 .
25602  Furthermore, it is possible to roll your own template to support a specific
25603  kind of material.
25604  Later we'll describe in more detail what is involved, and hopefully you
25605  will submit all the templates you create so we can include them in a later
25606  \SpecialChar LyX
25607  version.
25608 \end_layout
25609
25610 \begin_layout Standard
25611 Another basic idea of the external material feature is to distinguish between
25612  the original file that serves as a base for final material and the produced
25613  file that is included in your exported or printed document.
25614  For example, consider the case of a figure produced with 
25615 \begin_inset Flex Code
25616 status collapsed
25617
25618 \begin_layout Plain Layout
25619 Xfig
25620 \end_layout
25621
25622 \end_inset
25623
25624 .
25625  The Xfig application itself works on an original file with the 
25626 \begin_inset Flex Code
25627 status collapsed
25628
25629 \begin_layout Plain Layout
25630 .fig
25631 \end_layout
25632
25633 \end_inset
25634
25635  extension.
25636  Within Xfig, you create and change your figure, and when you are done,
25637  you save the 
25638 \begin_inset Flex Code
25639 status collapsed
25640
25641 \begin_layout Plain Layout
25642 fig
25643 \end_layout
25644
25645 \end_inset
25646
25647 -file.
25648  When you want to include the figure in your document, you invoke 
25649 \begin_inset Flex Code
25650 status collapsed
25651
25652 \begin_layout Plain Layout
25653 transfig
25654 \end_layout
25655
25656 \end_inset
25657
25658  in order to create a PostScript file that can readily be included in your
25659  \SpecialChar LaTeX
25660  file.
25661  In this case, the 
25662 \begin_inset Flex Code
25663 status collapsed
25664
25665 \begin_layout Plain Layout
25666 .fig
25667 \end_layout
25668
25669 \end_inset
25670
25671  file is the original file, and the PostScript file is the produced file.
25672 \end_layout
25673
25674 \begin_layout Standard
25675 This distinction is important in order to allow updating of the material
25676  while you are in the process of writing the document.
25677  Furthermore, it provides us with the flexibility that is needed to support
25678  multiple export formats.
25679  For instance, in the case of a plain text file, it is not exactly an award-winn
25680 ing idea to include the figure as raw PostScript.
25681  Instead, you would either prefer to just include a reference to the figure
25682  or try to invoke some graphics to ASCII converter to make the final result
25683  look similar to the real graphics.
25684  The external material management allows you to do this, because it is parametri
25685 zed on the different export formats that \SpecialChar LyX
25686  supports.
25687 \end_layout
25688
25689 \begin_layout Standard
25690 Besides supporting the production of different products according to the
25691  exported format, it supports tight integration with editing and viewing
25692  applications.
25693  In the case of an Xfig figure, you are able to invoke Xfig on the original
25694  file with a single click from within the external material dialog in \SpecialChar LyX
25695 ,
25696  and also preview the produced PostScript file with Ghostview with another
25697  click.
25698  No more fiddling around with the command line and/or file browsers to locate
25699  and manipulate the original or produced files.
25700  In this way, you are finally able to take full advantage of the many different
25701  applications that are relevant to use when you write your documents, and
25702  ultimately be more productive.
25703 \end_layout
25704
25705 \begin_layout Section
25706 The external template configuration file
25707 \change_inserted -712698321 1490533960
25708 s
25709 \change_unchanged
25710
25711 \end_layout
25712
25713 \begin_layout Standard
25714 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25715 .
25716  However, be aware that doing this in an careless manner most probably 
25717 \emph on
25718 will
25719 \emph default
25720  introduce an easily exploitable security hole.
25721  So before you do this, please read the discussion about security in 
25722 \begin_inset CommandInset ref
25723 LatexCommand ref
25724 reference "sec:Security-discussion"
25725
25726 \end_inset
25727
25728 .
25729 \end_layout
25730
25731 \begin_layout Standard
25732 Having said that, we encourage you to submit any interesting templates that
25733  you create.
25734  
25735 \end_layout
25736
25737 \begin_layout Standard
25738 The external templates are defined in the
25739 \change_inserted -712698321 1490534022
25740  
25741 \begin_inset Flex Code
25742 status collapsed
25743
25744 \begin_layout Plain Layout
25745
25746 \change_inserted -712698321 1490533996
25747 *.xtemplate
25748 \end_layout
25749
25750 \end_inset
25751
25752  files that are stored in the
25753 \change_unchanged
25754  
25755 \begin_inset Flex Code
25756 status collapsed
25757
25758 \begin_layout Plain Layout
25759 LyXDir/lib/
25760 \change_deleted -712698321 1490533984
25761 external_
25762 \change_inserted -712698321 1490533984
25763 x
25764 \change_unchanged
25765 templates
25766 \change_inserted -712698321 1490534077
25767 /
25768 \change_unchanged
25769
25770 \end_layout
25771
25772 \end_inset
25773
25774  
25775 \change_deleted -712698321 1490534025
25776 file
25777 \change_inserted -712698321 1490534028
25778 directory
25779 \change_unchanged
25780 .
25781  
25782 \change_inserted -712698321 1490534233
25783 Each template is defined in a file of its own.
25784  
25785 \change_unchanged
25786 You can place your own 
25787 \change_deleted -712698321 1490534089
25788 version
25789 \change_inserted -712698321 1490534090
25790 templates
25791 \change_unchanged
25792  in 
25793 \begin_inset Flex Code
25794 status collapsed
25795
25796 \begin_layout Plain Layout
25797 UserDir/
25798 \change_deleted -712698321 1490534069
25799 external_
25800 \change_inserted -712698321 1490534069
25801 x
25802 \change_unchanged
25803 templates
25804 \change_inserted -712698321 1490534080
25805 /
25806 \change_unchanged
25807
25808 \end_layout
25809
25810 \end_inset
25811
25812
25813 \change_inserted -712698321 1490534112
25814  or copy existing templates to that directory in order to modify them
25815 \change_unchanged
25816 .
25817 \end_layout
25818
25819 \begin_layout Standard
25820 A typical template looks like this:
25821 \end_layout
25822
25823 \begin_layout LyX-Code
25824 Template XFig
25825 \end_layout
25826
25827 \begin_layout LyX-Code
25828 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25829 \end_layout
25830
25831 \begin_layout LyX-Code
25832 HelpText
25833 \end_layout
25834
25835 \begin_layout LyX-Code
25836 An XFig figure.
25837 \end_layout
25838
25839 \begin_layout LyX-Code
25840 HelpTextEnd
25841 \end_layout
25842
25843 \begin_layout LyX-Code
25844 InputFormat fig
25845 \end_layout
25846
25847 \begin_layout LyX-Code
25848 FileFilter "*.fig"
25849 \end_layout
25850
25851 \begin_layout LyX-Code
25852 AutomaticProduction true
25853 \end_layout
25854
25855 \begin_layout LyX-Code
25856 Transform Rotate
25857 \end_layout
25858
25859 \begin_layout LyX-Code
25860 Transform Resize
25861 \end_layout
25862
25863 \begin_layout LyX-Code
25864 Format LaTeX
25865 \end_layout
25866
25867 \begin_layout LyX-Code
25868 TransformCommand Rotate RotationLatexCommand
25869 \end_layout
25870
25871 \begin_layout LyX-Code
25872 TransformCommand Resize ResizeLatexCommand
25873 \end_layout
25874
25875 \begin_layout LyX-Code
25876 Product "$$RotateFront$$ResizeFront
25877 \end_layout
25878
25879 \begin_layout LyX-Code
25880          
25881 \backslash
25882
25883 \backslash
25884 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25885 \end_layout
25886
25887 \begin_layout LyX-Code
25888          $$ResizeBack$$RotateBack"
25889 \end_layout
25890
25891 \begin_layout LyX-Code
25892 UpdateFormat pstex
25893 \end_layout
25894
25895 \begin_layout LyX-Code
25896 UpdateResult "$$AbsPath$$Basename.pstex_t"
25897 \end_layout
25898
25899 \begin_layout LyX-Code
25900 Requirement "graphicx"
25901 \end_layout
25902
25903 \begin_layout LyX-Code
25904 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25905 \end_layout
25906
25907 \begin_layout LyX-Code
25908 ReferencedFile latex "$$AbsPath$$Basename.eps"
25909 \end_layout
25910
25911 \begin_layout LyX-Code
25912 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25913 \end_layout
25914
25915 \begin_layout LyX-Code
25916 FormatEnd
25917 \end_layout
25918
25919 \begin_layout LyX-Code
25920 Format PDFLaTeX
25921 \end_layout
25922
25923 \begin_layout LyX-Code
25924 TransformCommand Rotate RotationLatexCommand
25925 \end_layout
25926
25927 \begin_layout LyX-Code
25928 TransformCommand Resize ResizeLatexCommand
25929 \end_layout
25930
25931 \begin_layout LyX-Code
25932 Product "$$RotateFront$$ResizeFront
25933 \end_layout
25934
25935 \begin_layout LyX-Code
25936          
25937 \backslash
25938
25939 \backslash
25940 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25941 \end_layout
25942
25943 \begin_layout LyX-Code
25944          $$ResizeBack$$RotateBack"
25945 \end_layout
25946
25947 \begin_layout LyX-Code
25948 UpdateFormat pdftex
25949 \end_layout
25950
25951 \begin_layout LyX-Code
25952 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25953 \end_layout
25954
25955 \begin_layout LyX-Code
25956 Requirement "graphicx"
25957 \end_layout
25958
25959 \begin_layout LyX-Code
25960 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25961 \end_layout
25962
25963 \begin_layout LyX-Code
25964 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25965 \end_layout
25966
25967 \begin_layout LyX-Code
25968 FormatEnd
25969 \end_layout
25970
25971 \begin_layout LyX-Code
25972 Format Ascii
25973 \end_layout
25974
25975 \begin_layout LyX-Code
25976 Product "[XFig: $$FName]"
25977 \end_layout
25978
25979 \begin_layout LyX-Code
25980 FormatEnd
25981 \end_layout
25982
25983 \begin_layout LyX-Code
25984 Format DocBook
25985 \end_layout
25986
25987 \begin_layout LyX-Code
25988 Product "<graphic fileref=
25989 \backslash
25990 "$$AbsOrRelPathMaster$$Basename.eps
25991 \backslash
25992 ">
25993 \end_layout
25994
25995 \begin_layout LyX-Code
25996          </graphic>"
25997 \end_layout
25998
25999 \begin_layout LyX-Code
26000 UpdateFormat eps
26001 \end_layout
26002
26003 \begin_layout LyX-Code
26004 UpdateResult "$$AbsPath$$Basename.eps"
26005 \end_layout
26006
26007 \begin_layout LyX-Code
26008 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26009 \end_layout
26010
26011 \begin_layout LyX-Code
26012 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26013 \end_layout
26014
26015 \begin_layout LyX-Code
26016 FormatEnd
26017 \end_layout
26018
26019 \begin_layout LyX-Code
26020 TemplateEnd
26021 \end_layout
26022
26023 \begin_layout Standard
26024 As you can see, the template is enclosed in 
26025 \begin_inset Flex Code
26026 status collapsed
26027
26028 \begin_layout Plain Layout
26029 Template
26030 \end_layout
26031
26032 \end_inset
26033
26034  \SpecialChar ldots
26035  
26036 \begin_inset Flex Code
26037 status collapsed
26038
26039 \begin_layout Plain Layout
26040 TemplateEnd
26041 \end_layout
26042
26043 \end_inset
26044
26045 .
26046  It contains a header specifying some general settings and, for each supported
26047  primary document file format, a section 
26048 \begin_inset Flex Code
26049 status collapsed
26050
26051 \begin_layout Plain Layout
26052 Format
26053 \end_layout
26054
26055 \end_inset
26056
26057  \SpecialChar ldots
26058  
26059 \begin_inset Flex Code
26060 status collapsed
26061
26062 \begin_layout Plain Layout
26063 FormatEnd
26064 \end_layout
26065
26066 \end_inset
26067
26068 .
26069 \end_layout
26070
26071 \begin_layout Subsection
26072 The template header
26073 \end_layout
26074
26075 \begin_layout Description
26076 \begin_inset Flex Code
26077 status collapsed
26078
26079 \begin_layout Plain Layout
26080 AutomaticProduction
26081 \begin_inset space ~
26082 \end_inset
26083
26084 true|false
26085 \end_layout
26086
26087 \end_inset
26088
26089  Whether the file represented by the template must be generated by \SpecialChar LyX
26090 .
26091  This command must occur exactly once.
26092 \end_layout
26093
26094 \begin_layout Description
26095 \begin_inset Flex Code
26096 status collapsed
26097
26098 \begin_layout Plain Layout
26099 FileFilter
26100 \begin_inset space ~
26101 \end_inset
26102
26103 <pattern>
26104 \end_layout
26105
26106 \end_inset
26107
26108  A glob pattern that is used in the file dialog to filter out the desired
26109  files.
26110  If there is more than one possible file extension (e.
26111 \begin_inset space \thinspace{}
26112 \end_inset
26113
26114 g.
26115 \begin_inset space \space{}
26116 \end_inset
26117
26118 tgif has 
26119 \begin_inset Flex Code
26120 status collapsed
26121
26122 \begin_layout Plain Layout
26123 .obj
26124 \end_layout
26125
26126 \end_inset
26127
26128  and 
26129 \begin_inset Flex Code
26130 status collapsed
26131
26132 \begin_layout Plain Layout
26133 .tgo
26134 \end_layout
26135
26136 \end_inset
26137
26138 ), use something like 
26139 \begin_inset Flex Code
26140 status collapsed
26141
26142 \begin_layout Plain Layout
26143 "*.{obj,tgo}"
26144 \end_layout
26145
26146 \end_inset
26147
26148 .
26149  This command must occur exactly once.
26150 \end_layout
26151
26152 \begin_layout Description
26153 \begin_inset Flex Code
26154 status collapsed
26155
26156 \begin_layout Plain Layout
26157 GuiName
26158 \begin_inset space ~
26159 \end_inset
26160
26161 <guiname>
26162 \end_layout
26163
26164 \end_inset
26165
26166  The text that is displayed on the button.
26167  This command must occur exactly once.
26168 \end_layout
26169
26170 \begin_layout Description
26171 \begin_inset Flex Code
26172 status collapsed
26173
26174 \begin_layout Plain Layout
26175 HelpText
26176 \begin_inset space ~
26177 \end_inset
26178
26179 <text>
26180 \begin_inset space ~
26181 \end_inset
26182
26183 HelpTextEnd
26184 \end_layout
26185
26186 \end_inset
26187
26188  The help text that is used in the External dialog.
26189  Provide enough information to explain to the user just what the template
26190  can provide him with.
26191  This command must occur exactly once.
26192 \end_layout
26193
26194 \begin_layout Description
26195 \begin_inset Flex Code
26196 status collapsed
26197
26198 \begin_layout Plain Layout
26199 InputFormat
26200 \begin_inset space ~
26201 \end_inset
26202
26203 <format>
26204 \end_layout
26205
26206 \end_inset
26207
26208  The file format of the original file.
26209  This must be the name of a format that is known to \SpecialChar LyX
26210  (see 
26211 \begin_inset CommandInset ref
26212 LatexCommand ref
26213 reference "sec:Formats"
26214
26215 \end_inset
26216
26217 ).
26218  Use 
26219 \begin_inset Quotes eld
26220 \end_inset
26221
26222
26223 \begin_inset Flex Code
26224 status collapsed
26225
26226 \begin_layout Plain Layout
26227 *
26228 \end_layout
26229
26230 \end_inset
26231
26232
26233 \begin_inset Quotes erd
26234 \end_inset
26235
26236  if the template can handle original files of more than one format.
26237  \SpecialChar LyX
26238  will attempt to interrogate the file itself in order to deduce its format
26239  in this case.
26240  This command must occur exactly once.
26241 \end_layout
26242
26243 \begin_layout Description
26244 \begin_inset Flex Code
26245 status collapsed
26246
26247 \begin_layout Plain Layout
26248 Template
26249 \begin_inset space ~
26250 \end_inset
26251
26252 <id>
26253 \end_layout
26254
26255 \end_inset
26256
26257  A unique name for the template.
26258  It must not contain substitution macros (see below).
26259 \end_layout
26260
26261 \begin_layout Description
26262 \begin_inset Flex Code
26263 status collapsed
26264
26265 \begin_layout Plain Layout
26266 Transform
26267 \begin_inset space ~
26268 \end_inset
26269
26270 Rotate|Resize|Clip|Extra
26271 \end_layout
26272
26273 \end_inset
26274
26275  This command specifies which transformations are supported by this template.
26276  It may occur zero or more times.
26277  This command enables the corresponding tabs in the external dialog.
26278  Each 
26279 \begin_inset Flex Code
26280 status collapsed
26281
26282 \begin_layout Plain Layout
26283 Transform
26284 \end_layout
26285
26286 \end_inset
26287
26288  command must have either a corresponding 
26289 \begin_inset Flex Code
26290 status collapsed
26291
26292 \begin_layout Plain Layout
26293 TransformCommand
26294 \end_layout
26295
26296 \end_inset
26297
26298  or a 
26299 \begin_inset Flex Code
26300 status collapsed
26301
26302 \begin_layout Plain Layout
26303 TransformOption
26304 \end_layout
26305
26306 \end_inset
26307
26308  command in the 
26309 \begin_inset Flex Code
26310 status collapsed
26311
26312 \begin_layout Plain Layout
26313 Format
26314 \end_layout
26315
26316 \end_inset
26317
26318  section.
26319  Otherwise the transformation will not be supported by that format.
26320 \end_layout
26321
26322 \begin_layout Subsection
26323 The Format section
26324 \end_layout
26325
26326 \begin_layout Description
26327 \begin_inset Flex Code
26328 status collapsed
26329
26330 \begin_layout Plain Layout
26331 Format
26332 \begin_inset space ~
26333 \end_inset
26334
26335 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26336 \end_layout
26337
26338 \end_inset
26339
26340  The primary document file format that this format definition is for.
26341  Not every template has a sensible representation in all document file formats.
26342  Please define nevertheless a 
26343 \begin_inset Flex Code
26344 status collapsed
26345
26346 \begin_layout Plain Layout
26347 Format
26348 \end_layout
26349
26350 \end_inset
26351
26352  section for all templates.
26353  Use a dummy text when no representation is available.
26354  Then you can at least see a reference to the external material in the exported
26355  document.
26356 \end_layout
26357
26358 \begin_layout Description
26359 \begin_inset Flex Code
26360 status collapsed
26361
26362 \begin_layout Plain Layout
26363 Option
26364 \begin_inset space ~
26365 \end_inset
26366
26367 <name>
26368 \begin_inset space ~
26369 \end_inset
26370
26371 <value>
26372 \end_layout
26373
26374 \end_inset
26375
26376  This command defines an additional macro 
26377 \begin_inset Flex Code
26378 status collapsed
26379
26380 \begin_layout Plain Layout
26381 $$<name>
26382 \end_layout
26383
26384 \end_inset
26385
26386  for substitution in 
26387 \begin_inset Flex Code
26388 status collapsed
26389
26390 \begin_layout Plain Layout
26391 Product
26392 \end_layout
26393
26394 \end_inset
26395
26396 .
26397  
26398 \begin_inset Flex Code
26399 status collapsed
26400
26401 \begin_layout Plain Layout
26402 <value>
26403 \end_layout
26404
26405 \end_inset
26406
26407  itself may contain substitution macros.
26408  The advantage over using 
26409 \begin_inset Flex Code
26410 status collapsed
26411
26412 \begin_layout Plain Layout
26413 <value>
26414 \end_layout
26415
26416 \end_inset
26417
26418  directly in 
26419 \begin_inset Flex Code
26420 status collapsed
26421
26422 \begin_layout Plain Layout
26423 Product
26424 \end_layout
26425
26426 \end_inset
26427
26428  is that the substituted value of 
26429 \begin_inset Flex Code
26430 status collapsed
26431
26432 \begin_layout Plain Layout
26433 $$<name>
26434 \end_layout
26435
26436 \end_inset
26437
26438  is sanitized so that it is a valid optional argument in the document format.
26439  This command may occur zero or more times.
26440 \end_layout
26441
26442 \begin_layout Description
26443 \begin_inset Flex Code
26444 status collapsed
26445
26446 \begin_layout Plain Layout
26447 Product
26448 \begin_inset space ~
26449 \end_inset
26450
26451 <text>
26452 \end_layout
26453
26454 \end_inset
26455
26456  The text that is inserted in the exported document.
26457  This is actually the most important command and can be quite complex.
26458  This command must occur exactly once.
26459 \end_layout
26460
26461 \begin_layout Description
26462 \begin_inset Flex Code
26463 status collapsed
26464
26465 \begin_layout Plain Layout
26466 Preamble
26467 \begin_inset space ~
26468 \end_inset
26469
26470 <name>
26471 \end_layout
26472
26473 \end_inset
26474
26475  This command specifies a preamble snippet that will be included in the
26476  \SpecialChar LaTeX
26477  preamble.
26478  It has to be defined using 
26479 \begin_inset Flex Code
26480 status collapsed
26481
26482 \begin_layout Plain Layout
26483 PreambleDef
26484 \end_layout
26485
26486 \end_inset
26487
26488  \SpecialChar ldots
26489  
26490 \begin_inset Flex Code
26491 status collapsed
26492
26493 \begin_layout Plain Layout
26494 PreambleDefEnd
26495 \end_layout
26496
26497 \end_inset
26498
26499 .
26500  This command may occur zero or more times.
26501 \end_layout
26502
26503 \begin_layout Description
26504 \begin_inset Flex Code
26505 status collapsed
26506
26507 \begin_layout Plain Layout
26508 ReferencedFile
26509 \begin_inset space ~
26510 \end_inset
26511
26512 <format>
26513 \begin_inset space ~
26514 \end_inset
26515
26516 <filename>
26517 \end_layout
26518
26519 \end_inset
26520
26521  This command denotes files that are created by the conversion process and
26522  are needed for a particular export format.
26523  If the filename is relative, it is interpreted relative to the master document.
26524  This command may be given zero or more times.
26525 \end_layout
26526
26527 \begin_layout Description
26528 \begin_inset Flex Code
26529 status collapsed
26530
26531 \begin_layout Plain Layout
26532 Requirement
26533 \begin_inset space ~
26534 \end_inset
26535
26536 <package>
26537 \end_layout
26538
26539 \end_inset
26540
26541  The name of a required \SpecialChar LaTeX
26542  package.
26543  The package is included via 
26544 \begin_inset Flex Code
26545 status collapsed
26546
26547 \begin_layout Plain Layout
26548
26549 \backslash
26550 usepackage{}
26551 \end_layout
26552
26553 \end_inset
26554
26555  in the \SpecialChar LaTeX
26556  preamble.
26557  This command may occur zero or more times.
26558 \end_layout
26559
26560 \begin_layout Description
26561 \begin_inset Flex Code
26562 status collapsed
26563
26564 \begin_layout Plain Layout
26565 TransformCommand
26566 \begin_inset space ~
26567 \end_inset
26568
26569 Rotate
26570 \begin_inset space ~
26571 \end_inset
26572
26573 RotationLatexCommand
26574 \end_layout
26575
26576 \end_inset
26577
26578  This command specifies that the built in \SpecialChar LaTeX
26579  command should be used for rotation.
26580  This command may occur once or not at all.
26581 \end_layout
26582
26583 \begin_layout Description
26584 \begin_inset Flex Code
26585 status collapsed
26586
26587 \begin_layout Plain Layout
26588 TransformCommand
26589 \begin_inset space ~
26590 \end_inset
26591
26592 Resize
26593 \begin_inset space ~
26594 \end_inset
26595
26596 ResizeLatexCommand
26597 \end_layout
26598
26599 \end_inset
26600
26601  This command specifies that the built in \SpecialChar LaTeX
26602  command should be used for resizing.
26603  This command may occur once or not at all.
26604 \end_layout
26605
26606 \begin_layout Description
26607 \begin_inset Flex Code
26608 status collapsed
26609
26610 \begin_layout Plain Layout
26611 TransformOption
26612 \begin_inset space ~
26613 \end_inset
26614
26615 Rotate
26616 \begin_inset space ~
26617 \end_inset
26618
26619 RotationLatexOption
26620 \end_layout
26621
26622 \end_inset
26623
26624  This command specifies that rotation is done via an optional argument.
26625  This command may occur once or not at all.
26626 \end_layout
26627
26628 \begin_layout Description
26629 \begin_inset Flex Code
26630 status collapsed
26631
26632 \begin_layout Plain Layout
26633 TransformOption
26634 \begin_inset space ~
26635 \end_inset
26636
26637 Resize
26638 \begin_inset space ~
26639 \end_inset
26640
26641 ResizeLatexOption
26642 \end_layout
26643
26644 \end_inset
26645
26646  This command specifies that resizing is done via an optional argument.
26647  This command may occur once or not at all.
26648 \end_layout
26649
26650 \begin_layout Description
26651 \begin_inset Flex Code
26652 status collapsed
26653
26654 \begin_layout Plain Layout
26655 TransformOption
26656 \begin_inset space ~
26657 \end_inset
26658
26659 Clip
26660 \begin_inset space ~
26661 \end_inset
26662
26663 ClipLatexOption
26664 \end_layout
26665
26666 \end_inset
26667
26668  This command specifies that clipping is done via an optional argument.
26669  This command may occur once or not at all.
26670 \end_layout
26671
26672 \begin_layout Description
26673 \begin_inset Flex Code
26674 status collapsed
26675
26676 \begin_layout Plain Layout
26677 TransformOption
26678 \begin_inset space ~
26679 \end_inset
26680
26681 Extra
26682 \begin_inset space ~
26683 \end_inset
26684
26685 ExtraLatexOption
26686 \end_layout
26687
26688 \end_inset
26689
26690  This command specifies that an extra optional argument is used.
26691  This command may occur once or not at all.
26692 \end_layout
26693
26694 \begin_layout Description
26695 \begin_inset Flex Code
26696 status collapsed
26697
26698 \begin_layout Plain Layout
26699 UpdateFormat
26700 \begin_inset space ~
26701 \end_inset
26702
26703 <format>
26704 \end_layout
26705
26706 \end_inset
26707
26708  The file format of the converted file.
26709  This must be the name of a format that is known to \SpecialChar LyX
26710  (see the 
26711 \begin_inset Flex Noun
26712 status collapsed
26713
26714 \begin_layout Plain Layout
26715 Tools\SpecialChar menuseparator
26716 Preferences\SpecialChar menuseparator
26717 File Handling\SpecialChar menuseparator
26718 File Format
26719 \end_layout
26720
26721 \end_inset
26722
26723  dialog).
26724  This command must occur exactly once.
26725  If the resulting file format is PDF, you need to specify the format 
26726 \begin_inset Flex Code
26727 status collapsed
26728
26729 \begin_layout Plain Layout
26730 pdf6
26731 \end_layout
26732
26733 \end_inset
26734
26735 .
26736  This is the PDF format used for including graphics.
26737  The other defined PDF formats are for document export.
26738 \end_layout
26739
26740 \begin_layout Description
26741 \begin_inset Flex Code
26742 status collapsed
26743
26744 \begin_layout Plain Layout
26745 UpdateResult
26746 \begin_inset space ~
26747 \end_inset
26748
26749 <filename>
26750 \end_layout
26751
26752 \end_inset
26753
26754  The file name of the converted file.
26755  The file name must be absolute.
26756  This command must occur exactly once.
26757 \end_layout
26758
26759 \begin_layout Subsection
26760 Preamble definitions
26761 \end_layout
26762
26763 \begin_layout Standard
26764 The external template configuration file may contain additional preamble
26765  definitions enclosed by 
26766 \begin_inset Flex Code
26767 status collapsed
26768
26769 \begin_layout Plain Layout
26770 PreambleDef
26771 \end_layout
26772
26773 \end_inset
26774
26775  \SpecialChar ldots
26776  
26777 \begin_inset Flex Code
26778 status collapsed
26779
26780 \begin_layout Plain Layout
26781 PreambleDefEnd
26782 \end_layout
26783
26784 \end_inset
26785
26786 .
26787  They can be used by the templates in the 
26788 \begin_inset Flex Code
26789 status collapsed
26790
26791 \begin_layout Plain Layout
26792 Format
26793 \end_layout
26794
26795 \end_inset
26796
26797  section.
26798 \end_layout
26799
26800 \begin_layout Section
26801 The substitution mechanism
26802 \end_layout
26803
26804 \begin_layout Standard
26805 When the external material facility invokes an external program, it is done
26806  on the basis of a command defined in the template configuration file.
26807  These commands can contain various macros that are expanded before execution.
26808  Execution always take place in the directory of the containing document.
26809 \end_layout
26810
26811 \begin_layout Standard
26812 Also, whenever external material is to be displayed, the name will be produced
26813  by the substitution mechanism, and most other commands in the template
26814  definition support substitution as well.
26815 \end_layout
26816
26817 \begin_layout Standard
26818 The available macros are the following:
26819 \end_layout
26820
26821 \begin_layout Description
26822 \begin_inset Flex Code
26823 status collapsed
26824
26825 \begin_layout Plain Layout
26826 $$AbsOrRelPathMaster
26827 \end_layout
26828
26829 \end_inset
26830
26831  The file path, absolute or relative to the master \SpecialChar LyX
26832  document.
26833 \end_layout
26834
26835 \begin_layout Description
26836 \begin_inset Flex Code
26837 status collapsed
26838
26839 \begin_layout Plain Layout
26840 $$AbsOrRelPathParent
26841 \end_layout
26842
26843 \end_inset
26844
26845  The file path, absolute or relative to the \SpecialChar LyX
26846  document.
26847 \end_layout
26848
26849 \begin_layout Description
26850 \begin_inset Flex Code
26851 status collapsed
26852
26853 \begin_layout Plain Layout
26854 $$AbsPath
26855 \end_layout
26856
26857 \end_inset
26858
26859  The absolute file path.
26860 \end_layout
26861
26862 \begin_layout Description
26863 \begin_inset Flex Code
26864 status collapsed
26865
26866 \begin_layout Plain Layout
26867 $$Basename
26868 \end_layout
26869
26870 \end_inset
26871
26872  The filename without path and without the extension.
26873 \end_layout
26874
26875 \begin_layout Description
26876 \begin_inset Flex Code
26877 status collapsed
26878
26879 \begin_layout Plain Layout
26880 $$Contents(
26881 \begin_inset Quotes eld
26882 \end_inset
26883
26884 filename.ext
26885 \begin_inset Quotes erd
26886 \end_inset
26887
26888 )
26889 \end_layout
26890
26891 \end_inset
26892
26893  This macro will expand to the contents of the file with the name 
26894 \begin_inset Flex Code
26895 status collapsed
26896
26897 \begin_layout Plain Layout
26898 filename.ext
26899 \end_layout
26900
26901 \end_inset
26902
26903 .
26904 \end_layout
26905
26906 \begin_layout Description
26907 \begin_inset Flex Code
26908 status collapsed
26909
26910 \begin_layout Plain Layout
26911 $$Extension
26912 \end_layout
26913
26914 \end_inset
26915
26916  The file extension (including the dot).
26917 \end_layout
26918
26919 \begin_layout Description
26920 \begin_inset Flex Code
26921 status collapsed
26922
26923 \begin_layout Plain Layout
26924 $$pngOrjpg
26925 \end_layout
26926
26927 \end_inset
26928
26929  This will be the string 
26930 \begin_inset Quotes eld
26931 \end_inset
26932
26933 jpg
26934 \begin_inset Quotes erd
26935 \end_inset
26936
26937  if the file is in JPEG format, otherwise it will be the string 
26938 \begin_inset Quotes eld
26939 \end_inset
26940
26941 png
26942 \begin_inset Quotes erd
26943 \end_inset
26944
26945 .
26946  This is useful to avoid uneeded conversions for output formats that support
26947  both PNG and JPEG fomats.
26948  The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26949  output
26950  format.
26951 \end_layout
26952
26953 \begin_layout Description
26954 \begin_inset Flex Code
26955 status collapsed
26956
26957 \begin_layout Plain Layout
26958 $$FName
26959 \end_layout
26960
26961 \end_inset
26962
26963  The filename of the file specified in the external material dialog.
26964  This is either an absolute name, or it is relative to the \SpecialChar LyX
26965  document.
26966 \end_layout
26967
26968 \begin_layout Description
26969 \begin_inset Flex Code
26970 status collapsed
26971
26972 \begin_layout Plain Layout
26973 $$FPath
26974 \end_layout
26975
26976 \end_inset
26977
26978  The path part of 
26979 \begin_inset Flex Code
26980 status collapsed
26981
26982 \begin_layout Plain Layout
26983 $$FName
26984 \end_layout
26985
26986 \end_inset
26987
26988  (absolute name or relative to the \SpecialChar LyX
26989  document).
26990 \end_layout
26991
26992 \begin_layout Description
26993 \begin_inset Flex Code
26994 status collapsed
26995
26996 \begin_layout Plain Layout
26997 $$RelPathMaster
26998 \end_layout
26999
27000 \end_inset
27001
27002  The file path, relative to the master \SpecialChar LyX
27003  document.
27004 \end_layout
27005
27006 \begin_layout Description
27007 \begin_inset Flex Code
27008 status collapsed
27009
27010 \begin_layout Plain Layout
27011 $$RelPathParent
27012 \end_layout
27013
27014 \end_inset
27015
27016  The file path, relative to the \SpecialChar LyX
27017  document.
27018 \end_layout
27019
27020 \begin_layout Description
27021 \begin_inset Flex Code
27022 status collapsed
27023
27024 \begin_layout Plain Layout
27025 $$Sysdir
27026 \end_layout
27027
27028 \end_inset
27029
27030  This macro will expand to the absolute path of the system directory.
27031  This is typically used to point to the various helper scripts that are
27032  bundled with \SpecialChar LyX
27033 .
27034 \end_layout
27035
27036 \begin_layout Description
27037 \begin_inset Flex Code
27038 status collapsed
27039
27040 \begin_layout Plain Layout
27041 $$Tempname
27042 \end_layout
27043
27044 \end_inset
27045
27046  A name and full path to a temporary file which will be automatically deleted
27047  whenever the containing document is closed, or the external material insertion
27048  deleted.
27049 \end_layout
27050
27051 \begin_layout Standard
27052 All path macros contain a trailing directory separator, so you can construct
27053  e.
27054 \begin_inset space \thinspace{}
27055 \end_inset
27056
27057 g.
27058 \begin_inset space \space{}
27059 \end_inset
27060
27061 the absolute filename with 
27062 \begin_inset Flex Code
27063 status collapsed
27064
27065 \begin_layout Plain Layout
27066 $$AbsPath$$Basename$$Extension
27067 \end_layout
27068
27069 \end_inset
27070
27071 .
27072 \end_layout
27073
27074 \begin_layout Standard
27075 The macros above are substituted in all commands unless otherwise noted.
27076  The command 
27077 \begin_inset Flex Code
27078 status collapsed
27079
27080 \begin_layout Plain Layout
27081 Product
27082 \end_layout
27083
27084 \end_inset
27085
27086  supports additionally the following substitutions if they are enabled by
27087  the 
27088 \begin_inset Flex Code
27089 status collapsed
27090
27091 \begin_layout Plain Layout
27092 Transform
27093 \end_layout
27094
27095 \end_inset
27096
27097  and 
27098 \begin_inset Flex Code
27099 status collapsed
27100
27101 \begin_layout Plain Layout
27102 TransformCommand
27103 \end_layout
27104
27105 \end_inset
27106
27107  commands:
27108 \end_layout
27109
27110 \begin_layout Description
27111 \begin_inset Flex Code
27112 status collapsed
27113
27114 \begin_layout Plain Layout
27115 $$ResizeFront
27116 \end_layout
27117
27118 \end_inset
27119
27120  The front part of the resize command.
27121 \end_layout
27122
27123 \begin_layout Description
27124 \begin_inset Flex Code
27125 status collapsed
27126
27127 \begin_layout Plain Layout
27128 $$ResizeBack
27129 \end_layout
27130
27131 \end_inset
27132
27133  The back part of the resize command.
27134 \end_layout
27135
27136 \begin_layout Description
27137 \begin_inset Flex Code
27138 status collapsed
27139
27140 \begin_layout Plain Layout
27141 $$RotateFront
27142 \end_layout
27143
27144 \end_inset
27145
27146  The front part of the rotation command.
27147 \end_layout
27148
27149 \begin_layout Description
27150 \begin_inset Flex Code
27151 status collapsed
27152
27153 \begin_layout Plain Layout
27154 $$RotateBack
27155 \end_layout
27156
27157 \end_inset
27158
27159  The back part of the rotation command.
27160 \end_layout
27161
27162 \begin_layout Standard
27163 The value string of the 
27164 \begin_inset Flex Code
27165 status collapsed
27166
27167 \begin_layout Plain Layout
27168 Option
27169 \end_layout
27170
27171 \end_inset
27172
27173  command supports additionally the following substitutions if they are enabled
27174  by the 
27175 \begin_inset Flex Code
27176 status collapsed
27177
27178 \begin_layout Plain Layout
27179 Transform
27180 \end_layout
27181
27182 \end_inset
27183
27184  and 
27185 \begin_inset Flex Code
27186 status collapsed
27187
27188 \begin_layout Plain Layout
27189 TransformOption
27190 \end_layout
27191
27192 \end_inset
27193
27194  commands:
27195 \end_layout
27196
27197 \begin_layout Description
27198 \begin_inset Flex Code
27199 status collapsed
27200
27201 \begin_layout Plain Layout
27202 $$Clip
27203 \end_layout
27204
27205 \end_inset
27206
27207  The clip option.
27208 \end_layout
27209
27210 \begin_layout Description
27211 \begin_inset Flex Code
27212 status collapsed
27213
27214 \begin_layout Plain Layout
27215 $$Extra
27216 \end_layout
27217
27218 \end_inset
27219
27220  The extra option.
27221 \end_layout
27222
27223 \begin_layout Description
27224 \begin_inset Flex Code
27225 status collapsed
27226
27227 \begin_layout Plain Layout
27228 $$Resize
27229 \end_layout
27230
27231 \end_inset
27232
27233  The resize option.
27234 \end_layout
27235
27236 \begin_layout Description
27237 \begin_inset Flex Code
27238 status collapsed
27239
27240 \begin_layout Plain Layout
27241 $$Rotate
27242 \end_layout
27243
27244 \end_inset
27245
27246  The rotation option.
27247 \end_layout
27248
27249 \begin_layout Standard
27250 You may ask why there are so many path macros.
27251  There are mainly two reasons:
27252 \end_layout
27253
27254 \begin_layout Enumerate
27255 Relative and absolute file names should remain relative or absolute, respectivel
27256 y.
27257  Users may have reasons to prefer either form.
27258  Relative names are useful for portable documents that should work on different
27259  machines, for example.
27260  Absolute names may be required by some programs.
27261 \end_layout
27262
27263 \begin_layout Enumerate
27264 \SpecialChar LaTeX
27265  treats relative file names differently than \SpecialChar LyX
27266  and other programs in nested
27267  included files.
27268  For \SpecialChar LyX
27269 , a relative file name is always relative to the document that contains
27270  the file name.
27271  For \SpecialChar LaTeX
27272 , it is always relative to the master document.
27273  These two definitions are identical if you have only one document, but
27274  differ if you have a master document that includes part documents.
27275  That means that relative filenames must be transformed when presented to
27276  \SpecialChar LaTeX
27277 .
27278  Fortunately \SpecialChar LyX
27279  does this automatically for you if you choose the right macros.
27280 \end_layout
27281
27282 \begin_layout Standard
27283 So which path macro should be used in new template definitions? The rule
27284  is not difficult:
27285 \end_layout
27286
27287 \begin_layout Itemize
27288 Use 
27289 \begin_inset Flex Code
27290 status collapsed
27291
27292 \begin_layout Plain Layout
27293 $$AbsPath
27294 \end_layout
27295
27296 \end_inset
27297
27298  if an absolute path is required.
27299 \end_layout
27300
27301 \begin_layout Itemize
27302 Use 
27303 \begin_inset Flex Code
27304 status collapsed
27305
27306 \begin_layout Plain Layout
27307 $$AbsOrRelPathMaster
27308 \end_layout
27309
27310 \end_inset
27311
27312  if the substituted string is some kind of \SpecialChar LaTeX
27313  input.
27314 \end_layout
27315
27316 \begin_layout Itemize
27317 Else use 
27318 \begin_inset Flex Code
27319 status collapsed
27320
27321 \begin_layout Plain Layout
27322 $$AbsOrRelPathParent
27323 \end_layout
27324
27325 \end_inset
27326
27327  in order to preserve the user's choice.
27328 \end_layout
27329
27330 \begin_layout Standard
27331 There are special cases where this rule does not work and e.
27332 \begin_inset space \thinspace{}
27333 \end_inset
27334
27335 g.
27336 \begin_inset space \space{}
27337 \end_inset
27338
27339 relative names are needed, but normally it will work just fine.
27340  One example for such a case is the command 
27341 \begin_inset Flex Code
27342 status collapsed
27343
27344 \begin_layout Plain Layout
27345 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27346 \end_layout
27347
27348 \end_inset
27349
27350  in the XFig template above: We can't use the absolute name because the
27351  copier for 
27352 \begin_inset Flex Code
27353 status collapsed
27354
27355 \begin_layout Plain Layout
27356 .pstex_t
27357 \end_layout
27358
27359 \end_inset
27360
27361  files needs the relative name in order to rewrite the file content.
27362 \end_layout
27363
27364 \begin_layout Section
27365 Security discussion
27366 \begin_inset CommandInset label
27367 LatexCommand label
27368 name "sec:Security-discussion"
27369
27370 \end_inset
27371
27372
27373 \end_layout
27374
27375 \begin_layout Standard
27376 The external material feature interfaces with a lot of external programs
27377  and does so automatically, so we have to consider the security implications
27378  of this.
27379  In particular, since you have the option of including your own filenames
27380  and/or parameter strings and those are expanded into a command, it seems
27381  that it would be possible to create a malicious document which executes
27382  arbitrary commands when a user views or prints the document.
27383  This is something we definitely want to avoid.
27384 \end_layout
27385
27386 \begin_layout Standard
27387 However, since the external program commands are specified in the template
27388  configuration file only, there are no security issues if \SpecialChar LyX
27389  is properly configure
27390 d with safe templates only.
27391  This is so because the external programs are invoked with the 
27392 \begin_inset Flex Code
27393 status collapsed
27394
27395 \begin_layout Plain Layout
27396 execvp
27397 \end_layout
27398
27399 \end_inset
27400
27401 -system call rather than the 
27402 \begin_inset Flex Code
27403 status collapsed
27404
27405 \begin_layout Plain Layout
27406 system
27407 \end_layout
27408
27409 \end_inset
27410
27411  system-call, so it's not possible to execute arbitrary commands from the
27412  filename or parameter section via the shell.
27413 \end_layout
27414
27415 \begin_layout Standard
27416 This also implies that you are restricted in what command strings you can
27417  use in the external material templates.
27418  In particular, pipes and redirection are not readily available.
27419  This has to be so if \SpecialChar LyX
27420  should remain safe.
27421  If you want to use some of the shell features, you should write a safe
27422  script to do this in a controlled manner, and then invoke the script from
27423  the command string.
27424  
27425 \end_layout
27426
27427 \begin_layout Standard
27428 It is possible to design a template that interacts directly with the shell,
27429  but since this would allow a malicious user to execute arbitrary commands
27430  by writing clever filenames and/or parameters, we generally recommend that
27431  you only use safe scripts that work with the 
27432 \begin_inset Flex Code
27433 status collapsed
27434
27435 \begin_layout Plain Layout
27436 execvp
27437 \end_layout
27438
27439 \end_inset
27440
27441  system call in a controlled manner.
27442  Of course, for use in a controlled environment, it can be tempting to just
27443  fall back to use ordinary shell scripts.
27444  If you do so, be aware that you 
27445 \emph on
27446 will
27447 \emph default
27448  provide an easily exploitable security hole in your system.
27449  Of course it stands to reason that such unsafe templates will never be
27450  included in the standard \SpecialChar LyX
27451  distribution, although we do encourage people
27452  to submit new templates in the open source tradition.
27453  But \SpecialChar LyX
27454  as shipped from the official distribution channels will never have
27455  unsafe templates.
27456 \end_layout
27457
27458 \begin_layout Standard
27459 Including external material provides a lot of power, and you have to be
27460  careful not to introduce security hazards with this power.
27461  A subtle error in a single line in an innocent looking script can open
27462  the door to huge security problems.
27463  So if you do not fully understand the issues, we recommend that you consult
27464  a knowledgeable security professional or the \SpecialChar LyX
27465  development team if you have
27466  any questions about whether a given template is safe or not.
27467  And do this before you use it in an uncontrolled environment.
27468 \end_layout
27469
27470 \begin_layout Chapter
27471 \start_of_appendix
27472 List of supported \SpecialChar LyX
27473  functions to be used in layouts
27474 \begin_inset CommandInset label
27475 LatexCommand label
27476 name "chap:List-of-functions"
27477
27478 \end_inset
27479
27480
27481 \end_layout
27482
27483 \begin_layout Standard
27484 \align center
27485 \begin_inset Tabular
27486 <lyxtabular version="3" rows="11" columns="8">
27487 <features tabularvalignment="middle">
27488 <column alignment="left" valignment="top">
27489 <column alignment="left" valignment="top">
27490 <column alignment="left" valignment="top">
27491 <column alignment="left" valignment="top">
27492 <column alignment="left" valignment="top">
27493 <column alignment="left" valignment="top">
27494 <column alignment="left" valignment="top">
27495 <column alignment="left" valignment="top">
27496 <row>
27497 <cell alignment="left" valignment="top" usebox="none">
27498 \begin_inset Text
27499
27500 \begin_layout Plain Layout
27501 accents
27502 \end_layout
27503
27504 \end_inset
27505 </cell>
27506 <cell alignment="left" valignment="top" usebox="none">
27507 \begin_inset Text
27508
27509 \begin_layout Plain Layout
27510 booktabs
27511 \end_layout
27512
27513 \end_inset
27514 </cell>
27515 <cell alignment="left" valignment="top" usebox="none">
27516 \begin_inset Text
27517
27518 \begin_layout Plain Layout
27519 feyn
27520 \end_layout
27521
27522 \end_inset
27523 </cell>
27524 <cell alignment="left" valignment="top" usebox="none">
27525 \begin_inset Text
27526
27527 \begin_layout Plain Layout
27528 listings
27529 \end_layout
27530
27531 \end_inset
27532 </cell>
27533 <cell alignment="center" valignment="top" usebox="none">
27534 \begin_inset Text
27535
27536 \begin_layout Plain Layout
27537 natbib
27538 \end_layout
27539
27540 \end_inset
27541 </cell>
27542 <cell alignment="center" valignment="top" usebox="none">
27543 \begin_inset Text
27544
27545 \begin_layout Plain Layout
27546 rotfloat
27547 \end_layout
27548
27549 \end_inset
27550 </cell>
27551 <cell alignment="center" valignment="top" usebox="none">
27552 \begin_inset Text
27553
27554 \begin_layout Plain Layout
27555 tfrupee
27556 \end_layout
27557
27558 \end_inset
27559 </cell>
27560 <cell alignment="center" valignment="top" usebox="none">
27561 \begin_inset Text
27562
27563 \begin_layout Plain Layout
27564 wasysym
27565 \end_layout
27566
27567 \end_inset
27568 </cell>
27569 </row>
27570 <row>
27571 <cell alignment="left" valignment="top" usebox="none">
27572 \begin_inset Text
27573
27574 \begin_layout Plain Layout
27575 amsbsy
27576 \end_layout
27577
27578 \end_inset
27579 </cell>
27580 <cell alignment="left" valignment="top" usebox="none">
27581 \begin_inset Text
27582
27583 \begin_layout Plain Layout
27584 calc
27585 \end_layout
27586
27587 \end_inset
27588 </cell>
27589 <cell alignment="left" valignment="top" usebox="none">
27590 \begin_inset Text
27591
27592 \begin_layout Plain Layout
27593 fixltx2e
27594 \end_layout
27595
27596 \end_inset
27597 </cell>
27598 <cell alignment="left" valignment="top" usebox="none">
27599 \begin_inset Text
27600
27601 \begin_layout Plain Layout
27602 longtable
27603 \end_layout
27604
27605 \end_inset
27606 </cell>
27607 <cell alignment="center" valignment="top" usebox="none">
27608 \begin_inset Text
27609
27610 \begin_layout Plain Layout
27611 nomencl
27612 \end_layout
27613
27614 \end_inset
27615 </cell>
27616 <cell alignment="center" valignment="top" usebox="none">
27617 \begin_inset Text
27618
27619 \begin_layout Plain Layout
27620 rsphrase
27621 \end_layout
27622
27623 \end_inset
27624 </cell>
27625 <cell alignment="center" valignment="top" usebox="none">
27626 \begin_inset Text
27627
27628 \begin_layout Plain Layout
27629 tipa
27630 \end_layout
27631
27632 \end_inset
27633 </cell>
27634 <cell alignment="center" valignment="top" usebox="none">
27635 \begin_inset Text
27636
27637 \begin_layout Plain Layout
27638 wrapfig
27639 \end_layout
27640
27641 \end_inset
27642 </cell>
27643 </row>
27644 <row>
27645 <cell alignment="left" valignment="top" usebox="none">
27646 \begin_inset Text
27647
27648 \begin_layout Plain Layout
27649 amscd
27650 \end_layout
27651
27652 \end_inset
27653 </cell>
27654 <cell alignment="left" valignment="top" usebox="none">
27655 \begin_inset Text
27656
27657 \begin_layout Plain Layout
27658 CJK
27659 \end_layout
27660
27661 \end_inset
27662 </cell>
27663 <cell alignment="left" valignment="top" usebox="none">
27664 \begin_inset Text
27665
27666 \begin_layout Plain Layout
27667 float
27668 \end_layout
27669
27670 \end_inset
27671 </cell>
27672 <cell alignment="left" valignment="top" usebox="none">
27673 \begin_inset Text
27674
27675 \begin_layout Plain Layout
27676 lyxskak
27677 \end_layout
27678
27679 \end_inset
27680 </cell>
27681 <cell alignment="center" valignment="top" usebox="none">
27682 \begin_inset Text
27683
27684 \begin_layout Plain Layout
27685 pdfcolmk
27686 \end_layout
27687
27688 \end_inset
27689 </cell>
27690 <cell alignment="center" valignment="top" usebox="none">
27691 \begin_inset Text
27692
27693 \begin_layout Plain Layout
27694 setspace
27695 \end_layout
27696
27697 \end_inset
27698 </cell>
27699 <cell alignment="center" valignment="top" usebox="none">
27700 \begin_inset Text
27701
27702 \begin_layout Plain Layout
27703 tipx
27704 \end_layout
27705
27706 \end_inset
27707 </cell>
27708 <cell alignment="center" valignment="top" usebox="none">
27709 \begin_inset Text
27710
27711 \begin_layout Plain Layout
27712 xargs
27713 \end_layout
27714
27715 \end_inset
27716 </cell>
27717 </row>
27718 <row>
27719 <cell alignment="left" valignment="top" usebox="none">
27720 \begin_inset Text
27721
27722 \begin_layout Plain Layout
27723 amsmath
27724 \end_layout
27725
27726 \end_inset
27727 </cell>
27728 <cell alignment="left" valignment="top" usebox="none">
27729 \begin_inset Text
27730
27731 \begin_layout Plain Layout
27732 color
27733 \end_layout
27734
27735 \end_inset
27736 </cell>
27737 <cell alignment="left" valignment="top" usebox="none">
27738 \begin_inset Text
27739
27740 \begin_layout Plain Layout
27741 framed
27742 \end_layout
27743
27744 \end_inset
27745 </cell>
27746 <cell alignment="left" valignment="top" usebox="none">
27747 \begin_inset Text
27748
27749 \begin_layout Plain Layout
27750 makeidx
27751 \end_layout
27752
27753 \end_inset
27754 </cell>
27755 <cell alignment="center" valignment="top" usebox="none">
27756 \begin_inset Text
27757
27758 \begin_layout Plain Layout
27759 pdfpages
27760 \end_layout
27761
27762 \end_inset
27763 </cell>
27764 <cell alignment="center" valignment="top" usebox="none">
27765 \begin_inset Text
27766
27767 \begin_layout Plain Layout
27768 shapepar
27769 \end_layout
27770
27771 \end_inset
27772 </cell>
27773 <cell alignment="center" valignment="top" usebox="none">
27774 \begin_inset Text
27775
27776 \begin_layout Plain Layout
27777 tone
27778 \end_layout
27779
27780 \end_inset
27781 </cell>
27782 <cell alignment="center" valignment="top" usebox="none">
27783 \begin_inset Text
27784
27785 \begin_layout Plain Layout
27786 xcolor
27787 \end_layout
27788
27789 \end_inset
27790 </cell>
27791 </row>
27792 <row>
27793 <cell alignment="left" valignment="top" usebox="none">
27794 \begin_inset Text
27795
27796 \begin_layout Plain Layout
27797 amssymb
27798 \end_layout
27799
27800 \end_inset
27801 </cell>
27802 <cell alignment="left" valignment="top" usebox="none">
27803 \begin_inset Text
27804
27805 \begin_layout Plain Layout
27806 covington
27807 \end_layout
27808
27809 \end_inset
27810 </cell>
27811 <cell alignment="left" valignment="top" usebox="none">
27812 \begin_inset Text
27813
27814 \begin_layout Plain Layout
27815 graphicx
27816 \end_layout
27817
27818 \end_inset
27819 </cell>
27820 <cell alignment="left" valignment="top" usebox="none">
27821 \begin_inset Text
27822
27823 \begin_layout Plain Layout
27824 marvosym
27825 \end_layout
27826
27827 \end_inset
27828 </cell>
27829 <cell alignment="center" valignment="top" usebox="none">
27830 \begin_inset Text
27831
27832 \begin_layout Plain Layout
27833 pifont
27834 \end_layout
27835
27836 \end_inset
27837 </cell>
27838 <cell alignment="center" valignment="top" usebox="none">
27839 \begin_inset Text
27840
27841 \begin_layout Plain Layout
27842 slashed
27843 \end_layout
27844
27845 \end_inset
27846 </cell>
27847 <cell alignment="center" valignment="top" usebox="none">
27848 \begin_inset Text
27849
27850 \begin_layout Plain Layout
27851 txfonts
27852 \end_layout
27853
27854 \end_inset
27855 </cell>
27856 <cell alignment="center" valignment="top" usebox="none">
27857 \begin_inset Text
27858
27859 \begin_layout Plain Layout
27860 xy
27861 \end_layout
27862
27863 \end_inset
27864 </cell>
27865 </row>
27866 <row>
27867 <cell alignment="left" valignment="top" usebox="none">
27868 \begin_inset Text
27869
27870 \begin_layout Plain Layout
27871 amstext
27872 \end_layout
27873
27874 \end_inset
27875 </cell>
27876 <cell alignment="left" valignment="top" usebox="none">
27877 \begin_inset Text
27878
27879 \begin_layout Plain Layout
27880 csquotes
27881 \end_layout
27882
27883 \end_inset
27884 </cell>
27885 <cell alignment="left" valignment="top" usebox="none">
27886 \begin_inset Text
27887
27888 \begin_layout Plain Layout
27889 hhline
27890 \end_layout
27891
27892 \end_inset
27893 </cell>
27894 <cell alignment="left" valignment="top" usebox="none">
27895 \begin_inset Text
27896
27897 \begin_layout Plain Layout
27898 mathdesign
27899 \end_layout
27900
27901 \end_inset
27902 </cell>
27903 <cell alignment="center" valignment="top" usebox="none">
27904 \begin_inset Text
27905
27906 \begin_layout Plain Layout
27907 pmboxdraw
27908 \end_layout
27909
27910 \end_inset
27911 </cell>
27912 <cell alignment="center" valignment="top" usebox="none">
27913 \begin_inset Text
27914
27915 \begin_layout Plain Layout
27916 soul
27917 \end_layout
27918
27919 \end_inset
27920 </cell>
27921 <cell alignment="center" valignment="top" usebox="none">
27922 \begin_inset Text
27923
27924 \begin_layout Plain Layout
27925 ulem
27926 \end_layout
27927
27928 \end_inset
27929 </cell>
27930 <cell alignment="center" valignment="top" usebox="none">
27931 \begin_inset Text
27932
27933 \begin_layout Plain Layout
27934 yhmath
27935 \end_layout
27936
27937 \end_inset
27938 </cell>
27939 </row>
27940 <row>
27941 <cell alignment="left" valignment="top" usebox="none">
27942 \begin_inset Text
27943
27944 \begin_layout Plain Layout
27945 amsthm
27946 \end_layout
27947
27948 \end_inset
27949 </cell>
27950 <cell alignment="left" valignment="top" usebox="none">
27951 \begin_inset Text
27952
27953 \begin_layout Plain Layout
27954 dvipost
27955 \end_layout
27956
27957 \end_inset
27958 </cell>
27959 <cell alignment="left" valignment="top" usebox="none">
27960 \begin_inset Text
27961
27962 \begin_layout Plain Layout
27963 hyperref
27964 \end_layout
27965
27966 \end_inset
27967 </cell>
27968 <cell alignment="left" valignment="top" usebox="none">
27969 \begin_inset Text
27970
27971 \begin_layout Plain Layout
27972 mathdots
27973 \end_layout
27974
27975 \end_inset
27976 </cell>
27977 <cell alignment="center" valignment="top" usebox="none">
27978 \begin_inset Text
27979
27980 \begin_layout Plain Layout
27981 polyglossia
27982 \end_layout
27983
27984 \end_inset
27985 </cell>
27986 <cell alignment="center" valignment="top" usebox="none">
27987 \begin_inset Text
27988
27989 \begin_layout Plain Layout
27990 splitidx
27991 \end_layout
27992
27993 \end_inset
27994 </cell>
27995 <cell alignment="center" valignment="top" usebox="none">
27996 \begin_inset Text
27997
27998 \begin_layout Plain Layout
27999 undertilde
28000 \end_layout
28001
28002 \end_inset
28003 </cell>
28004 <cell alignment="center" valignment="top" usebox="none">
28005 \begin_inset Text
28006
28007 \begin_layout Plain Layout
28008
28009 \end_layout
28010
28011 \end_inset
28012 </cell>
28013 </row>
28014 <row>
28015 <cell alignment="left" valignment="top" usebox="none">
28016 \begin_inset Text
28017
28018 \begin_layout Plain Layout
28019 array
28020 \end_layout
28021
28022 \end_inset
28023 </cell>
28024 <cell alignment="left" valignment="top" usebox="none">
28025 \begin_inset Text
28026
28027 \begin_layout Plain Layout
28028 endnotes
28029 \end_layout
28030
28031 \end_inset
28032 </cell>
28033 <cell alignment="left" valignment="top" usebox="none">
28034 \begin_inset Text
28035
28036 \begin_layout Plain Layout
28037 ifsym
28038 \end_layout
28039
28040 \end_inset
28041 </cell>
28042 <cell alignment="left" valignment="top" usebox="none">
28043 \begin_inset Text
28044
28045 \begin_layout Plain Layout
28046 mathrsfs
28047 \end_layout
28048
28049 \end_inset
28050 </cell>
28051 <cell alignment="center" valignment="top" usebox="none">
28052 \begin_inset Text
28053
28054 \begin_layout Plain Layout
28055 prettyref
28056 \end_layout
28057
28058 \end_inset
28059 </cell>
28060 <cell alignment="center" valignment="top" usebox="none">
28061 \begin_inset Text
28062
28063 \begin_layout Plain Layout
28064 subfig
28065 \end_layout
28066
28067 \end_inset
28068 </cell>
28069 <cell alignment="center" valignment="top" usebox="none">
28070 \begin_inset Text
28071
28072 \begin_layout Plain Layout
28073 units
28074 \end_layout
28075
28076 \end_inset
28077 </cell>
28078 <cell alignment="center" valignment="top" usebox="none">
28079 \begin_inset Text
28080
28081 \begin_layout Plain Layout
28082
28083 \end_layout
28084
28085 \end_inset
28086 </cell>
28087 </row>
28088 <row>
28089 <cell alignment="left" valignment="top" usebox="none">
28090 \begin_inset Text
28091
28092 \begin_layout Plain Layout
28093 ascii
28094 \end_layout
28095
28096 \end_inset
28097 </cell>
28098 <cell alignment="left" valignment="top" usebox="none">
28099 \begin_inset Text
28100
28101 \begin_layout Plain Layout
28102 enumitem
28103 \end_layout
28104
28105 \end_inset
28106 </cell>
28107 <cell alignment="left" valignment="top" usebox="none">
28108 \begin_inset Text
28109
28110 \begin_layout Plain Layout
28111 ifthen
28112 \end_layout
28113
28114 \end_inset
28115 </cell>
28116 <cell alignment="left" valignment="top" usebox="none">
28117 \begin_inset Text
28118
28119 \begin_layout Plain Layout
28120 mhchem
28121 \end_layout
28122
28123 \end_inset
28124 </cell>
28125 <cell alignment="center" valignment="top" usebox="none">
28126 \begin_inset Text
28127
28128 \begin_layout Plain Layout
28129 pxfonts
28130 \end_layout
28131
28132 \end_inset
28133 </cell>
28134 <cell alignment="center" valignment="top" usebox="none">
28135 \begin_inset Text
28136
28137 \begin_layout Plain Layout
28138 subscript
28139 \end_layout
28140
28141 \end_inset
28142 </cell>
28143 <cell alignment="center" valignment="top" usebox="none">
28144 \begin_inset Text
28145
28146 \begin_layout Plain Layout
28147 url
28148 \end_layout
28149
28150 \end_inset
28151 </cell>
28152 <cell alignment="center" valignment="top" usebox="none">
28153 \begin_inset Text
28154
28155 \begin_layout Plain Layout
28156
28157 \end_layout
28158
28159 \end_inset
28160 </cell>
28161 </row>
28162 <row>
28163 <cell alignment="left" valignment="top" usebox="none">
28164 \begin_inset Text
28165
28166 \begin_layout Plain Layout
28167 bbding
28168 \end_layout
28169
28170 \end_inset
28171 </cell>
28172 <cell alignment="left" valignment="top" usebox="none">
28173 \begin_inset Text
28174
28175 \begin_layout Plain Layout
28176 esint
28177 \end_layout
28178
28179 \end_inset
28180 </cell>
28181 <cell alignment="left" valignment="top" usebox="none">
28182 \begin_inset Text
28183
28184 \begin_layout Plain Layout
28185 jurabib
28186 \end_layout
28187
28188 \end_inset
28189 </cell>
28190 <cell alignment="left" valignment="top" usebox="none">
28191 \begin_inset Text
28192
28193 \begin_layout Plain Layout
28194 multicol
28195 \end_layout
28196
28197 \end_inset
28198 </cell>
28199 <cell alignment="center" valignment="top" usebox="none">
28200 \begin_inset Text
28201
28202 \begin_layout Plain Layout
28203 refstyle
28204 \end_layout
28205
28206 \end_inset
28207 </cell>
28208 <cell alignment="center" valignment="top" usebox="none">
28209 \begin_inset Text
28210
28211 \begin_layout Plain Layout
28212 textcomp
28213 \end_layout
28214
28215 \end_inset
28216 </cell>
28217 <cell alignment="center" valignment="top" usebox="none">
28218 \begin_inset Text
28219
28220 \begin_layout Plain Layout
28221 varioref
28222 \end_layout
28223
28224 \end_inset
28225 </cell>
28226 <cell alignment="center" valignment="top" usebox="none">
28227 \begin_inset Text
28228
28229 \begin_layout Plain Layout
28230
28231 \end_layout
28232
28233 \end_inset
28234 </cell>
28235 </row>
28236 <row>
28237 <cell alignment="center" valignment="top" usebox="none">
28238 \begin_inset Text
28239
28240 \begin_layout Plain Layout
28241 bm
28242 \end_layout
28243
28244 \end_inset
28245 </cell>
28246 <cell alignment="center" valignment="top" usebox="none">
28247 \begin_inset Text
28248
28249 \begin_layout Plain Layout
28250 fancybox
28251 \end_layout
28252
28253 \end_inset
28254 </cell>
28255 <cell alignment="center" valignment="top" usebox="none">
28256 \begin_inset Text
28257
28258 \begin_layout Plain Layout
28259 latexsym
28260 \end_layout
28261
28262 \end_inset
28263 </cell>
28264 <cell alignment="center" valignment="top" usebox="none">
28265 \begin_inset Text
28266
28267 \begin_layout Plain Layout
28268 multirow
28269 \end_layout
28270
28271 \end_inset
28272 </cell>
28273 <cell alignment="center" valignment="top" usebox="none">
28274 \begin_inset Text
28275
28276 \begin_layout Plain Layout
28277 rotating
28278 \end_layout
28279
28280 \end_inset
28281 </cell>
28282 <cell alignment="center" valignment="top" usebox="none">
28283 \begin_inset Text
28284
28285 \begin_layout Plain Layout
28286 textgreek
28287 \end_layout
28288
28289 \end_inset
28290 </cell>
28291 <cell alignment="center" valignment="top" usebox="none">
28292 \begin_inset Text
28293
28294 \begin_layout Plain Layout
28295 verbatim
28296 \end_layout
28297
28298 \end_inset
28299 </cell>
28300 <cell alignment="center" valignment="top" usebox="none">
28301 \begin_inset Text
28302
28303 \begin_layout Plain Layout
28304
28305 \end_layout
28306
28307 \end_inset
28308 </cell>
28309 </row>
28310 </lyxtabular>
28311
28312 \end_inset
28313
28314
28315 \end_layout
28316
28317 \begin_layout Chapter
28318 Names of available colors to be used in layouts
28319 \begin_inset CommandInset label
28320 LatexCommand label
28321 name "chap:Names-of-colors"
28322
28323 \end_inset
28324
28325
28326 \end_layout
28327
28328 \begin_layout Standard
28329 The colors listed here are the standard colors and the those that you can
28330  adjust in the \SpecialChar LyX
28331  preferences.
28332 \end_layout
28333
28334 \begin_layout Description
28335 none
28336 \family roman
28337 \series medium
28338 \shape up
28339 \size normal
28340 \emph off
28341 \bar no
28342 \strikeout off
28343 \uuline off
28344 \uwave off
28345 \noun off
28346 \color none
28347  No particular color – clear or default
28348 \end_layout
28349
28350 \begin_layout Description
28351 black
28352 \end_layout
28353
28354 \begin_layout Description
28355 white
28356 \end_layout
28357
28358 \begin_layout Description
28359 red
28360 \end_layout
28361
28362 \begin_layout Description
28363 green
28364 \end_layout
28365
28366 \begin_layout Description
28367 blue
28368 \end_layout
28369
28370 \begin_layout Description
28371 cyan
28372 \end_layout
28373
28374 \begin_layout Description
28375 magenta
28376 \end_layout
28377
28378 \begin_layout Description
28379 yellow
28380 \end_layout
28381
28382 \begin_layout Description
28383 added_space Added space marker color
28384 \end_layout
28385
28386 \begin_layout Description
28387 addedtext Added text color
28388 \end_layout
28389
28390 \begin_layout Description
28391 appendix Appendix marker color
28392 \end_layout
28393
28394 \begin_layout Description
28395 background Background color
28396 \end_layout
28397
28398 \begin_layout Description
28399 bottomarea Bottom area color
28400 \end_layout
28401
28402 \begin_layout Description
28403 branchlabel Label color for branches
28404 \end_layout
28405
28406 \begin_layout Description
28407 buttonbg Color used for button background
28408 \end_layout
28409
28410 \begin_layout Description
28411 buttonhoverbg Color used for button background under focus
28412 \end_layout
28413
28414 \begin_layout Description
28415 buttonframe Color for inset button frames
28416 \end_layout
28417
28418 \begin_layout Description
28419 changebar Changebar color
28420 \end_layout
28421
28422 \begin_layout Description
28423 changedtextauthor1 Changed text color author 1
28424 \end_layout
28425
28426 \begin_layout Description
28427 changedtextauthor2 Changed text color author 2
28428 \end_layout
28429
28430 \begin_layout Description
28431 changedtextauthor3 Changed text color author 3
28432 \end_layout
28433
28434 \begin_layout Description
28435 changedtextauthor4 Changed text color author 4
28436 \end_layout
28437
28438 \begin_layout Description
28439 changedtextauthor5 Changed text color author 5
28440 \end_layout
28441
28442 \begin_layout Description
28443 collapsable_inset_frame Collapsable insets framecolor
28444 \end_layout
28445
28446 \begin_layout Description
28447 collapsable_inset_text Collapsable insets text color
28448 \end_layout
28449
28450 \begin_layout Description
28451 command Text color for command insets
28452 \end_layout
28453
28454 \begin_layout Description
28455 commandbg Background color for command insets
28456 \end_layout
28457
28458 \begin_layout Description
28459 commandframe Frame color for command insets
28460 \end_layout
28461
28462 \begin_layout Description
28463 comment color for comments
28464 \end_layout
28465
28466 \begin_layout Description
28467 commentbg Background color of comments
28468 \end_layout
28469
28470 \begin_layout Description
28471 cursor Cursor color
28472 \end_layout
28473
28474 \begin_layout Description
28475 deletedtext Deleted text color
28476 \end_layout
28477
28478 \begin_layout Description
28479 deletedtextmodifier Deleted text modifying color
28480 \end_layout
28481
28482 \begin_layout Description
28483 depthbar Color for the depth bars in the margin
28484 \end_layout
28485
28486 \begin_layout Description
28487 eolmarker End of line marker color
28488 \end_layout
28489
28490 \begin_layout Description
28491 error Color of the \SpecialChar LaTeX
28492  error box
28493 \end_layout
28494
28495 \begin_layout Description
28496 footlabel Label color for footnotes
28497 \end_layout
28498
28499 \begin_layout Description
28500 graphicsbg Graphics inset background color
28501 \end_layout
28502
28503 \begin_layout Description
28504 greyedout Label color for greyedout insets
28505 \end_layout
28506
28507 \begin_layout Description
28508 greyedoutbg Background color of greyedout inset
28509 \end_layout
28510
28511 \begin_layout Description
28512 greyedouttext Color for greyedout inset text
28513 \end_layout
28514
28515 \begin_layout Description
28516 indexlabel Label color for index insets
28517 \end_layout
28518
28519 \begin_layout Description
28520 ignore The color is ignored
28521 \end_layout
28522
28523 \begin_layout Description
28524 inherit The color is inherited
28525 \end_layout
28526
28527 \begin_layout Description
28528 inlinecompletion Inline completion color
28529 \end_layout
28530
28531 \begin_layout Description
28532 insetbg Inset marker background color
28533 \end_layout
28534
28535 \begin_layout Description
28536 insetframe Inset marker frame color
28537 \end_layout
28538
28539 \begin_layout Description
28540 language Color for marking foreign language words
28541 \end_layout
28542
28543 \begin_layout Description
28544 latex Text color in \SpecialChar LaTeX
28545  mode
28546 \end_layout
28547
28548 \begin_layout Description
28549 listingsbg Background color of listings inset
28550 \end_layout
28551
28552 \begin_layout Description
28553 marginlabel Label color for margin notes
28554 \end_layout
28555
28556 \begin_layout Description
28557 math Math inset text color
28558 \end_layout
28559
28560 \begin_layout Description
28561 mathbg Math inset background color
28562 \end_layout
28563
28564 \begin_layout Description
28565 mathcorners Math inset frame color not under focus
28566 \end_layout
28567
28568 \begin_layout Description
28569 mathframe Math inset frame color under focus
28570 \end_layout
28571
28572 \begin_layout Description
28573 mathline Math line color
28574 \end_layout
28575
28576 \begin_layout Description
28577 mathmacrobg Macro math inset background color
28578 \end_layout
28579
28580 \begin_layout Description
28581 mathmacroblend Macro math blended color
28582 \end_layout
28583
28584 \begin_layout Description
28585 mathmacroframe Macro math frame color
28586 \end_layout
28587
28588 \begin_layout Description
28589 mathmacrohoverbg Macro math inset background color hovered
28590 \end_layout
28591
28592 \begin_layout Description
28593 mathmacrolabel Macro math label color
28594 \end_layout
28595
28596 \begin_layout Description
28597 mathmacronewarg Macro template color for new parameters
28598 \end_layout
28599
28600 \begin_layout Description
28601 mathmacrooldarg Macro template color for old parameters
28602 \end_layout
28603
28604 \begin_layout Description
28605 newpage New page color
28606 \end_layout
28607
28608 \begin_layout Description
28609 nonunique_inlinecompletion Inline completion color for the non-unique part
28610 \end_layout
28611
28612 \begin_layout Description
28613 notebg Background color of notes
28614 \end_layout
28615
28616 \begin_layout Description
28617 notelabel Label color for notes
28618 \end_layout
28619
28620 \begin_layout Description
28621 pagebreak Page break/line break color
28622 \end_layout
28623
28624 \begin_layout Description
28625 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28626 \end_layout
28627
28628 \begin_layout Description
28629 phantomtext Text color for phantom insets
28630 \end_layout
28631
28632 \begin_layout Description
28633 preview The color used for previews
28634 \end_layout
28635
28636 \begin_layout Description
28637 previewframe Preview frame color
28638 \end_layout
28639
28640 \begin_layout Description
28641 regexpframe Color for regexp frame
28642 \end_layout
28643
28644 \begin_layout Description
28645 selection Background color of selected text
28646 \end_layout
28647
28648 \begin_layout Description
28649 selectiontext Foreground color of selected text
28650 \end_layout
28651
28652 \begin_layout Description
28653 shadedbg Background color of shaded box
28654 \end_layout
28655
28656 \begin_layout Description
28657 special Special chars text color
28658 \end_layout
28659
28660 \begin_layout Description
28661 tabularline Table line color
28662 \end_layout
28663
28664 \begin_layout Description
28665 tabularonoffline Table line color
28666 \end_layout
28667
28668 \begin_layout Description
28669 urllabel Label color for URL insets
28670 \end_layout
28671
28672 \begin_layout Description
28673 urltext Color for URL inset text
28674 \end_layout
28675
28676 \end_body
28677 \end_document