smcl.hlp

是一个经济学管理应用软件 很难找的 但是经济学学生又必须用到

{title:Link directives for use in line and paragraph modes}

{pstd}
All the link commands share the feature that when syntax 4 is allowed,

{center:Syntax 4:  {cmd:{c -(}xyz} {it:args}{cmd::}{it:text}{cmd:{c )-}}}

{pstd}
then syntax 3 is also allowed,

{center:Syntax 3:  {cmd:{c -(}xyz} {it:args}{cmd:{c )-}}     }

{pstd}
and, if syntax 3 is specified, Stata treats it as if you specified syntax 4,
inserting a colon and then repeating the argument.

{pstd}
The link directives, which may be used in either line mode or paragraph
mode, are

    {cmd:{c -(}help} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}help{c )-}} displays {it:args} as a link to {cmd:help}
{it:args}.  If you also specify the optional {cmd:}{it:text}, {it:text}
is displayed instead of {it:args}, but you are still directed to the help
file for {it:args}.

    {cmd:{c -(}helpb} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}helpb{c )-}} is equivalent to {cmd:{c -(}help{c )-}},
except that {it:args} or {it:text} is displayed in bold.

    {cmd:{c -(}manhelp} {it:args1 args2}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}manhelp{c )-}} displays {cmd:[}{it:args2}{cmd:]} {it:args1} as 
a link to {cmd:help} {it:args1}; thus,
{cmd:{c -(}manhelp summarize R{c )-}} would display
{manhelp summarize R}.  Specifying the optional {cmd::}{it:text} displays
{it:text} instead of {it:args1}, but you are still directed to the help
file for {it:args1}.

    {cmd:{c -(}manhelpi} {it:args1 args2}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}manhelpi{c )-}} is equivalent to {cmd:{c -(}manhelp{c )-}},
except that {it:args} or {it:text} is displayed in italics.

{marker markername}{...}
    {cmd:{c -(}help} {it:args}{cmd:##}{it:markername}[{cmd:|}{it:viewername}] [{cmd::}{it:text}]{cmd:{c )-}} and {cmd:{c -(}marker} {it:markername}{cmd:{c )-}}{right:(syntax 3)  }
{pin}They give the user the ability to jump to a specific location within a
file, not just to the top of the file.  {cmd:{c -(}help}
{it:args}{cmd:##}{it:markername}{cmd:{c )-}} displays
{it:args}{cmd:##}{it:markername} as a link that will jump to the location
marked by {cmd:{c -(}marker} {it:markername}{cmd:{c )-}}.  Specifying the
optional {cmd:|}{it:viewername} will display the results of
{cmd:{c -(}marker} {it:markername}{cmd:{c )-}} in a new Viewer window named
{it:viewername}; {cmd:_new} is a valid {it:viewername} that assigns a unique
name for the new Viewer.  Specifying the optional {cmd::}{it:text} displays
{it:text} instead of {it:args}{cmd:##}{it:markername}.  {it:args} represents
the name of the file where the {cmd:{c -(}marker{c )-}} is located.  If
{it:args} contains spaces, be sure to specify it within quotes.

{pin}
We document the directive as {cmd:{c -(}help} ...{cmd:{c )-}}, however, 
{cmd:view}, {cmd:news}, {cmd:net}, {cmd:ado}, and {cmd:update} may be used in
place of {cmd:help}; although, you would probably only want to use {cmd:help}
or {cmd:view}.

    {cmd:{c -(}help_d:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}help_d{c )-}} displays {it:text} as a link that will display
a help dialog box from which the user may obtain interactive help on any Stata
command.

    {cmd:{c -(}newvar}[{cmd::}{it:args}]{cmd:{c )-}}{right:(syntaxes 1 & 2)  }
{pin}{cmd:{c -(}newvar{c )-}} displays {it:newvar} as a link to
{cmd:help newvar}.  If you also specify the optional {cmd::}{it:args}, Stata
concatenates {it:args} to {it:newvar} to display {it:newvar<args>}.

    {cmd:{c -(}var}[{cmd::}{it:args}]{cmd:{c )-}} & {cmd:{c -(}varname}[{cmd::}{it:args}]{cmd:{c )-}} {right:(syntaxes 1 & 2)  }
{pin}{cmd:{c -(}var{c )-}} and {cmd:{c -(}varname{c )-}} display {it:varname}
as a link to {cmd:help varname}.  If you also specify the optional
{cmd::}{it:args}, Stata concatenates {it:args} to {it:varname} to display
{it:varname<args>}.

    {cmd:{c -(}vars}[{cmd::}{it:args}]{cmd:{c )-}} & {cmd:{c -(}varlist}[{cmd::}{it:args}]{cmd:{c )-}} {right:(syntaxes 1 & 2)  }
{pin}{cmd:{c -(}vars{c )-}} and {cmd:{c -(}varlist{c )-}} display {it:varlist}
as a link to {cmd:help varlist}.  If you also specify the optional
{cmd::}{it:args}, Stata concatenates {it:args} to {it:varlist} to display
{it:varlist<args>}.

    {cmd:{c -(}depvar}[{cmd::}{it:args}]{cmd:{c )-}}{right:(syntaxes 1 & 2)  }
{pin}{cmd:{c -(}depvar{c )-}} displays {it:depvar} as a link to
{cmd:help depvar}.  If you also specify the 
optional {cmd::}{it:args}, Stata concatenates {it:args} to {it:depvar}
to display {it:depvar<args>}.

    {cmd:{c -(}depvars}[{cmd::}{it:args}]{cmd:{c )-}} & {cmd:{c -(}depvarlist}[{cmd::}{it:args}]{cmd:{c )-}} {right:(syntaxes 1 & 2)  }
{pin}{cmd:{c -(}depvars{c )-}} and {cmd:{c -(}depvarlist{c )-}} display
{it:depvarlist} as a link to {cmd:help depvarlist}.  If you also specify the
optional {cmd::}{it:args}, Stata concatenates {it:args} to {it:depvarlist} to
display {it:depvarlist<args>}.

    {cmd:{c -(}indepvars}[{cmd::}{it:args}]{cmd:{c )-}}{right:(syntaxes 1 & 2)  }
{pin}{cmd:{c -(}indepvars{c )-}} displays {it:indepvars} as a link to
{cmd:help varlist}.  If you also specify the optional {cmd::}{it:args}, Stata
concatenates {it:args} to {it:indepvars} to display {it:indepvars<args>}.

    {cmd:{c -(}ifin{c )-}}{right:(syntax 1)  }
{pin}{cmd:{c -(}ifin{c )-}} displays [{it:if}] and [{it:in}], where {it:if}
is a link to the {cmd:help} for the {cmd:if} qualifier and {it:in} is a link 
to the {cmd:help} for the {cmd:in} qualifier.

    {cmd:{c -(}weight{c )-}}{right:(syntax 1)  }
{pin}{cmd:{c -(}weight{c )-}} displays [{it:weight}], where {it:weight}
is a link to the {cmd:help} for the {it:weight} specification.

    {cmd:{c -(}dtype{c )-}}{right:(syntax 1)  }
{pin}{cmd:{c -(}dtype{c )-}} displays [{it:type}], where {it:type} is a link
to {cmd:help data types}.

    {cmd:{c -(}search} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}search{c )-}} displays {it:text} as a link that will display
the results of {cmd:search} on {it:args}; see {helpb search}.

    {cmd:{c -(}search_d:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}search_d{c )-}} displays {it:text} as a link that will display
a {hi:Keyword Search} dialog box from which the user can obtain interactive
help by entering keywords of choice.

    {cmd:{c -(}dialog} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}dialog{c )-}} displays {it:text} as a link that will launch
the dialog box for {it:args}.

    {cmd:{c -(}browse} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}browse{c )-}} displays {it:text} as a link that will launch
the user's browser pointing at {it:args}.  Since {it:args} is typically a URL
and so contains a colon, {it:args} usually must be specified within quotes.

    {cmd:{c -(}view} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}view{c )-}} displays {it:text} as a link that will present
in the Viewer the filename {it:args} If {it:args} is a URL, be sure to specify
it in quotes.  {cmd:{c -(}view{c )-}} is seldom used in a SMCL file
(such as a help file) because you would seldom know of a fixed location for
the file unless it was a URL.  {cmd:{c -(}view{c )-}} is sometimes used from
programs because the program knows the location of the file it created.

{pin}{cmd:{c -(}view{c )-}} can also be used with {cmd:{c -(}marker{c )-}};
   see {help smcl##markername:above}.

    {cmd:{c -(}view_d:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}view_d{c )-}} displays {it:text} as a link that will display
the {hi:Choose File to View} dialog box in which the user may
type the name of a file or a URL to be displayed in the Viewer.

    {cmd:{c -(}news:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}news{c )-}} displays {it:text} as a link that will display
in the Viewer the latest news from {hi:http://www.stata.com}.

{pin}{cmd:{c -(}news{c )-}} can also be used with {cmd:{c -(}marker{c )-}};
   see {help smcl##markername:above}.

    {cmd:{c -(}net} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}net{c )-}} displays {it:args} as a link that will display in
the Viewer the results of {cmd:net} {it:args}; see {helpb net}.  Specifying
the optional {cmd::}{it:text}, display {it:text} instead of {it:args}.  For
security reasons, {cmd:net get} and {cmd:net install} cannot be executed in
this way.  Instead use {cmd:{c -(}net:describe} {it:...}{cmd:{c )-}} to show
the page, and, from there, the user can click the appropriate links to install
the materials.  Whenever {it:args} contains a colon, as it does when {it:args}
is a URL, be sure to enclose {it:args} in quotes.

{pin}{cmd:{c -(}net cd .:}{it:text}{cmd:{c )-}} displays {it:text} as a link
that will display the contents of the current {cmd:net} location.

{pin}{cmd:{c -(}net{c )-}} can also be used with {cmd:{c -(}marker{c )-}};
   see {help smcl##markername:above}.

    {cmd:{c -(}net_d:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}net_d{c )-}} displays {it:text} as a link that will display a
{hi:Keyword Search} dialog box from which the user can search the Internet
for additions to Stata.

    {cmd:{c -(}netfrom_d:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}netfrom_d{c )-}} displays {it:text} as a link that will display
a {hi:Choose Download Site} dialog box into which the user may enter
a URL and then see the contents of the site.  This directive is seldom used.

    {cmd:{c -(}ado} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}ado{c )-}} displays {it:text} as a link that will display
in the Viewer the results of {cmd:ado} {it:args}; see {helpb ado}.  For
security reasons, {cmd:ado uninstall} cannot be executed in this way.  Instead
use {cmd:{c -(}ado:describe} {it:...}{cmd:{c )-}} to show the package, and,
from there, the user can click to uninstall (delete) the material.

{pin}{cmd:{c -(}ado{c )-}} can also be used with {cmd:{c -(}marker{c )-}};
   see {help smcl##markername:above}.

    {cmd:{c -(}ado_d:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}ado_d{c )-}} displays {it:text} as a link that will display a
{hi:Search Installed Programs} dialog box from which the user can search for
user-written routines previously installed (and uninstall them if desired).

    {cmd:{c -(}update} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}update{c )-}} displays {it:text} as a link that will display
in the Viewer the results of {cmd:update} {it:args}; see {helpb update}.  If
{it:args} contains a URL, be careful to place the {it:args} in quotes.

{pin}{it:args} can be omitted because the {cmd:update} command is valid
without arguments.  {cmd:{c -(}update:}{it:text}{cmd:{c )-}} is really the
best way to use the {cmd:{c -(}update{c )-}} directive because it allows the
user to chose whether and fro where to update their Stata.

{pin}{cmd:{c -(}update{c )-}} can also be used with {cmd:{c -(}marker{c )-}};
see {help smcl##markername:above}.

    {cmd:{c -(}update_d:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}update_d{c )-}} displays {it:text} as a link that will display
a {hi:Choose Official Update Site} dialog box into which the user may type
a source (typically {hi:http://www.stata.com}, but perhaps a local CD
drive) from which to install official updates to Stata.

    {cmd:{c -(}back:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}back{c )-}} displays {it:text} as a link that will take an
action equivalent to pressing the Viewer's {hi:Back} button.

    {cmd:{c -(}clearmore:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}clearmore{c )-}} displays {it:text} as a link that will take an
action equivalent to pressing Stata's {hi:Clear -more- Condition} button.
{cmd:{c -(}clearmore{c )-}} is of little use to anyone but the developers of
Stata.

    {cmd:{c -(}stata} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}stata{c )-}} displays {it:text} as a link that will execute
the Stata command {it:args} in the Results window.  Stata will first ask
before executing the command that is displayed in a web browser.  If {it:args}
(the Stata command) contains a colon, remember to enclose the command in
quotes.

    {cmd:{c -(}matacmd} {it:args}[{cmd::}{it:text}]{cmd:{c )-}}{right:(syntaxes 3 & 4)  }
{pin}{cmd:{c -(}matacmd{c )-}} works the same as {cmd:{c -(}stata{c )-}},
except it submits a command to Mata.  If Mata is not already active, the
command will be prefixed with {cmd:mata} to allow Stata to execute it.

{marker line_mode}{...}
{title:Formatting directives for use in line mode}

    {cmd:{c -(}title:}{it:text}{cmd:{c )-}}(carriage return){right:(syntax 2)  }
{pin}{cmd:{c -(}title:}{it:text}{cmd:{c )-}} displays {it:text} as a title.

    {cmd:{c -(}center:}{it:text}{cmd:{c )-}} and {cmd:{c -(}centre:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
    {cmd:{c -(}center} {it:#}{cmd::}{it:text}{cmd:{c )-}} and {cmd:{c -(}centre} {it:#}{cmd::}{it:text}{cmd:{c )-}}{right:(syntax 4)  }
{pin}{cmd:{c -(}center:}{it:text}{cmd:{c )-}} and
{cmd:{c -(}centre:}{it:text}{cmd:{c )-}} are synonyms; they center the text on
the line.  With syntax 4, they center the text in a field of width {it:#}.

    {cmd:{c -(}rcenter:}{it:text}{cmd:{c )-}} and {cmd:{c -(}rcentre:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
    {cmd:{c -(}rcenter} {it:#}{cmd::}{it:text}{cmd:{c )-}} and {cmd:{c -(}rcentre} {it:#}{cmd::}{it:text}{cmd:{c )-}}{right:(syntax 4)  }
{pin}{cmd:{c -(}rcenter:}{it:text}{cmd:{c )-}} and
{cmd:{c -(}rcentre:}{it:text}{cmd:{c )-}} are synonyms and have the same
behavior as {cmd:{c -(}center:}{it:text}{cmd:{c )-}}, except when there is
an unequal number of spaces to be placed around the centered text.
{cmd:{c -(}rcenter:}{it:text}{cmd:{c )-}} places the extra space to the left
of the text, moving the text to the right.
{cmd:{c -(}center:}{it:text}{cmd:{c )-}} places the extra space to the right
of the text, moving the text to the left.
With syntax 4, they center the text in a field of width {it:#}.

    {cmd:{c -(}right:}{it:text}{cmd:{c )-}}{right:(syntax 2)  }
{pin}{cmd:{c -(}right:}{it:text}{cmd:{c )-}} displays {it:text} with its
last character aligned on the right margin.

    {cmd:{c -(}lalign} {it:#}{cmd::}{it:text}{cmd:{c )-}} and {cmd:{c -(}ralign} {it:#}{cmd::}{it:text}{cmd:{c )-}}{right:(syntax 4)  }
{pin}{cmd:{c -(}lalign{c )-}} left aligns {it:text} in a field {it:#}
characters wide.  {cmd:{c -(}ralign{c )-}} right aligns {it:text} in a
field {it:#} characters wide.

    {cmd:{c -(}dlgtab} [{it:#} [{it:#]]{cmd::}{it:text}{cmd:{c )-}}{right:(syntaxes 2 & 4)  }
{pin}{cmd:{c -(}dlgtab{c )-}} displays {it:text} as a dialog tab.  The first
{it:#} specifies how many characters to indent the dialog tab from the
left-hand-side, and the second {it:#} specifies how much to indent from the
right-hand side.  The default is {cmd:{c -(}dlgtab 4 2:}{it:text}{cmd:{c )-}}.