Funkcie rozhrania

Používajte editor, formulár transakcií a dopytovacie zostavy na prácu s vašou knihou. Nižšie uvedené spustiteľné recepty cielia na štandardnú Fava 1.30.16 s Beancount 3.2.3 a beanquery 0.2.0; postupujte podľa pinned lokálneho nastavenia.

Beancount.io používa samostatný dashboard. Jeho produktový zdroj potvrdzuje trasy knihy pre úpravy, dopytovanie, dokumenty a nastavenia, plus konzumentov pre niekoľko možností zobrazenia Fava. To nerobí klávesové skratky, pravidlá vkladania, spúšťanie pluginov alebo URL cesty štandardnej Fava zárukou hostovanej kompatibility. Obrázok nižšie zobrazuje hostovaný dashboard, nie štandardné rozhranie.

Preskúmajte živú knihu →

1. Úpravy a zadávanie údajov​

Vstavaný editor​

Editor štandardnej Fava ponúka dopĺňanie účtov, príjemcov a značiek. Použite default-file na výber jeho počiatočného zdrojového súboru. insert-entry tiež umiestni kurzor na najnovšiu značku vkladu v tomto súbore; nie je to základná možnosť Beancount.

2000-01-01 custom "fava-option" "default-file"
2024-01-01 custom "fava-option" "insert-entry" "^Expenses:Food$"

Tento fragment vyberá svoj obsahujúci súbor. Nové záznamy po 1. januári 2024, ktoré zodpovedajú Expenses:Food, sa vkladajú pred značku, pokiaľ nemá prednosť neskoršie vyhovujúce pravidlo alebo účet neskoršieho zápisu. Pozrite si kompletný príklad viacnásobného vkladania súborov.

Pridávanie transakcií​

V štandardnej Fava kliknite na + alebo stlačte n na otvorenie formulára transakcie. Pole rozprávania akceptuje značky a odkazy oddelené medzerami, napríklad Lunch #food ^receipt-001. Názvy účtov už musia mať direktívy open.

Uložte túto kompletnú knihu ako ui-demo.beancount a vyskúšajte nižšie uvedené zostavy. Pozitívny výdavok je debet; negatívny zápis hotovosti je jeho kredit.

option "title" "UI Demo"
option "operating_currency" "USD"
2024-01-01 open Assets:Checking USD
  fava-uptodate-indication: TRUE
2024-01-01 open Income:Salary USD
2024-01-01 open Expenses:Food USD
 
2024-01-02 * "Salary"
  Assets:Checking    3000.00 USD
  Income:Salary     -3000.00 USD
 
2024-01-03 * "Groceries" #food
  Expenses:Food       400.00 USD
  Assets:Checking    -400.00 USD
 
2024-01-04 balance Assets:Checking 2600.00 USD

Spustite bea --file ui-demo.beancount check, potom fava ui-demo.beancount. Kontrola prejde a kontrola drží 2 600,00 USD. Transakcia s dátumom v budúcnosti s #template je stále skutočná transakcia: táto značka z nej nerobí inertnú opätovne použiteľnú šablónu formulára. Uchovávajte hypotetické transakcie v samostatnej knize scenára.

2. Správa dokumentov​

Štandardná Fava môže nahrávať dokumenty ich presunutím na názvy účtov alebo riadky denníka. Nakonfigurujte skutočný koreň dokumentov a udržiavajte jeho hierarchiu účtov konzistentnú s vašimi otvorenými účtami.

Tento voliteľný fragment možno pridať do ui-demo.beancount. Najprv vytvorte adresár documents vedľa knihy. Na vyskúšanie zisťovania umiestnite skutočný súbor s názvom 2024-01-03-receipt.pdf do documents/Expenses/Food/.

option "documents" "documents"
plugin "fava.plugins.link_documents"
plugin "fava.plugins.tag_discovered_documents"

Toto sú skutočné moduly dodávané v Fava 1.30.16. Beancount zisťuje datované súbory v adresároch účtov; tag_discovered_documents pridáva #discovered. link_documents spája metadáta document so záznamami dokumentov a prepája ich. Neodvodzuje asociáciu transakcie z obsahu účtenky. Pridajte tieto metadáta priamo pod existujúcu hlavičku Groceries, pred jej zápisy:

  document: "2024-01-03-receipt.pdf"

Tento odsadený riadok je fragment metadát, nie samostatná kniha. S prítomným súborom dokument dostane #linked a zdieľa ^dok-2024-01-03 s transakciou. Chýbajúce zodpovedajúce dokumenty spôsobia chybu. Pre presné štandardné správanie pozrite verzovaný plugin na prepájanie dokumentov.

3. Dopytovanie a analýza s BQL​

Stránka Query štandardnej Fava spúšťa Beancount Query Language. Pred reprodukciou týchto výsledkov celej knihy vymažte globálne filtre času/účtu. Tieto filtre rozhrania môžu odstrániť záznamy pred spustením dopytu.

Výsledky možno stiahnuť ako CSV. Podpora grafov závisí od typov výsledkov: štandardná pomoc popisuje presne dva stĺpce, s dátumom alebo reťazcom nasledovaným inventárom. Ľubovoľný pár číselných stĺpcov nezaručuje graf.

Praktické príklady dopytov​

Spustite tieto dopyty proti ui-demo.beancount na stránke Query Fava alebo odovzdajte každý citovaný dopyt príkazu bea --file ui-demo.beancount query.

Mesačný súhrn výdavkov:

SELECT account, SUM(position) AS total
FROM postings
WHERE account ~ '^Expenses:'
  AND date >= 2024-01-01 AND date < 2024-02-01
GROUP BY account
ORDER BY account;

Očakávaný výsledok: Expenses:Food, 400,00 USD.

Príjmy vs. výdavky podľa mesiaca:

SELECT YEAR(date) AS year, MONTH(date) AS month,
       ROOT(account, 1) AS category, currency,
       SUM(number) AS signed_total
FROM postings
WHERE account ~ '^(Income|Expenses):'
GROUP BY year, month, category, currency
ORDER BY year, month, category, currency;

Dopyt zachováva znamienka Beancount a zoskupuje jednotky oddelene podľa meny. Príjmy 3 000,00 USD mínus výdavky 400,00 USD ponechávajú 2 600,00 USD. Je to zostava jednotiek, nie konverzia alebo zostava nákladovej základne. IIF nie je dostupné na beanquery 0.2.0 a unárny -position nie je podporovaný; zoskupenie dvoch kategórií účtov sa vyhýba obom operáciám.

4. Prispôsobenie a pracovný postup​

Prispôsobenie zobrazenia​

Pridajte tieto direktívy Fava do príkladovej knihy na skrytie účtov s nulovým zostatkom a zbalenie investičných vetiev:

2000-01-01 custom "fava-option" "show-closed-accounts" "false"
2000-01-01 custom "fava-option" "show-accounts-with-zero-balance" "false"
2000-01-01 custom "fava-option" "collapse-pattern" "^Assets:Investments"

Ovplyvňujú stromy účtov zostáv. Účty s nenulovými zostatkami zostávajú viditeľné. Základné formy ako option "show-closed-accounts" "false" zlyhajú pri validácii Beancount.

Metadáta vzorky fava-uptodate-indication: TRUE sú na vlastnom odsadenom riadku pod open. Neumiestňujte ich na riadok open ani neúvodzovkujte boolovskú hodnotu. Najnovšia úspešná kontrola zostatku produkuje zelenú; neúspešná kontrola produkuje červenú; nasledujúca transakcia produkuje žltú. Januárová asercia je zelená. Samostatný sivý indikátor čerstvosti sa tiež môže objaviť, pretože tieto dátumy sú staré.

Odkazy na bočnom paneli​

Pre štandardný príklad s názvom UI Demo tieto úplné cesty vedú na jeho zostavy:

2024-01-01 custom "fava-sidebar-link" "January Expenses" "/ui-demo/income_statement/?time=2024-01"
2024-01-01 custom "fava-sidebar-link" "All Documents" "/ui-demo/documents/"

Tieto cesty predpokladajú, že štandardná Fava je namontovaná na koreni hostiteľa. Nahraďte /ui-demo vaším skutočným slugom knihy a zahrňte akýkoľvek prefix serverovej montáže. Pozrite vlastné odkazy na bočnom paneli pre testované správanie /jump a hranicu hostovaného smerovania.

Všeobecná konfigurácia​

Spustenie štandardnej Fava s viacerými hlavnými súbormi vytvára samostatné knihy v jej prepínači kníh. Súbory prinesené cez include zostávajú súčasťou jednej knihy a objavujú sa ako editovateľné zdroje; nie sú to samostatné knihy.

Použite možnosti Fava pre language, default-file a use-external-editor. Externý editor potrebuje handler beancount:// a prístup k zdrojovým súborom. Skutočné štandardné rozširujúce moduly tiež zahŕňajú fava.ext.auto_commit a fava.ext.portfolio_list. Rozšírenia používajú custom "fava-extension" s vlastnými predpokladmi; sú odlišné od direktív plugin použitých vyššie. Pozrite verzovanú pomoc rozšírení Fava.

5. Výkon a riešenie problémov​

Práca s veľkými súbormi​

Použite includes na organizáciu knihy podľa účtu alebo obdobia. Beancount stále načítava zahrnuté súbory, takže rozdelenie jednej knihy samo o sebe neznižuje vstup zostavy. Obmedzte zobrazené dátumy a zjednodušte nákladné dopyty, keď potrebujete menšiu zostavu.

Bežné problémy a opravy​

• Chyby knihy: Spustite bea check a skontrolujte zostavu Errors Fava. Stránka sa môže vykresliť, zatiaľ čo loader má chyby.
• Neočakávané správanie možností: Skontrolujte testovaný runtime a používajte datované vlastné direktívy Fava. bea check sám nemôže zistiť neznámu možnosť Fava.
• Neočakávané súčty dopytov: Vymažte globálne filtre, zahrňte históriu otvorenia a držte meny oddelene.
• Chýbajúce dokumenty: Skontrolujte, či adresár existuje, účet je otvorený, názov súboru začína platným dátumom a metadáta transakcie zodpovedajú dokumentu.

Pre kontrast sú to zámerne neplatné príklady. Nesmú sa kopírovať do pracovnej knihy:

option "insert-entry" "Expenses:Food"
custom "fava-sidebar-link" "Label" "/jump?time=month"

Prvý používa neznámu základnú možnosť. Druhý vynecháva požadovaný dátum. Referencia štandardných funkcií popisuje správanie rozhrania pre toto vydanie.