# This file is part of NIT ( http://www.nitlanguage.org ).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Render documentation pages as HTML
module static_html
import static::static_structure
import json
redef class DocPage
super Template
# Page url
var html_url: String is writable, noinit
# Directory where css, js and other assets can be found
var shareurl: String is writable, noinit
# Top menu template if any
var topmenu: DocTopMenu is writable, noinit
# Footer content if any
var footer: nullable Writable = null is writable
# Render the page as a html template
fun render(doc: DocModel): Writable do
# init page options
self.shareurl = doc.share_url or else "."
self.footer = doc.custom_footer
# build page
init_title(doc)
init_topmenu(doc)
# piwik tracking
var tracker_url = doc.tracker_url
var site_id = doc.piwik_site_id
if tracker_url != null and site_id != null then
piwik_script = new PiwikScript(tracker_url, site_id)
end
return self
end
# Build page title string
fun init_title(doc: DocModel) do end
# Build top menu template if any
fun init_topmenu(doc: DocModel) do
topmenu = new DocTopMenu
var home = new Link("index.html", "Nitdoc")
var custom_brand = doc.custom_brand
if custom_brand != null then
topmenu.brand = new Link("index.html", custom_brand)
topmenu.items.add new ListItem(home)
else
topmenu.brand = home
end
end
# Renders the html ``
private fun render_head do
var css = (self.shareurl / "css").html_escape
var vendors = (self.shareurl / "vendors").html_escape
addn ""
addn ""
addn " "
addn " "
addn " "
addn " "
addn " "
addn " "
addn " "
addn " {title.html_escape}"
addn ""
add ""
end
# Renders the footer and content
private fun render_content do
if tabs.is_empty then return
if tabs.length == 1 then
addn tabs.first
return
end
addn "
"
for tab in tabs do
if tab.is_empty and not tab isa DocTabLink then continue
addn tab.tab_link
end
addn "
"
addn "
"
for tab in tabs do
if tab.is_empty then continue
addn tab
end
addn "
"
end
# Piwik script to append in the page scripts
var piwik_script: nullable PiwikScript = null is writable
# Render JS scripts
private fun render_footer do
if footer != null then
addn ""
end
var vendors = (self.shareurl / "vendors").html_escape
var js = (self.shareurl / "js").html_escape
addn ""
addn ""
addn ""
addn ""
addn ""
addn ""
var piwik_script = self.piwik_script
if piwik_script != null then
add piwik_script
end
addn ""
addn ""
end
# Render the whole page
redef fun rendering do
render_head
add topmenu
addn "
"
render_content
addn "
"
render_footer
end
end
redef class PageHome
redef var html_url = "index.html"
redef fun render(doc) do
main_tab.show_sidebar = false
return super
end
redef fun init_title(doc) do
title = doc.custom_title or else "Nitdoc"
end
redef fun render_content do
addn "
"
if tabs.not_empty then
addn tabs.first
end
addn "
"
end
end
redef class PageMEntity
redef var html_url is lazy do return mentity.html_url
redef fun init_title(doc) do title = mentity.html_name
redef fun render_content do
addn new CardPageHeader(
mentity.html_declaration.write_to_string,
mentity.html_namespace.write_to_string)
super
end
redef fun init_topmenu(doc) do
super
for m in mentity.nitdoc_breadcrumbs do
topmenu.add_li new ListItem(new Link(m.html_url, m.html_name))
end
topmenu.active_item = topmenu.items.last
end
end
redef class PagePerson
redef var html_url is lazy do return person.html_url
end
redef class PageTag
redef var html_url is lazy do return "tag_{tag.to_cmangle}.html"
end
redef class HtmlightVisitor
redef fun hrefto(mentity) do return mentity.html_url
end
redef class DocTab
super Template
# Show sidebar for this page?
var show_sidebar = true is writable
# Tab link for tab headers
fun tab_link: Template do
var tpl = new Template
tpl.addn "
"
return tpl
end
redef fun rendering do end
end
# Top menu bar template
class DocTopMenu
super UnorderedList
# Brand link to display in first position of the top menu
#
# This is where you want to put your logo.
var brand: nullable Link is noinit, writable
# Active menu item
#
# Depends on the current page, this allows to hilighted the current item.
var active_item: nullable ListItem is noinit, writable
redef fun rendering do
addn ""
end
end
redef class DocSidebar
super Template
redef fun rendering do
if cards.is_empty then return
addn "
"
for card in cards do addn card
addn "
"
end
end
# JS script for Piwik Tracker
class PiwikScript
super Template
# Piwik URL to use for this tracker
var tracker_url: String
# Site ID used on Piwik system
var site_id: String
redef fun rendering do
addn ""
end
end
# Model redefs
redef class MEntity
redef fun to_dot_node do
var node = super
node["URL"] = html_url
return node
end
redef var html_url = "{html_id}.html" is lazy
end
redef class MPackage
redef var html_url is lazy do return "package_{super}"
end
redef class MGroup
redef var html_url is lazy do return "group_{super}"
end
redef class MModule
redef var html_url is lazy do return "module_{super}"
end
redef class MClass
redef var html_url is lazy do return "class_{super}"
end
redef class MClassDef
redef var html_url is lazy do
if is_intro then return mclass.html_url
return "{mclass.html_url}?def=def_code_{html_id}#lin"
end
end
redef class MProperty
redef var html_url is lazy do return "property_{super}"
end
redef class MPropDef
redef var html_url is lazy do
if is_intro then return mproperty.html_url
return "{mproperty.html_url}?def=def_code_{html_id}#lin"
end
end
redef class Person
redef var html_url = "person_{html_id}.html" is lazy
end