Guidelines (한국어)

이 페이지는 중요한 원칙을 담고 있습니다. 되도록이면 원본 영어 가이드라인을 참조하세요.

포럼( http://www.love2d.org/forums/ )에서 회원 가입만 한다면 누구나 위키를 편집할 수 있습니다. 다만 이 가이드라인은 꼭 따라주시길 바랍니다. (만약 지금 읽고 있는 한국어판이 아니라) 영어판 가이드라인에 대해서 수정 혹은 추가적 정보가 제공되어야 한다고 생각하시면 Rude에게 연락을 하시기 바랍니다.

목적

이 위키의 목적은 다음과 같습니다.

  1. LÖVE API 및 튜토리얼 제공.
  2. LÖVE를 사용한 게임 혹은 라이브러리에 대한 정보 제공.

글로는 이렇게 썼지만 사실 여기에 벗어나는 다른 여러가지 것들도 언제든 환영입니다.

그렇다고 해서 지금 이루고 있는 구조를 완전히 갈아엎는 것과 같은 엄청난 변경은... 절대로 하지 마세요! 그 전에 일단 Rude와 충분한 대화를 나누세요. 안그러면 여러분이 가한 수정이 무시될 지도 모릅니다.

이름 충돌

URL이 너무 길어지는 것을 막기 위해, API에서는 다른 문서로 링크를 거는 데 접두접미어 없는 순수한 제목만을 사용합니다. Image 타입은 http://love2d.org/wiki/Image 를 가리킵니다.

이런저런 이름 충돌이 일어날 수도 있는데 이런 경우에는 API가 항상 먼저입니다. 만약 여러분이 Awesome이란 게임을 만들어서 위키에 등록했다 칩시다. 후에 LÖVE Awesome라는 타입을 정의하면 (말도 안되긴 하지만), 그 게임의 제목은 다른 것으로 변경될 것입니다.

스타일

LÖVE의 내장 타입에 대해 서술할 때에는 링크를 거세요. 사용 예 : Image는 화면에 표시될 수 있는 타입입니다.

소스 코드를 서술하고 싶다면 <code> 태그를 사용해 가독성을 증가시켜보세요. 사용 예 : foo와 bar를 더하면 결과값은 foobar 입니다.

API

보다 유용히 사용할 수 있도록 API는 반드시 다음과 같은 구조를 따라야 합니다.

모든 API 문서는 같이 보기 부분에 자신의 부모 문서로 갈 수 있는 링크를 제공해야 합니다. 이게 없으면 위키에서 자동으로 제공하는 리스트에 해당 문서가 나타나지 않을 것입니다. love.audio 안에 있는 모든 함수, 열거형, 타입에는 아래와 같은 링크가 들어가 있습니다. 

[[parent::love.audio]]

부모로 가는 링크 뿐만 아니라 부모가 가진 리스트에 표기될 설명 또한 필요합니다. 페이지 하단부에 다음과 같이 작성하세요. 

{{#set:Description=화면에 [[Image (한국어)|Image]]를 그립니다.}}

모듈

'level 2' 머리말로 사용할 수 있는 것은 다음과 같습니다. 반드시 무언가 안에 내용이 있을 때에만 사용하세요.

  • Types : 타입
  • Functions : 함수
  • Enums : 열거형
  • Notes : 알아 두기
  • Examples : 예제
  • See Also : 같이 보기
  • Other Languages : 다른 언어

모든 모듈은 Category:Modules에 포함되어야 합니다.

타입

'level 2' 머리말로 사용할 수 있는 것은 다음과 같습니다. 다시 한번 말하지만 이들이 비워놓지 마세요.

  • Constructors : 생성자
  • Functions : 함수
  • Enums : 열거형
  • Supertypes : 상위 타입
  • Subtypes : 하위 타입
  • Notes : 알아 두기
  • Examples : 예제
  • See Also : 같이 보기
  • Other Languages : 다른 언어

모든 타입은 Category:Types에 포함되어야 합니다.

함수

함수의 경우 매개변수, 리턴값은 반드시 필요합니다. 함수가 아무것도 리턴하지 않으면 리턴하지 않는다고 확실히 명시하여 주세요. 매개변수의 경우도 마찬가지입니다.

외부 리스트는 'level 2' 머리말이고, 내부는 'level 3' 머리말입니다.

  • Function : 함수
    • Synopsis : 형식
    • Arguments : 매개변수
    • Returns : 리턴값
    • Notes : 알아 두기
  • Examples : 예제
  • See Also : 같이 보기
  • Other Languages : 다른 언어

If a function has overloads, repeat the 'Function' header for each overload. This is not required for trailing optional arguments; just indicate the default value in parentheses instead.

Arguments and return values should be presented as a definition list, using Template:param.

All functions must be assiciated with Category:Functions.

열거형

For enums, these headers are allowed:

  • Constants : 상수
  • Notes : 알아 두기
  • See Also : 같이 보기
  • Other Languages : 다른 언어

The constants should be listed as a definition list.

All enums must be associated with Category:Enums.

게임

For games, you can choose your own structure, but you should always add some semantic properties to the page to make it appear correctly in the list of games: 

{{#set:Name=NoGame}} (Should be same as page title)
{{#set:Author=User:Rude}}
{{#set:Genre=What kind of game your game is}}
{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your game.}}
{{#set:Screenshot=File:ScreenshotURL.png}}

Screenshots will automatically be resized to fit a box of 161x100 pixels.

Also, put your game in Category:Games to make it appear automatically in the Games page. To put your game in the correct category, add this line at the end of the page. 

[[Category:Games]]

It is also recommended that you provide screenshots of your game.

Libraries

No strict rules, but as for games, you should add these semantic properties: 

{{#set:LOVE Version=0.6.1}}
{{#set:Description=A short description of your library.}}

Put your library in Category:Libraries to make it appear automatically in on the Libraries page. To put your library in the correct category, add this line at the end of the page. 

[[Category:Libraries]]
Retrieved from "https://love2d.org./w/index.php?title=Guidelines_(한국어)&oldid=12399"