>  Docs Center  >  Libraries  >  Daithi  >  IDL_LIB_HTML

IDL_LIB_HTML

IDL_LIB_HTML

Name


    IDL_LIB_HTML

Purpose


    This procedure creates the web page listing of a library's IDL utilities.

Category


    Miscellaneous

Calling Sequence


    IDL_LIB_HTML

Keyword Parameters


    ADMIN_WEB: The administrator's web page. The default is defined in the
        Constants section.
    ADMIN_NAME: The administrator's name. The default is defined in the
        Constants section.
    ADMIN_EMAIL: The administrator's e-mail address. The default is defined
        in the Constants section.
    CATEG: A list of function and procedure categories to which to restrict.
    FIRST_UPDATE: A vector of strings containing information on updates to be
        added before the list of routines.
    INDIR: A scalar or vector string containing the directories in which to
        search for files. The default is the current directory.
    INFILE: The flag for filenames to include in the library. The default is
        '*.pro'.
    MODIFIED_AUTHOR: If set then authors under the "Modified" heading are
        included as Contributors in the output webpage.
    OUTFILE: The filename for the output webpage. The default is
        'idl_lib.html'.
    REVERSE_CATEGORY: Order the categories in the output webpage in reverse
        alphabetical order. The default is alphabetical order.
    TAR: If set, then a .tar archive file is created containing all of the
        routines in the library. This archive will be included on the web
        page.
    TITLE_FIRST_UPDATE: A string contain the title of the FIRST_UPDATE list
        of information. The default is 'UPDATES'.
    TITLE_PAGE: The title of the web page.
    TITLE_UPDATE: A string contain the title of the UPDATE list of
        information. The default is 'UPDATES'.
    UPDATE: A vector of strings containing information on updates to be added
        after the list of routines.
    ZIP: If set, then a .zip archive file is created containing all of the
        routines in the library. This archive will be included on the web
        page.

Uses


    month_name.pro
    str.pro
    string_from_vector.pro

Procedure


    This procedure reads the documentation of the IDL files in the group
    utility directory, and creates a web page that lists them.

Modification History


    Written by: Daithi A. Stone (stoned@atm.ox.ac.uk), 2002-02-08.
    Modified: DAS, 2002-04-10 (STD.pro removal update)
    Modified: DAS, 2002-08-09 (CONSTANTS.pro changes update)
    Modified: DAS, 2002-11-29 (altered directory structure)
    Modified: DAS, 2002-12-06 (removed dependency on me)
    Modified: DAS, 2003-05-07 (renamed, and added ADMIN* keywords)
    Modified: DAS, 2004-06-24 (added old modification date printing)
    Modified: DAS, 2005-09-01 (added FIRST_UPDATE, FUTITLE, INDIR, INFILE,
        MODIFIED_AUTHOR, OUTFILE, REVERSE_CATEGORY, TITLE, UPDATE, UTITLE
        keywords; permitted multiple input directories; removed use of
        constants.pro)
    Modified: DAS, 2006-03-23 (corrected self-reference; increased
        modification highlighting to 90 days)
    Modified: DAS, 2007-05-24 (added TAR and ZIP options)
    Modified: DAS, 2008-12-01 (updated administrator details)
    Modified: DAS, 2011-11-06 (modified documentation; altered keyword
        parameter names; modified colours; added CATEG keyword; introduced
        removal of middle initials in names; allowed multiple categories per
        file)
    Modified: DAS, 2013-07-19 (switched from use of findfile to file_search)



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us