nitdoc: replace `article:` prefix id by `.article` suffix

Because some HTML/JS tools do not like `:` in ids...

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

diff --git a/src/doc/doc_phases/doc_graphs.nit b/src/doc/doc_phases/doc_graphs.nit
index 6552739..ecc89f5 100644 (file)
--- a/src/doc/doc_phases/doc_graphs.nit
+++ b/src/doc/doc_phases/doc_graphs.nit
@@ -73,7 +73,7 @@ redef class MModulePage
                        end
                end
                op.append("\}\n")
-               return new GraphArticle("article:{mentity.nitdoc_id}.graph", mentity, name, "Importation Graph", op)
+               return new GraphArticle("{mentity.nitdoc_id}.graph", mentity, name, "Importation Graph", op)
        end
 end
 
@@ -107,7 +107,7 @@ redef class MClassPage
                        end
                end
                op.append("\}\n")
-               return new GraphArticle("article:{mentity.nitdoc_id}.graph", mentity, name, "Inheritance Graph", op)
+               return new GraphArticle("{mentity.nitdoc_id}.graph", mentity, name, "Inheritance Graph", op)
        end
 end
 

diff --git a/src/doc/doc_phases/doc_hierarchies.nit b/src/doc/doc_phases/doc_hierarchies.nit
index 4aeb52c..487f411 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("group:list", "List")
                var imports = self.imports.to_a
                v.name_sorter.sort(imports)
-               group.add_child new HierarchyListArticle("article:Imports_{id}.hierarchy", mentity, "Imports", imports)
+               group.add_child new HierarchyListArticle("{id}.imports", mentity, "Imports", imports)
                var clients = self.clients.to_a
                v.name_sorter.sort(clients)
-               group.add_child new HierarchyListArticle("article:Clients_{id}.hierarchy", mentity, "Clients", clients)
+               group.add_child new HierarchyListArticle("{id}.clients", mentity, "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("group:list", "List")
                var parents = self.parents.to_a
                v.name_sorter.sort(parents)
-               group.add_child new HierarchyListArticle("article:Parents_{id}.hierarchy", mentity, "Parents", parents)
+               group.add_child new HierarchyListArticle("{id}.parents", mentity, "Parents", parents)
                var ancestors = self.ancestors.to_a
                v.name_sorter.sort(ancestors)
-               group.add_child new HierarchyListArticle("article:Ancestors_{id}.hierarchy", mentity, "Ancestors", ancestors)
+               group.add_child new HierarchyListArticle("{id}.ancestors", mentity, "Ancestors", ancestors)
                var children = self.children.to_a
                v.name_sorter.sort(children)
-               group.add_child new HierarchyListArticle("article:Children_{id}.hierarchy", mentity, "Children", children)
+               group.add_child new HierarchyListArticle("{id}.children", mentity, "Children", children)
                var descendants = self.descendants.to_a
                v.name_sorter.sort(descendants)
-               group.add_child new HierarchyListArticle("article:Descendants_{id}.hierarchy", mentity, "Descendants", descendants)
+               group.add_child new HierarchyListArticle("{id}.descendants", mentity, "Descendants", descendants)
                section.add_child group
                section.parent = root.children.first
                root.children.first.children.insert(section, 1)

diff --git a/src/doc/doc_phases/doc_html.nit b/src/doc/doc_phases/doc_html.nit
index c6a7ca1..4439e98 100644 (file)
--- a/src/doc/doc_phases/doc_html.nit
+++ b/src/doc/doc_phases/doc_html.nit
@@ -372,7 +372,7 @@ redef class MClassPage
                if not mprop_is_local(mprop) then
                        classes.add "inherit"
                        var cls_url = mprop.intro.mclassdef.mclass.nitdoc_url
-                       var def_url = "{cls_url}#article:{mprop.nitdoc_id}.definition"
+                       var def_url = "{cls_url}#{mprop.nitdoc_id}.definition"
                        var lnk = new Link(def_url, mprop.html_name)
                        var mdoc = mprop.intro.mdoc_or_fallback
                        if mdoc != null then lnk.title = mdoc.short_comment
@@ -388,7 +388,7 @@ redef class MClassPage
                end
                var def = select_mpropdef(mprop)
                var anc = def.html_link_to_anchor
-               anc.href = "#article:{def.nitdoc_id}.definition"
+               anc.href = "#{def.nitdoc_id}.definition"
                var lnk = new Template
                lnk.add new DocHTMLLabel.with_classes(classes)
                lnk.add anc

diff --git a/src/doc/doc_phases/doc_indexing.nit b/src/doc/doc_phases/doc_indexing.nit
index 72df73c..1e74138 100644 (file)
--- a/src/doc/doc_phases/doc_indexing.nit
+++ b/src/doc/doc_phases/doc_indexing.nit
@@ -43,7 +43,7 @@ class IndexingPhase
                                if not doc.mpropdefs.has(mpropdef) then continue
                                var full_name = mpropdef.mclassdef.mclass.full_name
                                var cls_url = mpropdef.mclassdef.mclass.nitdoc_url
-                               var def_url = "{cls_url}#article:{mpropdef.nitdoc_id}.definition"
+                               var def_url = "{cls_url}#{mpropdef.nitdoc_id}.definition"
                                add_result_for(mproperty.name, full_name, def_url)
                        end
                end

diff --git a/src/doc/doc_phases/doc_intros_redefs.nit b/src/doc/doc_phases/doc_intros_redefs.nit
index ec6ad29..b1e6e20 100644 (file)
--- a/src/doc/doc_phases/doc_intros_redefs.nit
+++ b/src/doc/doc_phases/doc_intros_redefs.nit
@@ -58,10 +58,10 @@ redef class DefinitionArticle
                var group = new PanelGroup("group:list", "List")
                var intros = mmodule.intro_mclassdefs(v.ctx.min_visibility).to_a
                doc.mainmodule.linearize_mclassdefs(intros)
-               group.add_child new IntrosRedefsListArticle("article:Introduces_{mentity.nitdoc_id}.intros_redefs", mentity, "Introduces", intros)
+               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.intros", mentity, "Introduces", intros)
                var redefs = mmodule.redef_mclassdefs(v.ctx.min_visibility).to_a
                doc.mainmodule.linearize_mclassdefs(redefs)
-               group.add_child new IntrosRedefsListArticle("article:Redefines_{mentity.nitdoc_id}.intros_redefs", mentity, "Redefines", redefs)
+               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.redefs", mentity, "Redefines", redefs)
                section.add_child group
                add_child(section)
        end
@@ -73,11 +73,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("article:Introduces_{mentity.nitdoc_id}.intros_redefs", mentity, "Introduces", intros)
+               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.intros", mentity, "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("article:Redefines_{mentity.nitdoc_id}.intros_redefs", mentity, "Redefines", redefs)
+               group.add_child new IntrosRedefsListArticle("{mentity.nitdoc_id}.redefs", mentity, "Redefines", redefs)
                section.add_child group
                add_child(section)
        end

diff --git a/src/doc/doc_phases/doc_lin.nit b/src/doc/doc_phases/doc_lin.nit
index a57c71c..a919f93 100644 (file)
--- a/src/doc/doc_phases/doc_lin.nit
+++ b/src/doc/doc_phases/doc_lin.nit
@@ -73,7 +73,7 @@ redef class DefinitionArticle
                var lin = all_defs.to_a
                doc.mainmodule.linearize_mpropdefs(lin)
                if lin.length > 1 then
-                       add_child new DefinitionLinArticle("article:{mentity.nitdoc_id}.lin", mentity, lin)
+                       add_child new DefinitionLinArticle("{mentity.nitdoc_id}.lin", mentity, lin)
                end
        end
 

diff --git a/src/doc/doc_phases/doc_structure.nit b/src/doc/doc_phases/doc_structure.nit
index 1384ef9..d29a5df 100644 (file)
--- a/src/doc/doc_phases/doc_structure.nit
+++ b/src/doc/doc_phases/doc_structure.nit
@@ -47,7 +47,7 @@ end
 
 redef class OverviewPage
        redef fun apply_structure(v, doc) do
-               var article = new HomeArticle("article:home")
+               var article = new HomeArticle("home.article")
                root.add_child article
                # Projects list
                var mprojects = doc.model.mprojects.to_a
@@ -55,7 +55,7 @@ redef class OverviewPage
                sorter.sort mprojects
                var section = new ProjectsSection("projects.section")
                for mproject in mprojects do
-                       section.add_child new DefinitionArticle("article:{mproject.nitdoc_id}.definition", mproject)
+                       section.add_child new DefinitionArticle("{mproject.nitdoc_id}.definition", mproject)
                end
                article.add_child section
        end
@@ -69,7 +69,7 @@ redef class SearchPage
                v.name_sorter.sort(mclasses)
                var mprops = doc.mproperties.to_a
                v.name_sorter.sort(mprops)
-               root.add_child new IndexArticle("article:index", mmodules, mclasses, mprops)
+               root.add_child new IndexArticle("index.article", mmodules, mclasses, mprops)
        end
 end
 
@@ -78,9 +78,9 @@ redef class MGroupPage
                var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
                root.add_child section
                if mentity.is_root then
-                       section.add_child new IntroArticle("article:{mentity.mproject.nitdoc_id}.intro", mentity.mproject)
+                       section.add_child new IntroArticle("{mentity.mproject.nitdoc_id}.intro", mentity.mproject)
                else
-                       section.add_child new IntroArticle("article:{mentity.nitdoc_id}.intro", mentity)
+                       section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
                end
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
@@ -90,11 +90,11 @@ redef class MGroupPage
                concerns.sort_with(v.concerns_sorter)
                mentity.mproject.booster_rank = 0
                mentity.booster_rank = 0
-               section.add_child new ConcernsArticle("article:{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
                for mentity in concerns do
                        var ssection = new ConcernSection("concern:{mentity.nitdoc_id}", mentity)
                        if mentity isa MModule then
-                               ssection.add_child new DefinitionArticle("article:{mentity.nitdoc_id}.definition", mentity)
+                               ssection.add_child new DefinitionArticle("{mentity.nitdoc_id}.definition", mentity)
                        end
                        section.add_child ssection
                end
@@ -105,7 +105,7 @@ redef class MModulePage
        redef fun apply_structure(v, doc) do
                var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
                root.add_child section
-               section.add_child new IntroArticle("article:{mentity.nitdoc_id}.intro", mentity)
+               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
                # FIXME avoid diff
@@ -116,7 +116,7 @@ redef class MModulePage
                mentity.mgroup.mproject.booster_rank = 0
                mentity.mgroup.booster_rank = 0
                mentity.booster_rank = 0
-               section.add_child new ConcernsArticle("article:{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
                # reference list
                for mentity in concerns do
                        var ssection = new ConcernSection("concern:{mentity.nitdoc_id}", mentity)
@@ -125,16 +125,16 @@ redef class MModulePage
                                v.name_sorter.sort(mclasses)
                                for mclass in mclasses do
                                        var article = new DefinitionListArticle(
-                                               "article:{mclass.intro.nitdoc_id}.definition-list", mclass)
+                                               "{mclass.intro.nitdoc_id}.definition-list", mclass)
                                        var mclassdefs = mclassdefs_for(mclass).to_a
                                        if not mclassdefs.has(mclass.intro) then
                                                article.add_child(new DefinitionArticle(
-                                                       "article:{mclass.intro.nitdoc_id}.definition", mclass.intro))
+                                                       "{mclass.intro.nitdoc_id}.definition", mclass.intro))
                                        end
                                        doc.mainmodule.linearize_mclassdefs(mclassdefs)
                                        for mclassdef in mclassdefs do
                                                article.add_child(new DefinitionArticle(
-                                                       "article:{mclassdef.nitdoc_id}.definition", mclassdef))
+                                                       "{mclassdef.nitdoc_id}.definition", mclassdef))
                                        end
                                        ssection.add_child article
                                end
@@ -170,7 +170,7 @@ redef class MClassPage
        redef fun apply_structure(v, doc) do
                var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
                root.add_child section
-               section.add_child new IntroArticle("article:{mentity.nitdoc_id}.intro", mentity)
+               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
                # FIXME diff hack
@@ -182,13 +182,13 @@ redef class MClassPage
                mentity.intro_mmodule.mgroup.booster_rank = 0
                mentity.intro_mmodule.booster_rank = 0
                var constructors = new ConstructorsSection(
-                       "article:{mentity.nitdoc_id}.constructors", mentity)
+                       "{mentity.nitdoc_id}.constructors", mentity)
                var minit = mentity.root_init
                if minit != null then
-                       constructors.add_child new DefinitionArticle("article:{minit.nitdoc_id}.definition", minit)
+                       constructors.add_child new DefinitionArticle("{minit.nitdoc_id}.definition", minit)
                end
                section.add_child constructors
-               section.add_child new ConcernsArticle("article:{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
                for mentity in concerns do
                        var ssection = new ConcernSection("concern:{mentity.nitdoc_id}", mentity)
                        if mentity isa MModule then
@@ -201,10 +201,10 @@ redef class MClassPage
                                                        if mpropdef isa MMethodDef and mpropdef.mproperty.is_init then
                                                                if mpropdef == minit then continue
                                                                constructors.add_child new DefinitionArticle(
-                                                                       "article:{mpropdef.nitdoc_id}.definition", mpropdef)
+                                                                       "{mpropdef.nitdoc_id}.definition", mpropdef)
                                                        else
                                                                ssection.add_child new DefinitionArticle(
-                                                                       "article:{mpropdef.nitdoc_id}.definition", mpropdef)
+                                                                       "{mpropdef.nitdoc_id}.definition", mpropdef)
                                                        end
                                                end
                                        end
@@ -246,7 +246,7 @@ redef class MPropertyPage
        redef fun apply_structure(v, doc) do
                var section = new MEntitySection("{mentity.nitdoc_name}.section", mentity)
                root.add_child section
-               section.add_child new IntroArticle("article:{mentity.nitdoc_id}.intro", mentity)
+               section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", mentity)
                var concerns = self.concerns
                if concerns == null or concerns.is_empty then return
                # FIXME diff hack
@@ -257,7 +257,7 @@ redef class MPropertyPage
                mentity.intro.mclassdef.mmodule.mgroup.mproject.booster_rank = 0
                mentity.intro.mclassdef.mmodule.mgroup.booster_rank = 0
                mentity.intro.mclassdef.mmodule.booster_rank = 0
-               section.add_child new ConcernsArticle("article:{mentity.nitdoc_id}.concerns", mentity, concerns)
+               section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", mentity, concerns)
                for mentity in concerns do
                        var ssection = new ConcernSection("concern:{mentity.nitdoc_id}", mentity)
                        if mentity isa MModule then
@@ -266,7 +266,7 @@ redef class MPropertyPage
                                v.name_sorter.sort(mpropdefs)
                                for mpropdef in mpropdefs do
                                        ssection.add_child new DefinitionArticle(
-                                               "article:{mpropdef.nitdoc_id}.definition", mpropdef)
+                                               "{mpropdef.nitdoc_id}.definition", mpropdef)
                                end
                        end
                        section.add_child ssection