Merge lp:~fenryxo/zim/templates-pagemenu into lp:~jaap.karssenberg/zim/pyzim

[Jiří Janoušek]

This branch contains 3 features:
1) notebook.name template variable
2) page.menu template variable: Page menu is a tree-style menu like index, but branches not related to current page are collapsed.
3) New template using both notebook.name & page.menu

Basic test coverage and manual update included.

I've prepared an example - manual exported with the new template - see http://tmp.doublej.cz/pagemenu/

[Jaap Karssenberg (jaap.karssenberg)]

I like the idea - maybe we should not put it in the "page" namespace. How about exposing this as a function to the template ? That way you can (later) add parameters to control the style (folded vs unfolded etc.) and make it a bit more powerful.

[Jiří Janoušek (fenryxo)]

What a good idea :-) I can imagine additional paramethers
* starting path
* limit of nesting

I'll focus on it at the weekend.

[Jiří Janoušek (fenryxo)]

The branch is ready for the review again. The test suite probably needs to be polished.

[Jaap Karssenberg (jaap.karssenberg)]

Thanks, looks better this way. Will have a look at the test cases when merging.

FYI: will be offline from this Friday for about a week and a bit - will probably not have time to merge all your branched before then. But have will attend to it when I'm back.

-- Jaap

review: Approve

[Jaap Karssenberg (jaap.karssenberg)]

Did some rework and afraid that changed how the options work. But it is more in line now with the index page that can be generated, so I propose keeping it like this. If you really want the style you had before maybe we can add a "sparse" option ?

* collapse now mimics the standard index, so it shows all of the toplevel pages and pages in any expanded sub page
* hide_empty now only hides pages that don't have content OR children, this is needed because otherwise namspaces were the parent has no text disappear.

[Jiří Janoušek (fenryxo)]

2011/6/6 Jaap Karssenberg <email address hidden>:
> Did some rework and afraid that changed how the options work. But it is more in line now with the index page that can be generated, so I propose keeping it like this. If you really want the style you had before maybe we can add a "sparse" option ?
>
> * collapse now mimics the standard index, so it shows all of the toplevel pages and pages in any expanded sub page

If I understand it correctly, collapse works like the original example
(e.g. http://tmp.doublej.cz/pagemenu /Help/Export.html ) Or if I'm
missing something, can you put somewhere similar example output?

> * hide_empty now only hides pages that don't have content OR children, this is needed because otherwise namspaces were the parent has no text disappear.

The hide_empty option was intended to prevent creating links to
non-existing pages. But the proper solution could be to create little
index pages listing child nodes (like in WWWInterface).

> --
> https://code.launchpad.net/~janousek.jiri/zim/templates-pagemenu/+merge/60616
> You are the owner of lp:~janousek.jiri/zim/templates-pagemenu.
>

[Jaap Karssenberg (jaap.karssenberg)]

2011/6/6 Jiří Janoušek <email address hidden>

> > * collapse now mimics the standard index, so it shows all of the toplevel
> pages and pages in any expanded sub page
>

> If I understand it correctly, collapse works like the original example
> (e.g. http://tmp.doublej.cz/pagemenu /Help/Export.html ) Or if I'm
> missing something, can you put somewhere similar example output?
>
>
Yes, for two level depth the behavior is the same. However it now keeps
showing the top level also for deeper nested pages.

> > * hide_empty now only hides pages that don't have content OR children,
> this is needed because otherwise namspaces were the parent has no text
> disappear.
>
> The hide_empty option was intended to prevent creating links to
> non-existing pages. But the proper solution could be to create little
> index pages listing child nodes (like in WWWInterface).
>

Maybe we need to check common code between IndexPage and this function.

-- Jaap

[Jiří Janoušek (fenryxo)]

2011/6/6 Jaap Karssenberg <email address hidden>:
> 2011/6/6 Jiří Janoušek <email address hidden>
>
>> > * collapse now mimics the standard index, so it shows all of the toplevel
>> pages and pages in any expanded sub page
>>
>
>
>> If I understand it correctly, collapse works like the original example
>> (e.g. http://tmp.doublej.cz/pagemenu /Help/Export.html ) Or if I'm
>> missing something, can you put somewhere similar example output?
>>
>>
> Yes, for two level depth the behavior is the same. However it now keeps
> showing the top level also for deeper nested pages

My code should keep top level too (unless a different starting
namespace is explicitly given). If not, it's a mistake, not purpose.

>> > * hide_empty now only hides pages that don't have content OR children,
>> this is needed because otherwise namspaces were the parent has no text
>> disappear.
>>
>> The hide_empty option was intended to prevent creating links to
>> non-existing pages. But the proper solution could be to create little
>> index pages listing child nodes (like in WWWInterface).
>>
>
> Maybe we need to check common code between IndexPage and this function.

The menu function is based on IndexPage code, but I think IndexPage
doesn't require extra logic from menu (home page order manipulation,
current page in bold, ...). It should get starting namespace and level
limit to be usable as a page body for empty pages with children.

> -- Jaap
>
> --
> https://code.launchpad.net/~janousek.jiri/zim/templates-pagemenu/+merge/60616
> You are the owner of lp:~janousek.jiri/zim/templates-pagemenu.
>

=== modified file 'data/manual/Help/Templates.txt'
--- data/manual/Help/Templates.txt	2011-04-06 20:00:02 +0000
+++ data/manual/Help/Templates.txt	2011-05-16 21:27:32 +0000
@@ -56,31 +56,31 @@
 
 '''
 zim.version		# version of zim
+notebook.name		# name of the notebook
 
 page.name		# complete page name
 page.namespace		# namespace
 page.basename		# last part of the page name
-page.title		# 
+page.title		# first heading in the page or the basename
+page.heading		# first heading in the page
+page.body		# content of the page (without the leading heading)
+page.links		# list of page objects for pages linked in this page
+page.backlinks		# list of page objects for pages linking to this page
+page.properties		# dict with page properties
+
+# These special pages have the same properties as the 'page' object
+pages.index		# the index page generated when exporting
+pages.home		# the home page
+pages.next		# the next page in the index (if any)
+pages.previous		# the previous page in the index (if any)
+
+options			# dict where format specific options can be set
 '''
-''first heading in the page or the basename''
-''page.heading		# first heading in the page''
-''page.body		# content of the page (without the leading heading)''
-''page.links		# list of page objects for pages linked in this page''
-''page.backlinks		# ''''list of page objects for pages linking to this page''
-''page.properties		# dict with page properties''
-
-''# These special pages have the same properties as the 'page' object''
-''pages.index		# the index page generated when exporting''
-''pages.home		# the home page''
-''pages.next		# the next page in the index (if any)''
-''pages.previous		# the previous page in the index (if any)''
-
-''options			# dict where format specific options can be set''
+
 
 Functions available:
 
-'''
-url(link)			# turns a zim link into an URL
-strftime(template, date)	# format a date
-'''
+* ''url(link)'' - turns a zim link into an URL
+* ''strftime(template, date)'' - format a date
+* ''menu(namespace, collapse, ignore_empty)'' - creates a tree-style menu starting with given namespace (''":"'' by default).  ''collapse'' can be ''TRUE'' (only branches related to the current page are visible, //default value//) or ''FALSE'' (all branches are visible). ''ignore_empty'' can be ''TRUE'' (empty pages are ignored, //default value//) or ''FALSE''. Example: ''menu(page.namespace,  TRUE, FALSE)''
 

=== added file 'data/templates/html/With_Menu.html'
--- data/templates/html/With_Menu.html	1970-01-01 00:00:00 +0000
+++ data/templates/html/With_Menu.html	2011-05-16 21:27:32 +0000
@@ -0,0 +1,73 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+		<title>[% page.title %]</title>
+		<meta name='Generator' content='Zim [% zim.version %]'>
+		<style type='text/css'>
+			a          { text-decoration: none      }
+			a:hover    { text-decoration: underline }
+			a:active   { text-decoration: underline }
+			strike     { color: grey                }
+			u          { text-decoration: none;
+			             background-color: yellow   }
+			tt         { color: #2e3436;            }
+			pre        { color: #2e3436;
+			             margin-left: 20px          }
+			h1         { text-align: center;
+			             color: #4e9a06             }
+			h2         { color: #4e9a06             }
+			h3         { color: #4e9a06             }
+			h4         { color: #4e9a06             }
+			h5         { color: #4e9a06             }
+			span.insen { color: grey                }
+			.page { max-width: 1000px;}
+			.menu{
+				float:left; width: 300px;
+			}
+			
+			.content { padding-left: 320px;}
+			.notebook{font-variant: small-caps;
+					color:#4e9a06;
+					padding: 0px 20px;}
+			hr{clear:both;}
+		</style>
+		
+	</head>
+	<body>
+		<div class="page">
+			<div class="heading">
+				<h1><a href="[% url(pages.home.name) %]" class="notebook">[% notebook.name %]:</a>
+			
+				
+				[% IF page.properties.type == 'namespace-index' -%]
+					Document Index</h1>
+				[%- ELSE -%]
+					[% page.heading %]</h1>
+				[%- END %]
+			</div>
+			<hr>
+			<div class="menu">
+				[% menu(page) %]
+			</div>
+			<div class="content">
+			<!-- Wiki content -->
+				[% page.body %]
+
+			<!-- End wiki content -->
+			</div>
+			<hr>
+			<!-- Backlinks -->
+			<div class="footer">
+				[% IF page.backlinks -%] Backlinks:
+					[%- FOREACH link = page.backlinks -%]
+						<a href='[% url(link) %]'>[% link.name %]</a></li>
+					[%- END -%]
+				[%- ELSE -%]
+					No backlinks to this page.
+				[%- END %]
+			<!-- End Backlinks -->
+			</div>
+		</div>
+	</body>
+</html>

=== modified file 'tests/data/notebook-wiki.xml'
--- tests/data/notebook-wiki.xml	2011-04-05 20:11:51 +0000
+++ tests/data/notebook-wiki.xml	2011-05-16 21:27:32 +0000
@@ -312,4 +312,15 @@
 [[Linking:Foo:Bar]]
 [[Dus]]
 </page>
+<page name="Parent">For page.menu template variable test</page>
+<page name="Parent:Son">For page.menu template variable test</page>
+<page name="Parent:Son:Grandson">For page.menu template variable test</page>
+<page name="Parent:Son:Granddaughter">For page.menu template variable test</page>
+<page name="Parent:Daughter">For page.menu template variable test</page>
+<page name="Parent:Daughter:Grandson">For page.menu template variable test</page>
+<page name="Parent:Daughter:Granddaughter">For page.menu template variable test</page>
+<page name="Parent:Daughter:SomeOne:Foo">For page.menu template variable test</page>
+<page name="Parent:Daughter:SomeOne:Bar">For page.menu template variable test</page>
+<page name="Parent:Child:Grandchild">For page.menu template variable test</page>
+
 </pagelist>

=== modified file 'tests/parsing.py'
--- tests/parsing.py	2011-04-02 12:36:48 +0000
+++ tests/parsing.py	2011-05-16 21:27:32 +0000
@@ -17,6 +17,11 @@
 		list = ['"foo bar"', ',', r'"\"foooo bar\""', 'dusss', 'ja']
 		result = split_quoted_strings(string, unescape=False)
 		self.assertEquals(result, list)
+		
+		string = r'''"foo bar", False, True'''
+		list = ['foo bar', ',', 'False', ',', 'True']
+		result = split_quoted_strings(string)
+		self.assertEquals(result, list)
 
 	def testParseDate(self):
 		'''Test parsing dates'''

=== modified file 'tests/templates.py'
--- tests/templates.py	2011-05-14 11:08:50 +0000
+++ tests/templates.py	2011-05-16 21:27:32 +0000
@@ -14,6 +14,7 @@
 	TemplateParam, TemplateDict, TemplateFunction, PageProxy
 from zim.notebook import Notebook, Path
 import zim.formats
+from zim.parsing import link_type
 
 
 class TestTemplateParam(tests.TestCase):
@@ -159,14 +160,14 @@
 		input = u'''\
 Version [% zim.version %]
 <title>[% page.title %]</title>
-<h1>[% page.name %]</h1>
+<h1>[% notebook.name %]: [% page.name %]</h1>
 <h2>[% page.heading %]</h2>
 [% page.body %]
 '''
 		wantedresult = u'''\
 Version %s
 <title>Page Heading</title>
-<h1>FooBar</h1>
+<h1>Unnamed Notebook: FooBar</h1>
 <h2>Page Heading</h2>
 <p>
 <strong>foo bar !</strong><br>
@@ -190,7 +191,213 @@
 		tree = template.process_to_parsetree(notebook, page) # No linker !
 		self.assertEqual(tree.find('h').text, u'Some New None existing page')
 
-
+class TestTemplatePageMenu(tests.TestCase):
+	def runTest(self):
+		# menu(root, collapse, ignore_empty)
+		data = (
+# Test default settings
+(u"[% menu() %]", '''\
+<ul>
+<li><a href="page://Parent" title="Parent">Parent</a></li>
+<ul>
+<li><strong>Daughter</strong></li>
+<ul>
+<li><a href="page://Parent:Daughter:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Daughter:Grandson" title="Grandson">Grandson</a></li>
+</ul>
+<li><a href="page://Parent:Son" title="Son">Son</a></li>
+</ul>
+<li><a href="page://roundtrip" title="roundtrip">roundtrip</a></li>
+<li><a href="page://TODOList" title="TODOList">TODOList</a></li>
+<li><a href="page://TrashMe" title="TrashMe">TrashMe</a></li>
+</ul>
+'''),
+# Collapsing turned off
+(u"[% menu(':', FALSE, TRUE) %]", '''\
+<ul>
+<li><a href="page://Parent" title="Parent">Parent</a></li>
+<ul>
+<li><strong>Daughter</strong></li>
+<ul>
+<li><a href="page://Parent:Daughter:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Daughter:Grandson" title="Grandson">Grandson</a></li>
+</ul>
+<li><a href="page://Parent:Son" title="Son">Son</a></li>
+<ul>
+<li><a href="page://Parent:Son:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Son:Grandson" title="Grandson">Grandson</a></li>
+</ul>
+</ul>
+<li><a href="page://roundtrip" title="roundtrip">roundtrip</a></li>
+<li><a href="page://TODOList" title="TODOList">TODOList</a></li>
+<ul>
+<li><a href="page://TODOList:bar" title="bar">bar</a></li>
+<li><a href="page://TODOList:foo" title="foo">foo</a></li>
+</ul>
+<li><a href="page://TrashMe" title="TrashMe">TrashMe</a></li>
+<ul>
+<li><a href="page://TrashMe:sub page 1" title="sub page 1">sub page 1</a></li>
+<li><a href="page://TrashMe:sub page 2" title="sub page 2">sub page 2</a></li>
+</ul>
+</ul>
+'''),
+# Empty pages are not ignored
+(u"[% menu(':', TRUE, FALSE) %]", '''\
+<ul>
+<li><a href="page://Bar" title="Bar">Bar</a></li>
+<li><a href="page://foo" title="foo">foo</a></li>
+<li><a href="page://Linking" title="Linking">Linking</a></li>
+<li><a href="page://Parent" title="Parent">Parent</a></li>
+<ul>
+<li><a href="page://Parent:Child" title="Child">Child</a></li>
+<li><strong>Daughter</strong></li>
+<ul>
+<li><a href="page://Parent:Daughter:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Daughter:Grandson" title="Grandson">Grandson</a></li>
+<li><a href="page://Parent:Daughter:SomeOne" title="SomeOne">SomeOne</a></li>
+</ul>
+<li><a href="page://Parent:Son" title="Son">Son</a></li>
+</ul>
+<li><a href="page://roundtrip" title="roundtrip">roundtrip</a></li>
+<li><a href="page://Test" title="Test">Test</a></li>
+<li><a href="page://TODOList" title="TODOList">TODOList</a></li>
+<li><a href="page://TrashMe" title="TrashMe">TrashMe</a></li>
+<li><a href="page://utf8" title="utf8">utf8</a></li>
+</ul>
+'''),
+# Both
+(u"[% menu(':', FALSE, FALSE) %]", '''\
+<ul>
+<li><a href="page://Bar" title="Bar">Bar</a></li>
+<li><a href="page://foo" title="foo">foo</a></li>
+<ul>
+<li><a href="page://foo:bar" title="bar">bar</a></li>
+</ul>
+<li><a href="page://Linking" title="Linking">Linking</a></li>
+<ul>
+<li><a href="page://Linking:Dus" title="Dus">Dus</a></li>
+<ul>
+<li><a href="page://Linking:Dus:Ja" title="Ja">Ja</a></li>
+</ul>
+<li><a href="page://Linking:Foo" title="Foo">Foo</a></li>
+<ul>
+<li><a href="page://Linking:Foo:Bar" title="Bar">Bar</a></li>
+<ul>
+<li><a href="page://Linking:Foo:Bar:Baz" title="Baz">Baz</a></li>
+</ul>
+</ul>
+</ul>
+<li><a href="page://Parent" title="Parent">Parent</a></li>
+<ul>
+<li><a href="page://Parent:Child" title="Child">Child</a></li>
+<ul>
+<li><a href="page://Parent:Child:Grandchild" title="Grandchild">Grandchild</a></li>
+</ul>
+<li><strong>Daughter</strong></li>
+<ul>
+<li><a href="page://Parent:Daughter:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Daughter:Grandson" title="Grandson">Grandson</a></li>
+<li><a href="page://Parent:Daughter:SomeOne" title="SomeOne">SomeOne</a></li>
+<ul>
+<li><a href="page://Parent:Daughter:SomeOne:Bar" title="Bar">Bar</a></li>
+<li><a href="page://Parent:Daughter:SomeOne:Foo" title="Foo">Foo</a></li>
+</ul>
+</ul>
+<li><a href="page://Parent:Son" title="Son">Son</a></li>
+<ul>
+<li><a href="page://Parent:Son:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Son:Grandson" title="Grandson">Grandson</a></li>
+</ul>
+</ul>
+<li><a href="page://roundtrip" title="roundtrip">roundtrip</a></li>
+<li><a href="page://Test" title="Test">Test</a></li>
+<ul>
+<li><a href="page://Test:foo" title="foo">foo</a></li>
+<ul>
+<li><a href="page://Test:foo:bar" title="bar">bar</a></li>
+</ul>
+<li><a href="page://Test:Foo Bar" title="Foo Bar">Foo Bar</a></li>
+<ul>
+<li><a href="page://Test:Foo Bar:Dus Ja Hmm" title="Dus Ja Hmm">Dus Ja Hmm</a></li>
+</ul>
+<li><a href="page://Test:tags" title="tags">tags</a></li>
+<li><a href="page://Test:wiki" title="wiki">wiki</a></li>
+</ul>
+<li><a href="page://TODOList" title="TODOList">TODOList</a></li>
+<ul>
+<li><a href="page://TODOList:bar" title="bar">bar</a></li>
+<li><a href="page://TODOList:foo" title="foo">foo</a></li>
+</ul>
+<li><a href="page://TrashMe" title="TrashMe">TrashMe</a></li>
+<ul>
+<li><a href="page://TrashMe:sub page 1" title="sub page 1">sub page 1</a></li>
+<li><a href="page://TrashMe:sub page 2" title="sub page 2">sub page 2</a></li>
+</ul>
+<li><a href="page://utf8" title="utf8">utf8</a></li>
+<ul>
+<li><a href="page://utf8:αβγ" title="αβγ">αβγ</a></li>
+<li><a href="page://utf8:בדיקה" title="בדיקה">בדיקה</a></li>
+<ul>
+<li><a href="page://utf8:בדיקה:טכניון" title="טכניון">טכניון</a></li>
+<ul>
+<li><a href="page://utf8:בדיקה:טכניון:הנדסת מכונות" title="הנדסת מכונות">הנדסת מכונות</a></li>
+<li><a href="page://utf8:בדיקה:טכניון:מדעי המחשב" title="מדעי המחשב">מדעי המחשב</a></li>
+</ul>
+</ul>
+<li><a href="page://utf8:中文" title="中文">中文</a></li>
+</ul>
+</ul>
+'''),
+# Let's chenge the root
+(u"[% menu(page, FALSE) %]", '''\
+<ul>
+<li><a href="page://Parent:Daughter:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Daughter:Grandson" title="Grandson">Grandson</a></li>
+</ul>
+'''),
+(u"[% menu(page.name, FALSE, FALSE) %]", '''\
+<ul>
+<li><a href="page://Parent:Daughter:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Daughter:Grandson" title="Grandson">Grandson</a></li>
+<li><a href="page://Parent:Daughter:SomeOne" title="SomeOne">SomeOne</a></li>
+<ul>
+<li><a href="page://Parent:Daughter:SomeOne:Bar" title="Bar">Bar</a></li>
+<li><a href="page://Parent:Daughter:SomeOne:Foo" title="Foo">Foo</a></li>
+</ul>
+</ul>
+'''),
+(u"[% menu(page.namespace, FALSE, FALSE) %]", '''\
+<ul>
+<li><a href="page://Parent:Child" title="Child">Child</a></li>
+<ul>
+<li><a href="page://Parent:Child:Grandchild" title="Grandchild">Grandchild</a></li>
+</ul>
+<li><strong>Daughter</strong></li>
+<ul>
+<li><a href="page://Parent:Daughter:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Daughter:Grandson" title="Grandson">Grandson</a></li>
+<li><a href="page://Parent:Daughter:SomeOne" title="SomeOne">SomeOne</a></li>
+<ul>
+<li><a href="page://Parent:Daughter:SomeOne:Bar" title="Bar">Bar</a></li>
+<li><a href="page://Parent:Daughter:SomeOne:Foo" title="Foo">Foo</a></li>
+</ul>
+</ul>
+<li><a href="page://Parent:Son" title="Son">Son</a></li>
+<ul>
+<li><a href="page://Parent:Son:Granddaughter" title="Granddaughter">Granddaughter</a></li>
+<li><a href="page://Parent:Son:Grandson" title="Grandson">Grandson</a></li>
+</ul>
+</ul>
+'''),
+)
+
+		notebook = notebook = tests.new_notebook()
+		page = notebook.get_page(Path(':Parent:Daughter'))
+		for input, wantedresult in data:
+			result = Template(input, 'html', linker=StubLinker()).process(notebook, page)
+			self.assertEqual(result, wantedresult.splitlines(True))
+
+		
 
 class StubLinker(object):
 

=== modified file 'zim/parsing.py'
--- zim/parsing.py	2011-05-13 05:44:02 +0000
+++ zim/parsing.py	2011-05-16 21:27:32 +0000
@@ -12,7 +12,8 @@
 	word_re = Re(r'''
 		(	'(\\'|[^'])*' |  # single quoted word
 			"(\\"|[^"])*" |  # double quoted word
-			\S+              # word without spaces
+			[^\s,]+       |  # word without spaces and commas
+			,                # comma
 		)''', re.X)
 	string = string.strip()
 	words = []

=== modified file 'zim/templates.py'
--- zim/templates.py	2011-05-13 05:44:02 +0000
+++ zim/templates.py	2011-05-16 21:27:32 +0000
@@ -71,8 +71,9 @@
 from zim.fs import File
 from zim.config import data_dirs
 from zim.parsing import Re, TextBuffer, split_quoted_strings, unescape_quoted_string, is_path_re
-from zim.formats import ParseTree, Element
+from zim.formats import ParseTree, Element, TreeBuilder
 from zim.index import LINK_DIR_BACKWARD
+from zim.notebook import Path
 
 logger = logging.getLogger('zim.templates')
 
@@ -198,7 +199,6 @@
 		'''
 		if not isinstance(dict, TemplateDict):
 			dict = TemplateDict(dict)
-
 		output = TextBuffer(self.tokens.process(dict))
 		return output.get_lines()
 
@@ -334,7 +334,11 @@
 			'pages': pages,
 			'strftime': StrftimeFunction(),
 			'url': TemplateFunction(self.url),
-			'options': options
+			'options': options,
+			'notebook': {'name' : notebook.name},
+			'menu' : MenuFunction(notebook, page, self.format, self.linker, options),
+			# helpers that allow to write TRUE instead of 'TRUE' in template functions
+			'TRUE' : 'True', 'FALSE' : 'False', 
 		}
 
 		if self.linker:
@@ -625,6 +629,109 @@
 		else:
 			raise AssertionError, 'Not a datetime object: %s', date
 
+class MenuFunction(TemplateFunction):
+	'''Template function wrapper for strftime'''
+
+	def __init__(self, notebook, page, format, linker, options):
+		self._notebook = notebook
+		self._page = page
+		self._format = format
+		self._linker = linker
+		self._options = options
+		
+
+	def __call__(self, dict, root=':', collapse=True, ignore_empty=True):
+		builder = TreeBuilder()
+		level = self._page.name.count(':')
+		home = Path(self._notebook.config['Notebook']['home'])
+		
+		# TODO: Some logic to parse boolean template function params
+		if isinstance(collapse, (TemplateParam, TemplateLiteral, basestring)):
+			collapse = (str(collapse).strip().lower() == 'true')
+		if isinstance(ignore_empty, (TemplateParam, TemplateLiteral, basestring)):
+			ignore_empty = (str(ignore_empty).strip().lower() == 'true')
+		
+		# [% menu(page) %] vs [% menu(page.name) %]
+		if isinstance(root, PageProxy): root = root.name
+		#~ print "!!! ROOT, ", root
+		
+		def add_namespace(path):
+			mylevel = path.name.count(':')
+			
+			if collapse:
+				# Menu doesn't show whole tree, but only pages related to the current page.
+				if mylevel > level:
+					# "path" is more nested then the current page
+					return
+				elif level == mylevel:
+					# "path" has same level as current page
+					if not self._page.name == path.name and path.name:
+						# Show only children of the current page or namespace pages
+						return
+				elif not self._page.name.startswith(path.name):
+					# "path" is less nested, show only children of the ancestors
+					# of the current page
+					return
+			
+			#~ print "!!! path & level", path, mylevel
+			pagelist = list(self._notebook.index.list_pages(path))
+			# find home page
+			for page in pagelist:
+				if page.name == home.name:
+					home_page = page
+					break
+			else:
+				# home page not in list
+				home_page = None
+
+			# home page will be first item
+			if not home_page is None:
+				pagelist.remove(home_page)
+				pagelist.insert(0, home_page)
+
+			builder.start('ul')
+			for page in pagelist:
+				if ignore_empty and not page.hascontent:
+					#~ print "!!! skip page", page
+					continue
+				builder.start('li')
+				text = page.basename
+
+				if self._page.name == page.name:
+					# Current page is marked with the strong style
+					builder.start('strong')
+					builder.data(text)
+					builder.end('strong')
+				else:
+					# links to other pages
+					builder.start('link', {'type': 'page', 'href': page.name})
+					builder.data(text)
+					builder.end('link')
+				builder.end('li')
+				if page.haschildren:
+					add_namespace(page) # recurs
+			builder.end('ul')
+
+		builder.start('page')
+		add_namespace(Path(root))
+		builder.end('page')
+
+		tree = ParseTree(builder.close())
+		if not tree:
+			return None
+			
+		#~ print "!!!", tree.tostring()
+		
+		format = self._format
+		linker = self._linker
+		if linker:
+			linker.set_path(self._page)
+
+		dumper = format.Dumper(
+			linker=linker,
+			template_options=self._options )
+
+		return ''.join(dumper.dump(tree))
 
 class TemplateDict(object):
 	'''Object behaving like a dict for storing values of template parameters.
@@ -751,7 +858,7 @@
 		for link in blinks:
 			source = self._notebook.get_page(link.source)
 			yield PageProxy(self._notebook, source, self._format, self._linker, self._options)
-
+	
 
 class ParseTreeProxy(object):