Attachment 'tables-1.2.py'
Download 1 #-*- coding: utf-8 -*-
2 '''
3 MoinMoin - tables parser, Version 1.2, 14.10.2012
4
5 A simple parser that reads key:value pairs from a listing of tables (moin table markup from page or attachment) and captions then formats these for display within an enclosing borderless table. Defaults to single column layout with captions above centred tables. If more key:value pairs are provided additional rows are added to the layout. The user can set options to (1) force double or triple column layout, (2) place captions to the left or right of the tables, (3) set tables left or right justified, (4) give tables a width other than the default of 66% (a value from 25 to 100% is permitted), and (5) show only the markup for re-use with modifications, if desired, or for debugging purposes.
6
7 The key:value list must be in the form " table_page/file:: caption" with a leading space (as moin dictionary entries). All non-conforming lines are ignored without warning.
8
9 The key is a page or attachment name. The parser checks for a page first. Processing instructions are permitted at the head of a page but not in an attachment. Comment lines beginning with `##` are permitted within the table. Otherwise, both the page and file must contain a markup for a single table only.
10
11 The parser is intended for page section use only. The parser name is followed by a list of keywords separated by spaces to specify any options required.
12
13 Keywords
14
15 c-2 : forces double column layout, if the requested with is 50% or less. Overides c-3, if both options given, as double column takes precedence.
16
17 c-3 : forces triple column layout, if the requested width is 33% or less. Default is one columns, so no c-1 is not needed.
18
19 c-left : caption to left of image. Overides c-none or c-right, if more than one option given, as left takes precedence.
20
21 c-none : ignore captions.
22
23 c-right : caption to right of image. Overides c-none, if both options given, as right takes precedence over none.
24
25 t-left : tables set left. Overides f-right, if both options given, as left takes precedence.
26
27 t-right : tables set right.
28
29 nnn% : requested width of table (including caption if set to left or right), where n is digits from 25 to 100. If outside this range, the default 50% is applied and no warning is given. If two or more width options are given, the first takes precedence and others are ignored (even if the first is invalid and the default widith applied).
30
31 markup : shows the markup if you wish to re-use this with modification (assuming the default tabulation does not suit a specific purpose) or for debugging purposes.
32
33 # : inserted at the beginning of the caption overrides caption inclusion and any associated padding. Inclusion of caption text is option and effectively acts as a comment. Overidding captions can result in uneven multiple row layout where rows have different number of images and/or overidden captions. Therefore, this feature in recommended only for single row layouts. Also, caption and padding cells are not generated, so the sum of the cell widths is less than the table width and the tables and remaining captions will increase in size proportionally. Values set by the nnn% argument therefore become nominal only.
34
35 Defaults are caption and table centred, width 66%, one column (so no options for these are needed).
36
37 Keywords can appear in any order, other than as indicated above for conflicting choices.
38
39 Dependency
40
41 The parser requires a macro RenderText.py to be installed in plugin/macros. This macro un-glues the inserted table's lines, renders the markup text and inserts it in the enclosing table cell.
42
43 {{{
44 from MoinMoin import wikiutil
45 from MoinMoin.parser.text_moin_wiki import Parser as wiki
46 def execute(macro, text):
47 text = (text.replace('&&', '\n')).replace(')+>>', ')>>')
48 return wikiutil.renderText(macro.request, wiki, text)
49 }}}
50
51 Usage
52
53 {{{#!tables [c-2|c-3 ][c-left|c-none|c-right ][t-left|t-right ][nnn% ][markup ]
54 table_page/file:: [#]caption
55 table_page/file:: [#]caption
56 ...
57 }}}
58
59 History
60
61 Version 1.2 - 14.10.2012: included time dependency to properly handle Ref macro in captions
62 Version 1.1 - 23.01.2011: escaped macro syntax; revised RenderText macro accordingly
63 Version 1.0 - 22.01.2011: initial version
64
65 Developed with inspiration and code from:
66
67 figures.py parser - @copyright: 2011 Ian Riley
68 keyval.py parser - @copyright: 2006 by Matt Cooper <macooper@vt.edu>
69 sort.py parser - @copyright: 2005 ReimarBauer
70
71 Copyright
72
73 @copyright: 2012 Ian Riley <ian.riley@internode.on.net>
74
75 License
76
77 GNU GPL, see COPYING for details.
78 '''
79
80 from MoinMoin.action import AttachFile
81 from MoinMoin.Page import Page
82 from MoinMoin.parser import text_moin_wiki as wiki
83 from MoinMoin import wikiutil
84
85 Dependencies = ["time"] # for captions with <<Ref()>>, which uses <<FootNote()>>, so no caching
86
87 class Parser:
88 parsername = 'tables'
89
90 def __init__(self, raw, request, **kw):
91 self.raw = raw
92 self.request = request
93 self.form = request.form
94 self._ = request.getText
95 self.args = kw.get('format_args', '')
96
97 def format(self, formatter):
98 empty = u''
99 eol = u'\n'
100 rtn = u'\r'
101 glue = u'&&'
102 sep = u':: '
103 sep_dir = u'/'
104 space = u' '
105 monospace = u'` `'
106 macro_end = u')>>'
107 macro_esc = u')+>>'
108 ignore = u'#'
109 comment = u'##'
110 percent = u'%'
111 brk = u'<<BR>>'
112 parsing = (u"{{{", u"}}}", )
113 tab = u'||<tablestyle="width:100%; " '
114 cell = u'||<style="border:none; width:%(width)s%%; ">'
115 cella = u'||<%(align)s style="border:none; width:%(width)s%%; ">'
116 padcell = u'||<style="border:none; width:%(pad)s%%; ">'
117 celli = u'||'
118 cellf = u'||\n'
119 tbl = u'<<RenderText(%(tbl)s)>>'
120 cap = u'%(cap)s'
121 capc = u'<<RenderText(||<tablestyle="width:100%%; " style="border:none; ">%(cap)s ||)>>'
122 tfile = u'.txt'
123 warning_msg = u'||<style="color: #ff0000; font-weight: bold;">%s: %s||'
124 options, tables, rows, results = ([], [], [], [])
125 tbls, ignored, layout, padding = (0, 0, 0, 0, )
126 left, centre, right, void = (0, 1, 2, 3, )
127 top, mid, bot, ljust, cjust, rjust = (u'^', u'', u'v', u'(', u':', u')', )
128 max_cols = 1
129 std_width = 66
130 min_widths = (0, 25, 25, 25, )
131 max_widths = (0, 100, 50, 33, )
132 aligns = (mid, top, mid, mid, ) # TODO consider making this a selectable option
133 justs = (rjust, ljust, ljust, ljust, ) # leave centred (ie above) caption left justified
134 # for captions (left, centre, right, none,)
135 layouts = (cella+cap+cell+tbl, cell+capc+tbl, cell+tbl+cella+cap, cell+tbl, )
136
137 #set defaults which might get changed
138 cap_pos = centre
139 tbl_pos = centre
140 req_width = std_width
141
142 # set options
143 options = self.args.split(space)
144 if "c-none" in options:
145 cap_pos = void
146 if "c-right" in options: # do second as right takes precedence
147 cap_pos = right
148 if "c-left" in options: # do last as left takes precedence
149 cap_pos = left
150 if "c-3" in options:
151 max_cols = 3
152 if "c-2" in options: # do second as single column takes precedence
153 max_cols = 2
154 if "t-right" in options:
155 tbl_pos = right
156 if "t-left" in options: # do second as left takes precedence
157 tbl_pos = left
158 markup = "markup" in options
159 for option in options:
160 if option.endswith(percent):
161 try:
162 req_width = int(option.rstrip(percent)) # will check this value later
163 except:
164 pass
165 break # do not look for any more width options
166 del options
167 # check requested width in range or set default
168 if (req_width > max_widths[1]) or (req_width < min_widths[3]):
169 req_width = std_width
170 # dynamically set maximum columns depending on requested width
171 while (max_cols > 1) and (req_width > max_widths[max_cols]):
172 max_cols = max_cols - 1
173 # calculate widths for captions (left, centre, right)
174 widths = (int(req_width / 2), req_width, int(req_width / 2), req_width, )
175
176 def get_attachment(request, page_name, source):
177 if AttachFile.exists(request, page_name, source):
178 file_name = Page(request, page_name).getPagePath("attachments")
179 file_name = file_name+sep_dir+source
180 f = open(file_name,'r')
181 text = f.read()
182 f.close()
183 text = text.replace(rtn,empty)
184 if text == empty:
185 text = warning_msg % (source, 'attachment empty', )
186 else:
187 text = warning_msg % (source, 'not found', )
188 return text
189
190 def get_content(source):
191 content = []
192 page_name = self.request.page.page_name
193 abs_source = wikiutil.AbsPageName(page_name, source)
194 # is there a page?
195 if not Page(self.request, abs_source).isStandardPage(abs_source):
196 #try for an attachment instead
197 text = get_attachment(self.request, page_name, (source + tfile))
198 else:
199 if self.request.user.may.read(abs_source):
200 content = Page(self.request, abs_source)
201 text = content.getPageText()
202 if (content is None) or (text == empty):
203 text = warning_msg % (source, 'page empty', )
204 else:
205 text = warning_msg % (source, 'access denied', )
206 # crudely check that text conforms to table markup
207 text = text.strip()
208 lines = text.split(eol)
209 text = empty
210 for line in lines:
211 if line.startswith(comment):
212 continue
213 if (not line.startswith(celli)) or (not line.endswith(celli)):
214 text = warning_msg % (source, 'invalid table markup', )
215 break
216 text = text + line.strip() + glue
217 text = text.rstrip(glue)
218 text = text.replace(macro_end, macro_esc)
219 return text
220
221 # process the lines of text provided
222 lines = self.raw.split(eol)
223 for line in lines:
224 if line:
225 # handle table lines
226 if (line[0] == space) and (sep in line):
227 key, val = (line.lstrip(space)).split(sep)
228 val = val.replace(macro_end, macro_esc)
229 tables.append((key, val, get_content(key)))
230 if val.startswith(ignore):
231 ignored = ignored + 1
232 del lines
233
234 # construct a list of row column numbers
235 tbls = len(tables)
236 while tbls >= max_cols:
237 rows.append(max_cols)
238 tbls = tbls - max_cols
239 if tbls > 0:
240 rows.append(tbls)
241
242 # construct output for columns in rows
243 def calc_padding():
244 table_width = int(100 / max_cols) * max_cols
245 item_width = widths[cap_pos]
246 if (cap_pos in (left, right, )): # offset caption so double for image + caption
247 item_width = item_width * 2
248 if tbl_pos == centre: # centred so needs smaller interspersed padding
249 padding = int((table_width - (item_width * cols)) / (cols + 1))
250 else: # not centred so wider padding
251 padding = int(table_width - (item_width * cols))
252 return padding
253
254 def add_padding(seq):
255 yes_pad = False
256 if padding == 0:
257 return ''
258 if seq == 0:
259 yes_pad = (tbl_pos == right)
260 elif seq == 1:
261 yes_pad = (tbl_pos == centre) and \
262 ((cap_pos in (centre, void, )) or \
263 (first_col) or \
264 ((cap_pos == left) and (layout != void)))
265 elif seq == 2:
266 yes_pad = (tbl_pos == centre) and \
267 ((cols == 1) or \
268 ((cap_pos == right) and (layout != void)))
269 elif seq == 3:
270 yes_pad = (tbl_pos == left)
271
272 if yes_pad:
273 return (padcell % {'pad': padding})
274 else:
275 return ''
276
277 for cols in rows:
278 first_col = True
279 pending = ''
280 padding = calc_padding()
281 pending = pending + add_padding(0)
282 while cols > 0:
283 table = tables.pop(0)
284 if table[1].startswith(ignore):
285 layout = void
286 else:
287 layout = cap_pos
288 pending = pending + add_padding(1)
289 pending = pending + \
290 (layouts[layout] % {'align': aligns[cap_pos]+justs[cap_pos], \
291 'width': widths[cap_pos], \
292 'tbl': table[2], \
293 'cap': table[1]})
294 pending = pending + add_padding(2)
295 cols = cols - 1
296 first_col = False
297 pending = pending + add_padding(3)
298 pending = tab + pending[3:] + cellf # insert tablestyle and close table
299 results.append(pending)
300 del rows, tables
301
302 # escape markup if requested
303 if markup:
304 results.insert(0, parsing[0])
305 results.append(parsing[1])
306
307 wikiizer = wiki.Parser(eol.join(results), self.request)
308 wikiizer.format(formatter, inhibit_p=True)
You are not allowed to attach a file to this page.