| 
    PLearn 0.1 
   | 
 
#include <HTMLHelpCommand.h>


Public Member Functions | |
| virtual string | classname () const | 
| virtual OptionList & | getOptionList () const | 
| virtual OptionMap & | getOptionMap () const | 
| virtual RemoteMethodMap & | getRemoteMethodMap () const | 
| virtual HTMLHelpConfig * | deepCopy (CopiesMap &copies) const | 
Static Public Member Functions | |
| static string | _classname_ () | 
| static OptionList & | _getOptionList_ () | 
| static RemoteMethodMap & | _getRemoteMethodMap_ () | 
| static Object * | _new_instance_for_typemap_ () | 
| static bool | _isa_ (const Object *o) | 
| static void | _static_initialize_ () | 
| static const PPath & | declaringFile () | 
Public Attributes | |
| string | output_dir | 
| Directory where the .html files should be generated.   | |
| string | html_index_document | 
| Filename containing the main index file (index.html).   | |
| string | html_prolog_document | 
| Filename containing the "top" of the HTML document (including an opening <body> tag)   | |
| string | html_epilog_document | 
| Filename containing the "bottom" of the HTML document (including the closing </body> tag)   | |
Static Public Attributes | |
| static StaticInitializer | _static_initializer_ | 
Static Protected Member Functions | |
| static void | declareOptions (OptionList &ol) | 
| Declares this class' options.   | |
Private Types | |
| typedef Object | inherited | 
Definition at line 135 of file HTMLHelpCommand.h.
typedef Object PLearn::HTMLHelpConfig::inherited [private] | 
        
Reimplemented from PLearn::Object.
Definition at line 137 of file HTMLHelpCommand.h.
| string PLearn::HTMLHelpConfig::_classname_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| OptionList & PLearn::HTMLHelpConfig::_getOptionList_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| RemoteMethodMap & PLearn::HTMLHelpConfig::_getRemoteMethodMap_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| Object * PLearn::HTMLHelpConfig::_new_instance_for_typemap_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| StaticInitializer HTMLHelpConfig::_static_initializer_ & PLearn::HTMLHelpConfig::_static_initialize_ | ( | ) |  [static] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| string PLearn::HTMLHelpConfig::classname | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| void PLearn::HTMLHelpConfig::declareOptions | ( | OptionList & | ol | ) |  [static, protected] | 
        
Declares this class' options.
Reimplemented from PLearn::Object.
Definition at line 72 of file HTMLHelpCommand.cc.
References PLearn::OptionBase::buildoption, PLearn::declareOption(), html_epilog_document, html_index_document, html_prolog_document, and output_dir.
{
    declareOption(ol, "output_dir", &HTMLHelpConfig::output_dir,
                  OptionBase::buildoption,
                  "Directory where the .html files should be generated");
    declareOption(ol, "html_index_document", &HTMLHelpConfig::html_index_document,
                  OptionBase::buildoption,
                  "Filename containing the main index file (index.html).  If missing,\n"
                  "a default index is generated.  Note that the prolog and epilog are\n"
                  "always generated for this file.");
    
    declareOption(ol, "html_prolog_document", &HTMLHelpConfig::html_prolog_document,
                  OptionBase::buildoption,
                  "Filename containing the \"top\" of the HTML document (including an\n"
                  "opening <body> tag");
                
    declareOption(ol, "html_epilog_document", &HTMLHelpConfig::html_epilog_document,
                  OptionBase::buildoption,
                  "Filename containing the \"bottom\" of the HTML document (including the\n"
                  "closing </body> tag");
                
    inherited::declareOptions(ol);
}

| static const PPath& PLearn::HTMLHelpConfig::declaringFile | ( | ) |  [inline, static] | 
        
Reimplemented from PLearn::Object.
Definition at line 163 of file HTMLHelpCommand.h.
| HTMLHelpConfig * PLearn::HTMLHelpConfig::deepCopy | ( | CopiesMap & | copies | ) |  const [virtual] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| OptionList & PLearn::HTMLHelpConfig::getOptionList | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| OptionMap & PLearn::HTMLHelpConfig::getOptionMap | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
| RemoteMethodMap & PLearn::HTMLHelpConfig::getRemoteMethodMap | ( | ) |  const [virtual] | 
        
Reimplemented from PLearn::Object.
Definition at line 70 of file HTMLHelpCommand.cc.
Reimplemented from PLearn::Object.
Definition at line 163 of file HTMLHelpCommand.h.
Filename containing the "bottom" of the HTML document (including the closing </body> tag)
Definition at line 154 of file HTMLHelpCommand.h.
Referenced by declareOptions(), PLearn::HTMLHelpCommand::helpClasses(), PLearn::HTMLHelpCommand::helpCommands(), PLearn::HTMLHelpCommand::helpIndex(), PLearn::HTMLHelpCommand::helpOnClass(), and PLearn::HTMLHelpCommand::helpOnCommand().
Filename containing the main index file (index.html).
If missing, a default index is generated. Note that the prolog and epilog are always generated for this file.
Definition at line 146 of file HTMLHelpCommand.h.
Referenced by declareOptions(), and PLearn::HTMLHelpCommand::helpIndex().
Filename containing the "top" of the HTML document (including an opening <body> tag)
Definition at line 150 of file HTMLHelpCommand.h.
Referenced by declareOptions(), PLearn::HTMLHelpCommand::helpClasses(), PLearn::HTMLHelpCommand::helpCommands(), PLearn::HTMLHelpCommand::helpIndex(), PLearn::HTMLHelpCommand::helpOnClass(), and PLearn::HTMLHelpCommand::helpOnCommand().
Directory where the .html files should be generated.
Definition at line 141 of file HTMLHelpCommand.h.
Referenced by declareOptions().
 1.7.4