@database MiamiPhone.guide @author "Maxime Doyen" @$VER: MiamiPhone.guide 2.1 (19.05.00) @Node "MAIN" "MiamiPhone - Documentation in «English»" @{b}================================== M i a m i P h o n e version 2.1 ==================================@{ub} Copyright © 1998-2000 Maxime Doyen All Rights Reserved - F R E E W A R E - @{" Introduction " link "INTR"} - Features of MiamiPhone. @{" Requirements " link "REQU"} - What you need to use MiamiPhone. @{" Copyright " link "COPY"} - Your rights and legals. @{" Upgrading " link "UPGR"} - Must be done if you upgrade!! @{" First step " link "STEP"} - Before to start. @{" Main window " link "MWIN"} - The full guided tour. @{" Price file " link "FILE"} - Set the price file. @{" Preferences " link "SETT"} - The preferences. @{" History " link "Changes/main" 0} - The history of changes. @{" The future " link "PLAN"} - Planned enhancements. @{" Author " link "AUTH"} - How to contact the author. @{" Thanks to " link "CRED"} - Those deserving favour. @EndNode @Node "INTR" "Introduction" @{b}INTRODUCTION@{ub} «MiamiPhone» is the analyzer for the phone log generated by the TCP/IP stack program "Miami" (© Holger Kruse). It enables to compute the time and the cost of your phone connections for the internet and more!! You can use ticks or exact charge method, configure some discount, special days, name the time zones, apply a filter, display in numbers or bars or lines, display in Euro, print the results... «MiamiPhone» is the result of a friend request who wanted a MUI (© Stefan Stuntz) based phone log analyzer for "Miami", which was not existing till now... It should be useable in many countries because it has a flexible configuration. At last, please note that «MiamiPhone» is freeware but copyrighted by me, but of course donations are welcome :-)) @{b}Main features includes@{ub} - easy price configuration using a simple text file - connect time (seconds between phone connect and modem online) - "ticks" or "exact" charge method - credit time and cost (used in most countries) - retrechment discount - maximum charge discount - special days - optional V.A.T. - euro currency - optional error detection (online with no offline -> computer crash) - a nice graphical display of all connections using bars or lines - display many informations about your connections in a list (number, date, start, end, duration, initial, invoice, zone, speed) - a toolbar for mainly used functions - a display filter on month, year and zone - display filtered and total results of your connections time and cost (number, duration, initial, retrench, v.a.t., invoice) - print the filtered list and results on printer or into a ascii file - localized in some languages (and includes a .cd file for thoses want to) - includes some pre-configured price files for some countries @EndNode @Node "REQU" "Requirements" @{b}REQUIREMENTS@{ub} @{b}Software@{ub} - Kickstart 2.0 or higher - Workbench 2.1 or higher - @{"MUI 3.1" link "MUI3"} or higher (not provided -> aminet/util/libs) - NList.mcc (not provided -> aminet/dev/mui) @EndNode @Node "COPY" "Copyright" @{b}LEGAL STUFF@{ub} @{b}Copyright notice@{ub} The copyright for this software is by Maxime Doyen, all rights reserved. This archive may only be distributed in unmodified form. In particular the deletion of the documentation and this copyright-note is not allowed. @{b}Distribution@{ub} This software is freely distributable. The distribution is permitted under the following conditions: - All associated files included with the distribution archive are to remain intact and unaltered. - The distribution over BBS's, Internet, software libraries like the ones from Fred Fish or Aminet CD-ROM's and similar electronic channels is granted. - For disc-magazines and service providers, who rise additional costs for the file transfer, the permission of the @{"program author" link "AUTH"} is required. @{b}Disclaimer@{ub} This software is provided as-is, without warranty of any kind, either expressed or implied. In no event will the author be liable for direct, indirect, incidental or consequential damages or data loss resulting from the use or application of this software. The entire risk as to the results and performance of this software is assumed by the user. @EndNode @Node "UPGR" "Upgrading" @{b}UPGRADING@{ub} If you upgrade from version below 1.4 then you must: - reinstall MiamiPhone completely, (just delete any prior version and copy the new directory into its destination) - YOU MUST ADJUST THE @{"MIAMIPHONE.PRICE" link "FILE"} FILE. I suggest you to create a new one from the default "MiamiPhone.price", because a lot of things have changed!! @EndNode @Node "STEP" "First step" @{b}FIRST STEP@{ub} First of all, the phone logging for "Miami" is only possible for registered users, this feature is disabled if you have not register "Miami". @{b}1. Configure Miami@{ub} Normally, there is nothing to do, "Miami" defaults log the phone to the "Miami:" directory into a file called "miami.phone" and MiamiPhone defaults uses this file. @{b}2. Configure 'MiamiPhone.price'@{ub} Before running MiamiPhone, you must also configure the @{"MiamiPhone.price" link "FILE"} file. This file let you adjust the parameters for charging your phone cost. @{b}3. Run MiamiPhone@{ub} @EndNode @Node "MWIN" "The full guided tour" «MiamiPhone» main window is laid in four distinct part: 1. On the upper left, the tool bar, which provides easy access to most frequently used functions: @{b}[Open ] @{ub} Select a new phone log to be displayed and analyzed. @{b}[Parse] @{ub} This button will parse the file again. @{b}[List ] @{ub} Display the detailed list of connections. @{b}[Graph] @{ub} Display a 2D bars/lines graph of connections. @{b}[Refre] @{ub} Refresh the display according to the filter. @{b}[Print] @{ub} Print the results to the printer or into a ascii file. @{b}[Prefs] @{ub} Open the settings window. 2. Just below this toolbar is the filter area, which enable to control the 'Filtered Results' on the right: @{b}[Euro]@{ub} display all the cost in euro currency @{b}[Date]@{ub} enable the date filtering @{b}[From]@{ub} define the lower date boundary (DATE MUST BE dd-mm-yy FORMAT!!) @{b}[To ]@{ub} define the upper date boundary (DATE MUST BE dd-mm-yy FORMAT!!) (when changing the date you must click on the [Refre.] button to see the changes). @{b}[Zone]@{ub} enable zone filter, control zone 3. On the right is the result part, both filtered and total results are displayed: @{b}Num./Skip. @{ub} is the number of connection/the skipped ones @{b}Duration @{ub} is the connection time @{b}Initial @{ub} is the initial cost (whitout tax nor retrenchment) @{b}- Retrensh.@{ub} is the retrenchment gain @{b}+ V.A.T @{ub} is the tax amount @{b}= Invoice @{ub} is the invoice amount (e.g. the real cost) 4. A last below all of that, the detailed list or the 2d graph depending on what is active: @{b}@{ub} Displays detailed information on each connection: Num | Online | Offline | Duration | Initial | Invoice | Zone | Speed @{b}@{ub} Displays a graph of connection in 2d bars or lines (just click on left mousebutton on graph to toggle). @EndNode @Node "FILE" "The price file" @{b}WARNING: IF YOU ARE UPGRADING FROM V1.4 AND BELOW, YOU MUST MAKE SOME CHANGES IN YOUR PRICE FILE@{ub} @{b}THE PRICE FILE@{ub} «MiamiPhone» is quite configurable, it allow to uses both 'Ticks' charge method (the main used), but also 'Exact' charge method like in France. I will here detail the French example file for you to understand how to configure the 'MiamiPhone.price' file for your needs (white lines are from the price file): Please always provide a header such as follow when writing a new price file: @{fg shine} # MiamiPhone 2.0 price file # ------------------------- # Country : France # Operator : France Telecom # Subscription: Normal # Author : Maxime Doyen # Modified : 24/04/2000 # # -> Please read the amigaguide detailed documentation on how to configure this file # @{fg text} @{fg shine}# PARAMETERS pmct: 10@{fg text} This is the «modem connect time» (in seconds) that time will be substract from the online time because there is a little delay while Miami is connecting and then write the time into the log. This value can be either positive or negative. @{fg shine}ptrv: 20.6@{fg text} This is an optional «tax rate value» (V.A.T.) that will be used to compute the invoice cost. @{fg shine}# TIME ZONE DAY & STRINGS & COSTS & TICKS & MAXIMUM@{fg text} This is where we are going to define how the cost should be computed. The week is divided into three «time zone day» (tzd), index 0 is for Sunday, index 1 is for weekdays (Mon-Fri), index 2 if for Saturday. Each time zone is divided into 30mns slices for which we will set a cost index (from 0 to 9). The 1st slice is from 00:00:00 to 00:29:59, the 2nd is from 00:30:00 to 00:59:59, and so on... @{fg shine} # 1 1 1 1 1 1 1 1 1 1 2 2 2 2 # 0.1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.3. tzd0: 222222222222222211111111111111111111111111112222 #Sun tzd1: 222222222222222200000000000000000000001111112222 #Mon-Fri tzd2: 222222222222222200000000111111111111111111112222 #Sat @{fg text} Sunday will be cost2 from 00:00:00 to 7:59:59 then cost1 from 8:00:00 to 21:59:59 and cost2 from 22:00:00 to 23:59:59 Mon-Fri will be cost2 from 00:00:00 to 7:59:59 then cost0 from 8:00:00 to 18:59:59 then cost1 from 19:00:00 to 21:59:59 and cost2 from 22:00:00 to 23:59:59 Each time zone can have an «time zone string» that will be displayed in the detail list (31 char. max):@{fg shine} tzs0: Plein tzs1: Réduit tzs2: Internet @{fg text} Then for each cost index, we must define the real cost in currency per seconds. You can of course define different cost with different strings easily like in the example file where tzc1 = tzc2 but uses another string.@{fg shine} tzc0: 0.003868 tzc1: 0.001934 tzc2: 0.001934 @{fg text} In most countries the phone connection is charged using ticks (time unity), if it is the case in your country then uncomment (remove #) the «time zone ticks» lines (tzt) and set the duration in seconds.@{fg shine} #tzt0: 0 #tzt1: 0 #tzt2: 0 @{fg text} A special discount is available in some countries when the cost of a connection reach a certain amount then the charge is stopped and you don't pay more. If it is the case the uncomment (remove #) the «time zone maximum» lines and set the maximum amount in your currency.@{fg shine} #tzm0: 0 #tzm1: 0 #tzm2: 0 # CREDIT TIME DAY & COST & TIME@{fg text} Sometimes, the phone connections have a fixed time/amount to take the cost of the connection to the network and things like that. Usually you pay a fixed amount and you have a fixed credit time until the charge is applied using ticks or exact cost. Example with France Telecom: Every connection has the 1st 3mns charged 0.615Fr, and then another cost which depends on the time zone cost. First we must define the «credit time day» (ctd) like for «time zone day» above, and then the «credit time charge» (ctc) in currency and the «credit time time» (ctt) in seconds.@{fg shine} # 1 1 1 1 1 1 1 1 1 1 2 2 2 2 # 0.1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.3. ctd0: 000000000000000000000000000000000000000000000000 #Sun ctd1: 000000000000000000000000000000000000000000000000 #Mon-Fri ctd2: 000000000000000000000000000000000000000000000000 #Sat # ctc0: 0.615 ctt0: 180 # RETRENCHMENT DAY & RATE@{fg text} In some countries, a discount is available under certain time zone and enable a retrenchment in percent to be applied on the costs. First we must also define the «retrechnment day» (rtd) like above, then set the corresponding «retrenchment rate» in percent. You can also define 10 different rate here (from 0 to 9).@{fg shine} # 1 1 1 1 1 1 1 1 1 1 2 2 2 2 # 0.1.2.3.4.5.6.7.8.9.0.1.2.3.4.5.6.7.8.9.0.1.2.3. rtd0: 111111111111111100000000000000000000000000001111 #Sun rtd1: 111111111111111100000000000000000000000000001111 #Mon-Fri rtd2: 111111111111111100000000000000000000000000001111 #Sat # rtr0: 0 rtr1: 50.0 # SPECIAL DAYS@{fg text} A special day is a non working day for which it is necessary to apply the rules of another day (Sunday) for phone connections. Such days are 'national day', 'x-mas'... You can define 10 special days (from 0 to 9). A special day is defined by the day number and month, and then the day index to be applied instead, example: we want sunday rules to be applied for these days, then the index will be 0, and so on for other days: @{fg shine} sdd0: 01-01 0 #happy new year sdd1: 01-05 0 #work day sdd2: 08-05 0 #2nd world war armistice sdd3: 14-07 0 #national day sdd4: 15-08 0 #ascension sdd5: 11-11 0 #1st world war armistice sdd6: 25-12 0 #x-mas @{fg text} @{b}The applied formulas@{ub} The connection is broken into the different charge zone and then for each slice of connection: in exact mode the formula is (x is the time zone index): cost call = ctcx + [( - cttx ) * tzcx] in ticks mode the formula is (x is the time zone index): cost call = ctcx + [number of ticks in[( - cttx )] * tzcx] @EndNode @Node "SETT" "The settings window" @{b}@{ub} [Buttons] define the toolbar buttons to appears as icon and/or text [Font] define the font to be used [Frame] define the frame to be used @{b}@{ub} here you can define the default filter settings for: [Euro][Date][Zone] @{b}@{ub} [Date] define the @{"date format" link DATE} for the "Date" column. [Time] define the @{"time format" link DATE} for the "Start" "End" column. [Round] define decimal to be displayed and the round rule. @{b}@{ub} here you can define which column to be displayed. @{b}@{ub} [File] define the default phone log. [Warn if skip] enable to popup a requester when an error (online without offline) is detected in the phone log @{b}@{ub} [Display] define the default display, e.g. "List" or "Graph". [Graph] define the default graph, e.g. "Bars" or "Lines". [Euro value] define the euro value change from your currency. @EndNode @Node "DATE" "Date formatting" @{b}Date format@{ub} Here is the string components for the date format you can enter in one of the date format string: %a - abbreviated weekday name %A - weekday name %b - abbreviated month name %B - month name %c - same as "%a %b %d %H:%M:%S %Y" %C - same as "%a %b %e %T %Z %Y" %d - day number with leading 0s %D - same as "%m/%d/%y" %e - day number with leading spaces %h - abbreviated month name %H - hour using 24-hour style with leading 0s %I - hour using 12-hour style with leading 0s %j - julian date %m - month number with leading 0s %M - the number of minutes with leading 0s %n - insert a linefeed %p - AM or PM strings %q - hour using 24-hour style %Q - hour using 12-hour style %r - same as "%I:%M:%S %p" %R - same as "%H:%M" %S - number of seconds with leadings 0s %t - insert a tab character %T - same as "%H:%M:%S" %U - week number, taking Sunday as first day of week %w - weekday number %W - week number, taking Monday as first day of week %x - same as "%m/%d/%y" %X - same as "%H:%M:%S" %y - year using two digits with leading 0s %Y - year using four digits with leading 0s @EndNode @Node "PLAN" "Future Plans" @{b}FUTURE PLANS@{ub} At the time of writing, no new release are planned, meanwhile here are listed some features that could perhaps be implemented one day. You can also contact the @{"Author" link "AUTH"} if you have some more good ideas: - multiple providers support - some more specific discounts - improve special days (support of irregular celebration days) - ... @EndNode @Node "AUTH" "Author & Support" @{b}AUTHOR & SUPPPORT@{ub} A world wide web page is accessible for latest informations about the softwares i am developing at: @{fg shine}@{fg text} Feel free to send me suggestions, questions, comments, bug reports at: @{fg shine}@{fg text} or failing that, by conventional mail at: Maxime Doyen A2/12 rés. Planche Epinoy 59170 Croix France @EndNode @Node "CRED" "Credits" @{b}CREDITS@{ub} At last, I would like to thanks the following people who contributed substantially to the development of this software: @{u}Programmers@{uu}: @{b}*@{ub} Stefan Stuntz (MUI) @{b}*@{ub} Gilles Masson (NList.mcc) @{u}Translators@{uu}: @{b}*@{ub} Franz Wlaschitz - Deutsch @{b}*@{ub} Dámaso Domínguez - Español @{b}*@{ub} David Zipeto - Italiano @{b}*@{ub} Kovács "Smith" Péter - Magyar @{u}Bug reports@{uu}: @{b}*@{ub} Luca 'Hexaae' Longone @{b}*@{ub} Tomas Amsrud @{b}*@{ub} Dámaso Domínguez @{u}Miscellaneous@{uu}: @{b}*@{ub} Luca 'Hexaae' Longone - NewIcons @{b}*@{ub} Kovács "Smith" Péter - GlowIcons for OS3.5 @EndNode @Node "MUI3" "MUI" @{b}MUI@{ub} This application uses MUI - MagicUserInterface (c) Copyright 1992-99 by Stefan Stuntz MUI is a system to generate and maintain graphical user interfaces. With the aid of a preferences program, the user of an application has the ability to customize the outfit according to his personal taste. MUI is distributed as shareware. To obtain a complete package containing lots of examples and more information about registration please look for a file called "muiXXusr.lha" (XX means the latest version number) on your local bulletin boards or on public domain disks. If you want to register directly, feel free to send DM 30.- or US$ 20.- to Stefan Stuntz Eduard-Spranger-Straße 7 80935 München GERMANY Support and online registration is available at http://www.sasg.com/ @EndNode