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 a3fbf07..ebc1193 100644
--- a/src/doc/doc_phases/doc_html.nit
+++ b/src/doc/doc_phases/doc_html.nit
@@ -46,7 +46,7 @@ redef class ToolContext
 	# Display a custom brand or logo in the documentation top menu.
 	var opt_custom_brand = new OptionString("custom link to external site", "--custom-brand")
 
-	# Display a custom introduction text before the projects overview.
+	# Display a custom introduction text before the packages overview.
 	var opt_custom_intro = new OptionString("custom intro text for homepage", "--custom-overview-text")
 	# Display a custom footer on each documentation page.
 	#
@@ -68,7 +68,7 @@ redef class ToolContext
 	# FIXME redo the plugin
 	var opt_github_base_sha1 = new OptionString("Git sha1 of base commit used to create pull request", "--github-base-sha1")
 	# FIXME redo the plugin
-	var opt_github_gitdir = new OptionString("Git working directory used to resolve path name (ex: /home/me/myproject/)", "--github-gitdir")
+	var opt_github_gitdir = new OptionString("Git working directory used to resolve path name (ex: /home/me/mypackage/)", "--github-gitdir")
 
 	redef init do
 		super
@@ -104,7 +104,7 @@ class RenderHTMLPhase
 
 	redef fun apply do
 		init_output_dir
-		for page in doc.pages do
+		for page in doc.pages.values do
 			page.render(self, doc).write_to_file("{ctx.output_dir.to_s}/{page.html_url}")
 		end
 	end
@@ -187,19 +187,12 @@ redef class DocPage
 	# all properties below are roughly copied from `doc_pages`
 
 	# Build page title string
-	fun init_title(v: RenderHTMLPhase, doc: DocModel) is abstract
+	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
-		var brand = v.ctx.opt_custom_brand.value
-		if brand != null then
-			var tpl = new Template
-			tpl.add "<span class='navbar-brand'>"
-			tpl.add brand
-			tpl.add "</span>"
-			topmenu.brand = tpl
-		end
+		topmenu.brand = v.ctx.opt_custom_brand.value
 		var title = "Overview"
 		if v.ctx.opt_custom_title.value != null then
 			title = v.ctx.opt_custom_title.value.to_s
@@ -245,7 +238,13 @@ redef class SearchPage
 end
 
 redef class MEntityPage
-	redef var html_url is lazy do return mentity.nitdoc_url
+	redef var html_url is lazy do
+		if mentity isa MGroup and mentity.mdoc != null then
+			return "api_{mentity.nitdoc_url}"
+		end
+		return mentity.nitdoc_url
+	end
+
 	redef fun init_title(v, doc) do title = mentity.html_name
 end
 
@@ -253,19 +252,45 @@ end
 # doc phases. This is to preserve the compatibility with the current
 # `doc_templates` module.
 
+redef class ReadmePage
+	redef var html_url is lazy do return mentity.nitdoc_url
+
+	redef fun init_topmenu(v, doc) do
+		super
+		var mpackage = mentity.mpackage
+		if not mentity.is_root then
+			topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
+		end
+		topmenu.add_li new ListItem(new Link(html_url, mpackage.html_name))
+		topmenu.active_item = topmenu.items.last
+	end
+
+	redef fun init_sidebar(v, doc) do
+		super
+		var api_lnk = """<a href="api_{{{mentity.nitdoc_url}}}">Go to API</a>"""
+		sidebar.boxes.unshift new DocSideBox(api_lnk, "")
+	end
+end
+
 redef class MGroupPage
 	redef fun init_topmenu(v, doc) do
 		super
-		var mproject = mentity.mproject
+		var mpackage = mentity.mpackage
 		if not mentity.is_root then
-			topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+			topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
 		end
-		topmenu.add_li new ListItem(new Link(html_url, mproject.html_name))
+		topmenu.add_li new ListItem(new Link(html_url, mpackage.html_name))
 		topmenu.active_item = topmenu.items.last
 	end
 
 	redef fun init_sidebar(v, doc) do
 		super
+		# README link
+		if mentity.mdoc != null then
+			var doc_lnk = """<a href="{{{mentity.nitdoc_url}}}">Go to README</a>"""
+			sidebar.boxes.unshift new DocSideBox(doc_lnk, "")
+		end
+		# MClasses list
 		var mclasses = new HashSet[MClass]
 		mclasses.add_all intros
 		mclasses.add_all redefs
@@ -298,8 +323,8 @@ end
 redef class MModulePage
 	redef fun init_topmenu(v, doc) do
 		super
-		var mproject = mentity.mproject
-		topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+		var mpackage = mentity.mpackage
+		topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
 		topmenu.add_li new ListItem(new Link(mentity.nitdoc_url, mentity.html_name))
 		topmenu.active_item = topmenu.items.last
 	end
@@ -309,8 +334,8 @@ redef class MModulePage
 		# TODO filter here?
 		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)
+		mclasses.add_all mentity.collect_intro_mclasses(v.ctx.min_visibility)
+		mclasses.add_all mentity.collect_redef_mclasses(v.ctx.min_visibility)
 		if mclasses.is_empty then return
 		var list = new UnorderedList
 		list.css_classes.add "list-unstyled list-labeled"
@@ -342,8 +367,8 @@ redef class MClassPage
 
 	redef fun init_topmenu(v, doc) do
 		super
-		var mproject = mentity.intro_mmodule.mgroup.mproject
-		topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+		var mpackage = mentity.intro_mmodule.mgroup.mpackage
+		topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
 		topmenu.add_li new ListItem(new Link(html_url, mentity.html_name))
 		topmenu.active_item = topmenu.items.last
 	end
@@ -379,10 +404,10 @@ 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}#{mprop.nitdoc_id}"
+			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
+			if mdoc != null then lnk.title = mdoc.synopsis
 			var item = new Template
 			item.add new DocHTMLLabel.with_classes(classes)
 			item.add lnk
@@ -393,16 +418,32 @@ redef class MClassPage
 		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 DocHTMLLabel.with_classes(classes)
-		lnk.add mprop.html_link_to_anchor
+		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
 		var res = new HashSet[MProperty]
-		var local = mentity.local_mproperties(v.ctx.min_visibility)
-		for mprop in mentity.inherited_mproperties(doc.mainmodule, v.ctx.min_visibility) do
+		var local = mentity.collect_local_mproperties(v.ctx.min_visibility)
+		for mprop in mentity.collect_inherited_mproperties(v.ctx.min_visibility) do
 			if local.has(mprop) then continue
 			#if mprop isa MMethod and mprop.is_init then continue
 			if mprop.intro.mclassdef.mclass.name == "Object" and
@@ -430,9 +471,9 @@ redef class MPropertyPage
 	redef fun init_topmenu(v, doc) do
 		super
 		var mmodule = mentity.intro_mclassdef.mmodule
-		var mproject = mmodule.mgroup.mproject
+		var mpackage = mmodule.mgroup.mpackage
 		var mclass = mentity.intro_mclassdef.mclass
-		topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+		topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.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
@@ -454,15 +495,15 @@ redef class MEntitySection
 		if not page isa MEntityPage then return
 		var mentity = self.mentity
 		if mentity isa MGroup and mentity.is_root then
-			html_title = mentity.mproject.html_name
-			html_subtitle = mentity.mproject.html_declaration
+			html_title = mentity.mpackage.html_name
+			html_subtitle = mentity.mpackage.html_declaration
 		else if mentity isa MProperty then
 			var title = new Template
 			title.add mentity.html_name
 			title.add mentity.html_signature
 			html_title = title
 			html_subtitle = mentity.html_namespace
-			toc_title = mentity.html_name
+			html_toc_title = mentity.html_name
 		end
 		super
 	end
@@ -473,14 +514,18 @@ redef class ConcernSection
 	redef fun init_html_render(v, doc, page) do
 		if not page isa MEntityPage then return
 		var mentity = self.mentity
-		if page.mentity isa MModule and mentity isa MModule 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 "
-				toc_title = "in {mentity.html_name}"
+				html_toc_title = "in {mentity.html_name}"
 			else
 				title.add "from "
-				toc_title = "from {mentity.html_name}"
+				html_toc_title = "from {mentity.html_name}"
 			end
 			title.add mentity.html_namespace
 			html_title = title
@@ -490,7 +535,7 @@ redef class ConcernSection
 			title.add "in "
 			title.add mentity.html_namespace
 			html_title = title
-			toc_title = "in {mentity.html_name}"
+			html_toc_title = "in {mentity.html_name}"
 		end
 		super
 	end
@@ -514,30 +559,22 @@ end
 redef class DefinitionArticle
 	redef fun init_html_render(v, doc, page) do
 		var mentity = self.mentity
-		if mentity isa MProject or mentity isa MModule then
+		if mentity isa MPackage or mentity isa MModule then
 			var title = new Template
 			title.add mentity.html_icon
 			title.add mentity.html_namespace
 			html_title = title
-			toc_title = mentity.html_name
+			html_toc_title = mentity.html_name
 			if mentity isa MModule then
 				html_source_link = v.html_source_link(mentity.location)
 			end
-		else if mentity isa MClass then
-			var title = new Template
-			title.add mentity.html_icon
-			title.add mentity.html_link
-			html_title = title
-			html_subtitle = mentity.html_namespace
-			toc_title = mentity.html_name
-			is_no_body = true
 		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
-			toc_title = "in {mentity.html_name}"
+			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
@@ -550,16 +587,19 @@ redef class DefinitionArticle
 				title.add mentity.html_declaration
 				html_title = title
 				html_subtitle = mentity.html_namespace
-				toc_title = mentity.html_name
+				html_toc_title = mentity.html_name
 			else
 				var title = new Template
 				title.add "in "
 				title.add mentity.mclassdef.html_link
 				html_title = title
-				toc_title = "in {mentity.mclassdef.html_name}"
+				html_toc_title = "in {mentity.mclassdef.html_name}"
 			end
 			html_source_link = v.html_source_link(mentity.location)
 		end
+		if page isa MGroupPage and mentity isa MModule then
+			is_toc_hidden = true
+		end
 		super
 	end
 end
@@ -568,7 +608,7 @@ 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.toc_title = v.ctx.opt_custom_title.value.to_s
+			self.html_toc_title = v.ctx.opt_custom_title.value.to_s
 		end
 		self.content = v.ctx.opt_custom_intro.value
 		super
@@ -577,15 +617,19 @@ end
 
 redef class GraphArticle
 	redef fun init_html_render(v, doc, page) do
-		var output_dir = v.ctx.output_dir
-		var path = output_dir / id
-		var path_sh = path.escape_to_sh
+		var path = v.ctx.output_dir / graph_id
 		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")
-		self.map = fmap.read_all
-		fmap.close
+		var proc = new ProcessReader("dot", "-Tsvg", "-Tcmapx", "{path}.dot")
+		var svg = new Buffer
+		var i = 0
+		while not proc.eof do
+			i += 1
+			if i < 6 then continue # skip dot default header
+			svg.append proc.read_line
+		end
+		proc.close
+		self.svg = svg.write_to_string
 	end
 end