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
84 wiki
.message
("Render auto-index for section {out_path}", 1)
91 # Copy attached files from `src_path` to `out_path`.
92 private fun copy_files
do
94 var dir
= src_full_path
.to_s
95 for name
in dir
.files
do
96 if name
== wiki
.config_filename
then continue
97 if name
.has_suffix
(".md") then continue
98 if has_child
(name
) then continue
99 var src
= wiki
.expand_path
(dir
, name
)
100 var out
= wiki
.expand_path
(out_full_path
, name
)
101 if not wiki
.need_render
(src
, out
) then continue
102 sys
.system
"cp -R {src} {out_full_path}"
106 # The index page for this section.
108 # If no file `index.md` exists for this section,
109 # a summary is generated using contained articles.
110 fun index
: WikiArticle is cached
do
111 for child
in children
.values
do
112 if child
isa WikiArticle and child
.is_index
then return child
114 return new WikiSectionIndex(wiki
, "index", self)
117 redef fun tpl_link
do return index
.tpl_link
119 # Render the section hierarchy as a html tree.
121 # `limit` is used to specify the max-depth of the tree.
123 # The generated tree will be something like this:
130 # <li>section 2.1</li>
131 # <li>section 2.2</li>
136 fun tpl_tree
(limit
: Int): Template do
137 return tpl_tree_intern
(limit
, 1)
140 # Build the template tree for this section recursively.
141 protected fun tpl_tree_intern
(limit
, count
: Int): Template do
142 var out
= new Template
146 if (limit
< 0 or count
< limit
) and
147 (children
.length
> 1 or (children
.length
== 1)) then
149 for child
in children
.values
do
150 if child
== index
then continue
151 if child
isa WikiArticle then
153 out
.add child
.tpl_link
155 else if child
isa WikiSection and not child
.is_hidden
then
156 out
.add child
.tpl_tree_intern
(limit
, count
+ 1)
166 redef class WikiArticle
168 redef fun out_path
: String do
169 if parent
== null then
170 return wiki
.expand_path
(wiki
.config
.out_dir
, "{name}.html")
172 return wiki
.expand_path
(parent
.out_path
, "{name}.html")
177 if parent
== null then
178 return wiki
.config
.root_url
.join_path
("{name}.html")
180 return parent
.url
.join_path
("{name}.html")
184 # Is `self` an index page?
186 # Checks if `self.name == "index"`.
187 fun is_index
: Bool do return name
== "index"
190 if not is_dirty
and not wiki
.force_render
then return
191 wiki
.message
("Render article {name}", 2)
192 var file
= out_full_path
194 tpl_page
.write_to_file file
199 # Replace macros in the template by wiki data.
200 private fun tpl_page
: TemplateString do
201 var tpl
= wiki
.load_template
(template_file
)
202 if tpl
.has_macro
("TOP_MENU") then
203 tpl
.replace
("TOP_MENU", tpl_menu
)
205 if tpl
.has_macro
("HEADER") then
206 tpl
.replace
("HEADER", tpl_header
)
208 if tpl
.has_macro
("BODY") then
209 tpl
.replace
("BODY", tpl_article
)
211 if tpl
.has_macro
("FOOTER") then
212 tpl
.replace
("FOOTER", tpl_footer
)
217 # Generate the HTML header for this article.
218 fun tpl_header
: Streamable do
219 var file
= header_file
220 if not wiki
.has_template
(file
) then return ""
221 return wiki
.load_template
(file
)
224 # Generate the HTML page for this article.
225 fun tpl_article
: TplArticle do
226 var article
= new TplArticle
227 article
.body
= content
228 article
.breadcrumbs
= new TplBreadcrumbs(self)
229 tpl_sidebar
.blocks
.add tpl_summary
230 article
.sidebar
= tpl_sidebar
234 # Sidebar for this page.
235 var tpl_sidebar
= new TplSidebar
237 # Generate the HTML summary for this article.
239 # Based on `headlines`
240 fun tpl_summary
: Streamable do
241 var headlines
= self.headlines
242 var tpl
= new Template
243 tpl
.add
"<ul class=\"summary list-unstyled\
">"
244 var iter
= headlines
.iterator
247 # parse title as markdown
248 var title
= hl
.title
.md_to_html
.to_s
249 title
= title
.substring
(3, title
.length
- 8)
250 tpl
.add
"<li><a href=\"#{hl.id}\">{title}</a>"
253 if iter
.item
.level
> hl
.level
then
254 tpl
.add
"<ul class=\"list-unstyled\
">"
255 else if iter
.item
.level
< hl
.level
then
267 # Generate the HTML menu for this article.
268 fun tpl_menu
: Streamable do
270 if not wiki
.has_template
(file
) then return ""
271 var tpl
= wiki
.load_template
(file
)
272 if tpl
.has_macro
("MENUS") then
273 var items
= new Template
274 for child
in wiki
.root_section
.children
.values
do
275 if child
isa WikiArticle and child
.is_index
then continue
276 if child
isa WikiSection and child
.is_hidden
then continue
278 if self == child
or self.breadcrumbs
.has
(child
) then
279 items
.add
" class=\"active\
""
282 items
.add child
.tpl_link
285 tpl
.replace
("MENUS", items
)
290 # Generate the HTML footer for this article.
291 fun tpl_footer
: Streamable do
292 var file
= footer_file
293 if not wiki
.has_template
(file
) then return ""
294 var tpl
= wiki
.load_template
(file
)
295 var time
= new Tm.gmtime
296 if tpl
.has_macro
("YEAR") then
297 tpl
.replace
("YEAR", (time
.year
+ 1900).to_s
)
299 if tpl
.has_macro
("GEN_TIME") then
300 tpl
.replace
("GEN_TIME", time
.to_s
)
306 # A `WikiArticle` that contains the sitemap tree.
310 redef fun tpl_article
do
311 var article
= new TplArticle.with_title
("Sitemap")
312 article
.body
= new TplPageTree(wiki
.root_section
, -1)
316 redef var is_dirty
= false
319 # A `WikiArticle` that contains the section index tree.
320 class WikiSectionIndex
323 # The section described by `self`.
324 var section
: WikiSection
326 redef fun title
do return section
.title
328 redef fun url
do return section
.url
330 redef var is_dirty
= false
332 redef fun tpl_article
do
333 var article
= new TplArticle.with_title
(section
.title
)
334 article
.body
= new TplPageTree(section
, -1)
335 article
.breadcrumbs
= new TplBreadcrumbs(self)
340 # Article HTML output.
345 var title
: nullable Streamable = null
348 var body
: nullable Streamable = null
350 # Sidebar of this article (if any).
351 var sidebar
: nullable TplSidebar = null
353 # Breadcrumbs from wiki root to this article.
354 var breadcrumbs
: nullable TplBreadcrumbs = null
356 # Init `self` with a `title`.
357 init with_title
(title
: Streamable) do
361 redef fun rendering
do
362 if sidebar
!= null then
363 add
"<div class=\"col-sm-3 sidebar\
">"
364 add sidebar
.as(not null)
366 add
"<div class=\"col-sm-9 content\
">"
368 add
"<div class=\"col-sm-12 content\
">"
372 if breadcrumbs
!= null then
373 add breadcrumbs
.as(not null)
375 if title
!= null then
377 add title
.as(not null)
380 add body
.as(not null)
387 # A collection of HTML blocks displayed on the side of a page.
391 # Blocks are `Stremable` pieces that will be rendered in the sidebar.
392 var blocks
= new Array[Streamable]
394 redef fun rendering
do
395 for block
in blocks
do
396 add
"<div class=\"sideblock\
">"
403 # An HTML breadcrumbs that show the path from a `WikiArticle` to the `Nitiwiki` root.
407 # Bread crumb article.
408 var article
: WikiArticle
410 redef fun rendering
do
411 var path
= article
.breadcrumbs
412 if path
.is_empty
or path
.length
<= 2 and article
.is_index
then return
413 add
"<ol class=\"breadcrumb\
">"
415 if entry
== path
.last
then
416 add
"<li class=\"active\
">"
420 if article
.parent
== entry
and article
.is_index
then continue
430 # An HTML tree that show the section pages structure.
434 # Builds the page tree from `root`.
435 var root
: WikiSection
437 # Limits the tree depth to `max_depth` levels.
440 redef fun rendering
do
442 add root
.tpl_tree
(-1)