X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Flayouts%2Fenumitem.module;h=db9ff32d986f0e0653b663a3f40647b5b39e16af;hb=bf88ad495cead6e97a05fee59e41414648145fc1;hp=24021848a64fa127a7a9386f55a70389857e04c8;hpb=64495f2500a8eab7ee8f815244d2d5e1fa76dd32;p=lyx.git diff --git a/lib/layouts/enumitem.module b/lib/layouts/enumitem.module index 24021848a6..db9ff32d98 100644 --- a/lib/layouts/enumitem.module +++ b/lib/layouts/enumitem.module @@ -1,123 +1,125 @@ -#\DeclareLyXModule[enumitem.sty]{Customizable Lists (enumitem)} -#DescriptionBegin -# Control the layout of enumerate, itemize and description -# with an optional argument. -# See http://dante.ctan.org/CTAN/macros/latex/contrib/enumitem/enumitem.pdf -#DescriptionEnd -# Author: Günter Milde -# -# 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 -# 2010-11-16 use Require keyword instead of \usepackage in preamble -# -# 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. -# http://dante.ctan.org/CTAN/macros/latex/contrib/enumitem/enumitem.pdf -# -# 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. - -Format 30 - -AddToPreamble - \newlength{\lyxlabelwidth} % auxiliary length -EndPreamble - -# Customizable Basic Lists -# ------------------------ - -# With enumitem, the three standard list environments take an optional -# argument. See enumitem.pdf_ for possible values. - -Style Itemize - OptionalArgs 1 - Requires enumitem -End - -Style Enumerate - OptionalArgs 1 - Requires enumitem -End - -Style Description - OptionalArgs 1 - Requires enumitem -End - -# Customizable LyX List -# --------------------- - -Style Labeling - # verbatim insert definition of List environment, - # The KOMA script classes replace List with Labeling, - # this leads to an error with "CopyStyle List"! - Category List - Margin Manual - LatexType List_Environment - 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" - # en of verbatim copy - - LatexName elabeling - OptionalArgs 1 - Requires enumitem - 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=,style=sameline, - leftmargin=\lyxlabelwidth,#1]} - {\end{description}} - EndPreamble -End - - -# List Variants -# ------------- -# -# Styles with pre-defined optional arguments for ease of use - -Style Enumerate-Resume - CopyStyle Enumerate - LatexParam [resume] - OptionalArgs 0 - Requires enumitem - # a blue label to indicate that this is not a WYSIWYG label - # because the numbering differs in the output - LabelFont - Color blue - EndFont -End - +#\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 +# +# 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 +