No longer require the abstract tag

msuchane · msuchane · commit c9bb0e494df5 · 2022-02-21T17:57:17.000+01:00
diff --git a/data/generated/assembly_testing-that-an-assembly-forms-properly.adoc b/data/generated/assembly_testing-that-an-assembly-forms-properly.adoc
@@ -40,7 +40,6 @@ If the assembly covers a task, start the title with a verb in the gerund form, s
 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"]
 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.
 
 == Prerequisites
diff --git a/data/generated/con_a-title-that-tests-a-concept.adoc b/data/generated/con_a-title-that-tests-a-concept.adoc
@@ -25,7 +25,6 @@ The `context` attribute enables module reuse. Every module ID includes {context}
 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"]
 Write a short introductory paragraph that provides an overview of the module.
 
 The contents of a concept module give the user descriptions and explanations needed to understand and use a product.
diff --git a/data/generated/minimal-assembly.adoc b/data/generated/minimal-assembly.adoc
@@ -12,8 +12,6 @@ endif::[]
 
 :context: minimal-assembly
 
-[role="_abstract"]
-
 == Prerequisites
 
 [role="_additional-resources"]
diff --git a/data/generated/minimal-concept.adoc b/data/generated/minimal-concept.adoc
@@ -3,8 +3,6 @@
 [id="minimal-concept_{context}"]
 = Minimal concept
 
-[role="_abstract"]
-
 [role="_additional-resources"]
 .Additional resources
 
diff --git a/data/generated/minimal-procedure.adoc b/data/generated/minimal-procedure.adoc
@@ -3,8 +3,6 @@
 [id="minimal-procedure_{context}"]
 = Minimal procedure
 
-[role="_abstract"]
-
 .Prerequisites
 
 .Procedure
diff --git a/data/generated/minimal-reference.adoc b/data/generated/minimal-reference.adoc
@@ -3,8 +3,6 @@
 [id="minimal-reference_{context}"]
 = Minimal reference
 
-[role="_abstract"]
-
 [role="_additional-resources"]
 .Additional resources
 
diff --git a/data/generated/proc_testing-a-procedure.adoc b/data/generated/proc_testing-a-procedure.adoc
@@ -23,7 +23,6 @@ Add the following attribute before the module ID:
 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"]
 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.
diff --git a/data/generated/ref_the-lines-in-a-reference-module.adoc b/data/generated/ref_the-lines-in-a-reference-module.adoc
@@ -23,7 +23,6 @@ Add the following attribute before the module ID:
 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"]
 Write a short introductory paragraph that provides an overview of the module.
 
 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.
diff --git a/data/templates/assembly.adoc b/data/templates/assembly.adoc
@@ -40,7 +40,6 @@ If the assembly covers a task, start the title with a verb in the gerund form, s
 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"]
 {% if examples -%}
 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.
 {%- endif %}
diff --git a/data/templates/concept.adoc b/data/templates/concept.adoc
@@ -25,7 +25,6 @@ The `context` attribute enables module reuse. Every module ID includes {context}
 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"]
 {% if examples -%}
 Write a short introductory paragraph that provides an overview of the module.
 
diff --git a/data/templates/procedure.adoc b/data/templates/procedure.adoc
@@ -23,7 +23,6 @@ Add the following attribute before the module ID:
 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"]
 {% if examples -%}
 Write a short introductory paragraph that provides an overview of the module.
 
diff --git a/data/templates/reference.adoc b/data/templates/reference.adoc
@@ -23,7 +23,6 @@ Add the following attribute before the module ID:
 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"]
 {% if examples -%}
 Write a short introductory paragraph that provides an overview of the module.
 
diff --git a/src/validation.rs b/src/validation.rs
@@ -386,7 +386,8 @@ mod content {
         results
     }
 
-    /// Check that the abstract flag exists in the file and that it's followed by a paragraph.
+    /// Check that the abstract flag is followed by a paragraph,
+    /// if it exists at all. The abstract flag is not required.
     fn check_abstract_flag(content: &str) -> Option<IssueReport> {
         let abstract_regex = Regex::new(r#"^\[role="_abstract"\]"#).unwrap();
         let abstract_flag = find_first_occurrence(content, abstract_regex);
@@ -421,12 +422,9 @@ mod content {
                 debug!("No lines after the abstract.");
                 Some(no_paragraph_report)
             }
+        // If the file contains no abstract tag, report no error. This is supported format.
         } else {
-            Some(IssueReport {
-                line_number: None,
-                description: "The file is missing the _abstract flag. The flag is recommended but not required.",
-                severity: IssueSeverity::Warning,
-            })
+            None
         }
     }
 
