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.
22 # Render HTML output looking for changes in the markdown sources.
24 if not root_section
.is_dirty
and not force_render
then return
25 var out_dir
= expand_path
(config
.root_dir
, config
.out_dir
)
28 root_section
.add_child make_sitemap
32 # Copy the asset directory to the (public) output directory.
33 private fun copy_assets
do
34 var src
= expand_path
(config
.root_dir
, config
.assets_dir
)
35 var out
= expand_path
(config
.root_dir
, config
.out_dir
)
36 if need_render
(src
, expand_path
(out
, config
.assets_dir
)) then
37 if src
.file_exists
then sys
.system
"cp -R {src} {out}"
41 # Build the wiki sitemap page.
42 private fun make_sitemap
: WikiSitemap do
43 var sitemap
= new WikiSitemap(self, "sitemap")
44 sitemap
.is_dirty
= true
51 # Url to `self` once generated.
52 fun url
: String do return wiki
.config
.root_url
.join_path
(breadcrumbs
.join
("/"))
54 # Get a `<a>` template link to `self`
55 fun tpl_link
: Streamable do
56 return "<a href=\"{url}\
">{title}</a>"
60 redef class WikiSection
62 # Output directory (where to ouput the HTML pages for this section).
63 redef fun out_path
: String do
64 if parent
== null then
65 return wiki
.config
.out_dir
67 return wiki
.expand_path
(parent
.out_path
, name
)
72 if not is_dirty
and not wiki
.force_render
then return
76 sys
.system
"touch {out_full_path}"
79 wiki
.message
("Render section {out_path}", 1)
82 var index
= self.index
83 if index
isa WikiSectionIndex then
90 # Copy attached files from `src_path` to `out_path`.
91 private fun copy_files
do
93 var dir
= src_full_path
.to_s
94 for name
in dir
.files
do
95 if name
== wiki
.config_filename
then continue
96 if name
.has_suffix
(".md") then continue
97 if has_child
(name
) then continue
98 var src
= wiki
.expand_path
(dir
, name
)
99 var out
= wiki
.expand_path
(out_full_path
, name
)
100 if not wiki
.need_render
(src
, out
) then continue
101 sys
.system
"cp -R {src} {out_full_path}"
105 # The index page for this section.
107 # If no file `index.md` exists for this section,
108 # a summary is generated using contained articles.
109 fun index
: WikiArticle is cached
do
110 for child
in children
.values
do
111 if child
isa WikiArticle and child
.is_index
then return child
113 return new WikiSectionIndex(wiki
, "index", self)
116 redef fun tpl_link
do return index
.tpl_link
118 # Render the section hierarchy as a html tree.
120 # `limit` is used to specify the max-depth of the tree.
122 # The generated tree will be something like this:
129 # <li>section 2.1</li>
130 # <li>section 2.2</li>
135 fun tpl_tree
(limit
: Int): Template do
136 return tpl_tree_intern
(limit
, 1)
139 # Build the template tree for this section recursively.
140 protected fun tpl_tree_intern
(limit
, count
: Int): Template do
141 var out
= new Template
145 if (limit
< 0 or count
< limit
) and
146 (children
.length
> 1 or (children
.length
== 1)) then
148 for child
in children
.values
do
149 if child
== index
then continue
150 if child
isa WikiArticle then
152 out
.add child
.tpl_link
154 else if child
isa WikiSection and not child
.is_hidden
then
155 out
.add child
.tpl_tree_intern
(limit
, count
+ 1)
165 redef class WikiArticle
167 redef fun out_path
: String do
168 if parent
== null then
169 return wiki
.expand_path
(wiki
.config
.out_dir
, "{name}.html")
171 return wiki
.expand_path
(parent
.out_path
, "{name}.html")
176 if parent
== null then
177 return wiki
.config
.root_url
.join_path
("{name}.html")
179 return parent
.url
.join_path
("{name}.html")
183 # Is `self` an index page?
185 # Checks if `self.name == "index"`.
186 fun is_index
: Bool do return name
== "index"
189 if not is_dirty
and not wiki
.force_render
then return
190 wiki
.message
("Render article {name}", 2)
191 var file
= out_full_path
193 tpl_page
.write_to_file file
198 # Replace macros in the template by wiki data.
199 private fun tpl_page
: TemplateString do
200 var tpl
= wiki
.load_template
(template_file
)
201 if tpl
.has_macro
("TOP_MENU") then
202 tpl
.replace
("TOP_MENU", tpl_menu
)
204 if tpl
.has_macro
("HEADER") then
205 tpl
.replace
("HEADER", tpl_header
)
207 if tpl
.has_macro
("BODY") then
208 tpl
.replace
("BODY", tpl_article
)
210 if tpl
.has_macro
("FOOTER") then
211 tpl
.replace
("FOOTER", tpl_footer
)
216 # Generate the HTML header for this article.
217 fun tpl_header
: Streamable do
218 var file
= header_file
219 if not wiki
.has_template
(file
) then return ""
220 return wiki
.load_template
(file
)
223 # Generate the HTML page for this article.
224 fun tpl_article
: TplArticle do
225 var article
= new TplArticle
226 article
.body
= content
227 article
.breadcrumbs
= new TplBreadcrumbs(self)
228 tpl_sidebar
.blocks
.add tpl_summary
229 article
.sidebar
= tpl_sidebar
233 # Sidebar for this page.
234 var tpl_sidebar
= new TplSidebar
236 # Generate the HTML summary for this article.
238 # Based on `headlines`
239 fun tpl_summary
: Streamable do
240 var headlines
= self.headlines
241 var tpl
= new Template
242 tpl
.add
"<ul class=\"summary list-unstyled\
">"
243 var iter
= headlines
.iterator
246 # parse title as markdown
247 var title
= hl
.title
.md_to_html
.to_s
248 title
= title
.substring
(3, title
.length
- 8)
249 tpl
.add
"<li><a href=\"#{hl.id}\">{title}</a>"
252 if iter
.item
.level
> hl
.level
then
253 tpl
.add
"<ul class=\"list-unstyled\
">"
254 else if iter
.item
.level
< hl
.level
then
266 # Generate the HTML menu for this article.
267 fun tpl_menu
: Streamable do
269 if not wiki
.has_template
(file
) then return ""
270 var tpl
= wiki
.load_template
(file
)
271 if tpl
.has_macro
("MENUS") then
272 var items
= new Template
273 for child
in wiki
.root_section
.children
.values
do
274 if child
isa WikiArticle and child
.is_index
then continue
275 if child
isa WikiSection and child
.is_hidden
then continue
277 if self == child
or self.breadcrumbs
.has
(child
) then
278 items
.add
" class=\"active\
""
281 items
.add child
.tpl_link
284 tpl
.replace
("MENUS", items
)
289 # Generate the HTML footer for this article.
290 fun tpl_footer
: Streamable do
291 var file
= footer_file
292 if not wiki
.has_template
(file
) then return ""
293 var tpl
= wiki
.load_template
(file
)
294 var time
= new Tm.gmtime
295 if tpl
.has_macro
("YEAR") then
296 tpl
.replace
("YEAR", (time
.year
+ 1900).to_s
)
298 if tpl
.has_macro
("GEN_TIME") then
299 tpl
.replace
("GEN_TIME", time
.to_s
)
305 # A `WikiArticle` that contains the sitemap tree.
309 redef fun tpl_article
do
310 var article
= new TplArticle.with_title
("Sitemap")
311 article
.body
= new TplPageTree(wiki
.root_section
, -1)
315 redef var is_dirty
= false
318 # A `WikiArticle` that contains the section index tree.
319 class WikiSectionIndex
322 # The section described by `self`.
323 var section
: WikiSection
325 redef var is_dirty
= false
327 redef fun tpl_article
do
328 var article
= new TplArticle.with_title
(section
.title
)
329 article
.body
= new TplPageTree(section
, -1)
330 article
.breadcrumbs
= new TplBreadcrumbs(self)
335 # Article HTML output.
340 var title
: nullable Streamable = null
343 var body
: nullable Streamable = null
345 # Sidebar of this article (if any).
346 var sidebar
: nullable TplSidebar = null
348 # Breadcrumbs from wiki root to this article.
349 var breadcrumbs
: nullable TplBreadcrumbs = null
351 # Init `self` with a `title`.
352 init with_title
(title
: Streamable) do
356 redef fun rendering
do
357 if sidebar
!= null then
358 add
"<div class=\"col-sm-3 sidebar\
">"
359 add sidebar
.as(not null)
361 add
"<div class=\"col-sm-9 content\
">"
363 add
"<div class=\"col-sm-12 content\
">"
367 if breadcrumbs
!= null then
368 add breadcrumbs
.as(not null)
370 if title
!= null then
372 add title
.as(not null)
375 add body
.as(not null)
382 # A collection of HTML blocks displayed on the side of a page.
386 # Blocks are `Stremable` pieces that will be rendered in the sidebar.
387 var blocks
= new Array[Streamable]
389 redef fun rendering
do
390 for block
in blocks
do
391 add
"<div class=\"sideblock\
">"
398 # An HTML breadcrumbs that show the path from a `WikiArticle` to the `Nitiwiki` root.
402 # Bread crumb article.
403 var article
: WikiArticle
405 redef fun rendering
do
406 var path
= article
.breadcrumbs
407 if path
.is_empty
or path
.length
<= 2 and article
.is_index
then return
408 add
"<ol class=\"breadcrumb\
">"
410 if entry
== path
.last
then
411 add
"<li class=\"active\
">"
415 if article
.parent
== entry
and article
.is_index
then continue
425 # An HTML tree that show the section pages structure.
429 # Builds the page tree from `root`.
430 var root
: WikiSection
432 # Limits the tree depth to `max_depth` levels.
435 redef fun rendering
do
437 add root
.tpl_tree
(-1)