재구성된 텍스트

reStructuredText
대표적인 국가 이전과 혼동하지 마십시오.
재구성된 텍스트
reStructuredText logo
파일 확장자
.첫번째
인터넷 미디어 유형텍스트/x-rst
개발자데이비드 굿거
최초출시2001년 6월 1일; 22년전(2001-06-01)[1]
최신출시
개정판 8407
2019년 10월 29일, 4년 전(2019-10-29)
오픈포맷?공용 도메인
웹사이트docutils.sourceforge.io/rst.html

재구조화텍스트(Text, RST, ReST)는 파이썬 프로그래밍 언어 커뮤니티에서 기술 문서화를 위해 주로 사용되는 텍스트 데이터의 파일 형식입니다.

이것은 자바용 자바독 또는 펄용 POD(Plean Old Documentation)와 유사한 파이썬용 도구 집합을 만드는 것을 목표로 하는 파이썬 Doc-SIG(Documentation Special Interest Group)의 Docutils 프로젝트의 일부입니다. 문서는 Python 프로그램에서 코멘트와 정보를 추출하고, 이를 다양한 형태의 프로그램 문서로 포맷할 수 있습니다.[2]

이런 의미에서 restructured는텍스트는 Docutils와 같은 문서 처리 소프트웨어에 의해 처리가 가능하고 파이썬 소스 코드를 읽고 쓰는 인간 프로그래머가 쉽게 읽을 수 있도록 설계된 경량 마크업 언어입니다.

역사

재구조화텍스트는 이전의 Structured라는 경량 마크업 언어에서 진화했습니다.텍스트[3](Zope가 개발함). StructuredText에는 여러 가지 문제가 있었고, 이를 해결하기 위해 reST가 개발되었습니다.[4] restructured라는 이름텍스트는 reST가 "수정, 재작업 및 재해석된 구조화된 텍스트"임을 나타내기 위해 선택되었습니다.[5]

reST 구문의 일부는 1990년대 초부터 세텍스트 언어에서 영감을 받았습니다. 일반적인 RFC822 인터넷 메시지 형식과 자바독 형식의 요소도 설계에 포함시키기 위해 고려되었습니다.[6]

재구조화텍스트는 2001년 6월에 처음 공개되었습니다.[1] 2002년부터 Python 커뮤니티에서 중요하게 사용되기 시작했습니다.[7]

참조구현

reST 파서의 참조 구현은 Python 프로그래밍 언어의 Docutils 텍스트 처리 프레임워크의 구성 요소이지만 다른 파서를 사용할 수 있습니다.

RestructuredText에 등록된 공식 MIME 유형은 없지만, 비공식 MIME 유형은 text/x-rst.[8]

적용들

재구조화텍스트는 일반적으로 기술 문서화, 예를 들어 파이썬 라이브러리의 문서화에 사용됩니다.[9] 그러나 광범위한 텍스트에 적합합니다.

2008년부터 reST는 파이썬의 스핑크스 문서 생성 시스템의 핵심 구성 요소였습니다.

Trac은 GitHub 및 Bitbucket과 [10]마찬가지로 restructuredText도 지원합니다.

2011년, Project Gutenberg의 텍스트를 준비한 Distributed Proofreaders는 다른 전자책 형식을 생성할 수 있는 기본 형식으로 reST를 채택하는 것을 고려하고 있었습니다.[11][needs update]

2016년 7월 리눅스 커널 프로젝트는 DocBook 기반 문서에서 restructured로 전환하기로 결정했습니다.텍스트와 스핑크스 툴체인.[12]

소프트웨어 빌드 도구 CMake는 사용자 지정 마크업 언어에서 restructured로 전환되었습니다.문서화를 위해 버전 3.0의 텍스트.[13]

예

rST 구문을 사용한 텍스트 rST 프로세서에서 생성된 해당 HTML 브라우저에서 본 텍스트 
================문서 제목 ================ 제목 ======= 하위 제목 ----------- 문단은 공백 줄로 구분됩니다. 
<h1> Document Heading </h1> <h2> Heading </h2> Sub-heading </h3> <p> 문단은 공백줄로 구분됩니다.</p>
문서 제목
헤딩
소제목

단락은 빈 줄로 구분됩니다. 

텍스트 속성 *강조*, **강조**, ''monspace''.  수평 규칙: ---- 
<텍스트 속성 <em> 강조 </em>, <strong> 강조 </strong> 강조 </strong>, <code> monspace </code>.</p><p>수평규칙:/p><hr />
텍스트는 강조, 강한 강조, monospace.

수평 규칙: 

총알 목록 : * 사과 * 오렌지 * 배 번호 목록 : 1. 거품기 2. 헹굼 3. 중첩 목록 : 1. 과일 * 사과 * 바나나 2. 채소 * 당근 * 브로콜리 
<p>Bullet list:</p> <ul> <li>apples</li> <li>oranges</li> <li>pears</li> </ul> <p>Numbered list:</p> <ol> <li>lather</li> <li>rinse</li> <li>repeat</li> </ol> <p>Nested lists:</p> <ol> <li>fruits     <ul> <li>apple</li> <li>banana</li> </ul> </li> <li>vegetables     <ul> <li>carrot</li> <li>broccoli</li> </ul> </li> </ol>
블렛 리스트:
  • 사과
  • 오렌지
  • 배

번호가 매겨진 목록:

  1. 거품을 내다
  2. 헹구다.
  3. 따라하다

중첩 목록:

  1. 과일들
    • 사과
    • 바나나
  2. 야채들
    • 당근
    • 브로콜리
'example <http://example.com >. 이미지: Icon-pictures.png:alt: Image 텍스트가 들여오면 블록 따옴표로 처리됩니다.      배열 인덱스는 0에서 시작해야 합니까 아니면 1에서 시작해야 합니까?     제가 제안한 0.5 타협안은 적절한 고려 없이 거부되었다고 생각합니다. -- Stan Kelly-Bootle reST는 formatted 전 코드 블록에 :: Y = lambda f: (lambda x: f(x))(lambda x: f(x)) 파이프 문자가 있는 테이블에 여러 줄로 표시될 수 있습니다. 
<<a href="http://example.com "> example </a>.</p> <imgalt="Image"src="Icon-pictures.png" /><p><p>텍스트가 입력되면 블록 따옴표로 처리되며 최종 속성 행은 자동으로 처리됩니다:/p><block quotes> 배열 인덱스는 0에서 시작해야 하나요, 1에서 시작해야 하나요? 제가 제안한 0.5 타협안은 적절한 고려 없이 거부되었다고 생각합니다. -- Stan Kelly-Bootle </block quotes> <p>reST는 :: 사전 formatted 코드 블록 이전에 사용합니다:/p> <pre class="literal-block"> Y = lambda f: (lambda x: f(x(x))(lambda x: f(x)) </p> 파이프 문자로 다중 행 텍스트 캔 <br/>span 테이블 <br/>span.</p>
예를 들면.

Image

텍스트가 들여오면 블록 따옴표로 처리되고 최종 속성 줄은 자동으로 처리됩니다.

배열 인덱스는 0에서 시작해야 합니까 아니면 1에서 시작해야 합니까? 제가 제안한 0.5 타협안은 적절한 고려 없이 거부되었다고 생각했습니다.

-- 스탠 켈리-부틀

reST는 다음과 같은 코드 블록을 미리 포맷하기 전에 사용합니다.

Y = 람다 f: (lambda x: f(x(x))(lambda x: f(x))

여러 줄 텍스트 캔
테이블에 걸치다
파이프 같은 성격의

참고 항목

참고문헌

  1. ^ a b "Project: reStructuredText - File List". SourceForge. Archived from the original on 19 October 2001. Retrieved 5 February 2023.
  2. ^ Mertz, David (2003-02-01). "XML Matters: reStructuredText". IBM developerWorks. Retrieved 2016-10-05.
  3. ^ "zope.structuredtext Documentation". Read the Docs. Retrieved 2022-08-16.
  4. ^ Goodger, David (2016-05-24). "Problems With StructuredText". Docutils Project. Retrieved 2022-08-16.
  5. ^ Goodger, David (2016-02-26). "Docutils FAQ (Frequently Asked Questions)". Docutils Project. Retrieved 2016-10-05.
  6. ^ Goodger, David (2022-04-02). "A Record of reStructuredText Syntax Alternatives". docutils.sourceforge.io. Docutils Project. Retrieved 2022-08-16.
  7. ^ "Introduction to reStructuredText". Write The Docs. Retrieved 2022-06-25.
  8. ^ "What's the official MIME type for reStructuredText data? in Docutils FAQ". Docutils Project. Retrieved 2017-12-20.
  9. ^ Goodger, David (2002-04-02). "PEP 287 -- reStructuredText Docstring Format". Python Software Foundation. Retrieved 2016-10-05.
  10. ^ "reStructuredText Support in Trac". Trac. 2016-09-13. Retrieved 2016-10-05.
  11. ^ Newby, Greg (2011-01-08). "Minutes of 2010 December 11 meeting". Distributed Proofreaders. Retrieved 2011-01-08.
  12. ^ "Kernel documentation with Sphinx, part 1: how we got here". LWN.net. 2016-07-06. Retrieved 2016-10-27.
  13. ^ "CMake 3.0.0 Release Notes". Kitware, Inc. 2014-06-10. Retrieved 2016-10-05.

외부 링크