• View
• Edit
• Upload
• History
• Print

Modules

This page points to user-provided modules, i.e., modular extensions to arbitrary document classes.

To use the modules, just copy the respective *.module files to the layouts folder of your user directory (if the folder doesn't exist yet, create it) and then reconfigure LyX (Tools→Reconfigure). After a restart of LyX, the new modules can be selected in Document→Settings→Modules.

It is suggested that contributors take credit/accept blame. Unless noted otherwise, contributors can be contacted either through the user or developer mailing lists.

Extending LyX's functionality

Producing annotations and comments

• PDF annotations: This module provides (limited) support for the pdfcomment package. It provides two insets PDF-Annotation and PDF-Margin that add annotations to the output PDF file. Please refer to the pdfcomment manual for details. uploads:/Modules/pdfcomment.module (contributed by Jürgen Spitzmüller)
• TODO-Notes: This module provides (limited) support for the todonotes package. It provides an inset TODO that adds a nifty TODO note to the output file. Please refer to the todonotes manual for details. uploads:/Modules/todonotes.module (contributed by Jürgen Spitzmüller)
• TODO-Notes-Alternate: Extension to above with green notes rather than default orange, inline notes and missing figure. uploads:/Modules/todonotesalternate.module
• FiXme: This module provides support for the FiXme package. It provides a variety of insets by which comments having different "levels" can be added to a document, optionally highlighting the text that is being commented on. Additionally, it can generate a list of all the comments in your document. See the FiXme manual for more details -- there are several possible configuration options. fixme.module (contributed by Mark Edgington)
• Comments printing: Typeset comment notes in LyX. When used with notes-mutate lfun, it can be used even for normal LyX notes. printcomments.module. For inclusion into trunk savsf=1 issue needs to be fixed, but I don't know how, see this thread.

Bibliography, index and friends

• Index of Names: This module defines an additional Index of Names (requires the splitidx package). See this page for details. uploads:/Modules/nomindex.module (contributed by Jürgen Spitzmüller)

Footnotes, floats, graphics, tables, etc.

• Bigfoot support: Implements some simple functionality of the bigfoot package. See this thread.
• Longtable: Implements longtable as contributed to lyx mailing list. Uses the afterpage This also adds an inset for a landscape longtable using pdflscape. uploads:/Modules/longtablepage.module
• Algorithms: Convenient emphasis environments for the Algorithms bundle. Module: http://www.mpi-inf.mpg.de/~dietz/lyx/algorithmics.module and toolbar include http://www.mpi-inf.mpg.de/~dietz/lyx/algo-toolbar.inc to be included in your *ui file. See example lyx document for details. http://www.mpi-inf.mpg.de/~dietz/lyx/algo-example.lyx (contributed by Laura Dietz)
• inline program listings: allows for inline program listings (as opposed to program listings surrounded by newlines) using the listings package. Module: http://www.mpi-inf.mpg.de/~dietz/lyx/listings.module. (contributed by Laura Dietz)
• Side Captions: a module for generating side captions can be found at http://www.physics.utoronto.ca/~jrioux/resources/lyx/. This uses the sidecap LaTeX package
• enumitem: provides variants of the standard listing environment enumerate, itemize and description. This includes support for a resumable Enumeration. For a more detailed description, see enumitem.
  The module is included in LyX 2.0.0 and newer.

Markup

• Soul: Implements some functionality from the Soul package (emphasis environments for highlighting, and striking through and spacing letters). uploads:/Modules/soul.module

Spreadsheet capabilities

• spreadtab: The Latex spreadtab package provides spreadsheet-like capabilities for Latex tables. The spreadtab module enables these tables to be built in LyX using the table toolbar and right-click menu. With instant preview (from LyX 2.0.1), tables so built are evaluated before one's eyes in LyX. The module and an explanatory LyX document, including a timesheet, can be found here [http://marc.info/?l=lyx-users&m=134818458717499&w=2]. (Note that the LyX document has been saved in LyX's compressed format. In LyX, go to Documents > Compressed.) (contributed by Andrew Parsloe)

Integration with Sage via SageTeX

• sage: SageTeX supports computations using the Sage mathematics software (http://www.sagemath.org/) within LaTeX. The sage module provides custom environments and insets in LyX to directly compile documents containing Sage code through SageTeX. The module, supporting files, and a configuration script can be found in uploads:/Modules/Sage, or as attachments to the following message: http://www.mail-archive.com/lyx-users@lists.lyx.org/msg91798.html. (contributed by Thomas Coffee based on earlier work by Murat Yildizoglu)

Extensions to document classes

Article document class

• Wide abstract: This module typesets the abstract in one-column format irregardless of the article being in one- or two-column format. Tested with article, article (paper), and article (TUGboat) document classes. Found at http://www.physics.utoronto.ca/~jrioux/resources/lyx/. This uses the abstract LaTeX package

Beamer presentation class

• Incremental lists: This module adds four new environments to Beamer: itemized and enumerated lists, with and without alerting, that specify incremental overlays (each item on a new overlay). The alerted versions alert the item only the overlay where it first appears. (Beamer veterans: these incorporate the <+-> and <+-|alert@+> overlay specifications.) uploads:/Modules/beamer/beamer-incremented-lists.module (contributed by Paul A. Rubin)
• Beamer Fragile Frames: This module allows to include Sweave output or simple verbatim environments in Beamer presentations, using only native LyX functionality and without the need to use any raw LaTeX code. It provides this functionality via custom insets. Please check the attached template for instructions on using the module in Beamer presentations (see #7273 for more info). uploads:/Modules/beamer/beamer-fragile.module (contributed by Liviu Andronic)
  uploads:/Examples/Beamer/Liv/beamer-fragile-sweave-template.lyx
  uploads:/Examples/Beamer/Liv/beamer-fragile-sweave-template.pdf

Cosmetics

• Informal paragraph indenting and spacing The module allows both indented and extra-spaced raggedright paragraphs, suitable for informal letters to friends or family. Suitable for wide text body and narrow margins. http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg167341.html (contributed by Andrew Parsloe)
• Left-aligned headings: Typesets the headings (chapters, sections) ragged-right instead of justified in the LyX view. This does not affect the output, just the appearance in the LyX work area.uploads:/Modules/leftheadings.module

For the record: Modules (now) shipped with LyX

Theorem-related Modules

(Contributor: Paul A. Rubin)

• Bold face v. italics (bug fix): The four files here correct a small bug that can cause the words Theorem, Lemma etc. to appear in italics rather than bold face under certain circumstances. uploads:/Modules/theorems_1_6_3/theorem_fixes.zip
  These fixes are included in LyX 1.6.4 and newer.
• Consecutive numbering within type: The seven files here provide additional modules that allow you to number theorem-like environments consecutively within type, so that theorems, lemmas, propositions etc. each have their own separate sequence of numbers. There are standard, within section and within chapter versions. uploads:/Modules/theorems_1_6_3/theorems_by_type.zip
  These modules are included in LyX 1.6.5 and newer.
• Nesting case environments: As of version 2.0, nesting a case environment within another case environment will typically result in incorrect numbering of some items. Unzipping either the fix for LyX 1.6 or the fix for LyX 2.0 in your ~/.lyx/layouts directory and reconfiguring LyX should fix the problem.

Category: modules