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

tools/pandoc-{site,drop-toc}, Shake, site/, doc/: switch from bulletlist to metainline toc marker

Browse Source 
Files `site/doc/{1.0,1.1}/hledger-ui.md` had to be treated specially because
thay had some other elements inside the same `BulletList` that the `toc` lived
inside. Because only the first element of the `BulletList` is compared, these
extra HTML elements were either dropped or replaced with a TOC at compile time.
By switching to the meta-inline `\$toc\$`, they started to persist into the
resulting HTML. The fix was to drop them from the source markdown.
This commit is contained in:
Everett Hildenbrandt 2018-05-10 22:01:25 -06:00 committed by Simon Michael
parent ae987b236b
commit 946fa1d498
70 changed files with 75 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Shake.hs
View File

@ -267,7 +267,7 @@ main = do
webmanall %> \out -> do webmanall %> \out -> do
need webmanpages need webmanpages
liftIO $ writeFile webmanall "* toc\n\n" -- # Big Manual\n\n -- TOC style is better without main heading, liftIO $ writeFile webmanall "\\$toc\\$" -- # Big Manual\n\n -- TOC style is better without main heading,
forM_ webmanpages $ \f -> do -- site/hledger.md, site/journal.md forM_ webmanpages $ \f -> do -- site/hledger.md, site/journal.md
cmd Shell ("printf '\\n\\n' >>") webmanall :: Action ExitCode cmd Shell ("printf '\\n\\n' >>") webmanall :: Action ExitCode
cmd Shell "pandoc" f "-t markdown-fenced_divs --atx-headers" cmd Shell "pandoc" f "-t markdown-fenced_divs --atx-headers"

2
doc/lib.m4
View File

@ -31,7 +31,7 @@ m4_dnl | <a href="/doc/0.27/manual.html#$1">0.27</a>
</span>)m4_dnl </span>)m4_dnl
m4_dnl m4_dnl
m4_define({{_toc_}},{{ m4_define({{_toc_}},{{
* toc \$toc\$
}})m4_dnl }})m4_dnl
m4_dnl m4_dnl
m4_dnl _table_({{ m4_dnl _table_({{

2
doc/manpage.html
View File

@ -10,7 +10,7 @@ $include-before$
$endfor$ $endfor$
--> -->
<!-- * toc --> <!-- $toc$ -->
$body$ $body$

2
site/doc/0.27/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.0/csv.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.0/hledger-api.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

15
site/doc/1.0/hledger-ui.md
View File

@ -2,20 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
<style>
.highslide img {max-width:250px; float:right; margin:0 0 1em 1em;}
.highslide-caption {color:white; background-color:black;}
</style>
<a href="images/hledger-ui/hledger-ui-sample-acc2.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc2.png" title="Accounts screen with query and depth limit" /></a>
<a href="images/hledger-ui/hledger-ui-sample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc.png" title="Accounts screen" /></a>
<a href="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" title="Accounts screen with greenterm theme" /></a>
<a href="images/hledger-ui/hledger-ui-sample-txn.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-txn.png" title="Transaction screen" /></a>
<a href="images/hledger-ui/hledger-ui-sample-reg.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-reg.png" title="Register screen" /></a>
<!-- <br clear=all> -->
<a href="images/hledger-ui/hledger-ui-bcexample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc.png" title="beancount example accounts" /></a>
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" title="beancount example's etrade cash subaccount" /></a>
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" title="beancount example's etrade investments, all commoditiess" /></a>
## NAME ## NAME

2
site/doc/1.0/hledger-web.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.0/hledger.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.0/journal.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.0/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.0/timeclock.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.0/timedot.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.0**. <span class="docversions"></span> This doc is for version **1.0**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.1/csv.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.1/hledger-api.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

15
site/doc/1.1/hledger-ui.md
View File

@ -2,20 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
<style>
.highslide img {max-width:250px; float:right; margin:0 0 1em 1em;}
.highslide-caption {color:white; background-color:black;}
</style>
<a href="images/hledger-ui/hledger-ui-sample-acc2.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc2.png" title="Accounts screen with query and depth limit" /></a>
<a href="images/hledger-ui/hledger-ui-sample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc.png" title="Accounts screen" /></a>
<a href="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-acc-greenterm.png" title="Accounts screen with greenterm theme" /></a>
<a href="images/hledger-ui/hledger-ui-sample-txn.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-txn.png" title="Transaction screen" /></a>
<a href="images/hledger-ui/hledger-ui-sample-reg.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-sample-reg.png" title="Register screen" /></a>
<!-- <br clear=all> -->
<a href="images/hledger-ui/hledger-ui-bcexample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc.png" title="beancount example accounts" /></a>
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" title="beancount example's etrade cash subaccount" /></a>
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" title="beancount example's etrade investments, all commoditiess" /></a>
## NAME ## NAME

2
site/doc/1.1/hledger-web.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.1/hledger.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.1/journal.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.1/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.1/timeclock.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.1/timedot.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.1**. <span class="docversions"></span> This doc is for version **1.1**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/csv.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/hledger-api.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/hledger-ui.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/hledger-web.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/hledger.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/journal.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.2/timeclock.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.2/timedot.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.2**. []{.docversions} This doc is for version **1.2**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/csv.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/hledger-api.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/hledger-ui.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/hledger-web.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/hledger.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/journal.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.3/timeclock.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.3/timedot.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.3**. []{.docversions} This doc is for version **1.3**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/csv.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/hledger-api.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/hledger-ui.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/hledger-web.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/hledger.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/journal.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.4/timeclock.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.4/timedot.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.4**. <span class="docversions"></span> This doc is for version **1.4**. <span class="docversions"></span>
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/csv.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/hledger-api.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/hledger-ui.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/hledger-web.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/hledger.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/journal.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.5/timeclock.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.5/timedot.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.5**. []{.docversions} This doc is for version **1.5**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/csv.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/hledger-api.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/hledger-ui.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/hledger-web.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/hledger.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/journal.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/manual.md
View File

@ -1,4 +1,4 @@
* toc \$toc\$

2
site/doc/1.9/timeclock.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/doc/1.9/timedot.md
View File

@ -2,7 +2,7 @@
This doc is for version **1.9 (dev)**. []{.docversions} This doc is for version **1.9 (dev)**. []{.docversions}
- toc \$toc\$
## NAME ## NAME

2
site/download.md
View File

@ -1,4 +1,4 @@
- toc \$toc\$
# Download # Download

20
tools/pandoc-drop-toc.lua
View File

@ -1,16 +1,6 @@
function keepBi(bi) function Para(p)
if not (bi[1].t == "Plain") then return true end if not p.content[1] then return p end
if not (bi[1].content[1].t == "Str") then return true end if not (p.content[1].t == "Str") then return p end
if not (string.find(bi[1].content[1].text, "toc") == 1) then return true end if not (p.content[1].text == "$toc$") then return p end
return false return pandoc.Null()
end
function BulletList(bl)
local newBl = { }
for i,bi in pairs(bl.content) do
if keepBi(bi)
then table.insert(newBl, bi)
end
end
return pandoc.BulletList(newBl)
end end

5
tools/pandoc-site.hs
View File

@ -65,9 +65,8 @@ createTable alignment headers
in RawBlock "html" (navBegin ++ "\n" ++ tocString ++ "\n" ++ navEnd) in RawBlock "html" (navBegin ++ "\n" ++ tocString ++ "\n" ++ navEnd)
generateTOC :: Block -> Block -> Block generateTOC :: Block -> Block -> Block
generateTOC toc (BulletList (( (( Plain ((Str "toc"):_)):_)):_)) generateTOC toc (Para [Str "$toc$"]) = toc
= toc generateTOC _ x = x
generateTOC _ x = x
tableOfContents :: TOCAlignment -> Pandoc -> Pandoc tableOfContents :: TOCAlignment -> Pandoc -> Pandoc
tableOfContents TOCOff ast = walk ignoreTOC ast tableOfContents TOCOff ast = walk ignoreTOC ast