slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: better doc version indicator, on 0.27 manual too #385, #387

Browse Source
This commit is contained in:
Simon Michael 2016-08-07 08:28:47 -07:00
parent fdd1378b4e
commit 1a29d9cc02
5 changed files with 30 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Shake.hs
View File

@ -244,7 +244,9 @@ main = do
phony "releasemanual0.27" $ do phony "releasemanual0.27" $ do
-- XXX under doc so hakyll-std will render it -- XXX under doc so hakyll-std will render it
cmd "mkdir -p site/doc/0.27" :: Action ExitCode cmd "mkdir -p site/doc/0.27" :: Action ExitCode
cmd Shell "git show 0.27:doc/manual.md >site/doc/0.27/manual.md" cmd Shell "git show 0.27:doc/manual.md >site/doc/0.27/manual.md" :: Action ExitCode
cmd Shell "patch site/doc/0.27/manual.md doc/manual0.27.diff "
-- build standard hakyll script used for site rendering -- build standard hakyll script used for site rendering
hakyllstd %> \out -> do hakyllstd %> \out -> do

12
doc/lib.m4
View File

@ -10,11 +10,17 @@ m4_define({{_author_}}, {{}})m4_dnl
m4_define({{_monthyear_}}, {{May 2016}})m4_dnl m4_define({{_monthyear_}}, {{May 2016}})m4_dnl
m4_define({{_currentrelease_}}, {{0.27}})m4_dnl m4_define({{_currentrelease_}}, {{0.27}})m4_dnl
m4_define({{_version_}}, {{0.28}})m4_dnl m4_define({{_version_}}, {{0.28}})m4_dnl
m4_dnl
m4_dnl Links to dev and recent release versions of a manual.
m4_dnl $1 is the manual's web slug: hledger, hledger-ui, journal, csv etc.
m4_dnl The current version is hidden (or whatever) by highlightDocVersion in site.js.
m4_dnl
m4_define({{_versions_}}, m4_define({{_versions_}},
<div class="versions"> <div class="versions">
version: This doc is for version **_version_**.
<a href="$1.html">dev</a> Other versions:
| <a href="doc/_currentrelease_()/manual.html{{#}}m4_patsubst($1,{{hledger-}})">_currentrelease_()</a> <a href="$1.html">_version_</a>
| <a href="doc/_currentrelease_()/manual.html{{#}}$1">_currentrelease_()</a>
</div>)m4_dnl </div>)m4_dnl
m4_dnl m4_dnl
m4_define({{_toc_}}, {{* toc}})m4_dnl m4_define({{_toc_}}, {{* toc}})m4_dnl

15
doc/manual0.27.diff Normal file
View File

@ -0,0 +1,15 @@
4a5,12
> <div class="versions">
> This doc is for version **0.27**.
> Other versions:
> <a href="manual.html">0.28dev</a>
> </div>
>
> <a name="hledger" />
>
2198a2207,2208
> <a name="hledger-ui" />
>
2316a2327,2328
>
> <a name="hledger-web" />

6
hledger-api/doc/hledger-api.1.m4.md
View File

@ -3,11 +3,7 @@
% _monthyear_ % _monthyear_
_web_({{ _web_({{
m4_dnl _versions_({{hledger-api}}) _versions_({{hledger-api}})
<div class="versions">
version:
<a href="$1.html">dev</a>
</div>
_toc_ _toc_
}}) }})

3
site/js/site.js
View File

@ -6,7 +6,7 @@ function highlightDocVersion() {
$('.versions').each( function() { $('.versions').each( function() {
var parts = window.location.pathname.split('/'); var parts = window.location.pathname.split('/');
var dir = parts.length > 1 ? parts[parts.length-2] : ''; var dir = parts.length > 1 ? parts[parts.length-2] : '';
var ver = $.isNumeric(dir) ? dir : 'dev'; var ver = $.isNumeric(dir) ? dir : '0.28';
$(this).find('a').each( function() { $(this).find('a').each( function() {
if ($(this).html() == ver) if ($(this).html() == ver)
$(this) $(this)
@ -14,6 +14,7 @@ function highlightDocVersion() {
.css('text-decoration', 'none') .css('text-decoration', 'none')
.css('color', 'initial') .css('color', 'initial')
// .css('font-weight','bold'); // .css('font-weight','bold');
.hide()
}); });
}); });
} }