|
⇤ ← Revision 1 as of 2025-07-24 13:50:54
Size: 4942
Comment:
|
← Revision 2 as of 2025-07-24 15:49:49 ⇥
Size: 5393
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| MoinMoin wiki 콘텐츠 생성과 관리를 위한 가이드라인과 도구들. | MoinMoin wiki 작성을 위한 가이드 및 모범 사례입니다. |
| Line 11: | Line 11: |
| '''MoinMoin Wiki Markup''' - 마크다운이 아닌 MoinMoin wiki 마크업 구문을 사용하라: | '''MoinMoin Wiki Markup''' - 마크다운이 아닌 MoinMoin wiki 마크업 문법을 사용하라: |
| Line 18: | Line 18: |
| '''Local First, Then Upload''' - 먼저 로컬 파일에서 콘텐츠를 생성하고 편집하라. wiki 서버에 업로드하기 전에 로컬에서 검토하고 개선하라. `cat filename.txt | moin put PageName`을 사용해서 콘텐츠를 업로드하라. | '''Local First, Then Upload''' - 항상 로컬 파일에서 작성하고 검토하라. wiki 서버에 업로드하기 전에 로컬에서 완성하고 검토하라. `cat filename.txt | moin put PageName`을 사용해서 작성물을 업로드하라. |
| Line 20: | Line 20: |
| '''Follow Wiki Conventions''' - 기존 페이지 명명 규칙을 사용하라 (CamelCase 또는 관찰된 특정 패턴들). `[[PageName]]`을 사용해서 기존 관련 페이지들을 참조하라. 향후 콘텐츠를 계획할 때 존재하지 않는 페이지들에 링크하라. 기존 wiki 콘텐츠와 일관된 구조를 유지하라. | '''Follow Wiki Conventions''' - 해당 위키의 명명 규칙을 따르라 (CamelCase 또는 특정한 특수 패턴들). `[[PageName]]`을 사용해서 다른 페이지 참조들로 연결하라. 향후 작성할지 계획하지 않은 페이지들에 링크하라. 기존 wiki 페이지들과 일관되게 패턴을 유지하라. |
| Line 22: | Line 22: |
| '''Content Organization''' - 구조적 패턴을 위해 기존 페이지들을 연구하라. 적절한 분류를 사용하라 (예: `CategoryPattern`, `CategoryBook`). 관련 개념과 페이지들을 상호 참조하라. 논리적 계층과 관계를 유지하라. | '''Content Organization''' - 내용을 논리적 순서로 배치 페이지들로 구성하라. 카테고리 분류를 사용하라 (예: `CategoryPattern`, `CategoryBook`). 관련 페이지들 간에 상호참조를 적극 활용하라. 페이지의 목적과 범위를 명확히 하라. |
| Line 28: | Line 28: |
| moin auth # 초기 설정과 인증 | moin auth # 초기 인증과 설정 |
| Line 31: | Line 31: |
| moin get PageName # 페이지 콘텐츠 다운로드 moin put PageName file.txt # 파일에서 콘텐츠 업로드 cat file.txt | moin put PageName # stdin에서 콘텐츠 업로드 (권장) |
moin get PageName # 페이지 내용을 다운로드 moin put PageName file.txt # 파일에서 페이지로 업로드 cat file.txt | moin put PageName # stdin에서 페이지로 업로드 (권장) |
| Line 36: | Line 36: |
| moin recent N # 지난 N일 동안 변경된 페이지 표시 | moin recent N # 최근 N개 변경 사항의 페이지들 표시 |
| Line 41: | Line 41: |
| '''Research''' - `moin list`와 `moin search`를 사용해서 기존 콘텐츠를 이해하라. | '''Research''' - `moin list`와 `moin search`를 사용해서 기존 콘텐츠를 조사하라. |
| Line 43: | Line 43: |
| '''Draft''' - MoinMoin 마크업으로 로컬 파일을 생성하라. | '''Draft''' - MoinMoin 마크업으로 로컬 파일을 작성하라. |
| Line 45: | Line 45: |
| '''Review''' - 로컬에서 마크업과 콘텐츠 구조를 검증하라. | '''Review''' - 로컬에서 마크업과 내용을 철저히 검토하라. |
| Line 49: | Line 49: |
| '''Verify''' - wiki 서버에서 게시된 콘텐츠를 확인하라. | '''Verify''' - wiki 서버에서 게시된 내용물을 확인하라. |
| Line 72: | Line 72: |
| '''중요:''' MoinMoin에서는 불릿 포인트에 `*`만 사용하고, `-`는 사용하지 않는다. 반드시 앞에 공백을 넣어야 한다. | '''중요:''' MoinMoin에서 리스트는 앞에 공백이 필요하다. `-`는 작동하지 않는다. |
| Line 75: | Line 75: |
| * Bullet list item | * Bullet list item (공백 + *) |
| Line 77: | Line 77: |
| * Nested item (더 많은 공백으로 중첩) | * Nested item (두 개의 공백으로 중첩) |
| Line 79: | Line 79: |
| 1. Numbered list | 1. Numbered list (공백 + 1.) |
| Line 82: | Line 82: |
- 이건 작동하지 않음 (공백 + -) }}} === Definition Lists === 용어와 정의를 위한 정의 목록: {{{ term:: definition another term:: another definition multi-line term:: :: line 1 of definition :: line 2 of definition :: line 3 of definition |
|
| Line 111: | Line 126: |
| '''Broken Bullet Points''' - `-` 대신 `*` 사용해야 함. 공백 없이 시작하면 렌더링되지 않음. | '''Broken Bullet Points''' - `-` 말고 `*` 써야 함. 앞에 공백 빠뜨리면 렌더링이 깨짐. |
| Line 122: | Line 137: |
| '''WikiLinks in Headings''' - 헤딩 안에 wikilink를 넣으면 제대로 렌더링되지 않음. | '''Missing Leading Spaces''' - 모든 리스트 항목은 앞에 공백이 필요함. {{{ # 잘못된 예 * No space 1. No space # 올바른 예 * With space 1. With space }}} '''WikiLinks in Headings''' - 제목 안에 wikilink를 넣으면 제목이 렌더링이 깨짐. |
| Line 129: | Line 155: |
| [[SomePage]] - 관련 페이지 설명 | [[SomePage]] - 관련 페이지로 링크 |
| Line 132: | Line 158: |
| '''Code Block Syntax''' - 마크다운 스타일 ` ``` `가 아닌 `{{{ }}}`를 사용해야 함. | '''Code Block Syntax''' - 마크다운 스타일 ` ``` `이 아닌 `{{{ }}}`를 써야 함. |
| Line 136: | Line 162: |
| '''Story-First Approach''' - 이솝우화처럼 기억에 남는 이야기 구조를 사용하라. 불릿 포인트보다는 자연스러운 문단을 활용하라. 은유와 구체적 캐릭터를 통해 추상적 개념을 설명하라. | '''Story-First Approach''' - 리스딩화처럼 독자에 중심 이야기 구조로 작성하라. 총알 리스트보다는 자연스러운 흐름을 활용하라. 독자의 전체적 캐릭터를 중심 중심으로 내용을 구성하라. |
| Line 138: | Line 164: |
| '''Educational Focus''' - 초보자들이 이해하고 적용할 수 있도록 풍부한 설명, 예시, 은유, 우화를 포함하라. 단순한 규칙이 아닌 왜 그런지에 대한 통찰을 제공하라. | '''Educational Focus''' - 초보자들이 이해하고 따라할 수 있도록 풍부한 맥락, 예시, 배경, 설화를 제공하라. 단순한 규칙이 아닌 왜 그렇게까지 하는 이유를 설명하라. |
| Line 144: | Line 170: |
| '''Regular Syntax Check''' - 새 페이지를 만들 때마다 기본 마크업이 제대로 렌더링되는지 확인하라. | '''Regular Syntax Check''' - 각 페이지에서 모든 마크업 기본 문법이 올바로 렌더링되는지 확인하라. |
| Line 146: | Line 172: |
| '''Link Validation''' - 내부 링크들이 올바르게 작동하는지 주기적으로 점검하라. | '''Link Validation''' - 내부 링크들이 올바르게 작동하는지 주기적으로 검증하라. |
| Line 148: | Line 174: |
| '''Category Management''' - 적절한 CategoryXXX 태그를 추가해서 페이지 분류를 명확히 하라. | '''Category Management''' - 페이지에 CategoryXXX 태그를 추가해서 콘텐츠 분류를 정확히 하라. |
AiGarden/WikiAuthoring
MoinMoin wiki 작성을 위한 가이드 및 모범 사례입니다.
Contents
Core Principles
MoinMoin Wiki Markup - 마크다운이 아닌 MoinMoin wiki 마크업 문법을 사용하라:
= Heading 1 =
== Heading 2 ==
'''bold'''와 ''italic''
내부 링크는 [[PageName]]
외부 링크는 [http://example.com Link Text]
Local First, Then Upload - 항상 로컬 파일에서 작성하고 검토하라. wiki 서버에 업로드하기 전에 로컬에서 완성하고 검토하라. cat filename.txt | moin put PageName을 사용해서 작성물을 업로드하라.
Follow Wiki Conventions - 해당 위키의 명명 규칙을 따르라 (CamelCase 또는 특정한 특수 패턴들). [[PageName]]을 사용해서 다른 페이지 참조들로 연결하라. 향후 작성할지 계획하지 않은 페이지들에 링크하라. 기존 wiki 페이지들과 일관되게 패턴을 유지하라.
Content Organization - 내용을 논리적 순서로 배치 페이지들로 구성하라. 카테고리 분류를 사용하라 (예: CategoryPattern, CategoryBook). 관련 페이지들 간에 상호참조를 적극 활용하라. 페이지의 목적과 범위를 명확히 하라.
Available Commands
# 인증과 설정 moin auth # 초기 인증과 설정 # 콘텐츠 작업 moin get PageName # 페이지 내용을 다운로드 moin put PageName file.txt # 파일에서 페이지로 업로드 cat file.txt | moin put PageName # stdin에서 페이지로 업로드 (권장) moin list # 모든 페이지 목록 moin search "query" # 페이지 검색 moin recent N # 최근 N개 변경 사항의 페이지들 표시
Workflow
Research - moin list와 moin search를 사용해서 기존 콘텐츠를 조사하라.
Draft - MoinMoin 마크업으로 로컬 파일을 작성하라.
Review - 로컬에서 마크업과 내용을 철저히 검토하라.
Upload - cat file.txt | moin put PageName을 사용해서 wiki 서버에 게시하라.
Verify - wiki 서버에서 게시된 내용물을 확인하라.
MoinMoin Markup Reference
Basic Formatting
= Main Heading = == Sub Heading == === Sub-sub Heading === '''Bold text''' ''Italic text'' `Monospace text`
Links
[[InternalPageLink]] [[PageName|Display Text]] [http://example.com External Link]
Lists
중요: MoinMoin에서 리스트는 앞에 공백이 필요하다. -는 작동하지 않는다.
* Bullet list item (공백 + *) * Another item * Nested item (두 개의 공백으로 중첩) 1. Numbered list (공백 + 1.) 2. Another item 1. Nested numbered item - 이건 작동하지 않음 (공백 + -)
Definition Lists
용어와 정의를 위한 정의 목록:
term:: definition another term:: another definition multi-line term:: :: line 1 of definition :: line 2 of definition :: line 3 of definition
Code and Preformatted Text
Inline `code` with backticks
{{{
Code block or preformatted text
Multiple lines supported}}}
Tables
||Cell 1||Cell 2|| ||Cell 3||Cell 4||
Other Elements
---- (horizontal rule) <<TableOfContents(2)>> (table of contents, depth 2)
Common Mistakes
Broken Bullet Points - - 말고 * 써야 함. 앞에 공백 빠뜨리면 렌더링이 깨짐.
# 잘못된 예 - Item 1 * Item 2 (공백 없음) # 올바른 예 * Item 1 * Item 2
Missing Leading Spaces - 모든 리스트 항목은 앞에 공백이 필요함.
# 잘못된 예 * No space 1. No space # 올바른 예 * With space 1. With space
WikiLinks in Headings - 제목 안에 wikilink를 넣으면 제목이 렌더링이 깨짐.
# 잘못된 예 == [[SomePage]] == # 올바른 예 == Some Topic == [[SomePage]] - 관련 페이지로 링크
Code Block Syntax - 마크다운 스타일 이 아닌 `를 써야 함.
Style Guidelines
Story-First Approach - 리스딩화처럼 독자에 중심 이야기 구조로 작성하라. 총알 리스트보다는 자연스러운 흐름을 활용하라. 독자의 전체적 캐릭터를 중심 중심으로 내용을 구성하라.
Educational Focus - 초보자들이 이해하고 따라할 수 있도록 풍부한 맥락, 예시, 배경, 설화를 제공하라. 단순한 규칙이 아닌 왜 그렇게까지 하는 이유를 설명하라.
Pattern Connections - 각 페이지가 다른 페이지들과 의미있게 연결되도록 하라. Related Patterns, See Also 섹션을 활용해서 지식 네트워크를 구축하라.
Maintenance Tips
Regular Syntax Check - 각 페이지에서 모든 마크업 기본 문법이 올바로 렌더링되는지 확인하라.
Link Validation - 내부 링크들이 올바르게 작동하는지 주기적으로 검증하라.
Category Management - 페이지에 CategoryXXX 태그를 추가해서 콘텐츠 분류를 정확히 하라.