You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
313 lines
16 KiB
Plaintext
313 lines
16 KiB
Plaintext
INTSourceChangelist:2601055
|
|
Availability:Docs
|
|
Title:에픽 게임스 문서 스타일 안내
|
|
Crumbs:DocumentationGuidelines
|
|
Description:언리얼 엔진 4 관련 문서 제작시의 스타일 안내입니다.
|
|
|
|
[TOC(start:2)]
|
|
|
|
## 문서 정책
|
|
|
|
### 문서 위치와 이름
|
|
|
|
문서 소스 파일은 퍼포스의 Engine/Documentation/Source 폴더에 .udn 파일로 보관됩니다. 파일명에는 문서에 쓰인 언어를 나타내는 언어 코드가 포함되어 있어야 합니다. 파일명은 그 자체로 문서의 내용에 대한 설명이 되는 것이어야 합니다.
|
|
문서는 폴더당 하나의 파일에 보관되는데, 디렉토리 경로명을 문서에 대한 식별자가 되도록 합니다. 폴더 이름을 지을 때는 직관적인 서술형이 될 수 있도록 신경을 써 주시기 바랍니다. 경로명을 이루는 폴더명의 요소가 중복되지 않도록 하세요. 실제 문서의 이름은 중복이 가능하며, 일반적으로 선호되기도 합니다.
|
|
|
|
| 좋음 | 나쁨 |
|
|
| --- | --- |
|
|
| Materials/Editor/UserGuide | Materials/MaterialEditor/MaterialEditorUserGuide |
|
|
|
|
예를 들어 **콘텐츠 브라우저 사용 안내서** 의 영어 버전 이름은 `UnrealEditorUserGuide.INT.udn` 이며, `Editor/UserGuide` 디렉토리에 보관됩니다.
|
|
|
|
같은 식으로, 제목의 중복도 가급적 피하는 것이 좋습니다. 예를 들어 **시작하기** 섹션에 **콘텐츠** 섹션이 있어, 그 안에 **머티리얼** 페이지가 포함된다 칩시다. 따로 떼어내면 그 각각의 페이지 이름은 이렇습니다:
|
|
|
|
* 언리얼 엔진 시작하기
|
|
* 콘텐츠 개발 시작하기
|
|
* 머티리얼 제작 시작하기
|
|
|
|
|
|
위의 이름 모두 완전 괜찮습니다만, 하나하나씩 보자면 중복이 생깁니다. 페이지 상단에 표시되는 이정표의 경우 위와 같이 연달아 표시된다면 특히나 문제가 될 것입니다. 글의 내용에 대한 대표성은 잘 띄면서 서로간에 비교했을 때 중복되지는 않도록 다양한 이름을 지어주는 것이 훨씬 좋을 것입니다.
|
|
|
|
### 내용 조각화
|
|
|
|
보통 한 페이지에 너무 많은 내용이 반복되는 경향이 있습니다. 그럴 때는 내용을 논리적 조각으로 떼어내어 합리적이면서 보다 읽기 쉬운 크기로 나누는 것이 좋을 것입니다.
|
|
|
|
애니메이션의 블렌드스페이스(BlendSpace) 관련 부분이 좋은 예제입니다. 블렌드스페이스 관련 모든 것들, 즉 만들고 편집하고 Vim Blueprint 안에서 사용하고 등등을 모두 하나의 페이지에 몰아넣을 수는 있으나, 이들 각각의 하위부분은 부모와 마찬가지로 일반적인 개요 페이지를 곁들여 별도의 페이지로 나누어 두는 편이 좋습니다.
|
|
|
|
* 블렌드스페이스
|
|
* 블렌드스페이스 만들기
|
|
* 블렌드스페이스 편집하기
|
|
* 블렌드스페이스 사용하기
|
|
|
|
|
|
### 정체성과 브랜드
|
|
|
|
회사, 엔진, 게임 등의 이름은 모든 문서에 일관되어야 합니다. 이에 대한 올바른 철자, 대소문자, 숫자, 구두점은 아래와 같습니다.
|
|
|
|
* Epic Games, Inc.
|
|
* Unreal Engine 3/Unreal Engine 4
|
|
* Gears of War/Gears of War 2/Gears of War 3
|
|
* Infinity Blade/Infinity Blade 2/Infinity Blade 3
|
|
* Fortnite
|
|
|
|
|
|
[REGION:note]
|
|
Unreal Engine 4 (UE4) 식으로 페이지에 정의를 내린 이후에는 (UE3/UE4/GoW/IBD 식으로) 짧은 이름을 사용합니다.
|
|
[/REGION]
|
|
|
|
### 유형
|
|
|
|
데이터 유형, 즉 클래스 이름, 애셋 유형 등에 대해 논할 때는 항상, 각 유형 정의에 일치하도록 올바른 대소문자를 사용합니다. 그렇게 하여 어떤 단어가 언리얼 엔진 내 구체적인 유형으로 쓰였는지, 아니면 보다 일반적인 용법으로 사용되었는지 혼동을 더는 데 도움이 됩니다. 또 이러한 이름들에는 이탤릭체를 사용하여 특별하다는 것을 나타냅니다.
|
|
|
|
예를 들어:
|
|
|
|
| 맞음 | 틀림 |
|
|
| ---- | ---- |
|
|
| _Actor_ | actor |
|
|
| _Material_ | material |
|
|
| _StaticMesh_ 또는 _Static Mesh_ | staticmesh 또는 static mesh |
|
|
| _ParticleSystem_ 또는 _Particle System_ | particlesystem 또는 particle system |
|
|
|
|
### UI 요소
|
|
|
|
**콘텐츠 브라우저** 나 **씬 아웃라이너** 같은 특정 유저 인터페이스 부분은 올바른 대소문자와 함께 두껍게 표시해야 합니다.
|
|
|
|
[REGION:tip]
|
|
일부 패널은 **디테일** 패널처럼 이름 뒤에 "패널"이 붙지만, 이 "패널" 부분은 대소문자나 두껍게를 적용하지 않습니다. 이에 대한 유일한 예외라면, "Panel" 이 창, 패널, 다른 인터페이스 부속의 이름 일부로 UI 에 표시될 경우입니다.
|
|
[/REGION]
|
|
|
|
| 맞음 | 틀림 |
|
|
| ---- | ---- |
|
|
| **Content Browser** | Content Browser 또는 **content browser** |
|
|
| **Scene Outliner** | Scene outliner 또는 **scene outliner**
|
|
| **Details** panel | Details panel 또는 **Details Panel** |
|
|
|
|
## 문법과 구두법
|
|
|
|
### 문장간 공백
|
|
|
|
연이은 문장 사이에는 하나의 공백만 있으면 됩니다.
|
|
|
|
### 나열시의 쉼표
|
|
|
|
쉼표로 구분되는 나열 항목들은 이전 항목 앞에 반드시 쉼표를 사용해야 합니다. 엄밀히 말하면 마지막 쉼표는 생략해도 괜찮기는 하지만, 반드시 사용하는 편이 해당 항목이 한 집합의 일부인지 아닌지 혼동의 소지를 예방하는 데 좋습니다.
|
|
|
|
| 명확 | 모호 |
|
|
| ---- | ---- |
|
|
| This, that and those, them, and the other one | This, that and those, them and the other |
|
|
|
|
## 포맷과 레이아웃
|
|
|
|
### 메타데이터
|
|
|
|
모든 문서는 다음과 같은 메타데이터를 요합니다:
|
|
|
|
* Title - 문서의 제목입니다. 브라우저의 제목줄과 1 단계 쪽 제목에 표시됩니다.
|
|
* Crumbs - 쉼표로 구분되는 이동 계층구조 경로 목록입니다. 각 문서는 Crumbs 메타데이터 항목을 몇이든 가질 수 있습니다.
|
|
* Description - 문서에 대한 간단한 요약으로, 검색 결과 문서에 표시됩니다. 메타데이터는 모든 소스 문서 상단에 키:값 짝 형태로 줄당 하나씩 보관됩니다.
|
|
|
|
|
|
### 제목 (Headings)
|
|
|
|
문서의 주요 부분은 (2 단계에서 6 단계까지의) 제목을 사용하여 기술됩니다.
|
|
|
|
제목은 항상 다른 하위제목 이전에 약간의 텍스트나 다른 내용이 따라야 합니다. 어떠한 제목에 아무런 내용도 오지 않는다면, 제거하여 재정비할 것을 고려해 보세요.
|
|
|
|
문서 내 제목 단계를 건너뛰지 마세요. 예를 들어 2 단계 제목 뒤에 4 단계 제목이 갑자기 오지 말아야 할 것입니다.
|
|
|
|
#### 쪽 제목
|
|
|
|
쪽 제목은 문서에 자동으로 삽입되며, 항상 1 단계 제목을 사용하여 기술됩니다. 이는 어느 문서든지 오직 1 단계 제목이어야 합니다. 문서 내의 부분에 대해서는 1 단계 제목을 사용하지 마시기 바랍니다.
|
|
|
|
#### 제목의 대소문자
|
|
|
|
제목의 각 단어는 (and, or 등의) 접속사나 (to, of, on 등의) 전치사 이외에는 모두 첫 글자를 대문자로 써야 합니다. 모든 제목에는 같은 대소문자 방식을 적용하며, 다양한 단계의 제목에는 적절한 스타일을 통해 구분하고 있습니다.
|
|
|
|
### 목록
|
|
|
|
목록은 순서형(ordered), 비순서형(unordered), 정의형(definition) 목록이 있습니다. 비순서형 목록은 순서가 중요치 않은 항목에 사용해야 합니다. 튜토리얼처럼 순서대로 따라야 하는 지침이라면 순서형 목록을 사용해야 할테구요. 특정 용어를 정의할 때는 정의형 목록을 활용해야 할 것입니다.
|
|
|
|
#### 비순서형 목록
|
|
|
|
비순서형 목록은 항상 '* ' 문법을 사용하여 만들어야 합니다. 그래야 소스를 봤을 때 어디에 목록이 있는지 바로 알 수가 있습니다.
|
|
|
|
* 비순서 항목 1
|
|
* 비순서 항목 2
|
|
* 비순서 항목 3
|
|
* 비순서 항목 4
|
|
|
|
* 비순서 항목 1
|
|
* 비순서 항목 2
|
|
* 비순서 항목 3
|
|
* 비순서 항목 4
|
|
|
|
|
|
목록을 만드는 데 '- ' 나 '+ ' 문법을 사용할 수는 있지만, 모든 문서에 통일성을 유지하고자 합니다.
|
|
|
|
#### 순서형 목록
|
|
|
|
순서형 목록은 줄의 시작에 아무 번호에다 점을 찍어 만들 수 있습니다. 항목의 번호는 1, 2, 3, 4, 5 식으로 하고 싶겠지만, 순서형 목록의 각 항목은 반드시 '1. ' 문법으로 만들어야 합니다.
|
|
|
|
1. 첫째 항목
|
|
1. 둘째 항목
|
|
1. 셋째 항목
|
|
1. 넷째 항목
|
|
|
|
1. 첫째 항목
|
|
1. 둘째 항목
|
|
1. 셋째 항목
|
|
1. 넷째 항목
|
|
|
|
|
|
그래야 번호의 순서에 상관 없이 항목을 삽입한다던가 순서를 바꾼다던가 하는 작업을 쉽게 할 수 있습니다.
|
|
|
|
#### 항목 정의하기
|
|
|
|
용어를 정의할 때는 정의형 목록을 써 주세요.
|
|
|
|
주: 프로퍼티, 메뉴 옵션, 툴바 버튼 등에 대한 설명의 경우에는 표를 사용해 주세요. 자세한 것은 아래 표 부분을 참고해 주시기 바랍니다.
|
|
|
|
### 텍스트 효과
|
|
|
|
#### 두껍게와 이탤릭
|
|
|
|
두껍게(bold) 또는 강한(strong) 텍스트는 '__' 버전과는 달리 항상 '**' 문법을 사용합니다:
|
|
|
|
**두꺼운 텍스트**
|
|
|
|
이탤릭(italic) 또는 강조(emphasized) 텍스트는 '*' 버전과는 달리 '_' 문법을 사용합니다:
|
|
|
|
_강조 텍스트_
|
|
|
|
두꺼운 이탤릭 텍스트를 만들 때의 문법은 '**_' 와 '_**' 를 사용해야 합니다:
|
|
|
|
**_두꺼운 강조 텍스트_**
|
|
|
|
이러한 규칙의 준수를 통해 저자의 의도를 명확히 알 수 있을 것입니다. 두꺼운 텍스트를 만들려다 * 나 _ 가 남아버리거나, 이탤릭 텍스트를 만들려다 ** 나 __ 를 실수로 두 번 추가하게 되는 경우가 빈번합니다. ** 는 항상 두껍게이고 _ 는 항상 이탤릭이라는 것을 안다면, 저자가 어떤 포맷을 추가하려 했는지 명확히 알 수 있습니다.
|
|
|
|
### 주, 꼼수, 경고, 인용
|
|
|
|
주, 꼼수, 경고같은 특수한 정보는 각 항목에 대한 컨테이너를 사용하여 시작해야 합니다. `<div>` 요소에 note, tip, warning 클래스를 사용하면 자동으로 특수 아이콘과 더불어 그 안의 정보가 색이 들어간 글상자로 둘러쌓이게 됩니다.
|
|
|
|
#### 주
|
|
|
|
[REGION:note]
|
|
주 부분입니다. 노랑 글상자에 들어 있으며, 좌상단에는 주 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
[REGION:note]
|
|
주 부분입니다. 노랑 글상자에 들어 있으며, 좌상단에는 주 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
#### 꼼수
|
|
|
|
[REGION:tip]
|
|
꼼수 부분입니다. 초록 글상자에 들어 있으며, 좌상단에는 꼼수 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
[REGION:tip]
|
|
꼼수 부분입니다. 초록 글상자에 들어 있으며, 좌상단에는 꼼수 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
#### 경고
|
|
|
|
[REGION:warning]
|
|
경고 부분입니다. 빨강 글상자에 들어 있으며, 좌상단에는 경고 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
[REGION:warning]
|
|
경고 부분입니다. 빨강 글상자에 들어 있으며, 좌상단에는 경고 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
#### 인용
|
|
|
|
[REGION:quote]
|
|
인용 부분입니다. 파랑 글상자에 들어 있으며, 좌상단에는 인용 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
[REGION:quote]
|
|
인용 부분입니다. 파랑 글상자에 들어 있으며, 좌상단에는 인용 아이콘을 볼 수 있습니다.
|
|
[/REGION]
|
|
|
|
### 이미지
|
|
|
|
이미지는 문서 안에 표시되는 모든 종류의 그래픽을 말합니다.
|
|
|
|
#### 포맷과 해상도
|
|
|
|
소스 이미지에는 가급적 좋은 품질에 크기도 적합한 PNG 를 사용해 주시기 바랍니다.
|
|
이미지 크기는 표시하려는 해상도 그대로 만들어 주시구요. 같은 이미지를 다른 해상도로 여러 번 사용하게 될 경우,
|
|
최대 표시 해상도로 만드시기 바랍니다. 크기를 바로 조절하게 되면
|
|
보통 바람직하지 못한 결과가 나오게 됩니다.
|
|
|
|
이미지 크기:
|
|
|
|
| 용도 | 최대 이미지 폭 |
|
|
| ---- | -------------- |
|
|
| 표준 | 720 px |
|
|
| 배너 | 1180 px |
|
|
| 머티리얼 네트워크, 블루프린트 그래프 | 제한은 없으나 [Lightbox](#Lightbox) 를 사용해야 합니다. |
|
|
|
|
#### 퀄리티
|
|
|
|
기본적으로 모든 이미지는 jpeg 로 압축 변환됩니다. jpeg 으로 압축할 때는 가끔 이미지 퀄리티가
|
|
문제가 될 수 있는데요. [이미지 프로퍼티](DocumentationGuidelines/Syntax#이미지프로퍼티) 를 통해
|
|
압축률을 조절하고 심지어 퍼블리싱된 페이지에 사용할 원본 이미지를
|
|
변환하여 덮어쓰기도 합니다.
|
|
|
|
#### 이펙트
|
|
|
|
이미지에는 어떤 종류의 스타일이나 이펙트가 있어서는 안됩니다. 둥근 모서리라든가, 음영이라든가, 다른 테두리 효과를 사용하지 마세요. 이러한 이펙트는 소스 콘텐츠 재생성 없이 원하는 대로 쉽게 바꿀 수 있도록 스타일에서 처리가 됩니다.
|
|
|
|
#### 이미지 표
|
|
|
|
첫 줄에는 이미지가, 둘째 줄에는 캡션이 들어가는 표로 이미지를 표시하면 좋을 때가 종종 있습니다. 보통의 표를 사용하면 적용되는 스타일때문에 약간 못나 보일 수 있습니다.
|
|
|
|
|  |  |
|
|
| ------ | ------ |
|
|
| 필터링 미적용 레이어 리스트 | 필터링 적용 레이어 리스트 |
|
|
|
|
|  |  |
|
|
| ------ | ------ |
|
|
| 필터링 미적용 레이어 리스트 | 필터링 적용 레이어 리스트 |
|
|
|
|
그 이유로 _imagetable_ 이라는 특수 region 이 제공됩니다. 이 region 으로 둘러쌓인 표는 훨씬 깔끔하고 세련된 모양새가 납니다.
|
|
|
|
[REGION:imagetable]
|
|
|  |  |
|
|
| ------ | ------ |
|
|
| 필터링 미적용 레이어 리스트 | 필터링 적용 레이어 리스트 |
|
|
[/REGION]
|
|
|
|
[REGION:imagetable]
|
|
|  |  |
|
|
| ------ | ------ |
|
|
| 필터링 미적용 레이어 리스트 | 필터링 적용 레이어 리스트 |
|
|
[/REGION]
|
|
|
|
#### 이미지 번호표
|
|
|
|
종종 이미지에 번호표(callout)를 붙여 텍스트에서 번호 목록으로 가리켜야 할 필요가 있습니다. 이미지 안에 번호표를 붙일 때는,가리키는 부분을 노랑색 선으로 가리켜야 합니다. 인접한 인터페이스 영역을 구분할 때는 모서리를 둥글게 하는 것이 좋습니다. 여기에 번호표를 바로 붙이면 됩니다.
|
|
|
|
번호 자체는 일관성을 위해 다음과 같은 스타일을 사용합니다:
|
|
|
|
|
|
* **폰트:** Arial 이나 비슷한 sans serif 폰트
|
|
* **스타일:** 두껍게 + 이탤릭
|
|
* **색:** 노랑 (#fdf242)
|
|
|
|
|
|
|
|
|
|
1. **툴바** - 현재 편집중인 _애니메이션 시퀀스_ 이름을 표시합니다.
|
|
1. **트랙 목록** - 노티파이 생성/편집을 위한 편집가능 트랙 목록입니다. 트랙 생성이나 제거는 물론 노티파이 생성이나 작업 관련 정보는 아래를 참고해 주시기 바랍니다.
|
|
1. **타임라인** - **뷰포트** 패널의 미리보기 재생 관련 정보가 표시되고, 그에 대한 콘트롤이 제공됩니다.
|
|
|
|
|
|
위 예제에서 인터페이스를 어떻게 나누고 번호를 붙였으며, 또 번호 목록은 어떻게 땄는지 볼 수 있습니다.
|
|
|
|
### Lightbox
|
|
|
|
페이지에 오버레이 형식으로 표시하는 것이 최선인 큰 이미지나 기타 콘텐츠는 Lightbox 를 활용해야 합니다. 일반적으로는 `Lightbox` [Region(리전)](DocumentationGuidelines/Syntax#Region) 안에 링크를 포함시키는 것을 뜻합니다. 정확한 문법은 라이트박스 대상 콘텐츠의 유형에 따라 달라집니다. 자세한 것은 문법 페이지의 [Lightbox](DocumentationGuidelines/Syntax#이미지라이트박스) 부분을 참고해 주시기 바랍니다.
|
|
|
|
[refepiclogo]: Logo_Epic-New.jpg "Here's a title"(w:50 h:50 a:left convert:true quality:75 fill:#000000) |