1.1.1. 그나마 보존시간이 짧아지고 있다

바로 다양한 binary 포맷 데이타들 때문이다. plain/text 와는 달리 이러한 전용 포멧 데이타들은 읽을수 있는 전용 프로그램이 없다면, 아예 접근조차 못할수 있으며, 이런 전용프로그램들은 아예 사라질수도 있다. 심지어는 같은 전용 프로그램이라도 버젼에 따라서 데이타를 읽지 못하게 될수도 있다.

또한 plain/text 의 경우에는 일부가 훼손되더라도, 그럭저럭 복구가 가능하지만 binary 포멧 데이타의 경우 잘못하면 문서전체가 날라가는 경우도 심심찮게 발생한다.

1.2.1. 그런데 정보 검색의 장점마저 사라지고 있다.

이른바 프리젠테이션(외관)에 중점을 둔 전용의 포맷을 가지는 포맷이 plain/text 대신 사용되기 때문이다. 예를들어 hwp나 doc 로된 문서를 가지는 전자도서관을 구축했다고 하자. 이럴경우 쉽게 검색될수 있다는 기존의 장점은 사리지게 된다. 정보 검색은 고작해야 제목으로 찾기나, 혹은 책의 내용을 요약한 text 를 가지고 찾아야 할것이다.

그나마 hwp, doc 가 현재 자주 쓰이는 포맷이라면 문제가 없다. 그러나 과연 10년 혹은 20년후에도 지금의 hwp, doc 문서를 읽을수 있을런지는 냉정히 생각해 보아야 한다. 여러분이 지금 한 10년전에 쓰이는던 워드퍼펙트 문서, 하나워드, 보석글 문서 를 보려고 한다면 상당한 노력을 기울여야 할것이다. 대부분의 경우는 포기하고, 비슷한 내용을 가지는 다른 문서를 찾으러 떠날것이다.

원하는 문서를 찾았다고 하더라도 내용을 보려면 전용 프로그램(대부분 비싸다)이 있어야 한다. 그나마 전용 프로그램이 사라지면 많은 노력을 기울여야한다. (아마 대부분 포기하고 다른문서를 찾을것이다)

이것은 정보검색의 범위를 심각하게 축소시키게 된다. 반드시 최신의 문서라고 만해서 가장 좋은 정보를 가지고 있을것이라고는 생각할수 없다. 오래된 문서라고 해도 훌륭한 아이디어와 정보를 제공할수 있기 때문이다.

전자 도서관에 doc, hwp, 워드퍼팩, 하나, 보석글 등의 서로호환되지 않은 다양한 포맷의 문서가 공존한다고 생각해보자. 과연 어떻게 접근하고 어떻게 검색을 해야 할것인가.

1.2.2. 접근역시 점점힘들어지고 있다

독특한 포맷으로 작성된 정보에 접근하기 위해서 역시 독특한 전용 소프트웨어를 사용해야 한다. 어떤것은 구하기가 어렵고(오래된 버젼의 포맷), 어떤것은 많은 비용을 지불해야 한다. (불법복사라는게 있긴하지만) 원하는 정보를 얻기 위해서는 그정도의 경제능력을 가지고 있어야만 한다. 이는 정보접근에 대한 불평등을 가속화 시킨다 - 마치 컴퓨터와 인터넷 인프라의 유무로 인한 정보 빈부격차가 가속화 되는 것처럼 -. 머 어차피 이러한 격차가 생기는 건 어쩔수 없겠지만, 조금만 노력한다면 이러한 격차를 줄일수 있을것이다.

plain/text 로 작성된 RFC의 경우 인터넷에 연결되어 있다면, 문서에 접근하는데 제약이 없다. 이문서가 워드퍼펙 포맷으로 작성되어 있다고 생각해보라, 소프트웨어를 찾는것 조차 수월하지 않을것이다. ms word 역시 언제 워드퍼펙 짝이 날런지 알수 없는 일이다.

2.3.1. docbook의 특징

기업이나 개인이 사용하는 대부분의 문서들은 데이터 중심이 아닌 프리젠테이션 중심이다. 이들 문서들은 외관상 예쁘긴 하지만 표준,효율,정보 중심의 표준적인 틀을 가지고 있지 않고 중구난방으로 제작되는 경향이 있다. 최근의 문서제작툴들이 xml을 지향하기 시작했다는 것은 그나마 다행이라고 할 수 있겠다.

docbook는 정보와 데이터중심의 표준적이고 효율적인 문서의 제작을 도와주기 위한 목적으로 만들어 졌다.

2.3.2. 개발 문서는 docbook 으로 하자

제안서, 홍보용 문서등 구조적인 문서의 내용을 보여주는것 보다는 외적으로 회려한 그래서 사람의 시선을 끌수 있는 문서가 아닌 개발문서 를 만들고자 한다면 docbook 의 사용을 권장하는 바이다.

docbook 은 매우 사용하기 쉬우며(HTML 을 사용하는 것만큼), 문서를 구조적으로 작성할수 있도록 도와주며, plain/text 로 언제든지 열람가능하고 그자체를 데이타베이스로써 관리할수 있다. 또한 쉽게 접근가능하다.

필자는 개발문서작성을 위해서 word, hwp 등의 전용 어플리케이션을 쓰는걸 지극히 싫어하는(반대하는 입장)이다. 일단 문서 표준이 없다. 나름대로 팀에서 만든다고 만들겠지만, 구조적으로 보기 쉬운 표준화된 문서의 틀을 마련하는건 결코 쉬운일이 아니다. 또한 이러한 틀을 만들었다고 해도 다른 회사의 문서들 - 심지어는 같은 회사의 다른 팀의 문서들 - 과도 그 틀이 다르며, 이는 문서의 이해도를 떨어지게 만든다. 팀이 바뀌면 이 틀은 깨어지게 된다.

게다가 문서 검색이 힘들다.(고작해야 제목으로 검색이 가능하다) 검색이 힘든 문서는 활용도가 떨어지게 되고, 이러한 문서들이 쌓이고 쌓이면 결국 하드의 한구석만 차지하는 쓸모없는 정보가 되어버리고 만다. docbook 는 HTML 로 변경하든 그대로 사용하든지 간에 모든 종류의 검색이 가능하다. 보통 개발 문서에는 많은 중요한 내용이 - 설계방법, 코딩방법, 팁, 문제해결 방법, 코드 -들어 있는데, 검색자체가 힘들므로 만들어진 개발문서가 다음 프로젝트에 거의 활용되어 지지 않는다. 그나마 팀이 그대로 유지되면 괜찮은데, 팀개편이라도 일어나게 되면, 이 문서들은 거의 폐기되는 경우가 많다(개인적으로 유지하는 경우 제외하면)

결론적으로 말해서 docbook을 사용하면 표준화된, 그리고 검색하기 쉬우며, 사용하기 쉽고, 데이타 베이스화 하기 쉬운 표준 문서를 가지게 됨으로써 약간의 노력으로 - 약간 능력 있는 프로그래머가 한 일주일만 노력하면 쓸만한 시스템을 구축할수 있을것이다. (물론 다른 공개된 시스템을 수정해서 사용해도 된다) - 지식 system을 구축할수 있다.

문서 작성시간도 훨씬 단축시킬수 있다. 문서의 구조에 대해서 생각해야 되는 시간을 줄일수 있으며, 눈에 어떻게 보일런지에 신경쓰지 않아도 되기 때문이다.

2.3.3. 물론 단점도 있다

아직 많은 회사에서 훌륭한 정보란, "보기에 예쁜 그림과 표 그리고 폰트를 포함한 doc, hwp 포멧을 가지는 문서에 저장된.. "예쁜문자" 이라고 생각하고 있는게 현실이다. docbook 로 만든문서는 아마 결재처리 과정을 밟지 못하는 불운을 겪을수도 있을 것이다. 어쨋든 분명 docbook 로 만들어진 문서는 "화려한" 이란 수식어와는 거리가 좀 멀다.

아무리 사용하기 쉽다고는 하지만, HTML 테그 같은 몇가지 테그들에 대해서 익히고 있어야 한다. 필자역시 여전히 문서를 만들적에는 docbook 의 기본적인 사용법을 담고 있는 템플릿문서를 참고한다. (하긴 word 나 hwp 도 제대로 익혀서 사용하려면 결코 쉬운게 아니지만)

복잡한 표만들기가 수월하지가 않다. 하지만 복잡한 표를 만들지 않더라도, 정보를 전달할수 있는 방법은 충분하다고 생각되어진다.

모든 회사들이 표준적인 문서로 doc 포맷을 고집하고 있다. 표준적이 되어야할 이유가 없는데도 말이다. docbook 으로 만들어진 문서를 HTML 혹은 PDF 변환 시켜서 준다면 "기본도 안된 회사" 라는 오명을 듣기에 딱 알맞다(PDF 라면 그나마 양호하겠지만).

3.2.1. 문서 형식

docbook 은 자주 사용되는 문서형식에 따라서 다양한 문서의 타입을 지정해줄수 있다. docbook 에서 지원하는 문서형식은 "book", "article", "chapter", "set" 등이 있다. book 는 책을 펴내기에 알맞은 다양한 문서구조를 지원한다. article 는 보고서 수준, chapter 은 간단한 몇개의 장 만으로 이루어진 문서를 나타내기 위해서 사용한다. set 은 여러개의 book 을 포함한다.

이러한 문서구조를 선택하려면 다음과 같이 문서의 처음에 명시해주면 된다.

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
				

3.2.2. docbook 을 사용했음을 알려주기

docbook 은 sgml(xml)의 DTD 이므로, 모든 정보가 사용자 정의된 TAG 를 이용해서 표기되어 진다. 일단은 이 문서가 docbook DTD 를 이용해서 만들어 졌다는걸 알려줘야 한다.

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
				

참고로 현재 이 사이트에서 사용되는 모든 docbook 문서는 article 문서 구조를 사용했다.

3.2.3. 문서의 시작과 끝을 알려준다

HTML 문서의 경우 <HTML> 과 </HTML> TAG 를 이용해서 문서의 시작과 끝을 알려준다. docbook의 경우는 <article> 테그를 이용한다.

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<article lang="ko">

<!-- 실제 문서의 내용이 온다 -->
...
...
</article>
				

3.2.4. 문서의 정보

대부분의 문서를 보면, 문서의 가장 첫머리에는 문서의 "제목", "저작자", "저작자의 연락처 - email 같은 - ", "문서 소개" 등이 놓이게 된다. 문서의 정보를 위해서 사용되는 TAG 는 <articleinfo> 이다. articleinfo TAG 는 HTML 의 HEAD 테그와 비슷하다고 생각할수 있다.

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<article lang="ko">
<articleinfo>
    <title>dockbook 사용하기</title>
    <author>
        <surname>윤</surname>
        <firstname>드림</firstname>
        <affiliation>
            <orgdiv>특수 기술연구개발실</orgdiv>
            <orgname>재미있는 개발팀</orgname>
            <jobtitle>연구원</jobtitle>
            <address>
                <email>dreamyun@yahoo.co.kr</email>
            </address>
        </affiliation>
    </author>
</articleinfo>
....
				

<author>
	<surname>Richard</surname>
	<firstname>mu ge</firstname>
	...
</author>
<!-- 번역자  -->
<othercredit role="translator">
	<surname>아</surname>
	<firstname>무개</firstname>
	....
</othercredit>
					

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<article lang="ko">
<articleinfo>
    <title>dockbook 사용하기</title>
    <author>
         ......
    </author>
	<revhistory>
		<revision>
			<revnumber>0.8</revnumber>
			<date>2003년 1월 22일 23시</date>
			<revremark>revsion 관련 내용추가</revremark>
		</revision>
		<revision>
			<revnumber>0.7</revnumber>
			<date>2003년 1월 21일 3시</date>
			<revremark>문서 최초작성</revremark>
		</revision>
	</revhistory>
</articleinfo>
					

<articleinfo>
....
</articleinfo>
<abstract>
	<para>
		드디어 2.6커널이 세상에 나오게 되었다. 많은 기능들이 추가되었으며 몇몇 중요 기능들은 
		2.4로 백포팅 되기도 했다. 이문서는 2.6커널에 추가된 주요 기능들에 대한 설명을 담고 
		있다. ...   
	</para>
</abstract>
					

3.2.5. 주석의 사용

docbook 는 마크업 언어를 사용한다. 그러므로 문서 작성 자체가 프로그래밍 과정과 매우 비슷하다. 모든 프로그래밍할때와 마찬가지로 주석이 필요할때가 있다. 주석은 HTML 과 동일하게 <-- 주석 --> 를 사용한다.

<!--                                 -->
<!--  여기에서 부터 본문 시작        -->
<!--                                 -->
				

3.2.6. 본문의 작성(기본)

<para>
    시스템 프로그램이란 특정한 프로그래밍 언어를 이용해서 시스템(os)를 제어하는 
    프로그램을 작성하는 것이다. 보통은 C와 perl 등이 주로 사용된다. 사용자와 
    프로그램간에 상호대화하는 영역이 적기 때문에 
    GUI를 포함하지 않는 경우가 많으며, 
    실행시 아규먼트를 주어서 프로그램과 대화하는 경우가 대부분이다.  
</para>
<para>
    이와는 달리 응용 프로그램은 시스템을 제어하는 일이 아닌, 사용자 레벨에서 
    사용되는 프로그램을 말한다. 웹브라우저, 문서작성기, 표계산기 등이 응용 
    프로그램의 범위에 포함된다. 주로 C, C++ 을 통해서 만들어지며, 사용자와 
    프로그램간의 상호대화가 매우 중요하기 때문에 GUI 환경을 포함한다. 
</para>
					

<section>
    <title>언어의 종류</title>
    <para>
        이번장에서는 인터프리터 언어와, 컴파일러 언어에 대해서 
        알아보겠다.
    </para>

    <!-- 인터 프리터 언어에 대해서 -->
    <section>
        <title>인터프리터 언어</title>
        <section>
            <title>Perl</title>
            <para>
                펄은 래리웰이 어쩌고 저쩌고...
            </para>
        </section>
        <section>
            <title>Python</title>
            <para>
                최근 각광 받고 있는 파이슨은 어쩌고 저쩌고...
            </para>
        </section>
    </section>

    <!-- 컴파일러 언어에 대해서 -->
    <section>
        <title>컴파일러 언어</title>
        <section>
            <title>C</title>
            <para>
                오래되었지만 혹은 낡았다고 말하고 있지만 어쩌고 저쩌고..
            </para>
        </section>
        <section>
            <title>C++</title>
            <para>
                C와 닮았지만 전혀다른 언어인 C++ 은 어쩌고 저쩌고..
            </para>
        </section>
    </section>
</section>
					

1장. 언어의 종류
1.1. 인터프리터 언어
1.1.1. Perl
1.1.2. Python

1.2 컴파일러언어
1.2.1. C 
1.2.2. C++ 
					

3.3.1. 링크걸기

문서작성을 하다보면 특정 사이트등에 링크를 걸고자 할때가 있을것이다. 이럴땐 <ulink> 를 사용하면 된다. HTML 의 <a> 와 비슷하다.

더욱 자세한 정보는 <ulink url=http://www.joinc.co.kr>joinc.co.kr</ulink> 를 참고하기 바란다. 
				

3.3.2. 테이블 만들기

문서작성에 있어서 테이블의 사용은 필수이다. ≶table> 를 이용해서 작성가능하다.

<table>
    <title>vim 에서의 커서이동</title>
    <tgroup cols=2>
    <tbody>    
        <row>
            <entry>k</entry>    
            <entry>커서를 위로 움직임</entry>    
        </row>
        <row>
            <entry>j</entry>    
            <entry>커서를 아래로 움직임</entry>    
        </row>
        <row>
            <entry>j</entry>    
            <entry>커서를 왼쪽으로 움직임</entry>    
        </row>
        <row>
            <entry>l</entry>    
            <entry>커서를 오른쪽으로 움직임</entry>    
        </row>
    </tbody>    
    </tgroup>
</table>
				

이보다 좀더 복잡한 표에 대해서는 DocBook으로 글 쓰기(더욱 다채로운 기능들)를 참고하기 바란다.

3.3.3. 그림 넣기

대부분의 문서에 그림은 필수적이다. 다음과 같은 방식으로 필요한 이미지를 넣을수 있다.

<figure>
    <title>테스트 이미지</title>
    <graphic fileref=http://www.joinc.co.kr/images/articles/vim_navi.jpg>
</figure>
				

3.3.4. 참조하기

문서를 작성하다 보면 같은 문서내의 특정한 내용을 "참조"해야 하는경우가 있다. 책이라면 몇 page 를 참조 하라는 방식일것이다. 반면 docbook 은 하이퍼링크로 참조될 영역을 직접 연결시킬수 있다.

<section id="compile">
...
</section>

<section>
...
    <para>
        컴파일 방법에 대한 자세한 내용은 <xref linkend="complie">를 참고하라.
    </para>
</section>
				

3.3.5. 보이는 그대로 찍기

HTML 의 <pre> 와 비슷하며, 특히 쏘쓰 코드를 포함하거나, ASCII 도표등을 포함시키고자 할때 유용하게 사용될수 있다.

<screen>
#include <stdio.h>
int main()
{
    printf("hello world\n"); 
    exit(0);
}
</screen>
				

3.3.6. 부가정보 기록

문서를 작성하다보면, "참고", "주의", "팁" 형식으로 부가적인 데이타를 삽입해야 하는 경우가 있다. docbook 에서는 5가지 유형별로 부가적인 정보를 삽입할수 있도록 도와준다.

---

3.3.6.1. note

부가적인 설명을 첨부하고자 할때를 위해서 note 라는 테그를 제공한다.

<para> <note><title>커널버전 넘버링 방식</title> <para> 리눅스커널버젼 넘버링은 x.x.xx 의 형식으로 이루어진다. 첫번째 필드는 메이저버전의 변화를 표시하기 위해서, 두번째 필드는 마이너버젼의 변화, 세번째는 patch 와 같은 간단한 변화를 표시한다. </para> </para>

note를 적용했을 경우 다음과 같이 표시된다.

	커널버전 넘버링 방식
	리눅스커널버젼 넘버링은 x.x.xx 의 형식으로 이루어진다. 첫번째 필드는 메이저버전의 변화를 표시하기 위해서, 두번째 필드는 마이너버젼의 변화, 세번째는 patch 와 같은 간단한 변화를 표시한다.

---

3.3.6.2. warning

문서를 작성하다보면 문서를 읽는 사람에게 주의해야될 내용을 알려야할 필요가 생긴다. 이럴땐 waring 태그를 사용하면된다.

<para> <warning> <para> fork 를 해서 자식프로세스를 생성시켰을경우, 반드시 wait() 함수를 이용해서 자식프로세스를 정리해주어야 한다. 그렇지 않을경우 좀비프로세스가 발생할수 있다. </para> </warning> </para>

다음은 warnig 테그를 사용했을때의 출력결과이다.

fork 를 해서 자식프로세스를 생성시켰을경우, 반드시 wait() 함수를 이용해서 자식프로세스를 정리해주어야 한다. 그렇지 않을경우 좀비프로세스가 발생할수 있다.

---

3.3.6.3. important

특별히 중요한 사항들을 정리할필요가 있다면 important태그를 사용하면된다.

<para> <important> <para> 이문서의 모든 예제는 리눅스상에서 gcc3.x 를 이용해서 테스트되었다. </para> </important> </para>

다음은 important 태그를 사용했을때의 출력결과이다.

이문서의 모든 예제는 리눅스상에서 gcc3.x 를 이용해서 테스트되었다.

---

3.3.6.4. tip

tip태그를 이용하면 간단한 팁을 문서에 포함시킬수 있다.

<para> <tip> <para> 표준출력을 파일과 터미널에 동시에 출력하길 원한다면 tee 라는 명령어를 이용하면된다. tee는 디버깅을 위한 용도로 유용하게 사용할수 있다. </para> </tip> </para>

다음은 tip 태그를 사용했을때의 출력결과이다.

표준출력을 파일과 터미널에 동시에 출력하길 원한다면 tee 라는 명령어를 이용하면된다. tee는 디버깅을 위한 용도로 유용하게 사용할수 있다.

---

3.3.6.5. caution

문서를 읽는 사람의 주의를 환기시키기 위한 목적으로 caution 태그를 사용할수 있다.

<para> <caution> <title>문서에 내용에 대한 책임</title> <para> 이 문서내용에 의해서 발생된 어떠한 책임도 문서 저작자에게 없음을 밝힘니다. 문서내용에 의해서 발생된 모든 책임은 각자에게 있습니다. </para> </caution> </para>

다음은 caution을 적용했을때의 출력결과이다.

	문서에 내용에 대한 책임
	이 문서내용에 의해서 발생된 어떠한 책임도 문서 저작자에게 없음을 밝힘니다. 문서내용에 의해서 발생된 모든 책임은 각자에게 있습니다.

3.3.7. 각주 달기

책을 보면 페이지의 아래에 어떤 단어등에 대한 자세한 설명등을 달아 놓은걸 볼수 있을것이다. 이걸 각주라고 하는데, docbook 에서 각주를 사용하려면 다음과 같이 하면 된다.

linux 
<footnote>
    <para>
        리누스 토발즈가 만든 운영체제로, minix 를 보고 i386 에서 
        돌아가는 자신만의 운영체제를 만들어 보자는 취지하에 취미로 
        만들어졌다. 
    </para>
</footnote>
의 가장 큰 장점은 재미있다는 것으로 최고의 즐거움 즉 
삽질을 제공한다. 
				

3.3.8. 문자의 강조

<emphasis> 를 사용하면 된다.

<emphasis>Vim</emphasis> 의 특징은 다음과 같다.  
				

3.3.9. 인용문의 사용

<blockquote>
    <attribution>햄릿 중에서</attribution>
    <para>죽느냐 사느냐 이것이 문제로다.</para>
</blockquote>
				

3.3.10. 나열하기

이번에는 목록을 나열하는 다양한 방법에 대해서 알아보도록 하겠다.

3.3.11. 컴퓨터와 관련된 속성

이번에는 컴퓨터 그중에서도 Key 와 관련된 내용들이다. 개발문서를 위해서 docbook 을 사용한다면, 유용하게 사용할수 있을것이다.

아래의 예들을 보면 굳이 이러한 복잡한? TAG를 사용해서 나타낼필요가 있을까 하고 생각할수도 있을것이다. 그러나 이렇게 속성을 각각 지정해 둠으로써 필요할때 속성검색등을 하는데 유용하게 사용할수 있다. docbook 의 가장 큰장점은 데이타에 속성을 지정해줌으로써, 데이타를 단순히 데이타가 아닌 정보로 사용될수 있도록 만들어준다는 점이다.

4.1.1. 여러개의 파일로 이루어진 html 문서를 만들때

이제 모든 준비가 끝났고, 만들어진 docbook 파일을 변환 시키기만 하면 된다. docbook 파일은 보통 sgml(xml)의 확장자를 가지게 된다. 변환은 jada 라는 프로그램을 사용하면 된다.

jade -t sgml -i html -d /usr/share/sgml/docbook/kldp/kldp.dsl#html [파일이름]
				

4.1.2. 하나의 파일로 이루어진 html 문서를 만들때

여러개의 html 파일이 생성되는걸 원치 않을경우가 있다. 예를들어 프린트 하고자 할때나 한눈에 변환된 문서의 내용을 보고 싶을때는 모든 html 문서가 하나의 문서로 정리되기를 원할것이다. 이럴경우에는 다음과 같은 방법으로 변환하면 된다.

jade -V nochunks -t sgml -i html -d /usr/share/sgml/docbook/kldp/kldp.dsl#html [파일이름]