JIRA issue 中的標(biāo)記語言(Textile)

簡介

昨天忽然發(fā)現(xiàn),公司用的JIRA issue中,竟然是用Textile作為標(biāo)記語言。

這也是一種輕量級標(biāo)記語言,能力比流行的Markdown更強大,因為設(shè)計目的不同。Markdown是為了寫作而設(shè)計,而Textile是為了更快地寫HTML。
但是在JIRA上卻有諸多限制,也許是為了某種程度的簡單,而刪減掉了吧。

Textile 語法參考

第一個是中文,其它全是英文。

上述語法介紹,在 JIRA 上并非全部有效。

在 JIRA 上的有效語法

標(biāo)題

  • h1. 標(biāo)題一
  • h2. 標(biāo)題二
  • h3. 標(biāo)題三
  • h4. 標(biāo)題四
  • h5. 標(biāo)題五
  • h6. 標(biāo)題六

字體

顯示 輸入
黑體 *黑體*
斜體 _斜體_
刪除線 -刪除線-
<u>下劃線</u> +下劃線+
下標(biāo)sub 下標(biāo) ~sub~
上標(biāo)sup 上標(biāo) ^sup^

所有這些標(biāo)記基本都要保證*-這些字符不在一個英文單詞或中文句子的中間,否則無效。可以在外面再加一層空格。

引用

bq. 這是引用,不能換行。

這是引用,不能換行。

其實bq.能用已經(jīng)讓我很詫異了,因為其它b開頭的標(biāo)記都掛了。

Textile通常是用p.來區(qū)分段落的,而在JIRA上禁用它后用的是換行符,因此bq.只能作用于一行。

圖片

用兩個!包裹起來。

!/path/to/image!
!http://upload-images.jianshu.io/upload_images/245520-8d44d5e7c54148da.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240!
textile.png

不支持各種雜七雜八的Textile圖片語法,例如:

!/path/to/image 10w 20h!
!/path/to/image 20%x40%!
!/path/to/image 20%!
!/path/to/image (Alt text)!

這些統(tǒng)統(tǒng)不支持!

無序列表

Textile是只能用*,這里JIRA上可以用-

* 無序列表一
* 無序列表二
** 無序列表縮進(jìn)一次
*** 無序列表縮進(jìn)二次
** 無序列表縮進(jìn)一次
* 無序列表三
  • 無序列表一
  • 無序列表二
    • 無序列表縮進(jìn)一次
      • 無序列表縮進(jìn)二次
    • 無序列表縮進(jìn)一次
  • 無序列表三

有序列表

有序列表不用標(biāo)序。

# 有序列表一
# 有序列表二
## 有序列表縮進(jìn)一次
### 有序列表縮進(jìn)二次
## 有序列表縮進(jìn)一次
# 有序列表三
  1. 有序列表一
  2. 有序列表二
    1. 有序列表縮進(jìn)一次
      1. 有序列表縮進(jìn)二次
    2. 有序列表縮進(jìn)一次
  3. 有序列表三

表格

|| First name || Family name ||
| Stephen    | Hawking     |
| Steve      | Jobs        |
First name Family name
Stephen Hawking
Steve Jobs

只支持這種簡單表格。其中,|中的是左對齊單元格,||中的是居中對齊灰底加粗單元格,適合作為表頭。?

不支持各種Textile雜七雜八的表格語法。

鏈接

支持顯式鏈接、郵箱,例如:

https://en.wikipedia.org/wiki/Textile_(markup_language)
mail@company.com

直接可得:

https://en.wikipedia.org/wiki/Textile_(markup_language)
mail@company.com

不支持其它任何形式的隱式鏈接。

也支持 JIRA issue ID 號自動轉(zhuǎn)換為鏈接。

代碼

無論是Textile的內(nèi)聯(lián)代碼@inline@、還是代碼塊bc. code block,都不支持。

但是后來發(fā)現(xiàn),支持一個形式為{code:language}{code}的語法。

{code:java}
public class Hello {
    public static void main(String[] args) {
        System.out.println("Hello world!");
    }
}
{code}

效果如下:

一段簡單的Helloworld.png

比Markdown麻煩一些,但更明了。

不支持

  • 不支持腳注
  • 不支持對齊
  • 不支持縮進(jìn)
  • 不支持p.
  • 不支持pre.或pre..
  • 不支持特殊字符(c)(tm)等。
  • 不支持HTML插入

編輯器

我一般不用Textile,所以沒有研究過專門的編輯器。

在JIRA上,通過Firefox的Vimperator的Ctrl+i,把編輯區(qū)轉(zhuǎn)到Vim中編輯。

Plugin 'timcharper/textile.vim'

通過上述插件,可以實現(xiàn)語法高亮,比大多數(shù)Vim的Markdown插件好得多。
雖然也支持預(yù)覽,但是很遺憾我的工作平臺是Windows,沒有配置Ruby環(huán)境。

結(jié)語

我不知道為什么JIRA用的是Textile這種標(biāo)記語言,但總體來說,它的一些語法細(xì)節(jié)還是比流行的Markdown更合適做工作內(nèi)容交流。比如多重列表,在不能輸入TAB的網(wǎng)頁編輯區(qū)內(nèi),它就非常合適。


如果說前面都是一些可能會在工作中用到的技術(shù)記錄,那么后面就是感慨了。

我在這家公司,用這個系統(tǒng)已經(jīng)有一年半了,從來沒有人提起過、使用過其Textile功能!每一個issue的頁面,哪怕是會被自動導(dǎo)入每一個新項目的CR,也都是純文本的渣排版

很多issue內(nèi)容,是以圖片為第一內(nèi)容的,比如界面上出現(xiàn)了一個顯示問題。而現(xiàn)在所有的issue圖片,都作為附件的方式附在上面,打開前要手動下載!另外還有一種圖片,需要跳轉(zhuǎn)到另一個頁面觀看,但少有人用。除了因為上傳時稍微麻煩些,更重要的是,這種查看體驗和下載也沒什么區(qū)別。
如果換成Textile的圖片鏈接,顯然可以大幅提高工作效率。

Textile,或者任何一種標(biāo)記語言,對程序員來說都不算什么高門檻,沒人發(fā)現(xiàn)、沒人使用,更重要的還是一種技術(shù)的鈍感。對新技術(shù)缺乏渴望,對工作相關(guān)的事物全不在意,對提高自己和同事的工作效率毫無興趣。
而那些系統(tǒng)的維護(hù)者,對自己維護(hù)的JIRA系統(tǒng)不做任何推廣。新開發(fā)的小功能一封郵件了事,JIRA本身就有的功能也毫不傳播。我剛進(jìn)公司、不知JIRA為何物時,竟然沒有任何培訓(xùn)!直到現(xiàn)在,我們的JIRA上仍然充斥著不知道JIRA為何物的人,隨意地改狀態(tài)、寫comment、罵戰(zhàn)……
文案、issue的撰寫者,依舊滿足于在JIRA上用純文本加上各種自定義格式來表達(dá)想法、不行就用doc文件在各個地方傳來傳去,對既有的或新興的其它高效方式漠不關(guān)心。

在這樣的環(huán)境中,一年的工作經(jīng)驗可以用十年。

我不得不考慮……


話說,碰巧看到本文的諸位,你們?nèi)绻灿?a target="_blank" rel="nofollow">JIRA,可曾發(fā)現(xiàn)你們的issue中的標(biāo)記語言,是否也是縮減版Textile

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,321評論 6 543
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,559評論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,442評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,835評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 72,581評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,922評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,931評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,096評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,639評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 41,374評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,591評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,104評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,789評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,196評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,524評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,322評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 48,554評論 2 379

推薦閱讀更多精彩內(nèi)容