You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
11
+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
12
12
////
13
13
:_mod-docs-content-type: ASSEMBLY
14
14
@@ -18,23 +18,19 @@ Metadata attribute that will help enable correct parsing and conversion to the a
18
18
* ID: [id="assembly-my-user-story_{context}"]
19
19
* Title: = My user story
20
20
21
-
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. Include {context} in the ID so the assembly can be reused.
22
-
////
23
-
[id="assembly-my-user-story_{context}"]
24
-
= My user story
21
+
ID is a unique identifier that can be used to reference this assembly. Avoid changing it after the module has been published to ensure existing links are not broken. Include {context} in the ID so the assembly can be reused.
25
22
26
-
////
27
23
Be sure to include a line break between the title and the :context: variable and the :context: variable and the assembly introduction.
28
-
29
24
If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.
30
25
////
31
-
32
-
:context: assembly-keyword
33
-
26
+
[id="assembly-my-user-story_{context}"]
27
+
= My user story
34
28
////
35
29
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
36
30
////
37
31
32
+
:context: assembly-keyword
33
+
38
34
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.
39
35
40
36
== Prerequisites
@@ -47,16 +43,15 @@ This paragraph is the assembly introduction. It explains what the user will acco
47
43
48
44
////
49
45
The following include statements pull in the module files that comprise the assembly. Include any combination of concept, procedure, or reference modules required to cover the user story. You can also include other assemblies.
[leveloffset=+1] ensures that when a module title is a level 1 heading (= Title), the heading will be interpreted as a level-2 heading (== Title) in the assembly. Use [leveloffset=+2] and [leveloffset=+3] to nest modules in an assembly.
48
+
49
+
Add a blank line after each 'include::' statement.
Copy file name to clipboardExpand all lines: modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
////
2
-
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
2
+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
3
3
////
4
4
5
5
:_mod-docs-content-type: CONCEPT
@@ -10,17 +10,17 @@ Base the file name and the ID on the module title. For example:
10
10
* ID: [id="my-concept-module-a_{context}"]
11
11
* Title: = My concept module A
12
12
13
-
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.
13
+
ID is a unique identifier that can be used to reference this module. Avoid changing it after the module has been published to ensure existing links are not broken.
14
14
15
15
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
16
+
17
+
Be sure to include a line break between the title and the module introduction.
16
18
////
17
19
18
20
[id="my-concept-module-a_{context}"]
19
21
= My concept module A
20
22
////
21
23
In the title of concept modules, include nouns or noun phrases that are used in the body text. This helps readers and search engines find the information quickly. Do not start the title of concept modules with a verb or gerund. See also _Wording of headings_ in _IBM Style_.
22
-
23
-
Be sure to include a line break between the title and the module introduction.
24
24
////
25
25
26
26
Write a short introductory paragraph that provides an overview of the module.
Copy file name to clipboardExpand all lines: modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
2
2
////
3
-
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
3
+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
4
4
////
5
5
6
6
:_mod-docs-content-type: PROCEDURE
@@ -11,16 +11,17 @@ Base the file name and the ID on the module title. For example:
11
11
* ID: [id="doing-procedure-a_{context}"]
12
12
* Title: = Doing procedure A
13
13
14
-
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.
14
+
ID is a unique identifier that can be used to reference this module. Avoid changing it after the module has been published to ensure existing links are not broken.
15
15
16
16
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
17
+
18
+
Be sure to include a line break between the title and the module introduction.
17
19
////
18
20
19
21
[id="doing-procedure-a_{context}"]
20
22
= Doing procedure A
21
23
////
22
24
Start the title of a procedure module with a gerund, such as Creating, Installing, or Deploying.
23
-
Be sure to include a line break between the title and the module introduction.
24
25
////
25
26
26
27
Write a short introductory paragraph that provides an overview of the module. The introduction should include what the module will help the user do and why it will be beneficial to the user. Include key words that relate to the module to maximize search engine optimization.
Copy file name to clipboardExpand all lines: modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
////
2
-
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
2
+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
3
3
////
4
4
:_mod-docs-content-type: REFERENCE
5
5
@@ -9,17 +9,18 @@ Base the file name and the ID on the module title. For example:
9
9
* ID: [id="my-reference-a_{context}"]
10
10
* Title: = My reference A
11
11
12
-
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.
12
+
ID is a unique identifier that can be used to reference this module. Avoid changing it after the module has been published to ensure existing links are not broken.
13
13
14
14
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
15
+
16
+
Be sure to include a line break between the title and the module introduction.
15
17
////
16
18
17
19
[id="reference-material_{context}"]
18
20
= Reference material
19
21
////
20
22
In the title of a reference module, include nouns that are used in the body text. For example, "Keyboard shortcuts for ___" or "Command options for ___." This helps readers and search engines find the information quickly.
21
-
22
-
Be sure to include a line break between the title and the module introduction.
23
+
on.
23
24
////
24
25
25
26
Write a short introductory paragraph that provides an overview of the module.
0 commit comments