c984bc8b7b18a4279bcc5f3b045dd5d110e37a82
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
, 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:
128 # <li>section 2.1</li>
129 # <li>section 2.2</li>
133 fun tpl_tree
(limit
: Int): Template do
134 return tpl_tree_intern
(limit
, 1)
137 # Build the template tree for this section recursively.
138 protected fun tpl_tree_intern
(limit
, count
: Int): Template do
139 var out
= new Template
143 if (limit
< 0 or count
< limit
) and
144 (children
.length
> 1 or (children
.length
== 1)) then
146 for child
in children
.values
do
147 if child
== index
then continue
148 if child
isa WikiArticle then
150 out
.add child
.tpl_link
152 else if child
isa WikiSection and not child
.is_hidden
then
153 out
.add child
.tpl_tree_intern
(limit
, count
+ 1)
163 redef class WikiArticle
165 redef fun out_path
: String do
166 if parent
== null then
167 return wiki
.expand_path
(wiki
.config
.out_dir
, "{name}.html")
169 return wiki
.expand_path
(parent
.out_path
, "{name}.html")
174 if parent
== null then
175 return wiki
.config
.root_url
.join_path
("{name}.html")
177 return parent
.url
.join_path
("{name}.html")
181 # Is `self` an index page?
183 # Checks if `self.name == "index"`.
184 fun is_index
: Bool do return name
== "index"
187 if not is_dirty
and not wiki
.force_render
then return
188 wiki
.message
("Render article {name}", 2)
189 var file
= out_full_path
191 tpl_page
.write_to_file file
196 # Replace macros in the template by wiki data.
197 private fun tpl_page
: TemplateString do
198 var tpl
= wiki
.load_template
(template_file
)
199 if tpl
.has_macro
("TOP_MENU") then
200 tpl
.replace
("TOP_MENU", tpl_menu
)
202 if tpl
.has_macro
("HEADER") then
203 tpl
.replace
("HEADER", tpl_header
)
205 if tpl
.has_macro
("BODY") then
206 tpl
.replace
("BODY", tpl_article
)
208 if tpl
.has_macro
("FOOTER") then
209 tpl
.replace
("FOOTER", tpl_footer
)
214 # Generate the HTML header for this article.
215 fun tpl_header
: Streamable do
216 var file
= header_file
217 if not wiki
.has_template
(file
) then return ""
218 return wiki
.load_template
(file
)
221 # Generate the HTML page for this article.
222 fun tpl_article
: TplArticle do
223 var article
= new TplArticle
224 article
.body
= content
225 article
.breadcrumbs
= new TplBreadcrumbs(self)
226 tpl_sidebar
.blocks
.add tpl_summary
227 article
.sidebar
= tpl_sidebar
231 # Sidebar for this page.
232 var tpl_sidebar
= new TplSidebar
234 # Generate the HTML summary for this article.
236 # Based on `headlines`
237 fun tpl_summary
: Streamable do
238 var headlines
= self.headlines
239 var tpl
= new Template
240 tpl
.add
"<ul class=\"summary list-unstyled\
">"
241 var iter
= headlines
.iterator
244 # parse title as markdown
245 var title
= hl
.title
.md_to_html
.to_s
246 title
= title
.substring
(3, title
.length
- 8)
247 tpl
.add
"<li><a href=\"#{hl.id}\">{title}</a>"
250 if iter
.item
.level
> hl
.level
then
251 tpl
.add
"<ul class=\"list-unstyled\
">"
252 else if iter
.item
.level
< hl
.level
then
264 # Generate the HTML menu for this article.
265 fun tpl_menu
: Streamable do
267 if not wiki
.has_template
(file
) then return ""
268 var tpl
= wiki
.load_template
(file
)
269 if tpl
.has_macro
("MENUS") then
270 var items
= new Template
271 for child
in wiki
.root_section
.children
.values
do
272 if child
isa WikiArticle and child
.is_index
then continue
273 if child
isa WikiSection and child
.is_hidden
then continue
275 if self == child
or self.breadcrumbs
.has
(child
) then
276 items
.add
" class=\"active\
""
279 items
.add child
.tpl_link
282 tpl
.replace
("MENUS", items
)
287 # Generate the HTML footer for this article.
288 fun tpl_footer
: Streamable do
289 var file
= footer_file
290 if not wiki
.has_template
(file
) then return ""
291 var tpl
= wiki
.load_template
(file
)
292 var time
= new Tm.gmtime
293 if tpl
.has_macro
("YEAR") then
294 tpl
.replace
("YEAR", (time
.year
+ 1900).to_s
)
296 if tpl
.has_macro
("GEN_TIME") then
297 tpl
.replace
("GEN_TIME", time
.to_s
)
303 # A `WikiArticle` that contains the sitemap tree.
307 redef fun tpl_article
do
308 var article
= new TplArticle.with_title
("Sitemap")
309 article
.body
= new TplPageTree(wiki
.root_section
, -1)
313 redef var is_dirty
= false
316 # A `WikiArticle` that contains the section index tree.
317 class WikiSectionIndex
320 # The section described by `self`.
321 var section
: WikiSection
323 init(wiki
: Nitiwiki, section
: WikiSection) do
325 self.section
= section
328 redef var is_dirty
= false
330 redef fun tpl_article
do
331 var article
= new TplArticle.with_title
(section
.title
)
332 article
.body
= new TplPageTree(section
, -1)
333 article
.breadcrumbs
= new TplBreadcrumbs(self)
338 # Article HTML output.
342 var title
: nullable Streamable = null
343 var body
: nullable Streamable = null
344 var sidebar
: nullable TplSidebar = null
345 var breadcrumbs
: nullable TplBreadcrumbs = null
347 init with_title
(title
: Streamable) do
351 redef fun rendering
do
352 if sidebar
!= null then
353 add
"<div class=\"col-sm-3 sidebar\
">"
354 add sidebar
.as(not null)
356 add
"<div class=\"col-sm-9 content\
">"
358 add
"<div class=\"col-sm-12 content\
">"
362 if breadcrumbs
!= null then
363 add breadcrumbs
.as(not null)
365 if title
!= null then
367 add title
.as(not null)
370 add body
.as(not null)
377 # A collection of HTML blocks displayed on the side of a page.
381 # Blocks are `Stremable` pieces that will be rendered in the sidebar.
382 var blocks
= new Array[Streamable]
384 redef fun rendering
do
385 for block
in blocks
do
386 add
"<div class=\"sideblock\
">"
393 # An HTML breadcrumbs that show the path from a `WikiArticle` to the `Nitiwiki` root.
397 # Bread crumb article.
398 var article
: WikiArticle
400 redef fun rendering
do
401 var path
= article
.breadcrumbs
402 if path
.is_empty
or path
.length
<= 2 and article
.is_index
then return
403 add
"<ol class=\"breadcrumb\
">"
405 if entry
== path
.last
then
406 add
"<li class=\"active\
">"
410 if article
.parent
== entry
and article
.is_index
then continue
420 # An HTML tree that show the section pages structure.
424 # Builds the page tree from `root`.
425 var root
: WikiSection
427 # Limits the tree depth to `max_depth` levels.
430 redef fun rendering
do
432 add root
.tpl_tree
(-1)