nitdoc: factorize list article into `MEntitiesListArticle`

Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>

diff --git a/share/nitdoc/css/nitdoc.css b/share/nitdoc/css/nitdoc.css
index e47f3aa..01da471 100644 (file)
--- a/share/nitdoc/css/nitdoc.css
+++ b/share/nitdoc/css/nitdoc.css
@@ -81,9 +81,6 @@ article.nospace {
        color: #666;
 }
 
-#sidebar .panel-body ul .list-labeled>li {
-}
-
 #sidebar .panel-body ul ul ul>li {
        font-size: 13px;
        color: #999;

diff --git a/src/doc/doc_phases/doc_hierarchies.nit b/src/doc/doc_phases/doc_hierarchies.nit
index a543c46..61a9b08 100644 (file)
--- a/src/doc/doc_phases/doc_hierarchies.nit
+++ b/src/doc/doc_phases/doc_hierarchies.nit
@@ -45,10 +45,10 @@ redef class MModulePage
                var group = new PanelGroup("list.group", "List")
                var imports = self.imports.to_a
                v.name_sorter.sort(imports)
-               group.add_child new HierarchyListArticle("{id}.imports", "Imports", imports)
+               group.add_child new MEntitiesListArticle("{id}.imports", "Imports", imports)
                var clients = self.clients.to_a
                v.name_sorter.sort(clients)
-               group.add_child new HierarchyListArticle("{id}.clients", "Clients", clients)
+               group.add_child new MEntitiesListArticle("{id}.clients", "Clients", clients)
                section.add_child group
                section.parent = root.children.first
                root.children.first.children.insert(section, 1)
@@ -62,16 +62,16 @@ redef class MClassPage
                var group = new PanelGroup("list.group", "List")
                var parents = self.parents.to_a
                v.name_sorter.sort(parents)
-               group.add_child new HierarchyListArticle("{id}.parents", "Parents", parents)
+               group.add_child new MEntitiesListArticle("{id}.parents", "Parents", parents)
                var ancestors = self.ancestors.to_a
                v.name_sorter.sort(ancestors)
-               group.add_child new HierarchyListArticle("{id}.ancestors", "Ancestors", ancestors)
+               group.add_child new MEntitiesListArticle("{id}.ancestors", "Ancestors", ancestors)
                var children = self.children.to_a
                v.name_sorter.sort(children)
-               group.add_child new HierarchyListArticle("{id}.children", "Children", children)
+               group.add_child new MEntitiesListArticle("{id}.children", "Children", children)
                var descendants = self.descendants.to_a
                v.name_sorter.sort(descendants)
-               group.add_child new HierarchyListArticle("{id}.descendants", "Descendants", descendants)
+               group.add_child new MEntitiesListArticle("{id}.descendants", "Descendants", descendants)
                section.add_child group
                section.parent = root.children.first
                root.children.first.children.insert(section, 1)
@@ -89,13 +89,3 @@ class InheritanceListSection
        super TabbedGroup
        super MEntityComposite
 end
-
-# Dislay a hierarchical list of mentities.
-class HierarchyListArticle
-       super DocArticle
-
-       # MEntities to display in this list.
-       var mentities: Array[MEntity]
-
-       redef fun is_hidden do return mentities.is_empty
-end

diff --git a/src/doc/doc_phases/doc_intros_redefs.nit b/src/doc/doc_phases/doc_intros_redefs.nit
index 38aaa80..8a2caac 100644 (file)
--- a/src/doc/doc_phases/doc_intros_redefs.nit
+++ b/src/doc/doc_phases/doc_intros_redefs.nit
@@ -59,10 +59,10 @@ redef class DefinitionArticle
                var group = new PanelGroup("list.group", "List")
                var intros = mmodule.collect_intro_mclassdefs(v.ctx.min_visibility).to_a
                doc.mainmodule.linearize_mclassdefs(intros)
-               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.intros", "Introduces", intros)
+               group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.intros", "Introduces", intros)
                var redefs = mmodule.collect_redef_mclassdefs(v.ctx.min_visibility).to_a
                doc.mainmodule.linearize_mclassdefs(redefs)
-               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.redefs", "Redefines", redefs)
+               group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.redefs", "Redefines", redefs)
                section.add_child group
                add_child(section)
        end
@@ -74,11 +74,11 @@ redef class DefinitionArticle
                var intros = mclassdef.collect_intro_mpropdefs(v.ctx.min_visibility).to_a
                # FIXME avoid diff changes
                # v.ctx.mainmodule.linearize_mpropdefs(intros)
-               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.intros", "Introduces", intros)
+               group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.intros", "Introduces", intros)
                var redefs = mclassdef.collect_redef_mpropdefs(v.ctx.min_visibility).to_a
                # FIXME avoid diff changes
                # v.ctx.mainmodule.linearize_mpropdefs(redefs)
-               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.redefs", "Redefines", redefs)
+               group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.redefs", "Redefines", redefs)
                section.add_child group
                add_child(section)
        end
@@ -92,17 +92,3 @@ class IntrosRedefsSection
 
        redef var is_toc_hidden = true
 end
-
-# An article that displays a list of introduced / refined mentities.
-#
-# FIXME diff hack
-# This can merged with InheritanceListArticle in a more generic class.
-class IntrosRedefsListArticle
-       super DocArticle
-
-       # Intro mentities to list.
-       var mentities: Array[MEntity]
-
-       redef fun is_hidden do return mentities.is_empty
-       redef var is_toc_hidden = true
-end

diff --git a/src/doc/doc_phases/doc_structure.nit b/src/doc/doc_phases/doc_structure.nit
index 0760ce9..b5990d2 100644 (file)
--- a/src/doc/doc_phases/doc_structure.nit
+++ b/src/doc/doc_phases/doc_structure.nit
@@ -330,6 +330,17 @@ abstract class MEntityArticle
        super DocArticle
 end
 
+# An article that displays a list of mentities.
+class MEntitiesListArticle
+       super DocArticle
+
+       # MEntities to display.
+       var mentities: Array[MEntity]
+
+       redef fun is_hidden do return mentities.is_empty
+end
+
+
 # A section about a Mentity.
 #
 # Used to regroup content about a MEntity.

diff --git a/src/doc/html_templates/html_templates.nit b/src/doc/html_templates/html_templates.nit
index b596df1..9fa52e5 100644 (file)
--- a/src/doc/html_templates/html_templates.nit
+++ b/src/doc/html_templates/html_templates.nit
@@ -538,27 +538,16 @@ redef class DefinitionArticle
        end
 end
 
-redef class HierarchyListArticle
-       redef fun render_body do
-               var lst = new UnorderedList
-               lst.css_classes.add "list-unstyled list-definition"
-               for mentity in mentities do
-                       lst.add_li mentity.html_list_item
-               end
-               addn lst
-       end
-end
-
 redef class IntrosRedefsSection
        redef var toc_title do return "Intros / Redefs"
        redef var html_title = null
        redef var html_subtitle = null
 end
 
-redef class IntrosRedefsListArticle
+redef class MEntitiesListArticle
        redef fun render_body do
                var lst = new UnorderedList
-               lst.css_classes.add "list-unstyled list-labeled"
+               lst.css_classes.add "list-unstyled list-definition"
                for mentity in mentities do
                        lst.add_li mentity.html_list_item
                end