====== 위키 문서 작성 규칙 ======

문서/이미지등을 만들 때 아래 규칙을 따르지 않으면 엄청 꼬인다. 

===== 1) 상대경로 쓰지 말고, 반드시 절대경로로 작성 ===== 

상대경로는 “현재 위치 기준으로 찾아가라”는 뜻이라서, 문서 위치가 바뀌면 링크가 쉽게 깨집니다.
따라서 링크는 항상 루트부터 전체 경로를 명확히 적어야 합니다.

  * 상대경로(금지): <nowiki> [[.:read]]</nowiki>
  * 절대경로(필수): <nowiki>''[[:modport:read]]'' </nowiki>
  * 루트에 위치하는 경로(금지): <nowiki> [[read]]</nowiki> 아무생각없이 맨앞에 아무것도 안쓰면 이건 루트에 위치함. 조심할것.


루트에 쓸꺼면 맨 앞의 콜론(:)을 꼭 붙이는 습관을 들여야한다.


===== 2) 파일명/경로명에 한글 사용 금지 (영문만 사용) ===== 

한글 파일명은 내부적으로 %EB%8B%A4%EC%88%98... 같은 형태로 바뀌어 사람이 알아보기 어렵고, 백업/전송 과정에서 파일명이 길어져 전송 실패가 발생하기도 합니다. 따라서 파일명과 경로명은 반드시 영문으로 작성합니다.

  * 잘못된 예: 셋업화면.png
  * 올바른 예: setupscreen.png

또한, 링크를 만들 때도 “한글 경로”가 생기지 않도록 주의해야 합니다.

  * 잘못된 예(한글 경로 생성): <nowiki>[[.:비트읽기:|비트 읽기 (bit read) RELAY 상태 읽기 패킷]] </nowiki> <-- 비트읽기라는 한글 경로명이 생성됨.
  * 올바른 예(절대경로 + 영문 경로): <nowiki>[[:modport:bitread:|비트 읽기 (bit read) RELAY 상태 읽기 패킷]]</nowiki>



===== 3) 다른 곳의 이미지를 직접 참조하지 말 것 (교차 참조 금지) ===== 

다른 네임스페이스(다른 폴더)에 있는 이미지를 그대로 끌어다 쓰면, 원본 문서를 삭제하거나 이동할 때 해당 이미지를 쓰던 다른 문서들이 같이 깨질 수 있습니다. 따라서 다른 곳의 이미지를 쓰고 싶다면, 이미지를 다운로드한 뒤 현재 문서 폴더에 재 업로드해서 사용합니다.

===== 4) 이미지는 텍스트(문서)와 같은 이름폴더에 저장 ===== 

원칙: 자기 문서에 쓰는 이미지는 자기 폴더 안에만 둔다.
다른 폴더로 “시집보내지 말 것”. 위에 언급한것과 같은 얘기임



===== 5) 문서 맨 아래에 “상위 네임스페이스로 이동” 링크 1개 추가 ===== 

문서를 다 읽고 나서 바로 윗단계로 돌아갈 수 있도록, 맨 아래에 상위 네임스페이스로 가는 링크를 하나 넣어둡니다.
이렇게 하면 사용자가 읽은 뒤에 즉시 전 단계로 점프할 수 있어 훨씬 편해집니다. 그리고 문서가 끝났다는 [The End]라는 표식도 됩니다.

<nowiki>[[:index|Comfile Technology's Document Library]]</nowiki>


===== 요약 ===== 

  - 링크는 절대경로만 사용
  - 경로/파일명은 영문만 사용 (한글 금지)
  - 이미지는 교차 참조하지 말고 현재 폴더에 복사해서 사용
  - 이미지는 문서와 같은 이름 폴더에 저장
  - 맨 아래에 상위로 가는 링크 1개 추가

[[syntax|도큐위키 사용법]]