📄 smcl.hlp
字号:
{cmd:{c -(}...{c )-}}{right:(syntax 1) }
{pin}{cmd:{c -(}...{c )-}} specifies that the next carriage return be
treated as a blank.
{cmd:{c -(}col} {it:#}{cmd:{c )-}}{right:(syntax 3) }
{pin}{cmd:{c -(}col} {it:#}{cmd:{c )-}} skips forward to column {it:#}.
If you are already at or beyond that column on the output,
{cmd:{c -(}col} {it:#}{cmd:{c )-}} does nothing.
{cmd:{c -(}space} {it:#}{cmd:{c )-}}{right:(syntax 3) }
{pin}{cmd:{c -(}space} {it:#}{cmd:{c )-}} is equivalent to typing {it:#}
blank characters.
{cmd:{c -(}tab{c )-}}{right:(syntax 1) }
{pin}{cmd:{c -(}tab{c )-}} has the same effect as typing a tab character.
Tab stops are set every 8 spaces.
{pin}Note: SMCL also understands tab characters and treats them the same
as the {cmd:{c -(}tab{c )-}} command, so you may include tabs in your files.
{marker paragraph_mode}{...}
{title:Formatting directives for use in paragraph mode}
{cmd:{c -(}p{c )-}} (full syntax is {cmd:{c -(}p} {it:# # #}{cmd:{c )-}}){...}
{right:(syntax 3) }
{pin}{cmd:{c -(}p} {it:# # #}{cmd:{c )-}} enters paragraph mode. The first
{it:#} specifies how much to indent the first line, the second {it:#} how much
to indent the second and subsequent lines, and the third {it:#} how much to
bring in the right margin on all lines. Numbers, if not specified, default to
zero, so typing {cmd:{c -(}p{c )-}} without numbers is equivalent to typing
{cmd:{c -(}p 0 0 0{c )-}}, {cmd:{c -(}p} {it:#}{cmd:{c )-}} is equivalent to
{cmd:{c -(}p} {it:#} {cmd:0 0{c )-}}, and so on. {cmd:{c -(}p{c )-}} (with or
without numbers) may be followed by a carriage return or not; it makes no
difference.
{pin}Paragraph mode ends when a blank line is encountered, the
{cmd:{c -(}p_end{c )-}} directive is encountered, or
{cmd:{c -(}smcl{c )-}}(carriage return) is encountered.
{p2colset 15 36 38 16}{...}
{p2col :SMCL directive ...}is equivalent to typing ...{p_end}
{p2line}
{p2col :{cmd:{c -(}pstd{c )-}}}{cmd:{c -(}p 4 4 2{c )-}}{p_end}
{p2col :{cmd:{c -(}psee{c )-}}}{cmd:{c -(}p 4 13 2{c )-}}{p_end}
{p2col :{cmd:{c -(}phang{c )-}}}{cmd:{c -(}p 4 8 2{c )-}}{p_end}
{p2col :{cmd:{c -(}pmore{c )-}}}{cmd:{c -(}p 8 8 2{c )-}}{p_end}
{p2col :{cmd:{c -(}pin{c )-}}}{cmd:{c -(}p 8 8 2{c )-}}{p_end}
{p2col :{cmd:{c -(}phang2{c )-}}}{cmd:{c -(}p 8 12 2{c )-}}{p_end}
{p2col :{cmd:{c -(}pmore2{c )-}}}{cmd:{c -(}p 12 12 2{c )-}}{p_end}
{p2col :{cmd:{c -(}pin2{c )-}}}{cmd:{c -(}p 12 12 2{c )-}}{p_end}
{p2col :{cmd:{c -(}phang3{c )-}}}{cmd:{c -(}p 12 16 2{c )-}}{p_end}
{p2col :{cmd:{c -(}pmore3{c )-}}}{cmd:{c -(}p 16 16 2{c )-}}{p_end}
{p2col :{cmd:{c -(}pin3{c )-}}}{cmd:{c -(}p 16 16 2{c )-}}{p_end}
{p2colreset}{...}
{cmd:{c -(}p_end{c )-}}{right:(syntax 1) }
{pin}{cmd:{c -(}p_end{c )-}} is a way of ending a paragraph without having
a blank line between paragraphs.
{cmd:{c -(}p2colset} {it:# # # #}{cmd:{c )-}}{right:(syntax 3) }
{pin}{cmd:{c -(}p2colset{c )-}} sets
up a two-column table. The first {it:#} specifies the beginning position of the first column, the second {it:#} specifies the placement of the second column, the third {it:#} specifies the placement for subsequent lines of the second column, and the last {it:#} specifies the number to indent from the right-hand side for the second column.
{cmd:{c -(}p2col} [{it:# # # #}]{cmd::}[{it:first_column_text}]{cmd:{c )-}} [{it:second_column_text}]{right:(syntaxes 2 & 4) }
{pin}{cmd:{c -(}p2col{c )-}} specifies the rows that make up the two-column
table. Specifying the optional numbers redefines the numbers specified in the
{cmd:{c -(}p2colset{c )-}} for this row only. If the {it:first_column_text}
or the {it:second_column_text} is not specified, the respective column is left
blank.
{cmd:{c -(}p2line} [{it:# #}]{cmd:{c )-}}{right:(syntaxes 1 & 3) }
{pin}{cmd:{c -(}p2line{c )-}} draws a dashed line for use with a two-column
table. The first {it:#} specifies the left indentation, and the second {it:#}
specifies the right indentation. If no numbers are specified, the defaults
are based on the numbers provided in {cmd:{c -(}p2colset{c )-}}.
{cmd:{c -(}p2colreset{c )-}}{right:(syntax 1) }
{pin}{cmd:{c -(}p2colreset{c )-}} restores the {cmd:{c -(}p2col{c )-}} default
values.
{cmd:{c -(}synoptset} [{it:#}] [{cmd:tabbed}]{cmd:{c )-}}{right:(syntaxes 1 & 3) }
{pin}{cmd:{c -(}synoptset{c )-}} sets
standard column spacing for the two-column tables used to document options in
syntax diagrams. {it:#} specifies the width of the first column; the width
defaults to 20 if {it:#} is not specified. The optional argument {cmd:tabbed}
specifies that the table will contain headings or "tabs" for sets of options.
{cmd:{c -(}synopthdr}[{cmd::}{it:column1_text}]{cmd:{c )-}}{right:(syntaxes 1 & 2) }
{pin}{cmd:{c -(}synopthdr}{it:...}{cmd:{c )-}} outputs a standard header
for a syntax-diagram-option table. {it:column1_text} is used to title the
first column in the header; if {it:column1_text} is not specified then the
first column is titled "{it:options}". The second column is always titled
"description".
{cmd:{c -(}syntab}{cmd::}{it:text}{cmd:{c )-}}{right:(syntax 2) }
{pin}{cmd:{c -(}syntab}{cmd::}{it:text}{cmd:{c )-}} outputs {it:text}
positioned as a subheading or "tab" in a syntax-diagram-option table.
{cmd:{c -(}synopt}{cmd::}[{it:first_column_text}]{cmd:{c )-}} [{it:second_column_text}]{right:(syntax 2) }
{pin}{cmd:{c -(}synopt{c )-}} outputs {it:option_text} in
the first column and enters paragraph mode in the second column for the text
that follows. The location of the columns is determined by a prior
{cmd:{c -(}synoptset{c )-}} or, less frequently, {cmd:{c -(}p2colset{c )-}}
directive.
{cmd:{c -(}p2coldent}{cmd::}[{it:first_column_text}]{cmd:{c )-}} [{it:second_column_text}]{right:(syntax 2) }
{pin}{cmd:{c -(}p2coldent}{it:...}{cmd:{c )-}} is the same as
{cmd:{c -(}synopt{c )-}}, except the {it:first_column_text} is displayed with the
standard indentation (which may be negative). The {it:second_column_text}
is displayed in paragraph mode. The location of the columns is determined by
a prior {cmd:{c -(}synoptset{c )-}} or {cmd:{c -(}p2colset{c )-}} directive.
{cmd:{c -(}synoptline{c )-}}{right:(syntax 1) }
{pin}{cmd:{c -(}synoptline{c )-}} draws a horizontal line that extends to
the boundaries of the previous {cmd:{c -(}synoptset{c )-}} or, less
frequently, {cmd:{c -(}p2colset{c )-}} directive.
{cmd:{c -(}bind:}{it:text}{cmd:{c )-}}{right:(syntax 2) }
{pin}{cmd:{c -(}bind:}{it:text}{cmd:{c )-}} keeps {it:text} together on a
line, even if that makes one line of the paragraph uncommonly short.
{cmd:{c -(}bind:}{it:text}{cmd:{c )-}} can also be used to insert one or
more real spaces into the paragraph if you specify {it:text} as one or more
spaces.
{cmd:{c -(}break{c )-}}{right:(syntax 1) }
{pin}{cmd:{c -(}break{c )-}} is used to force a line break without ending
the paragraph.
{marker class}{...}
{title:Inserting values from constant and current-value class}
{pstd}
The {cmd:{c -(}ccl{c )-}} directive outputs the value contained in a constant
and current-value class ({cmd:c()}) object. For instance,
{cmd:{c -(}ccl pi{c )-}} provides the value of the constant pi (3.14159...)
contained in {cmd:c(pi)}. See {helpb creturn} for a list of all the
available {cmd:c()} objects.
{marker ascii}{...}
{title:Displaying characters using ASCII code}
{pstd}
The {cmd:{c -(}char{c )-}} directive{hline 2}synonym
{cmd:{c -(}c{c )-}}{hline 2} allows the output of any ASCII character. For
instance, {cmd:{c -(}c 106{c )-}} is equivalent to typing the letter {hi:j},
because ASCII code 106 is defined as the letter {hi:j}.
{pstd}
You can get to all the ASCII characters by typing
{cmd:{c -(}c} {it:#}{cmd:{c )-}}, where {it:#} is between 1 and 255. Or, if
you prefer, you can type {cmd:{c -(}c 0x}{it:#}{cmd:{c )-}}, where {it:#} is
a hexadecimal number between 1 and ff. Thus {cmd:{c -(}c 0x6a{c )-}} is
also {hi:j} because the hexadecimal number 6a is equal to the decimal number
106.
{pstd}
In addition, so that you do not have to remember the ASCII numbers,
{cmd:{c -(}c{c )-}} provides special codes for characters that are, for one
reason or another, difficult to type. These include
{center:{cmd:{c -(}c S|{c )-}} $ (dollar sign) }
{center:{cmd:{c -(}c 'g{c )-}} ` (open single quote)}
{center:{cmd:{c -(}c -({c )-}} {c -(} (left curly brace) }
{center:{cmd:{c -(}c )-{c )-}} {c )-} (right curly brace)}
{pstd}
{cmd:{c -(}c S|{c )-}} and {cmd:{c -(}c 'g{c )-}} are included not because
they are difficult to type or cause SMCL any problems, but because in Stata
{cmd:display} statements, they can be difficult to make display because they
are Stata's macro substitution characters.
{pstd}
{cmd:{c -(}c -({c )-}} and {cmd:{c -(}c )-{c )-}} are included because
{cmd:{c -(}} and {cmd:{c )-}} are used to enclose SMCL directives. Although
{cmd:{c -(}} and {cmd:{c )-}} have special meaning to SMCL, SMCL usually
displays the two characters correctly when they do not have a special
meaning.
{pstd}
In addition, SMCL provides the following line-drawing characters:
{center:{cmd:{c -(}c -{c )-}} {c -}, a wide - (dash) character }
{center:{cmd:{c -(}c |{c )-}} {c |}, a tall | }
{center:{cmd:{c -(}c +{c )-}} {c +}, a wide - on top of a tall |}
{center:{cmd:{c -(}c TT{c )-}} {c TT}, a top T }
{center:{cmd:{c -(}c BT{c )-}} {c BT}, a bottom T }
{center:{cmd:{c -(}c LT{c )-}} {c LT}, a left T }
{center:{cmd:{c -(}c RT{c )-}} {c RT}, a right T }
{center:{cmd:{c -(}c TLC{c )-}} {c TLC}, a top-left corner }
{center:{cmd:{c -(}c TRC{c )-}} {c TRC}, a top-right corner }
{center:{cmd:{c -(}c BRC{c )-}} {c BRC}, a bottom-right corner }
{center:{cmd:{c -(}c BLC{c )-}} {c BLC}, a bottom-left corner }
{pstd}
The above are not really ASCII, they are instructions to SMCL to draw
lines. The "characters" are, however, one-character wide and one-character
tall, so you can use them as characters in your output.
{pstd}
Finally, SMCL provides the following West European characters:
{center:{cmd:{c -(}c a'{c )-}} {c a'} {cmd:{c -(}c A'{c )-}} {c A'}}
{center:{cmd:{c -(}c e'{c )-}} {c e'} {cmd:{c -(}c E'{c )-}} {c E'}}
{center:{cmd:{c -(}c i'{c )-}} {c i'} {cmd:{c -(}c I'{c )-}} {c I'}}
{center:{cmd:{c -(}c o'{c )-}} {c o'} {cmd:{c -(}c O'{c )-}} {c O'}}
{center:{cmd:{c -(}c u'{c )-}} {c u'} {cmd:{c -(}c U'{c )-}} {c U'}}
{center:{cmd:{c -(}c a'g{c )-}} {c a'g} {cmd:{c -(}c A'g{c )-}} {c A'g}}
{center:{cmd:{c -(}c e'g{c )-}} {c e'g} {cmd:{c -(}c E'g{c )-}} {c E'g}}
{center:{cmd:{c -(}c i'g{c )-}} {c i'g} {cmd:{c -(}c I'g{c )-}} {c I'g}}
{center:{cmd:{c -(}c o'g{c )-}} {c o'g} {cmd:{c -(}c O'g{c )-}} {c O'g}}
{center:{cmd:{c -(}c u'g{c )-}} {c u'g} {cmd:{c -(}c U'g{c )-}} {c U'g}}
{center:{cmd:{c -(}c a^{c )-}} {c a^} {cmd:{c -(}c A^{c )-}} {c A^}}
{center:{cmd:{c -(}c e^{c )-}} {c e^} {cmd:{c -(}c E^{c )-}} {c E^}}
{center:{cmd:{c -(}c i^{c )-}} {c i^} {cmd:{c -(}c I^{c )-}} {c I^}}
{center:{cmd:{c -(}c o^{c )-}} {c o^} {cmd:{c -(}c O^{c )-}} {c O^}}
{center:{cmd:{c -(}c u^{c )-}} {c u^} {cmd:{c -(}c U^{c )-}} {c U^}}
{center:{cmd:{c -(}c a~{c )-}} {c a~} {cmd:{c -(}c A~{c )-}} {c A~}}
{center:{cmd:{c -(}c o~{c )-}} {c o~} {cmd:{c -(}c O~{c )-}} {c O~}}
{center:{cmd:{c -(}c a:{c )-}} {c a:} {cmd:{c -(}c A:{c )-}} {c A:}}
{center:{cmd:{c -(}c e:{c )-}} {c e:} {cmd:{c -(}c E:{c )-}} {c E:}}
{center:{cmd:{c -(}c i:{c )-}} {c i:} {cmd:{c -(}c I:{c )-}} {c I:}}
{center:{cmd:{c -(}c o:{c )-}} {c o:} {cmd:{c -(}c O:{c )-}} {c O:}}
{center:{cmd:{c -(}c u:{c )-}} {c u:} {cmd:{c -(}c U:{c )-}} {c U:}}
{center:{cmd:{c -(}c ae{c )-}} {c ae} {cmd:{c -(}c AE{c )-}} {c AE}}
{center:{cmd:{c -(}c c,{c )-}} {c c,} {cmd:{c -(}c C,{c )-}} {c C,}}
{center:{cmd:{c -(}c n~{c )-}} {c n~} {cmd:{c -(}c N~{c )-}} {c N~}}
{center:{cmd:{c -(}c o/{c )-}} {c o:} {cmd:{c -(}c O/{c )-}} {c O:}}
{center:{cmd:{c -(}c y'{c )-}} {c y'} {cmd:{c -(}c Y'{c )-}} {c Y'}}
{center:{cmd:{c -(}c y:{c )-}} {c y:} {cmd:{c -(}c ss{c )-}} {c ss}}
{center:{cmd:{c -(}c r?{c )-}} {c r?} {cmd:{c -(}c r!{c )-}} {c r!}}
{center:{cmd:{c -(}c L-{c )-}} {c L-} {cmd:{c -(}c Y={c )-}} {c Y=}}
{pstd}
Depending on the fonts available with your operating system you may also
have{p_end}
{center:{cmd:{c -(}c E={c )-}} {c E=}}
{pstd}
SMCL uses ISO-8859-1 (Latin 1) to render the above characters. For
example, {cmd:{c -(}c e'{c )-}} is equivalent to
{cmd:{c -(}c 0xe9{c )-}}, if you care to look it up.
{pstd}
In the case of the Macintosh, however, Stata uses the Macintosh encoding,
but this can be reset. See {hi:[P] smcl} for details.
{title:Also see}
{psee}
Manual: {bf:[P] smcl}
{psee}
Online: {helpb creturn}, {helpb display}, {help examplehelpfile},
{helpb log}, {helpb translate}, {helpb viewer}
{p_end}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -