پرش به محتوای اصلی

مرجع گزینه‌های Fava برای رابط وب Beancount

گزینه‌های پیکربندی Fava برای دفترهای Beancount: سفارشی‌سازی رابط وب با دستورالعمل‌های fava-option در فایل‌های دفتر خود.

Fava استاندارد را با دستورات تاریخ‌دار custom "fava-option" پیکربندی کنید. این تنظیمات جدا از گزینه‌های هسته Beancount هستند.

این مرجع با Beancount 3.2.3، beanquery 0.2.0 و Fava 1.30.16 اجرا شده است. ماتریس آن نسخه پایدار را توصیف می‌کند. Beancount.io دارای داشبورد و بک‌اند جدا است؛ تنظیمات آن ثابت نمی‌کند که تمام ویژگی‌های Fava استاندارد در آنجا موجود است.

نحو​

مقادیر رشته‌های نقل‌قول شده هستند، از جمله اعداد صحیح و بولی. این مثال کامل در هر دو Beancount و Fava تجزیه می‌شود:

; Minimal Fava configuration
option "operating_currency" "USD"
2000-01-01 custom "fava-option" "language" "en"
2000-01-01 custom "fava-option" "default-page" "income_statement/"
2000-01-01 custom "fava-option" "indent" "2"
2000-01-01 custom "fava-option" "show-closed-accounts" "false"

تاریخ الزامی است. Fava دستورات سفارشی بارگذاری شده را به ترتیب تاریخ پردازش می‌کند؛ یک تنظیم اسکالر بعدی جایگزین قبلی می‌شود. تنظیمات تکراری collapse-pattern، import-dirs و insert-entry جمع می‌شوند. قواعد درج از تاریخ خود برای انتخاب مقصد استفاده می‌کنند، بنابراین آن تاریخ‌ها معنادار هستند.

برای بازتولید مثال‌ها به صورت محلی، uv را نصب کنید، سپس یک محیط یکبارمصرف ایجاد کنید:

uv venv .venv-fava-docs
uv pip install --python .venv-fava-docs/bin/python 'fava==1.30.16'
uv tool install beancount-io
source .venv-fava-docs/bin/activate
bea --file main.beancount check
fava main.beancount

ابتدا main.beancount را از بلوک پیکربندی ایجاد کنید، یا از یک دفتر موجود استفاده کنید. دستورات شل فوق از مسیرهای POSIX استفاده می‌کنند. bea check نحو و حسابداری Beancount را بررسی می‌کند؛ Fava علاوه بر آن نام‌ها و مقادیر گزینه‌های خود را بررسی می‌کند. همچنین گزارش Errors فاوا را بررسی کنید.

پیش‌فرض‌های زیر از کلاس داده FavaOptions نصب شده خوانده شده و علیه تجزیه‌گر گزینه نسخه‌دار بررسی شده است. «تنظیم نشده» به معنی None است؛ یک مجموعه خالی به معنی هیچ ورودی پیکربندی نشده است. ستون نوع-مقدار محتوای رشته نقل‌قول را توصیف می‌کند.

گزینه استانداردنوع مقدارپیش‌فرض
languageکد ترجمه پشتیبانی شدهتنظیم نشده
localeکد locale با‌بلتنظیم نشده؛ وقتی هسته render_commas true است en می‌شود
default-pageمسیر گزارش نسبی، اختیاری با فیلترهاincome_statement/
fiscal-year-endتاریخ مالی MM-DD12-31
indentعدد صحیح2
currency-columnعدد صحیح61
show-closed-accountsبولیfalse
show-accounts-with-zero-transactionsبولیtrue
show-accounts-with-zero-balanceبولیtrue
show-metadata-indicatorsبولیtrue
collapse-patternعبارت منظم حساب؛ قابل تکرارلیست خالی
sidebar-show-queriesعدد صحیح5
default-fileمسیر فایل، یا مقدار خالی برای این فایلتنظیم نشده
insert-entryعبارت منظم حساب؛ قابل تکرار، مکان‌های تاریخ‌دارلیست خالی
auto-reloadبولیfalse
use-external-editorبولیfalse
import-configمسیر پیکربندی ایمپورتتنظیم نشده
import-dirsمسیر دایرکتوری؛ قابل تکرارلیست خالی
invert-gains-losses-colorsبولیfalse
invert-income-liabilities-equityبولیfalse
conversion-currenciesکدهای ارز جدا شده با فضای در یک رشتهتاپل خالی
account-journal-include-childrenبولیtrue
uptodate-indicator-grey-lookback-daysعدد صحیح60
upcoming-eventsعدد صحیح7

برای بولی‌ها از "true" یا "false" استفاده کنید. مقایسه به حروف بزرگ/کوچک حساس نیست: "TRUE" نیز یک گزینه را فعال می‌کند. هر رشته‌ای غیر از یک حالت حروفی "true" به عنوان false درمان می‌شود. تجزیه‌گر عدد صحیح آن نحو عدد صحیح را بررسی می‌کند، نه محدوده مثبت؛ از اندازه‌های چیدمان مثبت و شمارهای غیر منفی استفاده کنید.

نمایش و بومی‌سازی​

language​

ترجمه رابط را تنظیم می‌کند، مثلاً "en"، "de" یا "zh_CN". وقتی تنظیم نشده، Fava با مرورگر مذاکره می‌کند. locale باید ترجمه‌ای داشته باشد که توسط Fava حمل می‌شود؛ یک کد زبان نحوی معتبر به تنهایی کافی نیست.

locale​

شماره‌گذاری را مستقل از زبان رابط تنظیم می‌کند، مثلاً "en_US" یا "de_DE". بدون این گزینه، Fava از الگوی شماره غیربومی خود استفاده می‌کند. هسته option "render_commas" "TRUE" عقب‌افتادن en را فراهم می‌کند. زبان مرورگر را ارث نمی‌برد.

ناوبری و چیدمان​

default-page​

مقصد در داخل دفتر را تنظیم می‌کند، مانند "balance_sheet/" یا "journal/?time=year". بخش بعد از اسلاگ دفتر را از یک URL کارکرد Fava استاندارد کپی کنید. / را پیش‌وند نکنید: مسیرهای گزارش نسبی به آن دفتر هستند.

fiscal-year-end​

مرزهای فیلتر زمانی مالی را تنظیم می‌کند. مثلاً، "03-31" سال مالی را در ۳۱ مارس پایان می‌دهد. از فیلترهای سال مالی و فصل مالی پشتیبانی می‌کند؛ تاریخ تراکنش‌ها را تغییر نمی‌دهد. Fava همچنین مقادیر ماه بالای ۱۲ را قبول می‌کند تا سال مالی را که در سال تقویمی بعدی پایان می‌شود برچسب‌گذاری کند.

indent​

تورفتگی پستینگ را برای ورودی‌های تولید شده و فرمت‌دهی ویرایشگر تنظیم می‌کند. از یک رشته عدد صحیح مثبت، مانند "4" استفاده کنید.

currency-column​

ستون هم‌ترازی ارز را وقتی پستینگ‌ها را ذخیره یا هم‌تراز می‌کنید تنظیم می‌کند. همچنین راهنمای عمودی ویرایشگر را موقعیت می‌دهد. پیش‌فرض "61" است.

قابلیت دید محتوا​

show-closed-accounts​

حساب‌های بسته را در درخت‌های حساب گزارش شامل می‌کند. حساب‌های با موجودی غیر صفر بدون توجه به این تنظیم قابل دید باقی می‌مانند.

show-accounts-with-zero-transactions​

حساب‌های بدون تراکنش را در درخت‌های حساب شامل می‌کند. حسابی که موجودی غیر صفر دارد را سرکوب نمی‌کند.

show-accounts-with-zero-balance​

حساب‌های که موجودی گزارش آنها صفر است را شامل می‌کند. با "false" برای درخت کوتاه‌تر آن را خاموش کنید.

collapse-pattern​

نام‌های حساب را برای جمع‌شودن در درخت‌های حساب مطابقت می‌کند. برای چند الگو دستور را تکرار کنید. مثلاً، "^Assets:Investments" آن حساب و فرزندان آن را جمع می‌کند.

تعداد پرس‌وجوهای ذخیره شده که در نوار جانبی لینک شده‌اند را محدود می‌کند. "0" آن لینک‌ها را مخفی می‌کند. ببینید لینک‌های سفارشی و پرس‌وجوها.

show-metadata-indicators​

نشانگرهای کوچک متادیتا را در ژورنال‌ها نشان می‌دهد. آن را به "false" تنظیم کنید تا نشانگرها بدون حذف متادیتا از دفتر مخفی شوند.

مدیریت فایل​

default-file​

فایلی را که ابتدا توسط ویرایشگر باز می‌شود و مقصد عقب‌افتادن برای ورودی‌های جدید انتخاب می‌کند. یک مسیر نسبی از فایل شامل دستور حل می‌شود. با مقدار خالی، فایل شامل انتخاب می‌شود. بدون این گزینه، فایل اصلی دفتر عقب‌افتادن است. یک فایل موجود باید همچنین در دفتر شامل شود تا یک منبع قابل ویرایش باشد.

insert-entry​

یک ورودی جدید را قبل یک دستور سفارشی مطابقت‌شده، در فایل شامل آن دستور قرار می‌دهد. عبارت منظم آن یک نام حساب از ابتدا مطابقت می‌کند؛ هرگز خطوط خام فایل را جستجو نمی‌کند. Fava پستینگ‌های تراکنش را از آخر به اول در نظر می‌گرد. برای اولین حساب با مطابقت واجد شرایط، آخرین قاعده تاریخ‌دار سخت قبل ورودی جدید را انتخاب می‌کند. اگر هیچ‌کدام مطابقت نکند، به فایل پیش‌فرض ضمیمه می‌کند. پیاده‌سازی درج مرجع معتبر برای این قواعد است.

این سه فایل را در همان دایرکتوری ایجاد کنید. main.beancount حساب‌ها را فراهم می‌کند و شامل می‌کند:

; main.beancount
option "title" "Insertion Demo"
option "operating_currency" "USD"
include "january.beancount"
include "february.beancount"
2000-01-01 open Assets:Checking USD
2000-01-01 open Assets:Cash USD
2000-01-01 open Assets:Wallet USD
2000-01-01 open Expenses:Food USD
2000-01-01 custom "fava-option" "default-file"
2024-01-01 custom "fava-option" "insert-entry" "^Expenses:Food$"

january.beancount شامل است:

; january.beancount
2024-01-01 custom "fava-option" "insert-entry" "^Assets:Checking$"

february.beancount شامل است:

; february.beancount
2024-02-01 custom "fava-option" "insert-entry" "^Assets:Checking$"

Fava را با main.beancount شروع کنید. این تراکنش‌ها را از طریق فرم تراکنش آن اضافه کنید؛ آنها ورودی برای عملیه درج هستند، نه یک فایل اضافی برای قبلی شامل:

2024-01-15 * "January groceries"
  Expenses:Food       10.00 USD
  Assets:Checking    -10.00 USD
 
2024-02-01 * "Same-day boundary"
  Expenses:Food       20.00 USD
  Assets:Checking    -20.00 USD
 
2024-02-15 * "February groceries"
  Expenses:Food       30.00 USD
  Assets:Checking    -30.00 USD
 
2024-02-16 * "Cash groceries"
  Expenses:Food       40.00 USD
  Assets:Cash        -40.00 USD
 
2024-02-17 * "Unmatched cash transfer"
  Assets:Cash         50.00 USD
  Assets:Wallet      -50.00 USD

دو ورودی اول قبل قاعده ژانویه می‌روند. سومی قبل قاعده فوریه می‌رود. چهارمی Assets:Cash را آزمایش می‌کند، هیچ مطابقتی پیدا نمی‌کند، سپس قاعده Expenses:Food در فایل اصلی استفاده می‌کند. پنجمی هیچ حساب مطابقت‌شده‌ای ندارد و به main.beancount ضمیمه می‌شود. ذخیره یک دسته شماره خطوط قاعده را به عنوان ورودی‌ها درج می‌شوند به‌روز می‌کند.

auto-reload​

صفحه را به طور خودکار دوباره بارگیری می‌کند وقتی Fava یک تغییر منبع خارجی تشخیص می‌دهد. وقتی false، Fava یک اعلام بارگیری مجدد ارائه می‌دهد. تغییرات انجام شده از طریق خود Fava قبلاً یک بارگیری مجدد را تحریک می‌کنند.

use-external-editor​

لینک‌های منبع را از طریق طرح URL beancount:// باز می‌کند. یک کنترل‌کننده را بر رایانه‌ای که مرورگر را اجرا می‌کند نصب کنید و مطمئن شوید که می‌تواند به فایل‌های دفتر دسترسی داشته باشد. این یک اتصال خودکار به فایل‌های روی یک سرور میزبان نیست.

import-config​

به یک پیکربندی ایمپورت‌ر Python اشاره می‌کند. این یک تنظیم یکپارچگی است: پیکربندی را ایجاد و وابسته‌های ایمپورت‌ر آن را قبل از استفاده از گزارش Import نصب کنید. سه بسته سنجاق شده فوق یک پیکربندی ایمپورت‌ر بانکی فراهم نمی‌کنند.

import-dirs​

یک دایرکتوری را برای اسکن برای نامزدهای ایمپورت اضافه می‌کند. برای اضافه دایرکتوری‌ها دستور را تکرار کنید. از دایرکتوری‌های واقعی و قابل دسترس استفاده کنید؛ تنظیم گزینه آنها را ایجاد نمی‌کند.

نمایش مالی​

unrealized​

یک گزینه استاندار Fava 1.30.16 نیست. Fava گزارش Unknown option و سپس نام در بک‌تیک را اگر اضافه کنید گزارش می‌دهد. از آن برای پیکربندی حساب‌های سود/زیان غیرواقعی استاندار استفاده نکنید.

اسنپ‌شات منبع Beancount.io که در 2026-09-07 بازبینی شده است یک فیلد رشته جدا به نام unrealized، با پیش‌فرض "Unrealized"، در تجزیه‌گر گزینه بک‌اند و جدول تنظیمات داشبورد خود افشا می‌کند. آن موجود بودن فیلد را آنجا تأیید می‌کند. آن ثابت نمی‌کند که تغییر آن Income:Unrealized یا Expenses:Unrealized ایجاد می‌کند، یا اینکه یک نصب مشخص این اسنپ‌شات را اجرا می‌کند.

invert-income-liabilities-equity​

علامت‌های نمایش داده شده Income، Liabilities و Equity را در صورت درآمد و ترازنامه می‌چرخاند. Expenses علامت‌های خود را حفظ می‌کنند. ورودی‌های ژورنال، ژورنال‌های حساب و پستینگ‌های ذخیره شده تغییر نکرده باقی می‌مانند.

conversion-currencies​

انتخاب‌های کشویی تبدیل را با یک لیست جدا شده با فضای در یک رشته جایگزین می‌کند:

; Conversion dropdown
2000-01-01 custom "fava-option" "conversion-currencies" "USD EUR"

تکرار این گزینه لیست قبلی را جایگزین می‌کند. وقتی تنظیم نشده، Fava ارزهای عمیلاتی به علاوه کالاهایی که به عنوان ارزهای ISO 4217 می‌شناسد ارائه می‌دهد.

account-journal-include-children​

ورودی‌های حساب‌های فرزند را در ژورنال یک حساب به طور پیش‌فرض شامل می‌کند. آن را به "false" تنظیم کنید تا فقط با آن حساب شروع کنید.

invert-gains-losses-colors​

رنگ‌های استفاده شده برای سودها و زیان‌های غیرواقعی در نماهای ترازنامه به ارزش بازار و تراز آزمایشی معکوس می‌کند. آن رنگ‌ها را تغییر می‌دهد، نه مقدارها یا نام‌های حساب.

نظارت​

uptodate-indicator-grey-lookback-days​

دوره نگاه‌به‌عقب نشانگر تازگی خاکستری را کنترل می‌کند. نشانگرهای حساب را با fava-uptodate-indication: TRUE بر دستور open حساب فعال کنید؛ ببینید مثال متادیتای رابط کاربری.

upcoming-events​

شمار اعلام نوار جانبی برای رویدادهای آینده در تعداد روزهای مشخص را کنترل می‌کند. "0" شمار را غیرفعال می‌کند.

پیکربندی پیشنهاد شده​

این پیکربندی کامل یک نقطه شروع برای محیط استاندار فوق است. آن تنظیمات نمایش را بدون بارگذاری پلاگین‌ها یا نیاز به فایل‌های اضافی تغییر می‌دهد:

option "operating_currency" "USD"
2000-01-01 custom "fava-option" "language" "en"
2000-01-01 custom "fava-option" "locale" "en_US"
2000-01-01 custom "fava-option" "default-page" "income_statement/"
2000-01-01 custom "fava-option" "fiscal-year-end" "12-31"
2000-01-01 custom "fava-option" "indent" "2"
2000-01-01 custom "fava-option" "currency-column" "61"
2000-01-01 custom "fava-option" "show-closed-accounts" "false"
2000-01-01 custom "fava-option" "show-accounts-with-zero-transactions" "true"
2000-01-01 custom "fava-option" "show-accounts-with-zero-balance" "false"
2000-01-01 custom "fava-option" "show-metadata-indicators" "true"
2000-01-01 custom "fava-option" "collapse-pattern" "^Assets:Investments"
2000-01-01 custom "fava-option" "sidebar-show-queries" "5"
2000-01-01 custom "fava-option" "auto-reload" "false"
2000-01-01 custom "fava-option" "use-external-editor" "false"
2000-01-01 custom "fava-option" "invert-income-liabilities-equity" "false"
2000-01-01 custom "fava-option" "invert-gains-losses-colors" "false"
2000-01-01 custom "fava-option" "conversion-currencies" "USD EUR"
2000-01-01 custom "fava-option" "account-journal-include-children" "true"
2000-01-01 custom "fava-option" "upcoming-events" "7"
2000-01-01 custom "fava-option" "uptodate-indicator-grey-lookback-days" "60"

مشاهده گزینه‌های فعلی شما​

در Fava استاندارد، صفحه Help ← Options آن را برای مرجع نسخه نصب شده باز کنید و بعد از تغییر یک دستور Errors را بررسی کنید. راهنمای گزینه رسمی 1.30.16 تنظیمات را توضیح می‌دهد.

در داشبورد Beancount.io، صفحه Settings یک دفتر را باز کنید. جدول گزینه‌های Fava آن زیرمجموعه‌ای را که توسط بک‌اند برگشت داده شده نشان می‌دهد. این رابط کاربری در اسنپ‌شات منبع محصول تأیید شده است، نه از طریق یک جلسه تولید معتبر. یک فیلد نمایش داده شده به معنی آن نیست که داشبورد میزبان ویرایشگر، ایمپورت‌ها یا مسیرهای URL Fava استاندارد را پیاده می‌کند.

همچنین ببینید​

منبع: https://beancount.io/fa/docs/Basics/fava-options