2 Configuration File
MkHelp.ini config file is divided into many sections :
- Common :
- cmdline : Put here all default cmdline options
- generator.language.default : specify with language section is used for generate html files
- generator.path.server : specify the C++ source server
- generator.fistpage : name of the root doc
- generator.html.version : same as cmdline -2, generate HTML 2.0 compliant files
- [English]
- generator.lib.type : specify the number, and class first letters for objects name for sort. In the case "RW,ya,yg,z,T" all name class/struct/union started with RW will be put in the library "Rogue Wave" and so on...
- generator.lib.name : specify the name of each library. for exemple "RogueWave,ya,yg,zApp,Borland" all name class started with T will be put in Borland lib.
- generator.lib.default.name : specify otherwise case. All that not match "RW,ya,yg,z,T" will be put in lib named "Misc"
- Language2 you can add here all languages you want, just cut/paste upper section.... and translate into the new laguage.. I give french exemple...
- Language3
...
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 Config File
//
[Common]
cmdline =
//generator.language.default = "Francais"
generator.language.default = "English"
generator.path.server = "koala.ldf-paris"
generator.fistpage = "index.html"
generator.html.version = "2"
//
// Configuration file for xxx.html
// generation in english
//
[English]
generator.lib.type = "RW,ya,yg,z,T"
generator.lib.name = "RogueWave,ya,yg,zApp,Borland"
generator.lib.default.name = "Misc"
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 = "example"
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"