search

asciidoctor / asciidoctor-extensions-lab

A lab for testing and demonstrating Asciidoctor extensions. Please do not use this code in production. If you want to use one of these extensions in your application, create a new project, import the code, and distribute it as a RubyGem. You can then request to make it a top-level project under the Asciidoctor organization.
Other
104 stars 101 forks source link

Create summaries from distributed definitions #93

Closed ukubauka closed 9 months ago

ukubauka commented 6 years ago

OK, couldn't find a better title... Here is what I want to do: I am writing technical machine (not software :-) ) documentation using asciidoctor on atom. The machines are described by elements. With the element it is suitable to define the required maintenance work. Could be a small table, an admonition, ... whatever.

While for the writer it is suitable to have the maintenance described with the element, it is more suitable for the maintenance person to have a maintenance summary list at the end of the document.

I came up with tags and a self-including document, see code snippet below. Any better idea?

= Title

== Motor

Content not part of the maintenance tag

|===
| Element | Maintenance Instruction | Frequency

// tag::Maintenance[]
| icon:Maintenance[] <<Motor>> Oil | Change Motor Oil, use for salad | Daily
// end::Maintenance[]
|===

== Extruder

|===
| Element | Maintenance Instruction | Frequency

// tag::Maintenance[]
| icon:Maintenance[] <<Extruder>> Screw | Make nice & shiny | Before go to sleep
// end::Maintenance[]
|===

== Maintenance Summary

|===
| Element | Maintenance Instruction | Frequency

include::Source.adoc[tag=Maintenance]

|===
mojavelinux commented 9 months ago

If you are looking for help writing an extension, please ask in the project chat at https://chat.asciidoctor.org.