Source code Contents Index

Hledger.Cli.Commands.Web

Description

A web-based UI.

Synopsis

data HledgerWebApp = HledgerWebApp { appRoot :: String appDir :: FilePath appOpts :: [Opt] appArgs :: [String] appJournal :: Journal appStatic :: Static } data HledgerWebAppRoute = StaticR (Route Static) | IndexR | JournalOnlyR | RegisterOnlyR | AccountsOnlyR | JournalR | RegisterR data TemplateData = TD { here :: HledgerWebAppRoute title :: String msg :: Maybe (Html ()) a :: String p :: String j :: Journal today :: Day } web :: [Opt] -> [String] -> Journal -> IO () browser :: String -> IO () server :: String -> Int -> [Opt] -> [String] -> Journal -> IO () getHandlerParameters :: Handler HledgerWebApp (String, String, [Opt], FilterSpec, Journal, Maybe (Html ()), HledgerWebAppRoute) getIndexR :: Handler HledgerWebApp () getJournalR :: Handler HledgerWebApp RepHtml postJournalR :: Handler HledgerWebApp RepPlain getRegisterR :: Handler HledgerWebApp RepHtml postRegisterR :: Handler HledgerWebApp RepPlain getAccountsOnlyR :: Handler HledgerWebApp RepHtml balanceReportAsHtml :: [Opt] -> TemplateData -> BalanceReport -> Hamlet HledgerWebAppRoute accountNameToAccountRegex :: String -> String accountRegexToAccountName :: String -> String isAccountRegex :: String -> Bool getJournalOnlyR :: Handler HledgerWebApp RepHtml journalReportAsHtml :: [Opt] -> TemplateData -> JournalReport -> Hamlet HledgerWebAppRoute addform :: TemplateData -> Hamlet HledgerWebAppRoute postingsfields :: TemplateData -> Hamlet HledgerWebAppRoute postingfields :: TemplateData -> Int -> Hamlet HledgerWebAppRoute editform :: TemplateData -> String -> Hamlet HledgerWebAppRoute importform :: Hamlet HledgerWebAppRoute postJournalOnlyR :: Handler HledgerWebApp RepPlain postAddForm :: Handler HledgerWebApp RepPlain postEditForm :: Handler HledgerWebApp RepPlain postImportForm :: Handler HledgerWebApp RepPlain getRegisterOnlyR :: Handler HledgerWebApp RepHtml registerReportAsHtml :: [Opt] -> TemplateData -> RegisterReport -> Hamlet HledgerWebAppRoute getEditR :: Handler HledgerWebApp RepHtml pageLayout :: TemplateData -> Hamlet HledgerWebAppRoute -> Hamlet HledgerWebAppRoute navbar :: TemplateData -> Hamlet HledgerWebAppRoute journalTitleInfo :: Journal -> String -> Day -> (String, String) navlinks :: TemplateData -> Hamlet HledgerWebAppRoute navlink :: TemplateData -> String -> HledgerWebAppRoute -> Hamlet HledgerWebAppRoute filterform :: TemplateData -> Hamlet HledgerWebAppRoute helplink :: String -> String -> Hamlet HledgerWebAppRoute

Documentation

data HledgerWebApp Source

Constructors HledgerWebApp appRoot :: String appDir :: FilePath appOpts :: [Opt] appArgs :: [String] appJournal :: Journal appStatic :: Static Instances Yesod HledgerWebApp YesodSite HledgerWebApp

data HledgerWebAppRoute Source

Constructors StaticR (Route Static) IndexR JournalOnlyR RegisterOnlyR AccountsOnlyR JournalR RegisterR Instances Eq HledgerWebAppRoute Read HledgerWebAppRoute Show HledgerWebAppRoute

data TemplateData Source

A bundle of useful data passed to templates. Constructors TD here :: HledgerWebAppRoute the current page's route title :: String page's title msg :: Maybe (Html ()) transient message a :: String a (acct/desc filter pattern) parameter p :: String p (period expression) parameter j :: Journal the current journal today :: Day the current day

web :: [Opt] -> [String] -> Journal -> IO () Source

The web command.

browser :: String -> IO () Source

server :: String -> Int -> [Opt] -> [String] -> Journal -> IO () Source

getHandlerParameters :: Handler HledgerWebApp (String, String, [Opt], FilterSpec, Journal, Maybe (Html ()), HledgerWebAppRoute) Source

Gather all the stuff we want for a typical hledger web request handler.

getIndexR :: Handler HledgerWebApp () Source

getJournalR :: Handler HledgerWebApp RepHtml Source

A combined accounts and journal view.

postJournalR :: Handler HledgerWebApp RepPlain Source

getRegisterR :: Handler HledgerWebApp RepHtml Source

A combined accounts and register view.

postRegisterR :: Handler HledgerWebApp RepPlain Source

getAccountsOnlyR :: Handler HledgerWebApp RepHtml Source

A simple accounts and balances view like hledger balance.

balanceReportAsHtml :: [Opt] -> TemplateData -> BalanceReport -> Hamlet HledgerWebAppRoute Source

Render a balance report as HTML.

accountNameToAccountRegex :: String -> String Source

accountRegexToAccountName :: String -> String Source

isAccountRegex :: String -> Bool Source

getJournalOnlyR :: Handler HledgerWebApp RepHtml Source

A basic journal view, like hledger print, with editing.

journalReportAsHtml :: [Opt] -> TemplateData -> JournalReport -> Hamlet HledgerWebAppRoute Source

Render a journal report as HTML.

addform :: TemplateData -> Hamlet HledgerWebAppRoute Source

postingsfields :: TemplateData -> Hamlet HledgerWebAppRoute Source

postingfields :: TemplateData -> Int -> Hamlet HledgerWebAppRoute Source

editform :: TemplateData -> String -> Hamlet HledgerWebAppRoute Source

importform :: Hamlet HledgerWebAppRoute Source

postJournalOnlyR :: Handler HledgerWebApp RepPlain Source

postAddForm :: Handler HledgerWebApp RepPlain Source

Handle a journal add form post.

postEditForm :: Handler HledgerWebApp RepPlain Source

Handle a journal edit form post.

postImportForm :: Handler HledgerWebApp RepPlain Source

Handle an import page post.

getRegisterOnlyR :: Handler HledgerWebApp RepHtml Source

A simple postings view like hledger register.

registerReportAsHtml :: [Opt] -> TemplateData -> RegisterReport -> Hamlet HledgerWebAppRoute Source

Render a register report as HTML.

getEditR :: Handler HledgerWebApp RepHtml Source

A standalone journal edit form page.

pageLayout :: TemplateData -> Hamlet HledgerWebAppRoute -> Hamlet HledgerWebAppRoute Source

Wrap a template with the standard hledger web ui page layout.

navbar :: TemplateData -> Hamlet HledgerWebAppRoute Source

journalTitleInfo :: Journal -> String -> Day -> (String, String) Source

Generate journal- and context-specific title and info strings for display.

navlinks :: TemplateData -> Hamlet HledgerWebAppRoute Source

navlink :: TemplateData -> String -> HledgerWebAppRoute -> Hamlet HledgerWebAppRoute Source

filterform :: TemplateData -> Hamlet HledgerWebAppRoute Source

helplink :: String -> String -> Hamlet HledgerWebAppRoute Source

Produced by Haddock version 2.6.1