Skip to content

Commit 246f52b

Browse files
committed
Update the modular templates to match upstream changes:
* Clarify rules for text following [role="_abstract"] in the templates #160 * Inconsistent module IDs in the procedure module template #155
1 parent 122f6c3 commit 246f52b

File tree

4 files changed

+9
-6
lines changed

4 files changed

+9
-6
lines changed

data/templates/assembly.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The `context` attribute enables module reuse. Every module ID includes {context}
3434
3535
[role="_abstract"]
3636
{% if examples -%}
37-
This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
37+
This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on.
3838
{%- endif %}
3939
4040
== Prerequisites

data/templates/concept.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ In the title of concept modules, include nouns or noun phrases that are used in
2727

2828
[role="_abstract"]
2929
{% if examples -%}
30-
Write a short introductory paragraph that provides an overview of the module. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
30+
Write a short introductory paragraph that provides an overview of the module.
3131

3232
The contents of a concept module give the user descriptions and explanations needed to understand and use a product.
3333

data/templates/procedure.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
////
22
Base the file name and the ID on the module title. For example:
33
* file name: proc-doing-procedure-a.adoc
4-
* ID: [id="doing-procedure-a_{context}"]
4+
* ID: [id="proc-doing-procedure-a_{context}"]
55
* Title: = Doing procedure A
66

77
The ID is an anchor that links to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
@@ -25,7 +25,9 @@ Start the title of a procedure module with a verb, such as Creating or Create. S
2525

2626
[role="_abstract"]
2727
{% if examples -%}
28-
Write a short introductory paragraph that provides an overview of the module. Procedure modules should include the steps that users perform and address user motivation.The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
28+
Write a short introductory paragraph that provides an overview of the module.
29+
30+
Procedure modules should include the steps that users perform and address user motivation.
2931
{%- endif %}
3032

3133
.Prerequisites

data/templates/reference.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ In the title of a reference module, include nouns that are used in the body text
2525

2626
[role="_abstract"]
2727
{% if examples -%}
28-
Write a short introductory paragraph that provides an overview of the module. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata. A reference module provides data that users might want to look up, but do not need to remember.
29-
It has a very strict structure, often in the form of a list or a table.
28+
Write a short introductory paragraph that provides an overview of the module.
29+
30+
A reference module provides data that users might want to look up, but do not need to remember. It has a very strict structure, often in the form of a list or a table.
3031
A well-organized reference module enables users to scan it quickly to find the details they want.
3132
AsciiDoc markup to consider for reference data:
3233

0 commit comments

Comments
 (0)