· KLDP.org · KLDP.net · KLDP Wiki · KLDP BBS ·
위키문서변환토론

문서 포맷 변환 토론

개인적으로 자주 가는 채널에서 docbook문서 변환에 관한 이야기기 나왔습니다.

대충 요약해 보면,
  • 대부분의 자작 문서는 간단히 위키 문서로 변환할 수 있을 것이다.
  • 그러나, 일반적인 docbook -> 위키 변환은 tag의 소실을 가져온다.
  • 위키 -> docbook-xml 완벽한 변환을 할 수 없다.
등등입니다.

일단, 인력만 충분하다면 무엇이든지 못할 것은 없을 것입니다 :) 그러나 현 시점에서, 문서 변환은 좀 버거운 작업이 될 것으로 생각되며, KLDPDoc의 활성화 방안을 토론하는 것이 더 시급한 문제가 아닐까 합니다. 잠시 목표를 수정하고 점진적으로 KLDPDoc 활성화 방안을 마련했으면 합니다. --WkPark

IRC에서도 말씀드렸지만, 당장의 정보 손실의 문제를 떠나 표준(?) 포맷인 docbook을 독점(?) 포맷인 위키로 전환한다는것은 다소 문제가 있다고 생각됩니다. 모니위키가 언제까지 영원할 거라는 보장은 없죠. 모니 위키 포맷이 언제까지 현재와 같이 유지된다는 보장도 없구요... docbook은 docbook이기 이전에 xml입니다. 즉, 언제든지 재가공해서 그 시점에 유용한 형식으로 - 예를 들면 open office 9.0 ;) - 전환할 수 있다는 것이지요. 물론 위키 형식에도 장점은 있습니다. 하이퍼링크가 바로 그것이죠! 거기에다 모니위키가 지원하는 몇가지 플러그인은 문서작업을 효율을 높여줍니다(OeKaki, HotDraw, Attachment등).

각설하고, 제 의견은:
  • 기존의 docbook문서나 linuxdoc문서를 (사전에 일괄적으로) 위키 페이지로 변환하지 않는다.
  • 신규 문서는 세 가지 포맷을 모두 인정한다.
  • XML과 XSLT가 있는 것이라면 추가적인 형식도 인정한다.

기술적으로는 큰 문제가 없지만, 위키로 docbook문서를 볼때마다 매번 jade와 sgml2html로 변환한다면 시스템 자원의 낭비가 심할테니 적절한 캐싱이 필요하겠죠. --iolo
DeleteMe jade, sgml2html은 캐싱된 html과 문서의 최근 변경일과 비교해서 선택적으로 jade/sgml2html이 실행됩니다. html + WikiName의 조합일 경우도 생각해 볼 수 있는데 (html로 랜더링 된 출력에 WikiName문법을 적용하여 링크를 거는 방법) 이 경우라면 캐쉬를 일정 주기마다 업데이트 해 줄 필요가 있겠죠. --WkPark

최대한의 효율을 위해서는 작업 방식을 단순화하고 누구나 쉽게 참여할 수 있게 해야 합니다. 제 생각은 툴을 개발해서 기존의 docbook문서나 linuxdoc문서를 위키 페이지로 일괄 변환하고 이것을 docbook xml로 다시 일괄변환해서 ftp로 제공하는 것입니다. 물론 기존문서의 일부 태그가 위키페이지로 변환되면서 소실되는 경우는 있을 것입니다. 그렇지만 그러한 경우는 매우 제한적이며 그동안 KLDP에서는 하나의 소스로부터 여러가지 포맷의 자료를 얻을 수 있다는 장점을 주로 차용한 것이지, docbook의 수많은 태그들을 그때그때 골라 쓰는 부분에 대해서는 특별히 강조하지 않고 장/절 구분 등의 문서 내용 구분에 관련된 태그들을 골라 예제로 제공해 왔기 때문에 기존의 docbook문서에서 사용된 태그의 수는 많지 않습니다.

이렇게 될 경우 최종 사용자에게 전달되는 파일 포맷이 docbook xml 하나로 통일된다는 장점이 있습니다. docbook sgml의 경우만 해도 여러 다양한 버전들이 존재하고 버전간에 서로 호환되지 않는 태그들도 있기 때문에 최종사용자에게 전달되는 파일 포맷을 하나로 통일한다는 것은 큰 장점입니다.

그리고 새로운 문서의 경우는 위키텍스트 이외에 docbook, linuxdoc을 직접 올리는 것에 대해서는 허용은 할 수 있겠으나 실제로 그렇게 해서 문서를 올리는 이의 수는 많지 않을 것이라 예상되므로 유명무실한 규정이 될 가능성이 큽니다. linuxdoc은 이미 오래된 포맷이고 docbook의 경우도 익숙한 사람이 많지 않습니다.

지금 가장 중요한 것은 docbook이냐 아니냐, docbook을 얼마나 잘 사용하느냐 아니냐가 아니라 어떻게 하면 좀더 많은 사람들이 최소의 시간 안에 쉽게 문서화 프로젝트에 동참할 수 있게 하느냐입니다. 그리고 그렇게 하기 위해서는 참여 방법을 단순화하고 작업 흐름 역시 최대한 단순하고 명쾌하게 정의할 필요가 있습니다. -- 권순선

linuxdoc은 더 이상 받지 않는 것으로 하고, 새로 들어오는 문서도 docbook xml 혹은 위키 문서로 하는 게 좋겠습니다. --WkPark

위키문서 변환 시점

LinuxdocSgml/Alpha164-KLDP 이 자작 문서는 위키문서로 옮길 수 있을 것 같군요.
위키문서로 바꿀 경우 페이지 이름도 바꾸어 줘야 하지 않나요? 그렇지 않으면 jade나 linuxdoc 플러그인이 동작하게 될테니까요.
페이지 이름이 LinuxdocSgml로 시작되는 문서면(LinuxdocSgml 하위 페이지라면) linuxdoc 문서로 가정됩니다.

적절한 매크로를 앞뒤에 삽입해서 그냥 위키문서라고 선언하고 바꾸는 방법이 있을 것 같은데 일단 기존 문서를 수동으로 위키텍스트로 변환하는 것은 잠시 중지하는 것이 좋을 것 같습니다. 이유는

  1. 기존 문서들 중 상당수가 내용이 오래된 경우가 많아 내용변화 없이 겉모양만 위키텍스트로 바뀌는 것은 실제로 큰 장점이 없고
  2. 기존 docbook, linuxdoc 문서들을 위키텍스트로 바꾸는 것은 툴을 개발해서 일괄적으로 바꾸는 것이 낫다

    고 생각하기 때문입니다. 지금 일부 문서들을 수동으로 바꾸는 것은 분명 좋은 일이긴 하지만 위키나 linuxdoc, docbook에 익숙하지 않은 일반 사용자의 입장에서는 상당히 혼란스럽게 될 여지가 있을 것 같습니다. 따라서 문서 관리 형태가 완전히 결정되기 전까지는 변환보다는 분류 작업에 치중하는 것이 좋을 것 같습니다. -- 권순선

수동으로 바꾸어도 될 만한 짧은 문서가 많은 것 같습니다. 자작문서가 아닌 번역 문서중에 짧은 문서를 골라서 키문서로 바꾸는 것은 어떨지요 ?

docbook dsssl문서를 보면 dsssl언어를 알면 비교적 쉽게(?) 위키문서로 변환할 수 있을 듯 합니다만, 툴을 개발하는 것은 당장에 될 일은 아닐 것입니다. 현재 대부분의 문서는 낡은 문서로 생각되는데, 위키 문서로 바꾸는 비용이 적은 것들을 선택적으로 골라서 하나 둘 씩 위키문서로 옮기는 것은 어떨까요 ?
내용 자체가 이미 오래되어 버린 문서는 위키텍스트로 바꾸어도 특별히 플러스가 될만한 부분이 없어 보입니다. 일단 문서를 변환하는 것은 당장 급한게 아니니 잠시 접어두고 분류를 먼저 마무리지은 후에 변환 작업에 대해 논하는게 편리할 것 같습니다. -- 권순선

Extracted to 분류작업토론

공동 작업 문서와 자작문서의 차이점

LinuxdocSgml/Basic-KLDP와 같은 글은 독특한 문체로 인하여 공동작업으로 고칠만한 특성을 가진 글이 아닌 것 같습니다. 이런 류의 글은 변환하지 않고 토씨만 고치거나 하여 포맷을 그대로 두는 것이 낫겠습니다.

DocBook문서는 기본적으로 최초 글쓴이가 명시되고, 위키문서와 같은 공동 작업 문서의 특징보다는 개인의 아티클적 특징이 눈에 띄게 보입니다. KLDPDoc의 공동 작업문서에 관한 어떤 가이드가 있었으면 좋겠습니다. --WkPark
맞습니다. 어떤 성격의 글, 어떤 내용의 글을 어떤 형식으로 올릴 것인가에 대한 개략적인 가이드라인이 필요합니다. 참여하는 방법란에 페이지를 추가하도록 하겠습니다. -- 권순선

See also



sponsored by andamiro
sponsored by cdnetworks
sponsored by HP

Valid XHTML 1.0! Valid CSS! powered by MoniWiki
last modified 2003-10-15 14:57:54
Processing time 0.0054 sec