lyx_mirror/lib/layouts/theorems-withinchap.module

#\DeclareLyXModule{Defines some theorem environments for use with non-AMS classes. The theorems are numbered within chapters of the document. NOTES: This module should therefore be used only with document classes that define a chapter environment. Only one of the theorem modules should be used at a time.}{Theorems (By Chapter)}

# Author: Richard Heck <rgheck@comcast.net>
# Adapted from amsmaths.inc

Format 6

Counter
	Name           theorem
	Within         chapter
End

Input theorems.inc
Add a note to the theorem module descriptions. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@20341 a592a061-630c-0410-9148-cb99ea01b6c8 2007-09-18 16:27:14 +00:00			`#\DeclareLyXModule{Defines some theorem environments for use with non-AMS classes. The theorems are numbered within chapters of the document. NOTES: This module should therefore be used only with document classes that define a chapter environment. Only one of the theorem modules should be used at a time.}{Theorems (By Chapter)}`
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. 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 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. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (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 set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8 2007-08-29 17:59:49 +00:00
			`# Author: Richard Heck <rgheck@comcast.net>`
			`# Adapted from amsmaths.inc`

* Requires tag for classes, layouts and custom insets * * src/TextClass{cpp,h}: - implement Requires tag for class and InsetLayout. * src/Layout.{cpp,h}: - implement Requires tag for layouts. - increase layouts format to 6. * src/Paragraph.cpp: - request required features for paragraph layouts. * src/LaTeXFeatures.cpp: - add some packages needed by modules. - remove Preamble method for InsetLayout. This is now done in InsetFlex::validate. * src/BufferParams.cpp (validate): - request required features for the class. * src/insets/InsetLayout.h: - new member "requires". * src/insets/InsetFlex.{cpp,h}: - implement validate method and request required features and preamble snippets. * lib/layouts/.{layout,module,inc}: - increase layouts format to 6. - use Requires tags in some modules (more can be done later). lib/doc/Customization.lyx: - document Requires tag. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@22414 a592a061-630c-0410-9148-cb99ea01b6c8 2008-01-07 16:59:10 +00:00			`Format 6`
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. 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 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. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (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 set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8 2007-08-29 17:59:49 +00:00
			`Counter`
			`Name theorem`
			`Within chapter`
			`End`

Modularize the theorem modules. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19952 a592a061-630c-0410-9148-cb99ea01b6c8 2007-08-31 15:01:17 +00:00			`Input theorems.inc`