== CTWILL 시스템 == === 소개 === CWEB 시스템으로 하는 문학적 프로그래밍은 컴퓨터 프로그래머들로 하여금 마치 자신이 소설이나 수필을 쓰고 있는 듯한 착각을 불러 일으킬 정도로 프로그래밍 작업을 즐겁게하여 줍니다. 뿐만아니라, 그 작업 결과 또한 매우 깔끔하고 훌륭합니다. 특히, 프로그램 도큐먼트 맨 뒤에 자동으로 생성해주는 인덱스는 매우 유용합니다. 한 편의 짧은 에세이 정도 길이의 프로그램이라면 그 인덱스가 매우 유익할텐데, 장편 소설 같은 프로그램이라면 상황이 달라집니다. 오히려 도큐먼트 맨 뒤에 나오는 인덱스는 골칫거리가 될 수도 있습니다. 프로그램 소스를 읽는다는 것은 보통의 소설이나 수필을 읽는 것과는 약간 차이가 있어서, 그 소스에 사용된 변수나 함수등 각종 식별자들의 정의와 쓰임새등을 세세히 자주 파악할 필요가 있습니다. 그럴 때마다, 즉 어떤 변수의 정의나 쓰이는 곳을 찾기 위해서 도큐먼트의 맨 뒤의 인덱스를 찾아서 해당 페이지로 가는 것은 매우 귀찮은 작업입니다. 우리에게 친숙한 TeX: The Program 역시 web 시스템으로 작성된 문학적 프로그램인데, 그 소스의 도큐먼트 페이지가 500 페이지가 훨씬 넘고, 맨 뒤에 나오는 인덱스만도 30 페이지가 넘습니다. 이러한 상황을 해결하기 위한 방법 중의 하나는 인덱스를 맨 뒤에만 두는 것 뿐만 아니라, 도큐먼트 전반에 걸쳐서 매 오른쪽 페이지에 둔다면, 현재 페이지에서 사용된 변수나 함수들을 쉽게 찾아 볼 수 있을 것입니다. 이러한 인덱스를 미니 인덱스(mini-indexes) 라고 하는데, ctwill 시스템은 문학적 프로그래밍 할 때에 미니 인덱스를 생성하도록 도와줍니다. Knuth는 그의 책 [http://www-cs-faculty.stanford.edu/~knuth/sgb.html The Stanford GraphBase]는 ctwill을 이용해서 미니 인덱스를 갖춘 멋진 책입니다. === 구성 === CTWILL 시스템은 크게 세 개의 프로그램으로 구성되어 있습니다. * '''ctwill''' 이 프로그램은 cweave를 변형한 two-pass 프로그램입니다. cweave가 cwebmac.tex 매크로 파일을 사용하는 반면, ctwill 프로그램은 cwebmac.tex 매크로과 거의 동일하지만, 미니 인덱스 생성등 책을 만드는 데에 보다 초점을 맞춘 ctwimac.tex 매크로 파일을 이용합니다. * '''refsort''' foo.w라는 cweb 파일에 ctwill 프로그램을 적용하고 나면, foo.ref라는 미니 인덱스 생성에 필요한 reference 파일이 생기는데, 이 foo.ref 파일을 정렬하여, 소트된 버전의 foo.sref를 만들어 냅니다. * '''twinx''' ctwill 시스템은 매우 큰 하나의 cweb 프로그램으로 책을 만들거나, 여러 개의 작은 cweb 파일을 묶어서 책을 만드는 경우에 사용됩니다. [http://www-cs-faculty.stanford.edu/~knuth/sgb.html The Stanford GraphBase]는 후자의 경우에 해당합니다. 이러한 경우, 미니 인덱스 뿐만 아니라 여러 cweb 소스들의 major indexes도 필요한데, twinx는 이 경우에 사용됩니다. === 사용법 === Knuth는 ctwill을 만들고나서 참 이상한 일을 합니다. cweb 시스템의 경우는 cwebman.tex이라는 사용자 설명서도 만들고 곳곳에서 인터뷰 ([http://tex.loria.fr/historique/interviews/knuth-clb1993.html Donald Knuth-CLB Interview])등을 통해서 cweb을 홍보하기 위해서 많은 애를 썼습니다. 하지만, ctwill을 만들고 나서는 아무런 홍보도, 심지어는 사용자 설명서도 만들지 않았습니다. (이는 아마도 Knuth 설명에의하면, ctwill은 [http://www-cs-faculty.stanford.edu/~knuth/sgb.html The Stanford GraphBase] 책을 만들기 위해서 cweave를 해킹해서 만들었기 때문이고, 안정적이지 않아서 그다지 사용을 추천하지 않는다고 하네요. :( --[작은나무]) 유일한 설명서는 Knuth의 paper "Mini-indexes for literate programs"와 [ftp://ftp.cs.stanford.edu/pub/ctwill/ctwill.tar.gz ctwill.tar.gz]에 들어 있는 ctwill.w, refsort.w, twinx.w 들의 cweb 파일에서 도큐먼트를 만들어내서 읽어야 합니다. ==== 설치 ==== ctwill.tar.gz내의 Makefile에는 그 흔한 make install도 제공하지 않습니다. -_-; 1. ctwill.tar.gz의 압축을 풀고, cweb 설치 할때와 마찬가지로 한글(utf-8)을 이용하기 위해서 common.w 파일의 buffer_end 정의한 곳에서 buffer_size를 long_buffer_size로 바꿉니다. 2. make ctwill, make refsort, make twinx를 통해서 실행 파일을 만들어 path가 잡혀 있는, 예를들어, /usr/local/bin에 둡니다. 3. ctwimac.tex, twinxmac.tex 등 매크로 파일을 tex이 알 수 있는 디렉토리에 둡니다. ==== 사용예 ==== 구체적인 설명을 위해서, n개의 cweb파일을 가지고, 책을 만든다고 가정하겠습니다. 1. 먼저 n개의 cweb 프로그램 소스를 bar1.w, bar2.w, ... barn.w을 만듭니다. 각각의 cweb 파일은 각 프로그램에 대한 자세한 설명을 담고 있습니다. 2. 위의 n개의 cweb 파일을 포함하는 foo.w을 만듭니다. foo.w 파일에는 만들고자 하는 책의 전체적인 설명을 담고 있습니다. foo.w안에 위의 n개의 cweb 파일을 포함하는 방법은 다음과 같습니다. {{{ @i "bar1.w" @i "bar2.w" ... @i "barn.w" }}} 이제 책을 만들 준비가 다 끝났습니다. 3. 먼저 ctwill 프로그램으로 foo.{tex,idx,scn,aux} 파일들을 만듭니다. {{{ ctwill foo.w }}} 4. 위에서 생성한 foo.tex 으로부터 foo.{ref,log,dvi} 파일들을 만들어 냅니다 {{{ tex foo.tex }}} 5. 위 단계에서 생성한 reference 파일, foo.ref를 소트하여 foo.sref를 만듭니다. {{{ refsort < foo.ref > foo.sref }}} 6. 최종적으로 tex을 한 번 더 실행합니다. {{{ tex foo.tex }}} 7. twinx를 이용하여 master 인덱스를 생성합니다. {{{ twinx foo.tex > index.tex }}} 8. 인덱스 파일, index.tex을 컴파일 합니다. {{{ tex index.tex }}} 9. 위의 6, 8 단계에서 생성한 foo.dvi, index.dvi로 책을 만듭니다. {{{ dvipdfmx foo dvipdfmx index }}} 불행히도 ctwill은 cweave와 같은 완전 자동 프로그램이 아닙니다. 일부 수작업이 들어갑니다. 하지만 그럼에도 불구하고, 책을 만들고자 하는 분들께는 인덱스 생성에 들어가는 수고를 많이 줄여줍니다. --[작은나무] === ctwill 예제 === * [http://www-cs-faculty.stanford.edu/~knuth/sgb.html The Stanford GraphBase: A Platform for Combinatorial Computing], Donald E. Knuth 지음 * Knuth의 대표적인 ctwill 사용 예제: [http://www-cs-faculty.stanford.edu/~knuth/papers/ham.w.gz Hamiltonian circuits] (KTUGContrib:3268)