]> git.lyx.org Git - lyx.git/blobdiff - lib/layouts/scrlttr2.layout
Add frontispiece layout to KOMA classes
[lyx.git] / lib / layouts / scrlttr2.layout
index eeed1af8d854e1f6c4d1e4ec789169661bb06273..9c98bdd122b5633a6baea18f21f8c57a1cb03cda 100644 (file)
 #% Do not delete the line below; configure depends on this
-#  \DeclareLaTeXClass[scrlttr2]{letter (koma-script v.2)}
+#  \DeclareLaTeXClass{KOMA-Script Letter (V. 2)}
+#  \DeclareCategory{Letters}
 # KOMA scrlettr2 textclass definition file.
-# Juergen Spitzmueller <j.spitzmueller@gmx.de>, 2003/2/17.
+# Juergen Spitzmueller <spitz@lyx.org>, 2003/2/17.
+# Uwe Stöhr <uwestoehr@web.de>, 2008/2/03.
+
+# TODO: DocBook doesn't support several letters in the same file.
+# DocBook design note: there are several ways to implement sender data, this class does it in 
+# another way that the other letters. Usually, there is a large <address> tag with author 
+# information in <info>, but there is no possibility to include a URL in this case. 
+# Therefore, here, we use a <author> in <info>, having an <address>. <author> allows a URL
+# (<uri>) and an address. However, phone and fax numbers should be put in <address>, they 
+# are not allowed directly in <author>... The generated DocBook will not be valid due to this!
+
+Format 90
+Provides subscript 1
 
-# Standard style definition
 Style Standard
-  LatexName             dummy
-  ParSep                0.4
-  AlignPossible         Block, Left, Right, Center
+       Category              MainText
+       LatexName             dummy
+       ParSep                0.4
+       AlignPossible         Block, Left, Right, Center
+       ParIndent             MM
+       DocBookTag            para
 End
 
 Input stdlists.inc
+Input stdlayouts.inc
+Input stdcounters.inc
+Input stdinsets.inc
 
-# Modify Description
 Style Description
-  LabelFont
-    Family              Sans
-  EndFont
+       LabelFont
+         Family              Sans
+       EndFont
 End
 
-# Delete List
-NoStyle List
 
-# Labeling style definition
 Style Labeling
-  Margin               Manual
-  LatexType            List_Environment
-  LatexName             labeling
-  NextNoindent         1
-  LabelSep             xxx
-  ParSkip              0.4
-  TopSep               0.7
-  BottomSep            0.7
-  ParSep               0.5
-  Align                        Block
-  AlignPossible                Block, Left
-  LabelType            Manual
-  LabelString          00.00.0000
+       CopyStyle             List
+       LatexName             labeling
+       # overwrite the preamble code definition
+       Preamble
+       EndPreamble
 End
 
-Input stdlayouts.inc
 
-# Delete Caption
-NoStyle Caption
+Style List
+       Obsoletedby           Labeling
+End
+
+
+Preamble
+       \newif\ifletterclosed
+EndPreamble
+
 
-# Letter style definition
 Style Address
-  LatexType             Command
-  LatexName             begin
-  LatexParam            {letter}
-  #Ugly hack!
-  Preamble
-  \AtEndDocument{\end{letter}}
-  EndPreamble
-  KeepEmpty             1
-  LeftMargin            xxxxxxxxxxxx::xx
-  LabelSep              xx
-  TopSep                1.5
-  BottomSep             1.5
-  ParSep                1.5
-  Align                 Left
-  AlignPossible         Left
-  LabelType             Static
-  LabelString           "Address:"
-
-  LabelFont 
-    Series              Bold
-    Shape               Italic
-    Size                Small
-    Color               Blue
-  EndFont
-End
-
-# NextLetter style definition
+       LatexType             Command
+       LatexName             begin
+       LatexParam            {letter}
+       Preamble
+               \AtEndDocument{\ifletterclosed\else\end{letter}\fi}
+       EndPreamble
+       KeepEmpty             1
+       LeftMargin            xxxxxxxxxxxx::xx
+       LabelSep              xx
+       TopSep                1.5
+       BottomSep             1.5
+       ParSep                1.5
+       Align                 Left
+       LabelType             Static
+       LabelString           "Address:"
+       LabelFont
+         Series              Bold
+         Shape               Italic
+         Size                Small
+         Color               textlabel1
+       EndFont
+    DocBookTag         NONE
+    DocBookWrapperTag  address
+    DocBookWrapperMergeWithPrevious  true
+    DocBookInInfo      always
+End
+
+
 # Start new letter
+# Not supported by DocBook.
 Style NextAddress
-  LatexType             Command
-  LatexName             end{letter}\begin{letter}
-  KeepEmpty             1
-  LeftMargin            xxxxxxxxxxxx::xx
-  LabelSep              xx
-  TopSep                1.5
-  BottomSep             1.5
-  ParSep                1.5
-  Align                 Left
-  AlignPossible         Left
-  LabelType             Static
-  LabelString           "Next Address:"
-
-  LabelFont 
-    Series              Bold
-    Shape               Italic
-    Size                Small
-    Color               Blue
-  EndFont
-End
-
-# Opening style definition
+       LatexType             Command
+       LatexName             end{letter}\begin{letter}
+       KeepEmpty             1
+       LeftMargin            xxxxxxxxxxxx::xx
+       LabelSep              xx
+       TopSep                1.5
+       BottomSep             1.5
+       ParSep                1.5
+       Align                 Left
+       LabelType             Static
+       LabelString           "Next Address:"
+       LabelFont
+         Series              Bold
+         Shape               Italic
+         Size                Small
+         Color               textlabel1
+       EndFont
+End
+
+
 Style Opening
-  LatexType             Command
-  LatexName             opening
-  KeepEmpty             0
-  LeftMargin            xxxxxxxxxxxx::xx
-  LabelSep              xx
-  TopSep                0.4
-  BottomSep             0.4
-  ParSep                0.4
-  Align                 Left
-  AlignPossible         Left
-  LabelType             Static
-  LabelString           "Opening:"
-  
-  LabelFont 
-    Series              Bold
-    Shape               Italic
-    Color               Magenta
-  EndFont
-End
-
-# Closing style definition
+       Category              Letter
+       LatexType             Command
+       LatexName             opening
+       KeepEmpty             0
+       LeftMargin            xxxxxxxxxxxx::xx
+       LabelSep              xx
+       TopSep                0.4
+       BottomSep             0.4
+       ParSep                0.4
+       Align                 Left
+       LabelType             Static
+       LabelString           "Opening:"
+       LabelFont
+         Series              Bold
+         Shape               Italic
+         Color               textlabel3
+       EndFont
+       DocBookTag            para
+       DocBookAttr           role='opening'
+End
+
+
 Style Closing
-  CopyStyle             Opening
-  LatexType             Command
-  LatexName             closing
-  LabelString           "Closing:"
+       CopyStyle             Opening
+       LatexType             Command
+       LatexName             closing
+       LabelString           "Closing:"
+       DocBookTag            para
+       DocBookAttr           role='closing'
 End
 
-# PS style definition
+
 Style PS
-  CopyStyle             Opening
-  LatexType             Command
-  LatexName             ps
-  LabelString           "Post Scriptum:"
+       CopyStyle             Opening
+       LatexType             Command
+       LatexName             ps
+       LabelString           "Post Scriptum:"
+       DocBookTag            para
+       DocBookAttr           role='post-scriptum'
 End
 
-# CC style definition
+
 Style CC
-  CopyStyle             Opening
-  LatexType             Command
-  LatexName             cc
-  LabelString           "cc:"
+       CopyStyle             Opening
+       LatexType             Command
+       LatexName             cc
+       LabelString           "cc:"
+       DocBookTag            para
+       DocBookAttr           role='carbon-copy'
 End
 
-# Encl style definition
+
 Style Encl
-  CopyStyle             Opening
-  LatexName             encl
-  LabelString           "encl:"
+       CopyStyle             Opening
+       LatexName             encl
+       LabelString           "encl:"
+       DocBookTag            para
+       DocBookAttr           role='enclosed'
 End
 
-# Name style definition
+
 Style Name
-  LatexType             Command
-  LatexName             setkomavar
-  LatexParam            {fromname}
-  KeepEmpty             1
-  LeftMargin            xxxxxxxxxxxx::xx
-  LabelSep              xx
-  TopSep                0.4
-  BottomSep             0.4
-  ParSep                0.4
-  Align                 Left
-  AlignPossible         Left
-  LabelType             Static
-  LabelString           "Sender Name:"
-
-  LabelFont 
-    Series              Bold
-    Shape               Italic
-    Color               Blue
-  EndFont
-End
-
-# Signature style definition
+       Category              Letter
+       LatexType             Command
+       LatexName             setkomavar
+       LatexParam            {fromname}
+       KeepEmpty             1
+       LeftMargin            xxxxxxxxxxxxxxxxx::xx
+       LabelSep              xx
+       TopSep                0.4
+       BottomSep             0.4
+       ParSep                0.4
+       Align                 Left
+       LabelType             Static
+       LabelString           "Sender Name:"
+
+       LabelFont
+         Series              Bold
+         Shape               Italic
+         Color               textlabel1
+       EndFont
+       DocBookTag            personname
+       DocBookTagType        paragraph
+       DocBookWrapperTag     author
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always     
+End
+
+
 Style Signature
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {signature}
-  LabelString           "Signature:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {signature}
+       LabelString           "Signature:"
+       DocBookTag            para
+       DocBookWrapperTag     abstract
+       DocBookWrapperAttr    role='signature'
 End
 
-# Address style definition
+
 Style SenderAddress
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {fromaddress}
-  LabelString           "Sender Address:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {fromaddress}
+       LabelString           "Sender Address:"
+       DocBookTag            address
+       DocBookTagType        paragraph
+       DocBookWrapperTag     author
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always    
 End
 
-# Telephone style definition
+
 Style Telephone
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {fromphone}
-  LabelString           "Sender Phone:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {fromphone}
+       LabelString           "Sender Phone:"
+       # TODO: to be valid DocBook, this should be in the address.
+       DocBookTag            phone
+       DocBookTagType        paragraph
+       DocBookWrapperTag     author
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always    
 End
 
-# Fax style definition
+
 Style Fax
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {fromfax}
-  LabelString           "Sender Fax:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {fromfax}
+       LabelString           "Sender Fax:"
+       # TODO: to be valid DocBook, this should be in the address.
+       DocBookTag            fax
+       DocBookTagType        paragraph
+       DocBookWrapperTag     author
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always    
 End
 
 
-# E-Mail style definition
 Style E-Mail
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {fromemail}
-  LabelString           "Sender E-Mail:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {fromemail}
+       LabelString           "Sender E-Mail:"
+       DocBookTag            email
+       DocBookTagType        paragraph
+       DocBookWrapperTag     author
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always
 End
 
-# URL style definition
+
 Style URL
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {fromurl}
-  LabelString           "Sender URL:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {fromurl}
+       LabelString           "Sender URL:"
+       DocBookTag            uri
+       DocBookTagType        paragraph
+       DocBookWrapperTag     author
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always
 End
 
-# Bank style definition
+
 Style Bank
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {frombank}
-  LabelString           "Bank:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {frombank}
+       LabelString           "Bank:"
+       DocBookTag            personblurb
+       DocBookAttr           role='bank'
+       DocBookTagType        paragraph
+       DocBookWrapperTag     author
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always
 End
 
-# Logo style definition
+
 Style Logo
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {fromlogo}
-  LabelString           "Logo:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {fromlogo}
+       LabelString           "Logo:"
 End
 
-# Place style definition
+
 Style Place
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {place}
-  LabelString           "Place:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {place}
+       LabelString           "Place:"
+       DocBookTag            country
+       DocBookTagType        paragraph
+       DocBookWrapperTag     address
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always
 End
 
-# Date style definition
+
 Style Date
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {date}
-  LabelString           "Date:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {date}
+       LabelString           "Date:"
+       DocBookTag            date
+       DocBookTagType        paragraph
+       DocBookWrapperTag     NONE
+       DocBookInInfo         always
 End
 
-# Backaddress style definition
+
 Style Backaddress
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {backaddress}
-  LabelString           "Backaddress:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {backaddress}
+       LabelString           "Backaddress:"
+       DocBookTag            NONE
+       DocBookWrapperTag     address
+       DocBookWrapperTagType paragraph
+       DocBookWrapperMergeWithPrevious true
+       DocBookInInfo         always
 End
 
-# Specialmail style definition
+
 Style Specialmail
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {specialmail}
-  LabelString           "Specialmail:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {specialmail}
+       LabelString           "Specialmail:"
+       # TODO: not implemented for DocBook, what is the meaning of this?
 End
 
-# Location style definition
+
 Style Location
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {location}
-  LabelString           "Location:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {location}
+       LabelString           "Location:"
+       # TODO: not implemented for DocBook, what is the meaning of this?
 End
 
-# Title style definition
+
 Style Title
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {title}
-  LabelString           "Title:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {title}
+       LabelString           "Title:"
+       HTMLTitle             true
+       DocBookTag            title
+       DocBookAttr           role='title' # As opposed to subject.
+       DocBookTagType        paragraph
+       DocBookWrapperTag     NONE
+       DocBookInInfo         maybe
 End
 
-# Subject style definition
+
 Style Subject
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {subject}
-  LabelString           "Subject:"
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {subject}
+       LabelString           "Subject:"
+       DocBookTag            title
+       DocBookAttr           role='title'
+       DocBookTagType        paragraph
+       DocBookWrapperTag     NONE
+       DocBookInInfo         maybe
 End
 
-# Yourref style definition
-Style Yourref
-  CopyStyle             Name
-  LatexName             setkomavar
-  LatexParam            {yourref}
-  LabelString           "Your ref.:"
 
-  LabelFont 
-    Family              Sans
-    Series              Medium
-    Shape               Up
-    Size                Small
-    Color               None
-  EndFont
+Style Yourref
+       CopyStyle             Name
+       LatexName             setkomavar
+       LatexParam            {yourref}
+       LabelString           "Your ref.:"
+
+       LabelFont
+         Family              Sans
+         Series              Medium
+         Shape               Up
+         Size                Small
+         Color               None
+       EndFont
 End
 
-# Yourmail style definition
+
 Style Yourmail
-  CopyStyle             Yourref
-  LatexName             setkomavar
-  LatexParam            {yourmail}
-  LabelString           "Your letter of:"
+       CopyStyle             Yourref
+       LatexName             setkomavar
+       LatexParam            {yourmail}
+       LabelString           "Your letter of:"
 End
 
-# Myref style definition
+
 Style Myref
-  CopyStyle             Yourref
-  LatexName             setkomavar
-  LatexParam            {myref}
-  LabelString           "Our ref.:"
+       CopyStyle             Yourref
+       LatexName             setkomavar
+       LatexParam            {myref}
+       LabelString           "Our ref.:"
 End
 
-# Customer style definition
+
 Style Customer
-  CopyStyle             Yourref
-  LatexName             setkomavar
-  LatexParam            {customer}
-  LabelString           "Customer no.:"
+       CopyStyle             Yourref
+       LatexName             setkomavar
+       LatexParam            {customer}
+       LabelString           "Customer no.:"
 End
 
-# Invoice style definition
+
 Style Invoice
-  CopyStyle             Yourref
-  LatexName             setkomavar
-  LatexParam            {invoice}
-  LabelString           "Invoice no.:"
+       CopyStyle             Yourref
+       LatexName             setkomavar
+       LatexParam            {invoice}
+       LabelString           "Invoice no.:"
+End
+
+
+Style EndLetter
+       Margin                Dynamic
+       LatexType             Command
+       LatexName             end{letter}
+       Preamble
+               \letterclosedtrue
+       EndPreamble
+       KeepEmpty             1
+       TopSep                1
+       ParSkip               0.4
+       Align                 Block
+       LabelSep              xx
+       LabelType             Static
+       LabelString           "End of letter"
+       LabelFont
+         Series              Bold
+         Color               textlabel2
+       EndFont
 End