daumeditor/DaumEditor — Issue #13: API 문서 작성
Author: ragiragi
Created: 2011-12-09 09:58:38+00:00
State: open

ragiragi 입니다.

다들 느끼시겠지만 현재 DaumEditor 에 가장 부족한 부분 중 하나가 바로 문서입니다. 에디터를 사용하기 위해서는 많은 항목의 config들을 각기 상황에 맞게 설정해야하고, 작성된 내용을 저장 / 수정하기 위해서는 에디터의 JS API 또한 알아야합니다. 작성된 게시글을 조회 화면에 정확하게 표현하기 위해서도 CSS 등을 상황에 맞게 잘 넣어주어야하구요. 굳이 DaumEditor의 기능을 확장하기 위하여 extension 을 직접 개발하려 하지 않아도 DaumEditor 와 관련된 추가 개발 정보들을 많이 필요로 합니다. 하지만 현재 DaumEditor 에서는 이 모든걸 sample 페이지 하나로 커버하고 있는 상황입니다. :-(

기존 googlecode 시절부터 보아오면 결국 많은 이슈들이 이 '사용법'에 관련된 내용이었구요. 이러한 내용들이 개별 이슈들로 case by case 로 처리가 되고, 정확한 문서로 정리가 되지 못하다 보니 사용자 측면에서도 어렵고 운영 측면에서도 부담으로 작용하였던 것 같습니다.

이를 해결하고자 'API Documentation' Issue 을 생성하였습니다. :)
문서가 필요한 부분에 대해서 이슈를 생성하고 follow-up 할 예정입니다. 가장 필요한 부분인 configuration, 저장 / 수정을 위한 JS interface 부분을 먼저 진행해보고자 합니다.

문서 작성을 위한 환경도 새로 꾸몄습니다. 기존 JSDOC 을 이용한 문서는 접근성 및 가독성이 부족하여 좀 더 읽고 쓰기 편한 형태로 아래와 같이 변경하였습니다.

---

- 문서 포맷 : markdown 기반 [markdown 문법](http://daringfireball.net/projects/markdown/)
- 문서 build tool : node.js 의 doctool. [[Contributor's Guide]] 참조 바랍니다.
- 소스 : [doc/api](https://github.com/daumeditor/DaumEditor/tree/development/doc/api)
- 언어 : 1. English, 2. 한글
- 짧은 영어라 할지라도 향후 프로젝트 활성화를 위하여 영어를 우선하고자 합니다.
- commit message 규칙 : 커밋메시지 앞에 `daumeditor/DaumEditor# `을 붙여주시면 이 이슈를 통해서 문서화 관련 변경 사항들을 한눈에 볼 수 있을 것 같습니다.

가장 시급한 부분은 config 들인데, 소스 상에서 `TrexConfig.add` 로 검색하면 나오는 항목들을 하나씩 정리해 나가면 될 것 같습니다. - 56개나 되는 군요!

많은 분들의 fork! pull request! 기다리겠습니다. :D
감사합니다.