]> git.lyx.org Git - lyx.git/blobdiff - lib/layouts/enumitem.module
Make Word Wrap property confiurable by language
[lyx.git] / lib / layouts / enumitem.module
index 24021848a64fa127a7a9386f55a70389857e04c8..db9ff32d986f0e0653b663a3f40647b5b39e16af 100644 (file)
-#\DeclareLyXModule[enumitem.sty]{Customizable Lists (enumitem)}\r
-#DescriptionBegin\r
-# Control the layout of enumerate, itemize and description\r
-# with an optional argument.\r
-# See http://dante.ctan.org/CTAN/macros/latex/contrib/enumitem/enumitem.pdf\r
-#DescriptionEnd\r
-# Author: Günter Milde <milde@users.berlios.de>\r
-# \r
-# 2008-12-04 first published version\r
-# 2009-02-02 use name Labeling for "LyX-List/Labeling" list type,\r
-#           copy standard layout verbatim for failsave working with \r
-#           both KOMA and non-KOMA document classes\r
-# 2010-11-16 use Require keyword instead of \usepackage in preamble\r
-#\r
-# The package enumitem provides user control over the layout of the three\r
-# basic list environments: enumerate, itemize and description. It supersedes\r
-# both enumerate and mdwlist (providing well-structured replacements for all\r
-# their funtionality), and in addition provides functions to compute the\r
-# layout of labels, and to ‘clone’ the standard environments, to create new\r
-# environments with counters of their own.\r
-#\r
-# - fancy labels and fancy refs,\r
-# - leftmargin, labelsep and labelwidth automatically set,\r
-# - changes applied globally or only in one of the three\r
-#   types or even in a single list (including topsep),\r
-# - several description styles (which fix some bad spacing, too),\r
-# - starting value and counter resuming,\r
-# - trivlists properly formatted,\r
-# - control on page breaking\r
-#\r
-# Styling the basic lists is possible \r
-#\r
-# a) generally in the LaTeX preamble and \r
-# b) per environment with optional arguments\r
-#\r
-# See enumitem.pdf for details and examples.\r
-#    http://dante.ctan.org/CTAN/macros/latex/contrib/enumitem/enumitem.pdf\r
-#\r
-# TODO: since version 2.0, enumitem supports "cloning" of lists.\r
-#       Producing a labeling as clone of a description allows\r
-#       Preamble-Styling specific to this list type.\r
-\r
-Format 30\r
-\r
-AddToPreamble\r
-       \newlength{\lyxlabelwidth}      % auxiliary length \r
-EndPreamble\r
-\r
-# Customizable Basic Lists\r
-# ------------------------\r
-\r
-# With enumitem, the three standard list environments take an optional\r
-# argument. See enumitem.pdf_ for possible values.\r
-\r
-Style Itemize\r
-       OptionalArgs          1\r
-       Requires        enumitem\r
-End\r
-\r
-Style Enumerate\r
-       OptionalArgs          1\r
-       Requires        enumitem\r
-End\r
-\r
-Style Description\r
-       OptionalArgs          1\r
-       Requires        enumitem\r
-End\r
-\r
-# Customizable LyX List\r
-# ---------------------\r
-\r
-Style Labeling\r
-       # verbatim insert definition of List environment, \r
-       # The KOMA script classes replace List with Labeling, \r
-       # this leads to an error with "CopyStyle List"!\r
-       Category              List\r
-       Margin                Manual\r
-       LatexType             List_Environment\r
-       NextNoindent          1\r
-       LabelSep              xxx\r
-       ParSkip               0.4\r
-       TopSep                0.7\r
-       BottomSep             0.7\r
-       ParSep                0.5\r
-       Align                 Block\r
-       AlignPossible         Block, Left\r
-       LabelType             Manual\r
-       LabelString           "00.00.0000"\r
-       # en of verbatim copy\r
-       \r
-       LatexName             elabeling\r
-       OptionalArgs          1\r
-       Requires              enumitem\r
-       Preamble\r
-       % labeling-like list based on enumitem's description list with\r
-       % mandatory second argument (label-pattern):\r
-       \newenvironment{elabeling}[2][]%\r
-         {\settowidth{\lyxlabelwidth}{#2}\r
-          \begin{description}[font=,style=sameline,\r
-                              leftmargin=\lyxlabelwidth,#1]}\r
-         {\end{description}}\r
-       EndPreamble\r
-End\r
-\r
-\r
-# List Variants\r
-# -------------\r
-#\r
-# Styles with pre-defined optional arguments for ease of use\r
-\r
-Style Enumerate-Resume\r
-       CopyStyle             Enumerate\r
-       LatexParam            [resume]\r
-       OptionalArgs          0\r
-       Requires              enumitem\r
-       # a blue label to indicate that this is not a WYSIWYG label\r
-       # because the numbering differs in the output\r
-       LabelFont\r
-         Color               blue\r
-       EndFont\r
-End\r
-\r
+#\DeclareLyXModule[enumitem.sty]{Customisable Lists (enumitem)}
+#\DeclareCategory{List Enhancements}
+#DescriptionBegin
+# Controls the layout of enumerate, itemize, description, and list/labeling.
+# See section Customized Lists of the User's Guide for a detailed description.
+#DescriptionEnd
+#Excludes: paralist
+
+# Author: Günter Milde <milde@lyx.org>
+# 
+# 2008-12-04 first published version.
+# 2009-02-02 use name Labeling for "LyX-List/Labeling" list type,
+#           copy standard layout verbatim for failsave working with 
+#           both KOMA and non-KOMA document classes.
+# 2011-01-12 bugfix: set elabeling label font to \normalfont.
+
+Format 74
+
+# The package enumitem provides user control over the layout of the three
+# basic list environments: enumerate, itemize and description. It supersedes
+# both enumerate and mdwlist (providing well-structured replacements for all
+# their funtionality), and in addition provides functions to compute the
+# layout of labels, and to ‘clone’ the standard environments, to create new
+# environments with counters of their own.
+#
+# - fancy labels and fancy refs,
+# - leftmargin, labelsep and labelwidth automatically set,
+# - changes applied globally or only in one of the three
+#   types or even in a single list (including topsep),
+# - several description styles (which fix some bad spacing, too),
+# - starting value and counter resuming,
+# - trivlists properly formatted,
+# - control on page breaking
+#
+# Styling the basic lists is possible 
+#
+# a) generally in the LaTeX preamble and 
+# b) per environment with optional arguments
+#
+# See enumitem.pdf_ for details and examples.
+#
+# TODO: since version 2.0, enumitem supports "cloning" of lists.
+#       Producing a labeling as clone of a description allows
+#       Preamble-Styling specific to this list type.
+
+AddToPreamble
+       \newlength{\lyxlabelwidth}      % auxiliary length 
+EndPreamble
+
+
+# Customisable Basic Lists
+# ------------------------
+
+# With enumitem, the three standard list environments take an optional
+# argument. See enumitem.pdf for possible values.
+
+ModifyStyle Itemize
+       Argument 1
+               LabelString   "Itemize Options"
+               Tooltip       "Optional arguments for this list (see enumitem manual)"
+       EndArgument
+       Requires enumitem
+End
+
+ModifyStyle Enumerate
+       Argument 1
+               LabelString   "Enumerate Options"
+               Tooltip       "Optional arguments for this list (see enumitem manual)"
+       EndArgument
+       Requires enumitem
+End
+
+ModifyStyle Description
+       Argument 1
+               LabelString   "Description Options"
+               Tooltip       "Optional arguments for this list (see enumitem manual)"
+       EndArgument
+       Requires enumitem
+End
+
+
+# Customisable LyX List
+# ---------------------
+
+Input stdlyxlist.inc
+
+Style Labeling
+       Category              List
+       LatexName             elabeling
+       # FIXME This should probably be defined using \newlist instead
+       Preamble
+       % labeling-like list based on enumitem's description list with
+       % mandatory second argument (label-pattern):
+               \newenvironment{elabeling}[2][]%
+               {\settowidth{\lyxlabelwidth}{#2}
+                       \begin{description}[font=\normalfont,style=sameline,
+                               leftmargin=\lyxlabelwidth,#1]}
+               {\end{description}}
+       EndPreamble
+       Requires enumitem
+End
+
+
+# List Variants
+# -------------
+#
+# Styles with pre-defined optional arguments for ease of use
+
+Style Enumerate-Resume
+       CopyStyle             Enumerate
+       Argument 1
+               LabelString   "Enumerate Options"
+               Tooltip       "Optional arguments for this list (see enumitem manual)"
+               PresetArg     "resume"
+       EndArgument
+       ResumeCounter true
+       Requires enumitem
+End
+
+# References
+# ----------
+#
+# .. _enumitem.pdf:
+#    http://dante.ctan.org/CTAN/macros/latex/contrib/enumitem/enumitem.pdf
+