search

asciidoctor / asciidoctor

:gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
https://asciidoctor.org
Other
4.78k stars 788 forks source link

Support docbook procedure element #1265

Open rockyallen opened 9 years ago

rockyallen commented 9 years ago

Improvement: Docbook has procedure/step/substep but Asciidoc doesn't seem to support it. Visually I can get close with an ordered list, but that doesn't help with producing a list of procedures, or cross referencing procedures eg "See procedure 15 - Replace Battery".

Syntax: The simplest would be an attribute [procedure] on ordered lists. This might preclude having lists as part of a step, but this isn't vital to me.

This imporvement would tie in well with request #1246 to label list items so you can reference individual steps.

mojavelinux commented 9 years ago

This idea has been raised once before. We left the conversation with design you have proposed, giving it additional merit. See https://github.com/asciidoctor/asciidoctor/issues/192#issuecomment-15321665. I think it's very reasonable to add this at least as part of the docbook backend.

Note that there's also an extension in the works that aims to do something similar. See https://github.com/asciidoctor/asciidoctor-extensions-lab/tree/master/lib/steps-postprocessor

mojavelinux commented 9 years ago

Also keep in mind that it's possible to achieve this before we implement it in core using a custom template for the olist node. For a starting point, see https://github.com/asciidoctor/asciidoctor-backends/blob/master/slim/docbook45/block_olist.xml.slim.