티스토리 뷰

IT 일반

Trac 위키 사용팁

야라바 2019. 3. 7. 09:47


지난 포스팅에서는 Trac의 위키 페이지를 수정하거나 새로운 위키 페이지를 생성하는 방법을 다루었습니다. 이번 포스팅에서는 위키를 사용하면서 알아두면 편리한 팁과 자주사용하는 기능들을 정리해 볼까 합니다.


아래의 링크들은 윈도우 시스템에서 Trac과 서브버전(Subversion)을 기반으로한 협업 개발 시스템 관련 글을 읽을때 참고할 만한 시스템 설치와 기본 운영에 관련한 글입니다.





■ 홈으로 이동하기



Trac 페이지에서 위키 첫문서로 이동하는 방법은 상단 메뉴 탭에 있는 "위키"를 클릭하거나 위키 탭 상태에서 상단에 있는 "시작 페이지"링크를 클릭하면 어떤 위키 페이지에서도 바로 홈으로 이동할 수 있습니다. 위키피디아의 기반 패키지인 미디어위키에서는 이 시작 페이지를 "대문"이라고 부르기도 한다. 물론, 별도로 작성한 위키 페이지에서 "[wiki:WikiStart 홈으로이동하기]"와 같은 형태로 직접 링크를 만들어 두는 것도 한가지 방법 입니다. Trac의 시작 페이지의 이름은 "WikiStart" 입니다.


■ 모든 위키 페이지 리스트하기


현재 프로젝트에서 작성한 모든 위키 페이지를 확인해 보는 방법은 위키 탭 상태에서 상단의 "페이지 색인" 링크를 클릭하면 됩니다.



위키 페이지에서 "페이지 색인"을 클릭하면 기본 출력 형식은 위키 페이지들의 제목순으로 현재 프로젝트에 포함되어 있는 페이지에는 어떤 것들이 있는지 확인할 수 있고, "Index by date"를 클릭하면 위의 그림과 같이 최근에 변경된 순서로 각 페이지들을 리스팅 할 수 있습니다. 그런데, 수정한 페이지라고는 시작페이지(Wikistart) 뿐이고, 추가한 페이지는 기본설계서 뿐인데, 언급한 2개 페이지 외에도 다른 여러가지 페이지들을 확인할 수 있습니다.


여러 위키 페이지들은 프로젝트를 생성하면 자동적으로 만들어지는 시스템 위키 페이지로, 위키 페이지를 작성하다가 사용법을 확인하거나 특정 기능을 수행하는 페이지들입니다. 페이지 소스를 확인해서 매시업하거나 나름의 페이지로 재구성 할 수도 있습니다. 주요 페이지들에 대한 설명은 다음과 같습니다.


    • WikiStart
      시작 페이지

    • PageTemplates
      새로운 페이지 작성시 활용할 수 있는 기본 양식을 등록 관리할 수 있는 페이지

    • RecentChanges
      최근에 변경된 페이지들을 리스팅 합니다.  "Index by date"를 클릭하면 나오는 페이지

    • SandBox
      위키 사용법이 익숙치 않는 사용자가 마음껏 연습해 볼 수 있는 페이지

    • TitleIndex
      위키 "페이지 색인"을 클릭하면 나오는 페이지

    • TracTickets
      Trac의 티켓 시스템(이슈트래커)에 대한 시스템 구조와 설명

    • TracTimeline
      Trac의 타임라인에 대한 설명

    • TracRoadmap
      Trac의  Roadmap 및 마일스톤 관리에 대한 설명

    • WikiProcessors
      문서 내에 HTML코드를 넣거나, C/C++, PHP, ASP, SQL등의 코드를 자동으로 문법 구분해서 표시해주는 방법 설명

    • WikiFormatting
      위키 문법에 대한 설명과 예시. 티켓(이슈), 위키, 소스코드 커밋 메시지등에 모두 이 문법이 적용 됩니다.



■ 문서 내용의 변동 내역 확인하기


하나의 문서를 협업하여 여러 사람이 수정할 수 있으므로 페이지(문서)의 버전별로 누가, 언제, 어떻게 변경했는지, 그리고 예전 페이지와 시간이 한참 지난 현재 페이지의 내용을 비교해 보는 방법을 위키 문서들은 기본적으로 제공 합니다. 아래의 그림은 테스트 프로젝트의 시작 페이지에 일부 내용을 추가한 내용인데, 이 시작 페이지가 어떻게 변경되어 왔는지 확인하고 싶다면 현재 보고 있는 페이지 상단에 있는 "이력" 링크를 클릭하면 됩니다.



위의 그림에 있는 변경 기록을 보면, 프로젝트 생성시점에 시스템이(trac 사용자) 시작 페이지(WikiStart)를 생성했고 이후에 admin 사용자의 변경이 있었음을 확인할 수 있습니다. 이 상황에서 마지막에 바뀐 내용을 알고 싶다면 Radio 버튼을 버전 2와 1에 두고 "변경사항 보기"를 클릭하면 됩니다. 그 결과는 아래와 같습니다.



범례를 통해서도 확인할 수 있지만 적색으로 표시된 부분은 버전1에서 있었지만 현재 버전에서는 삭제된 라인이고, 녹색으로 표시된 부분이 대신 추가된 부분임을 확인할 수 있습니다. 이상태에서 V1이나 V2로 표시된 링크를 클릭하면 해단 버전의 문서를 그대로 확인할 수 있습니다.


여러 사람이 협업으로 문서를 작성할 때는 적절하게 나누어서 분업하는 것도 중요하지만, 특정 문서의 변경 내역과 변경자를 파악하여 어떤 의도로 문서를 수정했는지 알 수 있다면 보다 효과적이고 효율적인 협업 문서화가 가능할 것입니다. 문서를 변경하면서 사유를 적거나 연관 티켓을 메모해 놓으면 다른 팀원들과 정보 공유에도 도움이 되므로 적극 활용할 필요가 있습니다.


워드나 한글과 같은 특정 워드 프로세서에 제약을 받지 않는 문서화 작업, 기록이 남고 버전이 관리되는 문서화 작업, 작업 내용을 다양한 형태로 응용할 수 있는 문서화 작업, 문서와 코드, 문서와 이슈 트래커가 연동되는 살아있는 문서화 작업을 기대해 볼 수 있습니다.




댓글
댓글쓰기 폼