Attachment 'figures-1.6.py'
Download 1 #-*- coding: utf-8 -*-
2 '''
3 MoinMoin - figures parser, Version 1.6, 15.10.2012
4
5 A simple parser that reads key:value pairs from a listing of figures (attachments) and captions then formats these for display in tables. Defaults to three column table with captions below centred figures (centred if less than three in the row). If more than three key:value pairs are provided, additional rows are added to the table. The user can set options to (1) force a single or double column table, (2) place captions to the left or right of the figures, (3) set figures left or right justified, (4) give figures a width other than the default of 33% (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. The number of columns is set dynamically, if specified widths are two wide for 3 columns (ie if 34-50% then two columns forced and if >50% a single column is forced).
6
7 The key:value list must be in the form " figure_file:: caption" with a leading space (as moin dictionary entries). All non-conforming lines are ignored without warning.
8
9 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.
10
11 Keywords
12
13 anchors : Create anchors from the captions, if they contain 'Fig. nnn', 'Figure nnn' or 'Plate nnn', where n is any digit. Any bold or italic emphasis markup is removed from the caption first. The anchors are placed before all figures in in a horizontal group.
14
15 c-1 : forces single column only. Overides c-2, if both options given, as single column takes precedence.
16
17 c-2 : forces double column only, if the requested width 50% or less. Default is three columns, so no col-3 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 f-left : figures set left. Overides f-right, if both options given, as left takes precedence.
26
27 f-right : figures set right.
28
29 nnn% : requested width of figure (including caption if set to left or right), where n is digits from 25 to 100. If outside this range, the default 33% 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). The value is checked and if 34-50% two columns are forced, and if >50% then a single column is forced.
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 optional 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 figures and remaining captions will increase in size proportionally. Values set by the nnn% argument therefore become nominal only.
34
35 Defaults are caption and figure centred, width 33%, three columns (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 Usage
40
41 {{{#!figures [anchors ][c-1|c-2 ][c-left|c-none|c-right ][f-left|f-right ][nnn% ][markup ]
42 figure_file:: [#]caption
43 figure_file:: [#]caption
44 ...
45 }}}
46
47 History
48
49 Version 1.6 - 15.10.2012: included automatic anchor insertion
50 Version 1.5 - 14.10.2012: included time dependency to properly handle Ref macro in captions
51 Version 1.4 - 22.01.2011: fixed dynamic column allocation; minor edits
52 Version 1.3 - 15.01.2011: fixed the wiki formatting by setting inhibit_p to True.
53 Version 1.2 - 13.01.2011: allowed for caption to overridden; right justified left positioned captions; other minor fixes
54 Version 1.1 - 11.01.2011: reverted to Python 2.5 string formatting
55 Version 1.0 - 11.01.2011: initial version
56
57 Developed with inspiration and code from:
58
59 keyval.py parser - @copyright: 2006 by Matt Cooper <macooper@vt.edu>
60 sort.py parser - @copyright: 2005 ReimarBauer
61
62 Copyright
63
64 @copyright: 2012 Ian Riley <ian.riley@internode.on.net>
65
66 License
67
68 GNU GPL, see COPYING for details.
69 '''
70
71 import re
72 from MoinMoin.parser import text_moin_wiki as wiki
73 from MoinMoin import wikiutil
74
75 Dependencies = ["time"] # for captions with <<Ref()>>, which uses <<FootNote()>>, so no caching
76
77 class Parser:
78 parsername = 'figures'
79
80 def __init__(self, raw, request, **kw):
81 self.raw = raw
82 self.request = request
83 self.form = request.form
84 self._ = request.getText
85 self.args = kw.get('format_args', '')
86
87 def format(self, formatter):
88 eol = u'\n'
89 sep = u':: '
90 space = u' '
91 ignore = u'#'
92 percent = u'%'
93 brk = u'<<BR>>'
94 parsing = (u"{{{", u"}}}", )
95 anchor = u'<<Anchor(%(anchorname)s)>>'
96 anchor_pattern = u'(Fig[.]? \d+|Figure \d+|Plate \d+)'
97 tab = u'||<tablestyle="width:100%; " '
98 cell = u'||<%(align)s style="border:none; width:%(width)s%%; ">'
99 padcell = u'||<style="border:none; width:%(pad)s%%; ">'
100 cellf = u'||\n'
101 att = u'{{attachment:%(att)s||width=100%%}}'
102 cap = u'%(cap)s'
103 options, figures, anchornames, rows, results = ([], [], [], [], [], )
104 figs, ignored, layout, padding = (0, 0, 0, 0, )
105 left, centre, right, void = (0, 1, 2, 3, )
106 top, mid, bot, ljust, cjust, rjust = (u'^', u'', u'v', u'(', u':', u')', )
107 max_cols = 3
108 std_width = 33
109 min_widths = (0, 25, 25, 25, )
110 max_widths = (0, 100, 50, 33, )
111 aligns = (mid, top, mid, mid, ) # TODO consider making this a selectable option
112 justs = (rjust, ljust, ljust, ljust, ) # leave centred (ie underneath) caption left justified
113 # for captions (left, centre, right, none,)
114 layouts = (cell+cap+cell+att, cell+att+brk+cap, cell+att+cell+cap, cell+att, )
115
116 # TODO add a 4 column option min and max of 25%
117
118 #set defaults which might get changed
119 cap_pos = centre
120 fig_pos = centre
121 req_width = std_width
122
123 # set options
124 options = self.args.split(space)
125 anchors = "anchors" in options
126 if "c-none" in options:
127 cap_pos = void
128 if "c-right" in options: # do second as right takes precedence
129 cap_pos = right
130 if "c-left" in options: # do last as left takes precedence
131 cap_pos = left
132 if "c-2" in options:
133 max_cols = 2
134 if "c-1" in options: # do second as single column takes precedence
135 max_cols = 1
136 if "f-right" in options:
137 fig_pos = right
138 if "f-left" in options: # do second as left takes precedence
139 fig_pos = left
140 markup = "markup" in options
141 for option in options:
142 if option.endswith(percent):
143 try:
144 req_width = int(option.rstrip(percent)) # will check this value later
145 except:
146 pass
147 break # do not look for any more width options
148 del options
149 # check requested width in range or set default
150 if (req_width > max_widths[1]) or (req_width < min_widths[3]):
151 req_width = std_width
152 # dynamically set maximum columns depending on requested width
153 while (max_cols > 1) and (req_width > max_widths[max_cols]):
154 max_cols = max_cols - 1
155 # calculate widths for captions (left, centre, right)
156 widths = (int(req_width / 2), req_width, int(req_width / 2), req_width, )
157
158 def get_anchorname(val):
159 match = None
160 if anchors:
161 match = re.match(anchor_pattern, val.replace("'","")).group()
162 return match
163
164 # process the lines of text provided
165 lines = self.raw.split(eol)
166 for line in lines:
167 if line:
168 # handle figure lines
169 if (line[0] == space) and (sep in line):
170 key, val = (line.lstrip(space)).split(sep)
171 figures.append((key, val, ))
172 anchornames.append(get_anchorname(val))
173 #if val.startswith(ignore): #TODO check if really not needed
174 # ignored = ignored + 1
175 del lines
176
177 # construct a list of row column numbers
178 figs = len(figures)
179 while figs >= max_cols:
180 rows.append(max_cols)
181 figs = figs - max_cols
182 if figs > 0:
183 rows.append(figs)
184
185 # construct output for columns in rows
186 def calc_padding():
187 table_width = int(100 / max_cols) * max_cols
188 item_width = widths[cap_pos]
189 if (cap_pos in (left, right, )): # offset caption so double for image + caption
190 item_width = item_width * 2
191 if fig_pos == centre: # centred so needs smaller interspersed padding
192 padding = int((table_width - (item_width * cols)) / (cols + 1))
193 else: # not centred so wider padding
194 padding = int(table_width - (item_width * cols))
195 return padding
196
197 def add_padding(seq):
198 yes_pad = False
199 if padding == 0:
200 return ''
201 if seq == 0:
202 yes_pad = (fig_pos == right)
203 elif seq == 1:
204 yes_pad = (fig_pos == centre) and \
205 ((cap_pos in (centre, void, )) or \
206 (first_col) or \
207 ((cap_pos == left) and (layout != void)))
208 elif seq == 2:
209 yes_pad = (fig_pos == centre) and \
210 ((cols == 1) or \
211 ((cap_pos == right) and (layout != void)))
212 elif seq == 3:
213 yes_pad = (fig_pos == left)
214
215 if yes_pad:
216 return (padcell % {'pad': padding})
217 else:
218 return ''
219
220 for cols in rows:
221 first_col = True
222 pending = ''
223 anchors_pending = ''
224 padding = calc_padding()
225 pending = pending + add_padding(0)
226 while cols > 0:
227 figure = figures.pop(0)
228 if anchors:
229 anchorname = anchornames.pop(0)
230 if anchorname:
231 anchors_pending += (anchor % {'anchorname': anchorname, })
232 if figure[1].startswith(ignore):
233 layout = void
234 else:
235 layout = cap_pos
236 pending = pending + add_padding(1)
237 pending = pending + \
238 (layouts[layout] % {'align': aligns[cap_pos]+justs[cap_pos], \
239 'width': widths[cap_pos], \
240 'att': figure[0], \
241 'cap': figure[1]})
242 pending = pending + add_padding(2)
243 cols = cols - 1
244 first_col = False
245 pending = pending + add_padding(3)
246 pending = tab + pending[3:] + cellf # insert tablestyle and close table
247 if anchors:
248 results.append(anchors_pending)
249 results.append(pending)
250
251 del rows, figures
252
253 # escape markup if requested
254 if markup:
255 results.insert(0, parsing[0])
256 results.append(parsing[1])
257
258 wikiizer = wiki.Parser(eol.join(results), self.request)
259 wikiizer.format(formatter, inhibit_p=True)
You are not allowed to attach a file to this page.