hierarchy.py: preliminary get_hierarchal_sitemap()

[webber.git] / in / functions.md

diff --git a/in/functions.md b/in/functions.md
index c91418c43d59d52cb55c465ed921556a2798ba16..9ee79498c3d946cc8a6426b876a61e0ab6a7b645 100644 (file)
--- a/in/functions.md
+++ b/in/functions.md
@@ -66,7 +66,7 @@ You'll need to specify "`root`" if your top-most page isn't named "`Home`".
 Defined in [[hierarchy.py|hierarchy]], where you find an example.
 
 
-== get_sitemap(root, show_orphans) ==
+== get_linear_sitemap(root, show_orphans, level) ==
 
 Returns all pages as "`(level, page, link)`" tuples, where "`page`" is a
 "`class File`"-object and link is a relative link from the current page to
@@ -74,6 +74,8 @@ Returns all pages as "`(level, page, link)`" tuples, where "`page`" is a
 
 You'll need to specify "`root`" if your top-most page isn't named "`Home`".
 
+The "`level`" will by default start at 1.
+
 To put pages into the sitemap that are outside the parent/child relationships,
 specify "`True`" for "`show_orphans`".