X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FModuleList.h;h=66353affe35928ad443503fe3f5aac64733eda1c;hb=24fe5b08c0e1dfb739738acb6fc995da7315d35f;hp=0ef152c06962ec2ee39a27169eb464e3010be936;hpb=a940cc3f6b46a21c2738e9ad409bfacbde5320e6;p=lyx.git

diff --git a/src/ModuleList.h b/src/ModuleList.h
index 0ef152c069..66353affe3 100644
--- a/src/ModuleList.h
+++ b/src/ModuleList.h
@@ -21,7 +21,28 @@ 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.
+ *
+ *  Modules can also be "provided" or "excluded" by document classes, using
+ *  the ProvidesModule and ExcludesModule tags.
  */
 
 class LyXModule {