1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/moinformat/macros/pagelist.py Sun Apr 14 19:13:03 2019 +0200
1.3 @@ -0,0 +1,81 @@
1.4 +#!/usr/bin/env python
1.5 +
1.6 +"""
1.7 +PageList macro for Moin compatibility.
1.8 +
1.9 +Copyright (C) 2019 Paul Boddie <paul@boddie.org.uk>
1.10 +
1.11 +This program is free software; you can redistribute it and/or modify it under
1.12 +the terms of the GNU General Public License as published by the Free Software
1.13 +Foundation; either version 3 of the License, or (at your option) any later
1.14 +version.
1.15 +
1.16 +This program is distributed in the hope that it will be useful, but WITHOUT
1.17 +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
1.18 +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
1.19 +details.
1.20 +
1.21 +You should have received a copy of the GNU General Public License along with
1.22 +this program. If not, see <http://www.gnu.org/licenses/>.
1.23 +"""
1.24 +
1.25 +from moinformat.macros.common import Macro
1.26 +from moinformat.tree.moin import Link, LinkLabel, List, ListItem, Text
1.27 +from moinformat.utils.links import LinkTarget
1.28 +
1.29 +class PageListMacro(Macro):
1.30 +
1.31 + "A page list macro."
1.32 +
1.33 + name = "PageList"
1.34 +
1.35 + def evaluate(self):
1.36 +
1.37 + "Evaluate the macro, producing a list of pages."
1.38 +
1.39 + # Obtain the parameters.
1.40 +
1.41 + args = self.node.args
1.42 + pattern = args and args[0] or None
1.43 +
1.44 + # Access the input context to get page details.
1.45 +
1.46 + input = self.metadata.get_input()
1.47 +
1.48 + # Select pages according to the parameters.
1.49 + # NOTE: Currently using prefix matching only.
1.50 +
1.51 + if pattern:
1.52 + pagenames = []
1.53 + for pagename in input.all():
1.54 + if pagename.startswith(pattern):
1.55 + pagenames.append(pagename)
1.56 + else:
1.57 + pagenames = input.all()
1.58 +
1.59 + # Sort the pagenames.
1.60 + # NOTE: The actual sort order should be controlled.
1.61 +
1.62 + pagenames.sort()
1.63 +
1.64 + # Prepare a list of links.
1.65 +
1.66 + items = []
1.67 + indent = 0
1.68 + marker = "*"
1.69 + space = " "
1.70 + num = None
1.71 +
1.72 + for pagename in pagenames:
1.73 + text = [Text(pagename)]
1.74 + nodes = [Link([LinkLabel(text)], LinkTarget("page", pagename))]
1.75 + items.append(ListItem(nodes, indent, marker, space, num))
1.76 +
1.77 + # Replace the macro node with the list.
1.78 +
1.79 + macro = self.node
1.80 + macro.parent.replace(macro, List(items))
1.81 +
1.82 +macro = PageListMacro
1.83 +
1.84 +# vim: tabstop=4 expandtab shiftwidth=4