Skip to content

Commit bd60b49

Browse files
authored
Merge pull request #132 from redhat-documentation/file-name-corrections
file-name-corrections
2 parents 10c1482 + 1881103 commit bd60b49

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ These file naming guidelines are optional but highly recommended. However, if yo
3737
----
3838

3939
.Anchors
40-
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.
40+
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 the generated URL.
4141

4242
[source]
4343
----
@@ -87,7 +87,7 @@ You can use guided decision tables to ...
8787
[NOTE]
8888
.Note on Other Anchor Formats (Not Recommended)
8989
====
90-
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.
90+
The anchor 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 correctly. 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.
9191
====
9292

9393

0 commit comments

Comments
 (0)