Add option to automatically download documentation (#886)

Add option to automatically download documentation

Jasper van Merle committed 7 years ago

Commit 0f9ff402 parents 536003c 8aa8ae15 files · +13 −2Browse files

Unified · Split

5 files

assets/javascripts/app/app.coffee +4 −1
assets/javascripts/app/settings.coffee +1 −0
assets/javascripts/models/doc.coffee +3 −1
assets/javascripts/templates/pages/settings_tmpl.coffee +4 −0
assets/javascripts/views/content/settings_page.coffee +1 −0

assets/javascripts/app/app.coffee+4−1

@@ -140,7 +140,10 @@ · 139 unmodified lines
140	140	@docs.sort()
141	141	@initDoc(doc)
142	142	@saveDocs()
143		− _onSuccess()
	143	+ if app.settings.get('autoInstall')
	144	+ doc.install(_onSuccess, onError)
	145	+ else
	146	+ _onSuccess()
144	147	return
145	148
146	149	doc.load onSuccess, onError, writeCache: true

assets/javascripts/app/settings.coffee+1−0

@@ -11,6 +11,7 @@ class app.Settings · 10 unmodified lines
11	11	'layout'
12	12	'size'
13	13	'tips'
	14	+ 'autoInstall'
14	15	]
15	16
16	17	INTERNAL_KEYS = [

assets/javascripts/models/doc.coffee+3−1

@@ -142,4 +142,6 @@ class app.models.Doc extends app.Model · 141 unmodified lines
142	142	return
143	143
144	144	isOutdated: (status) ->
145		− status and status.installed and @mtime isnt status.mtime
	145	+ return false if not status
	146	+ isInstalled = status.installed or app.settings.get('autoInstall')
	147	+ isInstalled and @mtime isnt status.mtime

assets/javascripts/templates/pages/settings_tmpl.coffee+4−0

@@ -15,6 +15,10 @@ app.templates.settingsPage = (settings) -> """ · 14 unmodified lines
15	15	<input type="checkbox" form="settings" name="layout" value="_sidebar-hidden"#{if settings['_sidebar-hidden'] then ' checked' else ''}>Automatically hide and show the sidebar
16	16	<small>Tip: drag the edge of the sidebar to resize it.</small>
17	17	</label>
	18	+ <label class="_settings-label">
	19	+ <input type="checkbox" form="settings" name="autoInstall" value="_auto-install"#{if settings.autoInstall then ' checked' else ''}>Automatically download documentation for offline use
	20	+ <small>Only enable this when bandwidth isn't a concern to you.</small>
	21	+ </label>
18	22	<label class="_settings-label">
19	23	<input type="checkbox" form="settings" name="analyticsConsent"#{if settings.analyticsConsent then ' checked' else ''}>Enable tracking cookies
20	24	<small>With this checked, we enable Google Analytics and Gauges to collect anonymous traffic information.</small>

assets/javascripts/views/content/settings_page.coffee+1−0

@@ -14,6 +14,7 @@ class app.views.SettingsPage extends app.View · 13 unmodified lines
14	14	settings.dark = app.settings.get('dark')
15	15	settings.smoothScroll = !app.settings.get('fastScroll')
16	16	settings.arrowScroll = app.settings.get('arrowScroll')
	17	+ settings.autoInstall = app.settings.get('autoInstall')
17	18	settings.analyticsConsent = app.settings.get('analyticsConsent')
18	19	settings[layout] = app.settings.hasLayout(layout) for layout in app.settings.LAYOUTS
19	20	settings