checkhlpfiles.hlp

来自「是一个经济学管理应用软件 很难找的 但是经济学学生又必须用到」· HLP 代码 · 共 220 行

{smcl}
{* 09mar2005}{...}
{cmd:help checkhlpfiles}{right:also see:  {help undocumented}}
{hline}

{title:Title}

{pstd}
{cmd:checkhlpfiles} {hline 2} Help-file error checking


{title:Syntax}

{p 8 16 2}
{cmd:checkhlpfiles}
{cmd:help}
[{cmd:,}
{cmd:path(}{it:path}{cmd:)}
{cmdab:s:ystem}
]

{p 8 16 2}
{cmd:checkhlpfiles}
{cmd:dialog}
[{cmd:,}
{cmd:path(}{it:path}{cmd:)}
{cmdab:s:ystem}
]

{p 8 16 2}
{cmd:checkhlpfiles}
{cmd:manual}
[{cmd:,}
{cmd:path(}{it:path}{cmd:)}
{cmdab:s:ystem}
]

{p 8 16 2}
{cmd:checkhlpfiles}
{cmd:stata}
[{cmd:,}
{cmd:path(}{it:path}{cmd:)}
{cmdab:s:ystem}
]

{p 8 16 2}
{cmd:checkhlpfiles}
{cmd:doublebang}
[{cmd:,}
{cmd:path(}{it:path}{cmd:)}
{cmdab:s:ystem}
]

{phang}
Also used by {cmd:checkhlpfiles} are the files{break}

		{cmd:*.hlp}
		{cmd:*.dlg}
		{cmd:hlpnotused.maint}
		{cmd:manref.maint}

		{cmd:ahelp_alias.maint}
		{cmd:bhelp_alias.maint}
		...
		{cmd:zhelp_alias.maint}

{phang}
You must be using {help SpecialEdition:Stata/SE} to use {cmd:checkhlpfiles}.


{title:Description}

{pstd}
{cmd:checkhelpfiles} is a tool used by StataCorp to verify that the
{cmd:*.hlp} files contain no linkage errors.

{pstd}
For {cmd:checkhlpfiles help} the help files are divided into two clases 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.hlp.
All of these files (except contents.hlp) have names beginning with "y_".  All
other help files are "base".


{title:Description of checkhlpfiles help}

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

{phang2}
	{bf:leaves}{break}
	Help files that contain no 
	{cmd:{c -(}help }...{cmd:{c )-}} links.

{phang2}
	{bf:From base help files:  referenced but do not exist}{break}
	{cmd:{c -(}help }...{cmd:{c )-}} linkages to nonexisting help files
	among all non {cmd:y_*.hlp} help files.

{phang2}
	{bf:From base help files:  exist but not referenced}{break}
	Help files that exist but not refrenced among all non
	{cmd:y_*.hlp} help files, with the removal of the names listed
	in file {cmd:hlpnotused.maint}.

{phang2}
	{bf:From base help files:  referenced but should not be}{break}
	{cmd:{c -(}help }...{cmd:{c )-}} linkages
        from non {cmd:y_*.hlp} files to help files that are listed in file
        {cmd:hlpnotused.maint}.

{phang2}
	{bf:From contents help files:  referenced but do not exist}{break}
	{cmd:{c -(}help }...{cmd:{c )-}} linkages to nonexisting help files
	among all {cmd:y_*.hlp} help files.

{phang2}
	{bf:From contents help files:  exist but not referenced}{break}
	Help files that exist but not refrenced among all
	{cmd:y_*.hlp} help files, with the removal of the names listed
	in file {cmd:hlpnotused.maint}.

{phang2}
	{bf:From contents help files:  referenced but should not be}{break}
	{cmd:{c -(}help }...{cmd:{c )-}} linkages
        from non {cmd:y_*.hlp} files to help files that are listed in file
        {cmd:hlpnotused.maint}.

{pstd}
The {cmd:helpnotused.maint} file has the following syntax:

	{cmd:*} comments
	{it:blank lines}

	{it:name} [{cmd:contents}|{cmd:base}|{cmd:both}]

{pstd}
If {cmd:contents}, {cmd:base}, or {cmd:both} are not specified for a
{it:name}, {cmd:both} is assumed.  {it:name} is specified without the
{cmd:.hlp} suffix.


{title:Description of checkhlpfiles dialog}

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


{title:Description of checkhlpfiles manual}

{pstd}
{cmd:checkhlpfiles} {cmd:manual} examines all the
{cmd:{c -(}hi:[}...{cmd:{c )-}} links {it:(sic)} and
{cmd:{c -(}bf:[}...{cmd:{c )-}} links {it:(sic)} in the help files.  Two lists
are produced:  Files referenced but not in {cmd:manref.maint}, and files not
referenced that are in {cmd:manref.maint}.  File {cmd:manref.maint} should
contain a list of valid manual references.  Its syntax is

	{cmd:*} comments
	{it:blank lines}

	{cmd:[}{it:string}{cmd:]} {it:string}{right:(brackets significant)}


{title:Description of checkhlpfiles stata}

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


{title:Description of checkhlpfiles doublebang}

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


{title:Options (all commands)}

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

{phang}
{cmd:system} is an alternative to specifying {cmd:path()}.
Specifying {cmd:system} is equivalent to specifying
{cmd:path("UPDATES;BASE")}.


{title:Also see}

{psee}
Online:  
{helpb checkdlgfiles},
{help smcl},
{help sysdir};
{help contents}
{p_end}