index.adoc 4.01 KB
Newer Older
hyeryung's avatar
hyeryung committed
1 2 3 4 5 6 7 8
= Text Formatting
Gildong Hong <email1@bwg.com>
:description: The document's description. This document is about the text formatting.
include::./attributes/common_attrs.adoc[]
include::./attributes/dir_attrs.adoc[]

[abstract]
.문서개요
hyeryung's avatar
hyeryung committed
9
--
hyeryung's avatar
hyeryung committed
10 11
This document has a header that specifies the {doctitle}.
This document is about the text formatting.
hyeryung's avatar
hyeryung committed
12 13
--

hyeryung's avatar
hyeryung committed
14
== 굵게 (*)
hyeryung's avatar
hyeryung committed
15
----
hyeryung's avatar
hyeryung committed
16 17
A bold *word*, and a bold *phrase of text*.
Bold c**hara**cter**s** within a word.
hyeryung's avatar
hyeryung committed
18
----
hyeryung's avatar
hyeryung committed
19 20 21 22
====
A bold *word*, and a bold *phrase of text*.
Bold c**hara**cter**s** within a word.
====
hyeryung's avatar
hyeryung committed
23

hyeryung's avatar
hyeryung committed
24
== 기울임체 (_)
hyeryung's avatar
hyeryung committed
25
----
hyeryung's avatar
hyeryung committed
26 27
An italic _word_, and an italic _phrase of text_.
Italic c__hara__cter__s__ within a word.
hyeryung's avatar
hyeryung committed
28 29
----
====
hyeryung's avatar
hyeryung committed
30 31
An italic _word_, and an italic _phrase of text_.
Italic c__hara__cter__s__ within a word.
hyeryung's avatar
hyeryung committed
32 33
====

hyeryung's avatar
hyeryung committed
34
== 고정 폭 (`)
hyeryung's avatar
hyeryung committed
35
----
hyeryung's avatar
hyeryung committed
36 37 38 39
"`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!_
hyeryung's avatar
hyeryung committed
40 41
----
====
hyeryung's avatar
hyeryung committed
42 43 44 45
"`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!_
hyeryung's avatar
hyeryung committed
46 47
====

hyeryung's avatar
hyeryung committed
48
== 강조 표시 (#)
hyeryung's avatar
hyeryung committed
49
----
hyeryung's avatar
hyeryung committed
50 51
Mark my words, #automation is essential#.
Mark my words, auto##ma##tion is essential.
hyeryung's avatar
hyeryung committed
52
----
hyeryung's avatar
hyeryung committed
53 54 55 56
====
Mark my words, #automation is essential#.
Mark my words, auto##ma##tion is essential.
====
hyeryung's avatar
hyeryung committed
57

hyeryung's avatar
hyeryung committed
58 59 60 61 62 63 64 65 66
== 스타일 구문 ([.]#)
----
Do werewolves believe in [.small]#small print#?
[.big]##O##nce upon an infinite loop.
----
====
Do werewolves believe in [.small]#small print#?
[.big]##O##nce upon an infinite loop.
====
hyeryung's avatar
hyeryung committed
67

hyeryung's avatar
hyeryung committed
68
=== Text with custom role
hyeryung's avatar
hyeryung committed
69
....
hyeryung's avatar
hyeryung committed
70 71
This sentence contains [.userinput]*bold inline content* that's assigned a role.
=> HTML:
hyeryung's avatar
hyeryung committed
72

hyeryung's avatar
hyeryung committed
73
[source,html]
hyeryung's avatar
hyeryung committed
74
----
hyeryung's avatar
hyeryung committed
75
<p>This sentence contains <strong class="userinput">bold inline content</strong> that&#8217;s assigned a role.</p>
hyeryung's avatar
hyeryung committed
76
----
hyeryung's avatar
hyeryung committed
77 78 79 80 81 82
** See the link:Blocks_sample.adoc#blocks_sample[Blocks sample] for more details about the block usage.
** See the link:Links_sample.adoc#links_sample[Links sample] for more details about the link usage.
....
====
This sentence contains [.userinput]*bold inline content* that's assigned a role.
=> HTML:
hyeryung's avatar
hyeryung committed
83

hyeryung's avatar
hyeryung committed
84
[source,html]
hyeryung's avatar
hyeryung committed
85
----
hyeryung's avatar
hyeryung committed
86
<p>This sentence contains <strong class="userinput">bold inline content</strong> that&#8217;s assigned a role.</p>
hyeryung's avatar
hyeryung committed
87
----
hyeryung's avatar
hyeryung committed
88 89
** See the link:Blocks_sample.adoc#blocks_sample[Blocks sample] for more details about the block usage.
** See the link:Links_sample.adoc#links_sample[Links sample] for more details about the link usage.
hyeryung's avatar
hyeryung committed
90 91
====

hyeryung's avatar
hyeryung committed
92 93 94 95 96 97
== 아래 첨자 (~), 위 첨자 (^)
----
"`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.
----
hyeryung's avatar
hyeryung committed
98
====
hyeryung's avatar
hyeryung committed
99 100 101
"`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.
hyeryung's avatar
hyeryung committed
102 103
====

hyeryung's avatar
hyeryung committed
104 105 106 107
== 밑줄
----
The text pass:[<u>underline me</u>] is underlined.
----
hyeryung's avatar
hyeryung committed
108
====
hyeryung's avatar
hyeryung committed
109
The text pass:[<u>underline me</u>] is underlined.
hyeryung's avatar
hyeryung committed
110 111
====

hyeryung's avatar
hyeryung committed
112 113 114 115 116 117 118 119 120 121 122 123
== 권고 레이블
* 레이블은 대문자여야 함.
* 단락일 경우 
** 레이블 바로 뒤에 콜론(:)이 온다.
** 단락의 첫 번째 줄을 레이블에서 한 칸으로 구분
* 블록일 경우
** 속성 목록([ ])에서 레이블을 설정
** 일반적으로 예제 블록(====)에 설정
* 종류
[cols="2*"]
|===
|소스 |결과
hyeryung's avatar
hyeryung committed
124

hyeryung's avatar
hyeryung committed
125 126 127 128 129 130 131 132 133 134
a|
....
. {blank}
+
NOTE: 단락 
      note1
      note2

. {blank}
+
hyeryung's avatar
hyeryung committed
135
[TIP]
hyeryung's avatar
hyeryung committed
136
.tips
hyeryung's avatar
hyeryung committed
137
====
hyeryung's avatar
hyeryung committed
138 139 140
* 블록
* tip1
* tip2
hyeryung's avatar
hyeryung committed
141 142
====

hyeryung's avatar
hyeryung committed
143 144 145
. {blank}
+
IMPORTANT: important
hyeryung's avatar
hyeryung committed
146

hyeryung's avatar
hyeryung committed
147 148 149
. {blank}
+
CAUTION: caution
hyeryung's avatar
hyeryung committed
150

hyeryung's avatar
hyeryung committed
151 152 153 154
. {blank}
+
WARNING: warning
....
hyeryung's avatar
hyeryung committed
155

hyeryung's avatar
hyeryung committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
a|
. {blank}
+
NOTE: 단락 
      note1
      note2

. {blank}
+
[TIP]
.tips
====
* 블록
* tip1
* tip2
====
hyeryung's avatar
hyeryung committed
172

hyeryung's avatar
hyeryung committed
173 174 175
. {blank}
+
IMPORTANT: important
hyeryung's avatar
hyeryung committed
176

hyeryung's avatar
hyeryung committed
177 178 179 180 181 182 183 184
. {blank}
+
CAUTION: caution

. {blank}
+
WARNING: warning
|===
hyeryung's avatar
hyeryung committed
185 186


hyeryung's avatar
hyeryung committed
187 188 189
NOTE: 단락 
      note1
      note2
hyeryung's avatar
hyeryung committed
190

hyeryung's avatar
hyeryung committed
191 192 193 194 195
. {blank}
+
NOTE: 단락 
      note1
      note2
hyeryung's avatar
hyeryung committed
196

hyeryung's avatar
hyeryung committed
197 198 199
. {blank}
+
note2
hyeryung's avatar
hyeryung committed
200

hyeryung's avatar
hyeryung committed
201 202 203 204 205
. {blank}
+
NOTE: 단락 
      note1
      note2
hyeryung's avatar
hyeryung committed
206

hyeryung's avatar
hyeryung committed
207 208 209 210 211 212 213 214 215
. {blank}
+
[TIP]
.tips
====
* 블록
* tip1
* tip2
====
hyeryung's avatar
hyeryung committed
216

hyeryung's avatar
hyeryung committed
217 218 219
. {blank}
+
IMPORTANT: important
hyeryung's avatar
hyeryung committed
220

hyeryung's avatar
hyeryung committed
221 222 223
. {blank}
+
CAUTION: caution
hyeryung's avatar
hyeryung committed
224

hyeryung's avatar
hyeryung committed
225 226 227
. {blank}
+
WARNING: warning