Back to Details

backlog-notation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

backlog-notation

Backlog記法

Backlog notation (Backlog記法) syntax reference. This is not Markdown — do not mix the two syntaxes.
Backlog記法（Backlog notation）语法参考。这不是Markdown——请勿混用两种语法。

Quick Reference

快速参考

FeatureSyntax
Heading
* H1
/ 
** H2
/ 
*** H3
/ 
**** H4
Bold
''text''
Italic
'''text'''
Strikethrough
%%text%%
Color
&color(red) { text }
Color + background
&color(#fff, #333) { text }
Bullet list
- item
(nest with 
--
)
Numbered list
+ item
(nest with 
++
)
Checklist
- [ ] todo
/ 
- [x] done
(issue descriptions only)
Link
[[https://example.com]]
Labeled link
[[label>https://example.com]]
Issue link
PROJECT-123
(auto-linked)
Quote
> text
or 
{quote}...{/quote}
Code block
{code}...{/code}
Code (lang)
{code:java}...{/code}
Image
#image(URL or filename)
Thumbnail
#thumbnail(URL or filename)
(< 200KB)
Table of contents
#contents
Line break
&br;
Escape
\
before special characters
功能语法
标题
* H1
/ 
** H2
/ 
*** H3
/ 
**** H4
粗体
''text''
斜体
'''text'''
删除线
%%text%%
文字颜色
&color(red) { text }
文字颜色+背景色
&color(#fff, #333) { text }
无序列表
- item
（嵌套使用
--
）
有序列表
+ item
（嵌套使用
++
）
复选列表
- [ ] todo
/ 
- [x] done
（仅支持问题描述）
链接
[[https://example.com]]
带标签的链接
[[label>https://example.com]]
问题链接
PROJECT-123
（自动链接）
引用
> text
或 
{quote}...{/quote}
代码块
{code}...{/code}
带语言标识的代码块
{code:java}...{/code}
图片
#image(URL or filename)
缩略图
#thumbnail(URL or filename)
（小于200KB）
目录
#contents
换行
&br;
转义在特殊字符前添加
\

Tables

表格

Separate cells with 
|
. End a row with 
h
for a header row. Prefix a cell with 
~
for a row header. Use 
>
to merge a cell with the one to its left.
|Name|Value|Note|h
|~Header|data 1|data 2|
|Span two||>|
使用
|
分隔单元格。在行尾添加
h
标记表头行。在单元格前添加
~
标记行表头。使用
>
将单元格与其左侧单元格合并。
|Name|Value|Note|h
|~Header|data 1|data 2|
|Span two||>|

Markdown → Backlog Notation Conversion

Markdown → Backlog記法转换

MarkdownBacklog Notation
# H1
* H1
**bold**
''bold''
*italic*
'''italic'''
~~strike~~
%%strike%%
1. item
+ item
```
{code}
/ 
{/code}
[text](url)
[[text>url]]
![alt](url)
#image(url)
|---|
separator
|h
at end of row
N/A
&color(red) { text }
Markdown语法Backlog記法
# H1
* H1
**bold**
''bold''
*italic*
'''italic'''
~~strike~~
%%strike%%
1. item
+ item
```
{code}
/ 
{/code}
[text](url)
[[text>url]]
![alt](url)
#image(url)
|---|
分隔符		在行尾添加
|h
无对应语法
&color(red) { text }

Gotchas

注意事项

  • No inline code syntax — only block-level 
    {code}...{/code}
  • {quote}
    blocks cannot be nested
  • Checklists work only in issue descriptions, not in comments or wikis
  • Supported code languages: 
    java
    , 
    cs
    , 
    js
    , 
    python
    , 
    ruby
    , 
    perl
    , 
    php
    , 
    sql
    , 
    html
    , 
    xml
    , 
    css
    , 
    shell
    , etc.
  • 不支持行内代码语法——仅支持块级的
    {code}...{/code}
  • {quote}
    块无法嵌套
  • 复选列表仅在问题描述中可用，不适用于评论或维基页面
  • 支持的代码语言：
    java
    、
    cs
    、
    js
    、
    python
    、
    ruby
    、
    perl
    、
    php
    、
    sql
    、
    html
    、
    xml
    、
    css
    、
    shell
    等