Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
S
SWLab Docs for Choi
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
CI / CD
CI / CD
Pipelines
Schedules
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
heywon.choi
SWLab Docs for Choi
Commits
3090f45a
Commit
3090f45a
authored
May 29, 2024
by
heywon.choi
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
추가
parent
30006b59
Pipeline
#19035
passed with stage
in 13 seconds
Changes
9
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
173 additions
and
72 deletions
+173
-72
common_attrs.adoc
getting-started/modules/ROOT/pages/common_attrs.adoc
+1
-1
nav.adoc
getting-started/modules/guide-like-bgbook/nav.adoc
+21
-20
00aboutManual.adoc
...tarted/modules/guide-like-bgbook/pages/00aboutManual.adoc
+128
-28
01title.adoc
getting-started/modules/guide-like-bgbook/pages/01title.adoc
+2
-2
02section.adoc
...ng-started/modules/guide-like-bgbook/pages/02section.adoc
+1
-1
09image.adoc
getting-started/modules/guide-like-bgbook/pages/09image.adoc
+3
-3
10icon.adoc
getting-started/modules/guide-like-bgbook/pages/10icon.adoc
+5
-5
nav.adoc
getting-started/modules/guide-samples/nav.adoc
+9
-9
nav.adoc
getting-started/modules/ready-to-write/nav.adoc
+3
-3
No files found.
getting-started/modules/ROOT/pages/common_attrs.adoc
View file @
3090f45a
// Toggle section numbers on
:sectnums: all
// You can increase or reduce the section level limit
:sectnumlevels:
5
:sectnumlevels:
3
// Line breaks preserved throughout the document
:hardbreaks-option:
// Hide the scheme (e.g., https://)
...
...
getting-started/modules/guide-like-bgbook/nav.adoc
View file @
3090f45a
* 가이드
** xref:00aboutManual.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[]
.가이드
* xref:00aboutManual.adoc[]
** xref:00_1writing.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[]
getting-started/modules/guide-like-bgbook/pages/00aboutManual.adoc
View file @
3090f45a
...
...
@@ -14,44 +14,104 @@ include::ROOT:common_attrs.adoc[]
=== Repository 구조
----
📒 repository
📂 docs <1>
📄 antora.yml <2>
📂 modules <3>
📂 guide-like-bgbook <4>
📂 images <5>
📄 image-source-file.png <6>
📂 pages <7>
📄 page-source-file.adoc <8>
📄 nav.adoc <9>
📂 ready-to-write <4>
📒 repository (swlab-docs) <1>
📄 antora-playbook.yml <2>
📂 getting-started <3>
📄 antora.yml <4>
📂 modules <5>
📂 ROOT <6>
📂 images <8>
📄 image-source-file.png <9>
📂 pages <10>
📄 page-source-file.adoc <11>
📄 nav.adoc <12>
📂 guide-like-bgbook <7>
📂 images
📄 image-source-file.png
📂 pages
📄 page-source-file.adoc
📄 nav.adoc
📂 ready-to-write <7>
📂 images
📄 image-source-file.png
📂 pages
📄 page-source-fi le.adoc
📄 nav.adoc
📂 ROOT <10>
📂 images
📄 image-source-file.png
📂 pages
📄 page-source-file.adoc
📄 nav.adoc
----
<1> 콘텐츠 원본 루트
<2> 필수 구성 요소 버전 설명자 파일
<3> 필수 모듈 디렉토리
<4> 명명된 모듈 디렉토리
<1> 팀별로 구성
<2> 필수 구성 파일
: 사이트, 콘텐츠 원본 및 UI URL을 구성
<3> 콘텐츠 원본 루트
<4> 필수 구성 파일
: 이름, 버전, 메타데이터, 속성 및 탐색 목록을 구성
<5> 필수 모듈 디렉토리
<6> ROOT 모듈 디렉토리
: ROOT 모듈의 페이지는 구성 요소 버전의 최상위 페이지가 되므로 다른 모듈에서 참조하는 공통 리소스를 저장한다.
+
[CAUTION]
====
기본 셋팅되어 있는 리소스는 수정/제거하지 않도록 주의한다.
====
<7> 명명된 모듈 디렉토리
: 필요한 만큼 생성 가능하고 생성할 때는 xref:./00aboutManual.adoc#module_name_rule["모듈 디렉토리 명명 규칙"]에 준하여 생성한다.
<
5
> 이미지 디렉터리
<
6
> 이미지 소스 파일
<
8
> 이미지 디렉터리
<
9
> 이미지 소스 파일
: PNG, JPG, SVG 및 GIF(정적 및 애니메이션) 이미지 파일 형식을 지원한다.
<
7
> pages 디렉토리
<
10
> pages 디렉토리
: 하나 이상의 AsciiDoc 소스 파일이 포함되어야 한다.
<
8
> 페이지의 원본 파일
<
11
> 페이지의 원본 파일
: AsciiDoc 구문으로 마크업되고 유효한 .adoc 파일 확장명으로 저장된 페이지 파일
<9> 내비게이션 파일
<10> ROOT 모듈 디렉토리
: ROOT 모듈의 페이지는 구성 요소 버전의 최상위 페이지가 된다. 다른 모듈에서 참조하는 공통 리소스를 저장하도록 한다.
<12> 내비게이션 파일
: 사이트 탐색 파일로써 모듈당 하나의 탐색 파일을 가진다. xref:./00aboutManual.adoc#nav_file["내비게이션 파일"]을 참고하여 작성한다.
=== 필수 구성 파일 (antora.yml)
antora.yml 파일은 구성 요소 버전을 식별, 설명 및 구성하는 필수 및 선택적 정보를 제공한다.
[source,yml]
----
name: swlab-docs <1>
title: SWLab Docs <2>
version: '2.0' <3>
start_page: ready-to-write:text-editor.adoc <4>
asciidoc: <5>
attributes:
source-language: asciidoc@
table-caption: false
nav: <6>
- modules/ready-to-write/nav.adoc
- modules/guide-like-bgbook/nav.adoc
----
.키 설명
[cols="30a,70a"]
|===
|키
|설명
|<1> name
|구성 요소 버전을 식별하는 데 사용되는 구성 요소 이름으로 리소스 ID의 구성 요소 좌표 및 구성 요소 버전의 게시된 리소스에 대한 구성 요소 URL 세그먼트에서 사용된다.
|<2> title
|왼쪽 메뉴 페이지에 표시되는 목적으로 사용되는 구성 요소 이름으로 공백, 대문자 및 다양한 문자를 사용할 수 있다.
|<3> version
|구성 요소 버전을 식별하는 데 사용되는 버전으로 리소스 ID의 버전 좌표 및 구성 요소 버전의 게시된 리소스 URL에 대한 버전 세그먼트로 사용된다.
|<4> start_page
|페이지를 구성 요소 버전의 홈 페이지로 지정한다. 형식: 모듈명:페이지 (ROOT모듈은 모듈명 작성시 생략한다.)
|<5> asciidoc.attributes
|**수정금지** 기본 제공 및 사용자 정의 AsciiDoc 속성 및 페이지 속성을 나타내고 antora.yml의 속성은 구성 요소 버전에 속하는 모든 페이지와 리소스(해당되는 경우)에 적용되므로 수정하지 않습니다.
|<6> nav
|탐색 파일 목록을 설정한다. 왼쪽 메뉴 페이지에서 사용된다.
* 한 줄에 하나씩 입력한다.
* 들여쓰지 않는다.
* 각 값을 하이픈(-)으로 시작하고 그 뒤에 공백을 입력한다.
* 공백 뒤에 antora.yml 파일의 위치를 기준으로 개별 탐색 파일의 경로를 입력한다.
* 나열된 순서로 왼쪽 메뉴 페이지가 구성된다.
|===
[#module_name_rule]
=== 모듈 디렉토리 명명 규칙
...
...
@@ -61,6 +121,46 @@ include::ROOT:common_attrs.adoc[]
* 대문자, 밑줄(_) 및 URL에서 권장되지 않는 기타 문자를 사용하지 않는다.
* 너무 길거나 기억하기 어렵게 만들지 말고 짧고 설명적으로 만든다.
[#nav_file]
=== 내비게이션 파일
탐색 파일은 사이트의 왼쪽메뉴를 구성한다. 작성 방법은 다음과 같다.
==== 파일 이름 및 형식
탐색 파일은 **nav.adoc**으로 명명한다.
탐색 파일에는 하나 이상의 글머리 기호 목록이 포함되어 있다.
목록의 각 항목은 페이지에 대한 상호 참조, 사이트에 속하지 않은 웹 사이트의 URL 또는 중첩된 목록 항목 집합을 그룹화하는 범주 제목과 같은 연결되지 않은 텍스트일 수 있다.
==== 목록 구조
탐색 목록은 순서가 지정되지 않은 AsciiDoc 목록이다. 파일에 여러 목록이 포함된 경우 각 목록은 목록 제목으로 시작해야 하고 각 최상위 목록 항목은 최대 2 Level까지만 허용한다.
[NOTE]
====
최상위 목록 항목은 점(.)으로 표시되는 목록 제목이거나, 목록 제목이 없는 경우 단일 별표(*)로 표시된 각 목록 항목을 말한다.
====
[discrete]
==== AsciiDoc 소스
탐색 파일을 작성하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
.가이드
* xref:00aboutManual.adoc[]
** xref:00_1writing.adoc[]
* xref:01title.adoc[]
----
[discrete]
==== 결과
탐색 파일을 작성한 메뉴 형태는 다음과 같다.
****
.Navigation file (Site)
image::figure0_1.png["내비게이션 파일",800]
****
==== 내비게이션 등록
== 글쓰기 방법
여러 사람이 집필하지만 한사람이 집필한 것처럼 일관되고 통일된 형태로 문장이 표현될 수 있도록 기존 BGBook 가이드의 글쓰기 방법을 이용하므로 한번씩 정독하도록 한다.
xref:./00_1writing.adoc#how_to_write["글쓰기 방법"]
...
...
getting-started/modules/guide-like-bgbook/pages/01title.adoc
View file @
3090f45a
...
...
@@ -26,8 +26,8 @@ Title을 작성하는 AsciiDoc 소스는 다음과 같다.
----
=== 결과
Title을 작성
하는
본문 형태는 다음과 같다.
Title을 작성
한
본문 형태는 다음과 같다.
****
.Document Title
image::figure1_1.png["Document Title",800
,600
]
image::figure1_1.png["Document Title",800]
****
\ No newline at end of file
getting-started/modules/guide-like-bgbook/pages/02section.adoc
View file @
3090f45a
...
...
@@ -31,5 +31,5 @@ Section을 작성하는 AsciiDoc 소스는 다음과 같다.
Section을 사용하는 경우 본문 형태는 다음과 같다.
****
.Section
image::figure2_1.png["Section",800
,600
]
image::figure2_1.png["Section",800]
****
\ No newline at end of file
getting-started/modules/guide-like-bgbook/pages/09image.adoc
View file @
3090f45a
...
...
@@ -9,7 +9,7 @@ include::ROOT:common_attrs.adoc[]
--
== Image
문서에서 그림을 표현하기 위해서는 블록(pass:[****)]과 image::파일명["대체 텍스트",너비
,높이
]를 사용하고 결과물은 다음과 같다.
문서에서 그림을 표현하기 위해서는 블록(pass:[****)]과 image::파일명["대체 텍스트",너비]를 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
그림을 사용하는 AsciiDoc 소스는 다음과 같다.
...
...
@@ -17,7 +17,7 @@ include::ROOT:common_attrs.adoc[]
----
****
.Online Architecture
image::figure9_1.png["Online Architecture",800
,600
]
image::figure9_1.png["Online Architecture",800]
****
----
...
...
@@ -25,5 +25,5 @@ image::figure9_1.png["Online Architecture",800,600]
그림을 사용하는 경우 본문 형태는 다음과 같다.
****
.Online Architecture
image::figure9_1.png["Online Architecture",800
,600
]
image::figure9_1.png["Online Architecture",800]
****
getting-started/modules/guide-like-bgbook/pages/10icon.adoc
View file @
3090f45a
...
...
@@ -9,21 +9,21 @@ include::ROOT:common_attrs.adoc[]
--
== Inline Image
문서에서 아이콘을 표현하기 위해서는 pass:[image:파일명["대체 텍스트",너비
,높이
]]를 사용하고 결과물은 다음과 같다.
문서에서 아이콘을 표현하기 위해서는 pass:[image:파일명["대체 텍스트",너비]]를 사용하고 결과물은 다음과 같다.
=== AsciiDoc 소스
아이콘을 사용하는 AsciiDoc 소스는 다음과 같다.
[source,asciidoc]
----
Click image:play.png["Play",20
,20
] to get the party started.
Click image:play.png["Play",20] to get the party started.
Click image:pause.png["Pause"20
,20
] when you need a break.
Click image:pause.png["Pause"20] when you need a break.
----
=== 결과
아이콘을 사용하는 경우 본문 형태는 다음과 같다.
****
Click image:ROOT:play.png["Play",20
,20
] to get the party started.
Click image:ROOT:play.png["Play",20] to get the party started.
Click image:ROOT:pause.png["Pause",20
,20
] when you need a break.
Click image:ROOT:pause.png["Pause",20] when you need a break.
****
getting-started/modules/guide-samples/nav.adoc
View file @
3090f45a
* 가이드 및 샘플
** xref:default.adoc[]
** xref:section.adoc[]
** xref:list.adoc[]
** xref:text-formatting.adoc[]
** xref:blocks.adoc[]
** xref:tables.adoc[]
** xref:image.adoc[]
** xref:links.adoc[]
\ No newline at end of file
.가이드 및 샘플
* xref:default.adoc[]
* xref:section.adoc[]
* xref:list.adoc[]
* xref:text-formatting.adoc[]
* xref:blocks.adoc[]
* xref:tables.adoc[]
* xref:image.adoc[]
* xref:links.adoc[]
\ No newline at end of file
getting-started/modules/ready-to-write/nav.adoc
View file @
3090f45a
* AsciiDoc 작성 준비
** xref:text-editor.adoc[]
** xref:pandoc.adoc[]
\ No newline at end of file
.AsciiDoc 작성 준비
* xref:text-editor.adoc[]
* xref:pandoc.adoc[]
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment