Projects/KMyMoney: Difference between revisions

    From KDE TechBase
    No edit summary
    (Move wiki to GitLab)
    Tag: Replaced
     
    (122 intermediate revisions by 12 users not shown)
    Line 1: Line 1:
    This page is dedicated to discuss issues related to the port to KDE4. The effort is ongoing and it is not considered stable. It is only suitable for early adopters. If you are looking for the stable version, go to the official page of [http://kmymoney2.sourceforge.net KMyMoney]
    This documentation has been moved to GitLab wiki: https://invent.kde.org/office/kmymoney/-/wikis/home
     
    == Available versions ==
     
    KMyMoney 3.95 will be released on Dec 28th 2009. Until then, you can get the source from the KDE SVN. (see link below)
     
    == Installation ==
     
    === Requirements ===
     
    KMyMoney depends on KDE SC 4.3. Specifically on kdelibs and kde PIM libs.
    Additionally, you may want to install other libraries that will provide additional functionality:
    * libofx
    * Aqbanking v4
    * quote::finance
     
    === Installation steps ===
    Get the source from KDE SVN or the latest tarball (include link when available)
     
    To install read the README.cmake file in the root folder of the source.
    The basic steps are the following:
    $ mkdir build
    $ cd build
    $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/
    $ make
    $ make install
     
    This last step should be executed with root privileges (either switch to root or use sudo, or the appropiate steps on your installation)
     
    To execute, either look for KMyMoney on the Office menu, or type kmymoney in a console window.
     
    == Guidelines ==
     
    As a first step, we are leaving Qt3Support, if possible.
    There are cases when it is best to port to the corresponding Qt4 classes.
    Examples of these are the QButtonGroups, KActions, KPageWidget, QTabBar
     
    For now, focus on make it work. Assess whether it will be faster using Qt3Support or a newer class.
     
    The repository to use is the one in KDE SVN. svn://anonsvn.kde.org/home/kde/trunk/playground/office/kmymoney.
     
     
    == Blocking issues ==
    These are the issues that need to be fixed first before releasing a beta version.
    *<s>Entering a transaction and hitting an account limit will get the application in a loop which ends in a crash</s>
    *<s>Reinvest dividend transaction form never enables the Enter button</s>
    *<s>Enter does not work for transaction enter, only Return does.(not as important as the other, but it's a nag in a main part of the application)</s>
    *<s>Port AqBanking plugin</s> ''Note: KBanking compiles against at Qt4 AqBanking. Still need to test if it really works (ipwizard)''
    * There are a couple of occurrences of '''Uninitialized variables''' warnings during the build. We should fix those.
    * Several files are rebuilt if '''make''' is executed twice in a row.
    *<s>After the payee completer depletes al possible completions when typing a payee's name the typed text is selected so if the user continues to type all characters entered so far are lost</s>
     
    == Areas known to work ==
    I thought that we can put here a list of features that are known to work (after a developer testing):
     
     
    {|- border="1"
    !Area
    !Status
    !Comments
    |-
    |Tips and tricks
    | Working
    |
    |-
    | Home Page
    | Working
    |
    |-
    | Institutions
    | Working
    |
    |-
    | Accounts
    | Working
    |
    |-
    | Ledgers
    | Working
    | The cancel transaction dialog keeps coming up in random situations
    |-
    | Schedules
    | Working
    |
    |-
    | Categories
    | Working
    |
    |-
    | Payees
    | Working
    |
    |-
    | Investments
    | Working
    |
    |-
    | Reports
    | Working
    |
    |-
    | Charts
    | Working
    |
    |-
    | Budgets
    | Working
    |
    |-
    | Forecast
    | Working
    |
    |-
    | Splash screen
    | Working
    |
    |-
    | Settings
    | Working
    |
    |-
    | Webconnect
    | Working
    |
    |-
    | Plugins
    | Working
    | KBanking plugin needs to be tested
    |-
    | Database 
    | Working
    | Passes unit tests for MySQL, PostgreSQL and SQLite3. (fvilas)
    |-
    | GPG
    | Working
    | Needs testing
    |}
     
    == Areas to work on ==
     
    *Views
    *Dialogs
    *Widgets
     
    Also, here you have the KrazyEBN report, which reports common issues on the code.
    [http://www.englishbreakfastnetwork.org/krazy/reports/playground/office/kmymoney/index.html Krazy Report]
     
    Please include the areas you are working on to avoid overlapping with other developers.
    === conet ===
    The following are on my TODO list but that does not mean that I don't need any help on them:
    *<s>Check all the KListView classes that save their layout and make sure that works (restoreLayout was called in polish() in the Institutions view and polish() is not called anymore)</s>(done)
    *<s>Check what's up with the transaction form in the ledger</s>(done)
    *<s>Work on the transaction form since I see it as the hardest thing to port and once it is done (with qt3 support) we can go one and work on the following bullet</s>(done)
    *<s>Try to fix various small stuff that don't work yet until a usable application is obtained</s>(done)
    *<s>Check for multiple instances. It was using DCOP, and it has to be migrated to a method suitable with DBus.</s>
    *<s>Port the KBanking plugin to KDE4 and add it the KMyMoney source tree</s>
    *Although the code that takes care of the drawing of the highlighter of the drop target in kmymoneyaccounttreebase.cpp was ported the drop target is not highlighted
     
    === asoliverez ===
    <s>I will work on the account selector, probably migrate it to Qt4 widgets, because it does all kinds of weird stuff that can be probably optimized.</s> (fixed by conet)
    Working on the i18n and documentation issues with KDE-i18n team.
    Also going through the Krazy report, and fixing issues there.
     
    === ipwizard ===
    I will try to keep the strings together and work on coordination for the integration of/with other KDE applications. On the code front maybe setting up the Qt-Designer plugin for the KMyMoney widgets.
     
    * <s>Getting the GPG encryption to work with either [http://api.kde.org/kdesupport-api/kdesupport-apidocs/qca/html/index.html QCA] or [http://api.kde.org/4.1-api/kdepim-apidocs/libkleo/html/index.html libkleo]</s> Replaced using [http://api.kde.org/4.3-api/kdepim-apidocs/libkleo/html/index.html libkleo]
    * Replace kMyMoneyDateInput with [http://api.kde.org/4.x-api/kdepim-apidocs/libkdepim/html/classKPIM_1_1KDateEdit.html KPIM::KDateEdit]
    * Separate the base and constructed widgets into their own libs
     
    === fvilas ===
    *<s>Convert the dialog allocations on the stack to use QPointer, per EBN point #5.</s>
    *<s>Port the WebPriceQuote object.</s>
    *<s>Port the QIF reader</s> and add test cases for it.
    *Q3Table -> QTableWidget for transaction and register (postponed due to size of task. If anyone wants this, I can send you my patch so far, if not, I'll get back to it at some point.)
    *<s>Q3ButtonGroup -> QButtonGroup port</s>
    *General cleanup of deprecation warnings to quiet the build a bit
    *<s>Q3BoxLayout -> QBoxLayout</s>
     
    == Issues ==
     
    Please report here the issues you find.
     
    *Libkdchart has been commented out until last minute. Charts won't work until then
    *<s>Check for multiple instances. It was using DCOP, and it has to be migrated to a method suitable with DBus.</s> (conet)
    *<s>There is a bug in KHTMLPart where you get weird results if you call write() many times. Save it to a QString and call write() once instead.</s> Done (ipwizard)
    *<s>Q3ButtonGroup objects should be migrated to QButtonGroup. The Q3Support class is severely handicapped and there are no issues in porting to the new class.</s>
    *Standard icon names have changed. Check the name of the icon being called if you see a default icon is being displayed.
    *<s>The code that creates the title bar (the one with the blue image) has been commented out since it somehow was not visible and the other widgets got behind in making it impossible to click them with the mouse.</s>(the code has been ported it only needs a good color scheme)
    *The kmymoney.css has to be updated to use the KDE4 styles.
     
    == Areas to leave as they are for the moment ==
     
    libkdchart is an extract from koffice. If we find a bug there, it is best to report it to the koffice maintainers
     
    The mymoney folder contains the engine. It is covered by the unit tests and they run ok. This is a critical area of the application, so check with Thomas or Alvaro before making a change.
     
    Of course, if you find a critical bug in any of these, let us know.
     
    == Mailing list ==
    https://mail.kde.org/mailman/listinfo/kmymoney-devel. Use it to discuss issues related to the port to KDE4.
     
    == Coordination ==
     
    Alvaro Soliverez is coordinating the KDE4 effort. You can reach me at asoliverez at gmail.com or on IRC under Hei_ku in the #kmymoney channel.
    Alternatively, you can contact Thomas Baumgart on the developers list.
     
    == People involved ==
     
    *mlaurent
    *conet
    *neoclust
    *asoliverez
    *tbaumgart aka ipwizard
    *fvilas
    *tonyb
     
    (Contact the coordinator if you are willing to contribute)
     
    == Timeline ==
    Have it ready for kdereview before the end of the year. Is it too optimistic?

    Latest revision as of 02:46, 10 September 2020

    This documentation has been moved to GitLab wiki: https://invent.kde.org/office/kmymoney/-/wikis/home