Skip to content

Commit

Permalink
docs: add documentation about table cells merging
Browse files Browse the repository at this point in the history
  • Loading branch information
main-kun committed Jun 10, 2024
1 parent b40aa1a commit 4df2750
Show file tree
Hide file tree
Showing 2 changed files with 221 additions and 3 deletions.
114 changes: 112 additions & 2 deletions en/syntax/tables/multiline.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Tables with support inside cells for more than just simple content. Example, [lists](../lists.md), [code snippets](../code.md) and other tables.

### Syntax {#syntax}
## Syntax {#syntax}

* a table starts with `#|` and ends with `|#`;
* lines start and end with `||`;
Expand All @@ -28,7 +28,7 @@ Multiline tables do not contain headers, but they can be done by applying format
|| Text | Text ||
|#

### Multiline content {#multirow}
## Multiline content {#multirow}

Any multiline content can be placed in a table cell. For example, lists.

Expand Down Expand Up @@ -97,3 +97,113 @@ Text after other table||
|| 3
| 4||
|#


## Cell Merging {#span}

Cells can be merged vertically using the "^" symbol:

```markdown
#|
|| Header1 | Header2 ||
|| Text spanning two rows | Another text ||
|| ^ | More text ||
|#
```

**Result**

#|
|| Header1 | Header2 ||
|| Text spanning two rows | Another text ||
|| ^ | More text ||
|#


Horizontal merging is supported with the ">" symbol:

```markdown
#|
|| Header1 | Header2 ||
|| Text spanning two columns | > ||
|| Another text | More text ||
|#
```

**Result**

#|
|| Header1 | Header2 ||
|| Text spanning two columns | > ||
|| Another text | More text ||
|#

Merging symbols can be used together:

```markdown
#|
|| Header1 | Header2 | Header3 ||
|| Text spanning two columns and two rows | > | Text ||
|| ^ | > | More text ||
|#
```

**Result**

#|
|| Header1 | Header2 | Header3 ||
|| Text spanning two columns and two rows | > | Text ||
|| ^ | > | More text ||
|#

### Text Alignment in Cells

To control the alignment of text in cells, you can use attribute syntax within the cells:

```markdown
#|
|| Header1 | Header2 | Header3 ||
|| Text spanning two columns and two rows {.cell-align-center} | > | Text ||
|| ^ | > | More text ||
|#
```

**Result**

#|
|| Header1 | Header2 | Header3 ||
|| Text spanning two columns and two rows {.cell-align-center} | > | Text ||
|| ^ | > | More text ||
|#

The following alignment options are available:

- cell-align-top-left
- cell-align-top-center
- cell-align-top-right
- cell-align-center
- cell-align-bottom-left
- cell-align-bottom-center
- cell-align-bottom-right

### Escaping Cell Merging Symbols

To include a merging symbol as plain text in a cell, use escaping with "",
i.e., "\^" and "\>".

```markdown
#|
|| Header1 | Header2 | Header3 ||
|| Text in one cell | \> | Text ||
|| \^ | \> | More text ||
|#
```

**Result**

#|
|| Header1 | Header2 | Header3 ||
|| Text in one cell | \> | Text ||
|| \^ | \> | More text ||
|#

110 changes: 109 additions & 1 deletion ru/syntax/tables/multiline.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
на двух строчках
|
- Текс 1
- Тект 2
- Тект 2[cell_merging_guide.md](..%2F..%2F..%2F..%2F..%2FDocuments%2Fcell_merging_guide.md)
- Текст 3
- Текст 4||
|#
Expand Down Expand Up @@ -97,3 +97,111 @@
|| 3
| 4||
|#

## Объединение ячеек {#span}

Ячейки можно объединять вертикально с помощью ячейки с символом "^":

```markdown
#|
|| Заголовок1 | Заголовок2 ||
|| Текст на два ряда | Другой текст ||
|| ^ | Еще текст ||
|#
```

**Результат**

#|
|| Заголовок1 | Заголовок2 ||
|| Текст на два ряда | Другой текст ||
|| ^ | Еще текст ||
|#


Горизонтальное объединение поддерживается через символ ">":

```markdown
#|
|| Заголовок1 | Заголовок2 ||
|| Текст на две колонки | > ||
|| Другой текст | Еще текст ||
|#
```

**Результат**

#|
|| Заголовок1 | Заголовок2 ||
|| Текст на две колонки | > ||
|| Другой текст | Еще текст ||
|#

Символы объединения ячеек можно использовать вместе:

```markdown
#|
|| Заголовок1 | Заголовок2 | Заголовок3 ||
|| Текст на две колонки и два ряда | > | Текст ||
|| ^ | > | Еще текст ||
|#
```

**Результат**

#|
|| Заголовок1 | Заголовок2 | Заголовок3 ||
|| Текст на две колонки и два ряда | > | Текст ||
|| ^ | > | Еще текст ||
|#

### Выравнивание текста в ячейках

Для контроля за выравниванием ячеек можно использовать синтаксис атрибутов внутри ячеек:

```markdown
#|
|| Заголовок1 | Заголовок2 | Заголовок3 ||
|| Текст на две колонки и два ряда {.cell-align-center} | > | Текст ||
|| ^ | > | Еще текст ||
|#
```

**Результат**

#|
|| Заголовок1 | Заголовок2 | Заголовок3 ||
|| Текст на две колонки и два ряда {.cell-align-center} | > | Текст ||
|| ^ | > | Еще текст ||
|#

Доступны следующие опции для выравнивания:

- cell-align-top-left
- cell-align-top-center
- cell-align-top-right
- cell-align-center
- cell-align-bottom-left
- cell-align-bottom-center
- cell-align-bottom-right

### Экранирование символов объединения ячеек

Для того чтобы получить клетку с одним из символов объединения ячеек внутри можно использовать экранирование через "\",
т.е. "\^" и "\>".

```markdown
#|
|| Заголовок1 | Заголовок2 | Заголовок3 ||
|| Текст на одну ячейку | \> | Текст ||
|| \^ | \> | Еще текст ||
|#
```

**Результат**

#|
|| Заголовок1 | Заголовок2 | Заголовок3 ||
|| Текст на одну ячейку | \> | Текст ||
|| \^ | \> | Еще текст ||
|#

0 comments on commit 4df2750

Please sign in to comment.