]> git.lyx.org Git - lyx.git/blobdiff - lib/layouts/IEEEtran.layout
Update description to reflect arg improvements
[lyx.git] / lib / layouts / IEEEtran.layout
index 98217dea2a8cdcd3b39622ba386f7bfb50cdf548..d97fb4b8a01c0a7d9401f240768fc664ff95cc3a 100644 (file)
 #% Do not delete he line below; configure depends on this
-#  \DeclareLaTeXClass{article (IEEEtran)}
-# Based on Article textclass definition file. 
-#
+#  \DeclareLaTeXClass{IEEE Transactions}
+#  \DeclareCategory{Articles}
 # Author : Allan Rae <rae@lyx.org>
 #
-# IEEEtran is the class used for submitting to any of the IEEE Transactions.
-# The on-screen display in LyX is set to reflect the appearance of two column
-# text.  The section counters appear correctly in the output but are
-# in arabic numerals in LyX -- this requires some additional code in LyX
-# to get right (maybe LyX-2.0 ;-).
-#
-# IEEEtran.cls can be obtained from the www.ieee.org website -- look for
-# the author information area.  There is a LaTeX 2.09 IEEEtran.sty available
-# also but LyX doesn't support 2.09 stuff so don't get that one.
+# revised for IEEEtran version 1.7a
+# Author: Uwe Stöhr (uwestoehr@web.de)
 #
-# Input general definitions
+# IEEtran textclass definition file.
+
 
-Columns                 1
-Sides                   1
-MaxCounter             Counter_Section
-SecNumDepth            3
-TocDepth               3
+Format 54
+
+Sides          1
+SecNumDepth    3
+TocDepth       3
+DefaultStyle   Standard
 
 ClassOptions
-  FontSize              9|10|11|12
-End  
+  FontSize     9|10|11|12
+end
+
 
+# This is just to show how to declare the default font.
+# The defaults are exactly those shown here.
 DefaultFont
-  Family               Roman
-  Series               Medium
-  Shape                        Up
-  Size                 Normal
-  Color                        None
+  Family       Roman
+  Series       Medium
+  Shape                Up
+  Size         Normal
+  Color                None
 EndFont
 
-# Standard style definition
-Style Standard
-  Margin               Static
-  LatexType            Paragraph
-  LatexName            dummy
-  ParIndent            MM
-  ParSkip              0.4
-  Align                Block
-  AlignPossible        Block, Left, Right, Center
-  LabelType            No_Label
-End
 
-##
-## stdlists
-##
-Input stdlists.inc
-
-# 
-# First cut at theorem environment support.
-# What other theorem-like environments are needed?
-# How many of these should be discarded?
-# I got this list from amsmaths*.inc but I haven't
-# found an official list of theorem environments for
-# IEEE Transactions.
-# OH!  and all theorems are numbered.  Is that a problem?
-# Tell me:  rae@lyx.org
-#
-# Theorem-numbered style *Template* declaration
-Style TheoremTemplate
-  Margin               First_Dynamic
-  LatexType            Environment
-  LabelSep             M
-  ParIndent            MM
-  ParSep               0.4
-  Align                        Block
-  AlignPossible                Block, Left
-  LabelType            Static
-
-  # label font definition
-  LabelFont
-    Shape              Italic
-  EndFont
+Style Standard
+  Category     MainText
+  Margin       Static
+  LatexType    Paragraph
+  LatexName    dummy
+  ParIndent    MM
+  ParSkip      0.4
+  Align                Block
+  AlignPossible        Block, Left, Right, Center
+  LabelType    No_Label
 End
 
-# Proof style declaration
-Style Proof
-  CopyStyle            TheoremTemplate
-  LatexName            proof
-  LabelString          "Proof:"
-  EndLabelType          Filled_Box
+Counter                theorem
 End
 
-# Theorem-numbered style declaration
-Style Theorem
-  CopyStyle            TheoremTemplate
-  LatexName            thm
-  LabelString          "Theorem #:"
-
-  Preamble
-    \newtheorem{thm}{Theorem}
-  EndPreamble
-End  
-
-# Lemma-numbered style declaration
-Style Lemma
-  CopyStyle            TheoremTemplate
-  LatexName            lemma
-  LabelString          "Lemma #:"
-
-  Preamble
-    \newtheorem{lemma}{Lemma}
-  EndPreamble
-End  
-
-# Corollary-numbered style declaration
-Style Corollary
-  CopyStyle            TheoremTemplate
-  LatexName            cor
-  LabelString          "Corollary #:"
+Input stdcounters.inc
+Input stdfloats.inc
+Input stdlists.inc
+Input stdsections.inc
+Input stdstarsections.inc
+Input stdlayouts.inc
+Input lyxmacros.inc
 
-  Preamble
-    \newtheorem{cor}{Corollary}
-  EndPreamble
+ProvidesModule theorems-std
+Input theorems.inc
+
+NoStyle Chapter
+NoCounter chapter
+NoStyle Chapter*
+
+
+Style Title
+  Margin       Static
+  LatexType    Command
+  LatexName    title
+  Category     FrontMatter
+  InTitle      1
+  ResetArgs    1
+  ParSkip      0.4
+  ItemSep      0
+  TopSep       0
+  BottomSep    1
+  ParSep       1
+  Align                Center
+  LabelType    No_Label
+  Font
+    Size       Largest
+  EndFont
 End
 
-# Proposition-numbered style declaration
-Style Proposition
-  CopyStyle            TheoremTemplate
-  LatexName            prop
-  LabelString          "Proposition #:"
-
-  Preamble
-    \newtheorem{prop}{Proposition}
-  EndPreamble
-End  
-
-# Conjecture-numbered style declaration
-Style Conjecture
-  CopyStyle            TheoremTemplate
-  LatexName            conject
-  LabelString          "Conjecture #:"
-
-  Preamble
-    \newtheorem{conject}{Conjecture}
-  EndPreamble
-End  
-
-# Criterion-numbered style declaration
-Style Criterion
-  CopyStyle            TheoremTemplate
-  LatexName            criter
-  LabelString          "Criterion #:"
-
-  Preamble
-    \newtheorem{criter}{Criterion}
-  EndPreamble
-End  
-
-# Fact-numbered style declaration
-Style Fact
-  CopyStyle            TheoremTemplate
-  LatexName            fact
-  LabelString          "Fact #:"
-
-  Preamble
-    \newtheorem{fact}{Fact}
-  EndPreamble
-End  
 
-# Axiom-numbered style declaration
-Style Axiom
-  CopyStyle            TheoremTemplate
-  LatexName            axi
-  LabelString          "Axiom #:"
-
-  Preamble
-    \newtheorem{axi}{Axiom}
-  EndPreamble
-End  
-
-# Definition-numbered style declaration
-Style Definition
-  CopyStyle            TheoremTemplate
-  LatexName            definitn
-  LabelString          "Definition #:"
-
-  Preamble
-    \newtheorem{definitn}{Definition}
-  EndPreamble
+InsetLayout Flex:IEEE_membership
+  LyxType      custom
+  LatexType    command
+  ForcePlain   1
+  LatexName    IEEEmembership
+  LabelString  "IEEE membership"
+  Font
+    Shape      Italic
+    Size       Large
+    Misc       No_Emph
+    Misc       No_Noun
+    Misc       No_Bar
+  EndFont
+  LabelFont
+    Color      green
+    Size       Small
+  EndFont
+       ResetsFont true
 End
 
-# Example-numbered style declaration
-Style Example
-  CopyStyle            TheoremTemplate
-  LatexName            example
-  LabelString          "Example #:"
 
-  Preamble
-    \newtheorem{example}{Example}
-  EndPreamble
+InsetLayout Flex:Lowercase
+  CopyStyle    Flex:IEEE_membership
+  LatexType    command
+  LatexName    MakeLowercase
+  LabelString  "lowercase"
+  Font
+    Size       Normal
+  EndFont
 End
 
-# Condition-numbered style declaration
-Style Condition
-  CopyStyle            TheoremTemplate
-  LatexName            condition
-  LabelString          "Condition #:"
 
-  Preamble
-    \newtheorem{condition}{Condition}
-  EndPreamble
+Style Author
+  Margin       Static
+  LatexType    Command
+  Category     FrontMatter
+  InTitle      1
+  Argument 1
+    LabelString        "Short Author|S"
+    Tooltip    "A short version of the author name"
+    InsertCotext 1
+  EndArgument
+  LatexName    author
+  LabelSep     xxx
+  ParSkip      0.4
+  TopSep       1.3
+  BottomSep    0.7
+  ParSep       0.7
+  Align                Center
+  LabelType    No_Label
+  Font
+    Size       Large
+  EndFont
 End
 
-# Problem-numbered style declaration
-Style Problem
-  CopyStyle            TheoremTemplate
-  LatexName            problem
-  LabelString          "Problem #:"
 
-  Preamble
-    \newtheorem{problem}{Problem}
-  EndPreamble
+InsetLayout Flex:Author_Name
+  LyxType      custom
+  LatexType    command
+  Decoration   Classic
+  ForcePlain   1
+  LaTeXName    IEEEauthorblockN
+  LabelString  "Author name"
+  Font
+    Size       Large
+  EndFont
+  LabelFont
+    Color      blue
+    Size       Small
+  EndFont
+       ResetsFont true
 End
 
-# Exercise-numbered style declaration
-Style Exercise
-  CopyStyle            TheoremTemplate
-  LatexName            exacise
-  LabelString          "Exercise #:"
 
-  Preamble
-    \newtheorem{exacise}{Exercise}
-  EndPreamble
+InsetLayout Flex:Author_Affiliation
+  CopyStyle    Flex:Author_Name
+  LaTeXName    IEEEauthorblockA
+  LabelString  "Author affiliation"
+  Font
+    Size       Normal
+  EndFont
+  LabelFont
+    Color      blue
+    Size       Small
+  EndFont
 End
 
-# Remark-numbered style declaration
-Style Remark
-  CopyStyle            TheoremTemplate
-  LatexName            remrk
-  LabelString          "Remark #:"
 
-  Preamble
-    \newtheorem{remrk}{Remark}
-  EndPreamble
+InsetLayout Flex:Author_Mark
+       LyxType         custom
+       LatexType       command
+       ForcePlain      1
+       LatexName       IEEEauthorrefmark
+       LabelString     "Author mark"
+       Font
+         Color         foreground
+         Size          Small
+         Family        Roman
+         Shape         Up
+         Series        Medium
+         Misc          No_Emph
+         Misc          No_Noun
+         Misc          No_Bar
+       EndFont
+       LabelFont
+         Color         latex
+         Size          Small
+       EndFont
+       ResetsFont true
 End
 
-# Claim-numbered style declaration
-Style Claim
-  CopyStyle            TheoremTemplate
-  LatexName            claim
-  LabelString          "Claim #:"
 
-  Preamble
-    \newtheorem{claim}{Claim}
-  EndPreamble
+Style Special_Paper_Notice
+  CopyStyle    Title
+  LatexName    IEEEspecialpapernotice
+  InTitle      1
+  Font
+    Shape      Italic
+    Size       Large
+  EndFont
 End
 
-# Note-numbered style declaration
-Style Note
-  CopyStyle            TheoremTemplate
-  LatexName            note
-  LabelString          "Note #:"
 
-  Preamble
-    \newtheorem{note}{Note}
-  EndPreamble
+Style After_Title_Text
+  CopyStyle    Special_Paper_Notice
+  LatexName    IEEEaftertitletext
+  Font
+    Shape      Up
+    Size       Normal
+  EndFont
 End
 
-# Notation-numbered style declaration
-Style Notation
-  CopyStyle            TheoremTemplate
-  LatexName            notation
-  LabelString          "Notation #:"
 
+Style Page_headings
+  LaTeXType    Command
+  LaTeXName    markboth
+  Category     FrontMatter
+  InTitle      1
+  Align                Center
+  Argument 1
+    Mandatory  1
+    AutoInsert 1
+    LabelString        "Left Side"
+    Tooltip    "Left side of the header line"
+  EndArgument
+  Font
+    Size       Small
+  EndFont
   Preamble
-    \newtheorem{notation}{Notation}
+  % protect \markboth against an old bug reintroduced in babel >= 3.8g
+  \let\oldforeign@language\foreign@language
+  \DeclareRobustCommand{\foreign@language}[1]{%
+    \lowercase{\oldforeign@language{#1}}}
   EndPreamble
 End
 
-# Case-numbered style declaration
-Style Case
-  CopyStyle            TheoremTemplate
-  LatexName            case
-  LabelString          "Case #:"
 
-  Preamble
-    \newtheorem{case}{Case}
-  EndPreamble
+Style MarkBoth
+  ObsoletedBy  Page_headings
 End
 
-NoStyle TheoremTemplate
-
-##
-## stdsections and stdstarsections
-##
-Input stdsections.inc
-Input stdstarsections.inc
-
-NoStyle                 Part
-NoStyle                 Part*
-NoStyle                 Chapter
-NoStyle                 Chapter*
-NoStyle                 Subparagraph
-NoStyle                 Subparagraph*
-
-Style Section
-  Align                        Center
-  AlignPossible                Block, Center, Left
 
+Style Publication_ID
+  CopyStyle    Special_Paper_Notice
+  LatexName    IEEEpubid
   Font
-     Shape              Smallcaps
-     Size               Normal
+    Shape      Up
+    Size       Small
   EndFont
 End
 
 
-Style Subsection
+Style Abstract
+  Margin       First_Dynamic
+  LatexType    Environment
+  LatexName    abstract
+  Category     FrontMatter
+  TopSep       0.7
+  BottomSep    0.7
+  ParSkip      0.4
+  LabelType    Static
+  LabelString  "Abstract---"
   Font
-     Shape              Italic
-     Size               Normal
+    Series     Bold
+    Size       small
   EndFont
-End
-
-Style Subsubsection
-  Font
-     Shape              Up
-     Size               Normal
+  LabelFont
+    Shape      Italic
+    Series     Bold
+    Size       Small
   EndFont
 End
 
-Style Section*
-  Align                        Center
-  AlignPossible                Block, Center, Left
 
-  Font
-     Shape              Smallcaps
-     Size               Normal
-  EndFont
+Style Keywords
+  CopyStyle    Abstract
+  LatexName    IEEEkeywords
+  LabelString  "Index Terms---"
 End
 
 
-Style Subsection*
+InsetLayout Flex:Paragraph_Start
+  LyxType      custom
+  LatexType    command
+  LaTeXName    IEEEPARstart
+  LabelString  "Paragraph Start"
+  Argument 1
+    Mandatory  1
+    AutoInsert 1
+    LabelString        "First Char"
+    Tooltip    "First character of first word"
+  EndArgument
   Font
-     Shape              Italic
-     Size               Normal
+    Size       Small
   EndFont
+       ResetsFont true
 End
 
-Style Subsubsection*
-  Font
-     Shape              Up
-     Size               Normal
-  EndFont
-End
-
-##
-## stdstruct
-##
-Input stdtitle.inc
-Input stdstruct.inc
-
-Style Abstract
-  Margin                First_Dynamic
-  LeftMargin           ""
-  RightMargin          ""
-#  ParIndent           MM
-  LabelSep              M
-  LabelType            Static
-  LabelString          "Abstract---"
-#  LabelBottomSep        0.0
-
-  # standard font definition
-  Font 
-    Series              Bold
-    Size               Small
-  EndFont
-
-  # label font definition
-  LabelFont
-    Shape               Italic
-    Series             Medium
-    Size               Small
-  EndFont
-End 
 
-Style Keywords
-  Margin               Dynamic
-  LatexType            Environment
-  InTitle              0
-  LatexName            keywords
-  ParSkip              0.4
-  BottomSep            1.5
-  ParSep               1.5
-  Align                        Left
-  AlignPossible                Block, Left, Right, Center
-  LabelType            Static
-  LabelString          "Keywords---"
-  # label font definition
-  TextFont
-    Shape               Up
-    Size                Small
-  EndFont
+Style Appendices
+  Margin       Dynamic
+  LatexType    Command
+  LatexName    appendices
+  Category     BackMatter
+  KeepEmpty    1
+  ParSkip      0.4
+  Align                Block
+  LabelSep     xx
+  LabelType    Static
+  LabelString  "Appendices"
   LabelFont
-    Shape              Italic
-    Size                Small
+    Series     Bold
+    Color      Green
   EndFont
 End
 
-# Bibliography style definition
-Style Bibliography
-  # label font definition
-  LabelFont
-    Shape               Smallcaps             
-    Series             Medium
-    Size               Normal
-  EndFont
+
+Style Peer_Review_Title
+  CopyStyle    Appendices
+  LatexName    IEEEpeerreviewmaketitle
+  Category     FrontMatter
+  TopSep       1
+  LabelString  "PeerReviewTitle"
 End
 
+
 Style Appendix
-  Margin               Static
-  LatexType            Command
-  InTitle              0
-  LatexName            appendix
-  ParSkip              0.4
-  BottomSep            1.5
-  ParSep               1.5
-  Align                        Block
-  AlignPossible                Block, Left, Right, Center
-  LabelType            Static
-  LabelString          "Appendix"
-  # label font definition
-  TextFont
-    Shape               Up
-    Size                Normal
-  EndFont
-  LabelFont
-    Shape              Smallcaps
-    Size                Normal
-  EndFont
+  CopyStyle    Appendices
+  LatexName    appendix
+  LabelString  "Appendix"
+  Argument 1
+    LabelString        "Short Title"
+    Tooltip    "Short title for the appendix"
+    InsertCotext 1
+  EndArgument
 End
 
-Style Appendices
-  Margin               Static
-  LatexType            Command
-  InTitle              0
-  LatexName            appendices
-  ParSkip              0.4
-  BottomSep            1.5
-  ParSep               1.5
-  Align                        Center
-  AlignPossible                Block, Left, Right, Center
-  LabelType            Static
-  LabelString          "Appendices"
-  # label font definition
-  TextFont
-    Shape               Up
-    Size                Small
-  EndFont
+
+Style Bibliography
+  Margin       First_Dynamic
+  LatexType    Bib_Environment
+  LatexName    thebibliography
+  Category     BackMatter
+  NextNoIndent 1
+  ToggleIndent Never
+  LeftMargin   MM
+  ParSkip      0.4
+  ItemSep      0
+  TopSep       0.7
+  BottomSep    0.7
+  ParSep       0.5
+  Align                Block
+  AlignPossible        Block, Left
+  LabelType    Bibliography
+  LabelString  "References"
+  LabelBottomSep 1.2
   LabelFont
-    Shape              Smallcaps
-    Size                Normal
+    Series     Bold
+    Size       Larger
   EndFont
 End
 
+
 Style Biography
-  LaTeXType            Environment
-  LaTeXName            biography
-  Align                        Block
-  AlignPossible                Block
+  LaTeXType    Environment
+  LaTeXName    IEEEbiography
+  Category     BackMatter
+  Argument 1
+    LabelString        "Photo"
+    Tooltip    "Optional photo for biography"
+  EndArgument
+  Argument 2
+    Mandatory  1
+    AutoInsert 1
+    LabelString        "Name"
+    Tooltip    "Name of the author"
+  EndArgument
+  Align        Block
   TextFont
-    Size               Small
+    Size       Small
   EndFont
 End
 
-##
-##  stdlayouts
-##
-Input stdlayouts.inc
 
-Style Caption
-  LabelFont
-    Series              Medium
-  EndFont
+Style Biography_without_photo
+  CopyStyle    Biography
+  LaTeXName    IEEEbiographynophoto
+  ResetArgs    1
+  Argument 1
+    Mandatory  1
+    AutoInsert 1
+    LabelString        "Name"
+    Tooltip    "Name of the author"
+  EndArgument
 End
 
-Style Footernote
-  Margin               Static
-  LatexType            Command
-  InTitle              0
-  LatexName            footernote
-  ParSkip              0.4
-  BottomSep            1.5
-  ParSep               1.5
-  Align                        Center
-  AlignPossible                Block, Left, Right, Center
-  LabelType            Static
-  LabelString          "Footernote"
-  # label font definition
-  TextFont
-    Shape               Up
-    Size                Small
+Style BiographyNoPhoto
+  ObsoletedBy  Biography_without_photo
+End
+
+
+Style Proof
+  Category     Reasoning
+  Margin       First_Dynamic
+  LatexType    Environment
+  LatexName    IEEEproof
+  NextNoIndent 1
+  Argument 1
+    LabelString        "Alternative Proof String"
+    Tooltip    "An alternative proof string"
+  EndArgument
+  LabelSep     xx
+  ParIndent    MMM
+  ParSkip      0.4
+  ItemSep      0.2
+  TopSep       0.7
+  BottomSep    0.7
+  ParSep       0.3
+  Align                Block
+  AlignPossible        Block, Left
+  LabelType    Static
+  LabelString  "Proof."
+  EndLabelType Filled_Box
+  Font
+    Shape      Up
+    Size       Normal
   EndFont
   LabelFont
-    Shape              Italic
-    Size                Small
+    Shape      Italic
   EndFont
 End
-
-Style MarkBoth
-  LaTeXType            Command
-  LaTeXName            markboth
-  Align                        Center
-  AlignPossible                Center
-End
-
-##
-## Others
-##
-Input stdfloats.inc
-Input stdcounters.inc
-Input lyxmacros.inc
-Input obsolete.inc