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 is writable, noinit
28 # Directory where css, js and other assets can be found
29 var shareurl
: String is writable, noinit
31 # Attributes of the body tag element
32 var body_attrs
= new Array[TagAttribute]
34 # Top menu template if any
35 var topmenu
: TplTopMenu is writable, noinit
37 # Sidebar template if any
38 var sidebar
: nullable TplSidebar = null is 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 = null is 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 # Brand link to display in first position of the top menu
153 private var brand
: nullable Streamable = null is writable
154 # Elements of the topmenu
155 private var elts
= new Array[Streamable]
159 # Add a content between `<li>` tags
160 fun add_item
(content
: Streamable, is_active
: Bool) do
161 var tpl
= new Template
164 tpl
.add
" class='active'"
172 # Add a raw content to the menu
173 fun add_raw
(content
: Streamable) do
177 redef fun rendering
do
178 if brand
== null and elts
.is_empty
then return
179 add
"<nav id='topmenu' class='navbar navbar-default navbar-fixed-top' role='navigation'>"
180 add
" <div class='container-fluid'>"
181 add
" <div class='navbar-header'>"
182 add
" <button type='button' class='navbar-toggle' "
183 add
" data-toggle='collapse' data-target='#topmenu-collapse'>"
184 add
" <span class='sr-only'>Toggle menu</span>"
185 add
" <span class='icon-bar'></span>"
186 add
" <span class='icon-bar'></span>"
187 add
" <span class='icon-bar'></span>"
189 if brand
!= null then add brand
.as(not null)
191 add
" <div class='collapse navbar-collapse' id='topmenu-collapse'>"
192 if not elts
.is_empty
then
193 add
"<ul class='nav navbar-nav'>"
194 for elt
in elts
do add elt
207 # Sidebar contains sidebar element templates called boxes
208 var boxes
= new Array[TplSidebarElt]
210 # Sort boxes by order priority
211 private fun order_boxes
do
212 var sorter
= new OrderComparator
216 redef fun rendering
do
217 if boxes
.is_empty
then return
219 add
"<div id='sidebar'>"
220 for box
in boxes
do add box
225 # Comparator used to sort boxes by order
226 private class OrderComparator
227 super Comparator[TplSidebarElt]
229 redef fun compare
(a
, b
) do
230 if a
.order
< b
.order
then return -1
231 if a
.order
> b
.order
then return 1
236 # Something that can be put in the sidebar
240 # Order of the box in the sidebar
243 init with_order
(order
: Int) do self.order
= order
246 # Agenericbox that can be added to sidebar
250 # Title of the box to display
251 # Title is also a placeholder for the collapse link
255 # equals to `title.to_cmangle` by default
256 # Used for collapsing
259 # Content to display in the box
260 # box will not be rendered if the content is null
261 var content
: nullable Streamable writable
263 # Is the box opened by default
264 # otherwise, the user will have to clic on the title to display the content
265 var is_open
writable = false
267 init(title
: String) do
269 self.id
= title
.to_cmangle
272 init with_content
(title
: String, content
: Streamable) do
274 self.content
= content
277 redef fun rendering
do
278 if content
== null then return
280 if is_open
then open
= "in"
281 add
"<div class='panel'>"
282 add
" <div class='panel-heading'>"
283 add
" <a data-toggle='collapse' data-parent='#sidebar' data-target='#box_{id}' href='#'>"
287 add
" <div id='box_{id}' class='panel-body collapse {open}'>"
288 add content
.as(not null)
294 # Something that can go on a summary template
298 # Add an element to the summary
299 fun add_child
(child
: TplSummaryElt) is abstract
302 # A summary that can go on the sidebar
303 # If the page contains a sidebar, the summary is automatically placed
304 # on top of the sidebarauto-generated
305 # summary contains anchors to all sections displayed in the page
310 # Summary elements to display
311 var children
= new Array[TplSummaryElt]
313 redef fun add_child
(child
) do children
.add child
315 redef fun rendering
do
316 if children
.is_empty
then return
317 add
"<div class='panel'>"
318 add
" <div class='panel-heading'>"
319 add
" <a data-toggle='collapse' data-parent='#sidebar' data-target='#box-sum' href='#'>"
323 add
" <div id='box-sum' class='summary collapse in'>"
324 add
" <ul class='nav'>"
325 for entry
in children
do add entry
333 class TplSummaryEntry
339 # Children of this entry
340 # Will be displayed as a tree
341 var children
= new Array[TplSummaryElt]
343 init(text
: Streamable) do self.text
= text
345 redef fun add_child
(child
) do children
.add child
347 redef fun rendering
do
350 if not children
.is_empty
then
351 add
"<ul class='nav'>"
352 for entry
in children
do add entry
359 # Something that can go in a section
360 # Sections are automatically collected to populate the menu
367 # Title to display if any
368 # if both `title` and `summary_title` are null then
369 # the section will not appear in the summary
370 var title
: nullable Streamable writable
372 # Subtitle to display if any
373 var subtitle
: nullable Streamable writable
375 # Title that appear in the summary
376 # if null use `title` instead
377 var summary_title
: nullable String writable
379 # CSS classes to apply on the section element
380 var css_classes
= new Array[String]
382 # CSS classes to apply on the title heading element
383 var title_classes
= new Array[String]
385 # Parent article/section if any
386 var parent
: nullable TplSectionElt
388 init(id
: String) do self.id
= id
390 init with_title
(id
: String, title
: Streamable) do
395 # Level <hX> for HTML heading
396 protected fun hlvl
: Int do
397 if parent
== null then return 1
398 return parent
.hlvl
+ 1
401 # Elements contained by this section
402 var children
= new Array[TplSectionElt]
404 # Add an element in this section
405 fun add_child
(child
: TplSectionElt) do
410 # Is the section empty (no content at all)
411 fun is_empty
: Bool do return children
.is_empty
413 # Render this section in the summary
414 fun render_summary
(parent
: TplSummaryElt) do
415 if is_empty
then return
416 var title
= summary_title
417 if title
== null and self.title
!= null then title
= self.title
.write_to_string
418 if title
== null then return
419 var lnk
= new TplLink("#{id}", title
)
420 var entry
= new TplSummaryEntry(lnk
)
421 for child
in children
do
422 child
.render_summary
(entry
)
424 parent
.add_child entry
428 # A HTML <section> element
432 redef fun rendering
do
433 add
"<section id='{id}' class='{css_classes.join(" ")}'>"
434 if title
!= null then
436 if lvl
== 2 then title_classes
.add
"well well-sm"
437 add
"<h{lvl} class='{title_classes.join(" ")}'>"
438 add title
.as(not null)
441 if subtitle
!= null then
442 add
"<div class='info subtitle'>"
443 add subtitle
.as(not null)
446 for child
in children
do
453 # A page article that can go in a section
457 # Content for this article
458 var content
: nullable Streamable writable = null
459 var source_link
: nullable Streamable writable = null
461 init with_content
(id
: String, title
: Streamable, content
: Streamable) do
462 with_title
(id
, title
)
463 self.content
= content
466 redef fun render_summary
(parent
) do
467 if is_empty
then return
468 var title
= summary_title
469 if title
== null and self.title
!= null then title
= self.title
.write_to_string
470 if title
== null then return
471 var lnk
= new TplLink("#{id}", title
)
472 parent
.add_child
new TplSummaryEntry(lnk
)
475 redef fun rendering
do
476 if is_empty
then return
477 add
"<article id='{id}' class='{css_classes.join(" ")}'>"
478 if source_link
!= null then
479 add
"<div class='source-link'>"
480 add source_link
.as(not null)
483 if title
!= null then
485 if lvl
== 2 then title_classes
.add
"well well-sm"
486 add
"<h{lvl} class='{title_classes.join(" ")}'>"
487 add title
.as(not null)
490 if subtitle
!= null then
491 add
"<div class='info subtitle'>"
492 add subtitle
.as(not null)
495 if content
!= null then
496 add content
.as(not null)
498 for child
in children
do
504 redef fun is_empty
: Bool do
505 return title
== null and subtitle
== null and content
== null
509 # A module / class / prop definition
514 var comment
: nullable Streamable = null is writable
516 # Namespace for this definition
517 var namespace
: nullable Streamable = null is writable
519 # Location link to display
520 var location
: nullable Streamable = null is writable
522 private fun render_info
do
523 add
"<div class='info text-right'>"
524 if namespace
!= null then
525 if comment
== null then
526 add
"<span class=\"noComment\
">no comment for </span>"
528 add namespace
.as(not null)
530 if location
!= null then
532 add location
.as(not null)
537 private fun render_comment
do
538 if comment
!= null then add comment
.as(not null)
541 redef fun rendering
do
542 add
"<div class='definition'>"
550 class TplClassDefinition
553 var intros
= new Array[TplListElt]
554 var redefs
= new Array[TplListElt]
558 redef fun rendering
do
559 add
"<div class='definition'>"
562 render_list
("Introduces", intros
)
563 render_list
("Redefines", redefs
)
567 private fun render_list
(name
: String, elts
: Array[TplListElt]) do
568 if elts
.is_empty
then return
569 add
"<h5>{name}</h5>"
570 add
"<ul class='list-unstyled list-definition'>"
571 for elt
in elts
do add elt
576 # Layout for Search page
580 var modules
= new Array[Streamable]
581 var classes
= new Array[Streamable]
582 var props
= new Array[Streamable]
584 redef fun rendering
do
585 var title
= self.title
586 if title
!= null then add
"<h1>{title}</h1>"
587 add
"<div class='container-fluid'>"
588 add
" <div class='row'>"
589 if not modules
.is_empty
then
590 add
"<div class='col-xs-4'>"
591 add
"<h3>Modules</h3>"
601 if not classes
.is_empty
then
602 add
"<div class='col-xs-4'>"
603 add
"<h3>Classes</h3>"
613 if not props
.is_empty
then
614 add
"<div class='col-xs-4'>"
615 add
"<h3>Properties</h3>"
630 #####################
631 # Basiv HTML elements
632 #####################
639 var href
: String writable
641 # Text to display in the link
642 var text
: String writable
645 var title
: nullable String writable
647 init(href
, text
: String) do
652 init with_title
(href
, text
, title
: String) do
657 redef fun rendering
do
661 if title
!= null then
663 add title.as(not null)
676 # Elements contained in this list
677 # can be <li> or <ul> elements
678 var elts
= new Array[TplListElt]
680 # CSS classes of the <ul> element
681 var css_classes
= new Array[String]
683 # Add content wrapped in a <li> element
684 fun add_li
(content
: Streamable) do elts
.add
new TplListItem.with_content
(content
)
688 init with_classes
(classes
: Array[String]) do self.css_classes
= classes
690 fun is_empty
: Bool do return elts
.is_empty
692 redef fun rendering
do
693 if elts
.is_empty
then return
694 add
"<ul class='{css_classes.join(" ")}'>"
695 for elt
in elts
do add elt
700 # Something that can be added to a TplList
709 # Content of the list item
710 var content
= new Template
712 # CSS classes of the <li> element
713 var css_classes
= new Array[String]
717 init with_content
(content
: Streamable) do append
(content
)
719 init with_classes
(content
: Streamable, classes
: Array[String]) do
720 with_content
(content
)
721 css_classes
= classes
724 # Append `content` to the item
725 # similar to `self.content.add`
726 fun append
(content
: Streamable) do self.content
.add content
728 redef fun rendering
do
730 for cls
in css_classes
do add
" {cls}"
737 # A label with a text content
741 # Content of the label if any
742 var content
: nullable Streamable
744 # CSS classes of the <span> element
745 var css_classes
= new Array[String]
748 init with_content
(content
: Streamable) do self.content
= content
749 init with_classes
(classes
: Array[String]) do self.css_classes
= classes
751 redef fun rendering
do
752 add
"<span class='label {css_classes.join(" ")}'>"
753 if content
!= null then add content
.as(not null)
758 # A label with an icon
763 # see: http://getbootstrap.com/components/#glyphicons
766 init with_icon
(icon
: String) do self.icon
= icon
768 redef fun rendering
do
769 add
"<span class='glyphicon glyphicon-{icon} {css_classes.join(" ")}'>"
770 if content
!= null then add content
.as(not null)
775 # A HTML tag attribute
776 # `<tag attr="value">`
781 var value
: nullable String
783 init(name
: String, value
: nullable String) do
788 redef fun rendering
do
789 var value
= self.value
790 if value
== null then
793 add
(" {name}=\"{value}\
"")
802 var attrs
= new Array[TagAttribute]
803 var content
: nullable Streamable = null is writable
806 attrs
.add
(new TagAttribute("type", "text/javascript"))
809 protected fun render_content
do
810 if content
!= null then add content
.as(not null)
813 redef fun rendering
do
815 for attr
in attrs
do add attr
822 # JS script for Piwik Tracker
826 var tracker_url
: String
829 init(tracker_url
, site_id
: String) do
831 self.tracker_url
= tracker_url
832 self.site_id
= site_id
835 redef fun render_content
do
837 add
"var _paq = _paq || [];"
838 add
" _paq.push([\"trackPageView\
"]);"
839 add
" _paq.push([\"enableLinkTracking\
"]);"
841 add
" var u=((\"https
:\
" == document.location.protocol) ? \"https\
" : \"http\
") + \"://{tracker_url}\
";"
842 add
" _paq.push([\"setTrackerUrl\
", u+\"piwik
.php\
"]);"
843 add
" _paq.push([\"setSiteId\
", \"{site_id}\
"]);"
844 add
" var d=document, g=d.createElement(\"script\
"), s=d.getElementsByTagName(\"script\
")[0]; g.type=\"text
/javascript\
";"
845 add
" g.defer=true; g.async=true; g.src=u+\"piwik
.js\
"; s.parentNode.insertBefore(g,s);"