태그 : reference

DocBook으로 스프링 레퍼런스 같은 문서를 만들어 보자고

스프링을 알고 나서 사용하는 즐거움 외에 부수적인 즐거움 몇 가지가 있는데 그 중 큰  것은 멋진 소스코드와 설계 노하우를 접할 수 있다는 것과 정말 마음에 드는 기술 문서를 알게 되었다는 것 입니다.

지금까지 많은 기술 문서를 접했지만 스프링 레퍼런스는 정말 읽기 쉽고 원하는 내용을 찾기 쉽게 작성되어 있습니다. 무엇보다 점진적인 학습이 가능합니다.

스프링은 전부 다 몰라서 아는 만큼만 써도 유용하게 쓸 수 있는 프레임워크라고 생각합니다. 그 후에 익숙해져서 더 배우게 되면 그만큼 더 활용할 수 있는... 꺼내도 꺼내도 끝이 없는 화수분 같은 프레임워크입니다. 그리고 레퍼런스도 그렇게 작성되어 있습니다.

그래서 앞으로 저도 프로그램을 만들게 되면 스프링 같이 만들고 레퍼런스를 작성할 때에는 스프링 레퍼런스 처럼 작성하고 싶다는 생각을 하고 있습니다.

좌우간 지금까지는 쓸데 없는 얘기였고... (졸려요. =.=) 이번에 KSUG에서 스프링 레퍼런스를 한글로 공동 번역하는 작업을 진행하기로 했습니다. 시간도 없고 영어 실력도 미천하여 별 도움은 못 되겠지만 늘 받아 먹기만 하는 것이 미안하여 (그리고 공부도 좀 할 요량으로) 참가를 하게 되었습니다.

여러 논의 끝에 HTML로 작업하기로 했는데 정작 스프링 배포본의 HTML 파일은 사람이 작성한 것이 아니고 docbook으로 만든 원본문서를 XSL로 변환해서 자동 생성한 것이라서 아주 지저분하더군요. 버스에서 퇴근하면서 노트북으로 번역을 하고 있기 때문에 마우스질이 힘든데 영 작업이 어렵더라고요.

그래서 그냥 docbook으로 작업을 하고 HTML로 변환한 후에 제출하기로 했습니다.

우선 스프링 CVS에서 레퍼런스 소스를 내려 받고 문서를 빌드하는데 필요한 몇가지 파일을 추가했습니다. spring ant 빌드 파일에서 레퍼런스 빌드 부분만 빼서 빌드 파일도 만들었고요.

한글 문제도 있어서 인코딩을 UTF-8로 되도록 약간 수정했습니다. 아직 PDF는 폰트 설정을 안해서 한글이 안 되지만 HTML 변환은 잘 되네요.

혹시 저 처럼 스프링 레퍼런스 같은 문서를 docbook으로 작성하고 싶으신 분들을 위해서 올려 놓습니다.

저는 아마테라스에서 작업하지만 ant 만 설치되어 있다면 vi나 editplus 같은 일반 에디터로 작업하셔도 됩니다.

나중에 PDF 변환도 한글이 되도록해서 다시 올려 놓겠습니다.

spring_reference.zip


by 박성철 | 2008/09/05 02:31 | 프로그래밍 이야기 | 트랙백 | 덧글(0)

◀ 이전 페이지다음 페이지 ▶