readable var _opt_private: OptionBool = new OptionBool("Generate the private API", "--private")
readable var _opt_nodot: OptionBool = new OptionBool("Do not generate graphes with graphviz", "--no-dot")
readable var _opt_sharedir: OptionString = new OptionString("Directory containing the nitdoc files", "--sharedir")
+ readable var _opt_overview_text: OptionString = new OptionString("Text displayed as introduction of Overview page", "--overview-text")
+ readable var _opt_footer_text: OptionString = new OptionString("Text displayed as footer of all pages", "--footer-text")
var sharedir: nullable String
fun public_only: Bool
end
var head = "<meta charset=\"utf-8\">" +
- "<script type=\"text/javascript\" src=\"scripts/jquery-1.7.1.min.js\"></script>\n" +
+ "<script type=\"text/javascript\" src=\"scripts/jquery-1.7.1.min.js\"></script>\n" +
+ "<script type=\"text/javascript\" src=\"quicksearch-list.js\"></script>\n" +
"<script type=\"text/javascript\" src=\"scripts/js-facilities.js\"></script>\n" +
"<link rel=\"stylesheet\" href=\"styles/main.css\" type=\"text/css\" media=\"screen\" />"
- var action_bar = "<header><nav class='main'><ul><li class=\"current\">Overview</li><li><a href='full-index.html'>Full Index</a></li></ul></nav></header>\n"
+ var action_bar = "<header><nav class='main'><ul><li class=\"current\">Overview</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
+
+ var overview_text = ""
+ if self._opt_overview_text.value != null then overview_text = self._opt_overview_text.value.as(not null)
+
+ var footer_text = ""
+ if self._opt_footer_text.value != null then footer_text = self._opt_footer_text.value.as(not null)
# generate the index
self.filename = "index.html"
add(action_bar)
add("<div class=\"page\">")
add("<div class=\"content fullpage\">")
- add("<h1>Modules</h1>\n<article class='overview'><ul>")
+ add("<h1>Modules</h1>\n<article class='overview'>{overview_text}<ul>")
var modss = mainmod.mhe.greaters_and_self.to_a
sort(modss)
for mod in modss do
add("</article></div>")
add("<div class='clear'></div>")
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/index.html")
assert mod isa MMSrcModule
if not mod.require_doc(self) then continue
self.filename = mod.html_name
- action_bar = "<header><nav class='main'><ul><li><a href='./'>Overview</a></li><li class=\"current\">{mod.name}</li><li><a href='full-index.html'>Full Index</a></li></ul></nav></header>\n"
+ action_bar = "<header><nav class='main'><ul><li><a href='./index.html'>Overview</a></li><li class=\"current\">{mod.name}</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
add("<!DOCTYPE html>")
add("<html><head>{head}<title>Module {mod.name}</title></head><body>\n")
add("<div class=\"page\">")
mod.file_page_doc(self)
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/{mod.html_name}.html")
end
for c in mainmod.local_classes do
if not c.require_doc(self) then continue
self.filename = c.html_name
- action_bar = "<header><nav class='main'><ul><li><a href='./'>Overview</a></li><li>{c.global.intro.mmmodule.toplevel_owner.html_link(self)}</li><li class=\"current\">{c.name}</li><li><a href='full-index.html'>Full Index</a></li></ul></nav></header>\n"
+ action_bar = "<header><nav class='main'><ul><li><a href='./index.html'>Overview</a></li><li>{c.global.intro.mmmodule.toplevel_owner.html_link(self)}</li><li class=\"current\">{c.name}</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
add("<!DOCTYPE html>")
add("<html><head>{head}<title>Class {c.name}</title></head><body>\n")
add("<div class=\"page\">")
c.file_page_doc(self)
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/{c.html_name}.html")
end
self.filename = "fullindex"
- action_bar = "<header><nav class='main'><ul><li><a href='./'>Overview</a></li><li class=\"current\">Full Index</li></ul></nav></header>\n"
+ action_bar = "<header><nav class='main'><ul><li><a href='./index.html'>Overview</a></li><li class=\"current\">Full Index</li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
add("<!DOCTYPE html>")
add("<html><head>{head}<title>Full Index</title></head><body>\n")
mainmod.file_index_page_doc(self)
add("</div>")
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/full-index.html")
+
+ self.filename = "quicksearch-list"
+ clear
+ mainmod.file_quicksearch_list_doc(self)
+ write_to("{dir}/quicksearch-list.js")
end
do
var s = opt_source.value
if s == null then
- add("in #{l.file.filename.simplify_path}")
+ add("in {l.file.filename.simplify_path}")
else
# THIS IS JUST UGLY ! (but there is no replace yet)
var x = s.split_with("%f")
option_context.add_option(opt_source)
option_context.add_option(opt_nodot)
option_context.add_option(opt_sharedir)
+ option_context.add_option(opt_overview_text)
+ option_context.add_option(opt_footer_text)
end
redef fun process_options
# The doc node from the AST
# Return null is none
fun doc: nullable ADoc do return null
+
+ # Return a jason entry for quicksearch list JSON Object
+ fun json_entry(dctx: DocContext): String is abstract
+
+ # Return the qualified name as string
+ fun qualified_name: String is abstract
+
end
redef class MMModule
return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
end
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{self.qualified_name}\",url:\"{html_name}.html\"\},"
+ end
+
+ redef fun qualified_name do
+ var buffer = new Buffer
+ for m in mnhe.smallers do
+ buffer.append("{m.html_name}::")
+ end
+ buffer.append("{self.name}")
+ return buffer.to_s
+ end
+
fun require_doc(dctx: DocContext): Bool
do
if dctx.public_only and not is_toplevel then return false
dctx.stage("</ul></article>\n")
dctx.close_stage
end
+
+ # Fill the quicksearch list JSON object
+ fun file_quicksearch_list_doc(dctx: DocContext)
+ do
+ var entities = new HashMap[String, Array[MMEntity]]
+ var props = new HashMap[MMGlobalProperty, Array[MMLocalProperty]]
+ for m in mhe.greaters_and_self do
+ if not m.require_doc(dctx) then continue
+ var a = new Array[MMEntity]
+ a.add(m)
+ entities[m.html_name] = a
+ end
+ for g in global_classes do
+ var lc = self[g]
+ if not lc.require_doc(dctx) then continue
+ var a = new Array[MMEntity]
+ a.add(lc)
+ entities[lc.html_name] = a
+ for gp in lc.global_properties do
+ var lp = lc[gp]
+ if not lp.require_doc(dctx) then continue
+ if props.has_key(lp.global) then
+ if not props[lp.global].has(lp) then
+ props[lp.global].add(lp)
+ end
+ else
+ props[lp.global] = [lp]
+ end
+ end
+ end
+
+ for k, v in props do
+ entities[k.short_name] = v
+ end
+
+ var keys = entities.keys.to_a
+ var sorter = new AlphaSorter[String]
+ sorter.sort(keys)
+
+ dctx.open_stage
+ dctx.stage("var entries = \{")
+ for key in keys do
+ dctx.add("\"{key}\": [")
+ for entity in entities[key] do
+ dctx.add(entity.json_entry(dctx))
+ end
+ dctx.add("],")
+ end
+ dctx.stage("\};")
+ dctx.close_stage
+ end
end
+redef class MMGlobalProperty
+ # Return the short name of the property
+ fun short_name: String do
+ return self.intro.html_name
+ end
+end
+
redef class MMLocalProperty
super MMEntity
# Anchor of the property description in the module html file
return "PROP_{local_class}_{cmangle(name)}"
end
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{qualified_name}\",url:\"{local_class.html_name}.html#{html_anchor}\"\},"
+ end
+
+ redef fun qualified_name do
+ return "{intro_module.qualified_name}::{local_class.html_name}::{html_name}"
+ end
+
fun html_open_link(dctx: DocContext): String
do
if not require_doc(dctx) then print "not required {self}"
if lp == tlp then continue
dctx.add(" {lp.mmmodule.html_link(dctx)}")
if lp.local_class.global != lc.global then
- dctx.add(" for {lp.local_class.html_link(dctx)}")
+ dctx.add(" for {lp.local_class.html_link(dctx)} ")
end
n = lp.node
return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
end
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{qualified_name}\",url:\"{html_name}.html\"\},"
+ end
+
+ redef fun qualified_name do
+ return "{intro_module.qualified_name}::{html_name}"
+ end
+
redef fun short_doc do return global.intro.short_doc
redef fun doc do return global.intro.doc
cla.add_all(cshe.greaters_and_self)
var op = new Buffer
+ var name = "class_{name}"
op.append("digraph {name} \{ rankdir=BT; node[shape=none,margin=0,width=0,height=0,fontsize=10]; edge[dir=none,color=gray]; ranksep=0.2; nodesep=0.1;\n")
for c in cla do
if c == self then
dctx.stage(". Definition in:")
for lc in crhe.greaters do
if lc.mmmodule.toplevel_owner != m then continue
- dctx.add(" {lc.mmmodule.html_link(dctx)}")
+ dctx.add(" {lc.mmmodule.html_link(dctx)} ")
assert lc isa MMSrcLocalClass
var n = lc.node
if n != null then
nitlanguage / nit.git / blobdiff