1 #!/usr/bin/env python 2 3 """ 4 Moin wiki serialisers. 5 6 Copyright (C) 2017, 2018, 2023 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 """ 21 22 from moinformat.serialisers.manifest import serialisers 23 24 # Top-level functions. 25 26 def get_serialiser(name, doctype=None): 27 28 """ 29 Return the main serialiser class for the format having the given 'name'. 30 If 'doctype' is indicated, obtain a serialiser class specific to that 31 document type. Otherwise, a general Moin serialiser class is obtained. 32 """ 33 34 return serialisers["%s.%s" % (name, doctype or "moin")] 35 36 def make_serialiser(metadata, format=None): 37 38 """ 39 Return a serialiser instance using the given 'metadata' and optional 40 'format'. 41 """ 42 43 return metadata.get_serialiser(format) 44 45 def serialise(doc, serialiser): 46 47 "Serialise 'doc' using the given 'serialiser' instance." 48 49 serialiser.reset() 50 doc.visit(serialiser) 51 return serialiser.get_output() 52 53 # vim: tabstop=4 expandtab shiftwidth=4