Stata 15 help for checkhlpfiles

Title

[P] checkhlpfiles -- Help-file error checking

Syntax

check_help

checkhlpfiles stata [, path(path) system ]

checkhlpfiles doublebang [, path(path) system ]

The following subcommand is partially deprecated; see check_help above.

checkhlpfiles help [, path(path) system ]

The following subcommand is mostly deprecated; see check_help above.

checkhlpfiles dialog [, path(path) system ]

Also used by check_help and checkhlpfiles are the files

*.sthlp *.ihlp *.hlp (if any) *.dlg hlpnotused.maint validpdflinks.maint

ahelp_alias.maint bhelp_alias.maint ... zhelp_alias.maint

fsmcl_alias.maint gsmcl_alias.maint (etc)

You must be using Stata/MP or Stata/SE to use checkhlpfiles.

Description

check_help and checkhlpfiles are tools used by StataCorp to verify that the *.sthlp files contain no linkage errors.

Description of check_help

check_help checks all files ending in .sthlp and .ihlp that are found in the BASE system directory (see sysdir) for broken help file links from smcl directives help, helpb, manhelp, manhelpi, opth, vieweralsosee, and viewerjumpto. It also checks for broken manual links from smcl directives mansection, manlink, manlinki, findalias, and vieweralsosee.

Description of checkhlpfiles dialog

checkhlpfiles dialog examines all the {dialog ...} links in the help files (.sthlp, .hlp, and .ihlp files). Any broken links are reported; along with the lists of dialogs referred to that do not exist and dialogs not referred to that do exist.

Description of checkhlpfiles stata

checkhlpfiles stata examines all the {stata ...} links in the help files (.sthlp, .hlp, and .ihlp files). Any files containing invalid Stata commands (as determined by which) are listed and two lists are produced: commands used but that do not exist and commands used that exist.

Description of checkhlpfiles doublebang

checkhlpfiles doublebang examines all *.sthlp, *.hlp, *.ihlp, and *.maint files and lists the names of those that have lines containing two exclamation points, one next to the other, that is, ! followed by !. StataCorp uses "doublebangs" to flag problems.

Description of checkhlpfiles help (partially deprecated)

For checkhlpfiles help, the help files are divided into two classes called "base help files" and "contents help files". The "contents" help files are those that make up the hierarchy of help files whose root is contents.sthlp. All of these files (except contents.sthlp) have names beginning with "contents_". All other help files are "base".

checkhlpfiles help examines all the {help ...}, {helpb ...}, {manhelp ...}, {manhelpi ...}, and {opth ...}, links in the help files (.sthlp, .hlp, and .ihlp files). In the explanations below, we mention only {help ...}, but the comments apply to the other help link smcl directives as well. Any broken links are reported, along with the following lists:

leaves Help files that contain no {help ...} links.

From base help files: referenced but do not exist {help ...} linkages to nonexisting help files among all non contents*.sthlp help files.

From base help files: exist but not referenced Help files that exist but are not referenced among all non contents*.sthlp help files, with the removal of the names listed in file hlpnotused.maint.

From base help files: referenced but should not be {help ...} linkages from non contents*.sthlp files to help files that are listed in file hlpnotused.maint.

From contents help files: referenced but do not exist {help ...} linkages to nonexisting help files among all contents*.sthlp help files.

From contents help files: exist but not referenced Help files that exist but not referenced among all contents*.sthlp help files, with the removal of the names listed in file hlpnotused.maint.

From contents help files: referenced but should not be {help ...} linkages from non contents*.sthlp files to help files that are listed in file hlpnotused.maint.

The helpnotused.maint file has the following syntax:

* comments blank lines

name [contents|base|both]

If contents, base, or both are not specified for a name, both is assumed. name is specified without the .sthlp suffix.

Options

path() specifies the search path for locating *.sthlp, *.hlp, *.ihlp, *.dlg, and *.maint files. The default is path(`c(adopath)').

system is an alternative to specifying path(). Specifying system is equivalent to specifying path("BASE").


© Copyright 1996–2018 StataCorp LLC   |   Terms of use   |   Privacy   |   Contact us   |   What's new   |   Site index