X-Git-Url: http://nitlanguage.org diff --git a/src/doc/doc_phases/doc_html.nit b/src/doc/doc_phases/doc_html.nit index 57ebb67..83a2cc9 100644 --- a/src/doc/doc_phases/doc_html.nit +++ b/src/doc/doc_phases/doc_html.nit @@ -87,7 +87,7 @@ redef class ToolContext var git_dir = opt_github_gitdir var opts = [upstream.value, base_sha.value, git_dir.value] if not opts.has_only(null) and opts.has(null) then - print "Error: Options {upstream.names.first}, " + + print "Option Error: options {upstream.names.first}, " + "{base_sha.names.first} and {git_dir.names.first} " + "are required to enable the GitHub plugin" exit 1 @@ -104,8 +104,8 @@ class RenderHTMLPhase redef fun apply do init_output_dir - for page in doc.pages do - page.render(self, doc).write_to_file("{ctx.output_dir.to_s}/{page.page_url}") + for page in doc.pages.values do + page.render(self, doc).write_to_file("{ctx.output_dir.to_s}/{page.html_url}") end end @@ -120,7 +120,7 @@ class RenderHTMLPhase var dir = ctx.nit_dir sharedir = dir/"share/nitdoc" if not sharedir.file_exists then - print "Error: Cannot locate nitdoc share files. Uses --sharedir or envvar NIT_DIR" + print "Error: cannot locate nitdoc share files. Uses --sharedir or envvar NIT_DIR" abort end end @@ -133,8 +133,8 @@ class RenderHTMLPhase end - # A source link template for a given location - fun tpl_showsource(location: nullable Location): nullable String + # Returns a HTML link for a given `location`. + fun html_source_link(location: nullable Location): nullable String do if location == null then return null var source = ctx.opt_source.value @@ -157,172 +157,89 @@ end redef class DocPage # Render the page as a html template. - private fun render(v: RenderHTMLPhase, doc: DocModel): TplPage do + private fun render(v: RenderHTMLPhase, doc: DocModel): Writable do var shareurl = "." if v.ctx.opt_shareurl.value != null then shareurl = v.ctx.opt_shareurl.value.as(not null) end + # init page options + self.shareurl = shareurl + self.footer = v.ctx.opt_custom_footer.value + self.body_attrs.add(new TagAttribute("data-bootstrap-share", shareurl)) + # build page - var tpl = new TplPage - tpl.title = tpl_title(v, doc) - tpl.url = page_url - tpl.shareurl = shareurl - tpl.topmenu = tpl_topmenu(v, doc) - tpl.add_section tpl_content(v, doc) - tpl.footer = v.ctx.opt_custom_footer.value - tpl.body_attrs.add(new TagAttribute("data-bootstrap-share", shareurl)) - tpl.sidebar = tpl_sidebar(v, doc) + init_title(v, doc) + init_topmenu(v, doc) + init_content(v, doc) + init_sidebar(v, doc) # piwik tracking var tracker_url = v.ctx.opt_piwik_tracker.value var site_id = v.ctx.opt_piwik_site_id.value if tracker_url != null and site_id != null then - tpl.scripts.add new TplPiwikScript(tracker_url, site_id) + self.scripts.add new TplPiwikScript(tracker_url, site_id) end - return tpl + return self end # FIXME diff hack # all properties below are roughly copied from `doc_pages` - # URL to this page. - fun page_url: String is abstract - - # Build page sidebar if any - fun tpl_sidebar(v: RenderHTMLPhase, doc: DocModel): nullable TplSidebar do return null - # Build page title string - fun tpl_title(v: RenderHTMLPhase, doc: DocModel): String do + fun init_title(v: RenderHTMLPhase, doc: DocModel) do end + + # Build top menu template if any. + fun init_topmenu(v: RenderHTMLPhase, doc: DocModel) do + topmenu = new DocTopMenu + topmenu.brand = v.ctx.opt_custom_brand.value + var title = "Overview" if v.ctx.opt_custom_title.value != null then - return v.ctx.opt_custom_title.value.to_s + title = v.ctx.opt_custom_title.value.to_s end - return "Nitdoc" - end - - # Build top menu template - fun tpl_topmenu(v: RenderHTMLPhase, doc: DocModel): TplTopMenu do - var topmenu = new TplTopMenu(page_url) - var brand = v.ctx.opt_custom_brand.value - if brand != null then - var tpl = new Template - tpl.add "" - tpl.add brand - tpl.add "" - topmenu.brand = tpl - end - topmenu.add_link new TplLink("index.html", "Overview") - topmenu.add_link new TplLink("search.html", "Index") - return topmenu + topmenu.add_li new ListItem(new Link("index.html", title)) + topmenu.add_li new ListItem(new Link("search.html", "Index")) + topmenu.active_item = topmenu.items.first + end + + # Build page sidebar if any. + fun init_sidebar(v: RenderHTMLPhase, doc: DocModel) do + sidebar = new DocSideBar + sidebar.boxes.add new DocSideBox("Summary", html_toc) end - # Build page content template - fun tpl_content(v: RenderHTMLPhase, doc: DocModel): TplSection is abstract + # Build page content template. + fun init_content(v: RenderHTMLPhase, doc: DocModel) do + root.init_html_render(v, doc, self) + end end redef class OverviewPage - redef fun page_url do return "index.html" + redef var html_url = "index.html" - redef fun tpl_title(v, doc) do + redef fun init_title(v, doc) do + title = "Overview" if v.ctx.opt_custom_title.value != null then - return v.ctx.opt_custom_title.value.to_s - else - return "Overview" + title = v.ctx.opt_custom_title.value.to_s end end - - # TODO this should be done in StructurePhase. - redef fun tpl_content(v, doc) do - # intro text - var section = new TplSection.with_title("overview", tpl_title(v, doc)) - var article = new TplArticle("intro") - if v.ctx.opt_custom_intro.value != null then - article.content = v.ctx.opt_custom_intro.value.to_s - end - section.add_child article - # Projects list - var mprojects = doc.model.mprojects.to_a - var sorter = new MConcernRankSorter - sorter.sort mprojects - var ssection = new TplSection.with_title("projects", "Projects") - for mproject in mprojects do - var sarticle = mproject.tpl_article - sarticle.subtitle = mproject.tpl_declaration - sarticle.content = mproject.tpl_definition - var mdoc = mproject.mdoc_or_fallback - if mdoc != null then - sarticle.content = mdoc.tpl_short_comment - end - ssection.add_child sarticle - end - section.add_child ssection - return section - end - - redef fun tpl_sidebar(v, doc) do return new TplSidebar end redef class SearchPage - redef fun page_url do return "search.html" - redef fun tpl_title(v, doc) do return "Index" - - # TODO this should be done in StructurePhase. - redef fun tpl_content(v, doc) do - var tpl = new TplSearchPage("search_all") - var section = new TplSection("search") - # title - tpl.title = "Index" - # modules list - for mmodule in modules_list(v, doc) do - tpl.modules.add mmodule.tpl_link - end - # classes list - for mclass in classes_list(v, doc) do - tpl.classes.add mclass.tpl_link - end - # properties list - for mproperty in mprops_list(v, doc) do - var m = new Template - m.add mproperty.intro.tpl_link - m.add " (" - m.add mproperty.intro.mclassdef.mclass.tpl_link - m.add ")" - tpl.props.add m - end - section.add_child tpl - return section - end - - # Extract mmodule list to display (sorted by name) - private fun modules_list(v: RenderHTMLPhase, doc: DocModel): Array[MModule] do - var sorted = new Array[MModule] - for mmodule in doc.model.mmodule_importation_hierarchy do - if mmodule.is_fictive or mmodule.is_test_suite then continue - sorted.add mmodule - end - v.name_sorter.sort(sorted) - return sorted - end + redef var html_url = "search.html" + redef fun init_title(v, doc) do title = "Index" - # Extract mclass list to display (sorted by name) - private fun classes_list(v: RenderHTMLPhase, doc: DocModel): Array[MClass] do - var sorted = doc.mclasses.to_a - v.name_sorter.sort(sorted) - return sorted + redef fun init_topmenu(v, doc) do + super + topmenu.active_item = topmenu.items.last end - # Extract mproperty list to display (sorted by name) - private fun mprops_list(v: RenderHTMLPhase, doc: DocModel): Array[MProperty] do - var sorted = doc.mproperties.to_a - v.name_sorter.sort(sorted) - return sorted - end + redef fun init_sidebar(v, doc) do end end redef class MEntityPage - redef fun page_url do return mentity.nitdoc_url - redef fun tpl_title(v, doc) do return mentity.nitdoc_name - redef fun tpl_content(v, doc) do return root.start_rendering(v, doc, self) + redef var html_url is lazy do return mentity.nitdoc_url + redef fun init_title(v, doc) do title = mentity.html_name end # FIXME all clases below are roughly copied from `doc_pages` and adapted to new @@ -330,148 +247,165 @@ end # `doc_templates` module. redef class MGroupPage - redef fun tpl_topmenu(v, doc) do - var topmenu = super + redef fun init_topmenu(v, doc) do + super var mproject = mentity.mproject if not mentity.is_root then - topmenu.add_link new TplLink(mproject.nitdoc_url, mproject.nitdoc_name) + topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name)) end - topmenu.add_link new TplLink(page_url, mproject.nitdoc_name) - return topmenu + topmenu.add_li new ListItem(new Link(html_url, mproject.html_name)) + topmenu.active_item = topmenu.items.last end - redef fun tpl_sidebar(v, doc) do - var sidebar = new TplSidebar + redef fun init_sidebar(v, doc) do + super var mclasses = new HashSet[MClass] mclasses.add_all intros mclasses.add_all redefs - if mclasses.is_empty then return sidebar - var list = new TplList.with_classes(["list-unstyled", "list-labeled"]) - + if mclasses.is_empty then return + var list = new UnorderedList + list.css_classes.add "list-unstyled list-labeled" var sorted = mclasses.to_a v.name_sorter.sort(sorted) for mclass in sorted do list.add_li tpl_sidebar_item(mclass) end - sidebar.boxes.add new TplSideBox.with_content("All classes", list) - return sidebar + sidebar.boxes.add new DocSideBox("All classes", list) + sidebar.boxes.last.is_open = false end - private fun tpl_sidebar_item(def: MClass): TplListItem do - var classes = def.intro.tpl_css_classes.to_a + private fun tpl_sidebar_item(def: MClass): ListItem do + var classes = def.intro.css_classes if intros.has(def) then classes.add "intro" else classes.add "redef" end var lnk = new Template - lnk.add new TplLabel.with_classes(classes) - lnk.add def.tpl_link - return new TplListItem.with_content(lnk) + lnk.add new DocHTMLLabel.with_classes(classes) + lnk.add def.html_link + return new ListItem(lnk) end end redef class MModulePage - redef fun tpl_topmenu(v, doc) do - var topmenu = super + redef fun init_topmenu(v, doc) do + super var mproject = mentity.mproject - topmenu.add_link new TplLink(mproject.nitdoc_url, mproject.nitdoc_name) - topmenu.add_link new TplLink(mentity.nitdoc_url, mentity.nitdoc_name) - return topmenu + topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name)) + topmenu.add_li new ListItem(new Link(mentity.nitdoc_url, mentity.html_name)) + topmenu.active_item = topmenu.items.last end # Class list to display in sidebar - redef fun tpl_sidebar(v, doc) do + redef fun init_sidebar(v, doc) do # TODO filter here? - var sidebar = new TplSidebar + super var mclasses = new HashSet[MClass] mclasses.add_all mentity.filter_intro_mclasses(v.ctx.min_visibility) mclasses.add_all mentity.filter_redef_mclasses(v.ctx.min_visibility) - if mclasses.is_empty then return sidebar - var list = new TplList.with_classes(["list-unstyled", "list-labeled"]) + if mclasses.is_empty then return + var list = new UnorderedList + list.css_classes.add "list-unstyled list-labeled" var sorted = mclasses.to_a v.name_sorter.sort(sorted) for mclass in sorted do list.add_li tpl_sidebar_item(mclass) end - sidebar.boxes.add new TplSideBox.with_content("All classes", list) - return sidebar + sidebar.boxes.add new DocSideBox("All classes", list) + sidebar.boxes.last.is_open = false end - private fun tpl_sidebar_item(def: MClass): TplListItem do - var classes = def.intro.tpl_css_classes.to_a + private fun tpl_sidebar_item(def: MClass): ListItem do + var classes = def.intro.css_classes if def.intro_mmodule == self.mentity then classes.add "intro" else classes.add "redef" end var lnk = new Template - lnk.add new TplLabel.with_classes(classes) - lnk.add def.tpl_link - return new TplListItem.with_content(lnk) + lnk.add new DocHTMLLabel.with_classes(classes) + lnk.add def.html_link + return new ListItem(lnk) end end redef class MClassPage - redef fun tpl_title(v, doc) do - return "{mentity.nitdoc_name}{mentity.tpl_signature.write_to_string}" - end - - redef fun tpl_topmenu(v, doc) do - var topmenu = super + redef fun init_topmenu(v, doc) do + super var mproject = mentity.intro_mmodule.mgroup.mproject - topmenu.add_link new TplLink("{mproject.nitdoc_url}", "{mproject.nitdoc_name}") - topmenu.add_link new TplLink(page_url, mentity.nitdoc_name) - return topmenu + topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name)) + topmenu.add_li new ListItem(new Link(html_url, mentity.html_name)) + topmenu.active_item = topmenu.items.last end - redef fun tpl_sidebar(v, doc) do - var sidebar = new TplSidebar + redef fun init_sidebar(v, doc) do + super var by_kind = new PropertiesByKind.with_elements(mclass_inherited_mprops(v, doc)) - var summary = new TplList.with_classes(["list-unstyled"]) + var summary = new UnorderedList + summary.css_classes.add "list-unstyled" by_kind.sort_groups(v.name_sorter) for g in by_kind.groups do tpl_sidebar_list(g, summary) - sidebar.boxes.add new TplSideBox.with_content("All properties", summary) - return sidebar + sidebar.boxes.add new DocSideBox("All properties", summary) + sidebar.boxes.last.is_open = false end - private fun tpl_sidebar_list(mprops: PropertyGroup[MProperty], summary: TplList) do + private fun tpl_sidebar_list(mprops: PropertyGroup[MProperty], summary: UnorderedList) do if mprops.is_empty then return - var entry = new TplListItem.with_content(mprops.title) - var list = new TplList.with_classes(["list-unstyled", "list-labeled"]) + var list = new UnorderedList + list.css_classes.add "list-unstyled list-labeled" for mprop in mprops do list.add_li tpl_sidebar_item(mprop) end - entry.append list - summary.elts.add entry + var content = new Template + content.add mprops.title + content.add list + var li = new ListItem(content) + summary.add_li li end - private fun tpl_sidebar_item(mprop: MProperty): TplListItem do - var classes = mprop.intro.tpl_css_classes.to_a + private fun tpl_sidebar_item(mprop: MProperty): ListItem do + var classes = mprop.intro.css_classes if not mprop_is_local(mprop) then classes.add "inherit" var cls_url = mprop.intro.mclassdef.mclass.nitdoc_url - var def_url = "{cls_url}#{mprop.nitdoc_id}" - var lnk = new TplLink(def_url, mprop.nitdoc_name) + 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 var item = new Template - item.add new TplLabel.with_classes(classes) + item.add new DocHTMLLabel.with_classes(classes) item.add lnk - return new TplListItem.with_content(item) + return new ListItem(item) end if mpropdefs.has(mprop.intro) then classes.add "intro" else classes.add "redef" end + var def = select_mpropdef(mprop) + var anc = def.html_link_to_anchor + anc.href = "#{def.nitdoc_id}.definition" var lnk = new Template - lnk.add new TplLabel.with_classes(classes) - lnk.add mprop.tpl_anchor - return new TplListItem.with_content(lnk) + lnk.add new DocHTMLLabel.with_classes(classes) + lnk.add anc + return new ListItem(lnk) + end + + # Get the mpropdef contained in `self` page for a mprop. + # + # FIXME this method is used to translate a mprop into a mpropdefs for + # section linking. A better page structure should avoid this... + private fun select_mpropdef(mprop: MProperty): MPropDef do + for mclassdef in mentity.mclassdefs do + for mpropdef in mclassdef.mpropdefs do + if mpropdef.mproperty == mprop then return mpropdef + end + end + abort # FIXME is there a case where the prop is not found? end private fun mclass_inherited_mprops(v: RenderHTMLPhase, doc: DocModel): Set[MProperty] do @@ -498,348 +432,168 @@ redef class MClassPage end redef class MPropertyPage - redef fun tpl_topmenu(v, doc) do - var topmenu = super + redef fun init_title(v, doc) do + title = "{mentity.html_name}{mentity.html_short_signature.write_to_string}" + end + + redef fun init_topmenu(v, doc) do + super var mmodule = mentity.intro_mclassdef.mmodule var mproject = mmodule.mgroup.mproject var mclass = mentity.intro_mclassdef.mclass - topmenu.add_link new TplLink("{mproject.nitdoc_url}", "{mproject.nitdoc_name}") - topmenu.add_link new TplLink("{mclass.nitdoc_url}", "{mclass.nitdoc_name}") - topmenu.add_link new TplLink(page_url, mentity.nitdoc_name) - return topmenu + topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name)) + topmenu.add_li new ListItem(new Link(mclass.nitdoc_url, mclass.html_name)) + topmenu.add_li new ListItem(new Link(html_url, mentity.html_name)) + topmenu.active_item = topmenu.items.last end - - redef fun tpl_title(v, doc) do - return "{mentity.nitdoc_name}{mentity.tpl_signature.write_to_string}" - end - - redef fun tpl_sidebar(v, doc) do return new TplSidebar end redef class DocComposite - # Render this DocComposite as HTML. + # Prepares the HTML rendering for this element. # - # FIXME needed to maintain TplSection compatibility. - fun render(v: RenderHTMLPhase, doc: DocModel, page: MEntityPage, parent: TplSectionElt) is abstract + # This visit is mainly used to set template attributes before rendering. + fun init_html_render(v: RenderHTMLPhase, doc: DocModel, page: DocPage) do + for child in children do child.init_html_render(v, doc, page) + end end -redef class DocRoot - - # Start the rendering from root. - # - # FIXME needed to maintain TplSection compatibility. - fun start_rendering(v: RenderHTMLPhase, doc: DocModel, page: MEntityPage): TplSection do - var section = new TplSection("top") - var mentity = page.mentity - section.title = mentity.nitdoc_name - section.subtitle = mentity.tpl_declaration - # FIXME ugly hack to avoid diff +# FIXME hideous hacks to avoid diff +redef class MEntitySection + redef fun init_html_render(v, doc, page) do + if not page isa MEntityPage then return + var mentity = self.mentity if mentity isa MGroup and mentity.is_root then - section.title = mentity.mproject.nitdoc_name - section.subtitle = mentity.mproject.tpl_declaration - else if mentity isa MClass then - section.title = "{mentity.nitdoc_name}{mentity.tpl_signature.write_to_string}" + html_title = mentity.mproject.html_name + html_subtitle = mentity.mproject.html_declaration else if mentity isa MProperty then - section.title = "{mentity.nitdoc_name}{mentity.intro.tpl_signature.write_to_string}" - section.subtitle = mentity.tpl_namespace - section.summary_title = mentity.nitdoc_name - end - render(v, doc, page, section) - return section - end - - redef fun render(v, doc, page, parent) do - for child in children do - child.render(v, doc, page, parent) + var title = new Template + title.add mentity.html_name + title.add mentity.html_signature + html_title = title + html_subtitle = mentity.html_namespace + html_toc_title = mentity.html_name end + super end end +# FIXME hideous hacks to avoid diff redef class ConcernSection - redef fun render(v, doc, page, parent) do - var section = new TplSection(mentity.nitdoc_id) + redef fun init_html_render(v, doc, page) do + if not page isa MEntityPage then return var mentity = self.mentity - # FIXME hideous hacks to avoid diff - if page.mentity isa MModule and mentity isa MModule then - render_concern_mmodule(page, section, mentity) - else if page.mentity isa MClass and mentity isa MModule then - render_concern_other(page, section, mentity) - else if page.mentity isa MProperty and mentity isa MModule then - render_concern_other(page, section, mentity) - end - for child in children do - child.render(v, doc, page, section) - end - parent.add_child section - end - - private fun render_concern_mmodule(page: MEntityPage, section: TplSection, mmodule: MModule) do - var title = new Template - if mmodule == page.mentity then + if page isa MGroupPage then + html_title = null + html_toc_title = mentity.html_name + is_toc_hidden = false + else if page.mentity isa MModule and mentity isa MModule then + var title = new Template + if mentity == page.mentity then + title.add "in " + html_toc_title = "in {mentity.html_name}" + else + title.add "from " + html_toc_title = "from {mentity.html_name}" + end + title.add mentity.html_namespace + html_title = title + else if (page.mentity isa MClass and mentity isa MModule) or + (page.mentity isa MProperty and mentity isa MModule) then + var title = new Template title.add "in " - section.summary_title = "in {mmodule.nitdoc_name}" - else - title.add "from " - section.summary_title = "from {mmodule.nitdoc_name}" + title.add mentity.html_namespace + html_title = title + html_toc_title = "in {mentity.html_name}" end - title.add mmodule.tpl_namespace - section.title = title - end - - private fun render_concern_other(page: MEntityPage, section: TplSection, mmodule: MModule) do - var title = new Template - title.add "in " - title.add mmodule.tpl_namespace - section.title = title - section.summary_title = "in {mmodule.nitdoc_name}" + super end end +# TODO redo showlink redef class IntroArticle - redef fun render(v, doc, page, parent) do - var article = new TplArticle("intro") + redef fun init_html_render(v, doc, page) do var mentity = self.mentity if mentity isa MModule then - article.source_link = v.tpl_showsource(mentity.location) + html_source_link = v.html_source_link(mentity.location) else if mentity isa MClassDef then - article.source_link = v.tpl_showsource(mentity.location) + html_source_link = v.html_source_link(mentity.location) else if mentity isa MPropDef then - article.source_link = v.tpl_showsource(mentity.location) - end - # article.subtitle = mentity.tpl_declaration - # FIXME diff hack - if mentity isa MProperty then - # intro title - var ns = mentity.intro.mclassdef.mmodule.tpl_namespace - var section = new TplSection("intro") - var title = new Template - title.add "Introduction in " - title.add ns - section.title = title - section.summary_title = "Introduction" - var intro = mentity.intro.tpl_article - intro.source_link = v.tpl_showsource(mentity.intro.location) - section.add_child intro - parent.add_child section - else - article.content = mentity.tpl_definition - parent.add_child article + html_source_link = v.html_source_link(mentity.location) end end end -redef class ConcernsArticle - redef fun render(v, doc, page, parent) do - # FIXME diff hack - var title = "concerns" - if page.mentity isa MProperty then title = "Concerns" - parent.add_child new TplArticle. - with_content(title, "Concerns", concerns.to_tpl) - end -end - +# FIXME less hideous hacks... redef class DefinitionArticle - redef fun render(v, doc, page, parent) do - var article: TplArticle + redef fun init_html_render(v, doc, page) do var mentity = self.mentity - # FIXME hideous hacks... - if mentity isa MModule then - article = mentity.tpl_article - article.subtitle = mentity.tpl_declaration - article.content = mentity.tpl_definition - else if mentity isa MClass then - article = make_mclass_article(v, page) - else if mentity isa MClassDef then - article = make_mclassdef_article(v, page) - article.source_link = v.tpl_showsource(mentity.location) - else if mentity isa MPropDef and page.mentity isa MClass then - article = make_mpropdef_article(v, doc, page) - else - article = mentity.tpl_article - article.subtitle = mentity.tpl_declaration - if mentity isa MPropDef then - article.source_link = v.tpl_showsource(mentity.location) - end - if not mentity isa MVirtualTypeProp then - # article.content = mentity.tpl_comment - end - end - for child in children do - child.render(v, doc, page, article) - end - parent.add_child article - end - - # FIXME avoid diff while preserving TplArticle compatibility. - - private fun make_mclass_article(v: RenderHTMLPhase, page: MEntityPage): TplArticle do - var article = mentity.tpl_article - article.subtitle = mentity.tpl_namespace - article.content = null - return article - end - - private fun make_mclassdef_article(v: RenderHTMLPhase, page: MEntityPage): TplArticle do - var mclassdef = mentity.as(MClassDef) - var article = mentity.tpl_article - if mclassdef.is_intro and mclassdef.mmodule != page.mentity then - article = mentity.tpl_short_article - end - var title = new Template - title.add "in " - title.add mclassdef.mmodule.tpl_namespace - article.subtitle = title - return article - end - - private fun make_mpropdef_article(v: RenderHTMLPhase, doc: DocModel, page: MEntityPage): TplArticle - do - var mpropdef = mentity.as(MPropDef) - var mprop = mpropdef.mproperty - var article = new TplArticle(mprop.nitdoc_id) - var title = new Template - title.add mprop.tpl_icon - title.add "" - if mpropdef.is_intro then - title.add mprop.tpl_link - title.add mprop.intro.tpl_signature - else - var cls_url = mprop.intro.mclassdef.mclass.nitdoc_url - var def_url = "{cls_url}#{mprop.nitdoc_id}" - var lnk = new TplLink.with_title(def_url, mprop.nitdoc_name, - "Go to introduction") - title.add "redef " - title.add lnk - end - article.title = title - article.title_classes.add "signature" - article.summary_title = "{mprop.nitdoc_name}" - article.subtitle = mpropdef.tpl_namespace - if mpropdef.mdoc_or_fallback != null then - article.content = mpropdef.mdoc_or_fallback.tpl_comment - end - # TODO move in its own phase? let's see after doc_template refactoring. - # Add linearization - var all_defs = new HashSet[MPropDef] - for local_def in local_defs(page.as(MClassPage), mprop) do - all_defs.add local_def - var smpropdef = local_def - while not smpropdef.is_intro do - smpropdef = smpropdef.lookup_next_definition( - doc.mainmodule, smpropdef.mclassdef.bound_mtype) - all_defs.add smpropdef + if mentity isa MProject or mentity isa MModule then + var title = new Template + title.add mentity.html_icon + title.add mentity.html_namespace + html_title = title + html_toc_title = mentity.html_name + if mentity isa MModule then + html_source_link = v.html_source_link(mentity.location) end - end - var lin = all_defs.to_a - doc.mainmodule.linearize_mpropdefs(lin) - if lin.length > 1 then - var lin_article = new TplArticle("{mpropdef.nitdoc_id}.lin") - lin_article.title = "Inheritance" - var lst = new TplList.with_classes(["list-unstyled", "list-labeled"]) - for smpropdef in lin do - lst.add_li smpropdef.tpl_inheritance_item + else if mentity isa MClassDef then + var title = new Template + title.add "in " + title.add mentity.mmodule.html_namespace + html_title = mentity.html_declaration + html_subtitle = title + html_toc_title = "in {mentity.html_name}" + html_source_link = v.html_source_link(mentity.location) + if page isa MEntityPage and mentity.is_intro and mentity.mmodule != page.mentity then + is_short_comment = true end - lin_article.content = lst - article.add_child lin_article - end - return article - end - - # Filter `page.mpropdefs` for this `mpropertie`. - # - # FIXME compatability with current templates. - private fun local_defs(page: MClassPage, mproperty: MProperty): HashSet[MPropDef] do - var mpropdefs = new HashSet[MPropDef] - for mpropdef in page.mpropdefs do - if mpropdef.mproperty == mproperty then - mpropdefs.add mpropdef + if page isa MModulePage then is_toc_hidden = true + else if mentity isa MPropDef then + if page isa MClassPage then + var title = new Template + title.add mentity.html_icon + title.add mentity.html_declaration + html_title = title + html_subtitle = mentity.html_namespace + html_toc_title = mentity.html_name + else + var title = new Template + title.add "in " + title.add mentity.mclassdef.html_link + html_title = title + html_toc_title = "in {mentity.mclassdef.html_name}" end + html_source_link = v.html_source_link(mentity.location) end - return mpropdefs - end -end - -redef class IntrosRedefsListArticle - redef fun render(v, doc, page, parent) do - if mentities.is_empty then return - var title = list_title - # FIXME diff hack - var id = "intros" - if title == "Redefines" then id = "redefs" - var article = new TplArticle.with_title("{mentity.nitdoc_id}.{id}", title) - var list = new TplList.with_classes(["list-unstyled", "list-labeled"]) - for mentity in mentities do - list.add_li mentity.tpl_list_item - end - article.content = list - parent.add_child article - end -end - -# FIXME compatibility with doc_templates. -redef class ImportationListSection - redef fun render(v, doc, page, parent) do - var section = new TplSection.with_title("dependencies", "Dependencies") - for child in children do - child.render(v, doc, page, section) + if page isa MGroupPage and mentity isa MModule then + is_toc_hidden = true end - parent.add_child section - end -end - -# FIXME compatibility with doc_templates. -redef class InheritanceListSection - redef fun render(v, doc, page, parent) do - var section = new TplSection.with_title("inheritance", "Inheritance") - for child in children do - child.render(v, doc, page, section) - end - parent.add_child section + super end end -# FIXME compatibility with doc_templates. -redef class HierarchyListArticle - redef fun render(v, doc, page, parent) do - if mentities.is_empty then return - var title = list_title - var id = list_title.to_lower - var article = new TplArticle.with_title(id, title) - var list = new TplList.with_classes(["list-unstyled", "list-definition"]) - for mentity in mentities do - list.elts.add mentity.tpl_list_item +redef class HomeArticle + redef fun init_html_render(v, doc, page) do + if v.ctx.opt_custom_title.value != null then + self.html_title = v.ctx.opt_custom_title.value.to_s + self.html_toc_title = v.ctx.opt_custom_title.value.to_s end - article.content = list - parent.add_child article + self.content = v.ctx.opt_custom_intro.value + super end end redef class GraphArticle - redef fun render(v, doc, page, parent) do + redef fun init_html_render(v, doc, page) do var output_dir = v.ctx.output_dir - var path = output_dir / id + var path = output_dir / graph_id var path_sh = path.escape_to_sh var file = new FileWriter.open("{path}.dot") file.write(dot) file.close sys.system("\{ test -f {path_sh}.png && test -f {path_sh}.s.dot && diff -- {path_sh}.dot {path_sh}.s.dot >/dev/null 2>&1 ; \} || \{ cp -- {path_sh}.dot {path_sh}.s.dot && dot -Tpng -o{path_sh}.png -Tcmapx -o{path_sh}.map {path_sh}.s.dot ; \}") var fmap = new FileReader.open("{path}.map") - var map = fmap.read_all + self.map = fmap.read_all fmap.close - - var article = new TplArticle("graph") - var alt = "" - # FIXME diff hack - # if title != null then - # article.title = title - # alt = "alt='{title.html_escape}'" - # end - article.css_classes.add "text-center" - var content = new Template - var name_html = id.html_escape - content.add "" - content.add map - article.content = content - parent.add_child article end end