내 작은 왕국 기획 위키

읽는 법

이 문서 안에서

이 폴더는 마크다운 파일 마흔두 개가 아니라 서로를 가리키는 문서망 하나입니다. 이 문서가 그 문서망을 읽고 고치는 규칙입니다. 처음 오셨다면 왕국 개요부터 읽고 돌아오세요.

한 줄 요약 — 문서의 가치는 길이가 아니라 링크에 있습니다. 들어오는 링크가 없는 문서는 없는 문서입니다.

1. 무엇으로 읽는가

읽는 도구는 옵시디언이 아니라 작업대 앱(../eunhasu)의 「기획」탭입니다. 문법은 옵시디언과 비슷하지만 파서가 다릅니다. 문서를 열면 본문 옆에 목록 네 개가 섭니다.

무엇어디서 오는가
이 문서를 가리키는 곳 (백링크)이 문서를 [[ ]] 로 가리키는 문서들
이 문서가 가리키는 곳이 문서가 [[ ]] 나 상대 경로로 가리키는 문서들
이름만 적힌 곳이름을 적어 두고 링크는 걸지 않은 문서들 — 후보입니다. 한국어는 낱말 사이 틈이 없어 제작소가 제작의 언급으로 잡히기도 합니다
데이터에서 가져온 값이 문서의 {{ }} 중 풀리지 않은 것

첫째가 핵심입니다. 문서를 고칠 때 알아야 하는 것은 그 문서가 무엇을 가리키는지가 아니라 무엇이 그 문서를 믿고 있는지입니다. 구현 상태에 들어오는 링크가 마흔 개인 이유도 그것입니다.

앞의 두 목록은 닿지 않는 링크를 세지 않습니다. 아직 쓰지 않은 문서를 [[ ]] 로 적어 두면 관계로 잡히지 않고, 이름을 잘못 적은 링크도 조용히 빠집니다. 그것을 찾는 자리는 아래 §6 입니다.

머리의 관계 그림은 폴더 전체를 점과 선으로 그립니다. 점 하나가 문서 하나, 크기는 들어오는 링크 수, 자리는 폴더가 정합니다. 문서 점검은 §6과 같은 것을 창 안에서 합니다.

2. 쓸 수 있는 문법 — 이것이 전부입니다

파서는 ../eunhasu/src/shared/markdown.ts 하나이고 라이브러리를 쓰지 않습니다. 아래에 없는 문법은 조용히 사라지지 않고 글자 그대로 화면에 나옵니다.

문법비고
# ~ ###### 제목6단계까지
문단빈 줄로 나눕니다. 연달아 쓴 줄은 공백 하나로 이어 붙습니다
- 항목 / 1. 항목한 겹만. 들여쓴 다음 줄은 그 항목에 이어 붙습니다
> 인용한 줄에 상자 하나
코드 울타리안쪽은 문법을 보지 않습니다
표헤더 줄과 |---| 구분 줄이 반드시 함께
--- 가로줄
**굵게** *기울임* _기울임_ ` 코드 `
[글자](경로)상대 경로 링크
[[문서명]] [[문서명|보이는 글자]]위키링크
{{파일#칸}}값 바인딩. 수치를 베껴 적는 대신 그 수치가 사는 자리를 적으면 앱이 읽어서 채웁니다
{{파일#칸|percent}}분수를 백분율로. 0.07 → 7
{{파일#칸|text}}값이 그림을 가리켜도 경로 글자로. 에셋 점검표에서 쓰는 쪽
{{파일#칸}} (값이 그림)그림이 섭니다. 그림 옆에 같은 이름의 .json이 portrait를 적어 두면 그 칸만 오립니다
{{오브젝트#sprite.image|frame=idle}}아틀라스에서 그 오브젝트가 쓰는 칸만. 칸은 animations.idle.frames가, 한 줄의 칸 수는 그림의 폭이 말합니다
쓰면 안 되는 것화면에서 벌어지는 일
중첩 목록들여쓴 항목이 위 항목과 같은 층으로 평평해집니다
이미지 ![설명](경로)! 가 글자로 남고 나머지가 링크 버튼이 됩니다
HTML 태그 · 취소선 ~~글자~~글자 그대로 나옵니다
체크박스 - [ ]대괄호가 링크로 읽힙니다
YAML 앞머리--- 가 가로줄이 되고 그 사이가 문단으로 나옵니다
각주 [^1]지원하지 않습니다
docs/ 밖을 가리키는 상대 링크닿지 않는 죽은 버튼이 됩니다

마지막 줄에 자주 걸립니다. 소스 파일은 링크 대신 인라인 코드로 쓰세요 — src/game/gather.ts 처럼요. 계층이 필요하면 중첩 목록 대신 표나 하위 제목을 씁니다.

그림은 경로를 적어 넣지 않습니다. ![](…)는 위 표대로 깨지고, 설령 된다 해도 그것은 이 문서가 에셋 경로를 한 벌 더 갖는 일입니다 — 파일이 옮겨 가면 조용히 죽습니다. 대신 그 그림을 가리키는 데이터를 적으면 그림이 섭니다:

| {{apple-pie#sprite.image|frame=idle}} | 애플 파이 |
| {{assets/sprites/characters/farmer-1.json#png}} | 농부 |
| {{data/battle-backgrounds.json#slime-cave.image}} | 슬라임 굴 |

세 줄이 다 같은 규칙입니다: 문서는 어느 데이터의 어느 칸인지만 말하고, 경로도 잘라 낼 칸도 그 데이터가 답합니다. 아틀라스 한 장에 아이템 일흔다섯 개가 들어 있어도 |frame=이 그 하나를 고릅니다.

3. 링크 거는 법

4. 모든 문서의 뼈대

# 문서 이름 (파일명과 같게)

한 문단. 이 문서가 무엇을 정하는 문서인지. 링크를 여기서부터 겁니다.

> 한 줄 요약

## (본문 절들)

## 코드에 있는 자리

| 무엇 | 파일 |
|---|---|

## 이어서 읽기

- [[문서A]] — 왜 이어서 읽는지 한 줄

「코드에 있는 자리」는 모든 문서에 들어갑니다. 기획서가 코드에서 멀어지는 것을 막는 유일한 장치입니다. 줄번호는 적지 않습니다 — 금방 썩습니다. 파일 경로와, 꼭 필요하면 함수 이름까지가 적당합니다.

5. 고칠 때의 원칙

코드가 사실입니다. 문서와 코드가 어긋나면 코드대로 서술하고, 어긋났다는 사실을 구현 상태에 올린 뒤 그리로 링크하세요.

구현되지 않은 설계라고 지우지는 마세요. "설계안 — 아직 구현되지 않음"으로 표시해 남기고 구현 상태에 올립니다. 농사·가공·상점 설계가 그렇게 살아 있습니다(데이터 파일 규격, 제작).

코드에서 복원할 수 없는 지식을 가장 조심하세요. 스토어 콘솔의 클릭 절차, 과거에 무엇이 왜 실패했는지, 외부에 제출한 문안, 키를 어디서 발급받는지 — 소스를 아무리 읽어도 나오지 않습니다. 스토어 등록, 플랫폼과 네이티브 서비스, 푸시와 알림, 사전등록 이벤트 이 네 편은 특히 함부로 줄이면 안 됩니다.

수치는 코드값 그대로 적고, 계산해서 얻은 값은 계산값이라고 밝히세요. 용어는 용어집을 먼저 봅니다. 같은 것을 두 이름으로 부르면 검색이 무너지고 [[ ]] 도 조용히 안 붙기 시작합니다.

새 문서를 하나 만들 때는 이름이 유일한지 확인하고, 다섯 폴더 중 어디에 들어갈지 정하고, 왕국 개요의 「문서 지도」에 한 줄을 더하고, 그 내용을 이미 다루던 문서에서 덜어 내 그 자리에 링크를 남기고, 최소 두 편에서 새 문서를 가리키게 합니다.

6. 검사하는 법

작업대 앱의 파서로 이 폴더를 그대로 읽어 보는 검사기가 있습니다. 끊긴 링크, 이름 겹침, 아무도 가리키지 않는 문서, 앱이 못 그리는 문법을 찾아 줍니다. 「기획」탭의 문서 점검 단추를 눌러도 되고 명령으로 돌려도 됩니다. 판단하는 코드가 한 곳이라 둘은 같은 답을 냅니다.

끝값은 끊긴 링크와 겹친 이름에만 1입니다. 고아 문서와 문법은 세어서 보여만 줍니다. 전부에 1을 받으려면 --strict, 「이름만 적힌 곳」까지 훑으려면 --mentions 를 붙입니다.

문서 이름을 바꿨을 때는 반드시 돌리세요. [[ ]] 는 이름으로 붙기 때문에 이름 하나를 바꾸면 그 문서를 가리키던 모든 링크가 조용히 죽습니다.

이어서 읽기

이 문서를 가리키는 곳