diff options
| author | reptee <[email protected]> | 2025-09-15 12:45:28 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-09-15 12:45:28 +0200 |
| commit | a0cfb3fd31bc3729266cc3a7aaac1416df183445 (patch) | |
| tree | 188945541576851557ac34e3b19c01cd45bd0197 /test/vimdoc/headers.vimdoc | |
| parent | 0ce85b0cfa8e5d3155dddc77b1408b4d7d7890fa (diff) | |
Vimdoc writer (#11132)
Support for vimdoc, documentation format used by vim in its help pages.
Relies heavily on definition lists and precise text alignment to generate tags.
Diffstat (limited to 'test/vimdoc/headers.vimdoc')
| -rw-r--r-- | test/vimdoc/headers.vimdoc | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/test/vimdoc/headers.vimdoc b/test/vimdoc/headers.vimdoc new file mode 100644 index 000000000..a73e69770 --- /dev/null +++ b/test/vimdoc/headers.vimdoc @@ -0,0 +1,94 @@ + Type |gO| to see the table of contents. + +unremarkable header 1 .................................. |unremarkable-header-1| + unremarkable header 2 ................................ |unremarkable-header-2| + unremarkable header 2 .............................. |unremarkable-header-2-1| +bold italic underline strikethrough .................................. |short11| + superscript2 subscript3 ............................................ |short21| +Long header 1 long header 1 long header 1 long header 1 long header 1... |long1| + Long header 2 long header 2 long header 2 long header 2 long heade... |long21| + Long header 2 long header 2 long header 2 long header 2 long heade... |long22| +... |long-header-1-long-header-1-long-header-1-long-header-1-long-header-1-long-header-1-long-header-1| + ... |long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2| + ... |long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-1| + + +Headers with a short title and implicit ref. Last 3 headers are unnumbered. + +============================================================================== +unremarkable header 1 *unremarkable-header-1* + +------------------------------------------------------------------------------ +unremarkable header 2 *unremarkable-header-2* + +UNREMARKABLE HEADER 3 *unremarkable-header-3* + +UNREMARKABLE HEADER 3 *unremarkable-header-3-1* + +------------------------------------------------------------------------------ +unremarkable header 2 *unremarkable-header-2-1* + +UNREMARKABLE HEADER 3 *unremarkable-header-3-2* + +UNREMARKABLE HEADER 3 *unremarkable-header-3-3* + + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + +Headers with various inline elements + +============================================================================== +bold italic underline strikethrough *short11* + +------------------------------------------------------------------------------ +superscript2 subscript3 *short21* + +SMALLCAPS `code` `$inline math$` `$display math$` *short31* + +LINK example.com *short32* + + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + +Headers with a long name and explicit short ref + +============================================================================== +Long header 1 long header 1 long header 1 long header 1 long header 1 long header 1 long header 1 *long1* + +------------------------------------------------------------------------------ +Long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 *long21* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long31* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long32* + +------------------------------------------------------------------------------ +Long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 *long22* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long33* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long34* + + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + +Headers with a long name and implicit ref. + +Since implicit ref is very lengthy, there is no way to fit it. Therefore title +is not rendered and the references exceed the columns (textwidth) limit + +============================================================================== +Long header 1 long header 1 long header 1 long header 1 long header 1 long header 1 long header 1 *long-header-1-long-header-1-long-header-1-long-header-1-long-header-1-long-header-1-long-header-1* + +------------------------------------------------------------------------------ +Long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 *long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-1* + +------------------------------------------------------------------------------ +Long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 long header 2 *long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-long-header-2-1* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-2* + +LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 LONG HEADER 3 *long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-long-header-3-3* + + vim:tw=78:sw=4:ts=4:ft=help:norl:et: |