Backlog uses cookies to deliver our services. By visiting our website, you agree to the use of cookies as described in our Cookie Policy.

Now, we'll introduce you to the most frequently-used text formatting features provided by Wikis.

Headings

If your page features a lot of text, adding headings can make it much easier to read.

Markdown notation

Adding a “#” at the start of a line will designate that line as a heading. You must put a space after the #. “##” will create a level 2 header, while “###” will create a level 3 header.

Copy and paste the text below into your “Test” page, then click the “Submit” button.

# Plan
This feature requires revisions to both the batch and web app.

## Web app
Web app revision details.

## Batch
Batch revision details

# Implementation
Something noticed during implementation.

Backlog notation

Adding a “*” at the start of a line will designate that line as a heading. You must put a space after the #. “*” will create a level 2 header, while “***” will create a level 3 header.

Copy and paste the text below into your “Test” page, then click the “Submit” button.

* Plan
This feature requires revisions to both the batch and web app.

** Web app
Web app revision details.

** Batch
Batch revision details

* Implementation
Something noticed during implementation.

For some Wiki services, headings will automatically display a list of headings on that page. In Backlog's Wiki, a list of headings will display in the right-hand sidebar.

Lists

Another important formatting feature for readability is lists. Backlog's Wiki supports both bullet-pointed (“・”) and numbered (“1.”, “2.”, “3.”) lists.

Markdown notation

Adding a “ * ” at the start of a line will display that line as part of a list beginning with a “・”. You must put a space after the *. Putting four spaces before the * will make the line display as another list embedded within the first.

Adding a “1.” at the start of a line will display that line as part of a list beginning with “1.”. You must put a space after the “1.”. It doesn't matter if you number the following items sequentially with “2.”, “3.”, or just keep typing “1.”. When the list is displayed, the numbers will adjust automatically.

Copy and paste the following text into the contents of the “Test” page, then click the “Submit” button.

# Guidance for new employees
* Explanation of assignments
* Explanation of starting setup
  * PC setup
  * Printer setup
* Internal company processes
  * Attendance management
  * Conference room reservations

## PC setup process
1. Apply OS security updates
2. Install antivirus software
3. Install workplace standard software
  1. Web browser
  1. Office software
  1. Development tools

Backlog notation

Adding a “-” at the start of a line will display that line as part of a list beginning with a “・”. You must put a space after the -. Typing “—” will make the line display as another list embedded within the first.

Adding a “+” at the start of a line will display that line as part of a list beginning with “1.”. You must put a space after the +. Adding “++” to the start of a line will make the line display as another list embedded within the first.

Copy and paste the following text into the contents of the “Test” page, then click the “Submit” button.

* Guidance for new employees
- Explanation of assignments
- Explanation of starting setup
-- PC setup
-- Printer setup
- Internal company processes
-- Attendance management
-- Conference room reservations

** PC setup process
+ Apply OS security updates
+ Install antivirus software
+ Install workplace standard software
++ Web browser
++ Office software
++ Development tools

Embedded images

On a Wiki, you can embed images within pages. Using images can help make things that are hard to explain with words easy to understand.

Markdown notation

You can embed an image at a specified URL using the ![Alt text](Image URL) format. The alt text will be displayed if the image can't be loaded.

![Alt text](https://www.backlog.jp/img/common/header/logo_site.png)

Backlog notation

You can embed an image at a specified URL using the #image(Image URL) format. Unlike Markdown notation, you cannot specify the “[Alt text]” characters if the images are unable to be loaded.

#image(https://www.backlog.jp/img/common/header/logo_site.png)

Backlog also provides the option to embed images via our Cacoo online diagram tool. You can also upload image files directly to a Wiki page with any paid Backlog subscription.

Tables

Tables are another great way to make dense information easy to scan.

Markdown notation

Separating text with a “|” will display that text as a table. After your title line, you must include a line of only dashes (e.g. |---|---|---|), to represent the breaks. To right-align fields containing numbers, include a “:” at the far right of the line, as shown in the second table.

| Conference room name | Location | No. of Seats (Left-aligned) |
|----------------------|----------|-----------------------------|
| Gorilla | 1F | 6 |
| Giraffe | 2F | 2 |
| Dog | 3F | 4 |

| Conference room name | Location | No. of Seats (Right-aligned) |
|----------------------|----------|------------------------------:|
| Gorilla | 1F | 6 |
| Giraffe | 2F | 2 |
| Dog | 3F | 4 |

Backlog notation

Separating text with a “|” will display that text as a table. Adding an “h” at the end of a line will display that line as the title line. Adding a ~ at the start of a cell will designate that cell as a title line. You cannot right-align numbers in Backlog notation.

| Conference room name | Location | No. of Seats |h
| Gorilla | 1F | 6 |
| Giraffe | 2F | 2 |
| Dog | 3F | 4 |

|~ Conference room name | Gorilla | Giraffe | Dog |
|~ Location | 1F | 2F | 3F |
|~ No. of seats | 6 | 2 | 4 |

When using Backlog notation, you can easily modify an existing table. Just hover your cursor over the chart and an edit button will appear in the top-left of the table. Click this button to display an input field for each cell which will allow you to edit them directly. You can also add or delete rows.