1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Introduces templates that compose the documentation HTML rendering.
19 import html
::bootstrap
20 import doc_phases
::doc_structure
21 import doc_phases
::doc_hierarchies
22 import doc_phases
::doc_graphs
23 import doc_phases
::doc_intros_redefs
24 import doc_phases
::doc_lin
26 # Renders the page as HTML.
31 var html_url
: String is writable, noinit
33 # Directory where css, js and other assets can be found.
34 var shareurl
: String is writable, noinit
36 # Attributes of the body tag element.
37 var body_attrs
= new Array[TagAttribute]
39 # Top menu template if any.
40 var topmenu
: DocTopMenu is writable, noinit
42 # Sidebar template if any.
43 var sidebar
: nullable DocSideBar = null is writable
45 # Footer content if any.
46 var footer
: nullable Writable = null is writable
48 # JS scripts to append at the end of the body
49 var scripts
= new Array[TplScript]
51 # Renders the html `<head>`.
52 private fun render_head
do
53 var css
= (self.shareurl
/ "css").html_escape
54 var vendors
= (self.shareurl
/ "vendors").html_escape
56 addn
"<!DOCTYPE html>"
58 addn
" <meta charset='utf-8'/>"
59 addn
" <!--link rel='stylesheet' href='{css}/Nitdoc.UI.css' type='text/css'/-->"
60 addn
" <link rel='stylesheet' href='{vendors}/bootstrap/css/bootstrap.min.css'/>"
61 addn
" <link rel='stylesheet' href='{css}/nitdoc.bootstrap.css'/>"
62 addn
" <link rel='stylesheet' href='{css}/nitdoc.css'/>"
63 addn
" <link rel='stylesheet' href='{css}/Nitdoc.QuickSearch.css'/>"
64 addn
" <link rel='stylesheet' href='{css}/Nitdoc.ModalBox.css'/>"
65 addn
" <link rel='stylesheet' href='{css}/Nitdoc.GitHub.css'/>"
66 addn
" <title>{title.html_escape}</title>"
69 for attr
in body_attrs
do add attr
73 # Renders the footer and content.
74 private fun render_content
do
76 if footer
!= null then
77 addn
"<div class='well footer'>"
78 add footer
.as(not null)
84 private fun render_footer
do
85 var vendors
= (self.shareurl
/ "vendors").html_escape
86 var js
= (self.shareurl
/ "js").html_escape
88 addn
"<script src='{vendors}/jquery/jquery-1.11.1.min.js'></script>"
89 addn
"<script src='{vendors}/jquery/jquery-ui-1.10.4.custom.min.js'></script>"
90 addn
"<script src='{vendors}/bootstrap/js/bootstrap.min.js'></script>"
91 addn
"<script data-main='{js}/nitdoc' src='{js}/lib/require.js'></script>"
92 for script
in scripts
do add script
95 $("[data-toggle='tooltip']").tooltip();
96 $("[data-toggle='popover']").popover();
103 # Render the whole page
104 redef fun rendering
do
106 addn
"<div class='container-fluid'>"
107 addn
" <div class='row'>"
110 addn
" <div class='row' id='content'>"
111 var sidebar
= self.sidebar
112 if sidebar
!= null then
113 addn
"<div class='col col-xs-3 col-lg-2'>"
116 addn
"<div class='col col-xs-9 col-lg-10' data-spy='scroll' data-target='.summary'>"
120 addn
"<div class='col col-xs-12'>"
129 # Render table of content for this page.
130 fun html_toc
: UnorderedList do
131 var lst
= new UnorderedList
132 lst
.css_classes
.add
"nav"
133 for child
in root
.children
do
134 child
.render_toc_item
(lst
)
140 # Top menu bar template.
142 # FIXME should be a Bootstrap component template
143 # At this moment, the topmenu structure stills to specific to Nitdoc to use the
148 # Brand link to display in first position of the top menu.
150 # This is where you want to put your logo.
151 var brand
: nullable Writable is noinit
, writable
155 # Depends on the current page, this allows to hilighted the current item.
157 # FIXME should be using Boostrap breadcrumbs component.
158 # This will still like this to avoid diff and be changed in further fixes
159 # when we will modify the output.
160 var active_item
: nullable ListItem is noinit
, writable
162 redef fun rendering
do
163 addn
"<nav id='topmenu' class='navbar navbar-default navbar-fixed-top' role='navigation'>"
164 addn
" <div class='container-fluid'>"
165 addn
" <div class='navbar-header'>"
166 add
" <button type='button' class='navbar-toggle' "
167 addn
" data-toggle='collapse' data-target='#topmenu-collapse'>"
168 addn
" <span class='sr-only'>Toggle menu</span>"
169 addn
" <span class='icon-bar'></span>"
170 addn
" <span class='icon-bar'></span>"
171 addn
" <span class='icon-bar'></span>"
173 if brand
!= null then
174 add
"<span class='navbar-brand'>"
175 add brand
.write_to_string
179 addn
" <div class='collapse navbar-collapse' id='topmenu-collapse'>"
180 addn
" <ul class='nav navbar-nav'>"
182 if item
== active_item
then item
.css_classes
.add
"active"
183 add item
.write_to_string
192 # Nitdoc sidebar template.
196 # Sidebar contains `DocSideBox`.
197 var boxes
= new Array[DocSideBox]
199 redef fun rendering
do
200 if boxes
.is_empty
then return
201 addn
"<div id='sidebar'>"
202 for box
in boxes
do add box
207 # Something that can be put in a DocSideBar.
211 # Box HTML id, used for Bootstrap collapsing feature.
213 # Use `html_title.to_cmangle` by default.
214 var id
: String is lazy
do return title
.write_to_string
.to_cmangle
216 # Title of the box to display.
219 # Content to display in the box.
220 var content
: Writable
222 # Is the box opened by default?
224 # Otherwise, the user will have to clic on the title to display the content.
227 var is_open
= true is writable
229 redef fun rendering
do
231 if is_open
then open
= "in"
232 addn
"<div class='panel'>"
233 addn
" <div class='panel-heading'>"
234 add
" <a data-toggle='collapse' data-parent='#sidebar'"
235 add
" data-target='#box_{id}' href='#'>"
239 addn
" <div id='box_{id}' class='summary panel-body collapse {open}'>"
246 redef class DocComposite
250 var html_id
: String is writable, lazy
do return id
252 # Title to display if any.
254 # This title can be decorated with HTML.
255 var html_title
: nullable Writable is writable, lazy
do return title
257 # Subtitle to display if any.
258 var html_subtitle
: nullable Writable is noinit
, writable
260 # Render the element title and subtitle.
261 private fun render_title
do
262 if html_title
!= null then
263 var header
= new Header(hlvl
, html_title
.write_to_string
)
264 header
.css_classes
.add
"signature"
265 if hlvl
== 2 then header
.css_classes
.add
"well well-sm"
268 if html_subtitle
!= null then
269 addn
"<div class='info subtitle'>"
270 addn html_subtitle
.write_to_string
275 # Render the element body.
276 private fun render_body
do
277 for child
in children
do addn child
.write_to_string
280 redef fun rendering
do
281 if is_hidden
then return
286 # Level <hX> for HTML heading.
287 private fun hlvl
: Int do return depth
289 # A short, undecorated title that goes in the table of contents.
291 # By default, returns `html_title.to_s`, subclasses should redefine it.
292 var html_toc_title
: nullable String is lazy
, writable do
293 if html_title
== null then return toc_title
294 return html_title
.write_to_string
297 # Render this element in a table of contents.
298 private fun render_toc_item
(lst
: UnorderedList) do
299 if is_toc_hidden
or html_toc_title
== null then return
301 var content
= new Template
302 content
.add
new Link("#{html_id}", html_toc_title
.to_s
)
303 if not children
.is_empty
then
304 var sublst
= new UnorderedList
305 sublst
.css_classes
.add
"nav"
306 for child
in children
do
307 child
.render_toc_item
(sublst
)
311 lst
.add_li
new ListItem(content
)
314 # ID used in HTML tab labels.
316 # We sanitize it for Boostrap JS panels that do not like ":" and "." in ids.
317 var html_tab_id
: String is lazy
do
318 var id
= html_id
.replace
(":", "")
319 id
= id
.replace
(".", "")
325 redef fun rendering
do
326 for child
in children
do addn child
.write_to_string
330 redef class DocSection
333 redef fun rendering
do
335 addn
"<a id=\"{html_id}\
"></a>"
338 addn
"<section{render_css_classes} id=\"{html_id}\
">"
345 redef class DocArticle
348 redef fun rendering
do
349 if is_hidden
then return
350 addn
"<article{render_css_classes} id=\"{html_id}\
">"
357 redef class TabbedGroup
358 redef fun render_body
do
359 var tabs
= new DocTabs("{html_id}.tabs", "")
360 for child
in children
do
361 if child
.is_hidden
then continue
362 var title
= child
.html_toc_title
or else child
.toc_title
or else ""
363 tabs
.add_panel
new DocTabPanel(child
.html_tab_id
, title
, child
)
369 redef class PanelGroup
370 redef var html_title
= null
371 redef var toc_title
is lazy
do return title
or else ""
372 redef var is_toc_hidden
= true
375 redef class HomeArticle
376 redef var html_title
= "Overview"
378 # HTML content to display on the home page.
380 # This attribute is set by the `doc_render` phase who knows the context.
381 var content
: nullable String is noinit
, writable
383 redef fun render_body
do
384 var content
= self.content
385 if content
!= null then add content
390 redef class IndexArticle
391 redef var html_title
= "Index"
393 redef fun render_body
do
394 addn
"<div class='container-fluid'>"
395 addn
" <div class='row'>"
396 render_list
("Modules", mmodules
)
397 render_list
("Classes", mclasses
)
398 render_list
("Properties", mprops
)
403 # Displays a list from the content of `mentities`.
404 private fun render_list
(title
: String, mentities
: Array[MEntity]) do
405 if mentities
.is_empty
then return
406 addn
"<div class='col-xs-4'>"
407 addn
new Header(3, title
)
408 var lst
= new UnorderedList
409 for mentity
in mentities
do
410 if mentity
isa MProperty then
411 var tpl
= new Template
412 tpl
.add mentity
.intro
.html_link
414 tpl
.add mentity
.intro
.mclassdef
.mclass
.html_link
416 lst
.add_li
new ListItem(tpl
)
418 lst
.add_li
new ListItem(mentity
.html_link
)
426 redef class MEntityComposite
427 redef var html_title
is lazy
do return mentity
.nitdoc_name
430 redef class MEntitySection
431 redef var html_title
is lazy
do return mentity
.html_name
432 redef var html_subtitle
is lazy
do return mentity
.html_declaration
435 redef class ConcernSection
436 redef var html_title
is lazy
do return "in {mentity.nitdoc_name}"
439 redef class IntroArticle
440 redef var html_title
= null
442 # Link to source to display if any.
443 var html_source_link
: nullable Writable is noinit
, writable
445 redef fun render_body
do
446 var tabs
= new DocTabs("{html_id}.tabs", "")
447 var comment
= mentity
.html_comment
448 if comment
!= null then
449 tabs
.add_panel
new DocTabPanel("{html_tab_id}-comment", "Comment", comment
)
451 for child
in children
do
452 if child
.is_hidden
then continue
453 var title
= child
.html_toc_title
or else child
.toc_title
or else ""
454 tabs
.add_panel
new DocTabPanel(child
.html_tab_id
, title
, child
)
456 var lnk
= html_source_link
458 tabs
.drop_list
.items
.add
new ListItem(lnk
)
464 redef class ConcernsArticle
465 redef var html_title
= "Concerns"
466 redef fun render_body
do add concerns
.html_list
469 redef class DefinitionListArticle
470 redef var html_title
is lazy
do
471 var title
= new Template
472 title
.add mentity
.html_icon
473 title
.add mentity
.html_link
477 redef var html_subtitle
is lazy
do return mentity
.html_namespace
478 redef var html_toc_title
is lazy
do return mentity
.html_name
481 redef class DefinitionArticle
482 redef var html_title
is lazy
do return mentity
.html_name
483 redef var html_subtitle
is lazy
do return mentity
.html_declaration
485 # Does `self` display only it's title and no body?
488 var is_no_body
: Bool = false is writable
490 # Does `self` display only the short content as definition?
493 var is_short_comment
: Bool = false is writable
495 # Link to source to display if any.
496 var html_source_link
: nullable Writable is noinit
, writable
498 redef fun render_body
do
499 var tabs
= new DocTabs("{html_id}.tabs", "")
500 if not is_no_body
then
502 if is_short_comment
then
503 comment
= mentity
.html_short_comment
505 comment
= mentity
.html_comment
507 if comment
!= null then
508 tabs
.add_panel
new DocTabPanel("{html_tab_id}-comment", "Comment", comment
)
511 for child
in children
do
512 if child
.is_hidden
then continue
513 var title
= child
.html_toc_title
or else child
.toc_title
or else ""
514 tabs
.add_panel
new DocTabPanel(child
.html_tab_id
, title
, child
)
516 var lnk
= html_source_link
518 tabs
.drop_list
.items
.add
new ListItem(lnk
)
524 redef class MEntitiesListArticle
525 redef fun render_body
do
526 var lst
= new UnorderedList
527 lst
.css_classes
.add
"list-unstyled list-definition"
528 for mentity
in mentities
do
529 lst
.add_li mentity
.html_list_item
535 redef class DefinitionLinArticle
536 redef fun render_body
do
537 var lst
= new UnorderedList
538 lst
.css_classes
.add
"list-unstyled list-labeled"
539 for mentity
in mentities
do
540 if not mentity
isa MPropDef then continue # TODO handle all mentities
541 var tpl
= new Template
542 tpl
.add mentity
.mclassdef
.html_namespace
543 var comment
= mentity
.mclassdef
.html_short_comment
544 if comment
!= null then
548 var li
= new ListItem(tpl
)
549 li
.css_classes
.add
"signature"
556 redef class GraphArticle
557 redef var html_title
= null
559 # HTML map used to display link.
561 # This attribute is set by the `doc_render` phase who knows the context.
562 var map
: String is noinit
, writable
564 redef fun render_body
do
565 addn
"<div class=\"text-center\
">"
566 addn
" <img src='{graph_id}.png' usemap='#{graph_id}' style='margin:auto'"
567 addn
" alt='{title or else ""}'/>"