Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for the customization of Ledger Schedule #365

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add documentation for the customization of Ledger Schedule #365

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fbec14
Add information about the schedule file
boechat107 Aug 7, 2023
6d70cb9
Add a section for the Ledger Schedule customization variables
boechat107 Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 34 additions & 6 deletions doc/ledger-mode.texi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -864,10 +864,11 @@ are not reflected in the actual data file. Many transactions are very
repetitive, but may vary slightly in the date they occur on, or the
amount. Some transactions are weekly, monthly, quarterly or annually.
Ledger mode provides a way to schedule upcoming transaction with a
flexible scheduler that allows you to specify the transactions in a
separate ledger file and calculate the upcoming occurrences of those
transactions. You can then copy the transactions into your live data
file.
flexible scheduler that allows you to specify the transactions in a separate
ledger file (the file @file{~/ledger-schedule.ledger} by default, or set a
different value for @option{ledger-schedule-file}) and calculate the upcoming
occurrences of those transactions. You can then copy the transactions into your
live data file.

@menu
* Specifying Upcoming Transactions::
Expand Down Expand Up @@ -961,6 +962,7 @@ for Ledger under the data options. Alternatively you can choose
* Ledger Customization Group::
* Ledger Reconcile Customization Group::
* Ledger Report Customization Group::
* Ledger Schedule Customization Group::
* Ledger Faces Customization Group::
* Ledger Post Customization Group::
* Ledger Exec Customization Group::
Expand Down Expand Up @@ -1055,7 +1057,7 @@ If t, will force closing reconcile window after @kbd{C-c C-c}.

@end ftable

@node Ledger Report Customization Group, Ledger Faces Customization Group, Ledger Reconcile Customization Group, Customization Variables
@node Ledger Report Customization Group, Ledger Schedule Customization Group, Ledger Reconcile Customization Group, Customization Variables
@subsection Ledger Report Customization Group
@cindex customization, report

Expand All @@ -1077,7 +1079,33 @@ Whether reports should fill the whole width of the @file{*Report*} window

@end ftable

@node Ledger Faces Customization Group, Ledger Post Customization Group, Ledger Report Customization Group, Customization Variables
@node Ledger Schedule Customization Group, Ledger Faces Customization Group, Ledger Report Customization Group, Customization Variables
@subsection Ledger Schedule Customization Group
@cindex customization, schedule

@ftable @option

@item ledger-schedule
Support for automatically recommendation transactions.

@item ledger-schedule-buffer-name
Name of the schedule buffer. Defaults to @file{*Ledger Schedule*}.

@item ledger-schedule-file
File to find scheduled transactions. Defaults to @file{~/ledger-schedule.ledger}.

@item ledger-schedule-look-backward
Number of days to look back in time for transactions. Defaults to @samp{7}.

@item ledger-schedule-look-forward
Number of days auto look forward to recommend transactions. Defaults to @samp{14}.

@item ledger-schedule-week-days
List of weekday abbreviations.

@end ftable

@node Ledger Faces Customization Group, Ledger Post Customization Group, Ledger Schedule Customization Group, Customization Variables
@subsection Ledger Faces Customization Group
@cindex customization, faces

Expand Down