새로운 포맷을 만들어 보았습니다.

자유 게시판

새로운 포맷을 만들어 보았습니다.

전체글글쓴이: haje01 » 2007-03-16 3:16 pm

아래글에 주소가 틀려 다시 올립니다. ( 좀 지워주세요.. ㅠㅠ )
---------------------------------------------------------------------------

이 곳에 올려주시는 글들을 참고해서, 팀내 문서화를
닥북을 공부해가며 꽤 진행하였습니다. 상당히 장점이 많다고
생각되었습니다만, 문제라고 하기엔 그런 아쉬운 점들이 있었습니다.

1. 초보자가 쓰기에는 엘레멘트가 너무 복잡(다양?)하다.
2. 표, 리스트 등에 요소를 위한 타이핑이 너무 많다.
3. PDF문서의 경우, 빌드에 걸리는 시간이 너무 길다.

등등의 문제로 팀내에서 회의의 목소리가 커졌습니다..


고민하던 중 dbwiki등에서 착안을 하여 TinyDoc(가칭)이라는
포맷을 고안해 보았습니다. 아래의 주소에 간단한 메뉴얼을
올려 놓았습니다.

http://www.daniya.com/tinydoc/document/ ... manual.xml

간단히 얘기하면, 좀 단순화 된 닥북형식으로 작업을 하고
( 작업중에 프리뷰는 웹브라우저로 합니다. )
최종적으로 닥북포맷으로 변경해 pdf를 생성하는 방식입니다.

아직 docbook으로 변환하는 것은 만들지 못했는데요..
이러한 방법이 유용할지에 대해 닥북을 쓰시는 여러분들의
의견이 듣고 싶습니다.
haje01
 

전체글글쓴이: 류광 » 2007-03-18 10:21 pm

(이전 글은 지웠습니다...)
기본적으로 저도 DocBook이 너무 복잡하다고 생각합니다. DbWiki를 만든 것도 그런 이유였고요... XML을 벗어나지 않으면서 편리함을 추구한다는 TinyDoc의 접근방식이 상당히 인상적입니다.

DbWiki 개발 경험에서 한 가지 말씀드리면... 단순함을 유지하면서도 DocBook의 표현력을 최대한 흉내내기 위해서는 범용 블럭, 범용 인라인, 버바팀(verbatim)을 위한 수단이 꼭 필요하더군요. 그리고 문서 내부의 참조를 위한 id를 지정하는 수단도 꼭 필요한데, TinyDoc의 경우에는 XML 기반이므로 이미 해결이 된 셈이고요.

DocBook으로 변환하는 스크립트 기대하겠습니다~

그나저나 Visual Studio의 XML 편집 기능이 제가 생각하는 이상적인 XML 편집기와 거의 일치하네요.... Express 버전 깔고 거의 안 썼는데 XML 용으로 써봐야 겠습니다.
류광
사용자
 
전체글: 433
가입일: 2003-12-27 12:02 am

답변감사합니다.

전체글글쓴이: haje01 » 2007-03-19 10:43 am

답변에 감사드립니다.

아직은 초기버전이어서 부족한 부분이 많습니다만,
말씀하신 부분을 참고하여, 앞으로의 작업을 진행
하도록 하겠습니다.

팀내 문서화를 하는 틈틈이 기능을 보강해 나가려
합니다. 다른 분들도 써 보시고 조언 주시길 바라겠습니다..
haje01
 

전체글글쓴이: 류광 » 2007-03-26 7:47 pm

다시 생각해보니 TinyDoc은 기본적으로 XML 기반이고 어차피 해당 요소의 CSS, XSLT가 지원되지 않으면 의미가 없으니, 닥북한국의 위키 같은 범용 블록, 범용 인라인이 꼭 필요할 것 같지는 않네요. 그냥 필요에 따라 새 요소를(그리고 관련 CSS, XSLT를) 추가하면 되는 문제일 것 같습니다. 특히 태그가 제시되는 편리한 XML 편집 환경이라면 사용자의 입장에서는 스키마 자체에서 새 요소를 지원하게 하는 게 훨씬 편할 것입니다.

그리고 버바팀도 마찬가지인데, XML 이름공간을 이용해서 DocBook의 것을 그대로 사용하면 될 것이니까요...

문제는 필요에 따라 스키마 및 관련 파일을 갱신하는 과정을 합리화하는 것인데, http://norman.walsh.name/2005/11/05/dbtiny 같은 접근방식도 흥미롭습니다. 제가 상상하는 것은... DocBook XML 전체에 대해 최대한 많은 CSS, XSLT 조각들을 만들어 두고, 뭐랄까 요즘의 설치 프로그램의 체크상자 딸린 트리뷰 같은 것으로 원하는 요소들을 선택하면 자동으로 TinyDoc 스키마 및 CSS, XSLT가 생성되게 하는 것입니다. 멋지지 않을까요 ~
류광
사용자
 
전체글: 433
가입일: 2003-12-27 12:02 am

* 흥미롭습니다..

전체글글쓴이: haje01 » 2007-03-27 10:47 am

말씀하신 페이지를 잘 살펴보았습니다.

그러한 방식은 필요한 요소만을 노출 할 수 있게하여
확실히 DocBook의 복잡도를 많이 줄여줄 수 있을 듯
합니다. RelaxNG의 강력함이 다시 한번 나타나는
부분인 듯 한데요.. ( TinyDoc도 RelaxNG로 작업하고
있습니다. )

그런데 그 방식은 좀 RelexNG + Emacs에 최적화
되어있는 듯 하여 일반적이진 않을 듯 합니다.

역시 말씀하신 대로 트리뷰UI를 제공하여 선택적으로
스키마, CSS, XSLT를 생성하는 방법이 보통사람들이
사용하기에는 좋은 방법일 듯 하네요.

제 경우는 주위 사람들에게 TinyDoc을 소개해 주었을 때
몇가지 더 필요한 요소에 대한 제안이 있었고, 그 것들을
어떻게 추가할지가 고민입니다. ( 자칫 DocBook과 같이
많은 태그를 제공하면, 특징이 사라져버릴 듯 하여.. )

제안하신 방법을 도입하는 것도 가능할 듯 하고, 코어한
스키마와 그것을 확장한 특화된 스키마들을 정의
하는 것도 생각해 보고있습니다.

DocBook을 사용하시는 분들에게는 말씀하신 것처럼
선택적인 스키마의 조합을 사용하거나, 도메인에 맞는
전문스키마를 정의 하여 기술 한 뒤, 그것을 XSLT을 통해
DocBook으로변환하는 등의 방법이 앞으로 기대가 됩니다.
haje01
 

* TinyDoc홈페이지입니다.

전체글글쓴이: haje01 » 2007-03-27 10:51 am

TinyDoc 홈페이지를 만들어 보았습니다.

http://www.tinydoc.org

앞으로는 이쪽에서 갱신할 예정입니다.
모쪼록 많은 관심과 조언바라겠습니다~
haje01
 

전체글글쓴이: 초보 » 2007-03-28 11:56 am

tinyDoc 매뉴얼 페이지를 firefox 로 보면 페이지의 왼쪽이 브라우저의 영역밖으로
넘어갑니다. 아마도 스타일시트에 문제가 있는듯합니다.
IE 에서는 제대로 보이는군요...
초보
 

아.. 그렇네요

전체글글쓴이: haje01 » 2007-03-28 8:23 pm

음.. 확실히 문제가 있네요.

아직 스타일쉬트나 CSS에 미숙하여 뭔가 표준을 어긴 것인지도 모르겠습니다..

수정하도록 하겠습니다.
haje01
 

* FireFox와의 문제를 해결하였습니다.

전체글글쓴이: haje01 » 2007-05-28 12:01 pm

업데이트가 많이 늦어졌습니다.

지적해주신 TinyDoc문서를 FireFox에서 볼때
이상하게 나오던 문제점을 해결했습니다.

CSS를 IE와 FireFox가 서로 다르게 적용하는 것과
XSLT프로세서도 좀 다르게 동작하는 것 때문에
문제가 발생한 듯 합니다.

www.tinydoc.org에서 확인하실 수 있습니다.

앞으로는 TinyDoc -> DocBook 변환기 작업을 하려합니다.
haje01
 


다시 돌아감: 자유 게시판

접속 중인 사용자

이 포럼에 접속 중인 사용자: 접속한 회원이 없음 그리고 손님들 7 명

cron