귤나무 사용설명서입니다

성룡


          
        

초록

이 문서는 귤나무 사용법을 설명하는 문서입니다.


차례

귤나무는..
귤나무의 구성
저작권(라이센스)
귤나무의 장단점
귤나무의 사용법
일반적인 사용법
닥북 문서 탐색
닥북 문서 편집
단축키에 대해서..
주의하실 점
앞으로 할일
마치면서..

귤나무는..

귤나무는 닥북을 좀 더 쉽게 작성할 수 있게 하기 위한 닥북 편집기입니다.

귤나무의 구성

귤나무의 GUI 부분은 Troll Tech 사의 Qt 2.3.0 Non-Commercial 버젼으로 만들어졌습니다. 귤나무의 유효성 검사 부분은 apache.org의 Xerces-C 2.2.0 으로 이루어졌습니다. 귤나무의 문서변환 부분은 apache.org의 Xalan-C 1.5.0 으로 이루어졌습니다.

저작권(라이센스)

이 프로그램은 프리웨어입니다. 라이센스의 이름을 붙이자면 GPL이 되겠지요..? :) 다만, 프로그램 자체는 GPL이어도 이 프로그램을 구성하고 있는 구성물들의 라이센스가 있습니다. Qt에 QPL이 적용되며. Xerces와 Xalan으로 인해 apache.org의 라이센스가 적용됩니다. 하지만 최종적으로, 일반 사용자들은 사용하기에 아무런 제약 조건이 없습니다. 배포 역시 마찬가지입니다. :)

이 프로그램은 DocBook 한국♡ 프로젝트의 도움을 많이 받았습니다. 닥북 윈도우용 패키지를 기본으로 해서 프로그램이 작성 및 테스트를 되었습니다. 제 자신의 닥북에 대한 지식도 이 곳에서 얻어졌습니다. :) 좀 더 자세한 사항은 앞으로 기재할 예정입니다.

또한 이 프로그램에 쓰인 아이콘들은 주로 KDE에서 따왔습니다. ^^; (제가 약간의 수정을 하긴 했습니다..) 또 아이콘들 중의 일부는 인터넷에서 찾아 쓴 거라서 혹시 이의제기가 들어올지도 모르겠습니다. ^^;

귤나무의 장단점

귤나무의 장점은 하나의 프로그램에서 닥북의 작성과 유효성 검사, 문서 변환을 할 수 있다는 것입니다. 자바로 작성된 프로그램들 역시 훌륭하지만, 자바 SDK를 설치할 필요없이 독립적으로 모든 작업을 할 수 있습니다.

귤나무의 단점은 (여러가지가 발견되겠지만..^^;) 가장 치명적인 점은 PDF를 지원 못한다는 것입니다. 이유는 FOP가 모두 자바로만 작성되어있기때문에 귤나무로의 통합을 할 수 없었기 때문입니다. 이점은 물론 FOP 자바 모듈을 실행시키는 것으로 지원할 수 있으리라 예상을 해보지만, C++로 작성된 FOP가 나오길 간절히 바랄뿐입니다.

귤나무의 사용법

귤나무의 사용법에 대해서 설명합니다.

일반적인 사용법

프로그램의 시작과 파일의 열기/닫기/저장은 다른 프로그램과 동일하므로 한번 사용하시면 알 수 있을 것입니다.

닥북 문서 탐색

닥북 문서의 탐색은 문서의 구성요소를 돌아다니는 것을 뜻합니다.

탐색창이 활성화가 되어 있을때 화살표키로 각 문서의 요소들을 이동할 수 있습니다.

닥북 문서 편집

오른쪽에 위치하고 있는 편집창에서 문서 각 요소의 내용을 편집할 수 있습니다. 요소(나뭇잎)나 속성(귤)의 경우 엑셀 형태의 입력 위젯이 나타나며, 내용을 입력함과 동시에 문서에 내용이 적용이 됩니다. Text(꽃)의 경우 메모장 형태에 위젯이 나타나며, 이곳에 내용을 입력하신후 [적용]버튼을 누르셔야 문서에 적용이 됩니다.(단축키는 ALT + D입니다)

요소의 경우 편집창의 왼쪽이 요소의 이름이며 오른쪽은 주석입니다. 주석은 내용만 입력해도 태그 윗줄에 주석처리되어 들어갑니다.

속성의 경우 편집창의 왼쪽이 속성의 이름이며 오른쪽은 속성의 값입니다.

단축키에 대해서..

귤나무를 사용하실때 일반적으로 마우스로 편집하고자 하는 곳을 클릭한 다음 키보드로 내용을 입력하는 형태로 닥북을 작성하실 수 있습니다. 하지만 좀 더 빠른 편집을 위해서 마우스를 사용하지 않고도 모든 문서편집이 가능한 사용자 인터페이스를 추구했습니다. (Vi 편집기처럼 말이죠..)

탐색창으로의 이동은 CTRL+W로 하실 수 있습니다. 편집창으로의 이동은 CTRL+E로 하실 수 있습니다. (마우스 오른쪽 클릭에 해당하는)요소의 추가/삭제를 위한 팝업창 띄우기는 CTRL+R로 하실 수 있습니다.

제가 추구한 건 키보드상에서 손이 별로 움직이지 않는 인터페이스였는데, 이 사용법문서를 만들기 위해 귤나무를 직접 사용해보니 여간 불편한게 아니더군요..--;; (어떻게 보면 일반 편집기를 사용하는 것보다 손가락을 더많이 움직여야 하는 것 같습니다..) 앞으로 편하고 빠른 편집을 위해서 많이 고민해 보겠습니다.

주의하실 점

DTD가 아닌 스키마 기반의 유효성검사를 하기 때문에 DOCTYPE 태그가 없어야 합니다. 있으면 유효성 검사할때 프로그램이 다운이 됩니다. 이 사항은 유효성 검사시에만 해당하고, 문서를 여는 것뿐이라면 상관은 없습니다. 다만 DOCTYPE 태그는 귤나무에서 보여지지 않습니다.

파일이 위치한 폴더나 파일의 이름이 한글이면 읽지 못합니다

유효성 검사를 하려면 닥북문서의 스키마 경로를 지정해주어야 합니다. ( 스키마 위치는 [실행파일위치/docbook/schema] 입니다.)

이 프로그램에 포함된 stylesheet 폴더는 닥북 윈도우용 패키지에서 옮겨온 것입니다. 다만 용량을 줄이려는 목적으로 귤나무에서 사용하지 않는 부분이라 생각하는 하위 폴더들은 삭제를 하였습니다.

스타일시트의 적용은 dbk-html.xsl로 고정 적용됩니다. 스타일시트를 선택 적용하는 점은 앞으로 개선해보겠습니다.

앞으로 할일

일단 기본적으로 사용자 인터페이스와 디자인 부분을 계속 개선시켜 나갈 것입니다.

사용자 인터페이스 부분은 많은 시간을 투자해야 할 것 같습니다. 두 부분으로 나뉘어진 개선 작업이 이루어져야 할 걸로 생각됩니다.

첫째는 닥북 자체에 의한 것입니다. 이 사용법 문서는 제가 처음으로 만들어본 닥북문서입니다. 그런데 작성하기가 만만치 않습니다. 어떤 태그를 어디다 써야 할지 몰라 상당히 당황스럽습니다. 저는 이 프로그램을 만들기 위해 닥북문서를 많이 기웃거려봤는데도 그런데, 닥북을 처음 접하는 사람들은 더할나위가 없을 것 같습니다. 따라서 앞으로 태그를 '고르는' 식의 편집기로 가야할 것 같습니다.

또 닥북을 작성하며 느낀 점이 태그가 만만치 않게 많이 들어간다는 것입니다. orderlist 같은 태그를 쓰려고 하니 정말 많은 걸 챙겨야 되더군요. (저만 그런건가요..? ^^;) 그래서 템플릿 형식의 태그 삽입 기능을 작성해볼까 합니다. section 태그를 삽입하면 id와 title, para 태그가 기본적으로 들어가는 형식으로 말입니다.

둘째는 프로그램 자체적인 불편함입니다. 손이 너무 많이 들어가네요. 몇페이지 분량의 문서를 만들려면 날 새겠습니다. ^^; 좀더 편한 편집기가 되도록 하겠습니다.

또한 이 프로그램은 Qt로 작성되었기 때문에, 플랫폼 독립적으로 돌아갈 수 있습니다. 하지만 아직 리눅스에서는 컴파일 및 테스트를 해보지 못했습니다. 이 부분을 앞으로 해볼 생각입니다.

그리고 디자인 부분은 신경 좀 더 써야할 것 같습니다. 프로그램 레이아웃에서부터 아이콘 모양까지 말입니다.

그리고 이 프로그램은 오픈소스 프로젝트로 진행시켜 나갈 것입니다. 프로젝트라는 것을 진행하는 것을 생각해보니 많은 준비가 필요한 것 같습니다. 그때까지 시간이 좀 걸리겠네요.

마치면서..

얼렁뚱땅 첫번째 프로그램 설명 문서를 만들게 됐습니다. 내용이 많이 부실하지만, 앞으로 계속 보충해가겠습니다. ( 특히 라이센스 부분 )

말씀드리기 뭣하지만, 제가 초보 프로그래머라서.. 여러가지 초보적인 실수들이 많이 있을 겁니다. 프로그램이 갑자기 다운이 되버릴 수도 있을 것입니다. (포인터를 처음 써보느라.. 어쩌면 시스템에 악영향을 미칠지도.. --;;) 레이아웃 부분도 마찬가지라서,프로그램을 전체화면으로 늘려보시면 뭔가 이상하다는 걸 느끼실 수 있을 겁니다..^^;

일단 부족하나마 0.1 버젼을 릴리즈했습니다. 아무쪼록 이 프로그램이 닥북의 발전에 보탬이 되었으면 하는 생각입니다.