anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-12-23 13:31:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add some module related comments.

Browse Source 
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@27002 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Richard Heck 2008-10-20 21:11:49 +00:00
parent 85cf71f69a
commit 5537e8a6b5
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/ModuleList.h
View File

@ -21,7 +21,25 @@ namespace lyx {
/**
* This struct represents a particular LyX "module", which is a like a layout
* file, except that it does not stand alone. In that sense, it is more like
* a LaTeX package, where a layout file corresponds to a LaTeX class.
* a LaTeX package, where a layout file corresponds to a LaTeX class. Or, in
* LyX's own terms, a module is more like an included file that can be used
* with various document classes. The difference is that using a module only
* means selecting it in the Document>Settings dialog, whereas including a
* layout file means layout file editing.
*
* In general, a given module can be used with any document class. That said,
* one module may `require' another, or it may `exclude' some other module.
* The requires and excludes are given in comments within the module file,
* which must begin roughly so:
* #\DeclareLyXModule{Theorems (By Section)}
* #DescriptionBegin
* #Numbers theorems and the like by section.
* #DescriptionEnd
* #Requires: theorems-std | theorems-ams
* #Excludes: theorems-chap
* The description is used in the gui to give information to the user. The
* Requires and Excludes lines are read by the configuration script and
* written to a file lyxmodules.lst in the user configuration directory.
*/
class LyXModule {