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

;doc: manuals: hide NAME/SYNOPSIS/DESCRIPTION headings in web manuals

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2020-01-25 16:57:51 -08:00
parent a6ec6b40da
commit 444c4342ed
8 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Shake.hs
View File

@ -351,7 +351,7 @@ main = do
,""
]
cmd Shell
"m4 -P -DMAN -DWEB -I" dir commonm4 packagem4 src "|"
"m4 -P -DWEB -I" dir commonm4 packagem4 src "|"
pandoc fromsrcmd towebmd
"--lua-filter tools/pandoc-demote-headers.lua"
">>" out

7
hledger-lib/hledger_csv.m4.md
View File

@ -5,14 +5,15 @@
_web_({{
_docversionlinks_({{csv}})
}})
_man_({{
_man_({{
# NAME
}})
CSV - how hledger reads CSV data, and the CSV rules file format
_man_({{
# DESCRIPTION
}})
hledger can read
@ -861,5 +862,3 @@ This is all part of the CSV reader, one of several readers hledger can
use to parse input files. When all files have been read successfully,
the transactions are passed as input to whichever hledger command the
user specified.

5
hledger-lib/hledger_journal.m4.md
View File

@ -5,14 +5,15 @@
_web_({{
_docversionlinks_({{journal}})
}})
_man_({{
_man_({{
# NAME
}})
Journal - hledger's default file format, representing a General Journal
_man_({{
# DESCRIPTION
}})
hledger's usual data source is a plain text file containing journal entries in hledger journal format.

5
hledger-lib/hledger_timeclock.m4.md
View File

@ -5,14 +5,15 @@
_web_({{
_docversionlinks_({{timeclock}})
}})
_man_({{
_man_({{
# NAME
}})
Timeclock - the time logging format of timeclock.el, as read by hledger
_man_({{
# DESCRIPTION
}})
hledger can read timeclock files.

5
hledger-lib/hledger_timedot.m4.md
View File

@ -5,14 +5,15 @@
_web_({{
_docversionlinks_({{timedot}})
}})
_man_({{
_man_({{
# NAME
}})
Timedot - hledger's human-friendly time logging format
_man_({{
# DESCRIPTION
}})
Timedot is a plain text format for logging dated, categorised quantities (of time, usually), supported by hledger.

11
hledger-ui/hledger-ui.m4.md
View File

@ -8,18 +8,22 @@ _docversionlinks_({{hledger-ui}})
_man_({{
# NAME
}})
hledger-ui - terminal interface for the hledger accounting tool
_man_({{
# SYNOPSIS
}})
`hledger-ui [OPTIONS] [QUERYARGS]`\
`hledger ui -- [OPTIONS] [QUERYARGS]`
_man_({{
# DESCRIPTION
}})
_hledgerdescription_
}})
_web_({{
<style>
@ -296,7 +300,7 @@ when you press g to reload. Once you have fixed the problem,
press g again to reload and resume normal operation.
(Or, you can press escape to cancel the reload attempt.)
_man_({{
# ENVIRONMENT
**COLUMNS**
@ -331,6 +335,3 @@ until the program is restarted.
Also, if you are viewing files mounted from another machine, `--watch`
requires that both machine clocks are roughly in step.
}})

10
hledger-web/hledger-web.m4.md
View File

@ -8,18 +8,22 @@ _docversionlinks_({{hledger-web}})
_man_({{
# NAME
}})
hledger-web - web interface for the hledger accounting tool
_man_({{
# SYNOPSIS
}})
`hledger-web [OPTIONS]`\
`hledger web -- [OPTIONS]`
_man_({{
# DESCRIPTION
}})
_hledgerdescription_
}})
_web_({{
<style>
@ -241,8 +245,6 @@ $ curl -s http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' -
By default, both the server-side HTML UI and the JSON API are served.
Running with `--serve-api` disables the former, useful if you only want to serve the API.
_man_({{
# ENVIRONMENT
_LEDGER_FILE_
@ -262,5 +264,3 @@ Query arguments and some hledger options are ignored.
Does not work in text-mode browsers.
Does not work well on small screens.
}})

10
hledger/hledger.m4.md
View File

@ -16,21 +16,24 @@ _docversionlinks_({{hledger}})
}})
_man_({{
# NAME
}})
hledger - a command-line accounting tool
_man_({{
# SYNOPSIS
}})
`hledger [-f FILE] COMMAND [OPTIONS] [ARGS]`\
`hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]`\
`hledger`
_man_({{
# DESCRIPTION
}})
_hledgerdescription_
}})
This is hledger’s command-line interface (there are also terminal and web
interfaces). Its basic function is to read a plain text file describing
@ -70,7 +73,6 @@ _include_(hledger_examples.m4.md)
_include_(hledger_options.m4.md)
_include_(hledger_queries.m4.md)
_include_(hledger_commands.m4.md)
_man_({{
# ENVIRONMENT
@ -103,5 +105,3 @@ Not all of Ledger's journal file syntax is supported. See [file format differenc
On large data files, hledger is slower and uses more memory than Ledger.
_include_(hledger_troubleshooting.m4.md)
}})