Building Grails Documentation for Korean

이 글은 Grails Documenttaion에 대한 노트이다. 어떻게 구성돼 있고 어떻게 빌드하는지 설명한다.

Grails Documentation Project의 구조

Grails Documentation Proejct는 HTML형식의 Grails Documentation을 만드는 프로젝트다. 그 결과물은 Grails User Guide로서 http://grails.org/doc/1.1/ 페이지에서 확인 할 수 있다. 버전에 따라 문서가 업데이트 되므로 원본문서는 Documentation페이지(http://grails.org/Documentation)에서 User Guide항목에서 확인 할 수있다.

문서화는 크게 Guide와 Reference로 그리고 나머지 나뉜다.

• Guide는 Grails에서 지원하는 기능 들을 각 Chapter별로 정리하여 보여준다.
• Reference는 Grails의 각 기능별로 소스코드에서 사용하는 키워드들을 보여준다.

Guide의 소스 위치는 /grails-doc/src/guide에 각 Chapter별로 나열되어 있으며 Radeox위키 형식을 따르고 있다. Grails Documentation Project는 이 파일들을 읽어 Guide에 해당하는 HTML페이지를 생성한다.

Reference의 소스 위치는 /grails-doc/src/ref/ 및 /grails-doc/src/ref/[각 세부 기능] 폴더에 정리되어 있다. Grails Docuementation Proejct는 이 파일 들을 읽어 Reference에 해당하는 HTML페이지를 생성한다.

/grails-doc/resources/doc.properties 파일에 정의해 놓은 특정 문구를 Guide나 Reference에 대한 문서를 생성할 때 치환하여 생성하는 목록을 가지고 있다. 데이터를 한글로 지정할 경우, native2ascii로 유니코드로 저장하여야 한다. 만약 새로운 Properties를 추가한다면 /grails-doc/Generate.groovy 파일의 vars 전역변수에 등록해 주어야 한다.

기타 /grails-doc/resource/doc.properties

한글 작업을 하기 위해서 Ant설정 변경

한글 작업