Skip to content

Commit ec28c33

Browse files
authored
FCCEUD-54 Update the module type identifiers (#536)
* FCCEUD-54 Update the module type identifiers * FCCEUD-54 Peer review comments. * FCCEUD-54 Updating module identifier placement rules.
1 parent cefea77 commit ec28c33

File tree

3 files changed

+54
-48
lines changed

3 files changed

+54
-48
lines changed

pantheon-bundle/src/main/resources/SLING-INF/content/docs/assemblies/assembly-overview-of-modules.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ include::../modules/con_definition-of-a-module.adoc[]
1212
include::../modules/con_comparison-between-modules-and-DITA-topics.adoc[]
1313

1414
include::../modules/con_definition-of-metadata.adoc[]
15-
include::../modules/ref_identifying-module-types.adoc[]
15+
include::../modules/ref_adding-module-types_to_modules_in_Pantheon.adoc[]
1616

1717
ifdef::parent-context[:context: {parent-context}]
1818
ifndef::parent-context[:!context:]
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
:_module-type: REFERENCE
2+
[id='adding-module-types_to_modules_in_Pantheon_{context}']
3+
= Adding the module type to modules in {ProductShortName}
4+
5+
[role="_abstract"]
6+
In {ProductShortName}, you can search and filter modules by type: concept, procedure, or reference. You declare a module's type by adding an identifier to each module.
7+
8+
Use one or both of the following identifiers to declare the module's type:
9+
10+
* The `:_module-type:` attribute, preceding the module's ID
11+
* The corresponding prefix in the module's file name
12+
13+
{ProductShortName} {ProductNumber} first checks for the `:_module-type:` attribute. Any value other than those specified above is ignored. If there is no valid attribute, {ProductShortName} {ProductNumber} then checks if the module's file name includes a valid prefix. If both a valid attribute and prefix exist, {ProductShortName} {ProductNumber} uses the attribute.
14+
15+
16+
Attribute (preferred method)::
17+
Enter the correct attribute in the line before the module's ID to avoid build problems, choosing among the following:
18+
+
19+
* `:_module-type: CONCEPT`
20+
* `:_module-type: PROCEDURE`
21+
* `:_module-type: REFERENCE`
22+
+
23+
====
24+
.Example
25+
`:_module-type: REFERENCE`
26+
`[id='identifying-module-types_in_Pantheon_{context}']`
27+
28+
`= Identifying {ProductShortName} module types`
29+
====
30+
31+
Prefix::
32+
Begin the file names of modules with one of the following prefixes, followed by either an underscore or a hyphen:
33+
+
34+
* `con`
35+
* `proc`
36+
* `ref`
37+
+
38+
====
39+
.Examples: A reference module
40+
41+
Underscore after the prefix:
42+
43+
`**ref_**identifying-module-types.adoc`
44+
45+
Hyphen after the prefix:
46+
47+
`**ref-**identifying-module-types.adoc`
48+
49+
====
50+
51+
.Additional resources
52+
53+
* link:https://redhat-documentation.github.io/modular-docs/#writing-mod-docs[Types of modules in Red Hat documentation] in the _Modular Documentation Reference Guide_

pantheon-bundle/src/main/resources/SLING-INF/content/docs/modules/ref_identifying-module-types.adoc

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)