Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion templates/procedure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,18 @@ NOTE: You can add text, tables, code examples, images, and other items to a step
{%- endif %}

////
Only the following block headings can be reliably mapped to DITA: Prerequisites, Procedure, Verification, Troubleshooting, Troubleshooting steps, Next steps, Next step, Additional resources. They must appear in this order and, with the exception of Additional resources, are only allowed in a procedure module. You can also use block headings in figure, table, and example titles.
Only the following block titles can be reliably mapped to DITA:

* Prerequisites or Prerequisite
* Procedure
* Verification, Results, or Result
* Troubleshooting, Troubleshooting steps, or Troubleshooting step
* Next steps or Next step
* Additional resources

With the exception of Additional resources, these titles are only allowed in a procedure module. You can use each title exactly once and cannot use two different variants of the same title in the same module.

Additionally, you can use block titles for figures, tables, and example blocks.
////
.Verification
{% if examples -%}
Expand Down
13 changes: 12 additions & 1 deletion tests/generated/proc_testing-a-procedure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,18 @@ Write a short introductory paragraph that provides an overview of the module. Th
NOTE: You can add text, tables, code examples, images, and other items to a step. However, these items must be connected to the step with a plus sign (+). Any items under the .Procedure heading and before one of the following approved headings that are not connected to the last step with a plus sign cannot be converted to DITA.

////
Only the following block headings can be reliably mapped to DITA: Prerequisites, Procedure, Verification, Troubleshooting, Troubleshooting steps, Next steps, Next step, Additional resources. They must appear in this order and, with the exception of Additional resources, are only allowed in a procedure module. You can also use block headings in figure, table, and example titles.
Only the following block titles can be reliably mapped to DITA:

* Prerequisites or Prerequisite
* Procedure
* Verification, Results, or Result
* Troubleshooting, Troubleshooting steps, or Troubleshooting step
* Next steps or Next step
* Additional resources

With the exception of Additional resources, these titles are only allowed in a procedure module. You can use each title exactly once and cannot use two different variants of the same title in the same module.

Additionally, you can use block titles for figures, tables, and example blocks.
////
.Verification
Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.
Expand Down