Skip to content

Commit 2574289

Browse files
committed
adding disclaimer to tagged region includes
1 parent cc9cba8 commit 2574289

File tree

1 file changed

+50
-10
lines changed

1 file changed

+50
-10
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -380,16 +380,6 @@ include::modules/module-filename.adoc[leveloffset=+1] <1>
380380
----
381381
<1> `[leveloffset=]` link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-with-leveloffset/#manipulate-heading-levels-with-leveloffset[is relative], and changes the header level of included content.
382382

383-
You can use `tag` attributes to link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions[define regions of a file and include by tag instead of the whole file.] This enables you to make conditional modifications to existing modules instead of duplicating content. When creating a tag, use a tag name that makes it easy to understand where the content defined will be included.
384-
385-
.Tagged module include syntax
386-
[source,text]
387-
====
388-
\include::modules/module-with-tags-filename.adoc[leveloffset=+1,tag=TagName]
389-
====
390-
391-
You can filter out the regions defined by a `tag` attribute by using link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/#tag-filtering[expressions] in place of or in conjunction with the tag name. If you add tag defined conditional content to a module with no existing tags, you must update existing includes of the file you are changing to exclude your content.
392-
393383
[IMPORTANT]
394384
====
395385
Including link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-lines/[lines by content ranges] can lead to content errors when the included file is subsequently updated and is not permitted.
@@ -407,6 +397,56 @@ When using the "Prerequisites", "Next steps", or "Additional resources" headings
407397
Only use `.` formatting (`.Additional resources`) to follow a module in an assembly. Because you cannot use the xrefs in modules, this functions as a _trailing include_ at the assembly level, where the `.` formatting of the `include` statement indicates that the resource applies specifically to the module and not to the assembly.
408398
====
409399

400+
=== Including by tags
401+
You can use `tag` attributes to link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions[define regions of a file and include by tag instead of the whole file.] This enables you to make conditional modifications to existing modules instead of duplicating content. When creating a tag, use a tag name that makes it easy to understand where the content defined will be included.
402+
403+
* In assembly files, use the `tags` (plural) attribute when there is more than one tag specified. Use the `tag` (singular) attribute when there is only one tag. For example:
404+
+
405+
.Singular tagged module include syntax
406+
[source,text]
407+
====
408+
\include::modules/module-with-tag-filename.adoc[leveloffset=+1,tag=TagName]
409+
====
410+
+
411+
.Plural tagged module include syntax
412+
[source,text]
413+
====
414+
\include::modules/module-with-tags-filename.adoc[leveloffset=+1,tags=TagName;Mode1;!Mode2]
415+
====
416+
417+
* In the module files, use `//` before the tag directives in asciidoc text and a `#` before tag directives in YAML. For example:
418+
+
419+
.Included file tag directives
420+
[source,text]
421+
----
422+
// tag::TagName[]
423+
== Tagging regions
424+
425+
Tags are useful when you want to identify specific regions of a file to include. You can then select the lines between the boundaries of the include tag/end directives to include using the tags attribute.
426+
427+
In the included file, the tag directives (e.g., tag::<tag_name>[] and end::<tag_name>[]) must follow a word boundary and precede a space character or the end of line. The tag name must not be empty and must consist exclusively of non-space characters.
428+
429+
.Example CR
430+
[source,yaml]
431+
--
432+
spec:
433+
# tag::Mode1[]
434+
mode: openshift
435+
# end::Mode1[]
436+
# tag::Mode2[]
437+
mode: openshift-network
438+
# end::Mode2[]
439+
--
440+
// end::TagName[]
441+
----
442+
+
443+
[WARNING]
444+
====
445+
The use of a wildcard (`*`) is not fully supported by PV1. Verify that access.redhat.com builds and docs.openshift.com builds are including or excluding content as expected if you try to use them.
446+
====
447+
448+
You can filter out the regions defined by a `tag` attribute by using link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/#tag-filtering[expressions] in place of or in conjunction with the tag name. If you add tag defined conditional content to a module with no existing tags, you must update existing includes of the file you are changing to exclude your content.
449+
410450
== Writing concepts
411451
A _concept_ contains information to support the tasks that users want to do and
412452
must not include task information like commands or numbered steps. In most

0 commit comments

Comments
 (0)