Merge pull request #15 from redhat-documentation/pantheon-2-metadata-14

Add Pantheon 2 metadata in the templates

Author: Marek Suchánek

src/module.rs

@@ -129,14 +129,22 @@ impl Input {
             title_with_replacements = title_with_replacements.replace("--", "-");
         }
 
-        title_with_replacements
+        let prefix = self.prefix();
+
+        [prefix, title_with_replacements].join("")
     }
 
     /// Prepare the file name for the generated file.
     ///
-    /// The file name is based on the module ID, with the `.adoc` extension and an optional prefix.
+    /// The file name is based on the module ID, with the `.adoc` extension.
     pub fn file_name(&self) -> String {
-        let prefix = if self.options.prefixes {
+        let suffix = ".adoc";
+
+        [&self.id(), suffix].join("")
+    }
+
+    fn prefix(&self) -> String {
+        if self.options.prefixes {
             // If prefixes are enabled, pick the right file prefix
             match self.mod_type {
                 ModuleType::Assembly => "assembly_",
@@ -147,11 +155,7 @@ impl Input {
         } else {
             // If prefixes are disabled, use an empty string for the prefix
             ""
-        };
-
-        let suffix = ".adoc";
-
-        [prefix, &self.id(), suffix].join("")
+        }.to_string()
     }
 
     /// Prepare an include statement that can be used to include the generated file from elsewhere.
@@ -376,7 +380,7 @@ mod tests {
             assembly.title,
             "A testing assembly with /special-characters*"
         );
-        assert_eq!(assembly.id, "a-testing-assembly-with-special-characters");
+        assert_eq!(assembly.id, "assembly_a-testing-assembly-with-special-characters");
         assert_eq!(
             assembly.file_name,
             "assembly_a-testing-assembly-with-special-characters.adoc"

templates/assembly.adoc

@@ -2,32 +2,43 @@
 //
 // <List assemblies here, each on a new line>
 
-// Retains the context of the parent assembly if this assembly is nested within another assembly.
-// For more information about nesting assemblies, see: https://redhat-documentation.github.io/modular-docs/#nesting-assemblies
-// See also the complementary step on the last line of this file.
+////
+Retains the context of the parent assembly if this assembly is nested within another assembly.
+For more information about nesting assemblies, see: https://redhat-documentation.github.io/modular-docs/#nesting-assemblies
+See also the complementary step on the last line of this file.
+////
+
 ifdef::context[:parent-context-of-${module_id}: {context}]
 
-// Base the file name and the ID on the assembly title. For example:
-// * file name: my-assembly-a.adoc
-// * ID: [id="my-assembly-a"]
-// * Title: = My assembly A
+////
+Base the file name and the ID on the assembly title. For example:
+* file name: assembly-my-user-story.adoc
+* ID: [id="assembly-my-user-story_{context}"]
+* Title: = My user story
+
+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.
+////
 
-// The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
-// If the assembly is reused in other assemblies in a guide, include {context} in the ID: [id="a-collection-of-modules_{context}"].
 ifndef::context[]
 [id="${module_id}"]
 endif::[]
 ifdef::context[]
 [id="${module_id}_{context}"]
 endif::[]
 = ${module_title}
-// If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.
+////
+If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.
+////
 
 :context: ${module_id}
-// The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
 
+////
+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.
+////
+
+[role="_abstract"]
 // <example>
-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. Can include more than one paragraph. Consider using the information from the user story.
+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. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
 // </example>
 
 .Prerequisites
@@ -36,27 +47,41 @@ This paragraph is the assembly introduction. It explains what the user will acco
 * A bulleted list of conditions that must be satisfied before the user starts following this assembly.
 * You can also link to other modules or assemblies the user must follow before starting this assembly.
 * Delete the section title and bullets if the assembly has no prerequisites.
+* X is installed. For information about installing X, see <link>.
+* You can log in to X with administrator privileges.
 // </example>
 
-// 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.
+////
+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.
 
-// include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
-// [leveloffset=+1] ensures that when a module starts with a level-1 heading (= Heading), the heading will be interpreted as a level-2 heading (== Heading) in the assembly.
-
-// include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+1]
+include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
+////
 
 ${include_statements}
 
+////
+[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.
+
+include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
+
+include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=2]
+////
 
+[role="_additional-resources"]
 == Additional resources (or Next steps)
+////
+Optional. Delete if not used.
+////
 
 // <example>
 * A bulleted list of links to other material closely related to the contents of the assembly, including xref links to other assemblies in your collection.
 * For more details on writing assemblies, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
 * Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
 // </example>
 
-// Restore the context to what it was before this assembly.
+////
+Restore the context to what it was before this assembly.
+////
 ifdef::parent-context-of-${module_id}[:context: {parent-context-of-${module_id}}]
 ifndef::parent-context-of-${module_id}[:!context:]
 

templates/concept.adoc

@@ -2,21 +2,28 @@
 //
 // <List assemblies here, each on a new line>
 
-// Base the file name and the ID on the module title. For example:
-// * file name: my-concept-module-a.adoc
-// * ID: [id="my-concept-module-a-{context}"]
-// * Title: = My concept module A
+////
+Base the file name and the ID on the module title. For example:
+* file name: con-my-concept-module-a.adoc
+* ID: [id="con-my-concept-module-a_{context}"]
+* Title: = My concept module A
+////
+
+////
+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.
+
+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.
+////
 
-// The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
 [id="${module_id}_{context}"]
-// The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
 = ${module_title}
-// 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. See also _Wording of headings_ in _The IBM Style Guide_.
+////
+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. See also _Wording of headings_ in _The IBM Style Guide_.
+////
 
+[role="_abstract"]
 // <example>
-A short introductory paragraph is required for the concept module.
-It will provide an overview of the module.
+Write a short introductory paragraph that provides an overview of the module. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
 
 The contents of a concept module give the user descriptions and explanations needed to understand and use a product.
 
@@ -25,8 +32,11 @@ The contents of a concept module give the user descriptions and explanations nee
 * Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.
 // </example>
 
+[role="_additional-resources"]
 .Additional resources
-
+////
+Optional. Delete if not used.
+////
 // <example>
 * A bulleted list of links to other material closely related to the contents of the concept module.
 * Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.

templates/procedure.adoc

@@ -2,46 +2,67 @@
 //
 // <List assemblies here, each on a new line>
 
-// Base the file name and the ID on the module title. For example:
-// * file name: doing-procedure-a.adoc
-// * ID: [id="doing-procedure-a"]
-// * Title: = Doing procedure A
+////
+Base the file name and the ID on the module title. For example:
+* file name: proc-doing-procedure-a.adoc
+* ID: [id="doing-procedure-a_{context}"]
+* Title: = Doing procedure A
+
+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.
+
+The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
+////
 
-// The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
 [id="${module_id}_{context}"]
-// The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
 = ${module_title}
-// Start the title of a procedure module with a verb, such as Creating or Create. See also _Wording of headings_ in _The IBM Style Guide_.
+////
+Start the title of a procedure module with a verb, such as Creating or Create. See also _Wording of headings_ in _The IBM Style Guide_.
+////
 
+[role="_abstract"]
 // <example>
-This paragraph is the procedure module introduction: a short description of the procedure.
+Write a short introductory paragraph that provides an overview of the module. Procedure modules should include  the steps that users perform and address user motivation.The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
 // </example>
 
 .Prerequisites
 
 // <example>
-* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
-* You can also link to other modules or assemblies the user must follow before starting this assembly.
-* Delete the section title and bullets if the assembly has no prerequisites.
+* A bulleted list of conditions that must be satisfied before the user starts following this module.
+* You can also link to other modules or assemblies the user must follow before starting this module.
+* Delete the section title and bullets if the module has no prerequisites.
 // </example>
 
 .Procedure
 
 // <example>
 . Start each step with an active verb.
-. Include one command or action per step.
+
+. Include one command or action for each step with the exception of simple follow-step, for example:
+.. Do this thing and then select *Next*.
+.. Do this other thing and then select *Next*.
+
 . Use an unnumbered bullet (*) if the procedure includes only one step.
 // </example>
 
 .Verification steps
+////
+Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.
+////
 
 // <example>
-. Optional: Provide the user with verification method(s) for the procedure, such as expected output or commands that can be used to check for success or failure.
+. Start each step with an active verb.
+
+. Include one command or action per step.
+
 . Use an unnumbered bullet (*) if the procedure includes only one step.
 // </example>
 
-.Additional resources
 
+[role="_additional-resources"]
+.Additional resources
+////
+Optional. Delete if not used.
+////
 // <example>
 * A bulleted list of links to other material closely related to the contents of the procedure module.
 * Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.

templates/reference.adoc

@@ -2,22 +2,26 @@
 //
 // <List assemblies here, each on a new line>
 
-// Base the file name and the ID on the module title. For example:
-// * file name: my-reference-a.adoc
-// * ID: [id="my-reference-a"]
-// * Title: = My reference A
+////
+Base the file name and the ID on the module title. For example:
+* file name: ref-my-reference-a.adoc
+* ID: [id="ref-my-reference-a_{context}"]
+* Title: = My reference A
+
+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.
+
+The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
+////
 
-// The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
 [id="${module_id}_{context}"]
-// The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
 = ${module_title}
-// 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.
+////
+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.
+////
 
+[role="_abstract"]
 // <example>
-A short introductory paragraph is required for the reference module.
-It will provide an overview of the module.
-
-A reference module provide data that users might want to look up, but do not need to remember.
+Write a short introductory paragraph that provides an overview of the module. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata. A reference module provides data that users might want to look up, but do not need to remember.
 It has a very strict structure, often in the form of a list or a table.
 A well-organized reference module enables users to scan it quickly to find the details they want.
 AsciiDoc markup to consider for reference data: