X-Git-Url: http://nitlanguage.org diff --git a/src/doc/html_templates/html_model.nit b/src/doc/html_templates/html_model.nit index 15b2963..3882eb0 100644 --- a/src/doc/html_templates/html_model.nit +++ b/src/doc/html_templates/html_model.nit @@ -18,6 +18,7 @@ module html_model import doc_base import doc_down import html_components +import html::bootstrap import ordered_tree redef class Location @@ -45,9 +46,22 @@ redef class MEntity # URL of this entity’s Nitdoc page. fun nitdoc_url: String is abstract - # A template link to the mentity `nitdoc_id` - fun tpl_anchor: TplLink do - var tpl = new TplLink("#{nitdoc_id}", nitdoc_name) + # Returns the mentity name without short signature. + # + # * MProject: `foo` + # * MGroup: `foo` + # * MModule: `foo` + # * MClass: `Foo[E]` + # * MClassDef: `Foo[E]` + # * MProperty: `foo(e)` + # * MPropdef: `foo(e)` + var html_name: String is lazy do return name.html_escape + + # Returns a Link to the mentity `html_url`. + # + # Example: `html_short_name + var html_link: Link is lazy do + var tpl = new Link(nitdoc_url, html_name) var mdoc = mdoc_or_fallback if mdoc != null then tpl.title = mdoc.short_comment @@ -55,9 +69,11 @@ redef class MEntity return tpl end - # A template link to the mentity `nitdoc_url` - fun tpl_link: TplLink do - var tpl = new TplLink(nitdoc_url, nitdoc_name) + # Returns a Link to the mentity `nitdoc_id`. + # + # Example: `html_short_name + fun html_link_to_anchor: Link do + var tpl = new Link("#{nitdoc_id}", html_name) var mdoc = mdoc_or_fallback if mdoc != null then tpl.title = mdoc.short_comment @@ -80,7 +96,7 @@ redef class MEntity var tpl = new TplArticle.with_title(nitdoc_id, tpl_title) tpl.title_classes.add "signature" tpl.subtitle = tpl_namespace - tpl.summary_title = nitdoc_name + tpl.summary_title = html_name return tpl end @@ -98,7 +114,7 @@ redef class MEntity fun tpl_list_item: TplListItem do var lnk = new Template lnk.add new TplLabel.with_classes(tpl_css_classes) - lnk.add tpl_link + lnk.add html_link var mdoc = mdoc_or_fallback if mdoc != null then lnk.add ": " @@ -129,7 +145,7 @@ redef class MConcern # Return a li element for `self` that can be displayed in a concern list private fun tpl_concern_item: TplListItem do var lnk = new Template - lnk.add tpl_anchor + lnk.add html_link_to_anchor var mdoc = mdoc_or_fallback if mdoc != null then lnk.add ": " @@ -146,12 +162,12 @@ redef class MProject redef fun tpl_declaration do var tpl = new Template tpl.add "project " - tpl.add tpl_link + tpl.add html_link tpl.add "" return tpl end - redef fun tpl_namespace do return tpl_link + redef fun tpl_namespace do return html_link redef fun tpl_definition do var tpl = new TplDefinition @@ -180,7 +196,7 @@ redef class MGroup tpl.add mproject.tpl_namespace if mproject.root != self then tpl.add "::" - tpl.add tpl_link + tpl.add html_link end return tpl end @@ -188,7 +204,7 @@ redef class MGroup redef fun tpl_declaration do var tpl = new Template tpl.add "group " - tpl.add tpl_link + tpl.add html_link tpl.add "" return tpl end @@ -231,7 +247,7 @@ redef class MModule tpl.add mgroup.tpl_namespace tpl.add "::" end - tpl.add tpl_link + tpl.add html_link return tpl end @@ -252,6 +268,22 @@ redef class MClass redef fun nitdoc_url do return "class_{nitdoc_id}.html" redef fun mdoc_or_fallback do return intro.mdoc + # Format: `Foo[E]` + redef var html_name is lazy do + var tpl = new Template + tpl.add name.html_escape + if arity > 0 then + tpl.add "[" + var parameter_names = new Array[String] + for p in mparameters do + parameter_names.add(p.html_name) + end + tpl.add parameter_names.join(", ") + tpl.add "]" + end + return tpl.write_to_string + end + redef fun tpl_declaration do return intro.tpl_declaration redef fun tpl_definition do return intro.tpl_definition @@ -259,7 +291,7 @@ redef class MClass var tpl = new Template tpl.add intro_mmodule.mgroup.mproject.tpl_namespace tpl.add "::" - tpl.add tpl_link + tpl.add html_link tpl.add "" return tpl end @@ -267,8 +299,7 @@ redef class MClass redef fun tpl_title do var title = new Template title.add tpl_icon - title.add tpl_link - title.add tpl_signature + title.add html_link return title end @@ -280,7 +311,7 @@ redef class MClass tpl.add "[" var parameter_names = new Array[String] for p in mparameters do - parameter_names.add(p.nitdoc_name) + parameter_names.add(p.html_name) end tpl.add parameter_names.join(", ") tpl.add "]" @@ -288,12 +319,6 @@ redef class MClass return tpl end - redef fun tpl_article do - var tpl = super - tpl.summary_title = "{nitdoc_name}{tpl_signature.write_to_string}" - return tpl - end - redef fun tpl_css_classes do return intro.tpl_css_classes end @@ -307,14 +332,14 @@ redef class MClassDef var tpl = new Template tpl.add mmodule.tpl_namespace tpl.add "::" - tpl.add mclass.tpl_link + tpl.add mclass.html_link tpl.add "" return tpl end redef fun tpl_article do var tpl = new TplArticle(nitdoc_id) - tpl.summary_title = "in {mmodule.nitdoc_name}" + tpl.summary_title = "in {mmodule.html_name}" tpl.title = tpl_declaration tpl.title_classes.add "signature" var title = new Template @@ -331,15 +356,14 @@ redef class MClassDef redef fun tpl_title do var title = new Template title.add tpl_icon - title.add tpl_link - title.add tpl_signature + title.add html_link return title end redef fun tpl_declaration do var tpl = new Template tpl.add tpl_modifiers - tpl.add tpl_link + tpl.add html_link tpl.add tpl_signature return tpl end @@ -350,7 +374,7 @@ redef class MClassDef if not mparameters.is_empty then tpl.add "[" for i in [0..mparameters.length[ do - tpl.add "{mparameters[i].nitdoc_name}: " + tpl.add "{mparameters[i].html_name}: " tpl.add bound_mtype.arguments[i].tpl_signature if i < mparameters.length - 1 then tpl.add ", " end @@ -396,7 +420,7 @@ redef class MProperty var tpl = new Template tpl.add intro_mclassdef.mclass.tpl_namespace tpl.add "::" - tpl.add intro.tpl_link + tpl.add intro.html_link tpl.add "" return tpl end @@ -422,16 +446,16 @@ redef class MPropDef var tpl = new Template tpl.add mclassdef.tpl_namespace tpl.add "::" - tpl.add tpl_link + tpl.add html_link return tpl end redef fun tpl_article do var tpl = new TplArticle(nitdoc_id) - tpl.summary_title = "in {mclassdef.nitdoc_name}" + tpl.summary_title = "in {mclassdef.html_name}" var title = new Template title.add "in " - title.add mclassdef.tpl_link + title.add mclassdef.html_link tpl.title = title tpl.subtitle = tpl_declaration var mdoc = mdoc_or_fallback @@ -453,7 +477,7 @@ redef class MPropDef redef fun tpl_declaration do var tpl = new Template tpl.add tpl_modifiers - tpl.add tpl_link + tpl.add html_link tpl.add tpl_signature return tpl end @@ -480,8 +504,10 @@ redef class MPropDef redef fun tpl_list_item do var lnk = new Template lnk.add new TplLabel.with_classes(tpl_css_classes.to_a) - var anchor = tpl_link - anchor.href = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}" + var atext = html_link.text + var ahref = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}" + var atitle = html_link.title + var anchor = new Link.with_title(ahref, atext, atitle) lnk.add anchor var mdoc = mdoc_or_fallback if mdoc != null then @@ -496,8 +522,10 @@ redef class MPropDef lnk.add new TplLabel.with_classes(tpl_css_classes.to_a) lnk.add mclassdef.mmodule.tpl_namespace lnk.add "::" - var anchor = mclassdef.tpl_link - anchor.href = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}" + var atext = mclassdef.html_link.text + var ahref = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}" + var atitle = mclassdef.html_link.title + var anchor = new Link.with_title(ahref, atext, atitle) lnk.add anchor var mdoc = mdoc_or_fallback if mdoc != null then @@ -542,8 +570,8 @@ redef class MMethodDef end redef class MVirtualTypeProp - redef fun tpl_link do return mvirtualtype.tpl_link - redef fun tpl_signature do return tpl_link + redef fun html_link do return mvirtualtype.html_link + redef fun tpl_signature do return html_link end redef class MVirtualTypeDef @@ -561,8 +589,8 @@ redef class MType end redef class MClassType - redef fun tpl_link do return mclass.tpl_link - redef fun tpl_signature do return tpl_link + redef fun html_link do return mclass.html_link + redef fun tpl_signature do return html_link end redef class MNullableType @@ -576,8 +604,9 @@ end redef class MGenericType redef fun tpl_signature do + var lnk = html_link var tpl = new Template - tpl.add tpl_link + tpl.add new Link.with_title(lnk.href, mclass.name.html_escape, lnk.title) tpl.add "[" for i in [0..arguments.length[ do tpl.add arguments[i].tpl_signature @@ -589,15 +618,15 @@ redef class MGenericType end redef class MParameterType - redef fun tpl_link do - return new TplLink.with_title("{mclass.nitdoc_url}#FT_{name.to_cmangle}", name, "formal type") + redef fun html_link do + return new Link.with_title("{mclass.nitdoc_url}#FT_{name.to_cmangle}", name, "formal type") end - redef fun tpl_signature do return tpl_link + redef fun tpl_signature do return html_link end redef class MVirtualType - redef fun tpl_link do return mproperty.intro.tpl_link - redef fun tpl_signature do return tpl_link + redef fun html_link do return mproperty.intro.html_link + redef fun tpl_signature do return html_link end redef class MSignature @@ -676,7 +705,7 @@ redef class MRawType for part in parts do if part.target != null then - tpl.add part.target.as(not null).tpl_link + tpl.add part.target.as(not null).html_link else tpl.add part.text.html_escape end @@ -693,8 +722,8 @@ end redef class MInnerClassDef redef fun nitdoc_url do return inner.nitdoc_url - redef fun tpl_anchor do return inner.tpl_anchor - redef fun tpl_link do return inner.tpl_link + redef fun html_link_to_anchor do return inner.html_link_to_anchor + redef fun html_link do return inner.html_link redef fun tpl_signature do return inner.tpl_signature redef fun tpl_definition do