2 Configuration File
MkHelp.ini config file is divided into many sections :
- [Common]
- generator.lexer.keyword.ignore : specify exotic compiler keyword to ignore
- generator.preprocessor.define : specify compiler internal defines, ex : "-D __BCOPT__=1 ..."
- generator.preprocessor.include : specify path for include files, ex : "-I c:. -I c:\bc5\include ..."
- generator.language.default : specify wich language section is used to generate HTML files
- generator.url.server : specify the C++ source server
- generator.fistpage : name of the root doc
- generator.html.version : same as cmdline -3, generate HTML 3.2 compliant files
- generator.html.frame.header.bgcolor : when -f option is on, this line describe header bgcolor (ex : "#E0E0A0")
- generator.html.frame.body.bgcolor : when -f option is on, this line describe body bgcolor (ex : "")
- generator.html.noframe.bgcolor : when -f option is off, this line describe body bgcolor (ex : "")
- [English]
- generator.lib.type : specify the list of first letters for each set of
classes to be associated with a library. The default is "C,tag,H,AFX,_" in which,
for the first item, all names of class/struct/union
starting with 'C' will be put in the corresponding generator.lib.name library "MS-Fund.
Classes" and so on... Thus, be carefull to the order of elements in this list.
- generator.lib.name : specify the list of library names that will
be available in the Main Index. The library concept allows to associate each
class corresponding on the generator.lib.type key. The default is
"MS-Fund. Classes,MS-Struct,MS-Handles,MS-AFX Classes,MS-Misc". For example,
all classnames starting with AFX will be put in MS-AFX Classes lib.
- generator.lib.default.name : specify otherwise cases. All names that do not match "C,tag,H,AFX,_" will be put in lib named "Misc"
- generator.classes.exclude : specify in regular expression format the name of classes excluded from the parse.
For example ".*stream.*|^y.*" means all classnames with 'stream' in the name or all classnames starting by 'y' will be excluded from parse ( and generate too)
For regexp the 'special characters' are : + * ? . [ ] ^ $ |
- [Francais]
- [Language3] you can add here all languages you want, just cut/paste upper section.... and translate into the new laguage.. I give french exemple...
- [Language4]
...
Warning : the cmdline option have always higher priority than mkhelp.ini same options.
ex : >mkhelp -1 .....
with generator.html.version = "2" in mkhelp.ini : the winner is -1
//
// MkHelp 1.0.1 Release (c) 1996 Thierry Wilmot & Gerard Melka
// Email wilmot@mail.club-internet.fr
//
// Evaluation Config File
//
[Common]
generator.lexer.keyword.ignore = "" // Add here keywords to be ignored
// the following lines are given for Visual C++ 4.x compiler
// and must be change to match your compiler internal defines and library path
//generator.preprocessor.define = "-D WIN32 -D _WINDOWS -D _AFXDLL -D _MBCS -D _MSC_VER=0x900"
//generator.preprocessor.include = "-I c:. -I c:\msdev\include -I c:\msdev\mfc\include"
// the following lines are given for Borland C++ 5.x compiler
// and must be change to match your compiler internal defines and library path
generator.preprocessor.define = "-D __BCOPT__=1 -D __BCPLUSPLUS__=0x340 -D __BORLANDC__=0x460 -D __CDECL__=1 -D _CHAR_UNSIGNED=1 -D __CONSOLE__ -D _CPPUNWIND=1 -D __cplusplus=1 -D _M_IX86=300 -D __MT__=1 -D __STDC__=1 -D __TCPLUSPLUS__=0x340 -D __TEMPLATES__=1 -D __TLS__=1 -D __TURBOC__=0x460 -D _WCHAR_T=1 -D _WCHAR_T_DEFINED=1 -D _Windows -D __WIN32__=1"
generator.preprocessor.include = "-I c:. -I c:\bc5\include"
// the following lines are given for Sun SparcWorks C++ 4.x compiler
// and must be change to match your compiler internal defines and library path
//generator.preprocessor.include = "-I. -I/usr/include -I/home/opt/SUNWspro/SC3.0.1/include/CC -I/usr/dt/include -I/usr/openwin/include -I/usr/openwin/include/X11 "
//generator.preprocessor.define = "-D__SUNPRO_CC=0x401 -D__cplusplus -Dunix -Dsun -Dsparc -D__unix -D__sun -D__sparc -D__BUILTIN_VA_ARG_INCR -D__SVR4 -Dc_plusplus"
//generator.language.default = "Francais"
generator.language.default = "English" // Name of language section used
generator.url.server = "file:///" // Define the server name in generated URL for include file references
generator.fistpage = "index.html" // First page name
generator.html.version = "3" // Force generation in HTML 3.2
generator.html.frame.header.bgcolor = "#E0E0A0" // upper frame background color when -f option ON
generator.html.frame.body.bgcolor = "" // lower frame background color when -f option ON
generator.html.noframe.bgcolor = "" // Background color when -f option OFF
//
// Configuration file for xxx.html
// generation in English
//
[English]
generator.lib.type = "C,tag,H,AFX,_"
generator.lib.name = "MS-Fund. Classes,MS-Struct,MS-Handles,MS-AFX Classes,MS-Misc"
generator.lib.default.name = "Misc"
generator.classes.exclude = ""
generator.classes.exclude = ""
comment.description = "Description :"
comment.example = "sample"
comment.author.nobody = "nobody"
comment.version.unknown = "unknown"
footer.name = "Last update :"
footer.by = " by "
class.abstract = "abstract"
class.library = "Library"
class.source = "Source :"
class.file = "File :"
class.author = "Author :"
class.update = "Update :"
class.version = "Version :"
function.constructor = "Constructors :"
function.destructor = "Destructors :"
function.operator = "Operators :"
function.public = "Public Function :"
function.protected = "Protected Function :"
funtion.private = "Private Function :"
data.public = "Public Data :"
data.protected = "Protected Data :"
data.private = "Private Data :"
file.name = "File :"
file.author = "Author :"
file.update = "Update :"
file.version = "Version :"
file.classdef = "Classes definition :"
file.typedef = "Typedef definition :"
file.functiondef = "Function prototype definition :"
firstpage.title = "My doc"
firstpage.header = "Main Index : "
firstpage.author = "Authors : "
firstpage.version = "Version : "
firstpage.library = "list of libraries :"
firstpage.libname = "Library : "
firstpage.file = "List of files :"
firstpage.filename = "File :"
hppfile.title = "Files hpp (h,hxx) library"
hppfile.header = "Files library : "
hppfile.countname = " Files"
cppfile.title = "Files cpp (c,cxx) library"
cppfile.header = "Files library : "
cppfile.author = "Authors : "
cppfile.version = "Version : "
cppfile.countname = " Files"
libfile.title = "library"
libfile.header = "library : "
libfile.author = "Authors : "
libfile.version = "Version : "
libfile.countname = " Classes"
//
// Fichier de configuration pour la generation
// des xxx.html en Francais
//
[Francais]
generator.lib.type = "RW,ya,yg,z"
generator.lib.name = "RogueWave,ya,yg,zApp"
generator.lib.default.name = "Divers"
comment.description = "Déscription :"
comment.example = "exemple"
comment.author.nobody = "Inconnu"
comment.version.unknown = "Aucune"
footer.name = "Dernière mise à jour :"
footer.by = " par "
class.abstract = "Abstraite"
class.library = "Librairie"
class.source = "Source :"
class.file = "Fichier :"
class.author = "Auteur"
class.update = "Maj :"
class.version = "Version"
function.constructor = "Constructeur(s):"
function.destructor = "Destructeur(s):"
function.operator = "Operateur(s):"
function.public = "Fonctions 'Public':"
function.protected = "Fonctions 'Protected':"
funtion.private = "Fonctions 'Private':"
data.public = "Données 'Public':"
data.protected = "Données 'protected':"
data.private = "Données 'Private':"
file.name = "Fichier :"
file.author = "Auteur(s) :"
file.update = "Maj :"
file.version = "Version :"
file.classdef = "Définition des classes :"
file.typedef = "Définition des typedefs :"
file.functiondef = "Définition des prototypes de functions :"
firstpage.title = "Index Principal"
firstpage.header = "Index Principal : "
firstpage.author = "Auteur(s) : "
firstpage.version = "Version : "
firstpage.library = "Reference par librairies :"
firstpage.libname = "Librairie : "
firstpage.file = "Reference par fichiers :"
firstpage.filename = "Fichier :"
hppfile.title = "Librairie de fichiers hpp (h,hxx)"
hppfile.header = "Librairie de fichiers : "
hppfile.countname = " Fichiers"
cppfile.title = "Librairie de fichiers cpp (c,cxx)"
cppfile.header = "Librairie de fichiers : "
cppfile.author = "Auteur(s) : "
cppfile.version = "Version : "
cppfile.countname = " Fichiers"
libfile.title = "Librairie"
libfile.header = "Librairie : "
libfile.author = "Auteur(s) : "
libfile.version = "Version : "
libfile.countname = " Classes"