Commit 8045106e authored by minseok.park's avatar minseok.park

update latest docs

parent 9f50519b
Pipeline #19635 canceled with stage
in 13 seconds
node_modules/
build/
\ No newline at end of file
/build/
/node_modules/
#before_script:
# - |
# export NVM_DIR="$HOME/.nvm"
# [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
# nvm install 16.20
# nvm use 16.20
# node --version
image:
name: antora/antora:3.1.7
pages:
stage: deploy
cache:
# paths:
# - .cache
key: ${CI_COMMIT_REF_SLUG}
paths:
- node_modules/
script:
# - nvm alias default 16.20.2
# - node --version
# - nvm use 16.20
- node --version
# - antora --fetch --cache-dir .cache/antora --redirect-facility gitlab --to-dir public antora-playbook.yml
- |
if git diff --quiet HEAD~1 HEAD -- package.json package-lock.json; then
echo "No changes in package.json or package-lock.json, skipping npm install."
else
echo "Changes detected in package.json or package-lock.json, running npm install."
npm install
fi
- antora --fetch --cache-dir node_modules/antora --redirect-facility httpd antora-playbook.yml
only:
- master
\ No newline at end of file
# SWLab Docs
이 프로젝트는 GitLab의 SWLab 문서를 AsciiDoc으로 작성하고, Antora를 사용해 자동으로 사이트로 변환 및 배포하는 과정을 GitLab CI/CD 파이프라인으로 자동화합니다.
* 사이트: https://swlab.bwg.co.kr/docs
\ No newline at end of file
site:
title: My Demo Site
url: https://swlab.bwg.co.kr/docs/
start_page: swlab-docs::ready-to-write/text-editor.adoc
title: SWLab Docs Site
url: https://swlab.bwg.co.kr/docs
content:
sources:
- url: https://gitlab.bwg.co.kr/test/swlab-docs-for-park.git
start_path: getting-started
- url: https://gitlab.bwg.co.kr/swd/swlab-docs.git
branches: [master]
antora:
extensions:
- require: '@antora/lunr-extension'
languages: [en, ko]
asciidoc:
attributes:
experimental: ''
idprefix: ''
idseparator: '-'
page-pagination: ''
sectnums: all
sectnumlevels: 3
hardbreaks-option: '@'
hide-uri-scheme: '@'
icons: font
toclevels: 5
table-caption: false
ui:
bundle:
url: https://gitlab.bwg.co.kr/swd/swlab-ui/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
\ No newline at end of file
snapshot: true
output:
destinations:
- provider: fs
path: /data/home/bxdocs/web/docs
name: swlab-docs
title: SWLab Docs
version: '2.0'
start_page: ready-to-write:text-editor.adoc
asciidoc:
attributes:
source-language: asciidoc@
nav:
- modules/ready-to-write/nav.adoc
- modules/guide-like-bgbook/nav.adoc
// Toggle section numbers on
:sectnums: all
// You can increase or reduce the section level limit
:sectnumlevels: 3
// Line breaks preserved throughout the document
:hardbreaks-option:
// Hide the scheme (e.g., https://)
:hide-uri-scheme:
// Enable font-based icons
:icons: font
////
+ Enable the autogenerated a table of contents(TOC)
- auto (default), left, right, preamble, macro
+ The table of contents is inserted directly below the document title, author, and revision lines when the toc attribute is set and its value is left empty or set to auto.
////
// :toc: left
:toclevels: 5
// In order to use the UI macros
//(the name of the attribute will likely change to better reflect)
:experimental:
\ No newline at end of file
.가이드
* xref:00aboutManual.adoc[]
** xref:00_1writing.adoc[]
** xref:00_2management.adoc[]
* xref:01title.adoc[]
* xref:02section.adoc[]
* xref:03sublevel.adoc[]
* xref:04paragragh.adoc[]
* xref:05appendix.adoc[]
* xref:06sourcecode.adoc[]
* xref:07codedescription.adoc[]
* xref:08commandblock.adoc[]
* xref:09image.adoc[]
* xref:10icon.adoc[]
* xref:11unorderedlist.adoc[]
* xref:12orderedlist.adoc[]
* xref:13table.adoc[]
* xref:14admonition.adoc[]
* xref:15link.adoc[]
* xref:16footnotes.adoc[]
* xref:17textformatting.adoc[]
* xref:18etc.adoc[]
This diff is collapsed.
This diff is collapsed.
= 매뉴얼에 대하여
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 으로 작성하는 매뉴얼에 대하여 설명합니다.
--
== 글쓰기 방법
여러 사람이 집필하지만 한사람이 집필한 것처럼 일관되고 통일된 형태로 문장이 표현될 수 있도록 기존 BGBook 가이드의 xref:00_1writing.adoc#how_to_write["글쓰기 방법"]을 이용하므로 한번씩 정독하도록 한다.
== 매뉴얼 구성
매뉴얼의 기본 구성에 대해서 설명한다.
=== 공통 양식
문서를 시작할 때 공통적으로 작성되어야 할 사항이다.
[source,asciidoc]
----
= Document Title <1>
Gildong Hong <email1@bankwareglobal.com> <2>
[abstract] <3>
.문서개요
--
문서에 대해 설명한다.
--
----
<1> 문서 제목
<2> 작성자 정보
<3> 문서 개요
==== 문서 제목
각 페이지마다 하나의 문서 제목을 가진다. 작성 방법은 xref:01title.adoc#document_title["문서 제목"]을 참고하여 작성한다.
==== 작성자 정보
각 페이지마다 작성자 또는 대표 담당자 정보를 문서 제목 아래에 다음과 같은 형태로 기입한다.
----
성명 <메일주소>
----
==== 문서 개요
문서의 개념 및 작성 과정에 대해서 개략적으로 설명한다.
[source,asciidoc]
----
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 작성하는 매뉴얼에 대하여 설명합니다.
--
----
== 매뉴얼 관리
xref:00_2management.adoc#manual_management["매뉴얼 관리"] 메뉴에서 설명한다.
\ No newline at end of file
[#document_title]
= 문서 제목 (Title)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 문서 제목을 표현하는 방법에 대해 설명합니다.
--
== Document Title
모든 페이지에는 문서 제목을 작성해야하고 결과물은 다음과 같다.
=== AsciiDoc 소스
Title을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
= 문서 제목 (Title)
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 문서 제목을 표현하는 방법에 대해 설명합니다.
--
----
=== 결과
Title을 작성한 본문 형태는 다음과 같다.
****
.Document Title
image::guide-like-bgbook_figure1_1.png["Document Title",800]
****
\ No newline at end of file
= 절 (Section)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 절(Section)을 표현하는 방법에 대해 설명합니다.
--
== Section
문서에서 절을 표현하기 위해서는 = 을 늘려가며 사용하고 결과물은 다음과 같다.
문서 제목을 제외하고 섹션은 3 Depth까지만 허용한다.
Document Title(=) -> Level 1 Section(==) -> Level 2 Section(===) -> Level 3 Section(====)
=== AsciiDoc 소스
절을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
== Text Formatting
우리가 말할 때 특정 단어와 구를 강조하는 것처럼, 우리는 서식과 구두점을 사용하여 텍스트에서 단어와 구를 강조한다. 문서에서 텍스트 서식을 표현하기 위해서는 다양한 서식 표시를 사용하고 결과물은 다음과 같다.
=== 굵게 (*)
굵은 텍스트는 더 두껍거나 어두운 글꼴을 적용한다.
==== AsciiDoc 소스
텍스트 서식(Bold)을 사용하는 AsciiDoc 소스는 다음과 같다.
----
=== 결과
절을 사용하는 경우 본문 형태는 다음과 같다.
****
.Section
image::guide-like-bgbook_figure2_1.png["Section",800]
****
\ No newline at end of file
= 절 (Section) 이하
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 절(Section) 이하 레벨을 표현하는 방법에 대해 설명합니다.
--
== Section 이하
문서에서 절 이하 레벨을 표현하기 위해서는 [discrete]를 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
절 이하 레벨을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
[discrete]
==== Section
절 이하 레벨 표현 시 사용한다.
----
=== 결과
절 이하 레벨을 사용하는 경우 본문 형태는 다음과 같다.
****
[discrete]
==== Section 이하
절 이하 레벨 표현 시 사용한다.
****
= 단락 (Paragraph)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 단락(Paragraph)을 표현하는 방법에 대해 설명합니다.
--
== Paragraph
AsciiDoc에서는 단락을 만들기 위해 특별한 마크업이나 속성을 사용할 필요가 없다. 문장을 입력하기 시작하면 해당 내용이 단락이 된다. 결과물은 다음과 같다.
=== AsciiDoc 소스
Paragraph를 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
단락에는 AsciiDoc에서 특별한 마크업이 필요하지 않습니다. 단락은 한 줄 이상의 연속된 텍스트입니다.
새 단락을 시작하려면 이전 단락 또는 블록에서 하나 이상의 빈 줄로 구분합니다.
----
=== 결과
단락을 사용하는 본문 형태는 다음과 같다.
****
단락에는 AsciiDoc에서 특별한 마크업이 필요하지 않습니다. 단락은 한 줄 이상의 연속된 텍스트입니다.
새 단락을 시작하려면 이전 단락 또는 블록에서 하나 이상의 빈 줄로 구분합니다.
****
== 단락 연결
AsciiDoc에서 단락을 연결하려면 단락 사이에 + 기호를 사용한다. 이렇게 하면 줄바꿈이 발생하지 않고, 연결된 텍스트가 하나의 문단으로 표시된다.
[NOTE]
====
* + 기호는 단락 사이에 빈 줄 없이 사용해야 한다.
* + 기호 뒤에 오는 텍스트는 공백 한 칸 띄고 시작하지 않아야 한다.
====
=== AsciiDoc 소스
단락 연결을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
....
// + 사용 안 했을 경우
* 제품명과 같은 고유명사는 영문으로 표시하고 영문 명사는 국문으로 표시한다.
----
아파치 → Apache
----
// + 사용 했을 경우
* 외래어 표기는 정부부처에서 제정한 외래어 표기법을 따른다.
+
----
Access → 액세스 (O), 접근 (X)
----
....
=== 결과
단락 연결을 사용하는 본문 형태는 다음과 같다.
****
// + 사용 안 했을 경우
* 제품명과 같은 고유명사는 영문으로 표시하고 영문 명사는 국문으로 표시한다.
----
아파치 → Apache
----
// + 사용 했을 경우
* 외래어 표기는 정부부처에서 제정한 외래어 표기법을 따른다.
+
----
Access → 액세스 (O), 접근 (X)
----
****
= 부록 (Appendix)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 부록(Appendix) 표현하는 방법에 대해 설명합니다.
--
== Appendix
문서에서 부록을 표현하기 위해서는 [appendix]를 사용하고 Level 1 Section(==)으로 정의한다. 문서 끝에 배치하도록 하고 결과물은 다음과 같다.
=== AsciiDoc 소스
부록을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
[appendix]
== 첫번째 부록
=== First Subsection
=== Second Subsection
[appendix]
== 두번째 부록
----
=== 결과
부록을 사용하는 본문 형태는 다음과 같다.
[appendix]
== 첫번째 부록
=== First Subsection
=== Second Subsection
[appendix]
== 두번째 부록
= 소스 코드
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 소스 코드를 표현하는 방법에 대해 설명합니다.
--
== Source Code
문서에서 소스 코드를 표현하기 위해서는 [source,언어명]와 소스 블록(----)을 사용하고 결과물은 다음과 같다.
[NOTE]
====
* 소스가 아닌 경우 [source,언어명] 는 생략하고 블록(----)만 사용한다.
* AsciiDoc에서 특수하게 사용되는 문자가 포함된 경우 xref:06sourcecode.adoc#text_print["텍스트 그대로 출력"]을 참고한다.
====
=== AsciiDoc 소스
소스 코드를 작성하는 AsciiDoc 소스는 다음과 같다.
....
[source,c]
----
#include <stdio.h>
int main() {
printf("Hello, World!");
return 0;
}
----
....
=== 결과
소스 코드를 사용하는 경우 본문 형태는 다음과 같다.
****
[source,c]
----
#include <stdio.h>
int main() {
printf("Hello, World!");
return 0;
}
----
****
== Stack Trace
문서에서 Stack Trace를 표현하기 위해서는 [%collapsible]와 블록(====)을 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
Stack Trace를 작성하는 AsciiDoc 소스 다음과 같다.
....
.Show stacktrace
[%collapsible]
====
[source]
----
Error: Content repository not found (url: https://git.example.org/repo.git)
at transformGitCloneError
at git.clone.then.then.catch
Caused by: HttpError: HTTP Error: 401 HTTP Basic: Access Denied
at GitCredentialManagerStore.rejected
at fill.then
----
====
....
=== 결과
Stack Trace를 사용하는 경우 본문 형태는 다음과 같다.
****
.Show stacktrace
[%collapsible]
====
[source]
----
Error: Content repository not found (url: https://git.example.org/repo.git)
at transformGitCloneError
at git.clone.then.then.catch
Caused by: HttpError: HTTP Error: 401 HTTP Basic: Access Denied
at GitCredentialManagerStore.rejected
at fill.then
----
====
****
[#text_print]
== 텍스트 그대로 출력
입력한 대로 출력 텍스트를 표시한다.
* 인라인 패스 매크로: 인라인일 경우 사용한다.
* 리터럴 블록: 블록으로 지정할 때 사용한다.
* 블록 내 패스 매크로: 블록 내 패스 매크로 사용 방법
* subs 속성: 블록(및 특정 인라인 요소)에 적용되는 대체 규칙
=== 인라인 패스 매크로 (pass:[pass:[ ]])
인라인 텍스트의 서식이 지정되지 않도록 하는 특수 구문이다.
==== AsciiDoc 소스
Inline pass를 작성하는 AsciiDoc 소스 다음과 같다.
....
http.authorizeRequests()**.antMatchers("/resources/pass:[**]").permitAll()**.anyRequest().authenticated()
....
==== 결과
Inline pass를 사용하는 경우 본문 형태는 다음과 같다.
****
http.authorizeRequests()**.antMatchers("/resources/pass:[**]").permitAll()**.anyRequest().authenticated()
****
=== 리터럴 블록 (pass:[....])
리터럴 블록은 소스에서 보는 그대로 작성한 텍스트를 표시한다.
==== AsciiDoc 소스
리터럴 블록을 작성하는 AsciiDoc 소스 다음과 같다.
----
....
Kismet: Where is the *defensive operations manual*?
Computer: Calculating ...
Can not locate object.
....
----
=== AsciiDoc 소스
Stack Trace를 작성하는 AsciiDoc 소스 다음과 같다.
****
....
Kismet: Where is the *defensive operations manual*?
Computer: Calculating ...
Can not locate object.
....
****
. 출력에서 텍스트에 굵은 텍스트 서식이 적용되지 않는다.
. 세 개의 연속된 마침표가 줄임표 유니코드 문자로 대체되지 않는다.
=== 블록 내 패스 매크로
리터럴(....) 및 소스 블록(----) 내에서 pass를 사용하는 경우 pass가 매크로 대체라는 사실을 잊기 쉽다. pass를 활성화하려면 xref:06sourcecode.adoc#subs_attribute["subs 속성"]에 macros값을 할당한다.
==== AsciiDoc 소스
블록에서 Inline pass를 작성하는 AsciiDoc 소스 다음과 같다.
....
[source,java,subs="+quotes,+macros"]
----
protected void configure(HttpSecurity http) throws Exception {
http
.authorizeRequests()
**.antMatchers("/resources/pass:[**]").permitAll()**
.anyRequest().authenticated()
.and()
.formLogin()
.loginPage("/login")
.permitAll();
----
....
==== 결과
블록에서 Inline pass를 사용하는 경우 본문 형태는 다음과 같다.
****
[source,java,subs="+quotes,+macros"]
----
protected void configure(HttpSecurity http) throws Exception {
http
.authorizeRequests()
**.antMatchers("/resources/pass:[**]").permitAll()**
.anyRequest().authenticated()
.and()
.formLogin()
.loginPage("/login")
.permitAll();
----
****
[#subs_attribute]
=== subs 속성
블록(및 특정 인라인 요소)에 적용되는 대체 규칙은 subs 요소 속성을 사용하여 변경하거나 수정할 수 있다.
==== 종류
다음은 그 대체 단계 및 그룹이다.
[horizontal]
none:: 모든 대체를 비활성화하는 대체 그룹.
normal:: 콜아웃을 제외한 모든 대체 유형을 수행하는 대체 그룹.
specialchars:: <, > 및 &를 해당 엔티티로 대체하는 대체 단계. 소스 블록의 경우, 이 대체 단계는 구문 강조 표시를 활성화한다.
callouts:: 리터럴, 목록 및 소스 블록에서 콜아웃을 처리하는 대체 단계.
quotes:: 인라인 텍스트 서식을 적용하는 대체 단계.
attributes:: 속성 참조를 대체하는 대체 단계.
macros:: 인라인 및 블록 매크로를 처리하는 대체 단계.
post_replacements:: 줄 바꿈 문자(+)를 처리하는 대체 단계.
[NOTE]
====
* 값은 대체가 적용되는 순서도 지정한다.
* subs 요소 속성은 중첩된 블록에 상속되지 않는다. 이는 자식 블록을 가질 수 없는 단락(paragraph)이나 소스 블록(----)에만 적용될 수 있다.
====
==== 블록에 subs 속성 설정
소스 블록에서 인라인 서식 마크업을 처리하고 싶은 경우
기본적으로 소스 블록(----))은 특수 문자와 콜아웃만 적용된다. 이 동작은 블록의 속성 목록에서 subs 속성을 설정하여 변경할 수 있다.
[discrete]
==== AsciiDoc 소스
subs 속성을 작성하는 AsciiDoc 소스 다음과 같다.
....
// 기본 소스 블록
[source,java]
----
System.out.println("Hello *<name>*")
----
// subs 속성 설정
[source,java,subs="+quotes"]
----
System.out.println("Hello *<name>*")
----
....
[discrete]
==== 결과
subs 속성을 사용하는 경우 본문 형태는 다음과 같다.
****
[source,java]
----
System.out.println("Hello *<name>*")
----
[source,java,subs="+quotes"]
----
System.out.println("Hello *<name>*")
----
****
= 소스 코드 설명 (Callouts)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 설명선(Callouts; Callout numbers)을 표현하는 방법에 대해 설명합니다.
--
== Callout syntax
문서에서 설명선을 표현하기 위해서는 <n>을 사용한다.
<n>는 한 쌍으로 동작하며 첫번째는 소스 코드 블록 내에서 대상이 되는 줄 끝에 배치해야 하고 두 번째는 블록 아래에 배치하고 주석 텍스트를 정의한다. 결과물은 다음과 같다.
=== AsciiDoc 소스
설명선을 작성하는 AsciiDoc 소스는 다음과 같다.
....
[source,ruby]
----
require 'sinatra' \<1>
get '/hi' do \<2> \<3>
"Hello World!"
end
----
<1> Library import
<2> URL mapping
<3> Response block
....
=== 결과
설명선을 사용하는 경우 본문 형태는 다음과 같다.
****
[source,ruby]
----
require 'sinatra' <1>
get '/hi' do <2> <3>
"Hello World!"
end
----
<1> Library import
<2> URL mapping
<3> Response block
****
= 명령어 실행
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 명령어 실행을 표현하는 방법에 대해 설명합니다.
--
== Console 출력
문서에서 명령어 실행 단락을 표현하기 위해서 특별한 마크업이나 속성을 사용할 필요 없이 소스 코드와 동일하게 [source,언어명]와 소스 블록(----)을 사용한다. 언어명에 'console'을 지정하고 결과물은 다음과 같다.
=== AsciiDoc 소스
소스 코드를 작성하는 AsciiDoc 소스는 다음과 같다.
....
[source,console]
----
$ asciidoctor -v
----
[source,console]
----
C:\Users>dir
C 드라이브의 볼륨에는 이름이 없습니다.
볼륨 일련 번호: 4672-72DE
C:\Users 디렉터리
2024-02-19 오전 10:10 <DIR> .
2024-05-23 오전 03:51 <DIR> NB-20091101
2024-02-19 오전 10:07 <DIR> Public
0개 파일 0 바이트
3개 디렉터리 148,959,109,120 바이트 남음
----
....
=== 결과
소스 코드를 사용하는 경우 본문 형태는 다음과 같다.
****
[source,console]
----
$ asciidoctor -v
----
[source,console]
----
C:\Users>dir
C 드라이브의 볼륨에는 이름이 없습니다.
볼륨 일련 번호: 4672-72DE
C:\Users 디렉터리
2024-02-19 오전 10:10 <DIR> .
2024-05-23 오전 03:51 <DIR> NB-20091101
2024-02-19 오전 10:07 <DIR> Public
0개 파일 0 바이트
3개 디렉터리 148,959,109,120 바이트 남음
----
****
= 그림 (Image)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 그림(Image)을 표현하는 방법에 대해 설명합니다.
--
== Image
문서에서 그림을 표현하기 위해서는 블록(pass:[****)]과 image::파일명["대체 텍스트",너비]를 사용하고 결과물은 다음과 같다.
[NOTE]
====
이미지 파일명 규칙
. "모듈명_"을 접두어로 붙이고 파일명이 겹치지 않도록한다.
(예)
* concepts 모듈에서 사용되는 이미지
** 접두어: concepts_
** 파일명: concepts_overview.png
. images 폴더 아래 하위 폴더가 있다면 "폴더명_"도 추가한다.
(예)
* concepts 모듈의 images 폴더 하위의 architecture 폴더의 이미지
** 접두어: concepts_architecture_
** 파일명: concepts_architecture_01.png
====
=== AsciiDoc 소스
그림을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
****
.Online Architecture
image::guide-like-bgbook_figure9_1.png["Online Architecture",800]
****
----
=== 결과
그림을 사용하는 경우 본문 형태는 다음과 같다.
****
.Online Architecture
image::guide-like-bgbook_figure9_1.png["Online Architecture",800]
****
= 아이콘 (Inline Image)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 아이콘(Inline Image)을 표현하는 방법에 대해 설명합니다.
--
== Inline Image
문서에서 아이콘을 표현하기 위해서는 pass:[image:파일명["대체 텍스트",너비]]를 사용하고 결과물은 다음과 같다.
[NOTE]
====
이미지 파일명 규칙
. "모듈명_"을 접두어로 붙이고 파일명이 겹치지 않도록한다.
(예)
* concepts 모듈에서 사용되는 이미지
** 접두어: concepts_
** 파일명: concepts_overview.png
. images 폴더 아래 하위 폴더가 있다면 "폴더명_"도 추가한다.
(예)
* concepts 모듈의 images 폴더 하위의 architecture 폴더의 이미지
** 접두어: concepts_architecture_
** 파일명: concepts_architecture_01.png
====
=== AsciiDoc 소스
아이콘을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
Click image:guide-like-bgbook_play.png["Play",20] to get the party started.
////
대상 이미지가 ROOT 모듈에 속한 경우 ROOT 모듈 좌표를 지정해야 한다.
형식: image:ROOT:target-image-filename.ext[optional attribute]
////
Click image:ROOT:ROOT_pause.png["Pause",20] when you need a break.
----
[CAUTION]
====
공통으로 사용되는 이미지는 ROOT 모듈을 이용하고 다른 모듈의 이미지를 직접 접근해서 사용하지 않는다.
====
=== 결과
아이콘을 사용하는 경우 본문 형태는 다음과 같다.
****
Click image:guide-like-bgbook_play.png["Play",20] to get the party started.
Click image:ROOT:ROOT_pause.png["Pause",20] when you need a break.
****
= 기호 목록 (Unordered Lists)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 기호 목록(Unordered Lists)을 표현하는 방법에 대해 설명합니다.
--
== Unordered Lists
문서에서 순서가 지정되지 않은 목록은 디스크(일명 글머리 기호)와 같이 기호가 접두사로 붙은 항목이 있는 목록이다. 정렬되지 않은 목록 항목을 표현하기 위해서는 * 을 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
기호 목록을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
.기본 정보
* 적용 일자
해당 기관업무를 적용할 날짜. 당일부터 실행하고자 하는 경우, 오늘 이전 날짜를 등록한다.
* 응답 처리방식 코드
응답을 보낼 채널을 설정한다.
** 요청채널
요청받은 채널로 응답을 보낸다.
** 지정채널
커넥션정보의 추가정보에 설정된 지정응답커넥션으로 응답을 보낸다.
** 라운드로빈
커넥션 그룹 내의 커넥션을 라운드로빈 방식으로 배분하여 응답을 보낸다.
----
=== 결과
기호 목록을 사용하는 경우 본문 형태는 다음과 같다.
****
.기본 정보
* 적용 일자
해당 기관업무를 적용할 날짜. 당일부터 실행하고자 하는 경우, 오늘 이전 날짜를 등록한다.
* 응답 처리방식 코드
응답을 보낼 채널을 설정한다.
** 요청채널
요청받은 채널로 응답을 보낸다.
** 지정채널
커넥션정보의 추가정보에 설정된 지정응답커넥션으로 응답을 보낸다.
** 라운드로빈
커넥션 그룹 내의 커넥션을 라운드로빈 방식으로 배분하여 응답을 보낸다.
****
= 번호 목록 (Ordered Lists)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 번호 목록(Ordered Lists)을 표현하는 방법에 대해 설명합니다.
--
== Ordered Lists
문서에서 순서가 지정된 목록은 각 항목 앞에 숫자를 붙인 목록이다. 설치 과정이나 기동 단계와 같이 순서대로 나열되는 설명은 번호를 사용하여 설명한다. 정렬된 목록 항목을 표현하기 위해서는 점(.) 을 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
번호 목록을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
.등록절차
. 전문관리 > 전문레이아웃 화면
.. 그리드 우측 상단 버튼을 클릭
.. 신규 전문레이아웃 등록화면을 실행
. 우측상단의 행 추가 버튼을 클릭
.. 전문의 각 필드항목 필드명 및 타입, 길이 등을 설정하여 등록
----
=== 결과
번호 목록을 사용하는 경우 본문 형태는 다음과 같다.
****
.등록절차
. 전문관리 > 전문레이아웃 화면
.. 그리드 우측 상단 버튼을 클릭
.. 신규 전문레이아웃 등록화면을 실행
. 우측상단의 행 추가 버튼을 클릭
.. 전문의 각 필드항목 필드명 및 타입, 길이 등을 설정하여 등록
****
= 표 (Table)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 표(Table)를 표현하는 방법에 대해 설명합니다.
--
== Table
문서에서 표를 표현하기 위해서는 열 지정자 목록([cols="1열 지정자,2열 지정자,..."])과 표 블록(|===)을 사용한다.
* 열 지정자
열과 해당 열에 할당된 너비, 맞춤 및 스타일 속성을 나타낸다.
** 너비
열 너비는 1%와 100%사이의 백분율을 사용하여 할당하고 백분율 기호(%)는 생략한다.
** 서식
서식 연산자는 항상 열의 지정자 마지막 위치에 배치한다.
특정 셀에만 서식을 지정할 때는 셀 구분자(|) 앞에 서식 연산자를 지정한다.
*** 기본(d 또는 생략): 기본 인라인 서식 지원
*** AsciiDoc(a): AsciiDoc 블록 요소(목록, 블록) 지원
결과물은 다음과 같다.
=== AsciiDoc 소스
표를 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
.표 예제
[cols="50a,50"] <1>
|===
|헤더1열 |헤더2열
|. 1행 1열
AsciiDoc 서식 지정: AsciiDoc 블록 요소 지원됨
|. 1행 2열
기본 서식 지정: AsciiDoc 블록 요소 지원 안됨
|* 2행 1열
AsciiDoc 서식 지정: AsciiDoc 블록 요소 지원됨
|* 2행 2열
기본 서식 지정: AsciiDoc 블록 요소 지원 안됨
d|* 3행 1열 <2>
셀에 기본 서식 지정: AsciiDoc 블록 요소 지원 안됨
a|* 3행 2열 <3>
셀에 AsciiDoc 서식 지정: AsciiDoc 블록 요소 지원됨
|===
----
<1> 1열에 AsciiDoc(a) 서식 지정
<2> 셀에 기본(d) 서식 지정
<3> 셀에 AsciiDoc(a) 서식 지정
=== 결과
표를 사용하는 경우 본문 형태는 다음과 같다.
****
.표 예제
[cols="50a,50"]
|===
|헤더1열 |헤더2열
|. 1행 1열
AsciiDoc 서식: AsciiDoc 블록 요소 지원됨
|. 1행 2열
기본서식: AsciiDoc 블록 요소 지원 안됨
|* 2행 1열
AsciiDoc 서식: AsciiDoc 블록 요소 지원됨
|* 2행 2열
기본서식: AsciiDoc 블록 요소 지원 안됨
d|* 3행 1열
셀에 기본 서식 지정: AsciiDoc 블록 요소 지원 안됨
a|* 3행 2열
셀에 AsciiDoc 서식 지정: AsciiDoc 블록 요소 지원됨
|===
****
== 병합
표에서 병합을 표현하기 위해서는 셀 구분자(|) 앞에 범위 인수(`n`)와 범위 연산자(`+`)를 입력한다.
* 형식: 열범위.행범위+.^
** 예) 2.3+
결과물은 다음과 같다.
=== AsciiDoc 소스
병합을 작성하는 AsciiDoc 소스는 다음과 같다.
----
.병합 예제
[cols="25,25,25,25"]
|===
|헤더 1열 |헤더 2열 |헤더 3열 |헤더 4열
|1행 1열
2.3+|1행 2열
`2.3+`: 현위치 기준 2개의 열과 3개의 행 병합
-> 2열과 3열,
-> 1행과 2행, 그리고 3행 병합
|1행 4열
|2행 1열
|2행 4열
|3행 1열
|3행 4열
|===
----
=== 결과
병합을 사용하는 경우 본문 형태는 다음과 같다.
****
.병합 예제
[cols="25,25,25,25"]
|===
|헤더 1열 |헤더 2열 |헤더 3열 |헤더 4열
|1행 1열
2.3+|1행 2열
`2.3+`: 현위치 기준 2개의 열과 3개의 행 병합
-> 2열과 3열,
-> 1행과 2행, 그리고 3행 병합
|1행 4열
|2행 1열
|2행 4열
|3행 1열
|3행 4열
|===
****
\ No newline at end of file
= 권고 레이블
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 권고 레이블을 표현하는 방법에 대해 설명합니다.
--
== 권고 레이블
문서에서 권고 레이블을 표현하기 위해서는 [레이블명]과 블록(====)을 사용한다. 레이블은 대문자로 작성한다.
* 레이블 종류
** NOTE:
추가적인 정보나 참고 사항, 유용한 조언, 유익한 힌트를 제공할 때 사용한다. 문서의 주요 흐름에 직접적으로 영향을 미치지 않지만 독자에게 유용하거나 작업을 더 효율적으로 수행할 수 있도록 돕는 정보다.
** IMPORTANT:
중요한 정보나 절차를 강조할 때 사용한다. 반드시 알아야 하거나 주의 깊게 따라야 하는 내용이다.
** CAUTION:
신중하게 행동하도록 조언할 때 사용한다. 이 정보를 무시하면 오류가 발생하거나 예기치 않은 결과가 초래될 수 있다.
결과물은 다음과 같다.
=== AsciiDoc 소스
권고 레이블을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
[NOTE]
====
커넥션 구분이 클라이언트이면서 비유지 커넥션은 설정할 수 없다.
====
[IMPORTANT]
====
전송타임아웃은 거래에 대한 타임아웃 시간보다 큰 값을 설정해야 정상적으로 동작한다.
====
[CAUTION]
====
특별한 경우가 아니면 Half close 옵션을 사용하지 말 것을 권장한다.
====
----
=== 결과
권고 레이블을 사용하는 경우 본문 형태는 다음과 같다.
****
[NOTE]
====
커넥션 구분이 클라이언트이면서 비유지 커넥션은 설정할 수 없다.
====
[IMPORTANT]
====
전송타임아웃은 거래에 대한 타임아웃 시간보다 큰 값을 설정해야 정상적으로 동작한다.
====
[CAUTION]
====
특별한 경우가 아니면 Half close 옵션을 사용하지 말 것을 권장한다.
====
****
= 링크와 참조
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 링크와 참조를 표현하는 방법에 대해 설명합니다.
--
== Link
문서에서 주소 지정 가능한 다른 리소스에 대한 링크(일명 하이퍼링크)를 만드는 다양한 방법을 제공한다.
[NOTE]
====
* 링크의 대상: 웹 주소라고도 하는 URL(Uniform Resource Locator)
* 링크 텍스트: 해당 대상으로 이동하기 위해 클릭하는 텍스트
====
문서에서 링크를 표현하기 위해서는 pass:[link:+++URL+++["링크 텍스트"]] 를 사용하고 결과물은 다음과 같다.
[#link_asciidoc_source]
=== AsciiDoc 소스
링크를 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
The homepage for the Asciidoctor Project is link:+++https://asciidoctor.org/+++["AsciiDoctor Home"].
Email us at hello@example.com to say hello.
-- <1>
Once launched, the site will be available at \https://example.org.
If you cannot access the site, email \help@example.org for assistance.
--
----
<1> 자동 링크를 피하려면 URL앞에 \ 를 붙인다.
=== 결과
링크를 사용하는 경우 본문 형태는 다음과 같다.
****
The homepage for the Asciidoctor Project is link:+++https://asciidoctor.org/+++["AsciiDoctor Home"].
Email us at hello@example.com to say hello.
Once launched, the site will be available at \https://example.org.
If you cannot access the site, email \help@example.org for assistance.
****
== 상호 참조 (xref)
문서에서 상호 참조를 표현하기 위헤서는 pass:[xref:문서명#앵커ID["링크 텍스트"]] 를 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
상호 참조를 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
[#manual_id] <1>
Manually set id
[#link_asciidoc_source] <2>
=== AsciiDoc 소스
xref:15link.adoc#manual_id["Manual ID"] <3>
xref:15link.adoc#link_asciidoc_source["링크 AsciiDoc 소스"] <3>
----
<1> 앵커 설정
<2> 현 문서의 링크의 AsciiDoc 소스 섹션에 앵커 설정
<3> 참조 호출
[CAUTION]
====
.앵커 설정 규칙
* # 다음에 오는 첫 번째 문자는 소문자로 한다.
* 선택적 다음 문자는 소문자, 콜론, 밑줄, 하이픈, 마침표 또는 숫자여야 한다.
* ID에는 공백 문자를 사용할 수 없다.
====
=== 결과
상호 참조를 사용하는 경우 본문 형태는 다음과 같다.
****
[#manual_id]
Manually set id
xref:15link.adoc#manual_id["Manual ID"]
xref:15link.adoc#link_asciidoc_source["링크 AsciiDoc 소스"]
****
= 각주 (Footnotes)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 각주(Footnotes)를 표현하는 방법에 대해 설명합니다.
--
== Footnotes
문서에서 각주를 표현하기 위해서는 pass:[footnote:[텍스트]]를 사용하고 텍스트는 멀티라인으로 작성 가능하다.
* 각주를 재사용하려는 경우
대상 위치에 고유 ID 지정
** 예) pass:[footnote:id[text]]
* 기존 각주를 참조하는 경우
대상 슬롯에 각주의 ID만 지정하고 빈대괄호 사용
** 예) pass:[footnote:id[]]
결과물은 다음과 같다.
=== AsciiDoc 소스
각주를 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
.일관전송 파일 기본 정보
* 일괄전송파일IDfootnote:[일괄전송 파일을 식별하는 파일의 ID를 입력한다.
파일ID는 기관과 파일별로 정해진 이름이다.]
* 일괄전송파일명
* 적용일자footnote:effective_date[일괄전송 파일을 송수신할 적용일자를 입력한다.
입력된 일자 이후부터 해당 파일을 처리할 수 있다.
그러므로 당일 파일을 적용하기 위해서는 전일자를 입력해야 한다.]
* 데이터전송길이
.일괄전송 인터페이스 기본 정보
* 업무코드
* 적용일자footnote:effective_date[]
* 전문캐릭터셋
----
=== 결과
각주를 사용하는 경우 본문 형태는 다음과 같다.
****
.일관전송 파일 기본 정보
* 일괄전송파일IDfootnote:[일괄전송 파일을 식별하는 파일의 ID를 입력한다.
파일ID는 기관과 파일별로 정해진 이름이다.]
* 일괄전송파일명
* 적용일자footnote:effective_date[일괄전송 파일을 송수신할 적용일자를 입력한다.
입력된 일자 이후부터 해당 파일을 처리할 수 있다.
그러므로 당일 파일을 적용하기 위해서는 전일자를 입력해야 한다.]
* 데이터전송길이
.일괄전송 인터페이스 기본 정보
* 업무코드
* 적용일자footnote:effective_date[]
* 전문캐릭터셋
****
\ No newline at end of file
= 텍스트 서식
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 텍스트 서식을 표현하는 방법에 대해 설명합니다.
--
== Text Formatting
우리가 말할 때 특정 단어와 구를 강조하는 것처럼, 우리는 서식과 구두점을 사용하여 텍스트에서 단어와 구를 강조한다. 문서에서 텍스트 서식을 표현하기 위해서는 다양한 서식 표시를 사용하고 결과물은 다음과 같다.
=== 굵게 (*)
굵은 텍스트는 더 두껍거나 어두운 글꼴을 적용한다.
==== AsciiDoc 소스
텍스트 서식(Bold)을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
A bold *word*, and a bold *phrase of text*.
Bold c**hara**cter**s** within a word.
----
==== 결과
텍스트 서식(Bold)을 사용하는 경우 본문 형태는 다음과 같다.
****
A bold *word*, and a bold *phrase of text*.
Bold c**hara**cter**s** within a word.
****
=== 기울임체 (_)
오른쪽으로 약간 기울어진다.
==== AsciiDoc 소스
텍스트 서식(Italic)을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
An italic _word_, and an italic _phrase of text_.
Italic c__hara__cter__s__ within a word.
----
==== 결과
텍스트 서식(Italic)을 사용하는 경우 본문 형태는 다음과 같다.
****
An italic _word_, and an italic _phrase of text_.
Italic c__hara__cter__s__ within a word.
****
=== 고정 폭 (`)
명령 또는 소스 코드를 나타내는 방식으로 일반적으로 고정 너비(즉, 고정 폭) 글꼴을 사용하여 강조한다.
==== AsciiDoc 소스
텍스트 서식(Monospace)을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
"`Wait!`" Indigo plucked a small vial from her desk's top drawer
and held it toward us.
The vial's label read: `E=mc^2^`; the `E` represents _energy_,
but also pure _genius!_
----
==== 결과
텍스트 서식(Monospace)을 사용하는 경우 본문 형태는 다음과 같다.
****
"`Wait!`" Indigo plucked a small vial from her desk's top drawer
and held it toward us.
The vial's label read: `E=mc^2^`; the `E` represents _energy_,
but also pure _genius!_
****
=== 강조 표시 (#)
텍스트에 배경색을 주어 텍스트를 강조한다.
==== AsciiDoc 소스
텍스트 서식(Highlight)을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
Mark my words, #automation is essential#.
Mark my words, auto##ma##tion is essential.
----
==== 결과
텍스트 서식(Highlight)을 사용하는 경우 본문 형태는 다음과 같다.
****
Mark my words, #automation is essential#.
Mark my words, auto##ma##tion is essential.
****
=== 아래 첨자 (~), 위 첨자 (^)
아래 첨자와 위 첨자 텍스트는 수학 표현식과 화학 공식에서 일반적이다.
==== AsciiDoc 소스
텍스트 서식(Subscript, Superscript)을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
"`Well the H~2~O formula written on their whiteboard could be part
of a shopping list, but I don't think the local bodega sells
E=mc^2^,`" Lazarus replied.
----
==== 결과
텍스트 서식(Subscript, Superscript)을 사용하는 경우 본문 형태는 다음과 같다.
****
"`Well the H~2~O formula written on their whiteboard could be part
of a shopping list, but I don't think the local bodega sells
E=mc^2^,`" Lazarus replied.
****
=== 밑줄
텍스트 아래에 선이 그려진다.
==== AsciiDoc 소스
텍스트 서식(Underline)을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
The text [.underline]#underline me# is underlined.
The text [.underline]##under##line me is underlined.
----
==== 결과
텍스트 서식(Underline)을 사용하는 경우 본문 형태는 다음과 같다.
****
The text [.underline]#underline me# is underlined.
The text [.underline]##under##line me is underlined.
****
= 기타 작성법
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 AsciiDoc 에서 표현할 수 있는 기타 방법에 대해 설명합니다.
--
== 메뉴 표현
문서에서 메뉴를 표현하기 위해서는 [메뉴명] > [메뉴명] 을 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
메뉴를 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
[노드관리] > [노드정보] 에서 노드를 등록한다.
----
=== 결과
메뉴를 사용하는 경우 본문 형태는 다음과 같다.
****
[노드관리] > [노드정보] 에서 노드를 등록한다.
****
== 버튼 매크로
문서에서 버튼 매크로를 표현하기 위해서는 pass:[btn:[버튼명]]을 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
버튼 매크로를 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
완료되면 btn:[OK] 버튼을 누릅니다.
파일 네비게이터에서 파일을 선택하고 btn:[Open]를 클릭합니다.
----
=== 결과
버튼 매크로를 사용하는 경우 본문 형태는 다음과 같다.
****
완료되면 btn:[OK] 버튼을 누릅니다.
파일 네비게이터에서 파일을 선택하고 btn:[Open] 버튼을 클릭합니다.
****
== 키보드 매크로
문서에서 키보드 매크로를 표현하기 위해서는 pass:[kbd:[key(+key)*]]를 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
키보드 매크로를 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
.키보드 매크로
[cols="50,50"]
|===
|Shortcut |Purpose
|kbd:[F11]
|Toggle fullscreen
|kbd:[Ctrl+T]
|Open a new tab
|kbd:[Ctrl+Shift+N]
|New incognito window
|kbd:[\ ]
|Used to escape characters
|kbd:[Ctrl+\]]
|Jump to keyword
|kbd:[Ctrl + +]
|Increase zoom
|===
----
=== 결과
키보드 매크로를 사용하는 경우 본문 형태는 다음과 같다.
****
|===
|Shortcut |Purpose
|kbd:[F11]
|Toggle fullscreen
|kbd:[Ctrl+T]
|Open a new tab
|kbd:[Ctrl+Shift+N]
|New incognito window
|kbd:[\ ]
|Used to escape characters
|kbd:[Ctrl+\]]
|Jump to keyword
|kbd:[Ctrl + +]
|Increase zoom
|===
****
.AsciiDoc 작성 준비
* xref:text-editor.adoc[]
* xref:pandoc.adoc[]
\ No newline at end of file
= 문서 변환 도구 (Pandoc)
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
여기서는 문서 변환 도구(Pandoc)의 설치방법과 사용방법에 대하여 설명합니다.
--
== 설치
. 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}
----
* -s (또는 --standalone) : 완전한 문서를 생성하라는 지시입니다.
* -f html : 입력 파일 형식이 HTML임을 지정합니다.
* -t asciidoc : 목표 파일 형식을 AsciiDoc로 지정합니다.
* ${output.html} : 변환하고자하는 HTML 파일명입니다.
* –o ${output.adoc} : 생성될 AsciiDoc 파일명을 지정합니다.
=== Markdown -> AsciiDoc
Pandoc을 사용하여 Markdown 문서를 AsciiDoc 형식으로 변환한다.
----
pandoc -s -f markdown -t asciidoc ${input.md} -o ${output.adoc}
----
* -s (또는 --standalone) : 완전한 문서를 생성하라는 지시입니다.
* -f markdown : 입력 파일 형식이 Markdown임을 지정합니다.
* -t asciidoc : 목표 파일 형식을 AsciiDoc으로 지정합니다.
* ${input.md} : 변환하고자 하는 Markdown 파일명입니다.
* -o ${output.adoc} : 생성될 AsciiDoc 파일명을 지정합니다.
= AsciiDoc 도구
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
여기서는 AsciiDoc 문서를 미리 보고 편집하는 다양한 AsciiDoc 도구에 대하여 설명합니다.
AsciiDoc 구문은 일반 텍스트이므로 텍스트 편집기를 사용하여 AsciiDoc 문서를 작성할 수 있습니다.
--
== GitLab 주소
* link:+++https://gitlab.bwg.co.kr/swd/swlab-docs-bxcm+++["BXCM"]
* link:+++https://gitlab.bwg.co.kr/swd/swlab-docs-bxcp+++["BXCP"]
* link:+++https://gitlab.bwg.co.kr/swd/swlab-docs-bxi+++["BXI"]
* link:+++https://gitlab.bwg.co.kr/swd/swlab-docs-bxm+++["BXM"]
== IDE 및 텍스트 편집기
=== Visual Studio Code
. link:+++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를 재시작합니다.
// -
* 또는 link:+++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을 입력합니다.
+
----
https://de-jcup.github.io/update-site-eclipse-asciidoctor-editor/update-site/​
----
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 문서를 미리 보려면 link:+++https://chromewebstore.google.com/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia?pli=1+++["Chrome 확장 프로그램"^], link:+++https://microsoftedge.microsoft.com/addons/detail/asciidoctorjs-live-previ/pefkelkanablhjdekgdahplkccnbdggd+++["Edge 추가 기능"^], link:+++https://addons.mozilla.org/en-US/firefox/addon/asciidoctorjs-live-preview/+++["Firefox 추가 기능"^] 또는 link:+++https://addons.opera.com/en/extensions/details/asciidoctorjs-live-preview/+++["Opera 확장 프로그램"^](모두 동일한 코드 베이스에서 생성됨)을 설치합니다. 그런 다음 AsciiDoc 파일을 방문하기만 하면 HTML로 렌더링된 AsciiDoc 파일을 볼 수 있습니다.
\ No newline at end of file
This diff is collapsed.
{
"devDependencies": {
"@antora/cli": "3.1.7",
"@antora/site-generator": "3.1.7"
},
"dependencies": {
"highlight.js": "^11.9.0"
"@antora/lunr-extension": "^1.0.0-alpha.8",
"lunr-languages": "^1.14.0"
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment