Skip to content

Commit 6e8777e

Browse files
authored
Merge pull request #48 from jhradilek/procedure-titles
Add a complete list of supported block titles
2 parents 3814685 + 437a0ac commit 6e8777e

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

templates/procedure.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,18 @@ NOTE: You can add text, tables, code examples, images, and other items to a step
5252
{%- endif %}
5353
5454
////
55-
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.
55+
Only the following block titles can be reliably mapped to DITA:
56+
57+
* Prerequisites or Prerequisite
58+
* Procedure
59+
* Verification, Results, or Result
60+
* Troubleshooting, Troubleshooting steps, or Troubleshooting step
61+
* Next steps or Next step
62+
* Additional resources
63+
64+
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.
65+
66+
Additionally, you can use block titles for figures, tables, and example blocks.
5667
////
5768
.Verification
5869
{% if examples -%}

tests/generated/proc_testing-a-procedure.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,18 @@ Write a short introductory paragraph that provides an overview of the module. Th
4040
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.
4141
4242
////
43-
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.
43+
Only the following block titles can be reliably mapped to DITA:
44+
45+
* Prerequisites or Prerequisite
46+
* Procedure
47+
* Verification, Results, or Result
48+
* Troubleshooting, Troubleshooting steps, or Troubleshooting step
49+
* Next steps or Next step
50+
* Additional resources
51+
52+
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.
53+
54+
Additionally, you can use block titles for figures, tables, and example blocks.
4455
////
4556
.Verification
4657
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.

0 commit comments

Comments
 (0)