Skip to content

Latest commit

 

History

History
71 lines (58 loc) · 3.32 KB

LIMITATIONS.adoc

File metadata and controls

71 lines (58 loc) · 3.32 KB
Raw

Limitations

This is a rough-and-ready list of current-state features, planned features, and non-features.

Language Features in a Non-Working State

  • Section IDs are not auto-generated

  • Custom IDs/reference text

Working Caveats

Tables

Tables are rendered as expected, save that asciidocr does not currently respect column width designations; cols="3,1,1" will still produce a three-column table, but with columns of "default" widths. Tables also do not currently support spanning columns or rows; if you require this functionality, please use an HTML table in a passthrough block.

Language Features Planned for Inclusion Later

  • block style attribute short hand — I’m both not a fan (just use role= and , etc.!) and parsing this is going to be semi-annoying so I shall put it off.

  • Hardbreaks-option attribute (which we shall include for our poet friends who don’t want to have to wrap everything in [verse])

  • Author information

  • Revision information

  • Document metadata

  • Document types

  • Section Attributes and styles

  • Paragraph alignment and indented blocks

  • Substitutions

  • Checklists

  • Autolinks (for now, just use the url[text] or url[] syntax)

  • mailto:

  • Footnote:id syntax (this may not happen)

  • Icons

  • Keyboard/button/etc. macros (I mean to target "writers," first, then "technical writers" at some later point).

  • Syntax highlighting for source blocks

  • Code callous

  • STEM and equations

  • Automatic Tables of Contents

  • Deeply nested description lists (in the meantime: just use an open block)

  • Discrete Headings

Language Features Not Currently Planned for Inclusion

Audio and video:: Maybe… later? Not part of the current project target(s), which are more document-focused.

Externalized footnotes:: I think that it’s clearer to include footnote text where it ought to go (and don’t really believe there are many great footnote reuse use-cases); Supporting this would require a second-pass on the attribute parsing, which we’re not really doing at the moment. Can be added later, but no plans currently.

Counters

Given that these are a "poorly defined feature in Asciidoc," and I’ve never, myself, found a use for them, there are no plans for support.

Conditionals

This probably wouldn’t be too hard to implement, but (selfishly) I’ve yet to find a need for these, so have no current plans for supporting them. If this is of interest, open an issue.

Collapsible blocks:: Again, this feels a more web-oriented feature; at least for the moment, we’re targeting document creation.