Commit e366494e authored by heywon.choi's avatar heywon.choi

pdf 가이드 추가

parent dd8040ef
Pipeline #19998 failed with stage
in 11 seconds
#!/bin/bash
# Create a unified images directory
mkdir -p ../pdf/images
# Copy images from all modules to the unified images directory
cp ../getting-started/modules/ROOT/images/* ../pdf/images/
cp ../getting-started/modules/guide-like-bgbook/images/* ../pdf/images/
# Update image paths in .adoc files
#find ../getting-started/modules/ -name "*.adoc" -exec sed -i 's|ROOT:|{imagesdir}|g' {} +
# 'modules/' 디렉토리 내의 모든 '.adoc' 파일을 검색하여, 'grep'으로 'ROOT:' 문자열이 있는 파일만 추출한 뒤 'sed'로 수정
find ../getting-started/modules/ -name "*.adoc" -exec grep -l "ROOT:" {} \; -exec sed -i 's|ROOT:|{imagesdir}|g' {} +
# create PDF
asciidoctor-pdf --theme ../theme.yml -a pdf-fontsdir="C:/Windows/Fonts;../fonts" -o ../pdf/guide.pdf ../pdf/pdf.adoc
# Delete images in the pdf images directory
rm -f ../pdf/images/*
# Update image paths in .adoc files
#find ../getting-started/modules/ -name "*.adoc" -exec sed -i 's|{imagesdir}|ROOT:|g' {} +
# 'modules/' 디렉토리 내의 모든 '.adoc' 파일을 검색하여, 'grep'으로 '{imagesdir}' 문자열이 있는 파일만 추출한 뒤 'sed'로 수정
find ../getting-started/modules/ -name "*.adoc" -exec grep -l "{imagesdir}" {} \; -exec sed -i 's|{imagesdir}|ROOT:|g' {} +
.Asciidoctor PDF
* xref:installation.adoc[설치]
* xref:configration.adoc[설정]
* xref:pdf-adoc.adoc[변환 파일 작성]
\ No newline at end of file
= Asciidoctor PDF 환경설정
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 Asciidoctor PDF를 이용하기 위해 필요한 환경 설정에 대해 설명합니다.
--
== 한글 설정
=== 글꼴 파일 준비
한글을 지원하는 글꼴 파일(.ttf)을 준비한다. 프로젝트 디렉토리 내에 fonts 디렉토리를 만들고 그 안에 저장한다.
* PDF 변환 명령 실행 시 폰트 디렉토리 지정
[source,console]
----
-a pdf-fontsdir="C:/Windows/Fonts;C:/path/of/project/fonts"
----
=== 테마 파일 작성
프로젝트 루트에 theme.yml 파일을 작성한다. 여기서 .ttf 파일명은 실제 사용하려는 글꼴 파일명으로 변경한다.
[CAUTION]
====
AsciiDoc 콘텐츠를 제대로 지원하려면 normal, italic, bold, bold_italic 네 가지 변형이 모두 필요하다. 변형 중 하나가 컬렉션에서 누락된 경우 그 자리에 일반/단일 변형을 재사용한다.
Asciidoctor PDF는 브라우저처럼 동적으로 글꼴을 기울임꼴로 표시할 수 없으므로 텍스트를 기울임꼴로 표시하려면 기울임꼴 스타일이 필요하다.
====
글꼴의 이름이 NanumGothic라고 가정해 보겠습니다. 다음과 같은 형식으로 파일 이름을 바꿉니다.
* nanumgothic-regular.ttf (originally NanumGothic.ttf)
* nanumgothic-light.ttf (originally NanumGothicLight.ttf)
* nanumgothic-bold.ttf (originally NanumGothicBold.ttf)
* nanumgothic-bold_extra.ttf (originally NanumGothicExtraBold.ttf)
[source,yaml]
----
extends: default-with-font-fallbacks
font:
catalog:
merge: true
NanumGothic:
normal: nanumgothic-regular.ttf
italic: nanumgothic-light.ttf
bold: nanumgothic-bold.ttf
bold_italic: nanumgothic-bold_extra.ttf
SegoeUISymbol: seguisym.ttf
fallbacks:
- SegoeUISymbol
base:
font_family: NanumGothic
font_size: 12
font_color: #000000
code:
font_family: NanumGothic
font_size: 10
----
* PDF 변환 명령 실행 시 테마 파일 지정
[source,console]
----
--theme theme.yml
----
== PDF 파일 위치 지정
프로젝트 디렉토리 내에 pdf 디렉토리를 만들고 그 안에 저장한다.
----
📒 swlab-docs-제품명
📄 theme.yml
📁 fonts
📁 modules
📂 pdf
📄 guide.pdf (생성될 파일)
----
[source,console]
----
-o C:/path/of/project/pdf/guide.pdf
----
= Asciidoctor PDF 설치
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 Asciidoctor PDF를 설치하는 방법에 대해 설명합니다.
--
== 필수 구성 요소
* Ruby 2.7 이상 또는 JRuby 9.2 이상
* Asciidoctor
* Asciidoctor PDF
=== Ruby 설치
asciidoctor는 Ruby 기반으로 작동하므로, Ruby가 시스템에 설치되어 있어야 한다.
==== 설치 확인
콘솔에서 다음 명령어를 통해 Ruby가 설치되어 있다면 버전 정보를 확인할 수 있다.
[source,console]
----
ruby -v
----
==== 설치
https://www.ruby-lang.org/ko/downloads/[Ruby 다운로드^]에서 사용중인 플랫폼에 맞춰 도구나 installer를 이용하여 설치한다.
=== Asciidoctor 설치
asciidoctor-pdf는 Asciidoctor의 확장 기능으로, 먼저 Asciidoctor가 설치되어 있어야 한다. 콘솔에서 다음 명령어로 Asciidoctor를 설치한다.
[source,console]
----
gem install asciidoctor
----
=== Asciidoctor PDF 설치
콘솔에서 다음 명령어로 asciidoctor-pdf 확장을 설치한다.
[source,console]
----
gem install asciidoctor-pdf
----
\ No newline at end of file
= Asciidoc 파일 작성
Heywon Choi <heywon.choi@bankwareglobal.com>
[abstract]
.문서개요
--
이 문서는 PDF로 변환할 Asciidoc 파일 작성 방법에 대해 설명합니다.
--
== pdf.adoc
PDF로 변환할 Asciidoc 파일에 PDF에 담을 각 페이지를 포함시킨다.
[source,asciidoc]
----
= Manual Guide
:doctype: book
:experimental: ''
:toc: macro
:toclevels: 3
:partnums:
:!part-signifier:
:sectnums: all
:!chapter-signifier:
:hardbreaks-option: '@'
:icons: font
:imagesdir: C:/path/of/project/pdf/images/ <1>
toc::[]
\include::../modules/guide-like-bgbook/pages/00aboutManual.adoc[] <2>
\include::../modules/guide-like-bgbook/pages/00_1writing.adoc[]
\include::../modules/guide-like-bgbook/pages/00_2management.adoc[]
\include::../modules/guide-like-bgbook/pages/01title.adoc[]
\include::../modules/guide-like-bgbook/pages/02section.adoc[]
\include::../modules/guide-like-bgbook/pages/03sublevel.adoc[]
\include::../modules/guide-like-bgbook/pages/04paragragh.adoc[]
\include::../modules/guide-like-bgbook/pages/05appendix.adoc[]
\include::../modules/guide-like-bgbook/pages/06sourcecode.adoc[]
\include::../modules/guide-like-bgbook/pages/07codedescription.adoc[]
\include::../modules/guide-like-bgbook/pages/08commandblock.adoc[]
\include::../modules/guide-like-bgbook/pages/09image.adoc[]
\include::../modules/guide-like-bgbook/pages/10icon.adoc[]
\include::../modules/guide-like-bgbook/pages/11unorderedlist.adoc[]
\include::../modules/guide-like-bgbook/pages/12orderedlist.adoc[]
\include::../modules/guide-like-bgbook/pages/13table.adoc[]
\include::../modules/guide-like-bgbook/pages/14admonition.adoc[]
\include::../modules/guide-like-bgbook/pages/15link.adoc[]
\include::../modules/guide-like-bgbook/pages/16footnotes.adoc[]
\include::../modules/guide-like-bgbook/pages/17textformatting.adoc[]
\include::../modules/guide-like-bgbook/pages/18etc.adoc[]
----
<1> 이미지 디렉토리 지정: {프로젝트 절대경로}/pdf/images/
<2> PDF에 포함시키고자 하는 파일을 순서대로 include 한다.
\ No newline at end of file
.가이드 .작성 가이드
* xref:00aboutManual.adoc[] * xref:00aboutManual.adoc[]
** xref:00_1writing.adoc[] ** xref:00_1writing.adoc[]
** xref:00_2management.adoc[] ** xref:00_2management.adoc[]
......
...@@ -12,10 +12,19 @@ Heywon Choi <heywon.choi@bankwareglobal.com> ...@@ -12,10 +12,19 @@ Heywon Choi <heywon.choi@bankwareglobal.com>
[NOTE] [NOTE]
==== ====
이미지 파일명은 "모듈명_"을 접두어로 붙인다. 이미지 파일명 규칙
예) concepts 모듈에서 사용되는 이미지
* 접두어: concepts_ . "모듈명_"을 접두어로 붙이고 파일명이 겹치지 않도록한다.
* 파일명: concepts_overview.png (예)
* concepts 모듈에서 사용되는 이미지
** 접두어: concepts_
** 파일명: concepts_overview.png
. images 폴더 아래 하위 폴더가 있다면 "폴더명_"도 추가한다.
(예)
* concepts 모듈의 images 폴더 하위의 architecture 폴더의 이미지
** 접두어: concepts_architecture_
** 파일명: concepts_architecture_01.png
==== ====
=== AsciiDoc 소스 === AsciiDoc 소스
......
...@@ -12,10 +12,19 @@ Heywon Choi <heywon.choi@bankwareglobal.com> ...@@ -12,10 +12,19 @@ Heywon Choi <heywon.choi@bankwareglobal.com>
[NOTE] [NOTE]
==== ====
이미지 파일명은 "모듈명_"을 접두어로 붙인다. 이미지 파일명 규칙
예) concepts 모듈에서 사용되는 이미지
* 접두어: concepts_ . "모듈명_"을 접두어로 붙이고 파일명이 겹치지 않도록한다.
* 파일명: concepts_overview.png (예)
* concepts 모듈에서 사용되는 이미지
** 접두어: concepts_
** 파일명: concepts_overview.png
. images 폴더 아래 하위 폴더가 있다면 "폴더명_"도 추가한다.
(예)
* concepts 모듈의 images 폴더 하위의 architecture 폴더의 이미지
** 접두어: concepts_architecture_
** 파일명: concepts_architecture_01.png
==== ====
=== AsciiDoc 소스 === AsciiDoc 소스
......
= Manual Guide
:doctype: book
:experimental: ''
:toc: macro
:toclevels: 3
:partnums:
:!part-signifier:
:sectnums: all
:!chapter-signifier:
:hardbreaks-option: '@'
:icons: font
:imagesdir: C:/BwG/Git/swlab-docs-for-choi/pdf/images/
toc::[]
include::../getting-started/modules/guide-like-bgbook/pages/00aboutManual.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/00_1writing.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/00_2management.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/01title.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/02section.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/03sublevel.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/04paragragh.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/05appendix.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/06sourcecode.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/07codedescription.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/08commandblock.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/09image.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/10icon.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/11unorderedlist.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/12orderedlist.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/13table.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/14admonition.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/15link.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/16footnotes.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/17textformatting.adoc[]
include::../getting-started/modules/guide-like-bgbook/pages/18etc.adoc[]
\ No newline at end of file
extends: default-with-font-fallbacks
font:
catalog:
merge: true
NanumGothic:
normal: nanumgothic-regular.ttf
italic: nanumgothic-light.ttf
bold: nanumgothic-bold.ttf
bold_italic: nanumgothic-bold_extra.ttf
SegoeUISymbol: seguisym.ttf
fallbacks:
- SegoeUISymbol
base:
font_family: NanumGothic
font_size: 12
font_color: #000000
code:
font_family: NanumGothic
font_size: 10
heading:
chapter:
break-before: avoid
break-after: avoid
part:
break-before: always
break-after: avoid
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