:description: This document is about the conversion of documents.
include::../attributes/common_attrs.adoc[]
include::../attributes/dir_attrs.adoc[]
include::../attributes/common_css.adoc[]
:source-highlighter: pygments
:pygments-style: manni
:pygments-linenums-mode: inline
[abstract]
.문서개요
--
여기서는 {doctitle} 의 설치방법과 사용방법에 대하여 설명합니다.
--
== 설치
. Pandoc 공식 다운로드 페이지( https://pandoc.org/installing.html[Pandoc - Installing pandoc^])에서 사용하는 운영 체제(OS)에 맞는 설치 프로그램을 다운로드합니다.
. 다운로드한 설치 프로그램을 실행합니다.
. 설치 마법사의 지시를 따라 설치합니다.
=== 설치 확인
명령 프롬프트(Command Prompt), 터미널(Terminal), 또는 쉘(Shell)을 열고 변환하고자 하는 문서의 폴더로 이동하여 아래의 명령어를 입력합니다.
----
pandoc --version
----
입력 후, 설치된 Pandoc의 버전 정보가 나타난다면 Pandoc이 성공적으로 설치된 것입니다.
만약 "pandoc" 명령을 인식하지 못한다는 메시지가 나온다면, Pandoc이 제대로 설치되지 않았거나 시스템의 PATH 환경 변수에 Pandoc의 설치 경로가 추가되지 않았을 가능성이 있습니다. 이 경우, Pandoc을 다시 설치하거나 PATH 환경 변수를 확인하고 수정해야 할 수 있습니다.
== 문서 변환 방법
=== DocBook -> AsciiDoc
Pandoc을 사용하여 DocBook 문서를 AsciiDoc 형식으로 변환한다.
. DocBook을 중간 형식(HTML)으로 변환
+
----
pandoc -s -f docbook -t html ${input.xml} –o ${output.html}
----
* -s (또는 --standalone) : 완전한 문서를 생성하라는 지시입니다.
* -f docbook : 입력 파일 형식이 DocBook임을 지정합니다.
* -t html : 목표 파일 형식을 HTML로 지정합니다.
* ${input.xml} : 변환하고자하는 DocBook 파일명입니다.
* –o ${output.html} : 생성될 HTML 파일명을 지정합니다.
. 그 형식(HTML)을 AsciiDoc으로 변환
+
----
pandoc -s -f html -t asciidoc ${output.html} -o ${output.adoc}
:description: This document is about the conversion of documents.
include::../attributes/common_attrs.adoc[]
include::../attributes/dir_attrs.adoc[]
include::../attributes/common_css.adoc[]
:source-highlighter: pygments
:pygments-style: manni
:pygments-linenums-mode: inline
[abstract]
.문서개요
--
여기서는 AsciiDoc 문서를 미리 보고 편집하는 다양한 {doctitle} 에 대하여 설명합니다.
AsciiDoc 구문은 일반 텍스트이므로 텍스트 편집기를 사용하여 AsciiDoc 문서를 작성할 수 있습니다.
--
== IDE 및 텍스트 편집기
=== Visual Studio Code
. https://code.visualstudio.com/[Visual Studio Code^] 를 설치합니다.
. VS Code를 실행한 후, 확장 기능 탭에서 "AsciiDoc"을 검색하여 설치합니다.
=== Eclipse
Eclipse에서 AsciiDoc을 사용하기 위해 AsciiDoc 문서를 작성하고 미리 보기할 수 있는 플러그인을 설치하는 방법을 안내하겠습니다. 가장 인기 있는 방법 중 하나는 "Asciidoctor Editor" 플러그인을 사용하는 것입니다. 이 플러그인을 통해 Eclipse 내에서 AsciiDoc 파일을 편집하고, 실시간 미리 보기를 볼 수 있습니다.
==== Eclipse Marketplace에서 설치하기
. Eclipse를 실행하고, 상단 메뉴에서 Help > Eclipse Marketplace...를 선택합니다.
. 검색창에 "Asciidoctor Editor"를 입력하고 검색합니다.
. 나타난 결과 중 "Asciidoctor Editor"를 찾아 Install 버튼을 클릭합니다.
. 설치 마법사의 지시에 따라 설치를 완료하고, 필요한 경우 Eclipse를 재시작합니다.
// -
* 또는 https://marketplace.eclipse.org/content/asciidoctor-editor[Eclipse Marketplace^]에서도 설치 가능
==== Update Site를 통해 설치하기
특정 버전의 플러그인을 설치하고자 할 때 또는 Marketplace에서 찾을 수 없는 경우 Update Site를 사용할 수 있습니다.
. Eclipse에서 Help > Install New Software...를 선택합니다.
. "Work with" 입력란에 Asciidoctor Editor의 Update Site URL을 입력합니다.
Asciidoctor Editor의 GitHub 페이지 또는 공식 문서에서 최신 URL을 찾을 수 있습니다.
. 목록에서 "Asciidoctor Editor"를 선택하고 Next > Finish를 따라 설치 프로세스를 완료합니다.
==== 문서 작성 및 미리 보기
* **문서 작성**: 설치가 완료되면, Eclipse에서 새로운 AsciiDoc 파일(.adoc)을 생성하고 문서를 작성할 수 있습니다.
* **미리 보기**: Asciidoctor Editor를 사용하면, AsciiDoc 문서를 작성하는 동안 자동으로 실시간 미리 보기를 볼 수 있습니다. 일부 설정이나 특정 미리 보기 기능은 플러그인 설정에서 조정할 수 있습니다.
== Hosted git repositories
git 리포지토리 호스트인 GitHub와 GitLab은 AsciiDoc 파일 편집 및 미리보기를 지원합니다.
이 지원을 활성화하려면 파일에 지원되는 AsciiDoc 확장자(예: .adoc)가 있어야 합니다.
* 리포지토리 보기에서 AsciiDoc 파일을 찾으면 AsciiDoc 콘텐츠의 HTML 미리 보기가 표시됩니다. 해당 미리보기는 Asciidoctor에서 제공합니다.
* 렌더링되는 HTML은 기본 제공 HTML 변환기에서 생성된 포함된 출력입니다.
즉, Asciidoctor에서 생성 한 독립 실행 형 HTML 문서처럼 보이지 않습니다.
대신 HTML은 호스팅 서비스의 테마에 맞게 스타일이 지정되고 삭제되므로 페이지 렌더링에 영향을 주지 않습니다. 따라서, 특정 기능을 사용하지 못할 수 있습니다.
== Web browser add-ons (미리보기 전용)
웹 브라우저에서 AsciiDoc 문서를 미리 보려면 https://chromewebstore.google.com/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia?pli=1[Chrome 확장 프로그램^], https://microsoftedge.microsoft.com/addons/detail/asciidoctorjs-live-previ/pefkelkanablhjdekgdahplkccnbdggd[Edge 추가 기능^], https://addons.mozilla.org/en-US/firefox/addon/asciidoctorjs-live-preview/[Firefox 추가 기능^] 또는 https://addons.opera.com/en/extensions/details/asciidoctorjs-live-preview/[Opera 확장 프로그램^](모두 동일한 코드 베이스에서 생성됨)을 설치합니다. 그런 다음 AsciiDoc 파일을 방문하기만 하면 HTML로 렌더링된 AsciiDoc 파일을 볼 수 있습니다.
