1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
# This file is part of the Frescobaldi project, http://www.frescobaldi.org/
#
# Copyright (c) 2008 - 2014 by Wilbert Berendsen
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# See http://www.gnu.org/licenses/ for more information.
"""
Utility functions for the user guide.
"""
import re
import app
import simplemarkdown
from .page import Page
class Formatter(object):
"""Format a full userguide page HTML."""
def html(self, name):
"""Return a full userguide page HTML."""
page = Page(name)
from appinfo import appname, version
parents = cache.parents(name) if name != 'index' else []
children = cache.children(name)
qt_detail = '<qt type=detail>' if page.is_popup() else ''
title = page.title()
nav_up = ''
if parents and not page.is_popup():
pp = parents
links = []
while pp:
p = pp[0]
links.append(p)
pp = cache.parents(p)
nav_up = '<p>{0} {1}</p>'.format(
_("Up:"),
' → '.join(map(self.format_link, reversed(links))))
body = self.markexternal(page.body())
nav_children, nav_next, nav_seealso = '', '', ''
if children:
nav_children = '<p>{0}</p>\n<ul>{1}</ul>'.format(
_("In this chapter:"),
'\n'.join('<li>{0}</li>'.format(self.format_link(c))
for c in children))
else:
# add navigation to next page, or if last page, to next page in
# the first parent document that has a next page.
html = []
def sibling(parent, name):
"""Return the next sibling page name."""
c = cache.children(parent)
i = c.index(name)
if i < len(c) - 1:
return c[i+1]
for p in parents:
next_page = sibling(p, name)
if next_page:
html.append('<div>{0} {1}</div>'.format(
_("Next:"), self.format_link(next_page)))
else:
pp = [(parent, p) for parent in cache.parents(p)]
while pp:
p1, p = pp.pop(0)
next_chapter = sibling(p1, p)
if next_chapter:
html.append('<div>{0} {1}</div>'.format(
_("Next Chapter:"), self.format_link(next_chapter)))
else:
pp.extend((parent, p1) for parent in cache.parents(p1))
nav_next = '\n'.join(html)
if page.seealso():
nav_seealso = "<p>{0} {1}</p>".format(
_("See also:"),
', '.join(map(self.format_link, page.seealso())))
return self._html_template().format(**locals())
def format_link(self, name):
"""Make a clickable link to the page."""
return format_link(name)
def markexternal(self, text):
"""Marks http(s)/ftp(s) links as external with an arrow."""
return markexternal(text)
def _html_template(self):
"""Return the userguide html template to render the html().
The default implementation returns _userguide_html_template.
"""
return _userguide_html_template
def format_link(name):
"""Make a clickable link to the page."""
title = simplemarkdown.html_escape(cache.title(name))
return '<a href="{0}">{1}</a>'.format(name, title)
def markexternal(text):
"""Marks http(s)/ftp(s) links as external with an arrow."""
pat = re.compile(r'''<a\s+.*?href\s*=\s*(['"])(ht|f)tps?.*?\1[^>]*>''', re.I)
return pat.sub(r'\g<0>⬀', text)
_userguide_html_template = '''\
{qt_detail}<html>
<head>
<style type="text/css">
body {{
margin: 10px;
}}
</style>
<title>{title}</title>
</head>
<body>
{nav_up}
{body}
{nav_children}
{nav_next}
{nav_seealso}
<br/><hr width=80%/>
<address><center>{appname} {version}</center></address>
</body>
</html>
'''
class Cache(object):
"""Cache certain information about pages.
Just one instance of this is created and put in the cache global.
"""
def __init__(self):
self._title = {}
self._children = {}
app.languageChanged.connect(lambda: self._title.clear(), -999)
def title(self, name):
"""Return the title of the named page."""
try:
t = self._title[name]
except KeyError:
t = self._title[name] = Page(name).title()
return t
def children(self, name):
"""Return the list of children of the named page."""
try:
c = self._children[name]
except KeyError:
c = self._children[name] = Page(name).children()
return c
def parents(self, name):
"""Return the list of parents (zero or more) of the named page."""
try:
self._parents
except AttributeError:
self._parents = {}
self._compute_parents()
try:
return self._parents[name]
except KeyError:
return []
def _compute_parents(self):
def _compute(n1):
for n in self.children(n1):
self._parents.setdefault(n, []).append(n1)
_compute(n)
_compute('index')
# one global Cache instance
cache = Cache()
|
