JIRA中的標記語言的語法參考
前言
看到網上有的文章說JIRA是使用Textile這門標記語言,有些語法和Wikitext和Markdown相像。JIRA在2017年進行了一次大更新,某些語法可能和以前不大一樣,這裡紀錄一下常用的一些語法。
標題
h1.一級標題
h2.二級標題
h3.三級標題
h4.四級標題
h5.五級標題
用法示例:
h1.ddd
一共有h1到h5這五種大小的標題,但是h6也是有效果的,不過h6起到的作用是將小寫字母變成大寫字母,示例如下:
h6.ddd
以上會得到DDD
的輸出。
字型
用法 | 效果 |
---|---|
*黑體* |
黑體 |
_斜體_ |
黑體 |
-刪除線- |
|
+下劃線+ |
下劃線 |
~下標~ |
下標 |
^上標^ |
上標 |
注意在使用上邊這些字型效果的時候,~
等字元需要和其他文字相隔一個空格,否則沒有效果,如下:
H ~2~ O
換行
第一行
\\
第二行
通過\\
來進行換行。
引用
bq. 這是引用,可以使用字型效果並進行換行。
通過bq.
來引用一段文字或圖片等,可以在引用段裡使用字型效果並進行換行。
附件
附件有兩種方式:
[^xxxx.mp4]
或者
!xxxx.mp4!
[^xxxx.mp4]
這種形式類似於超鏈,!xxxx.mp4!
這種形式則可以將圖片顯示出來,或者將視訊播放出來。
如果附件是圖片,還可以使用以下寫法:
顯示圖片的縮圖
!xxxx.jpg|thumbnail!
指定圖片的大小
!xxxx.jpg|width=300,height=400!
如果附件是視訊 ,還可以使用以下寫法:
指定視訊播放器的大小
!xxxx.mp4|width=300,height=400!
列表
第一種無序列表,會在每行最前邊顯示一個圓點
* 1
* 2
** 2.1
* 3
第二種無序列表,會在每行最前邊顯示一個方塊
- 1
- 2
-- 2.1
- 3
有序列表
# 1
# 2
## 2.1
# 3
有序列表和無序列表可以混合使用,如下:
# 1
# 2
#* 2.1
# 3
表格
表頭加粗寫法:
||heading 1||heading 2||heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|
表頭不加粗寫法:
|heading 1|heading 2|heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|
超鏈
直接貼上一個超鏈:
[https://lewky.cn]
給超鏈起一個別名:
[233|https://lewky.cn]
此外,可以直接輸入JIRA的issue id,會自動轉換成特定的超鏈。
轉義字元
有些特殊字元在JIRA中具有特殊效果,如果需要輸入這些字元,需要進行轉義。JIRA使用的轉義字元是\
,用法如下:
\{
表情符號
JIRA支援通過輸入一些特定的組合字元來顯示成對應的表情符號,比如:
:) :( :P :D ;) (y) (n) (i) (/) (x) (!)
(+) (-) (?) (on) (off) (*) (*r) (*g) (*b) (*y) (flag)
(flagoff)
高階文字格式
可以通過{panel}
來顯示一個模板塊,如下:
{panel}
Some text
{panel}
可以給這個panel起標題:
{panel:title=My Title}
Some text with a title
{panel}
還可以給這個panel設定css屬性:
{panel:title=My Title|borderStyle=dashed|borderColor=#ccc|titleBGColor=#F7D6C1|bgColor=#FFFFCE}
a block of text surrounded with a *panel*
yet _another_ line
{panel}
程式碼塊
程式碼塊通過{code}
來使用:
{code:xml}
<test>
<another tag="attribute"/>
</test>
{code}
建議給程式碼塊設定對應的語言,譬如上邊的xml,這樣寫的好處是程式碼塊可以自動使用對應語言的程式碼高亮,並且當代碼過長時會自動生成滾動條,不至於讓程式碼塊佔據頁面的一大塊地方。
同樣可以給程式碼塊設定標題和css屬性:
{code:title=Bar.java|borderStyle=solid}
// Some comments here
public String getFoo()
{
return foo;
}
{code}