forks/vimwiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update header and definition list specs to support inline components

Browse Source
This commit is contained in:
Chip Senkbeil
2020-10-04 10:23:00 -05:00
committed by Tinmarino
parent 333b44a238
commit c3eff1dd0e
1 changed files with 9 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/specification.wiki
+9 -15
View File
@@ -119,14 +119,11 @@ It mirrors the functionality available in an [[https://developer.mozilla.org/en-
{{{vimwiki {{{vimwiki
Term 1:: Some definition Term 1:: Some definition
Term 2:: First def Term 2:: First def
:: Second def :: Second def with [[link]]
Term3:: Term3::
:: Some definition :: Some *bold* definition
}}} }}}
TODO ... should the definitions and terms be raw text? Or can they support
decorations and links? e.g. `Term 1:: *Bold* def with [[link]]`
===== Syntax ===== ===== Syntax =====
A *definition list* is composed of one or more [[#term and definitions|term and definitions]] A *definition list* is composed of one or more [[#term and definitions|term and definitions]]
@@ -136,16 +133,16 @@ zero or more [[#definition line|definition lines]]
A *term line* is represented by the following: A *term line* is represented by the following:
1. Starts at the beginning of a line 1. Starts at the beginning of a line
2. One or more characters before the sequence `::` 2. One or more [[#inline components|inline components]] before the sequence `::`
3. The sequence `::` 3. The sequence `::`
4. An optional one or more characters before [[#line ending|line ending]] 4. An optional one or more [[#inline components|inline components]] before [[#line ending|line ending]]
to be the first definition to be the first definition
5. A [[#line ending|line ending]] or end of input 5. A [[#line ending|line ending]] or end of input
A *definition line* is represented by the following: A *definition line* is represented by the following:
1. Starts at the beginning of a line 1. Starts at the beginning of a line
2. The sequence `::` 2. The sequence `::`
3. One or more characters before [[#line ending|line ending]] 3. One or more [[#inline components|inline components]] before [[#line ending|line ending]]
4. A [[#line ending|line ending]] or end of input 4. A [[#line ending|line ending]] or end of input
*Extra Notes*: Each term and definition is trimmed to remove all leading and *Extra Notes*: Each term and definition is trimmed to remove all leading and
@@ -173,14 +170,11 @@ A header is composed of some content surrounded by equals sign (`U+003D` aka
`=`) of equal length. It mirrors the functionality of the [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements|HTML Heading]]. `=`) of equal length. It mirrors the functionality of the [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements|HTML Heading]].
{{{vimwiki {{{vimwiki
= Some Heading = = Some Header =
== Some Sub Headering == == Some Sub Header ==
= *Bold* Header with [[link]] =
}}} }}}
TODO ... should the content of the header be raw text? Or can it support
decorations and links? e.g. `= *Bold* Header with [[link]] =`
Pandoc appears to support decorations, links, and other [[#inline components|inline components]]
===== Syntax ===== ===== Syntax =====
A *header* is represented by the following: A *header* is represented by the following:
@@ -188,7 +182,7 @@ A *header* is represented by the following:
2. Zero or more [[#whitespace character|whitespace characters]] (implying 2. Zero or more [[#whitespace character|whitespace characters]] (implying
whether or not a header is centered) whether or not a header is centered)
3. One or more equal sign (`U+003D`) characters 3. One or more equal sign (`U+003D`) characters
4. Any character until an equal number of equal sign characters are found 4. One or more [[#inline components|inline components]]
5. An equivalent number of equal sign characters as in step #3 5. An equivalent number of equal sign characters as in step #3
6. A [[#line ending|line ending]] or end of input 6. A [[#line ending|line ending]] or end of input