1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/kr/xml-guide.xml">
<title>젠투 리눅스 문서작성 설명서</title>
<author title="Chief Architect"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author>
<author title="번역"><mail link="sarang4u@empal.com">이만우</mail></author>
<author title="번역수정"><mail link="confide@korea.com">윤종은</mail></author>
<author title="Moderator"><mail link="seo@gentoo.org">Jungmin Seo</mail></author>
<abstract> 이 설명서는 새롭고 가벼운 젠투의 XML 가이드 문법을 이용해 어떤식으로 웹 문서를 만드는지를 설명한다.
이 문법은 젠투 리눅스 문서의 공통적인 포맷이고, 이 설명서 또한 젠투의 가이드 XML문법으로 만들어져 있다.
이 설명서는 XML과 HTML에 대한 기본적 지식을 가지고 있다고 가정한다.
</abstract>
<version>1.0</version>
<date>07 Mar 2002</date>
<chapter>
<title>기본적 설명</title>
<section>
<title>Guide XML 의 설계 목표</title>
<body>
<p> guide XML은 가볍다. 그래서 쉽게 우리가 웹 문서를 만드는데 필요한 요구 사항들을 쉽게 익힐 수 있다.
필요한 태그의 수는 최소로 유지된다. -- 오직 우리가 필요한것만 있다.
그리고 닥북(DocBook)이나 XML/SGML 이나 웹에서 읽을수 있는 HTML 등의 다른 문서 포맷으로 쉽게 변환 할 수 있다. </p>
<p>쉽게 <e>만들수</e> 있고 <e>변환할 수</e>있는것이 바로 guide XML의 목표이다.</p>
</body>
</section>
<section>
<title>guide XML을 HTML으로 변환하는 방법</title>
<body>
<p> 우리가 guide XML의 문법을 보기 전에 먼저, guide XML문서를 HTML문서로 변환하는 방법을 알아두는것은 매우 유익하다.
<path>guide-main.xsl</path>라는 파일을 이용해, 커맨드라인 XSLT 프로세싱툴을 이용한다.(엔진이라고도 부른다.)
<path>guide-main.xsl</path> 파일은 정확히 어떻게 guide XML 문서가 목표로하는 HTML문서로 변환 되는지에 대해 기술하고 있다.
두개의 유명한 XSLT 프로세서(엔진)는 <c>sabcmd</c>
(<path>app-text/sablotron</path> 패키지에 있는) 과 <c>xsltproc</c>
(<path>gnome-libs/libxslt</path> 패키지에 있는) 이다.
실험을 통해서 우리는 <c>xsltproc</c> 가 보다 높은 품질과 깔끔함을 보여주는 XSLT 프로세서(엔진)라는걸 찾았다. </p>
<p>일단 여러분이 <c>xsltproc</c> 이나 <c>sabcmd</c> 둘중하나를 인스톨 했으면, 여러분은
guide XML문서를 HTML문서로 변환할 준비가 끝난것이다. 어떻게 해야 할지는 여기에 나와있다!.
먼저 최신의 문서를 여기 우리의 웹사이트에서 다운 받는다.
<uri>http://www.gentoo.org/projects/xml.html</uri>, <uri
link="http://www.gentoo.org/projects/guide-xml-latest.tar.gz">xml-guide-latest.tar.gz</uri>를 찾는다.
그리고 타르볼을 전개한다. 여러분은 <path>gentoo-src</path> 디렉토리를 찾을 수 있을 것이다.
마찬가지로 <path>gentoo-src/xml</path> 디렉토리와 나머지 디렉토리도 보일것이다. 자!
<path>gentoo-src/xml/install.xml</path>파일을 찾는다. (새로운 사용자를 위한 인스톨 가이드문서이다).
이것은 아마 guide XML문서로 되어 있을 것이다. 아주 쉬운 과정으로 변환하는 방법은
<path>guide-main.xsl</path> 파일이 있는 디렉토리로 일단 바꾼다. 그리고 아래와 같이<c>xsltproc</c>를 실행한다:
</p>
<pre>
# <i>cd gentoo-web/xsl</i>
# <i>xsltproc guide-main.xsl ../xml/install.xml > /tmp/install.html</i>
</pre>
<p> 잘 따라했다면 여러분은
<path>install.xml</path> 이 새로운 <path>/tmp/install.html</path>파일로 생겨난것을 볼 수 있을 것이다.
이 새로운 문서는 일반적인 여러분의 웹 브라우저에서 볼 수 있다, 여러분은 <path>gentoo-web</path> 에서 <path>/tmp</path>로
<path>css/main-new.css</path> 와 (안전을 위해) <path>images</path> 디렉토리 전체를 복사할 필요가 있다.
</p>
</body>
</section>
</chapter>
<chapter>
<title>Guide XML</title>
<section>
<title>기본적인 구조</title>
<body>
<p>이제 여러분은 guide XML문서를 변환 할 수 있게 되었다.
여러분은 guide XML 의 문법을 배울 준비가 된 것이다.
우리는 이제 guide XML 문서의 초기화 태그를 시작할 것이다.
</p>
<pre caption="guide XML문서의 초기화 부분">
<?xml version='1.0'?>
<guide>
<title><i>Gentoo Linux Documentation Guide</i></title>
<author title="<i>Chief Architect</i>"><mail link="<i>drobbins@gentoo.org</i>">
<i>Daniel Robbins</i></mail>
</author>
<author title="<i>Editor</i>"><mail link="<i>thomasfl@gentoo.org</i>">
<i>Thomas Flavel</i></mail>
</author>
<abstract><i>This guide shows you how to compose web documentation using
our new lightweight Gentoo guide XML syntax. This syntax is the official
format for Gentoo Linux web documentation, and this document itself was created
using guide XML.</i> </abstract>
<version><i>1.0</i></version>
<date><i>29 Mar 2001</i></date>
</pre>
<p>첫번째 라인은 이 문서가 XML 문서라는것을 알려주는 식별자 태그이다.
다음에 따라오는 문장은 <c><guide></c> 태그이다. -- 전체적인
가이드 문서는 <c><guide> </guide></c> 두쌍의 태그로 둘러
싸인다.
다음으로, <c><title></c> 태그가 온다, 전체 문서의 제목을 정할때 쓰는
태그이다. </p>
<p>다음으로 따라오는 태그는 <c><author></c> 태그이다, 해당문서에 대한
여러명의 저자의 정보를 포함 할 수가 있다.
각각의 <c><author></c> 태그는 <c>title=</c>
요소를 옵션으로 가진다. 문서에 대한 저자들끼리의 특수한 관계도
표현 할수 있다.(저자, 공저자, 수정인, 그외...).
이와 같은 예에서, 저자의 이름은 another 태그로 묶인다. --
<c><mail></c> 태그는 특정인의 이메일 주소를 표시할때 쓰인다.
<c><mail></c> 태그는 선택사항이므로 생략해도 상관없다. 그리고
더이상의 <c><author></c> 요소는 하나의 가이드 문서에서 더이상 요구되지
않는다.
</p>
<p>다음으로 나오는 <c><abstract></c>, <c><version></c> 과
<c><date></c> 는, 문서의 개략적인 요약사항을 표시하는 태그이다,
각각 현재 버전 번호와 현재 버전의 날짜 ( DD MMM YYYY 형식) 을 뜻한다.
여기까지가 가이드 문서의 시작부분이고 이제부터 본격적인 가이드 문서의 내용이
시작된다.
<c><title></c> 과 <c><mail></c>태그는
더이상 직접적으로 <c><guide></c>태그안에 나타나지 않는다.
그리고 이들 태그는 문서의 실질적인 내용이 시작하기 전에 사용하는것을
권한다.(반드시 필요한것도 아니다.) </p>
</body>
</section>
<section>
<title>챕터와 섹션</title>
<body>
<p> 초기화 태그를 작성할 수 있다면, 여러분은 이제 문서에 실질적인 내용을
추가할 수 있는 준비가 된것이다.
가이드 문서는 챕터로 나뉘어 있고, 각각의 챕터는 한개 이상의 섹션으로
구성되어 있다.
각각의 챕터와 섹션은 제목을 가지고 있다.
아래에 한개짜리 섹션을 가진 챕터의 예가 나와 있다. 한단락 한단락에 대해 잘
생각해 보아라.
만약 여러분이<uri link="#doc_pre2">위에 있는 인용문</uri> 과 아래에 있는
XML문서를 붙이고 그 아래에<c></guide></c> 를 첨가해서 파일을 만들면,
여러분은 아주 작고 간단한 guide XML문서를 만들 수 있을 것이다.
</p>
<pre>
<chapter>
<title><i>This is my chapter</i></title>
<section>
<title><i>This is section one of my chapter</i></title>
<body>
<p><i>This is the actual text content of my section.</i></p>
</body>
</section>
</chapter>
</pre>
<p>위에서, 나는 <c><title></c> 태그를 <c><chapter></c> 태그안에 하부 요소로 이용했다.
그리고 섹션을<c><section></c> 태그를 이용해 만들었다. 만약 여러분이
<c><section></c> 의 안을 본다면, 여러분은 두개의 하부 요소를 볼 수 있을 것이다. --
<c><title></c> 과 <c><body></c> 태그이다. 이제 더이상 <c><title></c>
태그는 새롭지 않다, <c><body></c> 는 -- 현재 부분단락의 실질적인 내용을 담고 있는 태그이다.
우리는 <c><body></c>태그안의 요소가 한 조각을 이루고 있음을 볼 수 있다.
</p>
<note> <c><guide></c> 요소는 여러개의
<c><chapter></c>요소를 포함 할 수 있다. 그리고 <c><chapter></c>요소는 여러개의
<c><section></c>요소를 포함 할 수 있다. 그러나 <c><section></c>
요소는 오직 한개의 <c><body></c> 요소만을 포함한다. </note>
</body>
</section>
<section>
<title><body>의 예</title>
<body>
<p>
이제, 실질적인 내용을 어떻게 작성하는가에 대해 배울 시간이 왔다!. 여기에 XML코드로
<c><body></c> 를 어떻게 구성해야 하는지에 대해 설명하고 있다.
</p>
<pre>
<p>
이것은 문단이다. <path>/etc/passwd</path> 는 파일이다.
<uri>http://www.gentoo.org</uri> 는 내가 좋아하는 웹사이트이다.
<c>ls</c> 는 여러분 맘대로 생각해라. 나는 <e>존나게(-_-)</e> 졸립다.
</p>
<pre>
이것은 텍스트 출력이거나 코드이다.
# <i>이것은 여러분의 입력이다</i>
HTML/XML 은 읽기 쉽게금 선택적으로 강조할 수 있다:
<foo><i>bar</i></foo>
<codenote>이것은 코드 블럭 안에서 어떻게 첨부내용을 쓸 수 있는지를 알려준다</codenote>
</pre>
<note>이것은 노트다</note>
<warn>이것은 경고다</warn>
<impo>이것은 중요한 내용이다</impo>
</pre>
<p>
이 아래로는 위의
<c><body></c> 요소안의 코드가 어떻게 랜더링 되었는지에 대해 나온다. </p>
<p>
이것은 문단이다. <path>/etc/passwd</path> 는 파일이다.
<uri>http://www.gentoo.org</uri> 는 내가 좋아하는 웹사이트이다.
<c>ls</c> 는 여러분 맘대로 생각해라. 나는 <e>존나게(-_-)</e> 졸립다.
</p>
<pre>
이것은 텍스트 출력이거나 코드이다.
# <i>이것은 여러분의 입력이다</i>
HTML/XML 은 읽기 쉽게금 선택적으로 강조할 수 있다:
<foo><i>bar</i></foo>
<codenote>이것은 코드 블럭 안에서 어떻게 첨부내용을 쓸 수 있는지를 알려준다</codenote>
</pre>
<note>이것은 노크다</note>
<warn>이것은 경고다</warn>
<impo>이것은 중요한 내용이다</impo>
</body>
</section>
<section>
<title> <body> 태그</title>
<body>
<p> 우리는 이전 섹션에서 새로운 많은 태그에 대한 소개를 보았다. -- 이제는 여러분이 알기 원하는 내용이 나온다
<c><p></c> (문단), <c><pre></c> (코드 블럭), <c><note></c>, <c><warn></c> (경고) 와
<c><impo></c> (중요) 태그들은 한줄이상의 텍스트 정보를 가질 수 있다. 덧붙여
<c><table></c> 요소 (테이블에 대해서는 약간만 설명한다)와 함께,
이들 태그들은 오로지 <c><body></c> 요소 안에 바로 사용해야 한다. 다른점들 -- 이 태그들은
중첩해서 <e>사용하면 안된다.</e> -- 다시 말해서, <c><note></c> 요소를
<c><p></c> 요소 안에서 쓸 수 없다. 아마 여러분이 생각하기에,<c><pre></c> 요소
는 공백을 그대로 보존하니까, 프로그램 코드를 넣는데 적당하다고 볼것이다. 맞는 생각이다.</p>
</body>
</section>
<section>
<title><path>, <c> 와 <e></title>
<body>
<p> <c><path></c>, <c><c></c> 와 <c><e></c> 요소는
<c><body></c>태그안에서 <c><pre></c>를 제외한 모든 하부포함 태그 안에서 사용될 수 있다. </p>
<p> <c><path></c> 요소는
<e>디스크상의 파일</e>을 표시하거나 가르키는데 사용한다.
-- <e>절대경로나 상대경로</e> 둘다로 표현이 가능하다, 아니면 <e>간단한 파일 이름</e>등을 표시할때 쓴다.
이 요소는 일반적으로 표준 문단 타입에서 고정폭 글꼴로 랜더링 된다.
</p>
<p><c><c></c> 요소는 <e>명령어</e> 나 <e>사용자의 입력내용</e>등을 표시하는데 사용한다.
<c><c></c> 를 또한 세심한 주의를 요하는 입력이나, 주의해서 읽어야 할 부분 등에 사용하는 방법도 생각해볼만 하다.
예를 들어,이 문서의 모든
XML태그들은 <c><c></c> 태그에 둘러쌓여 표시된다.
왜냐면 사용자가 경로가 아닌것을 입력할 수 있도록 설명해야 하기 때문이다.
<c><c></c> 요소를 사용해서, 여러분은 여러분의 글을 읽는 독자들이 보다 쉽고 빠르게 명령어와 그들이 입력해야
할것들을 구분해 내도록 도와줄 수 있다.
또한, <c><c></c> 요소는 고정폭 글꼴이다, <e>그래서 유저의 입력을 큰따옴표로 묶을 필요가 없다.</e>
예를 들어, "<c><c></c>" 이런식으로 표현하지 말라는 말이다.
위에처럼 큰따옴표를 사용하지 않는 문서형식을 문서를 더욱 보기 쉽게 만들어준다.-- 사랑스러울정도로! (역자주:-_-)</p>
<p><c><e></c> 는 단어나 문장을 강조하는데 사용한다; 예를 들어:
나는 <e>정말로</e> 세미콜론을 더 많이 써야 한다. 여러분이 보듯이, 이 글자는
강조를 위해 폭이 조정된다. 이는 여러분의 문서를 보다 <e>멋지게</e>!</p> 해준다
</body>
</section>
<section>
<title><mail> 과 <uri></title>
<body>
<p>우리는 <c><mail></c> 태그를 저 앞에서 먼저 보았다; 이 태그는 어떤 문장을 특정한 이메일 주소로 링크를 걸어준다.
<c><mail link="foo@bar.com">Mr. Foo Bar</mail></c>이런식으로 사용하면 된다.</p>
<p><c><uri></c> 태그는 인터넷상의 파일이나 주소를 표시할때 사용한다.
이건 두가지 형식을 가지는데 -- <uri>http://www.gentoo.org</uri>처럼 문서안에서 링크 이름을 그대로
출력해서 링크에 접근하는 방식이다.이 링크를 만들려고, 난
<c><uri>http://www.gentoo.org</uri></c>라고 입력했다. 나머지 다른 형식은 링크이름을 다른 문장으로 대체해
문서에는 URI가 직접 드러나지 않는 방식이다. -- 예를 들면 <uri
link="http://www.gentoo.org">the Gentoo Linux website</uri>와 같은거다. <e>이 링크</e>를 만들려면
<c><uri link="http://www.gentoo.org">the Gentoo Linux website</uri></c> 라고 입력하면 된다.
</p>
</body>
</section>
<section>
<title>그림</title>
<body>
<p>문서에 그림을 어떻게 삽입해야 하는지를 설명한다 -- <c><figure
link="mygfx.png" short="my picture" caption="my favorite picture of all
time"/></c>이렇게 입력한다. <c>link=</c> 그래픽이미지의 파일이름,
<c>short=</c> 그래픽 이미지의 간단한 설명 (HTML <c>alt=</c> 속성을 이용한다), 그리고 제목 으로 구성된다.
뭐.. 그리 어렵지 않다. :)
우리는 또한 HTML-스타일의 <img src="foo.gif"/> 태그도 지원한다.
이경우 이미지에 테두리나, 제목 등을 지원하지 못한다.</p>
</body>
</section>
<section>
<title>테이블과 리스트</title>
<body>
<p>guide XML은 HTML과 비슷한 테이블 태그를 지원한다.
테이블의 시작은, <c><table></c> 태그를 사용해서 시작한다. 한줄은<c><tr></c>태그로
그러나, 실질적인 데이터의 입력에서, 우리는 HTML 방식의 <td> 를 사용하지 <e>않는다.</e>
만약에 헤더를 입력했으면, 일반적인 정보는 <c><ti></c>태그로 입력한다.
여러분은 또한 <c><th></c>태그도 사용할 수 있다. 어디든지 <c><ti></c> 태그를 사용할 수 있다 --
이는 <c><th></c> 요소를 필요로 하지 않는다. 이건 오로지 줄의 첫번째에서만 나타난다.
일반적으로, 이 태그는 다른 특별한 속성을 지원하지 않는다. 그러나 몇가지는
추가 할 수 있다 (예를 들어 <c><table></c> 에서 <c>caption=</c> 속성을 쓸 수 있다 ).
</p>
<p> 순정렬 혹은 역순정렬 리스트를 만들려면, 간단한 HTML-style 을 사용하면 된다.
<c><ol></c>, <c><ul></c> 과 <c><li></c> 태그들말이다.
리스트 태그들은 <c><p></c>, <c><ti></c>,
<c><note></c>, <c><warn></c> 나 <c><impo></c> 태그 안에서 사용되어야 한다. </p>
</body>
</section>
<section>
<title>문서 레퍼런스</title>
<body>
<p>가이드 문서는 정말로 쉽게 문서의 다른 부분을 하이퍼링크를 이용해 레퍼런싱 할 수 있다.
여러분은 <uri link="#doc_chap1"> chaper1</uri>의 링크를 <c><uri link="#doc_chap1">ChapterOne</uri></c>
라고 타이핑 함으로써 만들 수 있다.
<uri link="#doc_chap1_sect2">section two of Chapter One</uri>는
<c><uri link="#doc_chap1_sect2">section two of Chapter One</uri></c>라고 타이핑 함으로써 만들 수 있다.
그림 3을 참조하는 링크는, <c><uri link="doc_fig3">figure 3</uri></c>라고 타이핑 하면 된다.
또한 <uri link="#doc_pre2">code listing 2</uri>는 <c><uri link="doc_pre2">code listing 2</uri></c>
라고 타이핑하면 만들어진다.
우리는 곧 자동링크 기능을 (테이블을 지원하는) 추가할 것이다.
</p>
</body>
</section>
</chapter>
<chapter>
<title>Resources</title>
<section>
<title>글쓰기</title>
<body>
<p>
가이드는 "배우면서 익히게" 디자인 되었다. 그래서 개발자들이 문서화에 좀더 많은 시간을
투자하고, 실질적인 XML문법을 공부하는데는 보다 적은 시간을 쓸 수 있게 하였다.
이런점이 "재치있는 문장가" 가 아닌 개발자들이라도 젠투 리눅스 문서 작성을 시작할 수 있도록
하는 소망이 있다.
만약 여러분이 남을 도와주길 꺼리지 않는다면(아니면 가이드에 대한 어떤 질문이라도 있다면)
이메일을 <mail link="gentoo-dev@gentoo.org">the gentoo-dev mailing list</mail> 로 보내주기 바란다.
우리에게 태클걸기를 시작해다오~!
즐컴!
</p>
</body>
</section>
</chapter>
</guide>
|
GitWeb