Naming convention in Dossier [C20]

이 문서는 읽기 전용입니다. 원본을 볼 수는 있지만 바꿀 수는 없습니다. 문제가 있다고 생각하면 관리자에게 문의하세요.
<!DOCTYPE markdown>

# Naming convention in Dossier

## 개요
[[wiki:sw:dokuwiki|DokuWiki]]는 그 특성상, [[tech:mediawiki|Mediawiki]]처럼 표제어을 곧장 링크하는 것이 불가능하며, 문서명을 링크하는 식으로 작동하게 된다[^1]. 따라서 적절한 문서명 명명에 대한 규칙을 정해놓고, 이를 따르도록 하는 것이 필요하다[^2]. 이 문서는 그 규칙을 정리한다.

## 네임스페이스
문서의 조직화를 위해, 가능한 네임스페이스 아래에 문서를 배치하는 것을 원칙으로 한다. 네임스페이스는 해당 문서가 속하는 가장 적절한 카테고리를 그 이름으로 삼는다. 현재 사용중인 네임스페이스는 다음과 같다.

- tech: 모든 기술적인 내용.
- cinema: 영화(작품)에 관련된 내용.
- text: 텍스트에 관련된 내용.
- list: 모든 종류의 목록에 관련된 내용.
- event: 행사에 관련된 내용.
- journal: 일기.
- living: 생활에 관련된 내용.
- music: 음악에 관련된 내용.
- record: 음반에 관련된 내용.


## 문서명
문서명(id)은 쉽게 검색하거나 링크걸 수 있도록 붙여야 한다. 이는 도쿠위키의 특징이자 단점 - 전통적인 위키처럼 문서 제목과 id가 일치되지 않고 분리되며, 문서명으로 링크거는 것이 불가능함 - 에 따른 불편함을 최소화하기 위함이다. 크게 두 가지 원칙을 따른다.

1. 문서 제목은 원어로 작성한다.
    1) 원어 제목을 한글로 통칭하는 역제가 있다면, 제목에는 작성하지 않는 대신 본문 내에 이를 반영하여 검색이 용이하도록 한다.
2. 문서의 id는 문서명을 반영하여 알파벳으로 기재하되, 원어를 최대한 반영한다.
    1) 영어로 된 제목은 영어로 기재한다.
    2) 프랑스어 등 액센트가 포함된 제목의 경우 대응하는 기본 알파벳을 사용한다.
    3) 도쿠위키는 띄어쓰기를 밑줄로 변환하므로 id에 사용하지 않는 것도 장점이 있지만, 문서명이 길다면 너무 난잡해지기 때문에 원어와 동일하게 띄어쓰기를 적용한다.
    4) 비알파벳 제목의 경우 영어를 사용하여, 원어 발음과 유사하게, 혹은 해당 언어의 로마자 표기법을 따라 id를 만든다. [Google Translate](https://translate.google.com/) 등을 활용하면 도움이 된다.

[^1]: 도쿠위키보다 미디어위키가 집단적/협업 위키에 더 적합한 결정적인 이유는 이러한 정책 때문이라고 생각한다. 굳이 문서의 hierarchy를 고민할 필요 없이 수평적으로 문서를 구성하고 링크거는 것이 가능하기 때문이다.
[^2]: 다만 [[doku>plugin:linksuggest]]를 사용하면 링크가 조금 용이하다. 그러나 이 때에도 문서명의 convention을 잘 규정해 놓아야, 문서 수와 규모가 커질 때에 대응하기가 쉬워진다.
c20/dossier/naming_conventions.txt · 마지막으로 수정됨: 2023/06/14 16:19 (바깥 편집)