Fixed the sidebar menu in the HTML report so that the first click collapses a collapsable item directly; and also fixed indentation for subitems.

Added an inline description to categories in the HTML report explaining why and how the data of the category can be useful.

Author: llavarello

src/gitxray/include/gx_output.py

@@ -195,10 +195,10 @@ def _create_html_output(self):
 
                 if len(data_rows) > 0:
                     r_sidebar_links.append('<li class="nav-item"><a class="nav-link" href="#repository_'+str(sanitized_entity)+'_'+str(rtype)+'">'+str(rtype)+' '+gx_definitions.HTML_REPORT_EMOJIS.get(rtype,"")+'</a></li>')
-                    r_tables.append(templates['table'].replace("{{table_rows}}", "".join(data_rows)).replace("{{table_title}}", f"{rtype} {gx_definitions.HTML_REPORT_EMOJIS.get(rtype,'')}").replace("{{table_id}}", "repository_"+str(sanitized_entity)+"_"+rtype))
+                    r_tables.append(templates['table'].replace("{{table_rows}}", "".join(data_rows)).replace("{{table_title}}", f"{rtype} {gx_definitions.HTML_REPORT_EMOJIS.get(rtype,'')}").replace("{{table_id}}", "repository_"+str(sanitized_entity)+"_"+rtype).replace("{{table_description}}", f"{gx_definitions.HTML_REPORT_DESCRIPTIONS.get(rtype,'')}"))
 
             if len(r_tables) > 0:
-                repository_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a class="nav-link collapsed" data-bs-toggle="collapse" role="button" aria-expanded="false" aria-controls="nav_'+str(sanitized_entity)+'" href="#nav_'+str(sanitized_entity)+'">'+str(sanitized_entity_raw)+' &#128193;</a><div class="collapse" id="nav_'+str(sanitized_entity)+'"><ul class="nav flex-column ms-3">'
+                repository_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a class="nav-link collapsed" data-bs-toggle="collapse" role="button" aria-expanded="false" aria-controls="nav_'+str(sanitized_entity)+'" href="#nav_'+str(sanitized_entity)+'">'+str(sanitized_entity_raw)+' &#128193;</a><div class="px-3 collapse" id="nav_'+str(sanitized_entity)+'"><ul class="nav flex-column ms-3">'
                 repository_sidebar_links += "".join(r_sidebar_links)
                 repository_sidebar_links += '</ul></div></li></ul>'
                 r_template = r_template.replace("{{repository_tables}}", "".join(r_tables))
@@ -230,7 +230,8 @@ def _create_html_output(self):
             category_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a href="#nav_category_'+str(rtype)+'">'+str(rtype)+' '+gx_definitions.HTML_REPORT_EMOJIS.get(rtype,"")+'</a></li></ul>'
             table_html = templates['table'].replace("{{table_rows}}", table_rows) \
                                        .replace("{{table_title}}", f"{rtype} {gx_definitions.HTML_REPORT_EMOJIS.get(rtype, '')}") \
-                                       .replace("{{table_id}}", f"nav_category_{rtype}")
+                                       .replace("{{table_id}}", f"nav_category_{rtype}") \
+                                       .replace("{{table_description}}", f"{gx_definitions.HTML_REPORT_DESCRIPTIONS.get(rtype,'')}")
             category_sections += table_html
 
 
@@ -255,10 +256,10 @@ def _create_html_output(self):
 
                 if len(data_rows) > 0:
                     c_sidebar_links.append('<li class="nav-item"><a class="nav-link" href="#contributor_'+str(sanitized_entity)+'_'+str(rtype)+'">'+str(rtype)+' '+gx_definitions.HTML_REPORT_EMOJIS.get(rtype,"")+'</a></li>')
-                    c_tables.append(templates['table'].replace("{{table_rows}}", "".join(data_rows)).replace("{{table_title}}", f"{rtype} {gx_definitions.HTML_REPORT_EMOJIS.get(rtype,'')}").replace("{{table_id}}", "contributor_"+str(sanitized_entity)+"_"+str(rtype)))
+                    c_tables.append(templates['table'].replace("{{table_rows}}", "".join(data_rows)).replace("{{table_title}}", f"{rtype} {gx_definitions.HTML_REPORT_EMOJIS.get(rtype,'')}").replace("{{table_id}}", "contributor_"+str(sanitized_entity)+"_"+str(rtype)).replace("{{table_description}}", f"{gx_definitions.HTML_REPORT_DESCRIPTIONS.get(rtype,'')}"))
 
             if len(c_tables) > 0:
-                contributor_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a class="nav-link collapsed" data-bs-toggle="collapse" role="button" aria-expanded="false" aria-controls="nav_'+str(sanitized_entity)+'" href="#nav_'+str(sanitized_entity)+'">'+str(sanitized_entity)+' &#128193;</a><div class="collapse" id="nav_'+str(sanitized_entity)+'"><ul class="nav flex-column ms-3">'
+                contributor_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a class="nav-link collapsed" data-bs-toggle="collapse" role="button" aria-expanded="false" aria-controls="nav_'+str(sanitized_entity)+'" href="#nav_'+str(sanitized_entity)+'">'+str(sanitized_entity)+' &#128193;</a><div class="px-3 collapse" id="nav_'+str(sanitized_entity)+'"><ul class="nav flex-column ms-3">'
                 contributor_sidebar_links += "".join(c_sidebar_links)
                 contributor_sidebar_links += '</ul></div></li></ul>'
                 c_template = c_template.replace("{{contributor_tables}}", "".join(c_tables))
@@ -269,7 +270,7 @@ def _create_html_output(self):
                 sanitized_entity = "Anonymous"
                 a_template = templates['non_contributor'].replace("{{non_contributor_id}}", str(sanitized_entity))
                 a_template = a_template.replace("{{non_contributor_name}}", f'{sanitized_entity} &#128123;')
-                more_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a class="nav-link collapsed" data-bs-toggle="collapse" role="button" aria-expanded="false" aria-controls="nav_'+str(sanitized_entity)+'" href="#nav_'+str(sanitized_entity)+'">'+str(sanitized_entity)+' &#128123;</a><div class="collapse" id="nav_'+str(sanitized_entity)+'"><ul class="nav flex-column ms-3">'
+                more_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a class="nav-link collapsed" data-bs-toggle="collapse" role="button" aria-expanded="false" aria-controls="nav_'+str(sanitized_entity)+'" href="#nav_'+str(sanitized_entity)+'">'+str(sanitized_entity)+' &#128123;</a><div class="px-3 collapse" id="nav_'+str(sanitized_entity)+'"><ul class="nav flex-column ms-3">'
                 a_tables = ""
                 for rtype in data.keys():
                     data_rows = []
@@ -281,7 +282,7 @@ def _create_html_output(self):
                     if len(data_rows) > 0:
                         more_sidebar_links += '<li class="nav-item"><a class="nav-link" href="#contributor_'+str(sanitized_entity)+'_'+str(rtype)+'">'+str(rtype)+'</a></li>'
 
-                    a_tables += templates['table'].replace("{{table_rows}}", "".join(data_rows)).replace("{{table_title}}", str(rtype)).replace("{{table_id}}", "contributor_"+str(sanitized_entity)+"_"+str(rtype))
+                    a_tables += templates['table'].replace("{{table_rows}}", "".join(data_rows)).replace("{{table_title}}", str(rtype)).replace("{{table_id}}", "contributor_"+str(sanitized_entity)+"_"+str(rtype)).replace("{{table_description}}", f"{gx_definitions.HTML_REPORT_DESCRIPTIONS.get(rtype,'')}")
 
                 more_sidebar_links += '</ul></div></li></ul>'
                 a_template = a_template.replace("{{non_contributor_tables}}", a_tables)
@@ -312,13 +313,14 @@ def _create_html_output(self):
             more_sidebar_links += '<ul class="nav flex-column mb-0"><li class="nav-item"><a href="#nav_more_'+str(rtype)+'">'+str(rtype)+' '+gx_definitions.HTML_REPORT_EMOJIS.get(rtype,"")+'</a></li></ul>'
             table_html = templates['table'].replace("{{table_rows}}", table_rows) \
                                        .replace("{{table_title}}", f"{rtype} {gx_definitions.HTML_REPORT_EMOJIS.get(rtype, '')}") \
-                                       .replace("{{table_id}}", f"nav_more_{rtype}")
+                                       .replace("{{table_id}}", f"nav_more_{rtype}") \
+                                       .replace("{{table_description}}", f"{gx_definitions.HTML_REPORT_DESCRIPTIONS.get(rtype,'')}")
             more_sections += table_html
 
 
         # We now have all highlights under highlights_rows; let's fill the highlights table and section of the report
         if len(highlights_rows) > 0:
-            highlights_section = templates['table'].replace("{{table_rows}}", "".join(highlights_rows)).replace("{{table_title}}", "Highlights").replace("{{table_id}}", "highlights")
+            highlights_section = templates['table'].replace("{{table_rows}}", "".join(highlights_rows)).replace("{{table_title}}", "Highlights").replace("{{table_id}}", "highlights").replace("{{table_description}}", "")
         else: highlights_section = "<br/><h5>No results were highlighted by Gitxray.</h5>"
 
         output = templates['main'].replace("{{repository_sections}}", repository_sections)

src/gitxray/include/html_report/template_main.html

@@ -1,12 +1,13 @@
     <div class="table-section py-3">
         <div class="d-flex justify-content-between align-items-center">
        	<a id="{{table_id}}"></a>
-        <h3 class="flex-grow-1 text-start">{{table_title}}</h3>
+	<h3 class="flex-grow-1 text-start">{{table_title}}</h3>
           	<button class="btn btn-link" type="button" data-bs-toggle="collapse" data-bs-target="#tableCollapse_{{table_id}}" aria-expanded="true" aria-controls="tableCollapse_{{table_id}}">
 	            <span class="toggle-icon">&#8661;</span>
           	</button>
         </div>
 	<div class="collapse show" id="tableCollapse_{{table_id}}">
+	<h6><i>{{table_description}}</i></h6>
         <table class="table table-striped table-bordered" style="width:100%">
             <thead>
                 <tr>