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 태그를 추가해서 콘텐츠 분류를 정확히 하라.