[kde-doc-english] [skrooge] doc: Documentation update
Git commit 2fe596ef8d6e43ad86ebdc2535ea9bcb4320a116 by Stephane Mankowski. Committed on 11/07/2015 at 14:41. Pushed by smankowski into branch 'master'. Documentation update M +6-11 doc/index.docbook M +---doc/menu_edit.png M +---doc/menu_file.png M +---doc/menu_go1.png M +---doc/menu_go2.png M +---doc/menu_help.png M +---doc/menu_import.png M +---doc/menu_settings.png M +---doc/menu_tools.png M +---doc/menu_view.png D +---doc/merge_operations_menu.png M +---doc/tab_state_management.png http://commits.kde.org/skrooge/2fe596ef8d6e43ad86ebdc2535ea9bcb4320a116 diff --git a/doc/index.docbook b/doc/index.docbook index eb9615c..234788a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -746,15 +746,7 @@ titleMerge operations after import/title paraThere are some cases where you have manually entered an operation, but also imported it from your bank. In such cases, the operation will appear twice in the list./para paraYou may merge these two operations by selecting them, and select guimenuitemMerge operations/guimenuitem in the contextual menu. This will add all information you manually entered to the imported operation, and will delete the manually entered operation./para - - screenshot - mediaobject - imageobjectimagedata fileref=merge_operations_menu.png//imageobject - /mediaobject - /screenshot - /sect2 - /sect1 sect1 id=export @@ -830,7 +822,8 @@ listitemparaguimenuitemImport categories/guimenuitem: To import a set of predefined categories. This option depends of your country/para/listitem listitemparaguimenuitemImport/guimenuitem: To link linkend=importimport/link operation from files/para/listitem listitemparaguimenuitemImport with backend/guimenuitem: To link linkend=importimport/link operation with a backend/para/listitem - listitemparaguimenuitemImport currency values.../guimenuitem: To import currency values from files/para/listitem + listitemparaguimenuitemImport currency values.../guimenuitem: To import currency values from files. Of couse, the csv file must have the three columns (unit, date and amount)./para/listitem + listitemparaguimenuitemImport rules.../guimenuitem: To import link linkend=search_and_processSearch and process/link rules to associate a category to a payee. Of couse, the csv file must have the two columns (payee and category)./para/listitem /itemizedlist /para/listitem listitemparaguimenuitemExport.../guimenuitem: To link linkend=export_fileexport/link operations into a file/para/listitem /itemizedlist @@ -848,21 +841,23 @@ itemizedlist listitemparaguimenuitemUndo/guimenuitem: Cancel the previous modification done/para/listitem listitemparaguimenuitemRedo/guimenuitem: Reapply the previous modification canceled/para/listitem - listitemparaguimenuitemUndo/guimenuitem: Cancel the previous modifications done up to the last save/para/listitem + listitemparaguimenuitemRevert document/guimenuitem: Cancel the previous modifications done up to the last save/para/listitem listitemparaguimenuitemDelete/guimenuitem: Delete the selected objects (operations, accounts, categories, ...)/para/listitem listitemparaguimenuitemAdd property/guimenuitem: Add a property regularly used on the selected objects/para/listitem listitemparaguimenuitemSelect all/guimenuitem: Select all lines of the link linkend=tablestable/link of the current page/para/listitem listitemparaguimenuitemFast edit:/guimenuitem: Facilitation the creation of new link linkend=operationsoperations/link by filling fields automatically based on previous operations created/para/listitem listitemparaguimenuitemFind.../guimenuitem: Open the link linkend=search_and_processSearch and process/link page with a predefined filter corresponding to the selected objects/para/listitem listitemparaguimenuitemSwitch highlight/guimenuitem: Switch the highlight state of objects/para/listitem + listitemparaguimenuitemSwitch close/guimenuitem: Switch the close state of objects/para/listitem listitemparaguimenuitemReconcile.../guimenuitem: Open the link linkend=operationsOperations/link page in link linkend=reconciliationreconciliation/link mode/para/listitem listitemparaguimenuitemPoint/guimenuitem: Point the selected operations/para/listitem listitemparaguimenuitemGroup operations/guimenuitem: Group the selected operations/para/listitem listitemparaguimenuitemUngroup operations/guimenuitem: Ungroup the selected operations/para/listitem listitemparaguimenuitemDuplicate/guimenuitem: Duplicate the selected operation to create a new one from a
[kde-doc-english] [skrooge] doc: Documentation update
Git commit e3c38a97e959a834365f42e817ac83ec4728a370 by Stephane Mankowski. Committed on 11/06/2014 at 20:30. Pushed by smankowski into branch 'master'. Documentation update M +---doc/categories.png M +60 -4doc/index.docbook A +---doc/payees.png M +---doc/reports.png M +---doc/units.png http://commits.kde.org/skrooge/e3c38a97e959a834365f42e817ac83ec4728a370 diff --git a/doc/categories.png b/doc/categories.png index 22911f1..e0e4164 100644 Binary files a/doc/categories.png and b/doc/categories.png differ diff --git a/doc/index.docbook b/doc/index.docbook index 50ec271..203d1af 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -746,6 +746,7 @@ /para sect2 id=menu-file titleThe file menu/title + paraYou can find in this menu all functions relative to the appname; document/para screenshot mediaobject imageobjectimagedata fileref=menu_file.png//imageobject @@ -775,6 +776,7 @@ sect2 id=menu-edit titleThe edit menu/title + paraYou can find in this menu all functions modifing selected objects/para screenshot mediaobject imageobjectimagedata fileref=menu_edit.png//imageobject @@ -782,12 +784,32 @@ /screenshot itemizedlist - listitempara/para/listitem + listitemparaguimenuitemUndo/guimenuitem: Cancel the previous modification done/para/listitem + listitemparaguimenuitemRedo/guimenuitem: Reapply the previous modification cancelled/para/listitem + listitemparaguimenuitemUndo/guimenuitem: Cancel the previous modifications done up to the last save/para/listitem + listitemparaguimenuitemDelete/guimenuitem: Delete the selected objects (operations, accounts, categories, ...)/para/listitem + listitemparaguimenuitemAdd property/guimenuitem: Add a property regularly used on the selected objects/para/listitem + listitemparaguimenuitemSelect all/guimenuitem: Select all lines of the link linkend=tablestable/link of the current page/para/listitem + listitemparaguimenuitemFast edit:/guimenuitem: Facilitation the creation of new link linkend=operationsoperations/link by filling fields automatically based on previous operations created/para/listitem + listitemparaguimenuitemFind.../guimenuitem: Open the link linkend=search_and_processSearch and process/link page with a predefined filter corresponding to the selected objects/para/listitem + listitemparaguimenuitemSwitch highlight/guimenuitem: Switch the highlight state of objects/para/listitem + listitemparaguimenuitemReconcile.../guimenuitem: Open the link linkend=operationsOperations/link page in link linkend=reconciliationreconciliation/link mode/para/listitem + listitemparaguimenuitemPoint/guimenuitem: Point the selected operations/para/listitem + listitemparaguimenuitemGroup operations/guimenuitem: Group the selected operations/para/listitem + listitemparaguimenuitemUngroup operations/guimenuitem: Ungroup the selected operations/para/listitem + listitemparaguimenuitemDuplicate/guimenuitem: Duplicate the selected operation to create a new one from a previous one/para/listitem + listitemparaguimenuitemCreate template/guimenuitem: Create a link linkend=templatestemplate/link from a selected operation/para/listitem + listitemparaguimenuitemMerge sub operations/guimenuitem: Merge selected operations in one split operation/para/listitem + listitemparaguimenuitemSchedule/guimenuitem: /para/listitem + listitemparaguimenuitemValidate imported operations/guimenuitem: Validate all selected imported operations/para/listitem + listitemparaguimenuitemMerge imported operations/guimenuitem: Merge one imported operation with an other operation entered manually. If amounts are different then a confirmation is requested/para/listitem + listitemparaguimenuitemSplit shares/guimenuitem: Split selected link linkend=unitsshares/link/para/listitem /itemizedlist /sect2 sect2 id=menu-view titleThe view menu/title + paraYou can find in this menu all functions relative to link linkend=multi-tabspages/link/para screenshot mediaobject imageobjectimagedata fileref=menu_view.png//imageobject @@ -795,12 +817,13 @@ /screenshot itemizedlist - listitempara/para/listitem + listitemparaguimenuitem/guimenuitem: /para/listitem /itemizedlist /sect2 sect2 id=menu-do titleThe go menu/title + paraYou can find in this menu all functions relative to link linkend=multi-tabspages/link/para screenshot mediaobject imageobjectimagedata fileref=menu_go1.png//imageobject @@ -900,7 +923,7 @@ listitemparaThe account type can
[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
