Merge: lib/github: introduces Github hook events

[nit.git] / contrib / nitiwiki / src / wiki_html.nit

diff --git a/contrib/nitiwiki/src/wiki_html.nit b/contrib/nitiwiki/src/wiki_html.nit
index c984bc8..7f213b7 100644 (file)
--- a/contrib/nitiwiki/src/wiki_html.nit
+++ b/contrib/nitiwiki/src/wiki_html.nit
@@ -110,7 +110,7 @@ redef class WikiSection
                for child in children.values do
                        if child isa WikiArticle and child.is_index then return child
                end
-               return new WikiSectionIndex(wiki, self)
+               return new WikiSectionIndex(wiki, "index", self)
        end
 
        redef fun tpl_link do return index.tpl_link
@@ -121,15 +121,17 @@ redef class WikiSection
        #
        # The generated tree will be something like this:
        #
-       #    <ul>
-       #     <li>section 1</li>
-       #     <li>section 2
-       #      <ul>
-       #       <li>section 2.1</li>
-       #       <li>section 2.2</li>
-       #      </ul>
-       #     </li>
-       #    </ul>
+       # ~~~html
+       # <ul>
+       #  <li>section 1</li>
+       #  <li>section 2
+       #   <ul>
+       #    <li>section 2.1</li>
+       #    <li>section 2.2</li>
+       #   </ul>
+       #  </li>
+       # </ul>
+       # ~~~
        fun tpl_tree(limit: Int): Template do
                return tpl_tree_intern(limit, 1)
        end
@@ -320,11 +322,6 @@ class WikiSectionIndex
        # The section described by `self`.
        var section: WikiSection
 
-       init(wiki: Nitiwiki, section: WikiSection) do
-               super(wiki, "index")
-               self.section = section
-       end
-
        redef var is_dirty = false
 
        redef fun tpl_article do
@@ -339,11 +336,19 @@ end
 class TplArticle
        super Template
 
+       # Article title.
        var title: nullable Streamable = null
+
+       # Article HTML body.
        var body: nullable Streamable = null
+
+       # Sidebar of this article (if any).
        var sidebar: nullable TplSidebar = null
+
+       # Breadcrumbs from wiki root to this article.
        var breadcrumbs: nullable TplBreadcrumbs = null
 
+       # Init `self` with a `title`.
        init with_title(title: Streamable) do
                self.title = title
        end