model: use the robust `intro_mmodule` instead of `intro.mmodule`.
[nit.git] / src / doc / doc_phases / doc_structure.nit
index dd3759b..d84a739 100644 (file)
@@ -49,13 +49,13 @@ redef class OverviewPage
        redef fun apply_structure(v, doc) do
                var article = new HomeArticle("home.article", "Home")
                root.add_child article
-               # Projects list
-               var mprojects = doc.model.mprojects.to_a
+               # Packages list
+               var mpackages = doc.model.mpackages.to_a
                var sorter = new MConcernRankSorter
-               sorter.sort mprojects
-               var section = new DocSection("projects.section", "Projects")
-               for mproject in mprojects do
-                       section.add_child new DefinitionArticle("{mproject.nitdoc_id}.definition", mproject)
+               sorter.sort mpackages
+               var section = new DocSection("packages.section", "Packages")
+               for mpackage in mpackages do
+                       section.add_child new DefinitionArticle("{mpackage.nitdoc_id}.definition", null, mpackage)
                end
                article.add_child section
        end
@@ -69,32 +69,32 @@ redef class SearchPage
                v.name_sorter.sort(mclasses)
                var mprops = doc.mproperties.to_a
                v.name_sorter.sort(mprops)
-               root.add_child new IndexArticle("index.article", mmodules, mclasses, mprops)
+               root.add_child new IndexArticle("index.article", null, mmodules, mclasses, mprops)
        end
 end
 
 redef class MGroupPage
        redef fun apply_structure(v, doc) do
-               var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
+               var section = new MEntitySection("{mentity.nitdoc_name}.section", null, mentity)
                root.add_child section
                if mentity.is_root then
-                       section.add_child new IntroArticle("{mentity.mproject.nitdoc_id}.intro", mentity.mproject)
+                       section.add_child new IntroArticle("{mentity.mpackage.nitdoc_id}.intro", null, mentity.mpackage)
                else
-                       section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
+                       section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", null, mentity)
                end
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
                # FIXME avoid diff
-               mentity.mproject.booster_rank = -1000
+               mentity.mpackage.booster_rank = -1000
                mentity.booster_rank = -1000
                concerns.sort_with(v.concerns_sorter)
-               mentity.mproject.booster_rank = 0
+               mentity.mpackage.booster_rank = 0
                mentity.booster_rank = 0
-               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", null, mentity, concerns)
                for mentity in concerns do
-                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", mentity)
+                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", null, mentity)
                        if mentity isa MModule then
-                               ssection.add_child new DefinitionArticle("{mentity.nitdoc_id}.definition", mentity)
+                               ssection.add_child new DefinitionArticle("{mentity.nitdoc_id}.definition", null, mentity)
                        end
                        section.add_child ssection
                end
@@ -103,38 +103,38 @@ end
 
 redef class MModulePage
        redef fun apply_structure(v, doc) do
-               var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
+               var section = new MEntitySection("{mentity.nitdoc_name}.section", null, mentity)
                root.add_child section
-               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
+               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", null, mentity)
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
                # FIXME avoid diff
-               mentity.mgroup.mproject.booster_rank = -1000
+               mentity.mgroup.mpackage.booster_rank = -1000
                mentity.mgroup.booster_rank = -1000
                mentity.booster_rank = -1000
                concerns.sort_with(v.concerns_sorter)
-               mentity.mgroup.mproject.booster_rank = 0
+               mentity.mgroup.mpackage.booster_rank = 0
                mentity.mgroup.booster_rank = 0
                mentity.booster_rank = 0
-               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", null, mentity, concerns)
                # reference list
                for mentity in concerns do
-                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", mentity)
+                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", null, mentity)
                        if mentity isa MModule then
                                var mclasses = mclasses_for_mmodule(mentity).to_a
                                v.name_sorter.sort(mclasses)
                                for mclass in mclasses do
                                        var article = new DefinitionListArticle(
-                                               "{mclass.intro.nitdoc_id}.definition-list", mclass)
+                                               "{mclass.intro.nitdoc_id}.definition-list", null, mclass)
                                        var mclassdefs = mclassdefs_for(mclass).to_a
                                        if not mclassdefs.has(mclass.intro) then
                                                article.add_child(new DefinitionArticle(
-                                                       "{mclass.intro.nitdoc_id}.definition", mclass.intro))
+                                                       "{mclass.intro.nitdoc_id}.definition", null, mclass.intro))
                                        end
                                        doc.mainmodule.linearize_mclassdefs(mclassdefs)
                                        for mclassdef in mclassdefs do
                                                article.add_child(new DefinitionArticle(
-                                                       "{mclassdef.nitdoc_id}.definition", mclassdef))
+                                                       "{mclassdef.nitdoc_id}.definition", null, mclassdef))
                                        end
                                        ssection.add_child article
                                end
@@ -147,7 +147,7 @@ redef class MModulePage
        private fun mclasses_for_mmodule(mmodule: MModule): Set[MClass] do
                var mclasses = new HashSet[MClass]
                for mclass in self.mclasses do
-                       if mclass.intro.mmodule == mmodule then
+                       if mclass.intro_mmodule == mmodule then
                                mclasses.add mclass
                        end
                end
@@ -168,28 +168,28 @@ end
 
 redef class MClassPage
        redef fun apply_structure(v, doc) do
-               var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
+               var section = new MEntitySection("{mentity.nitdoc_name}.section", null, mentity)
                root.add_child section
-               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
+               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", null, mentity)
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
                # FIXME diff hack
-               mentity.intro_mmodule.mgroup.mproject.booster_rank = -1000
+               mentity.intro_mmodule.mgroup.mpackage.booster_rank = -1000
                mentity.intro_mmodule.mgroup.booster_rank = -1000
                mentity.intro_mmodule.booster_rank = -1000
                concerns.sort_with(v.concerns_sorter)
-               mentity.intro_mmodule.mgroup.mproject.booster_rank = 0
+               mentity.intro_mmodule.mgroup.mpackage.booster_rank = 0
                mentity.intro_mmodule.mgroup.booster_rank = 0
                mentity.intro_mmodule.booster_rank = 0
                var constructors = new DocSection("{mentity.nitdoc_id}.constructors", "Constructors")
                var minit = mentity.root_init
                if minit != null then
-                       constructors.add_child new DefinitionArticle("{minit.nitdoc_id}.definition", minit)
+                       constructors.add_child new DefinitionArticle("{minit.nitdoc_id}.definition", null, minit)
                end
                section.add_child constructors
-               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", null, mentity, concerns)
                for mentity in concerns do
-                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", mentity)
+                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", null, mentity)
                        if mentity isa MModule then
                                var mprops = mproperties_for(mentity)
                                var by_kind = new PropertiesByKind.with_elements(mprops)
@@ -200,10 +200,10 @@ redef class MClassPage
                                                        if mpropdef isa MMethodDef and mpropdef.mproperty.is_init then
                                                                if mpropdef == minit then continue
                                                                constructors.add_child new DefinitionArticle(
-                                                                       "{mpropdef.nitdoc_id}.definition", mpropdef)
+                                                                       "{mpropdef.nitdoc_id}.definition", null, mpropdef)
                                                        else
                                                                ssection.add_child new DefinitionArticle(
-                                                                       "{mpropdef.nitdoc_id}.definition", mpropdef)
+                                                                       "{mpropdef.nitdoc_id}.definition", null, mpropdef)
                                                        end
                                                end
                                        end
@@ -243,29 +243,29 @@ end
 
 redef class MPropertyPage
        redef fun apply_structure(v, doc) do
-               var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
+               var section = new MEntitySection("{mentity.nitdoc_name}.section", null, mentity)
                root.add_child section
-               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
+               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", null, mentity)
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
                # FIXME diff hack
-               mentity.intro.mclassdef.mmodule.mgroup.mproject.booster_rank = -1000
+               mentity.intro.mclassdef.mmodule.mgroup.mpackage.booster_rank = -1000
                mentity.intro.mclassdef.mmodule.mgroup.booster_rank = -1000
                mentity.intro.mclassdef.mmodule.booster_rank = -1000
                concerns.sort_with(v.concerns_sorter)
-               mentity.intro.mclassdef.mmodule.mgroup.mproject.booster_rank = 0
+               mentity.intro.mclassdef.mmodule.mgroup.mpackage.booster_rank = 0
                mentity.intro.mclassdef.mmodule.mgroup.booster_rank = 0
                mentity.intro.mclassdef.mmodule.booster_rank = 0
-               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", null, mentity, concerns)
                for mentity in concerns do
-                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", mentity)
+                       var ssection = new ConcernSection("{mentity.nitdoc_id}.concern", null, mentity)
                        if mentity isa MModule then
                                # Add mproperties
                                var mpropdefs = mpropdefs_for(mentity).to_a
                                v.name_sorter.sort(mpropdefs)
                                for mpropdef in mpropdefs do
                                        ssection.add_child new DefinitionArticle(
-                                               "{mpropdef.nitdoc_id}.definition", mpropdef)
+                                               "{mpropdef.nitdoc_id}.definition", null, mpropdef)
                                end
                        end
                        section.add_child ssection
@@ -364,7 +364,7 @@ class ConcernsArticle
        redef fun is_hidden do return concerns.is_empty
 end
 
-# An article that displaus a list of definition belonging to a MEntity.
+# An article that displays a list of definition belonging to a MEntity.
 class DefinitionListArticle
        super TabbedGroup
        super MEntityArticle
@@ -377,7 +377,7 @@ class DefinitionArticle
        redef var is_hidden = false
 end
 
-# The main project article.
+# The main package article.
 class HomeArticle
        super DocArticle
 end
@@ -439,7 +439,7 @@ redef class MConcern
        fun concern_rank: Int is abstract
 end
 
-redef class MProject
+redef class MPackage
        redef var concern_rank is lazy do
                var max = 0
                for mgroup in mgroups do