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 # HTML templates used by Nitdoc to generate API documentation
16 # Pages are assembled using `Template`
21 # A documentation page
25 # Page title in HTML header
26 var title
: String writable
28 # Directory where css, js and other assets can be found
29 var shareurl
: String writable
31 # Attributes of the body tag element
32 var body_attrs
= new Array[TagAttribute]
34 # Top menu template if any
35 var topmenu
: TplTopMenu writable
37 # Sidebar template if any
38 var sidebar
: nullable TplSidebar writable
40 # Content of the page in form a TplSection
41 var sections
= new Array[TplSection]
43 # Footer content if any
44 var footer
: nullable Streamable writable
46 # JS scripts to append at the end of the body
47 var scripts
= new Array[TplScript]
51 # Add a section to this page
52 fun add_section
(section
: TplSection) do
56 # Render the html header
57 private fun render_head
do
60 add
" <meta charset='utf-8'/>"
61 add
" <!--link rel='stylesheet' href='{shareurl}/css/Nitdoc.UI.css' type='text/css'/-->"
62 add
" <link rel='stylesheet' href='{shareurl}/vendors/bootstrap/css/bootstrap.min.css'/>"
63 add
" <link rel='stylesheet' href='{shareurl}/css/nitdoc.bootstrap.css'/>"
64 add
" <link rel='stylesheet' href='{shareurl}/css/nitdoc.css'/>"
65 add
" <link rel='stylesheet' href='{shareurl}/css/Nitdoc.QuickSearch.css'/>"
66 add
" <link rel='stylesheet' href='{shareurl}/css/Nitdoc.ModalBox.css'/>"
67 add
" <link rel='stylesheet' href='{shareurl}/css/Nitdoc.GitHub.css'/>"
68 add
" <title>{title}</title>"
71 for attr
in body_attrs
do add attr
75 # Render the topmenu template
76 private fun render_topmenu
do
77 add
" <div class='row'>"
83 # Sidebar is automatically populated with a summary of all sections
85 if sidebar
== null then return
86 var summary
= new TplSummary.with_order
(0)
87 for section
in sections
do
88 section
.render_summary summary
90 sidebar
.boxes
.add summary
91 add sidebar
.as(not null)
93 # Render the footer and content
94 private fun render_content
do
95 for section
in sections
do add section
96 if footer
!= null then
97 add
"<div class='well footer'>"
98 add footer
.as(not null)
104 private fun render_footer
do
105 add
"<script src='{shareurl}/vendors/jquery/jquery-1.11.1.min.js'></script>"
106 add
"<script src='{shareurl}/vendors/jquery/jquery-ui-1.10.4.custom.min.js'></script>"
107 add
"<script src='{shareurl}/vendors/bootstrap/js/bootstrap.min.js'></script>"
108 add
"<script data-main='{shareurl}/js/nitdoc' src='{shareurl}/js/lib/require.js'</script>"
109 for script
in scripts
do add script
112 $("[data-toggle='tooltip']").tooltip();
113 $("[data-toggle='popover']").popover();
120 # Render the whole page
121 redef fun rendering
do
123 add
"<div class='container-fluid'>"
125 add
" <div class='row' id='content'>"
126 if sidebar
!= null then
127 add
"<div class='col col-xs-3 col-lg-2'>"
130 add
"<div class='col col-xs-9 col-lg-10' data-spy='scroll' data-target='.summary'>"
134 add
"<div class='col col-xs-12'>"
144 #########################
145 # general layout elements
146 #########################
148 # Top menu bar template
152 # Elements of the topmenu
153 private var elts
= new Array[Streamable]
155 # Add a new link to the menu
156 fun add_link
(href
, name
: String, is_active
: Bool) do
157 var tpl
= new Template
160 tpl
.add
" class='active'"
163 tpl
.add
new TplLink(href
, name
)
168 # Add a raw content to the menu
169 fun add_raw
(content
: Streamable) do
173 redef fun rendering
do
174 add
"<nav id='topmenu' class='navbar navbar-default navbar-fixed-top' role='navigation'>"
175 add
" <div class='container-fluid'>"
176 if not elts
.is_empty
then
177 add
"<ul class='nav navbar-nav'>"
178 for elt
in elts
do add
(elt
)
190 # Sidebar contains sidebar element templates called boxes
191 var boxes
= new Array[TplSidebarElt]
193 # Sort boxes by order priority
194 private fun order_boxes
do
195 var sorter
= new OrderComparator
199 redef fun rendering
do
200 if boxes
.is_empty
then return
202 add
"<div id='sidebar'>"
203 for box
in boxes
do add box
208 # Comparator used to sort boxes by order
209 private class OrderComparator
210 super Comparator[TplSidebarElt]
212 redef fun compare
(a
, b
) do
213 if a
.order
< b
.order
then return -1
214 if a
.order
> b
.order
then return 1
219 # Something that can be put in the sidebar
223 # Order of the box in the sidebar
226 init with_order
(order
: Int) do self.order
= order
229 # Agenericbox that can be added to sidebar
233 # Title of the box to display
234 # Title is also a placeholder for the collapse link
238 # equals to `title.to_cmangle` by default
239 # Used for collapsing
242 # Content to display in the box
243 # box will not be rendered if the content is null
244 var content
: nullable Streamable writable
246 # Is the box opened by default
247 # otherwise, the user will have to clic on the title to display the content
248 var is_open
writable = false
250 init(title
: String) do
252 self.id
= title
.to_cmangle
255 init with_content
(title
: String, content
: Streamable) do
257 self.content
= content
260 redef fun rendering
do
261 if content
== null then return
263 if is_open
then open
= "in"
264 add
"<div class='panel'>"
265 add
" <div class='panel-heading'>"
266 add
" <a data-toggle='collapse' data-parent='#sidebar' data-target='#box_{id}' href='#'>"
270 add
" <div id='box_{id}' class='panel-body collapse {open}'>"
271 add content
.as(not null)
277 # Something that can go on a summary template
281 # Add an element to the summary
282 fun add_child
(child
: TplSummaryElt) is abstract
285 # A summary that can go on the sidebar
286 # If the page contains a sidebar, the summary is automatically placed
287 # on top of the sidebarauto-generated
288 # summary contains anchors to all sections displayed in the page
293 # Summary elements to display
294 var children
= new Array[TplSummaryElt]
296 redef fun add_child
(child
) do children
.add child
298 redef fun rendering
do
299 if children
.is_empty
then return
300 add
"<div class='panel'>"
301 add
" <div class='panel-heading'>"
302 add
" <a data-toggle='collapse' data-parent='#sidebar' data-target='#box-sum' href='#'>"
306 add
" <div id='box-sum' class='summary collapse in'>"
307 add
" <ul class='nav'>"
308 for entry
in children
do add entry
316 class TplSummaryEntry
322 # Children of this entry
323 # Will be displayed as a tree
324 var children
= new Array[TplSummaryElt]
326 init(text
: Streamable) do self.text
= text
328 redef fun add_child
(child
) do children
.add child
330 redef fun rendering
do
333 if not children
.is_empty
then
334 add
"<ul class='nav'>"
335 for entry
in children
do add entry
342 # Something that can go in a section
343 # Sections are automatically collected to populate the menu
350 # Title to display if any
351 # if both `title` and `summary_title` are null then
352 # the section will not appear in the summary
353 var title
: nullable Streamable writable
355 # Subtitle to display if any
356 var subtitle
: nullable Streamable writable
358 # Title that appear in the summary
359 # if null use `title` instead
360 var summary_title
: nullable String writable
362 # Parent section of this section if any
363 var parent
: nullable TplSection
365 init(id
: String) do self.id
= id
367 init with_title
(id
: String, title
: Streamable) do
372 # Level <hX> for HTML heading
373 protected fun hlvl
: Int do
374 if parent
== null then return 1
375 return parent
.hlvl
+ 1
378 # Render this section in the summary
379 protected fun render_summary
(parent
: TplSummaryElt) is abstract
381 # Is the section empty (no content at all)
382 fun is_empty
: Bool is abstract
385 # A HTML <section> element
389 # Elements contained by this section
390 var children
= new Array[TplSectionElt]
392 # Add an element in this section
393 fun add_child
(child
: TplSectionElt) do
398 redef fun is_empty
: Bool do return children
.is_empty
400 redef fun render_summary
(parent
) do
401 if is_empty
then return
402 var title
= summary_title
403 if title
== null and self.title
!= null then title
= self.title
.write_to_string
404 if title
== null then return
405 var lnk
= new TplLink("#{id}", title
)
406 var entry
= new TplSummaryEntry(lnk
)
407 for child
in children
do
408 child
.render_summary
(entry
)
410 parent
.add_child entry
413 redef fun rendering
do
414 if is_empty
then return
415 add
"<section id='{id}'>"
416 if title
!= null then
419 add title
.as(not null)
422 if subtitle
!= null then
423 add
"<div class='info subtitle'>"
424 add subtitle
.as(not null)
427 for child
in children
do
434 # A page article that can go in a section
438 # Content for this article
439 var content
: nullable Streamable writable = null
441 # CSS classes to apply on the article title heading element
442 var title_classes
= new Array[String]
444 redef fun render_summary
(parent
) do
445 if is_empty
then return
446 var title
= summary_title
447 if title
== null and self.title
!= null then title
= self.title
.write_to_string
448 if title
== null then return
449 var lnk
= new TplLink("#{id}", title
)
450 parent
.add_child
new TplSummaryEntry(lnk
)
453 redef fun rendering
do
454 add
"<article id='{id}'>"
455 if title
!= null then
457 add
"<h{lvl} class='{title_classes.join(" ")}'>"
458 add title
.as(not null)
461 if subtitle
!= null then
462 add
"<div class='info subtitle'>"
463 add subtitle
.as(not null)
466 if content
!= null then
467 add content
.as(not null)
472 redef fun is_empty
: Bool do return content
== null
475 # A module / class / prop definition
480 var comment
: nullable Streamable writable
482 # Namespace for this definition
483 var namespace
: Streamable writable
485 # Location link to display
486 var location
: nullable Streamable writable
490 private fun render_info
do
491 add
"<div class='info text-right'>"
492 if comment
== null then
493 add
"<span class=\"noComment\
">no comment for </span>"
496 if location
!= null then
498 add location
.as(not null)
503 private fun render_comment
do
504 if comment
!= null then add comment
.as(not null)
507 redef fun rendering
do
508 add
"<div class='definition'>"
516 class TplClassDefinition
519 var intros
= new Array[TplListElt]
520 var redefs
= new Array[TplListElt]
524 redef fun rendering
do
525 add
"<div class='definition'>"
528 render_list
("Introduces", intros
)
529 render_list
("Redefines", redefs
)
533 private fun render_list
(name
: String, elts
: Array[TplListElt]) do
534 if elts
.is_empty
then return
535 add
"<h5>{name}</h5>"
536 add
"<ul class='list-unstyled list-definition'>"
537 for elt
in elts
do add elt
542 # Layout for Search page
546 var modules
= new Array[Streamable]
547 var classes
= new Array[Streamable]
548 var props
= new Array[Streamable]
550 redef fun rendering
do
551 if title
!= null then add
"<h1>{title}</h1>"
552 add
"<div class='container-fluid'>"
553 add
" <div class='row'>"
554 if not modules
.is_empty
then
555 add
"<div class='col-xs-4'>"
556 add
"<h3>Modules</h3>"
566 if not classes
.is_empty
then
567 add
"<div class='col-xs-4'>"
568 add
"<h3>Classes</h3>"
578 if not props
.is_empty
then
579 add
"<div class='col-xs-4'>"
580 add
"<h3>Properties</h3>"
595 #####################
596 # Basiv HTML elements
597 #####################
604 var href
: String writable
606 # Text to display in the link
607 var text
: String writable
610 var title
: nullable String writable
612 init(href
, text
: String) do
617 init with_title
(href
, text
, title
: String) do
622 redef fun rendering
do
626 if title
!= null then
628 add title.as(not null)
641 # Elements contained in this list
642 # can be <li> or <ul> elements
643 var elts
= new Array[TplListElt]
645 # CSS classes of the <ul> element
646 var css_classes
= new Array[String]
648 # Add content wrapped in a <li> element
649 fun add_li
(content
: Streamable) do elts
.add
new TplListItem.with_content
(content
)
653 init with_classes
(classes
: Array[String]) do self.css_classes
= classes
655 redef fun rendering
do
656 if elts
.is_empty
then return
657 add
"<ul class='{css_classes.join(" ")}'>"
658 for elt
in elts
do add elt
663 # Something that can be added to a TplList
672 # Content of the list item
673 var content
= new Template
675 # CSS classes of the <li> element
676 var css_classes
= new Array[String]
680 init with_content
(content
: Streamable) do append
(content
)
682 init with_classes
(content
: Streamable, classes
: Array[String]) do
683 with_content
(content
)
684 css_classes
= classes
687 # Append `content` to the item
688 # similar to `self.content.add`
689 fun append
(content
: Streamable) do self.content
.add content
691 redef fun rendering
do
693 for cls
in css_classes
do add
" {cls}"
700 # A label with a text content
704 # Content of the label if any
705 var content
: nullable Streamable
707 # CSS classes of the <span> element
708 var css_classes
= new Array[String]
711 init with_content
(content
: Streamable) do self.content
= content
712 init with_classes
(classes
: Array[String]) do self.css_classes
= classes
714 redef fun rendering
do
715 add
"<span class='label {css_classes.join(" ")}'>"
716 if content
!= null then add content
.as(not null)
721 # A label with an icon
726 # see: http://getbootstrap.com/components/#glyphicons
729 init with_icon
(icon
: String) do self.icon
= icon
731 redef fun rendering
do
732 add
"<span class='glyphicon glyphicon-{icon} {css_classes.join(" ")}'>"
733 if content
!= null then add content
.as(not null)
738 # A HTML tag attribute
739 # `<tag attr="value">`
744 var value
: nullable String
746 init(name
: String, value
: nullable String) do
751 redef fun rendering
do
752 if value
== null then
755 add
(" {name}=\"{value}\
"")
764 var attrs
= new Array[TagAttribute]
765 var content
: nullable Streamable writable
768 attrs
.add
(new TagAttribute("type", "text/javascript"))
771 protected fun render_content
do
772 if content
!= null then add content
.as(not null)
775 redef fun rendering
do
777 for attr
in attrs
do add attr
784 # JS script for Piwik Tracker
788 var tracker_url
: String
791 init(tracker_url
, site_id
: String) do
793 self.tracker_url
= tracker_url
794 self.site_id
= site_id
797 redef fun render_content
do
799 add
"var _paq = _paq || [];"
800 add
" _paq.push([\"trackPageView\
"]);"
801 add
" _paq.push([\"enableLinkTracking\
"]);"
803 add
" var u=((\"https
:\
" == document.location.protocol) ? \"https\
" : \"http\
") + \"://{tracker_url}\
";"
804 add
" _paq.push([\"setTrackerUrl\
", u+\"piwik
.php\
"]);"
805 add
" _paq.push([\"setSiteId\
", \"{site_id}\
"]);"
806 add
" var d=document, g=d.createElement(\"script\
"), s=d.getElementsByTagName(\"script\
")[0]; g.type=\"text
/javascript\
";"
807 add
" g.defer=true; g.async=true; g.src=u+\"piwik
.js\
"; s.parentNode.insertBefore(g,s);"