Texinfo에서, 여러가지 방법으로 단어나, 구절을 mark할 수 있다. Texinfo formatter는 이 정보를 어떻게 그 글을 highlight하는지 결정하는 데 쓴다. 예를 들어, 어떤 단어나 구절이 사건을 정의하는지, metasyntactic 변수인지, 또는 프로그램에 쓰이는 symbol인지 지정할 수 있다.
Texinfo에는 글의 한 부분이 어떤 종류의 object인지를 가리키는 명령들이
있다. 예를 들어, metasyntactic 변수는 @var로 mark되고, code는
@code로 mark된다. 글의 조각은 그 조각이 어떤 종류의
object인지를 알려주는 명령으로 label되기 때문에, Texinfo formatter가
이런 text를 준비하는 방법을 변경하는 것도 쉽다. (Texinfo는
typesetting formatting language라기 보다는 intentional
formatting language이다.)
예를 들어, 인쇄된 매뉴얼에서, code는 보통 typewriter 폰트로 장식된다;
@code는 TeX에게 이 글을 typewriter 폰트로 typeset하도록
알려준다. 하지만, TeX이 다른 폰트를 써서 code를 highlight하도록
바꾸는 것도 쉽고, 이렇게 바꾸는 건 keystroke 예가 어떻게
highlight되는지에는 아무 영향을 끼치지 않을 것이다. 직접적인
typesetting 명령을 써서 파일의 본론을 작성한 다음 변경하려면, code를
바꾸면서 나머지 다른 것은 바뀌지 않도록 하나하나를 검사해야 할 것이다.
highlighting 명령은 함수의 리스트나 파일의 이름과 같은, 파일에서 유용한 정보를 표시하는 데 사용한다. 예를 들어, Emacs Lisp으로 (혹은 키보드 매크로로) 프로그램을 작성해서 특정 명령으로 mark된 단어나 구절을 매 문단 뒤에 색인 entry로 첨가할 수 있다. 아직 entry를 만들지 않았을 때, 이 명령을 사용해서 함수의 index를 구성할 수 있다.
이 명령들은 여러가지 목적으로 사용된다:
@code{sample-code}
@kbd{keyboard-characters}
@key{key-name}
@samp{text}
@var{metasyntactic-variable}
@url{uniform-resource-locator}
@file{file-name}
@email{email-address[, displayed-text]}
@dfn{term}
@cite{reference}
@code{sample-code}
@code 명령은 프로그램의 일부와 syntactic token으로 구성된 글을
나타낸다. 이 글을 중괄호로 묶는다.
즉, 프로그램 내에서 쓰는 표현의 경우, 프로그램내에 쓰이는 변수나 함수의
이름, 또는 keyword의 경우에 @code를 사용해야 한다. 또,
diff와 같은 프로그램의 이름---컴퓨터에서 직접 명령어로 쓰이는
이름--같은 경우, @code를 사용해야 한다. (만약, `Emacs'나
`Bison'처럼 프로그램의 이름이 새로운 영어 단어라고 생각되면, 보통 텍스트
폰트로 프로그램의 이름을 써야 한다.)
TEXINPUTS등과 같은 환경 변수에 @code를 사용한다.
Texinfo나 셸과 같은 프로그래밍 언어와 비슷한 command language의 명령어
이름에 @code를 사용한다. 예를 들어 @code와
@samp는 Texinfo 소스에서 각각 `@code{@@code}'와
`@code{@@samp}'라고 써서 만들어 진다.
하지만, `-c'와 같은 셸 옵션이 단독으로 사용될 때는 @code를
사용하면 안 된다. (@samp를 사용하라.) 또 전체 셸 명령은
@code보다는 @samp로 쓰는 것이 보통의 경우 보기가 좋다.
이런 경우의 규칙은, 더 마음에 드는 형식을 선택하는 것이다.
문자의 맨 처음에 있다고 해서 @code 내의 단어의 대소문자를
변경하는 건 잘못된 일이다. 예를 들어 C에서, Printf는
printf 식별자와는 다르고, 대부분의 경우 스펠링을 잘못 쓴
경우이다. 대소문자를 구분하지 않는 언어의 경우라고 해도, 사람이 다르게
대소문자 표기된 식별자를 알아보는 건 혼란스럽다. 한가지 철자를 골라,
계속 그것만을 사용하라. 소문자로 시작하는 명령으로 문장을 시작하고 싶지
않다면, 그 문장의 순서를 바꿔야 한다.
syntactic token보다 짧은 문자열에 대해서 @code 명령을 사용하지
말라, 만약 TEXINPUTS 환경변수의 일부분인 `TEXINPU'를 쓰려면
@samp를 써야 한다.
특히 token에 쓰이는 문자들에 대해 @code를 쓰지 말아야 한다; 예를
들어, 함수의 이름에서 어떤 문자와 printable symbol이 쓰일 수 있는지
설명할 때는 @code를 쓰지 말라. (@samp를 쓴다.) 또,
프로그램의 입력이 프로그래밍 언어와 같은 언어로 쓰여 있지 않다면,
프로그램의 입력에 대해 @code로 mark해서는 안 된다. 예를 들어,
GNU Emacs의 keystroke 명령에 대해--비록 그 keystroke 명령에 의해
실행되는 Emacs Lisp 함수의 이름에 대해서는 @code를 쓸 수
있지만---@code를 쓰지 않는다 (대신 @kbd를 쓴다).
인쇄된 매뉴얼에서, @code는 TeX이 인수를 typewriter 체로
typeset하게 한다. Info 파일에서는, @code가 Info formatting
명령이 한개의 따옴표로 그 글을 둘러싸도록 한다.
예를 들어,
Use @code{diff} to compare two files.
는 인쇄된 매뉴얼에서 다음과 같이 만든다:
Use
diffto compare two files.
그리고 Info 파일에서는:
Use `diff' to compare two files.
@kbd{keyboard-characters}
@kbd 명령은 사용자가 타이프하는 입력 문자들에 대해 쓰인다. 예를
들어 M-a 문자를 쓸때,
@kbd{M-a}
그리고 M-x shell 문자를 쓸때,
@kbd{M-x shell}
@kbd 명령은 Info에서는 @code와 마찬가지의 효과를 내지만,
인쇄된 매뉴얼에선느 다른 폰트로 (보통 typewriter 대신 slanted typewriter)
표시한다. 이렇게 해서 사용자들은 type할 문자들과 컴퓨터에서 출력될
문자들을 구분할 수 있다.
@kbd의 사용은 매뉴얼마다 다르기 때문에, @kbdinputstyle
명령으로 폰트 변경을 할 수 있다. 이 명령은 Info 출력에는 영향이 없다.
이 명령은 줄이 시작할 때 쓰고 한개의 단어를 인수로 쓴다. 그 인수는
다음과 같다.
@kbd에 대해서 @code와 언제나 같은 폰트를 쓴다.
@example과 그외 비슷한 environment 내에서만 @kbd에
대해 다른 폰트를 쓴다.
@kbd에 대해 다른 폰트를 쓴다.
@kbd 명령의 중괄호 안에 또다른 @-명령을 포함할 수 있다. 예를
들어, 여기에 "press an `r' and then press RET key"라고
장황하게 설명될 수도 있는 명령을 간단히 쓰는 방법이 있다.
@kbd{r @key{RET}}
이것은 다음을 만든다: r RET
타이프할 문자들의 철자를 쓸 때도 @kbd 명령을 ㅤㅤㅏㅅ용한다;
예를 들어:
To give the @code{logout} command,
type the characters @kbd{l o g o u t @key{RET}}.
이것은 다음을 만들어 낸다:
To give the
logoutcommand, type the characters l o g o u t RET.
(또, 이 예에서 보다 명확하게 하기 위해 공백을 첨가한 것을 볼 수 있다. 정말로 공백문자를 한개의 입력된 문자로 표시하고 싶다면 @key{SPC}라고 쓴다.)
@key{key-name}
@key 명령은 다음과 같이 키보드 위의 한개 키에 대한 전통적인
이름에 대해 쓰인다:
@key{RET}
type될 문자열중에서 키의 이름으로 설명해야만 할 키가 한개 이상 있는
경우에 @kbd 명령의 인수 중간에 @key 명령을 쓴다.
예를 들어, C-x ESC를 만드려면 다음과 같이 type한다:
@kbd{C-x @key{ESC}}
다음은 키들에 대해 추천되는 이름의 리스트이다.
- SPC
- Space
- RET
- Return
- LFD
- Linefeed (however, since most keyboards nowadays do not have a Linefeed key, it might be better to call this character C-j.
- TAB
- Tab
- BS
- Backspace
- ESC
- Escape
- DEL
- Delete
- SHIFT
- Shift
- CTRL
- Control
- META
- Meta
modifier key인 `meta' 혹은 `ctrl'과 같은 단어를 다루는 데는 미묘한 점이
있다. Meta-a와 같이, modifier key가 쓰이는 문자를 표시할 때는,
@kbd 명령만을 쓴다; @key 명령을 쓰지 않는다; 하지만
modifier key를 단독으로 가리킬 때는 @key 명령을 사용한다. 예를
들어, Meta-a를 만드려면 `@kbd{Meta-a}'라고 쓰고,
META를 만드려면 `@key{META}'라고 쓴다.
@samp{text}
@samp 명령은 literal 예 혹은 파일, 문자열, 패턴 등의내에 있는
문자들의 `예(sample)'를 나타내는 데 쓰인다. 그 텍스트를 중괄호로
묶는다. Info 파일과 인쇄된 매뉴얼의 경우에 모두 그 인수가 따옴표로
묶여져 나타난다; 또 텍스트는 고정폭의 폰트로 인쇄된다.
To match @samp{foo} at the end of the line,
use the regexp @samp{foo$}.
는 다음을 만든다.
To match `foo' at the end of the line, use the regexp `foo$'.
언제든지 한개의 문자에 대해서, @kbd나 @key가 더 적합하지
않다면 @samp를 써야 한다. command-line 옵션의 이름에 대해서
@samp를 사용한다 (@code가 더 읽기 쉬운 @table의
경우를 제외하고). 또, C의 전체 statement들이나 전체 셸 명령에 대해 에
대해 @samp를 쓸 수 있다---이런 경우에, @samp가
@code보다 더 좋아 보인다. 기본적으로 @code,
@kbd, 혹은 @key가 쓰이지 않는 곳에 어디든지 쓰이는
다목적 명령이다.
구두점이 가리키려는 문자열의 일부라면 중괄호 사이에 구두점을 포함하면 된다. 구두점이 그 문자열을 둘러싸는 영어 텍스트의 일부라면 구두점을 중괄호 밖에 쓴다. 예를 들어, 다음 문장에서 쉼표와 마침표는 중괄호 밖에 쓰여 있다.
In English, the vowels are @samp{a}, @samp{e},
@samp{i}, @samp{o}, @samp{u}, and sometimes
@samp{y}.
이것은 다음을 만든다.
In English, the vowels are `a', `e', `i', `o', `u', and sometimes `y'.
@var{metasyntactic-variable}
@var 명령은 metasyntactic 변수를 나타내는 데 쓴다.
metasyntactic 변수는 어떤 다른 텍스트 조각을 뜻하는 그
무언가이다. 예를 들어, 함수에서 함수에 넘겨지는 인수들을 설명하려 할때
metasyntactic 변수를 사용해야 한다.
@var를 프로그래밍 언어의 특정 변수의 이름으로 사용하지 말라.
그런 변수들은 프로그램에서 온 명확한 이름이므로, @code를
사용하는 것이 맞다. 예를 들어, Emacs Lisp 변수
texinfo-tex-command는 metasyntactic 변수가 아니다; 이 변수는
@code를 써야 제대로 format된다.
Info 파일에서 @var의 효과는 인수를 모두 대문자로 바꾸는 것이다;
인쇄된 매뉴얼에서는, 인수를 이탤릭체로 바꾼다.
예를 들어,
To delete file @var{filename},
type @code{rm @var{filename}}.
는 다음을 만들어 낸다.
To delete file filename, type
rm filename.
(@var는 @code, @samp, @file 등의
내부에도 올 수 있다는 것에 주목하라.)
metasyntactic 변수는 공백 없이 모두 소문자로 쓰고, 더 읽기 쉽게 하려면 hyphen을 사용한다. 즉, 어떻게 Texinfo 매뉴얼이 시작하는지 표시하려는 Texinfo 소스는 다음과 같다:
\input texinfo
@@setfilename @var{info-file-name}
@@settitle @var{name-of-manual}
는 다음을 만들어 낸다:
\input texinfo @setfilename info-file-name @settitle name-of-manual
어떤 문서 스타일에서는, metasyntactic 변수는 각괄호와 함께 표시되기도 한다. 에를 들어:
..., type rm <filename>
하지만, 이것은 Texinfo가 사용하는 스타일이 아니다. (물론, 하고 싶다면
TeX 소스와 Info formatting 명령을 수정해서 <...>로
출력하도록 할 수 있다.)
@file{file-name}
@file 명령은 file, buffer, 혹은 디렉토리, 또는 Info의 node
이름을 나타낼 때 쓴다. 이 명령은 파일 이름 접미어에 쓸 수도 있다.
@file을 프로그래밍 언어의 symbol에 대해 쓰지 말라;
@code를 쓴다.
현재 @file은 @samp와 동일한 효과가 있다.
The @file{.el} files are in
the @file{/usr/local/emacs/lisp} directory.
는 다음을 만든다.
The `.el' files are in the `/usr/local/emacs/lisp' directory.
@dfn{term}
@dfn 명령은 기술적인 용어에 대해서 소개하거나 정의 할때 쓴다.
이 명령은 읽는 이가 알아 두어야 하거나, 앞으로 사용될 용어를 소개하려는
부분에만 사용한다. 단순히 첫번째로 용어를 언급하는 데는 @dfn를
자격이 없다. @dfn 명령은 인쇄된 매뉴얼에서 이탤릭체로 표기하고,
Info 파일에서는 쌍따옴표로 둘러싸여 표시된다. 예를 들어:
Getting rid of a file is called @dfn{deleting} it.
는 다음을 만든다.
Getting rid of a file is called deleting it.
일반적인 규칙상, 어떤 정의해야 할 용어가 들어 있는 문장은 그 용어의 정의가 되어야 한다. 그 문장은 명시적으로 이것이 저의라고 하지는 않지만, 정의하는 정보가 있어야 한다---그 용어의 의미를 명확히 해야 한다.
@cite{reference}
@cite 명령은 해당되는 Info 파일이 없는 책의 이름에 쓰인다. 이
명령은 인쇄된 매뉴얼에서 이탤릭체로 쓰이고, Info 파일에서는 따옴표로
둘러싸여 진다.
(만약 책이 Texinfo로 쓰여져 있다면, 상호 참조 명령을 쓰는 편이 좋다.
왜냐하면 읽는 이가 Info에서 그러한 참조를 쉽게 따라갈 수 있기 때문이다.
See section @xref.)
@url{uniform-resource-locator}
@url은 World Wide Web 상의 uniform resource locator를 나타내는
데 쓴다. 이것은 @file, @var 등과 마찬가지로 순전히
markup 목적을 위한 것이다. 이 명령은 HTML 출력물에서 따라갈 수 있는
링크를 만들지 않는다 (@uref 명령이 이렇게 한다, see section @uref{url[, displayed-text]}). 실제로 존재하지 않는 URL을 예로 들때 유용하다.
For example, the url might be
@url{http://host.domain.org/path}.
@email{email-address[, displayed-text]}
@email 명령은 전자 우편 주소를 나타낼 때 쓴다. 이것은 한개의
필수적인 인수, 즉 주소를 받고, 또 한개의 생략 가능한 인수를 받는다. 이
생략 가능한 인수는 표시할 텍스트이다 (default는 주소 그 자체이다).
Info와 TeX에서 주소는 표시할 텍스트 앞에, 각괄호 내에 나타난다. HTML
출력에서, @email은 `mailto' 링크를 만들어서 이 링크를 통해
메일을 쓰는 윈도우로 데려다 준다. 예를 들어:
Send bug reports to @email{bug-texinfo@@prep.ai.mit.edu}.
Send suggestions to the @email{bug-texinfo@@prep.ai.mit.edu, same place}.
는 다음을 만든다.
Send bug reports to bug-texinfo@prep.ai.mit.edu. Send suggestions to the same place.
보통, Texinfo는 그 단어가 어떤 범주에 들어가는 지에 따라 텍스트의 단어를
mark해서 폰트를 바꾼다; 예로 @code 명령이 있다. 대부분, 이것이
단어를 mark하는 가장 좋은 방법이다.
하지만, 때때로 단어의 범주와는 상관없이 텍스트를 강조하고 싶을 것이다.
Texinfo는 강조하는 데 쓰는 두개의 명령이 있다. 또, Texinfo에는 TeX이
텍스트를 typeset하는 폰트를 지정하는 명령들도 있다. 이런 명령들은
Info에는 영향을 끼치지 않고, 이 명령중에 @r 명령 하나만이 자주
쓰인다.
@emph{text} and @strong{text}
@emph와 @strong 명령은 강조에 스인다; @strong이
더 강력하다. 인쇄된 매뉴얼에서 @emph는
이탤릭(italic)체의 글을 만들어 내고, @strong은
볼드(bold)체의 글을 만든다.
예를 들어,
@quotation
@strong{Caution:} @samp{rm * .[^.]*} removes @emph{all}
files in the directory.
@end quotation
는 인쇄된 매뉴얼에서 다음을 만든다:
Caution:
rm * .[^.]*removes all files in the directory.
그리고 Info에서는 다음과 같다:
*Caution*: `rm * .[^.]*' removes *all*
files in the directory.
@strong 명령은 이전의 예에서 `Caution' 단어와 같은 그 효과가
typographical element인 경우를 제외하고는 거의 쓰이지 않는다.
Info 파일에서, @emph와 @strong은 텍스트를 asterisk로
둘러싼다.
주의:
@emph나@strong을 `Note' 단어에 쓰지 말라; Info는 상호 참조의 형태로 잘못 알아볼 것이다. 대신에 Please note 혹은 Caution과 같이 사용하라.
@sc{text}: The Small Caps Font`@sc' 명령은 인쇄된 매뉴얼에서 SMALL CAPS 폰트로 쓰여지는 텍스트를 표시하는 데 쓰고, Info 파일에서는 대문자로 표시된다.
다음과 같이, 중괄호 사이에 소문자로 텍스트를 쓴다:
The @sc{acm} and @sc{ieee} are technical societies.
는 다음을 만들어 낸다:
The ACM and IEEE are technical societies.
TeX은 small caps 폰트를 글자가 `페이지 위에서 뛰쳐나가는 것을' 막는 형태로 typeset한다. 그래서 small caps 텍스트는 모두 대문자로 쓰여진 텍스트보다 읽기가 쉽다. Info formatting 명령은 모든 small caps 텍스트를 대문자로 표시한다.
만약 @sc 명령의 중괄호 사이의 텍스트가 대문자라면, TeX은
FULL-SIZE CAPITAL을 사용해 typeset한다. full-size capital은 가끔
사용하라.
ATO와 같은 약자에 small caps 폰트를 쓸 수도 있다 (`abord to orbit'을 뜻하는 NASA 용어).
Lisp 프로그래밍에 쓰이는 CDR과 같은 약자에 small caps 폰트를 쓰는 데 미묘함이 있다. 이런 경우, 이 단어가 list의 두번째와 그 이후 elements를 나타낼 때만 small caps 폰트를 쓴다. 하지만, 이 단어가 같은 철자의 Lisp 함수를 나타낼 때는 `@code'를 쓴다.
Texinfo는 Info에선 효과가 없지만, 인쇄된 매뉴얼에 대해 폰트를 바꿀 수
있는 네개의 폰트 명령을 제공한다. @i는 이탤릭(italic)
폰트를 쓰도록 하고 (TeX의 어떤 버전에서는, slanted 폰트가 쓰인다),
@b는 볼드(bold) face를 쓰도록 한다. @t는
@code에 쓰이는 고정폭(fixed-width) 폰트를 쓰도록 해 주고,
@r은 보통 텍스트에 사용되는 폰트인 로만(roman) 폰트를 쓴다.
이 네개의 명령은 모두 그 다음에 중괄호에 둘러싸여 따라오는 한개의
argument에 대해서 적용된다.
@r 명령만이 많이 쓰인다: 프로그램의 예에서, @r 명령을
사용해서 주석문을 고정폭 폰트에서 로만 폰트로 바꿀 수 있다. 이렇게 하면
인쇄된 매뉴얼에서 더 보기가 좋다.
예를 들어,
@lisp
(+ 2 2) ; @r{Add two plus two.}
@end lisp
는 다음을 만든다.
(+ 2 2) ; Add two plus two.
가능하다면, 나머지 세개의 폰트 명령은 피해야 한다. 만약 사용해야 한다면, 그것은 Texinfo 언어의 좋지 않은 틈을 보여주는 것이다.
@iftex ... @end iftex 안에 TeX 명령을 써서
자기만의 customize된 Texinfo용 highlighting 명령을 만들 수 있다. 가장
하기 쉬운 방법은 customized 명령을 이탤릭체를 표시하는 데 쓰이는 명령과
같은 이미 존재하는 명령으로 표현하는 것이다. 이렇게 만든 새로운
명령들은 TeX에서만 동작한다.
@definfoenclose명령을 @ifinfo ... @end
ifinfo 사이에 사용해서 TeX의 새로운 명령어와 같은 이름의 Info용
명령어를 정의할 수 있다.
@definfoenclose는 새로운 텍스트를 텍스트 앞뒤로 올 문자열로
둘러싸는 명령어를 만든다. (7)
여기에 TeX에서는 그 인수를 이탤릭체로 typeset하고,
Info에서는는 인수를 `//'와 `\\' 사이에 놓는 @phoo라고
하는 @-명령을 어떻게 만드는 지 나와 있다:
@iftex @global@let@phoo=@i @end iftex
이것은 @phoo를 TeX이 @phoo의 인수를 이탤릭체로
typeset하도록 하는 명령어로 정의한다. @global@let은 TeX이
그 다음에 나오는 인수를 equal sign 뒤의 인수와 같다고 놓게 한다.
Info에서, 다음과 같이 Info formatter가 인수를 `//'와 `\\'로 둘러싸도록 한다.
@ifinfo @definfoenclose phoo, //, \\ @end ifinfo
@definfoenclose 명령어를 한 줄에 쓰고, 명령어 다음에 쉼표로
구분된 세개이 인수를 쓴다 (쉼표는 @node 줄과 마찬가지로 구분자로
쓰인다.)
@definfoenclose의 첫번째 인수는 `@'가 없는
@-명령의 이름이다.
뒤의 두개의 인수는 Info 파일에서 highlight할 텍스트를 둘러싸게 된다. 둘러싸는 문자열은 공백을 포함할 수도 있고, 시작하고, 끝내는 문자열중 어느것도 생략될 수 있다. 하지만, 시작하는 문자열을 지정하지 않는다면, 명령어 이름 다음에 두개의 쉼표를 연속으로 써야 한다; 그렇지 않으면 Info formatting 명령은 끝내는 문자열을 시작하는 문자열로 잘못 알아들을 것이다.
TeX과 Info를 위한 @phoo 명령을 정의한 다음,
@phoo{bar}라고 쓰면 Info에서는 `//bar\\'를 보게 될
것이고, 인쇄된 매뉴얼에서는
이탤릭체의 bar가 보일 것이다.
각각의 정의는 각각의 formatter에만 적용된다는 것에 유의한다; 한개는 TeX에만 적용되고, 다른 하나는 Info에만 적용된다.
여기 또 다른 예가 있다;
@ifinfo @definfoenclose headword, , : @end ifinfo @iftex @global@let@headword=@b @end iftex
이것은 @headword을 인수의 앞에는 아무것도 집어넣지 않고, 뒤에는
콜론을 집어넣는 Info formatting 명령으로 정의한다. 그리고 TeX
formatting 명령으로는 그 인수를 볼드체로 typeset하는 명령으로 정의한다.
Go to the first, previous, next, last section, table of contents.