Add user docuemntation

HaikuArchives · Aug 1, 2024 · 3da803e · 3da803e
1 parent a3b14e1
commit 3da803e
Show file tree

Hide file tree

Showing 30 changed files with 754 additions and 0 deletions.
diff --git a/documentation/_doc.css b/documentation/_doc.css
@@ -0,0 +1,243 @@
+/*
+ * Copyright 2008-2017, Haiku. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ *		François Revol <[email protected]>
+ *		Stephan Aßmus <[email protected]>
+ *		Braden Ewing <[email protected]>
+ *		Humdinger <[email protected]>
+ *		Vincent Duvert <[email protected]>
+ *		Augustin Cavalier <waddlesplash>
+ */
+
+html {
+	margin: 0;
+	padding: 0;
+	background: #FFF;
+}
+body {
+	color: #333333;
+	line-height: 1.5;
+	font-family: "Noto Sans", Arial, Helvetica, sans-serif;
+	font-size: 0.9em;
+	min-width: 45em;
+	max-width: 70em;
+}
+/* link colors and text decoration */
+
+a:link {
+	font-weight: bold;
+	text-decoration: none;
+	color: #dc3c01;
+}
+a:visited {
+	font-weight: bold;
+	text-decoration: none;
+	color: #892601;
+}
+a:hover, a:active {
+	text-decoration: underline;
+	color: #ff4500;
+}
+
+/* Some headers act as anchors, don't give them a hover effect */
+
+h1, h2, h3, h4, h5 {
+	a:hover, a:active {
+		text-decoration: none;
+		color: #000;
+	}
+}
+
+/* Index table */
+
+table.index {
+	margin: 6px 6px 6px 30px;
+	padding: 1px;
+	border-width: 1px;
+	border-style: dotted;
+	border-color: #e0e0e0;
+	float: right;
+	position: relative;
+}
+table.index tr.heading {
+	background-color: #e0e0e0;
+	text-align: center;
+	font-weight: bold;
+	font-size: 1.1em;
+}
+table.index tr.index {
+	background-color: #eeeeee;
+}
+table.index td {
+	padding: 5px 20px;
+}
+
+table.index a:link, table.index a:visited {
+	font-weight: normal;
+	text-decoration: none;
+	color: #dc3c01;
+}
+table.index a:hover, table.index a:active {
+	text-decoration: underline;
+	color: #ff4500;
+}
+
+/* heading and navigation */
+
+#navbar {
+	overflow: hidden;
+	background-color: #555;
+	position: fixed;
+	top: 0;
+	width: 100%;
+	z-index: 10;
+}
+
+#navbar a {
+	float: left;
+	display: block;
+	color: #f2f2f2;
+	text-align: center;
+	padding: 0px 14px;
+	text-decoration: none;
+	font-size: 12px;
+}
+
+#navbar a:hover {
+	background-color: #ddd;
+	color: black;
+}
+
+#navbar a.active {
+	background-color: #D1A600;
+	color: white;
+}
+
+#content {
+	margin-left: 20px;
+	margin-right: 20px;
+	padding-top: 5px;
+}
+
+
+hr {
+	margin-top: 45px;
+	border: dotted thin #e0e0e0;
+}
+h1 {
+	font-size: 1.6em;
+	border-bottom: dotted thin #e0e0e0;
+	margin: 45px;
+	text-align: center;
+}
+h2 {
+	font-size: 1.5em;
+	border-bottom: dotted thin #e0e0e0;
+	margin-top: 40px;
+}
+h3 {
+	font-size: 1.2em;
+	border-bottom: none;
+	margin-top: 30px;
+	margin-bottom: 0px;
+}
+h4 {
+	font-size: 1.1em;
+	border-bottom: none;
+	margin-top: 30px;
+	margin-bottom: 0px;
+}
+.key {				/* Shortcut (separate with &#160; */
+	-webkit-border-radius: 3px;
+	-khtml-border-radius: 3px;
+	-moz-border-radius: 3px;
+	border-radius: 3px;
+	border-color: #c7c7c7;
+	border-style: solid;
+	border-width: 1px;
+	padding: 0px 2px;
+	background-color: #e8e8e8;
+    font-family: sans;
+   	font-variant: small-caps;
+  	font-size: 0.9em;
+}
+.menu {				/* Menu */
+	font-size: 1.0em;
+	font-family: serif;
+	font-style: italic;
+	color: #24225e;
+}
+.button {			/* Button */
+	font-size: 1.0em;
+	font-family: serif;
+	font-style: italic;
+	color: #33583c;
+}
+.path {				/* File path */
+	background-color: #e8e8e8;
+	font-size: 0.9em;
+	font-family: monospace;
+}
+.cli {				/* Shell command or file */
+	background-color: #e8e8e8;
+	font-size: 0.9em;
+	font-family: monospace;
+}
+
+pre.terminal {			/* Terminal output*/
+	border-color: #ffb11f;
+	border-style: dotted;
+	border-width: thin;
+	margin: 0em;
+	padding: 1.5em;
+	background-color: #3a3a3a;
+	color: #ffb11f;
+}
+
+tt {
+	background-color: #e8e8e8;
+}
+
+td.onelinetop {
+	padding-right: 1em;
+	vertical-align: top;
+	white-space: nowrap;
+}
+
+ol {
+	padding-left: 20px;
+}
+
+ul {
+	padding-left: 14px;
+}
+
+/* Rounded corner boxes */
+/* Common declarations */
+.box-info, .box-stop, .box-warning {
+	-webkit-border-radius: 10px;
+	-khtml-border-radius: 10px;
+	-moz-border-radius: 10px;
+	border-radius: 10px;
+	border-style: dotted;
+	border-width: thin;
+	border-color: 8f7200;
+	padding: 10px 15px 10px 80px;
+	margin: 15px 56px 15px 56px;
+	min-height: 42px;
+}
+.box-info {
+	background: #fff1bc url(./icons/info-box_32.png) 15px 15px no-repeat;
+}
+.box-warning {
+	background: #ffe992 url(./icons/warning-box_32.png) 15px 15px no-repeat;
+}
+
+/* Images floating to the left of text */
+.floatleft {
+	border:none;
+	padding:0 1em 2em 0;
+	float:left
+}
diff --git a/documentation/en/budget.html b/documentation/en/budget.html
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">
+<head>
+<!--
+ * Copyright 2024
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ *		Darkwyrm (original helpfile)
+ *		Humdinger <[email protected]>
+-->
+	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+	<meta http-equiv="Content-Style-Type" content="text/css" />
+	<meta name="robots" content="all" />
+	<link rel="stylesheet" type="text/css" href="../_doc.css" />
+	<title>CapitalBe's User Documentation</title>
+
+</head>
+<body>
+
+<div id="navbar">
+<a href="./start.html">QuickStart</a> <a href="./menus.html">Menus</a> <a class="active" href="./budget.html">Budget</a> <a href="./reports.html">Reports</a> <a href="./reconcile.html">Reconcile</a>
+</div>
+
+<div id="content">
+<h1>Budget</h1>
+
+<p>If you want to have extra money, you need a budget. While you are the only one who knows what is a good choice for the amount to put into each category, Capital Be gives you the tools to make the best decisions more easily.</p>
+
+<p style="text-align:center"><img src="./images/budget.png" alt="The budget window" /></p>
+
+<p>There are four parts:</p>
+<ol>
+<li><p><span class="menu">Category list</span> - this lists each category, the amount set aside for it, and the period of time for which you are allocating the money, such as each week or month.</p></li>
+<li><p><span class="menu">Budget editor</span> - making changes here will change the item you've chosen in the category list.</p></li>
+<li><p><span class="menu">Information box</span> - displays information about the category selected in the category list. The information includes the biggest and smallest transactions and the average monthly spending over the past 12 months for the chosen category.</p></li>
+<li><p><span class="menu">Budget summary</span> - shows what your budget looks like over the course of a year.</p></li>
+</ol>
+
+<h2><a id="budget" name="budget">How to make a budget</a></h2>
+
+<p>When you open the <i>Budget</i> window for the first time, it automatically generates a budget for you, based on your spending for the past 12 months. This is only a starting point.</p>
+
+<div class="box-warning">
+<p>You get back to the auto-generated budget by clicking <span class="menu">Recalculate all</span> in the menu bar.<br />
+This will remove any budget plans you may have entered!</p>
+<p><span class="menu">Set all to zero</span> in the menu bar will erase all auto-generated or manually edited values!</p></div>
+
+<p>Click on each item in the <span class="menu">Category list</span> for which you want to set aside money and type in the amount in the <span class="menu">Budget editor</span> on the right. Unless you've seen a significant change in your financial situation in the last year, choosing an amount which is just a little more than the average is a good idea unless the amount is not expected to change.</p>
+
+<p>Make sure that there is some money left over to account for unexpected expenses &mdash; 5% of your monthly income is a good start.</p>
+
+<div class="box-info">If you need more information than what the <span class="menu">Information box</span> can give, leave the <i>Budget</i> window open, go back to the main window, and open up the <a href="./reports.html">Reports</a> window. Placed side-by-side, you can easily see where you've been and plan where you're going.</div>
+
+
+<hr />
+<a href="./menus.html" style="border:none;float:left">Previous: Menus</a>
+<a href="./reports.html" style="border:none;float:right">Next: Reports</a>
+<p></p>
+</div>
+</body>
+</html>
diff --git a/documentation/en/images/account_new.png b/documentation/en/images/account_new.png
diff --git a/documentation/en/images/app_settings.png b/documentation/en/images/app_settings.png
diff --git a/documentation/en/images/budget.png b/documentation/en/images/budget.png
diff --git a/documentation/en/images/categories_window.png b/documentation/en/images/categories_window.png
diff --git a/documentation/en/images/filter.png b/documentation/en/images/filter.png
diff --git a/documentation/en/images/main_window.png b/documentation/en/images/main_window.png
diff --git a/documentation/en/images/menu_account.png b/documentation/en/images/menu_account.png
diff --git a/documentation/en/images/menu_app.png b/documentation/en/images/menu_app.png
diff --git a/documentation/en/images/menu_file.png b/documentation/en/images/menu_file.png
diff --git a/documentation/en/images/menu_tools.png b/documentation/en/images/menu_tools.png
diff --git a/documentation/en/images/menu_transaction.png b/documentation/en/images/menu_transaction.png
diff --git a/documentation/en/images/reconcile.png b/documentation/en/images/reconcile.png
diff --git a/documentation/en/images/reports.png b/documentation/en/images/reports.png
diff --git a/documentation/en/images/schedule_transaction.png b/documentation/en/images/schedule_transaction.png
diff --git a/documentation/en/images/scheduled_transactions.png b/documentation/en/images/scheduled_transactions.png
diff --git a/documentation/en/images/split_transaction.png b/documentation/en/images/split_transaction.png
diff --git a/documentation/en/images/transaction_edit.png b/documentation/en/images/transaction_edit.png
diff --git a/documentation/en/images/transaction_init.png b/documentation/en/images/transaction_init.png
diff --git a/documentation/en/images/transfer.png b/documentation/en/images/transfer.png