Skip to content

Commit 2782623

Browse files
committed
issues-109-111-115 updated with review comments
1 parent 0d99d68 commit 2782623

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

modular-docs-manual/content/topics/module_anchor-and-file-names-concept.adoc

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
To optimize modular documentation, follow these guidelines for naming files and creating anchors:
55

66
.File names
7-
Assembly and module file names should accurately and closely reflect the title of the assembly or module. File names should have the format `prefix-filename.adoc` or `prefix_filename.adoc` where `prefix` is one of the following module prefixes:
7+
Create assembly and module file names that accurately and closely reflect the title of the assembly or module. Create file names with the format `prefix-filename.adoc` or `prefix_filename.adoc` where `prefix` is one of the following module prefixes:
88

99
* `con`: Concept module prefix
1010
* `proc`: Procedure module prefix
@@ -13,11 +13,13 @@ Assembly and module file names should accurately and closely reflect the title o
1313

1414
.Examples
1515
* `con-guided-decision-tables.adoc` (Concept module)
16+
* `con_guided-decision-tables.adoc` (Concept module)
1617
* `proc-creating-guided-decision-tables.adoc` (Procedure module for creating)
17-
* `proc-editing-guided-decision-tables.adoc` (Procedure module for editing)
18+
* `proc_creating-guided-decision-tables.adoc` (Procedure module for creating)
1819
* `ref-guided-decision-table-examples.adoc` (Reference module with examples)
19-
* `ref-guided-decision-table-columns.adoc` (Reference module with column types)
20+
* `ref_guided-decision-table-examples.adoc` (Reference module with examples)
2021
* `assembly-designing-guided-decision-tables.adoc` (Assembly of guided decision table modules)
22+
* `assembly_designing-guided-decision-tables.adoc` (Assembly of guided decision table modules)
2123

2224

2325
[NOTE]
@@ -27,8 +29,6 @@ Do not include special characters in file names. Ensure that all members of your
2729

2830
These file naming guidelines are optional but highly recommended. However, if your team does not include the module prefixes in file names followed by either a hyphen (-) or an underscore (_), you must include one of the following variables in each concept, procedure, and reference module:
2931

30-
NOTE: This is a Pantheon 2 requirement.
31-
3232
[source]
3333
----
3434
:system-module-type: CONCEPT
@@ -39,8 +39,8 @@ NOTE: This is a Pantheon 2 requirement.
3939

4040

4141
.Anchors
42-
At the top of every module, provide an anchor in the format `+++[id="filename_{context}"]+++` where `filename` is the exact name of the file, without the file extension (`.adoc`). Module anchors are necessary so that the module can be identified by Asciidoctor when reused or cross-referenced. The `{context}` variable is intentionally not defined in the module anchor ID. You define a context value in each assembly, in the format `:context: my-context-value`. This enables the context variable in each module to be populated according to the relevant assembly.
43-
--
42+
At the top of every module, provide an anchor in the format `+++[id="filename_{context}"]+++` where `filename` is the exact name of the file, without the file extension (`.adoc`). Module anchors are necessary so that Asciidoctor can identify the module when the module is reused or cross-referenced. The `context` variable is defined in each assembly module, for example `:context: my-context-value`. When you build an assembly, the value of the `context` variable replaces `{context}` in each module anchor ID and appears in generated URL.
43+
4444
[source]
4545
----
4646
[id="filename_{context}"]
@@ -53,13 +53,22 @@ The first sentence of the topic.
5353
[source]
5454
----
5555
[id="con-guided-decision-tables_{context}"]
56+
= Guided Decision Tables
5657
58+
The guided decision tables feature works similarly to ...
59+
----
60+
61+
.Example 2. Concept Module
62+
[source]
63+
----
64+
[id="con_guided-decision-tables_{context}"]
5765
= Guided Decision Tables
5866
5967
The guided decision tables feature works similarly to ...
6068
----
6169

62-
.Example 2. Procedure Module
70+
71+
.Example 3. Procedure Module
6372
[source]
6473
----
6574
[id="proc-creating-guided-decision-tables_{context}"]
@@ -68,13 +77,22 @@ The guided decision tables feature works similarly to ...
6877
You can use guided decision tables to ...
6978
----
7079

80+
.Example 4. Procedure Module
81+
[source]
82+
----
83+
[id="proc_creating-guided-decision-tables_{context}"]
84+
= Creating Guided Decision Tables
85+
86+
You can use guided decision tables to ...
87+
----
88+
7189
[NOTE]
7290
.Note on Other Anchor Formats (Not Recommended)
7391
====
7492
The format defined here is recommended because it is the most stable and versatile of anchor formats, and supports variables that enable topics to be reused and cross-referenced properly. For details, see xref:reusing-modules[]. Other anchor formats include `+++[[anchor-name]]+++` and `+++[#anchor-name]+++`, but these formats either do not support variables for content reuse or do not support certain character types, such as periods. These limitations cause errors at build time.
7593
====
7694

77-
--
95+
7896

7997
.Additional Resources
8098

0 commit comments

Comments
 (0)