Skip to content

Commit 6690400

Browse files
NyanHelsingfelliott
authored andcommitted
Add hypothes.is client to pdf renderer
* Add setting to enable/disable hypothesis in the pdf, defaulting to 'disable'. The corresponding envvar is named `PDF_EXTENSION_CONFIG_ENABLE_HYPOTHESIS`. Setting this to "1" will turn on the hypothesis sidebar for pdfs. Other file types are unaffected. * Move pdf.js menu button out from underneath the hypothesis toggle. [SVCS-645]
1 parent a9a381c commit 6690400

File tree

4 files changed

+28
-5
lines changed

4 files changed

+28
-5
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@ node_modules/
8888

8989
# Asynchronous HTTP
9090
######################
91-
/src/
91+
/src/

mfr/extensions/pdf/render.py

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,11 @@ def render(self):
2323
logger.debug('extension::{} supported-list::{}'.format(self.metadata.ext, settings.EXPORT_SUPPORTED))
2424
if self.metadata.ext not in settings.EXPORT_SUPPORTED:
2525
logger.debug('Extension not found in supported list!')
26-
return self.TEMPLATE.render(base=self.assets_url, url=download_url.geturl())
26+
return self.TEMPLATE.render(
27+
base=self.assets_url,
28+
url=download_url.geturl(),
29+
enable_hypothesis=settings.ENABLE_HYPOTHESIS
30+
)
2731

2832
logger.debug('Extension found in supported list!')
2933
exported_url = furl.furl(self.export_url)
@@ -35,9 +39,17 @@ def render(self):
3539
exported_url.args['format'] = settings.EXPORT_TYPE
3640

3741
self.metrics.add('needs_export', True)
38-
return self.TEMPLATE.render(base=self.assets_url, url=exported_url.url)
39-
40-
return self.TEMPLATE.render(base=self.assets_url, url=download_url.geturl())
42+
return self.TEMPLATE.render(
43+
base=self.assets_url,
44+
url=exported_url.url,
45+
enable_hypothesis=settings.ENABLE_HYPOTHESIS
46+
)
47+
48+
return self.TEMPLATE.render(
49+
base=self.assets_url,
50+
url=download_url.geturl(),
51+
enable_hypothesis=settings.ENABLE_HYPOTHESIS
52+
)
4153

4254
@property
4355
def file_required(self):

mfr/extensions/pdf/settings.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
EXPORT_TYPE = config.get('EXPORT_TYPE', 'pdf')
77
EXPORT_MAXIMUM_SIZE = config.get('EXPORT_MAXIMUM_SIZE', '1200x1200')
88

9+
ENABLE_HYPOTHESIS = config.get_bool('ENABLE_HYPOTHESIS', False)
10+
911
# supports multiple files in the form of a space separated string
1012
EXPORT_SUPPORTED = config.get('EXPORT_SUPPORTED', '.tiff .tif').split(' ')
1113
EXPORT_MAX_PAGES = int(config.get('EXPORT_MAX_PAGES', 40))

mfr/extensions/pdf/templates/viewer.mako

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ http://sourceforge.net/adobe/cmap/wiki/License/
3737

3838
<script src="debugger.js"></script>
3939
<script src="viewer.js"></script>
40+
% if enable_hypothesis:
41+
<script src="https://hypothes.is/embed.js"></script>
42+
<style>
43+
#toolbarViewer {
44+
position: relative;
45+
margin-right: 36px;
46+
}
47+
</style>
48+
% endif
4049
</head>
4150

4251
<body tabindex="1" class="loadingInProgress">

0 commit comments

Comments
 (0)