Add docs for tables, update roadmap

This commit is contained in:
Juno Takano 2026-02-16 14:26:59 -03:00
commit f3a997f29a

View file

@ -314,7 +314,7 @@ b
c c
` `
You still get "a b c" as a result. This is the case for paragraphs, but not for lists, verse blocks and preformatted text. Blockquotes support both modes. You still get "a b c" as a result. This is the case for paragraphs, but not for lists, verse blocks, tables and preformatted text. Blockquotes support both modes.
This is useful when editing your text, allowing you to break some thoughts and special syntax without losing control over where your paragraph ends, particularly when handling huge paragraphs. This is useful when editing your text, allowing you to break some thoughts and special syntax without losing control over where your paragraph ends, particularly when handling huge paragraphs.
@ -456,6 +456,50 @@ Lines starting with a `+` character will create numbered lists instead:
+ ni + ni
+ san + san
### Tables
Tables are blocks delimited by a sole `%` on its own line:
`
%
Country ! Capital
Colombia | Bogotá
Belgium | Brussels
Palestine | Jerusalem
Zambia | Lusaka
%
`
%
Country ! Capital
Colombia | Bogotá
Belgium | Brussels
Palestine | Jerusalem
Zambia | Lusaka
%
Table cells are delimited by either a `!` for headers or `|` for common cells. These delimiters must be surrounded by at least one space to each side and are optional at the first and last position of each line.
This means you can use any of the following formats:
`
%
middle | only
tail | only |
| lead | only
| fully | wrapped |
%
`
%
middle | only
tail | only |
| lead | only
| fully | wrapped |
%
Because at least one space is required around each delimiter, you must indent the table inside the surrounding `%` markers by at least one space.
## Rendering unformatted text ## Rendering unformatted text
The backtick character `\\`` can be used to render unformatted blocks and inline text: The backtick character `\\`` can be used to render unformatted blocks and inline text:
@ -482,25 +526,23 @@ Finally, you can precede any character with a `\\\\` to fully _escape_ that char
## Raw HTML ## Raw HTML
If you need some more advanced feature that is not supported directly by en's markup snytax, you can always just write plain HTML and it will be passed along. For example, you could render a table: If you need some more advanced feature that is not supported directly by en's markup snytax, you can always just write plain HTML and it will be passed along. For example, you could render a form:
` `
<table> <form style="text-align: center;">
<tr> <label for="name"> *__Name__* </label>
<td> Hi, </td> <input type="text" id="name"/>
<td> *HTML*! </td> <input type="submit"/>
</tr> </form>
</table>
` `
<table> <form style="text-align: center;">
<tr> <label for="name"> *__Name__* </label>
<td> Hi, </td> <input type="text" id="name"/>
<td> *HTML*! </td> <input type="submit"/>
</tr> </form>
</table>
Notice that, as shown in this example, you can mix en syntax and HTML. You might want to add a space between your HTML tags and en special syntax so the boundary is clearer, but otherwise they don't tend to overlap since the symbols most used in HTML are not special in en. Notice that, as shown in this example, you can mix en syntax and HTML. You might want to add a space between your HTML tags and en special syntax so the boundary is clearer, but otherwise they don't tend to overlap since the symbols most used in HTML are not special in en with the exception of `<`, which is interpreted specially only at the end of lines.
If you want to avoid either one of these syntaxes from being interpreted specially, you should escape the relevant characters as explained in the previous section. If you want to avoid either one of these syntaxes from being interpreted specially, you should escape the relevant characters as explained in the previous section.
""" """
@ -723,11 +765,7 @@ text = """
- [ ] Invert where redirects are set - [ ] Invert where redirects are set
- [x] Formatting - [x] Formatting
- [x] Blockquotes - [x] Blockquotes
- [ ] Tables - [x] Tables
- `%` block
- newline for rows
- indented, space-surrounded `!` wrap for headers
- indented, space-surrounded `|` wrap for cells
- [x] Nested formatting - [x] Nested formatting
- [x] Headers - [x] Headers
- [x] Preformatted blocks - [x] Preformatted blocks