Chris@383: # configuration file for generation of html-docu from m-files Chris@383: # Chris@383: # Author: Hartmut Pohlheim Chris@383: # History: 05.11.2000 file created (parameters for mtree2html2001) Chris@383: # Chris@383: # The following options/variables must be changed/adapted: Chris@383: # dirmfiles Chris@383: # dirhtml Chris@383: # csslink Chris@383: # texttitleframelayout Chris@383: # texttitlefiles Chris@383: # Chris@383: # The following options/variables should be adapted: Chris@383: # authorfile Chris@383: # filenametopframe Chris@383: # codeheadmeta Chris@383: Chris@383: #======================================================================== Chris@383: # Variables (possible keywords: set) Chris@383: # to use the built-in settings, comment the line using # in first column Chris@383: #======================================================================== Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # dirmfiles: name of directory containing Matlab m-files Chris@383: # dirhtml: name of directory to place the html-files into Chris@383: # exthtml: extension used for the html files (.html or .htm) Chris@383: # don't forget the point in front of the extension Chris@383: #------------------------------------------------------------------------ Chris@383: set dirmfiles = . Chris@383: set dirhtml = doc-output Chris@383: set exthtml = .html Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # authorfile: name of file containing info about author (in html) Chris@383: # if defined, this text is included at the bottom of the Chris@383: # html files Chris@383: #------------------------------------------------------------------------ chris@410: set authorfile = matlab-docs-credit.html Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # csslink: text for linking to css file (style sheets) Chris@383: # the text defined here is directly included into the head Chris@383: # of the html file Chris@383: #------------------------------------------------------------------------ chris@410: #set csslink = Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # links2filescase: this is a bit difficult Chris@383: # Matlab is case sensitive on UNIX, but case insensitive Chris@383: # on Windows. Under UNIX Matlab function calls work Chris@383: # only, when the case of file name and function call are Chris@383: # identical, under Windows you can do what you want. Chris@383: # This scripts help you, to keep an exact case in your Chris@383: # project. Chris@383: # exact - internal links are only generated, when case of file Chris@383: # name and in source code are identical Chris@383: # all - case doesn't matter Chris@383: # exactupper - same as exact, additionally links are also vreated to Chris@383: # all upper case function names in source code (often Chris@383: # used by Mathworks) Chris@383: # exactvery - same as exact, additionally info about not matching Chris@383: # case is written to screen (stdout), this can be very Chris@383: # helpful in cleaning up the case in a project Chris@383: #------------------------------------------------------------------------ Chris@383: set links2filescase = all Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # texttitleframelayout: text of title for frame layout file (whole docu) Chris@383: #------------------------------------------------------------------------ chris@389: set texttitleframelayout = MATLAB Function Documentation Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # texttitle/headerindexalldirs: text of title and header for directory index Chris@383: #------------------------------------------------------------------------ Chris@383: set texttitleindexalldirs = Index of Directories Chris@383: set textheaderindexalldirs = Index of Directories Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # texttitle/headerindex: text of title and header for index file Chris@383: #------------------------------------------------------------------------ Chris@383: set texttitleindex = A-Z Index of Functions Chris@383: set textheaderindex = A-Z Index of Functions Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # texttitle/headerfiles: text of title and header for files Chris@383: # name of file will be added at the end Chris@383: #------------------------------------------------------------------------ chris@389: set texttitlefiles = Function Chris@383: set textheaderfiles = Documentation of Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # frames: whether to use frames in layout (yes or no) Chris@383: #------------------------------------------------------------------------ Chris@383: set frames = no Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # filenametopframe: name of file including frame layout (highest level file) Chris@383: # [default: index] Chris@383: #------------------------------------------------------------------------ Chris@383: set filenametopframe = index Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # textjumpindexglobal: text displayed for jump to index of all files Chris@383: # (global) Chris@383: # textjumpindexlocal: text displayed for jump to index of files in actual Chris@383: # directory (local) Chris@383: #------------------------------------------------------------------------ chris@389: set textjumpindexglobal = Index of all files: chris@389: set textjumpindexlocal = this subdirectory only: Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # includesource: include source of m-files in documentation [YES|no] Chris@383: #------------------------------------------------------------------------ Chris@383: set includesource = yes Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # usecontentsm: use contents.m files as well for structured Chris@383: # (hopefully) index [YES|no] Chris@383: #------------------------------------------------------------------------ Chris@383: set usecontentsm = no Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # includesource: write/update contents.m files [yes|NO] Chris@383: #------------------------------------------------------------------------ Chris@383: set writecontentsm = no Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # processtree: parse whole directory tree recursively [YES|no] Chris@383: #------------------------------------------------------------------------ Chris@383: set processtree = yes Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # producetree: produce tree for html-files in same structure than Chris@383: # tree of m-files [yes|NO] Chris@383: # if no, all files are saved in the same directory, often Chris@383: # easier for outside linking to files Chris@383: #------------------------------------------------------------------------ chris@401: set producetree = yes Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # codebodyindex/files: HTML-code for adding to BODY tag Chris@383: # can be used for defining colors and Chris@383: # backgroundimages of the files Chris@383: # No longer recommended, use the css file Chris@383: #------------------------------------------------------------------------ Chris@383: set codebodyindex = Chris@383: set codebodyfiles = Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # codeheadmeta: HTML-code added in HEAD area, use for supplying META info Chris@383: #------------------------------------------------------------------------ Chris@383: set codeheadmeta = Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # codehr: HTML-code used to define a
, do what you want Chris@383: #------------------------------------------------------------------------ chris@411: set codehr =
Chris@383: Chris@383: #------------------------------------------------------------------------ Chris@383: # codeheader: HTML-code added to tags, use for centering header text Chris@383: # or changing the colour/size/font of the header text Chris@383: #------------------------------------------------------------------------ chris@389: set codeheader = Chris@383: Chris@383: Chris@383: # End of parameter file