[kde-doc-english] [skrooge] doc: Update documentation
Git commit 1ffc2aec24c45fec16feb01ee4ea91a3004d64f7 by Stephane Mankowski. Committed on 09/06/2014 at 16:10. Pushed by smankowski into branch 'master'. Update documentation M +---doc/bank_accounts.png M +---doc/bookmarks_browser.png M +---doc/context_chooser.png M +---doc/dashboard.png M +---doc/export_graph_menu.png M +---doc/export_table_menu.png M +---doc/history_browser.png M +2197 -2071 doc/index.docbook M +---doc/merge_operations_menu.png M +---doc/operations.png M +---doc/property_editor.png A +---doc/shares.png M +---doc/tab_state_management.png M +---doc/table_menu.png http://commits.kde.org/skrooge/1ffc2aec24c45fec16feb01ee4ea91a3004d64f7 diff --git a/doc/bank_accounts.png b/doc/bank_accounts.png index 2d83ad7..d36431a 100644 Binary files a/doc/bank_accounts.png and b/doc/bank_accounts.png differ diff --git a/doc/bookmarks_browser.png b/doc/bookmarks_browser.png index 004da39..8961e9c 100644 Binary files a/doc/bookmarks_browser.png and b/doc/bookmarks_browser.png differ diff --git a/doc/context_chooser.png b/doc/context_chooser.png index 6217e22..bcc22ff 100644 Binary files a/doc/context_chooser.png and b/doc/context_chooser.png differ diff --git a/doc/dashboard.png b/doc/dashboard.png index 8e79dce..0e8f368 100644 Binary files a/doc/dashboard.png and b/doc/dashboard.png differ diff --git a/doc/export_graph_menu.png b/doc/export_graph_menu.png index ef027d3..e6dd855 100644 Binary files a/doc/export_graph_menu.png and b/doc/export_graph_menu.png differ diff --git a/doc/export_table_menu.png b/doc/export_table_menu.png index c709de4..c9914c1 100644 Binary files a/doc/export_table_menu.png and b/doc/export_table_menu.png differ diff --git a/doc/history_browser.png b/doc/history_browser.png index 0913a7c..1095fee 100644 Binary files a/doc/history_browser.png and b/doc/history_browser.png differ diff --git a/doc/index.docbook b/doc/index.docbook index 646b10e..9c63adf 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,2082 +1,2208 @@ ?xml version=1.0 ? !DOCTYPE book PUBLIC -//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN customization/dtd/kdex.dtd [ - !ENTITY appname 'applicationSkrooge/application' - !ENTITY kappname appname; - !ENTITY tbw TO BE WRITTEN - !ENTITY % addindex IGNORE - !ENTITY % English INCLUDE!-- change language only here -- +!ENTITY appname 'applicationSkrooge/application' +!ENTITY kappname appname; +!ENTITY tbw TO BE WRITTEN +!ENTITY % addindex IGNORE +!ENTITY % English INCLUDE!-- change language only here -- - !ENTITY homepage http://extragear.kde.org/apps/skrooge/; +!ENTITY homepage http://extragear.kde.org/apps/skrooge/; ] - book id=skrooge lang=language; -titleThe appname; Handbook/title - - -bookinfo - -authorgroup - -author -firstnameSt?phane/firstname -surnameMANKOWSKI/surname -affiliation -addressemailstephane at mankowski.fr/email/address -/affiliation -/author - -othercredit role=developer -firstnameGuillaume/firstname -surnameDE BURE/surname -affiliation -addressemailguillaume.debure at gmail.com/email/address -/affiliation -contribDeveloper/contrib -/othercredit -!-- TRANS:ROLES_OF_TRANSLATORS -- -/authorgroup - -copyright -year2007/year -year2008/year -year2009/year -year2010/year -year2011/year -holderSt?phane MANKOWSKI/holder -holderGuillaume DE BURE/holder -/copyright - -legalnoticeFDLNotice;/legalnotice - -date30/01/2011/date -releaseinfo0.8.0/releaseinfo - - -abstract -para -This document is a handbook for using appname;, a personal finances manager application. -/para -/abstract - -keywordset -keywordKDE/keyword -keywordextragear/keyword -keywordoffice/keyword -keywordskrooge/keyword -keywordpersonal finances/keyword -/keywordset - -/bookinfo - -chapter id=introduction -titleIntroduction/title - -sect1 id=skrooge-intro -titleappname;/title - -para -appname; is an application for managing your personal finances. It can keep track of your incomes and expenses across several accounts, in several currencies. It has all the features you should expect from such a tool, such as categories, scheduled operations, graphical reporting, stocks management... It also has some less common features, like fast operation edition, search as you type, refund trackers, customizable attributes... -/para - -screenshot -screeninfoappname; displaying pie charts of expenses per category/screeninfo -mediaobject -imageobject -imagedata fileref=reports.png format=PNG/ -/imageobject -textobjectphraseappname; displaying pie charts of expenses per category/phrase/textobject -/mediaobject -/screenshot - - -sect2 id=what-skrooge-is -titleWhat appname; Is/title - -para -appname; is a personal finances manager for kde; 4. It is intended to be used by individuals who want to keep track of their incomes, expenses and investments. -/para - -/sect2 - -sect2 id=what-skrooge-is-not -titleWhat appname; Is Not/title - -para -appname; is not a
[kde-doc-english] [skrooge] doc: Documentation
Git commit 1283fed93c20b205b7b1d7e29de89613a552439c by Stephane Mankowski. Committed on 09/06/2014 at 20:26. Pushed by smankowski into branch 'master'. Documentation A +---doc/bar_location.png M +279 -209 doc/index.docbook A +---doc/menu_edit.png A +---doc/menu_file.png A +---doc/menu_go1.png A +---doc/menu_go2.png A +---doc/menu_help.png A +---doc/menu_import.png A +---doc/menu_settings.png A +---doc/menu_tools.png A +---doc/menu_view.png http://commits.kde.org/skrooge/1283fed93c20b205b7b1d7e29de89613a552439c diff --git a/doc/bar_location.png b/doc/bar_location.png new file mode 100644 index 000..d6dbc7a Binary files /dev/null and b/doc/bar_location.png differ diff --git a/doc/index.docbook b/doc/index.docbook index 9c63adf..61dd3c5 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -278,34 +278,151 @@ /para /sect2 - sect2 id=status_bar - titleStatus Bar/title + sect2 id=page_chooser + titlePage Chooser/title para - The status bar is a small section at the bottom of the appname; window, displaying various information as you work. It includes a progress bar and a cancel button, in case you want to interrupt a long task, such as importing a large file. + The page chooser is a dock where you can select the view to be displayed in the current tab or in a new tab. To open in a new tab, hold the Ctrl; key while clicking on the selected view./paratipparaYou can customize this list by using the contextual menu on this list./para/tip + + screenshot + mediaobject + imageobjectimagedata fileref=context_chooser.png format=PNG//imageobject + textobjectphraseThe page chooser/phrase/textobject + /mediaobject + /screenshot + + paraEach context will be described in a specific chapter in this handbook./para + /sect2 + + sect2 id=bookmarks + titleBookmarks/title + paraImagine you need to customize the operations view on a per account basis: each account would be displayed in its own tab, maybe with different columns in each table. The forementioned method does not work, since it applies on all tabs with the same type. + /para + paraThe solution here is to save each individual tab as a Bookmark. Much like in a web browser, bookmarks can be organized in a hierarchy of bookmark folders, that you can visualize in the Bookmark Browser:/para + screenshot mediaobject - imageobjectimagedata fileref=progress-bar.png format=PNG//imageobject - textobjectphraseThe appname; progress bar/phrase/textobject + imageobjectimagedata fileref=bookmarks_browser.png format=PNG//imageobject + textobjectphraseThe bookmarks browser/phrase/textobject /mediaobject /screenshot + + paraTo create a bookmark, select a page from the link linkend=page_chooserpage chooser/link you want to bookmark, and customize its content to your liking. Once you're done with that, in the Bookmarks link linkend=docksdock/link, bring up the contextual menu, and select menuchoiceguimenuBookmark current page/guimenu/menuchoice./para + + paraEach bookmark or bookmark folder can be autostarted, ie; it will be automatically opened when starting appname;. This way, you can fully customize the default appname; layout./para + paraYou can select the text and icon you want for each bookmark or bookmark folder./para + /sect2 + + sect2 id=undo_redo + titleUndo / Redo/title + para + appname; manages undo/redo in a rather classic fashion, except that you can undo or redo any action, even if it was made several days ago. As per default settings, the history is not cleared upon closing appname; (you can change this behaviour in the !-- TODO:put a link here-- settings), which means you could undo virtually everything up to the document creation. + /para + para + In order to limit the impact on filesize, appname; is configured by default to keep an history of 50 entries. You can change this value in the !-- TODO:put a link here-- settings. + /para + para + appname; has a link linkend=docksdock/link that lists all undoable actions. + /para + + screenshot + mediaobject + imageobjectimagedata fileref=history_browser.png format=PNG//imageobject + textobjectphraseThe history browser/phrase/textobject + /mediaobject + /screenshot + + para + The history browser shows three columns: + /para + + itemizedlist + listitem + para + an icon showing the state of the action. A yellow counter clockwise arrow
