멀티미디어방

docbook 문서작성 사례

벤허 2008. 1. 7. 10:30

문서 작성의 실제

  DocBook 문서 작성을 익히는 가장 쉬운 방법은 완성된 구조의 문서를 보고 따라하는 것입니다.

article 작성하기

  article은 간단한 논문이나 설명서 정도의 글에 알맞습니다. 글의 구조가 어떻게 이루어져 나가는지 눈여겨 보기 바랍니다.

예 1. 간단한 article의 예

<?xml version="1.0" encoding="euc-kr"?>                   
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
                  "http://www.docbook.org/xml/4.1.2/docbookx.dtd"> 
<article lang="ko">
  <articleinfo>
    <title>내가 만든 article 문서</title>
    <author>
      <surname>고</surname>
      <firstname>등어</firstname>
      <affiliation>
        <orgname>태평양 고등학교</orgname>
        <orgdiv>등푸른 생선과</orgdiv>
        <address>
          <email>gofish@pacific.ocean</email>
        </address>
      </affiliation>
    </author>
  </articleinfo>
  <abstract> 
    <para>
      문서의 소개나 간단한 요약을 이 곳에 씁니다.
    </para>
  </abstract> 
  <section>
    <title>첫번째 절의 제목</title>
    <para>
      첫 번째 문단입니다. 여기서 부터 글의 본문을
      써 넣습니다. 태그 사이에서는 줄바꿈을 여러번 
      하거나 띄어 쓰기를     두 칸 이상      하여도
      모두 한칸 띄어 쓰는 효과만을 냅니다.  
    </para>
    <para>
      두 번째 문단입니다. 첫번째 문단과는 줄바꿈을
      통해 구별되어 보이게 됩니다. 이렇게 한 문단씩 
      추가시키며 글을 쓰면 됩니다.
    </para>
  </section>
  <section>
    <title>두번째 절의 제목</title>
    <para>
      두 번째 절의 첫번째 문단입니다. 이런 식으로
      절과 문단을 추가 시키며 글을 쓰면 됩니다. 
      절(section)은 제목(title)을 가지고 있어야
      합니다.
    </para>
    <para>
      이렇게 태그들이 전체적으로 어떤 구조를 
      이루는지만 파악하면 좀더 복잡한 구조를 만드는 
      것도 어렵지 않습니다.
    </para>
  </section>
</article>

  이상에서 보인 것과 같이 모든 DocBook 문서는 꼭 XML 선언과 문서 형식 선언으로 시작해야 합니다.

<?xml version="1.0" encoding="euc-kr"?>                   
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
                  "http://www.docbook.org/xml/4.1.2/docbookx.dtd">

  문서 형식 선언이 끝나면 <article> 태그를 여는 것으로 부터 문서 작성이 시작됩니다. 보기에서는 <article lang="ko">와 같이 부가적인 속성이 주어져 있는데 이는 이 문서가 한국어로 씌어져 있다는 점을 나타내기 위한 것입니다. 이 속성이 올바로 지정되어 있지 않으면 문서가 한국어 환경에 맞게 출력되지 않으므로 꼭 lang="ko" 속성을 주도록 합니다.

  article은 다양한 하위 구조를 가지고 있습니다. article은 articleinfo 구성요소를 꼭 포함하고 있어야 하며 하나의 abstract와 여러개의 section을 가집니다. 그리고 이 각각은 또 나름의 하위 구조를 가지고 있습니다. 즉, articleinfo는 문서의 제목을 나타내는 title과 지은이에 대한 정보를 나타내는 author를 가지고 있습니다. abstract는 para를 가지고 있으며 section은 title과 para를 가지고 있습니다. 이해를 돕기 위해 위 문서 구조의 전체적인 도해를 그림에 나타내었습니다.

그림 1. article 문서 구조의 예

article은 articleinfo, abstract, 여러개의 section 등으로 구성된다.

book 작성하기

  다음 보기는 간단한 book 구조 문서의 예를 보여주고 있습니다. book은 책의 형태를 갖추어야 할 만큼 규모가 크고 체계적인 문서에 알맞습니다. book은 bookinfo를 가지고 있어야 하며, 여러개의 chapter와 함께 preface, appendix 등을 가질 수 있습니다. 각 하위 구조가 어떻게 구성되는지를 눈여겨 보기 바랍니다.

예 2. 간단한 book의 예

<?xml version="1.0" encoding="euc-kr"?>                   
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
                  "http://www.docbook.org/xml/4.1.2/docbookx.dtd"> 
<book lang="ko">
  <bookinfo>
    <title>좀더 복잡한 book 문서</title>
    <author>
      <surname>이</surname>
      <firstname>눅수</firstname>
      <affiliation>
        <orgname>자유 소프트웨어 대학</orgname>
        <orgdiv>운영체제과</orgdiv>
        <address>
          <email>leenux@free.os</email>
        </address>
      </affiliation>
    </author>
    <abstract> 
      <para>
        이 글은 간단한 book 문서를 테스트해 보기 위해
	씌어졌습니다. 
      </para>
      <para>
	abstract에서도 para를 사용해 
	문단을 나눌 수 있습니다.
      </para>
    </abstract>
  </bookinfo> 
  <preface>
    <title>서문</title>
    <para>
      이 곳(preface)에는 글의 서문을 넣습니다.
      역시 para를 사용해 문단을 나눌 수 있습니다.
    </para>
  </preface>
  <chapter>
    <title>첫번째 장</title>
    <para>
      첫번째 장(chapter)의 첫번째 문단입니다.
      역시 para를 사용해 문단을 나눌 수 있습니다.
    </para>
  </chapter>
  <chapter>
    <title>두번째 장</title>
    <section>
      <title>첫번째 절</title>
      <para>
        두번째 장의 첫번째 절입니다.
	이와 같이 장(chapter)은 절(section)을
	포함할 수 있습니다.
      </para>
    </section>
    <section>
      <title>두번째 절</title>
      <para>
        절안에서는 역시 para를 사용해
	문단을 추가시킬 수 있습니다.
        장과 절, 문단이 이루는 구조를 눈여겨 
	보시기 바랍니다.
    </section>
  </chapter>
  <appendix>
    <title>부록</title>
    <section>
      <title>부록의 첫번째 절</title>
      <para>
        book은 부록(appendix)을 가질 수 있습니다.
	부록은 다시 여러개의 절로 세분화할 수 
	있습니다.
      </para>
    </section>
  </appendix>
</book>

그림 2. book 문서 구조의 예

book은 bookinfo, preface, appendix, 여러개의 chapter 등으로 구성된다.
[Note] 참고

  지금까지 보인 문서의 예는 DocBook의 아주 간단한 구조만을 사용한 경우입니다. 본격적인 문서를 만들기 위해서는 좀더 자세히 설명된 문서를 참고해야만 합니다.

DocBook으로 글쓰기

 DocBook의 특징과 사용법에 관해 자세히 설명된 문서입니다. 주로 SGML 버전 문서를 위주로 설명되어 있으나 대부분의 내용을 XML 문서에서도 적용 가능합니다.

DocBook:The Definitive Guide(영문)

 DocBook의 교과서라 할 수 있는 문서로, 모든 것이 설명되어 있다고 할 수 있습니다. 특히 각 구성요소(element)의 레퍼런스는 꼭 이 문서를 보아야 합니다.

DocBook:The Definitive Guide(한글-번역중)

 번역 중인 문서입니다. 아직 번역되지 않은 부분이 많고, 전체적으로 정리되지 못한 상태입니다.