Go to page:

Search:   Help

Developers' side bar

Selected categories


Shared groups



Categories: Development, LyX_1_6
<< | Page list | >>

Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes.

Table of contents

  1. Design goal
  2. Issues
  3. Categories

Design goal

Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc.

This second patch adds the backend. The ModuleList class holds a list of the available modules, which are retrieved from lyxmodules.lst, itself generated by configure.py. There are two LFUNs available: modules-clear and module-add, which do the obvious thing; you can test by typing these into the minibuffer, along with the name of one of the available modules: URL (a CharStyle), Endnote (a Custom Inset), and---with the spaces---End To Foot (View>LaTeX and look at the user preamble), which are themselves in lib/layouts. The GUI will come next. A theorems module will follow, when I get a chance. Other ideas more than welcome!


(i) The configure.py script could be improved. It'd be nice, for example, if it tested for the presence of the LaTeX packages a particular module needs. But this would mean re-working the LaTeX script, and I don't know how to do that. Note that at present, the packages are ignored. This will change shortly.

(ii) I've used std::string in LyXModule, following what seemed to be a precedent in TextClass. If some of these should be docstrings, please let me know, and I'll change them.

(iii) There is at present no distinction between LaTeX and DocBook modules. Should there be? That is: Should there be modules that are available when the document class is a LaTeX class and others that are available only when it is DocBook? Or should there just be one modules?


Category: Development, LyX_1_6

Edit - History - Print - Recent Changes - All Recent Changes - Search
Page last modified on 2007-08-24 19:53 CEST