From 701b161a5fb5356a32c765ea83202b003e9a99f1 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 26 Oct 2004 12:33:39 +0000 Subject: slightly more up-to-date docs --- ANNOUNCE.1.5.0 | 1 + httemplate/docs/billing.html | 10 +++++-- httemplate/docs/export.html | 62 ++++++++------------------------------- httemplate/docs/index.html | 21 ++++++++----- httemplate/docs/overview-new.dia | Bin 0 -> 2452 bytes httemplate/docs/overview-new.png | Bin 0 -> 29343 bytes httemplate/docs/schema.html | 2 +- httemplate/docs/selfservice.html | 60 +++++++++++++++++++++++++++++++++++++ 8 files changed, 96 insertions(+), 60 deletions(-) create mode 100644 httemplate/docs/overview-new.dia create mode 100644 httemplate/docs/overview-new.png create mode 100644 httemplate/docs/selfservice.html diff --git a/ANNOUNCE.1.5.0 b/ANNOUNCE.1.5.0 index d9968dce1..46204b8bf 100644 --- a/ANNOUNCE.1.5.0 +++ b/ANNOUNCE.1.5.0 @@ -16,6 +16,7 @@ - modular price plans, rewrote package add/edit page - fixed up tax report - should be correct for all edge cases with named taxes, tax classes, etc. +- some documentation updates 1.5.0pre7: - historical late notice viewing in web interface diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index 1d6f8c4fc..78e250153 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -4,12 +4,18 @@

Billing

Add one or more Invoice events implmenting your business rules for re-sending invoices, retrying cards, suspending, etc.
You can bill individual customers by clicking on the Bill now link on the main customer view.
The freeside-daily script should be run daily to bill customers and run invoice collection events.
Real-time credit card processing: Install the Business::OnlinePayment module for your processor. Configure the business-onlinepayment configuration option. Disable the default Batch card invoice event and add one for Business::OnlinePayment.
Optional: Credit card expiration alerts: Customize alerter_template configuration option and run freeside-expiration-alerter daily.
Credit card decline alerts: Customize the declinetemplate configuration option and set the emaildecline configuration option. -
Optional: Invoice template customization +
Typeset (LaTeX) invoice templates +
- Place your logo in EPS (Encapsulated PostScript) format at /usr/local/etc/freeside/conf.your_datasrc/logo.eps. +
- Edit the invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration files. If you are adventurous, edit invoice_latex as well. +
+
Plaintext invoice templates
- See the Text::Template documentation for details on the substitution language.
- You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices). @@ -23,7 +29,7 @@

Batch credit card processing + @@ -18,13 +22,14 @@ -

Importing legacy data -

File exporting and remote setup -

fs_passwd -

Signup server -

Session monitor +

Exports +

Signup, self-service and reseller interfaces

Billing + +

Developer

diff --git a/httemplate/docs/overview-new.dia b/httemplate/docs/overview-new.dia new file mode 100644 index 000000000..8995cd978 Binary files /dev/null and b/httemplate/docs/overview-new.dia differ diff --git a/httemplate/docs/overview-new.png b/httemplate/docs/overview-new.png new file mode 100644 index 000000000..bcae522fa Binary files /dev/null and b/httemplate/docs/overview-new.png differ diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index 85026c76d..8523a4a79 100644 --- a/httemplate/docs/schema.html +++ b/httemplate/docs/schema.html @@ -3,7 +3,7 @@

Schema reference

- Schema diagram: as a giant .png or dia source (dia homepage). + Schema diagram (1.4.1): as a giant .png or dia source (dia homepage).

agent - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type).