루비 문서 형식
Ruby Document format |
RD(Ruby Document)는 Ruby 관련 문서를 작성하기 위한 경량 마크업 언어입니다.Ruby 소스 코드에 삽입할 수 있습니다.
RD는 전통적인 형식입니다.현대의 Ruby에서는 개발자가 RD가 아닌 RDoc으로 문서를 작성하는 경향이 있습니다.
사용하다
원래 루비 자체를 포함한 루비 세계의 대부분의 문서는 RD로 작성되었습니다.그 후 2002년에 많은 부분이 RDoc 형식으로 변환되었습니다.그러나 일본어판 Ruby Reference Manual은 여전히 RD 형식입니다.
RD는 손으로 쓰고 원시 형태로 쉽게 읽을 수 있도록 설계되었습니다.그러나 대부분의 최종 사용자는 HTML 페이지 또는 man 페이지로 변환된 후 이를 경험합니다.
RD는 루비 코드에 포함될 수 있으며 순수 RD 파일에는 보통 확장자가 있습니다..rd.
샘플 RD 문서
이 문서는 구문적으로 올바른 RD로 섹션 명명 관련 주요 규칙을 따르려고 합니다.
| 원천 | HTML 결과 |
|---|---|
=param = NAME RD 샘플 - 샘플 RD 문서 = SYNOPSIS here.is_a?(부품:Of::Code) print <<"END" 이 들여쓰기된 블록은 포맷 코드 또는 지시문을 스캔하지 않고 공백이 유지됩니다.END = 설명 일반 텍스트입니다.(*강조*), (%keyboard%), ({code})-형식화된 텍스트, (((변수 부분), ((::색인:), ('있는 그대로'(-)) 텍스트가 포함됩니다.== 예제 목록 * 글머리 기호 목록입니다.* 여기 다른 아이템이 있습니다.* 중첩된 목록 항목입니다.== 주문 목록 (1) 첫 번째 항목 (2) 두 번째 * 주문되지 않은 중첩 목록 (3) 세 번째 (1) 주문 목록 (2) 두 번째 항목 = 끝 = html <img src="예.png" align="right" alt="Figure 1." /> <p> 여기 내장된HTML 이 있습니다.이 블록에는 이미지를 포함하거나 <span style="color: green"> 스타일을 적용하거나 HTML로 할 수 있는 다른 작업을 할 수 있습니다.HTML을 출력하지 않는 RD 프로세서는 완전히 무시합니다.</p> = end = copyright = Copyright 2005 J. Random Hacker <jrh@cpan.org >이 문서의 복사, 배포 및/또는 수정은 자유 소프트웨어 재단이 발행한 GNU Free Documentation License, 버전 1.2 또는 이후 버전에 따라 허가됩니다.불변 섹션, 전면 커버 텍스트 및 후면 커버 텍스트가 없습니다.=종료 |
이름.RD 샘플 - 샘플 RD 문서 개요here.is_a?(부품:Of::Code) print <<"END" 이 들여쓰기된 블록은 포맷 코드 또는 지시문을 스캔하지 않고 공백이 유지됩니다.끝. 묘사여기 평범한 텍스트가 있습니다.강조된 텍스트가 포함되어 있습니다.키보드, 리스트의 예
주문 목록
저작권Copyright 2005 J. Random Hacker < jrh@cpan.org > 。이 문서의 복사, 배포 및/또는 수정은 자유 소프트웨어 재단이 발행한 GNU Free Documentation License, 버전 1.2 또는 이후 버전에 따라 허가됩니다.불변 섹션, 전면 커버 텍스트 및 후면 커버 텍스트가 없습니다. |
「 」를 참조해 주세요.
외부 링크
- RDtool - RD 문서를 다른 형식으로 변환하는 프레임워크입니다.
- rd-draft.rd - RD 마크업 언어에 대한 전체 설명(RD 형식)
- rd-draft.html - RD 마크업 언어 전체 설명(HTML로 변환)
| 실장 |
|  | ||||
|---|---|---|---|---|---|---|
| IDE | ||||||
| 적용들 | ||||||
| 라이브러리와 틀 |
| |||||
| 서버 소프트웨어 |
| |||||
| 사람 | ||||||
| 다른. | ||||||
