# Introduces templates that compose the documentation HTML rendering.
module html_templates
+
+import html_model
+
+# Renders the page as HTML.
+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
+
+ # Attributes of the body tag element.
+ var body_attrs = new Array[TagAttribute]
+
+ # Top menu template if any.
+ var topmenu: TplTopMenu is writable, noinit
+
+ # Sidebar template if any.
+ var sidebar: nullable TplSidebar = null is writable
+
+ # Content of the page in form a TplSection.
+ # TODO remove when other templates are migrated.
+ var sections = new Array[TplSection]
+
+ # Footer content if any.
+ var footer: nullable Writable = null is writable
+
+ # JS scripts to append at the end of the body
+ var scripts = new Array[TplScript]
+
+ # Adds a section to this page.
+ # TODO remove when other templates are migrated.
+ fun add_section(section: TplSection) do
+ sections.add section
+ end
+
+ # Renders the html `<head>`.
+ private fun render_head do
+ var css = (self.shareurl / "css").html_escape
+ var vendors = (self.shareurl / "vendors").html_escape
+
+ addn "<!DOCTYPE html>"
+ addn "<head>"
+ addn " <meta charset='utf-8'/>"
+ addn " <!--link rel='stylesheet' href='{css}/Nitdoc.UI.css' type='text/css'/-->"
+ addn " <link rel='stylesheet' href='{vendors}/bootstrap/css/bootstrap.min.css'/>"
+ addn " <link rel='stylesheet' href='{css}/nitdoc.bootstrap.css'/>"
+ addn " <link rel='stylesheet' href='{css}/nitdoc.css'/>"
+ addn " <link rel='stylesheet' href='{css}/Nitdoc.QuickSearch.css'/>"
+ addn " <link rel='stylesheet' href='{css}/Nitdoc.ModalBox.css'/>"
+ addn " <link rel='stylesheet' href='{css}/Nitdoc.GitHub.css'/>"
+ addn " <title>{title.html_escape}</title>"
+ addn "</head>"
+ add "<body"
+ for attr in body_attrs do add attr
+ addn ">"
+ end
+
+ # Renders the topmenu template.
+ private fun render_topmenu do
+ addn " <div class='row'>"
+ add topmenu
+ addn " </div>"
+ end
+
+ # Renders the sidebar template.
+ #
+ # Sidebar is automatically populated with a summary of all sections
+ # TODO remove summary generation when other templates are migrated.
+ private fun render_sidebar do
+ if sidebar == null then return
+ var summary = new TplSummary.with_order(0)
+ for section in sections do
+ section.render_summary summary
+ end
+ sidebar.boxes.add summary
+ add sidebar.as(not null)
+ end
+
+ # Renders the footer and content.
+ private fun render_content do
+ for section in sections do add section
+ if footer != null then
+ addn "<div class='well footer'>"
+ add footer.as(not null)
+ addn "</div>"
+ end
+ end
+
+ # Render JS scripts
+ private fun render_footer do
+ var vendors = (self.shareurl / "vendors").html_escape
+ var js = (self.shareurl / "js").html_escape
+
+ addn "<script src='{vendors}/jquery/jquery-1.11.1.min.js'></script>"
+ addn "<script src='{vendors}/jquery/jquery-ui-1.10.4.custom.min.js'></script>"
+ addn "<script src='{vendors}/bootstrap/js/bootstrap.min.js'></script>"
+ addn "<script data-main='{js}/nitdoc' src='{js}/lib/require.js'></script>"
+ for script in scripts do add script
+ addn """<script>
+ $(function () {
+ $("[data-toggle='tooltip']").tooltip();
+ $("[data-toggle='popover']").popover();
+ });
+ </script>"""
+ addn "</body>"
+ addn "</html>"
+ end
+
+ # Render the whole page
+ redef fun rendering do
+ render_head
+ addn "<div class='container-fluid'>"
+ render_topmenu
+ addn " <div class='row' id='content'>"
+ if sidebar != null then
+ addn "<div class='col col-xs-3 col-lg-2'>"
+ render_sidebar
+ addn "</div>"
+ addn "<div class='col col-xs-9 col-lg-10' data-spy='scroll' data-target='.summary'>"
+ render_content
+ addn "</div>"
+ else
+ addn "<div class='col col-xs-12'>"
+ render_content
+ addn "</div>"
+ end
+ addn " </div>"
+ addn "</div>"
+ render_footer
+ end
+end
nitlanguage / nit.git / blobdiff